From 798ef4b134b4c9fed9a382c8e7c5d36b00905d1b Mon Sep 17 00:00:00 2001 From: "Mike F. Robbins" Date: Fri, 10 Jan 2025 14:10:00 -0600 Subject: [PATCH 1/3] Updated archive url (#3439) --- docfx.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docfx.json b/docfx.json index 82dd3c8a0c..5fcbbef939 100644 --- a/docfx.json +++ b/docfx.json @@ -471,7 +471,7 @@ }, "globalMetadata": { "apiPlatform": "powershell", - "archive_url": "https://learn.microsoft.com/previous-versions/powershell/azure/deploymentmanager/overview", + "archive_url": "https://learn.microsoft.com/previous-versions/powershell/azure", "brand": "azure", "searchScope": [ "Azure", From 19c5d658175ada6f504bfe79e4c19bde99258381 Mon Sep 17 00:00:00 2001 From: "Mike F. Robbins" Date: Fri, 10 Jan 2025 14:30:05 -0600 Subject: [PATCH 2/3] Archived azurerm docs (#3440) --- .../Add-AzureAnalysisServicesAccount.md | 228 -- .../Azure.AnalysisServices.md | 27 - ...Export-AzureAnalysisServicesInstanceLog.md | 128 - .../Restart-AzureAnalysisServicesInstance.md | 113 - .../Sync-AzureAnalysisServicesInstance.md | 135 - .../Azure.Storage/Azure.Storage.md | 219 -- ...sable-AzureStorageDeleteRetentionPolicy.md | 127 - ...nable-AzureStorageDeleteRetentionPolicy.md | 142 -- .../Azure.Storage/Get-AzureStorageBlob.md | 299 --- .../Get-AzureStorageBlobContent.md | 319 --- .../Get-AzureStorageBlobCopyState.md | 258 -- .../Azure.Storage/Get-AzureStorageCORSRule.md | 162 -- .../Get-AzureStorageContainer.md | 225 -- ...AzureStorageContainerStoredAccessPolicy.md | 182 -- .../Azure.Storage/Get-AzureStorageFile.md | 251 -- .../Get-AzureStorageFileContent.md | 381 --- .../Get-AzureStorageFileCopyState.md | 216 -- .../Azure.Storage/Get-AzureStorageQueue.md | 144 -- ...Get-AzureStorageQueueStoredAccessPolicy.md | 132 - .../Get-AzureStorageServiceLoggingProperty.md | 112 - .../Get-AzureStorageServiceMetricsProperty.md | 130 - .../Get-AzureStorageServiceProperty.md | 118 - .../Azure.Storage/Get-AzureStorageShare.md | 217 -- ...Get-AzureStorageShareStoredAccessPolicy.md | 183 -- .../Azure.Storage/Get-AzureStorageTable.md | 145 -- ...Get-AzureStorageTableStoredAccessPolicy.md | 132 - .../New-AzureStorageAccountSASToken.md | 235 -- .../New-AzureStorageBlobSASToken.md | 280 -- .../New-AzureStorageContainer.md | 196 -- .../New-AzureStorageContainerSASToken.md | 239 -- ...AzureStorageContainerStoredAccessPolicy.md | 226 -- .../Azure.Storage/New-AzureStorageContext.md | 373 --- .../New-AzureStorageDirectory.md | 246 -- .../New-AzureStorageFileSASToken.md | 290 --- .../Azure.Storage/New-AzureStorageQueue.md | 114 - .../New-AzureStorageQueueSASToken.md | 221 -- ...New-AzureStorageQueueStoredAccessPolicy.md | 172 -- .../Azure.Storage/New-AzureStorageShare.md | 159 -- .../New-AzureStorageShareSASToken.md | 242 -- ...New-AzureStorageShareStoredAccessPolicy.md | 222 -- .../Azure.Storage/New-AzureStorageTable.md | 114 - .../New-AzureStorageTableSASToken.md | 303 --- ...New-AzureStorageTableStoredAccessPolicy.md | 172 -- .../Azure.Storage/Remove-AzureStorageBlob.md | 319 --- .../Remove-AzureStorageCORSRule.md | 164 -- .../Remove-AzureStorageContainer.md | 220 -- ...AzureStorageContainerStoredAccessPolicy.md | 225 -- .../Remove-AzureStorageDirectory.md | 297 --- .../Azure.Storage/Remove-AzureStorageFile.md | 314 --- .../Azure.Storage/Remove-AzureStorageQueue.md | 173 -- ...ove-AzureStorageQueueStoredAccessPolicy.md | 171 -- .../Azure.Storage/Remove-AzureStorageShare.md | 275 -- ...ove-AzureStorageShareStoredAccessPolicy.md | 223 -- .../Azure.Storage/Remove-AzureStorageTable.md | 171 -- ...ove-AzureStorageTableStoredAccessPolicy.md | 171 -- .../Set-AzureStorageBlobContent.md | 420 --- .../Azure.Storage/Set-AzureStorageCORSRule.md | 226 -- .../Set-AzureStorageContainerAcl.md | 213 -- ...AzureStorageContainerStoredAccessPolicy.md | 285 --- .../Set-AzureStorageFileContent.md | 337 --- ...Set-AzureStorageQueueStoredAccessPolicy.md | 228 -- .../Set-AzureStorageServiceLoggingProperty.md | 185 -- .../Set-AzureStorageServiceMetricsProperty.md | 200 -- .../Set-AzureStorageShareQuota.md | 201 -- ...Set-AzureStorageShareStoredAccessPolicy.md | 283 -- ...Set-AzureStorageTableStoredAccessPolicy.md | 230 -- .../Start-AzureStorageBlobCopy.md | 574 ----- .../Start-AzureStorageBlobIncrementalCopy.md | 398 --- .../Start-AzureStorageFileCopy.md | 485 ---- .../Stop-AzureStorageBlobCopy.md | 303 --- .../Stop-AzureStorageFileCopy.md | 262 -- .../Update-AzureStorageServiceProperty.md | 166 -- azurermps-6.13.0/AzureRM.Aks/AzureRM.Aks.md | 36 - .../AzureRM.Aks/Get-AzureRmAks.md | 132 - .../Import-AzureRmAksCredential.md | 233 -- .../AzureRM.Aks/New-AzureRmAks.md | 313 --- .../AzureRM.Aks/Remove-AzureRmAks.md | 216 -- .../AzureRM.Aks/Set-AzureRmAks.md | 346 --- .../AzureRM.Aks/Start-AzureRmAksDashboard.md | 170 -- .../AzureRM.Aks/Stop-AzureRmAksDashboard.md | 80 - .../AzureRM.AnalysisServices.md | 42 - .../Get-AzureRmAnalysisServicesServer.md | 108 - ...w-AzureRmAnalysisServicesFirewallConfig.md | 101 - ...New-AzureRmAnalysisServicesFirewallRule.md | 113 - .../New-AzureRmAnalysisServicesServer.md | 277 -- .../Remove-AzureRmAnalysisServicesServer.md | 146 -- .../Resume-AzureRmAnalysisServicesServer.md | 146 -- .../Set-AzureRmAnalysisServicesServer.md | 329 --- .../Suspend-AzureRmAnalysisServicesServer.md | 147 -- .../Test-AzureRmAnalysisServicesServer.md | 101 - .../Add-AzureRmApiManagementApiToProduct.md | 136 - .../Add-AzureRmApiManagementProductToGroup.md | 140 - .../Add-AzureRmApiManagementRegion.md | 169 -- .../Add-AzureRmApiManagementUserToGroup.md | 141 - .../AzureRM.ApiManagement.md | 327 --- .../Backup-AzureRmApiManagement.md | 178 -- .../Export-AzureRmApiManagementApi.md | 234 -- .../Get-AzureRmApiManagement.md | 126 - .../Get-AzureRmApiManagementApi.md | 192 -- .../Get-AzureRmApiManagementApiRelease.md | 147 -- .../Get-AzureRmApiManagementApiRevision.md | 143 -- .../Get-AzureRmApiManagementApiVersionSet.md | 158 -- ...AzureRmApiManagementAuthorizationServer.md | 120 - .../Get-AzureRmApiManagementBackend.md | 127 - .../Get-AzureRmApiManagementCertificate.md | 154 -- .../Get-AzureRmApiManagementGroup.md | 200 -- ...et-AzureRmApiManagementIdentityProvider.md | 119 - .../Get-AzureRmApiManagementLogger.md | 123 - ...ureRmApiManagementOpenIdConnectProvider.md | 154 -- .../Get-AzureRmApiManagementOperation.md | 153 -- .../Get-AzureRmApiManagementPolicy.md | 279 -- .../Get-AzureRmApiManagementProduct.md | 145 -- .../Get-AzureRmApiManagementProperty.md | 140 - .../Get-AzureRmApiManagementSsoToken.md | 101 - .../Get-AzureRmApiManagementSubscription.md | 184 -- .../Get-AzureRmApiManagementTenantAccess.md | 87 - ...Get-AzureRmApiManagementTenantGitAccess.md | 83 - ...Get-AzureRmApiManagementTenantSyncState.md | 83 - .../Get-AzureRmApiManagementUser.md | 244 -- .../Get-AzureRmApiManagementUserSsoUrl.md | 106 - .../Import-AzureRmApiManagementApi.md | 270 -- ...AzureRmApiManagementHostnameCertificate.md | 172 -- .../New-AzureRmApiManagement.md | 347 --- .../New-AzureRmApiManagementApi.md | 284 --- .../New-AzureRmApiManagementApiRelease.md | 197 -- .../New-AzureRmApiManagementApiRevision.md | 173 -- .../New-AzureRmApiManagementApiVersionSet.md | 232 -- ...AzureRmApiManagementAuthorizationServer.md | 374 --- .../New-AzureRmApiManagementBackend.md | 319 --- ...w-AzureRmApiManagementBackendCredential.md | 160 -- .../New-AzureRmApiManagementBackendProxy.md | 113 - ...zureRmApiManagementBackendServiceFabric.md | 163 -- .../New-AzureRmApiManagementCertificate.md | 165 -- .../New-AzureRmApiManagementContext.md | 98 - ...piManagementCustomHostnameConfiguration.md | 226 -- .../New-AzureRmApiManagementGroup.md | 170 -- ...ureRmApiManagementHostnameConfiguration.md | 105 - ...ew-AzureRmApiManagementIdentityProvider.md | 193 -- .../New-AzureRmApiManagementLogger.md | 199 -- ...ureRmApiManagementOpenIdConnectProvider.md | 186 -- .../New-AzureRmApiManagementOperation.md | 285 --- .../New-AzureRmApiManagementProduct.md | 242 -- .../New-AzureRmApiManagementProperty.md | 187 -- .../New-AzureRmApiManagementRegion.md | 135 - .../New-AzureRmApiManagementSubscription.md | 208 -- ...w-AzureRmApiManagementSystemCertificate.md | 121 - .../New-AzureRmApiManagementUser.md | 212 -- .../New-AzureRmApiManagementVirtualNetwork.md | 117 - ...reRmApiManagementTenantGitConfiguration.md | 194 -- .../Remove-AzureRmApiManagement.md | 153 -- .../Remove-AzureRmApiManagementApi.md | 160 -- ...move-AzureRmApiManagementApiFromProduct.md | 136 - .../Remove-AzureRmApiManagementApiRelease.md | 195 -- .../Remove-AzureRmApiManagementApiRevision.md | 194 -- ...emove-AzureRmApiManagementApiVersionSet.md | 181 -- ...AzureRmApiManagementAuthorizationServer.md | 148 -- .../Remove-AzureRmApiManagementBackend.md | 158 -- .../Remove-AzureRmApiManagementCertificate.md | 157 -- .../Remove-AzureRmApiManagementGroup.md | 156 -- ...ve-AzureRmApiManagementIdentityProvider.md | 157 -- .../Remove-AzureRmApiManagementLogger.md | 156 -- ...ureRmApiManagementOpenIdConnectProvider.md | 157 -- .../Remove-AzureRmApiManagementOperation.md | 187 -- .../Remove-AzureRmApiManagementPolicy.md | 230 -- .../Remove-AzureRmApiManagementProduct.md | 172 -- ...ve-AzureRmApiManagementProductFromGroup.md | 140 - .../Remove-AzureRmApiManagementProperty.md | 154 -- .../Remove-AzureRmApiManagementRegion.md | 118 - ...Remove-AzureRmApiManagementSubscription.md | 156 -- .../Remove-AzureRmApiManagementUser.md | 174 -- ...emove-AzureRmApiManagementUserFromGroup.md | 139 - .../Restore-AzureRmApiManagement.md | 172 -- ...reRmApiManagementTenantGitConfiguration.md | 167 -- .../Set-AzureRmApiManagement.md | 191 -- .../Set-AzureRmApiManagementApi.md | 307 --- .../Set-AzureRmApiManagementApiRevision.md | 361 --- .../Set-AzureRmApiManagementApiVersionSet.md | 263 -- ...AzureRmApiManagementAuthorizationServer.md | 399 --- .../Set-AzureRmApiManagementBackend.md | 329 --- .../Set-AzureRmApiManagementCertificate.md | 183 -- .../Set-AzureRmApiManagementGroup.md | 155 -- .../Set-AzureRmApiManagementHostnames.md | 192 -- ...et-AzureRmApiManagementIdentityProvider.md | 208 -- .../Set-AzureRmApiManagementLogger.md | 210 -- ...ureRmApiManagementOpenIdConnectProvider.md | 204 -- .../Set-AzureRmApiManagementOperation.md | 272 -- .../Set-AzureRmApiManagementPolicy.md | 286 --- .../Set-AzureRmApiManagementProduct.md | 245 -- .../Set-AzureRmApiManagementProperty.md | 206 -- .../Set-AzureRmApiManagementSubscription.md | 229 -- .../Set-AzureRmApiManagementTenantAccess.md | 120 - .../Set-AzureRmApiManagementUser.md | 232 -- .../Update-AzureRmApiManagementApiRelease.md | 209 -- .../Update-AzureRmApiManagementDeployment.md | 289 --- .../Update-AzureRmApiManagementRegion.md | 162 -- .../AzureRM.ApplicationInsights.md | 51 - .../Get-AzureRmApplicationInsights.md | 202 -- .../Get-AzureRmApplicationInsightsApiKey.md | 177 -- ...reRmApplicationInsightsContinuousExport.md | 179 -- .../New-AzureRmApplicationInsights.md | 191 -- .../New-AzureRmApplicationInsightsApiKey.md | 212 -- ...reRmApplicationInsightsContinuousExport.md | 251 -- .../Remove-AzureRmApplicationInsights.md | 189 -- ...Remove-AzureRmApplicationInsightsApiKey.md | 207 -- ...reRmApplicationInsightsContinuousExport.md | 206 -- ...reRmApplicationInsightsContinuousExport.md | 283 -- .../Set-AzureRmApplicationInsightsDailyCap.md | 210 -- ...t-AzureRmApplicationInsightsPricingPlan.md | 225 -- .../AzureRM.Automation/AzureRM.Automation.md | 276 -- .../Export-AzureRMAutomationRunbook.md | 213 -- ...xport-AzureRmAutomationDscConfiguration.md | 201 -- ...t-AzureRmAutomationDscNodeReportContent.md | 204 -- .../Get-AzureRMAutomationCertificate.md | 136 - .../Get-AzureRMAutomationConnection.md | 164 -- .../Get-AzureRMAutomationCredential.md | 137 - .../Get-AzureRMAutomationHybridWorkerGroup.md | 135 - .../Get-AzureRMAutomationJob.md | 230 -- .../Get-AzureRMAutomationJobOutput.md | 170 -- .../Get-AzureRMAutomationRunbook.md | 138 - .../Get-AzureRMAutomationSchedule.md | 127 - .../Get-AzureRMAutomationScheduledRunbook.md | 192 -- .../Get-AzureRMAutomationVariable.md | 132 - .../Get-AzureRMAutomationWebhook.md | 149 -- .../Get-AzureRmAutomationAccount.md | 132 - .../Get-AzureRmAutomationDscCompilationJob.md | 225 -- ...zureRmAutomationDscCompilationJobOutput.md | 165 -- .../Get-AzureRmAutomationDscConfiguration.md | 132 - .../Get-AzureRmAutomationDscNode.md | 245 -- ...t-AzureRmAutomationDscNodeConfiguration.md | 180 -- ...utomationDscNodeConfigurationDeployment.md | 199 -- ...nDscNodeConfigurationDeploymentSchedule.md | 172 -- .../Get-AzureRmAutomationDscNodeReport.md | 223 -- ...zureRmAutomationDscOnboardingMetaconfig.md | 185 -- .../Get-AzureRmAutomationJobOutputRecord.md | 137 - .../Get-AzureRmAutomationModule.md | 134 - .../Get-AzureRmAutomationRegistrationInfo.md | 106 - ...RmAutomationSoftwareUpdateConfiguration.md | 150 -- ...ureRmAutomationSoftwareUpdateMachineRun.md | 218 -- .../Get-AzureRmAutomationSoftwareUpdateRun.md | 253 -- .../Get-AzureRmAutomationSourceControl.md | 143 -- ...t-AzureRmAutomationSourceControlSyncJob.md | 155 -- ...eRmAutomationSourceControlSyncJobOutput.md | 203 -- .../Import-AzureRMAutomationRunbook.md | 302 --- ...mport-AzureRmAutomationDscConfiguration.md | 232 -- ...t-AzureRmAutomationDscNodeConfiguration.md | 207 -- .../New-AzureRMAutomationCertificate.md | 192 -- .../New-AzureRMAutomationConnection.md | 171 -- .../New-AzureRMAutomationCredential.md | 160 -- .../New-AzureRMAutomationRunbook.md | 217 -- .../New-AzureRMAutomationSchedule.md | 420 --- .../New-AzureRMAutomationVariable.md | 183 -- .../New-AzureRMAutomationWebhook.md | 268 -- .../New-AzureRmAutomationAccount.md | 159 -- .../New-AzureRmAutomationKey.md | 117 - .../New-AzureRmAutomationModule.md | 149 -- ...RmAutomationSoftwareUpdateConfiguration.md | 365 --- .../New-AzureRmAutomationSourceControl.md | 323 --- .../Publish-AzureRMAutomationRunbook.md | 130 - ...ister-AzureRMAutomationScheduledRunbook.md | 175 -- .../Register-AzureRmAutomationDscNode.md | 273 -- .../Remove-AzureRMAutomationCertificate.md | 152 -- .../Remove-AzureRMAutomationConnection.md | 165 -- .../Remove-AzureRMAutomationCredential.md | 152 -- .../Remove-AzureRMAutomationRunbook.md | 177 -- .../Remove-AzureRMAutomationSchedule.md | 167 -- .../Remove-AzureRMAutomationVariable.md | 154 -- .../Remove-AzureRMAutomationWebhook.md | 155 -- .../Remove-AzureRmAutomationAccount.md | 152 -- .../Remove-AzureRmAutomationConnectionType.md | 168 -- ...emove-AzureRmAutomationDscConfiguration.md | 160 -- ...e-AzureRmAutomationDscNodeConfiguration.md | 177 -- ...move-AzureRmAutomationHybridWorkerGroup.md | 146 -- .../Remove-AzureRmAutomationModule.md | 167 -- ...RmAutomationSoftwareUpdateConfiguration.md | 182 -- .../Remove-AzureRmAutomationSourceControl.md | 163 -- .../Resume-AzureRMAutomationJob.md | 126 - .../Set-AzureRMAutomationCertificate.md | 191 -- ...t-AzureRMAutomationConnectionFieldValue.md | 149 -- .../Set-AzureRMAutomationCredential.md | 160 -- .../Set-AzureRMAutomationRunbook.md | 195 -- .../Set-AzureRMAutomationSchedule.md | 153 -- .../Set-AzureRMAutomationVariable.md | 180 -- .../Set-AzureRMAutomationWebhook.md | 158 -- .../Set-AzureRmAutomationAccount.md | 150 -- .../Set-AzureRmAutomationDscNode.md | 185 -- .../Set-AzureRmAutomationModule.md | 164 -- .../Start-AzureRMAutomationRunbook.md | 207 -- ...tart-AzureRmAutomationDscCompilationJob.md | 210 -- ...utomationDscNodeConfigurationDeployment.md | 296 --- ...t-AzureRmAutomationSourceControlSyncJob.md | 162 -- .../Stop-AzureRMAutomationJob.md | 125 - ...utomationDscNodeConfigurationDeployment.md | 213 -- .../Suspend-AzureRMAutomationJob.md | 126 - ...ister-AzureRMAutomationScheduledRunbook.md | 206 -- .../Unregister-AzureRmAutomationDscNode.md | 169 -- .../Update-AzureRmAutomationSourceControl.md | 241 -- .../AzureRM.Backup/AzureRM.Backup.md | 87 - .../Backup-AzureRmBackupItem.md | 104 - .../Disable-AzureRmBackupProtection.md | 147 -- ...le-AzureRmBackupContainerReregistration.md | 87 - .../Enable-AzureRmBackupProtection.md | 123 - .../Get-AzureRmBackupContainer.md | 197 -- .../AzureRM.Backup/Get-AzureRmBackupItem.md | 187 -- .../AzureRM.Backup/Get-AzureRmBackupJob.md | 287 --- .../Get-AzureRmBackupJobDetails.md | 149 -- .../Get-AzureRmBackupProtectionPolicy.md | 132 - .../Get-AzureRmBackupRecoveryPoint.md | 120 - .../AzureRM.Backup/Get-AzureRmBackupVault.md | 149 -- .../Get-AzureRmBackupVaultCredentials.md | 99 - .../New-AzureRmBackupProtectionPolicy.md | 273 -- .../New-AzureRmBackupRetentionPolicyObject.md | 332 --- .../AzureRM.Backup/New-AzureRmBackupVault.md | 168 -- .../Register-AzureRmBackupContainer.md | 153 -- .../Remove-AzureRmBackupProtectionPolicy.md | 147 -- .../Remove-AzureRmBackupVault.md | 142 -- .../Restore-AzureRmBackupItem.md | 127 - .../Set-AzureRmBackupProtectionPolicy.md | 207 -- .../AzureRM.Backup/Set-AzureRmBackupVault.md | 113 - .../AzureRM.Backup/Stop-AzureRmBackupJob.md | 149 -- .../Unregister-AzureRmBackupContainer.md | 160 -- .../AzureRM.Backup/Wait-AzureRmBackupJob.md | 102 - .../AzureRM.Batch/AzureRM.Batch.md | 228 -- .../Disable-AzureBatchAutoScale.md | 107 - ...Disable-AzureBatchComputeNodeScheduling.md | 204 -- .../AzureRM.Batch/Disable-AzureBatchJob.md | 140 - .../Disable-AzureBatchJobSchedule.md | 118 - .../Enable-AzureBatchAutoScale.md | 141 - .../Enable-AzureBatchComputeNodeScheduling.md | 159 -- .../AzureRM.Batch/Enable-AzureBatchJob.md | 115 - .../Enable-AzureBatchJobSchedule.md | 117 - .../AzureRM.Batch/Enable-AzureBatchTask.md | 195 -- .../Get-AzureBatchCertificate.md | 245 -- .../Get-AzureBatchComputeNode.md | 313 --- .../AzureRM.Batch/Get-AzureBatchJob.md | 312 --- ...BatchJobPreparationAndReleaseTaskStatus.md | 217 -- .../Get-AzureBatchJobSchedule.md | 245 -- .../Get-AzureBatchJobStatistics.md | 108 - .../Get-AzureBatchNodeAgentSku.md | 122 - .../AzureRM.Batch/Get-AzureBatchNodeFile.md | 368 --- .../Get-AzureBatchNodeFileContent.md | 334 --- .../AzureRM.Batch/Get-AzureBatchPool.md | 246 -- .../Get-AzureBatchPoolNodeCounts.md | 205 -- .../Get-AzureBatchPoolStatistics.md | 109 - .../Get-AzureBatchPoolUsageMetrics.md | 195 -- ...Get-AzureBatchRemoteDesktopProtocolFile.md | 213 -- .../Get-AzureBatchRemoteLoginSettings.md | 173 -- .../AzureRM.Batch/Get-AzureBatchSubtask.md | 166 -- .../AzureRM.Batch/Get-AzureBatchTask.md | 295 --- .../AzureRM.Batch/Get-AzureBatchTaskCounts.md | 144 -- .../AzureRM.Batch/Get-AzureRmBatchAccount.md | 159 -- .../Get-AzureRmBatchAccountKeys.md | 96 - .../Get-AzureRmBatchApplication.md | 131 - .../Get-AzureRmBatchApplicationPackage.md | 149 -- .../Get-AzureRmBatchLocationQuotas.md | 87 - .../New-AzureBatchCertificate.md | 157 -- .../New-AzureBatchComputeNodeUser.md | 221 -- .../AzureRM.Batch/New-AzureBatchJob.md | 320 --- .../New-AzureBatchJobSchedule.md | 191 -- .../AzureRM.Batch/New-AzureBatchPool.md | 517 ---- .../AzureRM.Batch/New-AzureBatchTask.md | 483 ---- .../AzureRM.Batch/New-AzureRmBatchAccount.md | 212 -- .../New-AzureRmBatchAccountKey.md | 137 - .../New-AzureRmBatchApplication.md | 160 -- .../New-AzureRmBatchApplicationPackage.md | 197 -- .../Remove-AzureBatchCertificate.md | 170 -- .../Remove-AzureBatchComputeNode.md | 250 -- .../Remove-AzureBatchComputeNodeUser.md | 173 -- .../AzureRM.Batch/Remove-AzureBatchJob.md | 175 -- .../Remove-AzureBatchJobSchedule.md | 152 -- .../Remove-AzureBatchNodeFile.md | 284 --- .../AzureRM.Batch/Remove-AzureBatchPool.md | 166 -- .../AzureRM.Batch/Remove-AzureBatchTask.md | 215 -- .../Remove-AzureRmBatchAccount.md | 155 -- .../Remove-AzureRmBatchApplication.md | 127 - .../Remove-AzureRmBatchApplicationPackage.md | 143 -- .../Reset-AzureBatchComputeNode.md | 170 -- .../Restart-AzureBatchComputeNode.md | 169 -- .../Set-AzureBatchComputeNodeUser.md | 169 -- .../AzureRM.Batch/Set-AzureBatchJob.md | 124 - .../Set-AzureBatchJobSchedule.md | 108 - .../AzureRM.Batch/Set-AzureBatchPool.md | 120 - .../Set-AzureBatchPoolOSVersion.md | 119 - .../AzureRM.Batch/Set-AzureBatchTask.md | 121 - .../AzureRM.Batch/Set-AzureRmBatchAccount.md | 152 -- .../Set-AzureRmBatchApplication.md | 175 -- ...t-AzureBatchComputeNodeServiceLogUpload.md | 266 -- .../Start-AzureBatchPoolResize.md | 188 -- .../Stop-AzureBatchCertificateDeletion.md | 125 - .../AzureRM.Batch/Stop-AzureBatchJob.md | 134 - .../Stop-AzureBatchJobSchedule.md | 116 - .../Stop-AzureBatchPoolResize.md | 120 - .../AzureRM.Batch/Stop-AzureBatchTask.md | 161 -- .../AzureRM.Batch/Test-AzureBatchAutoScale.md | 129 - .../AzureRM.Billing/AzureRM.Billing.md | 24 - .../Get-AzureRmBillingInvoice.md | 159 -- .../Get-AzureRmBillingPeriod.md | 116 - .../Get-AzureRmEnrollmentAccount.md | 103 - azurermps-6.13.0/AzureRM.Cdn/AzureRM.Cdn.md | 99 - .../Confirm-AzureRmCdnEndpointProbeURL.md | 84 - .../Disable-AzureRmCdnCustomDomain.md | 196 -- .../Enable-AzureRmCdnCustomDomain.md | 196 -- .../AzureRM.Cdn/Get-AzureRMCdnProfile.md | 98 - .../AzureRM.Cdn/Get-AzureRmCdnCustomDomain.md | 150 -- .../AzureRM.Cdn/Get-AzureRmCdnEdgeNodes.md | 65 - .../AzureRM.Cdn/Get-AzureRmCdnEndpoint.md | 141 - .../Get-AzureRmCdnEndpointNameAvailability.md | 75 - .../Get-AzureRmCdnEndpointResourceUsage.md | 134 - .../AzureRM.Cdn/Get-AzureRmCdnOrigin.md | 147 -- .../Get-AzureRmCdnProfileResourceUsage.md | 119 - .../Get-AzureRmCdnProfileSsoUrl.md | 118 - ...reRmCdnProfileSupportedOptimizationType.md | 121 - ...Get-AzureRmCdnSubscriptionResourceUsage.md | 65 - .../AzureRM.Cdn/New-AzureRmCdnCustomDomain.md | 198 -- .../AzureRM.Cdn/New-AzureRmCdnEndpoint.md | 437 ---- .../AzureRM.Cdn/New-AzureRmCdnProfile.md | 175 -- .../Publish-AzureRmCdnEndpointContent.md | 165 -- .../Remove-AzureRmCdnCustomDomain.md | 201 -- .../AzureRM.Cdn/Remove-AzureRmCdnEndpoint.md | 204 -- .../AzureRM.Cdn/Remove-AzureRmCdnProfile.md | 185 -- .../AzureRM.Cdn/Set-AzureRmCdnEndpoint.md | 119 - .../AzureRM.Cdn/Set-AzureRmCdnOrigin.md | 79 - .../AzureRM.Cdn/Set-AzureRmCdnProfile.md | 115 - .../AzureRM.Cdn/Start-AzureRmCdnEndpoint.md | 189 -- .../AzureRM.Cdn/Stop-AzureRmCdnEndpoint.md | 189 -- .../Test-AzureRmCdnCustomDomain.md | 151 -- .../Unpublish-AzureRmCdnEndpointContent.md | 197 -- .../AzureRM.CognitiveServices.md | 42 - .../Get-AzureRmCognitiveServicesAccount.md | 137 - .../Get-AzureRmCognitiveServicesAccountKey.md | 107 - ...Get-AzureRmCognitiveServicesAccountSkus.md | 142 -- ...Get-AzureRmCognitiveServicesAccountType.md | 121 - ...et-AzureRmCognitiveServicesAccountUsage.md | 180 -- .../New-AzureRmCognitiveServicesAccount.md | 233 -- .../New-AzureRmCognitiveServicesAccountKey.md | 170 -- .../Remove-AzureRmCognitiveServicesAccount.md | 152 -- .../Set-AzureRmCognitiveServicesAccount.md | 201 -- .../AzureRM.Compute.ManagedService.md | 18 - .../ConvertTo-AzureRmVhd.md | 158 -- .../AzureRM.Compute/Add-AzureRMVhd.md | 214 -- ...AzureRmContainerServiceAgentPoolProfile.md | 185 -- .../Add-AzureRmImageDataDisk.md | 236 -- .../Add-AzureRmVMAdditionalUnattendContent.md | 146 -- .../AzureRM.Compute/Add-AzureRmVMDataDisk.md | 384 --- .../Add-AzureRmVMNetworkInterface.md | 166 -- .../AzureRM.Compute/Add-AzureRmVMSecret.md | 171 -- .../Add-AzureRmVMSshPublicKey.md | 125 - ...dd-AzureRmVmssAdditionalUnattendContent.md | 192 -- .../Add-AzureRmVmssDataDisk.md | 228 -- .../Add-AzureRmVmssDiagnosticsExtension.md | 217 -- .../Add-AzureRmVmssExtension.md | 270 -- ...zureRmVmssNetworkInterfaceConfiguration.md | 246 -- .../AzureRM.Compute/Add-AzureRmVmssSecret.md | 165 -- .../Add-AzureRmVmssSshPublicKey.md | 151 -- .../Add-AzureRmVmssVMDataDisk.md | 219 -- .../Add-AzureRmVmssWinRMListener.md | 159 -- .../AzureRM.Compute/AzureRM.Compute.md | 564 ---- .../ConvertTo-AzureRmVMManagedDisk.md | 142 -- .../Disable-AzureRmVMDiskEncryption.md | 268 -- .../Disable-AzureRmVmssDiskEncryption.md | 207 -- ...AzureRmLogAnalyticRequestRateByInterval.md | 238 -- ...ort-AzureRmLogAnalyticThrottledRequests.md | 223 -- .../Get-AzureRMVMDiagnosticsExtension.md | 135 - .../Get-AzureRMVMSqlServerExtension.md | 157 -- .../Get-AzureRmAvailabilitySet.md | 111 - .../Get-AzureRmComputeResourceSku.md | 65 - .../Get-AzureRmContainerService.md | 106 - .../AzureRM.Compute/Get-AzureRmDisk.md | 110 - .../AzureRM.Compute/Get-AzureRmGallery.md | 130 - .../Get-AzureRmGalleryImageDefinition.md | 133 - .../Get-AzureRmGalleryImageVersion.md | 166 -- .../AzureRM.Compute/Get-AzureRmImage.md | 125 - .../Get-AzureRmRemoteDesktopFile.md | 147 -- .../AzureRM.Compute/Get-AzureRmSnapshot.md | 110 - .../AzureRM.Compute/Get-AzureRmVM.md | 236 -- .../Get-AzureRmVMADDomainExtension.md | 124 - .../Get-AzureRmVMAEMExtension.md | 157 -- .../Get-AzureRmVMAccessExtension.md | 145 -- .../Get-AzureRmVMBootDiagnosticsData.md | 169 -- .../Get-AzureRmVMChefExtension.md | 179 -- .../Get-AzureRmVMCustomScriptExtension.md | 144 -- .../Get-AzureRmVMDiskEncryptionStatus.md | 149 -- .../Get-AzureRmVMDscExtension.md | 137 - .../Get-AzureRmVMDscExtensionStatus.md | 112 - .../AzureRM.Compute/Get-AzureRmVMExtension.md | 146 -- .../Get-AzureRmVMExtensionImage.md | 155 -- .../Get-AzureRmVMExtensionImageType.md | 106 - .../AzureRM.Compute/Get-AzureRmVMImage.md | 179 -- .../Get-AzureRmVMImageOffer.md | 108 - .../Get-AzureRmVMImagePublisher.md | 91 - .../AzureRM.Compute/Get-AzureRmVMImageSku.md | 122 - .../Get-AzureRmVMRunCommandDocument.md | 104 - .../AzureRM.Compute/Get-AzureRmVMSize.md | 158 -- .../AzureRM.Compute/Get-AzureRmVMUsage.md | 85 - .../AzureRM.Compute/Get-AzureRmVmss.md | 160 -- .../Get-AzureRmVmssDiskEncryption.md | 112 - .../Get-AzureRmVmssRollingUpgrade.md | 96 - .../AzureRM.Compute/Get-AzureRmVmssSku.md | 101 - .../AzureRM.Compute/Get-AzureRmVmssVM.md | 161 -- .../Get-AzureRmVmssVMDiskEncryption.md | 128 - .../Grant-AzureRmDiskAccess.md | 172 -- .../Grant-AzureRmSnapshotAccess.md | 172 -- .../Invoke-AzureRmVMRunCommand.md | 235 -- .../Invoke-AzureRmVmssVMRunCommand.md | 258 -- .../New-AzureRmAvailabilitySet.md | 199 -- .../New-AzureRmContainerService.md | 181 -- .../New-AzureRmContainerServiceConfig.md | 339 --- .../AzureRM.Compute/New-AzureRmDisk.md | 169 -- .../AzureRM.Compute/New-AzureRmDiskConfig.md | 370 --- .../New-AzureRmDiskUpdateConfig.md | 266 -- .../AzureRM.Compute/New-AzureRmGallery.md | 190 -- .../New-AzureRmGalleryImageDefinition.md | 477 ---- .../New-AzureRmGalleryImageVersion.md | 294 --- .../AzureRM.Compute/New-AzureRmImage.md | 172 -- .../AzureRM.Compute/New-AzureRmImageConfig.md | 207 -- .../AzureRM.Compute/New-AzureRmSnapshot.md | 169 -- .../New-AzureRmSnapshotConfig.md | 320 --- .../New-AzureRmSnapshotUpdateConfig.md | 236 -- .../AzureRM.Compute/New-AzureRmVM.md | 718 ------ .../AzureRM.Compute/New-AzureRmVMConfig.md | 258 -- .../AzureRM.Compute/New-AzureRmVMDataDisk.md | 238 -- .../New-AzureRmVMSqlServerAutoBackupConfig.md | 348 --- ...ew-AzureRmVMSqlServerAutoPatchingConfig.md | 158 -- ...reRmVMSqlServerKeyVaultCredentialConfig.md | 158 -- .../AzureRM.Compute/New-AzureRmVmss.md | 699 ----- .../AzureRM.Compute/New-AzureRmVmssConfig.md | 673 ----- .../New-AzureRmVmssIpConfig.md | 327 --- .../New-AzureRmVmssIpTagConfig.md | 128 - .../New-AzureRmVmssVaultCertificateConfig.md | 137 - .../Publish-AzureRmVMDscConfiguration.md | 301 --- .../Remove-AzureRMVMSqlServerExtension.md | 118 - .../Remove-AzureRmAvailabilitySet.md | 164 -- .../Remove-AzureRmContainerService.md | 165 -- ...AzureRmContainerServiceAgentPoolProfile.md | 138 - .../AzureRM.Compute/Remove-AzureRmDisk.md | 157 -- .../AzureRM.Compute/Remove-AzureRmGallery.md | 202 -- .../Remove-AzureRmGalleryImageDefinition.md | 217 -- .../Remove-AzureRmGalleryImageVersion.md | 233 -- .../AzureRM.Compute/Remove-AzureRmImage.md | 157 -- .../Remove-AzureRmImageDataDisk.md | 128 - .../AzureRM.Compute/Remove-AzureRmSnapshot.md | 157 -- .../AzureRM.Compute/Remove-AzureRmVM.md | 194 -- .../Remove-AzureRmVMAEMExtension.md | 139 - .../Remove-AzureRmVMAccessExtension.md | 158 -- .../AzureRM.Compute/Remove-AzureRmVMBackup.md | 103 - .../Remove-AzureRmVMChefExtension.md | 191 -- .../Remove-AzureRmVMCustomScriptExtension.md | 155 -- .../Remove-AzureRmVMDataDisk.md | 139 - .../Remove-AzureRmVMDiagnosticsExtension.md | 123 - ...Remove-AzureRmVMDiskEncryptionExtension.md | 176 -- .../Remove-AzureRmVMDscExtension.md | 150 -- .../Remove-AzureRmVMExtension.md | 164 -- .../Remove-AzureRmVMNetworkInterface.md | 125 - .../AzureRM.Compute/Remove-AzureRmVMSecret.md | 128 - .../AzureRM.Compute/Remove-AzureRmVmss.md | 201 -- .../Remove-AzureRmVmssDataDisk.md | 160 -- .../Remove-AzureRmVmssDiagnosticsExtension.md | 138 - .../Remove-AzureRmVmssExtension.md | 163 -- ...zureRmVmssNetworkInterfaceConfiguration.md | 159 -- .../Remove-AzureRmVmssVMDataDisk.md | 100 - ...ir-AzureRmVmssServiceFabricUpdateDomain.md | 220 -- .../AzureRM.Compute/Restart-AzureRmVM.md | 207 -- .../AzureRM.Compute/Restart-AzureRmVmss.md | 183 -- .../Revoke-AzureRmDiskAccess.md | 141 - .../Revoke-AzureRmSnapshotAccess.md | 141 - .../AzureRM.Compute/Save-AzureRmVMImage.md | 222 -- .../AzureRM.Compute/Save-AzureRmVhd.md | 216 -- .../AzureRM.Compute/Set-AzureRMVMDataDisk.md | 206 -- .../Set-AzureRMVMDiagnosticsExtension.md | 267 -- .../Set-AzureRMVMSqlServerExtension.md | 241 -- .../Set-AzureRmDiskDiskEncryptionKey.md | 152 -- .../Set-AzureRmDiskImageReference.md | 150 -- .../Set-AzureRmDiskKeyEncryptionKey.md | 152 -- .../Set-AzureRmDiskUpdateDiskEncryptionKey.md | 153 -- .../Set-AzureRmDiskUpdateKeyEncryptionKey.md | 153 -- .../AzureRM.Compute/Set-AzureRmImageOsDisk.md | 258 -- .../Set-AzureRmSnapshotDiskEncryptionKey.md | 153 -- .../Set-AzureRmSnapshotImageReference.md | 150 -- .../Set-AzureRmSnapshotKeyEncryptionKey.md | 152 -- ...-AzureRmSnapshotUpdateDiskEncryptionKey.md | 154 -- ...t-AzureRmSnapshotUpdateKeyEncryptionKey.md | 153 -- .../AzureRM.Compute/Set-AzureRmVM.md | 182 -- .../Set-AzureRmVMADDomainExtension.md | 289 --- .../Set-AzureRmVMAEMExtension.md | 172 -- .../Set-AzureRmVMAccessExtension.md | 239 -- .../Set-AzureRmVMBackupExtension.md | 116 - .../Set-AzureRmVMBginfoExtension.md | 211 -- .../Set-AzureRmVMBootDiagnostics.md | 162 -- .../Set-AzureRmVMChefExtension.md | 456 ---- .../Set-AzureRmVMCustomScriptExtension.md | 366 --- .../Set-AzureRmVMDiskEncryptionExtension.md | 634 ----- .../Set-AzureRmVMDscExtension.md | 395 --- .../AzureRM.Compute/Set-AzureRmVMExtension.md | 355 --- .../AzureRM.Compute/Set-AzureRmVMOSDisk.md | 442 ---- .../Set-AzureRmVMOperatingSystem.md | 352 --- .../AzureRM.Compute/Set-AzureRmVMPlan.md | 152 -- .../Set-AzureRmVMSourceImage.md | 191 -- .../AzureRM.Compute/Set-AzureRmVmss.md | 256 -- .../Set-AzureRmVmssBootDiagnostic.md | 149 -- .../Set-AzureRmVmssDiskEncryptionExtension.md | 325 --- .../Set-AzureRmVmssOsProfile.md | 331 --- .../Set-AzureRmVmssRollingUpgradePolicy.md | 188 -- .../Set-AzureRmVmssStorageProfile.md | 383 --- .../AzureRM.Compute/Set-AzureRmVmssVM.md | 232 -- .../AzureRM.Compute/Start-AzureRmVM.md | 178 -- .../AzureRM.Compute/Start-AzureRmVmss.md | 184 -- .../Start-AzureRmVmssRollingOSUpgrade.md | 143 -- .../AzureRM.Compute/Stop-AzureRmVM.md | 209 -- .../AzureRM.Compute/Stop-AzureRmVmss.md | 222 -- .../Stop-AzureRmVmssRollingUpgrade.md | 164 -- .../Test-AzureRmVMAEMExtension.md | 156 -- .../Update-AzureRmAvailabilitySet.md | 178 -- .../Update-AzureRmContainerService.md | 180 -- .../AzureRM.Compute/Update-AzureRmDisk.md | 210 -- .../AzureRM.Compute/Update-AzureRmGallery.md | 219 -- .../Update-AzureRmGalleryImageDefinition.md | 432 ---- .../Update-AzureRmGalleryImageVersion.md | 313 --- .../AzureRM.Compute/Update-AzureRmImage.md | 160 -- .../AzureRM.Compute/Update-AzureRmSnapshot.md | 211 -- .../AzureRM.Compute/Update-AzureRmVM.md | 299 --- .../AzureRM.Compute/Update-AzureRmVmss.md | 827 ------ .../Update-AzureRmVmssInstance.md | 165 -- .../AzureRM.Compute/Update-AzureRmVmssVM.md | 241 -- .../AzureRM.Consumption.md | 42 - .../Get-AzureRmConsumptionBudget.md | 145 -- .../Get-AzureRmConsumptionMarketplace.md | 245 -- .../Get-AzureRmConsumptionPriceSheet.md | 169 -- ...Get-AzureRmConsumptionReservationDetail.md | 151 -- ...et-AzureRmConsumptionReservationSummary.md | 203 -- .../Get-AzureRmConsumptionUsageDetail.md | 339 --- .../New-AzureRmConsumptionBudget.md | 381 --- .../Remove-AzureRmConsumptionBudget.md | 176 -- .../Set-AzureRmConsumptionBudget.md | 434 ---- .../AzureRM.ContainerInstance.md | 27 - .../Get-AzureRmContainerGroup.md | 200 -- .../Get-AzureRmContainerInstanceLog.md | 213 -- .../New-AzureRmContainerGroup.md | 549 ---- .../Remove-AzureRmContainerGroup.md | 202 -- .../AzureRM.ContainerRegistry.md | 63 - .../Get-AzureRmContainerRegistry.md | 209 -- .../Get-AzureRmContainerRegistryCredential.md | 151 -- ...Get-AzureRmContainerRegistryReplication.md | 191 -- .../Get-AzureRmContainerRegistryWebhook.md | 223 -- ...et-AzureRmContainerRegistryWebhookEvent.md | 179 -- .../New-AzureRmContainerRegistry.md | 250 -- ...New-AzureRmContainerRegistryReplication.md | 227 -- .../New-AzureRmContainerRegistryWebhook.md | 310 --- .../Remove-AzureRmContainerRegistry.md | 192 -- ...ove-AzureRmContainerRegistryReplication.md | 210 -- .../Remove-AzureRmContainerRegistryWebhook.md | 211 -- ...zureRmContainerRegistryNameAvailability.md | 88 - .../Test-AzureRmContainerRegistryWebhook.md | 169 -- .../Update-AzureRmContainerRegistry.md | 308 --- ...date-AzureRmContainerRegistryCredential.md | 203 -- .../Update-AzureRmContainerRegistryWebhook.md | 295 --- .../AzureRM.DataFactories.md | 108 - .../Get-AzureRmDataFactory.md | 131 - .../Get-AzureRmDataFactoryActivityWindow.md | 399 --- .../Get-AzureRmDataFactoryDataset.md | 198 -- .../Get-AzureRmDataFactoryGateway.md | 185 -- .../Get-AzureRmDataFactoryGatewayAuthKey.md | 146 -- .../Get-AzureRmDataFactoryHub.md | 155 -- .../Get-AzureRmDataFactoryLinkedService.md | 170 -- .../Get-AzureRmDataFactoryPipeline.md | 227 -- .../Get-AzureRmDataFactoryRun.md | 200 -- .../Get-AzureRmDataFactorySlice.md | 258 -- .../New-AzureRmDataFactory.md | 195 -- .../New-AzureRmDataFactoryDataset.md | 272 -- .../New-AzureRmDataFactoryEncryptValue.md | 325 --- .../New-AzureRmDataFactoryGateway.md | 172 -- .../New-AzureRmDataFactoryGatewayAuthKey.md | 192 -- .../New-AzureRmDataFactoryGatewayKey.md | 150 -- .../New-AzureRmDataFactoryHub.md | 209 -- .../New-AzureRmDataFactoryLinkedService.md | 223 -- .../New-AzureRmDataFactoryPipeline.md | 229 -- .../Remove-AzureRmDataFactory.md | 180 -- .../Remove-AzureRmDataFactoryDataset.md | 198 -- .../Remove-AzureRmDataFactoryGateway.md | 199 -- .../Remove-AzureRmDataFactoryHub.md | 194 -- .../Remove-AzureRmDataFactoryLinkedService.md | 198 -- .../Remove-AzureRmDataFactoryPipeline.md | 204 -- .../Resume-AzureRmDataFactoryPipeline.md | 189 -- .../Save-AzureRmDataFactoryLog.md | 205 -- .../Set-AzureRmDataFactoryGateway.md | 173 -- ...-AzureRmDataFactoryPipelineActivePeriod.md | 261 -- .../Set-AzureRmDataFactorySliceStatus.md | 237 -- .../Suspend-AzureRmDataFactoryPipeline.md | 189 -- .../AzureRM.DataFactoryV2.md | 129 - .../Get-AzureRmDataFactoryV2.md | 144 -- .../Get-AzureRmDataFactoryV2ActivityRun.md | 233 -- .../Get-AzureRmDataFactoryV2Dataset.md | 198 -- ...-AzureRmDataFactoryV2IntegrationRuntime.md | 252 -- ...ureRmDataFactoryV2IntegrationRuntimeKey.md | 163 -- ...RmDataFactoryV2IntegrationRuntimeMetric.md | 164 -- ...reRmDataFactoryV2IntegrationRuntimeNode.md | 246 -- .../Get-AzureRmDataFactoryV2LinkedService.md | 206 -- .../Get-AzureRmDataFactoryV2Pipeline.md | 251 -- .../Get-AzureRmDataFactoryV2PipelineRun.md | 212 -- .../Get-AzureRmDataFactoryV2Trigger.md | 190 -- .../Get-AzureRmDataFactoryV2TriggerRun.md | 181 -- ...mDataFactoryV2IntegrationRuntimeUpgrade.md | 194 -- .../Invoke-AzureRmDataFactoryV2Pipeline.md | 218 -- ...ureRmDataFactoryV2IntegrationRuntimeKey.md | 225 -- ...ctoryV2LinkedServiceEncryptedCredential.md | 198 -- .../Remove-AzureRmDataFactoryV2.md | 198 -- .../Remove-AzureRmDataFactoryV2Dataset.md | 214 -- ...-AzureRmDataFactoryV2IntegrationRuntime.md | 226 -- ...reRmDataFactoryV2IntegrationRuntimeNode.md | 219 -- ...emove-AzureRmDataFactoryV2LinkedService.md | 217 -- .../Remove-AzureRmDataFactoryV2Pipeline.md | 218 -- .../Remove-AzureRmDataFactoryV2Trigger.md | 216 -- .../Set-AzureRmDataFactoryV2.md | 192 -- .../Set-AzureRmDataFactoryV2Dataset.md | 217 -- ...-AzureRmDataFactoryV2IntegrationRuntime.md | 501 ---- .../Set-AzureRmDataFactoryV2LinkedService.md | 217 -- .../Set-AzureRmDataFactoryV2Pipeline.md | 220 -- .../Set-AzureRmDataFactoryV2Trigger.md | 208 -- ...-AzureRmDataFactoryV2IntegrationRuntime.md | 226 -- .../Start-AzureRmDataFactoryV2Trigger.md | 215 -- ...-AzureRmDataFactoryV2IntegrationRuntime.md | 206 -- .../Stop-AzureRmDataFactoryV2PipelineRun.md | 213 -- .../Stop-AzureRmDataFactoryV2Trigger.md | 215 -- ...taFactoryV2IntegrationRuntimeCredential.md | 203 -- .../Update-AzureRmDataFactoryV2.md | 201 -- ...-AzureRmDataFactoryV2IntegrationRuntime.md | 250 -- ...reRmDataFactoryV2IntegrationRuntimeNode.md | 231 -- .../Add-AzureRmDataLakeAnalyticsDataSource.md | 155 -- ...dd-AzureRmDataLakeAnalyticsFirewallRule.md | 173 -- .../AzureRM.DataLakeAnalytics.md | 117 - .../Get-AzureRmDataLakeAnalyticsAccount.md | 131 - ...Get-AzureRmDataLakeAnalyticsCatalogItem.md | 143 -- ...eRmDataLakeAnalyticsCatalogItemAclEntry.md | 246 -- ...t-AzureRmDataLakeAnalyticsComputePolicy.md | 119 - .../Get-AzureRmDataLakeAnalyticsDataSource.md | 159 -- ...et-AzureRmDataLakeAnalyticsFirewallRule.md | 118 - .../Get-AzureRmDataLakeAnalyticsJob.md | 317 --- ...Get-AzureRmDataLakeAnalyticsJobPipeline.md | 145 -- ...t-AzureRmDataLakeAnalyticsJobRecurrence.md | 145 -- .../New-AzureRmDataLakeAnalyticsAccount.md | 223 -- ...ureRmDataLakeAnalyticsCatalogCredential.md | 230 -- ...w-AzureRmDataLakeAnalyticsCatalogSecret.md | 176 -- ...w-AzureRmDataLakeAnalyticsComputePolicy.md | 217 -- .../Remove-AzureRmDataLakeAnalyticsAccount.md | 169 -- ...ureRmDataLakeAnalyticsCatalogCredential.md | 210 -- ...eRmDataLakeAnalyticsCatalogItemAclEntry.md | 243 -- ...e-AzureRmDataLakeAnalyticsCatalogSecret.md | 180 -- ...e-AzureRmDataLakeAnalyticsComputePolicy.md | 158 -- ...move-AzureRmDataLakeAnalyticsDataSource.md | 204 -- ...ve-AzureRmDataLakeAnalyticsFirewallRule.md | 160 -- .../Set-AzureRmDataLakeAnalyticsAccount.md | 227 -- ...ureRmDataLakeAnalyticsCatalogCredential.md | 235 -- ...eRmDataLakeAnalyticsCatalogItemAclEntry.md | 398 --- ...t-AzureRmDataLakeAnalyticsCatalogSecret.md | 176 -- .../Set-AzureRmDataLakeAnalyticsDataSource.md | 133 - ...et-AzureRmDataLakeAnalyticsFirewallRule.md | 173 -- .../Stop-AzureRmDataLakeAnalyticsJob.md | 171 -- .../Submit-AzureRmDataLakeAnalyticsJob.md | 389 --- .../Test-AzureRmDataLakeAnalyticsAccount.md | 105 - ...est-AzureRmDataLakeAnalyticsCatalogItem.md | 135 - ...e-AzureRmDataLakeAnalyticsComputePolicy.md | 182 -- .../Wait-AzureRmDataLakeAnalyticsJob.md | 139 - .../Add-AzureRmDataLakeStoreFirewallRule.md | 171 -- .../Add-AzureRmDataLakeStoreItemContent.md | 151 -- ...d-AzureRmDataLakeStoreTrustedIdProvider.md | 156 -- ...-AzureRmDataLakeStoreVirtualNetworkRule.md | 149 -- .../AzureRM.DataLakeStore.md | 141 - .../Enable-AzureRmDataLakeStoreKeyVault.md | 131 - ...AzureRmDataLakeStoreChildItemProperties.md | 301 --- .../Export-AzureRmDataLakeStoreItem.md | 270 -- .../Get-AzureRmDataLakeStoreAccount.md | 131 - .../Get-AzureRmDataLakeStoreChildItem.md | 99 - ...et-AzureRmDataLakeStoreChildItemSummary.md | 148 -- .../Get-AzureRmDataLakeStoreFirewallRule.md | 121 - .../Get-AzureRmDataLakeStoreItem.md | 117 - .../Get-AzureRmDataLakeStoreItemAclEntry.md | 105 - .../Get-AzureRmDataLakeStoreItemContent.md | 268 -- .../Get-AzureRmDataLakeStoreItemOwner.md | 123 - .../Get-AzureRmDataLakeStoreItemPermission.md | 105 - ...t-AzureRmDataLakeStoreTrustedIdProvider.md | 121 - ...-AzureRmDataLakeStoreVirtualNetworkRule.md | 105 - .../Import-AzureRmDataLakeStoreItem.md | 284 --- .../Join-AzureRmDataLakeStoreItem.md | 180 -- .../Move-AzureRmDataLakeStoreItem.md | 178 -- .../New-AzureRmDataLakeStoreAccount.md | 257 -- .../New-AzureRmDataLakeStoreItem.md | 226 -- .../Remove-AzureRmDataLakeStoreAccount.md | 169 -- ...Remove-AzureRmDataLakeStoreFirewallRule.md | 158 -- .../Remove-AzureRmDataLakeStoreItem.md | 192 -- .../Remove-AzureRmDataLakeStoreItemAcl.md | 186 -- ...Remove-AzureRmDataLakeStoreItemAclEntry.md | 293 --- ...e-AzureRmDataLakeStoreTrustedIdProvider.md | 158 -- ...-AzureRmDataLakeStoreVirtualNetworkRule.md | 144 -- .../Set-AzureRmDataLakeStoreAccount.md | 229 -- .../Set-AzureRmDataLakeStoreFirewallRule.md | 171 -- .../Set-AzureRmDataLakeStoreItemAcl.md | 224 -- .../Set-AzureRmDataLakeStoreItemAclEntry.md | 321 --- .../Set-AzureRmDataLakeStoreItemExpiry.md | 213 -- .../Set-AzureRmDataLakeStoreItemOwner.md | 187 -- .../Set-AzureRmDataLakeStoreItemPermission.md | 153 -- ...t-AzureRmDataLakeStoreTrustedIdProvider.md | 156 -- ...-AzureRmDataLakeStoreVirtualNetworkRule.md | 149 -- .../Test-AzureRmDataLakeStoreAccount.md | 107 - .../Test-AzureRmDataLakeStoreItem.md | 135 - .../AzureRM.DataMigration.md | 69 - .../Get-AzureRmDataMigrationProject.md | 164 -- .../Get-AzureRmDataMigrationService.md | 143 -- .../Get-AzureRmDataMigrationTask.md | 311 --- .../Invoke-AzureRmDataMigrationCommand.md | 173 -- .../New-AzureRmDataMigrationConnectionInfo.md | 82 - .../New-AzureRmDataMigrationDatabaseInfo.md | 82 - .../New-AzureRmDataMigrationFileShare.md | 98 - .../New-AzureRmDataMigrationProject.md | 283 -- ...ew-AzureRmDataMigrationSelectedDBObject.md | 196 -- .../New-AzureRmDataMigrationService.md | 171 -- ...zureRmDataMigrationSyncSelectedDBObject.md | 182 -- .../New-AzureRmDataMigrationTask.md | 220 -- .../Remove-AzureRmDataMigrationProject.md | 242 -- .../Remove-AzureRmDataMigrationService.md | 219 -- .../Remove-AzureRmDataMigrationTask.md | 243 -- .../Start-AzureRmDataMigrationService.md | 196 -- .../Stop-AzureRmDataMigrationService.md | 196 -- .../Stop-AzureRmDataMigrationTask.md | 227 -- .../AzureRM.DevSpaces/AzureRM.DevSpaces.md | 27 - .../Get-AzureRmDevSpacesController.md | 130 - .../New-AzureRmDevSpacesController.md | 192 -- .../Remove-AzureRmDevSpacesController.md | 203 -- .../Update-AzureRmDevSpacesController.md | 192 -- .../AzureRM.DevTestLabs.md | 45 - .../Get-AzureRmDtlAllowedVMSizesPolicy.md | 97 - .../Get-AzureRmDtlAutoShutdownPolicy.md | 95 - .../Get-AzureRmDtlAutoStartPolicy.md | 95 - .../Get-AzureRmDtlVMsPerLabPolicy.md | 95 - .../Get-AzureRmDtlVMsPerUserPolicy.md | 95 - .../Set-AzureRmDtlAllowedVMSizesPolicy.md | 180 -- .../Set-AzureRmDtlAutoShutdownPolicy.md | 180 -- .../Set-AzureRmDtlAutoStartPolicy.md | 196 -- .../Set-AzureRmDtlVMsPerLabPolicy.md | 178 -- .../Set-AzureRmDtlVMsPerUserPolicy.md | 178 -- ...oTDeviceProvisioningServiceAccessPolicy.md | 225 -- ...IoTDeviceProvisioningServiceCertificate.md | 251 -- ...RmIoTDeviceProvisioningServiceLinkedHub.md | 258 -- .../AzureRM.DeviceProvisioningServices.md | 66 - ...Get-AzureRmIoTDeviceProvisioningService.md | 153 -- ...oTDeviceProvisioningServiceAccessPolicy.md | 176 -- ...IoTDeviceProvisioningServiceCertificate.md | 180 -- ...RmIoTDeviceProvisioningServiceLinkedHub.md | 179 -- ...New-AzureRmIoTDeviceProvisioningService.md | 208 -- ...oningServiceCertificateVerificationCode.md | 236 -- ...ove-AzureRmIoTDeviceProvisioningService.md | 197 -- ...oTDeviceProvisioningServiceAccessPolicy.md | 214 -- ...IoTDeviceProvisioningServiceCertificate.md | 221 -- ...RmIoTDeviceProvisioningServiceLinkedHub.md | 213 -- ...IoTDeviceProvisioningServiceCertificate.md | 249 -- ...ate-AzureRmIoTDeviceProvisioningService.md | 289 --- ...oTDeviceProvisioningServiceAccessPolicy.md | 227 -- ...RmIoTDeviceProvisioningServiceLinkedHub.md | 229 -- .../AzureRM.Dns/Add-AzureRmDnsRecordConfig.md | 472 ---- azurermps-6.13.0/AzureRM.Dns/AzureRM.DNS.md | 48 - .../AzureRM.Dns/Get-AzureRmDnsRecordSet.md | 220 -- .../AzureRM.Dns/Get-AzureRmDnsZone.md | 130 - .../AzureRM.Dns/New-AzureRmDnsRecordConfig.md | 449 ---- .../AzureRM.Dns/New-AzureRmDnsRecordSet.md | 478 ---- .../AzureRM.Dns/New-AzureRmDnsZone.md | 273 -- .../Remove-AzureRmDnsRecordConfig.md | 487 ---- .../AzureRM.Dns/Remove-AzureRmDnsRecordSet.md | 297 --- .../AzureRM.Dns/Remove-AzureRmDnsZone.md | 206 -- .../AzureRM.Dns/Set-AzureRmDnsRecordSet.md | 166 -- .../AzureRM.Dns/Set-AzureRmDnsZone.md | 315 --- .../AzureRM.EventGrid/AzureRM.EventGrid.md | 48 - .../Get-AzureRmEventGridSubscription.md | 282 -- .../Get-AzureRmEventGridTopic.md | 161 -- .../Get-AzureRmEventGridTopicKey.md | 149 -- .../Get-AzureRmEventGridTopicType.md | 115 - .../New-AzureRmEventGridSubscription.md | 453 ---- .../New-AzureRmEventGridTopic.md | 166 -- .../New-AzureRmEventGridTopicKey.md | 207 -- .../Remove-AzureRmEventGridSubscription.md | 262 -- .../Remove-AzureRmEventGridTopic.md | 195 -- .../Set-AzureRmEventGridTopic.md | 202 -- .../Update-AzureRmEventGridSubscription.md | 330 --- .../AzureRM.EventHub/AzureRM.EventHub.md | 87 - .../AzureRM.EventHub/Get-AzureRmEventHub.md | 135 - .../Get-AzureRmEventHubAuthorizationRule.md | 192 -- .../Get-AzureRmEventHubConsumerGroup.md | 150 -- .../Get-AzureRmEventHubGeoDRConfiguration.md | 166 -- .../Get-AzureRmEventHubKey.md | 166 -- .../Get-AzureRmEventHubNamespace.md | 98 - .../AzureRM.EventHub/New-AzureRmEventHub.md | 222 -- .../New-AzureRmEventHubAuthorizationRule.md | 191 -- .../New-AzureRmEventHubConsumerGroup.md | 173 -- .../New-AzureRmEventHubGeoDRConfiguration.md | 243 -- .../New-AzureRmEventHubKey.md | 216 -- .../New-AzureRmEventHubNamespace.md | 258 -- .../Remove-AzureRmEventHub.md | 240 -- ...Remove-AzureRmEventHubAuthorizationRule.md | 203 -- .../Remove-AzureRmEventHubConsumerGroup.md | 256 -- ...emove-AzureRmEventHubGeoDRConfiguration.md | 219 -- .../Remove-AzureRmEventHubNamespace.md | 230 -- .../AzureRM.EventHub/Set-AzureRmEventHub.md | 219 -- .../Set-AzureRmEventHubAuthorizationRule.md | 222 -- .../Set-AzureRmEventHubConsumerGroup.md | 173 -- ...reRmEventHubGeoDRConfigurationBreakPair.md | 205 -- ...ureRmEventHubGeoDRConfigurationFailOver.md | 205 -- .../Set-AzureRmEventHubNamespace.md | 257 -- .../Test-AzureRmEventHubName.md | 131 - .../AzureRM.FrontDoor/AzureRM.FrontDoor.md | 72 - .../AzureRM.FrontDoor/Get-AzureRmFrontDoor.md | 194 -- .../Get-AzureRmFrontDoorFireWallPolicy.md | 143 -- .../AzureRM.FrontDoor/New-AzureRmFrontDoor.md | 262 -- .../New-AzureRmFrontDoorBackendObject.md | 194 -- .../New-AzureRmFrontDoorBackendPoolObject.md | 174 -- .../New-AzureRmFrontDoorCustomRuleObject.md | 205 -- .../New-AzureRmFrontDoorFireWallPolicy.md | 212 -- ...-AzureRmFrontDoorFrontendEndpointObject.md | 263 -- ...zureRmFrontDoorHealthProbeSettingObject.md | 142 -- ...reRmFrontDoorLoadBalancingSettingObject.md | 142 -- .../New-AzureRmFrontDoorManagedRuleObject.md | 121 - ...ew-AzureRmFrontDoorMatchConditionObject.md | 156 -- .../New-AzureRmFrontDoorRoutingRuleObject.md | 299 --- ...AzureRmFrontDoorRuleGroupOverrideObject.md | 106 - .../Remove-AzureRmFrontDoor.md | 213 -- .../Remove-AzureRmFrontDoorContent.md | 155 -- .../Remove-AzureRmFrontDoorFireWallPolicy.md | 199 -- .../AzureRM.FrontDoor/Set-AzureRmFrontDoor.md | 357 --- .../Set-AzureRmFrontDoorFireWallPolicy.md | 301 --- .../Add-AzureRmHDInsightClusterIdentity.md | 214 -- .../Add-AzureRmHDInsightComponentVersion.md | 171 -- .../Add-AzureRmHDInsightConfigValues.md | 408 --- .../Add-AzureRmHDInsightMetastore.md | 201 -- .../Add-AzureRmHDInsightScriptAction.md | 201 -- .../Add-AzureRmHDInsightSecurityProfile.md | 191 -- .../Add-AzureRmHDInsightStorage.md | 157 -- .../AzureRM.HDInsight/AzureRM.HDInsight.md | 129 - ...ureRmHDInsightOperationsManagementSuite.md | 149 -- ...ureRmHDInsightOperationsManagementSuite.md | 180 -- .../Get-AzureRmHDInsightCluster.md | 104 - .../Get-AzureRmHDInsightJob.md | 167 -- .../Get-AzureRmHDInsightJobOutput.md | 214 -- ...ureRmHDInsightOperationsManagementSuite.md | 133 - ...t-AzureRmHDInsightPersistedScriptAction.md | 118 - .../Get-AzureRmHDInsightProperties.md | 82 - ...Get-AzureRmHDInsightScriptActionHistory.md | 112 - ...rant-AzureRmHDInsightHttpServicesAccess.md | 122 - ...Grant-AzureRmHDInsightRdpServicesAccess.md | 140 - .../Invoke-AzureRmHDInsightHiveJob.md | 268 -- .../New-AzureRmHDInsightCluster.md | 753 ------ .../New-AzureRmHDInsightClusterConfig.md | 367 --- .../New-AzureRmHDInsightHiveJobDefinition.md | 209 -- ...-AzureRmHDInsightMapReduceJobDefinition.md | 202 -- .../New-AzureRmHDInsightPigJobDefinition.md | 161 -- .../New-AzureRmHDInsightSqoopJobDefinition.md | 155 -- ...DInsightStreamingMapReduceJobDefinition.md | 237 -- .../Remove-AzureRmHDInsightCluster.md | 106 - ...e-AzureRmHDInsightPersistedScriptAction.md | 121 - ...voke-AzureRmHDInsightHttpServicesAccess.md | 102 - ...evoke-AzureRmHDInsightRdpServicesAccess.md | 101 - .../Set-AzureRmHDInsightClusterSize.md | 112 - .../Set-AzureRmHDInsightDefaultStorage.md | 161 -- ...t-AzureRmHDInsightPersistedScriptAction.md | 124 - .../Start-AzureRmHDInsightJob.md | 152 -- .../Stop-AzureRmHDInsightJob.md | 142 -- .../Submit-AzureRmHDInsightScriptAction.md | 205 -- .../Use-AzureRmHDInsightCluster.md | 124 - .../Wait-AzureRmHDInsightJob.md | 183 -- .../Add-AzureRmAutoscaleSetting.md | 258 -- .../AzureRM.Insights/Add-AzureRmLogProfile.md | 205 -- .../Add-AzureRmMetricAlertRule.md | 344 --- .../Add-AzureRmWebtestAlertRule.md | 290 --- .../AzureRM.Insights/AzureRM.Insights.md | 123 - .../Disable-AzureRmActivityLogAlert.md | 202 -- .../Enable-AzureRmActivityLogAlert.md | 201 -- .../Get-AzureRmActionGroup.md | 134 - .../Get-AzureRmActivityLogAlert.md | 137 - .../Get-AzureRmAlertHistory.md | 407 --- .../AzureRM.Insights/Get-AzureRmAlertRule.md | 170 -- .../Get-AzureRmAutoscaleHistory.md | 316 --- .../Get-AzureRmAutoscaleSetting.md | 290 --- .../Get-AzureRmDiagnosticSetting.md | 108 - .../AzureRM.Insights/Get-AzureRmLog.md | 397 --- .../AzureRM.Insights/Get-AzureRmLogProfile.md | 80 - .../AzureRM.Insights/Get-AzureRmMetric.md | 446 ---- .../Get-AzureRmMetricDefinition.md | 232 -- .../New-AzureRmActionGroup.md | 113 - .../New-AzureRmActionGroupReceiver.md | 220 -- .../New-AzureRmActivityLogAlertCondition.md | 110 - .../New-AzureRmAlertRuleEmail.md | 122 - .../New-AzureRmAlertRuleWebhook.md | 117 - .../New-AzureRmAutoscaleNotification.md | 143 -- .../New-AzureRmAutoscaleProfile.md | 380 --- .../New-AzureRmAutoscaleRule.md | 325 --- .../New-AzureRmAutoscaleWebhook.md | 96 - .../New-AzureRmMetricFilter.md | 118 - .../Remove-AzureRmActionGroup.md | 178 -- .../Remove-AzureRmActivityLogAlert.md | 208 -- .../Remove-AzureRmAlertRule.md | 142 -- .../Remove-AzureRmAutoscaleSetting.md | 128 - .../Remove-AzureRmDiagnosticSetting.md | 138 - .../Remove-AzureRmLogProfile.md | 127 - .../Set-AzureRmActionGroup.md | 288 --- .../Set-AzureRmActivityLogAlert.md | 467 ---- .../Set-AzureRmDiagnosticSetting.md | 419 --- .../AzureRM.IotCentral/AzureRM.IotCentral.md | 27 - .../Get-AzureRmIotCentralApp.md | 223 -- .../New-AzureRmIotCentralApp.md | 277 -- .../Remove-AzureRmIotCentralApp.md | 199 -- .../Set-AzureRmIotCentralApp.md | 231 -- .../Add-AzureRmIotHubCertificate.md | 249 -- .../Add-AzureRmIotHubEventHubConsumerGroup.md | 167 -- .../AzureRM.IotHub/Add-AzureRmIotHubKey.md | 190 -- .../AzureRM.IotHub/Add-AzureRmIotHubRoute.md | 256 -- .../Add-AzureRmIotHubRoutingEndpoint.md | 278 -- .../AzureRM.IotHub/AzureRM.IotHub.md | 108 - .../AzureRM.IotHub/Get-AzureRmIotHub.md | 130 - .../Get-AzureRmIotHubCertificate.md | 180 -- ...zureRmIotHubCertificateVerificationCode.md | 185 -- .../Get-AzureRmIotHubConnectionString.md | 119 - .../Get-AzureRmIotHubEventHubConsumerGroup.md | 120 - .../AzureRM.IotHub/Get-AzureRmIotHubJob.md | 120 - .../AzureRM.IotHub/Get-AzureRmIotHubKey.md | 119 - .../Get-AzureRmIotHubQuotaMetric.md | 96 - .../Get-AzureRmIotHubRegistryStatistic.md | 97 - .../AzureRM.IotHub/Get-AzureRmIotHubRoute.md | 174 -- .../Get-AzureRmIotHubRoutingEndpoint.md | 222 -- .../Get-AzureRmIotHubValidSku.md | 98 - .../AzureRM.IotHub/New-AzureRmIotHub.md | 198 -- .../New-AzureRmIotHubExportDevices.md | 161 -- .../New-AzureRmIotHubImportDevices.md | 161 -- .../AzureRM.IotHub/Remove-AzureRmIotHub.md | 127 - .../Remove-AzureRmIotHubCertificate.md | 219 -- ...move-AzureRmIotHubEventHubConsumerGroup.md | 160 -- .../AzureRM.IotHub/Remove-AzureRmIotHubKey.md | 143 -- .../Remove-AzureRmIotHubRoute.md | 203 -- .../Remove-AzureRmIotHubRoutingEndpoint.md | 229 -- .../AzureRM.IotHub/Set-AzureRmIotHub.md | 392 --- .../AzureRM.IotHub/Set-AzureRmIotHubRoute.md | 282 -- .../Set-AzureRmIotHubVerifiedCertificate.md | 231 -- .../AzureRM.IotHub/Test-AzureRmIotHubRoute.md | 288 --- .../AzureRM.IotHub/Update-AzureRmIotHub.md | 166 -- .../Add-AzureKeyVaultCertificate.md | 221 -- .../Add-AzureKeyVaultCertificateContact.md | 201 -- .../AzureRM.KeyVault/Add-AzureKeyVaultKey.md | 561 ---- .../Add-AzureKeyVaultManagedStorageAccount.md | 280 -- .../Add-AzureRmKeyVaultNetworkRule.md | 260 -- .../AzureRM.KeyVault/AzureRM.KeyVault.md | 177 -- .../Backup-AzureKeyVaultCertificate.md | 214 -- .../Backup-AzureKeyVaultKey.md | 221 -- ...ckup-AzureKeyVaultManagedStorageAccount.md | 214 -- .../Backup-AzureKeyVaultSecret.md | 219 -- .../Get-AzureKeyVaultCertificate.md | 363 --- .../Get-AzureKeyVaultCertificateContact.md | 138 - .../Get-AzureKeyVaultCertificateIssuer.md | 158 -- .../Get-AzureKeyVaultCertificateOperation.md | 144 -- .../Get-AzureKeyVaultCertificatePolicy.md | 144 -- .../AzureRM.KeyVault/Get-AzureKeyVaultKey.md | 391 --- .../Get-AzureKeyVaultManagedStorageAccount.md | 196 -- ...zureKeyVaultManagedStorageSasDefinition.md | 187 -- .../Get-AzureKeyVaultSecret.md | 413 --- .../AzureRM.KeyVault/Get-AzureRmKeyVault.md | 300 --- .../Import-AzureKeyVaultCertificate.md | 260 -- ...KeyVaultCertificateAdministratorDetails.md | 167 -- ...eKeyVaultCertificateOrganizationDetails.md | 140 - .../New-AzureKeyVaultCertificatePolicy.md | 412 --- .../AzureRM.KeyVault/New-AzureRmKeyVault.md | 338 --- .../Remove-AzureKeyVaultCertificate.md | 253 -- .../Remove-AzureKeyVaultCertificateContact.md | 202 -- .../Remove-AzureKeyVaultCertificateIssuer.md | 196 -- ...emove-AzureKeyVaultCertificateOperation.md | 207 -- .../Remove-AzureKeyVaultKey.md | 248 -- ...move-AzureKeyVaultManagedStorageAccount.md | 239 -- ...zureKeyVaultManagedStorageSasDefinition.md | 227 -- .../Remove-AzureKeyVaultSecret.md | 252 -- .../Remove-AzureRmKeyVault.md | 299 --- .../Remove-AzureRmKeyVaultAccessPolicy.md | 449 ---- .../Remove-AzureRmKeyVaultNetworkRule.md | 256 -- .../Restore-AzureKeyVaultCertificate.md | 214 -- .../Restore-AzureKeyVaultKey.md | 201 -- ...tore-AzureKeyVaultManagedStorageAccount.md | 193 -- .../Restore-AzureKeyVaultSecret.md | 201 -- .../Set-AzureKeyVaultCertificateIssuer.md | 248 -- .../Set-AzureKeyVaultCertificatePolicy.md | 476 ---- ...zureKeyVaultManagedStorageSasDefinition.md | 267 -- .../Set-AzureKeyVaultSecret.md | 308 --- .../Set-AzureRmKeyVaultAccessPolicy.md | 677 ----- .../Stop-AzureKeyVaultCertificateOperation.md | 183 -- .../Undo-AzureKeyVaultCertificateRemoval.md | 191 -- .../Undo-AzureKeyVaultKeyRemoval.md | 173 -- ...ureKeyVaultManagedStorageAccountRemoval.md | 167 -- ...VaultManagedStorageSasDefinitionRemoval.md | 181 -- .../Undo-AzureKeyVaultSecretRemoval.md | 171 -- .../Undo-AzureRmKeyVaultRemoval.md | 222 -- .../Update-AzureKeyVaultCertificate.md | 250 -- .../Update-AzureKeyVaultKey.md | 306 --- ...date-AzureKeyVaultManagedStorageAccount.md | 272 -- ...e-AzureKeyVaultManagedStorageAccountKey.md | 213 -- .../Update-AzureKeyVaultSecret.md | 325 --- .../Update-AzureRmKeyVaultNetworkRuleSet.md | 295 --- .../AzureRM.LogicApp/AzureRM.LogicApp.md | 144 -- .../Get-AzureRmIntegrationAccount.md | 147 -- .../Get-AzureRmIntegrationAccountAgreement.md | 162 -- ...et-AzureRmIntegrationAccountCallbackUrl.md | 124 - ...et-AzureRmIntegrationAccountCertificate.md | 156 -- ...t-AzureRmIntegrationAccountGeneratedIcn.md | 166 -- .../Get-AzureRmIntegrationAccountMap.md | 154 -- .../Get-AzureRmIntegrationAccountPartner.md | 148 -- ...et-AzureRmIntegrationAccountReceivedIcn.md | 161 -- .../Get-AzureRmIntegrationAccountSchema.md | 156 -- .../AzureRM.LogicApp/Get-AzureRmLogicApp.md | 148 -- .../Get-AzureRmLogicAppRunAction.md | 168 -- .../Get-AzureRmLogicAppRunHistory.md | 165 -- .../Get-AzureRmLogicAppTrigger.md | 153 -- .../Get-AzureRmLogicAppTriggerCallbackUrl.md | 125 - .../Get-AzureRmLogicAppTriggerHistory.md | 188 -- .../Get-AzureRmLogicAppUpgradedDefinition.md | 266 -- .../New-AzureRmIntegrationAccount.md | 179 -- .../New-AzureRmIntegrationAccountAgreement.md | 334 --- ...ew-AzureRmIntegrationAccountCertificate.md | 309 --- .../New-AzureRmIntegrationAccountMap.md | 250 -- .../New-AzureRmIntegrationAccountPartner.md | 215 -- .../New-AzureRmIntegrationAccountSchema.md | 248 -- .../AzureRM.LogicApp/New-AzureRmLogicApp.md | 372 --- .../Remove-AzureRmIntegrationAccount.md | 156 -- ...move-AzureRmIntegrationAccountAgreement.md | 172 -- ...ve-AzureRmIntegrationAccountCertificate.md | 172 -- .../Remove-AzureRmIntegrationAccountMap.md | 171 -- ...Remove-AzureRmIntegrationAccountPartner.md | 171 -- ...ve-AzureRmIntegrationAccountReceivedIcn.md | 222 -- .../Remove-AzureRmIntegrationAccountSchema.md | 171 -- .../Remove-AzureRmLogicApp.md | 159 -- .../Set-AzureRmIntegrationAccount.md | 193 -- .../Set-AzureRmIntegrationAccountAgreement.md | 347 --- ...et-AzureRmIntegrationAccountCertificate.md | 261 -- ...t-AzureRmIntegrationAccountGeneratedIcn.md | 207 -- .../Set-AzureRmIntegrationAccountMap.md | 263 -- .../Set-AzureRmIntegrationAccountPartner.md | 229 -- ...et-AzureRmIntegrationAccountReceivedIcn.md | 212 -- .../Set-AzureRmIntegrationAccountSchema.md | 262 -- .../AzureRM.LogicApp/Set-AzureRmLogicApp.md | 316 --- .../AzureRM.LogicApp/Start-AzureRmLogicApp.md | 178 -- .../Stop-AzureRmLogicAppRun.md | 167 -- .../AzureRM.LogicApp/Test-AzureRmLogicApp.md | 242 -- ...Add-AzureRmMlWebServiceRegionalProperty.md | 159 -- .../AzureRM.MachineLearning.md | 60 - .../Export-AzureRmMlWebService.md | 170 -- .../Get-AzureRmMlCommitmentAssociation.md | 116 - .../Get-AzureRmMlCommitmentPlan.md | 106 - ...Get-AzureRmMlCommitmentPlanUsageHistory.md | 95 - .../Get-AzureRmMlWebService.md | 121 - .../Get-AzureRmMlWebServiceKeys.md | 125 - .../Import-AzureRmMlWebService.md | 105 - .../Move-AzureRmMlCommitmentAssociation.md | 156 -- .../New-AzureRmMlCommitmentPlan.md | 205 -- .../New-AzureRmMlWebService.md | 219 -- .../Remove-AzureRmMlCommitmentPlan.md | 163 -- .../Remove-AzureRmMlWebService.md | 164 -- .../Update-AzureRmMlCommitmentPlan.md | 201 -- .../Update-AzureRmMlWebService.md | 366 --- .../AzureRM.MachineLearningCompute.md | 36 - .../Get-AzureRmMlOpCluster.md | 129 - .../Get-AzureRmMlOpClusterKey.md | 141 - .../New-AzureRmMlOpCluster.md | 417 --- .../Remove-AzureRmMlOpCluster.md | 191 -- .../Set-AzureRmMlOpCluster.md | 325 --- ...ClusterSystemServicesUpdateAvailability.md | 150 -- .../Update-AzureRmMlOpClusterSystemService.md | 173 -- .../AzureRM.ManagedServiceIdentity.md | 24 - .../Get-AzureRmUserAssignedIdentity.md | 227 -- .../New-AzureRmUserAssignedIdentity.md | 218 -- .../Remove-AzureRmUserAssignedIdentity.md | 204 -- .../AzureRM.ManagementPartner.md | 27 - .../Get-AzureRmManagementPartner.md | 104 - .../New-AzureRmManagementPartner.md | 123 - .../Remove-AzureRmManagementPartner.md | 134 - .../Update-AzureRmManagementPartner.md | 123 - azurermps-6.13.0/AzureRM.Maps/AzureRM.Maps.md | 31 - .../AzureRM.Maps/Get-AzureRmMapsAccount.md | 176 -- .../AzureRM.Maps/Get-AzureRmMapsAccountKey.md | 161 -- .../AzureRM.Maps/New-AzureRmMapsAccount.md | 177 -- .../AzureRM.Maps/New-AzureRmMapsAccountKey.md | 214 -- .../AzureRM.Maps/Remove-AzureRmMapsAccount.md | 205 -- .../AzureRM.MarketplaceOrdering.md | 21 - .../Get-AzureRmMarketplaceTerms.md | 117 - .../Set-AzureRmMarketplaceTerms.md | 229 -- .../AzureRM.Media/AzureRM.Media.md | 43 - .../AzureRM.Media/Get-AzureRmMediaService.md | 119 - .../Get-AzureRmMediaServiceKeys.md | 101 - ...Get-AzureRmMediaServiceNameAvailability.md | 94 - .../AzureRM.Media/New-AzureRmMediaService.md | 268 -- .../New-AzureRmMediaServiceStorageConfig.md | 137 - .../Remove-AzureRmMediaService.md | 151 -- .../AzureRM.Media/Set-AzureRmMediaService.md | 174 -- .../Set-AzureRmMediaServiceKey.md | 156 -- .../Sync-AzureRmMediaServiceStorageKeys.md | 146 -- ...icationGatewayAuthenticationCertificate.md | 149 -- ...eRmApplicationGatewayBackendAddressPool.md | 193 -- ...RmApplicationGatewayBackendHttpSettings.md | 314 --- ...dd-AzureRmApplicationGatewayCustomError.md | 112 - ...ureRmApplicationGatewayFrontendIPConfig.md | 234 -- ...d-AzureRmApplicationGatewayFrontendPort.md | 125 - ...d-AzureRmApplicationGatewayHttpListener.md | 268 -- ...plicationGatewayHttpListenerCustomError.md | 114 - ...zureRmApplicationGatewayIPConfiguration.md | 154 -- ...dd-AzureRmApplicationGatewayProbeConfig.md | 260 -- ...ApplicationGatewayRedirectConfiguration.md | 208 -- ...eRmApplicationGatewayRequestRoutingRule.md | 287 --- ...AzureRmApplicationGatewaySslCertificate.md | 141 - ...pplicationGatewayTrustedRootCertificate.md | 148 -- ...ureRmApplicationGatewayUrlPathMapConfig.md | 220 -- .../AzureRM.Network/Add-AzureRmDelegation.md | 120 - ...AzureRmExpressRouteCircuitAuthorization.md | 129 - ...reRmExpressRouteCircuitConnectionConfig.md | 211 -- ...AzureRmExpressRouteCircuitPeeringConfig.md | 361 --- ...eRmLoadBalancerBackendAddressPoolConfig.md | 140 - ...Add-AzureRmLoadBalancerFrontendIpConfig.md | 280 -- ...AzureRmLoadBalancerInboundNatPoolConfig.md | 257 -- ...AzureRmLoadBalancerInboundNatRuleConfig.md | 277 -- ...d-AzureRmLoadBalancerOutboundRuleConfig.md | 254 -- .../Add-AzureRmLoadBalancerProbeConfig.md | 218 -- .../Add-AzureRmLoadBalancerRuleConfig.md | 367 --- .../Add-AzureRmNetworkInterfaceIpConfig.md | 377 --- .../Add-AzureRmNetworkInterfaceTapConfig.md | 170 -- .../Add-AzureRmNetworkSecurityRuleConfig.md | 371 --- .../AzureRM.Network/Add-AzureRmRouteConfig.md | 256 -- .../Add-AzureRmRouteFilterRuleConfig.md | 204 -- ...-AzureRmServiceEndpointPolicyDefinition.md | 146 -- ...dd-AzureRmVirtualNetworkGatewayIpConfig.md | 269 -- .../Add-AzureRmVirtualNetworkPeering.md | 242 -- .../Add-AzureRmVirtualNetworkSubnetConfig.md | 269 -- .../Add-AzureRmVpnClientRevokedCertificate.md | 144 -- .../Add-AzureRmVpnClientRootCertificate.md | 158 -- .../AzureRM.Network/AzureRM.Network.md | 1111 -------- ...AzureRMNetworkWatcherReachabilityReport.md | 376 --- .../Get-AzureRmApplicationGateway.md | 115 - ...icationGatewayAuthenticationCertificate.md | 102 - ...pplicationGatewayAutoscaleConfiguration.md | 84 - ...RmApplicationGatewayAvailableSslOptions.md | 66 - ...mApplicationGatewayAvailableWafRuleSets.md | 67 - ...eRmApplicationGatewayBackendAddressPool.md | 118 - ...-AzureRmApplicationGatewayBackendHealth.md | 136 - ...RmApplicationGatewayBackendHttpSettings.md | 115 - ...eRmApplicationGatewayConnectionDraining.md | 96 - ...et-AzureRmApplicationGatewayCustomError.md | 103 - ...ureRmApplicationGatewayFrontendIPConfig.md | 117 - ...t-AzureRmApplicationGatewayFrontendPort.md | 119 - ...t-AzureRmApplicationGatewayHttpListener.md | 117 - ...plicationGatewayHttpListenerCustomError.md | 105 - ...zureRmApplicationGatewayIPConfiguration.md | 118 - ...et-AzureRmApplicationGatewayProbeConfig.md | 108 - ...ApplicationGatewayRedirectConfiguration.md | 99 - ...eRmApplicationGatewayRequestRoutingRule.md | 119 - .../Get-AzureRmApplicationGatewaySku.md | 91 - ...AzureRmApplicationGatewaySslCertificate.md | 121 - .../Get-AzureRmApplicationGatewaySslPolicy.md | 92 - ...RmApplicationGatewaySslPredefinedPolicy.md | 88 - ...pplicationGatewayTrustedRootCertificate.md | 98 - ...ureRmApplicationGatewayUrlPathMapConfig.md | 108 - ...ewayWebApplicationFirewallConfiguration.md | 94 - .../Get-AzureRmApplicationSecurityGroup.md | 118 - .../Get-AzureRmAvailableServiceDelegation.md | 96 - .../Get-AzureRmBgpServiceCommunity.md | 130 - .../Get-AzureRmDdosProtectionPlan.md | 172 -- .../AzureRM.Network/Get-AzureRmDelegation.md | 118 - ...et-AzureRmEffectiveNetworkSecurityGroup.md | 101 - .../Get-AzureRmEffectiveRouteTable.md | 116 - .../Get-AzureRmExpressRouteCircuit.md | 105 - .../Get-AzureRmExpressRouteCircuitARPTable.md | 137 - ...AzureRmExpressRouteCircuitAuthorization.md | 135 - ...reRmExpressRouteCircuitConnectionConfig.md | 113 - ...AzureRmExpressRouteCircuitPeeringConfig.md | 106 - ...et-AzureRmExpressRouteCircuitRouteTable.md | 138 - ...eRmExpressRouteCircuitRouteTableSummary.md | 138 - .../Get-AzureRmExpressRouteCircuitStats.md | 120 - .../Get-AzureRmExpressRoutePort.md | 127 - .../Get-AzureRmExpressRoutePortLinkConfig.md | 126 - .../Get-AzureRmExpressRoutePortsLocation.md | 91 - .../Get-AzureRmExpressRouteServiceProvider.md | 75 - .../AzureRM.Network/Get-AzureRmFirewall.md | 178 -- .../Get-AzureRmFirewallFqdnTag.md | 79 - .../Get-AzureRmInterfaceEndpoint.md | 161 -- .../Get-AzureRmLoadBalancer.md | 146 -- ...eRmLoadBalancerBackendAddressPoolConfig.md | 110 - ...Get-AzureRmLoadBalancerFrontendIpConfig.md | 112 - ...AzureRmLoadBalancerInboundNatPoolConfig.md | 91 - ...AzureRmLoadBalancerInboundNatRuleConfig.md | 110 - ...t-AzureRmLoadBalancerOutboundRuleConfig.md | 98 - .../Get-AzureRmLoadBalancerProbeConfig.md | 112 - .../Get-AzureRmLoadBalancerRuleConfig.md | 110 - .../Get-AzureRmLocalNetworkGateway.md | 94 - .../Get-AzureRmNetworkInterface.md | 223 -- .../Get-AzureRmNetworkInterfaceIpConfig.md | 112 - .../Get-AzureRmNetworkInterfaceTapConfig.md | 170 -- .../Get-AzureRmNetworkProfile.md | 174 -- .../Get-AzureRmNetworkSecurityGroup.md | 149 -- .../Get-AzureRmNetworkSecurityRuleConfig.md | 132 - .../Get-AzureRmNetworkUsage.md | 124 - .../Get-AzureRmNetworkWatcher.md | 197 -- ...-AzureRmNetworkWatcherConnectionMonitor.md | 260 -- ...RmNetworkWatcherConnectionMonitorReport.md | 430 ---- .../Get-AzureRmNetworkWatcherFlowLogStatus.md | 269 -- .../Get-AzureRmNetworkWatcherNextHop.md | 286 --- .../Get-AzureRmNetworkWatcherPacketCapture.md | 240 -- ...NetworkWatcherReachabilityProvidersList.md | 320 --- ...-AzureRmNetworkWatcherSecurityGroupView.md | 232 -- .../Get-AzureRmNetworkWatcherTopology.md | 308 --- ...reRmNetworkWatcherTroubleshootingResult.md | 224 -- .../Get-AzureRmPublicIpAddress.md | 271 -- .../Get-AzureRmPublicIpPrefix.md | 125 - .../AzureRM.Network/Get-AzureRmRouteConfig.md | 119 - .../AzureRM.Network/Get-AzureRmRouteFilter.md | 142 -- .../Get-AzureRmRouteFilterRuleConfig.md | 97 - .../AzureRM.Network/Get-AzureRmRouteTable.md | 171 -- .../Get-AzureRmServiceEndpointPolicy.md | 105 - ...-AzureRmServiceEndpointPolicyDefinition.md | 141 - .../AzureRM.Network/Get-AzureRmVirtualHub.md | 119 - .../Get-AzureRmVirtualHubVnetConnection.md | 192 -- .../Get-AzureRmVirtualNetwork.md | 149 -- ...mVirtualNetworkAvailableEndpointService.md | 85 - .../Get-AzureRmVirtualNetworkGateway.md | 94 - ...eRmVirtualNetworkGatewayAdvertisedRoute.md | 135 - ...ureRmVirtualNetworkGatewayBGPPeerStatus.md | 136 - ...-AzureRmVirtualNetworkGatewayConnection.md | 94 - ...irtualNetworkGatewayConnectionSharedKey.md | 92 - ...kGatewayConnectionVpnDeviceConfigScript.md | 175 -- ...zureRmVirtualNetworkGatewayLearnedRoute.md | 136 - ...VirtualNetworkGatewaySupportedVpnDevice.md | 108 - .../Get-AzureRmVirtualNetworkPeering.md | 120 - .../Get-AzureRmVirtualNetworkSubnetConfig.md | 112 - .../Get-AzureRmVirtualNetworkTap.md | 148 -- .../Get-AzureRmVirtualNetworkUsageList.md | 110 - .../AzureRM.Network/Get-AzureRmVirtualWan.md | 113 - .../Get-AzureRmVirtualWanVpnConfiguration.md | 264 -- .../Get-AzureRmVpnClientConfiguration.md | 128 - .../Get-AzureRmVpnClientIpsecParameter.md | 97 - .../Get-AzureRmVpnClientPackage.md | 126 - .../Get-AzureRmVpnClientRevokedCertificate.md | 132 - .../Get-AzureRmVpnClientRootCertificate.md | 133 - .../Get-AzureRmVpnConnection.md | 187 -- .../AzureRM.Network/Get-AzureRmVpnGateway.md | 120 - .../AzureRM.Network/Get-AzureRmVpnSite.md | 126 - .../Move-AzureRmExpressRouteCircuit.md | 217 -- .../New-AzureRmApplicationGateway.md | 605 ----- ...icationGatewayAuthenticationCertificate.md | 132 - ...pplicationGatewayAutoscaleConfiguration.md | 114 - ...eRmApplicationGatewayBackendAddressPool.md | 163 -- ...RmApplicationGatewayBackendHttpSettings.md | 297 --- ...eRmApplicationGatewayConnectionDraining.md | 104 - ...ew-AzureRmApplicationGatewayCustomError.md | 98 - ...nGatewayFirewallDisabledRuleGroupConfig.md | 103 - ...plicationGatewayFirewallExclusionConfig.md | 111 - ...ureRmApplicationGatewayFrontendIPConfig.md | 211 -- ...w-AzureRmApplicationGatewayFrontendPort.md | 107 - ...w-AzureRmApplicationGatewayHttpListener.md | 247 -- ...zureRmApplicationGatewayIPConfiguration.md | 136 - ...AzureRmApplicationGatewayPathRuleConfig.md | 257 -- ...ew-AzureRmApplicationGatewayProbeConfig.md | 241 -- ...licationGatewayProbeHealthResponseMatch.md | 98 - ...ApplicationGatewayRedirectConfiguration.md | 190 -- ...eRmApplicationGatewayRequestRoutingRule.md | 267 -- .../New-AzureRmApplicationGatewaySku.md | 129 - ...AzureRmApplicationGatewaySslCertificate.md | 123 - .../New-AzureRmApplicationGatewaySslPolicy.md | 190 -- ...pplicationGatewayTrustedRootCertificate.md | 128 - ...ureRmApplicationGatewayUrlPathMapConfig.md | 211 -- ...ewayWebApplicationFirewallConfiguration.md | 257 -- .../New-AzureRmApplicationSecurityGroup.md | 206 -- .../New-AzureRmContainerNicConfig.md | 129 - .../New-AzureRmContainerNicConfigIpConfig.md | 150 -- .../New-AzureRmDdosProtectionPlan.md | 239 -- .../AzureRM.Network/New-AzureRmDelegation.md | 107 - .../New-AzureRmExpressRouteCircuit.md | 401 --- ...AzureRmExpressRouteCircuitAuthorization.md | 103 - ...AzureRmExpressRouteCircuitPeeringConfig.md | 348 --- .../New-AzureRmExpressRoutePort.md | 297 --- .../AzureRM.Network/New-AzureRmFirewall.md | 302 --- .../New-AzureRmFirewallApplicationRule.md | 219 -- ...zureRmFirewallApplicationRuleCollection.md | 204 -- .../New-AzureRmFirewallNatRule.md | 232 -- .../New-AzureRmFirewallNatRuleCollection.md | 186 -- .../New-AzureRmFirewallNetworkRule.md | 213 -- ...ew-AzureRmFirewallNetworkRuleCollection.md | 206 -- .../AzureRM.Network/New-AzureRmIpsecPolicy.md | 194 -- .../New-AzureRmLoadBalancer.md | 351 --- ...eRmLoadBalancerBackendAddressPoolConfig.md | 120 - ...New-AzureRmLoadBalancerFrontendIpConfig.md | 240 -- ...AzureRmLoadBalancerInboundNatPoolConfig.md | 242 -- ...AzureRmLoadBalancerInboundNatRuleConfig.md | 266 -- ...w-AzureRmLoadBalancerOutboundRuleConfig.md | 243 -- .../New-AzureRmLoadBalancerProbeConfig.md | 200 -- .../New-AzureRmLoadBalancerRuleConfig.md | 359 --- .../New-AzureRmLocalNetworkGateway.md | 271 -- .../New-AzureRmNetworkInterface.md | 589 ----- .../New-AzureRmNetworkInterfaceIpConfig.md | 376 --- .../New-AzureRmNetworkProfile.md | 209 -- .../New-AzureRmNetworkSecurityGroup.md | 235 -- .../New-AzureRmNetworkSecurityRuleConfig.md | 348 --- .../New-AzureRmNetworkWatcher.md | 224 -- ...-AzureRmNetworkWatcherConnectionMonitor.md | 423 --- .../New-AzureRmNetworkWatcherPacketCapture.md | 405 --- ...reRmNetworkWatcherProtocolConfiguration.md | 212 -- .../New-AzureRmPacketCaptureFilterConfig.md | 225 -- .../New-AzureRmPublicIpAddress.md | 387 --- .../New-AzureRmPublicIpPrefix.md | 274 -- .../AzureRM.Network/New-AzureRmPublicIpTag.md | 130 - .../AzureRM.Network/New-AzureRmRouteConfig.md | 192 -- .../AzureRM.Network/New-AzureRmRouteFilter.md | 218 -- .../New-AzureRmRouteFilterRuleConfig.md | 186 -- .../AzureRM.Network/New-AzureRmRouteTable.md | 260 -- .../New-AzureRmServiceEndpointPolicy.md | 162 -- ...-AzureRmServiceEndpointPolicyDefinition.md | 131 - .../AzureRM.Network/New-AzureRmVirtualHub.md | 323 --- .../New-AzureRmVirtualHubRoute.md | 103 - .../New-AzureRmVirtualHubRouteTable.md | 100 - .../New-AzureRmVirtualHubVnetConnection.md | 267 -- .../New-AzureRmVirtualNetwork.md | 338 --- .../New-AzureRmVirtualNetworkGateway.md | 533 ---- ...-AzureRmVirtualNetworkGatewayConnection.md | 405 --- ...ew-AzureRmVirtualNetworkGatewayIpConfig.md | 152 -- .../New-AzureRmVirtualNetworkSubnetConfig.md | 260 -- .../New-AzureRmVirtualNetworkTap.md | 293 --- .../AzureRM.Network/New-AzureRmVirtualWan.md | 215 -- .../New-AzureRmVpnClientConfiguration.md | 193 -- .../New-AzureRmVpnClientIpsecParameter.md | 195 -- .../New-AzureRmVpnClientIpsecPolicy.md | 214 -- .../New-AzureRmVpnClientRevokedCertificate.md | 117 - .../New-AzureRmVpnClientRootCertificate.md | 128 - .../New-AzureRmVpnConnection.md | 366 --- .../AzureRM.Network/New-AzureRmVpnGateway.md | 272 -- .../AzureRM.Network/New-AzureRmVpnSite.md | 399 --- .../Remove-AzureRmApplicationGateway.md | 165 -- ...icationGatewayAuthenticationCertificate.md | 134 - ...pplicationGatewayAutoscaleConfiguration.md | 131 - ...eRmApplicationGatewayBackendAddressPool.md | 141 - ...RmApplicationGatewayBackendHttpSettings.md | 108 - ...eRmApplicationGatewayConnectionDraining.md | 98 - ...ve-AzureRmApplicationGatewayCustomError.md | 96 - ...ureRmApplicationGatewayFrontendIPConfig.md | 110 - ...e-AzureRmApplicationGatewayFrontendPort.md | 110 - ...e-AzureRmApplicationGatewayHttpListener.md | 110 - ...plicationGatewayHttpListenerCustomError.md | 98 - ...zureRmApplicationGatewayIPConfiguration.md | 110 - ...ve-AzureRmApplicationGatewayProbeConfig.md | 108 - ...ApplicationGatewayRedirectConfiguration.md | 99 - ...eRmApplicationGatewayRequestRoutingRule.md | 110 - ...AzureRmApplicationGatewaySslCertificate.md | 110 - ...move-AzureRmApplicationGatewaySslPolicy.md | 138 - ...pplicationGatewayTrustedRootCertificate.md | 132 - ...ureRmApplicationGatewayUrlPathMapConfig.md | 101 - .../Remove-AzureRmApplicationSecurityGroup.md | 176 -- .../Remove-AzureRmDdosProtectionPlan.md | 204 -- .../Remove-AzureRmDelegation.md | 126 - .../Remove-AzureRmExpressRouteCircuit.md | 185 -- ...AzureRmExpressRouteCircuitAuthorization.md | 123 - ...reRmExpressRouteCircuitConnectionConfig.md | 149 -- ...AzureRmExpressRouteCircuitPeeringConfig.md | 123 - .../Remove-AzureRmExpressRoutePort.md | 230 -- .../AzureRM.Network/Remove-AzureRmFirewall.md | 198 -- .../Remove-AzureRmLoadBalancer.md | 184 -- ...eRmLoadBalancerBackendAddressPoolConfig.md | 140 - ...ove-AzureRmLoadBalancerFrontendIpConfig.md | 142 -- ...AzureRmLoadBalancerInboundNatPoolConfig.md | 121 - ...AzureRmLoadBalancerInboundNatRuleConfig.md | 141 - ...e-AzureRmLoadBalancerOutboundRuleConfig.md | 131 - .../Remove-AzureRmLoadBalancerProbeConfig.md | 142 -- .../Remove-AzureRmLoadBalancerRuleConfig.md | 142 -- .../Remove-AzureRmLocalNetworkGateway.md | 184 -- .../Remove-AzureRmNetworkInterface.md | 191 -- .../Remove-AzureRmNetworkInterfaceIpConfig.md | 113 - ...Remove-AzureRmNetworkInterfaceTapConfig.md | 226 -- .../Remove-AzureRmNetworkProfile.md | 221 -- .../Remove-AzureRmNetworkSecurityGroup.md | 182 -- ...Remove-AzureRmNetworkSecurityRuleConfig.md | 115 - .../Remove-AzureRmNetworkWatcher.md | 262 -- ...-AzureRmNetworkWatcherConnectionMonitor.md | 319 --- ...move-AzureRmNetworkWatcherPacketCapture.md | 277 -- .../Remove-AzureRmPublicIpAddress.md | 182 -- .../Remove-AzureRmPublicIpPrefix.md | 219 -- .../Remove-AzureRmRouteConfig.md | 161 -- .../Remove-AzureRmRouteFilter.md | 157 -- .../Remove-AzureRmRouteFilterRuleConfig.md | 142 -- .../Remove-AzureRmRouteTable.md | 186 -- .../Remove-AzureRmServiceEndpointPolicy.md | 166 -- ...-AzureRmServiceEndpointPolicyDefinition.md | 99 - .../Remove-AzureRmVirtualHub.md | 250 -- .../Remove-AzureRmVirtualHubVnetConnection.md | 261 -- .../Remove-AzureRmVirtualNetwork.md | 191 -- .../Remove-AzureRmVirtualNetworkGateway.md | 176 -- ...-AzureRmVirtualNetworkGatewayConnection.md | 168 -- ...AzureRmVirtualNetworkGatewayDefaultSite.md | 97 - ...ve-AzureRmVirtualNetworkGatewayIpConfig.md | 166 -- .../Remove-AzureRmVirtualNetworkPeering.md | 190 -- ...emove-AzureRmVirtualNetworkSubnetConfig.md | 124 - .../Remove-AzureRmVirtualNetworkTap.md | 217 -- .../Remove-AzureRmVirtualWan.md | 229 -- .../Remove-AzureRmVpnClientIpsecParameter.md | 175 -- ...move-AzureRmVpnClientRevokedCertificate.md | 143 -- .../Remove-AzureRmVpnClientRootCertificate.md | 156 -- .../Remove-AzureRmVpnConnection.md | 257 -- .../Remove-AzureRmVpnGateway.md | 225 -- .../AzureRM.Network/Remove-AzureRmVpnSite.md | 226 -- .../Reset-AzureRmVirtualNetworkGateway.md | 125 - ...irtualNetworkGatewayConnectionSharedKey.md | 162 -- .../Resize-AzureRmVirtualNetworkGateway.md | 132 - .../Set-AzureRmApplicationGateway.md | 102 - ...icationGatewayAuthenticationCertificate.md | 149 -- ...pplicationGatewayAutoscaleConfiguration.md | 131 - ...eRmApplicationGatewayBackendAddressPool.md | 182 -- ...RmApplicationGatewayBackendHttpSettings.md | 316 --- ...eRmApplicationGatewayConnectionDraining.md | 128 - ...et-AzureRmApplicationGatewayCustomError.md | 112 - ...ureRmApplicationGatewayFrontendIPConfig.md | 236 -- ...t-AzureRmApplicationGatewayFrontendPort.md | 126 - ...t-AzureRmApplicationGatewayHttpListener.md | 263 -- ...plicationGatewayHttpListenerCustomError.md | 114 - ...zureRmApplicationGatewayIPConfiguration.md | 156 -- ...et-AzureRmApplicationGatewayProbeConfig.md | 257 -- ...ApplicationGatewayRedirectConfiguration.md | 208 -- ...eRmApplicationGatewayRequestRoutingRule.md | 285 --- .../Set-AzureRmApplicationGatewaySku.md | 147 -- ...AzureRmApplicationGatewaySslCertificate.md | 141 - .../Set-AzureRmApplicationGatewaySslPolicy.md | 208 -- ...pplicationGatewayTrustedRootCertificate.md | 147 -- ...ureRmApplicationGatewayUrlPathMapConfig.md | 220 -- ...ewayWebApplicationFirewallConfiguration.md | 274 -- .../Set-AzureRmExpressRouteCircuit.md | 106 - ...AzureRmExpressRouteCircuitPeeringConfig.md | 357 --- .../Set-AzureRmExpressRoutePort.md | 136 - .../AzureRM.Network/Set-AzureRmFirewall.md | 156 -- .../Set-AzureRmLoadBalancer.md | 141 - ...Set-AzureRmLoadBalancerFrontendIpConfig.md | 265 -- ...AzureRmLoadBalancerInboundNatPoolConfig.md | 267 -- ...AzureRmLoadBalancerInboundNatRuleConfig.md | 278 -- ...t-AzureRmLoadBalancerOutboundRuleConfig.md | 256 -- .../Set-AzureRmLoadBalancerProbeConfig.md | 223 -- .../Set-AzureRmLoadBalancerRuleConfig.md | 371 --- .../Set-AzureRmLocalNetworkGateway.md | 183 -- .../Set-AzureRmNetworkInterface.md | 158 -- .../Set-AzureRmNetworkInterfaceIpConfig.md | 402 --- .../Set-AzureRmNetworkInterfaceTapConfig.md | 142 -- .../Set-AzureRmNetworkProfile.md | 133 - .../Set-AzureRmNetworkSecurityGroup.md | 137 - .../Set-AzureRmNetworkSecurityRuleConfig.md | 360 --- .../Set-AzureRmNetworkWatcherConfigFlowLog.md | 509 ---- ...-AzureRmNetworkWatcherConnectionMonitor.md | 462 ---- .../Set-AzureRmPublicIpAddress.md | 134 - .../Set-AzureRmPublicIpPrefix.md | 134 - .../AzureRM.Network/Set-AzureRmRouteConfig.md | 232 -- .../AzureRM.Network/Set-AzureRmRouteFilter.md | 142 -- .../Set-AzureRmRouteFilterRuleConfig.md | 192 -- .../AzureRM.Network/Set-AzureRmRouteTable.md | 180 -- .../Set-AzureRmServiceEndpointPolicy.md | 84 - ...-AzureRmServiceEndpointPolicyDefinition.md | 145 -- .../Set-AzureRmVirtualNetwork.md | 117 - .../Set-AzureRmVirtualNetworkGateway.md | 411 --- ...-AzureRmVirtualNetworkGatewayConnection.md | 230 -- ...irtualNetworkGatewayConnectionSharedKey.md | 167 -- ...AzureRmVirtualNetworkGatewayDefaultSite.md | 121 - ...eRmVirtualNetworkGatewayVpnClientConfig.md | 198 -- .../Set-AzureRmVirtualNetworkPeering.md | 151 -- .../Set-AzureRmVirtualNetworkSubnetConfig.md | 295 --- .../Set-AzureRmVirtualNetworkTap.md | 130 - .../Set-AzureRmVpnClientIpsecParameter.md | 199 -- .../Start-AzureRmApplicationGateway.md | 87 - ...-AzureRmNetworkWatcherConnectionMonitor.md | 319 --- ...RmNetworkWatcherResourceTroubleshooting.md | 252 -- .../Stop-AzureRmApplicationGateway.md | 110 - ...-AzureRmNetworkWatcherConnectionMonitor.md | 319 --- ...Stop-AzureRmNetworkWatcherPacketCapture.md | 275 -- .../Test-AzureRmDnsAvailability.md | 91 - .../Test-AzureRmNetworkWatcherConnectivity.md | 316 --- .../Test-AzureRmNetworkWatcherIPFlow.md | 347 --- ...est-AzureRmPrivateIPAddressAvailability.md | 140 - .../Update-AzureRmVirtualHub.md | 294 --- .../Update-AzureRmVirtualWan.md | 263 -- .../Update-AzureRmVpnConnection.md | 335 --- .../Update-AzureRmVpnGateway.md | 255 -- .../AzureRM.Network/Update-AzureRmVpnSite.md | 496 ---- .../AzureRM.NotificationHubs.md | 78 - .../Get-AzureRmNotificationHub.md | 135 - ...zureRmNotificationHubAuthorizationRules.md | 158 -- .../Get-AzureRmNotificationHubListKeys.md | 142 -- ...et-AzureRmNotificationHubPNSCredentials.md | 121 - .../Get-AzureRmNotificationHubsNamespace.md | 130 - ...ficationHubsNamespaceAuthorizationRules.md | 145 -- ...zureRmNotificationHubsNamespaceListKeys.md | 123 - .../New-AzureRmNotificationHub.md | 188 -- ...zureRmNotificationHubAuthorizationRules.md | 199 -- .../New-AzureRmNotificationHubKey.md | 180 -- .../New-AzureRmNotificationHubsNamespace.md | 209 -- ...ficationHubsNamespaceAuthorizationRules.md | 199 -- ...New-AzureRmNotificationHubsNamespaceKey.md | 167 -- .../Remove-AzureRmNotificationHub.md | 174 -- ...zureRmNotificationHubAuthorizationRules.md | 193 -- ...Remove-AzureRmNotificationHubsNamespace.md | 156 -- ...ficationHubsNamespaceAuthorizationRules.md | 178 -- .../Set-AzureRmNotificationHub.md | 203 -- ...zureRmNotificationHubAuthorizationRules.md | 231 -- .../Set-AzureRmNotificationHubsNamespace.md | 265 -- ...ficationHubsNamespaceAuthorizationRules.md | 210 -- .../AzureRM.OperationalInsights.md | 135 - ...reRmOperationalInsightsIISLogCollection.md | 151 -- ...ationalInsightsLinuxCustomLogCollection.md | 151 -- ...ionalInsightsLinuxPerformanceCollection.md | 153 -- ...perationalInsightsLinuxSyslogCollection.md | 153 -- ...reRmOperationalInsightsIISLogCollection.md | 150 -- ...ationalInsightsLinuxCustomLogCollection.md | 151 -- ...ionalInsightsLinuxPerformanceCollection.md | 151 -- ...perationalInsightsLinuxSyslogCollection.md | 153 -- ...et-AzureRmOperationalInsightsDataSource.md | 240 -- ...eRmOperationalInsightsIntelligencePacks.md | 101 - ...t-AzureRmOperationalInsightsLinkTargets.md | 71 - ...t-AzureRmOperationalInsightsSavedSearch.md | 126 - ...RmOperationalInsightsSavedSearchResults.md | 116 - .../Get-AzureRmOperationalInsightsSchema.md | 101 - ...AzureRmOperationalInsightsSearchResults.md | 252 -- ...zureRmOperationalInsightsStorageInsight.md | 152 -- ...Get-AzureRmOperationalInsightsWorkspace.md | 104 - ...tionalInsightsWorkspaceManagementGroups.md | 110 - ...mOperationalInsightsWorkspaceSharedKeys.md | 112 - ...zureRmOperationalInsightsWorkspaceUsage.md | 112 - .../Invoke-AzureRmOperationalInsightsQuery.md | 230 -- ...ionalInsightsAzureActivityLogDataSource.md | 202 -- ...AzureRmOperationalInsightsComputerGroup.md | 215 -- ...mOperationalInsightsCustomLogDataSource.md | 199 -- ...nsightsLinuxPerformanceObjectDataSource.md | 249 -- ...perationalInsightsLinuxSyslogDataSource.md | 322 --- ...w-AzureRmOperationalInsightsSavedSearch.md | 243 -- ...zureRmOperationalInsightsStorageInsight.md | 280 -- ...erationalInsightsWindowsEventDataSource.md | 238 -- ...ghtsWindowsPerformanceCounterDataSource.md | 257 -- ...New-AzureRmOperationalInsightsWorkspace.md | 249 -- ...ve-AzureRmOperationalInsightsDataSource.md | 183 -- ...e-AzureRmOperationalInsightsSavedSearch.md | 147 -- ...zureRmOperationalInsightsStorageInsight.md | 199 -- ...ove-AzureRmOperationalInsightsWorkspace.md | 158 -- ...et-AzureRmOperationalInsightsDataSource.md | 83 - ...reRmOperationalInsightsIntelligencePack.md | 132 - ...t-AzureRmOperationalInsightsSavedSearch.md | 209 -- ...zureRmOperationalInsightsStorageInsight.md | 202 -- ...Set-AzureRmOperationalInsightsWorkspace.md | 190 -- .../AzureRM.PolicyInsights.md | 36 - .../Get-AzureRmPolicyEvent.md | 480 ---- .../Get-AzureRmPolicyRemediation.md | 269 -- .../Get-AzureRmPolicyState.md | 505 ---- .../Get-AzureRmPolicyStateSummary.md | 390 --- .../Remove-AzureRmPolicyRemediation.md | 265 -- .../Start-AzureRmPolicyRemediation.md | 279 -- .../Stop-AzureRmPolicyRemediation.md | 243 -- .../AzureRM.PowerBIEmbedded.md | 56 - .../Get-AzureRmPowerBIEmbeddedCapacity.md | 161 -- .../Get-AzureRmPowerBIWorkspace.md | 101 - .../Get-AzureRmPowerBIWorkspaceCollection.md | 129 - ...eRmPowerBIWorkspaceCollectionAccessKeys.md | 101 - .../New-AzureRmPowerBIEmbeddedCapacity.md | 207 -- .../New-AzureRmPowerBIWorkspaceCollection.md | 149 -- .../Remove-AzureRmPowerBIEmbeddedCapacity.md | 202 -- ...emove-AzureRmPowerBIWorkspaceCollection.md | 134 - ...eRmPowerBIWorkspaceCollectionAccessKeys.md | 163 -- .../Resume-AzureRmPowerBIEmbeddedCapacity.md | 202 -- .../Suspend-AzureRmPowerBIEmbeddedCapacity.md | 203 -- .../Test-AzureRmPowerBIEmbeddedCapacity.md | 87 - .../Update-AzureRmPowerBIEmbeddedCapacity.md | 251 -- .../AzureRM.Profile/Add-AzureRmEnvironment.md | 560 ---- .../AzureRM.Profile/AzureRM.Profile.md | 97 - .../AzureRM.Profile/Clear-AzureRmContext.md | 143 -- .../AzureRM.Profile/Clear-AzureRmDefault.md | 166 -- .../AzureRM.Profile/Connect-AzureRmAccount.md | 569 ----- .../Disable-AzureRmContextAutosave.md | 113 - .../Disable-AzureRmDataCollection.md | 106 - .../Disconnect-AzureRmAccount.md | 247 -- .../Enable-AzureRmContextAutosave.md | 113 - .../Enable-AzureRmDataCollection.md | 107 - .../AzureRM.Profile/Get-AzureRmContext.md | 125 - .../Get-AzureRmContextAutosaveSetting.md | 107 - .../AzureRM.Profile/Get-AzureRmDefault.md | 102 - .../AzureRM.Profile/Get-AzureRmEnvironment.md | 129 - .../Get-AzureRmSubscription.md | 181 -- .../AzureRM.Profile/Get-AzureRmTenant.md | 98 - .../AzureRM.Profile/Import-AzureRmContext.md | 167 -- .../AzureRM.Profile/Remove-AzureRmContext.md | 182 -- .../Remove-AzureRmEnvironment.md | 149 -- .../AzureRM.Profile/Rename-AzureRmContext.md | 207 -- .../AzureRM.Profile/Resolve-AzureRmError.md | 238 -- .../AzureRM.Profile/Save-AzureRmContext.md | 152 -- .../AzureRM.Profile/Select-AzureRmContext.md | 157 -- .../AzureRM.Profile/Send-Feedback.md | 79 - .../AzureRM.Profile/Set-AzureRmContext.md | 294 --- .../AzureRM.Profile/Set-AzureRmDefault.md | 150 -- .../AzureRM.Profile/Set-AzureRmEnvironment.md | 553 ---- .../AzureRM.RecoveryServices.Backup.md | 84 - ...ackup-AzureRmRecoveryServicesBackupItem.md | 165 -- ...AzureRmRecoveryServicesBackupProtection.md | 179 -- ...reRmRecoveryServicesBackupRPMountScript.md | 162 -- ...AzureRmRecoveryServicesBackupProtection.md | 243 -- ...-AzureRmRecoveryServicesBackupContainer.md | 211 -- .../Get-AzureRmRecoveryServicesBackupItem.md | 251 -- .../Get-AzureRmRecoveryServicesBackupJob.md | 260 -- ...AzureRmRecoveryServicesBackupJobDetails.md | 131 - ...mRecoveryServicesBackupManagementServer.md | 105 - ...mRecoveryServicesBackupProtectionPolicy.md | 173 -- ...reRmRecoveryServicesBackupRPMountScript.md | 158 -- ...reRmRecoveryServicesBackupRecoveryPoint.md | 192 -- ...veryServicesBackupRetentionPolicyObject.md | 122 - ...overyServicesBackupSchedulePolicyObject.md | 138 - ...Get-AzureRmRecoveryServicesBackupStatus.md | 138 - ...mRecoveryServicesBackupProtectionPolicy.md | 240 -- ...mRecoveryServicesBackupProtectionPolicy.md | 199 -- ...store-AzureRmRecoveryServicesBackupItem.md | 338 --- ...mRecoveryServicesBackupProtectionPolicy.md | 192 -- .../Stop-AzureRmRecoveryServicesBackupJob.md | 164 -- ...-AzureRmRecoveryServicesBackupContainer.md | 153 -- ...mRecoveryServicesBackupManagementServer.md | 154 -- .../Wait-AzureRmRecoveryServicesBackupJob.md | 139 - .../AzureRM.RecoveryServices.SiteRecovery.md | 201 -- ...-AzureRmRecoveryServicesAsrRecoveryPlan.md | 212 -- ...-AzureRmRecoveryServicesAsrAlertSetting.md | 69 - .../Get-AzureRmRecoveryServicesAsrEvent.md | 258 -- .../Get-AzureRmRecoveryServicesAsrFabric.md | 140 - .../Get-AzureRmRecoveryServicesAsrJob.md | 191 -- .../Get-AzureRmRecoveryServicesAsrNetwork.md | 125 - ...zureRmRecoveryServicesAsrNetworkMapping.md | 131 - .../Get-AzureRmRecoveryServicesAsrPolicy.md | 141 - ...ureRmRecoveryServicesAsrProtectableItem.md | 173 -- ...mRecoveryServicesAsrProtectionContainer.md | 159 -- ...ryServicesAsrProtectionContainerMapping.md | 129 - ...-AzureRmRecoveryServicesAsrRecoveryPlan.md | 130 - ...AzureRmRecoveryServicesAsrRecoveryPoint.md | 115 - ...veryServicesAsrReplicationProtectedItem.md | 153 -- ...reRmRecoveryServicesAsrServicesProvider.md | 129 - ...ecoveryServicesAsrStorageClassification.md | 125 - ...ServicesAsrStorageClassificationMapping.md | 109 - .../Get-AzureRmRecoveryServicesAsrVCenter.md | 142 -- ...-AzureRmRecoveryServicesAsrVaultContext.md | 65 - ...eRmRecoveryServicesAsrVaultSettingsFile.md | 114 - ...cesAsrAzureToAzureDiskReplicationConfig.md | 229 -- .../New-AzureRmRecoveryServicesAsrFabric.md | 177 -- ...zureRmRecoveryServicesAsrNetworkMapping.md | 245 -- .../New-AzureRmRecoveryServicesAsrPolicy.md | 529 ---- ...ureRmRecoveryServicesAsrProtectableItem.md | 158 -- ...mRecoveryServicesAsrProtectionContainer.md | 127 - ...ryServicesAsrProtectionContainerMapping.md | 211 -- ...-AzureRmRecoveryServicesAsrRecoveryPlan.md | 228 -- ...veryServicesAsrReplicationProtectedItem.md | 585 ----- ...ServicesAsrStorageClassificationMapping.md | 148 -- .../New-AzureRmRecoveryServicesAsrVCenter.md | 175 -- ...Remove-AzureRmRecoveryServicesAsrFabric.md | 131 - ...zureRmRecoveryServicesAsrNetworkMapping.md | 116 - ...Remove-AzureRmRecoveryServicesAsrPolicy.md | 116 - ...mRecoveryServicesAsrProtectionContainer.md | 113 - ...ryServicesAsrProtectionContainerMapping.md | 131 - ...-AzureRmRecoveryServicesAsrRecoveryPlan.md | 142 -- ...veryServicesAsrReplicationProtectedItem.md | 150 -- ...reRmRecoveryServicesAsrServicesProvider.md | 131 - ...ServicesAsrStorageClassificationMapping.md | 116 - ...emove-AzureRmRecoveryServicesAsrVCenter.md | 170 -- .../Restart-AzureRmRecoveryServicesAsrJob.md | 141 - .../Resume-AzureRmRecoveryServicesAsrJob.md | 155 -- ...-AzureRmRecoveryServicesAsrAlertSetting.md | 205 -- ...veryServicesAsrReplicationProtectedItem.md | 339 --- ...-AzureRmRecoveryServicesAsrVaultContext.md | 134 - ...RmRecoveryServicesAsrApplyRecoveryPoint.md | 161 -- ...eRmRecoveryServicesAsrCommitFailoverJob.md | 135 - ...RmRecoveryServicesAsrPlannedFailoverJob.md | 255 -- ...yServicesAsrResynchronizeReplicationJob.md | 135 - ...coveryServicesAsrSwitchProcessServerJob.md | 166 -- ...coveryServicesAsrTestFailoverCleanupJob.md | 178 -- ...ureRmRecoveryServicesAsrTestFailoverJob.md | 301 --- ...RecoveryServicesAsrUnplannedFailoverJob.md | 259 -- .../Stop-AzureRmRecoveryServicesAsrJob.md | 140 - ...ureRmRecoveryServicesAsrMobilityService.md | 127 - ...zureRmRecoveryServicesAsrNetworkMapping.md | 150 -- ...Update-AzureRmRecoveryServicesAsrPolicy.md | 472 ---- ...mRecoveryServicesAsrProtectionDirection.md | 525 ---- ...-AzureRmRecoveryServicesAsrRecoveryPlan.md | 140 - ...reRmRecoveryServicesAsrServicesProvider.md | 116 - ...pdate-AzureRmRecoveryServicesAsrVCenter.md | 165 -- .../AzureRM.RecoveryServices.md | 36 - ...t-AzureRmRecoveryServicesBackupProperty.md | 83 - .../Get-AzureRmRecoveryServicesVault.md | 119 - ...zureRmRecoveryServicesVaultSettingsFile.md | 201 -- .../New-AzureRmRecoveryServicesVault.md | 150 -- .../Remove-AzureRmRecoveryServicesVault.md | 121 - ...AzureRmRecoveryServicesBackupProperties.md | 138 - ...Set-AzureRmRecoveryServicesVaultContext.md | 84 - .../AzureRM.RedisCache/AzureRM.RedisCache.md | 78 - .../Export-AzureRmRedisCache.md | 206 -- .../Get-AzureRmRedisCache.md | 224 -- .../Get-AzureRmRedisCacheFirewallRule.md | 154 -- .../Get-AzureRmRedisCacheKey.md | 103 - .../Get-AzureRmRedisCacheLink.md | 178 -- .../Get-AzureRmRedisCachePatchSchedule.md | 106 - .../Import-AzureRmRedisCache.md | 208 -- .../New-AzureRmRedisCache.md | 448 ---- .../New-AzureRmRedisCacheFirewallRule.md | 239 -- .../New-AzureRmRedisCacheKey.md | 178 -- .../New-AzureRmRedisCacheLink.md | 143 -- .../New-AzureRmRedisCachePatchSchedule.md | 155 -- .../New-AzureRmRedisCacheScheduleEntry.md | 137 - .../Remove-AzureRmRedisCache.md | 176 -- .../Remove-AzureRmRedisCacheDiagnostics.md | 134 - .../Remove-AzureRmRedisCacheFirewallRule.md | 195 -- .../Remove-AzureRmRedisCacheLink.md | 154 -- .../Remove-AzureRmRedisCachePatchSchedule.md | 152 -- .../Reset-AzureRmRedisCache.md | 209 -- .../Set-AzureRmRedisCache.md | 334 --- .../Set-AzureRmRedisCacheDiagnostics.md | 148 -- .../AzureRM.Relay/AzureRM.Relay.md | 75 - .../Get-AzureRmRelayAuthorizationRule.md | 202 -- .../Get-AzureRmRelayHybridConnection.md | 124 - .../AzureRM.Relay/Get-AzureRmRelayKey.md | 197 -- .../Get-AzureRmRelayNamespace.md | 110 - .../Get-AzureRmRelayOperation.md | 91 - .../AzureRM.Relay/Get-AzureRmWcfRelay.md | 127 - .../New-AzureRmRelayAuthorizationRule.md | 249 -- .../New-AzureRmRelayHybridConnection.md | 234 -- .../AzureRM.Relay/New-AzureRmRelayKey.md | 311 --- .../New-AzureRmRelayNamespace.md | 173 -- .../AzureRM.Relay/New-AzureRmWcfRelay.md | 271 -- .../Remove-AzureRmRelayAuthorizationRule.md | 246 -- .../Remove-AzureRmRelayHybridConnection.md | 145 -- .../Remove-AzureRmRelayNamespace.md | 130 - .../AzureRM.Relay/Remove-AzureRmWcfRelay.md | 145 -- .../Set-AzureRmRelayAuthorizationRule.md | 346 --- .../Set-AzureRmRelayHybridConnection.md | 216 -- .../Set-AzureRmRelayNamespace.md | 174 -- .../AzureRM.Relay/Set-AzureRmWcfRelay.md | 222 -- .../AzureRM.Relay/Test-AzureRmRelayName.md | 105 - .../AzureRM.Reservations.md | 39 - .../Get-AzureRmReservation.md | 154 -- .../Get-AzureRmReservationCatalog.md | 118 - .../Get-AzureRmReservationHistory.md | 121 - .../Get-AzureRmReservationOrder.md | 90 - .../Get-AzureRmReservationOrderId.md | 88 - .../Merge-AzureRmReservation.md | 148 -- .../Split-AzureRmReservation.md | 164 -- .../Update-AzureRmReservation.md | 218 -- .../AzureRm.ResourceGraph.md | 18 - .../Search-AzureRmGraph.md | 154 -- .../Add-AzureRmADGroupMember.md | 228 -- .../AzureRM.Resources/AzureRM.Resources.md | 305 --- .../Export-AzureRmResourceGroup.md | 246 -- .../Get-AzureRmADAppCredential.md | 167 -- .../Get-AzureRmADApplication.md | 258 -- .../AzureRM.Resources/Get-AzureRmADGroup.md | 221 -- .../Get-AzureRmADGroupMember.md | 195 -- .../Get-AzureRmADServicePrincipal.md | 287 --- .../Get-AzureRmADSpCredential.md | 174 -- .../AzureRM.Resources/Get-AzureRmADUser.md | 263 -- .../Get-AzureRmDeployment.md | 146 -- .../Get-AzureRmDeploymentOperation.md | 163 -- .../AzureRM.Resources/Get-AzureRmLocation.md | 94 - .../Get-AzureRmManagedApplication.md | 164 -- ...Get-AzureRmManagedApplicationDefinition.md | 158 -- .../Get-AzureRmManagementGroup.md | 238 -- .../Get-AzureRmPolicyAlias.md | 387 --- .../Get-AzureRmPolicyAssignment.md | 255 -- .../Get-AzureRmPolicyDefinition.md | 311 --- .../Get-AzureRmPolicySetDefinition.md | 267 -- .../Get-AzureRmProviderFeature.md | 138 - .../Get-AzureRmProviderOperation.md | 96 - .../AzureRM.Resources/Get-AzureRmResource.md | 356 --- .../Get-AzureRmResourceGroup.md | 203 -- .../Get-AzureRmResourceGroupDeployment.md | 195 -- ...AzureRmResourceGroupDeploymentOperation.md | 182 -- .../Get-AzureRmResourceLock.md | 308 --- .../Get-AzureRmResourceProvider.md | 145 -- .../Get-AzureRmRoleAssignment.md | 446 ---- .../Get-AzureRmRoleDefinition.md | 165 -- .../Invoke-AzureRmResourceAction.md | 353 --- .../AzureRM.Resources/Move-AzureRmResource.md | 239 -- .../New-AzureRmADAppCredential.md | 326 --- .../New-AzureRmADApplication.md | 334 --- .../AzureRM.Resources/New-AzureRmADGroup.md | 128 - .../New-AzureRmADServicePrincipal.md | 600 ----- .../New-AzureRmADSpCredential.md | 319 --- .../AzureRM.Resources/New-AzureRmADUser.md | 205 -- .../New-AzureRmDeployment.md | 337 --- .../New-AzureRmManagedApplication.md | 270 -- ...New-AzureRmManagedApplicationDefinition.md | 304 --- .../New-AzureRmManagementGroup.md | 233 -- .../New-AzureRmManagementGroupSubscription.md | 140 - .../New-AzureRmPolicyAssignment.md | 483 ---- .../New-AzureRmPolicyDefinition.md | 350 --- .../New-AzureRmPolicySetDefinition.md | 313 --- .../AzureRM.Resources/New-AzureRmResource.md | 443 ---- .../New-AzureRmResourceGroup.md | 240 -- .../New-AzureRmResourceGroupDeployment.md | 432 ---- .../New-AzureRmResourceLock.md | 378 --- .../New-AzureRmRoleAssignment.md | 384 --- .../New-AzureRmRoleDefinition.md | 187 -- .../Register-AzureRmProviderFeature.md | 128 - .../Register-AzureRmResourceProvider.md | 146 -- .../Remove-AzureRmADAppCredential.md | 265 -- .../Remove-AzureRmADApplication.md | 237 -- .../Remove-AzureRmADGroup.md | 197 -- .../Remove-AzureRmADGroupMember.md | 234 -- .../Remove-AzureRmADServicePrincipal.md | 300 --- .../Remove-AzureRmADSpCredential.md | 254 -- .../AzureRM.Resources/Remove-AzureRmADUser.md | 256 -- .../Remove-AzureRmDeployment.md | 224 -- .../Remove-AzureRmManagedApplication.md | 200 -- ...ove-AzureRmManagedApplicationDefinition.md | 201 -- .../Remove-AzureRmManagementGroup.md | 153 -- ...move-AzureRmManagementGroupSubscription.md | 140 - .../Remove-AzureRmPolicyAssignment.md | 240 -- .../Remove-AzureRmPolicyDefinition.md | 290 --- .../Remove-AzureRmPolicySetDefinition.md | 242 -- .../Remove-AzureRmResource.md | 321 --- .../Remove-AzureRmResourceGroup.md | 219 -- .../Remove-AzureRmResourceGroupDeployment.md | 182 -- .../Remove-AzureRmResourceLock.md | 339 --- .../Remove-AzureRmRoleAssignment.md | 402 --- .../Remove-AzureRmRoleDefinition.md | 218 -- .../Save-AzureRmDeploymentTemplate.md | 203 -- ...-AzureRmResourceGroupDeploymentTemplate.md | 224 -- .../Set-AzureRmManagedApplication.md | 278 -- ...Set-AzureRmManagedApplicationDefinition.md | 263 -- .../Set-AzureRmPolicyAssignment.md | 315 --- .../Set-AzureRmPolicyDefinition.md | 328 --- .../Set-AzureRmPolicySetDefinition.md | 294 --- .../AzureRM.Resources/Set-AzureRmResource.md | 472 ---- .../Set-AzureRmResourceGroup.md | 201 -- .../Set-AzureRmResourceLock.md | 378 --- .../Set-AzureRmRoleDefinition.md | 156 -- .../Stop-AzureRmDeployment.md | 214 -- .../Stop-AzureRmResourceGroupDeployment.md | 220 -- .../Test-AzureRmDeployment.md | 232 -- .../Test-AzureRmResourceGroupDeployment.md | 296 --- .../Unregister-AzureRmResourceProvider.md | 139 - .../Update-AzureRmADApplication.md | 320 --- .../Update-AzureRmADServicePrincipal.md | 284 --- .../AzureRM.Resources/Update-AzureRmADUser.md | 304 --- .../Update-AzureRmManagementGroup.md | 252 -- .../AzureRM.Scheduler/AzureRM.Scheduler.md | 66 - .../Disable-AzureRmSchedulerJobCollection.md | 149 -- .../Enable-AzureRmSchedulerJobCollection.md | 149 -- .../Get-AzureRmSchedulerJob.md | 148 -- .../Get-AzureRmSchedulerJobCollection.md | 102 - .../Get-AzureRmSchedulerJobHistory.md | 130 - .../New-AzureRmSchedulerHttpJob.md | 377 --- .../New-AzureRmSchedulerJobCollection.md | 223 -- .../New-AzureRmSchedulerServiceBusQueueJob.md | 383 --- .../New-AzureRmSchedulerServiceBusTopicJob.md | 383 --- .../New-AzureRmSchedulerStorageQueueJob.md | 348 --- .../Remove-AzureRmSchedulerJob.md | 156 -- .../Remove-AzureRmSchedulerJobCollection.md | 149 -- .../Set-AzureRmSchedulerHttpJob.md | 377 --- .../Set-AzureRmSchedulerJobCollection.md | 223 -- .../Set-AzureRmSchedulerServiceBusQueueJob.md | 383 --- .../Set-AzureRmSchedulerServiceBusTopicJob.md | 383 --- .../Set-AzureRmSchedulerStorageQueueJob.md | 348 --- .../AzureRM.Search/AzureRM.Search.md | 42 - .../Get-AzureRmSearchAdminKeyPair.md | 148 -- .../Get-AzureRmSearchQueryKey.md | 150 -- .../Get-AzureRmSearchService.md | 133 - .../New-AzureRmSearchAdminKey.md | 214 -- .../New-AzureRmSearchQueryKey.md | 195 -- .../New-AzureRmSearchService.md | 221 -- .../Remove-AzureRmSearchQueryKey.md | 234 -- .../Remove-AzureRmSearchService.md | 215 -- .../Set-AzureRmSearchService.md | 219 -- .../AzureRM.Security/AzureRM.Security.md | 78 - .../Get-AzureRmDiscoveredSecuritySolution.md | 159 -- .../Get-AzureRmExternalSecuritySolution.md | 201 -- .../Get-AzureRmJitNetworkAccessPolicy.md | 192 -- .../Get-AzureRmSecurityAlert.md | 446 ---- ...-AzureRmSecurityAutoProvisioningSetting.md | 112 - .../Get-AzureRmSecurityCompliance.md | 207 -- .../Get-AzureRmSecurityContact.md | 113 - .../Get-AzureRmSecurityLocation.md | 111 - .../Get-AzureRmSecurityPricing.md | 149 -- .../Get-AzureRmSecurityTask.md | 173 -- .../Get-AzureRmSecurityWorkspaceSetting.md | 112 - .../Remove-AzureRmJitNetworkAccessPolicy.md | 201 -- .../Remove-AzureRmSecurityContact.md | 170 -- .../Remove-AzureRmSecurityWorkspaceSetting.md | 171 -- .../Set-AzureRmJitNetworkAccessPolicy.md | 180 -- .../Set-AzureRmSecurityAlert.md | 233 -- ...-AzureRmSecurityAutoProvisioningSetting.md | 186 -- .../Set-AzureRmSecurityContact.md | 179 -- .../Set-AzureRmSecurityPricing.md | 184 -- .../Set-AzureRmSecurityWorkspaceSetting.md | 146 -- .../Start-AzureRmJitNetworkAccessPolicy.md | 212 -- .../AzureRM.ServiceBus/AzureRM.ServiceBus.md | 129 - .../Complete-AzureRmServiceBusMigration.md | 188 -- .../Get-AzureRmServiceBusAuthorizationRule.md | 196 -- ...Get-AzureRmServiceBusGeoDRConfiguration.md | 165 -- .../Get-AzureRmServiceBusKey.md | 196 -- .../Get-AzureRmServiceBusMigration.md | 150 -- .../Get-AzureRmServiceBusNamespace.md | 106 - .../Get-AzureRmServiceBusOperation.md | 65 - .../Get-AzureRmServiceBusQueue.md | 164 -- .../Get-AzureRmServiceBusRule.md | 171 -- .../Get-AzureRmServiceBusSubscription.md | 170 -- .../Get-AzureRmServiceBusTopic.md | 160 -- .../New-AzureRmServiceBusAuthorizationRule.md | 220 -- ...New-AzureRmServiceBusGeoDRConfiguration.md | 243 -- .../New-AzureRmServiceBusKey.md | 254 -- .../New-AzureRmServiceBusNamespace.md | 204 -- .../New-AzureRmServiceBusQueue.md | 428 ---- .../New-AzureRmServiceBusRule.md | 237 -- .../New-AzureRmServiceBusSubscription.md | 337 --- .../New-AzureRmServiceBusTopic.md | 325 --- ...move-AzureRmServiceBusAuthorizationRule.md | 251 -- ...ove-AzureRmServiceBusGeoDRConfiguration.md | 219 -- .../Remove-AzureRmServiceBusMigration.md | 203 -- .../Remove-AzureRmServiceBusNamespace.md | 226 -- .../Remove-AzureRmServiceBusQueue.md | 244 -- .../Remove-AzureRmServiceBusRule.md | 284 --- .../Remove-AzureRmServiceBusSubscription.md | 258 -- .../Remove-AzureRmServiceBusTopic.md | 240 -- .../Set-AzureRmServiceBusAuthorizationRule.md | 270 -- ...RmServiceBusGeoDRConfigurationBreakPair.md | 205 -- ...eRmServiceBusGeoDRConfigurationFailOver.md | 205 -- .../Set-AzureRmServiceBusNamespace.md | 205 -- .../Set-AzureRmServiceBusQueue.md | 189 -- .../Set-AzureRmServiceBusRule.md | 192 -- .../Set-AzureRmServiceBusSubscription.md | 180 -- .../Set-AzureRmServiceBusTopic.md | 185 -- .../Start-AzureRmServiceBusMigration.md | 180 -- .../Stop-AzureRmServiceBusMigration.md | 188 -- .../Test-AzureRmServiceBusName.md | 130 - ...reRmServiceFabricApplicationCertificate.md | 267 -- ...d-AzureRmServiceFabricClientCertificate.md | 272 -- ...-AzureRmServiceFabricClusterCertificate.md | 270 -- .../Add-AzureRmServiceFabricNode.md | 162 -- .../Add-AzureRmServiceFabricNodeType.md | 245 -- .../AzureRM.ServiceFabric.md | 63 - .../Get-AzureRmServiceFabricCluster.md | 108 - .../New-AzureRmServiceFabricCluster.md | 485 ---- ...e-AzureRmServiceFabricClientCertificate.md | 247 -- ...-AzureRmServiceFabricClusterCertificate.md | 143 -- .../Remove-AzureRmServiceFabricNode.md | 162 -- .../Remove-AzureRmServiceFabricNodeType.md | 142 -- .../Remove-AzureRmServiceFabricSetting.md | 183 -- .../Set-AzureRmServiceFabricSetting.md | 199 -- .../Set-AzureRmServiceFabricUpgradeType.md | 170 -- .../Update-AzureRmServiceFabricDurability.md | 177 -- .../Update-AzureRmServiceFabricReliability.md | 164 -- .../AzureRM.SignalR/AzureRM.SignalR.md | 30 - .../AzureRM.SignalR/Get-AzureRmSignalR.md | 162 -- .../AzureRM.SignalR/Get-AzureRmSignalRKey.md | 162 -- .../AzureRM.SignalR/New-AzureRmSignalR.md | 209 -- .../AzureRM.SignalR/New-AzureRmSignalRKey.md | 205 -- .../AzureRM.SignalR/Remove-AzureRmSignalR.md | 209 -- .../Add-AzureRmSqlDatabaseToFailoverGroup.md | 162 -- ...nceTransparentDataEncryptionCertificate.md | 175 -- .../Add-AzureRmSqlServerKeyVaultKey.md | 167 -- ...verTransparentDataEncryptionCertificate.md | 248 -- azurermps-6.13.0/AzureRM.Sql/AzureRM.Sql.md | 517 ---- ...baseVulnerabilityAssessmentRuleBaseline.md | 207 -- ...DatabaseVulnerabilityAssessmentSettings.md | 171 -- ...mSqlDatabaseVulnerabilityAssessmentScan.md | 223 -- ...zureRmSqlServerAdvancedThreatProtection.md | 161 -- ...zureRmSqlServerAdvancedThreatProtection.md | 161 -- .../Get-AzureRMSqlDatabaseGeoBackup.md | 161 -- .../Get-AzureRMSqlDeletedDatabaseBackup.md | 174 -- .../AzureRM.Sql/Get-AzureRmSqlCapability.md | 207 -- .../AzureRM.Sql/Get-AzureRmSqlDatabase.md | 218 -- .../Get-AzureRmSqlDatabaseActivity.md | 183 -- .../Get-AzureRmSqlDatabaseAdvisor.md | 294 --- .../Get-AzureRmSqlDatabaseAuditing.md | 151 -- .../Get-AzureRmSqlDatabaseAuditingPolicy.md | 178 -- ...qlDatabaseBackupLongTermRetentionPolicy.md | 199 -- ...Get-AzureRmSqlDatabaseDataMaskingPolicy.md | 163 -- .../Get-AzureRmSqlDatabaseDataMaskingRule.md | 244 -- .../Get-AzureRmSqlDatabaseExpanded.md | 146 -- .../Get-AzureRmSqlDatabaseFailoverGroup.md | 133 - .../Get-AzureRmSqlDatabaseGeoBackupPolicy.md | 110 - ...et-AzureRmSqlDatabaseImportExportStatus.md | 127 - ...-AzureRmSqlDatabaseIndexRecommendations.md | 193 -- ...ureRmSqlDatabaseLongTermRetentionBackup.md | 340 --- ...Get-AzureRmSqlDatabaseRecommendedAction.md | 276 -- .../Get-AzureRmSqlDatabaseReplicationLink.md | 177 -- .../Get-AzureRmSqlDatabaseRestorePoints.md | 155 -- ...zureRmSqlDatabaseSecureConnectionPolicy.md | 155 -- ...AzureRmSqlDatabaseThreatDetectionPolicy.md | 160 -- ...eRmSqlDatabaseTransparentDataEncryption.md | 155 -- ...tabaseTransparentDataEncryptionActivity.md | 158 -- .../Get-AzureRmSqlDatabaseUpgradeHint.md | 184 -- ...baseVulnerabilityAssessmentRuleBaseline.md | 190 -- ...tabaseVulnerabilityAssessmentScanRecord.md | 220 -- ...DatabaseVulnerabilityAssessmentSettings.md | 159 -- .../AzureRM.Sql/Get-AzureRmSqlElasticPool.md | 229 -- .../Get-AzureRmSqlElasticPoolActivity.md | 174 -- .../Get-AzureRmSqlElasticPoolAdvisor.md | 292 --- .../Get-AzureRmSqlElasticPoolDatabase.md | 171 -- ...Get-AzureRmSqlElasticPoolRecommendation.md | 137 - ...-AzureRmSqlElasticPoolRecommendedAction.md | 279 -- .../AzureRM.Sql/Get-AzureRmSqlInstance.md | 166 -- .../Get-AzureRmSqlInstanceDatabase.md | 217 -- .../AzureRM.Sql/Get-AzureRmSqlServer.md | 210 -- ...RmSqlServerActiveDirectoryAdministrator.md | 137 - ...SqlServerAdvancedThreatProtectionPolicy.md | 130 - .../Get-AzureRmSqlServerAdvisor.md | 266 -- .../Get-AzureRmSqlServerAuditing.md | 135 - .../Get-AzureRmSqlServerAuditingPolicy.md | 160 -- ...RmSqlServerBackupLongTermRetentionVault.md | 127 - .../Get-AzureRmSqlServerCommunicationLink.md | 160 -- ...mSqlServerDisasterRecoveryConfiguration.md | 146 -- ...erDisasterRecoveryConfigurationActivity.md | 156 -- .../Get-AzureRmSqlServerDnsAlias.md | 158 -- .../Get-AzureRmSqlServerFirewallRule.md | 166 -- .../Get-AzureRmSqlServerKeyVaultKey.md | 167 -- .../Get-AzureRmSqlServerRecommendedAction.md | 261 -- .../Get-AzureRmSqlServerServiceObjective.md | 181 -- ...t-AzureRmSqlServerThreatDetectionPolicy.md | 144 -- ...erverTransparentDataEncryptionProtector.md | 132 - .../Get-AzureRmSqlServerUpgrade.md | 139 - .../Get-AzureRmSqlServerUpgradeHint.md | 160 -- .../Get-AzureRmSqlServerVirtualNetworkRule.md | 118 - .../AzureRM.Sql/Get-AzureRmSqlSyncAgent.md | 158 -- .../Get-AzureRmSqlSyncAgentLinkedDatabase.md | 117 - .../AzureRM.Sql/Get-AzureRmSqlSyncGroup.md | 181 -- .../AzureRM.Sql/Get-AzureRmSqlSyncGroupLog.md | 178 -- .../AzureRM.Sql/Get-AzureRmSqlSyncMember.md | 203 -- .../AzureRM.Sql/Get-AzureRmSqlSyncSchema.md | 171 -- .../AzureRM.Sql/New-AzureRmSqlDatabase.md | 478 ---- .../AzureRM.Sql/New-AzureRmSqlDatabaseCopy.md | 307 --- .../New-AzureRmSqlDatabaseDataMaskingRule.md | 340 --- .../New-AzureRmSqlDatabaseExport.md | 273 -- .../New-AzureRmSqlDatabaseFailoverGroup.md | 214 -- .../New-AzureRmSqlDatabaseImport.md | 325 --- .../New-AzureRmSqlDatabaseRestorePoint.md | 168 -- .../New-AzureRmSqlDatabaseSecondary.md | 318 --- .../AzureRM.Sql/New-AzureRmSqlElasticPool.md | 418 --- .../AzureRM.Sql/New-AzureRmSqlInstance.md | 354 --- .../New-AzureRmSqlInstanceDatabase.md | 252 -- .../AzureRM.Sql/New-AzureRmSqlServer.md | 240 -- .../New-AzureRmSqlServerCommunicationLink.md | 184 -- ...mSqlServerDisasterRecoveryConfiguration.md | 206 -- .../New-AzureRmSqlServerDnsAlias.md | 161 -- .../New-AzureRmSqlServerFirewallRule.md | 223 -- .../New-AzureRmSqlServerVirtualNetworkRule.md | 188 -- .../AzureRM.Sql/New-AzureRmSqlSyncAgent.md | 228 -- .../AzureRM.Sql/New-AzureRmSqlSyncAgentKey.md | 143 -- .../AzureRM.Sql/New-AzureRmSqlSyncGroup.md | 293 --- .../AzureRM.Sql/New-AzureRmSqlSyncMember.md | 391 --- .../AzureRM.Sql/Remove-AzureRmSqlDatabase.md | 174 -- .../Remove-AzureRmSqlDatabaseAuditing.md | 173 -- ...emove-AzureRmSqlDatabaseDataMaskingRule.md | 233 -- .../Remove-AzureRmSqlDatabaseFailoverGroup.md | 173 -- ...ove-AzureRmSqlDatabaseFromFailoverGroup.md | 208 -- ...ureRmSqlDatabaseLongTermRetentionBackup.md | 263 -- .../Remove-AzureRmSqlDatabaseRestorePoint.md | 178 -- .../Remove-AzureRmSqlDatabaseSecondary.md | 175 -- ...AzureRmSqlDatabaseThreatDetectionPolicy.md | 164 -- .../Remove-AzureRmSqlElasticPool.md | 173 -- .../AzureRM.Sql/Remove-AzureRmSqlInstance.md | 186 -- .../Remove-AzureRmSqlInstanceDatabase.md | 201 -- .../AzureRM.Sql/Remove-AzureRmSqlServer.md | 155 -- ...RmSqlServerActiveDirectoryAdministrator.md | 157 -- .../Remove-AzureRmSqlServerAuditing.md | 156 -- ...emove-AzureRmSqlServerCommunicationLink.md | 167 -- ...mSqlServerDisasterRecoveryConfiguration.md | 160 -- .../Remove-AzureRmSqlServerDnsAlias.md | 218 -- .../Remove-AzureRmSqlServerFirewallRule.md | 169 -- .../Remove-AzureRmSqlServerKeyVaultKey.md | 171 -- ...e-AzureRmSqlServerThreatDetectionPolicy.md | 148 -- ...move-AzureRmSqlServerVirtualNetworkRule.md | 158 -- .../AzureRM.Sql/Remove-AzureRmSqlSyncAgent.md | 178 -- .../AzureRM.Sql/Remove-AzureRmSqlSyncGroup.md | 195 -- .../Remove-AzureRmSqlSyncMember.md | 210 -- .../AzureRM.Sql/Restore-AzureRmSqlDatabase.md | 475 ---- .../Restore-AzureRmSqlInstanceDatabase.md | 312 --- .../AzureRM.Sql/Resume-AzureRmSqlDatabase.md | 173 -- .../AzureRM.Sql/Set-AzureRmSqlDatabase.md | 436 ---- ...reRmSqlDatabaseAdvisorAutoExecuteStatus.md | 197 -- .../Set-AzureRmSqlDatabaseAuditing.md | 349 --- .../Set-AzureRmSqlDatabaseAuditingPolicy.md | 348 --- ...qlDatabaseBackupLongTermRetentionPolicy.md | 428 ---- ...Set-AzureRmSqlDatabaseDataMaskingPolicy.md | 232 -- .../Set-AzureRmSqlDatabaseDataMaskingRule.md | 341 --- .../Set-AzureRmSqlDatabaseFailoverGroup.md | 184 -- .../Set-AzureRmSqlDatabaseGeoBackupPolicy.md | 162 -- ...zureRmSqlDatabaseRecommendedActionState.md | 253 -- .../Set-AzureRmSqlDatabaseSecondary.md | 215 -- ...AzureRmSqlDatabaseThreatDetectionPolicy.md | 259 -- ...eRmSqlDatabaseTransparentDataEncryption.md | 178 -- ...baseVulnerabilityAssessmentRuleBaseline.md | 279 -- .../AzureRM.Sql/Set-AzureRmSqlElasticPool.md | 422 --- ...mSqlElasticPoolAdvisorAutoExecuteStatus.md | 197 -- ...eRmSqlElasticPoolRecommendedActionState.md | 238 -- .../AzureRM.Sql/Set-AzureRmSqlInstance.md | 312 --- .../AzureRM.Sql/Set-AzureRmSqlServer.md | 222 -- ...RmSqlServerActiveDirectoryAdministrator.md | 203 -- ...zureRmSqlServerAdvisorAutoExecuteStatus.md | 180 -- .../Set-AzureRmSqlServerAuditing.md | 302 --- .../Set-AzureRmSqlServerAuditingPolicy.md | 314 --- ...RmSqlServerBackupLongTermRetentionVault.md | 142 -- ...mSqlServerDisasterRecoveryConfiguration.md | 190 -- .../Set-AzureRmSqlServerDnsAlias.md | 204 -- .../Set-AzureRmSqlServerFirewallRule.md | 190 -- ...-AzureRmSqlServerRecommendedActionState.md | 224 -- ...t-AzureRmSqlServerThreatDetectionPolicy.md | 239 -- ...erverTransparentDataEncryptionProtector.md | 207 -- .../Set-AzureRmSqlServerVirtualNetworkRule.md | 189 -- ...RmSqlDatabaseExecuteIndexRecommendation.md | 136 - ...mSqlDatabaseVulnerabilityAssessmentScan.md | 314 --- .../Start-AzureRmSqlServerUpgrade.md | 195 -- .../Start-AzureRmSqlSyncGroupSync.md | 176 -- .../Stop-AzureRmSqlDatabaseActivity.md | 189 -- ...RmSqlDatabaseExecuteIndexRecommendation.md | 136 - .../Stop-AzureRmSqlElasticPoolActivity.md | 187 -- .../Stop-AzureRmSqlServerUpgrade.md | 151 -- .../Stop-AzureRmSqlSyncGroupSync.md | 176 -- .../AzureRM.Sql/Suspend-AzureRmSqlDatabase.md | 173 -- .../Switch-AzureRmSqlDatabaseFailoverGroup.md | 195 -- ...DatabaseVulnerabilityAssessmentSettings.md | 382 --- .../AzureRM.Sql/Update-AzureRmSqlSyncGroup.md | 230 -- .../Update-AzureRmSqlSyncMember.md | 212 -- .../Update-AzureRmSqlSyncSchema.md | 197 -- .../Use-AzureRmSqlServerAuditingPolicy.md | 143 -- .../Add-AzureRmStorageAccountNetworkRule.md | 255 -- .../Add-AzureRmStorageContainerLegalHold.md | 216 -- .../AzureRM.Storage/AzureRM.Storage.md | 84 - .../Get-AzureRmStorageAccount.md | 138 - .../Get-AzureRmStorageAccountKey.md | 110 - ...t-AzureRmStorageAccountNameAvailability.md | 86 - ...Get-AzureRmStorageAccountNetworkRuleSet.md | 96 - .../Get-AzureRmStorageContainer.md | 149 -- ...ureRmStorageContainerImmutabilityPolicy.md | 186 -- .../Get-AzureRmStorageUsage.md | 100 - ...ureRmStorageContainerImmutabilityPolicy.md | 265 -- .../New-AzureRmStorageAccount.md | 318 --- .../New-AzureRmStorageAccountKey.md | 118 - .../New-AzureRmStorageContainer.md | 205 -- .../Remove-AzureRmStorageAccount.md | 164 -- ...Remove-AzureRmStorageAccountNetworkRule.md | 253 -- .../Remove-AzureRmStorageContainer.md | 229 -- ...ureRmStorageContainerImmutabilityPolicy.md | 250 -- ...Remove-AzureRmStorageContainerLegalHold.md | 217 -- .../Set-AzureRmCurrentStorageAccount.md | 127 - .../Set-AzureRmStorageAccount.md | 478 ---- ...ureRmStorageContainerImmutabilityPolicy.md | 319 --- ...ate-AzureRmStorageAccountNetworkRuleSet.md | 235 -- .../Update-AzureRmStorageContainer.md | 233 -- .../AzureRm.StorageSync.md | 18 - ...ke-AzureRmStorageSyncCompatibilityCheck.md | 173 -- .../AzureRM.StreamAnalytics.md | 78 - ...treamAnalyticsDefaultFunctionDefinition.md | 135 - .../Get-AzureRmStreamAnalyticsFunction.md | 129 - .../Get-AzureRmStreamAnalyticsInput.md | 127 - .../Get-AzureRmStreamAnalyticsJob.md | 144 -- .../Get-AzureRmStreamAnalyticsOutput.md | 127 - .../Get-AzureRmStreamAnalyticsQuota.md | 87 - ...et-AzureRmStreamAnalyticsTransformation.md | 116 - .../New-AzureRmStreamAnalyticsFunction.md | 201 -- .../New-AzureRmStreamAnalyticsInput.md | 202 -- .../New-AzureRmStreamAnalyticsJob.md | 182 -- .../New-AzureRmStreamAnalyticsOutput.md | 194 -- ...ew-AzureRmStreamAnalyticsTransformation.md | 190 -- .../Remove-AzureRmStreamAnalyticsFunction.md | 153 -- .../Remove-AzureRmStreamAnalyticsInput.md | 151 -- .../Remove-AzureRmStreamAnalyticsJob.md | 138 - .../Remove-AzureRmStreamAnalyticsOutput.md | 151 -- .../Start-AzureRmStreamAnalyticsJob.md | 146 -- .../Stop-AzureRmStreamAnalyticsJob.md | 111 - .../Test-AzureRmStreamAnalyticsFunction.md | 121 - .../Test-AzureRmStreamAnalyticsInput.md | 120 - .../Test-AzureRmStreamAnalyticsOutput.md | 120 - .../AzureRM.Subscription.md | 18 - .../New-AzureRmSubscription.md | 207 -- azurermps-6.13.0/AzureRM.Tags/AzureRM.Tags.md | 24 - .../AzureRM.Tags/Get-AzureRmTag.md | 174 -- .../AzureRM.Tags/New-AzureRmTag.md | 217 -- .../AzureRM.Tags/Remove-AzureRmTag.md | 180 -- ...eRmTrafficManagerCustomHeaderToEndpoint.md | 164 -- ...reRmTrafficManagerCustomHeaderToProfile.md | 162 -- ...Add-AzureRmTrafficManagerEndpointConfig.md | 328 --- ...RmTrafficManagerExpectedStatusCodeRange.md | 162 -- ...Add-AzureRmTrafficManagerIpAddressRange.md | 185 -- .../AzureRM.TrafficManager.md | 81 - .../Disable-AzureRmTrafficManagerEndpoint.md | 238 -- .../Disable-AzureRmTrafficManagerProfile.md | 194 -- .../Enable-AzureRmTrafficManagerEndpoint.md | 188 -- .../Enable-AzureRmTrafficManagerProfile.md | 145 -- .../Get-AzureRmTrafficManagerEndpoint.md | 174 -- .../Get-AzureRmTrafficManagerProfile.md | 134 - .../New-AzureRmTrafficManagerEndpoint.md | 346 --- .../New-AzureRmTrafficManagerProfile.md | 359 --- ...mTrafficManagerCustomHeaderFromEndpoint.md | 148 -- ...RmTrafficManagerCustomHeaderFromProfile.md | 146 -- .../Remove-AzureRmTrafficManagerEndpoint.md | 225 -- ...ove-AzureRmTrafficManagerEndpointConfig.md | 124 - ...RmTrafficManagerExpectedStatusCodeRange.md | 145 -- ...ove-AzureRmTrafficManagerIpAddressRange.md | 147 -- .../Remove-AzureRmTrafficManagerProfile.md | 195 -- .../Set-AzureRmTrafficManagerEndpoint.md | 98 - .../Set-AzureRmTrafficManagerProfile.md | 110 - .../AzureRM.UsageAggregates.md | 18 - .../Get-UsageAggregates.md | 163 -- .../AzureRM.Websites/AzureRM.Websites.md | 156 -- .../Edit-AzureRmWebAppBackupConfiguration.md | 250 -- .../Enter-AzureRmWebAppContainerPSSession.md | 192 -- .../Get-AzureRmAppServicePlan.md | 133 - .../Get-AzureRmAppServicePlanMetrics.md | 198 -- .../Get-AzureRmDeletedWebApp.md | 114 - .../AzureRM.Websites/Get-AzureRmWebApp.md | 151 -- .../Get-AzureRmWebAppBackup.md | 151 -- .../Get-AzureRmWebAppBackupConfiguration.md | 136 - .../Get-AzureRmWebAppBackupList.md | 135 - .../Get-AzureRmWebAppCertificate.md | 109 - ...mWebAppContainerContinuousDeploymentUrl.md | 132 - .../Get-AzureRmWebAppMetrics.md | 204 -- .../Get-AzureRmWebAppPublishingProfile.md | 191 -- .../Get-AzureRmWebAppSSLBinding.md | 175 -- .../AzureRM.Websites/Get-AzureRmWebAppSlot.md | 152 -- .../Get-AzureRmWebAppSlotConfigName.md | 122 - .../Get-AzureRmWebAppSlotMetrics.md | 221 -- .../Get-AzureRmWebAppSlotPublishingProfile.md | 207 -- .../Get-AzureRmWebAppSnapshot.md | 135 - .../New-AzureRmAppServicePlan.md | 268 -- .../AzureRM.Websites/New-AzureRmWebApp.md | 454 ---- .../New-AzureRmWebAppBackup.md | 184 -- .../New-AzureRmWebAppContainerPSSession.md | 178 -- .../New-AzureRmWebAppDatabaseBackupSetting.md | 126 - .../New-AzureRmWebAppSSLBinding.md | 255 -- .../AzureRM.Websites/New-AzureRmWebAppSlot.md | 331 --- .../Remove-AzureRmAppServicePlan.md | 189 -- .../AzureRM.Websites/Remove-AzureRmWebApp.md | 197 -- .../Remove-AzureRmWebAppBackup.md | 151 -- .../Remove-AzureRmWebAppSSLBinding.md | 254 -- .../Remove-AzureRmWebAppSlot.md | 211 -- .../Reset-AzureRmWebAppPublishingProfile.md | 121 - ...eset-AzureRmWebAppSlotPublishingProfile.md | 136 - .../AzureRM.Websites/Restart-AzureRmWebApp.md | 134 - .../Restart-AzureRmWebAppSlot.md | 150 -- .../Restore-AzureRmDeletedWebApp.md | 251 -- .../Restore-AzureRmWebAppBackup.md | 233 -- .../Restore-AzureRmWebAppSnapshot.md | 235 -- .../Set-AzureRmAppServicePlan.md | 226 -- .../AzureRM.Websites/Set-AzureRmWebApp.md | 508 ---- .../AzureRM.Websites/Set-AzureRmWebAppSlot.md | 515 ---- .../Set-AzureRmWebAppSlotConfigName.md | 186 -- .../AzureRM.Websites/Start-AzureRmWebApp.md | 133 - .../Start-AzureRmWebAppSlot.md | 150 -- .../AzureRM.Websites/Stop-AzureRmWebApp.md | 133 - .../Stop-AzureRmWebAppSlot.md | 136 - .../Switch-AzureRmWebAppSlot.md | 216 -- docfx.json | 20 +- .../azurermps-6.13.0/authenticate-azureps.md | 102 - .../azurermps-6.13.0/azureps-vm-tutorial.yml | 333 --- .../azurermps-6.13.0/context-persistence.md | 196 -- .../create-azure-service-principal-azureps.md | 258 -- docs-conceptual/azurermps-6.13.0/faq.md | 47 - .../azurermps-6.13.0/formatting-output.md | 125 - .../azurermps-6.13.0/get-started-azureps.md | 413 --- .../azurermps-6.13.0/install-azurerm-ps.md | 146 -- .../manage-subscriptions-azureps.md | 69 - .../azurermps-6.13.0/migration-guide.6.0.0.md | 571 ----- .../azurermps-6.13.0/other-install.md | 49 - docs-conceptual/azurermps-6.13.0/overview.md | 49 - .../azurermps-6.13.0/queries-azureps.md | 101 - .../azurermps-6.13.0/release-notes-azureps.md | 1050 -------- docs-conceptual/azurermps-6.13.0/toc.yml | 64 - .../azurermps-6.13.0/uninstall-azurerm-ps.md | 140 - .../using-experimental-modules.md | 126 - .../azurermps-6.13.0/using-psjobs.md | 153 -- mapping/monikerMapping.json | 7 - mapping/rm-groupMapping-6.13.0.json | 2268 ----------------- 2358 files changed, 1 insertion(+), 466450 deletions(-) delete mode 100644 azurermps-6.13.0/Azure.AnalysisServices/Add-AzureAnalysisServicesAccount.md delete mode 100644 azurermps-6.13.0/Azure.AnalysisServices/Azure.AnalysisServices.md delete mode 100644 azurermps-6.13.0/Azure.AnalysisServices/Export-AzureAnalysisServicesInstanceLog.md delete mode 100644 azurermps-6.13.0/Azure.AnalysisServices/Restart-AzureAnalysisServicesInstance.md delete mode 100644 azurermps-6.13.0/Azure.AnalysisServices/Sync-AzureAnalysisServicesInstance.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Azure.Storage.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Disable-AzureStorageDeleteRetentionPolicy.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Enable-AzureStorageDeleteRetentionPolicy.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Get-AzureStorageBlob.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Get-AzureStorageBlobContent.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Get-AzureStorageBlobCopyState.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Get-AzureStorageCORSRule.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Get-AzureStorageContainer.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Get-AzureStorageContainerStoredAccessPolicy.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Get-AzureStorageFile.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Get-AzureStorageFileContent.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Get-AzureStorageFileCopyState.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Get-AzureStorageQueue.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Get-AzureStorageQueueStoredAccessPolicy.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Get-AzureStorageServiceLoggingProperty.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Get-AzureStorageServiceMetricsProperty.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Get-AzureStorageServiceProperty.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Get-AzureStorageShare.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Get-AzureStorageShareStoredAccessPolicy.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Get-AzureStorageTable.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Get-AzureStorageTableStoredAccessPolicy.md delete mode 100644 azurermps-6.13.0/Azure.Storage/New-AzureStorageAccountSASToken.md delete mode 100644 azurermps-6.13.0/Azure.Storage/New-AzureStorageBlobSASToken.md delete mode 100644 azurermps-6.13.0/Azure.Storage/New-AzureStorageContainer.md delete mode 100644 azurermps-6.13.0/Azure.Storage/New-AzureStorageContainerSASToken.md delete mode 100644 azurermps-6.13.0/Azure.Storage/New-AzureStorageContainerStoredAccessPolicy.md delete mode 100644 azurermps-6.13.0/Azure.Storage/New-AzureStorageContext.md delete mode 100644 azurermps-6.13.0/Azure.Storage/New-AzureStorageDirectory.md delete mode 100644 azurermps-6.13.0/Azure.Storage/New-AzureStorageFileSASToken.md delete mode 100644 azurermps-6.13.0/Azure.Storage/New-AzureStorageQueue.md delete mode 100644 azurermps-6.13.0/Azure.Storage/New-AzureStorageQueueSASToken.md delete mode 100644 azurermps-6.13.0/Azure.Storage/New-AzureStorageQueueStoredAccessPolicy.md delete mode 100644 azurermps-6.13.0/Azure.Storage/New-AzureStorageShare.md delete mode 100644 azurermps-6.13.0/Azure.Storage/New-AzureStorageShareSASToken.md delete mode 100644 azurermps-6.13.0/Azure.Storage/New-AzureStorageShareStoredAccessPolicy.md delete mode 100644 azurermps-6.13.0/Azure.Storage/New-AzureStorageTable.md delete mode 100644 azurermps-6.13.0/Azure.Storage/New-AzureStorageTableSASToken.md delete mode 100644 azurermps-6.13.0/Azure.Storage/New-AzureStorageTableStoredAccessPolicy.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Remove-AzureStorageBlob.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Remove-AzureStorageCORSRule.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Remove-AzureStorageContainer.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Remove-AzureStorageContainerStoredAccessPolicy.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Remove-AzureStorageDirectory.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Remove-AzureStorageFile.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Remove-AzureStorageQueue.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Remove-AzureStorageQueueStoredAccessPolicy.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Remove-AzureStorageShare.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Remove-AzureStorageShareStoredAccessPolicy.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Remove-AzureStorageTable.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Remove-AzureStorageTableStoredAccessPolicy.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Set-AzureStorageBlobContent.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Set-AzureStorageCORSRule.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Set-AzureStorageContainerAcl.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Set-AzureStorageContainerStoredAccessPolicy.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Set-AzureStorageFileContent.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Set-AzureStorageQueueStoredAccessPolicy.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Set-AzureStorageServiceLoggingProperty.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Set-AzureStorageServiceMetricsProperty.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Set-AzureStorageShareQuota.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Set-AzureStorageShareStoredAccessPolicy.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Set-AzureStorageTableStoredAccessPolicy.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Start-AzureStorageBlobCopy.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Start-AzureStorageBlobIncrementalCopy.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Start-AzureStorageFileCopy.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Stop-AzureStorageBlobCopy.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Stop-AzureStorageFileCopy.md delete mode 100644 azurermps-6.13.0/Azure.Storage/Update-AzureStorageServiceProperty.md delete mode 100644 azurermps-6.13.0/AzureRM.Aks/AzureRM.Aks.md delete mode 100644 azurermps-6.13.0/AzureRM.Aks/Get-AzureRmAks.md delete mode 100644 azurermps-6.13.0/AzureRM.Aks/Import-AzureRmAksCredential.md delete mode 100644 azurermps-6.13.0/AzureRM.Aks/New-AzureRmAks.md delete mode 100644 azurermps-6.13.0/AzureRM.Aks/Remove-AzureRmAks.md delete mode 100644 azurermps-6.13.0/AzureRM.Aks/Set-AzureRmAks.md delete mode 100644 azurermps-6.13.0/AzureRM.Aks/Start-AzureRmAksDashboard.md delete mode 100644 azurermps-6.13.0/AzureRM.Aks/Stop-AzureRmAksDashboard.md delete mode 100644 azurermps-6.13.0/AzureRM.AnalysisServices/AzureRM.AnalysisServices.md delete mode 100644 azurermps-6.13.0/AzureRM.AnalysisServices/Get-AzureRmAnalysisServicesServer.md delete mode 100644 azurermps-6.13.0/AzureRM.AnalysisServices/New-AzureRmAnalysisServicesFirewallConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.AnalysisServices/New-AzureRmAnalysisServicesFirewallRule.md delete mode 100644 azurermps-6.13.0/AzureRM.AnalysisServices/New-AzureRmAnalysisServicesServer.md delete mode 100644 azurermps-6.13.0/AzureRM.AnalysisServices/Remove-AzureRmAnalysisServicesServer.md delete mode 100644 azurermps-6.13.0/AzureRM.AnalysisServices/Resume-AzureRmAnalysisServicesServer.md delete mode 100644 azurermps-6.13.0/AzureRM.AnalysisServices/Set-AzureRmAnalysisServicesServer.md delete mode 100644 azurermps-6.13.0/AzureRM.AnalysisServices/Suspend-AzureRmAnalysisServicesServer.md delete mode 100644 azurermps-6.13.0/AzureRM.AnalysisServices/Test-AzureRmAnalysisServicesServer.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Add-AzureRmApiManagementApiToProduct.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Add-AzureRmApiManagementProductToGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Add-AzureRmApiManagementRegion.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Add-AzureRmApiManagementUserToGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/AzureRM.ApiManagement.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Backup-AzureRmApiManagement.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Export-AzureRmApiManagementApi.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagement.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementApi.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementApiRelease.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementApiRevision.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementApiVersionSet.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementAuthorizationServer.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementBackend.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementIdentityProvider.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementLogger.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementOpenIdConnectProvider.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementOperation.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementProduct.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementProperty.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementSsoToken.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementSubscription.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementTenantAccess.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementTenantGitAccess.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementTenantSyncState.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementUser.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementUserSsoUrl.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Import-AzureRmApiManagementApi.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Import-AzureRmApiManagementHostnameCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagement.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementApi.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementApiRelease.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementApiRevision.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementApiVersionSet.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementAuthorizationServer.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementBackend.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementBackendCredential.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementBackendProxy.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementBackendServiceFabric.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementContext.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementCustomHostnameConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementHostnameConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementIdentityProvider.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementLogger.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementOpenIdConnectProvider.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementOperation.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementProduct.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementProperty.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementRegion.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementSubscription.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementSystemCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementUser.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementVirtualNetwork.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Publish-AzureRmApiManagementTenantGitConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagement.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementApi.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementApiFromProduct.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementApiRelease.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementApiRevision.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementApiVersionSet.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementAuthorizationServer.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementBackend.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementIdentityProvider.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementLogger.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementOpenIdConnectProvider.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementOperation.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementProduct.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementProductFromGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementProperty.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementRegion.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementSubscription.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementUser.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementUserFromGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Restore-AzureRmApiManagement.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Save-AzureRmApiManagementTenantGitConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagement.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementApi.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementApiRevision.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementApiVersionSet.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementAuthorizationServer.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementBackend.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementHostnames.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementIdentityProvider.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementLogger.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementOpenIdConnectProvider.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementOperation.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementProduct.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementProperty.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementSubscription.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementTenantAccess.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementUser.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Update-AzureRmApiManagementApiRelease.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Update-AzureRmApiManagementDeployment.md delete mode 100644 azurermps-6.13.0/AzureRM.ApiManagement/Update-AzureRmApiManagementRegion.md delete mode 100644 azurermps-6.13.0/AzureRM.ApplicationInsights/AzureRM.ApplicationInsights.md delete mode 100644 azurermps-6.13.0/AzureRM.ApplicationInsights/Get-AzureRmApplicationInsights.md delete mode 100644 azurermps-6.13.0/AzureRM.ApplicationInsights/Get-AzureRmApplicationInsightsApiKey.md delete mode 100644 azurermps-6.13.0/AzureRM.ApplicationInsights/Get-AzureRmApplicationInsightsContinuousExport.md delete mode 100644 azurermps-6.13.0/AzureRM.ApplicationInsights/New-AzureRmApplicationInsights.md delete mode 100644 azurermps-6.13.0/AzureRM.ApplicationInsights/New-AzureRmApplicationInsightsApiKey.md delete mode 100644 azurermps-6.13.0/AzureRM.ApplicationInsights/New-AzureRmApplicationInsightsContinuousExport.md delete mode 100644 azurermps-6.13.0/AzureRM.ApplicationInsights/Remove-AzureRmApplicationInsights.md delete mode 100644 azurermps-6.13.0/AzureRM.ApplicationInsights/Remove-AzureRmApplicationInsightsApiKey.md delete mode 100644 azurermps-6.13.0/AzureRM.ApplicationInsights/Remove-AzureRmApplicationInsightsContinuousExport.md delete mode 100644 azurermps-6.13.0/AzureRM.ApplicationInsights/Set-AzureRmApplicationInsightsContinuousExport.md delete mode 100644 azurermps-6.13.0/AzureRM.ApplicationInsights/Set-AzureRmApplicationInsightsDailyCap.md delete mode 100644 azurermps-6.13.0/AzureRM.ApplicationInsights/Set-AzureRmApplicationInsightsPricingPlan.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/AzureRM.Automation.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Export-AzureRMAutomationRunbook.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Export-AzureRmAutomationDscConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Export-AzureRmAutomationDscNodeReportContent.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationConnection.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationCredential.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationHybridWorkerGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationJob.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationJobOutput.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationRunbook.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationSchedule.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationScheduledRunbook.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationVariable.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationWebhook.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscCompilationJob.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscCompilationJobOutput.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscNode.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscNodeConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscNodeConfigurationDeployment.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscNodeConfigurationDeploymentSchedule.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscNodeReport.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscOnboardingMetaconfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationJobOutputRecord.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationModule.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationRegistrationInfo.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationSoftwareUpdateConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationSoftwareUpdateMachineRun.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationSoftwareUpdateRun.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationSourceControl.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationSourceControlSyncJob.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationSourceControlSyncJobOutput.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Import-AzureRMAutomationRunbook.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Import-AzureRmAutomationDscConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Import-AzureRmAutomationDscNodeConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/New-AzureRMAutomationCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/New-AzureRMAutomationConnection.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/New-AzureRMAutomationCredential.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/New-AzureRMAutomationRunbook.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/New-AzureRMAutomationSchedule.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/New-AzureRMAutomationVariable.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/New-AzureRMAutomationWebhook.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/New-AzureRmAutomationAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/New-AzureRmAutomationKey.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/New-AzureRmAutomationModule.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/New-AzureRmAutomationSoftwareUpdateConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/New-AzureRmAutomationSourceControl.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Publish-AzureRMAutomationRunbook.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Register-AzureRMAutomationScheduledRunbook.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Register-AzureRmAutomationDscNode.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Remove-AzureRMAutomationCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Remove-AzureRMAutomationConnection.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Remove-AzureRMAutomationCredential.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Remove-AzureRMAutomationRunbook.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Remove-AzureRMAutomationSchedule.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Remove-AzureRMAutomationVariable.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Remove-AzureRMAutomationWebhook.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Remove-AzureRmAutomationAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Remove-AzureRmAutomationConnectionType.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Remove-AzureRmAutomationDscConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Remove-AzureRmAutomationDscNodeConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Remove-AzureRmAutomationHybridWorkerGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Remove-AzureRmAutomationModule.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Remove-AzureRmAutomationSoftwareUpdateConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Remove-AzureRmAutomationSourceControl.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Resume-AzureRMAutomationJob.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Set-AzureRMAutomationCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Set-AzureRMAutomationConnectionFieldValue.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Set-AzureRMAutomationCredential.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Set-AzureRMAutomationRunbook.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Set-AzureRMAutomationSchedule.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Set-AzureRMAutomationVariable.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Set-AzureRMAutomationWebhook.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Set-AzureRmAutomationAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Set-AzureRmAutomationDscNode.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Set-AzureRmAutomationModule.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Start-AzureRMAutomationRunbook.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Start-AzureRmAutomationDscCompilationJob.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Start-AzureRmAutomationDscNodeConfigurationDeployment.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Start-AzureRmAutomationSourceControlSyncJob.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Stop-AzureRMAutomationJob.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Stop-AzureRmAutomationDscNodeConfigurationDeployment.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Suspend-AzureRMAutomationJob.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Unregister-AzureRMAutomationScheduledRunbook.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Unregister-AzureRmAutomationDscNode.md delete mode 100644 azurermps-6.13.0/AzureRM.Automation/Update-AzureRmAutomationSourceControl.md delete mode 100644 azurermps-6.13.0/AzureRM.Backup/AzureRM.Backup.md delete mode 100644 azurermps-6.13.0/AzureRM.Backup/Backup-AzureRmBackupItem.md delete mode 100644 azurermps-6.13.0/AzureRM.Backup/Disable-AzureRmBackupProtection.md delete mode 100644 azurermps-6.13.0/AzureRM.Backup/Enable-AzureRmBackupContainerReregistration.md delete mode 100644 azurermps-6.13.0/AzureRM.Backup/Enable-AzureRmBackupProtection.md delete mode 100644 azurermps-6.13.0/AzureRM.Backup/Get-AzureRmBackupContainer.md delete mode 100644 azurermps-6.13.0/AzureRM.Backup/Get-AzureRmBackupItem.md delete mode 100644 azurermps-6.13.0/AzureRM.Backup/Get-AzureRmBackupJob.md delete mode 100644 azurermps-6.13.0/AzureRM.Backup/Get-AzureRmBackupJobDetails.md delete mode 100644 azurermps-6.13.0/AzureRM.Backup/Get-AzureRmBackupProtectionPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Backup/Get-AzureRmBackupRecoveryPoint.md delete mode 100644 azurermps-6.13.0/AzureRM.Backup/Get-AzureRmBackupVault.md delete mode 100644 azurermps-6.13.0/AzureRM.Backup/Get-AzureRmBackupVaultCredentials.md delete mode 100644 azurermps-6.13.0/AzureRM.Backup/New-AzureRmBackupProtectionPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Backup/New-AzureRmBackupRetentionPolicyObject.md delete mode 100644 azurermps-6.13.0/AzureRM.Backup/New-AzureRmBackupVault.md delete mode 100644 azurermps-6.13.0/AzureRM.Backup/Register-AzureRmBackupContainer.md delete mode 100644 azurermps-6.13.0/AzureRM.Backup/Remove-AzureRmBackupProtectionPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Backup/Remove-AzureRmBackupVault.md delete mode 100644 azurermps-6.13.0/AzureRM.Backup/Restore-AzureRmBackupItem.md delete mode 100644 azurermps-6.13.0/AzureRM.Backup/Set-AzureRmBackupProtectionPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Backup/Set-AzureRmBackupVault.md delete mode 100644 azurermps-6.13.0/AzureRM.Backup/Stop-AzureRmBackupJob.md delete mode 100644 azurermps-6.13.0/AzureRM.Backup/Unregister-AzureRmBackupContainer.md delete mode 100644 azurermps-6.13.0/AzureRM.Backup/Wait-AzureRmBackupJob.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/AzureRM.Batch.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Disable-AzureBatchAutoScale.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Disable-AzureBatchComputeNodeScheduling.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Disable-AzureBatchJob.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Disable-AzureBatchJobSchedule.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Enable-AzureBatchAutoScale.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Enable-AzureBatchComputeNodeScheduling.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Enable-AzureBatchJob.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Enable-AzureBatchJobSchedule.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Enable-AzureBatchTask.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchComputeNode.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchJob.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchJobPreparationAndReleaseTaskStatus.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchJobSchedule.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchJobStatistics.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchNodeAgentSku.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchNodeFile.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchNodeFileContent.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchPool.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchPoolNodeCounts.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchPoolStatistics.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchPoolUsageMetrics.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchRemoteDesktopProtocolFile.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchRemoteLoginSettings.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchSubtask.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchTask.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchTaskCounts.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Get-AzureRmBatchAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Get-AzureRmBatchAccountKeys.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Get-AzureRmBatchApplication.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Get-AzureRmBatchApplicationPackage.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Get-AzureRmBatchLocationQuotas.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/New-AzureBatchCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/New-AzureBatchComputeNodeUser.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/New-AzureBatchJob.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/New-AzureBatchJobSchedule.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/New-AzureBatchPool.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/New-AzureBatchTask.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/New-AzureRmBatchAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/New-AzureRmBatchAccountKey.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/New-AzureRmBatchApplication.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/New-AzureRmBatchApplicationPackage.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Remove-AzureBatchCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Remove-AzureBatchComputeNode.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Remove-AzureBatchComputeNodeUser.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Remove-AzureBatchJob.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Remove-AzureBatchJobSchedule.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Remove-AzureBatchNodeFile.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Remove-AzureBatchPool.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Remove-AzureBatchTask.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Remove-AzureRmBatchAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Remove-AzureRmBatchApplication.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Remove-AzureRmBatchApplicationPackage.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Reset-AzureBatchComputeNode.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Restart-AzureBatchComputeNode.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Set-AzureBatchComputeNodeUser.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Set-AzureBatchJob.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Set-AzureBatchJobSchedule.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Set-AzureBatchPool.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Set-AzureBatchPoolOSVersion.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Set-AzureBatchTask.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Set-AzureRmBatchAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Set-AzureRmBatchApplication.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Start-AzureBatchComputeNodeServiceLogUpload.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Start-AzureBatchPoolResize.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Stop-AzureBatchCertificateDeletion.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Stop-AzureBatchJob.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Stop-AzureBatchJobSchedule.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Stop-AzureBatchPoolResize.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Stop-AzureBatchTask.md delete mode 100644 azurermps-6.13.0/AzureRM.Batch/Test-AzureBatchAutoScale.md delete mode 100644 azurermps-6.13.0/AzureRM.Billing/AzureRM.Billing.md delete mode 100644 azurermps-6.13.0/AzureRM.Billing/Get-AzureRmBillingInvoice.md delete mode 100644 azurermps-6.13.0/AzureRM.Billing/Get-AzureRmBillingPeriod.md delete mode 100644 azurermps-6.13.0/AzureRM.Billing/Get-AzureRmEnrollmentAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.Cdn/AzureRM.Cdn.md delete mode 100644 azurermps-6.13.0/AzureRM.Cdn/Confirm-AzureRmCdnEndpointProbeURL.md delete mode 100644 azurermps-6.13.0/AzureRM.Cdn/Disable-AzureRmCdnCustomDomain.md delete mode 100644 azurermps-6.13.0/AzureRM.Cdn/Enable-AzureRmCdnCustomDomain.md delete mode 100644 azurermps-6.13.0/AzureRM.Cdn/Get-AzureRMCdnProfile.md delete mode 100644 azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnCustomDomain.md delete mode 100644 azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnEdgeNodes.md delete mode 100644 azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnEndpoint.md delete mode 100644 azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnEndpointNameAvailability.md delete mode 100644 azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnEndpointResourceUsage.md delete mode 100644 azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnOrigin.md delete mode 100644 azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnProfileResourceUsage.md delete mode 100644 azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnProfileSsoUrl.md delete mode 100644 azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnProfileSupportedOptimizationType.md delete mode 100644 azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnSubscriptionResourceUsage.md delete mode 100644 azurermps-6.13.0/AzureRM.Cdn/New-AzureRmCdnCustomDomain.md delete mode 100644 azurermps-6.13.0/AzureRM.Cdn/New-AzureRmCdnEndpoint.md delete mode 100644 azurermps-6.13.0/AzureRM.Cdn/New-AzureRmCdnProfile.md delete mode 100644 azurermps-6.13.0/AzureRM.Cdn/Publish-AzureRmCdnEndpointContent.md delete mode 100644 azurermps-6.13.0/AzureRM.Cdn/Remove-AzureRmCdnCustomDomain.md delete mode 100644 azurermps-6.13.0/AzureRM.Cdn/Remove-AzureRmCdnEndpoint.md delete mode 100644 azurermps-6.13.0/AzureRM.Cdn/Remove-AzureRmCdnProfile.md delete mode 100644 azurermps-6.13.0/AzureRM.Cdn/Set-AzureRmCdnEndpoint.md delete mode 100644 azurermps-6.13.0/AzureRM.Cdn/Set-AzureRmCdnOrigin.md delete mode 100644 azurermps-6.13.0/AzureRM.Cdn/Set-AzureRmCdnProfile.md delete mode 100644 azurermps-6.13.0/AzureRM.Cdn/Start-AzureRmCdnEndpoint.md delete mode 100644 azurermps-6.13.0/AzureRM.Cdn/Stop-AzureRmCdnEndpoint.md delete mode 100644 azurermps-6.13.0/AzureRM.Cdn/Test-AzureRmCdnCustomDomain.md delete mode 100644 azurermps-6.13.0/AzureRM.Cdn/Unpublish-AzureRmCdnEndpointContent.md delete mode 100644 azurermps-6.13.0/AzureRM.CognitiveServices/AzureRM.CognitiveServices.md delete mode 100644 azurermps-6.13.0/AzureRM.CognitiveServices/Get-AzureRmCognitiveServicesAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.CognitiveServices/Get-AzureRmCognitiveServicesAccountKey.md delete mode 100644 azurermps-6.13.0/AzureRM.CognitiveServices/Get-AzureRmCognitiveServicesAccountSkus.md delete mode 100644 azurermps-6.13.0/AzureRM.CognitiveServices/Get-AzureRmCognitiveServicesAccountType.md delete mode 100644 azurermps-6.13.0/AzureRM.CognitiveServices/Get-AzureRmCognitiveServicesAccountUsage.md delete mode 100644 azurermps-6.13.0/AzureRM.CognitiveServices/New-AzureRmCognitiveServicesAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.CognitiveServices/New-AzureRmCognitiveServicesAccountKey.md delete mode 100644 azurermps-6.13.0/AzureRM.CognitiveServices/Remove-AzureRmCognitiveServicesAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.CognitiveServices/Set-AzureRmCognitiveServicesAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute.ManagedService/AzureRM.Compute.ManagedService.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute.ManagedService/ConvertTo-AzureRmVhd.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Add-AzureRMVhd.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Add-AzureRmContainerServiceAgentPoolProfile.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Add-AzureRmImageDataDisk.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVMAdditionalUnattendContent.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVMDataDisk.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVMNetworkInterface.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVMSecret.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVMSshPublicKey.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssAdditionalUnattendContent.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssDataDisk.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssDiagnosticsExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssNetworkInterfaceConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssSecret.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssSshPublicKey.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssVMDataDisk.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssWinRMListener.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/AzureRM.Compute.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/ConvertTo-AzureRmVMManagedDisk.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Disable-AzureRmVMDiskEncryption.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Disable-AzureRmVmssDiskEncryption.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Export-AzureRmLogAnalyticRequestRateByInterval.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Export-AzureRmLogAnalyticThrottledRequests.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRMVMDiagnosticsExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRMVMSqlServerExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmAvailabilitySet.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmComputeResourceSku.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmContainerService.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmDisk.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmGallery.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmGalleryImageDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmGalleryImageVersion.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmImage.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmRemoteDesktopFile.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmSnapshot.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVM.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMADDomainExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMAEMExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMAccessExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMBootDiagnosticsData.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMChefExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMCustomScriptExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMDiskEncryptionStatus.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMDscExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMDscExtensionStatus.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMExtensionImage.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMExtensionImageType.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMImage.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMImageOffer.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMImagePublisher.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMImageSku.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMRunCommandDocument.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMSize.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMUsage.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVmss.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVmssDiskEncryption.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVmssRollingUpgrade.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVmssSku.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVmssVM.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVmssVMDiskEncryption.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Grant-AzureRmDiskAccess.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Grant-AzureRmSnapshotAccess.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Invoke-AzureRmVMRunCommand.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Invoke-AzureRmVmssVMRunCommand.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/New-AzureRmAvailabilitySet.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/New-AzureRmContainerService.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/New-AzureRmContainerServiceConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/New-AzureRmDisk.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/New-AzureRmDiskConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/New-AzureRmDiskUpdateConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/New-AzureRmGallery.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/New-AzureRmGalleryImageDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/New-AzureRmGalleryImageVersion.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/New-AzureRmImage.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/New-AzureRmImageConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/New-AzureRmSnapshot.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/New-AzureRmSnapshotConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/New-AzureRmSnapshotUpdateConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/New-AzureRmVM.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/New-AzureRmVMConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/New-AzureRmVMDataDisk.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/New-AzureRmVMSqlServerAutoBackupConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/New-AzureRmVMSqlServerAutoPatchingConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/New-AzureRmVMSqlServerKeyVaultCredentialConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/New-AzureRmVmss.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/New-AzureRmVmssConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/New-AzureRmVmssIpConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/New-AzureRmVmssIpTagConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/New-AzureRmVmssVaultCertificateConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Publish-AzureRmVMDscConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Remove-AzureRMVMSqlServerExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmAvailabilitySet.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmContainerService.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmContainerServiceAgentPoolProfile.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmDisk.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmGallery.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmGalleryImageDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmGalleryImageVersion.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmImage.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmImageDataDisk.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmSnapshot.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVM.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMAEMExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMAccessExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMBackup.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMChefExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMCustomScriptExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMDataDisk.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMDiagnosticsExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMDiskEncryptionExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMDscExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMNetworkInterface.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMSecret.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVmss.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVmssDataDisk.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVmssDiagnosticsExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVmssExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVmssNetworkInterfaceConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVmssVMDataDisk.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Repair-AzureRmVmssServiceFabricUpdateDomain.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Restart-AzureRmVM.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Restart-AzureRmVmss.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Revoke-AzureRmDiskAccess.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Revoke-AzureRmSnapshotAccess.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Save-AzureRmVMImage.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Save-AzureRmVhd.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRMVMDataDisk.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRMVMDiagnosticsExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRMVMSqlServerExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRmDiskDiskEncryptionKey.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRmDiskImageReference.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRmDiskKeyEncryptionKey.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRmDiskUpdateDiskEncryptionKey.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRmDiskUpdateKeyEncryptionKey.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRmImageOsDisk.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRmSnapshotDiskEncryptionKey.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRmSnapshotImageReference.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRmSnapshotKeyEncryptionKey.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRmSnapshotUpdateDiskEncryptionKey.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRmSnapshotUpdateKeyEncryptionKey.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVM.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMADDomainExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMAEMExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMAccessExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMBackupExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMBginfoExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMBootDiagnostics.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMChefExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMCustomScriptExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMDiskEncryptionExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMDscExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMOSDisk.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMOperatingSystem.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMPlan.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMSourceImage.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVmss.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVmssBootDiagnostic.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVmssDiskEncryptionExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVmssOsProfile.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVmssRollingUpgradePolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVmssStorageProfile.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVmssVM.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Start-AzureRmVM.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Start-AzureRmVmss.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Start-AzureRmVmssRollingOSUpgrade.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Stop-AzureRmVM.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Stop-AzureRmVmss.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Stop-AzureRmVmssRollingUpgrade.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Test-AzureRmVMAEMExtension.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Update-AzureRmAvailabilitySet.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Update-AzureRmContainerService.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Update-AzureRmDisk.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Update-AzureRmGallery.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Update-AzureRmGalleryImageDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Update-AzureRmGalleryImageVersion.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Update-AzureRmImage.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Update-AzureRmSnapshot.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Update-AzureRmVM.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Update-AzureRmVmss.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Update-AzureRmVmssInstance.md delete mode 100644 azurermps-6.13.0/AzureRM.Compute/Update-AzureRmVmssVM.md delete mode 100644 azurermps-6.13.0/AzureRM.Consumption/AzureRM.Consumption.md delete mode 100644 azurermps-6.13.0/AzureRM.Consumption/Get-AzureRmConsumptionBudget.md delete mode 100644 azurermps-6.13.0/AzureRM.Consumption/Get-AzureRmConsumptionMarketplace.md delete mode 100644 azurermps-6.13.0/AzureRM.Consumption/Get-AzureRmConsumptionPriceSheet.md delete mode 100644 azurermps-6.13.0/AzureRM.Consumption/Get-AzureRmConsumptionReservationDetail.md delete mode 100644 azurermps-6.13.0/AzureRM.Consumption/Get-AzureRmConsumptionReservationSummary.md delete mode 100644 azurermps-6.13.0/AzureRM.Consumption/Get-AzureRmConsumptionUsageDetail.md delete mode 100644 azurermps-6.13.0/AzureRM.Consumption/New-AzureRmConsumptionBudget.md delete mode 100644 azurermps-6.13.0/AzureRM.Consumption/Remove-AzureRmConsumptionBudget.md delete mode 100644 azurermps-6.13.0/AzureRM.Consumption/Set-AzureRmConsumptionBudget.md delete mode 100644 azurermps-6.13.0/AzureRM.ContainerInstance/AzureRM.ContainerInstance.md delete mode 100644 azurermps-6.13.0/AzureRM.ContainerInstance/Get-AzureRmContainerGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.ContainerInstance/Get-AzureRmContainerInstanceLog.md delete mode 100644 azurermps-6.13.0/AzureRM.ContainerInstance/New-AzureRmContainerGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.ContainerInstance/Remove-AzureRmContainerGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.ContainerRegistry/AzureRM.ContainerRegistry.md delete mode 100644 azurermps-6.13.0/AzureRM.ContainerRegistry/Get-AzureRmContainerRegistry.md delete mode 100644 azurermps-6.13.0/AzureRM.ContainerRegistry/Get-AzureRmContainerRegistryCredential.md delete mode 100644 azurermps-6.13.0/AzureRM.ContainerRegistry/Get-AzureRmContainerRegistryReplication.md delete mode 100644 azurermps-6.13.0/AzureRM.ContainerRegistry/Get-AzureRmContainerRegistryWebhook.md delete mode 100644 azurermps-6.13.0/AzureRM.ContainerRegistry/Get-AzureRmContainerRegistryWebhookEvent.md delete mode 100644 azurermps-6.13.0/AzureRM.ContainerRegistry/New-AzureRmContainerRegistry.md delete mode 100644 azurermps-6.13.0/AzureRM.ContainerRegistry/New-AzureRmContainerRegistryReplication.md delete mode 100644 azurermps-6.13.0/AzureRM.ContainerRegistry/New-AzureRmContainerRegistryWebhook.md delete mode 100644 azurermps-6.13.0/AzureRM.ContainerRegistry/Remove-AzureRmContainerRegistry.md delete mode 100644 azurermps-6.13.0/AzureRM.ContainerRegistry/Remove-AzureRmContainerRegistryReplication.md delete mode 100644 azurermps-6.13.0/AzureRM.ContainerRegistry/Remove-AzureRmContainerRegistryWebhook.md delete mode 100644 azurermps-6.13.0/AzureRM.ContainerRegistry/Test-AzureRmContainerRegistryNameAvailability.md delete mode 100644 azurermps-6.13.0/AzureRM.ContainerRegistry/Test-AzureRmContainerRegistryWebhook.md delete mode 100644 azurermps-6.13.0/AzureRM.ContainerRegistry/Update-AzureRmContainerRegistry.md delete mode 100644 azurermps-6.13.0/AzureRM.ContainerRegistry/Update-AzureRmContainerRegistryCredential.md delete mode 100644 azurermps-6.13.0/AzureRM.ContainerRegistry/Update-AzureRmContainerRegistryWebhook.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactories/AzureRM.DataFactories.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactory.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactoryActivityWindow.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactoryDataset.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactoryGateway.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactoryGatewayAuthKey.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactoryHub.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactoryLinkedService.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactoryPipeline.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactoryRun.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactorySlice.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactory.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactoryDataset.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactoryEncryptValue.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactoryGateway.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactoryGatewayAuthKey.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactoryGatewayKey.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactoryHub.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactoryLinkedService.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactoryPipeline.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactories/Remove-AzureRmDataFactory.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactories/Remove-AzureRmDataFactoryDataset.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactories/Remove-AzureRmDataFactoryGateway.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactories/Remove-AzureRmDataFactoryHub.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactories/Remove-AzureRmDataFactoryLinkedService.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactories/Remove-AzureRmDataFactoryPipeline.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactories/Resume-AzureRmDataFactoryPipeline.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactories/Save-AzureRmDataFactoryLog.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactories/Set-AzureRmDataFactoryGateway.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactories/Set-AzureRmDataFactoryPipelineActivePeriod.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactories/Set-AzureRmDataFactorySliceStatus.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactories/Suspend-AzureRmDataFactoryPipeline.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/AzureRM.DataFactoryV2.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2ActivityRun.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2Dataset.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2IntegrationRuntime.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2IntegrationRuntimeKey.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2IntegrationRuntimeMetric.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2IntegrationRuntimeNode.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2LinkedService.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2Pipeline.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2PipelineRun.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2Trigger.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2TriggerRun.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Invoke-AzureRmDataFactoryV2IntegrationRuntimeUpgrade.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Invoke-AzureRmDataFactoryV2Pipeline.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/New-AzureRmDataFactoryV2IntegrationRuntimeKey.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/New-AzureRmDataFactoryV2LinkedServiceEncryptedCredential.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Remove-AzureRmDataFactoryV2.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Remove-AzureRmDataFactoryV2Dataset.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Remove-AzureRmDataFactoryV2IntegrationRuntime.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Remove-AzureRmDataFactoryV2IntegrationRuntimeNode.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Remove-AzureRmDataFactoryV2LinkedService.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Remove-AzureRmDataFactoryV2Pipeline.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Remove-AzureRmDataFactoryV2Trigger.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Set-AzureRmDataFactoryV2.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Set-AzureRmDataFactoryV2Dataset.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Set-AzureRmDataFactoryV2IntegrationRuntime.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Set-AzureRmDataFactoryV2LinkedService.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Set-AzureRmDataFactoryV2Pipeline.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Set-AzureRmDataFactoryV2Trigger.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Start-AzureRmDataFactoryV2IntegrationRuntime.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Start-AzureRmDataFactoryV2Trigger.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Stop-AzureRmDataFactoryV2IntegrationRuntime.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Stop-AzureRmDataFactoryV2PipelineRun.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Stop-AzureRmDataFactoryV2Trigger.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Sync-AzureRmDataFactoryV2IntegrationRuntimeCredential.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Update-AzureRmDataFactoryV2.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Update-AzureRmDataFactoryV2IntegrationRuntime.md delete mode 100644 azurermps-6.13.0/AzureRM.DataFactoryV2/Update-AzureRmDataFactoryV2IntegrationRuntimeNode.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/Add-AzureRmDataLakeAnalyticsDataSource.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/Add-AzureRmDataLakeAnalyticsFirewallRule.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/AzureRM.DataLakeAnalytics.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsCatalogItem.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsCatalogItemAclEntry.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsComputePolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsDataSource.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsFirewallRule.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsJob.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsJobPipeline.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsJobRecurrence.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/New-AzureRmDataLakeAnalyticsAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/New-AzureRmDataLakeAnalyticsCatalogCredential.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/New-AzureRmDataLakeAnalyticsCatalogSecret.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/New-AzureRmDataLakeAnalyticsComputePolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/Remove-AzureRmDataLakeAnalyticsAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/Remove-AzureRmDataLakeAnalyticsCatalogCredential.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/Remove-AzureRmDataLakeAnalyticsCatalogItemAclEntry.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/Remove-AzureRmDataLakeAnalyticsCatalogSecret.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/Remove-AzureRmDataLakeAnalyticsComputePolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/Remove-AzureRmDataLakeAnalyticsDataSource.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/Remove-AzureRmDataLakeAnalyticsFirewallRule.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/Set-AzureRmDataLakeAnalyticsAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/Set-AzureRmDataLakeAnalyticsCatalogCredential.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/Set-AzureRmDataLakeAnalyticsCatalogSecret.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/Set-AzureRmDataLakeAnalyticsDataSource.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/Set-AzureRmDataLakeAnalyticsFirewallRule.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/Stop-AzureRmDataLakeAnalyticsJob.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/Submit-AzureRmDataLakeAnalyticsJob.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/Test-AzureRmDataLakeAnalyticsAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/Test-AzureRmDataLakeAnalyticsCatalogItem.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/Update-AzureRmDataLakeAnalyticsComputePolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeAnalytics/Wait-AzureRmDataLakeAnalyticsJob.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Add-AzureRmDataLakeStoreFirewallRule.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Add-AzureRmDataLakeStoreItemContent.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Add-AzureRmDataLakeStoreTrustedIdProvider.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Add-AzureRmDataLakeStoreVirtualNetworkRule.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/AzureRM.DataLakeStore.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Enable-AzureRmDataLakeStoreKeyVault.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Export-AzureRmDataLakeStoreChildItemProperties.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Export-AzureRmDataLakeStoreItem.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreChildItem.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreChildItemSummary.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreFirewallRule.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreItem.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreItemAclEntry.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreItemContent.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreItemOwner.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreItemPermission.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreTrustedIdProvider.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreVirtualNetworkRule.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Import-AzureRmDataLakeStoreItem.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Join-AzureRmDataLakeStoreItem.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Move-AzureRmDataLakeStoreItem.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/New-AzureRmDataLakeStoreAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/New-AzureRmDataLakeStoreItem.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Remove-AzureRmDataLakeStoreAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Remove-AzureRmDataLakeStoreFirewallRule.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Remove-AzureRmDataLakeStoreItem.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Remove-AzureRmDataLakeStoreItemAcl.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Remove-AzureRmDataLakeStoreItemAclEntry.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Remove-AzureRmDataLakeStoreTrustedIdProvider.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Remove-AzureRmDataLakeStoreVirtualNetworkRule.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreFirewallRule.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreItemAcl.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreItemAclEntry.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreItemExpiry.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreItemOwner.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreItemPermission.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreTrustedIdProvider.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreVirtualNetworkRule.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Test-AzureRmDataLakeStoreAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.DataLakeStore/Test-AzureRmDataLakeStoreItem.md delete mode 100644 azurermps-6.13.0/AzureRM.DataMigration/AzureRM.DataMigration.md delete mode 100644 azurermps-6.13.0/AzureRM.DataMigration/Get-AzureRmDataMigrationProject.md delete mode 100644 azurermps-6.13.0/AzureRM.DataMigration/Get-AzureRmDataMigrationService.md delete mode 100644 azurermps-6.13.0/AzureRM.DataMigration/Get-AzureRmDataMigrationTask.md delete mode 100644 azurermps-6.13.0/AzureRM.DataMigration/Invoke-AzureRmDataMigrationCommand.md delete mode 100644 azurermps-6.13.0/AzureRM.DataMigration/New-AzureRmDataMigrationConnectionInfo.md delete mode 100644 azurermps-6.13.0/AzureRM.DataMigration/New-AzureRmDataMigrationDatabaseInfo.md delete mode 100644 azurermps-6.13.0/AzureRM.DataMigration/New-AzureRmDataMigrationFileShare.md delete mode 100644 azurermps-6.13.0/AzureRM.DataMigration/New-AzureRmDataMigrationProject.md delete mode 100644 azurermps-6.13.0/AzureRM.DataMigration/New-AzureRmDataMigrationSelectedDBObject.md delete mode 100644 azurermps-6.13.0/AzureRM.DataMigration/New-AzureRmDataMigrationService.md delete mode 100644 azurermps-6.13.0/AzureRM.DataMigration/New-AzureRmDataMigrationSyncSelectedDBObject.md delete mode 100644 azurermps-6.13.0/AzureRM.DataMigration/New-AzureRmDataMigrationTask.md delete mode 100644 azurermps-6.13.0/AzureRM.DataMigration/Remove-AzureRmDataMigrationProject.md delete mode 100644 azurermps-6.13.0/AzureRM.DataMigration/Remove-AzureRmDataMigrationService.md delete mode 100644 azurermps-6.13.0/AzureRM.DataMigration/Remove-AzureRmDataMigrationTask.md delete mode 100644 azurermps-6.13.0/AzureRM.DataMigration/Start-AzureRmDataMigrationService.md delete mode 100644 azurermps-6.13.0/AzureRM.DataMigration/Stop-AzureRmDataMigrationService.md delete mode 100644 azurermps-6.13.0/AzureRM.DataMigration/Stop-AzureRmDataMigrationTask.md delete mode 100644 azurermps-6.13.0/AzureRM.DevSpaces/AzureRM.DevSpaces.md delete mode 100644 azurermps-6.13.0/AzureRM.DevSpaces/Get-AzureRmDevSpacesController.md delete mode 100644 azurermps-6.13.0/AzureRM.DevSpaces/New-AzureRmDevSpacesController.md delete mode 100644 azurermps-6.13.0/AzureRM.DevSpaces/Remove-AzureRmDevSpacesController.md delete mode 100644 azurermps-6.13.0/AzureRM.DevSpaces/Update-AzureRmDevSpacesController.md delete mode 100644 azurermps-6.13.0/AzureRM.DevTestLabs/AzureRM.DevTestLabs.md delete mode 100644 azurermps-6.13.0/AzureRM.DevTestLabs/Get-AzureRmDtlAllowedVMSizesPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.DevTestLabs/Get-AzureRmDtlAutoShutdownPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.DevTestLabs/Get-AzureRmDtlAutoStartPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.DevTestLabs/Get-AzureRmDtlVMsPerLabPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.DevTestLabs/Get-AzureRmDtlVMsPerUserPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.DevTestLabs/Set-AzureRmDtlAllowedVMSizesPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.DevTestLabs/Set-AzureRmDtlAutoShutdownPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.DevTestLabs/Set-AzureRmDtlAutoStartPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.DevTestLabs/Set-AzureRmDtlVMsPerLabPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.DevTestLabs/Set-AzureRmDtlVMsPerUserPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Add-AzureRmIoTDeviceProvisioningServiceAccessPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Add-AzureRmIoTDeviceProvisioningServiceCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Add-AzureRmIoTDeviceProvisioningServiceLinkedHub.md delete mode 100644 azurermps-6.13.0/AzureRM.DeviceProvisioningServices/AzureRM.DeviceProvisioningServices.md delete mode 100644 azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Get-AzureRmIoTDeviceProvisioningService.md delete mode 100644 azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Get-AzureRmIoTDeviceProvisioningServiceAccessPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Get-AzureRmIoTDeviceProvisioningServiceCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Get-AzureRmIoTDeviceProvisioningServiceLinkedHub.md delete mode 100644 azurermps-6.13.0/AzureRM.DeviceProvisioningServices/New-AzureRmIoTDeviceProvisioningService.md delete mode 100644 azurermps-6.13.0/AzureRM.DeviceProvisioningServices/New-AzureRmIoTDeviceProvisioningServiceCertificateVerificationCode.md delete mode 100644 azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Remove-AzureRmIoTDeviceProvisioningService.md delete mode 100644 azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Remove-AzureRmIoTDeviceProvisioningServiceAccessPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Remove-AzureRmIoTDeviceProvisioningServiceCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Remove-AzureRmIoTDeviceProvisioningServiceLinkedHub.md delete mode 100644 azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Set-AzureRmIoTDeviceProvisioningServiceCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Update-AzureRmIoTDeviceProvisioningService.md delete mode 100644 azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Update-AzureRmIoTDeviceProvisioningServiceAccessPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Update-AzureRmIoTDeviceProvisioningServiceLinkedHub.md delete mode 100644 azurermps-6.13.0/AzureRM.Dns/Add-AzureRmDnsRecordConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Dns/AzureRM.DNS.md delete mode 100644 azurermps-6.13.0/AzureRM.Dns/Get-AzureRmDnsRecordSet.md delete mode 100644 azurermps-6.13.0/AzureRM.Dns/Get-AzureRmDnsZone.md delete mode 100644 azurermps-6.13.0/AzureRM.Dns/New-AzureRmDnsRecordConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Dns/New-AzureRmDnsRecordSet.md delete mode 100644 azurermps-6.13.0/AzureRM.Dns/New-AzureRmDnsZone.md delete mode 100644 azurermps-6.13.0/AzureRM.Dns/Remove-AzureRmDnsRecordConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Dns/Remove-AzureRmDnsRecordSet.md delete mode 100644 azurermps-6.13.0/AzureRM.Dns/Remove-AzureRmDnsZone.md delete mode 100644 azurermps-6.13.0/AzureRM.Dns/Set-AzureRmDnsRecordSet.md delete mode 100644 azurermps-6.13.0/AzureRM.Dns/Set-AzureRmDnsZone.md delete mode 100644 azurermps-6.13.0/AzureRM.EventGrid/AzureRM.EventGrid.md delete mode 100644 azurermps-6.13.0/AzureRM.EventGrid/Get-AzureRmEventGridSubscription.md delete mode 100644 azurermps-6.13.0/AzureRM.EventGrid/Get-AzureRmEventGridTopic.md delete mode 100644 azurermps-6.13.0/AzureRM.EventGrid/Get-AzureRmEventGridTopicKey.md delete mode 100644 azurermps-6.13.0/AzureRM.EventGrid/Get-AzureRmEventGridTopicType.md delete mode 100644 azurermps-6.13.0/AzureRM.EventGrid/New-AzureRmEventGridSubscription.md delete mode 100644 azurermps-6.13.0/AzureRM.EventGrid/New-AzureRmEventGridTopic.md delete mode 100644 azurermps-6.13.0/AzureRM.EventGrid/New-AzureRmEventGridTopicKey.md delete mode 100644 azurermps-6.13.0/AzureRM.EventGrid/Remove-AzureRmEventGridSubscription.md delete mode 100644 azurermps-6.13.0/AzureRM.EventGrid/Remove-AzureRmEventGridTopic.md delete mode 100644 azurermps-6.13.0/AzureRM.EventGrid/Set-AzureRmEventGridTopic.md delete mode 100644 azurermps-6.13.0/AzureRM.EventGrid/Update-AzureRmEventGridSubscription.md delete mode 100644 azurermps-6.13.0/AzureRM.EventHub/AzureRM.EventHub.md delete mode 100644 azurermps-6.13.0/AzureRM.EventHub/Get-AzureRmEventHub.md delete mode 100644 azurermps-6.13.0/AzureRM.EventHub/Get-AzureRmEventHubAuthorizationRule.md delete mode 100644 azurermps-6.13.0/AzureRM.EventHub/Get-AzureRmEventHubConsumerGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.EventHub/Get-AzureRmEventHubGeoDRConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.EventHub/Get-AzureRmEventHubKey.md delete mode 100644 azurermps-6.13.0/AzureRM.EventHub/Get-AzureRmEventHubNamespace.md delete mode 100644 azurermps-6.13.0/AzureRM.EventHub/New-AzureRmEventHub.md delete mode 100644 azurermps-6.13.0/AzureRM.EventHub/New-AzureRmEventHubAuthorizationRule.md delete mode 100644 azurermps-6.13.0/AzureRM.EventHub/New-AzureRmEventHubConsumerGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.EventHub/New-AzureRmEventHubGeoDRConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.EventHub/New-AzureRmEventHubKey.md delete mode 100644 azurermps-6.13.0/AzureRM.EventHub/New-AzureRmEventHubNamespace.md delete mode 100644 azurermps-6.13.0/AzureRM.EventHub/Remove-AzureRmEventHub.md delete mode 100644 azurermps-6.13.0/AzureRM.EventHub/Remove-AzureRmEventHubAuthorizationRule.md delete mode 100644 azurermps-6.13.0/AzureRM.EventHub/Remove-AzureRmEventHubConsumerGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.EventHub/Remove-AzureRmEventHubGeoDRConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.EventHub/Remove-AzureRmEventHubNamespace.md delete mode 100644 azurermps-6.13.0/AzureRM.EventHub/Set-AzureRmEventHub.md delete mode 100644 azurermps-6.13.0/AzureRM.EventHub/Set-AzureRmEventHubAuthorizationRule.md delete mode 100644 azurermps-6.13.0/AzureRM.EventHub/Set-AzureRmEventHubConsumerGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.EventHub/Set-AzureRmEventHubGeoDRConfigurationBreakPair.md delete mode 100644 azurermps-6.13.0/AzureRM.EventHub/Set-AzureRmEventHubGeoDRConfigurationFailOver.md delete mode 100644 azurermps-6.13.0/AzureRM.EventHub/Set-AzureRmEventHubNamespace.md delete mode 100644 azurermps-6.13.0/AzureRM.EventHub/Test-AzureRmEventHubName.md delete mode 100644 azurermps-6.13.0/AzureRM.FrontDoor/AzureRM.FrontDoor.md delete mode 100644 azurermps-6.13.0/AzureRM.FrontDoor/Get-AzureRmFrontDoor.md delete mode 100644 azurermps-6.13.0/AzureRM.FrontDoor/Get-AzureRmFrontDoorFireWallPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoor.md delete mode 100644 azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorBackendObject.md delete mode 100644 azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorBackendPoolObject.md delete mode 100644 azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorCustomRuleObject.md delete mode 100644 azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorFireWallPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorFrontendEndpointObject.md delete mode 100644 azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorHealthProbeSettingObject.md delete mode 100644 azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorLoadBalancingSettingObject.md delete mode 100644 azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorManagedRuleObject.md delete mode 100644 azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorMatchConditionObject.md delete mode 100644 azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorRoutingRuleObject.md delete mode 100644 azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorRuleGroupOverrideObject.md delete mode 100644 azurermps-6.13.0/AzureRM.FrontDoor/Remove-AzureRmFrontDoor.md delete mode 100644 azurermps-6.13.0/AzureRM.FrontDoor/Remove-AzureRmFrontDoorContent.md delete mode 100644 azurermps-6.13.0/AzureRM.FrontDoor/Remove-AzureRmFrontDoorFireWallPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.FrontDoor/Set-AzureRmFrontDoor.md delete mode 100644 azurermps-6.13.0/AzureRM.FrontDoor/Set-AzureRmFrontDoorFireWallPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/Add-AzureRmHDInsightClusterIdentity.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/Add-AzureRmHDInsightComponentVersion.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/Add-AzureRmHDInsightConfigValues.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/Add-AzureRmHDInsightMetastore.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/Add-AzureRmHDInsightScriptAction.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/Add-AzureRmHDInsightSecurityProfile.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/Add-AzureRmHDInsightStorage.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/AzureRM.HDInsight.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/Disable-AzureRmHDInsightOperationsManagementSuite.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/Enable-AzureRmHDInsightOperationsManagementSuite.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/Get-AzureRmHDInsightCluster.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/Get-AzureRmHDInsightJob.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/Get-AzureRmHDInsightJobOutput.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/Get-AzureRmHDInsightOperationsManagementSuite.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/Get-AzureRmHDInsightPersistedScriptAction.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/Get-AzureRmHDInsightProperties.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/Get-AzureRmHDInsightScriptActionHistory.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/Grant-AzureRmHDInsightHttpServicesAccess.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/Grant-AzureRmHDInsightRdpServicesAccess.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/Invoke-AzureRmHDInsightHiveJob.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/New-AzureRmHDInsightCluster.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/New-AzureRmHDInsightClusterConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/New-AzureRmHDInsightHiveJobDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/New-AzureRmHDInsightMapReduceJobDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/New-AzureRmHDInsightPigJobDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/New-AzureRmHDInsightSqoopJobDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/New-AzureRmHDInsightStreamingMapReduceJobDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/Remove-AzureRmHDInsightCluster.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/Remove-AzureRmHDInsightPersistedScriptAction.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/Revoke-AzureRmHDInsightHttpServicesAccess.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/Revoke-AzureRmHDInsightRdpServicesAccess.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/Set-AzureRmHDInsightClusterSize.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/Set-AzureRmHDInsightDefaultStorage.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/Set-AzureRmHDInsightPersistedScriptAction.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/Start-AzureRmHDInsightJob.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/Stop-AzureRmHDInsightJob.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/Submit-AzureRmHDInsightScriptAction.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/Use-AzureRmHDInsightCluster.md delete mode 100644 azurermps-6.13.0/AzureRM.HDInsight/Wait-AzureRmHDInsightJob.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/Add-AzureRmAutoscaleSetting.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/Add-AzureRmLogProfile.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/Add-AzureRmMetricAlertRule.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/Add-AzureRmWebtestAlertRule.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/AzureRM.Insights.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/Disable-AzureRmActivityLogAlert.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/Enable-AzureRmActivityLogAlert.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/Get-AzureRmActionGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/Get-AzureRmActivityLogAlert.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/Get-AzureRmAlertHistory.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/Get-AzureRmAlertRule.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/Get-AzureRmAutoscaleHistory.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/Get-AzureRmAutoscaleSetting.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/Get-AzureRmDiagnosticSetting.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/Get-AzureRmLog.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/Get-AzureRmLogProfile.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/Get-AzureRmMetric.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/Get-AzureRmMetricDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/New-AzureRmActionGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/New-AzureRmActionGroupReceiver.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/New-AzureRmActivityLogAlertCondition.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/New-AzureRmAlertRuleEmail.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/New-AzureRmAlertRuleWebhook.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/New-AzureRmAutoscaleNotification.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/New-AzureRmAutoscaleProfile.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/New-AzureRmAutoscaleRule.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/New-AzureRmAutoscaleWebhook.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/New-AzureRmMetricFilter.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/Remove-AzureRmActionGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/Remove-AzureRmActivityLogAlert.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/Remove-AzureRmAlertRule.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/Remove-AzureRmAutoscaleSetting.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/Remove-AzureRmDiagnosticSetting.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/Remove-AzureRmLogProfile.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/Set-AzureRmActionGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/Set-AzureRmActivityLogAlert.md delete mode 100644 azurermps-6.13.0/AzureRM.Insights/Set-AzureRmDiagnosticSetting.md delete mode 100644 azurermps-6.13.0/AzureRM.IotCentral/AzureRM.IotCentral.md delete mode 100644 azurermps-6.13.0/AzureRM.IotCentral/Get-AzureRmIotCentralApp.md delete mode 100644 azurermps-6.13.0/AzureRM.IotCentral/New-AzureRmIotCentralApp.md delete mode 100644 azurermps-6.13.0/AzureRM.IotCentral/Remove-AzureRmIotCentralApp.md delete mode 100644 azurermps-6.13.0/AzureRM.IotCentral/Set-AzureRmIotCentralApp.md delete mode 100644 azurermps-6.13.0/AzureRM.IotHub/Add-AzureRmIotHubCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.IotHub/Add-AzureRmIotHubEventHubConsumerGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.IotHub/Add-AzureRmIotHubKey.md delete mode 100644 azurermps-6.13.0/AzureRM.IotHub/Add-AzureRmIotHubRoute.md delete mode 100644 azurermps-6.13.0/AzureRM.IotHub/Add-AzureRmIotHubRoutingEndpoint.md delete mode 100644 azurermps-6.13.0/AzureRM.IotHub/AzureRM.IotHub.md delete mode 100644 azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHub.md delete mode 100644 azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubCertificateVerificationCode.md delete mode 100644 azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubConnectionString.md delete mode 100644 azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubEventHubConsumerGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubJob.md delete mode 100644 azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubKey.md delete mode 100644 azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubQuotaMetric.md delete mode 100644 azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubRegistryStatistic.md delete mode 100644 azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubRoute.md delete mode 100644 azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubRoutingEndpoint.md delete mode 100644 azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubValidSku.md delete mode 100644 azurermps-6.13.0/AzureRM.IotHub/New-AzureRmIotHub.md delete mode 100644 azurermps-6.13.0/AzureRM.IotHub/New-AzureRmIotHubExportDevices.md delete mode 100644 azurermps-6.13.0/AzureRM.IotHub/New-AzureRmIotHubImportDevices.md delete mode 100644 azurermps-6.13.0/AzureRM.IotHub/Remove-AzureRmIotHub.md delete mode 100644 azurermps-6.13.0/AzureRM.IotHub/Remove-AzureRmIotHubCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.IotHub/Remove-AzureRmIotHubEventHubConsumerGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.IotHub/Remove-AzureRmIotHubKey.md delete mode 100644 azurermps-6.13.0/AzureRM.IotHub/Remove-AzureRmIotHubRoute.md delete mode 100644 azurermps-6.13.0/AzureRM.IotHub/Remove-AzureRmIotHubRoutingEndpoint.md delete mode 100644 azurermps-6.13.0/AzureRM.IotHub/Set-AzureRmIotHub.md delete mode 100644 azurermps-6.13.0/AzureRM.IotHub/Set-AzureRmIotHubRoute.md delete mode 100644 azurermps-6.13.0/AzureRM.IotHub/Set-AzureRmIotHubVerifiedCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.IotHub/Test-AzureRmIotHubRoute.md delete mode 100644 azurermps-6.13.0/AzureRM.IotHub/Update-AzureRmIotHub.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Add-AzureKeyVaultCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Add-AzureKeyVaultCertificateContact.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Add-AzureKeyVaultKey.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Add-AzureKeyVaultManagedStorageAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Add-AzureRmKeyVaultNetworkRule.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/AzureRM.KeyVault.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Backup-AzureKeyVaultCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Backup-AzureKeyVaultKey.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Backup-AzureKeyVaultManagedStorageAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Backup-AzureKeyVaultSecret.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultCertificateContact.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultCertificateIssuer.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultCertificateOperation.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultCertificatePolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultKey.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultManagedStorageAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultManagedStorageSasDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultSecret.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Get-AzureRmKeyVault.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Import-AzureKeyVaultCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/New-AzureKeyVaultCertificateAdministratorDetails.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/New-AzureKeyVaultCertificateOrganizationDetails.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/New-AzureKeyVaultCertificatePolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/New-AzureRmKeyVault.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureKeyVaultCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureKeyVaultCertificateContact.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureKeyVaultCertificateIssuer.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureKeyVaultCertificateOperation.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureKeyVaultKey.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureKeyVaultManagedStorageAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureKeyVaultManagedStorageSasDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureKeyVaultSecret.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureRmKeyVault.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureRmKeyVaultAccessPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureRmKeyVaultNetworkRule.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Restore-AzureKeyVaultCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Restore-AzureKeyVaultKey.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Restore-AzureKeyVaultManagedStorageAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Restore-AzureKeyVaultSecret.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Set-AzureKeyVaultCertificateIssuer.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Set-AzureKeyVaultCertificatePolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Set-AzureKeyVaultManagedStorageSasDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Set-AzureKeyVaultSecret.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Set-AzureRmKeyVaultAccessPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Stop-AzureKeyVaultCertificateOperation.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Undo-AzureKeyVaultCertificateRemoval.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Undo-AzureKeyVaultKeyRemoval.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Undo-AzureKeyVaultManagedStorageAccountRemoval.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Undo-AzureKeyVaultManagedStorageSasDefinitionRemoval.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Undo-AzureKeyVaultSecretRemoval.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Undo-AzureRmKeyVaultRemoval.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Update-AzureKeyVaultCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Update-AzureKeyVaultKey.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Update-AzureKeyVaultManagedStorageAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Update-AzureKeyVaultManagedStorageAccountKey.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Update-AzureKeyVaultSecret.md delete mode 100644 azurermps-6.13.0/AzureRM.KeyVault/Update-AzureRmKeyVaultNetworkRuleSet.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/AzureRM.LogicApp.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccountAgreement.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccountCallbackUrl.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccountCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccountGeneratedIcn.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccountMap.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccountPartner.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccountReceivedIcn.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccountSchema.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmLogicApp.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmLogicAppRunAction.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmLogicAppRunHistory.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmLogicAppTrigger.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmLogicAppTriggerCallbackUrl.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmLogicAppTriggerHistory.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmLogicAppUpgradedDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/New-AzureRmIntegrationAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/New-AzureRmIntegrationAccountAgreement.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/New-AzureRmIntegrationAccountCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/New-AzureRmIntegrationAccountMap.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/New-AzureRmIntegrationAccountPartner.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/New-AzureRmIntegrationAccountSchema.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/New-AzureRmLogicApp.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Remove-AzureRmIntegrationAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Remove-AzureRmIntegrationAccountAgreement.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Remove-AzureRmIntegrationAccountCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Remove-AzureRmIntegrationAccountMap.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Remove-AzureRmIntegrationAccountPartner.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Remove-AzureRmIntegrationAccountReceivedIcn.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Remove-AzureRmIntegrationAccountSchema.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Remove-AzureRmLogicApp.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmIntegrationAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmIntegrationAccountAgreement.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmIntegrationAccountCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmIntegrationAccountGeneratedIcn.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmIntegrationAccountMap.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmIntegrationAccountPartner.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmIntegrationAccountReceivedIcn.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmIntegrationAccountSchema.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmLogicApp.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Start-AzureRmLogicApp.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Stop-AzureRmLogicAppRun.md delete mode 100644 azurermps-6.13.0/AzureRM.LogicApp/Test-AzureRmLogicApp.md delete mode 100644 azurermps-6.13.0/AzureRM.MachineLearning/Add-AzureRmMlWebServiceRegionalProperty.md delete mode 100644 azurermps-6.13.0/AzureRM.MachineLearning/AzureRM.MachineLearning.md delete mode 100644 azurermps-6.13.0/AzureRM.MachineLearning/Export-AzureRmMlWebService.md delete mode 100644 azurermps-6.13.0/AzureRM.MachineLearning/Get-AzureRmMlCommitmentAssociation.md delete mode 100644 azurermps-6.13.0/AzureRM.MachineLearning/Get-AzureRmMlCommitmentPlan.md delete mode 100644 azurermps-6.13.0/AzureRM.MachineLearning/Get-AzureRmMlCommitmentPlanUsageHistory.md delete mode 100644 azurermps-6.13.0/AzureRM.MachineLearning/Get-AzureRmMlWebService.md delete mode 100644 azurermps-6.13.0/AzureRM.MachineLearning/Get-AzureRmMlWebServiceKeys.md delete mode 100644 azurermps-6.13.0/AzureRM.MachineLearning/Import-AzureRmMlWebService.md delete mode 100644 azurermps-6.13.0/AzureRM.MachineLearning/Move-AzureRmMlCommitmentAssociation.md delete mode 100644 azurermps-6.13.0/AzureRM.MachineLearning/New-AzureRmMlCommitmentPlan.md delete mode 100644 azurermps-6.13.0/AzureRM.MachineLearning/New-AzureRmMlWebService.md delete mode 100644 azurermps-6.13.0/AzureRM.MachineLearning/Remove-AzureRmMlCommitmentPlan.md delete mode 100644 azurermps-6.13.0/AzureRM.MachineLearning/Remove-AzureRmMlWebService.md delete mode 100644 azurermps-6.13.0/AzureRM.MachineLearning/Update-AzureRmMlCommitmentPlan.md delete mode 100644 azurermps-6.13.0/AzureRM.MachineLearning/Update-AzureRmMlWebService.md delete mode 100644 azurermps-6.13.0/AzureRM.MachineLearningCompute/AzureRM.MachineLearningCompute.md delete mode 100644 azurermps-6.13.0/AzureRM.MachineLearningCompute/Get-AzureRmMlOpCluster.md delete mode 100644 azurermps-6.13.0/AzureRM.MachineLearningCompute/Get-AzureRmMlOpClusterKey.md delete mode 100644 azurermps-6.13.0/AzureRM.MachineLearningCompute/New-AzureRmMlOpCluster.md delete mode 100644 azurermps-6.13.0/AzureRM.MachineLearningCompute/Remove-AzureRmMlOpCluster.md delete mode 100644 azurermps-6.13.0/AzureRM.MachineLearningCompute/Set-AzureRmMlOpCluster.md delete mode 100644 azurermps-6.13.0/AzureRM.MachineLearningCompute/Test-AzureRmMlOpClusterSystemServicesUpdateAvailability.md delete mode 100644 azurermps-6.13.0/AzureRM.MachineLearningCompute/Update-AzureRmMlOpClusterSystemService.md delete mode 100644 azurermps-6.13.0/AzureRM.ManagedServiceIdentity/AzureRM.ManagedServiceIdentity.md delete mode 100644 azurermps-6.13.0/AzureRM.ManagedServiceIdentity/Get-AzureRmUserAssignedIdentity.md delete mode 100644 azurermps-6.13.0/AzureRM.ManagedServiceIdentity/New-AzureRmUserAssignedIdentity.md delete mode 100644 azurermps-6.13.0/AzureRM.ManagedServiceIdentity/Remove-AzureRmUserAssignedIdentity.md delete mode 100644 azurermps-6.13.0/AzureRM.ManagementPartner/AzureRM.ManagementPartner.md delete mode 100644 azurermps-6.13.0/AzureRM.ManagementPartner/Get-AzureRmManagementPartner.md delete mode 100644 azurermps-6.13.0/AzureRM.ManagementPartner/New-AzureRmManagementPartner.md delete mode 100644 azurermps-6.13.0/AzureRM.ManagementPartner/Remove-AzureRmManagementPartner.md delete mode 100644 azurermps-6.13.0/AzureRM.ManagementPartner/Update-AzureRmManagementPartner.md delete mode 100644 azurermps-6.13.0/AzureRM.Maps/AzureRM.Maps.md delete mode 100644 azurermps-6.13.0/AzureRM.Maps/Get-AzureRmMapsAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.Maps/Get-AzureRmMapsAccountKey.md delete mode 100644 azurermps-6.13.0/AzureRM.Maps/New-AzureRmMapsAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.Maps/New-AzureRmMapsAccountKey.md delete mode 100644 azurermps-6.13.0/AzureRM.Maps/Remove-AzureRmMapsAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.MarketplaceOrdering/AzureRM.MarketplaceOrdering.md delete mode 100644 azurermps-6.13.0/AzureRM.MarketplaceOrdering/Get-AzureRmMarketplaceTerms.md delete mode 100644 azurermps-6.13.0/AzureRM.MarketplaceOrdering/Set-AzureRmMarketplaceTerms.md delete mode 100644 azurermps-6.13.0/AzureRM.Media/AzureRM.Media.md delete mode 100644 azurermps-6.13.0/AzureRM.Media/Get-AzureRmMediaService.md delete mode 100644 azurermps-6.13.0/AzureRM.Media/Get-AzureRmMediaServiceKeys.md delete mode 100644 azurermps-6.13.0/AzureRM.Media/Get-AzureRmMediaServiceNameAvailability.md delete mode 100644 azurermps-6.13.0/AzureRM.Media/New-AzureRmMediaService.md delete mode 100644 azurermps-6.13.0/AzureRM.Media/New-AzureRmMediaServiceStorageConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Media/Remove-AzureRmMediaService.md delete mode 100644 azurermps-6.13.0/AzureRM.Media/Set-AzureRmMediaService.md delete mode 100644 azurermps-6.13.0/AzureRM.Media/Set-AzureRmMediaServiceKey.md delete mode 100644 azurermps-6.13.0/AzureRM.Media/Sync-AzureRmMediaServiceStorageKeys.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayAuthenticationCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayBackendAddressPool.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayBackendHttpSettings.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayCustomError.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayFrontendIPConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayFrontendPort.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayHttpListener.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayHttpListenerCustomError.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayIPConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayProbeConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayRedirectConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayRequestRoutingRule.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewaySslCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayTrustedRootCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayUrlPathMapConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmDelegation.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmExpressRouteCircuitAuthorization.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmExpressRouteCircuitConnectionConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmExpressRouteCircuitPeeringConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmLoadBalancerBackendAddressPoolConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmLoadBalancerFrontendIpConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmLoadBalancerInboundNatPoolConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmLoadBalancerInboundNatRuleConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmLoadBalancerOutboundRuleConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmLoadBalancerProbeConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmLoadBalancerRuleConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmNetworkInterfaceIpConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmNetworkInterfaceTapConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmNetworkSecurityRuleConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmRouteConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmRouteFilterRuleConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmServiceEndpointPolicyDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmVirtualNetworkGatewayIpConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmVirtualNetworkPeering.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmVirtualNetworkSubnetConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmVpnClientRevokedCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Add-AzureRmVpnClientRootCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/AzureRM.Network.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRMNetworkWatcherReachabilityReport.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGateway.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayAuthenticationCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayAutoscaleConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayAvailableSslOptions.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayAvailableWafRuleSets.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayBackendAddressPool.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayBackendHealth.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayBackendHttpSettings.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayConnectionDraining.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayCustomError.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayFrontendIPConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayFrontendPort.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayHttpListener.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayHttpListenerCustomError.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayIPConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayProbeConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayRedirectConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayRequestRoutingRule.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewaySku.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewaySslCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewaySslPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewaySslPredefinedPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayTrustedRootCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayUrlPathMapConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationSecurityGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmAvailableServiceDelegation.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmBgpServiceCommunity.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmDdosProtectionPlan.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmDelegation.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmEffectiveNetworkSecurityGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmEffectiveRouteTable.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteCircuit.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteCircuitARPTable.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteCircuitAuthorization.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteCircuitConnectionConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteCircuitPeeringConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteCircuitRouteTable.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteCircuitRouteTableSummary.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteCircuitStats.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRoutePort.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRoutePortLinkConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRoutePortsLocation.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteServiceProvider.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmFirewall.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmFirewallFqdnTag.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmInterfaceEndpoint.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmLoadBalancer.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmLoadBalancerBackendAddressPoolConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmLoadBalancerFrontendIpConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmLoadBalancerInboundNatPoolConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmLoadBalancerInboundNatRuleConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmLoadBalancerOutboundRuleConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmLoadBalancerProbeConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmLoadBalancerRuleConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmLocalNetworkGateway.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkInterface.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkInterfaceIpConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkInterfaceTapConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkProfile.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkSecurityGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkSecurityRuleConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkUsage.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcher.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherConnectionMonitor.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherConnectionMonitorReport.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherFlowLogStatus.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherNextHop.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherPacketCapture.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherReachabilityProvidersList.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherSecurityGroupView.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherTopology.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherTroubleshootingResult.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmPublicIpAddress.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmPublicIpPrefix.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmRouteConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmRouteFilter.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmRouteFilterRuleConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmRouteTable.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmServiceEndpointPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmServiceEndpointPolicyDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualHub.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualHubVnetConnection.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetwork.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkAvailableEndpointService.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkGateway.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkGatewayAdvertisedRoute.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkGatewayBGPPeerStatus.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkGatewayConnection.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkGatewayConnectionSharedKey.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkGatewayConnectionVpnDeviceConfigScript.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkGatewayLearnedRoute.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkGatewaySupportedVpnDevice.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkPeering.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkSubnetConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkTap.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkUsageList.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualWan.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualWanVpnConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmVpnClientConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmVpnClientIpsecParameter.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmVpnClientPackage.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmVpnClientRevokedCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmVpnClientRootCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmVpnConnection.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmVpnGateway.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Get-AzureRmVpnSite.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Move-AzureRmExpressRouteCircuit.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGateway.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayAuthenticationCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayAutoscaleConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayBackendAddressPool.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayBackendHttpSettings.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayConnectionDraining.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayCustomError.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayFirewallDisabledRuleGroupConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayFirewallExclusionConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayFrontendIPConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayFrontendPort.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayHttpListener.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayIPConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayPathRuleConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayProbeConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayProbeHealthResponseMatch.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayRedirectConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayRequestRoutingRule.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewaySku.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewaySslCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewaySslPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayTrustedRootCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayUrlPathMapConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationSecurityGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmContainerNicConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmContainerNicConfigIpConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmDdosProtectionPlan.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmDelegation.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmExpressRouteCircuit.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmExpressRouteCircuitAuthorization.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmExpressRouteCircuitPeeringConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmExpressRoutePort.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmFirewall.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmFirewallApplicationRule.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmFirewallApplicationRuleCollection.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmFirewallNatRule.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmFirewallNatRuleCollection.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmFirewallNetworkRule.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmFirewallNetworkRuleCollection.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmIpsecPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmLoadBalancer.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmLoadBalancerBackendAddressPoolConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmLoadBalancerFrontendIpConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmLoadBalancerInboundNatPoolConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmLoadBalancerInboundNatRuleConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmLoadBalancerOutboundRuleConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmLoadBalancerProbeConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmLoadBalancerRuleConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmLocalNetworkGateway.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkInterface.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkInterfaceIpConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkProfile.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkSecurityGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkSecurityRuleConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkWatcher.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkWatcherConnectionMonitor.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkWatcherPacketCapture.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkWatcherProtocolConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmPacketCaptureFilterConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmPublicIpAddress.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmPublicIpPrefix.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmPublicIpTag.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmRouteConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmRouteFilter.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmRouteFilterRuleConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmRouteTable.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmServiceEndpointPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmServiceEndpointPolicyDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualHub.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualHubRoute.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualHubRouteTable.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualHubVnetConnection.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualNetwork.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualNetworkGateway.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualNetworkGatewayConnection.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualNetworkGatewayIpConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualNetworkSubnetConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualNetworkTap.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualWan.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmVpnClientConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmVpnClientIpsecParameter.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmVpnClientIpsecPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmVpnClientRevokedCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmVpnClientRootCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmVpnConnection.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmVpnGateway.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/New-AzureRmVpnSite.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGateway.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayAuthenticationCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayAutoscaleConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayBackendAddressPool.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayBackendHttpSettings.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayConnectionDraining.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayCustomError.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayFrontendIPConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayFrontendPort.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayHttpListener.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayHttpListenerCustomError.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayIPConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayProbeConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayRedirectConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayRequestRoutingRule.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewaySslCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewaySslPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayTrustedRootCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayUrlPathMapConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationSecurityGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmDdosProtectionPlan.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmDelegation.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmExpressRouteCircuit.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmExpressRouteCircuitAuthorization.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmExpressRouteCircuitConnectionConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmExpressRouteCircuitPeeringConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmExpressRoutePort.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmFirewall.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLoadBalancer.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLoadBalancerBackendAddressPoolConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLoadBalancerFrontendIpConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLoadBalancerInboundNatPoolConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLoadBalancerInboundNatRuleConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLoadBalancerOutboundRuleConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLoadBalancerProbeConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLoadBalancerRuleConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLocalNetworkGateway.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkInterface.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkInterfaceIpConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkInterfaceTapConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkProfile.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkSecurityGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkSecurityRuleConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkWatcher.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkWatcherConnectionMonitor.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkWatcherPacketCapture.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmPublicIpAddress.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmPublicIpPrefix.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmRouteConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmRouteFilter.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmRouteFilterRuleConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmRouteTable.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmServiceEndpointPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmServiceEndpointPolicyDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualHub.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualHubVnetConnection.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualNetwork.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualNetworkGateway.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualNetworkGatewayConnection.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualNetworkGatewayDefaultSite.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualNetworkGatewayIpConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualNetworkPeering.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualNetworkSubnetConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualNetworkTap.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualWan.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVpnClientIpsecParameter.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVpnClientRevokedCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVpnClientRootCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVpnConnection.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVpnGateway.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVpnSite.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Reset-AzureRmVirtualNetworkGateway.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Reset-AzureRmVirtualNetworkGatewayConnectionSharedKey.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Resize-AzureRmVirtualNetworkGateway.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGateway.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayAuthenticationCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayAutoscaleConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayBackendAddressPool.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayBackendHttpSettings.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayConnectionDraining.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayCustomError.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayFrontendIPConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayFrontendPort.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayHttpListener.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayHttpListenerCustomError.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayIPConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayProbeConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayRedirectConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayRequestRoutingRule.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewaySku.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewaySslCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewaySslPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayTrustedRootCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayUrlPathMapConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmExpressRouteCircuit.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmExpressRouteCircuitPeeringConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmExpressRoutePort.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmFirewall.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmLoadBalancer.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmLoadBalancerFrontendIpConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmLoadBalancerInboundNatPoolConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmLoadBalancerInboundNatRuleConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmLoadBalancerOutboundRuleConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmLoadBalancerProbeConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmLoadBalancerRuleConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmLocalNetworkGateway.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmNetworkInterface.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmNetworkInterfaceIpConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmNetworkInterfaceTapConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmNetworkProfile.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmNetworkSecurityGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmNetworkSecurityRuleConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmNetworkWatcherConfigFlowLog.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmNetworkWatcherConnectionMonitor.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmPublicIpAddress.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmPublicIpPrefix.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmRouteConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmRouteFilter.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmRouteFilterRuleConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmRouteTable.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmServiceEndpointPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmServiceEndpointPolicyDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetwork.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetworkGateway.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetworkGatewayConnection.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetworkGatewayConnectionSharedKey.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetworkGatewayDefaultSite.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetworkGatewayVpnClientConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetworkPeering.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetworkSubnetConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetworkTap.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Set-AzureRmVpnClientIpsecParameter.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Start-AzureRmApplicationGateway.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Start-AzureRmNetworkWatcherConnectionMonitor.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Start-AzureRmNetworkWatcherResourceTroubleshooting.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Stop-AzureRmApplicationGateway.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Stop-AzureRmNetworkWatcherConnectionMonitor.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Stop-AzureRmNetworkWatcherPacketCapture.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Test-AzureRmDnsAvailability.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Test-AzureRmNetworkWatcherConnectivity.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Test-AzureRmNetworkWatcherIPFlow.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Test-AzureRmPrivateIPAddressAvailability.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Update-AzureRmVirtualHub.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Update-AzureRmVirtualWan.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Update-AzureRmVpnConnection.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Update-AzureRmVpnGateway.md delete mode 100644 azurermps-6.13.0/AzureRM.Network/Update-AzureRmVpnSite.md delete mode 100644 azurermps-6.13.0/AzureRM.NotificationHubs/AzureRM.NotificationHubs.md delete mode 100644 azurermps-6.13.0/AzureRM.NotificationHubs/Get-AzureRmNotificationHub.md delete mode 100644 azurermps-6.13.0/AzureRM.NotificationHubs/Get-AzureRmNotificationHubAuthorizationRules.md delete mode 100644 azurermps-6.13.0/AzureRM.NotificationHubs/Get-AzureRmNotificationHubListKeys.md delete mode 100644 azurermps-6.13.0/AzureRM.NotificationHubs/Get-AzureRmNotificationHubPNSCredentials.md delete mode 100644 azurermps-6.13.0/AzureRM.NotificationHubs/Get-AzureRmNotificationHubsNamespace.md delete mode 100644 azurermps-6.13.0/AzureRM.NotificationHubs/Get-AzureRmNotificationHubsNamespaceAuthorizationRules.md delete mode 100644 azurermps-6.13.0/AzureRM.NotificationHubs/Get-AzureRmNotificationHubsNamespaceListKeys.md delete mode 100644 azurermps-6.13.0/AzureRM.NotificationHubs/New-AzureRmNotificationHub.md delete mode 100644 azurermps-6.13.0/AzureRM.NotificationHubs/New-AzureRmNotificationHubAuthorizationRules.md delete mode 100644 azurermps-6.13.0/AzureRM.NotificationHubs/New-AzureRmNotificationHubKey.md delete mode 100644 azurermps-6.13.0/AzureRM.NotificationHubs/New-AzureRmNotificationHubsNamespace.md delete mode 100644 azurermps-6.13.0/AzureRM.NotificationHubs/New-AzureRmNotificationHubsNamespaceAuthorizationRules.md delete mode 100644 azurermps-6.13.0/AzureRM.NotificationHubs/New-AzureRmNotificationHubsNamespaceKey.md delete mode 100644 azurermps-6.13.0/AzureRM.NotificationHubs/Remove-AzureRmNotificationHub.md delete mode 100644 azurermps-6.13.0/AzureRM.NotificationHubs/Remove-AzureRmNotificationHubAuthorizationRules.md delete mode 100644 azurermps-6.13.0/AzureRM.NotificationHubs/Remove-AzureRmNotificationHubsNamespace.md delete mode 100644 azurermps-6.13.0/AzureRM.NotificationHubs/Remove-AzureRmNotificationHubsNamespaceAuthorizationRules.md delete mode 100644 azurermps-6.13.0/AzureRM.NotificationHubs/Set-AzureRmNotificationHub.md delete mode 100644 azurermps-6.13.0/AzureRM.NotificationHubs/Set-AzureRmNotificationHubAuthorizationRules.md delete mode 100644 azurermps-6.13.0/AzureRM.NotificationHubs/Set-AzureRmNotificationHubsNamespace.md delete mode 100644 azurermps-6.13.0/AzureRM.NotificationHubs/Set-AzureRmNotificationHubsNamespaceAuthorizationRules.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/AzureRM.OperationalInsights.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/Disable-AzureRmOperationalInsightsIISLogCollection.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/Disable-AzureRmOperationalInsightsLinuxCustomLogCollection.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/Disable-AzureRmOperationalInsightsLinuxPerformanceCollection.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/Disable-AzureRmOperationalInsightsLinuxSyslogCollection.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/Enable-AzureRmOperationalInsightsIISLogCollection.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/Enable-AzureRmOperationalInsightsLinuxCustomLogCollection.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/Enable-AzureRmOperationalInsightsLinuxPerformanceCollection.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/Enable-AzureRmOperationalInsightsLinuxSyslogCollection.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsDataSource.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsIntelligencePacks.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsLinkTargets.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsSavedSearch.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsSavedSearchResults.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsSchema.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsSearchResults.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsStorageInsight.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsWorkspace.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsWorkspaceManagementGroups.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsWorkspaceSharedKeys.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsWorkspaceUsage.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/Invoke-AzureRmOperationalInsightsQuery.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsAzureActivityLogDataSource.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsComputerGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsCustomLogDataSource.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsLinuxPerformanceObjectDataSource.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsLinuxSyslogDataSource.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsSavedSearch.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsStorageInsight.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsWindowsEventDataSource.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsWindowsPerformanceCounterDataSource.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsWorkspace.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/Remove-AzureRmOperationalInsightsDataSource.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/Remove-AzureRmOperationalInsightsSavedSearch.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/Remove-AzureRmOperationalInsightsStorageInsight.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/Remove-AzureRmOperationalInsightsWorkspace.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/Set-AzureRmOperationalInsightsDataSource.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/Set-AzureRmOperationalInsightsIntelligencePack.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/Set-AzureRmOperationalInsightsSavedSearch.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/Set-AzureRmOperationalInsightsStorageInsight.md delete mode 100644 azurermps-6.13.0/AzureRM.OperationalInsights/Set-AzureRmOperationalInsightsWorkspace.md delete mode 100644 azurermps-6.13.0/AzureRM.PolicyInsights/AzureRM.PolicyInsights.md delete mode 100644 azurermps-6.13.0/AzureRM.PolicyInsights/Get-AzureRmPolicyEvent.md delete mode 100644 azurermps-6.13.0/AzureRM.PolicyInsights/Get-AzureRmPolicyRemediation.md delete mode 100644 azurermps-6.13.0/AzureRM.PolicyInsights/Get-AzureRmPolicyState.md delete mode 100644 azurermps-6.13.0/AzureRM.PolicyInsights/Get-AzureRmPolicyStateSummary.md delete mode 100644 azurermps-6.13.0/AzureRM.PolicyInsights/Remove-AzureRmPolicyRemediation.md delete mode 100644 azurermps-6.13.0/AzureRM.PolicyInsights/Start-AzureRmPolicyRemediation.md delete mode 100644 azurermps-6.13.0/AzureRM.PolicyInsights/Stop-AzureRmPolicyRemediation.md delete mode 100644 azurermps-6.13.0/AzureRM.PowerBIEmbedded/AzureRM.PowerBIEmbedded.md delete mode 100644 azurermps-6.13.0/AzureRM.PowerBIEmbedded/Get-AzureRmPowerBIEmbeddedCapacity.md delete mode 100644 azurermps-6.13.0/AzureRM.PowerBIEmbedded/Get-AzureRmPowerBIWorkspace.md delete mode 100644 azurermps-6.13.0/AzureRM.PowerBIEmbedded/Get-AzureRmPowerBIWorkspaceCollection.md delete mode 100644 azurermps-6.13.0/AzureRM.PowerBIEmbedded/Get-AzureRmPowerBIWorkspaceCollectionAccessKeys.md delete mode 100644 azurermps-6.13.0/AzureRM.PowerBIEmbedded/New-AzureRmPowerBIEmbeddedCapacity.md delete mode 100644 azurermps-6.13.0/AzureRM.PowerBIEmbedded/New-AzureRmPowerBIWorkspaceCollection.md delete mode 100644 azurermps-6.13.0/AzureRM.PowerBIEmbedded/Remove-AzureRmPowerBIEmbeddedCapacity.md delete mode 100644 azurermps-6.13.0/AzureRM.PowerBIEmbedded/Remove-AzureRmPowerBIWorkspaceCollection.md delete mode 100644 azurermps-6.13.0/AzureRM.PowerBIEmbedded/Reset-AzureRmPowerBIWorkspaceCollectionAccessKeys.md delete mode 100644 azurermps-6.13.0/AzureRM.PowerBIEmbedded/Resume-AzureRmPowerBIEmbeddedCapacity.md delete mode 100644 azurermps-6.13.0/AzureRM.PowerBIEmbedded/Suspend-AzureRmPowerBIEmbeddedCapacity.md delete mode 100644 azurermps-6.13.0/AzureRM.PowerBIEmbedded/Test-AzureRmPowerBIEmbeddedCapacity.md delete mode 100644 azurermps-6.13.0/AzureRM.PowerBIEmbedded/Update-AzureRmPowerBIEmbeddedCapacity.md delete mode 100644 azurermps-6.13.0/AzureRM.Profile/Add-AzureRmEnvironment.md delete mode 100644 azurermps-6.13.0/AzureRM.Profile/AzureRM.Profile.md delete mode 100644 azurermps-6.13.0/AzureRM.Profile/Clear-AzureRmContext.md delete mode 100644 azurermps-6.13.0/AzureRM.Profile/Clear-AzureRmDefault.md delete mode 100644 azurermps-6.13.0/AzureRM.Profile/Connect-AzureRmAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.Profile/Disable-AzureRmContextAutosave.md delete mode 100644 azurermps-6.13.0/AzureRM.Profile/Disable-AzureRmDataCollection.md delete mode 100644 azurermps-6.13.0/AzureRM.Profile/Disconnect-AzureRmAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.Profile/Enable-AzureRmContextAutosave.md delete mode 100644 azurermps-6.13.0/AzureRM.Profile/Enable-AzureRmDataCollection.md delete mode 100644 azurermps-6.13.0/AzureRM.Profile/Get-AzureRmContext.md delete mode 100644 azurermps-6.13.0/AzureRM.Profile/Get-AzureRmContextAutosaveSetting.md delete mode 100644 azurermps-6.13.0/AzureRM.Profile/Get-AzureRmDefault.md delete mode 100644 azurermps-6.13.0/AzureRM.Profile/Get-AzureRmEnvironment.md delete mode 100644 azurermps-6.13.0/AzureRM.Profile/Get-AzureRmSubscription.md delete mode 100644 azurermps-6.13.0/AzureRM.Profile/Get-AzureRmTenant.md delete mode 100644 azurermps-6.13.0/AzureRM.Profile/Import-AzureRmContext.md delete mode 100644 azurermps-6.13.0/AzureRM.Profile/Remove-AzureRmContext.md delete mode 100644 azurermps-6.13.0/AzureRM.Profile/Remove-AzureRmEnvironment.md delete mode 100644 azurermps-6.13.0/AzureRM.Profile/Rename-AzureRmContext.md delete mode 100644 azurermps-6.13.0/AzureRM.Profile/Resolve-AzureRmError.md delete mode 100644 azurermps-6.13.0/AzureRM.Profile/Save-AzureRmContext.md delete mode 100644 azurermps-6.13.0/AzureRM.Profile/Select-AzureRmContext.md delete mode 100644 azurermps-6.13.0/AzureRM.Profile/Send-Feedback.md delete mode 100644 azurermps-6.13.0/AzureRM.Profile/Set-AzureRmContext.md delete mode 100644 azurermps-6.13.0/AzureRM.Profile/Set-AzureRmDefault.md delete mode 100644 azurermps-6.13.0/AzureRM.Profile/Set-AzureRmEnvironment.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.Backup/AzureRM.RecoveryServices.Backup.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Backup-AzureRmRecoveryServicesBackupItem.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Disable-AzureRmRecoveryServicesBackupProtection.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Disable-AzureRmRecoveryServicesBackupRPMountScript.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Enable-AzureRmRecoveryServicesBackupProtection.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupContainer.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupItem.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupJob.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupJobDetails.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupManagementServer.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupProtectionPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupRPMountScript.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupRecoveryPoint.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupRetentionPolicyObject.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupSchedulePolicyObject.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupStatus.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.Backup/New-AzureRmRecoveryServicesBackupProtectionPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Remove-AzureRmRecoveryServicesBackupProtectionPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Restore-AzureRmRecoveryServicesBackupItem.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Set-AzureRmRecoveryServicesBackupProtectionPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Stop-AzureRmRecoveryServicesBackupJob.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Unregister-AzureRmRecoveryServicesBackupContainer.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Unregister-AzureRmRecoveryServicesBackupManagementServer.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Wait-AzureRmRecoveryServicesBackupJob.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/AzureRM.RecoveryServices.SiteRecovery.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Edit-AzureRmRecoveryServicesAsrRecoveryPlan.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrAlertSetting.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrEvent.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrFabric.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrJob.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrNetwork.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrNetworkMapping.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrProtectableItem.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrProtectionContainer.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrProtectionContainerMapping.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrRecoveryPlan.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrRecoveryPoint.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrReplicationProtectedItem.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrServicesProvider.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrStorageClassification.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrStorageClassificationMapping.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrVCenter.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrVaultContext.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Import-AzureRmRecoveryServicesAsrVaultSettingsFile.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrAzureToAzureDiskReplicationConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrFabric.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrNetworkMapping.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrProtectableItem.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrProtectionContainer.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrProtectionContainerMapping.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrRecoveryPlan.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrReplicationProtectedItem.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrStorageClassificationMapping.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrVCenter.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrFabric.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrNetworkMapping.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrProtectionContainer.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrProtectionContainerMapping.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrRecoveryPlan.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrReplicationProtectedItem.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrServicesProvider.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrStorageClassificationMapping.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrVCenter.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Restart-AzureRmRecoveryServicesAsrJob.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Resume-AzureRmRecoveryServicesAsrJob.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Set-AzureRmRecoveryServicesAsrAlertSetting.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Set-AzureRmRecoveryServicesAsrReplicationProtectedItem.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Set-AzureRmRecoveryServicesAsrVaultContext.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Start-AzureRmRecoveryServicesAsrApplyRecoveryPoint.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Start-AzureRmRecoveryServicesAsrCommitFailoverJob.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Start-AzureRmRecoveryServicesAsrPlannedFailoverJob.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Start-AzureRmRecoveryServicesAsrResynchronizeReplicationJob.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Start-AzureRmRecoveryServicesAsrSwitchProcessServerJob.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Start-AzureRmRecoveryServicesAsrTestFailoverCleanupJob.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Start-AzureRmRecoveryServicesAsrTestFailoverJob.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Start-AzureRmRecoveryServicesAsrUnplannedFailoverJob.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Stop-AzureRmRecoveryServicesAsrJob.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Update-AzureRmRecoveryServicesAsrMobilityService.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Update-AzureRmRecoveryServicesAsrNetworkMapping.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Update-AzureRmRecoveryServicesAsrPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Update-AzureRmRecoveryServicesAsrProtectionDirection.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Update-AzureRmRecoveryServicesAsrRecoveryPlan.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Update-AzureRmRecoveryServicesAsrServicesProvider.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Update-AzureRmRecoveryServicesAsrVCenter.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices/AzureRM.RecoveryServices.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices/Get-AzureRmRecoveryServicesBackupProperty.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices/Get-AzureRmRecoveryServicesVault.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices/Get-AzureRmRecoveryServicesVaultSettingsFile.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices/New-AzureRmRecoveryServicesVault.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices/Remove-AzureRmRecoveryServicesVault.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices/Set-AzureRmRecoveryServicesBackupProperties.md delete mode 100644 azurermps-6.13.0/AzureRM.RecoveryServices/Set-AzureRmRecoveryServicesVaultContext.md delete mode 100644 azurermps-6.13.0/AzureRM.RedisCache/AzureRM.RedisCache.md delete mode 100644 azurermps-6.13.0/AzureRM.RedisCache/Export-AzureRmRedisCache.md delete mode 100644 azurermps-6.13.0/AzureRM.RedisCache/Get-AzureRmRedisCache.md delete mode 100644 azurermps-6.13.0/AzureRM.RedisCache/Get-AzureRmRedisCacheFirewallRule.md delete mode 100644 azurermps-6.13.0/AzureRM.RedisCache/Get-AzureRmRedisCacheKey.md delete mode 100644 azurermps-6.13.0/AzureRM.RedisCache/Get-AzureRmRedisCacheLink.md delete mode 100644 azurermps-6.13.0/AzureRM.RedisCache/Get-AzureRmRedisCachePatchSchedule.md delete mode 100644 azurermps-6.13.0/AzureRM.RedisCache/Import-AzureRmRedisCache.md delete mode 100644 azurermps-6.13.0/AzureRM.RedisCache/New-AzureRmRedisCache.md delete mode 100644 azurermps-6.13.0/AzureRM.RedisCache/New-AzureRmRedisCacheFirewallRule.md delete mode 100644 azurermps-6.13.0/AzureRM.RedisCache/New-AzureRmRedisCacheKey.md delete mode 100644 azurermps-6.13.0/AzureRM.RedisCache/New-AzureRmRedisCacheLink.md delete mode 100644 azurermps-6.13.0/AzureRM.RedisCache/New-AzureRmRedisCachePatchSchedule.md delete mode 100644 azurermps-6.13.0/AzureRM.RedisCache/New-AzureRmRedisCacheScheduleEntry.md delete mode 100644 azurermps-6.13.0/AzureRM.RedisCache/Remove-AzureRmRedisCache.md delete mode 100644 azurermps-6.13.0/AzureRM.RedisCache/Remove-AzureRmRedisCacheDiagnostics.md delete mode 100644 azurermps-6.13.0/AzureRM.RedisCache/Remove-AzureRmRedisCacheFirewallRule.md delete mode 100644 azurermps-6.13.0/AzureRM.RedisCache/Remove-AzureRmRedisCacheLink.md delete mode 100644 azurermps-6.13.0/AzureRM.RedisCache/Remove-AzureRmRedisCachePatchSchedule.md delete mode 100644 azurermps-6.13.0/AzureRM.RedisCache/Reset-AzureRmRedisCache.md delete mode 100644 azurermps-6.13.0/AzureRM.RedisCache/Set-AzureRmRedisCache.md delete mode 100644 azurermps-6.13.0/AzureRM.RedisCache/Set-AzureRmRedisCacheDiagnostics.md delete mode 100644 azurermps-6.13.0/AzureRM.Relay/AzureRM.Relay.md delete mode 100644 azurermps-6.13.0/AzureRM.Relay/Get-AzureRmRelayAuthorizationRule.md delete mode 100644 azurermps-6.13.0/AzureRM.Relay/Get-AzureRmRelayHybridConnection.md delete mode 100644 azurermps-6.13.0/AzureRM.Relay/Get-AzureRmRelayKey.md delete mode 100644 azurermps-6.13.0/AzureRM.Relay/Get-AzureRmRelayNamespace.md delete mode 100644 azurermps-6.13.0/AzureRM.Relay/Get-AzureRmRelayOperation.md delete mode 100644 azurermps-6.13.0/AzureRM.Relay/Get-AzureRmWcfRelay.md delete mode 100644 azurermps-6.13.0/AzureRM.Relay/New-AzureRmRelayAuthorizationRule.md delete mode 100644 azurermps-6.13.0/AzureRM.Relay/New-AzureRmRelayHybridConnection.md delete mode 100644 azurermps-6.13.0/AzureRM.Relay/New-AzureRmRelayKey.md delete mode 100644 azurermps-6.13.0/AzureRM.Relay/New-AzureRmRelayNamespace.md delete mode 100644 azurermps-6.13.0/AzureRM.Relay/New-AzureRmWcfRelay.md delete mode 100644 azurermps-6.13.0/AzureRM.Relay/Remove-AzureRmRelayAuthorizationRule.md delete mode 100644 azurermps-6.13.0/AzureRM.Relay/Remove-AzureRmRelayHybridConnection.md delete mode 100644 azurermps-6.13.0/AzureRM.Relay/Remove-AzureRmRelayNamespace.md delete mode 100644 azurermps-6.13.0/AzureRM.Relay/Remove-AzureRmWcfRelay.md delete mode 100644 azurermps-6.13.0/AzureRM.Relay/Set-AzureRmRelayAuthorizationRule.md delete mode 100644 azurermps-6.13.0/AzureRM.Relay/Set-AzureRmRelayHybridConnection.md delete mode 100644 azurermps-6.13.0/AzureRM.Relay/Set-AzureRmRelayNamespace.md delete mode 100644 azurermps-6.13.0/AzureRM.Relay/Set-AzureRmWcfRelay.md delete mode 100644 azurermps-6.13.0/AzureRM.Relay/Test-AzureRmRelayName.md delete mode 100644 azurermps-6.13.0/AzureRM.Reservations/AzureRM.Reservations.md delete mode 100644 azurermps-6.13.0/AzureRM.Reservations/Get-AzureRmReservation.md delete mode 100644 azurermps-6.13.0/AzureRM.Reservations/Get-AzureRmReservationCatalog.md delete mode 100644 azurermps-6.13.0/AzureRM.Reservations/Get-AzureRmReservationHistory.md delete mode 100644 azurermps-6.13.0/AzureRM.Reservations/Get-AzureRmReservationOrder.md delete mode 100644 azurermps-6.13.0/AzureRM.Reservations/Get-AzureRmReservationOrderId.md delete mode 100644 azurermps-6.13.0/AzureRM.Reservations/Merge-AzureRmReservation.md delete mode 100644 azurermps-6.13.0/AzureRM.Reservations/Split-AzureRmReservation.md delete mode 100644 azurermps-6.13.0/AzureRM.Reservations/Update-AzureRmReservation.md delete mode 100644 azurermps-6.13.0/AzureRM.ResourceGraph/AzureRm.ResourceGraph.md delete mode 100644 azurermps-6.13.0/AzureRM.ResourceGraph/Search-AzureRmGraph.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Add-AzureRmADGroupMember.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/AzureRM.Resources.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Export-AzureRmResourceGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Get-AzureRmADAppCredential.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Get-AzureRmADApplication.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Get-AzureRmADGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Get-AzureRmADGroupMember.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Get-AzureRmADServicePrincipal.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Get-AzureRmADSpCredential.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Get-AzureRmADUser.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Get-AzureRmDeployment.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Get-AzureRmDeploymentOperation.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Get-AzureRmLocation.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Get-AzureRmManagedApplication.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Get-AzureRmManagedApplicationDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Get-AzureRmManagementGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Get-AzureRmPolicyAlias.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Get-AzureRmPolicyAssignment.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Get-AzureRmPolicyDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Get-AzureRmPolicySetDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Get-AzureRmProviderFeature.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Get-AzureRmProviderOperation.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Get-AzureRmResource.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Get-AzureRmResourceGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Get-AzureRmResourceGroupDeployment.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Get-AzureRmResourceGroupDeploymentOperation.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Get-AzureRmResourceLock.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Get-AzureRmResourceProvider.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Get-AzureRmRoleAssignment.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Get-AzureRmRoleDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Invoke-AzureRmResourceAction.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Move-AzureRmResource.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/New-AzureRmADAppCredential.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/New-AzureRmADApplication.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/New-AzureRmADGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/New-AzureRmADServicePrincipal.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/New-AzureRmADSpCredential.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/New-AzureRmADUser.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/New-AzureRmDeployment.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/New-AzureRmManagedApplication.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/New-AzureRmManagedApplicationDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/New-AzureRmManagementGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/New-AzureRmManagementGroupSubscription.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/New-AzureRmPolicyAssignment.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/New-AzureRmPolicyDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/New-AzureRmPolicySetDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/New-AzureRmResource.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/New-AzureRmResourceGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/New-AzureRmResourceGroupDeployment.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/New-AzureRmResourceLock.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/New-AzureRmRoleAssignment.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/New-AzureRmRoleDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Register-AzureRmProviderFeature.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Register-AzureRmResourceProvider.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmADAppCredential.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmADApplication.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmADGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmADGroupMember.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmADServicePrincipal.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmADSpCredential.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmADUser.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmDeployment.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmManagedApplication.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmManagedApplicationDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmManagementGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmManagementGroupSubscription.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmPolicyAssignment.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmPolicyDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmPolicySetDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmResource.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmResourceGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmResourceGroupDeployment.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmResourceLock.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmRoleAssignment.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmRoleDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Save-AzureRmDeploymentTemplate.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Save-AzureRmResourceGroupDeploymentTemplate.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Set-AzureRmManagedApplication.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Set-AzureRmManagedApplicationDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Set-AzureRmPolicyAssignment.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Set-AzureRmPolicyDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Set-AzureRmPolicySetDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Set-AzureRmResource.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Set-AzureRmResourceGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Set-AzureRmResourceLock.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Set-AzureRmRoleDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Stop-AzureRmDeployment.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Stop-AzureRmResourceGroupDeployment.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Test-AzureRmDeployment.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Test-AzureRmResourceGroupDeployment.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Unregister-AzureRmResourceProvider.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Update-AzureRmADApplication.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Update-AzureRmADServicePrincipal.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Update-AzureRmADUser.md delete mode 100644 azurermps-6.13.0/AzureRM.Resources/Update-AzureRmManagementGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Scheduler/AzureRM.Scheduler.md delete mode 100644 azurermps-6.13.0/AzureRM.Scheduler/Disable-AzureRmSchedulerJobCollection.md delete mode 100644 azurermps-6.13.0/AzureRM.Scheduler/Enable-AzureRmSchedulerJobCollection.md delete mode 100644 azurermps-6.13.0/AzureRM.Scheduler/Get-AzureRmSchedulerJob.md delete mode 100644 azurermps-6.13.0/AzureRM.Scheduler/Get-AzureRmSchedulerJobCollection.md delete mode 100644 azurermps-6.13.0/AzureRM.Scheduler/Get-AzureRmSchedulerJobHistory.md delete mode 100644 azurermps-6.13.0/AzureRM.Scheduler/New-AzureRmSchedulerHttpJob.md delete mode 100644 azurermps-6.13.0/AzureRM.Scheduler/New-AzureRmSchedulerJobCollection.md delete mode 100644 azurermps-6.13.0/AzureRM.Scheduler/New-AzureRmSchedulerServiceBusQueueJob.md delete mode 100644 azurermps-6.13.0/AzureRM.Scheduler/New-AzureRmSchedulerServiceBusTopicJob.md delete mode 100644 azurermps-6.13.0/AzureRM.Scheduler/New-AzureRmSchedulerStorageQueueJob.md delete mode 100644 azurermps-6.13.0/AzureRM.Scheduler/Remove-AzureRmSchedulerJob.md delete mode 100644 azurermps-6.13.0/AzureRM.Scheduler/Remove-AzureRmSchedulerJobCollection.md delete mode 100644 azurermps-6.13.0/AzureRM.Scheduler/Set-AzureRmSchedulerHttpJob.md delete mode 100644 azurermps-6.13.0/AzureRM.Scheduler/Set-AzureRmSchedulerJobCollection.md delete mode 100644 azurermps-6.13.0/AzureRM.Scheduler/Set-AzureRmSchedulerServiceBusQueueJob.md delete mode 100644 azurermps-6.13.0/AzureRM.Scheduler/Set-AzureRmSchedulerServiceBusTopicJob.md delete mode 100644 azurermps-6.13.0/AzureRM.Scheduler/Set-AzureRmSchedulerStorageQueueJob.md delete mode 100644 azurermps-6.13.0/AzureRM.Search/AzureRM.Search.md delete mode 100644 azurermps-6.13.0/AzureRM.Search/Get-AzureRmSearchAdminKeyPair.md delete mode 100644 azurermps-6.13.0/AzureRM.Search/Get-AzureRmSearchQueryKey.md delete mode 100644 azurermps-6.13.0/AzureRM.Search/Get-AzureRmSearchService.md delete mode 100644 azurermps-6.13.0/AzureRM.Search/New-AzureRmSearchAdminKey.md delete mode 100644 azurermps-6.13.0/AzureRM.Search/New-AzureRmSearchQueryKey.md delete mode 100644 azurermps-6.13.0/AzureRM.Search/New-AzureRmSearchService.md delete mode 100644 azurermps-6.13.0/AzureRM.Search/Remove-AzureRmSearchQueryKey.md delete mode 100644 azurermps-6.13.0/AzureRM.Search/Remove-AzureRmSearchService.md delete mode 100644 azurermps-6.13.0/AzureRM.Search/Set-AzureRmSearchService.md delete mode 100644 azurermps-6.13.0/AzureRM.Security/AzureRM.Security.md delete mode 100644 azurermps-6.13.0/AzureRM.Security/Get-AzureRmDiscoveredSecuritySolution.md delete mode 100644 azurermps-6.13.0/AzureRM.Security/Get-AzureRmExternalSecuritySolution.md delete mode 100644 azurermps-6.13.0/AzureRM.Security/Get-AzureRmJitNetworkAccessPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Security/Get-AzureRmSecurityAlert.md delete mode 100644 azurermps-6.13.0/AzureRM.Security/Get-AzureRmSecurityAutoProvisioningSetting.md delete mode 100644 azurermps-6.13.0/AzureRM.Security/Get-AzureRmSecurityCompliance.md delete mode 100644 azurermps-6.13.0/AzureRM.Security/Get-AzureRmSecurityContact.md delete mode 100644 azurermps-6.13.0/AzureRM.Security/Get-AzureRmSecurityLocation.md delete mode 100644 azurermps-6.13.0/AzureRM.Security/Get-AzureRmSecurityPricing.md delete mode 100644 azurermps-6.13.0/AzureRM.Security/Get-AzureRmSecurityTask.md delete mode 100644 azurermps-6.13.0/AzureRM.Security/Get-AzureRmSecurityWorkspaceSetting.md delete mode 100644 azurermps-6.13.0/AzureRM.Security/Remove-AzureRmJitNetworkAccessPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Security/Remove-AzureRmSecurityContact.md delete mode 100644 azurermps-6.13.0/AzureRM.Security/Remove-AzureRmSecurityWorkspaceSetting.md delete mode 100644 azurermps-6.13.0/AzureRM.Security/Set-AzureRmJitNetworkAccessPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Security/Set-AzureRmSecurityAlert.md delete mode 100644 azurermps-6.13.0/AzureRM.Security/Set-AzureRmSecurityAutoProvisioningSetting.md delete mode 100644 azurermps-6.13.0/AzureRM.Security/Set-AzureRmSecurityContact.md delete mode 100644 azurermps-6.13.0/AzureRM.Security/Set-AzureRmSecurityPricing.md delete mode 100644 azurermps-6.13.0/AzureRM.Security/Set-AzureRmSecurityWorkspaceSetting.md delete mode 100644 azurermps-6.13.0/AzureRM.Security/Start-AzureRmJitNetworkAccessPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/AzureRM.ServiceBus.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/Complete-AzureRmServiceBusMigration.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusAuthorizationRule.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusGeoDRConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusKey.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusMigration.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusNamespace.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusOperation.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusQueue.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusRule.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusSubscription.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusTopic.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/New-AzureRmServiceBusAuthorizationRule.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/New-AzureRmServiceBusGeoDRConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/New-AzureRmServiceBusKey.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/New-AzureRmServiceBusNamespace.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/New-AzureRmServiceBusQueue.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/New-AzureRmServiceBusRule.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/New-AzureRmServiceBusSubscription.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/New-AzureRmServiceBusTopic.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/Remove-AzureRmServiceBusAuthorizationRule.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/Remove-AzureRmServiceBusGeoDRConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/Remove-AzureRmServiceBusMigration.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/Remove-AzureRmServiceBusNamespace.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/Remove-AzureRmServiceBusQueue.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/Remove-AzureRmServiceBusRule.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/Remove-AzureRmServiceBusSubscription.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/Remove-AzureRmServiceBusTopic.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/Set-AzureRmServiceBusAuthorizationRule.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/Set-AzureRmServiceBusGeoDRConfigurationBreakPair.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/Set-AzureRmServiceBusGeoDRConfigurationFailOver.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/Set-AzureRmServiceBusNamespace.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/Set-AzureRmServiceBusQueue.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/Set-AzureRmServiceBusRule.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/Set-AzureRmServiceBusSubscription.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/Set-AzureRmServiceBusTopic.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/Start-AzureRmServiceBusMigration.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/Stop-AzureRmServiceBusMigration.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceBus/Test-AzureRmServiceBusName.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceFabric/Add-AzureRmServiceFabricApplicationCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceFabric/Add-AzureRmServiceFabricClientCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceFabric/Add-AzureRmServiceFabricClusterCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceFabric/Add-AzureRmServiceFabricNode.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceFabric/Add-AzureRmServiceFabricNodeType.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceFabric/AzureRM.ServiceFabric.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceFabric/Get-AzureRmServiceFabricCluster.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceFabric/New-AzureRmServiceFabricCluster.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceFabric/Remove-AzureRmServiceFabricClientCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceFabric/Remove-AzureRmServiceFabricClusterCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceFabric/Remove-AzureRmServiceFabricNode.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceFabric/Remove-AzureRmServiceFabricNodeType.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceFabric/Remove-AzureRmServiceFabricSetting.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceFabric/Set-AzureRmServiceFabricSetting.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceFabric/Set-AzureRmServiceFabricUpgradeType.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceFabric/Update-AzureRmServiceFabricDurability.md delete mode 100644 azurermps-6.13.0/AzureRM.ServiceFabric/Update-AzureRmServiceFabricReliability.md delete mode 100644 azurermps-6.13.0/AzureRM.SignalR/AzureRM.SignalR.md delete mode 100644 azurermps-6.13.0/AzureRM.SignalR/Get-AzureRmSignalR.md delete mode 100644 azurermps-6.13.0/AzureRM.SignalR/Get-AzureRmSignalRKey.md delete mode 100644 azurermps-6.13.0/AzureRM.SignalR/New-AzureRmSignalR.md delete mode 100644 azurermps-6.13.0/AzureRM.SignalR/New-AzureRmSignalRKey.md delete mode 100644 azurermps-6.13.0/AzureRM.SignalR/Remove-AzureRmSignalR.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Add-AzureRmSqlDatabaseToFailoverGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Add-AzureRmSqlServerKeyVaultKey.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Add-AzureRmSqlServerTransparentDataEncryptionCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/AzureRM.Sql.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Clear-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Clear-AzureRmSqlDatabaseVulnerabilityAssessmentSettings.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Convert-AzureRmSqlDatabaseVulnerabilityAssessmentScan.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Disable-AzureRmSqlServerAdvancedThreatProtection.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Enable-AzureRmSqlServerAdvancedThreatProtection.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRMSqlDatabaseGeoBackup.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRMSqlDeletedDatabaseBackup.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlCapability.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabase.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseActivity.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseAdvisor.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseAuditing.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseAuditingPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseBackupLongTermRetentionPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseDataMaskingPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseDataMaskingRule.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseExpanded.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseFailoverGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseGeoBackupPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseImportExportStatus.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseIndexRecommendations.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseLongTermRetentionBackup.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseRecommendedAction.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseReplicationLink.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseRestorePoints.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseSecureConnectionPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseThreatDetectionPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseTransparentDataEncryption.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseUpgradeHint.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseVulnerabilityAssessmentScanRecord.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseVulnerabilityAssessmentSettings.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlElasticPool.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlElasticPoolActivity.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlElasticPoolAdvisor.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlElasticPoolDatabase.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlElasticPoolRecommendation.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlElasticPoolRecommendedAction.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlInstance.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlInstanceDatabase.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServer.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerActiveDirectoryAdministrator.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerAdvancedThreatProtectionPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerAdvisor.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerAuditing.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerAuditingPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerBackupLongTermRetentionVault.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerCommunicationLink.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerDisasterRecoveryConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerDisasterRecoveryConfigurationActivity.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerDnsAlias.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerFirewallRule.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerKeyVaultKey.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerRecommendedAction.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerServiceObjective.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerThreatDetectionPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerTransparentDataEncryptionProtector.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerUpgrade.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerUpgradeHint.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerVirtualNetworkRule.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlSyncAgent.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlSyncAgentLinkedDatabase.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlSyncGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlSyncGroupLog.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlSyncMember.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlSyncSchema.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlDatabase.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlDatabaseCopy.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlDatabaseDataMaskingRule.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlDatabaseExport.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlDatabaseFailoverGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlDatabaseImport.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlDatabaseRestorePoint.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlDatabaseSecondary.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlElasticPool.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlInstance.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlInstanceDatabase.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlServer.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlServerCommunicationLink.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlServerDisasterRecoveryConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlServerDnsAlias.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlServerFirewallRule.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlServerVirtualNetworkRule.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlSyncAgent.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlSyncAgentKey.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlSyncGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlSyncMember.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabase.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabaseAuditing.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabaseDataMaskingRule.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabaseFailoverGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabaseFromFailoverGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabaseLongTermRetentionBackup.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabaseRestorePoint.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabaseSecondary.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabaseThreatDetectionPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlElasticPool.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlInstance.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlInstanceDatabase.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServer.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerActiveDirectoryAdministrator.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerAuditing.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerCommunicationLink.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerDisasterRecoveryConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerDnsAlias.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerFirewallRule.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerKeyVaultKey.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerThreatDetectionPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerVirtualNetworkRule.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlSyncAgent.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlSyncGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlSyncMember.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Restore-AzureRmSqlDatabase.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Restore-AzureRmSqlInstanceDatabase.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Resume-AzureRmSqlDatabase.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabase.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseAdvisorAutoExecuteStatus.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseAuditing.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseAuditingPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseDataMaskingPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseDataMaskingRule.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseFailoverGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseGeoBackupPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseRecommendedActionState.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseSecondary.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseThreatDetectionPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseTransparentDataEncryption.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlElasticPool.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlElasticPoolAdvisorAutoExecuteStatus.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlElasticPoolRecommendedActionState.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlInstance.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServer.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerActiveDirectoryAdministrator.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerAdvisorAutoExecuteStatus.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerAuditing.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerAuditingPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerBackupLongTermRetentionVault.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerDisasterRecoveryConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerDnsAlias.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerFirewallRule.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerRecommendedActionState.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerThreatDetectionPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerTransparentDataEncryptionProtector.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerVirtualNetworkRule.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Start-AzureRmSqlDatabaseExecuteIndexRecommendation.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Start-AzureRmSqlDatabaseVulnerabilityAssessmentScan.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Start-AzureRmSqlServerUpgrade.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Start-AzureRmSqlSyncGroupSync.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Stop-AzureRmSqlDatabaseActivity.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Stop-AzureRmSqlDatabaseExecuteIndexRecommendation.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Stop-AzureRmSqlElasticPoolActivity.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Stop-AzureRmSqlServerUpgrade.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Stop-AzureRmSqlSyncGroupSync.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Suspend-AzureRmSqlDatabase.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Switch-AzureRmSqlDatabaseFailoverGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Update-AzureRmSqlDatabaseVulnerabilityAssessmentSettings.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Update-AzureRmSqlSyncGroup.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Update-AzureRmSqlSyncMember.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Update-AzureRmSqlSyncSchema.md delete mode 100644 azurermps-6.13.0/AzureRM.Sql/Use-AzureRmSqlServerAuditingPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Storage/Add-AzureRmStorageAccountNetworkRule.md delete mode 100644 azurermps-6.13.0/AzureRM.Storage/Add-AzureRmStorageContainerLegalHold.md delete mode 100644 azurermps-6.13.0/AzureRM.Storage/AzureRM.Storage.md delete mode 100644 azurermps-6.13.0/AzureRM.Storage/Get-AzureRmStorageAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.Storage/Get-AzureRmStorageAccountKey.md delete mode 100644 azurermps-6.13.0/AzureRM.Storage/Get-AzureRmStorageAccountNameAvailability.md delete mode 100644 azurermps-6.13.0/AzureRM.Storage/Get-AzureRmStorageAccountNetworkRuleSet.md delete mode 100644 azurermps-6.13.0/AzureRM.Storage/Get-AzureRmStorageContainer.md delete mode 100644 azurermps-6.13.0/AzureRM.Storage/Get-AzureRmStorageContainerImmutabilityPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Storage/Get-AzureRmStorageUsage.md delete mode 100644 azurermps-6.13.0/AzureRM.Storage/Lock-AzureRmStorageContainerImmutabilityPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Storage/New-AzureRmStorageAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.Storage/New-AzureRmStorageAccountKey.md delete mode 100644 azurermps-6.13.0/AzureRM.Storage/New-AzureRmStorageContainer.md delete mode 100644 azurermps-6.13.0/AzureRM.Storage/Remove-AzureRmStorageAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.Storage/Remove-AzureRmStorageAccountNetworkRule.md delete mode 100644 azurermps-6.13.0/AzureRM.Storage/Remove-AzureRmStorageContainer.md delete mode 100644 azurermps-6.13.0/AzureRM.Storage/Remove-AzureRmStorageContainerImmutabilityPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Storage/Remove-AzureRmStorageContainerLegalHold.md delete mode 100644 azurermps-6.13.0/AzureRM.Storage/Set-AzureRmCurrentStorageAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.Storage/Set-AzureRmStorageAccount.md delete mode 100644 azurermps-6.13.0/AzureRM.Storage/Set-AzureRmStorageContainerImmutabilityPolicy.md delete mode 100644 azurermps-6.13.0/AzureRM.Storage/Update-AzureRmStorageAccountNetworkRuleSet.md delete mode 100644 azurermps-6.13.0/AzureRM.Storage/Update-AzureRmStorageContainer.md delete mode 100644 azurermps-6.13.0/AzureRM.StorageSync/AzureRm.StorageSync.md delete mode 100644 azurermps-6.13.0/AzureRM.StorageSync/Invoke-AzureRmStorageSyncCompatibilityCheck.md delete mode 100644 azurermps-6.13.0/AzureRM.StreamAnalytics/AzureRM.StreamAnalytics.md delete mode 100644 azurermps-6.13.0/AzureRM.StreamAnalytics/Get-AzureRmStreamAnalyticsDefaultFunctionDefinition.md delete mode 100644 azurermps-6.13.0/AzureRM.StreamAnalytics/Get-AzureRmStreamAnalyticsFunction.md delete mode 100644 azurermps-6.13.0/AzureRM.StreamAnalytics/Get-AzureRmStreamAnalyticsInput.md delete mode 100644 azurermps-6.13.0/AzureRM.StreamAnalytics/Get-AzureRmStreamAnalyticsJob.md delete mode 100644 azurermps-6.13.0/AzureRM.StreamAnalytics/Get-AzureRmStreamAnalyticsOutput.md delete mode 100644 azurermps-6.13.0/AzureRM.StreamAnalytics/Get-AzureRmStreamAnalyticsQuota.md delete mode 100644 azurermps-6.13.0/AzureRM.StreamAnalytics/Get-AzureRmStreamAnalyticsTransformation.md delete mode 100644 azurermps-6.13.0/AzureRM.StreamAnalytics/New-AzureRmStreamAnalyticsFunction.md delete mode 100644 azurermps-6.13.0/AzureRM.StreamAnalytics/New-AzureRmStreamAnalyticsInput.md delete mode 100644 azurermps-6.13.0/AzureRM.StreamAnalytics/New-AzureRmStreamAnalyticsJob.md delete mode 100644 azurermps-6.13.0/AzureRM.StreamAnalytics/New-AzureRmStreamAnalyticsOutput.md delete mode 100644 azurermps-6.13.0/AzureRM.StreamAnalytics/New-AzureRmStreamAnalyticsTransformation.md delete mode 100644 azurermps-6.13.0/AzureRM.StreamAnalytics/Remove-AzureRmStreamAnalyticsFunction.md delete mode 100644 azurermps-6.13.0/AzureRM.StreamAnalytics/Remove-AzureRmStreamAnalyticsInput.md delete mode 100644 azurermps-6.13.0/AzureRM.StreamAnalytics/Remove-AzureRmStreamAnalyticsJob.md delete mode 100644 azurermps-6.13.0/AzureRM.StreamAnalytics/Remove-AzureRmStreamAnalyticsOutput.md delete mode 100644 azurermps-6.13.0/AzureRM.StreamAnalytics/Start-AzureRmStreamAnalyticsJob.md delete mode 100644 azurermps-6.13.0/AzureRM.StreamAnalytics/Stop-AzureRmStreamAnalyticsJob.md delete mode 100644 azurermps-6.13.0/AzureRM.StreamAnalytics/Test-AzureRmStreamAnalyticsFunction.md delete mode 100644 azurermps-6.13.0/AzureRM.StreamAnalytics/Test-AzureRmStreamAnalyticsInput.md delete mode 100644 azurermps-6.13.0/AzureRM.StreamAnalytics/Test-AzureRmStreamAnalyticsOutput.md delete mode 100644 azurermps-6.13.0/AzureRM.Subscription/AzureRM.Subscription.md delete mode 100644 azurermps-6.13.0/AzureRM.Subscription/New-AzureRmSubscription.md delete mode 100644 azurermps-6.13.0/AzureRM.Tags/AzureRM.Tags.md delete mode 100644 azurermps-6.13.0/AzureRM.Tags/Get-AzureRmTag.md delete mode 100644 azurermps-6.13.0/AzureRM.Tags/New-AzureRmTag.md delete mode 100644 azurermps-6.13.0/AzureRM.Tags/Remove-AzureRmTag.md delete mode 100644 azurermps-6.13.0/AzureRM.TrafficManager/Add-AzureRmTrafficManagerCustomHeaderToEndpoint.md delete mode 100644 azurermps-6.13.0/AzureRM.TrafficManager/Add-AzureRmTrafficManagerCustomHeaderToProfile.md delete mode 100644 azurermps-6.13.0/AzureRM.TrafficManager/Add-AzureRmTrafficManagerEndpointConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.TrafficManager/Add-AzureRmTrafficManagerExpectedStatusCodeRange.md delete mode 100644 azurermps-6.13.0/AzureRM.TrafficManager/Add-AzureRmTrafficManagerIpAddressRange.md delete mode 100644 azurermps-6.13.0/AzureRM.TrafficManager/AzureRM.TrafficManager.md delete mode 100644 azurermps-6.13.0/AzureRM.TrafficManager/Disable-AzureRmTrafficManagerEndpoint.md delete mode 100644 azurermps-6.13.0/AzureRM.TrafficManager/Disable-AzureRmTrafficManagerProfile.md delete mode 100644 azurermps-6.13.0/AzureRM.TrafficManager/Enable-AzureRmTrafficManagerEndpoint.md delete mode 100644 azurermps-6.13.0/AzureRM.TrafficManager/Enable-AzureRmTrafficManagerProfile.md delete mode 100644 azurermps-6.13.0/AzureRM.TrafficManager/Get-AzureRmTrafficManagerEndpoint.md delete mode 100644 azurermps-6.13.0/AzureRM.TrafficManager/Get-AzureRmTrafficManagerProfile.md delete mode 100644 azurermps-6.13.0/AzureRM.TrafficManager/New-AzureRmTrafficManagerEndpoint.md delete mode 100644 azurermps-6.13.0/AzureRM.TrafficManager/New-AzureRmTrafficManagerProfile.md delete mode 100644 azurermps-6.13.0/AzureRM.TrafficManager/Remove-AzureRmTrafficManagerCustomHeaderFromEndpoint.md delete mode 100644 azurermps-6.13.0/AzureRM.TrafficManager/Remove-AzureRmTrafficManagerCustomHeaderFromProfile.md delete mode 100644 azurermps-6.13.0/AzureRM.TrafficManager/Remove-AzureRmTrafficManagerEndpoint.md delete mode 100644 azurermps-6.13.0/AzureRM.TrafficManager/Remove-AzureRmTrafficManagerEndpointConfig.md delete mode 100644 azurermps-6.13.0/AzureRM.TrafficManager/Remove-AzureRmTrafficManagerExpectedStatusCodeRange.md delete mode 100644 azurermps-6.13.0/AzureRM.TrafficManager/Remove-AzureRmTrafficManagerIpAddressRange.md delete mode 100644 azurermps-6.13.0/AzureRM.TrafficManager/Remove-AzureRmTrafficManagerProfile.md delete mode 100644 azurermps-6.13.0/AzureRM.TrafficManager/Set-AzureRmTrafficManagerEndpoint.md delete mode 100644 azurermps-6.13.0/AzureRM.TrafficManager/Set-AzureRmTrafficManagerProfile.md delete mode 100644 azurermps-6.13.0/AzureRM.UsageAggregates/AzureRM.UsageAggregates.md delete mode 100644 azurermps-6.13.0/AzureRM.UsageAggregates/Get-UsageAggregates.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/AzureRM.Websites.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Edit-AzureRmWebAppBackupConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Enter-AzureRmWebAppContainerPSSession.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Get-AzureRmAppServicePlan.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Get-AzureRmAppServicePlanMetrics.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Get-AzureRmDeletedWebApp.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebApp.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppBackup.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppBackupConfiguration.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppBackupList.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppCertificate.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppContainerContinuousDeploymentUrl.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppMetrics.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppPublishingProfile.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppSSLBinding.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppSlot.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppSlotConfigName.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppSlotMetrics.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppSlotPublishingProfile.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppSnapshot.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/New-AzureRmAppServicePlan.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/New-AzureRmWebApp.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/New-AzureRmWebAppBackup.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/New-AzureRmWebAppContainerPSSession.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/New-AzureRmWebAppDatabaseBackupSetting.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/New-AzureRmWebAppSSLBinding.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/New-AzureRmWebAppSlot.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Remove-AzureRmAppServicePlan.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Remove-AzureRmWebApp.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Remove-AzureRmWebAppBackup.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Remove-AzureRmWebAppSSLBinding.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Remove-AzureRmWebAppSlot.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Reset-AzureRmWebAppPublishingProfile.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Reset-AzureRmWebAppSlotPublishingProfile.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Restart-AzureRmWebApp.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Restart-AzureRmWebAppSlot.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Restore-AzureRmDeletedWebApp.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Restore-AzureRmWebAppBackup.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Restore-AzureRmWebAppSnapshot.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Set-AzureRmAppServicePlan.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Set-AzureRmWebApp.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Set-AzureRmWebAppSlot.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Set-AzureRmWebAppSlotConfigName.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Start-AzureRmWebApp.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Start-AzureRmWebAppSlot.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Stop-AzureRmWebApp.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Stop-AzureRmWebAppSlot.md delete mode 100644 azurermps-6.13.0/AzureRM.Websites/Switch-AzureRmWebAppSlot.md delete mode 100644 docs-conceptual/azurermps-6.13.0/authenticate-azureps.md delete mode 100644 docs-conceptual/azurermps-6.13.0/azureps-vm-tutorial.yml delete mode 100644 docs-conceptual/azurermps-6.13.0/context-persistence.md delete mode 100644 docs-conceptual/azurermps-6.13.0/create-azure-service-principal-azureps.md delete mode 100644 docs-conceptual/azurermps-6.13.0/faq.md delete mode 100644 docs-conceptual/azurermps-6.13.0/formatting-output.md delete mode 100644 docs-conceptual/azurermps-6.13.0/get-started-azureps.md delete mode 100644 docs-conceptual/azurermps-6.13.0/install-azurerm-ps.md delete mode 100644 docs-conceptual/azurermps-6.13.0/manage-subscriptions-azureps.md delete mode 100644 docs-conceptual/azurermps-6.13.0/migration-guide.6.0.0.md delete mode 100644 docs-conceptual/azurermps-6.13.0/other-install.md delete mode 100644 docs-conceptual/azurermps-6.13.0/overview.md delete mode 100644 docs-conceptual/azurermps-6.13.0/queries-azureps.md delete mode 100644 docs-conceptual/azurermps-6.13.0/release-notes-azureps.md delete mode 100644 docs-conceptual/azurermps-6.13.0/toc.yml delete mode 100644 docs-conceptual/azurermps-6.13.0/uninstall-azurerm-ps.md delete mode 100644 docs-conceptual/azurermps-6.13.0/using-experimental-modules.md delete mode 100644 docs-conceptual/azurermps-6.13.0/using-psjobs.md delete mode 100644 mapping/rm-groupMapping-6.13.0.json diff --git a/azurermps-6.13.0/Azure.AnalysisServices/Add-AzureAnalysisServicesAccount.md b/azurermps-6.13.0/Azure.AnalysisServices/Add-AzureAnalysisServicesAccount.md deleted file mode 100644 index 2c57e63721..0000000000 --- a/azurermps-6.13.0/Azure.AnalysisServices/Add-AzureAnalysisServicesAccount.md +++ /dev/null @@ -1,228 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AnalysisServices.Dataplane.dll-Help.xml -Module Name: Azure.AnalysisServices -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.analysisservices/add-azureanalysisservicesaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AnalysisServices/Commands.AnalysisServices.Dataplane/help/Add-AzureAnalysisServicesAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AnalysisServices/Commands.AnalysisServices.Dataplane/help/Add-AzureAnalysisServicesAccount.md ---- - -# Add-AzureAnalysisServicesAccount - -## SYNOPSIS -Adds an authenticated account to use for Azure Analysis Services server cmdlet requests. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### UserParameterSetName (Default) -``` -Add-AzureAnalysisServicesAccount [[-RolloutEnvironment] ] [[-Credential] ] [-WhatIf] - [-Confirm] [] -``` - -### ServicePrincipalWithPasswordParameterSetName -``` -Add-AzureAnalysisServicesAccount [-RolloutEnvironment] [-Credential] - [-ServicePrincipal] -TenantId [-WhatIf] [-Confirm] [] -``` - -### ServicePrincipalWithCertificateParameterSetName -``` -Add-AzureAnalysisServicesAccount [-RolloutEnvironment] [-ServicePrincipal] -TenantId - -ApplicationId -CertificateThumbprint [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Add-AzureAnalysisServicesAccount cmdlet is used to login to an instance of Azure Analysis Services server - -## EXAMPLES - -### Example 1 -``` -PS C:\>Add-AzureAnalysisServicesAccount -RolloutEnvironment: westcentralus.asazure.windows.net -Credential: $UserCredential -``` - -This example will add the account specified by the $UserCredential variable to the westcentralus.asazure.windows.net Analysis Services environment. - -### Example 2 -``` -PS C:\>$ApplicationCredential = Get-Credential -PS C:\>Add-AzureAnalysisServicesAccount -RolloutEnvironment 'westcentralus.asazure.windows.net' -ServicePrincipal -Credential $ApplicationCredential -TenantId "xxxx-xxxx-xxxx-xxxx" -``` - -The first command gets the application service principal credentials, and then stores them in the $ApplicationCredential variable. -The second command add the application service principal account specified by the $ApplicationCredential variable and TenantId to the westcentralus.asazure.windows.net Analysis Services environment. - -### Example 3 -``` -PS C:\>Add-AzureAnalysisServicesAccount -RolloutEnvironment 'westcentralus.asazure.windows.net' -ServicePrincipal -ApplicationId "yyyy-yyyy-yyyy-yyyy" -CertificateThumbprint 'zzzzzzzzzzzzzzzz' -TenantId "xxxx-xxxx-xxxx-xxxx" -``` - -This example will add the application service principal account specified by the ApplicationId, TenantId and CertificateThumbprint to the westcentralus.asazure.windows.net Analysis Services environment. - -## PARAMETERS - -### -ApplicationId -The application ID. - -```yaml -Type: System.String -Parameter Sets: ServicePrincipalWithCertificateParameterSetName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CertificateThumbprint -Certificate Hash (Thumbprint) - -```yaml -Type: System.String -Parameter Sets: ServicePrincipalWithCertificateParameterSetName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Login credentials - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: UserParameterSetName -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: ServicePrincipalWithPasswordParameterSetName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RolloutEnvironment -Name of the Azure Analysis Services environment to which to logon to. Given the full name of the server for example asazure://westcentralus.asazure.windows.net/testserver , the correct value for this variable will be westcentralus.asazure.windows.net - -```yaml -Type: System.String -Parameter Sets: UserParameterSetName -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ServicePrincipalWithPasswordParameterSetName, ServicePrincipalWithCertificateParameterSetName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServicePrincipal -Indicates that this account authenticates by providing service principal credentials. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ServicePrincipalWithPasswordParameterSetName, ServicePrincipalWithCertificateParameterSetName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TenantId -Tenant name or ID - -```yaml -Type: System.String -Parameter Sets: ServicePrincipalWithPasswordParameterSetName, ServicePrincipalWithCertificateParameterSetName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.AnalysisServices.Dataplane.AsAzureProfile - -## NOTES -Alias: Login-AzureAsAccount - -## RELATED LINKS diff --git a/azurermps-6.13.0/Azure.AnalysisServices/Azure.AnalysisServices.md b/azurermps-6.13.0/Azure.AnalysisServices/Azure.AnalysisServices.md deleted file mode 100644 index 1a49f11c38..0000000000 --- a/azurermps-6.13.0/Azure.AnalysisServices/Azure.AnalysisServices.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -Module Name: Azure.AnalysisServices -Module Guid: c717b5a4-1f1b-4a2f-8aa1-bfd09934626e -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azure.analysisservices -Help Version: 0.5.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AnalysisServices/Commands.AnalysisServices.Dataplane/help/Azure.AnalysisServices.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AnalysisServices/Commands.AnalysisServices.Dataplane/help/Azure.AnalysisServices.md ---- - -# Azure.AnalysisServices Module -## Description -This module contains commands for performing operations on a given Azure Analysis Services environment - -## Azure.AnalysisServices Cmdlets -### [Add-AzureAnalysisServicesAccount](Add-AzureAnalysisServicesAccount.md) -Adds an authenticated account to use for Azure Analysis Services server cmdlet requests. - -### [Export-AzureAnalysisServicesInstanceLog](Export-AzureAnalysisServicesInstanceLog.md) -Exports a log from an instance of Analysis Services server in the currently logged in Environment as specified in Add-AzureAnalysisServicesAccount command - -### [Restart-AzureAnalysisServicesInstance](Restart-AzureAnalysisServicesInstance.md) -Restarts an instance of Analysis Services server in the currently logged in Environment as specified in Add-AzureAnalysisServicesAccount command - -### [Sync-AzureAnalysisServicesInstance](Sync-AzureAnalysisServicesInstance.md) -Synchronizes a specified database on the specified instance of Analysis Services server to all the query scaleout instances in the currently logged in Environment as specified in Add-AzureAnalysisServicesAccount command - diff --git a/azurermps-6.13.0/Azure.AnalysisServices/Export-AzureAnalysisServicesInstanceLog.md b/azurermps-6.13.0/Azure.AnalysisServices/Export-AzureAnalysisServicesInstanceLog.md deleted file mode 100644 index 75765b2e2a..0000000000 --- a/azurermps-6.13.0/Azure.AnalysisServices/Export-AzureAnalysisServicesInstanceLog.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AnalysisServices.Dataplane.dll-Help.xml -Module Name: Azure.AnalysisServices -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.analysisservices/export-azureanalysisservicesinstancelog -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AnalysisServices/Commands.AnalysisServices.Dataplane/help/Export-AzureAnalysisServicesInstanceLog.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AnalysisServices/Commands.AnalysisServices.Dataplane/help/Export-AzureAnalysisServicesInstanceLog.md ---- - -# Export-AzureAnalysisServicesInstanceLog - -## SYNOPSIS -Exports a log from an instance of Analysis Services server in the currently logged in Environment as specified in Add-AzureAnalysisServicesAccount command - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Export-AzureAnalysisServicesInstanceLog -Instance -OutputPath [-Force] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The Export-AzureAnalysisServicesInstance cmdlet exports log from an instance of Azure Analysis Services server to file - -## EXAMPLES - -### Example 1 -``` -PS C:\>Export-AzureAnalysisServicesInstanceLog -Instance testserver -OuptutPath C:\path\to\log\testserver.log -``` - -This command will export log from the server 'testserver' in the environment specified in the Add-AzureAnalysisServicesAccount command -and save it to file specified in OutputPath 'C:\path\to\log\testserver.log' - -## PARAMETERS - -### -Force -Overwrite file if exists without asking - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Name of the Analysis Services server instance - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutputPath -Output path to file to export log - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Void - -## NOTES -Alias: Export-AzureAsInstanceLog - -## RELATED LINKS diff --git a/azurermps-6.13.0/Azure.AnalysisServices/Restart-AzureAnalysisServicesInstance.md b/azurermps-6.13.0/Azure.AnalysisServices/Restart-AzureAnalysisServicesInstance.md deleted file mode 100644 index 8a9f06352d..0000000000 --- a/azurermps-6.13.0/Azure.AnalysisServices/Restart-AzureAnalysisServicesInstance.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AnalysisServices.Dataplane.dll-Help.xml -Module Name: Azure.AnalysisServices -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.analysisservices/restart-azureanalysisservicesinstance -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AnalysisServices/Commands.AnalysisServices.Dataplane/help/Restart-AzureAnalysisServicesInstance.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AnalysisServices/Commands.AnalysisServices.Dataplane/help/Restart-AzureAnalysisServicesInstance.md ---- - -# Restart-AzureAnalysisServicesInstance - -## SYNOPSIS -Restarts an instance of Analysis Services server in the currently logged in Environment as specified in Add-AzureAnalysisServicesAccount command - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Restart-AzureAnalysisServicesInstance -Instance [-PassThru] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Restart-AzureAnalysisServicesInstance cmdlet restarts an instance of Azure Analysis Services server - -## EXAMPLES - -### Example 1 -``` -PS C:\>Restart-AzureAnalysisServicesInstance -Instance: testserver -``` - -This command will restart the server 'testserver' in the environment specified in the Add-AzureAnalysisServicesAccount command - -## PARAMETERS - -### -Instance -Name of the Analysis Services server instance to restart - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Specifying this will return true if the command was successful. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Boolean - -## NOTES -Alias: Restart-AzureAsInstance - -## RELATED LINKS diff --git a/azurermps-6.13.0/Azure.AnalysisServices/Sync-AzureAnalysisServicesInstance.md b/azurermps-6.13.0/Azure.AnalysisServices/Sync-AzureAnalysisServicesInstance.md deleted file mode 100644 index a57781c58a..0000000000 --- a/azurermps-6.13.0/Azure.AnalysisServices/Sync-AzureAnalysisServicesInstance.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AnalysisServices.Dataplane.dll-Help.xml -Module Name: Azure.AnalysisServices -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.analysisservices/sync-azureanalysisservicesinstance -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AnalysisServices/Commands.AnalysisServices.Dataplane/help/Sync-AzureAnalysisServicesInstance.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AnalysisServices/Commands.AnalysisServices.Dataplane/help/Sync-AzureAnalysisServicesInstance.md ---- - -# Sync-AzureAnalysisServicesInstance - -## SYNOPSIS - -Synchronizes a specified database on the specified instance of Analysis Services server to all the query scaleout instances in the currently logged in Environment as specified in Add-AzureAnalysisServicesAccount command - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Sync-AzureAnalysisServicesInstance [-Instance] [-Database] [-PassThru] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION - -The Sync-AzureAnalysisServicesInstance cmdlet synchronizes a specified database on the specified instance of Analysis Services server to all the query scaleout instances in the currently logged in Environment as specified in Add-AzureAnalysisServicesAccount command - -## EXAMPLES - -### Example 1 - -``` -PS C:\>Sync-AzureAnalysisServicesInstance -Instance asazure://westus.asazure.windows.net/contoso -Database SalesOrders -``` - -This command will synchronize the database named SalesOrders in the server named 'contoso' in the environment westus.asazure.windows.net provided the user has logged-in to this environment using Add-AzureAnalysisServicesAccount command. - -## PARAMETERS - -### -Database - -Identity of the database to be synchronized - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Instance - -Name of the Analysis Services server instance to restart - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru - -Specifying this will return true if the command was successful. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: Database (ByValue), Instance (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.AnalysisServices.Dataplane.Models.ScaleOutServerDatabaseSyncDetails - -## NOTES - -Alias: Sync-AzureAsInstance - -## RELATED LINKS diff --git a/azurermps-6.13.0/Azure.Storage/Azure.Storage.md b/azurermps-6.13.0/Azure.Storage/Azure.Storage.md deleted file mode 100644 index 7246d9e2ea..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Azure.Storage.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -Module Name: Azure.Storage -Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azure.storage -Help Version: 4.2.1.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Azure.Storage.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Azure.Storage.md ---- - -# Azure.Storage Module -## Description -This topic displays help topics for the Azure Storage Cmdlets. - -## Azure.Storage Cmdlets -### [Disable-AzureStorageDeleteRetentionPolicy](Disable-AzureStorageDeleteRetentionPolicy.md) -Disable delete retention policy for the Azure Storage Blob service. - -### [Disable-AzureStorageStaticWebsite](Disable-AzureStorageStaticWebsite.md) -Disable static website for the Azure Storage account. - -### [Enable-AzureStorageDeleteRetentionPolicy](Enable-AzureStorageDeleteRetentionPolicy.md) -Enable delete retention policy for the Azure Storage Blob service. - -### [Enable-AzureStorageStaticWebsite](Enable-AzureStorageStaticWebsite.md) -Enable static website for the Azure Storage account. - -### [Get-AzureStorageBlob](Get-AzureStorageBlob.md) -Lists blobs in a container. - -### [Get-AzureStorageBlobContent](Get-AzureStorageBlobContent.md) -Downloads a storage blob. - -### [Get-AzureStorageBlobCopyState](Get-AzureStorageBlobCopyState.md) -Gets the copy status of an Azure Storage blob. - -### [Get-AzureStorageContainer](Get-AzureStorageContainer.md) -Lists the storage containers. - -### [Get-AzureStorageContainerStoredAccessPolicy](Get-AzureStorageContainerStoredAccessPolicy.md) -Gets the stored access policy or policies for an Azure storage container. - -### [Get-AzureStorageCORSRule](Get-AzureStorageCORSRule.md) -Gets CORS rules for a Storage service type. - -### [Get-AzureStorageFile](Get-AzureStorageFile.md) -Lists directories and files for a path. - -### [Get-AzureStorageFileContent](Get-AzureStorageFileContent.md) -Downloads the contents of a file. - -### [Get-AzureStorageFileCopyState](Get-AzureStorageFileCopyState.md) -Gets the state of a copy operation. - -### [Get-AzureStorageQueue](Get-AzureStorageQueue.md) -Lists storage queues. - -### [Get-AzureStorageQueueStoredAccessPolicy](Get-AzureStorageQueueStoredAccessPolicy.md) -Gets the stored access policy or policies for an Azure storage queue. - -### [Get-AzureStorageServiceLoggingProperty](Get-AzureStorageServiceLoggingProperty.md) -Gets logging properties for Azure Storage services. - -### [Get-AzureStorageServiceMetricsProperty](Get-AzureStorageServiceMetricsProperty.md) -Gets metrics properties for the Azure Storage service. - -### [Get-AzureStorageServiceProperty](Get-AzureStorageServiceProperty.md) -Gets properties for Azure Storage services. - -### [Get-AzureStorageShare](Get-AzureStorageShare.md) -Gets a list of file shares. - -### [Get-AzureStorageShareStoredAccessPolicy](Get-AzureStorageShareStoredAccessPolicy.md) -Gets stored access policies for a Storage share. - -### [Get-AzureStorageTable](Get-AzureStorageTable.md) -Lists the storage tables. - -### [Get-AzureStorageTableStoredAccessPolicy](Get-AzureStorageTableStoredAccessPolicy.md) -Gets the stored access policy or policies for an Azure storage table. - -### [New-AzureStorageAccountSASToken](New-AzureStorageAccountSASToken.md) -Creates an account-level SAS token. - -### [New-AzureStorageBlobSASToken](New-AzureStorageBlobSASToken.md) -Generates a SAS token for an Azure storage blob. - -### [New-AzureStorageContainer](New-AzureStorageContainer.md) -Creates an Azure storage container. - -### [New-AzureStorageContainerSASToken](New-AzureStorageContainerSASToken.md) -Generates an SAS token for an Azure storage container. - -### [New-AzureStorageContainerStoredAccessPolicy](New-AzureStorageContainerStoredAccessPolicy.md) -Creates a stored access policy for an Azure storage container. - -### [New-AzureStorageContext](New-AzureStorageContext.md) -Creates an Azure Storage context. - -### [New-AzureStorageDirectory](New-AzureStorageDirectory.md) -Creates a directory. - -### [New-AzureStorageFileSASToken](New-AzureStorageFileSASToken.md) -Generates a shared access signature token for a Storage file. - -### [New-AzureStorageQueue](New-AzureStorageQueue.md) -Creates a storage queue. - -### [New-AzureStorageQueueSASToken](New-AzureStorageQueueSASToken.md) -Generates a shared access signature token for an Azure storage queue. - -### [New-AzureStorageQueueStoredAccessPolicy](New-AzureStorageQueueStoredAccessPolicy.md) -Creates a stored access policy for an Azure storage queue. - -### [New-AzureStorageShare](New-AzureStorageShare.md) -Creates a file share. - -### [New-AzureStorageShareSASToken](New-AzureStorageShareSASToken.md) -Generate Shared Access Signature token for Azure Storage share. - -### [New-AzureStorageShareStoredAccessPolicy](New-AzureStorageShareStoredAccessPolicy.md) -Creates a stored access policy on a Storage share. - -### [New-AzureStorageTable](New-AzureStorageTable.md) -Creates a storage table. - -### [New-AzureStorageTableSASToken](New-AzureStorageTableSASToken.md) -Generates an SAS token for an Azure Storage table. - -### [New-AzureStorageTableStoredAccessPolicy](New-AzureStorageTableStoredAccessPolicy.md) -Creates a stored access policy for an Azure storage table. - -### [Remove-AzureStorageBlob](Remove-AzureStorageBlob.md) -Removes the specified storage blob. - -### [Remove-AzureStorageContainer](Remove-AzureStorageContainer.md) -Removes the specified storage container. - -### [Remove-AzureStorageContainerStoredAccessPolicy](Remove-AzureStorageContainerStoredAccessPolicy.md) -Removes a stored access policy from an Azure storage container. - -### [Remove-AzureStorageCORSRule](Remove-AzureStorageCORSRule.md) -Removes CORS for a Storage service. - -### [Remove-AzureStorageDirectory](Remove-AzureStorageDirectory.md) -Deletes a directory. - -### [Remove-AzureStorageFile](Remove-AzureStorageFile.md) -Deletes a file. - -### [Remove-AzureStorageQueue](Remove-AzureStorageQueue.md) -Removes a storage queue. - -### [Remove-AzureStorageQueueStoredAccessPolicy](Remove-AzureStorageQueueStoredAccessPolicy.md) -Removes a stored access policy from an Azure storage queue. - -### [Remove-AzureStorageShare](Remove-AzureStorageShare.md) -Deletes a file share. - -### [Remove-AzureStorageShareStoredAccessPolicy](Remove-AzureStorageShareStoredAccessPolicy.md) -Removes a stored access policy from a Storage share. - -### [Remove-AzureStorageTable](Remove-AzureStorageTable.md) -Removes a storage table. - -### [Remove-AzureStorageTableStoredAccessPolicy](Remove-AzureStorageTableStoredAccessPolicy.md) -Removes a stored access policy from an Azure storage table. - -### [Set-AzureStorageBlobContent](Set-AzureStorageBlobContent.md) -Uploads a local file to an Azure Storage blob. - -### [Set-AzureStorageContainerAcl](Set-AzureStorageContainerAcl.md) -Sets the public access permission to a storage container. - -### [Set-AzureStorageContainerStoredAccessPolicy](Set-AzureStorageContainerStoredAccessPolicy.md) -Sets a stored access policy for an Azure storage container. - -### [Set-AzureStorageCORSRule](Set-AzureStorageCORSRule.md) -Sets the CORS rules for a type of Storage service. - -### [Set-AzureStorageFileContent](Set-AzureStorageFileContent.md) -Uploads the contents of a file. - -### [Set-AzureStorageQueueStoredAccessPolicy](Set-AzureStorageQueueStoredAccessPolicy.md) -Sets a stored access policy for an Azure storage queue. - -### [Set-AzureStorageServiceLoggingProperty](Set-AzureStorageServiceLoggingProperty.md) -Modifies logging for Azure Storage services. - -### [Set-AzureStorageServiceMetricsProperty](Set-AzureStorageServiceMetricsProperty.md) -Modifies metrics properties for the Azure Storage service. - -### [Set-AzureStorageShareQuota](Set-AzureStorageShareQuota.md) -Sets the storage capacity for a share. - -### [Set-AzureStorageShareStoredAccessPolicy](Set-AzureStorageShareStoredAccessPolicy.md) -Updates a stored access policy on a Storage share. - -### [Set-AzureStorageTableStoredAccessPolicy](Set-AzureStorageTableStoredAccessPolicy.md) -Sets the stored access policy for an Azure storage table. - -### [Start-AzureStorageBlobCopy](Start-AzureStorageBlobCopy.md) -Starts to copy a blob. - -### [Start-AzureStorageBlobIncrementalCopy](Start-AzureStorageBlobIncrementalCopy.md) -Start an Incremental copy operation from a Page blob snapshot to the specified destination Page blob. - -### [Start-AzureStorageFileCopy](Start-AzureStorageFileCopy.md) -Starts to copy a source file. - -### [Stop-AzureStorageBlobCopy](Stop-AzureStorageBlobCopy.md) -Stops a copy operation. - -### [Stop-AzureStorageFileCopy](Stop-AzureStorageFileCopy.md) -Stops a copy operation to the specified destination file. - -### [Update-AzureStorageServiceProperty](Update-AzureStorageServiceProperty.md) -Modifies the properties for the Azure Storage service. - diff --git a/azurermps-6.13.0/Azure.Storage/Disable-AzureStorageDeleteRetentionPolicy.md b/azurermps-6.13.0/Azure.Storage/Disable-AzureStorageDeleteRetentionPolicy.md deleted file mode 100644 index 2d141b2a70..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Disable-AzureStorageDeleteRetentionPolicy.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/disable-azurestoragedeleteretentionpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Disable-AzureStorageDeleteRetentionPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Disable-AzureStorageDeleteRetentionPolicy.md ---- - -# Disable-AzureStorageDeleteRetentionPolicy - -## SYNOPSIS -Disable delete retention policy for the Azure Storage Blob service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Disable-AzureStorageDeleteRetentionPolicy [-PassThru] [-Context ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Disable-AzureStorageDeleteRetentionPolicy** cmdlet disables delete retention policy for the Azure Storage Blob service. - -## EXAMPLES - -### Example 1: Disable delete retention policy for the Blob service -``` -C:\PS>Disable-AzureStorageDeleteRetentionPolicy -``` - -This command disables delete retention policy for the Blob service. - -## PARAMETERS - -### -Context -Azure Storage Context Object - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Display DeleteRetentionPolicyProperties - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Storage.Model.ResourceModel.PSDeleteRetentionPolicy - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/Azure.Storage/Enable-AzureStorageDeleteRetentionPolicy.md b/azurermps-6.13.0/Azure.Storage/Enable-AzureStorageDeleteRetentionPolicy.md deleted file mode 100644 index 1675a5ff48..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Enable-AzureStorageDeleteRetentionPolicy.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/enable-azurestoragedeleteretentionpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Enable-AzureStorageDeleteRetentionPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Enable-AzureStorageDeleteRetentionPolicy.md ---- - -# Enable-AzureStorageDeleteRetentionPolicy - -## SYNOPSIS -Enable delete retention policy for the Azure Storage Blob service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Enable-AzureStorageDeleteRetentionPolicy [-RetentionDays] [-PassThru] [-Context ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Enable-AzureStorageDeleteRetentionPolicy** cmdlet enables delete retention policy for the Azure Storage Blob service. - -## EXAMPLES - -### Example 1: Enable delete retention policy for the Blob service -``` -C:\PS>Enable-AzureStorageDeleteRetentionPolicy -RetentionDays 3 -``` - -This command enables delete retention policy for the Blob service, and sets deleted blob retention days to 3. - -## PARAMETERS - -### -Context -Azure Storage Context Object - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Display DeleteRetentionPolicyProperties - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionDays -Sets the number of retention days for the DeleteRetentionPolicy. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: Days - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Storage.Model.ResourceModel.PSDeleteRetentionPolicy - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageBlob.md b/azurermps-6.13.0/Azure.Storage/Get-AzureStorageBlob.md deleted file mode 100644 index 427a79cbdc..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageBlob.md +++ /dev/null @@ -1,299 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: E54BFD3A-CD54-4E6B-9574-92B8D3E88FF3 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestorageblob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageBlob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageBlob.md ---- - -# Get-AzureStorageBlob - -## SYNOPSIS -Lists blobs in a container. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### BlobName (Default) -``` -Get-AzureStorageBlob [[-Blob] ] [-Container] [-IncludeDeleted] [-MaxCount ] - [-ContinuationToken ] [-Context ] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [] -``` - -### BlobPrefix -``` -Get-AzureStorageBlob [-Prefix ] [-Container] [-IncludeDeleted] [-MaxCount ] - [-ContinuationToken ] [-Context ] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [] -``` - -## DESCRIPTION -The **Get-AzureStorageBlob** cmdlet lists blob in the specified container in an Azure storage account. - -## EXAMPLES - -### Example 1: Get a blob by blob name -``` -PS C:\>Get-AzureStorageBlob -Container "ContainerName" -Blob blob* -``` - -This command uses a blob name and wildcard to get a blob. - -### Example 2: Get blobs in a container by using the pipeline -``` -PS C:\>Get-AzureStorageContainer -Name container* | Get-AzureStorageBlob -IncludeDeleted - - Container Uri: https://storageaccountname.blob.core.windows.net/container1 - -Name BlobType Length ContentType LastModified AccessTier SnapshotTime IsDeleted ----- -------- ------ ----------- ------------ ---------- ------------ --------- -test1 BlockBlob 403116 application/octet-stream 2017-11-08 07:53:19Z 2017-11-08 08:19:32Z True -test1 BlockBlob 403116 application/octet-stream 2017-11-08 09:00:29Z True -test2 BlockBlob 403116 application/octet-stream 2017-11-08 07:53:00Z False -``` - -This command uses the pipeline to get all blobs (include blobs in Deleted status) in a container. - -### Example 3: Get blobs by name prefix -``` -PS C:\>Get-AzureStorageBlob -Container "ContainerName" -Prefix "blob" -``` - -This command uses a name prefix to get blobs. - -### Example 4: List blobs in multiple batches -``` -PS C:\>$MaxReturn = 10000 -PS C:\> $ContainerName = "abc" -PS C:\> $Total = 0 -PS C:\> $Token = $Null -PS C:\> do - { - $Blobs = Get-AzureStorageBlob -Container $ContainerName -MaxCount $MaxReturn -ContinuationToken $Token - $Total += $Blobs.Count - if($Blobs.Length -le 0) { Break;} - $Token = $Blobs[$blobs.Count -1].ContinuationToken; - } - While ($Token -ne $Null) -PS C:\> Echo "Total $Total blobs in container $ContainerName" -``` - -This example uses the *MaxCount* and *ContinuationToken* parameters to list Azure Storage blobs in multiple batches. -The first four commands assign values to variables to use in the example. -The fifth command specifies a **Do-While** statement that uses the **Get-AzureStorageBlob** cmdlet to get blobs. -The statement includes the continuation token stored in the $Token variable. -$Token changes value as the loop runs. -For more information, type `Get-Help About_Do`. -The final command uses the **Echo** command to display the total. - -## PARAMETERS - -### -Blob -Specifies a name or name pattern, which can be used for a wildcard search. -If no blob name is specified, the cmdlet lists all the blobs in the specified container. -If a value is specified for this parameter, the cmdlet lists all blobs with names that match this parameter. - -```yaml -Type: System.String -Parameter Sets: BlobName -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Container -Specifies the name of the container. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Specifies the Azure storage account from which you want to get a list of blobs. -You can use the New-AzureStorageContext cmdlet to create a storage context. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ContinuationToken -Specifies a continuation token for the blob list. -Use this parameter and the *MaxCount* parameter to list blobs in multiple batches. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.BlobContinuationToken -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDeleted -Include Deleted Blob, by default get blob won't include deleted blob. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxCount -Specifies the maximum number of objects that this cmdlet returns. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Prefix -Specifies a prefix for the blob names that you want to get. -This parameter does not support using regular expressions or wildcard characters to search. -This means that if the container has only blobs named "My", "MyBlob1", and "MyBlob2" and you specify "-Prefix My*", the cmdlet returns no blobs. -However, if you specify "-Prefix My", the cmdlet returns "My", "MyBlob1", and "MyBlob2". - -```yaml -Type: System.String -Parameter Sets: BlobPrefix -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the service side time-out interval, in seconds, for a request. -If the specified interval elapses before the service processes the request, the storage service returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageBlob - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageBlobContent](./Get-AzureStorageBlobContent.md) - -[Remove-AzureStorageBlob](./Remove-AzureStorageBlob.md) - -[Set-AzureStorageBlobContent](./Set-AzureStorageBlobContent.md) - - diff --git a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageBlobContent.md b/azurermps-6.13.0/Azure.Storage/Get-AzureStorageBlobContent.md deleted file mode 100644 index fbaf303110..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageBlobContent.md +++ /dev/null @@ -1,319 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: C091D654-E113-4AE0-A6C8-24630D1294A4 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestorageblobcontent -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageBlobContent.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageBlobContent.md ---- - -# Get-AzureStorageBlobContent - -## SYNOPSIS -Downloads a storage blob. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ReceiveManual (Default) -``` -Get-AzureStorageBlobContent [-Blob] [-Container] [-Destination ] [-CheckMd5] [-Force] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### BlobPipeline -``` -Get-AzureStorageBlobContent -CloudBlob [-Destination ] [-CheckMd5] [-Force] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### ContainerPipeline -``` -Get-AzureStorageBlobContent -CloudBlobContainer [-Blob] [-Destination ] - [-CheckMd5] [-Force] [-Context ] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Get-AzureStorageBlobContent** cmdlet downloads the specified storage blob. -If the blob name is not valid for the local computer, this cmdlet automatically resolves it if it is possible. - -## EXAMPLES - -### Example 1: Download blob content by name -``` -PS C:\>Get-AzureStorageBlobContent -Container "ContainerName" -Blob "Blob" -Destination "C:\test\" -``` - -This command downloads a blob by name. - -### Example 2: Download blob content using the pipeline -``` -PS C:\>Get-AzureStorageBlob -Container containername -Blob blobname | Get-AzureStorageBlobContent -``` - -This command uses the pipeline to find and download blob content. - -### Example 3: Download blob content using the pipeline and a wildcard character -``` -PS C:\>Get-AzureStorageContainer container* | Get-AzureStorageBlobContent -Blob "cbox.exe" -Destination "C:\test" -``` - -This example uses the asterisk wildcard character and the pipeline to find and download blob content. - -## PARAMETERS - -### -Blob -Specifies the name of the blob to be downloaded. - -```yaml -Type: System.String -Parameter Sets: ReceiveManual, ContainerPipeline -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CheckMd5 -Specifies whether to check the Md5 sum for the downloaded file. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CloudBlob -Specifies a cloud blob. -To obtain a **CloudBlob** object, use the Get-AzureStorageBlob cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudBlob -Parameter Sets: BlobPipeline -Aliases: ICloudBlob - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CloudBlobContainer -Specifies a **CloudBlobContainer** object from the Azure storage client library. -You can create it or use the Get-AzureStorageContainer cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudBlobContainer -Parameter Sets: ContainerPipeline -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Container -Specifies the name of container that has the blob you want to download. - -```yaml -Type: System.String -Parameter Sets: ReceiveManual -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies the Azure storage account from which you want to download blob content. -You can use the New-AzureStorageContext cmdlet to create a storage context. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Destination -Specifies the location to store the downloaded file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Path - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Overwrites an existing file without confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the service side time-out interval, in seconds, for a request. -If the specified interval elapses before the service processes the request, the storage service returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.WindowsAzure.Storage.Blob.CloudBlob - -### Microsoft.WindowsAzure.Storage.Blob.CloudBlobContainer - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageBlob - -## NOTES -* If the blob name is invalid for local computer, this cmdlet autoresolves it, if it is possible. - -## RELATED LINKS - -[Set-AzureStorageBlobContent](./Set-AzureStorageBlobContent.md) - -[Get-AzureStorageBlob](./Get-AzureStorageBlob.md) - -[Remove-AzureStorageBlob](./Remove-AzureStorageBlob.md) diff --git a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageBlobCopyState.md b/azurermps-6.13.0/Azure.Storage/Get-AzureStorageBlobCopyState.md deleted file mode 100644 index 2514d1626b..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageBlobCopyState.md +++ /dev/null @@ -1,258 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: CBD157D2-37C5-491F-A806-6B39F1D0415A -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestorageblobcopystate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageBlobCopyState.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageBlobCopyState.md ---- - -# Get-AzureStorageBlobCopyState - -## SYNOPSIS -Gets the copy status of an Azure Storage blob. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NamePipeline (Default) -``` -Get-AzureStorageBlobCopyState [-Blob] [-Container] [-WaitForComplete] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -### BlobPipeline -``` -Get-AzureStorageBlobCopyState -CloudBlob [-WaitForComplete] [-Context ] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -### ContainerPipeline -``` -Get-AzureStorageBlobCopyState -CloudBlobContainer [-Blob] [-WaitForComplete] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -## DESCRIPTION -The **Get-AzureStorageBlobCopyState** cmdlet gets the copy status of an Azure Storage blob. - -## EXAMPLES - -### Example 1: Get the copy status of a blob -``` -C:\PS>Get-AzureStorageBlobCopyState -Blob "ContosoPlanning2015" -Container "ContosoUploads" -``` - -This command gets the copy status of the blob named ContosoPlanning2015 in the container ContosoUploads. - -### Example 2: Get the copy status for of a blob by using the pipeline -``` -C:\PS>Get-AzureStorageBlob -Blob "ContosoPlanning2015" -Container "ContosoUploads" | Get-AzureStorageBlobCopyState -``` - -This command gets the blob named ContosoPlanning2015 in the container named ContosoUploads by using the **Get-AzureStorageBlob** cmdlet, and then passes the result to the current cmdlet by using the pipeline operator. -The **Get-AzureStorageBlobCopyState** cmdlet gets the copy status for that blob. - -### Example 3: Get the copy status for a blob in a container by using the pipeline -``` -C:\PS>Get-AzureStorageContainer -Name "ContosoUploads" | Get-AzureStorageBlobCopyState -Blob "ContosoPlanning2015" -``` - -This command gets the container named by using the **Get-AzureStorageBlob** cmdlet, and then passes the result to the current cmdlet. -The **Get-AzureStorageContainer** cmdlet gets the copy status for the blob named ContosoPlanning2015 in that container. - -## PARAMETERS - -### -Blob -Specifies the name of a blob. -This cmdlet gets the state of the blob copy operation for the Azure Storage blob that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: NamePipeline, ContainerPipeline -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CloudBlob -Specifies a **CloudBlob** object from Azure Storage Client library. -To obtain a **CloudBlob** object, use the Get-AzureStorageBlob cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudBlob -Parameter Sets: BlobPipeline -Aliases: ICloudBlob - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CloudBlobContainer -Specifies a **CloudBlobContainer** object from the Azure Storage Client library. -This cmdlet gets the copy status of a blob in the container that this parameter specifies. -To obtain a **CloudBlobContainer** object, use the Get-AzureStorageContainer cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudBlobContainer -Parameter Sets: ContainerPipeline -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Container -Specifies the name of a container. -This cmdlet gets the copy status for a blob in the container that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: NamePipeline -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the service side time-out interval, in seconds, for a request. -If the specified interval elapses before the service processes the request, the storage service returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WaitForComplete -Indicates that this cmdlet waits for the copy to finish. -If you do not specify this parameter, this cmdlet returns a result immediately. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.WindowsAzure.Storage.Blob.CloudBlob - -### Microsoft.WindowsAzure.Storage.Blob.CloudBlobContainer - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageBlob - -## NOTES - -## RELATED LINKS - -[Start-AzureStorageBlobCopy](./Start-AzureStorageBlobCopy.md) - -[Stop-AzureStorageBlobCopy](./Stop-AzureStorageBlobCopy.md) - - diff --git a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageCORSRule.md b/azurermps-6.13.0/Azure.Storage/Get-AzureStorageCORSRule.md deleted file mode 100644 index 57627223cf..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageCORSRule.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 5FA8A3F3-F52C-40BC-94C2-4CDA00C6F32F -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestoragecorsrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageCORSRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageCORSRule.md ---- - -# Get-AzureStorageCORSRule - -## SYNOPSIS -Gets CORS rules for a Storage service type. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureStorageCORSRule [-ServiceType] [-Context ] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -## DESCRIPTION -The **Get-AzureStorageCORSRule** cmdlet gets Cross-Origin Resource Sharing (CORS) rules for an Azure Storage service type. - -## EXAMPLES - -### Example 1: Get CORS rules of blob service -``` -PS C:\>Get-AzureStorageCORSRule -ServiceType Blob -``` - -This command gets the CORS rules for the Blob service type. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure Storage context. -To obtain a context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceType -Specifies the Azure Storage service type for which this cmdlet gets CORS rules. -The acceptable values for this parameter are: -- Blob -- Table -- Queue -- File - -```yaml -Type: Microsoft.WindowsAzure.Commands.Storage.Common.StorageServiceType -Parameter Sets: (All) -Aliases: -Accepted values: Blob, Table, Queue, File - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Storage.Model.ResourceModel.PSCorsRule - -## NOTES - -## RELATED LINKS - -[Remove-AzureStorageCORSRule](./Remove-AzureStorageCORSRule.md) - -[Set-AzureStorageCORSRule](./Set-AzureStorageCORSRule.md) - - diff --git a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageContainer.md b/azurermps-6.13.0/Azure.Storage/Get-AzureStorageContainer.md deleted file mode 100644 index fe6ef655d8..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageContainer.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 90C3DF13-0010-49B6-A8CD-C6AC34BC3EFA -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestoragecontainer -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageContainer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageContainer.md ---- - -# Get-AzureStorageContainer - -## SYNOPSIS -Lists the storage containers. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ContainerName (Default) -``` -Get-AzureStorageContainer [[-Name] ] [-MaxCount ] [-ContinuationToken ] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -### ContainerPrefix -``` -Get-AzureStorageContainer -Prefix [-MaxCount ] [-ContinuationToken ] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -## DESCRIPTION -The **Get-AzureStorageContainer** cmdlet lists the storage containers associated with the storage account in Azure. - -## EXAMPLES - -### Example 1: Get Azure Storage blob by name -``` -PS C:\>Get-AzureStorageContainer -Name container* -``` - -This example uses a wildcard character to return a list of all containers with a name that starts with container. - -### Example 2: Get Azure Storage container by container name prefix -``` -PS C:\>Get-AzureStorageContainer -Prefix "container" -``` - -This example uses the *Prefix* parameter to return a list of all containers with a name that starts with container. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies the storage context. -To create it, you can use the New-AzureStorageContext cmdlet. -The container permissions won't be retrieved when you use a storage context created from SAS Token, because query container permissions requires Storage account key permission. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ContinuationToken -Specifies a continuation token for the blob list. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.BlobContinuationToken -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxCount -Specifies the maximum number of objects that this cmdlet returns. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the container name. -If container name is empty, the cmdlet lists all the containers. -Otherwise, it lists all containers that match the specified name or the regular name pattern. - -```yaml -Type: System.String -Parameter Sets: ContainerName -Aliases: N, Container - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Prefix -Specifies a prefix used in the name of the container or containers you want to get. -You can use this to find all containers that start with the same string, such as "my" or "test". - -```yaml -Type: System.String -Parameter Sets: ContainerPrefix -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the service side time-out interval, in seconds, for a request. -If the specified interval elapses before the service processes the request, the storage service returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageContainer - -## NOTES - -## RELATED LINKS - -[New-AzureStorageContainer](./New-AzureStorageContainer.md) - -[Remove-AzureStorageContainer](./Remove-AzureStorageContainer.md) - -[Set-AzureStorageContainerAcl](./Set-AzureStorageContainerAcl.md) - - diff --git a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageContainerStoredAccessPolicy.md b/azurermps-6.13.0/Azure.Storage/Get-AzureStorageContainerStoredAccessPolicy.md deleted file mode 100644 index 41d8c974d0..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageContainerStoredAccessPolicy.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 10D5B7E0-242B-4DC0-A527-8F6388E72E0A -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestoragecontainerstoredaccesspolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageContainerStoredAccessPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageContainerStoredAccessPolicy.md ---- - -# Get-AzureStorageContainerStoredAccessPolicy - -## SYNOPSIS -Gets the stored access policy or policies for an Azure storage container. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureStorageContainerStoredAccessPolicy [-Container] [[-Policy] ] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -## DESCRIPTION -The **Get-AzureStorageContainerStoredAccessPolicy** cmdlet lists the stored access policy or policies for an Azure storage container. - -## EXAMPLES - -### Example 1: Get a stored access policy in a storage container -``` -PS C:\>Get-AzureStorageContainerStoredAccessPolicy -Container "Container07" -Policy "Policy22" -``` - -This command gets the access policy named Policy22 in the storage container named Container07. - -### Example 2: Get all the stored access policies in a storage container -``` -PS C:\>Get-AzureStorageContainerStoredAccessPolicy -Container "Container07" -``` - -This command gets all access policies in the storage container named Container07. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Container -Specifies the name of your Azure storage container. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Context -Specifies the Azure storage context. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies the Azure stored access policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the service side time-out interval, in seconds, for a request. -If the specified interval elapses before the service processes the request, the storage service returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.Blob.SharedAccessBlobPolicy - -## NOTES - -## RELATED LINKS - -[New-AzureStorageContainerStoredAccessPolicy](./New-AzureStorageContainerStoredAccessPolicy.md) - -[Remove-AzureStorageContainerStoredAccessPolicy](./Remove-AzureStorageContainerStoredAccessPolicy.md) - -[Set-AzureStorageContainerStoredAccessPolicy](./Set-AzureStorageContainerStoredAccessPolicy.md) - - diff --git a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageFile.md b/azurermps-6.13.0/Azure.Storage/Get-AzureStorageFile.md deleted file mode 100644 index e931ee3eab..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageFile.md +++ /dev/null @@ -1,251 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 38207027-FD76-45EE-8817-88599735C0B0 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestoragefile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageFile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageFile.md ---- - -# Get-AzureStorageFile - -## SYNOPSIS -Lists directories and files for a path. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ShareName (Default) -``` -Get-AzureStorageFile [-ShareName] [[-Path] ] [-Context ] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -### Share -``` -Get-AzureStorageFile [-Share] [[-Path] ] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [] -``` - -### Directory -``` -Get-AzureStorageFile [-Directory] [[-Path] ] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [] -``` - -## DESCRIPTION -The **Get-AzureStorageFile** cmdlet lists directories and files for the share or directory that you specify. -Specify the *Path* parameter to get an instance of a directory or file in the specified path. -This cmdlet returns **AzureStorageFile** and **AzureStorageDirectory** objects. -You can use the **IsDirectory** property to distinguish between folders and files. - -## EXAMPLES - -### Example 1: List directories in a share -``` -PS C:\>Get-AzureStorageFile -ShareName "ContosoShare06" | where {$_.GetType().Name -eq "CloudFileDirectory"} -``` - -This command lists only the directories in the share ContosoShare06. -It first retrieves both files and directories, passes them to the **where** operator by using the pipeline operator, then discards any objects whose type is not "CloudFileDirectory". - -### Example 2: List a File Directory -``` -PS C:\> Get-AzureStorageFile -ShareName "ContosoShare06" -Path "ContosoWorkingFolder" | Get-AzureStorageFile -``` - -This command lists the files and folders in the directory ContosoWorkingFolder under the share ContosoShare06. -It first gets the directory instance, and then pipelines it to the **Get-AzureStorageFile** cmdlet to list the directory. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client side time-out interval, in seconds, for one service request. -If the previous call fails within the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help mitigate network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure Storage context. -To obtain a Storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: ShareName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Directory -Specifies a folder as a **CloudFileDirectory** object. -This cmdlet gets the folder that this parameter specifies. -To obtain a directory, use the New-AzureStorageDirectory cmdlet. -You can also use the **Get-AzureStorageFile** cmdlet to obtain a directory. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFileDirectory -Parameter Sets: Directory -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Path -Specifies the path of a folder. -If you omit the *Path* parameter, **Get-AzureStorageFile** lists the directories and files in the specified file share or directory. -If you include the *Path* parameter, **Get-AzureStorageFile** returns an instance of a directory or file in the specified path. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the service-side timeout interval, in seconds, for a request. -If the specified interval elapses before the service processes the request, the Storage service returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Share -Specifies a **CloudFileShare** object. -This cmdlet gets a file or directory from the file share that this parameter specifies. -To obtain a **CloudFileShare** object, use the Get-AzureStorageShare cmdlet. -This object contains the Storage context. -If you specify this parameter, do not specify the *Context* parameter. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameter Sets: Share -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ShareName -Specifies the name of the file share. -This cmdlet gets a file or directory from the file share that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ShareName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameters: Share (ByValue) - -### Microsoft.WindowsAzure.Storage.File.CloudFileDirectory -Parameters: Directory (ByValue) - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFile - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageFileContent](./Get-AzureStorageFileContent.md) - -[New-AzureStorageDirectory](./New-AzureStorageDirectory.md) - -[Remove-AzureStorageDirectory](./Remove-AzureStorageDirectory.md) - -[Remove-AzureStorageFile](./Remove-AzureStorageFile.md) - -[Set-AzureStorageFileContent](./Set-AzureStorageFileContent.md) - - diff --git a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageFileContent.md b/azurermps-6.13.0/Azure.Storage/Get-AzureStorageFileContent.md deleted file mode 100644 index 7d7c1f9c86..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageFileContent.md +++ /dev/null @@ -1,381 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 6420CBE1-BF9D-493D-BCA8-E8C6688FAF3B -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestoragefilecontent -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageFileContent.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageFileContent.md ---- - -# Get-AzureStorageFileContent - -## SYNOPSIS -Downloads the contents of a file. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ShareName (Default) -``` -Get-AzureStorageFileContent [-ShareName] [-Path] [[-Destination] ] [-CheckMd5] - [-PassThru] [-Force] [-Context ] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -### Share -``` -Get-AzureStorageFileContent [-Share] [-Path] [[-Destination] ] [-CheckMd5] - [-PassThru] [-Force] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### Directory -``` -Get-AzureStorageFileContent [-Directory] [-Path] [[-Destination] ] - [-CheckMd5] [-PassThru] [-Force] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### File -``` -Get-AzureStorageFileContent [-File] [[-Destination] ] [-CheckMd5] [-PassThru] [-Force] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Get-AzureStorageFileContent** cmdlet downloads the contents of a file, and then saves it to a destination that you specify. -This cmdlet does not return the contents of the file. - -## EXAMPLES - -### Example 1: Download a file from a folder -``` -PS C:\>Get-AzureStorageFileContent -ShareName "ContosoShare06" -Path "ContosoWorkingFolder/CurrentDataFile" -``` - -This command downloads a file that is named CurrentDataFile in the folder ContosoWorkingFolder from the file share ContosoShare06 to current folder. - -### Example 2: Download the files under sample file share -``` -PS C:\>Get-AzureStorageFile -ShareName sample | ? {$_.GetType().Name -eq "CloudFile"} | Get-AzureStorageFileContent -``` - -This example downloads the files under sample file share - -## PARAMETERS - -### -CheckMd5 -If you specify the path of a file that does not exist, this cmdlet creates that file, and saves the contents in the new file. -If you specify a path of a file that already exists and you specify the *Force* parameter, the cmdlet overwrites the file. -If you specify a path of an existing file and you do not specify *Force*, the cmdlet prompts you before it continues. -If you specify the path of a folder, this cmdlet attempts to create a file that has the name of the Azure storage file. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientTimeoutPerRequest -If you specify the path of a file that does not exist, this cmdlet creates that file, and saves the contents in the new file. -If you specify a path of a file that already exists and you specify the *Force* parameter, the cmdlet overwrites the file. -If you specify a path of an existing file and you do not specify *Force*, the cmdlet prompts you before it continues. -If you specify the path of a folder, this cmdlet attempts to create a file that has the name of the Azure storage file. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -If you specify the path of a file that does not exist, this cmdlet creates that file, and saves the contents in the new file. -If you specify a path of a file that already exists and you specify the *Force* parameter, the cmdlet overwrites the file. -If you specify a path of an existing file and you do not specify *Force*, the cmdlet prompts you before it continues. -If you specify the path of a folder, this cmdlet attempts to create a file that has the name of the Azure storage file. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -If you specify the path of a file that does not exist, this cmdlet creates that file, and saves the contents in the new file. -If you specify a path of a file that already exists and you specify the *Force* parameter, the cmdlet overwrites the file. -If you specify a path of an existing file and you do not specify *Force*, the cmdlet prompts you before it continues. -If you specify the path of a folder, this cmdlet attempts to create a file that has the name of the Azure storage file. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: ShareName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Destination -Specifies the destination path. -This cmdlet downloads the file contents to the location that this parameter specifies. -If you specify the path of a file that does not exist, this cmdlet creates that file, and saves the contents in the new file. -If you specify a path of a file that already exists and you specify the *Force* parameter, the cmdlet overwrites the file. -If you specify a path of an existing file and you do not specify *Force*, the cmdlet prompts you before it continues. -If you specify the path of a folder, this cmdlet attempts to create a file that has the name of the Azure storage file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Directory -Specifies a folder as a **CloudFileDirectory** object. -This cmdlet gets content for a file in the folder that this parameter specifies. -To obtain a directory, use the New-AzureStorageDirectory cmdlet. -You can also use the Get-AzureStorageFile cmdlet to obtain a directory. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFileDirectory -Parameter Sets: Directory -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -File -Specifies a file as a **CloudFile** object. -This cmdlet gets the file that this parameter specifies. -To obtain a **CloudFile** object, use the Get-AzureStorageFile cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFile -Parameter Sets: File -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Force -If you specify the path of a file that does not exist, this cmdlet creates that file, and saves the contents in the new file. -If you specify a path of a file that already exists and you specify the *Force* parameter, the cmdlet overwrites the file. -If you specify a path of an existing file and you do not specify *Force*, the cmdlet prompts you before it continues. -If you specify the path of a folder, this cmdlet attempts to create a file that has the name of the Azure storage file. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -If you specify the path of a file that does not exist, this cmdlet creates that file, and saves the contents in the new file. -If you specify a path of a file that already exists and you specify the *Force* parameter, the cmdlet overwrites the file. -If you specify a path of an existing file and you do not specify *Force*, the cmdlet prompts you before it continues. -If you specify the path of a folder, this cmdlet attempts to create a file that has the name of the Azure storage file. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path of a file. -This cmdlet gets the contents the file that this parameter specifies. -If the file does not exist, this cmdlet returns an error. - -```yaml -Type: System.String -Parameter Sets: ShareName, Share, Directory -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -If you specify the path of a file that does not exist, this cmdlet creates that file, and saves the contents in the new file. -If you specify a path of a file that already exists and you specify the *Force* parameter, the cmdlet overwrites the file. -If you specify a path of an existing file and you do not specify *Force*, the cmdlet prompts you before it continues. -If you specify the path of a folder, this cmdlet attempts to create a file that has the name of the Azure storage file. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Share -Specifies a **CloudFileShare** object. -This cmdlet downloads the contents of the file in the share this parameter specifies. -To obtain a **CloudFileShare** object, use the Get-AzureStorageShare cmdlet. -This object contains the storage context. -If you specify this parameter, do not specify the *Context* parameter. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameter Sets: Share -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ShareName -Specifies the name of the file share. -This cmdlet downloads the contents of the file in the share this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ShareName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameters: Share (ByValue) - -### Microsoft.WindowsAzure.Storage.File.CloudFileDirectory -Parameters: Directory (ByValue) - -### Microsoft.WindowsAzure.Storage.File.CloudFile -Parameters: File (ByValue) - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFile - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageFile](./Get-AzureStorageFile.md) - -[Set-AzureStorageFileContent](./Set-AzureStorageFileContent.md) - - diff --git a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageFileCopyState.md b/azurermps-6.13.0/Azure.Storage/Get-AzureStorageFileCopyState.md deleted file mode 100644 index 5bedabc1e7..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageFileCopyState.md +++ /dev/null @@ -1,216 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: C1648DC3-8CFD-4487-A080-D9BE25DAD258 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestoragefilecopystate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageFileCopyState.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageFileCopyState.md ---- - -# Get-AzureStorageFileCopyState - -## SYNOPSIS -Gets the state of a copy operation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ShareName -``` -Get-AzureStorageFileCopyState [-ShareName] [-FilePath] [-WaitForComplete] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -### File -``` -Get-AzureStorageFileCopyState [-File] [-WaitForComplete] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [] -``` - -## DESCRIPTION -The **Get-AzureStorageFileCopyState** cmdlet gets the state of an Azure Storage file copy operation. - -## EXAMPLES - -### Example 1: Get the copy state by file name -``` -PS C:\>Get-AzureStorageFileCopyState -ShareName "ContosoShare" -FilePath "ContosoFile" -``` - -This command gets the state of the copy operation for a file that has the specified name. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure Storage context. -To obtain a context, use the [New-AzureStorageContext](./New-AzureStorageContext.md) cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: ShareName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -File -Specifies a **CloudFile** object. -You can create a cloud file or obtain one by using the Get-AzureStorageFile cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFile -Parameter Sets: File -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -FilePath -Specifies the path of the file relative to an Azure Storage share. - -```yaml -Type: System.String -Parameter Sets: ShareName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShareName -Specifies the name of a share. - -```yaml -Type: System.String -Parameter Sets: ShareName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WaitForComplete -Indicates that this cmdlet waits for the copy to finish. -If you do not specify this parameter, this cmdlet returns a result immediately. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFile -Parameters: File (ByValue) - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFile - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageFile](./Get-AzureStorageFile.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[Start-AzureStorageFileCopy](./Start-AzureStorageFileCopy.md) - -[Stop-AzureStorageFileCopy](./Stop-AzureStorageFileCopy.md) diff --git a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageQueue.md b/azurermps-6.13.0/Azure.Storage/Get-AzureStorageQueue.md deleted file mode 100644 index 407ffaac49..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageQueue.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: C2EBCCF0-56CE-4D49-A138-74E52FC3A9AC -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestoragequeue -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageQueue.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageQueue.md ---- - -# Get-AzureStorageQueue - -## SYNOPSIS -Lists storage queues. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### QueueName (Default) -``` -Get-AzureStorageQueue [[-Name] ] [-Context ] - [-DefaultProfile ] [] -``` - -### QueuePrefix -``` -Get-AzureStorageQueue -Prefix [-Context ] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Get-AzureStorageQueue** cmdlet lists storage queues associated with an Azure Storage account. - -## EXAMPLES - -### Example 1: List all Azure Storage queues -``` -PS C:\>Get-AzureStorageQueue -``` - -This command gets a list of all storage queues for the current Storage account. - -### Example 2: List Azure Storage queues using a wildcard character -``` -PS C:\>Get-AzureStorageQueue -Name queue* -``` - -This command uses a wildcard character to get a list of storage queues whose name starts with queue. - -### Example 3: List Azure Storage queues using queue name prefix -``` -PS C:\>Get-AzureStorageQueue -Prefix "queue" -``` - -This example uses the *Prefix* parameter to get a list of storage queues whose name starts with queue. - -## PARAMETERS - -### -Context -Specifies the Azure storage context. -You can create it by using the **New-AzureStorageContext** cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name. -If no name is specified, the cmdlet gets a list of all the queues. -If a full or partial name is specified, the cmdlet gets all queues that match the name pattern. - -```yaml -Type: System.String -Parameter Sets: QueueName -Aliases: N, Queue - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Prefix -Specifies a prefix used in the name of the queues you want to get. - -```yaml -Type: System.String -Parameter Sets: QueuePrefix -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageQueue - -## NOTES - -## RELATED LINKS - -[New-AzureStorageQueue](./New-AzureStorageQueue.md) - -[Remove-AzureStorageQueue](./Remove-AzureStorageQueue.md) - - diff --git a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageQueueStoredAccessPolicy.md b/azurermps-6.13.0/Azure.Storage/Get-AzureStorageQueueStoredAccessPolicy.md deleted file mode 100644 index ffbbba19b8..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageQueueStoredAccessPolicy.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: F1EC601C-3ADD-402A-A5F7-84A95D312187 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestoragequeuestoredaccesspolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageQueueStoredAccessPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageQueueStoredAccessPolicy.md ---- - -# Get-AzureStorageQueueStoredAccessPolicy - -## SYNOPSIS -Gets the stored access policy or policies for an Azure storage queue. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureStorageQueueStoredAccessPolicy [-Queue] [[-Policy] ] [-Context ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureStorageQueueStoredAccessPolicy** cmdlet lists the stored access policy or policies for an Azure storage queue. - -## EXAMPLES - -### Example 1: Get a stored access policy in the queue -``` -PS C:\>Get-AzureStorageQueueStoredAccessPolicy -Queue "MyQueue" -Policy "Policy12" -``` - -This command gets the access policy named Policy12 in the storage queue named MyQueue. - -### Example 2: Get all stored access policies in the queue -``` -PS C:\>Get-AzureStorageQueueStoredAccessPolicy -Queue "MyQueue" -``` - -This command gets all stored access policies in the queue named MyQueue. - -## PARAMETERS - -### -Context -Specifies the Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies a stored access policy, which includes the permissions for this Shared Access Signature (SAS) token. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Queue -Specifies the Azure storage queue name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.Queue.SharedAccessQueuePolicy - -## NOTES - -## RELATED LINKS - -[New-AzureStorageQueueStoredAccessPolicy](./New-AzureStorageQueueStoredAccessPolicy.md) - -[Remove-AzureStorageQueueStoredAccessPolicy](./Remove-AzureStorageQueueStoredAccessPolicy.md) - -[Set-AzureStorageQueueStoredAccessPolicy](./Set-AzureStorageQueueStoredAccessPolicy.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - - diff --git a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageServiceLoggingProperty.md b/azurermps-6.13.0/Azure.Storage/Get-AzureStorageServiceLoggingProperty.md deleted file mode 100644 index 974c10d3a2..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageServiceLoggingProperty.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 494291A1-D854-4E97-B5EE-27BB5653D97C -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestorageserviceloggingproperty -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageServiceLoggingProperty.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageServiceLoggingProperty.md ---- - -# Get-AzureStorageServiceLoggingProperty - -## SYNOPSIS -Gets logging properties for Azure Storage services. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureStorageServiceLoggingProperty [-ServiceType] [-Context ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureStorageServiceLoggingProperty** cmdlet gets logging properties for Azure Storage services. - -## EXAMPLES - -### Example 1: Get logging properties for the Blob service -``` -C:\PS>Get-AzureStorageServiceLoggingProperty -ServiceType Blob -``` - -This command gets logging properties for blob storage. - -## PARAMETERS - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceType -Specifies the storage service type. -This cmdlet gets the logging properties for the service type that this parameter specifies. -The acceptable values for this parameter are: -- Blob -- Table -- Queue -- File -The value of File is not currently supported. - -```yaml -Type: Microsoft.WindowsAzure.Commands.Storage.Common.StorageServiceType -Parameter Sets: (All) -Aliases: -Accepted values: Blob, Table, Queue, File - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.Shared.Protocol.LoggingProperties - -## NOTES - -## RELATED LINKS - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[Set-AzureStorageServiceLoggingProperty](./Set-AzureStorageServiceLoggingProperty.md) - - diff --git a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageServiceMetricsProperty.md b/azurermps-6.13.0/Azure.Storage/Get-AzureStorageServiceMetricsProperty.md deleted file mode 100644 index ea7522a3c4..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageServiceMetricsProperty.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 3B5B828A-6B3E-49BD-8BA9-916F8B69B8E9 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestorageservicemetricsproperty -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageServiceMetricsProperty.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageServiceMetricsProperty.md ---- - -# Get-AzureStorageServiceMetricsProperty - -## SYNOPSIS -Gets metrics properties for the Azure Storage service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureStorageServiceMetricsProperty [-ServiceType] [-MetricsType] - [-Context ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureStorageServiceMetricsProperty** cmdlet gets metrics properties for the Azure Storage service. - -## EXAMPLES - -### Example 1: Get metrics properties for the Blob service -``` -C:\PS>Get-AzureStorageServiceMetricsProperty -ServiceType Blob -MetricsType Hour -``` - -This command gets metrics properties for blob storage for the Hour metrics type. - -## PARAMETERS - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MetricsType -Specifies a metrics type. -This cmdlet gets the Azure Storage service metrics properties for the metrics type that this parameter specifies. -The acceptable values for this parameter are: Hour and Minute. - -```yaml -Type: Microsoft.WindowsAzure.Commands.Storage.Common.ServiceMetricsType -Parameter Sets: (All) -Aliases: -Accepted values: Hour, Minute - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceType -Specifies the storage service type. -This cmdlet gets the metrics properties for the type that this parameter specifies. -The acceptable values for this parameter are: -- Blob -- Table -- Queue -- File -The value of File is not currently supported. - -```yaml -Type: Microsoft.WindowsAzure.Commands.Storage.Common.StorageServiceType -Parameter Sets: (All) -Aliases: -Accepted values: Blob, Table, Queue, File - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.Shared.Protocol.MetricsProperties - -## NOTES - -## RELATED LINKS - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[Set-AzureStorageServiceMetricsProperty](./Set-AzureStorageServiceMetricsProperty.md) - - diff --git a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageServiceProperty.md b/azurermps-6.13.0/Azure.Storage/Get-AzureStorageServiceProperty.md deleted file mode 100644 index 49f7f3e469..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageServiceProperty.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestorageserviceproperty -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageServiceProperty.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageServiceProperty.md ---- - -# Get-AzureStorageServiceProperty - -## SYNOPSIS -Gets properties for Azure Storage services. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureStorageServiceProperty [-ServiceType] [-Context ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureStorageServiceProperty** cmdlet gets the properties for Azure Storage services. - -## EXAMPLES - -### Example 1: Get Azure Storage services property of the Blob service -``` -C:\PS>Get-AzureStorageServiceProperty -ServiceType Blob - -Logging.Version : 1.0 -Logging.LoggingOperations : None -Logging.RetentionDays : -HourMetrics.Version : 1.0 -HourMetrics.MetricsLevel : ServiceAndApi -HourMetrics.RetentionDays : 7 -MinuteMetrics.Version : 1.0 -MinuteMetrics.MetricsLevel : None -MinuteMetrics.RetentionDays : -DeleteRetentionPolicy.Enabled : True -DeleteRetentionPolicy.RetentionDays : 70 -Cors : -DefaultServiceVersion : 2017-07-29 -``` - -This command gets DefaultServiceVersion property of the Blob service. - -## PARAMETERS - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceType -Specifies the storage service type. -This cmdlet gets the logging properties for the service type that this parameter specifies. -The acceptable values for this parameter are: -- Blob -- Table -- Queue -- File - -```yaml -Type: Microsoft.WindowsAzure.Commands.Storage.Common.StorageServiceType -Parameter Sets: (All) -Aliases: -Accepted values: Blob, Table, Queue, File - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Storage.Model.ResourceModel.PSSeriviceProperties - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageShare.md b/azurermps-6.13.0/Azure.Storage/Get-AzureStorageShare.md deleted file mode 100644 index 51600561af..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageShare.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: FD3A0013-4365-4E65-891C-5C50A9D5658C -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestorageshare -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageShare.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageShare.md ---- - -# Get-AzureStorageShare - -## SYNOPSIS -Gets a list of file shares. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### MatchingPrefix (Default) -``` -Get-AzureStorageShare [[-Prefix] ] [-Context ] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [] -``` - -### Specific -``` -Get-AzureStorageShare [-Name] [[-SnapshotTime] ] [-Context ] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -## DESCRIPTION -The **Get-AzureStorageShare** cmdlet gets a list of file shares for a storage account. - -## EXAMPLES - -### Example 1: Get a file share -``` -PS C:\>Get-AzureStorageShare -Name "ContosoShare06" -``` - -This command gets the file share named ContosoShare06. - -### Example 2: Get all file shares that begin with a string -``` -PS C:\>Get-AzureStorageShare -Prefix "Contoso" -``` - -This command gets all file shares that have names that begin with Contoso. - -### Example 3: Get all file shares in a specified context -``` -PS C:\>$Context = New-AzureStorageContext -Local -PS C:\> Get-AzureStorageShare -Context $Context -``` - -The first command uses the **New-AzureStorageContext** cmdlet to create a context by using the *Local* parameter, and then stores that context object in the $Context variable. -The second command gets the file shares for the context object stored in $Context. - -### Example 4: Get a file share snapshot with specific share name and SnapshotTime -``` -PS C:\>Get-AzureStorageShare -Name "ContosoShare06" -SnapshotTime "6/16/2017 9:48:41 AM +00:00" -``` - -This command gets a file share snapshot with specific share name and SnapshotTime. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure Storage context. -To obtain a context, use the [New-AzureStorageContext](./New-AzureStorageContext.md) cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the file share. -This cmdlet gets the file share that this parameter specifies, or nothing if you specify the name of a file share that does not exist. - -```yaml -Type: System.String -Parameter Sets: Specific -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Prefix -Specifies the prefix for file shares. -This cmdlet gets file shares that match the prefix that this parameter specifies, or no file shares if no file shares match the specified prefix. - -```yaml -Type: System.String -Parameter Sets: MatchingPrefix -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SnapshotTime -SnapshotTime of the file share snapshot to be received. - -```yaml -Type: System.Nullable`1[System.DateTimeOffset] -Parameter Sets: Specific -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFileShare - -## NOTES - -## RELATED LINKS - -[New-AzureStorageShare](./New-AzureStorageShare.md) - -[Remove-AzureStorageShare](./Remove-AzureStorageShare.md) diff --git a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageShareStoredAccessPolicy.md b/azurermps-6.13.0/Azure.Storage/Get-AzureStorageShareStoredAccessPolicy.md deleted file mode 100644 index 91304331f8..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageShareStoredAccessPolicy.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 73BB521B-20F2-4F2B-AA88-2B128F36A9EF -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestoragesharestoredaccesspolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageShareStoredAccessPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageShareStoredAccessPolicy.md ---- - -# Get-AzureStorageShareStoredAccessPolicy - -## SYNOPSIS -Gets stored access policies for a Storage share. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureStorageShareStoredAccessPolicy [-ShareName] [[-Policy] ] [-Context ] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -## DESCRIPTION -The **Get-AzureStorageShareStoredAccessPolicy** cmdlet gets stored access policies for an Azure Storage share. -To get a particular policy, specify it by name. - -## EXAMPLES - -### Example 1: Get a stored access policy in a share -``` -PS C:\>Get-AzureStorageShareStoredAccessPolicy -ShareName "ContosoShare" -Policy "GeneralPolicy" -``` - -This command gets a stored access policy named GeneralPolicy in ContosoShare. - -### Example 2: Get all the stored access policies in share -``` -PS C:\>Get-AzureStorageShareStoredAccessPolicy -ShareName "ContosoShare" -``` - -This command gets all stored access policies in ContosoShare. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure Storage context. -To obtain a context, use the [New-AzureStorageContext](./New-AzureStorageContext.md) cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies the name of the stored access policy that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShareName -Specifies the Storage share name for which this cmdlet gets policies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.File.SharedAccessFilePolicy - -## NOTES - -## RELATED LINKS - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[New-AzureStorageShareStoredAccessPolicy](./New-AzureStorageShareStoredAccessPolicy.md) - -[Remove-AzureStorageShareStoredAccessPolicy](./Remove-AzureStorageShareStoredAccessPolicy.md) - -[Set-AzureStorageShareStoredAccessPolicy](./Set-AzureStorageShareStoredAccessPolicy.md) diff --git a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageTable.md b/azurermps-6.13.0/Azure.Storage/Get-AzureStorageTable.md deleted file mode 100644 index b88ae6ca2a..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageTable.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 4631D36F-926A-4279-AA4D-5F694C18081E -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestoragetable -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageTable.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageTable.md ---- - -# Get-AzureStorageTable - -## SYNOPSIS -Lists the storage tables. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### TableName (Default) -``` -Get-AzureStorageTable [[-Name] ] [-Context ] - [-DefaultProfile ] [] -``` - -### TablePrefix -``` -Get-AzureStorageTable -Prefix [-Context ] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Get-AzureStorageTable** cmdlet lists the storage tables associated with the storage account in Azure. - -## EXAMPLES - -### Example 1: List all Azure Storage tables -``` -PS C:\>Get-AzureStorageTable -``` - -This command gets all storage tables for a Storage account. - -### Example 2: List Azure Storage tables using a wildcard character -``` -PS C:\>Get-AzureStorageTable -Name table* -``` - -This command uses a wildcard character to get storage tables whose name starts with table. - -### Example 3: List Azure Storage tables using table name prefix -``` -PS C:\>Get-AzureStorageTable -Prefix "table" -``` - -This command uses the *Prefix* parameter to get storage tables whose name starts with table. - -## PARAMETERS - -### -Context -Specifies the storage context. -To create it, you can use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the table name. -If the table name is empty, the cmdlet lists all the tables. -Otherwise, it lists all tables that match the specified name or the regular name pattern. - -```yaml -Type: System.String -Parameter Sets: TableName -Aliases: N, Table - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Prefix -Specifies a prefix used in the name of the table or tables you want to get. -You can use this to find all tables that start with the same string, such as table. - -```yaml -Type: System.String -Parameter Sets: TablePrefix -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageTable - -## NOTES - -## RELATED LINKS - -[New-AzureStorageTable](./New-AzureStorageTable.md) - -[Remove-AzureStorageTable](./Remove-AzureStorageTable.md) - - diff --git a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageTableStoredAccessPolicy.md b/azurermps-6.13.0/Azure.Storage/Get-AzureStorageTableStoredAccessPolicy.md deleted file mode 100644 index 4c9fcd811c..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Get-AzureStorageTableStoredAccessPolicy.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: BF5526C1-11B9-47A8-A5A6-CB275B470A9E -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestoragetablestoredaccesspolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageTableStoredAccessPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Get-AzureStorageTableStoredAccessPolicy.md ---- - -# Get-AzureStorageTableStoredAccessPolicy - -## SYNOPSIS -Gets the stored access policy or policies for an Azure storage table. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureStorageTableStoredAccessPolicy [-Table] [[-Policy] ] [-Context ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureStorageTableStoredAccessPolicy** cmdlet lists the stored access policy or policies for an Azure storage table. - -## EXAMPLES - -### Example 1: Get a stored access policy in a storage table -``` -PS C:\>Get-AzureStorageTableStoredAccessPolicy -Table "Table02" -Policy "Policy50" -``` - -This command gets the access policy named Policy50 in the storage table named Table02. - -### Example 2: Get all stored access policies in a storage table -``` -PS C:\>Get-AzureStorageTableStoredAccessPolicy -Table "Table02" -``` - -This command gets all access policies in the table named Table02. - -## PARAMETERS - -### -Context -Specifies the Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies a stored access policy, which includes the permissions for this Shared Access Signature (SAS) token. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Table -Specifies the Azure storage table name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.Table.SharedAccessTablePolicy - -## NOTES - -## RELATED LINKS - -[New-AzureStorageTableStoredAccessPolicy](./New-AzureStorageTableStoredAccessPolicy.md) - -[Remove-AzureStorageTableStoredAccessPolicy](./Remove-AzureStorageTableStoredAccessPolicy.md) - -[Set-AzureStorageTableStoredAccessPolicy](./Set-AzureStorageTableStoredAccessPolicy.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - - diff --git a/azurermps-6.13.0/Azure.Storage/New-AzureStorageAccountSASToken.md b/azurermps-6.13.0/Azure.Storage/New-AzureStorageAccountSASToken.md deleted file mode 100644 index 7ecb17a2f1..0000000000 --- a/azurermps-6.13.0/Azure.Storage/New-AzureStorageAccountSASToken.md +++ /dev/null @@ -1,235 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: BCCBB05B-A5D7-4796-BE55-6BE5E18E07FC -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/new-azurestorageaccountsastoken -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/New-AzureStorageAccountSASToken.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/New-AzureStorageAccountSASToken.md ---- - -# New-AzureStorageAccountSASToken - -## SYNOPSIS -Creates an account-level SAS token. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureStorageAccountSASToken -Service - -ResourceType [-Permission ] [-Protocol ] - [-IPAddressOrRange ] [-StartTime ] [-ExpiryTime ] [-Context ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureStorageSASToken** cmdlet creates an account-level shared access signature (SAS) token for an Azure Storage account. -You can use the SAS token to delegate permissions for multiple services, or to delegate permissions for services not available with an object-level SAS token. - -## EXAMPLES - -### Example 1: Create an account-level SAS token with full permission -``` -PS C:\> New-AzureStorageAccountSASToken -Service Blob,File,Table,Queue -ResourceType Service,Container,Object -Permission "racwdlup" -``` - -This command creates an account-level SAS token with full permission. - -### Example 2: Create an account-level SAS token for a range of IP addresses -``` -PS C:\> New-AzureStorageAccountSASToken -Service Blob,File,Table,Queue -ResourceType Service,Container,Object -Permission "racwdlup" -Protocol HttpsOnly -IPAddressOrRange 168.1.5.60-168.1.5.70 -``` - -This command creates an account-level SAS token for HTTPS-only requests from the specified range of IP addresses. - -## PARAMETERS - -### -Context -Specifies the Azure storage context. -You can use the New-AzureStorageContext cmdlet to get an **AzureStorageContext** object. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpiryTime -Specifies the time at which the shared access signature becomes invalid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddressOrRange -Specifies the IP address or range of IP addresses from which to accept requests, such as 168.1.5.65 or 168.1.5.60-168.1.5.70. -The range is inclusive. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Permission -Specifies the permissions for Storage account. -Permissions are valid only if they match the specified resource type. -It is important to note that this is a string, like `rwd` (for Read, Write and Delete). -For more information about acceptable permission values, see Constructing an Account SAS https://go.microsoft.com/fwlink/?LinkId=799514 - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol permitted for a request made with the account SAS. -The acceptable values for this parameter are: -- HttpsOnly -- HttpsOrHttp -The default value is HttpsOrHttp. - -```yaml -Type: System.Nullable`1[Microsoft.WindowsAzure.Storage.SharedAccessProtocol] -Parameter Sets: (All) -Aliases: -Accepted values: HttpsOnly, HttpsOrHttp - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceType -Specifies the resource types that are available with the SAS token. -The acceptable values for this parameter are: -- None -- Service -- Container -- Object - -```yaml -Type: Microsoft.WindowsAzure.Storage.SharedAccessAccountResourceTypes -Parameter Sets: (All) -Aliases: -Accepted values: None, Service, Container, Object - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Service -Specifies the service. -The acceptable values for this parameter are: -- None -- Blob -- File -- Queue -- Table - -```yaml -Type: Microsoft.WindowsAzure.Storage.SharedAccessAccountServices -Parameter Sets: (All) -Aliases: -Accepted values: None, Blob, File, Queue, Table - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Specifies the time, as a **DateTime** object, at which the SAS becomes valid. -To get a **DateTime** object, use the Get-Date cmdlet. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[New-AzureStorageBlobSASToken](./New-AzureStorageBlobSASToken.md) - -[New-AzureStorageContainerSASToken](./New-AzureStorageContainerSASToken.md) - -[New-AzureStorageFileSASToken](./New-AzureStorageFileSASToken.md) - -[New-AzureStorageQueueSASToken](./New-AzureStorageQueueSASToken.md) - -[New-AzureStorageShareSASToken](./New-AzureStorageShareSASToken.md) - -[New-AzureStorageTableSASToken](./New-AzureStorageTableSASToken.md) - - diff --git a/azurermps-6.13.0/Azure.Storage/New-AzureStorageBlobSASToken.md b/azurermps-6.13.0/Azure.Storage/New-AzureStorageBlobSASToken.md deleted file mode 100644 index 63ccf4b047..0000000000 --- a/azurermps-6.13.0/Azure.Storage/New-AzureStorageBlobSASToken.md +++ /dev/null @@ -1,280 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 585371E3-D4CE-452E-B0B0-92B3ABD127E7 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/new-azurestorageblobsastoken -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/New-AzureStorageBlobSASToken.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/New-AzureStorageBlobSASToken.md ---- - -# New-AzureStorageBlobSASToken - -## SYNOPSIS -Generates a SAS token for an Azure storage blob. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### BlobNameWithPermission (Default) -``` -New-AzureStorageBlobSASToken [-Container] [-Blob] [-Permission ] - [-Protocol ] [-IPAddressOrRange ] [-StartTime ] - [-ExpiryTime ] [-FullUri] [-Context ] [-DefaultProfile ] - [] -``` - -### BlobPipelineWithPolicy -``` -New-AzureStorageBlobSASToken -CloudBlob -Policy [-Protocol ] - [-IPAddressOrRange ] [-StartTime ] [-ExpiryTime ] [-FullUri] - [-Context ] [-DefaultProfile ] [] -``` - -### BlobPipelineWithPermission -``` -New-AzureStorageBlobSASToken -CloudBlob [-Permission ] [-Protocol ] - [-IPAddressOrRange ] [-StartTime ] [-ExpiryTime ] [-FullUri] - [-Context ] [-DefaultProfile ] [] -``` - -### BlobNameWithPolicy -``` -New-AzureStorageBlobSASToken [-Container] [-Blob] -Policy - [-Protocol ] [-IPAddressOrRange ] [-StartTime ] - [-ExpiryTime ] [-FullUri] [-Context ] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **New-AzureStorageBlobSASToken** cmdlet generates a Shared Access Signature (SAS) token for an Azure storage blob. - -## EXAMPLES - -### Example 1: Generate a blob SAS token with full blob permission -``` -PS C:\>New-AzureStorageBlobSASToken -Container "ContainerName" -Blob "BlobName" -Permission rwd -``` - -This example generates a blob SAS token with full blob permission. - -### Example 2: Generate a blob SAS token with life time -``` -PS C:\> $StartTime = Get-Date -PS C:\> $EndTime = $startTime.AddHours(2.0) -PS C:\> New-AzureStorageBlobSASToken -Container "ContainerName" -Blob "BlobName" -Permission rwd -StartTime $StartTime -ExpiryTime $EndTime -``` - -This example generates a blob SAS token with life time. - -## PARAMETERS - -### -Blob -Specifies the storage blob name. - -```yaml -Type: System.String -Parameter Sets: BlobNameWithPermission, BlobNameWithPolicy -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CloudBlob -Specifies the **CloudBlob** object. -To obtain a **CloudBlob** object, use the [Get-AzureStorageBlob](./Get-AzureStorageBlob.md) cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudBlob -Parameter Sets: BlobPipelineWithPolicy, BlobPipelineWithPermission -Aliases: ICloudBlob - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Container -Specifies the storage container name. - -```yaml -Type: System.String -Parameter Sets: BlobNameWithPermission, BlobNameWithPolicy -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies the storage context. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpiryTime -Specifies when the shared access signature expires. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FullUri -Indicates that this cmdlet return the full blob URI and the shared access signature token. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddressOrRange -Specifies the IP address or range of IP addresses from which to accept requests, such as 168.1.5.65 or 168.1.5.60-168.1.5.70. -The range is inclusive. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Permission -Specifies the permissions for a storage blob. -It is important to note that this is a string, like `rwd` (for Read, Write and Delete). - -```yaml -Type: System.String -Parameter Sets: BlobNameWithPermission, BlobPipelineWithPermission -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies an Azure Stored Access Policy. - -```yaml -Type: System.String -Parameter Sets: BlobPipelineWithPolicy, BlobNameWithPolicy -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol permitted for a request. -The acceptable values for this parameter are: -* HttpsOnly -* HttpsOrHttp -The default value is HttpsOrHttp. - -```yaml -Type: System.Nullable`1[Microsoft.WindowsAzure.Storage.SharedAccessProtocol] -Parameter Sets: (All) -Aliases: -Accepted values: HttpsOnly, HttpsOrHttp - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Specifies the time at which the shared access signature becomes valid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.WindowsAzure.Storage.Blob.CloudBlob - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageBlob](./Get-AzureStorageBlob.md) - -[New-AzureStorageContainerSASToken](./New-AzureStorageContainerSASToken.md) diff --git a/azurermps-6.13.0/Azure.Storage/New-AzureStorageContainer.md b/azurermps-6.13.0/Azure.Storage/New-AzureStorageContainer.md deleted file mode 100644 index 4e499df502..0000000000 --- a/azurermps-6.13.0/Azure.Storage/New-AzureStorageContainer.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 2B12BC19-EF8F-43F5-AF04-C570FEEA1AE6 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/new-azurestoragecontainer -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/New-AzureStorageContainer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/New-AzureStorageContainer.md ---- - -# New-AzureStorageContainer - -## SYNOPSIS -Creates an Azure storage container. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureStorageContainer [-Name] [[-Permission] ] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -## DESCRIPTION -The **New-AzureStorageContainer** cmdlet creates an Azure storage container. - -## EXAMPLES - -### Example 1: Create an Azure storage container -``` -PS C:\>New-AzureStorageContainer -Name "ContainerName" -Permission Off -``` - -This command creates a storage container. - -### Example 2: Create multiple Azure storage containers -``` -PS C:\>"container1 container2 container3".split() | New-AzureStorageContainer -Permission Container -``` - -This example creates multiple storage containers. -It uses the **Split** method of the .NET **String** class and then passes the names on the pipeline. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies a context for the new container. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the new container. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Container - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Permission -Specifies the level of public access to this container. -By default, the container and any blobs in it can be accessed only by the owner of the storage account. -To grant anonymous users read permissions to a container and its blobs, you can set the container permissions to enable public access. -Anonymous users can read blobs in a publicly available container without authenticating the request. -The acceptable values for this parameter are: -- Container. -Provides full read access to a container and its blobs. -Clients can enumerate blobs in the container through anonymous request, but cannot enumerate containers in the storage account. -- Blob. -Provides read access to blob data throughout a container through anonymous request, but does not provide access to container data. -Clients cannot enumerate blobs in the container by using anonymous request. -- Off. -Which restricts access to only the storage account owner. - -```yaml -Type: System.Nullable`1[Microsoft.WindowsAzure.Storage.Blob.BlobContainerPublicAccessType] -Parameter Sets: (All) -Aliases: PublicAccess -Accepted values: Off, Container, Blob, Unknown - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the service side time-out interval, in seconds, for a request. -If the specified interval elapses before the service processes the request, the storage service returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageContainer - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageContainer](./Get-AzureStorageContainer.md) - -[Remove-AzureStorageContainer](./Remove-AzureStorageContainer.md) - -[Set-AzureStorageContainerAcl](./Set-AzureStorageContainerAcl.md) - - diff --git a/azurermps-6.13.0/Azure.Storage/New-AzureStorageContainerSASToken.md b/azurermps-6.13.0/Azure.Storage/New-AzureStorageContainerSASToken.md deleted file mode 100644 index 8c177c6fb9..0000000000 --- a/azurermps-6.13.0/Azure.Storage/New-AzureStorageContainerSASToken.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 6FF04E82-4921-4F7B-83D0-6997316BC5FD -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/new-azurestoragecontainersastoken -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/New-AzureStorageContainerSASToken.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/New-AzureStorageContainerSASToken.md ---- - -# New-AzureStorageContainerSASToken - -## SYNOPSIS -Generates an SAS token for an Azure storage container. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SasPolicy -``` -New-AzureStorageContainerSASToken [-Name] -Policy [-Protocol ] - [-IPAddressOrRange ] [-StartTime ] [-ExpiryTime ] [-FullUri] - [-Context ] [-DefaultProfile ] [] -``` - -### SasPermission -``` -New-AzureStorageContainerSASToken [-Name] [-Permission ] [-Protocol ] - [-IPAddressOrRange ] [-StartTime ] [-ExpiryTime ] [-FullUri] - [-Context ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureStorageContainerSASToken** cmdlet generates a Shared Access Signature (SAS) token for an Azure storage container. - -## EXAMPLES - -### Example 1: Generate a container SAS token with full container permission -``` -PS C:\>New-AzureStorageContainerSASToken -Name "Test" -Permission rwdl -``` - -This example generates a container SAS token with full container permission. - -### Example 2: Generate multiple container SAS token by pipeline -``` -PS C:\>Get-AzureStorageContainer -Container test* | New-AzureStorageContainerSASToken -Permission rwdl -``` - -This example generates multiple container SAS tokens by using the pipeline. - -### Example 3: Generate container SAS token with shared access policy -``` -PS C:\>New-AzureStorageContainerSASToken -Name "Test" -Policy "PolicyName" -``` - -This example generates a container SAS token with shared access policy. - -## PARAMETERS - -### -Context -Specifies an Azure storage context. -You can create it by using the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpiryTime -Specifies the time at which the shared access signature becomes invalid. -If the user sets the start time but not the expiry time, the expiry time is set to the start time plus one hour. -If neither the start time nor the expiry time is specified, the expiry time is set to the current time plus one hour. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FullUri -Indicates that this cmdlet return the full blob URI and the shared access signature token. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddressOrRange -Specifies the IP address or range of IP addresses from which to accept requests, such as 168.1.5.65 or 168.1.5.60-168.1.5.70. -The range is inclusive. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies an Azure storage container name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Container - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Permission -Specifies permissions for a storage container. -It is important to note that this is a string, like `rwd` (for Read, Write and Delete). - -```yaml -Type: System.String -Parameter Sets: SasPermission -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies an Azure Stored Access Policy. - -```yaml -Type: System.String -Parameter Sets: SasPolicy -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol permitted for a request. -The acceptable values for this parameter are: -* HttpsOnly -* HttpsOrHttp -The default value is HttpsOrHttp. - -```yaml -Type: System.Nullable`1[Microsoft.WindowsAzure.Storage.SharedAccessProtocol] -Parameter Sets: (All) -Aliases: -Accepted values: HttpsOnly, HttpsOrHttp - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Specifies the time at which the shared access signature becomes valid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[New-AzureStorageBlobSASToken](./New-AzureStorageBlobSASToken.md) diff --git a/azurermps-6.13.0/Azure.Storage/New-AzureStorageContainerStoredAccessPolicy.md b/azurermps-6.13.0/Azure.Storage/New-AzureStorageContainerStoredAccessPolicy.md deleted file mode 100644 index 90053cbae7..0000000000 --- a/azurermps-6.13.0/Azure.Storage/New-AzureStorageContainerStoredAccessPolicy.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: C324F28A-7215-4F10-A012-92B4F6544BC0 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/new-azurestoragecontainerstoredaccesspolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/New-AzureStorageContainerStoredAccessPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/New-AzureStorageContainerStoredAccessPolicy.md ---- - -# New-AzureStorageContainerStoredAccessPolicy - -## SYNOPSIS -Creates a stored access policy for an Azure storage container. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureStorageContainerStoredAccessPolicy [-Container] [-Policy] [-Permission ] - [-StartTime ] [-ExpiryTime ] [-Context ] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -## DESCRIPTION -The **New-AzureStorageContainerStoredAccessPolicy** cmdlet creates a stored access policy for an Azure storage container. - -## EXAMPLES - -### Example 1: Create a stored access policy in a storage container -``` -PS C:\>New-AzureStorageContainerStoredAccessPolicy -Container "MyContainer" -Policy "Policy01" -``` - -This command creates an access policy named Policy01 in the storage container named MyContainer. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Container -Specifies the Azure storage container name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpiryTime -Specifies the time at which the stored access policy becomes invalid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Permission -Specifies permissions in the stored access policy to access the container. -It is important to note that this is a string, like `rwd` (for Read, Write and Delete). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies a stored access policy, which includes the permissions for this SAS token. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Specifies the time at which the stored access policy becomes valid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageContainerStoredAccessPolicy](./Get-AzureStorageContainerStoredAccessPolicy.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[Remove-AzureStorageContainerStoredAccessPolicy](./Remove-AzureStorageContainerStoredAccessPolicy.md) - -[Set-AzureStorageContainerStoredAccessPolicy](./Set-AzureStorageContainerStoredAccessPolicy.md) - - diff --git a/azurermps-6.13.0/Azure.Storage/New-AzureStorageContext.md b/azurermps-6.13.0/Azure.Storage/New-AzureStorageContext.md deleted file mode 100644 index e44760c29e..0000000000 --- a/azurermps-6.13.0/Azure.Storage/New-AzureStorageContext.md +++ /dev/null @@ -1,373 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 383402B2-6B7C-41AB-AFF9-36C86156B0A9 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/new-azurestoragecontext -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/New-AzureStorageContext.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/New-AzureStorageContext.md ---- - -# New-AzureStorageContext - -## SYNOPSIS -Creates an Azure Storage context. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### OAuthAccount (Default) -``` -New-AzureStorageContext [-StorageAccountName] [-UseConnectedAccount] [-Protocol ] - [-Endpoint ] [] -``` - -### AccountNameAndKey -``` -New-AzureStorageContext [-StorageAccountName] [-StorageAccountKey] [-Protocol ] - [-Endpoint ] [] -``` - -### AccountNameAndKeyEnvironment -``` -New-AzureStorageContext [-StorageAccountName] [-StorageAccountKey] [-Protocol ] - -Environment [] -``` - -### AnonymousAccount -``` -New-AzureStorageContext [-StorageAccountName] [-Anonymous] [-Protocol ] [-Endpoint ] - [] -``` - -### AnonymousAccountEnvironment -``` -New-AzureStorageContext [-StorageAccountName] [-Anonymous] [-Protocol ] -Environment - [] -``` - -### SasToken -``` -New-AzureStorageContext [-StorageAccountName] -SasToken [-Protocol ] - [-Endpoint ] [] -``` - -### SasTokenWithAzureEnvironment -``` -New-AzureStorageContext [-StorageAccountName] -SasToken -Environment - [] -``` - -### OAuthAccountEnvironment -``` -New-AzureStorageContext [-StorageAccountName] [-UseConnectedAccount] [-Protocol ] - -Environment [] -``` - -### ConnectionString -``` -New-AzureStorageContext -ConnectionString [] -``` - -### LocalDevelopment -``` -New-AzureStorageContext [-Local] [] -``` - -## DESCRIPTION -The **New-AzureStorageContext** cmdlet creates an Azure Storage context. - -## EXAMPLES - -### Example 1: Create a context by specifying a storage account name and key -``` -C:\PS>New-AzureStorageContext -StorageAccountName "ContosoGeneral" -StorageAccountKey "< Storage Key for ContosoGeneral ends with == >" -``` - -This command creates a context for the account named ContosoGeneral that uses the specified key. - -### Example 2: Create a context by specifying a connection string -``` -C:\PS>New-AzureStorageContext -ConnectionString "DefaultEndpointsProtocol=https;AccountName=ContosoGeneral;AccountKey=< Storage Key for ContosoGeneral ends with == >;" -``` - -This command creates a context based on the specified connection string for the account ContosoGeneral. - -### Example 3: Create a context for an anonymous storage account -``` -C:\PS>New-AzureStorageContext -StorageAccountName "ContosoGeneral" -Anonymous -Protocol "http" -``` - -This command creates a context for anonymous use for the account named ContosoGeneral. -The command specifies HTTP as a connection protocol. - -### Example 4: Create a context by using the local development storage account -``` -C:\PS>New-AzureStorageContext -Local -``` - -This command creates a context by using the local development storage account. -The command specifies the *Local* parameter. - -### Example 5: Get the container for the local developer storage account -``` -C:\PS>New-AzureStorageContext -Local | Get-AzureStorageContainer -``` - -This command creates a context by using the local development storage account, and then passes the new context to the **Get-AzureStorageContainer** cmdlet by using the pipeline operator. -The command gets the Azure Storage container for the local developer storage account. - -### Example 6: Get multiple containers -``` -C:\PS>$Context01 = New-AzureStorageContext -Local -PS C:\> $Context02 = New-AzureStorageContext -StorageAccountName "ContosoGeneral" -StorageAccountKey "< Storage Key for ContosoGeneral ends with == >" -PS C:\> ($Context01, $Context02) | Get-AzureStorageContainer -``` - -The first command creates a context by using the local development storage account, and then stores that context in the $Context01 variable. -The second command creates a context for the account named ContosoGeneral that uses the specified key, and then stores that context in the $Context02 variable. -The final command gets the containers for the contexts stored in $Context01 and $Context02 by using **Get-AzureStorageContainer**. - -### Example 7: Create a context with an endpoint -``` -C:\PS>New-AzureStorageContext -StorageAccountName "ContosoGeneral" -StorageAccountKey "< Storage Key for ContosoGeneral ends with == >" -Endpoint "contosoaccount.core.windows.net" -``` - -This command creates an Azure Storage context that has the specified storage endpoint. -The command creates the context for the account named ContosoGeneral that uses the specified key. - -### Example 8: Create a context with a specified environment -``` -C:\PS>New-AzureStorageContext -StorageAccountName "ContosoGeneral" -StorageAccountKey "< Storage Key for ContosoGeneral ends with == >" -Environment "AzureChinaCloud" -``` - -This command creates an Azure storage context that has the specified Azure environment. -The command creates the context for the account named ContosoGeneral that uses the specified key. - -### Example 9: Create a context by using an SAS token -``` -C:\PS>$SasToken = New-AzureStorageContainerSASToken -Name "ContosoMain" -Permission "rad" -PS C:\> $Context = New-AzureStorageContext -StorageAccountName "ContosoGeneral" -SasToken $SasToken -PS C:\> $Context | Get-AzureStorageBlob -Container "ContosoMain" -``` - -The first command generates an SAS token by using the **New-AzureStorageContainerSASToken** cmdlet for the container named ContosoMain, and then stores that token in the $SasToken variable. -That token is for read, add, update, and delete permissions. -The second command creates a context for the account named ContosoGeneral that uses the SAS token stored in $SasToken, and then stores that context in the $Context variable. -The final command lists all the blobs associated with the container named ContosoMain by using the context stored in $Context. - -### Example 10: Create a context by using the OAuth Authentication -``` -C:\PS>Connect-AzureRmAccount -C:\PS> $Context = New-AzureStorageContext -StorageAccountName "myaccountname" -UseConnectedAccount -``` - -This command creates a context by using the OAuth Authentication. - -## PARAMETERS - -### -Anonymous -Indicates that this cmdlet creates an Azure Storage context for anonymous logon. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: AnonymousAccount, AnonymousAccountEnvironment -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionString -Specifies a connection string for the Azure Storage context. - -```yaml -Type: System.String -Parameter Sets: ConnectionString -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Endpoint -Specifies the endpoint for the Azure Storage context. - -```yaml -Type: System.String -Parameter Sets: OAuthAccount, AccountNameAndKey, AnonymousAccount, SasToken -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Environment -Specifies the Azure environment. -The acceptable values for this parameter are: AzureCloud and AzureChinaCloud. -For more information, type `Get-Help Get-AzureEnvironment`. - -```yaml -Type: System.String -Parameter Sets: AccountNameAndKeyEnvironment, AnonymousAccountEnvironment -Aliases: Name, EnvironmentName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: SasTokenWithAzureEnvironment, OAuthAccountEnvironment -Aliases: Name, EnvironmentName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Local -Indicates that this cmdlet creates a context by using the local development storage account. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: LocalDevelopment -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Transfer Protocol (https/http). - -```yaml -Type: System.String -Parameter Sets: OAuthAccount, AccountNameAndKey, AccountNameAndKeyEnvironment, AnonymousAccount, AnonymousAccountEnvironment, SasToken, OAuthAccountEnvironment -Aliases: -Accepted values: Http, Https - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SasToken -Specifies a Shared Access Signature (SAS) token for the context. - -```yaml -Type: System.String -Parameter Sets: SasToken, SasTokenWithAzureEnvironment -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageAccountKey -Specifies an Azure Storage account key. -This cmdlet creates a context for the key that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: AccountNameAndKey, AccountNameAndKeyEnvironment -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageAccountName -Specifies an Azure Storage account name. -This cmdlet creates a context for the account that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: OAuthAccount, AccountNameAndKey, AccountNameAndKeyEnvironment, AnonymousAccount, AnonymousAccountEnvironment, SasToken, SasTokenWithAzureEnvironment, OAuthAccountEnvironment -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseConnectedAccount -Indicates that this cmdlet creates an Azure Storage context with OAuth Authentication. -The cmdlet will use OAuth Authentication by default, when other authentication is not specified. - -```yaml -Type: SwitchParameter -Parameter Sets: OAuthAccount, OAuthAccountEnvironment -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseConnectedAccount -Indicates that this cmdlet creates an Azure Storage context with OAuth Authentication. -The cmdlet will use OAuth Authentication by default, when other authentication is not specified. - -```yaml -Type: SwitchParameter -Parameter Sets: OAuthAccount, OAuthAccountEnvironment -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Storage.AzureStorageContext - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageBlob](./Get-AzureStorageBlob.md) - -[New-AzureStorageContainerSASToken](./New-AzureStorageContainerSASToken.md) - - diff --git a/azurermps-6.13.0/Azure.Storage/New-AzureStorageDirectory.md b/azurermps-6.13.0/Azure.Storage/New-AzureStorageDirectory.md deleted file mode 100644 index d18352a904..0000000000 --- a/azurermps-6.13.0/Azure.Storage/New-AzureStorageDirectory.md +++ /dev/null @@ -1,246 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 65962F9A-CC79-4B8B-9208-A993708FD36F -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/new-azurestoragedirectory -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/New-AzureStorageDirectory.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/New-AzureStorageDirectory.md ---- - -# New-AzureStorageDirectory - -## SYNOPSIS -Creates a directory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ShareName (Default) -``` -New-AzureStorageDirectory [-ShareName] [-Path] [-Context ] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -### Share -``` -New-AzureStorageDirectory [-Share] [-Path] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [] -``` - -### Directory -``` -New-AzureStorageDirectory [-Directory] [-Path] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [] -``` - -## DESCRIPTION -The **New-AzureStorageDirectory** cmdlet creates a directory. -This cmdlet returns a **CloudFileDirectory** object. - -## EXAMPLES - -### Example 1: Create a folder in a file share -``` -PS C:\>New-AzureStorageDirectory -ShareName "ContosoShare06" -Path "ContosoWorkingFolder" -``` - -This command creates a folder named ContosoWorkingFolder in the file share named ContosoShare06. - -### Example 2: Create a folder in a file share specified in a file share object -``` -PS C:\>Get-AzureStorageShare -Name "ContosoShare06" | New-AzureStorageDirectory -Path "ContosoWorkingFolder" -``` - -This command uses the **Get-AzureStorageShare** cmdlet to get the file share named ContosoShare06, and then passes it to the current cmdlet by using the pipeline operator. -The current cmdlet creates the folder named ContosoWorkingFolder in ContosoShare06. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the [New-AzureStorageContext](./New-AzureStorageContext.md) cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: ShareName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Directory -Specifies a folder as a **CloudFileDirectory** object. -This cmdlet creates the folder in the location that this parameter specifies. -To obtain a directory, use the New-AzureStorageDirectory cmdlet. -You can also use the Get-AzureStorageFile cmdlet to obtain a directory. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFileDirectory -Parameter Sets: Directory -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Path -Specifies the path of a folder. -This cmdlet creates a folder for the path that this cmdlet specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Share -Specifies a **CloudFileShare** object. -This cmdlet creates a folder in the file share that this parameter specifies. -To obtain a **CloudFileShare** object, use the Get-AzureStorageShare cmdlet. -This object contains the storage context. -If you specify this parameter, do not specify the *Context* parameter. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameter Sets: Share -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ShareName -Specifies the name of the file share. -This cmdlet creates a folder in the file share that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ShareName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameters: Share (ByValue) - -### Microsoft.WindowsAzure.Storage.File.CloudFileDirectory -Parameters: Directory (ByValue) - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFileDirectory - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageFile](./Get-AzureStorageFile.md) - -[Get-AzureStorageShare](./Get-AzureStorageShare.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[New-AzureStorageDirectory](./New-AzureStorageDirectory.md) - -[Remove-AzureStorageDirectory](./Remove-AzureStorageDirectory.md) diff --git a/azurermps-6.13.0/Azure.Storage/New-AzureStorageFileSASToken.md b/azurermps-6.13.0/Azure.Storage/New-AzureStorageFileSASToken.md deleted file mode 100644 index bb59c01b39..0000000000 --- a/azurermps-6.13.0/Azure.Storage/New-AzureStorageFileSASToken.md +++ /dev/null @@ -1,290 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: BB139312-A536-4B61-A005-6CAF02BE1637 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/new-azurestoragefilesastoken -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/New-AzureStorageFileSASToken.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/New-AzureStorageFileSASToken.md ---- - -# New-AzureStorageFileSASToken - -## SYNOPSIS -Generates a shared access signature token for a Storage file. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameSasPermission -``` -New-AzureStorageFileSASToken [-ShareName] [-Path] [-Permission ] - [-Protocol ] [-IPAddressOrRange ] [-StartTime ] - [-ExpiryTime ] [-FullUri] [-Context ] [-DefaultProfile ] - [] -``` - -### NameSasPolicy -``` -New-AzureStorageFileSASToken [-ShareName] [-Path] -Policy - [-Protocol ] [-IPAddressOrRange ] [-StartTime ] - [-ExpiryTime ] [-FullUri] [-Context ] [-DefaultProfile ] - [] -``` - -### FileSasPermission -``` -New-AzureStorageFileSASToken -File [-Permission ] [-Protocol ] - [-IPAddressOrRange ] [-StartTime ] [-ExpiryTime ] [-FullUri] - [-DefaultProfile ] [] -``` - -### FileSasPolicy -``` -New-AzureStorageFileSASToken -File -Policy [-Protocol ] - [-IPAddressOrRange ] [-StartTime ] [-ExpiryTime ] [-FullUri] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureStorageFileSASToken** cmdlet generates a shared access signature token for an Azure Storage file. - -## EXAMPLES - -### Example 1: Generate a shared access signature token that has full file permissions -``` -PS C:\> New-AzureStorageFileSASToken -ShareName "ContosoShare" -Path "FilePath" -Permission "rwd" -``` - -This command generates a shared access signature token that has full permissions for the file that is named FilePath. - -### Example 2: Generate a shared access signature token that has a time limit -``` -PS C:\> $StartTime = Get-Date -PS C:\> $EndTime = $StartTime.AddHours(2.0) -PS C:\> New-AzureStorageFileSASToken -ShareName "ContosoShare" -Path "FilePath" -Permission "rwd" -StartTime $StartTime -ExpiryTime $EndTime -``` - -The first command creates a **DateTime** object by using the Get-Date cmdlet. -The command stores the current time in the $StartTime variable. -The second command adds two hours to the object in $StartTime, and then stores the result in the $EndTime variable. -This object is a time two hours in the future. -The third command generates a shared access signature token that has the specified permissions. -This token becomes valid at the current time. -The token remains valid until time stored in $EndTime. - -## PARAMETERS - -### -Context -Specifies an Azure Storage context. -To obtain a context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: NameSasPermission, NameSasPolicy -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpiryTime -Specifies the time at which the shared access signature becomes invalid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -File -Specifies a **CloudFile** object. -You can create a cloud file or obtain one by using the Get-AzureStorageFile cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFile -Parameter Sets: FileSasPermission, FileSasPolicy -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -FullUri -Indicates that this cmdlet return the full blob URI and the shared access signature token. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddressOrRange -Specifies the IP address or range of IP addresses from which to accept requests, such as 168.1.5.65 or 168.1.5.60-168.1.5.70. -The range is inclusive. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path of the file relative to a Storage share. - -```yaml -Type: System.String -Parameter Sets: NameSasPermission, NameSasPolicy -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Permission -Specifies the permissions for a Storage file. -It is important to note that this is a string, like `rwd` (for Read, Write and Delete). - -```yaml -Type: System.String -Parameter Sets: NameSasPermission, FileSasPermission -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies the stored access policy for a file. - -```yaml -Type: System.String -Parameter Sets: NameSasPolicy, FileSasPolicy -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol permitted for a request. -The acceptable values for this parameter are: -* HttpsOnly -* HttpsOrHttp -The default value is HttpsOrHttp. - -```yaml -Type: System.Nullable`1[Microsoft.WindowsAzure.Storage.SharedAccessProtocol] -Parameter Sets: (All) -Aliases: -Accepted values: HttpsOnly, HttpsOrHttp - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShareName -Specifies the name of the Storage share. - -```yaml -Type: System.String -Parameter Sets: NameSasPermission, NameSasPolicy -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -StartTime -Specifies the time at which the shared access signature becomes valid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.WindowsAzure.Storage.File.CloudFile - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameters: Context (ByValue) - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[New-AzureStorageShareSASToken](./New-AzureStorageShareSASToken.md) diff --git a/azurermps-6.13.0/Azure.Storage/New-AzureStorageQueue.md b/azurermps-6.13.0/Azure.Storage/New-AzureStorageQueue.md deleted file mode 100644 index d265363b94..0000000000 --- a/azurermps-6.13.0/Azure.Storage/New-AzureStorageQueue.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: E9500392-6BE1-46EC-9AF5-9234281025E6 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/new-azurestoragequeue -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/New-AzureStorageQueue.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/New-AzureStorageQueue.md ---- - -# New-AzureStorageQueue - -## SYNOPSIS -Creates a storage queue. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureStorageQueue [-Name] [-Context ] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **New-AzureStorageQueue** cmdlet creates a storage queue in Azure. - -## EXAMPLES - -### Example 1: Create an Azure storage queue -``` -PS C:\>New-AzureStorageQueue -Name "queueabc" -``` - -This example creates a storage queue named queueabc. - -### Example 2: Create multiple azure storage queues -``` -PS C:\>"queue1 queue2 queue3".split() | New-AzureStorageQueue -``` - -This example creates multiple storage queues. -It uses the Split method of the .NET String class and then passes the names on the pipeline. - -## PARAMETERS - -### -Context -Specifies the Azure storage context. -You can create it by using the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the queue. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Queue - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageQueue - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageQueue](./Get-AzureStorageQueue.md) - -[Remove-AzureStorageQueue](./Remove-AzureStorageQueue.md) - - diff --git a/azurermps-6.13.0/Azure.Storage/New-AzureStorageQueueSASToken.md b/azurermps-6.13.0/Azure.Storage/New-AzureStorageQueueSASToken.md deleted file mode 100644 index e218ec3af9..0000000000 --- a/azurermps-6.13.0/Azure.Storage/New-AzureStorageQueueSASToken.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 42C669B6-B621-454C-B897-262E1C8E76E3 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/new-azurestoragequeuesastoken -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/New-AzureStorageQueueSASToken.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/New-AzureStorageQueueSASToken.md ---- - -# New-AzureStorageQueueSASToken - -## SYNOPSIS -Generates a shared access signature token for an Azure storage queue. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SasPolicy -``` -New-AzureStorageQueueSASToken [-Name] -Policy [-Protocol ] - [-IPAddressOrRange ] [-StartTime ] [-ExpiryTime ] [-FullUri] - [-Context ] [-DefaultProfile ] [] -``` - -### SasPermission -``` -New-AzureStorageQueueSASToken [-Name] [-Permission ] [-Protocol ] - [-IPAddressOrRange ] [-StartTime ] [-ExpiryTime ] [-FullUri] - [-Context ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureStorageQueueSASToken** cmdlet generates shared access signature token for an Azure storage queue. - -## EXAMPLES - -### Example 1: Generate a queue SAS token with full permission -``` -PS C:\>New-AzureStorageQueueSASToken -Name "Test" -Permission raup -``` - -This example generates a queue SAS token with full permission. - -## PARAMETERS - -### -Context -Specifies the Azure storage context. -You can create it by New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpiryTime -Specifies when the shared access signature is no longer valid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FullUri -Indicates that this cmdlet return the full blob URI and the shared access signature token. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddressOrRange -Specifies the IP address or range of IP addresses from which to accept requests, such as 168.1.5.65 or 168.1.5.60-168.1.5.70. -The range is inclusive. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies an Azure storage queue name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Queue - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Permission -Specifies permissions for a storage queue. -It is important to note that this is a string, like `rwd` (for Read, Write and Delete). - -```yaml -Type: System.String -Parameter Sets: SasPermission -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies an Azure stored access policy. - -```yaml -Type: System.String -Parameter Sets: SasPolicy -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol permitted for a request. -The acceptable values for this parameter are: -* HttpsOnly -* HttpsOrHttp -The default value is HttpsOrHttp. - -```yaml -Type: System.Nullable`1[Microsoft.WindowsAzure.Storage.SharedAccessProtocol] -Parameter Sets: (All) -Aliases: -Accepted values: HttpsOnly, HttpsOrHttp - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Specifies when the shared access signature becomes valid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/Azure.Storage/New-AzureStorageQueueStoredAccessPolicy.md b/azurermps-6.13.0/Azure.Storage/New-AzureStorageQueueStoredAccessPolicy.md deleted file mode 100644 index b942e8b5df..0000000000 --- a/azurermps-6.13.0/Azure.Storage/New-AzureStorageQueueStoredAccessPolicy.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 351145AC-7C1E-4EB7-A17D-B8B7D8ED8DAB -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/new-azurestoragequeuestoredaccesspolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/New-AzureStorageQueueStoredAccessPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/New-AzureStorageQueueStoredAccessPolicy.md ---- - -# New-AzureStorageQueueStoredAccessPolicy - -## SYNOPSIS -Creates a stored access policy for an Azure storage queue. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureStorageQueueStoredAccessPolicy [-Queue] [-Policy] [-Permission ] - [-StartTime ] [-ExpiryTime ] [-Context ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureStorageQueueStoredAccessPolicy** cmdlet creates a stored access policy for an Azure storage queue. - -## EXAMPLES - -### Example 1: Create a stored access policy in a storage queue -``` -PS C:\>New-AzureStorageQueueStoredAccessPolicy -Queue "MyQueue" -Policy "Policy01" -``` - -This command creates an access policy named Policy01 in the storage queue named MyQueue. - -## PARAMETERS - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpiryTime -Specifies the time at which the stored access policy becomes invalid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Permission -Specifies permissions in the stored access policy to access the storage queue. -It is important to note that this is a string, like `rwd` (for Read, Write and Delete). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies a name for the stored access policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Queue -Specifies the Azure storage queue name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -StartTime -Specifies the time at which the stored access policy becomes valid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageQueueStoredAccessPolicy](./Get-AzureStorageQueueStoredAccessPolicy.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[Remove-AzureStorageQueueStoredAccessPolicy](./Remove-AzureStorageQueueStoredAccessPolicy.md) - -[Set-AzureStorageQueueStoredAccessPolicy](./Set-AzureStorageQueueStoredAccessPolicy.md) - - diff --git a/azurermps-6.13.0/Azure.Storage/New-AzureStorageShare.md b/azurermps-6.13.0/Azure.Storage/New-AzureStorageShare.md deleted file mode 100644 index bac85435ab..0000000000 --- a/azurermps-6.13.0/Azure.Storage/New-AzureStorageShare.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: FCDCEF0B-6E2C-480E-9841-EF4E64D61D54 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/new-azurestorageshare -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/New-AzureStorageShare.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/New-AzureStorageShare.md ---- - -# New-AzureStorageShare - -## SYNOPSIS -Creates a file share. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureStorageShare [-Name] [-Context ] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [] -``` - -## DESCRIPTION -The **New-AzureStorageShare** cmdlet creates a file share. - -## EXAMPLES - -### Example 1: Create a file share -``` -PS C:\>New-AzureStorageShare -Name "ContosoShare06" -``` - -This command creates a file share named ContosoShare06. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the [New-AzureStorageContext](./New-AzureStorageContext.md) cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a file share. -This cmdlet creates a file share that has the name that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFileShare - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageShare](./Get-AzureStorageShare.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[Remove-AzureStorageShare](./Remove-AzureStorageShare.md) diff --git a/azurermps-6.13.0/Azure.Storage/New-AzureStorageShareSASToken.md b/azurermps-6.13.0/Azure.Storage/New-AzureStorageShareSASToken.md deleted file mode 100644 index 5d12646018..0000000000 --- a/azurermps-6.13.0/Azure.Storage/New-AzureStorageShareSASToken.md +++ /dev/null @@ -1,242 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: BDF42420-3616-4A64-9562-1A896F828728 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/new-azurestoragesharesastoken -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/New-AzureStorageShareSASToken.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/New-AzureStorageShareSASToken.md ---- - -# New-AzureStorageShareSASToken - -## SYNOPSIS -Generate Shared Access Signature token for Azure Storage share. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SasPolicy -``` -New-AzureStorageShareSASToken [-ShareName] -Policy [-Protocol ] - [-IPAddressOrRange ] [-StartTime ] [-ExpiryTime ] [-FullUri] - [-Context ] [-DefaultProfile ] [] -``` - -### SasPermission -``` -New-AzureStorageShareSASToken [-ShareName] [-Permission ] [-Protocol ] - [-IPAddressOrRange ] [-StartTime ] [-ExpiryTime ] [-FullUri] - [-Context ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureStorageShareSASToken** cmdlet generates a shared access signature token for an Azure Storage share. - -## EXAMPLES - -### Example 1: Generate a shared access signature token for a share -``` -PS C:\>New-AzureStorageShareSASToken -ShareName "ContosoShare" -Permission "rwdl" -``` - -This command creates a shared access signature token for the share named ContosoShare. - -### Example 2: Generate multiple shared access signature token by using the pipeline -``` -PS C:\>Get-AzureStorageShare -Prefix "test" | New-AzureStorageShareSASToken -Permission "rwdl" -``` - -This command gets all the Storage shares that match the prefix test. -The command passes them to the current cmdlet by using the pipeline operator. -The current cmdlet creates a shared access token for each Storage share that has the specified permissions. - -### Example 3: Generate a shared access signature token that uses a shared access policy -``` -PS C:\>New-AzureStorageShareSASToken -ShareName "ContosoShare" -Policy "ContosoPolicy03" -``` - -This command creates a shared access signature token for the Storage share named ContosoShare that has the policy named ContosoPolicy03. - -## PARAMETERS - -### -Context -Specifies an Azure Storage context. -To obtain a context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpiryTime -Specifies the time at which the shared access signature becomes invalid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FullUri -Indicates that this cmdlet return the full blob URI and the shared access signature token. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddressOrRange -Specifies the IP address or range of IP addresses from which to accept requests, such as 168.1.5.65 or 168.1.5.60-168.1.5.70. -The range is inclusive. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Permission -Specifies the permissions in the token to access the share and files under the share. -It is important to note that this is a string, like `rwd` (for Read, Write and Delete). - -```yaml -Type: System.String -Parameter Sets: SasPermission -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies the stored access policy for a share. - -```yaml -Type: System.String -Parameter Sets: SasPolicy -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol permitted for a request. -The acceptable values for this parameter are: -* HttpsOnly -* HttpsOrHttp -The default value is HttpsOrHttp. - -```yaml -Type: System.Nullable`1[Microsoft.WindowsAzure.Storage.SharedAccessProtocol] -Parameter Sets: (All) -Aliases: -Accepted values: HttpsOnly, HttpsOrHttp - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShareName -Specifies the name of the Storage share. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -StartTime -Specifies the time at which the shared access signature becomes valid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.String - -## NOTES -* Keywords: common, azure, services, data, storage, blob, queue, table - -## RELATED LINKS - -[Get-AzureStorageShare](./Get-AzureStorageShare.md) - -[New-AzureStorageFileSASToken](./New-AzureStorageFileSASToken.md) diff --git a/azurermps-6.13.0/Azure.Storage/New-AzureStorageShareStoredAccessPolicy.md b/azurermps-6.13.0/Azure.Storage/New-AzureStorageShareStoredAccessPolicy.md deleted file mode 100644 index 13ddbac5d1..0000000000 --- a/azurermps-6.13.0/Azure.Storage/New-AzureStorageShareStoredAccessPolicy.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 37E76360-B683-407C-9AEF-7138374562D8 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/new-azurestoragesharestoredaccesspolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/New-AzureStorageShareStoredAccessPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/New-AzureStorageShareStoredAccessPolicy.md ---- - -# New-AzureStorageShareStoredAccessPolicy - -## SYNOPSIS -Creates a stored access policy on a Storage share. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureStorageShareStoredAccessPolicy [-ShareName] [-Policy] [-Permission ] - [-StartTime ] [-ExpiryTime ] [-Context ] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -## DESCRIPTION -The **New-AzureStorageShareStoredAccessPolicy** cmdlet creates a stored access policy on an Azure Storage share. - -## EXAMPLES - -### Example 1: Create a stored access policy in a share -``` -PS C:\>New-AzureStorageShareStoredAccessPolicy -ShareName "ContosoShare" -Policy "GeneralPolicy" -Permission "rwdl" -``` - -This command creates a stored access policy that has full permission in a share. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the [New-AzureStorageContext](./New-AzureStorageContext.md) cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpiryTime -Specifies the time at which the stored access policy becomes invalid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Permission -Specifies permissions in the stored access policy to access the Storage share or files under it. -It is important to note that this is a string, like `rwd` (for Read, Write and Delete). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies a name for the stored access policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShareName -Specifies the name of the Storage share. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -StartTime -Specifies the time at which the stored access policy becomes valid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageShareStoredAccessPolicy](./Get-AzureStorageShareStoredAccessPolicy.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[Remove-AzureStorageShareStoredAccessPolicy](./Remove-AzureStorageShareStoredAccessPolicy.md) - -[Set-AzureStorageShareStoredAccessPolicy](./Set-AzureStorageShareStoredAccessPolicy.md) diff --git a/azurermps-6.13.0/Azure.Storage/New-AzureStorageTable.md b/azurermps-6.13.0/Azure.Storage/New-AzureStorageTable.md deleted file mode 100644 index 092f122d34..0000000000 --- a/azurermps-6.13.0/Azure.Storage/New-AzureStorageTable.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 3B4F32F3-51ED-4851-B38F-172658186C96 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/new-azurestoragetable -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/New-AzureStorageTable.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/New-AzureStorageTable.md ---- - -# New-AzureStorageTable - -## SYNOPSIS -Creates a storage table. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureStorageTable [-Name] [-Context ] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **New-AzureStorageTable** cmdlet creates a storage table associated with the storage account in Azure. - -## EXAMPLES - -### Example 1: Create an azure storage table -``` -PS C:\>New-AzureStorageTable -Name "tableabc" -``` - -This command creates a storage table with a name of tableabc. - -### Example 2: Create multiple azure storage tables -``` -PS C:\>"table1 table2 table3".split() | New-AzureStorageTable -``` - -This command creates multiple tables. -It uses the **Split** method of the .NET **String** class and then passes the names on the pipeline. - -## PARAMETERS - -### -Context -Specifies the storage context. -To create it, you can use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the new table. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Table - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageTable - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageTable](./Get-AzureStorageTable.md) - -[Remove-AzureStorageTable](./Remove-AzureStorageTable.md) - - diff --git a/azurermps-6.13.0/Azure.Storage/New-AzureStorageTableSASToken.md b/azurermps-6.13.0/Azure.Storage/New-AzureStorageTableSASToken.md deleted file mode 100644 index 5dc304abb2..0000000000 --- a/azurermps-6.13.0/Azure.Storage/New-AzureStorageTableSASToken.md +++ /dev/null @@ -1,303 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 3CFA6E31-E243-4B22-AE8F-1942DD324639 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/new-azurestoragetablesastoken -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/New-AzureStorageTableSASToken.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/New-AzureStorageTableSASToken.md ---- - -# New-AzureStorageTableSASToken - -## SYNOPSIS -Generates an SAS token for an Azure Storage table. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SasPolicy -``` -New-AzureStorageTableSASToken [-Name] -Policy [-Protocol ] - [-IPAddressOrRange ] [-StartTime ] [-ExpiryTime ] [-FullUri] - [-StartPartitionKey ] [-StartRowKey ] [-EndPartitionKey ] [-EndRowKey ] - [-Context ] [-DefaultProfile ] [] -``` - -### SasPermission -``` -New-AzureStorageTableSASToken [-Name] [-Permission ] [-Protocol ] - [-IPAddressOrRange ] [-StartTime ] [-ExpiryTime ] [-FullUri] - [-StartPartitionKey ] [-StartRowKey ] [-EndPartitionKey ] [-EndRowKey ] - [-Context ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureStorageTableSASToken** cmdlet generates a Shared Access Signature (SAS) token for an Azure Storage table. - -## EXAMPLES - -### Example 1: Generate an SAS token that has full permissions for a table -``` -C:\PS>New-AzureStorageTableSASToken -Name "ContosoResources" -Permission "raud" -``` - -This command generates an SAS token with full permissions for the table named ContosoResources. -That token is for read, add, update, and delete permissions. - -### Example 2: Generate an SAS token for a range of partitions -``` -C:\PS>New-AzureStorageTableSASToken -Name "ContosoResources" -Permission "raud" -StartPartitionKey "a" -EndPartitionKey "b" -``` - -This command generates and SAS token with full permissions for the table named ContosoResources. -The command limits the token to the range that the *StartPartitionKey* and *EndPartitionKey* parameters specify. - -### Example 3: Generate an SAS token that has a stored access policy for a table -``` -C:\PS>New-AzureStorageTableSASToken -Name "ContosoResources" -Policy "ClientPolicy01" -``` - -This command generates an SAS token for the table named ContosoResources. -The command specifies the stored access policy named ClientPolicy01. - -## PARAMETERS - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndPartitionKey -Specifies the partition key of the end of the range for the token that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: endpk - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndRowKey -Specifies the row key for the end of the range for the token that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: endrk - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpiryTime -Specifies when the SAS token expires. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FullUri -Indicates that this cmdlet returns the full queue URI with the SAS token. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddressOrRange -Specifies the IP address or range of IP addresses from which to accept requests, such as 168.1.5.65 or 168.1.5.60-168.1.5.70. -The range is inclusive. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of an Azure Storage table. -This cmdlet creates an SAS token for the table that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Table - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Permission -Specifies permissions for an Azure Storage table. -It is important to note that this is a string, like `rwd` (for Read, Write and Delete). - -```yaml -Type: System.String -Parameter Sets: SasPermission -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies a stored access policy, which includes the permissions for this SAS token. - -```yaml -Type: System.String -Parameter Sets: SasPolicy -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol permitted for a request. -The acceptable values for this parameter are: -* HttpsOnly -* HttpsOrHttp -The default value is HttpsOrHttp. - -```yaml -Type: System.Nullable`1[Microsoft.WindowsAzure.Storage.SharedAccessProtocol] -Parameter Sets: (All) -Aliases: -Accepted values: HttpsOnly, HttpsOrHttp - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartPartitionKey -Specifies the partition key of the start of the range for the token that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: startpk - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartRowKey -Specifies the row key for the start of the range for the token that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: startrk - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Specifies when the SAS token becomes valid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[New-AzureStorageContext](./New-AzureStorageContext.md) diff --git a/azurermps-6.13.0/Azure.Storage/New-AzureStorageTableStoredAccessPolicy.md b/azurermps-6.13.0/Azure.Storage/New-AzureStorageTableStoredAccessPolicy.md deleted file mode 100644 index 5d901426aa..0000000000 --- a/azurermps-6.13.0/Azure.Storage/New-AzureStorageTableStoredAccessPolicy.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: CF3B6E3B-3FC1-4871-AFE0-366B17A9E4F8 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/new-azurestoragetablestoredaccesspolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/New-AzureStorageTableStoredAccessPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/New-AzureStorageTableStoredAccessPolicy.md ---- - -# New-AzureStorageTableStoredAccessPolicy - -## SYNOPSIS -Creates a stored access policy for an Azure storage table. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureStorageTableStoredAccessPolicy [-Table] [-Policy] [-Permission ] - [-StartTime ] [-ExpiryTime ] [-Context ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureStorageTableStoredAccessPolicy** cmdlet creates a stored access policy for an Azure storage table. - -## EXAMPLES - -### Example 1: Create a stored access policy in a table -``` -PS C:\>New-AzureStorageTableStoredAccessPolicy -Table "MyTable" -Policy "Policy02" -``` - -This command creates an access policy named Policy02 in the storage table named MyTable. - -## PARAMETERS - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpiryTime -Specifies the time at which the stored access policy becomes invalid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Permission -Specifies permissions in the stored access policy to access the storage table. -It is important to note that this is a string, like `rwd` (for Read, Write and Delete). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies a name for the stored access policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Specifies the time at which the stored access policy becomes valid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Table -Specifies the Azure storage table name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageTableStoredAccessPolicy](./Get-AzureStorageTableStoredAccessPolicy.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[Remove-AzureStorageTableStoredAccessPolicy](./Remove-AzureStorageTableStoredAccessPolicy.md) - -[Set-AzureStorageTableStoredAccessPolicy](./Set-AzureStorageTableStoredAccessPolicy.md) - - diff --git a/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageBlob.md b/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageBlob.md deleted file mode 100644 index b41e35d6dd..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageBlob.md +++ /dev/null @@ -1,319 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 03EC0D20-C737-4B2B-B8D9-71D06A938FAD -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/remove-azurestorageblob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Remove-AzureStorageBlob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Remove-AzureStorageBlob.md ---- - -# Remove-AzureStorageBlob - -## SYNOPSIS -Removes the specified storage blob. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NamePipeline (Default) -``` -Remove-AzureStorageBlob [-Blob] [-Container] [-DeleteSnapshot] [-Force] [-PassThru] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### BlobPipeline -``` -Remove-AzureStorageBlob -CloudBlob [-DeleteSnapshot] [-Force] [-PassThru] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### ContainerPipeline -``` -Remove-AzureStorageBlob -CloudBlobContainer [-Blob] [-DeleteSnapshot] [-Force] - [-PassThru] [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Remove-AzureStorageBlob** cmdlet removes the specified blob from a storage account in Azure. - -## EXAMPLES - -### Example 1: Remove a storage blob by name -``` -PS C:\>Remove-AzureStorageBlob -Container "ContainerName" -Blob "BlobName" -``` - -This command removes a blob identified by its name. - -### Example 2: Remove a storage blob using the pipeline -``` -PS C:\>Get-AzureStorageBlob -Container "ContainerName" -Blob "BlobName" | Remove-AzureStorageBlob -``` - -This command uses the pipeline. - -### Example 3: Remove storage blobs using the pipeline -``` -PS C:\>Get-AzureStorageContainer -Container container* | Remove-AzureStorageBlob -Blob "BlobName" -``` - -This command uses the asterisk (*) wildcard character and the pipeline to retrieve the blob or blobs and then removes them. - -## PARAMETERS - -### -Blob -Specifies the name of the blob you want to remove. - -```yaml -Type: System.String -Parameter Sets: NamePipeline, ContainerPipeline -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CloudBlob -Specifies a cloud blob. -To obtain a **CloudBlob** object, use the Get-AzureStorageBlob cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudBlob -Parameter Sets: BlobPipeline -Aliases: ICloudBlob - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CloudBlobContainer -Specifies a **CloudBlobContainer** object from the Azure Storage Client library. -You can use the Get-AzureStorageContainer cmdlet to get it. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudBlobContainer -Parameter Sets: ContainerPipeline -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Container -Specifies the name of the container. - -```yaml -Type: System.String -Parameter Sets: NamePipeline -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies the Azure storage context. -You can use the New-AzureStorageContext cmdlet to create it. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeleteSnapshot -Specifies that all snapshots be deleted, but not the base blob. -If this parameter is not specified, the base blob and its snapshots are deleted together. -The user is prompted to confirm the delete operation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Indicates that this cmdlet removes the blob and its snapshot without confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a **Boolean** that reflects the success of the operation. -By default, this cmdlet does not return a value. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the Azure profile for the cmdlet to read. -If not specified, the cmdlet reads from the default profile. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.WindowsAzure.Storage.Blob.CloudBlob - -### Microsoft.WindowsAzure.Storage.Blob.CloudBlobContainer - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageBlob](./Get-AzureStorageBlob.md) - -[Get-AzureStorageBlobContent](./Get-AzureStorageBlobContent.md) - -[Set-AzureStorageBlobContent](./Set-AzureStorageBlobContent.md) diff --git a/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageCORSRule.md b/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageCORSRule.md deleted file mode 100644 index d79f5d930c..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageCORSRule.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 26E06BA3-C550-40A5-B8E3-FEC8E9BF3867 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/remove-azurestoragecorsrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Remove-AzureStorageCORSRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Remove-AzureStorageCORSRule.md ---- - -# Remove-AzureStorageCORSRule - -## SYNOPSIS -Removes CORS for a Storage service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureStorageCORSRule [-ServiceType] [-Context ] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -## DESCRIPTION -The **Remove-AzureStorageCORSRule** cmdlet removes Cross-Origin Resource Sharing (CORS) for an Azure Storage service. -This cmdlet deletes all CORS rules in a Storage service type. -The types of storage services for this cmdlet are Blob, Table, Queue, and File. - -## EXAMPLES - -### Example 1: Remove CORS rules for the blob service -``` -PS C:\>Remove-AzureStorageCORSRule -ServiceType Blob -``` - -This command removes CORS rules for the Blob service type. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies the Azure storage context. -To obtain the storage context, the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceType -Specifies the Azure Storage service type for which this cmdlet removes rules. -The acceptable values for this parameter are: -- Blob -- Table -- Queue -- File - -```yaml -Type: Microsoft.WindowsAzure.Commands.Storage.Common.StorageServiceType -Parameter Sets: (All) -Aliases: -Accepted values: Blob, Table, Queue, File - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageCORSRule](./Get-AzureStorageCORSRule.md) - -[Set-AzureStorageCORSRule](./Set-AzureStorageCORSRule.md) - - diff --git a/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageContainer.md b/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageContainer.md deleted file mode 100644 index 819d3ada9d..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageContainer.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 6A46DA60-2ACF-4842-B5B3-58944264854A -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/remove-azurestoragecontainer -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Remove-AzureStorageContainer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Remove-AzureStorageContainer.md ---- - -# Remove-AzureStorageContainer - -## SYNOPSIS -Removes the specified storage container. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureStorageContainer [-Name] [-Force] [-PassThru] [-Context ] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Remove-AzureStorageContainer** cmdlet removes the specified storage container in Azure. - -## EXAMPLES - -### Example 1: Remove a container -``` -PS C:\>Remove-AzureStorageContainer -Name "MyTestContainer" -``` - -This example removes a container named MyTestContainer. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies a context for the container you want to remove. -You can use the New-AzureStorageContext cmdlet to create it. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the container to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Container - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a **Boolean** that reflects the success of the operation. -By default, this cmdlet does not return a value. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the service side time-out interval, in seconds, for a request. -If the specified interval elapses before the service processes the request, the storage service returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageContainer](./Get-AzureStorageContainer.md) - -[New-AzureStorageContainer](./New-AzureStorageContainer.md) diff --git a/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageContainerStoredAccessPolicy.md b/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageContainerStoredAccessPolicy.md deleted file mode 100644 index 226bd4d215..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageContainerStoredAccessPolicy.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 3E79EE05-7E52-4C54-B985-441BC2599925 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/remove-azurestoragecontainerstoredaccesspolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Remove-AzureStorageContainerStoredAccessPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Remove-AzureStorageContainerStoredAccessPolicy.md ---- - -# Remove-AzureStorageContainerStoredAccessPolicy - -## SYNOPSIS -Removes a stored access policy from an Azure storage container. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureStorageContainerStoredAccessPolicy [-Container] [-Policy] [-PassThru] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Remove-AzureStorageContainerStoredAccessPolicy** cmdlet removes a stored access policy from an Azure storage container. - -## EXAMPLES - -### Example 1: Remove a stored access policy from a storage container -``` -PS C:\>Remove-AzureStorageContainerStoredAccessPolicy -Container "MyContainer" -Policy "Policy03" -``` - -This command removes an access policy named Policy03 from the stored container named MyContainer. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Container -Specifies the Azure storage container name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a **Boolean** that reflects the success of the operation. -By default, this cmdlet does not return a value. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies the name of the stored access policy that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageContainerStoredAccessPolicy](./Get-AzureStorageContainerStoredAccessPolicy.md) - -[New-AzureStorageContainerStoredAccessPolicy](./New-AzureStorageContainerStoredAccessPolicy.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[Set-AzureStorageContainerStoredAccessPolicy](./Set-AzureStorageContainerStoredAccessPolicy.md) diff --git a/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageDirectory.md b/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageDirectory.md deleted file mode 100644 index a50e099ef1..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageDirectory.md +++ /dev/null @@ -1,297 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 53988D79-1F8B-4138-9F92-2912D418C121 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/remove-azurestoragedirectory -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Remove-AzureStorageDirectory.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Remove-AzureStorageDirectory.md ---- - -# Remove-AzureStorageDirectory - -## SYNOPSIS -Deletes a directory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ShareName (Default) -``` -Remove-AzureStorageDirectory [-ShareName] [-Path] [-PassThru] [-Context ] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### Share -``` -Remove-AzureStorageDirectory [-Share] [-Path] [-PassThru] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### Directory -``` -Remove-AzureStorageDirectory [-Directory] [[-Path] ] [-PassThru] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Remove-AzureStorageDirectory** cmdlet deletes a directory. - -## EXAMPLES - -### Example 1: Delete a folder -``` -PS C:\>Remove-AzureStorageDirectory -ShareName "ContosoShare06" -Path "ContosoWorkingFolder" -``` - -This command deletes the folder named ContosoWorkingFolder from the file share named ContosoShare06. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the [New-AzureStorageContext](./New-AzureStorageContext.md) cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: ShareName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Directory -Specifies a folder as a **CloudFileDirectory** object. -This cmdlet removes the folder that this parameter specifies. -To obtain a directory, use the New-AzureStorageDirectory cmdlet. -You can also use the **Get-AzureStorageFile** cmdlet to obtain a directory. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFileDirectory -Parameter Sets: Directory -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that, if this cmdlet succeeds, it returns a value of $True. -If you specify this parameter, and if the cmdlet is unsuccessful because of an inappropriate value for the _Path_ parameter, the cmdlet returns an error. -If you do not specify this parameter, this cmdlet does not return a value. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path of a folder. -If the folder that this parameter specifies is empty, this cmdlet deletes that folder. -If the folder is not empty, this cmdlet makes no change, and returns an error. - -```yaml -Type: System.String -Parameter Sets: ShareName, Share -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: Directory -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Share -Specifies a **CloudFileShare** object. -This cmdlet removes a folder under the file share that this parameter specifies. -To obtain a **CloudFileShare** object, use the Get-AzureStorageShare cmdlet. -This object contains the storage context. -If you specify this parameter, do not specify the *Context* parameter. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameter Sets: Share -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ShareName -Specifies the name of the file share. -This cmdlet removes a folder under the file share that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ShareName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameters: Share (ByValue) - -### Microsoft.WindowsAzure.Storage.File.CloudFileDirectory -Parameters: Directory (ByValue) - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFileDirectory - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageShare](./Get-AzureStorageShare.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[New-AzureStorageDirectory](./New-AzureStorageDirectory.md) diff --git a/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageFile.md b/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageFile.md deleted file mode 100644 index 2a8028e385..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageFile.md +++ /dev/null @@ -1,314 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 811671E9-592E-4E58-8174-34D665206A65 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/remove-azurestoragefile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Remove-AzureStorageFile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Remove-AzureStorageFile.md ---- - -# Remove-AzureStorageFile - -## SYNOPSIS -Deletes a file. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ShareName (Default) -``` -Remove-AzureStorageFile [-ShareName] [-Path] [-PassThru] [-Context ] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### Share -``` -Remove-AzureStorageFile [-Share] [-Path] [-PassThru] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### Directory -``` -Remove-AzureStorageFile [-Directory] [-Path] [-PassThru] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### File -``` -Remove-AzureStorageFile [-File] [-PassThru] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AzureStorageFile** cmdlet deletes a file. - -## EXAMPLES - -### Example 1: Delete a file from a file share -``` -PS C:\>Remove-AzureStorageFile -ShareName "ContosoShare06" -Path "ContosoFile22" -``` - -This command deletes the file that is named ContosoFile22 from the file share named ContosoShare06. - -### Example 2: Get a file from a file share by using a file share object -``` -PS C:\>Get-AzureStorageShare -Name "ContosoShare06" | Remove-AzureStorageFile -Path "ContosoFile22" -``` - -This command uses the **Get-AzureStorageShare** cmdlet to get the file share named ContosoShare06, and then passes that object to the current cmdlet by using the pipeline operator. -The current command deletes the file that is named ContosoFile22 from ContosoShare06. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the [New-AzureStorageContext](./New-AzureStorageContext.md) cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: ShareName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Directory -Specifies a folder as a **CloudFileDirectory** object. -This cmdlet removes a file in the folder that this parameter specifies. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFileDirectory -Parameter Sets: Directory -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -File -Specifies a file as a **CloudFile** object. -This cmdlet removes the file that this parameter specifies. -To obtain a **CloudFile** object, use the Get-AzureStorageFile cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFile -Parameter Sets: File -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a **Boolean** that reflects the success of the operation. -By default, this cmdlet does not return a value. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path of a file. -This cmdlet deletes the file that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ShareName, Share, Directory -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Share -Specifies a **CloudFileShare** object. -This cmdlet removes the file in the share this parameter specifies. -To obtain a **CloudFileShare** object, use the Get-AzureStorageShare cmdlet. -This object contains the storage context. -If you specify this parameter, do not specify the *Context* parameter. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameter Sets: Share -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ShareName -Specifies the name of the file share. -This cmdlet removes the file in the share this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ShareName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameters: Share (ByValue) - -### Microsoft.WindowsAzure.Storage.File.CloudFileDirectory -Parameters: Directory (ByValue) - -### Microsoft.WindowsAzure.Storage.File.CloudFile -Parameters: File (ByValue) - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFile - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageFile](./Get-AzureStorageFile.md) - -[Get-AzureStorageShare](./Get-AzureStorageShare.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) diff --git a/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageQueue.md b/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageQueue.md deleted file mode 100644 index 8b019cbf20..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageQueue.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 22975A89-CAFF-4F18-8DCE-B695413FBAC7 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/remove-azurestoragequeue -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Remove-AzureStorageQueue.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Remove-AzureStorageQueue.md ---- - -# Remove-AzureStorageQueue - -## SYNOPSIS -Removes a storage queue. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureStorageQueue [-Name] [-Force] [-PassThru] [-Context ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AzureStorageQueue** cmdlet removes a storage queue. - -## EXAMPLES - -### Example 1: Remove a storage queue by name -``` -PS C:\>Remove-AzureStorageQueue "ContosoQueue01" -``` - -This command removes a queue named ContosoQueue01. - -### Example 2: Remove multiple storage queues -``` -PS C:\>Get-AzureStorageQueue "Contoso*" | Remove-AzureStorageQueue -``` - -This command removes all queues with names that start with Contoso. - -## PARAMETERS - -### -Context -Specifies the Azure storage context. -To obtain the storage context, the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the queue to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Queue - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a **Boolean** that reflects the success of the operation. -By default, this cmdlet does not return a value. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageQueue](./Get-AzureStorageQueue.md) - -[New-AzureStorageQueue](./New-AzureStorageQueue.md) diff --git a/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageQueueStoredAccessPolicy.md b/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageQueueStoredAccessPolicy.md deleted file mode 100644 index 3466968b8d..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageQueueStoredAccessPolicy.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 80DE5D60-93F8-4509-AA9C-F54E4AB70013 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/remove-azurestoragequeuestoredaccesspolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Remove-AzureStorageQueueStoredAccessPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Remove-AzureStorageQueueStoredAccessPolicy.md ---- - -# Remove-AzureStorageQueueStoredAccessPolicy - -## SYNOPSIS -Removes a stored access policy from an Azure storage queue. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureStorageQueueStoredAccessPolicy [-Queue] [-Policy] [-PassThru] - [-Context ] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Remove-AzureStorageQueueStoredAccessPolicy** cmdlet removes a stored access policy from an Azure storage queue. - -## EXAMPLES - -### Example 1: Remove a stored access policy from a storage queue -``` -PS C:\>Remove-AzureStorageQueueStoredAccessPolicy -Queue "MyQueue" -Policy "Policy04" -``` - -This command removes an access policy named Policy04 from the storage queue named MyQueue. - -## PARAMETERS - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a **Boolean** that reflects the success of the operation. -By default, this cmdlet does not return a value. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies the name of the stored access policy that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Queue -Specifies the Azure storage queue name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageQueueStoredAccessPolicy](./Get-AzureStorageQueueStoredAccessPolicy.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[New-AzureStorageQueueStoredAccessPolicy](./New-AzureStorageQueueStoredAccessPolicy.md) - -[Set-AzureStorageQueueStoredAccessPolicy](./Set-AzureStorageQueueStoredAccessPolicy.md) diff --git a/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageShare.md b/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageShare.md deleted file mode 100644 index e05a2d82ec..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageShare.md +++ /dev/null @@ -1,275 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: FF3AD436-CA33-4A52-8580-D2345D80A231 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/remove-azurestorageshare -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Remove-AzureStorageShare.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Remove-AzureStorageShare.md ---- - -# Remove-AzureStorageShare - -## SYNOPSIS -Deletes a file share. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ShareName (Default) -``` -Remove-AzureStorageShare [-Name] [-IncludeAllSnapshot] [-Force] [-PassThru] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### Share -``` -Remove-AzureStorageShare [-Share] [-IncludeAllSnapshot] [-Force] [-PassThru] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Remove-AzureStorageShare** cmdlet deletes a file share. - -## EXAMPLES - -### Example 1: Remove a file share -``` -PS C:\>Remove-AzureStorageShare -Name "ContosoShare06" -``` - -This command removes the file share named ContosoShare06. - -### Example 2: Remove a file share and all its snapshots -``` -PS C:\>Remove-AzureStorageShare -Name "ContosoShare06" -IncludeAllSnapshot -``` - -This command removes the file share named ContosoShare06 and all its snapshots. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the [New-AzureStorageContext](./New-AzureStorageContext.md) cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: ShareName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Force to remove the share with all of its snapshots, and all content. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeAllSnapshot -Remove File Share with all of its snapshots - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the file share. -This cmdlet deletes the file share that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ShareName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a **Boolean** that reflects the success of the operation. -By default, this cmdlet does not return a value. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Share -Specifies a **CloudFileShare** object. -This cmdlet removes the object that this parameter specifies. -To obtain a **CloudFileShare** object, use the Get-AzureStorageShare cmdlet. -This object contains the storage context. -If you specify this parameter, do not specify the *Context* parameter. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameter Sets: Share -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameters: Share (ByValue) - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFileShare - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageShare](./Get-AzureStorageShare.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[New-AzureStorageShare](./New-AzureStorageShare.md) diff --git a/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageShareStoredAccessPolicy.md b/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageShareStoredAccessPolicy.md deleted file mode 100644 index 71195882ba..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageShareStoredAccessPolicy.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: E2CCDA8F-2D45-4F25-B297-337B7AB021E0 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/remove-azurestoragesharestoredaccesspolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Remove-AzureStorageShareStoredAccessPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Remove-AzureStorageShareStoredAccessPolicy.md ---- - -# Remove-AzureStorageShareStoredAccessPolicy - -## SYNOPSIS -Removes a stored access policy from a Storage share. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureStorageShareStoredAccessPolicy [-ShareName] [-Policy] [-PassThru] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Remove-AzureStorageShareStoredAccessPolicy** cmdlet removes a stored access policy from an Azure Storage share. - -## EXAMPLES - -### Example 1: Remove a stored access policy from an Azure Storage share -``` -PS C:\>Remove-AzureStorageShareStoredAccessPolicy -ShareName "ContosoShare" -Policy "GeneralPolicy" -``` - -This command removes a stored access policy named GeneralPolicy from ContosoShare. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the [New-AzureStorageContext](./New-AzureStorageContext.md) cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a **Boolean** that reflects the success of the operation. -By default, this cmdlet does not return a value. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies the name of the stored access policy that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShareName -Specifies the Storage share name for which this cmdlet removes a policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageShareStoredAccessPolicy](./Get-AzureStorageShareStoredAccessPolicy.md) - -[New-AzureStorageShareStoredAccessPolicy](./New-AzureStorageShareStoredAccessPolicy.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[Set-AzureStorageShareStoredAccessPolicy](./Set-AzureStorageShareStoredAccessPolicy.md) diff --git a/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageTable.md b/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageTable.md deleted file mode 100644 index 01d66851f6..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageTable.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 1B29AB8C-95DD-4C4F-86E2-2F81E8020CEA -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/remove-azurestoragetable -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Remove-AzureStorageTable.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Remove-AzureStorageTable.md ---- - -# Remove-AzureStorageTable - -## SYNOPSIS -Removes a storage table. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureStorageTable [-Name] [-Force] [-PassThru] [-Context ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AzureStorageTable** cmdlet removes one or more storage tables from a storage account in Azure. - -## EXAMPLES - -### Example 1: Remove a table -``` -PS C:\>Remove-AzureStorageTable -Name "TableABC" -``` - -This command removes a table. - -### Example 2: Remove several tables -``` -PS C:\>Get-AzureStorageTable table* | Remove-AzureStorageTable -``` - -This example uses a wildcard character with the *Name* parameter to get all tables that match the pattern table and then passes the result on the pipeline to remove the tables. - -## PARAMETERS - -### -Context -Specifies the Azure storage context. -You can create it by using the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the table to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Table - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a **Boolean** that reflects the success of the operation. -By default, this cmdlet does not return a value. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageTable](./Get-AzureStorageTable.md) diff --git a/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageTableStoredAccessPolicy.md b/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageTableStoredAccessPolicy.md deleted file mode 100644 index 4aa04cc440..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Remove-AzureStorageTableStoredAccessPolicy.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 30CC0D80-505A-4988-B4EC-3B7BC5B76F5D -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/remove-azurestoragetablestoredaccesspolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Remove-AzureStorageTableStoredAccessPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Remove-AzureStorageTableStoredAccessPolicy.md ---- - -# Remove-AzureStorageTableStoredAccessPolicy - -## SYNOPSIS -Removes a stored access policy from an Azure storage table. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureStorageTableStoredAccessPolicy [-Table] [-Policy] [-PassThru] - [-Context ] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Remove-AzureStorageTableStoredAccessPolicy** cmdlet removes a stored access policy from an Azure storage table. - -## EXAMPLES - -### Example 1: Remove a stored access policy from a storage table -``` -PS C:\>Remove-AzureStorageTableStoredAccessPolicy -Table "MyTable" -Policy "Policy05" -``` - -This command removes policy named Policy05 from storage table named MyTable. - -## PARAMETERS - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a **Boolean** that reflects the success of the operation. -By default, this cmdlet does not return a value. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies the name of the stored access policy that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Table -Specifies the Azure table name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageTableStoredAccessPolicy](./Get-AzureStorageTableStoredAccessPolicy.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[New-AzureStorageTableStoredAccessPolicy](./New-AzureStorageTableStoredAccessPolicy.md) - -[Set-AzureStorageTableStoredAccessPolicy](./Set-AzureStorageTableStoredAccessPolicy.md) diff --git a/azurermps-6.13.0/Azure.Storage/Set-AzureStorageBlobContent.md b/azurermps-6.13.0/Azure.Storage/Set-AzureStorageBlobContent.md deleted file mode 100644 index 7157c87d47..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Set-AzureStorageBlobContent.md +++ /dev/null @@ -1,420 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: F20A5FD3-6EC3-4EFE-988C-75F8583961A4 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/set-azurestorageblobcontent -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Set-AzureStorageBlobContent.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Set-AzureStorageBlobContent.md ---- - -# Set-AzureStorageBlobContent - -## SYNOPSIS -Uploads a local file to an Azure Storage blob. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SendManual (Default) -``` -Set-AzureStorageBlobContent [-File] [-Container] [-Blob ] [-BlobType ] - [-Properties ] [-Metadata ] [-PremiumPageBlobTier ] [-Force] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### ContainerPipeline -``` -Set-AzureStorageBlobContent [-File] [-Blob ] -CloudBlobContainer - [-BlobType ] [-Properties ] [-Metadata ] - [-PremiumPageBlobTier ] [-Force] [-Context ] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### BlobPipeline -``` -Set-AzureStorageBlobContent [-File] -CloudBlob [-BlobType ] - [-Properties ] [-Metadata ] [-PremiumPageBlobTier ] [-Force] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Set-AzureStorageBlobContent** cmdlet uploads a local file to an Azure Storage blob. - -## EXAMPLES - -### Example 1: Upload a named file -``` -PS C:\>Set-AzureStorageBlobContent -Container "ContosoUpload" -File ".\PlanningData" -Blob "Planning2015" -``` - -This command uploads the file that is named PlanningData to a blob named Planning2015. - -### Example 2: Upload all files under the current folder -``` -PS C:\>Get-ChildItem -File -Recurse | Set-AzureStorageBlobContent -Container "ContosoUploads" -``` - -This command uses the core Windows PowerShell cmdlet Get-ChildItem to get all the files in the current folder and in subfolders, and then passes them to the current cmdlet by using the pipeline operator. -The **Set-AzureStorageBlobContent** cmdlet uploads the files to the container named ContosoUploads. - -### Example 3: Overwrite an existing blob -``` -PS C:\>Get-AzureStorageBlob -Container "ContosoUploads" -Blob "Planning2015" | Set-AzureStorageBlobContent -File "ContosoPlanning" -``` - -This command gets the blob named Planning2015 in the ContosoUploads container by using the Get-AzureStorageBlob cmdlet, and then passes that blob to the current cmdlet. -The command uploads the file that is named ContosoPlanning as Planning2015. -This command does not specify the *Force* parameter. -The command prompts you for confirmation. -If you confirm the command, the cmdlet overwrites the existing blob. - -### Example 4: Upload a file to a container by using the pipeline -``` -PS C:\>Get-AzureStorageContainer -Container "ContosoUpload*" | Set-AzureStorageBlobContent -File "ContosoPlanning" -Blob "Planning2015" -``` - -This command gets the container that starts with the string ContosoUpload by using the **Get-AzureStorageContainer** cmdlet, and then passes that blob to the current cmdlet. -The command uploads the file that is named ContosoPlanning as Planning2015. - -### Example 5: Upload a file to page blob with metadata and PremiumPageBlobTier as P10 -``` -PS C:\>$Metadata = @{"key" = "value"; "name" = "test"} -PS C:\> Set-AzureStorageBlobContent -File "ContosoPlanning" -Container "ContosoUploads" -Metadata $Metadata -BlobType Page -PremiumPageBlobTier P10 -``` - -The first command creates a hash table that contains metadata for a blob, and stores that hash table in the $Metadata variable. -The second command uploads the file that is named ContosoPlanning to the container named ContosoUploads. -The blob includes the metadata stored in $Metadata, and has PremiumPageBlobTier as P10. - -### Example 6: Upload a file to blob with specified blob properties -``` -PS C:\> Set-AzureStorageBlobContent -File "ContosoPlanning" -Container "ContosoUploads" -Properties @{"ContentType" = "image/jpeg"; "ContentMD5" = "i727sP7HigloQDsqadNLHw=="} -``` - -This command uploads the file that is named ContosoPlanning to the container named ContosoUploads with specified blob properties. - -## PARAMETERS - -### -Blob -Specifies the name of a blob. -This cmdlet uploads a file to the Azure Storage blob that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: SendManual, ContainerPipeline -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlobType -Specifies the type for the blob that this cmdlet uploads. -The acceptable values for this parameter are: -- Block -- Page -The default value is Block. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Block, Page, Append - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CloudBlob -Specifies a **CloudBlob** object. -To obtain a **CloudBlob** object, use the Get-AzureStorageBlob cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudBlob -Parameter Sets: BlobPipeline -Aliases: ICloudBlob - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CloudBlobContainer -Specifies a **CloudBlobContainer** object from the Azure Storage Client library. -This cmdlet uploads content to a blob in the container that this parameter specifies. -To obtain a **CloudBlobContainer** object, use the Get-AzureStorageContainer cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudBlobContainer -Parameter Sets: ContainerPipeline -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Container -Specifies the name of a container. -This cmdlet uploads a file to a blob in the container that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: SendManual -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. -To use a storage context created from a SAS Token without read permission, need add -Force parameter to skip check blob existance. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -File -Specifies a local file path for a file to upload as blob content. - -```yaml -Type: System.String -Parameter Sets: SendManual -Aliases: FullName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ContainerPipeline, BlobPipeline -Aliases: FullName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Indicates that this cmdlet overwrites an existing blob without prompting you for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Metadata -Specifies metadata for the uploaded blob. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PremiumPageBlobTier -Page Blob Tier - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.PremiumPageBlobTier -Parameter Sets: (All) -Aliases: -Accepted values: Unknown, P4, P6, P10, P20, P30, P40, P50, P60 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Properties -Specifies properties for the uploaded blob. -The supported properties are: CacheControl, ContentDisposition, ContentEncoding, ContentLanguage, ContentMD5, ContentType. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the service side time-out interval, in seconds, for a request. -If the specified interval elapses before the service processes the request, the storage service returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.WindowsAzure.Storage.Blob.CloudBlobContainer - -### Microsoft.WindowsAzure.Storage.Blob.CloudBlob - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageBlob - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageBlobContent](./Get-AzureStorageBlobContent.md) - -[Get-AzureStorageBlob](./Get-AzureStorageBlob.md) - -[Remove-AzureStorageBlob](./Remove-AzureStorageBlob.md) diff --git a/azurermps-6.13.0/Azure.Storage/Set-AzureStorageCORSRule.md b/azurermps-6.13.0/Azure.Storage/Set-AzureStorageCORSRule.md deleted file mode 100644 index 90f7b207c6..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Set-AzureStorageCORSRule.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 288B7B56-B934-45AF-BF56-4EB0DD827522 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/set-azurestoragecorsrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Set-AzureStorageCORSRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Set-AzureStorageCORSRule.md ---- - -# Set-AzureStorageCORSRule - -## SYNOPSIS -Sets the CORS rules for a type of Storage service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureStorageCORSRule [-ServiceType] -CorsRules [-PassThru] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -## DESCRIPTION -The **Set-AzureStorageCORSRule** cmdlet sets the Cross-Origin Resource Sharing (CORS) rules for a type of Azure Storage service. -The types of storage services for this cmdlet are Blob, Table, Queue, and File. -This cmdlet overwrites the existing rules. -To see the current rules, use the Get-AzureStorageCORSRule cmdlet. - -## EXAMPLES - -### Example 1: Assign CORS rules to the blob service -``` -PS C:\>$CorsRules = (@{ - AllowedHeaders=@("x-ms-blob-content-type","x-ms-blob-content-disposition"); - AllowedOrigins=@("*"); - MaxAgeInSeconds=30; - AllowedMethods=@("Get","Connect")}, - @{ - AllowedOrigins=@("http://www.fabrikam.com","http://www.contoso.com"); - ExposedHeaders=@("x-ms-meta-data*","x-ms-meta-customheader"); - AllowedHeaders=@("x-ms-meta-target*","x-ms-meta-customheader"); - MaxAgeInSeconds=30; - AllowedMethods=@("Put")}) -PS C:\> Set-AzureStorageCORSRule -ServiceType Blob -CorsRules $CorsRules -``` - -The first command assigns an array of rules to the $CorsRules variable. -This command uses standard extends over several lines in this code block. -The second command assigns the rules in $CorsRules to the Blob service type. - -### Example 2: Change properties of a CORS rule for blob service -``` -PS C:\>$CorsRules = Get-AzureStorageCORSRule -ServiceType Blob -PS C:\> $CorsRules[0].AllowedHeaders = @("x-ms-blob-content-type", "x-ms-blob-content-disposition") -PS C:\> $CorsRules[0].AllowedMethods = @("Get", "Connect", "Merge") -PS C:\> Set-AzureStorageCORSRule -ServiceType Blob -CorsRules $CorsRules -``` - -The first command gets the current CORS rules for the Blob type by using the **Get-AzureStorageCORSRule** cmdlet. -The command stores the rules in the $CorsRules array variable. -The second and third commands modify the first rule in $CorsRules. -The final command assigns the rules in $CorsRules to the Blob service type. -The revised rules overwrite the current CORS rules. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure Storage context. -To obtain a context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -CorsRules -Specifies an array of CORS rules. -You can retrieve the existing rules using the Get-AzureStorageCORSRule cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Commands.Storage.Model.ResourceModel.PSCorsRule[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a Boolean that reflects the success of the operation. -By default, this cmdlet does not return a value. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceType -Specifies the Azure Storage service type for which this cmdlet assigns rules. -The acceptable values for this parameter are: -- Blob -- Table -- Queue -- File - -```yaml -Type: Microsoft.WindowsAzure.Commands.Storage.Common.StorageServiceType -Parameter Sets: (All) -Aliases: -Accepted values: Blob, Table, Queue, File - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Storage.Model.ResourceModel.PSCorsRule - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageCORSRule](./Get-AzureStorageCORSRule.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[Remove-AzureStorageCORSRule](./Remove-AzureStorageCORSRule.md) - - diff --git a/azurermps-6.13.0/Azure.Storage/Set-AzureStorageContainerAcl.md b/azurermps-6.13.0/Azure.Storage/Set-AzureStorageContainerAcl.md deleted file mode 100644 index bb2fd17147..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Set-AzureStorageContainerAcl.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: BDEEF1EA-A785-4E17-9887-C2000BDFCF57 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/set-azurestoragecontaineracl -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Set-AzureStorageContainerAcl.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Set-AzureStorageContainerAcl.md ---- - -# Set-AzureStorageContainerAcl - -## SYNOPSIS -Sets the public access permission to a storage container. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureStorageContainerAcl [-Name] [-Permission] [-PassThru] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -## DESCRIPTION -The **Set-AzureStorageContainerAcl** cmdlet sets the public access permission to the specified storage container in Azure. - -## EXAMPLES - -### Example 1: Set azure storage container ACL by name -``` -PS C:\>Set-AzureStorageContainerAcl -Container "Container01" -Permission Off -PassThru -``` - -This command creates a container that has no public access. - -### Example 2: Set azure storage container ACL by using the pipeline -``` -PS C:\>Get-AzureStorageContainer container* | Set-AzureStorageContainerAcl -Permission Blob -PassThru -``` - -This command gets all storage containers whose name starts with container and then passes the result on the pipeline to set the permission for them all to Blob access. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies the Azure storage context. -You can create it by using the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a container name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Container - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Permission -Specifies the level of public access to this container. -By default, the container and any blobs in it can be accessed only by the owner of the storage account. -To grant anonymous users read permissions to a container and its blobs, you can set the container permissions to enable public access. -Anonymous users can read blobs in a publicly available container without authenticating the request. -The acceptable values for this parameter are: ---Container. -Provides full read access to a container and its blobs. -Clients can enumerate blobs in the container through anonymous request, but cannot enumerate containers in the storage account. ---Blob. -Provides read access to blob data in a container through anonymous request, but does not provide access to container data. -Clients cannot enumerate blobs in the container by using anonymous request. ---Off. -Restricts access to only the storage account owner. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.BlobContainerPublicAccessType -Parameter Sets: (All) -Aliases: PublicAccess -Accepted values: Off, Container, Blob, Unknown - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the service side time-out interval, in seconds, for a request. -If the specified interval elapses before the service processes the request, the storage service returns an error. -Server side time out for each request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageContainer - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageContainer](./Get-AzureStorageContainer.md) - -[New-AzureStorageContainer](./New-AzureStorageContainer.md) - -[Remove-AzureStorageContainer](./Remove-AzureStorageContainer.md) - - diff --git a/azurermps-6.13.0/Azure.Storage/Set-AzureStorageContainerStoredAccessPolicy.md b/azurermps-6.13.0/Azure.Storage/Set-AzureStorageContainerStoredAccessPolicy.md deleted file mode 100644 index a607a828cf..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Set-AzureStorageContainerStoredAccessPolicy.md +++ /dev/null @@ -1,285 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 730ECC60-72DE-46DA-A177-D5749F540710 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/set-azurestoragecontainerstoredaccesspolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Set-AzureStorageContainerStoredAccessPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Set-AzureStorageContainerStoredAccessPolicy.md ---- - -# Set-AzureStorageContainerStoredAccessPolicy - -## SYNOPSIS -Sets a stored access policy for an Azure storage container. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureStorageContainerStoredAccessPolicy [-Container] [-Policy] [-Permission ] - [-StartTime ] [-ExpiryTime ] [-NoStartTime] [-NoExpiryTime] [-Context ] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Set-AzureStorageContainerStoredAccessPolicy** cmdlet sets a stored access policy for an Azure storage container. - -## EXAMPLES - -### Example 1: Set a stored access policy in a storage container with full permission -``` -PS C:\>Set-AzureStorageContainerStoredAccessPolicy -Container "MyContainer" -Policy "Policy06" -Permission rwdl -``` - -This command sets an access policy named Policy06 for storage container named MyContainer. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Container -Specifies the Azure storage container name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpiryTime -Specifies the time at which the stored access policy becomes invalid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoExpiryTime -Indicates that the access policy has no expiration date. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoStartTime -Sets the start time to be $Null. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Permission -Specifies permissions in the stored access policy to access the storage container. -It is important to note that this is a string, like `rwd` (for Read, Write and Delete). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies the name for the stored access policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Specifies the time at which the stored access policy becomes valid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageContainerStoredAccessPolicy](./Get-AzureStorageContainerStoredAccessPolicy.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[New-AzureStorageContainerStoredAccessPolicy](./New-AzureStorageContainerStoredAccessPolicy.md) - -[Remove-AzureStorageContainerStoredAccessPolicy](./Remove-AzureStorageContainerStoredAccessPolicy.md) diff --git a/azurermps-6.13.0/Azure.Storage/Set-AzureStorageFileContent.md b/azurermps-6.13.0/Azure.Storage/Set-AzureStorageFileContent.md deleted file mode 100644 index d4c5f728f0..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Set-AzureStorageFileContent.md +++ /dev/null @@ -1,337 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: FA98E64B-D589-4653-9ACC-86573FAF4550 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/set-azurestoragefilecontent -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Set-AzureStorageFileContent.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Set-AzureStorageFileContent.md ---- - -# Set-AzureStorageFileContent - -## SYNOPSIS -Uploads the contents of a file. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ShareName (Default) -``` -Set-AzureStorageFileContent [-ShareName] [-Source] [[-Path] ] [-PassThru] [-Force] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### Share -``` -Set-AzureStorageFileContent [-Share] [-Source] [[-Path] ] [-PassThru] - [-Force] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### Directory -``` -Set-AzureStorageFileContent [-Directory] [-Source] [[-Path] ] [-PassThru] - [-Force] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Set-AzureStorageFileContent** cmdlet uploads the contents of a file to a file on a specified share. - -## EXAMPLES - -### Example 1: Upload a file in the current folder -``` -PS C:\>Set-AzureStorageFileContent -ShareName "ContosoShare06" -Source "DataFile37" -Path "ContosoWorkingFolder/CurrentDataFile" -``` - -This command uploads a file that is named DataFile37 in the current folder as a file that is named CurrentDataFile in the folder named ContosoWorkingFolder. - -### Example 2: Upload all the files in the current folder -``` -PS C:\>$CurrentFolder = (Get-Item .).FullName -PS C:\> $Container = Get-AzureStorageShare -Name "ContosoShare06" -PS C:\> Get-ChildItem -Recurse | Where-Object { $_.GetType().Name -eq "FileInfo"} | ForEach-Object { - $path=$_.FullName.Substring($Currentfolder.Length+1).Replace("\","/") - Set-AzureStorageFileContent -Share $Container -Source $_.FullName -Path $path -Force -} -``` - -This example uses several common Windows PowerShell cmdlets and the current cmdlet to upload all files from the current folder to the root folder of container ContosoShare06. -The first command gets the name of the current folder and stores it in the $CurrentFolder variable. -The second command uses the **Get-AzureStorageShare** cmdlet to get the file share named ContosoShare06, and then stores it in the $Container variable. -The final command gets the contents of the current folder and passes each one to the Where-Object cmdlet by using the pipeline operator. -That cmdlet filters out objects that are not files, and then passes the files to the ForEach-Object cmdlet. -That cmdlet runs a script block for each file that creates the appropriate path for it and then uses the current cmdlet to upload the file. -The result has the same name and same relative position with regard to the other files that this example uploads. -For more information about script blocks, type `Get-Help about_Script_Blocks`. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the [New-AzureStorageContext](./New-AzureStorageContext.md) cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: ShareName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Directory -Specifies a folder as a **CloudFileDirectory** object. -This cmdlet uploads the file to the folder that this parameter specifies. -To obtain a directory, use the New-AzureStorageDirectory cmdlet. -You can also use the Get-AzureStorageFile cmdlet to obtain a directory. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFileDirectory -Parameter Sets: Directory -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Force -Indicates that this cmdlet overwrites an existing Azure storage file. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns the **AzureStorageFile** object that it creates or uploads. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path of a file or folder. -This cmdlet uploads contents to the file that this parameter specifies, or to a file in the folder that this parameter specifies. -If you specify a folder, this cmdlet creates a file that has the same name as the source file. -If you specify a path of a file that does not exist, this cmdlet creates that file and saves the contents to that file. -If you specify a file that already exists, and you specify the _Force_ parameter, this cmdlet overwrites the contents of the file. -If you specify a file that already exists and you do not specify _Force_, this cmdlet makes no change, and returns an error. -If you specify a path of a folder that does not exist, this cmdlet makes no change, and returns an error. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Share -Specifies a **CloudFileShare** object. -This cmdlet uploads to a file in the file share this parameter specifies. -To obtain a **CloudFileShare** object, use the Get-AzureStorageShare cmdlet. -This object contains the storage context. -If you specify this parameter, do not specify the *Context* parameter. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameter Sets: Share -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ShareName -Specifies the name of the file share. -This cmdlet uploads to a file in the file share this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ShareName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Source -Specifies the source file that this cmdlet uploads. -If you specify a file that does not exist, this cmdlet returns an error. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: FullName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameters: Share (ByValue) - -### Microsoft.WindowsAzure.Storage.File.CloudFileDirectory -Parameters: Directory (ByValue) - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFile - -## NOTES - -## RELATED LINKS - -[Remove-AzureStorageDirectory](./Remove-AzureStorageDirectory.md) - -[New-AzureStorageDirectory](./New-AzureStorageDirectory.md) - -[Get-AzureStorageFileContent](./Get-AzureStorageFileContent.md) diff --git a/azurermps-6.13.0/Azure.Storage/Set-AzureStorageQueueStoredAccessPolicy.md b/azurermps-6.13.0/Azure.Storage/Set-AzureStorageQueueStoredAccessPolicy.md deleted file mode 100644 index f8c8ef0852..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Set-AzureStorageQueueStoredAccessPolicy.md +++ /dev/null @@ -1,228 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 4FB7E017-7D37-4EDB-BEC1-36629058B87C -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/set-azurestoragequeuestoredaccesspolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Set-AzureStorageQueueStoredAccessPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Set-AzureStorageQueueStoredAccessPolicy.md ---- - -# Set-AzureStorageQueueStoredAccessPolicy - -## SYNOPSIS -Sets a stored access policy for an Azure storage queue. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureStorageQueueStoredAccessPolicy [-Queue] [-Policy] [-Permission ] - [-StartTime ] [-ExpiryTime ] [-NoStartTime] [-NoExpiryTime] [-Context ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Set-AzureStorageQueueStoredAccessPolicy** cmdlet sets a stored access policy for an Azure storage queue. - -## EXAMPLES - -### Example 1: Set a stored access policy in the queue with full permission -``` -PS C:\> Set-AzureStorageQueueStoredAccessPolicy -Queue "MyQueue" -Policy "Policy07" -Permission arup -``` - -This command sets an access policy named Policy07 for storage queue named MyQueue. - -## PARAMETERS - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpiryTime -Specifies the time at which the stored access policy becomes invalid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoExpiryTime -Indicates that the access policy has no expiration date. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoStartTime -Indicates that this cmdlet sets the start time to be $Null. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Permission -Specifies permissions in the stored access policy to access the storage queue. -It is important to note that this is a string, like `rwd` (for Read, Write and Delete). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies the name for the stored access policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Queue -Specifies the Azure storage queue name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -StartTime -Specifies the time at which the stored access policy becomes valid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageQueueStoredAccessPolicy](./Get-AzureStorageQueueStoredAccessPolicy.md) - -[New-AzureStorageQueueStoredAccessPolicy](./New-AzureStorageQueueStoredAccessPolicy.md) - -[Remove-AzureStorageQueueStoredAccessPolicy](./Remove-AzureStorageQueueStoredAccessPolicy.md) diff --git a/azurermps-6.13.0/Azure.Storage/Set-AzureStorageServiceLoggingProperty.md b/azurermps-6.13.0/Azure.Storage/Set-AzureStorageServiceLoggingProperty.md deleted file mode 100644 index 4d9cfb9a95..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Set-AzureStorageServiceLoggingProperty.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 5422429E-C609-4C1F-A021-E2A085B5F74E -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/set-azurestorageserviceloggingproperty -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Set-AzureStorageServiceLoggingProperty.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Set-AzureStorageServiceLoggingProperty.md ---- - -# Set-AzureStorageServiceLoggingProperty - -## SYNOPSIS -Modifies logging for Azure Storage services. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureStorageServiceLoggingProperty [-ServiceType] [-Version ] - [-RetentionDays ] [-LoggingOperations ] [-PassThru] [-Context ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Set-AzureStorageServiceLoggingProperty** cmdlet modifies logging for Azure Storage services. - -## EXAMPLES - -### Example 1: Modify logging properties for the Blob service -``` -C:\PS>Set-AzureStorageServiceLoggingProperty -ServiceType Blob -LoggingOperations Read,Write -PassThru -RetentionDays 10 -Version 1.0 -``` - -This command modifies version 1.0 logging for blob storage to include read and write operations. -Azure Storage service logging retains entries for 10 days. -Because this command specifies the *PassThru* parameter, the command displays the modified logging properties. - -## PARAMETERS - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoggingOperations -Specifies an array of Azure Storage service operations. -Azure Storage services logs the operations that this parameter specifies. -The acceptable values for this parameter are: -- None -- Read -- Write -- Delete -- All - -```yaml -Type: Microsoft.WindowsAzure.Storage.Shared.Protocol.LoggingOperations[] -Parameter Sets: (All) -Aliases: -Accepted values: None, Read, Write, Delete, All - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns the updated logging properties. -If you do not specify this parameter, this cmdlet does not return a value. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionDays -Specifies the number of days that the Azure Storage service retains logged information. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceType -Specifies the storage service type. -This cmdlet modifies the logging properties for the service type that this parameter specifies. -The acceptable values for this parameter are: -- Blob -- Table -- Queue -- File -The value of File is not currently supported. - -```yaml -Type: Microsoft.WindowsAzure.Commands.Storage.Common.StorageServiceType -Parameter Sets: (All) -Aliases: -Accepted values: Blob, Table, Queue, File - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Version -Specifies the version of the Azure Storage service logging. -The default value is 1.0. - -```yaml -Type: System.Nullable`1[System.Double] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.Shared.Protocol.LoggingProperties - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageServiceLoggingProperty](./Get-AzureStorageServiceLoggingProperty.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - - diff --git a/azurermps-6.13.0/Azure.Storage/Set-AzureStorageServiceMetricsProperty.md b/azurermps-6.13.0/Azure.Storage/Set-AzureStorageServiceMetricsProperty.md deleted file mode 100644 index d7f0cf2451..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Set-AzureStorageServiceMetricsProperty.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 5878FAD4-A4BB-4DBF-A1F2-221FD34F0308 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/set-azurestorageservicemetricsproperty -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Set-AzureStorageServiceMetricsProperty.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Set-AzureStorageServiceMetricsProperty.md ---- - -# Set-AzureStorageServiceMetricsProperty - -## SYNOPSIS -Modifies metrics properties for the Azure Storage service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureStorageServiceMetricsProperty [-ServiceType] [-MetricsType] - [-Version ] [-RetentionDays ] [-MetricsLevel ] [-PassThru] - [-Context ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Set-AzureStorageServiceMetricsProperty** cmdlet modifies metrics properties for the Azure Storage service. - -## EXAMPLES - -### Example 1: Modify metrics properties for the Blob service -``` -C:\PS>Set-AzureStorageServiceMetricsProperty -ServiceType Blob -MetricsType Hour -MetricsLevel Service -PassThru -RetentionDays 10 -Version 1.0 -``` - -This command modifies version 1.0 metrics for blob storage to a level of Service. -Azure Storage service metrics retains entries for 10 days. -Because this command specifies the *PassThru* parameter, the command displays the modified metrics properties. - -## PARAMETERS - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MetricsLevel -Specifies the metrics level that Azure Storage uses for the service. -The acceptable values for this parameter are: -- None -- Service -- ServiceAndApi - -```yaml -Type: System.Nullable`1[Microsoft.WindowsAzure.Storage.Shared.Protocol.MetricsLevel] -Parameter Sets: (All) -Aliases: -Accepted values: None, Service, ServiceAndApi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MetricsType -Specifies a metrics type. -This cmldet sets the Azure Storage service metrics type to the value that this parameter specifies. -The acceptable values for this parameter are: Hour and Minute. - -```yaml -Type: Microsoft.WindowsAzure.Commands.Storage.Common.ServiceMetricsType -Parameter Sets: (All) -Aliases: -Accepted values: Hour, Minute - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlets returns the updated metrics properties. -If you do not specify this parameter, this cmdlet does not return a value. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionDays -Specifies the number of days that the Azure Storage service retains metrics information. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceType -Specifies the storage service type. -This cmdlet modifies the metrics properties for the service type that this parameter specifies. -The acceptable values for this parameter are: -- Blob -- Table -- Queue -- File -The value of File is not currently supported. - -```yaml -Type: Microsoft.WindowsAzure.Commands.Storage.Common.StorageServiceType -Parameter Sets: (All) -Aliases: -Accepted values: Blob, Table, Queue, File - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Version -Specifies the version of the Azure Storage metrics. -The default value is 1.0. - -```yaml -Type: System.Nullable`1[System.Double] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.Shared.Protocol.MetricsProperties - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageServiceMetricsProperty](./Get-AzureStorageServiceMetricsProperty.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - - diff --git a/azurermps-6.13.0/Azure.Storage/Set-AzureStorageShareQuota.md b/azurermps-6.13.0/Azure.Storage/Set-AzureStorageShareQuota.md deleted file mode 100644 index 43fec65f78..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Set-AzureStorageShareQuota.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 176294FA-BB08-4A63-AD45-1E6C6D67A5D8 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/set-azurestoragesharequota -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Set-AzureStorageShareQuota.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Set-AzureStorageShareQuota.md ---- - -# Set-AzureStorageShareQuota - -## SYNOPSIS -Sets the storage capacity for a share. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ShareName -``` -Set-AzureStorageShareQuota [-ShareName] [-Quota] [-Context ] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -### Share -``` -Set-AzureStorageShareQuota [-Share] [-Quota] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [] -``` - -## DESCRIPTION -The **Set-AzureStorageShareQuota** cmdlet sets the storage capacity for a specified share. - -## EXAMPLES - -### Example 1: Set the storage capacity of a share -``` -PS C:\>Set-AzureStorageShareQuota -ShareName "ContosoShare01" -Quota 1024 -``` - -This command sets the storage capacity for a share named ContosoShare01 to 1024 GB. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the [New-AzureStorageContext](./New-AzureStorageContext.md) cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: ShareName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Quota -Specifies the quota value in gigabytes (GB). -See the quota limitation in https://docs.microsoft.com/en-us/azure/azure-subscription-service-limits#azure-files-limits. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Share -Specifies a **CloudFileShare** object to represent the share for which this cmdlets sets a quota. -To obtain a **CloudFileShare** object, use the Get-AzureStorageShare cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameter Sets: Share -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ShareName -Specifies the name of the file share for which to set a quota. - -```yaml -Type: System.String -Parameter Sets: ShareName -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameters: Share (ByValue) - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.File.FileShareProperties - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageFileContent](./Get-AzureStorageFileContent.md) - -[Get-AzureStorageShare](./Get-AzureStorageShare.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) diff --git a/azurermps-6.13.0/Azure.Storage/Set-AzureStorageShareStoredAccessPolicy.md b/azurermps-6.13.0/Azure.Storage/Set-AzureStorageShareStoredAccessPolicy.md deleted file mode 100644 index 94ceeec99c..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Set-AzureStorageShareStoredAccessPolicy.md +++ /dev/null @@ -1,283 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: C21CC2FA-017E-492E-96E7-B37829917FAF -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/set-azurestoragesharestoredaccesspolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Set-AzureStorageShareStoredAccessPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Set-AzureStorageShareStoredAccessPolicy.md ---- - -# Set-AzureStorageShareStoredAccessPolicy - -## SYNOPSIS -Updates a stored access policy on a Storage share. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureStorageShareStoredAccessPolicy [-ShareName] [-Policy] [-Permission ] - [-StartTime ] [-ExpiryTime ] [-NoStartTime] [-NoExpiryTime] [-Context ] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Set-AzureStorageShareStoredAccessPolicy** cmdlet updates stored access policy on an Azure Storage share. - -## EXAMPLES - -### Example 1: Update a stored access policy in Storage share -``` -PS C:\>Set-AzureStorageShareStoredAccessPolicy -ShareName "ContosoShare" -Policy "GeneralPolicy" -Permission "rwdl" -``` - -This command updates a stored access policy that has full permission in a share. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the [New-AzureStorageContext](./New-AzureStorageContext.md) cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpiryTime -Specifies the time at which the stored access policy becomes invalid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoExpiryTime -Indicates that this cmdlet clears the **ExpiryTime** property in the stored access policy. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoStartTime -Indicates that this cmdlet clears the **StartTime** property in the stored access policy. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Permission -Specifies permissions in the stored access policy to access the share or files under it. -It is important to note that this is a string, like `rwd` (for Read, Write and Delete). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies a name for the stored access policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShareName -Specifies the name of the Storage share. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -StartTime -Specifies the time at which the stored access policy becomes valid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageShareStoredAccessPolicy](./Get-AzureStorageShareStoredAccessPolicy.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[New-AzureStorageShareStoredAccessPolicy](./New-AzureStorageShareStoredAccessPolicy.md) - -[Remove-AzureStorageShareStoredAccessPolicy](./Remove-AzureStorageShareStoredAccessPolicy.md) diff --git a/azurermps-6.13.0/Azure.Storage/Set-AzureStorageTableStoredAccessPolicy.md b/azurermps-6.13.0/Azure.Storage/Set-AzureStorageTableStoredAccessPolicy.md deleted file mode 100644 index e56c696787..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Set-AzureStorageTableStoredAccessPolicy.md +++ /dev/null @@ -1,230 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: FF2BFE34-4A12-49F9-9BE5-4084A36BC272 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/set-azurestoragetablestoredaccesspolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Set-AzureStorageTableStoredAccessPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Set-AzureStorageTableStoredAccessPolicy.md ---- - -# Set-AzureStorageTableStoredAccessPolicy - -## SYNOPSIS -Sets the stored access policy for an Azure storage table. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureStorageTableStoredAccessPolicy [-Table] [-Policy] [-Permission ] - [-StartTime ] [-ExpiryTime ] [-NoStartTime] [-NoExpiryTime] [-Context ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Set-AzureStorageTableStoredAccessPolicy** cmdlet set the stored access policy for an Azure storage table. - -## EXAMPLES - -### Example 1: Set a stored access policy in table with full permission -``` -PS C:\>Set-AzureStorageTableStoredAccessPolicy -Table "MyTable" -Policy "Policy08" -Permission raud -``` - -This command sets an access policy named Policy08 for storage table named MyTable. - -## PARAMETERS - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpiryTime -Specifies the time at which the stored access policy expires. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoExpiryTime -Indicates that the access policy has no expiration date. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoStartTime -Indicates that the start time is set to $Null. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Permission -Specifies permissions in the stored access policy to access the storage table. -It is important to note that this is a string, like `rwd` (for Read, Write and Delete). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies the name for the stored access policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Specifies the time at which the stored access policy becomes valid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Table -Specifies the Azure storage table name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageTableStoredAccessPolicy](./Get-AzureStorageTableStoredAccessPolicy.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[New-AzureStorageTableStoredAccessPolicy](./New-AzureStorageTableStoredAccessPolicy.md) - -[Remove-AzureStorageTableStoredAccessPolicy](./Remove-AzureStorageTableStoredAccessPolicy.md) diff --git a/azurermps-6.13.0/Azure.Storage/Start-AzureStorageBlobCopy.md b/azurermps-6.13.0/Azure.Storage/Start-AzureStorageBlobCopy.md deleted file mode 100644 index 21d44fb0d0..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Start-AzureStorageBlobCopy.md +++ /dev/null @@ -1,574 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 54585346-04E2-4FB4-B5FD-833A85C46ACB -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/start-azurestorageblobcopy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Start-AzureStorageBlobCopy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Start-AzureStorageBlobCopy.md ---- - -# Start-AzureStorageBlobCopy - -## SYNOPSIS -Starts to copy a blob. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ContainerName (Default) -``` -Start-AzureStorageBlobCopy [-SrcBlob] -SrcContainer -DestContainer - [-DestBlob ] [-PremiumPageBlobTier ] [-Context ] - [-DestContext ] [-Force] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -### BlobInstance -``` -Start-AzureStorageBlobCopy -CloudBlob -DestContainer [-DestBlob ] - [-PremiumPageBlobTier ] [-Context ] [-DestContext ] - [-Force] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### BlobInstanceToBlobInstance -``` -Start-AzureStorageBlobCopy -CloudBlob -DestCloudBlob - [-PremiumPageBlobTier ] [-Context ] [-DestContext ] - [-Force] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### ContainerInstance -``` -Start-AzureStorageBlobCopy -CloudBlobContainer [-SrcBlob] -DestContainer - [-DestBlob ] [-PremiumPageBlobTier ] [-Context ] - [-DestContext ] [-Force] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -### ShareName -``` -Start-AzureStorageBlobCopy -SrcShareName -SrcFilePath -DestContainer - [-DestBlob ] [-Context ] [-DestContext ] [-Force] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### ShareInstance -``` -Start-AzureStorageBlobCopy -SrcShare -SrcFilePath -DestContainer - [-DestBlob ] [-Context ] [-DestContext ] [-Force] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### DirInstance -``` -Start-AzureStorageBlobCopy -SrcDir -SrcFilePath -DestContainer - [-DestBlob ] [-Context ] [-DestContext ] [-Force] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### FileInstance -``` -Start-AzureStorageBlobCopy -SrcFile -DestContainer [-DestBlob ] - [-Context ] [-DestContext ] [-Force] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -### FileInstanceToBlobInstance -``` -Start-AzureStorageBlobCopy -SrcFile -DestCloudBlob [-Context ] - [-DestContext ] [-Force] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -### UriPipeline -``` -Start-AzureStorageBlobCopy -AbsoluteUri -DestContainer -DestBlob - [-Context ] [-DestContext ] [-Force] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Start-AzureStorageBlobCopy** cmdlet starts to copy a blob. - -## EXAMPLES - -### Example 1: Copy a named blob -``` -C:\PS>Start-AzureStorageBlobCopy -SrcBlob "ContosoPlanning2015" -DestContainer "ContosoArchives" -SrcContainer "ContosoUploads" -``` - -This command starts the copy operation of the blob named ContosoPlanning2015 from the container named ContosoUploads to the container named ContosoArchives. - -### Example 2: Get a container to specify blobs to copy -``` -C:\PS>Get-AzureStorageContainer -Name "ContosoUploads" | Start-AzureStorageBlobCopy -SrcBlob "ContosoPlanning2015" -DestContainer "ContosoArchives" -``` - -This command gets the container named ContosoUploads, by using the **Get-AzureStorageContainer** cmdlet, and then passes the container to the current cmdlet by using the pipeline operator. -That cmdlet starts the copy operation of the blob named ContosoPlanning2015. -The previous cmdlet provides the source container. -The *DestContainer* parameter specifies ContosoArchives as the destination container. - -### Example 3: Get all blobs in a container and copy them -``` -C:\PS>Get-AzureStorageBlob -Container "ContosoUploads" | Start-AzureStorageBlobCopy -DestContainer "ContosoArchives" -``` - -This command gets the blobs in the container named ContosoUploads, by using the **Get-AzureStorageBlob** cmdlet, and then passes the results to the current cmdlet by using the pipeline operator. -That cmdlet starts the copy operation of the blobs to the container named ContosoArchives. - -### Example 4: Copy a blob specified as an object -``` -C:\PS>$SrcBlob = Get-AzureStorageBlob -Container "ContosoUploads" -Blob "ContosoPlanning2015" -C:\PS> $DestBlob = Get-AzureStorageBlob -Container "ContosoArchives" -Blob "ContosoPlanning2015Archived" -C:\PS> Start-AzureStorageBlobCopy -ICloudBlob $SrcBlob.ICloudBlob -DestICloudBlob $DestBlob.ICloudBlob -``` - -The first command gets the blob named ContosoPlanning2015 in the container named ContosoUploads. -The command stores that object in the $SrcBlob variable. -The second command gets the blob named ContosoPlanning2015Archived in the container named ContosoArchives. -The command stores that object in the $DestBlob variable. -The last command starts the copy operation from the source container to the destination container. -The command uses standard dot notation to specify the **ICloudBlob** objects for the $SrcBlob and $DestBlob blobs. - -### Example 5: Copy a blob from a URI -``` -C:\PS>$Context = New-AzureStorageContext -StorageAccountName "ContosoGeneral" -StorageAccountKey "< Storage Key for ContosoGeneral ends with == >" -C:\PS> Start-AzureStorageBlobCopy -AbsoluteUri "http://www.contosointernal.com/planning" -DestContainer "ContosoArchive" -DestBlob "ContosoPlanning2015" -DestContext $Context -``` - -This command creates a context for the account named ContosoGeneral that uses the specified key, and then stores that key in the $Context variable. -The second command copies the file from the specified URI to the blob named ContosoPlanning in the container named ContosoArchive. -The command starts the copy operation in the context stored in $Context. - -## PARAMETERS - -### -AbsoluteUri -Specifies the absolute URI of a file to copy to an Azure Storage blob. - -```yaml -Type: System.String -Parameter Sets: UriPipeline -Aliases: SrcUri, SourceUri - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CloudBlob -Specifies a **CloudBlob** object from Azure Storage Client library. -To obtain a **CloudBlob** object, use the Get-AzureStorageBlob cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudBlob -Parameter Sets: BlobInstance, BlobInstanceToBlobInstance -Aliases: SrcICloudBlob, SrcCloudBlob, ICloudBlob, SourceICloudBlob, SourceCloudBlob - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -CloudBlobContainer -Specifies a **CloudBlobContainer** object from the Azure Storage Client library. -This cmdlet copies a blob from the container that this parameter specifies. -To obtain a **CloudBlobContainer** object, use the Get-AzureStorageContainer cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudBlobContainer -Parameter Sets: ContainerInstance -Aliases: SourceCloudBlobContainer - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: ContainerName, BlobInstance, BlobInstanceToBlobInstance, ContainerInstance, ShareName, ShareInstance, DirInstance, FileInstance, FileInstanceToBlobInstance -Aliases: SrcContext, SourceContext - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: UriPipeline -Aliases: SrcContext, SourceContext - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestBlob -Specifies the name of the destination blob. - -```yaml -Type: System.String -Parameter Sets: ContainerName, BlobInstance, ContainerInstance, ShareName, ShareInstance, DirInstance, FileInstance -Aliases: DestinationBlob - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: UriPipeline -Aliases: DestinationBlob - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestCloudBlob -Specifies a destination **CloudBlob** object - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudBlob -Parameter Sets: BlobInstanceToBlobInstance, FileInstanceToBlobInstance -Aliases: DestICloudBlob, DestinationCloudBlob, DestinationICloudBlob - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestContainer -Specifies the name of the destination container. - -```yaml -Type: System.String -Parameter Sets: ContainerName, BlobInstance, ContainerInstance, ShareName, ShareInstance, DirInstance, FileInstance, UriPipeline -Aliases: DestinationContainer - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestContext -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: DestinationContext - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Indicates that this cmdlet overwrites the destination blob without prompting you for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PremiumPageBlobTier -Premium Page Blob Tier - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.PremiumPageBlobTier -Parameter Sets: ContainerName, BlobInstance, BlobInstanceToBlobInstance, ContainerInstance -Aliases: -Accepted values: Unknown, P4, P6, P10, P20, P30, P40, P50, P60 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the service side time-out interval, in seconds, for a request. -If the specified interval elapses before the service processes the request, the storage service returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SrcBlob -Specifies the name of the source blob. - -```yaml -Type: System.String -Parameter Sets: ContainerName, ContainerInstance -Aliases: SourceBlob - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SrcContainer -Specifies the name of the source container. - -```yaml -Type: System.String -Parameter Sets: ContainerName -Aliases: SourceContainer - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SrcDir -Specifies a **CloudFileDirectory** object from Azure Storage Client library. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFileDirectory -Parameter Sets: DirInstance -Aliases: SourceDir - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SrcFile -Specifes a **CloudFile** object from Azure Storage Client library. -You can create it or use Get-AzureStorageFile cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFile -Parameter Sets: FileInstance, FileInstanceToBlobInstance -Aliases: SourceFile - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SrcFilePath -Specifies the source file relative path of source directory or source share. - -```yaml -Type: System.String -Parameter Sets: ShareName, ShareInstance, DirInstance -Aliases: SourceFilePath - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SrcShare -Specifies a **CloudFileShare** object from Azure Storage Client library. -You can create it or use Get-AzureStorageShare cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameter Sets: ShareInstance -Aliases: SourceShare - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SrcShareName -Specifies the source share name. - -```yaml -Type: System.String -Parameter Sets: ShareName -Aliases: SourceShareName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.WindowsAzure.Storage.Blob.CloudBlob - -### Microsoft.WindowsAzure.Storage.Blob.CloudBlobContainer - -### Microsoft.WindowsAzure.Storage.File.CloudFile -Parameters: SrcFile (ByValue) - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageBlob - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageBlobCopyState](./Get-AzureStorageBlobCopyState.md) - -[Stop-AzureStorageBlobCopy](./Stop-AzureStorageBlobCopy.md) diff --git a/azurermps-6.13.0/Azure.Storage/Start-AzureStorageBlobIncrementalCopy.md b/azurermps-6.13.0/Azure.Storage/Start-AzureStorageBlobIncrementalCopy.md deleted file mode 100644 index b944e74683..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Start-AzureStorageBlobIncrementalCopy.md +++ /dev/null @@ -1,398 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/start-azurestorageblobincrementalcopy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Start-AzureStorageBlobIncrementalCopy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Start-AzureStorageBlobIncrementalCopy.md ---- - -# Start-AzureStorageBlobIncrementalCopy - -## SYNOPSIS -Start an Incremental copy operation from a Page blob snapshot to the specified destination Page blob. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ContainerInstance (Default) -``` -Start-AzureStorageBlobIncrementalCopy -CloudBlobContainer -SrcBlob - -SrcBlobSnapshotTime -DestContainer [-DestBlob ] - [-Context ] [-DestContext ] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -### BlobInstance -``` -Start-AzureStorageBlobIncrementalCopy -CloudBlob -DestContainer [-DestBlob ] - [-Context ] [-DestContext ] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -### BlobInstanceToBlobInstance -``` -Start-AzureStorageBlobIncrementalCopy -CloudBlob -DestCloudBlob - [-Context ] [-DestContext ] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -### ContainerName -``` -Start-AzureStorageBlobIncrementalCopy -SrcBlob -SrcContainer - -SrcBlobSnapshotTime -DestContainer [-DestBlob ] - [-Context ] [-DestContext ] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -### UriPipeline -``` -Start-AzureStorageBlobIncrementalCopy -AbsoluteUri -DestContainer -DestBlob - [-Context ] [-DestContext ] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Start an Incremental copy operation from a Page blob snapshot to the specified destination Page blob. -See more details of the feature in https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/incremental-copy-blob. - -## EXAMPLES - -### Example 1: Start Incremental Copy Operation by blob name and snapshot time -``` -PS C:\>Start-AzureStorageBlobIncrementalCopy -SrcContainer container1 -SrcBlob blob1 -SrcBlobSnapshotTime "04/07/2017 09:55:36.1190229 AM +00:00" -DestContainer container2 -DestBlob blob2 -``` - -This command start Incremental Copy Operation by blob name and snapshot time - -### Example 2: Start Incremental copy operation using source uri -``` -PS C:\>Start-AzureStorageBlobIncrementalCopy -AbsoluteUri "http://www.somesite.com/somefile?snapshot=2017-04-07T10:05:40.2126635Z" -DestContainer container -DestBlob blob -DestContext $context -``` - -This command start Incremental Copy Operation using source uri - -### Example 3: Start Incremental copy operation using container pipeline from GetAzureStorageContainer -``` -PS C:\>Get-AzureStorageContainer -Container container1 | Start-AzureStorageBlobIncrementalCopy -SrcBlob blob -SrcBlobSnapshotTime "04/07/2017 09:55:36.1190229 AM +00:00" -DestContainer container2 -``` - -This command start Incremental Copy Operation using container pipeline from GetAzureStorageContainer - -### Example 4: start Incremental copy operation from CloudPageBlob object to destination blob with blob name -``` -PS C:\>$srcBlobSnapshot = Get-AzureStorageBlob -Container container1 -prefix blob1| ?{$_.ICloudBlob.IsSnapshot})[0] -PS C:\>Start-AzureStorageBlobIncrementalCopy -CloudBlob $srcBlobSnapshot.ICloudBlob -DestContainer container2 -DestBlob blob2 -``` - -This command start Incremental Copy Operation from CloudPageBlob object to destination blob with blob name - -## PARAMETERS - -### -AbsoluteUri -Absolute Uri to the source. Be noted that the credential should be provided in the Uri, if the source requires any. - -```yaml -Type: System.String -Parameter Sets: UriPipeline -Aliases: SrcUri, SourceUri - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ClientTimeoutPerRequest -The client side maximum execution time for each request in seconds. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CloudBlob -CloudBlob object from Azure Storage Client library. You can create it or use Get-AzureStorageBlob cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudPageBlob -Parameter Sets: BlobInstance, BlobInstanceToBlobInstance -Aliases: SrcICloudBlob, SrcCloudBlob, ICloudBlob, SourceICloudBlob, SourceCloudBlob - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -CloudBlobContainer -CloudBlobContainer object from Azure Storage Client library. You can create it or use Get-AzureStorageContainer cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudBlobContainer -Parameter Sets: ContainerInstance -Aliases: SourceCloudBlobContainer - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -The total amount of concurrent async tasks. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Source Azure Storage Context. You can create it by New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: ContainerInstance, BlobInstance, BlobInstanceToBlobInstance, ContainerName -Aliases: SrcContext, SourceContext - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: UriPipeline -Aliases: SrcContext, SourceContext - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestBlob -Destination blob name - -```yaml -Type: System.String -Parameter Sets: ContainerInstance, BlobInstance, ContainerName -Aliases: DestinationBlob - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: UriPipeline -Aliases: DestinationBlob - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestCloudBlob -Destination CloudBlob object - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudPageBlob -Parameter Sets: BlobInstanceToBlobInstance -Aliases: DestICloudBlob, DestinationCloudBlob, DestinationICloudBlob - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestContainer -Destination container name - -```yaml -Type: System.String -Parameter Sets: ContainerInstance, BlobInstance, ContainerName, UriPipeline -Aliases: DestinationContainer - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestContext -Destination Azure Storage Context. You can create it by New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: DestinationContext - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -The server time out for each request in seconds. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SrcBlob -Source page blob name. - -```yaml -Type: System.String -Parameter Sets: ContainerInstance, ContainerName -Aliases: SourceBlob - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SrcBlobSnapshotTime -Source page blob snapshot time. - -```yaml -Type: System.Nullable`1[System.DateTimeOffset] -Parameter Sets: ContainerInstance, ContainerName -Aliases: SourceBlobSnapshotTime - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SrcContainer -Source Container name - -```yaml -Type: System.String -Parameter Sets: ContainerName -Aliases: SourceContainer - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.WindowsAzure.Storage.Blob.CloudPageBlob - -### Microsoft.WindowsAzure.Storage.Blob.CloudBlobContainer - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageBlob - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/Azure.Storage/Start-AzureStorageFileCopy.md b/azurermps-6.13.0/Azure.Storage/Start-AzureStorageFileCopy.md deleted file mode 100644 index 2a1b620f96..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Start-AzureStorageFileCopy.md +++ /dev/null @@ -1,485 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: A96A1A67-6C9C-499F-9935-B90F7ACEB50E -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/start-azurestoragefilecopy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Start-AzureStorageFileCopy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Start-AzureStorageFileCopy.md ---- - -# Start-AzureStorageFileCopy - -## SYNOPSIS -Starts to copy a source file. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ContainerName -``` -Start-AzureStorageFileCopy -SrcBlobName -SrcContainerName -DestShareName - -DestFilePath [-Context ] [-DestContext ] [-Force] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### ContainerInstance -``` -Start-AzureStorageFileCopy -SrcBlobName -SrcContainer -DestShareName - -DestFilePath [-DestContext ] [-Force] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -### BlobInstanceFilePath -``` -Start-AzureStorageFileCopy -SrcBlob -DestShareName -DestFilePath - [-DestContext ] [-Force] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -### BlobInstanceFileInstance -``` -Start-AzureStorageFileCopy -SrcBlob -DestFile [-Force] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### ShareName -``` -Start-AzureStorageFileCopy -SrcFilePath -SrcShareName -DestShareName - -DestFilePath [-Context ] [-DestContext ] [-Force] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### ShareInstance -``` -Start-AzureStorageFileCopy -SrcFilePath -SrcShare -DestShareName - -DestFilePath [-DestContext ] [-Force] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -### FileInstanceToFilePath -``` -Start-AzureStorageFileCopy -SrcFile -DestShareName -DestFilePath - [-DestContext ] [-Force] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -### FileInstanceToFileInstance -``` -Start-AzureStorageFileCopy -SrcFile -DestFile [-Force] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### UriToFilePath -``` -Start-AzureStorageFileCopy -AbsoluteUri -DestShareName -DestFilePath - [-DestContext ] [-Force] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -### UriToFileInstance -``` -Start-AzureStorageFileCopy -AbsoluteUri -DestFile [-Force] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Start-AzureStorageFileCopy** cmdlet starts to copy a source file to a destination file. - -## EXAMPLES - -### Example 1: Start copy operation from file to file by using share name and file name -``` -PS C:\>Start-AzureStorageFileCopy -SrcShareName "ContosoShare01" -SrcFilePath "FilePath01" -DestShareName "ContosoShare02" -DestFilePath "FilePath02" -``` - -This command starts a copy operation from file to file. -The command specifies share name and file name - -### Example 2: Start copy operation from blob to file by using container name and blob name -``` -PS C:\>Start-AzureStorageFileCopy -SrcContainerName "ContosoContainer01" -SrcBlobName "ContosoBlob01" -DestShareName "ContosoShare" -DestFilePath "FilePath02" -``` - -This command starts a copy operation from blob to file. -The command specifies container name and blob name - -## PARAMETERS - -### -AbsoluteUri -Specifies the URI of the source file. -If the source location requires a credential, you must provide one. - -```yaml -Type: System.String -Parameter Sets: UriToFilePath, UriToFileInstance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure Storage context. -To obtain a context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: ContainerName, ShareName -Aliases: SrcContext - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestContext -Specifies the Azure Storage context of the destination. -To obtain a context, use **New-AzureStorageContext**. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: ContainerName, ContainerInstance, BlobInstanceFilePath, ShareName, ShareInstance, FileInstanceToFilePath, UriToFilePath -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestFile -Specifies a **CloudFile** object. -You can create a cloud file or obtain one by using the Get-AzureStorageFile cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFile -Parameter Sets: BlobInstanceFileInstance, FileInstanceToFileInstance, UriToFileInstance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestFilePath -Specifies the path of the destination file relative to the destination share. - -```yaml -Type: System.String -Parameter Sets: ContainerName, ContainerInstance, BlobInstanceFilePath, ShareName, ShareInstance, FileInstanceToFilePath, UriToFilePath -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestShareName -Specifies the name of the destination share. - -```yaml -Type: System.String -Parameter Sets: ContainerName, ContainerInstance, BlobInstanceFilePath, ShareName, ShareInstance, FileInstanceToFilePath, UriToFilePath -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SrcBlob -Specifies a **CloudBlob** object. -You can create a cloud blob or obtain one by using the Get-AzureStorageBlob cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudBlob -Parameter Sets: BlobInstanceFilePath, BlobInstanceFileInstance -Aliases: ICloudBlob - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -SrcBlobName -Specifies the name of the source blob. - -```yaml -Type: System.String -Parameter Sets: ContainerName, ContainerInstance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SrcContainer -Specifies a cloud blob container object. -You can create cloud blob container object or use the Get-AzureStorageContainer cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudBlobContainer -Parameter Sets: ContainerInstance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SrcContainerName -Specifies the name of the source container. - -```yaml -Type: System.String -Parameter Sets: ContainerName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SrcFile -Specifies a **CloudFile** object. -You can create a cloud file or obtain one by using **Get-AzureStorageFile**. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFile -Parameter Sets: FileInstanceToFilePath, FileInstanceToFileInstance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SrcFilePath -Specifies the path of the source file relative to the source directory or source share. - -```yaml -Type: System.String -Parameter Sets: ShareName, ShareInstance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SrcShare -Specifies a cloud file share object. -You can create a cloud file share or obtain one by using the Get-AzureStorageShare cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameter Sets: ShareInstance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SrcShareName -Specifies the name of the source share. - -```yaml -Type: System.String -Parameter Sets: ShareName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.WindowsAzure.Storage.Blob.CloudBlob - -### Microsoft.WindowsAzure.Storage.File.CloudFile -Parameters: SrcFile (ByValue) - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageBlob](./Get-AzureStorageBlob.md) - -[Get-AzureStorageContainer](./Get-AzureStorageContainer.md) - -[Get-AzureStorageFile](./Get-AzureStorageFile.md) - -[Get-AzureStorageShare](./Get-AzureStorageShare.md) - -[Get-AzureStorageFileCopyState](./Get-AzureStorageFileCopyState.md) - -[Stop-AzureStorageFileCopy](./Stop-AzureStorageFileCopy.md) diff --git a/azurermps-6.13.0/Azure.Storage/Stop-AzureStorageBlobCopy.md b/azurermps-6.13.0/Azure.Storage/Stop-AzureStorageBlobCopy.md deleted file mode 100644 index b7563c31a4..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Stop-AzureStorageBlobCopy.md +++ /dev/null @@ -1,303 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: C274DFBD-6C93-4043-AF93-DAF7BEA1F11F -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/stop-azurestorageblobcopy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Stop-AzureStorageBlobCopy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Stop-AzureStorageBlobCopy.md ---- - -# Stop-AzureStorageBlobCopy - -## SYNOPSIS -Stops a copy operation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NamePipeline (Default) -``` -Stop-AzureStorageBlobCopy [-Blob] [-Container] [-Force] [-CopyId ] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### BlobPipeline -``` -Stop-AzureStorageBlobCopy -CloudBlob [-Force] [-CopyId ] [-Context ] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### ContainerPipeline -``` -Stop-AzureStorageBlobCopy -CloudBlobContainer [-Blob] [-Force] [-CopyId ] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Stop-AzureStorageBlobCopy** cmdlet stops a copy operation to the specified destination blob. - -## EXAMPLES - -### Example 1: Stop copy operation by name -``` -PS C:\>Stop-AzureStorageBlobCopy -Container "ContainerName" -Blob "BlobName" -CopyId "CopyID" -``` - -This command stops the copy operation by name. - -### Example 2: Stop copy operation by using the pipeline -``` -PS C:\>Get-AzureStorageContainer container* | Stop-AzureStorageBlobCopy -Blob "BlobName" -``` - -This command stops the copy operation by passing the container on the pipeline from **Get-AzureStorageContainer**. - -### Example 3: Stop copy operation by using the pipeline and Get-AzureStorageBlob -``` -PS C:\>Get-AzureStorageBlob -Container "ContainerName" | Stop-AzureStorageBlobCopy -Force -``` - -This example stops the copy operation by passing the container on the pipeline from the Get-AzureStorageBlob cmdlet. - -## PARAMETERS - -### -Blob -Specifies the name of the blob. - -```yaml -Type: System.String -Parameter Sets: NamePipeline, ContainerPipeline -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CloudBlob -Specifies a **CloudBlob** object from Azure Storage Client library. -To obtain a **CloudBlob** object, use the Get-AzureStorageBlob cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudBlob -Parameter Sets: BlobPipeline -Aliases: ICloudBlob - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CloudBlobContainer -Specifies a **CloudBlobContainer** object from the Azure Storage Client library. -You can create the object or use the Get-AzureStorageContainer cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudBlobContainer -Parameter Sets: ContainerPipeline -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Container -Specifies the name of the container. - -```yaml -Type: System.String -Parameter Sets: NamePipeline -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies the Azure storage context. -You can create the context by using the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -CopyId -Specifies the copy ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Stops the current copy task on the specified blob without prompting for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the service side time-out interval, in seconds, for a request. -If the specified interval elapses before the service processes the request, the storage service returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.WindowsAzure.Storage.Blob.CloudBlob - -### Microsoft.WindowsAzure.Storage.Blob.CloudBlobContainer - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageBlob - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageBlob](./Get-AzureStorageBlob.md) - -[Get-AzureStorageContainer](./Get-AzureStorageContainer.md) - -[Start-AzureStorageBlobCopy](./Start-AzureStorageBlobCopy.md) - -[Get-AzureStorageBlobCopyState](./Get-AzureStorageBlobCopyState.md) diff --git a/azurermps-6.13.0/Azure.Storage/Stop-AzureStorageFileCopy.md b/azurermps-6.13.0/Azure.Storage/Stop-AzureStorageFileCopy.md deleted file mode 100644 index 9d220ac4be..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Stop-AzureStorageFileCopy.md +++ /dev/null @@ -1,262 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 3AC3F8DE-E25D-41AE-9083-5C459A4C8CD0 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/stop-azurestoragefilecopy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Stop-AzureStorageFileCopy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Stop-AzureStorageFileCopy.md ---- - -# Stop-AzureStorageFileCopy - -## SYNOPSIS -Stops a copy operation to the specified destination file. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ShareName -``` -Stop-AzureStorageFileCopy [-ShareName] [-FilePath] [-CopyId ] [-Force] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### File -``` -Stop-AzureStorageFileCopy [-File] [-CopyId ] [-Force] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Stop-AzureStorageFileCopy** cmdlet stops copying a file to a destination file. - -## EXAMPLES - -### Example 1: Stop a copy operation -``` -PS C:\>Stop-AzureStorageFileCopy -ShareName "ContosoShare" -FilePath "FilePath" -CopyId "CopyId" -``` - -This command stops copying a file that has the specified name. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the [New-AzureStorageContext](./New-AzureStorageContext.md) cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: ShareName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -CopyId -Specifies the ID of the copy operation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -File -Specifies a **CloudFile** object. -You can create a cloud file or obtain one by using the Get-AzureStorageFile cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFile -Parameter Sets: File -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -FilePath -Specifies the path of a file. - -```yaml -Type: System.String -Parameter Sets: ShareName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShareName -Specifies the name of a share. - -```yaml -Type: System.String -Parameter Sets: ShareName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFile -Parameters: File (ByValue) - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageFile](./Get-AzureStorageFile.md) - -[Get-AzureStorageFileCopyState](./Get-AzureStorageFileCopyState.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[Start-AzureStorageFileCopy](./Start-AzureStorageFileCopy.md) diff --git a/azurermps-6.13.0/Azure.Storage/Update-AzureStorageServiceProperty.md b/azurermps-6.13.0/Azure.Storage/Update-AzureStorageServiceProperty.md deleted file mode 100644 index 975c3c2af9..0000000000 --- a/azurermps-6.13.0/Azure.Storage/Update-AzureStorageServiceProperty.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/update-azurestorageserviceproperty -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Update-AzureStorageServiceProperty.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/Storage/Commands.Storage/help/Update-AzureStorageServiceProperty.md ---- - -# Update-AzureStorageServiceProperty - -## SYNOPSIS -Modifies the properties for the Azure Storage service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Update-AzureStorageServiceProperty [-ServiceType] [-DefaultServiceVersion ] - [-PassThru] [-Context ] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Update-AzureStorageServiceProperty** cmdlet modifies the properties for the Azure Storage service. - -## EXAMPLES - -### Example 1: Set Blob Service DefaultServiceVersion to 2017-04-17 -``` -C:\PS>Update-AzureStorageServiceProperty -ServiceType Blob -DefaultServiceVersion 2017-04-17 -``` - -This command Set the DefaultServiceVersion of Blob Service to 2017-04-17 - -## PARAMETERS - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultServiceVersion -DefaultServiceVersion indicates the default version to use for requests to the Blob service if an incoming request's version is not specified. Possible values include version 2008-10-27 and all more recent versions. -See more details in https://docs.microsoft.com/en-us/rest/api/storageservices/versioning-for-the-azure-storage-services - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Display ServiceProperties - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceType -Specifies the storage service type. -This cmdlet gets the logging properties for the service type that this parameter specifies. -The acceptable values for this parameter are: -- Blob -- Table -- Queue -- File - -```yaml -Type: Microsoft.WindowsAzure.Commands.Storage.Common.StorageServiceType -Parameter Sets: (All) -Aliases: -Accepted values: Blob, Table, Queue, File - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Storage.Model.ResourceModel.PSSeriviceProperties - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Aks/AzureRM.Aks.md b/azurermps-6.13.0/AzureRM.Aks/AzureRM.Aks.md deleted file mode 100644 index 369a8a1ad2..0000000000 --- a/azurermps-6.13.0/AzureRM.Aks/AzureRM.Aks.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -Module Name: AzureRM.Aks -Module Guid: a97e0c3e-e389-46a6-b73d-2b9bd6909bdb -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.aks -Help Version: 0.0.1.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Aks/Commands.Aks/help/AzureRM.Aks.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Aks/Commands.Aks/help/AzureRM.Aks.md ---- - -# AzureRM.Aks Module -## Description -Commands to interact with Azure managed Kubernetes clusters. - -## AzureRM.Aks Cmdlets -### [Get-AzureRmAks](Get-AzureRmAks.md) -List Kubernetes managed clusters. - -### [Import-AzureRmAksCredential](Import-AzureRmAksCredential.md) -Import and merge Kubectl config for a managed Kubernetes Cluster. - -### [New-AzureRmAks](New-AzureRmAks.md) -Create a new managed Kubernetes cluster. - -### [Remove-AzureRmAks](Remove-AzureRmAks.md) -Delete a managed Kubernetes cluster. - -### [Set-AzureRmAks](Set-AzureRmAks.md) -Update or create a managed Kubernetes cluster. - -### [Start-AzureRmAksDashboard](Start-AzureRmAksDashboard.md) -Create a Kubectl SSH tunnel to the managed cluster's dashboard. - -### [Stop-AzureRmAksDashboard](Stop-AzureRmAksDashboard.md) -Stop the Kubectl SSH tunnel created in Start-AzureRmKubernetesDashboard. - diff --git a/azurermps-6.13.0/AzureRM.Aks/Get-AzureRmAks.md b/azurermps-6.13.0/AzureRM.Aks/Get-AzureRmAks.md deleted file mode 100644 index 2804b8d107..0000000000 --- a/azurermps-6.13.0/AzureRM.Aks/Get-AzureRmAks.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Aks.dll-Help.xml -Module Name: AzureRM.Aks -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.aks/get-azurermaks -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Aks/Commands.Aks/help/Get-AzureRmAks.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Aks/Commands.Aks/help/Get-AzureRmAks.md ---- - -# Get-AzureRmAks - -## SYNOPSIS -List Kubernetes managed clusters. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceGroupParameterSet (Default) -``` -Get-AzureRmAks [[-ResourceGroupName] ] [-DefaultProfile ] [] -``` - -### IdParameterSet -``` -Get-AzureRmAks [-Id] [-DefaultProfile ] [] -``` - -### NameParameterSet -``` -Get-AzureRmAks [-ResourceGroupName] [-Name] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -List Kubernetes managed clusters. - -## EXAMPLES - -### List all Kubernetes clusters -``` -PS C:\> Get-AzureRmAks -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Id of a managed Kubernetes cluster - -```yaml -Type: System.String -Parameter Sets: IdParameterSet -Aliases: ResourceId - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Name of your managed Kubernetes cluster - -```yaml -Type: System.String -Parameter Sets: NameParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource group name - -```yaml -Type: System.String -Parameter Sets: ResourceGroupParameterSet -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: NameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Aks/Import-AzureRmAksCredential.md b/azurermps-6.13.0/AzureRM.Aks/Import-AzureRmAksCredential.md deleted file mode 100644 index a8135bd640..0000000000 --- a/azurermps-6.13.0/AzureRM.Aks/Import-AzureRmAksCredential.md +++ /dev/null @@ -1,233 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Aks.dll-Help.xml -Module Name: AzureRM.Aks -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.aks/import-azurermaks -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Aks/Commands.Aks/help/Import-AzureRmAksCredential.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Aks/Commands.Aks/help/Import-AzureRmAksCredential.md ---- - -# Import-AzureRmAksCredential - -## SYNOPSIS -Import and merge Kubectl config for a managed Kubernetes Cluster. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GroupNameParameterSet (Default) -``` -Import-AzureRmAksCredential [-ResourceGroupName] [-Name] [-Admin] [-ConfigPath ] - [-Force] [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### InputObjectParameterSet -``` -Import-AzureRmAksCredential -InputObject [-Admin] [-ConfigPath ] [-Force] - [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### IdParameterSet -``` -Import-AzureRmAksCredential [-Id] [-Admin] [-ConfigPath ] [-Force] [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Import and merge Kubectl config for a managed Kubernetes Cluster. - -## EXAMPLES - -### Import and merge Kubectl config -``` -PS C:\> Import-AzureRmAksCredential -ResourceGroupName group -Name myCluster -``` - -## PARAMETERS - -### -Admin -Get the 'clusterAdmin' kubectl config instead of the default 'clusterUser'. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConfigPath -A kubectl config file to create or update. -Use '-' to print YAML to stdout instead. -Default: %Home%/.kube/config. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Import Kubernetes config even if it is the default - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Id of a managed Kubernetes cluster - -```yaml -Type: System.String -Parameter Sets: IdParameterSet -Aliases: ResourceId - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -A PSKubernetesCluster object, normally passed through the pipeline. - -```yaml -Type: Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of your managed Kubernetes cluster - -```yaml -Type: System.String -Parameter Sets: GroupNameParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true if import is successful - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource group name - -```yaml -Type: System.String -Parameter Sets: GroupNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Aks/New-AzureRmAks.md b/azurermps-6.13.0/AzureRM.Aks/New-AzureRmAks.md deleted file mode 100644 index 99446c4a2d..0000000000 --- a/azurermps-6.13.0/AzureRM.Aks/New-AzureRmAks.md +++ /dev/null @@ -1,313 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Aks.dll-Help.xml -Module Name: AzureRM.Aks -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.aks/new-azurermaks -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Aks/Commands.Aks/help/New-AzureRmAks.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Aks/Commands.Aks/help/New-AzureRmAks.md ---- - -# New-AzureRmAks - -## SYNOPSIS -Create a new managed Kubernetes cluster. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmAks [-Force] [-ResourceGroupName] [-Name] [[-ClientIdAndSecret] ] - [-Location ] [-AdminUserName ] [-DnsNamePrefix ] [-KubernetesVersion ] - [-NodeCount ] [-NodeOsDiskSize ] [-NodeVmSize ] [-SshKeyValue ] [-AsJob] - [-Tag ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -Create a new managed Kubernetes cluster. - -## EXAMPLES - -### Example 1 - -Create a new managed Kubernetes cluster with default params. - -``` -PS C:\> New-AzureRmAks -ResourceGroupName group -Name myCluster -``` - -## PARAMETERS - -### -AdminUserName -User name for the Linux Virtual Machines. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientIdAndSecret -The client id and client secret associated with the AAD application / service principal. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DnsNamePrefix -The DNS name prefix for the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Create cluster even if it already exists - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KubernetesVersion -The version of Kubernetes to use for creating the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Azure location for the cluster. -Defaults to the location of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Kubernetes managed cluster Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NodeCount -The default number of nodes for the node pools. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NodeOsDiskSize -Size in GB of the OS disk for each node in the node pool. Minimum 30 GB. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NodeVmSize -The size of the Virtual Machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SshKeyValue -SSH key file value or key file path. -Defaults to {HOME}/.ssh/id_rsa.pub. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: SshKeyPath - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Tags to be applied to the resource - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Aks/Remove-AzureRmAks.md b/azurermps-6.13.0/AzureRM.Aks/Remove-AzureRmAks.md deleted file mode 100644 index 685ebbd88c..0000000000 --- a/azurermps-6.13.0/AzureRM.Aks/Remove-AzureRmAks.md +++ /dev/null @@ -1,216 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Aks.dll-Help.xml -Module Name: AzureRM.Aks -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.aks/remove-azurermaks -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Aks/Commands.Aks/help/Remove-AzureRmAks.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Aks/Commands.Aks/help/Remove-AzureRmAks.md ---- - -# Remove-AzureRmAks - -## SYNOPSIS -Delete a managed Kubernetes cluster. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GroupNameParameterSet (Default) -``` -Remove-AzureRmAks [-ResourceGroupName] [-Name] [-PassThru] [-AsJob] [-Force] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### InputObjectParameterSet -``` -Remove-AzureRmAks -InputObject [-PassThru] [-AsJob] [-Force] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### IdParameterSet -``` -Remove-AzureRmAks [-Id] [-PassThru] [-AsJob] [-Force] [-DefaultProfile ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Delete a managed Kubernetes cluster. - -## EXAMPLES - -### Delete an existing managed Kubernetes cluster -``` -PS C:\> Remove-AzureRmAks -ResourceGroupName group -Name myCluster -``` - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Remove managed Kubernetes cluster without prompt - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Id of a managed Kubernetes cluster - -```yaml -Type: System.String -Parameter Sets: IdParameterSet -Aliases: ResourceId - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -A PSKubernetesCluster object, normally passed through the pipeline. - -```yaml -Type: Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of your managed Kubernetes cluster - -```yaml -Type: System.String -Parameter Sets: GroupNameParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true if deletion is successful - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource group name - -```yaml -Type: System.String -Parameter Sets: GroupNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Aks/Set-AzureRmAks.md b/azurermps-6.13.0/AzureRM.Aks/Set-AzureRmAks.md deleted file mode 100644 index 9cbbe9e863..0000000000 --- a/azurermps-6.13.0/AzureRM.Aks/Set-AzureRmAks.md +++ /dev/null @@ -1,346 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Aks.dll-Help.xml -Module Name: AzureRM.Aks -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.aks/set-azurermaks -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Aks/Commands.Aks/help/Set-AzureRmAks.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Aks/Commands.Aks/help/Set-AzureRmAks.md ---- - -# Set-AzureRmAks - -## SYNOPSIS -Update or create a managed Kubernetes cluster. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### defaultParameterSet (Default) -``` -Set-AzureRmAks [-ResourceGroupName] [-Name] [[-ClientIdAndSecret] ] - [-Location ] [-AdminUserName ] [-DnsNamePrefix ] [-KubernetesVersion ] - [-NodeCount ] [-NodeOsDiskSize ] [-NodeVmSize ] [-SshKeyValue ] [-AsJob] - [-Tag ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### InputObjectParameterSet -``` -Set-AzureRmAks -InputObject [-Location ] [-AdminUserName ] - [-DnsNamePrefix ] [-KubernetesVersion ] [-NodeCount ] [-NodeOsDiskSize ] - [-NodeVmSize ] [-SshKeyValue ] [-AsJob] [-Tag ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### IdParameterSet -``` -Set-AzureRmAks [-Id] [-Location ] [-AdminUserName ] [-DnsNamePrefix ] - [-KubernetesVersion ] [-NodeCount ] [-NodeOsDiskSize ] [-NodeVmSize ] - [-SshKeyValue ] [-AsJob] [-Tag ] [-DefaultProfile ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -Update or create a managed Kubernetes cluster. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmAks -ResourceGroupName group -Name myCluster | Set-AzureRmAks -NodeCount 5 -``` - -Set the number of nodes in the Kubernetes cluster to 5. - -## PARAMETERS - -### -AdminUserName -User name for the Linux Virtual Machines. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientIdAndSecret -The client id and client secret associated with the AAD application / service principal. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: defaultParameterSet -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DnsNamePrefix -The DNS name prefix for the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Id of a managed Kubernetes cluster - -```yaml -Type: System.String -Parameter Sets: IdParameterSet -Aliases: ResourceId - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -A PSKubernetesCluster object, normally passed through the pipeline. - -```yaml -Type: Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -KubernetesVersion -The version of Kubernetes to use for creating the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Azure location for the cluster. -Defaults to the location of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Kubernetes managed cluster Name. - -```yaml -Type: System.String -Parameter Sets: defaultParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NodeCount -The default number of nodes for the node pools. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NodeOsDiskSize -The default number of nodes for the node pools. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NodeVmSize -The size of the Virtual Machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: defaultParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SshKeyValue -SSH key file value or key file path. -Defaults to {HOME}/.ssh/id_rsa.pub. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: SshKeyPath - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Tags to be applied to the resource - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Aks/Start-AzureRmAksDashboard.md b/azurermps-6.13.0/AzureRM.Aks/Start-AzureRmAksDashboard.md deleted file mode 100644 index 0787b343cf..0000000000 --- a/azurermps-6.13.0/AzureRM.Aks/Start-AzureRmAksDashboard.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Aks.dll-Help.xml -Module Name: AzureRM.Aks -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.aks/start-azurermaksdashboard -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Aks/Commands.Aks/help/Start-AzureRmAksDashboard.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Aks/Commands.Aks/help/Start-AzureRmAksDashboard.md ---- - -# Start-AzureRmAksDashboard - -## SYNOPSIS -Create a Kubectl SSH tunnel to the managed cluster's dashboard. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GroupNameParameterSet (Default) -``` -Start-AzureRmAksDashboard [-ResourceGroupName] [-Name] [-DisableBrowser] [-PassThru] - [-DefaultProfile ] [] -``` - -### InputObjectParameterSet -``` -Start-AzureRmAksDashboard [-InputObject] [-DisableBrowser] [-PassThru] - [-DefaultProfile ] [] -``` - -### IdParameterSet -``` -Start-AzureRmAksDashboard [-Id] [-DisableBrowser] [-PassThru] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -Create a Kubectl SSH tunnel to the managed cluster's dashboard. The SSH tunnel is setup in a PowerShell job called Kubectl-Tunnel and can be found by running `Get-Job`. The tunnel should be accessable via [http://127.0.0.1:8001](http://127.0.0.1:8001). - -## EXAMPLES - -### Start an SSH tunnel and open a browser to the Kubernetes dashboard -``` -PS C:\> Start-AzureRmAksDashboard -ResourceGroupName group -Name myCluster -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableBrowser -Do not pop open a browser after establising the kubectl port-forward. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Id of a managed Kubernetes cluster - -```yaml -Type: System.String -Parameter Sets: IdParameterSet -Aliases: ResourceId - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -A PSKubernetesCluster object, normally passed through the pipeline. - -```yaml -Type: Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of your managed Kubernetes cluster - -```yaml -Type: System.String -Parameter Sets: GroupNameParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Cmdlet returns the KubeTunnelJob if passed. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource group name - -```yaml -Type: System.String -Parameter Sets: GroupNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Aks.KubeTunnelJob - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Aks/Stop-AzureRmAksDashboard.md b/azurermps-6.13.0/AzureRM.Aks/Stop-AzureRmAksDashboard.md deleted file mode 100644 index 648f510659..0000000000 --- a/azurermps-6.13.0/AzureRM.Aks/Stop-AzureRmAksDashboard.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Aks.dll-Help.xml -Module Name: AzureRM.Aks -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.aks/stop-azurermaksdashboard -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Aks/Commands.Aks/help/Stop-AzureRmAksDashboard.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Aks/Commands.Aks/help/Stop-AzureRmAksDashboard.md ---- - -# Stop-AzureRmAksDashboard - -## SYNOPSIS -Stop the Kubectl SSH tunnel created in Start-AzureRmKubernetesDashboard. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Stop-AzureRmAksDashboard [-PassThru] [-DefaultProfile ] [] -``` - -## DESCRIPTION -Stop the Kubectl SSH tunnel created in Start-AzureRmKubernetesDashboard. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Stop-AzureRmKubernetesDashboard -``` - -Stops the existing SSH tunnel setup by executing Start-AzureRmKubernetesDashboard. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true if SSH tunnel is closed. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.AnalysisServices/AzureRM.AnalysisServices.md b/azurermps-6.13.0/AzureRM.AnalysisServices/AzureRM.AnalysisServices.md deleted file mode 100644 index b0df4c7752..0000000000 --- a/azurermps-6.13.0/AzureRM.AnalysisServices/AzureRM.AnalysisServices.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -Module Name: AzureRM.AnalysisServices -Module Guid: acace26c-1775-4100-85c0-20c4d71eaa21 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.analysisservices -Help Version: 0.0.1.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AnalysisServices/Commands.AnalysisServices/help/AzureRM.AnalysisServices.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AnalysisServices/Commands.AnalysisServices/help/AzureRM.AnalysisServices.md ---- - -# AzureRM.AnalysisServices Module -## Description -This topic displays help topics for the Azure AnalysisServices cmdlets. - -## AzureRM.AnalysisServices Cmdlets -### [Get-AzureRmAnalysisServicesServer](Get-AzureRmAnalysisServicesServer.md) -Gets the details of an Analysis Services server. - -### [New-AzureRmAnalysisServicesFirewallConfig](New-AzureRmAnalysisServicesFirewallConfig.md) -Creates a new Analysis Services firewall config - -### [New-AzureRmAnalysisServicesFirewallRule](New-AzureRmAnalysisServicesFirewallRule.md) -Creates a new Analysis Services firewall rule - -### [New-AzureRmAnalysisServicesServer](New-AzureRmAnalysisServicesServer.md) -Creates a new Analysis Services server - -### [Remove-AzureRmAnalysisServicesServer](Remove-AzureRmAnalysisServicesServer.md) -Deletes an instance of Analysis Services server - -### [Resume-AzureRmAnalysisServicesServer](Resume-AzureRmAnalysisServicesServer.md) -Resumes an instance of Analysis Services server - -### [Set-AzureRmAnalysisServicesServer](Set-AzureRmAnalysisServicesServer.md) -Modifies an instance of Analysis Services server - -### [Suspend-AzureRmAnalysisServicesServer](Suspend-AzureRmAnalysisServicesServer.md) -Suspends an instance of Analysis Services server - -### [Test-AzureRmAnalysisServicesServer](Test-AzureRmAnalysisServicesServer.md) -Tests the existence of an instance of Analysis Services server - diff --git a/azurermps-6.13.0/AzureRM.AnalysisServices/Get-AzureRmAnalysisServicesServer.md b/azurermps-6.13.0/AzureRM.AnalysisServices/Get-AzureRmAnalysisServicesServer.md deleted file mode 100644 index 6f2bc41d72..0000000000 --- a/azurermps-6.13.0/AzureRM.AnalysisServices/Get-AzureRmAnalysisServicesServer.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AnalysisServices.dll-Help.xml -Module Name: AzureRM.AnalysisServices -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.analysisservices/get-azurermanalysisservicesserver -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AnalysisServices/Commands.AnalysisServices/help/Get-AzureRmAnalysisServicesServer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AnalysisServices/Commands.AnalysisServices/help/Get-AzureRmAnalysisServicesServer.md ---- - -# Get-AzureRmAnalysisServicesServer - -## SYNOPSIS -Gets the details of an Analysis Services server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmAnalysisServicesServer [[-ResourceGroupName] ] [[-Name] ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The Get-AzureRmAnalysisServicesServer cmdlet gets the details of an Analysis Services server. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-AzureRmAnalysisServicesServer -ResourceGroupName "ResourceGroup03" -``` - -This command gets all Azure Analysis Services servers in the resource group named ResourceGroup03. - -### Example 2: Get a server -``` -PS C:\>Get-AzureRmAnalysisServicesServer -ResourceGroupName "ResourceGroup03" -Name "testserver" -``` - -This command gets the Azure Analysis Services server named testserver in the resource group named ResourceGroup03. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the Analysis Services server - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Azure resource group to which the server belongs - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.AnalysisServices.Models.AzureAnalysisServicesServer - -## NOTES -Alias: Get-AzureAs - -## RELATED LINKS - -[New-AzureRmAnalysisServicesServer ](./New-AzureRmAnalysisServicesServer .md) - -[Remove-AzureRmAnalysisServicesServer ](./Remove-AzureRmAnalysisServicesServer .md) diff --git a/azurermps-6.13.0/AzureRM.AnalysisServices/New-AzureRmAnalysisServicesFirewallConfig.md b/azurermps-6.13.0/AzureRM.AnalysisServices/New-AzureRmAnalysisServicesFirewallConfig.md deleted file mode 100644 index 158e76366a..0000000000 --- a/azurermps-6.13.0/AzureRM.AnalysisServices/New-AzureRmAnalysisServicesFirewallConfig.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AnalysisServices.dll-Help.xml -Module Name: AzureRM.AnalysisServices -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.analysisservices/new-azurermanalysisservicesfirewallconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AnalysisServices/Commands.AnalysisServices/help/New-AzureRmAnalysisServicesFirewallConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AnalysisServices/Commands.AnalysisServices/help/New-AzureRmAnalysisServicesFirewallConfig.md ---- - -# New-AzureRmAnalysisServicesFirewallConfig - -## SYNOPSIS -Creates a new Analysis Services firewall config - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmAnalysisServicesFirewallConfig [-EnablePowerBIService] - [-FirewallRule ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The New-AzureRmAnalysisServicesFirewallConfig creates a new firewall config object - -## EXAMPLES - -### Example 1 -``` -PS C:\> $rule1 = New-AzureRmAnalysisServicesFirewallRule -FirewallRuleName rule1 -RangeStart 0.0.0.0 -RangeEnd 255.255.255.255 -PS C:\> $rule2 = New-AzureRmAnalysisServicesFirewallRule -FirewallRuleName rule2 -RangeStart 6.6.6.6 -RangeEnd 7.7.7.7 -PS C:\> $config = New-AzureRmAnalysisServicesFirewallConfig -EnablePowerBIService -FirewallRule $rule1,$rule2 -``` - -Creates a firewall config object with two rules while also enabling access from Power BI service. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnablePowerBIService -A flag to indicate if the firewall is allowing access from Power BI - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FirewallRule -A list of firewall rules - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.AnalysisServices.Models.PsAzureAnalysisServicesFirewallRule] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.AnalysisServices.Models.PsAzureAnalysisServicesFirewallRule, Microsoft.Azure.Commands.AnalysisServices, Version=0.6.11.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### Microsoft.Azure.Commands.AnalysisServices.Models.PsAzureAnalysisServicesFirewallConfig - -## NOTES - -## RELATED LINKS - -[New-AzureRmAnalysisServicesFirewallRule](./New-AzureRmAnalysisServicesFirewallRule.md) diff --git a/azurermps-6.13.0/AzureRM.AnalysisServices/New-AzureRmAnalysisServicesFirewallRule.md b/azurermps-6.13.0/AzureRM.AnalysisServices/New-AzureRmAnalysisServicesFirewallRule.md deleted file mode 100644 index ad45ffb4b9..0000000000 --- a/azurermps-6.13.0/AzureRM.AnalysisServices/New-AzureRmAnalysisServicesFirewallRule.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AnalysisServices.dll-Help.xml -Module Name: AzureRM.AnalysisServices -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.analysisservices/new-azurermanalysisservicesfirewallrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AnalysisServices/Commands.AnalysisServices/help/New-AzureRmAnalysisServicesFirewallRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AnalysisServices/Commands.AnalysisServices/help/New-AzureRmAnalysisServicesFirewallRule.md ---- - -# New-AzureRmAnalysisServicesFirewallRule - -## SYNOPSIS -Creates a new Analysis Services firewall rule - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmAnalysisServicesFirewallRule [-FirewallRuleName] [-RangeStart] - [-RangeEnd] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The New-AzureRmAnalysisServicesFirewallRule creates a new firewall rule object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmAnalysisServicesFirewallRule -FirewallRuleName rule1 -RangeStart 0.0.0.0 -RangeEnd 255.255.255.255 -``` - -Creates a firewall rule named rule1 with start range 0.0.0.0 and end range 255.255.255.255 - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FirewallRuleName -Name of firewall rule - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RangeEnd -The range end of a firewall rule - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RangeStart -The range start of a firewall rule - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.AnalysisServices.Models.PsAzureAnalysisServicesFirewallRule - -## NOTES - -## RELATED LINKS - -[New-AzureRmAnalysisServicesFirewallConfig](./New-AzureRmAnalysisServicesFirewallConfig.md) diff --git a/azurermps-6.13.0/AzureRM.AnalysisServices/New-AzureRmAnalysisServicesServer.md b/azurermps-6.13.0/AzureRM.AnalysisServices/New-AzureRmAnalysisServicesServer.md deleted file mode 100644 index c37e56d652..0000000000 --- a/azurermps-6.13.0/AzureRM.AnalysisServices/New-AzureRmAnalysisServicesServer.md +++ /dev/null @@ -1,277 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AnalysisServices.dll-Help.xml -Module Name: AzureRM.AnalysisServices -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.analysisservices/new-azurermanalysisservicesserver -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AnalysisServices/Commands.AnalysisServices/help/New-AzureRmAnalysisServicesServer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AnalysisServices/Commands.AnalysisServices/help/New-AzureRmAnalysisServicesServer.md ---- - -# New-AzureRmAnalysisServicesServer - -## SYNOPSIS -Creates a new Analysis Services server - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmAnalysisServicesServer [-ResourceGroupName] [-Name] [-Location] - [-Sku] [[-Tag] ] [[-Administrator] ] [[-BackupBlobContainerUri] ] - [-ReadonlyReplicaCount ] [-DefaultConnectionMode ] - [-FirewallConfig ] [-GatewayResourceId ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The New-AzureRmAnalysisServicesServer cmdlet creates a new Analysis Services server - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmAnalysisServicesServer -ResourceGroupName "testresourcegroup" -Name "testserver" -Location "West-US" -Sku "S1" -``` - -Creates a server named testserver in the Azure region West-US and in resource group testresrourcegroup. The sku level for the server will be S1. - -## PARAMETERS - -### -Administrator -A string representing a comma separated list of users or groups to be set as administrators on the server. The users or groups need to be specified UPN format e.g. user@contoso.com or groups@contoso.com - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BackupBlobContainerUri -The blob container Uri for backup the Analysis Services server - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultConnectionMode -Default connection mode of an Analysis service server - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: All, Readonly - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FirewallConfig -Firewall config of an Analysis server - -```yaml -Type: Microsoft.Azure.Commands.AnalysisServices.Models.PsAzureAnalysisServicesFirewallConfig -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GatewayResourceId -Gateway resource Id for assocaite to an Analysis server - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -The Azure region where the Analysis Services server is hosted - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Name of the Analysis Services server - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReadonlyReplicaCount -Read only replica count of an Analysis service server - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Azure resource group to which the server belongs - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -The name of the Sku for the server. -The supported values are 'S0', 'S1', 'S2', 'S4' for the Standard tier; 'B1', 'B2' for the Basic tier and 'D1' for Development tier. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table set as tags on the server. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts user to confirm whether to perform the operation - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Describes the actions the current operation will perform without actually performing them - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -### System.Int32 - -### Microsoft.Azure.Commands.AnalysisServices.Models.PsAzureAnalysisServicesFirewallConfig - -## OUTPUTS - -### Microsoft.Azure.Commands.AnalysisServices.Models.AzureAnalysisServicesServer - -## NOTES -Alias: New-AzureAs - -## RELATED LINKS - -[Get-AzureRmAnalysisServicesServer](./Get-AzureRmAnalysisServicesServer.md) - -[Remove-AzureRmAnalysisServicesServer](./Remove-AzureRmAnalysisServicesServer.md) diff --git a/azurermps-6.13.0/AzureRM.AnalysisServices/Remove-AzureRmAnalysisServicesServer.md b/azurermps-6.13.0/AzureRM.AnalysisServices/Remove-AzureRmAnalysisServicesServer.md deleted file mode 100644 index 10684c4d06..0000000000 --- a/azurermps-6.13.0/AzureRM.AnalysisServices/Remove-AzureRmAnalysisServicesServer.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AnalysisServices.dll-Help.xml -Module Name: AzureRM.AnalysisServices -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.analysisservices/remove-azurermanalysisservicesserver -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AnalysisServices/Commands.AnalysisServices/help/Remove-AzureRmAnalysisServicesServer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AnalysisServices/Commands.AnalysisServices/help/Remove-AzureRmAnalysisServicesServer.md ---- - -# Remove-AzureRmAnalysisServicesServer - -## SYNOPSIS -Deletes an instance of Analysis Services server - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmAnalysisServicesServer [-Name] [[-ResourceGroupName] ] [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Remove-AzureRmAnalysisServicesServer cmdlet deletes an instance of Analysis Services server - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmAnalysisServicesServer -Name "testserver" -ResourceGroupName "testgroup" -``` - -This command will remove the server named testserver in the resourcegroup testgroup - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the Analysis Services server - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Will return the deleted server details if the operation completes successfully - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Azure resource group to which the server belongs - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts user to confirm whether to perform the operation - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Describes the actions the current operation will perform without actually performing them - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.AnalysisServices.Models.AzureAnalysisServicesServer - -## NOTES -Alias: Remove-AzureAs - -## RELATED LINKS - -[Get-AzureRmAnalysisServicesServer](./Get-AzureRmAnalysisServicesServer.md) - -[New-AzureRmAnalysisServicesServer](./New-AzureRmAnalysisServicesServer.md) diff --git a/azurermps-6.13.0/AzureRM.AnalysisServices/Resume-AzureRmAnalysisServicesServer.md b/azurermps-6.13.0/AzureRM.AnalysisServices/Resume-AzureRmAnalysisServicesServer.md deleted file mode 100644 index 554b3a799e..0000000000 --- a/azurermps-6.13.0/AzureRM.AnalysisServices/Resume-AzureRmAnalysisServicesServer.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AnalysisServices.dll-Help.xml -Module Name: AzureRM.AnalysisServices -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.analysisservices/resume-azurermanalysisservicesserver -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AnalysisServices/Commands.AnalysisServices/help/Resume-AzureRmAnalysisServicesServer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AnalysisServices/Commands.AnalysisServices/help/Resume-AzureRmAnalysisServicesServer.md ---- - -# Resume-AzureRmAnalysisServicesServer - -## SYNOPSIS -Resumes an instance of Analysis Services server - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Resume-AzureRmAnalysisServicesServer [[-ResourceGroupName] ] [-Name] [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Resume-AzureRmAnalysisServicesServer cmdlet resumes an instance of Analysis Services server - -## EXAMPLES - -### Example 1 -``` -PS C:\> Resume-AzureRmAnalysisServicesServer -Name "testserver" -ResourceGroupName "testgroup" -``` - -This command will resume a paused server named testserver in the resourcegroup testgroup - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the Analysis Services server - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Will return the deleted server details if the operation completes successfully - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Azure resource group to which the server belongs - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts user to confirm whether to perform the operation - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Describes the actions the current operation will perform without actually performing them - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.AnalysisServices.Models.AzureAnalysisServicesServer - -## NOTES -Alias: Resume-AzureAs - -## RELATED LINKS - -[Get-AzureRmAnalysisServicesServer](./Get-AzureRmAnalysisServicesServer.md) - -[Suspend-AzureRmAnalysisServicesServer](./Suspend-AzureRmAnalysisServicesServer.md) diff --git a/azurermps-6.13.0/AzureRM.AnalysisServices/Set-AzureRmAnalysisServicesServer.md b/azurermps-6.13.0/AzureRM.AnalysisServices/Set-AzureRmAnalysisServicesServer.md deleted file mode 100644 index dcc2a39c2a..0000000000 --- a/azurermps-6.13.0/AzureRM.AnalysisServices/Set-AzureRmAnalysisServicesServer.md +++ /dev/null @@ -1,329 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AnalysisServices.dll-Help.xml -Module Name: AzureRM.AnalysisServices -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.analysisservices/set-azurermanalysisservicesserver -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AnalysisServices/Commands.AnalysisServices/help/Set-AzureRmAnalysisServicesServer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AnalysisServices/Commands.AnalysisServices/help/Set-AzureRmAnalysisServicesServer.md ---- - -# Set-AzureRmAnalysisServicesServer - -## SYNOPSIS -Modifies an instance of Analysis Services server - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Default (Default) -``` -Set-AzureRmAnalysisServicesServer [-Name] [[-ResourceGroupName] ] [[-Sku] ] - [[-Tag] ] [[-Administrator] ] [[-BackupBlobContainerUri] ] [-PassThru] - [-ReadonlyReplicaCount ] [-DefaultConnectionMode ] - [-FirewallConfig ] [-GatewayResourceId ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### DisableBackup -``` -Set-AzureRmAnalysisServicesServer [-Name] [[-ResourceGroupName] ] [[-Sku] ] - [[-Tag] ] [[-Administrator] ] [-PassThru] [-DisableBackup] [-ReadonlyReplicaCount ] - [-DefaultConnectionMode ] [-FirewallConfig ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### DisassociateGateway -``` -Set-AzureRmAnalysisServicesServer [-Name] [[-ResourceGroupName] ] [[-Sku] ] - [[-Tag] ] [[-Administrator] ] [-PassThru] [-ReadonlyReplicaCount ] - [-DefaultConnectionMode ] [-FirewallConfig ] - [-DisassociateGateway] [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Set-AzureRmAnalysisServicesServer cmdlet modifies an instance of Analysis Services server - -## EXAMPLES - -### Example 1 -``` -PS C:\> Set-AzureRmAnalysisServicesServer -Name "testserver" -ResourceGroupName "testgroup" -Tag "key1:value1,key2:value2" -Administrator "testuser1@contoso.com" -``` - -Modifies the server named testserver in resourcegroup testgroup to set the tags as key1:value1 and key2:value2 and administrator to testuser1@contoso.com - -## PARAMETERS - -### -Administrator -A string representing a comma separated list of users or groups to be set as administrators on the server. -The users or groups need to be specified UPN format e.g. -user@contoso.com or groups@contoso.com - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BackupBlobContainerUri -The blob container Uri for backup the Analysis Services server - -```yaml -Type: System.String -Parameter Sets: Default -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultConnectionMode -Default connection mode of an Analysis service server - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: All, Readonly - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableBackup -The switch to disable backup blob container. -To re-enable the backup blob container, please provide the backup blob container Uri as -BackupBlobContainerUri. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: DisableBackup -Aliases: - -Required: True -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisassociateGateway -Disassociate Gateway resource from an Analysis server - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: DisassociateGateway -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FirewallConfig -Firewall config of an Analysis server - -```yaml -Type: Microsoft.Azure.Commands.AnalysisServices.Models.PsAzureAnalysisServicesFirewallConfig -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GatewayResourceId -Gateway resource Id for assocaite to an Analysis server - -```yaml -Type: System.String -Parameter Sets: Default -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Name of the Analysis Services server - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Will return the deleted server details if the operation completes successfully - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadonlyReplicaCount -Read only replica count of an Analysis service server - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Azure resource group to which the server belongs - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -The name of the Sku for the server. -The supported values are 'S0', 'S1', 'S2', 'S4' for the Standard tier; 'B1', 'B2' for the Basic tier and 'D1' for Development tier. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table set as tags on the server. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts user to confirm whether to perform the operation - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Describes the actions the current operation will perform without actually performing them - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -### System.Management.Automation.SwitchParameter - -### System.Int32 - -### Microsoft.Azure.Commands.AnalysisServices.Models.PsAzureAnalysisServicesFirewallConfig - -## OUTPUTS - -### Microsoft.Azure.Commands.AnalysisServices.Models.AzureAnalysisServicesServer - -## NOTES -Alias: Set-AzureAs - -## RELATED LINKS - -[Get-AzureRmAnalysisServicesServer](./Get-AzureRmAnalysisServicesServer.md) - -[Remove-AzureRmAnalysisServicesServer](./Remove-AzureRmAnalysisServicesServer.md) diff --git a/azurermps-6.13.0/AzureRM.AnalysisServices/Suspend-AzureRmAnalysisServicesServer.md b/azurermps-6.13.0/AzureRM.AnalysisServices/Suspend-AzureRmAnalysisServicesServer.md deleted file mode 100644 index a808006e90..0000000000 --- a/azurermps-6.13.0/AzureRM.AnalysisServices/Suspend-AzureRmAnalysisServicesServer.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AnalysisServices.dll-Help.xml -Module Name: AzureRM.AnalysisServices -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.analysisservices/suspend-azurermanalysisservicesserver -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AnalysisServices/Commands.AnalysisServices/help/Suspend-AzureRmAnalysisServicesServer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AnalysisServices/Commands.AnalysisServices/help/Suspend-AzureRmAnalysisServicesServer.md ---- - -# Suspend-AzureRmAnalysisServicesServer - -## SYNOPSIS -Suspends an instance of Analysis Services server - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Suspend-AzureRmAnalysisServicesServer [[-ResourceGroupName] ] [-Name] [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Suspend-AzureRmAnalysisServicesServer cmdlet suspends an instance of Analysis Services server - -## EXAMPLES - -### Example 1 -``` -PS C:\> Suspend-AzureRmAnalysisServicesServer -Name "testserver" -ResourceGroupName "testgroup" -``` - -This command will suspend an active server named testserver in the resourcegroup testgroup - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the Analysis Services server - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Will return the deleted server details if the operation completes successfully - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Azure resource group to which the server belongs - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts user to confirm whether to perform the operation - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Describes the actions the current operation will perform without actually performing them - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.AnalysisServices.Models.AzureAnalysisServicesServer - -## NOTES -Alias: Suspend-AzureAs - -## RELATED LINKS - -[Get-AzureRmAnalysisServicesServer](./Get-AzureRmAnalysisServicesServer.md) - -[Resume-AzureRmAnalysisServicesServer](./Resume-AzureRmAnalysisServicesServer.md) - diff --git a/azurermps-6.13.0/AzureRM.AnalysisServices/Test-AzureRmAnalysisServicesServer.md b/azurermps-6.13.0/AzureRM.AnalysisServices/Test-AzureRmAnalysisServicesServer.md deleted file mode 100644 index 650d2c1d93..0000000000 --- a/azurermps-6.13.0/AzureRM.AnalysisServices/Test-AzureRmAnalysisServicesServer.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AnalysisServices.dll-Help.xml -Module Name: AzureRM.AnalysisServices -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.analysisservices/test-azurermanalysisservicesserver -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AnalysisServices/Commands.AnalysisServices/help/Test-AzureRmAnalysisServicesServer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AnalysisServices/Commands.AnalysisServices/help/Test-AzureRmAnalysisServicesServer.md ---- - -# Test-AzureRmAnalysisServicesServer - -## SYNOPSIS -Tests the existence of an instance of Analysis Services server - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Test-AzureRmAnalysisServicesServer [-Name] [[-ResourceGroupName] ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The Test-AzureRmAnalysisServicesServer cmdlet tests the existence of an instance of Analysis Services server - -## EXAMPLES - -### Example 1 -``` -PS C:\> Test-AzureRmAnalysisServicesServer -Name "testserver" -ResourceGroupName "testgroup" -``` - -This command will test if there is a server named testserver in the resourcegroup testgroup - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the Analysis Services server - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Azure resource group to which the server belongs - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES -Alias: Test-AzureAs - -## RELATED LINKS - -[Get-AzureRmAnalysisServicesServer](./Get-AzureRmAnalysisServicesServer.md) - -[Remove-AzureRmAnalysisServicesServer](./Remove-AzureRmAnalysisServicesServer.md) diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Add-AzureRmApiManagementApiToProduct.md b/azurermps-6.13.0/AzureRM.ApiManagement/Add-AzureRmApiManagementApiToProduct.md deleted file mode 100644 index 246658d77c..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Add-AzureRmApiManagementApiToProduct.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 7C86B385-D784-45FD-9B57-31C895115A2C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/add-azurermapimanagementapitoproduct -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Add-AzureRmApiManagementApiToProduct.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Add-AzureRmApiManagementApiToProduct.md ---- - -# Add-AzureRmApiManagementApiToProduct - -## SYNOPSIS -Adds an API to a product. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmApiManagementApiToProduct -Context -ProductId -ApiId - [-PassThru] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Add-AzureRmApiManagementApiToProduct** cmdlet adds an Azure API Management API to a product. - -## EXAMPLES - -### Example 1: Add an API to a product -``` -PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Add-AzureRmApiManagementApiToProduct -Context $ApiMgmtContext -ProductId "0123456789" -ApiId "0001" -``` - -This command adds the specified API to the specified product. - -## PARAMETERS - -### -ApiId -Specifies the ID of an API to add to a product. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -passthru - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProductId -Specifies the ID of the product to which to add the API. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmApiManagementApiFromProduct](./Remove-AzureRmApiManagementApiFromProduct.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Add-AzureRmApiManagementProductToGroup.md b/azurermps-6.13.0/AzureRM.ApiManagement/Add-AzureRmApiManagementProductToGroup.md deleted file mode 100644 index 4c1c7ef4b2..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Add-AzureRmApiManagementProductToGroup.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 1058BA4E-CD79-429D-BB05-422AE39230C4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/add-azurermapimanagementproducttogroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Add-AzureRmApiManagementProductToGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Add-AzureRmApiManagementProductToGroup.md ---- - -# Add-AzureRmApiManagementProductToGroup - -## SYNOPSIS -Adds a product to a group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmApiManagementProductToGroup -Context -GroupId -ProductId - [-PassThru] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Add-AzureRmApiManagementProductToGroup** cmdlet adds a product to an existing group. -In other words, this cmdlet assigns a group to a product. - -## EXAMPLES - -### Example 1: Add a product to a group -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Add-AzureRmApiManagementProductToGroup -Context $apimContext -GroupId "0001" -ProductId "0123456789" -``` - -This command adds a product to an existing group. - -## PARAMETERS - -### -Context -Specifies a **PsApiManagementContext** object. -This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId -Specifies the group ID. -This parameter is required. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -passthru - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProductId -Specifies the product ID. -This parameter is required. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmApiManagementProductFromGroup](./Remove-AzureRmApiManagementProductFromGroup.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Add-AzureRmApiManagementRegion.md b/azurermps-6.13.0/AzureRM.ApiManagement/Add-AzureRmApiManagementRegion.md deleted file mode 100644 index 08070b2236..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Add-AzureRmApiManagementRegion.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 9D4A68A8-0A39-4C9A-8EA6-391A5E7A0E25 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/add-azurermapimanagementregion -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Add-AzureRmApiManagementRegion.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Add-AzureRmApiManagementRegion.md ---- - -# Add-AzureRmApiManagementRegion - -## SYNOPSIS -Adds new deployment regions to a PsApiManagement instance. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmApiManagementRegion -ApiManagement -Location [-Sku ] - [-Capacity ] [-VirtualNetwork ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Add-AzureRmApiManagementRegion** cmdlet adds new instance of type **PsApiManagementRegion** to the collection of **AdditionalRegions** of provided instance of type **Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement**. -This cmdlet does not deploy anything by itself but updates instance of **PsApiManagement** in-memory. -To update a deployment of an API Management pass the modified **PsApiManagement** Instance to Update-AzureRmApiManagementDeployment. - -## EXAMPLES - -### Example 1: Add new deployment regions to a PsApiManagement instance -``` -PS C:\>Add-AzureRmApiManagementRegion -ApiManagement $ApiManagement -Location "East US" -Sku "Premium" -Capacity 2 -``` - -This command adds two premium SKU units and the region named East US to the **PsApiManagement** instance. - -### Example 2: Add new deployment regions to a PsApiManagement instance and then update deployment -``` -PS C:\>Get-AzureRmApiManagement -ResourceGroupName "Contoso" -Name "ContosoApi" | Add-AzureRmApiManagementRegion -Location "East US" -Sku "Premium" -Capacity 2 | Update-AzureRmApiManagementDeployment -``` - -This command gets a **PsApiManagement** object, adds two premium SKU units for the region named East US, and then updates deployment. - -## PARAMETERS - -### -ApiManagement -Specifies the **PsApiManagement** instance that this cmdlet adds additional deployment regions to. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Capacity -Specifies the SKU capacity of the deployment region. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the new deployment region amongst the supported region for Api Management service. -To obtain valid locations, use the cmdlet -Get-AzureRmResourceProvider -ProviderNamespace "Microsoft.ApiManagement" | where {$_.ResourceTypes[0].ResourceTypeName -eq "service"} | Select-Object Locations - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sku -Specifies the tier of the deployment region. -Valid values are: -- Developer -- Standard -- Premium - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSku] -Parameter Sets: (All) -Aliases: -Accepted values: Developer, Standard, Premium, Basic - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetwork -Specifies a virtual network configuration. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementVirtualNetwork -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement -Parameters: ApiManagement (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement - -## NOTES -* The cmdlet writes updated **PsApiManagement** instance to pipeline. - -## RELATED LINKS - -[Remove-AzureRmApiManagementRegion](./Remove-AzureRmApiManagementRegion.md) - -[Update-AzureRmApiManagementRegion](./Update-AzureRmApiManagementRegion.md) - -[Update-AzureRmApiManagementDeployment](./Update-AzureRmApiManagementDeployment.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Add-AzureRmApiManagementUserToGroup.md b/azurermps-6.13.0/AzureRM.ApiManagement/Add-AzureRmApiManagementUserToGroup.md deleted file mode 100644 index 628eaf5d2e..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Add-AzureRmApiManagementUserToGroup.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 8C014335-9622-4F2E-A163-4B0C84531506 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/add-azurermapimanagementusertogroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Add-AzureRmApiManagementUserToGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Add-AzureRmApiManagementUserToGroup.md ---- - -# Add-AzureRmApiManagementUserToGroup - -## SYNOPSIS -Adds a user to a group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmApiManagementUserToGroup -Context -GroupId -UserId - [-PassThru] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Add-AzureRmApiManagementUserToGroup** cmdlet adds a user to a group. - -## EXAMPLES - -### Example 1: Add a user to a group -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Add-AzureRmApiManagementUserToGroup -Context $apimContext -GroupId "0001" -UserId "0123456789" -``` - -This command adds an existing user to an existing group. - -## PARAMETERS - -### -Context -Specifies a **PsApiManagementContext** object. -This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId -Specifies the group ID. -This parameter is required. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -passthru - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserId -Specifies the user ID. -This parameter is required. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementUser](./Get-AzureRmApiManagementUser.md) - -[Remove-AzureRmApiManagementUserFromGroup](./Remove-AzureRmApiManagementUserFromGroup.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/AzureRM.ApiManagement.md b/azurermps-6.13.0/AzureRM.ApiManagement/AzureRM.ApiManagement.md deleted file mode 100644 index 501d05c86d..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/AzureRM.ApiManagement.md +++ /dev/null @@ -1,327 +0,0 @@ ---- -Module Name: AzureRM.ApiManagement -Module Guid: f875725d-8ce4-423f-a6af-ea880bc63f13 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement -Help Version: 4.0.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/AzureRM.ApiManagement.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/AzureRM.ApiManagement.md ---- - -# AzureRM.ApiManagement Module -## Description -This topic displays help topics for the Azure API Management Cmdlets. - -## AzureRM.ApiManagement Cmdlets -### [Add-AzureRmApiManagementApiToProduct](Add-AzureRmApiManagementApiToProduct.md) -Adds an API to a product. - -### [Add-AzureRmApiManagementProductToGroup](Add-AzureRmApiManagementProductToGroup.md) -Adds a product to a group. - -### [Add-AzureRmApiManagementRegion](Add-AzureRmApiManagementRegion.md) -Adds new deployment regions to a PsApiManagement instance. - -### [Add-AzureRmApiManagementUserToGroup](Add-AzureRmApiManagementUserToGroup.md) -Adds a user to a group. - -### [Backup-AzureRmApiManagement](Backup-AzureRmApiManagement.md) -Backs up an API Management service. - -### [Export-AzureRmApiManagementApi](Export-AzureRmApiManagementApi.md) -Exports an API to a file. - -### [Get-AzureRmApiManagement](Get-AzureRmApiManagement.md) -Gets a list or a particular API Management Service description. - -### [Get-AzureRmApiManagementApi](Get-AzureRmApiManagementApi.md) -Gets an API. - -### [Get-AzureRmApiManagementApiRelease](Get-AzureRmApiManagementApiRelease.md) -Get the API Release. - -### [Get-AzureRmApiManagementApiRevision](Get-AzureRmApiManagementApiRevision.md) -Gets details of all the API Revisions of an API - -### [Get-AzureRmApiManagementApiVersionSet](Get-AzureRmApiManagementApiVersionSet.md) -Get the details of the API Version Sets - -### [Get-AzureRmApiManagementAuthorizationServer](Get-AzureRmApiManagementAuthorizationServer.md) -Gets an API Management authorization server. - -### [Get-AzureRmApiManagementBackend](Get-AzureRmApiManagementBackend.md) -Get the details of the Backend. - -### [Get-AzureRmApiManagementCertificate](Get-AzureRmApiManagementCertificate.md) -Gets API Management certificates configured for Mutual Authentication with Backend in the service. - -### [Get-AzureRmApiManagementGroup](Get-AzureRmApiManagementGroup.md) -Gets all or specific API management groups. - -### [Get-AzureRmApiManagementIdentityProvider](Get-AzureRmApiManagementIdentityProvider.md) -Get the identity provider configuration details. - -### [Get-AzureRmApiManagementLogger](Get-AzureRmApiManagementLogger.md) -Gets API Management Logger objects. - -### [Get-AzureRmApiManagementOpenIdConnectProvider](Get-AzureRmApiManagementOpenIdConnectProvider.md) -Gets OpenID Connect providers. - -### [Get-AzureRmApiManagementOperation](Get-AzureRmApiManagementOperation.md) -Gets a list or a specified API Operation. - -### [Get-AzureRmApiManagementPolicy](Get-AzureRmApiManagementPolicy.md) -Gets the specified scope policy. - -### [Get-AzureRmApiManagementProduct](Get-AzureRmApiManagementProduct.md) -Gets a list or a particular product. - -### [Get-AzureRmApiManagementProperty](Get-AzureRmApiManagementProperty.md) - - -### [Get-AzureRmApiManagementSsoToken](Get-AzureRmApiManagementSsoToken.md) -Gets a link with an SSO token to a deployed management portal of an API Management service. - -### [Get-AzureRmApiManagementSubscription](Get-AzureRmApiManagementSubscription.md) -Gets subscriptions. - -### [Get-AzureRmApiManagementTenantAccess](Get-AzureRmApiManagementTenantAccess.md) -Gets the access configuration for a tenant. - -### [Get-AzureRmApiManagementTenantGitAccess](Get-AzureRmApiManagementTenantGitAccess.md) -Gets the Git access configuration for a tenant. - -### [Get-AzureRmApiManagementTenantSyncState](Get-AzureRmApiManagementTenantSyncState.md) -Gets the status of the most recent synchronization between the configuration database and the Git repository. - -### [Get-AzureRmApiManagementUser](Get-AzureRmApiManagementUser.md) -Gets a user or users. - -### [Get-AzureRmApiManagementUserSsoUrl](Get-AzureRmApiManagementUserSsoUrl.md) -Generates an SSO URL for a user. - -### [Import-AzureRmApiManagementApi](Import-AzureRmApiManagementApi.md) -Imports an API from a file or a URL. - -### [Import-AzureRmApiManagementHostnameCertificate](Import-AzureRmApiManagementHostnameCertificate.md) -Imports a certificate in a PFX format for an API Management Service. - -### [New-AzureRmApiManagement](New-AzureRmApiManagement.md) -Creates an API Management deployment. - -### [New-AzureRmApiManagementApi](New-AzureRmApiManagementApi.md) -Creates an API. - -### [New-AzureRmApiManagementApiRelease](New-AzureRmApiManagementApiRelease.md) -Creates an API Release of an API Revision - -### [New-AzureRmApiManagementApiRevision](New-AzureRmApiManagementApiRevision.md) -Creates a new Revision of an Existing API. - -### [New-AzureRmApiManagementApiVersionSet](New-AzureRmApiManagementApiVersionSet.md) -Creates an API Version Set. - -### [New-AzureRmApiManagementAuthorizationServer](New-AzureRmApiManagementAuthorizationServer.md) -Creates an authorization server. - -### [New-AzureRmApiManagementBackend](New-AzureRmApiManagementBackend.md) -Creates a new backend entity. - -### [New-AzureRmApiManagementBackendCredential](New-AzureRmApiManagementBackendCredential.md) -Creates a new Backend Credential contract. - -### [New-AzureRmApiManagementBackendProxy](New-AzureRmApiManagementBackendProxy.md) -Creates a new Backend Proxy Object. - -### [New-AzureRmApiManagementBackendServiceFabric](New-AzureRmApiManagementBackendServiceFabric.md) -Creates an object of `PsApiManagementServiceFabric` - -### [New-AzureRmApiManagementCertificate](New-AzureRmApiManagementCertificate.md) -Creates an API Management certificate to be used during Authentication with Backend. - -### [New-AzureRmApiManagementContext](New-AzureRmApiManagementContext.md) -Creates an instance of PsAzureApiManagementContext. - -### [New-AzureRmApiManagementCustomHostnameConfiguration](New-AzureRmApiManagementCustomHostnameConfiguration.md) -Creates an instance of `PsApiManagementCustomHostNameConfiguration`. - -### [New-AzureRmApiManagementGroup](New-AzureRmApiManagementGroup.md) -Creates an API management group. - -### [New-AzureRmApiManagementHostnameConfiguration](New-AzureRmApiManagementHostnameConfiguration.md) -Creates an instance of PsApiManagementHostnameConfiguration. - -### [New-AzureRmApiManagementIdentityProvider](New-AzureRmApiManagementIdentityProvider.md) -Creates a new Identity Provider configuration. - -### [New-AzureRmApiManagementLogger](New-AzureRmApiManagementLogger.md) -Creates an API Management Logger. - -### [New-AzureRmApiManagementOpenIdConnectProvider](New-AzureRmApiManagementOpenIdConnectProvider.md) -Creates an OpenID Connect provider. - -### [New-AzureRmApiManagementOperation](New-AzureRmApiManagementOperation.md) -Creates an API management operation. - -### [New-AzureRmApiManagementProduct](New-AzureRmApiManagementProduct.md) -Creates an API Management product. - -### [New-AzureRmApiManagementProperty](New-AzureRmApiManagementProperty.md) -Creates a new Property. - -### [New-AzureRmApiManagementRegion](New-AzureRmApiManagementRegion.md) -Creates an instance of PsApiManagementRegion. - -### [New-AzureRmApiManagementSubscription](New-AzureRmApiManagementSubscription.md) -Creates a subscription. - -### [New-AzureRmApiManagementSystemCertificate](New-AzureRmApiManagementSystemCertificate.md) -Creates an instance of `PsApiManagementSystemCertificate`. The certificate can be issued by private CA's and will be installed on the API Management service into `CertificateAuthority` or `Root` store. - -### [New-AzureRmApiManagementUser](New-AzureRmApiManagementUser.md) -Registers a new user. - -### [New-AzureRmApiManagementVirtualNetwork](New-AzureRmApiManagementVirtualNetwork.md) -Creates an instance of PsApiManagementVirtualNetwork. - -### [Publish-AzureRmApiManagementTenantGitConfiguration](Publish-AzureRmApiManagementTenantGitConfiguration.md) -Publishes changes from a Git branch to the configuration database. - -### [Remove-AzureRmApiManagement](Remove-AzureRmApiManagement.md) -Removes an API Management service. - -### [Remove-AzureRmApiManagementApi](Remove-AzureRmApiManagementApi.md) -Removes an API. - -### [Remove-AzureRmApiManagementApiFromProduct](Remove-AzureRmApiManagementApiFromProduct.md) -Removes an API from a product. - -### [Remove-AzureRmApiManagementApiRelease](Remove-AzureRmApiManagementApiRelease.md) -Removes a particular API Release - -### [Remove-AzureRmApiManagementApiRevision](Remove-AzureRmApiManagementApiRevision.md) -Removed a particular API Revision - -### [Remove-AzureRmApiManagementApiVersionSet](Remove-AzureRmApiManagementApiVersionSet.md) -Removes a particular Api Version Set - -### [Remove-AzureRmApiManagementAuthorizationServer](Remove-AzureRmApiManagementAuthorizationServer.md) -Removes an authorization server. - -### [Remove-AzureRmApiManagementBackend](Remove-AzureRmApiManagementBackend.md) -Removes a Backend. - -### [Remove-AzureRmApiManagementCertificate](Remove-AzureRmApiManagementCertificate.md) -Removes an API Management certificate. - -### [Remove-AzureRmApiManagementGroup](Remove-AzureRmApiManagementGroup.md) -Removes an existing API management group. - -### [Remove-AzureRmApiManagementIdentityProvider](Remove-AzureRmApiManagementIdentityProvider.md) -Removes an existing Identity Provider Configuration. - -### [Remove-AzureRmApiManagementLogger](Remove-AzureRmApiManagementLogger.md) -Removes an API Management Logger. - -### [Remove-AzureRmApiManagementOpenIdConnectProvider](Remove-AzureRmApiManagementOpenIdConnectProvider.md) -Removes an OpenID Connect provider. - -### [Remove-AzureRmApiManagementOperation](Remove-AzureRmApiManagementOperation.md) -Removes an existing operation. - -### [Remove-AzureRmApiManagementPolicy](Remove-AzureRmApiManagementPolicy.md) -Removes the API Management policy from a specified scope. - -### [Remove-AzureRmApiManagementProduct](Remove-AzureRmApiManagementProduct.md) -Removes an existing API Management product. - -### [Remove-AzureRmApiManagementProductFromGroup](Remove-AzureRmApiManagementProductFromGroup.md) -Removes a product from a group. - -### [Remove-AzureRmApiManagementProperty](Remove-AzureRmApiManagementProperty.md) -Removes an API Management Property. - -### [Remove-AzureRmApiManagementRegion](Remove-AzureRmApiManagementRegion.md) -Removes an existing deployment region from PsApiManagement instance. - -### [Remove-AzureRmApiManagementSubscription](Remove-AzureRmApiManagementSubscription.md) -Deletes an existing subscription. - -### [Remove-AzureRmApiManagementUser](Remove-AzureRmApiManagementUser.md) -Deletes an existing user. - -### [Remove-AzureRmApiManagementUserFromGroup](Remove-AzureRmApiManagementUserFromGroup.md) -Removes a user from a group. - -### [Restore-AzureRmApiManagement](Restore-AzureRmApiManagement.md) -Restores an API Management Service from the specified Azure storage blob. - -### [Save-AzureRmApiManagementTenantGitConfiguration](Save-AzureRmApiManagementTenantGitConfiguration.md) -Saves changes by creating a commit for current configuration. - -### [Set-AzureRmApiManagement](Set-AzureRmApiManagement.md) -Updates an Azure Api Management service - -### [Set-AzureRmApiManagementApi](Set-AzureRmApiManagementApi.md) -Modifies an API. - -### [Set-AzureRmApiManagementApiRevision](Set-AzureRmApiManagementApiRevision.md) -Modifies an API Revision - -### [Set-AzureRmApiManagementApiVersionSet](Set-AzureRmApiManagementApiVersionSet.md) -Updates an API Version Set in the API Management Context. - -### [Set-AzureRmApiManagementAuthorizationServer](Set-AzureRmApiManagementAuthorizationServer.md) -Modifies an authorization server. - -### [Set-AzureRmApiManagementBackend](Set-AzureRmApiManagementBackend.md) -Updates a Backend. - -### [Set-AzureRmApiManagementCertificate](Set-AzureRmApiManagementCertificate.md) -Modifies an API Management certificate which is configured for mutual authentication with backend. - -### [Set-AzureRmApiManagementGroup](Set-AzureRmApiManagementGroup.md) -Configures an API management group. - -### [Set-AzureRmApiManagementHostnames](Set-AzureRmApiManagementHostnames.md) -Sets a custom hostname configuration for an API Management service proxy or portal. - -### [Set-AzureRmApiManagementIdentityProvider](Set-AzureRmApiManagementIdentityProvider.md) -Updates the Configuration of an existing Identity Provider. - -### [Set-AzureRmApiManagementLogger](Set-AzureRmApiManagementLogger.md) -Modifies an API Management Logger. - -### [Set-AzureRmApiManagementOpenIdConnectProvider](Set-AzureRmApiManagementOpenIdConnectProvider.md) -Modifies an OpenID Connect provider. - -### [Set-AzureRmApiManagementOperation](Set-AzureRmApiManagementOperation.md) -Sets API operation details. - -### [Set-AzureRmApiManagementPolicy](Set-AzureRmApiManagementPolicy.md) -Sets the specified scope policy for API Management. - -### [Set-AzureRmApiManagementProduct](Set-AzureRmApiManagementProduct.md) -Sets the API Management product details. - -### [Set-AzureRmApiManagementProperty](Set-AzureRmApiManagementProperty.md) -Modifies an API Management Property. - -### [Set-AzureRmApiManagementSubscription](Set-AzureRmApiManagementSubscription.md) -Sets existing subscription details. - -### [Set-AzureRmApiManagementTenantAccess](Set-AzureRmApiManagementTenantAccess.md) -Enables or disables tenant access. - -### [Set-AzureRmApiManagementUser](Set-AzureRmApiManagementUser.md) -Sets user details. - -### [Update-AzureRmApiManagementApiRelease](Update-AzureRmApiManagementApiRelease.md) -Updates a particular Api Release. - -### [Update-AzureRmApiManagementDeployment](Update-AzureRmApiManagementDeployment.md) -Updates deployment of an API Management Service. - -### [Update-AzureRmApiManagementRegion](Update-AzureRmApiManagementRegion.md) -Updates existing deployment region in PsApiManagement instance. - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Backup-AzureRmApiManagement.md b/azurermps-6.13.0/AzureRM.ApiManagement/Backup-AzureRmApiManagement.md deleted file mode 100644 index 7f32a7b24c..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Backup-AzureRmApiManagement.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 5846BBB7-DA8E-41B5-A894-BA2B61C2212C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/backup-azurermapimanagement -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Backup-AzureRmApiManagement.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Backup-AzureRmApiManagement.md ---- - -# Backup-AzureRmApiManagement - -## SYNOPSIS -Backs up an API Management service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Backup-AzureRmApiManagement -ResourceGroupName -Name -StorageContext - -TargetContainerName [-TargetBlobName ] [-PassThru] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Backup-AzureRmApiManagement** cmdlet backs up an instance of an Azure API Management service. -This cmdlet stores the backup as an Azure Storage blob. - -## EXAMPLES - -### Example 1: Back up an API Management service -``` -PS C:\>New-AzureRmStorageAccount -StorageAccountName "ContosoStorage" -Location $location -ResourceGroupName "ContosoGroup02" -Type Standard_LRS -PS C:\>$storageKey = (Get-AzureRmStorageAccountKey -ResourceGroupName "ContosoGroup02" -StorageAccountName "ContosoStorage")[0].Value -PS C:\>$storageContext = New-AzureStorageContext -StorageAccountName "ContosoStorage" -StorageAccountKey $storageKey -PS C:\>Backup-AzureRmApiManagement -ResourceGroupName "ContosoGroup02" -Name "ContosoApi" -StorageContext $StorageContext -TargetContainerName "ContosoBackups" -TargetBlobName "ContosoBackup.apimbackup" -``` - -This command backs up an API Management service to a Storage blob. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the API Management deployment that this cmdlet backs up. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns the backed up **PsApiManagement** object, if the operation succeeds. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the of resource group under which the API Management deployment exists. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageContext -Specifies a storage connection context. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetBlobName -Specifies the name of the blob for the backup. -If the blob does not exist, this cmdlet creates it. -This cmdlet generates a default value based on the following pattern: -{Name}-{yyyy-MM-dd-HH-mm}.apimbackup - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetContainerName -Specifies the name of the container of the blob for the backup. -If the container does not exist, this cmdlet creates it. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagement](./Get-AzureRmApiManagement.md) - -[New-AzureRmApiManagement](./New-AzureRmApiManagement.md) - -[Remove-AzureRmApiManagement](./Remove-AzureRmApiManagement.md) - -[Restore-AzureRmApiManagement](./Restore-AzureRmApiManagement.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Export-AzureRmApiManagementApi.md b/azurermps-6.13.0/AzureRM.ApiManagement/Export-AzureRmApiManagementApi.md deleted file mode 100644 index 2849c7cff7..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Export-AzureRmApiManagementApi.md +++ /dev/null @@ -1,234 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 2BA76B02-B786-4A77-86E0-E7D4191120B5 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/export-azurermapimanagementapi -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Export-AzureRmApiManagementApi.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Export-AzureRmApiManagementApi.md ---- - -# Export-AzureRmApiManagementApi - -## SYNOPSIS -Exports an API to a file. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ExportToPipeline (Default) -``` -Export-AzureRmApiManagementApi -Context -ApiId [-ApiRevision ] - -SpecificationFormat [-DefaultProfile ] [-WhatIf] - [-Confirm] [] -``` - -### ExportToFile -``` -Export-AzureRmApiManagementApi -Context -ApiId [-ApiRevision ] - -SpecificationFormat -SaveAs [-Force] [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Export-AzureRmApiManagementApi** cmdlet exports an Azure API Management API to a file in one of the supported formats. - -## EXAMPLES - -### Example 1: Export an API in Web Application Description Language (WADL) format -```powershell -PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Export-AzureRmApiManagementApi -Context $ApiMgmtContext -ApiId "0123456789" -SpecificationFormat "Wadl" -SaveAs "C:\contoso\specifications\0123456789.wadl" -``` - -This command exports an API to a WADL file. - -## PARAMETERS - -### -ApiId -Specifies the ID of the API to export. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApiRevision -Identifier of API Revision. This parameter is optional. If not specified, the export will be done for the currently active api revision. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Indicates that this operation overwrites the file of the same name if it already exists. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ExportToFile -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this operation returns $True if the API is exported successfully, or $False otherwise. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ExportToFile -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SaveAs -Specifies the file path to which to save the exported API. - -```yaml -Type: System.String -Parameter Sets: ExportToFile -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SpecificationFormat -Specifies the API format. -psdx_paramvalues Wadl and Swagger. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiFormat -Parameter Sets: (All) -Aliases: -Accepted values: Wadl, Swagger, Wsdl - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiFormat - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.String -This cmdlet returns the exported API content as a string. - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementApi](./Get-AzureRmApiManagementApi.md) - -[Import-AzureRmApiManagementApi](./Import-AzureRmApiManagementApi.md) - -[New-AzureRmApiManagementApi](./New-AzureRmApiManagementApi.md) - -[Remove-AzureRmApiManagementApi](./Remove-AzureRmApiManagementApi.md) - -[Set-AzureRmApiManagementApi](./Set-AzureRmApiManagementApi.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagement.md b/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagement.md deleted file mode 100644 index f623dfbdd7..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagement.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: DBA7AD5F-CC13-417A-B753-F998942530BB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagement -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagement.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagement.md ---- - -# Get-AzureRmApiManagement - -## SYNOPSIS -Gets a list or a particular API Management Service description. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetBySubscription (Default) -``` -Get-AzureRmApiManagement [-DefaultProfile ] [] -``` - -### GetByResourceGroup -``` -Get-AzureRmApiManagement -ResourceGroupName [-DefaultProfile ] - [] -``` - -### GetByResource -``` -Get-AzureRmApiManagement -ResourceGroupName -Name [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Get-AzureRmApiManagement** cmdlet gets a list of all API Management services under subscription or specified resource group or a particular API Management. - -## EXAMPLES - -### Example 1: Get all API Management services -```powershell -PS C:\>Get-AzureRmApiManagement -``` - -This command gets all API Management services within a subscription. - -### Example 2: Get all API Management services by a specific name -```powershell -PS C:\>Get-AzureRmApiManagement -ResourceGroupName "ContosoGroup" -Name "ContosoApi" -``` - -This command gets all API Management service by name. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of API Management service. - -```yaml -Type: System.String -Parameter Sets: GetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group under in which this cmdlet gets the API Management service. - -```yaml -Type: System.String -Parameter Sets: GetByResourceGroup, GetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement - -## NOTES - -## RELATED LINKS - -[Backup-AzureRmApiManagement](./Backup-AzureRmApiManagement.md) - -[New-AzureRmApiManagement](./New-AzureRmApiManagement.md) - -[Remove-AzureRmApiManagement](./Remove-AzureRmApiManagement.md) - -[Restore-AzureRmApiManagement](./Restore-AzureRmApiManagement.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementApi.md b/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementApi.md deleted file mode 100644 index de1212991e..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementApi.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: B80389B9-E143-4E24-A222-E95F691DA2E9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementapi -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementApi.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementApi.md ---- - -# Get-AzureRmApiManagementApi - -## SYNOPSIS -Gets an API. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetAllApis (Default) -``` -Get-AzureRmApiManagementApi -Context [-DefaultProfile ] - [] -``` - -### GetByApiId -``` -Get-AzureRmApiManagementApi -Context -ApiId [-ApiRevision ] - [-DefaultProfile ] [] -``` - -### GetByName -``` -Get-AzureRmApiManagementApi -Context -Name - [-DefaultProfile ] [] -``` - -### GetByProductId -``` -Get-AzureRmApiManagementApi -Context -ProductId - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmApiManagementApi** cmdlet gets one or more Azure API Management APIs. - -## EXAMPLES - -### Example 1: Get all management APIs -``` -PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementApi -Context $ApiMgmtContext -``` - -This command gets all of the APIs for the specified context. - -### Example 2: Get a management API by ID -``` -PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementApi -Context $ApiMgmtContext -ApiId $ApiId -``` - -This command gets the API with the specified ID. - -### Example 3: Get a management API by name -``` -PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementApi -Context $ApiMgmtContext -Name "EchoApi" -``` - -This command gets the API with the specified name. - -## PARAMETERS - -### -ApiId -Specifies the ID of the API to get. - -```yaml -Type: System.String -Parameter Sets: GetByApiId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApiRevision -Revision Identifier of the particular Api revision. This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: GetByApiId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the API to get. - -```yaml -Type: System.String -Parameter Sets: GetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProductId -Specifies the ID of the product for which to get the API. - -```yaml -Type: System.String -Parameter Sets: GetByProductId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi - -## NOTES - -## RELATED LINKS - -[Export-AzureRmApiManagementApi](./Export-AzureRmApiManagementApi.md) - -[Import-AzureRmApiManagementApi](./Import-AzureRmApiManagementApi.md) - -[New-AzureRmApiManagementApi](./New-AzureRmApiManagementApi.md) - -[Remove-AzureRmApiManagementApi](./Remove-AzureRmApiManagementApi.md) - -[Set-AzureRmApiManagementApi](./Set-AzureRmApiManagementApi.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementApiRelease.md b/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementApiRelease.md deleted file mode 100644 index 29b24727b0..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementApiRelease.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementapirelease -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementApiRelease.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementApiRelease.md ---- - -# Get-AzureRmApiManagementApiRelease - -## SYNOPSIS -Get the API Release. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApiManagementApiRelease -Context -ApiId [-ReleaseId ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmApiManagementApiRelease** cmdlet gets one or more releases of the Azure API Management API. - -## EXAMPLES - -### Example 1: Get all releases of the API -```powershell -PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementApiRelease -Context $ApiMgmtContext -ApiId 5adf6fbf0faadf3ad8558065 -ReleaseId : 5afccaf6b89fd067426d402e -ApiId : 5adf6fbf0faadf3ad8558065 -CreatedDateTime : 5/17/2018 12:21:12 AM -UpdatedDateTime : 5/17/2018 12:21:12 AM -Notes : creating a new release -Id : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Microsoft.ApiManagement/service/contoso/apis/5adf6fbf0faadf3ad8558065/releases/5afccaf6b89fd067426d402e -ResourceGroupName : Api-Default-WestUS -ServiceName : contos -``` - -This command gets all of the releases of the `echo-api` API for the specified context. - -### Example 2: Get the release information of the particular API release -```powershell -PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementApiRelease -Context $ApiMgmtContext -ApiId 5adf6fbf0faadf3ad8558065 -ReleaseId 5afccaf6b89fd067426d402e -ReleaseId : 5afccaf6b89fd067426d402e -ApiId : 5adf6fbf0faadf3ad8558065 -CreatedDateTime : 5/17/2018 12:21:12 AM -UpdatedDateTime : 5/17/2018 12:21:12 AM -Notes : creating a new release -Id : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Mi - crosoft.ApiManagement/service/contos/apis/5adf6fbf0faadf3ad8558065/releases/5afccaf6b89fd067426d402 - e -ResourceGroupName : Api-Default-WestUS -ServiceName : contos -``` - -This command gets the releases information of a particular API with the specified releaseId. - -## PARAMETERS - -### -ApiId -API identifier to look for. -If specified will try to get the API by the Id. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Instance of PsApiManagementContext. -This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReleaseId -The identifier of the Release. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiRelease - -## NOTES - -## RELATED LINKS - -[New-AzureRmApiManagementApiRelease](./Get-AzureRmApiManagementApiRelease.md) - -[Remove-AzureRmApiManagementApiRelease](./Remove-AzureRmApiManagementApiRelease.md) - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementApiRevision.md b/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementApiRevision.md deleted file mode 100644 index 517ce5a96d..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementApiRevision.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementapirevision -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementApiRevision.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementApiRevision.md ---- - -# Get-AzureRmApiManagementApiRevision - -## SYNOPSIS -Gets details of all the API Revisions of an API - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApiManagementApiRevision -Context -ApiId [-ApiRevision ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmApiManagementApiRevision** cmdlet gets the details of all revisions of an API - -## EXAMPLES - -### Example 1: Get all API Revisions of an API -```powershell -PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementApiRevision -Context $ApiMgmtContext -ApiId "5adf6fbf0faadf3ad8558065" - -ApiId : /apis/5adf6fbf0faadf3ad8558065;rev=3 -ApiRevision : 3 -CreatedDateTime : 4/26/2018 10:57:42 PM -UpdatedDateTime : 4/26/2018 10:57:42 PM -Description : ddsds -PrivateUrl : /httpbin/v1;rev=3 -IsOnline : True -IsCurrent : False - -ApiId : /apis/5adf6fbf0faadf3ad8558065;rev=2 -ApiRevision : 2 -CreatedDateTime : 4/26/2018 10:57:33 PM -UpdatedDateTime : 4/26/2018 10:57:33 PM -Description : AA -PrivateUrl : /httpbin/v1 -IsOnline : True -IsCurrent : True - -ApiId : /apis/5adf6fbf0faadf3ad8558065;rev=1 -ApiRevision : 1 -CreatedDateTime : 4/24/2018 5:56:17 PM -UpdatedDateTime : 5/9/2018 9:29:06 PM -Description : -PrivateUrl : /httpbin/v1;rev=1 -IsOnline : True -IsCurrent : False -``` - -This command gets all of the API revision of specified API for particular ApiManagement Context. - -## PARAMETERS - -### -ApiId -API identifier whose revisions we want to list. -This parameter is required. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApiRevision -Revision Identifier of the particular Api revision. This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Instance of PsApiManagementContext. -This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiRevision - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementApiVersionSet.md b/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementApiVersionSet.md deleted file mode 100644 index 31f590488b..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementApiVersionSet.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementapiversionset -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementApiVersionSet.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementApiVersionSet.md ---- - -# Get-AzureRmApiManagementApiVersionSet - -## SYNOPSIS -Get the details of the API Version Sets - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApiManagementApiVersionSet -Context [-ApiVersionSetId ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmApiManagementApiVersionSet** cmdlet gets the details of the API Version Sets configured in an API Management context. - -## EXAMPLES - -### Example 1 - -### Example 1: Get all API Version Sets -```powershell -PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementApiVersionSet -Context $ApiMgmtContext - -ApiVersionSetId : a93316c8-8b88-46cc-8260-380789a5d598 -Description : -VersionQueryName : -VersionHeaderName : -DisplayName : Echo API -VersioningScheme : Segment -Id : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Microsoft.ApiManagement/service/contoso/api-version-sets/a916c8-8b88-46cc-8260-380789a5d598 -ResourceGroupName : Api-Default-WestUS -ServiceName : contoso - -ApiVersionSetId : 4cbdfa34-25f3-4a93-a9b6-76b6eade7562 -Description : -VersionQueryName : api-version -VersionHeaderName : -DisplayName : getproduct old -VersioningScheme : Query -Id : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Microsoft.ApiManagement/service/contoso/api-version-sets/4cbdfa34-25f3-4a93-a9b6-76b6eade7562 -ResourceGroupName : Api-Default-WestUS -ServiceName : contoso - - -ApiVersionSetId : 8c441e0e-a0cd-47d8-8d88-f944a83b41bd -Description : -VersionQueryName : -VersionHeaderName : Api-Version -DisplayName : ordersapi -VersioningScheme : Header -Id : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Microsoft.ApiManagement/service/contoso/api-version-sets/8c441e0e-a0cd-47d8-8d88-f944a83b41bd -ResourceGroupName : Api-Default-WestUS -ServiceName : contoso -``` - -This command gets all of the API Version sets for the specified context. - -### Example 2: Get a API Version Set by ID -```powershell -PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementApiVersionSet -Context $ApiMgmtContext -ApiVersionSetId $ApiVersionSetId - -ApiVersionSetId : 8c441e0e-a0cd-47d8-8d88-f944a83b41bd -Description : -VersionQueryName : -VersionHeaderName : Api-Version -DisplayName : ordersapi -VersioningScheme : Header -Id : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Microsoft.ApiManagement/service/contoso/api-version-sets/8c441e0e-a0cd-47d8-8d88-f944a83b41bd -ResourceGroupName : Api-Default-WestUS -ServiceName : contoso -``` - -This command gets the API Version Set with the specified ID. - -## PARAMETERS - -### -ApiVersionSetId -API identifier to look for. -If specified will try to get the API by the Id. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Instance of PsApiManagementContext. -This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiVersionSet - -## NOTES - -## RELATED LINKS - -[New-AzureRmApiManagementApiVersionSet](./New-AzureRmApiManagementApiVersionSet.md) - -[Remove-AzureRmApiManagementApiSet](./Remove-AzureRmApiManagementApiVersionSet.md) - -[Set-AzureRmApiManagementApiVersionSet](./Set-AzureRmApiManagementApiVersionSet.md) diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementAuthorizationServer.md b/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementAuthorizationServer.md deleted file mode 100644 index da25e379c2..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementAuthorizationServer.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 8B0116E5-0AED-4050-BF11-1BFE65DB9436 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementauthorizationserver -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementAuthorizationServer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementAuthorizationServer.md ---- - -# Get-AzureRmApiManagementAuthorizationServer - -## SYNOPSIS -Gets an API Management authorization server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetAllAuthorizationServers (Default) -``` -Get-AzureRmApiManagementAuthorizationServer -Context - [-DefaultProfile ] [] -``` - -### GetByServerId -``` -Get-AzureRmApiManagementAuthorizationServer -Context [-ServerId ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmApiManagementAuthorizationServer** cmdlet gets all Azure API Management authorization servers or specified authorization servers. - -## EXAMPLES - -### Example 1: Get all authorization servers -``` -PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementAuthrizarionServer -Context $ApiMgmtContext -``` - -This command gets all API Management authorization servers. - -### Example 2: Get a specified authorization server -``` -PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementCertificate -Context $ApiMgmtContext -ServerId "0123456789" -``` - -This command gets the specified authorization server. - -## PARAMETERS - -### -Context - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerId -```yaml -Type: System.String -Parameter Sets: GetByServerId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOAuth2AuthrozationServer - -## NOTES - -## RELATED LINKS - -[New-AzureRmApiManagementAuthorizationServer](./New-AzureRmApiManagementAuthorizationServer.md) - -[Remove-AzureRmApiManagementAuthorizationServer](./Remove-AzureRmApiManagementAuthorizationServer.md) - -[Set-AzureRmApiManagementAuthorizationServer](./Set-AzureRmApiManagementAuthorizationServer.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementBackend.md b/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementBackend.md deleted file mode 100644 index 98a53cc0af..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementBackend.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementbackend -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementBackend.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementBackend.md ---- - -# Get-AzureRmApiManagementBackend - -## SYNOPSIS -Get the details of the Backend. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetAllBackends (Default) -``` -Get-AzureRmApiManagementBackend -Context [-DefaultProfile ] - [] -``` - -### GetByBackendId -``` -Get-AzureRmApiManagementBackend -Context -BackendId - [-DefaultProfile ] [] -``` - -## DESCRIPTION -Get the details of the Backend. - -## EXAMPLES - -### Example 1: Get all Backends -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementBackend -Context $apimContext -``` - -Gets a list of all the Backends configured in the Api Management service. - -### Example 2: Get the Backend specified by the Identifier 123 -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementBackend -Context $apimContext -backendId 123 -``` - -Get the details of the specified Backend identified by the Identifier '123' - -## PARAMETERS - -### -BackendId -Identifier of a backend. -If specified will try to find backend by the identifier. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: GetByBackendId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Instance of PsApiManagementContext. -This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackend - -## NOTES - -## RELATED LINKS - -[New-AzureRmApiManagementBackend](./New-AzureRmApiManagementBackend.md) - -[New-AzureRmApiManagementBackendCredential](./New-AzureRmApiManagementBackendCredential.md) - -[New-AzureRmApiManagementBackendProxy](./New-AzureRmApiManagementBackendProxy.md) - -[Set-AzureRmApiManagementBackend](./Set-AzureRmApiManagementBackend.md) - -[Remove-AzureRmApiManagementBackend](./Remove-AzureRmApiManagementBackend.md) diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementCertificate.md b/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementCertificate.md deleted file mode 100644 index 4a3900f996..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementCertificate.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 6F7C6611-5C56-4F1D-AB98-CDD92D88821C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementCertificate.md ---- - -# Get-AzureRmApiManagementCertificate - -## SYNOPSIS -Gets API Management certificates configured for Mutual Authentication with Backend in the service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetAllCertificates (Default) -``` -Get-AzureRmApiManagementCertificate -Context - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### GetByCertificateId -``` -Get-AzureRmApiManagementCertificate -Context -CertificateId - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Get-AzureRmApiManagementCertificate** cmdlet gets all Azure API Management certificates or certificates that you specify. - -## EXAMPLES - -### Example 1: Get all certificates -``` -PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementCertificate -Context $ApiMgmtContext -``` - -This command gets all API Management certificates. - -### Example 2: Get a certificate by its ID -``` -PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementCertificate -Context $ApiMgmtContext -CertificateId "0123456789" -``` - -This command gets the API Management certificate with the specified ID. - -## PARAMETERS - -### -CertificateId -Specifies the ID of the certificate to get. - -```yaml -Type: System.String -Parameter Sets: GetByCertificateId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementCertificate - -## NOTES - -## RELATED LINKS - -[New-AzureRmApiManagementCertificate](./New-AzureRmApiManagementCertificate.md) - -[Remove-AzureRmApiManagementCertificate](./Remove-AzureRmApiManagementCertificate.md) - -[Set-AzureRmApiManagementCertificate](./Set-AzureRmApiManagementCertificate.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementGroup.md b/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementGroup.md deleted file mode 100644 index 0dda5ee87e..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementGroup.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: EEB52CCA-F5D6-4ACB-A6C9-D07C510A5878 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementgroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementGroup.md ---- - -# Get-AzureRmApiManagementGroup - -## SYNOPSIS -Gets all or specific API management groups. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetAllGroups (Default) -``` -Get-AzureRmApiManagementGroup -Context [-Name ] - [-DefaultProfile ] [] -``` - -### GetByGroupId -``` -Get-AzureRmApiManagementGroup -Context [-GroupId ] [-Name ] - [-DefaultProfile ] [] -``` - -### GetByUserId -``` -Get-AzureRmApiManagementGroup -Context [-Name ] [-UserId ] - [-DefaultProfile ] [] -``` - -### GetByProductId -``` -Get-AzureRmApiManagementGroup -Context [-Name ] [-ProductId ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmApiManagementGroup** cmdlet gets all or specific API management groups. - -## EXAMPLES - -### Example 1: Get all groups -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementGroup -Context $apimContext -``` - -This command gets all groups. - -### Example 2: Get a group by ID -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementGroup -Context $apimContext -GroupId "0123456789" -``` - -This command gets the group ID named 0123456789. - -### Example 3: Get a group by name -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementGroup -Context $apimContext -Name "Group0002" -``` - -This command gets the group named Group0002. - -### Example 4: Get all user groups -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementGroup -Context $apimContext -UserId "0123456789" -``` - -This command gets all user groups with the user ID named 0123456789. - -## PARAMETERS - -### -Context -Specifies an instance of PsApiManagementContext. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId -Specifies the group ID. -If specified, the cmdlet attempts to find the group by the identifier. - -```yaml -Type: System.String -Parameter Sets: GetByGroupId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the management group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProductId -Identifier of existing product. -If specified will return all groups the product assigned to. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: GetByProductId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserId -Specifies the identifier of existing product. -If specified the cmdlet will return all groups the product assigned to. - -```yaml -Type: System.String -Parameter Sets: GetByUserId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGroup - -## NOTES - -## RELATED LINKS - -[New-AzureRmApiManagementGroup](./New-AzureRmApiManagementGroup.md) - -[Remove-AzureRmApiManagementGroup](./Remove-AzureRmApiManagementGroup.md) - -[Set-AzureRmApiManagementGroup](./Set-AzureRmApiManagementGroup.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementIdentityProvider.md b/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementIdentityProvider.md deleted file mode 100644 index 8be89abe1c..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementIdentityProvider.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementidentityprovider -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementIdentityProvider.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementIdentityProvider.md ---- - -# Get-AzureRmApiManagementIdentityProvider - -## SYNOPSIS -Get the identity provider configuration details. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### AllIdentityProviders (Default) -``` -Get-AzureRmApiManagementIdentityProvider -Context - [-DefaultProfile ] [] -``` - -### IdentityProviderByType -``` -Get-AzureRmApiManagementIdentityProvider -Context - -Type [-DefaultProfile ] [] -``` - -## DESCRIPTION -Get the identity provider configuration details. - -## EXAMPLES - -### Example 1: Get all Identity Providers - -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementIdentityProvider -Context $apimContext -``` - -Get all the identity provider Configuration on the service. - -### Get the Microsoft Entra ID Type Identity Provider -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementIdentityProvider -Context $apimContext -Type Aad -``` - -Gets the Identity Provider Configuration of Microsoft Entra ID. - -## PARAMETERS - -### -Context -Instance of PsApiManagementContext. -This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Identifier of a Identity Provider. -If specified will try to find identity provider configuration by the identifier. -This parameter is optional. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementIdentityProviderType -Parameter Sets: IdentityProviderByType -Aliases: -Accepted values: Facebook, Google, Microsoft, Twitter, Aad, AadB2C - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementIdentityProviderType - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementIdentityProvider - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementLogger.md b/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementLogger.md deleted file mode 100644 index 4ddc5363d4..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementLogger.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: A935ABAC-6C60-4AE3-9434-B9BCC1182A34 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementlogger -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementLogger.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementLogger.md ---- - -# Get-AzureRmApiManagementLogger - -## SYNOPSIS -Gets API Management Logger objects. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetAllLoggers (Default) -``` -Get-AzureRmApiManagementLogger -Context [-DefaultProfile ] - [] -``` - -### GetByLoggerId -``` -Get-AzureRmApiManagementLogger -Context -LoggerId - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmApiManagementLogger** cmdlet gets an Azure API Management **Logger** or all the loggers. - -## EXAMPLES - -### Example 1: Get all loggers -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementLogger -Context $apimContext -``` - -This command gets all the loggers for the specified context. - -### Example 2: Get a specific logger -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementLogger -Context $apimContext -LoggerId "Logger123" -``` - -This command removes a logger that has the ID Logger123. - -## PARAMETERS - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoggerId -Specifies the ID of the specific logger to get. - -```yaml -Type: System.String -Parameter Sets: GetByLoggerId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementLogger - -## NOTES - -## RELATED LINKS - -[New-AzureRmApiManagementLogger](./New-AzureRmApiManagementLogger.md) - -[Remove-AzureRmApiManagementLogger](./Remove-AzureRmApiManagementLogger.md) - -[Set-AzureRmApiManagementLogger](./Set-AzureRmApiManagementLogger.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementOpenIdConnectProvider.md b/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementOpenIdConnectProvider.md deleted file mode 100644 index 693df25154..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementOpenIdConnectProvider.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 15B6EAE2-56ED-4A01-B8EA-52B9FCDC1F66 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementopenidconnectprovider -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementOpenIdConnectProvider.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementOpenIdConnectProvider.md ---- - -# Get-AzureRmApiManagementOpenIdConnectProvider - -## SYNOPSIS -Gets OpenID Connect providers. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetAllOpenIdConnectProviders (Default) -``` -Get-AzureRmApiManagementOpenIdConnectProvider -Context - [-DefaultProfile ] [] -``` - -### GetByOpenIdConnectProviderId -``` -Get-AzureRmApiManagementOpenIdConnectProvider -Context - [-OpenIdConnectProviderId ] [-DefaultProfile ] [] -``` - -### GetByName -``` -Get-AzureRmApiManagementOpenIdConnectProvider -Context [-Name ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmApiManagementOpenIdConnectProvider** cmdlet gets OpenID Connect providers in Azure API Management. - -## EXAMPLES - -### Example 1: Get all providers -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementOpenIdConnectProvider -Context $apimContext -``` - -This command gets all OpenID Connect providers for the specified context. - -### Example 2: Get a provider by using an ID -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementOpenIdConnectProvider -Context $apimContext -OpenIdConnectProviderId "OICProvicer01" -``` - -This command gets the provider that has the ID OICProvicer01. - -### Example 3: Get a provider by using a name -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementOpenIdConnectProvider -Context $apimContext -Name "Contoso OpenID Connect Provider" -``` - -This command gets the provider named Contoso OpenID Connect Provider. - -## PARAMETERS - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a friendly name of a provider. -If you specify a name, this cmdlet gets that provider. - -```yaml -Type: System.String -Parameter Sets: GetByName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OpenIdConnectProviderId -Specifies an ID of the provider that this cmdlet removes. -If you specify an ID, this cmdlet gets that provider. - -```yaml -Type: System.String -Parameter Sets: GetByOpenIdConnectProviderId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOpenIdConnectProvider - -## NOTES - -## RELATED LINKS - -[New-AzureRmApiManagementOpenIdConnectProvider](./New-AzureRmApiManagementOpenIdConnectProvider.md) - -[Remove-AzureRmApiManagementOpenIdConnectProvider](./Remove-AzureRmApiManagementOpenIdConnectProvider.md) - -[Set-AzureRmApiManagementOpenIdConnectProvider](./Set-AzureRmApiManagementOpenIdConnectProvider.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementOperation.md b/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementOperation.md deleted file mode 100644 index e79f73d678..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementOperation.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: D5EB9AFA-B56C-45E2-838B-4555ED1EF8F8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementoperation -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementOperation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementOperation.md ---- - -# Get-AzureRmApiManagementOperation - -## SYNOPSIS -Gets a list or a specified API Operation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetAllApiOperations (Default) -``` -Get-AzureRmApiManagementOperation -Context -ApiId [-ApiRevision ] - [-DefaultProfile ] [] -``` - -### GetById -``` -Get-AzureRmApiManagementOperation -Context -ApiId [-ApiRevision ] - -OperationId [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmApiManagementOperation** gets a list or a specified API Operation. - -## EXAMPLES - -### Example 1: Get all API management operations -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementOperation -Context $apimContext -ApiId $APIId -``` - -This command gets all API management operations. - -### Example 2: Get an API Management operation by operation ID -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementOperation -Context $apimContext -ApiId $APIId -OperationId "Operation003" -``` - -This command gets an API management operation by operation ID named Operation0003. - -## PARAMETERS - -### -ApiId -Specifies the identifier of the API Operation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApiRevision -Identifier of API Revision. This parameter is optional. If not specified, the operation will be retrieved from the currently active api revision. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Specifies the instance of the **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OperationId -Specifies the operation identifier. - -```yaml -Type: System.String -Parameter Sets: GetById -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOperation - -## NOTES - -## RELATED LINKS - -[New-AzureRmApiManagementOperation](./New-AzureRmApiManagementOperation.md) - -[Remove-AzureRmApiManagementOperation](./Remove-AzureRmApiManagementOperation.md) - -[Set-AzureRmApiManagementOperation](./Set-AzureRmApiManagementOperation.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementPolicy.md b/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementPolicy.md deleted file mode 100644 index e0263e6f1c..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementPolicy.md +++ /dev/null @@ -1,279 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 7BCEB0EF-1A09-4CED-9F34-CE3AB03181A7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementPolicy.md ---- - -# Get-AzureRmApiManagementPolicy - -## SYNOPSIS -Gets the specified scope policy. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetTenantLevel (Default) -``` -Get-AzureRmApiManagementPolicy -Context [-Format ] [-SaveAs ] [-Force] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### GetProductLevel -``` -Get-AzureRmApiManagementPolicy -Context [-Format ] [-SaveAs ] - -ProductId [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -### GetApiLevel -``` -Get-AzureRmApiManagementPolicy -Context [-Format ] [-SaveAs ] - -ApiId [-ApiRevision ] [-Force] [-DefaultProfile ] [-WhatIf] - [-Confirm] [] -``` - -### GetOperationLevel -``` -Get-AzureRmApiManagementPolicy -Context [-Format ] [-SaveAs ] - -ApiId [-ApiRevision ] -OperationId [-Force] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Get-AzureRmApiManagementPolicy** cmdlet gets the specified scope policy. - -## EXAMPLES - -### Example 1: Get the tenant level policy -```powershell -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementPolicy -Context $apimContext -SaveAs "C:\contoso\policies\tenantpolicy.xml" -``` - -This command gets tenant level policy and saves it to a file named tenantpolicy.xml. - -### Example 2: Get the product-scope policy -```powershell -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementPolicy -Context $apimContext -ProductId "0123456789" -``` - -This command gets product-scope policy - -### Example 3: Get the API-scope policy -```powershell -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementPolicy -Context $apimContext -ApiId "9876543210" -``` - -This command gets API-scope policy. - -### Example 4: Get the operation-scope policy -```powershell -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementPolicy -Context $apimContext -ApiId "9876543210" -OperationId "777" -``` - -This command gets the operation-scope policy. - -## PARAMETERS - -### -ApiId -Specifies the identifier of the existing API. -If you specify this parameter the cmdlet returns the API-scope policy. - -```yaml -Type: System.String -Parameter Sets: GetApiLevel, GetOperationLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApiRevision -Identifier of API Revision. This parameter is optional. If not specified, the policy will be retrieved from the currently active api revision. - -```yaml -Type: System.String -Parameter Sets: GetApiLevel, GetOperationLevel -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Specifies an instance of **PsApiManagementContext**. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -ps_force - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Format -Specifies the format of the API management policy. -The default value for this parameter is "application/vnd.ms-azure-apim.policy+xml". - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OperationId -Specifies the identifier of the existing API operation. -If you specify this parameter with *ApiId* the cmdlet returns operation-scope policy. - -```yaml -Type: System.String -Parameter Sets: GetOperationLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProductId -Specifies the identifier of an existing product. -If you specify this parameter the cmdlet returns the product-scope policy. - -```yaml -Type: System.String -Parameter Sets: GetProductLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SaveAs -Specifies the file path to save the result to. -If you do not specify this parameter the result is pipelined as a sting. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmApiManagementPolicy](./Remove-AzureRmApiManagementPolicy.md) - -[Set-AzureRmApiManagementPolicy](./Set-AzureRmApiManagementPolicy.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementProduct.md b/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementProduct.md deleted file mode 100644 index 7abe18c573..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementProduct.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: B64E9C13-97A6-4E8B-92DB-EFAF8A48C5B8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementproduct -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementProduct.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementProduct.md ---- - -# Get-AzureRmApiManagementProduct - -## SYNOPSIS -Gets a list or a particular product. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetAllProducts (Default) -``` -Get-AzureRmApiManagementProduct -Context [-DefaultProfile ] - [] -``` - -### GetByProductId -``` -Get-AzureRmApiManagementProduct -Context -ProductId - [-DefaultProfile ] [] -``` - -### GetByTitle -``` -Get-AzureRmApiManagementProduct -Context [-Title ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmApiManagementProduct** cmdlet gets a list or a particular product. - -## EXAMPLES - -### Example 1: Get all products -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementProduct -Context $apimContext -``` - -This command get all API Management products. - -### Example 2: Get a product by ID -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementProduct -Context $apimContext -ProductId "0123456789" -``` - -This command get an API Management product by ID. - -## PARAMETERS - -### -Context -Specifies an instance of a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProductId -Specifies the identifier of the product to search for. - -```yaml -Type: System.String -Parameter Sets: GetByProductId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Title -Specifies the title of the product to look for. -If specified, the cmdlet attempts to get the product by title. - -```yaml -Type: System.String -Parameter Sets: GetByTitle -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProduct - -## NOTES - -## RELATED LINKS - -[New-AzureRmApiManagementProduct](./New-AzureRmApiManagementProduct.md) - -[Remove-AzureRmApiManagementProduct](./Remove-AzureRmApiManagementProduct.md) - -[Set-AzureRmApiManagementProduct](./Set-AzureRmApiManagementProduct.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementProperty.md b/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementProperty.md deleted file mode 100644 index 34864b00ba..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementProperty.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 894297BF-2771-4871-9E4C-8684364DAC4B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementproperty -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementProperty.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementProperty.md ---- - -# Get-AzureRmApiManagementProperty - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetAllProperties (Default) -``` -Get-AzureRmApiManagementProperty -Context [-DefaultProfile ] - [] -``` - -### GetByPropertyId -``` -Get-AzureRmApiManagementProperty -Context [-PropertyId ] - [-DefaultProfile ] [] -``` - -### GetByName -``` -Get-AzureRmApiManagementProperty -Context [-Name ] - [-DefaultProfile ] [] -``` - -### GetByTag -``` -Get-AzureRmApiManagementProperty -Context [-Tag ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION - -## EXAMPLES - -### Example 1: Get Property by name -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementProperty -Context $apimContext -Name "sql-connectionstring" -``` - -## PARAMETERS - -### -Context -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -```yaml -Type: System.String -Parameter Sets: GetByName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PropertyId -```yaml -Type: System.String -Parameter Sets: GetByPropertyId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.String -Parameter Sets: GetByTag -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProperty - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementSsoToken.md b/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementSsoToken.md deleted file mode 100644 index fbd8657524..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementSsoToken.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: A7CABC63-2E9C-474B-A4F0-69F13A16F65A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementssotoken -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementSsoToken.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementSsoToken.md ---- - -# Get-AzureRmApiManagementSsoToken - -## SYNOPSIS -Gets a link with an SSO token to a deployed management portal of an API Management service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApiManagementSsoToken -ResourceGroupName -Name - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmApiManagementSsoToken** cmdlet returns a link (URL) containing a single sign-on (SSO) token to a deployed management portal of an API Management service. - -## EXAMPLES - -### Example 1: Get the SSO token of an API Management service -``` -PS C:\>Get-AzureRmApiManagementSsoToken -ResourceGroupName "Contoso" -Name "ContosoApi" -``` - -This command gets the SSO token of an API Management service. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the API Management instance. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of resource group under which API Management exists. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagement](./Get-AzureRmApiManagement.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementSubscription.md b/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementSubscription.md deleted file mode 100644 index 37dd79f348..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementSubscription.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 227EF8A2-E04A-4F6B-B66E-E77F1276A7E4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementsubscription -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementSubscription.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementSubscription.md ---- - -# Get-AzureRmApiManagementSubscription - -## SYNOPSIS -Gets subscriptions. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetAllSubscriptions (Default) -``` -Get-AzureRmApiManagementSubscription -Context - [-DefaultProfile ] [] -``` - -### GetBySubscriptionId -``` -Get-AzureRmApiManagementSubscription -Context [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -### GetByUserId -``` -Get-AzureRmApiManagementSubscription -Context [-UserId ] - [-DefaultProfile ] [] -``` - -### GetByProductId -``` -Get-AzureRmApiManagementSubscription -Context [-ProductId ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmApiManagementSubscription** cmdlet gets a specified subscription, or all subscriptions, if no subscription is specified. - -## EXAMPLES - -### Example 1: Get all subscriptions -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementSubscription -Context $apimContext -``` - -This command gets all subscriptions. - -### Example 2: Get a subscription with a specified ID -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementSubscription -Context $apimContext -SubscriptionId "0123456789" -``` - -This command gets a subscription by ID. - -### Example 3: Get all subscriptions for a user -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementSubscription -Context $apimContext -UserId "777" -``` - -This command gets a user's subscriptions. - -### Example 4: Get all subscriptions for a product -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementSubscription -Context $apimContext -ProductId "999" -``` - -This command gets all subscriptions for the product. - -## PARAMETERS - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProductId -Specifies a product identifier. -If specified, this cmdlet finds all subscriptions by the product identifier. - -```yaml -Type: System.String -Parameter Sets: GetByProductId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubscriptionId -Specifies a subscription identifier. -If specified, this cmdlet finds subscription by the identifier. - -```yaml -Type: System.String -Parameter Sets: GetBySubscriptionId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserId -Specifies a user identifier. -If specified, this cmdlet finds all subscriptions by the user identifier. - -```yaml -Type: System.String -Parameter Sets: GetByUserId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscription - -## NOTES - -## RELATED LINKS - -[New-AzureRmApiManagementSubscription](./New-AzureRmApiManagementSubscription.md) - -[Remove-AzureRmApiManagementSubscription](./Remove-AzureRmApiManagementSubscription.md) - -[Set-AzureRmApiManagementSubscription](./Set-AzureRmApiManagementSubscription.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementTenantAccess.md b/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementTenantAccess.md deleted file mode 100644 index a24084ab48..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementTenantAccess.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 236B4436-E8AD-42B4-922C-E2E1406CAFC2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementtenantaccess -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementTenantAccess.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementTenantAccess.md ---- - -# Get-AzureRmApiManagementTenantAccess - -## SYNOPSIS -Gets the access configuration for a tenant. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApiManagementTenantAccess -Context - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmApiManagementTenantAccess** cmdlet gets the tenant access configuration for a tenant. - -## EXAMPLES - -### Example 1: Get tenant access configuration -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementTenantAccess -Context $apimContext -``` - -This command gets the tenant access configuration for the specified context. - -## PARAMETERS - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementAccessInformation - -## NOTES - -## RELATED LINKS - -[Set-AzureRmApiManagementTenantAccess](./Set-AzureRmApiManagementTenantAccess.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementTenantGitAccess.md b/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementTenantGitAccess.md deleted file mode 100644 index 6cf6c4f889..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementTenantGitAccess.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 6F01F494-CD1D-483A-9E57-BF693B1F2FC1 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementtenantgitaccess -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementTenantGitAccess.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementTenantGitAccess.md ---- - -# Get-AzureRmApiManagementTenantGitAccess - -## SYNOPSIS -Gets the Git access configuration for a tenant. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApiManagementTenantGitAccess -Context - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmApiManagementTenantGitAccess** cmdlet gets the Git access configuration for a tenant. - -## EXAMPLES - -### Example 1: Get tenant access configuration -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementTenantGitAccess -Context $apimContext -``` - -This command gets the Git access configuration for the specified context. - -## PARAMETERS - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementAccessInformation - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementTenantSyncState.md b/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementTenantSyncState.md deleted file mode 100644 index da83610fb4..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementTenantSyncState.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 288EF15B-FE5C-44AE-ABD5-2B92F408B9EB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementtenantsyncstate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementTenantSyncState.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementTenantSyncState.md ---- - -# Get-AzureRmApiManagementTenantSyncState - -## SYNOPSIS -Gets the status of the most recent synchronization between the configuration database and the Git repository. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApiManagementTenantSyncState -Context - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmApiManagementTenantSyncState** cmdlet gets the status of the most recent synchronization between the configuration database and the Git repository. - -## EXAMPLES - -### Example 1: Get the status of the most recent synchronization -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementTenantSyncState -Context $apimContext -``` - -This command gets the status of the most recent synchronization between the configuration database and the Git repository. - -## PARAMETERS - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementTenantConfigurationSyncState - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementUser.md b/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementUser.md deleted file mode 100644 index e33236544e..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementUser.md +++ /dev/null @@ -1,244 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 638B2BF6-23F8-4038-B20B-1CFABFDBF5D3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementuser -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementUser.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementUser.md ---- - -# Get-AzureRmApiManagementUser - -## SYNOPSIS -Gets a user or users. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GeAllUsers (Default) -``` -Get-AzureRmApiManagementUser -Context [-DefaultProfile ] - [] -``` - -### GetByUserId -``` -Get-AzureRmApiManagementUser -Context [-UserId ] - [-DefaultProfile ] [] -``` - -### GetByUser -``` -Get-AzureRmApiManagementUser -Context [-FirstName ] [-LastName ] - [-State ] [-Email ] [-GroupId ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmApiManagementUser** cmdlet gets a specified user, or all users, if no user is specified. - -## EXAMPLES - -### Example 1: Get all users -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementUser -Context $apimContext -``` - -This command gets all users. - -### Example 2: Get a user by ID -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementUser -Context $apimContext -UserId "0123456789" -``` - -This command gets a user by ID. - -### Example: Get users by last name -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementUser -Context $apimContext -LastName "Fuller" -``` - -This command gets users that have a specified last name, Fuller. - -### Example 4: Get a user by email address -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementUser -Context $apimContext -Email "user@contoso.com" -``` - -This command gets the user that has the specified email address. - -### Example 5: Get all users within a group -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementUser -Context $apimContext -GroupId "0001" -``` - -This command gets all users within the specified group. - -## PARAMETERS - -### -Context -Specifies an instance of **PsApiManagementContext**. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Email -Specifies the email address of the user. -If this parameter is specified, this cmdlet finds a user by email. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: GetByUser -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FirstName -Specifies the first name of the user. -If this parameter is specified, this cmdlet finds a user by first name. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: GetByUser -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GroupId -Specifies the group identifier. -If specified, this cmdlet finds all users within the specified group. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: GetByUser -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LastName -Specifies the last name of a user. -If specified, this cmdlet finds users by last name. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: GetByUser -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -Specifies the user state. -If specified, this cmdlet finds users in this state. -This parameter is optional. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementUserState] -Parameter Sets: GetByUser -Aliases: -Accepted values: Active, Blocked, Deleted, Pending - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserId -Specifies a user ID. -If specified, this cmdlet finds the user by this identifier. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: GetByUserId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Nullable`1[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementUserState, Microsoft.Azure.Commands.ApiManagement.ServiceManagement, Version=6.1.0.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementUser - -## NOTES - -## RELATED LINKS - -[New-AzureRmApiManagementUser](./New-AzureRmApiManagementUser.md) - -[Remove-AzureRmApiManagementUser](./Remove-AzureRmApiManagementUser.md) - -[Set-AzureRmApiManagementUser](./Set-AzureRmApiManagementUser.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementUserSsoUrl.md b/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementUserSsoUrl.md deleted file mode 100644 index dbc24a4cb3..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Get-AzureRmApiManagementUserSsoUrl.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 27FF1B7D-E103-4504-AD09-8D3A8BCA8B75 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementuserssourl -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementUserSsoUrl.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementUserSsoUrl.md ---- - -# Get-AzureRmApiManagementUserSsoUrl - -## SYNOPSIS -Generates an SSO URL for a user. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApiManagementUserSsoUrl -Context -UserId - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmApiManagementUserSsoUrl** cmdlet generates a single sign-on (SSO) URL for a user. - -## EXAMPLES - -### Example 1: Get a user's SSO URL -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Get-AzureRmApiManagementUserSsoUrl -Context $apimContext -UserId "0123456789" -``` - -This command gets a user's SSO URL. - -## PARAMETERS - -### -Context -Specifies a **PsApiManagementContext** object. -This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserId -Specifies a user ID. -This parameter is required. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementUser](./Get-AzureRmApiManagementUser.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Import-AzureRmApiManagementApi.md b/azurermps-6.13.0/AzureRM.ApiManagement/Import-AzureRmApiManagementApi.md deleted file mode 100644 index 93a51ace42..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Import-AzureRmApiManagementApi.md +++ /dev/null @@ -1,270 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 48C143BE-3BF6-43E3-99B0-1A1D12A0A3F3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/import-azurermapimanagementapi -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Import-AzureRmApiManagementApi.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Import-AzureRmApiManagementApi.md ---- - -# Import-AzureRmApiManagementApi - -## SYNOPSIS -Imports an API from a file or a URL. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ImportFromLocalFile (Default) -``` -Import-AzureRmApiManagementApi -Context [-ApiId ] [-ApiRevision ] - -SpecificationFormat -SpecificationPath [-Path ] - [-WsdlServiceName ] [-WsdlEndpointName ] [-ApiType ] - [-DefaultProfile ] [] -``` - -### ImportFromUrl -``` -Import-AzureRmApiManagementApi -Context [-ApiId ] [-ApiRevision ] - -SpecificationFormat -SpecificationUrl [-Path ] - [-WsdlServiceName ] [-WsdlEndpointName ] [-ApiType ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Import-AzureRmApiManagementApi** cmdlet imports an Azure API Management API from a file or a URL in Web Application Description Language (WADL), Web Services Description Language (WSDL), or Swagger format. - -## EXAMPLES - -### Example 1 Import an API from a WADL file -```powershell -PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Import-AzureRmApiManagementApi -Context $ApiMgmtContext -SpecificationFormat "Wadl" -SpecificationPath "C:\contoso\specifications\echoapi.wadl" -Path "apis" -``` - -This command imports an API from the specified WADL file. - -### Example 2 Import an API from a Swagger file -```powershell -PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Import-AzureRmApiManagementApi -Context $ApiMgmtContext -SpecificationFormat "Swagger" -SpecificationPath "C:\contoso\specifications\echoapi.swagger" -Path "apis" -``` - -This command imports an API from the specified Swagger file. - -### Example 3: Import an API from a WADL link -```powershell -PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Import-AzureRmApiManagementApi -Context $ApiMgmtContext -SpecificationFormat "Wadl" -SpecificationUrl "http://contoso.com/specifications/wadl/echoapi" -Path "apis" -``` - -This command imports an API from the specified WADL link. - -## PARAMETERS - -### -ApiId -Specifies an ID for the API to import. -If you do not specify this parameter, an ID is generated for you. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApiRevision -Identifier of API Revision. This parameter is optional. If not specified, the import will be done onto the currently active revision or a new api. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApiType -This parameter is optional with a default value of Http. The Soap option is only applicable when importing WSDL and will create a SOAP Passthrough API. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiType] -Parameter Sets: (All) -Aliases: -Accepted values: Http, Soap - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies a web API path as the last part of the API's public URL. -This URL is used by API consumers for sending requests to the web service. -Must be 1 to 400 characters long. -The default value is $Null. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SpecificationFormat -Specifies the specification format. -psdx_paramvalues Wadl, Wsdl, and Swagger. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiFormat -Parameter Sets: (All) -Aliases: -Accepted values: Wadl, Swagger, Wsdl - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SpecificationPath -Specifies the specification file path. - -```yaml -Type: System.String -Parameter Sets: ImportFromLocalFile -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SpecificationUrl -Specifies the specification URL. - -```yaml -Type: System.String -Parameter Sets: ImportFromUrl -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WsdlEndpointName -Local name of WSDL Endpoint (port) to be imported. Must be 1 to 400 characters long. This parameter is optional and only required for importing Wsdl. Default value is $null. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WsdlServiceName -Local name of WSDL Service to be imported. Must be 1 to 400 characters long. This parameter is optional and only required for importing Wsdl . Default value is $null. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiFormat - -### System.Nullable`1[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiType, Microsoft.Azure.Commands.ApiManagement.ServiceManagement, Version=6.1.0.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi - -## NOTES - -## RELATED LINKS - -[Export-AzureRmApiManagementApi](./Export-AzureRmApiManagementApi.md) - -[Get-AzureRmApiManagementApi](./Get-AzureRmApiManagementApi.md) - -[New-AzureRmApiManagementApi](./New-AzureRmApiManagementApi.md) - -[Remove-AzureRmApiManagementApi](./Remove-AzureRmApiManagementApi.md) - -[Set-AzureRmApiManagementApi](./Set-AzureRmApiManagementApi.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Import-AzureRmApiManagementHostnameCertificate.md b/azurermps-6.13.0/AzureRM.ApiManagement/Import-AzureRmApiManagementHostnameCertificate.md deleted file mode 100644 index 38f4347c2d..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Import-AzureRmApiManagementHostnameCertificate.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 98367100-4FFD-46F6-8974-603B32533626 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/import-azurermapimanagementhostnamecertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Import-AzureRmApiManagementHostnameCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Import-AzureRmApiManagementHostnameCertificate.md ---- - -# Import-AzureRmApiManagementHostnameCertificate - -## SYNOPSIS -Imports a certificate in a PFX format for an API Management Service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Import-AzureRmApiManagementHostnameCertificate -ResourceGroupName -Name - -HostnameType -PfxPath -PfxPassword [-PassThru] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Import-AzureRmApiManagementHostnameCertificate** cmdlet imports a certificate in a PFX format for an API Management Service. -The certificate is to be used for custom hostnames configuration. - -## EXAMPLES - -### Example 1: Import a API Management hostname certificate -```powershell -PS C:\>Import-AzureRmApiManagementHostnameCertificate -Name "ContosoApi" -ResourceGroupName Contoso -HostnameType "Proxy" -PfxPath "C:\proxycert.pfx" -PfxPassword "CertSecret" -``` - -This command imports a certificate for a proxy custom hostname. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostnameType -Specifies the host name type that this cmdlet loads the certificate for. -Valid values are: -- Proxy -- Portal - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementHostnameType -Parameter Sets: (All) -Aliases: -Accepted values: Proxy, Portal, Management, Scm - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the API Management deployment that this cmdlet imports. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PfxPassword -Specifies the password for the .pfx certificate file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PfxPath -Specifies the path to a .pfx certificate file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the of resource group under which the API Management deployment exists. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementHostnameType - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementHostnameCertificate - -## NOTES - -## RELATED LINKS - -[New-AzureRmApiManagementHostnameConfiguration](./New-AzureRmApiManagementHostnameConfiguration.md) - -[Set-AzureRmApiManagementHostnames](./Set-AzureRmApiManagementHostnames.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagement.md b/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagement.md deleted file mode 100644 index 3a61bfe12d..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagement.md +++ /dev/null @@ -1,347 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 164C5205-01BA-47BB-B780-D0B9AE614A4B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagement -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagement.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagement.md ---- - -# New-AzureRmApiManagement - -## SYNOPSIS -Creates an API Management deployment. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApiManagement -ResourceGroupName -Name -Location -Organization - -AdminEmail [-Sku ] [-Capacity ] [-VpnType ] - [-VirtualNetwork ] - [-Tag ] - [-AdditionalRegions ] - [-CustomHostnameConfiguration ] - [-SystemCertificateConfiguration ] [-AssignIdentity] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureRmApiManagement** cmdlet creates an API Management deployment in Azure API Management. - -## EXAMPLES - -### Example 1: Create a Developer tier API Management service -```powershell -PS C:\>New-AzureRmApiManagement -ResourceGroupName "ContosoGroup02" -Name "ContosoApi" -Location "Central US" -Organization "Contoso" -AdminEmail "admin@contoso.com" -``` - -This command creates a Developer tier API Management service. -The command specifies the organization and the administrator address. -The command does not specify the *SKU* parameter. -Therefore, the cmdlet uses the default value of Developer. - -### Example 2: Create a Standard tier service that has three units -```powershell -PS C:\>New-AzureRmApiManagement -ResourceGroupName "ContosoGroup02 -Name "ContosoApi" -Location "Central US" -Organization "Contoso" -AdminEmail "admin@contoso.com" -Sku Standard -Capacity 3 -``` - -This command creates a Standard tier API Management service that has three units. - -### Example 3: Create an API Management service for an external virtual network -```powershell -PS C:\> $virtualNetwork = New-AzureRmApiManagementVirtualNetwork -Location "West US" -SubnetResourceId "/subscriptions/a8ff56dc-3bc7-4174-b1e8-3726ab15d0e2/resourceGroups/ContosoGroup/providers/Microsoft.Network/virtualNetworks/westUsVirtualNetwork/subnets/backendSubnet" -PS C:\> New-AzureRmApiManagement -ResourceGroupName "ContosoGroup" -Location "West US" -Name "ContosoApi" -Organization Contoso -AdminEmail admin@contoso.com -VirtualNetwork $virtualNetwork -VpnType "External" -Sku "Premium" -``` - -This command creates a Premium-tier API Management service in an Azure virtual network subnet having an external-facing gateway endpoint with a master region in the West US. - -### Example 4: Create an API Management service for an internal virtual network -```powershell -PS C:\> $virtualNetwork = New-AzureRmApiManagementVirtualNetwork -Location "West US" -SubnetResourceId "/subscriptions/a8ff56dc-3bc7-4174-b1e8-3726ab15d0e2/resourceGroups/ContosoGroup/providers/Microsoft.Network/virtualNetworks/westUsVirtualNetwork/subnets/backendSubnet" -PS C:\> New-AzureRmApiManagement -ResourceGroupName "ContosoGroup" -Location "West US" -Name "ContosoApi" -Organization "Contoso" -AdminEmail "admin@contoso.com" -VirtualNetwork $virtualNetwork -VpnType "Internal" -Sku "Premium" -``` - -This command creates a Premium-tier API Management service in an Azure virtual network subnet having an internal-facing gateway endpoint with a master region in the West US. - -## PARAMETERS - -### -AdditionalRegions -Additional deployment regions of Azure API Management. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementRegion[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AdminEmail -Specifies the originating email address for all notifications that the API Management system sends. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AssignIdentity -Generate and assign a Microsoft Entra identity for this server for use with key management services like Azure KeyVault. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Capacity -Specifies the SKU capacity of the Azure API Management service. -The default is one (1). - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CustomHostnameConfiguration -Custom hostname configurations. Default value is $null. Passing $null will set the default hostname. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementCustomHostNameConfiguration[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location to create the Api Management service. -To obtain valid locations, use the cmdlet -Get-AzureRmResourceProvider -ProviderNamespace "Microsoft.ApiManagement" | where {$_.ResourceTypes[0].ResourceTypeName -eq "service"} | Select-Object Locations - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the API Management deployment. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Organization -Specifies the name of an organization. -API Management uses this address in the developer portal in email notifications. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the of resource group under which this cmdlet creates an API Management deployment. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -Specifies the tier of the API Management service. -Valid values are: -- Developer -- Standard -- Premium -The default is Developer. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSku] -Parameter Sets: (All) -Aliases: -Accepted values: Developer, Basic, Standard, Premium - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SystemCertificateConfiguration -Certificates issued by Internal CA to be installed on the service. Default value is $null. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSystemCertificate[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Tags dictionary. - -```yaml -Type: System.Collections.Generic.Dictionary`2[System.String,System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetwork -Virtual Network Configuration of master Azure API Management deployment region. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementVirtualNetwork -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VpnType -Virtual Network Type of the ApiManagement Deployment. Valid Values are -- "None" (Default Value. ApiManagement is not part of any Virtual Network") -- "External" (ApiManagement Deployment is setup inside a Virtual Network having an Internet Facing Endpoint) -- "Internal" (ApiManagement Deployment is setup inside a Virtual Network having an Intranet Facing Endpoint) - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementVpnType -Parameter Sets: (All) -Aliases: -Accepted values: None, External, Internal - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSku, Microsoft.Azure.Commands.ApiManagement, Version=6.1.2.0, Culture=neutral, PublicKeyToken=null]] - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementVirtualNetwork - -### System.Collections.Generic.Dictionary`2[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089],[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementRegion[] - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementCustomHostNameConfiguration[] - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSystemCertificate[] - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement - -## NOTES - -## RELATED LINKS - -[Backup-AzureRmApiManagement](./Backup-AzureRmApiManagement.md) - -[Get-AzureRmApiManagement](./Get-AzureRmApiManagement.md) - -[Set-AzureRmApiManagement](./Set-AzureRmApiManagement.md) - -[Remove-AzureRmApiManagement](./Remove-AzureRmApiManagement.md) - -[Restore-AzureRmApiManagement](./Restore-AzureRmApiManagement.md) diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementApi.md b/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementApi.md deleted file mode 100644 index 6b01128de3..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementApi.md +++ /dev/null @@ -1,284 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 664CF009-FC52-4F1B-933B-3DEBD05AC8C5 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementapi -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementApi.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementApi.md ---- - -# New-AzureRmApiManagementApi - -## SYNOPSIS -Creates an API. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApiManagementApi -Context [-ApiId ] -Name - [-Description ] -ServiceUrl -Path -Protocols - [-AuthorizationServerId ] [-AuthorizationScope ] [-SubscriptionKeyHeaderName ] - [-SubscriptionKeyQueryParamName ] [-ProductIds ] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **New-AzureRmApiManagementApi** cmdlet creates an Azure API Management API. - -## EXAMPLES - -### Example 1: Create an API -```powershell -PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>New-AzureRmApiManagementApi -Context $ApiMgmtContext -Name "Echo api" -ServiceUrl "https://contoso.com/apis/echo" -Protocols @("http", "https") -Path "testapi" -``` - -This command creates an API named EchoApi with the specified URL. - -## PARAMETERS - -### -ApiId -Specifies the ID of the API to create. -If you do not specify this parameter, this cmdlet generates an ID for you. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AuthorizationScope -Specifies the OAuth operations scope. -The default value is $Null. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AuthorizationServerId -Specifies the OAuth authorization server ID. -The default value is $Null. -You must specify this parameter if *AuthorizationScope* is specified. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the web API. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the web API. -This is the public name of the API as it appears on the developer and admin portals. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the web API path, which is the last part of the API's public URL and corresponds to the Web API URL suffix field in the admin portal. -This URL is used by API consumers to send requests to the web service, and must be one to 400 characters long. -The default value is $Null. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProductIds -Specifies an array of product IDs to which to add the new API. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Protocols -Specifies an array of web API protocols. -Valid values are http, https. -These are the web protocols over which the API is made available. -The default value is $Null. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSchema[] -Parameter Sets: (All) -Aliases: -Accepted values: Http, Https - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceUrl -Specifies the URL of the web service that exposes the API. -This URL is used only by Azure API Management, and is not made public. -The URL must be one to 2000 characters long. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubscriptionKeyHeaderName -Specifies the subscription key header name. -The default value is $Null. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubscriptionKeyQueryParamName -Specifies the subscription key query string parameter name. -The default value is $Null. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSchema[] - -### System.String[] - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi - -## NOTES - -## RELATED LINKS - -[Export-AzureRmApiManagementApi](./Export-AzureRmApiManagementApi.md) - -[Get-AzureRmApiManagementApi](./Get-AzureRmApiManagementApi.md) - -[Import-AzureRmApiManagementApi](./Import-AzureRmApiManagementApi.md) - -[Remove-AzureRmApiManagementApi](./Remove-AzureRmApiManagementApi.md) - -[Set-AzureRmApiManagementApi](./Set-AzureRmApiManagementApi.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementApiRelease.md b/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementApiRelease.md deleted file mode 100644 index a749bf5744..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementApiRelease.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementapirelease -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementApiRelease.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementApiRelease.md ---- - -# New-AzureRmApiManagementApiRelease - -## SYNOPSIS -Creates an API Release of an API Revision - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApiManagementApiRelease -Context -ApiId -ApiRevision - [-ReleaseId ] [-Note ] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION - -The **New-AzureRmApiManagementApiRelease** cmdlet creates an API Release for an API Revision in API Management context. - -## EXAMPLES - -### Example 1: Create an API Release for an API Revision -```powershell -PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>New-AzureRmApiManagementApiRelease -Context $context -ApiId 5adf6fbf0faadf3ad8558065 -ApiRevision 6 -Note "Releasing version 6" - - -ReleaseId : 7e4d3fbb43c146c4bf406499ef9411f4 -ApiId : 5adf6fbf0faadf3ad8558065 -CreatedDateTime : 5/17/2018 1:16:29 AM -UpdatedDateTime : 5/17/2018 1:16:29 AM -Notes : Releasing version 6 -Id : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Mi - crosoft.ApiManagement/service/contoso/apis/5adf6fbf0faadf3ad8558065/releases/7e4d3fbb43c146c4bf40649 - 9ef9411f4 -ResourceGroupName : Api-Default-WestUS -ServiceName : contoso -``` - -This command creates an API Release of Revision `2` of the `echo-api`. - -## PARAMETERS - -### -ApiId -Identifier for new API. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApiRevision -Identifier for the Api Revision. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Instance of PsApiManagementContext. -This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Note -Api Release Notes. This parameter is optional - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReleaseId -Identifier for the Api Release. -This parameter is optional. -If not specified identifier will be generated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameters: Context (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiRelease - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementApiRelease](./Get-AzureRmApiManagementApiRelease.md) - -[Remove-AzureRmApiManagementApiRelease](./Remove-AzureRmApiManagementApiRelease.md) - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementApiRevision.md b/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementApiRevision.md deleted file mode 100644 index 34d8e7d678..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementApiRevision.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementapirevision -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementApiRevision.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementApiRevision.md ---- - -# New-AzureRmApiManagementApiRevision - -## SYNOPSIS -Creates a new Revision of an Existing API. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApiManagementApiRevision -Context -ApiId -ApiRevision - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -The **New-AzureRmApiManagementApiRevision** cmdlet creates an API Revision for an existing an API in API Management context. - -## EXAMPLES - -### Example 1: Create an API Revision for an API -```powershell -PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>New-AzureRmApiManagementApiRevision -Context $ApiMgmtContext -ApiId 5adf6fbf0faadf3ad8558065 -ApiRevision 6 - - -ApiId : 5adf6fbf0faadf3ad8558065;rev=6 -Name : httpbin.org -Description : API Management facade for a very handy and free online HTTP tool. -ServiceUrl : https://httpbin.org/ -Path : httpbin -ApiType : http -Protocols : {Http, Https} -AuthorizationServerId : contoso-oauth -AuthorizationScope : contoso-oauth -SubscriptionKeyHeaderName : Ocp-Apim-Subscription-Key -SubscriptionKeyQueryParamName : subscription-key -ApiRevision : 6 -ApiVersion : v1 -IsCurrent : False -IsOnline : False -Id : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Microsoft.ApiManagement/service/contoso/apis/5adf6fbf0faadf3ad8558065;rev=6 -ResourceGroupName : Api-Default-WestUS -ServiceName : contoso -``` - -This command creates an API Revision `2` of the `echo-api` API. - -## PARAMETERS - -### -ApiId -Identifier for API whose Revision is to be created. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApiRevision -Revision Identifier of the Api. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Instance of PsApiManagementContext. -This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameters: Context (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementApi](./Get-AzureRmApiManagementApi.md) - -[Remove-AzureRmApiManagementApi](./Remove-AzureRmApiManagementApi.md) - -[Set-AzureRmApiManagementApi](./Set-AzureRmApiManagementApi.md) diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementApiVersionSet.md b/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementApiVersionSet.md deleted file mode 100644 index 067a250ad7..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementApiVersionSet.md +++ /dev/null @@ -1,232 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementapiversionset -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementApiVersionSet.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementApiVersionSet.md ---- - -# New-AzureRmApiManagementApiVersionSet - -## SYNOPSIS -Creates an API Version Set. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApiManagementApiVersionSet -Context [-ApiVersionSetId ] - -Name -Scheme [-HeaderName ] [-QueryName ] - [-Description ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **New-AzureRmApiManagementApiVersionSet** cmdlet creates an API Version set entity in the Azure API Management context. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\> New-AzureRmApiManagementApiVersionSet -Context $ApiMgmtContext -Name "newversion" -Scheme Header -HeaderName "x-ms-version" -Description "version by xmsversion" - -ApiVersionSetId : ea9a87cd-a699-4a75-bf7d-909846b91268 -Description : version by xmsversion -VersionQueryName : -VersionHeaderName : x-ms-version -DisplayName : newversion -VersioningScheme : Header -Id : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Microsoft.ApiManagement/service/contoso/api-version-sets/ea9a87cd-a699-4a75-bf7d-909846b91268 -ResourceGroupName : Api-Default-WestUS -ServiceName : contoso -``` - -This command creates an API Version Set which versioning scheme `Query` and Query parameter `api-version`. - -## PARAMETERS - -### -ApiVersionSetId -Identifier for new API Version Set. -This parameter is optional. -If not specified an identifier will be generated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Instance of PsApiManagementContext. -This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Description of the Api Version set. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HeaderName -The Header value which will contain the versioning information. -If versioning Scheme HEADER is choosen, then this value must be specified. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The name of the ApiVersion Set. -This parameter is required. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -QueryName -The Query value which will contain the versioning information. -If versioning Scheme Query is choosen, then this value must be specified. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Scheme -Versioning Scheme to select for the Api Versioning Set. -This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementVersioningScheme -Parameter Sets: (All) -Aliases: -Accepted values: Segment, Query, Header - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameters: Context (ByValue) - -### System.String - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementVersioningScheme - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiVersionSet - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementApiVersionSet](./Get-AzureRmApiManagementApiVersionSet.md) - -[Remove-AzureRmApiManagementApiVersionSet](./Remove-AzureRmApiManagementApiVersionSet.md) - -[Set-AzureRmApiManagementApiVersionSet](./Set-AzureRmApiManagementApiVersionSet.md) diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementAuthorizationServer.md b/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementAuthorizationServer.md deleted file mode 100644 index cc01c2e719..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementAuthorizationServer.md +++ /dev/null @@ -1,374 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 45B96AB0-ACE3-4754-B162-88027AC8CA41 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementauthorizationserver -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementAuthorizationServer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementAuthorizationServer.md ---- - -# New-AzureRmApiManagementAuthorizationServer - -## SYNOPSIS -Creates an authorization server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApiManagementAuthorizationServer -Context [-ServerId ] - -Name [-Description ] -ClientRegistrationPageUrl -AuthorizationEndpointUrl - -TokenEndpointUrl -ClientId [-ClientSecret ] - [-AuthorizationRequestMethods ] - -GrantTypes - -ClientAuthenticationMethods [-TokenBodyParameters ] - [-SupportState ] [-DefaultScope ] - -AccessTokenSendingMethods [-ResourceOwnerUsername ] - [-ResourceOwnerPassword ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureRmApiManagementAuthorizationServer** cmdlet creates an Azure API Management authorization server. - -## EXAMPLES - -### Example 1: Create an authorization server -```powershell -PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>New-AzureRmApiManagementAuthrizarionServer -Context $ApiMgmtContext -Name "Contoso OAuth2 server" -ClientRegistrationPageUrl "https://contoso/signup" -AuthorizationEndpointUrl "https://contoso/auth" -TokenEndpointUrl "https://contoso/token" -ClientId "clientid" -ClientSecret "e041ed1b660b4eadbad5a29d066e6e88" -AuthorizationRequestMethods @('Get', 'Post') -GrantTypes @( 'AuthorizationCode', 'Implicit', 'ResourceOwnerPassword', 'ClientCredentials') -ClientAuthenticationMethods @('Basic') -TokenBodyParameters @{'par1'='val1'; 'par2'='val2'} -AccessTokenSendingMethods @('AuthorizationHeader', 'Query') -ResourceOwnerUsername "ivan" -ResourceOwnerPassword "qwerty" -``` - -This command creates an authorization server. - -## PARAMETERS - -### -AccessTokenSendingMethods -Specifies an array of methods to send an access token. -psdx_paramvalues AuthorizationHeader and Query. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementAccessTokenSendingMethod[] -Parameter Sets: (All) -Aliases: -Accepted values: AuthorizationHeader, Query - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AuthorizationEndpointUrl -Specifies the authorization endpoint to authenticate resource owners and obtain authorization grants. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AuthorizationRequestMethods -Specifies an array of authorization request methods. -Valid values are: GET, POST. -The default value is GET. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementAuthorizationRequestMethod[] -Parameter Sets: (All) -Aliases: -Accepted values: Get, Post, Head, Options, Trace, Put, Patch, Delete - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ClientAuthenticationMethods -Specifies an array of client authentication methods. -psdx_paramvalues Basic and Body. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementClientAuthenticationMethod[] -Parameter Sets: (All) -Aliases: -Accepted values: Basic, Body - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ClientId -Specifies the client ID of the developer console that is the client application. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ClientRegistrationPageUrl -Specifies the client registration endpoint to register clients with the authorization server and obtain client credentials. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ClientSecret -Specifies the client secret of developer console that is the client application. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultScope -Specifies the default scope for the authorization server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Description -Specifies a description for an authorization server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GrantTypes -Specifies an array of grant types. -psdx_paramvalues -- AuthorizationCode -- ClientCredentials -- Implicit -- ResourceOwnerPassword - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGrantType[] -Parameter Sets: (All) -Aliases: -Accepted values: AuthorizationCode, Implicit, ResourceOwnerPassword, ClientCredentials - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the authorization server to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceOwnerPassword -Specifies the resource owner password. -You must specify this parameter is required if ResourceOwnerPassword is specified by the *GrantTypes* parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceOwnerUsername -Specifies the resource owner user name. -You must specify this parameter if ResourceOwnerPassword is specified by the *GrantTypes* parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerId -Specifies the ID of the authorization server to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SupportState -Indicates whether to support the *State* parameter. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TokenBodyParameters -Specifies additional body parameters using **application/x-www-form-urlencoded** format. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TokenEndpointUrl -Specifies the token endpoint URL that is used by clients to obtain access tokens in exchange for presenting authorization grants or refresh tokens. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementAuthorizationRequestMethod[] - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGrantType[] - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementClientAuthenticationMethod[] - -### System.Collections.Hashtable - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementAccessTokenSendingMethod[] - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOAuth2AuthrozationServer - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementBackend.md b/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementBackend.md deleted file mode 100644 index c1aa5951d6..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementBackend.md +++ /dev/null @@ -1,319 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementbackend -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementBackend.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementBackend.md ---- - -# New-AzureRmApiManagementBackend - -## SYNOPSIS -Creates a new backend entity. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApiManagementBackend -Context [-BackendId ] -Protocol - -Url [-ResourceId ] [-Title ] [-Description ] - [-SkipCertificateChainValidation ] [-SkipCertificateNameValidation ] - [-Credential ] [-Proxy ] - [-ServiceFabricCluster ] [-DefaultProfile ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -Creates a new backend entity in Api Management. - -## EXAMPLES - -### Create Backend 123 with a Basic Authorization Scheme -```powershell -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>$credential = New-AzureRmApiManagementBackendCredential -AuthorizationHeaderScheme basic -AuthorizationHeaderParameter opensesame -Query @{"sv" = @('xx', 'bb'); "sr" = @('cc')} -Header @{"x-my-1" = @('val1', 'val2')} - -PS C:\>$backend = New-AzureRmApiManagementBackend -Context $apimContext -BackendId 123 -Url 'https://contoso.com/awesomeapi' -Protocol http -Title "first backend" -SkipCertificateChainValidation $true -Credential $credential -Description "my backend" -``` - -Creates a new Backend - -## PARAMETERS - -### -BackendId -Identifier of new backend. -This parameter is optional. -If not specified will be generated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Instance of PsApiManagementContext. -This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Credential -Credential details which should be used when talking to the Backend. -This parameter is optional. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackendCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Backend Description. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Protocol -Backend Communication protocol. -This parameter is required. -Valid values are 'http' and 'soap'. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: http, soap - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Proxy -Proxy Server details to be used while sending request to the Backend. -This parameter is optional. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackendProxy -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Management Uri of the Resource in External System. -This parameter is optional. -This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceFabricCluster -Service Fabric Cluster Backend details. This parameter is optional. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementServiceFabric -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkipCertificateChainValidation -Whether to Skip Certificate Chain Validation when talking to the Backend. -This parameter is optional. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkipCertificateNameValidation -Whether to skip Certificate Name Validation when talking to the Backend. -This parameter is optional. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Title -Backend Title. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Url -Runtime Url for the Backend. -This parameter is required. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackendCredential - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackendProxy - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementServiceFabric - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackend - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementBackend](./Get-AzureRmApiManagementBackend.md) - -[New-AzureRmApiManagementBackendCredential](./New-AzureRmApiManagementBackendCredential.md) - -[New-AzureRmApiManagementBackendProxy](./New-AzureRmApiManagementBackendProxy.md) - -[Set-AzureRmApiManagementBackend](./Set-AzureRmApiManagementBackend.md) - -[Remove-AzureRmApiManagementBackend](./Remove-AzureRmApiManagementBackend.md) - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementBackendCredential.md b/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementBackendCredential.md deleted file mode 100644 index 75c5369f0a..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementBackendCredential.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementbackendcredential -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementBackendCredential.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementBackendCredential.md ---- - -# New-AzureRmApiManagementBackendCredential - -## SYNOPSIS -Creates a new Backend Credential contract. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApiManagementBackendCredential [-CertificateThumbprint ] [-Query ] - [-Header ] [-AuthorizationHeaderScheme ] [-AuthorizationHeaderParameter ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -Creates a new Backend Credential contract. - -## EXAMPLES - -### Create a Backend Credentials In-Memory Object -```powershell -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>$credential = New-AzureRmApiManagementBackendCredential -AuthorizationHeaderScheme basic -AuthorizationHeaderParameter opensesame -Query @{"sv" = @('xx', 'bb'); "sr" = @('cc')} -Header @{"x-my-1" = @('val1', 'val2')} - -PS C:\>$backend = New-AzureRmApiManagementBackend -Context $apimContext -BackendId 123 -Url 'https://contoso.com/awesomeapi' -Protocol http -Title "first backend" -SkipCertificateChainValidation $true -Credential $credential -Description "my backend" -``` - -Creates a Backend Credentials Contract - -## PARAMETERS - -### -AuthorizationHeaderParameter -Authorization Header used for the Backend. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthorizationHeaderScheme -Authorization Scheme used for the Backend. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CertificateThumbprint -Client Certificate Thumbprints. -This parameter is optional. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Header -Header Parameter Values accepted by Backend. -This parameter is optional. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Query -Query Parameter Values accepted by Backend. -This parameter is optional. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackendCredential - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementBackend](./Get-AzureRmApiManagementBackend.md) - -[New-AzureRmApiManagementBackend](./New-AzureRmApiManagementBackend.md) - -[New-AzureRmApiManagementBackendProxy](./New-AzureRmApiManagementBackendProxy.md) - -[Set-AzureRmApiManagementBackend](./Set-AzureRmApiManagementBackend.md) - -[Remove-AzureRmApiManagementBackend](./Remove-AzureRmApiManagementBackend.md) diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementBackendProxy.md b/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementBackendProxy.md deleted file mode 100644 index 83874e1619..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementBackendProxy.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementbackendproxy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementBackendProxy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementBackendProxy.md ---- - -# New-AzureRmApiManagementBackendProxy - -## SYNOPSIS -Creates a new Backend Proxy Object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApiManagementBackendProxy -Url [-ProxyCredential ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -Creates a new Backend Proxy Object which can be piped when creating a new Backend entity. - -## EXAMPLES - -### Create a Backend Proxy In-Memory Object -```powershell -PS C:\>$secpassword = ConvertTo-SecureString "PlainTextPassword" -AsPlainText -Force -PS C:\>$proxyCreds = New-Object System.Management.Automation.PSCredential ("foo", $secpassword) -PS C:\>$credential = New-AzureRmApiManagementBackendProxy -Url "http://12.168.1.1:8080" -ProxyCredential $proxyCreds - -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" - -PS C:\>$backend = New-AzureRmApiManagementBackend -Context $apimContext -BackendId 123 -Url 'https://contoso.com/awesomeapi' -Protocol http -Title "first backend" -SkipCertificateChainValidation $true -Proxy $credential -Description "backend with proxy server" -``` - -Creates a Backend Proxy Object and sets up Backend - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials used to connect to Backend Proxy. This parameter is optional. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Url -Url of the Proxy server to be used when forwarding calls to Backend. -This parameter is required. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackendProxy - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementBackend](./Get-AzureRmApiManagementBackend.md) - -[New-AzureRmApiManagementBackend](./New-AzureRmApiManagementBackend.md) - -[New-AzureRmApiManagementBackendCredential](./New-AzureRmApiManagementBackendCredential.md) - -[Set-AzureRmApiManagementBackend](./Set-AzureRmApiManagementBackend.md) - -[Remove-AzureRmApiManagementBackend](./Remove-AzureRmApiManagementBackend.md) diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementBackendServiceFabric.md b/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementBackendServiceFabric.md deleted file mode 100644 index 3792d5afbe..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementBackendServiceFabric.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementbackendservicefabric -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementBackendServiceFabric.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementBackendServiceFabric.md ---- - -# New-AzureRmApiManagementBackendServiceFabric - -## SYNOPSIS -Creates an object of `PsApiManagementServiceFabric` - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApiManagementBackendServiceFabric -ManagementEndpoint - -ClientCertificateThumbprint [-MaxPartitionResolutionRetry ] [-ServerX509Name ] - [-ServerCertificateThumbprint ] [-DefaultProfile ] [] -``` - -## DESCRIPTION - -The **New-AzureRmApiManagementBackendServiceFabric** cmdlet creates an object of `PsApiManagementServiceFabric` to be used in cmdlet -**New-AzureRmApiManagementBackend** and **Set-AzureRmApiManagementBackend**. - -## EXAMPLES - -### Example 1: Create a Backend Service Fabric In-Memory Object -```powershell -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>$ManagementEndpoints = 'https://sfbackend-01.net:443', 'https://sfbackend-02.net:443' -PS C:\>$ServerCertificateThumbprints = '33CC47C6FCA848DC9B14A6F071C1EF7C' -PS C:\>$serviceFabric = New-AzureRmApiManagementBackendServiceFabric -ManagementEndpoint $ManagementEndpoints -ClientCertificateThumbprint "33CC47C6FCA848DC9B14A6F071C1EF7C" -ServerX509Name @{"CN=foobar.net" = @('33CC47C6FCA848DC9B14A6F071C1EF7C'); } -ServerCertificateThumbprint $ServerCertificateThumbprints - -PS C:\>$backend = New-AzureRmApiManagementBackend -Context $apimContext -BackendId 123 -Url 'https://contoso.com/awesomeapi' -Protocol http -ServiceFabricCluster $serviceFabric -Description "service fabric backend" -PassThru -``` - -Creates a Backend Service Fabric Contract - -## PARAMETERS - -### -ClientCertificateThumbprint -Client Certificate Thumbprint for the management endpoint. -This parameter is required. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagementEndpoint -Service Fabric Cluster management Endpoints. -This parameter is required. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxPartitionResolutionRetry -Maximum number of retries when resolving a Service Fabric partition. -This parameter is optional and default value is 5. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerCertificateThumbprint -Thumbprint of certificates cluster management service uses for tls communication.This parameter is optional. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerX509Name -Server X509 Certificate Names Collection. -This parameter is optional. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementServiceFabric - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementBackend](./Get-AzureRmApiManagementBackend.md) - -[New-AzureRmApiManagementBackend](./New-AzureRmApiManagementBackend.md) - -[New-AzureRmApiManagementBackendProxy](./New-AzureRmApiManagementBackendProxy.md) - -[Set-AzureRmApiManagementBackend](./Set-AzureRmApiManagementBackend.md) - -[Remove-AzureRmApiManagementBackend](./Remove-AzureRmApiManagementBackend.md) diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementCertificate.md b/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementCertificate.md deleted file mode 100644 index 1643574ba9..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementCertificate.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 5CBEDFF8-C441-44CC-B011-5F5AAFA2E5C6 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementCertificate.md ---- - -# New-AzureRmApiManagementCertificate - -## SYNOPSIS -Creates an API Management certificate to be used during Authentication with Backend. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### LoadFromFile (Default) -``` -New-AzureRmApiManagementCertificate -Context [-CertificateId ] - -PfxFilePath -PfxPassword [-DefaultProfile ] [] -``` - -### Raw -``` -New-AzureRmApiManagementCertificate -Context [-CertificateId ] - -PfxBytes -PfxPassword [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureRmApiManagementCertificate** cmdlet creates an Azure API Management certificate. - -## EXAMPLES - -### Example 1: Create and upload a certificate -``` -PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>New-AzureRmApiManagementCertificate -Context $ApiMgmtContext -PfxFilePath "C:\contoso\certificates\apimanagement.pfx" -PfxPassword "1111" -``` - -This command uploads a certificate to Api Management. This certificate can be used for mutual authentication with backend using policies. - -## PARAMETERS - -### -CertificateId -Specifies the ID of the certificate to create. -If you do not specify this parameter, an ID is generated for you. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PfxBytes -Specifies an array of bytes of the certificate file in .pfx format. -This parameter is required if you do not specify the *PfxFilePath* parameter. - -```yaml -Type: System.Byte[] -Parameter Sets: Raw -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PfxFilePath -Specifies the path to the certificate file in .pfx format to create and upload. -This parameter is required if you do not specify the *PfxBytes* parameter. - -```yaml -Type: System.String -Parameter Sets: LoadFromFile -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PfxPassword -Specifies the password for the certificate. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Byte[] - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementCertificate - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementCertificate](./Get-AzureRmApiManagementCertificate.md) - -[Remove-AzureRmApiManagementCertificate](./Remove-AzureRmApiManagementCertificate.md) - -[Set-AzureRmApiManagementCertificate](./Set-AzureRmApiManagementCertificate.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementContext.md b/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementContext.md deleted file mode 100644 index 03db6c6cbe..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementContext.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 15634C76-6B34-4E2B-9354-86155827F200 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementcontext -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementContext.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementContext.md ---- - -# New-AzureRmApiManagementContext - -## SYNOPSIS -Creates an instance of PsAzureApiManagementContext. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApiManagementContext -ResourceGroupName -ServiceName - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureRmApiManagementContext** cmdlet creates an instance of **PsAzureApiManagementContext**. -The context is used for all of the API Management service cmdlets. - -## EXAMPLES - -### Example 1: Create a PsApiManagementContext instance -``` -PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "ContosoResources" -ServiceName "Contoso" -``` - -This command creates an instance of **PsApiManagementContext**. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group under which an API Management service is deployed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceName -Specifies the name of the deployed API Management service. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementCustomHostnameConfiguration.md b/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementCustomHostnameConfiguration.md deleted file mode 100644 index ce70eefb60..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementCustomHostnameConfiguration.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementcustomhostnameconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementCustomHostnameConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementCustomHostnameConfiguration.md ---- - -# New-AzureRmApiManagementCustomHostnameConfiguration - -## SYNOPSIS -Creates an instance of `PsApiManagementCustomHostNameConfiguration`. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NoChangeCertificate (Default) -``` -New-AzureRmApiManagementCustomHostnameConfiguration -Hostname - -HostnameType - -HostNameCertificateInformation [-DefaultSslBinding] - [-NegotiateClientCertificate] [-DefaultProfile ] [] -``` - -### SslCertificateFromFile -``` -New-AzureRmApiManagementCustomHostnameConfiguration -Hostname - -HostnameType -PfxPath [-PfxPassword ] - [-DefaultSslBinding] [-NegotiateClientCertificate] [-DefaultProfile ] - [] -``` - -### SslCertificateFromKeyVault -``` -New-AzureRmApiManagementCustomHostnameConfiguration -Hostname - -HostnameType -KeyVaultId [-DefaultSslBinding] - [-NegotiateClientCertificate] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureRmApiManagementCustomHostnameConfiguration** cmdlet is a helper command that creates an instance of **PsApiManagementCustomHostNameConfiguration**. -This command is used with the New-AzureRmApiManagement and Set-AzureRmApiManagement cmdlet. - -## EXAMPLES - -### Example 1: Create and initialize an instance of PsApiManagementCustomHostNameConfiguration using an Ssl Certificate from file -```powershell -PS C:\>$portal = New-AzureRmApiManagementCustomHostnameConfiguration -Hostname "portal.contoso.com" -HostnameType Portal -PfxPath "C:\contoso\certificates\apimanagement.pfx" -PfxPassword "1111" -DefaultSslBinding -PS C:\>$customConfig = @($portal) -PS C:\>New-AzureRmApiManagement -ResourceGroupName "ContosoGroup" -Location "West US" -Name "ContosoApi" -Organization Contoso -AdminEmail admin@contoso.com -CustomHostnameConfiguration $customConfig -``` - -This command creates and initializes an instance of **PsApiManagementCustomHostNameConfiguration** for Portal. Then it creates a new ApiManagement service with custom hostname configuration. - -### Example 2: Create and initialize an instance of PsApiManagementCustomHostNameConfiguration using an Secret from KeyVault Resource -```powershell -PS C:\>$portal = New-AzureRmApiManagementCustomHostnameConfiguration -Hostname "portal.contoso.com" -HostnameType Portal -KeyVaultId "https://apim-test-keyvault.vault.azure.net/secrets/api-portal-custom-ssl.pfx" - -PS C:\>$customConfig = @($portal) -PS C:\>New-AzureRmApiManagement -ResourceGroupName "ContosoGroup" -Location "West US" -Name "ContosoApi" -Organization Contoso -AdminEmail admin@contoso.com -CustomHostnameConfiguration $customConfig -AssignIdentity -``` - -This command creates and initializes an instance of **PsApiManagementCustomHostNameConfiguration**. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultSslBinding -Determines whether the value is a secret and should be encrypted or not. -This parameter is optional. -Default Value is false. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Hostname -Custom Hostname - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostNameCertificateInformation -Existing Certificate Configuration. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementCertificateInformation -Parameter Sets: NoChangeCertificate -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HostnameType -Hostname Type - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementHostnameType -Parameter Sets: (All) -Aliases: -Accepted values: Proxy, Portal, Management, Scm - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyVaultId -KeyVaultId to the secret storing the Custom SSL Certificate. - -```yaml -Type: System.String -Parameter Sets: SslCertificateFromKeyVault -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NegotiateClientCertificate -Determines whether the value is a secret and should be encrypted or not. -This parameter is optional. -Default Value is false. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PfxPassword -Password for the .pfx certificate file. - -```yaml -Type: System.Security.SecureString -Parameter Sets: SslCertificateFromFile -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PfxPath -Path to a .pfx certificate file. - -```yaml -Type: System.String -Parameter Sets: SslCertificateFromFile -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementCertificateInformation - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementCustomHostNameConfiguration - -## NOTES - -## RELATED LINKS - -[New-AzureRmApiManagement](./New-AzureRmApiManagement.md) - -[Set-AzureRmApiManagement](./Set-AzureRmApiManagement.md) diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementGroup.md b/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementGroup.md deleted file mode 100644 index f6f97a295e..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementGroup.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: EE2BC1F7-E6F3-477D-8416-8E61893534E2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementgroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementGroup.md ---- - -# New-AzureRmApiManagementGroup - -## SYNOPSIS -Creates an API management group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApiManagementGroup -Context [-GroupId ] -Name - [-Description ] [-Type ] [-ExternalId ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureRmApiManagementGroup** cmdlet creates an API management group. - -## EXAMPLES - -### Example 1: Create a management group -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>New-AzureRmApiManagementGroup -Context $apimContext -Name "Group0001" -``` - -This command creates a management group. - -## PARAMETERS - -### -Context -Specifies the instance of the **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies the description of the management group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExternalId -For external groups, this property contains the id of the group from the external identity provider, e.g. Microsoft Entra aad://contoso5api.onmicrosoft.com/groups/12ad42b1-592f-4664-a77b4250-2f2e82579f4c; otherwise the value is null. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId -Specifies the identifier of the new management group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the management group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Type -Group Type. Custom Group is User defined Group. System Group includes Administrator, Developers and Guests. You cannot create or update a System Group. External Group is groups from External Identity Provider like Microsoft Entra ID. This parameter is optional and by default assumed to be a Custom Group. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGroupType] -Parameter Sets: (All) -Aliases: -Accepted values: Custom, System, External - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Nullable`1[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGroupType, Microsoft.Azure.Commands.ApiManagement.ServiceManagement, Version=6.1.0.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGroup - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementGroup](./Get-AzureRmApiManagementGroup.md) - -[Remove-AzureRmApiManagementGroup](./Remove-AzureRmApiManagementGroup.md) - -[Set-AzureRmApiManagementGroup](./Set-AzureRmApiManagementGroup.md) diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementHostnameConfiguration.md b/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementHostnameConfiguration.md deleted file mode 100644 index 607861eb63..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementHostnameConfiguration.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: D4C465CE-1B8A-4CFC-BAA8-21CC66B7D6D6 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementhostnameconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementHostnameConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementHostnameConfiguration.md ---- - -# New-AzureRmApiManagementHostnameConfiguration - -## SYNOPSIS -Creates an instance of PsApiManagementHostnameConfiguration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApiManagementHostnameConfiguration -CertificateThumbprint -Hostname - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureRmApiManagementHostnameConfiguration** cmdlet is a helper command that creates an instance of **PsApiManagementHostnameConfiguration**. -This command is used with the Set-AzureRmApiManagementHostnames cmdlet. - -## EXAMPLES - -### Example 1: Create and initialize an instance of PsApiManagementHostnameConfiguration -``` -PS C:\>New-AzureRmApiManagementHostnameConfiguration -Hostname "portal.contoso.com" -CertificateThumbprint "33CC47C6FCA848DC9B14A6F071C1EF7C" -``` - -This command creates and initializes an instance of **PsApiManagementHostnameConfiguration**. - -## PARAMETERS - -### -CertificateThumbprint -Specifies the certificate thumbprint. -The certificate must be first imported with the Import-AzureRmApiManagementHostnameCertificate cmdlet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Hostname -Specifies the custom host name for which this cmdlet creates the **PsApiManagementHostnameConfiguration** instance. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementHostnameConfiguration - -## NOTES - -## RELATED LINKS - -[Import-AzureRmApiManagementHostnameCertificate](./Import-AzureRmApiManagementHostnameCertificate.md) - -[Set-AzureRmApiManagementHostnames](./Set-AzureRmApiManagementHostnames.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementIdentityProvider.md b/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementIdentityProvider.md deleted file mode 100644 index 20dd667cbf..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementIdentityProvider.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementidentityprovider -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementIdentityProvider.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementIdentityProvider.md ---- - -# New-AzureRmApiManagementIdentityProvider - -## SYNOPSIS -Creates a new Identity Provider configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApiManagementIdentityProvider -Context - -Type -ClientId -ClientSecret - [-AllowedTenants ] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -Creates a new Identity Provider configuration. - -## EXAMPLES - -### Example 1: Configures Facebook as an identity Provider for Developer Portal Logins -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>New-AzureRmApiManagementIdentityProvider -Context $apimContext -Type 'Facebook' -ClientId 'sdfsfwerwerw' -ClientSecret 'sdgsdfgfst43tewfewrf' -``` - -This command configures Facebook Identity as a accepted Identity Provider on the Developer Portal of the ApiManagement service. -This takes as input the ClientId and ClientSecret of the Facebook app. - -## PARAMETERS - -### -AllowedTenants -List of allowed Microsoft Entra tenants - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ClientId -Client Id of the Application in the external Identity Provider. -It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ClientSecret -Client secret of the Application in external Identity Provider, used to authenticate login request. -For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Instance of PsApiManagementContext. -This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Identifier of a Identity Provider. -If specified will try to find identity provider configuration by the identifier. -This parameter is optional. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementIdentityProviderType -Parameter Sets: (All) -Aliases: -Accepted values: Facebook, Google, Microsoft, Twitter, Aad, AadB2C - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementIdentityProviderType - -### System.String - -### System.String[] - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementIdentityProvider - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementIdentityProvider](./Get-AzureRmApiManagementIdentityProvider.md) - -[Remove-AzureRmApiManagementIdentityProvider](./Remove-AzureRmApiManagementIdentityProvider.md) - -[Set-AzureRmApiManagementIdentityProvider](./Set-AzureRmApiManagementIdentityProvider.md) diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementLogger.md b/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementLogger.md deleted file mode 100644 index 209adecb84..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementLogger.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 17D53F56-6E3B-491E-8776-5EBE109FBE3C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementlogger -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementLogger.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementLogger.md ---- - -# New-AzureRmApiManagementLogger - -## SYNOPSIS -Creates an API Management Logger. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### EventHubLoggerSet (Default) -``` -New-AzureRmApiManagementLogger -Context [-LoggerId ] -Name - -ConnectionString [-Description ] [-IsBuffered ] - [-DefaultProfile ] [] -``` - -### ApplicationInsightsLoggerSet -``` -New-AzureRmApiManagementLogger -Context [-LoggerId ] - -InstrumentationKey [-Description ] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **New-AzureRmApiManagementLogger** cmdlet creates an Azure API Management **Logger**. - -## EXAMPLES - -### Example 1: Create a logger -```powershell -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>New-AzureRmApiManagementLogger -Context $apimContext -LoggerId "Logger123" -Name "ContosoSdkEventHub" -ConnectionString "Endpoint=sb://ContosoSdkEventHubs.servicebus.windows.net/;SharedAccessKeyName=SendKey;SharedAccessKey=" -Description "SDK event hub logger" -``` - -This command creates a logger named ContosoSdkEventHub by using the specified connection string. - -## PARAMETERS - -### -ConnectionString -Specifies an Azure Event Hubs connection string that starts with the following: -`Endpoint=endpoint and key from Azure classic portal` -The Key with Send Rights in the connection string must be configured. - -```yaml -Type: System.String -Parameter Sets: EventHubLoggerSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InstrumentationKey -Instrumentation Key of the application Insights. This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: ApplicationInsightsLoggerSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IsBuffered -Specifies whether the records in the logger are buffered before publishing. -The default value is $True. -When records are buffered, they are sent to Event Hubs every 15 seconds, or whenever the buffer receives 256 KB of messages. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: EventHubLoggerSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoggerId -Specifies an ID for the logger. -If you do not specify an ID, this cmdlet generates one. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the entity name of an event hub from Azure classic portal. - -```yaml -Type: System.String -Parameter Sets: EventHubLoggerSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementLogger - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementLogger](./Get-AzureRmApiManagementLogger.md) - -[Remove-AzureRmApiManagementLogger](./Remove-AzureRmApiManagementLogger.md) - -[Set-AzureRmApiManagementLogger](./Set-AzureRmApiManagementLogger.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementOpenIdConnectProvider.md b/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementOpenIdConnectProvider.md deleted file mode 100644 index ed2bbd950f..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementOpenIdConnectProvider.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: D5B18FF4-3294-4561-A4CD-CF0FA5E4A59B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementopenidconnectprovider -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementOpenIdConnectProvider.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementOpenIdConnectProvider.md ---- - -# New-AzureRmApiManagementOpenIdConnectProvider - -## SYNOPSIS -Creates an OpenID Connect provider. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApiManagementOpenIdConnectProvider -Context - [-OpenIdConnectProviderId ] -Name -MetadataEndpointUri -ClientId - [-ClientSecret ] [-Description ] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **New-AzureRmApiManagementOpenIdConnectProvider** cmdlet creates an OpenID Connect provider in Azure API Management. - -## EXAMPLES - -### Example 1: Create a provider -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>New-AzureRmApiManagementOpenIdConnectProvider -Context $apimContext -OpenIdConnectProviderId "OICProvicer01" -Name "Contoso OpenID Connect Provider" -MetadataEndpointUri "https://openid.provider/configuration" -ClientId "12432143" -Description "OpenID Connect provider description" -``` - -This command creates an OpenID Connect **Provider** named Contoso OpenID Connect Provider - -## PARAMETERS - -### -ClientId -Specifies the client ID of the developer console. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ClientSecret -Specifies the client secret of the developer console. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MetadataEndpointUri -Specifies a metadata endpoint URI of the provider. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a friendly name for the provider. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OpenIdConnectProviderId -Specifies an ID for the provider. -If you do not specify an ID, this cmdlet generates one. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOpenIdConnectProvider - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementOpenIdConnectProvider](./Get-AzureRmApiManagementOpenIdConnectProvider.md) - -[Remove-AzureRmApiManagementOpenIdConnectProvider](./Remove-AzureRmApiManagementOpenIdConnectProvider.md) - -[Set-AzureRmApiManagementOpenIdConnectProvider](./Set-AzureRmApiManagementOpenIdConnectProvider.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementOperation.md b/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementOperation.md deleted file mode 100644 index 6fd4b43140..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementOperation.md +++ /dev/null @@ -1,285 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 0BC53178-8463-4EF5-8268-FBEC4753AD97 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementoperation -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementOperation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementOperation.md ---- - -# New-AzureRmApiManagementOperation - -## SYNOPSIS -Creates an API management operation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApiManagementOperation -Context -ApiId [-ApiRevision ] - [-OperationId ] -Name -Method -UrlTemplate [-Description ] - [-TemplateParameters ] [-Request ] - [-Responses ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureRmApiManagementOperation** cmdlet create an API operation. - -## EXAMPLES - -### Example 1: Create an API management operation -```powershell -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>New-AzureRmApiManagementOperation -Context $apimContext -ApiId $APIId -OperationId "Operation001" -Name "Operation" -Method "GET" -UrlTemplate "/resource" -Description "Use this operation to get resource" -``` - -This command creates an API management operation. - -### Example 2: Create an API management operation with request and response details -```powershell -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>$RID = New-Object -TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementParameter -$RID.Name = "RID" -$RID.Description = "Resource identifier" -$RID.Type = "string" -$Query = New-Object -TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementParameter -$Query.Name = "query" -$Query.Description = "Query string" -$Query.Type = 'string' -$Request = New-Object -TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementRequest -$Request.Description = "Create/update resource request" -$DummyQp = New-Object -TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementParameter -$DummyQp.Name = 'dummy' -$DummyQp.Type = 'string' -$DummyQp.Required = $FALSE -$Request.QueryParameters = @($DummyQp) -$Header = New-Object -TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementParameter -$Header.Name = 'x-custom-header' -$Header.Type = 'string' -$Request.Headers = @($Header) -$RequestRepresentation = New-Object -TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementRepresentation -$RequestRepresentation.ContentType = 'application/json' -$RequestRepresentation.Sample = '{ "propName": "propValue" }' -$Request.Representations = @($requestRepresentation) -$Response = New-Object -TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementResponse -$Response.StatusCode = 204 -PS C:\>New-AzureRmApiManagementOperation -Context $apimContext -ApiId $APIId -OperationId "01234567890" -Name 'Create/update resource' -Method 'PUT' -UrlTemplate '/resource/{rid}?q={query}' -Description "Use this operation to create new or update existing resource" -TemplateParameters @($rid, $query) -Request $Request -Responses @($response) -``` - -This example creates an API management operation with request and response details. - -## PARAMETERS - -### -ApiId -Specifies the identifier of the API management operation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApiRevision -Identifier of API Revision. This parameter is optional. If not specified, the operation will be attached to the currently active api revision. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Specifies the instance of the **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies the description of new API operation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Method -Specifies the HTTP method of the new API management operation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the display name of new API management operation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OperationId -Specifies the identifier of the API management operation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Request -Specifies the details of the API management operation. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementRequest -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Responses -Specifies an array of possible API management operation responses. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementResponse[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TemplateParameters -Specifies an array of parameters defined in parameter *UrlTemplate*. -If you do not specify this parameter, a default value will be generated based on the *UrlTemplate*. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementParameter[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UrlTemplate -Specifies the URL template. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementParameter[] - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementRequest - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementResponse[] - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOperation - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementOperation](./Get-AzureRmApiManagementOperation.md) - -[Remove-AzureRmApiManagementOperation](./Remove-AzureRmApiManagementOperation.md) - -[Set-AzureRmApiManagementOperation](./Set-AzureRmApiManagementOperation.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementProduct.md b/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementProduct.md deleted file mode 100644 index 37aa7048ab..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementProduct.md +++ /dev/null @@ -1,242 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: E94B88AA-B8B0-49F0-AD36-6707E17B40AD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementproduct -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementProduct.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementProduct.md ---- - -# New-AzureRmApiManagementProduct - -## SYNOPSIS -Creates an API Management product. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApiManagementProduct -Context [-ProductId ] -Title - [-Description ] [-LegalTerms ] [-SubscriptionRequired ] [-ApprovalRequired ] - [-SubscriptionsLimit ] [-State ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureRmApiManagementProduct** cmdlet creates an API Management product. - -## EXAMPLES - -### Example 1: Create a product that does not require a subscription -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>New-AzureRmApiManagementProduct -Context $apimContext -ProductId "0123456789" -Title "Starter" -Description "Starter Product" -LegalTerms "Free for all" -SubscriptionRequired $False -State "Published" -``` - -This command creates an API Management product. -No subscription is required. - -### Example 2: Create a product that requires a subscription and approval -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>New-AzureRmApiManagementProduct -Context $apimContext -ProductId "9876543210" -Title "Unlimited" -Description "Subscribers have completely unlimited access to the API. Administrator approval is required." -LegalTerms "Free for all" -ApprovalRequired $True -State "Published" -NotificationPeriod "D10" -SubscriptionPeriod "Y1" -``` - -This command creates a product. -A subscription and approval are required. -This command sets the notification period to 10 days. -The subscription duration is set to one year. - -## PARAMETERS - -### -ApprovalRequired -Indicates whether the subscription to the product requires approval or not. -By default, this parameter is **$False**. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Specifies an instance of a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies the product description. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LegalTerms -Specifies the legal terms of use of the product. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProductId -Specifies the identifier of new product. -If you do not specify this parameter, a new product is generated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -Specifies the product state. -psdx_paramvalues -- NotPublished -- Published -The default value is NotPublished. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProductState] -Parameter Sets: (All) -Aliases: -Accepted values: NotPublished, Published - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubscriptionRequired -Indicates whether the product requires a subscription. -The default value is **$True**. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubscriptionsLimit -Specifies the maximum number of simultaneous subscriptions. -The default value is 1. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Title -Specifies the product title. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Nullable`1[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProductState, Microsoft.Azure.Commands.ApiManagement.ServiceManagement, Version=6.1.0.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProduct - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementProduct](./Get-AzureRmApiManagementProduct.md) - -[Remove-AzureRmApiManagementProduct](./Remove-AzureRmApiManagementProduct.md) - -[Set-AzureRmApiManagementProduct](./Set-AzureRmApiManagementProduct.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementProperty.md b/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementProperty.md deleted file mode 100644 index 44fb49ba84..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementProperty.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: A91F93D3-B8C7-4328-A049-AB9877C1166C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementproperty -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementProperty.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementProperty.md ---- - -# New-AzureRmApiManagementProperty - -## SYNOPSIS -Creates a new Property. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApiManagementProperty -Context [-PropertyId ] -Name - -Value [-Secret] [-Tag ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureRmApiManagementProperty** cmdlet creates an Azure API Management **Property**. - -## EXAMPLES - -### Example 1: Create a property that includes tags -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>$Tags = 'sdk', 'powershell' -PS C:\> New-AzureRmApiManagementProperty -Context $apimContext -PropertyId "Property11" -Name "Property Name" -Value "Property Value" -Tags $Tags -``` - -The first command assigns two values to the $Tags variable. -The second command creates a property and assigns the strings in $Tags as tags on the property. - -### Example 2: Create a property that has a secret value -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>New-AzureRmApiManagementProperty -Context $apimContext -PropertyId "Property12" -Name "Secret Property -Value "Secret Property Value" -Secret -``` - -This command creates a **Property** that has a value that is encrypted. - -## PARAMETERS - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the property that this cmdlet creates. -Maximum length is 100 characters. -Names contain only letters, digits, period, dash, and underscore characters. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PropertyId -Specifies an ID for the property. -Maximum length is 256 characters. -If you do not specify an ID, this cmdlet generates one. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Secret -Indicates that the property value is a secret and should be encrypted. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Tags to be associated with Property. This parameter is optional. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Value -Specifies a value for the property. -This value can contain policy expressions. -Maximum length is 1000 characters. -The value may not be empty or consist only of whitespace. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Management.Automation.SwitchParameter - -### System.String[] - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProperty - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmApiManagementProperty](./Remove-AzureRmApiManagementProperty.md) - -[Set-AzureRmApiManagementProperty](./Set-AzureRmApiManagementProperty.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementRegion.md b/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementRegion.md deleted file mode 100644 index c801b2f71d..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementRegion.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: A4226BFB-AB3B-4883-9D52-5EB7F29D8A71 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementregion -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementRegion.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementRegion.md ---- - -# New-AzureRmApiManagementRegion - -## SYNOPSIS -Creates an instance of PsApiManagementRegion. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApiManagementRegion -Location [-Capacity ] - [-VirtualNetwork ] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -Helper command to create an instance of PsApiManagementRegion. -This command is to be used with New-AzureRmApiManagement command. - -## EXAMPLES - -### Example 1 -``` -$apimRegion = New-AzureRmApiManagementRegion -Location "Central US" - -$additionalRegions = @($apimRegion) - -New-AzureRmApiManagement -ResourceGroupName ContosoGroup -Location "West US" -Name ContosoApi -Organization Contoso -AdminEmail admin@contoso.com -AdditionalRegions $additionalRegions -Sku "Premium" -``` - -### Example 2 -``` -$apimRegionVirtualNetwork = New-AzureRmApiManagementVirtualNetwork -Location "Central US" -SubnetResourceId "/subscriptions/a8ff56dc-3bc7-4174-a1e8-3726ab15d0e2/resourceGroups/ContosoGroup/providers/Microsoft.Network/virtualNetworks/centralusvirtualNetwork/subnets/backendSubnet" - -$apimRegion = New-AzureRmApiManagementRegion -Location "Central US" -VirtualNetwork $apimRegionVirtualNetwork - -$additionalRegions = @($apimRegion) - -$virtualNetwork = New-AzureRmApiManagementVirtualNetwork -Location "West US" -SubnetResourceId "/subscriptions/a8ff56dc-3bc2-4174-a1e8-3726ab15d0e2/resourceGroups/ContosoGroup/providers/Microsoft.Network/virtualNetworks/westUsVirtualNetwork/subnets/backendSubnet" - -New-AzureRmApiManagement -ResourceGroupName ContosoGroup -Location "West US" -Name ContosoApi -Organization Contoso -AdminEmail admin@contoso.com -AdditionalRegions $additionalRegions -VirtualNetwork $virtualNetwork -VpnType "External" -Sku "Premium" -``` - -Creates an ApiManagement service of External VpnType in West US Region, with an Additional Region in Central US. - -## PARAMETERS - -### -Capacity -Sku capacity of the Azure API Management service additional region. -Default value is 1. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the new deployment region amongst the supported region for Api Management service. -To obtain valid locations, use the cmdlet -Get-AzureRmResourceProvider -ProviderNamespace "Microsoft.ApiManagement" | where {$_.ResourceTypes[0].ResourceTypeName -eq "service"} | Select-Object Locations - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetwork -Virtual Network Configuration of Azure API Management deployment region. -Default value is $null. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementVirtualNetwork -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementVirtualNetwork - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementRegion - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementSubscription.md b/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementSubscription.md deleted file mode 100644 index f514a12ff3..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementSubscription.md +++ /dev/null @@ -1,208 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: B85BF332-503D-41CB-A3B7-221B85B9BE30 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementsubscription -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementSubscription.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementSubscription.md ---- - -# New-AzureRmApiManagementSubscription - -## SYNOPSIS -Creates a subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApiManagementSubscription -Context [-SubscriptionId ] - -Name -UserId -ProductId [-PrimaryKey ] [-SecondaryKey ] - [-State ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureRmApiManagementSubscription** cmdlet creates a subscription. - -## EXAMPLES - -### Example 1: Subscribe a user to a product -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>New-AzureRmApiManagementSubscription -Context $apimContext -UserId "777" -ProductId "999" -``` - -This command subscribes an existing user to a product. - -## PARAMETERS - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the subscription name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PrimaryKey -Specifies the subscription primary key. -If this parameter is not specified the key is generated automatically. -This parameter must be 1 to 300 characters long. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProductId -Specifies the ID of the product to which to subscribe. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecondaryKey -Specifies the subscription secondary key. -This parameter is generated automatically if it is not specified. -This parameter must be 1 to 300 characters long. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -Specifies the subscription state. -The default value is $Null. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscriptionState] -Parameter Sets: (All) -Aliases: -Accepted values: Suspended, Active, Expired, Submitted, Rejected, Cancelled - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubscriptionId -Specifies the subscription ID. -This parameter is generated if not specified. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserId -Specifies the subscriber ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Nullable`1[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscriptionState, Microsoft.Azure.Commands.ApiManagement.ServiceManagement, Version=6.1.0.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscription - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementSubscription](./Get-AzureRmApiManagementSubscription.md) - -[Remove-AzureRmApiManagementSubscription](./Remove-AzureRmApiManagementSubscription.md) - -[Set-AzureRmApiManagementSubscription](./Set-AzureRmApiManagementSubscription.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementSystemCertificate.md b/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementSystemCertificate.md deleted file mode 100644 index 442cbbf61e..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementSystemCertificate.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementsystemcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementSystemCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementSystemCertificate.md ---- - -# New-AzureRmApiManagementSystemCertificate - -## SYNOPSIS -Creates an instance of `PsApiManagementSystemCertificate`. The certificate can be issued by private CA's and will be installed on the API Management service into `CertificateAuthority` or `Root` store. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApiManagementSystemCertificate -StoreName -PfxPath [-PfxPassword ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureRmApiManagementSystemCertificate** cmdlet is a helper command that creates an instance of **PsApiManagementSystemCertificate**. -This command is used with the New-AzureRmApiManagement and Set-AzureRmApiManagement cmdlet. - -## EXAMPLES - -### Example 1: Create and initialize an instance of PsApiManagementSystemCertificate using an Ssl Certificate from file -```powershell -PS C:\>$rootCa = New-AzureRmApiManagementSystemCertificate -StoreName "Root" -PfxPath "C:\contoso\certificates\privateCa.cer" -PS C:\>$systemCert = @($rootCa) -PS C:\>New-AzureRmApiManagement -ResourceGroupName "ContosoGroup" -Location "West US" -Name "ContosoApi" -Organization Contoso -AdminEmail admin@contoso.com -SystemCertificateConfiguration $systemCert -``` - -This command creates and initializes an instance of **PsApiManagementSystemCertificate** with a root CA certificate. It then creates and API Management service which installs the CA cert to the Root store. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PfxPassword -Password for the .pfx certificate file. - -```yaml -Type: System.Security.SecureString -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PfxPath -Path to a .pfx certificate file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StoreName -Certificate StoreName - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: CertificateAuthority, Root - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Security.SecureString - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSystemCertificate - -## NOTES - -## RELATED LINKS - -[New-AzureRmApiManagement](./New-AzureRmApiManagement.md) - -[Set-AzureRmApiManagement](./Set-AzureRmApiManagement.md) diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementUser.md b/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementUser.md deleted file mode 100644 index f10a4498ce..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementUser.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 3C467F64-7525-4420-9AFE-DCB98EF6D203 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementuser -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementUser.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementUser.md ---- - -# New-AzureRmApiManagementUser - -## SYNOPSIS -Registers a new user. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApiManagementUser -Context [-UserId ] -FirstName - -LastName -Email -Password [-State ] - [-Note ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureRmApiManagementUser** cmdlet registers a new user. - -## EXAMPLES - -### Example 1: Register a new user -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>$securePassword = ConvertTo-SecureString "qwerty" -AsPlainText -Force -PS C:\>New-AzureRmApiManagementUser -Context $apimContext -FirstName "Patti" -LastName "Fuller" -Email "Patti.Fuller@contoso.com" -Password $securePassword -``` - -This command registers a new user named Patti Fuller. - -## PARAMETERS - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Email -Specifies the email address of the user. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FirstName -Specifies the first name of the user. -This parameter must be 1 to 100 characters long. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LastName -Specifies the last name of the user. -This parameter must be 1 to 100 characters long. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Note -Specifies a note about the user. -This parameter is optional. -The default value is $Null. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Password -Specifies the user password. -This parameter is required. - -```yaml -Type: System.Security.SecureString -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -Specifies the user state. -This parameter is optional. -The default value of this parameter is $Null. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementUserState] -Parameter Sets: (All) -Aliases: -Accepted values: Active, Blocked, Deleted, Pending - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserId -Specifies the user ID. -This parameter is optional. -If this parameter is not specified, this cmdlet generates a user ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Security.SecureString - -### System.Nullable`1[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementUserState, Microsoft.Azure.Commands.ApiManagement.ServiceManagement, Version=6.1.0.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementUser - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementUser](./Get-AzureRmApiManagementUser.md) - -[Set-AzureRmApiManagementUser](./Set-AzureRmApiManagementUser.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementVirtualNetwork.md b/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementVirtualNetwork.md deleted file mode 100644 index ed805a4f05..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/New-AzureRmApiManagementVirtualNetwork.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: FB5E4ED2-8EF3-462F-A053-7EC82C767E8D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementvirtualnetwork -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementVirtualNetwork.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementVirtualNetwork.md ---- - -# New-AzureRmApiManagementVirtualNetwork - -## SYNOPSIS -Creates an instance of PsApiManagementVirtualNetwork. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApiManagementVirtualNetwork -Location -SubnetResourceId - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureRmApiManagementVirtualNetwork** cmdlet is a helper command to create an instance of **PsApiManagementVirtualNetwork**. -This command is used with **Update-AzureRmApiManagementDeployment** cmdlet. - -## EXAMPLES - -### Example 1: Create a virtual network -``` -PS C:\>$vnetName = "myvnet" -PS C:\>$subnetName = "default" -PS C:\>$subnet = New-AzureRmVirtualNetworkSubnetConfig -Name $subnetName -AddressPrefix 10.0.1.0/24 -PS C:\>$vnet = New-AzureRmvirtualNetwork -Name $vnetName -ResourceGroupName $resourceGroupName -Location $location -AddressPrefix 10.0.0.0/16 -Subnet $subnet - -# Create a Virtual Network Object -PS C:\>$virtualNetwork = New-AzureRmApiManagementVirtualNetwork -Location $location -SubnetResourceId $vnet.Subnets[0].Id - -# Get the service -PS C:\>$service = Get-AzureRmApiManagement -ResourceGroupName $resourceGroupName -Name $apiManagementName -PS C:\>$service.VirtualNetwork = $virtualNetwork -PS C:\>$service.VpnType = "External" - -# Update the Deployment with Virtual Network -PS C:\>Update-AzureRmApiManagementDeployment -ApiManagement $service -``` - -This example creates a virtual network and then calls the **Update-AzureRmApiManagementDeployment** cmdlet. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location amongst the supported region for Api Management service. -To obtain valid locations, use the cmdlet -Get-AzureRmResourceProvider -ProviderNamespace "Microsoft.ApiManagement" | where {$_.ResourceTypes[0].ResourceTypeName -eq "service"} | Select-Object Locations - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetResourceId -Specifies the subnet resource ID of the virtual network. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementVirtualNetwork - -## NOTES - -## RELATED LINKS - -[Update-AzureRmApiManagementDeployment](./Update-AzureRmApiManagementDeployment.md) - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Publish-AzureRmApiManagementTenantGitConfiguration.md b/azurermps-6.13.0/AzureRM.ApiManagement/Publish-AzureRmApiManagementTenantGitConfiguration.md deleted file mode 100644 index 5b0df15afc..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Publish-AzureRmApiManagementTenantGitConfiguration.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 4783305F-5619-446A-A6DF-BD1E56739A2F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/publish-azurermapimanagementtenantgitconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Publish-AzureRmApiManagementTenantGitConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Publish-AzureRmApiManagementTenantGitConfiguration.md ---- - -# Publish-AzureRmApiManagementTenantGitConfiguration - -## SYNOPSIS -Publishes changes from a Git branch to the configuration database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Publish-AzureRmApiManagementTenantGitConfiguration -Context -Branch [-Force] - [-ValidateOnly] [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Publish-AzureRmApiManagementTenantGitConfiguration** cmdlet publishes the changes from a Git branch to the configuration database. -You can alternatively validate the changes in a Git branch without publishing. - -## EXAMPLES - -### Example 1: Deploy Git changes -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Publish-AzureRmApiManagementTenantGitConfiguration -Context $apimContext -Branch 'master' -PassThru -``` - -This command publishes the changes from the specified branch to the configuration database. - -### Example 2: Validate Git changes -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Publish-AzureRmApiManagementTenantGitConfiguration -Context $apimContext -Branch 'master' -ValidateOnly -PassThru -``` - -This command validates the changes in the Git branch against the configuration database. -It does not publish changes. - -## PARAMETERS - -### -Branch -Specifies the name of the Git branch from which this cmdlet deploys the configuration to the configuration database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Indicates that this cmdlet deletes subscriptions to products that are deleted in this update. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a **PsApiManagementOperationResult** object. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ValidateOnly -Indicates that this cmdlet validates the changes in the specified Git branch. -It does not publish to the configuration database. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOperationResult - -## NOTES - -## RELATED LINKS - -[Save-AzureRmApiManagementTenantGitConfiguration](./Save-AzureRmApiManagementTenantGitConfiguration.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagement.md b/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagement.md deleted file mode 100644 index 6558b05a0e..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagement.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: CD582654-1B0C-4960-9E18-454F857B56E7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagement -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagement.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagement.md ---- - -# Remove-AzureRmApiManagement - -## SYNOPSIS -Removes an API Management service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApiManagement -ResourceGroupName -Name [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AzureRmApiManagement** cmdlet removes an Azure API Management service. - -## EXAMPLES - -### Example 1: Remove an API Management service -``` -PS C:\>Remove-AzureRmApiManagement -ResourceGroupName "ContosoGroup02" -Name "ContosoApi" -``` - -This command removes the API Management service named ContosoApi. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the API Management deployment that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a value of $True if the operation succeeds. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the of resource group under which the API Management deployment exists. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Backup-AzureRmApiManagement](./Backup-AzureRmApiManagement.md) - -[Get-AzureRmApiManagement](./Get-AzureRmApiManagement.md) - -[New-AzureRmApiManagement](./New-AzureRmApiManagement.md) - -[Restore-AzureRmApiManagement](./Restore-AzureRmApiManagement.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementApi.md b/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementApi.md deleted file mode 100644 index 285bd88e47..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementApi.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: F23D9274-63B9-4654-897B-6E84757774D2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementapi -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementApi.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementApi.md ---- - -# Remove-AzureRmApiManagementApi - -## SYNOPSIS -Removes an API. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApiManagementApi -Context -ApiId [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AzureRmApiManagementApi** cmdlet removes an existing API. - -## EXAMPLES - -### Example 1: Remove an API -```powershell -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Remove-AzureRmApiManagementApi -Context $apimContext -ApiId "0123456789" -``` - -This command removes the API with the specified ID. - -## PARAMETERS - -### -ApiId -Specifies the ID of the API remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -passthru - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Export-AzureRmApiManagementApi](./Export-AzureRmApiManagementApi.md) - -[Get-AzureRmApiManagementApi](./Get-AzureRmApiManagementApi.md) - -[Import-AzureRmApiManagementApi](./Import-AzureRmApiManagementApi.md) - -[New-AzureRmApiManagementApi](./New-AzureRmApiManagementApi.md) - -[Set-AzureRmApiManagementApi](./Set-AzureRmApiManagementApi.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementApiFromProduct.md b/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementApiFromProduct.md deleted file mode 100644 index a04017d2c4..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementApiFromProduct.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 2457C7F5-7FB9-4712-AD7C-438E88F591A8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementapifromproduct -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementApiFromProduct.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementApiFromProduct.md ---- - -# Remove-AzureRmApiManagementApiFromProduct - -## SYNOPSIS -Removes an API from a product. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApiManagementApiFromProduct -Context -ProductId -ApiId - [-PassThru] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Remove-AzureRmApiManagementApiFromProduct** cmdlet removes an Azure API Management API from a product. - -## EXAMPLES - -### Example 1: Remove an API from a product -``` -PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Remove-AzureRmApiManagementApiFromProduct -Context $ApiMgmtContext -ProductId "0123456789" -ApiId "0001" -PassThru -``` - -This commnd removes the specified API from a product. - -## PARAMETERS - -### -ApiId -Specifies the ID of the API to remove from the product. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Specifies a **PsApiManagementContext**. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a value of $True if it succeeds, or $False, otherwise. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProductId -Specifies the ID of the product from which to remove the API. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApiManagementApiToProduct](./Add-AzureRmApiManagementApiToProduct.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementApiRelease.md b/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementApiRelease.md deleted file mode 100644 index 1899847f5b..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementApiRelease.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementapirelease -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementApiRelease.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementApiRelease.md ---- - -# Remove-AzureRmApiManagementApiRelease - -## SYNOPSIS -Removes a particular API Release - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByApiReleaseId (Default) -``` -Remove-AzureRmApiManagementApiRelease -Context -ApiId -ReleaseId - [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### ByInputObject -``` -Remove-AzureRmApiManagementApiRelease -InputObject [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -The **Remove-AzureRmApiManagementApiRelease** cmdlet removes an existing API Release. - -## EXAMPLES - -### Example 1: Remove an API Release -```powershell -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Remove-AzureRmApiManagementApiRelease -Context $apimContext -ApiId "echo-api" -ReleaseId "2" -``` - -This command removes the API Release with the specified ApiId and ReleaseId. - -## PARAMETERS - -### -ApiId -Identifier of the API. -This parameter is required. - -```yaml -Type: System.String -Parameter Sets: ByApiReleaseId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Instance of PsApiManagementContext. -This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: ByApiReleaseId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Instance of PsApiManagementApiRelease. This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiRelease -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -If specified will write true in case operation succeeds. -This parameter is optional. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReleaseId -Identifier of the API Release. -This parameter is required. - -```yaml -Type: System.String -Parameter Sets: ByApiReleaseId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiRelease -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementApiRelease](./Get-AzureRmApiManagementApiRelease.md) - -[New-AzureRmApiManagementApiRelease](./New-AzureRmApiManagementApiRelease.md) - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementApiRevision.md b/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementApiRevision.md deleted file mode 100644 index 5f4d584a10..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementApiRevision.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementapirevision -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementApiRevision.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementApiRevision.md ---- - -# Remove-AzureRmApiManagementApiRevision - -## SYNOPSIS -Removed a particular API Revision - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByApiId (Default) -``` -Remove-AzureRmApiManagementApiRevision -Context -ApiId -ApiRevision - [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### ByInputObject -``` -Remove-AzureRmApiManagementApiRevision -InputObject [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The cmdlet **Remove-AzureRmApiManagementApiRevision** removes a particular API revision. - -## EXAMPLES - -### Example 1: Remove an API Revision -```powershell -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Remove-AzureRmApiManagementApiRevision -Context $apimContext -ApiId "echo-api" -ApiRevision "2" -``` - -This command removes the `2` revision of the API `echo-api` from API Management service. - -## PARAMETERS - -### -ApiId -Identifier of the API. -This parameter is required. - -```yaml -Type: System.String -Parameter Sets: ByApiId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApiRevision -Identifier of the API Revision. This parameter is required. - -```yaml -Type: System.String -Parameter Sets: ByApiId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Instance of PsApiManagementContext. -This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: ByApiId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Instance of PsApiManagementApiRelease. This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -If specified will write true in case operation succeeds. -This parameter is optional. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementApiRevision](./Get-AzureRmApiManagementApiRevision.md) - -[New-AzureRmApiManagementApiRevision](./New-AzureRmApiManagementApiRevision.md) - -[Set-AzureRmApiManagementApiRevision](./Set-AzureRmApiManagementApiRevision.md) diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementApiVersionSet.md b/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementApiVersionSet.md deleted file mode 100644 index f5679d89cb..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementApiVersionSet.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementapiversionset -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementApiVersionSet.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementApiVersionSet.md ---- - -# Remove-AzureRmApiManagementApiVersionSet - -## SYNOPSIS -Removes a particular Api Version Set - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ExpandedParameter (Default) -``` -Remove-AzureRmApiManagementApiVersionSet -Context -ApiVersionSetId - [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### ByInputObject -``` -Remove-AzureRmApiManagementApiVersionSet -InputObject [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -The **Remove-AzureRmApiManagementApiVersionSet** cmdlet removes an existing API Version Set. - -## EXAMPLES - -### Example 1: Remove an API Version set -```powershell -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Remove-AzureRmApiManagementApiVersionSet -Context $apimContext -ApiVersionSetId "query-param-set" -``` - -This command removes the API Version Set with the specified ApiVersionSetId. - -## PARAMETERS - -### -ApiVersionSetId -Identifier of the API Version Set. -This parameter is required. - -```yaml -Type: System.String -Parameter Sets: ExpandedParameter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Instance of PsApiManagementContext. -This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: ExpandedParameter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Instance of PsApiManagementApiVersionSet. This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiVersionSet -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -If specified will write true in case operation succeeds. -This parameter is optional. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameters: Context (ByValue) - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiVersionSet -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementApiVersionSet](./Get-AzureRmApiManagementApiVersionSet.md) - -[New-AzureRmApiManagementApiVersionSet](./New-AzureRmApiManagementApiVersionSet.md) - -[Set-AzureRmApiManagementApiVersionSet](./Set-AzureRmApiManagementApiVersionSet.md) diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementAuthorizationServer.md b/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementAuthorizationServer.md deleted file mode 100644 index 631e948671..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementAuthorizationServer.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: C2CC10DE-1D36-4937-8A3E-9776BE80DF9A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementauthorizationserver -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementAuthorizationServer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementAuthorizationServer.md ---- - -# Remove-AzureRmApiManagementAuthorizationServer - -## SYNOPSIS -Removes an authorization server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApiManagementAuthorizationServer -Context -ServerId [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AzureRmApiManagementAuthorizationServer** cmdlet removes an Azure API Management authorization server. - -## EXAMPLES - -## PARAMETERS - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -passthru - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerId -Specifies the ID of the authorization server to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementAuthorizationServer](./Get-AzureRmApiManagementAuthorizationServer.md) - -[New-AzureRmApiManagementAuthorizationServer](./New-AzureRmApiManagementAuthorizationServer.md) - -[Set-AzureRmApiManagementAuthorizationServer](./Set-AzureRmApiManagementAuthorizationServer.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementBackend.md b/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementBackend.md deleted file mode 100644 index 717c4281e4..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementBackend.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementbackend -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementBackend.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementBackend.md ---- - -# Remove-AzureRmApiManagementBackend - -## SYNOPSIS -Removes a Backend. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApiManagementBackend -Context -BackendId [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Removes a backend specified by the Identifier from the Api Management. - -## EXAMPLES - -### Example 1: Remove the Backend 123 -```powershell -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Remove-AzureRmApiManagementBackend -Context $apimContext -BackendId 123 -PassThru -``` - -## PARAMETERS - -### -BackendId -Identifier of existing backend. -This parameter is required. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Instance of PsApiManagementContext. -This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -If specified will write true in case operation succeeds. -This parameter is optional. -Default value is false. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementBackend](./Get-AzureRmApiManagementBackend.md) - -[New-AzureRmApiManagementBackend](./New-AzureRmApiManagementBackend.md) - -[New-AzureRmApiManagementBackendCredential](./New-AzureRmApiManagementBackendCredential.md) - -[New-AzureRmApiManagementBackendProxy](./New-AzureRmApiManagementBackendProxy.md) - -[Set-AzureRmApiManagementBackend](./Set-AzureRmApiManagementBackend.md) diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementCertificate.md b/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementCertificate.md deleted file mode 100644 index dbedf64f11..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementCertificate.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 9B261CD8-5209-4C14-A6F8-97D61B641642 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementCertificate.md ---- - -# Remove-AzureRmApiManagementCertificate - -## SYNOPSIS -Removes an API Management certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApiManagementCertificate -Context -CertificateId [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AzureRmApiManagementCertificate** cmdlet removes an Azure API Management certificate. - -## EXAMPLES - -### Example 1: Remove a certificate -```powershell -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Remove-AzureRmApiManagementCertificate -Context $ApiMgmtContext -CertificateId "0123456789" -Force -``` - -This command removes the specified API Management certificate. -Because the *Force* parameter is specified, no confirmation is required. - -## PARAMETERS - -### -CertificateId -Specifies the ID of the certificate to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -passthru - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementCertificate](./Get-AzureRmApiManagementCertificate.md) - -[New-AzureRmApiManagementCertificate](./New-AzureRmApiManagementCertificate.md) - -[Set-AzureRmApiManagementCertificate](./Set-AzureRmApiManagementCertificate.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementGroup.md b/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementGroup.md deleted file mode 100644 index 7a419bd6e3..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementGroup.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: B88EC6DB-84AC-4F1D-AD79-0D243E0DC88A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementgroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementGroup.md ---- - -# Remove-AzureRmApiManagementGroup - -## SYNOPSIS -Removes an existing API management group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApiManagementGroup -Context -GroupId [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AzureRmApiManagementGroup** cmdlet removes an existing API management group. - -## EXAMPLES - -### Example 1: Remove an existing management group -```powershell -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Remove-AzureRmApiManagementGroup -Context $apimContext -GroupId "Group0001" -Force -``` - -This command removes an existing management group named Group0001 and does not prompt the user for confirmation. - -## PARAMETERS - -### -Context -Specifies the instance of a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId -Specifies the identifier of a management group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a value of $True if it succeeds, or a value of $False, otherwise. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementGroup](./Get-AzureRmApiManagementGroup.md) - -[New-AzureRmApiManagementGroup](./New-AzureRmApiManagementGroup.md) - -[Set-AzureRmApiManagementGroup](./Set-AzureRmApiManagementGroup.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementIdentityProvider.md b/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementIdentityProvider.md deleted file mode 100644 index 4c19a69517..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementIdentityProvider.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementidentityprovider -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementIdentityProvider.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementIdentityProvider.md ---- - -# Remove-AzureRmApiManagementIdentityProvider - -## SYNOPSIS -Removes an existing Identity Provider Configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApiManagementIdentityProvider -Context - -Type [-PassThru] [-DefaultProfile ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -Removes an existing Identity Provider Configuration. - -## EXAMPLES - -### Removes the Facebook identity provider settings from ApiManagement service -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Remove-AzureRmApiManagementIdentityProvider -Context $apimContext -Type 'Facebook' -PassThru -``` - -Deletes configuration related to Facebook Identity provider configuration. - -## PARAMETERS - -### -Context -Instance of PsApiManagementContext. -This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a value of $True if the operation succeeds or $False otherwise. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Type -Identifier of an existing Identity Provider. -This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementIdentityProviderType -Parameter Sets: (All) -Aliases: -Accepted values: Facebook, Google, Microsoft, Twitter, Aad, AadB2C - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementIdentityProviderType - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[New-AzureRmApiManagementIdentityProvider](./New-AzureRmApiManagementIdentityProvider.md) - -[Get-AzureRmApiManagementIdentityProvider](./Get-AzureRmApiManagementIdentityProvider.md) - -[Set-AzureRmApiManagementIdentityProvider](./Set-AzureRmApiManagementIdentityProvider.md) - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementLogger.md b/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementLogger.md deleted file mode 100644 index 29bdf9a414..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementLogger.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 98AD1C84-B147-48EB-94B5-8D77B531F6F8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementlogger -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementLogger.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementLogger.md ---- - -# Remove-AzureRmApiManagementLogger - -## SYNOPSIS -Removes an API Management Logger. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApiManagementLogger -Context -LoggerId [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AzureRmApiManagementLogger** cmdlet removes an Azure API Management **Logger**. - -## EXAMPLES - -### Example 1: Remove a logger -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Remove-AzureRmApiManagementLogger -Context $apimContext -LoggerId "Logger123" -Force -``` - -This command removes a logger that has the ID Logger123. - -## PARAMETERS - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoggerId -Specifies the ID of the logger to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a value of $True if the operation succeeds or $False otherwise. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementLogger](./Get-AzureRmApiManagementLogger.md) - -[New-AzureRmApiManagementLogger](./New-AzureRmApiManagementLogger.md) - -[Set-AzureRmApiManagementLogger](./Set-AzureRmApiManagementLogger.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementOpenIdConnectProvider.md b/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementOpenIdConnectProvider.md deleted file mode 100644 index a6ae1e4898..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementOpenIdConnectProvider.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 80B61E7D-14DC-422A-8EE3-CAC49EF1BE8B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementopenidconnectprovider -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementOpenIdConnectProvider.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementOpenIdConnectProvider.md ---- - -# Remove-AzureRmApiManagementOpenIdConnectProvider - -## SYNOPSIS -Removes an OpenID Connect provider. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApiManagementOpenIdConnectProvider -Context - -OpenIdConnectProviderId [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Remove-AzureRmApiManagementOpenIdConnectProvider** cmdlet removes an OpenID Connect provider for Azure API Management. - -## EXAMPLES - -### Example 1: Remove a provider -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Remove-AzureRmApiManagementOpenIdConnectProvider -Context $apimContext -OpenIdConnectProviderId "OICProvicer01" -PassThru -``` - -This command removes a provider that has the ID OICProvicer01. - -## PARAMETERS - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OpenIdConnectProviderId -Specifies an ID of the provider that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a value of $True if the operation succeeds or $False otherwise. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementOpenIdConnectProvider](./Get-AzureRmApiManagementOpenIdConnectProvider.md) - -[New-AzureRmApiManagementOpenIdConnectProvider](./New-AzureRmApiManagementOpenIdConnectProvider.md) - -[Set-AzureRmApiManagementOpenIdConnectProvider](./Set-AzureRmApiManagementOpenIdConnectProvider.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementOperation.md b/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementOperation.md deleted file mode 100644 index 2d487f33cf..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementOperation.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: A4A8D996-72A2-4154-98DA-5F84CAA010B9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementoperation -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementOperation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementOperation.md ---- - -# Remove-AzureRmApiManagementOperation - -## SYNOPSIS -Removes an existing operation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApiManagementOperation -Context -ApiId [-ApiRevision ] - -OperationId [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Remove-AzureRmApiManagementOperation** cmdlet removes an existing operation. - -## EXAMPLES - -### Example 1: Remove an existing API Operation -```powershell -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Remove-AzureRmApiManagementOperation -Context $apimContext -ApiId "0123456789" -OperationId "9876543210" -Force -``` - -This command removes an existing API Operation. - -## PARAMETERS - -### -ApiId -Specifies the identifier of the API. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApiRevision -Identifier of API Revision. This parameter is optional. If not specified, the operation will be removed from the currently active api revision. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Specifies an instance of **PsApiManagementContext**. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OperationId -Specifies the identifier of the API operation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a value of $True if it succeeds, or a value of $False, otherwise. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementOperation](./Get-AzureRmApiManagementOperation.md) - -[New-AzureRmApiManagementOperation](./New-AzureRmApiManagementOperation.md) - -[Set-AzureRmApiManagementOperation](./Set-AzureRmApiManagementOperation.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementPolicy.md b/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementPolicy.md deleted file mode 100644 index 90d04a6b30..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementPolicy.md +++ /dev/null @@ -1,230 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 466AFB8C-C272-4A4F-8E13-A4DBD6EE3A85 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementPolicy.md ---- - -# Remove-AzureRmApiManagementPolicy - -## SYNOPSIS -Removes the API Management policy from a specified scope. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RemoveTenantLevel (Default) -``` -Remove-AzureRmApiManagementPolicy -Context [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### RemoveProductLevel -``` -Remove-AzureRmApiManagementPolicy -Context -ProductId [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### RemoveApiLevel -``` -Remove-AzureRmApiManagementPolicy -Context -ApiId [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### RemoveOperationLevel -``` -Remove-AzureRmApiManagementPolicy -Context -ApiId -OperationId - [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AzureRmApiManagementPolicy** cmdlet removes the API Management policy from specified scope. - -## EXAMPLES - -### Example 1: Remove the tenant level policy -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Remove-AzureRmApiManagementPolicy -Context $apimContext -``` - -This command removes tenant level policy from API Management. - -### Example 2: Remove the product-scope policy -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Remove-AzureRmApiManagementPolicy -Context $apimContext -ProductId "0123456789" -``` - -This command removes product-scope policy from API Management. - -### Example 3: Remove the API-scope policy -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Remove-AzureRmApiManagementPolicy -Context $apimContext -ApiId "9876543210" -``` - -This command removes API-scope policy from API Management. - -### Example 4: Remove the operation-scope policy -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Remove-AzureRmApiManagementPolicy -Context $apimContext -ApiId "9876543210" -OperationId "777" -``` - -This command removes operation-scope policy from API Management. - -## PARAMETERS - -### -ApiId -Specifies the identifier of an existing API. -If you specify this parameter, the cmdlet removes the API-scope policy. - -```yaml -Type: System.String -Parameter Sets: RemoveApiLevel, RemoveOperationLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Specifies the instance of the **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OperationId -Specifies the identifier of an existing operation. -If you specify this parameter with the *ApiId* parameter, this cmdlet removes the operation-scope policy. - -```yaml -Type: System.String -Parameter Sets: RemoveOperationLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a value of $True, if it succeeds, or a value of $False, otherwise. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProductId -Specifies the identifier of the existing product. -If you specify this parameter, the cmdlet removes the product-scope policy. - -```yaml -Type: System.String -Parameter Sets: RemoveProductLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementPolicy](./Get-AzureRmApiManagementPolicy.md) - -[Set-AzureRmApiManagementPolicy](./Set-AzureRmApiManagementPolicy.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementProduct.md b/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementProduct.md deleted file mode 100644 index ecdb5fce6f..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementProduct.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: D6B7F253-03CD-40BE-87D6-E4AE300A29D5 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementproduct -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementProduct.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementProduct.md ---- - -# Remove-AzureRmApiManagementProduct - -## SYNOPSIS -Removes an existing API Management product. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApiManagementProduct -Context -ProductId [-DeleteSubscriptions] - [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AzureRmApiManagementProduct** cmdlet removes an existing API Management product. - -## EXAMPLES - -### Example 1: Remove an existing product and all subscriptions -```powershell -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Remove-AzureRmApiManagementProduct -Context $apimContext -Id "0123456789" -DeleteSubscriptions -Force -``` - -This command removes an existing product and all subscriptions. - -## PARAMETERS - -### -Context -Specifies an instance of the **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeleteSubscriptions -Indicates whether to delete subscriptions to the product. -If you do not set this parameter and subscriptions exists, an exception is thrown. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a value of $True, if it succeeds, or a value of $False, if it fails. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProductId -Specifies the identifier of the existing product. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementProduct](./Get-AzureRmApiManagementProduct.md) - -[New-AzureRmApiManagementProduct](./New-AzureRmApiManagementProduct.md) - -[Set-AzureRmApiManagementProduct](./Set-AzureRmApiManagementProduct.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementProductFromGroup.md b/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementProductFromGroup.md deleted file mode 100644 index a9f626682b..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementProductFromGroup.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 2FD2C5C0-5A5A-4CF0-9260-21B9E3DE52B9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementproductfromgroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementProductFromGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementProductFromGroup.md ---- - -# Remove-AzureRmApiManagementProductFromGroup - -## SYNOPSIS -Removes a product from a group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApiManagementProductFromGroup -Context -GroupId - -ProductId [-PassThru] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Remove-AzureRmApiManagementProductFromGroup** cmdlet removes a product from an existing group. -In other words, this cmdlet removes the group assignment from a product. - -## EXAMPLES - -### Example 1: Remove a product from a group -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Remove-AzureRmApiManagementProductFromGroup -Context $apimContext -GroupId "0001" -ProductId "0123456789" -``` - -This command removes a product from an existing group. - -## PARAMETERS - -### -Context -Specifies a **PsApiManagementContext** object. -This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId -Specifies the group ID. -This parameter is required. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a value of $True, if it succeeds, or $False, otherwise. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProductId -Specifies the product ID. -This parameter is required. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApiManagementProductToGroup](./Add-AzureRmApiManagementProductToGroup.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementProperty.md b/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementProperty.md deleted file mode 100644 index 5884459381..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementProperty.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: D3C60123-CE1F-45F1-8C8F-25CDC302490C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementproperty -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementProperty.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementProperty.md ---- - -# Remove-AzureRmApiManagementProperty - -## SYNOPSIS -Removes an API Management Property. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApiManagementProperty -Context -PropertyId [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AzureRmApiManagementProperty** cmdlet removes an Azure API Management **Property**. - -## EXAMPLES - -### Example 1: Remove a property -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Remove-AzureRmApiManagementProperty -Context $apimContext -PropertyId "Property11" -PassThru -``` - -This command removes the property that has the ID Property11. - -## PARAMETERS - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a value of $True if the operation succeeds or $False otherwise. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PropertyId -Specifies an ID of the property that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[New-AzureRmApiManagementProperty](./New-AzureRmApiManagementProperty.md) - -[Set-AzureRmApiManagementProperty](./Set-AzureRmApiManagementProperty.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementRegion.md b/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementRegion.md deleted file mode 100644 index 32aa5f3438..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementRegion.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 17D7EBD2-FE3F-4D24-A1AA-8C45B9B1FEF5 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementregion -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementRegion.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementRegion.md ---- - -# Remove-AzureRmApiManagementRegion - -## SYNOPSIS -Removes an existing deployment region from PsApiManagement instance. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApiManagementRegion -ApiManagement -Location - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Remove-AzureRmApiManagementRegion** cmdlet removes instance of type **Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementRegion** from a collection of **AdditionalRegions** of provided the instance of type **Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement**. -This cmdlet does not modify deployment by itself but updates the instance of **PsApiManagement** in-memory. -To update a deployment of an API Management, pass the modified **PsApiManagementInstance** to **Update-AzureRmApiManagement**. - -## EXAMPLES - -### Example 1: Remove a region from a PsApiManagement instance -``` -PS C:\>Remove-AzureRmApiManagementRegion -ApiManagement $ApiManagement -Location "East US" -``` - -This command removes the region named East US from the **PsApiManagement** instance. - -### Example 2: Remove a region from a PsApiManagement instance using a series of commands -``` -PS C:\>Get-AzureRmApiManagement -ResourceGroupName "Contoso" -Name ContosoApi | Remove-AzureRmApiManagementRegion -Location "East US" | Update-AzureRmApiManagementDeployment -``` - -This first command gets an instance of **PsApiManagement** from the resource group named Contoso named ContosoApi. -The final command then removes the region named East US from that instance then updates the deployment. - -## PARAMETERS - -### -ApiManagement -Specifies the **PsApiManagement** instance that this cmdlet removes the additional deployment region from. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the region that this cmdlet removes. -Specifies the location of the new deployment region amongst the supported region for Api Management service. -To obtain valid locations, use the cmdlet -Get-AzureRmResourceProvider -ProviderNamespace "Microsoft.ApiManagement" | where {$_.ResourceTypes[0].ResourceTypeName -eq "service"} | Select-Object Locations - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement -Parameters: ApiManagement (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApiManagementRegion](./Add-AzureRmApiManagementRegion.md) - -[Update-AzureRmApiManagementRegion](./Update-AzureRmApiManagementRegion.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementSubscription.md b/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementSubscription.md deleted file mode 100644 index edb772ec05..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementSubscription.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 329EF130-5CC9-4BFF-8561-DE5274018B09 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementsubscription -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementSubscription.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementSubscription.md ---- - -# Remove-AzureRmApiManagementSubscription - -## SYNOPSIS -Deletes an existing subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApiManagementSubscription -Context -SubscriptionId [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AzureRmApiManagementSubscription** cmdlet deletes an existing subscription. - -## EXAMPLES - -### Example 1: Delete a subscription -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Remove-AzureRmApiManagementSubscription -Context $apimContext -SubscriptionId "0123456789" -Force -``` - -This command deletes an existing subscription. - -## PARAMETERS - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a value of $True, if it succeeds, or a value of $false, otherwise. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubscriptionId -Specifies the subscription ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementSubscription](./Get-AzureRmApiManagementSubscription.md) - -[New-AzureRmApiManagementSubscription](./New-AzureRmApiManagementSubscription.md) - -[Set-AzureRmApiManagementSubscription](./Set-AzureRmApiManagementSubscription.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementUser.md b/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementUser.md deleted file mode 100644 index 64c6696b89..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementUser.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 441BC2EE-DBB7-4579-BA64-9D3042B7EBD8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementuser -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementUser.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementUser.md ---- - -# Remove-AzureRmApiManagementUser - -## SYNOPSIS -Deletes an existing user. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApiManagementUser -Context -UserId [-DeleteSubscriptions] - [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AzureRmApiManagementUser** cmdlet deletes an existing user. - -## EXAMPLES - -### Example 1: Delete a user -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Remove-AzureRmApiManagementUser -Context $apimContext -UserId "0123456789" -Force -``` - -This command deletes an existing user. - -## PARAMETERS - -### -Context -Specifies a **PsApiManagementContext** object. -This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeleteSubscriptions -Indicates whether to delete subscriptions to the product. -If this parameter is not specified and a subscription exists, this cmdlet throws an exception. -This parameter is optional. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a value of $Ture, if it succeeds, or a value of $False, otherwise. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserId -Specifies the ID of the user to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementUser](./Get-AzureRmApiManagementUser.md) - -[New-AzureRmApiManagementUser](./New-AzureRmApiManagementUser.md) - -[Set-AzureRmApiManagementUser](./Set-AzureRmApiManagementUser.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementUserFromGroup.md b/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementUserFromGroup.md deleted file mode 100644 index c5736be923..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Remove-AzureRmApiManagementUserFromGroup.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: F0BDB0EE-1F26-450D-9C68-34C79CE8F778 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementuserfromgroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementUserFromGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementUserFromGroup.md ---- - -# Remove-AzureRmApiManagementUserFromGroup - -## SYNOPSIS -Removes a user from a group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApiManagementUserFromGroup -Context -GroupId -UserId - [-PassThru] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Remove-AzureRmApiManagementUserFromGroup** cmdlet removes a user from an existing group. - -## EXAMPLES - -### Example 1: Remove a user from a group -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Remove-AzureRmApiManagementUserFromGroup -Context $apimContext -GroupId "0001" -UserId "0123456789" -``` - -This command removes a user from a group. - -## PARAMETERS - -### -Context -Specifies a **PsApiManagementContext** object. -This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId -Specifies the ID of the group from which to remove a user. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a value of $True, if it succeeds, or a value of $False, otherwise. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserId -Specifies the ID of the user to remove from the group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApiManagementUserToGroup](./Add-AzureRmApiManagementUserToGroup.md) - -[Get-AzureRmApiManagementUser](./Get-AzureRmApiManagementUser.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Restore-AzureRmApiManagement.md b/azurermps-6.13.0/AzureRM.ApiManagement/Restore-AzureRmApiManagement.md deleted file mode 100644 index ce5468864f..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Restore-AzureRmApiManagement.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 022BBF5F-AFF1-45D5-9153-872779FFBAF4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/restore-azurermapimanagement -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Restore-AzureRmApiManagement.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Restore-AzureRmApiManagement.md ---- - -# Restore-AzureRmApiManagement - -## SYNOPSIS -Restores an API Management Service from the specified Azure storage blob. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Restore-AzureRmApiManagement -ResourceGroupName -Name [-StorageContext] - -SourceContainerName -SourceBlobName [-PassThru] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Restore-AzureRmApiManagement** cmdlet restores an API Management Service from the specified backup residing in an Azurestorage blob. - -## EXAMPLES - -### Example 1: Restore an API Management service -``` -PS C:\>New-AzureRmStorageAccount -StorageAccountName "ContosoStorage" -Location $location -ResourceGroupName "ContosoGroup02" -Type Standard_LRS -PS C:\>$storageKey = (Get-AzureRmStorageAccountKey -ResourceGroupName "ContosoGroup02" -StorageAccountName "ContosoStorage")[0].Value -PS C:\>$storageContext = New-AzureStorageContext -StorageAccountName "ContosoStorage" -StorageAccountKey $storageKey -PS C:\>Restore-AzureRmApiManagement -ResourceGroupName "ContosoGroup" -Name "RestoredContosoApi" -StorageContext $StorageContext -SourceContainerName "ContosoBackups" -SourceBlobName "ContosoBackup.apimbackup" -``` - -This command restores an API Management service from Azure storage blob. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the API Management instance that will be restored with the backup. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of resource group under which API Management exists. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceBlobName -Specifies the name of the Azure storage backup source blob. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceContainerName -Specifies the name of the Azure storage backup source container. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageContext -Specifies the storage connection context. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement - -## NOTES - -## RELATED LINKS - -[Backup-AzureRmApiManagement](./Backup-AzureRmApiManagement.md) - -[Get-AzureRmApiManagement](./Get-AzureRmApiManagement.md) - -[New-AzureRmApiManagement](./New-AzureRmApiManagement.md) - -[Remove-AzureRmApiManagement](./Remove-AzureRmApiManagement.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Save-AzureRmApiManagementTenantGitConfiguration.md b/azurermps-6.13.0/AzureRM.ApiManagement/Save-AzureRmApiManagementTenantGitConfiguration.md deleted file mode 100644 index b066e206d7..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Save-AzureRmApiManagementTenantGitConfiguration.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 6221C40F-63FC-4D66-B6BD-01024AFF3B65 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/save-azurermapimanagementtenantgitconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Save-AzureRmApiManagementTenantGitConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Save-AzureRmApiManagementTenantGitConfiguration.md ---- - -# Save-AzureRmApiManagementTenantGitConfiguration - -## SYNOPSIS -Saves changes by creating a commit for current configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Save-AzureRmApiManagementTenantGitConfiguration -Context -Branch [-Force] - [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Save-AzureRmApiManagementTenantGitConfiguration** cmdlet saves the changes by creating a commit that contains the current configuration snapshot to a branch in the repository. - -## EXAMPLES - -### Example 1: Save changes to configuration -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Save-AzureRmApiManagementTenantGitConfiguration -Context $apimContext -Branch 'master' -PassThru -``` - -This command saves the changes by creating a commit with the current configuration snapshot to the specified branch in the repository. - -## PARAMETERS - -### -Branch -Specifies the name of the Git branch in which to commit the current configuration snapshot. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Specifies that this cmdlet commits the current configuration database to the Git repository, even if the Git repository has newer changes that are overwritten. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a **PsApiManagementOperationResult** object. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOperationResult - -## NOTES - -## RELATED LINKS - -[Publish-AzureRmApiManagementTenantGitConfiguration](./Publish-AzureRmApiManagementTenantGitConfiguration.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagement.md b/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagement.md deleted file mode 100644 index d1d0932c78..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagement.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagement -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagement.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagement.md ---- - -# Set-AzureRmApiManagement - -## SYNOPSIS -Updates an Azure Api Management service - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApiManagement -InputObject [-AssignIdentity] [-AsJob] [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -The **Set-AzureRmApiManagement** cmdlet updates an Azure API Management service. - -## EXAMPLES - -### Example 1 Get an API Management service and scale it to Premium and Add a region -```powershell -PS C:\> $apim = Get-AzureRmApiManagement -ResourceGroupName "ContosoGroup" -Name "ContosoApi" -PS C:\> $apim.Sku = "Premium" -PS C:\> $apim.Capacity = 5 -PS C:\> $apim.AddRegion("Central US", "Premium", 3) -PS C:\>Set-AzureRmApiManagement -ApiManagement $apim -``` - -This example gets an Api Management instance, scales it to five premium units and then adds an additional three units to the premium region. - -### Example 2: Update deployment (external VNET) -```powershell -PS C:\> $virtualNetwork = New-AzureRmApiManagementVirtualNetwork -Location "East US" -SubnetResourceId "/subscriptions/a8ff56dc-3bc7-4174-a1e8-3726ab15d0e2/resourceGroups/Api-Default-WestUS/providers/Microsoft.Network/virtualNetworks/dfVirtualNetwork/subnets/backendSubnet" -PS C:\> $apim = Get-AzureRmApiManagement -ResourceGroupName "ContosoGroup" -Name "ContosoApi" -PS C:\> $apim.VpnType = "External" -PS C:\> $apim.VirtualNetwork = $virtualNetwork -PS C:\> Set-AzureRmApiManagement -ApiManagement $apim -``` - -This command updates an existing API Management deployment and joins to an external *VpnType*. - -### Example 3: Create and initialize an instance of PsApiManagementCustomHostNameConfiguration using an Secret from KeyVault Resource -```powershell -PS C:\>$portal = New-AzureRmApiManagementCustomHostnameConfiguration -Hostname "portal.contoso.com" -HostnameType Portal -KeyVaultId "https://apim-test-keyvault.vault.azure.net/secrets/api-portal-custom-ssl.pfx" -PS C:\>$proxy1 = New-AzureRmApiManagementCustomHostnameConfiguration -Hostname "gatewayl.contoso.com" -HostnameType Proxy -KeyVaultId "https://apim-test-keyvault.vault.azure.net/secrets/contoso-proxy-custom-ssl.pfx" -PS C:\>$proxy2 = New-AzureRmApiManagementCustomHostnameConfiguration -Hostname "gatewayl.foobar.com" -HostnameType Proxy -KeyVaultId "https://apim-test-keyvault.vault.azure.net/secrets/foobar-proxy-custom-ssl.pfx" -PS C:\>$proxyCustomConfig = @($proxy1,$proxy2) -PS C:\>$apim = Get-AzureRmApiManagement -ResourceGroupName "ContosoGroup" -Name "ContosoApi" -PS C:\>$apim.PortalCustomHostnameConfiguration = $portal -PS C:\>$apim.ProxyCustomHostnameConfiguration = $proxyCustomConfig -PS C:\>Set-AzureRmApiManagement -InputObject $apim -AssignIdentity -``` - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignIdentity -Generate and assign a Microsoft Entra identity for this server for use with key management services like Azure KeyVault. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The ApiManagement instance. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Sends updated PsApiManagement to pipeline if operation succeeds. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagement](./Get-AzureRmApiManagement.md) - -[New-AzureRmApiManagement](./New-AzureRmApiManagement.md) - -[Remove-AzureRmApiManagement](./Remove-AzureRmApiManagement.md) diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementApi.md b/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementApi.md deleted file mode 100644 index f07b79c2fc..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementApi.md +++ /dev/null @@ -1,307 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 29CCF141-CC2F-4E11-8235-64025CFB5782 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagementapi -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementApi.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementApi.md ---- - -# Set-AzureRmApiManagementApi - -## SYNOPSIS -Modifies an API. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ExpandedParameter (Default) -``` -Set-AzureRmApiManagementApi -Context -ApiId -Name - [-Description ] -ServiceUrl [-Path ] -Protocols - [-AuthorizationServerId ] [-AuthorizationScope ] [-SubscriptionKeyHeaderName ] - [-SubscriptionKeyQueryParamName ] [-PassThru] [-DefaultProfile ] - [] -``` - -### ByInputObject -``` -Set-AzureRmApiManagementApi -InputObject -Name [-Description ] - -ServiceUrl [-Path ] -Protocols [-AuthorizationServerId ] - [-AuthorizationScope ] [-SubscriptionKeyHeaderName ] [-SubscriptionKeyQueryParamName ] - [-PassThru] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Set-AzureRmApiManagementApi** cmdlet modifies an Azure API Management API. - -## EXAMPLES - -### Example 1 Modify an API -```powershell -PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Set-AzureRmApiManagementApi -Context $ApiMgmtContext -Name "EchoApi" -ServiceUrl "https://contoso.com/apis/echo" -Protocols @('https') -Description "Responds with what was sent" -Path "echo" -``` - -## PARAMETERS - -### -ApiId -Specifies the ID of the API to modify. - -```yaml -Type: System.String -Parameter Sets: ExpandedParameter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AuthorizationScope -Specifies the OAuth operations scope. -The default value is $Null. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AuthorizationServerId -Specifies the OAuth authorization server identifier. -The default value is $Null. -You must specify this parameter if *AuthorizationScope* is specified. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: ExpandedParameter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the web API. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -Instance of PsApiManagementApi. This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the web API. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -passthru - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the web API path, which is the last part of the API's public URL. -This URL is used by API consumers to send requests to the web service, and must be one to 400 characters long. -The default value is $Null. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Protocols -Specifies an array of web API protocols. -psdx_paramvalues http and https. -These are the web protocols over which the API is made available. -The default value is $Null. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSchema[] -Parameter Sets: (All) -Aliases: -Accepted values: Http, Https - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceUrl -Specifies the URL of the web service that exposes the API. -This URL is used only by Azure API Management, and is not made public. -The URL must be one to 2000 characters long. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubscriptionKeyHeaderName -Specifies the name of the subscription key header. -The default value is $Null. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubscriptionKeyQueryParamName -Specifies the name of the subscription key query string parameter. -The default value is $Null. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi -Parameters: InputObject (ByValue) - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSchema[] - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi - -## NOTES - -## RELATED LINKS - -[Export-AzureRmApiManagementApi](./Export-AzureRmApiManagementApi.md) - -[Get-AzureRmApiManagementApi](./Get-AzureRmApiManagementApi.md) - -[Import-AzureRmApiManagementApi](./Import-AzureRmApiManagementApi.md) - -[New-AzureRmApiManagementApi](./New-AzureRmApiManagementApi.md) - -[Remove-AzureRmApiManagementApi](./Remove-AzureRmApiManagementApi.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementApiRevision.md b/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementApiRevision.md deleted file mode 100644 index 116ab8e129..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementApiRevision.md +++ /dev/null @@ -1,361 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagementapirevision -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementApiRevision.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementApiRevision.md ---- - -# Set-AzureRmApiManagementApiRevision - -## SYNOPSIS -Modifies an API Revision - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ExpandedParameter (Default) -``` -Set-AzureRmApiManagementApiRevision -ApiRevision -Context -ApiId - -Name [-Description ] -ServiceUrl [-Path ] - -Protocols [-AuthorizationServerId ] [-AuthorizationScope ] - [-SubscriptionKeyHeaderName ] [-SubscriptionKeyQueryParamName ] [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### ByInputObject -``` -Set-AzureRmApiManagementApiRevision -InputObject -Name [-Description ] - -ServiceUrl [-Path ] -Protocols [-AuthorizationServerId ] - [-AuthorizationScope ] [-SubscriptionKeyHeaderName ] [-SubscriptionKeyQueryParamName ] - [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Set-AzureRmApiManagementApiRevision** cmdlet modifies an Azure API Management API Revision. - -## EXAMPLES - -### Example 1 Modify an API Revision -```powershell -PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Set-AzureRmApiManagementApiRevision -Context $ApiMgmtContext -ApiId "echo-api" -ApiRevision "2" -Name "EchoApi" -ServiceUrl "https://contoso.com/apis/echo" -Protocols @('https') -Description "Responds with what was sent" -Path "echo" -``` - -The cmdlet updates the `2` revision of the API `echo-api` with a new description, protocol and path. - -## PARAMETERS - -### -ApiId -Identifier of existing API. -This parameter is required. - -```yaml -Type: System.String -Parameter Sets: ExpandedParameter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApiRevision -Identifier of existing API Revision. This parameter is required. - -```yaml -Type: System.String -Parameter Sets: ExpandedParameter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AuthorizationScope -OAuth operations scope. -This parameter is optional. -Default value is $null. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AuthorizationServerId -OAuth authorization server identifier. -This parameter is optional. -Default value is $null. -Must be specified if AuthorizationScope specified. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Instance of PsApiManagementContext. -This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: ExpandedParameter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Web API description. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -Instance of PsApiManagementApi. This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Web API name. -Public name of the API as it would appear on the developer and admin portals. -This parameter is required. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -If specified then instance of Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi type representing the set API. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Web API Path. -Last part of the API's public URL. -This URL will be used by API consumers for sending requests to the web service. -Must be 1 to 400 characters long. -This parameter is optional. -Default value is $null. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Protocols -Web API protocols (http, https). -Protocols over which API is made available. -This parameter is required. -Default value is $null. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSchema[] -Parameter Sets: (All) -Aliases: -Accepted values: Http, Https - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceUrl -A URL of the web service exposing the API. -This URL will be used by Azure API Management only, and will not be made public. -Must be 1 to 2000 characters long. -This parameter is required. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubscriptionKeyHeaderName -Subscription key header name. -This parameter is optional. -Default value is $null. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubscriptionKeyQueryParamName -Subscription key query string parameter name. -This parameter is optional. -Default value is $null. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi -Parameters: InputObject (ByValue) - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSchema[] - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementApiRevision](./Get-AzureRmApiManagementApiRevision.md) - -[New-AzureRmApiManagementApiRevision](./New-AzureRmApiManagementApiRevision.md) - -[Remove-AzureRmApiManagementApiRevision](./Remove-AzureRmApiManagementApiRevision.md) diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementApiVersionSet.md b/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementApiVersionSet.md deleted file mode 100644 index 35bb294021..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementApiVersionSet.md +++ /dev/null @@ -1,263 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagementapiversionset -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementApiVersionSet.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementApiVersionSet.md ---- - -# Set-AzureRmApiManagementApiVersionSet - -## SYNOPSIS -Updates an API Version Set in the API Management Context. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ExpandedParameter (Default) -``` -Set-AzureRmApiManagementApiVersionSet -Context -ApiVersionSetId - [-Name ] [-Scheme ] [-HeaderName ] [-QueryName ] - [-Description ] [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -### ByInputObject -``` -Set-AzureRmApiManagementApiVersionSet -InputObject [-Name ] - [-Scheme ] [-HeaderName ] [-QueryName ] - [-Description ] [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION - -The **Set-AzureRmApiManagementApiVersionSet** cmdlet modifies an Azure API Management API Version Set. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Set-AzureRmApiManagementApiVersionSet -Context $ApiMgmtContext -ApiVersionSetId "query-verion-set" -Scheme Header -HeaderName "api-version" -Description "Azure version header string" -``` - -This command updates an existing API Version Set with versioning scheme `Header` and Header parameter `api-version`. - -## PARAMETERS - -### -ApiVersionSetId -Identifier for new API Version Set. - -```yaml -Type: System.String -Parameter Sets: ExpandedParameter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Instance of PsApiManagementContext. -This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: ExpandedParameter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Description of the Api Version set. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HeaderName -The Header value which will contain the versioning information. -If versioning Scheme HEADER is choosen, then this value must be specified. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -Instance of PsApiManagementApiVersionSet. This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiVersionSet -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the ApiVersion Set. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -If specified then instance of Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiVersionSet type representing the modified apiVersionSet will be written to output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QueryName -The Query value which will contain the versioning information. -If versioning Scheme Query is choosen, then this value must be specified. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Scheme -Versioning Scheme to select for the Api Versioning Set. -This parameter is optional. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementVersioningScheme -Parameter Sets: (All) -Aliases: -Accepted values: Segment, Query, Header - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiVersionSet -Parameters: InputObject (ByValue) - -### System.String - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementVersioningScheme - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiVersionSet - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementApiVersionSet](./Get-AzureRmApiManagementApiVersionSet.md) - -[New-AzureRmApiManagementApiVersionSet](./New-AzureRmApiManagementApiVersionSet.md) - -[Set-AzureRmApiManagementApiVersionSet](./Set-AzureRmApiManagementApiVersionSet.md) diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementAuthorizationServer.md b/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementAuthorizationServer.md deleted file mode 100644 index 599ad6deff..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementAuthorizationServer.md +++ /dev/null @@ -1,399 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 93005775-3AB9-43C5-B353-45B82124ADB7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagementauthorizationserver -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementAuthorizationServer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementAuthorizationServer.md ---- - -# Set-AzureRmApiManagementAuthorizationServer - -## SYNOPSIS -Modifies an authorization server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApiManagementAuthorizationServer -Context -ServerId -Name - [-Description ] -ClientRegistrationPageUrl -AuthorizationEndpointUrl - -TokenEndpointUrl -ClientId [-ClientSecret ] - [-AuthorizationRequestMethods ] - -GrantTypes - -ClientAuthenticationMethods [-TokenBodyParameters ] - [-SupportState ] [-DefaultScope ] - -AccessTokenSendingMethods [-ResourceOwnerUsername ] - [-ResourceOwnerPassword ] [-PassThru] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Set-AzureRmApiManagementAuthorizationServer** cmdlet modifies Azure API Management authorization server details. - -## EXAMPLES - -### Example 1: Modify an authorization server -``` -PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Set-AzureRmApiManagementAuthrizarionServer -Context $ApiMgmtContext -ServerId 0123456789 -Name "Contoso OAuth2 server" -ClientRegistrationPageUrl "https://contoso/signupv2" -AuthorizationEndpointUrl "https://contoso/authv2" -TokenEndpointUrl "https://contoso/tokenv2" -ClientId "clientid" -ClientSecret "e041ed1b660b4eadbad5a29d066e6e88" -AuthorizationRequestMethods @('Get') -GrantTypes @( 'AuthorizationCode', 'Implicit', 'ClientCredentials') -ClientAuthenticationMethods @('Basic') -TokenBodyParameters @{'par1'='val1'} -AccessTokenSendingMethods @('AuthorizationHeader') -``` - -This command modifies the specified API Management authorization server. - -## PARAMETERS - -### -AccessTokenSendingMethods -Specifies an array of methods to send an access token. -psdx_paramvalues AuthorizationHeader and Query. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementAccessTokenSendingMethod[] -Parameter Sets: (All) -Aliases: -Accepted values: AuthorizationHeader, Query - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AuthorizationEndpointUrl -Specifies the authorization endpoint to authenticate resource owners and obtain authorization grants. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AuthorizationRequestMethods -Specifies an array of authorization request methods. -psdx_paramvalues GET and POST. -The default value is GET. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementAuthorizationRequestMethod[] -Parameter Sets: (All) -Aliases: -Accepted values: Get, Post, Head, Options, Trace, Put, Patch, Delete - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ClientAuthenticationMethods -Specifies an array of client authentication methods. -psdx_paramvalues Basic and Body. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementClientAuthenticationMethod[] -Parameter Sets: (All) -Aliases: -Accepted values: Basic, Body - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ClientId -Specifies the client ID of the developer console that is the client application. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ClientRegistrationPageUrl -Specifies the client registration endpoint to register clients with the authorization server and obtain client credentials. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ClientSecret -Specifies the client secret of the developer console that is the client application. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultScope -Specifies the default scope for the authorization server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Description -Specifies a description for an authorization server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GrantTypes -Specifies an array of grant types. -psdx_paramvalues -- AuthorizationCode -- ClientCredentials -- Implicit -- ResourceOwnerPassword - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGrantType[] -Parameter Sets: (All) -Aliases: -Accepted values: AuthorizationCode, Implicit, ResourceOwnerPassword, ClientCredentials - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the authorization server to modify. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -passthru - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceOwnerPassword -Specifies the resource owner password. -You must specify this parameter if ResourceOwnerPassword is specified by the *GrantTypes* parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceOwnerUsername -Specifies the resource owner user name. -You must specify this parameter if ResourceOwnerPassword is specified by the *GrantTypes* parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerId -Specifies the ID of the authorization server to modify. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SupportState -Indicates whether to support the *State* parameter. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TokenBodyParameters -Specifies additional body parameters using application/x-www-form-urlencoded format. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TokenEndpointUrl -Specifies the token endpoint for clients to obtain access tokens in exchange for presenting authorization grants or refresh tokens. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementAuthorizationRequestMethod[] - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGrantType[] - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementClientAuthenticationMethod[] - -### System.Collections.Hashtable - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementAccessTokenSendingMethod[] - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOAuth2AuthrozationServer - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementAuthorizationServer](./Get-AzureRmApiManagementAuthorizationServer.md) - -[New-AzureRmApiManagementAuthorizationServer](./New-AzureRmApiManagementAuthorizationServer.md) - -[Remove-AzureRmApiManagementAuthorizationServer](./Remove-AzureRmApiManagementAuthorizationServer.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementBackend.md b/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementBackend.md deleted file mode 100644 index 251c33fa2b..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementBackend.md +++ /dev/null @@ -1,329 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagementbackend -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementBackend.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementBackend.md ---- - -# Set-AzureRmApiManagementBackend - -## SYNOPSIS -Updates a Backend. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApiManagementBackend -Context -BackendId [-Protocol ] - [-Url ] [-ResourceId ] [-Title ] [-Description ] - [-SkipCertificateChainValidation ] [-SkipCertificateNameValidation ] - [-Credential ] [-Proxy ] - [-ServiceFabricCluster ] [-PassThru] [-DefaultProfile ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Updates an existing backend in the Api Management. - -## EXAMPLES - -### Updates the Description of the Backend 123 -```powershell -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Set-AzureRmApiManagementBackend -Context $apimContext -BackendId 123 -Description "updated description" -PassThru -``` - -## PARAMETERS - -### -BackendId -Identifier of new backend. -This parameter is required. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Instance of PsApiManagementContext. -This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Credential -Credential details which should be used when talking to the Backend. -This parameter is optional. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackendCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Backend Description. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns the **PsApiManagementBackend** that this cmdlet modifies. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Protocol -Backend Communication protocol (http or soap). -This parameter is optional - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: http, soap - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Proxy -Proxy Server details to be used while sending request to the Backend. -This parameter is optional. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackendProxy -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Management Uri of the Resource in External System. -This parameter is optional. -This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceFabricCluster -Service Fabric Cluster Backend details. This parameter is optional. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementServiceFabric -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkipCertificateChainValidation -Whether to Skip Certificate Chain Validation when talking to the Backend. -This parameter is optional. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkipCertificateNameValidation -Whether to skip Certificate Name Validation when talking to the Backend. -This parameter is optional. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Title -Backend Title. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Url -Runtime Url for the Backend. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackendCredential - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackendProxy - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementServiceFabric - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackend - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementBackend](./Get-AzureRmApiManagementBackend.md) - -[New-AzureRmApiManagementBackend](./New-AzureRmApiManagementBackend.md) - -[New-AzureRmApiManagementBackendCredential](./New-AzureRmApiManagementBackendCredential.md) - -[New-AzureRmApiManagementBackendProxy](./New-AzureRmApiManagementBackendProxy.md) - -[Remove-AzureRmApiManagementBackend](./Remove-AzureRmApiManagementBackend.md) diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementCertificate.md b/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementCertificate.md deleted file mode 100644 index c24048cd58..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementCertificate.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 12FC21EB-0B4E-4275-88FB-7FF42730A6A0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagementcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementCertificate.md ---- - -# Set-AzureRmApiManagementCertificate - -## SYNOPSIS -Modifies an API Management certificate which is configured for mutual authentication with backend. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### LoadFromFile (Default) -``` -Set-AzureRmApiManagementCertificate -Context -CertificateId - -PfxFilePath -PfxPassword [-PassThru] [-DefaultProfile ] - [] -``` - -### Raw -``` -Set-AzureRmApiManagementCertificate -Context -CertificateId - -PfxBytes -PfxPassword [-PassThru] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Set-AzureRmApiManagementCertificate** cmdlet modifies an Azure API Management certificate. - -## EXAMPLES - -### Example 1: Modify a certificate -``` -PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Set-AzureRmApiManagementCertificate -Context $ApiMgmtContext -CertificateId "0123456789" -PfxFilePath "C:\contoso\certificates\apimanagementnew.pfx" -PfxPassword "2222" -``` - -This command modifies the specified API Management certificate. - -## PARAMETERS - -### -CertificateId -Specifies the ID of the certificate to modify. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -passthru - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PfxBytes -Specifies an array of bytes of the certificate file in .pfx format. -This parameter is required if you do not specify the *PfxFilePath* parameter. - -```yaml -Type: System.Byte[] -Parameter Sets: Raw -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PfxFilePath -Specifies the path to the certificate file in .pfx format to create and upload. -This parameter is required if you do not specify the *PfxBytes* parameter. - -```yaml -Type: System.String -Parameter Sets: LoadFromFile -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PfxPassword -Specifies the password for the certificate. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Byte[] - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementCertificate - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementCertificate](./Get-AzureRmApiManagementCertificate.md) - -[New-AzureRmApiManagementCertificate](./New-AzureRmApiManagementCertificate.md) - -[Remove-AzureRmApiManagementCertificate](./Remove-AzureRmApiManagementCertificate.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementGroup.md b/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementGroup.md deleted file mode 100644 index 93bea83e97..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementGroup.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 66D543C0-34F0-47B1-943A-415DECF2155C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagementgroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementGroup.md ---- - -# Set-AzureRmApiManagementGroup - -## SYNOPSIS -Configures an API management group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApiManagementGroup -Context -GroupId [-Name ] - [-Description ] [-PassThru] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Set-AzureRmApiManagementGroup** cmdlet configures an API management group. - -## EXAMPLES - -### Example 1: Configure a management group -```powershell -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Set-AzureRmApiManagementGroup -Context $apimContext -Description "Updated Management Group" -Name "Group0001" -``` - -This command configures a management group named Group0001. - -## PARAMETERS - -### -Context -Specifies an instance of a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies the description of the management group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GroupId -Specifies the identifier of the management group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the management group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -passthru - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGroup - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementGroup](./Get-AzureRmApiManagementGroup.md) - -[New-AzureRmApiManagementGroup](./New-AzureRmApiManagementGroup.md) - -[Remove-AzureRmApiManagementGroup](./Remove-AzureRmApiManagementGroup.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementHostnames.md b/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementHostnames.md deleted file mode 100644 index 6113eba953..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementHostnames.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: F9CE8705-F7B1-45AB-98BC-FC6DC023D38D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagementhostnames -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementHostnames.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementHostnames.md ---- - -# Set-AzureRmApiManagementHostnames - -## SYNOPSIS -Sets a custom hostname configuration for an API Management service proxy or portal. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetSpecificService (Default) -``` -Set-AzureRmApiManagementHostnames -ResourceGroupName -Name - [-PortalHostnameConfiguration ] - [-ProxyHostnameConfiguration ] [-PassThru] - [-DefaultProfile ] [] -``` - -### SetFromPsApiManagementInstance -``` -Set-AzureRmApiManagementHostnames -ApiManagement [-PassThru] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Set-AzureRmApiManagementHostnames** cmdlet applies a custom hostname configuration for an API Management service proxy or portal. - -## EXAMPLES - -### Example 1: Set the custom hostname configuration for a proxy and portal -``` -PS C:\>Set-AzureRmApiManagementHostnames -Name ContosoApi -ResourceGroupName Contoso -PortalHostnameConfiguration $portalHostnameConf -ProxyHostnameConfiguration $proxyHostnameConf -``` - -This command sets the custom hostname configuration for proxy and portal. - -### Example 2: Configure a custom hostname for a proxy and portal -``` -PS C:\>Import-AzureRmApiManagementHostnameCertificate -Name ContosoApi -ResourceGroupName "Contoso" -HostnameType "Proxy" -PfxPath "C:\proxycert.pfx" -PfxPassword "CertSecret" -PS C:\> Import-AzureRmApiManagementHostnameCertificate -Name "ContosoApi" -ResourceGroupName "Contoso" -HostnameType "Portal" -PfxPath "C:\portalcert.pfx" -PfxPassword "CertSecret" -PS C:\> $PortalHostnameConf = New-AzureRmApiManagementHostnameConfiguration -Hostname "portal.contoso.com" -CertificateThumbprint "33CC47C6FCA848DC9B14A6F071C1EF7C" -PS C:\> $ProxyHostnameConf = New-AzureRmApiManagementHostnameConfiguration -Hostname "proxy.contoso.com" -CertificateThumbprint "5DD7CCF6A1E74E0987DD2873406B7264" -PS C:\> Set-AzureRmApiManagementHostnames -Name "ContosoApi" -ResourceGroupName "Contoso" -PortalHostnameConfiguration $PortalHostnameConf -ProxyHostnameConfiguration $ProxyHostnameConf -``` - -This example configures a custom hostname for proxy and portal. -You need to import corresponding certificates and then apply the custom hostnames. - -## PARAMETERS - -### -ApiManagement -Specifies the **PsApiManagement** instance that this cmdlet gets the *PortalHostnameConfiguration* and *ProxyHostnameConfiguration* parameters from. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement -Parameter Sets: SetFromPsApiManagementInstance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the API Management instance. - -```yaml -Type: System.String -Parameter Sets: SetSpecificService -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PortalHostnameConfiguration -Specifies the custom portal hostname configuration. -Passing $null to the cmdlet sets the default hostname. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementHostnameConfiguration -Parameter Sets: SetSpecificService -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProxyHostnameConfiguration -Specifies the custom proxy hostname configuration. -Passing $null sets the default hostname. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementHostnameConfiguration -Parameter Sets: SetSpecificService -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group under which the API Management instance exists. - -```yaml -Type: System.String -Parameter Sets: SetSpecificService -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement -Parameters: ApiManagement (ByValue) - -### System.String - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementHostnameConfiguration - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement - -## NOTES - -## RELATED LINKS - -[Import-AzureRmApiManagementHostnameCertificate](./Import-AzureRmApiManagementHostnameCertificate.md) - -[New-AzureRmApiManagementHostnameConfiguration](./New-AzureRmApiManagementHostnameConfiguration.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementIdentityProvider.md b/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementIdentityProvider.md deleted file mode 100644 index 3747eafcb2..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementIdentityProvider.md +++ /dev/null @@ -1,208 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagementidentityprovider -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementIdentityProvider.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementIdentityProvider.md ---- - -# Set-AzureRmApiManagementIdentityProvider - -## SYNOPSIS -Updates the Configuration of an existing Identity Provider. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApiManagementIdentityProvider -Context - -Type [-ClientId ] [-ClientSecret ] - [-AllowedTenants ] [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -Updates the Configuration of an existing Identity Provider. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\> Set-AzureRmApiManagementIdentityProvider -Context $apimContext -Type Facebook -ClientSecret "updatedSecret" -PassThru -``` - -The cmdlet updates the Client Secret of the Facebook Identity Provider; - -## PARAMETERS - -### -AllowedTenants -List of allowed Microsoft Entra tenants. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ClientId -Client Id of the Application in the external Identity Provider. -It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ClientSecret -Client secret of the Application in external Identity Provider, used to authenticate login request. -For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Instance of PsApiManagementContext. -This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns the **PsApiManagementIdentityProvider** that this cmdlet modifies. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Type -Identifier of an existing Identity Provider. -This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementIdentityProviderType -Parameter Sets: (All) -Aliases: -Accepted values: Facebook, Google, Microsoft, Twitter, Aad, AadB2C - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementIdentityProviderType - -### System.String - -### System.String[] - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementIdentityProvider - -## NOTES - -## RELATED LINKS - -[New-AzureRmApiManagementIdentityProvider](./New-AzureRmApiManagementIdentityProvider.md) - -[Get-AzureRmApiManagementIdentityProvider](./Get-AzureRmApiManagementIdentityProvider.md) - -[Remove-AzureRmApiManagementIdentityProvider](./Remove-AzureRmApiManagementIdentityProvider.md) diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementLogger.md b/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementLogger.md deleted file mode 100644 index 59409d70fc..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementLogger.md +++ /dev/null @@ -1,210 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 5B4ADD38-FA22-4C25-9B9C-FD7861883811 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagementlogger -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementLogger.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementLogger.md ---- - -# Set-AzureRmApiManagementLogger - -## SYNOPSIS -Modifies an API Management Logger. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### EventHubLoggerSet (Default) -``` -Set-AzureRmApiManagementLogger -Context -LoggerId [-Name ] - [-ConnectionString ] [-Description ] [-IsBuffered] [-PassThru] - [-DefaultProfile ] [] -``` - -### ApplicationInsightsLoggerSet -``` -Set-AzureRmApiManagementLogger -Context -LoggerId - [-InstrumentationKey ] [-Description ] [-PassThru] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Set-AzureRmApiManagementLogger** cmdlet modifies settings of an Azure API Management **Logger**. - -## EXAMPLES - -### Example 1: Modify EventHub logger -```powershell -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Set-AzureRmApiManagementLogger -Context $apimContext -LoggerId "Logger123" -Name "ContosoSdkEventHub" -ConnectionString "Endpoint=sb://ContosoSdkEventHubs.servicebus.windows.net/;SharedAccessKeyName=SendKey;SharedAccessKey=" -Description "updated SDK event hub logger" -PassThru -``` - -This command modifies a logger that has the ID Logger123. - -## PARAMETERS - -### -ConnectionString -Specifies an Azure Event Hubs connection string that includes Send policy rights. - -```yaml -Type: System.String -Parameter Sets: EventHubLoggerSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InstrumentationKey -Instrumentation Key of the application Insights. This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: ApplicationInsightsLoggerSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IsBuffered -Specifies that the records in the logger are buffered before publishing. -When records are buffered, they are sent to Event Hubs every 15 seconds, or whenever the buffer receives 256 KB of messages. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: EventHubLoggerSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoggerId -Specifies the ID of the logger to update. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the entity name of an event hub from Azure classic portal. - -```yaml -Type: System.String -Parameter Sets: EventHubLoggerSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns the **PsApiManagementLogger** that this cmdlet modifies. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementLogger - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementLogger](./Get-AzureRmApiManagementLogger.md) - -[New-AzureRmApiManagementLogger](./New-AzureRmApiManagementLogger.md) - -[Remove-AzureRmApiManagementLogger](./Remove-AzureRmApiManagementLogger.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementOpenIdConnectProvider.md b/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementOpenIdConnectProvider.md deleted file mode 100644 index dcded2b940..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementOpenIdConnectProvider.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: F3F21304-CED1-4742-B8BD-2841C4107DCC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagementopenidconnectprovider -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementOpenIdConnectProvider.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementOpenIdConnectProvider.md ---- - -# Set-AzureRmApiManagementOpenIdConnectProvider - -## SYNOPSIS -Modifies an OpenID Connect provider. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApiManagementOpenIdConnectProvider -Context - -OpenIdConnectProviderId [-Name ] [-MetadataEndpointUri ] [-ClientId ] - [-ClientSecret ] [-Description ] [-PassThru] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Set-AzureRmApiManagementOpenIdConnectProvider** cmdlet modifies an OpenID Connect provider in Azure API Management. - -## EXAMPLES - -### Example 1: Change the client secret for a provider -```powershell -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Set-AzureRmApiManagementOpenIdConnectProvider -Context $apimContext -OpenIdConnectProviderId "OICProvicer01" -ClientSecret "q2w3e43r45" -PassThru -``` - -This command modifies the provider that has the ID OICProvicer01. -The command specifies a client secret for the provider. - -## PARAMETERS - -### -ClientId -Specifies the client ID of the developer console. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ClientSecret -Specifies the client secret of the developer console. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MetadataEndpointUri -Specifies a metadata endpoint URI of the provider. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a friendly name for the provider. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OpenIdConnectProviderId -Specifies an ID for the provider that this cmdlet modifies. -If you do not specify an ID, this cmdlet generates one. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns the **PsApiManagementOpenIdConnectProvider** that this cmdlet modifies. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOpenIdConnectProvider - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementOpenIdConnectProvider](./Get-AzureRmApiManagementOpenIdConnectProvider.md) - -[New-AzureRmApiManagementOpenIdConnectProvider](./New-AzureRmApiManagementOpenIdConnectProvider.md) - -[Remove-AzureRmApiManagementOpenIdConnectProvider](./Remove-AzureRmApiManagementOpenIdConnectProvider.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementOperation.md b/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementOperation.md deleted file mode 100644 index 5eca10ff50..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementOperation.md +++ /dev/null @@ -1,272 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 67EE6EFB-3297-4D21-A6EC-B03F5FE82F84 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagementoperation -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementOperation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementOperation.md ---- - -# Set-AzureRmApiManagementOperation - -## SYNOPSIS -Sets API operation details. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApiManagementOperation -Context -ApiId [-ApiRevision ] - -OperationId -Name -Method -UrlTemplate [-Description ] - [-TemplateParameters ] [-Request ] - [-Responses ] [-PassThru] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Set-AzureRmApiManagementOperation** cmdlet sets API operation details. - -## EXAMPLES - -### Example 1: Set the operation details -```powershell -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>New-AzureRmApiManagementOperation -Context $apimContext -ApiId $APIID -OperationId $OperationId -Name "Get Resource" -Method GET -UrlTemplate "/newresource" -Description "Use this operation to get newresource" -``` - -This command sets the operation details for API management. - -## PARAMETERS - -### -ApiId -Specifies the identifier of the API. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApiRevision -Identifier of API Revision. This parameter is optional. If not specified, the operation will be updated in the currently active api revision. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Specifies an instance of **PsApiManagementContext**. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies the description of the new operation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Method -Specifies the HTTP method of the new operation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the display name of the new operation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OperationId -Specifies the identifier of the existing operation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -passthru - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Request -Specifies the operation request details. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementRequest -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Responses -Specifies an array of possible operation responses. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementResponse[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TemplateParameters -Specifies an array or parameters defined in parameter *UrlTemplate*. -If you do not specify a value, a default value will be generated based on the UrlTemplate. -Use the parameter to give more details on parameters such as description, type, and other possible values. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementParameter[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UrlTemplate -Specifies the URL template. -For instance: customers/{cid}/orders/{oid}/?date={date}. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementParameter[] - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementRequest - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementResponse[] - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOperation - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementOperation](./Get-AzureRmApiManagementOperation.md) - -[New-AzureRmApiManagementOperation](./New-AzureRmApiManagementOperation.md) - -[Remove-AzureRmApiManagementOperation](./Remove-AzureRmApiManagementOperation.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementPolicy.md b/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementPolicy.md deleted file mode 100644 index c6cc215d24..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementPolicy.md +++ /dev/null @@ -1,286 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 6CD1C2B8-0416-4FF3-81B0-0C9E59AE6CF9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagementpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementPolicy.md ---- - -# Set-AzureRmApiManagementPolicy - -## SYNOPSIS -Sets the specified scope policy for API Management. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetTenantLevel (Default) -``` -Set-AzureRmApiManagementPolicy -Context [-Format ] [-Policy ] - [-PolicyFilePath ] [-PolicyUrl ] [-PassThru] [-DefaultProfile ] - [] -``` - -### SetProductLevel -``` -Set-AzureRmApiManagementPolicy -Context [-Format ] -ProductId - [-Policy ] [-PolicyFilePath ] [-PolicyUrl ] [-PassThru] - [-DefaultProfile ] [] -``` - -### SetApiLevel -``` -Set-AzureRmApiManagementPolicy -Context [-Format ] -ApiId - [-ApiRevision ] [-Policy ] [-PolicyFilePath ] [-PolicyUrl ] [-PassThru] - [-DefaultProfile ] [] -``` - -### SetOperationLevel -``` -Set-AzureRmApiManagementPolicy -Context [-Format ] -ApiId - [-ApiRevision ] -OperationId [-Policy ] [-PolicyFilePath ] - [-PolicyUrl ] [-PassThru] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Set-AzureRmApiManagementPolicy** cmdlet sets the specified scope policy for API Management. - -## EXAMPLES - -### Example 1: Set the tenant level policy -```powershell -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Set-AzureRmApiManagementPolicy -Context $apimContext -PolicyFilePath "C:\contoso\policies\tenantpolicy.xml" -``` - -This command sets the tenant level policy from a file named tenantpolicy.xml. - -### Example 2: Set a product-scope policy -```powershell -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Set-AzureRmApiManagementPolicy -Context $apimContext -ProductId "0123456789" -Policy $PolicyString -``` - -This command sets the product-scope policy for API Management. - -### Example 3: Set API-scope policy -```powershell -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Set-AzureRmApiManagementPolicy -Context $apimContext -ApiId "9876543210" -Policy $PolicyString -``` - -This command sets API-scope policy for API Management. - -### Example 4: Set operation-scope policy -```powershell -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Set-AzureRmApiManagementPolicy -Context $apimContext -ApiId "9876543210" -OperationId "777" -Policy $PolicyString -``` - -This command sets operation-scope policy for API Management. - -## PARAMETERS - -### -ApiId -Specifies the identifier of the existing API. -If you specify this parameter, the cmdlet sets the API-scope policy. - -```yaml -Type: System.String -Parameter Sets: SetApiLevel, SetOperationLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApiRevision -Identifier of API Revision. This parameter is optional. If not specified, the policy will be updated in the currently active api revision. - -```yaml -Type: System.String -Parameter Sets: SetApiLevel, SetOperationLevel -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Specifies the instance of **PsApiManagementContext**. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Format -Specifies the format of the policy. When using `application/vnd.ms-azure-apim.policy+xml`, -expressions contained within the policy must be XML-escaped. When using `application/vnd.ms-azure-apim.policy.raw+xml` it -is **not** necessary for the policy to be XML-escaped. -The default value is `application/vnd.ms-azure-apim.policy+xml`. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: application/vnd.ms-azure-apim.policy.raw+xml, application/vnd.ms-azure-apim.policy+xml - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OperationId -Specifies the identifier of the existing operation. -If specified with ApiId will set operation-scope policy. -This parameters is required. - -```yaml -Type: System.String -Parameter Sets: SetOperationLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -passthru - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Policy -Specifies the policy document as a string. -This parameter is required if the -*PolicyFilePath* is not specified. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PolicyFilePath -Specifies the policy document file path. -This parameter is required if the *Policy* parameter is not specified. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PolicyUrl -The Url where the Policy document is hosted. This parameter is required if -Policy or -PolicyFilePath is not specified. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProductId -Specifies the identifier of the existing product. -If this parameter is specified, the cmdlet sets the product-scope policy. - -```yaml -Type: System.String -Parameter Sets: SetProductLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementPolicy](./Get-AzureRmApiManagementPolicy.md) - -[Remove-AzureRmApiManagementPolicy](./Remove-AzureRmApiManagementPolicy.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementProduct.md b/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementProduct.md deleted file mode 100644 index c949115c4c..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementProduct.md +++ /dev/null @@ -1,245 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 223FBBA6-4405-4B7A-BA63-5F2434A2A50D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagementproduct -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementProduct.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementProduct.md ---- - -# Set-AzureRmApiManagementProduct - -## SYNOPSIS -Sets the API Management product details. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApiManagementProduct -Context -ProductId [-Title ] - [-Description ] [-LegalTerms ] [-SubscriptionRequired ] [-ApprovalRequired ] - [-SubscriptionsLimit ] [-State ] [-PassThru] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Set-AzureRmApiManagementProduct** cmdlet sets the API Management product details. - -## EXAMPLES - -### Example 1: Update the product details -```powershell -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Set-AzureRmApiManagementProduct -Context $apimContext -ProductId "0123456789" -Title "Starter" -Description "Starter Product" -LegalTerms "Free for all" -SubscriptionRequired $True -State "NotPublished" -``` - -This command updates the API Management product details, requires a subscription, and then unpublishes. - -## PARAMETERS - -### -ApprovalRequired -Indicates whether the subscription to the product requires approval. -The default value is **$False**. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Specifies an instance of the **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies the product description. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LegalTerms -Specifies the legal terms of use of the product. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -passthru - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProductId -Specifies the identifier of the existing product. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -Specifies the product state. -psdx_paramvalues -- NotPublished -- Published - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProductState] -Parameter Sets: (All) -Aliases: -Accepted values: NotPublished, Published - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubscriptionRequired -Indicates whether the product requires a subscription. -The default value for this parameter is **$True**. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubscriptionsLimit -Specifies the maximum number of simultaneous subscriptions. -The default value for this parameter is 1. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Title -Specifies the product title this cmdlet sets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Nullable`1[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProductState, Microsoft.Azure.Commands.ApiManagement.ServiceManagement, Version=6.1.0.0, Culture=neutral, PublicKeyToken=null]] - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProduct - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementProduct](./Get-AzureRmApiManagementProduct.md) - -[New-AzureRmApiManagementProduct](./New-AzureRmApiManagementProduct.md) - -[Remove-AzureRmApiManagementProduct](./Remove-AzureRmApiManagementProduct.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementProperty.md b/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementProperty.md deleted file mode 100644 index 5f9971e6f4..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementProperty.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 5C0C437D-7237-4B40-A254-1B55916F1C71 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagementproperty -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementProperty.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementProperty.md ---- - -# Set-AzureRmApiManagementProperty - -## SYNOPSIS -Modifies an API Management Property. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApiManagementProperty -Context -PropertyId [-Name ] - [-Value ] [-Secret ] [-Tag ] [-PassThru] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Set-AzureRmApiManagementProperty** cmdlet modifies an Azure API Management Property. - -## EXAMPLES - -### Example 1: Change the tags on a property -```powershell -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>$Tags = 'sdk', 'powershell' -PS C:\> Set-AzureRmApiManagementProperty -Context $apimContext -PropertyId "Property11" -Tags $Tags -PassThru -``` - -The first command assigns two values to the $Tags variable. -The second command modifies the property that has the ID Property11. -The command assigns the strings in $Tags as tags on the property. - -### Example 2: Modify a property to have a secret value -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Set-AzureRmApiManagementProperty -Context $apimContext -PropertyId "Property12" -Secret $True -PassThru -``` - -This command changes the property to be Encrypted. - -## PARAMETERS - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the property. -Maximum length is 100 characters. -Names contain only letters, digits, period, dash, and underscore characters. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns the **PsApiManagementProperty** that this cmdlet modifies. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PropertyId -Specifies an ID of the property that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Secret -Indicates that the property value is a secret and should be encrypted. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Tags associated with a property. This parameter is optional. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Value -Specifies a value for the property. -This value can contain policy expressions. -Maximum length is 1000 characters. -The value may not be empty or consist only of whitespace. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.String[] - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProperty - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementProperty](./Get-AzureRmApiManagementProperty.md) - -[New-AzureRmApiManagementProperty](./New-AzureRmApiManagementProperty.md) - -[Remove-AzureRmApiManagementProperty](./Remove-AzureRmApiManagementProperty.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementSubscription.md b/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementSubscription.md deleted file mode 100644 index 27b427c2e1..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementSubscription.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 52115C49-0229-4F2C-B7B0-02FC52C1D32D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagementsubscription -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementSubscription.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementSubscription.md ---- - -# Set-AzureRmApiManagementSubscription - -## SYNOPSIS -Sets existing subscription details. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApiManagementSubscription -Context -SubscriptionId - [-Name ] [-PrimaryKey ] [-SecondaryKey ] [-State ] - [-ExpiresOn ] [-StateComment ] [-PassThru] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Set-AzureRmApiManagementSubscription** cmdlet sets existing subscription details. - -## EXAMPLES - -### Example 1: Set the state and primary and secondary keys for a subscription -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Set-AzureRmApiManagementSubscription -Context $apimContext -SubscriptionId -0123456789 -PrimaryKey "80450f7d0b6d481382113073f67822c1" -SecondaryKey "97d6112c3a8f48d5bf0266b7a09a761c" -State "Active" -``` - -This command sets the primary and secondary keys for a subscription and activates it. - -## PARAMETERS - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpiresOn -Specifies a subscription expiration date. -The default value of this parameter is $Null. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a subscription name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -passthru - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PrimaryKey -Specifies the subscription primary key. -This parameter is generated automatically if not specified. -This parameter must be 1 to 300 characters long. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecondaryKey -Specifies the subscription secondary key. -This parameter is generated automatically if not specified. -This parameter must be 1 to 300 characters long. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -Specifies the subscription state. -The default value of this parameter is $Null. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscriptionState] -Parameter Sets: (All) -Aliases: -Accepted values: Suspended, Active, Expired, Submitted, Rejected, Cancelled - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StateComment -Specifies the subscription state comment. -The default value of this parameter is $Null. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubscriptionId -Specifies the subscription ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Nullable`1[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscriptionState, Microsoft.Azure.Commands.ApiManagement.ServiceManagement, Version=6.1.0.0, Culture=neutral, PublicKeyToken=null]] - -### System.Nullable`1[[System.DateTime, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscription - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementSubscription](./Get-AzureRmApiManagementSubscription.md) - -[New-AzureRmApiManagementSubscription](./New-AzureRmApiManagementSubscription.md) - -[Remove-AzureRmApiManagementSubscription](./Remove-AzureRmApiManagementSubscription.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementTenantAccess.md b/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementTenantAccess.md deleted file mode 100644 index 7bdc6e97d3..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementTenantAccess.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 3B5FC8E3-5A02-4F3B-81F0-51DFE47A201B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagementtenantaccess -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementTenantAccess.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementTenantAccess.md ---- - -# Set-AzureRmApiManagementTenantAccess - -## SYNOPSIS -Enables or disables tenant access. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApiManagementTenantAccess -Context -Enabled [-PassThru] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Set-AzureRmApiManagementTenantAccess** cmdlet enables or disables tenant access. - -## EXAMPLES - -### Example 1: Enable tenant access -``` -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Set-AzureRmApiManagementTenantAccess -Context $apimContext -Enabled $True -``` - -This command enables tenant access in the specified context. - -## PARAMETERS - -### -Context -Specifies a **PsApiManagementContext** object. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Specifies whether this cmdlet enables or disables tenant access. -Specify a value of $True to enable or $False to disable. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns the **PsApiManagementAccessInformation** that this cmdlet modifies. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementAccessInformation - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementTenantAccess](./Get-AzureRmApiManagementTenantAccess.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementUser.md b/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementUser.md deleted file mode 100644 index 8f8e39c7c6..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Set-AzureRmApiManagementUser.md +++ /dev/null @@ -1,232 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 562DE7FA-F2A7-49E9-9273-3C4E2BF8D4B5 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagementuser -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementUser.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementUser.md ---- - -# Set-AzureRmApiManagementUser - -## SYNOPSIS -Sets user details. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApiManagementUser -Context -UserId [-FirstName ] - [-LastName ] [-Email ] [-Password ] [-State ] - [-Note ] [-PassThru] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Set-AzureRmApiManagementUser** cmdlet sets user details. - -## EXAMPLES - -### Example 1: Change a user's password, email address and state -```powershell -PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>$securePassword = ConvertTo-SecureString "qwerty" -AsPlainText -Force -PS C:\>Set-AzureRmApiManagementUser -Context $apimContext -UserId "0123456789" -Email "patti.fuller@contoso.com" -Password $securePassword -State "Blocked" -``` - -This command sets a new user password and email address and blocks the user. - -## PARAMETERS - -### -Context -Specifies a **PsApiManagementContext** object. -This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Email -Specifies the email address of the user. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FirstName -Specifies the first name of the user. -This parameter must be 1 to 100 characters long. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LastName -Specifies the last name of the user. -This parameter is must be 1 to 100 characters long. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Note -Specifies a note about the user. -This parameter is optional. -The default value of this parameter is $null. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -passthru - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Password -Specifies the user password. -This parameter is optional. - -```yaml -Type: System.Security.SecureString -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -Specifies the user state. -This parameter is optional. -The default value is Active. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementUserState -Parameter Sets: (All) -Aliases: -Accepted values: Active, Blocked, Deleted, Pending - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserId -Specifies the user ID. -This parameter is required. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext - -### System.String - -### System.Security.SecureString - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementUserState - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementUser - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementUser](./Get-AzureRmApiManagementUser.md) - -[New-AzureRmApiManagementUser](./New-AzureRmApiManagementUser.md) - -[Remove-AzureRmApiManagementUser](./Remove-AzureRmApiManagementUser.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Update-AzureRmApiManagementApiRelease.md b/azurermps-6.13.0/AzureRM.ApiManagement/Update-AzureRmApiManagementApiRelease.md deleted file mode 100644 index 1971e2196a..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Update-AzureRmApiManagementApiRelease.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/update-azurermapimanagementapirelease -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Update-AzureRmApiManagementApiRelease.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Update-AzureRmApiManagementApiRelease.md ---- - -# Update-AzureRmApiManagementApiRelease - -## SYNOPSIS -Updates a particular Api Release. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ExpandedParameter (Default) -``` -Update-AzureRmApiManagementApiRelease -Context -ReleaseId -ApiId - [-Note ] [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -### ByInputObject -``` -Update-AzureRmApiManagementApiRelease [-Note ] -InputObject [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Update-AzureRmApiManagementApiRelease** cmdlet modifies an Azure API Management API Release. - -## EXAMPLES - -### Example 1: Updates an API Release for an API Revision -```powershell -PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" -PS C:\>Update-AzureRmApiManagementApiRelease -Context $ApiMgmtContext -ApiId "echo-api" -ReleaseId "echo-api-release" -Note "Releasing version 2 of the echo-api to public" -``` - -This command updates the `echo-api-release` API Release of the Api `echo-api` with new note. - -## PARAMETERS - -### -ApiId -Identifier of existing API. -This parameter is required. - -```yaml -Type: System.String -Parameter Sets: ExpandedParameter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Instance of PsApiManagementContext. -This parameter is required. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameter Sets: ExpandedParameter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Instance of type Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiRelease. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiRelease -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Note -Api Release Notes. -This parameter is optional. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -If specified then instance of Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiRelease type representing the set API Release. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReleaseId -Identifier for the Api Revision ReleaseId. -This parameter is required. - -```yaml -Type: System.String -Parameter Sets: ExpandedParameter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext -Parameters: Context (ByValue) - -### System.String - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiRelease - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiRelease - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagementApiRelease](./Get-AzureRmApiManagementApiRelease.md) - -[New-AzureRmApiManagementApiRelease](./New-AzureRmApiManagementApiRelease.md) diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Update-AzureRmApiManagementDeployment.md b/azurermps-6.13.0/AzureRM.ApiManagement/Update-AzureRmApiManagementDeployment.md deleted file mode 100644 index 2ceeb52a78..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Update-AzureRmApiManagementDeployment.md +++ /dev/null @@ -1,289 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 56604912-53A0-496D-9BDC-472BCE45A6A2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/update-azurermapimanagementdeployment -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Update-AzureRmApiManagementDeployment.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Update-AzureRmApiManagementDeployment.md ---- - -# Update-AzureRmApiManagementDeployment - -## SYNOPSIS -Updates deployment of an API Management Service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### UpdateSpecificService (Default) -``` -Update-AzureRmApiManagementDeployment -ResourceGroupName -Name -Location - -Sku -Capacity [-VirtualNetwork ] - [-VpnType ] - [-AdditionalRegions ] - [-PassThru] [-DefaultProfile ] [] -``` - -### UpdateFromPsApiManagementInstance -``` -Update-AzureRmApiManagementDeployment -ApiManagement [-PassThru] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Update-AzureRmApiManagementDeployment** cmdlet updates current deployments of an API Management service. - -## EXAMPLES - -### Example 1: Update a deployment of an ApiManagement instance -```powershell -PS C:\>Update-AzureRmApiManagementDeployment -ResourceGroupName "Contoso" -Name "ContosoApi" -Sku "Standard" -Capacity 3 -``` - -This command updates deployment of an API Management instance to a three unit capacity standard. - -### Example 2: Get an ApiManagement instance and rescale it -```powershell -PS C:\>$ApiManagement = Get-AzureRmApiManagement -ResourceGroupName "Contoso" -Name "ContosoApi" -PS C:\> $ApiManagement.Sku = "Premium" -PS C:\> $ApiManagement.Capacity = 5 -PS C:\> $ApiManagement.AddRegion("Central US", "Premium", 3) -PS C:\> Update-AzureRmApiManagementDeployment -ApiManagement $ApiManagement -``` - -This example gets an Api Management instance, scales it to five premium units and then adds an additional three units to the premium region. - -### Example 3: Update deployment (external VNET) -```powershell -PS C:\> $virtualNetwork = New-AzureRmApiManagementVirtualNetwork -Location "East US" -SubnetResourceId "/subscriptions/a8ff56dc-3bc7-4174-a1e8-3726ab15d0e2/resourceGroups/Api-Default-WestUS/providers/Microsoft.Network/virtualNetworks/dfVirtualNetwork/subnets/backendSubnet" -PS C:\> Update-AzureRmApiManagementDeployment -ResourceGroupName "ContosoGroup" -Name "ContosoApi" -VirtualNetwork $virtualNetwork -VpnType "External" -``` - -This command updates an existing API Management deployment and joins to an external *VpnType*. - -### Example 4: Update deployment (internal VNET) -```powershell -PS C:\> $virtualNetwork = New-AzureRmApiManagementVirtualNetwork -Location "East US" -SubnetResourceId "/subscriptions/a8ff56dc-3bc7-4174-a1e8-3726ab15d0e2/resourceGroups/Api-Default-WestUS/providers/Microsoft.ClassicNetwork/virtualNetworks/dfVirtualNetwork/subnets/backendSubnet" -PS C:\> Update-AzureRmApiManagementDeployment -ResourceGroupName "ContosoGroup" -Name "ContosoApi" -VirtualNetwork $virtualNetwork -VpnType "Internal" -``` - -This command updates an existing API Management deployment and joins to an internal *VpnType*. - -## PARAMETERS - -### -AdditionalRegions -Specifies additional deployment regions of Azure API Management. - -```yaml -Type: System.Collections.Generic.IList`1[Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementRegion] -Parameter Sets: UpdateSpecificService -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApiManagement -Specifies the **PsApiManagement** instance to get deployment configuration from. -Use this parameter if the instance already has all the required changes. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement -Parameter Sets: UpdateFromPsApiManagementInstance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Capacity -Specifies the SKU capacity of the master Azure API Management deployment region. - -```yaml -Type: System.Int32 -Parameter Sets: UpdateSpecificService -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the master API Management deployment region. -To obtain valid locations, use the cmdlet -Get-AzureRmResourceProvider -ProviderNamespace "Microsoft.ApiManagement" | where {$_.ResourceTypes[0].ResourceTypeName -eq "service"} | Select-Object Locations - -```yaml -Type: System.String -Parameter Sets: UpdateSpecificService -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of API Management that this cmdlet updates. - -```yaml -Type: System.String -Parameter Sets: UpdateSpecificService -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of resource group under which API Management exists. - -```yaml -Type: System.String -Parameter Sets: UpdateSpecificService -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -Specifies the tier of the master Azure API Management deployment region. -The acceptable values for this parameter are: -- Developer -- Standard -- Premium - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSku -Parameter Sets: UpdateSpecificService -Aliases: -Accepted values: Developer, Standard, Premium, Basic - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetwork -Specifies the Virtual Network configuration of the master Azure API Management deployment region. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementVirtualNetwork -Parameter Sets: UpdateSpecificService -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VpnType -Specifies the virtual network Type of the API Management deployment. -The acceptable values for this parameter are: -- None. -The API Management deployment is not part of any Virtual Network. -This is the default value. -- External. -The API Management deployment has an external facing virtual address. -- Internal. -The API Management deployment has an intranet facing virtual address. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementVpnType -Parameter Sets: UpdateSpecificService -Aliases: -Accepted values: None, External, Internal - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement -Parameters: ApiManagement (ByValue) - -### System.String - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSku - -### System.Int32 - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementVirtualNetwork - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementVpnType - -### System.Collections.Generic.IList`1[[Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementRegion, Microsoft.Azure.Commands.ApiManagement, Version=6.1.2.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApiManagement](./Get-AzureRmApiManagement.md) - - diff --git a/azurermps-6.13.0/AzureRM.ApiManagement/Update-AzureRmApiManagementRegion.md b/azurermps-6.13.0/AzureRM.ApiManagement/Update-AzureRmApiManagementRegion.md deleted file mode 100644 index bcc274074b..0000000000 --- a/azurermps-6.13.0/AzureRM.ApiManagement/Update-AzureRmApiManagementRegion.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApiManagement.dll-Help.xml -Module Name: AzureRM.ApiManagement -ms.assetid: 5B7B285A-6418-44D7-BD78-E14AFFAA7765 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/update-azurermapimanagementregion -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Update-AzureRmApiManagementRegion.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Update-AzureRmApiManagementRegion.md ---- - -# Update-AzureRmApiManagementRegion - -## SYNOPSIS -Updates existing deployment region in PsApiManagement instance. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Update-AzureRmApiManagementRegion -ApiManagement -Location -Sku - -Capacity [-VirtualNetwork ] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Update-AzureRmApiManagementRegion** cmdlet updates an existing instance of type **Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementRegion** in a collection of **AdditionalRegions** objects of a provided instance of type **Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement**. -This cmdlet does not deploy anything but updates an instance of **PsApiManagement** in-memory. -To update a deployment of an API Management use the modified **PsApiManagementInstance** to the Update-AzureRmApiManagementDeployment cmdlet. - -## EXAMPLES - -## PARAMETERS - -### -ApiManagement -Specifies the **PsApiManagement** instance to update an existing deployment region in. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Capacity -Specifies the new SKU capacity value for the deployment region. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the deployment region to update. -Specifies the location of the new deployment region amongst the supported region for Api Management service. -To obtain valid locations, use the cmdlet -Get-AzureRmResourceProvider -ProviderNamespace "Microsoft.ApiManagement" | where {$_.ResourceTypes[0].ResourceTypeName -eq "service"} | Select-Object Locations - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -Specifies the new tier value for the deployment region. -Valid values are: -- Developer -- Standard -- Premium - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSku -Parameter Sets: (All) -Aliases: -Accepted values: Developer, Standard, Premium, Basic - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetwork -Specifies a virtual network configuration for the deployment region. -Passing $null will remove virtual network configuration for the region. - -```yaml -Type: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementVirtualNetwork -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement -Parameters: ApiManagement (ByValue) - -### System.String - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSku - -### System.Int32 - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementVirtualNetwork - -## OUTPUTS - -### Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApiManagementRegion](./Add-AzureRmApiManagementRegion.md) - -[Remove-AzureRmApiManagementRegion](./Remove-AzureRmApiManagementRegion.md) - -[Update-AzureRmApiManagementDeployment](./Update-AzureRmApiManagementDeployment.md) diff --git a/azurermps-6.13.0/AzureRM.ApplicationInsights/AzureRM.ApplicationInsights.md b/azurermps-6.13.0/AzureRM.ApplicationInsights/AzureRM.ApplicationInsights.md deleted file mode 100644 index f42646d9e2..0000000000 --- a/azurermps-6.13.0/AzureRM.ApplicationInsights/AzureRM.ApplicationInsights.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -Module Name: AzureRM.ApplicationInsights -Module Guid: da67eaa7-4cb1-4bfa-a194-8bf3faae8ac6 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.applicationinsights -Help Version: 0.1.2.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApplicationInsights/Commands.ApplicationInsights/help/AzureRM.ApplicationInsights.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApplicationInsights/Commands.ApplicationInsights/help/AzureRM.ApplicationInsights.md ---- - -# AzureRM.ApplicationInsights Module -## Description -Creates and manages application insights in Azure Resource Manager. - -## AzureRM.ApplicationInsights Cmdlets -### [Get-AzureRmApplicationInsights](Get-AzureRmApplicationInsights.md) -Get application insights resources - -### [Get-AzureRmApplicationInsightsApiKey](Get-AzureRmApplicationInsightsApiKey.md) -Get application insights api keys for an application insights resource - -### [Get-AzureRmApplicationInsightsContinuousExport](Get-AzureRmApplicationInsightsContinuousExport.md) -Get application insights continuous export configuration for an application insights resource - -### [New-AzureRmApplicationInsights](New-AzureRmApplicationInsights.md) -Create a new application insights resource - -### [New-AzureRmApplicationInsightsApiKey](New-AzureRmApplicationInsightsApiKey.md) -Create an application insights api key for an application insights resource - -### [New-AzureRmApplicationInsightsContinuousExport](New-AzureRmApplicationInsightsContinuousExport.md) -Create a new application insights continuous export configuration for an application insights resource - -### [Remove-AzureRmApplicationInsights](Remove-AzureRmApplicationInsights.md) -Remove an application insights resource - -### [Remove-AzureRmApplicationInsightsApiKey](Remove-AzureRmApplicationInsightsApiKey.md) -Remove an application insights api key for an application insights resource - -### [Remove-AzureRmApplicationInsightsContinuousExport](Remove-AzureRmApplicationInsightsContinuousExport.md) -Remove a cotinuous export configuration in an application insights resource - -### [Set-AzureRmApplicationInsightsContinuousExport](Set-AzureRmApplicationInsightsContinuousExport.md) -Update a continuous export configuration in an applciation insights resource - -### [Set-AzureRmApplicationInsightsDailyCap](Set-AzureRmApplicationInsightsDailyCap.md) -Set daily data volume cap for an application insights resource - -### [Set-AzureRmApplicationInsightsPricingPlan](Set-AzureRmApplicationInsightsPricingPlan.md) -Set pricing plan and daily data volume information for an applicaiton insights resource - diff --git a/azurermps-6.13.0/AzureRM.ApplicationInsights/Get-AzureRmApplicationInsights.md b/azurermps-6.13.0/AzureRM.ApplicationInsights/Get-AzureRmApplicationInsights.md deleted file mode 100644 index 86583189ba..0000000000 --- a/azurermps-6.13.0/AzureRM.ApplicationInsights/Get-AzureRmApplicationInsights.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApplicationInsights.dll-Help.xml -Module Name: AzureRM.ApplicationInsights -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.applicationinsights/get-azurermapplicationinsights -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApplicationInsights/Commands.ApplicationInsights/help/Get-AzureRmApplicationInsights.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApplicationInsights/Commands.ApplicationInsights/help/Get-AzureRmApplicationInsights.md ---- - -# Get-AzureRmApplicationInsights - -## SYNOPSIS -Get application insights resources - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceGroupParameterSet (Default) -``` -Get-AzureRmApplicationInsights [[-ResourceGroupName] ] [-DefaultProfile ] - [] -``` - -### ComponentNameParameterSet -``` -Get-AzureRmApplicationInsights [-ResourceGroupName] [-Name] [-Full] - [-DefaultProfile ] [] -``` - -### ResourceIdParameterSet -``` -Get-AzureRmApplicationInsights [-ResourceId] [-Full] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -Get application insights resources in a resource group or specific resource - -## EXAMPLES - -### Example 1 Get application insights resource -``` -PS C:\> Get-AzureRmApplicationInsights -ResourceGroupName "testgroup" -Name "test" - -Id : /subscriptions/{subid}/resourceGroups/testgroup/providers/microsoft.insights/components/test -ResourceGroupName : testgroup -Name : test -Kind : web -Location : eastus -Type : microsoft.insights/components -AppId : 00001111-aaaa-2222-bbbb-3333cccc4444 -ApplicationType : web -Tags : {} -CreationDate : 7/5/2017 4:37:22 PM -FlowType : Redfield -HockeyAppId : -HockeyAppToken : -InstrumentationKey : 1e30d092-4b4b-47c6-ad39-7c10785d80f5 -ProvisioningState : Succeeded -RequestSource : IbizaAIExtension -SamplingPercentage : -TenantId : 00001111-aaaa-2222-bbbb-3333cccc4444 -``` - -Get application insights resource named "test" in resoruce group "testgroup" - -### Example 2 Get application insights resource with pricing plan information -``` -PS C:\> Get-AzureRmApplicationInsights -ResourceGroupName "testgroup" -Name "test" -IncludePricingPlan - -Cap : 330 -ResetTime : 0 -StopSendNotificationWhenHitCap : True -CapExpirationTime : -IsCapped : False -Id : /subscriptions/{subid}/resourceGroups/testgroup/providers/microsoft.insights/components/test -ResourceGroupName : testgroup -Name : test -Kind : web -Location : eastus -Type : microsoft.insights/components -AppId : 00001111-aaaa-2222-bbbb-3333cccc4444 -ApplicationType : web -Tags : {} -CreationDate : 7/5/2017 4:37:22 PM -FlowType : Redfield -HockeyAppId : -HockeyAppToken : -InstrumentationKey : 1e30d092-4b4b-47c6-ad39-7c10785d80f5 -ProvisioningState : Succeeded -RequestSource : IbizaAIExtension -SamplingPercentage : -TenantId : 00001111-aaaa-2222-bbbb-3333cccc4444 -PricingPlan : Basic -``` - -Get application insights resource and include pricing plan information for resource named "test" in resoruce group "testgroup" - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Full -If specified, it will get back pricing plan/daily cap and status of the application insights component. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ComponentNameParameterSet, ResourceIdParameterSet -Aliases: IncludeDailyCap, IncludeDailyCapStatus, IncludePricingPlan - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Application Insights Resource Name. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: ApplicationInsightsComponentName, ComponentName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupParameterSet -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Application Insights Component Resource Id. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ApplicationInsights.Models.PSApplicationInsightsComponent - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ApplicationInsights/Get-AzureRmApplicationInsightsApiKey.md b/azurermps-6.13.0/AzureRM.ApplicationInsights/Get-AzureRmApplicationInsightsApiKey.md deleted file mode 100644 index d2bad16cef..0000000000 --- a/azurermps-6.13.0/AzureRM.ApplicationInsights/Get-AzureRmApplicationInsightsApiKey.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApplicationInsights.dll-Help.xml -Module Name: AzureRM.ApplicationInsights -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.applicationinsights/get-azurermapplicationinsightsapikey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApplicationInsights/Commands.ApplicationInsights/help/Get-AzureRmApplicationInsightsApiKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApplicationInsights/Commands.ApplicationInsights/help/Get-AzureRmApplicationInsightsApiKey.md ---- - -# Get-AzureRmApplicationInsightsApiKey - -## SYNOPSIS -Get application insights api keys for an application insights resource - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ComponentNameParameterSet (Default) -``` -Get-AzureRmApplicationInsightsApiKey [-ResourceGroupName] [-Name] [[-ApiKeyId] ] - [-DefaultProfile ] [] -``` - -### ComponentObjectParameterSet -``` -Get-AzureRmApplicationInsightsApiKey [-ApplicationInsightsComponent] - [[-ApiKeyId] ] [-DefaultProfile ] [] -``` - -### ResourceIdParameterSet -``` -Get-AzureRmApplicationInsightsApiKey [-ResourceId] [[-ApiKeyId] ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -Get application insights api keys for an application insights resource - -## EXAMPLES - -### Example 1 Get Api Keys for an application insights resource -``` -PS C:\> Get-AzureRmApplicationInsightsApiKey -ResourceGroupName "testGroup" -Name "test" - -Id Description Permissions CreatedDate ApiKey --- ----------- ----------- ----------- ------ -7c4c61dc-b392-4aa4-992f-ee92b84e5dee test1 ReadTelemetry Wed, 18 Oct 2017 23:36:40 GMT -63657030-dea6-4c52-82f4-6f5128cb92cb test2 {ReadTelemetry, WriteAnnotations} Wed, 18 Oct 2017 21:46:41 GMT -82549f39-f3ae-492e-8f94-f7aada75fa57 test3 ReadTelemetry Wed, 18 Oct 2017 22:30:23 GMT -``` - -Get application insights api keys for resource "test" in resource group "testGroup". - -### Example 2 Get specific API key for an application insights resource -``` -PS C:\> Get-AzureRmApplicationInsightsApiKey -ResourceGroupName "testGroup" -Name "test" -ApiKeyId -7c4c61dc-b392-4aa4-992f-ee92b84e5dee -ApiKey : -CreatedDate : Wed, 18 Oct 2017 23:36:40 GMT -Id : 7c4c61dc-b392-4aa4-992f-ee92b84e5dee -Permissions : {ReadTelemetry} -Description : test1 -``` - -Get specific application insights api key that id is "dd173f38-4fd1-4c75-8af5-9 -9c29aa0f867" for resource "test" in resource group "testGroup". - -## PARAMETERS - -### -ApiKeyId -Application Insights Api Key Id. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationInsightsComponent -Application Insights Component Object. - -```yaml -Type: Microsoft.Azure.Commands.ApplicationInsights.Models.PSApplicationInsightsComponent -Parameter Sets: ComponentObjectParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Application Insights Component Name. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: ApplicationInsightsComponentName, ComponentName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Application Insights Component Resource Id. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApplicationInsights.Models.PSApplicationInsightsComponent -Parameters: ApplicationInsightsComponent (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ApplicationInsights.Models.PSApiKey - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ApplicationInsights/Get-AzureRmApplicationInsightsContinuousExport.md b/azurermps-6.13.0/AzureRM.ApplicationInsights/Get-AzureRmApplicationInsightsContinuousExport.md deleted file mode 100644 index ac67a1f0e9..0000000000 --- a/azurermps-6.13.0/AzureRM.ApplicationInsights/Get-AzureRmApplicationInsightsContinuousExport.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApplicationInsights.dll-Help.xml -Module Name: AzureRM.ApplicationInsights -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.applicationinsights/get-azurermapplicationinsightscontinuousexport -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApplicationInsights/Commands.ApplicationInsights/help/Get-AzureRmApplicationInsightsContinuousExport.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApplicationInsights/Commands.ApplicationInsights/help/Get-AzureRmApplicationInsightsContinuousExport.md ---- - -# Get-AzureRmApplicationInsightsContinuousExport - -## SYNOPSIS -Get application insights continuous export configuration for an application insights resource - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ComponentNameParameterSet (Default) -``` -Get-AzureRmApplicationInsightsContinuousExport [-ResourceGroupName] [-Name] - [[-ExportId] ] [-DefaultProfile ] [] -``` - -### ComponentObjectParameterSet -``` -Get-AzureRmApplicationInsightsContinuousExport [-ApplicationInsightsComponent] - [[-ExportId] ] [-DefaultProfile ] [] -``` - -### ResourceIdParameterSet -``` -Get-AzureRmApplicationInsightsContinuousExport [-ResourceId] [[-ExportId] ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -Get application insights continuous export configuration for an application insights resource - -## EXAMPLES - -### Example 1 Get continuous export for an application insights resource -``` -PS C:\> Get-AzureRmApplicationInsightsContinuousExport -ResourceGroupName "testgroup" -Name "test" - -ExportId DocumentTypes ExportStatus DestinationStorageAccountId --------- ------------- ------------ --------------------------- -ZJrfffySPdtG3ESn3iRxVIEFuNY= Request, Performance Counter Preparing /subscriptions/{subid}... -``` - -Get application insights continuous export configurations for resource named "test" in resource group "testgroup" - -### Example 2 Get continuous export for an application insights resource -``` -PS C:\> Get-AzureRmApplicationInsightsContinuousExport -ResourceGroupName "testgroup" -Name "test" -ExportId "ZJrfffySPdtG3ESn3iRxVIEFuNY=" - -ExportId : ZJrfffySPdtG3ESn3iRxVIEFuNY= -StorageName : targetaccount -ContainerName : continuousexport -DocumentTypes : Request, Performance Counter -DestinationStorageSubscriptionId : {subid} -DestinationStorageLocationId : eastus -DestinationStorageAccountId : /subscriptions/{subid}/resourceGroups/targetstorage/providers/Microsoft.Storage/storageAccounts/targetaccount -IsEnabled : True -ExportStatus : Preparing -LastSuccessTime : -``` - -Get application insights continuous export configuration with export id "ZJrfffySPdtG3ESn3iRxVIEFuNY=" for resource named "test" in resource group "testgroup" - -## PARAMETERS - -### -ApplicationInsightsComponent -Application Insights Component Object. - -```yaml -Type: Microsoft.Azure.Commands.ApplicationInsights.Models.PSApplicationInsightsComponent -Parameter Sets: ComponentObjectParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExportId -Application Insights Continuous Export Id. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Application Insights Component Name. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: ApplicationInsightsComponentName, ComponentName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Application Insights Component Resource Id. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApplicationInsights.Models.PSApplicationInsightsComponent -Parameters: ApplicationInsightsComponent (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ApplicationInsights.Models.PSExportConfiguration - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ApplicationInsights/New-AzureRmApplicationInsights.md b/azurermps-6.13.0/AzureRM.ApplicationInsights/New-AzureRmApplicationInsights.md deleted file mode 100644 index dad3cb09da..0000000000 --- a/azurermps-6.13.0/AzureRM.ApplicationInsights/New-AzureRmApplicationInsights.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApplicationInsights.dll-Help.xml -Module Name: AzureRM.ApplicationInsights -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.applicationinsights/new-azurermapplicationinsights -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApplicationInsights/Commands.ApplicationInsights/help/New-AzureRmApplicationInsights.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApplicationInsights/Commands.ApplicationInsights/help/New-AzureRmApplicationInsights.md ---- - -# New-AzureRmApplicationInsights - -## SYNOPSIS -Create a new application insights resource - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApplicationInsights [-ResourceGroupName] [-Name] [-Location] - [-Kind ] [-Tag ] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -Create a new application insights resource - -## EXAMPLES - -### Example 1 Create a new application insights resource -``` -PS C:\> New-AzureRmApplicationInsights -Kind java -ResourceGroupName testgroup -Name test1027 -location eastus -Id : /subscriptions/{subid}/resourceGroups/testgroup/providers/microsoft.insights/components/test1027 -ResourceGroupName : testgroup -Name : test1027 -Kind : web -Location : eastus -Type : microsoft.insights/components -AppId : 00001111-aaaa-2222-bbbb-3333cccc4444 -ApplicationType : web -Tags : {} -CreationDate : 10/27/2017 4:56:40 PM -FlowType : -HockeyAppId : -HockeyAppToken : -InstrumentationKey : 083112ed-ed9b-464e-a9b0-8cf126fbfced -ProvisioningState : Succeeded -RequestSource : AzurePowerShell -SamplingPercentage : -TenantId : {subid} -``` - -Add a new application insights resource named as "test" in resource group "testgroup" with kind "java". - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Kind -Application kind. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ApplicationKind -Accepted values: web, other, Node.js, java - -Required: False -Position: Named -Default value: web -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Application Insights Resource Location. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Application Insights Resource Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ApplicationInsightsComponentName, ComponentName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Component Tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.ApplicationInsights.Models.PSApplicationInsightsComponent - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ApplicationInsights/New-AzureRmApplicationInsightsApiKey.md b/azurermps-6.13.0/AzureRM.ApplicationInsights/New-AzureRmApplicationInsightsApiKey.md deleted file mode 100644 index 47e1d11bf6..0000000000 --- a/azurermps-6.13.0/AzureRM.ApplicationInsights/New-AzureRmApplicationInsightsApiKey.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApplicationInsights.dll-Help.xml -Module Name: AzureRM.ApplicationInsights -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.applicationinsights/new-azurermapplicationinsightsapikey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApplicationInsights/Commands.ApplicationInsights/help/New-AzureRmApplicationInsightsApiKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApplicationInsights/Commands.ApplicationInsights/help/New-AzureRmApplicationInsightsApiKey.md ---- - -# New-AzureRmApplicationInsightsApiKey - -## SYNOPSIS -Create an application insights api key for an application insights resource - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ComponentNameParameterSet (Default) -``` -New-AzureRmApplicationInsightsApiKey [-ResourceGroupName] [-Name] [-Permissions] - [-Description] [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### ComponentObjectParameterSet -``` -New-AzureRmApplicationInsightsApiKey [-ApplicationInsightsComponent] - [-Permissions] [-Description] [-DefaultProfile ] [-WhatIf] - [-Confirm] [] -``` - -### ResourceIdParameterSet -``` -New-AzureRmApplicationInsightsApiKey [-ResourceId] [-Permissions] [-Description] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Create an application insights api keys for an application insights resource - -## EXAMPLES - -### Example 1 Create a new Api Key for an application insights resource -``` -PS C:\>$apiKeyDescription="testapiKey" -PS C:\>$permissions = @("ReadTelemetry", "WriteAnnotations") -PS C:\>New-AzureRmApplicationInsightsApiKey -ResourceGroupName "testGroup" -Name "test" -Description $apiKeyDescription -Permissions $permissions - -ApiKey : st0rfelw7m3oimfspozrtwgccxihiftbdwqjdfkg -CreatedDate : Fri, 27 Oct 2017 16:59:19 GMT -Id : 1ed593f9-1561-4981-922d-6917971eecd3 -Permissions : {ReadTelemetry, WriteAnnotations} -Description : testapiKey -``` - -Create application insights api key description as "testapiKey" with permissions "ReadTelemetry", "WriteAnnotations" for resource "test" in resource group "testGroup". - -## PARAMETERS - -### -ApplicationInsightsComponent -Application Insights Component Object. - -```yaml -Type: Microsoft.Azure.Commands.ApplicationInsights.Models.PSApplicationInsightsComponent -Parameter Sets: ComponentObjectParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Description to help identify this API key. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Component Name. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: ApplicationInsightsComponentName, ComponentName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Permissions -Permissions that API key allow apps to do. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: -Accepted values: ReadTelemetry, WriteAnnotations, AuthenticateSDKControlChannel - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Application Insights Component Resource Id. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApplicationInsights.Models.PSApplicationInsightsComponent -Parameters: ApplicationInsightsComponent (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ApplicationInsights.Models.PSApiKey - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ApplicationInsights/New-AzureRmApplicationInsightsContinuousExport.md b/azurermps-6.13.0/AzureRM.ApplicationInsights/New-AzureRmApplicationInsightsContinuousExport.md deleted file mode 100644 index ae15021939..0000000000 --- a/azurermps-6.13.0/AzureRM.ApplicationInsights/New-AzureRmApplicationInsightsContinuousExport.md +++ /dev/null @@ -1,251 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApplicationInsights.dll-Help.xml -Module Name: AzureRM.ApplicationInsights -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.applicationinsights/new-azurermapplicationinsightscontinuousexport -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApplicationInsights/Commands.ApplicationInsights/help/New-AzureRmApplicationInsightsContinuousExport.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApplicationInsights/Commands.ApplicationInsights/help/New-AzureRmApplicationInsightsContinuousExport.md ---- - -# New-AzureRmApplicationInsightsContinuousExport - -## SYNOPSIS -Create a new application insights continuous export configuration for an application insights resource - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ComponentNameParameterSet (Default) -``` -New-AzureRmApplicationInsightsContinuousExport [-ResourceGroupName] [-Name] - -DocumentType -StorageAccountId -StorageLocation -StorageSASUri - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### ComponentObjectParameterSet -``` -New-AzureRmApplicationInsightsContinuousExport [-ApplicationInsightsComponent] - -DocumentType -StorageAccountId -StorageLocation -StorageSASUri - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### ResourceIdParameterSet -``` -New-AzureRmApplicationInsightsContinuousExport [-ResourceId] -DocumentType - -StorageAccountId -StorageLocation -StorageSASUri - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Create a new application insights continuous export configuration for an application insights resource - -## EXAMPLES - -### Example 1 Create a new continuous export configuration for an application insights resource -``` -PS C:\> $sastoken = New-AzureStorageContainerSASToken -Name testcontainer -Context $context -ExpiryTime (Get-Date).AddYears(50) -Permission w -PS C:\> $sasuri = "https://teststorageaccount.blob.core.windows.net/testcontainer" + $sastoken -PS C:\> New-AzureRmApplicationInsightsContinuousExport -ResourceGroupName "testgroup" -Name "test" - -DocumentType "Request","Trace", "Custom Event" -StorageAccountId "/subscriptions/50359d91-7b9d-4823-85af-eb298a61ba96/resourceGroups/testgroup/providers/Microsoft.Storage/storageAccounts/teststorageaccount" -StorageLocation sourcecentralus - -StorageSASUri $sasuri - -ExportId : jlTFEiBg1rkDXOCIeJQ2mB2TxZg= -StorageName : teststorageaccount -ContainerName : testcontainer -DocumentTypes : Request, Custom Event, Trace -DestinationStorageSubscriptionId : 50359d91-7b9d-4823-85af-eb298a61ba96 -DestinationStorageLocationId : sourcecentralus -DestinationStorageAccountId : /subscriptions/50359d91-7b9d-4823-85af-eb298a61ba96/resourceGroups/testgroup/providers/Microsoft.Storage/storageAccounts/teststorageaccount -IsEnabled : True -ExportStatus : Preparing -LastSuccessTime : -``` - -Create a new application insights continuous export configuration to export "Request" and "Trace" document types to storage contain "testcontainer" in storage account "teststorageaccount" in resource group "testgroup". The SAS token have to be valid and have write permission to the container, otherwise continous export feature won't work.If SAS token expired, the continuous export feature will stop working. - -## PARAMETERS - -### -ApplicationInsightsComponent -Application Insights Component Object. - -```yaml -Type: Microsoft.Azure.Commands.ApplicationInsights.Models.PSApplicationInsightsComponent -Parameter Sets: ComponentObjectParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DocumentType -Document types that need exported. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: -Accepted values: Request, Exception, Custom Event, Trace, Metric, Page Load, Page View, Dependency, Availability, Performance Counter - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Component Name. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: ApplicationInsightsComponentName, ComponentName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Application Insights Component Resource Id. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountId -Destination Storage Account Id. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageLocation -Destination Storage Location Id. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageSASUri -Destination Storage SAS Uri. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApplicationInsights.Models.PSApplicationInsightsComponent -Parameters: ApplicationInsightsComponent (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ApplicationInsights.Models.PSExportConfiguration - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ApplicationInsights/Remove-AzureRmApplicationInsights.md b/azurermps-6.13.0/AzureRM.ApplicationInsights/Remove-AzureRmApplicationInsights.md deleted file mode 100644 index 659f20d25c..0000000000 --- a/azurermps-6.13.0/AzureRM.ApplicationInsights/Remove-AzureRmApplicationInsights.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApplicationInsights.dll-Help.xml -Module Name: AzureRM.ApplicationInsights -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.applicationinsights/remove-azurermapplicationinsights -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApplicationInsights/Commands.ApplicationInsights/help/Remove-AzureRmApplicationInsights.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApplicationInsights/Commands.ApplicationInsights/help/Remove-AzureRmApplicationInsights.md ---- - -# Remove-AzureRmApplicationInsights - -## SYNOPSIS -Remove an application insights resource - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ComponentNameParameterSet (Default) -``` -Remove-AzureRmApplicationInsights [-ResourceGroupName] [-Name] [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### ComponentObjectParameterSet -``` -Remove-AzureRmApplicationInsights [-ApplicationInsightsComponent] [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### ResourceIdParameterSet -``` -Remove-AzureRmApplicationInsights [-ResourceId] [-PassThru] [-DefaultProfile ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Remove an application insights resource - -## EXAMPLES - -### Example 1 Remove an application insights resource -``` -PS C:\> Remove-AzureRmApplicationInsights -ResourceGroupName "testgroup" -Name "test" -PassThru -True -``` - -Remove an applciation insights resource named "test" in resource group "testgroup" - -## PARAMETERS - -### -ApplicationInsightsComponent -Application Insights Component Object. - -```yaml -Type: Microsoft.Azure.Commands.ApplicationInsights.Models.PSApplicationInsightsComponent -Parameter Sets: ComponentObjectParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Application Insights Component Name. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: ApplicationInsightsComponentName, ComponentName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -If specified will write true in case operation succeeds. This parameter is optional. Default value is false. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Application Insights Component Resource Id. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApplicationInsights.Models.PSApplicationInsightsComponent -Parameters: ApplicationInsightsComponent (ByValue) - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ApplicationInsights/Remove-AzureRmApplicationInsightsApiKey.md b/azurermps-6.13.0/AzureRM.ApplicationInsights/Remove-AzureRmApplicationInsightsApiKey.md deleted file mode 100644 index 089c934056..0000000000 --- a/azurermps-6.13.0/AzureRM.ApplicationInsights/Remove-AzureRmApplicationInsightsApiKey.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApplicationInsights.dll-Help.xml -Module Name: AzureRM.ApplicationInsights -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.applicationinsights/remove-azurermapplicationinsightsapikey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApplicationInsights/Commands.ApplicationInsights/help/Remove-AzureRmApplicationInsightsApiKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApplicationInsights/Commands.ApplicationInsights/help/Remove-AzureRmApplicationInsightsApiKey.md ---- - -# Remove-AzureRmApplicationInsightsApiKey - -## SYNOPSIS -Remove an application insights api key for an application insights resource - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ComponentNameParameterSet (Default) -``` -Remove-AzureRmApplicationInsightsApiKey [-ResourceGroupName] [-Name] [-ApiKeyId] - [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### ComponentObjectParameterSet -``` -Remove-AzureRmApplicationInsightsApiKey [-ApplicationInsightsComponent] - [-ApiKeyId] [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -### ResourceIdParameterSet -``` -Remove-AzureRmApplicationInsightsApiKey [-ResourceId] [-ApiKeyId] [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Remove an application insights api key for an application insights resource - -## EXAMPLES - -### Example 1 Remove an application insights api key for an application insights resource -``` -Get-AzureRmApplicationInsightsApiKey -ResourceGroupName "testGroup" -Name "test" -ApiKeyId dd173f38-4fd1-4c75-8af5-9 -9c29aa0f867 -PassThru -True -``` - -Remove specific application insights api key that id is "dd173f38-4fd1-4c75-8af5-9 -9c29aa0f867" for resource "test" in resource group "testGroup". - -## PARAMETERS - -### -ApiKeyId -Application Insights API Key ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationInsightsComponent -Application Insights Component Object. - -```yaml -Type: Microsoft.Azure.Commands.ApplicationInsights.Models.PSApplicationInsightsComponent -Parameter Sets: ComponentObjectParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Application Insights Component Name. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: ApplicationInsightsComponentName, ComponentName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -If specified will write true in case operation succeeds. This parameter is optional. Default value is false. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Application Insights Component Resource Id. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApplicationInsights.Models.PSApplicationInsightsComponent -Parameters: ApplicationInsightsComponent (ByValue) - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ApplicationInsights/Remove-AzureRmApplicationInsightsContinuousExport.md b/azurermps-6.13.0/AzureRM.ApplicationInsights/Remove-AzureRmApplicationInsightsContinuousExport.md deleted file mode 100644 index bce2948102..0000000000 --- a/azurermps-6.13.0/AzureRM.ApplicationInsights/Remove-AzureRmApplicationInsightsContinuousExport.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApplicationInsights.dll-Help.xml -Module Name: AzureRM.ApplicationInsights -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.applicationinsights/remove-azurermapplicationinsightscontinuousexport -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApplicationInsights/Commands.ApplicationInsights/help/Remove-AzureRmApplicationInsightsContinuousExport.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApplicationInsights/Commands.ApplicationInsights/help/Remove-AzureRmApplicationInsightsContinuousExport.md ---- - -# Remove-AzureRmApplicationInsightsContinuousExport - -## SYNOPSIS -Remove a cotinuous export configuration in an application insights resource - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ComponentNameParameterSet (Default) -``` -Remove-AzureRmApplicationInsightsContinuousExport [-ResourceGroupName] [-Name] - [-ExportId] [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -### ComponentObjectParameterSet -``` -Remove-AzureRmApplicationInsightsContinuousExport - [-ApplicationInsightsComponent] [-ExportId] [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### ResourceIdParameterSet -``` -Remove-AzureRmApplicationInsightsContinuousExport [-ResourceId] [-ExportId] [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Remove a cotinuous export configuration in an application insights resource - -## EXAMPLES - -### Example 1 Remove a cotinuous export configuration in an application insights resource -``` -PS C:\> Remove-AzureRmApplicationInsightsContinuousExport -ResourceGroupName "testgroup" -Name "test" -ExportId "uGOoki0jQsyEs3IdQ83Q4QsNr4=" -PassThru -True -``` - -Remove application insights continuous export configuration with export id "uGOoki0jQsyEs3IdQ83Q4QsNr4=" for resource named "test" in resource group "testgroup" - -## PARAMETERS - -### -ApplicationInsightsComponent -Application Insights Component Object. - -```yaml -Type: Microsoft.Azure.Commands.ApplicationInsights.Models.PSApplicationInsightsComponent -Parameter Sets: ComponentObjectParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExportId -Application Insights Continuous Export ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Application Insights Component Name. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: ApplicationInsightsComponentName, ComponentName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -If specified will write true in case operation succeeds. This parameter is optional. Default value is false. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Application Insights Component Resource Id. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApplicationInsights.Models.PSApplicationInsightsComponent -Parameters: ApplicationInsightsComponent (ByValue) - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ApplicationInsights/Set-AzureRmApplicationInsightsContinuousExport.md b/azurermps-6.13.0/AzureRM.ApplicationInsights/Set-AzureRmApplicationInsightsContinuousExport.md deleted file mode 100644 index 49723fa85f..0000000000 --- a/azurermps-6.13.0/AzureRM.ApplicationInsights/Set-AzureRmApplicationInsightsContinuousExport.md +++ /dev/null @@ -1,283 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApplicationInsights.dll-Help.xml -Module Name: AzureRM.ApplicationInsights -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.applicationinsights/set-azurermapplicationinsightscontinuousexport -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApplicationInsights/Commands.ApplicationInsights/help/Set-AzureRmApplicationInsightsContinuousExport.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApplicationInsights/Commands.ApplicationInsights/help/Set-AzureRmApplicationInsightsContinuousExport.md ---- - -# Set-AzureRmApplicationInsightsContinuousExport - -## SYNOPSIS -Update a continuous export configuration in an applciation insights resource - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ComponentNameParameterSet (Default) -``` -Set-AzureRmApplicationInsightsContinuousExport [-ResourceGroupName] [-Name] - -ExportId -DocumentType -StorageAccountId -StorageLocation - -StorageSASUri [-DisableConfiguration] [-DefaultProfile ] [-WhatIf] - [-Confirm] [] -``` - -### ComponentObjectParameterSet -``` -Set-AzureRmApplicationInsightsContinuousExport [-ApplicationInsightsComponent] - -ExportId -DocumentType -StorageAccountId -StorageLocation - -StorageSASUri [-DisableConfiguration] [-DefaultProfile ] [-WhatIf] - [-Confirm] [] -``` - -### ResourceIdParameterSet -``` -Set-AzureRmApplicationInsightsContinuousExport [-ResourceId] -ExportId - -DocumentType -StorageAccountId -StorageLocation -StorageSASUri - [-DisableConfiguration] [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Update a continuous export configuration in an applciation insights resource - -## EXAMPLES - -### Example 1 -``` -PS C:\> $sastoken = New-AzureStorageContainerSASToken -Name testcontainer -Context $context -ExpiryTime (Get-Date).AddYears(50) -Permission w -PS C:\> $sasuri = "https://teststorageaccount.blob.core.windows.net/testcontainer" + $sastoken -PS C:\> Set-AzureRmApplicationInsightsContinuousExport -ResourceGroupName "testgroup" -Name "test" - -DocumentTypes "Request","Trace" -ExportId "jlTFEiBg1rkDXOCIeJQ2mB2TxZg=" -DestinationStorageAccountId "/subscriptions/50359d91-7b9d-4823-85af-eb298a61ba96/resourceGroups/testgroup/providers/Microsoft.Storage/storageAccounts/teststorageaccount" -DestinationStorageLocationId sourcecentralus - -DestinationStorageSASUri $sasuri - -ExportId : jlTFEiBg1rkDXOCIeJQ2mB2TxZg= -StorageName : teststorageaccount -ContainerName : testcontainer -DocumentTypes : Request, Custom Event, Trace -DestinationStorageSubscriptionId : 50359d91-7b9d-4823-85af-eb298a61ba96 -DestinationStorageLocationId : sourcecentralus -DestinationStorageAccountId : /subscriptions/50359d91-7b9d-4823-85af-eb298a61ba96/resourceGroups/testgroup/providers/Microsoft.Storage/storageAccounts/teststorageaccount -IsEnabled : True -ExportStatus : Preparing -LastSuccessTime : -``` - -Update continuous export configuration "jlTFEiBg1rkDXOCIeJQ2mB2TxZg=" of resource "test" in resource group "testgroup" to export "Request" and "Trace" documents to storage container "testcontainer" in "teststorageaccount".The SAS token have to be valid and have write permission to the container, otherwise continous export feature won't work. If SAS token expired, the continuous export feature will stop working. - -## PARAMETERS - -### -ApplicationInsightsComponent -Application Insights Component Object. - -```yaml -Type: Microsoft.Azure.Commands.ApplicationInsights.Models.PSApplicationInsightsComponent -Parameter Sets: ComponentObjectParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableConfiguration -Disable continuous export or not. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DocumentType -Document types that need exported. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: -Accepted values: Request, Exception, Custom Event, Trace, Metric, Page Load, Page View, Dependency, Availability, Performance Counter - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExportId -Application Insights Continuous Export Id. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Application Insights Component Name. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: ApplicationInsightsComponentName, ComponentName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Application Insights Component Resource Id. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountId -Destination Storage Account Id. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageLocation -Destination Storage Location Id. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageSASUri -Destination Storage SAS uri. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApplicationInsights.Models.PSApplicationInsightsComponent -Parameters: ApplicationInsightsComponent (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ApplicationInsights.Models.PSExportConfiguration - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ApplicationInsights/Set-AzureRmApplicationInsightsDailyCap.md b/azurermps-6.13.0/AzureRM.ApplicationInsights/Set-AzureRmApplicationInsightsDailyCap.md deleted file mode 100644 index 523311d287..0000000000 --- a/azurermps-6.13.0/AzureRM.ApplicationInsights/Set-AzureRmApplicationInsightsDailyCap.md +++ /dev/null @@ -1,210 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApplicationInsights.dll-Help.xml -Module Name: AzureRM.ApplicationInsights -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.applicationinsights/set-azurermapplicationinsightsdailycap -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApplicationInsights/Commands.ApplicationInsights/help/Set-AzureRmApplicationInsightsDailyCap.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApplicationInsights/Commands.ApplicationInsights/help/Set-AzureRmApplicationInsightsDailyCap.md ---- - -# Set-AzureRmApplicationInsightsDailyCap - -## SYNOPSIS -Set daily data volume cap for an application insights resource - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ComponentNameParameterSet (Default) -``` -Set-AzureRmApplicationInsightsDailyCap [-ResourceGroupName] [-Name] [-DailyCapGB ] - [-DisableNotificationWhenHitCap] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -### ComponentObjectParameterSet -``` -Set-AzureRmApplicationInsightsDailyCap [-ApplicationInsightsComponent] - [-DailyCapGB ] [-DisableNotificationWhenHitCap] [-DefaultProfile ] [-WhatIf] - [-Confirm] [] -``` - -### ResourceIdParameterSet -``` -Set-AzureRmApplicationInsightsDailyCap [-ResourceId] [-DailyCapGB ] - [-DisableNotificationWhenHitCap] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -Set daily data volume cap for an application insights resource - -## EXAMPLES - -### Example 1 Set daily data volume cap for an application insights resource -``` -PS C:\> Set-AzureRmApplicationInsightsDailyCap -ResourceGroupName "testgroup" -Name "test" -DailyCapGB 400 - -DisableNotificationWhenHitCap - - Cap ResetTime StopSendNotificationWhenHitCap ---- --------- ------------------------------ -400 0 True -``` - -Set the daily data volumen cap to 400GB per day and stop send notification when hit cap for resource "test" in resource group "testgroup" - -## PARAMETERS - -### -ApplicationInsightsComponent -Application Insights Component Object. - -```yaml -Type: Microsoft.Azure.Commands.ApplicationInsights.Models.PSApplicationInsightsComponent -Parameter Sets: ComponentObjectParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DailyCapGB -Daily Cap. - -```yaml -Type: System.Nullable`1[System.Double] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableNotificationWhenHitCap -Stop send notification when hit cap. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Application Insights Component Name. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: ApplicationInsightsComponentName, ComponentName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Application Insights Component Resource Id. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApplicationInsights.Models.PSApplicationInsightsComponent -Parameters: ApplicationInsightsComponent (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ApplicationInsights.Models.PSPricingPlan - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ApplicationInsights/Set-AzureRmApplicationInsightsPricingPlan.md b/azurermps-6.13.0/AzureRM.ApplicationInsights/Set-AzureRmApplicationInsightsPricingPlan.md deleted file mode 100644 index 6e88a79ad7..0000000000 --- a/azurermps-6.13.0/AzureRM.ApplicationInsights/Set-AzureRmApplicationInsightsPricingPlan.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ApplicationInsights.dll-Help.xml -Module Name: AzureRM.ApplicationInsights -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.applicationinsights/set-azurermapplicationinsightspricingplan -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApplicationInsights/Commands.ApplicationInsights/help/Set-AzureRmApplicationInsightsPricingPlan.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ApplicationInsights/Commands.ApplicationInsights/help/Set-AzureRmApplicationInsightsPricingPlan.md ---- - -# Set-AzureRmApplicationInsightsPricingPlan - -## SYNOPSIS -Set pricing plan and daily data volume information for an applicaiton insights resource - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ComponentNameParameterSet (Default) -``` -Set-AzureRmApplicationInsightsPricingPlan [-ResourceGroupName] [-Name] - [-PricingPlan ] [-DailyCapGB ] [-DisableNotificationWhenHitCap] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### ComponentObjectParameterSet -``` -Set-AzureRmApplicationInsightsPricingPlan [-ApplicationInsightsComponent] - [-PricingPlan ] [-DailyCapGB ] [-DisableNotificationWhenHitCap] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### ResourceIdParameterSet -``` -Set-AzureRmApplicationInsightsPricingPlan [-ResourceId] [-PricingPlan ] [-DailyCapGB ] - [-DisableNotificationWhenHitCap] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -Set pricing plan and daily data volume information for an applicaiton insights resource - -## EXAMPLES - -### Example 1 Set pricing plan and daily data volume information for an applicaiton insights resource -``` -PS C:\> Set-AzureRmApplicationInsightsDailyCap -ResourceGroupName "testgroup" -Name "test" -PricingPlan "Basic" -DailyCapGB 400 - - Cap ResetTime StopSendNotificationWhenHitCap PricingPlan ---- --------- ------------------------------ ----------- -400 0 False Basic -``` - -Set the pricing plan to "Basic", set the daily data volumen cap to 400GB per day and stop send notification when hit cap for resource "test" in resource group "testgroup" - -## PARAMETERS - -### -ApplicationInsightsComponent -Application Insights Component Object. - -```yaml -Type: Microsoft.Azure.Commands.ApplicationInsights.Models.PSApplicationInsightsComponent -Parameter Sets: ComponentObjectParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DailyCapGB -Daily Cap. - -```yaml -Type: System.Nullable`1[System.Double] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableNotificationWhenHitCap -Stop send notification when hit cap. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Application Insights Component Name. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: ApplicationInsightsComponentName, ComponentName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PricingPlan -Pricing plan name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Basic, Application Insights Enterprise, Limited Basic - -Required: False -Position: Named -Default value: "Basic" -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Application Insights Component Resource Id. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ApplicationInsights.Models.PSApplicationInsightsComponent -Parameters: ApplicationInsightsComponent (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ApplicationInsights.Models.PSPricingPlan - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Automation/AzureRM.Automation.md b/azurermps-6.13.0/AzureRM.Automation/AzureRM.Automation.md deleted file mode 100644 index a6916ed4b5..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/AzureRM.Automation.md +++ /dev/null @@ -1,276 +0,0 @@ ---- -Module Name: AzureRM.Automation -Module Guid: bcea1c70-a32b-48c3-a05c-323e1c02f4d3 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation -Help Version: 4.0.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/AzureRM.Automation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/AzureRM.Automation.md ---- - -# AzureRM.Automation Module -## Description -This topic displays help topics for the Azure Automation Cmdlets. - -## AzureRM.Automation Cmdlets -### [Export-AzureRmAutomationDscConfiguration](Export-AzureRmAutomationDscConfiguration.md) -Exports a DSC configuration from Automation to a local file. - -### [Export-AzureRmAutomationDscNodeReportContent](Export-AzureRmAutomationDscNodeReportContent.md) -Exports the raw content of a DSC report sent from a DSC node to Automation. - -### [Export-AzureRmAutomationRunbook](Export-AzureRmAutomationRunbook.md) -Exports an Automation runbook. - -### [Get-AzureRmAutomationAccount](Get-AzureRmAutomationAccount.md) -Gets Automation accounts in a resource group. - -### [Get-AzureRmAutomationCertificate](Get-AzureRmAutomationCertificate.md) -Gets Automation certificates. - -### [Get-AzureRmAutomationConnection](Get-AzureRmAutomationConnection.md) -Gets an Automation connection. - -### [Get-AzureRmAutomationCredential](Get-AzureRmAutomationCredential.md) -Gets Automation credentials. - -### [Get-AzureRmAutomationDscCompilationJob](Get-AzureRmAutomationDscCompilationJob.md) -Gets DSC compilation jobs in Automation. - -### [Get-AzureRmAutomationDscCompilationJobOutput](Get-AzureRmAutomationDscCompilationJobOutput.md) -Gets the logging streams of an Automation DSC compilation job. - -### [Get-AzureRmAutomationDscConfiguration](Get-AzureRmAutomationDscConfiguration.md) -Gets DSC configurations from Automation. - -### [Get-AzureRmAutomationDscNode](Get-AzureRmAutomationDscNode.md) -Gets DSC nodes from Automation. - -### [Get-AzureRmAutomationDscNodeConfiguration](Get-AzureRmAutomationDscNodeConfiguration.md) -Gets metadata for DSC node configurations in Automation. - -### [Get-AzureRmAutomationDscNodeConfigurationDeployment](Get-AzureRmAutomationDscNodeConfigurationDeployment.md) -Gets DSC Node configuration deployments in Automation. - -### [Get-AzureRmAutomationDscNodeConfigurationDeploymentSchedule](Get-AzureRmAutomationDscNodeConfigurationDeploymentSchedule.md) -Gets a DSC Node configuration deployment job schedule in Automation. - -### [Get-AzureRmAutomationDscNodeReport](Get-AzureRmAutomationDscNodeReport.md) -Gets reports sent from a DSC node to Automation. - -### [Get-AzureRmAutomationDscOnboardingMetaconfig](Get-AzureRmAutomationDscOnboardingMetaconfig.md) -Creates meta-configuration .mof files. - -### [Get-AzureRmAutomationHybridWorkerGroup](Get-AzureRmAutomationHybridWorkerGroup.md) -Gets hybrid runbook worker groups. - -### [Get-AzureRmAutomationJob](Get-AzureRmAutomationJob.md) -Gets Automation runbook jobs. - -### [Get-AzureRmAutomationJobOutput](Get-AzureRmAutomationJobOutput.md) -Gets the output of an Automation job. - -### [Get-AzureRmAutomationJobOutputRecord](Get-AzureRmAutomationJobOutputRecord.md) -Gets the full output of an Automation job output record. - -### [Get-AzureRmAutomationModule](Get-AzureRmAutomationModule.md) -Gets metadata for modules from Automation. - -### [Get-AzureRmAutomationRegistrationInfo](Get-AzureRmAutomationRegistrationInfo.md) -Gets registration information for onboarding a DSC node or hybrid worker to Automation. - -### [Get-AzureRmAutomationRunbook](Get-AzureRmAutomationRunbook.md) -Gets a runbook. - -### [Get-AzureRmAutomationSchedule](Get-AzureRmAutomationSchedule.md) -Gets an Automation schedule. - -### [Get-AzureRmAutomationScheduledRunbook](Get-AzureRmAutomationScheduledRunbook.md) -Gets Automation runbooks and associated schedules. - -### [Get-AzureRmAutomationSoftwareUpdateConfiguration](Get-AzureRmAutomationSoftwareUpdateConfiguration.md) -Gets a list of azure automation software update configurations. - -### [Get-AzureRmAutomationSoftwareUpdateMachineRun](Get-AzureRmAutomationSoftwareUpdateMachineRun.md) -Gets a list of azure automation software update configuration machine runs. - -### [Get-AzureRmAutomationSoftwareUpdateRun](Get-AzureRmAutomationSoftwareUpdateRun.md) -Gets a list of azure automation software update runs. - -### [Get-AzureRmAutomationSourceControl](Get-AzureRmAutomationSourceControl.md) -Gets a list of Azure Automation source controls. - -### [Get-AzureRmAutomationSourceControlSyncJob](Get-AzureRmAutomationSourceControlSyncJob.md) -Gets Azure Automation source control sync jobs. - -### [Get-AzureRmAutomationSourceControlSyncJobOutput](Get-AzureRmAutomationSourceControlSyncJobOutput.md) -Gets the output of an Azure Automation source control sync job. - -### [Get-AzureRmAutomationVariable](Get-AzureRmAutomationVariable.md) -Gets an Automation variable. - -### [Get-AzureRmAutomationWebhook](Get-AzureRmAutomationWebhook.md) -Gets webhooks from Automation. - -### [Import-AzureRmAutomationDscConfiguration](Import-AzureRmAutomationDscConfiguration.md) -Imports a DSC configuration into Automation. - -### [Import-AzureRmAutomationDscNodeConfiguration](Import-AzureRmAutomationDscNodeConfiguration.md) -Imports a MOF document as a DSC node configuration in Automation. - -### [Import-AzureRmAutomationRunbook](Import-AzureRmAutomationRunbook.md) -Imports an Automation runbook. - -### [New-AzureRmAutomationAccount](New-AzureRmAutomationAccount.md) -Creates an Automation account. - -### [New-AzureRmAutomationCertificate](New-AzureRmAutomationCertificate.md) -Creates an Automation certificate. - -### [New-AzureRmAutomationConnection](New-AzureRmAutomationConnection.md) -Creates an Automation connection. - -### [New-AzureRmAutomationCredential](New-AzureRmAutomationCredential.md) -Creates an Automation credential. - -### [New-AzureRmAutomationKey](New-AzureRmAutomationKey.md) -Regenerates registration keys for an Automation account. - -### [New-AzureRmAutomationModule](New-AzureRmAutomationModule.md) -Imports a module into Automation. - -### [New-AzureRmAutomationRunbook](New-AzureRmAutomationRunbook.md) -Creates an Automation runbook. - -### [New-AzureRmAutomationSchedule](New-AzureRmAutomationSchedule.md) -Creates an Automation schedule. - -### [New-AzureRmAutomationSoftwareUpdateConfiguration](New-AzureRmAutomationSoftwareUpdateConfiguration.md) -Creates a scheduled azure automation software update configuration. - -### [New-AzureRmAutomationSourceControl](New-AzureRmAutomationSourceControl.md) -Creates an A Automation source control. - -### [New-AzureRmAutomationVariable](New-AzureRmAutomationVariable.md) -Creates an Automation variable. - -### [New-AzureRmAutomationWebhook](New-AzureRmAutomationWebhook.md) -Creates a webhook for an Automation runbook. - -### [Publish-AzureRmAutomationRunbook](Publish-AzureRmAutomationRunbook.md) -Publishes a runbook. - -### [Register-AzureRmAutomationDscNode](Register-AzureRmAutomationDscNode.md) -Registers an Azure virtual machine as a DSC node for an Automation account. - -### [Register-AzureRmAutomationScheduledRunbook](Register-AzureRmAutomationScheduledRunbook.md) -Associates a runbook to a schedule. - -### [Remove-AzureRmAutomationAccount](Remove-AzureRmAutomationAccount.md) -Removes an Automation account. - -### [Remove-AzureRmAutomationCertificate](Remove-AzureRmAutomationCertificate.md) -Removes an Automation certificate. - -### [Remove-AzureRmAutomationConnection](Remove-AzureRmAutomationConnection.md) -Removes an Automation connection. - -### [Remove-AzureRmAutomationConnectionType](Remove-AzureRmAutomationConnectionType.md) -Removes an Automation connection type. - -### [Remove-AzureRmAutomationCredential](Remove-AzureRmAutomationCredential.md) -Removes an Automation credential. - -### [Remove-AzureRmAutomationDscConfiguration](Remove-AzureRmAutomationDscConfiguration.md) -Removes DSC configurations from Automation. - -### [Remove-AzureRmAutomationDscNodeConfiguration](Remove-AzureRmAutomationDscNodeConfiguration.md) -Removes metadata from DSC node configurations in Automation. - -### [Remove-AzureRmAutomationHybridWorkerGroup](Remove-AzureRmAutomationHybridWorkerGroup.md) -Removes hybrid worker group from Automation. - -### [Remove-AzureRmAutomationModule](Remove-AzureRmAutomationModule.md) -Removes a module from Automation. - -### [Remove-AzureRmAutomationRunbook](Remove-AzureRmAutomationRunbook.md) -Removes a runbook. - -### [Remove-AzureRmAutomationSchedule](Remove-AzureRmAutomationSchedule.md) -Deletes an Automation schedule. - -### [Remove-AzureRmAutomationSoftwareUpdateConfiguration](Remove-AzureRmAutomationSoftwareUpdateConfiguration.md) -Removes an azure automation software update configuration. - -### [Remove-AzureRmAutomationSourceControl](Remove-AzureRmAutomationSourceControl.md) -Removes an Azure Automation source control. - -### [Remove-AzureRmAutomationVariable](Remove-AzureRmAutomationVariable.md) -Removes an Automation variable. - -### [Remove-AzureRmAutomationWebhook](Remove-AzureRmAutomationWebhook.md) -Removes a webhook from an Automation runbook. - -### [Resume-AzureRmAutomationJob](Resume-AzureRmAutomationJob.md) -Resumes a suspended Automation job. - -### [Set-AzureRmAutomationAccount](Set-AzureRmAutomationAccount.md) -Modifies an Automation account. - -### [Set-AzureRmAutomationCertificate](Set-AzureRmAutomationCertificate.md) -Modifies the configuration of an Automation certificate. - -### [Set-AzureRmAutomationConnectionFieldValue](Set-AzureRmAutomationConnectionFieldValue.md) -Modifies the value of a field in an Automation connection. - -### [Set-AzureRmAutomationCredential](Set-AzureRmAutomationCredential.md) -Modifies an Automation credential. - -### [Set-AzureRmAutomationDscNode](Set-AzureRmAutomationDscNode.md) -Modifies the node configuration that a DSC node is mapped to. - -### [Set-AzureRmAutomationModule](Set-AzureRmAutomationModule.md) -Updates a module in Automation. - -### [Set-AzureRmAutomationRunbook](Set-AzureRmAutomationRunbook.md) -Modifies a runbook. - -### [Set-AzureRmAutomationSchedule](Set-AzureRmAutomationSchedule.md) -Modifies an Automation schedule. - -### [Set-AzureRmAutomationVariable](Set-AzureRmAutomationVariable.md) -Modifies an Automation variable. - -### [Set-AzureRmAutomationWebhook](Set-AzureRmAutomationWebhook.md) -Modifies a webhook for an Automation runbook. - -### [Start-AzureRmAutomationDscCompilationJob](Start-AzureRmAutomationDscCompilationJob.md) -Compiles a DSC configuration in Automation. - -### [Start-AzureRmAutomationDscNodeConfigurationDeployment](Start-AzureRmAutomationDscNodeConfigurationDeployment.md) -Deploys a DSC Node configuration in Automation. - -### [Start-AzureRmAutomationRunbook](Start-AzureRmAutomationRunbook.md) -Starts a runbook job. - -### [Start-AzureRmAutomationSourceControlSyncJob](Start-AzureRmAutomationSourceControlSyncJob.md) -Starts an Azure Automation source control sync job. - -### [Stop-AzureRmAutomationDscNodeConfigurationDeployment](Stop-AzureRmAutomationDscNodeConfigurationDeployment.md) -Stops a DSC Node configuration deployment in Automation. It only stops the current deployment job but does not unassign already assigned node configurations. - -### [Stop-AzureRmAutomationJob](Stop-AzureRmAutomationJob.md) -Stops an Automation job. - -### [Suspend-AzureRmAutomationJob](Suspend-AzureRmAutomationJob.md) -Suspends an Automation job. - -### [Unregister-AzureRmAutomationDscNode](Unregister-AzureRmAutomationDscNode.md) -Removes a DSC node from management by an Automation account. - -### [Unregister-AzureRmAutomationScheduledRunbook](Unregister-AzureRmAutomationScheduledRunbook.md) -Removes an association between a runbook and a schedule. - -### [Update-AzureRmAutomationSourceControl](Update-AzureRmAutomationSourceControl.md) -Updates an Azure Automation source control. - diff --git a/azurermps-6.13.0/AzureRM.Automation/Export-AzureRMAutomationRunbook.md b/azurermps-6.13.0/AzureRM.Automation/Export-AzureRMAutomationRunbook.md deleted file mode 100644 index 8e3e89539a..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Export-AzureRMAutomationRunbook.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 0FF88136-4FC9-41F2-A3E6-BFADBAFF4E44 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/export-azurermautomationrunbook -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Export-AzureRMAutomationRunbook.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Export-AzureRMAutomationRunbook.md ---- - -# Export-AzureRmAutomationRunbook - -## SYNOPSIS -Exports an Automation runbook. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Export-AzureRmAutomationRunbook [-Name] [-Slot ] [-OutputFolder ] [-Force] - [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Export-AzureRmAutomationRunbook** cmdlet exports an Azure Automation runbook to a wps_2 script (.ps1 ) file, for wps_2 or wps_2 Workflow runbooks, or to a graphical runbook (.graphrunbook) file, for graphical runbooks. -The name of the runbook becomes the name of the exported file. - -## EXAMPLES - -### Example 1: Export a runbook -``` -PS C:\>Export-AzureRmAutomationRunbook -ResourceGroupName "ResourceGroup01" -AutomationAccountName "ContosoAutomationAccount" -Name "Runbook03" -Slot "Published" -OutputFolder "C:\Users\PattiFuller\Desktop" -``` - -This command exports the published version of an Automation runbook to a user desktop. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account in which this cmdlet exports a runbook. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -ps_force - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the runbook that this cmdlet exports. -The name of the runbook becomes the name of the export file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: RunbookName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OutputFolder -Specifies the path of a folder in which this cmdlet creates the export file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for which this cmdlet exports a runbook. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Slot -Specifies whether this cmdlet exports the draft or published content of the runbook. -Valid values are: -- Published -- Draft - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Published, Draft - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.IO.DirectoryInfo - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationRunbook](./Get-AzureRMAutomationRunbook.md) - -[Import-AzureRmAutomationRunbook](./Import-AzureRMAutomationRunbook.md) - -[New-AzureRmAutomationRunbook](./New-AzureRMAutomationRunbook.md) - -[New-AzureRmAutomationRunbook](./New-AzureRMAutomationRunbook.md) - -[Publish-AzureRmAutomationRunbook](./Publish-AzureRMAutomationRunbook.md) - -[Remove-AzureRmAutomationRunbook](./Remove-AzureRMAutomationRunbook.md) - -[Set-AzureRmAutomationRunbook](./Set-AzureRMAutomationRunbook.md) - -[Start-AzureRmAutomationRunbook](./Start-AzureRMAutomationRunbook.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Export-AzureRmAutomationDscConfiguration.md b/azurermps-6.13.0/AzureRM.Automation/Export-AzureRmAutomationDscConfiguration.md deleted file mode 100644 index e0bff341a4..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Export-AzureRmAutomationDscConfiguration.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 595D3304-3331-4F44-BA57-AE090FB8A132 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/export-azurermautomationdscconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Export-AzureRmAutomationDscConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Export-AzureRmAutomationDscConfiguration.md ---- - -# Export-AzureRmAutomationDscConfiguration - -## SYNOPSIS -Exports a DSC configuration from Automation to a local file. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Export-AzureRmAutomationDscConfiguration -Name [-Slot ] [-OutputFolder ] [-Force] - [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Export-AzureRmAutomationDscConfiguration** cmdlet exports an APS Desired State Configuration (DSC) configuration from Azure Automation to a local file. -The exported file has a .ps1 file name extension. - -## EXAMPLES - -### Example 1: Export the published version of a DSC configuration -``` -PS C:\>Export-AzureRmAutomationDscConfiguration -ResourceGroupName "ResourceGroup01" -AutomationAccountName "AutomationAccount01" -Name "Configuration01" -Slot Published -OutputFolder "C:\Users\PattiFuller\Desktop" -``` - -This command exports the published version of a DSC configuration in Automation to the specified folder, which is the desktop. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account that contains the DSC that this cmdlet exports. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Indicates that this cmdlet replaces an existing local file with a new file that has the same name. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the DSC configuration that this cmdlet exports. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ConfigurationName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OutputFolder -Specifies the output folder where this cmdlet exports the DSC configuration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group for which this cmdlet exports a DSC configuration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Slot -Specifies which version of the DSC configuration that this cmdlet exports. -Valid values are: -- Draft -- Published -The default value is Published. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Published, Draft - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.IO.DirectoryInfo - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationDscConfiguration](./Get-AzureRmAutomationDscConfiguration.md) - -[Import-AzureRmAutomationDscConfiguration](./Import-AzureRmAutomationDscConfiguration.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Export-AzureRmAutomationDscNodeReportContent.md b/azurermps-6.13.0/AzureRM.Automation/Export-AzureRmAutomationDscNodeReportContent.md deleted file mode 100644 index 9f0d7bccd6..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Export-AzureRmAutomationDscNodeReportContent.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 4285EF77-FA70-4BE7-96E0-89E2E8FC5AD6 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/export-azurermautomationdscnodereportcontent -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Export-AzureRmAutomationDscNodeReportContent.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Export-AzureRmAutomationDscNodeReportContent.md ---- - -# Export-AzureRmAutomationDscNodeReportContent - -## SYNOPSIS -Exports the raw content of a DSC report sent from a DSC node to Automation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Export-AzureRmAutomationDscNodeReportContent -NodeId -ReportId [-OutputFolder ] [-Force] - [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Export-AzureRmAutomationDscNodeReportContent** cmdlet exports the raw contents of an APS Desired State Configuration (DSC) report. -A DSC node sends a DSC report to Azure Automation. - -## EXAMPLES - -### Example 1: Export a report from a DSC node -``` -PS C:\>$Node = Get-AzureRmAutomationDscNode -ResourceGroupName "ResourceGroup03" -AutomationAccountName "AutomationAccount01" -Name "Computer14" -PS C:\> $Report = Get-AzureRmAutomationDscNodeReport -ResourceGroupName "ResourceGroup03" -AutomationAccountName "ContosoAutomationAccount" -NodeId $Node.Id -Latest -PS C:\> $Report | Export-AzureRmAutomationDscNodeReportContent -OutputFolder "C:\Users\PattiFuller\Desktop" -``` - -This set of commands exports the latest report from the DSC node named Computer14 to the desktop. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of an Automation account. -This cmdlet exports report content for a DSC node that belongs to the Automation account that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Indicates that this cmdlet replaces an existing local file with a new file that has the same name. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NodeId -Specifies the unique ID of the DSC node for which this cmdlet exports report contents. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OutputFolder -Specifies the output folder where this cmdlet exports report contents. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReportId -Specifies the unique ID of the DSC node report that this cmdlet exports. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. -This cmdlet exports the contents of a report for the DSC node that belongs to the resource group that this cmdlet specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -## OUTPUTS - -### System.IO.DirectoryInfo - -## NOTES - -## RELATED LINKS - -[Export-AzureRmAutomationDscNodeReportContent](./Export-AzureRmAutomationDscNodeReportContent.md) - -[Get-AzureRmAutomationDscNode](./Get-AzureRmAutomationDscNode.md) - -[Get-AzureRmAutomationDscNodeReport](./Get-AzureRmAutomationDscNodeReport.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationCertificate.md b/azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationCertificate.md deleted file mode 100644 index caee2d709d..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationCertificate.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: D690C903-A481-45F2-9D42-1CE2F4184A98 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/get-azurermautomationcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRMAutomationCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRMAutomationCertificate.md ---- - -# Get-AzureRmAutomationCertificate - -## SYNOPSIS -Gets Automation certificates. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByAll (Default) -``` -Get-AzureRmAutomationCertificate [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -### ByCertificateName -``` -Get-AzureRmAutomationCertificate [-Name] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmAutomationCertificate** cmdlet gets one or more Azure Automation certificates. -By default, this cmdlet gets all certificates. -Specify the name of a certificate to get a specific certificate. - -## EXAMPLES - -### Example 1: Get all certificates -``` -PS C:\>Get-AzureRmAutomationCertificate -ResourceGroupName "ResourceGroup07" -AutomationAccountName "Contoso17" -``` - -This command gets metadata for all certificates in the Automation account named Contoso17. - -### Example 2: Get a certificate -``` -PS C:\>Get-AzureRmAutomationCertificate -ResourceGroupName "ResourceGroup07" -AutomationAccountName "Contoso17" -Name "ContosoCertificate" -``` - -This command gets metadata for the certificate named ContosoCertificate. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account for which this cmdlet retrieves a certificate. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a certificate to retrieve. - -```yaml -Type: System.String -Parameter Sets: ByCertificateName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group for which this cmdlet gets an Automation certificate. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.CertificateInfo - -## NOTES - -## RELATED LINKS - -[New-AzureRmAutomationCertificate](./New-AzureRMAutomationCertificate.md) - -[Remove-AzureRmAutomationCertificate](./Remove-AzureRMAutomationCertificate.md) - -[Set-AzureRmAutomationCertificate](./Set-AzureRMAutomationCertificate.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationConnection.md b/azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationConnection.md deleted file mode 100644 index 0a50b55174..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationConnection.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: D12007E8-8693-45B9-8919-CF8A4BA63AAA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/get-azurermautomationconnection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRMAutomationConnection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRMAutomationConnection.md ---- - -# Get-AzureRmAutomationConnection - -## SYNOPSIS -Gets an Automation connection. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByAll (Default) -``` -Get-AzureRmAutomationConnection [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -### ByConnectionName -``` -Get-AzureRmAutomationConnection [-Name] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -### ByConnectionTypeName -``` -Get-AzureRmAutomationConnection [-ConnectionTypeName] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmAutomationConnection** cmdlet gets one or more Azure Automation connections. -By default, this cmdlet retrieves all connections. -Specify the name of a connection to get a specific connection. -Specify the connection type name to get all connections of a specific type. - -## EXAMPLES - -### Example 1: Get all connections -``` -PS C:\>Get-AzureRmAutomationConnection -ResourceGroupName "ResourceGroup01" -AutomationAccountName "Contoso17" -``` - -This command gets metadata for all connections in the Automation account named Contoso17. - -### Example 2: Get all connections of a type -``` -PS C:\>Get-AzureRmAutomationConnection -ResourceGroupName "ResourceGroup01" -AutomationAccountName "Contoso17" -ConnectionTypeName "SqlServer" -``` - -This command gets metadata for connections in the Automation account named Contoso17. -This command gets connections of the type SqlServer. - -### Example 3: Get a connection -``` -PS C:\>Get-AzureRmAutomationConnection -ResourceGroupName "ResourceGroup01" -AutomationAccountName "Contoso17" -Name "ContosoConnection" -``` - -This command gets metadata for the connection named ContosoConnection. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account for which this cmdlet gets connections. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConnectionTypeName -Specifies the name of a connection type for which this cmdlet retrieves connections. - -```yaml -Type: System.String -Parameter Sets: ByConnectionTypeName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a connection that this cmdlet retrieves. - -```yaml -Type: System.String -Parameter Sets: ByConnectionName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group for which this cmdlet gets connections. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.Connection - -## NOTES - -## RELATED LINKS - -[New-AzureRmAutomationConnection](./New-AzureRMAutomationConnection.md) - -[Remove-AzureRmAutomationConnection](./Remove-AzureRMAutomationConnection.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationCredential.md b/azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationCredential.md deleted file mode 100644 index 92e0bf81fe..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationCredential.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: DAFB709D-A6F2-4645-8A9E-F8D95669E02F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/get-azurermautomationcredential -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRMAutomationCredential.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRMAutomationCredential.md ---- - -# Get-AzureRmAutomationCredential - -## SYNOPSIS -Gets Automation credentials. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByAll (Default) -``` -Get-AzureRmAutomationCredential [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -### ByName -``` -Get-AzureRmAutomationCredential [-Name] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmAutomationCredential** cmdlet gets one or more Azure Automation credentials. -By default, all credentials are returned. -Specify the name of a credential to get a specific credential. -For security purposes, this cmdlet does not return credential passwords. - -## EXAMPLES - -### Example 1: Get all credentials -``` -PS C:\>Get-AzureRmAutomationCredential -ResourceGroupName "ResourceGroup01" -AutomationAccountName "Contoso17" -``` - -This command gets metadata for all credentials in the Automation account named Contoso17. - -### Example 2: Get a credential -``` -PS C:\>Get-AzureRmAutomationCredential -ResourceGroupName "ResourceGroup01" -AutomationAccountName "Contoso17" -Name "ContosoCredential" -``` - -This command gets metadata for the credential named ContosoCredential in the Automation account named Contoso17. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account for which this cmdlet retrieves credentials. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a credential to retrieve. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group for which this cmdlet retrieves credentials. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.CredentialInfo - -## NOTES - -## RELATED LINKS - -[New-AzureRmAutomationCredential](./New-AzureRMAutomationCredential.md) - -[Remove-AzureRmAutomationCredential](./Remove-AzureRMAutomationCredential.md) - -[Set-AzureRmAutomationCredential](./Set-AzureRMAutomationCredential.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationHybridWorkerGroup.md b/azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationHybridWorkerGroup.md deleted file mode 100644 index 890dac1002..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationHybridWorkerGroup.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 9B0BBBB4-A7A0-4243-9264-362A00F5B399 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/get-azurermautomationhybridworkergroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRMAutomationHybridWorkerGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRMAutomationHybridWorkerGroup.md ---- - -# Get-AzureRmAutomationHybridWorkerGroup - -## SYNOPSIS -Gets hybrid runbook worker groups. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByAll (Default) -``` -Get-AzureRmAutomationHybridWorkerGroup [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -### ByName -``` -Get-AzureRmAutomationHybridWorkerGroup [[-Name] ] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmAutomationHybridWorkerGroup** cmdlet gets Azure Automation hybrid runbook worker groups. -To get a specific group, specify its name. - -## EXAMPLES - -### Example 1: Get all hybrid runbook worker groups -``` -PS C:\>Get-AzureRMAutomationHybridWorkerGroup -ResourceGroupName "ResourceGroupName01" -AutomationAccountName "Contoso17" -``` - -This command gets all hybrid runbook worker groups in the Automation account named Contoso17. - -### Example 2: Get a single hybrid runbook worker group -``` -PS C:\>Get-AzureRMAutomationHybridWorkerGroup -ResourceGroupName "ResourceGroupName01" -AutomationAccountName "Contoso17" -Name "HybridRunbookWorkerGroup01" -``` - -This command gets the hybrid runbook worker group named HybridRunbookWorkerGroup01 in the Automation account named Contoso17. - -### Example 3: Get the workers in a hybrid runbook worker group -``` -PS C:\>(Get-AzureRMAutomationHybridWorker -ResourceGroupName ResourceGroupName01 -AutomationAccountName Contoso17 -Name "HybridRunbookWorkerGroup01" ).RunbookWorker -``` - -This command gets the hybrid runbook workers in the hybrid runbook worker group named HybridRunbookWorkerGroup01 in the Automation account named Contoso17. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of an Automation account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the hybrid runbook worker group name. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: Group - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: Name (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.HybridRunbookWorkerGroup - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationJob.md b/azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationJob.md deleted file mode 100644 index 9c749c8198..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationJob.md +++ /dev/null @@ -1,230 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: BD32B909-296B-4E46-A24F-6E2BD4B9764B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/get-azurermautomationjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRMAutomationJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRMAutomationJob.md ---- - -# Get-AzureRmAutomationJob - -## SYNOPSIS -Gets Automation runbook jobs. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByAll (Default) -``` -Get-AzureRmAutomationJob [-Status ] [-StartTime ] [-EndTime ] - [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] - [] -``` - -### ByJobId -``` -Get-AzureRmAutomationJob -Id [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -### ByRunbookName -``` -Get-AzureRmAutomationJob -RunbookName [-Status ] [-StartTime ] - [-EndTime ] [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmAutomationJob** cmdlet gets runbook jobs in Azure Automation. - -## EXAMPLES - -### Example 1: Get a specific runbook job -``` -PS C:\>Get-AzureRmAutomationJob -AutomationAccountName "Contoso17" -Id 2989b069-24fe-40b9-b3bd-cb7e5eac4b647 -``` - -This command gets the job that has the specified GUID. - -### Example 2: Get all jobs for a runbook -``` -PS C:\>Get-AzureRmAutomationJob -AutomationAccountName "Contoso17" -ResourceGroupName "ResourceGroup01" -RunbookName "Runbook02" -``` - -This command gets all jobs associated with a runbook named Runbook02. - -### Example 3: Get all running jobs -``` -PS C:\>Get-AzureRmAutomationJob -AutomationAccountName "Contoso17" -ResourceGroupName "ResourceGroup01" -Status "Running" -``` - -This command gets all running jobs in the Automation account named Contoso17. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of an Automation account for which this cmdlet gets jobs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndTime -Specifies the end time for a job as a **DateTimeOffset** object. -You can specify a string that can be converted to a valid **DateTimeOffset**. -This cmdlet gets jobs that have an end time at or before the value that this parameter specifies. - -```yaml -Type: System.Nullable`1[System.DateTimeOffset] -Parameter Sets: ByAll, ByRunbookName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of a job that this cmdlet gets. - -```yaml -Type: System.Guid -Parameter Sets: ByJobId -Aliases: JobId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group in which this cmdlet gets jobs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RunbookName -Specifies the name of a runbook for which this cmdlet gets jobs. - -```yaml -Type: System.String -Parameter Sets: ByRunbookName -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Specifies the start time of a job as a **DateTimeOffset** object. -This cmdlet gets jobs that have a start time at or after the value that this parameter specifies. - -```yaml -Type: System.Nullable`1[System.DateTimeOffset] -Parameter Sets: ByAll, ByRunbookName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Status -Specifies the status of a job. -This cmdlet gets jobs that have a status matching this parameter. -Valid values are: -- Activating -- Completed -- Failed -- Queued -- Resuming -- Running -- Starting -- Stopped -- Stopping -- Suspended -- Suspending - -```yaml -Type: System.String -Parameter Sets: ByAll, ByRunbookName -Aliases: -Accepted values: Completed, Failed, Queued, Starting, Resuming, Running, Stopped, Stopping, Suspended, Suspending, Activating - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.Job - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationJobOutput](./Get-AzureRMAutomationJobOutput.md) - -[Resume-AzureRmAutomationJob](./Resume-AzureRMAutomationJob.md) - -[Stop-AzureRmAutomationJob](./Stop-AzureRMAutomationJob.md) - -[Suspend-AzureRmAutomationJob](./Suspend-AzureRMAutomationJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationJobOutput.md b/azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationJobOutput.md deleted file mode 100644 index 68ade80133..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationJobOutput.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: B39C4D6B-392A-4C8D-A6FB-886DA1A2BA58 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/get-azurermautomationjoboutput -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRMAutomationJobOutput.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRMAutomationJobOutput.md ---- - -# Get-AzureRmAutomationJobOutput - -## SYNOPSIS -Gets the output of an Automation job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmAutomationJobOutput [-Id] [-Stream ] [-StartTime ] - [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Get-AzureRmAutomationJobOutput** cmdlet gets the output of an Azure Automation job. - -## EXAMPLES - -### Example 1: Get the output of an Automation job -``` -PS C:\>Get-AzureRmAutomationJobOutput -AutomationAccountName "Contoso17" -Id 2989b069-24fe-40b9-b3bd-cb7e5eac4b64 -ResourceGroupName "ResourceGroup01" -Stream "Any" -``` - -This command gets all of the output of the job that has the specified ID. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of an Automation account for which this cmdlet gets job output. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of a job for which this cmdlet gets output. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: JobId - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group for which this cmdlet gets job output. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartTime -Specifies a start time as a **DateTimeOffset** object. -You can specify a string that can be converted to a valid **DateTimeOffset**. -The cmdlet retrieves output created after this time. - -```yaml -Type: System.Nullable`1[System.DateTimeOffset] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Stream -Specifies the type of output. -Valid values are: -- Any -- Debug -- Error -- Output -- Progress -- Verbose -- Warning - -```yaml -Type: Microsoft.Azure.Commands.Automation.Common.StreamType -Parameter Sets: (All) -Aliases: -Accepted values: Any, Progress, Output, Warning, Error, Debug, Verbose - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### Microsoft.Azure.Commands.Automation.Common.StreamType - -### System.Nullable`1[[System.DateTimeOffset, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.JobStream - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationJob](./Get-AzureRMAutomationJob.md) - -[Resume-AzureRmAutomationJob](./Resume-AzureRMAutomationJob.md) - -[Stop-AzureRmAutomationJob](./Stop-AzureRMAutomationJob.md) - -[Suspend-AzureRmAutomationJob](./Suspend-AzureRMAutomationJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationRunbook.md b/azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationRunbook.md deleted file mode 100644 index a30a3c8c9e..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationRunbook.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: EDB918EA-4FF3-44EF-A4CA-5BFBD14340EA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/get-azurermautomationrunbook -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRMAutomationRunbook.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRMAutomationRunbook.md ---- - -# Get-AzureRmAutomationRunbook - -## SYNOPSIS -Gets a runbook. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByAll (Default) -``` -Get-AzureRmAutomationRunbook [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -### ByRunbookName -``` -Get-AzureRmAutomationRunbook [-Name] [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmAutomationRunbook** cmdlet gets Azure Automation runbooks. -To get a specific runbook, specify its name. - -## EXAMPLES - -### Example 1: Get all runbooks -``` -PS C:\>Get-AzureRmAutomationRunbook -AutomationAccountName "Contoso17" -ResourceGroupName "ResourceGroup01" -``` - -This command gets all runbooks in the Azure Automation account named Contoso17. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of an Automation account in which this cmdlet gets runbooks. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a runbook that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: ByRunbookName -Aliases: RunbookName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for which this cmdlet gets runbooks. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.Runbook - -## NOTES - -## RELATED LINKS - -[Export-AzureRmAutomationRunbook](./Export-AzureRMAutomationRunbook.md) - -[Import-AzureRmAutomationRunbook](./Import-AzureRMAutomationRunbook.md) - -[New-AzureRmAutomationRunbook](./New-AzureRMAutomationRunbook.md) - -[New-AzureRmAutomationRunbook](./New-AzureRMAutomationRunbook.md) - -[Publish-AzureRmAutomationRunbook](./Publish-AzureRMAutomationRunbook.md) - -[Remove-AzureRmAutomationRunbook](./Remove-AzureRMAutomationRunbook.md) - -[Set-AzureRmAutomationRunbook](./Set-AzureRMAutomationRunbook.md) - -[Start-AzureRmAutomationRunbook](./Start-AzureRMAutomationRunbook.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationSchedule.md b/azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationSchedule.md deleted file mode 100644 index 48f40d01ee..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationSchedule.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 2908890B-7A46-41B7-931F-AE94638D1EDF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/get-azurermautomationschedule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRMAutomationSchedule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRMAutomationSchedule.md ---- - -# Get-AzureRmAutomationSchedule - -## SYNOPSIS -Gets an Automation schedule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByAll (Default) -``` -Get-AzureRmAutomationSchedule [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -### ByName -``` -Get-AzureRmAutomationSchedule [-Name] [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmAutomationSchedule** cmdlet gets an Azure Automation schedule. - -## EXAMPLES - -### Example 1: Get a schedule -``` -PS C:\>Get-AzureRmAutomationSchedule -AutomationAccountName "Contoso17" -Name "DailySchedule08" -ResourceGroupName "ResourceGroup01" -``` - -This command gets the schedule named DailySchedule08. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of an Automation account for which this cmdlet get a schedule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a schedule that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: ScheduleName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group for which this cmdlet gets a schedule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.Schedule - -## NOTES - -## RELATED LINKS - -[New-AzureRmAutomationSchedule](./New-AzureRMAutomationSchedule.md) - -[Remove-AzureRmAutomationSchedule](./Remove-AzureRMAutomationSchedule.md) - -[Set-AzureRmAutomationSchedule](./Set-AzureRMAutomationSchedule.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationScheduledRunbook.md b/azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationScheduledRunbook.md deleted file mode 100644 index cb8af73856..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationScheduledRunbook.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: EE854F8A-4B6B-4831-992A-6EC318BEE234 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/get-azurermautomationscheduledrunbook -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRMAutomationScheduledRunbook.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRMAutomationScheduledRunbook.md ---- - -# Get-AzureRmAutomationScheduledRunbook - -## SYNOPSIS -Gets Automation runbooks and associated schedules. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByAll (Default) -``` -Get-AzureRmAutomationScheduledRunbook [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -### ByJobScheduleId -``` -Get-AzureRmAutomationScheduledRunbook -JobScheduleId [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -### ByRunbookName -``` -Get-AzureRmAutomationScheduledRunbook -RunbookName [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -### ByRunbookNameAndScheduleName -``` -Get-AzureRmAutomationScheduledRunbook -RunbookName -ScheduleName - [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] - [] -``` - -### ByScheduleName -``` -Get-AzureRmAutomationScheduledRunbook -ScheduleName [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmAutomationScheduledRunbook** cmdlet gets one or more Azure Automation runbooks and associated schedules. -By default, this cmdlet gets all scheduled runbooks. -Specify the name of a runbook or a schedule or both to see specific runbook schedules. - -## EXAMPLES - -### Example 1: Get all scheduled runbooks -``` -PS C:\>Get-AzureRmAutomationScheduledRunbook -AutomationAccountName "Contoso17" -ResourceGroupName "ResourceGroup01" -``` - -This command gets all scheduled runbooks in the Azure Automation account named Contoso17. - -### Example 2: Get all schedules associated with a runbook -``` -PS C:\>Get-AzureRmAutomationScheduledRunbook -AutomationAccountName "Contoso17" -ResourceGroupName "ResourceGroup01" -RunbookName "Runbk01" -``` - -This command gets all scheduled runbooks for the runbook Runbk01 in the Azure Automation account named Contoso17. - -### Example 3: Get all runbooks associated with a schedule -``` -PS C:\>Get-AzureRmAutomationScheduledRunbook -AutomationAccountName "Contoso17" -ResourceGroupName "ResourceGroup01" -ScheduleName "Schedule01" -``` - -This command gets all scheduled runbooks for the schedule Schedule01 in the Azure Automation account named Contoso17. - -## PARAMETERS - -### -AutomationAccountName -Specifies an Automation account for the runbook on which this cmdlet operates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobScheduleId -Specifies the ID of a scheduled job that this cmdlet gets. - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: ByJobScheduleId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group for scheduled runbooks that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RunbookName -Specifies the name of a runbook for which this cmdlet gets scheduled runbooks. - -```yaml -Type: System.String -Parameter Sets: ByRunbookName, ByRunbookNameAndScheduleName -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScheduleName -Specifies the name of a schedule for which this cmdlet gets scheduled runbooks. - -```yaml -Type: System.String -Parameter Sets: ByRunbookNameAndScheduleName, ByScheduleName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.JobSchedule - -## NOTES - -## RELATED LINKS - -[Register-AzureRmAutomationScheduledRunbook](./Register-AzureRMAutomationScheduledRunbook.md) - -[Unregister-AzureRmAutomationScheduledRunbook](./Unregister-AzureRMAutomationScheduledRunbook.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationVariable.md b/azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationVariable.md deleted file mode 100644 index ada66df23f..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationVariable.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 8FB78A4A-8392-44EE-A907-10FDF756071B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/get-azurermautomationvariable -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRMAutomationVariable.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRMAutomationVariable.md ---- - -# Get-AzureRmAutomationVariable - -## SYNOPSIS -Gets an Automation variable. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByAll (Default) -``` -Get-AzureRmAutomationVariable [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -### ByName -``` -Get-AzureRmAutomationVariable [-Name] [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmAutomationVariable** cmdlet gets one or more Azure Automation variables. -To get a specific variable, specify its name. - -## EXAMPLES - -### Example 1: Get a variable -``` -PS C:\>$Variable = Get-AzureRmAutomationVariable -AutomationAccountName "Contoso17" -Name "Variable06" -ResourceGroupName "ResourceGroup01" -PS C:\> $Value = $Variable.value -``` - -The first command gets an Automation variable named Variable06 in the account named Contoso17. -The command stores that object in the $Variable variable. -The second command uses standard dot notation to refer to the **value** property of $Variable. -The command stores the value in the $value variable. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account that contains the variables that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a variable that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group for which this cmdlet gets variables. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.Variable - -## NOTES - -## RELATED LINKS - -[New-AzureRmAutomationVariable](./New-AzureRMAutomationVariable.md) - -[Remove-AzureRmAutomationVariable](./Remove-AzureRMAutomationVariable.md) - -[Set-AzureRmAutomationVariable](./Set-AzureRMAutomationVariable.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationWebhook.md b/azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationWebhook.md deleted file mode 100644 index 7e8226182d..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRMAutomationWebhook.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: A0A956E9-6C4F-4432-A39F-A180CD519C04 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/get-azurermautomationwebhook -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRMAutomationWebhook.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRMAutomationWebhook.md ---- - -# Get-AzureRmAutomationWebhook - -## SYNOPSIS -Gets webhooks from Automation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByAll (Default) -``` -Get-AzureRmAutomationWebhook [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -### ByName -``` -Get-AzureRmAutomationWebhook -Name [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -### ByRunbookName -``` -Get-AzureRmAutomationWebhook -RunbookName [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmAutomationWebhook** cmdlet gets webhooks. -To get specific webhooks, specify a webhook name or specify the name of an Azure Automation runbook to get the webhooks connected to it. - -## EXAMPLES - -### Example 1: Get all webhooks for a runbook -``` -PS C:\>Get-AzureRmAutomationWebhook -RunbookName "Runbook03" -ResourceGroup "ResourceGroup01" -AutomationAccountName "AutomationAccount01" -``` - -This command gets all webhooks for a runbook named Runbook03 in the Automation account named AutomationAccount01 in the resource group named ResourceGroup01. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of an Automation account in which this cmdlet gets a webhook. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the webhook that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: WebhookName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for which this cmdlet gets webhooks. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RunbookName -Specifies the name of a runbook for which this cmdlet gets webhooks. - -```yaml -Type: System.String -Parameter Sets: ByRunbookName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.Webhook - -## NOTES - -## RELATED LINKS - -[New-AzureRmAutomationWebhook](./New-AzureRMAutomationWebhook.md) - -[Remove-AzureRmAutomationWebhook](./Remove-AzureRMAutomationWebhook.md) - -[Set-AzureRmAutomationWebhook](./Set-AzureRMAutomationWebhook.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationAccount.md b/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationAccount.md deleted file mode 100644 index bc976f21fd..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationAccount.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: B32A8423-A7AA-418E-A95D-6C18566741AB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/get-azurermautomationaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationAccount.md ---- - -# Get-AzureRmAutomationAccount - -## SYNOPSIS -Gets Automation accounts in a resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByAll (Default) -``` -Get-AzureRmAutomationAccount [[-ResourceGroupName] ] [-DefaultProfile ] - [] -``` - -### ByAutomationAccountName -``` -Get-AzureRmAutomationAccount [-ResourceGroupName] [-Name] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmAutomationAccount** cmdlet gets Azure Automation accounts in a resource group. -For more information about Automation accounts, see the New-AzureRmAutomationAccount cmdlet. - -## EXAMPLES - -### Example 1: Get all accounts -``` -PS C:\>Get-AzureRmAutomationAccount -ResourceGroupName "ResourceGroup03" -``` - -This command gets all Automation accounts in the resource group named ResourceGroup03. - -### Example 2: Get an account -``` -PS C:\>Get-AzureRmAutomationAccount -ResourceGroupName "ResourceGroup03" -Name "ContosoAutomationAccount" -``` - -This command gets the Automation account named ContosoAutomationAccount in the resource group named ContosoResourceGroup. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Automation account that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: ByAutomationAccountName -Aliases: AutomationAccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group in which this cmdlet gets Automation accounts. - -```yaml -Type: System.String -Parameter Sets: ByAll -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ByAutomationAccountName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.AutomationAccount - -## NOTES - -## RELATED LINKS - -[New-AzureRmAutomationAccount](./New-AzureRmAutomationAccount.md) - -[Remove-AzureRmAutomationAccount](./Remove-AzureRmAutomationAccount.md) - -[Set-AzureRmAutomationAccount](./Set-AzureRmAutomationAccount.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscCompilationJob.md b/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscCompilationJob.md deleted file mode 100644 index f979438315..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscCompilationJob.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: D704BAC0-D89E-4F15-ACF8-FA2C1F0D1B8F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/get-azurermautomationdsccompilationjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationDscCompilationJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationDscCompilationJob.md ---- - -# Get-AzureRmAutomationDscCompilationJob - -## SYNOPSIS -Gets DSC compilation jobs in Automation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByAll (Default) -``` -Get-AzureRmAutomationDscCompilationJob [-Status ] [-StartTime ] - [-EndTime ] [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -### ByJobId -``` -Get-AzureRmAutomationDscCompilationJob -Id [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -### ByConfigurationName -``` -Get-AzureRmAutomationDscCompilationJob -ConfigurationName [-Status ] - [-StartTime ] [-EndTime ] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmAutomationDscCompilationJob** cmdlet gets APS Desired State Configuration (DSC) compilation jobs in Azure Automation. - -## EXAMPLES - -### Example 1: Get all DSC compilation jobs -``` -PS C:\>Get-AzureRmAutomationDscCompilationJob -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -``` - -This command gets all compilation jobs in the Automation account named Contoso17. - -### Example 2: Get DSC compilation jobs for a configuration -``` -PS C:\>Get-AzureRmAutomationDscCompilationJob -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -ConfigurationName "ContosoConfiguration" -``` - -This command gets all compilation jobs for the DSC configuration named ContosoConfiguration in the Automation account named Contoso17. - -### Example 3: Get a specific DSC compilation job -``` -PS C:\>Get-AzureRmAutomationDscCompilationJob -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -Id c0a1718e-d8be-4fa3-91b6-82e1d3a36298 -``` - -This command gets the compilation job with the specified ID in the Automation account named Contoso17. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account that contains DSC compilation jobs that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConfigurationName -Specifies the name of the DSC configuration for which this cmdlet gets compilation jobs. - -```yaml -Type: System.String -Parameter Sets: ByConfigurationName -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndTime -Specifies an end time. -This cmdlet gets compilations jobs that started up to the time that this parameter specifies. - -```yaml -Type: System.Nullable`1[System.DateTimeOffset] -Parameter Sets: ByAll, ByConfigurationName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the unique ID of the DSC compilation job that this cmdlet gets. - -```yaml -Type: System.Guid -Parameter Sets: ByJobId -Aliases: JobId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group in which this cmdlet gets DSC compilation jobs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartTime -Specifies a start time. -This cmdlet gets jobs that start at or after the time that this parameter specifies. - -```yaml -Type: System.Nullable`1[System.DateTimeOffset] -Parameter Sets: ByAll, ByConfigurationName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Status -Specifies the status of jobs that this cmdlet gets. -Valid values are: -- Completed -- Failed -- Queued -- Starting -- Resuming -- Running -- Stopped -- Stopping -- Suspended -- Suspending -- Activating -- New - -```yaml -Type: System.String -Parameter Sets: ByAll, ByConfigurationName -Aliases: -Accepted values: Completed, Failed, Queued, Starting, Resuming, Running, Stopped, Stopping, Suspended, Suspending, Activating, New - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.CompilationJob - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationDscCompilationJobOutput](./Get-AzureRmAutomationDscCompilationJobOutput.md) - -[Start-AzureRmAutomationDscCompilationJob](./Start-AzureRmAutomationDscCompilationJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscCompilationJobOutput.md b/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscCompilationJobOutput.md deleted file mode 100644 index 3c753eaeb5..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscCompilationJobOutput.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: D40BA2E2-50DF-4D51-A4D2-2D02AECBF20F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/get-azurermautomationdsccompilationjoboutput -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationDscCompilationJobOutput.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationDscCompilationJobOutput.md ---- - -# Get-AzureRmAutomationDscCompilationJobOutput - -## SYNOPSIS -Gets the logging streams of an Automation DSC compilation job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmAutomationDscCompilationJobOutput [-Id] [-Stream ] - [-StartTime ] [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmAutomationDscCompilationJobOutput** cmdlet gets the stream records of an APS Desired State Configuration (DSC) compilation job in Azure Automation. - -## EXAMPLES - -### Example 1: Get the logs for a DSC compilation job -``` -PS C:\>$Jobs = Get-AzureRmAutomationDscCompilationJob -ResourceGroupName "ResourceGroup01" -AutomationAccountName "Contoso17" -PS C:\> $Jobs[0] | Get-AzureRmAutomationDscCompilationJobOutput -Stream "Any" -``` - -The first command gets the compilation jobs in the Automation account named Contoso17 by using the Get-AzureRmAutomationDscCompilationJob cmdlet. -The command stores those objects in the $Jobs variable. -The second command gets the compilation job output for any stream for the first member of the $Jobs array. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account that contains the DSC compilation job. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the unique ID of the DSC compilation job for which this cmdlet gets output. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: JobId - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the DSC compilation job for which this cmdlet gets stream records. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartTime -Specifies a start time. -This cmdlet gets stream records that the DSC compilation job outputs after this time. - -```yaml -Type: System.Nullable`1[System.DateTimeOffset] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Stream -Specifies the type of stream for the output that this cmdlet gets. -Valid values are: -- Any -- Warning -- Error -- Verbose - -```yaml -Type: Microsoft.Azure.Commands.Automation.Common.CompilationJobStreamType -Parameter Sets: (All) -Aliases: -Accepted values: Warning, Error, Verbose, Any - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### Microsoft.Azure.Commands.Automation.Common.CompilationJobStreamType - -### System.Nullable`1[[System.DateTimeOffset, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.JobStream - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationDscCompilationJob](./Get-AzureRmAutomationDscCompilationJob.md) - -[Start-AzureRmAutomationDscCompilationJob](./Start-AzureRmAutomationDscCompilationJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscConfiguration.md b/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscConfiguration.md deleted file mode 100644 index 518e691ba4..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscConfiguration.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: BBD37C4B-BB6F-4560-BDEE-F0440EC1938A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/get-azurermautomationdscconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationDscConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationDscConfiguration.md ---- - -# Get-AzureRmAutomationDscConfiguration - -## SYNOPSIS -Gets DSC configurations from Automation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByAll (Default) -``` -Get-AzureRmAutomationDscConfiguration [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -### ByConfigurationName -``` -Get-AzureRmAutomationDscConfiguration [-Name] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmAutomationDscConfiguration** cmdlet gets APS Desired State Configuration (DSC) configurations from Azure Automation. - -## EXAMPLES - -### Example 1: Get all DSC configurations -``` -PS C:\>Get-AzureRmAutomationDscConfiguration -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -``` - -This command gets metadata for all DSC configurations in the Automation account named Contoso17. - -### Example 2: Get a DSC configuration by name -``` -PS C:\>Get-AzureRmAutomationDscConfiguration -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -Name "ContosoConfiguration" -``` - -This command gets metadata for a DSC configuration named MyConfiguration in the Automation account named Contoso17. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account that contains DSC configurations that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the DSC configuration that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: ByConfigurationName -Aliases: ConfigurationName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group for which this cmdlet gets DSC configurations. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.DscConfiguration - -## NOTES - -## RELATED LINKS - -[Export-AzureRmAutomationDscConfiguration](./Export-AzureRmAutomationDscConfiguration.md) - -[Import-AzureRmAutomationDscConfiguration](./Import-AzureRmAutomationDscConfiguration.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscNode.md b/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscNode.md deleted file mode 100644 index fc9755c6d3..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscNode.md +++ /dev/null @@ -1,245 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 6493186F-064B-45B7-8DFD-7799B1F2E5C9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/get-azurermautomationdscnode -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationDscNode.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationDscNode.md ---- - -# Get-AzureRmAutomationDscNode - -## SYNOPSIS -Gets DSC nodes from Automation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByAll (Default) -``` -Get-AzureRmAutomationDscNode [-Status ] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -### ById -``` -Get-AzureRmAutomationDscNode -Id [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -### ByName -``` -Get-AzureRmAutomationDscNode [-Status ] -Name [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -### ByNodeConfiguration -``` -Get-AzureRmAutomationDscNode [-Status ] -NodeConfigurationName - [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] - [] -``` - -### ByConfiguration -``` -Get-AzureRmAutomationDscNode -ConfigurationName [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmAutomationDscNode** cmdlet gets APS Desired State Configuration (DSC) nodes from Azure Automation. - -## EXAMPLES - -### Example 1: Get all DSC nodes -``` -PS C:\>Get-AzureRmAutomationDscNode -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -``` - -This command gets metadata for all DSC nodes in the Automation account named Contoso17. - -### Example 2: Get all DSC nodes for a DSC configuration -``` -PS C:\>Get-AzureRmAutomationDscNode -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -ConfigurationName "ContosoConfiguration" -``` - -This command gets metadata for all DSC nodes in the Automation account named Contoso17 that are mapped to a DSC node configuration which was generated by DSC configuration ContosoConfiguration. - -### Example 3: Get a DSC node by ID -``` -PS C:\>Get-AzureRmAutomationDscNode -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -Id c0a1718e-d8be-4fa3-91b6-82e1d3a36298 -``` - -This command gets metadata on a DSC node with the specified ID in the Automation account named Contoso17. - -### Example 4: Get a DSC node by name -``` -PS C:\>Get-AzureRmAutomationDscNode -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -Name "Computer14" -``` - -This command gets metadata on a DSC node with the name Computer14 in the Automation account named Contoso17. - -### Example 5: Get all DSC nodes mapped to a DSC node configuration -``` -PS C:\>Get-AzureRmAutomationDscNode -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -NodeConfigurationName "ContosoConfiguration.webserver" -``` - -This command gets metadata on all DSC nodes in the Automation account named Contoso17 that are mapped to a DSC node configuration named ContosoConfiguration.webserver. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account that contains the DSC nodes that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConfigurationName -Specifies the name of a DSC configuration. -This cmdlet gets DSC nodes that match the node configurations generated from the configuration that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByConfiguration -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the unique ID of the DSC node that this cmdlet gets. - -```yaml -Type: System.Guid -Parameter Sets: ById -Aliases: NodeId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a DSC node that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: NodeName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NodeConfigurationName -Specifies the name of a node configuration that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: ByNodeConfiguration -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group in which this cmdlet gets DSC nodes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Status -Specifies the status of the DSC nodes that this cmdlet gets. -Valid values are: -- Compliant -- NotCompliant -- Failed -- Pending -- Received -- Unresponsive - -```yaml -Type: Microsoft.Azure.Commands.Automation.Common.DscNodeStatus -Parameter Sets: ByAll, ByName, ByNodeConfiguration -Aliases: -Accepted values: Compliant, NotCompliant, Failed, Pending, Received, Unresponsive - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.DscNode - -## NOTES - -## RELATED LINKS - -[Register-AzureRmAutomationDscNode](./Register-AzureRmAutomationDscNode.md) - -[Set-AzureRmAutomationDscNode](./Set-AzureRmAutomationDscNode.md) - -[Unregister-AzureRmAutomationDscNode](./Unregister-AzureRmAutomationDscNode.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscNodeConfiguration.md b/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscNodeConfiguration.md deleted file mode 100644 index a5c6e68b18..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscNodeConfiguration.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 89C931AE-DA81-47A7-80E4-159C36497DA0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/get-azurermautomationdscnodeconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationDscNodeConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationDscNodeConfiguration.md ---- - -# Get-AzureRmAutomationDscNodeConfiguration - -## SYNOPSIS -Gets metadata for DSC node configurations in Automation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByAll (Default) -``` -Get-AzureRmAutomationDscNodeConfiguration [-RollupStatus ] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -### ByNodeConfigurationName -``` -Get-AzureRmAutomationDscNodeConfiguration -Name [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -### ByConfigurationName -``` -Get-AzureRmAutomationDscNodeConfiguration -ConfigurationName [-RollupStatus ] - [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Get-AzureRmAutomationDscNodeConfiguration** cmdlet gets metadata for APS Desired State Configuration (DSC) node configurations in Azure Automation. -Automation stores DSC node configuration as a Managed Object Format (MOF) configuration document. - -## EXAMPLES - -### Example 1: Get all DSC node configurations -``` -PS C:\>Get-AzureRmAutomationDscNodeConfiguration -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -``` - -This command gets metadata for all DSC node configurations in the Automation account named Contoso17. - -### Example 2: Get all DSC node configurations for a DSC configuration -``` -PS C:\>Get-AzureRmAutomationDscNodeConfiguration -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -ConfigurationName "ContosoConfiguration" -``` - -This command gets metadata for all DSC node configurations in the Automation account named Contoso17 that the DSC configuration named ContosoConfiguration generated. - -### Example 3: Get a DSC node configuration by name -``` -PS C:\>Get-AzureRmAutomationDscNodeConfiguration -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -Name "ContosoConfiguration.webserver" -``` - -This command gets metadata for a DSC node configuration with the name ContosoConfiguration.webserver in the Automation account named Contoso17. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of an Automation account that contains the DSC node configurations for which this cmdlet gets metadata. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConfigurationName -Specifies the name of DSC configuration for which this cmdlet gets node configuration metadata. - -```yaml -Type: System.String -Parameter Sets: ByConfigurationName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the DSC node configuration for which this cmdlet gets metadata. - -```yaml -Type: System.String -Parameter Sets: ByNodeConfigurationName -Aliases: NodeConfigurationName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. -This cmdlet gets metadata for DSC node configurations in the resource group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RollupStatus -Specifies the rollup status of DSC node configurations that this cmdlet gets. -Valid values are: -- Bad -- Good - -```yaml -Type: System.String -Parameter Sets: ByAll, ByConfigurationName -Aliases: -Accepted values: Good, Bad - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.CompilationJob - -## NOTES - -## RELATED LINKS - -[Import-AzureRmAutomationDscNodeConfiguration](./Import-AzureRmAutomationDscNodeConfiguration.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscNodeConfigurationDeployment.md b/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscNodeConfigurationDeployment.md deleted file mode 100644 index 9e9852cc38..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscNodeConfigurationDeployment.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 32CF9BF7-519F-4B5D-9F2B-3CC556A77A48 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/get-azurermautomationdscnodeconfigurationdeployment -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationDscNodeConfigurationDeployment.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationDscNodeConfigurationDeployment.md ---- - -# Get-AzureRmAutomationDscNodeConfigurationDeployment - -## SYNOPSIS -Gets DSC Node configuration deployments in Automation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByAll (Default) -``` -Get-AzureRmAutomationDscNodeConfigurationDeployment [-Status ] [-StartTime ] - [-EndTime ] [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -### ByJobId -``` -Get-AzureRmAutomationDscNodeConfigurationDeployment -JobId [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmAutomationDscNodeConfigurationDeployment** cmdlet deployes an APS Desired State Configuration (DSC) node configuration in Azure Automation. - -## EXAMPLES - -### Example 1: Get a node configuration deployment -``` -PS C:\> $deployment = Get-AzureRmAutomationDscNodeConfigurationDeployment ` - -JobId 35b14eb4-52b7-4a1d-ad62-8e9f84adc657 ` - -AutomationAccountName "Contoso01" ` - -ResourceGroupName "ResourceGroup01" ` - -ResourceGroupName : ResourceGroup01 -AutomationAccountName : Contoso01 -JobId : 35b14eb4-52b7-4a1d-ad62-8e9f84adc657 -Job : Microsoft.Azure.Commands.Automation.Model.Job -JobStatus : Running -NodeStatus : {System.Collections.Generic.Dictionary`2[System.String,System.String], System.Collections.Generic.Dictionary`2[System.String,System.String]} -NodeConfigurationName : Config01.Node1 -JobSchedule : -JobScheduleId : 00000000-0000-0000-0000-000000000000 - -PS C:\> $deployment | Select -expand nodeStatus - -Key Value ---- ----- -WebServer Pending -WebServer2 Pending -WebServer3 Compliant -``` - -The above command deploys the DSC node configuration named "Config01.Node1" to the given two-dimensional array of Node Names. The deployment happens in a staged manner. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account that contains the DSC configuration that this cmdlet compiles. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndTime -End time filter. - -```yaml -Type: System.Nullable`1[System.DateTimeOffset] -Parameter Sets: ByAll -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobId -Specifies the Job id of an existing deployment job. - -```yaml -Type: System.Guid -Parameter Sets: ByJobId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group in which this cmdlet compiles a configuration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartTime -Start time filter. - -```yaml -Type: System.Nullable`1[System.DateTimeOffset] -Parameter Sets: ByAll -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Status -Status of the Job filter. - -```yaml -Type: System.String -Parameter Sets: ByAll -Aliases: -Accepted values: Completed, Failed, Queued, Starting, Resuming, Running, Stopped, Stopping, Suspended, Suspending, Activating - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.NodeConfigurationDeployment - -## NOTES - -## RELATED LINKS - -[Start-AzureRmAutomationDscCompilationJob](./Start-AzureRmAutomationDscCompilationJob.md) - -[Import-AzureRmAutomationDscNodeConfiguration](./Import-AzureRmAutomationDscNodeConfiguration.md) - -[Start-AzureRmAutomationDscNodeConfigurationDeployment](./Start-AzureRmAutomationDscNodeConfigurationDeployment.md) - -[Stop-AzureRmAutomationDscNodeConfigurationDeployment](./Stop-AzureRmAutomationDscNodeConfigurationDeployment.md) - -[Get-AzureRmAutomationDscNodeConfigurationDeploymentSchedule](./Get-AzureRmAutomationDscNodeConfigurationDeploymentSchedule.md) diff --git a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscNodeConfigurationDeploymentSchedule.md b/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscNodeConfigurationDeploymentSchedule.md deleted file mode 100644 index b0e684c8ef..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscNodeConfigurationDeploymentSchedule.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 32CF9BF7-519F-4B5D-9F2B-3CC556A77A48 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/get-azurermautomationdscnodeconfigurationdeploymentschedule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationDscNodeConfigurationDeploymentSchedule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationDscNodeConfigurationDeploymentSchedule.md ---- - -# Get-AzureRmAutomationDscNodeConfigurationDeploymentSchedule - -## SYNOPSIS -Gets a DSC Node configuration deployment job schedule in Automation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByAll (Default) -``` -Get-AzureRmAutomationDscNodeConfigurationDeploymentSchedule [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -### ByJobScheduleId -``` -Get-AzureRmAutomationDscNodeConfigurationDeploymentSchedule -JobScheduleId [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmAutomationDscNodeConfigurationDeployment** cmdlet deployes an APS Desired State Configuration (DSC) node configuration in Azure Automation. - -## EXAMPLES - -### Example 1: Get all the deployment schedules -``` -PS C:\> Get-AzureRmAutomationDscNodeConfigurationDeploymentSchedule ` - -AutomationAccountName "Contoso01" ` - -ResourceGroupName "ResourceGroup01" - -ResourceGroupName : ResourceGroup01 -AutomationAccountName : Contoso01 -JobScheduleId : 2b1d7738-093d-4ff7-b87b-e4b2321319e5 -JobSchedule : Microsoft.Azure.Commands.Automation.Model.JobSchedule -RunbookName : Deploy-NodeConfigurationToAutomationDscNodesV1 - -ResourceGroupName : ResourceGroup01 -AutomationAccountName : Contoso01 -JobScheduleId : e347dfc4-62fe-4ed6-adfb-55518c57b558 -JobSchedule : Microsoft.Azure.Commands.Automation.Model.JobSchedule -RunbookName : Deploy-NodeConfigurationToAutomationDscNodesV1 -``` - -### Example 2: Get a deployment schedule -``` -PS C:\> $js= Get-AzureRmAutomationDscNodeConfigurationDeploymentSchedule ` - -AutomationAccountName "Contoso01" ` - -ResourceGroupName "ResourceGroup01" ` - -JobScheduleId 2b1d7738-093d-4ff7-b87b-e4b2321319e5 - -PS C:\> $js - -ResourceGroupName : ResourceGroup01 -AutomationAccountName : Contoso01 -JobScheduleId : 2b1d7738-093d-4ff7-b87b-e4b2321319e5 -JobSchedule : Microsoft.Azure.Commands.Automation.Model.JobSche -RunbookName : Deploy-NodeConfigurationToAutomationDscNodesV1 - -PS C:\> $js.JobSchedule - -ResourceGroupName : ResourceGroup01 -RunOn : -AutomationAccountName : Contoso01 -JobScheduleId : 2b1d7738-093d-4ff7-b87b-e4b2321319e5 -RunbookName : Deploy-NodeConfigurationToAutomationDscNodesV1 -ScheduleName : TestScheduleName -Parameters : {AutomationAccountName, NodeConfigurationName, ResourceGroupName, ListOfNodeNames} -HybridWorker : -``` - -The above command deploys the DSC node configuration named "Config01.Node1" to the given two-dimensional array of Node Names. The deployment happens in a staged manner. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account that contains the DSC configuration that this cmdlet compiles. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobScheduleId -Specifies the Job Schedule id of an existing scheduled deployment job. - -```yaml -Type: System.Guid -Parameter Sets: ByJobScheduleId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group in which this cmdlet compiles a configuration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.NodeConfigurationDeploymentSchedule - -## NOTES - -## RELATED LINKS - -[Start-AzureRmAutomationDscCompilationJob](./Start-AzureRmAutomationDscCompilationJob.md) - -[Import-AzureRmAutomationDscNodeConfiguration](./Import-AzureRmAutomationDscNodeConfiguration.md) - -[Start-AzureRmAutomationDscNodeConfigurationDeployment](./Start-AzureRmAutomationDscNodeConfigurationDeployment.md) - -[Stop-AzureRmAutomationDscNodeConfigurationDeployment](./Stop-AzureRmAutomationDscNodeConfigurationDeployment.md) - -[Get-AzureRmAutomationDscNodeConfigurationDeployment](./Get-AzureRmAutomationDscNodeConfigurationDeployment.md) diff --git a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscNodeReport.md b/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscNodeReport.md deleted file mode 100644 index e43f66b062..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscNodeReport.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 1246C3AC-A123-4EA1-B99E-458A85789109 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/get-azurermautomationdscnodereport -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationDscNodeReport.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationDscNodeReport.md ---- - -# Get-AzureRmAutomationDscNodeReport - -## SYNOPSIS -Gets reports sent from a DSC node to Automation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByAll (Default) -``` -Get-AzureRmAutomationDscNodeReport -NodeId [-StartTime ] [-EndTime ] - [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] - [] -``` - -### ByLatest -``` -Get-AzureRmAutomationDscNodeReport -NodeId [-Latest] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -### ById -``` -Get-AzureRmAutomationDscNodeReport -NodeId -Id [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmAutomationDscNodeReport** cmdlet gets reports sent from an APS Desired State Configuration (DSC) node to Azure Automation. - -## EXAMPLES - -### Example 1: Get all reports for a DSC node -``` -PS C:\>$Node = Get-AzureRmAutomationDscNode -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -Name "Computer14" -PS C:\> Get-AzureRmAutomationDscNodeReport -ResourceGroupName "ResourceGroup14" -AutomationAccountName "Contoso17" -NodeId $Node.Id -``` - -The first command gets the DSC node for the computer named Computer14 in the Automation account named Contoso17. -The command stores this object in the $Node variable. -The second command gets metadata for all reports sent from the DSC node named Computer14 to the Automation account named Contoso17. -The command specifies the node by using the **Id** property of the $Node object. - -### Example 2: Get a report for a DSC node by report ID -``` -PS C:\>$Node = Get-AzureRmAutomationDscNode -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -Name "Computer14" -PS C:\> Get-AzureRmAutomationDscNodeReport -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -NodeId $Node.Id -Id c0a1718e-d8be-4fa3-91b6-82e1d3a36298 -``` - -The first command gets the DSC node for the computer named Computer14 in the Automation account named Contoso17. -The command stores this object in the $Node variable. -The second command gets metadata for the report identified by the specified ID sent from the DSC node named Computer14 to the Automation account named Contoso17. - -### Example 3: Get the latest report for a DSC node -``` -PS C:\>$Node = Get-AzureRmAutomationDscNode -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -Name "Computer14" -PS C:\> Get-AzureRmAutomationDscNodeReport -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -NodeId $Node.Id -Latest -``` - -The first command gets the DSC node for the computer named Computer14 in the Automation account named Contoso17. -The command stores this object in the $Node variable. -The second command gets metadata for the latest report sent from the DSC node named Computer14 to the Automation account named Contoso17. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of an Automation account. -This cmdlet exports reports for a DSC node that belongs to the account that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndTime -Specifies an end time. -This cmdlet gets reports that Automation received before this time. - -```yaml -Type: System.Nullable`1[System.DateTimeOffset] -Parameter Sets: ByAll -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Id -Specifies the unique ID of the DSC node report for this cmdlet to get. - -```yaml -Type: System.Guid -Parameter Sets: ById -Aliases: ReportId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Latest -Indicates that this cmdlet gets the latest DSC report for the specified node only. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByLatest -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NodeId -Specifies the unique ID of the DSC node for which this cmdlet gets reports. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group that contains the DSC node for which this cmdlet gets reports. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartTime -Specifies a start time. -This cmdlet gets reports that Automation received after this time. - -```yaml -Type: System.Nullable`1[System.DateTimeOffset] -Parameter Sets: ByAll -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.Nullable`1[[System.DateTimeOffset, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.DscNode - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationDscNode](./Get-AzureRmAutomationDscNode.md) - -[Export-AzureRmAutomationDscNodeReportContent](./Export-AzureRmAutomationDscNodeReportContent.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscOnboardingMetaconfig.md b/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscOnboardingMetaconfig.md deleted file mode 100644 index 11eb31d435..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationDscOnboardingMetaconfig.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: FB331566-AC13-4751-A600-3A0E576308C7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/get-azurermautomationdsconboardingmetaconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationDscOnboardingMetaconfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationDscOnboardingMetaconfig.md ---- - -# Get-AzureRmAutomationDscOnboardingMetaconfig - -## SYNOPSIS -Creates meta-configuration .mof files. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmAutomationDscOnboardingMetaconfig [-OutputFolder ] [-ComputerName ] [-Force] - [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Get-AzureRmAutomationDscOnboardingMetaconfig** cmdlet creates APS Desired State Configuration (DSC) meta-configuration Managed Object Format (MOF) files. -This cmdlet creates a .mof file for each computer name that you specify. -The cmdlet creates a folder for the .mof files. -You can run the Set-DscLocalConfigurationManager cmdlet for this folder to onboard these computers into an Azure Automation account as DSC nodes. - -## EXAMPLES - -### Example 1: Onboard servers to Automation DSC -``` -PS C:\>Get-AzureRmAutomationDscOnboardingMetaconfig -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -ComputerName "Server01", "Server02" -OutputFolder "C:\Users\PattiFuller\Desktop" -PS C:\> Set-DscLocalConfigurationManager -Path "C:\Users\PattiFuller\Desktop\DscMetaConfigs" -ComputerName "Server01", "Server02" -``` - -The first command creates DSC meta-configuration files for two servers for the Automation account named Contoso17. -The command saves these files on a desktop. -The second command uses the **Set-DscLocalConfigurationManager** cmdlet to apply the meta-configuration to the specified computers to onboard them as DSC nodes. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of an Automation account. -You can onboard the computers that the *ComputerName* parameter specifies to the account that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ComputerName -Specifies an array of names of computers for which this cmdlet generates .mof files. -If you do not specify this parameter, the cmdlet generates an .mof file for the current computer (localhost). - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without prompting you for confirmation, and to replace existing .mof files that have the same name. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutputFolder -Specifies the name of a folder where this cmdlet stores .mof files. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. -This cmdlet creates .mof files to onboard computers in the resource group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.String[] - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.DscOnboardingMetaconfig - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationJobOutputRecord.md b/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationJobOutputRecord.md deleted file mode 100644 index 70c33ca1df..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationJobOutputRecord.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 38BB4F4E-B72B-460E-8DF2-2A7A9CACDB41 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/get-azurermautomationjoboutputrecord -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationJobOutputRecord.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationJobOutputRecord.md ---- - -# Get-AzureRmAutomationJobOutputRecord - -## SYNOPSIS -Gets the full output of an Automation job output record. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmAutomationJobOutputRecord [-JobId] [-Id] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmAutomationJobOutputRecord** cmdlet gets the full output of an Automation job output record. -Although the **Get-AzureRmAutomationJobOutput** cmdlet lists one or more job output records, it returns only a summary, as a string, of the value of any output record. -It does not return the full value of an output record's outputted value in its original type. -In addition, the summary has a maximum length, which the full value that this cmdlet outputs may exceed. -Unlike **Get-AzureRmAutomationJobOutput**, this cmdlet returns the full value in its originally outputted type, for any output record's outputted value. - -## EXAMPLES - -### Example 1: Get the full output of an Automation job -``` -PS C:\>Get-AzureRmAutomationJobOutput -AutomationAccountName "Contoso17" -Id 2989b069-24fe-40b9-b3bd-cb7e5eac4b64 -ResourceGroupName "ResourceGroup01" -Stream "Any" | Get-AzureRmAutomationJobOutputRecord -``` - -This command gets the full output of the job that has the specified job ID. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of an Automation account for which this cmdlet gets a job output record. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of a job output record for this cmdlet to retrieve. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: StreamRecordId - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -JobId -Specifies the ID of a job for which this cmdlet gets an output record. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group for which this cmdlet gets a job output record. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.JobStreamRecord - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationJobOutput](./Get-AzureRMAutomationJobOutput.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationModule.md b/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationModule.md deleted file mode 100644 index ebdb31dffb..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationModule.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: A73B388A-E859-40D3-BA63-0E231CF1E81D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/get-azurermautomationmodule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationModule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationModule.md ---- - -# Get-AzureRmAutomationModule - -## SYNOPSIS -Gets metadata for modules from Automation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByAll (Default) -``` -Get-AzureRmAutomationModule [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -### ByName -``` -Get-AzureRmAutomationModule [-Name] [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmAutomationModule** cmdlet gets metadata for modules from Azure Automation. - -## EXAMPLES - -### Example 1: Get all modules -``` -PS C:\>Get-AzureRmAutomationModule -AutomationAccountName "Contoso17" -ResourceGroupName "ResourceGroup01" -``` - -This command gets all modules in the Automation account named Contoso17. - -### Example 2: Get a module -``` -PS C:\>Get-AzureRmAutomationModule -AutomationAccountName "Contoso17" -Name "ContosoModule" -ResourceGroupName "ResourceGroup01" -``` - -This command gets a module named ContosoModule in the Automation account named Contoso17. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account for which this cmdlet gets module metadata. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the module for which this cmdlet gets metadata. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group for which this cmdlet gets module metadata. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.Module - -## NOTES - -## RELATED LINKS - -[New-AzureRmAutomationModule](./New-AzureRmAutomationModule.md) - -[Remove-AzureRmAutomationModule](./Remove-AzureRmAutomationModule.md) - -[Set-AzureRmAutomationModule](./Set-AzureRmAutomationModule.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationRegistrationInfo.md b/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationRegistrationInfo.md deleted file mode 100644 index 91229bc8ca..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationRegistrationInfo.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 09823BE3-A98B-42EF-B6F4-99F95F2B342E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/get-azurermautomationregistrationinfo -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationRegistrationInfo.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationRegistrationInfo.md ---- - -# Get-AzureRmAutomationRegistrationInfo - -## SYNOPSIS -Gets registration information for onboarding a DSC node or hybrid worker to Automation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmAutomationRegistrationInfo [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmAutomationRegistrationInfo** cmdlet gets the endpoint and keys required to onboard a Desired State Configuration (DSC) node or hybrid worker into an Azure Automation account. - -## EXAMPLES - -### Example 1: Get registration information -``` -PS C:\>Get-AzureRmAutomationRegistrationInfo -ResourceGroup "ResourceGroup01" -AutomationAccountName "AutomationAccount01" -``` - -This command gets the registration information for the Automation account named AutomationAccount01 in the Resource Group named ResourceGroup01. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of Automation account for which this cmdlet gets registration information. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. -This cmdlet gets registration information for the resource group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.AgentRegistration - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationAccount](./Get-AzureRmAutomationAccount.md) - -[Get-AzureRmAutomationDscNode](./Get-AzureRmAutomationDscNode.md) - -[New-AzureRmAutomationKey](./New-AzureRmAutomationKey.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationSoftwareUpdateConfiguration.md b/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationSoftwareUpdateConfiguration.md deleted file mode 100644 index 38000b317f..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationSoftwareUpdateConfiguration.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/get-azurermautomationsoftwareupdateconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationSoftwareUpdateConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationSoftwareUpdateConfiguration.md ---- - -# Get-AzureRmAutomationSoftwareUpdateConfiguration - -## SYNOPSIS -Gets a list of azure automation software update configurations. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByAll (Default) -``` -Get-AzureRmAutomationSoftwareUpdateConfiguration [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -### ByName -``` -Get-AzureRmAutomationSoftwareUpdateConfiguration -Name [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -### ByVMId -``` -Get-AzureRmAutomationSoftwareUpdateConfiguration -AzureVMResourceId [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The Get-AzureRmAutomationSoftwareUpdateConfiguration returns a list of software update configurations. To get a specific software update configuration, specify the name parameter. You can also list software update configurations targeting specific azure virtual machine by specifying the azure resource Id for this virtual machine. - -## EXAMPLES - -### Example 1 -Get an azure automation software update configuration by name. - -```powershell -PS C:\> Get-AzureRmAutomationSoftwareUpdateConfiguration -ResourceGroupName "mygroup" -AutomationAccountName "myaccount" -Name "MyWeeklySchedule" - -UpdateConfiguration : Microsoft.Azure.Commands.Automation.Model.UpdateManagement.UpdateConfiguration -ScheduleConfiguration : Microsoft.Azure.Commands.Automation.Model.Schedule -ProvisioningState : Succeeded -ErrorInfo : -ResourceGroupName : mygroup -AutomationAccountName : myaccount -Name : MyWeeklySchedule -CreationTime : 9/14/2018 3:53:27 AM +00:00 -LastModifiedTime : 9/14/2018 3:53:37 AM +00:00 -Description : -``` - -## PARAMETERS - -### -AutomationAccountName -The automation account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AzureVMResourceId -Azure resource Id of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: ByVMId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the software update configuration. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.UpdateManagement.SoftwareUpdateConfiguration - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationSoftwareUpdateMachineRun.md b/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationSoftwareUpdateMachineRun.md deleted file mode 100644 index 8420f8e28c..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationSoftwareUpdateMachineRun.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/get-azurermautomationsoftwareupdatemachinerun -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationSoftwareUpdateMachineRun.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationSoftwareUpdateMachineRun.md ---- - -# Get-AzureRmAutomationSoftwareUpdateMachineRun - -## SYNOPSIS -Gets a list of azure automation software update configuration machine runs. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByAll (Default) -``` -Get-AzureRmAutomationSoftwareUpdateMachineRun [-Status ] - [-TargetComputer ] [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -### ById -``` -Get-AzureRmAutomationSoftwareUpdateMachineRun -Id [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -### BySucrId -``` -Get-AzureRmAutomationSoftwareUpdateMachineRun [-SoftwareUpdateRunId ] - [-Status ] [-TargetComputer ] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -### BySucr -``` -Get-AzureRmAutomationSoftwareUpdateMachineRun [-SoftwareUpdateRun ] - [-Status ] [-TargetComputer ] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -## DESCRIPTION -This cmdlet returns a list of machine runs. Each software update run will trigger a machine run for each of the software update configuration target machine. To get a specific machine run, pass the Id parameter. You can list all the machine runs, all runs for a specific computer, all runs with specific status by passing the corresponding parameters. - -## EXAMPLES - -### Example 1 -This example returns all failed machine runs for the specified azure virtual machine. - - -```powershell -PS C:\> $targetComputer = "/subscriptions/22e2445a-0984-4fa5-86a4-0280d76c4b2c/resourceGroups/compute/providers/Microsoft.Compute/virtualMachines/myvm" -PS C:\> Get-AzureRmAutomationSoftwareUpdateMachineRun -ResourceGroupName "mygroup" ` - -AutomationAccountName "myaccount" ` - -TargetComputer $targetComputer ` - -Status Failed - -MachineRunId : 0033d6d6-828d-4712-adab-293cc4fc8809 -TargetComputer : /subscriptions/22e2445a-0984-4fa5-86a4-0280d76c4b2c/resourceGroups/compute/providers/Microsoft.Compute/virtualMachines/myvm -TargetComputerType : AzureVirtualMachines -SoftwareUpdateRunId : 46568d26-0182-49b2-8bfd-af3455780397 -OperatingSystem : Windows -Status : Failed -ResourceGroupName : mygroup -AutomationAccountName : myaccount -Name : 0033d6d6-828d-4712-adab-293cc4fc8809 -CreationTime : 5/17/2018 2:06:44 AM +00:00 -LastModifiedTime : 5/17/2018 2:08:49 AM +00:00 -``` - -## PARAMETERS - -### -AutomationAccountName -The automation account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Id of the software update machine run. - -```yaml -Type: System.Guid -Parameter Sets: ById -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SoftwareUpdateRun -The software update run. - -```yaml -Type: Microsoft.Azure.Commands.Automation.Model.UpdateManagement.SoftwareUpdateRun -Parameter Sets: BySucr -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SoftwareUpdateRunId -Id of the software update run. - -```yaml -Type: System.Guid -Parameter Sets: BySucrId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Status -Status of the machine run. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Commands.Automation.Model.UpdateManagement.SoftwareUpdateMachineRunStatus] -Parameter Sets: ByAll, BySucrId, BySucr -Aliases: -Accepted values: NotStarted, InProgress, Succeeded, Failed, MaintenanceWindowExceeded, FailedToStart - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetComputer -target computer for the machine run. -Can be either a non-azure computer name or an azure VM resource id. - -```yaml -Type: System.String -Parameter Sets: ByAll, BySucrId, BySucr -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### Microsoft.Azure.Commands.Automation.Model.UpdateManagement.SoftwareUpdateRun - -### System.Nullable`1[[Microsoft.Azure.Commands.Automation.Model.UpdateManagement.SoftwareUpdateMachineRunStatus, Microsoft.Azure.Commands.ResourceManager.Automation, Version=5.1.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.UpdateManagement.SoftwareUpdateMachineRun - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationSoftwareUpdateRun.md b/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationSoftwareUpdateRun.md deleted file mode 100644 index 2a1d971f2c..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationSoftwareUpdateRun.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/get-azurermautomationsoftwareupdaterun -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationSoftwareUpdateRun.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationSoftwareUpdateRun.md ---- - -# Get-AzureRmAutomationSoftwareUpdateRun - -## SYNOPSIS -Gets a list of azure automation software update runs. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByAll (Default) -``` -Get-AzureRmAutomationSoftwareUpdateRun [-OperatingSystem ] - [-Status ] [-StartTime ] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -### ById -``` -Get-AzureRmAutomationSoftwareUpdateRun -Id [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -### BySucName -``` -Get-AzureRmAutomationSoftwareUpdateRun [-SoftwareUpdateConfigurationName ] - [-OperatingSystem ] [-Status ] [-StartTime ] - [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] - [] -``` - -### BySuc -``` -Get-AzureRmAutomationSoftwareUpdateRun [-SoftwareUpdateConfiguration ] - [-OperatingSystem ] [-Status ] [-StartTime ] - [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The Get-AzureRmAutomationSoftwareUpdateRun cmdlet returns a list of software update runs. Since a software update configuration has an associated schedule, it can be triggered multiple times. Each time a schedule is triggered will result in an update run created. Update run is an aggregate of the result of all machine runs. You can get runs for specific software update configuration by passing the SoftwareUpdateConfigurationName parameter. To get a specific runs, you need to pass the name parameter. You can also list runs with specific status, runs targeting specific operatins system, or runs started after specific time by passing the appropriate parameter. - -## EXAMPLES - -### Example 1 -This example list all update runs triggered by a specific software update configuration. - -```powershell -PS C:\> Get-AzureRmAutomationSoftwareUpdateRun -ResourceGroupName "mygroup" ` - -AutomationAccountName "myaccount" ` - -SoftwareUpdateConfigurationName "MyUpdateConfiguration" - -RunId : ec9ce57f-da18-44be-b33b-651a0f93cb52 -SoftwareUpdateConfigurationName : MyUpdateConfiguration -ConfiguredDuration : 02:00:00 -OperatingSystem : Windows -StartTime : 5/22/2018 11:37:42 PM +00:00 -EndTime : 5/22/2018 11:38:31 PM +00:00 -ComputerCount : 2 -FailedCount : 0 -ResourceGroupName : mygroup -AutomationAccountName : myaccount -Name : ec9ce57f-da18-44be-b33b-651a0f93cb52 -CreationTime : 5/22/2018 11:37:42 PM +00:00 -LastModifiedTime : 5/22/2018 11:38:54 PM +00:00 -Description : - -RunId : ac9396c7-a837-43d4-be97-fbfe46c80baa -SoftwareUpdateConfigurationName : MyUpdateConfiguration -ConfiguredDuration : 02:00:00 -OperatingSystem : Windows -StartTime : 5/22/2018 10:00:47 PM +00:00 -EndTime : 5/22/2018 10:02:20 PM +00:00 -ComputerCount : 2 -FailedCount : 0 -ResourceGroupName : mygroup -AutomationAccountName : myaccount -Name : ac9396c7-a837-43d4-be97-fbfe46c80baa -CreationTime : 5/22/2018 10:00:47 PM +00:00 -LastModifiedTime : 5/22/2018 10:02:58 PM +00:00 -``` - -## PARAMETERS - -### -AutomationAccountName -The automation account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Id of the software update configuration run. - -```yaml -Type: System.Guid -Parameter Sets: ById -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OperatingSystem -The operating system of the run. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Commands.Automation.Model.UpdateManagement.OperatingSystemType] -Parameter Sets: ByAll, BySucName, BySuc -Aliases: -Accepted values: Windows, Linux - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SoftwareUpdateConfiguration -The software update configuration triggered the run. - -```yaml -Type: Microsoft.Azure.Commands.Automation.Model.UpdateManagement.SoftwareUpdateConfiguration -Parameter Sets: BySuc -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SoftwareUpdateConfigurationName -Name of the software update configuration triggered the run. - -```yaml -Type: System.String -Parameter Sets: BySucName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartTime -Minimum start time of the run. - -```yaml -Type: System.DateTimeOffset -Parameter Sets: ByAll, BySucName, BySuc -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Status -Status of the run. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Commands.Automation.Model.UpdateManagement.SoftwareUpdateRunStatus] -Parameter Sets: ByAll, BySucName, BySuc -Aliases: -Accepted values: NotStarted, InProgress, Succeeded, Failed, MaintenanceWindowExceeded - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -### Microsoft.Azure.Commands.Automation.Model.UpdateManagement.SoftwareUpdateConfiguration - -### System.Nullable`1[[Microsoft.Azure.Commands.Automation.Model.UpdateManagement.OperatingSystemType, Microsoft.Azure.Commands.ResourceManager.Automation, Version=5.1.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Nullable`1[[Microsoft.Azure.Commands.Automation.Model.UpdateManagement.SoftwareUpdateRunStatus, Microsoft.Azure.Commands.ResourceManager.Automation, Version=5.1.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.DateTimeOffset - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.UpdateManagement.SoftwareUpdateRun - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationSourceControl.md b/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationSourceControl.md deleted file mode 100644 index 319b5ba61e..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationSourceControl.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/get-azurermautomationsourcecontrol -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationSourceControl.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationSourceControl.md ---- - -# Get-AzureRmAutomationSourceControl - -## SYNOPSIS -Gets a list of Azure Automation source controls. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByAll (Default) -``` -Get-AzureRmAutomationSourceControl [-SourceType ] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -### ByName -``` -Get-AzureRmAutomationSourceControl -Name [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The Get-AzureRmAutomationSourceControl cmdlet gets Automation source controls. -To get a specific source control, specify its name. - -## EXAMPLES - -### Example 1 -This command gets an Automation source control named VSTSNative in the account named devAccount. - - -```powershell -PS C:\> Get-AzureRmAutomationSourceControl -ResourceGroupName "rg1" ` - -AutomationAccountName "devAccount" ` - -Name "VSTSNative" - - -Name SourceType Branch FolderPath AutoSync PublishRunbook RepoUrl ----- ---------- ------ ---------- -------- -------------- ------- -VSTSNative VsoTfvc /MyRunbooks False True https://contoso.visualstudio.com/_git/Fin... -``` - -## PARAMETERS - -### -AutomationAccountName -The automation account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The source control name. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceType -The source control type. - -```yaml -Type: System.String -Parameter Sets: ByAll -Aliases: -Accepted values: GitHub, VsoGit, VsoTfvc - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.SourceControl - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationSourceControlSyncJob.md b/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationSourceControlSyncJob.md deleted file mode 100644 index 85f0d39067..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationSourceControlSyncJob.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/get-azurermautomationsourcecontrolsyncjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationSourceControlSyncJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationSourceControlSyncJob.md ---- - -# Get-AzureRmAutomationSourceControlSyncJob - -## SYNOPSIS -Gets Azure Automation source control sync jobs. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmAutomationSourceControlSyncJob -SourceControlName [-JobId ] - [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The Get-AzureRmAutomationSourceControlSyncJob cmdlet gets Azure Automation source control sync jobs. To get a specific source control sync job, specify its id. - -## EXAMPLES - -### Example 1 -This command gets all the Automation source control sync jobs for the source control VSTSNative. - - -```powershell -PS C:\> Get-AzureRmAutomationSourceControlSyncJob -ResourceGroupName "rg1" ` - -AutomationAccountName "devAccount" ` - -Name "VSTSNative" - -SourceControlSyncJobId SyncType Status StartTime EndTime ----------------------- -------- ------ --------- ------- -08d6d266-27b6-463c-beea-bc48a67ace15 FullSync Failed 08/15/2018 09:17 AM 08/15/2018 09:18 AM -b566d564-878a-4641-8c44-25bf7850531e FullSync Failed 08/15/2018 09:09 AM 08/15/2018 09:10 AM -``` - -### Example 2 -This command gets the source control sync job with id 08d6d266-27b6-463c-beea-bc48a67ace15 -for the source control VSTSNative. - - -```powershell -PS C:\> Get-AzureRmAutomationSourceControlSyncJob -ResourceGroupName "rg1" ` - -AutomationAccountName "devAccount" ` - -Name "VSTSNative" - -Id "08d6d266-27b6-463c-beea-bc48a67ace15" - -Status SyncType Exception ------- -------- --------- -Failed FullSync There were errors while syncing the user runbooks. Please see error streams for more information. (T... -``` - -## PARAMETERS - -### -AutomationAccountName -The automation account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobId -The source control sync job id. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: SourceControlSyncJobId - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceControlName -The source control name of the job. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Guid - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.SourceControlSyncJob - -### Microsoft.Azure.Commands.Automation.Model.SourceControlSyncJobRecord - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationSourceControlSyncJobOutput.md b/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationSourceControlSyncJobOutput.md deleted file mode 100644 index fd353851f0..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Get-AzureRmAutomationSourceControlSyncJobOutput.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/get-azurermautomationsourcecontrolsyncjoboutput -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationSourceControlSyncJobOutput.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Get-AzureRmAutomationSourceControlSyncJobOutput.md ---- - -# Get-AzureRmAutomationSourceControlSyncJobOutput - -## SYNOPSIS -Gets the output of an Azure Automation source control sync job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmAutomationSourceControlSyncJobOutput -SourceControlName -JobId - [-Stream ] [-StreamId ] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmAutomationSourceControlSyncJobOutput** cmdlet gets the output for a Azure Automation source control sync job. - -## EXAMPLES - -### Example 1 -This command gets the output of source control sync job with id 08d6d266-27b6-463c-beea-bc48a67ace15 for the source control VSTSNative. - - -```powershell -PS C:\> Get-AzureRmAutomationSourceControlSyncJobOutput -ResourceGroupName "rg1" ` - -AutomationAccountName "devAccount" ` - -Name "VSTSNative" - -Id "08d6d266-27b6-463c-beea-bc48a67ace15" ` - -Stream Output | ForEach-Object {$_.summary} - -======================================================================================================== - -Azure Automation Source Control Public Preview. -Supported runbooks to sync: PowerShell Workflow, PowerShell Scripts, DSC Configurations, Graphical, and Python 2. -Setting AzureRmEnvironment. -Getting AzureRunAsConnection. -Logging in to Azure... -Source control information for syncing: -[RepoUrl = https://contoso.visualstudio.com/_git/GitDemo] [Branch = master] [FolderPath = /] -Verifying url: https://fcontoso.visualstudio.com/_git/GitDemo -Connecting to VSTS... - -Source Control Sync Summary: - -2 files synced: - - RunbookA.ps1 - - RunbookB.ps1 - -Failed to import runbook: - - RunbookC.ps1 - -File is not a runbook: - - README.md - - text_file.txt - -File size exceeds 1Mb: - - RunbookD_GreatherThan1MB.ps1 - -Invalid runbook name: - - RunbookZ_ĈĦŕĬŞ.ps1 - -======================================================================================================== -``` - -## PARAMETERS - -### -AutomationAccountName -The automation account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobId -The source control sync job id. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: SourceControlSyncJobId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceControlName -The source control name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Stream -The stream type. -Defaults to Any. - -```yaml -Type: Microsoft.Azure.Commands.Automation.Common.SourceControlSyncJobStreamType -Parameter Sets: (All) -Aliases: -Accepted values: Any, Output, Error - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StreamId -The stream id. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: SourceControlSyncJobStreamId - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Guid - -### Microsoft.Azure.Commands.Automation.Common.SourceControlSyncJobStreamType - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.SourceControlSyncJobStream - -### Microsoft.Azure.Commands.Automation.Model.SourceControlSyncJobStreamRecord - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Automation/Import-AzureRMAutomationRunbook.md b/azurermps-6.13.0/AzureRM.Automation/Import-AzureRMAutomationRunbook.md deleted file mode 100644 index c29bbd3fb3..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Import-AzureRMAutomationRunbook.md +++ /dev/null @@ -1,302 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: B6487D26-2B6A-4938-B1CD-48EADD8D0C3C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/import-azurermautomationrunbook -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Import-AzureRMAutomationRunbook.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Import-AzureRMAutomationRunbook.md ---- - -# Import-AzureRmAutomationRunbook - -## SYNOPSIS -Imports an Automation runbook. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Import-AzureRmAutomationRunbook [-Path] [-Description ] [-Name ] [-Tags ] - -Type [-LogProgress ] [-LogVerbose ] [-Published] [-Force] - [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Import-AzureRmAutomationRunbook** cmdlet imports an Azure Automation runbook. Specify the -path to a wps_2 script (.ps1) file to import for wps_2 and wps_2 Workflow runbooks, -(.graphrunbook) file for graphical runbooks, or (.py) file for python 2 runbooks. -For wps_2 Workflow runbooks, the script must contain a single wps_2 Workflow definition that matches the name of the file. - -## EXAMPLES - -### Example 1: Import a runbook from a file -``` -PS C:\> $Tags = @{"tag01"="value01"; "tag02"="value02"} -PS C:\> Import-AzureRmAutomationRunbook -Path .\GraphicalRunbook06.graphrunbook -Tags $Tags -ResourceGroup "ResourceGroup01" -AutomationAccountName "AutomationAccount01" -Type GraphicalPowershell -``` - -The first command assigns two key/value pairs to the $Tags variable. -The second command imports a graphical runbook called GraphicalRunbook06 into the Automation account named AutomationAccount01. -The command also assigns the tags stored in $Tags. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account into which this cmdlet imports a runbook. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the imported runbook. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -ps_force - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogProgress -Specifies whether the runbook logs progress information. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogVerbose -Specifies whether the runbook logs detailed information. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the runbook that this cmdlet imports. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: RunbookName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the path of a .ps1 or .graphrunbook file that this cmdlet imports. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: SourcePath - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Published -Indicates that this cmdlet publishes the runbook that it imports. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for which this cmdlet imports a runbook. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tags -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.IDictionary -Parameter Sets: (All) -Aliases: Tag - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Type -Specifies the type of runbook that this cmdlet creates. -Valid values are: -- PowerShell -- GraphicalPowerShell -- PowerShellWorkflow -- GraphicalPowerShellWorkflow -- Graph -- Python2 -The value Graph is obsolete. -It is equivalent to GraphicalPowerShellWorkflow. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: PowerShell, GraphicalPowerShell, PowerShellWorkflow, GraphicalPowerShellWorkflow, Graph, Python2 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.IDictionary - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.Runbook - -## NOTES - -## RELATED LINKS - -[Export-AzureRmAutomationRunbook](./Export-AzureRMAutomationRunbook.md) - -[Get-AzureRmAutomationRunbook](./Get-AzureRMAutomationRunbook.md) - -[New-AzureRmAutomationRunbook](./New-AzureRMAutomationRunbook.md) - -[New-AzureRmAutomationRunbook](./New-AzureRMAutomationRunbook.md) - -[Publish-AzureRmAutomationRunbook](./Publish-AzureRMAutomationRunbook.md) - -[Remove-AzureRmAutomationRunbook](./Remove-AzureRMAutomationRunbook.md) - -[Set-AzureRmAutomationRunbook](./Set-AzureRMAutomationRunbook.md) - -[Start-AzureRmAutomationRunbook](./Start-AzureRMAutomationRunbook.md) diff --git a/azurermps-6.13.0/AzureRM.Automation/Import-AzureRmAutomationDscConfiguration.md b/azurermps-6.13.0/AzureRM.Automation/Import-AzureRmAutomationDscConfiguration.md deleted file mode 100644 index e4a6ceed73..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Import-AzureRmAutomationDscConfiguration.md +++ /dev/null @@ -1,232 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: BA508F0B-847F-4531-9D5D-A5A044A2D207 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/import-azurermautomationdscconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Import-AzureRmAutomationDscConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Import-AzureRmAutomationDscConfiguration.md ---- - -# Import-AzureRmAutomationDscConfiguration - -## SYNOPSIS -Imports a DSC configuration into Automation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Import-AzureRmAutomationDscConfiguration -SourcePath [-Tags ] [-Description ] - [-Published] [-Force] [-LogVerbose ] [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Import-AzureRmAutomationDscConfiguration** cmdlet imports an APS Desired State Configuration (DSC) configuration into Azure Automation. -Specify the path of an APS script that contains a single DSC configuration. - -## EXAMPLES - -### Example 1: Import a DSC configuration into Automation -``` -PS C:\>Import-AzureRmAutomationDscConfiguration -AutomationAccountName "Contoso17"-ResourceGroupName "ResourceGroup01" -SourcePath "C:\DSC\client.ps1" -Force -``` - -This command imports the DSC configuration in the file named client.ps1 into the Automation account -named Contoso17. The command specifies the *Force* parameter. If there is an existing DSC -configuration, this command replaces it. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account into which this cmdlet imports a DSC configuration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the configuration that this cmdlet imports. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Indicates that this cmdlet replaces an existing DSC configuration in Automation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogVerbose -Specifies whether this cmdlet turns verbose logging on or off for compilation jobs of this DSC -configuration. Specify a value of $True to turn verbose logging on or $False to turn it off. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Published -Indicates that this cmdlet imports the DSC configuration in the published state. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group for which this cmdlet imports a DSC configuration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourcePath -Specifies the path of the wps_2 script that contains the DSC configuration that this cmdlet imports. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Path - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tags -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.IDictionary -Parameter Sets: (All) -Aliases: Tag - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.IDictionary - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.DscConfiguration - -## NOTES - -## RELATED LINKS - -[Export-AzureRmAutomationDscConfiguration](./Export-AzureRmAutomationDscConfiguration.md) - -[Get-AzureRmAutomationDscConfiguration](./Get-AzureRmAutomationDscConfiguration.md) diff --git a/azurermps-6.13.0/AzureRM.Automation/Import-AzureRmAutomationDscNodeConfiguration.md b/azurermps-6.13.0/AzureRM.Automation/Import-AzureRmAutomationDscNodeConfiguration.md deleted file mode 100644 index e63fa0b30c..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Import-AzureRmAutomationDscNodeConfiguration.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: CC9D74BB-DFB2-41F3-B5CF-B265C549EC33 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/import-azurermautomationdscnodeconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Import-AzureRmAutomationDscNodeConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Import-AzureRmAutomationDscNodeConfiguration.md ---- - -# Import-AzureRmAutomationDscNodeConfiguration - -## SYNOPSIS -Imports a MOF document as a DSC node configuration in Automation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Import-AzureRmAutomationDscNodeConfiguration -Path -ConfigurationName [-Force] - [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] - [-IncrementNodeConfigurationBuild] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Import-AzureRmAutomationDscConfiguration** cmdlet imports a Managed Object Format (MOF) configuration document into Azure Automation as a Desired State Configuration (DSC) node configuration. -Specify the path of a .mof file. - -## EXAMPLES - -### Example 1: Import a DSC node configuration into Automation -``` -PS C:\>Import-AzureRmAutomationDscConfiguration -AutomationAccountName "Contoso17" -ResourceGroupName "ResourceGroup01" -ConfigurationName "ContosoConfiguration" -Path "C:\DSC\webserver.mof" -Force -``` - -This command imports a DSC node configuration from the file named webserver.mof into the Automation account named Contoso17, under the DSC configuration ContosoConfiguration. -The command specifies the *Force* parameter. -If there is an existing DSC node configuration named ContosoConfiguration.webserver, this command replaces it. - -### Example 2: Import a DSC node configuration into Automation and create a new build version and not overwrite existing NodeConfiguration. -``` -PS C:\>Import-AzureRmAutomationDscConfiguration -AutomationAccountName "Contoso17" -ResourceGroupName "ResourceGroup01" -ConfigurationName "ContosoConfiguration" -Path "C:\DSC\webserver.mof" -IncrementNodeConfigurationBuild -``` - -This command imports a DSC node configuration from the file named webserver.mof into the Automation account named Contoso17, under the DSC configuration ContosoConfiguration. -The command specifies the *Force* parameter. -If there is an existing DSC node configuration named ContosoConfiguration.webserver, this command adds a new build version with the name ContosoConfiguration[2].webserver. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account into which this cmdlet imports a DSC node configuration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConfigurationName -Specifies the name of a DSC configuration in Automation to use as the namespace and container for the node configuration to import. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Indicates that this cmdlet replaces an existing DSC node configuration in Automation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncrementNodeConfigurationBuild -Creates a new Node Configuration build version. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path of the MOF configuration document that this cmdlet imports. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group for which this cmdlet imports a DSC node configuration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.NodeConfiguration - -## NOTES - -## RELATED LINKS - -[Export-AzureRmAutomationDscConfiguration](./Export-AzureRmAutomationDscConfiguration.md) - -[Get-AzureRmAutomationDscConfiguration](./Get-AzureRmAutomationDscConfiguration.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/New-AzureRMAutomationCertificate.md b/azurermps-6.13.0/AzureRM.Automation/New-AzureRMAutomationCertificate.md deleted file mode 100644 index b3967eef61..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/New-AzureRMAutomationCertificate.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: A504099E-BA96-45C9-A7A6-195E7087A0D4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/new-azurermautomationcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/New-AzureRMAutomationCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/New-AzureRMAutomationCertificate.md ---- - -# New-AzureRmAutomationCertificate - -## SYNOPSIS -Creates an Automation certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmAutomationCertificate [-Name] [-Description ] [-Password ] - [-Path] [-Exportable] [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureRmAutomationCertificate** cmdlet creates a certificate in Azure Automation. -Provide the path to a certificate file to upload. - -## EXAMPLES - -### Example 1: Create a new certificate -``` -PS C:\>$Password = ConvertTo-SecureString -String "Password" -AsPlainText -Force -PS C:\> New-AzureRmAutomationCertificate -AutomationAccountName "Contoso17" -Name "ContosoCertificate" -Path "./cert.pfx" -Password $Password -ResourceGroupName "ResourceGroup01" -``` - -The first command converts a plain text password to be a secure string by using the ConvertTo-SecureString cmdlet. -The command stores that object in the $Password variable. -The second command creates a certificate named ContosoCertificate. -The command uses the password stored in $Password. -The command specifies the account name and the path of the file that it uploads. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account for which this cmdlet stores the certificate. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the certificate. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Exportable -Specifies whether the certificate can be exported. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name for the certificate. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Password -Specifies the password for the certificate file. - -```yaml -Type: System.Security.SecureString -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the path to a script file that this cmdlet uploads. -The file can be a .cer or a .pfx file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for which this cmdlet creates a certificate. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Security.SecureString - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.CertificateInfo - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationCertificate](./Get-AzureRMAutomationCertificate.md) - -[Remove-AzureRmAutomationCertificate](./Remove-AzureRMAutomationCertificate.md) - -[Set-AzureRmAutomationCertificate](./Set-AzureRMAutomationCertificate.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/New-AzureRMAutomationConnection.md b/azurermps-6.13.0/AzureRM.Automation/New-AzureRMAutomationConnection.md deleted file mode 100644 index 91f7e131cb..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/New-AzureRMAutomationConnection.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 95103160-8101-4C43-8DAA-0BD75DFF3150 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/new-azurermautomationconnection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/New-AzureRMAutomationConnection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/New-AzureRMAutomationConnection.md ---- - -# New-AzureRmAutomationConnection - -## SYNOPSIS -Creates an Automation connection. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmAutomationConnection [-Name] [-ConnectionTypeName] - [-ConnectionFieldValues] [-Description ] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureRmAutomationConnection** cmdlet creates a connection in Azure Automation. - -## EXAMPLES - -### Example 1: Create a connection -``` -PS C:\>$FieldValues = @{"AutomationCertificateName"="ContosoCertificate";"SubscriptionID"="81b59010-dc55-45b7-89cd-5ca26db62472"} -PS C:\> New-AzureRmAutomationConnection -Name "Connection12" -ConnectionTypeName Azure -ConnectionFieldValues $FieldValues -ResourceGroupName "ResourceGroup01" -AutomationAccountName "AutomationAccount01" -``` - -The first command assigns a hash table of field values to the $FieldValue variable. -The second command creates an Azure connection named Connection12 in the Automation account named AutomationAccount01. -The command uses the connection field values in $FieldValues. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account for which this cmdlet creates a connection. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConnectionFieldValues -Specifies a hash table that contains key/value pairs. -The keys represent the connection fields for the specified connection type. -The values represent the specific values of each connection field for the connection instance. - -```yaml -Type: System.Collections.IDictionary -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConnectionTypeName -Specifies the name of the connection type. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the connection. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the connection. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for which this cmdlet creates a connection. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.IDictionary - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.Connection - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationConnection](./Get-AzureRMAutomationConnection.md) - -[Remove-AzureRmAutomationConnection](./Remove-AzureRMAutomationConnection.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/New-AzureRMAutomationCredential.md b/azurermps-6.13.0/AzureRM.Automation/New-AzureRMAutomationCredential.md deleted file mode 100644 index e1b337b026..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/New-AzureRMAutomationCredential.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 739EB137-E4A8-4E85-96BD-4CF26D2C5763 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/new-azurermautomationcredential -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/New-AzureRMAutomationCredential.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/New-AzureRMAutomationCredential.md ---- - -# New-AzureRmAutomationCredential - -## SYNOPSIS -Creates an Automation credential. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmAutomationCredential [-Name] [-Description ] [-Value] - [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **New-AzureRmAutomationCredential** cmdlet creates a credential as a **PSCredential** object in Azure Automation. - -## EXAMPLES - -### Example 1: Create a credential -``` -PS C:\>$User = "Contoso\PFuller" -PS C:\> $Password = ConvertTo-SecureString "Password" -AsPlainText -Force -PS C:\> $Credential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $User, $Password -PS C:\> New-AzureRmAutomationCredential -AutomationAccountName "Contoso17" -Name "ContosoCredential" -Value $Credential -ResourceGroupName "ResourceGroup01" -``` - -The first command assigns a user name to the $User variable. -The second command converts a plain text password into a secure string by using the ConvertTo-SecureString cmdlet. -The command stores that object in the $Password variable. -The third command creates a credential based on $User and $Password, and then stores it in the $Credential variable. -The final command creates an Automation credential named ContosoCredential that uses $Credential. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account in which this cmdlet stores the credential. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the credential. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the credential. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies a description for the resource group for which this cmdlet creates a credential. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Value -Specifies the credentials as a **PSCredential** object. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.PSCredential - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.CredentialInfo - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationCredential](./Get-AzureRMAutomationCredential.md) - -[Remove-AzureRmAutomationCredential](./Remove-AzureRMAutomationCredential.md) - -[Set-AzureRmAutomationCredential](./Set-AzureRMAutomationCredential.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/New-AzureRMAutomationRunbook.md b/azurermps-6.13.0/AzureRM.Automation/New-AzureRMAutomationRunbook.md deleted file mode 100644 index f7da12deb7..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/New-AzureRMAutomationRunbook.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: B6E35D4D-B2C1-4527-94A6-E7E3488F510B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/new-azurermautomationrunbook -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/New-AzureRMAutomationRunbook.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/New-AzureRMAutomationRunbook.md ---- - -# New-AzureRmAutomationRunbook - -## SYNOPSIS -Creates an Automation runbook. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmAutomationRunbook [-Name] [-Description ] [-Tags ] -Type - [-LogProgress ] [-LogVerbose ] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureRmAutomationRunbook** cmdlet creates an empty Azure Automation runbook by using APS. -Specify a name for the runbook. - -## EXAMPLES - -### Example 1: Create a runbook -``` -PS C:\>New-AzureRmAutomationRunbook -AutomationAccountName "Contoso17" -Name "Runbook02" -ResourceGroupName "ResourceGroup01" -``` - -This command creates a runbook named Runbook02 in the Azure Automation account named Contoso17. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account in which this cmdlet creates a runbook. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the runbook. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogProgress -Specifies whether the runbook logs progress. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogVerbose -Specifies whether logging includes detailed information. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the runbook. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: RunbookName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for which this cmdlet creates a runbook. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tags -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.IDictionary -Parameter Sets: (All) -Aliases: Tag - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Type -Specifies the type of runbook that this cmdlet creates. -Valid values are: -- PowerShell -- GraphicalPowerShell -- PowerShellWorkflow -- GraphicalPowerShellWorkflow -- Graph -The value Graph is obsolete. -It is equivalent to GraphicalPowerShellWorkflow. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: PowerShell, GraphicalPowerShell, PowerShellWorkflow, GraphicalPowerShellWorkflow, Graph - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.IDictionary - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.Runbook - -## NOTES - -## RELATED LINKS - -[Export-AzureRmAutomationRunbook](./Export-AzureRMAutomationRunbook.md) - -[Get-AzureRmAutomationRunbook](./Get-AzureRMAutomationRunbook.md) - -[Import-AzureRmAutomationRunbook](./Import-AzureRMAutomationRunbook.md) - -[Publish-AzureRmAutomationRunbook](./Publish-AzureRMAutomationRunbook.md) - -[Remove-AzureRmAutomationRunbook](./Remove-AzureRMAutomationRunbook.md) - -[Set-AzureRmAutomationRunbook](./Set-AzureRMAutomationRunbook.md) - -[Start-AzureRmAutomationRunbook](./Start-AzureRMAutomationRunbook.md) diff --git a/azurermps-6.13.0/AzureRM.Automation/New-AzureRMAutomationSchedule.md b/azurermps-6.13.0/AzureRM.Automation/New-AzureRMAutomationSchedule.md deleted file mode 100644 index 79b5faef15..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/New-AzureRMAutomationSchedule.md +++ /dev/null @@ -1,420 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: CB621890-EF8A-4F14-8F18-D8806E624DAB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/new-azurermautomationschedule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/New-AzureRMAutomationSchedule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/New-AzureRMAutomationSchedule.md ---- - -# New-AzureRmAutomationSchedule - -## SYNOPSIS -Creates an Automation schedule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByDaily (Default) -``` -New-AzureRmAutomationSchedule [-Name] [-StartTime] [-Description ] - [-ExpiryTime ] -DayInterval [-TimeZone ] [-ForUpdateConfiguration] - [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] - [] -``` - -### ByWeekly -``` -New-AzureRmAutomationSchedule [-Name] [-StartTime] [-Description ] - [-DaysOfWeek ] [-ExpiryTime ] -WeekInterval [-TimeZone ] - [-ForUpdateConfiguration] [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -### ByMonthlyDaysOfMonth -``` -New-AzureRmAutomationSchedule [-Name] [-StartTime] [-Description ] - [-DaysOfMonth ] [-ExpiryTime ] -MonthInterval [-TimeZone ] - [-ForUpdateConfiguration] [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -### ByMonthlyDayOfWeek -``` -New-AzureRmAutomationSchedule [-Name] [-StartTime] [-Description ] - [-DayOfWeek ] [-DayOfWeekOccurrence ] [-ExpiryTime ] - -MonthInterval [-TimeZone ] [-ForUpdateConfiguration] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -### ByOneTime -``` -New-AzureRmAutomationSchedule [-Name] [-StartTime] [-Description ] [-OneTime] - [-TimeZone ] [-ForUpdateConfiguration] [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -### ByHourly -``` -New-AzureRmAutomationSchedule [-Name] [-StartTime] [-Description ] - [-ExpiryTime ] -HourInterval [-TimeZone ] [-ForUpdateConfiguration] - [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **New-AzureRmAutomationSchedule** cmdlet creates a schedule in Azure Automation. - -## EXAMPLES - -### Example 1: Create a one-time schedule in local time -``` -PS C:\> $TimeZone = ([System.TimeZoneInfo]::Local).Id -PS C:\> New-AzureRmAutomationSchedule -AutomationAccountName "Contoso17" -Name "Schedule01" -StartTime "23:00" -OneTime -ResourceGroupName "ResourceGroup01" -TimeZone $TimeZone -``` - -The first command gets the time zone ID from the system and stores it in the $TimeZone variable. -The second command creates a schedule that runs one time on the current date at 11:00 PM in the specified time zone.. - -### Example 2: Create a recurring schedule -``` -PS C:\> $StartTime = Get-Date "13:00:00" -PS C:\> $EndTime = $StartTime.AddYears(1) -PS C:\> New-AzureRmAutomationSchedule -AutomationAccountName "Contoso17" -Name "Schedule02" -StartTime $StartTime -ExpiryTime $EndTime -DayInterval 1 -ResourceGroupName "ResourceGroup01" -``` - -The first command creates a date object by using the **Get-Date** cmdlet, and then stores the object in the $StartDate variable. -Specify a time that is at least five minutes in the future. -The second command creates a date object by using the **Get-Date** cmdlet, and then stores the object in the $EndDate variable. -The command specifies a future time. -The final command creates a daily schedule named Schedule02 to begin at the time stored in $StartDate and expire at the time stored in $EndDate. - -### Example 3: Create a weekly recurring schedule -``` -PS C:\> $StartTime = (Get-Date "13:00:00").AddDays(1) -PS C:\> [System.DayOfWeek[]]$WeekDays = @([System.DayOfWeek]::Monday..[System.DayOfWeek]::Friday) -PS C:\> New-AzureRmAutomationSchedule -AutomationAccountName "Contoso17" -Name "Schedule03" -StartTime $StartTime - WeekInterval 1 -DaysOfWeek $WeekDays -ResourceGroupName "ResourceGroup01" -``` - -The first command creates a date object by using the **Get-Date** cmdlet, and then stores the object in the $StartDate variable. -The second command creates an array of week days that contains Monday, Tuesday, Wednesday, Thursday and Friday. -The final command creates a daily schedule named Schedule03 that will run Monday to Friday each week at 13:00. The schedule will never expire. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of an Automation account for which this cmdlet creates a schedule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DayInterval -Specifies an interval, in days, for the schedule. -If you do not specify this parameter, and you do not specify the *OneTime* parameter, the default value is one (1). - -```yaml -Type: System.Byte -Parameter Sets: ByDaily -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DayOfWeek -Specifies a list of days of the week for the weekly schedule. - -```yaml -Type: System.Nullable`1[System.DayOfWeek] -Parameter Sets: ByMonthlyDayOfWeek -Aliases: -Accepted values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DayOfWeekOccurrence -Specifies the occurrence of the week within the month that the schedule runs. -psdx_paramvalues -- 1 -- 2 -- 3 -- 4 -- -1 -- First -- Second -- Third -- Fourth -- LastDay - -```yaml -Type: Microsoft.Azure.Commands.Automation.Cmdlet.DayOfWeekOccurrence -Parameter Sets: ByMonthlyDayOfWeek -Aliases: -Accepted values: First, Second, Third, Fourth, Last - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DaysOfMonth -Specifies a list of days of the month for the monthly schedule. - -```yaml -Type: Microsoft.Azure.Commands.Automation.Cmdlet.DaysOfMonth[] -Parameter Sets: ByMonthlyDaysOfMonth -Aliases: -Accepted values: One, Two, Three, Four, Five, Six, Seventh, Eighth, Ninth, Tenth, Eleventh, Twelfth, Thirteenth, Fourteenth, Fifteenth, Sixteenth, Seventeenth, Eighteenth, Nineteenth, Twentieth, TwentyFirst, TwentySecond, TwentyThird, TwentyFourth, TwentyFifth, TwentySixth, TwentySeventh, TwentyEighth, TwentyNinth, Thirtieth, ThirtyFirst, LastDay - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DaysOfWeek -Specifies a list of days of the week for the weekly schedule. - -```yaml -Type: System.DayOfWeek[] -Parameter Sets: ByWeekly -Aliases: -Accepted values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the schedule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExpiryTime -Specifies the expiry time of a schedule as a **DateTimeOffest** object. -You can specify a string that can be converted to a valid **DateTimeOffset**. - -```yaml -Type: System.DateTimeOffset -Parameter Sets: ByDaily, ByWeekly, ByMonthlyDaysOfMonth, ByMonthlyDayOfWeek, ByHourly -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForUpdateConfiguration -Indicates that this schedule object will be used for scheduling a software update configuration - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HourInterval -Specifies an interval, in hours, for the schedule. - -```yaml -Type: System.Byte -Parameter Sets: ByHourly -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MonthInterval -Specifies an interval, in Months, for the schedule. - -```yaml -Type: System.Byte -Parameter Sets: ByMonthlyDaysOfMonth, ByMonthlyDayOfWeek -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the schedule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OneTime -Specifies that the cmdlet creates a one-time schedule. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByOneTime -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group for which this cmdlet creates a schedule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartTime -Specifies the start time of a schedule as a **DateTimeOffset** object. -You can specify a string that can be converted to a valid **DateTimeOffset**. -If the *TimeZone* parameter is specified, the offset will be ignored and the time zone specified is used. - -```yaml -Type: System.DateTimeOffset -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TimeZone -Specifies the time zone for the schedule. -This string can be the IANA ID or the Windows Time Zone ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WeekInterval -Specifies an interval, in weeks, for the schedule. - -```yaml -Type: System.Byte -Parameter Sets: ByWeekly -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.DateTimeOffset - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.Schedule - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationSchedule](./Get-AzureRMAutomationSchedule.md) - -[Remove-AzureRmAutomationSchedule](./Remove-AzureRMAutomationSchedule.md) - -[Set-AzureRmAutomationSchedule](./Set-AzureRMAutomationSchedule.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/New-AzureRMAutomationVariable.md b/azurermps-6.13.0/AzureRM.Automation/New-AzureRMAutomationVariable.md deleted file mode 100644 index 170d40abe6..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/New-AzureRMAutomationVariable.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 5AF6F70F-7137-48E2-96ED-2C509042F127 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/new-azurermautomationvariable -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/New-AzureRMAutomationVariable.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/New-AzureRMAutomationVariable.md ---- - -# New-AzureRmAutomationVariable - -## SYNOPSIS -Creates an Automation variable. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmAutomationVariable [-Name] -Encrypted [-Description ] [-Value ] - [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **New-AzureRmAutomationVariable** cmdlet creates a variable in Azure Automation. -To encrypt the variable, specify the *Encrypted* parameter. -You cannot modify the encrypted state of a variable after creation. - -## EXAMPLES - -### Example 1: Create a variable with a simple value -``` -PS C:\>New-AzureRmAutomationVariable -AutomationAccountName "Contoso17" -Name "StringVariable22" -Encrypted $False -Value "My String" -ResourceGroupName "ResourceGroup01" -``` - -This command creates a variable named StringVariable22 with a string value in the Automation account named Contoso17. - -### Example 2: Create a variable with a complex value -``` -PS C:\>$VirtualMachine = Get-AzureVM -ServiceName "VirtualMachine" -Name "VirtualMachine03" -PS C:\> New-AzureRmAutomationVariable -AutomationAccountName "Contoso17" -Name "ComplexVariable01" -Encrypted $False -Value $VirtualMachine -ResourceGroupName "ResourceGroup01" -``` - -The first command gets a virtual machine by using the Get-AzureVM cmdlet. -The command stores it in the $VirtualMachine variable. -The second command creates a variable named ComplexVariable01 in the Automation account named Contoso17. -This command uses a complex object for its value, in this case, the virtual machine in $VirtualMachine. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account in which to store the variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Encrypted -Specifies whether this cmdlet encrypts the value of the variable for storage. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group for which this cmdlet creates a variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Value -Specifies a value for the variable. - -```yaml -Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Boolean - -### System.Object - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.Variable - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationVariable](./Get-AzureRMAutomationVariable.md) - -[Remove-AzureRmAutomationVariable](./Remove-AzureRMAutomationVariable.md) - -[Set-AzureRmAutomationVariable](./Set-AzureRMAutomationVariable.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/New-AzureRMAutomationWebhook.md b/azurermps-6.13.0/AzureRM.Automation/New-AzureRMAutomationWebhook.md deleted file mode 100644 index 7bedfc8332..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/New-AzureRMAutomationWebhook.md +++ /dev/null @@ -1,268 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: E1FC931E-4EB8-4DCA-92BD-8013DDC13219 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/new-azurermautomationwebhook -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/New-AzureRMAutomationWebhook.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/New-AzureRMAutomationWebhook.md ---- - -# New-AzureRmAutomationWebhook - -## SYNOPSIS -Creates a webhook for an Automation runbook. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmAutomationWebhook [-Name] [-RunbookName] [-IsEnabled] - [-ExpiryTime] [-Parameters ] [-Force] [-RunOn ] - [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **New-AzureRmAutomationWebhook** cmdlet creates a webhook for an Azure Automation runbook. -Be sure to save the webhook URL that this cmdlet returns, because it cannot be retrieved again. - -## EXAMPLES - -### Example 1: Create a webhook -``` -PS C:\>$Webhook = New-AzureRmAutomationWebhook -Name "Webhook06" -IsEnabled $True -ExpiryTime "10/2/2016" -RunbookName "ContosoRunbook" -ResourceGroup "ResourceGroup01" -AutomationAccountName "AutomationAccount01" -Force -``` - -This command creates a webhook named Webhook06 for the runbook named ContosoRunbook in the Automation account named AutomationAccount01. -The command stores the webhook in the $Webhook variable. -The webhook is enabled. -The webhook expires at the specified time. -This command does not provide any values for webhook parameters. -This command specifies the *Force* parameter. -Therefore, it does not prompt you for confirmation. - -### Example 2: Create a webhook with parameters -``` -PS C:\>$Params = @{"StringParam"="Hello World";"IntegerParam"=32} -PS C:\> $Webhook = New-AzureRmAutomationWebhook -Name "Webhook11" -Parameters $Params -IsEnabled $True -ExpiryTime "10/2/2016" -RunbookName "ContosoRunbook" -ResourceGroup "ResourceGroup01" -AutomationAccountName "AutomationAccount01" -Force -``` - -The first command creates a dictionary of parameters, and stores them in the $Params variable. -The second command creates a webhook named Webhook11 for the runbook named ContosoRunbook in the Automation account named AutomationAccount01. -The command assigns the parameters in $Params to the webhook. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of an Automation account in which this cmdlet creates a webhook. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpiryTime -Specifies the expiry time for the webhook as a **DateTimeOffset** object. -You can specify a string or a **DateTime** that can be converted to a valid **DateTimeOffset**. - -```yaml -Type: System.DateTimeOffset -Parameter Sets: (All) -Aliases: - -Required: True -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -ps_force - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsEnabled -Specifies whether the webhook is enabled. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the webhook. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Parameters -Specifies a dictionary of key/value pairs. -The keys are the runbook parameter names. -The values are the runbook parameter values. -When the runbook starts in response to a webhook, these parameters are passed to the runbook. - -```yaml -Type: System.Collections.IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for which this cmdlet creates a webhook. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RunbookName -Specifies the name of the runbook to associate to the webhook. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RunOn -Optional name of the hybrid worker group which should execute the runbook - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: HybridWorker - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Boolean - -### System.DateTimeOffset - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.Webhook - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationWebhook](./Get-AzureRMAutomationWebhook.md) - -[Remove-AzureRmAutomationWebhook](./Remove-AzureRMAutomationWebhook.md) - -[Set-AzureRmAutomationWebhook](./Set-AzureRMAutomationWebhook.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/New-AzureRmAutomationAccount.md b/azurermps-6.13.0/AzureRM.Automation/New-AzureRmAutomationAccount.md deleted file mode 100644 index 76ce6322b8..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/New-AzureRmAutomationAccount.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 2D5B16F0-0662-4D9F-A13F-808CE5EEBBA3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/new-azurermautomationaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/New-AzureRmAutomationAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/New-AzureRmAutomationAccount.md ---- - -# New-AzureRmAutomationAccount - -## SYNOPSIS -Creates an Automation account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmAutomationAccount [-ResourceGroupName] [-Name] [-Location] - [-Plan ] [-Tags ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureRmAutomationAccount** cmdlet creates an Azure Automation account in a resource group. -An Automation account is a container for Automation resources that is isolated from the resources -of other Automation accounts. Automation resources include runbooks, Desired State Configuration -(DSC) configurations, jobs, and assets. - -## EXAMPLES - -### Example 1: Create an automation account -``` -PS C:\> New-AzureRmAutomationAccount -Name "ContosoAutomationAccount" -Location "East US" -ResourceGroupName "ResourceGroup01" -``` - -This command creates a new automation account named ContosoAutomationAccount in the East US region. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location in which this cmdlet creates the Automation account. -To obtain valid locations, use the Get-AzureRMLocation cmdlet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the Automation account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AutomationAccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Plan -Specifies the plan for the Automation account. -Valid values are: -- Basic -- Free - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Free, Basic - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group to which this cmdlet adds an Automation account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tags -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.IDictionary -Parameter Sets: (All) -Aliases: Tag - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.IDictionary - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.AutomationAccount - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationAccount](./Get-AzureRmAutomationAccount.md) - -[Remove-AzureRmAutomationAccount](./Remove-AzureRmAutomationAccount.md) - -[Set-AzureRmAutomationAccount](./Set-AzureRmAutomationAccount.md) diff --git a/azurermps-6.13.0/AzureRM.Automation/New-AzureRmAutomationKey.md b/azurermps-6.13.0/AzureRM.Automation/New-AzureRmAutomationKey.md deleted file mode 100644 index 392678352c..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/New-AzureRmAutomationKey.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 055526FA-5DB7-4F1D-81B3-5D9753283FE2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/new-azurermautomationkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/New-AzureRmAutomationKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/New-AzureRmAutomationKey.md ---- - -# New-AzureRmAutomationKey - -## SYNOPSIS -Regenerates registration keys for an Automation account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmAutomationKey [-KeyType] [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureRmAutomationKey** cmdlet regenerates registration keys for an Azure Automation account. - -## EXAMPLES - -### Example 1: Regenerate a key for an Automation account -``` -PS C:\>New-AzureAutomationKey -KeyType Primary -ResourceGroup "ResourceGroup01" -AutomationAccountName "AutomationAccount01" -``` - -This command regenerates the primary key for the Azure Automation account named AutomationAccount01 in the resource group named ResourceGroup01. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of an Automation account for which this cmdlet regenerates keys. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyType -Specifies the type of the agent registration key. -Valid values are: -- Primary -- Secondary - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Primary, Secondary - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. -This cmdlet regenerates keys for an Automation account in the resource group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.AgentRegistration - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Automation/New-AzureRmAutomationModule.md b/azurermps-6.13.0/AzureRM.Automation/New-AzureRmAutomationModule.md deleted file mode 100644 index d289ae1977..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/New-AzureRmAutomationModule.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 2DC97415-D59A-428E-8FFE-56B17B320DAF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/new-azurermautomationmodule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/New-AzureRmAutomationModule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/New-AzureRmAutomationModule.md ---- - -# New-AzureRmAutomationModule - -## SYNOPSIS -Imports a module into Automation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmAutomationModule [-Name] [-ContentLinkUri] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureRmAutomationModule** cmdlet imports a module into Azure Automation. -This command accepts a compressed file that has a .zip file name extension. -The file contains a folder that includes a file that is one of the following types: -- wps_2 module, which has a .psm1 or .dll file name extension -- wps_2 module manifest, which has a .psd1 file name extension -The name of the .zip file, the name of the folder, and the name of the file in the folder must be the same. -Specify the .zip file as a URL that the Automation service can access. -If you import a wps_2 module into Automation by using this cmdlet or the Set-AzureRmAutomationModule cmdlet, the operation is asynchronous. -The command finishes whether the import succeeds or fails. -To check whether it succeeded, run the following command: -`PS C:\\\> $ModuleInstance = Get-AzureRmAutomationModule -Name `ModuleName -Check the **ProvisioningState** property for a value of Succeeded. - -## EXAMPLES - -### Example 1: Import a module -``` -PS C:\>New-AzureRmAutomationModule -AutomationAccountName "Contoso17" -Name "ContosoModule" -ContentLink "http://contosostorage.blob.core.windows.net/modules/ContosoModule.zip" -ResourceGroupName "ResourceGroup01" -``` - -This command imports a module named ContosoModule into the Automation account named Contoso17. -The module is stored in an Azure blob in a storage account named contosostorage and a container named modules. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account for which this cmdlet imports a module. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ContentLinkUri -The url to a module zip package - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: ContentLink - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the module that this cmdlet imports. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group for which this cmdlet imports a module. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Uri - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.Module - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationModule](./Get-AzureRmAutomationModule.md) - -[Remove-AzureRmAutomationModule](./Remove-AzureRmAutomationModule.md) - -[Set-AzureRmAutomationModule](./Set-AzureRmAutomationModule.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/New-AzureRmAutomationSoftwareUpdateConfiguration.md b/azurermps-6.13.0/AzureRM.Automation/New-AzureRmAutomationSoftwareUpdateConfiguration.md deleted file mode 100644 index 20465693d5..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/New-AzureRmAutomationSoftwareUpdateConfiguration.md +++ /dev/null @@ -1,365 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/new-azurermautomationsoftwareupdateconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/New-AzureRmAutomationSoftwareUpdateConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/New-AzureRmAutomationSoftwareUpdateConfiguration.md ---- - -# New-AzureRmAutomationSoftwareUpdateConfiguration - -## SYNOPSIS -Creates a scheduled azure automation software update configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Windows (Default) -``` -New-AzureRmAutomationSoftwareUpdateConfiguration -Schedule [-Windows] - [-AzureVMResourceId ] [-NonAzureComputer ] [-Duration ] - [-IncludedUpdateClassification ] [-ExcludedKbNumber ] - [-IncludedKbNumber ] [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### Linux -``` -New-AzureRmAutomationSoftwareUpdateConfiguration -Schedule [-Linux] [-AzureVMResourceId ] - [-NonAzureComputer ] [-Duration ] [-IncludedPackageClassification ] - [-ExcludedPackageNameMask ] [-IncludedPackageNameMask ] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -Creates a software update configuration that runs on a schedule to update a list of computers. Computers include both azure virtual machines or non-azure computers. - -## EXAMPLES - -### Example 1 -Creates a software update configuration to install critical updates on two Windows azure virtual machines once every Saturday 9PM. Update duration is set to 2 hours in this example. - -```powershell -PS C:\> $startTime = [DateTimeOffset]"2018-09-13T21:00" -PS C:\> $targetMachines = @( ` - "/subscriptions/22e2445a-0984-4fa5-86a4-0280d76c4b2c/resourceGroups/compute/providers/Microsoft.Compute/virtualMachines/vm-w-01", ` - "/subscriptions/22e2445a-0984-4fa5-86a4-0280d76c4b2c/resourceGroups/compute/providers/Microsoft.Compute/virtualMachines/vm-w-02" - ) -PS C:\> $duration = New-TimeSpan -Hours 2 -PS C:\> $schedule = New-AzureRmAutomationSchedule -ResourceGroupName "mygroup" ` - -AutomationAccountName "myaccount" ` - -Name MyWeeklySchedule ` - -StartTime $startTime ` - -DaysOfWeek Saturday ` - -WeekInterval 1 ` - -ForUpdateConfiguration - -New-AzureRmAutomationSoftwareUpdateConfiguration -ResourceGroupName "mygroup" ` - -AutomationAccountName "myaccount" ` - -Schedule $schedule ` - -Windows ` - -AzureVMResourceIds $targetMachines ` - -IncludedUpdateClassifications Critical ` - -Duration $duration - -UpdateConfiguration : Microsoft.Azure.Commands.Automation.Model.UpdateManagement.UpdateConfiguration -ScheduleConfiguration : Microsoft.Azure.Commands.Automation.Model.Schedule -ProvisioningState : Provisioning -ErrorInfo : -ResourceGroupName : mygroup -AutomationAccountName : myaccount -Name : MyWeeklySchedule -CreationTime : 9/14/2018 3:53:27 AM +00:00 -LastModifiedTime : 9/14/2018 3:53:27 AM +00:00 -Description : -``` - -## PARAMETERS - -### -AutomationAccountName -The automation account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AzureVMResourceId -Resource Ids for azure virtual machines. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Duration -Maximum duration for the update. - -```yaml -Type: System.TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExcludedKbNumber -KB numbers of excluded updates. - -```yaml -Type: System.String[] -Parameter Sets: Windows -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExcludedPackageNameMask -Excluded Linux package masks. - -```yaml -Type: System.String[] -Parameter Sets: Linux -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IncludedKbNumber -KB numbers of included updates. - -```yaml -Type: System.String[] -Parameter Sets: Windows -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IncludedPackageClassification -Included Linux package classifications. - -```yaml -Type: Microsoft.Azure.Commands.Automation.Model.UpdateManagement.LinuxPackageClasses[] -Parameter Sets: Linux -Aliases: -Accepted values: Unclassified, Critical, Security, Other - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IncludedPackageNameMask -Included Linux package masks. - -```yaml -Type: System.String[] -Parameter Sets: Linux -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IncludedUpdateClassification -Included Windows Update classifications. - -```yaml -Type: Microsoft.Azure.Commands.Automation.Model.UpdateManagement.WindowsUpdateClasses[] -Parameter Sets: Windows -Aliases: -Accepted values: Unclassified, Critical, Security, UpdateRollup, FeaturePack, ServicePack, Definition, Tools, Updates - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Linux -Indicates that the software update configuration targeting Linux operating system machines. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Linux -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NonAzureComputer -Non-Azure computer names. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Schedule -Schedule object used for software update configuration. - -```yaml -Type: Microsoft.Azure.Commands.Automation.Model.Schedule -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Windows -Indicates that the software update configuration targeting windows operating system machines. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Windows -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Automation.Model.Schedule - -### System.Management.Automation.SwitchParameter - -### System.String[] - -### System.TimeSpan - -### Microsoft.Azure.Commands.Automation.Model.UpdateManagement.WindowsUpdateClasses[] - -### Microsoft.Azure.Commands.Automation.Model.UpdateManagement.LinuxPackageClasses[] - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.UpdateManagement.SoftwareUpdateConfiguration - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Automation/New-AzureRmAutomationSourceControl.md b/azurermps-6.13.0/AzureRM.Automation/New-AzureRmAutomationSourceControl.md deleted file mode 100644 index 28484aeaa7..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/New-AzureRmAutomationSourceControl.md +++ /dev/null @@ -1,323 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/new-azurermautomationsourcecontrol -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/New-AzureRmAutomationSourceControl.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/New-AzureRmAutomationSourceControl.md ---- - -# New-AzureRmAutomationSourceControl - -## SYNOPSIS -Creates an A Automation source control. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmAutomationSourceControl -Name -RepoUrl -SourceType - -AccessToken -FolderPath [-Branch ] [-Description ] [-EnableAutoSync] - [-DoNotPublishRunbook] [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The New-AzureRmAutomationSourceControl cmdlet creates a configuration to link my Azure Automation account with my VSTS TFVC, VSTS Git or GitHub. - -## EXAMPLES - -### Example 1 -Create a source control configuration to link my Azure Automation account with my VSTS TFVC project. TFVC projects do not have branches, and therefore, the Branch parameter is not specified. - -```powershell -PS C:\> # VSTS Personal access token -PS C:\> $token = "vppmrabbs65axamofglyo66rjg6reddaa7xxgvaddd5555aaaaddxzbmma" -PS C:\> $accessToken = ConvertTo-SecureString -String $token -AsPlainText -Force -PS C:\> New-AzureRmAutomationSourceControl -ResourceGroupName "rg1" ` - -AutomationAccountName "devAccount" ` - -Name "VSTSNative" ` - -RepoUrl "https://contoso.visualstudio.com/ContosoProduction/_versionControl" ` - -SourceType "VsoTfvc" ` - -FolderPath "/Runbooks" ` - -AccessToken $accessToken - -Name SourceType Branch FolderPath AutoSync PublishRunbook RepoUrl ----- ---------- ------ ---------- -------- -------------- ------- -VSTSNative VsoTfvc /Runbooks True True https://contoso.visualstudio.com/ContosoProduc... -``` - -### Example 2 -Create a source control configuration to link my Azure Automation account with my VSTS Git project. - - -```powershell -PS C:\> # VSTS Personal access token -PS C:\> $token = "vppmrabbs65axamofglyo66rjg6reddaa7xxgvaddd5555aaaaddxzbmma" -PS C:\> $accessToken = ConvertTo-SecureString -String $token -AsPlainText -Force -PS C:\> New-AzureRmAutomationSourceControl -ResourceGroupName "rg1" ` - -AutomationAccountName "devAccount" ` - -Name "VSTSGit" ` - -RepoUrl "https://contoso.visualstudio.com/_git/Finance" ` - -SourceType "VsoGit" ` - -Branch "Development" ` - -FolderPath "/" ` - -AccessToken $accessToken - -Name SourceType Branch FolderPath AutoSync PublishRunbook RepoUrl ----- ---------- ------ ---------- -------- -------------- ------- -VSTSGit VsoGit Development / True True https://contoso.visualstudio.com/_git/Finan... -``` - -### Example 3 -Create a source control configuration to link my Azure Automation account with my GitHub project. - - -```powershell -PS C:\> # GitHub access token -PS C:\> $token = "68b08011223aac8bdd3388913a44rrsaa84fdf" -PS C:\> $accessToken = ConvertTo-SecureString -String $token -AsPlainText -Force -PS C:\> New-AzureRmAutomationSourceControl -ResourceGroupName "rg1" ` - -AutomationAccountName "devAccount" ` - -Name "GitHub1" ` - -RepoUrl "https://github.com/Contoso/TestSourceControl.git" ` - -SourceType "GitHub" ` - -Branch "master" ` - -FolderPath "/Runbooks" ` - -AccessToken $accessToken - -Name SourceType Branch FolderPath AutoSync PublishRunbook RepoUrl ----- ---------- ------ ---------- -------- -------------- ------- -GitHub1 GitHub master /Runbooks True True https://github.com/Contoso/TestSourceControl... -``` - -## PARAMETERS - -### -AccessToken -The source control access token. - -```yaml -Type: System.Security.SecureString -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutomationAccountName -The automation account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Branch -The source control branch. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The source control description. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DoNotPublishRunbook -The publishRunbook property of the source control. -If DoNotPublishRunbook is set, this means that user runbooks will be imported as 'Draft'. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableAutoSync -The autoSync property for the source control. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FolderPath -The source control folder path. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The source control name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RepoUrl -The source control repo url. - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceType -The source control type. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: GitHub, VsoGit, VsoTfvc - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.SourceControl - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Automation/Publish-AzureRMAutomationRunbook.md b/azurermps-6.13.0/AzureRM.Automation/Publish-AzureRMAutomationRunbook.md deleted file mode 100644 index f8e2b60bfe..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Publish-AzureRMAutomationRunbook.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: E7F31B71-983A-4DB3-BB30-BDC5C0247E74 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/publish-azurermautomationrunbook -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Publish-AzureRMAutomationRunbook.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Publish-AzureRMAutomationRunbook.md ---- - -# Publish-AzureRmAutomationRunbook - -## SYNOPSIS -Publishes a runbook. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Publish-AzureRmAutomationRunbook [-Name] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Publish-AzureRmAutomationRunbook** cmdlet publishes a runbook for use in the production environment of Azure Automation. - -## EXAMPLES - -### Example 1: Publish a runbook -``` -PS C:\>Publish-AzureRmAutomationRunbook -AutomationAccountName "Contoso17" -Name "Runbk01" -ResourceGroupName "ResourceGroup01" -``` - -This command publishes the runbook named Runbk01 in the Azure Automation account named Contoso17. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account in which this cmdlet publishes a runbook. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the runbook that this cmdlet publishes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: RunbookName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for which this cmdlet publishes a runbook. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.Runbook - -## NOTES - -## RELATED LINKS - -[Export-AzureRmAutomationRunbook](./Export-AzureRMAutomationRunbook.md) - -[Get-AzureRmAutomationRunbook](./Get-AzureRMAutomationRunbook.md) - -[Import-AzureRmAutomationRunbook](./Import-AzureRMAutomationRunbook.md) - -[New-AzureRmAutomationRunbook](./New-AzureRMAutomationRunbook.md) - -[New-AzureRmAutomationRunbook](./New-AzureRMAutomationRunbook.md) - -[Remove-AzureRmAutomationRunbook](./Remove-AzureRMAutomationRunbook.md) - -[Set-AzureRmAutomationRunbook](./Set-AzureRMAutomationRunbook.md) - -[Start-AzureRmAutomationRunbook](./Start-AzureRMAutomationRunbook.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Register-AzureRMAutomationScheduledRunbook.md b/azurermps-6.13.0/AzureRM.Automation/Register-AzureRMAutomationScheduledRunbook.md deleted file mode 100644 index b8d2e39417..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Register-AzureRMAutomationScheduledRunbook.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: F79AFF9A-CEDA-4E57-B5DB-9D0A7CDA6D27 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/register-azurermautomationscheduledrunbook -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Register-AzureRMAutomationScheduledRunbook.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Register-AzureRMAutomationScheduledRunbook.md ---- - -# Register-AzureRmAutomationScheduledRunbook - -## SYNOPSIS -Associates a runbook to a schedule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByRunbookName (Default) -``` -Register-AzureRmAutomationScheduledRunbook [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -### ByRunbookNameAndScheduleName -``` -Register-AzureRmAutomationScheduledRunbook -RunbookName -ScheduleName - [-Parameters ] [-RunOn ] [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Register-AzureRmAutomationScheduledRunbook** cmdlet associates an Azure Automation runbook to a schedule. -The runbook starts based on the schedule you specify using the *ScheduleName* parameter. - -## EXAMPLES - -### Example 1: Associate a runbook with a schedule -``` -PS C:\>Register-AzureRmAutomationScheduledRunbook -AutomationAccountName "Contoso17" -Name "Runbk01" -ScheduleName "Sched01" -ResourceGroupName "ResourceGroup01" -``` - -This command associates the runbook named Runbk01 with the schedule named Sched01 in the Azure Automation account named Contoso17. - -## PARAMETERS - -### -AutomationAccountName -Specifies an Automation account for the runbook on which this cmdlet operates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Parameters -Specifies a hash table of key/value pairs. -The keys are runbook parameter names. -The values are runbook parameter values. -When the runbook starts in response to the associated schedule, these parameters are passed to the runbook. - -```yaml -Type: System.Collections.IDictionary -Parameter Sets: ByRunbookNameAndScheduleName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group for the scheduled runbook. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RunbookName -Specifies the name of the runbook that this cmdlet associates to a schedule. - -```yaml -Type: System.String -Parameter Sets: ByRunbookNameAndScheduleName -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RunOn -The name of the hybrid runbook worker group. - -```yaml -Type: System.String -Parameter Sets: ByRunbookNameAndScheduleName -Aliases: HybridWorker - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScheduleName -Specifies the name of the schedule to which this cmdlet associates a runbook. - -```yaml -Type: System.String -Parameter Sets: ByRunbookNameAndScheduleName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.JobSchedule - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationScheduledRunbook](./Get-AzureRMAutomationScheduledRunbook.md) - -[Unregister-AzureRmAutomationScheduledRunbook](./Unregister-AzureRMAutomationScheduledRunbook.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Register-AzureRmAutomationDscNode.md b/azurermps-6.13.0/AzureRM.Automation/Register-AzureRmAutomationDscNode.md deleted file mode 100644 index e0b83ddf7c..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Register-AzureRmAutomationDscNode.md +++ /dev/null @@ -1,273 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 73E6DF02-7171-481B-966F-DECEC122A602 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/register-azurermautomationdscnode -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Register-AzureRmAutomationDscNode.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Register-AzureRmAutomationDscNode.md ---- - -# Register-AzureRmAutomationDscNode - -## SYNOPSIS -Registers an Azure virtual machine as a DSC node for an Automation account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Register-AzureRmAutomationDscNode -AzureVMName [-NodeConfigurationName ] - [-ConfigurationMode ] [-ConfigurationModeFrequencyMins ] [-RefreshFrequencyMins ] - [-RebootNodeIfNeeded ] [-ActionAfterReboot ] [-AllowModuleOverwrite ] - [-AzureVMResourceGroup ] [-AzureVMLocation ] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Register-AzureRmAutomationDscNode** cmdlet registers an Azure virtual machine as an APS Desired State Configuration (DSC) node in an Azure Automation account. - -## EXAMPLES - -### Example 1: Register an Azure virtual machine as an Azure DSC node -``` -PS C:\>Register-AzureRmAutomationDscNode -AutomationAccountName "Contoso17" -AzureVMName "VirtualMachine01" -ResourceGroupName "ResourceGroup01"-NodeConfigurationName "ContosoConfiguration.webserver" -``` - -This command registers the Azure virtual machine named VirtualMachine01 as a DSC node in the Automation account named Contoso17. - -## PARAMETERS - -### -ActionAfterReboot -Specifies the action that the virtual machine takes after it restarts. -Valid values are: -- ContinueConfiguration -- StopConfiguration - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: ContinueConfiguration, StopConfiguration - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AllowModuleOverwrite -Specifies whether new configurations that this DSC node downloads from the Azure Automation DSC pull server replace the existing modules already on the target node. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AutomationAccountName -Specifies the name of an Automation account in which this cmdlet registers a virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AzureVMLocation -Specifies the location in which this cmdlet registers a virtual machine. -To obtain valid locations, use the Get-AzureRMLocation cmdlet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AzureVMName -Specifies the name of the Azure virtual machine that this cmdlet registers for management. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AzureVMResourceGroup -Specifies the name of the resource group of the Azure virtual machine that this cmdlet registers. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConfigurationMode -Specifies the DSC configuration mode. -Valid values are: -- ApplyAndMonitor -- ApplyAndAutocorrect -- ApplyOnly - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: ApplyAndMonitor, ApplyAndAutocorrect, ApplyOnly - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConfigurationModeFrequencyMins -Specifies the frequency, in minutes, at which the background application of DSC attempts to implement the current configuration on the target node. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NodeConfigurationName -Specifies the name of the node configuration that this cmdlet configures the virtual machine to pull from Azure Automation DSC. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RebootNodeIfNeeded -Specifies whether to restart the virtual machine, if needed. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RefreshFrequencyMins -Specifies the frequency, in minutes, at which the local Configuration Manager contacts the Azure Automation DSC pull server to download the latest node configuration. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. -The Automation account with which this cmdlet registers a virtual machine belongs to the resource group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Int32 - -### System.Boolean - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationDscNode](./Get-AzureRmAutomationDscNode.md) - -[Set-AzureRmAutomationDscNode](./Set-AzureRmAutomationDscNode.md) - -[Unregister-AzureRmAutomationDscNode](./Unregister-AzureRmAutomationDscNode.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRMAutomationCertificate.md b/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRMAutomationCertificate.md deleted file mode 100644 index c2150b1e2c..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRMAutomationCertificate.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: C0B24E18-9163-458A-8297-93CB5C2003FA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/remove-azurermautomationcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Remove-AzureRMAutomationCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Remove-AzureRMAutomationCertificate.md ---- - -# Remove-AzureRmAutomationCertificate - -## SYNOPSIS -Removes an Automation certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmAutomationCertificate [-Name] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Remove-AzureRmAutomationCertificate** cmdlet removes a certificate from Azure Automation. - -## EXAMPLES - -### Example 1: Remove a certificate -``` -PS C:\>Remove-AzureRmAutomationCertificate -AutomationAccountName "Contoso17" -Name "Cert01" -ResourceGroupName "ResourceGroup01" -``` - -This command removes a certificate named Cert01 in the Automation account named Contoso17. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account for which this cmdlet removes a certificate. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the certificate that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for which this cmdlet removes a certificate. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationCertificate](./Get-AzureRMAutomationCertificate.md) - -[New-AzureRmAutomationCertificate](./New-AzureRMAutomationCertificate.md) - -[Set-AzureRmAutomationCertificate](./Set-AzureRMAutomationCertificate.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRMAutomationConnection.md b/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRMAutomationConnection.md deleted file mode 100644 index 20a2f8f8ad..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRMAutomationConnection.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: C1C0F69D-6A3F-4523-BB70-27676A3DDCBD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/remove-azurermautomationconnection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Remove-AzureRMAutomationConnection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Remove-AzureRMAutomationConnection.md ---- - -# Remove-AzureRmAutomationConnection - -## SYNOPSIS -Removes an Automation connection. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmAutomationConnection [-Name] [-Force] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Remove-AzureRmAutomationConnection** cmdlet removes a connection from Azure Automation. - -## EXAMPLES - -### Example 1: Remove a connection -``` -PS C:\>Remove-AzureRmAutomationConnection -AutomationAccountName "Contoso17" -Name "ContosoConnection" -ResourceGroupName "ResourceGroup01" -``` - -This command removes a certificate named ContosoConnection in the Automation account named Contoso17. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the automation account for which this cmdlet removes a connection. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -ps_force - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the connection that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for which this cmdlet removes a connection. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationConnection](./Get-AzureRMAutomationConnection.md) - -[New-AzureRmAutomationConnection](./New-AzureRMAutomationConnection.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRMAutomationCredential.md b/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRMAutomationCredential.md deleted file mode 100644 index be2cf7606c..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRMAutomationCredential.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: B53B765F-5CFC-4BF8-A48A-E638A73E1FC5 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/remove-azurermautomationcredential -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Remove-AzureRMAutomationCredential.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Remove-AzureRMAutomationCredential.md ---- - -# Remove-AzureRmAutomationCredential - -## SYNOPSIS -Removes an Automation credential. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmAutomationCredential [-Name] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Remove-AzureRmAutomationCredential** cmdlet removes a credential from Azure Automation. - -## EXAMPLES - -### Example 1: Remove a credential -``` -PS C:\>Remove-AzureRmAutomationCredential -AutomationAccountName "Contoso17" -Name "ContosoCredential" -ResourceGroupName "ResourceGroup01" -``` - -This command removes a credential named ContosoCredential in the Azure Automation account named Contoso17. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account from which this cmdlet removes a credential. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the credential that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for which this cmdlet removes a credential. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationCredential](./Get-AzureRMAutomationCredential.md) - -[New-AzureRmAutomationCredential](./New-AzureRMAutomationCredential.md) - -[Set-AzureRmAutomationCredential](./Set-AzureRMAutomationCredential.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRMAutomationRunbook.md b/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRMAutomationRunbook.md deleted file mode 100644 index dc69f62f1f..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRMAutomationRunbook.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 16055879-C001-46E7-B8C3-1FE2A1A67AC4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/remove-azurermautomationrunbook -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Remove-AzureRMAutomationRunbook.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Remove-AzureRMAutomationRunbook.md ---- - -# Remove-AzureRmAutomationRunbook - -## SYNOPSIS -Removes a runbook. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmAutomationRunbook [-Name] [-Force] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Remove-AzureRmAutomationRunbook** cmdlet removes a runbook from Azure Automation. - -## EXAMPLES - -### Example 1: Remove a runbook -``` -PS C:\>Remove-AzureRmAutomationRunbook -AutomationAccountName "Contoso17" -Name "Runbook03" -ResourceGroupName "ResourceGroup01" -``` - -This command removes the runbook named Runbook03 in the Azure Automation account named Contoso17. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account in which this cmdlet removes a runbook. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -ps_force - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the runbook that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: RunbookName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for which this cmdlet publishes a runbook. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Export-AzureRmAutomationRunbook](./Export-AzureRMAutomationRunbook.md) - -[Get-AzureRmAutomationRunbook](./Get-AzureRMAutomationRunbook.md) - -[Import-AzureRmAutomationRunbook](./Import-AzureRMAutomationRunbook.md) - -[New-AzureRmAutomationRunbook](./New-AzureRMAutomationRunbook.md) - -[New-AzureRmAutomationRunbook](./New-AzureRMAutomationRunbook.md) - -[Publish-AzureRmAutomationRunbook](./Publish-AzureRMAutomationRunbook.md) - -[Set-AzureRmAutomationRunbook](./Set-AzureRMAutomationRunbook.md) - -[Start-AzureRmAutomationRunbook](./Start-AzureRMAutomationRunbook.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRMAutomationSchedule.md b/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRMAutomationSchedule.md deleted file mode 100644 index 477662962a..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRMAutomationSchedule.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: EAD39EE1-C66F-4092-8876-E7F9FA612481 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/remove-azurermautomationschedule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Remove-AzureRMAutomationSchedule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Remove-AzureRMAutomationSchedule.md ---- - -# Remove-AzureRmAutomationSchedule - -## SYNOPSIS -Deletes an Automation schedule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmAutomationSchedule [-Name] [-Force] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Remove-AzureRmAutomationSchedule** cmdlet deletes a schedule from Azure Automation. - -## EXAMPLES - -### Example 1: Remove a schedule -``` -PS C:\>Remove-AzureRmAutomationSchedule -AutomationAccountName "Contoso17" -Name "Schedule01" -ResourceGroupName "ResourceGroup01" -``` - -This command deletes the schedule named Schedule01 in automation account Contoso17 in resource group ResourceGroup01. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of an Automation account for which this cmdlet removes a schedule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -ps_force - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name for the schedule that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group for which this cmdlet removes a schedule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationSchedule](./Get-AzureRMAutomationSchedule.md) - -[New-AzureRmAutomationSchedule](./New-AzureRMAutomationSchedule.md) - -[Set-AzureRmAutomationSchedule](./Set-AzureRMAutomationSchedule.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRMAutomationVariable.md b/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRMAutomationVariable.md deleted file mode 100644 index 1a69239c1a..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRMAutomationVariable.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 760C03A0-12DB-43C4-A180-B013FA77A513 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/remove-azurermautomationvariable -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Remove-AzureRMAutomationVariable.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Remove-AzureRMAutomationVariable.md ---- - -# Remove-AzureRmAutomationVariable - -## SYNOPSIS -Removes an Automation variable. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmAutomationVariable [-Name] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Remove-AzureRmAutomationVariable** cmdlet removes a variable from Azure Automation. - -## EXAMPLES - -### Example 1: Remove a variable -``` -PS C:\>Remove-AzureRmAutomationVariable -AutomationAccountName "Contoso17" -Name "StringVariable22" -ResourceGroupName "ResourceGroup01" -``` - -This command removes a variable named StringVariable22 in the Automation account named Contoso17. -This command specifies the *Force* parameter. -Therefore, it does not prompt you for confirmation. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account that contains the variable that this cmdlet deletes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the variable that this cmdlet deletes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group for which this cmdlet deletes a variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationVariable](./Get-AzureRMAutomationVariable.md) - -[New-AzureRmAutomationVariable](./New-AzureRMAutomationVariable.md) - -[Set-AzureRmAutomationVariable](./Set-AzureRMAutomationVariable.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRMAutomationWebhook.md b/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRMAutomationWebhook.md deleted file mode 100644 index 4cb9428b27..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRMAutomationWebhook.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 71043093-DEE5-4395-B67A-2F104CF67893 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/remove-azurermautomationwebhook -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Remove-AzureRMAutomationWebhook.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Remove-AzureRMAutomationWebhook.md ---- - -# Remove-AzureRmAutomationWebhook - -## SYNOPSIS -Removes a webhook from an Automation runbook. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmAutomationWebhook [-Name] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Remove-AzureRmAutomationWebhook** cmdlet removes a webhook from an Azure Automation runbook. -The webhook is deleted. - -## EXAMPLES - -### Example 1: Remove a webhook -``` -PS C:\>Remove-AzureRmAutomationWebhook -Name "Webhook11" -ResourceGroup "ResourceGroup01" -AutomationAccountName "AutomationAccount01" -Force -``` - -This command removes a webhook named Webhook11 in the Automation account named AutomationAccount01. -The command specifies the *Force* parameter. -Therefore, it does not prompt you for confirmation. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of an Automation account from which this cmdlet removes a webhook. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the webhook that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for which this cmdlet removes a webhook. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationWebhook](./Get-AzureRMAutomationWebhook.md) - -[New-AzureRmAutomationWebhook](./New-AzureRMAutomationWebhook.md) - -[Set-AzureRmAutomationWebhook](./Set-AzureRMAutomationWebhook.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRmAutomationAccount.md b/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRmAutomationAccount.md deleted file mode 100644 index dd041a6c56..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRmAutomationAccount.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 515933DF-5DB1-452A-808B-0198A3A2EA8B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/remove-azurermautomationaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Remove-AzureRmAutomationAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Remove-AzureRmAutomationAccount.md ---- - -# Remove-AzureRmAutomationAccount - -## SYNOPSIS -Removes an Automation account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmAutomationAccount [-ResourceGroupName] [-Name] [-Force] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AzureRmAutomationAccount** cmdlet removes an Azure Automation account from a resource group. -For more information about Automation accounts, see the New-AzureRmAutomationAccount cmdlet. - -## EXAMPLES - -### Example 1: Remove an automation account -``` -PS C:\>Remove-AzureRmAutomationAccount -Name "ContosoAutomationAccount" -Force -ResourceGroupName "ResourceGroup01" -``` - -This command removes an automation account named ContosoAutomationAccount without prompting for user validation. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -ps_force - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Automation account that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AutomationAccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group from which this cmdlet removes an Automation account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.AutomationAccount - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationAccount](./Get-AzureRmAutomationAccount.md) - -[New-AzureRmAutomationAccount](./New-AzureRmAutomationAccount.md) - -[Set-AzureRmAutomationAccount](./Set-AzureRmAutomationAccount.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRmAutomationConnectionType.md b/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRmAutomationConnectionType.md deleted file mode 100644 index bf88fc031d..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRmAutomationConnectionType.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 92B69069-0F98-428A-B05C-BBA09EBC0381 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/remove-azurermautomationconnectiontype -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Remove-AzureRmAutomationConnectionType.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Remove-AzureRmAutomationConnectionType.md ---- - -# Remove-AzureRmAutomationConnectionType - -## SYNOPSIS -Removes an Automation connection type. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmAutomationConnectionType [-Name] [-Force] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Remove-AzureRmAutomationConnectionType** cmdlet removes a connection type from Azure Automation. -All connections that are associated with the connection type that you delete become unusable. -Remove them, unless you create a new connection type that meets the following criteria: -- The type has the same name as the original connection type. -- The type has the same field definitions as the original connection type. -It can have additional fields. - -## EXAMPLES - -### Example 1: Remove a connection type -``` -PS C:\>Remove-AzureRmAutomationConnectionType -AutomationAccountName "Contoso17" -Name "ContosoConnectionType" -ResourceGroupName "ResourceGroup01" -``` - -This command removes a connection type named ContosoConnectionType in the Automation account named Contoso17. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account for which this cmdlet removes a connection type. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -ps_force - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Automation connection type that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group from which this cmdlet removes an Automation connection type. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmAutomationConnection](./Remove-AzureRMAutomationConnection.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRmAutomationDscConfiguration.md b/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRmAutomationDscConfiguration.md deleted file mode 100644 index 43beeb2fbe..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRmAutomationDscConfiguration.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 6389EE2A-12B5-46A1-A2B9-4B3CF5A55A30 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/remove-azurermautomationdscconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Remove-AzureRmAutomationDscConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Remove-AzureRmAutomationDscConfiguration.md ---- - -# Remove-AzureRmAutomationDscConfiguration - -## SYNOPSIS -Removes DSC configurations from Automation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmAutomationDscConfiguration [-Name] [-Force] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Remove-AzureRmAutomationDscConfiguration** cmdlet removes APS Desired State Configuration (DSC) configurations from Azure Automation. - -## EXAMPLES - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account that contains DSC configurations that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -ps_force - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the DSC configuration that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ConfigurationName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group for which this cmdlet gets DSC configurations. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Export-AzureRmAutomationDscConfiguration](./Export-AzureRmAutomationDscConfiguration.md) - -[Get-AzureRmAutomationDscConfiguration](./Get-AzureRmAutomationDscConfiguration.md) - -[Import-AzureRmAutomationDscConfiguration](./Import-AzureRmAutomationDscConfiguration.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRmAutomationDscNodeConfiguration.md b/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRmAutomationDscNodeConfiguration.md deleted file mode 100644 index 1b2e28bd9f..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRmAutomationDscNodeConfiguration.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 6C6C7142-31CD-4245-BC55-CB7916EA12E0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/remove-azurermautomationdscnodeconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Remove-AzureRmAutomationDscNodeConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Remove-AzureRmAutomationDscNodeConfiguration.md ---- - -# Remove-AzureRmAutomationDscNodeConfiguration - -## SYNOPSIS -Removes metadata from DSC node configurations in Automation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmAutomationDscNodeConfiguration [-Name] [-Force] [-IgnoreNodeMappings] - [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AzureRmAutomationDscNodeConfiguration** cmdlet removes metadata from APS Desired State Configuration (DSC) node configurations in Azure Automation. -Automation stores DSC node configuration as a Managed Object Format (MOF) configuration document. - -## EXAMPLES - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of an Automation account that contains the DSC node configurations for which this cmdlet removes metadata. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -ps_force - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreNodeMappings -Indicates that this cmdlet ignores node mappings. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the DSC node configuration for which this cmdlet removes metadata. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NodeConfigurationName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. -This cmdlet removes metadata for DSC node configurations in the resource group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationDscNodeConfiguration](./Get-AzureRmAutomationDscNodeConfiguration.md) - -[Import-AzureRmAutomationDscNodeConfiguration](./Import-AzureRmAutomationDscNodeConfiguration.md) - -[Azure Automation Cmdlets](./AzureRM.Automation.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRmAutomationHybridWorkerGroup.md b/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRmAutomationHybridWorkerGroup.md deleted file mode 100644 index 0be58c68ba..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRmAutomationHybridWorkerGroup.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/remove-azurermautomationdscnodeconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Remove-AzureRmAutomationHybridWorkerGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Remove-AzureRmAutomationHybridWorkerGroup.md ---- - -# Remove-AzureRmAutomationHybridWorkerGroup - -## SYNOPSIS -Removes hybrid worker group from Automation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmAutomationHybridWorkerGroup [-Name] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The Remove-AzureRmAutomationHybridWorkerGroup cmdlet removes a hybrid worker group from Automation. - -## EXAMPLES - -### Example 1 -This command removes a hybrid worker by name. - -```powershell -PS C:\> Remove-AzureRmAutomationHybridWorkerGroup -ResourceGroupName "rg1" ` - -AutomationAccountName "devAccount" ` - -Name "GroupName" ` - -Force -``` - -## PARAMETERS - -### -AutomationAccountName -The automation account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The hybrid worker group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Group - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRmAutomationModule.md b/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRmAutomationModule.md deleted file mode 100644 index a7b394b2d1..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRmAutomationModule.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 5F45A12C-BB50-4732-BE80-188491DEF8B5 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/remove-azurermautomationmodule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Remove-AzureRmAutomationModule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Remove-AzureRmAutomationModule.md ---- - -# Remove-AzureRmAutomationModule - -## SYNOPSIS -Removes a module from Automation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmAutomationModule [-Name] [-Force] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Remove-AzureRmAutomationModule** cmdlet removes a module from an Automation account in Azure Automation. - -## EXAMPLES - -### Example 1: Remove a module -``` -PS C:\>Remove-AzureRmAutomationModule -AutomationAccountName "Contoso17" -Name "ContosoModule" -ResourceGroupName "ResourceGroup01" -``` - -This command removes a module named ContosoModule from the Automation account named Contoso17. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account from which this cmdlet removes a module. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -ps_force - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the module that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group in which this cmdlet removes a module. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationModule](./Get-AzureRmAutomationModule.md) - -[New-AzureRmAutomationModule](./New-AzureRmAutomationModule.md) - -[Set-AzureRmAutomationModule](./Set-AzureRmAutomationModule.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRmAutomationSoftwareUpdateConfiguration.md b/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRmAutomationSoftwareUpdateConfiguration.md deleted file mode 100644 index 13998281be..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRmAutomationSoftwareUpdateConfiguration.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/remove-azurermautomationsoftwareupdateconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Remove-AzureRmAutomationSoftwareUpdateConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Remove-AzureRmAutomationSoftwareUpdateConfiguration.md ---- - -# Remove-AzureRmAutomationSoftwareUpdateConfiguration - -## SYNOPSIS -Removes an azure automation software update configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### BySucName (Default) -``` -Remove-AzureRmAutomationSoftwareUpdateConfiguration -Name [-PassThru] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -### BySuc -``` -Remove-AzureRmAutomationSoftwareUpdateConfiguration -SoftwareUpdateConfiguration - [-PassThru] [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This cmdlet removed an azure automation software update configuration. - -## EXAMPLES - -### Example 1 -This example shows how to remove 'MyUpdateConfiguration' from automation account - -```powershell -PS C:\> Remove-AzureRmAutomationSoftwareUpdateConfiguration -ResourceGroupName "mygroup" -AutomationAccountName "myaccount" -Name "MyUpdateConfiguration" -``` - -## PARAMETERS - -### -AutomationAccountName -The automation account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the software update configuration to remove. - -```yaml -Type: System.String -Parameter Sets: BySucName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -PassThru returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SoftwareUpdateConfiguration -The software update configuration to remove. - -```yaml -Type: Microsoft.Azure.Commands.Automation.Model.UpdateManagement.SoftwareUpdateConfiguration -Parameter Sets: BySuc -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Automation.Model.UpdateManagement.SoftwareUpdateConfiguration - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRmAutomationSourceControl.md b/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRmAutomationSourceControl.md deleted file mode 100644 index 356067e0b1..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Remove-AzureRmAutomationSourceControl.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/remove-azurermautomationsourcecontrol -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Remove-AzureRmAutomationSourceControl.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Remove-AzureRmAutomationSourceControl.md ---- - -# Remove-AzureRmAutomationSourceControl - -## SYNOPSIS -Removes an Azure Automation source control. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmAutomationSourceControl [-Name] [-PassThru] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The Remove-AzureRmAutomationSourceControl cmdlet removes a source control from Azure Automation. - -## EXAMPLES - -### Example 1 -This command removes the Automation source control named VSTSNative in the account named devAccount. -This command specifies the *Force* parameter. Therefore, it does not prompt you for confirmation. - -```powershell -PS C:\> Remove-AzureRmAutomationSourceControl -ResourceGroupName "rg1" ` - -AutomationAccountName "devAccount" ` - -Name "VSTSNative" ` - -Force -``` - -## PARAMETERS - -### -AutomationAccountName -The automation account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The source control name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -PassThru returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.SourceControl - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Automation/Resume-AzureRMAutomationJob.md b/azurermps-6.13.0/AzureRM.Automation/Resume-AzureRMAutomationJob.md deleted file mode 100644 index ae07e45743..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Resume-AzureRMAutomationJob.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 9400E9EB-E927-44D5-8722-9706BDD92FD5 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/resume-azurermautomationjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Resume-AzureRMAutomationJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Resume-AzureRMAutomationJob.md ---- - -# Resume-AzureRmAutomationJob - -## SYNOPSIS -Resumes a suspended Automation job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Resume-AzureRmAutomationJob [-Id] [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Resume-AzureRmAutomationJob** cmdlet resumes a suspended Azure Automation job. -Specify the suspended job. -To suspend a job, use the Suspend-AzureRmAutomationJob cmdlet. - -## EXAMPLES - -### Example 1: Resume a suspended job -``` -PS C:\>Resume-AzureRmAutomationJob -AutomationAccountName "Contoso17" -Id 2989b069-24fe-40b9-b3bd-cb7e5eac4b64 -ResourceGroupName "ResourceGroup01" -``` - -This command resumes the job that has the specified ID. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of an Automation account in which this cmdlet resume a job. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of a job that this cmdlet resumes. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: JobId - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group for which this cmdlet resumes a job. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationJob](./Get-AzureRMAutomationJob.md) - -[Get-AzureRmAutomationJobOutput](./Get-AzureRMAutomationJobOutput.md) - -[Stop-AzureRmAutomationJob](./Stop-AzureRMAutomationJob.md) - -[Suspend-AzureRmAutomationJob](./Suspend-AzureRMAutomationJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Set-AzureRMAutomationCertificate.md b/azurermps-6.13.0/AzureRM.Automation/Set-AzureRMAutomationCertificate.md deleted file mode 100644 index 3ac9b3a8b9..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Set-AzureRMAutomationCertificate.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: F1A2861F-14EF-4F67-8452-31FD498528BB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/set-azurermautomationcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Set-AzureRMAutomationCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Set-AzureRMAutomationCertificate.md ---- - -# Set-AzureRmAutomationCertificate - -## SYNOPSIS -Modifies the configuration of an Automation certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmAutomationCertificate [-Name] [-Description ] [-Password ] - [-Path ] [-Exportable ] [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Set-AzureRmAutomationCertificate** cmdlet modifies the configuration of a certificate in Azure Automation. - -## EXAMPLES - -### Example 1: Modify a certificate -``` -PS C:\>$Password = ConvertTo-SecureString -String "Password" -AsPlainText -Force -PS C:\> Set-AzureAutomationCertificate -AutomationAccountName "Contos17" -Name "ContosoCertificate" -Path "./cert.pfx" -Password $Password -ResourceGroupName "ResourceGroup01" -``` - -The first command converts a plain text password to be a secure string by using the ConvertTo-SecureString cmdlet. -The command stores that object in the $Password variable. -The second command modifies a certificate named ContosoCertificate. -The command uses the password stored in $Password. -The command specifies the account name and the path of the file that it uploads. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account for which this cmdlet modifies a certificate. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the certificate that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Exportable -Specifies whether the certificate can be exported. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the certificate that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Password -Specifies the password for the certificate file. - -```yaml -Type: System.Security.SecureString -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the path to a script file to upload. -The file can be a .cer file or a .pfx file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for which this cmdlet modifies a certificate. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Security.SecureString - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.CertificateInfo - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationCertificate](./Get-AzureRMAutomationCertificate.md) - -[New-AzureRmAutomationCertificate](./New-AzureRMAutomationCertificate.md) - -[Remove-AzureRmAutomationCertificate](./Remove-AzureRMAutomationCertificate.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Set-AzureRMAutomationConnectionFieldValue.md b/azurermps-6.13.0/AzureRM.Automation/Set-AzureRMAutomationConnectionFieldValue.md deleted file mode 100644 index 0d38684791..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Set-AzureRMAutomationConnectionFieldValue.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: CA25260C-D0BF-4F9C-A846-9D9B6C48CE8A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/set-azurermautomationconnectionfieldvalue -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Set-AzureRMAutomationConnectionFieldValue.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Set-AzureRMAutomationConnectionFieldValue.md ---- - -# Set-AzureRmAutomationConnectionFieldValue - -## SYNOPSIS -Modifies the value of a field in an Automation connection. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmAutomationConnectionFieldValue [-Name] -ConnectionFieldName -Value - [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Set-AzureRmAutomationConnectionFieldValue** cmdlet modifies the value of a field in a connection in Azure Automation. - -## EXAMPLES - -### Example 1: Change a field value in a connection -``` -PS C:\>Set-AzureRmAutomationConnectionFieldValue -Name "ContosoConnection" -ConnectionFieldName "SubscriptionID" -Value "b53ec456-3494-4847-8f2b-180901c51050" -ResourceGroupName "ResourceGroup01" -AutomationAccountName "AutomationAccount01" -``` - -This command changes the subscription ID for the Azure connection named ContosoConnection in the Automation account named AutomationAccount01. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account for which this cmdlet modifies a field in a connection. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConnectionFieldName -Specifies a name for the field that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the connection for which this cmdlet modifies a field. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for which this cmdlet modifies a field in a connection. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Value -Specifies a value to modify in the connection field. - -```yaml -Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Object - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.Connection - -## NOTES - -## RELATED LINKS - -[New-AzureRmAutomationConnection](./New-AzureRMAutomationConnection.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Set-AzureRMAutomationCredential.md b/azurermps-6.13.0/AzureRM.Automation/Set-AzureRMAutomationCredential.md deleted file mode 100644 index 7d72b9416a..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Set-AzureRMAutomationCredential.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: D6325A22-2D1B-4228-A5BC-3F1071E26FB2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/set-azurermautomationcredential -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Set-AzureRMAutomationCredential.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Set-AzureRMAutomationCredential.md ---- - -# Set-AzureRmAutomationCredential - -## SYNOPSIS -Modifies an Automation credential. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmAutomationCredential [-Name] [-Description ] [-Value ] - [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Set-AzureRmAutomationCredential** cmdlet modifies a credential as a **PSCredential** object in Azure Automation. - -## EXAMPLES - -### Example 1: Update a credential -``` -PS C:\>$User = "Contoso\DChew" -PS C:\> $Password = ConvertTo-SecureString "Password" -AsPlainText -Force -PS C:\> $Credential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $User, $Password -PS C:\> Set-AzureRmAutomationCredential -AutomationAccountName "Contoso17" -Name "ContosoCredential" -ResourceGroupName "ResourceGroup01" -Value $Credential -``` - -The first command assigns a user name to the $User variable. -The second command converts a plain text password into a secure string by using the ConvertTo-SecureString cmdlet. -The command stores that object in the $Password variable. -The third command creates a credential based on $User and $Password, and then stores it in the $Credential variable. -The final command modifies the Automation credential named ContosoCredential to use the credential in $Credential. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account for which this cmdlet modifies a credential. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the credential that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the credential that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for which this cmdlet modifies a credential. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Value -Specifies the credentials as a **PSCredential** object. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.PSCredential - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.CredentialInfo - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationCredential](./Get-AzureRMAutomationCredential.md) - -[New-AzureRmAutomationCredential](./New-AzureRMAutomationCredential.md) - -[Remove-AzureRmAutomationCredential](./Remove-AzureRMAutomationCredential.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Set-AzureRMAutomationRunbook.md b/azurermps-6.13.0/AzureRM.Automation/Set-AzureRMAutomationRunbook.md deleted file mode 100644 index aac1d20bc5..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Set-AzureRMAutomationRunbook.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 920C028B-0471-43EB-9123-C444289FD845 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/set-azurermautomationrunbook -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Set-AzureRMAutomationRunbook.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Set-AzureRMAutomationRunbook.md ---- - -# Set-AzureRmAutomationRunbook - -## SYNOPSIS -Modifies a runbook. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmAutomationRunbook [-Name] [-Description ] [-Tag ] - [-LogProgress ] [-LogVerbose ] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Set-AzureRmAutomationRunbook** cmdlet modifies the configuration of an Azure Automation runbook in APS. - -## EXAMPLES - -### Example 1: Enable verbose logging for a runbook -``` -PS C:\>Set-AzureRmAutomationRunbook -AutomationAccountName "Contoso17" -Name "Runbook02" -LogVerbose $True -ResourceGroupName "ResourceGroup01" -``` - -This command enables verbose logging for the jobs of the specified runbook in the Azure Automation account named Contoso17. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account in which this cmdlet modifies a runbook. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the runbook. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogProgress -Specifies whether the runbook logs progress. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogVerbose -Specifies whether logging includes detailed information. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the runbook that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: RunbookName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for which this cmdlet modifies a runbook. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -The runbook tags. - -```yaml -Type: System.Collections.IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.IDictionary - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.Runbook - -## NOTES - -## RELATED LINKS - -[Export-AzureRmAutomationRunbook](./Export-AzureRMAutomationRunbook.md) - -[Get-AzureRmAutomationRunbook](./Get-AzureRMAutomationRunbook.md) - -[Import-AzureRmAutomationRunbook](./Import-AzureRMAutomationRunbook.md) - -[New-AzureRmAutomationRunbook](./New-AzureRMAutomationRunbook.md) - -[New-AzureRmAutomationRunbook](./New-AzureRMAutomationRunbook.md) - -[Publish-AzureRmAutomationRunbook](./Publish-AzureRMAutomationRunbook.md) - -[Remove-AzureRmAutomationRunbook](./Remove-AzureRMAutomationRunbook.md) - -[Start-AzureRmAutomationRunbook](./Start-AzureRMAutomationRunbook.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Set-AzureRMAutomationSchedule.md b/azurermps-6.13.0/AzureRM.Automation/Set-AzureRMAutomationSchedule.md deleted file mode 100644 index 1bc110ba98..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Set-AzureRMAutomationSchedule.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 6429C564-1995-4D9B-BF9B-963B4F5FB3BD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/set-azurermautomationschedule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Set-AzureRMAutomationSchedule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Set-AzureRMAutomationSchedule.md ---- - -# Set-AzureRmAutomationSchedule - -## SYNOPSIS -Modifies an Automation schedule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmAutomationSchedule [-Name] [-IsEnabled ] [-Description ] - [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Set-AzureRmAutomationSchedule** cmdlet modifies a schedule in Azure Automation. - -## EXAMPLES - -### Example 1: Modify a schedule -``` -PS C:\>Set-AzureRmAutomationSchedule -AutomationAccountName "Contoso17" -Name "Schedule01" -Description "Automation Schedule" -ResourceGroupName "ResourceGroup01" -``` - -This command modifies the description of the schedule named Schedule01. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of an Automation account for which this cmdlet modifies a schedule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the schedule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IsEnabled -Specifies whether this cmdlet enables the schedule. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name for the schedule that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group for which this cmdlet modifies a schedule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.Schedule - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationSchedule](./Get-AzureRMAutomationSchedule.md) - -[New-AzureRmAutomationSchedule](./New-AzureRMAutomationSchedule.md) - -[Remove-AzureRmAutomationSchedule](./Remove-AzureRMAutomationSchedule.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Set-AzureRMAutomationVariable.md b/azurermps-6.13.0/AzureRM.Automation/Set-AzureRMAutomationVariable.md deleted file mode 100644 index 683f3efbc0..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Set-AzureRMAutomationVariable.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: F344D8D1-5593-4C09-A1CA-37579D2A3A61 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/set-azurermautomationvariable -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Set-AzureRMAutomationVariable.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Set-AzureRMAutomationVariable.md ---- - -# Set-AzureRmAutomationVariable - -## SYNOPSIS -Modifies an Automation variable. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### UpdateVariableValue -``` -Set-AzureRmAutomationVariable [-Name] -Encrypted -Value - [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] - [] -``` - -### UpdateVariableDescription -``` -Set-AzureRmAutomationVariable [-Name] -Description [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Set-AzureRmAutomationVariable** cmdlet modifies the value or description of a variable in Azure Automation. -To encrypt the variable, specify the *Encrypted* parameter. -You cannot modify the encrypted state of a variable after creation. -Specifying *Encrypted* for an existing, non-encrypted, variable fails. - -## EXAMPLES - -### Example 1: Set the value of a variable -``` -PS C:\>Set-AzureRmAutomationVariable -AutomationAccountName "Contoso17" -Name "StringVariable22" -ResourceGroupName "ResourceGroup01" -Value "New Value" -Encrypted $False -``` - -This command sets a new value for the variable named StringVariable22 in the Azure Automation account named Contoso17. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account in which the variable is stored. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the variable. - -```yaml -Type: System.String -Parameter Sets: UpdateVariableDescription -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Encrypted -Specifies whether cmdlet encrypts the value of the variable for storage. - -```yaml -Type: System.Boolean -Parameter Sets: UpdateVariableValue -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the variable that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group for which this cmdlet modifies a variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Value -Specifies a value for the variable. - -```yaml -Type: System.Object -Parameter Sets: UpdateVariableValue -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Boolean - -### System.Object - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.Variable - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationVariable](./Get-AzureRMAutomationVariable.md) - -[New-AzureRmAutomationVariable](./New-AzureRMAutomationVariable.md) - -[Remove-AzureRmAutomationVariable](./Remove-AzureRMAutomationVariable.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Set-AzureRMAutomationWebhook.md b/azurermps-6.13.0/AzureRM.Automation/Set-AzureRMAutomationWebhook.md deleted file mode 100644 index 528db1c918..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Set-AzureRMAutomationWebhook.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 9EA7F710-36FB-435C-BF28-1015E5D3155F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/set-azurermautomationwebhook -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Set-AzureRMAutomationWebhook.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Set-AzureRMAutomationWebhook.md ---- - -# Set-AzureRmAutomationWebhook - -## SYNOPSIS -Modifies a webhook for an Automation runbook. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmAutomationWebhook [-Name] [-IsEnabled] [[-Parameters] ] - [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Set-AzureRmAutomationWebhook** cmdlet modifies a webhook for an Azure Automation runbook. - -## EXAMPLES - -### Example 1: Disable a webhook -``` -PS C:\>Set-AzureAutomationWebhook -Name "Webhook01" -ResourceGroup "ResourceGroup01" -AutomationAccountName "AutomationAccount01" -IsEnabled $False -``` - -This command disables a webhook named Webhook01 in the Automation account named AutomationAccount01. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of an Automation account in which this cmdlet modifies a webhook. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsEnabled -Specifies whether the webhook is enabled. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name of the webhook that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Parameters -Specifies a dictionary of key/value pairs. -The keys are the runbook parameter names. -The values are the runbook parameter values. -When the runbook starts in response to a webhook, these parameters are passed to the runbook. - -```yaml -Type: System.Collections.IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for which this cmdlet modifies a webhook. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Collections.IDictionary - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.Webhook - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationWebhook](./Get-AzureRMAutomationWebhook.md) - -[New-AzureRmAutomationWebhook](./New-AzureRMAutomationWebhook.md) - -[Remove-AzureRmAutomationWebhook](./Remove-AzureRMAutomationWebhook.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Set-AzureRmAutomationAccount.md b/azurermps-6.13.0/AzureRM.Automation/Set-AzureRmAutomationAccount.md deleted file mode 100644 index 7adaead534..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Set-AzureRmAutomationAccount.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: B1897EFC-0184-4A8B-B8E4-203CC8E3B179 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/set-azurermautomationaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Set-AzureRmAutomationAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Set-AzureRmAutomationAccount.md ---- - -# Set-AzureRmAutomationAccount - -## SYNOPSIS -Modifies an Automation account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmAutomationAccount [-ResourceGroupName] [-Name] [-Plan ] - [-Tags ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Set-AzureRmAutomationAccount** cmdlet modifies an Azure Automation account. -For more information about Automation accounts, see the New-AzureRmAutomationAccount cmdlet. - -## EXAMPLES - -### Example 1: Set the tags for an Automation account -``` -PS C:\>$Tags = @{"tag01"="value01";"tag02"="value02"} -PS C:\> Set-AzureRmAutomationAccount -Name "AutomationAccount01" -ResourceGroupName "ResourceGroup01" -Tags $Tags -``` - -The first command assigns two key/value pairs to the $Tags variable. -The second command sets tags in $Tags for the Automation account named AutomationAccount01. - -### Example 2: Change the plan for an Automation account -``` -PS C:\>Set-AzureRmAutomationAccount -Name "AutomationAccount01" -ResourceGroupName "ResourceGroup01" -Plan Basic -``` - -This command changes the plan to Basic for the Automation account named AutomationAccount01. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Automation account that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AutomationAccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Plan -Specifies the plan for the Automation account. -Valid values are: -- Basic -- Free - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Free, Basic - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group that contains the Automation account that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tags -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.IDictionary -Parameter Sets: (All) -Aliases: Tag - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.IDictionary - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.AutomationAccount - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationAccount](./Get-AzureRmAutomationAccount.md) - -[New-AzureRmAutomationAccount](./New-AzureRmAutomationAccount.md) - -[Remove-AzureRmAutomationAccount](./Remove-AzureRmAutomationAccount.md) diff --git a/azurermps-6.13.0/AzureRM.Automation/Set-AzureRmAutomationDscNode.md b/azurermps-6.13.0/AzureRM.Automation/Set-AzureRmAutomationDscNode.md deleted file mode 100644 index 9f3125e7c6..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Set-AzureRmAutomationDscNode.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 60023C8D-EA37-41DA-97E6-AF89F7F9BADD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/set-azurermautomationdscnode -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Set-AzureRmAutomationDscNode.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Set-AzureRmAutomationDscNode.md ---- - -# Set-AzureRmAutomationDscNode - -## SYNOPSIS -Modifies the node configuration that a DSC node is mapped to. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmAutomationDscNode -Id -NodeConfigurationName [-Force] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Set-AzureRmAutomationDscNode** cmdlet modifies an APS Desired State Configuration (DSC) node configuration. -Azure Automation stores DSC node configuration as a Managed Object Format (MOF) configuration document. - -## EXAMPLES - -### Example 1: Modify node configuration mapping -``` -PS C:\>Set-AzureRmAutomationDscNode -NodeConfigurationName "Contoso.NodeConfiguration01" -ResourceGroupName "ResourceGroup01" -Id 064a8929-c98b-25e4-80hh-111c8a6067j8 -``` - -This command assigns the node configuration named Contoso.NodeConfiguration01 to the node that has the specified GUID. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account that contains the DSC node for which this cmdlet modifies the configuration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -ps_force the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the unique ID of the DSC node for which this cmdlet modifies the configuration. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: NodeId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NodeConfigurationName -Specifies the name of the node configuration to which this cmdlet maps the node. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group in which this cmdlet modifies a DSC node configuration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.DscNode - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationDscNode](./Get-AzureRmAutomationDscNode.md) - -[Register-AzureRmAutomationDscNode](./Register-AzureRmAutomationDscNode.md) - -[Unregister-AzureRmAutomationDscNode](./Unregister-AzureRmAutomationDscNode.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Set-AzureRmAutomationModule.md b/azurermps-6.13.0/AzureRM.Automation/Set-AzureRmAutomationModule.md deleted file mode 100644 index c70fe9fb65..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Set-AzureRmAutomationModule.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: A06D36D7-3F72-4D21-8995-9DBBB9A9B880 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/set-azurermautomationmodule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Set-AzureRmAutomationModule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Set-AzureRmAutomationModule.md ---- - -# Set-AzureRmAutomationModule - -## SYNOPSIS -Updates a module in Automation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmAutomationModule [-Name] [-ContentLinkUri ] [-ContentLinkVersion ] - [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Set-AzureRmAutomationModule** cmdlet updates a module in Azure Automation. -This command accepts a compressed file that has a .zip file name extension. -The file contains a folder that includes a file that is one of the following types: -- wps_2 module, which has a .psm1 or .dll file name extension -- wps_2 module manifest, which has a .psd1 file name extension -The name of the .zip file, the name of the folder, and the name of the file in the folder must be the same. -Specify the .zip file as a URL that the Automation service can access. -If you import a wps_2 module into Automation by using this cmdlet or the New-AzureRmAutomationModule cmdlet, the operation is asynchronous. -The command finishes whether the import succeeds or fails. -To check whether it succeeded, run the following command: -`PS C:\\\> $ModuleInstance = Get-AzureRmAutomationModule -Name `ModuleName -Check the **ProvisioningState** property for a value of Succeeded. - -## EXAMPLES - -### Example 1: Update a module -``` -PS C:\>Set-AzureRmAutomationModule -AutomationAccountName "Contoso17" -Name "ContosoModule" -ContentLinkUri "http://contosostorage.blob.core.windows.net/modules/ContosoModule.zip" -ContentLinkVersion "1.1" -ResourceGroupName "ResourceGroup01" -``` - -This command imports an updated version of an existing module named ContosoModule into the Automation account named Contoso17. The module is stored in an Azure blob in a storage account named contosostorage and a container named modules. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account for which this cmdlet updates a module. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ContentLinkUri -Specifies the URL of the .zip file that contains the new version of a module that this cmdlet imports. - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: ContentLink - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ContentLinkVersion -Specifies the version of the module to which this cmdlet updates Automation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the module that this cmdlet imports. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group for which this cmdlet updates a module. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Uri - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.Module - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationModule](./Get-AzureRmAutomationModule.md) - -[New-AzureRmAutomationModule](./New-AzureRmAutomationModule.md) - -[Remove-AzureRmAutomationModule](./Remove-AzureRmAutomationModule.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Start-AzureRMAutomationRunbook.md b/azurermps-6.13.0/AzureRM.Automation/Start-AzureRMAutomationRunbook.md deleted file mode 100644 index 50cb41ec3b..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Start-AzureRMAutomationRunbook.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: B2D9FF7B-EA3B-4853-814C-00FC4E328957 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/start-azurermautomationrunbook -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Start-AzureRMAutomationRunbook.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Start-AzureRMAutomationRunbook.md ---- - -# Start-AzureRmAutomationRunbook - -## SYNOPSIS -Starts a runbook job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByAsynchronousReturnJob (Default) -``` -Start-AzureRmAutomationRunbook [-Name] [-Parameters ] [-RunOn ] - [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] - [] -``` - -### BySynchronousReturnJobOutput -``` -Start-AzureRmAutomationRunbook [-Name] [-Parameters ] [-RunOn ] [-Wait] - [-MaxWaitSeconds ] [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Start-AzureRmAutomationRunbook** cmdlet starts an Azure Automation runbook job. -Specify the ID or name of a runbook. - -## EXAMPLES - -### Example 1: Start a runbook job -``` -PS C:\>Start-AzureRmAutomationRunbook -AutomationAccountName "Contoso17" -Name "Runbk01" -ResourceGroupName "ResourceGroup01" -``` - -This command starts a runbook job for the runbook named Runbk01 in the Azure Automation account named Contoso17. - -### Example 2: Start a runbook job and wait for results -``` -Start-AzureRmAutomationRunbook -AutomationAccountName "Contoso17" -Name "Runbk01" -ResourceGroupName "ResourceGroup01" -MaxWaitSeconds 1000 -Wait -``` - -This command starts a runbook job for the runbook named Runbk01 in the Azure Automation account named Contoso17. -This command specifies the _Wait_ parameter. -Therefore, it returns results after the job is completed. -The cmdlet waits up to 1000 seconds for the results. - -## PARAMETERS - -### -AutomationAccountName -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxWaitSeconds -Specifies the number of seconds this cmdlet waits for a job to finish before it abandons the job. -The default value is 10800, or three hours. - -```yaml -Type: System.Int32 -Parameter Sets: BySynchronousReturnJobOutput -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: RunbookName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Parameters -```yaml -Type: System.Collections.IDictionary -Parameter Sets: (All) -Aliases: JobParameters - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RunOn -Specifies which Hybrid Worker Group on which to run the runbook. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: HybridWorker - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Wait -Indicates that this cmdlet waits for job to complete, suspend, or fail, and then returns control to Azure PowerShell. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: BySynchronousReturnJobOutput -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.Job --This cmdlet returns a **Job** object, unless you specify the _Wait_ parameter. --If you do not specify _Wait_, Azure PowerShell returns a **Job** object immediately. --If you specify _Wait_, Azure PowerShell completes the job, and then returns the result. --The result is not a **Job** object. - -### System.Management.Automation.PSObject - -## NOTES - -## RELATED LINKS - -[Export-AzureRmAutomationRunbook](./Export-AzureRMAutomationRunbook.md) - -[Get-AzureRmAutomationRunbook](./Get-AzureRMAutomationRunbook.md) - -[Import-AzureRmAutomationRunbook](./Import-AzureRMAutomationRunbook.md) - -[New-AzureRmAutomationRunbook](./New-AzureRMAutomationRunbook.md) - -[New-AzureRmAutomationRunbook](./New-AzureRMAutomationRunbook.md) - -[Publish-AzureRmAutomationRunbook](./Publish-AzureRMAutomationRunbook.md) - -[Remove-AzureRmAutomationRunbook](./Remove-AzureRMAutomationRunbook.md) - -[Set-AzureRmAutomationRunbook](./Set-AzureRMAutomationRunbook.md) diff --git a/azurermps-6.13.0/AzureRM.Automation/Start-AzureRmAutomationDscCompilationJob.md b/azurermps-6.13.0/AzureRM.Automation/Start-AzureRmAutomationDscCompilationJob.md deleted file mode 100644 index c72e211cc3..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Start-AzureRmAutomationDscCompilationJob.md +++ /dev/null @@ -1,210 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 32CF9BF7-519F-4B5D-9F2B-3CC556A77A48 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/start-azurermautomationdsccompilationjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Start-AzureRmAutomationDscCompilationJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Start-AzureRmAutomationDscCompilationJob.md ---- - -# Start-AzureRmAutomationDscCompilationJob - -## SYNOPSIS -Compiles a DSC configuration in Automation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Start-AzureRmAutomationDscCompilationJob [-ConfigurationName] [-Parameters ] - [-ConfigurationData ] [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [-IncrementNodeConfigurationBuild] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Start-AzureRmAutomationDscCompilationJob** cmdlet compiles an APS Desired State Configuration (DSC) configuration in Azure Automation. - -## EXAMPLES - -### Example 1: Compile an Azure DSC configuration in Automation -``` -PS C:\>$Params = @{"StringParam"="Hello World";"IntegerParam"=32} -PS C:\> Start-AzureRmAutomationDscCompilationJob -ConfigurationName "Config01" -Parameters $Params -ResourceGroupName "ResourceGroup01" -``` - -The first command creates a dictionary of parameters, and stores them in the $Params variable. -The second command compiles the DSC configuration named Config01. -The command includes the values in $Params for DSC configuration parameters. - -### Example 2: Compile an Azure DSC configuration in Automation with a new Node Configuration build version. -``` -PS C:\>$Params = @{"StringParam"="Hello World";"IntegerParam"=32} -PS C:\> Start-AzureRmAutomationDscCompilationJob -ConfigurationName "Config01" -Parameters $Params -ResourceGroupName "ResourceGroup01" -IncrementNodeConfigurationBuild -``` - -Similar to the first example, the first command creates a dictionary of parameters, and stores them in the $Params variable. -The second command compiles the DSC configuration named Config01. -The command includes the values in $Params for DSC configuration parameters. -It does not override the earlier existing Node Configuration by creating a new Node Configuration with the name `Config01[<2>].`. -The version number is incremented based on the existing version number already present. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account that contains the DSC configuration that this cmdlet compiles. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConfigurationData -Specifies a dictionary of configuration data for DSC configuration. - -```yaml -Type: System.Collections.IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConfigurationName -Specifies the name of the DSC configuration that this cmdlet compiles. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncrementNodeConfigurationBuild -Creates a new Node Configuration build version. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Parameters -Specifies a dictionary of parameters that this cmdlet uses to compile the DSC configuration. - -```yaml -Type: System.Collections.IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group in which this cmdlet compiles a configuration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.CompilationJob - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationDscCompilationJob](./Get-AzureRmAutomationDscCompilationJob.md) - -[Get-AzureRmAutomationDscCompilationJobOutput](./Get-AzureRmAutomationDscCompilationJobOutput.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Start-AzureRmAutomationDscNodeConfigurationDeployment.md b/azurermps-6.13.0/AzureRM.Automation/Start-AzureRmAutomationDscNodeConfigurationDeployment.md deleted file mode 100644 index 3a008ad3a4..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Start-AzureRmAutomationDscNodeConfigurationDeployment.md +++ /dev/null @@ -1,296 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 32CF9BF7-519F-4B5D-9F2B-3CC556A77A48 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/start-azurermautomationdscnodeconfigurationdeployment -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Start-AzureRmAutomationDscNodeConfigurationDeployment.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Start-AzureRmAutomationDscNodeConfigurationDeployment.md ---- - -# Start-AzureRmAutomationDscNodeConfigurationDeployment - -## SYNOPSIS -Deploys a DSC Node configuration in Automation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByAll (Default) -``` -Start-AzureRmAutomationDscNodeConfigurationDeployment [-NodeConfigurationName] - [-NodeName] [-Schedule ] [-Force] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -### ByInputObject -``` -Start-AzureRmAutomationDscNodeConfigurationDeployment [-NodeConfigurationName] - [-NodeName] -InputObject [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Start-AzureRmAutomationDscNodeConfigurationDeployment** cmdlet deployes a Desired State Configuration (DSC) node configuration in Azure Automation. - -## EXAMPLES - -### Example 1: Deploy an Azure DSC node configuration in Automation -``` -PS C:\> $pilot = @("WebServerPilot1", "WebServerPilot2") -PS C:\> $prod = @("WebServerProd1", "WebServerProd2") -PS C:\> $nodes = @($pilot, $prod) -PS C:\> Start-AzureRmAutomationDscNodeConfigurationDeployment ` - -NodeConfigurationName "Config01.Node1" ` - -AutomationAccountName "Contoso01" ` - -ResourceGroupName "ResourceGroup01" ` - -NodeName $nodes ` - -Starting a node configuration deployment. -Starting a node configuration deployment. It will override any existing node configurations assigned to the node. -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Yes - -ResourceGroupName : ResourceGroup01 -AutomationAccountName : Contoso01 -JobId : 35b14eb4-52b7-4a1d-ad62-8e9f84adc657 -Job : Microsoft.Azure.Commands.Automation.Model.Job -JobStatus : New -NodeStatus : -NodeConfigurationName : Config01.Node1 -JobSchedule : -JobScheduleId : 00000000-0000-0000-0000-000000000000 -``` - -The above command deploys the DSC node configuration named "Config01.Node1" to the given two-dimensional array of Node Names. The deployment happens in a staged manner. - -### Example 2: Schedule an Azure DSC node configuration deployment in Automation -``` -PS C:\> $sched = New-AzureRmAutomationSchedule -AutomationAccountName "Contoso01" ` - -ResourceGroupName "ResourceGroup01" ` - -Name "TestSchedule" ` - -StartTime "23:00" ` - -OneTime -PS C:\> $pilot = @("WebServerPilot1", "WebServerPilot2") -PS C:\> $prod = @("WebServerProd1", "WebServerProd2") -PS C:\> $nodes = @($pilot, $prod) -PS C:\> Start-AzureRmAutomationDscNodeConfigurationDeployment ` - -NodeConfigurationName "Config01.Node1" ` - -AutomationAccountName "Contoso01" ` - -ResourceGroupName "ResourceGroup01" ` - -NodeName $nodes ` - -Schedule $sched - -Starting a node configuration deployment. -Starting a node configuration deployment. It will override any existing node configurations assigned to the node. -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y - -ResourceGroupName : ResourceGroup01 -AutomationAccountName : Contoso01 -JobId : 00000000-0000-0000-0000-000000000000 -Job : -JobStatus : -NodeStatus : -NodeConfigurationName : Config01.Node1 -JobSchedule : Microsoft.Azure.Commands.Automation.Model.JobSchedule -JobScheduleId : 2b1d7738-093d-4ff7-b87b-e4b2321319e5 -``` - -The above command schedules a deployment of a DSC node configuration named "Config01.Node1" to the given two-dimensional array of Node Names. The deployment happens in a staged manner and will be executed based on the schedule. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account that contains the DSC configuration that this cmdlet compiles. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -ps_force - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByAll -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Input object for Piping - -```yaml -Type: Microsoft.Azure.Commands.Automation.Model.NodeConfigurationDeployment -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NodeConfigurationName -Specifies the name of the DSC node configuration that this cmdlet deploys. - -```yaml -Type: System.String -Parameter Sets: ByAll -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ByInputObject -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NodeName -Specifies the names of the nodes to which the Node Configuration would be deployed to. - -```yaml -Type: System.String[][] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group in which this cmdlet compiles a configuration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Schedule -Automation Schedule object to schedule the deployment job. - -```yaml -Type: Microsoft.Azure.Commands.Automation.Model.Schedule -Parameter Sets: ByAll -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Automation.Model.NodeConfigurationDeployment -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.NodeConfigurationDeployment - -## NOTES - -## RELATED LINKS - -[Start-AzureRmAutomationDscCompilationJob](./Start-AzureRmAutomationDscCompilationJob.md) - -[Import-AzureRmAutomationDscNodeConfiguration](./Import-AzureRmAutomationDscNodeConfiguration.md) - -[Stop-AzureRmAutomationDscNodeConfigurationDeployment](./Stop-AzureRmAutomationDscNodeConfigurationDeployment.md) - -[Get-AzureRmAutomationDscNodeConfigurationDeployment](./Get-AzureRmAutomationDscNodeConfigurationDeployment.md) - -[Get-AzureRmAutomationDscNodeConfigurationDeploymentSchedule](./Get-AzureRmAutomationDscNodeConfigurationDeploymentSchedule.md) - -[New-AzureRmAutomationSchedule](./New-AzureRmAutomationSchedule.md) diff --git a/azurermps-6.13.0/AzureRM.Automation/Start-AzureRmAutomationSourceControlSyncJob.md b/azurermps-6.13.0/AzureRM.Automation/Start-AzureRmAutomationSourceControlSyncJob.md deleted file mode 100644 index c29909058d..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Start-AzureRmAutomationSourceControlSyncJob.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/start-azurermautomationsourcecontrolsyncjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Start-AzureRmAutomationSourceControlSyncJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Start-AzureRmAutomationSourceControlSyncJob.md ---- - -# Start-AzureRmAutomationSourceControlSyncJob - -## SYNOPSIS -Starts an Azure Automation source control sync job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Start-AzureRmAutomationSourceControlSyncJob -SourceControlName [-JobId ] - [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Start-AzureRmAutomationSourceControlSyncJob cmdlet starts a Azure Automation souce control sync job for the given source control name. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Start-AzureRmAutomationSourceControlSyncJob -ResourceGroupName "rg1" ` - -AutomationAccountName "devAccount" ` - -Name "VSTSNative" - -SourceControlSyncJobId SyncType Status StartTime EndTime ----------------------- -------- ------ --------- ------- -b51aed78-bef6-40d4-a966-cd45fd5af576 FullSync Running -``` - -## PARAMETERS - -### -AutomationAccountName -The automation account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobId -The source control sync job id. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: SourceControlSyncJobId - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceControlName -The source control name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.SourceControlSyncJob - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Automation/Stop-AzureRMAutomationJob.md b/azurermps-6.13.0/AzureRM.Automation/Stop-AzureRMAutomationJob.md deleted file mode 100644 index 475e965fdb..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Stop-AzureRMAutomationJob.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: BE1A9247-9F8E-45EA-9590-684A5A5662AC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/stop-azurermautomationjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Stop-AzureRMAutomationJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Stop-AzureRMAutomationJob.md ---- - -# Stop-AzureRmAutomationJob - -## SYNOPSIS -Stops an Automation job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Stop-AzureRmAutomationJob [-Id] [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Stop-AzureRmAutomationJob** cmdlet stops an Azure Automation job. -Specify a running Automation job. - -## EXAMPLES - -### Example 1: Stop a job -``` -PS C:\>Stop-AzureRmAutomationJob -AutomationAccountName "Contoso17" -Id 2989b069-24fe-40b9-b3bd-cb7e5eac4b64 -ResourceGroupName "ResourceGroup01" -``` - -This command stops the job that has the specified ID. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of an Automation account in which this cmdlet stops a job. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of a job that this cmdlet stops. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: JobId - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationJob](./Get-AzureRMAutomationJob.md) - -[Get-AzureRmAutomationJobOutput](./Get-AzureRMAutomationJobOutput.md) - -[Resume-AzureRmAutomationJob](./Resume-AzureRMAutomationJob.md) - -[Suspend-AzureRmAutomationJob](./Suspend-AzureRMAutomationJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Stop-AzureRmAutomationDscNodeConfigurationDeployment.md b/azurermps-6.13.0/AzureRM.Automation/Stop-AzureRmAutomationDscNodeConfigurationDeployment.md deleted file mode 100644 index ccede6b539..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Stop-AzureRmAutomationDscNodeConfigurationDeployment.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: 32CF9BF7-519F-4B5D-9F2B-3CC556A77A48 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/stop-azurermautomationdscnodeconfigurationdeployment -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Stop-AzureRmAutomationDscNodeConfigurationDeployment.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Stop-AzureRmAutomationDscNodeConfigurationDeployment.md ---- - -# Stop-AzureRmAutomationDscNodeConfigurationDeployment - -## SYNOPSIS -Stops a DSC Node configuration deployment in Automation. It only stops the current deployment job but does not unassign already assigned node configurations. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByJobId (Default) -``` -Stop-AzureRmAutomationDscNodeConfigurationDeployment -JobId [-Force] [-PassThru] - [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] - [-WhatIf] [-Confirm] [] -``` - -### ByInputObject -``` -Stop-AzureRmAutomationDscNodeConfigurationDeployment [-PassThru] -InputObject - [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Stop-AzureRmAutomationDscNodeConfigurationDeployment** cmdlet stops a deployment of a Desired State Configuration (DSC) node configuration in Azure Automation. It stops assignment of node configuration to groups of nodes, if any are remaining to be assigned, but does not unassign already assigned nodes. To unregister a scheduled job, please use the [Unregister-AzureRmAutomationScheduledRunbook](./Unregister-AzureRmAutomationScheduledRunbook.md) with the JobScheduleId to unassign an existing scheduled job. - -## EXAMPLES - -### Example 1: Deploy an Azure DSC node configuration in Automation -``` -PS C:\> Stop-AzureRmAutomationDscNodeConfigurationDeployment -AutomationAccountName "Contoso01" -ResourceGroupName "ResourceGroup01" -JobId 00000000-0000-0000-0000-000000000000 -``` - -The above command stops the DSC node configuration deployment job with the jobId passed in. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account that contains the DSC configuration that this cmdlet compiles - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -ps_force - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByJobId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Input object for Piping - -```yaml -Type: Microsoft.Azure.Commands.Automation.Model.NodeConfigurationDeployment -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -JobId -Specifies the Job id of an existing deployment job. - -```yaml -Type: System.Guid -Parameter Sets: ByJobId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group in which this cmdlet compiles a configuration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### Microsoft.Azure.Commands.Automation.Model.NodeConfigurationDeployment -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Start-AzureRmAutomationDscCompilationJob](./Start-AzureRmAutomationDscCompilationJob.md) - -[Import-AzureRmAutomationDscNodeConfiguration](./Import-AzureRmAutomationDscNodeConfiguration.md) - -[Start-AzureRmAutomationDscNodeConfigurationDeployment](./Start-AzureRmAutomationDscNodeConfigurationDeployment.md) - -[Get-AzureRmAutomationDscNodeConfigurationDeployment](./Get-AzureRmAutomationDscNodeConfigurationDeployment.md) - -[Get-AzureRmAutomationDscNodeConfigurationDeploymentSchedule](./Get-AzureRmAutomationDscNodeConfigurationDeploymentSchedule.md) diff --git a/azurermps-6.13.0/AzureRM.Automation/Suspend-AzureRMAutomationJob.md b/azurermps-6.13.0/AzureRM.Automation/Suspend-AzureRMAutomationJob.md deleted file mode 100644 index 4a56952748..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Suspend-AzureRMAutomationJob.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: FF44BCD2-AD8E-4F5C-AB10-BD6BD69E7F45 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/suspend-azurermautomationjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Suspend-AzureRMAutomationJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Suspend-AzureRMAutomationJob.md ---- - -# Suspend-AzureRmAutomationJob - -## SYNOPSIS -Suspends an Automation job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Suspend-AzureRmAutomationJob [-Id] [-ResourceGroupName] [-AutomationAccountName] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Suspend-AzureRmAutomationJob** cmdlet suspends an Azure Automation job. -Specify a running Automation job. -To resume a suspended job, use the Resume-AzureRmAutomationJob cmdlet. - -## EXAMPLES - -### Example 1: Suspend a job -``` -PS C:\>Suspend-AzureRmAutomationJob -AutomationAccountName "Contoso17" -Id 2989b069-24fe-40b9-b3bd-cb7e5eac4b64 -ResourceGroupName "ResourceGroup01" -``` - -This command suspends the job that has the specified ID. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of an Automation account in which this cmdlet suspends a job. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of a job that this cmdlet suspends. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: JobId - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the ID of a job that this cmdlet suspends. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationJob](./Get-AzureRMAutomationJob.md) - -[Get-AzureRmAutomationJobOutput](./Get-AzureRMAutomationJobOutput.md) - -[Resume-AzureRmAutomationJob](./Resume-AzureRMAutomationJob.md) - -[Stop-AzureRmAutomationJob](./Stop-AzureRMAutomationJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Unregister-AzureRMAutomationScheduledRunbook.md b/azurermps-6.13.0/AzureRM.Automation/Unregister-AzureRMAutomationScheduledRunbook.md deleted file mode 100644 index fab0290c9a..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Unregister-AzureRMAutomationScheduledRunbook.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: C7C193CF-4E3A-4275-8289-946C99B1C553 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/unregister-azurermautomationscheduledrunbook -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Unregister-AzureRMAutomationScheduledRunbook.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Unregister-AzureRMAutomationScheduledRunbook.md ---- - -# Unregister-AzureRmAutomationScheduledRunbook - -## SYNOPSIS -Removes an association between a runbook and a schedule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByJobScheduleId (Default) -``` -Unregister-AzureRmAutomationScheduledRunbook -JobScheduleId [-Force] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -### ByRunbookNameAndScheduleName -``` -Unregister-AzureRmAutomationScheduledRunbook -RunbookName -ScheduleName [-Force] - [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Unregister-AzureRmAutomationScheduledRunbook** cmdlet removes the association between an Azure Automation runbook and a schedule. -The schedule no longer starts the runbook. - -## EXAMPLES - -### Example 1: Remove the association between a runbook and a schedule -``` -PS C:\>Unregister-AzureRmAutomationScheduledRunbook -AutomationAccountName "Contoso17" -Name "Runbk01" -ResourceGroupName "ResourceGroup01" -ScheduleName "Runbk01Sched" -``` - -This command removes the association between the runbook named Runbk01 and the schedule named Runbk01Sched. - -## PARAMETERS - -### -AutomationAccountName -Specifies an Automation account for the runbook on which this cmdlet operates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -ps_force - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobScheduleId -Specifies the ID of a scheduled runbook. - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: ByJobScheduleId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group for the scheduled runbook. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RunbookName -Specifies the name of the runbook that this cmdlet dissociates from a schedule. - -```yaml -Type: System.String -Parameter Sets: ByRunbookNameAndScheduleName -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScheduleName -Specifies the name of the schedule from which this cmdlet dissociates a runbook. - -```yaml -Type: System.String -Parameter Sets: ByRunbookNameAndScheduleName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationScheduledRunbook](./Get-AzureRMAutomationScheduledRunbook.md) - -[Register-AzureRmAutomationScheduledRunbook](./Register-AzureRMAutomationScheduledRunbook.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Unregister-AzureRmAutomationDscNode.md b/azurermps-6.13.0/AzureRM.Automation/Unregister-AzureRmAutomationDscNode.md deleted file mode 100644 index 641ef383f8..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Unregister-AzureRmAutomationDscNode.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -ms.assetid: E4FC60AE-16B4-4E62-874F-49B9285CFF7A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/unregister-azurermautomationdscnode -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Unregister-AzureRmAutomationDscNode.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Unregister-AzureRmAutomationDscNode.md ---- - -# Unregister-AzureRmAutomationDscNode - -## SYNOPSIS -Removes a DSC node from management by an Automation account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Unregister-AzureRmAutomationDscNode -Id [-Force] [-ResourceGroupName] - [-AutomationAccountName] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Unregister-AzureRmAutomationDscNode** cmdlet removes an APS Desired State Configuration (DSC) node from management by an Azure Automation account. - -## EXAMPLES - -### Example 1: Remove an Azure DSC node from management by an Automation account -``` -PS C:\>Unregister-AzureRmAutomationDscNode -AutomationAccountName "Contoso17" -ResourceGroupName "ResourceGroup01" -Id 064a8929-c98b-25e4-80hh-111ca86067j8 -``` - -This command removes the DSC node that has the specified GUID from management by the Automation account named Contoso17. - -## PARAMETERS - -### -AutomationAccountName -Specifies the name of the Automation account from which this cmdlet removes a DSC node. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -ps_force - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the unique ID of the DSC node that this cmdlet removes. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: NodeId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group in which this cmdlet unregisters a DSC node. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.DscNode - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutomationDscNode](./Get-AzureRmAutomationDscNode.md) - -[Register-AzureRmAutomationDscNode](./Register-AzureRmAutomationDscNode.md) - -[Set-AzureRmAutomationDscNode](./Set-AzureRmAutomationDscNode.md) - - diff --git a/azurermps-6.13.0/AzureRM.Automation/Update-AzureRmAutomationSourceControl.md b/azurermps-6.13.0/AzureRM.Automation/Update-AzureRmAutomationSourceControl.md deleted file mode 100644 index c366d84968..0000000000 --- a/azurermps-6.13.0/AzureRM.Automation/Update-AzureRmAutomationSourceControl.md +++ /dev/null @@ -1,241 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml -Module Name: AzureRM.Automation -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.automation/update-azurermautomationsourcecontrol -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Update-AzureRmAutomationSourceControl.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Automation/Commands.Automation/help/Update-AzureRmAutomationSourceControl.md ---- - -# Update-AzureRmAutomationSourceControl - -## SYNOPSIS -Updates an Azure Automation source control. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Update-AzureRmAutomationSourceControl -Name [-AccessToken ] [-FolderPath ] - [-Branch ] [-Description ] [-AutoSync ] [-PublishRunbook ] - [-ResourceGroupName] [-AutomationAccountName] [-DefaultProfile ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Update-AzureRmAutomationSourceControl cmdlet modifies the value of a field in a source control in Azure Automation. - -## EXAMPLES - -### Example 1 -This commands sets the PublishRunbook field to false for the Azure Automation source control named VSTSNative in the account named devAccount. - - -```powershell -Update-AzureRmAutomationSourceControl -ResourceGroupName "rg1" ` - -AutomationAccountName "devAccount" ` - -Name "VSTSNative" ` - -PublishRunbook $false - -Name SourceType Branch FolderPath AutoSync PublishRunbook RepoUrl ----- ---------- ------ ---------- -------- -------------- ------- -VSTSNative VsoTfvc /MyRunbooks False False https://contoso.visualstudio.com/_git/Fin... -``` - -## PARAMETERS - -### -AccessToken -The source control access token. - -```yaml -Type: System.Security.SecureString -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutomationAccountName -The automation account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AutoSync -The autoSync property for the source control. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Branch -The source control branch. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The source control description. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FolderPath -The source control folder path. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The source control name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublishRunbook -The publishRunbook property of the source control. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Automation.Model.SourceControl - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Backup/AzureRM.Backup.md b/azurermps-6.13.0/AzureRM.Backup/AzureRM.Backup.md deleted file mode 100644 index c783ab4663..0000000000 --- a/azurermps-6.13.0/AzureRM.Backup/AzureRM.Backup.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -Module Name: AzureRM.Backup -Module Guid: 0b1d76f5-a928-4b8f-9c83-df26947568d4 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.backup -Help Version: 4.0.4.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/AzureRM.Backup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/AzureRM.Backup.md ---- - -# AzureRM.Backup Module -## Description -This topic displays help topics for the Azure Online Backup cmdlets. - -## AzureRM.Backup Cmdlets -### [Backup-AzureRmBackupItem](Backup-AzureRmBackupItem.md) -Starts a backup for a Backup item. - -### [Disable-AzureRmBackupProtection](Disable-AzureRmBackupProtection.md) -Disables protection for a Backup protected item. - -### [Enable-AzureRmBackupContainerReregistration](Enable-AzureRmBackupContainerReregistration.md) -Reregisters a server to connect to a Backup vault. - -### [Enable-AzureRmBackupProtection](Enable-AzureRmBackupProtection.md) -Associates an item with an Azure Backup protection policy. - -### [Get-AzureRmBackupContainer](Get-AzureRmBackupContainer.md) -Gets Backup containers. - -### [Get-AzureRmBackupItem](Get-AzureRmBackupItem.md) -Gets the items under a container in Backup. - -### [Get-AzureRmBackupJob](Get-AzureRmBackupJob.md) -Gets Backup jobs. - -### [Get-AzureRmBackupJobDetails](Get-AzureRmBackupJobDetails.md) -Gets the details of a Backup job. - -### [Get-AzureRmBackupProtectionPolicy](Get-AzureRmBackupProtectionPolicy.md) -Gets backup policies for a Backup vault. - -### [Get-AzureRmBackupRecoveryPoint](Get-AzureRmBackupRecoveryPoint.md) -Gets the recovery points for a backed up item. - -### [Get-AzureRmBackupVault](Get-AzureRmBackupVault.md) -Gets Backup vaults. - -### [Get-AzureRmBackupVaultCredentials](Get-AzureRmBackupVaultCredentials.md) -Downloads the vault credentials file for a Backup vault. - -### [New-AzureRmBackupProtectionPolicy](New-AzureRmBackupProtectionPolicy.md) -Creates a Backup policy. - -### [New-AzureRmBackupRetentionPolicyObject](New-AzureRmBackupRetentionPolicyObject.md) -Creates a Backup retention policy. - -### [New-AzureRmBackupVault](New-AzureRmBackupVault.md) -Creates a Backup vault. - -### [Register-AzureRmBackupContainer](Register-AzureRmBackupContainer.md) -Registers the container with a Backup vault. - -### [Remove-AzureRmBackupProtectionPolicy](Remove-AzureRmBackupProtectionPolicy.md) -Deletes a policy from a Backup vault. - -### [Remove-AzureRmBackupVault](Remove-AzureRmBackupVault.md) -Deletes a Backup vault. - -### [Restore-AzureRmBackupItem](Restore-AzureRmBackupItem.md) -Restores the data and configuration for a Backup item to a recovery point. - -### [Set-AzureRmBackupProtectionPolicy](Set-AzureRmBackupProtectionPolicy.md) -Modifies an existing protection policy. - -### [Set-AzureRmBackupVault](Set-AzureRmBackupVault.md) -Changes the storage type of a Backup vault. - -### [Stop-AzureRmBackupJob](Stop-AzureRmBackupJob.md) -Cancels an existing Backup job. - -### [Unregister-AzureRmBackupContainer](Unregister-AzureRmBackupContainer.md) -Unregisters a container from a Backup vault. - -### [Wait-AzureRmBackupJob](Wait-AzureRmBackupJob.md) -Waits for a Backup job to finish. - diff --git a/azurermps-6.13.0/AzureRM.Backup/Backup-AzureRmBackupItem.md b/azurermps-6.13.0/AzureRM.Backup/Backup-AzureRmBackupItem.md deleted file mode 100644 index da84a191df..0000000000 --- a/azurermps-6.13.0/AzureRM.Backup/Backup-AzureRmBackupItem.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AzureBackup.dll-Help.xml -Module Name: AzureRM.Backup -ms.assetid: 9FF4F649-F50C-4C27-842F-1CD6C5BC7A2B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.backup/backup-azurermbackupitem -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Backup-AzureRmBackupItem.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Backup-AzureRmBackupItem.md ---- - -# Backup-AzureRmBackupItem - -## SYNOPSIS -Starts a backup for a Backup item. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Backup-AzureRmBackupItem [-Item] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Backup-AzureRmBackupItem** cmdlet starts a backup for a protected Azure Backup item that is not tied to the backup schedule. -You can do an initial backup immediately after you enable protection or start a backup after a scheduled backup fails. -If an existing backup job is running, this cmdlet fails. - -## EXAMPLES - -### Example 1: Start to back up a virtual machine -``` -PS C:\>$Vault = Get-AzureRmBackupVault -Name "Vault03" -PS C:\> $Container = Get-AzureRmBackupContainer -Vault $Vault -Type AzureVM -Name "DPMSERVER.CONTOSO.COM" -PS C:\> Get-AzureRmBackupItem -Container $Container | Backup-AzureRmBackupItem -WorkloadName Operation Status StartTime EndTime ------------- --------- ------ --------- ------- -co03-vm Backup InProgress 26-Aug-15 12:24:01 PM 01-Jan-01 12:00:00 AM -``` - -The first command gets the vault named Vault03 by using the Get-AzureRmBackupVault cmdlet. -The command stores that object in the $Vault variable. -The second command gets a container that has the specified name in the vault in $Vault by using the Get-AzureRmBackupContainer cmdlet. -The command stores that object in the $Container variable. -The last command gets the backup items in $Container by using the Get-AzureRmBackupItem cmdlet. -The command passes the items to the current cmdlet by using the pipeline operator. -The current cmdlet starts backing up the virtual machine in the container. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Item -Specifies a Backup item for which this cmdlet starts a backup operation. - -```yaml -Type: Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupItem -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupItem -Parameters: Item (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupJob - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBackupItem](./Get-AzureRmBackupItem.md) - -[Get-AzureRmBackupVault](./Get-AzureRmBackupVault.md) - -[Restore-AzureRmBackupItem](./Restore-AzureRmBackupItem.md) - - diff --git a/azurermps-6.13.0/AzureRM.Backup/Disable-AzureRmBackupProtection.md b/azurermps-6.13.0/AzureRM.Backup/Disable-AzureRmBackupProtection.md deleted file mode 100644 index ac2d811693..0000000000 --- a/azurermps-6.13.0/AzureRM.Backup/Disable-AzureRmBackupProtection.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AzureBackup.dll-Help.xml -Module Name: AzureRM.Backup -ms.assetid: 6E886340-864C-4FF6-8FA3-669D637770F3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.backup/disable-azurermbackupprotection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Disable-AzureRmBackupProtection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Disable-AzureRmBackupProtection.md ---- - -# Disable-AzureRmBackupProtection - -## SYNOPSIS -Disables protection for a Backup protected item. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Disable-AzureRmBackupProtection [-RemoveRecoveryPoints] [-Force] [-Item] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Disable-AzureRmBackupProtection** cmdlet disables protection for an Azure Backup protected item. -This cmdlet stops regular scheduled backup of an item. -This cmdlet can delete existing recovery points for the backup item. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Item -Specifies the Backup item for which this cmdlet disables protection. -To obtain an **AzureRmBackupItem**, use the Get-AzureRmBackupItem cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupItem -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RemoveRecoveryPoints -Indicates that this cmdlet deletes existing recovery points. -To delete stored recovery points later, run this cmdlet again and specify this parameter. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupItem -Parameters: Item (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupJob - -## NOTES - -## RELATED LINKS - -[Enable-AzureRmBackupProtection](./Enable-AzureRmBackupProtection.md) - -[Get-AzureRmBackupItem](./Get-AzureRmBackupItem.md) - - diff --git a/azurermps-6.13.0/AzureRM.Backup/Enable-AzureRmBackupContainerReregistration.md b/azurermps-6.13.0/AzureRM.Backup/Enable-AzureRmBackupContainerReregistration.md deleted file mode 100644 index 33948cb851..0000000000 --- a/azurermps-6.13.0/AzureRM.Backup/Enable-AzureRmBackupContainerReregistration.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AzureBackup.dll-Help.xml -Module Name: AzureRM.Backup -ms.assetid: 2605B232-10CA-4426-9917-7C9719C15166 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.backup/enable-azurermbackupcontainerreregistration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Enable-AzureRmBackupContainerReregistration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Enable-AzureRmBackupContainerReregistration.md ---- - -# Enable-AzureRmBackupContainerReregistration - -## SYNOPSIS -Reregisters a server to connect to a Backup vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Enable-AzureRmBackupContainerReregistration [-Container] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Enable-AzureRmBackupContainerReregistration** cmdlet reregisters a server to connect to an Azure Backup vault and continue the Backup recovery point chain. -If you destroy a server, all its cloud backup points remain in the Backup vault. -If you create a replacement server and assign it the same fully qualified domain name, you can connect the server back to the same vault. -This cmdlet enables Backup to make backups and add new backup points to the existing set. -The new the server continues in the backup chain. - -## EXAMPLES - -## PARAMETERS - -### -Container -Specifies the container that this cmdlet reregisters. -To obtain an **AzureRmBackupContainer**, use the Get-AzureRmBackupContainer cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupContainer -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupContainer -Parameters: Container (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBackupContainer](./Get-AzureRmBackupContainer.md) - -[Register-AzureRmBackupContainer](./Register-AzureRmBackupContainer.md) - - diff --git a/azurermps-6.13.0/AzureRM.Backup/Enable-AzureRmBackupProtection.md b/azurermps-6.13.0/AzureRM.Backup/Enable-AzureRmBackupProtection.md deleted file mode 100644 index 17b36f4904..0000000000 --- a/azurermps-6.13.0/AzureRM.Backup/Enable-AzureRmBackupProtection.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AzureBackup.dll-Help.xml -Module Name: AzureRM.Backup -ms.assetid: DD150A2C-27D5-4119-9B43-FAB82F9F7D5B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.backup/enable-azurermbackupprotection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Enable-AzureRmBackupProtection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Enable-AzureRmBackupProtection.md ---- - -# Enable-AzureRmBackupProtection - -## SYNOPSIS -Associates an item with an Azure Backup protection policy. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Enable-AzureRmBackupProtection -Policy - [-Item] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Enable-AzureRmBackupProtection** cmdlet associates an item with an Azure Backup protection policy. -To enable a protection policy, you must first have an existing backup item and an existing policy. -Both must belong to the same Backup vault. -The backup schedule does the full initial copy for the item and the incremental copy for the subsequent backups. - -## EXAMPLES - -### Example 1: Enable protection on an Azure virtual machine -``` -PS C:\>$Vault = Get-AzureRmBackupVault -Name "Vault03" -PS C:\> $Policy = Get-AzureRmBackupProtectionPolicy -Vault $Vault -Name "DefaultPolicy" -PS C:\> Get-AzureRmBackupContainer -Vault $Vault -Type AzureVM -Status Registered | Get-AzureRmBackupItem | Enable-AzureRmBackupProtection -Policy $Policy -WorkloadName Operation Status StartTime EndTime ------------- --------- ------ --------- ------- -co03-vm ConfigureBackup Completed 26-Aug-15 12:19:49 PM 26-Aug-15 12:19:54 PM -``` - -The first command gets the vault named Vault03 by using the **Get-AzureRmBackupVault** cmdlet. -The command stores that object in the $Vault variable. -The second command gets the Backup protection policy named DefaultPolicy for the vault in $Vault. -The command stores that object in the $Policy variable. -The final command uses the pipeline operator to pass values from one cmdlet to the next. -It gets a container, by using the Get-AzureRmBackupContainer cmdlet. -The command gets the backup item from that container by using the Get-AzureRmBackupItem cmdlet. -The current cmdlet enables the policy stored in $Policy for the item that the command passes to that cmdlet. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Item -Specifies the Backup item for which this cmdlet enables protection. -To obtain an **AzureRmBackupItem**, use the Get-AzureRmBackupItem cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupContainerContextObject -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Policy -Specifies protection policy that this cmdlet associates with an item. -To obtain an **AzureRmBackupProtectionPolicy** object, use the Get-AzureRmBackupProtectionPolicy cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupProtectionPolicy -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupContainerContextObject -Parameters: Item (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupJob - -## NOTES - -## RELATED LINKS - -[Backup-AzureRmBackupItem](./Backup-AzureRmBackupItem.md) - -[Get-AzureRmBackupItem](./Get-AzureRmBackupItem.md) - -[Get-AzureRmBackupProtectionPolicy](./Get-AzureRmBackupProtectionPolicy.md) - - diff --git a/azurermps-6.13.0/AzureRM.Backup/Get-AzureRmBackupContainer.md b/azurermps-6.13.0/AzureRM.Backup/Get-AzureRmBackupContainer.md deleted file mode 100644 index 481e43f13b..0000000000 --- a/azurermps-6.13.0/AzureRM.Backup/Get-AzureRmBackupContainer.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AzureBackup.dll-Help.xml -Module Name: AzureRM.Backup -ms.assetid: F3774658-A5E4-40BE-9A85-B33C70BC0A09 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.backup/get-azurermbackupcontainer -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Get-AzureRmBackupContainer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Get-AzureRmBackupContainer.md ---- - -# Get-AzureRmBackupContainer - -## SYNOPSIS -Gets Backup containers. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmBackupContainer [-Name ] -Type - [-ManagedResourceGroupName ] [-Status ] - [-Vault] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmBackupContainer** cmdlet gets Azure Backup containers. -An **AzureBackupContainer** encapsulates data sources, protected items, and recovery points. -An **AzureBackupContainer** can be one of the following: -- A Windows Server computer -- A System Center Data Protection Manager (SCDPM) server -- An Azure infrastructure as a service (IaaS) virtual machine -Before Backup can back up a data source or item, you must register the container that holds it with the Azure Backup service. -The container must be authenticated to send backup data to the Backup vault. -For Windows Server computers and SCDPM servers, the registration is held with the fully qualified domain name of the server. - -## EXAMPLES - -### Example 1: View all servers registered to a vault -``` -PS C:\>$Vault = Get-AzureRmBackupVault -Name "Vault03" -PS C:\> Get-AzureRmBackupContainer -Vault $Vault -Type Windows -Name Type Status ----- ---- ------ -SERVER01.CONTOSO.COM Windows Registered -SERVER02.CONTOSO.COM Windows Registered -``` - -The first command gets the vault named Vault03 by using the **Get-AzureRmBackupVault** cmdlet. -The command stores that object in the $Vault variable. -The second command gets all containers of type Windows from the vault in $Vault. - -### Example 2: Get a specific container -``` -PS C:\>Get-AzureRmBackupContainer -Vault $Vault -Type SCDPM -Name "DPMSERVER.CONTOSO.COM" -Name Type Status ----- ---- ------ -DPMSERVER.CONTOSO.COM SCDPM Registered -``` - -This command gets the container named DPMSERVER.CONTOSO.COM. -The command specifies the vault in $Vault and the type of container. - -### Example 3: View all registered Azure virtual machines -``` -PS C:\>Get-AzureRmBackupContainer -Vault $Vault -Type AzureVM -Status Registered -Name Type Status ----- ---- ------ -co03-vm AzureVM Registered -``` - -This command gets the registered virtual machines from the vault in $Vault. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedResourceGroupName -Specifies the name of the resource group associated with the container. -This name is the same value that you specified for the *ServiceName* or *ResourceGroupName* parameter of the Register-AzureRmBackupContainer cmdlet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the container that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Status -Specifies the current status of the containers that this cmdlet gets. -The acceptable values for this parameter are: -- NotRegistered -- Registered -- Registering - -```yaml -Type: Microsoft.Azure.Commands.AzureBackup.Models.AzureBackupContainerRegistrationStatus -Parameter Sets: (All) -Aliases: -Accepted values: Registered, Registering, NotRegistered - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the type of containers that this cmdlet gets. - -```yaml -Type: Microsoft.Azure.Commands.AzureBackup.Models.AzureBackupContainerType -Parameter Sets: (All) -Aliases: -Accepted values: Windows, SCDPM, AzureVM, AzureBackupServer, Other - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Vault -Specifies a Backup vault from which this cmdlet gets containers. -To obtain an **AzureRmBackupVault**, use the Get-AzureRmBackupVault cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupVault -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupVault -Parameters: Vault (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupContainer - -## NOTES -* None - -## RELATED LINKS - -[Get-AzureRmBackupVault](./Get-AzureRmBackupVault.md) - -[Register-AzureRmBackupContainer](./Register-AzureRmBackupContainer.md) - -[Unregister-AzureRmBackupContainer](./Unregister-AzureRmBackupContainer.md) - - diff --git a/azurermps-6.13.0/AzureRM.Backup/Get-AzureRmBackupItem.md b/azurermps-6.13.0/AzureRM.Backup/Get-AzureRmBackupItem.md deleted file mode 100644 index ef0edbc41c..0000000000 --- a/azurermps-6.13.0/AzureRM.Backup/Get-AzureRmBackupItem.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AzureBackup.dll-Help.xml -Module Name: AzureRM.Backup -ms.assetid: 8A638FB1-F530-4E28-BAAE-5382671092C4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.backup/get-azurermbackupitem -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Get-AzureRmBackupItem.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Get-AzureRmBackupItem.md ---- - -# Get-AzureRmBackupItem - -## SYNOPSIS -Gets the items under a container in Backup. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmBackupItem [-ProtectionStatus ] [-Status ] [-Type ] - [-Container] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmBackupItem** cmdlet gets the items in a container in Azure Backup and the protection status of the items. -Enable items for protection by using the Enable-AzureRmBackupProtection cmdlet. -A container that is registered to a Backup vault can have one or more items that can be protected. -For Azure virtual machines, there can be only one item in the virtual machine container. - -## EXAMPLES - -### Example 1: Get the items in a container -``` -PS C:\>$Vault = Get-AzureRmBackupVault -Name "Vault03" -PS C:\> $Container = Get-AzureRmBackupContainer -Vault $Vault -Type AzureVM -Name "DPMSERVER.CONTOSO.COM" -PS C:\> Get-AzureRmBackupItem -Container $Container -Name ProtectionStatus DataSourceStatus RecoveryPointsCount ProtectionPolicyName ----- ---------------- ---------------- ------------------- -------------------- -co03-vm NotProtected 0 -``` - -The first command gets the vault named Vault03 by using the Get-AzureRmBackupVault cmdlet. -The command stores that object in the $Vault variable. -The second command gets a container that has the specified name in the vault in $Vault by using the **Get-AzureRmBackupContainer** cmdlet. -The command stores that object in the $Container variable. -The final command gets the backup item in the container in $Container. - -### Example 2: View all properties for an item -``` -PS C:\>Get-AzureRmBackupItem -Container $Container | Select-Object -Property * -Name : co03-vm -DataSourceStatus : -ProtectionStatus : NotProtected -Type : AzureVM -ProtectionPolicyName : -ProtectionPolicyId : -RecoveryPointsCount : 0 -ItemName : iaasvmcontainer;co03-vm;co03-vm -ContainerType : AzureVM -ContainerUniqueName : iaasvmcontainer;co03-vm;co03-vm -ResourceGroupName : resourcegroup02 -ResourceName : vault03 -Location : southeastasia -``` - -This command gets the backup item in the container in $Container, and then passes it to the Select-Object cmdlet. -That cmdlet returns all properties of the backup item. -For more information, type `Get-Help Select-Object`. - -## PARAMETERS - -### -Container -Specifies a container object for which this cmdlet gets backup items. -To obtain an **AzureRmBackupContainer**, use the Get-AzureRmBackupContainer cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupContainer -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtectionStatus -Specifies the overall protection status of an item in the container. -The acceptable values for this parameter are: -- Protected -- Protecting -- NotProtected - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Protected, Protecting, NotProtected - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Status -Specifies the backup status for an item. -The acceptable values for this parameter are: IRPending, Protected, ProtectionError, and ProtectionStopped. -If the *ProtectionStatus* parameter has the value Protected, you can use the *Status* parameter value to filter items. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: IRPending, ProtectionStopped, ProtectionError, Protected - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the type of item that this cmdlet gets. -Currently, the only supported value is AzureVM. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: AzureVM - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupContainer -Parameters: Container (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupItem - -## NOTES - -## RELATED LINKS - -[Backup-AzureRmBackupItem](./Backup-AzureRmBackupItem.md) - -[Disable-AzureRmBackupProtection](./Disable-AzureRmBackupProtection.md) - -[Enable-AzureRmBackupProtection](./Enable-AzureRmBackupProtection.md) - -[Get-AzureRmBackupContainer](./Get-AzureRmBackupContainer.md) - -[Get-AzureRmBackupVault](./Get-AzureRmBackupVault.md) - -[Restore-AzureRmBackupItem](./Restore-AzureRmBackupItem.md) - - diff --git a/azurermps-6.13.0/AzureRM.Backup/Get-AzureRmBackupJob.md b/azurermps-6.13.0/AzureRM.Backup/Get-AzureRmBackupJob.md deleted file mode 100644 index 6eb3f86dab..0000000000 --- a/azurermps-6.13.0/AzureRM.Backup/Get-AzureRmBackupJob.md +++ /dev/null @@ -1,287 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AzureBackup.dll-Help.xml -Module Name: AzureRM.Backup -ms.assetid: 331F32CB-7777-401C-A42A-23098944CFBE -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.backup/get-azurermbackupjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Get-AzureRmBackupJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Get-AzureRmBackupJob.md ---- - -# Get-AzureRmBackupJob - -## SYNOPSIS -Gets Backup jobs. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### FiltersSet (Default) -``` -Get-AzureRmBackupJob -Vault [-JobId ] [-From ] [-To ] - [-Status ] [-Type ] [-Operation ] [-DefaultProfile ] - [] -``` - -### JobsListFilter -``` -Get-AzureRmBackupJob -Job [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmBackupJob** cmdlet gets Azure Backup jobs for a specific vault. - -## EXAMPLES - -### Example 1: Get all jobs in a Backup vault -``` -PS C:\>$Vault = Get-AzureRmBackupVault -Name "Vault03" -PS C:\> Get-AzureRmBackupJob -Vault $Vault -WorkloadName Operation Status StartTime EndTime ------------- --------- ------ --------- ------- -co03-vm Backup InProgress 26-Aug-15 12:24:01 PM 01-Jan-01 12:00:00 AM -co03-vm ConfigureBackup Completed 26-Aug-15 12:19:49 PM 26-Aug-15 12:19:54 PM -co03-vm Register Completed 25-Aug-15 3:23:53 PM 25-Aug-15 3:25:00 PM -``` - -The first command gets the vault named Vault03 by using the **Get-AzureRmBackupVault** cmdlet. -The command stores that object in the $Vault variable. -The second command gets all the jobs for the vault in $Vault. - -### Example 2: Get completed jobs -``` -PS C:\>Get-AzureRmBackupJob -Vault $Vault -Status Completed -WorkloadName Operation Status StartTime EndTime ------------- --------- ------ --------- ------- -co03-vm Register Completed 25-Aug-15 3:23:53 PM 25-Aug-15 3:25:00 PM -``` - -This command gets completed jobs from the vault in $Vault. - -### Example 3: Get failed jobs for the last week -``` -PS C:\>Get-AzureRmBackupJob -Vault $Vault -From (Get-Date).AddDays(-7) -Status Failed -``` - -This command gets failed jobs from the last week from the vault in $Vault. -The *From* parameter specifies a time seven days in the past. -The command does not specify a value for the *To* parameter. -Therefore, it uses the default value of the current time. - -### Example 4: Poll Backup for an in progress job that finishes -``` -PS C:\>$Jobs = Get-AzureRmBackupJob -Vault $Vault -Status InProgress -$Job = $Jobs[0] -while ( $Job.Status -ne Completed ) -{ - Write-Host "Waiting for completion..." - Start-Sleep -Seconds 10 - $job = Get-AzureRmBackupJob -Vault $Vault -Job $Job -} -Write-Host "Done!" -Waiting for completion... -Waiting for completion... -Waiting for completion... -Done! -``` - -This script polls the first job that is currently in progress until the job has completed. -The first line of the script gets all the jobs in $Vault that are in progress, and then stores those jobs in the $Jobs array variable. -The second line stores the first job from the $Jobs array in the $Job variable. -The third line starts a **while** loop that checks the current status of the job until the job is completed. -For information about the **while** keyword, type `Get-Help about_While`. -The **while** loop writes a message to the console, sleeps for ten seconds, and then updates the $Job variable. -The script updates the $Job variable by using existing value of $Job and the current cmdlet to get the current status of the job. -For information about the Windows PowerShell cmdlets, type `Get-Help Write-Host` and `Get-Help Start-Sleep`. -The final line of the script tells you that the script has finished. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -From -Specifies the start, as a **DateTime** object, of a time range for the jobs that this cmdlet gets. -To obtain a **DateTime** object, use the Get-Date cmdlet. -For more information about **DateTime** objects, type `Get-Help Get-Date`. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: FiltersSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Job -Specifies a job that this cmdlet gets. -To obtain an **AzureRmBackupJob** object, use the Get-AzureRmBackupJob cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupJob -Parameter Sets: JobsListFilter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobId -Specifies the ID of a job that this cmdlet gets. -The ID is the **InstanceId** property of an **AzureRmBackupJob** object. -To obtain an **AzureRmBackupJob** object, use Get-AzureRmBackupJob. - -```yaml -Type: System.String -Parameter Sets: FiltersSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Operation -Specifies an operation of the jobs that this cmdlet gets. -The acceptable values for this parameter are: -- Backup -- ConfigureBackup -- DeleteBackupData -- Register -- Restore -- UnProtect -- Unregister - -```yaml -Type: System.String -Parameter Sets: FiltersSet -Aliases: -Accepted values: Backup, ConfigureBackup, DeleteBackupData, Register, Restore, UnProtect, Unregister - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Status -Specifies a status of the jobs that this cmdlet gets. -The acceptable values for this parameter are: -- InProgress -- Failed -- Cancelled -- Cancelling -- Completed -- CompletedWithWarnings -You can specify this parameter to find all in progress jobs or all failed jobs. - -```yaml -Type: System.String -Parameter Sets: FiltersSet -Aliases: -Accepted values: Cancelled, Cancelling, Completed, CompletedWithWarnings, Failed, InProgress - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -To -Specifies the end, as a **DateTime** object, of a time range for the jobs that this cmdlet gets. -The default value is the current system time. -If you specify this parameter, you must also specify the *From* parameter. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: FiltersSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the type of container for which this cmdlet gets backup jobs. -Currently, the only supported value is AzureVM. - -```yaml -Type: System.String -Parameter Sets: FiltersSet -Aliases: -Accepted values: AzureVM - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Vault -Specifies the Backup vault for which this cmdlet gets jobs. -To obtain an **AzureRmBackupVault** object, use the Get-AzureRmBackupVault cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupVault -Parameter Sets: FiltersSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupVault -Parameters: Vault (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupJob - -## NOTES -* None - -## RELATED LINKS - -[Get-AzureRmBackupVault](./Get-AzureRmBackupVault.md) - -[Stop-AzureRmBackupJob](./Stop-AzureRmBackupJob.md) - -[Wait-AzureRmBackupJob](./Wait-AzureRmBackupJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.Backup/Get-AzureRmBackupJobDetails.md b/azurermps-6.13.0/AzureRM.Backup/Get-AzureRmBackupJobDetails.md deleted file mode 100644 index ae3641b416..0000000000 --- a/azurermps-6.13.0/AzureRM.Backup/Get-AzureRmBackupJobDetails.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AzureBackup.dll-Help.xml -Module Name: AzureRM.Backup -ms.assetid: 6187F603-5298-4854-94F3-0C38FCF3125F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.backup/get-azurermbackupjobdetails -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Get-AzureRmBackupJobDetails.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Get-AzureRmBackupJobDetails.md ---- - -# Get-AzureRmBackupJobDetails - -## SYNOPSIS -Gets the details of a Backup job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### JobsFiltersSet (Default) -``` -Get-AzureRmBackupJobDetails -Job [-DefaultProfile ] - [] -``` - -### IdFiltersSet -``` -Get-AzureRmBackupJobDetails -Vault -JobId - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmBackupJobDetails** cmdlet gets the details of an Azure Backup job. -You can use this cmdlet to gather information about a job that fails. - -## EXAMPLES - -### Example 1: Display the details of a failed job -``` -PS C:\>$Vault = Get-AzureRmBackupVault -Name "Vault03" -PS C:\> $Jobs = Get-AzureRmBackupJob -Vault $Vault -Status Failed -PS C:\> $JobDetails = Get-AzureRmBackupJobDetails -Job $Jobs[0] -PS C:\> $JobDetails.ErrorDetails -ErrorCode ErrorMessage Recommendations ---------- ------------ --------------- - 400001 Command execution failed. {Another operation is currently in p... -``` - -The first command gets the vault named Vault03 by using the **Get-AzureRmBackupVault** cmdlet. -The command stores that object in the $Vault variable. -The second command gets failed jobs from the vault in $Vault, and then stores them in the $Jobs array variable. -The third job gets details for the first job in the $Jobs variable, and then stores those details in the $JobDetails variable. -The final command displays the **ErrorDetails** property of $JobDetails by using standard dot syntax. - -### Example 2: Display the recommended action for a failed job -``` -PS C:\>$JobDetails.ErrorDetails.Recommendations -Another operation is currently in progress on this item. Please wait until the previous operation is completed, and then retry. -``` - -This command displays the recommended action from the $JobDetails variable that was created in the first example. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Job -Specifies a job for which this cmdlet gets details. -To obtain an **AzureRmBackupJob** object, use the Get-AzureRmBackupJob cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupJob -Parameter Sets: JobsFiltersSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -JobId -Specifies the ID of a job for which this cmdlet gets details. -The ID is the **InstanceId** property of an **AzureRmBackupJob** object. -To obtain an **AzureRmBackupJob** object, use Get-AzureRmBackupJob. - -```yaml -Type: System.String -Parameter Sets: IdFiltersSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Vault -Specifies the Backup vault for which this cmdlet gets job details. -To obtain an **AzureRmBackupVault** object, use the Get-AzureRmBackupVault cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupVault -Parameter Sets: IdFiltersSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupJob -Parameters: Job (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupJobDetails - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBackupJob](./Get-AzureRmBackupJob.md) - -[Get-AzureRmBackupVault](./Get-AzureRmBackupVault.md) - - diff --git a/azurermps-6.13.0/AzureRM.Backup/Get-AzureRmBackupProtectionPolicy.md b/azurermps-6.13.0/AzureRM.Backup/Get-AzureRmBackupProtectionPolicy.md deleted file mode 100644 index e1ec9119f4..0000000000 --- a/azurermps-6.13.0/AzureRM.Backup/Get-AzureRmBackupProtectionPolicy.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AzureBackup.dll-Help.xml -Module Name: AzureRM.Backup -ms.assetid: B3B708C5-776E-4F1C-BA0B-492CD9057794 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.backup/get-azurermbackupprotectionpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Get-AzureRmBackupProtectionPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Get-AzureRmBackupProtectionPolicy.md ---- - -# Get-AzureRmBackupProtectionPolicy - -## SYNOPSIS -Gets backup policies for a Backup vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmBackupProtectionPolicy [[-Name] ] [-Vault] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmBackupProtectionPolicy** cmdlet gets backup policies for an Azure Backup vault. - -## EXAMPLES - -### Example 1: View the policies in a vault -``` -PS C:\>$Vault = Get-AzureRmBackupVault -Name "Vault03" -PS C:\> Get-AzureRmBackupProtectionPolicy -Vault $Vault -Name Type ScheduleType BackupTime ----- ---- ------------ ---------- -contoso01 AzureVM Daily 26-Aug-15 3:00:00 PM -DailyBkp AzureVM Daily 26-Aug-15 3:00:00 PM -DefaultPolicy AzureVM Daily 26-Aug-15 12:30:00 AM -WeeklyBkp AzureVM Weekly 26-Aug-15 5:00:00 PM -contoso02 AzureVM Daily 26-Aug-15 3:00:00 PM -``` - -The first command gets the vault named Vault03 by using the **Get-AzureRmBackupVault** cmdlet. -The command stores that object in the $Vault variable. -The second command gets all the Backup protection policies for the vault in $Vault. - -### Example 2: Get a specific policy from a vault -``` -PS C:\>$Vault = Get-AzureRmBackupVault -Name "Vault03" -PS C:\> Get-AzureRmBackupProtectionPolicy -Vault $Vault -Name "DefaultPolicy" -Name Type ScheduleType BackupTime ----- ---- ------------ ---------- -DefaultPolicy AzureVM Daily 26-Aug-15 12:30:00 AM -``` - -The first command gets the vault named Vault03 by using the **Get-AzureRmBackupVault** cmdlet. -The command stores that object in the $Vault variable. -The second command gets the Backup protection policy named DefaultPolicy for the vault in $Vault. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the policy that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Vault -Specifies the Backup vault for which this cmdlet gets policies. -To obtain an **AzureRmBackupVault** object, use the Get-AzureRmBackupVault cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupVault -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupVault -Parameters: Vault (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupProtectionPolicy - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBackupVault](./Get-AzureRmBackupVault.md) - -[Enable-AzureRmBackupProtection](./Enable-AzureRmBackupProtection.md) - -[New-AzureRmBackupProtectionPolicy](./New-AzureRmBackupProtectionPolicy.md) - -[Remove-AzureRmBackupProtectionPolicy](./Remove-AzureRmBackupProtectionPolicy.md) - - diff --git a/azurermps-6.13.0/AzureRM.Backup/Get-AzureRmBackupRecoveryPoint.md b/azurermps-6.13.0/AzureRM.Backup/Get-AzureRmBackupRecoveryPoint.md deleted file mode 100644 index 6a52f7f0db..0000000000 --- a/azurermps-6.13.0/AzureRM.Backup/Get-AzureRmBackupRecoveryPoint.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AzureBackup.dll-Help.xml -Module Name: AzureRM.Backup -ms.assetid: 6778E018-B6CC-468A-823E-3DA047EA6B52 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.backup/get-azurermbackuprecoverypoint -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Get-AzureRmBackupRecoveryPoint.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Get-AzureRmBackupRecoveryPoint.md ---- - -# Get-AzureRmBackupRecoveryPoint - -## SYNOPSIS -Gets the recovery points for a backed up item. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmBackupRecoveryPoint [[-RecoveryPointId] ] [-Item] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmBackupRecoveryPoint** cmdlet gets the recovery points for a backed up Azure Backup item. -After an item has been backed up, Backup stores one or more recovery points. - -## EXAMPLES - -### Example 1: Get recovery points for an item -``` -PS C:\>$Vault = Get-AzureRmBackupVault -Name "Vault03" -PS C:\> $Container = Get-AzureRmBackupContainer -Vault $Vault -Type AzureVM -Name "DPMSERVER.CONTOSO.COM" -PS C:\> $BackupItem = Get-AzureRmBackupItem -Container $Container -PS C:\> Get-AzureRmBackupRecoveryPoint -Item $BackupItem -RecoveryPointId RecoveryPointType RecoveryPointTime ContainerName ---------------- ----------------- ----------------- ------------- -15273496567119 AppConsistent 26-Aug-15 12:27:38 PM iaasvmcontainer;conto02-vm;conto0... -``` - -The first command gets the vault named Vault03 by using the Get-AzureRmBackupVault cmdlet. -The command stores that object in the $Vault variable. -The second command gets a container that has the specified name in the vault in $Vault by using the **Get-AzureRmBackupContainer** cmdlet. -The command stores that object in the $Container variable. -The third command gets the backup item in the container in $Container by using the **Get-AzureRmBackupItem** cmdlet. -The command stores that object in the $BackupItem variable. -The final command gets recovery points for the item in $BackupItem. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Item -Specifies the item for which this cmdlet gets recovery points. -To obtain an **AzureRmBackupItem**, use the Get-AzureRmBackupItem cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupItem -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RecoveryPointId -Specifies the ID of a recovery point that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupItem -Parameters: Item (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupRecoveryPoint - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBackupContainer](./Get-AzureRmBackupContainer.md) - -[Get-AzureRmBackupItem](./Get-AzureRmBackupItem.md) - -[Get-AzureRmBackupVault](./Get-AzureRmBackupVault.md) - - diff --git a/azurermps-6.13.0/AzureRM.Backup/Get-AzureRmBackupVault.md b/azurermps-6.13.0/AzureRM.Backup/Get-AzureRmBackupVault.md deleted file mode 100644 index 4973860b56..0000000000 --- a/azurermps-6.13.0/AzureRM.Backup/Get-AzureRmBackupVault.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AzureBackup.dll-Help.xml -Module Name: AzureRM.Backup -ms.assetid: 95FF3F7A-5CC6-4AA6-A393-5EBB5579D9A2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.backup/get-azurermbackupvault -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Get-AzureRmBackupVault.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Get-AzureRmBackupVault.md ---- - -# Get-AzureRmBackupVault - -## SYNOPSIS -Gets Backup vaults. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmBackupVault [[-ResourceGroupName] ] [[-Name] ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmBackupVault** cmdlet gets Azure Backup vaults. -This cmdlet returns **AzureRmBackupVault** objects for use with other cmdlets. - -## EXAMPLES - -### Example 1: View all the Backup vaults -``` -PS C:\>Get-AzureRmBackupVault -``` - -This command gets all the Azure Backup vaults. - -### Example 2: View all vaults created in West US -``` -PS C:\>Get-AzureRmBackupVault | Where-Object { $_.Region -eq "westus" } -``` - -This command gets all the Backup vaults. -The command passes them to the Where-Object cmdlet by using the pipeline operator. -That cmdlet filters the results based on the **Region** property. -For more information, type `Get-Help Where-Object`. - -### Example 3: Get a specific vault -``` -PS C:\>Get-AzureRmBackupVault -Name "Vault03" -ResourceId : /subscriptions/4bfbe168-f42a-4a06-8f5a-331cad1f497e/resourceGroups/ResourceGroup011/providers/Microsoft.Backup - /BackupVault/Vault -Name : Vault03 -ResourceGroupName : ResourceGroup01 -Region : westus -Storage : GeoRedundant -``` - -This command gets the vault named Vault03. - -### Example 4: Count the number of vaults that have locally redundant storage -``` -PS C:\>Get-AzureRmBackupVault | Where-Object { $_.Storage -match "LocallyRedundant" } | Measure-Object -Count : 4 -Average : -Sum : -Maximum : -Minimum : -Property : -``` - -This command gets all the Azure Backup vaults. -The command passes them to **Where-Object**, which filters the results based on the **Storage** property. -The command passes the ones that have a value of LocallyRedundant to the Measure-Object cmdlet, which counts the results. -For more information, type `Get-Help Measure-Object`. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Backup vault that this cmdlet gets. -If more than one Backup vault has the same name, this cmdlet returns them all. -Specify the *ResourceGroupName* parameter to get a unique vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group in which this cmdlet gets a Backup vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupVault - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBackupContainer](./Get-AzureRmBackupContainer.md) - -[New-AzureRmBackupVault](./New-AzureRmBackupVault.md) - -[Remove-AzureRmBackupVault](./Remove-AzureRmBackupVault.md) - -[Set-AzureRmBackupVault](./Set-AzureRmBackupVault.md) - - diff --git a/azurermps-6.13.0/AzureRM.Backup/Get-AzureRmBackupVaultCredentials.md b/azurermps-6.13.0/AzureRM.Backup/Get-AzureRmBackupVaultCredentials.md deleted file mode 100644 index c2ad93c4e6..0000000000 --- a/azurermps-6.13.0/AzureRM.Backup/Get-AzureRmBackupVaultCredentials.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AzureBackup.dll-Help.xml -Module Name: AzureRM.Backup -ms.assetid: 9882F1A5-6FFB-4DAF-8ED5-B14596BC939D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.backup/get-azurermbackupvaultcredentials -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Get-AzureRmBackupVaultCredentials.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Get-AzureRmBackupVaultCredentials.md ---- - -# Get-AzureRmBackupVaultCredentials - -## SYNOPSIS -Downloads the vault credentials file for a Backup vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmBackupVaultCredentials [-TargetLocation] [-Vault] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmBackupVaultCredentials** cmdlet downloads the vault credentials file for an Azure Backup vault. -Backup uses a vault credential file to connect a server to the Azure Backup vault and register it. -You must register a server before Backup can send backup data to the vault. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetLocation -Specifies the destination path where this cmdlet stores the vault credentials file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Vault -Specifies the Backup vault for which this cmdlet gets a vault credential file. -To obtain an **AzureRmBackupVault** object, use the Get-AzureRmBackupVault cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupVault -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupVault -Parameters: Vault (ByValue) - -## OUTPUTS - -### System.String -This cmdlet returns the name of the vault credential file. - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBackupVault](./Get-AzureRmBackupVault.md) - - diff --git a/azurermps-6.13.0/AzureRM.Backup/New-AzureRmBackupProtectionPolicy.md b/azurermps-6.13.0/AzureRM.Backup/New-AzureRmBackupProtectionPolicy.md deleted file mode 100644 index a1b52401b3..0000000000 --- a/azurermps-6.13.0/AzureRM.Backup/New-AzureRmBackupProtectionPolicy.md +++ /dev/null @@ -1,273 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AzureBackup.dll-Help.xml -Module Name: AzureRM.Backup -ms.assetid: 3A7B0280-CE6E-4374-87AF-4C1015EB88FA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.backup/new-azurermbackupprotectionpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/New-AzureRmBackupProtectionPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/New-AzureRmBackupProtectionPolicy.md ---- - -# New-AzureRmBackupProtectionPolicy - -## SYNOPSIS -Creates a Backup policy. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NoScheduleParamSet (Default) -``` -New-AzureRmBackupProtectionPolicy [-Name] [-Type] [-BackupTime] - [[-DaysOfWeek] ] [-RetentionPolicy] [-Vault] - [-DefaultProfile ] [] -``` - -### DailyScheduleParamSet -``` -New-AzureRmBackupProtectionPolicy [-Name] [-Type] [-Daily] [-BackupTime] - [-RetentionPolicy] [-Vault] - [-DefaultProfile ] [] -``` - -### WeeklyScheduleParamSet -``` -New-AzureRmBackupProtectionPolicy [-Name] [-Type] [-Weekly] [-BackupTime] - [-DaysOfWeek] [-RetentionPolicy] [-Vault] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureRmBackupProtectionPolicy** cmdlet creates an Azure Backup policy as an Azure PowerShell object. -A backup policy defines when and how often Backup backs up an item. -The Enable-AzureRmBackupProtection cmdlet uses a backup policy. - -## EXAMPLES - -### Example 1: Create a daily backup policy with daily and monthly retention -``` -PS C:\>$Vault = Get-AzureRmBackupVault -Name "Vault03" -PS C:\> $Daily = New-AzureRmBackupRetentionPolicyObject -DailyRetention -Retention 30 -PS C:\> $Monthly = New-AzureRmBackupRetentionPolicyObject -MonthlyRetentionInDailyFormat -DaysOfMonth (10, 20) -Retention 12 -PS C:\> $ProtectionPolicy = New-AzureRmBackupProtectionPolicy -Name DailyBackup01 -Type AzureVM -Daily -BackupTime ([datetime]"3:30 PM") -RetentionPolicy ($Daily,$Monthly) -Vault $Vault -Name Type ScheduleType BackupTime ----- ---- ------------ ---------- -DailyBkp AzureVM Daily 26-Aug-15 3:00:00 PM -``` - -The first command gets the vault named Vault03 by using the Get-AzureRmBackupVault cmdlet. -The command stores that object in the $Vault variable. -The second command creates a retention policy for 30 days of daily retention, and then stores it in the $Daily variable. -The third command creates a retention policy that keeps the backup on the tenth and the twentieth of each month for twelve months. -The command stores the retention policy in the $Monthly variable. -The final command creates a backup policy for the vault in $Vault that has a daily backup time of 3:00 PM. -The command assigns the retention policies stored in $Daily and $Monthly. -The command stores the result in the $ProtectionPolicy variable. - -## PARAMETERS - -### -BackupTime -Specifies the time of day, as a **DateTime** object, for the backup operation. -To obtain a **DateTime**, use the Get-Date cmdlet. -For information about **DateTime** objects, type `Get-Help Get-Date`. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Daily -Indicates that the backup operation runs on a Daily schedule. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: DailyScheduleParamSet -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DaysOfWeek -Specifies an array of days of the week. -This policy runs backups on the days specified by this parameter. -The acceptable values for this parameter are: -- Monday -- Tuesday -- Wednesday -- Thursday -- Friday -- Saturday -- Sunday -If you specify the *Weekly* parameter, specify this parameter. - -```yaml -Type: System.String[] -Parameter Sets: NoScheduleParamSet -Aliases: -Accepted values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String[] -Parameter Sets: WeeklyScheduleParamSet -Aliases: -Accepted values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday - -Required: True -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the backup policy. -Select a name that is unique in the vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionPolicy -Specifies an array of retention policies for the backup policy. -To obtain an **AzureRmBackupRetentionPolicy**, use the New-AzureRmBackupRetentionPolicyObject cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupRetentionPolicy[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Type -Specifies the type of backup item to which the policy applies. -Currently, the only supported value is AzureVM. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: AzureVM - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Vault -Specifies the Azure Backup vault to which the backup policy belongs. -To obtain an **AzureRmBackupVault** object, use the Get-AzureRmBackupVault cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupVault -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Weekly -Indicates that the backup policy is triggered weekly on one or more days of the week. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: WeeklyScheduleParamSet -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.DateTime - -### System.String[] - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupRetentionPolicy[] - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupVault -Parameters: Vault (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupProtectionPolicy - -## NOTES -* None - -## RELATED LINKS - -[Enable-AzureRmBackupProtection](./Enable-AzureRmBackupProtection.md) - -[Get-AzureRmBackupProtectionPolicy](./Get-AzureRmBackupProtectionPolicy.md) - -[Get-AzureRmBackupVault](./Get-AzureRmBackupVault.md) - -[New-AzureRmBackupRetentionPolicyObject](./New-AzureRmBackupRetentionPolicyObject.md) - -[Remove-AzureRmBackupProtectionPolicy](./Remove-AzureRmBackupProtectionPolicy.md) - -[Set-AzureRmBackupProtectionPolicy](./Set-AzureRmBackupProtectionPolicy.md) - - diff --git a/azurermps-6.13.0/AzureRM.Backup/New-AzureRmBackupRetentionPolicyObject.md b/azurermps-6.13.0/AzureRM.Backup/New-AzureRmBackupRetentionPolicyObject.md deleted file mode 100644 index 44f54683e2..0000000000 --- a/azurermps-6.13.0/AzureRM.Backup/New-AzureRmBackupRetentionPolicyObject.md +++ /dev/null @@ -1,332 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AzureBackup.dll-Help.xml -Module Name: AzureRM.Backup -ms.assetid: 9574CEB5-B699-4606-8C5E-CE2C0D01092D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.backup/new-azurermbackupretentionpolicyobject -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/New-AzureRmBackupRetentionPolicyObject.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/New-AzureRmBackupRetentionPolicyObject.md ---- - -# New-AzureRmBackupRetentionPolicyObject - -## SYNOPSIS -Creates a Backup retention policy. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DailyRetentionParamSet -``` -New-AzureRmBackupRetentionPolicyObject [-DailyRetention] -Retention - [-DefaultProfile ] [] -``` - -### WeeklyRetentionParamSet -``` -New-AzureRmBackupRetentionPolicyObject [-WeeklyRetention] -DaysOfWeek -Retention - [-DefaultProfile ] [] -``` - -### MonthlyRetentionInDailyFormatParamSet -``` -New-AzureRmBackupRetentionPolicyObject [-MonthlyRetentionInDailyFormat] - -DaysOfMonth -Retention - [-DefaultProfile ] [] -``` - -### MonthlyRetentionInWeeklyFormatParamSet -``` -New-AzureRmBackupRetentionPolicyObject [-MonthlyRetentionInWeeklyFormat] -DaysOfWeek - -WeekNumber -Retention [-DefaultProfile ] [] -``` - -### YearlyRetentionInDailyFormatParamSet -``` -New-AzureRmBackupRetentionPolicyObject [-YearlyRetentionInDailyFormat] - -DaysOfMonth -MonthsOfYear -Retention - [-DefaultProfile ] [] -``` - -### YearlyRetentionInWeeklyFormatParamSet -``` -New-AzureRmBackupRetentionPolicyObject [-YearlyRetentionInWeeklyFormat] -DaysOfWeek - -WeekNumber -MonthsOfYear -Retention [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **New-AzureRmBackupRetentionPolicyObject** cmdlet creates an Azure Backup retention policy. -A retention policy defines how long Backup keeps a recovery point. -The types of retention are the following: -- Daily -- Weekly -- Monthly -- Yearly -Create one retention policy for each type of retention that you plan to use. -A backup policy is associated with at least one retention policy. -To create a backup policy, use the New-AzureRmBackupProtectionPolicy cmdlet. -You can instead provide a retention policy to the Enable-AzureRmBackupProtection cmdlet. - -## EXAMPLES - -### Example 1: Create a retention policy for daily retention -``` -PS C:\>$Daily = New-AzureRmBackupRetentionPolicyObject -DailyRetention -Retention 30 -PS C:\> $Daily -RetentionType Retention RetentionTimes -------------- --------- -------------- -Daily 30 -``` - -The first command creates a retention policy for 30 days of daily retention, and then stores it in the $Daily variable. -The second command displays the contents of $Daily. - -### Example 2: Create a monthly retention policy -``` -PS C:\>$Monthly = New-AzureRmBackupRetentionPolicyObject -MonthlyRetentionInDailyFormat -DaysOfMonth (10, 20) -Retention 12 -PS C:\> $Monthly | select * -RetentionFormat : Daily -DaysOfMonth : {10, 20} -WeekNumber : -DaysOfWeek : -RetentionType : Monthly -Retention : 12 -RetentionTimes : -``` - -The first command creates a retention policy that keeps the backup on the tenth and the twentieth of each month for twelve months. -The command stores the retention policy in the $Monthly variable. -The second command displays the contents of $Monthly. - -## PARAMETERS - -### -DailyRetention -Indicates that this cmdlet creates a Daily retention policy. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: DailyRetentionParamSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DaysOfMonth -Specifies the days of the month that identify which recovery points Backup retains and for how long. -The acceptable values for this parameter are: integers from 1 through 28 and Last. -Specify this parameter if you specify the *DailyRetention*, *MonthlyRetentionInDailyFormat*, and *YearlyRetentionInDailyFormat* parameters. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: MonthlyRetentionInDailyFormatParamSet, YearlyRetentionInDailyFormatParamSet -Aliases: -Accepted values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, Last - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DaysOfWeek -Specifies an array of days of the week. -The days that this cmdlet specifies identify which recovery points that Backup retains and for how long. -The acceptable values for this parameter are: -- Monday -- Tuesday -- Wednesday -- Thursday -- Friday -- Saturday -- Sunday -Specify this parameter if you specify the *WeeklyRetention*, *MonthlyRetentionInWeeklyFormat*, and *YearlyRetentionInWeeklyFormat* parameters. -Be sure that the days of the week you select for backup and for retention are aligned. -For example, if your backup is set for Saturdays, the retention policies must also use Saturday. - -```yaml -Type: System.String[] -Parameter Sets: WeeklyRetentionParamSet, MonthlyRetentionInWeeklyFormatParamSet, YearlyRetentionInWeeklyFormatParamSet -Aliases: -Accepted values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MonthlyRetentionInDailyFormat -Indicates that this cmdlet creates a Monthly policy in Daily format. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: MonthlyRetentionInDailyFormatParamSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MonthlyRetentionInWeeklyFormat -Indicates that this cmdlet creates a Monthly policy in Weekly format. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: MonthlyRetentionInWeeklyFormatParamSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MonthsOfYear -Specifies which months of the year have the recovery points that Backup retains on a yearly basis. -The acceptable values for this parameter are: names of months, such as January or February. - -```yaml -Type: System.String[] -Parameter Sets: YearlyRetentionInDailyFormatParamSet, YearlyRetentionInWeeklyFormatParamSet -Aliases: -Accepted values: January, February, March, April, May, June, July, August, September, October, November, December - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Retention -Specifies the retention period, in days, months, or years, for which Backup stores a backup point. -The unit depends on whether this cmdlet selects a daily, monthly, or yearly retention option. -For example, if specify the *DailyRetention* parameter, the cmdlet interprets the current parameter as a number of days. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WeeklyRetention -Indicates that this cmdlet creates a Weekly retention policy. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: WeeklyRetentionParamSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WeekNumber -Specifies the weeks of the month that identify which recovery points Backup retains and for how long. -The acceptable values for this parameter are: -- First -- Second -- Third -- Fourth -- Last - -```yaml -Type: System.String[] -Parameter Sets: MonthlyRetentionInWeeklyFormatParamSet, YearlyRetentionInWeeklyFormatParamSet -Aliases: -Accepted values: First, Second, Third, Fourth, Last - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -YearlyRetentionInDailyFormat -Indicates that this cmdlet creates a Yearly retention policy in Daily format. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: YearlyRetentionInDailyFormatParamSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -YearlyRetentionInWeeklyFormat -Indicates that this cmdlet creates a Yearly retention policy in Weekly format. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: YearlyRetentionInWeeklyFormatParamSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupRetentionPolicy - -## NOTES -* None - -## RELATED LINKS - -[Enable-AzureRmBackupProtection](./Enable-AzureRmBackupProtection.md) - -[New-AzureRmBackupProtectionPolicy](./New-AzureRmBackupProtectionPolicy.md) - - diff --git a/azurermps-6.13.0/AzureRM.Backup/New-AzureRmBackupVault.md b/azurermps-6.13.0/AzureRM.Backup/New-AzureRmBackupVault.md deleted file mode 100644 index 4f2735cd07..0000000000 --- a/azurermps-6.13.0/AzureRM.Backup/New-AzureRmBackupVault.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AzureBackup.dll-Help.xml -Module Name: AzureRM.Backup -ms.assetid: 015E3BC9-C535-4EA2-8A30-C728385DBFF8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.backup/new-azurermbackupvault -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/New-AzureRmBackupVault.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/New-AzureRmBackupVault.md ---- - -# New-AzureRmBackupVault - -## SYNOPSIS -Creates a Backup vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmBackupVault [-ResourceGroupName] [-Name] [-Region] - [[-Storage] ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureRmBackupVault** cmdlet creates an Azure Backup vault. -This cmdlet returns an **AzureRmBackupVault** object that acts as a reference to the vault entity. - -## EXAMPLES - -### Example 1: Create a backup vault -``` -PS C:\>New-AzureRmBackupVault -ResourceGroupName "ResourceGroup01" -Name "Vault03" -Region "westus" -ResourceId : /subscriptions/4bfbe168-f42a-4a06-8f5a-331cad1f497e/resourceGroups/ResourceGroup01/providers/Microsoft.Backup - /BackupVault/Vault03 -Name : Vault03 -ResourceGroupName : ResourceGroup01 -Region : westus -Storage : GeoRedundant -``` - -This command creates an Azure Backup vault named Vault03. -The vault is in the resource group named ResourceGroup01 in the West US region. -The vault uses the default GeoRedundant storage type. - -### Example 2: Create a backup vault that uses locally redundant storage -``` -PS C:\>New-AzureRmBackupVault -ResourceGroupName "ResourceGroup02" -Name "Vault03" -Region "westus" -Storage LocallyRedundant -ResourceId : /subscriptions/4bfbe168-f42a-4a06-8f5a-331cad1f497e/resourceGroups/ResourceGroup02/providers/Microsoft.Backup - /BackupVault/Vault03 -Name : Vault03 -ResourceGroupName : ResourceGroup02 -Region : westus -Storage : LocallyRedundant -``` - -This command creates an Azure Backup vault named Vault03. -The vault is in the resource group named ResourceGroup02 in the West US region. -The vault uses the LocallyRedundant storage type. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the Azure Backup vault. -The name must be unique in a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Region -Specifies an Azure region in which the backup vault exists. -For hybrid backup scenarios, we recommend that you create a vault in a region close to the on-premise server to reduce latency. -For backup of Azure infrastructure as a service (IaaS) virtual machines, the vault becomes the point of discovery for local virtual machines. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an existing Azure resource group in which this cmdlet creates a Backup vault. -To create a resource group, use the New-AzureRMResourceGroup cmdlet. -The resource group and the Azure Backup vault do not have to be in the same region. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Storage -Specifies the storage type for the backup data. -The acceptable values for this parameter are: LocallyRedundant and GeoRedundant. -The default value is GeoRedundant. - -```yaml -Type: Microsoft.Azure.Commands.AzureBackup.Models.AzureBackupVaultStorageType -Parameter Sets: (All) -Aliases: -Accepted values: GeoRedundant, LocallyRedundant - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupVault - -## NOTES -* None - -## RELATED LINKS - -[Get-AzureRmBackupVault](./Get-AzureRmBackupVault.md) - -[Remove-AzureRmBackupVault](./Remove-AzureRmBackupVault.md) - -[Set-AzureRmBackupVault](./Set-AzureRmBackupVault.md) - - diff --git a/azurermps-6.13.0/AzureRM.Backup/Register-AzureRmBackupContainer.md b/azurermps-6.13.0/AzureRM.Backup/Register-AzureRmBackupContainer.md deleted file mode 100644 index c76a07ea07..0000000000 --- a/azurermps-6.13.0/AzureRM.Backup/Register-AzureRmBackupContainer.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AzureBackup.dll-Help.xml -Module Name: AzureRM.Backup -ms.assetid: 394500DB-D2BB-4793-8D9F-2CAF4D892A55 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.backup/register-azurermbackupcontainer -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Register-AzureRmBackupContainer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Register-AzureRmBackupContainer.md ---- - -# Register-AzureRmBackupContainer - -## SYNOPSIS -Registers the container with a Backup vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### V1VM -``` -Register-AzureRmBackupContainer -Name -ServiceName [-Vault] - [-DefaultProfile ] [] -``` - -### V2VM -``` -Register-AzureRmBackupContainer -Name -ResourceGroupName [-Vault] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Register-AzureRmBackupContainer** cmdlet registers the container with an Azure Backup vault. -To configure backup by using Azure Backup, first register your server or virtual machine with a Backup vault. -This cmdlet registers an infrastructure as a service (IaaS) virtual machine with the specified vault. -The register operation associates the Azure virtual machine with the backup vault and tracks the virtual machine through the backup life cycle. - -## EXAMPLES - -### Example 1: Register a virtual machine to a Backup vault -``` -PS C:\>$Vault = Get-AzureRmBackupVault -Name "Vault03" -PS C:\> Register-AzureRmBackupContainer -Vault $Vault -Name "Contoso03Vm" -ServiceName "ContosoService27" -``` - -The first command gets the vault named Vault03 by using the Get-AzureRmBackupVault cmdlet. -The command stores the vault in the $Vault variable. -The second command registers the virtual machine named Contoso03Vm with the vault in $Vault. -That virtual machine belongs to the service named ContosoService27. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual machine that this cmdlet registers. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for the virtual machine. - -```yaml -Type: System.String -Parameter Sets: V2VM -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceName -Specifies the service name of the virtual machine that this cmdlet registers. -Typically, a cloud service name has a suffix .cloudapp.net. -Do not include the suffix when you specify this parameter. -To obtain information about a virtual machine, use the Get-AzureRMVM cmdlet. -The service name is the **DeploymentName** property of the virtual machine object. - -```yaml -Type: System.String -Parameter Sets: V1VM -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Vault -Specifies the Backup vault to which this cmdlet registers virtual machine. -To obtain an **AzureRmBackupVault** object, use the Get-AzureRmBackupVault cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupVault -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupVault -Parameters: Vault (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupJob - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBackupVault](./Get-AzureRmBackupVault.md) - - diff --git a/azurermps-6.13.0/AzureRM.Backup/Remove-AzureRmBackupProtectionPolicy.md b/azurermps-6.13.0/AzureRM.Backup/Remove-AzureRmBackupProtectionPolicy.md deleted file mode 100644 index 9734d5c6ff..0000000000 --- a/azurermps-6.13.0/AzureRM.Backup/Remove-AzureRmBackupProtectionPolicy.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AzureBackup.dll-Help.xml -Module Name: AzureRM.Backup -ms.assetid: 189E3DD8-AA43-4D4C-A873-971E0585E54E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.backup/remove-azurermbackupprotectionpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Remove-AzureRmBackupProtectionPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Remove-AzureRmBackupProtectionPolicy.md ---- - -# Remove-AzureRmBackupProtectionPolicy - -## SYNOPSIS -Deletes a policy from a Backup vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmBackupProtectionPolicy [-Force] [-ProtectionPolicy] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AzureRmBackupProtectionPolicy** cmdlet deletes a policy from an Azure Backup vault. -Before you can delete a backup protection policy, the policy must not have any associated Backup items. -Before you delete the policy, make sure that each associated item is associated with some other policy. -To associate another policy with a backup item, use the Enable-AzureRmBackupProtection cmdlet. - -## EXAMPLES - -### Example 1: Remove a backup protection policy -``` -PS C:\>$Vault = Get-AzureRmBackupVault -Name "Vault03" -PS C:\> Get-AzureRmBackupProtectionPolicy -Vault $Vault -Name "DailyBackup" | Remove-AzureRmBackupProtectionPolicy -``` - -The first command gets the vault named Vault03 by using the Get-AzureRmBackupVault cmdlet. -The command stores that object in the $Vault variable. -The second command creates a retention policy for 30 days of daily retention, and then stores it in the $Daily variable. -The second command gets the protection policy named DailyBackup in the vault in $Vault by using the **Get-AzureRmBackupProtectionPolicy** cmdlet. -The command passes the policy to the current cmdlet. -That cmdlet removes the policy. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtectionPolicy -Specifies protection policy that this cmdlet removes. -To obtain an **AzureRmBackupProtectionPolicy**, use the Get-AzureRmBackupProtectionPolicy cmdlet - -```yaml -Type: Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupProtectionPolicy -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupProtectionPolicy -Parameters: ProtectionPolicy (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Enable-AzureRmBackupProtection](./Enable-AzureRmBackupProtection.md) - -[Get-AzureRmBackupProtectionPolicy](./Get-AzureRmBackupProtectionPolicy.md) - -[New-AzureRmBackupProtectionPolicy](./New-AzureRmBackupProtectionPolicy.md) - - diff --git a/azurermps-6.13.0/AzureRM.Backup/Remove-AzureRmBackupVault.md b/azurermps-6.13.0/AzureRM.Backup/Remove-AzureRmBackupVault.md deleted file mode 100644 index 9790db75a7..0000000000 --- a/azurermps-6.13.0/AzureRM.Backup/Remove-AzureRmBackupVault.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AzureBackup.dll-Help.xml -Module Name: AzureRM.Backup -ms.assetid: 698DCD00-13C0-4C36-A74B-35215D608339 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.backup/remove-azurermbackupvault -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Remove-AzureRmBackupVault.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Remove-AzureRmBackupVault.md ---- - -# Remove-AzureRmBackupVault - -## SYNOPSIS -Deletes a Backup vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmBackupVault [-Force] [-Vault] [-DefaultProfile ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AzureRmBackupVault** cmdlet deletes an Azure Backup vault. -Before you can delete a Backup vault, it must be empty. -Use the **Remove-AzureRmBackupContainer** cmdlet to remove infrastructure as a service (IaaS) virtual machine backup data from the vault. -Use the **Delete-RegisteredServer** cmdlet to remove other registered servers and backup data. - -## EXAMPLES - -### Example 1: Delete an Azure Backup vault -``` -PS C:\>Get-AzureRmBackupVault -Name "Vault03" | Remove-AzureRmBackupVault -``` - -This command gets the Azure Backup vault named Vault03 by using the **Get-AzureRmBackupVault** cmdlet. -The command passes that vault to the current cmdlet by using the pipeline operator. -The current cmdlet removes the vault. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Vault -Specifies a Backup vault that this cmdlet removes. -To obtain an **AzureRmBackupVault**, use the Get-AzureRmBackupVault cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupVault -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupVault -Parameters: Vault (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES -* None - -## RELATED LINKS - -[Get-AzureRmBackupVault](./Get-AzureRmBackupVault.md) - -[New-AzureRmBackupVault](./New-AzureRmBackupVault.md) - -[Set-AzureRmBackupVault](./Set-AzureRmBackupVault.md) - - diff --git a/azurermps-6.13.0/AzureRM.Backup/Restore-AzureRmBackupItem.md b/azurermps-6.13.0/AzureRM.Backup/Restore-AzureRmBackupItem.md deleted file mode 100644 index 6792a39a29..0000000000 --- a/azurermps-6.13.0/AzureRM.Backup/Restore-AzureRmBackupItem.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AzureBackup.dll-Help.xml -Module Name: AzureRM.Backup -ms.assetid: 856B76FC-88ED-4A29-9DC6-C482398D702E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.backup/restore-azurermbackupitem -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Restore-AzureRmBackupItem.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Restore-AzureRmBackupItem.md ---- - -# Restore-AzureRmBackupItem - -## SYNOPSIS -Restores the data and configuration for a Backup item to a recovery point. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Restore-AzureRmBackupItem [-StorageAccountName] [-RecoveryPoint] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Restore-AzureRmBackupItem** cmdlet restores the data and configuration for an Azure Backup item to a specified recovery point. -This cmdlet starts the restore from the Backup vault to your account. -The restore operation does not restore the full virtual machine. -It restores the disk data and configuration information. -After the restore operation finished, you must create the virtual machine and start it. - -## EXAMPLES - -### Example 1: Restore a virtual machine to a recovery point -``` -PS C:\>$Vault = Get-AzureRmBackupVault -Name "Vault03" -PS C:\> $Container = Get-AzureRmBackupContainer -Vault $Vault -Type AzureVM -Name "DPMSERVER.CONTOSO.COM" -PS C:\> $BackupItem = Get-AzureRmBackupItem -Container $Container -PS C:\> $RecoveryPoint = Get-AzureRmBackupRecoveryPoint -Item $BackupItem -PS C:\> Restore-AzureRmBackupItem -StorageAccountName "DestinationAccount" -RecoveryPoint $RecoveryPoint -WorkloadName Operation Status StartTime EndTime ------------- --------- ------ --------- ------- -co03-vm Restore InProgress 26-Aug-15 1:14:01 PM 01-Jan-01 12:00:00 AM -``` - -The first command gets the vault named Vault03 by using the Get-AzureRmBackupVault cmdlet. -The command stores that object in the $Vault variable. -The second command gets a container that has the specified name in the vault in $Vault by using the **Get-AzureRmBackupContainer** cmdlet. -The command stores that object in the $Container variable. -The third command gets the backup item in the container in $Container by using the **Get-AzureRmBackupItem** cmdlet. -The command stores that object in the $BackupItem variable. -The fourth command gets recovery point for the item in $BackupItem. -The command stores that object in the $RecoveryPoint variable. -The final command restores the recovery point in $RecoveryPoint for the account named DestinationAccount. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryPoint -Specifies the recovery point to which to restore the virtual machine. -To obtain an **AzureRmBackupRecoveryPoint**, use the Get-AzureRmBackupRecoveryPoint cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupRecoveryPoint -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -StorageAccountName -Specifies the name of the target storage account in your subscription. -As a part of the restore process, this cmdlet stores the disks and the configuration information in this storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupRecoveryPoint -Parameters: RecoveryPoint (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupJob - -## NOTES - -## RELATED LINKS - -[Backup-AzureRmBackupItem](./Backup-AzureRmBackupItem.md) - -[Get-AzureRmBackupItem](./Get-AzureRmBackupItem.md) - -[Get-AzureRmBackupRecoveryPoint](./Get-AzureRmBackupRecoveryPoint.md) - - diff --git a/azurermps-6.13.0/AzureRM.Backup/Set-AzureRmBackupProtectionPolicy.md b/azurermps-6.13.0/AzureRM.Backup/Set-AzureRmBackupProtectionPolicy.md deleted file mode 100644 index 0010133494..0000000000 --- a/azurermps-6.13.0/AzureRM.Backup/Set-AzureRmBackupProtectionPolicy.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AzureBackup.dll-Help.xml -Module Name: AzureRM.Backup -ms.assetid: 3BF6DB10-6020-4324-A177-F07BB52AF040 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.backup/set-azurermbackupprotectionpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Set-AzureRmBackupProtectionPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Set-AzureRmBackupProtectionPolicy.md ---- - -# Set-AzureRmBackupProtectionPolicy - -## SYNOPSIS -Modifies an existing protection policy. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NoScheduleParamSet (Default) -``` -Set-AzureRmBackupProtectionPolicy [[-NewName] ] [[-BackupTime] ] - [[-RetentionPolicy] ] [-ProtectionPolicy] - [-DefaultProfile ] [] -``` - -### DailyScheduleParamSet -``` -Set-AzureRmBackupProtectionPolicy [[-NewName] ] [-Daily] [[-BackupTime] ] - [[-RetentionPolicy] ] [-ProtectionPolicy] - [-DefaultProfile ] [] -``` - -### WeeklyScheduleParamSet -``` -Set-AzureRmBackupProtectionPolicy [[-NewName] ] [-Weekly] [[-BackupTime] ] - [[-RetentionPolicy] ] [[-DaysOfWeek] ] - [-ProtectionPolicy] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Set-AzureRmBackupProtectionPolicy** cmdlet modifies an existing protection policy in Azure Backup. -You can modify the following protection policy components: -- Name -- Backup schedule -- Retention policies -Any change might affect the backup and retention of the items associated with the policy. - -## EXAMPLES - -## PARAMETERS - -### -BackupTime -Specifies the new backup time of day, as a **DateTime** object, for the policy. -To obtain a **DateTime** object, use the Get-Date cmdlet. -For information about **DateTime** objects, type `Get-Help Get-Date`. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Daily -Indicates that the backup operation runs on a Daily schedule. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: DailyScheduleParamSet -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DaysOfWeek -Specifies an array of days of the week. -This policy runs backups on the days specified by this parameter. -The acceptable values for this parameter are: -- Monday -- Tuesday -- Wednesday -- Thursday -- Friday -- Saturday -- Sunday - -```yaml -Type: System.String[] -Parameter Sets: WeeklyScheduleParamSet -Aliases: -Accepted values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewName -Specifies the new name for the policy. -This name must be unique in a vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtectionPolicy -Specifies protection policy that this cmdlet modifies. -To obtain an **AzureRmBackupProtectionPolicy** object, use the Get-AzureRmBackupProtectionPolicy cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupProtectionPolicy -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RetentionPolicy -Specifies an array of retention policies for the backup policy. -To obtain **AzureRmBackupRetentionPolicy** objects, use the New-AzureRmBackupRetentionPolicyObject cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupRetentionPolicy[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Weekly -Indicates that the backup operation runs on a Weekly schedule. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: WeeklyScheduleParamSet -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupProtectionPolicy -Parameters: ProtectionPolicy (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupJob - -## NOTES - -## RELATED LINKS - -[New-AzureRmBackupProtectionPolicy](./New-AzureRmBackupProtectionPolicy.md) - - diff --git a/azurermps-6.13.0/AzureRM.Backup/Set-AzureRmBackupVault.md b/azurermps-6.13.0/AzureRM.Backup/Set-AzureRmBackupVault.md deleted file mode 100644 index 43da68c2b4..0000000000 --- a/azurermps-6.13.0/AzureRM.Backup/Set-AzureRmBackupVault.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AzureBackup.dll-Help.xml -Module Name: AzureRM.Backup -ms.assetid: D57C32D1-EB4F-495E-A11B-3B4066E8C552 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.backup/set-azurermbackupvault -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Set-AzureRmBackupVault.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Set-AzureRmBackupVault.md ---- - -# Set-AzureRmBackupVault - -## SYNOPSIS -Changes the storage type of a Backup vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmBackupVault [[-Storage] ] [-Vault] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Set-AzureRmBackupVault** cmdlet changes the storage type of an Azure Backup vault. -You cannot modify other properties of a vault. - -## EXAMPLES - -### Example 1: Change the storage for an existing vault -``` -PS C:\>Get-AzureRmBackupVault -Name "Vault03" | Set-AzureRmBackupVault -Storage LocallyRedundant -``` - -This command gets the Azure Backup vault named Vault03 by using the **Get-AzureRmBackupVault** cmdlet. -The command passes that vault to the current cmdlet by using the pipeline operator. -The current cmdlet changes the storage type to LocallyRedundant. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Storage -Specifies the storage type for the backup data. -The acceptable values for this parameter are: LocallyRedundant and GeoRedundant. - -```yaml -Type: Microsoft.Azure.Commands.AzureBackup.Models.AzureBackupVaultStorageType -Parameter Sets: (All) -Aliases: -Accepted values: GeoRedundant, LocallyRedundant - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Vault -Specifies a Backup vault that this cmdlet modifies. -To obtain an **AzureRmBackupVault** object, use the Get-AzureRmBackupVault cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupVault -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupVault -Parameters: Vault (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupVault - -## NOTES -* When you register the first server or virtual machine for a vault, the storage type is locked. Subsequently, you cannot change the storage type. - -## RELATED LINKS - -[Get-AzureRmBackupVault](./Get-AzureRmBackupVault.md) - -[New-AzureRmBackupVault](./New-AzureRmBackupVault.md) - -[Remove-AzureRmBackupVault](./Remove-AzureRmBackupVault.md) - - diff --git a/azurermps-6.13.0/AzureRM.Backup/Stop-AzureRmBackupJob.md b/azurermps-6.13.0/AzureRM.Backup/Stop-AzureRmBackupJob.md deleted file mode 100644 index 2f0aa40557..0000000000 --- a/azurermps-6.13.0/AzureRM.Backup/Stop-AzureRmBackupJob.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AzureBackup.dll-Help.xml -Module Name: AzureRM.Backup -ms.assetid: 44C5AF58-ADC1-4BC6-9771-3FD8F0480106 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.backup/stop-azurermbackupjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Stop-AzureRmBackupJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Stop-AzureRmBackupJob.md ---- - -# Stop-AzureRmBackupJob - -## SYNOPSIS -Cancels an existing Backup job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### IdFiltersSet -``` -Stop-AzureRmBackupJob -Vault -JobID [-DefaultProfile ] - [] -``` - -### JobFiltersSet -``` -Stop-AzureRmBackupJob -Job [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Stop-AzureRmBackupJob** cmdlet cancels an existing Azure Backup job. -Use this parameter to stop a job that takes too long and blocks other activities. -You can cancel only the following types of jobs: -- Backup -- Restore - -## EXAMPLES - -### Example 1: Stop a backup job by using a job ID -``` -PS C:\>$Vault = Get-AzureRmBackupVault -Name "Vault03" -PS C:\> $Job = Get-AzureRmBackupJob -Vault $Vault -Operation Backup -PS C:\> Stop-AzureRmBackupJob -Vault $Vault -JobID $Job.InstanceId -``` - -The first command gets the vault named Vault03 by using the **Get-AzureRmBackupVault** cmdlet. -The command stores that object in the $Vault variable. -The second command gets a backup job from the vault in $Vault by using the **Get-AzureRmBackupJob** cmdlet. -The command stores the job in the $Job variable. -In this example, there is only one backup operation in the specified vault. -The final command stops the job that has the specified ID. - -### Example 2: Stop all Restore operations -``` -PS C:\>Get-AzureRmBackupJob -Vault $Vault -Operation Restore | Stop-AzureRmBackupJob -``` - -This command gets all the restore operations in the vault in $Vault, and then passes them to the current cmdlet by using the pipeline operator. -The current cmdlet stops each job. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Job -Specifies a job that this cmdlet cancels. -To obtain an **AzureRmBackupJob** object, use the Get-AzureRmBackupJob cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupJob -Parameter Sets: JobFiltersSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -JobID -Specifies a job that this cmdlet cancels. -To obtain an **AzureRmBackupJob** object, use the Get-AzureRmBackupJob cmdlet. - -```yaml -Type: System.String -Parameter Sets: IdFiltersSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Vault -Specifies the Backup vault in which this cmdlet cancels a job. -To obtain an **AzureRmBackupVault** object, use the Get-AzureRmBackupVault cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupVault -Parameter Sets: IdFiltersSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupJob -Parameters: Job (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBackupJob](./Get-AzureRmBackupJob.md) - -[Get-AzureRmBackupVault](./Get-AzureRmBackupVault.md) - -[Wait-AzureRmBackupJob](./Wait-AzureRmBackupJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.Backup/Unregister-AzureRmBackupContainer.md b/azurermps-6.13.0/AzureRM.Backup/Unregister-AzureRmBackupContainer.md deleted file mode 100644 index 5f6629b497..0000000000 --- a/azurermps-6.13.0/AzureRM.Backup/Unregister-AzureRmBackupContainer.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AzureBackup.dll-Help.xml -Module Name: AzureRM.Backup -ms.assetid: 922BEA08-6619-4D4C-86EC-58279C9E1D93 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.backup/unregister-azurermbackupcontainer -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Unregister-AzureRmBackupContainer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Unregister-AzureRmBackupContainer.md ---- - -# Unregister-AzureRmBackupContainer - -## SYNOPSIS -Unregisters a container from a Backup vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Unregister-AzureRmBackupContainer [-Force] [-Container] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Unregister-AzureRmBackupContainer** cmdlet unregisters the Windows Server or Azure virtual machine from an Azure Backup vault. -This cmdlet removes references to a container from the Backup vault. -Before you can unregister a container, you must delete any protected data associated with that container. - -## EXAMPLES - -### Example 1: Unregister a Windows Server -``` -PS C:\>$Vault = Get-AzureRmBackupVault -Name "Vault03" -PS C:\> $Container = Get-AzureRmBackupContainer -Vault $Vault -Type Windows -Name "server01.contoso.com" -PS C:\> Unregister-AzureRmBackupContainer -Container $Container[0] -Unregister Server -This operation will delete all data in the backup vault that is associated with the server. Are you sure you want to unregister the server? -[] Yes [] No [?] Help (default is "No"): Yes -``` - -The first command gets the vault named Vault03 by using the Get-AzureRmBackupVault cmdlet. -The command stores that object in the $Vault variable. -The second command gets a container that has the specified name in the vault in $Vault by using the Get-AzureRmBackupContainer cmdlet. -The command stores that object in the $Container variable. -The final command unregisters the specified Windows Server from the Azure Backup vault. - -### Example 2: Unregister a Windows Server without confirmation -``` -PS C:\>Unregister-AzureRmBackupContainer -Container $Container[0] -Force -``` - -This command unregisters the specified Windows Server from the Azure Backup vault, just as in the first example. -This command specifies the *Force* parameter. -Therefore, the command does not prompt you for confirmation. - -## PARAMETERS - -### -Container -Specifies the Windows Server or Azure virtual machine that this cmdlet unregisters. -To obtain an **AzureRmBackupContainer**, use the Get-AzureRmBackupContainer cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupContainer -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. -This parameter is relevant only for **AzureBackupContainer** objects of type Windows. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupContainer -Parameters: Container (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupJob - -## NOTES -* None - -## RELATED LINKS - -[Get-AzureRmBackupContainer](./Get-AzureRmBackupContainer.md) - -[Get-AzureRmBackupVault](./Get-AzureRmBackupVault.md) - -[Register-AzureRmBackupContainer](./Register-AzureRmBackupContainer.md) - - diff --git a/azurermps-6.13.0/AzureRM.Backup/Wait-AzureRmBackupJob.md b/azurermps-6.13.0/AzureRM.Backup/Wait-AzureRmBackupJob.md deleted file mode 100644 index 07435e3241..0000000000 --- a/azurermps-6.13.0/AzureRM.Backup/Wait-AzureRmBackupJob.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.AzureBackup.dll-Help.xml -Module Name: AzureRM.Backup -ms.assetid: C5126E20-0A93-4ACE-8297-F1E8E17BEF53 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.backup/wait-azurermbackupjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Wait-AzureRmBackupJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBackup/Commands.AzureBackup/help/Wait-AzureRmBackupJob.md ---- - -# Wait-AzureRmBackupJob - -## SYNOPSIS -Waits for a Backup job to finish. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Wait-AzureRmBackupJob -Job [-TimeOut ] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Wait-AzureRmBackupJob** cmdlet waits for an Azure Backup job to finish. -Backup jobs can take a long time. -If you run a backup job as part of a script, you may want to force the script to wait for job to finish before it continues to other tasks. -A script that includes this cmdlet can be simpler than one that polls the Backup service for the job status. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Job -Specifies a job that this cmdlet cancels. -To obtain an **AzureRmBackupJob** object, use the Get-AzureRmBackupJob cmdlet. - -```yaml -Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TimeOut -Specifies the maximum time, in seconds, that this cmdlet waits for the job to finish. -We recommend that you specify a time-out value. - -```yaml -Type: System.Nullable`1[System.Int64] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Object -Parameters: Job (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupJob - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBackupJob](./Get-AzureRmBackupJob.md) - -[Stop-AzureRmBackupJob](./Stop-AzureRmBackupJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.Batch/AzureRM.Batch.md b/azurermps-6.13.0/AzureRM.Batch/AzureRM.Batch.md deleted file mode 100644 index 1f35f1caee..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/AzureRM.Batch.md +++ /dev/null @@ -1,228 +0,0 @@ ---- -Module Name: AzureRM.Batch -Module Guid: a8f00f40-1c1a-49b5-9db3-24076b75c3cf -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch -Help Version: 4.0.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/AzureRM.Batch.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/AzureRM.Batch.md ---- - -# AzureRM.Batch Module -## Description -The Azure Batch cmdlets in the Azure module enable you to manage Microsoft Azure Batch services in Azure PowerShell. - -## AzureRM.Batch Cmdlets -### [Disable-AzureBatchAutoScale](Disable-AzureBatchAutoScale.md) -Disables automatic scaling of a pool. - -### [Disable-AzureBatchComputeNodeScheduling](Disable-AzureBatchComputeNodeScheduling.md) -Disables task scheduling on the specified compute node. - -### [Disable-AzureBatchJob](Disable-AzureBatchJob.md) -Disables a Batch job. - -### [Disable-AzureBatchJobSchedule](Disable-AzureBatchJobSchedule.md) -Disables a Batch job schedule. - -### [Enable-AzureBatchAutoScale](Enable-AzureBatchAutoScale.md) -Enables automatic scaling of a pool. - -### [Enable-AzureBatchComputeNodeScheduling](Enable-AzureBatchComputeNodeScheduling.md) -Enables task scheduling on the specified compute node. - -### [Enable-AzureBatchJob](Enable-AzureBatchJob.md) -Enables a Batch job. - -### [Enable-AzureBatchJobSchedule](Enable-AzureBatchJobSchedule.md) -Enables a Batch job schedule. - -### [Enable-AzureBatchTask](Enable-AzureBatchTask.md) -Reactivates a task. - -### [Get-AzureBatchCertificate](Get-AzureBatchCertificate.md) -Gets the certificates in a Batch account. - -### [Get-AzureBatchComputeNode](Get-AzureBatchComputeNode.md) -Gets Batch compute nodes from a pool. - -### [Get-AzureBatchJob](Get-AzureBatchJob.md) -Gets Batch jobs for a Batch account or job schedule. - -### [Get-AzureBatchJobPreparationAndReleaseTaskStatus](Get-AzureBatchJobPreparationAndReleaseTaskStatus.md) -Gets Batch job preparation and release task status. - -### [Get-AzureBatchJobSchedule](Get-AzureBatchJobSchedule.md) -Gets Batch job schedules. - -### [Get-AzureBatchJobStatistics](Get-AzureBatchJobStatistics.md) -Gets job summary statistics for a Batch account. - -### [Get-AzureBatchNodeAgentSku](Get-AzureBatchNodeAgentSku.md) -Gets Batch node agent SKUs available in a Batch account. - -### [Get-AzureBatchNodeFile](Get-AzureBatchNodeFile.md) -Gets the properties of Batch node files. - -### [Get-AzureBatchNodeFileContent](Get-AzureBatchNodeFileContent.md) -Gets a Batch node file. - -### [Get-AzureBatchPool](Get-AzureBatchPool.md) -Gets Batch pools under the specified Batch account. - -### [Get-AzureBatchPoolNodeCounts](Get-AzureBatchPoolNodeCounts.md) -Gets Batch node counts per node state grouped by pool id. - -### [Get-AzureBatchPoolStatistics](Get-AzureBatchPoolStatistics.md) -Gets pool summary statistics for a Batch account. - -### [Get-AzureBatchPoolUsageMetrics](Get-AzureBatchPoolUsageMetrics.md) -Gets pool usage metrics for a Batch account. - -### [Get-AzureBatchRemoteDesktopProtocolFile](Get-AzureBatchRemoteDesktopProtocolFile.md) -Gets an RDP file from a compute node. - -### [Get-AzureBatchRemoteLoginSettings](Get-AzureBatchRemoteLoginSettings.md) -Gets remote logon settings for a compute node. - -### [Get-AzureBatchSubtask](Get-AzureBatchSubtask.md) -Gets the subtask information of the specified task. - -### [Get-AzureBatchTask](Get-AzureBatchTask.md) -Gets the Batch tasks for a job. - -### [Get-AzureBatchTaskCounts](Get-AzureBatchTaskCounts.md) -Gets the task counts for the specified job. - -### [Get-AzureRmBatchAccount](Get-AzureRmBatchAccount.md) -Gets a Batch account in the current subscription. - -### [Get-AzureRmBatchAccountKeys](Get-AzureRmBatchAccountKeys.md) -Gets the keys of a Batch account. - -### [Get-AzureRmBatchApplication](Get-AzureRmBatchApplication.md) -Gets information about the specified application. - -### [Get-AzureRmBatchApplicationPackage](Get-AzureRmBatchApplicationPackage.md) -Gets information about an application package in a Batch account. - -### [Get-AzureRmBatchLocationQuotas](Get-AzureRmBatchLocationQuotas.md) -Gets the Batch service quotas for your subscription at the given location. - -### [New-AzureBatchCertificate](New-AzureBatchCertificate.md) -Adds a certificate to the specified Batch account. - -### [New-AzureBatchComputeNodeUser](New-AzureBatchComputeNodeUser.md) -Creates a user account on a Batch compute node. - -### [New-AzureBatchJob](New-AzureBatchJob.md) -Creates a job in the Batch service. - -### [New-AzureBatchJobSchedule](New-AzureBatchJobSchedule.md) -Creates a job schedule in the Batch service. - -### [New-AzureBatchPool](New-AzureBatchPool.md) -Creates a pool in the Batch service. - -### [New-AzureBatchTask](New-AzureBatchTask.md) -Creates a Batch task under a job. - -### [New-AzureRmBatchAccount](New-AzureRmBatchAccount.md) -Creates a Batch account. - -### [New-AzureRmBatchAccountKey](New-AzureRmBatchAccountKey.md) -Regenerates a key of a Batch account. - -### [New-AzureRmBatchApplication](New-AzureRmBatchApplication.md) -Adds an application to the specified Batch account. - -### [New-AzureRmBatchApplicationPackage](New-AzureRmBatchApplicationPackage.md) -Creates an application package in a Batch account. - -### [Remove-AzureBatchCertificate](Remove-AzureBatchCertificate.md) -Deletes a certificate from an account. - -### [Remove-AzureBatchComputeNode](Remove-AzureBatchComputeNode.md) -Removes compute nodes from a pool. - -### [Remove-AzureBatchComputeNodeUser](Remove-AzureBatchComputeNodeUser.md) -Deletes a user account from a Batch compute node. - -### [Remove-AzureBatchJob](Remove-AzureBatchJob.md) -Deletes a Batch job. - -### [Remove-AzureBatchJobSchedule](Remove-AzureBatchJobSchedule.md) -Removes a Batch job schedule. - -### [Remove-AzureBatchNodeFile](Remove-AzureBatchNodeFile.md) -Deletes a node file for a task or compute node. - -### [Remove-AzureBatchPool](Remove-AzureBatchPool.md) -Deletes the specified Batch pool. - -### [Remove-AzureBatchTask](Remove-AzureBatchTask.md) -Deletes a Batch task. - -### [Remove-AzureRmBatchAccount](Remove-AzureRmBatchAccount.md) -Removes a Batch account. - -### [Remove-AzureRmBatchApplication](Remove-AzureRmBatchApplication.md) -Deletes an application from a Batch account. - -### [Remove-AzureRmBatchApplicationPackage](Remove-AzureRmBatchApplicationPackage.md) -Deletes an application package record and the binary file. - -### [Reset-AzureBatchComputeNode](Reset-AzureBatchComputeNode.md) -Reinstalls the operating system on the specified compute node. - -### [Restart-AzureBatchComputeNode](Restart-AzureBatchComputeNode.md) -Reboots the specified compute node. - -### [Set-AzureBatchComputeNodeUser](Set-AzureBatchComputeNodeUser.md) -Modifies properties of an account on a Batch compute node. - -### [Set-AzureBatchJob](Set-AzureBatchJob.md) -Updates a Batch job. - -### [Set-AzureBatchJobSchedule](Set-AzureBatchJobSchedule.md) -Sets a job schedule. - -### [Set-AzureBatchPool](Set-AzureBatchPool.md) -Updates the properties of a pool. - -### [Set-AzureBatchPoolOSVersion](Set-AzureBatchPoolOSVersion.md) -Changes the operating system version of the specified pool. - -### [Set-AzureBatchTask](Set-AzureBatchTask.md) -Updates the properties of a task. - -### [Set-AzureRmBatchAccount](Set-AzureRmBatchAccount.md) -Updates a Batch account. - -### [Set-AzureRmBatchApplication](Set-AzureRmBatchApplication.md) -Updates settings for the specified application. - -### [Start-AzureBatchComputeNodeServiceLogUpload](Start-AzureBatchComputeNodeServiceLogUpload.md) -Upload compute node service log files to an Azure Storage container. - -### [Start-AzureBatchPoolResize](Start-AzureBatchPoolResize.md) -Starts to resize a pool. - -### [Stop-AzureBatchCertificateDeletion](Stop-AzureBatchCertificateDeletion.md) -Cancels a failed deletion of a certificate. - -### [Stop-AzureBatchJob](Stop-AzureBatchJob.md) -Stops a Batch job. - -### [Stop-AzureBatchJobSchedule](Stop-AzureBatchJobSchedule.md) -Stops a Batch job schedule. - -### [Stop-AzureBatchPoolResize](Stop-AzureBatchPoolResize.md) -Stops a pool resize operation. - -### [Stop-AzureBatchTask](Stop-AzureBatchTask.md) -Stops a Batch task. - -### [Test-AzureBatchAutoScale](Test-AzureBatchAutoScale.md) -Gets the result of an automatic scaling formula on a pool. - diff --git a/azurermps-6.13.0/AzureRM.Batch/Disable-AzureBatchAutoScale.md b/azurermps-6.13.0/AzureRM.Batch/Disable-AzureBatchAutoScale.md deleted file mode 100644 index c0d4269d51..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Disable-AzureBatchAutoScale.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 9C755BE8-0624-4CF7-AE7C-34DAF44678E8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/disable-azurebatchautoscale -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchAutoScale.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchAutoScale.md ---- - -# Disable-AzureBatchAutoScale - -## SYNOPSIS -Disables automatic scaling of a pool. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Disable-AzureBatchAutoScale [-Id] -BatchContext - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Disable-AzureBatchAutoScale** cmdlet disables automatic scaling of the specified pool. - -## EXAMPLES - -### Example 1: Disable automatic scaling of a pool -``` -PS C:\>Disable-AzureBatchAutoScale -Id "MyPool" -BatchContext $Context -``` - -This command disables automatic scaling for the pool named MyPool. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the object ID of the pool. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Enable-AzureBatchAutoScale](./Enable-AzureBatchAutoScale.md) - -[Test-AzureBatchAutoScale](./Test-AzureBatchAutoScale.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Disable-AzureBatchComputeNodeScheduling.md b/azurermps-6.13.0/AzureRM.Batch/Disable-AzureBatchComputeNodeScheduling.md deleted file mode 100644 index f53a29335b..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Disable-AzureBatchComputeNodeScheduling.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 2DF5FB4D-A5CB-439C-AC6F-DF2130AF33EC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/disable-azurebatchcomputenodescheduling -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchComputeNodeScheduling.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchComputeNodeScheduling.md ---- - -# Disable-AzureBatchComputeNodeScheduling - -## SYNOPSIS -Disables task scheduling on the specified compute node. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Id (Default) -``` -Disable-AzureBatchComputeNodeScheduling [-PoolId] [-Id] - [-DisableSchedulingOption ] -BatchContext - [-DefaultProfile ] [] -``` - -### InputObject -``` -Disable-AzureBatchComputeNodeScheduling [[-ComputeNode] ] - [-DisableSchedulingOption ] -BatchContext - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Disable-AzureBatchComputeNodeScheduling** cmdlet disables task scheduling on the specified compute node. -A compute node is an Azure virtual machine dedicated to a specific application workload. -When you disable task scheduling on a compute node you will also have the option of determining what to do about jobs currently in the node's task queue. -**Disable-AzureBatchComputeNodeScheduling** lets you do the following: -- Terminate the tasks and put them back in the job queue. -This enables those tasks to be rescheduled on another compute node. -- Terminate the tasks and remove them from the job queue. -Tasks stopped in this manner will not be rescheduled. -- Wait for all the tasks currently being executed to complete and then disable task scheduling on the compute node. -- Wait for all the running tasks to complete and all the data retention periods to expire, and then disable task scheduling on the compute node. - -## EXAMPLES - -### Example 1: Disable task scheduling on a compute node -``` -PS C:\>$Context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount" -PS C:\> Disable-AzureBatchComputeNodeScheduling -PoolId "myPool" -Id "tvm-1783593343_34-20151117t222514z" -BatchContext $Context -``` - -These commands disable task schedule on the compute node tvm-1783593343_34-20151117t222514z. -To do this, the first command in the example creates an object reference to the account keys for the batch account contosobatchaccount. -This object reference is stored in a variable named $context. -The second command then uses this object reference and the **Disable-AzureBatchComputeNodeScheduling** cmdlet to connect to the pool myPool and disable task scheduling on node tvm-1783593343_34-20151117t222514z. -Because the *DisableComputeNodeSchedulingOptions* parameter was not included any tasks currently running on the compute node will be requeued. - -### Example 2: Disable task scheduling on all compute nodes in a pool -``` -PS C:\>$Context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount" -PS C:\> Get-AzureBatchComputeNode -PoolId "Pool06" -BatchContext $Context | Disable-AzureBatchComputeNodeScheduling -BatchContext $Context -``` - -These commands disable task scheduling on all the computer nodes in the batch pool Pool06. -To perform this task, the first command in the example creates an object reference to the account keys for the batch account contosobatchaccount. -This object reference is stored in a variable named $context. -The second command in the example then uses this object reference and **Get-AzureBatchComputeNode** to return a collection of all the compute nodes found in Pool06. -That collection is then piped to then **Disable-AzureBatchComputeNodeScheduling** cmdlet to disable task scheduling on each compute node in the collection. -Because the *DisableComputeNodeSchedulingOptions* parameter was not included any tasks currently running on the compute nodes will be requeued. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ComputeNode -Specifies an object reference to the compute node where task scheduling is disabled. -This object reference is created by using the Get-AzureBatchComputeNode cmdlet and storing the returned compute node object in a variable. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSComputeNode -Parameter Sets: InputObject -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableSchedulingOption -Specifies how this cmdlet deals with any tasks currently running on the computer node where scheduling is being disabled. -The acceptable values for this parameter are: -- Requeue. -Tasks are stopped immediately and returned to the job queue. -This enables the tasks to be rescheduled on another compute node. -This is the default value. -- Terminate. -Tasks are stopped immediately and removed from the job queue. -These tasks will not be rescheduled. -- TaskCompletion. -Currently running tasks will be able to complete before task scheduling is disabled on the compute node. -No new tasks will be scheduled on this node. -- RetainedData. -Currently running tasks will be able to complete and data retention periods will be able to expire before task scheduling is disabled on the compute node. -No new tasks will be scheduled on this node. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Batch.Common.DisableComputeNodeSchedulingOption] -Parameter Sets: (All) -Aliases: -Accepted values: Requeue, Terminate, TaskCompletion - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the compute node where task scheduling is disabled. - -```yaml -Type: System.String -Parameter Sets: Id -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PoolId -Specifies the ID of the batch pool that contains the compute node where task scheduling is disabled. -If you use the *PoolId* parameter, do not use the *ComputeNode* parameter in that same command. - -```yaml -Type: System.String -Parameter Sets: Id -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSComputeNode -Parameters: ComputeNode (ByValue) - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[Enable-AzureBatchComputeNodeScheduling](./Enable-AzureBatchComputeNodeScheduling.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Disable-AzureBatchJob.md b/azurermps-6.13.0/AzureRM.Batch/Disable-AzureBatchJob.md deleted file mode 100644 index 25b30feb80..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Disable-AzureBatchJob.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: C831F934-7513-4882-A155-816E56CD9807 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/disable-azurebatchjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchJob.md ---- - -# Disable-AzureBatchJob - -## SYNOPSIS -Disables a Batch job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Disable-AzureBatchJob [-Id] [-DisableJobOption] -BatchContext - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Disable-AzureBatchJob** cmdlet disables an Azure Batch job. -After you enable a job, new tasks can run. -Disabled jobs do not run new tasks. -You can enable a disabled job later. - -## EXAMPLES - -### Example 1: Disable a Batch job -``` -PS C:\>Disable-AzureBatchJob -Id "Job-000001" -DisableJobOption "Terminate" -BatchContext $Context -``` - -This command disables the job that has the ID Job-000001. -The command terminates active tasks for the job. -Use the **Get-AzureRmBatchAccountKeys** cmdlet to assign a context to the $Context variable. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableJobOption -Specifies what to do with active tasks associated with the job that this cmdlet disables. -Valid values are: -- Requeue -- Terminate -- Wait - -```yaml -Type: Microsoft.Azure.Batch.Common.DisableJobOption -Parameter Sets: (All) -Aliases: -Accepted values: Requeue, Terminate, Wait - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the job that this cmdlet disables. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Enable-AzureBatchJob](./Enable-AzureBatchJob.md) - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[Get-AzureBatchJob](./Get-AzureBatchJob.md) - -[New-AzureBatchJob](./New-AzureBatchJob.md) - -[Remove-AzureBatchJob](./Remove-AzureBatchJob.md) - -[Stop-AzureBatchJob](./Stop-AzureBatchJob.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Disable-AzureBatchJobSchedule.md b/azurermps-6.13.0/AzureRM.Batch/Disable-AzureBatchJobSchedule.md deleted file mode 100644 index 2f0b47f95a..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Disable-AzureBatchJobSchedule.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: B4737AE8-F57C-4B95-B81E-74802EF8E7AE -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/disable-azurebatchjobschedule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchJobSchedule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchJobSchedule.md ---- - -# Disable-AzureBatchJobSchedule - -## SYNOPSIS -Disables a Batch job schedule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Disable-AzureBatchJobSchedule [-Id] -BatchContext - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Disable-AzureBatchJobSchedule** cmdlet disables an Azure Batch job schedule. -If you disable a schedule, jobs are not created according to that schedule. -You can enable a disabled schedule later. - -## EXAMPLES - -### Example 1: Disable a job schedule -``` -PS C:\>Disable-AzureBatchJobSchedule -Id "JobSchedule17" -BatchContext $Context -``` - -This command disables the job schedule that has the ID JobSchedule17. -Use the **Get-AzureRmBatchAccountKeys** cmdlet to assign a context to the $Context variable. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the job schedule that this cmdlet disables. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Enable-AzureBatchJobSchedule](./Enable-AzureBatchJobSchedule.md) - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[Get-AzureBatchJobSchedule](./Get-AzureBatchJobSchedule.md) - -[New-AzureBatchJobSchedule](./New-AzureBatchJobSchedule.md) - -[Remove-AzureBatchJobSchedule](./Remove-AzureBatchJobSchedule.md) - -[Stop-AzureBatchJobSchedule](./Stop-AzureBatchJobSchedule.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Enable-AzureBatchAutoScale.md b/azurermps-6.13.0/AzureRM.Batch/Enable-AzureBatchAutoScale.md deleted file mode 100644 index dfb9cf2371..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Enable-AzureBatchAutoScale.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 3107D061-7F25-45D0-8029-C99120A156DA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/enable-azurebatchautoscale -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchAutoScale.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchAutoScale.md ---- - -# Enable-AzureBatchAutoScale - -## SYNOPSIS -Enables automatic scaling of a pool. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Enable-AzureBatchAutoScale [-Id] [[-AutoScaleFormula] ] - [[-AutoScaleEvaluationInterval] ] -BatchContext - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Enable-AzureBatchAutoScale** cmdlet enables automatic scaling of the specified pool. - -## EXAMPLES - -### Example 1: Enable automatic scaling for a pool -``` -PS C:\>$Formula = 'totalNodes=($CPUPercent.GetSamplePercent(TimeInterval_Minute*0,TimeInterval_Minute*10)<0.7?5:(min($CPUPercent.GetSample(TimeInterval_Minute*0, TimeInterval_Minute*10))>0.8?($CurrentDedicated*1.1):$CurrentDedicated));$TargetDedicated=min(100,totalNodes);'; -PS C:\> Enable-AzureBatchAutoScale -Id "MyPool" -AutoScaleFormula $Formula -BatchContext $Context -``` - -The first command defines a formula, and then saves it to the $Formula variable. -The second command enables automatic scaling on the pool named MyPool using the formula in $Formula. - -## PARAMETERS - -### -AutoScaleEvaluationInterval -Specifies the amount of time (in minutes) that elapses before the pool size is automatically adjusted according to the AutoScale formula. -The default value is 15 minutes, and the minimum value is 5 minutes. - -```yaml -Type: System.Nullable`1[System.TimeSpan] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoScaleFormula -Specifies the formula for the desired number of compute nodes in the pool. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the object ID of the pool for which to enable automatic scaling. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Disable-AzureBatchAutoScale](./Disable-AzureBatchAutoScale.md) - -[Test-AzureBatchAutoScale](./Test-AzureBatchAutoScale.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Enable-AzureBatchComputeNodeScheduling.md b/azurermps-6.13.0/AzureRM.Batch/Enable-AzureBatchComputeNodeScheduling.md deleted file mode 100644 index 4fc95ca4c1..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Enable-AzureBatchComputeNodeScheduling.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 36EB9CE6-EAC9-471C-97D6-14E882E0F710 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/enable-azurebatchcomputenodescheduling -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchComputeNodeScheduling.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchComputeNodeScheduling.md ---- - -# Enable-AzureBatchComputeNodeScheduling - -## SYNOPSIS -Enables task scheduling on the specified compute node. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Id (Default) -``` -Enable-AzureBatchComputeNodeScheduling [-PoolId] [-Id] -BatchContext - [-DefaultProfile ] [] -``` - -### InputObject -``` -Enable-AzureBatchComputeNodeScheduling [[-ComputeNode] ] -BatchContext - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Enable-AzureBatchComputeNodeScheduling** cmdlet enables task scheduling on the specified compute node. -A compute node is an Azure virtual machine dedicated to a specific application workload. - -## EXAMPLES - -### Example 1: Enable task scheduling on a compute node -``` -PS C:\>$Context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount" -PS C:\> Enable-AzureBatchComputeNodeScheduling -PoolId "myPool" -Id "tvm-1783593343_34-20151117t222514z" -BatchContext $Context -``` - -These commands enable task scheduling on the compute node tvm-1783593343_34-20151117t222514z. -To do this, the first command in the example creates an object reference containing the account keys for the batch account contosobatchaccount. -This object reference is stored in a variable named $context. -The second command then uses this object reference and the **Enable-AzureBatchComputeNodeScheduling** cmdlet to connect to the pool myPool and enable task scheduling on tvm-1783593343_34-20151117t222514z. - -### Example 2: Enable task scheduling on compute nodes in a pool -``` -PS C:\>$Context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount" -PS C:\> Get-AzureBatchComputeNode -PoolId "Pool06" -BatchContext $Context | Enable-AzureBatchComputeNodeScheduling -BatchContext $Context -``` - -These commands enable task scheduling on all the compute nodes found in the pool Pool06. -To perform this task, the first command in the example creates an object reference containing the account keys for the batch account contosobatchaccount. -This object reference is stored in a variable named $context. -The second command in the example then uses this object reference and **Get-AzureBatchComputeNode** to return a collection of all the compute nodes found in Pool06. -That collection is then piped to the **Enable-AzureBatchComputeNodeScheduling** cmdlet, which enables task scheduling on each compute node in the collection. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ComputeNode -Specifies an object reference to the compute node where task scheduling is enabled. -This object reference is created by using the Get-AzureBatchComputeNode cmdlet and storing the returned compute node object in a variable. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSComputeNode -Parameter Sets: InputObject -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the compute node where task scheduling is enabled. - -```yaml -Type: System.String -Parameter Sets: Id -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PoolId -Specifies the ID of the batch pool that contains the compute node where task scheduling is enabled. - -```yaml -Type: System.String -Parameter Sets: Id -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSComputeNode -Parameters: ComputeNode (ByValue) - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Disable-AzureBatchComputeNodeScheduling](./Disable-AzureBatchComputeNodeScheduling.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Enable-AzureBatchJob.md b/azurermps-6.13.0/AzureRM.Batch/Enable-AzureBatchJob.md deleted file mode 100644 index 8fec929c10..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Enable-AzureBatchJob.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 7C79BFF1-41E1-472D-AF67-1C3B39AB7548 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/enable-azurebatchjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchJob.md ---- - -# Enable-AzureBatchJob - -## SYNOPSIS -Enables a Batch job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Enable-AzureBatchJob [-Id] -BatchContext - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Enable-AzureBatchJob** cmdlet enables an Azure Batch job. -After you enable a job, new tasks can run. - -## EXAMPLES - -### Example 1: Enable a Batch job -``` -PS C:\>Enable-AzureBatchJob -Id "Job-000001" -BatchContext $Context -``` - -This command enables the job that has the ID Job-000001. -Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the job that this cmdlet enables. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Disable-AzureBatchJob](./Disable-AzureBatchJob.md) - -[Get-AzureBatchJob](./Get-AzureBatchJob.md) - -[New-AzureBatchJob](./New-AzureBatchJob.md) - -[Remove-AzureBatchJob](./Remove-AzureBatchJob.md) - -[Stop-AzureBatchJob](./Stop-AzureBatchJob.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Enable-AzureBatchJobSchedule.md b/azurermps-6.13.0/AzureRM.Batch/Enable-AzureBatchJobSchedule.md deleted file mode 100644 index 8ebda60365..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Enable-AzureBatchJobSchedule.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 02F91510-F14F-4401-BC5F-06B0874AEB4B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/enable-azurebatchjobschedule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchJobSchedule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchJobSchedule.md ---- - -# Enable-AzureBatchJobSchedule - -## SYNOPSIS -Enables a Batch job schedule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Enable-AzureBatchJobSchedule [-Id] -BatchContext - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Enable-AzureBatchJobSchedule** cmdlet enables an Azure Batch job schedule. -After you enable a job schedule, jobs can be created according to that schedule. - -## EXAMPLES - -### Example 1: Enable a job schedule -``` -PS C:\>Enable-AzureBatchJobSchedule -Id "JobSchedule17" -BatchContext $Context -``` - -This command enables the job schedule that has the ID JobSchedule17. -Use the **Get-AzureRmBatchAccountKeys** cmdlet to assign a context to the $Context variable. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the job schedule that this cmdlet enables. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Disable-AzureBatchJobSchedule](./Disable-AzureBatchJobSchedule.md) - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[Get-AzureBatchJobSchedule](./Get-AzureBatchJobSchedule.md) - -[New-AzureBatchJobSchedule](./New-AzureBatchJobSchedule.md) - -[Remove-AzureBatchJobSchedule](./Remove-AzureBatchJobSchedule.md) - -[Stop-AzureBatchJobSchedule](./Stop-AzureBatchJobSchedule.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Enable-AzureBatchTask.md b/azurermps-6.13.0/AzureRM.Batch/Enable-AzureBatchTask.md deleted file mode 100644 index d162698b4f..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Enable-AzureBatchTask.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 67FB5D02-4F4B-4119-B3AC-0D205247253E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/enable-azurebatchtask -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchTask.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchTask.md ---- - -# Enable-AzureBatchTask - -## SYNOPSIS -Reactivates a task. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Id -``` -Enable-AzureBatchTask [-JobId] [-Id] -BatchContext - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### InputObject -``` -Enable-AzureBatchTask [-Task] -BatchContext - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Enable-AzureBatchTask** cmdlet reactivates a task. -If a task has exhausted its retry count, this cmdlet nevertheless enables it to run. - -## EXAMPLES - -### Example 1: Reactivate a task -``` -PS C:\>Enable-AzureBatchTask -JobId "Job7" -Id "Task2" -BatchContext $Context -``` - -This command reactivates the task Task2 in job Job7. - -### Example 2: Reactivate a task by using the pipeline -``` -PS C:\>Get-AzureBatchTask -JobId "Job8" -Id "Task3" -BatchContext $Context | Enable-AzureBatchTask -BatchContext $Context -``` - -This command gets the Batch task that has the ID Task3 in the job that has the ID Job8 by using the Get-AzureBatchTask cmdlet. -The command passes that task to the current cmdlet by using the pipeline operator. -The command reactivates that task. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the task to reactivate. - -```yaml -Type: System.String -Parameter Sets: Id -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -JobId -Specifies the ID of the job that contains the task. - -```yaml -Type: System.String -Parameter Sets: Id -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Task -Specifies the task that this cmdlet reactivates. -To obtain a **PSCloudTask** object, use the Get-AzureBatchTask cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSCloudTask -Parameter Sets: InputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.Models.PSCloudTask -Parameters: Task (ByValue) - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[Get-AzureBatchTask](./Get-AzureBatchTask.md) - -[New-AzureBatchTask](./New-AzureBatchTask.md) - -[Remove-AzureBatchTask](./Remove-AzureBatchTask.md) - -[Set-AzureBatchTask](./Set-AzureBatchTask.md) - -[Stop-AzureBatchTask](./Stop-AzureBatchTask.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchCertificate.md b/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchCertificate.md deleted file mode 100644 index a2c998128b..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchCertificate.md +++ /dev/null @@ -1,245 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: A9C98F8F-90F2-4BF4-A234-31966FBB975B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/get-azurebatchcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchCertificate.md ---- - -# Get-AzureBatchCertificate - -## SYNOPSIS -Gets the certificates in a Batch account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ODataFilter (Default) -``` -Get-AzureBatchCertificate [-Filter ] [-MaxCount ] [-Select ] - -BatchContext [-DefaultProfile ] [] -``` - -### Thumbprint -``` -Get-AzureBatchCertificate [-ThumbprintAlgorithm] [-Thumbprint] [-Select ] - -BatchContext [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureBatchCertificate** cmdlet gets the certificates in the Azure Batch account that the *BatchContext* parameter specifies. -To obtain a particular certificate, specify the *ThumbprintAlgorithm* and *Thumbprint* parameters. -Specify the *Filter* parameter to get the certificates that match an Open Data Protocol (OData) filter. - -## EXAMPLES - -### Example 1: Get a certificate by thumbprint -``` -PS C:\>Get-AzureBatchCertificate -ThumbprintAlgorithm "sha1" - Thumbprint "C1E494A415149C5F211C4778B52F2E834A07247C" -BatchContext $Context -Thumbprint : c1e494a415149c5f211c4778b52f2e834a07247c -ThumbprintAlgorithm : sha1 -Url : https://pstests.eastus.batch.azure.com/certificates(thumbprintAlgorithm=sha1,thumbprint=C1E494A415149C5F211C4778B52F2E834A07247 -C) -State : Active -StateTransitionTime : 10/6/2015 6:21:16 PM -PreviousState : -PreviousStateTransitionTime : -Data : -CertificateFormat : -Password : -PublicData : MIIB9DCCAWGgAwIBAgIQpUXhwCuAPJRDhl7kY/0PdTAJBgUrDgMCHQUAMBYxFDASBgNVBAMTC0JhdGNoVGVzdDAxMB4XDTE1MTAwMjE2MjkwNVoXDTM5MTIzMTIzNTk -1OVowFjEUMBIGA1UEAxMLQmF0Y2hUZXN0MDEwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAM06unpRipn3BmHBM75d0s8w/Wwifci16PoJo4c2V68GwsCCFsNOn5 -ypo7BBXo1fpBjrnso5w+koaE5LjxkBSVm+TkogwbKlW6WURTM0O5viRVbPnEEU/Y01Pj5cJElFuLEk9Uoe/r/lP8b5A607t1cPjSXkwhEZEYc3LkHDSo0ZAgMBAAGjS -zBJMEcGA1UdAQRAMD6AEFRsTAsrvF+FmPuICooZXaKhGDAWMRQwEgYDVQQDEwtCYXRjaFRlc3QwMYIQpUXhwCuAPJRDhl7kY/0PdTAJBgUrDgMCHQUAA4GBALt0F8Ep -+8XVE/M2aNtxzlku72gxiOiAo1HmpUaixXx3gl8kdP3xgoKMaq4JskqdLmbJJUnCQ3wmzsdPwjswsW2ycT12zuBddaiS+id98k8U/KYc6FxMgS+H70FYOxARLn7P4FS -SBf/QCyign+BherzezdZ5NBdfzbmWxIMP5iFJ -DeleteCertificateError : -``` - -This command gets a single certificate that has the specified thumbprint. -The certificate thumbprint algorithm is sha1. - -### Example 2: Get filtered certificates -``` -PS C:\>Get-AzureBatchCertificate -Filter "state eq 'active'" -BatchContext $Context -Thumbprint : 025b351b087a084c5067f5e71eff8591970323f9 -ThumbprintAlgorithm : sha1 -Url : https://pstests.eastus.batch.azure.com/certificates(thumbprintAlgorithm=sha1,thumbprint=025b351b087a084c5067f5e71eff8591970323f9) -State : Active -StateTransitionTime : 10/6/2015 6:21:17 PM -PreviousState : -PreviousStateTransitionTime : -Data : -CertificateFormat : -Password : -PublicData : MIIB9DCCAWGgAwIBAgIQy9W5y8iwhppGhtAG06dHKTAJBgUrDgMCHQUAMBYxFDASBgNVBAMTC0JhdGNoVGVzdDAyMB4XDTE1MTAwMjE2MjkxNFoXDTM5MTIzMTIzNTk -1OVowFjEUMBIGA1UEAxMLQmF0Y2hUZXN0MDIwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAJxagvVrlnKfv6hfzSiFJUkdGkPjC3tFiKebK6IaeHzesFdFfupXUE -wT0xOWh9xwa3OVkPECEc/u1sw3iVX/J4AODiwzmOWutoVRpWjxGFpgw9+dPvXMjs/Ue7JL7ag3siHs5EcarW91qKbgtko6i/r4emaRyk60U93TrbWQAWJ9AgMBAAGjS -zBJMEcGA1UdAQRAMD6AEAdqsOpyeXF/uDe7ZGKeez+hGDAWMRQwEgYDVQQDEwtCYXRjaFRlc3QwMoIQy9W5y8iwhppGhtAG06dHKTAJBgUrDgMCHQUAA4GBAC0MaAem -6ByyURFvGnFZyjEepjXC5wcaGq+gguDFe8rG88ceig1ZqewdcmC1y4p05uBhbmETbYVWzJarNsHYq2LTihi4t2J4jt2YVYz/IRdUB82iaFFbJRSPrN+6xD3KM2lve5N -4OjtlZAdiXiSUYFf3I6ypberUsAdba3QQajCN -DeleteCertificateError : - -Thumbprint : c1e494a415149c5f211c4778b52f2e834a07247c -ThumbprintAlgorithm : sha1 -Url : https://pstests.eastus.batch.azure.com/certificates(thumbprintAlgorithm=sha1,thumbprint=c1e494a415149c5f211c4778b52f2e834a07247c) -State : Active -StateTransitionTime : 10/6/2015 6:21:16 PM -PreviousState : -PreviousStateTransitionTime : -Data : -CertificateFormat : -Password : -PublicData : MIIB9DCCAWGgAwIBAgIQpUXhwCuAPJRDhl7kY/0PdTAJBgUrDgMCHQUAMBYxFDASBgNVBAMTC0JhdGNoVGVzdDAxMB4XDTE1MTAwMjE2MjkwNVoXDTM5MTIzMTIzNTk -1OVowFjEUMBIGA1UEAxMLQmF0Y2hUZXN0MDEwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAM06unpRipn3BmHBM75d0s8w/Wwifci16PoJo4c2V68GwsCCFsNOn5 -ypo7BBXo1fpBjrnso5w+koaE5LjxkBSVm+TkogwbKlW6WURTM0O5viRVbPnEEU/Y01Pj5cJElFuLEk9Uoe/r/lP8b5A607t1cPjSXkwhEZEYc3LkHDSo0ZAgMBAAGjS -zBJMEcGA1UdAQRAMD6AEFRsTAsrvF+FmPuICooZXaKhGDAWMRQwEgYDVQQDEwtCYXRjaFRlc3QwMYIQpUXhwCuAPJRDhl7kY/0PdTAJBgUrDgMCHQUAA4GBALt0F8Ep -+8XVE/M2aNtxzlku72gxiOiAo1HmpUaixXx3gl8kdP3xgoKMaq4JskqdLmbJJUnCQ3wmzsdPwjswsW2ycT12zuBddaiS+id98k8U/KYc6FxMgS+H70FYOxARLn7P4FS -SBf/QCyign+BherzezdZ5NBdfzbmWxIMP5iFJ -DeleteCertificateError : -``` - -This command gets all certificates in the active state from the Batch account. -The *Filter* parameter specifies the state. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies an OData filter clause. -If you specify this parameter, this cmdlet gets the certificates that match the filter. - -```yaml -Type: System.String -Parameter Sets: ODataFilter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxCount -Specifies the maximum number of certificates to return. -If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. -The default value is 1000. - -```yaml -Type: System.Int32 -Parameter Sets: ODataFilter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Select -Specifies an OData select clause. -Specify a value for this parameter to get specific properties rather than all object properties. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Thumbprint -Specifies the thumbprint of the certificate that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: Thumbprint -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThumbprintAlgorithm -Specifies the algorithm used to derive the *Thumbprint* parameter. -Currently, the only valid value is sha1. - -```yaml -Type: System.String -Parameter Sets: Thumbprint -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSCertificate - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[New-AzureBatchCertificate](./New-AzureBatchCertificate.md) - -[Remove-AzureBatchCertificate](./Remove-AzureBatchCertificate.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchComputeNode.md b/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchComputeNode.md deleted file mode 100644 index 7dd98f9727..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchComputeNode.md +++ /dev/null @@ -1,313 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 93614655-A8F2-4A67-887D-43D41AB91F82 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/get-azurebatchcomputenode -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchComputeNode.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchComputeNode.md ---- - -# Get-AzureBatchComputeNode - -## SYNOPSIS -Gets Batch compute nodes from a pool. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ODataFilter (Default) -``` -Get-AzureBatchComputeNode [-PoolId] [-Filter ] [-MaxCount ] [-Select ] - -BatchContext [-DefaultProfile ] [] -``` - -### Id -``` -Get-AzureBatchComputeNode [-PoolId] [[-Id] ] [-Select ] - -BatchContext [-DefaultProfile ] [] -``` - -### ParentObject -``` -Get-AzureBatchComputeNode [[-Pool] ] [-Filter ] [-MaxCount ] [-Select ] - -BatchContext [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureBatchComputeNode** cmdlet gets Azure Batch compute nodes from a pool. -Specify either the *PoolID* or *Pool* parameter. -Specify the *Id* parameter to get a single compute node. -Specify the *Filter* parameter to get the compute nodes that match an Open Data Protocol (OData) filter. - -## EXAMPLES - -### Example 1: Get a compute node by ID -``` -PS C:\>Get-AzureBatchComputeNode -PoolId "Pool06" -Id "tvm-2316545714_1-20150725t213220z" -BatchContext $Context -Id : tvm-2316545714_1-20150725t213220z -Url : https://cmdletexample.westus.batch.azure.com/pools/MyPool/nodes/tvm-2316545714_1-20150725t213220z -State : Idle -StateTransitionTime : 7/25/2015 9:36:53 PM -LastBootTime : 7/25/2015 9:36:53 PM -AllocationTime : 7/25/2015 9:32:20 PM -IPAddress : 10.14.121.1 -AffinityId : TVM:tvm-2316545714_1-20150725t213220z -VirtualMachineSize : small -TotalTasksRun : 1 -StartTaskInformation : -RecentTasks : {} -StartTask : -CertificateReferences : -Errors : -``` - -This command gets the compute node that has the ID tvm-2316545714_1-20150725t213220z from the pool that has the ID Pool06. -Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable. - -### Example 2: Get all idle compute nodes from a pool -``` -PS C:\>Get-AzureBatchComputeNode -PoolId "Pool06" -Filter "state eq 'idle'" -BatchContext $Context -Id : tvm-2316545714_1-20150725t213220z -Url : https://cmdletexample.westus.batch.azure.com/pools/MyPool/nodes/tvm-2316545714_1-20150725t213220z -State : Idle -StateTransitionTime : 7/25/2015 9:36:53 PM -LastBootTime : 7/25/2015 9:36:53 PM -AllocationTime : 7/25/2015 9:32:20 PM -IPAddress : 10.14.121.1 -AffinityId : TVM:tvm-2316545714_1-20150725t213220z -VirtualMachineSize : small -TotalTasksRun : 1 -StartTaskInformation : -RecentTasks : {} -StartTask : -CertificateReferences : -Errors : - -Id : tvm-2316545714_2-20150726t172920z -Url : https://cmdletexample.westus.batch.azure.com/pools/MyPool/nodes/tvm-2316545714_2-20150726t172920z -State : Idle -StateTransitionTime : 7/26/2015 5:33:58 PM -LastBootTime : 7/26/2015 5:33:58 PM -AllocationTime : 7/26/2015 5:29:20 PM -IPAddress : 10.14.121.38 -AffinityId : TVM:tvm-2316545714_2-20150726t172920z -VirtualMachineSize : small -TotalTasksRun : 0 -StartTaskInformation : -RecentTasks : -StartTask : -CertificateReferences : -Errors : -``` - -This command gets all idle compute nodes that are contained in the pool that has the ID Pool06. -The command specifies the idle state by using the *Filter* parameter. - -### Example 3: Get all compute nodes in a specified pool -``` -PS C:\>Get-AzureBatchPool -Id "Pool07" -BatchContext $Context | Get-AzureBatchComputeNode -BatchContext $Context -Id : tvm-2316545714_1-20150725t213220z -Url : https://cmdletexample.westus.batch.azure.com/pools/MyPool/nodes/tvm-2316545714_1-20150725t213220z -State : Idle -StateTransitionTime : 7/25/2015 9:36:53 PM -LastBootTime : 7/25/2015 9:36:53 PM -AllocationTime : 7/25/2015 9:32:20 PM -IPAddress : 10.14.121.1 -AffinityId : TVM:tvm-2316545714_1-20150725t213220z -VirtualMachineSize : small -TotalTasksRun : 1 -StartTaskInformation : -RecentTasks : {} -StartTask : -CertificateReferences : -Errors : - - -Id : tvm-2316545714_2-20150726t172920z -Url : https://cmdletexample.westus.batch.azure.com/pools/MyPool/nodes/tvm-2316545714_2-20150726t172920z -State : Idle -StateTransitionTime : 7/26/2015 5:33:58 PM -LastBootTime : 7/26/2015 5:33:58 PM -AllocationTime : 7/26/2015 5:29:20 PM - -IPAddress : 10.14.121.38 -AffinityId : TVM:tvm-2316545714_2-20150726t172920z -VirtualMachineSize : small -TotalTasksRun : 0 -StartTaskInformation : -RecentTasks : -StartTask : -CertificateReferences : -Errors : -``` - -This command gets the pool that has the ID Pool07 by using the Get-AzureBatchPool cmdlet. -The command passes that pool to the current cmdlet by using the pipeline operator. -That cmdlet gets all compute nodes from that pool. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies an OData filter clause. -This cmdlet returns compute nodes that match the filter that this parameter specifies. -If you do not specify a filter, this cmdlet returns all compute nodes for the pool. - -```yaml -Type: System.String -Parameter Sets: ODataFilter, ParentObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the compute node that this cmdlet gets from the pool. -You cannot specify wildcard characters. - -```yaml -Type: System.String -Parameter Sets: Id -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaxCount -Specifies the maximum number of compute nodes to return. -If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. -The default value is 1000. - -```yaml -Type: System.Int32 -Parameter Sets: ODataFilter, ParentObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pool -Specifies the pool, as a **PSCloudPool** object, that contains the compute nodes. -To obtain a **PSCloudPool** object, use the Get-AzureBatchPool cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSCloudPool -Parameter Sets: ParentObject -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PoolId -Specifies the ID of the pool that contains the compute nodes. - -```yaml -Type: System.String -Parameter Sets: ODataFilter, Id -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Select -Specifies an OData select clause. -Specify a value for this parameter to get specific properties rather than all object properties. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.Models.PSCloudPool -Parameters: Pool (ByValue) - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSComputeNode - -## NOTES - -## RELATED LINKS - -[Get-AzureBatchComputeNode](./Get-AzureBatchComputeNode.md) - -[Get-AzureBatchNodeFile](./Get-AzureBatchNodeFile.md) - -[Get-AzureBatchNodeFileContent](./Get-AzureBatchNodeFileContent.md) - -[Get-AzureBatchPool](./Get-AzureBatchPool.md) - -[Reset-AzureBatchComputeNode](./Reset-AzureBatchComputeNode.md) - -[Restart-AzureBatchComputeNode](./Restart-AzureBatchComputeNode.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchJob.md b/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchJob.md deleted file mode 100644 index be68b11ac1..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchJob.md +++ /dev/null @@ -1,312 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 8BF49C4D-E7CD-4FD0-AFAC-9856239D24EC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/get-azurebatchjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJob.md ---- - -# Get-AzureBatchJob - -## SYNOPSIS -Gets Batch jobs for a Batch account or job schedule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ODataFilter (Default) -``` -Get-AzureBatchJob [-JobScheduleId ] [-Filter ] [-MaxCount ] [-Select ] - [-Expand ] -BatchContext [-DefaultProfile ] - [] -``` - -### Id -``` -Get-AzureBatchJob [[-Id] ] [-Select ] [-Expand ] -BatchContext - [-DefaultProfile ] [] -``` - -### ParentObject -``` -Get-AzureBatchJob [[-JobSchedule] ] [-Filter ] [-MaxCount ] - [-Select ] [-Expand ] -BatchContext - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureBatchJob** cmdlet gets the Azure Batch jobs for the Batch account specified by the *BatchAccountContext* parameter. -You can use the *Id* parameter to get a single job. -You can use the *Filter* parameter to get the jobs that match an Open Data Protocol (OData) filter. -If you supply a job schedule ID or **PSCloudJobSchedule** instance, this cmdlet returns only the jobs for that job schedule. - -## EXAMPLES - -### Example 1: Get a Batch job by ID -``` -PS C:\>Get-AzureBatchJob -Id "Job01" -BatchContext $Context -CommonEnvironmentSettings : -Constraints : Microsoft.Azure.Commands.Batch.Models.PSJobConstraints -CreationTime : 7/25/2015 9:12:07 PM -DisplayName : -ETag : 0x8D29535B2941439 -ExecutionInformation : Microsoft.Azure.Commands.Batch.Models.PSJobExecutionInformation -Id : Job01 -JobManagerTask : -JobPreparationTask : -JobReleaseTask : -LastModified : 7/25/2015 9:12:07 PM -Metadata : -PoolInformation : Microsoft.Azure.Commands.Batch.Models.PSPoolInformation -PreviousState : -PreviousStateTransitionTime : -Priority : 0 -State : Active -StateTransitionTime : 7/25/2015 9:12:07 PM -Statistics : -Url : https://pfuller.westus.batch.azure.com/jobs/Job01 -``` - -This command gets the job that has the ID Job01. -Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable. - -### Example 2: Get all active jobs for a job schedule -``` -PS C:\>Get-AzureBatchJob -JobScheduleId "JobSchedule27" -Filter "state eq 'active'" -BatchContext $Context -CommonEnvironmentSettings : -Constraints : Microsoft.Azure.Commands.Batch.Models.PSJobConstraints -CreationTime : 7/25/2015 9:15:44 PM -DisplayName : -ETag : 0x8D2953633DD13E1 -ExecutionInformation : Microsoft.Azure.Commands.Batch.Models.PSJobExecutionInformation -Id : JobSchedule27:job-1 -JobManagerTask : -JobPreparationTask : -JobReleaseTask : -LastModified : 7/25/2015 9:15:44 PM -Metadata : -PoolInformation : Microsoft.Azure.Commands.Batch.Models.PSPoolInformation -PreviousState : -PreviousStateTransitionTime : -Priority : 0 -State : Active -StateTransitionTime : 7/25/2015 9:15:44 PM -Statistics : -Url : https://pfuller.westus.batch.azure.com/jobs/JobSchedule27:job-1 -``` - -This command gets the active jobs for the job schedule that has the ID JobSchedule27. - -### Example 3: Gets all jobs under a job schedule by using the pipeline -``` -PS C:\>Get-AzureBatchJobSchedule -Id "JobSchedule27" -BatchContext $Context | Get-AzureBatchJob -BatchContext $Context -CommonEnvironmentSettings : -Constraints : Microsoft.Azure.Commands.Batch.Models.PSJobConstraints -CreationTime : 7/25/2015 9:15:44 PM -DisplayName : -ETag : 0x8D2953633DD13E1 -ExecutionInformation : Microsoft.Azure.Commands.Batch.Models.PSJobExecutionInformation -Id : JobSchedule27:job-1 -JobManagerTask : -JobPreparationTask : -JobReleaseTask : -LastModified : 7/25/2015 9:15:44 PM -Metadata : -PoolInformation : Microsoft.Azure.Commands.Batch.Models.PSPoolInformation -PreviousState : -PreviousStateTransitionTime : -Priority : 0 -State : Active -StateTransitionTime : 7/25/2015 9:15:44 PM -Statistics : -Url : https://pfuller.westus.batch.azure.com/jobs/JobSchedule27:job-1 -``` - -This command gets the job schedule that has the ID JobSchedule27 by using the Get-AzureBatchJobSchedule cmdlet. -The command passes that job schedule to the current cmdlet by using the pipeline operator. -The command gets all jobs for that job schedule. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expand -Specifies an Open Data Protocol (OData) expand clause. -Specify a value for this parameter to get associated entities of the main entity that you get. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies an OData filter clause for jobs. -If you do not specify a filter, this cmdlet returns all jobs for the Batch account or job schedule. - -```yaml -Type: System.String -Parameter Sets: ODataFilter, ParentObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the job that this cmdlet gets. -You cannot specify wildcard characters. - -```yaml -Type: System.String -Parameter Sets: Id -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobSchedule -Specifies a **PSCloudJobSchedule** object that represents the job schedule which contains the jobs. -To obtain a **PSCloudJobSchedule** object, use the Get-AzureBatchJobSchedule cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSCloudJobSchedule -Parameter Sets: ParentObject -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -JobScheduleId -Specifies the ID of the job schedule which contains the jobs. - -```yaml -Type: System.String -Parameter Sets: ODataFilter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaxCount -Specifies the maximum number of jobs to return. -If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. -The default value is 1000. - -```yaml -Type: System.Int32 -Parameter Sets: ODataFilter, ParentObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Select -Specifies an OData select clause. -Specify a value for this parameter to get specific properties rather than all object properties. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.Models.PSCloudJobSchedule -Parameters: JobSchedule (ByValue) - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSCloudJob - -## NOTES - -## RELATED LINKS - -[Disable-AzureBatchJob](./Disable-AzureBatchJob.md) - -[Enable-AzureBatchJob](./Enable-AzureBatchJob.md) - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[Get-AzureBatchJobSchedule](./Get-AzureBatchJobSchedule.md) - -[New-AzureBatchJob](./New-AzureBatchJob.md) - -[Remove-AzureBatchJob](./Remove-AzureBatchJob.md) - -[Stop-AzureBatchJob](./Stop-AzureBatchJob.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchJobPreparationAndReleaseTaskStatus.md b/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchJobPreparationAndReleaseTaskStatus.md deleted file mode 100644 index a824ef3b58..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchJobPreparationAndReleaseTaskStatus.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/get-azurebatchjobpreparationandreleasetaskstatus -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJobPreparationAndReleaseTaskStatus.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJobPreparationAndReleaseTaskStatus.md ---- - -# Get-AzureBatchJobPreparationAndReleaseTaskStatus - -## SYNOPSIS -Gets Batch job preparation and release task status. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Id (Default) -``` -Get-AzureBatchJobPreparationAndReleaseTaskStatus [-Id] [-Filter ] [-MaxCount ] - [-Select ] [-Expand ] -BatchContext - [-DefaultProfile ] [] -``` - -### InputObject -``` -Get-AzureBatchJobPreparationAndReleaseTaskStatus [-InputObject] [-Filter ] - [-MaxCount ] [-Select ] [-Expand ] -BatchContext - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureBatchJobPreparationAndReleaseTaskStatus** cmdlet gets the Azure Batch job preparation and release task status for a Batch job. -You must supply the *Id* parameter or a **PSCloudJob** instance to this cmdlet. - -## EXAMPLES - -### Example 1: Get the job preparation and release status of a job -``` -PS C:\> Get-AzureBatchJobPreparationAndReleaseTaskStatus -BatchContext $Context -Id Test - -ComputeNodeId : tvm-2316545714_1-20170613t201733z -ComputeNodeUrl : https://account.westus.batch.azure.com/pools/test/nodes/tvm-2316545714_1-20170613t201733z -JobPreparationTaskExecutionInformation : Microsoft.Azure.Commands.Batch.Models.PSJobPreparationTaskExecutionInformation -JobReleaseTaskExecutionInformation : -PoolId : test -``` - -This command gets the job preparation and release task status for job "Test". -Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable. - -### Example 2: Get the job preparation and release status of a job with Filter and Select specified -``` -PS C:\> Get-AzureBatchJobPreparationAndReleaseTaskStatus -BatchContext $context -Id Test -Filter "nodeId eq 'tvm-2316545714_1-20170613t201733z'" -Select "jobPreparationTaskExecutionInfo" - -ComputeNodeId : -ComputeNodeUrl : -JobPreparationTaskExecutionInformation : Microsoft.Azure.Commands.Batch.Models.PSJobPreparationTaskExecutionInformation -JobReleaseTaskExecutionInformation : -PoolId : -``` - -This command gets the job preparation and release task status for job "Test" on node "tvm-2316545714_1-20170613t201733z" and uses the Select clause to specify to only return the JobPreparationTaskExecutionInformation information - -## PARAMETERS - -### -BatchContext -The BatchAccountContext instance to use when interacting with the Batch service. -Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expand -Specifies an Open Data Protocol (OData) expand clause. -Specify a value for this parameter to get associated entities of the main entity that you get. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies an OData filter clause. -If you do not specify a filter, this cmdlet returns all job preparation and release task status' for the job. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the job whose preparation and release tasks should be retrieved. -You cannot specify wildcard characters. - -```yaml -Type: System.String -Parameter Sets: Id -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies a **PSCloudJob** object that represents the job to get the preparation and release task status from. -To obtain a **PSCloudJob** object, use the Get-AzureBatchJob cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSCloudJob -Parameter Sets: InputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -MaxCount -Specifies the maximum number of jobs preparation and release task status' to return. -If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. -The default value is 1000. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Select -Specifies an OData select clause. -Specify a value for this parameter to get specific properties rather than all object properties. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSCloudJob -Parameters: InputObject (ByValue) - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSJobPreparationAndReleaseTaskExecutionInformation - -## NOTES - -## RELATED LINKS - -[Get-AzureBatchJob](./Get-AzureBatchJob.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchJobSchedule.md b/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchJobSchedule.md deleted file mode 100644 index 067fea79a8..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchJobSchedule.md +++ /dev/null @@ -1,245 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 8BAA6D8C-1530-4CC4-8AE5-A2CE6B1192CA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/get-azurebatchjobschedule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJobSchedule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJobSchedule.md ---- - -# Get-AzureBatchJobSchedule - -## SYNOPSIS -Gets Batch job schedules. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ODataFilter (Default) -``` -Get-AzureBatchJobSchedule [-Filter ] [-MaxCount ] [-Select ] [-Expand ] - -BatchContext [-DefaultProfile ] [] -``` - -### Id -``` -Get-AzureBatchJobSchedule [[-Id] ] [-Select ] [-Expand ] - -BatchContext [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureBatchJobSchedule** cmdlet gets Azure Batch job schedules for the Batch account specified by the *BatchContext* parameter. -Specify an ID to get a single job schedule. -Specify the *Filter* parameter to get the job schedules that match an Open Data Protocol (OData) filter. - -## EXAMPLES - -### Example 1: Get a job schedule by specifying an ID -``` -PS C:\>Get-AzureBatchJobSchedule -Id "JobSchedule23" -BatchContext $Context -CreationTime : 7/25/2015 9:15:43 PM -DisplayName : -ETag : 0x8D2953633427FCA -ExecutionInformation : Microsoft.Azure.Commands.Batch.Models.PSJobScheduleExecutionInformation -Id : JobSchedule23 -JobSpecification : Microsoft.Azure.Commands.Batch.Models.PSJobSpecification -LastModified : 7/25/2015 9:15:43 PM -Metadata : -PreviousState : Invalid -PreviousStateTransitionTime : -Schedule : -State : Active -StateTransitionTime : 7/25/2015 9:15:43 PM -Statistics : -Url : https://pfuller.westus.batch.azure.com/jobschedules/JobSchedule23 -``` - -This command gets the job schedule that has the ID JobSchedule23. -Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable. - -### Example 2: Get job schedules by using a filter -``` -PS C:\>Get-AzureBatchJobSchedule -Filter "startswith(id,'Job')" -BatchContext $Context -CreationTime : 7/25/2015 9:15:43 PM -DisplayName : -ETag : 0x8D2953633427FCA -ExecutionInformation : Microsoft.Azure.Commands.Batch.Models.PSJobScheduleExecutionInformation -Id : JobSchedule23 -JobSpecification : Microsoft.Azure.Commands.Batch.Models.PSJobSpecification -LastModified : 7/25/2015 9:15:43 PM -Metadata : -PreviousState : Invalid -PreviousStateTransitionTime : -Schedule : -State : Active -StateTransitionTime : 7/25/2015 9:15:43 PM -Statistics : -Url : https://pfuller.westus.batch.azure.com/jobschedules/JobSchedule23 - -CreationTime : 7/26/2015 5:39:33 PM -DisplayName : -ETag : 0x8D295E12B1084B4 -ExecutionInformation : Microsoft.Azure.Commands.Batch.Models.PSJobScheduleExecutionInformation -Id : JobSchedule26 -JobSpecification : Microsoft.Azure.Commands.Batch.Models.PSJobSpecification -LastModified : 7/26/2015 5:39:33 PM -Metadata : -PreviousState : Invalid -PreviousStateTransitionTime : -Schedule : -State : Active -StateTransitionTime : 7/26/2015 5:39:33 PM -Statistics : -Url : https://pfuller.westus.batch.azure.com/jobschedules/JobSchedule26 -``` - -This command gets all job schedules that have IDs that start with Job by specifying the *Filter* parameter. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expand -Specifies an Open Data Protocol (OData) expand clause. -Specify a value for this parameter to get associated entities of the main entity that you get. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies an OData filter clause. -This cmdlet returns job schedules that match the filter that this parameter specifies. -If you do not specify a filter, this cmdlet returns all job schedules for the Batch context. - -```yaml -Type: System.String -Parameter Sets: ODataFilter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the job schedule that this cmdlet gets. -You cannot specify wildcard characters. - -```yaml -Type: System.String -Parameter Sets: Id -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -MaxCount -Specifies the maximum number of job schedules to return. -If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. -The default value is 1000. - -```yaml -Type: System.Int32 -Parameter Sets: ODataFilter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Select -Specifies an OData select clause. -Specify a value for this parameter to get specific properties rather than all object properties. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSCloudJobSchedule - -## NOTES - -## RELATED LINKS - -[Disable-AzureBatchJobSchedule](./Disable-AzureBatchJobSchedule.md) - -[Enable-AzureBatchJobSchedule](./Enable-AzureBatchJobSchedule.md) - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[New-AzureBatchJobSchedule](./New-AzureBatchJobSchedule.md) - -[Remove-AzureBatchJobSchedule](./Remove-AzureBatchJobSchedule.md) - -[Stop-AzureBatchJobSchedule](./Stop-AzureBatchJobSchedule.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchJobStatistics.md b/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchJobStatistics.md deleted file mode 100644 index 39299b2781..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchJobStatistics.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: E655684D-9601-4A0B-BB09-EFB787EB2B1B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/get-azurebatchjobstatistics -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJobStatistics.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJobStatistics.md ---- - -# Get-AzureBatchJobStatistics - -## SYNOPSIS -Gets job summary statistics for a Batch account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureBatchJobStatistics -BatchContext [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Get-AzureBatchJobStatistics** cmdlet gets lifetime summary statistics for all of the jobs in an Azure Batch account. -Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics. - -## EXAMPLES - -### Example 1: Get summary statistics for all jobs -``` -PS C:\>Get-AzureBatchJobStatistics -BatchContext $Context -FailedTaskCount : 330 -KernelCpuTime : 00:24:31.8440000 -LastUpdateTime : 5/16/2016 6:00:00 PM -ReadIOGiB : 38.1271341182292 -ReadIOps : 26546054 -StartTime : 11/3/2015 9:47:14 PM -SucceededTaskCount : 766 -TaskRetryCount : 0 -Url : https://accountname.westus.batch.azure.com/lifetimejobstats -UserCpuTime : 20:55:50.3200000 -WaitTime : 03:54:49.8530000 -WallClockTime : 20:55:50.3200000 -WriteIOGiB : 0.159623090177774 -WriteIOps : 146946 -``` - -The first command creates an object reference to the account keys for the batch account named ContosoBatchAccount by using **Get-AzureRmBatchAccountKeys**. -The command stores this object reference in the $Context variable. -The second command gets the summary statistics for all of the jobs. -The command uses the $Context value from the first command. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSJobStatistics - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[Get-AzureBatchPoolStatistics](./Get-AzureBatchPoolStatistics.md) - -[Get-AzureBatchPoolUsageMetrics](./Get-AzureBatchPoolUsageMetrics.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchNodeAgentSku.md b/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchNodeAgentSku.md deleted file mode 100644 index a7eee4bde2..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchNodeAgentSku.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 5C6D3792-AA56-4210-B376-D9E656B04FBD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/get-azurebatchnodeagentsku -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchNodeAgentSku.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchNodeAgentSku.md ---- - -# Get-AzureBatchNodeAgentSku - -## SYNOPSIS -Gets Batch node agent SKUs available in a Batch account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureBatchNodeAgentSku [-Filter ] [-MaxCount ] -BatchContext - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureBatchNodeAgentSku** cmdlet gets node agent SKUs that are available in an Azure Batch account. -Specify the account by using the *BatchContext* parameter. -You can narrow your search to SKUs that match an Open Data Protocol (OData) filter. - -## EXAMPLES - -### Example 1: Get all available node agent SKUs -``` -PS C:\>$Context = Get-AzureRmBatchAccountKeys -AccountName "ContosoBatchAccount" -PS C:\> Get-AzureBatchNodeAgentSku -BatchContext $Context -``` - -The first command gets a batch account context that contains access keys for your subscription by using **Get-AzureRmBatchAccountKeys**. -The command stores the context in the $Context variable to use in the next command. -The second command gets all available node agent SKUs that Batch supports. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies an OData filter clause for node agent SKUs. -If you do not specify a filter, this cmdlet returns all node agent SKUs that Batch supports. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxCount -Specifies the maximum number of node agent SKUs to return. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSNodeAgentSku - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchNodeFile.md b/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchNodeFile.md deleted file mode 100644 index a7031107bd..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchNodeFile.md +++ /dev/null @@ -1,368 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 38ED2854-23D0-400E-A5C8-239346B2AF99 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/get-azurebatchnodefile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchNodeFile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchNodeFile.md ---- - -# Get-AzureBatchNodeFile - -## SYNOPSIS -Gets the properties of Batch node files. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ComputeNode_Id (Default) -``` -Get-AzureBatchNodeFile [-PoolId] [-ComputeNodeId] [[-Path] ] - -BatchContext [-DefaultProfile ] [] -``` - -### Task_Id -``` -Get-AzureBatchNodeFile -JobId -TaskId [[-Path] ] -BatchContext - [-DefaultProfile ] [] -``` - -### Task_ODataFilter -``` -Get-AzureBatchNodeFile -JobId -TaskId [-Filter ] [-MaxCount ] [-Recursive] - -BatchContext [-DefaultProfile ] [] -``` - -### ParentTask -``` -Get-AzureBatchNodeFile [[-Task] ] [-Filter ] [-MaxCount ] [-Recursive] - -BatchContext [-DefaultProfile ] [] -``` - -### ComputeNode_ODataFilter -``` -Get-AzureBatchNodeFile [-PoolId] [-ComputeNodeId] [-Filter ] [-MaxCount ] - [-Recursive] -BatchContext [-DefaultProfile ] - [] -``` - -### ParentComputeNode -``` -Get-AzureBatchNodeFile [[-ComputeNode] ] [-Filter ] [-MaxCount ] [-Recursive] - -BatchContext [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureBatchNodeFile** cmdlet gets the properties of the Azure Batch node files of a task or compute node. -To narrow your results, you can specify an Open Data Protocol (OData) filter. -If you specify a task, but not a filter, this cmdlet returns properties for all node files for that task. -If you specify a compute node, but not a filter, this cmdlet returns properties for all node files for that compute node. - -## EXAMPLES - -### Example 1: Get the properties of a node file associated with a task -``` -PS C:\>Get-AzureBatchNodeFile -JobId "Job-000001" -TaskId "Task26" -Path "Stdout.txt" -BatchContext $Context -IsDirectory Name Properties Url - ------------ ---- ---------- --- - -False StdOut.txt Microsoft.Azure.Commands.Batch.Models.PSFile... https://cmdletexample.westus.Batch.contoso... -``` - -This command gets the properties of the StdOut.txt node file associated with the task that has the ID Task26 in the job that has the ID Job-000001. -Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable. - -### Example 2: Get the properties of node files associated with a task by using a filter -``` -PS C:\>Get-AzureBatchNodeFile -JobId "Job-00002" -TaskId "Task26" -Filter "startswith(name,'St')" -BatchContext $Context -IsDirectory Name Properties Url - ------------ ---- ---------- --- - -False StdErr.txt Microsoft.Azure.Commands.Batch.Models.PSFile... https://cmdletexample.westus.Batch.contoso... -False StdOut.txt Microsoft.Azure.Commands.Batch.Models.PSFile... https://cmdletexample.westus.Batch.contoso... -``` - -This command gets the properties of the node files whose names start with st and are associated with task that has the ID Task26 under job that has the ID Job-00002. - -### Example 3: Recursively get the properties of node files associated with a task -``` -PS C:\>Get-AzureBatchTask "Job-00003" "Task31" -BatchContext $Context | Get-AzureBatchNodeFile -Recursive -BatchContext $Context -IsDirectory Name Properties Url - ------------ ---- ---------- --- - -False ProcessEnv.cmd Microsoft.Azure.Commands.Batch.Models.PSFile... https://cmdletexample.westus.Batch.contoso... -False StdErr.txt Microsoft.Azure.Commands.Batch.Models.PSFile... https://cmdletexample.westus.Batch.contoso... -False StdOut.txt Microsoft.Azure.Commands.Batch.Models.PSFile... https://cmdletexample.westus.Batch.contoso... -True wd https://cmdletexample.westus.Batch.contoso... -False wd\newFile.txt Microsoft.Azure.Commands.Batch.Models.PSFile... https://cmdletexample.westus.Batch.contoso... -``` - -This command gets the properties of all files associated with the task that has the ID Task31 in job Job-00003. -This command specifies the *Recursive* parameter. -Therefore, the cmdlet performs a recursive file search is performed, and returns the wd\newFile.txt node file. - -### Example 4: Get a single file from a compute node -``` -PS C:\>Get-AzureBatchNodeFile -PoolId "Pool22" -ComputeNodeId "ComputeNode01" -Path "Startup\StdOut.txt" -BatchContext $Context -IsDirectory Name Properties Url ------------ ---- ---------- --- -False startup\stdout.txt Microsoft.Azure.Commands.Batch.Models.PSFile... https://cmdletexample.westus.Batch.contoso... -``` - -This command gets the file that is named Startup\StdOut.txt from the compute node that has the ID ComputeNode01 in the pool that has the ID Pool22. - -### Example 5: Get all files under a folder from a compute node -``` -PS C:\>Get-AzureBatchNodeFile -PoolId "Pool22" -ComputeNodeId "ComputeNode01" -Filter "startswith(name,'startup')" -Recursive -BatchContext $Context -IsDirectory Name Properties Url ------------ ---- ---------- --- -True startup https://cmdletexample.westus.Batch.contoso... -False startup\ProcessEnv.cmd Microsoft.Azure.Commands.Batch.Models.PSFile... https://cmdletexample.westus.Batch.contoso... -False startup\stderr.txt Microsoft.Azure.Commands.Batch.Models.PSFile... https://cmdletexample.westus.Batch.contoso... -False startup\stdout.txt Microsoft.Azure.Commands.Batch.Models.PSFile... https://cmdletexample.westus.Batch.contoso... -True startup\wd https://cmdletexample.westus.Batch.contoso... -``` - -This command gets all the files under the startup folder from the compute node that has the ID ComputeNode01 in the pool that has the ID Pool22. -This cmdlet specifies the *Recursive* parameter. - -### Example 6: Get files from the root folder of a compute node -``` -PS C:\>Get-AzureBatchComputeNode "Pool22" -Id "ComputeNode01" -BatchContext $Context | Get-AzureBatchNodeFile -BatchContext $Context -IsDirectory Name Properties Url ------------ ---- ---------- --- -True shared https://cmdletexample.westus.Batch.contoso... -True startup https://cmdletexample.westus.Batch.contoso... -True workitems https://cmdletexample.westus.Batch.contoso... -``` - -This command gets all the files at the root folder of the compute node that has the ID ComputeNode01 in the pool that has the ID Pool22. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ComputeNode -Specifies the compute node, as a **PSComputeNode** object, that contains the Batch node files. -To obtain a compute node object, use the Get-AzureBatchComputeNode cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSComputeNode -Parameter Sets: ParentComputeNode -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ComputeNodeId -Specifies the ID of the compute node that contains the Batch node files. - -```yaml -Type: System.String -Parameter Sets: ComputeNode_Id, ComputeNode_ODataFilter -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies an OData filter clause. -This cmdlet returns properties for node files that match the filter that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: Task_ODataFilter, ParentTask, ComputeNode_ODataFilter, ParentComputeNode -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobId -Specifies the ID of the job that contains the target task. - -```yaml -Type: System.String -Parameter Sets: Task_Id, Task_ODataFilter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaxCount -Specifies the maximum number of node files for which this cmdlet returns properties. -If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. -The default value is 1000. - -```yaml -Type: System.Int32 -Parameter Sets: Task_ODataFilter, ParentTask, ComputeNode_ODataFilter, ParentComputeNode -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path of the node file for which this cmdlet retrieves properties. -You cannot specify wildcard characters. - -```yaml -Type: System.String -Parameter Sets: ComputeNode_Id, Task_Id -Aliases: Name - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PoolId -Specifies the ID of the pool that contains the compute node from which to get properties of node files. - -```yaml -Type: System.String -Parameter Sets: ComputeNode_Id, ComputeNode_ODataFilter -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Recursive -Indicates that this cmdlet returns a recursive list of files. -Otherwise, it returns only the files in the root folder. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Task_ODataFilter, ParentTask, ComputeNode_ODataFilter, ParentComputeNode -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Task -Specifies the task, as a **PSCloudTask** object, with which the node files are associated. -To obtain a task object, use the Get-AzureBatchTask cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSCloudTask -Parameter Sets: ParentTask -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TaskId -Specifies the ID of the task for which this cmdlet gets properties of node files. - -```yaml -Type: System.String -Parameter Sets: Task_Id, Task_ODataFilter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.Models.PSCloudTask -Parameters: Task (ByValue) - -### Microsoft.Azure.Commands.Batch.Models.PSComputeNode -Parameters: ComputeNode (ByValue) - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSNodeFile - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[Get-AzureBatchComputeNode](./Get-AzureBatchComputeNode.md) - -[Get-AzureBatchNodeFileContent](./Get-AzureBatchNodeFileContent.md) - -[Get-AzureBatchTask](./Get-AzureBatchTask.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchNodeFileContent.md b/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchNodeFileContent.md deleted file mode 100644 index de0665ffae..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchNodeFileContent.md +++ /dev/null @@ -1,334 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: C9E2D9EC-3B6A-492D-B183-9856185548CD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/get-azurebatchnodefilecontent -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchNodeFileContent.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchNodeFileContent.md ---- - -# Get-AzureBatchNodeFileContent - -## SYNOPSIS -Gets a Batch node file. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Task_Id_Path -``` -Get-AzureBatchNodeFileContent -JobId -TaskId [-Path] -DestinationPath - [-ByteRangeStart ] [-ByteRangeEnd ] -BatchContext - [-DefaultProfile ] [] -``` - -### Task_Id_Stream -``` -Get-AzureBatchNodeFileContent -JobId -TaskId [-Path] -DestinationStream - [-ByteRangeStart ] [-ByteRangeEnd ] -BatchContext - [-DefaultProfile ] [] -``` - -### ComputeNode_Id_Path -``` -Get-AzureBatchNodeFileContent [-PoolId] [-ComputeNodeId] [-Path] - -DestinationPath [-ByteRangeStart ] [-ByteRangeEnd ] - -BatchContext [-DefaultProfile ] [] -``` - -### ComputeNode_Id_Stream -``` -Get-AzureBatchNodeFileContent [-PoolId] [-ComputeNodeId] [-Path] - -DestinationStream [-ByteRangeStart ] [-ByteRangeEnd ] - -BatchContext [-DefaultProfile ] [] -``` - -### InputObject_Path -``` -Get-AzureBatchNodeFileContent [[-InputObject] ] -DestinationPath [-ByteRangeStart ] - [-ByteRangeEnd ] -BatchContext [-DefaultProfile ] - [] -``` - -### InputObject_Stream -``` -Get-AzureBatchNodeFileContent [[-InputObject] ] -DestinationStream - [-ByteRangeStart ] [-ByteRangeEnd ] -BatchContext - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureBatchNodeFileContent** cmdlet gets an Azure Batch node file and saves it as a file or to a stream. - -## EXAMPLES - -### Example 1: Get a Batch node file associated with a task and save the file -``` -PS C:\>Get-AzureBatchNodeFileContent -JobId "Job01" -TaskId "Task01" -Path "StdOut.txt" -DestinationPath "E:\PowerShell\StdOut.txt" -BatchContext $Context -``` - -This command gets the node file that is named StdOut.txt, and saves it to the E:\PowerShell\StdOut.txt file path on the local computer. -The StdOut.txt node file is associated with task that has the ID Task01 for the job that has the ID Job01. -Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable. - -### Example 2: Get a Batch node file and save it to a specified file path using the pipeline -``` -PS C:\>Get-AzureBatchNodeFile -JobId "Job02" -TaskId "Task02" -Path "StdErr.txt" -BatchContext $Context | Get-AzureBatchNodeFileContent -DestinationPath "E:\PowerShell\StdOut.txt" -BatchContext $Context -``` - -This command gets the node file that is named StdErr.txt by using the Get-AzureBatchNodeFile cmdlet. -The command passes that file to the current cmdlet by using the pipeline operator. -The current cmdlet saves that file to the E:\PowerShell\StdOut.txt file path on the local computer. -The StdOut.txt node file is associated with the task that has the ID Task02 for the job that has the ID Job02. - -### Example 3: Get a Batch node file associated with a task and direct it to a stream -``` -PS C:\>$Stream = New-Object -TypeName "System.IO.MemoryStream" -PS C:\> Get-AzureBatchNodeFileContent -JobId "Job03" -TaskId "Task11" -Path "StdOut.txt" -DestinationStream $Stream -BatchContext $Context -``` - -The first command creates a stream by using the New-Object cmdlet, and then stores it in the $Stream variable. -The second command gets the node file that is named StdOut.txt from the task that has the ID Task11 for the job that has the ID Job03. -The command directs file contents to the stream in $Stream. - -### Example 4: Get a node file from a compute node and save it -``` -PS C:\>Get-AzureBatchNodeFileContent -PoolId "Pool01" -ComputeNodeId "ComputeNode01" -Path "Startup\StdOut.txt" -DestinationPath "E:\PowerShell\StdOut.txt" -BatchContext $Context -``` - -This command gets the node file Startup\StdOut.txt from the compute node that has the ID ComputeNode01 in the pool that has the ID Pool01. -The command saves the file to the E:\PowerShell\StdOut.txt file path on the local computer. - -### Example 5: Get a node file from a compute node and save it by using the pipeline -``` -PS C:\>Get-AzureBatchNodeFile -PoolId "Pool01" -ComputeNodeId "ComputeNode01" -Path "Startup\StdOut.txt" -BatchContext $Context | Get-AzureBatchNodeFileContent -DestinationPath "E:\PowerShell\StdOut.txt" -BatchContext $Context -``` - -This command gets the node file Startup\StdOut.txt by using Get-AzureBatchNodeFile from the compute node that has the ID ComputeNode01. -The compute node is in the pool that has the ID Pool01. -The command passes that node file to the current cmdlet. -That cmdlet saves the file to the E:\PowerShell\StdOut.txt file path on the local computer. - -### Example 6: Get a node file from a compute node and direct it to a stream -``` -PS C:\>$Stream = New-Object -TypeName "System.IO.MemoryStream" -PS C:\> Get-AzureBatchNodeFileContent -PoolId "Pool01" -ComputeNodeId "ComputeNode01" -Path "startup\stdout.txt" -DestinationStream $Stream -BatchContext $Context -``` - -The first command creates a stream by using the New-Object cmdlet, and then stores it in the $Stream variable. -The second command gets the node file that is named StdOut.txt from the compute node that has the ID ComputeNode01 in the pool that has the ID Pool01. -The command directs file contents to the stream in $Stream. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ByteRangeEnd -The end of the byte range to be downloaded. - -```yaml -Type: System.Nullable`1[System.Int64] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ByteRangeStart -The start of the byte range to be downloaded. - -```yaml -Type: System.Nullable`1[System.Int64] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputeNodeId -Specifies the ID of the compute node that contains the node file that this cmdlet returns. - -```yaml -Type: System.String -Parameter Sets: ComputeNode_Id_Path, ComputeNode_Id_Stream -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationPath -Specifies the file path where this cmdlet saves the node file. - -```yaml -Type: System.String -Parameter Sets: Task_Id_Path, ComputeNode_Id_Path, InputObject_Path -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationStream -Specifies the stream into which this cmdlet writes the node file contents. -This cmdlet does not close or rewind this stream. - -```yaml -Type: System.IO.Stream -Parameter Sets: Task_Id_Stream, ComputeNode_Id_Stream, InputObject_Stream -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the file that this cmdlet gets, as a **PSNodeFile** object. -To obtain a node file object, use the Get-AzureBatchNodeFile cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSNodeFile -Parameter Sets: InputObject_Path, InputObject_Stream -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -JobId -Specifies the ID of the job that contains the target task. - -```yaml -Type: System.String -Parameter Sets: Task_Id_Path, Task_Id_Stream -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -The path of the node file to download. - -```yaml -Type: System.String -Parameter Sets: Task_Id_Path, Task_Id_Stream, ComputeNode_Id_Path, ComputeNode_Id_Stream -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PoolId -Specifies the ID of the pool that contains the compute node that contains the node file that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: ComputeNode_Id_Path, ComputeNode_Id_Stream -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TaskId -Specifies the ID of the task. - -```yaml -Type: System.String -Parameter Sets: Task_Id_Path, Task_Id_Stream -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.Models.PSNodeFile -Parameters: InputObject (ByValue) - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[Get-AzureBatchNodeFile](./Get-AzureBatchNodeFile.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchPool.md b/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchPool.md deleted file mode 100644 index a274522ccd..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchPool.md +++ /dev/null @@ -1,246 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 44D877F1-D066-4C9C-A797-05EF03785B54 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/get-azurebatchpool -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPool.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPool.md ---- - -# Get-AzureBatchPool - -## SYNOPSIS -Gets Batch pools under the specified Batch account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ODataFilter (Default) -``` -Get-AzureBatchPool [-Filter ] [-MaxCount ] [-Select ] [-Expand ] - -BatchContext [-DefaultProfile ] [] -``` - -### Id -``` -Get-AzureBatchPool [[-Id] ] [-Select ] [-Expand ] -BatchContext - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureBatchPool** cmdlet gets the Azure Batch pools under the Batch account specified with the *BatchContext* parameter. -You can use the *Id* parameter to get a single pool, or you can use the *Filter* parameter to get the pools that match an Open Data Protocol (OData) filter. - -## EXAMPLES - -### Example 1: Get a pool by ID -``` -PS C:\>Get-AzureBatchPool -Id "MyPool" -BatchContext $Context -AllocationState : Resizing -AllocationStateTransitionTime : 7/25/2015 9:30:28 PM -AutoScaleEnabled : False -AutoScaleFormula : -AutoScaleRun : -CertificateReferences : -CreationTime : 7/25/2015 9:30:28 PM -CurrentDedicated : 0 -CurrentOSVersion : * -DisplayName : -ETag : 0x8D29538429CF04C -Id : MyPool -InterComputeNodeCommunicationEnabled : False -LastModified : 7/25/2015 9:30:28 PM -MaxTasksPerComputeNode : 1 -Metadata : -OSFamily : 4 -ResizeError : -ResizeTimeout : 00:05:00 -TaskSchedulingPolicy : Microsoft.Azure.Commands.Batch.Models.PSTaskSchedulingPolicy -StartTask : -State : Active -StateTransitionTime : 7/25/2015 9:30:28 PM -Statistics : -TargetDedicated : 1 -TargetOSVersion : * -Url : https://cmdletexample.westus.batch.azure.com/pools/MyPool -VirtualMachineSize : small -``` - -This command gets the pool with ID MyPool. - -### Example 2: Get all pools using an OData filter -``` -PS C:\>Get-AzureBatchPool -Filter "startswith(id,'My')" -BatchContext $Context -AllocationState : Resizing -AllocationStateTransitionTime : 7/25/2015 9:30:28 PM -AutoScaleEnabled : False -AutoScaleFormula : -AutoScaleRun : -CertificateReferences : -CreationTime : 7/25/2015 9:30:28 PM -CurrentDedicated : 0 -CurrentOSVersion : * -DisplayName : -ETag : 0x8D29538429CF04C -Id : MyPool -InterComputeNodeCommunicationEnabled : False -LastModified : 7/25/2015 9:30:28 PM -MaxTasksPerComputeNode : 1 -Metadata : -OSFamily : 4 -ResizeError : -ResizeTimeout : 00:05:00 -TaskSchedulingPolicy : Microsoft.Azure.Commands.Batch.Models.PSTaskSchedulingPolicy -StartTask : -State : Active -StateTransitionTime : 7/25/2015 9:30:28 PM -Statistics : -TargetDedicated : 1 -TargetOSVersion : * -Url : https://cmdletexample.westus.batch.azure.com/pools/MyPool -VirtualMachineSize : small -``` - -This command gets the pools whose IDs start with My by using the *Filter* parameter. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expand -Specifies an Open Data Protocol (OData) expand clause. -Specify a value for this parameter to get associated entities of the main entity that you get. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies the OData filter clause to use when querying for pools. -If you do not specify a filter, all pools under the Batch account specified with the *BatchContext* parameter are returned. - -```yaml -Type: System.String -Parameter Sets: ODataFilter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the pool to get. -You cannot specify wildcard characters. - -```yaml -Type: System.String -Parameter Sets: Id -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -MaxCount -Specifies the maximum number of pools to return. -If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. -The default value is 1000. - -```yaml -Type: System.Int32 -Parameter Sets: ODataFilter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Select -Specifies an OData select clause. -Specify a value for this parameter to get specific properties rather than all object properties. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSCloudPool - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[New-AzureBatchPool](./New-AzureBatchPool.md) - -[Remove-AzureBatchPool](./Remove-AzureBatchPool.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchPoolNodeCounts.md b/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchPoolNodeCounts.md deleted file mode 100644 index aa7c938a5b..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchPoolNodeCounts.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/get-azurebatchpoolnodecounts -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPoolNodeCounts.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPoolNodeCounts.md ---- - -# Get-AzureBatchPoolNodeCounts - -## SYNOPSIS -Gets Batch node counts per node state grouped by pool id. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### AzureBatchPoolNodeCounts (Default) -``` -Get-AzureBatchPoolNodeCounts -BatchContext [-DefaultProfile ] - [] -``` - -### PoolId -``` -Get-AzureBatchPoolNodeCounts [-PoolId ] -BatchContext - [-DefaultProfile ] [] -``` - -### ParentObject -``` -Get-AzureBatchPoolNodeCounts [-Pool ] -BatchContext - [-DefaultProfile ] [] -``` - -### ODataFilter -``` -Get-AzureBatchPoolNodeCounts [-MaxCount ] -BatchContext - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The Get-AzureBatchPoolNodeCounts cmdlet allows customers to get back node counts per node state grouped by pool. Possible node states are creating, idle, leavingPool, offline, preempted, rebooting, reimaging, running, starting, startTaskFailed, unknown, unusable and waitingForStartTask. The cmdlet takes PoolId or Pool parameter to filter only pool with pool id specified. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> $batchContext = Get-AzureRmBatchAccountKeys -AccountName "contosobatch" -PS C:\> Get-AzureBatchPoolNodeCounts -BatchContext $batchContext - -PoolId Dedicated LowPriority ------- --------- ----------- -contosopool1 Creating: 1, Idle: 1, Rebooting: 1, Running: 5, Total: 8 Total: 0 -contosopool2 Idle: 1, Rebooting: 1, Total: 2 Total: 0 -``` - -List node counts per node state for pools under current batch account context. - -### Example 2 - -```powershell -PS C:\> Get-AzureBatchPoolNodeCounts -BatchContext $batchContext -PoolId "contosopool1" - -PoolId Dedicated LowPriority ------- --------- ----------- -contosopool1 Creating: 1, Idle: 1, Rebooting: 1, Running: 5, Total: 8 Total: 0 - -PS C:\> $poolnodecounts = Get-AzureBatchPoolNodeCounts -BatchContext $batchContext -PoolId "contosopool1" -PS C:\> $poolnodecounts.Dedicated - -Creating : 1 -Idle : 1 -LeavingPool : 0 -Offline : 0 -Preempted : 0 -Rebooting : 1 -Reimaging : 0 -Running : 5 -Starting : 0 -StartTaskFailed : 0 -Total : 8 -Unknown : 0 -Unusable : 0 -WaitingForStartTask : 0 - -PS C:\> Get-AzureBatchPool -Id "contosopool1" -BatchContext $batchContext | Get-AzureBatchPoolNodeCounts -BatchContext $batchContext - -PoolId Dedicated LowPriority ------- --------- ----------- -contosopool1 Creating: 1, Idle: 1, Rebooting: 1, Running: 5, Total: 8 Total: 0 -``` - -Show node counts per node state for a pool given pool id. - -## PARAMETERS - -### -BatchContext -The BatchAccountContext instance to use when interacting with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. -To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. -When using shared key authentication, the primary access key is used by default. -To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxCount -Specifies the maximum number of pools to return. -The default value is 10. - -```yaml -Type: System.Int32 -Parameter Sets: ODataFilter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pool -Specifies the **PSCloudPool** for which to get node counts. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSCloudPool -Parameter Sets: ParentObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PoolId -The id of the pool for which to get node counts. - -```yaml -Type: System.String -Parameter Sets: PoolId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.Models.PSCloudPool -Parameters: Pool (ByValue) - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSPoolNodeCounts - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchAccountKeys]() - -[Get-AzureBatchJob]() - -[Azure Batch Cmdlets]() diff --git a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchPoolStatistics.md b/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchPoolStatistics.md deleted file mode 100644 index 61af794c07..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchPoolStatistics.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 8188C617-4895-4B43-8D3B-FA6FC5B868DD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/get-azurebatchpoolstatistics -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPoolStatistics.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPoolStatistics.md ---- - -# Get-AzureBatchPoolStatistics - -## SYNOPSIS -Gets pool summary statistics for a Batch account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureBatchPoolStatistics -BatchContext [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Get-AzureBatchPoolStatistics** cmdlet gets the lifetime statistics for all of the pools in the specified account. -Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics. - -## EXAMPLES - -### Example 1: Get resource statistics of all pools in an account -``` -PS C:\>$Context = Get-AzureRmBatchAccountKeys -AccountName "ContosoBatchAccount" -PS C:\> $PoolStatistics = Get-AzureBatchPoolStatistics -BatchContext $Context -PS C:\> $PoolStatistics.ResourceStatistics -AverageCpuPercentage : 0.351232518750755 -AverageDiskGiB : 55.2569014701165 -AverageMemoryGiB : 2.87273772318252 -DiskReadGiB : 45.1326256990433 -DiskReadIOps : 878278 -DiskWriteGiB : 1230.72120628133 -DiskWriteIOps : 176832212 -LastUpdateTime : 5/16/2016 4:30:00 PM -NetworkReadGiB : 29.3502839952707 -NetworkWriteGiB : 25.5208827350289 -PeakDiskGiB : 21.9638671875 -PeakMemoryGiB : 1.11184692382813 -StartTime : 2/10/2016 7:07:24 PM -``` - -The first command creates an object reference to the account keys for the batch account named ContosoBatchAccount by using **Get-AzureRmBatchAccountKeys**. -The command stores this object reference in the $Context variable. -The second command gets the statistics of all of the pools in the specified account, and then stores them in the $PoolStatistics. -The final command displays the **ResourceStatistics** property of $PoolStatistics. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSPoolStatistics - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[Get-AzureBatchPoolUsageMetrics](./Get-AzureBatchPoolUsageMetrics.md) - -[Get-AzureBatchJobStatistics](./Get-AzureBatchJobStatistics.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchPoolUsageMetrics.md b/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchPoolUsageMetrics.md deleted file mode 100644 index c67593cb0c..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchPoolUsageMetrics.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 4B373447-3078-4C1F-932E-8337AB170DEB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/get-azurebatchpoolusagemetrics -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPoolUsageMetrics.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPoolUsageMetrics.md ---- - -# Get-AzureBatchPoolUsageMetrics - -## SYNOPSIS -Gets pool usage metrics for a Batch account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureBatchPoolUsageMetrics [-StartTime ] [-EndTime ] [-Filter ] - -BatchContext [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureBatchPoolUsageMetrics** cmdlet gets the usage metrics, aggregated by pool across individual time intervals, for the specified account. -You can get the statistics for a specific pool and for a time range. - -## EXAMPLES - -### Example 1: Get pool usage metrics for a time range -``` -PS C:\>$Context = Get-AzureRmBatchAccountKeys -AccountName "ContosoBatchAccount" -PS C:\> $StartTime = Get-Date -Date "2016-05-16 00:00:00Z" -PS C:\> $EndTime = Get-Date -Date "2016-05-16 01:00:00Z" -PS C:\> Get-AzureBatchPoolUsageMetrics -StartTime $StartTime -EndTime $EndTime -BatchContext $context -DataEgressGiB : 6.68875873088837E-06 -DataIngressGiB : 1.9485130906105E-05 -EndTime : 5/16/2016 12:30:00 AM -PoolId : testpool1 -StartTime : 5/16/2016 12:00:00 AM -TotalCoreHours : 8 -VirtualMachineSize : standard_d4 - -DataEgressGiB : 5.61587512493134E-06 -DataIngressGiB : 1.76150351762772E-05 -EndTime : 5/16/2016 12:30:00 AM -PoolId : testpool2 -StartTime : 5/16/2016 12:00:00 AM -TotalCoreHours : 12 -VirtualMachineSize : standard_d4 - -DataEgressGiB : 7.36676156520844E-06 -DataIngressGiB : 2.10804864764214E-05 -EndTime : 5/16/2016 1:00:00 AM -PoolId : testpool1 -StartTime : 5/16/2016 12:30:00 AM -TotalCoreHours : 7.99999999955555 -VirtualMachineSize : standard_d4 - -DataEgressGiB : 5.80586493015289E-06 -DataIngressGiB : 1.80602073669434E-05 -EndTime : 5/16/2016 1:00:00 AM -PoolId : testpool2 -StartTime : 5/16/2016 12:30:00 AM -TotalCoreHours : 11.9999999993333 -VirtualMachineSize : standard_d4 -``` - -The first command creates an object reference to the account keys for the batch account named ContosoBatchAccount by using **Get-AzureRmBatchAccountKeys**. -The command stores this object reference in the $Context variable. -The next two commands create **DateTime** objects by using the Get-Date cmdlet. -The commands store these values in the $StartTime and $EndTime variables for use with the final command. -The final command returns all of the pool usage metrics, aggregated by pool, across time interval between the specified start and end times. - -### Example 2: Get pool usage metrics by using a filter -``` -PS C:\>Get-AzureBatchPoolUsageMetrics -Filter "poolId eq 'ContosoPool'" -BatchContext $Context -DataEgressGiB : 9.0496614575386E-06 -DataIngressGiB : 2.60043889284134E-05 -EndTime : 5/16/2016 5:30:00 PM -PoolId : MyPool -StartTime : 5/16/2016 5:00:00 PM -TotalCoreHours : 12 -VirtualMachineSize : standard_d4 -``` - -This command returns the usage metrics for pool named ContosoPool. -The command specifies a filter string to specify that pool, and uses the same $Context value as the previous example. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndTime -Specifies the end of a time range for which this cmdlet gets usage metrics. -Specify a time at least two hours earlier. -If you do not specify an end time, this cmdlet uses the last aggregation interval currently available. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies an OData filter clause to use to filter the metrics that this cmdlet retruns. -The only valid property is **poolId** with a string value. -Possible operations are the following: eq, ge, gt, le, lt, startswith. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Specifies the start of a time range for which this cmdlet gets usage metrics. -Specify a time at least two and a half hours earlier. -If you do not specify a start time, this cmdlet uses the last aggregation interval currently available. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSPoolUsageMetrics - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[Get-AzureBatchPoolStatistics](./Get-AzureBatchPoolStatistics.md) - -[Get-AzureBatchJobStatistics](./Get-AzureBatchJobStatistics.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchRemoteDesktopProtocolFile.md b/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchRemoteDesktopProtocolFile.md deleted file mode 100644 index f4f070b616..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchRemoteDesktopProtocolFile.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: D077DB50-12BC-45AB-8EAC-57810DA83035 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/get-azurebatchremotedesktopprotocolfile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchRemoteDesktopProtocolFile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchRemoteDesktopProtocolFile.md ---- - -# Get-AzureBatchRemoteDesktopProtocolFile - -## SYNOPSIS -Gets an RDP file from a compute node. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Id_Path (Default) -``` -Get-AzureBatchRemoteDesktopProtocolFile [-PoolId] [-ComputeNodeId] -DestinationPath - -BatchContext [-DefaultProfile ] [] -``` - -### Id_Stream -``` -Get-AzureBatchRemoteDesktopProtocolFile [-PoolId] [-ComputeNodeId] - -DestinationStream -BatchContext [-DefaultProfile ] - [] -``` - -### InputObject_Path -``` -Get-AzureBatchRemoteDesktopProtocolFile [[-ComputeNode] ] -DestinationPath - -BatchContext [-DefaultProfile ] [] -``` - -### InputObject_Stream -``` -Get-AzureBatchRemoteDesktopProtocolFile [[-ComputeNode] ] -DestinationStream - -BatchContext [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureBatchRemoteDesktopProtocolFile** cmdlet gets a Remote Desktop Protocol (RDP) file from a compute node and saves it as a file or to a user supplied stream. - -## EXAMPLES - -### Example 1: Get an RDP file from a specified compute node and save the file -``` -PS C:\>Get-AzureBatchRemoteDesktopProtocolFile -PoolId "Pool06" -ComputeNodeId "ComputeNode01" -DestinationPath "C:\PowerShell\ComputeNode01.rdp" -BatchContext $Context -``` - -This command gets an RDP file from the compute node that has the ID ComputeNode01 in the pool that has the ID Pool06. -The command saves the .rdp file as C:\PowerShell\MyComputeNode.rdp. -Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable. - -### Example 2: Get an RDP file from a compute node and save the file by using the pipeline -``` -PS C:\>Get-AzureBatchComputeNode -PoolId "Pool06" -Id "ComputeNode02" -BatchContext $Context | Get-AzureBatchRemoteDesktopProtocolFile -DestinationPath "C:\PowerShell\MyComputeNode02.rdp" -BatchContext $Context -``` - -This command gets the compute node that has the ID ComputeNode02 in the pool that has the ID Pool06. -The command passes that compute node to the current cmdlet by using the pipeline operator. -The current cmdlet gets an .rpd file from the compute node, and then saves the contents as a file that is named C:\PowerShell\MyComputeNode02.rdp. - -### Example 3: Get a RDP file from a specified compute node and direct it to a stream -``` -PS C:\>$Stream = New-Object -TypeName "System.IO.MemoryStream" -PS C:\> Get-AzureBatchRemoteDesktopProtocolFile "Pool06" -ComputeNodeId "ComputeNode03" -DestinationStream $Stream -BatchContext $Context -``` - -The first command creates a stream by using the New-Object cmdlet, and then stores it in the $Stream variable. -The second command gets an .rdp file from the compute node that has the ID ComputeNode03 in the pool that has the ID Pool06. -The command directs file contents to the stream in $Stream. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ComputeNode -Specifies a compute node, as a **PSComputeNode** object, to which the .rdp file points. -To obtain a compute node object, use the Get-AzureBatchComputeNode cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSComputeNode -Parameter Sets: InputObject_Path, InputObject_Stream -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ComputeNodeId -Specifies the ID of the compute node to which the .rdp file points. - -```yaml -Type: System.String -Parameter Sets: Id_Path, Id_Stream -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationPath -Specifies the file path where this cmdlet saves the .rdp file. - -```yaml -Type: System.String -Parameter Sets: Id_Path, InputObject_Path -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationStream -Specifies the stream into which this cmdlet directs the RDP data. -This cmdlet does not close or rewind this stream. - -```yaml -Type: System.IO.Stream -Parameter Sets: Id_Stream, InputObject_Stream -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PoolId -Specifies the ID of the pool that contains the compute node from which this cmdlet gets an .rdp file. - -```yaml -Type: System.String -Parameter Sets: Id_Path, Id_Stream -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.Models.PSComputeNode -Parameters: ComputeNode (ByValue) - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[Get-AzureBatchComputeNode](./Get-AzureBatchComputeNode.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchRemoteLoginSettings.md b/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchRemoteLoginSettings.md deleted file mode 100644 index e1a192c459..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchRemoteLoginSettings.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 07811B64-6A77-452C-B148-DE8C13E73DEF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/get-azurebatchremoteloginsettings -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchRemoteLoginSettings.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchRemoteLoginSettings.md ---- - -# Get-AzureBatchRemoteLoginSettings - -## SYNOPSIS -Gets remote logon settings for a compute node. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Id (Default) -``` -Get-AzureBatchRemoteLoginSettings [-PoolId] [-ComputeNodeId] - -BatchContext [-DefaultProfile ] [] -``` - -### InputObject -``` -Get-AzureBatchRemoteLoginSettings [[-ComputeNode] ] -BatchContext - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureBatchRemoteLoginSettings** cmdlet gets remote logon settings for a compute node in a virtual machines infrastructure-based pool. - -## EXAMPLES - -### Example 1: Get remote logon settings for all nodes in a pool -``` -PS C:\>$Context = Get-AzureRmBatchAccountKeys -AccountName "ContosoBatchAccount" -PS C:\> Get-AzureBatchComputeNode -PoolId "ContosoPool" -BatchContext $Context | Get-AzureBatchRemoteLoginSettings -BatchContext $Context -IPAddress Port ---------- ---- -10.214.75.221 50002 -10.214.75.221 50001 -10.214.75.221 50000 -``` - -The first command gets a batch account context that contains access keys for your subscription by using **Get-AzureRmBatchAccountKeys**. -The command stores the context in the $Context variable to use in the next command. -The second command gets each compute node in the pool that has the ID ContosoPool by using **Get-AzureBatchComputeNode**. -The command passes each computer node to the current cmdlet by using the pipeline operator. -The command gets the remote logon settings for each compute node. - -### Example 2: Get remote logon settings for a node -``` -PS C:\>$Context = Get-AzureRmBatchAccountKeys -AccountName "ContosoBatchAccount" -PS C:\> Get-AzureBatchRemoteLoginSettings -PoolId "ContosoPool" -ComputeNodeId "tvm-1900272697_1-20150330t205553z" -BatchContext $Context -IPAddress Port ---------- ---- -10.214.75.221 50000 -``` - -The first command gets a batch account context that contains access keys for your subscription, and then stores it in the $Context variable. -The second command gets the remote logon settings for the compute node that has the specified ID in the pool that has the ID ContosoPool. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -To obtain a **BatchAccountContext** that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ComputeNode -Specifies a compute node, as a **PSComputeNode** object, for which this cmdlet gets remote logon settings. -To obtain a compute node object, use the Get-AzureBatchComputeNode cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSComputeNode -Parameter Sets: InputObject -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ComputeNodeId -Specifies the ID of the compute node for which to get the remote logon settings. -for which this cmdlet gets remote logon settings. - -```yaml -Type: System.String -Parameter Sets: Id -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PoolId -Specifies the ID of the pool that contains the virtual machine. - -```yaml -Type: System.String -Parameter Sets: Id -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSComputeNode -Parameters: ComputeNode (ByValue) - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSRemoteLoginSettings - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[Get-AzureBatchComputeNode](./Get-AzureBatchComputeNode.md) - -[Get-AzureBatchRemoteDesktopProtocolFile](./Get-AzureBatchRemoteDesktopProtocolFile.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) - - diff --git a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchSubtask.md b/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchSubtask.md deleted file mode 100644 index ef9c7a9fa1..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchSubtask.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 7D0D8B46-4BF0-47D5-9261-3306AEB9E7DD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/get-azurebatchsubtask -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchSubtask.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchSubtask.md ---- - -# Get-AzureBatchSubtask - -## SYNOPSIS -Gets the subtask information of the specified task. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ODataFilter (Default) -``` -Get-AzureBatchSubtask [-JobId] [-TaskId] [-MaxCount ] - -BatchContext [-DefaultProfile ] [] -``` - -### ParentObject -``` -Get-AzureBatchSubtask [[-Task] ] [-MaxCount ] -BatchContext - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureBatchSubtask** cmdlet retrieves the subtask information about the specified task. -Subtasks provide parallel processing for individual tasks, and enable precise monitoring of task execution and progress. - -## EXAMPLES - -### Example 1: Return all subtasks for a specified task -``` -PS C:\>$Context = Get-AzureRmBatchAccountKeys -AccountName "contosobatchaccount" -PS C:\> Get-AzureBatchSubtask -JobId "Job-01" -TaskID "myTask" -BatchContext $Context -``` - -These commands return all the subtasks for the task with the ID myTask. -To do this, the first command in the example creates an object reference to the account keys for the batch account contosobatchaccount. -This object reference is stored in a variable named $context. -The second command then uses that object reference and the **Get-AzureBatchSubtask** cmdlet to return all the subtasks for myTask, a task that runs as part of job Job-01. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobId -Specifies the ID of the job that contains the task whose subtasks this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: ODataFilter -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaxCount -Specifies the maximum number of subtasks to return. -If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. -The default value is 1000. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Task -Specifies an object reference to the task that contain the subtasks that this cmdlet returns. -This object reference is created by using the Get-AzureBatchTask cmdlet and storing the returned object in a variable. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSCloudTask -Parameter Sets: ParentObject -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TaskId -Specifies the ID of the task whose subtasks this cmdlet returns. - -```yaml -Type: System.String -Parameter Sets: ODataFilter -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.Models.PSCloudTask -Parameters: Task (ByValue) - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSSubtaskInformation - -## NOTES - -## RELATED LINKS - -[Get-AzureBatchTask](./Get-AzureBatchTask.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchTask.md b/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchTask.md deleted file mode 100644 index bf0abff63d..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchTask.md +++ /dev/null @@ -1,295 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 4B5FE41A-090B-4859-B021-05CF0A8B7882 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/get-azurebatchtask -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchTask.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchTask.md ---- - -# Get-AzureBatchTask - -## SYNOPSIS -Gets the Batch tasks for a job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ODataFilter (Default) -``` -Get-AzureBatchTask [-JobId] [-Filter ] [-MaxCount ] [-Select ] - [-Expand ] -BatchContext [-DefaultProfile ] - [] -``` - -### Id -``` -Get-AzureBatchTask [-JobId] [[-Id] ] [-Select ] [-Expand ] - -BatchContext [-DefaultProfile ] [] -``` - -### ParentObject -``` -Get-AzureBatchTask [[-Job] ] [-Filter ] [-MaxCount ] [-Select ] - [-Expand ] -BatchContext [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Get-AzureBatchTask** cmdlet gets Azure Batch tasks for a Batch job. -Specify a job by either the *JobId* parameter or the *Job* parameter. -To get a single task, specify the *Id* parameter. -You can specify the *Filter* parameter to get the tasks that match an Open Data Protocol (OData) filter. - -## EXAMPLES - -### Example 1: Get a task by ID -``` -PS C:\>Get-AzureBatchTask -JobId "Job01" -Id "Task03" -BatchContext $Context -AffinityInformation : -CommandLine : cmd /c dir /s -ComputeNodeInformation : Microsoft.Azure.Commands.Batch.Models.PSComputeNodeInformation -Constraints : Microsoft.Azure.Commands.Batch.Models.PSTaskConstraints -CreationTime : 7/25/2015 11:24:52 PM -DisplayName : -EnvironmentSettings : -ETag : 0x8D295483E08BD9D -ExecutionInformation : Microsoft.Azure.Commands.Batch.Models.PSTaskExecutionInformation -Id : Task03 -LastModified : 7/25/2015 11:24:52 PM -PreviousState : Running -PreviousStateTransitionTime : 7/25/2015 11:24:59 PM -ResourceFiles : -RunElevated : False -State : Completed -StateTransitionTime : 7/25/2015 11:24:59 PM -Statistics : -Url : https://pfuller.westus.batch.azure.com/jobs/Job01/tasks/Task03 -``` - -This command gets the task with ID Task03 under job Job01. -Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable. - -### Example 2: Get all completed tasks from a specified job -``` -PS C:\>Get-AzureBatchTask -JobId "Job02" -Filter "state eq 'completed'" -BatchContext $Context -AffinityInformation : -CommandLine : cmd /c dir /s -ComputeNodeInformation : Microsoft.Azure.Commands.Batch.Models.PSComputeNodeInformation -Constraints : Microsoft.Azure.Commands.Batch.Models.PSTaskConstraints -CreationTime : 3/24/2015 10:21:51 PM -EnvironmentSettings : -ETag : 0x8D295483E08BD9D -ExecutionInformation : Microsoft.Azure.Commands.Batch.Models.PSTaskExecutionInformation -Id : Task17 -LastModified : 3/24/2015 10:21:51 PM -PreviousState : Running -PreviousStateTransitionTime : 3/24/2015 10:22:00 PM -ResourceFiles : -RunElevated : False -State : Completed -StateTransitionTime : 3/24/2015 10:22:00 PM -Statistics : -Url : https://pfuller.westus.batch.azure.com/jobs/Job02/tasks/Task17 - -AffinityInformation : -CommandLine : cmd /c echo hello > newFile.txt -ComputeNodeInformation : Microsoft.Azure.Commands.Batch.Models.PSComputeNodeInformation -Constraints : Microsoft.Azure.Commands.Batch.Models.PSTaskConstraints -CreationTime : 3/24/2015 10:21:51 PM -EnvironmentSettings : -ETag : 0x8D295483E08BD9D -ExecutionInformation : Microsoft.Azure.Commands.Batch.Models.PSTaskExecutionInformation -Id : Task27 -LastModified : 3/24/2015 10:23:35 PM -PreviousState : Running -PreviousStateTransitionTime : 3/24/2015 10:23:37 PM -ResourceFiles : -RunElevated : True -State : Completed -StateTransitionTime : 3/24/2015 10:23:37 PM -Statistics : -Url : https://pfuller.westus.batch.azure.com/jobs/Job02/tasks/Task27 -``` - -This command gets the completed tasks from the job that has the ID Job02. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expand -Specifies an OData expand clause. -Specify a value for this parameter to get associated entities of the main entity to get. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies an OData filter clause for tasks. -If you do not specify a filter, this cmdlet returns all tasks for the Batch account or job. - -```yaml -Type: System.String -Parameter Sets: ODataFilter, ParentObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the task that this cmdlet gets. -You cannot specify wildcard characters. - -```yaml -Type: System.String -Parameter Sets: Id -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Job -Specifies the job that contains tasks that this cmdlet gets. -To obtain a **PSCloudJob** object, use the Get-AzureBatchJob cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSCloudJob -Parameter Sets: ParentObject -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -JobId -Specifies the ID of the job that contains the tasks that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: ODataFilter, Id -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaxCount -Specifies the maximum number of tasks to return. -If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. -The default value is 1000. - -```yaml -Type: System.Int32 -Parameter Sets: ODataFilter, ParentObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Select -Specifies an OData select clause. -Specify a value for this parameter to get specific properties rather than all object properties. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.Models.PSCloudJob -Parameters: Job (ByValue) - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSCloudTask - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[Get-AzureBatchJob](./Get-AzureBatchJob.md) - -[New-AzureBatchTask](./New-AzureBatchTask.md) - -[Remove-AzureBatchTask](./Remove-AzureBatchTask.md) - -[Stop-AzureBatchTask](./Stop-AzureBatchTask.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchTaskCounts.md b/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchTaskCounts.md deleted file mode 100644 index 70b7477401..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Get-AzureBatchTaskCounts.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/get-azurebatchtaskcounts -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchTaskCounts.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchTaskCounts.md ---- - -# Get-AzureBatchTaskCounts - -## SYNOPSIS -Gets the task counts for the specified job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Id -``` -Get-AzureBatchTaskCounts [-JobId] -BatchContext - [-DefaultProfile ] [] -``` - -### ParentObject -``` -Get-AzureBatchTaskCounts [[-Job] ] -BatchContext - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureBatchTaskCounts** cmdlet gets the Azure Batch tasks count for a Batch job. -Specify a job by either the *JobId* parameter or the *Job* parameter. -Task counts provide a count of the tasks by active, running or completed task state, and a count of tasks which succeeded or failed. Tasks in the preparing state are counted as running. If the validationStatus is unvalidated, then the Batch service has not been able to check state counts against the task states as reported in the List Tasks API. The validationStatus may be unvalidated if the job contains more than 200,000 tasks. - -## EXAMPLES - -### Example 1: Get task counts by ID -``` -PS C:\> Get-AzureBatchTaskCounts -JobId "Job01" -Id "Task03" -BatchContext $Context -Active : 1 -Completed : 0 -Failed : 0 -Running : 1 -Succeeded : 5 -ValidationStatus : Validated -``` - -This command gets the task counts for job Job01. -Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable. - -## PARAMETERS - -### -BatchContext -The BatchAccountContext instance to use when interacting with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. -To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. -When using shared key authentication, the primary access key is used by default. -To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Job -Specifies the job that contains tasks that this cmdlet gets. -To obtain a **PSCloudJob** object, use the Get-AzureBatchJob cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSCloudJob -Parameter Sets: ParentObject -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -JobId -The id of the job for which to get task counts. - -```yaml -Type: System.String -Parameter Sets: Id -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.Models.PSCloudJob -Parameters: Job (ByValue) - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSTaskCounts - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[Get-AzureBatchJob](./Get-AzureBatchJob.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Get-AzureRmBatchAccount.md b/azurermps-6.13.0/AzureRM.Batch/Get-AzureRmBatchAccount.md deleted file mode 100644 index 053c91e3ef..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Get-AzureRmBatchAccount.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 818D5D85-B6D5-458C-A26E-E4DE8E111A10 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/get-azurermbatchaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchAccount.md ---- - -# Get-AzureRmBatchAccount - -## SYNOPSIS -Gets a Batch account in the current subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmBatchAccount [[-AccountName] ] [[-ResourceGroupName] ] [[-Tag] ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmBatchAccount** cmdlet gets an Azure Batch account in the current subscription. You -can use the *AccountName* parameter to get a single account, or you can use the *ResourceGroupName* -parameter to get accounts under that resource group. - -## EXAMPLES - -### Example 1: Get a batch account by name -``` -PS C:\>Get-AzureRmBatchAccount -AccountName "pfuller" -AccountName : pfuller -Location : westus -ResourceGroupName : CmdletExampleRG -CoreQuota : 20 -PoolQuota : 20 -ActiveJobAndJobScheduleQuota : 20 -Tags : -TaskTenantUrl : https://pfuller.westus.batch.azure.com -``` - -This command gets the batch account named pfuller. - -### Example 2: Get the batch accounts associated with a resource group -``` -PS C:\>Get-AzureRmBatchAccount -ResourceGroupName "CmdletExampleRG" -AccountName : cmdletexample -Location : westus -ResourceGroupName : CmdletExampleRG -CoreQuota : 20 -PoolQuota : 20 -ActiveJobAndJobScheduleQuota : 20 -Tags : -TaskTenantUrl : https://cmdletexample.westus.batch.azure.com -AccountName : cmdletexample2 -Location : westus -ResourceGroupName : CmdletExampleRG -CoreQuota : 20 -PoolQuota : 20 -ActiveJobAndJobScheduleQuota : 20 -Tags : -TaskTenantUrl : https://cmdletexample.westus.batch.azure.com -``` - -This command gets the batch accounts associated with the CmdletExampleRG resource group. - -## PARAMETERS - -### -AccountName -Specifies the name of an account. -If you specify an account name, this cmdlet only returns that account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. -If you specify a resource group, this cmdlet gets the accounts under the specified resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} -This cmdlet gets accounts that contain the tags that this parameter specifies. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.Batch.BatchAccountContext - -## NOTES - -## RELATED LINKS - -[New-AzureRmBatchAccount](./New-AzureRmBatchAccount.md) - -[Remove-AzureRmBatchAccount](./Remove-AzureRmBatchAccount.md) - -[Set-AzureRmBatchAccount](./Set-AzureRmBatchAccount.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Get-AzureRmBatchAccountKeys.md b/azurermps-6.13.0/AzureRM.Batch/Get-AzureRmBatchAccountKeys.md deleted file mode 100644 index c4150aa8de..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Get-AzureRmBatchAccountKeys.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: AFDE5ECD-29AB-4C91-98BF-1B8C9C3BB079 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/get-azurermbatchaccountkeys -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchAccountKeys.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchAccountKeys.md ---- - -# Get-AzureRmBatchAccountKeys - -## SYNOPSIS -Gets the keys of a Batch account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmBatchAccountKeys [-AccountName] [-ResourceGroupName ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmBatchAccountKeys** cmdlet gets the keys of an Azure Batch account in the current subscription. - -## EXAMPLES - -## PARAMETERS - -### -AccountName -Specifies the name of the account for which this cmdlet gets keys. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the account for which this cmdlet gets keys. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Batch.BatchAccountContext - -## NOTES - -## RELATED LINKS - -[New-AzureRmBatchAccountKey](./New-AzureRmBatchAccountKey.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) - - diff --git a/azurermps-6.13.0/AzureRM.Batch/Get-AzureRmBatchApplication.md b/azurermps-6.13.0/AzureRM.Batch/Get-AzureRmBatchApplication.md deleted file mode 100644 index c398348e08..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Get-AzureRmBatchApplication.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: CF8B8E94-3C6C-4D68-B55B-956393890946 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/get-azurermbatchapplication -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchApplication.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchApplication.md ---- - -# Get-AzureRmBatchApplication - -## SYNOPSIS -Gets information about the specified application. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmBatchApplication [-AccountName] [-ResourceGroupName] [[-ApplicationId] ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmBatchApplication** cmdlet gets information about an application in an Azure Batch account. - -## EXAMPLES - -### Example 1: Display the applications in a Batch account -``` -PS C:\>Get-AzureRmBatchApplication -AccountName "ContosoBatch" -ResourceGroupName "ContosoBatchGroup" -ApplicationId AllowUpdates DisplayName - -------------- ------------ ---------------------------- - -litware False Litware Advanced Reticulator -``` - -This command displays all applications in the ContosoBatch account. - -## PARAMETERS - -### -AccountName -Specifies the name of the Batch account that contains the application. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationId -Specifies the ID of the application. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the Batch account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSApplication - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchApplicationPackage](./Get-AzureRmBatchApplicationPackage.md) - -[New-AzureRmBatchApplication](./New-AzureRmBatchApplication.md) - -[New-AzureRmBatchApplicationPackage](./New-AzureRmBatchApplicationPackage.md) - -[Remove-AzureRmBatchApplication](./Remove-AzureRmBatchApplication.md) - -[Remove-AzureRmBatchApplicationPackage](./Remove-AzureRmBatchApplicationPackage.md) - -[Set-AzureRmBatchApplication](./Set-AzureRmBatchApplication.md) - - diff --git a/azurermps-6.13.0/AzureRM.Batch/Get-AzureRmBatchApplicationPackage.md b/azurermps-6.13.0/AzureRM.Batch/Get-AzureRmBatchApplicationPackage.md deleted file mode 100644 index e35f3fc6af..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Get-AzureRmBatchApplicationPackage.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 17653793-3CE1-465F-87F7-20B4B8F56193 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/get-azurermbatchapplicationpackage -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchApplicationPackage.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchApplicationPackage.md ---- - -# Get-AzureRmBatchApplicationPackage - -## SYNOPSIS -Gets information about an application package in a Batch account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmBatchApplicationPackage [-AccountName] [-ResourceGroupName] - [-ApplicationId] [-ApplicationVersion] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Get-AzureRmBatchApplicationPackage** cmdlet gets information about an application package in an Azure Batch account. - -## EXAMPLES - -### Example 1: Get details of an application package in a Batch account -``` -PS C:\>Get-AzureRmBatchApplicationPackage -AccountName "ContosoBatch" -ResourceGroupName "ContosoBatchGroup" -ApplicationId "Litware" -ApplicationVersion "1.0" -Format : zip -State : Active -Version : 1.0 -LastActivationTime : 13/05/2016 4:03:24 AM -StorageUrl : https://contosobatch.blob.core.windows.net/app-test -StorageUrlExpiry : 13/05/2016 8:04:44 AM -Id : litware -``` - -This command gets the details of version 1.0 of the Litware package. - -## PARAMETERS - -### -AccountName -Specifies the name of the Batch account from which this cmdlet gets information. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationId -Specifies the ID of the application. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationVersion -Specifies the version of the application. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the Batch account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSApplicationPackage - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchApplication](./Get-AzureRmBatchApplication.md) - -[New-AzureRmBatchApplication](./New-AzureRmBatchApplication.md) - -[New-AzureRmBatchApplicationPackage](./New-AzureRmBatchApplicationPackage.md) - -[Remove-AzureRmBatchApplication](./Remove-AzureRmBatchApplication.md) - -[Remove-AzureRmBatchApplicationPackage](./Remove-AzureRmBatchApplicationPackage.md) - -[Set-AzureRmBatchApplication](./Set-AzureRmBatchApplication.md) - - diff --git a/azurermps-6.13.0/AzureRM.Batch/Get-AzureRmBatchLocationQuotas.md b/azurermps-6.13.0/AzureRM.Batch/Get-AzureRmBatchLocationQuotas.md deleted file mode 100644 index c03ac52590..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Get-AzureRmBatchLocationQuotas.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: A39A415A-B403-48D3-AF80-CF7CFE382577 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/get-azurermbatchlocationquotas -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchLocationQuotas.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchLocationQuotas.md ---- - -# Get-AzureRmBatchLocationQuotas - -## SYNOPSIS -Gets the Batch service quotas for your subscription at the given location. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmBatchLocationQuotas [-Location] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -Gets the Batch service quotas for the specified subscription at the given location. - -## EXAMPLES - -### Example 1: Get the Batch service quotas for the subscription in the West US region -``` -PS C:\>Get-AzureRmBatchLocationQuotas -Location "westus" - AccountQuota Location - ------------ -------- - 1 westus -``` - -This command gets the quotas for the current subscription in the West US region. -The return value indicates that this subscription can create only one Batch account in that region. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the region for which this cmdlet checks the quotas. -For more information, see Azure Regions (https://azure.microsoft.com/regions). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSBatchLocationQuotas - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Batch/New-AzureBatchCertificate.md b/azurermps-6.13.0/AzureRM.Batch/New-AzureBatchCertificate.md deleted file mode 100644 index 28d611861a..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/New-AzureBatchCertificate.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: B423C1A1-1988-4721-81E7-3B7EC163B03A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/new-azurebatchcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchCertificate.md ---- - -# New-AzureBatchCertificate - -## SYNOPSIS -Adds a certificate to the specified Batch account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### File (Default) -``` -New-AzureBatchCertificate [-FilePath] [-Password ] -BatchContext - [-DefaultProfile ] [] -``` - -### RawData -``` -New-AzureBatchCertificate [-RawData] [-Password ] -BatchContext - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureBatchCertificate** cmdlet adds a certificate to the specified Azure Batch account. - -## EXAMPLES - -### Example 1: Add a certificate from a file -``` -PS C:\>New-AzureBatchCertificate -FilePath "E:\Certificates\MyCert.cer" -BatchContext $Context -``` - -This command adds a certificate to the specified Batch account by using the file E:\Certificates\MyCert.cer. - -### Example 2: Add a certificate from raw data -``` -PS C:\>$RawData = [System.IO.File]::ReadAllBytes("E:\Certificates\MyCert.pfx") -PS C:\> New-AzureBatchCertificate -RawData $RawData -Password "Password1234" -BatchContext $Context -``` - -The first command reads the data from the file named MyCert.pfx into the $RawData variable. -The second command adds a certificate to the specified Batch account using the raw data stored in $RawData. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FilePath -Specifies the path of the certificate file. -The certificate file must be in either .cer or .pfx format. - -```yaml -Type: System.String -Parameter Sets: File -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -Specifies the password to access the certificate private key. -You must specify this parameter if you specify a certificate in .pfx format. - -```yaml -Type: System.Security.SecureString -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RawData -Specifies the raw certificate data in either .cer or .pfx format. - -```yaml -Type: System.Byte[] -Parameter Sets: RawData -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Byte[] - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureBatchCertificate](./Get-AzureBatchCertificate.md) - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[Remove-AzureBatchCertificate](./Remove-AzureBatchCertificate.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/New-AzureBatchComputeNodeUser.md b/azurermps-6.13.0/AzureRM.Batch/New-AzureBatchComputeNodeUser.md deleted file mode 100644 index 5394f9c90f..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/New-AzureBatchComputeNodeUser.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: FE7689DE-4EC6-4C6B-94A4-D22C61CA569D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/new-azurebatchcomputenodeuser -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchComputeNodeUser.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchComputeNodeUser.md ---- - -# New-AzureBatchComputeNodeUser - -## SYNOPSIS -Creates a user account on a Batch compute node. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Id -``` -New-AzureBatchComputeNodeUser [-PoolId] [-ComputeNodeId] -Name - -Password [-ExpiryTime ] [-IsAdmin] -BatchContext - [-DefaultProfile ] [] -``` - -### ParentObject -``` -New-AzureBatchComputeNodeUser [[-ComputeNode] ] -Name -Password - [-ExpiryTime ] [-IsAdmin] -BatchContext - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureBatchComputeNodeUser** cmdlet creates a user account on an Azure Batch compute node. - -## EXAMPLES - -### Example 1: Create a user account that has administrative credentials -``` -PS C:\>New-AzureBatchComputeNodeUser -PoolId "MyPool01" -ComputeNodeId "ComputeNode01" -Name "TestUser" -Password "Password" -ExpiryTime ([DateTime]::Now.AddDays(7)) -IsAdmin -BatchContext $Context -``` - -This command creates a user account on the compute node that has the ID ComputeNode01. -The node is in the pool that has the ID MyPool01. -The user name is TestUser, the password is Password, the account expires in seven days, and the account is has administrative credentials. - -### Example 2: Create a user account on a compute node by using the pipeline -``` -PS C:\>Get-AzureBatchComputeNode "MyPool01" -ComputeNodeId "ComputeNode01" -BatchContext $Context | New-AzureBatchComputeNodeUser -Name "TestUser" -Password "Password" -BatchContext $Context -``` - -This command gets the compute node named ComputeNode01 by using the **Get-AzureBatchComputeNode** cmdlet. -That node is in the pool that has the ID MyPool01. -The command passes that compute node to the current cmdlet by using the pipeline operator. -The command creates a user account that has the user name TestUserand the password Password. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ComputeNode -Specifies the compute node, as a **PSComputeNode** object, on which this cmdlet creates a user account. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSComputeNode -Parameter Sets: ParentObject -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ComputeNodeId -Specifies the ID of the compute node on which this cmdlet creates a user account. - -```yaml -Type: System.String -Parameter Sets: Id -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpiryTime -Specifies the expiry time for the new user account. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsAdmin -Indicates that the cmdlet creates a user account that has administrative credentials. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the new local Windows account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -Specifies the user account password. - -```yaml -Type: System.Security.SecureString -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PoolId -Specifies the ID of the pool that contains the compute node on which to create the user account. - -```yaml -Type: System.String -Parameter Sets: Id -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSComputeNode -Parameters: ComputeNode (ByValue) - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[Get-AzureBatchComputeNode](./Get-AzureBatchComputeNode.md) - -[Remove-AzureBatchComputeNodeUser](./Remove-AzureBatchComputeNodeUser.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/New-AzureBatchJob.md b/azurermps-6.13.0/AzureRM.Batch/New-AzureBatchJob.md deleted file mode 100644 index d68ffab744..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/New-AzureBatchJob.md +++ /dev/null @@ -1,320 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: B6229D26-D38C-44CD-B9CA-7F39365C8B9D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/new-azurebatchjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchJob.md ---- - -# New-AzureBatchJob - -## SYNOPSIS -Creates a job in the Batch service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureBatchJob [-Id] [-CommonEnvironmentSettings ] [-DisplayName ] - [-Constraints ] [-JobManagerTask ] - [-JobPreparationTask ] [-JobReleaseTask ] [-Metadata ] - -PoolInformation [-Priority ] [-UsesTaskDependencies] - [-OnTaskFailure ] [-OnAllTasksComplete ] - -BatchContext [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureBatchJob** cmdlet creates a job in the Azure Batch service in the account specified by the *BatchAccountContext* parameter. - -## EXAMPLES - -### Example 1: Create a job -``` -PS C:\>$PoolInformation = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSPoolInformation" -PS C:\> $PoolInformation.PoolId = "Pool22" -PS C:\> New-AzureBatchJob -Id "ContosoJob35" -PoolInformation $PoolInformation -BatchContext $Context -``` - -The first command creates a **PSPoolInformation** object by using the New-Object cmdlet. -The command stores that object in the $PoolInformation variable. -The second command assigns the ID Pool22 to the **PoolId** property of the object in $PoolInformation. -The final command creates a job that has the ID ContosoJob35. -Tasks added to the job run on the pool that has the ID Pool22. -Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CommonEnvironmentSettings -Specifies the common environment variables, as key/value pairs, that this cmdlet sets for all tasks in the job. -The key is the environment variable name. -The value is the environment variable value. - -```yaml -Type: System.Collections.IDictionary -Parameter Sets: (All) -Aliases: CommonEnvironmentSetting - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Constraints -Specifies the execution constraints for the job. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSJobConstraints -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the display name for the job. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies an ID for the job. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -JobManagerTask -Specifies the Job Manager task. -The Batch service runs the Job Manager task when the job is started. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSJobManagerTask -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobPreparationTask -Specifies the Job Preparation task. -The Batch service runs the Job Preparation task on a compute node before it starts any tasks of that job on that compute node. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSJobPreparationTask -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobReleaseTask -Specifies the Job Release task. -The Batch service runs the Job Release task when the job ends. -The Batch service runs the Job Release task on each compute node where it ran any task of the job. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSJobReleaseTask -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Metadata -Specifies metadata, as key/value pairs, to add to the job. -The key is the metadata name. -The value is the metadata value. - -```yaml -Type: System.Collections.IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OnAllTasksComplete -Specifies an action the Batch service takes if all tasks in the job are in the completed state. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Batch.Common.OnAllTasksComplete] -Parameter Sets: (All) -Aliases: -Accepted values: NoAction, TerminateJob - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OnTaskFailure -Specifies an action the Batch service takes if any task in the job fails. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Batch.Common.OnTaskFailure] -Parameter Sets: (All) -Aliases: -Accepted values: NoAction, PerformExitOptionsJobAction - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PoolInformation -Specifies the details of the pool on which the Batch service runs the tasks of the job. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSPoolInformation -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -Specifies the priority of the job. -Valid values are: integers from -1000 to 1000. -A value of -1000 is the lowest priority. -A value of 1000 is the highest priority. -The default value is 0. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UsesTaskDependencies -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Disable-AzureBatchJob](./Disable-AzureBatchJob.md) - -[Enable-AzureBatchJob](./Enable-AzureBatchJob.md) - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[Get-AzureBatchJob](./Get-AzureBatchJob.md) - -[Get-AzureBatchJobSchedule](./Get-AzureBatchJobSchedule.md) - -[Remove-AzureBatchJob](./Remove-AzureBatchJob.md) - -[Stop-AzureBatchJob](./Stop-AzureBatchJob.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/New-AzureBatchJobSchedule.md b/azurermps-6.13.0/AzureRM.Batch/New-AzureBatchJobSchedule.md deleted file mode 100644 index 71f894daca..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/New-AzureBatchJobSchedule.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 87E7FA51-427E-4DB8-A6A2-D8638FD3DB8B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/new-azurebatchjobschedule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchJobSchedule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchJobSchedule.md ---- - -# New-AzureBatchJobSchedule - -## SYNOPSIS -Creates a job schedule in the Batch service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureBatchJobSchedule [-Id] [-DisplayName ] -Schedule - -JobSpecification [-Metadata ] -BatchContext - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureBatchJobSchedule** cmdlet creates a job schedule in the Azure Batch service. -The *BatchAccountContext* parameter specifies the account in which this cmdlet creates the schedule. - -## EXAMPLES - -### Example 1: Create a job schedule -``` -PS C:\>$Schedule = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSSchedule" -PS C:\> $Schedule.RecurrenceInterval = [TimeSpan]::FromDays(1) -PS C:\> $JobSpecification = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSJobSpecification" -PS C:\> $JobSpecification.PoolInformation = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSPoolInformation" -PS C:\> $JobSpecification.PoolInformation.PoolId = "ContosoPool06" -PS C:\> New-AzureBatchJobSchedule -Id "JobSchedule17" -Schedule $Schedule -JobSpecification $JobSpecification -BatchContext $Context -``` - -This example creates a job schedule. -The first five commands create and modify **PSSchedule**, **PSJobSpecification**, and **PSPoolInformation** objects. -The commands use the New-Object cmdlet and standard Azure PowerShell syntax. -The commands store these objects in the $Schedule and $JobSpecification variables. -The final command creates a job schedule that has the ID JobSchedule17. -This schedule creates jobs with a recurrence interval of one day. -The jobs run on the pool that has the ID ContosoPool06, as specified in the fifth command. -Use the **Get-AzureRmBatchAccountKeys** cmdlet to assign a context to the $Context variable. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Specifies a display name for the job schedule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the job schedule that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -JobSpecification -Specifies the details of the jobs that this cmdlet includes in the job schedule. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSJobSpecification -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Metadata -Specifies metadata, as key/value pairs, to add to the job schedule. -The key is the metadata name. -The value is the metadata value. - -```yaml -Type: System.Collections.IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Schedule -Specifies the schedule that determines when to create jobs. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSSchedule -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Disable-AzureBatchJobSchedule](./Disable-AzureBatchJobSchedule.md) - -[Enable-AzureBatchJobSchedule](./Enable-AzureBatchJobSchedule.md) - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[Get-AzureBatchJobSchedule](./Get-AzureBatchJobSchedule.md) - -[Remove-AzureBatchJobSchedule](./Remove-AzureBatchJobSchedule.md) - -[Stop-AzureBatchJobSchedule](./Stop-AzureBatchJobSchedule.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/New-AzureBatchPool.md b/azurermps-6.13.0/AzureRM.Batch/New-AzureBatchPool.md deleted file mode 100644 index 7d275a6716..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/New-AzureBatchPool.md +++ /dev/null @@ -1,517 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: C71C486E-34EB-42B5-B38A-D85B7DAA2F74 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/new-azurebatchpool -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchPool.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchPool.md ---- - -# New-AzureBatchPool - -## SYNOPSIS -Creates a pool in the Batch service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### CloudServiceAndTargetDedicated (Default) -``` -New-AzureBatchPool [-Id] -VirtualMachineSize [-DisplayName ] - [-ResizeTimeout ] [-TargetDedicatedComputeNodes ] [-TargetLowPriorityComputeNodes ] - [-MaxTasksPerComputeNode ] [-TaskSchedulingPolicy ] [-Metadata ] - [-InterComputeNodeCommunicationEnabled] [-StartTask ] - [-CertificateReferences ] - [-ApplicationPackageReferences ] - [-ApplicationLicenses ] - [-CloudServiceConfiguration ] [-NetworkConfiguration ] - [-UserAccount ] -BatchContext - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### VirtualMachineAndTargetDedicated -``` -New-AzureBatchPool [-Id] -VirtualMachineSize [-DisplayName ] - [-ResizeTimeout ] [-TargetDedicatedComputeNodes ] [-TargetLowPriorityComputeNodes ] - [-MaxTasksPerComputeNode ] [-TaskSchedulingPolicy ] [-Metadata ] - [-InterComputeNodeCommunicationEnabled] [-StartTask ] - [-CertificateReferences ] - [-ApplicationPackageReferences ] - [-ApplicationLicenses ] - [-VirtualMachineConfiguration ] - [-NetworkConfiguration ] [-UserAccount ] - -BatchContext [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -### CloudServiceAndAutoScale -``` -New-AzureBatchPool [-Id] -VirtualMachineSize [-DisplayName ] - [-AutoScaleEvaluationInterval ] [-AutoScaleFormula ] [-MaxTasksPerComputeNode ] - [-TaskSchedulingPolicy ] [-Metadata ] - [-InterComputeNodeCommunicationEnabled] [-StartTask ] - [-CertificateReferences ] - [-ApplicationPackageReferences ] - [-ApplicationLicenses ] - [-CloudServiceConfiguration ] [-NetworkConfiguration ] - [-UserAccount ] -BatchContext - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### VirtualMachineAndAutoScale -``` -New-AzureBatchPool [-Id] -VirtualMachineSize [-DisplayName ] - [-AutoScaleEvaluationInterval ] [-AutoScaleFormula ] [-MaxTasksPerComputeNode ] - [-TaskSchedulingPolicy ] [-Metadata ] - [-InterComputeNodeCommunicationEnabled] [-StartTask ] - [-CertificateReferences ] - [-ApplicationPackageReferences ] - [-ApplicationLicenses ] - [-VirtualMachineConfiguration ] - [-NetworkConfiguration ] [-UserAccount ] - -BatchContext [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **New-AzureBatchPool** cmdlet creates a pool in the Azure Batch service under the account specified by the *BatchContext* parameter. - -## EXAMPLES - -### Example 1: Create a new pool using the TargetDedicated parameter set using CloudServiceConfiguration -``` -PS C:\>$configuration = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSCloudServiceConfiguration" -ArgumentList @(4,"*") -PS C:\>New-AzureBatchPool -Id "MyPool" -VirtualMachineSize "Small" -CloudServiceConfiguration $configuration -TargetDedicatedComputeNodes 3 -BatchContext $Context -``` - -### Example 2: Create a new pool using the TargetDedicated parameter set using VirtualMachineConfiguration -``` -PS C:\$imageReference = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSImageReference" -ArgumentList @("WindowsServer", "MicrosoftWindowsServer", "2016-Datacenter", "*") -PS C:\>$configuration = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.VirtualMachineConfiguration" -ArgumentList @($imageReference, "batch.node.windows amd64") -PS C:\>New-AzureBatchPool -Id "MyPool" -VirtualMachineSize "Small" -VirtualMachineConfiguration $configuration -TargetDedicatedComputeNodes 3 -BatchContext $Context -``` - -This command creates a new pool with ID MyPool using the TargetDedicated parameter set. -The target allocation is three compute nodes. -The pool is configured to use small virtual machines imaged with the latest operating system version of family four. - -### Example 3: Create a new pool using the AutoScale parameter set -``` -PS C:\$imageReference = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSImageReference" -ArgumentList @("WindowsServer", "MicrosoftWindowsServer", "2016-Datacenter", "*") -PS C:\>$configuration = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.VirtualMachineConfiguration" -ArgumentList @($imageReference, "batch.node.windows amd64") -PS C:\>New-AzureBatchPool -Id "AutoScalePool" -VirtualMachineSize "Small" -VirtualMachineConfiguration $configuration -AutoScaleFormula '$TargetDedicated=2;' -BatchContext $Context -``` - -This command creates a new pool with ID AutoScalePool using the AutoScale parameter set. -The pool is configured to use small virtual machines imaged with the latest operating system version of family four, and the target number of compute nodes are determined by the Autoscale formula. - -### Example 4: Create a pool with nodes in a subnet -``` -PS C:\$imageReference = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSImageReference" -ArgumentList @("WindowsServer", "MicrosoftWindowsServer", "2016-Datacenter", "*") -PS C:\>$configuration = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.VirtualMachineConfiguration" -ArgumentList @($imageReference, "batch.node.windows amd64") -PS C:\>$networkConfig = New-Object Microsoft.Azure.Commands.Batch.Models.PSNetworkConfiguration -PS C:\>$networkConfig.SubnetId = "/subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}" -PS C:\>New-AzureBatchPool -Id "AutoScalePool" -VirtualMachineSize "Small" -VirtualMachineConfiguration $configuration -TargetDedicatedComputeNodes 3 -NetworkConfiguration $networkConfig -BatchContext $Context -``` - -### Example 5: Create a pool with custom user accounts -``` -PS C:\$imageReference = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSImageReference" -ArgumentList @("WindowsServer", "MicrosoftWindowsServer", "2016-Datacenter", "*") -PS C:\>$configuration = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.VirtualMachineConfiguration" -ArgumentList @($imageReference, "batch.node.windows amd64") -PS C:\>$userAccount = New-Object Microsoft.Azure.Commands.Batch.Models.PSUserAccount -ArgumentList @("myaccount", "mypassword") -PS C:\>New-AzureBatchPool -Id "AutoScalePool" -VirtualMachineSize "Small" -VirtualMachineConfiguration $configuration -TargetDedicatedComputeNodes 3 -UserAccount $userAccount -``` - -## PARAMETERS - -### -ApplicationLicenses -The list of application licenses the Batch service will make available on each compute node in the pool. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: ApplicationLicense - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationPackageReferences -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSApplicationPackageReference[] -Parameter Sets: (All) -Aliases: ApplicationPackageReference - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoScaleEvaluationInterval -Specifies the amount of time, in minutes, that elapses before the pool size is automatically adjusted according to the AutoScale formula. -The default value is 15 minutes, and the minimum value is 5 minutes. - -```yaml -Type: System.Nullable`1[System.TimeSpan] -Parameter Sets: CloudServiceAndAutoScale, VirtualMachineAndAutoScale -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoScaleFormula -Specifies the formula for automatically scaling the pool. - -```yaml -Type: System.String -Parameter Sets: CloudServiceAndAutoScale, VirtualMachineAndAutoScale -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CertificateReferences -Specifies certificates associated with the pool. -The Batch service installs the referenced certificates on each compute node of the pool. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSCertificateReference[] -Parameter Sets: (All) -Aliases: CertificateReference - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CloudServiceConfiguration -Specifies configuration settings for a pool based on the Azure cloud service platform. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSCloudServiceConfiguration -Parameter Sets: CloudServiceAndTargetDedicated, CloudServiceAndAutoScale -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the display name of the pool. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the pool to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InterComputeNodeCommunicationEnabled -Indicates that this cmdlet sets up the pool for direct communication between dedicated compute nodes. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxTasksPerComputeNode -Specifies the maximum number of tasks that can run on a single compute node. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Metadata -Specifies the metadata, as key/value pairs, to add to the new pool. -The key is the metadata name. -The value is the metadata value. - -```yaml -Type: System.Collections.IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkConfiguration -The network configuration for the pool. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSNetworkConfiguration -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResizeTimeout -Specifies the time-out for allocating compute nodes to the pool. - -```yaml -Type: System.Nullable`1[System.TimeSpan] -Parameter Sets: CloudServiceAndTargetDedicated, VirtualMachineAndTargetDedicated -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTask -Specifies the start task specification for the pool. -The start task is run when a compute node joins the pool, or when the compute node is rebooted or reimaged. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSStartTask -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetDedicatedComputeNodes -Specifies the target number of dedicated compute nodes to allocate to the pool. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: CloudServiceAndTargetDedicated, VirtualMachineAndTargetDedicated -Aliases: TargetDedicated - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetLowPriorityComputeNodes -Specifies the target number of low-priority compute nodes to allocate to the pool. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: CloudServiceAndTargetDedicated, VirtualMachineAndTargetDedicated -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TaskSchedulingPolicy -Specifies the task scheduling policy, such as the ComputeNodeFillType. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSTaskSchedulingPolicy -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserAccount -The list of user accounts to be created on each node in the pool. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSUserAccount[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualMachineConfiguration -Specifies configuration settings for a pool on the virtual machines infrastructure. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSVirtualMachineConfiguration -Parameter Sets: VirtualMachineAndTargetDedicated, VirtualMachineAndAutoScale -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualMachineSize -Specifies the size of the virtual machines in the pool. -For more information about virtual machine sizes, see [Sizes for virtual machines](/azure/virtual-machines/sizes) in the Microsoft Azure site. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[Get-AzureBatchPool](./Get-AzureBatchPool.md) - -[Remove-AzureBatchPool](./Remove-AzureBatchPool.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/New-AzureBatchTask.md b/azurermps-6.13.0/AzureRM.Batch/New-AzureBatchTask.md deleted file mode 100644 index 0839ebcf8d..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/New-AzureBatchTask.md +++ /dev/null @@ -1,483 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 2B4BFDDA-9721-42E6-84E1-A209CB782954 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/new-azurebatchtask -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchTask.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchTask.md ---- - -# New-AzureBatchTask - -## SYNOPSIS -Creates a Batch task under a job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### JobId_Single (Default) -``` -New-AzureBatchTask -JobId -Id [-DisplayName ] [-CommandLine ] - [-ResourceFiles ] [-EnvironmentSettings ] - [-AuthenticationTokenSettings ] [-UserIdentity ] - [-AffinityInformation ] [-Constraints ] - [-MultiInstanceSettings ] [-DependsOn ] - [-ApplicationPackageReferences ] [-OutputFile ] - [-ExitConditions ] [-ContainerSettings ] - -BatchContext [-DefaultProfile ] [] -``` - -### JobId_Bulk -``` -New-AzureBatchTask -JobId [-Tasks ] -BatchContext - [-DefaultProfile ] [] -``` - -### JobObject_Bulk -``` -New-AzureBatchTask [-Job ] [-Tasks ] -BatchContext - [-DefaultProfile ] [] -``` - -### JobObject_Single -``` -New-AzureBatchTask [-Job ] -Id [-DisplayName ] [-CommandLine ] - [-ResourceFiles ] [-EnvironmentSettings ] - [-AuthenticationTokenSettings ] [-UserIdentity ] - [-AffinityInformation ] [-Constraints ] - [-MultiInstanceSettings ] [-DependsOn ] - [-ApplicationPackageReferences ] [-OutputFile ] - [-ExitConditions ] [-ContainerSettings ] - -BatchContext [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureBatchTask** cmdlet creates an Azure Batch task under the job specified by the *JobId* parameter or the *Job* parameter. - -## EXAMPLES - -### Example 1: Create a Batch task -``` -PS C:\>New-AzureBatchTask -JobId "Job-000001" -Id "Task23" -CommandLine "cmd /c dir /s" -BatchContext $Context -``` - -This command creates a task that has the ID Task23 under the job that has the ID Job-000001. -The task runs the specified command. -Use the **Get-AzureRmBatchAccountKeys** cmdlet to assign a context to the $Context variable. - -### Example 2: Create a Batch task -``` -PS C:\> $autoUser = New-Object Microsoft.Azure.Commands.Batch.Models.PSAutoUserSpecification -ArgumentList @("Task", "Admin") -PS C:\> $userIdentity = New-Object Microsoft.Azure.Commands.Batch.Models.PSUserIdentity $autoUser -PS C:\>Get-AzureBatchJob -Id "Job-000001" -BatchContext $Context | New-AzureBatchTask -Id "Task26" -CommandLine "cmd /c echo hello > newFile.txt" -UserIdentity $userIdentity -BatchContext $Context -``` - -This command gets the Batch job that has the ID Job-000001 by using the **Get-AzureBatchJob** cmdlet. -The command passes that job to the current cmdlet by using the pipeline operator. -The command creates a task that has the ID Task26 under that job. -The task runs the specified command by using elevated permissions. - -### Example 3: Add a collection of tasks to the specified job by using the pipeline -``` -PS C:\>$Context = Get-AzureRmBatchAccountKeys -AccountName "ContosoBatchAccount" -PS C:\> $Task01 = New-Object Microsoft.Azure.Commands.Batch.Models.PSCloudTask("Task23", "cmd /c dir /s") -PS C:\> $Task02 = New-Object Microsoft.Azure.Commands.Batch.Models.PSCloudTask("Task24", "cmd /c dir /s") -PS C:\> Get-AzureBatchJob -Id "Job-000001" -BatchContext $Context | New-AzureBatchTask -Tasks @($Task01, $Task02) -BatchContext $Context -``` - -The first command creates an object reference to the account keys for the batch account named ContosoBatchAccount by using **Get-AzureRmBatchAccountKeys**. -The command stores this object reference in the $Context variable. -The next two commands create **PSCloudTask** objects by using the New-Object cmdlet. -The commands store the tasks in the $Task01 and $Task02 variables. -The final command gets the Batch job that has the ID Job-000001 by using **Get-AzureBatchJob**. -Then the command passes that job to the current cmdlet by using the pipeline operator. -The command adds a collection of tasks under that job. -The command uses the context stored in $Context. - -### Example 4: Add a collection of tasks to the specified job -``` -PS C:\>$Context = Get-AzureRmBatchAccountKeys -AccountName "ContosoBatchAccount" -PS C:\> $Task01 = New-Object Microsoft.Azure.Commands.Batch.Models.PSCloudTask("Task23", "cmd /c dir /s") -PS C:\> $Task02 = New-Object Microsoft.Azure.Commands.Batch.Models.PSCloudTask("Task24", "cmd /c dir /s") -PS C:\> New-AzureBatchTask -JobId "Job-000001" -Tasks @($Task01, $Task02) -BatchContext $Context -``` - -The first command creates an object reference to the account keys for the batch account named ContosoBatchAccount by using **Get-AzureRmBatchAccountKeys**. -The command stores this object reference in the $Context variable. -The next two commands create **PSCloudTask** objects by using the New-Object cmdlet. -The commands store the tasks in the $Task01 and $Task02 variables. -The final command adds the tasks stored in $Task01 and $Task02 under the job that has the ID Job-000001. - -### Example 5: Add a task with output files -``` -PS C:\>New-AzureBatchTask -JobId "Job-000001" -Id "Task23" -CommandLine "cmd /c dir /s" -BatchContext $Context -PS C:\>$blobContainerDestination = New-Object Microsoft.Azure.Commands.Batch.Models.PSOutputFileBlobContainerDestination "https://myaccount.blob.core.windows.net/sascontainer?sv=2015-04-05&st=2015-04-29T22%3A18%3A26Z&se=2015-04-30T02%3A23%3A26Z&sr=b&sp=rw&spr=https&sig=Z%2FRHIX5Xcg0Mq2rqI3OlWTjEg2tYkboXr1P9ZUXDtkk%3D" -PS C:\>$destination = New-Object Microsoft.Azure.Commands.Batch.Models.PSOutputFileDestination $blobContainerDestination -PS C:\>$uploadOptions = New-Object Microsoft.Azure.Commands.Batch.Models.PSOutputFileUploadOptions "TaskSuccess" -PS C:\>$outputFile = New-Object Microsoft.Azure.Commands.Batch.Models.PSOutputFile "*.txt", $blobContainerDestination, $uploadOptions - -PS C:\>New-AzureBatchTask -JobId "Job-000001" -Id "Task23" -CommandLine "cmd /c dir /s" -OutputFile $outputFile -BatchContext $Context -``` - -### Example 6: Add a task with authentication token settings -``` -PS C:\>$authSettings = New-Object Microsoft.Azure.Commands.Batch.Models.PSAuthenticationTokenSettings -PS C:\>$authSettings.Access = "Job" -PS C:\>New-AzureBatchTask -JobId "Job-000001" -Id "Task23" -CommandLine "cmd /c dir /s" -AuthenticationTokenSettings $authSettings -BatchContext $Context -``` - -### Example 7: Add a task which runs in a container -``` -PS C:\>New-AzureBatchTask -JobId "Job-000001" -Id "Task23" -CommandLine "cmd /c dir /s" -ContainerSettings New-Object Microsoft.Azure.Commands.Batch.Models.PSTaskContainerSettings "containerImageName" -``` - -## PARAMETERS - -### -AffinityInformation -Specifies a locality hint that the Batch service uses to select a node on which to run the task. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSAffinityInformation -Parameter Sets: JobId_Single, JobObject_Single -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationPackageReferences -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSApplicationPackageReference[] -Parameter Sets: JobId_Single, JobObject_Single -Aliases: ApplicationPackageReference - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthenticationTokenSettings -The settings for an authentication token that the task can use to perform Batch service operations. -If this is set, the Batch service provides the task with an authentication token which can be used to -authenticate Batch service operations without requiring an account access key. The token is provided via the -AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the task can carry out using the token -depend on the settings. For example, a task can request job permissions in order to add other tasks to the job, -or check the status of the job or of other tasks. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSAuthenticationTokenSettings -Parameter Sets: JobId_Single, JobObject_Single -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CommandLine -Specifies the command line for the task. - -```yaml -Type: System.String -Parameter Sets: JobId_Single, JobObject_Single -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Constraints -Specifies the execution constraints that apply to this task. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSTaskConstraints -Parameter Sets: JobId_Single, JobObject_Single -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContainerSettings -The settings for the container under which the task runs. -If the pool that will run this task has containerConfiguration set, this must be set as well. If the pool that will run this task -doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the -AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables -are mapped into the container, and the task command line is executed in the container. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSTaskContainerSettings -Parameter Sets: JobId_Single, JobObject_Single -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DependsOn -Specifies that the task depends on other tasks. -The task will not be scheduled until all depended-on tasks have completed successfully. - -```yaml -Type: Microsoft.Azure.Batch.TaskDependencies -Parameter Sets: JobId_Single, JobObject_Single -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the display name of the task. - -```yaml -Type: System.String -Parameter Sets: JobId_Single, JobObject_Single -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnvironmentSettings -Specifies the environment settings, as key/value pairs, that this cmdlet adds to the task. -The key is the environment setting name. -The value is the environment setting. - -```yaml -Type: System.Collections.IDictionary -Parameter Sets: JobId_Single, JobObject_Single -Aliases: EnvironmentSetting - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExitConditions -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSExitConditions -Parameter Sets: JobId_Single, JobObject_Single -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the task. - -```yaml -Type: System.String -Parameter Sets: JobId_Single, JobObject_Single -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Job -Specifies the job under which this cmdlet creates the task. -To obtain a **PSCloudJob** object, use the Get-AzureBatchJob cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSCloudJob -Parameter Sets: JobObject_Bulk, JobObject_Single -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -JobId -Specifies the ID of the job under which this cmdlet creates the task. - -```yaml -Type: System.String -Parameter Sets: JobId_Single, JobId_Bulk -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MultiInstanceSettings -Specifies information about how to run a multi-instance task. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSMultiInstanceSettings -Parameter Sets: JobId_Single, JobObject_Single -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutputFile -Gets or sets a list of files that the Batch service will upload from the compute node after running the command line. -For multi-instance tasks, the files will only be uploaded from the compute node on which the primary task is executed. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSOutputFile[] -Parameter Sets: JobId_Single, JobObject_Single -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceFiles -Specifies resource files, as key/value pairs, that the task requires. -The key is the resource file path. -The value is the resource file blob source. - -```yaml -Type: System.Collections.IDictionary -Parameter Sets: JobId_Single, JobObject_Single -Aliases: ResourceFile - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tasks -Specifies the collection of tasks to be added. -Each task must have a unique ID. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSCloudTask[] -Parameter Sets: JobId_Bulk, JobObject_Bulk -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserIdentity -The user identity under which the task runs. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSUserIdentity -Parameter Sets: JobId_Single, JobObject_Single -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSCloudJob -Parameters: Job (ByValue) - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[Get-AzureBatchJob](./Get-AzureBatchJob.md) - -[Get-AzureBatchTask](./Get-AzureBatchTask.md) - -[New-AzureBatchTask](./New-AzureBatchTask.md) - -[Remove-AzureBatchTask](./Remove-AzureBatchTask.md) - -[Stop-AzureBatchTask](./Stop-AzureBatchTask.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/New-AzureRmBatchAccount.md b/azurermps-6.13.0/AzureRM.Batch/New-AzureRmBatchAccount.md deleted file mode 100644 index c900641925..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/New-AzureRmBatchAccount.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 82C7B128-8818-4390-B1A5-CB40AC9D53CA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/new-azurermbatchaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchAccount.md ---- - -# New-AzureRmBatchAccount - -## SYNOPSIS -Creates a Batch account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmBatchAccount [-AccountName] [-Location] [-ResourceGroupName] - [[-AutoStorageAccountId] ] [-PoolAllocationMode ] [-KeyVaultId ] - [-KeyVaultUrl ] [-Tag ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureRmBatchAccount** cmdlet creates an Azure Batch account for the specified resource group and location. - -## EXAMPLES - -### Example 1: Create a Batch account -``` -PS C:\>New-AzureRmBatchAccount -AccountName "pfuller" -ResourceGroupName "ResourceGroup03" -Location "WestUS" -AccountName : pfuller -Location : westus -ResourceGroupName : ResourceGroup03 -CoreQuota : 20 -PoolQuota : 20 -ActiveJobAndJobScheduleQuota : 20 -Tags : -TaskTenantUrl : https://cmdletexample.westus.batch.azure.com -``` - -This command creates a Batch account named pfuller using the ResourceGroup03 resource group in the West US location. - -## PARAMETERS - -### -AccountName -Specifies the name of the Batch account that this cmdlet creates. -Batch account names must be between 3 and 24 characters long and contain only numbers and lowercase letters. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AutoStorageAccountId -Specifies the resource ID of the storage account to be used for auto storage. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyVaultId -The resource ID of the Azure key vault associated with the Batch account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyVaultUrl -The URL of the Azure key vault associated with the Batch account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the region where this cmdlet creates the account. -For more information, see [Azure Regions](https://azure.microsoft.com/en-us/regions). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PoolAllocationMode -The allocation mode for creating pools in the Batch account. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.Batch.Models.PoolAllocationMode] -Parameter Sets: (All) -Aliases: -Accepted values: BatchService, UserSubscription - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group in which this cmdlet creates the account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[Microsoft.Azure.Management.Batch.Models.PoolAllocationMode, Microsoft.Azure.Management.Batch, Version=4.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.Batch.BatchAccountContext - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchAccount](./Get-AzureRmBatchAccount.md) - -[Remove-AzureRmBatchAccount](./Remove-AzureRmBatchAccount.md) - -[Set-AzureRmBatchAccount](./Set-AzureRmBatchAccount.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/New-AzureRmBatchAccountKey.md b/azurermps-6.13.0/AzureRM.Batch/New-AzureRmBatchAccountKey.md deleted file mode 100644 index 057bd3e40e..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/New-AzureRmBatchAccountKey.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 486748AC-3932-4E0C-BBCC-2BC194E69DCC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/new-azurermbatchaccountkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchAccountKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchAccountKey.md ---- - -# New-AzureRmBatchAccountKey - -## SYNOPSIS -Regenerates a key of a Batch account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmBatchAccountKey [-AccountName] [-ResourceGroupName ] -KeyType - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureRmBatchAccountKey** cmdlet regenerates the primary or secondary key of an Azure Batch account. -The cmdlet returns a **BatchAccountContext** object that has its current **PrimaryAccountKey** and **SecondaryAccountKey** properties. - -## EXAMPLES - -### Example 1: Regenerate the primary account key on a Batch account -``` -PS C:\>New-AzureRmBatchAccountKey -AccountName "pfuller" -KeyType "Primary" -AccountName : pfuller - -Location : westus - -ResourceGroupName : CmdletExampleRG - -CoreQuota : 20 - -PoolQuota : 20 - -ActiveJobAndJobScheduleQuota : 20 - -Tags : -TaskTenantUrl : https://cmdletexample.westus.batch.azure.com -``` - -This command regenerates the primary account key on the Batch account named pfuller. - -## PARAMETERS - -### -AccountName -Specifies the name of the Batch account for which this cmdlet regenerates a key. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyType -Specifies the type of key that this cmdlet regenerates. -Valid values are: -- Primary -- Secondary - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Primary, Secondary - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group of the account for which this cmdlet regenerates a key. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Batch.BatchAccountContext - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) - - diff --git a/azurermps-6.13.0/AzureRM.Batch/New-AzureRmBatchApplication.md b/azurermps-6.13.0/AzureRM.Batch/New-AzureRmBatchApplication.md deleted file mode 100644 index f5d09d009c..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/New-AzureRmBatchApplication.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: FF111B74-90A3-4F7C-B515-CE1EEF68EB54 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/new-azurermbatchapplication -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchApplication.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchApplication.md ---- - -# New-AzureRmBatchApplication - -## SYNOPSIS -Adds an application to the specified Batch account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmBatchApplication [-AccountName] [-ResourceGroupName] [-ApplicationId] - [[-AllowUpdates] ] [[-DisplayName] ] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **New-AzureRmBatchApplication** cmdlet adds an application to the specified Azure Batch account. - -## EXAMPLES - -### Example 1: Add an empty application to a Batch account -``` -PS C:\>New-AzureRmBatchApplication -AccountName "ContosoBatch" -ResourceGroupName "ContosoBatchGroup" -ApplicationId "Litware" -AllowUpdates $True -DisplayName "Litware Advanced Reticulator" -``` - -This command creates the Litware application in the ContosoBatch account. -The application initially contains no packages. - -## PARAMETERS - -### -AccountName -Specifies the name of the Batch account to which this cmdlet adds an application. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AllowUpdates -Specifies whether packages within the application can be overwritten using the same version string. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationId -Specifies the ID of the application. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the display name for the application. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the Batch account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSApplication - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchApplication](./Get-AzureRmBatchApplication.md) - -[Get-AzureRmBatchApplicationPackage](./Get-AzureRmBatchApplicationPackage.md) - -[New-AzureRmBatchApplicationPackage](./New-AzureRmBatchApplicationPackage.md) - -[Remove-AzureRmBatchApplication](./Remove-AzureRmBatchApplication.md) - -[Remove-AzureRmBatchApplicationPackage](./Remove-AzureRmBatchApplicationPackage.md) - -[Set-AzureRmBatchApplication](./Set-AzureRmBatchApplication.md) - - diff --git a/azurermps-6.13.0/AzureRM.Batch/New-AzureRmBatchApplicationPackage.md b/azurermps-6.13.0/AzureRM.Batch/New-AzureRmBatchApplicationPackage.md deleted file mode 100644 index f29f2c8967..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/New-AzureRmBatchApplicationPackage.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: D53DAEB6-DC4F-473C-A193-A1E2A65326D4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/new-azurermbatchapplicationpackage -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchApplicationPackage.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchApplicationPackage.md ---- - -# New-AzureRmBatchApplicationPackage - -## SYNOPSIS -Creates an application package in a Batch account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### UploadAndActivate (Default) -``` -New-AzureRmBatchApplicationPackage [-AccountName] [-ResourceGroupName] - [-ApplicationId] [-ApplicationVersion] [-Format] -FilePath - [-DefaultProfile ] [] -``` - -### ActivateOnly -``` -New-AzureRmBatchApplicationPackage [-AccountName] [-ResourceGroupName] - [-ApplicationId] [-ApplicationVersion] [-Format] [-ActivateOnly] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureRmBatchApplicationPackage** cmdlet creates an application package in an Azure Batch account. - -## EXAMPLES - -### Example 1: Install an application package into a Batch account -``` -PS C:\>New-AzureRmBatchApplicationPackage -AccountName "ContosoBatch" -ResourceGroupName "ContosoBatchGroup" -ApplicationId "Litware" -ApplicationVersion "1.0" -FilePath "litware.1.0.zip" -Format "zip" -``` - -This command creates and activates version 1.0 of the Litware application, and uploads the contents of litware.1.0.zip as the application package content. - -## PARAMETERS - -### -AccountName -Specifies the name of the Batch account to which this cmdlet adds an application package. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ActivateOnly -Indicates that this cmdlet activates an application package that has already been uploaded. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ActivateOnly -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationId -Specifies the ID of the application. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationVersion -Specifies the version of the application. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FilePath -Specifies the file to be uploaded as the application package binary file. - -```yaml -Type: System.String -Parameter Sets: UploadAndActivate -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Format -Specifies the format of the application package binary file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the Batch account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSApplicationPackage - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchApplication](./Get-AzureRmBatchApplication.md) - -[Get-AzureRmBatchApplicationPackage](./Get-AzureRmBatchApplicationPackage.md) - -[New-AzureRmBatchApplication](./New-AzureRmBatchApplication.md) - -[Remove-AzureRmBatchApplication](./Remove-AzureRmBatchApplication.md) - -[Remove-AzureRmBatchApplicationPackage](./Remove-AzureRmBatchApplicationPackage.md) - -[Set-AzureRmBatchApplication](./Set-AzureRmBatchApplication.md) - - diff --git a/azurermps-6.13.0/AzureRM.Batch/Remove-AzureBatchCertificate.md b/azurermps-6.13.0/AzureRM.Batch/Remove-AzureBatchCertificate.md deleted file mode 100644 index 335ff61241..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Remove-AzureBatchCertificate.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 3DFFD0F2-6CD8-4FBE-B15C-8505CBF8F44E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/remove-azurebatchcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchCertificate.md ---- - -# Remove-AzureBatchCertificate - -## SYNOPSIS -Deletes a certificate from an account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureBatchCertificate [-ThumbprintAlgorithm] [-Thumbprint] - -BatchContext [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Remove-AzureBatchCertificate** cmdlet removes a certificate from the specified Azure Batch account. - -## EXAMPLES - -### Example 1: Remove a certificate -``` -PS C:\>Remove-AzureBatchCertificate -ThumbprintAlgorithm "sha1" -Thumbprint "c1e494a415149c5f211c4778b52f2e834a07247c" -BatchContext $Context -``` - -This command removes the certificate that has the specified thumbprint. - -### Example 2:Remove all active certificates -``` -PS C:\>Get-AzureBatchCertificate -Filter "state eq 'active'" -BatchContext $Context | Remove-AzureBatchCertificate -Force -BatchContext $Context -``` - -This command gets all certificates that are active by using the Get-AzureBatchCertificate cmdlet. -The command passes the active certificates to the current cmdlet by using the pipeline operator. -That cmdlet removes each certificate. -The command specifies the *Force* parameter. -Therefore, the command does not prompt you for confirmation. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Thumbprint -Specifies the thumbprint of the certificate that this cmdlet deletes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThumbprintAlgorithm -Specifies the algorithm used to derive the *Thumbprint* parameter. -Currently, the only valid value is sha1. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureBatchCertificate](./Get-AzureBatchCertificate.md) - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[New-AzureBatchCertificate](./New-AzureBatchCertificate.md) - -[Stop-AzureBatchCertificateDeletion](./Stop-AzureBatchCertificateDeletion.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Remove-AzureBatchComputeNode.md b/azurermps-6.13.0/AzureRM.Batch/Remove-AzureBatchComputeNode.md deleted file mode 100644 index dbc99b4398..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Remove-AzureBatchComputeNode.md +++ /dev/null @@ -1,250 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 0BB79553-26DA-413C-8086-740DB6B31A85 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/remove-azurebatchcomputenode -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchComputeNode.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchComputeNode.md ---- - -# Remove-AzureBatchComputeNode - -## SYNOPSIS -Removes compute nodes from a pool. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Id (Default) -``` -Remove-AzureBatchComputeNode [-PoolId] [-Ids] - [-DeallocationOption ] [-ResizeTimeout ] [-Force] - -BatchContext [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -### InputObject -``` -Remove-AzureBatchComputeNode [[-ComputeNode] ] - [-DeallocationOption ] [-ResizeTimeout ] [-Force] - -BatchContext [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Remove-AzureBatchComputeNode** cmdlet removes Azure Batch compute nodes from a pool. - -## EXAMPLES - -### Example 1: Remove a compute node -``` -PS C:\>Remove-AzureBatchComputeNode -PoolId "Pool07" -Ids "tvm-2316545714_1-20150725t213220z" -DeallocationOption Terminate -ResizeTimeout ([TimeSpan]::FromMinutes(10)) -BatchContext $Context -``` - -This command removes compute node that has the specified ID from pool that has the ID Pool07. -The command specifies the Terminate deallocation option. -The resize time-out is of 10 minutes. - -### Example 2: Remove a compute node by using the pipeline -``` -PS C:\>Get-AzureBatchComputeNode -PoolId "Pool07" -Id "tvm-2316545714_1-20150725t213220z" -BatchContext $Context | Remove-AzureBatchComputeNode -Force -BatchContext $Context -``` - -This command gets the compute node that has the specified ID from pool that has the ID Pool07 by using the Get-AzureBatchComputeNode cmdlet. -The command passes that node to the current cmdlet by using the pipeline. -The current cmdlet removes the compute node. -The command specifies the *Force* parameter. -Therefore, the command does not prompt you for confirmation. - -### Example 3: Remove multiple nodes -``` -PS C:\>Remove-AzureBatchComputeNode -PoolId "Pool07" @("tvm-1783593343_28-20151117t214257z","tvm-1783593343_29-20151117t214257z") -Force -BatchContext $Context -``` - -This command removes two compute nodes from the pool that has the ID Pool07. -The command does not prompt you for confirmation. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ComputeNode -Specifies the **PSComputeNode** object that represents the compute node that this cmdlet removes. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSComputeNode -Parameter Sets: InputObject -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DeallocationOption -Specifies a deallocation option for the removal operation that this cmdlet starts. -The default value is Requeue. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption] -Parameter Sets: (All) -Aliases: -Accepted values: Requeue, Terminate, TaskCompletion, RetainedData - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Ids -Specifies an array of IDs of compute nodes that this cmdlet removes from the pool. - -```yaml -Type: System.String[] -Parameter Sets: Id -Aliases: Id - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PoolId -Specifies the ID of the pool that contains the compute nodes that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: Id -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResizeTimeout -Specifies the time-out interval for removal of the compute nodes from the pool. -The default value is 10 minutes. -The minimum value is 5 minutes. - -```yaml -Type: System.Nullable`1[System.TimeSpan] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSComputeNode -Parameters: ComputeNode (ByValue) - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[Get-AzureBatchComputeNode](./Get-AzureBatchComputeNode.md) - -[Restart-AzureBatchComputeNode](./Restart-AzureBatchComputeNode.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Remove-AzureBatchComputeNodeUser.md b/azurermps-6.13.0/AzureRM.Batch/Remove-AzureBatchComputeNodeUser.md deleted file mode 100644 index 43a9959f88..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Remove-AzureBatchComputeNodeUser.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 9E423A10-06AF-42F8-AC90-82DB01012AFA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/remove-azurebatchcomputenodeuser -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchComputeNodeUser.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchComputeNodeUser.md ---- - -# Remove-AzureBatchComputeNodeUser - -## SYNOPSIS -Deletes a user account from a Batch compute node. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureBatchComputeNodeUser [-PoolId] [-ComputeNodeId] [-Name] - -BatchContext [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Remove-AzureBatchComputeNodeUser** cmdlet deletes a user account from an Azure Batch compute node. - -## EXAMPLES - -### Example 1: Delete a user from a compute node without confirmation -``` -PS C:\>Remove-AzureBatchComputeNodeUser -PoolId "Pool01" -ComputeNodeId "ComputeNode01" -Name "User14" -Force -BatchContext $Context -``` - -This command deletes the user named User14 from compute node named ComputeNode01. -The compute node is in the pool named Pool01. -This command specifies the *Force* parameter. -Therefore, the command does not prompt you for confirmation. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ComputeNodeId -Specifies the ID of the compute node on which this cmdlet deletes the user account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the user account to delete. -You cannot specify wildcard characters. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PoolId -Specifies the ID of the pool that contains the compute node on which to delete the user account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[New-AzureBatchComputeNodeUser](./New-AzureBatchComputeNodeUser.md) - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Remove-AzureBatchJob.md b/azurermps-6.13.0/AzureRM.Batch/Remove-AzureBatchJob.md deleted file mode 100644 index a216e95aa8..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Remove-AzureBatchJob.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: CB2F472B-C792-4A11-A055-F4161DCFBB28 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/remove-azurebatchjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchJob.md ---- - -# Remove-AzureBatchJob - -## SYNOPSIS -Deletes a Batch job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureBatchJob [-Id] [-Force] -BatchContext - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AzureBatchJob** cmdlet deletes an Azure Batch job. -This cmdlet prompts you for confirmation before it removes a job, unless you specify the *Force* parameter. - -## EXAMPLES - -### Example 1: Delete a Batch job -``` -PS C:\>Remove-AzureBatchJob -Id "Job-000001" -BatchContext $Context -``` - -This command deletes the job that has the ID Job-000001. -The command prompts you for confirmation before it deletes the job. -Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable. - -### Example 2: Delete a Batch job without confirmation by using the pipeline -``` -PS C:\>Get-AzureBatchJob -Id "Job-000002" -BatchContext $Context | Remove-AzureBatchJob -Force -BatchContext $Context -``` - -This command gets the job that has the ID Job-000002 by using the Get-AzureBatchJob cmdlet. -The command passes that job to the current cmdlet by using the pipeline operator. -The command deletes that job. -Because the command includes the *Force* parameter, it does not prompt you for confirmation. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the job that this cmdlet deletes. -You cannot specify wildcard characters. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Disable-AzureBatchJob](./Disable-AzureBatchJob.md) - -[Enable-AzureBatchJob](./Enable-AzureBatchJob.md) - -[Get-AzureBatchJob](./Get-AzureBatchJob.md) - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[New-AzureBatchJob](./New-AzureBatchJob.md) - -[Stop-AzureBatchJob](./Stop-AzureBatchJob.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Remove-AzureBatchJobSchedule.md b/azurermps-6.13.0/AzureRM.Batch/Remove-AzureBatchJobSchedule.md deleted file mode 100644 index 08755c9aef..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Remove-AzureBatchJobSchedule.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 97FA5983-0D73-4336-99DA-46E5992F06DC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/remove-azurebatchjobschedule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchJobSchedule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchJobSchedule.md ---- - -# Remove-AzureBatchJobSchedule - -## SYNOPSIS -Removes a Batch job schedule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureBatchJobSchedule [-Id] [-Force] -BatchContext - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AzureBatchJobSchedule** cmdlet removes an Azure Batch job schedule. - -## EXAMPLES - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the job schedule to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Disable-AzureBatchJobSchedule](./Disable-AzureBatchJobSchedule.md) - -[Enable-AzureBatchJobSchedule](./Enable-AzureBatchJobSchedule.md) - -[Get-AzureBatchJobSchedule](./Get-AzureBatchJobSchedule.md) - -[New-AzureBatchJobSchedule](./New-AzureBatchJobSchedule.md) - -[Set-AzureBatchJobSchedule](./Set-AzureBatchJobSchedule.md) - -[Stop-AzureBatchJobSchedule](./Stop-AzureBatchJobSchedule.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Remove-AzureBatchNodeFile.md b/azurermps-6.13.0/AzureRM.Batch/Remove-AzureBatchNodeFile.md deleted file mode 100644 index 4796fbe953..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Remove-AzureBatchNodeFile.md +++ /dev/null @@ -1,284 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: DBA02017-8372-4A91-A4F1-985777DEDAB9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/remove-azurebatchnodefile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchNodeFile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchNodeFile.md ---- - -# Remove-AzureBatchNodeFile - -## SYNOPSIS -Deletes a node file for a task or compute node. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Task -``` -Remove-AzureBatchNodeFile -JobId -TaskId -Path [-Force] [-Recursive] - -BatchContext [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -### ComputeNode -``` -Remove-AzureBatchNodeFile [-PoolId] [-ComputeNodeId] -Path [-Force] [-Recursive] - -BatchContext [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -### InputObject -``` -Remove-AzureBatchNodeFile [[-InputObject] ] [-Force] [-Recursive] - -BatchContext [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Remove-AzureBatchNodeFile** cmdlet deletes an Azure Batch node file for a task or compute node. - -## EXAMPLES - -### Example 1: Delete a file assocated with a task -``` -PS C:\>Remove-AzureBatchNodeFile -JobId "Job-000001" -TaskId "Task26" -Path "wd\testFile.txt" -BatchContext $Context -``` - -This command deletes the node file that is named wd\testFile.txt. -That file is associated with the task that has the ID Task26 under the job Job-000001. - -### Example 2: Delete a file from a compute node -``` -PS C:\>Remove-AzureBatchNodeFile -PoolId "Pool07" -ComputeNodeId "tvm-2316545714_1-20150725t213220z" -Path "startup\testFile.txt" -BatchContext $Context -``` - -This command deletes the node file that is named startup\testFile.txt from the specified compute node in the pool that has the ID Pool07. - -### Example 3: Remove a file by using the pipeline -``` -PS C:\>Get-AzureBatchNodeFile -JobId "Job-000001" -TaskId "Task26" -Path "wd\testFile2.txt" -BatchContext $Context | Remove-AzureBatchNodeFile -Force -BatchContext $Context -``` - -This command gets the node file by using **Get-AzureBatchNodeFile**. -That file is associated with the task that has the ID Task26 under the job Job-000001. -The command passes that file to the current cmdlet by using the pipeline. -The current cmdlet removes the node file. -The command specifies the *Force* parameter. -Therefore, the command does not prompt you for confirmation. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ComputeNodeId -Specifies the ID of the compute node that contains the Batch node file that this cmdlet deletes. - -```yaml -Type: System.String -Parameter Sets: ComputeNode -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies **PSNodeFile** object that represent the node file that this cmdlet deletes. -To obtain a **PSNodeFile**, use the Get-AzureBatchNodeFile cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSNodeFile -Parameter Sets: InputObject -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -JobId -Specifies the ID of the job that contains the task. - -```yaml -Type: System.String -Parameter Sets: Task -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -The file path of the node file to delete. - -```yaml -Type: System.String -Parameter Sets: Task, ComputeNode -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PoolId -Specifies the ID of the pool that contains the compute nodes for which this cmdlet removes a file. - -```yaml -Type: System.String -Parameter Sets: ComputeNode -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Recursive -Indicates that this cmdlet deletes the folder and all subfolders and files under the specified path. -This cmdlet is relevant only if the path is a folder. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TaskId -Specifies the ID of the task. - -```yaml -Type: System.String -Parameter Sets: Task -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.Models.PSNodeFile -Parameters: InputObject (ByValue) - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[Get-AzureBatchNodeFile](./Get-AzureBatchNodeFile.md) - -[Get-AzureBatchNodeFileContent](./Get-AzureBatchNodeFileContent.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Remove-AzureBatchPool.md b/azurermps-6.13.0/AzureRM.Batch/Remove-AzureBatchPool.md deleted file mode 100644 index 0e817a47b1..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Remove-AzureBatchPool.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: DB0A8E4B-AD3F-4BAC-A0B2-031913E019D4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/remove-azurebatchpool -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchPool.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchPool.md ---- - -# Remove-AzureBatchPool - -## SYNOPSIS -Deletes the specified Batch pool. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureBatchPool [-Id] [-Force] -BatchContext - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AzureBatchPool** cmdlet deletes the specified Azure Batch pool. -You are prompted for confirmation unless you use the *Force* parameter. - -## EXAMPLES - -### Example 1: Delete a Batch pool by pool ID -``` -PS C:\>Remove-AzureBatchPool -Id "MyPool" -BatchContext $Context -``` - -This command deletes the pool with ID MyPool. -The user is prompted for confirmation before the delete operation takes place. - -### Example 2: Delete all Batch pools by force -``` -PS C:\>Get-AzureBatchPool -BatchContext $Context | Remove-AzureBatchPool -Force -BatchContext $Context -``` - -This command deletes all Batch pools. -Because the *Force* parameter is present, the confirmation prompt is suppressed. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the pool to delete. -You cannot specify wildcard characters. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[Get-AzureBatchPool](./Get-AzureBatchPool.md) - -[New-AzureBatchPool](./New-AzureBatchPool.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Remove-AzureBatchTask.md b/azurermps-6.13.0/AzureRM.Batch/Remove-AzureBatchTask.md deleted file mode 100644 index 1ebd0c81c8..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Remove-AzureBatchTask.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: D79AEF8C-F0DC-40F8-9EEE-A2BB6AE5C4BF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/remove-azurebatchtask -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchTask.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchTask.md ---- - -# Remove-AzureBatchTask - -## SYNOPSIS -Deletes a Batch task. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Id -``` -Remove-AzureBatchTask [-JobId] [-Id] [-Force] -BatchContext - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### InputObject -``` -Remove-AzureBatchTask [-InputObject] [-Force] -BatchContext - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AzureBatchTask** cmdlet deletes an Azure Batch task. -This cmdlet prompts you for confirmation, unless you specify the *Force* parameter. - -## EXAMPLES - -### Example 1: Delete a Batch task by ID -``` -PS C:\>Remove-AzureBatchTask -JobId "Job-000001" -Id "Task23" -BatchContext $Context -``` - -This command deletes a task that has the ID Task23 under the job that has the ID Job-000001. -The command prompts you for confirmation. -Use the **Get-AzureRmBatchAccountKeys** cmdlet to assign a context to the $Context variable. - -### Example 2: Delete a Batch task by using the pipeline without confirmation -``` -PS C:\>Get-AzureBatchTask -JobId "Job-000001" -Id "Task26" -BatchContext $Context | Remove-AzureBatchTask -Force -BatchContext $Context -``` - -This command gets the Batch task that has the ID Task26 in the job that has the ID Job-000001 by using the **Get-AzureBatchTask** cmdlet. -The command passes that task to the current cmdlet by using the pipeline operator. -The command deletes that task. -This command specifies the *Force* parameter. -Therefore, the command does not prompt you for confirmation. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the task that this cmdlet deletes. -You cannot specify wildcard characters. - -```yaml -Type: System.String -Parameter Sets: Id -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -Specifies the task that this cmdlet deletes. -To obtain a **PSCloudTask** object, use the Get-AzureBatchTask cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSCloudTask -Parameter Sets: InputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -JobId -Specifies the ID of the job that contains the task. - -```yaml -Type: System.String -Parameter Sets: Id -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.Models.PSCloudTask -Parameters: InputObject (ByValue) - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[Get-AzureBatchTask](./Get-AzureBatchTask.md) - -[New-AzureBatchTask](./New-AzureBatchTask.md) - -[Remove-AzureBatchTask](./Remove-AzureBatchTask.md) - -[Stop-AzureBatchTask](./Stop-AzureBatchTask.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Remove-AzureRmBatchAccount.md b/azurermps-6.13.0/AzureRM.Batch/Remove-AzureRmBatchAccount.md deleted file mode 100644 index e3ae2ac7dc..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Remove-AzureRmBatchAccount.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 89F604DD-EE77-440D-BCC9-3F74D994C447 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/remove-azurermbatchaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureRmBatchAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureRmBatchAccount.md ---- - -# Remove-AzureRmBatchAccount - -## SYNOPSIS -Removes a Batch account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmBatchAccount [-AccountName] [[-ResourceGroupName] ] [-Force] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AzureRmBatchAccount** cmdlet removes an Azure Batch account. -This cmdlet prompts you before it removes an account, unless you specify the *Force* parameter. - -## EXAMPLES - -### Example 1: Remove a Batch account -``` -PS C:\>Remove-AzureRmBatchAccount -AccountName "pfuller" -``` - -This command removes the Batch account named pfuller. -This command prompts you for confirmation before it deletes the account. - -## PARAMETERS - -### -AccountName -Specifies the name of the Batch account that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group of the account that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchAccount](./Get-AzureRmBatchAccount.md) - -[New-AzureRmBatchAccount](./New-AzureRmBatchAccount.md) - -[Set-AzureRmBatchAccount](./Set-AzureRmBatchAccount.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) - - diff --git a/azurermps-6.13.0/AzureRM.Batch/Remove-AzureRmBatchApplication.md b/azurermps-6.13.0/AzureRM.Batch/Remove-AzureRmBatchApplication.md deleted file mode 100644 index 9e2163fce7..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Remove-AzureRmBatchApplication.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 2CED21D6-4BEF-423B-A04A-5B812CEB975D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/remove-azurermbatchapplication -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureRmBatchApplication.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureRmBatchApplication.md ---- - -# Remove-AzureRmBatchApplication - -## SYNOPSIS -Deletes an application from a Batch account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmBatchApplication [-AccountName] [-ResourceGroupName] [-ApplicationId] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Remove-AzureRmBatchApplication** cmdlet deletes an application from an Azure Batch account. - -## EXAMPLES - -### Example 1: Delete an application from a Batch account -``` -PS C:\>Remove-AzureRmBatchApplication -AccountName "ContosoBatch" -ResourceGroupName "ContosoBatchGroup" -ApplicationId "Litware" -``` - -This command deletes the Litware application from the ContosoBatch account. -The command fails if the application contains any packages. - -## PARAMETERS - -### -AccountName -Specifies the name of the Batch account from which this cmdlet removes an application. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationId -Specifies the ID of the application. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the Batch account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchApplication](./Get-AzureRmBatchApplication.md) - -[Get-AzureRmBatchApplicationPackage](./Get-AzureRmBatchApplicationPackage.md) - -[New-AzureRmBatchApplication](./New-AzureRmBatchApplication.md) - -[New-AzureRmBatchApplicationPackage](./New-AzureRmBatchApplicationPackage.md) - -[Remove-AzureRmBatchApplicationPackage](./Remove-AzureRmBatchApplicationPackage.md) - -[Set-AzureRmBatchApplication](./Set-AzureRmBatchApplication.md) - - diff --git a/azurermps-6.13.0/AzureRM.Batch/Remove-AzureRmBatchApplicationPackage.md b/azurermps-6.13.0/AzureRM.Batch/Remove-AzureRmBatchApplicationPackage.md deleted file mode 100644 index 48a4d55797..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Remove-AzureRmBatchApplicationPackage.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: FD2E3442-9CEA-4390-BE9C-772C7D6FD1E2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/remove-azurermbatchapplicationpackage -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureRmBatchApplicationPackage.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureRmBatchApplicationPackage.md ---- - -# Remove-AzureRmBatchApplicationPackage - -## SYNOPSIS -Deletes an application package record and the binary file. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmBatchApplicationPackage [-AccountName] [-ResourceGroupName] - [-ApplicationId] [-ApplicationVersion] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Remove-AzureRmBatchApplicationPackage** cmdlet deletes an application package record and the binary file from an Azure Batch account. - -## EXAMPLES - -### Example 1: Delete an application package from a Batch account -``` -PS C:\>Remove-AzureRmBatchApplicationPackage -AccountName "ContosoBatch" -ResourceGroupName "ContosoBatchGroup" -ApplicationId "litware" -ApplicationVersion "1.0" -``` - -This command deletes version 1.0 of the Litware application from the ContosoBatchGroup account. -The command deletes both the package record and the blob that contain the package binary file. - -## PARAMETERS - -### -AccountName -Specifies the name of the Batch account from which this cmdlet deletes an application package. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationId -Specifies the ID of the application. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationVersion -Specifies the version of the application. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the Batch account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchApplication](./Get-AzureRmBatchApplication.md) - -[Get-AzureRmBatchApplicationPackage](./Get-AzureRmBatchApplicationPackage.md) - -[New-AzureRmBatchApplication](./New-AzureRmBatchApplication.md) - -[New-AzureRmBatchApplicationPackage](./New-AzureRmBatchApplicationPackage.md) - -[Remove-AzureRmBatchApplication](./Remove-AzureRmBatchApplication.md) - -[Set-AzureRmBatchApplication](./Set-AzureRmBatchApplication.md) - - diff --git a/azurermps-6.13.0/AzureRM.Batch/Reset-AzureBatchComputeNode.md b/azurermps-6.13.0/AzureRM.Batch/Reset-AzureBatchComputeNode.md deleted file mode 100644 index 129cd8a6bd..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Reset-AzureBatchComputeNode.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: A202537B-D292-4822-A0B9-27A6A20621D4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/reset-azurebatchcomputenode -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Reset-AzureBatchComputeNode.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Reset-AzureBatchComputeNode.md ---- - -# Reset-AzureBatchComputeNode - -## SYNOPSIS -Reinstalls the operating system on the specified compute node. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Id (Default) -``` -Reset-AzureBatchComputeNode [-PoolId] [-Id] [-ReimageOption ] - -BatchContext [-DefaultProfile ] [] -``` - -### InputObject -``` -Reset-AzureBatchComputeNode [[-ComputeNode] ] [-ReimageOption ] - -BatchContext [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Reset-AzureBatchComputeNode** cmdlet reinstalls the operating system on the specified compute node. - -## EXAMPLES - -### Example 1: Reimage a node -``` -PS C:\>Reset-AzureBatchComputeNode -PoolId "MyPool" -Id "tvm-3257026573_2-20150813t200938z" -BatchContext $Context -``` - -This command reimages the compute node with ID "tvm-3257026573_2-20150813t200938z" in the pool named MyPool. -Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable. - -### Example 2: Reimage all nodes in a pool -``` -PS C:\>Get-AzureBatchComputeNode -PoolId "MyPool" -BatchContext $Context | Reset-AzureBatchComputeNode -BatchContext $Context -``` - -This command reimages every compute node in the pool named MyPool. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ComputeNode -Specifies the **PSComputeNode** object that represents the compute node to reimage. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSComputeNode -Parameter Sets: InputObject -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the compute node to reimage. - -```yaml -Type: System.String -Parameter Sets: Id -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PoolId -Specifies the ID of the pool that contains the compute node. - -```yaml -Type: System.String -Parameter Sets: Id -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReimageOption -Specifies when to reimage the node and what to do with currently running tasks. -The default is Requeue. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Batch.Common.ComputeNodeReimageOption] -Parameter Sets: (All) -Aliases: -Accepted values: Requeue, Terminate, TaskCompletion, RetainedData - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSComputeNode -Parameters: ComputeNode (ByValue) - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureBatchComputeNode](./Get-AzureBatchComputeNode.md) - -[Restart-AzureBatchComputeNode](./Restart-AzureBatchComputeNode.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Restart-AzureBatchComputeNode.md b/azurermps-6.13.0/AzureRM.Batch/Restart-AzureBatchComputeNode.md deleted file mode 100644 index bbe56047ae..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Restart-AzureBatchComputeNode.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 029361F0-C4E9-4948-9EBA-BFBD1B029909 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/restart-azurebatchcomputenode -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Restart-AzureBatchComputeNode.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Restart-AzureBatchComputeNode.md ---- - -# Restart-AzureBatchComputeNode - -## SYNOPSIS -Reboots the specified compute node. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Id (Default) -``` -Restart-AzureBatchComputeNode [-PoolId] [-Id] [[-RebootOption] ] - -BatchContext [-DefaultProfile ] [] -``` - -### InputObject -``` -Restart-AzureBatchComputeNode [[-ComputeNode] ] [[-RebootOption] ] - -BatchContext [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Restart-AzureBatchComputeNode** cmdlet reboots the specified compute node. - -## EXAMPLES - -### Example 1: Restart a compute node -``` -PS C:\>Restart-AzureBatchComputeNode -PoolId "MyPool" -Id "tvm-3257026573_2-20150813t200938z" -BatchContext $Context -``` - -This command reboots the compute node with the ID "tvm-3257026573_2-20150813t200938z" in the pool MyPool. - -### Example 2: Restart every compute node in a pool -``` -PS C:\>Get-AzureBatchComputeNode -PoolId "MyPool" -BatchContext $Context | Restart-AzureBatchComputeNode -BatchContext $Context -``` - -This command reboots every compute node in the pool MyPool. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ComputeNode -Specifies the **PSComputeNode** object that represents the compute node to reboot. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSComputeNode -Parameter Sets: InputObject -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the compute node to reboot. - -```yaml -Type: System.String -Parameter Sets: Id -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PoolId -Specifies the ID of the pool that contains the compute node. - -```yaml -Type: System.String -Parameter Sets: Id -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RebootOption -Specifies when to reboot the node and what to do with currently running tasks. -The default is Requeue. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Batch.Common.ComputeNodeRebootOption] -Parameter Sets: (All) -Aliases: -Accepted values: Requeue, Terminate, TaskCompletion, RetainedData - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSComputeNode -Parameters: ComputeNode (ByValue) - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureBatchComputeNode](./Get-AzureBatchComputeNode.md) - -[Reset-AzureBatchComputeNode](./Reset-AzureBatchComputeNode.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Set-AzureBatchComputeNodeUser.md b/azurermps-6.13.0/AzureRM.Batch/Set-AzureBatchComputeNodeUser.md deleted file mode 100644 index f28f46dba3..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Set-AzureBatchComputeNodeUser.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: A0D620DA-B5A3-4F8F-BD43-A58630C95432 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/set-azurebatchcomputenodeuser -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchComputeNodeUser.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchComputeNodeUser.md ---- - -# Set-AzureBatchComputeNodeUser - -## SYNOPSIS -Modifies properties of an account on a Batch compute node. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureBatchComputeNodeUser [-PoolId] [-ComputeNodeId] [-Name] - [-Password] [-ExpiryTime ] -BatchContext - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Set-AzureBatchComputeNodeUser** cmdlet modifies properties of a user account on an Azure Batch compute node. - -## EXAMPLES - -### Example 1: Update a user account -``` -PS C:\>Set-AzureBatchComputeNodeUser -PoolId "ContosoPool" -ComputeNodeId "tvm-3257026573_1-20150904t230807z" -Name "PFuller" -BatchContext $Context -Password "Password" -ExpiryTime ([DateTime]::Now.AddDays(14)) -``` - -This command modifies user account named PFuller on the compute node that has the specified ID in the pool named ContosoPool. -The command changes the account password and expiry time. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ComputeNodeId -Specifies the ID of the compute node on which this cmdlet operates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpiryTime -Specifies the expiry time for the user account. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the user account that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -Specifies the password for the user account. - -```yaml -Type: System.Security.SecureString -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PoolId -Specifies the ID of the pool that contains the compute node on which this cmdlet operates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[New-AzureBatchComputeNodeUser](./New-AzureBatchComputeNodeUser.md) - -[Remove-AzureBatchComputeNodeUser](./Remove-AzureBatchComputeNodeUser.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Set-AzureBatchJob.md b/azurermps-6.13.0/AzureRM.Batch/Set-AzureBatchJob.md deleted file mode 100644 index 5611fdb215..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Set-AzureBatchJob.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 75483BC7-440A-437B-9EDE-D270D87CF3C5 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/set-azurebatchjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchJob.md ---- - -# Set-AzureBatchJob - -## SYNOPSIS -Updates a Batch job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureBatchJob [-Job] -BatchContext - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Set-AzureBatchJob** cmdlet updates an Azure Batch job. -Use the Get-AzureBatchJob cmdlet to get a **PSCloudJob** object. -Modify the properties of that object, and then use the current cmdlet to commit your changes to the Batch service. - -## EXAMPLES - -### Example 1: Update a job -``` -PS C:\>$Job = Get-AzureBatchJob -Id "Job17" -BatchContext $Context -PS C:\> $Job.Priority = 1 -PS C:\> Set-AzureBatchJob -Job $Job -BatchContext $Context -``` - -The first command gets a pool by using **Get-AzureBatchJob**, and then stores it in the $Job variable. -The second command modifies the priority specification on the $Job object. -The final command updates the Batch service to match the local object in $Job. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Job -Specifies a **PSCloudJob** to which this cmdlet updates the Batch service. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSCloudJob -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSCloudJob -Parameters: Job (ByValue) - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Disable-AzureBatchJob](./Disable-AzureBatchJob.md) - -[Enable-AzureBatchJob](./Enable-AzureBatchJob.md) - -[Get-AzureBatchJob](./Get-AzureBatchJob.md) - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[New-AzureBatchJob](./New-AzureBatchJob.md) - -[Remove-AzureBatchJob](./Remove-AzureBatchJob.md) - -[Stop-AzureBatchJob](./Stop-AzureBatchJob.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Set-AzureBatchJobSchedule.md b/azurermps-6.13.0/AzureRM.Batch/Set-AzureBatchJobSchedule.md deleted file mode 100644 index 35a43fe944..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Set-AzureBatchJobSchedule.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 14026F0E-4959-4150-A31F-A94BC56ED808 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/set-azurebatchjobschedule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchJobSchedule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchJobSchedule.md ---- - -# Set-AzureBatchJobSchedule - -## SYNOPSIS -Sets a job schedule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureBatchJobSchedule [-JobSchedule] -BatchContext - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Set-AzureBatchJobSchedule** cmdlet sets a job schedule in the Azure Batch service. - -## EXAMPLES - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobSchedule -Specifies a **PSCloudJobSchedule** object that represents a job schedule. -To obtain a **PSCloudJobSchedule** object, use the Get-AzureBatchJobSchedule cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSCloudJobSchedule -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSCloudJobSchedule -Parameters: JobSchedule (ByValue) - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Disable-AzureBatchJobSchedule](./Disable-AzureBatchJobSchedule.md) - -[Enable-AzureBatchJobSchedule](./Enable-AzureBatchJobSchedule.md) - -[Get-AzureBatchJobSchedule](./Get-AzureBatchJobSchedule.md) - -[New-AzureBatchJobSchedule](./New-AzureBatchJobSchedule.md) - -[Remove-AzureBatchJobSchedule](./Remove-AzureBatchJobSchedule.md) - -[Stop-AzureBatchJobSchedule](./Stop-AzureBatchJobSchedule.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Set-AzureBatchPool.md b/azurermps-6.13.0/AzureRM.Batch/Set-AzureBatchPool.md deleted file mode 100644 index 4a9cb88b95..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Set-AzureBatchPool.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 23893EAE-47F3-45AA-AEB2-354FB8316C25 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/set-azurebatchpool -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchPool.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchPool.md ---- - -# Set-AzureBatchPool - -## SYNOPSIS -Updates the properties of a pool. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureBatchPool [-Pool] -BatchContext - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Set-AzureBatchPool** cmdlet updates the properties of a pool in the Azure Batch service. -Use the Get-AzureBatchPool cmdlet to get a **PSCloudPool** object. -Modify the properties of that object, and then use the current cmdlet to commit your changes to the Batch service. - -## EXAMPLES - -### Example 1: Update a pool -``` -PS C:\>$Pool = Get-AzureBatchPool "ContosoPool" -BatchContext $Context -PS C:\> $StartTask = New-Object Microsoft.Azure.Commands.Batch.Models.PSStartTask -PS C:\> $StartTask.CommandLine = "cmd /c echo example" -PS C:\> $Pool.StartTask = $StartTask -PS C:\> Set-AzureBatchPool -Pool $Pool -BatchContext $Context -``` - -The first command gets a pool by using **Get-AzureBatchPool**, and then stores it in the $Pool variable. -The next three commands modify the start task specification on the $Pool object. -The final command updates the Batch service to match the local object in $Pool. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pool -Specifies the **PSCloudPool** to which this cmdlet updates the Batch service. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSCloudPool -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSCloudPool -Parameters: Pool (ByValue) - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureBatchPool](./Get-AzureBatchPool.md) - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[New-AzureBatchPool](./New-AzureBatchPool.md) - -[Remove-AzureBatchPool](./Remove-AzureBatchPool.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Set-AzureBatchPoolOSVersion.md b/azurermps-6.13.0/AzureRM.Batch/Set-AzureBatchPoolOSVersion.md deleted file mode 100644 index 87375f0c7c..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Set-AzureBatchPoolOSVersion.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 4C3C6C81-7486-4ED6-BA30-2F202E654F77 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/set-azurebatchpoolosversion -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchPoolOSVersion.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchPoolOSVersion.md ---- - -# Set-AzureBatchPoolOSVersion - -## SYNOPSIS -Changes the operating system version of the specified pool. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureBatchPoolOSVersion [-Id] [-TargetOSVersion] -BatchContext - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Set-AzureBatchPoolOSVersion** cmdlet changes the operating system version of the specified pool. - -## EXAMPLES - -### Example 1: Set the target operating system version of a pool -``` -PS C:\>Set-AzureBatchPoolOSVersion -Id "MyPool" -TargetOSVersion "WA-GUEST-OS-4.20_201505-01" -BatchContext $Context -``` - -This command sets the target operating system version of pool MyPool to WA-GUEST-OS-4.20_201505-01. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the pool. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -TargetOSVersion -Specifies the Azure Guest operating system version to install on the virtual machines in the pool. -For more information on Azure Guest operating system versions, see Azure Guest OS Releases and SDK Compatibility Matrixhttps://azure.microsoft.com/en-us/documentation/articles/cloud-services-guestos-update-matrix/ (https://azure.microsoft.com/en-us/documentation/articles/cloud-services-guestos-update-matrix/). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Set-AzureBatchTask.md b/azurermps-6.13.0/AzureRM.Batch/Set-AzureBatchTask.md deleted file mode 100644 index bdd71cf627..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Set-AzureBatchTask.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 6A6D6C7D-EED7-4AD4-ACE6-BFA64404455E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/set-azurebatchtask -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchTask.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchTask.md ---- - -# Set-AzureBatchTask - -## SYNOPSIS -Updates the properties of a task. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureBatchTask [-Task] -BatchContext - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Set-AzureBatchTask** cmdlet updates the properties of a task in the Azure Batch service. -Use the Get-AzureBatchTask cmdlet to get a **PSCloudTask** object. -Modify the properties of that object, and then use the current cmdlet to commit your changes to the Batch service. - -## EXAMPLES - -### Example 1: Update a task -``` -PS C:\>$Task = Get-AzureBatchTask -JobId "Job16" -Id "Task22" -BatchContext $Context -PS C:\> $Constraints = New-Object Microsoft.Azure.Commands.Batch.Models.PSTaskConstraints -ArgumentList @([TimeSpan}::FromDays(5), [TimeSpan]::FromDays(2), 3) -PS C:\> $Task.Constraints = $Constraints -PS C:\> Set-AzureBatchTask -Task $Task -BatchContext $Context -``` - -The first command gets a task by using **Get-AzureBatchTask**, and then stores it in the $Task variable. -The next two commands modify the constraints of the task in $Task. -The final command updates the Batch service to match the local object in $Task. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Task -Specifies the **PSCloudTask** to which this cmdlet updates the Batch service. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSCloudTask -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSCloudTask -Parameters: Task (ByValue) - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureBatchTask](./Get-AzureBatchTask.md) - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[New-AzureBatchTask](./New-AzureBatchTask.md) - -[Remove-AzureBatchTask](./Remove-AzureBatchTask.md) - -[Stop-AzureBatchTask](./Stop-AzureBatchTask.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Set-AzureRmBatchAccount.md b/azurermps-6.13.0/AzureRM.Batch/Set-AzureRmBatchAccount.md deleted file mode 100644 index 14e1ced056..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Set-AzureRmBatchAccount.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 9BEE5888-304D-4438-BE97-D1FE254AEE98 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/set-azurermbatchaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureRmBatchAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureRmBatchAccount.md ---- - -# Set-AzureRmBatchAccount - -## SYNOPSIS -Updates a Batch account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmBatchAccount [-AccountName] [-Tag] [-ResourceGroupName ] - [-AutoStorageAccountId ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Set-AzureRmBatchAccount** cmdlet updates an Azure Batch account. -Currently, this cmdlet can update only tags. - -## EXAMPLES - -### Example 1: Update the tags on a Batch account -``` -PS C:\>Set-AzureRmBatchAccount -AccountName "cmdletexample" -Tag @{key0="value0";key1=$null;key2="value2"} -AccountName : cmdletexample -Location : westus -ResourceGroupName : CmdletExampleRG -CoreQuota : 20 -PoolQuota : 20 -ActiveJobAndJobScheduleQuota : 20 -Tags : - Name Value - ==== ====== - key0 value0 - key1 - key2 value2 -TaskTenantUrl : https://cmdletexample.westus.batch.azure.com -``` - -This command updates the tags on the account named pfuller. - -## PARAMETERS - -### -AccountName -Specifies the name of the Batch account that this cmdlet updates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AutoStorageAccountId -Specifies the resource ID of the storage account to be used for auto storage. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group of the account that this cmdlet updates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.Batch.BatchAccountContext - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchAccount](./Get-AzureRmBatchAccount.md) - -[New-AzureRmBatchAccount](./New-AzureRmBatchAccount.md) - -[Remove-AzureRmBatchAccount](./Remove-AzureRmBatchAccount.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Set-AzureRmBatchApplication.md b/azurermps-6.13.0/AzureRM.Batch/Set-AzureRmBatchApplication.md deleted file mode 100644 index fde52b8244..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Set-AzureRmBatchApplication.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: DCA1FD7A-54AF-48B1-A245-BFA9C43ACA9B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/set-azurermbatchapplication -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureRmBatchApplication.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureRmBatchApplication.md ---- - -# Set-AzureRmBatchApplication - -## SYNOPSIS -Updates settings for the specified application. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmBatchApplication [-AccountName] [-ResourceGroupName] [-ApplicationId] - [[-DisplayName] ] [[-DefaultVersion] ] [[-AllowUpdates] ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Set-AzureRmBatchApplication** cmdlet modifies settings for the specified Azure Batch application. - -## EXAMPLES - -### Example 1: Update an application in a Batch account -``` -PS C:\>Set-AzureRmBatchApplication -AccountName "ContosoBatch" -ResourceGroupName "ContosoBatchGroup" -ApplicationId "Litware" -AllowUpdates $False -``` - -This command changes whether the Llitware application in the ContosoBatch account allows updates. -The command does not change the default version or display name of the application. - -## PARAMETERS - -### -AccountName -Specifies the name of the Batch account for which this cmdlet modifies an application. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AllowUpdates -Specifies whether packages within the application can be overwritten using the same version string. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationId -Specifies the ID of the application. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultVersion -Specifies which package to use if a client requests the application but does not specify a version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the display name for the application. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the Batch account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchApplication](./Get-AzureRmBatchApplication.md) - -[Get-AzureRmBatchApplicationPackage](./Get-AzureRmBatchApplicationPackage.md) - -[New-AzureRmBatchApplication](./New-AzureRmBatchApplication.md) - -[New-AzureRmBatchApplicationPackage](./New-AzureRmBatchApplicationPackage.md) - -[Remove-AzureRmBatchApplication](./Remove-AzureRmBatchApplication.md) - -[Remove-AzureRmBatchApplicationPackage](./Remove-AzureRmBatchApplicationPackage.md) - - diff --git a/azurermps-6.13.0/AzureRM.Batch/Start-AzureBatchComputeNodeServiceLogUpload.md b/azurermps-6.13.0/AzureRM.Batch/Start-AzureBatchComputeNodeServiceLogUpload.md deleted file mode 100644 index 7b03071206..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Start-AzureBatchComputeNodeServiceLogUpload.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/Start-AzureBatchComputeNodeServiceLogUpload -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Start-AzureBatchComputeNodeServiceLogUpload.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Start-AzureBatchComputeNodeServiceLogUpload.md ---- - -# Start-AzureBatchComputeNodeServiceLogUpload - -## SYNOPSIS -Upload compute node service log files to an Azure Storage container. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### AzureBatchComputeNodeServiceLogUpload (Default) -``` -Start-AzureBatchComputeNodeServiceLogUpload [-ContainerUrl] [-StartTime] - [-EndTime ] -BatchContext [-DefaultProfile ] [-WhatIf] - [-Confirm] [] -``` - -### Id -``` -Start-AzureBatchComputeNodeServiceLogUpload [-PoolId] [-ComputeNodeId] - [-ContainerUrl] [-StartTime] [-EndTime ] -BatchContext - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### ParentObject -``` -Start-AzureBatchComputeNodeServiceLogUpload [-ComputeNode] [-ContainerUrl] - [-StartTime] [-EndTime ] -BatchContext - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This cmdlet gathers Azure Batch service log files from compute nodes if you are experiencing an error and wish to escalate to Azure support. The Azure Batch service log files should be shared with Azure support to aid in debugging issues with the Batch service. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> $storageContext = New-AzureStorageContext -StorageAccountName "contosogeneral" -StorageAccountKey "" -PS C:\> $sasToken = New-AzureStorageContainerSASToken -Name "contosocontainer" -Context $storageContext -PS C:\> $containerUrl = "https://contosogeneral.blob.core.windows.net/contosocontainer" + $sasToken -PS C:\> $batchContext = Get-AzureRmBatchAccountKeys -AccountName "contosobatch" -PS C:\> Start-AzureBatchComputeNodeServiceLogUpload -BatchContext $batchContext -PoolId "contosopool" -ComputeNodeId "tvm-1612030122_1-20180405t234700z" -ContainerUrl $containerUrl -StartTime "2018-01-01 00:00:00Z" - -NumberOfFilesUploaded VirtualDirectoryName ---------------------- -------------------- - 4 contosobatch-22F48D278AD60CC2/contosopool/tvm-1612030122_1-20180405t234700z/bc3dd583-19a5-4665-aa83-87e4e1237d35 -``` - -Upload compute node service logs written on or after January 1, 2018 midnight, which were obtained from the compute node, given pool id of the pool in which the compute node resides, and compute node id. - -### Example 2 - -```powershell -PS C:\> $storageContext = New-AzureStorageContext -StorageAccountName "contosogeneral" -StorageAccountKey "" -PS C:\> $sasToken = New-AzureStorageContainerSASToken -Name "contosocontainer" -Context $storageContext -PS C:\> $containerUrl = "https://contosogeneral.blob.core.windows.net/contosocontainer" + $sasToken -PS C:\> $batchContext = Get-AzureRmBatchAccountKeys -AccountName "contosobatch" -PS C:\> Start-AzureBatchComputeNodeServiceLogUpload -BatchContext $batchContext -PoolId "contosopool" -ComputeNodeId "tvm-1612030122_1-20180405t234700z" -ContainerUrl $containerUrl -StartTime "2018-01-01 00:00:00Z" -EndTime "2018-01-10 00:00:00Z" - -NumberOfFilesUploaded VirtualDirectoryName ---------------------- -------------------- - 2 contosobatch-22F48D278AD60CC2/contosopool/tvm-1612030122_1-20180405t234700z/bc3dd583-19a5-4665-aa83-87e4e1237d35 -``` - -Upload compute node service logs written on or after January 1, 2018 midnight and before January 10, 2018 midnight, which were obtained from the compute node, given pool id of the pool in which the compute node resides, and compute node id. - -### Example 3 - -```powershell -PS C:\> $storageContext = New-AzureStorageContext -StorageAccountName "contosogeneral" -StorageAccountKey "" -PS C:\> $sasToken = New-AzureStorageContainerSASToken -Name "contosocontainer" -Context $storageContext -PS C:\> $containerUrl = "https://contosogeneral.blob.core.windows.net/contosocontainer" + $sasToken -PS C:\> $batchContext = Get-AzureRmBatchAccountKeys -AccountName "contosobatch" -PS C:\> Get-AzureBatchComputeNode -BatchContext $batchContext -Id "tvm-1612030122_1-20180405t234700z" -PoolId "contosopool" | Start-AzureBatchComputeNodeServiceLogUpload -BatchContext $batchContext -ContainerUrl $containerUrl -StartTime "2018-01-01 00:00:00Z" -EndTime "2018-01-10 00:00:00Z" - -NumberOfFilesUploaded VirtualDirectoryName ---------------------- -------------------- - 2 contosobatch-22F48D278AD60CC2/contosopool/tvm-1612030122_1-20180405t234700z/bc3dd583-19a5-4665-aa83-87e4e1237d35 -``` - -Upload compute node service logs written on or after January 1, 2018 midnight and before January 10, 2018 midnight, which were obtained from the compute node object. - -## PARAMETERS - -### -BatchContext -The BatchAccountContext instance to use when interacting with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. -To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. -When using shared key authentication, the primary access key is used by default. -To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ComputeNode -Specifies the **PSComputeNode** object from which service logs are retrieved. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSComputeNode -Parameter Sets: ParentObject -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ComputeNodeId -The id of the compute node. - -```yaml -Type: System.String -Parameter Sets: Id -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContainerUrl -The container url to Azure Storage. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndTime -The end time of service log to be uploaded (optional). - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PoolId -The id of the pool that contains the compute node. - -```yaml -Type: System.String -Parameter Sets: Id -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -The start time of service log to be uploaded. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSComputeNode -Parameters: ComputeNode (ByValue) - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSStartComputeNodeServiceLogUploadResult - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Batch/Start-AzureBatchPoolResize.md b/azurermps-6.13.0/AzureRM.Batch/Start-AzureBatchPoolResize.md deleted file mode 100644 index 51ce88ff14..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Start-AzureBatchPoolResize.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 82DC8DC4-D8EC-4847-A54C-B779256FD590 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/start-azurebatchpoolresize -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Start-AzureBatchPoolResize.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Start-AzureBatchPoolResize.md ---- - -# Start-AzureBatchPoolResize - -## SYNOPSIS -Starts to resize a pool. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Start-AzureBatchPoolResize [-Id] [-TargetDedicatedComputeNodes ] - [-TargetLowPriorityComputeNodes ] [-ResizeTimeout ] - [-ComputeNodeDeallocationOption ] -BatchContext - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Start-AzureBatchPoolResize** cmdlet starts an Azure Batch resize operation on a pool. - -## EXAMPLES - -### Example 1: Resize a pool to 12 nodes -``` -PS C:\>Start-AzureBatchPoolResize -Id "ContosoPool06" -TargetDedicatedComputeNodes 12 -BatchContext $Context -``` - -This command starts a resize operation on the pool that has the ID ContosoPool06. -The target for the operation is 12 dedicated compute nodes. -Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable. - -### Example 2: Resize a pool using a deallocation option -``` -PS C:\>Get-AzureBatchPool -Id "ContosoPool06" -BatchContext $Context | Start-AzureBatchPoolResize -TargetDedicatedComputeNodes 5 -ResizeTimeout ([TimeSpan]::FromHours(1)) -ComputeNodeDeallocationOption ([Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption]::Terminate) -BatchContext $Context -``` - -This cmdlet resizes a pool to five dedicated compute nodes. -The command gets the pool that has the ID ContosoPool06 by using the Get-AzureBatchPool cmdlet. -The command passes that pool object to the current cmdlet by using the pipeline operator. -The command starts a resize operation on the pool. -The target is five dedicated compute nodes. -The command specifies time-out period of one hour. -The command specifies a deallocation option of Terminate. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ComputeNodeDeallocationOption -Specifies a deallocation option for the resizing operation that this cmdlet starts. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption] -Parameter Sets: (All) -Aliases: -Accepted values: Requeue, Terminate, TaskCompletion, RetainedData - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the pool that this cmdlet resizes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ResizeTimeout -Specifies a time-out period for the resizing operation. -If the pool does not reach the target size by this time, the resize operation stops. - -```yaml -Type: System.Nullable`1[System.TimeSpan] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetDedicatedComputeNodes -The number of target dedicated compute nodes. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: TargetDedicated - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetLowPriorityComputeNodes -The number of target low-priority compute nodes. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[Get-AzureBatchPool](./Get-AzureBatchPool.md) - -[Stop-AzureBatchPoolResize](./Stop-AzureBatchPoolResize.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Stop-AzureBatchCertificateDeletion.md b/azurermps-6.13.0/AzureRM.Batch/Stop-AzureBatchCertificateDeletion.md deleted file mode 100644 index 6e61ab8972..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Stop-AzureBatchCertificateDeletion.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: B3C8A2DB-6571-418D-8C4B-3BE3FDA42F89 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/stop-azurebatchcertificatedeletion -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchCertificateDeletion.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchCertificateDeletion.md ---- - -# Stop-AzureBatchCertificateDeletion - -## SYNOPSIS -Cancels a failed deletion of a certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Stop-AzureBatchCertificateDeletion [-ThumbprintAlgorithm] [-Thumbprint] - -BatchContext [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Stop-AzureBatchCertificateDeletion** cmdlet cancels a failed deletion of a certificate in the Azure Batch service. -You can stop a deletion only if the certificate is in the **DeleteFailed** state. -This cmldet restores the certificate to the **Active** state. - -## EXAMPLES - -### Example 1: Cancel a deletion -``` -PS C:\>Stop-AzureBatchCertificateDeletion -ThumbprintAlgorithm "sha1" -Thumbprint "c1e494a415149c5f211c4778b52f2e834a07247c" -BatchContext $Context -``` - -This command cancels the deletion of the certificate that has the specified thumbprint. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Thumbprint -Specifies the thumbprint of the certificate that this cmdlet restores to the **Active** state. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThumbprintAlgorithm -Specifies the algorithm used to derive the *Thumbprint* parameter. -Currently, the only valid value is sha1. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[Remove-AzureBatchCertificate](./Remove-AzureBatchCertificate.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Stop-AzureBatchJob.md b/azurermps-6.13.0/AzureRM.Batch/Stop-AzureBatchJob.md deleted file mode 100644 index 116726d9c6..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Stop-AzureBatchJob.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 975B707C-5001-43ED-81AB-9BB6665135BA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/stop-azurebatchjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchJob.md ---- - -# Stop-AzureBatchJob - -## SYNOPSIS -Stops a Batch job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Stop-AzureBatchJob [-Id] [[-TerminateReason] ] -BatchContext - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Stop-AzureBatchJob** cmdlet stops an Azure Batch job. -This command marks the job as completed. - -## EXAMPLES - -### Example 1: Stop a Batch job -``` -PS C:\>Stop-AzureBatchJob -Id "Job-000001" -TerminateReason "No more tasks to run" -BatchContext $Context -``` - -This command stops the job that has the ID Job-000001. -The command specifies a reason that you chose to stop the job. -Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the job that this cmdlet stops. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -TerminateReason -Specifies the reason that you decided to stop the job. -This cmdlet stores this text as the **TerminateReason** property of the job. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Disable-AzureBatchJob](./Disable-AzureBatchJob.md) - -[Enable-AzureBatchJob](./Enable-AzureBatchJob.md) - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[Get-AzureBatchJob](./Get-AzureBatchJob.md) - -[New-AzureBatchJob](./New-AzureBatchJob.md) - -[Remove-AzureBatchJob](./Remove-AzureBatchJob.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Stop-AzureBatchJobSchedule.md b/azurermps-6.13.0/AzureRM.Batch/Stop-AzureBatchJobSchedule.md deleted file mode 100644 index 182b3ade91..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Stop-AzureBatchJobSchedule.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: D1C5B35C-5419-4739-9D57-6C4228E98DAC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/stop-azurebatchjobschedule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchJobSchedule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchJobSchedule.md ---- - -# Stop-AzureBatchJobSchedule - -## SYNOPSIS -Stops a Batch job schedule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Stop-AzureBatchJobSchedule [-Id] -BatchContext - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Stop-AzureBatchJobSchedule** cmdlet stops an Azure Batch job schedule. - -## EXAMPLES - -### Example 1: Stop a job schedule -``` -PS C:\>Stop-AzureBatchJobSchedule -Id "JobSchedule17" -BatchContext $Context -``` - -This command stops the job schedule that has the ID JobSchedule17. -Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the job schedule that this cmdlet stops. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Disable-AzureBatchJobSchedule](./Disable-AzureBatchJobSchedule.md) - -[Enable-AzureBatchJobSchedule](./Enable-AzureBatchJobSchedule.md) - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[Get-AzureBatchJobSchedule](./Get-AzureBatchJobSchedule.md) - -[New-AzureBatchJobSchedule](./New-AzureBatchJobSchedule.md) - -[Remove-AzureBatchJobSchedule](./Remove-AzureBatchJobSchedule.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Stop-AzureBatchPoolResize.md b/azurermps-6.13.0/AzureRM.Batch/Stop-AzureBatchPoolResize.md deleted file mode 100644 index 48aa624610..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Stop-AzureBatchPoolResize.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 3E736E85-0488-4D10-BEA1-4F9B8DA54C4B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/stop-azurebatchpoolresize -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchPoolResize.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchPoolResize.md ---- - -# Stop-AzureBatchPoolResize - -## SYNOPSIS -Stops a pool resize operation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Stop-AzureBatchPoolResize [-Id] -BatchContext - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Stop-AzureBatchPoolResize** cmdlet stops an Azure Batch resize operation on a pool. - -## EXAMPLES - -### Example 1: Stop resizing a pool -``` -PS C:\>Stop-AzureBatchPoolResize -Id "ContosoPool06" -BatchContext $Context -``` - -This command stops a resize operation on the pool that has the ID ContosoPool06. -Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable. - -### Example 2: Stop resizing a pool by using the pipeline -``` -PS C:\>Get-AzureBatchPool -Id "ContosoPool06" -BatchContext $Context | Stop-AzureBatchPoolResize -BatchContext $Context -``` - -This command stops resizing a pool by using the pipeline operator. -The command gets the pool that has the ID ContosoPool06 by using the Get-AzureBatchPool cmdlet. -The command passes that pool object to the current cmdlet. -The command stops the resize operation on that pool. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the pool for which this cmdlet stops a resizing operation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[Get-AzureBatchPool](./Get-AzureBatchPool.md) - -[Start-AzureBatchPoolResize](./Start-AzureBatchPoolResize.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Stop-AzureBatchTask.md b/azurermps-6.13.0/AzureRM.Batch/Stop-AzureBatchTask.md deleted file mode 100644 index e62ebfc960..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Stop-AzureBatchTask.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: 1EA57372-6FA5-45C9-94A1-50D53830FC10 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/stop-azurebatchtask -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchTask.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchTask.md ---- - -# Stop-AzureBatchTask - -## SYNOPSIS -Stops a Batch task. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Id -``` -Stop-AzureBatchTask [-JobId] [-Id] -BatchContext - [-DefaultProfile ] [] -``` - -### InputObject -``` -Stop-AzureBatchTask [-Task] -BatchContext - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Stop-AzureBatchTask** cmdlet stops an Azure Batch task. - -## EXAMPLES - -### Example 1: Delete a Batch task by ID -``` -PS C:\>Stop-AzureBatchTask -JobId "Job-000001" -Id "Task23" -BatchContext $Context -``` - -This command stops a task that has the ID Task23 under the job that has the ID Job-000001. -The command prompts you for confirmation. -Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable. - -### Example 2: Stop a Batch task by using the pipeline -``` -PS C:\>Get-AzureBatchTask -JobId "Job-000001" -Id "Task26" -BatchContext $Context | Stop-AzureBatchTask -BatchContext $Context -``` - -This command gets the Batch task that has the ID Task26 in the job that has the ID Job-000001 by using the Get-AzureBatchTask cmdlet. -The command passes that task to the current cmdlet by using the pipeline operator. -The command stops that task. - -## PARAMETERS - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the task that this cmdlet stops. - -```yaml -Type: System.String -Parameter Sets: Id -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -JobId -Specifies the ID of the job that contains the task. - -```yaml -Type: System.String -Parameter Sets: Id -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Task -Specifies the task that this cmdlet stops. -To obtain a **PSCloudTask** object, use the Get-AzureBatchTask cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Batch.Models.PSCloudTask -Parameter Sets: InputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.Models.PSCloudTask -Parameters: Task (ByValue) - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureBatchTask](./Get-AzureBatchTask.md) - -[New-AzureBatchTask](./New-AzureBatchTask.md) - -[Remove-AzureBatchTask](./Remove-AzureBatchTask.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Batch/Test-AzureBatchAutoScale.md b/azurermps-6.13.0/AzureRM.Batch/Test-AzureBatchAutoScale.md deleted file mode 100644 index 604ab611c8..0000000000 --- a/azurermps-6.13.0/AzureRM.Batch/Test-AzureBatchAutoScale.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml -Module Name: AzureRM.Batch -ms.assetid: BF0C1A2F-2703-492F-A3A7-053416A5D1EB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/test-azurebatchautoscale -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Test-AzureBatchAutoScale.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AzureBatch/Commands.Batch/help/Test-AzureBatchAutoScale.md ---- - -# Test-AzureBatchAutoScale - -## SYNOPSIS -Gets the result of an automatic scaling formula on a pool. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Test-AzureBatchAutoScale [-Id] [-AutoScaleFormula] -BatchContext - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Test-AzureBatchAutoScale** cmdlet gets the result of an automatic scaling formula on the specified pool. - -## EXAMPLES - -### Example 1: Evaluate an autoscale formula on a pool -``` -PS C:\>$Formula = 'totalNodes=($CPUPercent.GetSamplePercent(TimeInterval_Minute*0,TimeInterval_Minute*10)<0.7?5:(min($CPUPercent.GetSample(TimeInterval_Minute*0, TimeInterval_Minute*10))>0.8?($CurrentDedicated*1.1):$CurrentDedicated));$TargetDedicated=min(100,totalNodes);'; -PS C:\> $Evaluation = Test-AzureBatchAutoScale -Id "ContosoPool" -AutoScaleFormula $Formula -BatchContext $Context -PS C:\> $Evaluation.AutoScaleRun.Results -$TargetDedicated=5;$NodeDeallocationOption=requeue;totalNodes=5 -``` - -The first command stores a formula in the $Formula variable for use in the example. -The second command evaluates the autoscale formula on the pool that has the ID ContosoPool. -The final command displays the **Results** by using standard dot syntax. - -## PARAMETERS - -### -AutoScaleFormula -Specifies the formula for the desired number of compute nodes in the pool. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BatchContext -Specifies the **BatchAccountContext** instance that this cmdlet uses to interact with the Batch service. -If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property. - -```yaml -Type: Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the object ID of the pool for which to test automatic scaling. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Batch.BatchAccountContext -Parameters: BatchContext (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Batch.Models.PSAutoScaleRun - -## NOTES - -## RELATED LINKS - -[Disable-AzureBatchAutoScale](./Disable-AzureBatchAutoScale.md) - -[Enable-AzureBatchAutoScale](./Enable-AzureBatchAutoScale.md) - -[Get-AzureRmBatchAccountKeys](./Get-AzureRmBatchAccountKeys.md) - -[Azure Batch Cmdlets](./AzureRM.Batch.md) diff --git a/azurermps-6.13.0/AzureRM.Billing/AzureRM.Billing.md b/azurermps-6.13.0/AzureRM.Billing/AzureRM.Billing.md deleted file mode 100644 index 0fb1c8fa17..0000000000 --- a/azurermps-6.13.0/AzureRM.Billing/AzureRM.Billing.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -Module Name: AzureRM.Billing -Module Guid: a1f34ce9-bf46-4180-b36c-be232a1f8f63 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.billing -Help Version: 2.0.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Billing/Commands.Billing/help/AzureRM.Billing.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Billing/Commands.Billing/help/AzureRM.Billing.md ---- - -# AzureRM.Billing Module -## Description -The topics in this section document the Azure PowerShell cmdlets for Azure Billing in the Azure Resource Manager (ARM) framework. The cmdlets exist in the Microsoft.Azure.Commands.Billing namespace. - -## AzureRM.Billing Cmdlets -### [Get-AzureRmBillingInvoice](Get-AzureRmBillingInvoice.md) -Get billing invoices of the subscription. - -### [Get-AzureRmBillingPeriod](Get-AzureRmBillingPeriod.md) -Get billing periods of the subscription. - -### [Get-AzureRmEnrollmentAccount](Get-AzureRmEnrollmentAccount.md) -Get enrollment accounts. - diff --git a/azurermps-6.13.0/AzureRM.Billing/Get-AzureRmBillingInvoice.md b/azurermps-6.13.0/AzureRM.Billing/Get-AzureRmBillingInvoice.md deleted file mode 100644 index 6131de2cd7..0000000000 --- a/azurermps-6.13.0/AzureRM.Billing/Get-AzureRmBillingInvoice.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Billing.dll-Help.xml -Module Name: AzureRM.Billing -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.billing/get-azurermbillinginvoice -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Billing/Commands.Billing/help/Get-AzureRmBillingInvoice.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Billing/Commands.Billing/help/Get-AzureRmBillingInvoice.md ---- - -# Get-AzureRmBillingInvoice - -## SYNOPSIS -Get billing invoices of the subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### List (Default) -``` -Get-AzureRmBillingInvoice [-MaxCount ] [-GenerateDownloadUrl] [-DefaultProfile ] - [] -``` - -### Latest -``` -Get-AzureRmBillingInvoice [-Latest] [-DefaultProfile ] [] -``` - -### Single -``` -Get-AzureRmBillingInvoice -Name - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmBillingInvoice** cmdlet gets billing invoices of the subscription. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmBillingInvoice -Latest -``` - -Get the latest invoice of the subscription. - -### Example 2 -``` -PS C:\> Get-AzureRmBillingInvoice -Name 2017-02-18-432543543 -``` - -Get the invoice of the subscription with the specified name. - -### Example 3 -``` -PS C:\> Get-AzureRmBillingInvoice -``` - -Get all available invoices of the subscription in reverse chronological order beginning with the most recent invoice without download Url. - -### Example 4 -``` -PS C:\> Get-AzureRmBillingInvoice -GenerateDownloadUrl -MaxCount 10 -``` - -Get most recent 10 invoices of the subscription and include the download Url in the result. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GenerateDownloadUrl -Generate the download url of the invoices. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Latest -Get the latest invoice. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Latest -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxCount -Determines the maximum number of records to return. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of a specific invoice to get or the most recent if not specified. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: Single -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Billing.Models.PSInvoice - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Billing/Get-AzureRmBillingPeriod.md b/azurermps-6.13.0/AzureRM.Billing/Get-AzureRmBillingPeriod.md deleted file mode 100644 index 737fbc8ba4..0000000000 --- a/azurermps-6.13.0/AzureRM.Billing/Get-AzureRmBillingPeriod.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Billing.dll-Help.xml -Module Name: AzureRM.Billing -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.billing/get-azurermbillingperiod -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Billing/Commands.Billing/help/Get-AzureRmBillingPeriod.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Billing/Commands.Billing/help/Get-AzureRmBillingPeriod.md ---- - -# Get-AzureRmBillingPeriod - -## SYNOPSIS -Get billing periods of the subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### List (Default) -``` -Get-AzureRmBillingPeriod [-MaxCount ] [-DefaultProfile ] [] -``` - -### Single -``` -Get-AzureRmBillingPeriod -Name - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmBillingPeriod** cmdlet gets billing periods of the subscription. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmBillingPeriod -``` - -Get all available billing periods of the subscription. - -### Example 2 -``` -PS C:\> Get-AzureRmBillingPeriod -Name 201704-1 -``` - -Get the billing period of the subscription with the specified name. - -### Example 3 -``` -PS C:\> Get-AzureRmBillingPeriod -MaxCount 2 -``` - -Get at most 2 billing periods of the subscription. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxCount -Determine the maximum number of records to return. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of a specific billing period to get. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: Single -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Billing.Models.PSBillingPeriod - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Billing/Get-AzureRmEnrollmentAccount.md b/azurermps-6.13.0/AzureRM.Billing/Get-AzureRmEnrollmentAccount.md deleted file mode 100644 index 17b1fdc253..0000000000 --- a/azurermps-6.13.0/AzureRM.Billing/Get-AzureRmEnrollmentAccount.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Billing.dll-Help.xml -Module Name: AzureRM.Billing -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.billing/get-azurermenrollmentaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Billing/Commands.Billing/help/Get-AzureRmEnrollmentAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Billing/Commands.Billing/help/Get-AzureRmEnrollmentAccount.md ---- - -# Get-AzureRmEnrollmentAccount - -## SYNOPSIS -Get enrollment accounts. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### List (Default) -``` -Get-AzureRmEnrollmentAccount [-DefaultProfile ] [] -``` - -### Single -``` -Get-AzureRmEnrollmentAccount [-ObjectId] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Get-AzureRmEnrollmentAccount** cmdlet gets enrollment accounts. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmEnrollmentAccount - -ObjectId PrincipalName --------- ------------- -dbd8453d-071f-4fb4-8e01-c99f5b067649 jason@contoso.onmicrosoft.com -7ff524ac-a0de-4402-876f-934ccee3b601 carol@contoso.onmicrosoft.com -``` - -Get all available enrollment accounts. - -### Example 2 -``` -PS C:\> Get-AzureRmEnrollmentAccount -ObjectId dbd8453d-071f-4fb4-8e01-c99f5b067649 - -ObjectId PrincipalName --------- ------------- -dbd8453d-071f-4fb4-8e01-c99f5b067649 jason@contoso.onmicrosoft.com -``` - -Get the enrollment account with the specified object id. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ObjectId -ObjectId of a specific enrollment account to get. - -```yaml -Type: System.String -Parameter Sets: Single -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Billing.Models.PSBillingPeriod - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Cdn/AzureRM.Cdn.md b/azurermps-6.13.0/AzureRM.Cdn/AzureRM.Cdn.md deleted file mode 100644 index ff5f1b2c10..0000000000 --- a/azurermps-6.13.0/AzureRM.Cdn/AzureRM.Cdn.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -Module Name: AzureRM.Cdn -Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.cdn -Help Version: 4.2.2.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/AzureRM.Cdn.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/AzureRM.Cdn.md ---- - -# AzureRM.Cdn Module -## Description -The topics in this section document the Azure PowerShell cmdlets for Azure Content Delivery Network (CDN) in the Azure Resource Manager (ARM) framework. The cmdlets exist in the Microsoft.Azure.Commands.Cdn namespace. - -## AzureRM.Cdn Cmdlets -### [Confirm-AzureRmCdnEndpointProbeURL](Confirm-AzureRmCdnEndpointProbeURL.md) -Validates a probe URL. - -### [Disable-AzureRmCdnCustomDomain](Disable-AzureRmCdnCustomDomain.md) -Disables custom HTTPS. - -### [Enable-AzureRmCdnCustomDomain](Enable-AzureRmCdnCustomDomain.md) -Enables custom HTTPS. - -### [Get-AzureRmCdnCustomDomain](Get-AzureRmCdnCustomDomain.md) -Gets a CDN custom domain. - -### [Get-AzureRmCdnEdgeNodes](Get-AzureRmCdnEdgeNodes.md) -Gets Azure CDN edgenodes. - -### [Get-AzureRmCdnEndpoint](Get-AzureRmCdnEndpoint.md) -Gets a CDN endpoint. - -### [Get-AzureRmCdnEndpointNameAvailability](Get-AzureRmCdnEndpointNameAvailability.md) -Gets availability status of the CDN endpoint. - -### [Get-AzureRmCdnEndpointResourceUsage](Get-AzureRmCdnEndpointResourceUsage.md) -Gets the resource usage of a CDN endpoint. - -### [Get-AzureRmCdnOrigin](Get-AzureRmCdnOrigin.md) -Gets a CDN origin server. - -### [Get-AzureRmCdnProfile](Get-AzureRmCdnProfile.md) -Gets a CDN profile. - -### [Get-AzureRmCdnProfileResourceUsage](Get-AzureRmCdnProfileResourceUsage.md) -Gets the resource usage of a CDN profile. - -### [Get-AzureRmCdnProfileSsoUrl](Get-AzureRmCdnProfileSsoUrl.md) -Gets the single sign-on URL of a CDN profile. - -### [Get-AzureRmCdnProfileSupportedOptimizationType](Get-AzureRmCdnProfileSupportedOptimizationType.md) -Gets the supported optimization types for a CDN profile. - -### [Get-AzureRmCdnSubscriptionResourceUsage](Get-AzureRmCdnSubscriptionResourceUsage.md) -Gets the resource usage for a susbscription. - -### [New-AzureRmCdnCustomDomain](New-AzureRmCdnCustomDomain.md) -Creates a custom domain for a CDN endpoint. - -### [New-AzureRmCdnEndpoint](New-AzureRmCdnEndpoint.md) -Creates a CDN endpoint. - -### [New-AzureRmCdnProfile](New-AzureRmCdnProfile.md) -Creates a CDN profile. - -### [Publish-AzureRmCdnEndpointContent](Publish-AzureRmCdnEndpointContent.md) -Loads content to an endpoint. - -### [Remove-AzureRmCdnCustomDomain](Remove-AzureRmCdnCustomDomain.md) -Removes a custom domain. - -### [Remove-AzureRmCdnEndpoint](Remove-AzureRmCdnEndpoint.md) -Removes a CDN endpoint. - -### [Remove-AzureRmCdnProfile](Remove-AzureRmCdnProfile.md) -Removes a CDN profile. - -### [Set-AzureRmCdnEndpoint](Set-AzureRmCdnEndpoint.md) -Updates a CDN endpoint. - -### [Set-AzureRmCdnOrigin](Set-AzureRmCdnOrigin.md) -Updates a CDN origin server. - -### [Set-AzureRmCdnProfile](Set-AzureRmCdnProfile.md) -Updates a CDN profile. - -### [Start-AzureRmCdnEndpoint](Start-AzureRmCdnEndpoint.md) -Starts a CDN endpoint. - -### [Stop-AzureRmCdnEndpoint](Stop-AzureRmCdnEndpoint.md) -Stops the CDN endpoint. - -### [Test-AzureRmCdnCustomDomain](Test-AzureRmCdnCustomDomain.md) -Checks whether a custom domain can be added to an endpoint. - -### [Unpublish-AzureRmCdnEndpointContent](Unpublish-AzureRmCdnEndpointContent.md) -Purges a CDN endpoint. - diff --git a/azurermps-6.13.0/AzureRM.Cdn/Confirm-AzureRmCdnEndpointProbeURL.md b/azurermps-6.13.0/AzureRM.Cdn/Confirm-AzureRmCdnEndpointProbeURL.md deleted file mode 100644 index b1973996cc..0000000000 --- a/azurermps-6.13.0/AzureRM.Cdn/Confirm-AzureRmCdnEndpointProbeURL.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Cdn.dll-Help.xml -Module Name: AzureRM.Cdn -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cdn/confirm-azurermcdnendpointprobeurl -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Confirm-AzureRmCdnEndpointProbeURL.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Confirm-AzureRmCdnEndpointProbeURL.md ---- - -# Confirm-AzureRmCdnEndpointProbeURL - -## SYNOPSIS -Validates a probe URL. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Confirm-AzureRmCdnEndpointProbeURL -ProbeUrl [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Confirm-AzureRmCdnEndpointProbeURL** cmdlet confirms if the probe URL provided can be used for dynamic site acceleration. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Confirm-AzureRmCdnEndpointProbeURL -ProbeUrl "http://www.bing.com/images" -IsValid: true -ErrorCode: None -Message: -``` - -Validates the probe url "http://www.bing.com/images" - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeUrl -Proposed probe URL name to validate. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Cdn.Models.Endpoint.PSValidateProbeOutput - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Cdn/Disable-AzureRmCdnCustomDomain.md b/azurermps-6.13.0/AzureRM.Cdn/Disable-AzureRmCdnCustomDomain.md deleted file mode 100644 index 3f4810686d..0000000000 --- a/azurermps-6.13.0/AzureRM.Cdn/Disable-AzureRmCdnCustomDomain.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Cdn.dll-Help.xml -Module Name: AzureRM.Cdn -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cdn/disable-azurermcdncustomain -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Disable-AzureRmCdnCustomDomain.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Disable-AzureRmCdnCustomDomain.md ---- - -# Disable-AzureRmCdnCustomDomain - -## SYNOPSIS -Disables custom HTTPS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFieldsParameterSet (Default) -``` -Disable-AzureRmCdnCustomDomain -CustomDomainName -EndpointName -ProfileName - -ResourceGroupName [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -### ByObjectParameterSet -``` -Disable-AzureRmCdnCustomDomain -InputObject [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Disable-AzureRmCdnCustomDomain** cmdlet disables the secured HTTPS delivery of a CDN custom domain. - -## EXAMPLES - -### Example 1 -```powershell -Disable-AzureRmCdnCustomDomain -CustomDomainName $customDomainName -EndpointName $endpointName -ProfileName $profileName -ResourceGroupName $resourceGroupName -true -``` - -Disable https delivery of the custom domain. - -## PARAMETERS - -### -CustomDomainName -Azure CDN custom domain display name. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndpointName -Azure CDN endpoint name. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The custom domain object. - -```yaml -Type: Microsoft.Azure.Commands.Cdn.Models.CustomDomain.PSCustomDomain -Parameter Sets: ByObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Return object (if specified). - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileName -Azure CDN profile name. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group of the Azure CDN profile. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Cdn.Models.CustomDomain.PSCustomDomain -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Cdn/Enable-AzureRmCdnCustomDomain.md b/azurermps-6.13.0/AzureRM.Cdn/Enable-AzureRmCdnCustomDomain.md deleted file mode 100644 index f31adeddb5..0000000000 --- a/azurermps-6.13.0/AzureRM.Cdn/Enable-AzureRmCdnCustomDomain.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Cdn.dll-Help.xml -Module Name: AzureRM.Cdn -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cdn/enable-azurermcdncustomain -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Enable-AzureRmCdnCustomDomain.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Enable-AzureRmCdnCustomDomain.md ---- - -# Enable-AzureRmCdnCustomDomain - -## SYNOPSIS -Enables custom HTTPS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFieldsParameterSet (Default) -``` -Enable-AzureRmCdnCustomDomain -CustomDomainName -EndpointName -ProfileName - -ResourceGroupName [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -### ByObjectParameterSet -``` -Enable-AzureRmCdnCustomDomain -InputObject [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Enable-AzureRmCdnCustomDomain** cmdlet enables the secured HTTPS delivery of a CDN custom domain. - -## EXAMPLES - -### Example 1 -```powershell -Enable-AzureRmCdnCustomDomain -CustomDomainName $customDomainName -EndpointName $endpointName -ProfileName $profileName -ResourceGroupName $resourceGroupName -true -``` - -Enable https delivery of the custom domain. - -## PARAMETERS - -### -CustomDomainName -Azure CDN custom domain display name. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndpointName -Azure CDN endpoint name. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The custom domain object. - -```yaml -Type: Microsoft.Azure.Commands.Cdn.Models.CustomDomain.PSCustomDomain -Parameter Sets: ByObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Return object (if specified). - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileName -Azure CDN profile name. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group of the Azure CDN profile. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Cdn.Models.CustomDomain.PSCustomDomain -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Cdn/Get-AzureRMCdnProfile.md b/azurermps-6.13.0/AzureRM.Cdn/Get-AzureRMCdnProfile.md deleted file mode 100644 index 6963eea1ca..0000000000 --- a/azurermps-6.13.0/AzureRM.Cdn/Get-AzureRMCdnProfile.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Cdn.dll-Help.xml -Module Name: AzureRM.Cdn -ms.assetid: 28DECA86-37A5-48BE-9727-0C1A3B867E9B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cdn/get-azurermcdnprofile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Get-AzureRMCdnProfile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Get-AzureRMCdnProfile.md ---- - -# Get-AzureRmCdnProfile - -## SYNOPSIS -Gets a CDN profile. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmCdnProfile [-ProfileName ] [-ResourceGroupName ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRMCdnProfile** cmdlet gets an Azure Content Delivery Network (CDN) profile and its related information. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileName -Specifies the name of the profile. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the profile belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Cdn.Models.Profile.PSProfile - -## NOTES - -## RELATED LINKS - -[New-AzureRmCdnProfile](./New-AzureRmCdnProfile.md) - -[Remove-AzureRmCdnProfile](./Remove-AzureRmCdnProfile.md) - -[Set-AzureRmCdnProfile](./Set-AzureRmCdnProfile.md) - - diff --git a/azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnCustomDomain.md b/azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnCustomDomain.md deleted file mode 100644 index c3803200c3..0000000000 --- a/azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnCustomDomain.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Cdn.dll-Help.xml -Module Name: AzureRM.Cdn -ms.assetid: 53246003-D1E9-4863-94E9-8E0BF1272134 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cdn/get-azurermcdncustomdomain -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Get-AzureRmCdnCustomDomain.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Get-AzureRmCdnCustomDomain.md ---- - -# Get-AzureRmCdnCustomDomain - -## SYNOPSIS -Gets a CDN custom domain. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFieldsParameterSet (Default) -``` -Get-AzureRmCdnCustomDomain [-CustomDomainName ] -EndpointName -ProfileName - -ResourceGroupName [-DefaultProfile ] [] -``` - -### ByObjectParameterSet -``` -Get-AzureRmCdnCustomDomain [-CustomDomainName ] -CdnEndpoint - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmCdnCustomDomain** cmdlet gets an Azure Content Delivery Network (CDN) custom domain and its related settings. - -## EXAMPLES - -## PARAMETERS - -### -CdnEndpoint -Specifies the CDN endpoint object of which the custom domain is a member. - -```yaml -Type: Microsoft.Azure.Commands.Cdn.Models.Endpoint.PSEndpoint -Parameter Sets: ByObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CustomDomainName -Specifies the name of the custom domain. -The name of the custom domain differs from the host name of the custom domain. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndpointName -Specifies the name of the endpoint to which the custom domain belongs. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileName -Specifies the name of the Profile to which the custom domain belongs. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the custom domain belongs. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Cdn.Models.Endpoint.PSEndpoint -Parameters: CdnEndpoint (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Cdn.Models.CustomDomain.PSCustomDomain - -## NOTES - -## RELATED LINKS - -[New-AzureRmCdnCustomDomain](./New-AzureRmCdnCustomDomain.md) - -[Remove-AzureRmCdnCustomDomain](./Remove-AzureRmCdnCustomDomain.md) - - diff --git a/azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnEdgeNodes.md b/azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnEdgeNodes.md deleted file mode 100644 index 25a87c8a39..0000000000 --- a/azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnEdgeNodes.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Cdn.dll-Help.xml -Module Name: AzureRM.Cdn -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cdn/get-azurermcdnedgenodes -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Get-AzureRmCdnEdgeNodes.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Get-AzureRmCdnEdgeNodes.md ---- - -# Get-AzureRmCdnEdgeNodes - -## SYNOPSIS -Gets Azure CDN edgenodes. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmCdnEdgeNodes [-DefaultProfile ] [] -``` - -## DESCRIPTION -{{Fill in the Description}} - -## EXAMPLES - -### Example 1 -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Cdn.EdgeNodes.PSEdgeNode - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnEndpoint.md b/azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnEndpoint.md deleted file mode 100644 index 59df28f4d4..0000000000 --- a/azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnEndpoint.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Cdn.dll-Help.xml -Module Name: AzureRM.Cdn -ms.assetid: F93D9D7C-AC2A-4D83-87EC-4A54CD45272B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cdn/get-azurermcdnendpoint -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Get-AzureRmCdnEndpoint.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Get-AzureRmCdnEndpoint.md ---- - -# Get-AzureRmCdnEndpoint - -## SYNOPSIS -Gets a CDN endpoint. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFieldsParameterSet (Default) -``` -Get-AzureRmCdnEndpoint [-EndpointName ] -ProfileName -ResourceGroupName - [-DefaultProfile ] [] -``` - -### ByObjectParameterSet -``` -Get-AzureRmCdnEndpoint [-EndpointName ] -CdnProfile - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRMCdnEndpoint** cmdlet gets an Azure Content Delivery Network (CDN) endpoint and its associated configuration data. - -## EXAMPLES - -## PARAMETERS - -### -CdnProfile -Specifies the CDN profile object to which the endpoint belongs. - -```yaml -Type: Microsoft.Azure.Commands.Cdn.Models.Profile.PSProfile -Parameter Sets: ByObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndpointName -Specifies the name of the endpoint. -The name of the endpoint is not the host name of the endpoint. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileName -Specifies the name of the profile to which the endpoint belongs. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the endpoint belongs. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Cdn.Models.Profile.PSProfile -Parameters: CdnProfile (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Cdn.Models.Endpoint.PSEndpoint - -## NOTES - -## RELATED LINKS - -[New-AzureRmCdnEndpoint](./New-AzureRmCdnEndpoint.md) - -[Remove-AzureRmCdnEndpoint](./Remove-AzureRmCdnEndpoint.md) - -[Set-AzureRmCdnEndpoint](./Set-AzureRmCdnEndpoint.md) - -[Start-AzureRmCdnEndpoint](./Start-AzureRmCdnEndpoint.md) - -[Stop-AzureRmCdnEndpoint](./Stop-AzureRmCdnEndpoint.md) - - diff --git a/azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnEndpointNameAvailability.md b/azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnEndpointNameAvailability.md deleted file mode 100644 index 4298d2de50..0000000000 --- a/azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnEndpointNameAvailability.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Cdn.dll-Help.xml -Module Name: AzureRM.Cdn -ms.assetid: 6BBD68B4-BCC6-479A-AA70-D4ED445CFB32 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cdn/get-azurermcdnendpointnameavailability -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Get-AzureRmCdnEndpointNameAvailability.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Get-AzureRmCdnEndpointNameAvailability.md ---- - -# Get-AzureRmCdnEndpointNameAvailability - -## SYNOPSIS -Gets availability status of the CDN endpoint. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmCdnEndpointNameAvailability -EndpointName [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Get-AzureRmCdnEndpointNameAvailability** cmdlet gets availability status of the Azure Content Delivery Network (CDN) endpoint. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndpointName -Specifies the name of the endpoint. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Cdn.Models.Endpoint.PSCheckNameAvailabilityOutput - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnEndpointResourceUsage.md b/azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnEndpointResourceUsage.md deleted file mode 100644 index ca90551701..0000000000 --- a/azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnEndpointResourceUsage.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Cdn.dll-Help.xml -Module Name: AzureRM.Cdn -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cdn/get-azurermcdnendpointresourceusage -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Get-AzureRmCdnEndpointResourceUsage.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Get-AzureRmCdnEndpointResourceUsage.md ---- - -# Get-AzureRmCdnEndpointResourceUsage - -## SYNOPSIS -Gets the resource usage of a CDN endpoint. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFieldsParameterSet (Default) -``` -Get-AzureRmCdnEndpointResourceUsage [-EndpointName ] -ProfileName -ResourceGroupName - [-DefaultProfile ] [] -``` - -### ByObjectParameterSet -``` -Get-AzureRmCdnEndpointResourceUsage [-EndpointName ] -CdnEndpoint - [-DefaultProfile ] [] -``` - -## DESCRIPTION -{{Fill in the Description}} - -## EXAMPLES - -### Example 1 -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -CdnEndpoint -The CDN endpoint object. - -```yaml -Type: Microsoft.Azure.Commands.Cdn.Models.Endpoint.PSEndpoint -Parameter Sets: ByObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndpointName -Azure CDN endpoint name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileName -Azure CDN profile name. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group of the Azure CDN Profile. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Cdn.Models.Endpoint.PSEndpoint -Parameters: CdnEndpoint (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Cdn.Models.PSResourceUsage - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnOrigin.md b/azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnOrigin.md deleted file mode 100644 index 47a17c79dd..0000000000 --- a/azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnOrigin.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Cdn.dll-Help.xml -Module Name: AzureRM.Cdn -ms.assetid: 91919242-59ED-4938-A3A3-23A66F85FBC1 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cdn/get-azurermcdnorigin -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Get-AzureRmCdnOrigin.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Get-AzureRmCdnOrigin.md ---- - -# Get-AzureRmCdnOrigin - -## SYNOPSIS -Gets a CDN origin server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFieldsParameterSet (Default) -``` -Get-AzureRmCdnOrigin [-OriginName ] -EndpointName -ProfileName - -ResourceGroupName [-DefaultProfile ] [] -``` - -### ByObjectParameterSet -``` -Get-AzureRmCdnOrigin [-OriginName ] -CdnEndpoint - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmCdnOrigin** cmdlet gets an Azure Content Delivery Network (CDN) origin server and its configuration data. - -## EXAMPLES - -## PARAMETERS - -### -CdnEndpoint -Specifies the CDN endpoint object to which the origin belongs. - -```yaml -Type: Microsoft.Azure.Commands.Cdn.Models.Endpoint.PSEndpoint -Parameter Sets: ByObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndpointName -Specifies the name of the endpoint to which the origin server belongs. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OriginName -Specifies the name of the origin server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileName -Specifies the name of the profile to which the origin server belongs. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the origin server belongs. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Cdn.Models.Endpoint.PSEndpoint -Parameters: CdnEndpoint (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Cdn.Models.Origin.PSOrigin - -## NOTES - -## RELATED LINKS - -[Set-AzureRmCdnOrigin](./Set-AzureRmCdnOrigin.md) - - diff --git a/azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnProfileResourceUsage.md b/azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnProfileResourceUsage.md deleted file mode 100644 index 93694bda99..0000000000 --- a/azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnProfileResourceUsage.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Cdn.dll-Help.xml -Module Name: AzureRM.Cdn -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cdn/get-azurermcdnprofileresourceusage -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Get-AzureRmCdnProfileResourceUsage.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Get-AzureRmCdnProfileResourceUsage.md ---- - -# Get-AzureRmCdnProfileResourceUsage - -## SYNOPSIS -Gets the resource usage of a CDN profile. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFieldsParameterSet (Default) -``` -Get-AzureRmCdnProfileResourceUsage -ProfileName -ResourceGroupName - [-DefaultProfile ] [] -``` - -### ByObjectParameterSet -``` -Get-AzureRmCdnProfileResourceUsage -CdnProfile [-DefaultProfile ] - [] -``` - -## DESCRIPTION -{{Fill in the Description}} - -## EXAMPLES - -### Example 1 -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -CdnProfile -The Azure CDN profile object. - -```yaml -Type: Microsoft.Azure.Commands.Cdn.Models.Profile.PSProfile -Parameter Sets: ByObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileName -The name of the profile. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group to which the profile belongs. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Cdn.Models.Profile.PSProfile -Parameters: CdnProfile (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Cdn.Models.PSResourceUsage - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnProfileSsoUrl.md b/azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnProfileSsoUrl.md deleted file mode 100644 index 290363fe19..0000000000 --- a/azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnProfileSsoUrl.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Cdn.dll-Help.xml -Module Name: AzureRM.Cdn -ms.assetid: 93D5E2D9-FB89-4311-8E8E-44CBFAFC98A9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cdn/get-azurermcdnprofilessourl -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Get-AzureRmCdnProfileSsoUrl.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Get-AzureRmCdnProfileSsoUrl.md ---- - -# Get-AzureRmCdnProfileSsoUrl - -## SYNOPSIS -Gets the single sign-on URL of a CDN profile. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFieldsParameterSet (Default) -``` -Get-AzureRmCdnProfileSsoUrl -ProfileName -ResourceGroupName - [-DefaultProfile ] [] -``` - -### ByObjectParameterSet -``` -Get-AzureRmCdnProfileSsoUrl -CdnProfile [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Get-AzureRmCdnProfileSsoUrl** cmdlet gets the single sign-on URL of the Azure Content Delivery Network (CDN) profile. -This URL lets users conntect to a supplementary portal and use additional features of CDN. - -## EXAMPLES - -## PARAMETERS - -### -CdnProfile -Specifies the CDN profile. - -```yaml -Type: Microsoft.Azure.Commands.Cdn.Models.Profile.PSProfile -Parameter Sets: ByObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileName -Specifies the name of the CDN profile. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group name to which the profile belongs. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Cdn.Models.Profile.PSProfile -Parameters: CdnProfile (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Cdn.Models.Profile.PSSsoUri - -## NOTES - -## RELATED LINKS - -[Get-AzureRMCdnProfile](./Get-AzureRMCdnProfile.md) - - diff --git a/azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnProfileSupportedOptimizationType.md b/azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnProfileSupportedOptimizationType.md deleted file mode 100644 index 54f51259fa..0000000000 --- a/azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnProfileSupportedOptimizationType.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Cdn.dll-Help.xml -Module Name: AzureRM.Cdn -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cdn/get-azurermcdnprofilesupportedoptimizationtype -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Get-AzureRmCdnProfileSupportedOptimizationType.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Get-AzureRmCdnProfileSupportedOptimizationType.md ---- - -# Get-AzureRmCdnProfileSupportedOptimizationType - -## SYNOPSIS -Gets the supported optimization types for a CDN profile. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFieldsParameterSet (Default) -``` -Get-AzureRmCdnProfileSupportedOptimizationType -ProfileName -ResourceGroupName - [-DefaultProfile ] [] -``` - -### ByObjectParameterSet -``` -Get-AzureRmCdnProfileSupportedOptimizationType -CdnProfile - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmCdnProfileSupportedOptimizationType** cmdlet gets the supported optimization types for the current profile. A user can create an endpoint with an optimization type from the listed values. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmCdnProfileSupportedOptimizationType -ProfileName $profileName -ResourceGroupName $resourceGroupName -OptimizationType: GeneralWebDelivery -OptimizationType: DynamicSiteAcceleration -``` - -Get the supported optimization types for a CDN profile. - -## PARAMETERS - -### -CdnProfile -The Azure CDN profile object. - -```yaml -Type: Microsoft.Azure.Commands.Cdn.Models.Profile.PSProfile -Parameter Sets: ByObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileName -The name of the profile. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group to which the profile belongs. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Cdn.Models.Profile.PSProfile -Parameters: CdnProfile (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Cdn.Models.Profile.PSOptimizationType - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnSubscriptionResourceUsage.md b/azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnSubscriptionResourceUsage.md deleted file mode 100644 index 2055a243f7..0000000000 --- a/azurermps-6.13.0/AzureRM.Cdn/Get-AzureRmCdnSubscriptionResourceUsage.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Cdn.dll-Help.xml -Module Name: AzureRM.Cdn -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cdn/get-azurermcdnsubscriptionresourceusage -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Get-AzureRmCdnSubscriptionResourceUsage.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Get-AzureRmCdnSubscriptionResourceUsage.md ---- - -# Get-AzureRmCdnSubscriptionResourceUsage - -## SYNOPSIS -Gets the resource usage for a susbscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmCdnSubscriptionResourceUsage [-DefaultProfile ] [] -``` - -## DESCRIPTION -{{Fill in the Description}} - -## EXAMPLES - -### Example 1 -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Cdn.Models.PSResourceUsage - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Cdn/New-AzureRmCdnCustomDomain.md b/azurermps-6.13.0/AzureRM.Cdn/New-AzureRmCdnCustomDomain.md deleted file mode 100644 index c5698e10b7..0000000000 --- a/azurermps-6.13.0/AzureRM.Cdn/New-AzureRmCdnCustomDomain.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Cdn.dll-Help.xml -Module Name: AzureRM.Cdn -ms.assetid: 7060D3D7-B397-447E-88E3-B6F0D094770D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cdn/new-azurermcdncustomdomain -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/New-AzureRmCdnCustomDomain.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/New-AzureRmCdnCustomDomain.md ---- - -# New-AzureRmCdnCustomDomain - -## SYNOPSIS -Creates a custom domain for a CDN endpoint. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFieldsParameterSet (Default) -``` -New-AzureRmCdnCustomDomain -HostName -CustomDomainName -EndpointName - -ProfileName -ResourceGroupName [-DefaultProfile ] [-WhatIf] - [-Confirm] [] -``` - -### ByObjectParameterSet -``` -New-AzureRmCdnCustomDomain -HostName -CustomDomainName -CdnEndpoint - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **New-AzureRmCdnCustomDomain** cmdlet creates a custom domain for the Azure Content Delivery Network (CDN) endpoint. - -## EXAMPLES - -## PARAMETERS - -### -CdnEndpoint -Specifies the CDN endpoint object to which the custom domain is added. - -```yaml -Type: Microsoft.Azure.Commands.Cdn.Models.Endpoint.PSEndpoint -Parameter Sets: ByObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CustomDomainName -Specifies the resource name of the custom domain. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndpointName -Specifies the name of the endpoint. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostName -Specifies the host name of the custom domain. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileName -Specifies the name of the profile. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the custom domain belongs. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Cdn.Models.Endpoint.PSEndpoint -Parameters: CdnEndpoint (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Cdn.Models.CustomDomain.PSCustomDomain - -## NOTES - -## RELATED LINKS - -[Get-AzureRmCdnCustomDomain](./Get-AzureRmCdnCustomDomain.md) - -[Remove-AzureRmCdnCustomDomain](./Remove-AzureRmCdnCustomDomain.md) - -[Test-AzureRmCdnCustomDomain](./Test-AzureRmCdnCustomDomain.md) - - diff --git a/azurermps-6.13.0/AzureRM.Cdn/New-AzureRmCdnEndpoint.md b/azurermps-6.13.0/AzureRM.Cdn/New-AzureRmCdnEndpoint.md deleted file mode 100644 index f3ab62e8c6..0000000000 --- a/azurermps-6.13.0/AzureRM.Cdn/New-AzureRmCdnEndpoint.md +++ /dev/null @@ -1,437 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Cdn.dll-Help.xml -Module Name: AzureRM.Cdn -ms.assetid: A8C6F3BC-EE93-49A4-BF7B-8420967EEB7B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cdn/new-azurermcdnendpoint -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/New-AzureRmCdnEndpoint.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/New-AzureRmCdnEndpoint.md ---- - -# New-AzureRmCdnEndpoint - -## SYNOPSIS -Creates a CDN endpoint. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFieldsParameterSet (Default) -``` -New-AzureRmCdnEndpoint -EndpointName -ProfileName -ResourceGroupName - -Location [-OriginHostHeader ] [-OriginPath ] [-ContentTypesToCompress ] - [-IsCompressionEnabled ] [-IsHttpAllowed ] [-IsHttpsAllowed ] - [-QueryStringCachingBehavior ] -OriginName -OriginHostName - [-HttpPort ] [-HttpsPort ] [-OptimizationType ] [-ProbePath ] - [-GeoFilters ] [-DeliveryPolicy ] [-Tag ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### ByObjectParameterSet -``` -New-AzureRmCdnEndpoint -EndpointName -CdnProfile [-OriginHostHeader ] - [-OriginPath ] [-ContentTypesToCompress ] [-IsCompressionEnabled ] - [-IsHttpAllowed ] [-IsHttpsAllowed ] - [-QueryStringCachingBehavior ] -OriginName -OriginHostName - [-HttpPort ] [-HttpsPort ] [-OptimizationType ] [-ProbePath ] - [-GeoFilters ] [-DeliveryPolicy ] [-Tag ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **New-AzureRmCdnEndpoint** cmdlet creates an Azure Content Delivery Network (CDN) endpoint. - -## EXAMPLES - -## PARAMETERS - -### -CdnProfile -Specifies the CDN profile object to which the endpoint is added. - -```yaml -Type: Microsoft.Azure.Commands.Cdn.Models.Profile.PSProfile -Parameter Sets: ByObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ContentTypesToCompress -Specifies an array of content types to compress from the edge node to the client. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeliveryPolicy -The delivery policy for this endpoint. - -```yaml -Type: Microsoft.Azure.Commands.Cdn.Models.Endpoint.PSDeliveryPolicy -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndpointName -Specifies the name of the endpoint. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GeoFilters -The list of geo filters that applies to this endpoint. - -```yaml -Type: Microsoft.Azure.Commands.Cdn.Models.Endpoint.PSGeoFilter[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPort -Specifies the HTTP port number on the origin server. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpsPort -Specifies the HTTPS port number on the origin server. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsCompressionEnabled -Indicates whether compression is enabled for the endpoint. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsHttpAllowed -Indicates whether the endpoint enables HTTP traffic. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsHttpsAllowed -Indicates whether the endpoint enables HTTPS traffic. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the resource location of the endpoint. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OptimizationType -Specifies any optimization this endpoint has. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OriginHostHeader -Specifies the origin host head of the endpoint. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OriginHostName -Specifies the host name of the origin server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OriginName -Specifies the resource name of the origin server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OriginPath -Specifies the path of the origin server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbePath -Specifies the probe path for Dynamic Site Acceleration - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileName -Specifies the name of the profile. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QueryStringCachingBehavior -Specifies the behavior of CDN endpoint when a query string is in the request URL. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Commands.Cdn.Models.Endpoint.PSQueryStringCachingBehavior] -Parameter Sets: (All) -Aliases: -Accepted values: IgnoreQueryString, BypassCaching, UseQueryString, NotSet - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which this endpoint belongs. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -The tags to associate with the Azure CDN endpoint. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Cdn.Models.Profile.PSProfile -Parameters: CdnProfile (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Cdn.Models.Endpoint.PSEndpoint - -## NOTES - -## RELATED LINKS - -[Get-AzureRmCdnEndpoint](./Get-AzureRmCdnEndpoint.md) - -[Remove-AzureRmCdnEndpoint](./Remove-AzureRmCdnEndpoint.md) - -[Set-AzureRmCdnEndpoint](./Set-AzureRmCdnEndpoint.md) - -[Start-AzureRmCdnEndpoint](./Start-AzureRmCdnEndpoint.md) - -[Stop-AzureRmCdnEndpoint](./Stop-AzureRmCdnEndpoint.md) - - diff --git a/azurermps-6.13.0/AzureRM.Cdn/New-AzureRmCdnProfile.md b/azurermps-6.13.0/AzureRM.Cdn/New-AzureRmCdnProfile.md deleted file mode 100644 index 03afe0790a..0000000000 --- a/azurermps-6.13.0/AzureRM.Cdn/New-AzureRmCdnProfile.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Cdn.dll-Help.xml -Module Name: AzureRM.Cdn -ms.assetid: 2785A8E5-6905-4EDE-BFE1-FF7B1E386A39 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cdn/new-azurermcdnprofile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/New-AzureRmCdnProfile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/New-AzureRmCdnProfile.md ---- - -# New-AzureRmCdnProfile - -## SYNOPSIS -Creates a CDN profile. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmCdnProfile -ProfileName -Location -Sku -ResourceGroupName - [-Tag ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **New-AzureRmCdnProfile** cmdlet creates an Azure Content Delivery Network (CDN) profile. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the resource location of the profile. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileName -Specifies the name of the profile. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the profile belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -Specifies the SKU of the profile. - -```yaml -Type: Microsoft.Azure.Commands.Cdn.Models.Profile.PSSkuName -Parameter Sets: (All) -Aliases: -Accepted values: Standard_Verizon, Premium_Verizon, Custom_Verizon, Standard_Akamai, Standard_ChinaCdn - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -The tags to associate with the Azure CDN profile. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Cdn.Models.Profile.PSProfile - -## NOTES - -## RELATED LINKS - -[Get-AzureRMCdnProfile](./Get-AzureRMCdnProfile.md) - -[Remove-AzureRmCdnProfile](./Remove-AzureRmCdnProfile.md) - -[Set-AzureRmCdnProfile](./Set-AzureRmCdnProfile.md) - - diff --git a/azurermps-6.13.0/AzureRM.Cdn/Publish-AzureRmCdnEndpointContent.md b/azurermps-6.13.0/AzureRM.Cdn/Publish-AzureRmCdnEndpointContent.md deleted file mode 100644 index deebc290a9..0000000000 --- a/azurermps-6.13.0/AzureRM.Cdn/Publish-AzureRmCdnEndpointContent.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Cdn.dll-Help.xml -Module Name: AzureRM.Cdn -ms.assetid: AFDBE48E-63B0-4A9E-9825-5246081AA129 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cdn/publish-azurermcdnendpointcontent -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Publish-AzureRmCdnEndpointContent.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Publish-AzureRmCdnEndpointContent.md ---- - -# Publish-AzureRmCdnEndpointContent - -## SYNOPSIS -Loads content to an endpoint. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFieldsParameterSet (Default) -``` -Publish-AzureRmCdnEndpointContent -EndpointName -ProfileName -ResourceGroupName - -LoadContent [-PassThru] [-DefaultProfile ] [] -``` - -### ByObjectParameterSet -``` -Publish-AzureRmCdnEndpointContent -CdnEndpoint -LoadContent [-PassThru] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Publish-AzureRmCdnEndpointContent** cmdlet loads content from an origin server for the Azure Content Delivery Network (CDN) endpoint. - -## EXAMPLES - -## PARAMETERS - -### -CdnEndpoint -Sepcifies the CDN endpoint. - -```yaml -Type: Microsoft.Azure.Commands.Cdn.Models.Endpoint.PSEndpoint -Parameter Sets: ByObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndpointName -Specifies the name of the endpoint. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadContent -Specifies an array of relative paths for the content on the origin server that this cmdlet publishes. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProfileName -Specifies the name of the profile to which the origin server belongs. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the origin server belongs. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Cdn.Models.Endpoint.PSEndpoint -Parameters: CdnEndpoint (ByValue) - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Unpublish-AzureRmCdnEndpointContent](./Unpublish-AzureRmCdnEndpointContent.md) - - diff --git a/azurermps-6.13.0/AzureRM.Cdn/Remove-AzureRmCdnCustomDomain.md b/azurermps-6.13.0/AzureRM.Cdn/Remove-AzureRmCdnCustomDomain.md deleted file mode 100644 index a936872ef0..0000000000 --- a/azurermps-6.13.0/AzureRM.Cdn/Remove-AzureRmCdnCustomDomain.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Cdn.dll-Help.xml -Module Name: AzureRM.Cdn -ms.assetid: 5727E2CA-0A0B-4050-9F4A-7E06758D9B53 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cdn/remove-azurermcdncustomdomain -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Remove-AzureRmCdnCustomDomain.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Remove-AzureRmCdnCustomDomain.md ---- - -# Remove-AzureRmCdnCustomDomain - -## SYNOPSIS -Removes a custom domain. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFieldsParameterSet (Default) -``` -Remove-AzureRmCdnCustomDomain -CustomDomainName -EndpointName -ProfileName - -ResourceGroupName [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -### ByObjectParameterSet -``` -Remove-AzureRmCdnCustomDomain -CdnCustomDomain [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AzureRmCdnCustomDomain** cmdlet removes the custom domain from an Azure Content Delivery Network (CDN) endpoint. - -## EXAMPLES - -## PARAMETERS - -### -CdnCustomDomain -Specifies the custom domain that this cmdlet removes. - -```yaml -Type: Microsoft.Azure.Commands.Cdn.Models.CustomDomain.PSCustomDomain -Parameter Sets: ByObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CustomDomainName -Specifies the resource name of the custom domain that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndpointName -Specifies the name of the endpoint from which this cmdlet removes a custom domain. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProfileName -Specifies the name of the profile from which this cmdlet removes a custom domain. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group from which this cmdlet removes a custom domain. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Cdn.Models.CustomDomain.PSCustomDomain -Parameters: CdnCustomDomain (ByValue) - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmCdnCustomDomain](./Get-AzureRmCdnCustomDomain.md) - -[New-AzureRmCdnCustomDomain](./New-AzureRmCdnCustomDomain.md) - -[Test-AzureRmCdnCustomDomain](./Test-AzureRmCdnCustomDomain.md) - - diff --git a/azurermps-6.13.0/AzureRM.Cdn/Remove-AzureRmCdnEndpoint.md b/azurermps-6.13.0/AzureRM.Cdn/Remove-AzureRmCdnEndpoint.md deleted file mode 100644 index effdebacef..0000000000 --- a/azurermps-6.13.0/AzureRM.Cdn/Remove-AzureRmCdnEndpoint.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Cdn.dll-Help.xml -Module Name: AzureRM.Cdn -ms.assetid: 7ADF4CDE-638B-4E00-88B1-688702B084A5 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cdn/remove-azurermcdnendpoint -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Remove-AzureRmCdnEndpoint.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Remove-AzureRmCdnEndpoint.md ---- - -# Remove-AzureRmCdnEndpoint - -## SYNOPSIS -Removes a CDN endpoint. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFieldsParameterSet -``` -Remove-AzureRmCdnEndpoint -EndpointName -ProfileName -ResourceGroupName [-PassThru] - [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### ByObjectParameterSet -``` -Remove-AzureRmCdnEndpoint -CdnEndpoint [-PassThru] [-Force] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AzureRmCdnEndpoint** cmdlet removes an Azure Content Delivery Network (CDN) endpoint. - -## EXAMPLES - -## PARAMETERS - -### -CdnEndpoint -Specifies the endpoint that this cmdlet removes. - -```yaml -Type: Microsoft.Azure.Commands.Cdn.Models.Endpoint.PSEndpoint -Parameter Sets: ByObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndpointName -Specifies the name of the endpoint that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProfileName -Specifies the name of the profile to which the endpoint belongs. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the endpoint belongs. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Cdn.Models.Endpoint.PSEndpoint -Parameters: CdnEndpoint (ByValue) - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmCdnEndpoint](./Get-AzureRmCdnEndpoint.md) - -[New-AzureRmCdnEndpoint](./New-AzureRmCdnEndpoint.md) - -[Set-AzureRmCdnEndpoint](./Set-AzureRmCdnEndpoint.md) - -[Start-AzureRmCdnEndpoint](./Start-AzureRmCdnEndpoint.md) - -[Stop-AzureRmCdnEndpoint](./Stop-AzureRmCdnEndpoint.md) - - diff --git a/azurermps-6.13.0/AzureRM.Cdn/Remove-AzureRmCdnProfile.md b/azurermps-6.13.0/AzureRM.Cdn/Remove-AzureRmCdnProfile.md deleted file mode 100644 index 3e295759b0..0000000000 --- a/azurermps-6.13.0/AzureRM.Cdn/Remove-AzureRmCdnProfile.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Cdn.dll-Help.xml -Module Name: AzureRM.Cdn -ms.assetid: 3A4F8442-1268-44BC-91ED-47C03CD20C47 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cdn/remove-azurermcdnprofile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Remove-AzureRmCdnProfile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Remove-AzureRmCdnProfile.md ---- - -# Remove-AzureRmCdnProfile - -## SYNOPSIS -Removes a CDN profile. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFieldsParameterSet -``` -Remove-AzureRmCdnProfile -ProfileName -ResourceGroupName [-PassThru] [-Force] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### ByObjectParameterSet -``` -Remove-AzureRmCdnProfile -CdnProfile [-PassThru] [-Force] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AzureRmCdnProfile** cmdlet removes a Azure Content Delivery Network (CDN) profile. - -## EXAMPLES - -## PARAMETERS - -### -CdnProfile -Specifies the profile that this cmdlet removes. - -```yaml -Type: Microsoft.Azure.Commands.Cdn.Models.Profile.PSProfile -Parameter Sets: ByObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProfileName -Specifies the name of the profile that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the profile belongs. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Cdn.Models.Profile.PSProfile -Parameters: CdnProfile (ByValue) - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRMCdnProfile](./Get-AzureRMCdnProfile.md) - -[New-AzureRmCdnProfile](./New-AzureRmCdnProfile.md) - -[Set-AzureRmCdnProfile](./Set-AzureRmCdnProfile.md) - - diff --git a/azurermps-6.13.0/AzureRM.Cdn/Set-AzureRmCdnEndpoint.md b/azurermps-6.13.0/AzureRM.Cdn/Set-AzureRmCdnEndpoint.md deleted file mode 100644 index af13b8ee76..0000000000 --- a/azurermps-6.13.0/AzureRM.Cdn/Set-AzureRmCdnEndpoint.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Cdn.dll-Help.xml -Module Name: AzureRM.Cdn -ms.assetid: 1A84AF77-1AEF-4FD0-9FAA-D195B361FCEB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cdn/set-azurermcdnendpoint -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Set-AzureRmCdnEndpoint.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Set-AzureRmCdnEndpoint.md ---- - -# Set-AzureRmCdnEndpoint - -## SYNOPSIS -Updates a CDN endpoint. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmCdnEndpoint -CdnEndpoint [-DefaultProfile ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -The **Set-AzureRmCdnEndpoint** cmdlet updates an Azure Content Delivery Network (CDN) endpoint. - -## EXAMPLES - -## PARAMETERS - -### -CdnEndpoint -Specifies the endpoint that this cmdlet updates. - -```yaml -Type: Microsoft.Azure.Commands.Cdn.Models.Endpoint.PSEndpoint -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Cdn.Models.Endpoint.PSEndpoint -Parameters: CdnEndpoint (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Cdn.Models.Endpoint.PSEndpoint - -## NOTES - -## RELATED LINKS - -[Get-AzureRmCdnEndpoint](./Get-AzureRmCdnEndpoint.md) - -[New-AzureRmCdnEndpoint](./New-AzureRmCdnEndpoint.md) - -[Remove-AzureRmCdnEndpoint](./Remove-AzureRmCdnEndpoint.md) - -[Start-AzureRmCdnEndpoint](./Start-AzureRmCdnEndpoint.md) - -[Stop-AzureRmCdnEndpoint](./Stop-AzureRmCdnEndpoint.md) - - diff --git a/azurermps-6.13.0/AzureRM.Cdn/Set-AzureRmCdnOrigin.md b/azurermps-6.13.0/AzureRM.Cdn/Set-AzureRmCdnOrigin.md deleted file mode 100644 index be749684b7..0000000000 --- a/azurermps-6.13.0/AzureRM.Cdn/Set-AzureRmCdnOrigin.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Cdn.dll-Help.xml -Module Name: AzureRM.Cdn -ms.assetid: 0EB9F1C9-54CC-4794-9E37-108342341FE5 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cdn/set-azurermcdnorigin -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Set-AzureRmCdnOrigin.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Set-AzureRmCdnOrigin.md ---- - -# Set-AzureRmCdnOrigin - -## SYNOPSIS -Updates a CDN origin server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmCdnOrigin -CdnOrigin [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Set-AzureRmCdnOrigin** cmdlet updates an Azure Content Delivery Network (CDN) origin server. - -## EXAMPLES - -## PARAMETERS - -### -CdnOrigin -Specifies the origin server that this cmdlet updates. - -```yaml -Type: Microsoft.Azure.Commands.Cdn.Models.Origin.PSOrigin -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Cdn.Models.Origin.PSOrigin -Parameters: CdnOrigin (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Cdn.Models.Origin.PSOrigin - -## NOTES - -## RELATED LINKS - -[Get-AzureRmCdnOrigin](./Get-AzureRmCdnOrigin.md) - - diff --git a/azurermps-6.13.0/AzureRM.Cdn/Set-AzureRmCdnProfile.md b/azurermps-6.13.0/AzureRM.Cdn/Set-AzureRmCdnProfile.md deleted file mode 100644 index 79867bf403..0000000000 --- a/azurermps-6.13.0/AzureRM.Cdn/Set-AzureRmCdnProfile.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Cdn.dll-Help.xml -Module Name: AzureRM.Cdn -ms.assetid: 863DD160-4443-4D50-804E-089255F3EA4E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cdn/set-azurermcdnprofile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Set-AzureRmCdnProfile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Set-AzureRmCdnProfile.md ---- - -# Set-AzureRmCdnProfile - -## SYNOPSIS -Updates a CDN profile. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmCdnProfile -CdnProfile [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Set-AzureRmCdnProfile** cmdlet updates an Azure Content Delivery Network (CDN) profile. - -## EXAMPLES - -## PARAMETERS - -### -CdnProfile -Specifies the profile that this cmdlet updates. - -```yaml -Type: Microsoft.Azure.Commands.Cdn.Models.Profile.PSProfile -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Cdn.Models.Profile.PSProfile -Parameters: CdnProfile (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Cdn.Models.Profile.PSProfile - -## NOTES - -## RELATED LINKS - -[Get-AzureRMCdnProfile](./Get-AzureRMCdnProfile.md) - -[New-AzureRmCdnProfile](./New-AzureRmCdnProfile.md) - -[Remove-AzureRmCdnProfile](./Remove-AzureRmCdnProfile.md) - - diff --git a/azurermps-6.13.0/AzureRM.Cdn/Start-AzureRmCdnEndpoint.md b/azurermps-6.13.0/AzureRM.Cdn/Start-AzureRmCdnEndpoint.md deleted file mode 100644 index 8ed95c0ffe..0000000000 --- a/azurermps-6.13.0/AzureRM.Cdn/Start-AzureRmCdnEndpoint.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Cdn.dll-Help.xml -Module Name: AzureRM.Cdn -ms.assetid: 6477ADC3-0831-493D-8904-F1D787145DD3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cdn/start-azurermcdnendpoint -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Start-AzureRmCdnEndpoint.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Start-AzureRmCdnEndpoint.md ---- - -# Start-AzureRmCdnEndpoint - -## SYNOPSIS -Starts a CDN endpoint. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFieldsParameterSet (Default) -``` -Start-AzureRmCdnEndpoint -EndpointName -ProfileName -ResourceGroupName [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### ByObjectParameterSet -``` -Start-AzureRmCdnEndpoint -CdnEndpoint [-PassThru] [-DefaultProfile ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Start-AzureRmCdnEndpoint** cmdlet starts an Azure Content Delivery Network (CDN) endpoint. - -## EXAMPLES - -## PARAMETERS - -### -CdnEndpoint -Specifies the endpoint that this cmdlet starts. - -```yaml -Type: Microsoft.Azure.Commands.Cdn.Models.Endpoint.PSEndpoint -Parameter Sets: ByObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndpointName -Specifies the name of the endpoint that this cmdlet starts. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProfileName -Specifies the name of the profile to which the endpoint belongs. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the endpoint belongs. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Cdn.Models.Endpoint.PSEndpoint -Parameters: CdnEndpoint (ByValue) - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmCdnEndpoint](./Get-AzureRmCdnEndpoint.md) - -[New-AzureRmCdnEndpoint](./New-AzureRmCdnEndpoint.md) - -[Remove-AzureRmCdnEndpoint](./Remove-AzureRmCdnEndpoint.md) - -[Set-AzureRmCdnEndpoint](./Set-AzureRmCdnEndpoint.md) - -[Stop-AzureRmCdnEndpoint](./Stop-AzureRmCdnEndpoint.md) - - diff --git a/azurermps-6.13.0/AzureRM.Cdn/Stop-AzureRmCdnEndpoint.md b/azurermps-6.13.0/AzureRM.Cdn/Stop-AzureRmCdnEndpoint.md deleted file mode 100644 index 2833535646..0000000000 --- a/azurermps-6.13.0/AzureRM.Cdn/Stop-AzureRmCdnEndpoint.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Cdn.dll-Help.xml -Module Name: AzureRM.Cdn -ms.assetid: 1C45A450-CFD5-40CE-871C-1C2521A03073 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cdn/stop-azurermcdnendpoint -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Stop-AzureRmCdnEndpoint.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Stop-AzureRmCdnEndpoint.md ---- - -# Stop-AzureRmCdnEndpoint - -## SYNOPSIS -Stops the CDN endpoint. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFieldsParameterSet (Default) -``` -Stop-AzureRmCdnEndpoint -EndpointName -ProfileName -ResourceGroupName [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### ByObjectParameterSet -``` -Stop-AzureRmCdnEndpoint -CdnEndpoint [-PassThru] [-DefaultProfile ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Stop-AzureRmCdnEndpoint** cmdlet stops the Azure Content Delivery Network (CDN) endpoint. - -## EXAMPLES - -## PARAMETERS - -### -CdnEndpoint -Specifies the endpoint object that this cmdlet stops. - -```yaml -Type: Microsoft.Azure.Commands.Cdn.Models.Endpoint.PSEndpoint -Parameter Sets: ByObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndpointName -Specifies the name of the endpoint that this cmdlet stops. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProfileName -Specifies the name of the profile to which the endpoint belongs. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the endpoint belongs. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Cdn.Models.Endpoint.PSEndpoint -Parameters: CdnEndpoint (ByValue) - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmCdnEndpoint](./Get-AzureRmCdnEndpoint.md) - -[New-AzureRmCdnEndpoint](./New-AzureRmCdnEndpoint.md) - -[Remove-AzureRmCdnEndpoint](./Remove-AzureRmCdnEndpoint.md) - -[Set-AzureRmCdnEndpoint](./Set-AzureRmCdnEndpoint.md) - -[Start-AzureRmCdnEndpoint](./Start-AzureRmCdnEndpoint.md) - - diff --git a/azurermps-6.13.0/AzureRM.Cdn/Test-AzureRmCdnCustomDomain.md b/azurermps-6.13.0/AzureRM.Cdn/Test-AzureRmCdnCustomDomain.md deleted file mode 100644 index 02f5d671a6..0000000000 --- a/azurermps-6.13.0/AzureRM.Cdn/Test-AzureRmCdnCustomDomain.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Cdn.dll-Help.xml -Module Name: AzureRM.Cdn -ms.assetid: 8C4E824F-FB4A-4DE7-8FD9-3FDA3848F25C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cdn/test-azurermcdncustomdomain -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Test-AzureRmCdnCustomDomain.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Test-AzureRmCdnCustomDomain.md ---- - -# Test-AzureRmCdnCustomDomain - -## SYNOPSIS -Checks whether a custom domain can be added to an endpoint. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFieldsParameterSet (Default) -``` -Test-AzureRmCdnCustomDomain -EndpointName -ProfileName -ResourceGroupName - -CustomDomainHostName [-DefaultProfile ] [] -``` - -### ByObjectParameterSet -``` -Test-AzureRmCdnCustomDomain -CdnEndpoint -CustomDomainHostName - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Test-AzureRmCdnCustomDomain** cmdlet checks whether a custom domain can be added to an endpoint by validating the CName mapping. - -## EXAMPLES - -## PARAMETERS - -### -CdnEndpoint -Specifies the endpoint to which you want to add the custom domain. - -```yaml -Type: Microsoft.Azure.Commands.Cdn.Models.Endpoint.PSEndpoint -Parameter Sets: ByObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CustomDomainHostName -Specifies the host name of the custom domain. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndpointName -Specifies the name of the endpoint to which you want to add the custom domain. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileName -Specifies the name of the profile. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Cdn.Models.Endpoint.PSEndpoint -Parameters: CdnEndpoint (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Cdn.Models.Endpoint.PSValidateCustomDomainOutput - -## NOTES - -## RELATED LINKS - -[Get-AzureRmCdnCustomDomain](./Get-AzureRmCdnCustomDomain.md) - -[New-AzureRmCdnCustomDomain](./New-AzureRmCdnCustomDomain.md) - -[Remove-AzureRmCdnCustomDomain](./Remove-AzureRmCdnCustomDomain.md) - - diff --git a/azurermps-6.13.0/AzureRM.Cdn/Unpublish-AzureRmCdnEndpointContent.md b/azurermps-6.13.0/AzureRM.Cdn/Unpublish-AzureRmCdnEndpointContent.md deleted file mode 100644 index 1e2acc9007..0000000000 --- a/azurermps-6.13.0/AzureRM.Cdn/Unpublish-AzureRmCdnEndpointContent.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Cdn.dll-Help.xml -Module Name: AzureRM.Cdn -ms.assetid: 21E9F441-A00B-4F79-8FF1-968D92982471 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cdn/unpublish-azurermcdnendpointcontent -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Unpublish-AzureRmCdnEndpointContent.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Cdn/Commands.Cdn/help/Unpublish-AzureRmCdnEndpointContent.md ---- - -# Unpublish-AzureRmCdnEndpointContent - -## SYNOPSIS -Purges a CDN endpoint. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFieldsParameterSet (Default) -``` -Unpublish-AzureRmCdnEndpointContent -EndpointName -ProfileName -ResourceGroupName - -PurgeContent [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -### ByObjectParameterSet -``` -Unpublish-AzureRmCdnEndpointContent -CdnEndpoint -PurgeContent [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Unpublish-AzureRmCdnEndpointContent** cmdlet purges the content from an Azure Content Delivery Network (CDN) endpoint. - -## EXAMPLES - -## PARAMETERS - -### -CdnEndpoint -Specifies the endpoint that this cmdlet purges. - -```yaml -Type: Microsoft.Azure.Commands.Cdn.Models.Endpoint.PSEndpoint -Parameter Sets: ByObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndpointName -Specifies name of the endpoint that this cmdlet purges. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProfileName -Specifies the name of the profile to which the endpoint belongs. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PurgeContent -Specifies an array of relative paths for the content on the origin server that this cmdlet purges. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the endpoint belongs. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Cdn.Models.Endpoint.PSEndpoint -Parameters: CdnEndpoint (ByValue) - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Publish-AzureRmCdnEndpointContent](./Publish-AzureRmCdnEndpointContent.md) - - diff --git a/azurermps-6.13.0/AzureRM.CognitiveServices/AzureRM.CognitiveServices.md b/azurermps-6.13.0/AzureRM.CognitiveServices/AzureRM.CognitiveServices.md deleted file mode 100644 index 306c09dce9..0000000000 --- a/azurermps-6.13.0/AzureRM.CognitiveServices/AzureRM.CognitiveServices.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -Module Name: AzureRM.CognitiveServices -Module Guid: 66c566b4-950c-4a2b-9f3b-199d92f0df1a -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.cognitiveservices -Help Version: 0.9.4.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/CognitiveServices/Commands.Management.CognitiveServices/help/AzureRM.CognitiveServices.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/CognitiveServices/Commands.Management.CognitiveServices/help/AzureRM.CognitiveServices.md ---- - -# AzureRM.CognitiveServices Module -## Description -This topic displays help topics for the Azure Cognitive Services cmdlets. - -## AzureRM.CognitiveServices Cmdlets -### [Get-AzureRmCognitiveServicesAccount](Get-AzureRmCognitiveServicesAccount.md) -Gets an account. - -### [Get-AzureRmCognitiveServicesAccountKey](Get-AzureRmCognitiveServicesAccountKey.md) -Gets the API keys for an account. - -### [Get-AzureRmCognitiveServicesAccountSkus](Get-AzureRmCognitiveServicesAccountSkus.md) -Gets the available SKUs for an account. - -### [Get-AzureRmCognitiveServicesAccountType](Get-AzureRmCognitiveServicesAccountType.md) -Gets the available Cognitive Services Account Types. - -### [Get-AzureRmCognitiveServicesAccountUsage](Get-AzureRmCognitiveServicesAccountUsage.md) -Get current usages for a Cognitive Services account. - -### [New-AzureRmCognitiveServicesAccount](New-AzureRmCognitiveServicesAccount.md) -Creates a Cognitive Services account. - -### [New-AzureRmCognitiveServicesAccountKey](New-AzureRmCognitiveServicesAccountKey.md) -Regenerates an account key. - -### [Remove-AzureRmCognitiveServicesAccount](Remove-AzureRmCognitiveServicesAccount.md) -Deletes a Cognitive Services account. - -### [Set-AzureRmCognitiveServicesAccount](Set-AzureRmCognitiveServicesAccount.md) -Modifies an account. - diff --git a/azurermps-6.13.0/AzureRM.CognitiveServices/Get-AzureRmCognitiveServicesAccount.md b/azurermps-6.13.0/AzureRM.CognitiveServices/Get-AzureRmCognitiveServicesAccount.md deleted file mode 100644 index b163d2ac7b..0000000000 --- a/azurermps-6.13.0/AzureRM.CognitiveServices/Get-AzureRmCognitiveServicesAccount.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.CognitiveServices.dll-Help.xml -Module Name: AzureRM.CognitiveServices -ms.assetid: 11D5BFDF-5E5D-46B2-9F9B-A0524EFA1B42 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cognitiveservices/get-azurermcognitiveservicesaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/CognitiveServices/Commands.Management.CognitiveServices/help/Get-AzureRmCognitiveServicesAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/CognitiveServices/Commands.Management.CognitiveServices/help/Get-AzureRmCognitiveServicesAccount.md ---- - -# Get-AzureRmCognitiveServicesAccount - -## SYNOPSIS -Gets an account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceGroupParameterSet -``` -Get-AzureRmCognitiveServicesAccount [[-ResourceGroupName] ] [-DefaultProfile ] - [] -``` - -### AccountNameParameterSet -``` -Get-AzureRmCognitiveServicesAccount [-ResourceGroupName] [-Name] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmCognitiveServicesAccount** cmdlet gets the provisioned Cognitive Services accounts in the resource group specified by the *ResoureGroupName* parameter. -If you do not specify the *ResoureGroupName* parameter, this cmdlet gets all Cognitive Services accounts for the current subscription. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-AzureRmCognitiveServicesAccount -ResourceGroupName cognitive-services-resource-group -name myluis -Type LUIS -SkuName S0 -Locati -on 'WestUS' - -ResourceGroupName : cognitive-services-resource-group -AccountName : myluis -Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/cognitive-services-resource-group/providers/Microsoft.Cog - nitiveServices/accounts/myluis -Endpoint : https://westus.api.cognitive.microsoft.com/luis/v2.0 -Location : WESTUS -Sku : Microsoft.Azure.Management.CognitiveServices.Models.Sku -AccountType : LUIS -ResourceType : Microsoft.CognitiveServices/accounts -Etag : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ProvisioningState : Succeeded -Tags : -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Cognitive Services account to get. - -```yaml -Type: System.String -Parameter Sets: AccountNameParameterSet -Aliases: CognitiveServicesAccountName, AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group the Cognitive Services account is assigned to. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupParameterSet -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: AccountNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSCognitiveServicesAccount - -## NOTES - -## RELATED LINKS - -[New-AzureRmCognitiveServicesAccount](./New-AzureRmCognitiveServicesAccount.md) - -[Remove-AzureRmCognitiveServicesAccount](./Remove-AzureRmCognitiveServicesAccount.md) - -[Set-AzureRmCognitiveServicesAccount](./Set-AzureRmCognitiveServicesAccount.md) - - diff --git a/azurermps-6.13.0/AzureRM.CognitiveServices/Get-AzureRmCognitiveServicesAccountKey.md b/azurermps-6.13.0/AzureRM.CognitiveServices/Get-AzureRmCognitiveServicesAccountKey.md deleted file mode 100644 index 4cd7d8f42a..0000000000 --- a/azurermps-6.13.0/AzureRM.CognitiveServices/Get-AzureRmCognitiveServicesAccountKey.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.CognitiveServices.dll-Help.xml -Module Name: AzureRM.CognitiveServices -ms.assetid: 73B1EB7E-568E-44E8-993A-91678B7D8AEE -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cognitiveservices/get-azurermcognitiveservicesaccountkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/CognitiveServices/Commands.Management.CognitiveServices/help/Get-AzureRmCognitiveServicesAccountKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/CognitiveServices/Commands.Management.CognitiveServices/help/Get-AzureRmCognitiveServicesAccountKey.md ---- - -# Get-AzureRmCognitiveServicesAccountKey - -## SYNOPSIS -Gets the API keys for an account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmCognitiveServicesAccountKey [-ResourceGroupName] [-Name] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmCognitiveServicesAccountKey** cmdlet gets the API keys for a provisioned Cognitive Services account. -A Cognitive Services account has two API keys: Key1 and Key2. -The keys enable interaction with the Cognitive Services account endpoint. -Use New-AzureRmCognitiveServicesAccountKey to regenerate a key. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmCognitiveServicesAccountKey -ResourceGroupName cognitive-services-resource-group -name myluis - -Key1 Key2 ----- ---- -xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the account. -This cmdlet gets the keys for this account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: CognitiveServicesAccountName, AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group the account is assigned to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSCognitiveServicesAccountKeys - -## NOTES - -## RELATED LINKS - -[New-AzureRmCognitiveServicesAccountKey](./New-AzureRmCognitiveServicesAccountKey.md) - - diff --git a/azurermps-6.13.0/AzureRM.CognitiveServices/Get-AzureRmCognitiveServicesAccountSkus.md b/azurermps-6.13.0/AzureRM.CognitiveServices/Get-AzureRmCognitiveServicesAccountSkus.md deleted file mode 100644 index 26b4cd3835..0000000000 --- a/azurermps-6.13.0/AzureRM.CognitiveServices/Get-AzureRmCognitiveServicesAccountSkus.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.CognitiveServices.dll-Help.xml -Module Name: AzureRM.CognitiveServices -ms.assetid: 386F09F0-2EEC-4B55-825C-F2E88D3B60AA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cognitiveservices/get-azurermcognitiveservicesaccountskus -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/CognitiveServices/Commands.Management.CognitiveServices/help/Get-AzureRmCognitiveServicesAccountSkus.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/CognitiveServices/Commands.Management.CognitiveServices/help/Get-AzureRmCognitiveServicesAccountSkus.md ---- - -# Get-AzureRmCognitiveServicesAccountSkus - -## SYNOPSIS -Gets the available SKUs for an account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetSkusWithAccount (Default) -``` -Get-AzureRmCognitiveServicesAccountSkus [-ResourceGroupName] [-Name] - [-DefaultProfile ] [] -``` - -### GetSkusWithFilter -``` -Get-AzureRmCognitiveServicesAccountSkus [-Type ] [-Location ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureRmCognitiveServicesAccountSkus** cmdlet gets the available SKUs for a Cognitive Services account. -The SKU is the tier plan for an account. -It defines the price, call limit, and rate for the account. -The F0 SKU is a free tier. -Paid tiers include S0, S1, S2, and so on. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> (Get-AzureRmCognitiveServicesAccountSkus -ResourceGroupName cognitive-services-resource-group -Name myluis).Value | Select-Object -E -xpandProperty Sku; - -Name Tier ----- ---- -F0 Free -S0 Standard -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Cognitive Services Account Location. - -```yaml -Type: System.String -Parameter Sets: GetSkusWithFilter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the account. - -```yaml -Type: System.String -Parameter Sets: GetSkusWithAccount -Aliases: CognitiveServicesAccountName, AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group the account is assigned to. - -```yaml -Type: System.String -Parameter Sets: GetSkusWithAccount -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Type -Cognitive Services Account Type. - -```yaml -Type: System.String -Parameter Sets: GetSkusWithFilter -Aliases: CognitiveServicesAccountType, AccountType, Kind - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSCognitiveServicesSkus - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.CognitiveServices/Get-AzureRmCognitiveServicesAccountType.md b/azurermps-6.13.0/AzureRM.CognitiveServices/Get-AzureRmCognitiveServicesAccountType.md deleted file mode 100644 index 30b2ba21af..0000000000 --- a/azurermps-6.13.0/AzureRM.CognitiveServices/Get-AzureRmCognitiveServicesAccountType.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.CognitiveServices.dll-Help.xml -Module Name: AzureRM.CognitiveServices -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cognitiveservices/get-azurermcognitiveservicesaccounttype -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/CognitiveServices/Commands.Management.CognitiveServices/help/Get-AzureRmCognitiveServicesAccountType.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/CognitiveServices/Commands.Management.CognitiveServices/help/Get-AzureRmCognitiveServicesAccountType.md ---- - -# Get-AzureRmCognitiveServicesAccountType - -## SYNOPSIS -Gets the available Cognitive Services Account Types. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetAccountTypeWithName -``` -Get-AzureRmCognitiveServicesAccountType -TypeName [-DefaultProfile ] - [] -``` - -### GetAccountTypes -``` -Get-AzureRmCognitiveServicesAccountType [-Location ] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Get-AzureRmCognitiveServicesAccountType** cmdlet gets the available Cognitive Services Account Types under this subscription. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmCognitiveServicesAccountType -``` - -Get the list of available Types. - -### Example 2 -```powershell -PS C:\> Get-AzureRmCognitiveServicesAccountType -Location westus -``` - -Get the list of available Types in westus. - -### Example 3 -```powershell -PS C:\> Get-AzureRmCognitiveServicesAccountType -TypeName Face - -Face -``` - -Check if `Face` is a valid Type name, the name will be returned if it is a valid name. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Cognitive Services Account Location. - -```yaml -Type: System.String -Parameter Sets: GetAccountTypes -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TypeName -Cognitive Services Account Type Name. - -```yaml -Type: System.String -Parameter Sets: GetAccountTypeWithName -Aliases: CognitiveServicesAccountTypeName, AccountTypeName, KindName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.String[] - -### System.String - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.CognitiveServices/Get-AzureRmCognitiveServicesAccountUsage.md b/azurermps-6.13.0/AzureRM.CognitiveServices/Get-AzureRmCognitiveServicesAccountUsage.md deleted file mode 100644 index e870a8fa78..0000000000 --- a/azurermps-6.13.0/AzureRM.CognitiveServices/Get-AzureRmCognitiveServicesAccountUsage.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.CognitiveServices.dll-Help.xml -Module Name: AzureRM.CognitiveServices -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cognitiveservices/get-azurermcognitiveservicesaccountusage -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/CognitiveServices/Commands.Management.CognitiveServices/help/Get-AzureRmCognitiveServicesAccountUsage.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/CognitiveServices/Commands.Management.CognitiveServices/help/Get-AzureRmCognitiveServicesAccountUsage.md ---- - -# Get-AzureRmCognitiveServicesAccountUsage - -## SYNOPSIS -Get current usages for a Cognitive Services account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceNameParameterSet (Default) -``` -Get-AzureRmCognitiveServicesAccountUsage [-ResourceGroupName] [-Name] - [-DefaultProfile ] [] -``` - -### InputObjectParameterSet -``` -Get-AzureRmCognitiveServicesAccountUsage [-InputObject] - [-DefaultProfile ] [] -``` - -### ResourceIdParameterSet -``` -Get-AzureRmCognitiveServicesAccountUsage [-ResourceId] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Get-AzureRmCognitiveServicesAccountUsage** cmdlet gets current usages for a Cognitive Services account. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmCognitiveServicesAccountUsage -ResourceGroupName TestUsages -Name TestCVUsages_Prediction - -CurrentValue : 0 -Name : CustomVision.Prediction.Transactions -Limit : 10000 -Status : Included -Unit : Count -QuotaPeriod : 30.00:00:00 -NextResetTime : 0001-01-01T00:00:00Z -``` - -### Example 2 -```powershell -PS C:\GitHub> $acc = Get-AzureRmCognitiveServicesAccount -ResourceGroupName TestUsages -Name TestCVUsages_Prediction - -PS C:\GitHub> Get-AzureRmCognitiveServicesAccountUsage -InputObject $acc - - -CurrentValue : 0 -Name : CustomVision.Prediction.Transactions -Limit : 10000 -Status : Included -Unit : Count -QuotaPeriod : 30.00:00:00 -NextResetTime : 0001-01-01T00:00:00Z -``` - -### Example 3 -```powershell -PS C:\GitHub> $acc = Get-AzureRmCognitiveServicesAccount -ResourceGroupName TestUsages -Name TestCVUsages_Prediction - -PS C:\GitHub> Get-AzureRmCognitiveServicesAccountUsage -ResourceId $acc.Id - - -CurrentValue : 0 -Name : CustomVision.Prediction.Transactions -Limit : 10000 -Status : Included -Unit : Count -QuotaPeriod : 30.00:00:00 -NextResetTime : 0001-01-01T00:00:00Z -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Cognitive Services Account Object. - -```yaml -Type: Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSCognitiveServicesAccount -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Cognitive Services Account Name. - -```yaml -Type: System.String -Parameter Sets: ResourceNameParameterSet -Aliases: CognitiveServicesAccountName, AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: ResourceNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Cognitive Services Account Resource ID. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSCognitiveServicesAccount -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSCognitiveServicesUsage - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.CognitiveServices/New-AzureRmCognitiveServicesAccount.md b/azurermps-6.13.0/AzureRM.CognitiveServices/New-AzureRmCognitiveServicesAccount.md deleted file mode 100644 index cbc9d7f3d4..0000000000 --- a/azurermps-6.13.0/AzureRM.CognitiveServices/New-AzureRmCognitiveServicesAccount.md +++ /dev/null @@ -1,233 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.CognitiveServices.dll-Help.xml -Module Name: AzureRM.CognitiveServices -ms.assetid: A2B4ACC1-6F53-47DE-A2D4-831E8AC89A5C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cognitiveservices/new-azurermcognitiveservicesaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/CognitiveServices/Commands.Management.CognitiveServices/help/New-AzureRmCognitiveServicesAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/CognitiveServices/Commands.Management.CognitiveServices/help/New-AzureRmCognitiveServicesAccount.md ---- - -# New-AzureRmCognitiveServicesAccount - -## SYNOPSIS -Creates a Cognitive Services account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmCognitiveServicesAccount [-ResourceGroupName] [-Name] [-Type] - [-SkuName] [-Location] [-Tag ] [-Force] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **New-AzureRmCognitiveServicesAccount** cmdlet creates a Cognitive Services account with the -specified type and SKU. - -## EXAMPLES - -### 1: -``` -PS C:\> New-AzureRmCognitiveServicesAccount -ResourceGroupName cognitive-services-resource-group -name myluis -Type LUIS -SkuName S0 -Locatio -n 'WestUS' - - -ResourceGroupName : cognitive-services-resource-group -AccountName : myluis -Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/cognitive-services-resource-group/providers/Microsoft.Cog - nitiveServices/accounts/myluis -Endpoint : https://westus.api.cognitive.microsoft.com/luis/v2.0 -Location : WestUS -Sku : Microsoft.Azure.Management.CognitiveServices.Models.Sku -AccountType : LUIS -ResourceType : Microsoft.CognitiveServices/accounts -Etag : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ProvisioningState : Succeeded -Tags : -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location in which to create the account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name for the account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: CognitiveServicesAccountName, AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which to assign the account. -The resource group must already exist. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuName -Specifies the SKU for the account. -The acceptable values for this parameter are: -- F0 (free tier) -- S0 -- S1 -- S2 -- S3 -- S4 -For more information, see [Cognitive Service APIs](https://www.microsoft.com/cognitive-services/en-us/apis). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Specifies a tag as a name/value pair. - -```yaml -Type: System.Collections.Hashtable[] -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the type of account to create. Use `Get-AzureRmCognitiveServicesAccountType` cmdlet to get current acceptable values. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: CognitiveServicesAccountType, AccountType, Kind - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSCognitiveServicesAccount - -## NOTES - -## RELATED LINKS - -[Get-AzureRmCognitiveServicesAccount](./Get-AzureRmCognitiveServicesAccount.md) - -[Remove-AzureRmCognitiveServicesAccount](./Remove-AzureRmCognitiveServicesAccount.md) - -[Set-AzureRmCognitiveServicesAccount](./Set-AzureRmCognitiveServicesAccount.md) diff --git a/azurermps-6.13.0/AzureRM.CognitiveServices/New-AzureRmCognitiveServicesAccountKey.md b/azurermps-6.13.0/AzureRM.CognitiveServices/New-AzureRmCognitiveServicesAccountKey.md deleted file mode 100644 index e3a0f55053..0000000000 --- a/azurermps-6.13.0/AzureRM.CognitiveServices/New-AzureRmCognitiveServicesAccountKey.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.CognitiveServices.dll-Help.xml -Module Name: AzureRM.CognitiveServices -ms.assetid: E0819A61-157A-4DFD-B492-09C8F1C38E18 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cognitiveservices/new-azurermcognitiveservicesaccountkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/CognitiveServices/Commands.Management.CognitiveServices/help/New-AzureRmCognitiveServicesAccountKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/CognitiveServices/Commands.Management.CognitiveServices/help/New-AzureRmCognitiveServicesAccountKey.md ---- - -# New-AzureRmCognitiveServicesAccountKey - -## SYNOPSIS -Regenerates an account key. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmCognitiveServicesAccountKey [-ResourceGroupName] [-Name] [-KeyName] - [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **New-AzureRmCognitiveServicesAccountKey** cmdlet regenerates an API key for a Cognitive Services account. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-AzureRmCognitiveServicesAccountKey -ResourceGroupName cognitive-services-resource-group -name myluis -keyname Key1 - -Key1 Key2 ----- ---- -xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyName -Specifies the name of the key to regenerate. -The acceptable values for this parameter are: -- Key1 -- Key2 - -```yaml -Type: Microsoft.Azure.Management.CognitiveServices.Models.KeyName -Parameter Sets: (All) -Aliases: -Accepted values: Key1, Key2 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: CognitiveServicesAccountName, AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group the account is assigned to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Management.CognitiveServices.Models.KeyName - -## OUTPUTS - -### Microsoft.Azure.Management.CognitiveServices.Models.CognitiveServicesAccountKeys - -## NOTES - -## RELATED LINKS - -[Get-AzureRmCognitiveServicesAccountKey](./Get-AzureRmCognitiveServicesAccountKey.md) - - diff --git a/azurermps-6.13.0/AzureRM.CognitiveServices/Remove-AzureRmCognitiveServicesAccount.md b/azurermps-6.13.0/AzureRM.CognitiveServices/Remove-AzureRmCognitiveServicesAccount.md deleted file mode 100644 index fb1c91161f..0000000000 --- a/azurermps-6.13.0/AzureRM.CognitiveServices/Remove-AzureRmCognitiveServicesAccount.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.CognitiveServices.dll-Help.xml -Module Name: AzureRM.CognitiveServices -ms.assetid: 87A79215-5688-474D-822A-6B84B3D10E3F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cognitiveservices/remove-azurermcognitiveservicesaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/CognitiveServices/Commands.Management.CognitiveServices/help/Remove-AzureRmCognitiveServicesAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/CognitiveServices/Commands.Management.CognitiveServices/help/Remove-AzureRmCognitiveServicesAccount.md ---- - -# Remove-AzureRmCognitiveServicesAccount - -## SYNOPSIS -Deletes a Cognitive Services account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmCognitiveServicesAccount [-ResourceGroupName] [-Name] [-Force] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AzureRmCognitiveServicesAccount** cmdlet deletes the specified Cognitive Services account. - -## EXAMPLES - -### Example 1 -This command doesn't return anything. - -```powershell -PS C:\> Remove-AzureRmCognitiveServicesAccount -ResourceGroupName cognitive-services-resource-group -name myluis -PS C:\> -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the account to delete. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: CognitiveServicesAccountName, AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group the Cognitive Services account is assigned to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmCognitiveServicesAccount](./Get-AzureRmCognitiveServicesAccount.md) - -[New-AzureRmCognitiveServicesAccount](./New-AzureRmCognitiveServicesAccount.md) - -[Set-AzureRmCognitiveServicesAccount](./Set-AzureRmCognitiveServicesAccount.md) - - diff --git a/azurermps-6.13.0/AzureRM.CognitiveServices/Set-AzureRmCognitiveServicesAccount.md b/azurermps-6.13.0/AzureRM.CognitiveServices/Set-AzureRmCognitiveServicesAccount.md deleted file mode 100644 index e393bc7980..0000000000 --- a/azurermps-6.13.0/AzureRM.CognitiveServices/Set-AzureRmCognitiveServicesAccount.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.CognitiveServices.dll-Help.xml -Module Name: AzureRM.CognitiveServices -ms.assetid: 11E2D82A-1DF1-4E19-8328-44674641D1BB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.cognitiveservices/set-azurermcognitiveservicesaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/CognitiveServices/Commands.Management.CognitiveServices/help/Set-AzureRmCognitiveServicesAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/CognitiveServices/Commands.Management.CognitiveServices/help/Set-AzureRmCognitiveServicesAccount.md ---- - -# Set-AzureRmCognitiveServicesAccount - -## SYNOPSIS -Modifies an account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmCognitiveServicesAccount [-ResourceGroupName] [-Name] [-SkuName ] - [-Tag ] [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Set-AzureRmCognitiveServicesAccount** cmdlet modifies the SKU or tags of the specified Cognitive Services account. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Set-AzureRmCognitiveServicesAccount -ResourceGroupName cognitive-services-resource-group -name myluis -SkuName S0 - - -ResourceGroupName : cognitive-services-resource-group -AccountName : myluis -Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/cognitive-services-resource-group/providers/Microsoft.Cog - nitiveServices/accounts/myluis -Endpoint : https://westus.api.cognitive.microsoft.com/luis/v2.0 -Location : WESTUS -Sku : Microsoft.Azure.Management.CognitiveServices.Models.Sku -AccountType : LUIS -ResourceType : Microsoft.CognitiveServices/accounts -Etag : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ProvisioningState : Succeeded -Tags : -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the account to modify. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: CognitiveServicesAccountName, AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group the account is assigned to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuName -Specifies the SKU for the account. -The acceptable values for this parameter are: -- F0 (free tier) -- S0 -- S1 -- S2 -- S3 -- S4 - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Specifies a tag as a name/value pair. - -```yaml -Type: System.Collections.Hashtable[] -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable[] - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSCognitiveServicesAccount - -## NOTES - -## RELATED LINKS - -[Get-AzureRmCognitiveServicesAccount](./Get-AzureRmCognitiveServicesAccount.md) - -[New-AzureRmCognitiveServicesAccount](./New-AzureRmCognitiveServicesAccount.md) - -[Remove-AzureRmCognitiveServicesAccount](./Remove-AzureRmCognitiveServicesAccount.md) diff --git a/azurermps-6.13.0/AzureRM.Compute.ManagedService/AzureRM.Compute.ManagedService.md b/azurermps-6.13.0/AzureRM.Compute.ManagedService/AzureRM.Compute.ManagedService.md deleted file mode 100644 index 85da2eaa19..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute.ManagedService/AzureRM.Compute.ManagedService.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -Module Name: AzureRM.Compute.ManagedService -Module Guid: 5c5f634f-b323-4822-b8e4-695dd0110af9 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute.managedservice -Help Version: 3.5.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute.ManagedService/Commands.Compute.ManagedService/help/AzureRM.Compute.ManagedService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute.ManagedService/Commands.Compute.ManagedService/help/AzureRM.Compute.ManagedService.md ---- - -# AzureRM.Compute.ManagedService Module -## Description -This topic displays the help topics for the Azure Compute Cmdlets. - -## AzureRM.Compute.ManagedService Cmdlets -### [ConvertTo-AzureRmVhd](ConvertTo-AzureRmVhd.md) -Convert Hyper-V VM to Azure supported virtual hard disk files - diff --git a/azurermps-6.13.0/AzureRM.Compute.ManagedService/ConvertTo-AzureRmVhd.md b/azurermps-6.13.0/AzureRM.Compute.ManagedService/ConvertTo-AzureRmVhd.md deleted file mode 100644 index ed034842b9..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute.ManagedService/ConvertTo-AzureRmVhd.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: AzureRM.Compute.ManagedService-help.xml -Module Name: AzureRM.Compute.ManagedService -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute.managedservice/convertto-azurermvhd -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute.ManagedService/Commands.Compute.ManagedService/help/ConvertTo-AzureRmVhd.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute.ManagedService/Commands.Compute.ManagedService/help/ConvertTo-AzureRmVhd.md ---- - -# ConvertTo-AzureRmVhd - -## SYNOPSIS -Convert Hyper-V VM to Azure supported virtual hard disk files - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -ConvertTo-AzureRmVhd -HyperVVMName -ExportPath [-HyperVServer ] [-Force] [-AsJob] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Convert Hyper-V VM to Azure supported virtual hard disk files - -## EXAMPLES - -### Example 1 -``` -PS C:\> ConvertTo-AzureRmVhd -HyperVVMName 'test' -ExportPath '.'; -.\test\Virtual Hard Disks\Converted\os.vhd -.\test\Virtual Hard Disks\Converted\disk.vhd -``` - -Convert Hyper-V VM named 'test' to Azure supported virtual hard disk files to the current folder. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExportPath -The export folder path that will contain the disk files. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Force the export even if existing folder is found. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HyperVServer -The Hyper-V server DNS name, with 'localhost' as the default value. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Localhost -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HyperVVMName -The Hyper-V name name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Management.Automation.PathInfo - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Add-AzureRMVhd.md b/azurermps-6.13.0/AzureRM.Compute/Add-AzureRMVhd.md deleted file mode 100644 index e488e37065..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Add-AzureRMVhd.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: D08DAA8B-B7BF-4167-AB16-F2723985A0B7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/add-azurermvhd -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRMVhd.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRMVhd.md ---- - -# Add-AzureRmVhd - -## SYNOPSIS -Uploads a virtual hard disk from an on-premises virtual machine to a blob in a cloud storage account in Azure. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmVhd [[-ResourceGroupName] ] [-Destination] [-LocalFilePath] - [[-NumberOfUploaderThreads] ] [[-BaseImageUriToPatch] ] [-OverWrite] [-AsJob] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Add-AzureRmVhd** cmdlet uploads on-premises virtual hard disks, in .vhd file format, to a blob storage account as fixed virtual hard disks. -You can configure the number of uploader threads that will be used or overwrite an existing blob in the specified destination URI. -Also supported is the ability to upload a patched version of an on-premises .vhd file. -When a base virtual hard disk has already been uploaded, you can upload differencing disks that use the base image as the parent. -Shared access signature (SAS) URI is supported also. - -## EXAMPLES - -### Example 1: Add a VHD file -``` -PS C:\> Add-AzureRmVhd -Destination "http://contosoaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd" -LocalFilePath "C:\vhd\Win7Image.vhd" -``` - -This command adds a .vhd file to a storage account. - -### Example 2: Add a VHD file and overwrite the destination -``` -PS C:\> Add-AzureRmVhd -Destination "http://contosoaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd" -LocalFilePath "C:\vhd\Win7Image.vhd" -Overwrite -``` - -This command adds a .vhd file to a storage account. -The command overwrites an existing file. - -### Example 3: Add a VHD file and specify the number of threads -``` -PS C:\> Add-AzureRmVhd -Destination "http://contosoaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd" -LocalFilePath "C:\vhd\Win7Image.vhd" -NumberOfUploaderThreads 32 -``` - -This command adds a .vhd file to a storage account. -The command specifies the number of threads to use to upload the file. - -### Example 4: Add a VHD file and specify the SAS URI -``` -PS C:\> Add-AzureRmVhd -Destination "http://contosoaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd?st=2013-01 -09T22%3A15%3A49Z&se=2013-01-09T23%3A10%3A49Z&sr=b&sp=w&sig=13T9Ow%2FRJAMmhfO%2FaP3HhKKJ6AY093SmveO SIV4%2FR7w%3D" -LocalFilePath "C:\vhd\win7baseimage.vhd" -``` - -This command adds a .vhd file to a storage account and specifies the SAS URI. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BaseImageUriToPatch -Specifies the URI to a base image blob in Azure Blob Storage. -An SAS can be specified as the value for this parameter. - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: bs - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Destination -Specifies the URI of a blob in Blob Storage. -The parameter supports SAS URI, although patching scenarios destination cannot be an SAS URI. - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: dst - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LocalFilePath -Specifies the path of the local .vhd file. - -```yaml -Type: System.IO.FileInfo -Parameter Sets: (All) -Aliases: lf - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NumberOfUploaderThreads -Specifies the number of uploader threads to be used when uploading the .vhd file. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: th - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OverWrite -Indicates that this cmdlet overwrites an existing blob in the specified destination URI, if one exists. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: o - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Uri - -### System.IO.FileInfo - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.VhdUploadContext - -## NOTES - -## RELATED LINKS - -[Save-AzureRmVhd](./Save-AzureRmVhd.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmContainerServiceAgentPoolProfile.md b/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmContainerServiceAgentPoolProfile.md deleted file mode 100644 index de34179121..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmContainerServiceAgentPoolProfile.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: C3C65F3E-1192-4B57-87DB-5D371C8FF68E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/add-azurermcontainerserviceagentpoolprofile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmContainerServiceAgentPoolProfile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmContainerServiceAgentPoolProfile.md ---- - -# Add-AzureRmContainerServiceAgentPoolProfile - -## SYNOPSIS -Adds a container service agent pool profile. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmContainerServiceAgentPoolProfile [-ContainerService] [[-Name] ] - [[-Count] ] [[-VmSize] ] [[-DnsPrefix] ] [-DefaultProfile ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Add-AzureRmContainerServiceAgentPoolProfile** cmdlet adds a container service agent pool profile to a local container service object. - -## EXAMPLES - -### Example 1: Add a profile -``` -PS C:\> Add-AzureRmContainerServiceAgentPoolProfile -Name "AgentPool01" -VmSize "Standard_A1" -DnsPrefix "APResourceGroup17" -``` - -This command adds a container service agent pool profile to the local container service object. - -## PARAMETERS - -### -ContainerService -Specifies the container service object to which this cmdlet adds an agent pool profile. -To obtain a **ContainerService** object, use the [New-AzureRmContainerServiceConfig](./New-AzureRmContainerServiceConfig.md) cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSContainerService -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Count -Specifies the number of agents that host containers. -The acceptable values for this parameter are: integers from 1 to 100. -The default value is 1. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DnsPrefix -Specifies the DNS prefix that this cmdlet uses to create the fully qualified domain name for this agent pool. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the agent pool profile. -This value must be unique in the context of the subscription and resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VmSize -Specifies the size of the virtual machines for the agents. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSContainerService - -### System.String - -### System.Int32 - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSContainerService - -## NOTES - -## RELATED LINKS - -[New-AzureRmContainerServiceConfig](./New-AzureRmContainerServiceConfig.md) - -[Remove-AzureRmContainerServiceAgentPoolProfile](./Remove-AzureRmContainerServiceAgentPoolProfile.md) diff --git a/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmImageDataDisk.md b/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmImageDataDisk.md deleted file mode 100644 index 82ee819bd0..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmImageDataDisk.md +++ /dev/null @@ -1,236 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/add-azurermimagedatadisk -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmImageDataDisk.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmImageDataDisk.md ---- - -# Add-AzureRmImageDataDisk - -## SYNOPSIS -Adds a data disk to an image object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmImageDataDisk [-Image] [[-Lun] ] [[-BlobUri] ] [[-Caching] ] - [-DiskSizeGB ] [-StorageAccountType ] [-SnapshotId ] [-ManagedDiskId ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Add-AzureRmImageDataDisk** cmdlet adds a data disk to an image object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $imageConfig = New-AzureRmImageConfig -Location 'West US'; -PS C:\> $osDiskVhdUri = "https://contoso.blob.core.windows.net/test/os.vhd" -PS C:\> $dataDiskVhdUri1 = "https://contoso.blob.core.windows.net/test/data1.vhd" -PS C:\> $dataDiskVhdUri2 = "https://contoso.blob.core.windows.net/test/data2.vhd" -PS C:\> Set-AzureRmImageOsDisk -Image $imageConfig -OsType 'Windows' -OsState 'Generalized' -BlobUri $osDiskVhdUri; -PS C:\> Add-AzureRmImageDataDisk -Image $imageConfig -Lun 1 -BlobUri $dataDiskVhdUri1; -PS C:\> Add-AzureRmImageDataDisk -Image $imageConfig -Lun 2 -BlobUri $dataDiskVhdUri2; -PS C:\> New-AzureRmImage -Image $imageConfig -ImageName 'ImageName01' -ResourceGroupName 'ResourceGroup01'; -``` - -The first command creates an image object, and then stores it in the $imageConfig variable. -The next three commands assign paths of operating system disk and two data disks to the $osDiskVhdUri, $dataDiskVhdUri1, and $dataDiskVhdUri2 variables. -This approach is only for readability of the following commands. -The next three commands each adds an operating system disk and two data disks to the image stored in $imageConfig. -The URI of each disk is stored in $osDiskVhdUri, $dataDiskVhdUri1, and $dataDiskVhdUri2. -The final command creates an image named ImageName01 in resource group ResourceGroup01. - -## PARAMETERS - -### -BlobUri -Specifies the link, as a URI, of the blob. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Caching -Specifies the caching mode of the disk. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.CachingTypes] -Parameter Sets: (All) -Aliases: -Accepted values: None, ReadOnly, ReadWrite - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskSizeGB -Specifies the size of the disk in Gigabytes (GB). - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Image -Specifies a local image object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSImage -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Lun -Specifies the logical unit number (LUN). - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ManagedDiskId -Specifies the ID of a managed disk. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SnapshotId -Specifies the ID of a snapshot. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountType -The Storage Account type of the data image disk - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSImage - -### System.Int32 - -### System.String - -### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.CachingTypes, Microsoft.Azure.Management.Compute, Version=21.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSImage - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVMAdditionalUnattendContent.md b/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVMAdditionalUnattendContent.md deleted file mode 100644 index 2a93ed350a..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVMAdditionalUnattendContent.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 50B64FFE-8277-4DAA-805A-271123B35355 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/add-azurermvmadditionalunattendcontent -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmVMAdditionalUnattendContent.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmVMAdditionalUnattendContent.md ---- - -# Add-AzureRmVMAdditionalUnattendContent - -## SYNOPSIS -Adds information to the unattended Windows Setup answer file. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmVMAdditionalUnattendContent [-VM] [[-Content] ] - [[-SettingName] ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Add-AzureRmVMAdditionalUnattendContent** cmdlet adds information to the unattended Windows Setup answer file. -Specify additional base 64 encoded .xml formatted information that this cmdlet adds to the unattend.xml file. - -## EXAMPLES - -### Example 1: Add content to unattend.xml -``` -PS C:\> $AvailabilitySet = Get-AzureRmAvailabilitySet -ResourceGroupName "ResourceGroup11" -Name "AvailabilitySet03" -PS C:\> $VirtualMachine = New-AzureRmVMConfig -VMName "VirtualMachine07" -VMSize "Standard_A1" -AvailabilitySetID $AvailabilitySet.Id -PS C:\> $Credential = Get-Credential -PS C:\> $VirtualMachine = Set-AzureRmVMOperatingSystem -VM $VirtualMachine -Windows -ComputerName "Contoso26" -Credential $Credential -PS C:\> $AucContent = "" + "Password" + "true</PlainText></AdministratorPassword></UserAccounts>"; -PS C:\> $VirtualMachine = Add-AzureRmVMAdditionalUnattendContent -VM $VirtualMachine -Content $AucContent -SettingName "AutoLogon" -``` - -The first command gets the availability set named AvailablitySet03 in the resource group named ResourceGroup11, and then stores that object in the $AvailabilitySet variable. -The second command creates a virtual machine object, and then stores it in the $VirtualMachine variable. -The command assigns a name and size to the virtual machine. -The virtual machine belongs to the availability set stored in $AvailabilitySet. -The third command creates a credential object by using the Get-Credential cmdlet, and then stores the result in the $Credential variable. -The command prompts you for a user name and password. -For more information, type `Get-Help Get-Credential`. -The fourth command uses the **Set-AzureRmVMOperatingSystem** cmdlet to configure the virtual machine stored in $VirtualMachine. -The fifth command assigns content to the $AucContent variable. -The content includes a password. -The final command adds the content stored in $AucContent to the unattend.xml file. - -## PARAMETERS - -### -Content -Specifies base 64 encoded XML formatted content. -This cmdlet adds the content to the unattend.xml file. -The XML content must be less than 4 KB and must include the root element for the setting or feature that this cmdlet inserts. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SettingName -Specifies the name of the setting to which the content applies. -The acceptable values for this parameter are: -- FirstLogonCommands -- AutoLogon - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.SettingNames] -Parameter Sets: (All) -Aliases: -Accepted values: AutoLogon, FirstLogonCommands - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine object that this cmdlet modifies. -To obtain a virtual machine object, use the [Get-AzureRmVM](./Get-AzureRmVM.md) cmdlet. -Create a virtual machine object by using the [New-AzureRmVMConfig](./New-AzureRmVMConfig.md) cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine -Parameter Sets: (All) -Aliases: VMProfile - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -### System.String - -### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.SettingNames, Microsoft.Azure.Management.Compute, Version=21.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAvailabilitySet](./Get-AzureRmAvailabilitySet.md) - -[Set-AzureRmVMOperatingSystem](./Set-AzureRmVMOperatingSystem.md) - -[New-AzureRmVMConfig](./New-AzureRmVMConfig.md) diff --git a/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVMDataDisk.md b/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVMDataDisk.md deleted file mode 100644 index 42c2030f9a..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVMDataDisk.md +++ /dev/null @@ -1,384 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 169E6694-82CD-4FCB-AB3D-E8A74001B8DB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/add-azurermvmdatadisk -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmVMDataDisk.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmVMDataDisk.md ---- - -# Add-AzureRmVMDataDisk - -## SYNOPSIS -Adds a data disk to a virtual machine or a Vmss VM. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### VmNormalDiskParameterSetName (Default) -``` -Add-AzureRmVMDataDisk [-VM] <PSVirtualMachine> [[-Name] <String>] [[-VhdUri] <String>] - [[-Caching] <CachingTypes>] [[-DiskSizeInGB] <Int32>] [-Lun] <Int32> [-CreateOption] <String> - [[-SourceImageUri] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### VmManagedDiskParameterSetName -``` -Add-AzureRmVMDataDisk [-VM] <PSVirtualMachine> [[-Name] <String>] [[-Caching] <CachingTypes>] - [[-DiskSizeInGB] <Int32>] [-Lun] <Int32> [-CreateOption] <String> [[-ManagedDiskId] <String>] - [[-StorageAccountType] <String>] [-WriteAccelerator] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### VmScaleSetVMParameterSetName -``` -Add-AzureRmVMDataDisk [-VirtualMachineScaleSetVM] <PSVirtualMachineScaleSetVM> [[-Caching] <CachingTypes>] - [[-DiskSizeInGB] <Int32>] [-Lun] <Int32> [-CreateOption] <String> [-ManagedDiskId] <String> - [[-StorageAccountType] <String>] [-WriteAccelerator] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVMDataDisk** cmdlet adds a data disk to a virtual machine or a Vmss VM. -You can add a data disk when you create a virtual machine, or you can add a data disk to an existing virtual machine. - -## EXAMPLES - -### Example 1: Add data disks to a new virtual machine -``` -PS C:\> $VirtualMachine = New-AzureRmVMConfig -VMName "VirtualMachine07" -VMSize "Standard_A1" -PS C:\> $DataDiskVhdUri01 = "https://contoso.blob.core.windows.net/test/data1.vhd" -PS C:\> $DataDiskVhdUri02 = "https://contoso.blob.core.windows.net/test/data2.vhd" -PS C:\> $DataDiskVhdUri03 = "https://contoso.blob.core.windows.net/test/data3.vhd" -PS C:\> $VirtualMachine = Add-AzureRmVMDataDisk -VM $VirtualMachine -Name 'DataDisk1' -Caching 'ReadOnly' -DiskSizeInGB 10 -Lun 0 -VhdUri $DataDiskVhdUri01 -CreateOption Empty -PS C:\> $VirtualMachine = Add-AzureRmVMDataDisk -VM $VirtualMachine -Name 'DataDisk2' -Caching 'ReadOnly' -DiskSizeInGB 11 -Lun 1 -VhdUri $DataDiskVhdUri02 -CreateOption Empty -PS C:\> $VirtualMachine = Add-AzureRmVMDataDisk -VM $VirtualMachine -Name 'DataDisk3' -Caching 'ReadOnly' -DiskSizeInGB 12 -Lun 2 -VhdUri $DataDiskVhdUri03 -CreateOption Empty -``` - -The first command creates a virtual machine object, and then stores it in the $VirtualMachine variable. -The command assigns a name and size to the virtual machine. -The next three commands assign paths of three data disks to the $DataDiskVhdUri01, $DataDiskVhdUri02, and $DataDiskVhdUri03 variables. -This approach is only for readability of the following commands. -The final three commands each adds a data disk to the virtual machine stored in $VirtualMachine. -The command specifies the name and location for the disk, and other properties of the disk. -The URI of each disk is stored in $DataDiskVhdUri01, $DataDiskVhdUri02, and $DataDiskVhdUri03. - -### Example 2: Add a data disk to an existing virtual machine -``` -PS C:\> $VirtualMachine = Get-AzureRmVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -PS C:\> Add-AzureRmVMDataDisk -VM $VirtualMachine -Name "disk1" -VhdUri "https://contoso.blob.core.windows.net/vhds/diskstandard03.vhd" -LUN 0 -Caching ReadOnly -DiskSizeinGB 1 -CreateOption Empty -PS C:\> Update-AzureRmVM -ResourceGroupName "ResourceGroup11" -VM $VirtualMachine -``` - -The first command gets the virtual machine named VirtualMachine07 by using the [Get-AzureRmVM](./Get-AzureRmVM.md) cmdlet. -The command stores the virtual machine in the $VirtualMachine variable. -The second command adds a data disk to the virtual machine stored in $VirtualMachine. -The final command updates the state of the virtual machine stored in $VirtualMachine in ResourceGroup11. - -### Example 3: Add a data disk to a new virtual machine from a generalized user image -``` -PS C:\> $VirtualMachine = New-AzureRmVMConfig -VMName "VirtualMachine07" -VMSize "Standard_A1" -PS C:\> $DataImageUri = "https://contoso.blob.core.windows.net/system/Microsoft.Compute/Images/captured/dataimage.vhd" -PS C:\> $DataDiskUri = "https://contoso.blob.core.windows.net/test/datadisk.vhd" -PS C:\> $VirtualMachine = Add-AzureRmVMDataDisk -VM $VirtualMachine -Name "disk1" -SourceImageUri $DataImageUri -VhdUri $DataDiskUri -Lun 0 -DiskSizeinGB 10 -CreateOption FromImage -``` - -The first command creates a virtual machine object and stores it in the $VirtualMachine variable. -The command assigns a name and size to the virtual machine. -The next two commands assign paths for the data image and data disks to the $DataImageUri and $DataDiskUri variables respectively. -This approach is used to improve the readability of the following commands. -The final commands adds a data disk to the virtual machine stored in $VirtualMachine. -The command specifies the name and location for the disk and other properties of the disk. - -### Example 4: Add data disks to a new virtual machine from a specialized user image -``` -PS C:\> $VirtualMachine = New-AzureRmVMConfig -VMName "VirtualMachine07" -VMSize "Standard_A1" -PS C:\> $DataDiskUri = "https://contoso.blob.core.windows.net/test/datadisk.vhd" -PS C:\> $VirtualMachine = Add-AzureRmVMDataDisk -VM $VirtualMachine -Name "dd1" -VhdUri $DataDiskUri -Lun 0 -DiskSizeinGB 10 -CreateOption Attach -``` - -The first command creates a virtual machine object and stores it in the $VirtualMachine variable. -The command assigns a name and size to the virtual machine. -The next commands assigns paths of the data disk to the $DataDiskUri variable. -This approach is used to improve the readability of the following commands. -The final command add a data disk to the virtual machine stored in $VirtualMachine. -The command specifies the name and location for the disk, and other properties of the disk. - -### Example 5: Add a managed data disk to a Vmss VM. -``` -PS C:\> $disk = Get-AzureRmDisk -ResourceGroupName $rgname -DiskName $diskname0 -PS C:\> $VmssVM = Get-AzureRmVmssVM -ResourceGroupName "myrg" -VMScaleSetName "myvmss" -InstanceId 0 -PS C:\> $VmssVM = Add-AzureRmVMDataDisk -VirtualMachineScaleSetVM $VmssVM -Lun 0 -DiskSizeInGB 10 -CreateOption Attach -StorageAccountType Standard_LRS -ManagedDiskId $disk.Id -PS C:\> Update-AzureRmVmssVM -VirtualMachineScaleSetVM $VmssVM -``` - -The first command gets an existing managed disk. -The next command gets an existing Vmss VM given by the resource group name, the vmss name and the instance ID. -The next command adds the managed disk to the Vmss VM stored locally in $VmssVM. -The final command updates the Vmss VM with added data disk. - -## PARAMETERS - -### -Caching -Specifies the caching mode of the disk. -The acceptable values for this parameter are: -- ReadOnly -- ReadWrite -- None -The default value is ReadWrite. -Changing this value causes the virtual machine to restart. -This setting affects the consistency and performance of the disk. - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.CachingTypes -Parameter Sets: (All) -Aliases: -Accepted values: None, ReadOnly, ReadWrite - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CreateOption -Specifies whether this cmdlet creates a disk in the virtual machine from a platform or user image, creates an empty disk, or attaches an existing disk. -The acceptable values for this parameter are: -- Attach. -Specify this option to create a virtual machine from a specialized disk. -When you specify this option, do not specify the *SourceImageUri* parameter. -The *VhdUri* is all that is needed in order to tell the Azure platform the location of the virtual hard disk (VHD) to attach as a data disk to the virtual machine. -- Empty. -Specify this to create an empty data disk. -- FromImage. -Specify this option to create a virtual machine from a generalized image or disk. -When you specify this option, you must specify the *SourceImageUri* parameter also in order to tell the Azure platform the location of the VHD to attach as a data disk. -The *VhdUri* parameter is used as the location identifying where the data disk VHD will be stored when it is used by the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskSizeInGB -Specifies the size, in gigabytes, of an empty disk to attach to a virtual machine. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Lun -Specifies the logical unit number (LUN) for a data disk. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ManagedDiskId -Specifies the ID of a managed disk. - -```yaml -Type: System.String -Parameter Sets: VmManagedDiskParameterSetName -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: VmScaleSetVMParameterSetName -Aliases: - -Required: True -Position: 8 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the data disk to add. - -```yaml -Type: System.String -Parameter Sets: VmNormalDiskParameterSetName, VmManagedDiskParameterSetName -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceImageUri -Specifies the source URI of the disk that this cmdlet attaches. - -```yaml -Type: System.String -Parameter Sets: VmNormalDiskParameterSetName -Aliases: SourceImage - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountType -Specifies the storage account type of managed disk. - -```yaml -Type: System.String -Parameter Sets: VmManagedDiskParameterSetName, VmScaleSetVMParameterSetName -Aliases: - -Required: False -Position: 9 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VhdUri -Specifies the Uniform Resource Identifier (URI) for the virtual hard disk (VHD) file to create when a platform image or user image is used. -This cmdlet copies the image binary large object (blob) to this location. -This is the location from which to start the virtual machine. - -```yaml -Type: System.String -Parameter Sets: VmNormalDiskParameterSetName -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSetVM -Specifies the local virtual machine scale set VM object to which to add a data disk. -You can use the **Get-AzureRmVmssVM** cmdlet to obtain a virtual machine scale set VM object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetVM -Parameter Sets: VmScaleSetVMParameterSetName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -VM -Specifies the local virtual machine object to which to add a data disk. -You can use the **Get-AzureRmVM** cmdlet to obtain a virtual machine object. -You can use the **New-AzureRmVMConfig** cmdlet to create a virtual machine object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine -Parameter Sets: VmNormalDiskParameterSetName, VmManagedDiskParameterSetName -Aliases: VMProfile - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WriteAccelerator -Specifies whether WriteAccelerator should be enabled or disabled on a managed data disk. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: VmManagedDiskParameterSetName, VmScaleSetVMParameterSetName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetVM - -### System.String - -### Microsoft.Azure.Management.Compute.Models.CachingTypes - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetVM - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmVMDataDisk](./Remove-AzureRmVMDataDisk.md) - -[Get-AzureRmVM](./Get-AzureRmVM.md) - -[New-AzureRmVMConfig](./New-AzureRmVMConfig.md) diff --git a/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVMNetworkInterface.md b/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVMNetworkInterface.md deleted file mode 100644 index ba2c198091..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVMNetworkInterface.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: BF80D456-DAB1-4B51-B50F-A75C2C66A472 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/add-azurermvmnetworkinterface -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmVMNetworkInterface.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmVMNetworkInterface.md ---- - -# Add-AzureRmVMNetworkInterface - -## SYNOPSIS -Adds a network interface to a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetNicFromNicId (Default) -``` -Add-AzureRmVMNetworkInterface [-VM] <PSVirtualMachine> [-Id] <String> [-Primary] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetNicFromNicObject -``` -Add-AzureRmVMNetworkInterface [-VM] <PSVirtualMachine> - [-NetworkInterface] <System.Collections.Generic.List`1[Microsoft.Azure.Management.Internal.Network.Common.INetworkInterfaceReference]> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVMNetworkInterface** cmdlet adds a network interface to a virtual machine. -You can add an interface when you create a virtual machine or add one to an existing virtual machine. - -## EXAMPLES - -### Example 1: Add a network interface to a new virtual machine -``` -PS C:\> $VirtualMachine = New-AzureRmVMConfig -VMName "VirtualMachine07" -VMSize "Standard_A1" -PS C:\> Add-AzureRmVMNetworkInterface -VM $VirtualMachine -Id "/subscriptions/46fc8ea4-2de6-4179-8ab1-365da4121af4/resourceGroups/contoso/providers/Microsoft.Network/networkInterfaces/sshNIC" -``` - -The first command creates a virtual machine object, and then stores it in the $VirtualMachine variable. -The command assigns a name and size to the virtual machine. -The second command adds a network interface to the virtual machine stored in $VirtualMachine. - -### Example 2: Add a network interface to an existing virtual machine -``` -PS C:\> $VirtualMachine = Get-AzureRmVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -PS C:\> Add-AzureRmVMNetworkInterface -VM $VirtualMachine -Id "/subscriptions/46fc8ea4-2de6-4179-8ab1-365da4121af4/resourceGroups/contoso/providers/Microsoft.Network/networkInterfaces/sshNIC" -PS C:\> Update-AzureRmVM -ResourceGroupName "ResourceGroup11" -VM $VirtualMachine -``` - -The first command gets the virtual machine named VirtualMachine07 by using the **Get-AzureRmVM** cmdlet. -The command stores the virtual machine in the $VirtualMachine variable. -The second command adds a network interface to the virtual machine stored in $VirtualMachine. -The final command updates the state of the virtual machine stored in $VirtualMachine in ResourceGroup11. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of a network interface to add to a virtual machine. -You can use the [Get-AzureRmNetworkInterface](/powershell/module/azurerm.network/get-azurermnetworkinterface) cmdlet to obtain a network interface. - -```yaml -Type: System.String -Parameter Sets: GetNicFromNicId -Aliases: NicId, NetworkInterfaceId - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkInterface -Specifies the network interface. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Internal.Network.Common.INetworkInterfaceReference] -Parameter Sets: GetNicFromNicObject -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Primary -Indicates that this cmdlet adds the network interface as the primary interface. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: GetNicFromNicId -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VM -Specifies a local virtual machine object to which to add a network interface. -To create a virtual machine, use the **New-AzureRmVMConfig** cmdlet. -To obtain an existing virtual machine, use the **Get-AzureRmVM** cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine -Parameter Sets: (All) -Aliases: VMProfile - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -### System.String - -### System.Collections.Generic.List`1[[Microsoft.Azure.Management.Internal.Network.Common.INetworkInterfaceReference, Microsoft.Azure.Commands.Common.Network, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## NOTES - -## RELATED LINKS - -[New-AzureRmVMConfig](./New-AzureRmVMConfig.md) - -[Get-AzureRmVM](./Get-AzureRmVM.md) - -[Get-AzureRmAvailabilitySet](./Get-AzureRmAvailabilitySet.md) diff --git a/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVMSecret.md b/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVMSecret.md deleted file mode 100644 index 68ea1aa9b7..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVMSecret.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 5008F83F-AF3E-47CF-99A3-55129E654128 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/add-azurermvmsecret -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmVMSecret.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmVMSecret.md ---- - -# Add-AzureRmVMSecret - -## SYNOPSIS -Adds a secret to a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmVMSecret [-VM] <PSVirtualMachine> [[-SourceVaultId] <String>] [[-CertificateStore] <String>] - [[-CertificateUrl] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVMSecret** cmdlet adds a secret to a virtual machine. -This value lets you add a certificate to the virtual machine. -The secret must be stored in a Key Vault. -For more information about Key Vault, see [What is Azure Key Vault?](https://azure.microsoft.com/en-us/documentation/articles/key-vault-whatis/). -For more information about the cmdlets, see [Azure Key Vault Cmdlets](/powershell/module/azurerm.keyvault/) in the Microsoft Developer Network library or the [Set-AzureKeyVaultSecret](/powershell/module/azurerm.keyvault/set-azurekeyvaultsecret) cmdlet. - -## EXAMPLES - -### Example 1: Add a secret to a virtual machine -``` -PS C:\> $VirtualMachine = New-AzureRmVMConfig -VMName "VirtualMachine07" -VMSize "Standard_A1" -AvailabilitySetID $AvailabilitySet.Id -PS C:\> $Credential = Get-Credential -PS C:\> $VirtualMachine = Set-AzureRmVMOperatingSystem -VM $VirtualMachine -Windows -ComputerName "Contoso26" -Credential $Credential -PS C:\> $SourceVaultId = "/subscriptions/46f8cea4-2de6-4179-8ab1-365da4211af4/resourceGroups/vault/providers/Microsoft.KeyVault/vaults/keyvault" -PS C:\> $CertificateStore01 = "My" -PS C:\> $CertificateUrl01 = "https://contosovault.vault.azure.net/secrets/514ceb769c984379a7e0230bdd703272" -PS C:\> $VirtualMachine = Add-AzureRmVMSecret -VM $VirtualMachine -SourceVaultId $SourceVaultId -CertificateStore $CertificateStore01 -CertificateUrl $CertificateUrl01 -``` - -The first command creates a virtual machine object, and then stores it in the $VirtualMachine variable. -The command assigns a name and size to the virtual machine. -The second command creates a credential object by using the Get-Credential cmdlet, and then stores the result in the $Credential variable. -The command prompts you for a user name and password. -For more information, type `Get-Help Get-Credential`. -The third command uses the **Set-AzureRmVMOperatingSystem** cmdlet to configure the virtual machine stored in $VirtualMachine. -The fourth command assigns a source vault ID to the $SourceVaultId variable for later use. -The command assumes that the $SubscriptionId variable has an appropriate value. -The fifth command assigns a value to the $CertificateStore01 variable for later use. -The sixth command assigns a URL for a certificate store. -The seventh command adds a secret to the virtual machine stored in $VirtualMachine. -The SourceVaultId parameter specifies the Key Vault. -The command specifies the name of the certificate store and the URL of the certificate. -You can run the **Add-AzureRmVMSecret** repeatedly to add secrets for other certificates. - -## PARAMETERS - -### -CertificateStore -Specifies the name of a certificate store on the virtual machine that runs the Windows operating system. -This cmdlet adds the certificate to the store that this parameter specifies. -You can only specify this parameter for virtual machines that run the Windows operating system. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CertificateUrl -Specifies the URL that points to a Key Vault secret which contains a certificate. -The certificate is the Base64 encoding of the following JavaScript Object Notation (JSON) object, which is encoded in UTF-8: -{ -"data": "\<Base64-encoded-file\>", -"dataType": "\<file-format\>", -"password": "\<pfx-file-password\>" -} -Currently, dataType accepts only .pfx files. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceVaultId -Specifies the resource ID of the Key Vault that contains the certificates that you can add to the virtual machine. -This value also acts as the key for adding multiple certificates. -This means that you can use the same value for *SourceVaultId* when you add multiple certificates from the same Key Vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Id - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine object that this cmdlet modifies. -To obtain a virtual machine object, use the [Get-AzureRmVM](./Get-AzureRmVM.md) cmdlet. -You can use the [New-AzureRmVMConfig](./New-AzureRmVMConfig.md) cmdlet to create a virtual machine object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine -Parameter Sets: (All) -Aliases: VMProfile - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - -[New-AzureRmVMConfig](./New-AzureRmVMConfig.md) - -[Set-AzureRmVMOperatingSystem](./Set-AzureRmVMOperatingSystem.md) diff --git a/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVMSshPublicKey.md b/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVMSshPublicKey.md deleted file mode 100644 index b9d0e0245b..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVMSshPublicKey.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 3CE367B1-7685-4046-8E9C-CE680B5AE03F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/add-azurermvmsshpublickey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmVMSshPublicKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmVMSshPublicKey.md ---- - -# Add-AzureRmVMSshPublicKey - -## SYNOPSIS -Adds the public keys for SSH for a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmVMSshPublicKey [-VM] <PSVirtualMachine> [[-KeyData] <String>] [[-Path] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVMSshPublicKey** cmdlet adds the public keys that you can use to connect to a virtual machine over Secure Shell (SSH). - -## EXAMPLES - -### Example 1: Add a public key to a virtual machine -``` -PS C:\> $VirtualMachine = Get-AzureRmVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -PS C:\> $VirtualMachine = Add-AzureRmVMSshPublicKey -VM $VirtualMachine -KeyData "MIIDszCCApugAwIBAgIJALBV9YJCF/tAMA0GCSq12Ib3DQEB21QUAMEUxCzAJBgNV" -Path "/home/admin/.ssh/authorized_keys" -``` - -The first command gets the virtual machine named VirtualMachine07 by using the **Get-AzureRmVM** cmdlet. -The command stores the virtual machine in the $VirtualMachine variable. -The second command adds the public key to the location on VirtualMachine07 that the Path parameter specifies. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyData -Specifies a base 64 encoding of a public key. -You can connect to a virtual machine by using SSH or by using the key that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the full path of a file, on the virtual machine, where this cmdlet stores the SSH public key. -If the file already exists, this cmdlet appends the key to the file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine object that this cmdlet modifies. -To obtain a virtual machine object, use the [Get-AzureRmVM](./Get-AzureRmVM.md) cmdlet. -You can use the [New-AzureRmVMConfig](./New-AzureRmVMConfig.md) cmdlet to create a virtual machine object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine -Parameter Sets: (All) -Aliases: VMProfile - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - -[New-AzureRmVMConfig](./New-AzureRmVMConfig.md) diff --git a/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssAdditionalUnattendContent.md b/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssAdditionalUnattendContent.md deleted file mode 100644 index c387706c27..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssAdditionalUnattendContent.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 9BE2E42C-594B-4B67-866C-BBA3B84AA5FD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/add-azurermvmssadditionalunattendcontent -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmVmssAdditionalUnattendContent.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmVmssAdditionalUnattendContent.md ---- - -# Add-AzureRmVmssAdditionalUnattendContent - -## SYNOPSIS -Adds information to the unattended Windows Setup answer file. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmVmssAdditionalUnattendContent [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> - [[-PassName] <PassNames>] [[-ComponentName] <ComponentNames>] [[-SettingName] <SettingNames>] - [[-Content] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVmssAdditionalUnattendContent** cmdlet adds information to the unattended Windows Setup answer file. - -## EXAMPLES - -### Example 1: Add information to the unattended Windows Setup answer file -``` -PS C:\> Add-AzureRmVmssAdditionalUnattendContent -VirtualMachineScaleSet $VMSS -ComponentName $AUCComponentName -Content $AUCContent -PassName $AUCPassName -SettingName $AUCSetting -``` - -This command adds information to the unattended Windows Setup answer file. - -## PARAMETERS - -### -ComponentName -Specifies the name of the component to configure with the added content. -The only allowable value is Microsoft-Windows-Shell-Setup. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.ComponentNames] -Parameter Sets: (All) -Aliases: -Accepted values: MicrosoftWindowsShellSetup - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Content -Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassName -Specifies the name of the pass that the content applies to. -The only allowable value is oobeSystem. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.PassNames] -Parameter Sets: (All) -Aliases: -Accepted values: OobeSystem - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SettingName -Specifies the name of the setting to which the content applies. -The acceptable values for this parameter are:: -- FirstLogonCommands -- AutoLogon - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.SettingNames] -Parameter Sets: (All) -Aliases: -Accepted values: AutoLogon, FirstLogonCommands - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specify the virtual machine **Scale Set** object. -You can use the [New-AzureRmVmssConfig](./New-AzureRmVmssConfig.md) cmdlet to create the object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.PassNames, Microsoft.Azure.Management.Compute, Version=21.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.ComponentNames, Microsoft.Azure.Management.Compute, Version=21.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.SettingNames, Microsoft.Azure.Management.Compute, Version=21.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -## NOTES - -## RELATED LINKS - -[New-AzureRmVmssConfig](./New-AzureRmVmssConfig.md) diff --git a/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssDataDisk.md b/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssDataDisk.md deleted file mode 100644 index 6b4cc1ee1f..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssDataDisk.md +++ /dev/null @@ -1,228 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/add-azurermvmssdatadisk -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmVmssDataDisk.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmVmssDataDisk.md ---- - -# Add-AzureRmVmssDataDisk - -## SYNOPSIS -Adds a data disk to the VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmVmssDataDisk [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [[-Name] <String>] - [[-Lun] <Int32>] [[-Caching] <CachingTypes>] [-WriteAccelerator] [-CreateOption <String>] - [-DiskSizeGB <Int32>] [-StorageAccountType <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVmssDataDisk** cmdlet adds a data disk to the Virtual Machine Scale Set (VMSS) instance. - -## EXAMPLES - -### Example 1: Add a data disk -``` -PS C:\> $vmss = New-AzureRmVmssConfig -Location $Loc -SkuCapacity 2 -SkuName "Standard_A0" -UpgradePolicyMode "Automatic" -PS C:\> $vmss = Add-AzureRmVmssDataDisk -VirtualMachineScaleSet $vmss -Name 'DataDisk1' -Lun 0 -Caching 'ReadOnly' -CreateOption Empty -DiskSizeGB 10 -StorageAccountType StandardLRS -``` - -This command adds an empty data disk to the VMSS object. - -## PARAMETERS - -### -Caching -Specifies the caching type of the disk. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.CachingTypes] -Parameter Sets: (All) -Aliases: -Accepted values: None, ReadOnly, ReadWrite - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CreateOption -Specifies the create option of the disk. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskSizeGB -Specifies the size of the disk in GB. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Lun -Specifies the logical unit number of the disk. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the disk. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountType -Specifies the storage account type of the disk. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specify the VMSS object. -You can use the [New-AzureRmVmssConfig](./New-AzureRmVmssConfig.md) cmdlet to create the object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WriteAccelerator -Specifies whether WriteAccelerator should be enabled or disabled on the data disk. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -### System.String - -### System.Int32 - -### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.CachingTypes, Microsoft.Azure.Management.Compute, Version=21.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssDiagnosticsExtension.md b/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssDiagnosticsExtension.md deleted file mode 100644 index 3a78edea30..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssDiagnosticsExtension.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 7A1B92F5-C698-4D5E-ACD7-4013F1BC6247 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/add-azurermvmssdiagnosticsextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmVmssDiagnosticsExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmVmssDiagnosticsExtension.md ---- - -# Add-AzureRmVmssDiagnosticsExtension - -## SYNOPSIS -Adds a diagnostics extension to the VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmVmssDiagnosticsExtension [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> - [-SettingFilePath] <String> [[-ProtectedSettingFilePath] <String>] [[-Name] <String>] - [[-TypeHandlerVersion] <String>] [[-AutoUpgradeMinorVersion] <Boolean>] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVmssDiagnosticsExtension** cmdlet adds a diagnostics extension to the Virtual Machine Scale Set (VMSS) instance. - -## EXAMPLES - -### Example 1: Add a diagnostics extension to the VMSS -``` -PS C:\> Add-AzureRmVmssDiagnosticsExtension -VirtualMachineScaleSet $VMSS -SettingFilePath $publicConfigPath -ProtectedSettingFilePath $privateConfigPath -Name $extName -TypeHandlerVersion $typeVersion -AutoUpgradeMinorVersion $True -Force -``` - -This command adds a diagnostics extension to the VMSS. - -## PARAMETERS - -### -AutoUpgradeMinorVersion -Indicates whether this cmdlet allows the Azure guest agent to automatically update the extension to a newer minor version. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of an extension. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProtectedSettingFilePath -Specifies the path of the private configuration file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SettingFilePath -Specifies the path of the public configuration file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TypeHandlerVersion -Specifies the version of the extension to use for this VMSS. -To obtain the version, run the [Get-AzureRmVMExtensionImage](./Get-AzureRmVMExtensionImage.md) cmdlet with a value of Microsoft.Azure.Diagnostics for the *PublisherName* parameter and IaaSDiagnostics for the *Type* parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: HandlerVersion, Version - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specify the VMSS object. -You can use the [New-AzureRmVmssConfig](./New-AzureRmVmssConfig.md) cmdlet to create the object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSet - -### System.String - -### System.Boolean - -## OUTPUTS - -### Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSet - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVmssExtension](./Add-AzureRmVmssExtension.md) - -[Remove-AzureRmVmssDiagnosticsExtension](./Remove-AzureRmVmssDiagnosticsExtension.md) - -[Set-AzureRmVMDiagnosticsExtension](./Set-AzureRMVMDiagnosticsExtension.md) diff --git a/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssExtension.md b/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssExtension.md deleted file mode 100644 index 96e581fa6f..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssExtension.md +++ /dev/null @@ -1,270 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 7EC166C7-151D-4DA0-9B10-165E735D4F12 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/add-azurermvmssextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmVmssExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmVmssExtension.md ---- - -# Add-AzureRmVmssExtension - -## SYNOPSIS -Adds an extension to the VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmVmssExtension [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [[-Name] <String>] - [[-Publisher] <String>] [[-Type] <String>] [[-TypeHandlerVersion] <String>] - [[-AutoUpgradeMinorVersion] <Boolean>] [[-Setting] <Object>] [[-ProtectedSetting] <Object>] - [-ForceUpdateTag <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVmssExtension** cmdlet adds an extension to the Virtual Machine Scale Set (VMSS). - -## EXAMPLES - -### Example 1: Add an extension to the VMSS -``` -PS C:\> Add-AzureRmVmssExtension -VirtualMachineScaleSet $VMSS -Name $ExtName -Publisher $Publisher -Type $ExtType -TypeHandlerVersion $ExtVer -AutoUpgradeMinorVersion $True -``` - -This command adds an extension to the VMSS. - -### Example 2: Add an extension to the VMSS with settings and protected settings -``` -PS C:\> $Settings = @{"fileUris" = "[]"; "commandToExecute" = ""}; -PS C:\> $ProtectedSettings = @{"storageAccountName" = $stoname; "storageAccountKey" = $stokey}; - -PS C:\> Add-AzureRmVmssExtension -VirtualMachineScaleSet $vmss -Name $vmssExtensionName -Publisher $vmssPublisher ` - -Type $vmssExtensionType -TypeHandlerVersion $ExtVer -AutoUpgradeMinorVersion $True ` - -Setting $Settings -ProtectedSetting $ProtectedSettings -``` - -This command adds an extension to the VMSS with a sample bash script on a blob storage, specify the url of blob storage and executable command in settings and security access in protected settings. - -## PARAMETERS - -### -AutoUpgradeMinorVersion -Indicates whether the extension version should be automatically updated to a newer minor version. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceUpdateTag -If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the extension that this cmdlet adds. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProtectedSetting -Specifies private configuration for the extension, as a string. -This cmdlet encrypts the private configuration. - -```yaml -Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Publisher -Specifies the name of the extension publisher. -The publisher provides a name when the publisher registers an extension. -This can use the [Get-AzureRmVMImagePublisher](./Get-AzureRmVMImagePublisher.md) cmdlet to get the publisher. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Setting -Specifies the public configuration, as a string, for the extension. -This cmdlet does not encrypt public configuration. - -```yaml -Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Type -Specifies the extension type. -You can use the [Get-AzureRmVMExtensionImageType](./Get-AzureRmVMExtensionImageType.md) cmdlet to get the extension type. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TypeHandlerVersion -Specifies the version of the extension to use for this virtual machine. -You can use the [Get-AzureRmVMExtensionImage](./Get-AzureRmVMExtensionImage.md) cmdlet to get the version of the extension. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specify the VMSS object. -You can use the [New-AzureRmVmssConfig](./New-AzureRmVmssConfig.md) to create the object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -### System.String - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Object - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmVmssExtension](./Remove-AzureRmVmssExtension.md) - -[Get-AzureRmVMImagePublisher](./Get-AzureRmVMImagePublisher.md) - -[Get-AzureRmVMExtensionImageType](./Get-AzureRmVMExtensionImageType.md) - -[Get-AzureRmVMExtensionImage](./Get-AzureRmVMExtensionImage.md) - -[New-AzureRmVmssConfig](./New-AzureRmVmssConfig.md) diff --git a/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssNetworkInterfaceConfiguration.md b/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssNetworkInterfaceConfiguration.md deleted file mode 100644 index 34fa6fc2cc..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssNetworkInterfaceConfiguration.md +++ /dev/null @@ -1,246 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: BAC2FA68-1D82-411D-A853-FD4EE525B533 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/add-azurermvmssnetworkinterfaceconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmVmssNetworkInterfaceConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmVmssNetworkInterfaceConfiguration.md ---- - -# Add-AzureRmVmssNetworkInterfaceConfiguration - -## SYNOPSIS -Adds a network interface configuration to the VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmVmssNetworkInterfaceConfiguration [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> - [[-Name] <String>] [[-Primary] <Boolean>] [[-Id] <String>] - [[-IpConfiguration] <VirtualMachineScaleSetIPConfiguration[]>] [-EnableAcceleratedNetworking] - [-EnableIPForwarding] [-NetworkSecurityGroupId <String>] [-DnsSettingsDnsServer <String[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVmssNetworkInterfaceConfiguration** cmdlet adds a network interface configuration to the Virtual Machine Scale Set (VMSS). - -## EXAMPLES - -### Example 1: Add a network interface configuration to the VMSS -``` -PS C:\> Add-AzureRmVmssNetworkInterfaceConfiguration -VirtualMachineScaleSet $VMSS -Name "Test" -Primary $True -IPConfiguration $IPCfg -``` - -This command adds a network interface configuration to the VMSS. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DnsSettingsDnsServer -List of dns server IP addresses for dns settings. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: DnsServer - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableAcceleratedNetworking -Specifies whether the network interface is accelerated networking-enabled. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableIPForwarding -Specifies whether IP forwarding enabled on this NIC. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the Resource ID of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IpConfiguration -Specifies the IP configurations of the network interface. - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetIPConfiguration[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network interface configuration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkSecurityGroupId -Id of the network security group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Primary -Indicates whether network interfaces created from the network interface configuration will be the primary network information center (NIC) of the virtual machine. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specifies the VMSS object. -You can use the [New-AzureRmVmssConfig](./New-AzureRmVmssConfig.md) cmdlet to create the object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -### System.String - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetIPConfiguration[] - -### System.String[] - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -## NOTES - -## RELATED LINKS - -[New-AzureRmVmssConfig](./New-AzureRmVmssConfig.md) diff --git a/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssSecret.md b/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssSecret.md deleted file mode 100644 index 3d305a0494..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssSecret.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 656BE930-E778-40B0-8A75-BFE52DE386CE -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/add-azurermvmsssecret -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmVmssSecret.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmVmssSecret.md ---- - -# Add-AzureRmVmssSecret - -## SYNOPSIS -Adds a secret to a VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmVmssSecret [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [[-SourceVaultId] <String>] - [[-VaultCertificate] <VaultCertificate[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVmssSecret** cmdlet adds a secret to the Virtual Machine Scale Set (VMSS). -The secret must be stored in an Azure Key Vault. -For more information relating to Key Vault, see [What is Azure Key Vault?](https://azure.microsoft.com/en-us/documentation/articles/key-vault-whatis/) (https://azure.microsoft.com/en-us/documentation/articles/key-vault-whatis/). -For more information about the cmdlets, see [Azure Key Vault Cmdlets](/powershell/module/azurerm.keyvault/) in the Microsoft Developer Network library or the [Set-AzureKeyVaultSecret](/powershell/module/azurerm.keyvault/set-azurekeyvaultsecret) cmdlet. - -## EXAMPLES - -### Example 1: Add a secret to the VMSS -``` -PS C:\> $Vault = Get-AzureRmKeyVault -VaultName "ContosoVault" -PS C:\> $CertConfig = New-AzureRmVmssVaultCertificateConfig -CertificateUrl "http://keyVaultName.vault.contoso.net/secrets/secretName/secretVersion" -CertificateStore "Certificates" -PS C:\> $VMSS = New-AzureRmVmssConfig -PS C:\> Add-AzureRmVmssSecret -VirtualMachineScaleSet $VMSS -SourceVaultId $Vault.ResourceId -VaultCertificate $CertConfig -``` - -This example adds a secret to the VMSS. -The first command uses the Get-AzureRmKeyVault cmdlet to get a vault secret from the vault named ContosoVault and stores the result in the variable named $Vault. -The second command uses the **New-AzureRmVmssVaultCertificateConfig** cmdlet to create a Key Vault certificate configuration using the specified certificate URL from the certificate store named Certificates and stores the results in the variable named $CertConfig. -The third command uses the **New-AzureRmVmssConfig** cmdlet to create a VMSS configuration object and stores the result in the variable named $VMSS. -The fourth command adds a secret to the VMSS using the vault secret using the key resource ID and the vault certificate stored in the $Vault and $CertConfig variables. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceVaultId -Specifies the resource ID of the Key Vault that contains the certificates that you can add to the virtual machine. -This value also acts as the key for adding multiple certificates. -This means that you can use the same value for the *SourceVaultId* parameter when you add multiple certificates from the same Key Vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultCertificate -Specifies the Vault **Certificate** object that contains the certificate URL and certificate name. -You can use the [New-AzureRmVmssVaultCertificateConfig](./New-AzureRmVmssVaultCertificateConfig.md) cmdlet to create this object. - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.VaultCertificate[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specifies the VMSS object. -You can use the [New-AzureRmVmssConfig](./New-AzureRmVmssConfig.md) cmdlet to create this object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -### System.String - -### Microsoft.Azure.Management.Compute.Models.VaultCertificate[] - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -## NOTES - -## RELATED LINKS - -[New-AzureRmVmssVaultCertificateConfig](./New-AzureRmVmssVaultCertificateConfig.md) - -[New-AzureRmVmssConfig](./New-AzureRmVmssConfig.md) diff --git a/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssSshPublicKey.md b/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssSshPublicKey.md deleted file mode 100644 index 31a635f116..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssSshPublicKey.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 9C216103-EB77-468E-8684-F5E5400B73A7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/add-azurermvmsssshpublickey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmVmssSshPublicKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmVmssSshPublicKey.md ---- - -# Add-AzureRmVmssSshPublicKey - -## SYNOPSIS -Adds SSH public keys to the VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmVmssSshPublicKey [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [[-Path] <String>] - [[-KeyData] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVmssSshPublicKey** cmdlet adds the public keys that you can use to connect to the Virtual Machine Scale Set (VMSS) virtual machines over Secure Shell (SSH). - -## EXAMPLES - -### Example 1: Add an SSH public key to the VMSS -``` -PS C:\> $VMSS = New-AzureRmVmssConfig -PS C:\> Add-AzureRmVmssSshPublicKey -VirtualMachineScaleSet $VMSS -KeyData "MIIDszCCApugAwIBAgIJALBV9YJCF/tAMA0GCSq12Ib3DQEB21QUAMEUxCzAJBgNV" -Path "/home/admin/.ssh/authorized_keys" -``` - -This example adds an SSH public key to the VMSS. -The first command uses the **New-AzureRmVmssConfig** cmdlet to create a VMSS configuration object and stores the result in the variable named $VMSS. -The second command adds an SSH key with the specified key data and stores the key at the specified path on the virtual machine. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyData -Specifies a SSH RSA public key data. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the full path of a file, on the virtual machine, where this cmdlet stores the SSH public key. -If the file already exists, this cmdlet appends the key to the file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specifies the VMSS object. -You can use the [New-AzureRmVmssConfig](./New-AzureRmVmssConfig.md) cmdlet to create the object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -## NOTES - -## RELATED LINKS - -[New-AzureRmVmssConfig](./New-AzureRmVmssConfig.md) diff --git a/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssVMDataDisk.md b/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssVMDataDisk.md deleted file mode 100644 index 9b43890969..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssVMDataDisk.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/add-azurermvmssvmdatadisk -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmVmssVMDataDisk.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmVmssVMDataDisk.md ---- - -# Add-AzureRmVmssVMDataDisk - -## SYNOPSIS -Adds a data disk to a Vmss VM. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmVmssVMDataDisk [-VirtualMachineScaleSetVM] <PSVirtualMachineScaleSetVM> [-Lun] <Int32> - [-CreateOption] <String> [-ManagedDiskId] <String> [-StorageAccountType <String>] [-Caching <CachingTypes>] - [-DiskSizeInGB <Int32>] [-WriteAccelerator] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVmssVMDataDisk** cmdlet adds a data disk to a Vmss VM. - -## EXAMPLES - -### Example 1: Add a managed data disk to a Vmss VM. -```powershell -PS C:\> $disk = Get-AzureRmDisk -ResourceGroupName $rgname -DiskName $diskname0 -PS C:\> $VmssVM = Get-AzureRmVmssVM -ResourceGroupName "myrg" -VMScaleSetName "myvmss" -InstanceId 0 -PS C:\> $VmssVM = Add-AzureRmVmssVMDataDisk -VirtualMachineScaleSetVM $VmssVM -Lun 0 -DiskSizeInGB 10 -CreateOption Attach -StorageAccountType Standard_LRS -ManagedDiskId $disk.Id -PS C:\> Update-AzureRmVmssVM -VirtualMachineScaleSetVM $VmssVM -``` - -The first command gets an existing managed disk. -The next command gets an existing Vmss VM given by the resource group name, the vmss name and the instance ID. -The next command adds the managed disk to the Vmss VM stored locally in $VmssVM. -The final command updates the Vmss VM with added data disk. - -## PARAMETERS - -### -Caching -Specifies the caching mode of the disk. -The acceptable values for this parameter are: -- ReadOnly -- ReadWrite -- None -The default value is ReadWrite. -Changing this value causes the virtual machine to restart. -This setting affects the consistency and performance of the disk. - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.CachingTypes -Parameter Sets: (All) -Aliases: -Accepted values: None, ReadOnly, ReadWrite - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CreateOption -Specifies whether this cmdlet creates a disk in the virtual machine from a platform or user image, creates an empty disk, or attaches an existing disk. -The acceptable values for this parameter are: -- Attach. -Specify this option to create a virtual machine from a specialized disk. -When you specify this option, do not specify the *SourceImageUri* parameter. -The *VhdUri* is all that is needed in order to tell the Azure platform the location of the virtual hard disk (VHD) to attach as a data disk to the virtual machine. -- Empty. -Specify this to create an empty data disk. -- FromImage. -Specify this option to create a virtual machine from a generalized image or disk. -When you specify this option, you must specify the *SourceImageUri* parameter also in order to tell the Azure platform the location of the VHD to attach as a data disk. -The *VhdUri* parameter is used as the location identifying where the data disk VHD will be stored when it is used by the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskSizeInGB -Specifies the size, in gigabytes, of an empty disk to attach to a virtual machine. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Lun -Specifies the logical unit number (LUN) for a data disk. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ManagedDiskId -Specifies the ID of a managed disk. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountType -Specifies the storage account type of managed disk. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSetVM -Specifies the local virtual machine scale set VM object to which to add a data disk. -You can use the **Get-AzureRmVmssVM** cmdlet to obtain a virtual machine scale set VM object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetVM -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WriteAccelerator -Specifies whether WriteAccelerator should be enabled or disabled on a managed data disk. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetVM - -### System.Int32 - -### System.String - -### Microsoft.Azure.Management.Compute.Models.CachingTypes - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetVM - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssWinRMListener.md b/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssWinRMListener.md deleted file mode 100644 index 29a4acf741..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Add-AzureRmVmssWinRMListener.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 987BD670-20F3-4105-A5BE-03E712AB2B56 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/add-azurermvmsswinrmlistener -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmVmssWinRMListener.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRmVmssWinRMListener.md ---- - -# Add-AzureRmVmssWinRMListener - -## SYNOPSIS -Adds a WinRM listener to the VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmVmssWinRMListener [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [[-Protocol] <ProtocolTypes>] - [[-CertificateUrl] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVmssWinRMListener** cmdlet adds a Windows Remote Management (WinRM) listener on the Virtual Machine Scale Set (VMSS). - -## EXAMPLES - -### Example 1: Add a WinRM listener to the VMSS -``` -PS C:\> $VMSS = New-AzureRmVmssConfig -PS C:\> Add-AzureRmVmssWinRMListener -VirtualMachineScaleSet $VMSS -Protocol Https -CertificateUrl "http://keyVaultName.vault.contoso.net/secrets/secretName/secretVersion" -``` - -This example adds a WinRM listener to the VMSS. -The first command uses the **New-AzureRmVmssConfig** cmdlet to create a VMSS configuration object and stores the result in the variable named $VMSS. -The second command adds an HTTP protocol WinRM listener with the certificate at the specified URL to the VMSS. - -## PARAMETERS - -### -CertificateUrl -Specifies a link, as a URL, of the certificate with which new virtual machines are provisioned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol of the WinRM listener. -The acceptable values for this parameter are: -- Http -- Https - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.ProtocolTypes] -Parameter Sets: (All) -Aliases: -Accepted values: Http, Https - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specifies the VMSS object. -You can use the New-AzureRmVmssConfig cmdlet to create the object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.ProtocolTypes, Microsoft.Azure.Management.Compute, Version=21.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -## NOTES - -## RELATED LINKS - -[New-AzureRmVmssConfig](./New-AzureRmVmssConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/AzureRM.Compute.md b/azurermps-6.13.0/AzureRM.Compute/AzureRM.Compute.md deleted file mode 100644 index 457c407d0a..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/AzureRM.Compute.md +++ /dev/null @@ -1,564 +0,0 @@ ---- -Module Name: AzureRM.Compute -Module Guid: 0a83c907-1ffb-4d87-a492-c65ac7d7ed37 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute -Help Version: 3.5.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/AzureRM.Compute.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/AzureRM.Compute.md ---- - -# AzureRM.Compute Module -## Description -This topic displays the help topics for the Azure Compute Cmdlets. - -## AzureRM.Compute Cmdlets -### [Add-AzureRmContainerServiceAgentPoolProfile](Add-AzureRmContainerServiceAgentPoolProfile.md) -Adds a container service agent pool profile. - -### [Add-AzureRmImageDataDisk](Add-AzureRmImageDataDisk.md) -Adds a data disk to an image object. - -### [Add-AzureRmVhd](Add-AzureRmVhd.md) -Uploads a virtual hard disk from an on-premises virtual machine to a blob in a cloud storage account in Azure. - -### [Add-AzureRmVMAdditionalUnattendContent](Add-AzureRmVMAdditionalUnattendContent.md) -Adds information to the unattended Windows Setup answer file. - -### [Add-AzureRmVMDataDisk](Add-AzureRmVMDataDisk.md) -Adds a data disk to a virtual machine or a Vmss VM. - -### [Add-AzureRmVMNetworkInterface](Add-AzureRmVMNetworkInterface.md) -Adds a network interface to a virtual machine. - -### [Add-AzureRmVMSecret](Add-AzureRmVMSecret.md) -Adds a secret to a virtual machine. - -### [Add-AzureRmVmssAdditionalUnattendContent](Add-AzureRmVmssAdditionalUnattendContent.md) -Adds information to the unattended Windows Setup answer file. - -### [Add-AzureRmVmssDataDisk](Add-AzureRmVmssDataDisk.md) -Adds a data disk to the VMSS. - -### [Add-AzureRmVmssDiagnosticsExtension](Add-AzureRmVmssDiagnosticsExtension.md) -Adds a diagnostics extension to the VMSS. - -### [Add-AzureRmVmssExtension](Add-AzureRmVmssExtension.md) -Adds an extension to the VMSS. - -### [Add-AzureRmVMSshPublicKey](Add-AzureRmVMSshPublicKey.md) -Adds the public keys for SSH for a virtual machine. - -### [Add-AzureRmVmssNetworkInterfaceConfiguration](Add-AzureRmVmssNetworkInterfaceConfiguration.md) -Adds a network interface configuration to the VMSS. - -### [Add-AzureRmVmssSecret](Add-AzureRmVmssSecret.md) -Adds a secret to a VMSS. - -### [Add-AzureRmVmssSshPublicKey](Add-AzureRmVmssSshPublicKey.md) -Adds SSH public keys to the VMSS. - -### [Add-AzureRmVmssVMDataDisk](Add-AzureRmVmssVMDataDisk.md) -Adds a data disk to a Vmss VM. - -### [Add-AzureRmVmssWinRMListener](Add-AzureRmVmssWinRMListener.md) -Adds a WinRM listener to the VMSS. - -### [ConvertTo-AzureRmVMManagedDisk](ConvertTo-AzureRmVMManagedDisk.md) -Converts a virtual machine with blob-based disks to a virtual machine with managed disks. - -### [Disable-AzureRmVMDiskEncryption](Disable-AzureRmVMDiskEncryption.md) -Disables encryption on an IaaS virtual machine. - -### [Disable-AzureRmVmssDiskEncryption](Disable-AzureRmVmssDiskEncryption.md) -Disables disk encryption on a VM scale set. - -### [Export-AzureRmLogAnalyticRequestRateByInterval](Export-AzureRmLogAnalyticRequestRateByInterval.md) -Export logs that show Api requests made by this subscription in the given time window to show throttling activities. - -### [Export-AzureRmLogAnalyticThrottledRequests](Export-AzureRmLogAnalyticThrottledRequests.md) -Export logs that show total throttled Api requests for this subscription in the given time window. - -### [Get-AzureRmAvailabilitySet](Get-AzureRmAvailabilitySet.md) -Gets Azure availability sets in a resource group. - -### [Get-AzureRmComputeResourceSku](Get-AzureRmComputeResourceSku.md) -List all compute resource Skus - -### [Get-AzureRmContainerService](Get-AzureRmContainerService.md) -Gets a container service. - -### [Get-AzureRmDisk](Get-AzureRmDisk.md) -Gets the properties of a Managed disk. - -### [Get-AzureRmGallery](Get-AzureRmGallery.md) -Get or list galleries. - -### [Get-AzureRmGalleryImageDefinition](Get-AzureRmGalleryImageDefinition.md) -Get or list gallery image definitions. - -### [Get-AzureRmGalleryImageVersion](Get-AzureRmGalleryImageVersion.md) -Get or list gallery image versions. - -### [Get-AzureRmImage](Get-AzureRmImage.md) -Gets the properties of an image. - -### [Get-AzureRmRemoteDesktopFile](Get-AzureRmRemoteDesktopFile.md) -Gets an .rdp file. - -### [Get-AzureRmSnapshot](Get-AzureRmSnapshot.md) -Gets the properties of a snapshot - -### [Get-AzureRmVM](Get-AzureRmVM.md) -Gets the properties of a virtual machine. - -### [Get-AzureRmVMAccessExtension](Get-AzureRmVMAccessExtension.md) -Gets information about the VMAccess extension. - -### [Get-AzureRmVMADDomainExtension](Get-AzureRmVMADDomainExtension.md) -Gets information about an AD domain extension. - -### [Get-AzureRmVMAEMExtension](Get-AzureRmVMAEMExtension.md) -Gets information about the AEM extension. - -### [Get-AzureRmVMBootDiagnosticsData](Get-AzureRmVMBootDiagnosticsData.md) -Gets boot diagnostics data for a virtual machine. - -### [Get-AzureRmVMChefExtension](Get-AzureRmVMChefExtension.md) -Gets information about a Chef extension. - -### [Get-AzureRmVMCustomScriptExtension](Get-AzureRmVMCustomScriptExtension.md) -Gets information about a custom script extension. - -### [Get-AzureRmVMDiagnosticsExtension](Get-AzureRmVMDiagnosticsExtension.md) -Gets the settings of the Diagnostics extension on a virtual machine. - -### [Get-AzureRmVMDiskEncryptionStatus](Get-AzureRmVMDiskEncryptionStatus.md) -Gets the encryption status of the virtual machine. - -### [Get-AzureRmVMDscExtension](Get-AzureRmVMDscExtension.md) -Gets the settings of the DSC extension on a particular virtual machine. - -### [Get-AzureRmVMDscExtensionStatus](Get-AzureRmVMDscExtensionStatus.md) -Gets the status of the DSC extension handler for a virtual machine. - -### [Get-AzureRmVMExtension](Get-AzureRmVMExtension.md) -Gets properties of Virtual Machine Extensions installed on a virtual machine. - -### [Get-AzureRmVMExtensionImage](Get-AzureRmVMExtensionImage.md) -Gets all versions for an Azure extension. - -### [Get-AzureRmVMExtensionImageType](Get-AzureRmVMExtensionImageType.md) -Gets the type of an Azure extension. - -### [Get-AzureRmVMImage](Get-AzureRmVMImage.md) -Gets all the versions of a VMImage. - -### [Get-AzureRmVMImageOffer](Get-AzureRmVMImageOffer.md) -Gets VMImage offer types. - -### [Get-AzureRmVMImagePublisher](Get-AzureRmVMImagePublisher.md) -Gets the VMImage publishers. - -### [Get-AzureRmVMImageSku](Get-AzureRmVMImageSku.md) -Gets VMImage SKUs. - -### [Get-AzureRmVMRunCommandDocument](Get-AzureRmVMRunCommandDocument.md) -Get run command document. - -### [Get-AzureRmVMSize](Get-AzureRmVMSize.md) -Gets available virtual machine sizes. - -### [Get-AzureRmVMSqlServerExtension](Get-AzureRmVMSqlServerExtension.md) -Gets the settings for a SQL Server extension on a virtual machine. - -### [Get-AzureRmVmss](Get-AzureRmVmss.md) -Gets the properties of a VMSS. - -### [Get-AzureRmVmssDiskEncryption](Get-AzureRmVmssDiskEncryption.md) -Shows the disk encryption status of a VM scale set. - -### [Get-AzureRmVmssRollingUpgrade](Get-AzureRmVmssRollingUpgrade.md) -Shows the status of the latest virtual machine scale set rolling upgrade. - -### [Get-AzureRmVmssSku](Get-AzureRmVmssSku.md) -Gets the available SKUs for the VMSS. - -### [Get-AzureRmVmssVM](Get-AzureRmVmssVM.md) -Gets the properties of a VMSS virtual machine. - -### [Get-AzureRmVmssVMDiskEncryption](Get-AzureRmVmssVMDiskEncryption.md) -Shows the disk encryption status of VMs in a VM scale set. - -### [Get-AzureRmVMUsage](Get-AzureRmVMUsage.md) -Gets the virtual machine core count usage for a location. - -### [Grant-AzureRmDiskAccess](Grant-AzureRmDiskAccess.md) -Grants an access to a disk. - -### [Grant-AzureRmSnapshotAccess](Grant-AzureRmSnapshotAccess.md) -Grants an access to a snapshot. - -### [Invoke-AzureRmVMRunCommand](Invoke-AzureRmVMRunCommand.md) -Run command on the VM. - -### [Invoke-AzureRmVmssVMRunCommand](Invoke-AzureRmVmssVMRunCommand.md) -Run command on the Virtual Machine Scale Set VM. - -### [New-AzureRmAvailabilitySet](New-AzureRmAvailabilitySet.md) -Creates an Azure availability set. - -### [New-AzureRmContainerService](New-AzureRmContainerService.md) -Creates a container service. - -### [New-AzureRmContainerServiceConfig](New-AzureRmContainerServiceConfig.md) -Creates a local configuration object for a container service. - -### [New-AzureRmDisk](New-AzureRmDisk.md) -Creates a managed disk. - -### [New-AzureRmDiskConfig](New-AzureRmDiskConfig.md) -Creates a configurable disk object. - -### [New-AzureRmDiskUpdateConfig](New-AzureRmDiskUpdateConfig.md) -Creates a configurable disk update object. - -### [New-AzureRmGallery](New-AzureRmGallery.md) -Create a gallery. - -### [New-AzureRmGalleryImageDefinition](New-AzureRmGalleryImageDefinition.md) -Create a gallery image definition. - -### [New-AzureRmGalleryImageVersion](New-AzureRmGalleryImageVersion.md) -Create a gallery image version. - -### [New-AzureRmImage](New-AzureRmImage.md) -Creates an image. - -### [New-AzureRmImageConfig](New-AzureRmImageConfig.md) -Creates a configurable image object. - -### [New-AzureRmSnapshot](New-AzureRmSnapshot.md) -Creates a snapshot. - -### [New-AzureRmSnapshotConfig](New-AzureRmSnapshotConfig.md) -Creates a configurable snapshot object. - -### [New-AzureRmSnapshotUpdateConfig](New-AzureRmSnapshotUpdateConfig.md) -Creates a configurable snapshot update object. - -### [New-AzureRmVM](New-AzureRmVM.md) -Creates a virtual machine. - -### [New-AzureRmVMConfig](New-AzureRmVMConfig.md) -Creates a configurable virtual machine object. - -### [New-AzureRmVMDataDisk](New-AzureRmVMDataDisk.md) -Creates a local data disk object for a virtual machine or a Vmss VM. - -### [New-AzureRmVMSqlServerAutoBackupConfig](New-AzureRmVMSqlServerAutoBackupConfig.md) -Creates a configuration object for SQL Server automatic backup. - -### [New-AzureRmVMSqlServerAutoPatchingConfig](New-AzureRmVMSqlServerAutoPatchingConfig.md) -Creates a configuration object for automatic patching on a virtual machine. - -### [New-AzureRmVMSqlServerKeyVaultCredentialConfig](New-AzureRmVMSqlServerKeyVaultCredentialConfig.md) -Creates a configuration object for SQL server key vault credential on a virtual machine. - -### [New-AzureRmVmss](New-AzureRmVmss.md) -Creates a VMSS. - -### [New-AzureRmVmssConfig](New-AzureRmVmssConfig.md) -Creates a VMSS configuration object. - -### [New-AzureRmVmssIpConfig](New-AzureRmVmssIpConfig.md) -Creates an IP configuration for a network interface of a VMSS. - -### [New-AzureRmVmssIpTagConfig](New-AzureRmVmssIpTagConfig.md) -Creates an IP Tag object for a network interface of a VMSS. - -### [New-AzureRmVmssVaultCertificateConfig](New-AzureRmVmssVaultCertificateConfig.md) -Creates a Key Vault certificate configuration. - -### [Publish-AzureRmVMDscConfiguration](Publish-AzureRmVMDscConfiguration.md) -Uploads a DSC script to Azure blob storage. - -### [Remove-AzureRmAvailabilitySet](Remove-AzureRmAvailabilitySet.md) -Removes an availability set from Azure. - -### [Remove-AzureRmContainerService](Remove-AzureRmContainerService.md) -Removes a container service. - -### [Remove-AzureRmContainerServiceAgentPoolProfile](Remove-AzureRmContainerServiceAgentPoolProfile.md) -Removes an agent pool profile from a container service. - -### [Remove-AzureRmDisk](Remove-AzureRmDisk.md) -Removes a disk. - -### [Remove-AzureRmGallery](Remove-AzureRmGallery.md) -Delete a gallery. - -### [Remove-AzureRmGalleryImageDefinition](Remove-AzureRmGalleryImageDefinition.md) -Delete a gallery image definition. - -### [Remove-AzureRmGalleryImageVersion](Remove-AzureRmGalleryImageVersion.md) -Delete a gallery image version. - -### [Remove-AzureRmImage](Remove-AzureRmImage.md) -Removes an image. - -### [Remove-AzureRmImageDataDisk](Remove-AzureRmImageDataDisk.md) -Removes a data disk from an image object. - -### [Remove-AzureRmSnapshot](Remove-AzureRmSnapshot.md) -Removes a snapshot. - -### [Remove-AzureRmVM](Remove-AzureRmVM.md) -Removes a virtual machine from Azure. - -### [Remove-AzureRmVMAccessExtension](Remove-AzureRmVMAccessExtension.md) -Removes the VMAccess extension from a virtual machine. - -### [Remove-AzureRmVMAEMExtension](Remove-AzureRmVMAEMExtension.md) -Removes the AEM extension from a virtual machine. - -### [Remove-AzureRmVMBackup](Remove-AzureRmVMBackup.md) -Removes the backup from a virtual machine. - -### [Remove-AzureRmVMChefExtension](Remove-AzureRmVMChefExtension.md) -Removes the Chef extension from a virtual machine. - -### [Remove-AzureRmVMCustomScriptExtension](Remove-AzureRmVMCustomScriptExtension.md) -Removes a custom script extension from a virtual machine. - -### [Remove-AzureRmVMDataDisk](Remove-AzureRmVMDataDisk.md) -Removes a data disk from a virtual machine. - -### [Remove-AzureRmVMDiagnosticsExtension](Remove-AzureRmVMDiagnosticsExtension.md) -Removes the Diagnostics extension from a virtual machine. - -### [Remove-AzureRmVMDiskEncryptionExtension](Remove-AzureRmVMDiskEncryptionExtension.md) -Removes the disk encryption extension from a virtual machine. - -### [Remove-AzureRmVMDscExtension](Remove-AzureRmVMDscExtension.md) -Removes a DSC extension handler from a virtual machine in a resource group. - -### [Remove-AzureRmVMExtension](Remove-AzureRmVMExtension.md) -Removes an extension from a virtual machine. - -### [Remove-AzureRmVMNetworkInterface](Remove-AzureRmVMNetworkInterface.md) -Removes a network interface from a virtual machine. - -### [Remove-AzureRmVMSecret](Remove-AzureRmVMSecret.md) -Removes (a) secret(s) from a virtual machine object - -### [Remove-AzureRmVMSqlServerExtension](Remove-AzureRmVMSqlServerExtension.md) -Removes a SQL Server extension from a virtual machine. - -### [Remove-AzureRmVmss](Remove-AzureRmVmss.md) -Removes the VMSS or a virtual machine that is within the VMSS. - -### [Remove-AzureRmVmssDataDisk](Remove-AzureRmVmssDataDisk.md) -Removes a data disk from the VMSS. - -### [Remove-AzureRmVmssDiagnosticsExtension](Remove-AzureRmVmssDiagnosticsExtension.md) -Removes a diagnostics extension from the VMSS. - -### [Remove-AzureRmVmssExtension](Remove-AzureRmVmssExtension.md) -Removes an extension from the VMSS. - -### [Remove-AzureRmVmssNetworkInterfaceConfiguration](Remove-AzureRmVmssNetworkInterfaceConfiguration.md) -Removes a network interface configuration from a VMSS. - -### [Remove-AzureRmVmssVMDataDisk](Remove-AzureRmVmssVMDataDisk.md) -Removes a data disk from a virtual machine scale set VM - -### [Repair-AzureRmVmssServiceFabricUpdateDomain](Repair-AzureRmVmssServiceFabricUpdateDomain.md) -Manual platform update domain walk to update virtual machines in a service fabric virtual machine scale set. - -### [Restart-AzureRmVM](Restart-AzureRmVM.md) -Restarts an Azure virtual machine. - -### [Restart-AzureRmVmss](Restart-AzureRmVmss.md) -Restarts the VMSS or a virtual machine within the VMSS. - -### [Revoke-AzureRmDiskAccess](Revoke-AzureRmDiskAccess.md) -Revokes an access to a disk. - -### [Revoke-AzureRmSnapshotAccess](Revoke-AzureRmSnapshotAccess.md) -Revokes an access to a snapshot. - -### [Save-AzureRmVhd](Save-AzureRmVhd.md) -Saves downloaded .vhd images locally. - -### [Save-AzureRmVMImage](Save-AzureRmVMImage.md) -Saves a virtual machine as a VMImage. - -### [Set-AzureRmDiskDiskEncryptionKey](Set-AzureRmDiskDiskEncryptionKey.md) -Sets the disk encryption key properties on a disk object. - -### [Set-AzureRmDiskImageReference](Set-AzureRmDiskImageReference.md) -Sets the image reference properties on a disk object. - -### [Set-AzureRmDiskKeyEncryptionKey](Set-AzureRmDiskKeyEncryptionKey.md) -Sets the key encryption key properties on a disk object. - -### [Set-AzureRmDiskUpdateDiskEncryptionKey](Set-AzureRmDiskUpdateDiskEncryptionKey.md) -Sets the disk encryption key properties on a disk update object. - -### [Set-AzureRmDiskUpdateKeyEncryptionKey](Set-AzureRmDiskUpdateKeyEncryptionKey.md) -Sets the key encryption key properties on a disk update object. - -### [Set-AzureRmImageOsDisk](Set-AzureRmImageOsDisk.md) -Sets the operating system disk properties on an image object. - -### [Set-AzureRmSnapshotDiskEncryptionKey](Set-AzureRmSnapshotDiskEncryptionKey.md) -Sets the disk encryption key properties on a snapshot object. - -### [Set-AzureRmSnapshotImageReference](Set-AzureRmSnapshotImageReference.md) -Sets the image reference properties on a snapshot object. - -### [Set-AzureRmSnapshotKeyEncryptionKey](Set-AzureRmSnapshotKeyEncryptionKey.md) -Sets the key encryption key properties on a snapshot object. - -### [Set-AzureRmSnapshotUpdateDiskEncryptionKey](Set-AzureRmSnapshotUpdateDiskEncryptionKey.md) -Sets the disk encryption key properties on a snapshot update object. - -### [Set-AzureRmSnapshotUpdateKeyEncryptionKey](Set-AzureRmSnapshotUpdateKeyEncryptionKey.md) -Sets the key encryption key properties on a snapshot update object. - -### [Set-AzureRmVM](Set-AzureRmVM.md) -Marks a virtual machine as generalized. - -### [Set-AzureRmVMAccessExtension](Set-AzureRmVMAccessExtension.md) -Adds the VMAccess extension to a virtual machine. - -### [Set-AzureRmVMADDomainExtension](Set-AzureRmVMADDomainExtension.md) -Adds an AD domain extension to a virtual machine. - -### [Set-AzureRmVMAEMExtension](Set-AzureRmVMAEMExtension.md) -Enables support for monitoring for SAP systems. - -### [Set-AzureRmVMBackupExtension](Set-AzureRmVMBackupExtension.md) -Sets the backup extension properties on a virtual machine. - -### [Set-AzureRmVMBginfoExtension](Set-AzureRmVMBginfoExtension.md) -Adds the BGInfo extension to a virtual machine. - -### [Set-AzureRmVMBootDiagnostics](Set-AzureRmVMBootDiagnostics.md) -Modifies boot diagnostics properties of a virtual machine. - -### [Set-AzureRmVMChefExtension](Set-AzureRmVMChefExtension.md) -Adds a Chef extension to a virtual machine. - -### [Set-AzureRmVMCustomScriptExtension](Set-AzureRmVMCustomScriptExtension.md) -Adds a custom script extension to a virtual machine. - -### [Set-AzureRmVMDataDisk](Set-AzureRmVMDataDisk.md) -Modifies properties of a virtual machine data disk. - -### [Set-AzureRmVMDiagnosticsExtension](Set-AzureRmVMDiagnosticsExtension.md) -Configures the Azure diagnostics extension on a virtual machine. - -### [Set-AzureRmVMDiskEncryptionExtension](Set-AzureRmVMDiskEncryptionExtension.md) -Enables encryption on a running IaaS virtual machine in Azure. - -### [Set-AzureRmVMDscExtension](Set-AzureRmVMDscExtension.md) -Configures the DSC extension on a virtual machine. - -### [Set-AzureRmVMExtension](Set-AzureRmVMExtension.md) -Updates extension properties or adds an extension to a virtual machine. - -### [Set-AzureRmVMOperatingSystem](Set-AzureRmVMOperatingSystem.md) -Sets operating system properties for a virtual machine. - -### [Set-AzureRmVMOSDisk](Set-AzureRmVMOSDisk.md) -Sets the operating system disk properties on a virtual machine. - -### [Set-AzureRmVMPlan](Set-AzureRmVMPlan.md) -Sets the Marketplace plan information on a virtual machine. - -### [Set-AzureRmVMSourceImage](Set-AzureRmVMSourceImage.md) -Specifies the image for a virtual machine. - -### [Set-AzureRmVMSqlServerExtension](Set-AzureRmVMSqlServerExtension.md) -Sets the Azure SQL Server extension on a virtual machine. - -### [Set-AzureRmVmss](Set-AzureRmVmss.md) -Sets specific actions on a specified VMSS. - -### [Set-AzureRmVmssBootDiagnostic](Set-AzureRmVmssBootDiagnostic.md) -Sets the virtual machine scale set boot diagnostics profile. - -### [Set-AzureRmVmssDiskEncryptionExtension](Set-AzureRmVmssDiskEncryptionExtension.md) -Enables disk encryption on a VM scale set. - -### [Set-AzureRmVmssOsProfile](Set-AzureRmVmssOsProfile.md) -Sets the VMSS operating system profile properties. - -### [Set-AzureRmVmssRollingUpgradePolicy](Set-AzureRmVmssRollingUpgradePolicy.md) -Sets the VMSS rolling upgrade policy properties. - -### [Set-AzureRmVmssStorageProfile](Set-AzureRmVmssStorageProfile.md) -Sets the storage profile properties for the VMSS. - -### [Set-AzureRmVmssVM](Set-AzureRmVmssVM.md) -Modifies the state of a VMSS instance. - -### [Start-AzureRmVM](Start-AzureRmVM.md) -Starts an Azure virtual machine. - -### [Start-AzureRmVmss](Start-AzureRmVmss.md) -Starts the VMSS or a set of virtual machines within the VMSS. - -### [Start-AzureRmVmssRollingOSUpgrade](Start-AzureRmVmssRollingOSUpgrade.md) -Starts a rolling upgrade to move all virtual machine scale set instances to the latest available Platform Image OS version. - -### [Stop-AzureRmVM](Stop-AzureRmVM.md) -Stops an Azure virtual machine. - -### [Stop-AzureRmVmss](Stop-AzureRmVmss.md) -Stops the VMSS or a set of virtual machines within the VMSS. - -### [Stop-AzureRmVmssRollingUpgrade](Stop-AzureRmVmssRollingUpgrade.md) -Cancels the current virtual machine scale set rolling upgrade. - -### [Test-AzureRmVMAEMExtension](Test-AzureRmVMAEMExtension.md) -Checks the configuration of the AEM extension. - -### [Update-AzureRmAvailabilitySet](Update-AzureRmAvailabilitySet.md) -Updates an availability set. - -### [Update-AzureRmContainerService](Update-AzureRmContainerService.md) -Updates the state of a container service. - -### [Update-AzureRmDisk](Update-AzureRmDisk.md) -Updates a disk. - -### [Update-AzureRmGallery](Update-AzureRmGallery.md) -Update a gallery. - -### [Update-AzureRmGalleryImageDefinition](Update-AzureRmGalleryImageDefinition.md) -Update a gallery image definition. - -### [Update-AzureRmGalleryImageVersion](Update-AzureRmGalleryImageVersion.md) -Update a gallery image version. - -### [Update-AzureRmImage](Update-AzureRmImage.md) -Updates an image. - -### [Update-AzureRmSnapshot](Update-AzureRmSnapshot.md) -Updates a snapshot. - -### [Update-AzureRmVM](Update-AzureRmVM.md) -Updates the state of an Azure virtual machine. - -### [Update-AzureRmVmss](Update-AzureRmVmss.md) -Updates the state of a VMSS. - -### [Update-AzureRmVmssInstance](Update-AzureRmVmssInstance.md) -Starts a manual upgrade of the VMSS instance. - -### [Update-AzureRmVmssVM](Update-AzureRmVmssVM.md) -Updates the state of a Vmss VM. - diff --git a/azurermps-6.13.0/AzureRM.Compute/ConvertTo-AzureRmVMManagedDisk.md b/azurermps-6.13.0/AzureRM.Compute/ConvertTo-AzureRmVMManagedDisk.md deleted file mode 100644 index 573c589784..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/ConvertTo-AzureRmVMManagedDisk.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/convertto-azurermvmmanageddisk -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/ConvertTo-AzureRmVMManagedDisk.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/ConvertTo-AzureRmVMManagedDisk.md ---- - -# ConvertTo-AzureRmVMManagedDisk - -## SYNOPSIS -Converts a virtual machine with blob-based disks to a virtual machine with managed disks. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -ConvertTo-AzureRmVMManagedDisk [-ResourceGroupName] <String> [-VMName] <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **ConvertTo-AzureRmVMManagedDisk** cmdlet converts a virtual machine with blob-based disks to a virtual machine with managed disks. -The virtual machine must be stop-deallocated before invoking this operation. - -## EXAMPLES - -### Example 1 -``` -PS C:\> ConvertTo-AzureRmVMManagedDisk -ResourceGroupName 'ResourceGroup01' -VMName 'VM01' -``` - -This command converts the blob-based disks of the virtual machine named 'VM01' in the resource group 'ResourceGroup01' to managed disks. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Disable-AzureRmVMDiskEncryption.md b/azurermps-6.13.0/AzureRM.Compute/Disable-AzureRmVMDiskEncryption.md deleted file mode 100644 index 3b8848dbd9..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Disable-AzureRmVMDiskEncryption.md +++ /dev/null @@ -1,268 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 979E956B-4C74-426E-A617-E50C4EBC8A20 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/disable-azurermvmdiskencryption -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Disable-AzureRmVMDiskEncryption.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Disable-AzureRmVMDiskEncryption.md ---- - -# Disable-AzureRmVMDiskEncryption - -## SYNOPSIS -Disables encryption on an IaaS virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Disable-AzureRmVMDiskEncryption [-ResourceGroupName] <String> [-VMName] <String> [[-VolumeType] <String>] - [[-Name] <String>] [[-TypeHandlerVersion] <String>] [-Force] [-DisableAutoUpgradeMinorVersion] - [-ExtensionType <String>] [-ExtensionPublisherName <String>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Disable-AzureRmVMDiskEncryption** cmdlet disables encryption on an infrastructure as a service (IaaS) virtual machine. -This cmdlet is only supported on Windows virtual machines and not Linux virtual machines. -This cmdlet installs an extension on the virtual machine to disable encryption. -If the *Name* parameter is not specified, an extension with the default name "AzureDiskEncryption for Windows VMs" is created. -Caution: This cmdlet reboots the virtual machine. - -## EXAMPLES - -### Example 1: Disable encryption for all volumes on a Windows virtual machine -``` -PS C:\> Disable-AzureRMVMDiskEncryption -ResourceGroupName "Group001" -VMName "VM002" -``` - -This command disables encryption for volumes of type all for the virtual machine named VM002 that belongs to the resource group named Group001. -Since the *VolumeType* parameter is not specified, the cmdlet sets the value to All. - -### Example 2: Disable encryption for data volumes on a Windows virtual machine -``` -PS C:\> $ResourceGroup = "Group002"; -PS C:\> $VMName = "VM004"; -PS C:\> Disable-AzureRMVMDiskEncryption -ResourceGroupName "Group002" -VMName "VM004" -VolumeType "Data" -``` - -This command disables encryption for volumes of type data for the virtual machine named VM004 that belongs to the resource group named Group002. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableAutoUpgradeMinorVersion -Indicates that this cmdlet disables auto-upgrade of the minor version of the extension. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExtensionPublisherName -The extension publisher name. Specify this parameter only to override the default value of "Microsoft.Azure.Security". - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExtensionType -The extension type. Specify this parameter to override its default value of "AzureDiskEncryption" for Windows VMs and "AzureDiskEncryptionForLinux" for Linux VMs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifes the name of the Azure Resource Manager (ARM) resource that represents the extension. -If this parameter is not specified, this cmdlet defaults to "AzureDiskEncryption for Windows VMs". - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group name of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TypeHandlerVersion -Specifies the version of the encryption extension. -If you do not specify a value for this parameter, the latest version of the extension is used. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: HandlerVersion, Version - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine that this cmdlet disables encryption on. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VolumeType -Specifies the type of virtual machine volumes to perform the encryption operation. -For Windows virtual machines, valid values are: -- All -- OS -- Data. -If you do not specify a value for this parameter, the default value is All. -Disable encryption is not currently supported for Linux. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: OS, Data, All - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMDiskEncryptionStatus](./Get-AzureRmVMDiskEncryptionStatus.md) - -[Remove-AzureRmVMDiskEncryptionExtension](./Remove-AzureRmVMDiskEncryptionExtension.md) - -[Set-AzureRmVMDiskEncryptionExtension](./Set-AzureRmVMDiskEncryptionExtension.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Disable-AzureRmVmssDiskEncryption.md b/azurermps-6.13.0/AzureRM.Compute/Disable-AzureRmVmssDiskEncryption.md deleted file mode 100644 index 2cb89b2b26..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Disable-AzureRmVmssDiskEncryption.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/disable-azurermvmssdiskencryption -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Disable-AzureRmVmssDiskEncryption.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Disable-AzureRmVmssDiskEncryption.md ---- - -# Disable-AzureRmVmssDiskEncryption - -## SYNOPSIS -Disables disk encryption on a VM scale set. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Disable-AzureRmVmssDiskEncryption [-ResourceGroupName] <String> [-VMScaleSetName] <String> - [[-ExtensionName] <String>] [-VolumeType <String>] [-ForceUpdate] [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Disables disk encryption on a VM scale set. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Disable-AzureRmVmssDiskEncryption -ResourceGroupName "Group001" -VMScaleSetName "VMSS001" -``` - -Disables disk encryption on the VM scale set named VMSS001 that belongs to the resource group named Group001. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionName -The extension name. -If this parameter is not specified, default values used are AzureDiskEncryption for windows VMs and AzureDiskEncryptionForLinux for Linux VMs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -To force the removal of the extension from the virtual machine. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceUpdate -Generate a tag for force update. This should be given to perform repeated encryption operations on the same VM. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMScaleSetName -The virtual machine name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VolumeType -Type of the volume (OS or Data) to perform encryption operation - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: OS, Data, All - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Export-AzureRmLogAnalyticRequestRateByInterval.md b/azurermps-6.13.0/AzureRM.Compute/Export-AzureRmLogAnalyticRequestRateByInterval.md deleted file mode 100644 index f97bb2b9ca..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Export-AzureRmLogAnalyticRequestRateByInterval.md +++ /dev/null @@ -1,238 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/export-azurermloganalyticrequestratebyinterval -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Export-AzureRmLogAnalyticRequestRateByInterval.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Export-AzureRmLogAnalyticRequestRateByInterval.md ---- - -# Export-AzureRmLogAnalyticRequestRateByInterval - -## SYNOPSIS -Export logs that show Api requests made by this subscription in the given time window to show throttling activities. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Export-AzureRmLogAnalyticRequestRateByInterval [-FromTime] <DateTime> [-GroupByOperationName] - [-IntervalLength] <IntervalInMins> [-GroupByThrottlePolicy] [-BlobContainerSasUri] <String> - [-GroupByResourceName] [-ToTime] <DateTime> [-Location] <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Exports statistical data about the subscription's calls to the Microsoft.Compute API by Success, Failure, or Throttled status, in predefined time intervals. The logs can be further grouped by three parameters: GroupByOperationName, GroupByThrottlePolicy, or GroupByResourceName. -Note that this cmdlet collects only Compute Resource Provider logs; moreover, data about the Disk and Snapshot resource types is not yet available. - -For an overview of the Compute Resource Provider's API throttling, see https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Export-AzureRmLogAnalyticRequestRateByInterval -Location 'West Central US' -FromTime '2018-02-20T17:54:14.8806951-08:00' -ToTime '2018-02-22T17:54:17.5832413-08:00' -BlobContainerSasUri 'https://wkuotest1.blob.core.windows.net/mylogs?someSasUri' -IntervalLength ThirtyMins -GroupByOperationName -``` - -This command stores the aggregated numbers of Microsoft.Compute API calls separated by Success, Failure, or Throttled between 2018-02-20T17:54:14 and 2018-02-22T17:54:17 in the given SAS URI, aggregated by operation name. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlobContainerSasUri -SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FromTime -From time of the query - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupByOperationName -Group query result by Operation Name. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupByResourceName -Group query result by Resource Name. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupByThrottlePolicy -Group query result by Throttle Policy applied. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IntervalLength -Interval value in minutes used to create LogAnalytics call rate logs. - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.IntervalInMins -Parameter Sets: (All) -Aliases: -Accepted values: ThreeMins, FiveMins, ThirtyMins, SixtyMins - -Required: True -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The location upon which log analytic is queried. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ToTime -To time of the query - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSLogAnalyticsOperationResult - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Export-AzureRmLogAnalyticThrottledRequests.md b/azurermps-6.13.0/AzureRM.Compute/Export-AzureRmLogAnalyticThrottledRequests.md deleted file mode 100644 index b6804fccc3..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Export-AzureRmLogAnalyticThrottledRequests.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/export-azurermloganalyticthrottledrequests -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Export-AzureRmLogAnalyticThrottledRequests.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Export-AzureRmLogAnalyticThrottledRequests.md ---- - -# Export-AzureRmLogAnalyticThrottledRequests - -## SYNOPSIS -Export logs that show total throttled Api requests for this subscription in the given time window. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Export-AzureRmLogAnalyticThrottledRequests [-GroupByOperationName] [-FromTime] <DateTime> - [-GroupByThrottlePolicy] [-BlobContainerSasUri] <String> [-GroupByResourceName] [-ToTime] <DateTime> - [-Location] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -This exports the total number of throttled Microsoft.Compute API calls. -The logs can be further aggregated by three options: GroupByOperationName, GroupByThrottlePolicy, or GroupByResourceName. -Note that this cmdlet collects only CRP logs. - -For an overview of the Compute Resource Provider's API throttling, see https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Export-AzureRmLogAnalyticThrottledRequests -Location 'West Central US' -FromTime '2018-02-20T17:54:14.8806951-08:00' -ToTime '2018-02-22T17:54:17.5832413-08:00' -BlobContainerSasUri 'https://wkuotest1.blob.core.windows.net/mylogs?someSasUri' -GroupByOperationName -``` - -This command stores the total throttled Microsoft.Compute API calls between 2018-02-20T17:54:14 and 2018-02-22T17:54:17 in the given SAS URI, aggregated by operation name. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlobContainerSasUri -SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FromTime -From time of the query - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupByOperationName -Group query result by Operation Name. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupByResourceName -Group query result by Resource Name. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupByThrottlePolicy -Group query result by Throttle Policy applied. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The location upon which log analytic is queried. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ToTime -To time of the query - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSLogAnalyticsOperationResult - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRMVMDiagnosticsExtension.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRMVMDiagnosticsExtension.md deleted file mode 100644 index a9bb9cd3e4..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRMVMDiagnosticsExtension.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: D5BEA683-44AE-4D71-827D-02A03F0BEAE9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmdiagnosticsextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRMVMDiagnosticsExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRMVMDiagnosticsExtension.md ---- - -# Get-AzureRmVMDiagnosticsExtension - -## SYNOPSIS -Gets the settings of the Diagnostics extension on a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVMDiagnosticsExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] [-Status] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMDiagnosticsExtension** cmdlet gets the settings of the Azure Diagnostics extension on a virtual machine. - -## EXAMPLES - -### Example 1: Get the diagnostics extension applied to a virtual machine -``` -PS C:\> Get-AzureRmVMDiagnosticsExtension -ResourceGroupName "ResourceGroup11" -VMName "ContosoVM22" -``` - -This command gets the diagnostics extension applied to the virtual machine named ContosoVM22. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Diagnostics extension for which this cmdlet gets settings. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Status -Indicates that this cmdlet uses the Status value. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine from which this cmdlet gets the Diagnostics extension. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineExtension - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmVMDiagnosticsExtension](./Remove-AzureRmVMDiagnosticsExtension.md) - -[Set-AzureRmVMDiagnosticsExtension](./Set-AzureRMVMDiagnosticsExtension.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRMVMSqlServerExtension.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRMVMSqlServerExtension.md deleted file mode 100644 index 7ce1f14fc9..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRMVMSqlServerExtension.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: CAA3E6A9-7E1A-4D57-A269-0B2D3D9C3BEC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmsqlserverextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRMVMSqlServerExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRMVMSqlServerExtension.md ---- - -# Get-AzureRmVMSqlServerExtension - -## SYNOPSIS -Gets the settings for a SQL Server extension on a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVMSqlServerExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMSqlServerExtension** cmdlet gets the settings of the SQL Server infrastructure as a service (IaaS) Agent on a virtual machine. - -## EXAMPLES - -### Example 1: Get the settings of a SQL Server extension on a virtual machine -``` -PS C:\> Get-AzureRmVMSqlServerExtension -ResourceGroupName "ResourceGroup11" -VMName "ContosoVM07" -ExtensionName : SqlIaaSAgent -Publisher : Microsoft.SqlServer.Management -Version : 1.0 -State : Enable -RoleName : VMName -AutoPatchingSettings : Microsoft.WindowsAzure.Commands.ServiceManagement.IaaS.Extensions.AutoPatchingSettings -AutoBackupSettings : Microsoft.WindowsAzure.Commands.ServiceManagement.IaaS.Extensions.AutoBackupSettings -``` - -This command gets the settings of the SQL Server extension on a virtual machine named ContosoVM07. - -### Example 2: Get the settings by using the pipeline -``` -PS C:\> Get-AzureRmVM -ServiceName "Service08" -Name "ContosoVM22" | Get-AzureRmVMSqlServerExtension -ExtensionName : SqlIaaSAgent -Publisher : Microsoft.SqlServer.Management -Version : 1.0 -State : Enable -RoleName : VMName -AutoPatchingSettings : Microsoft.WindowsAzure.Commands.ServiceManagement.IaaS.Extensions.AutoPatchingSettings -AutoBackupSettings : Microsoft.WindowsAzure.Commands.ServiceManagement.IaaS.Extensions.AutoBackupSettings -``` - -This command gets the virtual machine named ContosoVM22 on the service Service08 by using the Get-AzureRmVM cmdlet. -The command passes the results to the current cmdlet by using the pipeline operator. -The current command gets the settings of the SQL Server IaaS Agent on that virtual machine. - -### Example 3: Get the settings of specific SQL Server version -``` -PS C:\> Get-AzureRmVMSqlServerExtension -ResourceGroupName "ResourceGroup11" -VMName "ContosoVM07" -Version "1.0" -ExtensionName : SqlIaaSAgent -Publisher : Microsoft.SqlServer.Management -Version : 1.0 -State : Enable -RoleName : VMName -AutoPatchingSettings : Microsoft.WindowsAzure.Commands.ServiceManagement.IaaS.Extensions.AutoPatchingSettings -AutoBackupSettings : Microsoft.WindowsAzure.Commands.ServiceManagement.IaaS.Extensions.AutoBackupSettings -``` - -This command gets the settings of version 1.0 of the SQL Server extension on a virtual machine named ContosoVM07. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the SQL Server the extension. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.VirtualMachineSqlServerExtensionContext - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - -[Remove-AzureRmVMSqlServerExtension](./Remove-AzureRMVMSqlServerExtension.md) - -[Set-AzureRmVMSqlServerExtension](./Set-AzureRMVMSqlServerExtension.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmAvailabilitySet.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmAvailabilitySet.md deleted file mode 100644 index 02002f3e57..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmAvailabilitySet.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 45D55DC9-0027-4EB9-B2F7-9ABF6685E6B5 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermavailabilityset -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmAvailabilitySet.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmAvailabilitySet.md ---- - -# Get-AzureRmAvailabilitySet - -## SYNOPSIS -Gets Azure availability sets in a resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmAvailabilitySet [[-ResourceGroupName] <String>] [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmAvailabilitySet** cmdlet gets Azure availability sets in a resource group. -You can specify the name of a specific availability set to get. - -## EXAMPLES - -### Example 1: Get a specific availability set -``` -PS C:\> Get-AzureRmAvailabilitySet -ResourceGroupName "ResourceGroup11" -Name "AvailabilitySet03" -``` - -This command gets the availability set named AvailablitySet03 in the resource group named ResourceGroup11. - -### Example 2: Get all availability sets -``` -PS C:\> Get-AzureRmAvailabilitySet -ResourceGroupName "ResourceGroup11" -``` - -This command gets all the availability sets in the resource group named ResourceGroup11. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of an availability set that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName, AvailabilitySetName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAvailabilitySet - -## NOTES - -## RELATED LINKS - -[New-AzureRmAvailabilitySet](./New-AzureRmAvailabilitySet.md) - -[Remove-AzureRmAvailabilitySet](./Remove-AzureRmAvailabilitySet.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmComputeResourceSku.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmComputeResourceSku.md deleted file mode 100644 index ef48a8b7ce..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmComputeResourceSku.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermcomputeresourcesku -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmComputeResourceSku.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmComputeResourceSku.md ---- - -# Get-AzureRmComputeResourceSku - -## SYNOPSIS -List all compute resource Skus - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmComputeResourceSku [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -List all compute resource Skus - -## EXAMPLES - -### Example 1 -``` -PS C:\> PS C:\> Get-AzureRmComputeResourceSku | where {$_.Locations.Contains("westus")}; -``` - -List all compute resource skus in West US region - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSResourceSku - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmContainerService.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmContainerService.md deleted file mode 100644 index cb712b2359..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmContainerService.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: AFF75E0B-CB88-45ED-9067-7F43E2BA485C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermcontainerservice -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmContainerService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmContainerService.md ---- - -# Get-AzureRmContainerService - -## SYNOPSIS -Gets a container service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmContainerService [[-ResourceGroupName] <String>] [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmContainerService** cmdlet gets a container service. -You can view the properties of a container service, which include state, number of master and agents, and fully qualified domain name of master and agent. - -## EXAMPLES - -### Example 1: Get a container service -``` -PS C:\> Get-AzureRmContainerService -ResourceGroupName "ResourceGroup17" -Name "CSResourceGroup17" -``` - -This command gets a container service named CSResourceGroup17. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the container service that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group of the container service that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSContainerService - -## NOTES - -## RELATED LINKS - -[New-AzureRmContainerService](./New-AzureRmContainerService.md) - -[Remove-AzureRmContainerService](./Remove-AzureRmContainerService.md) - -[Update-AzureRmContainerService](./Update-AzureRmContainerService.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmDisk.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmDisk.md deleted file mode 100644 index 6ca31b2444..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmDisk.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermdisk -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmDisk.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmDisk.md ---- - -# Get-AzureRmDisk - -## SYNOPSIS -Gets the properties of a Managed disk. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmDisk [[-ResourceGroupName] <String>] [[-DiskName] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDisk** cmdlet gets the properties of a Managed disk. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -``` - -This command gets the properties of the disk named 'Disk01' in the resource group 'ResourceGroup01'. - -### Example 2 -``` -PS C:\> Get-AzureRmDisk -ResourceGroupName 'ResourceGroup01' -``` - -This command gets the properties of all disks in the resource group 'ResourceGroup01'. - -### Example 3 -``` -PS C:\> Get-AzureRmDisk -``` - -This command gets the properties of all disks under the subscription. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskName -Specifies the name of a disk. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmGallery.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmGallery.md deleted file mode 100644 index 3eacabe0ac..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmGallery.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermgallery -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmGallery.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmGallery.md ---- - -# Get-AzureRmGallery - -## SYNOPSIS -Get or list galleries. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameter (Default) -``` -Get-AzureRmGallery [[-ResourceGroupName] <String>] [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceIdParameter -``` -Get-AzureRmGallery [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Get or list galleries. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmGallery -ResourceGroupName $rgname -GalleryName $galleryName - -ResourceGroupName : rg1 -Description : Gallery created by Powershell. -Identifier : - UniqueName : 00000000-0000-0000-0000-000000000000-gallery1 -ProvisioningState : Succeeded -Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/galleries/gallery1 -Name : gallery1 -Type : Microsoft.Compute/galleries -Location : southcentralus -Tags : {} -``` - -Get the gallery. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the gallery. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: GalleryName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The resource id for Gallery - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameter -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSGallery - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSGallery - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmGalleryImageDefinition.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmGalleryImageDefinition.md deleted file mode 100644 index 59b6f723c6..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmGalleryImageDefinition.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermgalleryimagedefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmGalleryImageDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmGalleryImageDefinition.md ---- - -# Get-AzureRmGalleryImageDefinition - -## SYNOPSIS -Get or list gallery image definitions. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameter (Default) -``` -Get-AzureRmGalleryImageDefinition [-ResourceGroupName] <String> [-GalleryName] <String> [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceIdParameter -``` -Get-AzureRmGalleryImageDefinition [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -Get or list gallery image definitions. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmGalleryImageDefinition -ResourceGroupName $rgname -GalleryName $gallery -GalleryImageDefinitionName $image -``` - -Get the gallery image definition. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GalleryName -The name of the gallery. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The name of the gallery image definition. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: GalleryImageDefinitionName - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The resource ID for the gallery image definition - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameter -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSGalleryImage - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmGalleryImageVersion.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmGalleryImageVersion.md deleted file mode 100644 index ddeb15429c..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmGalleryImageVersion.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermgalleryimageversion -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmGalleryImageVersion.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmGalleryImageVersion.md ---- - -# Get-AzureRmGalleryImageVersion - -## SYNOPSIS -Get or list gallery image versions. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameter (Default) -``` -Get-AzureRmGalleryImageVersion [-ResourceGroupName] <String> [-GalleryName] <String> - [-GalleryImageDefinitionName] <String> [[-Name] <String>] [-ExpandReplicationStatus] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceIdParameter -``` -Get-AzureRmGalleryImageVersion [-ResourceId] <String> [-ExpandReplicationStatus] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Get or list gallery image versions. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmGalleryImageVersion -ResourceGroupName $rgname -GalleryName $gallery -ImageDefinitionName $image -GalleryImageVersionName $version -``` - -Get the gallery image version. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpandReplicationStatus -Show replication status. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GalleryImageDefinitionName -The name of the gallery image definition. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GalleryName -The name of the gallery. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The name of the gallery image version. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: GalleryImageVersionName - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The resource ID for the gallery image version - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameter -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSGalleryImageVersion - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSGalleryImageVersion - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmImage.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmImage.md deleted file mode 100644 index 08a3a8e373..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmImage.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermimage -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmImage.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmImage.md ---- - -# Get-AzureRmImage - -## SYNOPSIS -Gets the properties of an image. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmImage [[-ResourceGroupName] <String>] [[-ImageName] <String>] [[-Expand] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmImage** cmdlet gets the properties of an image. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmImage -ResourceGroupName 'ResourceGroup01' -ImageName 'Image01' -``` - -This command gets the properties of the image named 'Image01' in the resource group 'ResourceGroup01'. - -### Example 2 -``` -PS C:\> Get-AzureRmImage -ResourceGroupName 'ResourceGroup01' -``` - -This command gets the properties of all images in the resource group 'ResourceGroup01'. - -### Example 3 -``` -PS C:\> Get-AzureRmImage -``` - -This command gets the properties of all images under the subscription. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expand -Specifies the expand expression query. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ImageName -Specifies the name of an image. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSImage - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmRemoteDesktopFile.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmRemoteDesktopFile.md deleted file mode 100644 index bed999ef14..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmRemoteDesktopFile.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: E2A56E55-30A3-4A2F-80AE-9D166840909E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermremotedesktopfile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmRemoteDesktopFile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmRemoteDesktopFile.md ---- - -# Get-AzureRmRemoteDesktopFile - -## SYNOPSIS -Gets an .rdp file. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Download -``` -Get-AzureRmRemoteDesktopFile [-ResourceGroupName] <String> [-Name] <String> [-LocalPath] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### Launch -``` -Get-AzureRmRemoteDesktopFile [-ResourceGroupName] <String> [-Name] <String> [[-LocalPath] <String>] [-Launch] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRemoteDesktopFile** cmdlet gets a Remote Desktop Protocol (.rdp) file. - -## EXAMPLES - -### Example 1: Get a Remote Desktop file -``` -PS C:\> Get-AzureRmRemoteDesktopFile -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -LocalPath "D:\RemoteDesktopFile07.rdp" -``` - -This command gets the Remote Desktop file for the virtual machine named VirtualMachine07. -The command stores the result in the file named D:\RemoteDesktopFile07.rdp. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Launch -Indicates that this cmdlet launches Remote Desktop after it gets the .rdp file. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Launch -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalPath -Specifies the local full path where this cmdlet stores the .rdp file. - -```yaml -Type: System.String -Parameter Sets: Download -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: Launch -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the availability set that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName, VMName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmSnapshot.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmSnapshot.md deleted file mode 100644 index 6e6941dea5..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmSnapshot.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermsnapshot -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmSnapshot.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmSnapshot.md ---- - -# Get-AzureRmSnapshot - -## SYNOPSIS -Gets the properties of a snapshot - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSnapshot [[-ResourceGroupName] <String>] [[-SnapshotName] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSnapshot** cmdlet gets the properties of a snapshot. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmSnapshot -``` - -This command gets the properties of all snapshots of the subscription. - -### Example 2 -``` -PS C:\> Get-AzureRmSnapshot -ResourceGroupName "ResourceGroupName1" -``` - -This command gets the properties of all snapshots in the resource group named "ResourceGroupName1" - -### Example 3 -``` -PS C:\> Get-AzureRmSnapshot -ResourceGroupName "ResourceGroupName1" -SnapshotName "SnapshotName1" -``` - -This command gets the properties of the snapshot named "SnapshotName1" in the resource group named "ResourceGroupName1" - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SnapshotName -Specifies the name of a snapshot. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVM.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVM.md deleted file mode 100644 index fedcb74e44..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVM.md +++ /dev/null @@ -1,236 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 6250EC11-79CF-428B-A72F-9BD72C1751F0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvm -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVM.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVM.md ---- - -# Get-AzureRmVM - -## SYNOPSIS -Gets the properties of a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ListAllVirtualMachinesParamSet (Default) -``` -Get-AzureRmVM [-Status] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ListVirtualMachineInResourceGroupParamSet -``` -Get-AzureRmVM [-ResourceGroupName] <String> [-Status] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### GetVirtualMachineInResourceGroupParamSet -``` -Get-AzureRmVM [-ResourceGroupName] <String> [-Name] <String> [-Status] [-DisplayHint <DisplayHintType>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ListLocationVirtualMachinesParamSet -``` -Get-AzureRmVM -Location <String> [-Status] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ListNextLinkVirtualMachinesParamSet -``` -Get-AzureRmVM [-Status] [-NextLink] <Uri> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVM** cmdlet gets the model view and instance view of an Azure virtual machine. -The model view is the user specified properties of the virtual machine. -The instance view is the instance level status of the virtual machine. -Specify the *Status* parameter to get only the instance view of a virtual machine. - -## EXAMPLES - -### Example 1: Get model and instance view properties -``` -PS C:\> Get-AzureRmVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -``` - -This command gets the model view and instance view properties of the virtual machine named VirtualMachine07. - -### Example 2: Get instance view properties -``` -PS C:\> Get-AzureRmVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -Status -``` - -This command gets properties of the virtual machine named VirtualMachine07. -This command specifies the *Status* parameter. -Therefore, the command gets only the instance view properties. - -### Example 3: Get properties for all virtual machines in a resource group -``` -PS C:\> Get-AzureRmVM -ResourceGroupName "ResourceGroup11" -``` - -This command gets properties for all the virtual machines in the resource group named ResourceGroup11. - -### Example 4: Get all virtual machines in your subscription -``` -PS C:\> Get-AzureRmVM -``` - -This command gets all the virtual machines in your subscription. - -### Example 5: Get all virtual machines in the location. -``` -PS C:\> Get-AzureRmVM -Location "westus" -``` - -This command gets all the virtual machines in West US region. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayHint -Determines how the virtual machine object is displayed. -Valid values are: --- Compact: displays only top level properties --- Expand: displays all properties in all levels - -```yaml -Type: Microsoft.Azure.Commands.Compute.Models.DisplayHintType -Parameter Sets: GetVirtualMachineInResourceGroupParamSet -Aliases: -Accepted values: Compact, Expand - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies a location for the virtual machines to list. - -```yaml -Type: System.String -Parameter Sets: ListLocationVirtualMachinesParamSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual machine to get. - -```yaml -Type: System.String -Parameter Sets: GetVirtualMachineInResourceGroupParamSet -Aliases: ResourceName, VMName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NextLink -Specifies the next link. - -```yaml -Type: System.Uri -Parameter Sets: ListNextLinkVirtualMachinesParamSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: ListVirtualMachineInResourceGroupParamSet, GetVirtualMachineInResourceGroupParamSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Status -Indicates that this cmdlet gets only the instance view of the virtual machine. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Uri - -### Microsoft.Azure.Commands.Compute.Models.DisplayHintType - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineInstanceView - -## NOTES - -## RELATED LINKS - -[New-AzureRmVM](./New-AzureRmVM.md) - -[Remove-AzureRmVM](./Remove-AzureRmVM.md) - -[Restart-AzureRmVM](./Restart-AzureRmVM.md) - -[Start-AzureRmVM](./Start-AzureRmVM.md) - -[Stop-AzureRmVM](./Stop-AzureRmVM.md) - -[Update-AzureRmVM](./Update-AzureRmVM.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMADDomainExtension.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMADDomainExtension.md deleted file mode 100644 index bbdcf15708..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMADDomainExtension.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 49D17667-35C3-4A79-A0C8-C197DAA5CD90 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmaddomainextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMADDomainExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMADDomainExtension.md ---- - -# Get-AzureRmVMADDomainExtension - -## SYNOPSIS -Gets information about an AD domain extension. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVMADDomainExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name] <String> [-Status] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMADDomainExtension** cmdlet gets information about the specified Microsoft Entra domain extension. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the domain extension. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Status -Indicates that this cmdlet gets the instance view of the domain extension. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.VirtualMachineADDomainExtensionContext - -## NOTES - -## RELATED LINKS - -[Set-AzureRmVMADDomainExtension](./Set-AzureRmVMADDomainExtension.md) diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMAEMExtension.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMAEMExtension.md deleted file mode 100644 index 6d1359f77c..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMAEMExtension.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 212281F0-9A3E-4652-919F-400455E3950E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmaemextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMAEMExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMAEMExtension.md ---- - -# Get-AzureRmVMAEMExtension - -## SYNOPSIS -Gets information about the AEM extension. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVMAEMExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] [-Status] - [[-OSType] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMAEMExtension** cmdlet gets information about the Azure Enhanced Monitoring (AEM) extension. - -## EXAMPLES - -### Example 1: Get the AEM extension -``` -PS C:\> Get-AzureRmVMAEMExtension -ResourceGroupName "ResourceGroup11" -VMName "contoso-server" -``` - -This command gets information for the AEM extension for the virtual machine named contoso-server. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a virtual machine. -This cmdlet gets information for the AEM extension on the virtual machine that this cmdlet specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OSType -Specifies the type of the operating system of the operating system disk. -If the operating system disk does not have a type, you must specify this parameter. -The acceptable values for this parameter are: Windows and Linux. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of a virtual machine. -This cmdlet gets information for the AEM extension on that virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Status -Indicates that this cmdlet gets only the instance view of the AEM extension. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine. -This cmdlet gets information about AEM extension for the virtual machine that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineExtension - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmVMAEMExtension](./Remove-AzureRmVMAEMExtension.md) - -[Set-AzureRmVMAEMExtension](./Set-AzureRmVMAEMExtension.md) - -[Test-AzureRmVMAEMExtension](./Test-AzureRmVMAEMExtension.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMAccessExtension.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMAccessExtension.md deleted file mode 100644 index 7670c0fb5d..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMAccessExtension.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 32CF9DA7-5607-4CF9-A2D0-D76A0C005FDA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmaccessextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMAccessExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMAccessExtension.md ---- - -# Get-AzureRmVMAccessExtension - -## SYNOPSIS -Gets information about the VMAccess extension. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVMAccessExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name] <String> [-Status] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMAccessExtension** cmdlet gets information about the Virtual Machine Access (VMAccess) Virtual Machine Extension. - -## EXAMPLES - -### Example 1: Get the VMAccess extension -``` -PS C:\> $VMAccessExtension = Get-AzureRmVMAccessExtension -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine07" -Name "ContosoTest" -``` - -This command gets the VMAccess extension named ContosoTest for the virtual machine named VirtualMachine07. - -### Example 2: Get the instance view of the VMAccess extension -``` -PS C:\> $VMAccessExtension = Get-AzureRmVMAccessExtension -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine07" -Name "ContosoTest" -Status -``` - -This command gets the instance view of the VMAccess extension named ContosoTest for the virtual machine named VirtualMachine07. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the extension that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Status -Indicates that this cmdlet gets only the instance view of the extension. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine. -This cmdlet gets information about VMAccess for the virtual machine that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.VirtualMachineAccessExtensionContext - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmVMAccessExtension](./Remove-AzureRmVMAccessExtension.md) - -[Set-AzureRmVMAccessExtension](./Set-AzureRmVMAccessExtension.md) - -[Get-AzureRmVMExtension](./Get-AzureRmVMExtension.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMBootDiagnosticsData.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMBootDiagnosticsData.md deleted file mode 100644 index c90833be0d..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMBootDiagnosticsData.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 15CAC050-F2E9-4872-88E7-516A6D194FAB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmbootdiagnosticsdata -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMBootDiagnosticsData.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMBootDiagnosticsData.md ---- - -# Get-AzureRmVMBootDiagnosticsData - -## SYNOPSIS -Gets boot diagnostics data for a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### WindowsParamSet (Default) -``` -Get-AzureRmVMBootDiagnosticsData [-ResourceGroupName] <String> [-Name] <String> [-Windows] - [-LocalPath] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### LinuxParamSet -``` -Get-AzureRmVMBootDiagnosticsData [-ResourceGroupName] <String> [-Name] <String> [-Linux] - [[-LocalPath] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMBootDiagnosticsData** cmdlet gets boot diagnostics data for a virtual machine. - -## EXAMPLES - -### Example 1: Get boot diagnostics data -``` -PS C:\> Get-AzureRmVMBootDiagnosticsData -ResourceGroupName "ResourceGroup11" -Name "ContosoVM07" -Windows -LocalPath "C:\Contoso\BootDiagnostics" -``` - -This command gets boot diagnostics data for the virtual machine named ContosoVM07. -This virtual machine runs the Windows operating system. -The command stores the data in specified local path. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Linux -Indicates that the virtual machine runs the Linux operating system. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: LinuxParamSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalPath -Specifies the local path for the boot diagnostics data. - -```yaml -Type: System.String -Parameter Sets: WindowsParamSet -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: LinuxParamSet -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual machine for which this cmdlet gets diagnostics data. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName, VMName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Windows -Indicates that the virtual machine runs the Windows operating system. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: WindowsParamSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineInstanceView - -## NOTES - -## RELATED LINKS - -[Set-AzureRmVMBootDiagnostics](./Set-AzureRmVMBootDiagnostics.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMChefExtension.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMChefExtension.md deleted file mode 100644 index 6cc2437a8d..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMChefExtension.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: F41953F1-9515-4081-8624-6A1494DA4BB2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmchefextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMChefExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMChefExtension.md ---- - -# Get-AzureRmVMChefExtension - -## SYNOPSIS -Gets information about a Chef extension. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Linux -``` -Get-AzureRmVMChefExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] [-Status] - [-Linux] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### Windows -``` -Get-AzureRmVMChefExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] [-Status] - [-Windows] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureVMChefExtension** cmdlet gets information about a Chef extension installed on a virtual machine. - -## EXAMPLES - -### Example 1: Get the details of Chef extension for a Windows virtual machine -``` -PS C:\> Get-AzureRmVMChefExtension -ResourceGroupName "ResourceGroup001" -VMName "WindowsVM001" -Windows -``` - -This command gets the Chef extension from a Windows virtual machine named WindowsVM001 that belongs to the resource group named ResourceGroup001. - -### Example 2: Get the details of Chef extension for a Linux virtual machine -``` -PS C:\> Get-AzureRmVMChefExtension -ResourceGroupName "ResourceGroup002" -VMName "LinuxVM001" -Linux -``` - -This command gets the Chef extension from a Linux virtual machine named LinuxVM001 that belongs to the resource group named ResourceGroup002. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Linux -Indicates that this cmdlet works on a Linux virtual machine. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Linux -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Chef extension. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Status -Indicates that this cmdlet gets only the instance view of the Chef extension. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Windows -Indicates that this cmdlet is for a Windows virtual machine. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Windows -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineExtension - -## NOTES - -## RELATED LINKS - -[Set-AzureRmVMChefExtension](./Set-AzureRmVMChefExtension.md) - -[Remove-AzureRmVMChefExtension](./Remove-AzureRmVMChefExtension.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMCustomScriptExtension.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMCustomScriptExtension.md deleted file mode 100644 index 21df13b94b..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMCustomScriptExtension.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 1017A74D-6420-4E51-A4A4-1AD3AD6D8122 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmcustomscriptextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMCustomScriptExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMCustomScriptExtension.md ---- - -# Get-AzureRmVMCustomScriptExtension - -## SYNOPSIS -Gets information about a custom script extension. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVMCustomScriptExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name] <String> [-Status] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMCustomScriptExtension** cmdlet gets information about a custom script Virtual Machine Extension on a virtual machine. - -## EXAMPLES - -### Example 1: Get a custom script extension -``` -PS C:\> $VMCustomScriptExtension = Get-AzureRmVMCustomScriptExtension -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine07" -Name "ContosoCustomScript" -``` - -This command gets the custom script extension named ContosoCustomScript for the virtual machine named VirtualMachine07. - -### Example 2: Get the instance view of a custom script extension -``` -PS C:\> $VMCustomScriptExtension = Get-AzureRmVMCustomScriptExtension -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine07" -Name "ContosoCustomScript" -Status -``` - -This command gets the instance view of the custom script extension named ContosoCustomScript for the virtual machine named VirtualMachine07. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the custom script extension about which this cmdlet gets information. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Status -Indicates that this cmdlet gets the instance view of the custom script extension. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine for which this cmdlet gets the custom script extension. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.VirtualMachineCustomScriptExtensionContext - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMAccessExtension](./Get-AzureRmVMAccessExtension.md) - -[Get-AzureRmVMExtension](./Get-AzureRmVMExtension.md) - -[Get-AzureRmVMExtensionImage](./Get-AzureRmVMExtensionImage.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMDiskEncryptionStatus.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMDiskEncryptionStatus.md deleted file mode 100644 index c33e63b6c8..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMDiskEncryptionStatus.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: E6F91D2E-6481-44C2-AF21-F62947C3D78C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmdiskencryptionstatus -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMDiskEncryptionStatus.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMDiskEncryptionStatus.md ---- - -# Get-AzureRmVMDiskEncryptionStatus - -## SYNOPSIS -Gets the encryption status of the virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVMDiskEncryptionStatus [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] - [-ExtensionType <String>] [-ExtensionPublisherName <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMDiskEncryptionStatus** cmdlet gets the encryption status of the virtual machine. -It displays the encryption status of the operating system and data volumes. -In addition to encryption status, it also displays the encryption secret URL, key encryption key URL, resource IDs of the **KeyVaults** where the encryption key and key encryption key for operating system volume are present. - -## EXAMPLES - -### Example 1: Get the encryption status of a virtual machine -``` -PS C:\> Get-AzureRmVmDiskEncryptionStatus -ResourceGroupName "MyResourceGroup001" -VMName "VM001" -``` - -This command gets the encryption status of the virtual machine named VM001. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionPublisherName -The extension publisher name. Specify this parameter only to override the default value of "Microsoft.Azure.Security". - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExtensionType -The extension type. Specify this parameter to override its default value of "AzureDiskEncryption" for Windows VMs and "AzureDiskEncryptionForLinux" for Linux VMs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Extension.AzureDiskEncryption.AzureDiskEncryptionExtensionContext - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmVMDiskEncryptionExtension](./Remove-AzureRmVMDiskEncryptionExtension.md) - -[Set-AzureRmVMDiskEncryptionExtension](./Set-AzureRmVMDiskEncryptionExtension.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMDscExtension.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMDscExtension.md deleted file mode 100644 index 5fe5a0a1a4..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMDscExtension.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 5B7A1BE6-F5F5-4968-BE32-7743D0E25FE3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmdscextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMDscExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMDscExtension.md ---- - -# Get-AzureRmVMDscExtension - -## SYNOPSIS -Gets the settings of the DSC extension on a particular virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVMDscExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] [-Status] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMDscExtension** cmdlet gets the settings of the Desired State Configuration (DSC) extension on a particular virtual machine. - -## EXAMPLES - -### Example 1: Get the settings of a DSC extension -``` -PS C:\> Get-AzureRmVMDscExtension -ResourceGroupName "ResourceGroup002" -VMName "VM07" -Name "DSC" -``` - -This command gets the settings of extension named DSC on the virtual machine named VM07. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Azure Resource Manager resource that represents the extension. -The Set-AzureRmVMDscExtension cmdlet sets this name to Microsoft.Powershell.DSC, which is the same value that is used by **Get-AzureRmVMDscExtension**. -Specify this parameter only if you changed the default name in the **Set-AzureRmVMDscExtension** cmdlet or used a different resource name in a Resource Manager template. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Status -Indicates that this cmdlet gets the instance view of the DSC extension. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine for which this cmdlet gets the DSC extension. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Extension.DSC.VirtualMachineDscExtensionContext - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmVMDscExtension](./Remove-AzureRmVMDscExtension.md) - -[Set-AzureRmVMDscExtension](./Set-AzureRmVMDscExtension.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMDscExtensionStatus.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMDscExtensionStatus.md deleted file mode 100644 index 3aaa76d8d9..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMDscExtensionStatus.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 695F224D-DA25-49F2-916E-25DA2A48A4A7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmdscextensionstatus -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMDscExtensionStatus.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMDscExtensionStatus.md ---- - -# Get-AzureRmVMDscExtensionStatus - -## SYNOPSIS -Gets the status of the DSC extension handler for a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVMDscExtensionStatus [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMDscExtensionStatus** cmdlet gets the status of the Desired State Configuration (DSC) extension handler for a virtual machine in a resource group. -When a configuration is applied this cmdlet produces output consistent with the Start-DscConfiguration cmdlet. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Azure Resource Manager resource that represents the extension. -The Set-AzureRmVMDscExtension cmdlet sets this name to Microsoft.Powershell.DSC, which is the same value that is used by **Get-AzureRmVMDscExtensionStatus**. -Specify this parameter only if you changed the default name in the Set cmdlet or used a different resource name in a Resource Manager template. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine for which this cmdlet gets the DSC extension status. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineInstanceView - -## NOTES - -## RELATED LINKS - -[Set-AzureRmVMDscExtension](./Set-AzureRmVMDscExtension.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMExtension.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMExtension.md deleted file mode 100644 index 6257398bbb..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMExtension.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 842652D4-0F1C-4D0D-AB55-0D43D3C5D82A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMExtension.md ---- - -# Get-AzureRmVMExtension - -## SYNOPSIS -Gets properties of Virtual Machine Extensions installed on a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVMExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name] <String> [-Status] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMExtension** cmdlet gets properties of Virtual Machine Extensions installed on a virtual machine. -Specify the name of an extension for which to get properties. -To get only the instance view of an extension, specify the Status parameter. - -## EXAMPLES - -### Example 1: Get properties of an extension -``` -PS C:\> Get-AzureRmVMExtension -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine22" -Name "CustomScriptExtension" -``` - -This command gets properties for the extension named CustomScriptExtension on the virtual machine named VirtualMachine22 in the resource group ResourceGroup11. - -### Example 2: Get instance view of an extension -``` -PS C:\> Get-AzureRmVMExtension -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine22" -Name "CustomScriptExtension" -Status -``` - -This command gets the instance view for the extension named CustomScriptExtension on the virtual machine named VirtualMachine22 in the resource group ResourceGroup11. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of an extension. -This cmdlet gets properties for the extension that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Status -Indicates that this cmdlet gets only the instance view of an extension. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine. -This cmdlet gets properties of an extension from the virtual machine that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineExtension - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmVMExtension](./Remove-AzureRmVMExtension.md) - -[Set-AzureRmVMExtension](./Set-AzureRmVMExtension.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMExtensionImage.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMExtensionImage.md deleted file mode 100644 index 11598e102b..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMExtensionImage.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: F46041A3-355F-4449-B582-4D2F7314CA05 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmextensionimage -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMExtensionImage.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMExtensionImage.md ---- - -# Get-AzureRmVMExtensionImage - -## SYNOPSIS -Gets all versions for an Azure extension. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVMExtensionImage -Location <String> -PublisherName <String> -Type <String> - [-FilterExpression <String>] [-Version <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMExtensionImage** cmdlet gets all versions for an Azure extension. - -## EXAMPLES - -### Example 1: Get the versions of an extension image -``` -PS C:\> Get-AzureRmVMExtensionImage -Location "Central US" -PublisherName "Fabrikam" -Type "FabrikamEndpointProtection" -``` - -This command gets all the versions of the extension image for the specified location, publisher, and type. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FilterExpression -Specifies a filter expression. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location of an extension. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublisherName -Specifies the name of an extension publisher. -To obtain an extension publisher, use the Get-AzureRmVMImagePublisher cmdlet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Type -Specifies the type of the extension. -To obtain an extension type, use the Get-AzureRmVMExtensionImageType cmdlet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Version -Specifies the version of the extension that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineExtensionImage - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineExtensionImageDetails - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMExtensionImageType](./Get-AzureRmVMExtensionImageType.md) - -[Get-AzureRmVMImage](./Get-AzureRmVMImage.md) - -[Get-AzureRmVMImagePublisher](./Get-AzureRmVMImagePublisher.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMExtensionImageType.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMExtensionImageType.md deleted file mode 100644 index de196cbf08..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMExtensionImageType.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 45F35BDD-969E-4521-9E8D-3499A15434A6 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmextensionimagetype -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMExtensionImageType.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMExtensionImageType.md ---- - -# Get-AzureRmVMExtensionImageType - -## SYNOPSIS -Gets the type of an Azure extension. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVMExtensionImageType -Location <String> -PublisherName <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMExtensionImageType** cmdlet gets the type of an Azure extension. - -## EXAMPLES - -### Example 1: Get an extension image type -``` -PS C:\> Get-AzureRmVMExtensionImageType -Location "Central US" -PublisherName "Fabrikam" -``` - -This command gets the extension image type for the specified publisher and location. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location of an extension. -This cmdlet gets the type for an extension at the location that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublisherName -Specifies the name of a publisher of an extension. -To obtain an extension publisher, use the Get-AzureRmVMImagePublisher cmdlet. -This cmdlet gets the type for an extension from the publisher that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineExtensionImageType - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMExtensionImage](./Get-AzureRmVMExtensionImage.md) - -[Get-AzureRmVMImagePublisher](./Get-AzureRmVMImagePublisher.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMImage.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMImage.md deleted file mode 100644 index 6a5d26df1a..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMImage.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: D5254218-8B3B-4DE2-9480-D65EE5483018 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmimage -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMImage.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMImage.md ---- - -# Get-AzureRmVMImage - -## SYNOPSIS -Gets all the versions of a VMImage. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ListVMImage -``` -Get-AzureRmVMImage -Location <String> -PublisherName <String> -Offer <String> -Skus <String> - [-FilterExpression <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetVMImageDetail -``` -Get-AzureRmVMImage -Location <String> -PublisherName <String> -Offer <String> -Skus <String> -Version <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMImage** cmdlet gets all the versions of a VMImage. - -## EXAMPLES - -### Example 1: Get VMImage objects -``` -PS C:\> Get-AzureRmVMImage -Location "Central US" -PublisherName "MicrosoftWindowsServer" -Offer "windowsserver" -Skus "2012-R2-Datacenter" -``` - -This command gets all the versions of VMImage that match the specified values. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FilterExpression -Specifies a filter expression. - -```yaml -Type: System.String -Parameter Sets: ListVMImage -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location of a VMImage. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Offer -Specifies the type of VMImage offer. -To obtain an image offer, use the Get-AzureRmVMImageOffer cmdlet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublisherName -Specifies the publisher of a VMImage. -To obtain an image publisher, use the Get-AzureRmVMImagePublisher cmdlet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Skus -Specifies a VMImage SKU. -To obtain an SKU, use the Get-AzureRmVMImageSku cmdlet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Version -Specifies the version of the VMImage. - -```yaml -Type: System.String -Parameter Sets: GetVMImageDetail -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineImage - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineImageDetail - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMImageOffer](./Get-AzureRmVMImageOffer.md) - -[Get-AzureRmVMImagePublisher](./Get-AzureRmVMImagePublisher.md) - -[Get-AzureRmVMImageSku](./Get-AzureRmVMImageSku.md) - -[Save-AzureRmVMImage](./Save-AzureRmVMImage.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMImageOffer.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMImageOffer.md deleted file mode 100644 index 5e06a21c18..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMImageOffer.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: D2CCAEB4-E43E-4075-9436-77F2C4FE9463 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmimageoffer -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMImageOffer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMImageOffer.md ---- - -# Get-AzureRmVMImageOffer - -## SYNOPSIS -Gets VMImage offer types. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVMImageOffer -Location <String> -PublisherName <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMImageOffer** cmdlet gets the VMImage offer types. - -## EXAMPLES - -### Example 1: Get offer types for a publisher -``` -PS C:\> Get-AzureRmVMImageOffer -Location "Central US" -PublisherName "Fabrikam" -``` - -This command gets the offer types for the specified publisher in the Central US region. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the VMImage. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublisherName -Specifies the name of a publisher of a VMImage. -To obtain a publisher, use the Get-AzureRmVMImagePublisher cmdlet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineImageOffer - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMImage](./Get-AzureRmVMImage.md) - -[Get-AzureRmVMImagePublisher](./Get-AzureRmVMImagePublisher.md) - -[Get-AzureRmVMImageSku](./Get-AzureRmVMImageSku.md) - -[Save-AzureRmVMImage](./Save-AzureRmVMImage.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMImagePublisher.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMImagePublisher.md deleted file mode 100644 index c441c486f6..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMImagePublisher.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 7311F66C-3370-4436-8030-6D98D42C3112 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmimagepublisher -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMImagePublisher.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMImagePublisher.md ---- - -# Get-AzureRmVMImagePublisher - -## SYNOPSIS -Gets the VMImage publishers. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVMImagePublisher -Location <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMImagePublisher** cmdlet gets the VMImage publishers. - -## EXAMPLES - -### Example 1: Get VMImage publishers for a region -``` -PS C:\> Get-AzureRmVMImagePublisher -Location "Central US" -``` - -This command gets the publishers of VMImage instances for the Central US region within your Azure profile. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the VMImage. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineImagePublisher - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMImage](./Get-AzureRmVMImage.md) - -[Get-AzureRmVMImageOffer](./Get-AzureRmVMImageOffer.md) - -[Get-AzureRmVMImageSku](./Get-AzureRmVMImageSku.md) - -[Save-AzureRmVMImage](./Save-AzureRmVMImage.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMImageSku.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMImageSku.md deleted file mode 100644 index 33aee1c061..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMImageSku.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: D2BBAC5B-A7B9-44DA-BE37-24D89E03BAB3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmimagesku -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMImageSku.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMImageSku.md ---- - -# Get-AzureRmVMImageSku - -## SYNOPSIS -Gets VMImage SKUs. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVMImageSku -Location <String> -PublisherName <String> -Offer <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMImageSku** cmdlet gets VMImage SKUs. - -## EXAMPLES - -### Example 1: Get VMImage SKUs -``` -PS C:\> Get-AzureRmVMImageSku -Location "Central US" -PublisherName "Fabrikam" -Offer "LinuxServer" -``` - -This command gets the SKUs for the specified publisher and offer. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the VMImage. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Offer -Specifies the type of VMImage offer. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublisherName -Specifies the publisher of a VMImage. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineImageSku - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMImage](./Get-AzureRmVMImage.md) - -[Get-AzureRmVMImageOffer](./Get-AzureRmVMImageOffer.md) - -[Get-AzureRmVMImagePublisher](./Get-AzureRmVMImagePublisher.md) - -[Save-AzureRmVMImage](./Save-AzureRmVMImage.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMRunCommandDocument.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMRunCommandDocument.md deleted file mode 100644 index 29d1b7ec50..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMRunCommandDocument.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmruncommanddocument -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMRunCommandDocument.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMRunCommandDocument.md ---- - -# Get-AzureRmVMRunCommandDocument - -## SYNOPSIS -Get run command document. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVMRunCommandDocument [-Location] <String> [[-CommandId] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Get run command document. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmVMRunCommandDocument -Location 'westus' -CommandId 'RunPowerShellScript' -``` - -Gets a specific run command document for 'RunPowerShellScript' in 'westus'. -Get-AzureRmVMRunCommandDocument -Location $loc - -### Example 2 -``` -PS C:\> Get-AzureRmVMRunCommandDocument -Location 'westus' -``` - -Lists all available run commands in 'westus'. - -## PARAMETERS - -### -CommandId -The command id. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The location upon which run commands is queried. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSRunCommandDocument - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMSize.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMSize.md deleted file mode 100644 index f89cde3064..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMSize.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: B7A675D3-EF79-4EE2-9330-D4C690739006 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmsize -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMSize.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMSize.md ---- - -# Get-AzureRmVMSize - -## SYNOPSIS -Gets available virtual machine sizes. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ListVirtualMachineSizeParamSet (Default) -``` -Get-AzureRmVMSize [-Location] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ListAvailableSizesForAvailabilitySet -``` -Get-AzureRmVMSize [-ResourceGroupName] <String> [-AvailabilitySetName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ListAvailableSizesForVirtualMachine -``` -Get-AzureRmVMSize [-ResourceGroupName] <String> [-VMName] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMSize** cmdlet gets available virtual machine sizes. - -## EXAMPLES - -### Example 1: Get virtual machine sizes for a location -``` -PS C:\> Get-AzureRmVMSize -Location "Central US" -``` - -This command gets the available sizes for virtual machines in the specified location. - -### Example 2: Get sizes for an availability set -``` -PS C:\> Get-AzureRmVMSize -ResourceGroupName "ResourceGroup03" -AvailabilitySetName "AvailabilitySet17" -``` - -This command gets available sizes for virtual machines that you can deploy in the availability set named AvailabilitySet17. - -### Example 3: Get sizes for an existing virtual machine -``` -PS C:\> Get-AzureRmVMSize -ResourceGroupName "ResourceGroup03" -VMName "VirtualMachine12" -``` - -This command gets available sizes for the existing virtual machine named VirtualMachine12. -You can resize this virtual machine to the sizes that this command gets. - -## PARAMETERS - -### -AvailabilitySetName -Specifies the name of the Availability Set for which this cmdlet gets the available virtual machine sizes. - -```yaml -Type: System.String -Parameter Sets: ListAvailableSizesForAvailabilitySet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location for which this cmdlet gets the available virtual machine sizes. - -```yaml -Type: System.String -Parameter Sets: ListVirtualMachineSizeParamSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: ListAvailableSizesForAvailabilitySet, ListAvailableSizesForVirtualMachine -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine that this cmdlet gets the available virtual machine sizes for resizing. - -```yaml -Type: System.String -Parameter Sets: ListAvailableSizesForVirtualMachine -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineSize - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMUsage.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMUsage.md deleted file mode 100644 index 2afef6d827..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVMUsage.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 3702701E-428D-47E2-A227-0F38B055F881 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmusage -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMUsage.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVMUsage.md ---- - -# Get-AzureRmVMUsage - -## SYNOPSIS -Gets the virtual machine core count usage for a location. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVMUsage [-Location] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMUsage** cmdlet gets the virtual machine core count usage for a location. - -## EXAMPLES - -### Example 1: Get core count usage for a location -``` -PS C:\> Get-AzureRmVMUsage -Location "Central US" -``` - -This command gets the virtual machine core count usage for the location Central US. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location for which this cmdlet gets virtual machine core count usage. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSUsage - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVmss.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVmss.md deleted file mode 100644 index 3115109314..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVmss.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: FC6BC096-DBC4-48DA-A366-B87EB18A0496 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmss -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVmss.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVmss.md ---- - -# Get-AzureRmVmss - -## SYNOPSIS -Gets the properties of a VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameter (Default) -``` -Get-AzureRmVmss [[-ResourceGroupName] <String>] [[-VMScaleSetName] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### FriendMethod -``` -Get-AzureRmVmss [[-ResourceGroupName] <String>] [[-VMScaleSetName] <String>] [-InstanceView] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### OSUpgradeHistoryMethodParameter -``` -Get-AzureRmVmss [[-ResourceGroupName] <String>] [[-VMScaleSetName] <String>] [-OSUpgradeHistory] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVmss** cmdlet gets the model and instance view of a Virtual Machine Scale Set (VMSS). -The model view is the user specified properties of the virtual machine scale set. -The instance view is the instance level status of the virtual machine scale set. -Specify the *InstanceView* parameter to get only the instance view of a virtual machine scale set. - -## EXAMPLES - -### Example 1: Get the properties of a VMSS -``` -PS C:\> Get-AzureRmVmss -ResourceGroupName "Group001" -VMScaleSetName "VMSS001" -``` - -This command gets the properties of the VMSS named VMSS001 that belongs to the resource group named Group001. -Since the command does not specify the *InstanceView* switch parameter, the cmdlet gets the model view of the virtual machine scale set. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceView -Indicates that this cmdlet gets only the instance view of the virtual machine scale set. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: FriendMethod -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OSUpgradeHistory -Indicates that this cmdlet lists the os upgrade history of the virtual machine scale set. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: OSUpgradeHistoryMethodParameter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the Resource Group of the VMSS. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMScaleSetName -Species the name of the VMSS. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -## NOTES - -## RELATED LINKS - -[New-AzureRmVmss](./New-AzureRmVmss.md) - -[Remove-AzureRmVmss](./Remove-AzureRmVmss.md) - -[Restart-AzureRmVmss](./Restart-AzureRmVmss.md) - -[Set-AzureRmVmss](./Set-AzureRmVmss.md) - -[Start-AzureRmVmss](./Start-AzureRmVmss.md) - -[Stop-AzureRmVmss](./Stop-AzureRmVmss.md) - -[Update-AzureRmVmss](./Update-AzureRmVmss.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVmssDiskEncryption.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVmssDiskEncryption.md deleted file mode 100644 index 9b35b9c452..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVmssDiskEncryption.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmssdiskencryption -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVmssDiskEncryption.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVmssDiskEncryption.md ---- - -# Get-AzureRmVmssDiskEncryption - -## SYNOPSIS -Shows the disk encryption status of a VM scale set. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVmssDiskEncryption [[-ResourceGroupName] <String>] [[-VMScaleSetName] <String>] - [[-ExtensionName] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Shows the disk encryption status of a VM scale set. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmVmssDiskEncryption -ResourceGroupName "Group001" -VMScaleSetName "VMSS001" -``` - -Shows the disk encryption status of the VM scale set named VMSS001 that belongs to the resource group named Group001. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionName -The extension name. -If this parameter is not specified, default values used are AzureDiskEncryption for windows VMs and AzureDiskEncryptionForLinux for Linux VMs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource group name of the virtual machine scale set - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMScaleSetName -The virtual machine scale set name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVmssDiskEncryptionStatusContext - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVmssRollingUpgrade.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVmssRollingUpgrade.md deleted file mode 100644 index 19081b12d5..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVmssRollingUpgrade.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmssrollingupgrade -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVmssRollingUpgrade.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVmssRollingUpgrade.md ---- - -# Get-AzureRmVmssRollingUpgrade - -## SYNOPSIS -Shows the status of the latest virtual machine scale set rolling upgrade. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVmssRollingUpgrade [-ResourceGroupName] <String> [-VMScaleSetName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Shows the status of the latest virtual machine scale set rolling upgrade. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmVmssRollingUpgrade -ResourceGroupName "Group001" -VMScaleSetName "VMSS001" -``` - -This command shows the status of the latest rolling upgrade of the VMSS named VMSS001 that belongs to the resource group named Group001. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMScaleSetName -The name of the VM scale set. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSRollingUpgradeStatusInfo - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVmssSku.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVmssSku.md deleted file mode 100644 index 427aa36415..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVmssSku.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: BB6AFC7D-7E74-4D39-B336-A011B98D0682 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmsssku -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVmssSku.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVmssSku.md ---- - -# Get-AzureRmVmssSku - -## SYNOPSIS -Gets the available SKUs for the VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVmssSku [-ResourceGroupName] <String> [-VMScaleSetName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVmssSku** cmdlet gets the available SKUs for the Virtual Machine Scale Set (VMSS). - -## EXAMPLES - -### Example 1: Get all available SKUs from the VMSS -``` -PS C:\> Get-AzureRmVmssSku -ResourceGroupName "ContosoGroup" -VMScaleSetName "ContosoVMSS" -``` - -This command gets all the available SKUs from the VMSS named ContosoVMSS that belongs to the resource group named ContosoGroup. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the VMSS. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMScaleSetName -Species the name of the VMSS. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetSku - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVmss](./Get-AzureRmVmss.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVmssVM.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVmssVM.md deleted file mode 100644 index e9f62642d4..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVmssVM.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 63D48BA4-EE80-4740-90B9-0EE05B3F6536 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmssvm -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVmssVM.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVmssVM.md ---- - -# Get-AzureRmVmssVM - -## SYNOPSIS -Gets the properties of a VMSS virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameter (Default) -``` -Get-AzureRmVmssVM [[-ResourceGroupName] <String>] [[-VMScaleSetName] <String>] [[-InstanceId] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### FriendMethod -``` -Get-AzureRmVmssVM [[-ResourceGroupName] <String>] [[-VMScaleSetName] <String>] [[-InstanceId] <String>] - [-InstanceView] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVmssVM** cmdlet gets the model view and instance view of a Virtual Machine Scale Set (VMSS) virtual machine. -The model view is the user specified properties of the virtual machine. -The instance view is the instance level status of the virtual machine. -Specify the *Status* parameter to get only the instance view of a virtual machine. - -## EXAMPLES - -### Example 1: Get the properties of a VMSS virtual machine -``` -PS C:\> Get-AzureRmVmssVM -ResourceGroupName "Group001" -VMScaleSetName "VMSS001" -``` - -This command gets the properties of the VMSS virtual machine named VMSS001 that belongs to the resource group named Group001. -Since the command does not specify the *InstanceView* switch parameter, the cmdlet gets the model view of the virtual machine. - -### Example 2: Get the model view properties of a VMSS virtual machine -``` -PS C:\> Get-AzureRmVmssVM -ResourceGroupName "Group002" -VMScaleSetName "VMSS004" -InstanceId $ID -``` - -This command gets the properties of the VMSS virtual machine named VMSS004 that belongs to the resource group named Group002. -The command gets the instance ID stored in the variable $ID for which to get the model view. - -### Example 3: Get the instance view properties of a VMSS virtual machine -``` -PS C:\> Get-AzureRmVmssVM -InstanceView -ResourceGroupName $rgname -VMScaleSetName $vmssName -InstanceId $ID -``` - -This command gets the properties of the VMSS virtual machine named VMSS004 that belongs to the resource group named Group002. -Since the command specifies the *InstanceView* switch parameter, the cmdlet gets the instance view of the virtual machine. -The command gets the instance ID stored in the variable $ID for which to get the instance view. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceId -Specifies the instance ID for which to get the model view. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InstanceView -Indicates that this cmdlet gets only the instance view of the virtual machine. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: FriendMethod -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the Resource Group of the VMSS. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMScaleSetName -Species the name of the VMSS. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetVM - -## NOTES - -## RELATED LINKS - -[Set-AzureRmVmssVM](./Set-AzureRmVmssVM.md) - -[Get-AzureRmVmss](./Get-AzureRmVmss.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVmssVMDiskEncryption.md b/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVmssVMDiskEncryption.md deleted file mode 100644 index 3ed3e12ec9..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Get-AzureRmVmssVMDiskEncryption.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmssvmdiskencryption -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVmssVMDiskEncryption.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Get-AzureRmVmssVMDiskEncryption.md ---- - -# Get-AzureRmVmssVMDiskEncryption - -## SYNOPSIS -Shows the disk encryption status of VMs in a VM scale set. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVmssVMDiskEncryption [-ResourceGroupName] <String> [-VMScaleSetName] <String> - [[-InstanceId] <String>] [-ExtensionName <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -Shows the disk encryption status of VM scale set. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmVmssVMDiskEncryption -ResourceGroupName "Group001" -VMScaleSetName "VMSS001" -InstanceId "1" -``` - -Shows the disk encryption status of VM instance 1 in the VM scale set named VMSS001 that belongs to the resource group named Group001. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionName -The extension name. -If this parameter is not specified, default values used are AzureDiskEncryption for windows VMs and AzureDiskEncryptionForLinux for Linux VMs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InstanceId -Specifies the instance ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource group name of the virtual machine scale set. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMScaleSetName -The virtual machine scale set name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVmssVMDiskEncryptionStatusContext - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Grant-AzureRmDiskAccess.md b/azurermps-6.13.0/AzureRM.Compute/Grant-AzureRmDiskAccess.md deleted file mode 100644 index 0dfc5ab141..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Grant-AzureRmDiskAccess.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/grant-azurermdiskaccess -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Grant-AzureRmDiskAccess.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Grant-AzureRmDiskAccess.md ---- - -# Grant-AzureRmDiskAccess - -## SYNOPSIS -Grants an access to a disk. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Grant-AzureRmDiskAccess [-ResourceGroupName] <String> [-DiskName] <String> [-Access] <String> - [[-DurationInSecond] <Int32>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Grant-AzureRmDiskAccess** cmdlet grants an access to a disk. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Grant-AzureRmDiskAccess -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -Access 'Read' -DurationInSecond 60; -``` - -Grant 'Read' access to the disk named 'Disk01' in the resource group named 'ResourceGroup01' for 60 seconds. - -## PARAMETERS - -### -Access -Specifies Access level. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskName -Specifies the name of a disk. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DurationInSecond -Specifies access duration in seconds. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSAccessUri - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Grant-AzureRmSnapshotAccess.md b/azurermps-6.13.0/AzureRM.Compute/Grant-AzureRmSnapshotAccess.md deleted file mode 100644 index 47606f2e57..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Grant-AzureRmSnapshotAccess.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/grant-azurermsnapshotaccess -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Grant-AzureRmSnapshotAccess.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Grant-AzureRmSnapshotAccess.md ---- - -# Grant-AzureRmSnapshotAccess - -## SYNOPSIS -Grants an access to a snapshot. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Grant-AzureRmSnapshotAccess [-ResourceGroupName] <String> [-SnapshotName] <String> [-Access] <String> - [[-DurationInSecond] <Int32>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Grant-AzureRmSnapshotAccess** cmdlet grants an access to a snapshot. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Grant-AzureRmDiskAccess -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -Access 'Read' -DurationInSecond 60; -``` - -Grant 'Read' access to the snapshot named 'Snapshot01' in the resource group named 'ResourceGroup01' for 60 seconds. - -## PARAMETERS - -### -Access -Specifies Access level. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DurationInSecond -Specifies access duration in seconds. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SnapshotName -Specifies the name of a snapshot. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSAccessUri - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Invoke-AzureRmVMRunCommand.md b/azurermps-6.13.0/AzureRM.Compute/Invoke-AzureRmVMRunCommand.md deleted file mode 100644 index 22785777e7..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Invoke-AzureRmVMRunCommand.md +++ /dev/null @@ -1,235 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/invoke-azurermvmruncommand -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Invoke-AzureRmVMRunCommand.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Invoke-AzureRmVMRunCommand.md ---- - -# Invoke-AzureRmVMRunCommand - -## SYNOPSIS -Run command on the VM. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameter (Default) -``` -Invoke-AzureRmVMRunCommand [-ResourceGroupName] <String> [-VMName] <String> -CommandId <String> - [-ScriptPath <String>] [-Parameter <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameter -``` -Invoke-AzureRmVMRunCommand -CommandId <String> [-ScriptPath <String>] [-Parameter <Hashtable>] - [-ResourceId] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### VMParameter -``` -Invoke-AzureRmVMRunCommand -CommandId <String> [-ScriptPath <String>] [-Parameter <Hashtable>] - [-VM] <PSVirtualMachine> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Invoke a run command on the VM. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Invoke-AzureRmVMRunCommand -ResourceGroupName 'rgname' -Name 'vmname' -CommandId 'RunPowerShellScript' -ScriptPath 'sample.ps1' -Parameter @{"arg1" = "var1";"arg2" = "var2"} -``` - -Invoke a run command of RunPowerShellScript with overriding the script 'sample.ps1' and the parameters on the VM of 'vmname' in resource group 'rgname'. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CommandId -The run command id. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Parameter -The run command parameters. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The resource id for the VM - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameter -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScriptPath -Path of the script to be executed. When this value is given, the given script will override the default script of the command. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -The PS virtual Machine Object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine -Parameter Sets: VMParameter -Aliases: VMProfile - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -VMName -The name of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSRunCommandResult - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Invoke-AzureRmVmssVMRunCommand.md b/azurermps-6.13.0/AzureRM.Compute/Invoke-AzureRmVmssVMRunCommand.md deleted file mode 100644 index 3813bd4318..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Invoke-AzureRmVmssVMRunCommand.md +++ /dev/null @@ -1,258 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/invoke-azurermvmssvmruncommand -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Invoke-AzureRmVmssVMRunCommand.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Invoke-AzureRmVmssVMRunCommand.md ---- - -# Invoke-AzureRmVmssVMRunCommand - -## SYNOPSIS -Run command on the Virtual Machine Scale Set VM. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameter (Default) -``` -Invoke-AzureRmVmssVMRunCommand [-ResourceGroupName] <String> [-VMScaleSetName] <String> [-InstanceId] <String> - -CommandId <String> [-ScriptPath <String>] [-Parameter <Hashtable>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameter -``` -Invoke-AzureRmVmssVMRunCommand -CommandId <String> [-ScriptPath <String>] [-Parameter <Hashtable>] - [-ResourceId] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ObjectParameter -``` -Invoke-AzureRmVmssVMRunCommand -CommandId <String> [-ScriptPath <String>] [-Parameter <Hashtable>] - [-VirtualMachineScaleSetVM] <PSVirtualMachineScaleSetVM> [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Invoke a run command on the Virtual Machine Scale Set VM. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Invoke-AzureRmVmssVMRunCommand -ResourceGroupName 'rgname' -VMScaleSetName 'vmssname' -InstanceId '0' -CommandId 'RunPowerShellScript' -ScriptPath 'sample.ps1' -Parameter @{"arg1" = "var1";"arg2" = "var2"} -``` - -Invoke a run command of RunPowerShellScript with overriding the script 'sample.ps1' and the parameters on the ID '0' VM in the virtual machine scale set of 'vmssname' in resource group 'rgname'. - -### Example 2 -``` -PS C:\> $VmssVM = Get-AzureRmVmssVM -ResourceGroupName "myrg" -VMScaleSetName "myvmss" -InstanceId 0 -PS C:\> Invoke-AzureRmVmssVMRunCommand -VirtualMachineScaleSetVM $VmssVM -CommandId 'RunPowerShellScript' -ScriptPath 'sample.ps1' -Parameter @{"arg1" = "var1";"arg2" = "var2"} -``` - -Invoke a run command of RunPowerShellScript with overriding the script 'sample.ps1' and the parameters on the ID '0' VM in the virtual machine scale set of 'vmssname' in resource group 'rgname'. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CommandId -The run command id. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceId -The instance ID of the virtual machine scale set VM. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Parameter -The run command parameters. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The resource id for the virtual machine scale set VM - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameter -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScriptPath -Path of the script to be executed. When this value is given, the given script will override the default script of the command. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSetVM -The PS Virtual Machine Scale Set VM Object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetVM -Parameter Sets: ObjectParameter -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -VMScaleSetName -The name of the virtual machine scale set VM. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetVM - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSRunCommandResult - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmAvailabilitySet.md b/azurermps-6.13.0/AzureRM.Compute/New-AzureRmAvailabilitySet.md deleted file mode 100644 index ba1b617912..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmAvailabilitySet.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: BF6AA8D4-D624-4BE1-A393-1A43909450C4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermavailabilityset -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmAvailabilitySet.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmAvailabilitySet.md ---- - -# New-AzureRmAvailabilitySet - -## SYNOPSIS -Creates an Azure availability set. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmAvailabilitySet [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> - [[-PlatformUpdateDomainCount] <Int32>] [[-PlatformFaultDomainCount] <Int32>] [[-Sku] <String>] - [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmAvailabilitySet** cmdlet creates an Azure availability set. - -## EXAMPLES - -### Example 1: Create an availability set -``` -PS C:\> New-AzureRmAvailabilitySet -ResourceGroupName "ResourceGroup11" -Name "AvailabilitySet03" -Location "West US" -``` - -This command creates an availability set named AvailablitySet03 in the resource group named ResourceGroup11. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location for the availability set. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the availability set. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName, AvailabilitySetName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PlatformFaultDomainCount -Specifies the platform fault domain count. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PlatformUpdateDomainCount -Specifies the platform update domain count. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -The Name of Sku. -The acceptable values for this parameter are: -- Aligned: For managed disks -- Classic: For unmanaged disks - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAvailabilitySet - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAvailabilitySet](./Get-AzureRmAvailabilitySet.md) - -[Remove-AzureRmAvailabilitySet](./Remove-AzureRmAvailabilitySet.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmContainerService.md b/azurermps-6.13.0/AzureRM.Compute/New-AzureRmContainerService.md deleted file mode 100644 index ff85c45d00..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmContainerService.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 522F5305-CDF6-41F2-803B-9EEA9E927668 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermcontainerservice -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmContainerService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmContainerService.md ---- - -# New-AzureRmContainerService - -## SYNOPSIS -Creates a container service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmContainerService [-ResourceGroupName] <String> [-Name] <String> - [-ContainerService] <PSContainerService> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmContainerService** cmdlet creates a container service. -Specify a container service object that you can create by using the New-AzureRmContainerServiceConfig cmdlet. - -## EXAMPLES - -### Example 1: Create a container service -``` -PS C:\> New-AzureRMResourceGroup -Name "ResourceGroup17" -Location "Australia Southeast" -Force -PS C:\> $Container = New-AzureRmContainerServiceConfig -Location "Australia Southeast" -OrchestratorType "DCOS" -MasterDnsPrefix "MasterResourceGroup17" -AdminUsername "AcsLinuxAdmin" -SshPublicKey "<ssh-key>" | Add-AzureRmContainerServiceAgentPoolProfile -Name "AgentPool01" -VmSize "Standard_A1" -DnsPrefix "APResourceGroup17" -PS C:\> New-AzureRmContainerService -ResourceGroupName "ResourceGroup17" -Name "CSResourceGroup17" -ContainerService $Container -``` - -The first command creates a resource group named ResourceGroup17 at the specified location. -For more information, see the New-AzureRmResourceGroup cmdlet. -The second command creates a container, and then stores it in the $Container variable. -For more information, see the New-AzureRmContainerServiceConfig cmdlet. -The final command creates a container service for the container stored in $Container. -The service is named csResourceGroup17. - -## PARAMETERS - -### -AsJob -RRun cmdlet in the background and return a Job to track progress. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContainerService -Specifies a container service object that contains the properties for the new service. -To obtain a **ContainerService** object, use the New-AzureRmContainerServiceConfig cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSContainerService -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the container service that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group in which this cmdlet deploys the container service. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSContainerService -Parameters: ContainerService (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSContainerService - -## NOTES - -## RELATED LINKS - -[Get-AzureRmContainerService](./Get-AzureRmContainerService.md) - -[New-AzureRmContainerServiceConfig](./New-AzureRmContainerServiceConfig.md) - -[Remove-AzureRmContainerService](./Remove-AzureRmContainerService.md) - -[Update-AzureRmContainerService](./Update-AzureRmContainerService.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmContainerServiceConfig.md b/azurermps-6.13.0/AzureRM.Compute/New-AzureRmContainerServiceConfig.md deleted file mode 100644 index 4d0e9e7343..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmContainerServiceConfig.md +++ /dev/null @@ -1,339 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: EC8C915A-A0BC-41DE-9DBF-3617536E3D1A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermcontainerserviceconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmContainerServiceConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmContainerServiceConfig.md ---- - -# New-AzureRmContainerServiceConfig - -## SYNOPSIS -Creates a local configuration object for a container service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmContainerServiceConfig [[-Location] <String>] [[-Tag] <Hashtable>] - [[-OrchestratorType] <ContainerServiceOrchestratorTypes>] [[-MasterCount] <Int32>] - [[-MasterDnsPrefix] <String>] [[-AgentPoolProfile] <ContainerServiceAgentPoolProfile[]>] - [[-WindowsProfileAdminUsername] <String>] [[-WindowsProfileAdminPassword] <String>] - [[-AdminUsername] <String>] [[-SshPublicKey] <String[]>] [[-VmDiagnosticsEnabled] <Boolean>] - [-CustomProfileOrchestrator <String>] [-ServicePrincipalProfileClientId <String>] - [-ServicePrincipalProfileSecret <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmContainerServiceConfig** cmdlet creates a local configuration object for a container service. -Provide this object to the New-AzureRmContainerService cmdlet to create a container service. - -## EXAMPLES - -### Example 1: Create a container service configuration -``` -PS C:\> $Container = New-AzureRmContainerServiceConfig -Location "Australia Southeast" -OrchestratorType "DCOS" -MasterDnsPrefix "MasterResourceGroup17" -AdminUsername "AcsLinuxAdmin" -SshPublicKey "<ssh-key>" -PS C:\> $Container | Add-AzureRmContainerServiceAgentPoolProfile -Name "AgentPool01" -VmSize "Standard_A1" -DnsPrefix "APResourceGroup17" -``` - -This command creates a container, and then stores it in the $Container variable. -The command specifies various settings for the container service configuration. The command passes -the configuration object to the Add-AzureRmContainerServiceAgentPoolProfile cmdlet by using the -pipeline operator. That cmdlet adds an agent pool profile. -Specify the object in $Container for the *ContainerService* parameter of **New-AzureRmContainerService**. - -## PARAMETERS - -### -AdminUsername -Specifies the administrator account name to use for a Linux-based container service. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AgentPoolProfile -Specifies an array of agent pool profile objects for the container service. -Add a profile by using the Add-AzureRmContainerServiceAgentPoolProfile cmdlet. - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.ContainerServiceAgentPoolProfile[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CustomProfileOrchestrator -Specifies the custom profile orchestrator. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location in which to create the container service. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MasterCount -Specifies the number of master virtual machines to create. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MasterDnsPrefix -Specifies the DNS prefix for the master virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OrchestratorType -Specifies the type of orchestrator for the container service. -The acceptable values for this parameter are: DCOS and Swarm. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.ContainerServiceOrchestratorTypes] -Parameter Sets: (All) -Aliases: -Accepted values: Swarm, DCOS, Custom, Kubernetes - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServicePrincipalProfileClientId -Specifies the principal profile client ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServicePrincipalProfileSecret -Specifies the principal profile secret. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SshPublicKey -Specifies the SSH public key for a Linux-based container service. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 9 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VmDiagnosticsEnabled -Indicates whether this configuration enables diagnostics for the container service virtual machine. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 10 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowsProfileAdminPassword -Specifies the administrator password for a container service that uses the Windows operating system. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowsProfileAdminUsername -Specifies the administrator username for a container service that uses the Windows operating system. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.ContainerServiceOrchestratorTypes, Microsoft.Azure.Management.Compute, Version=21.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -### System.Int32 - -### Microsoft.Azure.Management.Compute.Models.ContainerServiceAgentPoolProfile[] - -### System.String[] - -### System.Boolean - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSContainerService - -## NOTES - -## RELATED LINKS - -[Add-AzureRmContainerServiceAgentPoolProfile](./Add-AzureRmContainerServiceAgentPoolProfile.md) - -[New-AzureRmContainerService](./New-AzureRmContainerService.md) diff --git a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmDisk.md b/azurermps-6.13.0/AzureRM.Compute/New-AzureRmDisk.md deleted file mode 100644 index 40acb0ceeb..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmDisk.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermdisk -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmDisk.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmDisk.md ---- - -# New-AzureRmDisk - -## SYNOPSIS -Creates a managed disk. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmDisk [-ResourceGroupName] <String> [-DiskName] <String> [-Disk] <PSDisk> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmDisk** cmdlet creates a managed disk. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $diskconfig = New-AzureRmDiskConfig -Location 'Central US' -DiskSizeGB 5 -AccountType Standard_LRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; -PS C:\> $secretUrl = https://myvault.vault-int.azure-int.net/secrets/123/; -PS C:\> $secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; -PS C:\> $keyUrl = https://myvault.vault-int.azure-int.net/keys/456; -PS C:\> $keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; -PS C:\> $diskconfig = Set-AzureRmDiskDiskEncryptionKey -Disk $diskconfig -SecretUrl $secretUrl -SourceVaultId $secretId; -PS C:\> $diskconfig = Set-AzureRmDiskKeyEncryptionKey -Disk $diskconfig -KeyUrl $keyUrl -SourceVaultId $keyId; -PS C:\> New-AzureRmDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -Disk $diskconfig; -``` - -The first command creates a local empty disk object with size 5GB in Standard_LRS storage account type. It also sets Windows OS type and enables encryption settings. -The second and third commands set the disk encryption key and key encryption key settings for the disk object. -The last command takes the disk object and creates a disk with name 'Disk01' in resource group 'ResourceGroup01'. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disk -Specifies a local disk object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DiskName -Specifies the name of a disk. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk -Parameters: Disk (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmDiskConfig.md b/azurermps-6.13.0/AzureRM.Compute/New-AzureRmDiskConfig.md deleted file mode 100644 index ec368ecfe2..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmDiskConfig.md +++ /dev/null @@ -1,370 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermdiskconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmDiskConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmDiskConfig.md ---- - -# New-AzureRmDiskConfig - -## SYNOPSIS -Creates a configurable disk object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmDiskConfig [[-SkuName] <String>] [[-OsType] <OperatingSystemTypes>] [[-DiskSizeGB] <Int32>] - [[-Location] <String>] [-Zone <String[]>] [-DiskIOPSReadWrite <Int32>] [-DiskMBpsReadWrite <Int32>] - [-Tag <Hashtable>] [-CreateOption <String>] [-StorageAccountId <String>] - [-ImageReference <ImageDiskReference>] [-SourceUri <String>] [-SourceResourceId <String>] - [-EncryptionSettingsEnabled <Boolean>] [-DiskEncryptionKey <KeyVaultAndSecretReference>] - [-KeyEncryptionKey <KeyVaultAndKeyReference>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmDiskConfig** cmdlet creates a configurable disk object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $diskconfig = New-AzureRmDiskConfig -Location 'Central US' -DiskSizeGB 5 -AccountType StandardLRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; -PS C:\> $secretUrl = https://myvault.vault-int.azure-int.net/secrets/123/; -PS C:\> $secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; -PS C:\> $keyUrl = https://myvault.vault-int.azure-int.net/keys/456; -PS C:\> $keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; -PS C:\> $diskconfig = Set-AzureRmDiskDiskEncryptionKey -Disk $diskconfig -SecretUrl $secretUrl -SourceVaultId $secretId; -PS C:\> $diskconfig = Set-AzureRmDiskKeyEncryptionKey -Disk $diskconfig -KeyUrl $keyUrl -SourceVaultId $keyId; -PS C:\> New-AzureRmDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -Disk $diskconfig; -``` - -The first command creates a local empty disk object with size 5GB in Standard_LRS storage account -type. It also sets Windows OS type and enables encryption settings. The second and third commands -set the disk encryption key and key encryption key settings for the disk object. The last command -takes the disk object and creates a disk with name 'Disk01' in resource group 'ResourceGroup01'. - -## PARAMETERS - -### -CreateOption -Specifies whether this cmdlet creates a disk in the virtual machine from a platform or user image, -creates an empty disk, or attaches an existing disk. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskEncryptionKey -Specifies the disk encryption key object on a disk. - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.KeyVaultAndSecretReference -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DiskIOPSReadWrite -The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DiskMBpsReadWrite -The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DiskSizeGB -Specifies the size of the disk in GB. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EncryptionSettingsEnabled -Enable encryption settings. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ImageReference -Specifies the image reference on a disk. - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.ImageDiskReference -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyEncryptionKey -Specifies the Key encryption key on a disk. - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.KeyVaultAndKeyReference -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies a location. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OsType -Specifies the OS type. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes] -Parameter Sets: (All) -Aliases: -Accepted values: Windows, Linux - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuName -Specifies the Sku name of the storage account. Available values are Standard_LRS, Premium_LRS, StandardSSD_LRS, and UltraSSD_LRS. UltraSSD_LRS can only be used with Empty value for CreateOption parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountType - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceResourceId -Specifies the source resource ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceUri -Specifies the source Uri. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountId -Specifies the storage account ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Zone -Specifies the logical zone list for Disk. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes, Microsoft.Azure.Management.Compute, Version=21.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -### System.Int32 - -### System.String[] - -### System.Collections.Hashtable - -### Microsoft.Azure.Management.Compute.Models.ImageDiskReference - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### Microsoft.Azure.Management.Compute.Models.KeyVaultAndSecretReference - -### Microsoft.Azure.Management.Compute.Models.KeyVaultAndKeyReference - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmDiskUpdateConfig.md b/azurermps-6.13.0/AzureRM.Compute/New-AzureRmDiskUpdateConfig.md deleted file mode 100644 index 0349585498..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmDiskUpdateConfig.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermdiskupdateconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmDiskUpdateConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmDiskUpdateConfig.md ---- - -# New-AzureRmDiskUpdateConfig - -## SYNOPSIS -Creates a configurable disk update object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmDiskUpdateConfig [[-SkuName] <String>] [[-OsType] <OperatingSystemTypes>] [[-DiskSizeGB] <Int32>] - [[-Tag] <Hashtable>] [-DiskIOPSReadWrite <Int32>] [-DiskMBpsReadWrite <Int32>] - [-EncryptionSettingsEnabled <Boolean>] [-DiskEncryptionKey <KeyVaultAndSecretReference>] - [-KeyEncryptionKey <KeyVaultAndKeyReference>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmDiskUpdateConfig** cmdlet creates a configurable disk update object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $diskupdateconfig = New-AzureRmDiskUpdateConfig -DiskSizeGB 10 -AccountType PremiumLRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; -PS C:\> $secretUrl = https://myvault.vault-int.azure-int.net/secrets/123/; -PS C:\> $secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; -PS C:\> $keyUrl = https://myvault.vault-int.azure-int.net/keys/456; -PS C:\> $keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; -PS C:\> $diskupdateconfig = Set-AzureRmDiskUpdateDiskEncryptionKey -DiskUpdate $diskupdateconfig -SecretUrl $secretUrl -SourceVaultId $secretId; -PS C:\> $diskupdateconfig = Set-AzureRmDiskUpdateKeyEncryptionKey -DiskUpdate $diskupdateconfig -KeyUrl $keyUrl -SourceVaultId $keyId; -PS C:\> Update-AzureRmDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -DiskUpdate $diskupdateconfig; -``` - -The first command creates a local empty disk update object with size 10GB in Premium_LRS storage -account type. It also sets Windows OS type and enables encryption settings. The second and third -commands set the disk encryption key and key encryption key settings for the disk update object. -The last command takes the disk update object and updates an existing disk with name 'Disk01' in -resource group 'ResourceGroup01'. - -### Example 2 -``` -PS C:\> New-AzureRmDiskUpdateConfig -DiskSizeGB 10 | Update-AzureRmDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01'; -``` - -This command updates an existing disk with name 'Disk01' in resource group 'ResourceGroup01' to 10 GB disk size. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskEncryptionKey -Specifies the disk encryption key object on a disk. - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.KeyVaultAndSecretReference -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DiskIOPSReadWrite -The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DiskMBpsReadWrite -The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DiskSizeGB -Specifies the size of the disk in GB. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EncryptionSettingsEnabled -Enable encryption settings. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyEncryptionKey -Specifies the Key encryption key on a disk. - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.KeyVaultAndKeyReference -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OsType -Specifies the OS type. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes] -Parameter Sets: (All) -Aliases: -Accepted values: Windows, Linux - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuName -Specifies the Sku name of the storage account. Available values are Standard_LRS, Premium_LRS, StandardSSD_LRS, and UltraSSD_LRS. UltraSSD_LRS can only be used with Empty value for CreateOption parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountType - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes, Microsoft.Azure.Management.Compute, Version=21.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -### System.Int32 - -### System.Collections.Hashtable - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### Microsoft.Azure.Management.Compute.Models.KeyVaultAndSecretReference - -### Microsoft.Azure.Management.Compute.Models.KeyVaultAndKeyReference - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskUpdate - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmGallery.md b/azurermps-6.13.0/AzureRM.Compute/New-AzureRmGallery.md deleted file mode 100644 index 3fde5e82c2..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmGallery.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermgallery -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmGallery.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmGallery.md ---- - -# New-AzureRmGallery - -## SYNOPSIS -Create a gallery. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmGallery [-ResourceGroupName] <String> [-Name] <String> [-AsJob] [-Location] <String> - [-Description <String>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Create a gallery. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-AzureRmGallery -ResourceGroupName $rgname -Name $galleryName -Location $location -Description $galleryDescription -``` - -Create a gallery. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The description of the gallery resource. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Resource location - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The name of the gallery. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: GalleryName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Resource tags - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSGallery - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmGalleryImageDefinition.md b/azurermps-6.13.0/AzureRM.Compute/New-AzureRmGalleryImageDefinition.md deleted file mode 100644 index 7b9b768d18..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmGalleryImageDefinition.md +++ /dev/null @@ -1,477 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermgalleryimagedefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmGalleryImageDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmGalleryImageDefinition.md ---- - -# New-AzureRmGalleryImageDefinition - -## SYNOPSIS -Create a gallery image definition. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmGalleryImageDefinition [-ResourceGroupName] <String> [-GalleryName] <String> [-Name] <String> - [-AsJob] [-Location] <String> -Publisher <String> -Offer <String> -Sku <String> - -OsState <OperatingSystemStateTypes> -OsType <OperatingSystemTypes> [-Description <String>] [-Eula <String>] - [-PrivacyStatementUri <String>] [-ReleaseNoteUri <String>] [-EndOfLifeDate <DateTime>] [-Tag <Hashtable>] - [-MinimumVCPU <Int32>] [-MaximumVCPU <Int32>] [-MinimumMemory <Int32>] [-MaximumMemory <Int32>] - [-DisallowedDiskType <String[]>] [-PurchasePlanName <String>] [-PurchasePlanPublisher <String>] - [-PurchasePlanProduct <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Create a gallery image definition. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-AzureRmGalleryImageDefinition -ResourceGroupName $resourceGroupName -GalleryName $galleryName -Name $galleryImageDefinitionName -Location $location -Publisher $publisherName -Offer $offerName -Sku $skuName -OsState "Generalized" -OsType "Linux" -Description $description -Eula $eula -PrivacyStatementUri $privacyStatementUri -ReleaseNoteUri $releaseNoteUri -DisallowedDiskType $disallowedDiskTypes -EndOfLifeDate $endOfLifeDate -MinimumMemory $minMemory -MaximumMemory $maxMemory -MinimumVCPU $minVCPU -MaximumVCPU $maxVCPU -PurchasePlanName $purchasePlanName -PurchasePlanProduct $purchasePlanProduct -PurchasePlanPublisher $purchasePlanPublisher -``` - -Create a gallery image definition. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The description of the gallery image Definition resource. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisallowedDiskType -The disallowed disk types. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EndOfLifeDate -The end of life date of the gallery Image Definition - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Eula -The Eula agreement for the gallery Image Definition. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GalleryName -The name of the gallery. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Resource location - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaximumMemory -The maximum of the recommended memory - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaximumVCPU -The maximum of the recommended CPU core - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MinimumMemory -The minimum of the recommended memory - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MinimumVCPU -The minimum of the recommended CPU core - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The name of the gallery image definition. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: GalleryImageDefinitionName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Offer -The name of the gallery Image Definition offer. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OsState -The state of OS - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.OperatingSystemStateTypes -Parameter Sets: (All) -Aliases: -Accepted values: Generalized, Specialized - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OsType -The type of OS - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes -Parameter Sets: (All) -Aliases: -Accepted values: Windows, Linux - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PrivacyStatementUri -The privacy statement uri. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Publisher -The name of the gallery Image Definition publisher. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PurchasePlanName -The ID for the purchase plan. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PurchasePlanProduct -The product ID for the purchase plan. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PurchasePlanPublisher -The publisher ID for the purchase plan. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReleaseNoteUri -The release note uri. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -The name of the gallery Image Definition SKU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Resource tags - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Management.Compute.Models.OperatingSystemStateTypes - -### Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes - -### System.DateTime - -### System.Collections.Hashtable - -### System.Int32 - -### System.String[] - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSGalleryImage - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmGalleryImageVersion.md b/azurermps-6.13.0/AzureRM.Compute/New-AzureRmGalleryImageVersion.md deleted file mode 100644 index 2acff1b084..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmGalleryImageVersion.md +++ /dev/null @@ -1,294 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermgalleryimageversion -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmGalleryImageVersion.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmGalleryImageVersion.md ---- - -# New-AzureRmGalleryImageVersion - -## SYNOPSIS -Create a gallery image version. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmGalleryImageVersion [-ResourceGroupName] <String> [-GalleryName] <String> - [-GalleryImageDefinitionName] <String> [-Name] <String> [-AsJob] -Location <String> -SourceImageId <String> - [-Tag <Hashtable>] [-ReplicaCount <Int32>] [-PublishingProfileExcludeFromLatest] - [-PublishingProfileEndOfLifeDate <DateTime>] [-TargetRegion <Hashtable[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Create a gallery image version. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> $region1 = @{Name='West US';ReplicaCount=1} -PS C:\> $region2 = @{Name='East US';ReplicaCount=2} -PS C:\> $region3 = @{Name='Central US'} -PS C:\> $targetRegions = @($region1,$region2,$region3) -PS C:\> New-AzureRmGalleryImageVersion -ResourceGroupName $rgname -GalleryName $galleryName -GalleryImageName $imageName -Name $versionName -Location $location -SourceImageId $sourceImageId -ReplicaCount 2 -PublishingProfileEndOfLifeDate $endOfLifeDate -TargetRegion $targetRegions -``` - -Create a gallery image version. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GalleryImageDefinitionName -The name of the gallery. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GalleryName -The name of the gallery. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Resource location - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The name of the gallery image version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: GalleryImageVersionName - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublishingProfileEndOfLifeDate -The end of life date of the gallery Image Version. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublishingProfileExcludeFromLatest -If it is set, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReplicaCount -The number of replicas of the Image Version to be created per region. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceImageId -The ID of the source image from which the Image Version is going to be created. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Resource tags - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetRegion -The target regions where the Image Version is going to be replicated to. - -```yaml -Type: System.Collections.Hashtable[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -### System.Int32 - -### System.Management.Automation.SwitchParameter - -### System.DateTime - -### System.Collections.Hashtable[] - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSGalleryImageVersion - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmImage.md b/azurermps-6.13.0/AzureRM.Compute/New-AzureRmImage.md deleted file mode 100644 index 9cfcaa55e3..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmImage.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermimage -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmImage.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmImage.md ---- - -# New-AzureRmImage - -## SYNOPSIS -Creates an image. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmImage [-ResourceGroupName] <String> [-ImageName] <String> [-Image] <PSImage> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmImage** cmdlet creates an image. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $imageConfig = New-AzureRmImageConfig -Location 'West US'; -PS C:\> $osDiskVhdUri = "https://contoso.blob.core.windows.net/test/os.vhd" -PS C:\> $dataDiskVhdUri1 = "https://contoso.blob.core.windows.net/test/data1.vhd" -PS C:\> $dataDiskVhdUri2 = "https://contoso.blob.core.windows.net/test/data2.vhd" -PS C:\> Set-AzureRmImageOsDisk -Image $imageConfig -OsType 'Windows' -OsState 'Generalized' -BlobUri $osDiskVhdUri; -PS C:\> Add-AzureRmImageDataDisk -Image $imageConfig -Lun 1 -BlobUri $dataDiskVhdUri1; -PS C:\> Add-AzureRmImageDataDisk -Image $imageConfig -Lun 2 -BlobUri $dataDiskVhdUri2; -PS C:\> New-AzureRmImage -Image $imageConfig -ImageName 'ImageName01' -ResourceGroupName 'ResourceGroup01'; -``` - -The first command creates an image object, and then stores it in the $imageConfig variable. -The next three commands assign paths of os disk and two data disks to the $osDiskVhdUri, $dataDiskVhdUri1, and $dataDiskVhdUri2 variables. -This approach is only for readability of the following commands. -The next three commands each adds an os disk and two data disks to the image stored in $imageConfig. -The URI of each disk is stored in $osDiskVhdUri, $dataDiskVhdUri1, and $dataDiskVhdUri2. -The final command creates an image named 'ImageName01' in resource group 'ResourceGroup01'. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Image -Specifies a local image object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSImage -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ImageName -Specifies the name of an image. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSImage -Parameters: Image (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSImage - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmImageConfig.md b/azurermps-6.13.0/AzureRM.Compute/New-AzureRmImageConfig.md deleted file mode 100644 index b0b73a744e..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmImageConfig.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermimageconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmImageConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmImageConfig.md ---- - -# New-AzureRmImageConfig - -## SYNOPSIS -Creates a configurable image object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmImageConfig [[-Location] <String>] [[-Tag] <Hashtable>] [[-SourceVirtualMachineId] <String>] - [[-OsDisk] <ImageOSDisk>] [-DataDisk <ImageDataDisk[]>] [-ZoneResilient] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmImageConfig** cmdlet creates a configurable image object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $imageConfig = New-AzureRmImageConfig -Location 'West US'; -PS C:\> $osDiskVhdUri = "https://contoso.blob.core.windows.net/test/os.vhd" -PS C:\> $dataDiskVhdUri1 = "https://contoso.blob.core.windows.net/test/data1.vhd" -PS C:\> $dataDiskVhdUri2 = "https://contoso.blob.core.windows.net/test/data2.vhd" -PS C:\> Set-AzureRmImageOsDisk -Image $imageConfig -OsType 'Windows' -OsState 'Generalized' -BlobUri $osDiskVhdUri; -PS C:\> Add-AzureRmImageDataDisk -Image $imageConfig -Lun 1 -BlobUri $dataDiskVhdUri1; -PS C:\> Add-AzureRmImageDataDisk -Image $imageConfig -Lun 2 -BlobUri $dataDiskVhdUri2; -PS C:\> New-AzureRmImage -Image $imageConfig -ImageName 'ImageName01' -ResourceGroupName 'ResourceGroup01'; -``` - -The first command creates an image object, and then stores it in the $imageConfig variable. -The next three commands assign paths of os disk and two data disks to the $osDiskVhdUri, -$dataDiskVhdUri1, and $dataDiskVhdUri2 variables. This approach is only for readability of the -following commands. -The next three commands each adds an os disk and two data disks to the image stored in $imageConfig. -The URI of each disk is stored in $osDiskVhdUri, $dataDiskVhdUri1, and $dataDiskVhdUri2. -The final command creates an image named 'ImageName01' in resource group 'ResourceGroup01'. - -## PARAMETERS - -### -DataDisk -Specifies the data disk object. - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.ImageDataDisk[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies a location. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OsDisk -Specifies the operating system Disk. - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.ImageOSDisk -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceVirtualMachineId -Specifies the source virtual machine ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ZoneResilient -Enable zone resilient - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -### Microsoft.Azure.Management.Compute.Models.ImageOSDisk - -### Microsoft.Azure.Management.Compute.Models.ImageDataDisk[] - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSImage - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmSnapshot.md b/azurermps-6.13.0/AzureRM.Compute/New-AzureRmSnapshot.md deleted file mode 100644 index d4ce08391d..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmSnapshot.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermsnapshot -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmSnapshot.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmSnapshot.md ---- - -# New-AzureRmSnapshot - -## SYNOPSIS -Creates a snapshot. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmSnapshot [-ResourceGroupName] <String> [-SnapshotName] <String> [-Snapshot] <PSSnapshot> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmSnapshot** cmdlet creates a snapshot. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $snapshotconfig = New-AzureRmSnapshotConfig -Location 'Central US' -DiskSizeGB 5 -AccountType StandardLRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; -PS C:\> $secretUrl = https://myvault.vault-int.azure-int.net/secrets/123/; -PS C:\> $secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; -PS C:\> $keyUrl = https://myvault.vault-int.azure-int.net/keys/456; -PS C:\> $keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; -PS C:\> $snapshotconfig = Set-AzureRmSnapshotDiskEncryptionKey -Snapshot $snapshotconfig -SecretUrl $secretUrl -SourceVaultId $secretId; -PS C:\> $snapshotconfig = Set-AzureRmSnapshotKeyEncryptionKey -Snapshot $snapshotconfig -KeyUrl $keyUrl -SourceVaultId $keyId; -PS C:\> New-AzureRmSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -Snapshot $snapshotconfig; -``` - -The first command creates a local empty snapshot object with size 5GB in Standard_LRS storage account type. It also sets Windows OS type and enables encryption settings. -The second and third commands set the disk encryption key and key encryption key settings for the snapshot object. -The last command takes the snapshot object and creates a snapshot with name 'Snapshot01' in resource group 'ResourceGroup01'. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Snapshot -Specifies a local snapshot object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SnapshotName -Specifies the name of a snapshot. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot -Parameters: Snapshot (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmSnapshotConfig.md b/azurermps-6.13.0/AzureRM.Compute/New-AzureRmSnapshotConfig.md deleted file mode 100644 index 4559924f75..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmSnapshotConfig.md +++ /dev/null @@ -1,320 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermsnapshotconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmSnapshotConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmSnapshotConfig.md ---- - -# New-AzureRmSnapshotConfig - -## SYNOPSIS -Creates a configurable snapshot object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmSnapshotConfig [[-SkuName] <String>] [[-OsType] <OperatingSystemTypes>] [[-DiskSizeGB] <Int32>] - [[-Location] <String>] [-Tag <Hashtable>] [-CreateOption <String>] [-StorageAccountId <String>] - [-ImageReference <ImageDiskReference>] [-SourceUri <String>] [-SourceResourceId <String>] - [-EncryptionSettingsEnabled <Boolean>] [-DiskEncryptionKey <KeyVaultAndSecretReference>] - [-KeyEncryptionKey <KeyVaultAndKeyReference>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmSnapshotConfig** cmdlet creates a configurable snapshot object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $snapshotconfig = New-AzureRmSnapshotConfig -Location 'Central US' -DiskSizeGB 5 -AccountType StandardLRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; -PS C:\> $secretUrl = https://myvault.vault-int.azure-int.net/secrets/123/; -PS C:\> $secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; -PS C:\> $keyUrl = https://myvault.vault-int.azure-int.net/keys/456; -PS C:\> $keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; -PS C:\> $snapshotconfig = Set-AzureRmSnapshotDiskEncryptionKey -Snapshot $snapshotconfig -SecretUrl $secretUrl -SourceVaultId $secretId; -PS C:\> $snapshotconfig = Set-AzureRmSnapshotKeyEncryptionKey -Snapshot $snapshotconfig -KeyUrl $keyUrl -SourceVaultId $keyId; -PS C:\> New-AzureRmSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -Snapshot $snapshotconfig; -``` - -The first command creates a local empty snapshot object with size 5GB in Standard_LRS storage account type. It also sets Windows OS type and enables encryption settings. -The second and third commands set the disk encryption key and key encryption key settings for the snapshot object. -The last command takes the snapshot object and creates a snapshot with name 'Snapshot01' in resource group 'ResourceGroup01'. - -## PARAMETERS - -### -CreateOption -Specifies whether this cmdlet creates a disk in the virtual machine from a platform or user image, creates an empty disk, or attaches an existing disk. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskEncryptionKey -Specifies the disk encryption key object on a snapshot. - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.KeyVaultAndSecretReference -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DiskSizeGB -Specifies the size of the disk in GB. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EncryptionSettingsEnabled -Enable encryption settings. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ImageReference -Specifies the image reference on a snapshot. - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.ImageDiskReference -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyEncryptionKey -Specifies the Key encryption key on a snapshot. - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.KeyVaultAndKeyReference -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies a location. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OsType -Specifies the OS type. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes] -Parameter Sets: (All) -Aliases: -Accepted values: Windows, Linux - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuName -Specifies the Sku name of the storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountType - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceResourceId -Specifies the source resource ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceUri -Specifies the source Uri. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountId -Specifies the storage account ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes, Microsoft.Azure.Management.Compute, Version=21.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -### System.Int32 - -### System.Collections.Hashtable - -### Microsoft.Azure.Management.Compute.Models.ImageDiskReference - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### Microsoft.Azure.Management.Compute.Models.KeyVaultAndSecretReference - -### Microsoft.Azure.Management.Compute.Models.KeyVaultAndKeyReference - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmSnapshotUpdateConfig.md b/azurermps-6.13.0/AzureRM.Compute/New-AzureRmSnapshotUpdateConfig.md deleted file mode 100644 index ddd4681110..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmSnapshotUpdateConfig.md +++ /dev/null @@ -1,236 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermsnapshotupdateconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmSnapshotUpdateConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmSnapshotUpdateConfig.md ---- - -# New-AzureRmSnapshotUpdateConfig - -## SYNOPSIS -Creates a configurable snapshot update object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmSnapshotUpdateConfig [[-SkuName] <String>] [[-OsType] <OperatingSystemTypes>] - [[-DiskSizeGB] <Int32>] [[-Tag] <Hashtable>] [-EncryptionSettingsEnabled <Boolean>] - [-DiskEncryptionKey <KeyVaultAndSecretReference>] [-KeyEncryptionKey <KeyVaultAndKeyReference>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmSnapshotUpdateConfig** cmdlet creates a configurable snapshot update object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $snapshotupdateconfig = New-AzureRmSnapshotUpdateConfig -DiskSizeGB 10 -AccountType PremiumLRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; -PS C:\> $secretUrl = https://myvault.vault-int.azure-int.net/secrets/123/; -PS C:\> $secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; -PS C:\> $keyUrl = https://myvault.vault-int.azure-int.net/keys/456; -PS C:\> $keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; -PS C:\> $snapshotupdateconfig = Set-AzureRmSnapshotUpdateDiskEncryptionKey -SnapshotUpdate $snapshotupdateconfig -SecretUrl $secretUrl -SourceVaultId $secretId; -PS C:\> $snapshotupdateconfig = Set-AzureRmSnapshotUpdateKeyEncryptionKey -SnapshotUpdate $snapshotupdateconfig -KeyUrl $keyUrl -SourceVaultId $keyId; -PS C:\> Update-AzureRmSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -SnapshotUpdate $snapshotupdateconfig; -``` - -The first command creates a local empty snapshot update object with size 10GB in Premium_LRS -storage account type. It also sets Windows OS type and enables encryption settings. The second and -third commands set the disk encryption key and key encryption key settings for the snapshot update -object. The last command takes the snapshot update object and updates an existing snapshot with -name 'Snapshot01' in resource group 'ResourceGroup01'. - -### Example 2 -``` -PS C:\> New-AzureRmSnapshotUpdateConfig -DiskSizeGB 10 | Update-AzureRmSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01'; -``` - -This command updates an existing snapshot with name 'Snapshot01' in resource group -'ResourceGroup01' to 10 GB disk size. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskEncryptionKey -Specifies the disk encryption key object on a snapshot. - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.KeyVaultAndSecretReference -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DiskSizeGB -Specifies the size of the disk in GB. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EncryptionSettingsEnabled -Enable encryption settings. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyEncryptionKey -Specifies the Key encryption key on a snapshot. - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.KeyVaultAndKeyReference -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OsType -Specifies the OS type. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes] -Parameter Sets: (All) -Aliases: -Accepted values: Windows, Linux - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuName -Specifies the Sku name of the storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountType - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes, Microsoft.Azure.Management.Compute, Version=21.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -### System.Int32 - -### System.Collections.Hashtable - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### Microsoft.Azure.Management.Compute.Models.KeyVaultAndSecretReference - -### Microsoft.Azure.Management.Compute.Models.KeyVaultAndKeyReference - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshotUpdate - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmVM.md b/azurermps-6.13.0/AzureRM.Compute/New-AzureRmVM.md deleted file mode 100644 index 1e5d3ef31c..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmVM.md +++ /dev/null @@ -1,718 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 05E6155D-4F0E-406B-9312-77AD97EF66EE -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermvm -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmVM.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmVM.md ---- - -# New-AzureRmVM - -## SYNOPSIS -Creates a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SimpleParameterSet (Default) -``` -New-AzureRmVM [[-ResourceGroupName] <String>] [[-Location] <String>] [[-Zone] <String[]>] -Name <String> - -Credential <PSCredential> [-VirtualNetworkName <String>] [-AddressPrefix <String>] [-SubnetName <String>] - [-SubnetAddressPrefix <String>] [-PublicIpAddressName <String>] [-DomainNameLabel <String>] - [-AllocationMethod <String>] [-SecurityGroupName <String>] [-OpenPorts <Int32[]>] [-Image <String>] - [-Size <String>] [-AvailabilitySetName <String>] [-SystemAssignedIdentity] [-UserAssignedIdentity <String>] - [-AsJob] [-DataDiskSizeInGb <Int32[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### DefaultParameterSet -``` -New-AzureRmVM [-ResourceGroupName] <String> [-Location] <String> [-VM] <PSVirtualMachine> [[-Zone] <String[]>] - [-DisableBginfoExtension] [-Tag <Hashtable>] [-LicenseType <String>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### DiskFileParameterSet -``` -New-AzureRmVM [[-ResourceGroupName] <String>] [[-Location] <String>] -Name <String> - [-VirtualNetworkName <String>] [-AddressPrefix <String>] [-SubnetName <String>] - [-SubnetAddressPrefix <String>] [-PublicIpAddressName <String>] [-DomainNameLabel <String>] - [-AllocationMethod <String>] [-SecurityGroupName <String>] [-OpenPorts <Int32[]>] -DiskFile <String> [-Linux] - [-Size <String>] [-AvailabilitySetName <String>] [-SystemAssignedIdentity] [-UserAssignedIdentity <String>] - [-AsJob] [-DataDiskSizeInGb <Int32[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmVM** cmdlet creates a virtual machine in Azure. -This cmdlet takes a virtual machine object as input. -Use the New-AzureRmVMConfig cmdlet to create a virtual machine object. -Other cmdlets can be used to configure the virtual machine, such as Set-AzureRmVMOperatingSystem, Set-AzureRmVMSourceImage, Add-AzureRmVMNetworkInterface, and Set-AzureRmVMOSDisk. -The `SimpleParameterSet` provides a convenient method to create a VM by making common VM creation arguments optional. - -## EXAMPLES - -### Example 1: Create a virtual machine -``` -PS C:\> New-AzureRmVM -Name MyVm -Credential (Get-Credential) - -VERBOSE: Use 'mstsc /v:myvm-222222.eastus.cloudapp.azure.com' to connect to the VM. - -ResourceGroupName : MyVm -Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyVm/provi -ders/Microsoft.Compute/virtualMachines/MyVm -VmId : 11111111-1111-1111-1111-111111111111 -Name : MyVm -Type : Microsoft.Compute/virtualMachines -Location : eastus -Tags : {} -HardwareProfile : {VmSize} -NetworkProfile : {NetworkInterfaces} -OSProfile : {ComputerName, AdminUsername, WindowsConfiguration, Secrets} -ProvisioningState : Succeeded -StorageProfile : {ImageReference, OsDisk, DataDisks} -FullyQualifiedDomainName : myvm-222222.eastus.cloudapp.azure.com -``` - -This example script shows how to create a virtual machine. -The script will ask a user name and password for the VM. -This script uses several other cmdlets. - -### Example 2: Create a virtual machine from a custom user image -``` -PS C:\> ## VM Account -# Credentials for Local Admin account you created in the sysprepped (generalized) vhd image -$VMLocalAdminUser = "LocalAdminUser" -$VMLocalAdminSecurePassword = ConvertTo-SecureString "Password" -AsPlainText -Force -## Azure Account -$LocationName = "westus" -$ResourceGroupName = "MyResourceGroup" -# This a Premium_LRS storage account. -# It is required in order to run a client VM with efficiency and high performance. -$StorageAccount = "Mydisk" - -## VM -$OSDiskName = "MyClient" -$ComputerName = "MyClientVM" -$OSDiskUri = "https://Mydisk.blob.core.windows.net/disks/MyOSDisk.vhd" -$SourceImageUri = "https://Mydisk.blob.core.windows.net/vhds/MyOSImage.vhd" -$VMName = "MyVM" -# Modern hardware environment with fast disk, high IOPs performance. -# Required to run a client VM with efficiency and performance -$VMSize = "Standard_DS3" -$OSDiskCaching = "ReadWrite" -$OSCreateOption = "FromImage" - -## Networking -$DNSNameLabel = "mydnsname" # mydnsname.westus.cloudapp.azure.com -$NetworkName = "MyNet" -$NICName = "MyNIC" -$PublicIPAddressName = "MyPIP" -$SubnetName = "MySubnet" -$SubnetAddressPrefix = "10.0.0.0/24" -$VnetAddressPrefix = "10.0.0.0/16" - -$SingleSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name $SubnetName -AddressPrefix $SubnetAddressPrefix -$Vnet = New-AzureRmVirtualNetwork -Name $NetworkName -ResourceGroupName $ResourceGroupName -Location $LocationName -AddressPrefix $VnetAddressPrefix -Subnet $SingleSubnet -$PIP = New-AzureRmPublicIpAddress -Name $PublicIPAddressName -DomainNameLabel $DNSNameLabel -ResourceGroupName $ResourceGroupName -Location $LocationName -AllocationMethod Dynamic -$NIC = New-AzureRmNetworkInterface -Name $NICName -ResourceGroupName $ResourceGroupName -Location $LocationName -SubnetId $Vnet.Subnets[0].Id -PublicIpAddressId $PIP.Id - -$Credential = New-Object System.Management.Automation.PSCredential ($VMLocalAdminUser, $VMLocalAdminSecurePassword); - -$VirtualMachine = New-AzureRmVMConfig -VMName $VMName -VMSize $VMSize -$VirtualMachine = Set-AzureRmVMOperatingSystem -VM $VirtualMachine -Windows -ComputerName $ComputerName -Credential $Credential -ProvisionVMAgent -EnableAutoUpdate -$VirtualMachine = Add-AzureRmVMNetworkInterface -VM $VirtualMachine -Id $NIC.Id -$VirtualMachine = Set-AzureRmVMOSDisk -VM $VirtualMachine -Name $OSDiskName -VhdUri $OSDiskUri -SourceImageUri $SourceImageUri -Caching $OSDiskCaching -CreateOption $OSCreateOption -Windows - -New-AzureRmVM -ResourceGroupName $ResourceGroupName -Location $LocationName -VM $VirtualMachine -Verbose -``` - -This example takes an existing sys-prepped, generalized custom operating system image and attaches a data disk to it, provisions a new network, deploys the VHD, and runs it. -This script can be used for automatic provisioning because it uses the local virtual machine admin credentials inline instead of calling **Get-Credential** which requires user interaction. -This script assumes that you are already logged into your Azure account. -You can confirm your login status by using the **Get-AzureSubscription** cmdlet. - -### Example 3: Create a VM from a marketplace image without a Public IP -``` -$VMLocalAdminUser = "LocalAdminUser" -$VMLocalAdminSecurePassword = ConvertTo-SecureString <password> -AsPlainText -Force -$LocationName = "eastus2" -$ResourceGroupName = "MyResourceGroup" -$ComputerName = "MyVM" -$VMName = "MyVM" -$VMSize = "Standard_DS3" - -$NetworkName = "MyNet" -$NICName = "MyNIC" -$SubnetName = "MySubnet" -$SubnetAddressPrefix = "10.0.0.0/24" -$VnetAddressPrefix = "10.0.0.0/16" - -$SingleSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name $SubnetName -AddressPrefix $SubnetAddressPrefix -$Vnet = New-AzureRmVirtualNetwork -Name $NetworkName -ResourceGroupName $ResourceGroupName -Location $LocationName -AddressPrefix $VnetAddressPrefix -Subnet $SingleSubnet -$NIC = New-AzureRmNetworkInterface -Name $NICName -ResourceGroupName $ResourceGroupName -Location $LocationName -SubnetId $Vnet.Subnets[0].Id - -$Credential = New-Object System.Management.Automation.PSCredential ($VMLocalAdminUser, $VMLocalAdminSecurePassword); - -$VirtualMachine = New-AzureRmVMConfig -VMName $VMName -VMSize $VMSize -$VirtualMachine = Set-AzureRmVMOperatingSystem -VM $VirtualMachine -Windows -ComputerName $ComputerName -Credential $Credential -ProvisionVMAgent -EnableAutoUpdate -$VirtualMachine = Add-AzureRmVMNetworkInterface -VM $VirtualMachine -Id $NIC.Id -$VirtualMachine = Set-AzureRmVMSourceImage -VM $VirtualMachine -PublisherName 'MicrosoftWindowsServer' -Offer 'WindowsServer' -Skus '2012-R2-Datacenter' -Version latest - -New-AzureRmVM -ResourceGroupName $ResourceGroupName -Location $LocationName -VM $VirtualMachine -Verbose -``` - -This example provisions a new network and deploys a Windows VM from the Marketplace without creating a public IP address or Network Security Group. -This script can be used for automatic provisioning because it uses the local virtual machine admin credentials inline instead of calling **Get-Credential** which requires user interaction. - -## PARAMETERS - -### -AddressPrefix -The address prefix for the virtual network which will be created for the VM. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet, DiskFileParameterSet -Aliases: - -Required: False -Position: Named -Default value: 192.168.0.0/16 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllocationMethod -The IP allocation method for the public IP which will be created for the VM. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet, DiskFileParameterSet -Aliases: -Accepted values: Static, Dynamic - -Required: False -Position: Named -Default value: Static -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AvailabilitySetName -Specifies a name for the availability set. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet, DiskFileParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -The administrator credentials for the VM. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: SimpleParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataDiskSizeInGb -Specifies the sizes of data disks in GB. - -```yaml -Type: System.Int32[] -Parameter Sets: SimpleParameterSet, DiskFileParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableBginfoExtension -Indicates that this cmdlet does not install the **BG Info** extension on the virtual machine. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: DefaultParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskFile -The local path to the virtual hard disk file to be uploaded to the cloud and for creating the VM, and it must have '.vhd' as its suffix. - -```yaml -Type: System.String -Parameter Sets: DiskFileParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainNameLabel -The subdomain label for the fully-qualified domain name (FQDN) of the VM. This will take the form `{domainNameLabel}.{location}.cloudapp.azure.com`. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet, DiskFileParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Image -The friendly image name upon which the VM will be built. These include: Win2016Datacenter, Win2012R2Datacenter, Win2012Datacenter, Win2008R2SP1, UbuntuLTS, CentOS, CoreOS, Debian, openSUSE-Leap, RHEL, SLES. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet -Aliases: ImageName - -Required: False -Position: Named -Default value: Win2016Datacenter -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LicenseType -Specifies a license type, which indicates that the image or disk for the virtual machine was licensed on-premises. -This value is used only for images that contain the Windows Server operating system. -The acceptable values for this parameter are: -- Windows_Client -- Windows_Server -This value cannot be updated. -If you specify this parameter for an update, the value must match the initial value for the virtual machine. - -```yaml -Type: System.String -Parameter Sets: DefaultParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Linux -Indicates whether the disk file is for Linux VM, if specified; or Windows, if not specified by default. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: DiskFileParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies a location for the virtual machine. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet, DiskFileParameterSet -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: DefaultParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the VM resource. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet, DiskFileParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OpenPorts -A list of ports to open on the network security group (NSG) for the created VM. The default value depends on the type of image chosen (i.e., Windows: 3389, 5985 and Linux: 22). - -```yaml -Type: System.Int32[] -Parameter Sets: SimpleParameterSet, DiskFileParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIpAddressName -The name of a new (or existing) public IP address for the created VM to use. If not specified, a name will be generated. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet, DiskFileParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet, DiskFileParameterSet -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: DefaultParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecurityGroupName -The name of a new (or existing) network security group (NSG) for the created VM to use. If not specified, a name will be generated. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet, DiskFileParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Size -The Virtual Machine Size. The Default Value is: Standard_DS1_v2. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet, DiskFileParameterSet -Aliases: - -Required: False -Position: Named -Default value: Standard_DS1_v2 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetAddressPrefix -The address prefix for the subnet which will be created for the VM. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet, DiskFileParameterSet -Aliases: - -Required: False -Position: Named -Default value: 192.168.1.0/24 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetName -The name of a new (or existing) subnet for the created VM to use. If not specified, a name will be generated. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet, DiskFileParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SystemAssignedIdentity -If the parameter is present then the VM is assigned a managed system identity that is auto generated. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: SimpleParameterSet, DiskFileParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Specifies that resources and resource groups can be tagged with a set of name-value pairs. -Adding tags to resources enables you to group resources together across resource groups and to create your own views. -Each resource or resource group can have a maximum of 15 tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: DefaultParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserAssignedIdentity -The name of a managed service identity that should be assigned to the VM. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet, DiskFileParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkName -The name of a new (or existing) virtual network for the created VM to use. If not specified, a name will be generated. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet, DiskFileParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies a local virtual machine to create. -To obtain a virtual machine object, use the New-AzureRmVMConfig cmdlet. -Other cmdlets can be used to configure the virtual machine, such as Set-AzureRmVMOperatingSystem, Set-AzureRmVMSourceImage, and Add-AzureRmVMNetworkInterface. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine -Parameter Sets: DefaultParameterSet -Aliases: VMProfile - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Zone -Specifies the zone list of the virtual machine. - -```yaml -Type: System.String[] -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String[] -Parameter Sets: DefaultParameterSet -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -### System.String[] - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - -[Remove-AzureRmVM](./Remove-AzureRmVM.md) - -[Restart-AzureRmVM](./Restart-AzureRmVM.md) - -[Start-AzureRmVM](./Start-AzureRmVM.md) - -[Stop-AzureRmVM](./Stop-AzureRmVM.md) - -[Update-AzureRmVM](./Update-AzureRmVM.md) - -[Add-AzureRmVMDataDisk](./Add-AzureRmVMDataDisk.md) - -[Add-AzureRmVMNetworkInterface](./Add-AzureRmVMNetworkInterface.md) - -[New-AzureRmVMConfig](./New-AzureRmVMConfig.md) - -[Set-AzureRmVMOperatingSystem](./Set-AzureRmVMOperatingSystem.md) - -[Set-AzureRmVMSourceImage](./Set-AzureRmVMSourceImage.md) - -[Set-AzureRmVMOSDisk](./Set-AzureRmVMOSDisk.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmVMConfig.md b/azurermps-6.13.0/AzureRM.Compute/New-AzureRmVMConfig.md deleted file mode 100644 index a4efd5d640..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmVMConfig.md +++ /dev/null @@ -1,258 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 1BECAC91-BB43-46EB-B2C9-C965C6FBC831 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermvmconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmVMConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmVMConfig.md ---- - -# New-AzureRmVMConfig - -## SYNOPSIS -Creates a configurable virtual machine object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameterSet (Default) -``` -New-AzureRmVMConfig [-VMName] <String> [-VMSize] <String> [[-AvailabilitySetId] <String>] - [[-LicenseType] <String>] [-Zone <String[]>] [-Tags <Hashtable>] [-EnableUltraSSD] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ExplicitIdentityParameterSet -``` -New-AzureRmVMConfig [-VMName] <String> [-VMSize] <String> [[-AvailabilitySetId] <String>] - [[-LicenseType] <String>] [-IdentityType] <ResourceIdentityType> [-IdentityId <String[]>] [-Zone <String[]>] - [-Tags <Hashtable>] [-EnableUltraSSD] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### AssignIdentityParameterSet -``` -New-AzureRmVMConfig [-VMName] <String> [-VMSize] <String> [[-AvailabilitySetId] <String>] - [[-LicenseType] <String>] [-AssignIdentity] [-Zone <String[]>] [-Tags <Hashtable>] [-EnableUltraSSD] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmVMConfig** cmdlet creates a configurable local virtual machine object for Azure. -Other cmdlets can be used to configure a virtual machine object, such as Set-AzureRmVMOperatingSystem, Set-AzureRmVMSourceImage, Add-AzureRmVMNetworkInterface, and Set-AzureRmVMOSDisk. - -## EXAMPLES - -### Example 1: Create a virtual machine object -``` -PS C:\> $AvailabilitySet = Get-AzureRmAvailabilitySet -ResourceGroupName "ResourceGroup11" -Name "AvailabilitySet03" -PS C:\> $VirtualMachine = New-AzureRmVMConfig -VMName "VirtualMachine07" -VMSize "Standard_A1" -AvailabilitySetID $AvailabilitySet.Id -``` - -The first command gets the availability set named AvailablitySet03 in the resource group named ResourceGroup11, and then stores that object in the $AvailabilitySet variable. -The second command creates a virtual machine object, and then stores it in the $VirtualMachine variable. -The command assigns a name and size to the virtual machine. -The virtual machine belongs to the availability set stored in $AvailabilitySet. - -## PARAMETERS - -### -AssignIdentity -Specify the system assigned identity for the virtual machine. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: AssignIdentityParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AvailabilitySetId -Specifies the ID of an availability set. -To obtain an availability set object, use the Get-AzureRmAvailabilitySet cmdlet. -The availability set object contains an ID property. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableUltraSSD -Enables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM. -Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine only if this property is enabled. - - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IdentityId -Specifies the list of user identities associated with the virtual machine scale set. -The user identity references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}' - -```yaml -Type: System.String[] -Parameter Sets: ExplicitIdentityParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IdentityType -The identity of the virtual machine, if configured. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.ResourceIdentityType] -Parameter Sets: ExplicitIdentityParameterSet -Aliases: -Accepted values: SystemAssigned, UserAssigned, SystemAssignedUserAssigned, None - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LicenseType -The license type, which is for bringing your own license scenario. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tags -The tags attached to the resource. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tag - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies a name for the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMSize -Specifies the size for the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Zone -Specifies the zone list for the virtual machine. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.String[] - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## NOTES - -## RELATED LINKS - -[Update-AzureRmVM](./Update-AzureRmVM.md) - -[Set-AzureRmVMOperatingSystem](./Set-AzureRmVMOperatingSystem.md) - -[Set-AzureRmVMSourceImage](./Set-AzureRmVMSourceImage.md) - -[Get-AzureRmAvailabilitySet](./Get-AzureRmAvailabilitySet.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmVMDataDisk.md b/azurermps-6.13.0/AzureRM.Compute/New-AzureRmVMDataDisk.md deleted file mode 100644 index df0bfc0158..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmVMDataDisk.md +++ /dev/null @@ -1,238 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermvmdatadisk -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmVMDataDisk.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmVMDataDisk.md ---- - -# New-AzureRmVMDataDisk - -## SYNOPSIS -Creates a local data disk object for a virtual machine or a Vmss VM. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NormalDiskParameterSetName (Default) -``` -New-AzureRmVMDataDisk [-Lun] <Int32> [-CreateOption] <String> [-Name <String>] [-Caching <CachingTypes>] - [-DiskSizeInGB <Int32>] [-VhdUri <String>] [-SourceImageUri <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ManagedDiskParameterSetName -``` -New-AzureRmVMDataDisk [-Lun] <Int32> [-CreateOption] <String> [-Name <String>] [-Caching <CachingTypes>] - [-DiskSizeInGB <Int32>] [-ManagedDiskId <String>] [-StorageAccountType <String>] [-WriteAccelerator] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmVMDataDisk** cmdlet creates a local data disk object for a virtual machine or a Vmss VM. - -## EXAMPLES - -### Example 1: Add a managed data disk to a Vmss VM. -``` -PS C:\> $disk = Get-AzureRmDisk -ResourceGroupName $rgname -DiskName $diskname0 -PS C:\> $datadisk = New-AzureRmVMDataDisk -Caching 'ReadOnly' -Lun 2 -CreateOption Attach -StorageAccountType Standard_LRS -ManagedDiskId $disk.Id -PS C:\> $VmssVM = Get-AzureRmVmssVM -ResourceGroupName "myrg" -VMScaleSetName "myvmss" -InstanceId 0 -PS C:\> Update-AzureRmVmssVM -ResourceGroupName "myrg" -VMScaleSetName "myvmss" -InstanceId 0 -DataDisk $datadisk -``` - -The first command gets an existing managed disk. -The next command creates a data disk object with the managed disk. -The next command gets an existing Vmss VM given by the resource group name, the vmss name and the instance ID. -The final command updates the Vmss VM by adding a new data disk. - -## PARAMETERS - -### -Caching -The virtual machine data disk's caching. - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.CachingTypes -Parameter Sets: (All) -Aliases: -Accepted values: None, ReadOnly, ReadWrite - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CreateOption -The virtual machine data disk's create option. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskSizeInGB -The virtual machine data disk's size in GB. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Lun -The virtual machine data disk's Lun. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ManagedDiskId -The virtual machine managed disk's Id. - -```yaml -Type: System.String -Parameter Sets: ManagedDiskParameterSetName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The virtual machine data disk's name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceImageUri -The virtual machine OS disk's source image Uri. - -```yaml -Type: System.String -Parameter Sets: NormalDiskParameterSetName -Aliases: SourceImage - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountType -The virtual machine managed disk's account type. - -```yaml -Type: System.String -Parameter Sets: ManagedDiskParameterSetName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VhdUri -The virtual machine data disk's Vhd Uri. - -```yaml -Type: System.String -Parameter Sets: NormalDiskParameterSetName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WriteAccelerator -Specifies whether WriteAccelerator should be enabled or disabled on a managed data disk. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ManagedDiskParameterSetName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Int32 - -### System.String - -### Microsoft.Azure.Management.Compute.Models.CachingTypes - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineDataDisk - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmVMSqlServerAutoBackupConfig.md b/azurermps-6.13.0/AzureRM.Compute/New-AzureRmVMSqlServerAutoBackupConfig.md deleted file mode 100644 index 6259acc1bf..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmVMSqlServerAutoBackupConfig.md +++ /dev/null @@ -1,348 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 0AC17275-17A9-47DE-BF04-C1A51DF057DC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermvmsqlserverautobackupconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmVMSqlServerAutoBackupConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmVMSqlServerAutoBackupConfig.md ---- - -# New-AzureRmVMSqlServerAutoBackupConfig - -## SYNOPSIS -Creates a configuration object for SQL Server automatic backup. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### StorageUriSqlServerAutoBackup (Default) -``` -New-AzureRmVMSqlServerAutoBackupConfig [-ResourceGroupName] <String> [-Enable] - [[-RetentionPeriodInDays] <Int32>] [-EnableEncryption] [[-CertificatePassword] <SecureString>] - [[-StorageUri] <Uri>] [[-StorageKey] <SecureString>] [-BackupSystemDbs] [-BackupScheduleType <String>] - [-FullBackupFrequency <String>] [-FullBackupStartHour <Int32>] [-FullBackupWindowInHours <Int32>] - [-LogBackupFrequencyInMinutes <Int32>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### StorageContextSqlServerAutoBackup -``` -New-AzureRmVMSqlServerAutoBackupConfig [-ResourceGroupName] <String> [-Enable] - [[-RetentionPeriodInDays] <Int32>] [-EnableEncryption] [[-CertificatePassword] <SecureString>] - [[-StorageContext] <IStorageContext>] [[-StorageUri] <Uri>] [[-StorageKey] <SecureString>] [-BackupSystemDbs] - [-BackupScheduleType <String>] [-FullBackupFrequency <String>] [-FullBackupStartHour <Int32>] - [-FullBackupWindowInHours <Int32>] [-LogBackupFrequencyInMinutes <Int32>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmVMSqlServerAutoBackupConfig** cmdlet creates a configuration object for SQL Server automatic backup. - -## EXAMPLES - -### Example 1: Create an automatic backup configuration using storage URI and account key -``` -PS C:\> $AutoBackupConfig = New-AzureRmVMSqlServerAutoBackupConfig -Enable -RetentionPeriod 10 -StorageUri "\\contoso\StorageGeneral" -StorageKey "< Storage Key for ContosoGeneral >" -Enable : True -EnableEncryption : False -RetentionPeriodInDays : 10 -``` - -This command creates an automatic backup configuration object by specifying storage URI and account key. -Automatic backup is enabled and automatic backups are kept for 10 days. -The command stores the result in the $AutoBackupConfig variable. -You can specify this configuration item for other cmdlets, such as the Set-AzureRmVMSqlServerExtension cmdlet. - -### Example 2: Create an automatic backup configuration using storage context -``` -PS C:\> $StorageContext = New-AzureStorageContext -StorageAccountName "ContosoGeneral" -StorageAccountKey "< Storage Key for ContosoGeneral >" -PS C:\> $AutoBackupConfig = New-AzureRmVMSqlServerAutoBackupConfig -StorageContext $StorageContext -Enable -RetentionPeriod 10 -Enable : True -EnableEncryption : False -RetentionPeriodInDays : 10 -``` - -The first command creates a storage context, and then stores it in the $StorageContext variable. -For more information, see New-AzureStorageContext. -The second command creates an automatic backup configuration object by specifying the storage context in $StorageContext. -Automatic backup is enabled and automatic backups are kept for 10 days. - -### Example 3: Create an automatic backup configuration using storage context with encryption and password -``` -PS C:\> $StorageContext = New-AzureRmVMSqlServerAutoBackupConfig -StorageContext $StorageContext -Enable -RetentionPeriod 10 -EnableEncryption -CertificatePassword $CertificatePassword -Enable : True -EnableEncryption : True -RetentionPeriodInDays : 10 -``` - -This command creates and stores an automatic backup configuration object. -The command specifies the storage context created in a previous example. -The command enables encryption with password. -The password was previously stored as a secure string in the $CertificatePassword variable. -To create a secure string, use the ConvertTo-SecureString cmdlet. - -## PARAMETERS - -### -BackupScheduleType -Backup schedule type, manual or automated - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Manual, Automated - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BackupSystemDbs -Backup system databases - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CertificatePassword -Specifies a password to encrypt the certificate that is used to perform SQL Server encrypted backups. - -```yaml -Type: System.Security.SecureString -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enable -Indicates that automated backup for the SQL Server virtual machine is enabled. -If you specify this parameter, automated backup sets a backup schedule for all current and new databases. -This updates your Managed Backup settings to follow this schedule. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableEncryption -Indicates that this cmdlet enables encryption. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FullBackupFrequency -Sql Server Full Backup frequency, daily or weekly - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Daily, Weekly - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FullBackupStartHour -Hour of the day (0-23) when the Sql Server Full Backup should start - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FullBackupWindowInHours -Sql Server Full Backup window in hours - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogBackupFrequencyInMinutes -Sql Server Log Backup frequency, once every 1-60 minutes - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RetentionPeriodInDays -Specifies the number of days to retain a backup. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageContext -Specifies the storage account that will be used to store backups. -To obtain an **AzureStorageContext** object, use the New-AzureStorageContext cmdlet. -The default is the storage account that is associated with the SQL Server virtual machine. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: StorageContextSqlServerAutoBackup -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageKey -Specifies the storage key of the blob storage account. - -```yaml -Type: System.Security.SecureString -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageUri -Specifies the Uniform Resource Identifier (URI) of the blob storage account. - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -### System.Int32 - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -### System.Uri - -### System.Security.SecureString - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.AutoBackupSettings - -## NOTES - -## RELATED LINKS - - -[Set-AzureRmVMSqlServerExtension](./Set-AzureRMVMSqlServerExtension.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmVMSqlServerAutoPatchingConfig.md b/azurermps-6.13.0/AzureRM.Compute/New-AzureRmVMSqlServerAutoPatchingConfig.md deleted file mode 100644 index 33e3ad3e84..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmVMSqlServerAutoPatchingConfig.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 7016BAA9-C25D-404E-9F75-2BE49FBF91A8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermvmsqlserverautopatchingconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmVMSqlServerAutoPatchingConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmVMSqlServerAutoPatchingConfig.md ---- - -# New-AzureRmVMSqlServerAutoPatchingConfig - -## SYNOPSIS -Creates a configuration object for automatic patching on a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmVMSqlServerAutoPatchingConfig [-Enable] [-DayOfWeek <String>] - [-MaintenanceWindowStartingHour <Int32>] [-MaintenanceWindowDuration <Int32>] [-PatchCategory <String>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmVMSqlServerAutoPatchingConfig** cmdlet creates a configuration object for automatic patching on a virtual machine. - -## EXAMPLES - -### Example 1: Create a configuration object to configure automatic patching -``` -PS C:\> $AutoPatchingConfig = New-AzureRmVMSqlServerAutoPatchingConfig -Enable -DayOfWeek "Thursday" -MaintenanceWindowStartingHour 11 -MaintenanceWindowDuration 120 -PatchCategory "Important" -Enable : True -DayOfWeek : Thursday -MaintenanceWindowStartingHour : 11 -MaintenanceWindowDuration : 120 -PatchCategory : Important -``` - -This command creates configuration object for patching. -The command specifies the day of the week and defines the maintenance window. -This configuration enables patching that uses these values. -The command stores the result in the $AutoBackupConfig variable. -You can specify this configuration item for other cmdlets, such as the Set-AzureRmVMSqlServerExtension cmdlet. - -## PARAMETERS - -### -DayOfWeek -Specifies the day of the week when updates should be installed. -The acceptable values for this parameter are: -- Sunday -- Monday -- Tuesday -- Wednesday -- Thursday -- Friday -- Saturday -- Everyday - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Everyday - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enable -Indicates that automated patching for the virtual machine is enabled. -If you enable automated patching the cmdlet puts Windows Update into interactive mode. -If you disable automated patching, Windows Update settings do not change. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaintenanceWindowDuration -Specifies the duration, in minutes, of the maintenance window. -Automated patching avoids performing an action that can affect a virtual machine availability outside that window. -Specify a multiple of 30 minutes. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaintenanceWindowStartingHour -Specifies the hour of the day when maintenance window starts. -This time defines when updates start to install. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PatchCategory -Specifies whether important updates should be included. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Important - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.AutoPatchingSettings - -## NOTES - -## RELATED LINKS - - -[Set-AzureRmVMSqlServerExtension](./Set-AzureRMVMSqlServerExtension.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmVMSqlServerKeyVaultCredentialConfig.md b/azurermps-6.13.0/AzureRM.Compute/New-AzureRmVMSqlServerKeyVaultCredentialConfig.md deleted file mode 100644 index 8b8bf12197..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmVMSqlServerKeyVaultCredentialConfig.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: B30C2BDD-6DA9-47B5-88FE-3AD43E15A072 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermvmsqlserverkeyvaultcredentialconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmVMSqlServerKeyVaultCredentialConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmVMSqlServerKeyVaultCredentialConfig.md ---- - -# New-AzureRmVMSqlServerKeyVaultCredentialConfig - -## SYNOPSIS -Creates a configuration object for SQL server key vault credential on a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmVMSqlServerKeyVaultCredentialConfig [-ResourceGroupName] <String> [-Enable] - [-CredentialName <String>] [-AzureKeyVaultUrl <String>] [-ServicePrincipalName <String>] - [-ServicePrincipalSecret <SecureString>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION - -## EXAMPLES - -## PARAMETERS - -### -AzureKeyVaultUrl -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CredentialName -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Enable -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServicePrincipalName -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServicePrincipalSecret -```yaml -Type: System.Security.SecureString -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -### System.Security.SecureString - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.KeyVaultCredentialSettings - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmVmss.md b/azurermps-6.13.0/AzureRM.Compute/New-AzureRmVmss.md deleted file mode 100644 index 6e155387d7..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmVmss.md +++ /dev/null @@ -1,699 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 1A2C843C-6962-4B0E-ACBF-A5EFF609A5BE -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermvmss -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmVmss.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmVmss.md ---- - -# New-AzureRmVmss - -## SYNOPSIS -Creates a VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameter (Default) -``` -New-AzureRmVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> - [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SimpleParameterSet -``` -New-AzureRmVmss [[-ResourceGroupName] <String>] [-VMScaleSetName] <String> [-AsJob] [-ImageName <String>] - -Credential <PSCredential> [-InstanceCount <Int32>] [-VirtualNetworkName <String>] [-SubnetName <String>] - [-PublicIpAddressName <String>] [-DomainNameLabel <String>] [-SecurityGroupName <String>] - [-LoadBalancerName <String>] [-BackendPort <Int32[]>] [-Location <String>] [-VmSize <String>] - [-UpgradePolicyMode <UpgradeMode>] [-AllocationMethod <String>] [-VnetAddressPrefix <String>] - [-SubnetAddressPrefix <String>] [-FrontendPoolName <String>] [-BackendPoolName <String>] - [-SystemAssignedIdentity] [-UserAssignedIdentity <String>] - [-Zone <System.Collections.Generic.List`1[System.String]>] [-NatBackendPort <Int32[]>] - [-DataDiskSizeInGb <Int32[]>] [-DefaultProfile <IAzureContextContainer>] [-SinglePlacementGroup] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmVmss** cmdlet creates a Virtual Machine Scale Set (VMSS) in Azure. -Use the simple parameter set (`SimpleParameterSet`) to quickly create a pre-set VMSS and associated resources. Use the default parameter set (`DefaultParameter`) for more advanced scenarios when you need to precisely configure each component of the VMSS and each associated resource before creation. - -## EXAMPLES - -### Example 1: Create a VMSS using the **`SimpleParameterSet`** -```powershell -$vmssName = <VMSSNAME> -# Create credentials, I am using one way to create credentials, there are others as well. -# Pick one that makes the most sense according to your use case. -$vmPassword = ConvertTo-SecureString <PASSWORD_HERE> -AsPlainText -Force -$vmCred = New-Object System.Management.Automation.PSCredential(<USERNAME_HERE>, $vmPassword) - -#Create a VMSS using the default settings -New-AzureRmVmss -Credential $vmCred -VMScaleSetName $vmssName -``` - -The command above creates the following with the name `$vmssName` : -* A Resource Group -* A virtual network -* A load balancer -* A public IP -* the VMSS with 2 instances - -The default image chosen for the VMs in the VMSS is `2016-Datacenter Windows Server` and the SKU is `Standard_DS1_v2` - -### Example 2: Create a VMSS using the **`DefaultParameterSet`** -```powershell -# Common -$LOC = "WestUs"; -$RGName = "rgkyvms"; - -New-AzureRmResourceGroup -Name $RGName -Location $LOC -Force; - -# SRP -$STOName = "STO" + $RGName; -$STOType = "Standard_GRS"; -New-AzureRmStorageAccount -ResourceGroupName $RGName -Name $STOName -Location $LOC -Type $STOType; -$STOAccount = Get-AzureRmStorageAccount -ResourceGroupName $RGName -Name $STOName; - -# NRP -$SubNet = New-AzureRmVirtualNetworkSubnetConfig -Name ("subnet" + $RGName) -AddressPrefix "10.0.0.0/24"; -$VNet = New-AzureRmVirtualNetwork -Force -Name ("vnet" + $RGName) -ResourceGroupName $RGName -Location $LOC -AddressPrefix "10.0.0.0/16" -DnsServer "10.1.1.1" -Subnet $SubNet; -$VNet = Get-AzureRmVirtualNetwork -Name ('vnet' + $RGName) -ResourceGroupName $RGName; -$SubNetId = $VNet.Subnets[0].Id; - -$PubIP = New-AzureRmPublicIpAddress -Force -Name ("PubIP" + $RGName) -ResourceGroupName $RGName -Location $LOC -AllocationMethod Dynamic -DomainNameLabel ("PubIP" + $RGName); -$PubIP = Get-AzureRmPublicIpAddress -Name ("PubIP" + $RGName) -ResourceGroupName $RGName; - -# Create LoadBalancer -$FrontendName = "fe" + $RGName -$BackendAddressPoolName = "bepool" + $RGName -$ProbeName = "vmssprobe" + $RGName -$InboundNatPoolName = "innatpool" + $RGName -$LBRuleName = "lbrule" + $RGName -$LBName = "vmsslb" + $RGName - -$Frontend = New-AzureRmLoadBalancerFrontendIpConfig -Name $FrontendName -PublicIpAddress $PubIP -$BackendAddressPool = New-AzureRmLoadBalancerBackendAddressPoolConfig -Name $BackendAddressPoolName -$Probe = New-AzureRmLoadBalancerProbeConfig -Name $ProbeName -RequestPath healthcheck.aspx -Protocol http -Port 80 -IntervalInSeconds 15 -ProbeCount 2 -$InboundNatPool = New-AzureRmLoadBalancerInboundNatPoolConfig -Name $InboundNatPoolName -FrontendIPConfigurationId ` - $Frontend.Id -Protocol Tcp -FrontendPortRangeStart 3360 -FrontendPortRangeEnd 3362 -BackendPort 3370; -$LBRule = New-AzureRmLoadBalancerRuleConfig -Name $LBRuleName ` - -FrontendIPConfiguration $Frontend -BackendAddressPool $BackendAddressPool ` - -Probe $Probe -Protocol Tcp -FrontendPort 80 -BackendPort 80 ` - -IdleTimeoutInMinutes 15 -EnableFloatingIP -LoadDistribution SourceIP; -$ActualLb = New-AzureRmLoadBalancer -Name $LBName -ResourceGroupName $RGName -Location $LOC ` - -FrontendIpConfiguration $Frontend -BackendAddressPool $BackendAddressPool ` - -Probe $Probe -LoadBalancingRule $LBRule -InboundNatPool $InboundNatPool; -$ExpectedLb = Get-AzureRmLoadBalancer -Name $LBName -ResourceGroupName $RGName - -# New VMSS Parameters -$VMSSName = "VMSS" + $RGName; - -$AdminUsername = "Admin01"; -$AdminPassword = "p4ssw0rd@123" + $RGName; - -$PublisherName = "MicrosoftWindowsServer" -$Offer = "WindowsServer" -$Sku = "2012-R2-Datacenter" -$Version = "latest" - -$VHDContainer = "https://" + $STOName + ".blob.core.contoso.net/" + $VMSSName; - -$ExtName = "CSETest"; -$Publisher = "Microsoft.Compute"; -$ExtType = "BGInfo"; -$ExtVer = "2.1"; - -#IP Config for the NIC -$IPCfg = New-AzureRmVmssIPConfig -Name "Test" ` - -LoadBalancerInboundNatPoolsId $ExpectedLb.InboundNatPools[0].Id ` - -LoadBalancerBackendAddressPoolsId $ExpectedLb.BackendAddressPools[0].Id ` - -SubnetId $SubNetId; - -#VMSS Config -$VMSS = New-AzureRmVmssConfig -Location $LOC -SkuCapacity 2 -SkuName "Standard_A2" -UpgradePolicyMode "Automatic" ` - | Add-AzureRmVmssNetworkInterfaceConfiguration -Name "Test" -Primary $True -IPConfiguration $IPCfg ` - | Add-AzureRmVmssNetworkInterfaceConfiguration -Name "Test2" -IPConfiguration $IPCfg ` - | Set-AzureRmVmssOSProfile -ComputerNamePrefix "Test" -AdminUsername $AdminUsername -AdminPassword $AdminPassword ` - | Set-AzureRmVmssStorageProfile -Name "Test" -OsDiskCreateOption 'FromImage' -OsDiskCaching "None" ` - -ImageReferenceOffer $Offer -ImageReferenceSku $Sku -ImageReferenceVersion $Version ` - -ImageReferencePublisher $PublisherName -VhdContainer $VHDContainer ` - | Add-AzureRmVmssExtension -Name $ExtName -Publisher $Publisher -Type $ExtType -TypeHandlerVersion $ExtVer -AutoUpgradeMinorVersion $True - -#Create the VMSS -New-AzureRmVmss -ResourceGroupName $RGName -Name $VMSSName -VirtualMachineScaleSet $VMSS; -``` - -The complex example above creates a VMSS, following is an explanation of what is happening: -* The first command creates a resource group with the specified name and location. -* The second command uses the **New-AzureRmStorageAccount** cmdlet to create a storage account. -* The third command then uses the **Get-AzureRmStorageAccount** cmdlet to get the storage account created in the second command and stores the result in the $STOAccount variable. -* The fifth command uses the **New-AzureRmVirtualNetworkSubnetConfig** cmdlet to create a subnet and stores the result in the variable named $SubNet. -* The sixth command uses the **New-AzureRmVirtualNetwork** cmdlet to create a virtual network and stores the result in the variable named $VNet. -* The seventh command uses the **Get-AzureRmVirtualNetwork** to get information about the virtual network created in the sixth command and stores the information in the variable named $VNet. -* The eighth and ninth command uses the **New-AzureRmPublicIpAddress** and **Get- AzureRmPublicIpAddress** to create and get information from that public IP address. -* The commands store the information in the variable named $PubIP. -* The tenth command uses the **New- AzureRmLoadBalancerFrontendIpConfig** cmdlet to create a frontend load balancer and stores the result in the variable named $Frontend. -* The eleventh command uses the **New-AzureRmLoadBalancerBackendAddressPoolConfig** to create a backend address pool configuration and stores the result in the variable named $BackendAddressPool. -* The twelfth command uses the **New-AzureRmLoadBalancerProbeConfig** to create a probe and stores the probe information in the variable named $Probe. -* The thirteenth command uses the **New-AzureRmLoadBalancerInboundNatPoolConfig** cmdlet to create a load balancer inbound network address translation (NAT) pool configuration. -* The fourteenth command uses the **New-AzureRmLoadBalancerRuleConfig** to create a load balancer rule configuration and stores the result in the variable named $LBRule. -* The fifteenth command uses the **New-AzureRmLoadBalancer** cmdlet to create a load balancer and stores the result in the variable named $ActualLb. -* The sixteenth command uses the **Get-AzureRmLoadBalancer** to get information about the load balancer that was created in the fifteenth command and stores the information in the variable named $ExpectedLb. -* The seventeenth command uses the **New-AzureRmVmssIPConfig** cmdlet to create a VMSS IP configuration and stores the information in the variable named $IPCfg. -* The eighteenth command uses the **New-AzureRmVmssConfig** cmdlet to create a VMSS configuration object and stores the result in the variable named $VMSS. -* The nineteenth command uses the **New-AzureRmVmss** cmdlet to create the VMSS. - -## PARAMETERS - -### -AllocationMethod -Allocation method for the Public IP Address of the Scale Set (Static or Dynamic). If no value is supplied, allocation will be static. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet -Aliases: -Accepted values: Static, Dynamic - -Required: False -Position: Named -Default value: Static -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendPoolName -The name of the backend address pool to use in the load balancer for this Scale Set. If no value is provided, a new backend pool will be created, with the same name as the Scale Set. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendPort -Backend port numbers used by the Scale Set load balancer to communicate with VMs in the Scale Set. If no values are specified, ports 3389 and 5985 will be used for Windows VMS, and port 22 will be used for Linux VMs. - -```yaml -Type: System.Int32[] -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -The administrator credentials (username and password) for VMs in this Scale Set. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: SimpleParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataDiskSizeInGb -Specifies the sizes of data disks in GB. - -```yaml -Type: System.Int32[] -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainNameLabel -The domain name label for the public Fully-Qualified domain name (FQDN) for this Scale Set. This is the first component of the domain name that is automatically assigned to the Scale Set. Automatically assigned Domain names use the form (`<DomainNameLabel>.<Location>.cloudapp.azure.com`). If no value is supplied, the default domain name label will be the concatenation of `<ScaleSetName>` and `<ResourceGroupName>`. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendPoolName -The name of the frontend address pool to use in the Scale Set load balancer. If no value is supplied, a new Frontend Address Pool will be created, with the same name as the scale set. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImageName -The name of the image for VMs in this Scale Set. If no value is provided, the "Windows Server 2016 DataCenter" image will be used. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceCount -The number of VM images in the Scale Set. If no value is provided, 2 instances will be created. - -```yaml -Type: System.Int32 -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: 2 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancerName -The name of the load balancer to use with this Scale Set. A new load balancer using the same name as the Scale Set will be created if no value is specified. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The Azure location where this Scale Set will be created. If no value is specified, the location will be inferred from the location of other resources referenced in the parameters. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NatBackendPort -Backend port for inbound network address translation. - -```yaml -Type: System.Int32[] -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIpAddressName -The name of the public IP Address to use with this scale set. A new Public IPAddress with the same name as the Scale Set will be created if no value is provided. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the VMSS. If no value is specified, a new ResourceGroup will be created using the same name as the Scale Set. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecurityGroupName -The name of the network security group to apply to this Scale Set. If no value is provided, a default network security group with the same name as the Scale Set will be created and applied to the Scale Set. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SinglePlacementGroup -Use this to create the Scale set in a single placement group, default is multiple groups - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetAddressPrefix -The address prefix of the Subnet this ScaleSet will use. Default Subnet settings (192.168.1.0/24) will be applied if no value is provided. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: 192.168.1.0/24 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetName -The name of the subnet to use with this Scale Set. A new Subnet will be created with the same name as the Scale Set if no value is provided. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SystemAssignedIdentity -If the parameter is present then the VM(s) in the scale set is(are) assigned a managed system identity that is auto generated. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UpgradePolicyMode -The upgrade policy mode for VM instances in this Scale Set. Upgrade policy could specify Automatic, Manual, or Rolling upgrades. - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.UpgradeMode -Parameter Sets: SimpleParameterSet -Aliases: -Accepted values: Automatic, Manual, Rolling - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserAssignedIdentity -The name of a managed service identity that should be assigned to the VM(s) in the scale set. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specifies the **VirtualMachineScaleSet** object that contains the properties of the VMSS that this cmdlet creates. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VirtualNetworkName -The name fo the Virtual Network to use with this scale set. If no value is supplied, a new virtual network with the same name as the Scale Set will be created. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMScaleSetName -Specifies the name of the VMSS that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VmSize -The size of the VM instances in this scale set. A default size (Standard_DS1_v2) will be used if no Size is specified. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: Standard_DS1_v2 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VnetAddressPrefix -The address prefix for the virtual network used with this Scale Set. Default virtual network address prefix settings (192.168.0.0/16) will be used if no value is supplied. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: 192.168.0.0/16 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Zone -A list of availability zones denoting the IP allocated for the resource needs to come from. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet -Parameters: VirtualMachineScaleSet (ByValue) - -### System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVmss](./Get-AzureRmVmss.md) - -[Remove-AzureRmVmss](./Remove-AzureRmVmss.md) - -[Restart-AzureRmVmss](./Restart-AzureRmVmss.md) - -[Set-AzureRmVmss](./Set-AzureRmVmss.md) - -[Start-AzureRmVmss](./Start-AzureRmVmss.md) - -[Stop-AzureRmVmss](./Stop-AzureRmVmss.md) - -[Update-AzureRmVmss](./Update-AzureRmVmss.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmVmssConfig.md b/azurermps-6.13.0/AzureRM.Compute/New-AzureRmVmssConfig.md deleted file mode 100644 index 022b658b06..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmVmssConfig.md +++ /dev/null @@ -1,673 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: CE32F620-8DB2-4004-8012-F1C4AA235B60 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermvmssconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmVmssConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmVmssConfig.md ---- - -# New-AzureRmVmssConfig - -## SYNOPSIS -Creates a VMSS configuration object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameterSet (Default) -``` -New-AzureRmVmssConfig [[-Overprovision] <Boolean>] [[-Location] <String>] [[-Tag] <Hashtable>] - [[-SkuName] <String>] [[-SkuTier] <String>] [[-SkuCapacity] <Int32>] [[-UpgradePolicyMode] <UpgradeMode>] - [[-OsProfile] <VirtualMachineScaleSetOSProfile>] [[-StorageProfile] <VirtualMachineScaleSetStorageProfile>] - [[-NetworkInterfaceConfiguration] <VirtualMachineScaleSetNetworkConfiguration[]>] - [[-Extension] <VirtualMachineScaleSetExtension[]>] [-SinglePlacementGroup <Boolean>] [-ZoneBalance] - [-PlatformFaultDomainCount <Int32>] [-Zone <String[]>] [-PlanName <String>] [-PlanPublisher <String>] - [-PlanProduct <String>] [-PlanPromotionCode <String>] [-RollingUpgradePolicy <RollingUpgradePolicy>] - [-AutoOSUpgrade] [-DisableAutoRollback <Boolean>] [-EnableUltraSSD] [-HealthProbeId <String>] - [-BootDiagnostic <BootDiagnostics>] [-LicenseType <String>] [-Priority <String>] [-EvictionPolicy <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ExplicitIdentityParameterSet -``` -New-AzureRmVmssConfig [[-Overprovision] <Boolean>] [[-Location] <String>] [[-Tag] <Hashtable>] - [[-SkuName] <String>] [[-SkuTier] <String>] [[-SkuCapacity] <Int32>] [[-UpgradePolicyMode] <UpgradeMode>] - [[-OsProfile] <VirtualMachineScaleSetOSProfile>] [[-StorageProfile] <VirtualMachineScaleSetStorageProfile>] - [[-NetworkInterfaceConfiguration] <VirtualMachineScaleSetNetworkConfiguration[]>] - [[-Extension] <VirtualMachineScaleSetExtension[]>] [-SinglePlacementGroup <Boolean>] [-ZoneBalance] - [-PlatformFaultDomainCount <Int32>] [-Zone <String[]>] [-PlanName <String>] [-PlanPublisher <String>] - [-PlanProduct <String>] [-PlanPromotionCode <String>] [-RollingUpgradePolicy <RollingUpgradePolicy>] - [-AutoOSUpgrade] [-DisableAutoRollback <Boolean>] [-EnableUltraSSD] [-HealthProbeId <String>] - [-BootDiagnostic <BootDiagnostics>] [-LicenseType <String>] [-Priority <String>] [-EvictionPolicy <String>] - -IdentityType <ResourceIdentityType> [-IdentityId <String[]>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### AssignIdentityParameterSet -``` -New-AzureRmVmssConfig [[-Overprovision] <Boolean>] [[-Location] <String>] [[-Tag] <Hashtable>] - [[-SkuName] <String>] [[-SkuTier] <String>] [[-SkuCapacity] <Int32>] [[-UpgradePolicyMode] <UpgradeMode>] - [[-OsProfile] <VirtualMachineScaleSetOSProfile>] [[-StorageProfile] <VirtualMachineScaleSetStorageProfile>] - [[-NetworkInterfaceConfiguration] <VirtualMachineScaleSetNetworkConfiguration[]>] - [[-Extension] <VirtualMachineScaleSetExtension[]>] [-SinglePlacementGroup <Boolean>] [-ZoneBalance] - [-PlatformFaultDomainCount <Int32>] [-Zone <String[]>] [-PlanName <String>] [-PlanPublisher <String>] - [-PlanProduct <String>] [-PlanPromotionCode <String>] [-RollingUpgradePolicy <RollingUpgradePolicy>] - [-AutoOSUpgrade] [-DisableAutoRollback <Boolean>] [-EnableUltraSSD] [-HealthProbeId <String>] - [-BootDiagnostic <BootDiagnostics>] [-LicenseType <String>] [-Priority <String>] [-EvictionPolicy <String>] - [-AssignIdentity] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmVmssConfig** cmdlet creates a configurable local Virtual Manager Scale Set (VMSS) -object. Other cmdlets are needed to configure the VMSS object. These cmdlets are: -- Set-AzureRmVmssOsProfile -- Set-AzureRmVmssStorageProfile -- Add-AzureRmVmssNetworkInterfaceConfiguration -- Add-AzureRmVmssExtension - -## EXAMPLES - -### Example 1: Create a VMSS configuration object -``` -PS C:\> $VMSS = New-AzureRmVmssConfig -Location $Loc -SkuCapacity 2 -SkuName "Standard_A0" -UpgradePolicyMode "Automatic" -NetworkInterfaceConfiguration $NetCfg ` - | Add-AzureRmVmssNetworkInterfaceConfiguration -Name "Test" -Primary $True -IPConfiguration $IPCfg ` - | Set-AzureRmVmssOSProfile -ComputerNamePrefix "Test" -AdminUsername $adminUsername -AdminPassword $AdminPassword ` - | Set-AzureRmVmssStorageProfile -Name "Test" -OsDiskCreateOption "FromImage" -OsDiskCaching "None" ` - -ImageReferenceOffer $ImgRef.Offer -ImageReferenceSku $ImgRef.Skus -ImageReferenceVersion $ImgRef.Version ` - -ImageReferencePublisher $ImgRef.PublisherName -VhdContainer $VHDContainer ` - | Add-AzureRmVmssAdditionalUnattendContent -ComponentName $AUCComponentName -Content $AUCContent -PassName $AUCPassName -SettingName $AUCSetting ` - | Remove-AzureRmVmssAdditionalUnattendContent -ComponentName $AUCComponentName; - -New-AzureRmVmss -ResourceGroupName $RGName -Name $VMSSName -VirtualMachineScaleSet $VMSS; -``` - -This example creates a VMSS configuration object. The first command uses the -**New-AzureRmVmssConfig** cmdlet to create a VMSS configuration object and stores the result in the -variable named $VMSS. The second command uses the **New-AzureRmVmss** cmdlet to create a VMSS that -uses the VMSS configuration object created in the first command. - -## PARAMETERS - -### -AssignIdentity -Specify the system assigned identity for the virtual machine scale set. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: AssignIdentityParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoOSUpgrade -Sets whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BootDiagnostic -Specifies the virtual machine scale set boot diagnostics profile. - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.BootDiagnostics -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableAutoRollback -Disable Auto Rollback for Auto OS Upgrade Policy - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableUltraSSD -Enables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the virtual machine scale set. -Managed disks with storage account type UltraSSD_LRS can be added to a VMSS only if this property is enabled. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EvictionPolicy -Specifies the eviction policy for the virtual machines in the scale set. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Extension -Specifies the extension information object for the VMSS. You can use the -**Add-AzureRmVmssExtension** cmdlet to add this object. - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetExtension[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 10 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HealthProbeId -Specifies the ID of a load balancer probe used to determine the health of an instance in the virtual machine scale set. -HealthProbeId is in the form of '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IdentityId -Specifies the list of user identities associated with the virtual machine scale set. -The user identity references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}' - -```yaml -Type: System.String[] -Parameter Sets: ExplicitIdentityParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IdentityType -Specifies the type of identity used for the virtual machine scale set. -The type 'SystemAssignedUserAssigned' includes both an implicitly created identity and a set of user assigned identities. -The type 'None' will remove any identities from the virtual machine scale set. -The acceptable values for this parameter are: -- SystemAssigned -- UserAssigned -- SystemAssignedUserAssigned -- None - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.ResourceIdentityType] -Parameter Sets: ExplicitIdentityParameterSet -Aliases: -Accepted values: SystemAssigned, UserAssigned, SystemAssignedUserAssigned, None - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LicenseType -Specify the license type, which is for bringing your own license scenario. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the Azure location where the VMSS is created. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkInterfaceConfiguration -Specifies the network profile object that contains the networking properties for the VMSS configuration. -You can use the **Add-AzureRmVmssNetworkInterfaceConfiguration** cmdlet to add this object. - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetNetworkConfiguration[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 9 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OsProfile -Specifies the operating system profile object that contains the operating system properties for the VMSS configuration. -You can use the **Set-AzureRmVmssOsProfile** cmdlet to set this object. - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetOSProfile -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Overprovision -Indicates whether the cmdlet overprovisions the VMSS. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PlanName -Specifies the plan name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PlanProduct -Specifies the plan product. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PlanPromotionCode -Specifies the plan promotion code. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PlanPublisher -Specifies the plan publisher. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PlatformFaultDomainCount -Fault Domain count for each placement group. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Priority -Specifies the priority for the virtual machines in the scale set. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RollingUpgradePolicy -Specifies the rolling upgrade policy. - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.RollingUpgradePolicy -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SinglePlacementGroup -Specifies the single placement group. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuCapacity -Specifies the number of instances in the VMSS. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuName -Specifies the size of all the instances of VMSS. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountType - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuTier -Specifies the tier of VMSS. The acceptable values for this parameter are: -- Standard -- Basic - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageProfile -Specifies the storage profile object that contains the disk properties for the VMSS configuration. -You can use the **Set-AzureRmVmssStorageProfile** cmdlet to set this object. - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetStorageProfile -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UpgradePolicyMode -Specified the mode of an upgrade to virtual machines in the scale set. -The acceptable values for this parameter are: -- Automatic -- Manual - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.UpgradeMode] -Parameter Sets: (All) -Aliases: -Accepted values: Automatic, Manual, Rolling - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Zone -Specifies the zone list for the virtual machine scale set. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ZoneBalance -Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.String - -### System.Collections.Hashtable - -### System.Int32 - -### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.UpgradeMode, Microsoft.Azure.Management.Compute, Version=21.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -### Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetOSProfile - -### Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetStorageProfile - -### Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetNetworkConfiguration[] - -### Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetExtension[] - -### System.String[] - -### Microsoft.Azure.Management.Compute.Models.RollingUpgradePolicy - -### Microsoft.Azure.Management.Compute.Models.BootDiagnostics - -### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.ResourceIdentityType, Microsoft.Azure.Management.Compute, Version=21.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -## NOTES - -## RELATED LINKS - -[Set-AzureRmVmssOsProfile](./Set-AzureRmVmssOsProfile.md) - -[Set-AzureRmVmssStorageProfile](./Set-AzureRmVmssStorageProfile.md) - -[Add-AzureRmVmssNetworkInterfaceConfiguration](./Add-AzureRmVmssNetworkInterfaceConfiguration.md) - -[Add-AzureRmVmssExtension](./Add-AzureRmVmssExtension.md) - -[New-AzureRmVmss](./New-AzureRmVmss.md) diff --git a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmVmssIpConfig.md b/azurermps-6.13.0/AzureRM.Compute/New-AzureRmVmssIpConfig.md deleted file mode 100644 index f759daf346..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmVmssIpConfig.md +++ /dev/null @@ -1,327 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 92F192A5-F75E-4EFE-B2D2-B0DF0B78D3B5 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermvmssipconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmVmssIpConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmVmssIpConfig.md ---- - -# New-AzureRmVmssIpConfig - -## SYNOPSIS -Creates an IP configuration for a network interface of a VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmVmssIpConfig [[-Name] <String>] [[-Id] <String>] [[-SubnetId] <String>] - [[-ApplicationGatewayBackendAddressPoolsId] <String[]>] [[-LoadBalancerBackendAddressPoolsId] <String[]>] - [[-LoadBalancerInboundNatPoolsId] <String[]>] [-Primary] [-PrivateIPAddressVersion <String>] - [-PublicIPAddressConfigurationName <String>] [-PublicIPAddressConfigurationIdleTimeoutInMinutes <Int32>] - [-DnsSetting <String>] [-IpTag <VirtualMachineScaleSetIpTag[]>] [-PublicIPPrefix <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmVmssIpConfig** cmdlet creates an IP configuration object for a network interface of a Virtual Machine Scale Set (VMSS). -Specify the configuration from this cmdlet as the *IPConfiguration* parameter of the Add-AzureRmVmssNetworkInterfaceConfiguration cmdlet. - -## EXAMPLES - -### Example 1: Create an IP configuration object for a VMSS interface -``` -PS C:\> $IPConfiguration = New-AzureRmVmssIPConfig -Name "ContosoVmssInterface02" -SubnetId $SubnetId -``` - -This command creates an IP configuration object named ContosoVmssInterface02. -The command uses a previously defined subnet ID stored in $SubnetId. -The command stores the configuration settings in the $IPConfiguration variable for later use with **Add-AzureRmVmssNetworkInterfaceConfiguration**. - -### Example 2: Create an IP configuration object that includes NAT pool settings -``` -PS C:\> $IPConfiguration = New-AzureRmVmssIPConfig -Name "ContosoVmssInterface03" -LoadBalancerInboundNatPoolsId $expectedLb.InboundNatPools[0].Id -LoadBalancerBackendAddressPoolsId $expectedLb.BackendAddressPools[0].Id -SubnetId $SubnetId -``` - -This command creates an IP configuration object named ContosoVmssInterface03, and then stores it in the $IPConfiguration variable for later use. -The command uses a previously defined subnet ID stored in $SubnetId. -The command stores the configuration settings in the $IPConfiguration variable for later use. -The command specifies values for the *LoadBalancerInboundNatPoolsId* and *LoadBalancerBackendAddressPoolsId* parameters. - -## PARAMETERS - -### -ApplicationGatewayBackendAddressPoolsId -Specifies an array of references to backend address pools of load balancers. -A scale set can reference backend address pools of one public and one internal load balancer. -Multiple scale sets cannot use the same load balancer. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DnsSetting -The dns settings to be applied on the publicIP addresses. -The domain name label of the Dns settings to be applied on the publicIP addresses. -The concatenation of the domain name label and vm index will be the domain name labels of the Public IP Address resources that will be created. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: PublicIPAddressDomainNameLabel - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Id -Specifies an ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IpTag -Specifies an array of Ip Tag objects. - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetIpTag[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancerBackendAddressPoolsId -Specifies an array of references to incoming network address translation (NAT) pools of the load balancers. -A scale set can reference incoming NAT pools of one public and one internal load balancer. -Multiple scale sets cannot use the same load balancer. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancerInboundNatPoolsId -Specifies an array of references to incoming NAT pools of the load balancers. -A scale set can reference incoming NAT pools of one public and one internal load balancer. -Multiple scale sets cannot use the same load balancer. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the IP configuration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Primary -Specifies the primary IP Configuration in case the network interface has more than one IP Configuration. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateIPAddressVersion -Specify the ip configuration is either IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublicIPAddressConfigurationIdleTimeoutInMinutes -The idle timeout of the public IP address. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: PublicIPAddressIdleTimeoutInMinutes - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublicIPAddressConfigurationName -The publicIP address configuration name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: PublicIPAddressName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublicIPPrefix -The ID of Public IP Prefix - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubnetId -Specifies the subnet ID in which the configuration creates the VMSS network interface. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.String[] - -### System.Int32 - -### Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetIpTag[] - -## OUTPUTS - -### Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetIPConfiguration - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVmssNetworkInterfaceConfiguration](./Add-AzureRmVmssNetworkInterfaceConfiguration.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmVmssIpTagConfig.md b/azurermps-6.13.0/AzureRM.Compute/New-AzureRmVmssIpTagConfig.md deleted file mode 100644 index 252feaa183..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmVmssIpTagConfig.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermvmssiptagconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmVmssIpTagConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmVmssIpTagConfig.md ---- - -# New-AzureRmVmssIpTagConfig - -## SYNOPSIS -Creates an IP Tag object for a network interface of a VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmVmssIpTagConfig [-IpTagType] <String> [-Tag <String>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmVmssIpTagConfig** cmdlet creates an IP Tag configuration object for a network interface of a Virtual Machine Scale Set (VMSS). -Specify the configuration from this cmdlet as the *IPTag* parameter of the New-AzureRmVmssIpConfig cmdlet. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> $iptag = New-AzureRmVmssIpTagConfig -IpTagType 'FirstPartyUsage' -Tag 'Sql' -PS C:\> $ipCfg = New-AzureRmVmssIPConfig -Name 'test' -SubnetId $subnetId -IpTag $ipTag; -``` - -This command creates an IP Tag local object with 'FirstPartyUsage' type and 'Sql' tag, and then creates an IP configuration with this IP tag. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IpTagType -Specifies an IP Tag Type. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Specifies an IP Tag Value. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetIpTag - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmVmssVaultCertificateConfig.md b/azurermps-6.13.0/AzureRM.Compute/New-AzureRmVmssVaultCertificateConfig.md deleted file mode 100644 index 54fda489f3..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/New-AzureRmVmssVaultCertificateConfig.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 5CC89899-00B6-424A-8896-FD32DE9DDA28 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermvmssvaultcertificateconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmVmssVaultCertificateConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmVmssVaultCertificateConfig.md ---- - -# New-AzureRmVmssVaultCertificateConfig - -## SYNOPSIS -Creates a Key Vault certificate configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmVmssVaultCertificateConfig [[-CertificateUrl] <String>] [[-CertificateStore] <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmVmssVaultCertificateConfig** cmdlet specifies the secret that needs to be placed on the Virtual Machine Scale Set (VMSS) virtual machines. -The output of this cmdlet is intended to be used with the Add-AzureRmVmssSecret cmdlet. - -## EXAMPLES - -### Example 1: Create a Key Vault certificate configuration -``` -PS C:\> New-AzureRmVmssVaultCertificateConfig -CertificateUrl "http://keyVaultName.vault.contoso.net/secrets/secretName/secretVersion" -CertificateStore "MyCerts" -``` - -This command creates a Key Vault certificate configuration that uses the certificate store named MyCerts located at the specified certificate URL. - -## PARAMETERS - -### -CertificateStore -Specifies the certificate store on the virtual machines in the scale set where the certificate is added. -This is only valid for Windows Virtual Machine Scale Sets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CertificateUrl -Specifies the URI of a certificate stored in the Key Vault. -It is the base64 encoding of the following JSON Object which is encoded in UTF-8: -{ - "data":"\<Base64-encoded-certificate\>", - "dataType":"pfx", - "password":"\<pfx-file-password\>" -} - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Compute.Models.VaultCertificate - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVmssSecret](./Add-AzureRmVmssSecret.md) diff --git a/azurermps-6.13.0/AzureRM.Compute/Publish-AzureRmVMDscConfiguration.md b/azurermps-6.13.0/AzureRM.Compute/Publish-AzureRmVMDscConfiguration.md deleted file mode 100644 index 71167f63d0..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Publish-AzureRmVMDscConfiguration.md +++ /dev/null @@ -1,301 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: FB9ACBA2-081E-4876-A21A-F5BA11CBEDA2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/publish-azurermvmdscconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Publish-AzureRmVMDscConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Publish-AzureRmVMDscConfiguration.md ---- - -# Publish-AzureRmVMDscConfiguration - -## SYNOPSIS -Uploads a DSC script to Azure blob storage. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### UploadArchive (Default) -``` -Publish-AzureRmVMDscConfiguration [-ResourceGroupName] <String> [-ConfigurationPath] <String> - [[-ContainerName] <String>] [-StorageAccountName] <String> [-StorageEndpointSuffix <String>] [-Force] - [-SkipDependencyDetection] [-ConfigurationDataPath <String>] [-AdditionalPath <String[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### CreateArchive -``` -Publish-AzureRmVMDscConfiguration [-ConfigurationPath] <String> [[-OutputArchivePath] <String>] [-Force] - [-SkipDependencyDetection] [-ConfigurationDataPath <String>] [-AdditionalPath <String[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Publish-AzureRmVMDscConfiguration** cmdlet uploads a Desired State Configuration (DSC) script to Azure blob storage, which later can be applied to Azure virtual machines using the Set-AzureRmVMDscExtension cmdlet. - -## EXAMPLES - -### Example 1: Create a .zip package an upload it to Azure storage -``` -PS C:\> Publish-AzureRmVMDscConfiguration ".\MyConfiguration.ps1" -``` - -This command creates a .zip package for the given script and any dependent resource modules and uploads it to Azure storage. - -### Example 2: Create a .zip package and store it to a local file -``` -PS C:\> Publish-AzureRmVMDscConfiguration ".\MyConfiguration.ps1" -OutputArchivePath ".\MyConfiguration.ps1.zip" -``` - -This command creates a .zip package for the given script and any dependent resource modules and stores it in the local file that is named .\MyConfiguration.ps1.zip. - -### Example 3: Add configuration to the archive and then upload it to storage -``` -PS C:\> Publish-AzureRmVMDscConfiguration -ConfigurationPath "C:\Sample.ps1" -SkipDependencyDetection -``` - -This command adds configuration named Sample.ps1 to the configuration archive to upload to Azure storage and skips dependent resource modules. - -### Example 4: Add configuration and configuration data to the archive and then upload it to storage -``` -PS C:\> Publish-AzureRmVMDscConfiguration -ConfigurationPath "C:\Sample.ps1" -ConfigurationDataPath "C:\SampleData.psd1" -``` - -This command adds configuration named Sample.ps1 and configuration data named SampleData.psd1 to the configuration archive to upload to Azure storage. - -### Example 5: Add configuration, configuration data, and additional content to the archive and then upload it to storage -``` -PS C:\> Publish-AzureRmVMDscConfiguration -ConfigurationPath "C:\Sample.ps1" -AdditionalPath @("C:\ContentDir1", "C:\File.txt") -ConfigurationDataPath "C:\SampleData.psd1" -``` - -This command adds configuration named Sample.ps1, configuration data SampleData.psd1, and additional content to configuration archive to upload to Azure storage. - -## PARAMETERS - -### -AdditionalPath -Specifies the path of a file or a directory to include in the configuration archive. -It gets downloaded to the virtual machine together with the configuration. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConfigurationDataPath -Specifies the path of a .psd1 file that specifies the data for the configuration. -This is added to the configuration archive and then passed to the configuration function. -It gets overwritten by the configuration data path provided through the Set-AzureRmVMDscExtension cmdlet - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConfigurationPath -Specifies the path of a file that contains one or more configurations. -The file can be a Windows PowerShell script (.ps1) file or a Windows PowerShell module (.psm1) file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ContainerName -Specifies the name of the Azure storage container the configuration is uploaded to. - -```yaml -Type: System.String -Parameter Sets: UploadArchive -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutputArchivePath -Specifies the path of a local .zip file to write the configuration archive to. -When this parameter is used, the configuration script is not uploaded to Azure blob storage. - -```yaml -Type: System.String -Parameter Sets: CreateArchive -Aliases: ConfigurationArchivePath - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the storage account. - -```yaml -Type: System.String -Parameter Sets: UploadArchive -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkipDependencyDetection -Indicates that this cmdlet excludes DSC resource dependencies from the configuration archive. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageAccountName -Specifies the Azure storage account name that is used to upload the configuration script to the container specified by the *ContainerName* parameter. - -```yaml -Type: System.String -Parameter Sets: UploadArchive -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageEndpointSuffix -Specifies the suffix for the storage end point. - -```yaml -Type: System.String -Parameter Sets: UploadArchive -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.String[] - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMDscExtension](./Get-AzureRmVMDscExtension.md) - -[Remove-AzureRmVMDscExtension](./Remove-AzureRmVMDscExtension.md) - -[Set-AzureRmVMDscExtension](./Set-AzureRmVMDscExtension.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRMVMSqlServerExtension.md b/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRMVMSqlServerExtension.md deleted file mode 100644 index d72a89848e..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRMVMSqlServerExtension.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: B02CEAC8-C838-4890-8C21-9897CA39EF45 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmsqlserverextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRMVMSqlServerExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRMVMSqlServerExtension.md ---- - -# Remove-AzureRmVMSqlServerExtension - -## SYNOPSIS -Removes a SQL Server extension from a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVMSqlServerExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVMSqlServerExtension** cmdlet removes an AzureSQL Server extension from a virtual machine. - -## EXAMPLES - -### Example 1: Remove a SQL Server extension -``` -PS C:\> Remove-AzureRMVMSqlServerExtension -ResourceGroupName "ResourceGroup11" -VMName "ContosoVM22" -Name "SqlIaaSAgent" -``` - -This command removes a SQL Server extension from the virtual machine named ContosoVM22. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the SQL Server the extension that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine from which this cmdlet removes the SQL Server extension. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMSqlServerExtension](./Get-AzureRMVMSqlServerExtension.md) - -[Set-AzureRmVMSqlServerExtension](./Set-AzureRMVMSqlServerExtension.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmAvailabilitySet.md b/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmAvailabilitySet.md deleted file mode 100644 index 575c1621c0..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmAvailabilitySet.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 7320B832-50FD-48AE-9089-445318F3B08A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermavailabilityset -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmAvailabilitySet.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmAvailabilitySet.md ---- - -# Remove-AzureRmAvailabilitySet - -## SYNOPSIS -Removes an availability set from Azure. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmAvailabilitySet [-ResourceGroupName] <String> [[-Name] <String>] [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmAvailabilitySet** cmdlet removes an availability set from Azure. - -## EXAMPLES - -### Example 1: Remove an availability set -``` -PS C:\> Remove-AzureRmAvailabilitySet -Name "AvailabilitySet03" -ResourceGroupName "ResourceGroup11" -``` - -This command removes an availability set named AvailablitySet03 in the resource group named ResourceGroup11. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The availability set name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName, AvailabilitySetName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAvailabilitySet](./Get-AzureRmAvailabilitySet.md) - -[New-AzureRmAvailabilitySet](./New-AzureRmAvailabilitySet.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmContainerService.md b/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmContainerService.md deleted file mode 100644 index f7cb8fa3bb..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmContainerService.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 8180092D-5B1D-43A0-B830-D009B30E2DDF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermcontainerservice -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmContainerService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmContainerService.md ---- - -# Remove-AzureRmContainerService - -## SYNOPSIS -Removes a container service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmContainerService [-ResourceGroupName] <String> [-Name] <String> [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmContainerService** cmdlet removes a container service from your Azure account. - -## EXAMPLES - -### Example 1: Remove a container service -``` -PS C:\> Remove-AzureRmContainerService -ResourceGroupName "ResourceGroup17" -Name "CSResourceGroup17" -``` - -This command removes the container service named CSResourceGroup17. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the container service that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group of the container service that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmContainerService](./Get-AzureRmContainerService.md) - -[New-AzureRmContainerService](./New-AzureRmContainerService.md) - -[Update-AzureRmContainerService](./Update-AzureRmContainerService.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmContainerServiceAgentPoolProfile.md b/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmContainerServiceAgentPoolProfile.md deleted file mode 100644 index 7963fdce03..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmContainerServiceAgentPoolProfile.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: ED37B17D-C513-422A-89EA-A6AF1C9A5FEE -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermcontainerserviceagentpoolprofile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmContainerServiceAgentPoolProfile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmContainerServiceAgentPoolProfile.md ---- - -# Remove-AzureRmContainerServiceAgentPoolProfile - -## SYNOPSIS -Removes an agent pool profile from a container service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmContainerServiceAgentPoolProfile [-ContainerService] <PSContainerService> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmContainerServiceAgentPoolProfile** cmdlet removes an agent pool profile from a container service. - -## EXAMPLES - -### Example 1: Remove a profile from a container service -``` -PS C:\> $Container = Get-AzureRmContainerService -ResourceGroupName "ResourceGroup17" -Name "CSResourceGroup17" -PS C:\> Remove-AzureRmContainerServiceAgentPoolProfile -ContainerService $Container -Name "AgentPool01" -``` - -The first command gets a container service named CSResourceGroup17 by using the Get-AzureRmContainerService cmdlet. -The command stores the service in the $Container variable. -The second command removes the profile named AgentPool01 from the container service in $Container. - -## PARAMETERS - -### -ContainerService -Specifies the container service object from which this cmdlet removes an agent pool profile. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSContainerService -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the agent pool profile that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSContainerService - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSContainerService - -## NOTES - -## RELATED LINKS - -[Add-AzureRmContainerServiceAgentPoolProfile](./Add-AzureRmContainerServiceAgentPoolProfile.md) - -[Get-AzureRmContainerService](./Get-AzureRmContainerService.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmDisk.md b/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmDisk.md deleted file mode 100644 index e2ba40215b..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmDisk.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermdisk -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmDisk.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmDisk.md ---- - -# Remove-AzureRmDisk - -## SYNOPSIS -Removes a disk. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmDisk [-ResourceGroupName] <String> [-DiskName] <String> [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmDisk** cmdlet removes a disk. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -Force; -``` - -This command removes the disk named 'Disk01' in the resource group 'ResourceGroup01'. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskName -Specifies the name of a disk. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmGallery.md b/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmGallery.md deleted file mode 100644 index 0ae57c9d43..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmGallery.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermgallery -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmGallery.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmGallery.md ---- - -# Remove-AzureRmGallery - -## SYNOPSIS -Delete a gallery. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameter (Default) -``` -Remove-AzureRmGallery [-ResourceGroupName] <String> [-Name] <String> [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameter -``` -Remove-AzureRmGallery [-Force] [-ResourceId] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ObjectParameter -``` -Remove-AzureRmGallery [-Force] [-InputObject] <PSGallery> [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Delete a gallery. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-AzureRmGallery -ResourceGroupName $rgname -GalleryName $galleryName -``` - -Delete the given gallery. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The PS Gallery Object - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSGallery -Parameter Sets: ObjectParameter -Aliases: Gallery - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the gallery. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: GalleryName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The resource Id for the gallery - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameter -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSGallery - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmGalleryImageDefinition.md b/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmGalleryImageDefinition.md deleted file mode 100644 index 02a31af36a..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmGalleryImageDefinition.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermgalleryimagedefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmGalleryImageDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmGalleryImageDefinition.md ---- - -# Remove-AzureRmGalleryImageDefinition - -## SYNOPSIS -Delete a gallery image definition. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameter (Default) -``` -Remove-AzureRmGalleryImageDefinition [-ResourceGroupName] <String> [-GalleryName] <String> [-Name] <String> - [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameter -``` -Remove-AzureRmGalleryImageDefinition [-Force] [-ResourceId] <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ObjectParameter -``` -Remove-AzureRmGalleryImageDefinition [-Force] [-InputObject] <PSGalleryImage> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Delete a gallery image definition. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-AzureRmGalleryImageDefinition -ResourceGroupName $rgname -GalleryName $gallery -GalleryImageDefinitionName $galleryImage -``` - -Remove the gallery image definition. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GalleryName -The name of the gallery. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -The PS Gallery Image Definition Object - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSGalleryImage -Parameter Sets: ObjectParameter -Aliases: GalleryImageDefinition - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the gallery image definition. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: GalleryImageDefinitionName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The resource ID for the gallery image definition - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameter -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSGalleryImage - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmGalleryImageVersion.md b/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmGalleryImageVersion.md deleted file mode 100644 index ad67979023..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmGalleryImageVersion.md +++ /dev/null @@ -1,233 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermgalleryimageversion -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmGalleryImageVersion.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmGalleryImageVersion.md ---- - -# Remove-AzureRmGalleryImageVersion - -## SYNOPSIS -Delete a gallery image version. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameter (Default) -``` -Remove-AzureRmGalleryImageVersion [-ResourceGroupName] <String> [-GalleryName] <String> - [-GalleryImageDefinitionName] <String> [-Name] <String> [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameter -``` -Remove-AzureRmGalleryImageVersion [-Force] [-ResourceId] <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ObjectParameter -``` -Remove-AzureRmGalleryImageVersion [-Force] [-InputObject] <PSGalleryImageVersion> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Delete a gallery image version. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-AzureRmGalleryImageVersion -ResourceGroupName $rgname -GalleryName $gallery -ImageDefinitionName $image -GalleryImageVersionName $version -``` - -Delete the given gallery image version. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GalleryImageDefinitionName -The name of the gallery image definition. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GalleryName -The name of the gallery. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -The PS Gallery Image Version Object - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSGalleryImageVersion -Parameter Sets: ObjectParameter -Aliases: GalleryImageVersion - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the gallery image version. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: GalleryImageVersionName - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The resource ID for gallery image version - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameter -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSGalleryImageVersion - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmImage.md b/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmImage.md deleted file mode 100644 index 507f37db15..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmImage.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermimage -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmImage.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmImage.md ---- - -# Remove-AzureRmImage - -## SYNOPSIS -Removes an image. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmImage [-ResourceGroupName] <String> [-ImageName] <String> [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmImage** cmdlet removes an image.. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmImage -ResourceGroupName 'ResourceGroup01' -ImageName 'Image01' -Force; -``` - -This command removes the image named 'Image01' in the resource group 'ResourceGroup01'. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImageName -Specifies the name of an image. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmImageDataDisk.md b/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmImageDataDisk.md deleted file mode 100644 index 1ec5390590..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmImageDataDisk.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermimagedatadisk -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmImageDataDisk.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmImageDataDisk.md ---- - -# Remove-AzureRmImageDataDisk - -## SYNOPSIS -Removes a data disk from an image object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmImageDataDisk [-Image] <PSImage> [-Lun] <Int32> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmImageDataDisk** cmdlet removes a data disk from an image object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmImage -ResourceGroupName 'ResourceGroup01' -ImageName 'Image01' | Remove-AzureRmImageDataDisk -Lun 1 | Update-AzureRmImage; -``` - -This command removes the data disk of logical unit number 1 from the existing image 'Image01' in the resource group 'ResourceGroup01'. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Image -Specifies a local image object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSImage -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Lun -Specifies the logical unit number (LUN). - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSImage - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSImage - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmSnapshot.md b/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmSnapshot.md deleted file mode 100644 index e4d5f8cab1..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmSnapshot.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermsnapshot -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmSnapshot.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmSnapshot.md ---- - -# Remove-AzureRmSnapshot - -## SYNOPSIS -Removes a snapshot. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmSnapshot [-ResourceGroupName] <String> [-SnapshotName] <String> [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmSnapshot** cmdlet removes a snapshot. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -Force; -``` - -This command removes the snapshot named 'Snapshot01' in the resource group 'ResourceGroup01'. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SnapshotName -Specifies the name of a snapshot. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVM.md b/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVM.md deleted file mode 100644 index bc4ab78cf8..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVM.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: A16C2084-30A4-4AB8-AE22-28CC6E74FD48 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvm -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVM.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVM.md ---- - -# Remove-AzureRmVM - -## SYNOPSIS -Removes a virtual machine from Azure. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceGroupNameParameterSetName (Default) -``` -Remove-AzureRmVM [-Name] <String> [-Force] [-ResourceGroupName] <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### IdParameterSetName -``` -Remove-AzureRmVM [-Name] <String> [-Force] [-Id] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVM** cmdlet removes a virtual machine from Azure. - -## EXAMPLES - -### Example 1: Remove a virtual machine -``` -PS C:\> Remove-AzureRmVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -``` - -This command removes the virtual machine named VirtualMachine07 in the resource group ResourceGroup11. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The resource group name. - -```yaml -Type: System.String -Parameter Sets: IdParameterSetName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName, VMName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupNameParameterSetName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSComputeLongRunningOperation - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - -[New-AzureRmVM](./New-AzureRmVM.md) - -[Restart-AzureRmVM](./Restart-AzureRmVM.md) - -[Start-AzureRmVM](./Start-AzureRmVM.md) - -[Stop-AzureRmVM](./Stop-AzureRmVM.md) - -[Update-AzureRmVM](./Update-AzureRmVM.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMAEMExtension.md b/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMAEMExtension.md deleted file mode 100644 index 639fae006a..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMAEMExtension.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: B1CD5302-9BF0-460E-98FE-F60DFE072848 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmaemextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVMAEMExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVMAEMExtension.md ---- - -# Remove-AzureRmVMAEMExtension - -## SYNOPSIS -Removes the AEM extension from a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVMAEMExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] - [[-OSType] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVMAEMExtension** cmdlet removes the Azure Enhanced Monitoring (AEM) extension from a virtual machine. - -## EXAMPLES - -### Example 1: Remove the AEM extension -``` -PS C:\> Remove-AzureRmVMAEMExtension -ResourceGroupName "ResourceGroup11" -VMName "contoso-server" -``` - -This command removes the AEM extension for the virtual machine named contoso-server. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual machine from which this cmdlet removes the AEM extension. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OSType -Specifies the type of the operating system of the operating system disk. -If the operating system disk does not have a type, you must specify this parameter. -The acceptable values for this parameter are: Windows and Linux. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of a virtual machine. -This cmdlet removes the AEM extension from that virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine. -This cmdlet removes the AEM extension for the virtual machine that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMAEMExtension](./Get-AzureRmVMAEMExtension.md) - -[Set-AzureRmVMAEMExtension](./Set-AzureRmVMAEMExtension.md) - -[Test-AzureRmVMAEMExtension](./Test-AzureRmVMAEMExtension.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMAccessExtension.md b/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMAccessExtension.md deleted file mode 100644 index 90d2bbd4df..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMAccessExtension.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 22C490C2-0135-4375-897E-7224DBBE13A7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmaccessextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVMAccessExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVMAccessExtension.md ---- - -# Remove-AzureRmVMAccessExtension - -## SYNOPSIS -Removes the VMAccess extension from a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVMAccessExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name] <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVMAccessExtension** cmdlet removes the Virtual Machine Access (VMAccess) Virtual Machine Extension from a virtual machine. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the extension that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine. -This cmdlet removes VMAccess for the virtual machine that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMAccessExtension](./Get-AzureRmVMAccessExtension.md) - -[Set-AzureRmVMAccessExtension](./Set-AzureRmVMAccessExtension.md) - -[Remove-AzureRmVMExtension](./Remove-AzureRmVMExtension.md) diff --git a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMBackup.md b/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMBackup.md deleted file mode 100644 index 60d8d4bc38..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMBackup.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 2AB1B227-68C4-49AE-84C0-E1421E609DE7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmbackup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVMBackup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVMBackup.md ---- - -# Remove-AzureRmVMBackup - -## SYNOPSIS -Removes the backup from a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVMBackup [-ResourceGroupName] <String> [-VMName] <String> [-Tag] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION - -## EXAMPLES - -### 1: -``` -PS C:\> -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMChefExtension.md b/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMChefExtension.md deleted file mode 100644 index 3bdacdbf01..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMChefExtension.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 473C71A8-1DF7-487A-B239-B80E2BB63B82 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmchefextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVMChefExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVMChefExtension.md ---- - -# Remove-AzureRmVMChefExtension - -## SYNOPSIS -Removes the Chef extension from a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Linux -``` -Remove-AzureRmVMChefExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] [-Linux] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Windows -``` -Remove-AzureRmVMChefExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] [-Windows] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureVMChefExtension** cmdlet removes the Chef extension from a virtual machine. - -## EXAMPLES - -### Example 1: Remove a Chef extension from a Windows virtual machine -``` -PS C:\> Remove-AzureRmVMChefExtension -ResourceGroupName "ResourceGroup001" -VMName "WindowsVM001" -Windows -``` - -This command removes a Chef extension from a Windows based virtual machine named WindowsVM001 that belongs to the resource group named ResourceGroup001. - -### Example 2: Remove a Chef extension from a Linux virtual machine -``` -PS C:\> Remove-AzureRmVMChefExtension -ResourceGroupName "ResourceGroup002" -VMName "LinuxVM001" -Linux -``` - -This command removes a Chef extension from a Linux based virtual machine named LinuxVM001 that belongs to the resource group named ResourceGroup002. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Linux -Indicates that this cmdlet targets a Linux virtual machine. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Linux -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Chef extension that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine for which this cmdlet removes the Chef extension. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Windows -Indicates that this cmdlet targets a Windows virtual machine. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Windows -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMChefExtension](./Get-AzureRmVMChefExtension.md) - -[Set-AzureRmVMChefExtension](./Set-AzureRmVMChefExtension.md) diff --git a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMCustomScriptExtension.md b/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMCustomScriptExtension.md deleted file mode 100644 index 59b335ef31..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMCustomScriptExtension.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: A65E82D5-706B-4470-A51E-936E381DA78F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmcustomscriptextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVMCustomScriptExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVMCustomScriptExtension.md ---- - -# Remove-AzureRmVMCustomScriptExtension - -## SYNOPSIS -Removes a custom script extension from a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVMCustomScriptExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name] <String> - [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVMCustomScriptExtension** cmdlet removes a custom script Virtual Machine Extension from a virtual machine. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the custom script extension that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine from which this cmdlet removes the custom script extension. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMCustomScriptExtension](./Get-AzureRmVMCustomScriptExtension.md) - -[Set-AzureRmVMCustomScriptExtension](./Set-AzureRmVMCustomScriptExtension.md) diff --git a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMDataDisk.md b/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMDataDisk.md deleted file mode 100644 index b61303d2c1..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMDataDisk.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: D5943E9F-E4E6-4A1F-A144-44691CF32FC8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmdatadisk -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVMDataDisk.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVMDataDisk.md ---- - -# Remove-AzureRmVMDataDisk - -## SYNOPSIS -Removes a data disk from a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVMDataDisk [-VM] <PSVirtualMachine> [[-DataDiskNames] <String[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVMDataDisk** cmdlet removes a data disk from a virtual machine. - -## EXAMPLES - -### Example 1: Remove a data disk from a virtual machine -``` -PS C:\> $VirtualMachine = Get-AzureRmVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -PS C:\> Remove-AzureRmVMDataDisk -VM $VirtualMachine -Name "Disk3" -PS C:\> Update-AzureRmVM -ResourceGroupName "ResourceGroup11" -VM $VirtualMachine -``` - -The first command gets the virtual machine named VirtualMachine07 by using the **Get-AzureRmVM** cmdlet. -The command stores the virtual machine in the $VirtualMachine variable. -The second command removes the data disk named Disk3 from the virtual machine stored in $VirtualMachine. -The final command updates the state of the virtual machine stored in $VirtualMachine in ResourceGroup11. - -## PARAMETERS - -### -DataDiskNames -Specifies the names of one or more data disks that this cmdlet removes. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: Name - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the local virtual machine object from which to remove a data disk. -To obtain a virtual machine object, use the Get-AzureRmVM cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine -Parameter Sets: (All) -Aliases: VMProfile - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVMDataDisk](./Add-AzureRmVMDataDisk.md) - -[Get-AzureRmVM](./Get-AzureRmVM.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMDiagnosticsExtension.md b/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMDiagnosticsExtension.md deleted file mode 100644 index 5282334761..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMDiagnosticsExtension.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 89DA3965-5344-4A1D-AEF1-10EA58E129CF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmdiagnosticsextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVMDiagnosticsExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVMDiagnosticsExtension.md ---- - -# Remove-AzureRmVMDiagnosticsExtension - -## SYNOPSIS -Removes the Diagnostics extension from a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVMDiagnosticsExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVMDiagnosticsExtension** cmdlet removes an Azure Diagnostics extension from a virtual machine. -You must pass the output of this cmdlet to the Update-AzureRmVM cmdlet to implement your changes. - -## EXAMPLES - -### Example 1: Remove the Diagnostics extension from a virtual machine -``` -PS C:\> Remove-AzureRmVMDiagnosticsExtension -ResourceGroupName "ResourceGroup11" -VMName "ContosoVM22" | Update-AzureRmVM -``` - -This command removes the Diagnostics extension from a virtual machine named ContosoVM22. -The command passes the result to the Update-AzureRmVM cmdlet by using the pipeline operator. -That command updates the virtual machine. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Diagnostics extension that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine from which this cmdlet removes a Diagnostics extension. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMDiagnosticsExtension](./Get-AzureRMVMDiagnosticsExtension.md) - -[Set-AzureRmVMDiagnosticsExtension](./Set-AzureRMVMDiagnosticsExtension.md) - -[Update-AzureRmVM](./Update-AzureRmVM.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMDiskEncryptionExtension.md b/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMDiskEncryptionExtension.md deleted file mode 100644 index 38186aff93..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMDiskEncryptionExtension.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 9DDB3672-4C98-4449-9F29-DD9501ED4D3E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmdiskencryptionextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVMDiskEncryptionExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVMDiskEncryptionExtension.md ---- - -# Remove-AzureRmVMDiskEncryptionExtension - -## SYNOPSIS -Removes the disk encryption extension from a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVMDiskEncryptionExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] - [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVMDiskEncryptionExtension** cmdlet removes the disk encryption extension from a virtual machine. -If no extension name is specified, this cmdlet removes the extension with default name AzureDiskEncryption for virtual machines that run the Windows operating system or AzureDiskEncryptionForLinux for Linux based virtual machines. -This cmdlet does not disable encryption on the virtual machine. -It removes the extension and the associated extension configuration from the virtual machine. - -## EXAMPLES - -### Example 1: Remove the disk encryption extension from a virtual machine. -``` -PS C:\> Remove-AzureRmVMDiskEncryptionExtension -ResourceGroupName "MyResourceGroup" -VMName "MyTestVM" -``` - -This command removes the extension with default name AzureDiskEncryption for a virtual machine that runs the Windows operating system or AzureDiskEncryptionForLinux for Linux based virtual machine named MyTestVM. - -### Example 2: Remove a specific disk encryption extension from a virtual machine. -``` -PS C:\> Remove-AzureRmVMDiskEncryptionExtension -ResourceGroupName "MyResourceGroup" -VMName "MyTestVM" -Name "MyDiskEncryptionExtension" -``` - -This command removes the encryption extension named MyDiskEncryptionExtension from the virtual machine named MyTestVM. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Azure Resource Manager resource that represents the extension. -The Set-AzureRmVMDiskEncryptionExtension cmdlet sets this name to AzureDiskEncryption for virtual machines that run the Windows operating system and AzureDiskEncryptionForLinux for Linux virtual machines. -Specify this parameter only if you changed the default name in the **Set-AzureRmVMDiskEncryptionExtension** cmdlet or used a different resource name in a Resource Manager template. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMDiskEncryptionStatus](./Get-AzureRmVMDiskEncryptionStatus.md) - -[Set-AzureRmVMDiskEncryptionExtension](./Set-AzureRmVMDiskEncryptionExtension.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMDscExtension.md b/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMDscExtension.md deleted file mode 100644 index fa4a8014f6..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMDscExtension.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: C7FCF2CA-2C8D-4280-BF68-10DEA96642A5 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmdscextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVMDscExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVMDscExtension.md ---- - -# Remove-AzureRmVMDscExtension - -## SYNOPSIS -Removes a DSC extension handler from a virtual machine in a resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVMDscExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVMDscExtension** cmdlet removes a Desired State Configuration (DSC) extension handler from a virtual machine in a resource group. - -## EXAMPLES - -### Example 1: Remove a DSC extension -``` -PS C:\> Remove-AzureRmVMDscExtension -ResourceGroupName "ResourceGroup001" -VMName "VM07" -Name "DSC" -``` - -This command removes the extension named DSC on virtual machine named VM07. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the DSC extension that this cmdlet removes. -The Set-AzureRmVMDscExtension cmdlet sets this name to Microsoft.Powershell.DSC, which is the default value used by **Remove-AzureRmVMDscExtension**. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine from which this cmdlet removes the DSC extension. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMDscExtension](./Get-AzureRmVMDscExtension.md) - -[Set-AzureRmVMDscExtension](./Set-AzureRmVMDscExtension.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMExtension.md b/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMExtension.md deleted file mode 100644 index aec11009a3..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMExtension.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 6C40A7BA-6BE2-464A-84E4-9021935A5BF6 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVMExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVMExtension.md ---- - -# Remove-AzureRmVMExtension - -## SYNOPSIS -Removes an extension from a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVMExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name] <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVMExtension** cmdlet removes an extension from the Virtual Machine Extensions of a virtual machine. - -## EXAMPLES - -### Example 1: Remove an extension from a virtual machine -``` -PS C:\> Remove-AzureRmVMExtension -ResourceGroupName "ResourceGroup11" -Name "ContosoTest" -VMName "VirtualMachine22" -``` - -This command removes the extension named ContosoTest from the virtual machine named VirtualMachine22 in ResourceGroup11. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the extension that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine from which this cmdlet removes the extension. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMExtension](./Get-AzureRmVMExtension.md) - -[Set-AzureRmVMExtension](./Set-AzureRmVMExtension.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMNetworkInterface.md b/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMNetworkInterface.md deleted file mode 100644 index 7d7bb4e6d1..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMNetworkInterface.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 6B26DADE-BF71-48D2-98C9-87B2F6182AC2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmnetworkinterface -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVMNetworkInterface.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVMNetworkInterface.md ---- - -# Remove-AzureRmVMNetworkInterface - -## SYNOPSIS -Removes a network interface from a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVMNetworkInterface [-VM] <PSVirtualMachine> [[-NetworkInterfaceIDs] <String[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVMNetworkInterface** cmdlet removes a network interface from a virtual machine. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkInterfaceIDs -Specifies an array of network interface IDs that this cmdlet removes. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: Id, NicIds - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine from which this cmdlet removes a network interface. -To obtain a virtual machine object, use the Get-AzureRmVM cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine -Parameter Sets: (All) -Aliases: VMProfile - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMSecret.md b/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMSecret.md deleted file mode 100644 index c01a6912d0..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVMSecret.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmsecret -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVMSecret.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVMSecret.md ---- - -# Remove-AzureRmVMSecret - -## SYNOPSIS -Removes (a) secret(s) from a virtual machine object - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVMSecret [-VM] <PSVirtualMachine> [[-SourceVaultId] <String[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmVMSecret cmdlet removes (a) secret(s) from a virtual machine object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmVM -ResourceGroupName "rg1" -Name "vm1" | Remove-AzureRmVMSecret | Update-AzureRmVM -``` - -Removes all secrets from a virtual machine "vm1" in resource group "rg1" and update the VM - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceVaultId -Specifies an array of source vault IDs that this cmdlet removes. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: Id - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine from which this cmdlet removes (a) secret(s). -To obtain a virtual machine object, use the Get-AzureRmVM cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine -Parameter Sets: (All) -Aliases: VMProfile - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVmss.md b/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVmss.md deleted file mode 100644 index 015bbe1345..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVmss.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: E6F2EE87-97C4-416A-9AE1-9FBD72062F0F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmss -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVmss.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVmss.md ---- - -# Remove-AzureRmVmss - -## SYNOPSIS -Removes the VMSS or a virtual machine that is within the VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> [[-InstanceId] <String[]>] [-Force] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVmss** cmdlet removes the Virtual Machine Scale Set (VMSS) from Azure. -This cmdlet can also be used to remove a specific virtual machine inside the VMSS. -You can use the *InstanceId* parameter to remove a specific virtual machine inside the VMSS. - -## EXAMPLES - -### Example 1: Remove a VMSS -``` -PS C:\> Remove-AzureRmVmss -ResourceGroupName "Group001" -VMScaleSetName "VMScaleSet001" -``` - -This command removes the VMSS named VMScaleSet001 that belongs to the resource group named Group001. - -### Example 2: Remove a virtual machine from within a VMSS -``` -PS C:\> Remove-AzureRmVmss -ResourceGroupName "Group002" -VMScaleSetName "VMScaleSet002" -InstanceId "3"; -``` - -This command removes the virtual machine with instance ID 3 from the VMSS named VMScaleSet002 that belongs to the resource group named Group002. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceId -Specifies, as a string array, the ID of the instances that need to be started. -For instance: `-InstanceId "0", "3"` - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the VMSS belongs to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMScaleSetName -Species the name of the VMSS that this cmdlet removes. -If you specify the *InstanceId* parameter, the cmdlet will remove the specified virtual machine from the VMSS named by this parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.String[] - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVmss](./Get-AzureRmVmss.md) - -[New-AzureRmVmss](./New-AzureRmVmss.md) - -[Restart-AzureRmVmss](./Restart-AzureRmVmss.md) - -[Set-AzureRmVmss](./Set-AzureRmVmss.md) - -[Start-AzureRmVmss](./Start-AzureRmVmss.md) - -[Stop-AzureRmVmss](./Stop-AzureRmVmss.md) - -[Update-AzureRmVmss](./Update-AzureRmVmss.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVmssDataDisk.md b/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVmssDataDisk.md deleted file mode 100644 index dd8fcc1a9f..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVmssDataDisk.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmssdatadisk -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVmssDataDisk.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVmssDataDisk.md ---- - -# Remove-AzureRmVmssDataDisk - -## SYNOPSIS -Removes a data disk from the VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameParameterSet -``` -Remove-AzureRmVmssDataDisk [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### LunParameterSet -``` -Remove-AzureRmVmssDataDisk [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [-Lun] <Int32> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVmssDataDisk** cmdlet removes a data disk from the Virtual Machine Scale Set (VMSS) instance. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmVmssDataDisk -VirtualMachineScaleSet $vmss -Name 'DataDisk1' -``` - -This command removes the data disk named 'DataDisk1' from the VMSS object. - -### Example 2 -``` -PS C:\> Remove-AzureRmVmssDataDisk -VirtualMachineScaleSet $vmss -Lun 0 -``` - -This command removes the data disk of LUN 0 from the VMSS object. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Lun -Specifies the logical unit number of the disk. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: LunParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the disk. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specify the VMSS object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -### System.String - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVmssDiagnosticsExtension.md b/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVmssDiagnosticsExtension.md deleted file mode 100644 index f47484a2b4..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVmssDiagnosticsExtension.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 5F135E64-9432-4D08-961F-4604410378A3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmssdiagnosticsextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVmssDiagnosticsExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVmssDiagnosticsExtension.md ---- - -# Remove-AzureRmVmssDiagnosticsExtension - -## SYNOPSIS -Removes a diagnostics extension from the VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVmssDiagnosticsExtension [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVmssDiagnosticsExtension** cmdlet removes a diagnostics extension from the Virtual Machine Scale Set (VMSS). - -## EXAMPLES - -### Example 1: Remove a diagnostics extension from the VMSS -``` -PS C:\> Remove-AzureRmVmssDiagnosticsExtension -VirtualMachineScaleSet $VMSS -Name $extName -``` - -This command removes diagnostics extension from the VMSS. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the extension that this cmdlet removes from the VMSS. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specifies the VMSS from which to remove the extension. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSet - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSet - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVmssDiagnosticsExtension](./Add-AzureRmVmssDiagnosticsExtension.md) - -[Remove-AzureRmVMDiagnosticsExtension](./Remove-AzureRmVMDiagnosticsExtension.md) - -[Remove-AzureRmVmssExtension](./Remove-AzureRmVmssExtension.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVmssExtension.md b/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVmssExtension.md deleted file mode 100644 index 844ae3ec42..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVmssExtension.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 8C1C12AD-5130-42E7-99BB-B13900D7A712 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmssextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVmssExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVmssExtension.md ---- - -# Remove-AzureRmVmssExtension - -## SYNOPSIS -Removes an extension from the VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameParameterSet -``` -Remove-AzureRmVmssExtension [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### IdParameterSet -``` -Remove-AzureRmVmssExtension [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [-Id] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVmssExtension** cmdlet removes an extension from the Virtual Machine Scale Set (VMSS). - -## EXAMPLES - -### Example 1: Remove a VMSS extension -``` -PS C:\> $vmss = Get-AzureRmVmss -ResourceGroupName $RGName -VMScaleSetName $vmssName -PS C:\> Remove-AzureRmVmssExtension -VirtualMachineScaleSet $vmss -Name $vmssExtensionName -PS C:\> Update-AzureRmVmss -ResourceGroupName $RGName -Name $vmssName -VirtualMachineScaleSet $vmss -``` - -This command removes the extension of a VMSS and update the VMSS after the modification. - -### Example 2: Remove an instance from within a VMSS -``` -PS C:\> $vmss = Get-AzureRmVmss -ResourceGroupName $RGName -VMScaleSetName $vmssName -PS C:\> Remove-AzureRmVmssExtension -ResourceGroupName "Group002" -VirtualMachineScaleSet $vmss -Id $extensionId -``` - -This command removes specify extension id from the VMSS that belongs to the resource group named Group002. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the extension that this cmdlet removes from the VMSS. - -```yaml -Type: System.String -Parameter Sets: IdParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the extension that this cmdlet removes from the VMSS. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specifies the VMSS from which to remove the extension from. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVmssExtension](./Add-AzureRmVmssExtension.md) diff --git a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVmssNetworkInterfaceConfiguration.md b/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVmssNetworkInterfaceConfiguration.md deleted file mode 100644 index 14729a6e0f..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVmssNetworkInterfaceConfiguration.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: EC4E8CC1-C21F-4D41-818F-D0BC15AEEE1D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmssnetworkinterfaceconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVmssNetworkInterfaceConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVmssNetworkInterfaceConfiguration.md ---- - -# Remove-AzureRmVmssNetworkInterfaceConfiguration - -## SYNOPSIS -Removes a network interface configuration from a VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameParameterSet -``` -Remove-AzureRmVmssNetworkInterfaceConfiguration [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> - [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### IdParameterSet -``` -Remove-AzureRmVmssNetworkInterfaceConfiguration [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> - [-Id] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVmssNetworkInterfaceConfiguration** cmdlet removes a network interface configuration from a Virtual Machine Scale Set (VMSS). - -## EXAMPLES - -### Example 1: Remove an interface configuration -``` -PS C:\> $VMSS = Get-AzureRmVmss -ResourceGroupName "ResourceGroup11" -VMScaleSetName "ContosoVMSS14" -PS C:\> Remove-AzureRmVmssNetworkInterfaceConfiguration -VirtualMachineScaleSet $VMSS -Name "ContosoVmssInterface02" -``` - -The first command gets a VMSS by using the Get-AzureRmVmss cmdlet, and then stores it in the $VMSS variable. -The second command removes the network interface configuration named ContosoVmssInterface02 from the set in $VMSS. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the network interface configuration that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: IdParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network interface configuration that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specifies the VMSS object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVmssNetworkInterfaceConfiguration](./Add-AzureRmVmssNetworkInterfaceConfiguration.md) - -[Get-AzureRmVmss](./Get-AzureRmVmss.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVmssVMDataDisk.md b/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVmssVMDataDisk.md deleted file mode 100644 index dc09084046..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Remove-AzureRmVmssVMDataDisk.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmssvmdatadisk -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVmssVMDataDisk.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Remove-AzureRmVmssVMDataDisk.md ---- - -# Remove-AzureRmVmssVMDataDisk - -## SYNOPSIS -Removes a data disk from a virtual machine scale set VM - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVmssVMDataDisk [-VirtualMachineScaleSetVM] <PSVirtualMachineScaleSetVM> [-Lun] <Int32> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVmssVMDataDisk** cmdlet removes a data disk from a VM scale set VM - -## EXAMPLES - -### Example 1: Remove a data disk from a VM scale set VM -```powershell -PS C:\> $VmssVM = Get-AzureRmVmssVM -ResourceGroupName "myrg" -VMScaleSetName "myvmss" -InstanceId 0 -PS C:\> Remove-AzureRmVmssVMDataDisk -VM $VirtualMachine -Lun 0 -PS C:\> Update-AzureRmVmssVM -VirtualMachineScaleSetVM $VmssVM -``` - -The first command getsan existing Vmss VM given by the resource group name, the vmss name and the instance ID. -The second command removes the data disk lun 0 from the VM scale set VM stored in $VmssVM -The final command updates the Vmss VM with removed data disk. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Lun -Specifies the logical unit number of the disk. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSetVM -The virtual machine scale set VM profile. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetVM -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetVM - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetVM - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Repair-AzureRmVmssServiceFabricUpdateDomain.md b/azurermps-6.13.0/AzureRM.Compute/Repair-AzureRmVmssServiceFabricUpdateDomain.md deleted file mode 100644 index 7c7a346c5e..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Repair-AzureRmVmssServiceFabricUpdateDomain.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/repair-azurermvmssservicefabricupdatedomain -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Repair-AzureRmVmssServiceFabricUpdateDomain.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Repair-AzureRmVmssServiceFabricUpdateDomain.md ---- - -# Repair-AzureRmVmssServiceFabricUpdateDomain - -## SYNOPSIS -Manual platform update domain walk to update virtual machines in a service fabric virtual machine scale set. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameter (Default) -``` -Repair-AzureRmVmssServiceFabricUpdateDomain [-ResourceGroupName] <String> [-VMScaleSetName] <String> - [-PlatformUpdateDomain] <Int32> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ResourceIdParameter -``` -Repair-AzureRmVmssServiceFabricUpdateDomain [-PlatformUpdateDomain] <Int32> [-ResourceId] <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ObjectParameter -``` -Repair-AzureRmVmssServiceFabricUpdateDomain [-PlatformUpdateDomain] <Int32> - [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Force manual platform update domain walk to update virtual machines in a service fabric virtual machine scale set. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Repair-AzureRmVmssServiceFabricUpdateDomain -ResourceGroupName $rgname -VMScaleSetName $vmssName -PlatformUpdateDomain 0 -``` - -This command forces service fabric update walk on UD 0 for the virtual machine scale set specified by resource group name and scale set name. - -### Example 2 -``` -PS C:\> $vmss = Get-AzureRmVmss -ResourceGroupName $rgname -VMScaleSetName $vmssName -PS C:\> Repair-AzureRmVmssServiceFabricUpdateDomain -VirtualMachineScaleSet $vmss -PlatformUpdateDomain 1 -``` - -This command forces service fabric update walk on UD 1 for the virtual machine scale set specified by VM scale set object. - -### Example 3 -``` -PS C:\> Repair-AzureRmVmssServiceFabricUpdateDomain -ResourceId $resoureId -PlatformUpdateDomain 2; -``` - -This command forces service fabric update walk on UD 2 for the virtual machine scale set specified by resource id. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PlatformUpdateDomain -The platform update domain for which a manual recovery walk is requested. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The resource id for the virtual machine scale set. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameter -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Local virtual machine scale set object - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet -Parameter Sets: ObjectParameter -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMScaleSetName -The name of the virtual machine scale set - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet -Parameters: VirtualMachineScaleSet (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSRecoveryWalkResponse - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Restart-AzureRmVM.md b/azurermps-6.13.0/AzureRM.Compute/Restart-AzureRmVM.md deleted file mode 100644 index 3536881c82..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Restart-AzureRmVM.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: EF155949-5766-4BC4-9C8A-2B97E8EA032D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/restart-azurermvm -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Restart-AzureRmVM.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Restart-AzureRmVM.md ---- - -# Restart-AzureRmVM - -## SYNOPSIS -Restarts an Azure virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RestartResourceGroupNameParameterSetName (Default) -``` -Restart-AzureRmVM [-ResourceGroupName] <String> [-Name] <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### PerformMaintenanceResourceGroupNameParameterSetName -``` -Restart-AzureRmVM [-ResourceGroupName] <String> [-Name] <String> [-PerformMaintenance] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RestartIdParameterSetName -``` -Restart-AzureRmVM [-Id] <String> [-Name] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### PerformMaintenanceIdParameterSetName -``` -Restart-AzureRmVM [-Id] <String> [-Name] <String> [-PerformMaintenance] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Restart-AzureRmVM** cmdlet restarts an Azure virtual machine. - -## EXAMPLES - -### Example 1: Restart a virtual machine -``` -PS C:\> Restart-AzureRmVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -``` - -This command restarts the virtual machine named VirtualMachine07 in ResourceGroup11. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The resource group name. - -```yaml -Type: System.String -Parameter Sets: RestartIdParameterSetName, PerformMaintenanceIdParameterSetName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The virtual machine name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PerformMaintenance -To perform the maintenance of virtual machine. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: PerformMaintenanceResourceGroupNameParameterSetName, PerformMaintenanceIdParameterSetName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: RestartResourceGroupNameParameterSetName, PerformMaintenanceResourceGroupNameParameterSetName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSComputeLongRunningOperation - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - -[New-AzureRmVM](./New-AzureRmVM.md) - -[Remove-AzureRmVM](./Remove-AzureRmVM.md) - -[Start-AzureRmVM](./Start-AzureRmVM.md) - -[Stop-AzureRmVM](./Stop-AzureRmVM.md) - -[Update-AzureRmVM](./Update-AzureRmVM.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Restart-AzureRmVmss.md b/azurermps-6.13.0/AzureRM.Compute/Restart-AzureRmVmss.md deleted file mode 100644 index 6484b8d8da..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Restart-AzureRmVmss.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 47F0EE55-78C0-4C71-BD32-C7CB7B200DC3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/restart-azurermvmss -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Restart-AzureRmVmss.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Restart-AzureRmVmss.md ---- - -# Restart-AzureRmVmss - -## SYNOPSIS -Restarts the VMSS or a virtual machine within the VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Restart-AzureRmVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> [[-InstanceId] <String[]>] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Restart-AzureRmVmss** cmdlet restarts the Virtual Machine Scale Set (VMSS). -This cmdlet can also be used to restart a specific virtual machine inside the VMSS by using the *InstanceId* parameter. - -## EXAMPLES - -### Example 1: Restart the VMSS -``` -PS C:\> Restart-AzureRmVmss -ResourceGroupName "Group001" -VMScaleSetName "VMSS001"; -``` - -This command restarts the VMSS named VMSS001 that belongs to the resource group named Group001. - -### Example 2: Restart a specific virtual machine within the VMSS -``` -PS C:\> Restart-AzureRmVmss -ResourceGroupName "Group004" -VMScaleSetName "VMSS001" -InstanceId "1" -``` - -This command restarts a virtual machine that has the instance ID of 1 in the VMSS named VMSS001 that belongs to the resource group named Group001. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceId -Specifies, as a string array, the ID of the instances that need restarted. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the VMSS. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMScaleSetName -Species the name of the VMSS that this cmdlet restarts. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.String[] - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVmss](./Get-AzureRmVmss.md) - -[New-AzureRmVmss](./New-AzureRmVmss.md) - -[Remove-AzureRmVmss](./Remove-AzureRmVmss.md) - -[Set-AzureRmVmss](./Set-AzureRmVmss.md) - -[Start-AzureRmVmss](./Start-AzureRmVmss.md) - -[Stop-AzureRmVmss](./Stop-AzureRmVmss.md) - -[Update-AzureRmVmss](./Update-AzureRmVmss.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Revoke-AzureRmDiskAccess.md b/azurermps-6.13.0/AzureRM.Compute/Revoke-AzureRmDiskAccess.md deleted file mode 100644 index d5eb8b7749..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Revoke-AzureRmDiskAccess.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/revoke-azurermdiskaccess -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Revoke-AzureRmDiskAccess.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Revoke-AzureRmDiskAccess.md ---- - -# Revoke-AzureRmDiskAccess - -## SYNOPSIS -Revokes an access to a disk. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Revoke-AzureRmDiskAccess [-ResourceGroupName] <String> [-DiskName] <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Revoke-AzureRmDiskAccess** cmdlet revokes an access to a disk. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Revoke-AzureRmDiskAccess -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -``` - -Revoke the access to the disk named 'Disk01' in the resource group named 'ResourceGroup01' - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskName -Specifies the name of a disk. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Revoke-AzureRmSnapshotAccess.md b/azurermps-6.13.0/AzureRM.Compute/Revoke-AzureRmSnapshotAccess.md deleted file mode 100644 index ed3e623f63..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Revoke-AzureRmSnapshotAccess.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/revoke-azurermsnapshotaccess -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Revoke-AzureRmSnapshotAccess.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Revoke-AzureRmSnapshotAccess.md ---- - -# Revoke-AzureRmSnapshotAccess - -## SYNOPSIS -Revokes an access to a snapshot. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Revoke-AzureRmSnapshotAccess [-ResourceGroupName] <String> [-SnapshotName] <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Revoke-AzureRmSnapshotAccess** cmdlet revokes an access to a snapshot. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Revoke-AzureRmDiskAccess -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -``` - -Revoke the access to the snapshot named 'Snapshot01' in the resource group named 'ResourceGroup01' - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SnapshotName -Specifies the name of a snapshot. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Save-AzureRmVMImage.md b/azurermps-6.13.0/AzureRM.Compute/Save-AzureRmVMImage.md deleted file mode 100644 index 634f748c91..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Save-AzureRmVMImage.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: D2B5BC27-6D51-45BC-AE6A-F7FED11B8651 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/save-azurermvmimage -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Save-AzureRmVMImage.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Save-AzureRmVMImage.md ---- - -# Save-AzureRmVMImage - -## SYNOPSIS -Saves a virtual machine as a VMImage. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceGroupNameParameterSetName (Default) -``` -Save-AzureRmVMImage [-Name] <String> [-DestinationContainerName] <String> [-VHDNamePrefix] <String> - [-Overwrite] [[-Path] <String>] [-ResourceGroupName] <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### IdParameterSetName -``` -Save-AzureRmVMImage [-Name] <String> [-DestinationContainerName] <String> [-VHDNamePrefix] <String> - [-Overwrite] [[-Path] <String>] [-Id] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Save-AzureRmVMImage** cmdlet saves a virtual machine as a VMImage. -Before you create a virtual machine image, sysprep the virtual machine, and then mark it as generalized by using the Set-AzureRmVM cmdlet. -The output of this cmdlet is a JavaScript Object Notation (JSON) template. -You can deploy virtual machines from your captured image. - -## EXAMPLES - -### Example 1: Capture a virtual machine -``` -PS C:\> Set-AzureRmVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -Generalized -PS C:\> Save-AzureRmVMImage -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine07" -DestinationContainerName "VMContainer01" -VHDNamePrefix "VM07" -``` - -The first command marks the virtual machine named VirtualMachine07 as generalized. -The second command captures a virtual machine named VirtualMachine07 as a VMImage. -The **Output** property returns a JSON template. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationContainerName -Specifies the name of a container inside the "system" container that you want to hold your images. -If the container doesn't exist, it is created for you. -The virtual hard disks (VHDs) that constitute the VMImage reside in the container that this parameter specifies. -If the VHDs are spread across multiple storage accounts, this cmdlet creates one container that has this name in each storage account. -The URL of the saved image is similar to: -https://\<storageAccountName\>.blob.core.windows.net/system/Microsoft.Compute/Images/\<imagesContainer\>/\<vhdPrefix-osDisk\>.xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.vhd. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Id -Specifies the Resource ID of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: IdParameterSetName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: VMName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Overwrite -Indicates that this cmdlet overwrites any VHDs that have the same prefix in the destination container. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -The file path in which the template of the captured image is stored. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupNameParameterSetName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VHDNamePrefix -Specifies the prefix in the name of the blobs that constitute the storage profile of the VMImage. -For example, a prefix vhdPrefix for an operating system disk results in the name vhdPrefix-osdisk.\<guid\>.vhd. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: VirtualHardDiskNamePrefix - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSComputeLongRunningOperation - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMImage](./Get-AzureRmVMImage.md) - -[Get-AzureRmVMImageOffer](./Get-AzureRmVMImageOffer.md) - -[Get-AzureRmVMImagePublisher](./Get-AzureRmVMImagePublisher.md) - -[Get-AzureRmVMImageSku](./Get-AzureRmVMImageSku.md) - -[Set-AzureRmVM](./Set-AzureRmVM.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Save-AzureRmVhd.md b/azurermps-6.13.0/AzureRM.Compute/Save-AzureRmVhd.md deleted file mode 100644 index f2a0af50b2..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Save-AzureRmVhd.md +++ /dev/null @@ -1,216 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 18E1AD70-42A6-47A2-A685-6E218B6DC4BE -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/save-azurermvhd -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Save-AzureRmVhd.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Save-AzureRmVhd.md ---- - -# Save-AzureRmVhd - -## SYNOPSIS -Saves downloaded .vhd images locally. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceGroupParameterSetName -``` -Save-AzureRmVhd [-ResourceGroupName] <String> [-SourceUri] <Uri> [-LocalFilePath] <FileInfo> - [[-NumberOfThreads] <Int32>] [-OverWrite] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### StorageKeyParameterSetName -``` -Save-AzureRmVhd [-StorageKey] <String> [-SourceUri] <Uri> [-LocalFilePath] <FileInfo> - [[-NumberOfThreads] <Int32>] [-OverWrite] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Save-AzureRmVhd** cmdlet saves .vhd images from a blob where they are stored to a file. -You can specify the number of downloader threads that the process uses and whether to replace a file that already exists. -This cmdlet downloads content as it is. -It does not apply any Virtual Hard Disk (VHD) format conversion. - -## EXAMPLES - -### Example 1: Download an image -``` -PS C:\> Save-AzureRmVhd -SourceUri "http://contosoaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd" -LocalFilePath "C:\vhd\Win7Image.vhd" -ResourceGroupName "rgname" -``` - -This command downloads a .vhd file, and stores it in the local path C:\vhd\Win7Image.vhd. - -### Example 2: Download an image and overwrite the local file -``` -PS C:\> Save-AzureRmVhd -SourceUri "http://contosoaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd" -LocalFilePath "C:\vhd\Win7Image.vhd" -Overwrite -ResourceGroupName "rgname" -``` - -This command downloads a .vhd file, and stores it in the local path. -The command includes the *Overwrite* parameter. -Therefore, if C:\vhd\Win7Image.vhd already exists, this command replaces it. - -### Example 3: Download an image by using a specified number of threads -``` -PS C:\> Save-AzureRmVhd -SourceUri "http://contosoaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd" -LocalFilePath "C:\vhd\Win7Image.vhd" -NumberOfThreads 32 -ResourceGroupName "rgname" -``` - -This command downloads a .vhd file, and stores it in the local path. -The command specifies a value of 32 for the *NumberOfThreads* parameter. -Therefore, the cmdlet uses 32 threads for this action. - -### Example 4: Download an image and specify the storage key -``` -PS C:\> Save-AzureRmVhd -SourceUri "http://contosoaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd" -LocalFilePath "C:\vhd\Win7Image.vhd" -StorageKey "zNvcH0r5vAGmC5AbwEtpcyWCMyBd3eMDbdaa4ua6kwxq6vTZH3Y+sw==" -ResourceGroupName "rgname" -``` - -This command downloads a .vhd file and specifies the storage key. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalFilePath -Specifies the local file path of the saved image. - -```yaml -Type: System.IO.FileInfo -Parameter Sets: (All) -Aliases: lf - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumberOfThreads -Specifies the number of download threads that this cmdlet uses during download. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: th - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OverWrite -Indicates that this cmdlet replaces the file specified by *LocalFilePath* file if it exists. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: o - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the storage account. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupParameterSetName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceUri -Specifies the Uniform Resource Identifier (URI) of the blob in `Azure`. - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: src, Source - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageKey -Specifies the storage key of the blob storage account. -If you do not specify a key, this cmdlet attempts to determine the storage key of the account in *SourceUri* from Azure. - -```yaml -Type: System.String -Parameter Sets: StorageKeyParameterSetName -Aliases: sk - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Uri - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.VhdDownloadContext - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVhd](./Add-AzureRMVhd.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRMVMDataDisk.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRMVMDataDisk.md deleted file mode 100644 index da875749c6..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRMVMDataDisk.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: C453485D-67A7-480E-83F6-527D4F5EBC93 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmdatadisk -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRMVMDataDisk.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRMVMDataDisk.md ---- - -# Set-AzureRmVMDataDisk - -## SYNOPSIS -Modifies properties of a virtual machine data disk. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ChangeWithName -``` -Set-AzureRmVMDataDisk [-VM] <PSVirtualMachine> [-Name] <String> [[-Caching] <CachingTypes>] - [[-DiskSizeInGB] <Int32>] [-StorageAccountType <String>] [-WriteAccelerator] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ChangeWithLun -``` -Set-AzureRmVMDataDisk [-VM] <PSVirtualMachine> [-Lun] <Int32> [[-Caching] <CachingTypes>] - [[-DiskSizeInGB] <Int32>] [-StorageAccountType <String>] [-WriteAccelerator] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVMDataDisk** cmdlet modifies properties of a virtual machine data disk. - -## EXAMPLES - -### Example 1: Modify the caching mode of a data disk -``` -PS C:\> $VM = Get-AzureRMVM -ResourceGroupName "ResourceGroup11" -VMName "ContosoVM07" -PS C:\> Set-AzureRmVMDataDisk -VM $VM -Name "DataDisk01" -Caching ReadWrite | Update-AzureRmVM -``` - -The first command gets the virtual machine named ContosoVM07 by using **Get-AzureRmVM**. -The command stores it in the $VM variable. -The second command modifies the caching mode for the data disk named DataDisk01 on the virtual machine in $VM. -The command passes the result to the Update-AzureRmVM cmdlet, which implements your changes. -A change to the cashing mode causes the virtual machine to restart. - -## PARAMETERS - -### -Caching -Specifies the caching mode of the disk. -The acceptable values for this parameter are: -- ReadOnly -- ReadWrite -The default value is ReadWrite. -Changing this value causes the virtual machine to restart. -This setting affects the consistency and performance of the disk. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.CachingTypes] -Parameter Sets: (All) -Aliases: -Accepted values: None, ReadOnly, ReadWrite - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskSizeInGB -Specifies the size, in gigabytes, for the data disk. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Lun -Specifies the logical unit number (LUN) of the data disk that this cmdlet modifies. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: ChangeWithLun -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the data disk that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: ChangeWithName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountType -The virtual machine managed disk's account type. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine for which this cmdlet modifies a data disk. -To obtain a virtual machine object, use the Get-AzureRmVM cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine -Parameter Sets: (All) -Aliases: VMProfile - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WriteAccelerator -Specifies whether WriteAccelerator should be enabled or disabled on the data disk. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -### System.String - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.CachingTypes, Microsoft.Azure.Management.Compute, Version=21.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - -[Update-AzureRmVM](./Update-AzureRmVM.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRMVMDiagnosticsExtension.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRMVMDiagnosticsExtension.md deleted file mode 100644 index bf32fcdd00..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRMVMDiagnosticsExtension.md +++ /dev/null @@ -1,267 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 13ED884A-6224-4BD4-9F12-F896932F7842 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmdiagnosticsextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRMVMDiagnosticsExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRMVMDiagnosticsExtension.md ---- - -# Set-AzureRmVMDiagnosticsExtension - -## SYNOPSIS -Configures the Azure diagnostics extension on a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVMDiagnosticsExtension [-ResourceGroupName] <String> [-VMName] <String> - [-DiagnosticsConfigurationPath] <String> [[-StorageAccountName] <String>] [[-StorageAccountKey] <String>] - [[-StorageAccountEndpoint] <String>] [[-StorageContext] <IStorageContext>] [[-Location] <String>] - [[-Name] <String>] [[-TypeHandlerVersion] <String>] [[-AutoUpgradeMinorVersion] <Boolean>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVMDiagnosticsExtension** cmdlet configures the Azure diagnostics extension on a virtual machine. - -## EXAMPLES - -### Example 1: Enable diagnostics using a storage account specified in a diagnostics configuration file -``` -PS C:\> Set-AzureRmVMDiagnosticsExtension -ResourceGroupName "ResourceGroup01" -VMName "VirtualMachine02" -DiagnosticsConfigurationPath "diagnostics_publicconfig.xml" -``` - -This command uses a diagnostics configuration file to enable diagnostics. -The file diagnostics_publicconfig.xml contains the public XML configuration for the diagnostics extension including the name of the storage account to which diagnostics data will be sent. -The diagnostics storage account must be in the same subscription as the virtual machine. - -### Example 2: Enable diagnostics using a storage account name -``` -PS C:\> Set-AzureRmVMDiagnosticsExtension -ResourceGroupName "ResourceGroup1" -VMName "VirtualMachine2" -DiagnosticsConfigurationPath diagnostics_publicconfig.xml -StorageAccountName "MyStorageAccount" -``` - -This command uses the storage account name to enable diagnostics. -If the diagnostics configuration does not specify a storage account name or if you want to override the diagnostics storage account name specified in the configuration file, use the *StorageAccountName* parameter. -The diagnostics storage account must be in the same subscription as the virtual machine. - -### Example 3: Enable diagnostics using storage account name and key -``` -PS C:\> Set-AzureRmVMDiagnosticsExtension -ResourceGroupName "ResourceGroup01" -VMName "VirtualMachine02" -DiagnosticsConfigurationPath "diagnostics_publicconfig.xml" -StorageAccountName "MyStorageAccount" -StorageAccountKey $storage_key -``` - -This command uses the storage account name and key to enable diagnostics. -If the diagnostics storage account is in a different subscription than the virtual machine then enable sending diagnostics data to that storage account by explicitly specifying its name and key. - -## PARAMETERS - -### -AutoUpgradeMinorVersion -Indicates whether this cmdlet allows the Azure guest agent to automatically update the extension to a newer minor version. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 10 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiagnosticsConfigurationPath -Specifies the path of the configuration file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of an extension. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: 8 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountEndpoint -Specifies the storage account endpoint. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountKey -Specifies the storage account key. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountName -Specifies the storage account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageContext -Specifies the Azure storage context. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TypeHandlerVersion -Specifies the version of the extension to use for this virtual machine. -To obtain the version, run the Get-AzureRmVMExtensionImage cmdlet with a value of Microsoft.Compute for the *PublisherName* parameter and VMAccessAgent for the *Type* parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: HandlerVersion, Version - -Required: False -Position: 9 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine on which this cmdlet operates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -### System.Boolean - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMDiagnosticsExtension](./Get-AzureRMVMDiagnosticsExtension.md) - -[Get-AzureRmVMExtensionImage](./Get-AzureRmVMExtensionImage.md) - -[Remove-AzureRmVMDiagnosticsExtension](./Remove-AzureRmVMDiagnosticsExtension.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRMVMSqlServerExtension.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRMVMSqlServerExtension.md deleted file mode 100644 index bfa46aad4c..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRMVMSqlServerExtension.md +++ /dev/null @@ -1,241 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: C650E465-7CDE-47F8-B85A-8FA3E1756FAF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmsqlserverextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRMVMSqlServerExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRMVMSqlServerExtension.md ---- - -# Set-AzureRmVMSqlServerExtension - -## SYNOPSIS -Sets the Azure SQL Server extension on a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVMSqlServerExtension [[-Version] <String>] [-ResourceGroupName] <String> [-VMName] <String> - [[-Name] <String>] [[-AutoPatchingSettings] <AutoPatchingSettings>] - [[-AutoBackupSettings] <AutoBackupSettings>] [[-KeyVaultCredentialSettings] <KeyVaultCredentialSettings>] - [[-Location] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVMSqlServerExtension** cmdlet sets the AzureSQL Server extension on a virtual machine. - -## EXAMPLES - -### Example 1: Set automatic patching settings on a virtual machine -``` -PS C:\> $AutoPatchingConfig = New-AzureVMSqlServerAutoPatchingConfig -Enable -DayOfWeek "Thursday" -MaintenanceWindowStartingHour 11 -MaintenanceWindowDuration 120 -PatchCategory "Important" -PS C:\> Get-AzureRmVM -ServiceName "Service02" -Name "VirtualMachine11" | Set-AzureRmVMSqlServerExtension -AutoPatchingSettings $AutoPatchingConfig | Update-AzureRmVM -``` - -The first command creates a configuration object by using the **New-AzureVMSqlServerAutoPatchingConfig** cmdlet. -The command stores the configuration in the $AutoPatchingConfig variable. -The second command gets the virtual machine named VirtualMachine11 on the service named Service02 by using the Get-AzureRmVM cmdlet. -The command passes that object to the current cmdlet by using the pipeline operator. -The current cmdlet sets the automatic patching settings in $AutoPatchingConfig for the virtual machine. -The command passes the virtual machine to the Update-AzureRmVM cmdlet. - -### Example 2: Set automatic backup settings on a virtual machine -``` -PS C:\> $AutoBackupConfig = New-AzureVMSqlServerAutoBackupConfig -Enable -RetentionPeriod 10 -StorageUri $StorageUrl -StorageKey $StorageAccountKeySecure -PS C:\> Get-AzureRmVM -ServiceName "Service02" -Name "VirtualMachine11" | Set-AzureRmVMSqlServerExtension -AutoBackupSettings $AutoBackupConfig | Update-AzureRmVM -``` - -The first command creates a configuration object by using the **New-AzureVMSqlServerAutoBackupConfig** cmdlet. -The command stores the configuration in the $AutoBackupConfig variable. -The second command gets the virtual machine named VirtualMachine11 on the service named Service02, and then passes it to the current cmdlet. -The current cmdlet sets the automatic backup settings in $AutoBackupConfig for the virtual machine. -The command passes the virtual machine to the Update-AzureRmVM cmdlet. - -### Example 3: Disable a SQL Server extension on a virtual machine -``` -PS C:\> Get-AzureRmVM -ServiceName "Service03" -Name "VirtualMachine08" | Set-AzureRmVMSqlServerExtension -Disable -``` - -This command gets a virtual machine named VirtualMachine08 on Service03, and then passes it to the current cmdlet. -The command disables SQL Server virtual machine extension on that virtual machine. - -### Example 4: Uninstall a SQL Server extension on a specific virtual machine -``` -PS C:\> Get-AzureRmVM -ServiceName "Service03" -Name "VirtualMachine08" | Set-AzureRmVMSqlServerExtension -Uninstall -``` - -This command gets a virtual machine named VirtualMachine08 on Service03, and then passes it to the current cmdlet. -The command uninstalls a SQL Server virtual machine extension on that virtual machine. - -## PARAMETERS - -### -AutoBackupSettings -Specifies the automatic SQL Server backup settings. -To create an **AutoBackupSettings** object , use the New-AzureVMSqlServerAutoBackupConfig cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Compute.AutoBackupSettings -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AutoPatchingSettings -Specifies the automatic SQL Server patching settings. -To create an **AutoPatchingSettings** object , use the New-AzureVMSqlServerAutoPatchingConfig cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Compute.AutoPatchingSettings -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyVaultCredentialSettings -```yaml -Type: Microsoft.Azure.Commands.Compute.KeyVaultCredentialSettings -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the SQL Server the extension. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Version -Specifies the version of the SQL Server extension. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: HandlerVersion - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine on which this cmdlet sets the SQL Server extension. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Compute.AutoPatchingSettings - -### Microsoft.Azure.Commands.Compute.AutoBackupSettings - -### Microsoft.Azure.Commands.Compute.KeyVaultCredentialSettings - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - -[Get-AzureRmVMSqlServerExtension](./Get-AzureRMVMSqlServerExtension.md) - - - -[Remove-AzureRmVMSqlServerExtension](./Remove-AzureRMVMSqlServerExtension.md) - -[Update-AzureRmVM](./Update-AzureRmVM.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmDiskDiskEncryptionKey.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmDiskDiskEncryptionKey.md deleted file mode 100644 index 7ce475133d..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmDiskDiskEncryptionKey.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermdiskdiskencryptionkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmDiskDiskEncryptionKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmDiskDiskEncryptionKey.md ---- - -# Set-AzureRmDiskDiskEncryptionKey - -## SYNOPSIS -Sets the disk encryption key properties on a disk object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmDiskDiskEncryptionKey [-Disk] <PSDisk> [[-SecretUrl] <String>] [[-SourceVaultId] <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDiskDiskEncryptionKey** cmdlet sets the disk encryption key properties on a disk object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $diskconfig = New-AzureRmDiskConfig -Location 'Central US' -DiskSizeGB 5 -AccountType StandardLRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; -PS C:\> $secretUrl = https://myvault.vault-int.azure-int.net/secrets/123/; -PS C:\> $secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; -PS C:\> $keyUrl = https://myvault.vault-int.azure-int.net/keys/456; -PS C:\> $keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; -PS C:\> $diskconfig = Set-AzureRmDiskDiskEncryptionKey -Disk $diskconfig -SecretUrl $secretUrl -SourceVaultId $secretId; -PS C:\> $diskconfig = Set-AzureRmDiskKeyEncryptionKey -Disk $diskconfig -KeyUrl $keyUrl -SourceVaultId $keyId; -PS C:\> New-AzureRmDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -Disk $diskconfig; -``` - -The first command creates a local empty disk object with size 5GB in Standard_LRS storage account type. It also sets Windows OS type and enables encryption settings. -The second and third commands set the disk encryption key and key encryption key settings for the disk object. -The last command takes the disk object and creates a disk with name 'Disk01' in resource group 'ResourceGroup01'. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disk -Specifies a local disk object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -SecretUrl -Specifies the secret Url. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceVaultId -Specifies the source vault ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmDiskImageReference.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmDiskImageReference.md deleted file mode 100644 index 4028e72719..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmDiskImageReference.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermdiskimagereference -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmDiskImageReference.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmDiskImageReference.md ---- - -# Set-AzureRmDiskImageReference - -## SYNOPSIS -Sets the image reference properties on a disk object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmDiskImageReference [-Disk] <PSDisk> [[-Id] <String>] [[-Lun] <Int32>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDiskImageReference** cmdlet sets the image reference properties on a disk object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $diskconfig = New-AzureRmDiskConfig -DiskSizeGB 10 -AccountType PremiumLRS -OsType Windows -CreateOption FromImage; -PS C:\> $image = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.Compute/images/TestImage123'; -PS C:\> $diskconfig = Set-AzureRmDiskImageReference -Disk $diskconfig -Id $image -Lun 0; -PS C:\> New-AzureRmDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -Disk $diskconfig; -``` - -The first command creates a local disk object with size 10GB in Premium_LRS storage account type. It also sets Windows OS type. -The second command sets the image id and the logical unit number 0 for the disk object. -The last command takes the disk object and creates a disk with name 'Disk01' in resource group 'ResourceGroup01'. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disk -Specifies a local disk object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Id -Specifies the ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Lun -Specifies the logical unit number (LUN). - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk - -### System.String - -### System.Int32 - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmDiskKeyEncryptionKey.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmDiskKeyEncryptionKey.md deleted file mode 100644 index d3e772e420..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmDiskKeyEncryptionKey.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermdiskkeyencryptionkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmDiskKeyEncryptionKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmDiskKeyEncryptionKey.md ---- - -# Set-AzureRmDiskKeyEncryptionKey - -## SYNOPSIS -Sets the key encryption key properties on a disk object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmDiskKeyEncryptionKey [-Disk] <PSDisk> [[-KeyUrl] <String>] [[-SourceVaultId] <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDiskKeyEncryptionKey** cmdlet sets the key encryption key properties on a disk object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $diskconfig = New-AzureRmDiskConfig -Location 'Central US' -DiskSizeGB 5 -AccountType StandardLRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; -PS C:\> $secretUrl = https://myvault.vault-int.azure-int.net/secrets/123/; -PS C:\> $secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; -PS C:\> $keyUrl = https://myvault.vault-int.azure-int.net/keys/456; -PS C:\> $keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; -PS C:\> $diskconfig = Set-AzureRmDiskDiskEncryptionKey -Disk $diskconfig -SecretUrl $secretUrl -SourceVaultId $secretId; -PS C:\> $diskconfig = Set-AzureRmDiskKeyEncryptionKey -Disk $diskconfig -KeyUrl $keyUrl -SourceVaultId $keyId; -PS C:\> New-AzureRmDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -Disk $diskconfig; -``` - -The first command creates a local empty disk object with size 5GB in Standard_LRS storage account type. It also sets Windows OS type and enables encryption settings. -The second and third commands set the disk encryption key and key encryption key settings for the disk object. -The last command takes the disk object and creates a disk with name 'Disk01' in resource group 'ResourceGroup01'. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disk -Specifies a local disk object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -KeyUrl -Specifes the key Url. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceVaultId -Specifies the source vault ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmDiskUpdateDiskEncryptionKey.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmDiskUpdateDiskEncryptionKey.md deleted file mode 100644 index 39123027a5..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmDiskUpdateDiskEncryptionKey.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermdiskupdatediskencryptionkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmDiskUpdateDiskEncryptionKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmDiskUpdateDiskEncryptionKey.md ---- - -# Set-AzureRmDiskUpdateDiskEncryptionKey - -## SYNOPSIS -Sets the disk encryption key properties on a disk update object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmDiskUpdateDiskEncryptionKey [-DiskUpdate] <PSDiskUpdate> [[-SecretUrl] <String>] - [[-SourceVaultId] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDiskUpdateDiskEncryptionKey** cmdlet sets the disk encryption key properties on a disk update object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $diskupdateconfig = New-AzureRmDiskUpdateConfig -DiskSizeGB 10 -AccountType PremiumLRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; -PS C:\> $secretUrl = https://myvault.vault-int.azure-int.net/secrets/123/; -PS C:\> $secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; -PS C:\> $keyUrl = https://myvault.vault-int.azure-int.net/keys/456; -PS C:\> $keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; -PS C:\> $diskupdateconfig = Set-AzureRmDiskUpdateDiskEncryptionKey -DiskUpdate $diskupdateconfig -SecretUrl $secretUrl -SourceVaultId $secretId; -PS C:\> $diskupdateconfig = Set-AzureRmDiskUpdateKeyEncryptionKey -DiskUpdate $diskupdateconfig -KeyUrl $keyUrl -SourceVaultId $keyId; -PS C:\> Update-AzureRmDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -DiskUpdate $diskupdateconfig; -``` - -The first command creates a local empty disk update object with size 10GB in Premium_LRS storage account type. It also sets Windows OS type and enables encryption settings. -The second and third commands set the disk encryption key and key encryption key settings for the disk update object. -The last command takes the disk update object and updates an existing disk with name 'Disk01' in resource group 'ResourceGroup01'. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskUpdate -Specifies a local disk update object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskUpdate -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -SecretUrl -Specifies the secret Url. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceVaultId -Specifies the source vault ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskUpdate - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskUpdate - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmDiskUpdateKeyEncryptionKey.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmDiskUpdateKeyEncryptionKey.md deleted file mode 100644 index 8c43aaa688..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmDiskUpdateKeyEncryptionKey.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermdiskupdatekeyencryptionkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmDiskUpdateKeyEncryptionKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmDiskUpdateKeyEncryptionKey.md ---- - -# Set-AzureRmDiskUpdateKeyEncryptionKey - -## SYNOPSIS -Sets the key encryption key properties on a disk update object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmDiskUpdateKeyEncryptionKey [-DiskUpdate] <PSDiskUpdate> [[-KeyUrl] <String>] - [[-SourceVaultId] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDiskUpdateKeyEncryptionKey** cmdlet sets the key encryption key properties on a disk update object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $diskupdateconfig = New-AzureRmDiskUpdateConfig -DiskSizeGB 10 -AccountType PremiumLRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; -PS C:\> $secretUrl = https://myvault.vault-int.azure-int.net/secrets/123/; -PS C:\> $secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; -PS C:\> $keyUrl = https://myvault.vault-int.azure-int.net/keys/456; -PS C:\> $keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; -PS C:\> $diskupdateconfig = Set-AzureRmDiskUpdateDiskEncryptionKey -DiskUpdate $diskupdateconfig -SecretUrl $secretUrl -SourceVaultId $secretId; -PS C:\> $diskupdateconfig = Set-AzureRmDiskUpdateKeyEncryptionKey -DiskUpdate $diskupdateconfig -KeyUrl $keyUrl -SourceVaultId $keyId; -PS C:\> Update-AzureRmDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -DiskUpdate $diskupdateconfig; -``` - -The first command creates a local empty disk update object with size 10GB in Premium_LRS storage account type. It also sets Windows OS type and enables encryption settings. -The second and third commands set the disk encryption key and key encryption key settings for the disk update object. -The last command takes the disk update object and updates an existing disk with name 'Disk01' in resource group 'ResourceGroup01'. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskUpdate -Specifies a local disk update object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskUpdate -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -KeyUrl -Specifes the key Url. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceVaultId -Specifies the source vault ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskUpdate - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskUpdate - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmImageOsDisk.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmImageOsDisk.md deleted file mode 100644 index 1456d14ca6..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmImageOsDisk.md +++ /dev/null @@ -1,258 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermimageosdisk -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmImageOsDisk.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmImageOsDisk.md ---- - -# Set-AzureRmImageOsDisk - -## SYNOPSIS -Sets the operating system disk properties on an image object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmImageOsDisk [-Image] <PSImage> [[-OsType] <OperatingSystemTypes>] - [[-OsState] <OperatingSystemStateTypes>] [[-BlobUri] <String>] [-Caching <CachingTypes>] [-DiskSizeGB <Int32>] - [-StorageAccountType <String>] [-SnapshotId <String>] [-ManagedDiskId <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmImageOsDisk** cmdlet sets the operating system disk properties on an image object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $imageConfig = New-AzureRmImageConfig -Location 'West US'; -PS C:\> $osDiskVhdUri = "https://contoso.blob.core.windows.net/test/os.vhd" -PS C:\> $dataDiskVhdUri1 = "https://contoso.blob.core.windows.net/test/data1.vhd" -PS C:\> $dataDiskVhdUri2 = "https://contoso.blob.core.windows.net/test/data2.vhd" -PS C:\> Set-AzureRmImageOsDisk -Image $imageConfig -OsType 'Windows' -OsState 'Generalized' -BlobUri $osDiskVhdUri; -PS C:\> Add-AzureRmImageDataDisk -Image $imageConfig -Lun 1 -BlobUri $dataDiskVhdUri1; -PS C:\> Add-AzureRmImageDataDisk -Image $imageConfig -Lun 2 -BlobUri $dataDiskVhdUri2; -PS C:\> New-AzureRmImage -Image $imageConfig -ImageName 'ImageName01' -ResourceGroupName 'ResourceGroup01'; -``` - -The first command creates an image object, and then stores it in the $imageConfig variable. -The next three commands assign paths of os disk and two data disks to the $osDiskVhdUri, $dataDiskVhdUri1, and $dataDiskVhdUri2 variables. -This approach is only for readability of the following commands. -The next three commands each adds an os disk and two data disks to the image stored in $imageConfig. -The URI of each disk is stored in $osDiskVhdUri, $dataDiskVhdUri1, and $dataDiskVhdUri2. -The final command creates an image named 'ImageName01' in resource group 'ResourceGroup01'. - -## PARAMETERS - -### -BlobUri -Specifies the Uri of the blob. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Caching -Specifies the caching mode of the disk. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.CachingTypes] -Parameter Sets: (All) -Aliases: -Accepted values: None, ReadOnly, ReadWrite - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskSizeGB -Specifies the size of the disk in GB. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Image -Specifies a local image object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSImage -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ManagedDiskId -Specifies the ID of a managed disk. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OsState -Specifies the OS state. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.OperatingSystemStateTypes] -Parameter Sets: (All) -Aliases: -Accepted values: Generalized, Specialized - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OsType -Specifies the OS type. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes] -Parameter Sets: (All) -Aliases: -Accepted values: Windows, Linux - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SnapshotId -Specifies the ID of a snapshot. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountType -The Storage Account type of Os Image Disk - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSImage - -### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes, Microsoft.Azure.Management.Compute, Version=21.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.OperatingSystemStateTypes, Microsoft.Azure.Management.Compute, Version=21.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -### System.String - -### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.CachingTypes, Microsoft.Azure.Management.Compute, Version=21.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -### System.Int32 - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSImage - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmSnapshotDiskEncryptionKey.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmSnapshotDiskEncryptionKey.md deleted file mode 100644 index 79de662ad2..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmSnapshotDiskEncryptionKey.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermsnapshotdiskencryptionkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmSnapshotDiskEncryptionKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmSnapshotDiskEncryptionKey.md ---- - -# Set-AzureRmSnapshotDiskEncryptionKey - -## SYNOPSIS -Sets the disk encryption key properties on a snapshot object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSnapshotDiskEncryptionKey [-Snapshot] <PSSnapshot> [[-SecretUrl] <String>] - [[-SourceVaultId] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSnapshotDiskEncryptionKey** cmdlet sets the disk encryption key properties on a snapshot object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $snapshotconfig = New-AzureRmSnapshotConfig -Location 'Central US' -DiskSizeGB 5 -AccountType StandardLRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; -PS C:\> $secretUrl = https://myvault.vault-int.azure-int.net/secrets/123/; -PS C:\> $secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; -PS C:\> $keyUrl = https://myvault.vault-int.azure-int.net/keys/456; -PS C:\> $keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; -PS C:\> $snapshotconfig = Set-AzureRmSnapshotDiskEncryptionKey -Snapshot $snapshotconfig -SecretUrl $secretUrl -SourceVaultId $secretId; -PS C:\> $snapshotconfig = Set-AzureRmSnapshotKeyEncryptionKey -Snapshot $snapshotconfig -KeyUrl $keyUrl -SourceVaultId $keyId; -PS C:\> New-AzureRmSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -Snapshot $snapshotconfig; -``` - -The first command creates a local empty snapshot object with size 5GB in Standard_LRS storage account type. It also sets Windows OS type and enables encryption settings. -The second and third commands set the disk encryption key and key encryption key settings for the snapshot object. -The last command takes the snapshot object and creates a snapshot with name 'Snapshot01' in resource group 'ResourceGroup01'. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecretUrl -Specifies the secret Url. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Snapshot -Specifies a local snapshot object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -SourceVaultId -Specifies the source vault ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmSnapshotImageReference.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmSnapshotImageReference.md deleted file mode 100644 index 59ccbfa16a..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmSnapshotImageReference.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermsnapshotimagereference -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmSnapshotImageReference.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmSnapshotImageReference.md ---- - -# Set-AzureRmSnapshotImageReference - -## SYNOPSIS -Sets the image reference properties on a snapshot object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSnapshotImageReference [-Snapshot] <PSSnapshot> [[-Id] <String>] [[-Lun] <Int32>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSnapshotImageReference** cmdlet sets the image reference properties on a snapshot object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $snapshotconfig = New-AzureRmSnapshotConfig -SnapshotSizeGB 10 -AccountType PremiumLRS -OsType Windows -CreateOption FromImage; -PS C:\> $image = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.Compute/images/TestImage123'; -PS C:\> $snapshotconfig = Set-AzureRmSnapshotImageReference -Snapshot $snapshotconfig -Id $image -Lun 0; -PS C:\> New-AzureRmSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -Snapshot $snapshotconfig; -``` - -The first command creates a local snapshot object with size 10GB in Premium_LRS storage account type. It also sets Windows OS type. -The second command sets the image ID and the logical unit number 0 for the snapshot object. -The last command takes the snapshot object and creates a snapshot with name 'Snapshot01' in resource group 'ResourceGroup01'. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Lun -Specifies the logical unit number (LUN). - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Snapshot -Specifies a local snapshot object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot - -### System.String - -### System.Int32 - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmSnapshotKeyEncryptionKey.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmSnapshotKeyEncryptionKey.md deleted file mode 100644 index 08857c1416..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmSnapshotKeyEncryptionKey.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermsnapshotkeyencryptionkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmSnapshotKeyEncryptionKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmSnapshotKeyEncryptionKey.md ---- - -# Set-AzureRmSnapshotKeyEncryptionKey - -## SYNOPSIS -Sets the key encryption key properties on a snapshot object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSnapshotKeyEncryptionKey [-Snapshot] <PSSnapshot> [[-KeyUrl] <String>] [[-SourceVaultId] <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSnapshotKeyEncryptionKey** cmdlet sets the key encryption key properties on a snapshot object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $snapshotconfig = New-AzureRmSnapshotConfig -Location 'Central US' -DiskSizeGB 5 -AccountType StandardLRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; -PS C:\> $secretUrl = https://myvault.vault-int.azure-int.net/secrets/123/; -PS C:\> $secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; -PS C:\> $keyUrl = https://myvault.vault-int.azure-int.net/keys/456; -PS C:\> $keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; -PS C:\> $snapshotconfig = Set-AzureRmSnapshotDiskEncryptionKey -Snapshot $snapshotconfig -SecretUrl $secretUrl -SourceVaultId $secretId; -PS C:\> $snapshotconfig = Set-AzureRmSnapshotKeyEncryptionKey -Snapshot $snapshotconfig -KeyUrl $keyUrl -SourceVaultId $keyId; -PS C:\> New-AzureRmSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -Snapshot $snapshotconfig; -``` - -The first command creates a local empty snapshot object with size 5GB in Standard_LRS storage account type. It also sets Windows OS type and enables encryption settings. -The second and third commands set the disk encryption key and key encryption key settings for the snapshot object. -The last command takes the snapshot object and creates a snapshot with name 'Snapshot01' in resource group 'ResourceGroup01'. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyUrl -Specifes the key Url. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Snapshot -Specifies a local snapshot object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -SourceVaultId -Specifies the source vault ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmSnapshotUpdateDiskEncryptionKey.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmSnapshotUpdateDiskEncryptionKey.md deleted file mode 100644 index e29cf56674..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmSnapshotUpdateDiskEncryptionKey.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermsnapshotupdatediskencryptionkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmSnapshotUpdateDiskEncryptionKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmSnapshotUpdateDiskEncryptionKey.md ---- - -# Set-AzureRmSnapshotUpdateDiskEncryptionKey - -## SYNOPSIS -Sets the disk encryption key properties on a snapshot update object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSnapshotUpdateDiskEncryptionKey [-SnapshotUpdate] <PSSnapshotUpdate> [[-SecretUrl] <String>] - [[-SourceVaultId] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSnapshotUpdateDiskEncryptionKey** cmdlet sets the disk encryption key properties on a snapshot update object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $snapshotupdateconfig = New-AzureRmSnapshotUpdateConfig -DiskSizeGB 10 -AccountType PremiumLRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; -PS C:\> $secretUrl = https://myvault.vault-int.azure-int.net/secrets/123/; -PS C:\> $secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; -PS C:\> $keyUrl = https://myvault.vault-int.azure-int.net/keys/456; -PS C:\> $keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; -PS C:\> $snapshotupdateconfig = Set-AzureRmSnapshotUpdateDiskEncryptionKey -SnapshotUpdate $snapshotupdateconfig -SecretUrl $secretUrl -SourceVaultId $secretId; -PS C:\> $snapshotupdateconfig = Set-AzureRmSnapshotUpdateKeyEncryptionKey -SnapshotUpdate $snapshotupdateconfig -KeyUrl $keyUrl -SourceVaultId $keyId; -PS C:\> Update-AzureRmSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -SnapshotUpdate $snapshotupdateconfig; -``` - -The first command creates a local empty snapshot update object with size 10GB in Premium_LRS storage account type. It also sets Windows OS type and enables encryption settings. -The second and third commands set the disk encryption key and key encryption key settings for the snapshot update object. -The last command takes the snapshot update object and updates an existing snapshot with name 'Snapshot01' in resource group 'ResourceGroup01'. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecretUrl -Specifes the secret Url. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SnapshotUpdate -Specifies a local snapshot update object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshotUpdate -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -SourceVaultId -Specifies the source vault ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshotUpdate - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshotUpdate - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmSnapshotUpdateKeyEncryptionKey.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmSnapshotUpdateKeyEncryptionKey.md deleted file mode 100644 index ee9b3136cf..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmSnapshotUpdateKeyEncryptionKey.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermsnapshotupdatekeyencryptionkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmSnapshotUpdateKeyEncryptionKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmSnapshotUpdateKeyEncryptionKey.md ---- - -# Set-AzureRmSnapshotUpdateKeyEncryptionKey - -## SYNOPSIS -Sets the key encryption key properties on a snapshot update object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSnapshotUpdateKeyEncryptionKey [-SnapshotUpdate] <PSSnapshotUpdate> [[-KeyUrl] <String>] - [[-SourceVaultId] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSnapshotUpdateKeyEncryptionKey** cmdlet sets the key encryption key properties on a snapshot update object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $snapshotupdateconfig = New-AzureRmSnapshotUpdateConfig -DiskSizeGB 10 -AccountType PremiumLRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; -PS C:\> $secretUrl = https://myvault.vault-int.azure-int.net/secrets/123/; -PS C:\> $secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; -PS C:\> $keyUrl = https://myvault.vault-int.azure-int.net/keys/456; -PS C:\> $keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; -PS C:\> $snapshotupdateconfig = Set-AzureRmSnapshotUpdateDiskEncryptionKey -SnapshotUpdate $snapshotupdateconfig -SecretUrl $secretUrl -SourceVaultId $secretId; -PS C:\> $snapshotupdateconfig = Set-AzureRmSnapshotUpdateKeyEncryptionKey -SnapshotUpdate $snapshotupdateconfig -KeyUrl $keyUrl -SourceVaultId $keyId; -PS C:\> Update-AzureRmSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -SnapshotUpdate $snapshotupdateconfig; -``` - -The first command creates a local empty snapshot update object with size 10GB in Premium_LRS storage account type. It also sets Windows OS type and enables encryption settings. -The second and third commands set the disk encryption key and key encryption key settings for the snapshot update object. -The last command takes the snapshot update object and updates an existing snapshot with name 'Snapshot01' in resource group 'ResourceGroup01'. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyUrl -Specifes the key Url. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SnapshotUpdate -Specifies a local snapshot update object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshotUpdate -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -SourceVaultId -Specifies the source vault ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshotUpdate - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshotUpdate - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVM.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVM.md deleted file mode 100644 index 0b469e3f1a..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVM.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 939320CB-2595-4150-AFDD-500CEA78559C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvm -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVM.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVM.md ---- - -# Set-AzureRmVM - -## SYNOPSIS -Marks a virtual machine as generalized. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GeneralizeResourceGroupNameParameterSetName (Default) -``` -Set-AzureRmVM [-ResourceGroupName] <String> [-Name] <String> [-Generalized] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### RedeployResourceGroupNameParameterSetName -``` -Set-AzureRmVM [-ResourceGroupName] <String> [-Name] <String> [-Redeploy] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GeneralizeIdParameterSetName -``` -Set-AzureRmVM [-Id] <String> [-Name] <String> [-Generalized] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### RedeployIdParameterSetName -``` -Set-AzureRmVM [-Id] <String> [-Name] <String> [-Redeploy] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVM** cmdlet marks a virtual machine as generalized. -Before you run this cmdlet, log on to the virtual machine and use Sysprep to prepare the hard disk. - -## EXAMPLES - -### Example 1: Mark a virtual machine as generalized -``` -PS C:\> Set-AzureRmVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -Generalized -``` - -This command marks the virtual machine named VirtualMachine07 as generalized. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Generalized -Indicates that this cmdlet marks a virtual machine as generalized. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: GeneralizeResourceGroupNameParameterSetName, GeneralizeIdParameterSetName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the Resource ID of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: GeneralizeIdParameterSetName, RedeployIdParameterSetName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual machine on which this cmdlet operates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Redeploy -Indicates that this cmdlet manually redeploys the virtual machine to a different Azure host to fix any problems. -If you redeploy a virtual machine, it restarts, which results in the loss of ephemeral drive data. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: RedeployResourceGroupNameParameterSetName, RedeployIdParameterSetName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: GeneralizeResourceGroupNameParameterSetName, RedeployResourceGroupNameParameterSetName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSComputeLongRunningOperation - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMADDomainExtension.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMADDomainExtension.md deleted file mode 100644 index fefad34101..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMADDomainExtension.md +++ /dev/null @@ -1,289 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 65BF37D3-4FCE-48A3-BC5D-01AA20FEB6CA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmaddomainextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVMADDomainExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVMADDomainExtension.md ---- - -# Set-AzureRmVMADDomainExtension - -## SYNOPSIS -Adds an AD domain extension to a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVMADDomainExtension -DomainName <String> [-OUPath <String>] [-JoinOption <UInt32>] - [-Credential <PSCredential>] [-Restart] [-ResourceGroupName] <String> [-VMName] <String> [-Name <String>] - [-TypeHandlerVersion <String>] [-Location <String>] [-DisableAutoUpgradeMinorVersion] [-ForceRerun <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVMADDomainExtension** cmdlet adds a Microsoft Entra domain virtual machine extension to a virtual machine. -This extension lets your virtual machine join a domain. - -## EXAMPLES - -## PARAMETERS - -### -Credential -Specifies the user name and password for the virtual machine as a **PSCredential** object. -To obtain a credential, use the Get-Credential cmdlet. -For more information, type `Get-Help Get-Credential`. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableAutoUpgradeMinorVersion -Indicates that this cmdlet disables auto-upgrade of the minor version of the extension. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DomainName -Specifies the name of the domain. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ForceRerun -Indicates that this cmdlet forces a rerun of the same extension configuration on the virtual machine without uninstalling and reinstalling the extension. -The value can be any string different from the current value. -If forceUpdateTag is not changed, updates to public or protected settings are still applied by the handler. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -JoinOption -Specifies the join option. For join options see [fJoinOptions](https://docs.microsoft.com/en-us/windows/desktop/api/lmjoin/nf-lmjoin-netjoindomain) - -```yaml -Type: System.Nullable`1[System.UInt32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the domain extension to add. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OUPath -Specifies an organizational unit (OU) for the domain account. -Enter the full distinguished name of the OU in quotation marks. -The default value is the default OU for machine objects in the domain. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Restart -Indicates that this cmdlet restarts the virtual machine. -A restart is often required to make the change effective. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TypeHandlerVersion -Specifies the version of the domain extension. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: HandlerVersion, Version - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.UInt32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Management.Automation.PSCredential - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMADDomainExtension](./Get-AzureRmVMADDomainExtension.md) diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMAEMExtension.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMAEMExtension.md deleted file mode 100644 index 5b29ccd0af..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMAEMExtension.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 3B15C734-DF57-433A-8854-ACE2B35FF6CB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmaemextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVMAEMExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVMAEMExtension.md ---- - -# Set-AzureRmVMAEMExtension - -## SYNOPSIS -Enables support for monitoring for SAP systems. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVMAEMExtension [-ResourceGroupName] <String> [-VMName] <String> [-EnableWAD] - [[-WADStorageAccountName] <String>] [[-OSType] <String>] [-SkipStorage] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVMAEMExtension** cmdlet updates the configuration of a virtual machine to enable or update the support for monitoring for SAP systems that are installed on the virtual machine. -The cmdlet installs the Azure Enhanced Monitoring (AEM) extension that collects the performance data and makes it discoverable for the SAP system. - -## EXAMPLES - -### Example 1: Use AEM extension -``` -PS C:\> Set-AzureRmVMAEMExtension -ResourceGroupName "ResourceGroup11" -VMName "contoso-server" -WADStorageAccountName "stdstorage" -``` - -This command configures the virtual machine named contoso-server to use the AEM extension. -The command specifies the storage account named stdstorage. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableWAD -If this parameter is provided, the commandlet will enable Windows Azure Diagnostics for this virtual machine. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OSType -Specifies the type of the operating system of the operating system disk. -If the operating system disk does not have a type, you must specify this parameter. -The acceptable values for this parameter are: Windows and Linux. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkipStorage -Indicates that this cmdlet skips configuration of storage. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine. -This cmdlet adds the AEM extension for the virtual machine that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WADStorageAccountName -Specifies the name of the storage account that this cmdlet uses to configure the LinuxDiagnostics or IaaSDiagnostics extension. -If the virtual machine does not use a standard storage account, you must specify a value for this parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMAEMExtension](./Get-AzureRmVMAEMExtension.md) - -[Remove-AzureRmVMAEMExtension](./Remove-AzureRmVMAEMExtension.md) - -[Test-AzureRmVMAEMExtension](./Test-AzureRmVMAEMExtension.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMAccessExtension.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMAccessExtension.md deleted file mode 100644 index 85014a6488..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMAccessExtension.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: D93666EC-C252-4E3B-B311-50B6EEA6D4BF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmaccessextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVMAccessExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVMAccessExtension.md ---- - -# Set-AzureRmVMAccessExtension - -## SYNOPSIS -Adds the VMAccess extension to a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVMAccessExtension [-Credential <PSCredential>] [-ResourceGroupName] <String> [-VMName] <String> - [-Name <String>] [-TypeHandlerVersion <String>] [-Location <String>] [-DisableAutoUpgradeMinorVersion] - [-ForceRerun <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVMAccessExtension** cmdlet adds the Virtual Machine Access (VMAccess) Virtual Machine VMAccess Extension to a virtual machine. VMAccess Extension can be used to set a temporary password and this should be immediately changed it after logging into the machine. This is not supported on Windows Domain Controllers. - -## EXAMPLES - -### Example 1: Add a VMAccess extension -``` -PS C:\> Set-AzureRmVMAccessExtension -ResourceGroupName "ResrouceGroup11" -Location "Central US" -VMName "VirtualMachine07" -Name "ContosoTest" -TypeHandlerVersion "2.4" -UserName "PFuller" -Password "Password" -``` - -This command adds a VMAccess extension for the virtual machine named VirtualMachine07 in ResrouceGroup11. -The command specifies the name and type handler version for VMAccess. - -## PARAMETERS - -### -Credential -Specifies the user name and password for the virtual machine as a **PSCredential** object. -If you type a different name than the current local administrator account on your VM, the VMAccess extension will add a local administrator account with that name, and assign your specified password to that account. If the local administrator account on your VM exists, it will reset the password and if the account is disabled, the VMAccess extension enables it. -To obtain a credential, use the Get-Credential cmdlet. -For more information, type `Get-Help Get-Credential`. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableAutoUpgradeMinorVersion -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ForceRerun -Indicates that this cmdlet forces a rerun of the same extension configuration on the virtual machine without uninstalling and reinstalling the extension. -The value can be any string different from the current value. -If forceUpdateTag is not changed, updates to public or protected settings are still applied by the handler. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the extension that this cmdlet adds. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TypeHandlerVersion -Specifies the version of the extension to use for this virtual machine. -To obtain the version, run the Get-AzureRmVMExtensionImage cmdlet with a value of Microsoft.Compute for the *PublisherName* parameter and VMAccessAgent for the *Type* parameter. The typeHandlerVersion must be 2.0 or greater, as version 1 is deprecated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: HandlerVersion, Version - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine. -This cmdlet adds VMAccess for the virtual machine that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Management.Automation.PSCredential - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMAccessExtension](./Get-AzureRmVMAccessExtension.md) - -[Remove-AzureRmVMAccessExtension](./Remove-AzureRmVMAccessExtension.md) - -[Set-AzureRmVMExtension](./Set-AzureRmVMExtension.md) - -[Get-AzureRmVMExtensionImage](./Get-AzureRmVMExtensionImage.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMBackupExtension.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMBackupExtension.md deleted file mode 100644 index 1ab6dc193f..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMBackupExtension.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: CBFFBF1B-1AF0-4D2F-9315-C3790A4E9346 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmbackupextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVMBackupExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVMBackupExtension.md ---- - -# Set-AzureRmVMBackupExtension - -## SYNOPSIS -Sets the backup extension properties on a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVMBackupExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name] <String> [-Tag] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION - -## EXAMPLES - -### 1: -``` -PS C:\> -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMBginfoExtension.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMBginfoExtension.md deleted file mode 100644 index 42ce557cee..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMBginfoExtension.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: B2B4E132-4A71-4DB8-A7B9-9ED3FE7EB292 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmbginfoextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVMBginfoExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVMBginfoExtension.md ---- - -# Set-AzureRmVMBginfoExtension - -## SYNOPSIS -Adds the BGInfo extension to a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVMBginfoExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name <String>] - [-TypeHandlerVersion <String>] [-Location <String>] [-DisableAutoUpgradeMinorVersion] [-ForceRerun <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVMBGInfoExtension** cmdlet adds the BGInfo extension to a virtual machine. - -## EXAMPLES - -### Example 1: Add the BGInfo extension for a virtual machine -``` -PS C:\> Set-AzureRmVMBgInfoExtension -ResourceGroupName "ContosoRG" -VMName "ContosoVM" -Name "ExtensionName" -TypeHandlerVersion "2.1" -Location "West Europe" -``` - -This command adds the BGInfo extension to virtual machine named ContosoVM. -The command specifies the resource group and location of the virtual machine. -The command specifies the name and version of the extension. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableAutoUpgradeMinorVersion -Indicates that this cmdlet prevents the Azure guest agent from automatically updating the extension to a newer minor version. -By default, this cmdlet enables the guest agent to update the extension. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ForceRerun -Specifies that the extension should be run again with the same public or protected settings. -The value can be any string different from the current value. -If forceUpdateTag is not changed, updates to public or protected settings are still applied by the handler. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the BGInfo extension that this cmdlet adds to a virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine to which this cmdlet adds an extension. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TypeHandlerVersion -Specifies the version of the extension that this cmdlet adds to the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: HandlerVersion, Version - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine to which this cmdlet adds the BGInfo extension. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMBootDiagnostics.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMBootDiagnostics.md deleted file mode 100644 index a3e9869897..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMBootDiagnostics.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 9A6F140C-9F1C-4701-9603-FC6107FCAF92 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmbootdiagnostics -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVMBootDiagnostics.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVMBootDiagnostics.md ---- - -# Set-AzureRmVMBootDiagnostics - -## SYNOPSIS -Modifies boot diagnostics properties of a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### EnableBootDiagnostics -``` -Set-AzureRmVMBootDiagnostics [-VM] <PSVirtualMachine> [-Enable] [-ResourceGroupName] <String> - [[-StorageAccountName] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### DisableBootDiagnostics -``` -Set-AzureRmVMBootDiagnostics [-VM] <PSVirtualMachine> [-Disable] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVMBootDiagnostics** cmdlet modifies boot diagnostics properties of a virtual machine. - -## EXAMPLES - -### Example 1: Enable boot diagnostics -``` -PS C:\> $VM = Get-AzureRmVM -ResourceGroupName "ResourceGroup11" -Name "ContosoVM07" -PS C:\> Set-AzureRmVMBootDiagnostics -VM $VM -Enable -ResourceGroupName "ResourceGroup11" -StorageAccountName "DiagnosticStorage" -``` - -The first command gets the virtual machine named ContosoVM07 by using **Get-AzureRmVM**. -The command stores it in the $VM variable. -The second command enables boot diagnostics for the virtual machine in $VM. -Diagnostics data is stored in the specified account. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disable -Indicates that this cmdlet disables the boot diagnostics for the virtual machine. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: DisableBootDiagnostics -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enable -Indicates that this cmdlet enables the boot diagnostics for the virtual machine. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: EnableBootDiagnostics -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: EnableBootDiagnostics -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountName -Specifies the name of the storage account in which to save boot diagnostics data. - -```yaml -Type: System.String -Parameter Sets: EnableBootDiagnostics -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine for which this cmdlet changes boot diagnostics. -To obtain a virtual machine object, use the Get-AzureRmVM cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine -Parameter Sets: (All) -Aliases: VMProfile - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - -[Get-AzureRmVMBootDiagnosticsData](./Get-AzureRmVMBootDiagnosticsData.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMChefExtension.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMChefExtension.md deleted file mode 100644 index 772e4d7b83..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMChefExtension.md +++ /dev/null @@ -1,456 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: CC306D8C-A5EE-4655-B686-E5A77CCE5042 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmchefextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVMChefExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVMChefExtension.md ---- - -# Set-AzureRmVMChefExtension - -## SYNOPSIS -Adds a Chef extension to a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Linux -``` -Set-AzureRmVMChefExtension [-ResourceGroupName] <String> [-VMName] <String> [[-TypeHandlerVersion] <String>] - -ValidationPem <String> [-ClientRb <String>] [-BootstrapOptions <String>] [-JsonAttribute <String>] - [-ChefDaemonInterval <String>] [-Daemon <String>] [-Secret <String>] [-SecretFile <String>] - [-RunList <String>] [-ChefServerUrl <String>] [-ValidationClientName <String>] [-OrganizationName <String>] - [-BootstrapVersion <String>] [-Linux] [[-Location] <String>] [[-Name] <String>] - [[-AutoUpgradeMinorVersion] <Boolean>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### Windows -``` -Set-AzureRmVMChefExtension [-ResourceGroupName] <String> [-VMName] <String> [[-TypeHandlerVersion] <String>] - -ValidationPem <String> [-ClientRb <String>] [-BootstrapOptions <String>] [-JsonAttribute <String>] - [-ChefDaemonInterval <String>] [-Daemon <String>] [-Secret <String>] [-SecretFile <String>] - [-RunList <String>] [-ChefServerUrl <String>] [-ValidationClientName <String>] [-OrganizationName <String>] - [-BootstrapVersion <String>] [-Windows] [[-Location] <String>] [[-Name] <String>] - [[-AutoUpgradeMinorVersion] <Boolean>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureVMChefExtension** cmdlet adds the Chef extension to the virtual machine. - -## EXAMPLES - -### Example 1: Add a Chef extension to a Windows virtual machine -``` -PS C:\> Set-AzureRmVMChefExtension -ResourceGroupName "ResourceGroup001" -VMName "WindowsVM001" -ValidationPem "C:\my-org-validator.pem" -ClientRb "C:\client.rb" -RunList "Apache" -Daemon "service" -SecretFile "C:\my_encrypted_data_bag_secret" -Windows -``` - -This command adds a Chef extension to a Windows virtual machine named WindowsVM001. -When the virtual machine starts, Chef bootstraps the virtual machine to run Apache. - -### Example 2: Add a Chef extension to a Linux virtual machine -``` -PS C:\> Set-AzureRmVMChefExtension -ResourceGroupName "ResourceGroup002" -VMName "LinuxVM001" -ValidationPem "C:\my-org-validator.pem" -ClientRb "C:\client.rb" -RunList "Apache" -Secret "my_secret" -Linux -``` - -This command adds a Chef extension to a Linux virtual machine named LinuxVM001. -When the virtual machine starts, Chef bootstraps the virtual machine to run Apache. - -### Example 3: Add a Chef extension to a Windows virtual machine with bootstrap options -``` -PS C:\> Set-AzureRmVMChefExtension -ResourceGroupName "ResourceGroup003" -VMName "WindowsVM002" -ValidationPem C:\my-org-validator.pem -ClientRb C:\client.rb -BootstrapOptions '{"chef_node_name":"your_node_name","chef_server_url":"https://api.opscode.com/organizations/some-org", "validation_client_name":"some-org-validator"}' -RunList "Apache" -Windows -``` - -This command adds the Chef extension to a Windows virtual machine named WindowsVM002. -When the virtual machine starts, Chef bootstraps the virtual machine to run Apache. -After bootstrapping, the virtual machine refers to the BootstrapOptions specified in JSON format. - -## PARAMETERS - -### -AutoUpgradeMinorVersion -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 10 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BootstrapOptions -Specifies configuration settings in the client_rb option. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BootstrapVersion -Specifies the version of the bootstrap configuration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ChefDaemonInterval -Specifies the frequency (in minutes) at which the chef-service runs. If in case you don't want the chef-service to be installed on the Azure VM then set value as 0 in this field. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ChefServiceInterval - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ChefServerUrl -Specifies the Chef server link, as a URL. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ClientRb -Specifies the full path of the Chef client.rb. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Daemon -Configures the chef-client service for unattended execution. The node platform should be Windows. -Allowed options: 'none','service' and 'task'. -none - Currently prevents the chef-client service from being configured as a service. -service - Configures the chef-client to run automatically in the background as a service. -task - Configures the chef-client to run automatically in the background as a secheduled task. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: none, service, task - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JsonAttribute -A JSON string to be added to the first run of chef-client. e.g. -JsonAttribute '{"foo" : "bar"}' - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Linux -Indicates that this cmdlet creates a Windows virtual machine. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Linux -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Chef extension. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: 8 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OrganizationName -Specifies the organization name of the Chef extension. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RunList -Specifies the Chef node run list. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Secret -The encryption key used to encrypt and decrypt the data bag item values. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecretFile -The path to the file that contains the encryption key used to encrypt and decrypt the data bag item values. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TypeHandlerVersion -Specifies the version of the extension to use for this virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: HandlerVersion, Version - -Required: False -Position: 9 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ValidationClientName -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ValidationPem -Specifies the Chef validator .pem file path - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine. -This cmdlet adds the Chef extension for the virtual machine that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Windows -Indicates that this cmdlet creates a Windows virtual machine. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Windows -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Boolean - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMChefExtension](./Get-AzureRmVMChefExtension.md) - -[Remove-AzureRmVMChefExtension](./Remove-AzureRmVMChefExtension.md) diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMCustomScriptExtension.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMCustomScriptExtension.md deleted file mode 100644 index 602751706f..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMCustomScriptExtension.md +++ /dev/null @@ -1,366 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 64AB1BAE-A756-43A8-A40F-10B746EA0946 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmcustomscriptextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVMCustomScriptExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVMCustomScriptExtension.md ---- - -# Set-AzureRmVMCustomScriptExtension - -## SYNOPSIS -Adds a custom script extension to a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetCustomScriptExtensionByContainerAndFileNames (Default) -``` -Set-AzureRmVMCustomScriptExtension -ContainerName <String> -FileName <String[]> [-StorageAccountName <String>] - [-StorageEndpointSuffix <String>] [-StorageAccountKey <String>] [-Run <String>] [-Argument <String>] - [-SecureExecution] [-ResourceGroupName] <String> [-VMName] <String> [-Name <String>] - [-TypeHandlerVersion <String>] [-Location <String>] [-DisableAutoUpgradeMinorVersion] [-ForceRerun <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetCustomScriptExtensionByUriLinks -``` -Set-AzureRmVMCustomScriptExtension [-FileUri <String[]>] [-Run <String>] [-Argument <String>] - [-SecureExecution] [-ResourceGroupName] <String> [-VMName] <String> [-Name <String>] - [-TypeHandlerVersion <String>] [-Location <String>] [-DisableAutoUpgradeMinorVersion] [-ForceRerun <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVMCustomScriptExtension** cmdlet adds a custom script Virtual Machine Extension to a virtual machine. -This extension lets you run your own scripts on the virtual machine. - -## EXAMPLES - -### Example 1: Add a custom script -``` -PS C:\> Set-AzureRmVMCustomScriptExtension -ResourceGroupName "ResourceGroup11" -Location "Central US" -VMName "VirtualMachine07" -Name "ContosoTest" -TypeHandlerVersion "1.1" -StorageAccountName "Contoso" -StorageAccountKey <StorageKey> -FileName "ContosoScript.exe" -ContainerName "Scripts" -``` - -This command adds a custom script to the virtual machine named VirtualMachine07. -The script file is contososcript.exe. - -## PARAMETERS - -### -Argument -Specifies arguments that the script extension passes to the script. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ContainerName -Specifies the name of the Azure storage container where this cmdlet stores the script. - -```yaml -Type: System.String -Parameter Sets: SetCustomScriptExtensionByContainerAndFileNames -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableAutoUpgradeMinorVersion -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FileName -Specifies the name of the script file. If the file is stored in Azure Blob storage, the file name -value is case-senstive. File names of files stored in Azure File storage are not case-senstive. - -```yaml -Type: System.String[] -Parameter Sets: SetCustomScriptExtensionByContainerAndFileNames -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FileUri -Specifies the URI of the script file. - -```yaml -Type: System.String[] -Parameter Sets: SetCustomScriptExtensionByUriLinks -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ForceRerun -Indicates that this cmdlet forces a rerun of the same extension configuration on the virtual machine without uninstalling and reinstalling the extension. -The value can be any string different from the current value. -If forceUpdateTag is not changed, updates to public or protected settings are still applied by the handler. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the custom script extension. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Run -Specifies the command to use that runs your script. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: RunFile, Command - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecureExecution -Indicates that this cmdlet makes sure that the value of the *Run* parameter is not logged on the server or returned to the user by using the GET extension API. -The value of *Run* might contain secrets or passwords to be passed to the script file securely. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountKey -Specifies the key for the Azure storage container. - -```yaml -Type: System.String -Parameter Sets: SetCustomScriptExtensionByContainerAndFileNames -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountName -Specifies the name of the Azure storage account where this cmdlet stores the script. - -```yaml -Type: System.String -Parameter Sets: SetCustomScriptExtensionByContainerAndFileNames -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageEndpointSuffix -Specifies the storage endpoint suffix. - -```yaml -Type: System.String -Parameter Sets: SetCustomScriptExtensionByContainerAndFileNames -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TypeHandlerVersion -Specifies the version of the extension to use for this virtual machine. -To obtain the version, run the Get-AzureRmVMExtensionImage cmdlet with a value of Microsoft.Compute for the *PublisherName* parameter and VMAccessAgent for the *Type* parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: HandlerVersion, Version - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine. -This cmdlet adds the custom script extension for the virtual machine that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.String[] - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMCustomScriptExtension](./Get-AzureRmVMCustomScriptExtension.md) - -[Remove-AzureRmVMCustomScriptExtension](./Remove-AzureRmVMCustomScriptExtension.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMDiskEncryptionExtension.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMDiskEncryptionExtension.md deleted file mode 100644 index 4ce0d875bf..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMDiskEncryptionExtension.md +++ /dev/null @@ -1,634 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 6BCB36BC-F5E6-4EDD-983C-8BDE7A9B004D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmdiskencryptionextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVMDiskEncryptionExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVMDiskEncryptionExtension.md ---- - -# Set-AzureRmVMDiskEncryptionExtension - -## SYNOPSIS -Enables encryption on a running IaaS virtual machine in Azure. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SinglePassParameterSet (Default) -``` -Set-AzureRmVMDiskEncryptionExtension [-ResourceGroupName] <String> [-VMName] <String> - [-DiskEncryptionKeyVaultUrl] <String> [-DiskEncryptionKeyVaultId] <String> [[-KeyEncryptionKeyUrl] <String>] - [[-KeyEncryptionKeyVaultId] <String>] [[-KeyEncryptionAlgorithm] <String>] [[-VolumeType] <String>] - [[-SequenceVersion] <String>] [[-TypeHandlerVersion] <String>] [[-Name] <String>] [[-Passphrase] <String>] - [-Force] [-DisableAutoUpgradeMinorVersion] [-SkipVmBackup] [-ExtensionType <String>] - [-ExtensionPublisherName <String>] [-EncryptFormatAll] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### AADClientSecretParameterSet -``` -Set-AzureRmVMDiskEncryptionExtension [-ResourceGroupName] <String> [-VMName] <String> [-AadClientID] <String> - [-AadClientSecret] <String> [-DiskEncryptionKeyVaultUrl] <String> [-DiskEncryptionKeyVaultId] <String> - [[-KeyEncryptionKeyUrl] <String>] [[-KeyEncryptionKeyVaultId] <String>] [[-KeyEncryptionAlgorithm] <String>] - [[-VolumeType] <String>] [[-SequenceVersion] <String>] [[-TypeHandlerVersion] <String>] [[-Name] <String>] - [[-Passphrase] <String>] [-Force] [-DisableAutoUpgradeMinorVersion] [-SkipVmBackup] [-ExtensionType <String>] - [-ExtensionPublisherName <String>] [-EncryptFormatAll] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### AADClientCertParameterSet -``` -Set-AzureRmVMDiskEncryptionExtension [-ResourceGroupName] <String> [-VMName] <String> [-AadClientID] <String> - [-AadClientCertThumbprint] <String> [-DiskEncryptionKeyVaultUrl] <String> [-DiskEncryptionKeyVaultId] <String> - [[-KeyEncryptionKeyUrl] <String>] [[-KeyEncryptionKeyVaultId] <String>] [[-KeyEncryptionAlgorithm] <String>] - [[-VolumeType] <String>] [[-SequenceVersion] <String>] [[-TypeHandlerVersion] <String>] [[-Name] <String>] - [[-Passphrase] <String>] [-Force] [-DisableAutoUpgradeMinorVersion] [-SkipVmBackup] [-ExtensionType <String>] - [-ExtensionPublisherName <String>] [-EncryptFormatAll] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVMDiskEncryptionExtension** cmdlet enables encryption on a running infrastructure as a service (IaaS) virtual machine in Azure. -This cmdlet enables encryption by installing the disk encryption extension on the virtual machine. -If no *Name* parameter is specified, an extension with the default name AzureDiskEncryption for virtual machines that run the Windows operating system or AzureDiskEncryptionForLinux for Linux virtual machines are installed. -This cmdlet requires confirmation from the users as one of the steps to enable encryption requires a restart of the virtual machine. -It is advised that you save your work on the virtual machine before you run this cmdlet. - -## EXAMPLES - -### Example 1: Enable encryption -``` -$RGName = "MyResourceGroup" -$VMName = "MyTestVM" -$VaultName= "MyKeyVault" -$KeyVault = Get-AzureRmKeyVault -VaultName $VaultName -ResourceGroupName $RGName -$DiskEncryptionKeyVaultUrl = $KeyVault.VaultUri -$KeyVaultResourceId = $KeyVault.ResourceId -Set-AzureRmVMDiskEncryptionExtension -ResourceGroupName $RGName -VMName $VMName -DiskEncryptionKeyVaultUrl $DiskEncryptionKeyVaultUrl -DiskEncryptionKeyVaultId $KeyVaultResourceId -``` - -This example demonstrates enabling encryption without specifying AD credentials. - -### Example 2: Enable encryption with pipelined input -``` -$params = New-Object PSObject -Property @{ - ResourceGroupName = "[resource-group-name]" - VMName = "[vm-name]" - DiskEncryptionKeyVaultId = "/subscriptions/[subscription-id-guid]/resourceGroups/[resource-group-name]/providers/Microsoft.KeyVault/vaults/[keyvault-name]" - DiskEncryptionKeyVaultUrl = "https://[keyvault-name].vault.azure.net" - KeyEncryptionKeyVaultId = "/subscriptions/[subscription-id-guid]/resourceGroups/[resource-group-name]/providers/Microsoft.KeyVault/vaults/[keyvault-name]" - KeyEncryptionKeyUrl = "https://[keyvault-name].vault.azure.net/keys/[kekname]/[kek-unique-id]" - VolumeType = "All" -} - -$params | Set-AzureRmVmDiskEncryptionExtension -``` - -This example demonstrates sending parameters using pipelined input to enable encryption without specifying AD credentials. - -### Example 3: Enable encryption using Microsoft Entra Client ID and Client Secret -``` -$RGName = "MyResourceGroup" -$VMName = "MyTestVM" -$AADClientID = "<clientID of your Azure AD app>" -$AADClientSecret = "<clientSecret of your Azure AD app>" -$VaultName= "MyKeyVault" -$KeyVault = Get-AzureRmKeyVault -VaultName $VaultName -ResourceGroupName $RGName -$DiskEncryptionKeyVaultUrl = $KeyVault.VaultUri -$KeyVaultResourceId = $KeyVault.ResourceId -Set-AzureRmVMDiskEncryptionExtension -ResourceGroupName $RGName -VMName $VMName -AadClientID $AADClientID -AadClientSecret $AADClientSecret -DiskEncryptionKeyVaultUrl $DiskEncryptionKeyVaultUrl -DiskEncryptionKeyVaultId $KeyVaultResourceId -``` - -This example enables encryption using Microsoft Entra client ID, and client secret. - -### Example 4: Enable encryption using Microsoft Entra client ID and client certification thumbprint -``` -$RGName = "MyResourceGroup" -$VMName = "MyTestVM" -#The KeyVault must have enabledForDiskEncryption property set on it -$VaultName= "MyKeyVault" -$KeyVault = Get-AzureRmKeyVault -VaultName $VaultName -ResourceGroupName $RGName -$DiskEncryptionKeyVaultUrl = $KeyVault.VaultUri -$KeyVaultResourceId = $KeyVault.ResourceId - -# create Azure AD application and associate the certificate -$CertPath = "C:\certificates\examplecert.pfx" -$CertPassword = "Password" -$Cert = New-Object System.Security.Cryptography.X509Certificates.X509Certificate2($CertPath, $CertPassword) -$CertValue = [System.Convert]::ToBase64String($cert.GetRawCertData()) -$AzureAdApplication = New-AzureRmADApplication -DisplayName "<Your Application Display Name>" -HomePage "<https://YourApplicationHomePage>" -IdentifierUris "<https://YouApplicationUri>" -CertValue $CertValue -$ServicePrincipal = New-AzureRmADServicePrincipal -ApplicationId $AzureAdApplication.ApplicationId - -$AADClientID = $AzureAdApplication.ApplicationId -$aadClientCertThumbprint= $cert.Thumbprint - -#Upload pfx to KeyVault -$KeyVaultSecretName = "MyAADCert" -$FileContentBytes = get-content $CertPath -Encoding Byte -$FileContentEncoded = [System.Convert]::ToBase64String($fileContentBytes) -$JSONObject = @" - { - "data" : "$filecontentencoded", - "dataType" : "pfx", - "password" : "$CertPassword" - } -"@ -$JSONObjectBytes = [System.Text.Encoding]::UTF8.GetBytes($jsonObject) -$JSONEncoded = [System.Convert]::ToBase64String($jsonObjectBytes) - -$Secret = ConvertTo-SecureString -String $JSONEncoded -AsPlainText -Force -Set-AzureKeyVaultSecret -VaultName $VaultName -Name $KeyVaultSecretName -SecretValue $Secret -Set-AzureRmKeyVaultAccessPolicy -VaultName $VaultName -ResourceGroupName $RGName -EnabledForDeployment - -#deploy cert to VM -$CertUrl = (Get-AzureKeyVaultSecret -VaultName $VaultName -Name $KeyVaultSecretName).Id -$SourceVaultId = (Get-AzureRmKeyVault -VaultName $VaultName -ResourceGroupName $RGName).ResourceId -$VM = Get-AzureRmVM -ResourceGroupName $RGName -Name $VMName -$VM = Add-AzureRmVMSecret -VM $VM -SourceVaultId $SourceVaultId -CertificateStore "My" -CertificateUrl $CertUrl -Update-AzureRmVM -VM $VM -ResourceGroupName $RGName - -#Enable encryption on the virtual machine using Azure AD client ID and client cert thumbprint -Set-AzureRmVMDiskEncryptionExtension -ResourceGroupName $RGName -VMName $VMName -AadClientID $AADClientID -AadClientCertThumbprint $AADClientCertThumbprint -DiskEncryptionKeyVaultUrl $DiskEncryptionKeyVaultUrl -DiskEncryptionKeyVaultId $KeyVaultResourceId -``` - -This example enables encryption using Microsoft Entra client ID and client certification thumbprints. - -### Example 5: Enable encryption using Microsoft Entra client ID, client secret, and wrap disk encryption key by using key encryption key -``` -$RGName = "MyResourceGroup" -$VMName = "MyTestVM" - -$AADClientID = "<clientID of your Azure AD app>" -$AADClientSecret = "<clientSecret of your Azure AD app>" - -$VaultName= "MyKeyVault" -$KeyVault = Get-AzureRmKeyVault -VaultName $VaultName -ResourceGroupName $RGName -$DiskEncryptionKeyVaultUrl = $KeyVault.VaultUri -$KeyVaultResourceId = $KeyVault.ResourceId - -$KEKName = "MyKeyEncryptionKey" -$KEK = Add-AzureKeyVaultKey -VaultName $VaultName -Name $KEKName -Destination "Software" -$KeyEncryptionKeyUrl = $KEK.Key.kid - -Set-AzureRmVMDiskEncryptionExtension -ResourceGroupName $RGName -VMName $VMName -AadClientID $AADClientID -AadClientSecret $AADClientSecret -DiskEncryptionKeyVaultUrl $DiskEncryptionKeyVaultUrl -DiskEncryptionKeyVaultId $KeyVaultResourceId -KeyEncryptionKeyUrl $KeyEncryptionKeyUrl -KeyEncryptionKeyVaultId $KeyVaultResourceId -``` - -This example enables encryption using Microsoft Entra client ID, client secret, and wrap disk encryption key by using the key encryption key. - -### Example 6: Enable encryption using Microsoft Entra client ID, client cert thumbprint, and wrap disk encryptionkey by using key encryption key -``` -$RGName = "MyResourceGroup" -$VMName = "MyTestVM" -#The KeyVault must have enabledForDiskEncryption property set on it -$VaultName= "MyKeyVault" -$KeyVault = Get-AzureRmKeyVault -VaultName $VaultName -ResourceGroupName $RGName -$DiskEncryptionKeyVaultUrl = $KeyVault.VaultUri -$KeyVaultResourceId = $KeyVault.ResourceId -$KEKName = "MyKeyEncryptionKey" -$KEK = Add-AzureKeyVaultKey -VaultName $VaultName -Name $KEKName -Destination "Software" -$KeyEncryptionKeyUrl = $KEK.Key.kid - -# create Azure AD application and associate the certificate -$CertPath = "C:\certificates\examplecert.pfx" -$CertPassword = "Password" -$Cert = New-Object System.Security.Cryptography.X509Certificates.X509Certificate2($CertPath, $CertPassword) -$CertValue = [System.Convert]::ToBase64String($cert.GetRawCertData()) -$AzureAdApplication = New-AzureRmADApplication -DisplayName "<Your Application Display Name>" -HomePage "<https://YourApplicationHomePage>" -IdentifierUris "<https://YouApplicationUri>" -CertValue $CertValue -$ServicePrincipal = New-AzureRmADServicePrincipal -ApplicationId $AzureAdApplication.ApplicationId - -$AADClientID = $AzureAdApplication.ApplicationId -$AADClientCertThumbprint= $Cert.Thumbprint - -#Upload pfx to KeyVault -$KeyVaultSecretName = "MyAADCert" -$FileContentBytes = get-content $CertPath -Encoding Byte -$FileContentEncoded = [System.Convert]::ToBase64String($FileContentBytes) -$JSONObject = @" - { - "data" : "$filecontentencoded", - "dataType" : "pfx", - "password" : "$CertPassword" - } -"@ -$JSONObjectBytes = [System.Text.Encoding]::UTF8.GetBytes($JSONObject) -$JsonEncoded = [System.Convert]::ToBase64String($JSONObjectBytes) -$Secret = ConvertTo-SecureString -String $JSONEncoded -AsPlainText -Force -Set-AzureKeyVaultSecret -VaultName $VaultName-Name $KeyVaultSecretName -SecretValue $Secret -Set-AzureRmKeyVaultAccessPolicy -VaultName $VaultName -ResourceGroupName $RGName -EnabledForDeployment - -#deploy cert to VM -$CertUrl = (Get-AzureKeyVaultSecret -VaultName $VaultName -Name $KeyVaultSecretName).Id -$SourceVaultId = (Get-AzureRmKeyVault -VaultName $VaultName -ResourceGroupName $RGName).ResourceId -$VM = Get-AzureRmVM -ResourceGroupName $RGName -Name $VMName -$VM = Add-AzureRmVMSecret -VM $VM -SourceVaultId $SourceVaultId -CertificateStore "My" -CertificateUrl $CertUrl -Update-AzureRmVM -VM $VM -ResourceGroupName $RGName - -#Enable encryption on the virtual machine using Azure AD client ID and client cert thumbprint -Set-AzureRmVMDiskEncryptionExtension -ResourceGroupName $RGname -VMName $VMName -AadClientID $AADClientID -AadClientCertThumbprint $AADClientCertThumbprint -DiskEncryptionKeyVaultUrl $DiskEncryptionKeyVaultUrl -DiskEncryptionKeyVaultId $KeyVaultResourceId -KeyEncryptionKeyUrl $KeyEncryptionKeyUrl -KeyEncryptionKeyVaultId $KeyVaultResourceId -``` - -This example enables encryption using Microsoft Entra client ID, client cert thumbprint, and wrap disk encryption key by using key encryption key. - -## PARAMETERS - -### -AadClientCertThumbprint -Specifies the thumbprint of the Microsoft Entra application client certificate that has permissions to write secrets to **KeyVault**. -As a prerequisite, the Microsoft Entra client certificate must be previously deployed to the virtual machine's local computer `my` certificate store. -The Add-AzureRmVMSecret cmdlet can be used to deploy a certificate to a virtual machine in Azure. -For more details, see the **Add-AzureRmVMSecret** cmdlet help. -The certificate must be previously deployed to the virtual machine local computer my certificate store. - -```yaml -Type: System.String -Parameter Sets: AADClientCertParameterSet -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AadClientID -Specifies the client ID of the Microsoft Entra application that has permissions to write secrets to **KeyVault**. - -```yaml -Type: System.String -Parameter Sets: AADClientSecretParameterSet, AADClientCertParameterSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AadClientSecret -Specifies the client secret of the Microsoft Entra application that has permissions to write secrets to **KeyVault**. - -```yaml -Type: System.String -Parameter Sets: AADClientSecretParameterSet -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableAutoUpgradeMinorVersion -Indicates that this cmdlet disables auto-upgrade of the minor version of the extension. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 14 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DiskEncryptionKeyVaultId -Specifies the resource ID of the **KeyVault** to which the virtual machine encryption keys should be uploaded. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DiskEncryptionKeyVaultUrl -Specifies the **KeyVault** URL to which the virtual machine encryption keys should be uploaded. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EncryptFormatAll -Encrypt-Format all data drives that are not already encrypted - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionPublisherName -The extension publisher name. Specify this parameter only to override the default value of "Microsoft.Azure.Security". - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExtensionType -The extension type. Specify this parameter to override its default value of "AzureDiskEncryption" for Windows VMs and "AzureDiskEncryptionForLinux" for Linux VMs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyEncryptionAlgorithm -Specifies the algorithm that is used to wrap and unwrap the key encryption key of the virtual machine. -The default value is RSA-OAEP. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: RSA-OAEP, RSA1_5 - -Required: False -Position: 8 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyEncryptionKeyUrl -Specifies the URL of the key encryption key that is used to wrap and unwrap the virtual machine encryption key. -This must be the full versioned URL. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyEncryptionKeyVaultId -Specifies the resource ID of the **KeyVault** that contains key encryption key that is used to wrap and unwrap the virtual machine encryption key. -This must be a full versioned URL. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Azure Resource Manager resource that represents the extension. -The default value is AzureDiskEncryption for virtual machines that run the Windows operating system or AzureDiskEncryptionForLinux for Linux virtual machines. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: 12 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Passphrase -Specifies the passphrase used for encrypting Linux virtual machines only. -This parameter is not used for virtual machines that run the Windows operating system. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 13 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SequenceVersion -Specifies the sequence number of the encryption operations for a virtual machine. -This is unique per each encryption operation performed on the same virtual machine. -The Get-AzureRmVMExtension cmdlet can be used to retrieve the previous sequence number that was used. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 10 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkipVmBackup -Skip backup creation for Linux VMs - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 15 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TypeHandlerVersion -Specifies the version of the encryption extension. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: HandlerVersion, Version - -Required: False -Position: 11 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VolumeType -Specifies the type of virtual machine volumes to perform the encryption operation. -Allowed values for virtual machines that run the Windows operating system are as follows: All, OS, and Data. -The allowed values for Linux virtual machines are as follows: All, OS, and Data when supported by the Linux distribution. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: OS, Data, All - -Required: False -Position: 9 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVMSecret](./Add-AzureRmVMSecret.md) - -[Get-AzureRmVMDiskEncryptionStatus](./Get-AzureRmVMDiskEncryptionStatus.md) - -[Remove-AzureRmVMDiskEncryptionExtension](./Remove-AzureRmVMDiskEncryptionExtension.md) diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMDscExtension.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMDscExtension.md deleted file mode 100644 index f1ca8dedac..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMDscExtension.md +++ /dev/null @@ -1,395 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 04F58D88-53D6-42CA-852C-9E2A129898C7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmdscextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVMDscExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVMDscExtension.md ---- - -# Set-AzureRmVMDscExtension - -## SYNOPSIS -Configures the DSC extension on a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVMDscExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name <String>] - [-ArchiveBlobName] <String> [-ArchiveStorageAccountName] <String> [-ArchiveResourceGroupName <String>] - [-ArchiveStorageEndpointSuffix <String>] [-ArchiveContainerName <String>] [-ConfigurationName <String>] - [-ConfigurationArgument <Hashtable>] [-ConfigurationData <String>] [-Version] <String> [-Force] - [-Location <String>] [-AutoUpdate] [-WmfVersion <String>] [-DataCollection <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVMDscExtension** cmdlet configures the Windows PowerShell Desired State Configuration (DSC) extension on a virtual machine in a resource group. - -## EXAMPLES - -### Example 1: Set a DSC extension -``` -PS C:\> Set-AzureRmVMDscExtension -ResourceGroupName "ResourceGroup001" -VMName "VM07" -ArchiveBlobName "Sample.ps1.zip" -ArchiveStorageAccountName "Stg" -ConfigurationName "ConfigName" -Version "1.10" -Location "West US" -``` - -This command sets the DSC extension on the virtual machine named VM07 to download Sample.ps1.zip from the storage account named Stg and the default container. -The command invokes the configuration named ConfigName. -The Sample.ps1.zip file was previously uploaded by using **Publish-AzureRmVMDscConfiguration**. - -### Example 2: Set a DSC extension with configuration data -``` -PS C:\> Set-AzureRmVMDscExtension -ResourceGroupName "ResourceGroup001" -VMName "VM13" -ArchiveBlobName "Sample.ps1.zip" -ArchiveStorageAccountName "Stg" -ConfigurationName "ConfigName" -ConfigurationArgument "@{arg="val"}" -ArchiveContainerName "WindowsPowerShellDSC" -ConfigurationData "SampleData.psd1" -Version "1.10" -Location "West US" -``` - -This command sets the extension on the virtual machine named VM13 to download Sample.ps1.zip from the storage account named Stg and the container named WindowsPowerShellDSC. -The command the configuration named ConfigName and specifies configuration data and arguments. -The Sample.ps1.zip file was previously uploaded by using **Publish-AzureRmVMDscConfiguration**. - -### Example 3: Set a DSC extension with configuration data that has auto update -``` -PS C:\> Set-AzureRmVMDscExtension -ResourceGroupName "ResourceGroup001" -VMName "VM22" -ArchiveBlobName "Sample.ps1.zip" -ArchiveStorageAccountName "Stg" -ConfigurationName "ConfigName" -ConfigurationArgument "@{arg="val"}" -ArchiveContainerName WindowsPowerShellDSC -ConfigurationData "SampleData.psd1" -Version "1.10" -Location "West US" -AutoUpdate -``` - -This command sets the extension on the virtual machine named VM22 to download Sample.ps1.zip from the storage account named Stg and the container named WindowsPowerShellDSC. -The command invokes the configuration named ConfigName and specifies configuration data and arguments. -This command also enables auto update of extension handler to the latest version. -The Sample.ps1.zip was previously uploaded by using **Publish-AzureRmVMDscConfiguration**. - -## PARAMETERS - -### -ArchiveBlobName -Specifies the name of the configuration file that was previously uploaded by the Publish-AzureRmVMDscConfiguration cmdlet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ConfigurationArchiveBlob - -Required: True -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ArchiveContainerName -Species name of the Azure storage container where the configuration archive is located. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ContainerName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ArchiveResourceGroupName -Specifies the name of the resource group that contains the storage account that contains the configuration archive. -This parameter is optional if the storage account and virtual machine are both in the same resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ArchiveStorageAccountName -Specifies the Azure storage account name that is used to download the ArchiveBlobName. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: StorageAccountName - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ArchiveStorageEndpointSuffix -Specifies the storage endpoint suffix. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: StorageEndpointSuffix - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AutoUpdate -Specifies the extension handler version specified by the *Version* parameter. -By default extension handler is not autoupdated. -Use the *AutoUpdate* parameter to enable auto update of the extension handler to the latest version as and when it is available. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConfigurationArgument -Specifies a hash table that contains the arguments to the configuration function. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConfigurationData -Specifies the path of a .psd1 file that specifies the data for the configuration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConfigurationName -Specifies the name of the configuration that the DSC Extension invokes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataCollection -Specifies the data collection type. -The acceptable values for this parameter are: Enable and Disable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Enable, Disable - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the path of the resource extension. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Azure Resource Manager resource that represents the extension. -The default value is Microsoft.Powershell.DSC. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Version -Specifies the version of the DSC extension that Set-AzureRmVMDscExtension applies the settings to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: HandlerVersion - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine where DSC extension handler is installed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WmfVersion -Specifies the WMF version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: 4.0, 5.0, 5.1, latest - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMDscExtension](./Get-AzureRmVMDscExtension.md) - -[Remove-AzureRmVMDscExtension](./Remove-AzureRmVMDscExtension.md) - -[Publish-AzureRmVMDscConfiguration](./Publish-AzureRmVMDscConfiguration.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMExtension.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMExtension.md deleted file mode 100644 index 67154f6b91..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMExtension.md +++ /dev/null @@ -1,355 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 064196C3-ABF3-4F3A-A4AB-EB0D27098C70 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVMExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVMExtension.md ---- - -# Set-AzureRmVMExtension - -## SYNOPSIS -Updates extension properties or adds an extension to a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Settings (Default) -``` -Set-AzureRmVMExtension -Publisher <String> -ExtensionType <String> [-Settings <Hashtable>] - [-ProtectedSettings <Hashtable>] [-AsJob] [-ResourceGroupName] <String> [-VMName] <String> [-Name <String>] - [-TypeHandlerVersion <String>] [-Location <String>] [-DisableAutoUpgradeMinorVersion] [-ForceRerun <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SettingString -``` -Set-AzureRmVMExtension -Publisher <String> -ExtensionType <String> [-SettingString <String>] - [-ProtectedSettingString <String>] [-AsJob] [-ResourceGroupName] <String> [-VMName] <String> [-Name <String>] - [-TypeHandlerVersion <String>] [-Location <String>] [-DisableAutoUpgradeMinorVersion] [-ForceRerun <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVMExtension** cmdlet updates properties for existing Virtual Machine Extensions or adds an extension to a virtual machine. - -## EXAMPLES - -### Example 1: Modify settings by using hash tables -``` -PS C:\> $Settings = @{"fileUris" = "[]"; "commandToExecute" = ""}; -PS C:\> $ProtectedSettings = @{"storageAccountName" = $stoname; "storageAccountKey" = $stokey}; -PS C:\> Set-AzureRmVMExtension -ResourceGroupName "ResourceGroup11" -Location "West US" -VMName "VirtualMachine22" -Name "ContosoTest" -Publisher "Contoso.Compute" -Type "CustomScriptExtension" -TypeHandlerVersion "1.1" -Settings $Settings -ProtectedSettings $ProtectedSettings; -``` - -The first two commands use standard Windows PowerShell syntax to create hash tables, and then stores those hash tables in the $Settings and $ProtectedSettings variables. -For more information, type `Get-Help about_Hash_Tables`. -The second command includes two values previously created and stored in variables. -The final command modifies an extension of the virtual machine named VirtualMachine22 in ResourceGroup11 according to the contents of $Settings and $ProtectedSettings. -The command specifies other required information that includes the publisher and the extension type. - -### Example 2: Modify settings by using strings -``` -PS C:\> $SettingsString = '{"fileUris":[],"commandToExecute":""}'; -PS C:\> $ProtectedSettingsString = '{"storageAccountName":"' + $stoname + '","storageAccountKey":"' + $stokey + '"}'; -PS C:\> Set-AzureRmVMExtension -ResourceGroupName "ResourceGroup11" -Location "West US" -VMName "VirtualMachine22" -Name "CustomScriptExtension" -Publisher "Contoso.Compute" -Type "CustomScriptExtension" -TypeHandlerVersion "1.1" -SettingString $SettingsString -ProtectedSettingString $ProtectedSettingsString ; -``` - -The first two commands create strings that contain settings, and then stores them in the $SettingsString and $ProtectedSettingsString variables. -The final command modifies an extension of the virtual machine named VirtualMachine22 in ResourceGroup11 according to the contents of $SettingsString and $ProtectedSettingsString. -The command specifies other required information that includes the publisher and the extension type. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableAutoUpgradeMinorVersion -Indicates that this cmdlet prevents the Azure guest agent from automatically updating the extensions to a newer minor version. -By default, this cmdlet enables the guest agent to update the extensions. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExtensionType -Specifies the extension type. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Type - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ForceRerun -Indicates that this cmdlet forces a rerun of the same extension configuration on the virtual machine without uninstalling and reinstalling the extension. -The value can be any string different from the current value. -If forceUpdateTag is not changed, updates to public or protected settings are still applied by the handler. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of an extension. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProtectedSettings -Specifies private configuration for the extension, as a hash table. -This cmdlet encrypts the private configuration. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: Settings -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProtectedSettingString -Specifies private configuration for the extension, as a string. -This cmdlet encrypts the private configuration. - -```yaml -Type: System.String -Parameter Sets: SettingString -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Publisher -Specifies the name of the extension publisher. -The publisher provides a name when the publisher registers an extension. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Settings -Specifies public configuration for the extension, as a hash table. -This cmdlet does not encrypt public configuration. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: Settings -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SettingString -Specifies public configuration for the extension, as a string. -This cmdlet does not encrypt public configuration. - -```yaml -Type: System.String -Parameter Sets: SettingString -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TypeHandlerVersion -Specifies the version of the extension to use for this virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: HandlerVersion, Version - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine. -This cmdlet modifies extensions for the virtual machine that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMExtension](./Get-AzureRmVMExtension.md) - -[Remove-AzureRmVMExtension](./Remove-AzureRmVMExtension.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMOSDisk.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMOSDisk.md deleted file mode 100644 index b8150df411..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMOSDisk.md +++ /dev/null @@ -1,442 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 8F7AF1B8-D769-452C-92CF-4486C3EB894D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmosdisk -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVMOSDisk.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVMOSDisk.md ---- - -# Set-AzureRmVMOSDisk - -## SYNOPSIS -Sets the operating system disk properties on a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParamSet (Default) -``` -Set-AzureRmVMOSDisk [-VM] <PSVirtualMachine> [[-Name] <String>] [[-VhdUri] <String>] - [[-Caching] <CachingTypes>] [[-SourceImageUri] <String>] [[-CreateOption] <String>] [-DiskSizeInGB <Int32>] - [-ManagedDiskId <String>] [-StorageAccountType <String>] [-WriteAccelerator] [-DiffDiskSetting <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### WindowsParamSet -``` -Set-AzureRmVMOSDisk [-VM] <PSVirtualMachine> [[-Name] <String>] [[-VhdUri] <String>] - [[-Caching] <CachingTypes>] [[-SourceImageUri] <String>] [[-CreateOption] <String>] [-Windows] - [-DiskSizeInGB <Int32>] [-ManagedDiskId <String>] [-StorageAccountType <String>] [-WriteAccelerator] - [-DiffDiskSetting <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### WindowsDiskEncryptionParameterSet -``` -Set-AzureRmVMOSDisk [-VM] <PSVirtualMachine> [[-Name] <String>] [[-VhdUri] <String>] - [[-Caching] <CachingTypes>] [[-SourceImageUri] <String>] [[-CreateOption] <String>] [-Windows] - [-DiskEncryptionKeyUrl] <String> [-DiskEncryptionKeyVaultId] <String> [[-KeyEncryptionKeyUrl] <String>] - [[-KeyEncryptionKeyVaultId] <String>] [-DiskSizeInGB <Int32>] [-ManagedDiskId <String>] - [-StorageAccountType <String>] [-WriteAccelerator] [-DiffDiskSetting <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### LinuxParamSet -``` -Set-AzureRmVMOSDisk [-VM] <PSVirtualMachine> [[-Name] <String>] [[-VhdUri] <String>] - [[-Caching] <CachingTypes>] [[-SourceImageUri] <String>] [[-CreateOption] <String>] [-Linux] - [-DiskSizeInGB <Int32>] [-ManagedDiskId <String>] [-StorageAccountType <String>] [-WriteAccelerator] - [-DiffDiskSetting <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### LinuxDiskEncryptionParameterSet -``` -Set-AzureRmVMOSDisk [-VM] <PSVirtualMachine> [[-Name] <String>] [[-VhdUri] <String>] - [[-Caching] <CachingTypes>] [[-SourceImageUri] <String>] [[-CreateOption] <String>] [-Linux] - [-DiskEncryptionKeyUrl] <String> [-DiskEncryptionKeyVaultId] <String> [[-KeyEncryptionKeyUrl] <String>] - [[-KeyEncryptionKeyVaultId] <String>] [-DiskSizeInGB <Int32>] [-ManagedDiskId <String>] - [-StorageAccountType <String>] [-WriteAccelerator] [-DiffDiskSetting <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVMOSDisk** cmdlet sets the operating system disk properties on a virtual machine. - -## EXAMPLES - -### Example 1: Set properties on a virtual machine from platform image -``` -PS C:\> $AvailabilitySet = Get-AzureRmAvailabilitySet -ResourceGroupName "ResourceGroup11" -Name "AvailabilitySet13" -PS C:\> $VirtualMachine = New-AzureRmVMConfig -VMName "VirtualMachine17" -VMSize "Standard_A1" -AvailabilitySetID $AvailabilitySet.Id -PS C:\> Set-AzureRmVMOSDisk -VM $VirtualMachine -Name "OsDisk12" -VhdUri "os.vhd" -Caching ReadWrite -PS C:\> $VirtualMachine = Set-AzureRmVMOperatingSystem -VM $VirtualMachine -Linux -ComputerName "MainComputer" -Credential (Get-Credential) -PS C:\> $VirtualMachine = Set-AzureRmVMSourceImage -VM $VirtualMachine -PublisherName "Canonical" -Offer "UbuntuServer" -Skus "15.10" -Version "latest" -Caching ReadWrite -PS C:\> $VirtualMachine = Set-AzureRmVMOSDisk -VM $VirtualMachine -Name "osDisk.vhd" -VhdUri "https://mystorageaccount.blob.core.windows.net/disks/" -CreateOption FromImage -PS C:> New-AzureRmVM -VM $VirtualMachine -ResouceGroupName "ResourceGroup11" -``` - -The first command gets the availability set named AvailablitySet13 in the resource group named ResourceGroup11, and then stores that object in the $AvailabilitySet variable. -The second command creates a virtual machine object, and then stores it in the $VirtualMachine variable. -The command assigns a name and size to the virtual machine. -The virtual machine belongs to the availability set stored in $AvailabilitySet. -The final command sets the properties on the virtual machine in $VirtualMachine. - -### Example 2: Sets properties on a virtual machine from generalized user image -``` -PS C:\> $AvailabilitySet = Get-AzureRmAvailabilitySet -ResourceGroupName "ResourceGroup11" -Name "AvailabilitySet13" -PS C:\> $VirtualMachine = New-AzureRmVMConfig -VMName "VirtualMachine17" -VMSize "Standard_A1" -PS C:\> $VirtualMachine = Set-AzureRmVMOperatingSystem -VM $VirtualMachine -Linux -ComputerName "MainComputer" -Credential (Get-Credential) -PS C:\> $VirtualMachine = Set-AzureRmVMOSDisk -VM $VirtualMachine -Name "osDisk.vhd" -SourceImageUri "https://mystorageaccount.blob.core.windows.net/vhds/myOSImage.vhd" -VhdUri "https://mystorageaccount.blob.core.windows.net/disks/" -CreateOption fromImage -Linux -PS C:> New-AzureRmVM -VM $VirtualMachine -ResouceGroupName "ResourceGroup11" -``` - -The first command gets the availability set named AvailablitySet13 in the resource group named ResourceGroup11 and stores that object in the $AvailabilitySet variable. -The second command creates a virtual machine object and stores it in the $VirtualMachine variable. -The command assigns a name and size to the virtual machine. -The virtual machine belongs to the availability set stored in $AvailabilitySet. -The final command sets the properties on the virtual machine in $VirtualMachine. - -### Example 3: Sets properties on a virtual machine from specialized user image -``` -PS C:\> $AvailabilitySet = Get-AzureRmAvailabilitySet -ResourceGroupName "ResourceGroup11" -Name "AvailabilitySet13" -PS C:\> $VirtualMachine = New-AzureRmVMConfig -VMName "VirtualMachine17" -VMSize "Standard_A1" -PS C:\> $VirtualMachine = Set-AzureRmVMOSDisk -VM $VirtualMachine -Name "osDisk.vhd" -VhdUri "https://mystorageaccount.blob.core.windows.net/disks/" -CreateOption Attach -Linux -PS C:> New-AzureRmVM -VM $VirtualMachine -ResouceGroupName "ResourceGroup11" -``` - -The first command gets the availability set named AvailablitySet13 in the resource group named ResourceGroup11 and stores that object in the $AvailabilitySet variable. -The second command creates a virtual machine object and stores it in the $VirtualMachine variable. -The command assigns a name and size to the virtual machine. -The virtual machine belongs to the availability set stored in $AvailabilitySet. -The final command sets the properties on the virtual machine in $VirtualMachine. - -### Example 4: Set the disk encryption settings on a virtual machine operating system disk -``` -PS C:\> $VirtualMachine = New-AzureRmVMConfig -VMName "VirtualMachine17" -VMSize "Standard_A1" -PS C:> $VirtualMachine = Set-AzureRmVMOSDisk -VM $VirtualMachine -Name "OsDisk12" -VhdUri "os.vhd" -Caching ReadWrite -Windows -CreateOption "Attach" -DiskEncryptionKeyUrl "https://mytestvault.vault.azure.net/secrets/Test1/514ceb769c984379a7e0230bddaaaaaa" -DiskEncryptionKeyVaultId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.KeyVault/vaults/mytestvault" -PS C:> New-AzureRmVM -VM $VirtualMachine -ResouceGroupName " ResourceGroup11" -``` - -This example sets the disk encryption settings on a virtual machine operating system disk. - -## PARAMETERS - -### -Caching -Specifies the caching mode of the operating system disk. -Valid values are: -- ReadOnly -- ReadWrite -The default value is ReadWrite. -Changing the caching value causes the virtual machine to restart. -This setting affects the performance of the disk. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.CachingTypes] -Parameter Sets: (All) -Aliases: -Accepted values: None, ReadOnly, ReadWrite - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CreateOption -Specifies whether this cmdlet creates a disk in the virtual machine from a platform or user image, or attaches an existing disk. -Valid values are: -- Attach. -Specify this option to create a virtual machine from a specialized disk. -When you specify this option, do not specify the *SourceImageUri* parameter. -Instead, use the Set-AzureRmVMSourceImage cmdlet. -You must also use the use the *Windows* or *Linux* parameters to tell the azure platform the type of the operating system on the VHD. -The *VhdUri* parameter is enough to tell the azure platform the location of the disk to attach. -- FromImage. -Specify this option to create a virtual machine from a platform image or a generalized user image. -In the case of a generalized user image, you also need to specify the *SourceImageUri* parameter and either the *Windows* or *Linux* parameters to tell the Azure platform the location and type of the operating system disk VHD instead of using the **Set-AzureRmVMSourceImage** cmdlet. -In the case of a platform image, the *VhdUri* parameter is sufficient. -- Empty. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiffDiskSetting -Specifies the differencing disk settings for operating system disk. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DiskEncryptionKeyUrl -Specifies the location of the disk encryption key. - -```yaml -Type: System.String -Parameter Sets: WindowsDiskEncryptionParameterSet, LinuxDiskEncryptionParameterSet -Aliases: - -Required: True -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskEncryptionKeyVaultId -Specifies the resource ID of the Key Vault containing the disk encryption key. - -```yaml -Type: System.String -Parameter Sets: WindowsDiskEncryptionParameterSet, LinuxDiskEncryptionParameterSet -Aliases: - -Required: True -Position: 8 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskSizeInGB -Specifies the size, in GB, of the operating system disk. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyEncryptionKeyUrl -Specifies the location of the key encryption key. - -```yaml -Type: System.String -Parameter Sets: WindowsDiskEncryptionParameterSet, LinuxDiskEncryptionParameterSet -Aliases: - -Required: False -Position: 9 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyEncryptionKeyVaultId -Specifies the resource ID of the Key Vault containing the key encryption key. - -```yaml -Type: System.String -Parameter Sets: WindowsDiskEncryptionParameterSet, LinuxDiskEncryptionParameterSet -Aliases: - -Required: False -Position: 10 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Linux -Indicates that the operating system on the user image is Linux. -Specify this parameter for user image based virtual machine deployment. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: LinuxParamSet, LinuxDiskEncryptionParameterSet -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedDiskId -Specifies the ID of a managed disk. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the operating system disk. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: OSDiskName, DiskName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceImageUri -Specifies the URI of the VHD for user image scenarios. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: SourceImage - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageAccountType -Specifies the storage account type of managed disk. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VhdUri -Specifies the Uniform Resource Identifier (URI) of a virtual hard disk (VHD). -For an image based virtual machine, this parameter specifies the VHD file to create when a platform image or user image is specified. -This is the location from which the image binary large object (BLOB) is copied to start the virtual machine. -For a disk based virtual machine boot scenario, this parameter specifies the VHD file that the virtual machine uses directly for starting up. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: OSDiskVhdUri, DiskVhdUri - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the local virtual machine object on which to set operating system disk properties. -To obtain a virtual machine object, use the Get-AzureRmVM cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine -Parameter Sets: (All) -Aliases: VMProfile - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Windows -Indicates that the operating system on the user image is Windows. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: WindowsParamSet, WindowsDiskEncryptionParameterSet -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WriteAccelerator -Specifies whether WriteAccelerator should be enabled or disabled on the OS disk. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine -Parameters: VM (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - -[Get-AzureRmAvailabilitySet](./Get-AzureRmAvailabilitySet.md) - -[New-AzureRmVMConfig](./New-AzureRmVMConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMOperatingSystem.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMOperatingSystem.md deleted file mode 100644 index 38b97a8eff..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMOperatingSystem.md +++ /dev/null @@ -1,352 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 39AADD19-2EDD-4C1F-BC9E-22186DD9A085 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmoperatingsystem -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVMOperatingSystem.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVMOperatingSystem.md ---- - -# Set-AzureRmVMOperatingSystem - -## SYNOPSIS -Sets operating system properties for a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Windows (Default) -``` -Set-AzureRmVMOperatingSystem [-VM] <PSVirtualMachine> [-Windows] [-ComputerName] <String> - [-Credential] <PSCredential> [[-CustomData] <String>] [-ProvisionVMAgent] [-EnableAutoUpdate] - [[-TimeZone] <String>] [-WinRMHttp] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### WindowsWinRmHttps -``` -Set-AzureRmVMOperatingSystem [-VM] <PSVirtualMachine> [-Windows] [-ComputerName] <String> - [-Credential] <PSCredential> [[-CustomData] <String>] [-ProvisionVMAgent] [-EnableAutoUpdate] - [[-TimeZone] <String>] [-WinRMHttp] [-WinRMHttps] [-WinRMCertificateUrl] <Uri> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### WindowsDisableVMAgent -``` -Set-AzureRmVMOperatingSystem [-VM] <PSVirtualMachine> [-Windows] [-ComputerName] <String> - [-Credential] <PSCredential> [[-CustomData] <String>] [-DisableVMAgent] [-EnableAutoUpdate] - [[-TimeZone] <String>] [-WinRMHttp] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### WindowsDisableVMAgentWinRmHttps -``` -Set-AzureRmVMOperatingSystem [-VM] <PSVirtualMachine> [-Windows] [-ComputerName] <String> - [-Credential] <PSCredential> [[-CustomData] <String>] [-DisableVMAgent] [-EnableAutoUpdate] - [[-TimeZone] <String>] [-WinRMHttp] [-WinRMHttps] [-WinRMCertificateUrl] <Uri> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### Linux -``` -Set-AzureRmVMOperatingSystem [-VM] <PSVirtualMachine> [-Linux] [-ComputerName] <String> - [-Credential] <PSCredential> [[-CustomData] <String>] [-DisablePasswordAuthentication] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVMOperatingSystem** cmdlet sets operating system properties for a virtual machine. -You can specify logon credentials, computer name, and operating system type. - -## EXAMPLES - -### Example 1: Set operating system properties for a new virtual machines -``` -PS C:\> $SecurePassword = ConvertTo-SecureString "Password" -AsPlainText -Force -PS C:\> $Credential = New-Object System.Management.Automation.PSCredential ("FullerP", $SecurePassword); -PS C:\> $AvailabilitySet = Get-AzureRmAvailabilitySet -ResourceGroupName "ResourceGroup11" -Name "AvailabilitySet03" -PS C:\> $VirtualMachine = New-AzureRmVMConfig -VMName "VirtualMachine07" -VMSize "Standard_A1" -AvailabilitySetID $AvailabilitySet.Id -PS C:\> $ComputerName = "ContosoVM122" -PS C:\> $WinRMCertUrl = "http://keyVaultName.vault.azure.net/secrets/secretName/secretVersion" -PS C:\> $TimeZone = "Pacific Standard Time" -PS C:\> $CustomData = "echo 'Hello World'" -PS C:\> $VirtualMachine = Set-AzureRmVMOperatingSystem -VM $$VirtualMachine -Windows -ComputerName $ComputerName -Credential $Credential -CustomData $CustomData -WinRMHttp -WinRMHttps -WinRMCertificateUrl $WinRMCertUrl -ProvisionVMAgent -EnableAutoUpdate -TimeZone $TimeZone -``` - -The first command converts a password to a secure string, and then stores it in the $SecurePassword variable. -For more information, type `Get-Help ConvertTo-SecureString`. -The second command creates a credential for the user FullerP and the password stored in $SecurePassword, and then stores the credential in the $Credential variable. -For more information, type `Get-Help New-Object`. -The third command gets the availability set named AvailablitySet03 in the resource group named ResourceGroup11, and then stores that object in the $AvailabilitySet variable. -The fourth command creates a virtual machine object, and then stores it in the $VirtualMachine variable. -The command assigns a name and size to the virtual machine. -The virtual machine belongs to the availability set stored in $AvailabilitySet. -The next four commands assign values to variables to use in the following command. -Because you could specify these strings directly in the **Set-AzureRmVMOperatingSystem** command, this approach is used only for readability. -However, you might use an approach such as this in scripts. -The final command sets operating system properties for the virtual machine stored in $VirtualMachine. -The command uses the credentials stored in $Credential. -The command uses variables assigned in previous commands for some parameters. - -## PARAMETERS - -### -ComputerName -Specifies the name of the computer. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Credential -Specifies the user name and password for the virtual machine as a **PSCredential** object. -To obtain a credential, use the Get-Credential cmdlet. -For more information, type `Get-Help Get-Credential`. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CustomData -Specifies a base-64 encoded string of custom data. -This is decoded to a binary array that is saved as a file on the virtual machine. -The maximum length of the binary array is 65535 bytes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisablePasswordAuthentication -Indicates that this cmdlet disables password authentication. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Linux -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisableVMAgent -Disable Provision VM Agent. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: WindowsDisableVMAgent, WindowsDisableVMAgentWinRmHttps -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableAutoUpdate -Indicates that this cmdlet enables auto update. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Windows, WindowsWinRmHttps, WindowsDisableVMAgent, WindowsDisableVMAgentWinRmHttps -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Linux -Indicates that the type of operating system is Linux. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Linux -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProvisionVMAgent -Indicates that the settings require that the virtual machine agent be installed on the virtual machine. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Windows, WindowsWinRmHttps -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TimeZone -Specifies the time zone for the virtual machine. - -```yaml -Type: System.String -Parameter Sets: Windows, WindowsWinRmHttps, WindowsDisableVMAgent, WindowsDisableVMAgentWinRmHttps -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VM -Specifies the local virtual machine object on which to set operating system properties. -To obtain a virtual machine object, use the Get-AzureRmVM cmdlet. -Create a virtual machine object by using the New-AzureRmVMConfig cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine -Parameter Sets: (All) -Aliases: VMProfile - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Windows -Indicates that the type of operating system is Windows. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Windows, WindowsWinRmHttps, WindowsDisableVMAgent, WindowsDisableVMAgentWinRmHttps -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WinRMCertificateUrl -Specifies the URI of a WinRM certificate. -This needs to be stored in a Key Vault. - -```yaml -Type: System.Uri -Parameter Sets: WindowsWinRmHttps, WindowsDisableVMAgentWinRmHttps -Aliases: - -Required: True -Position: 10 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WinRMHttp -Indicates that this operating system uses HTTP WinRM. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Windows, WindowsWinRmHttps, WindowsDisableVMAgent, WindowsDisableVMAgentWinRmHttps -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WinRMHttps -Indicates that this operating system uses HTTPS WinRM. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: WindowsWinRmHttps, WindowsDisableVMAgentWinRmHttps -Aliases: - -Required: True -Position: 9 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -### System.Management.Automation.SwitchParameter - -### System.String - -### System.Management.Automation.PSCredential - -### System.Uri - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - -[New-AzureRmVMConfig](./New-AzureRmVMConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMPlan.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMPlan.md deleted file mode 100644 index 0559e65901..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMPlan.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: A1EA7D34-A8B4-4FA0-BD8C-3E846715AFBA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmplan -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVMPlan.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVMPlan.md ---- - -# Set-AzureRmVMPlan - -## SYNOPSIS -Sets the Marketplace plan information on a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVMPlan [-VM] <PSVirtualMachine> [-Name] <String> [[-Product] <String>] [[-PromotionCode] <String>] - [[-Publisher] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVMPlan** cmdlet sets the Azure Marketplace plan information for a virtual machine. -Before being able to deploy a Marketplace image through the command-line, programmatic access must be enabled or the virtual machine must be deployed by using the Azure portal. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the image from the Marketplace. -This is the same value that is returned by the Get-AzureRmVMImageSku cmdlet. -For more information about how to find image information, see [Find and use Azure Marketplace VM images with Azure PowerShell](/azure/virtual-machines/windows/cli-ps-findimage) in the Microsoft Azure documentation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Product -Specifies the product of the image from the Marketplace. -This is the same information as the **Offer** value of the **imageReference** element. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PromotionCode -Specifies a promotion code. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Publisher -Specifies the publisher of the image. -You can find this information by using the Get-AzureRmVMImagePublisher cmdlet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine object for which to set a Marketplace plan. -You can use the Get-AzureRmVM cmdlet to obtain a virtual machine object. -You can use the New-AzureRmVMConfig cmdlet to create a virtual machine object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine -Parameter Sets: (All) -Aliases: VMProfile - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - -[Get-AzureRmVMImagePublisher](./Get-AzureRmVMImagePublisher.md) - -[Get-AzureRmVMImageSku](./Get-AzureRmVMImageSku.md) - -[New-AzureRmVMConfig](./New-AzureRmVMConfig.md) diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMSourceImage.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMSourceImage.md deleted file mode 100644 index e3d311f706..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVMSourceImage.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 91B2DE2F-442D-4428-8A6F-9C2CEC181CA7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmsourceimage -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVMSourceImage.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVMSourceImage.md ---- - -# Set-AzureRmVMSourceImage - -## SYNOPSIS -Specifies the image for a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ImageReferenceSkuParameterSet (Default) -``` -Set-AzureRmVMSourceImage [-VM] <PSVirtualMachine> [-PublisherName] <String> [-Offer] <String> [-Skus] <String> - [-Version] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ImageReferenceIdParameterSet -``` -Set-AzureRmVMSourceImage [-VM] <PSVirtualMachine> [-Id] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVMSourceImage** cmdlet specifies the platform image to use for a virtual machine. - -## EXAMPLES - -### Example 1: Set values for an image -``` -PS C:\> $AvailabilitySet = Get-AzureRmAvailabilitySet -ResourceGroupName "ResourceGroup11" -Name "AvailabilitySet03" -PS C:\> $VirtualMachine = New-AzureRmVMConfig -VMName "VirtualMachine07" -VMSize "Standard_A1" -AvailabilitySetID $AvailabilitySet.Id -PS C:\> Set-AzureRmVMSourceImage -VM $VirtualMachine -PublisherName "MicrosoftWindowsServer" -Offer "WindowsServer" -Skus "2012-R2-Datacenter" -Version "latest" -``` - -The first command gets the availability set named AvailablitySet03 in the resource group named ResourceGroup11, and then stores that object in the $AvailabilitySet variable. -The second command creates a virtual machine object, and then stores it in the $VirtualMachine variable. -The command assigns a name and size to the virtual machine. -The virtual machine belongs to the availability set stored in $AvailabilitySet. -The final command sets values for publisher name, offer, SKU, and version. -The **Get-AzureRmVMImagePublisher**, **Get-AzureRmVMImageOffer**, **Get-AzureRmVMImageSku**, and **Get-AzureRmVMImage** cmdlets can discover these settings. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID. - -```yaml -Type: System.String -Parameter Sets: ImageReferenceIdParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Offer -Specifies the type of VMImage offer. -To obtain an image offer, use the Get-AzureRmVMImageOffer cmdlet. - -```yaml -Type: System.String -Parameter Sets: ImageReferenceSkuParameterSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublisherName -Specifies the name of a publisher of a VMImage. -To obtain a publisher, use the Get-AzureRmVMImagePublisher cmdlet. - -```yaml -Type: System.String -Parameter Sets: ImageReferenceSkuParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Skus -Specifies a VMImage SKU. -To obtain SKUs, use the Get-AzureRmVMImageSku cmdlet. - -```yaml -Type: System.String -Parameter Sets: ImageReferenceSkuParameterSet -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Version -Specifies a version of a VMImage. -To use the latest version, specify a value of latest instead of a particular version. - -```yaml -Type: System.String -Parameter Sets: ImageReferenceSkuParameterSet -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VM -Specifies the local virtual machine object to configure. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine -Parameter Sets: (All) -Aliases: VMProfile - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAvailabilitySet](./Get-AzureRmAvailabilitySet.md) - -[Get-AzureRmVMImage](./Get-AzureRmVMImage.md) - -[Get-AzureRmVMImageOffer](./Get-AzureRmVMImageOffer.md) - -[Get-AzureRmVMImagePublisher](./Get-AzureRmVMImagePublisher.md) - -[Get-AzureRmVMImageSku](./Get-AzureRmVMImageSku.md) - -[New-AzureRmVMConfig](./New-AzureRmVMConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVmss.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVmss.md deleted file mode 100644 index a829d2bcf2..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVmss.md +++ /dev/null @@ -1,256 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 6442E5BB-D59D-483B-8AC5-2586C6C1E925 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmss -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVmss.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVmss.md ---- - -# Set-AzureRmVmss - -## SYNOPSIS -Sets specific actions on a specified VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameter (Default) -``` -Set-AzureRmVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> [[-InstanceId] <String[]>] [-Reimage] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### FriendMethod -``` -Set-AzureRmVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> [[-InstanceId] <String[]>] - [-ReimageAll] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RedeployMethodParameter -``` -Set-AzureRmVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> [[-InstanceId] <String[]>] [-Redeploy] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### PerformMaintenanceMethodParameter -``` -Set-AzureRmVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> [[-InstanceId] <String[]>] - [-PerformMaintenance] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVmss** cmdlet sets specific actions on the Virtual Machine Scale Set (VMSS). -The only action this cmdlet supports is Reimage. - -## EXAMPLES - -### Example 1: Reimage a VMSS -``` -PS C:\> Set-AzureRmVmss -Reimage -ResourceGroupName "ContosoGroup" -VMScaleSetName "ContosoVMSS" -``` - -This command reimages the VMSS named ContosoVMSS that belongs to the resource group named ContosoGroup. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceId -The instance ID of the virtual machine. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PerformMaintenance -Indicates that this cmdlet performs maintenance one or more virtual machines in the VMSS. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: PerformMaintenanceMethodParameter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Redeploy -Indicates that the cmdlet redeploys one or more virtual machines in the VMSS. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: RedeployMethodParameter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Reimage -Indicates that the cmdlet reimages the VMSS. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReimageAll -Indicates that the cmdlet reimages all the disks in the VMSS. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: FriendMethod -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the VMSS. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMScaleSetName -Species the name of the VMSS for which this cmdlet sets actions on. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.String[] - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVmss](./Get-AzureRmVmss.md) - -[New-AzureRmVmss](./New-AzureRmVmss.md) - -[Remove-AzureRmVmss](./Remove-AzureRmVmss.md) - -[Restart-AzureRmVmss](./Restart-AzureRmVmss.md) - -[Start-AzureRmVmss](./Start-AzureRmVmss.md) - -[Stop-AzureRmVmss](./Stop-AzureRmVmss.md) - -[Update-AzureRmVmss](./Update-AzureRmVmss.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVmssBootDiagnostic.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVmssBootDiagnostic.md deleted file mode 100644 index f880ac7a90..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVmssBootDiagnostic.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmssbootdiagnostic -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVmssBootDiagnostic.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVmssBootDiagnostic.md ---- - -# Set-AzureRmVmssBootDiagnostic - -## SYNOPSIS -Sets the virtual machine scale set boot diagnostics profile. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVmssBootDiagnostic [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [[-Enabled] <Boolean>] - [[-StorageUri] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Sets the virtual machine scale set boot diagnostics profile. - -## EXAMPLES - -### Example 1: Set the boot diagnostics profile property for a VMSS -``` -PS C:\> $vmss = New-AzureRmVmssConfig -Location $loc -SkuCapacity 2 -SkuName 'Standard_A0' -PS C:\> Set-AzureRmVmssBootDiagnostic -VirtualMachineScaleSet $vmss -Enabled $true -StorageUri $storageUri; -PS C:\> New-AzureRmVmss -ResourceGroupName $rgname -Name "ContosoVMSS" -VirtualMachineScaleSet $vmss; -``` - -This command sets boot diagnostics profile property for the VMSS named ContosoVMSS. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Whether boot diagnostics should be enabled on the virtual machine scale set. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageUri -URI of the storage account to use for placing the console output and screenshot. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specifies the VMSS object. -You can use the New-AzureRmVmssConfig cmdlet to create the object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVmssDiskEncryptionExtension.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVmssDiskEncryptionExtension.md deleted file mode 100644 index 0a5973c8ac..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVmssDiskEncryptionExtension.md +++ /dev/null @@ -1,325 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmssdiskencryptionextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVmssDiskEncryptionExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVmssDiskEncryptionExtension.md ---- - -# Set-AzureRmVmssDiskEncryptionExtension - -## SYNOPSIS -Enables disk encryption on a VM scale set. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVmssDiskEncryptionExtension [-ResourceGroupName] <String> [-VMScaleSetName] <String> - [-DiskEncryptionKeyVaultUrl] <String> [-DiskEncryptionKeyVaultId] <String> [-KeyEncryptionKeyUrl <String>] - [-KeyEncryptionKeyVaultId <String>] [-KeyEncryptionAlgorithm <String>] [-VolumeType <String>] [-ForceUpdate] - [-TypeHandlerVersion <String>] [-ExtensionName <String>] [-Passphrase <String>] [-Force] - [-DisableAutoUpgradeMinorVersion] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVmssDiskEncryptionExtension** cmdlet enables encryption on a VM scale set. -This cmdlet enables encryption by installing the disk encryption extension on the VM scale set. -If no *Name* parameter is specified, an extension with the default name AzureDiskEncryption for virtual machines that run the Windows operating system or AzureDiskEncryptionForLinux for Linux virtual machines are installed. - -## EXAMPLES - -### Example 1 -``` -$RGName = "MyResourceGroup" -$VmssName = "MyTestVmss" -$VaultName= "MyKeyVault" -$KeyVault = Get-AzureRmKeyVault -VaultName $VaultName -ResourceGroupName $RGName -$DiskEncryptionKeyVaultUrl = $KeyVault.VaultUri -$KeyVaultResourceId = $KeyVault.ResourceId -PS C:\> Set-AzureRmVmssDiskEncryptionExtension -ResourceGroupName $RGName -VMScaleSetName $VmssName -DiskEncryptionKeyVaultUrl $DiskEncryptionKeyVaultUrl -DiskEncryptionKeyVaultId $KeyVaultResourceId -``` - -This command enables encryption on all disks of all VMs in the VM scale set. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableAutoUpgradeMinorVersion -Disable auto-upgrade of minor version - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DiskEncryptionKeyVaultId -ResourceID of the KeyVault where generated encryption key will be placed to - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DiskEncryptionKeyVaultUrl -URL of the KeyVault where generated encryption key will be placed to - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExtensionName -The extension name. -If this parameter is not specified, default values used are AzureDiskEncryption for windows VMs and AzureDiskEncryptionForLinux for Linux VMs - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -To force enabling encryption on the virtual machine scale set. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceUpdate -Generate a tag for force update. This should be given to perform repeated encryption operations on the same VM. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyEncryptionAlgorithm -KeyEncryption Algorithm used to encrypt the volume encryption key - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: RSA-OAEP, RSA1_5 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyEncryptionKeyUrl -Versioned KeyVault URL of the KeyEncryptionKey used to encrypt the disk encryption key - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyEncryptionKeyVaultId -ResourceID of the KeyVault containing the KeyEncryptionKey used to encrypt the disk encryption key - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Passphrase -The passphrase specified in parameters. -This parameter only works for Linux VM. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name to which the VM Scale Set belongs to - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TypeHandlerVersion -The type handler version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: HandlerVersion, Version - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMScaleSetName -Name of the virtual machine scale set - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VolumeType -Type of the volume (OS or Data) to perform encryption operation - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: OS, Data, All - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineScaleSetExtension - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVmssOsProfile.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVmssOsProfile.md deleted file mode 100644 index ff9900672b..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVmssOsProfile.md +++ /dev/null @@ -1,331 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 3E7B9EFA-8BC2-46EB-9AD7-43EAB7FF3891 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmssosprofile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVmssOsProfile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVmssOsProfile.md ---- - -# Set-AzureRmVmssOsProfile - -## SYNOPSIS -Sets the VMSS operating system profile properties. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVmssOsProfile [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [[-ComputerNamePrefix] <String>] - [[-AdminUsername] <String>] [[-AdminPassword] <String>] [[-CustomData] <String>] - [[-WindowsConfigurationProvisionVMAgent] <Boolean>] [[-WindowsConfigurationEnableAutomaticUpdate] <Boolean>] - [[-TimeZone] <String>] [[-AdditionalUnattendContent] <AdditionalUnattendContent[]>] - [[-Listener] <WinRMListener[]>] [[-LinuxConfigurationDisablePasswordAuthentication] <Boolean>] - [[-PublicKey] <SshPublicKey[]>] [[-Secret] <VaultSecretGroup[]>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVmssOsProfile** cmdlet sets the Virtual Machine Scale Set operating system profile properties. - -## EXAMPLES - -### Example 1: Set the operating system profile properties for a VMSS -``` -PS C:\> Set-AzureRmVmssOSProfile -VirtualMachineScaleSet "ContosoVMSS" -ComputerNamePrefix "Test" -AdminUsername $AdminUsername -AdminPassword $AdminPassword -``` - -This command sets operating system profile properties for the virtual machines that belong to the VMSS named ContosoVMSS. -The command sets the computer name prefix for all the virtual machine instances in the VMSS to Test and supplies the administrator username and password. - -## PARAMETERS - -### -AdditionalUnattendContent -Specifies an unattended content object. -You can use the Add-AzureRmVMAdditionalUnattendContent to create the object. - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.AdditionalUnattendContent[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AdminPassword -Specifies the administrator password to use for all the virtual machine instances in the VMSS. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AdminUsername -Specifies the administrator account name to use for all the virtual machine instances in the VMSS. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ComputerNamePrefix -Specifies the computer name prefix for all the virtual machine instances in the VMSS. -Computer names must be 1 to 15 characters long. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CustomData -Specifies a base-64 encoded string of custom data. -This is decoded to a binary array that is saved as a file on the virtual machine. -The maximum length of the binary array is 65535 bytes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LinuxConfigurationDisablePasswordAuthentication -Indicates that this cmdlet disables password authentication. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 10 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Listener -Specifies the Windows Remote Management (WinRM) listeners. -This enables remote Windows PowerShell. -You can use the Add-AzureRmVmssWinRMListener cmdlet to create the listener. - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.WinRMListener[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 9 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublicKey -Specifies the Secure Shell (SSH) public key object. -You can use the Add-AzureRmVMSshPublicKey cmdlet to create the object. - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.SshPublicKey[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 11 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Secret -Specifies the secrets object which contains the certificate references to place on the virtual machine. -You can use the Add-AzureRmVmssSecret cmdlet to create the secrets object. - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.VaultSecretGroup[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 12 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TimeZone -Specifies the time zone for the virtual machine. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specifies the VMSS object. -You can use the New-AzureRmVmssConfig cmdlet to create the object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WindowsConfigurationEnableAutomaticUpdate -Indicates whether the virtual machines in the VMSS are enabled for automatic updates. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowsConfigurationProvisionVMAgent -Indicates whether virtual machine agent should be provisioned on the virtual machines in the VMSS. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -### System.String - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### Microsoft.Azure.Management.Compute.Models.AdditionalUnattendContent[] - -### Microsoft.Azure.Management.Compute.Models.WinRMListener[] - -### Microsoft.Azure.Management.Compute.Models.SshPublicKey[] - -### Microsoft.Azure.Management.Compute.Models.VaultSecretGroup[] - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVMAdditionalUnattendContent](./Add-AzureRmVMAdditionalUnattendContent.md) - -[Add-AzureRmVmssWinRMListener](./Add-AzureRmVmssWinRMListener.md) - -[Add-AzureRmVMSshPublicKey](./Add-AzureRmVMSshPublicKey.md) - -[Add-AzureRmVmssSecret](./Add-AzureRmVmssSecret.md) - -[New-AzureRmVmssConfig](./New-AzureRmVmssConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVmssRollingUpgradePolicy.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVmssRollingUpgradePolicy.md deleted file mode 100644 index b91cc78686..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVmssRollingUpgradePolicy.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmssrollingupgradepolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVmssRollingUpgradePolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVmssRollingUpgradePolicy.md ---- - -# Set-AzureRmVmssRollingUpgradePolicy - -## SYNOPSIS -Sets the VMSS rolling upgrade policy properties. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVmssRollingUpgradePolicy [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> - [[-MaxBatchInstancePercent] <Int32>] [[-MaxUnhealthyInstancePercent] <Int32>] - [[-MaxUnhealthyUpgradedInstancePercent] <Int32>] [-PauseTimeBetweenBatches <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Sets the VMSS rolling upgrade policy properties. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Set-AzureRmVmssRollingUpgradePolicy -VirtualMachineScaleSet $vmss -VirtualMachineScaleSet $vmss -MaxBatchInstancePercent 40 -MaxUnhealthyInstancePercent 35 -MaxUnhealthyUpgradedInstancePercent 30 -PauseTimeBetweenBatches "PT30S" -``` - -This command sets 40 percent for MaxBatchInstance, 35 percent for MaxUnhealthyInstance, 30 percent for MaxUnhealthyUpgradedInstance and 30 second pause time between batches for VMSS local object $vmss. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxBatchInstancePercent -The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. -As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. -If the value is not specified, it is set to 20. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaxUnhealthyInstancePercent -The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. -This constraint will be checked prior to starting any batch. -If the value is not specified, it is set to 20. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaxUnhealthyUpgradedInstancePercent -The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. -This check will happen after each batch is upgraded. -If this percentage is ever exceeded, the rolling update aborts. -If the value is not specified, it is set to 20. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PauseTimeBetweenBatches -The wait time between completing the update for all virtual machines in one batch and starting the next batch. -The time duration should be specified in ISO 8601 format. -The default value is 0 seconds (PT0S). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specifies the VMSS object. -You can use the New-AzureRmVmssConfig cmdlet to create the object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -### System.Int32 - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVmssStorageProfile.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVmssStorageProfile.md deleted file mode 100644 index 265a64fee6..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVmssStorageProfile.md +++ /dev/null @@ -1,383 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 230DAE05-C197-451F-A24C-F4A2DAE4AD04 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmssstorageprofile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVmssStorageProfile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVmssStorageProfile.md ---- - -# Set-AzureRmVmssStorageProfile - -## SYNOPSIS -Sets the storage profile properties for the VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVmssStorageProfile [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> - [[-ImageReferencePublisher] <String>] [[-ImageReferenceOffer] <String>] [[-ImageReferenceSku] <String>] - [[-ImageReferenceVersion] <String>] [[-OsDiskName] <String>] [[-OsDiskCaching] <CachingTypes>] - [[-OsDiskCreateOption] <String>] [[-OsDiskOsType] <OperatingSystemTypes>] [[-Image] <String>] - [[-VhdContainer] <String[]>] [-ImageReferenceId <String>] [-OsDiskWriteAccelerator] - [-DiffDiskSetting <String>] [-ManagedDisk <String>] [-DataDisk <VirtualMachineScaleSetDataDisk[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVmssStorageProfile** cmdlet sets the storage profile properties for the Virtual Machine Scale Set (VMSS). - -## EXAMPLES - -### Example 1: Set the storage profile properties for the VMSS -``` -PS C:\> Set-AzureRmVmssStorageProfile -VirtualMachineScaleSet "ContosoVMSS" -Name "Test" -OsDiskCreateOption "FromImage" -OsDiskCaching "None" ` - -ImageReferenceOffer $ImgRef.Offer -ImageReferenceSku $ImgRef.Skus -ImageReferenceVersion $ImgRef.Version ` - -ImageReferencePublisher $ImgRef.PublisherName -VhdContainer $VhdContainer -``` - -This command sets the storage profile properties for the VMSS named ContosoVMSS. - -## PARAMETERS - -### -DataDisk -Specifies the data disk object. - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetDataDisk[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiffDiskSetting -Specifies the differencing disk settings for operating system disk. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Image -Specifies the blob URI for the user image. -VMSS creates an operating system disk in the same container of the user image. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 9 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ImageReferenceId -Specifies the image reference ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ImageReferenceOffer -Specifies the type of virtual machine image (VMImage) offer. -To obtain an image offer, use the Get-AzureRmVMImageOffer cmdlet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ImageReferencePublisher -Specifies the name of a publisher of a VMImage. -To obtain a publisher, use the Get-AzureRmVMImagePublisher cmdlet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ImageReferenceSku -Specifies the VMImage SKU. -To obtain SKUs, use the Get-AzureRmVMImageSku cmdlet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ImageReferenceVersion -Specifies the version of the VMImage. -To use the latest version, specify a value of latest instead of a particular version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ManagedDisk -Specifies the managed disk. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OsDiskCaching -Specifies the caching mode of the operating system disk. -The acceptable values for this parameter are: -- ReadOnly -- ReadWrite -The default value is ReadWrite. -If you change the caching value, the cmdlet will restart the virtual machine. -This setting affects the consistency and performance of the disk. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.CachingTypes] -Parameter Sets: (All) -Aliases: -Accepted values: None, ReadOnly, ReadWrite - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OsDiskCreateOption -Specifies how this cmdlet creates the VMSS virtual machines. -The acceptable values for this parameter are: -- Attach : This value is used when you are using a specialized disk to create the VMSS virtual machine. -- FromImage : This value is used when you are using an image to create the VMSS virtual machine. -If you are using a platform image, you will also use the *imageReference* parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OsDiskName -Specifies the name of the operating system disk. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OsDiskOsType -Specifies the type of operating system on the disk. -This is only needed for user image scenarios and not for a platform image. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes] -Parameter Sets: (All) -Aliases: -Accepted values: Windows, Linux - -Required: False -Position: 8 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OsDiskWriteAccelerator -Specifies whether WriteAccelerator should be enabled or disabled on the OS disk. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VhdContainer -Specifies the container URLs that are used to store operating system disks for the VMSS. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 10 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specifies the VMSS object. -To obtain the object, use the New-AzureRmVmssConfig object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -### System.String - -### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.CachingTypes, Microsoft.Azure.Management.Compute, Version=21.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -### System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes, Microsoft.Azure.Management.Compute, Version=21.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -### System.String[] - -### Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetDataDisk[] - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMImageOffer](./Get-AzureRmVMImageOffer.md) - -[Get-AzureRmVMImagePublisher](./Get-AzureRmVMImagePublisher.md) - -[Get-AzureRmVMImageSku](./Get-AzureRmVMImageSku.md) - -[New-AzureRmVmssConfig](./New-AzureRmVmssConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVmssVM.md b/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVmssVM.md deleted file mode 100644 index 59d728fa2b..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Set-AzureRmVmssVM.md +++ /dev/null @@ -1,232 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 70AA9747-232E-40F2-845C-35A779F51CD2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmssvm -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVmssVM.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Set-AzureRmVmssVM.md ---- - -# Set-AzureRmVmssVM - -## SYNOPSIS -Modifies the state of a VMSS instance. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameter (Default) -``` -Set-AzureRmVmssVM [-ResourceGroupName] <String> [-VMScaleSetName] <String> [-InstanceId] <String> [-Reimage] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### FriendMethod -``` -Set-AzureRmVmssVM [-ResourceGroupName] <String> [-VMScaleSetName] <String> [-InstanceId] <String> [-ReimageAll] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RedeployMethodParameter -``` -Set-AzureRmVmssVM [-ResourceGroupName] <String> [-VMScaleSetName] <String> [-InstanceId] <String> [-Redeploy] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### PerformMaintenanceMethodParameter -``` -Set-AzureRmVmssVM [-ResourceGroupName] <String> [-VMScaleSetName] <String> [-InstanceId] <String> - [-PerformMaintenance] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVmssVM** cmdlet modifies the state of a Virtual Machine Scale Set (VMSS) instance. - -## EXAMPLES - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceId -Specifies the ID of the VMSS instance for which this cmdlet modifies state. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PerformMaintenance -Indicates that this cmdlet performs maintenance on a virtual machine in the VMSS. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: PerformMaintenanceMethodParameter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Redeploy -Indicates that this cmdlet redeploys a virtual machine in the VMSS. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: RedeployMethodParameter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Reimage -Indicates that this cmdlet reimages the VMSS instance. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReimageAll -Indicates that the cmdlet reimages all the disks in the VMSS instance. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: FriendMethod -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the VMSS instance. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMScaleSetName -Specifies the name of the VMSS instance that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVmssVM](./Get-AzureRmVmssVM.md) diff --git a/azurermps-6.13.0/AzureRM.Compute/Start-AzureRmVM.md b/azurermps-6.13.0/AzureRM.Compute/Start-AzureRmVM.md deleted file mode 100644 index 8cb48617e3..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Start-AzureRmVM.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 7B3259CD-079D-4E07-8608-F818522EE7CF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/start-azurermvm -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Start-AzureRmVM.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Start-AzureRmVM.md ---- - -# Start-AzureRmVM - -## SYNOPSIS -Starts an Azure virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceGroupNameParameterSetName (Default) -``` -Start-AzureRmVM [-Name] <String> [-ResourceGroupName] <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### IdParameterSetName -``` -Start-AzureRmVM [-Name] <String> [-Id] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Start-AzureRmVM** cmdlet starts an Azure virtual machine. - -## EXAMPLES - -### Example 1: Start a virtual machine -``` -PS C:\> Start-AzureRmVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -``` - -This command starts the virtual machine named VirtualMachine07 in ResourceGroup11. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The resource group name. - -```yaml -Type: System.String -Parameter Sets: IdParameterSetName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The virtual machine name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupNameParameterSetName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSComputeLongRunningOperation - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - -[New-AzureRmVM](./New-AzureRmVM.md) - -[Remove-AzureRmVM](./Remove-AzureRmVM.md) - -[Restart-AzureRmVM](./Restart-AzureRmVM.md) - -[Stop-AzureRmVM](./Stop-AzureRmVM.md) - -[Update-AzureRmVM](./Update-AzureRmVM.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Start-AzureRmVmss.md b/azurermps-6.13.0/AzureRM.Compute/Start-AzureRmVmss.md deleted file mode 100644 index 675bde601e..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Start-AzureRmVmss.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 7F7D1F05-617C-4EC5-8FF5-D816E9148841 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/start-azurermvmss -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Start-AzureRmVmss.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Start-AzureRmVmss.md ---- - -# Start-AzureRmVmss - -## SYNOPSIS -Starts the VMSS or a set of virtual machines within the VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Start-AzureRmVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> [[-InstanceId] <String[]>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Start-AzureRmVmss** cmdlet starts all the virtual machines within the Virtual Machine Scale Set (VMSS) or a set of virtual machines. -You can use the *InstanceId* parameter to select a set of virtual machines. - -## EXAMPLES - -### Example 1: Start a specific set of virtual machines within the VMSS -``` -PS C:\> Start-AzureRmVmss -ResourceGroupName "ContosOrg" -VMScaleSetName "ContosoVMSS"-InstanceId "0", "1" -``` - -This command starts a specific set of virtual machines specified by the instance ID string array that belong to the VMSS named ContosoVMSS. - -### Example 2: Start all virtual machines within the VMSS -``` -PS C:\> Start-AzureRmVmss -ResourceGroupName "ContosOrg" -VMScaleSetName "ContosoVMSS" -``` - -This command starts all virtual machines that belong to the VMSS named ContosoVMSS. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceId -Specifies, as a string array, the ID or IDs of the instances that cmdlet starts. -For instance: `-InstanceId "0", "3"` - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the VMSS. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMScaleSetName -Specifies the name of the VMSS that this cmdlet starts the virtual machines. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.String[] - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVmss](./Get-AzureRmVmss.md) - -[New-AzureRmVmss](./New-AzureRmVmss.md) - -[Remove-AzureRmVmss](./Remove-AzureRmVmss.md) - -[Restart-AzureRmVmss](./Restart-AzureRmVmss.md) - -[Set-AzureRmVmss](./Set-AzureRmVmss.md) - -[Stop-AzureRmVmss](./Stop-AzureRmVmss.md) - -[Update-AzureRmVmss](./Update-AzureRmVmss.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Start-AzureRmVmssRollingOSUpgrade.md b/azurermps-6.13.0/AzureRM.Compute/Start-AzureRmVmssRollingOSUpgrade.md deleted file mode 100644 index ed0a5fe504..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Start-AzureRmVmssRollingOSUpgrade.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/start-azurermvmssrollingosupgrade -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Start-AzureRmVmssRollingOSUpgrade.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Start-AzureRmVmssRollingOSUpgrade.md ---- - -# Start-AzureRmVmssRollingOSUpgrade - -## SYNOPSIS -Starts a rolling upgrade to move all virtual machine scale set instances to the latest available Platform Image OS version. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Start-AzureRmVmssRollingOSUpgrade [-ResourceGroupName] <String> [-VMScaleSetName] <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Starts a rolling upgrade to move all virtual machine scale set instances to the latest available Platform Image OS version. -Instances which are already running the latest available OS version are not affected. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Start-AzureRmVmssRollingOSUpgrade -ResourceGroupName "Group001" -VMScaleSetName "VMSS001" -``` - -This command starts a rolling upgrade of all vm instances of VM scale set "VMSS001" in resource group "Group001". - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMScaleSetName -The name of the VM scale set. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Stop-AzureRmVM.md b/azurermps-6.13.0/AzureRM.Compute/Stop-AzureRmVM.md deleted file mode 100644 index f1c829506a..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Stop-AzureRmVM.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 7C3CF963-6F1A-444C-B90C-C1D24F89204D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/stop-azurermvm -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Stop-AzureRmVM.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Stop-AzureRmVM.md ---- - -# Stop-AzureRmVM - -## SYNOPSIS -Stops an Azure virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceGroupNameParameterSetName (Default) -``` -Stop-AzureRmVM [-Name] <String> [-Force] [-StayProvisioned] [-ResourceGroupName] <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### IdParameterSetName -``` -Stop-AzureRmVM [-Name] <String> [-Force] [-StayProvisioned] [-Id] <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Stop-AzureRmVM** cmdlet stops an Azure virtual machine. - -## EXAMPLES - -### Example 1: Stop a virtual machine -``` -PS C:\> Stop-AzureRmVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -``` - -This command stops the virtual machine named VirtualMachine07 in ResourceGroup11. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The resource group name. - -```yaml -Type: System.String -Parameter Sets: IdParameterSetName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The virtual machine name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupNameParameterSetName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StayProvisioned -The cmdlet stops all the virtual machines within the VMSS but does not deallocate them. The account -is charged for the stopped virtual machines. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSComputeLongRunningOperation - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - -[New-AzureRmVM](./New-AzureRmVM.md) - -[Remove-AzureRmVM](./Remove-AzureRmVM.md) - -[Restart-AzureRmVM](./Restart-AzureRmVM.md) - -[Start-AzureRmVM](./Start-AzureRmVM.md) - -[Update-AzureRmVM](./Update-AzureRmVM.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Stop-AzureRmVmss.md b/azurermps-6.13.0/AzureRM.Compute/Stop-AzureRmVmss.md deleted file mode 100644 index ee866fba35..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Stop-AzureRmVmss.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: AF0DDDD0-B664-4AD8-A569-1363FB2EDB40 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/stop-azurermvmss -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Stop-AzureRmVmss.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Stop-AzureRmVmss.md ---- - -# Stop-AzureRmVmss - -## SYNOPSIS -Stops the VMSS or a set of virtual machines within the VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameter (Default) -``` -Stop-AzureRmVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> [[-InstanceId] <String[]>] [-Force] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### FriendMethod -``` -Stop-AzureRmVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> [[-InstanceId] <String[]>] [-Force] - [-StayProvisioned] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Stop-AzureRmVmss** cmdlet stops all the virtual machines within the Virtual Machine Scale Set (VMSS) or a set of virtual machines. -You can use the *InstanceId* parameter to select a set of virtual machines. - -## EXAMPLES - -### Example 1: Stop all the virtual machines within the VMSS -``` -PS C:\> Stop-AzureRmVmss -ResourceGroupName "ContosoGroup" -VMScaleSetName "ContosoVMSS" -``` - -This command stops all virtual machines that belong to the VMSS named ContosoVMSS. - -### Example 2: Stop a specific set of virtual machines within the VMSS -``` -PS C:\> Stop-AzureRmVmss -ResourceGroupName "ContosoGroup" -VMScaleSetName "ContosoVMSS" -InstanceId "3","5" -``` - -This command stops a specific set of virtual machines specified by the instance ID string array that belong to the VMSS named ContosoVMSS. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceId -Specifies, as a string array, the ID or IDs of the virtual machine instances that this cmdlet stops. -For instance: `-InstanceId "0", "3"`. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the VMSS. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StayProvisioned -If specified, the virtual machine will enter stopped state. If not specified, the virtual machine will enter stopped-deallocated state. The user is still charged for VMs in stopped state but not for VMs in stopped-deallocated state. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: FriendMethod -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMScaleSetName -Specifies the name of the VMSS for which this cmdlet stops the virtual machines. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.String[] - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVmss](./Get-AzureRmVmss.md) - -[New-AzureRmVmss](./New-AzureRmVmss.md) - -[Remove-AzureRmVmss](./Remove-AzureRmVmss.md) - -[Restart-AzureRmVmss](./Restart-AzureRmVmss.md) - -[Set-AzureRmVmss](./Set-AzureRmVmss.md) - -[Start-AzureRmVmss](./Start-AzureRmVmss.md) - -[Update-AzureRmVmss](./Update-AzureRmVmss.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Stop-AzureRmVmssRollingUpgrade.md b/azurermps-6.13.0/AzureRM.Compute/Stop-AzureRmVmssRollingUpgrade.md deleted file mode 100644 index 2fb56dd187..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Stop-AzureRmVmssRollingUpgrade.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/stop-azurermvmssrollingupgrade -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Stop-AzureRmVmssRollingUpgrade.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Stop-AzureRmVmssRollingUpgrade.md ---- - -# Stop-AzureRmVmssRollingUpgrade - -## SYNOPSIS -Cancels the current virtual machine scale set rolling upgrade. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameter (Default) -``` -Stop-AzureRmVmssRollingUpgrade [-ResourceGroupName] <String> [-VMScaleSetName] <String> [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### FriendMethod -``` -Stop-AzureRmVmssRollingUpgrade [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Cancels the current virtual machine scale set rolling upgrade. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Stop-AzureRmVmssRollingUpgrade -ResourceGroupName "Group001" -VMScaleSetName "VMSS001" -``` - -This command cancels on-going rolling upgrade of VM scale set "VMSS001" in resource group "Group001". - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMScaleSetName -The name of the VM scale set. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Test-AzureRmVMAEMExtension.md b/azurermps-6.13.0/AzureRM.Compute/Test-AzureRmVMAEMExtension.md deleted file mode 100644 index f255d0850b..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Test-AzureRmVMAEMExtension.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 67AED9B8-AE3D-47E5-813C-9B46E11AE46C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/test-azurermvmaemextension -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Test-AzureRmVMAEMExtension.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Test-AzureRmVMAEMExtension.md ---- - -# Test-AzureRmVMAEMExtension - -## SYNOPSIS -Checks the configuration of the AEM extension. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Test-AzureRmVMAEMExtension [-ResourceGroupName] <String> [-VMName] <String> [[-OSType] <String>] - [[-WaitTimeInMinutes] <Int32>] [-SkipStorageCheck] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Test-AzureRmVMAEMExtension** cmdlet checks the configuration of the Azure Enhanced Monitoring (AEM) extension. -The AEM extension collects the performance data. -This cmdlet checks whether performance data is available. - -## EXAMPLES - -### Example 1: Check the configuration of the AEM extension -``` -PS C:\> Test-AzureRmVMAEMExtension -ResourceGroupName "ResourceGroup11" -VMName "contoso-server" -``` - -This command checks the configuration of the AEM extension for the virtual machine named contoso-server. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OSType -Specifies the type of the operating system of the operating system disk. -If the operating system disk does not have a type, you must specify this parameter. -The acceptable values for this parameter are: Windows and Linux. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine that this cmdlet checks. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkipStorageCheck -Indicates that this cmdlet skips the check of storage configuration. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine. -This cmdlet tests the AEM extension for the virtual machine that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WaitTimeInMinutes -Specifies a time-out period, in minutes, for the storage configuration check. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Extension.AEM.AEMTestResult - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMAEMExtension](./Get-AzureRmVMAEMExtension.md) - -[Remove-AzureRmVMAEMExtension](./Remove-AzureRmVMAEMExtension.md) - -[Set-AzureRmVMAEMExtension](./Set-AzureRmVMAEMExtension.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmAvailabilitySet.md b/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmAvailabilitySet.md deleted file mode 100644 index 0278a52a63..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmAvailabilitySet.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/update-azurermavailabilityset -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Update-AzureRmAvailabilitySet.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Update-AzureRmAvailabilitySet.md ---- - -# Update-AzureRmAvailabilitySet - -## SYNOPSIS -Updates an availability set. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SkuParameterSet -``` -Update-AzureRmAvailabilitySet [-AvailabilitySet] <PSAvailabilitySet> [-Sku] <String> [-Tag <Hashtable>] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ManagedParamterSet -``` -Update-AzureRmAvailabilitySet [-AvailabilitySet] <PSAvailabilitySet> [-Managed] [-Tag <Hashtable>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureRmAvailabilitySet** cmdlet updates an availability set. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmAvailabilitySet -ResourceGroupName 'ResourceGroup01' -Name 'AvSet01' | Update-AzureRmAvailabilitySet -Managed; -``` - -This command updates the availability set named 'AvSet01' in the resource group named 'ResourceGroup01' to a managed availability set. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AvailabilitySet -Specifies the availability set object to be updated. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Models.PSAvailabilitySet -Parameter Sets: (All) -Aliases: VMProfile - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Managed -Managed Availability Set - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ManagedParamterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sku -The Name of Sku - -```yaml -Type: System.String -Parameter Sets: SkuParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAvailabilitySet - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAvailabilitySet - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmContainerService.md b/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmContainerService.md deleted file mode 100644 index 72761d58cb..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmContainerService.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 43D01A97-75B9-46CE-B007-26FE6A97C31C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/update-azurermcontainerservice -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Update-AzureRmContainerService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Update-AzureRmContainerService.md ---- - -# Update-AzureRmContainerService - -## SYNOPSIS -Updates the state of a container service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Update-AzureRmContainerService [-ResourceGroupName] <String> [-Name] <String> - [-ContainerService] <PSContainerService> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureRmContainerService** cmdlet updates the state of a container service to match a local instance of the service. - -## EXAMPLES - -### Example 1: Update a container service -``` -PS C:\> Get-AzureRmContainerService -ResourceGroupName "ResourceGroup17" -Name "CSResourceGroup17" | Remove-AzureRmContainerServiceAgentPoolProfile -Name "AgentPool01" | Add-AzureRmContainerServiceAgentPoolProfile -Name "AgentPool01" -VmSize "Standard_A1" -DnsPrefix "APResourceGroup17" -Count 2 | Update-AzureRmContainerService -ResourceGroupName "ResourceGroup17" -Name "CSResourceGroup17" -``` - -This command gets the container service named CSResourceGroup17 by using the Get-AzureRmContainerService cmdlet. -The command passes that object to the Remove-AzureRmContainerServiceAgentPoolProfile cmdlet by using the pipeline operator. -**Remove-AzureRmContainerServiceAgentPoolProfile** removes the profile named AgentPool01. -The command passes the result to the Add-AzureRmContainerServiceAgentPoolProfile cmdlet. -**Add-AzureRmContainerServiceAgentPoolProfile** adds a profile that has the name AgentPool01, and has the specified properties. -The command passes the result to the current cmdlet. -The current cmdlet updates the container service to reflect the changes that were made in this command. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContainerService -Specifies a local **ContainerService** object that contains changes. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSContainerService -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the container service that this cmdlet updates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group of the container service that this cmdlet updates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSContainerService -Parameters: ContainerService (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSContainerService - -## NOTES - -## RELATED LINKS - -[Add-AzureRmContainerServiceAgentPoolProfile](./Add-AzureRmContainerServiceAgentPoolProfile.md) - -[Get-AzureRmContainerService](./Get-AzureRmContainerService.md) - -[New-AzureRmContainerService](./New-AzureRmContainerService.md) - -[Remove-AzureRmContainerService](./Remove-AzureRmContainerService.md) - -[Remove-AzureRmContainerServiceAgentPoolProfile](./Remove-AzureRmContainerServiceAgentPoolProfile.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmDisk.md b/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmDisk.md deleted file mode 100644 index 60e694bc33..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmDisk.md +++ /dev/null @@ -1,210 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/update-azurermdisk -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Update-AzureRmDisk.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Update-AzureRmDisk.md ---- - -# Update-AzureRmDisk - -## SYNOPSIS -Updates a disk. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameter (Default) -``` -Update-AzureRmDisk [-ResourceGroupName] <String> [-DiskName] <String> [-DiskUpdate] <PSDiskUpdate> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### FriendMethod -``` -Update-AzureRmDisk [-ResourceGroupName] <String> [-DiskName] <String> [-Disk] <PSDisk> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureRmDisk** cmdlet updates a disk. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $diskupdateconfig = New-AzureRmDiskUpdateConfig -DiskSizeGB 10 -AccountType PremiumLRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; -PS C:\> $secretUrl = https://myvault.vault-int.azure-int.net/secrets/123/; -PS C:\> $secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; -PS C:\> $keyUrl = https://myvault.vault-int.azure-int.net/keys/456; -PS C:\> $keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; -PS C:\> $diskupdateconfig = Set-AzureRmDiskUpdateDiskEncryptionKey -DiskUpdate $diskupdateconfig -SecretUrl $secretUrl -SourceVaultId $secretId; -PS C:\> $diskupdateconfig = Set-AzureRmDiskUpdateKeyEncryptionKey -DiskUpdate $diskupdateconfig -KeyUrl $keyUrl -SourceVaultId $keyId; -PS C:\> Update-AzureRmDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -DiskUpdate $diskupdateconfig; -``` - -The first command creates a local empty disk update object with size 10GB in Premium_LRS storage account type. It also sets Windows OS type and enables encryption settings. -The second and third commands set the disk encryption key and key encryption key settings for the disk update object. -The last command takes the disk update object and updates an existing disk with name 'Disk01' in resource group 'ResourceGroup01'. - -### Example 2 -``` -PS C:\> New-AzureRmDiskUpdateConfig -DiskSizeGB 10 | Update-AzureRmDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01'; -``` - -This command updates an existing disk with name 'Disk01' in resource group 'ResourceGroup01' to 10 GB disk size. - -### Example 3 -``` -PS C:\> $disk = Get-AzureRmDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01'; -PS C:\> $disk.DiskSizeGB = 10; -PS C:\> Update-AzureRmDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -Disk $disk; -``` - -These commands also update an existing disk with name 'Disk01' in resource group 'ResourceGroup01' to 10 GB disk size. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disk -Specifies a local disk object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk -Parameter Sets: FriendMethod -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DiskName -Specifies the name of a disk. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DiskUpdate -Specifies a local disk update object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskUpdate -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskUpdate -Parameters: DiskUpdate (ByValue) - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk -Parameters: Disk (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmGallery.md b/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmGallery.md deleted file mode 100644 index 6d12b0e857..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmGallery.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/update-azurermgallery -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Update-AzureRmGallery.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Update-AzureRmGallery.md ---- - -# Update-AzureRmGallery - -## SYNOPSIS -Update a gallery. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameter (Default) -``` -Update-AzureRmGallery [-ResourceGroupName] <String> [-Name] <String> [-AsJob] [-Description <String>] - [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameter -``` -Update-AzureRmGallery [-ResourceId] <String> [-AsJob] [-Description <String>] [-Tag <Hashtable>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ObjectParameter -``` -Update-AzureRmGallery [-InputObject] <PSGallery> [-AsJob] [-Description <String>] [-Tag <Hashtable>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Update a gallery. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Update-AzureRmGallery -ResourceGroupName $rgname -Name $galleryName -Description $galleryDescription -``` - -Update a gallery. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The description of the gallery resource. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -The PS Gallery Object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSGallery -Parameter Sets: ObjectParameter -Aliases: Gallery - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the gallery. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: GalleryName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The resource Id for the gallery - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameter -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Resource tags - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSGallery - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSGallery - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmGalleryImageDefinition.md b/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmGalleryImageDefinition.md deleted file mode 100644 index 72a70403fd..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmGalleryImageDefinition.md +++ /dev/null @@ -1,432 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/update-azurermgalleryimagedefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Update-AzureRmGalleryImageDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Update-AzureRmGalleryImageDefinition.md ---- - -# Update-AzureRmGalleryImageDefinition - -## SYNOPSIS -Update a gallery image definition. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameter (Default) -``` -Update-AzureRmGalleryImageDefinition [-ResourceGroupName] <String> [-GalleryName] <String> [-Name] <String> - [-AsJob] [-Description <String>] [-Eula <String>] [-PrivacyStatementUri <String>] [-ReleaseNoteUri <String>] - [-EndOfLifeDate <DateTime>] [-Tag <Hashtable>] [-MinimumVCPU <Int32>] [-MaximumVCPU <Int32>] - [-MinimumMemory <Int32>] [-MaximumMemory <Int32>] [-DisallowedDiskType <String[]>] - [-PurchasePlanName <String>] [-PurchasePlanPublisher <String>] [-PurchasePlanProduct <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameter -``` -Update-AzureRmGalleryImageDefinition [-ResourceId] <String> [-AsJob] [-Description <String>] [-Eula <String>] - [-PrivacyStatementUri <String>] [-ReleaseNoteUri <String>] [-EndOfLifeDate <DateTime>] [-Tag <Hashtable>] - [-MinimumVCPU <Int32>] [-MaximumVCPU <Int32>] [-MinimumMemory <Int32>] [-MaximumMemory <Int32>] - [-DisallowedDiskType <String[]>] [-PurchasePlanName <String>] [-PurchasePlanPublisher <String>] - [-PurchasePlanProduct <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ObjectParameter -``` -Update-AzureRmGalleryImageDefinition [-InputObject] <PSGalleryImage> [-AsJob] [-Description <String>] - [-Eula <String>] [-PrivacyStatementUri <String>] [-ReleaseNoteUri <String>] [-EndOfLifeDate <DateTime>] - [-Tag <Hashtable>] [-MinimumVCPU <Int32>] [-MaximumVCPU <Int32>] [-MinimumMemory <Int32>] - [-MaximumMemory <Int32>] [-DisallowedDiskType <String[]>] [-PurchasePlanName <String>] - [-PurchasePlanPublisher <String>] [-PurchasePlanProduct <String>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Update a gallery image definition. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Update-AzureRmGalleryImageDefinition -ResourceGroupName $resourceGroupName -GalleryName $galleryName -Name $galleryImageDefinitionName -Description $description -Eula $eula -PrivacyStatementUri $privacyStatementUri -ReleaseNoteUri $releaseNoteUri -DisallowedDiskType $disallowedDiskTypes -EndOfLifeDate $endOfLifeDate -MinimumMemory $minMemory -MaximumMemory $maxMemory -MinimumVCPU $minVCPU -MaximumVCPU $maxVCPU -PurchasePlanName $purchasePlanName -PurchasePlanProduct $purchasePlanProduct -PurchasePlanPublisher $purchasePlanPublisher -``` - -Update a gallery image definition. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The description of the gallery image Definition resource. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisallowedDiskType -The disallowed disk types. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EndOfLifeDate -The end of life date of the gallery Image Definition - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Eula -The Eula agreement for the gallery Image Definition. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GalleryName -The name of the gallery. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -The PS Gallery Image Definition Object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSGalleryImage -Parameter Sets: ObjectParameter -Aliases: GalleryImageDefinition - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -MaximumMemory -The maximum of the recommended memory - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaximumVCPU -The maximum of the recommended CPU core - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MinimumMemory -The minimum of the recommended memory - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MinimumVCPU -The minimum of the recommended CPU core - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The name of the gallery image definition. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: GalleryImageDefinitionName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PrivacyStatementUri -The privacy statement uri. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PurchasePlanName -The ID for the purchase plan. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PurchasePlanProduct -The product ID for the purchase plan. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PurchasePlanPublisher -The publisher ID for the purchase plan. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReleaseNoteUri -The release note uri. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The resource ID for the image definition - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameter -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Resource tags - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSGalleryImage - -### System.DateTime - -### System.Collections.Hashtable - -### System.Int32 - -### System.String[] - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSGalleryImage - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmGalleryImageVersion.md b/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmGalleryImageVersion.md deleted file mode 100644 index 30cf554b72..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmGalleryImageVersion.md +++ /dev/null @@ -1,313 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/update-azurermgalleryimageversion -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Update-AzureRmGalleryImageVersion.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Update-AzureRmGalleryImageVersion.md ---- - -# Update-AzureRmGalleryImageVersion - -## SYNOPSIS -Update a gallery image version. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameter (Default) -``` -Update-AzureRmGalleryImageVersion [-ResourceGroupName] <String> [-GalleryName] <String> - [-GalleryImageDefinitionName] <String> [-Name] <String> [-AsJob] [-Tag <Hashtable>] [-ReplicaCount <Int32>] - [-PublishingProfileExcludeFromLatest] [-PublishingProfileEndOfLifeDate <DateTime>] - [-TargetRegion <Hashtable[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ResourceIdParameter -``` -Update-AzureRmGalleryImageVersion [-ResourceId] <String> [-AsJob] [-Tag <Hashtable>] [-ReplicaCount <Int32>] - [-PublishingProfileExcludeFromLatest] [-PublishingProfileEndOfLifeDate <DateTime>] - [-TargetRegion <Hashtable[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ObjectParameter -``` -Update-AzureRmGalleryImageVersion [-InputObject] <PSGalleryImageVersion> [-AsJob] [-Tag <Hashtable>] - [-ReplicaCount <Int32>] [-PublishingProfileExcludeFromLatest] [-PublishingProfileEndOfLifeDate <DateTime>] - [-TargetRegion <Hashtable[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Update a gallery image version. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> $region1 = @{Name='West US';ReplicaCount=1} -PS C:\> $region2 = @{Name='East US';ReplicaCount=2} -PS C:\> $region3 = @{Name='Central US'} -PS C:\> $targetRegions = @($region1,$region2,$region3) -PS C:\> Update-AzureRmGalleryImageVersion -ResourceGroupName $rgname -GalleryName $galleryName -GalleryImageName $imageName -Name $versionName -ReplicaCount 2 -PublishingProfileEndOfLifeDate $endOfLifeDate -TargetRegion $targetRegions -``` - -Update a gallery image version. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GalleryImageDefinitionName -The name of the gallery image definition. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GalleryName -The name of the gallery. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -The PS Gallery Image Version Object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSGalleryImageVersion -Parameter Sets: ObjectParameter -Aliases: GalleryImageVersion - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the gallery image version. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: GalleryImageVersionName - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublishingProfileEndOfLifeDate -The end of life date of the gallery Image Version. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublishingProfileExcludeFromLatest -If it is set, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReplicaCount -The number of replicas of the Image Version to be created per region. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The resource ID for the gallery image version. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameter -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Resource tags - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetRegion -The target regions where the Image Version is going to be replicated to. - -```yaml -Type: System.Collections.Hashtable[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSGalleryImageVersion - -### System.Collections.Hashtable - -### System.Int32 - -### System.Management.Automation.SwitchParameter - -### System.DateTime - -### System.Collections.Hashtable[] - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSGalleryImageVersion - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmImage.md b/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmImage.md deleted file mode 100644 index f129b93f10..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmImage.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/update-azurermimage -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Update-AzureRmImage.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Update-AzureRmImage.md ---- - -# Update-AzureRmImage - -## SYNOPSIS -Updates an image. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Update-AzureRmImage [-ResourceGroupName] <String> [-ImageName] <String> [-Image] <PSImage> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureRmImage** cmdlet updates an image. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmImage -ResourceGroupName 'ResourceGroup01' -ImageName 'Image01' | Remove-AzureRmImageDataDisk -Lun 1 | Update-AzureRmImage; -``` - -This command removes the data disk of logical unit number 1 from the existing image 'Image01' in the resource group 'ResourceGroup01'. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Image -Specifies a local image object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSImage -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ImageName -Specifies the name of an image. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSImage -Parameters: Image (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSImage - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmSnapshot.md b/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmSnapshot.md deleted file mode 100644 index 4fe90e0761..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmSnapshot.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/update-azurermsnapshot -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Update-AzureRmSnapshot.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Update-AzureRmSnapshot.md ---- - -# Update-AzureRmSnapshot - -## SYNOPSIS -Updates a snapshot. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameter (Default) -``` -Update-AzureRmSnapshot [-ResourceGroupName] <String> [-SnapshotName] <String> - [-SnapshotUpdate] <PSSnapshotUpdate> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### FriendMethod -``` -Update-AzureRmSnapshot [-ResourceGroupName] <String> [-SnapshotName] <String> [-Snapshot] <PSSnapshot> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureRmSnapshot** cmdlet updates a snapshot. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $snapshotupdateconfig = New-AzureRmSnapshotUpdateConfig -DiskSizeGB 10 -AccountType PremiumLRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; -PS C:\> $secretUrl = https://myvault.vault-int.azure-int.net/secrets/123/; -PS C:\> $secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; -PS C:\> $keyUrl = https://myvault.vault-int.azure-int.net/keys/456; -PS C:\> $keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; -PS C:\> $snapshotupdateconfig = Set-AzureRmSnapshotUpdateDiskEncryptionKey -SnapshotUpdate $snapshotupdateconfig -SecretUrl $secretUrl -SourceVaultId $secretId; -PS C:\> $snapshotupdateconfig = Set-AzureRmSnapshotUpdateKeyEncryptionKey -SnapshotUpdate $snapshotupdateconfig -KeyUrl $keyUrl -SourceVaultId $keyId; -PS C:\> Update-AzureRmSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -SnapshotUpdate $snapshotupdateconfig; -``` - -The first command creates a local empty snapshot update object with size 10GB in Premium_LRS storage account type. It also sets Windows OS type and enables encryption settings. -The second and third commands set the disk encryption key and key encryption key settings for the snapshot update object. -The last command takes the snapshot update object and updates an existing snapshot with name 'Snapshot01' in resource group 'ResourceGroup01'. - -### Example 2 -``` -PS C:\> New-AzureRmSnapshotUpdateConfig -DiskSizeGB 10 | Update-AzureRmSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01'; -``` - -This command updates an existing snapshot with name 'Snapshot01' in resource group 'ResourceGroup01' to 10 GB disk size. - -### Example 3 -``` -PS C:\> $snapshot = Get-AzureRmSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01'; -PS C:\> $snapshot.DiskSizeGB = 10; -PS C:\> Update-AzureRmSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -Snapshot $snapshot; -``` - -These commands also update an existing snapshot with name 'Snapshot01' in resource group 'ResourceGroup01' to 10 GB disk size. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Snapshot -Specifies a local snapshot object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot -Parameter Sets: FriendMethod -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SnapshotName -Specifies the name of a snapshot. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SnapshotUpdate -Specifies a local snapshot update object. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshotUpdate -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshotUpdate -Parameters: SnapshotUpdate (ByValue) - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot -Parameters: Snapshot (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmVM.md b/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmVM.md deleted file mode 100644 index 0f611cee19..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmVM.md +++ /dev/null @@ -1,299 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 38917534-49C6-47EA-B815-240F794EE655 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/update-azurermvm -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Update-AzureRmVM.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Update-AzureRmVM.md ---- - -# Update-AzureRmVM - -## SYNOPSIS -Updates the state of an Azure virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceGroupNameParameterSetName (Default) -``` -Update-AzureRmVM [-ResourceGroupName] <String> -VM <PSVirtualMachine> [-Tag <Hashtable>] - [-OsDiskWriteAccelerator <Boolean>] [-UltraSSDEnabled <Boolean>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### AssignIdentityParameterSet -``` -Update-AzureRmVM [-ResourceGroupName] <String> -VM <PSVirtualMachine> [-Tag <Hashtable>] [-AssignIdentity] - [-OsDiskWriteAccelerator <Boolean>] [-UltraSSDEnabled <Boolean>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ExplicitIdentityParameterSet -``` -Update-AzureRmVM [-ResourceGroupName] <String> -VM <PSVirtualMachine> [-Tag <Hashtable>] - -IdentityType <ResourceIdentityType> [-IdentityId <String[]>] [-OsDiskWriteAccelerator <Boolean>] - [-UltraSSDEnabled <Boolean>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### IdParameterSetName -``` -Update-AzureRmVM [-Id] <String> -VM <PSVirtualMachine> [-Tag <Hashtable>] [-OsDiskWriteAccelerator <Boolean>] - [-UltraSSDEnabled <Boolean>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureRmVM** cmdlet updates the state of an Azure virtual machine to the state of a virtual machine object. - -## EXAMPLES - -### Example 1: Update a virtual machine -``` -PS C:\> Update-AzureRmVM -ResourceGroupName "ResourceGroup11" -VM $VirtualMachine -``` - -This command updates the virtual machine, $VirtualMachine, in ResourceGroup11. -The command updates it by using the virtual machine object stored in the $VirtualMachine variable. -To obtain a virtual machine object, use the **Get-AzureRmVM** cmdlet. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignIdentity -Specify the system assigned identity for the virtual machine. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: AssignIdentityParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the Resource ID of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: IdParameterSetName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IdentityId -Specifies the list of user identities associated with the virtual machine scale set. -The user identity references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}' - -```yaml -Type: System.String[] -Parameter Sets: ExplicitIdentityParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IdentityType -The type of identity used for the virtual machine. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.ResourceIdentityType] -Parameter Sets: ExplicitIdentityParameterSet -Aliases: -Accepted values: SystemAssigned, UserAssigned, SystemAssignedUserAssigned, None - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OsDiskWriteAccelerator -Specifies whether WriteAccelerator should be enabled or disabled on the OS disk. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupNameParameterSetName, AssignIdentityParameterSet, ExplicitIdentityParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Specifies the resources and resource groups can be tagged with a set of name-value pairs. -Adding tags to resources enables you to group resources together across resource groups and to create your own views. -Each resource or resource group can have a maximum of 15 tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UltraSSDEnabled -The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM. -Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine only if this property is enabled. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VM -Specifies a local virtual machine object. -To obtain a virtual machine object, use the Get-AzureRmVM cmdlet. -This virtual machine object contains the updated state for the virtual machine. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine -Parameter Sets: (All) -Aliases: VMProfile - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - -[New-AzureRmVM](./New-AzureRmVM.md) - -[Remove-AzureRmVM](./Remove-AzureRmVM.md) - -[Restart-AzureRmVM](./Restart-AzureRmVM.md) - -[Start-AzureRmVM](./Start-AzureRmVM.md) - -[Stop-AzureRmVM](./Stop-AzureRmVM.md) - -[New-AzureRmVMConfig](./New-AzureRmVMConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmVmss.md b/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmVmss.md deleted file mode 100644 index 207868cbb0..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmVmss.md +++ /dev/null @@ -1,827 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 9EE192A5-4E3F-41ED-A539-8E0A5D5EA4C9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/update-azurermvmss -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Update-AzureRmVmss.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Update-AzureRmVmss.md ---- - -# Update-AzureRmVmss - -## SYNOPSIS -Updates the state of a VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameter (Default) -``` -Update-AzureRmVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> - [[-VirtualMachineScaleSet] <PSVirtualMachineScaleSet>] [-ImageReferenceSku <String>] - [-ManagedDiskStorageAccountType <String>] [-PlanPublisher <String>] [-ProvisionVMAgent <Boolean>] - [-BootDiagnosticsEnabled <Boolean>] [-Overprovision <Boolean>] [-MaxBatchInstancePercent <Int32>] - [-TimeZone <String>] [-BootDiagnosticsStorageUri <String>] [-AutomaticOSUpgrade <Boolean>] - [-DisableAutoRollback <Boolean>] [-SinglePlacementGroup <Boolean>] [-CustomData <String>] - [-UpgradePolicyMode <UpgradeMode>] [-ImageReferenceId <String>] [-DisablePasswordAuthentication <Boolean>] - [-Tag <Hashtable>] [-PlanName <String>] [-MaxUnhealthyUpgradedInstancePercent <Int32>] - [-ImageReferencePublisher <String>] [-PlanProduct <String>] [-VhdContainer <String[]>] [-ImageUri <String>] - [-SkuTier <String>] [-EnableAutomaticUpdate <Boolean>] [-LicenseType <String>] [-SkuName <String>] - [-PlanPromotionCode <String>] [-MaxUnhealthyInstancePercent <Int32>] [-SkuCapacity <Int32>] - [-OsDiskWriteAccelerator <Boolean>] [-ImageReferenceOffer <String>] [-PauseTimeBetweenBatches <String>] - [-OsDiskCaching <CachingTypes>] [-ImageReferenceVersion <String>] [-UltraSSDEnabled <Boolean>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ExplicitIdentityParameterSet -``` -Update-AzureRmVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> - [[-VirtualMachineScaleSet] <PSVirtualMachineScaleSet>] [-ImageReferenceSku <String>] [-IdentityId <String[]>] - [-ManagedDiskStorageAccountType <String>] [-PlanPublisher <String>] [-ProvisionVMAgent <Boolean>] - [-BootDiagnosticsEnabled <Boolean>] [-Overprovision <Boolean>] [-MaxBatchInstancePercent <Int32>] - [-TimeZone <String>] [-BootDiagnosticsStorageUri <String>] [-AutomaticOSUpgrade <Boolean>] - [-DisableAutoRollback <Boolean>] [-SinglePlacementGroup <Boolean>] [-CustomData <String>] - [-UpgradePolicyMode <UpgradeMode>] [-ImageReferenceId <String>] [-DisablePasswordAuthentication <Boolean>] - [-Tag <Hashtable>] [-PlanName <String>] [-MaxUnhealthyUpgradedInstancePercent <Int32>] - [-ImageReferencePublisher <String>] [-PlanProduct <String>] [-VhdContainer <String[]>] [-ImageUri <String>] - [-SkuTier <String>] [-EnableAutomaticUpdate <Boolean>] [-LicenseType <String>] - -IdentityType <ResourceIdentityType> [-SkuName <String>] [-PlanPromotionCode <String>] - [-MaxUnhealthyInstancePercent <Int32>] [-SkuCapacity <Int32>] [-OsDiskWriteAccelerator <Boolean>] - [-ImageReferenceOffer <String>] [-PauseTimeBetweenBatches <String>] [-OsDiskCaching <CachingTypes>] - [-ImageReferenceVersion <String>] [-UltraSSDEnabled <Boolean>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureRmVmss** cmdlet updates the state of a Virtual Machine Scale Set (VMSS) to the state of a local VMSS object. - -## EXAMPLES - -### Example 1: Update the state of a VMSS to the state of a local VMSS object. -``` -PS C:\> Update-AzureRmVmss -ResourceGroupName "Group001" -Name "VMSS001" -VirtualMachineScaleSet $LocalVMSS -``` - -This command updates the state of the VMSS named VMSS001 that belongs to the resource group named Group001 to the state of a local VMSS object, $LocalVMSS. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutomaticOSUpgrade -Sets whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BootDiagnosticsEnabled -Whether boot diagnostics should be enabled on the virtual machine scale set. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BootDiagnosticsStorageUri -URI of the storage account to use for placing the console output and screenshot. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomData -Specifies a base-64 encoded string of custom data. -This is decoded to a binary array that is saved as a file on the virtual machine. -The maximum length of the binary array is 65535 bytes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableAutoRollback -Disable Auto Rollback for Auto OS Upgrade Policy - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisablePasswordAuthentication -Indicates that this cmdlet disables password authentication for Linux OS. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableAutomaticUpdate -Indicates whether the Windows virtual machines in the VMSS are enabled for automatic updates. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IdentityId -Specifies the list of user identities associated with the virtual machine scale set. -The user identity references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}' - -```yaml -Type: System.String[] -Parameter Sets: ExplicitIdentityParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IdentityType -Specifies the type of identity used for the virtual machine scale set. -The type 'SystemAssignedUserAssigned' includes both an implicitly created identity and a set of user assigned identities. -The type 'None' will remove any identities from the virtual machine scale set. -The acceptable values for this parameter are: -- SystemAssigned -- UserAssigned -- SystemAssignedUserAssigned -- None - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.Compute.Models.ResourceIdentityType] -Parameter Sets: ExplicitIdentityParameterSet -Aliases: -Accepted values: SystemAssigned, UserAssigned, SystemAssignedUserAssigned, None - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImageReferenceId -Specifies the image reference ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImageReferenceOffer -Specifies the type of virtual machine image (VMImage) offer. -To obtain an image offer, use the Get-AzureRmVMImageOffer cmdlet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImageReferencePublisher -Specifies the name of a publisher of a VMImage. -To obtain a publisher, use the Get-AzureRmVMImagePublisher cmdlet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImageReferenceSku -Specifies the VMImage SKU. -To obtain SKUs, use the Get-AzureRmVMImageSku cmdlet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImageReferenceVersion -Specifies the version of the VMImage. -To use the latest version, specify a value of latest instead of a particular version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImageUri -Specifies the blob URI for the user image. -VMSS creates an operating system disk in the same container of the user image. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LicenseType -Specify the license type, which is for bringing your own license scenario. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedDiskStorageAccountType -Specifies the storage account type for managed disk. -The acceptable values for this parameter are: -- StandardLRS -- PremiumLRS - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxBatchInstancePercent -The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. -As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. -If the value is not specified, it is set to 20. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxUnhealthyInstancePercent -The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. -This constraint will be checked prior to starting any batch. -If the value is not specified, it is set to 20. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxUnhealthyUpgradedInstancePercent -The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. -This check will happen after each batch is upgraded. -If this percentage is ever exceeded, the rolling update aborts. -If the value is not specified, it is set to 20. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OsDiskCaching -Specifies the caching mode of the operating system disk. -The acceptable values for this parameter are: -- None -- ReadOnly -- ReadWrite -The default value is ReadWrite. -If you change the caching value, the cmdlet will restart the virtual machine. -This setting affects the consistency and performance of the disk. - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.CachingTypes -Parameter Sets: (All) -Aliases: -Accepted values: None, ReadOnly, ReadWrite - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OsDiskWriteAccelerator -Specifies whether WriteAccelerator should be enabled or disabled on the OS disk. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Overprovision -Indicates whether the cmdlet overprovisions the VMSS. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PauseTimeBetweenBatches -The wait time between completing the update for all virtual machines in one batch and starting the next batch. -The time duration should be specified in ISO 8601 format. -The default value is 0 seconds (PT0S). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PlanName -Specifies the plan name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PlanProduct -Specifies the plan product. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PlanPromotionCode -Specifies the plan promotion code. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PlanPublisher -Specifies the plan publisher. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProvisionVMAgent -Indicates whether virtual machine agent should be provisioned on the Windows virtual machines in the VMSS. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group the VMSS belongs to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SinglePlacementGroup -Specifies the single placement group. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkuCapacity -Specifies the number of instances in the VMSS. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkuName -Specifies the size of all the instances of VMSS. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkuTier -Specifies the tier of VMSS. -The acceptable values for this parameter are: -- Standard -- Basic - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeZone -Specifies the time zone for Windows OS. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UltraSSDEnabled -The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the virtual machine scale set. -Managed disks with storage account type UltraSSD_LRS can be added to a VMSS only if this property is enabled. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UpgradePolicyMode -Specified the mode of an upgrade to virtual machines in the scale set. -The acceptable values for this parameter are: -- Automatic -- Manual -- Rolling - -```yaml -Type: Microsoft.Azure.Management.Compute.Models.UpgradeMode -Parameter Sets: (All) -Aliases: -Accepted values: Automatic, Manual, Rolling - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VhdContainer -Specifies the container URLs that are used to store operating system disks for the VMSS. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specifies a local VMSS object. -To obtain a VMSS object, use the Get-AzureRmVmss cmdlet. -This virtual machine object contains the updated state for the VMSS. - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMScaleSetName -Specifies the name of the VMSS that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet -Parameters: VirtualMachineScaleSet (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVmss](./Get-AzureRmVmss.md) - -[New-AzureRmVmss](./New-AzureRmVmss.md) - -[Remove-AzureRmVmss](./Remove-AzureRmVmss.md) - -[Restart-AzureRmVmss](./Restart-AzureRmVmss.md) - -[Set-AzureRmVmss](./Set-AzureRmVmss.md) - -[Start-AzureRmVmss](./Start-AzureRmVmss.md) - -[Stop-AzureRmVmss](./Stop-AzureRmVmss.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmVmssInstance.md b/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmVmssInstance.md deleted file mode 100644 index 8f3fb74b43..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmVmssInstance.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: E8C9D68E-7C68-43D0-B348-72E9713CB99F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/update-azurermvmssinstance -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Update-AzureRmVmssInstance.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Update-AzureRmVmssInstance.md ---- - -# Update-AzureRmVmssInstance - -## SYNOPSIS -Starts a manual upgrade of the VMSS instance. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Update-AzureRmVmssInstance [-ResourceGroupName] <String> [-VMScaleSetName] <String> [-InstanceId] <String[]> - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Update-AzureRmVmssInstance cmdlet starts a manual upgrade of the specified Virtual Machine Scale Set (VMSS) instance. -This is used when the upgrade policy on the VMSS Scale Set is set to manual. - -## EXAMPLES - -### Example 1: Start an upgrade of the VMSS instance -``` -PS C:\> Update-AzureRmVmssInstance -ResourceGroupName "Group011" -VMScaleSetName "VMScaleSet001" -InstanceId "0" -``` - -This command starts an upgrade of the VMSS named VMScaleSet001 that has the instance ID of 0. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceId -Specifies, as a string array, the ID or IDs of the instance to upgrade. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the VMSS. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMScaleSetName -Specifies the name of the VMSS instance that this cmdlet upgrades. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.String[] - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse - -## NOTES - -## RELATED LINKS - -[Update-AzureRmVmss](./Update-AzureRmVmss.md) - - diff --git a/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmVmssVM.md b/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmVmssVM.md deleted file mode 100644 index 6937e257a3..0000000000 --- a/azurermps-6.13.0/AzureRM.Compute/Update-AzureRmVmssVM.md +++ /dev/null @@ -1,241 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/update-azurermvmssvm -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Update-AzureRmVmssVM.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Compute/Commands.Compute/help/Update-AzureRmVmssVM.md ---- - -# Update-AzureRmVmssVM - -## SYNOPSIS -Updates the state of a Vmss VM. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameter (Default) -``` -Update-AzureRmVmssVM [-ResourceGroupName] <String> [-VMScaleSetName] <String> [-InstanceId] <String> - [-DataDisk <PSVirtualMachineDataDisk[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameter -``` -Update-AzureRmVmssVM [-DataDisk <PSVirtualMachineDataDisk[]>] [-ResourceId] <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ObjectParameter -``` -Update-AzureRmVmssVM [-DataDisk <PSVirtualMachineDataDisk[]>] - [-VirtualMachineScaleSetVM] <PSVirtualMachineScaleSetVM> [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Updates the state of a Vmss VM. For now, the only allowed update is adding a managed data disk. - -## EXAMPLES - -### Example 1: Add a managed data disk to a Vmss VM using New-AzureRmVMDataDisk -``` -PS C:\> $disk = Get-AzureRmDisk -ResourceGroupName $rgname -DiskName $diskname0 -PS C:\> $datadisk = New-AzureRmVMDataDisk -Caching 'ReadOnly' -Lun 2 -CreateOption Attach -StorageAccountType Standard_LRS -ManagedDiskId $disk.Id -PS C:\> $VmssVM = Get-AzureRmVmssVM -ResourceGroupName "myrg" -VMScaleSetName "myvmss" -InstanceId 0 -PS C:\> Update-AzureRmVmssVM -ResourceGroupName "myrg" -VMScaleSetName "myvmss" -InstanceId 0 -DataDisk $datadisk -``` - -The first command gets an existing managed disk. -The next command creates a data disk object with the managed disk. -The next command gets an existing Vmss VM given by the resource group name, the vmss name and the instance ID. -The final command updates the Vmss VM by adding a new data disk. - -### Example 2: Add a managed data disk to a Vmss VM using Add-AzureRmVMDataDisk -``` -PS C:\> $disk = Get-AzureRmDisk -ResourceGroupName $rgname -DiskName $diskname0 -PS C:\> $VmssVM = Get-AzureRmVmssVM -ResourceGroupName "myrg" -VMScaleSetName "myvmss" -InstanceId 0 -PS C:\> $VmssVM = Add-AzureRmVMDataDisk -VirtualMachineScaleSetVM $VmssVM -Lun 0 -DiskSizeInGB 10 -CreateOption Attach -StorageAccountType Standard_LRS -ManagedDiskId $disk.Id -PS C:\> Update-AzureRmVmssVM -VirtualMachineScaleSetVM $VmssVM -``` - -The first command gets an existing managed disk. -The next command gets an existing Vmss VM given by the resource group name, the vmss name and the instance ID. -The next command adds the managed disk to the Vmss VM stored locally in $VmssVM. -The final command updates the Vmss VM with added data disk. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataDisk - -```yaml -Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineDataDisk[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceId -Specifies the instance ID of a VMSS VM. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the Resource Group of the VMSS. - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The resource id for the virtual machine scale set VM - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameter -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSetVM -Local virtual machine scale set VM object - -```yaml -Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetVM -Parameter Sets: ObjectParameter -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMScaleSetName -The name of the virtual machine scale set - -```yaml -Type: System.String -Parameter Sets: DefaultParameter -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineDataDisk[] -Parameters: DataDisk (ByValue) - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetVM -Parameters: VirtualMachineScaleSetVM (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSetVM - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Consumption/AzureRM.Consumption.md b/azurermps-6.13.0/AzureRM.Consumption/AzureRM.Consumption.md deleted file mode 100644 index cde3b4128b..0000000000 --- a/azurermps-6.13.0/AzureRM.Consumption/AzureRM.Consumption.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -Module Name: AzureRM.Consumption -Module Guid: c1f34ce9-bf46-4180-b36c-be232a1f8f65 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.consumption -Help Version: 1.0.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Consumption/Commands.Consumption/help/AzureRM.Consumption.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Consumption/Commands.Consumption/help/AzureRM.Consumption.md ---- - -# AzureRM.Consumption Module -## Description -The topics in this section document the Azure PowerShell cmdlets for Azure Consumption in the Azure Resource Manager (ARM) framework. The cmdlets exist in the Microsoft.Azure.Commands.Consumption namespace. - -## AzureRM.Consumption Cmdlets -### [Get-AzureRmConsumptionBudget](Get-AzureRmConsumptionBudget.md) -Get a list of budgets in either a subscription or a resource group. - -### [Get-AzureRmConsumptionMarketplace](Get-AzureRmConsumptionMarketplace.md) -Get marketplaces of the subscription. - -### [Get-AzureRmConsumptionPriceSheet](Get-AzureRmConsumptionPriceSheet.md) -Get price sheets of the subscription. - -### [Get-AzureRmConsumptionReservationDetail](Get-AzureRmConsumptionReservationDetail.md) -Get reservations details for provided date range. - -### [Get-AzureRmConsumptionReservationSummary](Get-AzureRmConsumptionReservationSummary.md) -Get reservation summaries for daily or monthly grain. - -### [Get-AzureRmConsumptionUsageDetail](Get-AzureRmConsumptionUsageDetail.md) -Get usage details of the subscription. - -### [New-AzureRmConsumptionBudget](New-AzureRmConsumptionBudget.md) -Create a budget in either a subscription or a resource group. - -### [Remove-AzureRmConsumptionBudget](Remove-AzureRmConsumptionBudget.md) -Remove a budget in either a subscription or a resource group. - -### [Set-AzureRmConsumptionBudget](Set-AzureRmConsumptionBudget.md) -Update a budget in either a subscription or a resource group. - diff --git a/azurermps-6.13.0/AzureRM.Consumption/Get-AzureRmConsumptionBudget.md b/azurermps-6.13.0/AzureRM.Consumption/Get-AzureRmConsumptionBudget.md deleted file mode 100644 index ddcc186ae5..0000000000 --- a/azurermps-6.13.0/AzureRM.Consumption/Get-AzureRmConsumptionBudget.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Consumption.dll-Help.xml -Module Name: AzureRM.Consumption -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.consumption/get-azurermconsumptionbudget -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Consumption/Commands.Consumption/help/Get-AzureRmConsumptionBudget.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Consumption/Commands.Consumption/help/Get-AzureRmConsumptionBudget.md ---- - -# Get-AzureRmConsumptionBudget - -## SYNOPSIS -Get a list of budgets in either a subscription or a resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmConsumptionBudget [-DefaultProfile <IAzureContextContainer>] [-ResourceGroupName <String>] - [-Name <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmConsumptionBudget cmdlet gets a list of budgets in either a subscription or a resource group. - -## EXAMPLES - -### Example 1: Get a list of budgets at subscription level -```powershell -PS C:\> Get-AzureRmConsumptionBudget -Amount: 60 -Category: Cost -CurrentSpend: null -Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Consumption/budgets/PSBudget -Name: PSBudget -TimeGrain: Monthly -TimePeriod: EndDate: 11/1/2018 12:00:00 AM - StartDate: 6/1/2018 12:00:00 AM -Type: Microsoft.Consumption/budgets -``` - -### Example 2: Get a list of budgets at resource group level -```powershell -PS C:\> Get-AzureRmConsumptionBudget -ResourceGroupName RGBudgets -Amount: 60 -Category: Cost -CurrentSpend: null -Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/resourceGroups/RGBudgets/providers/Microsoft.Consumption/budgets/PSBudgetRG -Name: PSBudgetRG -TimeGrain: Monthly -TimePeriod: EndDate: 11/1/2018 12:00:00 AM - StartDate: 6/1/2018 12:00:00 AM -Type: Microsoft.Consumption/budgets -``` - -### Example 3: Get a budget with the budget name at subscription level -```powershell -PS C:\> Get-AzureRmConsumptionBudget -Name PSBudget -Amount: 60 -Category: Cost -CurrentSpend: null -Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Consumption/budgets/PSBudget -Name: PSBudget -TimeGrain: Monthly -TimePeriod: EndDate: 11/1/2018 12:00:00 AM - StartDate: 6/1/2018 12:00:00 AM -Type: Microsoft.Consumption/budgets -``` - -### Example 4: Get a budget with the budget name at resource group level -```powershell -PS C:\> Get-AzureRmConsumptionBudget -ResourceGroupName RGBudgets -Name PSBudgetRG -Amount: 60 -Category: Cost -CurrentSpend: null -Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/resourceGroups/RGBudgets/providers/Microsoft.Consumption/budgets/PSBudgetRG -Name: PSBudgetRG -TimeGrain: Monthly -TimePeriod: EndDate: 11/1/2018 12:00:00 AM - StartDate: 6/1/2018 12:00:00 AM -Type: Microsoft.Consumption/budgets -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of a budget. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group of a budget. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Consumption.Models.PSBudget - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Consumption/Get-AzureRmConsumptionMarketplace.md b/azurermps-6.13.0/AzureRM.Consumption/Get-AzureRmConsumptionMarketplace.md deleted file mode 100644 index bc25f412fa..0000000000 --- a/azurermps-6.13.0/AzureRM.Consumption/Get-AzureRmConsumptionMarketplace.md +++ /dev/null @@ -1,245 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Consumption.dll-Help.xml -Module Name: AzureRM.Consumption -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.consumption/get-azurermconsumptionmarketplace -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Consumption/Commands.Consumption/help/Get-AzureRmConsumptionMarketplace.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Consumption/Commands.Consumption/help/Get-AzureRmConsumptionMarketplace.md ---- - -# Get-AzureRmConsumptionMarketplace - -## SYNOPSIS -Get marketplaces of the subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmConsumptionMarketplace [-BillingPeriodName <String>] [-EndDate <DateTime>] [-InstanceId <String>] - [-InstanceName <String>] [-ResourceGroup <String>] [-StartDate <DateTime>] [-Top <Int32>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmConsumptionMarketplace** cmdlet gets marketplaces of the subscription. - -## EXAMPLES - -### Example 1: Get marketplaces usage -```powershell -PS C:\> Get-AzureRmConsumptionMarketplace -Top 10 -BillingPeriodId: subscriptions/6b74c45b-9597-4939-a202-36b2ee8fbb3d/providers/Microsoft.Billing/billingPeriods/201807-1 -ConsumedQuantity: 24 -Currency: USD -Id: subscriptions/6b74c45b-9597-4939-a202-36b2ee8fbb3d/providers/Microsoft.Billing/billingPeriods/201807-1/providers/Microsoft.Consumption/marketplaces/018b7291-57a5-e194-65ea-28c3f1db76aa -InstanceId: subscriptions/6b74c45b-9597-4939-a202-36b2ee8fbb3d/resourceGroups/TESTRG1/providers/Microsoft.Compute/virtualMachines/TestVM -InstanceName: TestVM -IsEstimated: false -Name: 018b7291-57a5-e194-65ea-28c3f1db76aa -OfferName: 2b380487-dc18-4e5d-981f-1ee2cc59e776 -PretaxCost: 0 -ResourceRate: 0 -SubscriptionGuid: 6b74c45b-9597-4939-a202-36b2ee8fbb3d -Type: Microsoft.Consumption/usageDetails -UsageEnd: 2018-04-29T00:00:00Z -UsageStart: 2018-04-28T00:00:00Z -``` - -### Example 2: Get marketplace usage with date range -```powershell -PS C:\> Get-AzureRmConsumptionMarketplace -StartDate 2018-01-03 -EndDate 2018-01-20 -Top 10 -BillingPeriodId: subscriptions/6b74c45b-9597-4939-a202-36b2ee8fbb3d/providers/Microsoft.Billing/billingPeriods/201803-1 -ConsumedQuantity: 24 -Currency: USD -Id: subscriptions/6b74c45b-9597-4939-a202-36b2ee8fbb3d/providers/Microsoft.Billing/billingPeriods/201803-1/providers/Microsoft.Consumption/marketplaces/0ec2bd1e-1cd6-0c75-3661-eaf3f635df33 -InstanceId: subscriptions/6b74c45b-9597-4939-a202-36b2ee8fbb3d/resourceGroups/TESTRG1/providers/Microsoft.Compute/virtualMachines/TestVM -InstanceName: TestVM -IsEstimated: false -Name: 0ec2bd1e-1cd6-0c75-3661-eaf3f635df33 -OfferName: 2b380487-dc18-4e5d-981f-1ee2cc59e776 -PretaxCost: 0 -ResourceRate: 0 -SubscriptionGuid: 6b74c45b-9597-4939-a202-36b2ee8fbb3d -Type: Microsoft.Consumption/usageDetails -UsageEnd: 2018-01-04T00:00:00Z -UsageStart: 2018-01-03T00:00:00Z -``` - -### Example 3: Get marketplace usage of BillingPeriodName -```powershell -PS C:\> Get-AzureRmConsumptionMarketplace -BillingPeriodName 201801-1 -Top 10 -BillingPeriodId: subscriptions/6b74c45b-9597-4939-a202-36b2ee8fbb3d/providers/Microsoft.Billing/billingPeriods/201801-1 -ConsumedQuantity: 24 -Currency: USD -Id: subscriptions/6b74c45b-9597-4939-a202-36b2ee8fbb3d/providers/Microsoft.Billing/billingPeriods/201801-1/providers/Microsoft.Consumption/marketplaces/ea82233a-9f76-7eaa-4478-42bd61cf6287 -InstanceId: subscriptions/6b74c45b-9597-4939-a202-36b2ee8fbb3d/resourceGroups/TESTRG1/providers/Microsoft.Compute/virtualMachines/TestVM -InstanceName: TestVM -IsEstimated: false -Name: ea82233a-9f76-7eaa-4478-42bd61cf6287 -OfferName: 2b380487-dc18-4e5d-981f-1ee2cc59e776 -PretaxCost: 0 -ResourceRate: 0 -SubscriptionGuid: 6b74c45b-9597-4939-a202-36b2ee8fbb3d -Type: Microsoft.Consumption/usageDetails -UsageEnd: 2017-10-29T00:00:00Z -UsageStart: 2017-10-28T00:00:00Z -``` - -### Example 4: Get marketplace usage with InstanceName filter -```powershell -PS C:\> Get-AzureRmConsumptionMarketplace -InstanceName TestVM -Top 10 -BillingPeriodId: subscriptions/6b74c45b-9597-4939-a202-36b2ee8fbb3d/providers/Microsoft.Billing/billingPeriods/201807-1 -ConsumedQuantity: 24 -Currency: USD -Id: subscriptions/6b74c45b-9597-4939-a202-36b2ee8fbb3d/providers/Microsoft.Billing/billingPeriods/201807-1/providers/Microsoft.Consumption/marketplaces/018b7291-57a5-e194-65ea-28c3f1db76aa -InstanceId: subscriptions/6b74c45b-9597-4939-a202-36b2ee8fbb3d/resourceGroups/TESTRG1/providers/Microsoft.Compute/virtualMachines/TestVM -InstanceName: TestVM -IsEstimated: false -Name: 018b7291-57a5-e194-65ea-28c3f1db76aa -OfferName: 2b380487-dc18-4e5d-981f-1ee2cc59e776 -PretaxCost: 0 -ResourceRate: 0 -SubscriptionGuid: 6b74c45b-9597-4939-a202-36b2ee8fbb3d -Type: Microsoft.Consumption/usageDetails -UsageEnd: 2018-04-29T00:00:00Z -UsageStart: 2018-04-28T00:00:00Z -``` - -## PARAMETERS - -### -BillingPeriodName -Name of a specific billing period to get the marketplace that associate with. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndDate -The end date (in UTC) of the marketplaces to filter. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceId -The instance id of the marketplaces to filter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceName -The instance name of the marketplaces to filter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroup -The resource group of the marketplaces to filter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The start date (in UTC) of the marketplaces to filter. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Top -Determine the maximum number of records to return. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Consumption.Models.PSMarketplace - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Consumption/Get-AzureRmConsumptionPriceSheet.md b/azurermps-6.13.0/AzureRM.Consumption/Get-AzureRmConsumptionPriceSheet.md deleted file mode 100644 index 652defb823..0000000000 --- a/azurermps-6.13.0/AzureRM.Consumption/Get-AzureRmConsumptionPriceSheet.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Consumption.dll-Help.xml -Module Name: AzureRM.Consumption -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.consumption/get-azurermconsumptionpricesheet -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Consumption/Commands.Consumption/help/Get-AzureRmConsumptionPriceSheet.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Consumption/Commands.Consumption/help/Get-AzureRmConsumptionPriceSheet.md ---- - -# Get-AzureRmConsumptionPriceSheet - -## SYNOPSIS -Get price sheets of the subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmConsumptionPriceSheet [-BillingPeriodName <String>] [-ExpandMeterDetail] [-Top <Int32>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmConsumptionPriceSheet** cmdlet gets price sheets of the subscription. - -## EXAMPLES - -### Example 1: Get price sheets -```powershell -PS C:\> Get-AzureRmConsumptionPriceSheet -Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Billing/billingPeriods/20180601/providers/Microsoft.Consumption/pricesheets/default -Name: default -Type: Microsoft.Consumption/pricesheets -Pricesheets: BillingPeriodId: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Billing/billingPeriods/20180601 - CurrencyCode: USD - IncludedQuantity: 0 - MeterId: BACDDD36-2C2C-46BB-8CFA-D13C15EE4A7E - PartNumber: AAA-49135 - UnitOfMeasure: 10 Hours - UnitPrice: 1.33 -``` - -### Example 2: Get price sheets with expand of MeterDetails -```powershell -PS C:\> Get-AzureRmConsumptionPriceSheet -ExpandMeterDetail -Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Billing/billingPeriods/20180601/providers/Microsoft.Consumption/pricesheets/default -Name: default -Type: Microsoft.Consumption/pricesheets -Pricesheets: BillingPeriodId: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Billing/billingPeriods/20180601 - CurrencyCode: USD - IncludedQuantity: 0 - MeterDetails: MeterCategory: Virtual Machines - MeterLocation: US North Central - MeterName: Compute Hours - MeterSubCategory: Standard_D11_v2 VM_Promo (Windows) - Unit: Hours - MeterId: BACDDD36-2C2C-46BB-8CFA-D13C15EE4A7E - PartNumber: AAA-49135 - UnitOfMeasure: 10 Hours - UnitPrice: 1.33 -``` - -### Example 3: Get price sheets of BillingPeriodName -```powershell -PS C:\> Get-AzureRmConsumptionPriceSheet -BillingPeriodName 201712 -Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Billing/billingPeriods/20180601/providers/Microsoft.Consumption/pricesheets/default -Name: default -Type: Microsoft.Consumption/pricesheets -Pricesheets: BillingPeriodId: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Billing/billingPeriods/20180601 - CurrencyCode: USD - IncludedQuantity: 0 - MeterId: 46367D67-1E4C-4ED4-8267-4477083F581C - PartNumber: AAA-53590 - UnitOfMeasure: 10 Hours - UnitPrice: 1.37 -``` - -### Example 4: Get top 5 records of price sheets -```powershell -PS C:\> Get-AzureRmConsumptionPriceSheet -Top 5 -Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Billing/billingPeriods/20180601/providers/Microsoft.Consumption/pricesheets/default -Name: default -Type: Microsoft.Consumption/pricesheets -Pricesheets: BillingPeriodId: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Billing/billingPeriods/20180601 - CurrencyCode: USD - IncludedQuantity: 0 - MeterId: BACDDD36-2C2C-46BB-8CFA-D13C15EE4A7E - PartNumber: AAA-49135 - UnitOfMeasure: 10 Hours - UnitPrice: 1.33 -``` - -## PARAMETERS - -### -BillingPeriodName -Name of a specific billing period to get the price sheets that associate with. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpandMeterDetail -Expand the price sheets based on MeterDetails. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Top -Determine the maximum number of records to return. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Consumption.Models.PSPriceSheet - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Consumption/Get-AzureRmConsumptionReservationDetail.md b/azurermps-6.13.0/AzureRM.Consumption/Get-AzureRmConsumptionReservationDetail.md deleted file mode 100644 index 779e2e600e..0000000000 --- a/azurermps-6.13.0/AzureRM.Consumption/Get-AzureRmConsumptionReservationDetail.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Consumption.dll-Help.xml -Module Name: AzureRM.Consumption -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.consumption/get-azurermconsumptionreservationdetail -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Consumption/Commands.Consumption/help/Get-AzureRmConsumptionReservationDetail.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Consumption/Commands.Consumption/help/Get-AzureRmConsumptionReservationDetail.md ---- - -# Get-AzureRmConsumptionReservationDetail - -## SYNOPSIS -Get reservations details for provided date range. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmConsumptionReservationDetail -StartDate <DateTime> -EndDate <DateTime> -ReservationOrderId <String> - [-ReservationId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmConsumptionReservationDetail** cmdlet gets reservations details for provided date range. - -## EXAMPLES - -### Example 1: Get reservation details with reservation order Id for provided date range -```powershell -PS C:\> Get-AzureRmConsumptionReservationDetail -ReservationOrderId ca69259e-bd4f-45c3-bf28-3f353f9cce9b -StartDate 2017-10-01 -EndDate 2017-12-07 -Id: providers/Microsoft.Capacity/reservationOrders/ca69259e-bd4f-45c3-bf28-3f353f9cce9b/reservations/f37f4b70-52ba-4344-a8bd-28abfd21d640providers/Microsoft.Consumption/reservationDetails/20171007 -InstanceId: subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/testrg/providers/microsoft.compute/virtualmachines/std2swindows -Name: ca69259e-bd4f-45c3-bf28-3f353f9cce9b_f37f4b70-52ba-4344-a8bd-28abfd21d640_20171007 -ReservationId: f37f4b70-52ba-4344-a8bd-28abfd21d640 -ReservationOrderId: ca69259e-bd4f-45c3-bf28-3f353f9cce9b -ReservedHour: 24 -SkuName: Standard_DS2_v2 -TotalReservedQuantity: 1 -Type: Microsoft.Consumption/reservationDetails -UsageDate: 10/7/2017 12:00:00 AM -UsedHour: 24 -``` - -### Example 2: Get reservation details with reservation order Id and reservation Id for provided date range -```powershell -PS C:\> Get-AzureRmConsumptionReservationDetail -ReservationOrderId ca69259e-bd4f-45c3-bf28-3f353f9cce9b -ReservationId f37f4b70-52ba-4344-a8bd-28abfd21d640 -StartDate 2017-10-01 -EndDate 2017-12-07 -Id: providers/Microsoft.Capacity/reservationOrders/ca69259e-bd4f-45c3-bf28-3f353f9cce9b/reservations/f37f4b70-52ba-4344-a8bd-28abfd21d640providers/Microsoft.Consumption/reservationDetails/20171007 -InstanceId: subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/testrg/providers/microsoft.compute/virtualmachines/std2swindows -Name: ca69259e-bd4f-45c3-bf28-3f353f9cce9b_f37f4b70-52ba-4344-a8bd-28abfd21d640_20171007 -ReservationId: f37f4b70-52ba-4344-a8bd-28abfd21d640 -ReservationOrderId: ca69259e-bd4f-45c3-bf28-3f353f9cce9b -ReservedHour: 24 -SkuName: Standard_DS2_v2 -TotalReservedQuantity: 1 -Type: Microsoft.Consumption/reservationDetails -UsageDate: 10/7/2017 12:00:00 AM -UsedHour: 24 -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndDate -The end data (YYYY-MM-DD in UTC) of the reservation detail. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReservationId -The identifier of a reservation within a reservation order. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReservationOrderId -The identifier of a reservation purchase. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The start data (YYYY-MM-DD in UTC) of the reservation detail. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Consumption.Models.PSReservationDetail - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Consumption/Get-AzureRmConsumptionReservationSummary.md b/azurermps-6.13.0/AzureRM.Consumption/Get-AzureRmConsumptionReservationSummary.md deleted file mode 100644 index 432080ce52..0000000000 --- a/azurermps-6.13.0/AzureRM.Consumption/Get-AzureRmConsumptionReservationSummary.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Consumption.dll-Help.xml -Module Name: AzureRM.Consumption -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.consumption/get-azurermconsumptionreservationsummary -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Consumption/Commands.Consumption/help/Get-AzureRmConsumptionReservationSummary.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Consumption/Commands.Consumption/help/Get-AzureRmConsumptionReservationSummary.md ---- - -# Get-AzureRmConsumptionReservationSummary - -## SYNOPSIS -Get reservation summaries for daily or monthly grain. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmConsumptionReservationSummary -Grain <String> -ReservationOrderId <String> [-ReservationId <String>] - [-StartDate <DateTime>] [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmConsumptionReservationSummay** cmdlet gets reservation summaries for daily or monthly grain. - -## EXAMPLES - -### Example 1: Get reservation summaries with reservation order Id for monthly grain -```powershell -PS C:\> Get-AzureRmConsumptionReservationSummary -Grain monthly -ReservationOrderId ca69259e-bd4f-45c3-bf28-3f353f9cce9b -AvgUtilizationPercentage: 100 -Id: providers/Microsoft.Capacity/reservationOrders/ca69259e-bd4f-45c3-bf28-3f353f9cce9b/reservations/f37f4b70-52ba-4344-a8bd-28abfd21d640/providers/Microsoft.Consumption/reservationSummaries/20170901 -MaxUtilizationPercentage: 100 -MinUtilizationPercentage: 100 -Name: ca69259e-bd4f-45c3-bf28-3f353f9cce9b_f37f4b70-52ba-4344-a8bd-28abfd21d640_20170901 -ReservationId: f37f4b70-52ba-4344-a8bd-28abfd21d640 -ReservationOrderId: ca69259e-bd4f-45c3-bf28-3f353f9cce9b -ReservedHour: 288 -SkuName: Standard_DS2_v2 -Type: Microsoft.Consumption/reservationSummaries -UsageDate: 9/1/2017 12:00:00 AM -UsedHour: 288 -``` - -### Example 2: Get reservation summaries with reservation order Id and reservation Id for monthly grain -```powershell -PS C:\> Get-AzureRmConsumptionReservationSummary -Grain monthly -ReservationOrderId ca69259e-bd4f-45c3-bf28-3f353f9cce9b -ReservationId f37f4b70-52ba-4344-a8bd-28abfd21d640 -AvgUtilizationPercentage: 100 -Id: providers/Microsoft.Capacity/reservationOrders/ca69259e-bd4f-45c3-bf28-3f353f9cce9b/reservations/f37f4b70-52ba-4344-a8bd-28abfd21d640/providers/Microsoft.Consumption/reservationSummaries/20170901 -MaxUtilizationPercentage: 100 -MinUtilizationPercentage: 100 -Name: ca69259e-bd4f-45c3-bf28-3f353f9cce9b_f37f4b70-52ba-4344-a8bd-28abfd21d640_20170901 -ReservationId: f37f4b70-52ba-4344-a8bd-28abfd21d640 -ReservationOrderId: ca69259e-bd4f-45c3-bf28-3f353f9cce9b -ReservedHour: 288 -SkuName: Standard_DS2_v2 -Type: Microsoft.Consumption/reservationSummaries -UsageDate: 9/1/2017 12:00:00 AM -UsedHour: 288 -``` - -### Example 3: Get reservation summaries with reservation order Id for daily grain provided date range -```powershell -PS C:\> Get-AzureRmConsumptionReservationSummary -Grain daily -ReservationOrderId ca69259e-bd4f-45c3-bf28-3f353f9cce9b -StartDate 2017-10-01 -EndDate 2017-12-07 -AvgUtilizationPercentage: 100 -Id: providers/Microsoft.Capacity/reservationOrders/ca69259e-bd4f-45c3-bf28-3f353f9cce9b/reservations/f37f4b70-52ba-4344-a8bd-28abfd21d640/providers/Microsoft.Consumption/reservationSummaries/20171101 -MaxUtilizationPercentage: 100 -MinUtilizationPercentage: 100 -Name: ca69259e-bd4f-45c3-bf28-3f353f9cce9b_f37f4b70-52ba-4344-a8bd-28abfd21d640_20171101 -ReservationId: f37f4b70-52ba-4344-a8bd-28abfd21d640 -ReservationOrderId: ca69259e-bd4f-45c3-bf28-3f353f9cce9b -ReservedHour: 24 -SkuName: Standard_DS2_v2 -Type: Microsoft.Consumption/reservationSummaries -UsageDate: 11/1/2017 12:00:00 AM -UsedHour: 24 -``` - -### Example 4: Get reservation summaries with reservation order Id and reservation Id for daily grain provided date range -```powershell -PS C:\> Get-AzureRmConsumptionReservationSummary -Grain daily -ReservationOrderId ca69259e-bd4f-45c3-bf28-3f353f9cce9b -ReservationId f37f4b70-52ba-4344-a8bd-28abfd21d640 -StartDate 2017-10-01 -EndDate 2017-12-07 -AvgUtilizationPercentage: 100 -Id: providers/Microsoft.Capacity/reservationOrders/ca69259e-bd4f-45c3-bf28-3f353f9cce9b/reservations/f37f4b70-52ba-4344-a8bd-28abfd21d640/providers/Microsoft.Consumption/reservationSummaries/20171101 -MaxUtilizationPercentage: 100 -MinUtilizationPercentage: 100 -Name: ca69259e-bd4f-45c3-bf28-3f353f9cce9b_f37f4b70-52ba-4344-a8bd-28abfd21d640_20171101 -ReservationId: f37f4b70-52ba-4344-a8bd-28abfd21d640 -ReservationOrderId: ca69259e-bd4f-45c3-bf28-3f353f9cce9b -ReservedHour: 24 -SkuName: Standard_DS2_v2 -Type: Microsoft.Consumption/reservationSummaries -UsageDate: 11/1/2017 12:00:00 AM -UsedHour: 24 -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndDate -The end data (YYYY-MM-DD in UTC) of the reservation summary, required only for daily grain. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Grain -The time grain of the reservation summaryy, can be daily or monthly. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: daily, monthly - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReservationId -The identifier of a reservation within a reservation order. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReservationOrderId -The identifier of a reservation purchase. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The start data (YYYY-MM-DD in UTC) of the reservation summary, required only for daily grain. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Consumption.Models.PSReservationSummary - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Consumption/Get-AzureRmConsumptionUsageDetail.md b/azurermps-6.13.0/AzureRM.Consumption/Get-AzureRmConsumptionUsageDetail.md deleted file mode 100644 index 78997e714c..0000000000 --- a/azurermps-6.13.0/AzureRM.Consumption/Get-AzureRmConsumptionUsageDetail.md +++ /dev/null @@ -1,339 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Consumption.dll-Help.xml -Module Name: AzureRM.Consumption -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.consumption/get-azurermconsumptionusagedetail -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Consumption/Commands.Consumption/help/Get-AzureRmConsumptionUsageDetail.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Consumption/Commands.Consumption/help/Get-AzureRmConsumptionUsageDetail.md ---- - -# Get-AzureRmConsumptionUsageDetail - -## SYNOPSIS -Get usage details of the subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmConsumptionUsageDetail [-BillingPeriodName <String>] [-Expand <String>] [-IncludeMeterDetails] - [-IncludeAdditionalProperties] [-StartDate <DateTime>] [-EndDate <DateTime>] [-ResourceGroup <String>] - [-InstanceName <String>] [-InstanceId <String>] [-Tag <String>] [-MaxCount <Int32>] [-Top <Int32>] - [-InvoiceName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmConsumptionUsageDetail** cmdlet gets usage details of the subscription. - -## EXAMPLES - -### Example 1: Get usage details with expand of MeterDetails -```powershell -PS C:\> Get-AzureRmConsumptionUsageDetail -Expand MeterDetails -Top 10 -AccountName: AAAA -BillingPeriodId: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Billing/billingPeriods/20180601 -ConsumedService: Microsoft.Compute -CostCenter: XYZ987 -Currency: USD -DepartmentName: Ama -Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Billing/billingPeriods/20180601/providers/Microsoft.Consumption/usageDetails/24b9dff0-f022-55a1-886b-17b330000db3 -InstanceId: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/resourceGroups/MAR-CCM/providers/Microsoft.Compute/disks/mar-ccm-vm01_OsDisk_1_d0beead4b6ff4b4088a687701d355d61 -InstanceLocation: usnorthcentral -InstanceName: mar-ccm-vm01_OsDisk_1_d0beead4b6ff4b4088a687701d355d61 -IsEstimated: true -MeterDetails: MeterCategory: Data Management - MeterLocation: usnorthcentral - MeterName: Standard Managed Disk Operations (in 10,000s) - MeterSubCategory: Data Management - Unit: Operations -MeterId: 82cd70ab-1aee-4b30-bc04-8b71e1204dbc -Name: 24b9dff0-f022-55a1-886b-17b330000db3 -PretaxCost: 0 -Product: Data Management Standard Managed Disk Operations -SubscriptionGuid: 1caaa5a3-2b66-438e-8ab4-bce37d518c5d -SubscriptionName: CCM - Microsoft Azure Enterprise - 1 -Type: Microsoft.Consumption/usageDetails -UsageEnd: 6/1/2018 11:59:59 PM -UsageQuantity: 3.8218 -UsageStart: 6/1/2018 12:00:00 AM -``` - -### Example 2: Get usage details with date range -```powershell -PS C:\> Get-AzureRmConsumptionUsageDetail -StartDate 2017-10-02 -EndDate 2017-10-05 -Top 10 -AccountName: AAAA -BillingPeriodId: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Billing/billingPeriods/20171001 -ConsumedService: Storage -CostCenter: XYZ987 -Currency: USD -DepartmentName: Ama -Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Billing/billingPeriods/20171001/providers/Microsoft.Consumption/usageDetails/732582e5-40ad-bb23-7a69-ca1ff7c8b004 -InstanceId: storsimplezc9q6r2t7f -InstanceLocation: US West Central -InstanceName: storsimplezc9q6r2t7f -IsEstimated: false -MeterId: ad22fac8-9da5-4577-8683-56ae94d39e42 -Name: 732582e5-40ad-bb23-7a69-ca1ff7c8b004 -PretaxCost: 0 -Product: Data Management Geo Redundant Standard IO - Table Write -SubscriptionGuid: 1caaa5a3-2b66-438e-8ab4-bce37d518c5d -SubscriptionName: CCM - Microsoft Azure Enterprise - 1 -Type: Microsoft.Consumption/usageDetails -UsageEnd: 10/2/2017 11:59:59 PM -UsageQuantity: 0.0006 -UsageStart: 10/2/2017 12:00:00 AM -``` - -### Example 3: Get usage details of BillingPeriodName with InstanceName filter -```powershell -PS C:\> Get-AzureRmConsumptionUsageDetail -BillingPeriodName 201710 -InstanceName 1c2052westus -Top 10 -AccountName: AAAA -BillingPeriodId: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Billing/billingPeriods/20171001 -ConsumedService: Microsoft.Storage -CostCenter: XYZ987 -Currency: USD -DepartmentName: Ama -Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Billing/billingPeriods/20171001/providers/Microsoft.Consumption/usageDetails/8abc8b65-e8f1-31e1-f02b-058a7572363f -InstanceId: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/resourceGroups/securitydata/providers/Microsoft.Storage/storageAccounts/1c2052westus -InstanceLocation: uswest -InstanceName: 1c2052westus -IsEstimated: false -MeterId: 9995d93a-7d35-4d3f-9c69-7a7fea447ef4 -Name: 8abc8b65-e8f1-31e1-f02b-058a7572363f -PretaxCost: 0.000000693016692 -Product: Data Transfer Out - Zone 1 -SubscriptionGuid: 1caaa5a3-2b66-438e-8ab4-bce37d518c5d -SubscriptionName: CCM - Microsoft Azure Enterprise - 1 -Type: Microsoft.Consumption/usageDetails -UsageEnd: 10/1/2017 11:59:59 PM -UsageQuantity: 0.000009 -UsageStart: 10/1/2017 12:00:00 AM -``` - -## PARAMETERS - -### -BillingPeriodName -Name of a specific billing period to get the usage details that associate with. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndDate -The end date (in UTC) of the usages to filter. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expand -Expand the usages based on MeterDetails, or AdditionalInfo. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeAdditionalProperties -Include additional properties in the usages. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeMeterDetails -Include meter details in the usages. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceId -The instance id of the usages to filter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceName -The instance name of the usages to filter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InvoiceName -Name of a specific invoice to get the usage details that associate with. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxCount -Determine the maximum number of records to return. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroup -The resource group of the usages to filter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The start date (in UTC) of the usages to filter. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -The tag of the usages to filter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Top -Determine the maximum number of records to return. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Consumption.Models.PSUsageDetail - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Consumption/New-AzureRmConsumptionBudget.md b/azurermps-6.13.0/AzureRM.Consumption/New-AzureRmConsumptionBudget.md deleted file mode 100644 index 4ab92d6157..0000000000 --- a/azurermps-6.13.0/AzureRM.Consumption/New-AzureRmConsumptionBudget.md +++ /dev/null @@ -1,381 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Consumption.dll-Help.xml -Module Name: AzureRM.Consumption -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.consumption/new-azurermconsumptionbudget -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Consumption/Commands.Consumption/help/New-AzureRmConsumptionBudget.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Consumption/Commands.Consumption/help/New-AzureRmConsumptionBudget.md ---- - -# New-AzureRmConsumptionBudget - -## SYNOPSIS -Create a budget in either a subscription or a resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Subscription (Default) -``` -New-AzureRmConsumptionBudget [-DefaultProfile <IAzureContextContainer>] -Name <String> -Amount <Decimal> - -Category <String> -TimeGrain <String> -StartDate <DateTime> [-EndDate <DateTime>] - [-ResourceGroupName <String>] [-MeterFilter <String[]>] [-ResourceFilter <String[]>] - [-ResourceGroupFilter <String[]>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Notification -``` -New-AzureRmConsumptionBudget [-DefaultProfile <IAzureContextContainer>] -Name <String> -Amount <Decimal> - -Category <String> -TimeGrain <String> -StartDate <DateTime> [-EndDate <DateTime>] - [-ResourceGroupName <String>] [-MeterFilter <String[]>] [-ResourceFilter <String[]>] - [-ResourceGroupFilter <String[]>] -NotificationKey <String> [-NotificationEnabled] - -NotificationThreshold <Decimal> -ContactEmail <String[]> [-ContactGroup <String[]>] [-ContactRole <String[]>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmConsumptionBudget cmdlet creates a budget in either a subscription or a resource group. - -## EXAMPLES - -### Example 1: Create a cost budget with a budget name at subscription level -```powershell -PS C:\> New-AzureRmConsumptionBudget -Amount 60 -Name PSBudget -Category Cost -StartDate 2018-06-01 -EndDate 2018-11-01 -TimeGrain Monthly -Amount: 60 -Category: Cost -CurrentSpend: null -Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Consumption/budgets/PSBudget -Name: PSBudget -TimeGrain: Monthly -TimePeriod: EndDate: 11/1/2018 12:00:00 AM - StartDate: 6/1/2018 12:00:00 AM -Type: Microsoft.Consumption/budgets -``` - -### Example 2: Create a cost budget with a budget name at resource group level -```powershell -PS C:\> New-AzureRmConsumptionBudget -ResourceGroupName RGBudgets -Amount 60 -Name PSBudgetRG -Category Cost -StartDate 2018-06-01 -EndDate 2018-11-01 -TimeGrain Monthly -Amount: 60 -Category: Cost -CurrentSpend: null -Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/resourceGroups/RGBudgets/providers/Microsoft.Consumption/budgets/PSBudgetRG -Name: PSBudgetRG -TimeGrain: Monthly -TimePeriod: EndDate: 11/1/2018 12:00:00 AM - StartDate: 6/1/2018 12:00:00 AM -Type: Microsoft.Consumption/budgets -``` - -## PARAMETERS - -### -Amount -Amount of a budget. - -```yaml -Type: System.Decimal -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Category -Category of the budget can be cost or usage. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Cost, Usage - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContactEmail -Email addresses to send the budget notification to when the threshold is exceeded. - -```yaml -Type: System.String[] -Parameter Sets: Notification -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContactGroup -Action groups to send the budget notification to when the threshold is exceeded. - -```yaml -Type: System.String[] -Parameter Sets: Notification -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContactRole -Contact roles to send the budget notification to when the threshold is exceeded. - -```yaml -Type: System.String[] -Parameter Sets: Notification -Aliases: -Accepted values: Owner, Reader, Contributor - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndDate -End date (YYYY-MM-DD in UTC) of time period of a budget. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MeterFilter -Comma-separated list of meters to filter on. -Required if category is usage. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of a budget. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotificationEnabled -The notification is enabled or not. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Notification -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotificationKey -Key of a notification associated with a budget, required to create a notification with notification enabled switch, notification threshold, contact emails, contact groups, or contact roles. - -```yaml -Type: System.String -Parameter Sets: Notification -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotificationThreshold -Threshold value associated with a notification. -Notification is sent when the cost or usage exceeded the threshold. -It is always percent and has to be between 0 and 1000. - -```yaml -Type: System.Nullable`1[System.Decimal] -Parameter Sets: Notification -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceFilter -Comma-separated list of resource instances to filter on. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupFilter -Comma-separated list of resource groups to filter on. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group of a budget. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -Start date (YYYY-MM-DD in UTC) of time period of a budget. -Not prior to current month for monthly time grain. -Not prior to three months for quarterly time grain. -Not prior to twelve months for yearly time grain. -Future start date not more than three months. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeGrain -Time grain of the budget can be monthly, quarterly, or annually. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Monthly, Quarterly, Annually - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Consumption.Models.PSBudget - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Consumption/Remove-AzureRmConsumptionBudget.md b/azurermps-6.13.0/AzureRM.Consumption/Remove-AzureRmConsumptionBudget.md deleted file mode 100644 index 964cc1aebe..0000000000 --- a/azurermps-6.13.0/AzureRM.Consumption/Remove-AzureRmConsumptionBudget.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Consumption.dll-Help.xml -Module Name: AzureRM.Consumption -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.consumption/remove-azurermconsumptionbudget -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Consumption/Commands.Consumption/help/Remove-AzureRmConsumptionBudget.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Consumption/Commands.Consumption/help/Remove-AzureRmConsumptionBudget.md ---- - -# Remove-AzureRmConsumptionBudget - -## SYNOPSIS -Remove a budget in either a subscription or a resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Subscription (Default) -``` -Remove-AzureRmConsumptionBudget [-DefaultProfile <IAzureContextContainer>] -Name <String> - [-ResourceGroupName <String>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Piping -``` -Remove-AzureRmConsumptionBudget [-DefaultProfile <IAzureContextContainer>] -InputObject <PSBudget> [-PassThru] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmConsumptionBudget cmdlet removes a budget in either a subscription or a resource group. - -## EXAMPLES - -### Example 1: Remove a budget with a budget name at subscription level -```powershell -PS C:\> Remove-AzureRmConsumptionBudget -Name PSBudget -PassThru -True -``` - -### Example 2: Remove a budget with a budget name at resource group level -```powershell -PS C:\> Remove-AzureRmConsumptionBudget -ResourceGroupName RGBudgets -Name PSBudgetRG -PassThru -True -``` - -### Example 3: Remove a budget through piping at subscription level -```powershell -PS C:\> Get-AzureRmConsumptionBudget -Name PSBudget | Remove-AzureRmConsumptionBudget -PassThru -True -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Budget object. - -```yaml -Type: Microsoft.Azure.Commands.Consumption.Models.PSBudget -Parameter Sets: Piping -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of a budget. - -```yaml -Type: System.String -Parameter Sets: Subscription -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -The Cmdlet returns true if a budget was successfully removed. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group of a budget. - -```yaml -Type: System.String -Parameter Sets: Subscription -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Consumption.Models.PSBudget -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Consumption/Set-AzureRmConsumptionBudget.md b/azurermps-6.13.0/AzureRM.Consumption/Set-AzureRmConsumptionBudget.md deleted file mode 100644 index 607166e752..0000000000 --- a/azurermps-6.13.0/AzureRM.Consumption/Set-AzureRmConsumptionBudget.md +++ /dev/null @@ -1,434 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Consumption.dll-Help.xml -Module Name: AzureRM.Consumption -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.consumption/set-azurermconsumptionbudget -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Consumption/Commands.Consumption/help/Set-AzureRmConsumptionBudget.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Consumption/Commands.Consumption/help/Set-AzureRmConsumptionBudget.md ---- - -# Set-AzureRmConsumptionBudget - -## SYNOPSIS -Update a budget in either a subscription or a resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Subscription (Default) -``` -Set-AzureRmConsumptionBudget [-DefaultProfile <IAzureContextContainer>] -Name <String> [-Amount <Decimal>] - [-Category <String>] [-TimeGrain <String>] [-StartDate <DateTime>] [-EndDate <DateTime>] - [-ResourceGroupName <String>] [-MeterFilter <String[]>] [-ResourceFilter <String[]>] - [-ResourceGroupFilter <String[]>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Notification -``` -Set-AzureRmConsumptionBudget [-DefaultProfile <IAzureContextContainer>] -Name <String> [-Amount <Decimal>] - [-Category <String>] [-TimeGrain <String>] [-StartDate <DateTime>] [-EndDate <DateTime>] - [-ResourceGroupName <String>] [-MeterFilter <String[]>] [-ResourceFilter <String[]>] - [-ResourceGroupFilter <String[]>] -NotificationKey <String> [-NotificationEnabled] - [-NotificationThreshold <Decimal>] [-ContactEmail <String[]>] [-ContactGroup <String[]>] - [-ContactRole <String[]>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Piping -``` -Set-AzureRmConsumptionBudget [-DefaultProfile <IAzureContextContainer>] -InputObject <PSBudget> - [-Amount <Decimal>] [-Category <String>] [-TimeGrain <String>] [-StartDate <DateTime>] [-EndDate <DateTime>] - [-MeterFilter <String[]>] [-ResourceFilter <String[]>] [-ResourceGroupFilter <String[]>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### Piping and Notification -``` -Set-AzureRmConsumptionBudget [-DefaultProfile <IAzureContextContainer>] -InputObject <PSBudget> - [-Amount <Decimal>] [-Category <String>] [-TimeGrain <String>] [-StartDate <DateTime>] [-EndDate <DateTime>] - [-MeterFilter <String[]>] [-ResourceFilter <String[]>] [-ResourceGroupFilter <String[]>] - -NotificationKey <String> [-NotificationEnabled] [-NotificationThreshold <Decimal>] [-ContactEmail <String[]>] - [-ContactGroup <String[]>] [-ContactRole <String[]>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Set-AzureRmConsumptionBudget cmdlet updates a budget in either a subscription or a resource group. - -## EXAMPLES - -### Example 1: Update a budget by a new amount with a budget name at subscription level -```powershell -PS C:\> Set-AzureRmConsumptionBudget -Name PSBudget -Amount 75 -Amount: 75 -Category: Cost -CurrentSpend: null -Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Consumption/budgets/PSBudget -Name: PSBudget -TimeGrain: Monthly -TimePeriod: EndDate: 11/1/2018 12:00:00 AM - StartDate: 6/1/2018 12:00:00 AM -Type: Microsoft.Consumption/budgets -``` - -### Example 2: Update a budget with a notification when cost or usage reaches a threshold of 90 percent of amount at subscription level -```powershell -PS C:\> Set-AzureRmConsumptionBudget -Name PSBudget -NotificationKey notificationKey-ps1234 -NotificationEnabled -NotificationThreshold 90 -ContactEmail johndoe@contoso.com,janesmith@contoso.com -ContactRole Owner,Reader,Contributor -Amount: 75 -Category: Cost -CurrentSpend: null -Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Consumption/budgets/PSBudget -Name: PSBudget -Notification: NotificationKey: notificationKey-ps1234 - Threshold: 90 - Enabled: true - ContactEmail: johndoe@contoso.com,janesmith@contoso.com - ContactRole: Owner,Reader,Contributor -TimeGrain: Monthly -TimePeriod: EndDate: 11/1/2018 12:00:00 AM - StartDate: 6/1/2018 12:00:00 AM -Type: Microsoft.Consumption/budgets -``` - -### Example 3: Update a budget by a new amount with a budget name at resource group level -```powershell -PS C:\> Set-AzureRmConsumptionBudget -ResourceGroupName RGBudgets -Name PSBudgetRG -Amount 75 -Amount: 75 -Category: Cost -CurrentSpend: null -Id: subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/resourceGroups/RGBudgets/providers/Microsoft.Consumption/budgets/PSBudgetRG -Name: PSBudgetRG -TimeGrain: Monthly -TimePeriod: EndDate: 11/1/2018 12:00:00 AM - StartDate: 6/1/2018 12:00:00 AM -Type: Microsoft.Consumption/budgets -``` - -## PARAMETERS - -### -Amount -Amount of a budget. - -```yaml -Type: System.Nullable`1[System.Decimal] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Category -Category of the budget can be cost or usage. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Cost, Usage - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContactEmail -Email addresses to send the budget notification to when the threshold is exceeded. - -```yaml -Type: System.String[] -Parameter Sets: Notification, Piping and Notification -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContactGroup -Action groups to send the budget notification to when the threshold is exceeded. - -```yaml -Type: System.String[] -Parameter Sets: Notification, Piping and Notification -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContactRole -Contact roles to send the budget notification to when the threshold is exceeded. - -```yaml -Type: System.String[] -Parameter Sets: Notification, Piping and Notification -Aliases: -Accepted values: Owner, Reader, Contributor - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndDate -End date (YYYY-MM-DD in UTC) of time period of a budget. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Budget object. - -```yaml -Type: Microsoft.Azure.Commands.Consumption.Models.PSBudget -Parameter Sets: Piping, Piping and Notification -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -MeterFilter -Comma-separated list of meters to filter on. -Required if category is usage. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of a budget. - -```yaml -Type: System.String -Parameter Sets: Subscription, Notification -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotificationEnabled -The notification is enabled. -If not specified, the notification is disabled by default. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Notification, Piping and Notification -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotificationKey -Key of a notification associated with a budget, required to create a notification with notification enabled switch, notification threshold, contact emails, contact groups, or contact roles. - -```yaml -Type: System.String -Parameter Sets: Notification, Piping and Notification -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotificationThreshold -Threshold value associated with a notification. -Notification is sent when the cost or usage exceeded the threshold. -It is always percent and has to be between 0 and 1000. - -```yaml -Type: System.Nullable`1[System.Decimal] -Parameter Sets: Notification, Piping and Notification -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceFilter -Comma-separated list of resource instances to filter on. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupFilter -Comma-separated list of resource groups to filter on. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group of a budget. - -```yaml -Type: System.String -Parameter Sets: Subscription, Notification -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -Start date (YYYY-MM-DD in UTC) of time period of a budget. -Not prior to current month for monthly time grain. -Not prior to three months for quarterly time grain. -Not prior to twelve months for yearly time grain. -Future start date not more than three months. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeGrain -Time grain of the budget can be monthly, quarterly, or annually. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Monthly, Quarterly, Annually - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Consumption.Models.PSBudget -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Consumption.Models.PSBudget - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ContainerInstance/AzureRM.ContainerInstance.md b/azurermps-6.13.0/AzureRM.ContainerInstance/AzureRM.ContainerInstance.md deleted file mode 100644 index e60b8e13d3..0000000000 --- a/azurermps-6.13.0/AzureRM.ContainerInstance/AzureRM.ContainerInstance.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -Module Name: AzureRM.ContainerInstance -Module Guid: 99d2fc1f-ff3c-4bf3-ac22-8f81f0e5c279 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.containerinstance -Help Version: 0.2.5.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerInstance/Commands.ContainerInstance/help/AzureRM.ContainerInstance.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerInstance/Commands.ContainerInstance/help/AzureRM.ContainerInstance.md ---- - -# AzureRM.ContainerInstance Module -## Description -This topic displays help topics for the Azure Container Instance Cmdlets. - -## AzureRM.ContainerInstance Cmdlets -### [Get-AzureRmContainerGroup](Get-AzureRmContainerGroup.md) -Gets container groups. - -### [Get-AzureRmContainerInstanceLog](Get-AzureRmContainerInstanceLog.md) -Get the logs of a container instance in a container group. - -### [New-AzureRmContainerGroup](New-AzureRmContainerGroup.md) -Creates a container group. - -### [Remove-AzureRmContainerGroup](Remove-AzureRmContainerGroup.md) -Removes a container group. - diff --git a/azurermps-6.13.0/AzureRM.ContainerInstance/Get-AzureRmContainerGroup.md b/azurermps-6.13.0/AzureRM.ContainerInstance/Get-AzureRmContainerGroup.md deleted file mode 100644 index cba6cf1153..0000000000 --- a/azurermps-6.13.0/AzureRM.ContainerInstance/Get-AzureRmContainerGroup.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ContainerInstance.dll-Help.xml -Module Name: AzureRM.ContainerInstance -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.containerinstance/get-azurermcontainergroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerInstance/Commands.ContainerInstance/help/Get-AzureRmContainerGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerInstance/Commands.ContainerInstance/help/Get-AzureRmContainerGroup.md ---- - -# Get-AzureRmContainerGroup - -## SYNOPSIS -Gets container groups. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ListContainerGroupParamSet (Default) -``` -Get-AzureRmContainerGroup [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### GetContainerGroupInResourceGroupParamSet -``` -Get-AzureRmContainerGroup [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetContainerGroupByResourceIdParamSet -``` -Get-AzureRmContainerGroup -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmContainerGroup** cmdlet gets a specified container group or all the container groups in a resource group or the subscription. - -## EXAMPLES - -### Example 1: Gets a specified container group -``` -PS C:\> Get-AzureRmContainerGroup -ResourceGroupName demo -Name mycontainer - -ResourceGroupName : demo -Id : /subscriptions/ae43b1e3-c35d-4c8c-bc0d-f148b4c52b78/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/mycontainer -Name : mycontainer -Type : Microsoft.ContainerInstance/containerGroups -Location : westus -Tags : -ProvisioningState : Succeeded -Containers : {mycontainer} -ImageRegistryCredentials : -RestartPolicy : -IpAddress : 13.88.10.240 -Ports : {8000} -OsType : Linux -Volumes : -State : Running -Events : {} -``` - -The command gets the specified container group. - -### Example 2: Gets container groups in a resource group -``` -PS C:\> Get-AzureRmContainerGroup -ResourceGroupName demo - -ResourceGroupName Name Location OsType Image IP Resources ProvisioningState ------------------ ---- -------- ------ ----- -- --------- ----------------- -demo container1 west us Linux alpine:latest 40.83.144.50:8002 1 cores/1 gb Succeeded -demo container2 west us Linux alpine:latest 104.42.228.253:8001 1 cores/1 gb Succeeded -``` - -The command gets the container groups in the resource group `demo`. - -### Example 3: Gets container groups in the current subscription -``` -PS C:\> Get-AzureRmContainerGroup - -ResourceGroupName Name Location OsType Image IP Resources ProvisioningState ------------------ ---- -------- ------ ----- -- --------- ----------------- -demo1 container1 west us Linux alpine:latest 40.83.144.50:8002 1 cores/1 gb Succeeded -demo2 container2 west us Linux alpine:latest 104.42.228.253:8001 1 cores/1 gb Succeeded -``` - -The command gets the container groups in the current subscription. - -### Example 4: Gets container groups using resource Id. -``` -PS C:\> Find-AzureRmResource -ResourceGroupEquals demo -ResourceNameEquals mycontainer | Get-AzureRmContainerGroup - -ResourceGroupName : demo -Id : /subscriptions/ae43b1e3-c35d-4c8c-bc0d-f148b4c52b78/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/mycontainer -Name : mycontainer -Type : Microsoft.ContainerInstance/containerGroups -Location : westus -Tags : -ProvisioningState : Succeeded -Containers : {mycontainer} -ImageRegistryCredentials : -RestartPolicy : -IpAddress : 13.88.10.240 -Ports : {8000} -OsType : Linux -Volumes : -State : Running -Events : {} -``` - -The command gets the container group with the resource Id. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The container group Name. - -```yaml -Type: System.String -Parameter Sets: GetContainerGroupInResourceGroupParamSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource Group Name. - -```yaml -Type: System.String -Parameter Sets: ListContainerGroupParamSet -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: GetContainerGroupInResourceGroupParamSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The resource id. - -```yaml -Type: System.String -Parameter Sets: GetContainerGroupByResourceIdParamSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ContainerInstance.Models.PSContainerGroup - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ContainerInstance/Get-AzureRmContainerInstanceLog.md b/azurermps-6.13.0/AzureRM.ContainerInstance/Get-AzureRmContainerInstanceLog.md deleted file mode 100644 index 1bd43d99ce..0000000000 --- a/azurermps-6.13.0/AzureRM.ContainerInstance/Get-AzureRmContainerInstanceLog.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ContainerInstance.dll-Help.xml -Module Name: AzureRM.ContainerInstance -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.containerinstance/get-azurermcontainerinstancelog -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerInstance/Commands.ContainerInstance/help/Get-AzureRmContainerInstanceLog.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerInstance/Commands.ContainerInstance/help/Get-AzureRmContainerInstanceLog.md ---- - -# Get-AzureRmContainerInstanceLog - -## SYNOPSIS -Get the logs of a container instance in a container group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetContainerInstanceLogByNamesParamSet (Default) -``` -Get-AzureRmContainerInstanceLog [-ResourceGroupName] <String> -ContainerGroupName <String> [-Name <String>] - [-Tail <Int32>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetContainerInstanceLogByPSContainerGroupParamSet -``` -Get-AzureRmContainerInstanceLog -InputContainerGroup <PSContainerGroup> [-Name <String>] [-Tail <Int32>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetContainerInstanceLogByResourceIdParamSet -``` -Get-AzureRmContainerInstanceLog -ResourceId <String> [-Name <String>] [-Tail <Int32>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmContainerInstanceLog** cmdlet gets the logs of a container in a container group. - -## EXAMPLES - -### Example 1: Get the tail log of a container instance -``` -PS C:\> Get-AzureRmContainerInstanceLog -ResourceGroupName demo -ContainerGroupName mycontainer -Name container1 - -Log line 1. -Log line 2. -Log line 3. -Log line 4. -``` - -Get the log from `container1` in container group `mycontainer`. By default, it will return up to 4MB log content. - -### Example 2: Get the tail log of a container instance that has the same name as the container group -``` -PS C:\> Get-AzureRmContainerInstanceLog -ResourceGroupName demo -ContainerGroupName mycontainer - -Log line 1. -Log line 2. -Log line 3. -Log line 4. -``` - -Get the log from `mycontainer` in container group `mycontainer`. By default, it will return up to 4MB log content. - -### Example 3: Get the tail 2 lines of log of a container instance -``` -PS C:\> Get-AzureRmContainerInstanceLog -ResourceGroupName demo -ContainerGroupName mycontainer -Name container1 -Tail 2 - -Log line 3. -Log line 4. -``` - -Get the tail 2 lines of log from `container1` in container group `mycontainer`. - -### Example 4: Get the tail log of a container instance in a piped in container group -``` -PS C:\> Get-AzureRmContainerGroup -ResourceGroupName demo -Name mycontainer | Get-AzureRmContainerInstanceLog - -Log line 1. -Log line 2. -Log line 3. -Log line 4. -``` - -Get the log from `mycontainer` in piped in container group `mycontainer`. By default, it will return up to 4MB log content. - -## PARAMETERS - -### -ContainerGroupName -The container group name. - -```yaml -Type: System.String -Parameter Sets: GetContainerInstanceLogByNamesParamSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputContainerGroup -The input container group object. - -```yaml -Type: Microsoft.Azure.Commands.ContainerInstance.Models.PSContainerGroup -Parameter Sets: GetContainerInstanceLogByPSContainerGroupParamSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The container instance name in the container group. -Default: the same as the container group name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: GetContainerInstanceLogByNamesParamSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The resource id. - -```yaml -Type: System.String -Parameter Sets: GetContainerInstanceLogByResourceIdParamSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tail -The number of lines to tail the log. -If not specify, the cmdlet will return up to 4MB tailed log - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ContainerInstance.Models.PSContainerGroup -Parameters: InputContainerGroup (ByValue) - -### System.String - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ContainerInstance/New-AzureRmContainerGroup.md b/azurermps-6.13.0/AzureRM.ContainerInstance/New-AzureRmContainerGroup.md deleted file mode 100644 index 1f025a48ac..0000000000 --- a/azurermps-6.13.0/AzureRM.ContainerInstance/New-AzureRmContainerGroup.md +++ /dev/null @@ -1,549 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ContainerInstance.dll-Help.xml -Module Name: AzureRM.ContainerInstance -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.containerinstance/new-azurermcontainergroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerInstance/Commands.ContainerInstance/help/New-AzureRmContainerGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerInstance/Commands.ContainerInstance/help/New-AzureRmContainerGroup.md ---- - -# New-AzureRmContainerGroup - -## SYNOPSIS -Creates a container group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### CreateContainerGroupBaseParamSet (Default) -``` -New-AzureRmContainerGroup [-ResourceGroupName] <String> [-Name] <String> [-Image] <String> - [-RegistryCredential <PSCredential>] [-Location <String>] [-OsType <String>] [-RestartPolicy <String>] - [-Cpu <Int32>] [-MemoryInGB <Double>] [-IpAddressType <String>] [-DnsNameLabel <String>] [-Port <Int32[]>] - [-Command <String>] [-EnvironmentVariable <Hashtable>] [-RegistryServerDomain <String>] [-Tag <Hashtable>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### CreateContainerGroupWithAzureFileMountParamSet -``` -New-AzureRmContainerGroup [-ResourceGroupName] <String> [-Name] <String> [-Image] <String> - [-RegistryCredential <PSCredential>] -AzureFileVolumeShareName <String> - -AzureFileVolumeAccountCredential <PSCredential> -AzureFileVolumeMountPath <String> [-Location <String>] - [-OsType <String>] [-RestartPolicy <String>] [-Cpu <Int32>] [-MemoryInGB <Double>] [-IpAddressType <String>] - [-DnsNameLabel <String>] [-Port <Int32[]>] [-Command <String>] [-EnvironmentVariable <Hashtable>] - [-RegistryServerDomain <String>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmContainerGroup** cmdlets creates a container group. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmContainerGroup -ResourceGroupName demo -Name mycontainer -Image nginx -OsType Linux -IpAddressType Public -Port @(8000) - -ResourceGroupName : demo -Id : /subscriptions/ae43b1e3-c35d-4c8c-bc0d-f148b4c52b78/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/mycontainer -Name : mycontainer -Type : Microsoft.ContainerInstance/containerGroups -Location : westus -Tags : -ProvisioningState : Creating -Containers : {mycontainer} -ImageRegistryCredentials : -RestartPolicy : -IpAddress : 13.88.10.240 -Ports : {8000} -OsType : Linux -Volumes : -State : Running -Events : {} -``` - -This commands creates a container group using latest nginx image and requests a public IP address with opening port 8000. - -### Example 2 -``` -PS C:\> New-AzureRmContainerGroup -ResourceGroupName demo -Name mycontainer -Image alpine -OsType Linux -Command "/bin/sh -c myscript.sh" -EnvironmentVariable @{"env1"="value1";"env2"="value2"} - -ResourceGroupName : demo -Id : /subscriptions/ae43b1e3-c35d-4c8c-bc0d-f148b4c52b78/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/mycontainer -Name : mycontainer -Type : Microsoft.ContainerInstance/containerGroups -Location : westus -Tags : -ProvisioningState : Creating -Containers : {mycontainer} -ImageRegistryCredentials : -RestartPolicy : -IpAddress : -Ports : -OsType : Linux -Volumes : -State : Running -Events : {} -``` - -This commands creates a container group and runs a custom script inside the container. - -### Example 3: Creates a run-to-completion container group. -``` -PS C:\> New-AzureRmContainerGroup -ResourceGroupName demo -Name mycontainer -Image alpine -OsType Linux -Command "echo hello" -RestartPolicy Never - -ResourceGroupName : demo -Id : /subscriptions/ae43b1e3-c35d-4c8c-bc0d-f148b4c52b78/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/mycontainer -Name : mycontainer -Type : Microsoft.ContainerInstance/containerGroups -Location : westus -Tags : -ProvisioningState : Creating -Containers : {mycontainer} -ImageRegistryCredentials : -RestartPolicy : -IpAddress : -Ports : -OsType : Linux -Volumes : -State : Running -Events : {} -``` - -This commands creates a container group which prints out 'hello' and stops. - -### Example 4: Creates a container group using image in Azure Container Registry -``` -PS C:\> $secpasswd = ConvertTo-SecureString "PlainTextPassword" -AsPlainText -Force -PS C:\> $mycred = New-Object System.Management.Automation.PSCredential ("myacr", $secpasswd) -PS C:\> New-AzureRmContainerGroup -ResourceGroupName demo -Name mycontainer -Image myacr.azurecr.io/nginx:latest -IpAddressType Public -RegistryCredential $mycred - -ResourceGroupName : demo -Id : /subscriptions/ae43b1e3-c35d-4c8c-bc0d-f148b4c52b78/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/mycontainer -Name : mycontainer -Type : Microsoft.ContainerInstance/containerGroups -Location : westus -Tags : -ProvisioningState : Creating -Containers : {mycontainer} -ImageRegistryCredentials : {myacr} -RestartPolicy : -IpAddress : 13.88.10.240 -Ports : {80} -OsType : Linux -Volumes : -State : Running -Events : {} -``` - -This commands creates a container group using a nginx image in Azure Container Registry. - -### Example 5: Creates a container group using image in custom container image registry -``` -PS C:\> $secpasswd = ConvertTo-SecureString "PlainTextPassword" -AsPlainText -Force -PS C:\> $mycred = New-Object System.Management.Automation.PSCredential ("username", $secpasswd) -PS C:\> New-AzureRmContainerGroup -ResourceGroupName MyResourceGroup -Name MyContainer -Image myserver.com/myimage:latest -RegistryServer myserver.com -RegistryCredential $mycred - -ResourceGroupName : demo -Id : /subscriptions/ae43b1e3-c35d-4c8c-bc0d-f148b4c52b78/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/mycontainer -Name : mycontainer -Type : Microsoft.ContainerInstance/containerGroups -Location : westus -Tags : -ProvisioningState : Creating -Containers : {mycontainer} -ImageRegistryCredentials : {myserver.com} -RestartPolicy : -IpAddress : 13.88.10.240 -Ports : {80} -OsType : Linux -Volumes : -State : Running -Events : {} -``` - -This commands creates a container group using a custom image from a custom container image registry. - -### Example 6: Creates a container group that mounts Azure File volume -``` -PS C:\> $secpasswd = ConvertTo-SecureString "PlainTextPassword" -AsPlainText -Force -PS C:\> $mycred = New-Object System.Management.Automation.PSCredential ("username", $secpasswd) -PS C:\> New-AzureRmContainerGroup -ResourceGroupName MyResourceGroup -Name MyContainer -Image alpine -AzureFileVolumeShareName myshare -AzureFileVolumeAccountKey $mycred -AzureFileVolumeMountPath /mnt/azfile - -ResourceGroupName : demo -Id : /subscriptions/ae43b1e3-c35d-4c8c-bc0d-f148b4c52b78/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/mycontainer -Name : mycontainer -Type : Microsoft.ContainerInstance/containerGroups -Location : westus -Tags : -ProvisioningState : Creating -Containers : {mycontainer} -ImageRegistryCredentials : {myserver.com} -RestartPolicy : -IpAddress : 13.88.10.240 -Ports : {80} -OsType : Linux -Volumes : {AzureFile} -State : Running -Events : {} -``` - -This commands creates a container group that mounts the provided Azure File share to `/mnt/azfile`. - -## PARAMETERS - -### -AzureFileVolumeAccountCredential -The storage account credential of the Azure File share to mount where the username is the storage account name and the key is the storage account key. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: CreateContainerGroupWithAzureFileMountParamSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AzureFileVolumeMountPath -The mount path for the Azure File volume. - -```yaml -Type: System.String -Parameter Sets: CreateContainerGroupWithAzureFileMountParamSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AzureFileVolumeShareName -The name of the Azure File share to mount. - -```yaml -Type: System.String -Parameter Sets: CreateContainerGroupWithAzureFileMountParamSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Command -The command to run in the container. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Cpu -The required CPU cores. -Default: 1 - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DnsNameLabel -The DNS name label for the IP address. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnvironmentVariable -The container environment variables. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Image -The container image. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IpAddressType -The IP address type. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Public - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The container group Location. -Default to the location of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemoryInGB -The required memory in GB. -Default: 1.5 - -```yaml -Type: System.Nullable`1[System.Double] -Parameter Sets: (All) -Aliases: Memory - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The container group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OsType -The container OS type. -Default: Linux - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Linux, Windows - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Port -The port(s) to open. Default: [80] - -```yaml -Type: System.Int32[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegistryCredential -The custom container registry credential. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegistryServerDomain -The custom container registry login server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: RegistryServer - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RestartPolicy -The container restart policy. Default: Always - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Always, Never, OnFailure - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -{{Fill Tag Description}} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.ContainerInstance.Models.PSContainerGroup - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ContainerInstance/Remove-AzureRmContainerGroup.md b/azurermps-6.13.0/AzureRM.ContainerInstance/Remove-AzureRmContainerGroup.md deleted file mode 100644 index ebb71f065c..0000000000 --- a/azurermps-6.13.0/AzureRM.ContainerInstance/Remove-AzureRmContainerGroup.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ContainerInstance.dll-Help.xml -Module Name: AzureRM.ContainerInstance -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.containerinstance/remove-azurermcontainergroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerInstance/Commands.ContainerInstance/help/Remove-AzureRmContainerGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerInstance/Commands.ContainerInstance/help/Remove-AzureRmContainerGroup.md ---- - -# Remove-AzureRmContainerGroup - -## SYNOPSIS -Removes a container group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RemoveContainerGroupByResourceGroupAndNameParamSet (Default) -``` -Remove-AzureRmContainerGroup [-ResourceGroupName] <String> [-Name] <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RemoveContainerGroupByPSContainerGroupParamSet -``` -Remove-AzureRmContainerGroup -InputObject <PSContainerGroup> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RemoveContainerGroupByResourceIdParamSet -``` -Remove-AzureRmContainerGroup -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmContainerGroup** cmdlet removes a container group. - -## EXAMPLES - -### Example 1: Removes a container group -``` -PS C:\> Remove-AzureRmContainerGroup -ResourceGroupName MyResourceGroup -Name MyContainer -``` - -This command removes the specified container group. - -### Example 2: Removes a container group by piping -``` -PS C:\> Get-AzureRmContainerGroup -ResourceGroupName MyResourceGroup -Name MyContainer | Remove-AzureRmContainerGroup -``` - -This command removes a container group by piping. - -### Example 3: Removes a container group by resource Id. -``` -PS C:\> Find-AzureRmResource -ResourceGroupEquals MyResourceGroup -ResourceNameEquals MyContainer | Remove-AzureRmContainerGroup -``` - -This command removes a container group by resource Id. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The container group to remove. - -```yaml -Type: Microsoft.Azure.Commands.ContainerInstance.Models.PSContainerGroup -Parameter Sets: RemoveContainerGroupByPSContainerGroupParamSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The container group name. - -```yaml -Type: System.String -Parameter Sets: RemoveContainerGroupByResourceGroupAndNameParamSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: RemoveContainerGroupByResourceGroupAndNameParamSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The resource id. - -```yaml -Type: System.String -Parameter Sets: RemoveContainerGroupByResourceIdParamSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ContainerInstance.Models.PSContainerGroup -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ContainerInstance.Models.PSContainerGroup - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ContainerRegistry/AzureRM.ContainerRegistry.md b/azurermps-6.13.0/AzureRM.ContainerRegistry/AzureRM.ContainerRegistry.md deleted file mode 100644 index cd9c43cbbb..0000000000 --- a/azurermps-6.13.0/AzureRM.ContainerRegistry/AzureRM.ContainerRegistry.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -Module Name: AzureRM.ContainerRegistry -Module Guid: b3ca459c-feb9-41cc-a954-46222505acb3 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.containerregistry -Help Version: 1.0.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerRegistry/Commands.ContainerRegistry/help/AzureRM.ContainerRegistry.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerRegistry/Commands.ContainerRegistry/help/AzureRM.ContainerRegistry.md ---- - -# AzureRM.ContainerRegistry Module -## Description -This topic displays help topics for the Azure Container Registry Management Cmdlets. - -## AzureRM.ContainerRegistry Cmdlets -### [Get-AzureRmContainerRegistry](Get-AzureRmContainerRegistry.md) -Gets a container registry. - -### [Get-AzureRmContainerRegistryCredential](Get-AzureRmContainerRegistryCredential.md) -Gets the login credentials for a container registry. - -### [Get-AzureRmContainerRegistryReplication](Get-AzureRmContainerRegistryReplication.md) -Gets a replication of a container registry. - -### [Get-AzureRmContainerRegistryWebhook](Get-AzureRmContainerRegistryWebhook.md) -Gets a container registry webhook. - -### [Get-AzureRmContainerRegistryWebhookEvent](Get-AzureRmContainerRegistryWebhookEvent.md) -Gets events of a container registry webhook. - -### [New-AzureRmContainerRegistry](New-AzureRmContainerRegistry.md) -Creates a container registry. - -### [New-AzureRmContainerRegistryReplication](New-AzureRmContainerRegistryReplication.md) -Creates a container registry replication. - -### [New-AzureRmContainerRegistryWebhook](New-AzureRmContainerRegistryWebhook.md) -Creates a container registry webhook. - -### [Remove-AzureRmContainerRegistry](Remove-AzureRmContainerRegistry.md) -Removes a container registry. - -### [Remove-AzureRmContainerRegistryReplication](Remove-AzureRmContainerRegistryReplication.md) -Removes a container registry replication. - -### [Remove-AzureRmContainerRegistryWebhook](Remove-AzureRmContainerRegistryWebhook.md) -Removes a container registry webhook. - -### [Test-AzureRmContainerRegistryNameAvailability](Test-AzureRmContainerRegistryNameAvailability.md) -Checks the availability of a container registry name. - -### [Test-AzureRmContainerRegistryWebhook](Test-AzureRmContainerRegistryWebhook.md) -Triggers a webhook ping event. - -### [Update-AzureRmContainerRegistry](Update-AzureRmContainerRegistry.md) -Updates a container registry. - -### [Update-AzureRmContainerRegistryCredential](Update-AzureRmContainerRegistryCredential.md) -Regenerates a login credential for a container registry. - -### [Update-AzureRmContainerRegistryWebhook](Update-AzureRmContainerRegistryWebhook.md) -Updates a container registry webhook. - diff --git a/azurermps-6.13.0/AzureRM.ContainerRegistry/Get-AzureRmContainerRegistry.md b/azurermps-6.13.0/AzureRM.ContainerRegistry/Get-AzureRmContainerRegistry.md deleted file mode 100644 index 1c2e0b0955..0000000000 --- a/azurermps-6.13.0/AzureRM.ContainerRegistry/Get-AzureRmContainerRegistry.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ContainerRegistry.dll-Help.xml -Module Name: AzureRM.ContainerRegistry -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.containerregistry/get-azurermcontainerregistry -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerRegistry/Commands.ContainerRegistry/help/Get-AzureRmContainerRegistry.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerRegistry/Commands.ContainerRegistry/help/Get-AzureRmContainerRegistry.md ---- - -# Get-AzureRmContainerRegistry - -## SYNOPSIS -Gets a container registry. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ListRegistriesParameterSet (Default) -``` -Get-AzureRmContainerRegistry [[-ResourceGroupName] <String>] [-IncludeDetail] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### RegistryNameParameterSet -``` -Get-AzureRmContainerRegistry [-ResourceGroupName] <String> [-Name] <String> [-IncludeDetail] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Get-AzureRmContainerRegistry [-IncludeDetail] -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmContainerRegistry cmdlet gets a specified container registry or all the container registries in a resource group or the subscription. - -## EXAMPLES - -### Example 1: Get a specified container registry -```powershell -PS C:\>Get-AzureRmContainerRegistry -ResourceGroupName "MyResourceGroup" -Name "MyRegistry" - - Container registry location: westus - -Registry Name Sku LoginServer CreationDate Provisioni AdminUserE StorageAccountN - ngState nabled ame -------------- --- ----------- ------------ ---------- ---------- --------------- -myregistry Premium myregistry.azurecr.io 10/31/2017 6:49:31 PM Succeeded True -``` - -This command gets the specified container registry. - -### Example 2: Get all the container registries in a resource group -```powershell -PS C:\>Get-AzureRmContainerRegistry -ResourceGroupName "MyResourceGroup" - - Container registry location: westus - -Registry Name Sku LoginServer CreationDate Provisioni AdminUserE StorageAccountN - ngState nabled ame -------------- --- ----------- ------------ ---------- ---------- --------------- -myregistry Premium myregistry.azurecr.io 10/31/2017 6:49:31 PM Succeeded True - - - Container registry location: eastus - -Registry Name Sku LoginServer CreationDate Provisioni AdminUserE StorageAccountN - ngState nabled ame -------------- --- ----------- ------------ ---------- ---------- --------------- -myregistry1 Premium myregistry1.azurecr.io 10/31/2017 6:29:31 PM Succeeded True -``` - -This command gets all the container registries in a resource group. - -### Example 3: Get all the container registries in the subscription -```powershell -PS C:\>Get-AzureRmContainerRegistry - - Container registry location: westus - -Registry Name Sku LoginServer CreationDate Provisioni AdminUserE StorageAccountN - ngState nabled ame -------------- --- ----------- ------------ ---------- ---------- --------------- -myregistry Premium myregistry.azurecr.io 10/31/2017 6:49:31 PM Succeeded True - - - Container registry location: eastus - -Registry Name Sku LoginServer CreationDate Provisioni AdminUserE StorageAccountN - ngState nabled ame -------------- --- ----------- ------------ ---------- ---------- --------------- -myregistry1 Premium myregistry1.azurecr.io 10/31/2017 6:29:31 PM Succeeded True -``` - -This command gets all the container registries in the subscription. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDetail -Show more details about the container registry. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Container Registry Name. - -```yaml -Type: System.String -Parameter Sets: RegistryNameParameterSet -Aliases: ContainerRegistryName, RegistryName, ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: ListRegistriesParameterSet -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: RegistryNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The container registry resource id - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistry - -## NOTES - -## RELATED LINKS - -[New-AzureRmContainerRegistry](New-AzureRmContainerRegistry.md) - -[Update-AzureRmContainerRegistry](Update-AzureRmContainerRegistry.md) - -[Remove-AzureRmContainerRegistry](Remove-AzureRmContainerRegistry.md) - diff --git a/azurermps-6.13.0/AzureRM.ContainerRegistry/Get-AzureRmContainerRegistryCredential.md b/azurermps-6.13.0/AzureRM.ContainerRegistry/Get-AzureRmContainerRegistryCredential.md deleted file mode 100644 index df08622fba..0000000000 --- a/azurermps-6.13.0/AzureRM.ContainerRegistry/Get-AzureRmContainerRegistryCredential.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ContainerRegistry.dll-Help.xml -Module Name: AzureRM.ContainerRegistry -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.containerregistry/get-azurermcontainerregistrycredential -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerRegistry/Commands.ContainerRegistry/help/Get-AzureRmContainerRegistryCredential.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerRegistry/Commands.ContainerRegistry/help/Get-AzureRmContainerRegistryCredential.md ---- - -# Get-AzureRmContainerRegistryCredential - -## SYNOPSIS -Gets the login credentials for a container registry. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameResourceGroupParameterSet (Default) -``` -Get-AzureRmContainerRegistryCredential [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### RegistryObjectParameterSet -``` -Get-AzureRmContainerRegistryCredential -Registry <PSContainerRegistry> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Get-AzureRmContainerRegistryCredential -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmContainerRegistryCredential cmdlet gets the login credentials for a container registry. - -## EXAMPLES - -### Example 1: Get the login credentials for a container registry -```powershell -PS C:\>Get-AzureRmContainerRegistryCredential -ResourceGroupName "MyResourceGroup" -Name "MyRegistry" - -Username Password Password2 --------- -------- --------- -MyRegistry +Y+==B==KdT=YV=ZgH=p/zQ/e1sNQq/d //JRPkgxx+r+z/ztU=R//E==vum=pRKL -``` - -This command gets the login credentials for the specified container registry. -Admin user has to be enabled for the container registry \`MyRegistry\` to get login credentials. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Container Registry Name. - -```yaml -Type: System.String -Parameter Sets: NameResourceGroupParameterSet -Aliases: ContainerRegistryName, RegistryName, ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Registry -Container Registry Object. - -```yaml -Type: Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistry -Parameter Sets: RegistryObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: NameResourceGroupParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The container registry resource id - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistryCredential - -## NOTES - -## RELATED LINKS - -[New-AzureRmContainerRegistry](New-AzureRmContainerRegistry.md) - -[Update-AzureRmContainerRegistry](Update-AzureRmContainerRegistry.md) - -[Update-AzureRmContainerRegistryCredential](Update-AzureRmContainerRegistryCredential.md) - diff --git a/azurermps-6.13.0/AzureRM.ContainerRegistry/Get-AzureRmContainerRegistryReplication.md b/azurermps-6.13.0/AzureRM.ContainerRegistry/Get-AzureRmContainerRegistryReplication.md deleted file mode 100644 index d30032ecf7..0000000000 --- a/azurermps-6.13.0/AzureRM.ContainerRegistry/Get-AzureRmContainerRegistryReplication.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ContainerRegistry.dll-Help.xml -Module Name: AzureRM.ContainerRegistry -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.containerregistry/get-azurermcontainerregistrycredential -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerRegistry/Commands.ContainerRegistry/help/Get-AzureRmContainerRegistryReplication.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerRegistry/Commands.ContainerRegistry/help/Get-AzureRmContainerRegistryReplication.md ---- - -# Get-AzureRmContainerRegistryReplication - -## SYNOPSIS -Gets a replication of a container registry. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ListReplicationByNameResourceGroupParameterSet (Default) -``` -Get-AzureRmContainerRegistryReplication [-ResourceGroupName] <String> [-RegistryName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ShowReplicationByNameResourceGroupParameterSet -``` -Get-AzureRmContainerRegistryReplication [-Name] <String> [-ResourceGroupName] <String> [-RegistryName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ShowReplicationByRegistryObjectParameterSet -``` -Get-AzureRmContainerRegistryReplication [-Name] <String> -Registry <PSContainerRegistry> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ListReplicationByRegistryObjectParameterSet -``` -Get-AzureRmContainerRegistryReplication -Registry <PSContainerRegistry> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Get-AzureRmContainerRegistryReplication -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmContainerRegistryReplication cmdlet gets a specified replication of a container registry or all the replications of a container registry. - -## EXAMPLES - -### Example 1: Gets a specified replication of a container registry -```powershell -PS C:\>Get-AzureRmContainerRegistryReplication -ResourceGroupName "MyResourceGroup" -RegistryName "MyRegistry" -Name "myreplication" - -Name Location Provisioni Status StatusTimestamp Tags - ngState ----- -------- ---------- ------ --------------- ---- -myreplication westus Succeeded Ready 11/17/2017 10:19:45 PM {[tagName, MyTag]} -``` - -Gets a specified replication of a container registry - -### Example 2: Gets all the replications of a container registry -```powershell -PS C:\>Get-AzureRmContainerRegistryReplication -ResourceGroupName "MyResourceGroup" -RegistryName "MyRegistry" - -Name Location Provisioni Status StatusTimestamp Tags - ngState ----- -------- ---------- ------ --------------- ---- -eastus eastus Succeeded Ready 11/6/2017 6:14:47 PM {} -myreplication westus Succeeded Ready 11/17/2017 10:19:45 PM {[tagName, MyTag]} -``` - -Gets all the replications of a container registry - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Container Registry Replication Name. - -```yaml -Type: System.String -Parameter Sets: ShowReplicationByNameResourceGroupParameterSet, ShowReplicationByRegistryObjectParameterSet -Aliases: ReplicationName, ResourceName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Registry -Container Registry Object. - -```yaml -Type: Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistry -Parameter Sets: ShowReplicationByRegistryObjectParameterSet, ListReplicationByRegistryObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RegistryName -Container Registry Name. - -```yaml -Type: System.String -Parameter Sets: ListReplicationByNameResourceGroupParameterSet, ShowReplicationByNameResourceGroupParameterSet -Aliases: ContainerRegistryName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: ListReplicationByNameResourceGroupParameterSet, ShowReplicationByNameResourceGroupParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The container registry replication resource id - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistry -Parameters: Registry (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistryReplication - -## NOTES - -## RELATED LINKS - -[New-AzureRmContainerRegistryReplication](New-AzureRmContainerRegistryReplication.md) - -[Remove-AzureRmContainerRegistryReplication](Remove-AzureRmContainerRegistryReplication.md) diff --git a/azurermps-6.13.0/AzureRM.ContainerRegistry/Get-AzureRmContainerRegistryWebhook.md b/azurermps-6.13.0/AzureRM.ContainerRegistry/Get-AzureRmContainerRegistryWebhook.md deleted file mode 100644 index e333c3a344..0000000000 --- a/azurermps-6.13.0/AzureRM.ContainerRegistry/Get-AzureRmContainerRegistryWebhook.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ContainerRegistry.dll-Help.xml -Module Name: AzureRM.ContainerRegistry -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.containerregistry/get-azurermcontainerregistrycredential -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerRegistry/Commands.ContainerRegistry/help/Get-AzureRmContainerRegistryWebhook.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerRegistry/Commands.ContainerRegistry/help/Get-AzureRmContainerRegistryWebhook.md ---- - -# Get-AzureRmContainerRegistryWebhook - -## SYNOPSIS -Gets a container registry webhook. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ListWebhookByNameResourceGroupParameterSet (Default) -``` -Get-AzureRmContainerRegistryWebhook [-ResourceGroupName] <String> [-RegistryName] <String> - [-IncludeConfiguration] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ShowWebhookByNameResourceGroupParameterSet -``` -Get-AzureRmContainerRegistryWebhook [-Name] <String> [-ResourceGroupName] <String> [-RegistryName] <String> - [-IncludeConfiguration] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ShowWebhookByRegistryObjectParameterSet -``` -Get-AzureRmContainerRegistryWebhook [-Name] <String> -Registry <PSContainerRegistry> [-IncludeConfiguration] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ListWebhookByRegistryObjectParameterSet -``` -Get-AzureRmContainerRegistryWebhook -Registry <PSContainerRegistry> [-IncludeConfiguration] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Get-AzureRmContainerRegistryWebhook [-IncludeConfiguration] -ResourceId <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmContainerRegistryWebhook cmdlet gets a specified webhook of container registry or all the webhooks of a container registry. - -## EXAMPLES - -### Example 1: Get a specified webhook of a container registry -```powershell -PS C:\>Get-AzureRmContainerRegistryWebhook -ResourceGroupName "MyResourceGroup" -RegistryName "MyRegistry" -Name "webhook001" - -Name Location Status Scope Actions Provisioni ServiceUri - ngState ----- -------- ------ ----- ------- ---------- ---------- -webhook001 westus enabled {push, delete} Succeeded -``` - -Get a specified webhook of a container registry - -### Example 2: Get all the webhooks of a container registry -```powershell -PS C:\>Get-AzureRmContainerRegistryWebhook -ResourceGroupName "MyResourceGroup" -RegistryName "MyRegistry" - -Name Location Status Scope Actions Provisioni ServiceUri - ngState ----- -------- ------ ----- ------- ---------- ---------- -webhook04 westus enabled {push, delete} Succeeded -webhook05 westus disabled {push, delete} Succeeded -wh003 westus enabled delete Succeeded -``` - -Get all the webhooks of a container registry - -### Example 3: Get a specified webhook of a container registry with configuration details -```powershell -PS C:\>Get-AzureRmContainerRegistryWebhook -ResourceGroupName "MyResourceGroup" -RegistryName "MyRegistry" -Name "webhook001" -IncludeConfiguration - -Name Location Status Scope Actions Provisioni ServiceUri - ngState ----- -------- ------ ----- ------- ---------- ---------- -webhook001 westus enabled {push, delete} Succeeded http://www.test.com/ -``` - -Get a specified webhook of a container registry with configuration details - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeConfiguration -Get the configuration information for a webhook. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Webhook Name. - -```yaml -Type: System.String -Parameter Sets: ShowWebhookByNameResourceGroupParameterSet, ShowWebhookByRegistryObjectParameterSet -Aliases: WebhookName, ResourceName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Registry -Container Registry Object. - -```yaml -Type: Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistry -Parameter Sets: ShowWebhookByRegistryObjectParameterSet, ListWebhookByRegistryObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RegistryName -Container Registry Name. - -```yaml -Type: System.String -Parameter Sets: ListWebhookByNameResourceGroupParameterSet, ShowWebhookByNameResourceGroupParameterSet -Aliases: ContainerRegistryName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: ListWebhookByNameResourceGroupParameterSet, ShowWebhookByNameResourceGroupParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The container registry Webhook resource id - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistry -Parameters: Registry (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistryWebhook - -## NOTES - -## RELATED LINKS - -[New-AzureRmContainerRegistryWebhook](New-AzureRmContainerRegistryWebhook.md) - -[Update-AzureRmContainerRegistryWebhook](Update-AzureRmContainerRegistryWebhook.md) - -[Remove-AzureRmContainerRegistryWebhook](Remove-AzureRmContainerRegistryWebhook.md) - -[Test-AzureRmContainerRegistryWebhook](Test-AzureRmContainerRegistryWebhook.md) diff --git a/azurermps-6.13.0/AzureRM.ContainerRegistry/Get-AzureRmContainerRegistryWebhookEvent.md b/azurermps-6.13.0/AzureRM.ContainerRegistry/Get-AzureRmContainerRegistryWebhookEvent.md deleted file mode 100644 index 08921ecf15..0000000000 --- a/azurermps-6.13.0/AzureRM.ContainerRegistry/Get-AzureRmContainerRegistryWebhookEvent.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ContainerRegistry.dll-Help.xml -Module Name: AzureRM.ContainerRegistry -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.containerregistry/get-azurermcontainerregistrycredential -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerRegistry/Commands.ContainerRegistry/help/Get-AzureRmContainerRegistryWebhookEvent.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerRegistry/Commands.ContainerRegistry/help/Get-AzureRmContainerRegistryWebhookEvent.md ---- - -# Get-AzureRmContainerRegistryWebhookEvent - -## SYNOPSIS -Gets events of a container registry webhook. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ListWebhookEventsByNameResourceGroupParameterSet (Default) -``` -Get-AzureRmContainerRegistryWebhookEvent [-WebhookName] <String> [-ResourceGroupName] <String> - [-RegistryName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ListWebhookEventsByWebhookObjectParameterSet -``` -Get-AzureRmContainerRegistryWebhookEvent -Webhook <PSContainerRegistryWebhook> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Get-AzureRmContainerRegistryWebhookEvent -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmContainerRegistryWebhookEvent cmdlet lists all the events of a webhook. - -## EXAMPLES - -### Example 1: Gets all the events of a webhook. -```powershell -PS C:\>Get-AzureRmContainerRegistryWebhookEvent -ResourceGroupName mattacrtest001 -RegistryName premium001 -Name webhook001 - - Webhook service Uri: http://www.bing.com/ - -ID Action Timestamp Response - StatusCode --- ------ --------- ---------- -3c6281b6-47cd-4129-948b-4036780236f0 ping 11/17/2017 5:10:09 PM 200 -70f1d41d-15fe-4251-87b6-43c32a91eae7 ping 11/17/2017 6:56:23 AM 200 -5d25556b-32d0-4377-8031-d8ba7a263d6a ping 11/17/2017 6:27:41 AM 200 -c1e7d8aa-9f1b-447c-9583-2a58b7f81026 ping 11/17/2017 12:09:41 AM 200 -eb4aa503-0d14-4f25-8ae5-33cce9a8fd50 ping 11/16/2017 11:35:03 PM 200 -85a93d7f-3923-4ec5-bb8e-9ded5b6549c1 ping 11/17/2017 5:10:09 PM 200 -9e3c8b5f-e0ee-47cf-9727-df1c8d45a497 ping 11/17/2017 6:56:23 AM 200 -2d0ce294-9b59-4f5c-953a-47f2b270526f ping 11/17/2017 6:27:41 AM 200 -``` - -Gets all the events of a webhook. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegistryName -Container Registry Name. - -```yaml -Type: System.String -Parameter Sets: ListWebhookEventsByNameResourceGroupParameterSet -Aliases: ContainerRegistryName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: ListWebhookEventsByNameResourceGroupParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The container registry Webhook resource id - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Webhook -Container Registry Object. - -```yaml -Type: Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistryWebhook -Parameter Sets: ListWebhookEventsByWebhookObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebhookName -Webhook Name. - -```yaml -Type: System.String -Parameter Sets: ListWebhookEventsByNameResourceGroupParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistryWebhookEvent - -## NOTES - -## RELATED LINKS - -[New-AzureRmContainerRegistryWebhook](New-AzureRmContainerRegistryWebhook.md) - -[Get-AzureRmContainerRegistryWebhook](Get-AzureRmContainerRegistryWebhook.md) - -[Update-AzureRmContainerRegistryWebhook](Update-AzureRmContainerRegistryWebhook.md) - -[Remove-AzureRmContainerRegistryWebhook](Remove-AzureRmContainerRegistryWebhook.md) - -[Test-AzureRmContainerRegistryWebhook](Test-AzureRmContainerRegistryWebhook.md) - diff --git a/azurermps-6.13.0/AzureRM.ContainerRegistry/New-AzureRmContainerRegistry.md b/azurermps-6.13.0/AzureRM.ContainerRegistry/New-AzureRmContainerRegistry.md deleted file mode 100644 index fd5a673609..0000000000 --- a/azurermps-6.13.0/AzureRM.ContainerRegistry/New-AzureRmContainerRegistry.md +++ /dev/null @@ -1,250 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ContainerRegistry.dll-Help.xml -Module Name: AzureRM.ContainerRegistry -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.containerregistry/new-azurermcontainerregistry -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerRegistry/Commands.ContainerRegistry/help/New-AzureRmContainerRegistry.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerRegistry/Commands.ContainerRegistry/help/New-AzureRmContainerRegistry.md ---- - -# New-AzureRmContainerRegistry - -## SYNOPSIS -Creates a container registry. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmContainerRegistry [-ResourceGroupName] <String> [-Name] <String> [-Sku] <String> - [-Location <String>] [-EnableAdminUser] [-Tag <Hashtable>] [-StorageAccountName <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmContainerRegistry cmdlet creates a container registry. - -## EXAMPLES - -### Example 1: Create a container registry with a new storage account. -```powershell -PS C:\>New-AzureRmContainerRegistry -ResourceGroupName "MyResourceGroup" -Name "MyRegistry" -Sku "Basic" - - Container registry location: eastus - -Registry Name Sku LoginServer CreationDate Provisioni AdminUserE StorageAccountN - ngState nabled ame -------------- --- ----------- ------------ ---------- ---------- --------------- -myregistry Premium myregistry.azurecr.io 10/31/2017 6:49:31 PM Succeeded True -``` - -This command creates a container registry with a new storage account in the resource group \`MyResourceGroup\`. - -### Example 2: Create a container registry with admin user enabled. -```powershell -PS C:\>New-AzureRmContainerRegistry -ResourceGroupName "MyResourceGroup" -Name "MyRegistry" -Sku "Basic" -EnableAdminUser - - Container registry location: eastus - -Registry Name Sku LoginServer CreationDate Provisioni AdminUserE StorageAccountN - ngState nabled ame -------------- --- ----------- ------------ ---------- ---------- --------------- -myregistry Premium myregistry.azurecr.io 10/31/2017 6:49:31 PM Succeeded True -``` - -This command creates a container registry with admin user enabled. - -### Example 3: Create a container registry with an existing storage account. -```powershell -PS C:\>New-AzureRmContainerRegistry -ResourceGroupName "MyResourceGroup" -Name "MyRegistry" -Sku "Basic" -StorageAccountName "mystorageaccount" - - Container registry location: eastus - -Registry Name Sku LoginServer CreationDate Provisioni AdminUserE StorageAccountN - ngState nabled ame -------------- --- ----------- ------------ ---------- ---------- --------------- -myregistry Premium myregistry.azurecr.io 10/31/2017 6:49:31 PM Succeeded True -``` - -This command creates a container registry with an existing storage account \`mystorageaccount\` in the same subscription. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableAdminUser -Enable admin user for the container registry. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: EnableAdmin - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Container Registry Location. -Default to the location of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Container Registry Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ContainerRegistryName, RegistryName, ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -Container Registry SKU. -Allowed values: Basic. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ContainerRegistrySku, RegistrySku -Accepted values: Classic, Basic, Premium, Standard - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageAccountName -The name of an existing storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Container Registry Tags.Key-value pairs in the form of a hash table. -For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistry - -## NOTES - -## RELATED LINKS - -[Get-AzureRmContainerRegistry](Get-AzureRmContainerRegistry.md) - -[Update-AzureRmContainerRegistry](Update-AzureRmContainerRegistry.md) - -[Remove-AzureRmContainerRegistry](Remove-AzureRmContainerRegistry.md) - diff --git a/azurermps-6.13.0/AzureRM.ContainerRegistry/New-AzureRmContainerRegistryReplication.md b/azurermps-6.13.0/AzureRM.ContainerRegistry/New-AzureRmContainerRegistryReplication.md deleted file mode 100644 index be2212d055..0000000000 --- a/azurermps-6.13.0/AzureRM.ContainerRegistry/New-AzureRmContainerRegistryReplication.md +++ /dev/null @@ -1,227 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ContainerRegistry.dll-Help.xml -Module Name: AzureRM.ContainerRegistry -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.containerregistry/new-azurermcontainerregistry -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerRegistry/Commands.ContainerRegistry/help/New-AzureRmContainerRegistryReplication.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerRegistry/Commands.ContainerRegistry/help/New-AzureRmContainerRegistryReplication.md ---- - -# New-AzureRmContainerRegistryReplication - -## SYNOPSIS -Creates a container registry replication. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameResourceGroupParameterSet (Default) -``` -New-AzureRmContainerRegistryReplication [-ResourceGroupName] <String> [-RegistryName] <String> - -Location <String> [-Name <String>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### RegistryObjectParameterSet -``` -New-AzureRmContainerRegistryReplication -Registry <PSContainerRegistry> -Location <String> [-Name <String>] - [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -New-AzureRmContainerRegistryReplication -Location <String> [-Name <String>] [-Tag <Hashtable>] - -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmContainerRegistryReplication cmdlet creates a new container registry replication. - -## EXAMPLES - -### Example 1: Create a new container registry replication. -```powershell -PS C:\>New-AzureRmContainerRegistryReplication -ResourceGroupName "MyResourceGroup" -RegistryName "MyRegistry" -Name replication001 -Location 'west us' -Tag @{tagName='MyTag'} - -Name Location Provisioni Status StatusTimestamp Tags - ngState ----- -------- ---------- ------ --------------- ---- -replication001 westus Succeeded Ready 11/17/2017 10:19:45 PM {[tagName, MyTag]} -``` - -Create a new container registry replication. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Container Registry Location. -Default to the location of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ReplicationLocation - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Container Registry Replication Name. -Default to the location name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ReplicationName, ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Registry -Container Registry Object. - -```yaml -Type: Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistry -Parameter Sets: RegistryObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegistryName -Container Registry Name. - -```yaml -Type: System.String -Parameter Sets: NameResourceGroupParameterSet -Aliases: ContainerRegistryName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: NameResourceGroupParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The container registry resource id - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Container Registry Tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistryReplication - -## NOTES - -## RELATED LINKS - -[Get-AzureRmContainerRegistryReplication](New-AzureRmContainerRegistryReplication.md) - -[Remove-AzureRmContainerRegistryReplication](Remove-AzureRmContainerRegistryReplication.md) diff --git a/azurermps-6.13.0/AzureRM.ContainerRegistry/New-AzureRmContainerRegistryWebhook.md b/azurermps-6.13.0/AzureRM.ContainerRegistry/New-AzureRmContainerRegistryWebhook.md deleted file mode 100644 index 2afb25a638..0000000000 --- a/azurermps-6.13.0/AzureRM.ContainerRegistry/New-AzureRmContainerRegistryWebhook.md +++ /dev/null @@ -1,310 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ContainerRegistry.dll-Help.xml -Module Name: AzureRM.ContainerRegistry -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.containerregistry/new-azurermcontainerregistry -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerRegistry/Commands.ContainerRegistry/help/New-AzureRmContainerRegistryWebhook.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerRegistry/Commands.ContainerRegistry/help/New-AzureRmContainerRegistryWebhook.md ---- - -# New-AzureRmContainerRegistryWebhook - -## SYNOPSIS -Creates a container registry webhook. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameResourceGroupParameterSet (Default) -``` -New-AzureRmContainerRegistryWebhook [-Name] <String> [-ResourceGroupName] <String> [-RegistryName] <String> - [-Uri] <Uri> [-Action] <String[]> [-Header <Hashtable>] [-Tag <Hashtable>] [-Status <String>] - [-Scope <String>] [-Location <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### RegistryObjectParameterSet -``` -New-AzureRmContainerRegistryWebhook [-Name] <String> [-Uri] <Uri> [-Action] <String[]> - -Registry <PSContainerRegistry> [-Header <Hashtable>] [-Tag <Hashtable>] [-Status <String>] [-Scope <String>] - [-Location <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -New-AzureRmContainerRegistryWebhook [-Name] <String> [-Uri] <Uri> [-Action] <String[]> [-Header <Hashtable>] - [-Tag <Hashtable>] [-Status <String>] [-Scope <String>] [-Location <String>] -ResourceId <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmContainerRegistryWebhook cmdlet creates a container registry webhook. - -## EXAMPLES - -### Example 1: Create a container registry webhook. -``` -PS C:\> New-AzureRmContainerRegistryWebhook -ResourceGroupName "MyResourceGroup" -RegistryName "MyRegistry" -Name "webhook001" -Uri http://www.bing.com -Action Delete,Push -Header @{SpecialHeader='headerVal'} -Tag @{Key="val"} -Location "east us" -Status Enabled -Scope "foo:*" - -Name Location Status Scope Actions Provisioni ServiceUri - ngState ----- -------- ------ ----- ------- ---------- ---------- -webhook001 westus enabled foo:* {push, delete} Succeeded -``` - -Create a container registry webhook. - -## PARAMETERS - -### -Action -Space separated list of actions that trigger the webhook to post notifications. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: WebhookActions -Accepted values: delete, push - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Header -Custom headers that will be added to the webhook notifications. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: WebhookHeaders - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Webhook Location. -Default to the location of the registry. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: WebhookLocation - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Webhook Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: WebhookName, ResourceName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Registry -Container Registry Object. - -```yaml -Type: Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistry -Parameter Sets: RegistryObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegistryName -Container Registry Name. - -```yaml -Type: System.String -Parameter Sets: NameResourceGroupParameterSet -Aliases: ContainerRegistryName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: NameResourceGroupParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The container registry resource id - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Scope -Webhook scope. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: WebhookScope - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Status -Webhook status, default value is enabled - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: WebhookStatus -Accepted values: enabled, disabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Webhook tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Uri -The service URI for the webhook to post notifications. - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: WebhookUri - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistryWebhook - -## NOTES - -## RELATED LINKS - -[Get-AzureRmContainerRegistryWebhook](Get-AzureRmContainerRegistryWebhook.md) - -[Update-AzureRmContainerRegistryWebhook](Update-AzureRmContainerRegistryWebhook.md) - -[Remove-AzureRmContainerRegistryWebhook](Remove-AzureRmContainerRegistryWebhook.md) - -[Test-AzureRmContainerRegistryWebhook](Test-AzureRmContainerRegistryWebhook.md) diff --git a/azurermps-6.13.0/AzureRM.ContainerRegistry/Remove-AzureRmContainerRegistry.md b/azurermps-6.13.0/AzureRM.ContainerRegistry/Remove-AzureRmContainerRegistry.md deleted file mode 100644 index 3b7cccf0c0..0000000000 --- a/azurermps-6.13.0/AzureRM.ContainerRegistry/Remove-AzureRmContainerRegistry.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ContainerRegistry.dll-Help.xml -Module Name: AzureRM.ContainerRegistry -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.containerregistry/remove-azurermcontainerregistry -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerRegistry/Commands.ContainerRegistry/help/Remove-AzureRmContainerRegistry.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerRegistry/Commands.ContainerRegistry/help/Remove-AzureRmContainerRegistry.md ---- - -# Remove-AzureRmContainerRegistry - -## SYNOPSIS -Removes a container registry. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameResourceGroupParameterSet (Default) -``` -Remove-AzureRmContainerRegistry [-ResourceGroupName] <String> [-Name] <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RegistryObjectParameterSet -``` -Remove-AzureRmContainerRegistry -Registry <PSContainerRegistry> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Remove-AzureRmContainerRegistry -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmContainerRegistry cmdlet removes a container registry. - -## EXAMPLES - -### Example 1: Remove a specified container registry -```powershell -PS C:\>Remove-AzureRmContainerRegistry -ResourceGroupName "MyResourceGroup" -Name "MyRegistry" -``` - -This command removes the specified container registry. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Container Registry Name. - -```yaml -Type: System.String -Parameter Sets: NameResourceGroupParameterSet -Aliases: ContainerRegistryName, RegistryName, ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns true if the removal was successful. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Registry -Container Registry Object. - -```yaml -Type: Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistry -Parameter Sets: RegistryObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: NameResourceGroupParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The container registry resource id - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[New-AzureRmContainerRegistry]() - -[Get-AzureRmContainerRegistry]() - -[Update-AzureRmContainerRegistry]() - diff --git a/azurermps-6.13.0/AzureRM.ContainerRegistry/Remove-AzureRmContainerRegistryReplication.md b/azurermps-6.13.0/AzureRM.ContainerRegistry/Remove-AzureRmContainerRegistryReplication.md deleted file mode 100644 index 4533ff2617..0000000000 --- a/azurermps-6.13.0/AzureRM.ContainerRegistry/Remove-AzureRmContainerRegistryReplication.md +++ /dev/null @@ -1,210 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ContainerRegistry.dll-Help.xml -Module Name: AzureRM.ContainerRegistry -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.containerregistry/remove-azurermcontainerregistry -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerRegistry/Commands.ContainerRegistry/help/Remove-AzureRmContainerRegistryReplication.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerRegistry/Commands.ContainerRegistry/help/Remove-AzureRmContainerRegistryReplication.md ---- - -# Remove-AzureRmContainerRegistryReplication - -## SYNOPSIS -Removes a container registry replication. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameResourceGroupParameterSet (Default) -``` -Remove-AzureRmContainerRegistryReplication [-Name] <String> [-ResourceGroupName] <String> - [-RegistryName] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ReplicationObjectParameterSet -``` -Remove-AzureRmContainerRegistryReplication -Replicatoin <PSContainerRegistryReplication> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Remove-AzureRmContainerRegistryReplication -ResourceId <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmContainerRegistryReplication cmdlet removes a container registry replication. - -## EXAMPLES - -### Example 1: Removes a container registry replication. -```powershell -PS C:\> Remove-AzureRmContainerRegistryReplication -ResourceGroupName "MyResourceGroup" -RegistryName "MyRegistry" -Name "replication001" -``` - -Removes a container registry replication. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Container Registry Replication Name. -Default to the location name. - -```yaml -Type: System.String -Parameter Sets: NameResourceGroupParameterSet -Aliases: ReplicationName, ResourceName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns true if the removal was successful. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegistryName -Container Registry Name. - -```yaml -Type: System.String -Parameter Sets: NameResourceGroupParameterSet -Aliases: ContainerRegistryName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Replicatoin -Container Registry Object. - -```yaml -Type: Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistryReplication -Parameter Sets: ReplicationObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: NameResourceGroupParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The container registry replication resource id - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistryReplication -Parameters: Replicatoin (ByValue) - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[New-AzureRmContainerRegistryReplication](New-AzureRmContainerRegistryReplication.md) - -[Get-AzureRmContainerRegistryReplication](Remove-AzureRmContainerRegistryReplication.md) - diff --git a/azurermps-6.13.0/AzureRM.ContainerRegistry/Remove-AzureRmContainerRegistryWebhook.md b/azurermps-6.13.0/AzureRM.ContainerRegistry/Remove-AzureRmContainerRegistryWebhook.md deleted file mode 100644 index d91887a3f2..0000000000 --- a/azurermps-6.13.0/AzureRM.ContainerRegistry/Remove-AzureRmContainerRegistryWebhook.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ContainerRegistry.dll-Help.xml -Module Name: AzureRM.ContainerRegistry -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.containerregistry/remove-azurermcontainerregistry -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerRegistry/Commands.ContainerRegistry/help/Remove-AzureRmContainerRegistryWebhook.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerRegistry/Commands.ContainerRegistry/help/Remove-AzureRmContainerRegistryWebhook.md ---- - -# Remove-AzureRmContainerRegistryWebhook - -## SYNOPSIS -Removes a container registry webhook. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameResourceGroupParameterSet (Default) -``` -Remove-AzureRmContainerRegistryWebhook [-Name] <String> [-ResourceGroupName] <String> [-RegistryName] <String> - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### WebhookObjectParameterSet -``` -Remove-AzureRmContainerRegistryWebhook -Webhook <PSContainerRegistryWebhook> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Remove-AzureRmContainerRegistryWebhook -ResourceId <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmContainerRegistryWebhook cmdlet removes a container registry webhook. - -## EXAMPLES - -### Example 1: Remove a container registry webhook. -```powershell -PS C:\> Remove-AzureRmContainerRegistryWebhook -ResourceGroupName "MyResourceGroup" -RegistryName "MyRegistry" -Name "webhook001" -``` - -Removes a container registry webhook. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Webhook Name. - -```yaml -Type: System.String -Parameter Sets: NameResourceGroupParameterSet -Aliases: WebhookName, ResourceName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns true if the removal was successful. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegistryName -Container Registry Name. - -```yaml -Type: System.String -Parameter Sets: NameResourceGroupParameterSet -Aliases: ContainerRegistryName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: NameResourceGroupParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The container registry Webhook resource id - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Webhook -Container Registry Object. - -```yaml -Type: Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistryWebhook -Parameter Sets: WebhookObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistryWebhook -Parameters: Webhook (ByValue) - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[New-AzureRmContainerRegistryWebhook](New-AzureRmContainerRegistryWebhook.md) - -[Get-AzureRmContainerRegistryWebhook](Get-AzureRmContainerRegistryWebhook.md) - -[Update-AzureRmContainerRegistryWebhook](Update-AzureRmContainerRegistryWebhook.md) - -[Test-AzureRmContainerRegistryWebhook](Test-AzureRmContainerRegistryWebhook.md) diff --git a/azurermps-6.13.0/AzureRM.ContainerRegistry/Test-AzureRmContainerRegistryNameAvailability.md b/azurermps-6.13.0/AzureRM.ContainerRegistry/Test-AzureRmContainerRegistryNameAvailability.md deleted file mode 100644 index 732dc4d3d5..0000000000 --- a/azurermps-6.13.0/AzureRM.ContainerRegistry/Test-AzureRmContainerRegistryNameAvailability.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ContainerRegistry.dll-Help.xml -Module Name: AzureRM.ContainerRegistry -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.containerregistry/test-azurermcontainerregistrynameavailability -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerRegistry/Commands.ContainerRegistry/help/Test-AzureRmContainerRegistryNameAvailability.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerRegistry/Commands.ContainerRegistry/help/Test-AzureRmContainerRegistryNameAvailability.md ---- - -# Test-AzureRmContainerRegistryNameAvailability - -## SYNOPSIS -Checks the availability of a container registry name. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Test-AzureRmContainerRegistryNameAvailability [-Name] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Test-AzureRmContainerRegistryNameAvailability cmdlet checks whether a container registry name is valid and available to use. - -## EXAMPLES - -### Example 1: Checks the availability of a container registry name -```powershell -PS C:\>Test-AzureRmContainerRegistryNameAvailability -Name 'SomeRegistryName' - -NameAvailable Reason Message -------------- ------ ------- - True -``` - -This command checks the availability of the container registry name \`SomeRegistryName\`. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Container Registry Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ContainerRegistryName, RegistryName, ResourceName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.ContainerRegistry.Models.RegistryNameStatus - -## NOTES - -## RELATED LINKS - -[New-AzureRmContainerRegistry]() - diff --git a/azurermps-6.13.0/AzureRM.ContainerRegistry/Test-AzureRmContainerRegistryWebhook.md b/azurermps-6.13.0/AzureRM.ContainerRegistry/Test-AzureRmContainerRegistryWebhook.md deleted file mode 100644 index 0c987a7ccd..0000000000 --- a/azurermps-6.13.0/AzureRM.ContainerRegistry/Test-AzureRmContainerRegistryWebhook.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ContainerRegistry.dll-Help.xml -Module Name: AzureRM.ContainerRegistry -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.containerregistry/test-azurermcontainerregistrynameavailability -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerRegistry/Commands.ContainerRegistry/help/Test-AzureRmContainerRegistryWebhook.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerRegistry/Commands.ContainerRegistry/help/Test-AzureRmContainerRegistryWebhook.md ---- - -# Test-AzureRmContainerRegistryWebhook - -## SYNOPSIS -Triggers a webhook ping event. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceIdParameterSet (Default) -``` -Test-AzureRmContainerRegistryWebhook -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### NameResourceGroupParameterSet -``` -Test-AzureRmContainerRegistryWebhook [-Name] <String> [-ResourceGroupName] <String> [-RegistryName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### WebhookObjectParameterSet -``` -Test-AzureRmContainerRegistryWebhook -Webhook <PSContainerRegistryWebhook> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Test-AzureRmContainerRegistryWebhook cmdlet triggers a webhook ping event. - -## EXAMPLES - -### Example 1: Triggers a webhook ping event. -```powershell -PS C:\> Test-AzureRmContainerRegistryWebhook -ResourceGroupName "MyResourceGroup" -RegistryName "MyRegistry" -Name "webhook001" - -Id --- -c5950af0-c8d0-4924-9873-1ba7da5cbf83 -``` - -Triggers a webhook ping event. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Webhook Name. - -```yaml -Type: System.String -Parameter Sets: NameResourceGroupParameterSet -Aliases: WebhookName, ResourceName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegistryName -Container Registry Name. - -```yaml -Type: System.String -Parameter Sets: NameResourceGroupParameterSet -Aliases: ContainerRegistryName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: NameResourceGroupParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The container registry Webhook resource id - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Webhook -Container Registry Object. - -```yaml -Type: Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistryWebhook -Parameter Sets: WebhookObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistryWebhook -Parameters: Webhook (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistryEventInfo - -## NOTES - -## RELATED LINKS - -[New-AzureRmContainerRegistryWebhook](New-AzureRmContainerRegistryWebhook.md) - -[Get-AzureRmContainerRegistryWebhook](Get-AzureRmContainerRegistryWebhook.md) - -[Update-AzureRmContainerRegistryWebhook](Update-AzureRmContainerRegistryWebhook.md) - -[Remove-AzureRmContainerRegistryWebhook](Remove-AzureRmContainerRegistryWebhook.md) diff --git a/azurermps-6.13.0/AzureRM.ContainerRegistry/Update-AzureRmContainerRegistry.md b/azurermps-6.13.0/AzureRM.ContainerRegistry/Update-AzureRmContainerRegistry.md deleted file mode 100644 index 7c3c616a92..0000000000 --- a/azurermps-6.13.0/AzureRM.ContainerRegistry/Update-AzureRmContainerRegistry.md +++ /dev/null @@ -1,308 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ContainerRegistry.dll-Help.xml -Module Name: AzureRM.ContainerRegistry -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.containerregistry/update-azurermcontainerregistry -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerRegistry/Commands.ContainerRegistry/help/Update-AzureRmContainerRegistry.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerRegistry/Commands.ContainerRegistry/help/Update-AzureRmContainerRegistry.md ---- - -# Update-AzureRmContainerRegistry - -## SYNOPSIS -Updates a container registry. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameResourceGroupParameterSet (Default) -``` -Update-AzureRmContainerRegistry [-ResourceGroupName] <String> [-Name] <String> [-Tag <Hashtable>] - [-StorageAccountName <String>] [-Sku <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### EnableAdminUserByResourceNameParameterSet -``` -Update-AzureRmContainerRegistry [-ResourceGroupName] <String> [-Name] <String> [-EnableAdminUser] - [-Tag <Hashtable>] [-StorageAccountName <String>] [-Sku <String>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### DisableAdminUserByResourceNameParameterSet -``` -Update-AzureRmContainerRegistry [-ResourceGroupName] <String> [-Name] <String> [-DisableAdminUser] - [-Tag <Hashtable>] [-StorageAccountName <String>] [-Sku <String>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### EnableAdminUserByResourceIdParameterSet -``` -Update-AzureRmContainerRegistry [-EnableAdminUser] [-Tag <Hashtable>] [-StorageAccountName <String>] - [-Sku <String>] -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### DisableAdminUserByResourceIdParameterSet -``` -Update-AzureRmContainerRegistry [-DisableAdminUser] [-Tag <Hashtable>] [-StorageAccountName <String>] - [-Sku <String>] -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Update-AzureRmContainerRegistry [-Tag <Hashtable>] [-StorageAccountName <String>] [-Sku <String>] - -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Update-AzureRmContainerRegistry cmdlet updates a container registry. - -## EXAMPLES - -### Example 1: Enable admin user for a specified container registry -```powershell -PS C:\>Update-AzureRmContainerRegistry -ResourceGroupName "MyResourceGroup" -Name "MyRegistry" -EnableAdminUser - - Container registry location: eastus - -Registry Name Sku LoginServer CreationDate Provisioni AdminUserE StorageAccountName - ngState nabled -------------- --- ----------- ------------ ---------- ---------- ------------------ -MyRegistry Basic myregistry.azurecr.io 11/20/2017 10:05:... Succeeded True -``` - -This command enables admin user for the specified container registry. - -### Example 2: Set the storage account used by a specified container registry -```powershell -PS C:\>Update-AzureRmContainerRegistry -ResourceGroupName "MyResourceGroup" -Name "MyRegistry" -StorageAccountName "mystorageaccount" - - Container registry location: eastus - -Registry Name Sku LoginServer CreationDate Provisioni AdminUserE StorageAccountName - ngState nabled -------------- --- ----------- ------------ ---------- ---------- ------------------ -MyRegistry Basic myregistry.azurecr.io 11/20/2017 10:05:... Succeeded True mystorageaccount -``` - -This command sets the specified container registry to use an existing storage account \`mystorageaccount\` in the same subscription. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableAdminUser -Enable admin user for the container registry. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: DisableAdminUserByResourceNameParameterSet, DisableAdminUserByResourceIdParameterSet -Aliases: DisableAdmin - -Required: True -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableAdminUser -Enable admin user for the container registry. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: EnableAdminUserByResourceNameParameterSet, EnableAdminUserByResourceIdParameterSet -Aliases: EnableAdmin - -Required: True -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Container Registry Name. - -```yaml -Type: System.String -Parameter Sets: NameResourceGroupParameterSet -Aliases: ContainerRegistryName, RegistryName, ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: EnableAdminUserByResourceNameParameterSet, DisableAdminUserByResourceNameParameterSet -Aliases: ContainerRegistryName, RegistryName, ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: NameResourceGroupParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: EnableAdminUserByResourceNameParameterSet, DisableAdminUserByResourceNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The container registry resource id - -```yaml -Type: System.String -Parameter Sets: EnableAdminUserByResourceIdParameterSet, DisableAdminUserByResourceIdParameterSet, ResourceIdParameterSet -Aliases: Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -Container Registry SKU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ContainerRegistrySku, RegistrySku -Accepted values: Classic, Basic, Premium, Standard - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageAccountName -The name of an existing storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. -For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistry - -## NOTES - -## RELATED LINKS - -[New-AzureRmContainerRegistry](New-AzureRmContainerRegistry.md) - -[Get-AzureRmContainerRegistry](Get-AzureRmContainerRegistry.md) - -[Remove-AzureRmContainerRegistry](Remove-AzureRmContainerRegistry.md) - diff --git a/azurermps-6.13.0/AzureRM.ContainerRegistry/Update-AzureRmContainerRegistryCredential.md b/azurermps-6.13.0/AzureRM.ContainerRegistry/Update-AzureRmContainerRegistryCredential.md deleted file mode 100644 index 4fd4a01d76..0000000000 --- a/azurermps-6.13.0/AzureRM.ContainerRegistry/Update-AzureRmContainerRegistryCredential.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ContainerRegistry.dll-Help.xml -Module Name: AzureRM.ContainerRegistry -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.containerregistry/update-azurermcontainerregistrycredential -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerRegistry/Commands.ContainerRegistry/help/Update-AzureRmContainerRegistryCredential.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerRegistry/Commands.ContainerRegistry/help/Update-AzureRmContainerRegistryCredential.md ---- - -# Update-AzureRmContainerRegistryCredential - -## SYNOPSIS -Regenerates a login credential for a container registry. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameResourceGroupParameterSet (Default) -``` -Update-AzureRmContainerRegistryCredential [-ResourceGroupName] <String> [-Name] <String> - -PasswordName <PasswordName> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### RegistryObjectParameterSet -``` -Update-AzureRmContainerRegistryCredential -Registry <PSContainerRegistry> -PasswordName <PasswordName> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Update-AzureRmContainerRegistryCredential -PasswordName <PasswordName> -ResourceId <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Update-AzureRmContainerRegistryCredential cmdlet regenerates a login credential for a container registry. - -## EXAMPLES - -### Example 1: Regenerate a login credential for a container registry -```powershell -PS C:\>Update-AzureRmContainerRegistryCredential -ResourceGroupName "MyResourceGroup" -Name "MyRegistry" -PasswordName "Password" - -Username Password Password2 --------- -------- --------- -MyRegistry ++q/=K9+RH/+hwg2+3A=N+/w=J/12Ph9 //JRPkgxx+r+z/ztU=R//E==vum=pRKL -``` - -This command regenerates a login credential for the specified container registry. -Admin user has to be enabled for the container registry \`MyRegistry\` to regenerate login credentials. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Container Registry Name. - -```yaml -Type: System.String -Parameter Sets: NameResourceGroupParameterSet -Aliases: ContainerRegistryName, RegistryName, ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordName -The name of password to regenerate. -Allowed values: password, password2. - -```yaml -Type: Microsoft.Azure.Management.ContainerRegistry.Models.PasswordName -Parameter Sets: (All) -Aliases: -Accepted values: password, password2 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Registry -Container Registry Object. - -```yaml -Type: Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistry -Parameter Sets: RegistryObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: NameResourceGroupParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The container registry resource id - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistry -Parameters: Registry (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistryCredential - -## NOTES - -## RELATED LINKS - -[New-AzureRmContainerRegistry](New-AzureRmContainerRegistry.md) - -[Update-AzureRmContainerRegistry](Update-AzureRmContainerRegistry.md) - -[Get-AzureRmContainerRegistryCredential](Get-AzureRmContainerRegistryCredential.md) - diff --git a/azurermps-6.13.0/AzureRM.ContainerRegistry/Update-AzureRmContainerRegistryWebhook.md b/azurermps-6.13.0/AzureRM.ContainerRegistry/Update-AzureRmContainerRegistryWebhook.md deleted file mode 100644 index 3a7f408894..0000000000 --- a/azurermps-6.13.0/AzureRM.ContainerRegistry/Update-AzureRmContainerRegistryWebhook.md +++ /dev/null @@ -1,295 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ContainerRegistry.dll-Help.xml -Module Name: AzureRM.ContainerRegistry -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.containerregistry/update-azurermcontainerregistrycredential -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerRegistry/Commands.ContainerRegistry/help/Update-AzureRmContainerRegistryWebhook.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ContainerRegistry/Commands.ContainerRegistry/help/Update-AzureRmContainerRegistryWebhook.md ---- - -# Update-AzureRmContainerRegistryWebhook - -## SYNOPSIS -Updates a container registry webhook. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceIdParameterSet (Default) -``` -Update-AzureRmContainerRegistryWebhook [-Uri <Uri>] [-Action <String[]>] [-Header <Hashtable>] - [-Tag <Hashtable>] [-Status <String>] [-Scope <String>] -ResourceId <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### NameResourceGroupParameterSet -``` -Update-AzureRmContainerRegistryWebhook [-Name] <String> [-ResourceGroupName] <String> [-RegistryName] <String> - [-Uri <Uri>] [-Action <String[]>] [-Header <Hashtable>] [-Tag <Hashtable>] [-Status <String>] - [-Scope <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### WebhookObjectParameterSet -``` -Update-AzureRmContainerRegistryWebhook [-Uri <Uri>] [-Action <String[]>] -Webhook <PSContainerRegistryWebhook> - [-Header <Hashtable>] [-Tag <Hashtable>] [-Status <String>] [-Scope <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Update-AzureRmContainerRegistryWebhook cmdlet updates a container registry webhook. - -## EXAMPLES - -### Example 1: Update an existing container registry webhook. -```powershell -PS C:\>Update-AzureRmContainerRegistryWebhook -ResourceGroupName "MyResourceGroup" -RegistryName "MyRegistry" -Name "webhook001" -Uri http://www.bing.com -Action Delete,Push -Header @{SpecialHeader='headerVal'} -Tag @{Key='val'} -Status Enabled -Scope 'foo:*' - -Name Location Status Scope Actions Provisioni ServiceUri - ngState ----- -------- ------ ----- ------- ---------- ---------- -webhook001 westus enabled foo:* {push, delete} Succeeded -``` - -Update an existing container registry webhook. - -## PARAMETERS - -### -Action -Space separated list of actions that trigger the webhook to post notifications. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: WebhookActions -Accepted values: delete, push - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Header -Space separated custom headers in 'key\[=value\]' format that will be added to the webhook notifications. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: WebhookHeaders - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Webhook Name. - -```yaml -Type: System.String -Parameter Sets: NameResourceGroupParameterSet -Aliases: WebhookName, ResourceName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegistryName -Container Registry Name. - -```yaml -Type: System.String -Parameter Sets: NameResourceGroupParameterSet -Aliases: ContainerRegistryName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: NameResourceGroupParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The container registry Webhook resource id - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Scope -Webhook scope. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: WebhookScope - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Status -Webhook status - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: WebhookStatus -Accepted values: enabled, disabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Space separated tags in 'key\[=value\]' format. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Uri -The service URI for the webhook to post notifications. - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: WebhookUri - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Webhook -Container Registry Webhook Object. - -```yaml -Type: Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistryWebhook -Parameter Sets: WebhookObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistryWebhook -Parameters: Webhook (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ContainerRegistry.PSContainerRegistryWebhook - -## NOTES - -## RELATED LINKS - -[New-AzureRmContainerRegistryWebhook](New-AzureRmContainerRegistryWebhook.md) - -[Get-AzureRmContainerRegistryWebhook](Get-AzureRmContainerRegistryWebhook.md) - -[Test-AzureRmContainerRegistryWebhook](Test-AzureRmContainerRegistryWebhook.md) - -[Remove-AzureRmContainerRegistryWebhook](Remove-AzureRmContainerRegistryWebhook.md) diff --git a/azurermps-6.13.0/AzureRM.DataFactories/AzureRM.DataFactories.md b/azurermps-6.13.0/AzureRM.DataFactories/AzureRM.DataFactories.md deleted file mode 100644 index 6edb9b8ab6..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactories/AzureRM.DataFactories.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -Module Name: AzureRM.DataFactories -Module Guid: e3c0f6bc-fe96-41a0-88f4-5e490a91f05d -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories -Help Version: 4.2.2.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/AzureRM.DataFactories.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/AzureRM.DataFactories.md ---- - -# AzureRM.DataFactories Module -## Description -The cmdlets in the Azure Data Factory module enable you to manage data factories in Windows PowerShell. - -## AzureRM.DataFactories Cmdlets -### [Get-AzureRmDataFactory](Get-AzureRmDataFactory.md) -Gets information about Data Factories. - -### [Get-AzureRmDataFactoryActivityWindow](Get-AzureRmDataFactoryActivityWindow.md) -Gets information about activity windows associated with a data factory. - -### [Get-AzureRmDataFactoryDataset](Get-AzureRmDataFactoryDataset.md) -Gets information about datasets in Azure Data Factory. - -### [Get-AzureRmDataFactoryGateway](Get-AzureRmDataFactoryGateway.md) -Gets information about logical gateways in Azure Data Factory. - -### [Get-AzureRmDataFactoryGatewayAuthKey](Get-AzureRmDataFactoryGatewayAuthKey.md) -Gets gateway auth key for an Azure Data Factory. - -### [Get-AzureRmDataFactoryHub](Get-AzureRmDataFactoryHub.md) -Gets information about hubs in Azure Data Factory. - -### [Get-AzureRmDataFactoryLinkedService](Get-AzureRmDataFactoryLinkedService.md) -Gets information about linked services in Azure Data Factory. - -### [Get-AzureRmDataFactoryPipeline](Get-AzureRmDataFactoryPipeline.md) -Gets information about pipelines in Azure Data Factory. - -### [Get-AzureRmDataFactoryRun](Get-AzureRmDataFactoryRun.md) -Gets runs for a data slice of a dataset in Azure Data Factory. - -### [Get-AzureRmDataFactorySlice](Get-AzureRmDataFactorySlice.md) -Gets data slices for a dataset in Azure Data Factory. - -### [New-AzureRmDataFactory](New-AzureRmDataFactory.md) -Creates a data factory. - -### [New-AzureRmDataFactoryDataset](New-AzureRmDataFactoryDataset.md) -Creates a dataset in Data Factory. - -### [New-AzureRmDataFactoryEncryptValue](New-AzureRmDataFactoryEncryptValue.md) -Encrypts sensitive data. - -### [New-AzureRmDataFactoryGateway](New-AzureRmDataFactoryGateway.md) -Creates a gateway for an Azure Data Factory. - -### [New-AzureRmDataFactoryGatewayAuthKey](New-AzureRmDataFactoryGatewayAuthKey.md) -Creates auth key for an Azure Data Factory Gateway. - -### [New-AzureRmDataFactoryGatewayKey](New-AzureRmDataFactoryGatewayKey.md) -Creates a gateway key for an Azure Data Factory. This cmdlet is deprecated, and you should use **New-AzureRmDataFactoryGatewayAuthKey** instead. - -### [New-AzureRmDataFactoryHub](New-AzureRmDataFactoryHub.md) -Creates a hub for an Azure Data Factory. - -### [New-AzureRmDataFactoryLinkedService](New-AzureRmDataFactoryLinkedService.md) -Links a data store or a cloud service to an Azure Data Factory. - -### [New-AzureRmDataFactoryPipeline](New-AzureRmDataFactoryPipeline.md) -Creates a pipeline in Data Factory. - -### [Remove-AzureRmDataFactory](Remove-AzureRmDataFactory.md) -Removes a data factory. - -### [Remove-AzureRmDataFactoryDataset](Remove-AzureRmDataFactoryDataset.md) -Removes a dataset from Azure Data Factory. - -### [Remove-AzureRmDataFactoryGateway](Remove-AzureRmDataFactoryGateway.md) -Removes a gateway from Azure Data Factory. - -### [Remove-AzureRmDataFactoryHub](Remove-AzureRmDataFactoryHub.md) -Removes a hub from Azure Data Factory. - -### [Remove-AzureRmDataFactoryLinkedService](Remove-AzureRmDataFactoryLinkedService.md) -Removes a linked service from Azure Data Factory. - -### [Remove-AzureRmDataFactoryPipeline](Remove-AzureRmDataFactoryPipeline.md) -Removes a pipeline from Azure Data Factory. - -### [Resume-AzureRmDataFactoryPipeline](Resume-AzureRmDataFactoryPipeline.md) -Resumes a suspended pipeline in Data Factory. - -### [Save-AzureRmDataFactoryLog](Save-AzureRmDataFactoryLog.md) -Downloads log files from Azure HDInsight processing. - -### [Set-AzureRmDataFactoryGateway](Set-AzureRmDataFactoryGateway.md) -Sets the description for a gateway in Azure Data Factory. - -### [Set-AzureRmDataFactoryPipelineActivePeriod](Set-AzureRmDataFactoryPipelineActivePeriod.md) -Configures the active period for data slices. - -### [Set-AzureRmDataFactorySliceStatus](Set-AzureRmDataFactorySliceStatus.md) -Sets the status of slices for a dataset in Azure Data Factory. - -### [Suspend-AzureRmDataFactoryPipeline](Suspend-AzureRmDataFactoryPipeline.md) -Suspends a pipeline in Azure Data Factory. - diff --git a/azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactory.md b/azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactory.md deleted file mode 100644 index 7ccfb86c91..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactory.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactories.dll-Help.xml -Module Name: AzureRM.DataFactories -ms.assetid: ECE1F469-E3C3-4294-A288-8BAE851E8599 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/get-azurermdatafactory -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Get-AzureRmDataFactory.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Get-AzureRmDataFactory.md ---- - -# Get-AzureRmDataFactory - -## SYNOPSIS -Gets information about Data Factories. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmDataFactory [[-Name] <String>] [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDataFactory** cmdlet gets information about data factories in an Azure resource group. -If you specify the name of a data factory, this cmdlet gets information about that data factory. -If you do not specify a name, this cmdlet gets information about all of the data factories in an Azure resource group. - -## EXAMPLES - -### Example 1: Get all data factories -``` -PS C:\>Get-AzureRmDataFactory -ResourceGroupName "ADF" -DataFactoryName : WikiADF -ResourceGroupName : ADF -Location : WestUS -Tags : {} -Properties : Microsoft.WindowsAzure.Commands.Utilities.PSDataFactoryConfiguration - -DataFactoryName : WikiADF2 -ResourceGroupName : ADF -Location : westus -Tags : {} -Properties : Microsoft.WindowsAzure.Commands.Utilities.PSDataFactoryConfiguration -``` - -This command displays information about all data factories in the Azure subscription. - -### Example 2: Get a specific data factory -``` -PS C:\>$DataFactory = Get-AzureRmDataFactory -ResourceGroupName "ADF" -Name "WikiADF" -DataFactoryName : WikiADF -ResourceGroupName : ADF -Location : westus -Tags : {} -Properties : Microsoft.WindowsAzure.Commands.Utilities.PSDataFactoryConfiguration -``` - -This command displays information about the data factory named WikiADF in the subscription for the resource group named ADF, and then stores it in the $DataFactory variable. -Specify the *DataFactory* parameter in subsequent cmdlets to use the data factory stored in $DataFactory. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the data factory about which to get information. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet gets information about data factories that belong to the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[New-AzureRmDataFactory](./New-AzureRmDataFactory.md) - -[Remove-AzureRmDataFactory](./Remove-AzureRmDataFactory.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactoryActivityWindow.md b/azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactoryActivityWindow.md deleted file mode 100644 index bf070b1827..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactoryActivityWindow.md +++ /dev/null @@ -1,399 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactories.dll-Help.xml -Module Name: AzureRM.DataFactories -ms.assetid: F8C67F7B-64C5-45E4-A0BF-32212BEBE885 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/get-azurermdatafactoryactivitywindow -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Get-AzureRmDataFactoryActivityWindow.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Get-AzureRmDataFactoryActivityWindow.md ---- - -# Get-AzureRmDataFactoryActivityWindow - -## SYNOPSIS -Gets information about activity windows associated with a data factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Get-AzureRmDataFactoryActivityWindow [-DataFactoryName] <String> [[-DatasetName] <String>] - [[-PipelineName] <String>] [[-ActivityName] <String>] [-WindowState <String>] [-WindowSubstate <String>] - [-Filter <String>] [-OrderBy <String>] [-WindowStart <DateTime>] [-WindowEnd <DateTime>] - [-RunStart <DateTime>] [-RunEnd <DateTime>] [-Top <Int32>] [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByFactoryObject -``` -Get-AzureRmDataFactoryActivityWindow [-DataFactory] <PSDataFactory> [[-DatasetName] <String>] - [[-PipelineName] <String>] [[-ActivityName] <String>] [-WindowState <String>] [-WindowSubstate <String>] - [-Filter <String>] [-OrderBy <String>] [-WindowStart <DateTime>] [-WindowEnd <DateTime>] - [-RunStart <DateTime>] [-RunEnd <DateTime>] [-Top <Int32>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDataFactoryActivityWindow** cmdlet gets information about the activity windows associated with a data factory. - -## EXAMPLES - -### Example 1: Get activity windows associated with a data factory -``` -PS C:\>Get-AzureRmDataFactoryActivityWindow -DataFactoryName "WikiADF" -ResourceGroupName "ADF" -Top 3 -ResourceGroupName : ADF -DataFactoryName : WikiADF -PipelineName : DP_WikipediaSamplePipeline -ActivityName : BlobToSqlCopyActivity -ActivityType : Copy -LinkedServiceName : -WindowState : Waiting -WindowSubstate : ConcurrencyLimit -Duration : 00:00:00 -InputDatasets : {DA_CuratedWikiData} -OutputDatasets : {DA_WikiAggregatedData} -PercentComplete : 0 -RunAttempts : 1 -RunStart : 8/17/2016 10:05:51 PM -RunEnd : 8/17/2016 10:05:51 PM -WindowStart : 8/17/2016 6:00:00 AM -WindowEnd : 8/17/2016 7:00:00 AM - - -ResourceGroupName : ADF -DataFactoryName : WikiADF -PipelineName : DP_WikipediaSamplePipeline -ActivityName : BlobToSqlCopyActivity -ActivityType : Copy -LinkedServiceName : -WindowState : Waiting -WindowSubstate : ConcurrencyLimit -Duration : 00:00:00 -InputDatasets : {DA_CuratedWikiData} -OutputDatasets : {DA_WikiAggregatedData} -PercentComplete : 0 -RunAttempts : 1 -RunStart : 8/17/2016 10:05:51 PM -RunEnd : 8/17/2016 10:05:51 PM -WindowStart : 8/16/2016 10:00:00 PM -WindowEnd : 8/16/2016 11:00:00 PM - - -ResourceGroupName : ADF -DataFactoryName : WikiADF -PipelineName : DP_WikipediaSamplePipeline -ActivityName : WikiHiveActivity -ActivityType : HDInsightHive -LinkedServiceName : HDILinkedService -WindowState : Ready -WindowSubstate : -Duration : 00:03:37.8020000 -InputDatasets : {DA_WikipediaClickEvents} -OutputDatasets : {DA_CuratedWikiData} -PercentComplete : 100 -RunAttempts : 1 -RunStart : 8/17/2016 11:09:23 PM -RunEnd : 8/17/2016 11:13:01 PM -WindowStart : 8/17/2016 3:00:00 AM -WindowEnd : 8/17/2016 4:00:00 AM -``` - -This command gets information about all activity window associated with the data factory named WikiADF. - -## PARAMETERS - -### -ActivityName -Specifies the name of the activity. -This cmdlet gets activity windows for the activity that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataFactory -Specifies a **PSDataFactory** object returned by a cmdlet. -This cmdlet gets activity windows that belong to the data factory that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataFactoryName -Specifies the name of the data factory. -This cmdlet gets activity windows that belong to the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatasetName -Specifies the name of the dataset. -This cmdlet gets activity windows that belong to the dataset that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies the activity window expressed by using Azure Search filter grammar. -For information about the grammar, see OData Expression Syntax for Azure Searchhttps://msdn.microsoft.com/en-us/library/azure/dn798921.aspx (https://msdn.microsoft.com/en-us/library/azure/dn798921.aspx) in MSDN. -The activity windows list is filtered by the search string that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OrderBy -Specifies to order the response by one of the activity window list parameters. -This is a list of comma separated properties. -For example: WindowStart, PercentComplete. -By default, the order is ascending order (ASC). -Specify DESC if you want to order the list in descending order. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PipelineName -Specifies the name of the pipeline. -This cmdlet gets activity windows that belong to the pipeline that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. -This cmdlet gets activity windows that belong to the resource group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RunEnd -Specifies the end time of the activity window run. -This cmdlet gets activity windows whose run times fall between *RunStart* and *RunEnd* times. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RunStart -Specifies the start time of the activity window run. -This cmdlet gets activity windows whose run times fall between *RunStart* and *RunEnd* times. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Top -Specifies the maximum number of activity windows that this cmdlet returns. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowEnd -Specifies the end time of activity window. -This cmdlet gets activity windows whose times fall between *WindowStart* and *WindowEnd* times. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowStart -Specifies the start time of activity window. -This cmdlet gets activity windows whose times fall between *WindowStart* and *WindowEnd* times. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowState -Specifies the state of the activity window. -The acceptable values for this parameter are: -- None -- Waiting -- InProgress -- Ready -- Failed -- Skipped -This cmdlet gets activity windows that are in the state that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowSubstate -Specifies the substate of the activity window. -The acceptable values for this parameter are: -- Canceled -- timedOut -- Validating -This cmdlet gets activity windows that are in the substate that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory - -### System.String - -### System.Nullable`1[[System.DateTime, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSActivityWindow - -## NOTES - -## RELATED LINKS - -[Azure Data Factories Cmdlets](./AzureRM.DataFactories.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactoryDataset.md b/azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactoryDataset.md deleted file mode 100644 index 258ad8bc1b..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactoryDataset.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactories.dll-Help.xml -Module Name: AzureRM.DataFactories -ms.assetid: BB18EEF3-570A-4667-AF0E-FCEEE17B4905 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/get-azurermdatafactorydataset -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Get-AzureRmDataFactoryDataset.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Get-AzureRmDataFactoryDataset.md ---- - -# Get-AzureRmDataFactoryDataset - -## SYNOPSIS -Gets information about datasets in Azure Data Factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Get-AzureRmDataFactoryDataset [-DataFactoryName] <String> [[-Name] <String>] [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByFactoryObject -``` -Get-AzureRmDataFactoryDataset [-DataFactory] <PSDataFactory> [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDataFactoryDataset** cmdlet gets information about datasets in Azure Data Factory. -If you specify the name of a dataset, this cmdlet gets information about that dataset. -If you do not specify a name, this cmdlet gets information about all the datasets in the data factory. - -## EXAMPLES - -### Example 1: Get information about all datasets -``` -PS C:\>Get-AzureRmDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -DatasetName : DACuratedWikiData -ResourceGroupName : ADF -DataFactoryName : WikiADF -Availability : Microsoft.DataFactories.Availability -Location : -Policy : -Structure : {} - -DatasetName : DAWikipediaClickEvents -ResourceGroupName : ADF -DataFactoryName : WikiADF -Availability : Microsoft.DataFactories.Availability -Location : -Policy : -Structure : {} - -DatasetName : DAWikiAggregatedData -ResourceGroupName : ADF -DataFactoryName : WikiADF -Availability : Microsoft.DataFactories.Availability -Location : -Policy : -Structure : {} -``` - -This command gets information about all datasets in the data factory named WikiADF. - -### Example 2: Get information about a specific dataset -``` -PS C:\>Get-AzureRmDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikipediaClickEvents" -DatasetName : DAWikipediaClickEvents -ResourceGroupName : ADF -DataFactoryName : WikiADF -Availability : Microsoft.DataFactories.Availability -Location : Microsoft.DataFactories.AzureBlobLocation -Policy : Microsoft.DataFactories.Policy -Structure : {} -``` - -This command gets information about the dataset named DAWikipediaClickEvents in the data factory named WikiADF. - -### Example 3: Get the location for a specific dataset -``` -PS C:\>(Get-AzureRmDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikipediaClickEvents").Location -BlobPath : wikidatagateway/wikisampledatain/ -FilenamePrefix : -Format : -LinkedServiceName : LinkedServiceWikipediaClickEvents -PartitionBy : {} -``` - -This command gets information for the dataset named DAWikipediaClickEvents in the data factory named WikiADF, and then uses standard dot notation to view the **Location** associated with that dataset. -Alternatively, assign the output of the **Get-AzureRmDataFactoryDataset** cmdlet to a variable, and then use dot notation to view the Location property associated with the dataset object stored in that variable. - -## PARAMETERS - -### -DataFactory -Specifies a **PSDataFactory** object. -This cmdlet gets datasets that belong to the data factory that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataFactoryName -Specifies the name of a data factory. -This cmdlet gets datasets that belong to the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the dataset about which this cmdlet gets information. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet gets datasets that belong to the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataset - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[New-AzureRmDataFactoryDataset](./New-AzureRmDataFactoryDataset.md) - -[Remove-AzureRmDataFactoryDataset](./Remove-AzureRmDataFactoryDataset.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactoryGateway.md b/azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactoryGateway.md deleted file mode 100644 index 5631e96cc0..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactoryGateway.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactories.dll-Help.xml -Module Name: AzureRM.DataFactories -ms.assetid: D85FF5ED-23EA-48C7-8E61-D931713E0064 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/get-azurermdatafactorygateway -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Get-AzureRmDataFactoryGateway.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Get-AzureRmDataFactoryGateway.md ---- - -# Get-AzureRmDataFactoryGateway - -## SYNOPSIS -Gets information about logical gateways in Azure Data Factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Get-AzureRmDataFactoryGateway [-DataFactoryName] <String> [[-Name] <String>] [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByFactoryObject -``` -Get-AzureRmDataFactoryGateway [-DataFactory] <PSDataFactory> [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDataFactoryGateway** cmdlet gets information about logical gateways in Azure Data Factory. -If you specify the name of a gateway, this cmdlet gets information about that gateway. -If you do not specify a name, this cmdlet gets information about all gateways for a data factory. -If you want to add an on-premises Microsoft SQL Server as a linked service to a data factory, you must install a gateway on your on-premises computer. - -## EXAMPLES - -### Example 1: Get all logical gateways in a data factory -``` -PS C:\>Get-AzureRmDataFactoryGateway -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name : gateway1 -Description : -Version : 1.3.5338.1 -Status : Online -VersionStatus : UpToDate -CreateTime : 8/22/2014 1:40:34 AM -RegisterTime : 8/22/2014 1:41:46 AM -LastConnectTime : 8/22/2014 1:44:56 AM -ExpiryTime : -Name : gateway2 -Description : -Version : 1.3.5338.1 -Status : Offline -VersionStatus : UpToDate -CreateTime : 8/29/2014 1:46:44 AM -RegisterTime : 8/29/2014 1:48:36 AM -LastConnectTime : 8/29/2014 1:56:56 AM -ExpiryTime : -``` - -This command gets information about all logical gateways for the data factory named WikiADF in the resource group named ADF. - -### Example 2: Get a specific logical gateway in a data factory -``` -PS C:\>Get-AzureRmDataFactoryGateway -ResourceGroupName "ADF" -Name "Gateway01" -DataFactoryName "WikiADF" -Name : Gateway01 -Description : -Version : 1.3.5338.1 -Status : Online -VersionStatus : UpToDate -CreateTime : 8/22/2014 1:40:34 AM -RegisterTime : 8/22/2014 1:41:46 AM -LastConnectTime : 8/22/2014 1:44:56 AM -ExpiryTime : -``` - -This command gets information about the logical gateway named Gateway01 in the data factory named WikiADF in the resource group named ADF. - -## PARAMETERS - -### -DataFactory -Specifies a **PSDataFactory** object. -This cmdlet gets information about logical gateways in the data factory that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataFactoryName -Specifies the name of a data factory. -This cmdlet gets information about logical gateways in the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the logical gateway about which to get information. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet gets information about logical gateways that belong to the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactoryGateway - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[New-AzureRmDataFactoryGateway](./New-AzureRmDataFactoryGateway.md) - -[Remove-AzureRmDataFactoryGateway](./Remove-AzureRmDataFactoryGateway.md) - -[Set-AzureRmDataFactoryGateway](./Set-AzureRmDataFactoryGateway.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactoryGatewayAuthKey.md b/azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactoryGatewayAuthKey.md deleted file mode 100644 index 7272ffd6eb..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactoryGatewayAuthKey.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactories.dll-Help.xml -Module Name: AzureRM.DataFactories -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/get-azurermdatafactorygatewayauthkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Get-AzureRmDataFactoryGatewayAuthKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Get-AzureRmDataFactoryGatewayAuthKey.md ---- - -# Get-AzureRmDataFactoryGatewayAuthKey - -## SYNOPSIS -Gets gateway auth key for an Azure Data Factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Get-AzureRmDataFactoryGatewayAuthKey [-DataFactoryName] <String> [-GatewayName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByFactoryObject -``` -Get-AzureRmDataFactoryGatewayAuthKey [-InputObject] <PSDataFactory> [-GatewayName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDataFactoryGatewayAuthKey** cmdlet gets gateway auth key for a specified Azure Data Factory gateway. -You register the gateway with a cloud service by using this key1 or key2 of this auth key. - -## EXAMPLES - -### Example 1: Gets auth key of a gateway -``` -PS C:\> Get-AzureRmDataFactoryGatewayAuthKey -ResourceGroup ADFResource -GatewayName 'MyGateway' -DataFactoryName MyADF -Key1 : DMG@632e739e-1053-4070-9102-8591f067526e@41fcbc45-c594-4152-a8f1-fcbcd6452aea@wu@ZgBjjX6GfJcrzTQInEV9PoOqsDrqOmC - gGHqUg1THLqA= -Key2 : DMG@632e739e-1053-4070-9102-8591f067526e@41fcbc45-c594-4152-a8f1-fcbcd6452aea@wu@kFXxBdFCEBeL7LPB3hA3LqLd1uNFbyv - YmWxtV4WD3JQ= -``` - -This command gets gateway auth key for the data factory gateway named MyGateway. - -## PARAMETERS - -### -DataFactoryName -The data factory name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GatewayName -The data factory gateway name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -The data factory object - -```yaml -Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: DataFactory - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactoryGatewayAuthKey - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[New-AzureRmDataFactoryGateway](./New-AzureRmDataFactoryGateway.md) -[New-AzureRmDataFactoryGatewayAuthKey](./New-AzureRmDataFactoryGatewayAuthKey.md) - diff --git a/azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactoryHub.md b/azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactoryHub.md deleted file mode 100644 index 3cfcf0bbb2..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactoryHub.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactories.dll-Help.xml -Module Name: AzureRM.DataFactories -ms.assetid: B07FE1A2-732D-4CCF-A0DF-3CF6B91FB3F3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/get-azurermdatafactoryhub -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Get-AzureRmDataFactoryHub.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Get-AzureRmDataFactoryHub.md ---- - -# Get-AzureRmDataFactoryHub - -## SYNOPSIS -Gets information about hubs in Azure Data Factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Get-AzureRmDataFactoryHub [[-Name] <String>] [-DataFactoryName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByFactoryObject -``` -Get-AzureRmDataFactoryHub [[-Name] <String>] [-DataFactory] <PSDataFactory> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDataFactoryHub** cmdlet gets information about hubs in Azure Data Factory. -If you specify the name of a hub, this cmdlet gets information about that hub. -If you do not specify a name, this cmdlet gets information about all of the hubs in a data factory. - -## EXAMPLES - -### Example 1: Get all data hubs -``` -PS C:\>Get-AzureRmDataFactoryHub -ResourceGroupName "ADFResourceGroup" -DataFactoryName "ADFDataFactory" -``` - -This command gets all data hubs in the Azure resource group named ADFResourceGroup and the data factory named ADFDataFactory. - -### Example 2: Get a specific data hub -``` -PS C:\>Get-AzureRmDataFactoryHub -ResourceGroupName "ADFResourceGroup" -DataFactoryName "ADFDataFactory" -Name "MyDataHub" -``` - -This command gets information about the hub named MyDataHub in the Azure resource group named ADFResourceGroup and the data factory named ADFDataFactory. - -## PARAMETERS - -### -DataFactory -Specifies a **PSDataFactory** object. -This cmdlet gets information about hubs in the data factory that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataFactoryName -Specifies the name of a data factory. -This cmdlet gets information about hubs in the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the hub about which to get information. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet gets information about hubs that belong to the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSHub - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[New-AzureRmDataFactoryHub](./New-AzureRmDataFactoryHub.md) - -[Remove-AzureRmDataFactoryHub](./Remove-AzureRmDataFactoryHub.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactoryLinkedService.md b/azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactoryLinkedService.md deleted file mode 100644 index 77ef45465e..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactoryLinkedService.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactories.dll-Help.xml -Module Name: AzureRM.DataFactories -ms.assetid: DFA41A2B-7C8A-42CB-B0B6-5E6FF853EFEE -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/get-azurermdatafactorylinkedservice -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Get-AzureRmDataFactoryLinkedService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Get-AzureRmDataFactoryLinkedService.md ---- - -# Get-AzureRmDataFactoryLinkedService - -## SYNOPSIS -Gets information about linked services in Azure Data Factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Get-AzureRmDataFactoryLinkedService [-DataFactoryName] <String> [[-Name] <String>] - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByFactoryObject -``` -Get-AzureRmDataFactoryLinkedService [-DataFactory] <PSDataFactory> [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDataFactoryLinkedService** cmdlet gets information about linked services in Azure Data Factory. -If you specify the name of a linked service, this cmdlet gets information about that linked service. -If you do not specify a name, this cmdlet gets information about all the linked services in the data factory. - -## EXAMPLES - -### Example 1: Get information about all linked services -``` -PS C:\>Get-AzureRmDataFactoryLinkedService -ResourceGroupName "ADF" -DataFactoryName "WikiADF" | Format-List -``` - -This command gets information about all linked services in the data factory named WikiADF, and then passes the linked services to the Format-List cmdlet by using the pipeline operator. -That cmdlet formats the results. -For more information, type `Get-Help Format-List`. - -### Example 2: Get information about a specific linked service -``` -PS C:\>Get-AzureRmDataFactoryLinkedService -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "HDILinkedService" -LinkedServiceName ResourceGroupName DataFactoryName Properties ------------------ ----------------- --------------- ---------- -HDILinkedService ADF WikiADF Microsoft.DataFactories.HDInsightBYOCAsset -``` - -This command gets information about the linked service named HDILinkedService in the data factory named WikiADF. - -### Example 3: Get information about a specific linked service by specifying the DataFactory parameter -``` -PS C:\>$DataFactory = Get-AzureRmDataFactory -ResourceGroupName "ADF" -Name "ContosoFactory" -PS C:\> Get-AzureRmDataFactoryLinkedService -DataFactory $DataFactory | Format-Table -Property LinkedServiceName, DataFactoryName, ResourceGroupName -``` - -The first command uses the Get-AzureRmDataFactory cmdlet to get the data factory named ContosoFactory, and then stores it in the $DataFactory variable. -The second command gets information about the linked service for the data factory stored in $DataFactory, and then passes that information to the Format-Table cmdlet by using the pipeline operator. -**Format-Table** formats the output as a dataset with the specified properties as dataset columns. - -## PARAMETERS - -### -DataFactory -Specifies a **PSDataFactory** object. -This cmdlet gets linked services that belong to the data factory that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataFactoryName -Specifies the name of a data factory. -This cmdlet gets linked services that belong to the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the linked service about which to get information. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet gets linked services that belong to the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSLinkedService - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[New-AzureRmDataFactoryLinkedService](./New-AzureRmDataFactoryLinkedService.md) - -[Remove-AzureRmDataFactoryLinkedService](./Remove-AzureRmDataFactoryLinkedService.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactoryPipeline.md b/azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactoryPipeline.md deleted file mode 100644 index 2fba9ada8f..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactoryPipeline.md +++ /dev/null @@ -1,227 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactories.dll-Help.xml -Module Name: AzureRM.DataFactories -ms.assetid: 5224BDF5-D492-4160-893E-4BB5F76C22F3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/get-azurermdatafactorypipeline -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Get-AzureRmDataFactoryPipeline.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Get-AzureRmDataFactoryPipeline.md ---- - -# Get-AzureRmDataFactoryPipeline - -## SYNOPSIS -Gets information about pipelines in Azure Data Factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Get-AzureRmDataFactoryPipeline [[-Name] <String>] [-DataFactoryName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByFactoryObject -``` -Get-AzureRmDataFactoryPipeline [[-Name] <String>] [-DataFactory] <PSDataFactory> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDataFactoryPipeline** cmdlet gets information about pipelines in Azure Data Factory. -If you specify the name of a pipeline, this cmdlet gets information about that pipeline. -If you do not specify a name, this cmdlet gets information about all the pipelines in the data factory. - -## EXAMPLES - -### Example 1: Get information about all pipelines -``` -PS C:\>Get-AzureRmDataFactoryPipeline -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -``` - -This command gets information about all pipelines in the data factory named WikiADF. -You can either one of the following example commands. -The second one uses a **DataFactory** object as a parameter. - -### Example 2: Get information about a specific pipeline -``` -PS C:\>Get-AzureRmDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF" | Format-List -PipelineName : DPWikisample -ResourceGroupName : ADF -DataFactoryName : WikiADF -Properties : Microsoft.DataFactories.PipelineProperties -``` - -This command gets information about the pipeline named DPWikisample in the data factory named WikiADF. -The command passes that information to the Format-List cmdlet by using the pipeline operator. -That cmdlet formats the results. -For more information, type `Get-Help Format-List`. - -### Example 3: Get the properties for a specific pipeline -``` -PS C:\> (Get-AzureRmDataFactoryPipeline -ResourceGroupName "ADF" -Name DPWikisample -DataFactoryName "WikiADF").Properties -Activities : {WikiHiveActivity, BlobToSqlCopyActivity} -Description : DP Wikipedia Sample Pipelines -End : 6/6/2014 8:00:00 AM -IsPaused : -RuntimeInfo : Microsoft.DataFactories.PipelineRuntimeInfo -Start : 6/5/2014 8:00:00 PM -``` - -This command gets information for the pipeline named DPWikisample in the data factory named WikiADF, and then uses standard dot notation to view the **Properties** property associated with that pipeline. - -### Example 4: Get the activities for a specific pipeline -``` -PS C:\>(Get-AzureRmDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF").Properties.Activities -Transformation : Microsoft.DataFactories.HDInsightActivityProperties -Description : -Inputs : {DAWikipediaClickEvents} -LinkedServiceName : HDILinkedService -Name : WikiHiveActivity -Outputs : {DACuratedWikiData} -Policy : Microsoft.DataFactories.ActivityPolicy - -Transformation : Microsoft.DataFactories.CopyActivityProperties -Description : -Inputs : {DACuratedWikiData} -LinkedServiceName : HDILinkedService -Name : BlobToSqlCopyActivity -Outputs : {DAWikiAggregatedData} -Policy : Microsoft.DataFactories.ActivityPolicy -``` - -This command gets information for the pipeline named DPWikisample in the data factory named WikiADF, and then uses standard dot notation to view the **Activities** property associated with that pipeline. - -### Example 5: Get the runtime information for a specific pipeline -``` -PS C:\>(Get-AzureRmDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF").Properties.RuntimeInfo -DeploymentTime --------------- -6/5/2014 10:36:46 PM -``` - -This command gets information for the pipeline named DPWikisample in the data factory named WikiADF, and then uses standard dot notation to view the **RuntimeInfo** property associated with that pipeline. - -### Example 6: Get information about inputs for the first activity -``` -PS C:\>(Get-AzureRmDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF11").Properties.Activities[0].Inputs | Format-List -EndTime : -Length : -Name : DAWikipediaClickEvents -StartTime : -``` - -This command gets information for the pipeline named DPWikisample in the data factory named WikiADF, and then uses standard dot notation to view the **Activities** property associated with that pipeline. -The command displays the **Inputs** property of the first element of the **Activities** array by using **Format-List**. - -## PARAMETERS - -### -DataFactory -Specifies a **PSDataFactory** object. -This cmdlet gets pipelines that belong to the data factory that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataFactoryName -Specifies the name of a data factory. -This cmdlet gets pipelines that belong to the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the pipeline about which to get information. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet gets pipelines that belong to the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSPipeline - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[New-AzureRmDataFactoryPipeline](./New-AzureRmDataFactoryPipeline.md) - -[Remove-AzureRmDataFactoryPipeline](./Remove-AzureRmDataFactoryPipeline.md) - -[Resume-AzureRmDataFactoryPipeline](./Resume-AzureRmDataFactoryPipeline.md) - -[Set-AzureRmDataFactoryPipelineActivePeriod](./Set-AzureRmDataFactoryPipelineActivePeriod.md) - -[Suspend-AzureRmDataFactoryPipeline](./Suspend-AzureRmDataFactoryPipeline.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactoryRun.md b/azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactoryRun.md deleted file mode 100644 index d08f208c4f..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactoryRun.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactories.dll-Help.xml -Module Name: AzureRM.DataFactories -ms.assetid: 7100B5F0-A07B-4305-BF80-1F52647A03AB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/get-azurermdatafactoryrun -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Get-AzureRmDataFactoryRun.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Get-AzureRmDataFactoryRun.md ---- - -# Get-AzureRmDataFactoryRun - -## SYNOPSIS -Gets runs for a data slice of a dataset in Azure Data Factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Get-AzureRmDataFactoryRun [-DataFactoryName] <String> [-DatasetName] <String> [-StartDateTime] <DateTime> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByFactoryObject -``` -Get-AzureRmDataFactoryRun [-DataFactory] <PSDataFactory> [-DatasetName] <String> [-StartDateTime] <DateTime> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDataFactoryRun** cmdlet gets the runs for a data slice of a dataset in Azure Data Factory. -A dataset in a data factory is composed of slices over the time axis. -The width of a slice is determined by the schedule, either hourly or daily. -A run is a unit of processing for a slice. -There could be one or more runs for a slice in case of retries or in case you rerun your slice due to failures. -A slice is identified by its start time. -To obtain the start time of a slice, use the Get-AzureRmDataFactorySlice cmdlet. -For example, to get a run for the following slice, use the start time 2015-04-02T20:00:00. -ResourceGroupName : ADF -DataFactoryName : SPDataFactory0924 -DatasetName : MarketingCampaignEffectivenessBlobDataset -Start : 5/2/2014 8:00:00 PM -End : 5/3/2014 8:00:00 PM -RetryCount : 0 -Status : Ready -LatencyStatus : - -## EXAMPLES - -### Example 1: Get a dataset -``` -PS C:\>Get-AzureRmDataFactoryRun -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -DatasetName "DAWikiAggregatedData" -StartDateTime 2014-05-21T16:00:00Z -Id : a7c4913c-9623-49b3-ae1e-3e45e2b68819 -ResourceGroupName : ADF -DataFactoryName : WikiADF -DatasetName : DAWikiAggregatedData -PipelineName : 249ea141-ca00-8597-fad9-a148e5e7bdba -ActivityId : fcefe2bd-39b1-2d7a-7b35-bcc2b0432300 -ResumptionToken : a7c4913c-9623-49b3-ae1e-3e45e2b68819 -ContinuationToken : -ProcessingStartTime : 5/21/2014 5:02:41 PM -ProcessingEndTime : 5/21/2014 5:04:12 PM -PercentComplete : 100 -DataSliceStart : 5/21/2014 4:00:00 PM -DataSliceEnd : 5/21/2014 5:00:00 PM -Status : Succeeded -Timestamp : 5/21/2014 5:02:41 PM -RetryAttempt : 0 -Properties : {[errors, ]} -ErrorMessage : -``` - -This command gets all runs for slices of the dataset named DAWikiAggregatedData in the data factory named WikiADF that start from 4 PM GMT on 05/21/2014. - -## PARAMETERS - -### -DataFactory -Specifies a **PSDataFactory** object. -This cmdlet gets runs for slices that belong to the data factory that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataFactoryName -Specifies the name of a data factory. -This cmdlet gets runs for slices that belong to the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatasetName -Specifies the name of the dataset. -This cmdlet gets runs for slices that belong to the dataset that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet gets factory runs for slices that belong to the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartDateTime -Specifies the start of a time period as a **DateTime** object. -This cmdlet gets runs for the data slices that match this time period. -*StartDateTime* must be specified in the ISO8601 format, as in the following examples: -2015-01-01Z -2015-01-01T00:00:00Z -2015-01-01T00:00:00.000Z (UTC) -2015-01-01T00:00:00-08:00 (Pacific Standard Time) -The default time zone designator is UTC. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataSliceRun - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[Get-AzureRmDataFactorySlice](./Get-AzureRmDataFactorySlice.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactorySlice.md b/azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactorySlice.md deleted file mode 100644 index 7877366c75..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactories/Get-AzureRmDataFactorySlice.md +++ /dev/null @@ -1,258 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactories.dll-Help.xml -Module Name: AzureRM.DataFactories -ms.assetid: C102232A-C9C8-4CEE-8535-7C7A70057B06 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/get-azurermdatafactoryslice -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Get-AzureRmDataFactorySlice.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Get-AzureRmDataFactorySlice.md ---- - -# Get-AzureRmDataFactorySlice - -## SYNOPSIS -Gets data slices for a dataset in Azure Data Factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Get-AzureRmDataFactorySlice [[-EndDateTime] <DateTime>] [-DataFactoryName] <String> [-DatasetName] <String> - [-StartDateTime] <DateTime> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByFactoryObject -``` -Get-AzureRmDataFactorySlice [[-EndDateTime] <DateTime>] [-DataFactory] <PSDataFactory> [-DatasetName] <String> - [-StartDateTime] <DateTime> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDataFactorySlice** cmdlet gets data slices for a dataset in Azure Data Factory. -Specify a start time and an end time to define a range of data slices to view. -The status of a data slice is one of the following values: -- PendingExecution. -Data processing has not started. -- InProgress. -Data processing is in progress. -- Ready. -Data processing is completed. -The data slice is ready for dependent slices to consume it. -- Failed. -The run that produces the slice failed. -- Skip. -Data Factory skips processing of the slice. -- Retry. -Data Factory retries the run that produces the slice. -- Timed Out. -Data processing has timed out. -- PendingValidation. -Data slice is waiting for validation before it is processed. -- Retry Validation. -Data Factory retries the validation of the slice. -- Failed Validation. -Validation of the slice failed. -For each of the slices, you can see more information about the run that produces the slice by using the Get-AzureRmDataFactoryRun cmdlet. - -## EXAMPLES - -### Example 1: Get data slices for a dataset -``` -PS C:\>Get-AzureRmDataFactorySlice -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -DatasetName "DAWikiAggregatedData" -StartDateTime 2014-05-20T10:00:00Z -ResourceGroupName : ADF -DataFactoryName : WikiADF -DatasetName : DAWikiAggregatedData -Start : 5/21/2014 1:00:00 AM -End : 5/21/2014 2:00:00 AM -RetryCount : 0 -Status : Ready - -ResourceGroupName : ADF -DataFactoryName : WikiADF -DatasetName : DAWikiAggregatedData -Start : 5/21/2014 2:00:00 AM -End : 5/21/2014 3:00:00 AM -RetryCount : 0 -Status : Ready - -. . . - -ResourceGroupName : ADF -DataFactoryName : WikiADF -DatasetName : DAWikiAggregatedData -Start : 5/21/2014 8:00:00 PM -End : 5/21/2014 9:00:00 PM -RetryCount : 0 -Status : PendingExecution - -ResourceGroupName : ADF -DataFactoryName : WikiADF -DatasetName : DAWikiAggregatedData -Start : 5/21/2014 9:00:00 PM -End : 5/21/2014 10:00:00 PM -RetryCount : 0 -Status : PendingExecution - -. . . -``` - -This command gets all the data slices for the dataset named WikiAggregatedData in the data factory named WikiADF. -The command gets slices produced after the time that the StartDateTime parameter specifies. -The following example code sets the availability for this dataset every hour in the JavaScript Object Notation (JSON) file. - availability: - { - period: "Hour", - periodMultiplier: 1 - } - Some of the results are Ready and others are PendingExecution. -Ready slices have already run. -The pending slices are waiting to run at the end of each hour in the interval that the Set-AzureRmDataFactoryPipelineActivePeriod cmdlet specifies. -In this example, both start and end periods for the pipeline and the slice have a value of one day (24 hours). - -## PARAMETERS - -### -DataFactory -Specifies a **PSDataFactory** object. -This cmdlet gets slices that belong to the data factory that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataFactoryName -Specifies the name of a data factory. -This cmdlet gets slices that belong to the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatasetName -Specifies the name of the dataset for which this cmdlet gets slices. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndDateTime -Specifies the end of a time period as a **DateTime** object. -This cmdlet gets slices produced before the time that this parameter specifies. -For more information about **DateTime** objects, type `Get-Help Get-Date`. -*EndDateTime* must be specified in the ISO8601 format as in the following examples: -2015-01-01Z -2015-01-01T00:00:00Z -2015-01-01T00:00:00.000Z (UTC) -2015-01-01T00:00:00-08:00 (Pacific Standard Time) -The default time zone designator is UTC. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet gets slices that belong to the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartDateTime -Specifies the start of a time period as a **DateTime** object. -This cmdlet gets slices produced after the time that this parameter specifies. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataSlice - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[Set-AzureRmDataFactorySliceStatus](./Set-AzureRmDataFactorySliceStatus.md) - -[Get-AzureRmDataFactoryRun](./Get-AzureRmDataFactoryRun.md) - -[Set-AzureRmDataFactoryPipelineActivePeriod](./Set-AzureRmDataFactoryPipelineActivePeriod.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactory.md b/azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactory.md deleted file mode 100644 index 27dcc548ee..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactory.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactories.dll-Help.xml -Module Name: AzureRM.DataFactories -ms.assetid: 7B18FA1B-F616-4479-B2F0-620FC0E3E962 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/new-azurermdatafactory -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/New-AzureRmDataFactory.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/New-AzureRmDataFactory.md ---- - -# New-AzureRmDataFactory - -## SYNOPSIS -Creates a data factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmDataFactory [-Name] <String> [-Location] <String> [[-Tag] <Hashtable>] [-Force] - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmDataFactory** cmdlet creates a data factory with the specified resource group name and location. -Perform these operations in the following order: -- Create a data factory. -- Create linked services. -- Create datasets. -- Create a pipeline. - -## EXAMPLES - -### Example 1: Create a data factory -``` -PS C:\>New-AzureRmDataFactory -ResourceGroupName "ADF" -Name "WikiADF" -Location "WestUS" -DataFactoryName : WikiADF -ResourceGroupName : ADF -Location : WestUS -Tags : {} -Properties : Microsoft.WindowsAzure.Commands.Utilities.PSDataFactoryConfiguration -``` - -This command creates a data factory named WikiADF in the resource group named ADF in the WestUS location. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Indicates that this cmdlet replaces an existing data factory without prompting you for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location for the data factory, such as WestUS or EastUS. -Only WestUS is currently supported. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the data factory to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet creates a data factory that belongs to the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -The tags of the data factory. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[Get-AzureRmDataFactory](./Get-AzureRmDataFactory.md) - -[Remove-AzureRmDataFactory](./Remove-AzureRmDataFactory.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactoryDataset.md b/azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactoryDataset.md deleted file mode 100644 index 54dbe96c28..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactoryDataset.md +++ /dev/null @@ -1,272 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactories.dll-Help.xml -Module Name: AzureRM.DataFactories -ms.assetid: 352A4B94-E433-413B-91D1-6AA347563959 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/new-azurermdatafactorydataset -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/New-AzureRmDataFactoryDataset.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/New-AzureRmDataFactoryDataset.md ---- - -# New-AzureRmDataFactoryDataset - -## SYNOPSIS -Creates a dataset in Data Factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -New-AzureRmDataFactoryDataset [-DataFactoryName] <String> [[-Name] <String>] [-File] <String> [-Force] - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByFactoryObject -``` -New-AzureRmDataFactoryDataset [-DataFactory] <PSDataFactory> [[-Name] <String>] [-File] <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmDataFactoryDataset** cmdlet creates a dataset in Azure Data Factory. -If you specify a name for a dataset that already exists, this cmdlet prompts you for confirmation before it replaces the dataset. -If you specify the *Force* parameter, the cmdlet replaces the existing dataset without confirmation. -Perform these operations in the following order: -- Create a data factory. -- Create linked services. -- Create datasets. -- Create a pipeline. -If a dataset with the same name already exists in the data factory, this cmdlet prompts you to confirm whether to overwrite the existing dataset with the new dataset. -If you confirm to overwrite the existing dataset, the dataset definition is also replaced. - -## EXAMPLES - -### Example 1: Create a dataset -``` -PS C:\>New-AzureRmDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikipediaClickEvents" -File "C:\\samples\\WikiSample\\DA_WikipediaClickEvents.json" -DatasetName : DAWikipediaClickEvents -ResourceGroupName : ADF -DataFactoryName : WikiADF -Availability : Microsoft.DataFactories.Availability -Location : Microsoft.DataFactories.AzureBlobLocation -Policy : Microsoft.DataFactories.Policy -Structure : {} -``` - -This command creates a dataset named DA_WikipediaClickEvents in the data factory named WikiADF. -The command bases the dataset on information in the DAWikipediaClickEvents.json file. - -### Example 2: View availability for a new dataset -``` -PS C:\>$Dataset = New-AzureRmDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikipediaClickEvents" -File "C:\\samples\\WikiSample\\DA_WikipediaClickEvents.json" -PS C:\> $Dataset.Availability -AnchorDateTime : -Frequency : Hour -Interval : 1 -Offset : -WaitOnExternal : Microsoft.DataFactories.WaitOnExternal -``` - -The first command creates a dataset named DA_WikipediaClickEvents, as in a previous example, and then assigns that dataset to the $Dataset variable. -The second command uses standard dot notation to display details about the Availability property of the dataset. - -### Example 3: View location for a new dataset -``` -PS C:\>$Dataset = New-AzureRmDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikipediaClickEvents" -File "C:\\samples\\WikiSample\\DA_WikipediaClickEvents.json" -PS C:\> $Dataset.Location -BlobPath : wikidatagateway/wikisampledatain/ -FilenamePrefix : -Format : -LinkedServiceName : LinkedServiceWikipediaClickEvents -PartitionBy : {} -``` - -The first command creates a dataset named DA_WikipediaClickEvents, as in a previous example, and then assigns that dataset to the $Dataset variable. -The second command displays details about the Location property of the dataset. - -### Example 4: View validation rules for a new dataset -``` -PS C:\>$Dataset = New-AzureRmDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikipediaClickEvents" -File "C:\\samples\\WikiSample\\DA_WikipediaClickEvents.json" -PS C:\> $Dataset.Policy.Validation | Format-List $dataset.Location -BlobPath : wikidatagateway/wikisampledatain/ -FilenamePrefix : -Format : -LinkedServiceName : LinkedServiceWikipediaClickEvents -PartitionBy : {} - -MinimumRows : -MinimumSizeMB : 1 -``` - -The first command creates a dataset named DA_WikipediaClickEvents, as in a previous example, and then assigns that dataset to the $Dataset variable. -The second command gets details about the validation rules for the dataset, and then passes them to the Format-List cmdlet by using the pipeline operator. -That Windows PowerShell cmdlet formats the results. -For more information, type `Get-Help Format-List`. - -## PARAMETERS - -### -DataFactory -Specifies a **PSDataFactory** object. -This cmdlet creates a dataset in the data factory that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataFactoryName -Specifies the name of a data factory. -This cmdlet creates a dataset in the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -File -Specifies the full path of the JavaScript Object Notation (JSON) file that contains the description of the dataset. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Indicates that this cmdlet replaces an existing dataset without prompting you for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the dataset to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet creates a dataset in the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataset - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[Get-AzureRmDataFactoryDataset](./Get-AzureRmDataFactoryDataset.md) - -[Remove-AzureRmDataFactoryDataset](./Remove-AzureRmDataFactoryDataset.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactoryEncryptValue.md b/azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactoryEncryptValue.md deleted file mode 100644 index 765b58b05b..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactoryEncryptValue.md +++ /dev/null @@ -1,325 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactories.dll-Help.xml -Module Name: AzureRM.DataFactories -ms.assetid: 5BF24BC2-DEB6-4830-BDEA-841BAB070388 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/new-azurermdatafactoryencryptvalue -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/New-AzureRmDataFactoryEncryptValue.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/New-AzureRmDataFactoryEncryptValue.md ---- - -# New-AzureRmDataFactoryEncryptValue - -## SYNOPSIS -Encrypts sensitive data. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -New-AzureRmDataFactoryEncryptValue [-DataFactoryName] <String> [[-Value] <SecureString>] - [[-GatewayName] <String>] [[-Credential] <PSCredential>] [[-Type] <String>] [[-NonCredentialValue] <String>] - [[-AuthenticationType] <String>] [[-Server] <String>] [[-Database] <String>] [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByFactoryObject -``` -New-AzureRmDataFactoryEncryptValue [-DataFactory] <PSDataFactory> [[-Value] <SecureString>] - [[-GatewayName] <String>] [[-Credential] <PSCredential>] [[-Type] <String>] [[-NonCredentialValue] <String>] - [[-AuthenticationType] <String>] [[-Server] <String>] [[-Database] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmDataFactoryEncryptValue** cmdlet encrypts sensitive data, such as a password or a Microsoft SQL Server connection string, and returns an encrypted value. - -## EXAMPLES - -### Example 1: Encrypt a non-ODBC connection string -``` -PS C:\>$Value = ConvertTo-SecureString 'Data Source=ContosoServer;Initial Catalog=catelog;user id =user123;password=password123' -AsPlainText -Force -PS C:\> New-AzureRmDataFactoryEncryptValue -GatewayName "WikiGateway" -DataFactoryName "WikiAdf" -Value $value -ResourceGroupName "ADF" -Type OnPremisesSqlLinkedService -``` - -The first command uses the ConvertTo-SecureString cmdlet to convert the specified connection string to a **SecureString** object, and then stores that object in the $Value variable. -For more information, type `Get-Help ConvertTo-SecureString`. -Allowed values: SQL Server or Oracle connection string. -The second command creates an encrypted value for the object stored in $Value for the specified data factory, gateway, resource group, and linked service type. - -### Example 2: Encrypt a non-ODBC connection string that uses Windows authentication. -``` -PS C:\>$Value = ConvertTo-SecureString 'Data Source=ContosoServer;Initial Catalog=catelog;Integrated Security=True' -AsPlainText -Force -PS C:\> $Credential = Get-Credential -PS C:\> New-AzureRmDataFactoryEncryptValue -DataFactoryName "WikiADF" -GatewayName "WikiGateway" -ResourceGroupName "ADF" -Value $Value -Credential $Credential -Type OnPremisesSqlLinkedService $Value = ConvertTo-SecureString 'Data Source=ContosoServer;Initial Catalog=catelog;Integrated Security=True' -AsPlainText -Force -``` - -The first command uses **ConvertTo-SecureString** to convert the specified connection string to a secure string object, and then stores that object in the $Value variable. -The second command uses the Get-Credential cmdlet to collect the windows authentication (user name and password), and then stores that **PSCredential** object in the $Credential variable. -For more information, type `Get-Help Get-Credential`. -The third command creates an encrypted value for the object stored in $Value and $Credential for the specified data factory, gateway, resource group, and linked service type. - -### Example 3: Encrypt server name and credentials for File system linked service -``` -PS C:\>$Value = ConvertTo-SecureString '\\servername' -AsPlainText -Force -PS C:\> $Credential = Get-Credential -PS C:\> New-AzureRmDataFactoryEncryptValue -DataFactoryName "WikiADF" -GatewayName "WikiGateway" -ResourceGroupName "ADF" -Value $Value -Credential $Credential -Type OnPremisesFileSystemLinkedService -``` - -The first command uses **ConvertTo-SecureString** to convert the specified string to a secure string, and then stores that object in the $Value variable. -The second command uses **Get-Credential** to collect the windows authentication (user name and password), and then stores that **PSCredential** object in the $Credential variable. -The third command creates an encrypted value for the object stored in $Value and $Credential for the specified data factory, gateway, resource group, and linked service type. - -### Example 4: Encrypt credentials for HDFS linked service -``` -PS C:\>$UserName = ConvertTo-SecureString "domain\\username" -AsPlainText -Force -$Password = ConvertTo-SecureString "password" -AsPlainText -Force -$Credential = New-Object System.Management.Automation.PSCredential ($UserName, $Password) -New-AzureRmDataFactoryEncryptValue -DataFactoryName "MyDataFactory" -ResourceGroupName "MyResourceGroup" -GatewayName "MyDataManagementGateway" -Type HdfsLinkedService -AuthenticationType Windows -Credential $Credential -NonCredentialValue "http://server01.com:50070/webhdfs/v1/user/username" -``` - -The **ConvertTo-SecureString** command converts the specified string to a secure string. -The **New-Object** command creates a PSCredential object using the secure username and password strings. -Instead, you could use the **Get-Credential** command to collect windows authentication (user name and password), and then store the returned **PSCredential** object in the $credential variable as shown in previous examples. -The **New-AzureRmDataFactoryEncryptValue** command creates an encrypted value for the object stored in $Credential for the specified data factory, gateway, resource group, and linked service type. - -### Example 5: Encrypt credentials for ODBC linked service -``` -PS C:\>$Content = ConvertTo-SecureString "UID=username@contoso;PWD=password;" -AsPlainText -Force -New-AzureRmDataFactoryEncryptValue -ResourceGroupName $RGName -DataFactoryName $DFName -GatewayName $Gateway -Type OnPremisesOdbcLinkedService -AuthenticationType Basic -NonCredentialValue "Driver={SQL Server};Server=server01.database.contoso.net; Database=HDISScenarioTest;" -Value $content -``` - -The **ConvertTo-SecureString** command converts the specified string to a secure string. -The **New-AzureRmDataFactoryEncryptValue** command creates an encrypted value for the object stored in $Value for the specified data factory, gateway, resource group, and linked service type. - -## PARAMETERS - -### -AuthenticationType -Specifies the type of authentication to be used to connect to the data source. -The acceptable values for this parameter are: -- Windows -- Basic -- Anonymous. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Windows, Basic, Anonymous - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the Windows authentication credentials (user name and password) to be used. -This cmdlet encrypts the credential data you specify here. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Database -Specifies the database name of the linked service. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataFactory -Specifies a **PSDataFactory** object. -This cmdlet encrypts data for the data factory that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataFactoryName -Specifies the name of a data factory. -This cmdlet encrypts data for the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GatewayName -Specifies the name of the gateway. -This cmdlet encrypts data for the gateway that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NonCredentialValue -Specifies the non-credential part of the Open Database Connectivity (ODBC) connection string. -This parameter is applicable only for the ODBC linked service. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet encrypts data for the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Server -Specifies the server name of the linked service. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the linked service type. -This cmdlet encrypts data for the linked service type that this parameter specifies. -The acceptable values for this parameter are: -- OnPremisesSqlLinkedService -- OnPremisesFileSystemLinkedService -- OnPremisesOracleLinkedService -- OnPremisesOdbcLinkedService -- OnPremisesPostgreSqlLinkedService -- OnPremisesTeradataLinkedService -- OnPremisesMySQLLinkedService -- OnPremisesDB2LinkedService -- OnPremisesSybaseLinkedService - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: OnPremisesSqlLinkedService, OnPremisesFileSystemLinkedService, OnPremisesOracleLinkedService, OnPremisesOdbcLinkedService, OnPremisesPostgreSqlLinkedService, OnPremisesTeradataLinkedService, OnPremisesMySQLLinkedService, OnPremisesDB2LinkedService, OnPremisesSybaseLinkedService, HdfsLinkedService - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Value -Specifies the value to encrypt. -For an on-premises SQL Server linked service and an on-premises Oracle linked service, use a connection string. -For an on-premises ODBC linked service, use the credential part of the connection string. -For on premises file system linked service, if the file system is local to the gateway computer, use Local or localhost, and if the file system is on a server different from the gateway computer, use \\\\servername. - -```yaml -Type: System.Security.SecureString -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory - -### System.String - -## OUTPUTS - -### System.String - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[New-AzureRmDataFactoryEncryptValue](./New-AzureRmDataFactoryEncryptValue.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactoryGateway.md b/azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactoryGateway.md deleted file mode 100644 index 8f1d742ce0..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactoryGateway.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactories.dll-Help.xml -Module Name: AzureRM.DataFactories -ms.assetid: 4DCF54BA-CFFA-4555-8CA3-66B98F704EFB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/new-azurermdatafactorygateway -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/New-AzureRmDataFactoryGateway.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/New-AzureRmDataFactoryGateway.md ---- - -# New-AzureRmDataFactoryGateway - -## SYNOPSIS -Creates a gateway for an Azure Data Factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -New-AzureRmDataFactoryGateway [-DataFactoryName] <String> [-Name] <String> [[-Description] <String>] - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByFactoryObject -``` -New-AzureRmDataFactoryGateway [-DataFactory] <PSDataFactory> [-Name] <String> [[-Description] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmDataFactoryGateway** cmdlet creates a gateway in Azure Data Factory. - -## EXAMPLES - -### Example 1: Create a gateway -``` -PS C:\>New-AzureRmDataFactoryGateway -ResourceGroupName "ADF" -Name "ContosoGateway" -DataFactoryName "WikiADF" -Description "my gateway" -Name : ContosoGateway -Description : my gateway -Version : -Status : NeedRegistration -VersionStatus : None -CreateTime : 8/22/2014 1:40:34 AM -RegisterTime : -LastConnectTime : -ExpiryTime : -ProvisioningState : Succeeded -Key : ADF#40cbb3d9-2736-4794-a8a6-e6b839b4894f@a2d875ce-c9d7-4b8b-ad65-dd3ebbb9a940@8c0d1801-e863-44af-82e6-fb2f0c00f2ae@xz#Y9R0NhAeH3u7wgnrJyiWj4Y/QIhH4fFilIdzZgwsVQA= -``` - -This command creates a gateway named ContosoGateway in the data factory named WikiADF in the resource group named ADF. - -## PARAMETERS - -### -DataFactory -Specifies a **PSDataFactory** object. -This cmdlet creates a gateway for the data factory that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataFactoryName -Specifies the name of a data factory. -This cmdlet creates a gateway for the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the gateway. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the gateway to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet creates a gateway that belongs to the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactoryGateway - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[Remove-AzureRmDataFactoryGateway](./Remove-AzureRmDataFactoryGateway.md) - -[Set-AzureRmDataFactoryGateway](./Set-AzureRmDataFactoryGateway.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactoryGatewayAuthKey.md b/azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactoryGatewayAuthKey.md deleted file mode 100644 index 9af0d4c476..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactoryGatewayAuthKey.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactories.dll-Help.xml -Module Name: AzureRM.DataFactories -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/new-azurermdatafactorygatewayauthkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/New-AzureRmDataFactoryGatewayAuthKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/New-AzureRmDataFactoryGatewayAuthKey.md ---- - -# New-AzureRmDataFactoryGatewayAuthKey - -## SYNOPSIS -Creates auth key for an Azure Data Factory Gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -New-AzureRmDataFactoryGatewayAuthKey [-DataFactoryName] <String> [-GatewayName] <String> [-KeyName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByFactoryObject -``` -New-AzureRmDataFactoryGatewayAuthKey [-InputObject] <PSDataFactory> [-GatewayName] <String> [-KeyName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmDataFactoryGatewayAuthKey** cmdlet creates gateway auth key for a specified Azure Data Factory gateway. -You register the gateway with a cloud service by using this key. - -## EXAMPLES - -### Example 1: Creates a gateway auth key for Key1 -``` -PS C:\> New-AzureRmDataFactoryGatewayAuthKey -ResourceGroup ADFResource -GatewayName 'MyGateway' -DataFactoryName MyADF -KeyName key1 -Key1 : DMG@632e739e-1053-4070-9102-8591f067526e@41fcbc45-c594-4152-a8f1-fcbcd6452aea@wu@BH0EV9hu/o2IYGQzfYYD203XhdS6Tty - fkYwYFbG6wBU= -Key2 : -``` - -This command creates a gateway auth key of Key1 for the data factory gateway named MyGateway. - -## PARAMETERS - -### -DataFactoryName -The data factory name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GatewayName -The data factory gateway name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -The data factory object - -```yaml -Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: DataFactory - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -KeyName -The name of gateway auth key to be regenerated, either 'key1' or 'key2'. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: key1, key2 - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactoryGatewayAuthKey - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[New-AzureRmDataFactoryGateway](./New-AzureRmDataFactoryGateway.md) -[Get-AzureRmDataFactoryGatewayAuthKey](./Get-AzureRmDataFactoryGatewayAuthKey.md) - diff --git a/azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactoryGatewayKey.md b/azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactoryGatewayKey.md deleted file mode 100644 index 317b839d51..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactoryGatewayKey.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactories.dll-Help.xml -Module Name: AzureRM.DataFactories -ms.assetid: 8546C3FE-5396-4027-BF33-F98F6C018A67 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/new-azurermdatafactorygatewaykey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/New-AzureRmDataFactoryGatewayKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/New-AzureRmDataFactoryGatewayKey.md ---- - -# New-AzureRmDataFactoryGatewayKey - -## SYNOPSIS -Creates a gateway key for an Azure Data Factory. This cmdlet is deprecated, and you should use **New-AzureRmDataFactoryGatewayAuthKey** instead. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -New-AzureRmDataFactoryGatewayKey [-DataFactoryName] <String> [-GatewayName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByFactoryObject -``` -New-AzureRmDataFactoryGatewayKey [-DataFactory] <PSDataFactory> [-GatewayName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmDataFactoryGatewayKey** cmdlet creates a gateway key for a specified Azure Data Factory gateway. -You register the gateway with a cloud service by using this key. This cmdlet is deprecated, and you should use **New-AzureRmDataFactoryGatewayAuthKey** instead. - -## EXAMPLES - -### Example 1: Create a gateway key -``` -PS C:\>New-AzureRmDataFactoryGatewayKey -ResourceGroupName "ADF" -GatewayName "ContosoGateway" -DataFactoryName "WikiADF" | Format-List -GatewayKey : ADF#40cbb3d9-2736-4794-a8a6-e6b839b4894f@a2d875ce-c9d7-4b8b-ad65-dd3ebbb9a940@8c0d1801-e863-44af-82e6-fb2f0c00f2ae@xz#Y9R0NhAeH3u7wgnrJyiWj4Y/QIhH4fFilIdzZgwsVQA= -``` - -This command creates a gateway key for the data factory gateway named ContosoGateway, and then passes the gateway key to the Format-List cmdlet by using the pipeline operator. -For more information, type `Get-Help Format-List`. - -## PARAMETERS - -### -DataFactory -Specifies a **PSDataFactory** object. -This cmdlet creates a gateway key for the data factory that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataFactoryName -Specifies the name of a data factory. -This cmdlet creates a gateway key for the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GatewayName -Specifies the name of the gateway. -This cmdlet creates a key for the gateway that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet creates a key for a gateway that belongs to the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactoryGatewayKey - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[New-AzureRmDataFactoryGateway](./New-AzureRmDataFactoryGateway.md) -[Get-AzureRmDataFactoryGatewayAuthKey](./Get-AzureRmDataFactoryGatewayAuthKey.md) -[New-AzureRmDataFactoryGatewayAuthKey](./New-AzureRmDataFactoryGatewayAuthKey.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactoryHub.md b/azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactoryHub.md deleted file mode 100644 index 917c6ed446..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactoryHub.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactories.dll-Help.xml -Module Name: AzureRM.DataFactories -ms.assetid: B656B4C4-97DE-4F9F-937C-E115CB3F0E80 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/new-azurermdatafactoryhub -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/New-AzureRmDataFactoryHub.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/New-AzureRmDataFactoryHub.md ---- - -# New-AzureRmDataFactoryHub - -## SYNOPSIS -Creates a hub for an Azure Data Factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -New-AzureRmDataFactoryHub [-Name] <String> [-File] <String> [-Force] [-DataFactoryName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByFactoryObject -``` -New-AzureRmDataFactoryHub [-Name] <String> [-File] <String> [-Force] [-DataFactory] <PSDataFactory> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmDataFactoryHub** cmdlet creates a hub for Azure Data Factory in the specified Azure resource group and in the specified data factory with the specified file definition. -After you create the hub, you can use it to store and manage linked services in a group, and you can add pipelines to the hub. - -## EXAMPLES - -### Example 1: Create a hub -``` -PS C:\>New-AzureRmDataFactoryHub -ResourceGroupName "ADFResourceGroup" -DataFactoryName "ADFDataFactory" -Name "ContosoDataHub" -File "C:\Hub.json" -``` - -This command creates a hub named ContosoDataHub in the resource group ADFResourceGroup and the data factory named ADFDataFactory. - -## PARAMETERS - -### -DataFactory -Specifies a **PSDataFactory** object. -This cmdlet creates a hub for the data factory that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataFactoryName -Specifies the name of a data factory. -This cmdlet creates a hub for the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -File -Specifies the full path of the JavaScript Object Notation (JSON) file that contains the description of the hub. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Indicates that this cmdlet replaces an existing hub without prompting you for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the hub to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet creates a hub that belongs to the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSHub - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[Get-AzureRmDataFactoryHub](./Get-AzureRmDataFactoryHub.md) - -[Remove-AzureRmDataFactoryHub](./Remove-AzureRmDataFactoryHub.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactoryLinkedService.md b/azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactoryLinkedService.md deleted file mode 100644 index 70e890e781..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactoryLinkedService.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactories.dll-Help.xml -Module Name: AzureRM.DataFactories -ms.assetid: 8CD2BE3E-2FA1-4EAB-BC01-B1E1E3203FF1 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/new-azurermdatafactorylinkedservice -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/New-AzureRmDataFactoryLinkedService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/New-AzureRmDataFactoryLinkedService.md ---- - -# New-AzureRmDataFactoryLinkedService - -## SYNOPSIS -Links a data store or a cloud service to an Azure Data Factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -New-AzureRmDataFactoryLinkedService [-DataFactoryName] <String> [[-Name] <String>] [-File] <String> [-Force] - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByFactoryObject -``` -New-AzureRmDataFactoryLinkedService [-DataFactory] <PSDataFactory> [[-Name] <String>] [-File] <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmDataFactoryLinkedService** cmdlet links a data store or a cloud service to Azure Data Factory. -If you specify a name for a linked service that already exists, this cmdlet prompts you for confirmation before it replaces the linked service. -If you specify the *Force* parameter, the cmdlet replaces the existing linked service without confirmation. -Perform these operations in the following order: -- Create a data factory. -- Create linked services. -- Create datasets. -- Create a pipeline. - -## EXAMPLES - -### Example 1: Create a linked service -``` -PS C:\>New-AzureRmDataFactoryLinkedService -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "LinkedServiceCuratedWikiData" -File "C:\\samples\\WikiSample\\LinkedServiceCuratedWikiData.json" | Format-List -LinkedServiceName : LinkedServiceCuratedWikiData -ResourceGroupName : ADF -DataFactoryName : WikiADF -Properties : Microsoft.DataFactories.AzureStorageLinkedService -``` - -This command creates a linked service named LinkedServiceCuratedWikiData in the data factory named WikiADF. -This linked service links an Azure blob store specified in the file to the data factory named WikiADF. -The command passes the result to the Format-List cmdlet by using the pipeline operator. -That Windows PowerShell cmdlet formats the results. -For more information, type `Get-Help Format-List`. - -## PARAMETERS - -### -DataFactory -Specifies a **PSDataFactory** object. -This cmdlet creates a linked service for the data factory that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataFactoryName -Specifies the name of a data factory. -This cmdlet creates a linked service for the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -File -Specifies the full path of the JavaScript Object Notation (JSON) file that contains the description of the linked service. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Indicates that this cmdlet replaces an existing linked service without prompting you for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the linked service to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet creates a linked service for the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSLinkedService - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[Get-AzureRmDataFactoryLinkedService](./Get-AzureRmDataFactoryLinkedService.md) - -[Remove-AzureRmDataFactoryLinkedService](./Remove-AzureRmDataFactoryLinkedService.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactoryPipeline.md b/azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactoryPipeline.md deleted file mode 100644 index 7a97e82622..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactories/New-AzureRmDataFactoryPipeline.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactories.dll-Help.xml -Module Name: AzureRM.DataFactories -ms.assetid: 30C1AF6C-A8DC-4CA0-9E5F-10641A29D0E8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/new-azurermdatafactorypipeline -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/New-AzureRmDataFactoryPipeline.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/New-AzureRmDataFactoryPipeline.md ---- - -# New-AzureRmDataFactoryPipeline - -## SYNOPSIS -Creates a pipeline in Data Factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -New-AzureRmDataFactoryPipeline [[-Name] <String>] [-DataFactoryName] <String> [-File] <String> [-Force] - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByFactoryObject -``` -New-AzureRmDataFactoryPipeline [[-Name] <String>] [-DataFactory] <PSDataFactory> [-File] <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmDataFactoryPipeline** cmdlet creates a pipeline in Azure Data Factory. -If you specify a name for a pipeline that already exists, the cmdlet prompts you for confirmation before it replaces the pipeline. -If you specify the *Force* parameter, the cmdlet replaces the existing pipeline without confirmation. -Perform these operations in the following order: -- Create a data factory. -- Create linked services. -- Create datasets. -- Create a pipeline. -If a pipeline with the same name already exists in the data factory, this cmdlet prompts you to confirm whether to overwrite the existing pipeline with the new pipeline. -If you confirm to overwrite the existing pipeline, the pipeline definition is also replaced. - -## EXAMPLES - -### Example 1: Create a pipeline -``` -PS C:\>New-AzureRmDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF" -File "C:\DPWikisample.json" -PipelineName : DPWikisample -ResourceGroupName : ADF -DataFactoryName : WikiADF11 -Properties : Microsoft.DataFactories.PipelineProperties -``` - -This command creates a pipeline named DPWikisample in the data factory named ADF. -The command bases the pipeline on information in the DPWikisample.json file. -This file includes information about activities such as Copy Activity and HDInsight Activity in the pipeline. - -## PARAMETERS - -### -DataFactory -Specifies a **PSDataFactory** object. -This cmdlet creates a pipeline for the data factory that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataFactoryName -Specifies the name of a data factory. -This cmdlet creates a pipeline for the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -File -Specifies the full path of the JavaScript Object Notation (JSON) file that contains the description of the pipeline. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Indicates that this cmdlet replaces an existing pipeline without prompting you for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the pipeline to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet creates a pipeline for the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSPipeline - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[Get-AzureRmDataFactoryPipeline](./Get-AzureRmDataFactoryPipeline.md) - -[Remove-AzureRmDataFactoryPipeline](./Remove-AzureRmDataFactoryPipeline.md) - -[Resume-AzureRmDataFactoryPipeline](./Resume-AzureRmDataFactoryPipeline.md) - -[Set-AzureRmDataFactoryPipelineActivePeriod](./Set-AzureRmDataFactoryPipelineActivePeriod.md) - -[Suspend-AzureRmDataFactoryPipeline](./Suspend-AzureRmDataFactoryPipeline.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataFactories/Remove-AzureRmDataFactory.md b/azurermps-6.13.0/AzureRM.DataFactories/Remove-AzureRmDataFactory.md deleted file mode 100644 index b1b8655717..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactories/Remove-AzureRmDataFactory.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactories.dll-Help.xml -Module Name: AzureRM.DataFactories -ms.assetid: 3D2E9FAE-FE34-457A-BE95-BC61D025B07A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/remove-azurermdatafactory -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Remove-AzureRmDataFactory.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Remove-AzureRmDataFactory.md ---- - -# Remove-AzureRmDataFactory - -## SYNOPSIS -Removes a data factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Remove-AzureRmDataFactory [-Name] <String> [-Force] [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByFactoryObject -``` -Remove-AzureRmDataFactory [-DataFactory] <PSDataFactory> [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmDataFactory** cmdlet removes a data factory. - -## EXAMPLES - -### Example 1: Remove a data factory -``` -PS C:\>Remove-AzureRmDataFactory -Name "WikiADF" -ResourceGroupName "ADF" -Confirm -Are you sure you want to remove data factory 'WikiADF' in resource group 'ADF'? -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y -True -``` - -This command removes the data factory named WikiADF from the resource group named ADF. -This command returns a value of $True. - -## PARAMETERS - -### -DataFactory -Specifies the **PSDataFactory** object to remove. - -```yaml -Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Indicates that this cmdlet removes a data factory without prompting you for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the data factory to remove. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: DataFactoryName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet removes a data factory from the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory - -## OUTPUTS - -### System.Void - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[Get-AzureRmDataFactory](./Get-AzureRmDataFactory.md) - -[New-AzureRmDataFactory](./New-AzureRmDataFactory.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataFactories/Remove-AzureRmDataFactoryDataset.md b/azurermps-6.13.0/AzureRM.DataFactories/Remove-AzureRmDataFactoryDataset.md deleted file mode 100644 index c787dba625..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactories/Remove-AzureRmDataFactoryDataset.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactories.dll-Help.xml -Module Name: AzureRM.DataFactories -ms.assetid: 428BC568-A305-49AD-B6B8-B1BB5E9B822B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/remove-azurermdatafactorydataset -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Remove-AzureRmDataFactoryDataset.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Remove-AzureRmDataFactoryDataset.md ---- - -# Remove-AzureRmDataFactoryDataset - -## SYNOPSIS -Removes a dataset from Azure Data Factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Remove-AzureRmDataFactoryDataset [-Force] [-DataFactoryName] <String> [-Name] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByFactoryObject -``` -Remove-AzureRmDataFactoryDataset [-Force] [-DataFactory] <PSDataFactory> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmDataFactoryDataset** cmdlet removes a dataset from Azure Data Factory. - -## EXAMPLES - -### Example 1: Remove a dataset -``` -PS C:\>Remove-AzureRmDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikiAggregatedData" -Confirm -Are you sure you want to remove dataset 'DAWikiAggregatedData' in data factory 'WikiADF'? -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y -True -``` - -This command removes the dataset named DAWikiAggregatedData from the data factory named WikiADF. -The command returns a value of $True. - -## PARAMETERS - -### -DataFactory -Specifies a **PSDataFactory** object. -This cmdlet removes a dataset from the data factory that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataFactoryName -Specifies the name of a data factory. -This cmdlet removes a dataset from the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Indicates that this cmdlet removes a dataset without prompting you for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the dataset to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: DatasetName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet removes a dataset from the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[Get-AzureRmDataFactoryDataset](./Get-AzureRmDataFactoryDataset.md) - -[New-AzureRmDataFactoryDataset](./New-AzureRmDataFactoryDataset.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataFactories/Remove-AzureRmDataFactoryGateway.md b/azurermps-6.13.0/AzureRM.DataFactories/Remove-AzureRmDataFactoryGateway.md deleted file mode 100644 index db2730cbd2..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactories/Remove-AzureRmDataFactoryGateway.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactories.dll-Help.xml -Module Name: AzureRM.DataFactories -ms.assetid: E1461540-DEAE-43C3-83DF-7DF3FE8D4EC0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/remove-azurermdatafactorygateway -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Remove-AzureRmDataFactoryGateway.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Remove-AzureRmDataFactoryGateway.md ---- - -# Remove-AzureRmDataFactoryGateway - -## SYNOPSIS -Removes a gateway from Azure Data Factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Remove-AzureRmDataFactoryGateway [-DataFactoryName] <String> [-Name] <String> [-Force] - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByFactoryObject -``` -Remove-AzureRmDataFactoryGateway [-DataFactory] <PSDataFactory> [-Name] <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmDataFactoryGateway** cmdlet removes the specified gateway from Azure Data Factory. - -## EXAMPLES - -### Example 1: Remove a gateway -``` -PS C:\>Remove-AzureRmDataFactoryGateway -Name "ContosoGateway" -DataFactoryName "WikiADF" -ResourceGroupName "ADF" -Confirm -Are you sure you want to remove gateway 'ContosoGateway' in data factory 'WikiADF'? - [Y] Yes [N] No [S] Suspend [?] Help (default is Y): Y -True -``` - -This command removes the gateway named ContosoGateway from the data factory named WikiADF. - -## PARAMETERS - -### -DataFactory -Specifies a **PSDataFactory** object. -This cmdlet removes a gateway from the data factory that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataFactoryName -Specifies the name of a data factory. -This cmdlet removes a gateway from the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Indicates that this cmdlet removes a gateway without prompting you for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the gateway to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet removes a gateway that belongs to the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[Get-AzureRmDataFactoryGateway](./Get-AzureRmDataFactoryGateway.md) - -[New-AzureRmDataFactoryGateway](./New-AzureRmDataFactoryGateway.md) - -[Set-AzureRmDataFactoryGateway](./Set-AzureRmDataFactoryGateway.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataFactories/Remove-AzureRmDataFactoryHub.md b/azurermps-6.13.0/AzureRM.DataFactories/Remove-AzureRmDataFactoryHub.md deleted file mode 100644 index 0c903e9bde..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactories/Remove-AzureRmDataFactoryHub.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactories.dll-Help.xml -Module Name: AzureRM.DataFactories -ms.assetid: 4C839730-B494-45BD-B5A1-F93B02AB4B2A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/remove-azurermdatafactoryhub -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Remove-AzureRmDataFactoryHub.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Remove-AzureRmDataFactoryHub.md ---- - -# Remove-AzureRmDataFactoryHub - -## SYNOPSIS -Removes a hub from Azure Data Factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Remove-AzureRmDataFactoryHub [-Name] <String> [-Force] [-DataFactoryName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByFactoryObject -``` -Remove-AzureRmDataFactoryHub [-Name] <String> [-Force] [-DataFactory] <PSDataFactory> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmDataFactoryHub** cmdlet removes a hub from Azure Data Factory in the specified Azure resource group and in the specified data factory. -If you remove a hub, all linked services and pipelines in the hub are also removed. - -## EXAMPLES - -### Example 1: Remove a hub -``` -PS C:\>Remove-AzureRmDataFactoryHub -ResourceGroupName "ADFResourceGroup" -DataFactoryName "ADFDataFactory" -Name "ContosoDataHub" -``` - -This command removes the hub named ContosoDataHub from the Azure resource group named ADFResourceGroup and the data factory named ADFDataFactory. - -## PARAMETERS - -### -DataFactory -Specifies a **PSDataFactory** object. -This cmdlet removes a hub from the data factory that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataFactoryName -Specifies the name of a data factory. -This cmdlet removes a hub from the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Indicates that this cmdlet removes a hub without prompting you for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the hub to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: HubName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet removes a hub from the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory - -## OUTPUTS - -### System.Boolean - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[Get-AzureRmDataFactoryHub](./Get-AzureRmDataFactoryHub.md) - -[New-AzureRmDataFactoryHub](./New-AzureRmDataFactoryHub.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataFactories/Remove-AzureRmDataFactoryLinkedService.md b/azurermps-6.13.0/AzureRM.DataFactories/Remove-AzureRmDataFactoryLinkedService.md deleted file mode 100644 index d3b108131b..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactories/Remove-AzureRmDataFactoryLinkedService.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactories.dll-Help.xml -Module Name: AzureRM.DataFactories -ms.assetid: 9425D38D-5978-421F-A438-4463068C4628 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/remove-azurermdatafactorylinkedservice -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Remove-AzureRmDataFactoryLinkedService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Remove-AzureRmDataFactoryLinkedService.md ---- - -# Remove-AzureRmDataFactoryLinkedService - -## SYNOPSIS -Removes a linked service from Azure Data Factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Remove-AzureRmDataFactoryLinkedService [-Force] [-DataFactoryName] <String> [-Name] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByFactoryObject -``` -Remove-AzureRmDataFactoryLinkedService [-Force] [-DataFactory] <PSDataFactory> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmDataFactoryLinkedService** cmdlet removes a linked service from Azure Data Factory. - -## EXAMPLES - -### Example 1: Remove a linked service -``` -PS C:\>Remove-AzureRmDataFactoryLinkedService -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "LinkedServiceTest" -Confirm -Are you sure you want to remove linked service 'LinkedServiceTest' in data factory 'WikiADF'? -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y -True -``` - -This command removes the linked service named LinkedServiceTest from the data factory named WikiADF. -This command returns a value of $True. - -## PARAMETERS - -### -DataFactory -Specifies a **PSDataFactory** object. -This cmdlet removes a linked service from the data factory that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataFactoryName -Specifies the name of a data factory. -This cmdlet removes a linked service from the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Indicates that this cmdlet removes a linked service without prompting you for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the linked service to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: LinkedServiceName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet removes a linked service from the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[Get-AzureRmDataFactoryLinkedService](./Get-AzureRmDataFactoryLinkedService.md) - -[New-AzureRmDataFactoryLinkedService](./New-AzureRmDataFactoryLinkedService.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataFactories/Remove-AzureRmDataFactoryPipeline.md b/azurermps-6.13.0/AzureRM.DataFactories/Remove-AzureRmDataFactoryPipeline.md deleted file mode 100644 index 668218bcbd..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactories/Remove-AzureRmDataFactoryPipeline.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactories.dll-Help.xml -Module Name: AzureRM.DataFactories -ms.assetid: E1E0919A-062B-4794-ADE7-E17133A40604 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/remove-azurermdatafactorypipeline -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Remove-AzureRmDataFactoryPipeline.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Remove-AzureRmDataFactoryPipeline.md ---- - -# Remove-AzureRmDataFactoryPipeline - -## SYNOPSIS -Removes a pipeline from Azure Data Factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Remove-AzureRmDataFactoryPipeline [-Force] [-Name] <String> [-DataFactoryName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByFactoryObject -``` -Remove-AzureRmDataFactoryPipeline [-Force] [-Name] <String> [-DataFactory] <PSDataFactory> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmDataFactoryPipeline** cmdlet removes a pipeline from Azure Data Factory. - -## EXAMPLES - -### Example 1: Remove a pipeline -``` -PS C:\>Remove-AzureRmDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF" -Confirm -Are you sure you want to remove pipeline 'DPWikisample' in data factory 'WikiADF'? -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y -True -``` - -This cmdlet removes the pipeline named DPWikisample from the data factory named WikiADF. -The command returns a value of $True. - -## PARAMETERS - -### -DataFactory -Specifies a **PSDataFactory** object. -This cmdlet removes a pipeline from the data factory that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataFactoryName -Specifies the name of a data factory. -This cmdlet removes a pipeline from the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Indicates that this cmdlet removes a pipeline without prompting you for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the pipeline to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: PipelineName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet removes a pipeline from the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory - -## OUTPUTS - -### System.Void - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[Get-AzureRmDataFactoryPipeline](./Get-AzureRmDataFactoryPipeline.md) - -[New-AzureRmDataFactoryPipeline](./New-AzureRmDataFactoryPipeline.md) - -[Resume-AzureRmDataFactoryPipeline](./Resume-AzureRmDataFactoryPipeline.md) - -[Set-AzureRmDataFactoryPipelineActivePeriod](./Set-AzureRmDataFactoryPipelineActivePeriod.md) - -[Suspend-AzureRmDataFactoryPipeline](./Suspend-AzureRmDataFactoryPipeline.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataFactories/Resume-AzureRmDataFactoryPipeline.md b/azurermps-6.13.0/AzureRM.DataFactories/Resume-AzureRmDataFactoryPipeline.md deleted file mode 100644 index a1c50b8c35..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactories/Resume-AzureRmDataFactoryPipeline.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactories.dll-Help.xml -Module Name: AzureRM.DataFactories -ms.assetid: F522841A-4246-4028-A754-393D8DADD924 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/resume-azurermdatafactorypipeline -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Resume-AzureRmDataFactoryPipeline.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Resume-AzureRmDataFactoryPipeline.md ---- - -# Resume-AzureRmDataFactoryPipeline - -## SYNOPSIS -Resumes a suspended pipeline in Data Factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Resume-AzureRmDataFactoryPipeline [-Name] <String> [-DataFactoryName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByFactoryObject -``` -Resume-AzureRmDataFactoryPipeline [-Name] <String> [-DataFactory] <PSDataFactory> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Resume-AzureRmDataFactoryPipeline** cmdlet resumes a suspended pipeline in Azure Data Factory. - -## EXAMPLES - -### Example 1: Resume a pipeline -``` -PS C:\>Resume-AzureRmDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF" -Confirm -Are you sure you want to resume pipeline 'DPWikisample' in data factory 'WikiADF'? -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y -True -``` - -This command resumes the pipeline named DPWikisample in the data factory named WikiADF. -Use the **Suspend-AzureRmDataFactoryPipeline** cmdlet to suspend a pipeline. -The command returns a value of $True. - -## PARAMETERS - -### -DataFactory -Specifies a **PSDataFactory** object. -This cmdlet resumes a pipeline that belongs to the data factory that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataFactoryName -Specifies the name of a data factory. -This cmdlet resumes a pipeline that belongs to the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the pipeline to resume. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: PipelineName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet resumes a pipeline that belongs to the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory - -## OUTPUTS - -### System.Boolean - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[Get-AzureRmDataFactoryPipeline](./Get-AzureRmDataFactoryPipeline.md) - -[New-AzureRmDataFactoryPipeline](./New-AzureRmDataFactoryPipeline.md) - -[Remove-AzureRmDataFactoryPipeline](./Remove-AzureRmDataFactoryPipeline.md) - -[Set-AzureRmDataFactoryPipelineActivePeriod](./Set-AzureRmDataFactoryPipelineActivePeriod.md) - -[Suspend-AzureRmDataFactoryPipeline](./Suspend-AzureRmDataFactoryPipeline.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataFactories/Save-AzureRmDataFactoryLog.md b/azurermps-6.13.0/AzureRM.DataFactories/Save-AzureRmDataFactoryLog.md deleted file mode 100644 index 22623c6435..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactories/Save-AzureRmDataFactoryLog.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactories.dll-Help.xml -Module Name: AzureRM.DataFactories -ms.assetid: 5490BB24-127E-4C21-B85F-B70D817B659A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/save-azurermdatafactorylog -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Save-AzureRmDataFactoryLog.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Save-AzureRmDataFactoryLog.md ---- - -# Save-AzureRmDataFactoryLog - -## SYNOPSIS -Downloads log files from Azure HDInsight processing. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Save-AzureRmDataFactoryLog [-DataFactoryName] <String> [-Id] <String> [-DownloadLogs] [[-Output] <String>] - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByFactoryObject -``` -Save-AzureRmDataFactoryLog [-DataFactory] <PSDataFactory> [-Id] <String> [-DownloadLogs] [[-Output] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Save-AzureRmDataFactoryLog** cmdlet downloads log files associated with Azure HDInsight processing of Pig or Hive projects or for custom activities to your local hard drive. -You first run the Get-AzureRmDataFactoryRun cmdlet to get an ID for an activity run for a data slice, and then use that ID to retrieve log files from the binary large object (BLOB) storage associated with the HDInsight cluster. -If you do not specify the *DownloadLogs* parameter, the cmdlet just returns the location of log files. -If you specify *DownloadLogs* without specifying an output directory (*Output* parameter), the log files are downloaded to the default Documents folder. -If you specify *DownloadLogs* along with an output folder (*Output*), the log files are downloaded to the specified folder. - -## EXAMPLES - -### Example 1: Save log files to a specific folder -``` -PS C:\>Save-AzureRmDataFactoryLog -ResourceGroupName "ADF" -DataFactoryName "LogProcessingFactory" -Id "841b77c9-d56c-48d1-99a3-8c16c3e77d39" -DownloadLogs -Output "C:\Test" -``` - -This command saves log files for the activity run with the ID of 841b77c9-d56c-48d1-99a3-8c16c3e77d39 where the activity belongs to a pipeline in the data factory named LogProcessingFactory in the resource group named ADF. -The log files are saved to the C:\Test folder. - -### Example 2: Save log files to default Documents folder -``` -PS C:\>Save-AzureRmDataFactoryLog -ResourceGroupName "ADF" -DataFactoryName "LogProcessingFactory" -Id "841b77c9-d56c-48d1-99a3-8c16c3e77d39" -DownloadLogs -``` - -This command saves log files to Documents folder (default). - -### Example 3: Get the location of log files -``` -PS C:\>Save-AzureRmDataFactoryLog -ResourceGroupName "ADF" -DataFactoryName "LogProcessingFactory" -Id "841b77c9-d56c-48d1-99a3-8c16c3e77d39" -``` - -This command returns the location of log files. -Note that *DownloadLogs* is not specified. - -## PARAMETERS - -### -DataFactory -Specifies a **PSDataFactory** object. - -```yaml -Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataFactoryName -Specifies the name of a data factory. -This cmdlet downloads log files for the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DownloadLogs -Indicates that this cmdlet downloads log files to your local computer. -If *Ouptut* folder is not specified, files are saved to Documents folder under a subfolder. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the activity run for the data slice. -Use the Get-AzureRmDataFactoryRun cmdlet to get an ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Output -Specifies the output folder in which the downloaded log files are saved. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet creates a data factory that belongs to the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSRunLogInfo - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[Get-AzureRmDataFactoryRun](./Get-AzureRmDataFactoryRun.md) - -[Get-AzureRmDataFactoryPipeline](./Get-AzureRmDataFactoryPipeline.md) - -[New-AzureRmDataFactoryPipeline](./New-AzureRmDataFactoryPipeline.md) - -[Remove-AzureRmDataFactoryPipeline](./Remove-AzureRmDataFactoryPipeline.md) - -[Set-AzureRmDataFactoryPipelineActivePeriod](./Set-AzureRmDataFactoryPipelineActivePeriod.md) - -[Suspend-AzureRmDataFactoryPipeline](./Suspend-AzureRmDataFactoryPipeline.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataFactories/Set-AzureRmDataFactoryGateway.md b/azurermps-6.13.0/AzureRM.DataFactories/Set-AzureRmDataFactoryGateway.md deleted file mode 100644 index 4c11df3ef7..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactories/Set-AzureRmDataFactoryGateway.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactories.dll-Help.xml -Module Name: AzureRM.DataFactories -ms.assetid: 663D27A3-0B51-48F5-81D0-8DDBC5A3A33C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/set-azurermdatafactorygateway -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Set-AzureRmDataFactoryGateway.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Set-AzureRmDataFactoryGateway.md ---- - -# Set-AzureRmDataFactoryGateway - -## SYNOPSIS -Sets the description for a gateway in Azure Data Factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Set-AzureRmDataFactoryGateway [-DataFactoryName] <String> [-Name] <String> [-Description] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByFactoryObject -``` -Set-AzureRmDataFactoryGateway [-DataFactory] <PSDataFactory> [-Name] <String> [-Description] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDataFactoryGateway** cmdlet sets the description for the specified gateway in Azure Data Factory. - -## EXAMPLES - -### Example 1: Set the description for a gateway -``` -PS C:\>Set-AzureRmDataFactoryGateway -ResourceGroupName "ADF" -Name "ContosoGateway" -DataFactoryName "WikiADF" -Description "my gateway" -Name : ContosoGateway -Description : my gateway -Version : 1.3.5338.1 -Status : Online -VersionStatus : UpToDate -CreateTime : 8/22/2014 1:31:09 AM -RegisterTime : 8/22/2014 1:31:37 AM -LastConnectTime : 8/22/2014 1:41:41 AM -ExpiryTime : -``` - -This command sets the description for the gateway named ContosoGateway in the data factory named WikiADF. -The Description parameter specifies the new description. - -## PARAMETERS - -### -DataFactory -Specifies a **PSDataFactory** object. -This cmdlet sets the description for the gateway in the data factory that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataFactoryName -Specifies the name of a data factory. -This cmdlet sets the description for the gateway in the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the gateway. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the gateway for which to set a description. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet sets the description for a gateway that belongs to the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactoryGateway - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[Get-AzureRmDataFactoryGateway](./Get-AzureRmDataFactoryGateway.md) - -[New-AzureRmDataFactoryGateway](./New-AzureRmDataFactoryGateway.md) - -[Remove-AzureRmDataFactoryGateway](./Remove-AzureRmDataFactoryGateway.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataFactories/Set-AzureRmDataFactoryPipelineActivePeriod.md b/azurermps-6.13.0/AzureRM.DataFactories/Set-AzureRmDataFactoryPipelineActivePeriod.md deleted file mode 100644 index 7fa3d719f4..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactories/Set-AzureRmDataFactoryPipelineActivePeriod.md +++ /dev/null @@ -1,261 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactories.dll-Help.xml -Module Name: AzureRM.DataFactories -ms.assetid: D853A91F-95E7-4C36-AC0F-2C10DFCF68F8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/set-azurermdatafactorypipelineactiveperiod -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Set-AzureRmDataFactoryPipelineActivePeriod.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Set-AzureRmDataFactoryPipelineActivePeriod.md ---- - -# Set-AzureRmDataFactoryPipelineActivePeriod - -## SYNOPSIS -Configures the active period for data slices. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Set-AzureRmDataFactoryPipelineActivePeriod [-PipelineName] <String> [-DataFactoryName] <String> - [-StartDateTime] <DateTime> [[-EndDateTime] <DateTime>] [-AutoResolve] [-ForceRecalculate] - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByFactoryObject -``` -Set-AzureRmDataFactoryPipelineActivePeriod [-PipelineName] <String> [-DataFactory] <PSDataFactory> - [-StartDateTime] <DateTime> [[-EndDateTime] <DateTime>] [-AutoResolve] [-ForceRecalculate] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDataFactoryPipelineActivePeriod** cmdlet configures the active period for the data slices that are processed by a pipeline in Azure Data Factory. -If you use the Set-AzureRmDataFactorySliceStatus cmdlet to modify the status of slices for a dataset, make sure that the start time and end time for a slice are in the active period of the pipeline. -After you create a pipeline, you can specify the period in which data processing occurs. -Specifying the active period for a pipeline defines the time duration in which the data slices are processed based on the **Availability** properties that were defined for each Data Factory dataset. - -## EXAMPLES - -### Example 1: Configure the active period -``` -PS C:\>Set-AzureRmDataFactoryPipelineActivePeriod -ResourceGroupName "ADF" -PipelineName "DPWikisample" -DataFactoryName "WikiADF" -StartDateTime 2014-05-21T16:00:00Z -EndDateTime 2014-05-22T16:00:00Z -Confirm -Are you sure you want to set pipeline 'DPWikisample' active period from '05/21/2014 16:00:00' to -'05/22/2014 16:00:00'? -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y -True -``` - -This command configures the active period for the data slices that the pipeline named DPWikisample processes. -The command provides beginning and end points for the data slices as values. -The command returns a value of $True. - -## PARAMETERS - -### -AutoResolve -Indicates that this cmdlet uses auto resolve. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataFactory -Specifies a **PSDataFactory** object. -This cmdlet modifies the active period for a pipeline that belongs to the data factory that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataFactoryName -Specifies the name of a data factory. -This cmdlet modifies the active period for a pipeline that belongs to the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndDateTime -Specifies the end of a time period as a **DateTime** object. -Data processing occurs or data slices are processed within this period. -For more information about **DateTime** objects, type `Get-Help Get-Date`. -*EndDateTime* must be specified in the ISO8601 format as in the following examples: -2015-01-01Z -2015-01-01T00:00:00Z -2015-01-01T00:00:00.000Z (UTC) -2015-01-01T00:00:00-08:00 (Pacific Standard Time) -The default time zone designator is UTC. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceRecalculate -Indicates that this cmdlet uses force recalculate. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PipelineName -Specifies the name of the pipeline. -This cmdlet sets the active period for the pipeline that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet modifies the active period for a pipeline that belongs to the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartDateTime -Specifies the start of a time period as a **DateTime** object. -Data processing occurs or data slices are processed within this period. -*StartDateTime* must be specified in the ISO8601 format. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory - -## OUTPUTS - -### System.Boolean - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[New-AzureRmDataFactoryPipeline](./New-AzureRmDataFactoryPipeline.md) - -[Set-AzureRmDataFactorySliceStatus](./Set-AzureRmDataFactorySliceStatus.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataFactories/Set-AzureRmDataFactorySliceStatus.md b/azurermps-6.13.0/AzureRM.DataFactories/Set-AzureRmDataFactorySliceStatus.md deleted file mode 100644 index e6c4cb9e95..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactories/Set-AzureRmDataFactorySliceStatus.md +++ /dev/null @@ -1,237 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactories.dll-Help.xml -Module Name: AzureRM.DataFactories -ms.assetid: 1D07222C-17D1-421C-8C9B-37043CBCF517 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/set-azurermdatafactoryslicestatus -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Set-AzureRmDataFactorySliceStatus.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Set-AzureRmDataFactorySliceStatus.md ---- - -# Set-AzureRmDataFactorySliceStatus - -## SYNOPSIS -Sets the status of slices for a dataset in Azure Data Factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Set-AzureRmDataFactorySliceStatus [[-EndDateTime] <DateTime>] [-Status] <String> [[-UpdateType] <String>] - [-DataFactoryName] <String> [-DatasetName] <String> [-StartDateTime] <DateTime> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByFactoryObject -``` -Set-AzureRmDataFactorySliceStatus [[-EndDateTime] <DateTime>] [-Status] <String> [[-UpdateType] <String>] - [-DataFactory] <PSDataFactory> [-DatasetName] <String> [-StartDateTime] <DateTime> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDataFactorySliceStatus** cmdlet sets the status of slices for a dataset in Azure Data Factory. - -## EXAMPLES - -### Example 1: Set the status of all slices -``` -PS C:\>Set-AzureRmDataFactorySliceStatus -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -DatasetName "DAWikiAggregatedData" -StartDateTime 2014-05-21T16:00:00Z -EndDateTime 2014-05-21T20:00:00Z -Status "Waiting" -UpdateType "UpstreamInPipeline" -True -``` - -This command sets the status of all slices for the dataset named DAWikiAggregatedData to Waiting in the data factory named WikiADF. -The *UpdateType* parameter has a value of UpstreamInPipeline, and so the command sets the status of each slice for the dataset and all dependent datasets. -Dependent datasets are used as input datasets for activities in the pipeline. -This command returns a value of $True. - -## PARAMETERS - -### -DataFactory -Specifies a **PSDataFactory** object. -This cmdlet modifies the status of slices that belong to the data factory that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataFactoryName -Specifies the name of a data factory. -This cmdlet modifies the status of slices that belong to the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatasetName -Specifies the name of the dataset for which this cmdlet modifies slices. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndDateTime -Specifies the end of a time period as a **DateTime** object. -This time is the end of a data slice. -For more information about **DateTime** objects, type `Get-Help Get-Date`. -*EndDateTime* must be specified in the ISO8601 format as in the following examples: -2015-01-01Z -2015-01-01T00:00:00Z -2015-01-01T00:00:00.000Z (UTC) -2015-01-01T00:00:00-08:00 (Pacific Standard Time) -The default time zone designator is UTC. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet modifies the status of slices that belong to the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartDateTime -Specifies the start of a time period as a **DateTime** object. -This time is the beginning of a data slice. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Status -Specifies a status to assign to the data slice. -The acceptable values for this parameter are: -- Waiting. -Data slice is waiting for validation against validation policies before being processed. -- Ready. -Data processing has completed and the data slice is ready. -- InProgress. -Data processing is in-progress. -- Failed. -Data processing failed. -- Skipped. -Skipped processing the data slice. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Failed, InProgress, Ready, Skipped, Waiting - -Required: True -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UpdateType -Specifies the type of update to the slice. -The acceptable values for this parameter are: -- Individual. -Sets the status of each slice for the dataset in the specified time range. -- UpstreamInPipeline. -Sets the status of each slice for the dataset and all the dependent datasets, which are used as input datasets for activities in the pipeline. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Individual, UpstreamInPipeline - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[Get-AzureRmDataFactorySlice](./Get-AzureRmDataFactorySlice.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataFactories/Suspend-AzureRmDataFactoryPipeline.md b/azurermps-6.13.0/AzureRM.DataFactories/Suspend-AzureRmDataFactoryPipeline.md deleted file mode 100644 index 0f923405b1..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactories/Suspend-AzureRmDataFactoryPipeline.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactories.dll-Help.xml -Module Name: AzureRM.DataFactories -ms.assetid: 1FF0B0F9-4B2C-46BC-8BED-12BE865E4480 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/suspend-azurermdatafactorypipeline -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Suspend-AzureRmDataFactoryPipeline.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactories/Commands.DataFactories/help/Suspend-AzureRmDataFactoryPipeline.md ---- - -# Suspend-AzureRmDataFactoryPipeline - -## SYNOPSIS -Suspends a pipeline in Azure Data Factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Suspend-AzureRmDataFactoryPipeline [-Name] <String> [-DataFactoryName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByFactoryObject -``` -Suspend-AzureRmDataFactoryPipeline [-Name] <String> [-DataFactory] <PSDataFactory> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Suspend-AzureRmDataFactoryPipeline** cmdlet suspends a pipeline in Azure Data Factory. -You can resume the pipeline by using the Resume-AzureRmDataFactoryPipeline cmdlet. - -## EXAMPLES - -### Example 1: Suspend a pipeline -``` -PS C:\>Suspend-AzureRmDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikiSample" -DataFactoryName "WikiADF" -Confirm -Are you sure you want to suspend pipeline 'DPWikisample' in data factory 'WikiADF'? -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y -True -``` - -This command suspends the pipeline named DPWikiSample in the data factory named WikiADF. -The command returns a value of $True. - -## PARAMETERS - -### -DataFactory -Specifies a **PSDataFactory** object. -This cmdlet suspends a pipeline that belongs to the data factory that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataFactoryName -Specifies the name of a data factory. -This cmdlet suspends a pipeline that belongs to the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the pipeline to suspend. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: PipelineName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet suspends a pipeline that belongs to the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory - -## OUTPUTS - -### System.Boolean - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[Get-AzureRmDataFactoryPipeline](./Get-AzureRmDataFactoryPipeline.md) - -[New-AzureRmDataFactoryPipeline](./New-AzureRmDataFactoryPipeline.md) - -[Remove-AzureRmDataFactoryPipeline](./Remove-AzureRmDataFactoryPipeline.md) - -[Resume-AzureRmDataFactoryPipeline](./Resume-AzureRmDataFactoryPipeline.md) - -[Set-AzureRmDataFactoryPipelineActivePeriod](./Set-AzureRmDataFactoryPipelineActivePeriod.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/AzureRM.DataFactoryV2.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/AzureRM.DataFactoryV2.md deleted file mode 100644 index 261093b89e..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/AzureRM.DataFactoryV2.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -Module Name: AzureRM.DataFactoryV2 -Module Guid: e3c0f6bc-fe96-41a0-88f4-5e490a91f05d -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactoryv2 -Help Version: 0.5.3.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/AzureRM.DataFactoryV2.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/AzureRM.DataFactoryV2.md ---- - -# AzureRM.DataFactoryV2 Module -## Description -Azure Data Factory V2 is the data integration platform that goes beyond Azure Data Factory V1's orchestration and batch-processing of time-series log data, with a general purpose app model supporting modern data warehousing patterns and scenarios, lift-and-shift SSIS, and data-driven SaaS applications. Compose and manage reliable and secure data integration workflows at scale. Use native ADF data connectors and Integration Runtimes to move and transform cloud and on-premises data that can be unstructured, semi-structured, and structured with Hadoop, Azure Data Lake, Spark, SQL Server, Cosmos DB and many other data platforms. - -## AzureRM.DataFactoryV2 Cmdlets -### [Get-AzureRmDataFactoryV2](Get-AzureRmDataFactoryV2.md) -Gets information about Data Factory. - -### [Get-AzureRmDataFactoryV2ActivityRun](Get-AzureRmDataFactoryV2ActivityRun.md) -Gets information about activity runs for a pipeline run. - -### [Get-AzureRmDataFactoryV2Dataset](Get-AzureRmDataFactoryV2Dataset.md) -Gets information about datasets in Data Factory. - -### [Get-AzureRmDataFactoryV2IntegrationRuntime](Get-AzureRmDataFactoryV2IntegrationRuntime.md) -Gets information about integration runtime resources. - -### [Get-AzureRmDataFactoryV2IntegrationRuntimeKey](Get-AzureRmDataFactoryV2IntegrationRuntimeKey.md) -Gets keys for a self-hosted integration runtime. - -### [Get-AzureRmDataFactoryV2IntegrationRuntimeMetric](Get-AzureRmDataFactoryV2IntegrationRuntimeMetric.md) -Gets metric data for an integration runtime. - -### [Get-AzureRmDataFactoryV2IntegrationRuntimeNode](Get-AzureRmDataFactoryV2IntegrationRuntimeNode.md) -Gets an integration runtime node infomation. - -### [Get-AzureRmDataFactoryV2LinkedService](Get-AzureRmDataFactoryV2LinkedService.md) -Gets information about linked services in Data Factory. - -### [Get-AzureRmDataFactoryV2Pipeline](Get-AzureRmDataFactoryV2Pipeline.md) -Gets information about pipelines in Data Factory. - -### [Get-AzureRmDataFactoryV2PipelineRun](Get-AzureRmDataFactoryV2PipelineRun.md) -Gets information about pipeline runs. - -### [Get-AzureRmDataFactoryV2Trigger](Get-AzureRmDataFactoryV2Trigger.md) -Gets information about triggers in a data factory. - -### [Get-AzureRmDataFactoryV2TriggerRun](Get-AzureRmDataFactoryV2TriggerRun.md) -Returns information about trigger runs. - -### [Invoke-AzureRmDataFactoryV2IntegrationRuntimeUpgrade](Invoke-AzureRmDataFactoryV2IntegrationRuntimeUpgrade.md) -Upgrades self-hosted integration runtime. - -### [Invoke-AzureRmDataFactoryV2Pipeline](Invoke-AzureRmDataFactoryV2Pipeline.md) - Invokes a pipeline to start a run for it. - -### [New-AzureRmDataFactoryV2IntegrationRuntimeKey](New-AzureRmDataFactoryV2IntegrationRuntimeKey.md) -Regenerate self-hosted integration runtime key. - -### [New-AzureRmDataFactoryV2LinkedServiceEncryptedCredential](New-AzureRmDataFactoryV2LinkedServiceEncryptedCredential.md) -Encrypt credential in linked service with specified integration runtime. - -### [Remove-AzureRmDataFactoryV2](Remove-AzureRmDataFactoryV2.md) -Removes a data factory. - -### [Remove-AzureRmDataFactoryV2Dataset](Remove-AzureRmDataFactoryV2Dataset.md) -Removes a dataset from Data Factory. - -### [Remove-AzureRmDataFactoryV2IntegrationRuntime](Remove-AzureRmDataFactoryV2IntegrationRuntime.md) -Removes an integration runtime. - -### [Remove-AzureRmDataFactoryV2IntegrationRuntimeNode](Remove-AzureRmDataFactoryV2IntegrationRuntimeNode.md) -Remove a node with the given name on an integration runtime. - -### [Remove-AzureRmDataFactoryV2LinkedService](Remove-AzureRmDataFactoryV2LinkedService.md) -Removes a linked service from Data Factory. - -### [Remove-AzureRmDataFactoryV2Pipeline](Remove-AzureRmDataFactoryV2Pipeline.md) -Removes a pipeline from Data Factory. - -### [Remove-AzureRmDataFactoryV2Trigger](Remove-AzureRmDataFactoryV2Trigger.md) -Removes a trigger from a data factory. - -### [Set-AzureRmDataFactoryV2](Set-AzureRmDataFactoryV2.md) -Creates a data factory. - -### [Set-AzureRmDataFactoryV2Dataset](Set-AzureRmDataFactoryV2Dataset.md) -Creates a dataset in Data Factory. - -### [Set-AzureRmDataFactoryV2IntegrationRuntime](Set-AzureRmDataFactoryV2IntegrationRuntime.md) -Updates an integration runtime. - -### [Set-AzureRmDataFactoryV2LinkedService](Set-AzureRmDataFactoryV2LinkedService.md) -Links a data store or a cloud service to Data Factory. - -### [Set-AzureRmDataFactoryV2Pipeline](Set-AzureRmDataFactoryV2Pipeline.md) -Creates a pipeline in Data Factory. - -### [Set-AzureRmDataFactoryV2Trigger](Set-AzureRmDataFactoryV2Trigger.md) -Creates a trigger in a data factory. - -### [Start-AzureRmDataFactoryV2IntegrationRuntime](Start-AzureRmDataFactoryV2IntegrationRuntime.md) -Starts a managed dedicated integration runtime. - -### [Start-AzureRmDataFactoryV2Trigger](Start-AzureRmDataFactoryV2Trigger.md) -Starts a trigger in a data factory. - -### [Stop-AzureRmDataFactoryV2IntegrationRuntime](Stop-AzureRmDataFactoryV2IntegrationRuntime.md) -Stops a managed dedicated integration runtime. - -### [Stop-AzureRmDataFactoryV2PipelineRun](Stop-AzureRmDataFactoryV2PipelineRun.md) -Stops a pieline run in a data factory. - -### [Stop-AzureRmDataFactoryV2Trigger](Stop-AzureRmDataFactoryV2Trigger.md) -Stops a trigger in a data factory. - -### [Sync-AzureRmDataFactoryV2IntegrationRuntimeCredential](Sync-AzureRmDataFactoryV2IntegrationRuntimeCredential.md) -Synchronizes credentials among integration runtime nodes. - -### [Update-AzureRmDataFactoryV2](Update-AzureRmDataFactoryV2.md) -Updates the properties of a data factory. - -### [Update-AzureRmDataFactoryV2IntegrationRuntime](Update-AzureRmDataFactoryV2IntegrationRuntime.md) -Updates an integration runtime. - -### [Update-AzureRmDataFactoryV2IntegrationRuntimeNode](Update-AzureRmDataFactoryV2IntegrationRuntimeNode.md) -Updates self-hosted integration runtime node. - diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2.md deleted file mode 100644 index 812af2407a..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/get-azurermdatafactoryv2 -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Get-AzureRmDataFactoryV2.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Get-AzureRmDataFactoryV2.md ---- - -# Get-AzureRmDataFactoryV2 - -## SYNOPSIS -Gets information about Data Factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### BySubscriptionId (Default) -``` -Get-AzureRmDataFactoryV2 [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByFactoryName -``` -Get-AzureRmDataFactoryV2 [-ResourceGroupName] <String> [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmDataFactoryV2 cmdlet gets information about data factories in an Azure resource group. -If you specify the name of a data factory, this cmdlet gets information about that data factory. -If you do not specify a name, this cmdlet gets information about all of the data factories in an Azure resource group. - -## EXAMPLES - -### Example 1: Get all data factories -``` -PS C:\> Get-AzureRmDataFactoryV2 -ResourceGroupName "ADF" - - DataFactoryName : WikiADF - DataFactoryId : /subscriptions/3e8e61b5-9a7d-4952-bfae-545ab997b9ea/resourceGroups/adf/providers/Microsoft.DataFactory/factories/wikiadf - ResourceGroupName : ADF - Location : EastUS - Tags : {} - Identity : Microsoft.Azure.Management.DataFactory.Models.FactoryIdentity - ProvisioningState : Succeeded - - DataFactoryName : WikiADF2 - DataFactoryId : /subscriptions/3e8e61b5-9a7d-4952-bfae-545ab997b9ea/resourceGroups/adf/providers/Microsoft.DataFactory/factories/wikiadf2 - ResourceGroupName : ADF - Location : EastUS - Tags : {} - Identity : - ProvisioningState : Succeeded -``` - -Displays information about all data factories in the Azure subscription. - -### Example 2: Get a specific data factory -``` -PS C:\> $DataFactory = Get-AzureRmDataFactoryV2 -ResourceGroupName "ADF" -Name "WikiADF" - - DataFactoryName : WikiADF - DataFactoryId : /subscriptions/3e8e61b5-9a7d-4952-bfae-545ab997b9ea/resourceGroups/adf/providers/Microsoft.DataF - actory/factories/wikiadf - ResourceGroupName : ADF - Location : EastUS - Tags : {} - Identity : Microsoft.Azure.Management.DataFactory.Models.FactoryIdentity - ProvisioningState : Succeeded -``` - -This command displays information about the data factory named WikiADF in the subscription for the resource group named ADF, and then stores it in the $DataFactory variable. -Specify the DataFactory parameter in subsequent cmdlets to use the data factory stored in $DataFactory. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the data factory about which to get information. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: DataFactoryName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet gets information about data factories that belong to the group this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[Set-AzureRmDataFactoryV2]() - -[Remove-AzureRmDataFactoryV2]() - diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2ActivityRun.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2ActivityRun.md deleted file mode 100644 index 06bc8ee99e..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2ActivityRun.md +++ /dev/null @@ -1,233 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/get-azurermdatafactoryv2activityrun -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Get-AzureRmDataFactoryV2ActivityRun.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Get-AzureRmDataFactoryV2ActivityRun.md ---- - -# Get-AzureRmDataFactoryV2ActivityRun - -## SYNOPSIS -Gets information about activity runs for a pipeline run. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Get-AzureRmDataFactoryV2ActivityRun [-PipelineRunId] <String> [-RunStartedAfter] <DateTime> - [-RunStartedBefore] <DateTime> [[-ActivityName] <String>] [[-Status] <String>] [[-LinkedServiceName] <String>] - [-ResourceGroupName] <String> [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByFactoryObject -``` -Get-AzureRmDataFactoryV2ActivityRun [-PipelineRunId] <String> [-RunStartedAfter] <DateTime> - [-RunStartedBefore] <DateTime> [[-ActivityName] <String>] [[-Status] <String>] [[-LinkedServiceName] <String>] - [-DataFactory] <PSDataFactory> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDataFactoryV2ActivityRun** cmdlet gets information about runs in Azure Data Factory for the specified pipeline run that happened in the given timeframe. Additionally, you can specify filters for activity name, linked service name that executed the run, and the status of the run. - -## EXAMPLES - -### Example 1: Get all activity runs for a pipeline run -``` -PS C:\> Get-AzureRmDataFactoryV2ActivityRun -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -PipelineRunId "f288712d-fb08-4cb8-96ef-82d3b9b30621" -RunStartedAfter "2017-09-01" -RunStartedBefore "2017-09-30" - - ResourceGroupName : ADF - DataFactoryName : WikiADF - ActivityName : MyWebActivity - PipelineRunId : f288712d-fb08-4cb8-96ef-82d3b9b30621 - PipelineName : DPWikisample - Input : {method, url, headers, body...} - Output : {operationstatus} - LinkedServiceName : - ActivityRunStart : 9/14/2017 12:20:57 AM - ActivityRunEnd : 9/14/2017 12:21:00 AM - DurationInMs : 2768 - Status : Succeeded - Error : {errorCode, message, failureType, target} -``` - -This command gets details about all activity runs in the pipeline run with ID "f288712d-fb08-4cb8-96ef-82d3b9b30621" that happened between "2017-09-01" and "2017-09-30". - -## PARAMETERS - -### -ActivityName -The name of the activity. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataFactory -The data factory object. - -```yaml -Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DataFactoryName -The data factory name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LinkedServiceName -The linked service name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PipelineRunId -The Run ID of the pipeline. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RunStartedAfter -The time at or after which the pipeline run started to execute. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RunStartedBefore -The time at or before which the pipeline run started to execute. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Status -The status of the pipeline run. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory -Parameters: DataFactory (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSActivityRun - -## NOTES - -## RELATED LINKS - -[Invoke-AzureRmDataFactoryV2Pipeline]() - -[Get-AzureRmDataFactoryV2PipelineRun]() - diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2Dataset.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2Dataset.md deleted file mode 100644 index 8a1ad5115e..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2Dataset.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/get-azurermdatafactoryv2dataset -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Get-AzureRmDataFactoryV2Dataset.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Get-AzureRmDataFactoryV2Dataset.md ---- - -# Get-AzureRmDataFactoryV2Dataset - -## SYNOPSIS -Gets information about datasets in Data Factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Get-AzureRmDataFactoryV2Dataset [[-Name] <String>] [-ResourceGroupName] <String> [-DataFactoryName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByFactoryObject -``` -Get-AzureRmDataFactoryV2Dataset [[-Name] <String>] [-DataFactory] <PSDataFactory> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByResourceId -``` -Get-AzureRmDataFactoryV2Dataset [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmDataFactoryV2Dataset cmdlet gets information about datasets in Azure Data Factory. -If you specify the name of a dataset, this cmdlet gets information about that dataset. -If you do not specify a name, this cmdlet gets information about all the datasets in the data factory. - -## EXAMPLES - -### Example 1: Get information about all datasets -``` -PS C:\> Get-AzureRmDataFactoryV2Dataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" - - DatasetName : DACuratedWikiData - ResourceGroupName : ADF - DataFactoryName : WikiADF - Structure : - Properties : Microsoft.Azure.Management.DataFactory.Models.AzureBlobDataset - - DatasetName : DAWikipediaClickEvents - ResourceGroupName : ADF - DataFactoryName : WikiADF - Structure : - Properties : Microsoft.Azure.Management.DataFactory.Models.AzureBlobDataset - - DatasetName : DAWikiAggregatedData - ResourceGroupName : ADF - DataFactoryName : WikiADF - Structure : - Properties : Microsoft.Azure.Management.DataFactory.Models.AzureBlobDataset -``` - -This command gets information about all datasets in the data factory named WikiADF. - -### Example 2: Get information about a specific dataset -``` -PS C:\> Get-AzureRmDataFactoryV2Dataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikipediaClickEvents" - - DatasetName : DAWikipediaClickEvents - ResourceGroupName : ADF - DataFactoryName : WikiADF - Structure : - Properties : Microsoft.Azure.Management.DataFactory.Models.AzureBlobDataset -``` - -This command gets information about the dataset named DAWikipediaClickEvents in the data factory named WikiADF. - -## PARAMETERS - -### -DataFactory -Specifies a PSDataFactory object. -This cmdlet gets datasets that belong to the data factory that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DataFactoryName -Specifies the name of a data factory. -This cmdlet gets datasets that belong to the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the dataset about which to get information. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName, ByFactoryObject -Aliases: DatasetName - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet gets datasets that belong to the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory -Parameters: DataFactory (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataset - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[Set-AzureRmDataFactoryV2Dataset]() - -[Remove-AzureRmDataFactoryV2Dataset]() diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2IntegrationRuntime.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2IntegrationRuntime.md deleted file mode 100644 index 586ff874b2..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2IntegrationRuntime.md +++ /dev/null @@ -1,252 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/get-azurermdatafactoryv2integrationruntime -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Get-AzureRmDataFactoryV2IntegrationRuntime.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Get-AzureRmDataFactoryV2IntegrationRuntime.md ---- - -# Get-AzureRmDataFactoryV2IntegrationRuntime - -## SYNOPSIS -Gets information about integration runtime resources. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByIntegrationRuntimeName (Default) -``` -Get-AzureRmDataFactoryV2IntegrationRuntime [[-Name] <String>] [-Status] [-ResourceGroupName] <String> - [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByResourceId -``` -Get-AzureRmDataFactoryV2IntegrationRuntime [-Status] [-ResourceId] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByIntegrationRuntimeObject -``` -Get-AzureRmDataFactoryV2IntegrationRuntime [-Status] [-InputObject] <PSIntegrationRuntime> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmDataFactoryV2IntegrationRuntime cmdlet gets information about integration runtimes in a data factory. -If you specify the name of an integration runtime, this cmdlet gets information about that integration runtime. -If you do not specify a name, this cmdlet gets information about all of the integration runtimes in a data factory. - -## EXAMPLES - -### Example 1: List all integration runtimes in a data factory -``` -PS C:\> Get-AzureRmDataFactoryV2IntegrationRuntime -ResourceGroupName rg-test-dfv2 -DataFactoryName test-df-eu2 - - ResourceGroupName DataFactoryName Name Description - ----------------- --------------- ---- ----------- - rg-test-dfv2 test-df-eu2 test-reserved-ir Reserved IR - rg-test-dfv2 test-df-eu2 test-dedicated-ir Reserved IR - rg-test-dfv2 test-df-eu2 test-selfhost-ir selfhost IR -``` - -List all integration runtimes in the data factory named 'test-df-eu2'. - -### Example 2: Get managed dedicated integration runtime -``` -PS C:\> Get-AzureRmDataFactoryV2IntegrationRuntime -ResourceGroupName rg-test-dfv2 -DataFactoryName test-df-eu2 -Name test-dedicated-ir - - Location : West US - NodeSize : Standard_D1_v2 - NodeCount : 1 - MaxParallelExecutionsPerNode : 1 - CatalogServerEndpoint : test.database.windows.net - CatalogAdminUserName : test - CatalogAdminPassword : ********** - CatalogPricingTier : S1 - VNetId : - Subnet : - State : Starting - ResourceGroupName : rg-test-dfv2 - DataFactoryName : test-df-eu2 - Name : test-dedicated-ir - Description : Reserved IR -``` - -This command displays information about the integration runtime named 'test-dedicated-ir' in the subscription for the resource group named 'rg-test-dfv2' and data factory named 'test-df-eu2'. - -### Example 3: Get managed dedicated integration runtime with detail status -``` -PS C:\> Get-AzureRmDataFactoryV2IntegrationRuntime -ResourceGroupName rg-test-dfv2 -DataFactoryName test-df-eu2 -Name test-dedicated-ir -Status - - CreateTime : - Nodes : - OtherErrors : - LastOperation : - State : Initial - Location : West US - NodeSize : Standard_D1_v2 - NodeCount : 1 - MaxParallelExecutionsPerNode : 1 - CatalogServerEndpoint : test.database.windows.net - CatalogAdminUserName : test - CatalogAdminPassword : ********** - CatalogPricingTier : S1 - VNetId : - Subnet : - ResourceGroupName : rg-test-dfv2 - DataFactoryName : test-df-eu2 - Name : test-dedicated-ir - Description : Reserved IR -``` - -This command displays information about the integration runtime named 'test-dedicated-ir' in the subscription for the resource group named 'rg-test-dfv2' and data factory named 'test-df-eu2'. - -### Example 4: Get self-hosted integration runtime -``` -PS C:\> Get-AzureRmDataFactoryV2IntegrationRuntime -ResourceGroupName rg-test-dfv2 -DataFactoryName test-df-eu2 -Name test-selfhost-ir - - ResourceGroupName DataFactoryName Name Description - ----------------- --------------- ---- ----------- - rg-test-dfv2 test-df-eu2 test-selfhost-ir selfhost IR -``` - -This command displays information about the integration runtime named 'test-dedicated-ir' in the subscription for the resource group named 'rg-test-dfv2' and data factory named 'test-df-eu2'. - -## PARAMETERS - -### -DataFactoryName -The data factory name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The integration runtime object. - -```yaml -Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime -Parameter Sets: ByIntegrationRuntimeObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The integration runtime name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: IntegrationRuntimeName - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: Id - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Status -The integration runtime detail status. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSManagedIntegrationRuntime - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSSelfHostedIntegrationRuntime - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSLinkedIntegrationRuntime - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, data, factories, copy, activities, integration runtime - -## RELATED LINKS - -[Set-AzureRmDataFactoryV2IntegrationRuntime]() - -[Remove-AzureRmDataFactoryV2IntegrationRuntime]() diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2IntegrationRuntimeKey.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2IntegrationRuntimeKey.md deleted file mode 100644 index a16a919f2e..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2IntegrationRuntimeKey.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/get-azurermdatafactoryv2integrationruntimekey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Get-AzureRmDataFactoryV2IntegrationRuntimeKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Get-AzureRmDataFactoryV2IntegrationRuntimeKey.md ---- - -# Get-AzureRmDataFactoryV2IntegrationRuntimeKey - -## SYNOPSIS -Gets keys for a self-hosted integration runtime. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByIntegrationRuntimeName (Default) -``` -Get-AzureRmDataFactoryV2IntegrationRuntimeKey [-Name] <String> [-ResourceGroupName] <String> - [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByResourceId -``` -Get-AzureRmDataFactoryV2IntegrationRuntimeKey [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByIntegrationRuntimeObject -``` -Get-AzureRmDataFactoryV2IntegrationRuntimeKey [-InputObject] <PSIntegrationRuntime> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Get keys for an integration runtime. The keys are used to register an integration runtime node. - -## EXAMPLES - -### Example 1: Get integration runtime keys -``` -PS C:\> Get-AzureRmDataFactoryV2IntegrationRuntimeKey -ResourceGroupName 'rg-test-dfv2' -DataFactoryName 'test-df-eu2' -Name 'test-selfhost-ir' - -AuthKey1 AuthKey2 --------- -------- -IR@89895504-f647-48fd-8dd3-42fa556d67e3****** IR@89895504-f647-48fd-8dd3-42fa556d67e3**** -``` - -The cmdlet retrieves keys for an integration runtime named 'test-selfhost-ir'. - -## PARAMETERS - -### -DataFactoryName -The data factory name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The integration runtime object. - -```yaml -Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime -Parameter Sets: ByIntegrationRuntimeObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The integration runtime name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: IntegrationRuntimeName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: Id - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntimeKeys - -## NOTES - -## RELATED LINKS - -[New-AzureRmDataFactoryV2IntegrationRuntimeKey]() diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2IntegrationRuntimeMetric.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2IntegrationRuntimeMetric.md deleted file mode 100644 index 36b7799119..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2IntegrationRuntimeMetric.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/get-azurermdatafactoryv2integrationruntimemetric -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Get-AzureRmDataFactoryV2IntegrationRuntimeMetric.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Get-AzureRmDataFactoryV2IntegrationRuntimeMetric.md ---- - -# Get-AzureRmDataFactoryV2IntegrationRuntimeMetric - -## SYNOPSIS -Gets metric data for an integration runtime. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByIntegrationRuntimeName (Default) -``` -Get-AzureRmDataFactoryV2IntegrationRuntimeMetric [-Name] <String> [-ResourceGroupName] <String> - [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByResourceId -``` -Get-AzureRmDataFactoryV2IntegrationRuntimeMetric [-ResourceId] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByIntegrationRuntimeObject -``` -Get-AzureRmDataFactoryV2IntegrationRuntimeMetric [-InputObject] <PSIntegrationRuntime> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmDataFactoryV2IntegrationRuntimeMetric cmdlet gets metric data about integration runtime in a data factory. - -## EXAMPLES - -### Example 1: Get integration runtime metric -``` -PS C:\> Get-AzureRmDataFactoryV2IntegrationRuntimeMetric -ResourceGroupName 'rg-test-dfv2' -DataFactoryName 'test-df-eu2' -Name 'test-selfhost-ir' - -IntegrationRuntimeName ResourceGroupName DataFactoryName Nodes ----------------------- ----------------- --------------- ----- -test-selfhost-ir rg-test-dfv2 test-df-eu2 {Node_1} -``` - -This command displays metric data about the integration runtime named 'test-selfhost-ir' in the subscription for the resource group named 'rg-test-dfv2' and data factory named 'test-df-eu2'. - -## PARAMETERS - -### -DataFactoryName -The data factory name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The integration runtime object. - -```yaml -Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime -Parameter Sets: ByIntegrationRuntimeObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The integration runtime name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: IntegrationRuntimeName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: Id - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntimeMetrics - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDataFactoryV2IntegrationRuntime]() - diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2IntegrationRuntimeNode.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2IntegrationRuntimeNode.md deleted file mode 100644 index f40c7e4c88..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2IntegrationRuntimeNode.md +++ /dev/null @@ -1,246 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/get-azurermdatafactoryv2integrationruntimenode -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Get-AzureRmDataFactoryV2IntegrationRuntimeNode.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Get-AzureRmDataFactoryV2IntegrationRuntimeNode.md ---- - -# Get-AzureRmDataFactoryV2IntegrationRuntimeNode - -## SYNOPSIS -Gets an integration runtime node infomation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByIntegrationRuntimeName (Default) -``` -Get-AzureRmDataFactoryV2IntegrationRuntimeNode -Name <String> [-IpAddress] [-IntegrationRuntimeName] <String> - [-ResourceGroupName] <String> [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByResourceId -``` -Get-AzureRmDataFactoryV2IntegrationRuntimeNode -Name <String> [-IpAddress] [-ResourceId] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByIntegrationRuntimeObject -``` -Get-AzureRmDataFactoryV2IntegrationRuntimeNode -Name <String> [-IpAddress] - [-InputObject] <PSIntegrationRuntime> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDataFactoryV2IntegrationRuntimeNode** cmdlet gets the detail information of an integration runtime node. - -## EXAMPLES - -### Example 1: Gets the detail information of an integration runtime node. -``` -PS C:\> Get-AzureRmDataFactoryV2IntegrationRuntimeNode -ResourceGroupName 'rg-test-dfv2' -DataFactoryName 'test-df-eu2' -IntegrationRuntimeName 'test-selfhost-ir' -Name 'Node_1' - -ResourceGroupName : rg-test-dfv2 -DataFactoryName : test-df-eu2 -IntegrationRuntimeName : test-selfhost-ir -Name : Node_1 -MachineName : Test-02 -HostServiceUri : https://Test-02.redmond.corp.microsoft.com:8050/HostServiceRemote.svc/ -Status : Online -Capabilities : {[serviceBusConnected, True], [httpsPortEnabled, True], [credentialInSync, True], [connectedToResourceManager, True]...} -VersionStatus : UpToDate -Version : 3.2.6519.3 -RegisterTime : 12/1/2017 6:48:15 AM -LastConnectTime : 12/1/2017 7:35:03 AM -ExpiryTime : -LastStartTime : 12/1/2017 6:49:26 AM -LastStopTime : -LastUpdateResult : None -LastStartUpdateTime : -LastEndUpdateTime : -IsActiveDispatcher : True -ConcurrentJobsLimit : -MaxConcurrentJobs : 48 -IpAddress : -``` - -The cmdlet gets information of node named 'Node_1' in self-hosted integration runtime 'test-selfhost-ir' in data factory 'test-df-eu2'. - -### Example 2: Gets the detail information of an integration runtime node together with IP address. -``` -PS C:\> Get-AzureRmDataFactoryV2IntegrationRuntimeNode -ResourceGroupName 'rg-test-dfv2' -DataFactoryName 'test-df-eu2' -IntegrationRuntimeName 'test-selfhost-ir' -Name 'Node_1' -IpAddress - -ResourceGroupName : rg-test-dfv2 -DataFactoryName : test-df-eu2 -IntegrationRuntimeName : test-selfhost-ir -Name : Node_1 -MachineName : Test-02 -HostServiceUri : https://Test-02.redmond.corp.microsoft.com:8050/HostServiceRemote.svc/ -Status : Online -Capabilities : {[serviceBusConnected, True], [httpsPortEnabled, True], [credentialInSync, True], [connectedToResourceManager, True]...} -VersionStatus : UpToDate -Version : 3.2.6519.3 -RegisterTime : 12/1/2017 6:48:15 AM -LastConnectTime : 12/1/2017 7:35:03 AM -ExpiryTime : -LastStartTime : 12/1/2017 6:49:26 AM -LastStopTime : -LastUpdateResult : None -LastStartUpdateTime : -LastEndUpdateTime : -IsActiveDispatcher : True -ConcurrentJobsLimit : -MaxConcurrentJobs : 48 -IpAddress : 167.220.1.167 -``` - -The cmdlet gets information of node named 'Node_1' in self-hosted integration runtime 'test-selfhost-ir' in data factory 'test-df-eu2', including the IP address. - -## PARAMETERS - -### -DataFactoryName -The data factory name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The integration runtime object. - -```yaml -Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime -Parameter Sets: ByIntegrationRuntimeObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IntegrationRuntimeName -The integration runtime name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IpAddress -The IP Address of integration runtime node. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The integration runtime node name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: Id - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSManagedIntegrationRuntimeNode - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSSelfHostedIntegrationRuntimeNode - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, data, factories, copy, activities, integration runtime - -## RELATED LINKS - -[Get-AzureRmDataFactoryV2IntegrationRuntime]() diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2LinkedService.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2LinkedService.md deleted file mode 100644 index 5f4bab814c..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2LinkedService.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/get-azurermdatafactoryv2linkedservice -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Get-AzureRmDataFactoryV2LinkedService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Get-AzureRmDataFactoryV2LinkedService.md ---- - -# Get-AzureRmDataFactoryV2LinkedService - -## SYNOPSIS -Gets information about linked services in Data Factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Get-AzureRmDataFactoryV2LinkedService [[-Name] <String>] [-ResourceGroupName] <String> - [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByFactoryObject -``` -Get-AzureRmDataFactoryV2LinkedService [[-Name] <String>] [-DataFactory] <PSDataFactory> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByResourceId -``` -Get-AzureRmDataFactoryV2LinkedService [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmDataFactoryV2LinkedService cmdlet gets information about linked services in Azure Data Factory. -If you specify the name of a linked service, this cmdlet gets information about that linked service. -If you do not specify a name, this cmdlet gets information about all the linked services in the data factory. - -## EXAMPLES - -### Example 1: Get information about all linked services -``` -PS C:\> Get-AzureRmDataFactoryV2LinkedService -ResourceGroupName "ADF" -DataFactoryName "WikiADF" | Format-List - - LinkedServiceName : LinkedServiceCuratedWikiData - ResourceGroupName : ADF - DataFactoryName : WikiADF - Properties : Microsoft.Azure.Management.DataFactory.Models.AzureStorageLinkedService - - LinkedServiceName : LinkedServiceHDIStorage - ResourceGroupName : ADF - DataFactoryName : WikiADF - Properties : Microsoft.Azure.Management.DataFactory.Models.AzureStorageLinkedService - - LinkedServiceName : LinkedServiceWikipediaClickEvents - ResourceGroupName : ADF - DataFactoryName : WikiADF - Properties : Microsoft.Azure.Management.DataFactory.Models.AzureStorageLinkedService -``` - -This command gets information about all linked services in the data factory named WikiADF, and then passes the linked services to the Format-List cmdlet by using the pipeline operator. -That Windows PowerShell cmdlet formats the results. -For more information, type Get-Help Format-List. -You can use either one of the following ways: - -### Example 2: Get information about a specific linked service -``` -PS C:\> Get-AzureRmDataFactoryV2LinkedService -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "LinkedServiceCuratedWikiData" - - LinkedServiceName : LinkedServiceCuratedWikiData - ResourceGroupName : ADF - DataFactoryName : WikiADF - Properties : Microsoft.Azure.Management.DataFactory.Models.AzureStorageLinkedService -``` - -This command gets information about the linked service named LinkedServiceCuratedWikiData in the data factory named WikiADF. - -### Example 3: Get information about a specific linked service by specifying the DataFactory parameter -``` -PS C:\>$DataFactory = Get-AzureRmDataFactoryV2 -ResourceGroupName "ADF" -Name "ContosoFactory"PS C:\> Get-AzureRmDataFactoryV2LinkedService -DataFactory $DataFactory | Format-Table -Property LinkedServiceName, DataFactoryName, ResourceGroupName -``` - -The first command uses the Get-AzureRmDataFactoryV2 cmdlet to get the data factory named ContosoFactory, and then stores it in the $DataFactory variable. -The second command gets information about the linked service for the data factory stored in $DataFactory, and then passes that information to the Format-Table cmdlet by using the pipeline operator. -The Format-Table cmdlet formats the output as a dataset with the specified properties as dataset columns. - -## PARAMETERS - -### -DataFactory -Specifies a PSDataFactory object. -This cmdlet gets linked services that belong to the data factory that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DataFactoryName -Specifies the name of a data factory. -This cmdlet gets linked services that belong to the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the linked service about which to get information. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName, ByFactoryObject -Aliases: LinkedServiceName - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet gets linked services that belong to the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory -Parameters: DataFactory (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSLinkedService - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[Set-AzureRmDataFactoryV2LinkedService]() - -[Remove-AzureRmDataFactoryV2LinkedService]() diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2Pipeline.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2Pipeline.md deleted file mode 100644 index b709c55b00..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2Pipeline.md +++ /dev/null @@ -1,251 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/get-azurermdatafactoryv2pipeline -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Get-AzureRmDataFactoryV2Pipeline.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Get-AzureRmDataFactoryV2Pipeline.md ---- - -# Get-AzureRmDataFactoryV2Pipeline - -## SYNOPSIS -Gets information about pipelines in Data Factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Get-AzureRmDataFactoryV2Pipeline [[-Name] <String>] [-ResourceGroupName] <String> [-DataFactoryName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByFactoryObject -``` -Get-AzureRmDataFactoryV2Pipeline [[-Name] <String>] [-DataFactory] <PSDataFactory> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByResourceId -``` -Get-AzureRmDataFactoryV2Pipeline [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmDataFactoryV2Pipeline cmdlet gets information about pipelines in Azure Data Factory. -If you specify the name of a pipeline, this cmdlet gets information about that pipeline. -If you do not specify a name, this cmdlet gets information about all the pipelines in the data factory. - -## EXAMPLES - -### Example 1: Get information about all pipelines -``` -PS C:\> Get-AzureRmDataFactoryV2Pipeline -ResourceGroupName "ADF" -DataFactoryName "WikiADF" - - PipelineName : DPWikisample - ResourceGroupName : ADF - DataFactoryName : WikiADF - Activities : {MyWebActivity} - Parameters : {[url, Microsoft.Azure.Management.DataFactory.Models.ParameterSpecification]} - - PipelineName : DPTwittersample - ResourceGroupName : ADF - DataFactoryName : WikiADF - Activities : {MyCopyActivity_0_0, MyCopyActivity_1_0} - Parameters : {[OutputBlobName, Microsoft.Azure.Management.DataFactory.Models.ParameterSpecification]} -``` - -This command gets information about all pipelines in the data factory named WikiADF. -You can use either one of the following example commands. -The second one uses a DataFactory object as a parameter. - -### Example 2: Get information about a specific pipeline -``` -PS C:\> Get-AzureRmDataFactoryV2Pipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF" | Format-List - - PipelineName : DPWikisample - ResourceGroupName : ADF - DataFactoryName : WikiADF - Activities : {MyCopyActivity_0_0, MyCopyActivity_1_0} - Parameters : {[OutputBlobName, Microsoft.Azure.Management.DataFactory.Models.ParameterSpecification]} -``` - -This command gets information about the pipeline named DPWikisample in the data factory named WikiADF. -The command passes that information to the Format-List cmdlet by using the pipeline operator. -That Windows PowerShell cmdlet formats the results. -For more information, type Get-Help Format-List. - -### Example 3: Get the properties for a specific pipeline -``` -PS C:\> (Get-AzureRmDataFactoryV2Pipeline -ResourceGroupName "ADF" -Name DPWikisample -DataFactoryName "WikiADF").Activities - - Source : Microsoft.Azure.Management.DataFactory.Models.BlobSource - Sink : Microsoft.Azure.Management.DataFactory.Models.BlobSink - Translator : - EnableStaging : - StagingSettings : - ParallelCopies : - CloudDataMovementUnits : - EnableSkipIncompatibleRow : - RedirectIncompatibleRowSettings : - Inputs : {} - Outputs : {} - LinkedServiceName : - Policy : - Name : MyCopyActivity_0_0 - Description : - DependsOn : - - Source : Microsoft.Azure.Management.DataFactory.Models.BlobSource - Sink : Microsoft.Azure.Management.DataFactory.Models.BlobSink - Translator : - EnableStaging : - StagingSettings : - ParallelCopies : - CloudDataMovementUnits : - EnableSkipIncompatibleRow : - RedirectIncompatibleRowSettings : - Inputs : {} - Outputs : {} - LinkedServiceName : - Policy : - Name : MyCopyActivity_1_0 - Description : - DependsOn : {Microsoft.Azure.Management.DataFactory.Models.ActivityDependency} -``` - -This command gets information for the pipeline named DPWikisample in the data factory named WikiADF, and then uses standard dot notation to view the Activities property associated with that pipeline. - -### Example 6: Get information about inputs for the first activity -``` -PS C:\> (Get-AzureRmDataFactoryV2Pipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF11").Activities[0].Inputs | Format-List - - ReferenceName : dsIn - Parameters : -``` - -This command gets information for the pipeline named DPWikisample in the data factory named WikiADF, and then uses standard dot notation to view the Activities property associated with that pipeline. -The command displays the Inputs property of the first element of the Activities array by using the Format-List cmdlet. - -## PARAMETERS - -### -DataFactory -Specifies a PSDataFactory object. -This cmdlet gets pipelines that belong to the data factory that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DataFactoryName -Specifies the name of a data factory. -This cmdlet gets pipelines that belong to the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the pipeline about which to get information. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName, ByFactoryObject -Aliases: PipelineName - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet gets pipelines that belong to the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory -Parameters: DataFactory (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSPipeline - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[Set-AzureRmDataFactoryV2Pipeline]() - -[Remove-AzureRmDataFactoryV2Pipeline]() - -[Invoke-AzureRmDataFactoryV2Pipeline]() diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2PipelineRun.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2PipelineRun.md deleted file mode 100644 index 450f8c674a..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2PipelineRun.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/get-azurermdatafactoryv2pipelinerun -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Get-AzureRmDataFactoryV2PipelineRun.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Get-AzureRmDataFactoryV2PipelineRun.md ---- - -# Get-AzureRmDataFactoryV2PipelineRun - -## SYNOPSIS -Gets information about pipeline runs. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryNameByRunId (Default) -``` -Get-AzureRmDataFactoryV2PipelineRun [-ResourceGroupName] <String> [-DataFactoryName] <String> - [-PipelineRunId] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByFactoryObjectByRunId -``` -Get-AzureRmDataFactoryV2PipelineRun [-DataFactory] <PSDataFactory> [-PipelineRunId] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByFactoryObjectByPipeline -``` -Get-AzureRmDataFactoryV2PipelineRun [-DataFactory] <PSDataFactory> [-LastUpdatedAfter] <DateTime> - [-LastUpdatedBefore] <DateTime> [[-PipelineName] <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByFactoryNameByPipeline -``` -Get-AzureRmDataFactoryV2PipelineRun [-ResourceGroupName] <String> [-DataFactoryName] <String> - [-LastUpdatedAfter] <DateTime> [-LastUpdatedBefore] <DateTime> [[-PipelineName] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDataFactoryV2PipelineRun** command returns information about runs for the specified pipeline. If PipelineRunId is specified, it shows details for the run with that ID. If the PipelineRunId is not specified, then it shows information about all runs for the specified pipeline that happened between the values of LastUpdatedAfter and LastUpdatedBefore. - -## EXAMPLES - -### Example 1: Get information for a pipline run -``` -PS C:\> Get-AzureRmDataFactoryV2PipelineRun -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -PipelineRunId "61eb095a-fe23-4591-8a97-fade6c65ca72" - - ResourceGroupName : ADF - DataFactoryName : WikiADF - RunId : 61eb095a-fe23-4591-8a97-fade6c65ca72 - PipelineName : DPWikisample - LastUpdated : 9/14/2017 12:21:02 AM - Parameters : {[url, http://adfsamplewebapi.azurewebsites.net/api/execute/sample]} - RunStart : 9/14/2017 12:20:54 AM - RunEnd : 9/14/2017 12:21:02 AM - DurationInMs : 8246 - Status : Succeeded - Message : -``` - -This command gets details about the pipeline run with ID "61eb095a-fe23-4591-8a97-fade6c65ca72". - -## PARAMETERS - -### -DataFactory -The data factory object. - -```yaml -Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory -Parameter Sets: ByFactoryObjectByRunId, ByFactoryObjectByPipeline -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DataFactoryName -The data factory name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryNameByRunId, ByFactoryNameByPipeline -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LastUpdatedAfter -The time at or after which the pipeline run was updated in ISO8601 format. - -```yaml -Type: System.DateTime -Parameter Sets: ByFactoryObjectByPipeline, ByFactoryNameByPipeline -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LastUpdatedBefore -The time at or before which the pipeline run was updated in ISO8601 format. - -```yaml -Type: System.DateTime -Parameter Sets: ByFactoryObjectByPipeline, ByFactoryNameByPipeline -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PipelineName -The pipeline name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryObjectByPipeline, ByFactoryNameByPipeline -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PipelineRunId -The Run ID of the pipeline. - -```yaml -Type: System.String -Parameter Sets: ByFactoryNameByRunId, ByFactoryObjectByRunId -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryNameByRunId, ByFactoryNameByPipeline -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory -Parameters: DataFactory (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSPipelineRun - -## NOTES - -## RELATED LINKS - -[Invoke-AzureRmDataFactoryV2Pipeline]() - -[Get-AzureRmDataFactoryV2ActivityRun]() - diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2Trigger.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2Trigger.md deleted file mode 100644 index 0c1a5996ef..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2Trigger.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/get-azurermdatafactoryv2trigger -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Get-AzureRmDataFactoryV2Trigger.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Get-AzureRmDataFactoryV2Trigger.md ---- - -# Get-AzureRmDataFactoryV2Trigger - -## SYNOPSIS -Gets information about triggers in a data factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Get-AzureRmDataFactoryV2Trigger [[-Name] <String>] [-ResourceGroupName] <String> [-DataFactoryName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByFactoryObject -``` -Get-AzureRmDataFactoryV2Trigger [[-Name] <String>] [-DataFactory] <PSDataFactory> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByResourceId -``` -Get-AzureRmDataFactoryV2Trigger [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDataFactoryV2Trigger** cmdlet gets information about triggers in a data factory. If you specify the name of a trigger, the cmdlet gets information about that trigger. If you do not specify a name, the cmdlet gets information about all triggers in the data factory. - -## EXAMPLES - -### Example 1: Get information about a specific trigger -``` -PS C:\> Get-AzureRmDataFactoryV2Trigger -ResourceGroupName "ADF" -DataFactoryName "WikiADF" - - TriggerName : ScheduledTrigger - ResourceGroupName : ADF - DataFactoryName : WikiADF - Properties : Microsoft.Azure.Management.DataFactory.Models.ScheduleTrigger - RuntimeState : Stopped - - TriggerName : ScheduledTrigger2 - ResourceGroupName : ADF - DataFactoryName : WikiADF - Properties : Microsoft.Azure.Management.DataFactory.Models.ScheduleTrigger - RuntimeState : Stopped -``` - -Gets a list of all triggers that have been created in the data factory "WikiADF". - -### Example 2: Get information about all triggers -``` -Get-AzureRmDataFactoryV2Trigger -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -TriggerName "ScheduledTrigger" - - TriggerName : ScheduledTrigger - ResourceGroupName : ADF - DataFactoryName : WikiADF - Properties : Microsoft.Azure.Management.DataFactory.Models.ScheduleTrigger - RuntimeState : Stopped -``` - -Gets a single trigger called "ScheduledTrigger" in the data factory "WikiADF". - -## PARAMETERS - -### -DataFactory -The data factory object. - -```yaml -Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DataFactoryName -The data factory name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The trigger name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName, ByFactoryObject -Aliases: TriggerName - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory -Parameters: DataFactory (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSTrigger - -## NOTES - -## RELATED LINKS - -[Set-AzureRmDataFactoryV2Trigger]() - -[Start-AzureRmDataFactoryV2Trigger]() - -[Stop-AzureRmDataFactoryV2Trigger]() - -[Remove-AzureRmDataFactoryV2Trigger]() diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2TriggerRun.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2TriggerRun.md deleted file mode 100644 index 45909c6574..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Get-AzureRmDataFactoryV2TriggerRun.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/get-azurermdatafactoryv2triggerrun -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Get-AzureRmDataFactoryV2TriggerRun.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Get-AzureRmDataFactoryV2TriggerRun.md ---- - -# Get-AzureRmDataFactoryV2TriggerRun - -## SYNOPSIS -Returns information about trigger runs. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Get-AzureRmDataFactoryV2TriggerRun [-Name] <String> [-TriggerRunStartedAfter] <DateTime> - [-TriggerRunStartedBefore] <DateTime> [-ResourceGroupName] <String> [-DataFactoryName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByFactoryObject -``` -Get-AzureRmDataFactoryV2TriggerRun [-Name] <String> [-TriggerRunStartedAfter] <DateTime> - [-TriggerRunStartedBefore] <DateTime> [-DataFactory] <PSDataFactory> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDataFactoryV2TriggerRun** command returns detailed information about trigger runs for the specified trigger in the given timeframe. - -## EXAMPLES - -### Example 1: Get information about trigger run -``` -PS C:\> Get-AzureRmDataFactoryV2TriggerRun -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -TriggerName "WikiTrigger" -TriggerRunStartedAfter "2017-09-01" -TriggerRunStartedBefore "2019-09-30" - - ResourceGroupName : ADF - DataFactoryName : WikiADF - TriggerName : WikiTrigger - TriggerRunId : 08586958400454144995526033731 - TriggerType : ScheduleTrigger - TriggerRunTimestamp : 9/18/2017 8:34:00 PM - Status : Succeeded -``` - -This command shows information about runs for "WikiTrigger" in the factory "WikiADF" that started between "2017-09-01" and "2019-09-30". - -## PARAMETERS - -### -DataFactory -The data factory object. - -```yaml -Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DataFactoryName -The data factory name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The trigger name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: TriggerName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TriggerRunStartedAfter -The time at or after which the trigger run started to execute in ISO8601 format. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TriggerRunStartedBefore -The time at or before which the trigger run started to execute in ISO8601 format. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory -Parameters: DataFactory (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSTriggerRun - -## NOTES - -## RELATED LINKS - -[Start-AzureRmDataFactoryV2Trigger]() - -[Stop-AzureRmDataFactoryV2Trigger]() - diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Invoke-AzureRmDataFactoryV2IntegrationRuntimeUpgrade.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Invoke-AzureRmDataFactoryV2IntegrationRuntimeUpgrade.md deleted file mode 100644 index d05f85b2e6..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Invoke-AzureRmDataFactoryV2IntegrationRuntimeUpgrade.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/invoke-azurermdatafactoryv2integrationruntimeupgrade -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Invoke-AzureRmDataFactoryV2IntegrationRuntimeUpgrade.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Invoke-AzureRmDataFactoryV2IntegrationRuntimeUpgrade.md ---- - -# Invoke-AzureRmDataFactoryV2IntegrationRuntimeUpgrade - -## SYNOPSIS -Upgrades self-hosted integration runtime. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByIntegrationRuntimeName (Default) -``` -Invoke-AzureRmDataFactoryV2IntegrationRuntimeUpgrade [-Name] <String> [-ResourceGroupName] <String> - [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByResourceId -``` -Invoke-AzureRmDataFactoryV2IntegrationRuntimeUpgrade [-ResourceId] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByIntegrationRuntimeObject -``` -Invoke-AzureRmDataFactoryV2IntegrationRuntimeUpgrade [-InputObject] <PSIntegrationRuntime> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Invoke-AzureRmDataFactoryV2IntegrationRuntimeUpgrade** cmdlet upgrades self-hosted integration runtime if the new version is available. - -## EXAMPLES - -### Example 1: Upgrades a self-hosted integration runtime -``` -PS C:\> Invoke-AzureRmDataFactoryV2IntegrationRuntimeUpgrade -ResourceGroupName 'rg-test-dfv2' -DataFactoryName 'test-df-eu2' -Name 'test-selfhost-ir' -``` - -The cmdlet upgrades self-hosted integration runtime named 'test-selfhost-ir' in data factory 'test-df-eu2'. - -## PARAMETERS - -### -DataFactoryName -The data factory name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The integration runtime object. - -```yaml -Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime -Parameter Sets: ByIntegrationRuntimeObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The integration runtime name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: IntegrationRuntimeName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: Id - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, data, factories, copy, activities, integration runtime - -## RELATED LINKS - -[Set-AzureRmDataFactoryV2IntegrationRuntime]() -[Get-AzureRmDataFactoryV2IntegrationRuntime]() - diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Invoke-AzureRmDataFactoryV2Pipeline.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Invoke-AzureRmDataFactoryV2Pipeline.md deleted file mode 100644 index 6776aa8946..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Invoke-AzureRmDataFactoryV2Pipeline.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/invoke-azurermdatafactoryv2pipeline -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Invoke-AzureRmDataFactoryV2Pipeline.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Invoke-AzureRmDataFactoryV2Pipeline.md ---- - -# Invoke-AzureRmDataFactoryV2Pipeline - -## SYNOPSIS - Invokes a pipeline to start a run for it. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryNameByParameterFile (Default) -``` -Invoke-AzureRmDataFactoryV2Pipeline [-ResourceGroupName] <String> [-DataFactoryName] <String> - [-PipelineName] <String> [[-ParameterFile] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ByPipelineObjectByParameterFile -``` -Invoke-AzureRmDataFactoryV2Pipeline [-InputObject] <PSPipeline> [[-ParameterFile] <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByPipelineObjectByParameterObject -``` -Invoke-AzureRmDataFactoryV2Pipeline [-InputObject] <PSPipeline> [[-Parameter] <Hashtable>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByFactoryNameByParameterObject -``` -Invoke-AzureRmDataFactoryV2Pipeline [-ResourceGroupName] <String> [-DataFactoryName] <String> - [-PipelineName] <String> [[-Parameter] <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Invoke-AzureRmDataFactoryV2Pipeline** command starts a run on the specified pipeline and returns a ID for that run. This GUID can be passed to **Get-AzureRmDataFactoryV2PipelineRun** or **Get-AzureRmDataFactoryV2ActivityRun** to obtain further details about this run. - -## EXAMPLES - -### Example 1: Invoke a pipeline to start a run -``` -PS C:\> Invoke-AzureRmDataFactoryV2Pipeline -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -PipelineName "DPWikisample" -867d9d9f-1efc-4fee-974d-d8e6320bfbcb -``` - -This command starts a run for "DPWikisample" pipeline in the "WikiADF" factory. - -## PARAMETERS - -### -DataFactoryName -The data factory name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryNameByParameterFile, ByFactoryNameByParameterObject -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The data factory object. - -```yaml -Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSPipeline -Parameter Sets: ByPipelineObjectByParameterFile, ByPipelineObjectByParameterObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Parameter -Parameters for pipeline run. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: ByPipelineObjectByParameterObject, ByFactoryNameByParameterObject -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ParameterFile -The name of the file with parameters for pipeline run. - -```yaml -Type: System.String -Parameter Sets: ByFactoryNameByParameterFile, ByPipelineObjectByParameterFile -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PipelineName -The pipeline name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryNameByParameterFile, ByFactoryNameByParameterObject -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryNameByParameterFile, ByFactoryNameByParameterObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what happens if the cmdlet runs, but doesn't run the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSPipeline -Parameters: InputObject (ByValue) - -### System.String - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSPipeline - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDataFactoryV2PipelineRun]() - -[Get-AzureRmDataFactoryV2ActivityRun]() - diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/New-AzureRmDataFactoryV2IntegrationRuntimeKey.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/New-AzureRmDataFactoryV2IntegrationRuntimeKey.md deleted file mode 100644 index 8b2c41aefd..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/New-AzureRmDataFactoryV2IntegrationRuntimeKey.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/new-azurermdatafactoryv2integrationruntimekey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/New-AzureRmDataFactoryV2IntegrationRuntimeKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/New-AzureRmDataFactoryV2IntegrationRuntimeKey.md ---- - -# New-AzureRmDataFactoryV2IntegrationRuntimeKey - -## SYNOPSIS -Regenerate self-hosted integration runtime key. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByIntegrationRuntimeName (Default) -``` -New-AzureRmDataFactoryV2IntegrationRuntimeKey -KeyName <String> [-Force] [-Name] <String> - [-ResourceGroupName] <String> [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -New-AzureRmDataFactoryV2IntegrationRuntimeKey -KeyName <String> [-Force] [-ResourceId] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByIntegrationRuntimeObject -``` -New-AzureRmDataFactoryV2IntegrationRuntimeKey -KeyName <String> [-Force] [-InputObject] <PSIntegrationRuntime> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The cmdlet **New-AzureRmDataFactoryV2IntegrationRuntimeKey** regenerates the integration runtime key with the key name specified by 'KeyName' parameter. The previous key will is invalid. - -## EXAMPLES - -### Example 1: Generate a new key for an integration runtime -``` -PS C:\> New-AzureRmDataFactoryV2IntegrationRuntimeKey -ResourceGroupName 'rg-test-dfv2' -DataFactoryName 'test-df-eu2' -Name 'test-selfhost-ir' -KeyName authKey2 - -AuthKey1 AuthKey2 --------- -------- - IR@89895504-f647-48fd-8dd3-42fa556d67e3@*** -``` - -The cmdlet regenerates key 'authKey2' for integration runtime named 'test-selfhost-ir'. - -## PARAMETERS - -### -DataFactoryName -The data factory name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The integration runtime object. - -```yaml -Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime -Parameter Sets: ByIntegrationRuntimeObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -KeyName -The authentication key name of the self-hosted integration runtime. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: AuthKey1, AuthKey2 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The integration runtime name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: IntegrationRuntimeName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: Id - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what happens if the cmdlet runs, but doesn't run the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntimeKeys - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDataFactoryV2IntegrationRuntimeKey]() diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/New-AzureRmDataFactoryV2LinkedServiceEncryptedCredential.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/New-AzureRmDataFactoryV2LinkedServiceEncryptedCredential.md deleted file mode 100644 index 1dbc5cac9f..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/New-AzureRmDataFactoryV2LinkedServiceEncryptedCredential.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/new-azurermdatafactoryv2linkedserviceencryptedcredential -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/New-AzureRmDataFactoryV2LinkedServiceEncryptedCredential.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/New-AzureRmDataFactoryV2LinkedServiceEncryptedCredential.md ---- - -# New-AzureRmDataFactoryV2LinkedServiceEncryptedCredential - -## SYNOPSIS -Encrypt credential in linked service with specified integration runtime. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -New-AzureRmDataFactoryV2LinkedServiceEncryptedCredential [-IntegrationRuntimeName] <String> - [-DefinitionFile] <String> [-Force] [-ResourceGroupName] <String> [-DataFactoryName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByFactoryObject -``` -New-AzureRmDataFactoryV2LinkedServiceEncryptedCredential [-IntegrationRuntimeName] <String> - [-DefinitionFile] <String> [-Force] [-DataFactory] <PSDataFactory> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmDataFactoryV2LinkedServiceEncryptCredential cmdlet encrypt credential in linked service with specified integration runtime. - -## EXAMPLES - -### Example 1: Encrypt creadentials in a linked service -``` -PS C:\> New-AzureRmDataFactoryV2LinkedServiceEncryptCredential -ResourceGroupName resourceGroup -DataFactoryName myDataFactory -IntegrationRuntimeName myIR -File D:\sql.json -``` - -This command encrypts credential in file D:\sql.json with the integration runtime named myIR. - -## PARAMETERS - -### -DataFactory -The data factory object. - -```yaml -Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DataFactoryName -The data factory name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefinitionFile -The JSON file path. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: File - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IntegrationRuntimeName -The integration runtime name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what happens if the cmdlet runs, but doesn't run the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory -Parameters: DataFactory (ByValue) - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Remove-AzureRmDataFactoryV2.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Remove-AzureRmDataFactoryV2.md deleted file mode 100644 index 8c1f4f4bc2..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Remove-AzureRmDataFactoryV2.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/remove-azurermdatafactoryv2 -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Remove-AzureRmDataFactoryV2.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Remove-AzureRmDataFactoryV2.md ---- - -# Remove-AzureRmDataFactoryV2 - -## SYNOPSIS -Removes a data factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Remove-AzureRmDataFactoryV2 [-ResourceGroupName] <String> [-Name] <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByFactoryObject -``` -Remove-AzureRmDataFactoryV2 [-InputObject] <PSDataFactory> [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Remove-AzureRmDataFactoryV2 [-ResourceId] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmDataFactoryV2 cmdlet removes a data factory. - -## EXAMPLES - -### Example 1: Remove a data factory -``` -PS C:\> Remove-AzureRmDataFactoryV2 -Name "WikiADF" -ResourceGroupName "ADF" - Confirm - Are you sure you want to remove data factory 'WikiADF' in resource group 'ADF'? - [Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y - True -``` - -This command removes the data factory named WikiADF from the resource group named ADF. -This command returns a value of $True. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the DataFactory object to remove. - -```yaml -Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the data factory to remove. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: DataFactoryName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet removes a data factory from the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what happens if the cmdlet runs, but doesn't run the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[Get-AzureRmDataFactoryV2]() - -[Set-AzureRmDataFactoryV2]() diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Remove-AzureRmDataFactoryV2Dataset.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Remove-AzureRmDataFactoryV2Dataset.md deleted file mode 100644 index 1c653b98a5..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Remove-AzureRmDataFactoryV2Dataset.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/remove-azurermdatafactoryv2dataset -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Remove-AzureRmDataFactoryV2Dataset.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Remove-AzureRmDataFactoryV2Dataset.md ---- - -# Remove-AzureRmDataFactoryV2Dataset - -## SYNOPSIS -Removes a dataset from Data Factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Remove-AzureRmDataFactoryV2Dataset [-Name] <String> [-ResourceGroupName] <String> [-DataFactoryName] <String> - [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByInputObject -``` -Remove-AzureRmDataFactoryV2Dataset [-InputObject] <PSDataset> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Remove-AzureRmDataFactoryV2Dataset [-ResourceId] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmDataFactoryV2Dataset cmdlet removes a dataset from Azure Data Factory. - -## EXAMPLES - -### Example 1: Remove a dataset -``` -PS C:\> Remove-AzureRmDataFactoryV2Dataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikiAggregatedData" - Confirm - Are you sure you want to remove dataset 'DAWikiAggregatedData' in data factory 'WikiADF'? - [Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y - True -``` - -This command removes the dataset named DAWikiAggregatedData from the data factory named WikiADF. -The command returns a value of $True. - -## PARAMETERS - -### -DataFactoryName -Specifies the name of a data factory. -This cmdlet removes a dataset from the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies a Dataset object to remove. - -```yaml -Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataset -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the dataset to remove. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: DatasetName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet removes a dataset from the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what happens if the cmdlet runs, but doesn't run the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataset -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[Get-AzureRmDataFactoryV2Dataset]() - -[Set-AzureRmDataFactoryV2Dataset]() diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Remove-AzureRmDataFactoryV2IntegrationRuntime.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Remove-AzureRmDataFactoryV2IntegrationRuntime.md deleted file mode 100644 index b771aab4d3..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Remove-AzureRmDataFactoryV2IntegrationRuntime.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/remove-azurermdatafactoryv2integrationruntime -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Remove-AzureRmDataFactoryV2IntegrationRuntime.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Remove-AzureRmDataFactoryV2IntegrationRuntime.md ---- - -# Remove-AzureRmDataFactoryV2IntegrationRuntime - -## SYNOPSIS -Removes an integration runtime. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByIntegrationRuntimeName (Default) -``` -Remove-AzureRmDataFactoryV2IntegrationRuntime [-LinkedDataFactoryName <String>] [-Force] [-Name] <String> - [-ResourceGroupName] <String> [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Remove-AzureRmDataFactoryV2IntegrationRuntime [-LinkedDataFactoryName <String>] [-Force] [-ResourceId] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByIntegrationRuntimeObject -``` -Remove-AzureRmDataFactoryV2IntegrationRuntime [-LinkedDataFactoryName <String>] [-Force] - [-InputObject] <PSIntegrationRuntime> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmDataFactoryV2IntegrationRuntime cmdlet removes a integration runtime. - -## EXAMPLES - -### Example 1: Remove a integration runtime -``` -PS C:\> Remove-AzureRmDataFactoryV2IntegrationRuntime -ResourceGroupName 'rg-test-dfv2' -DataFactoryName 'test-df' -Name 'test-reserved-ir' -Confirm -``` - -This command removes the integration runtime named 'test-reserved-ir' from the data factory named 'test-df'. -This command returns a value of $True. - -## PARAMETERS - -### -DataFactoryName -The data factory name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The integration runtime object. - -```yaml -Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime -Parameter Sets: ByIntegrationRuntimeObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LinkedDataFactoryName -The linked data factory name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The integration runtime name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: IntegrationRuntimeName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: Id - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what happens if the cmdlet runs, but doesn't run the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, data, factories, copy, activities, integration runtime - -## RELATED LINKS - -[Set-AzureRmDataFactoryV2IntegrationRuntime]() - -[Get-AzureRmDataFactoryV2IntegrationRuntime]() - diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Remove-AzureRmDataFactoryV2IntegrationRuntimeNode.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Remove-AzureRmDataFactoryV2IntegrationRuntimeNode.md deleted file mode 100644 index 6fdbb0b19f..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Remove-AzureRmDataFactoryV2IntegrationRuntimeNode.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/remove-azurermdatafactoryv2integrationruntimenode -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Remove-AzureRmDataFactoryV2IntegrationRuntimeNode.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Remove-AzureRmDataFactoryV2IntegrationRuntimeNode.md ---- - -# Remove-AzureRmDataFactoryV2IntegrationRuntimeNode - -## SYNOPSIS -Remove a node with the given name on an integration runtime. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByIntegrationRuntimeName (Default) -``` -Remove-AzureRmDataFactoryV2IntegrationRuntimeNode -NodeName <String> [-Force] - [-IntegrationRuntimeName] <String> [-ResourceGroupName] <String> [-DataFactoryName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Remove-AzureRmDataFactoryV2IntegrationRuntimeNode -NodeName <String> [-Force] [-ResourceId] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByIntegrationRuntimeObject -``` -Remove-AzureRmDataFactoryV2IntegrationRuntimeNode -NodeName <String> [-Force] - [-InputObject] <PSIntegrationRuntime> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmDataFactoryV2IntegrationRuntimeNode cmdlet removes a node in an integration runtime. - -## EXAMPLES - -### Example 1: Remove a node from an integration runtime -``` -PS C:\> Remove-AzureRmDataFactoryV2IntegrationRuntimeNode -ResourceGroupName 'rg-test-dfv2' -DataFactoryName 'test-df-eu2' -Name 'test-selfhost-ir' -NodeName 'Node_1' -``` - -This command removes an node named 'Node_1' in the integration runtime named 'test-selfhost-ir' in the subscription for the resource group named 'rg-test-dfv2' and data factory named 'test-df-eu2'. - -## PARAMETERS - -### -DataFactoryName -The data factory name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The integration runtime object. - -```yaml -Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime -Parameter Sets: ByIntegrationRuntimeObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IntegrationRuntimeName -The integration runtime name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NodeName -The integration runtime node name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: Id - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what happens if the cmdlet runs, but doesn't run the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Remove-AzureRmDataFactoryV2LinkedService.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Remove-AzureRmDataFactoryV2LinkedService.md deleted file mode 100644 index 3169badac6..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Remove-AzureRmDataFactoryV2LinkedService.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/remove-azurermdatafactoryv2linkedservice -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Remove-AzureRmDataFactoryV2LinkedService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Remove-AzureRmDataFactoryV2LinkedService.md ---- - -# Remove-AzureRmDataFactoryV2LinkedService - -## SYNOPSIS -Removes a linked service from Data Factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Remove-AzureRmDataFactoryV2LinkedService [-Name] <String> [-ResourceGroupName] <String> - [-DataFactoryName] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByInputObject -``` -Remove-AzureRmDataFactoryV2LinkedService [-InputObject] <PSLinkedService> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Remove-AzureRmDataFactoryV2LinkedService [-ResourceId] <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmDataFactoryV2LinkedService cmdlet removes a linked service from Azure Data Factory. - -## EXAMPLES - -### Example 1: Remove a linked service -``` -PS C:\> Remove-AzureRmDataFactoryV2LinkedService -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "LinkedServiceTest" - Confirm - Are you sure you want to remove linked service 'LinkedServiceTest' in data factory 'WikiADF'? - [Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y - True -``` - -This command removes the linked service named LinkedServiceTest from the data factory named WikiADF. -This command returns a value of $True. - -## PARAMETERS - -### -DataFactoryName -Specifies the name of a data factory. -This cmdlet removes a linked service from the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the LinkedService object to remove. - -```yaml -Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSLinkedService -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the linked service to remove. -Name of the linked service. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: LinkedServiceName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet removes a linked service from the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID of the linked service to remove. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what happens if the cmdlet runs, but doesn't run the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSLinkedService -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[Get-AzureRmDataFactoryV2LinkedService]() - -[Set-AzureRmDataFactoryV2LinkedService]() - diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Remove-AzureRmDataFactoryV2Pipeline.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Remove-AzureRmDataFactoryV2Pipeline.md deleted file mode 100644 index 1ceb34038c..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Remove-AzureRmDataFactoryV2Pipeline.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/remove-azurermdatafactoryv2pipeline -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Remove-AzureRmDataFactoryV2Pipeline.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Remove-AzureRmDataFactoryV2Pipeline.md ---- - -# Remove-AzureRmDataFactoryV2Pipeline - -## SYNOPSIS -Removes a pipeline from Data Factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Remove-AzureRmDataFactoryV2Pipeline [-Name] <String> [-ResourceGroupName] <String> [-DataFactoryName] <String> - [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByInputObject -``` -Remove-AzureRmDataFactoryV2Pipeline [-InputObject] <PSPipeline> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Remove-AzureRmDataFactoryV2Pipeline [-ResourceId] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmDataFactoryV2Pipeline cmdlet removes a pipeline from Azure Data Factory. - -## EXAMPLES - -### Example 1: Remove a pipeline -``` -PS C:\> Remove-AzureRmDataFactoryV2Pipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF" - Confirm - Are you sure you want to remove pipeline 'DPWikisample' in data factory 'WikiADF'? - [Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y - True -``` - -This cmdlet removes the pipeline named DPWikisample from the data factory named WikiADF. -The command returns a value of $True. - -## PARAMETERS - -### -DataFactoryName -Specifies the name of a data factory. -This cmdlet removes a pipeline from the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies a Pipeline object. -This cmdlet removes the pipeline that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSPipeline -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the pipeline to remove. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: PipelineName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet removes a pipeline from the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID of the pipeline to remove. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what happens if the cmdlet runs, but doesn't run the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSPipeline -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[Get-AzureRmDataFactoryV2Pipeline]() - -[Set-AzureRmDataFactoryV2Pipeline]() - -[Invoke-AzureRmDataFactoryV2Pipeline]() - diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Remove-AzureRmDataFactoryV2Trigger.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Remove-AzureRmDataFactoryV2Trigger.md deleted file mode 100644 index 4bdafcdeb8..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Remove-AzureRmDataFactoryV2Trigger.md +++ /dev/null @@ -1,216 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/remove-azurermdatafactoryv2trigger -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Remove-AzureRmDataFactoryV2Trigger.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Remove-AzureRmDataFactoryV2Trigger.md ---- - -# Remove-AzureRmDataFactoryV2Trigger - -## SYNOPSIS -Removes a trigger from a data factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Remove-AzureRmDataFactoryV2Trigger [-Name] <String> [-ResourceGroupName] <String> [-DataFactoryName] <String> - [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByInputObject -``` -Remove-AzureRmDataFactoryV2Trigger [-InputObject] <PSTrigger> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Remove-AzureRmDataFactoryV2Trigger [-ResourceId] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmDataFactoryV2Trigger** cmdlet removes a trigger from a data factory. If the _Force_ parameter is specified, the cmdlet doesn't prompt before removing the trigger. - -## EXAMPLES - -### Example 1: Remove a trigger -``` -Remove-AzureRmDataFactoryV2Trigger -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "ScheduledTrigger" - -Confirm -Are you sure you want to remove trigger 'ScheduledTrigger' in data factory 'TestFactory'? -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y -True -``` - -Remove a trigger called "ScheduledTrigger" from the data factory "WikiADF". - -## PARAMETERS - -### -DataFactoryName -The data factory name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The Trigger object to remove. - -```yaml -Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSTrigger -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The trigger name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: TriggerName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what happens if the cmdlet runs, but doesn't run the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSTrigger -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDataFactoryV2Trigger]() - -[Set-AzureRmDataFactoryV2Trigger]() - -[Start-AzureRmDataFactoryV2Trigger]() - -[Stop-AzureRmDataFactoryV2Trigger]() - diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Set-AzureRmDataFactoryV2.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Set-AzureRmDataFactoryV2.md deleted file mode 100644 index 2750982e4c..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Set-AzureRmDataFactoryV2.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/set-azurermdatafactoryv2 -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Set-AzureRmDataFactoryV2.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Set-AzureRmDataFactoryV2.md ---- - -# Set-AzureRmDataFactoryV2 - -## SYNOPSIS -Creates a data factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmDataFactoryV2 [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> - [[-Tag] <Hashtable>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDataFactoryV2** cmdlet creates a data factory with the specified resource group name and location. -Perform these operations in the following order: - -- Create a data factory. - -- Create linked services. - -- Create datasets. - -- Create a pipeline. - -## EXAMPLES - -### Example 1: Create a data factory -``` -PS C:\> Set-AzureRmDataFactoryV2 -ResourceGroupName "ADF" -Name "WikiADF" -Location "WestUS" - - DataFactoryName : WikiADF - DataFactoryId : /subscriptions/3e8e61b5-9a7d-4952-bfae-545ab997b9ea/resourceGroups/adf/providers/Microsoft.DataFactory/factories/wikiadf - ResourceGroupName : ADF - Location : EastUS - Tags : {} - Identity : Microsoft.Azure.Management.DataFactory.Models.FactoryIdentity - ProvisioningState : Succeeded -``` - -This command creates a data factory named WikiADF in the resource group named ADF in the WestUS location. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The data factory is created in this region. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The data factory name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: DataFactoryName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -The tags of the data factory. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what happens if the cmdlet runs, but doesn't run the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[Get-AzureRmDataFactoryV2]() - -[Remove-AzureRmDataFactoryV2]() diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Set-AzureRmDataFactoryV2Dataset.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Set-AzureRmDataFactoryV2Dataset.md deleted file mode 100644 index c3b6eb931d..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Set-AzureRmDataFactoryV2Dataset.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/set-azurermdatafactoryv2dataset -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Set-AzureRmDataFactoryV2Dataset.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Set-AzureRmDataFactoryV2Dataset.md ---- - -# Set-AzureRmDataFactoryV2Dataset - -## SYNOPSIS -Creates a dataset in Data Factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Set-AzureRmDataFactoryV2Dataset [-Name] <String> [-DefinitionFile] <String> [-ResourceGroupName] <String> - [-DataFactoryName] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByResourceId -``` -Set-AzureRmDataFactoryV2Dataset [-DefinitionFile] <String> [-ResourceId] <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Set-AzureRmDataFactoryV2Dataset cmdlet creates a dataset in Azure Data Factory. -If you specify a name for a dataset that already exists, this cmdlet prompts you for confirmation before it replaces the dataset. -If you specify the Force parameter, the cmdlet replaces the existing dataset without confirmation. -Perform these operations in the following order: - -- Create a data factory. - -- Create linked services. - -- Create datasets. - -- Create a pipeline. -If a dataset with the same name already exists in the data factory, this cmdlet prompts you to confirm whether to overwrite the existing dataset with the new dataset. -If you confirm to overwrite the existing dataset, the dataset definition is also replaced. - -## EXAMPLES - -### Example 1: Create a dataset -``` -PS C:\> Set-AzureRmDataFactoryV2Dataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikipediaClickEvents" -DefinitionFile "C:\\samples\\WikiSample\\DA_WikipediaClickEvents.json" - - DatasetName : DAWikipediaClickEvents - ResourceGroupName : ADF - DataFactoryName : WikiADF - Structure : - Properties : Microsoft.Azure.Management.DataFactory.Models.AzureBlobDataset -``` - -This command creates a dataset named DA_WikipediaClickEvents in the data factory named WikiADF. -The command bases the dataset on information in the DAWikipediaClickEvents.json file. - -## PARAMETERS - -### -DataFactoryName -Specifies the name of a data factory. -This cmdlet creates a dataset in the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefinitionFile -The JSON file path. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: File - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the dataset to create. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: DatasetName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet creates a dataset in the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what happens if the cmdlet runs, but doesn't run the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataset - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[Get-AzureRmDataFactoryV2Dataset]() - -[Remove-AzureRmDataFactoryV2Dataset]() diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Set-AzureRmDataFactoryV2IntegrationRuntime.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Set-AzureRmDataFactoryV2IntegrationRuntime.md deleted file mode 100644 index e19b9ab9b6..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Set-AzureRmDataFactoryV2IntegrationRuntime.md +++ /dev/null @@ -1,501 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/set-azurermdatafactoryv2integrationruntime -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Set-AzureRmDataFactoryV2IntegrationRuntime.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Set-AzureRmDataFactoryV2IntegrationRuntime.md ---- - -# Set-AzureRmDataFactoryV2IntegrationRuntime - -## SYNOPSIS -Updates an integration runtime. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByIntegrationRuntimeName (Default) -``` -Set-AzureRmDataFactoryV2IntegrationRuntime [-ResourceGroupName] <String> [-DataFactoryName] <String> - [-Name] <String> [-Type <String>] [-Description <String>] [-Location <String>] [-NodeSize <String>] - [-NodeCount <Int32>] [-CatalogServerEndpoint <String>] [-CatalogAdminCredential <PSCredential>] - [-CatalogPricingTier <String>] [-VNetId <String>] [-Subnet <String>] [-SetupScriptContainerSasUri <String>] - [-Edition <String>] [-MaxParallelExecutionsPerNode <Int32>] [-LicenseType <String>] [-AuthKey <SecureString>] - [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Set-AzureRmDataFactoryV2IntegrationRuntime [-ResourceId] <String> [-Type <String>] [-Description <String>] - [-Location <String>] [-NodeSize <String>] [-NodeCount <Int32>] [-CatalogServerEndpoint <String>] - [-CatalogAdminCredential <PSCredential>] [-CatalogPricingTier <String>] [-VNetId <String>] [-Subnet <String>] - [-SetupScriptContainerSasUri <String>] [-Edition <String>] [-MaxParallelExecutionsPerNode <Int32>] - [-LicenseType <String>] [-AuthKey <SecureString>] [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByLinkedIntegrationRuntimeResourceId -``` -Set-AzureRmDataFactoryV2IntegrationRuntime [-ResourceId] <String> [-Type <String>] [-Description <String>] - -SharedIntegrationRuntimeResourceId <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ByLinkedIntegrationRuntimeName -``` -Set-AzureRmDataFactoryV2IntegrationRuntime [-ResourceGroupName] <String> [-DataFactoryName] <String> - [-Name] <String> [-Type <String>] [-Description <String>] -SharedIntegrationRuntimeResourceId <String> - [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByIntegrationRuntimeObject -``` -Set-AzureRmDataFactoryV2IntegrationRuntime [-InputObject] <PSIntegrationRuntime> [-Type <String>] - [-Description <String>] [-Location <String>] [-NodeSize <String>] [-NodeCount <Int32>] - [-CatalogServerEndpoint <String>] [-CatalogAdminCredential <PSCredential>] [-CatalogPricingTier <String>] - [-VNetId <String>] [-Subnet <String>] [-SetupScriptContainerSasUri <String>] [-Edition <String>] - [-MaxParallelExecutionsPerNode <Int32>] [-LicenseType <String>] [-AuthKey <SecureString>] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByLinkedIntegrationRuntimeObject -``` -Set-AzureRmDataFactoryV2IntegrationRuntime [-InputObject] <PSIntegrationRuntime> [-Type <String>] - [-Description <String>] -SharedIntegrationRuntimeResourceId <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Set-AzureRmDataFactoryV2IntegrationRuntime cmdlet updates an integration runtime with specific parameters. - -## EXAMPLES - -### Example 1: Update integration runtime description. -``` -PS C:\> Set-AzureRmDataFactoryV2IntegrationRuntime -ResourceGroupName 'rg-test-dfv2' -DataFactoryName 'test-df-eu2' -Name 'test-selfhost-ir' ` - -Description 'New description' - - Id : /subscriptions/b3ee3a7f-7614-4644-ad07-afa832620b4b/resourceGroups/rg-test-dfv2/providers/Microsoft.DataFactory/factories/test-df-eu2/integrationruntimes/test-selfhost-ir - ResourceGroupName : rg-test-dfv2 - DataFactoryName : test-df-eu2 - Name : test-selfhost-ir - Description : New description -``` - -The cmdlet updates the description of integration runtime named 'test-selfhost-ir'. - -### Example 2: Share Self-hosted integration runtime. -``` -PS C:\> Set-AzureRmDataFactoryV2IntegrationRuntime -ResourceGroupName 'rg-test-dfv2' -DataFactoryName 'test-df-eu2' -Name 'test-selfhost-ir' ` - -SharedIntegrationRuntimeResourceId '/subscriptions/b3ee3a7f-7614-4644-ad07-afa832620b4b/resourceGroups/rg-test-dfv2/providers/Microsoft.DataFactory/factories/test-df-eu2/integrationruntimes/test-selfhost-ir' -Type "SelfHosted" - - Id : /subscriptions/b3ee3a7f-7614-4644-ad07-afa832620b4b/resourceGroups/rg-test-dfv2/providers/Microsoft.DataFactory/factories/test-df-eu2/integrationruntimes/test-selfhost-ir - ResourceGroupName : rg-test-dfv2 - DataFactoryName : test-df-eu2 - Name : test-selfhost-ir - Description : New description -``` - -The cmdlet adds the ADF to use the shared integration runtime. When using `-SharedIntegrationRuntimeResourceId` parameter the `-Type` must also be included. Note that the data factory need to be granted permission to use the integration runtime before running cmdlet. - -## PARAMETERS - -### -AuthKey -The authentication key of the self-hosted integration runtime. - -```yaml -Type: System.Security.SecureString -Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CatalogAdminCredential -The catalog database administrator credential of the integration runtime. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CatalogPricingTier -The catalog database pricing tier of the integration runtime. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CatalogServerEndpoint -The catalog database server endpoint of the integration runtime. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataFactoryName -The data factory name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName, ByLinkedIntegrationRuntimeName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The integration runtime description. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Edition -The edition for SSIS integration runtime which could be Standard or Enterprise, default is Standard if it is not specified. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject -Aliases: -Accepted values: Standard, Enterprise - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The integration runtime object. - -```yaml -Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime -Parameter Sets: ByIntegrationRuntimeObject, ByLinkedIntegrationRuntimeObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LicenseType -The license type that you want to select for the SSIS IR. There are two types: LicenseIncluded or BasePrice. If you are qualified for the Azure Hybrid Use Benefit (AHUB) pricing, please select BasePrice. If not, please select LicenseIncluded. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject -Aliases: -Accepted values: LicenseIncluded, BasePrice - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The integration runtime location. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxParallelExecutionsPerNode -Maximum parallel execution count per node for a managed dedicated integration runtime. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The integration runtime name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName, ByLinkedIntegrationRuntimeName -Aliases: IntegrationRuntimeName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NodeCount -Target nodes count of the integration runtime. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NodeSize -The integration runtime node size. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName, ByLinkedIntegrationRuntimeName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId, ByLinkedIntegrationRuntimeResourceId -Aliases: Id - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SetupScriptContainerSasUri -The SAS URI of the Azure blob container that contains the custom setup script. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharedIntegrationRuntimeResourceId -The resource id of the shared self-hosted integration runtime. - -```yaml -Type: System.String -Parameter Sets: ByLinkedIntegrationRuntimeResourceId, ByLinkedIntegrationRuntimeName, ByLinkedIntegrationRuntimeObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subnet -The name of the subnet in the VNet. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject -Aliases: SubnetName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -The integration runtime type. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Managed, SelfHosted - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VNetId -The ID of the VNet that the integration runtime joins. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName, ByResourceId, ByIntegrationRuntimeObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what happens if the cmdlet runs, but doesn't run the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime - -## NOTES - -## RELATED LINKS - -[Set-AzureRmDataFactoryV2IntegrationRuntime]() diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Set-AzureRmDataFactoryV2LinkedService.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Set-AzureRmDataFactoryV2LinkedService.md deleted file mode 100644 index f149b9bf7b..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Set-AzureRmDataFactoryV2LinkedService.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/set-azurermdatafactoryv2linkedservice -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Set-AzureRmDataFactoryV2LinkedService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Set-AzureRmDataFactoryV2LinkedService.md ---- - -# Set-AzureRmDataFactoryV2LinkedService - -## SYNOPSIS -Links a data store or a cloud service to Data Factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Set-AzureRmDataFactoryV2LinkedService [-Name] <String> [-DefinitionFile] <String> [-ResourceGroupName] <String> - [-DataFactoryName] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByResourceId -``` -Set-AzureRmDataFactoryV2LinkedService [-DefinitionFile] <String> [-ResourceId] <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Set-AzureRmDataFactoryV2LinkedService cmdlet links a data store or a cloud service to Azure Data Factory. -If you specify a name for a linked service that already exists, this cmdlet prompts you for confirmation before it replaces the linked service. -If you specify the Force parameter, the cmdlet replaces the existing linked service without confirmation. -Perform these operations in the following order: - -- Create a data factory. - -- Create linked services. - -- Create datasets. - -- Create a pipeline. - -## EXAMPLES - -### Example 1: Create a linked service -``` -PS C:\> Set-AzureRmDataFactoryV2LinkedService -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "LinkedServiceCuratedWikiData" -File "C:\\samples\\WikiSample\\LinkedServiceCuratedWikiData.json" | Format-List - - LinkedServiceName : LinkedServiceCuratedWikiData - ResourceGroupName : ADF - DataFactoryName : WikiADF - Properties : Microsoft.Azure.Management.DataFactory.Models.AzureStorageLinkedService -``` - -This command creates a linked service named LinkedServiceCuratedWikiData in the data factory named WikiADF. -This linked service links an Azure blob store specified in the file to the data factory named WikiADF. -The command passes the result to the Format-List cmdlet by using the pipeline operator. -That Windows PowerShell cmdlet formats the results. -For more information, type Get-Help Format-List. - -## PARAMETERS - -### -DataFactoryName -Specifies the name of a data factory. -This cmdlet creates a linked service for the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefinitionFile -The JSON file path. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: File - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the linked service to create. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: LinkedServiceName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet creates a linked service for the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what happens if the cmdlet runs, but doesn't run the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSLinkedService - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[Get-AzureRmDataFactoryV2LinkedService]() - -[Remove-AzureRmDataFactoryV2LinkedService]() diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Set-AzureRmDataFactoryV2Pipeline.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Set-AzureRmDataFactoryV2Pipeline.md deleted file mode 100644 index 2376fc5b48..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Set-AzureRmDataFactoryV2Pipeline.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/set-azurermdatafactoryv2pipeline -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Set-AzureRmDataFactoryV2Pipeline.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Set-AzureRmDataFactoryV2Pipeline.md ---- - -# Set-AzureRmDataFactoryV2Pipeline - -## SYNOPSIS -Creates a pipeline in Data Factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Set-AzureRmDataFactoryV2Pipeline [-Name] <String> [-DefinitionFile] <String> [-ResourceGroupName] <String> - [-DataFactoryName] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByResourceId -``` -Set-AzureRmDataFactoryV2Pipeline [-DefinitionFile] <String> [-ResourceId] <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Set-AzureRmDataFactoryV2Pipeline cmdlet creates a pipeline in Azure Data Factory. -If you specify a name for a pipeline that already exists, the cmdlet prompts you for confirmation before it replaces the pipeline. -If you specify the Force parameter, the cmdlet replaces the existing pipeline without confirmation. -Perform these operations in the following order: - -- Create a data factory. - -- Create linked services. - -- Create datasets. - -- Create a pipeline. -If a pipeline with the same name already exists in the data factory, this cmdlet prompts you to confirm whether to overwrite the existing pipeline with the new pipeline. -If you confirm to overwrite the existing pipeline, the pipeline definition is also replaced. - -## EXAMPLES - -### Example 1: Create a pipeline -``` -PS C:\> Set-AzureRmDataFactoryV2Pipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF" -File "C:\DPWikisample.json" - - PipelineName : DPWikisample - ResourceGroupName : ADF - DataFactoryName : WikiADF11 - Activities : {MyCopyActivity_0_0, MyCopyActivity_1_0} - Parameters : {[OutputBlobName, Microsoft.Azure.Management.DataFactory.Models.ParameterSpecification]} -``` - -This command creates a pipeline named DPWikisample in the data factory named ADF. -The command bases the pipeline on information in the DPWikisample.json file. -This file includes information about activities such as Copy Activity and HDInsight Activity in the pipeline. - -## PARAMETERS - -### -DataFactoryName -Specifies the name of a data factory. -This cmdlet creates a pipeline for the data factory that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefinitionFile -The JSON file path. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: File - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Indicates that this cmdlet replaces an existing pipeline without prompting you for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the pipeline to create. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: PipelineName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -This cmdlet creates a pipeline for the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what happens if the cmdlet runs, but doesn't run the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSPipeline - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, data, factories - -## RELATED LINKS - -[Get-AzureRmDataFactoryV2Pipeline]() - -[Remove-AzureRmDataFactoryV2Pipeline]() - -[Invoke-AzureRmDataFactoryV2Pipeline]() diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Set-AzureRmDataFactoryV2Trigger.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Set-AzureRmDataFactoryV2Trigger.md deleted file mode 100644 index aca2474796..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Set-AzureRmDataFactoryV2Trigger.md +++ /dev/null @@ -1,208 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/set-azurermdatafactoryv2trigger -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Set-AzureRmDataFactoryV2Trigger.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Set-AzureRmDataFactoryV2Trigger.md ---- - -# Set-AzureRmDataFactoryV2Trigger - -## SYNOPSIS -Creates a trigger in a data factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Set-AzureRmDataFactoryV2Trigger [-Name] <String> [-DefinitionFile] <String> [-ResourceGroupName] <String> - [-DataFactoryName] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByResourceId -``` -Set-AzureRmDataFactoryV2Trigger [-DefinitionFile] <String> [-ResourceId] <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDataFactoryV2Trigger** cmdlet creates a trigger in a data factory. If you specify a name for a trigger that already exists, the cmdlet prompts for confirmation before replacing the trigger. If you specify the _Force_ parameter, the cmdlet replaces the existing trigger without prompting for confirmation. Triggers are created in the 'Stopped' state, meaning that they don't immediately begin invoking pipelines that they reference. - -## EXAMPLES - -### Example 1: Create a trigger -``` -PS C:\> Set-AzureRmDataFactoryV2Trigger -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "ScheduledTrigger" -DefinitionFile ".\scheduledTrigger.json" - - TriggerName : ScheduledTrigger - ResourceGroupName : ADF - DataFactoryName : WikiADF - Properties : Microsoft.Azure.Management.DataFactory.Models.ScheduleTrigger - RuntimeState : Stopped -``` - -Create a new trigger called "ScheduledTrigger" in the data factory "WikiADF". The trigger is created in the 'Stopped' state, meaning that it doesn't immediately start. A trigger can be started using the `Start-AzureRmDataFactoryV2Trigger` cmdlet. - -## PARAMETERS - -### -DataFactoryName -The data factory name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefinitionFile -The JSON file path. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: File - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The trigger name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: TriggerName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what happens if the cmdlet runs, but doesn't run the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSTrigger - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDataFactoryV2Trigger]() - -[Start-AzureRmDataFactoryV2Trigger]() - -[Stop-AzureRmDataFactoryV2Trigger]() - -[Remove-AzureRmDataFactoryV2Trigger]() diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Start-AzureRmDataFactoryV2IntegrationRuntime.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Start-AzureRmDataFactoryV2IntegrationRuntime.md deleted file mode 100644 index eba33486f9..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Start-AzureRmDataFactoryV2IntegrationRuntime.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/start-azurermdatafactoryv2integrationruntime -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Start-AzureRmDataFactoryV2IntegrationRuntime.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Start-AzureRmDataFactoryV2IntegrationRuntime.md ---- - -# Start-AzureRmDataFactoryV2IntegrationRuntime - -## SYNOPSIS -Starts a managed dedicated integration runtime. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByIntegrationRuntimeName (Default) -``` -Start-AzureRmDataFactoryV2IntegrationRuntime [-Force] [-Name] <String> [-ResourceGroupName] <String> - [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByResourceId -``` -Start-AzureRmDataFactoryV2IntegrationRuntime [-Force] [-ResourceId] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByIntegrationRuntimeObject -``` -Start-AzureRmDataFactoryV2IntegrationRuntime [-Force] [-InputObject] <PSIntegrationRuntime> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Start-AzureRmDataFactoryV2IntegrationRuntime** cmdlet starts a managed dedicated integration runtime. The resource is provisioned and after the operation the state is 'Started'. - -## EXAMPLES - -### Example 1: Start an integration runtime -``` -PS C:\> Start-AzureRmDataFactoryV2IntegrationRuntime -ResourceGroupName 'rg-test-dfv2' -DataFactoryName 'test-df-eu2' -Name test-dedicated-ir' -Force - - CreateTime : 9/11/2017 2:16:12 PM - Nodes : {tvm-1650185656_1-20170911t141751z} - OtherErrors : {} - LastOperation : - State : Started - Location : West US - NodeSize : Standard_D1_v2 - NodeCount : 1 - MaxParallelExecutionsPerNode : 1 - CatalogServerEndpoint : testsvr.database.windows.net - CatalogAdminUserName : admin - CatalogAdminPassword : ********** - CatalogPricingTier : S1 - VNetId : - Subnet : - Id : /subscriptions/b3ee3a7f-7614-4644-ad07-afa832620b4b/resourceGroups/rg-test-dfv2/providers/Microsoft.DataFactory/factories/test-df-eu2/integrationruntimes/test-dedicated-ir - ResourceGroupName : rg-test-dfv2 - DataFactoryName : test-df-eu2 - Name : test-dedicated-ir - Description : Reserved IR -``` - -This cmdlet starts a managed dedicated integration runtime named 'test-dedicated-ir'. - -## PARAMETERS - -### -DataFactoryName -The data factory name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The integration runtime object. - -```yaml -Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime -Parameter Sets: ByIntegrationRuntimeObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The integration runtime name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: IntegrationRuntimeName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: Id - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what happens if the cmdlet runs, but doesn't run the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSManagedIntegrationRuntimeStatus - -## NOTES - -## RELATED LINKS - -[Stop-AzureRmDataFactoryV2IntegrationRuntime]() diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Start-AzureRmDataFactoryV2Trigger.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Start-AzureRmDataFactoryV2Trigger.md deleted file mode 100644 index 2d318d6a57..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Start-AzureRmDataFactoryV2Trigger.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/start-azurermdatafactoryv2trigger -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Start-AzureRmDataFactoryV2Trigger.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Start-AzureRmDataFactoryV2Trigger.md ---- - -# Start-AzureRmDataFactoryV2Trigger - -## SYNOPSIS -Starts a trigger in a data factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Start-AzureRmDataFactoryV2Trigger [-Name] <String> [-ResourceGroupName] <String> [-DataFactoryName] <String> - [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByInputObject -``` -Start-AzureRmDataFactoryV2Trigger [-InputObject] <PSTrigger> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Start-AzureRmDataFactoryV2Trigger [-ResourceId] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Start-AzureRmDataFactoryV2Trigger** cmdlet starts a trigger in a data factory. If the trigger is in the 'Stopped' state, the cmdlet starts the trigger and it eventually invokes pipelines based on its definition. If the trigger is already in the 'Started' state, this cmdlet has no effect. If the Force parameter is specified, the cmdlet doesn't prompt before starting the trigger. - -## EXAMPLES - -### Example 1: Start a trigger -``` -Start-AzureRmDataFactoryV2Trigger -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -TriggerName "ScheduledTrigger" - -Confirm -Are you sure you want to start trigger 'ScheduledTrigger' in data factory 'WikiADF'? -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y -True -``` - -Starts a trigger called "ScheduledTrigger" in the data factory "WikiADF". - -## PARAMETERS - -### -DataFactoryName -The data factory name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Trigger object to start. - -```yaml -Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSTrigger -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The trigger name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: TriggerName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what happens if the cmdlet runs, but doesn't run the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSTrigger -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSTrigger - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDataFactoryV2Trigger]() - -[Set-AzureRmDataFactoryV2Trigger]() - -[Stop-AzureRmDataFactoryV2Trigger]() - -[Remove-AzureRmDataFactoryV2Trigger]() diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Stop-AzureRmDataFactoryV2IntegrationRuntime.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Stop-AzureRmDataFactoryV2IntegrationRuntime.md deleted file mode 100644 index c9fb36bd8c..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Stop-AzureRmDataFactoryV2IntegrationRuntime.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/stop-azurermdatafactoryv2integrationruntime -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Stop-AzureRmDataFactoryV2IntegrationRuntime.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Stop-AzureRmDataFactoryV2IntegrationRuntime.md ---- - -# Stop-AzureRmDataFactoryV2IntegrationRuntime - -## SYNOPSIS -Stops a managed dedicated integration runtime. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByIntegrationRuntimeName (Default) -``` -Stop-AzureRmDataFactoryV2IntegrationRuntime [-Force] [-Name] <String> [-ResourceGroupName] <String> - [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByResourceId -``` -Stop-AzureRmDataFactoryV2IntegrationRuntime [-Force] [-ResourceId] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByIntegrationRuntimeObject -``` -Stop-AzureRmDataFactoryV2IntegrationRuntime [-Force] [-InputObject] <PSIntegrationRuntime> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Stop-AzureRmDataFactoryV2IntegrationRuntime** cmdlet stops a managed dedicated integration runtime in 'Started' state, which was started by the Start-AzureRmDataFactoryV2IntegrationRuntime cmdlet. The resources are released and the state transfers to 'Stopped'. - -## EXAMPLES - -### Example 1: Stop a managed integration runtime that is in 'Started' state. -``` -PS C:\> Stop-AzureRmDataFactoryV2IntegrationRuntime -ResourceGroupName 'rg-test-dfv2' -DataFactoryName 'test-df' -Name 'test-reserlved-ir' -``` - -The managed integration runtime 'test-reserlved-ir' is in 'Started' state. After running Stop-AzureRmDataFactoryV2IntegrationRuntime cmdlet, the resources are released and the state transfers to 'Stopped'. - -## PARAMETERS - -### -DataFactoryName -The data factory name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The integration runtime object. - -```yaml -Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime -Parameter Sets: ByIntegrationRuntimeObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The integration runtime name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: IntegrationRuntimeName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: Id - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what happens if the cmdlet runs, but doesn't run the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, data, factories, copy, activities, integration runtime - -## RELATED LINKS - -[Start-AzureRmDataFactoryV2IntegrationRuntime]() diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Stop-AzureRmDataFactoryV2PipelineRun.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Stop-AzureRmDataFactoryV2PipelineRun.md deleted file mode 100644 index 884644fe1f..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Stop-AzureRmDataFactoryV2PipelineRun.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/stop-azurermdatafactoryv2pipelinerun -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Stop-AzureRmDataFactoryV2PipelineRun.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Stop-AzureRmDataFactoryV2PipelineRun.md ---- - -# Stop-AzureRmDataFactoryV2PipelineRun - -## SYNOPSIS -Stops a pieline run in a data factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Stop-AzureRmDataFactoryV2PipelineRun [-PipelineRunId] <String> [-PassThru] [-ResourceGroupName] <String> - [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByInputObject -``` -Stop-AzureRmDataFactoryV2PipelineRun [-InputObject] <PSPipelineRun> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByFactoryObject -``` -Stop-AzureRmDataFactoryV2PipelineRun [-PipelineRunId] <String> [-PassThru] [-DataFactory] <PSDataFactory> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Stop-AzureRmDataFactoryV2PipelineRun** cmdlet stops a pipeline run in a data factory specified with the pieline run ID. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Stop-AzureRmDataFactoryV2PipelineRun -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -PipelineRunId b9730a13-aa12-4926-a8b3-8e3a974ab0bd - -Confirm -Are you sure you want to stop pipeline run 'b9730a13-aa12-4926-a8b3-8e3a974ab0bd' in data factory 'WikiADF'? -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y - -true -``` - -This command stops the pipeline run with id b9730a13-aa12-4926-a8b3-8e3a974ab0bd in the factory WikiADF. - -## PARAMETERS - -### -DataFactory -The data factory object. - -```yaml -Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DataFactoryName -The data factory name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The Run ID of the pipeline. - -```yaml -Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSPipelineRun -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -If specified the cmdlet write true in case operation succeeds. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PipelineRunId -The Run ID of the pipeline. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName, ByFactoryObject -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSPipelineRun -Parameters: InputObject (ByValue) - -### System.String - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory -Parameters: DataFactory (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Stop-AzureRmDataFactoryV2Trigger.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Stop-AzureRmDataFactoryV2Trigger.md deleted file mode 100644 index 6a1727327d..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Stop-AzureRmDataFactoryV2Trigger.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/stop-azurermdatafactoryv2trigger -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Stop-AzureRmDataFactoryV2Trigger.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Stop-AzureRmDataFactoryV2Trigger.md ---- - -# Stop-AzureRmDataFactoryV2Trigger - -## SYNOPSIS -Stops a trigger in a data factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Stop-AzureRmDataFactoryV2Trigger [-Name] <String> [-ResourceGroupName] <String> [-DataFactoryName] <String> - [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByInputObject -``` -Stop-AzureRmDataFactoryV2Trigger [-InputObject] <PSTrigger> [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Stop-AzureRmDataFactoryV2Trigger [-ResourceId] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Stop-AzureRmDataFactoryV2Trigger** cmdlet stops a trigger in a data factory. If the trigger is in the 'Started' state, the cmdlet stops the trigger and no longer invokes pipelines. If the trigger is already in the 'Stopped' state, this cmdlet has no effect. If the Force parameter is specified, the cmdlet doesn't prompt before stopping the trigger. - -## EXAMPLES - -### Example 1: Stop a trigger -``` -Stop-AzureRmDataFactoryV2Trigger -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -TriggerName "ScheduledTrigger" - -Confirm -Are you sure you want to stop trigger 'ScheduledTrigger' in data factory 'TestFactory'? -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y -True -``` - -Stops a trigger called "ScheduledTrigger" in the data factory "WikiADF". - -## PARAMETERS - -### -DataFactoryName -The data factory name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Trigger object to start. - -```yaml -Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSTrigger -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The trigger name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: TriggerName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what happens if the cmdlet runs, but doesn't run the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSTrigger -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSTrigger - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDataFactoryV2Trigger]() - -[Set-AzureRmDataFactoryV2Trigger]() - -[Start-AzureRmDataFactoryV2Trigger]() - -[Remove-AzureRmDataFactoryV2Trigger]() diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Sync-AzureRmDataFactoryV2IntegrationRuntimeCredential.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Sync-AzureRmDataFactoryV2IntegrationRuntimeCredential.md deleted file mode 100644 index 68f8ec85e2..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Sync-AzureRmDataFactoryV2IntegrationRuntimeCredential.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/sync-azurermdatafactoryv2integrationruntimecredential -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Sync-AzureRmDataFactoryV2IntegrationRuntimeCredential.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Sync-AzureRmDataFactoryV2IntegrationRuntimeCredential.md ---- - -# Sync-AzureRmDataFactoryV2IntegrationRuntimeCredential - -## SYNOPSIS -Synchronizes credentials among integration runtime nodes. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByIntegrationRuntimeName (Default) -``` -Sync-AzureRmDataFactoryV2IntegrationRuntimeCredential [-Force] [-IntegrationRuntimeName] <String> - [-ResourceGroupName] <String> [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Sync-AzureRmDataFactoryV2IntegrationRuntimeCredential [-Force] [-ResourceId] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByIntegrationRuntimeObject -``` -Sync-AzureRmDataFactoryV2IntegrationRuntimeCredential [-Force] [-InputObject] <PSIntegrationRuntime> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Sync-AzureRmDataFactoryV2IntegrationRuntimeCredential** cmdlet synchronizes on-premises credentials among integration runtime nodes, which forces the credentials to be identical in all nodes. - -## EXAMPLES - -### Example 1: Sync an integration runtime credential -``` -PS C:\> Sync-AzureRmDataFactoryV2IntegrationRuntimeCredential -ResourceGroupName 'rg-test-dfv2' -DataFactoryName 'test-df-eu2' -Name 'test-selfhost-ir' -``` - -The cmdlet synchronizes credentials among integration runtime nodes. - -## PARAMETERS - -### -DataFactoryName -The data factory name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The integration runtime object. - -```yaml -Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime -Parameter Sets: ByIntegrationRuntimeObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IntegrationRuntimeName -The integration runtime name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: Id - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what happens if the cmdlet runs, but doesn't run the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Update-AzureRmDataFactoryV2.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Update-AzureRmDataFactoryV2.md deleted file mode 100644 index 5d623b64a1..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Update-AzureRmDataFactoryV2.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/update-azurermdatafactoryv2 -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Update-AzureRmDataFactoryV2.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Update-AzureRmDataFactoryV2.md ---- - -# Update-AzureRmDataFactoryV2 - -## SYNOPSIS -Updates the properties of a data factory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Update-AzureRmDataFactoryV2 [-ResourceGroupName] <String> [-Name] <String> [-Tag <Hashtable>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByFactoryObject -``` -Update-AzureRmDataFactoryV2 [-InputObject] <PSDataFactory> [-Tag <Hashtable>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Update-AzureRmDataFactoryV2 [-ResourceId] <String> [-Tag <Hashtable>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureRmDataFactoryV2** cmdlet updates tags or identity properties of a data factory. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Update-AzureRmDataFactoryV2 -ResourceGroupName "ADF" -Name "WikiADF" -Tag @{myNewTagName = "myTagValue"} - -Confirm -Are you sure you want to update properties of the data factory 'WikiADF' in resource group 'ADF'? -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y - - -DataFactoryName : WikiADF -DataFactoryId : /subscriptions/1e42591f-1f0c-4c5a-b7f2-a268f6105ec5/resourceGroups/adf/providers/Microsoft.DataF - actory/factories/wikiadf -ResourceGroupName : ADF -Location : EastUS -Tags : {[myNewTagName, myTagValue]} -Identity : -ProvisioningState : Succeeded -``` - -This command updates the tags for the factory WikiADF to a dictionary containing a tag named myNewTagName with value myTagValue. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The data factory object. - -```yaml -Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The data factory name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: DataFactoryName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -The tags of the data factory. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Update-AzureRmDataFactoryV2IntegrationRuntime.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Update-AzureRmDataFactoryV2IntegrationRuntime.md deleted file mode 100644 index ab5ba544be..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Update-AzureRmDataFactoryV2IntegrationRuntime.md +++ /dev/null @@ -1,250 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/update-azurermdatafactoryv2integrationruntime -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Update-AzureRmDataFactoryV2IntegrationRuntime.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Update-AzureRmDataFactoryV2IntegrationRuntime.md ---- - -# Update-AzureRmDataFactoryV2IntegrationRuntime - -## SYNOPSIS -Updates an integration runtime. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByIntegrationRuntimeName (Default) -``` -Update-AzureRmDataFactoryV2IntegrationRuntime [-AutoUpdate <String>] [-AutoUpdateDelayOffset <TimeSpan>] - [-Name] <String> [-ResourceGroupName] <String> [-DataFactoryName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Update-AzureRmDataFactoryV2IntegrationRuntime [-AutoUpdate <String>] [-AutoUpdateDelayOffset <TimeSpan>] - [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByIntegrationRuntimeObject -``` -Update-AzureRmDataFactoryV2IntegrationRuntime [-AutoUpdate <String>] [-AutoUpdateDelayOffset <TimeSpan>] - [-InputObject] <PSIntegrationRuntime> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureRmDataFactoryV2IntegrationRuntime** cmdlet updates integration runtime properties. Currently the cmdlet only supports updating 'AutoUpdate' and 'AutoUpdateDelayOffset' for self-hosted integration runtime. - -## EXAMPLES - -### Example 1: Updates an integration runtime -``` -PS C:\> $ts = New-TimeSpan -Hours 3 -PS C:\> Update-AzureRmDataFactoryV2IntegrationRuntime ` - -ResourceGroupName 'rg-test-dfv2' ` - -DataFactoryName 'test-df-eu2' ` - -Name 'test-selfhost-ir' ` - -AutoUpdate Off ` - -AutoUpdateDelayOffset $ts - -Nodes : {Node_1} -CreateTime : 11/18/2017 2:45:38 PM -InternalChannelEncryption : -Version : 3.2.6519.3 -Capabilities : {[serviceBusConnected, True], [httpsPortEnabled, True], [credentialInSync, True], [connectedToResourceManager, True]...} -ScheduledUpdateDate : -UpdateDelayOffset : -LocalTimeZoneOffset : -AutoUpdate : Off -ServiceUrls : {wu.frontend.int.clouddatahub-int.net, *.servicebus.windows.net} -State : Online -Id : /subscriptions/41fcbc45-c594-4152-a8f1-fcbcd6452aea/resourceGroups/rg-test-dfv2/providers/Microsoft.DataFactory/factories/test-df-eu2/integrationruntimes/test-selfhost-ir -Type : SelfHosted -ResourceGroupName : rg-test-dfv2 -DataFactoryName : test-df-eu2 -Name : test-selfhost-ir -Description : New 2 description -``` - -The cmdlet updates self-hosted integration runtime named 'test-selfhost-ir'. - -## PARAMETERS - -### -AutoUpdate -Enable or disable the self-hosted integration runtime auto-update. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: On, Off - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoUpdateDelayOffset -The time in hour of the day for the self-hosted integration runtime auto-update. - -```yaml -Type: System.Nullable`1[System.TimeSpan] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataFactoryName -The data factory name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The integration runtime object. - -```yaml -Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime -Parameter Sets: ByIntegrationRuntimeObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The integration runtime name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: IntegrationRuntimeName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: Id - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSSelfHostedIntegrationRuntimeStatus - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, data, factories, copy, activities, integration runtime - -## RELATED LINKS - -[Set-AzureRmDataFactoryV2IntegrationRuntime]() -[Get-AzureRmDataFactoryV2IntegrationRuntime]() - diff --git a/azurermps-6.13.0/AzureRM.DataFactoryV2/Update-AzureRmDataFactoryV2IntegrationRuntimeNode.md b/azurermps-6.13.0/AzureRM.DataFactoryV2/Update-AzureRmDataFactoryV2IntegrationRuntimeNode.md deleted file mode 100644 index a5e91aed96..0000000000 --- a/azurermps-6.13.0/AzureRM.DataFactoryV2/Update-AzureRmDataFactoryV2IntegrationRuntimeNode.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataFactoryV2.dll-Help.xml -Module Name: AzureRM.DataFactoryV2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datafactories/update-azurermdatafactoryv2integrationruntimenode -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Update-AzureRmDataFactoryV2IntegrationRuntimeNode.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataFactoryV2/Commands.DataFactoryV2/help/Update-AzureRmDataFactoryV2IntegrationRuntimeNode.md ---- - -# Update-AzureRmDataFactoryV2IntegrationRuntimeNode - -## SYNOPSIS -Updates self-hosted integration runtime node. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByIntegrationRuntimeName (Default) -``` -Update-AzureRmDataFactoryV2IntegrationRuntimeNode -Name <String> -ConcurrentJobsLimit <Int32> - [-IntegrationRuntimeName] <String> [-ResourceGroupName] <String> [-DataFactoryName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Update-AzureRmDataFactoryV2IntegrationRuntimeNode -Name <String> -ConcurrentJobsLimit <Int32> - [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByIntegrationRuntimeObject -``` -Update-AzureRmDataFactoryV2IntegrationRuntimeNode -Name <String> -ConcurrentJobsLimit <Int32> - [-InputObject] <PSIntegrationRuntime> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureRmDataFactoryV2IntegrationRuntimeNode** cmdlet updates properties of self-hosted integration runtime node in a data factory. Currently only supports updating 'ConcurrentJobsLimit'. - -## EXAMPLES - -### Example 1: Updates self-hosted integration runtime node -``` -PS C:\> Update-AzureRmDataFactoryV2IntegrationRuntimeNode ` - -ResourceGroupName 'rg-test-dfv2' ` - -DataFactoryName 'test-df-eu2' ` - -IntegrationRuntimeName 'test-selfhost-ir' ` - -Name 'Node_1' ` - -ConcurrentJobsLimit 3 -``` - -The cmdlet updates 'ConcurrentJobsLimit' to 3 for node 'Node_1' in self-hosted integration runtime 'test-selfhost-ir'. - -## PARAMETERS - -### -ConcurrentJobsLimit -The number of concurrent jobs permitted to run on the integration runtime node. -Values between 1 and maxConcurrentJobs are allowed. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataFactoryName -The data factory name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The integration runtime object. - -```yaml -Type: Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime -Parameter Sets: ByIntegrationRuntimeObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IntegrationRuntimeName -The integration runtime name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The integration runtime node name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByIntegrationRuntimeName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: Id - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.DataFactoryV2.Models.PSSelfHostedIntegrationRuntimeNode - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, data, factories, copy, activities, integration runtime - -## RELATED LINKS - -[Set-AzureRmDataFactoryV2IntegrationRuntime]() -[Get-AzureRmDataFactoryV2IntegrationRuntime]() - diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Add-AzureRmDataLakeAnalyticsDataSource.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Add-AzureRmDataLakeAnalyticsDataSource.md deleted file mode 100644 index c1d4222452..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Add-AzureRmDataLakeAnalyticsDataSource.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeAnalytics.dll-Help.xml -Module Name: AzureRM.DataLakeAnalytics -ms.assetid: A38D8BF6-D302-4586-B7AF-4C80B546E96F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics/add-azurermdatalakeanalyticsdatasource -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Add-AzureRmDataLakeAnalyticsDataSource.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Add-AzureRmDataLakeAnalyticsDataSource.md ---- - -# Add-AzureRmDataLakeAnalyticsDataSource - -## SYNOPSIS -Adds a data source to a Data Lake Analytics account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### AddDataLakeStorageAccount -``` -Add-AzureRmDataLakeAnalyticsDataSource [-Account] <String> [-DataLakeStore] <String> - [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### AddBlobStorageAccount -``` -Add-AzureRmDataLakeAnalyticsDataSource [-Account] <String> [-Blob] <String> [-AccessKey] <String> - [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmDataLakeAnalyticsDataSource** cmdlet adds a data source to an Azure Data Lake Analytics account. - -## EXAMPLES - -### Example 1: Add a data source to an account -``` -PS C:\>Add-AzureRmDataLakeAnalyticsDataSource -Account "ContosoAdlA" -DataLakeStore "ContosoAdlS" -``` - -This command adds a Data Lake Store data source to a Data Lake Analytics account. - -## PARAMETERS - -### -AccessKey -Specifies the access key of the Azure Blob storage account to add. - -```yaml -Type: System.String -Parameter Sets: AddBlobStorageAccount -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Account -Specifies the Data Lake Analytics account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Blob -Specifies the name of the Azure Blob Storage account to add. - -```yaml -Type: System.String -Parameter Sets: AddBlobStorageAccount -Aliases: AzureBlob - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataLakeStore -Specifies the name of the Azure Data Lake Store account to add. - -```yaml -Type: System.String -Parameter Sets: AddDataLakeStorageAccount -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group name of the Data Lake Analytics account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmDataLakeAnalyticsDataSource](./Remove-AzureRmDataLakeAnalyticsDataSource.md) - -[Set-AzureRmDataLakeAnalyticsDataSource](./Set-AzureRmDataLakeAnalyticsDataSource.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Add-AzureRmDataLakeAnalyticsFirewallRule.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Add-AzureRmDataLakeAnalyticsFirewallRule.md deleted file mode 100644 index ad48a9b3e3..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Add-AzureRmDataLakeAnalyticsFirewallRule.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeAnalytics.dll-Help.xml -Module Name: AzureRM.DataLakeAnalytics -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics/add-azurermdatalakeanalyticsfirewallrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Add-AzureRmDataLakeAnalyticsFirewallRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Add-AzureRmDataLakeAnalyticsFirewallRule.md ---- - -# Add-AzureRmDataLakeAnalyticsFirewallRule - -## SYNOPSIS -Adds a firewall rule to a Data Lake Analytics account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmDataLakeAnalyticsFirewallRule [-Account] <String> [-Name] <String> [-StartIpAddress] <String> - [-EndIpAddress] <String> [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmDataLakeAnalyticsFirewallRule** cmdlet adds a firewall rule to an Azure Data Lake Analytics account. - -## EXAMPLES - -### Example 1: Add a firewall rule -``` -PS C:\>Add-AzureRmDataLakeAnalyticsFirewallRule -Account "ContosoAdlAcct" -Name "My firewall rule" -StartIpAddress 127.0.0.1 -EndIpAddress 127.0.0.10 -``` - -This command adds the firewall rule named "my firewall rule" from account "ContosoAdlAcct" with the IP range: 127.0.0.1 - 127.0.0.10 - -## PARAMETERS - -### -Account -The Data Lake Analytics account to add the firewall rule to - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndIpAddress -The end of the valid ip range for the firewall rule - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The name of the firewall rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of resource group under which want to retrieve the account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartIpAddress -The start of the valid ip range for the firewall rule - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataLakeAnalytics.Models.DataLakeAnalyticsFirewallRule - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/AzureRM.DataLakeAnalytics.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/AzureRM.DataLakeAnalytics.md deleted file mode 100644 index 95cd3cac7d..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/AzureRM.DataLakeAnalytics.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -Module Name: AzureRM.DataLakeAnalytics -Module Guid: eca73aa1-a68f-4ceb-9775-70759316a57b -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics -Help Version: 1.0.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/AzureRM.DataLakeAnalytics.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/AzureRM.DataLakeAnalytics.md ---- - -# AzureRM.DataLakeAnalytics Module -## Description -The topics in this section document the Azure PowerShell cmdlets for Azure Data Lake Analytics in the Azure Resource Manager (ARM) framework. The cmdlets exist in the Microsoft.Azure.Commands.DataLakeAnalytics namespace. - -## AzureRM.DataLakeAnalytics Cmdlets -### [Add-AzureRmDataLakeAnalyticsDataSource](Add-AzureRmDataLakeAnalyticsDataSource.md) -Adds a data source to a Data Lake Analytics account. - -### [Add-AzureRmDataLakeAnalyticsFirewallRule](Add-AzureRmDataLakeAnalyticsFirewallRule.md) -Adds a firewall rule to a Data Lake Analytics account. - -### [Get-AzureRmDataLakeAnalyticsAccount](Get-AzureRmDataLakeAnalyticsAccount.md) -Gets information about a Data Lake Analytics account. - -### [Get-AzureRmDataLakeAnalyticsCatalogItem](Get-AzureRmDataLakeAnalyticsCatalogItem.md) -Gets a Data Lake Analytics catalog item or types of items. - -### [Get-AzureRmDataLakeAnalyticsCatalogItemAclEntry](Get-AzureRmDataLakeAnalyticsCatalogItemAclEntry.md) -Gets an entry in the ACL of a catalog or catalog item in Data Lake Analytics. - -### [Get-AzureRmDataLakeAnalyticsComputePolicy](Get-AzureRmDataLakeAnalyticsComputePolicy.md) -Gets a Data Lake Analytics compute policy or list of compute policies. - -### [Get-AzureRmDataLakeAnalyticsDataSource](Get-AzureRmDataLakeAnalyticsDataSource.md) -Gets a Data Lake Analytics data source. - -### [Get-AzureRmDataLakeAnalyticsFirewallRule](Get-AzureRmDataLakeAnalyticsFirewallRule.md) -Retrieves a firewall rule or list of firewall rules from a Data Lake Analytics account. - -### [Get-AzureRmDataLakeAnalyticsJob](Get-AzureRmDataLakeAnalyticsJob.md) -Gets a Data Lake Analytics job. - -### [Get-AzureRmDataLakeAnalyticsJobPipeline](Get-AzureRmDataLakeAnalyticsJobPipeline.md) -Gets a Data Lake Analytics Job pipeline or pipelines. - -### [Get-AzureRmDataLakeAnalyticsJobRecurrence](Get-AzureRmDataLakeAnalyticsJobRecurrence.md) -Gets a Data Lake Analytics Job recurrence or recurrences. - -### [New-AzureRmDataLakeAnalyticsAccount](New-AzureRmDataLakeAnalyticsAccount.md) -Creates a Data Lake Analytics account. - -### [New-AzureRmDataLakeAnalyticsCatalogCredential](New-AzureRmDataLakeAnalyticsCatalogCredential.md) -Creates a new Azure Data Lake Analytics catalog credential. - -### [New-AzureRmDataLakeAnalyticsCatalogSecret](New-AzureRmDataLakeAnalyticsCatalogSecret.md) -Creates a Data Lake Analytics catalog secret. - -### [New-AzureRmDataLakeAnalyticsComputePolicy](New-AzureRmDataLakeAnalyticsComputePolicy.md) -Creates a Data Lake Analytics compute policy rule for a specific AAD entity. - -### [Remove-AzureRmDataLakeAnalyticsAccount](Remove-AzureRmDataLakeAnalyticsAccount.md) -Deletes a Data Lake Analytics account. - -### [Remove-AzureRmDataLakeAnalyticsCatalogCredential](Remove-AzureRmDataLakeAnalyticsCatalogCredential.md) -Deletes an Azure Data Lake Analytics credential. - -### [Remove-AzureRmDataLakeAnalyticsCatalogItemAclEntry](Remove-AzureRmDataLakeAnalyticsCatalogItemAclEntry.md) -Deletes an entry from the ACL of a catalog or catalog item in Data Lake Analytics. - -### [Remove-AzureRmDataLakeAnalyticsCatalogSecret](Remove-AzureRmDataLakeAnalyticsCatalogSecret.md) -Deletes a Data Lake Analytics secret. - -### [Remove-AzureRmDataLakeAnalyticsComputePolicy](Remove-AzureRmDataLakeAnalyticsComputePolicy.md) -Removes a specified Azure Data Lake Analytics compute policy - -### [Remove-AzureRmDataLakeAnalyticsDataSource](Remove-AzureRmDataLakeAnalyticsDataSource.md) -Removes a data source from a Data Lake Analytics account. - -### [Remove-AzureRmDataLakeAnalyticsFirewallRule](Remove-AzureRmDataLakeAnalyticsFirewallRule.md) -Removes a firewall rule from a Data Lake Analytics account. - -### [Set-AzureRmDataLakeAnalyticsAccount](Set-AzureRmDataLakeAnalyticsAccount.md) -Modifies a Data Lake Analytics account. - -### [Set-AzureRmDataLakeAnalyticsCatalogCredential](Set-AzureRmDataLakeAnalyticsCatalogCredential.md) -Modifies an Azure Data Lake Analytics catalog credential password. - -### [Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry](Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry.md) -Modifies an entry in the ACL of a catalog or catalog item in Data Lake Analytics. - -### [Set-AzureRmDataLakeAnalyticsCatalogSecret](Set-AzureRmDataLakeAnalyticsCatalogSecret.md) -Modifies a Data Lake Analytics catalog secret. - -### [Set-AzureRmDataLakeAnalyticsDataSource](Set-AzureRmDataLakeAnalyticsDataSource.md) -Modifies the details of a data source of a Data Lake Analytics account. - -### [Set-AzureRmDataLakeAnalyticsFirewallRule](Set-AzureRmDataLakeAnalyticsFirewallRule.md) -Updates a firewall rule in a Data Lake Analytics account. - -### [Stop-AzureRmDataLakeAnalyticsJob](Stop-AzureRmDataLakeAnalyticsJob.md) -Cancels a job. - -### [Submit-AzureRmDataLakeAnalyticsJob](Submit-AzureRmDataLakeAnalyticsJob.md) -Submits a job. - -### [Test-AzureRmDataLakeAnalyticsAccount](Test-AzureRmDataLakeAnalyticsAccount.md) -Checks for the existence of a Data Lake Analytics account. - -### [Test-AzureRmDataLakeAnalyticsCatalogItem](Test-AzureRmDataLakeAnalyticsCatalogItem.md) -Checks for the existence of a catalog item. - -### [Update-AzureRmDataLakeAnalyticsComputePolicy](Update-AzureRmDataLakeAnalyticsComputePolicy.md) -Updates a Data Lake Analytics compute policy rule for a specific AAD entity. - -### [Wait-AzureRmDataLakeAnalyticsJob](Wait-AzureRmDataLakeAnalyticsJob.md) -Waits for a job to complete. - diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsAccount.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsAccount.md deleted file mode 100644 index b7437788be..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsAccount.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeAnalytics.dll-Help.xml -Module Name: AzureRM.DataLakeAnalytics -ms.assetid: 4EA01047-021C-4FA5-82F0-5102BA114BC2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics/get-azurermdatalakeanalyticsaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Get-AzureRmDataLakeAnalyticsAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Get-AzureRmDataLakeAnalyticsAccount.md ---- - -# Get-AzureRmDataLakeAnalyticsAccount - -## SYNOPSIS -Gets information about a Data Lake Analytics account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetAllInSubscription (Default) -``` -Get-AzureRmDataLakeAnalyticsAccount [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetByResourceGroup -``` -Get-AzureRmDataLakeAnalyticsAccount [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### GetBySpecificAccount -``` -Get-AzureRmDataLakeAnalyticsAccount [[-ResourceGroupName] <String>] [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDataLakeAnalyticsAccount** cmdlet gets information about an Azure Data Lake Analytics account. - -## EXAMPLES - -### Example 1: Get information about a Data Lake Analytics account -``` -PS C:\>Get-AzureRmDataLakeAnalyticsAccount -Name "ContosoAdlAccount" -``` - -This command gets information about the account named ContosoAdlAccount. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Data Lake Analytics account. - -```yaml -Type: System.String -Parameter Sets: GetBySpecificAccount -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group name of the Data Lake Analytics account. - -```yaml -Type: System.String -Parameter Sets: GetByResourceGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: GetBySpecificAccount -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataLakeAnalytics.Models.PSDataLakeAnalyticsAccount - -## NOTES - -## RELATED LINKS - -[New-AzureRmDataLakeAnalyticsAccount](./New-AzureRmDataLakeAnalyticsAccount.md) - -[Remove-AzureRmDataLakeAnalyticsAccount](./Remove-AzureRmDataLakeAnalyticsAccount.md) - -[Set-AzureRmDataLakeAnalyticsAccount](./Set-AzureRmDataLakeAnalyticsAccount.md) - -[Test-AzureRmDataLakeAnalyticsAccount](./Test-AzureRmDataLakeAnalyticsAccount.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsCatalogItem.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsCatalogItem.md deleted file mode 100644 index aff4b27b33..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsCatalogItem.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeAnalytics.dll-Help.xml -Module Name: AzureRM.DataLakeAnalytics -ms.assetid: A6899341-1E5E-4F8B-8D5D-5923B1223628 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics/get-azurermdatalakeanalyticscatalogitem -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Get-AzureRmDataLakeAnalyticsCatalogItem.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Get-AzureRmDataLakeAnalyticsCatalogItem.md ---- - -# Get-AzureRmDataLakeAnalyticsCatalogItem - -## SYNOPSIS -Gets a Data Lake Analytics catalog item or types of items. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmDataLakeAnalyticsCatalogItem [-Account] <String> [-ItemType] <CatalogItemType> - [[-Path] <CatalogPathInstance>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDataLakeAnalyticsCatalogItem** gets a specified Azure Data Lake Analytics catalog item, or gets catalog items of a specified type. - -## EXAMPLES - -### Example 1: Get a specified database -``` -PS C:\>Get-AzureRmDataLakeAnalyticsCatalogItem -Account "contosoadla" -ItemType Database -Path "databaseName" -``` - -This command gets the specified database. - -### Example 2: Get tables in a specified database and schema -``` -PS C:\>Get-AzureRmDataLakeAnalyticsDataSource -AccountName "contosoadla" -ItemType Table -Path "databaseName.schemaName" -``` - -This command gets a list of tables in the specified database. - -## PARAMETERS - -### -Account -Specifies the Data Lake Analytics account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ItemType -Specifies the catalog item type of the item(s) being fetched or listed. -The acceptable values for this parameter are: -- Database -- Schema -- Assembly -- Table -- TableValuedFunction -- TableStatistics -- ExternalDataSource -- View -- Procedure -- Secret -- Credential -- Types -- TablePartition - -```yaml -Type: Microsoft.Azure.Commands.DataLakeAnalytics.Models.DataLakeAnalyticsEnums+CatalogItemType -Parameter Sets: (All) -Aliases: -Accepted values: Database, Schema, Assembly, Table, TablePartition, TableValuedFunction, TableStatistics, ExternalDataSource, View, Procedure, Secret, Credential, Types, Package - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the multi-part path to the item to retrieve, or to the parent item of the items to list. -The parts of the path should be separated by a period (.). - -```yaml -Type: Microsoft.Azure.Commands.DataLakeAnalytics.Models.CatalogPathInstance -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataLakeAnalytics.Models.DataLakeAnalyticsEnums+CatalogItemType - -### Microsoft.Azure.Commands.DataLakeAnalytics.Models.CatalogPathInstance - -## OUTPUTS - -### Microsoft.Azure.Management.DataLake.Analytics.Models.CatalogItem - -## NOTES - -## RELATED LINKS - -[Test-AzureRmDataLakeAnalyticsCatalogItem](./Test-AzureRmDataLakeAnalyticsCatalogItem.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsCatalogItemAclEntry.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsCatalogItemAclEntry.md deleted file mode 100644 index 55fac48a2a..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsCatalogItemAclEntry.md +++ /dev/null @@ -1,246 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeAnalytics.dll-Help.xml -Module Name: AzureRM.DataLakeAnalytics -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics/get-azurermdatalakeanalyticscatalogitemaclentry -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Get-AzureRmDataLakeAnalyticsCatalogItemAclEntry.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Get-AzureRmDataLakeAnalyticsCatalogItemAclEntry.md ---- - -# Get-AzureRmDataLakeAnalyticsCatalogItemAclEntry - -## SYNOPSIS -Gets an entry in the ACL of a catalog or catalog item in Data Lake Analytics. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetCatalogAclEntry (Default) -``` -Get-AzureRmDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### GetCatalogAclEntryForUserOwner -``` -Get-AzureRmDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-UserOwner] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetCatalogAclEntryForGroupOwner -``` -Get-AzureRmDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-GroupOwner] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetCatalogItemAclEntry -``` -Get-AzureRmDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> -ItemType <String> - -Path <CatalogPathInstance> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetCatalogItemAclEntryForUserOwner -``` -Get-AzureRmDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-UserOwner] -ItemType <String> - -Path <CatalogPathInstance> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetCatalogItemAclEntryForGroupOwner -``` -Get-AzureRmDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-GroupOwner] -ItemType <String> - -Path <CatalogPathInstance> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDataLakeAnalyticsCatalogItemAclEntry** cmdlet gets a list of entries (ACEs) in the access control list (ACL) of a catalog or catalog item in Data Lake Analytics. - -## EXAMPLES - -### Example 1: Get the ACL for a catalog -```powershell -PS C:\> Get-AzureRmDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" - -Type Id Permissions ----- -- ----------- -User 90a6f74b-fd73-490e-900a-c4f0f9694d02 Read -Group 902b155a-5601-4ca8-8178-ad3289211f88 ReadWrite -Other 00000000-0000-0000-0000-000000000000 None -``` - -This command gets the ACL for the catalog of the specified Data Lake Analytics account - -### Example 2: Get the ACL entry of user owner for a catalog -```powershell -PS C:\> Get-AzureRmDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" -UserOwner - -Type Id Permissions ----- -- ----------- -UserOwner 0316ac75-6703-4ace-984f-a4dd79aeeafc ReadWrite -``` - -This command gets ACL entry of the user owner for the catalog of the specified Data Lake Analytics account - -### Example 3: Get the ACL entry of group owner for a catalog -```powershell -PS C:\> Get-AzureRmDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" -GroupOwner - -Type Id Permissions ----- -- ----------- -GroupOwner 0316ac75-6703-4ace-984f-a4dd79aeeafc ReadWrite -``` - -This command gets ACL entry of the group owner for the catalog of the specified Data Lake Analytics account - -### Example 4: Get the ACL for a database -```powershell -PS C:\> Get-AzureRmDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" -ItemType Database -Path "databaseName" - -Type Id Permissions ----- -- ----------- -User 90a6f74b-fd73-490e-900a-c4f0f9694d02 Read -Group 902b155a-5601-4ca8-8178-ad3289211f88 ReadWrite -Other 00000000-0000-0000-0000-000000000000 None -``` - -This command gets the ACL for the database of the specified Data Lake Analytics account - -### Example 5: Get the ACL entry of user owner for a database -```powershell -PS C:\> Get-AzureRmDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" -UserOwner -ItemType Database -Path "databaseName" - -Type Id Permissions ----- -- ----------- -UserOwner 0316ac75-6703-4ace-984f-a4dd79aeeafc ReadWrite -``` - -This command gets the ACL entry of the user owner for the database of the specified Data Lake Analytics account - -### Example 6: Get the ACL entry of group owner for a database -```powershell -PS C:\> Get-AzureRmDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" -GroupOwner -ItemType Database -Path "databaseName" - -Type Id Permissions ----- -- ----------- -GroupOwner 0316ac75-6703-4ace-984f-a4dd79aeeafc ReadWrite -``` - -This command gets the ACL entry of the group owner for the database of the specified Data Lake Analytics account - -## PARAMETERS - -### -Account -Specifies the Data Lake Analytics account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupOwner -Get ACL entry of catalog for group owner - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: GetCatalogAclEntryForGroupOwner, GetCatalogItemAclEntryForGroupOwner -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ItemType -Specifies the type of the catalog or catalog item(s). The acceptable values for this parameter are: -- Catalog -- Database - -```yaml -Type: System.String -Parameter Sets: GetCatalogItemAclEntry, GetCatalogItemAclEntryForUserOwner, GetCatalogItemAclEntryForGroupOwner -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the Data Lake Analytics path of an catalog or catalog item. -The parts of the path should be separated by a period (.). - -```yaml -Type: Microsoft.Azure.Commands.DataLakeAnalytics.Models.CatalogPathInstance -Parameter Sets: GetCatalogItemAclEntry, GetCatalogItemAclEntryForUserOwner, GetCatalogItemAclEntryForGroupOwner -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserOwner -Get ACL entry of catalog for user owner. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: GetCatalogAclEntryForUserOwner, GetCatalogItemAclEntryForUserOwner -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataLakeAnalytics.Models.CatalogPathInstance - -## OUTPUTS - -### Microsoft.Azure.Commands.DataLakeAnalytics.Models.PSDataLakeAnalyticsAcl - -## NOTES - -## RELATED LINKS - -[U-SQL now offers database level access control](https://github.com/Azure/AzureDataLake/blob/master/docs/Release_Notes/2016/2016_08_01/USQL_Release_Notes_2016_08_01.md#u-sql-now-offers-database-level-access-control) - -[Remove-AzureRmDataLakeAnalyticsCatalogItemAclEntry](Remove-AzureRmDataLakeAnalyticsCatalogItemAclEntry.md) - -[Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry](Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry.md) diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsComputePolicy.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsComputePolicy.md deleted file mode 100644 index 3a1f0589e8..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsComputePolicy.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeAnalytics.dll-Help.xml -Module Name: AzureRM.DataLakeAnalytics -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics/get-azurermdatalakeanalyticscomputepolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Get-AzureRmDataLakeAnalyticsComputePolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Get-AzureRmDataLakeAnalyticsComputePolicy.md ---- - -# Get-AzureRmDataLakeAnalyticsComputePolicy - -## SYNOPSIS -Gets a Data Lake Analytics compute policy or list of compute policies. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmDataLakeAnalyticsComputePolicy [-ResourceGroupName <String>] [-Account] <String> [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDataLakeAnalyticsComputePolicy** gets a specified Azure Data Lake Analytics compute policy or a list of policies. - -## EXAMPLES - -### Example 1: Get a specified compute policy -``` -PS C:\>Get-AzureRmDataLakeAnalyticsComputePolicy -Account "contosoadla" -Name myPolicy -``` - -This command gets the specified compute policy with name 'myPolicy' in account 'contosoadla'. - -### Example 2: Get a list of all compute policies in the account -``` -PS C:\>Get-AzureRmDataLakeAnalyticsComputePolicy -AccountName "contosoadla" -``` - -This command gets a list of all compute policies in the account "contosoadla" - -## PARAMETERS - -### -Account -Name of the account to get the compute policy or policies from. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the compute policy to get. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ComputePolicyName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of resource group under which you the account exists. -Optional and will attempt to discover if not provided. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataLakeAnalytics.Models.PSDataLakeAnalyticsComputePolicy - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsDataSource.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsDataSource.md deleted file mode 100644 index ddcd50289a..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsDataSource.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeAnalytics.dll-Help.xml -Module Name: AzureRM.DataLakeAnalytics -ms.assetid: 0377C4E9-C1DC-49BA-BBC4-5598C83234F8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics/get-azurermdatalakeanalyticsdatasource -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Get-AzureRmDataLakeAnalyticsDataSource.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Get-AzureRmDataLakeAnalyticsDataSource.md ---- - -# Get-AzureRmDataLakeAnalyticsDataSource - -## SYNOPSIS -Gets a Data Lake Analytics data source. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetAllDataSources (Default) -``` -Get-AzureRmDataLakeAnalyticsDataSource [-Account] <String> [[-ResourceGroupName] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetDataLakeStoreAccount -``` -Get-AzureRmDataLakeAnalyticsDataSource [-Account] <String> [-DataLakeStore] <String> - [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetBlobStorageAccount -``` -Get-AzureRmDataLakeAnalyticsDataSource [-Account] <String> [-Blob] <String> [[-ResourceGroupName] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDataLakeAnalyticsDataSource** cmdlet gets an Azure Data Lake Analytics data source. - -## EXAMPLES - -### Example 1: Get a data source from an account -``` -PS C:\>Get-AzureRmDataLakeAnalyticsDataSource -AccountName "ContosoAdlA" -DataLakeStore "ContosoAdls" -``` - -This command gets a Data Lake Store data source named ContosoAdls from a Data Lake Analytics account. - -### Example 2: Get the list of Data Lake Store accounts in a Data Lake Analytics account -``` -PS C:\>Get-AzureRmDataLakeAnalyticsDataSource -AccountName "ContosoAdlA" -DataSource "DataLakeStore" -``` - -This command gets all Data Lake Store accounts from a Data Lake Analytics account. - -## PARAMETERS - -### -Account -Specifies the Data Lake Analytics account that this cmdlet gets data sources. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Blob -Specifies the name of the Azure Blob Storage data source. - -```yaml -Type: System.String -Parameter Sets: GetBlobStorageAccount -Aliases: AzureBlob - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataLakeStore -Specifies the name of the Data Lake Store account. - -```yaml -Type: System.String -Parameter Sets: GetDataLakeStoreAccount -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group name that contains the data source. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataLakeAnalytics.Models.PSStorageAccountInfo - -### Microsoft.Azure.Commands.DataLakeAnalytics.Models.PSDataLakeStoreAccountInfo - -### Microsoft.Azure.Commands.DataLakeAnalytics.Models.AdlDataSource - -## NOTES - -## RELATED LINKS - -[Add-AzureRmDataLakeAnalyticsDataSource](./Add-AzureRmDataLakeAnalyticsDataSource.md) - -[Remove-AzureRmDataLakeAnalyticsDataSource](./Remove-AzureRmDataLakeAnalyticsDataSource.md) - -[Set-AzureRmDataLakeAnalyticsDataSource](./Set-AzureRmDataLakeAnalyticsDataSource.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsFirewallRule.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsFirewallRule.md deleted file mode 100644 index 6f82e26a5b..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsFirewallRule.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeAnalytics.dll-Help.xml -Module Name: AzureRM.DataLakeAnalytics -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics/get-azurermdatalakeanalyticsfirewallrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Get-AzureRmDataLakeAnalyticsFirewallRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Get-AzureRmDataLakeAnalyticsFirewallRule.md ---- - -# Get-AzureRmDataLakeAnalyticsFirewallRule - -## SYNOPSIS -Retrieves a firewall rule or list of firewall rules from a Data Lake Analytics account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmDataLakeAnalyticsFirewallRule [-Account] <String> [[-Name] <String>] [[-ResourceGroupName] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDataLakeAnalyticsFirewallRule** cmdlet retrieves a firewall rule or list of firewall rules from an Azure Data Lake Analytics account. - -## EXAMPLES - -### Example 1: Get a firewall rule -``` -PS C:\>Get-AzureRmDataLakeAnalyticsFirewallRule -Account "ContosoAdlAcct" -Name "My firewall rule" -``` - -This command gets the firewall rule named "my firewall rule" from account "ContosoAdlAcct" - -### Example 2: List all firewall rules -``` -PS C:\>Get-AzureRmDataLakeAnalyticsFirewallRule -Account "ContosoAdlAcct" -``` - -This command gets all firewall rules from account "ContosoAdlAcct" - -## PARAMETERS - -### -Account -The Data Lake Analytics account to get the firewall rule from - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the firewall rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of resource group under which want to retrieve the account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataLakeAnalytics.Models.DataLakeAnalyticsFirewallRule - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsJob.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsJob.md deleted file mode 100644 index f901982866..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsJob.md +++ /dev/null @@ -1,317 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeAnalytics.dll-Help.xml -Module Name: AzureRM.DataLakeAnalytics -ms.assetid: A0293D80-5935-4D2C-AF11-2837FEC95760 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics/get-azurermdatalakeanalyticsjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Get-AzureRmDataLakeAnalyticsJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Get-AzureRmDataLakeAnalyticsJob.md ---- - -# Get-AzureRmDataLakeAnalyticsJob - -## SYNOPSIS -Gets a Data Lake Analytics job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetAllInResourceGroupAndAccount (Default) -``` -Get-AzureRmDataLakeAnalyticsJob [-Account] <String> [[-Name] <String>] [[-Submitter] <String>] - [[-SubmittedAfter] <DateTimeOffset>] [[-SubmittedBefore] <DateTimeOffset>] [[-State] <JobState[]>] - [[-Result] <JobResult[]>] [-Top <Int32>] [-PipelineId <Guid>] [-RecurrenceId <Guid>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetBySpecificJobInformation -``` -Get-AzureRmDataLakeAnalyticsJob [-Account] <String> [-JobId] <Guid> [[-Include] <ExtendedJobData>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDataLakeAnalyticsJob** cmdlet gets an Azure Data Lake Analytics job. -If you do not specify a job, this cmdlet gets all jobs. - -## EXAMPLES - -### Example 1: Get a specified job -``` -PS C:\>Get-AzureRmDataLakeAnalyticsJob -Account "contosoadla" -JobId $JobID01 -``` - -This command gets the job with the specified ID. - -### Example 2: Get jobs submitted in the past week -``` -PS C:\>Get-AzureRmDataLakeAnalyticsJob -Account "contosoadla" -SubmittedAfter (Get-Date).AddDays(-7) -``` - -This command gets jobs submitted in the past week. - -## PARAMETERS - -### -Account -Specifies the name of a Data Lake Analytics account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Include -Specifies options that indicate the type of additional information to retrieve about the job. -The acceptable values for this parameter are: -- None -- DebugInfo -- Statistics -- All - -```yaml -Type: Microsoft.Azure.Commands.DataLakeAnalytics.Models.DataLakeAnalyticsEnums+ExtendedJobData -Parameter Sets: GetBySpecificJobInformation -Aliases: -Accepted values: None, All, DebugInfo, Statistics - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -JobId -Specifies the ID of the job to get. - -```yaml -Type: System.Guid -Parameter Sets: GetBySpecificJobInformation -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies a name to use to filter the job list results. -The acceptable values for this parameter are: -- None -- DebugInfo -- Statistics -- All - -```yaml -Type: System.String -Parameter Sets: GetAllInResourceGroupAndAccount -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PipelineId -An optional ID that indicates only jobs part of the specified pipeline should be returned. - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: GetAllInResourceGroupAndAccount -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RecurrenceId -An optional ID that indicates only jobs part of the specified recurrence should be returned. - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: GetAllInResourceGroupAndAccount -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Result -Specifies a result filter for the job results. -The acceptable values for this parameter are: -- None -- Cancelled -- Failed -- Succeeded - -```yaml -Type: Microsoft.Azure.Management.DataLake.Analytics.Models.JobResult[] -Parameter Sets: GetAllInResourceGroupAndAccount -Aliases: -Accepted values: None, Succeeded, Cancelled, Failed - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -Specifies a state filter for the job results. -The acceptable values for this parameter are: -- Accepted -- New -- Compiling -- Scheduling -- Queued -- Starting -- Paused -- Running -- Ended - -```yaml -Type: Microsoft.Azure.Management.DataLake.Analytics.Models.JobState[] -Parameter Sets: GetAllInResourceGroupAndAccount -Aliases: -Accepted values: Accepted, Compiling, Ended, New, Queued, Running, Scheduling, Starting, Paused, WaitingForCapacity - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubmittedAfter -Specifies a date filter. -Use this parameter to filter the job list result to jobs submitted after the specified date. - -```yaml -Type: System.Nullable`1[System.DateTimeOffset] -Parameter Sets: GetAllInResourceGroupAndAccount -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubmittedBefore -Specifies a date filter. -Use this parameter to filter the job list result to jobs submitted before the specified date. - -```yaml -Type: System.Nullable`1[System.DateTimeOffset] -Parameter Sets: GetAllInResourceGroupAndAccount -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Submitter -Specifies the email address of a user. -Use this parameter to filter the job list results to jobs submitted by a specified user. - -```yaml -Type: System.String -Parameter Sets: GetAllInResourceGroupAndAccount -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Top -An optional value which indicates the number of jobs to return. Default value is 500 - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: GetAllInResourceGroupAndAccount -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Guid - -### Microsoft.Azure.Commands.DataLakeAnalytics.Models.DataLakeAnalyticsEnums+ExtendedJobData - -### System.Nullable`1[[System.DateTimeOffset, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### Microsoft.Azure.Management.DataLake.Analytics.Models.JobState[] - -### Microsoft.Azure.Management.DataLake.Analytics.Models.JobResult[] - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Management.DataLake.Analytics.Models.JobInformation - -## NOTES - -## RELATED LINKS - -[Stop-AzureRmDataLakeAnalyticsJob](./Stop-AzureRmDataLakeAnalyticsJob.md) - -[Submit-AzureRmDataLakeAnalyticsJob](./Submit-AzureRmDataLakeAnalyticsJob.md) - -[Wait-AzureRmDataLakeAnalyticsJob](./Wait-AzureRmDataLakeAnalyticsJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsJobPipeline.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsJobPipeline.md deleted file mode 100644 index 89560c157b..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsJobPipeline.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeAnalytics.dll-Help.xml -Module Name: AzureRM.DataLakeAnalytics -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics/get-azurermdatalakeanalyticsjobpipeline -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Get-AzureRmDataLakeAnalyticsJobPipeline.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Get-AzureRmDataLakeAnalyticsJobPipeline.md ---- - -# Get-AzureRmDataLakeAnalyticsJobPipeline - -## SYNOPSIS -Gets a Data Lake Analytics Job pipeline or pipelines. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetAllInAccount (Default) -``` -Get-AzureRmDataLakeAnalyticsJobPipeline [-Account] <String> [-SubmittedAfter <DateTimeOffset>] - [-SubmittedBefore <DateTimeOffset>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetBySpecificJobPipeline -``` -Get-AzureRmDataLakeAnalyticsJobPipeline [-Account] <String> [-PipelineId] <Guid> - [-SubmittedAfter <DateTimeOffset>] [-SubmittedBefore <DateTimeOffset>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDataLakeAnalyticsJobPipeline** gets a specified Azure Data Lake Analytics Job pipeline or a list of pipelines. - -## EXAMPLES - -### Example 1: Get a specified pipeline -``` -PS C:\>Get-AzureRmDataLakeAnalyticsJobPipeline -Account "contosoadla" -PipelineId 83cb7ad2-3523-4b82-b909-d478b0d8aea3 -``` - -This command gets the specified pipeline with id '83cb7ad2-3523-4b82-b909-d478b0d8aea3' in account 'contosoadla'. - -### Example 2: Get a list of all pipelines in the account -``` -PS C:\>Get-AzureRmDataLakeAnalyticsJobPipeline -AccountName "contosoadla" -``` - -This command gets a list of all pipelines in the account "contosoadla" - -## PARAMETERS - -### -Account -Name of the Data Lake Analytics account name under which want to retrieve the job pipeline. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PipelineId -ID of the specific job pipeline to return information for. - -```yaml -Type: System.Guid -Parameter Sets: GetBySpecificJobPipeline -Aliases: Id - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -SubmittedAfter -An optional filter which returns job pipeline(s) only submitted after the specified time. - -```yaml -Type: System.Nullable`1[System.DateTimeOffset] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubmittedBefore -An optional filter which returns job pipeline(s) only submitted before the specified time. - -```yaml -Type: System.Nullable`1[System.DateTimeOffset] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Guid - -### System.Nullable`1[[System.DateTimeOffset, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.DataLakeAnalytics.Models.PSJobPipelineInformation - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsJobRecurrence.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsJobRecurrence.md deleted file mode 100644 index 98a797a20e..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Get-AzureRmDataLakeAnalyticsJobRecurrence.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeAnalytics.dll-Help.xml -Module Name: AzureRM.DataLakeAnalytics -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics/get-azurermdatalakeanalyticsjobrecurrence -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Get-AzureRmDataLakeAnalyticsJobRecurrence.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Get-AzureRmDataLakeAnalyticsJobRecurrence.md ---- - -# Get-AzureRmDataLakeAnalyticsJobRecurrence - -## SYNOPSIS -Gets a Data Lake Analytics Job recurrence or recurrences. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetAllInAccount (Default) -``` -Get-AzureRmDataLakeAnalyticsJobRecurrence [-Account] <String> [-SubmittedAfter <DateTimeOffset>] - [-SubmittedBefore <DateTimeOffset>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetBySpecificJobRecurrence -``` -Get-AzureRmDataLakeAnalyticsJobRecurrence [-Account] <String> [-RecurrenceId] <Guid> - [-SubmittedAfter <DateTimeOffset>] [-SubmittedBefore <DateTimeOffset>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDataLakeAnalyticsJobRecurrence** gets a specified Azure Data Lake Analytics Job recurrence or a list of recurrence. - -## EXAMPLES - -### Example 1: Get a specified recurrence -``` -PS C:\>Get-AzureRmDataLakeAnalyticsJobRecurrence -Account "contosoadla" -RecurrenceId 83cb7ad2-3523-4b82-b909-d478b0d8aea3 -``` - -This command gets the specified job recurrence with id '83cb7ad2-3523-4b82-b909-d478b0d8aea3' in account 'contosoadla'. - -### Example 2: Get a list of all recurrences in the account -``` -PS C:\>Get-AzureRmDataLakeAnalyticsJobRecurrence -AccountName "contosoadla" -``` - -This command gets a list of all recurrences in the account "contosoadla" - -## PARAMETERS - -### -Account -Name of the Data Lake Analytics account name under which want to retrieve the job recurrence. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecurrenceId -ID of the specific job recurrence to return information for. - -```yaml -Type: System.Guid -Parameter Sets: GetBySpecificJobRecurrence -Aliases: Id - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -SubmittedAfter -An optional filter which returns job recurrence(s) only submitted after the specified time. - -```yaml -Type: System.Nullable`1[System.DateTimeOffset] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubmittedBefore -An optional filter which returns job recurrence(s) only submitted before the specified time. - -```yaml -Type: System.Nullable`1[System.DateTimeOffset] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Guid - -### System.Nullable`1[[System.DateTimeOffset, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.DataLakeAnalytics.Models.PSJobRecurrenceInformation - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/New-AzureRmDataLakeAnalyticsAccount.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/New-AzureRmDataLakeAnalyticsAccount.md deleted file mode 100644 index 0ce022b049..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/New-AzureRmDataLakeAnalyticsAccount.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeAnalytics.dll-Help.xml -Module Name: AzureRM.DataLakeAnalytics -ms.assetid: 0A7CD695-6D14-4BC9-B960-0CAFE502B88B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics/new-azurermdatalakeanalyticsaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/New-AzureRmDataLakeAnalyticsAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/New-AzureRmDataLakeAnalyticsAccount.md ---- - -# New-AzureRmDataLakeAnalyticsAccount - -## SYNOPSIS -Creates a Data Lake Analytics account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmDataLakeAnalyticsAccount [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> - [-DefaultDataLakeStore] <String> [[-Tag] <Hashtable>] [-MaxAnalyticsUnits <Int32>] [-MaxJobCount <Int32>] - [-QueryStoreRetention <Int32>] [-Tier <TierType>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmDataLakeAnalyticsAccount** cmdlet creates an Azure Data Lake Analytics account. - -## EXAMPLES - -### Example 1: Create a Data Lake Analytics account -``` -PS C:\>New-AzureRmDataLakeAnalyticsAccount -Name "ContosoAdlAccount" -ResourceGroupName "ContosoOrg" -Location "East US 2" -DefaultDataLakeStore "ContosoAdlStore" -``` - -This command creates a Data Lake Analytics account named ContosoAdlAccount that uses the ContosoAdlStore Data Store, in the resource group named ContosoOrg. - -## PARAMETERS - -### -DefaultDataLakeStore -Specifies the name of the Data Lake Store account to set as the default data source. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location at which to create the Data Lake Analytics account. -Only East US 2 is supported at this time. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaxAnalyticsUnits -The optional maximum supported analytics units for this account. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: MaxDegreeOfParallelism - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaxJobCount -The optional maximum supported jobs running under the account at the same time. If none is specified, defaults to 3 - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the Data Lake Analytics account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -QueryStoreRetention -The optional number of days that job metadata is retained. If none specified, the default is 30 days. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group name of the Data Lake Analytics account. -To create a resource group, use the New-AzureRmResourceGroup cmdlet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -A string,string dictionary of tags associated with this account - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tier -The desired commitment tier for this account to use. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.DataLake.Analytics.Models.TierType] -Parameter Sets: (All) -Aliases: -Accepted values: Consumption, Commitment100AUHours, Commitment500AUHours, Commitment1000AUHours, Commitment5000AUHours, Commitment10000AUHours, Commitment50000AUHours, Commitment100000AUHours, Commitment500000AUHours - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Nullable`1[[Microsoft.Azure.Management.DataLake.Analytics.Models.TierType, Microsoft.Azure.Management.DataLake.Analytics, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -## OUTPUTS - -### Microsoft.Azure.Commands.DataLakeAnalytics.Models.PSDataLakeAnalyticsAccount - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDataLakeAnalyticsAccount](./Get-AzureRmDataLakeAnalyticsAccount.md) - -[Remove-AzureRmDataLakeAnalyticsAccount](./Remove-AzureRmDataLakeAnalyticsAccount.md) - -[Set-AzureRmDataLakeAnalyticsAccount](./Set-AzureRmDataLakeAnalyticsAccount.md) - -[Test-AzureRmDataLakeAnalyticsAccount](./Test-AzureRmDataLakeAnalyticsAccount.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/New-AzureRmDataLakeAnalyticsCatalogCredential.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/New-AzureRmDataLakeAnalyticsCatalogCredential.md deleted file mode 100644 index c342bd9286..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/New-AzureRmDataLakeAnalyticsCatalogCredential.md +++ /dev/null @@ -1,230 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeAnalytics.dll-Help.xml -Module Name: AzureRM.DataLakeAnalytics -ms.assetid: BB6AF5A9-49BD-4A76-9F3F-44B62D2AB842 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics/new-azurermdatalakeanalyticscatalogcredential -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/New-AzureRmDataLakeAnalyticsCatalogCredential.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/New-AzureRmDataLakeAnalyticsCatalogCredential.md ---- - -# New-AzureRmDataLakeAnalyticsCatalogCredential - -## SYNOPSIS -Creates a new Azure Data Lake Analytics catalog credential. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### CreateByHostNameAndPort (Default) -``` -New-AzureRmDataLakeAnalyticsCatalogCredential [-Account] <String> [-DatabaseName] <String> - [-CredentialName] <String> [-Credential] <PSCredential> [-Uri] <Uri> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### CreateByFullURI -``` -New-AzureRmDataLakeAnalyticsCatalogCredential [-Account] <String> [-DatabaseName] <String> - [-CredentialName] <String> [-Credential] <PSCredential> [-DatabaseHost] <String> [-Port] <Int32> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmDataLakeAnalyticsCatalogCredential cmdlet creates a new credential to use in an Azure Data Lake Analytics catalog for connecting to external data sources. - -## EXAMPLES - -### Example 1: Create a credential for a catalog specifying host and port -``` -PS C:\> New-AzureRmDataLakeAnalyticsCatalogCredential -AccountName "ContosoAdlAccount" ` - -DatabaseName "databaseName" ` - -CredentialName "exampleDbCred" ` - -Credential (Get-Credential) ` - -DatabaseHost "example.contoso.com" -Port 8080 -``` - -This command creates the specified credential for the specified account, database, host and port using https protocol. - -### Example 2: Create a credential for a catalog specifying full URI -``` -PS C:\> New-AzureRmDataLakeAnalyticsCatalogCredential -AccountName "ContosoAdlAccount" ` - -DatabaseName "databaseName" ` - -CredentialName "exampleDbCred" ` - -Credential (Get-Credential) ` - -Uri "http://httpExample.contoso.com:8080" -``` - -This command creates the specified credential for the specified account, database and external data source URI. - -## PARAMETERS - -### -Account -Specifies the Data Lake Analytics account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Credential -Specifies the user name and corresponding password of the credential. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CredentialName -Specifies the name and password of the credential. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseHost -Specifies the host name of the external data source the credential can connect to in the format mydatabase.contoso.com. - -```yaml -Type: System.String -Parameter Sets: CreateByFullURI -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the database in the Data Lake Analytics account that the credential will be stored in. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Port -Specifies the port number used to connect to the specified DatabaseHost using this credential. - -```yaml -Type: System.Int32 -Parameter Sets: CreateByFullURI -Aliases: - -Required: True -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Uri -Specifies the full Uniform Resource Identifier (URI) of the external data source this credential can connect to. - -```yaml -Type: System.Uri -Parameter Sets: CreateByHostNameAndPort -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.PSCredential - -### System.Uri - -### System.Int32 - -## OUTPUTS - -### Microsoft.Azure.Management.DataLake.Analytics.Models.USqlCredential - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/New-AzureRmDataLakeAnalyticsCatalogSecret.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/New-AzureRmDataLakeAnalyticsCatalogSecret.md deleted file mode 100644 index 3f48acaadc..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/New-AzureRmDataLakeAnalyticsCatalogSecret.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeAnalytics.dll-Help.xml -Module Name: AzureRM.DataLakeAnalytics -ms.assetid: C0BE6C8D-37F5-445F-AE15-2CD4F8D8E031 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics/new-azurermdatalakeanalyticscatalogsecret -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/New-AzureRmDataLakeAnalyticsCatalogSecret.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/New-AzureRmDataLakeAnalyticsCatalogSecret.md ---- - -# New-AzureRmDataLakeAnalyticsCatalogSecret - -## SYNOPSIS -Creates a Data Lake Analytics catalog secret. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### CreateByFullURI -``` -New-AzureRmDataLakeAnalyticsCatalogSecret [-Account] <String> [-DatabaseName] <String> [-Secret] <PSCredential> - [-DatabaseHost] <String> [-Port] <Int32> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### CreateByHostNameAndPort -``` -New-AzureRmDataLakeAnalyticsCatalogSecret [-Account] <String> [-DatabaseName] <String> [-Secret] <PSCredential> - [-Uri] <Uri> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmDataLakeAnalyticsCatalogSecret** cmdlet creates a secret to use in an Azure Data Lake Analytics catalog. - -## EXAMPLES - -### Example 1: Get the secret for a catalog -``` -PS C:\>New-AzureRmDataLakeAnalyticsCatalogSecret -Account "ContosoAdlAccount" -DatabaseName "databaseName" -Secret (Get-Credential) -Host "https://example.contoso.com" -Port 8080 -``` - -This command gets the secret corresponding to the specified account, database, credential, and host. - -## PARAMETERS - -### -Account -Specifies the name of the Data Lake Analytics account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseHost -Specifies the host name for the database the secret is associated with in the format 'mydatabase.contoso.com'. - -```yaml -Type: System.String -Parameter Sets: CreateByFullURI -Aliases: Host - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the database that holds the secret. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Port -Specifies the port number of the secret. - -```yaml -Type: System.Int32 -Parameter Sets: CreateByFullURI -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Secret -Specifies the name and password of the secret. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Uri -Specifies the Uniform Resource Identifier (URI) of the secret. - -```yaml -Type: System.Uri -Parameter Sets: CreateByHostNameAndPort -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.PSCredential - -### System.Uri - -### System.Int32 - -## OUTPUTS - -### Microsoft.Azure.Management.DataLake.Analytics.Models.USqlSecret - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmDataLakeAnalyticsCatalogSecret](./Remove-AzureRmDataLakeAnalyticsCatalogSecret.md) - -[Set-AzureRmDataLakeAnalyticsCatalogSecret](./Set-AzureRmDataLakeAnalyticsCatalogSecret.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/New-AzureRmDataLakeAnalyticsComputePolicy.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/New-AzureRmDataLakeAnalyticsComputePolicy.md deleted file mode 100644 index 3f2aacec88..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/New-AzureRmDataLakeAnalyticsComputePolicy.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeAnalytics.dll-Help.xml -Module Name: AzureRM.DataLakeAnalytics -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics/new-azurermdatalakeanalyticscomputepolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/New-AzureRmDataLakeAnalyticsComputePolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/New-AzureRmDataLakeAnalyticsComputePolicy.md ---- - -# New-AzureRmDataLakeAnalyticsComputePolicy - -## SYNOPSIS -Creates a Data Lake Analytics compute policy rule for a specific Microsoft Entra entity. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmDataLakeAnalyticsComputePolicy [-ResourceGroupName <String>] [-Account] <String> [-Name] <String> - [-ObjectId] <Guid> [-ObjectType] <String> [-MaxAnalyticsUnitsPerJob <Int32>] [-MinPriorityPerJob <Int32>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmDataLakeAnalyticsComputePolicy** creates the specified compute policy rule for a specific Microsoft Entra entity in an Azure Data Lake Analytics account. - -## EXAMPLES - -### Example 1: Create a compute policy with only one rule -``` -PS C:\>New-AzureRmDataLakeAnalyticsComputePolicy -Account "contosoadla" -Name "myPolicy" -ObjectId 83cb7ad2-3523-4b82-b909-d478b0d8aea3 -ObjectType User -MaxAnalyticsUnitsPerJob 5 -``` - -This command creates a policy called "myPolicy" in account "contosoadla" for the user with id "83cb7ad2-3523-4b82-b909-d478b0d8aea3" that ensures they cannot submit any job with more than 5 analytics units. - -### Example 2: Create a compute policy with both rules set -``` -PS C:\>New-AzureRmDataLakeAnalyticsComputePolicy -Account "contosoadla" -Name "myPolicy" -ObjectId 83cb7ad2-3523-4b82-b909-d478b0d8aea3 -ObjectType User -MaxAnalyticsUnitsPerJob 5 -MinPriorityPerJob 100 -``` - -This command creates a policy called "myPolicy" in account "contosoadla" for the user with id "83cb7ad2-3523-4b82-b909-d478b0d8aea3" that ensures they cannot submit any job with more than 5 analytics units or with a priority lower than 100 - -## PARAMETERS - -### -Account -Name of the account to add the compute policy to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxAnalyticsUnitsPerJob -The maximum supported analytics units per job for this policy. -Either this, MinPriorityPerJob, or both parameters must be specified. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: MaxDegreeOfParallelismPerJob - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MinPriorityPerJob -The minimum supported priority per job for this policy. -Either this, MaxAnalyticsUnitsPerJob, or both parameters must be specified. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Name of the compute policy to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ComputePolicyName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ObjectId -The Microsoft Entra object id for the user or group to apply the policy to. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ObjectType -The Microsoft Entra object type for the object ID passed in. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: User, Group, ServicePrincipal - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of resource group under which you the account exists. -Optional and will attempt to discover if not provided. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Guid - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.DataLakeAnalytics.Models.PSDataLakeAnalyticsComputePolicy - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Remove-AzureRmDataLakeAnalyticsAccount.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Remove-AzureRmDataLakeAnalyticsAccount.md deleted file mode 100644 index 2e7dfc0fce..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Remove-AzureRmDataLakeAnalyticsAccount.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeAnalytics.dll-Help.xml -Module Name: AzureRM.DataLakeAnalytics -ms.assetid: AEAD985C-F342-4B24-9BFD-6448436FE9BD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics/remove-azurermdatalakeanalyticsaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Remove-AzureRmDataLakeAnalyticsAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Remove-AzureRmDataLakeAnalyticsAccount.md ---- - -# Remove-AzureRmDataLakeAnalyticsAccount - -## SYNOPSIS -Deletes a Data Lake Analytics account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmDataLakeAnalyticsAccount [-Name] <String> [[-ResourceGroupName] <String>] [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmDataLakeAnalyticsAccount** cmdlet permanently deletes an Azure Data Lake Analytics account. - -## EXAMPLES - -### Example 1: Remove an account -``` -PS C:\>Remove-AzureRmDataLakeAnalyticsAccount -Name "ContosoAdlAccount" -``` - -This command removes the specified Data Lake Analytics account. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the Data Lake Analytics account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group name of the Data Lake Analytics account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDataLakeAnalyticsAccount](./Get-AzureRmDataLakeAnalyticsAccount.md) - -[New-AzureRmDataLakeAnalyticsAccount](./New-AzureRmDataLakeAnalyticsAccount.md) - -[Set-AzureRmDataLakeAnalyticsAccount](./Set-AzureRmDataLakeAnalyticsAccount.md) - -[Test-AzureRmDataLakeAnalyticsAccount](./Test-AzureRmDataLakeAnalyticsAccount.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Remove-AzureRmDataLakeAnalyticsCatalogCredential.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Remove-AzureRmDataLakeAnalyticsCatalogCredential.md deleted file mode 100644 index 901bf5ca5d..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Remove-AzureRmDataLakeAnalyticsCatalogCredential.md +++ /dev/null @@ -1,210 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeAnalytics.dll-Help.xml -Module Name: AzureRM.DataLakeAnalytics -ms.assetid: C6BB6E4D-6009-4796-866B-17115FDFA06D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics/remove-azurermdatalakeanalyticscatalogcredential -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Remove-AzureRmDataLakeAnalyticsCatalogCredential.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Remove-AzureRmDataLakeAnalyticsCatalogCredential.md ---- - -# Remove-AzureRmDataLakeAnalyticsCatalogCredential - -## SYNOPSIS -Deletes an Azure Data Lake Analytics credential. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmDataLakeAnalyticsCatalogCredential [-Account] <String> [-DatabaseName] <String> [-Name] <String> - [[-Password] <PSCredential>] [-Recurse] [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmDataLakeAnalyticsCatalogCredential cmdlet deletes an Azure Data Lake Analytics catalog credential. - -## EXAMPLES - -### Example 1: Remove a credential -``` -PS C:\> Remove-AzureRmDataLakeAnalyticsCatalogCredential -AccountName "ContosoAdla" ` - -DatabaseName "DatabaseName" ` - -Name "CredName" -``` - -This command removes the specified Data Lake Analytics catalog credential. - -## PARAMETERS - -### -Account -Specifies the Data Lake Analytics account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the database that holds the credential. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the credential. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet does not wait for the operation to complete. -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -The password for the credential. -This is required if the caller is not the owner of the account. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Recurse -Indicates that this delete operation should go through and also delete and drop all resources dependent on this credential. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.PSCredential - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Remove-AzureRmDataLakeAnalyticsCatalogItemAclEntry.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Remove-AzureRmDataLakeAnalyticsCatalogItemAclEntry.md deleted file mode 100644 index 09a8804428..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Remove-AzureRmDataLakeAnalyticsCatalogItemAclEntry.md +++ /dev/null @@ -1,243 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeAnalytics.dll-Help.xml -Module Name: AzureRM.DataLakeAnalytics -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics/remove-azurermdatalakeanalyticscatalogitemaclentry -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Remove-AzureRmDataLakeAnalyticsCatalogItemAclEntry.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Remove-AzureRmDataLakeAnalyticsCatalogItemAclEntry.md ---- - -# Remove-AzureRmDataLakeAnalyticsCatalogItemAclEntry - -## SYNOPSIS -Deletes an entry from the ACL of a catalog or catalog item in Data Lake Analytics. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RemoveCatalogAclEntryForUser (Default) -``` -Remove-AzureRmDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-User] -ObjectId <Guid> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RemoveCatalogItemAclEntryForUser -``` -Remove-AzureRmDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-User] -ObjectId <Guid> - -ItemType <String> -Path <CatalogPathInstance> [-PassThru] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RemoveCatalogAclEntryForGroup -``` -Remove-AzureRmDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-Group] -ObjectId <Guid> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RemoveCatalogItemAclEntryForGroup -``` -Remove-AzureRmDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-Group] -ObjectId <Guid> - -ItemType <String> -Path <CatalogPathInstance> [-PassThru] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmDataLakeAnalyticsCatalogItemAclEntry** cmdlet removes an entry (ACE) from the access control list (ACL) of a catalog or catalog item in Data Lake Analytics. - -## EXAMPLES - -### Example 1: Remove the user ACL for a catalog -```powershell -PS C:\> Remove-AzureRmDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" -User -ObjectId (Get-AzureRmADUser -Mail "PattiFuller@contoso.com").Id -``` - -This command removes the catalog ACL for Patti Fuller of the contosoadla account. - -### Example 2: Remove the user ACL for a database -```powershell -PS C:\> Remove-AzureRmDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" -User -ObjectId (Get-AzureRmADUser -Mail "PattiFuller@contoso.com").Id -ItemType Database -Path "databaseName" -``` - -This command removes the database ACL for Patti Fuller of the contosoadla account. - -## PARAMETERS - -### -Account -Specifies the Data Lake Analytics account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group -Remove ACL entry of catalog for group. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: RemoveCatalogAclEntryForGroup, RemoveCatalogItemAclEntryForGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ItemType -Specifies the type of the catalog or catalog item(s). The acceptable values for this parameter are: -- Catalog -- Database - -```yaml -Type: System.String -Parameter Sets: RemoveCatalogItemAclEntryForUser, RemoveCatalogItemAclEntryForGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ObjectId -The identity of the user to remove. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: Id, UserId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates a boolean response should be returned indicating the result of the delete operation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the Data Lake Analytics path of an catalog or catalog item. -The parts of the path should be separated by a period (.). - -```yaml -Type: Microsoft.Azure.Commands.DataLakeAnalytics.Models.CatalogPathInstance -Parameter Sets: RemoveCatalogItemAclEntryForUser, RemoveCatalogItemAclEntryForGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -User -Remove ACL entry of catalog for user. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: RemoveCatalogAclEntryForUser, RemoveCatalogItemAclEntryForUser -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Guid - -### Microsoft.Azure.Commands.DataLakeAnalytics.Models.CatalogPathInstance - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[U-SQL now offers database level access control](https://github.com/Azure/AzureDataLake/blob/master/docs/Release_Notes/2016/2016_08_01/USQL_Release_Notes_2016_08_01.md#u-sql-now-offers-database-level-access-control) - -[Get-AzureRmDataLakeAnalyticsCatalogItemAclEntry](Get-AzureRmDataLakeAnalyticsCatalogItemAclEntry.md) - -[Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry](Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry.md) diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Remove-AzureRmDataLakeAnalyticsCatalogSecret.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Remove-AzureRmDataLakeAnalyticsCatalogSecret.md deleted file mode 100644 index 96bceb34e1..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Remove-AzureRmDataLakeAnalyticsCatalogSecret.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeAnalytics.dll-Help.xml -Module Name: AzureRM.DataLakeAnalytics -ms.assetid: 7F063C03-3EAA-4D90-BC4B-E29721B328D9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics/remove-azurermdatalakeanalyticscatalogsecret -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Remove-AzureRmDataLakeAnalyticsCatalogSecret.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Remove-AzureRmDataLakeAnalyticsCatalogSecret.md ---- - -# Remove-AzureRmDataLakeAnalyticsCatalogSecret - -## SYNOPSIS -Deletes a Data Lake Analytics secret. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmDataLakeAnalyticsCatalogSecret [-Account] <String> [-DatabaseName] <String> [[-Name] <String>] - [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmDataLakeAnalyticsCatalogSecret** cmdlet deletes an Azure Data Lake Analytics catalog secret. - -## EXAMPLES - -### Example 1: Remove a secret -``` -PS C:\>Remove-AzureRmDataLakeAnalyticsCatalogSecret -Account "ContosoAdla" -DatabaseName "DatabaseName" -Name "SecretName" -``` - -This command removes the specified Data Lake Analytics catalog secret. - -## PARAMETERS - -### -Account -Specifies the Data Lake Analytics account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the database that holds the secret. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the secret. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[New-AzureRmDataLakeAnalyticsCatalogSecret](./New-AzureRmDataLakeAnalyticsCatalogSecret.md) - -[Set-AzureRmDataLakeAnalyticsCatalogSecret](./Set-AzureRmDataLakeAnalyticsCatalogSecret.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Remove-AzureRmDataLakeAnalyticsComputePolicy.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Remove-AzureRmDataLakeAnalyticsComputePolicy.md deleted file mode 100644 index 56d35114c6..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Remove-AzureRmDataLakeAnalyticsComputePolicy.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeAnalytics.dll-Help.xml -Module Name: AzureRM.DataLakeAnalytics -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics/remove-azurermdatalakeanalyticscomputepolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Remove-AzureRmDataLakeAnalyticsComputePolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Remove-AzureRmDataLakeAnalyticsComputePolicy.md ---- - -# Remove-AzureRmDataLakeAnalyticsComputePolicy - -## SYNOPSIS -Removes a specified Azure Data Lake Analytics compute policy - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmDataLakeAnalyticsComputePolicy [-ResourceGroupName <String>] [-Account] <String> [-Name] <String> - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmDataLakeAnalyticsComputePolicy** removes a specified Azure Data Lake Analytics compute policy. - -## EXAMPLES - -### Example 1: Remove a compute policy -``` -PS C:\>Remove-AzureRmDataLakeAnalyticsComputePolicy -Account "contosoadla" -Name myPolicy -``` - -This command removes the specified compute policy with name 'myPolicy' in account 'contosoadla'. - -## PARAMETERS - -### -Account -Name of the account to remove the compute policy from. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the compute policy to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ComputePolicyName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Return true upon successful deletion. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of resource group under which you the account exists. -Optional and will attempt to discover if not provided. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Remove-AzureRmDataLakeAnalyticsDataSource.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Remove-AzureRmDataLakeAnalyticsDataSource.md deleted file mode 100644 index ac64a93db9..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Remove-AzureRmDataLakeAnalyticsDataSource.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeAnalytics.dll-Help.xml -Module Name: AzureRM.DataLakeAnalytics -ms.assetid: E0E2617F-F6F1-434E-AD7C-27D309C2C3DA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics/remove-azurermdatalakeanalyticsdatasource -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Remove-AzureRmDataLakeAnalyticsDataSource.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Remove-AzureRmDataLakeAnalyticsDataSource.md ---- - -# Remove-AzureRmDataLakeAnalyticsDataSource - -## SYNOPSIS -Removes a data source from a Data Lake Analytics account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RemoveDataLakeStorageAccount -``` -Remove-AzureRmDataLakeAnalyticsDataSource [-Account] <String> [-DataLakeStore] <String> [-Force] [-PassThru] - [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### RemoveBlobStorageAccount -``` -Remove-AzureRmDataLakeAnalyticsDataSource [-Account] <String> [-Blob] <String> [-Force] [-PassThru] - [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmDataLakeAnalyticsDataSource** cmdlet removes a data source from an Azure Data Lake Analytics account. - -## EXAMPLES - -### Example 1: Remove a data source -``` -PS C:\>Remove-AzureRmDataLakeAnalyticsDataSource -Account "ContosoAdlAccount" -Blob "AzureStorage01" -``` - -This command removes the data source named AzureStorage01 from the account named ContosoAdlAccount. - -## PARAMETERS - -### -Account -Specifies the Data Lake Analytics account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Blob -Specifies the name of the AzureBlob Storage account to remove. - -```yaml -Type: System.String -Parameter Sets: RemoveBlobStorageAccount -Aliases: AzureBlob - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataLakeStore -Specifies the name of the AzureData Lake Store account to remove. - -```yaml -Type: System.String -Parameter Sets: RemoveDataLakeStorageAccount -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group name of the Data Lake Analytics account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Add-AzureRmDataLakeAnalyticsDataSource](./Add-AzureRmDataLakeAnalyticsDataSource.md) - -[Set-AzureRmDataLakeAnalyticsDataSource](./Set-AzureRmDataLakeAnalyticsDataSource.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Remove-AzureRmDataLakeAnalyticsFirewallRule.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Remove-AzureRmDataLakeAnalyticsFirewallRule.md deleted file mode 100644 index ebd5dce931..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Remove-AzureRmDataLakeAnalyticsFirewallRule.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeAnalytics.dll-Help.xml -Module Name: AzureRM.DataLakeAnalytics -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics/remove-azurermdatalakeanalyticsfirewallrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Remove-AzureRmDataLakeAnalyticsFirewallRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Remove-AzureRmDataLakeAnalyticsFirewallRule.md ---- - -# Remove-AzureRmDataLakeAnalyticsFirewallRule - -## SYNOPSIS -Removes a firewall rule from a Data Lake Analytics account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmDataLakeAnalyticsFirewallRule [-Account] <String> [[-Name] <String>] [-PassThru] - [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmDataLakeAnalyticsFirewallRule** cmdlet removes a firewall rule from an Azure Data Lake Analytics account. - -## EXAMPLES - -### Example 1: Remove a firewall rule -``` -PS C:\>Remove-AzureRmDataLakeAnalyticsFirewallRule -Account "ContosoAdlAcct" -Name "My firewall rule" -``` - -This command removes the firewall rule named "my firewall rule" from account "ContosoAdlAcct" - -## PARAMETERS - -### -Account -The Data Lake Analytics account to remove the firewall rule from - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the firewall rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates a boolean response should be returned indicating the result of the delete operation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of resource group under which want to retrieve the account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Set-AzureRmDataLakeAnalyticsAccount.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Set-AzureRmDataLakeAnalyticsAccount.md deleted file mode 100644 index 03ebf2aea1..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Set-AzureRmDataLakeAnalyticsAccount.md +++ /dev/null @@ -1,227 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeAnalytics.dll-Help.xml -Module Name: AzureRM.DataLakeAnalytics -ms.assetid: 8B10E476-F283-4BDC-BFAD-A33F8EC38341 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics/set-azurermdatalakeanalyticsaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Set-AzureRmDataLakeAnalyticsAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Set-AzureRmDataLakeAnalyticsAccount.md ---- - -# Set-AzureRmDataLakeAnalyticsAccount - -## SYNOPSIS -Modifies a Data Lake Analytics account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmDataLakeAnalyticsAccount [-Name] <String> [[-Tag] <Hashtable>] [[-ResourceGroupName] <String>] - [-MaxAnalyticsUnits <Int32>] [-MaxJobCount <Int32>] [-QueryStoreRetention <Int32>] [-Tier <TierType>] - [-FirewallState <FirewallState>] [-AllowAzureIpState <FirewallAllowAzureIpsState>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDataLakeAnalyticsAccount** cmdlet modifies an Azure Data Lake Analytics account. - -## EXAMPLES - -### Example 1: Modify the data source of an account -``` -PS C:\>Set-AzureRmDataLakeAnalyticsAccount -Name "ContosoAdlAcct" -DefaultDataLakeStore "ContosoAdlStore01" -Tags @{"stage"="production"} -``` - -This command changes the default data source and the Tags property of the account. - -## PARAMETERS - -### -AllowAzureIpState -Optionally allow/block Azure originating IPs through the firewall. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.DataLake.Analytics.Models.FirewallAllowAzureIpsState] -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FirewallState -Optionally enable/disable existing firewall rules. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.DataLake.Analytics.Models.FirewallState] -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaxAnalyticsUnits -The optional maximum supported analytics units to update the account with. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: MaxDegreeOfParallelism - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaxJobCount -The optional maximum supported jobs running under the account at the same time to set. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the Data Lake Analytics account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -QueryStoreRetention -The optional number of days that job metadata is retained to set in the account. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group name of the Data Lake Analytics account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -A string,string dictionary of tags associated with this account that should replace the current set of tags - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tier -The desired commitment tier for this account to use. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.DataLake.Analytics.Models.TierType] -Parameter Sets: (All) -Aliases: -Accepted values: Consumption, Commitment100AUHours, Commitment500AUHours, Commitment1000AUHours, Commitment5000AUHours, Commitment10000AUHours, Commitment50000AUHours, Commitment100000AUHours, Commitment500000AUHours - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Nullable`1[[Microsoft.Azure.Management.DataLake.Analytics.Models.TierType, Microsoft.Azure.Management.DataLake.Analytics, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -### System.Nullable`1[[Microsoft.Azure.Management.DataLake.Analytics.Models.FirewallState, Microsoft.Azure.Management.DataLake.Analytics, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -### System.Nullable`1[[Microsoft.Azure.Management.DataLake.Analytics.Models.FirewallAllowAzureIpsState, Microsoft.Azure.Management.DataLake.Analytics, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -## OUTPUTS - -### Microsoft.Azure.Commands.DataLakeAnalytics.Models.PSDataLakeAnalyticsAccount - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDataLakeAnalyticsAccount](./Get-AzureRmDataLakeAnalyticsAccount.md) - -[New-AzureRmDataLakeAnalyticsAccount](./New-AzureRmDataLakeAnalyticsAccount.md) - -[Remove-AzureRmDataLakeAnalyticsAccount](./Remove-AzureRmDataLakeAnalyticsAccount.md) - -[Test-AzureRmDataLakeAnalyticsAccount](./Test-AzureRmDataLakeAnalyticsAccount.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Set-AzureRmDataLakeAnalyticsCatalogCredential.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Set-AzureRmDataLakeAnalyticsCatalogCredential.md deleted file mode 100644 index 22b9d19fd8..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Set-AzureRmDataLakeAnalyticsCatalogCredential.md +++ /dev/null @@ -1,235 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeAnalytics.dll-Help.xml -Module Name: AzureRM.DataLakeAnalytics -ms.assetid: 75E4E0FB-35A8-47DA-B606-45E073D04625 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics/set-azurermdatalakeanalyticscatalogcredential -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Set-AzureRmDataLakeAnalyticsCatalogCredential.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Set-AzureRmDataLakeAnalyticsCatalogCredential.md ---- - -# Set-AzureRmDataLakeAnalyticsCatalogCredential - -## SYNOPSIS -Modifies an Azure Data Lake Analytics catalog credential password. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByHostNameAndPort (Default) -``` -Set-AzureRmDataLakeAnalyticsCatalogCredential [-Account] <String> [-DatabaseName] <String> - [-CredentialName] <String> [-Credential] <PSCredential> [-NewPassword] <PSCredential> [-Uri] <Uri> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByFullURI -``` -Set-AzureRmDataLakeAnalyticsCatalogCredential [-Account] <String> [-DatabaseName] <String> - [-CredentialName] <String> [-Credential] <PSCredential> [-NewPassword] <PSCredential> [-DatabaseHost] <String> - [-Port] <Int32> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Set-AzureRmDataLakeAnalyticsCatalogCredential cmdlet modifies a credential password associated with an Azure Data Lake Analytics catalog. - -## EXAMPLES - -### Example 1: Modify a credential's password associated with an account -``` -PS C:\> Set-AzureRmDataLakeAnalyticsCatalogCredential -AccountName "ContosoAdlAccount" ` - -DatabaseName "databaseName" ` - -CredentialName "credName" ` - -Credential (Get-Credential) ` - -NewPassword (Get-Credential) ` - -Host "example.contoso.com" -Port 8080 -``` - -This command sets the credential password to the password specified in NewPassword. - -## PARAMETERS - -### -Account -Specifies the Data Lake Analytics account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Credential -Specifies the name and current password of the credential to modify. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CredentialName -Specifies the name of the credential to modify - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseHost -Specifies the host name of the external data source the credential can connect to in the format mydatabase.contoso.com. - -```yaml -Type: System.String -Parameter Sets: SetByFullURI -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the database in the Data Lake Analytics account holding the credential. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewPassword -Specifies the new password for the credential - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Port -Specifies the port number used to connect to the specified DatabaseHost using this credential. - -```yaml -Type: System.Int32 -Parameter Sets: SetByFullURI -Aliases: - -Required: True -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Uri -Specifies the full Uniform Resource Identifier (URI) of the external data source this credential can connect to. - -```yaml -Type: System.Uri -Parameter Sets: SetByHostNameAndPort -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.PSCredential - -### System.Uri - -### System.Int32 - -## OUTPUTS - -### Microsoft.Azure.Management.DataLake.Analytics.Models.USqlCredential - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry.md deleted file mode 100644 index 0a4c2d4908..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry.md +++ /dev/null @@ -1,398 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeAnalytics.dll-Help.xml -Module Name: AzureRM.DataLakeAnalytics -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics/set-azurermdatalakeanalyticscatalogitemaclentry -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry.md ---- - -# Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry - -## SYNOPSIS -Modifies an entry in the ACL of a catalog or catalog item in Data Lake Analytics. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetCatalogAclEntryForUser (Default) -``` -Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-User] -ObjectId <Guid> - -Permissions <PermissionType> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### SetCatalogItemAclEntryForUser -``` -Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-User] -ObjectId <Guid> -ItemType <String> - -Path <CatalogPathInstance> -Permissions <PermissionType> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### SetCatalogAclEntryForGroup -``` -Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-Group] -ObjectId <Guid> - -Permissions <PermissionType> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### SetCatalogItemAclEntryForGroup -``` -Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-Group] -ObjectId <Guid> - -ItemType <String> -Path <CatalogPathInstance> -Permissions <PermissionType> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetCatalogAclEntryForOther -``` -Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-Other] -Permissions <PermissionType> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetCatalogItemAclEntryForOther -``` -Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-Other] -ItemType <String> - -Path <CatalogPathInstance> -Permissions <PermissionType> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### SetCatalogAclEntryForUserOwner -``` -Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-UserOwner] -Permissions <PermissionType> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetCatalogItemAclEntryForUserOwner -``` -Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-UserOwner] -ItemType <String> - -Path <CatalogPathInstance> -Permissions <PermissionType> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### SetCatalogAclEntryForGroupOwner -``` -Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-GroupOwner] -Permissions <PermissionType> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetCatalogItemAclEntryForGroupOwner -``` -Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry [-Account] <String> [-GroupOwner] -ItemType <String> - -Path <CatalogPathInstance> -Permissions <PermissionType> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry** cmdlet adds or modifies an entry (ACE) in the access control list (ACL) of a catalog or catalog item in Data Lake Analytics. - -## EXAMPLES - -### Example 1: Modify user permissions for a catalog -```powershell -PS C:\> Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" -User -ObjectId (Get-AzureRmADUser -Mail "PattiFuller@contoso.com").Id -Permissions Read - -Type Id Permissions ----- -- ----------- -User 90a6f74b-fd73-490e-900a-c4f0f9694d02 Read -Group 902b155a-5601-4ca8-8178-ad3289211f88 ReadWrite -Other 00000000-0000-0000-0000-000000000000 None -User bd0b55bb-3a57-442a-b2f6-78c95c10ef86 Read -``` - -This command modifies the catalog ACE for Patti Fuller to have read permissions. - -### Example 2: Modify user Permissions for a database -```powershell -PS C:\> Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" -User -ObjectId (Get-AzureRmADUser -Mail "PattiFuller@contoso.com").Id -ItemType Database -Path "databaseName" -Permissions Read - -Type Id Permissions ----- -- ----------- -User 90a6f74b-fd73-490e-900a-c4f0f9694d02 Read -Group 902b155a-5601-4ca8-8178-ad3289211f88 ReadWrite -Other 00000000-0000-0000-0000-000000000000 None -User bd0b55bb-3a57-442a-b2f6-78c95c10ef86 Read -``` - -This command modifies the database ACE for Patti Fuller to have read permissions. - -### Example 3: Modify other permissions for a catalog -```powershell -PS C:\> Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" -Other -Permissions Read - -Type Id Permissions ----- -- ----------- -User 90a6f74b-fd73-490e-900a-c4f0f9694d02 Read -Group 902b155a-5601-4ca8-8178-ad3289211f88 ReadWrite -Other 00000000-0000-0000-0000-000000000000 Read -User bd0b55bb-3a57-442a-b2f6-78c95c10ef86 Read -``` - -This command modifies the catalog ACE for other to have read permissions. - -### Example 4: Modify other Permissions for a database -```powershell -PS C:\> Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" -Other -ItemType Database -Path "databaseName" -Permissions Read - -Type Id Permissions ----- -- ----------- -User 90a6f74b-fd73-490e-900a-c4f0f9694d02 Read -Group 902b155a-5601-4ca8-8178-ad3289211f88 ReadWrite -Other 00000000-0000-0000-0000-000000000000 Read -User bd0b55bb-3a57-442a-b2f6-78c95c10ef86 Read -``` - -### Example 5: Modify user owner permissions for a catalog -```powershell -PS C:\> Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" -UserOwner -Permissions Read - -Type Id Permissions ----- -- ----------- -UserOwner 0316ac75-6703-4ace-984f-a4dd79aeeafc Read -``` - -This command sets the owner permission for the account to Read. - -### Example 6: Modify user owner Permissions for a database -```powershell -PS C:\> Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry -Account "contosoadla" -UserOwner -ItemType Database -Path "databaseName" -Permissions Read - -Type Id Permissions ----- -- ----------- -GroupOwner 0316ac75-6703-4ace-984f-a4dd79aeeafc Read -``` - -This command sets the owner permission for the database to Read. - -## PARAMETERS - -### -Account -Specifies the Data Lake Analytics account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group -Set ACL entry of catalog for group. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: SetCatalogAclEntryForGroup, SetCatalogItemAclEntryForGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupOwner -Set ACL entry of catalog for group owner. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: SetCatalogAclEntryForGroupOwner, SetCatalogItemAclEntryForGroupOwner -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ItemType -Specifies the type of the catalog or catalog item(s). The acceptable values for this parameter are: -- Catalog -- Database - -```yaml -Type: System.String -Parameter Sets: SetCatalogItemAclEntryForUser, SetCatalogItemAclEntryForGroup, SetCatalogItemAclEntryForOther, SetCatalogItemAclEntryForUserOwner, SetCatalogItemAclEntryForGroupOwner -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ObjectId -The identity of the user to set. - -```yaml -Type: System.Guid -Parameter Sets: SetCatalogAclEntryForUser, SetCatalogItemAclEntryForUser, SetCatalogAclEntryForGroup, SetCatalogItemAclEntryForGroup -Aliases: Id, UserId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Other -Set ACL entry of catalog for other. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: SetCatalogAclEntryForOther, SetCatalogItemAclEntryForOther -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the Data Lake Analytics path of an catalog or catalog item. -The parts of the path should be separated by a period (.). - -```yaml -Type: Microsoft.Azure.Commands.DataLakeAnalytics.Models.CatalogPathInstance -Parameter Sets: SetCatalogItemAclEntryForUser, SetCatalogItemAclEntryForGroup, SetCatalogItemAclEntryForOther, SetCatalogItemAclEntryForUserOwner, SetCatalogItemAclEntryForGroupOwner -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Permissions -Specifies the permissions for the ACE. -The acceptable values for this parameter are: -- None -- Read -- ReadWrite - -```yaml -Type: Microsoft.Azure.Commands.DataLakeAnalytics.Models.DataLakeAnalyticsEnums+PermissionType -Parameter Sets: (All) -Aliases: -Accepted values: None, Read, ReadWrite - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -User -Set ACL entry of catalog for user. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: SetCatalogAclEntryForUser, SetCatalogItemAclEntryForUser -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserOwner -Set ACL entry of catalog for user owner. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: SetCatalogAclEntryForUserOwner, SetCatalogItemAclEntryForUserOwner -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Guid - -### Microsoft.Azure.Commands.DataLakeAnalytics.Models.CatalogPathInstance - -### Microsoft.Azure.Commands.DataLakeAnalytics.Models.DataLakeAnalyticsEnums+PermissionType - -## OUTPUTS - -### Microsoft.Azure.Commands.DataLakeAnalytics.Models.PSDataLakeAnalyticsAcl - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDataLakeAnalyticsCatalogItemAclEntry](Get-AzureRmDataLakeAnalyticsCatalogItemAclEntry.md) - -[Remove-AzureRmDataLakeAnalyticsCatalogItemAclEntry](Remove-AzureRmDataLakeAnalyticsCatalogItemAclEntry.md) - -[U-SQL now offers database level access control](https://github.com/Azure/AzureDataLake/blob/master/docs/Release_Notes/2016/2016_08_01/USQL_Release_Notes_2016_08_01.md#u-sql-now-offers-database-level-access-control) diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Set-AzureRmDataLakeAnalyticsCatalogSecret.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Set-AzureRmDataLakeAnalyticsCatalogSecret.md deleted file mode 100644 index 9cf5a7d304..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Set-AzureRmDataLakeAnalyticsCatalogSecret.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeAnalytics.dll-Help.xml -Module Name: AzureRM.DataLakeAnalytics -ms.assetid: CAB32C72-5C16-467E-BC57-749EC49916BB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics/set-azurermdatalakeanalyticscatalogsecret -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Set-AzureRmDataLakeAnalyticsCatalogSecret.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Set-AzureRmDataLakeAnalyticsCatalogSecret.md ---- - -# Set-AzureRmDataLakeAnalyticsCatalogSecret - -## SYNOPSIS -Modifies a Data Lake Analytics catalog secret. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByFullUri -``` -Set-AzureRmDataLakeAnalyticsCatalogSecret [-Account] <String> [-DatabaseName] <String> [-Secret] <PSCredential> - [-DatabaseHost] <String> [-Port] <Int32> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByHostNameAndPort -``` -Set-AzureRmDataLakeAnalyticsCatalogSecret [-Account] <String> [-DatabaseName] <String> [-Secret] <PSCredential> - [-Uri] <Uri> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDataLakeAnalyticsCatalogSecret** cmdlet modifies a secret associated with an Azure Data Lake Analytics catalog. - -## EXAMPLES - -### Example 1: Modify the secret associated with an account -``` -PS C:\>Set-AzureRmDataLakeAnalyticsCatalogSecret -Account "ContosoAdlAccount" -DatabaseName "databaseName" -Secret (Get-Credential) -Host "https://example.contoso.com" -Port 8080 -``` - -This command sets the secret associated with a Data Lake Analytics catalog. - -## PARAMETERS - -### -Account -Specifies the Data Lake Analytics account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseHost -Specifies the host name for the database the secret is associated with in the format 'mydatabase.contoso.com'. - -```yaml -Type: System.String -Parameter Sets: SetByFullUri -Aliases: Host - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the database holding the secret. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Port -Specifies the port number of the secret. - -```yaml -Type: System.Int32 -Parameter Sets: SetByFullUri -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Secret -Specifies the name and password of the secret. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Uri -Specifies the Uniform Resource Identifier (URI) for the secret. - -```yaml -Type: System.Uri -Parameter Sets: SetByHostNameAndPort -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.PSCredential - -### System.Uri - -### System.Int32 - -## OUTPUTS - -### Microsoft.Azure.Management.DataLake.Analytics.Models.USqlSecret - -## NOTES - -## RELATED LINKS - -[New-AzureRmDataLakeAnalyticsCatalogSecret](./New-AzureRmDataLakeAnalyticsCatalogSecret.md) - -[Remove-AzureRmDataLakeAnalyticsCatalogSecret](./Remove-AzureRmDataLakeAnalyticsCatalogSecret.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Set-AzureRmDataLakeAnalyticsDataSource.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Set-AzureRmDataLakeAnalyticsDataSource.md deleted file mode 100644 index 8501f91f18..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Set-AzureRmDataLakeAnalyticsDataSource.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeAnalytics.dll-Help.xml -Module Name: AzureRM.DataLakeAnalytics -ms.assetid: 2F28118E-6A34-4261-85BD-8CFDDC8A2707 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics/set-azurermdatalakeanalyticsdatasource -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Set-AzureRmDataLakeAnalyticsDataSource.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Set-AzureRmDataLakeAnalyticsDataSource.md ---- - -# Set-AzureRmDataLakeAnalyticsDataSource - -## SYNOPSIS -Modifies the details of a data source of a Data Lake Analytics account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmDataLakeAnalyticsDataSource [-Account] <String> [-Blob] <String> [-AccessKey] <String> - [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDataLakeAnalyticsDataSource** cmdlet modifies the details of a data source of an Azure Data Lake Analytics account. - -## EXAMPLES - -### Example 1: Change the access key for a data source -``` -PS C:\>Set-AzureRmDataLakeAnalyticsDataSource -Account "ContosoAdlAccount" -Blob "contosowasb" -AccessKey "...newaccesskey..." -``` - -This command changes the access key stored for an Azure Blob Storage data source. - -## PARAMETERS - -### -AccessKey -Specifies the new access key of the Azure Blob Storage data source. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Account -Specifies the Data Lake Analytics account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Blob -Specifies the name of the Azure Blob Storage data source. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AzureBlob - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group name of the Data Lake Analytics account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Add-AzureRmDataLakeAnalyticsDataSource](./Add-AzureRmDataLakeAnalyticsDataSource.md) - -[Remove-AzureRmDataLakeAnalyticsDataSource](./Remove-AzureRmDataLakeAnalyticsDataSource.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Set-AzureRmDataLakeAnalyticsFirewallRule.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Set-AzureRmDataLakeAnalyticsFirewallRule.md deleted file mode 100644 index 4c0d2d5737..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Set-AzureRmDataLakeAnalyticsFirewallRule.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeAnalytics.dll-Help.xml -Module Name: AzureRM.DataLakeAnalytics -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics/set-azurermdatalakeanalyticsfirewallrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Set-AzureRmDataLakeAnalyticsFirewallRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Set-AzureRmDataLakeAnalyticsFirewallRule.md ---- - -# Set-AzureRmDataLakeAnalyticsFirewallRule - -## SYNOPSIS -Updates a firewall rule in a Data Lake Analytics account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmDataLakeAnalyticsFirewallRule [-Account] <String> [-Name] <String> [[-StartIpAddress] <String>] - [[-EndIpAddress] <String>] [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDataLakeAnalyticsFirewallRule** cmdlet updates a firewall rule in an Azure Data Lake Analytics account. - -## EXAMPLES - -### Example 1: Update a firewall rule -``` -PS C:\>Set-AzureRmDataLakeAnalyticsFirewallRule -Account "ContosoAdlAcct" -Name "My firewall rule" -StartIpAddress 127.0.0.1 -EndIpAddress 127.0.0.10 -``` - -This command updates the firewall rule named "my firewall rule" in account "ContosoAdlAcct" to have the new IP range: 127.0.0.1 - 127.0.0.10 - -## PARAMETERS - -### -Account -The Data Lake Analytics account to update the firewall rule in - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndIpAddress -The end of the valid ip range for the firewall rule - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The name of the firewall rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of resource group under which want to retrieve the account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartIpAddress -The start of the valid ip range for the firewall rule - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataLakeAnalytics.Models.DataLakeAnalyticsFirewallRule - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Stop-AzureRmDataLakeAnalyticsJob.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Stop-AzureRmDataLakeAnalyticsJob.md deleted file mode 100644 index c8c9c126d4..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Stop-AzureRmDataLakeAnalyticsJob.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeAnalytics.dll-Help.xml -Module Name: AzureRM.DataLakeAnalytics -ms.assetid: 5EB9E134-C789-47A5-9AF8-CD4A475559C2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics/stop-azurermdatalakeanalyticsjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Stop-AzureRmDataLakeAnalyticsJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Stop-AzureRmDataLakeAnalyticsJob.md ---- - -# Stop-AzureRmDataLakeAnalyticsJob - -## SYNOPSIS -Cancels a job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Stop-AzureRmDataLakeAnalyticsJob [-Account] <String> [-JobId] <Guid> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Stop-AzureRmDataLakeAnalyticsJob** cmdlet cancels an Azure Data Lake Analytics job. - -## EXAMPLES - -### Example 1: Cancel a job -``` -PS C:\>Stop-AzureRmDataLakeAnalyticsJob -Account "ContosoAdlAccout" -JobId "a0a78d72-3fa8-4564-9b18-6becb3fda48a" -``` - -This command cancels the job with the specified ID. - -## PARAMETERS - -### -Account -Specifies the Data Lake Analytics account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -JobId -Specifies the ID of the job to cancel. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Guid - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDataLakeAnalyticsJob](./Get-AzureRmDataLakeAnalyticsJob.md) - -[Submit-AzureRmDataLakeAnalyticsJob](./Submit-AzureRmDataLakeAnalyticsJob.md) - -[Wait-AzureRmDataLakeAnalyticsJob](./Wait-AzureRmDataLakeAnalyticsJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Submit-AzureRmDataLakeAnalyticsJob.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Submit-AzureRmDataLakeAnalyticsJob.md deleted file mode 100644 index 946eda0612..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Submit-AzureRmDataLakeAnalyticsJob.md +++ /dev/null @@ -1,389 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeAnalytics.dll-Help.xml -Module Name: AzureRM.DataLakeAnalytics -ms.assetid: 0DB9595A-6C8B-4F3F-A707-2DB41D7C7470 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics/submit-azurermdatalakeanalyticsjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Submit-AzureRmDataLakeAnalyticsJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Submit-AzureRmDataLakeAnalyticsJob.md ---- - -# Submit-AzureRmDataLakeAnalyticsJob - -## SYNOPSIS -Submits a job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SubmitUSqlJobWithScriptPath -``` -Submit-AzureRmDataLakeAnalyticsJob [-Account] <String> [-Name] <String> [-ScriptPath] <String> - [[-Runtime] <String>] [[-CompileMode] <String>] [-CompileOnly] [[-AnalyticsUnits] <Int32>] - [[-Priority] <Int32>] [-ScriptParameter <IDictionary>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### SubmitUSqlJob -``` -Submit-AzureRmDataLakeAnalyticsJob [-Account] <String> [-Name] <String> [-Script] <String> - [[-Runtime] <String>] [[-CompileMode] <String>] [-CompileOnly] [[-AnalyticsUnits] <Int32>] - [[-Priority] <Int32>] [-ScriptParameter <IDictionary>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### SubmitUSqlJobWithScriptPathAndRecurrence -``` -Submit-AzureRmDataLakeAnalyticsJob [-Account] <String> [-Name] <String> [-ScriptPath] <String> - [[-Runtime] <String>] [[-CompileMode] <String>] [-CompileOnly] [[-AnalyticsUnits] <Int32>] - [[-Priority] <Int32>] [-ScriptParameter <IDictionary>] -RecurrenceId <Guid> [-RecurrenceName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SubmitUSqlJobWithRecurrence -``` -Submit-AzureRmDataLakeAnalyticsJob [-Account] <String> [-Name] <String> [-Script] <String> - [[-Runtime] <String>] [[-CompileMode] <String>] [-CompileOnly] [[-AnalyticsUnits] <Int32>] - [[-Priority] <Int32>] [-ScriptParameter <IDictionary>] -RecurrenceId <Guid> [-RecurrenceName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SubmitUSqlJobWithScriptPathAndPipeline -``` -Submit-AzureRmDataLakeAnalyticsJob [-Account] <String> [-Name] <String> [-ScriptPath] <String> - [[-Runtime] <String>] [[-CompileMode] <String>] [-CompileOnly] [[-AnalyticsUnits] <Int32>] - [[-Priority] <Int32>] [-ScriptParameter <IDictionary>] -RecurrenceId <Guid> [-RecurrenceName <String>] - -PipelineId <Guid> [-PipelineName <String>] [-PipelineUri <String>] [-RunId <Guid>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SubmitUSqlJobWithPipeline -``` -Submit-AzureRmDataLakeAnalyticsJob [-Account] <String> [-Name] <String> [-Script] <String> - [[-Runtime] <String>] [[-CompileMode] <String>] [-CompileOnly] [[-AnalyticsUnits] <Int32>] - [[-Priority] <Int32>] [-ScriptParameter <IDictionary>] -RecurrenceId <Guid> [-RecurrenceName <String>] - -PipelineId <Guid> [-PipelineName <String>] [-PipelineUri <String>] [-RunId <Guid>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Submit-AzureRmDataLakeAnalyticsJob** cmdlet submits an Azure Data Lake Analytics job. - -## EXAMPLES - -### Example 1: Submit a job -``` -PS C:\>Submit-AzureRmDataLakeAnalyticsJob -Account "ContosoAdlAccount" -Name "New Job" -ScriptPath $LocalScriptPath -AnalyticsUnits 32 -``` - -This command submits a Data Lake Analytics job. - -### Example 2: Submit a job with script parameters -``` -PS C:\>$parameters = [ordered]@{} -$parameters["Department"] = "Sales" -$parameters["NumRecords"] = 1000 -$parameters["StartDateTime"] = (Get-Date).AddDays(-14) -Submit-AzureRmDataLakeAnalyticsJob -Account "ContosoAdlAccount" -Name "New Job" -ScriptPath $LocalScriptPath -AnalyticsUnits 32 -ScriptParameter $parameters -``` - -U-SQL script parameters are prepended above the main script contents, e.g.: -DECLARE @Department string = "Sales"; -DECLARE @NumRecords int = 1000; -DECLARE @StartDateTime DateTime = new DateTime(2017, 12, 6, 0, 0, 0, 0); - -## PARAMETERS - -### -Account -Name of Data Lake Analytics account under which the job will be submitted. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AnalyticsUnits -The analytics units to use for this job. Typically, more analytics units dedicated to a script results in faster script execution time. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: DegreeOfParallelism - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CompileMode -The type of compilation to be done on this job. -Valid values: -- Semantic (Only performs semantic checks and necessary sanity checks) -- Full (Full compilation) -- SingleBox (Full compilation performed locally) - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Semantic, Full, SingleBox - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CompileOnly -Indicates that the submission should only build the job and not execute if set to true. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The friendly name of the job to submit. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PipelineId -An ID that indicates the submission of this job is a part of a set of recurring jobs and also associated with a job pipeline. - -```yaml -Type: System.Guid -Parameter Sets: SubmitUSqlJobWithScriptPathAndPipeline, SubmitUSqlJobWithPipeline -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PipelineName -An optional friendly name for the pipeline associated with this job. - -```yaml -Type: System.String -Parameter Sets: SubmitUSqlJobWithScriptPathAndPipeline, SubmitUSqlJobWithPipeline -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PipelineUri -An optional uri that links to the originating service associated with this pipeline. - -```yaml -Type: System.String -Parameter Sets: SubmitUSqlJobWithScriptPathAndPipeline, SubmitUSqlJobWithPipeline -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Priority -The priority of the job. If not specified, the priority is 1000. A lower number indicates a higher job priority. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RecurrenceId -An ID that indicates the submission of this job is a part of a set of recurring jobs with the same recurrence ID. - -```yaml -Type: System.Guid -Parameter Sets: SubmitUSqlJobWithScriptPathAndRecurrence, SubmitUSqlJobWithRecurrence, SubmitUSqlJobWithScriptPathAndPipeline, SubmitUSqlJobWithPipeline -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RecurrenceName -An optional friendly name for the recurrence correlation between jobs. - -```yaml -Type: System.String -Parameter Sets: SubmitUSqlJobWithScriptPathAndRecurrence, SubmitUSqlJobWithRecurrence, SubmitUSqlJobWithScriptPathAndPipeline, SubmitUSqlJobWithPipeline -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RunId -An ID that identifies this specific run iteration of the pipeline. - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: SubmitUSqlJobWithScriptPathAndPipeline, SubmitUSqlJobWithPipeline -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Runtime -Optionally set the version of the runtime to use for the job. If left unset, the default runtime is used. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Script -Script to execute (written inline). - -```yaml -Type: System.String -Parameter Sets: SubmitUSqlJob, SubmitUSqlJobWithRecurrence, SubmitUSqlJobWithPipeline -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ScriptParameter -The script parameters for this job, as a dictionary of parameter names (string) to values (any combination of byte, sbyte, int, uint (or uint32), long, ulong (or uint64), float, double, decimal, short (or int16), ushort (or uint16), char, string, DateTime, bool, Guid, or byte[]). - -```yaml -Type: System.Collections.IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScriptPath -Path to the script file to submit. - -```yaml -Type: System.String -Parameter Sets: SubmitUSqlJobWithScriptPath, SubmitUSqlJobWithScriptPathAndRecurrence, SubmitUSqlJobWithScriptPathAndPipeline -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -### System.Int32 - -### System.Collections.IDictionary - -### System.Guid - -### System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Management.DataLake.Analytics.Models.JobInformation - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDataLakeAnalyticsJob](./Get-AzureRmDataLakeAnalyticsJob.md) - -[Stop-AzureRmDataLakeAnalyticsJob](./Stop-AzureRmDataLakeAnalyticsJob.md) - -[Wait-AzureRmDataLakeAnalyticsJob](./Wait-AzureRmDataLakeAnalyticsJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Test-AzureRmDataLakeAnalyticsAccount.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Test-AzureRmDataLakeAnalyticsAccount.md deleted file mode 100644 index 88d4fd7b72..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Test-AzureRmDataLakeAnalyticsAccount.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeAnalytics.dll-Help.xml -Module Name: AzureRM.DataLakeAnalytics -ms.assetid: 0B52890D-102F-4C3C-9EF9-017F6ECA3E26 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics/test-azurermdatalakeanalyticsaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Test-AzureRmDataLakeAnalyticsAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Test-AzureRmDataLakeAnalyticsAccount.md ---- - -# Test-AzureRmDataLakeAnalyticsAccount - -## SYNOPSIS -Checks for the existence of a Data Lake Analytics account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Test-AzureRmDataLakeAnalyticsAccount [-Name] <String> [[-ResourceGroupName] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Test-AzureRmDataLakeAnalyticsAccount** cmdlet checks for the existence of a Data Lake Analytics account. - -## EXAMPLES - -### Example 1: Test whether an account exists -``` -PS C:\>Test-AzureRmDataLakeAnalyticsAccount -Name "ContosoAdlAccount" -``` - -This command tests whether the account named ContosoAdlAccount exists. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the Data Lake Analytics account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group name of the Data Lake Analytics account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDataLakeAnalyticsAccount](./Get-AzureRmDataLakeAnalyticsAccount.md) - -[New-AzureRmDataLakeAnalyticsAccount](./New-AzureRmDataLakeAnalyticsAccount.md) - -[Set-AzureRmDataLakeAnalyticsAccount](./Set-AzureRmDataLakeAnalyticsAccount.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Test-AzureRmDataLakeAnalyticsCatalogItem.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Test-AzureRmDataLakeAnalyticsCatalogItem.md deleted file mode 100644 index 64675b19be..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Test-AzureRmDataLakeAnalyticsCatalogItem.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeAnalytics.dll-Help.xml -Module Name: AzureRM.DataLakeAnalytics -ms.assetid: ED17430D-4DAF-4B9E-937D-0F8A843DAB96 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics/test-azurermdatalakeanalyticscatalogitem -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Test-AzureRmDataLakeAnalyticsCatalogItem.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Test-AzureRmDataLakeAnalyticsCatalogItem.md ---- - -# Test-AzureRmDataLakeAnalyticsCatalogItem - -## SYNOPSIS -Checks for the existence of a catalog item. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Test-AzureRmDataLakeAnalyticsCatalogItem [-Account] <String> [-ItemType] <CatalogItemType> - [-Path] <CatalogPathInstance> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Test-AzureRmDataLakeAnalyticsCatalogItem** cmdlet checks for the existence of an Azure Data Lake Analytics catalog item. - -## EXAMPLES - -### Example 1: Test whether a catalog item exists -``` -PS C:\>Test-AzureRmDataLakeAnalyticsCatalogItem -Account "ContosoAdlAccount" -ItemType Schema -Path "databaseName.schemaName" -``` - -This command tests whether a specified Schema item exists. - -## PARAMETERS - -### -Account -Specifies the Data Lake Analytics account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ItemType -Specifies the catalog item type of the item to check. -The acceptable values for this parameter are: -- Database -- Schema -- Assembly -- Table -- TablePartition -- TableValuedFunction -- TableStatistics -- ExternalDataSource -- View -- Procedure -- Secret -- Credential -- Types - -```yaml -Type: Microsoft.Azure.Commands.DataLakeAnalytics.Models.DataLakeAnalyticsEnums+CatalogItemType -Parameter Sets: (All) -Aliases: -Accepted values: Database, Schema, Assembly, Table, TablePartition, TableValuedFunction, TableStatistics, ExternalDataSource, View, Procedure, Secret, Credential, Types, Package - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the path to the item to fetch, or the path to the parent item of the items to list. - -```yaml -Type: Microsoft.Azure.Commands.DataLakeAnalytics.Models.CatalogPathInstance -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataLakeAnalytics.Models.DataLakeAnalyticsEnums+CatalogItemType - -### Microsoft.Azure.Commands.DataLakeAnalytics.Models.CatalogPathInstance - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDataLakeAnalyticsCatalogItem](./Get-AzureRmDataLakeAnalyticsCatalogItem.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Update-AzureRmDataLakeAnalyticsComputePolicy.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Update-AzureRmDataLakeAnalyticsComputePolicy.md deleted file mode 100644 index 4e7f8849e0..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Update-AzureRmDataLakeAnalyticsComputePolicy.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeAnalytics.dll-Help.xml -Module Name: AzureRM.DataLakeAnalytics -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics/update-azurermdatalakeanalyticscomputepolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Update-AzureRmDataLakeAnalyticsComputePolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Update-AzureRmDataLakeAnalyticsComputePolicy.md ---- - -# Update-AzureRmDataLakeAnalyticsComputePolicy - -## SYNOPSIS -Updates a Data Lake Analytics compute policy rule for a specific AAD entity. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Update-AzureRmDataLakeAnalyticsComputePolicy [-ResourceGroupName <String>] [-Account] <String> [-Name] <String> - [-MaxAnalyticsUnitsPerJob <Int32>] [-MinPriorityPerJob <Int32>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureRmDataLakeAnalyticsComputePolicy** updates the specified compute policy rule for a specific AAD entity in an Azure Data Lake Analytics account. - -## EXAMPLES - -### Example 1: update one rule in a compute policy -``` -PS C:\>Update-AzureRmDataLakeAnalyticsComputePolicy -Account "contosoadla" -Name "myPolicy" -MaxAnalyticsUnitsPerJob 5 -``` - -This command updates a policy called "myPolicy" in account "contosoadla" to ensure the user cannot submit any job with more than 5 analytics units. - -### Example 2: Create a compute policy with both rules update -``` -PS C:\>Update-AzureRmDataLakeAnalyticsComputePolicy -Account "contosoadla" -Name "myPolicy" -MaxAnalyticsUnitsPerJob 5 -MinPriorityPerJob 100 -``` - -This command creates a policy called "myPolicy" in account "contosoadla" to ensure the user cannot submit any job with more than 5 analytics units or with a priority lower than 100 - -## PARAMETERS - -### -Account -Name of the account to update the compute policy in. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxAnalyticsUnitsPerJob -The maximum supported analytics units per job for this policy. Either this, MinPriorityPerJob, or both parameters must be specified. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: MaxDegreeOfParallelismPerJob - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MinPriorityPerJob -The minimum supported priority per job for this policy. Either this, MaxAnalyticsUnitsPerJob, or both parameters must be specified. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Name of the compute policy to update. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ComputePolicyName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of resource group under which you the account exists. -Optional and will attempt to discover if not provided. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.DataLakeAnalytics.Models.PSDataLakeAnalyticsComputePolicy - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Wait-AzureRmDataLakeAnalyticsJob.md b/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Wait-AzureRmDataLakeAnalyticsJob.md deleted file mode 100644 index 4a7078275e..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeAnalytics/Wait-AzureRmDataLakeAnalyticsJob.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeAnalytics.dll-Help.xml -Module Name: AzureRM.DataLakeAnalytics -ms.assetid: CE7B54BC-C493-49CE-93BD-346ED0B966A1 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakeanalytics/wait-azurermdatalakeanalyticsjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Wait-AzureRmDataLakeAnalyticsJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeAnalytics/Commands.DataLakeAnalytics/help/Wait-AzureRmDataLakeAnalyticsJob.md ---- - -# Wait-AzureRmDataLakeAnalyticsJob - -## SYNOPSIS -Waits for a job to complete. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Wait-AzureRmDataLakeAnalyticsJob [-Account] <String> [-JobId] <Guid> [[-WaitIntervalInSeconds] <Int32>] - [[-TimeoutInSeconds] <Int32>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Wait-AzureRmDataLakeAnalyticsJob** cmdlet waits for an Azure Data Lake Analytics job to complete. - -## EXAMPLES - -### Example 1: Wait for a job to complete -``` -PS C:\>Wait-AzureRmDataLakeAnalyticsJob -Account "ContosoAdlAccount" -JobId "a0a78d72-3fa8-4564-9b18-6becb3fda48a" -``` - -The following command waits for the job with the specified ID to complete. - -## PARAMETERS - -### -Account -Specifies the Data Lake Analytics account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobId -Specifies the ID of the job for which to wait. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -TimeoutInSeconds -Specifies the number of seconds to wait before exiting the wait operation. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WaitIntervalInSeconds -Specify the number of seconds that elapse between each check of the job state. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Guid - -### System.Int32 - -## OUTPUTS - -### Microsoft.Azure.Management.DataLake.Analytics.Models.JobInformation - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDataLakeAnalyticsJob](./Get-AzureRmDataLakeAnalyticsJob.md) - -[Stop-AzureRmDataLakeAnalyticsJob](./Stop-AzureRmDataLakeAnalyticsJob.md) - -[Submit-AzureRmDataLakeAnalyticsJob](./Submit-AzureRmDataLakeAnalyticsJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Add-AzureRmDataLakeStoreFirewallRule.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Add-AzureRmDataLakeStoreFirewallRule.md deleted file mode 100644 index c84f40dbfe..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Add-AzureRmDataLakeStoreFirewallRule.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -ms.assetid: C6FD4734-720C-4C8C-9B58-EDB331DD6415 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/add-azurermdatalakestorefirewallrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Add-AzureRmDataLakeStoreFirewallRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Add-AzureRmDataLakeStoreFirewallRule.md ---- - -# Add-AzureRmDataLakeStoreFirewallRule - -## SYNOPSIS -Adds a firewall rule to the specified Data Lake Store account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmDataLakeStoreFirewallRule [-Account] <String> [-Name] <String> [-StartIpAddress] <String> - [-EndIpAddress] <String> [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmDataLakeStoreFirewallRule** cmdlet adds a firewall rule to the specified Data Lake Store account. - -## EXAMPLES - -### Example 1: Add a new firewall rule to a Data Lake Store account -``` -PS C:\> Add-AzureRmDataLakeStoreFirewallRule -AccountName "ContosoADL" -Name MyRule -StartIpAddress "127.0.0.1" -EndIpAddress "127.0.0.2" -``` - -This creates a new firewall rule called "MyRule" in account "ContosoADL" with an IP range of 127.0.0.1 - 127.0.0.2 - -## PARAMETERS - -### -Account -The Data Lake Store account to add the firewall rule to - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndIpAddress -The end of the valid ip range for the firewall rule - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The name of the firewall rule to add. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of resource group under which the account to add the firewall rule is. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartIpAddress -The start of the valid ip range for the firewall rule - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreFirewallRule - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Add-AzureRmDataLakeStoreItemContent.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Add-AzureRmDataLakeStoreItemContent.md deleted file mode 100644 index 6f4c0b4253..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Add-AzureRmDataLakeStoreItemContent.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -ms.assetid: B008028D-27FC-4469-BE71-54F7218C068B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/add-azurermdatalakestoreitemcontent -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Add-AzureRmDataLakeStoreItemContent.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Add-AzureRmDataLakeStoreItemContent.md ---- - -# Add-AzureRmDataLakeStoreItemContent - -## SYNOPSIS -Adds content to an item in a Data Lake Store. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmDataLakeStoreItemContent [-Account] <String> [-Path] <DataLakeStorePathInstance> [-Value] <Object> - [[-Encoding] <FileSystemCmdletProviderEncoding>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmDataLakeStoreItemContent** cmdlet adds content to an item in an Azure Data Lake Store. - -## EXAMPLES - -### Example 1: Add content to a file -``` -PS C:\>Add-AzureRmDataLakeStoreItemContent -AccountName "ContosoADLS" -Path /abc/myFile.txt -Value "My content here" -``` - -This command adds content to the file myFile.txt. - -## PARAMETERS - -### -Account -Specifies the name of the Data Lake Store account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Encoding -Specifies the encoding for the item to create. -The acceptable values for this parameter are: -- Unknown -- String -- Unicode -- Byte -- BigEndianUnicode -- UTF8 -- UTF7 -- Ascii -- Default -- Oem -- BigEndianUTF32 - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.FileSystemCmdletProviderEncoding -Parameter Sets: (All) -Aliases: -Accepted values: Unknown, String, Unicode, Byte, BigEndianUnicode, UTF8, UTF7, UTF32, Ascii, Default, Oem, BigEndianUTF32 - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the Data Lake Store path of the item to modify, starting with the root directory (/). - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Value -Specifies the content to add to the item. - -```yaml -Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance - -### System.Object - -### Microsoft.Azure.Commands.DataLakeStore.Models.FileSystemCmdletProviderEncoding - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDataLakeStoreItemContent](./Get-AzureRmDataLakeStoreItemContent.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Add-AzureRmDataLakeStoreTrustedIdProvider.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Add-AzureRmDataLakeStoreTrustedIdProvider.md deleted file mode 100644 index 9d7df22c86..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Add-AzureRmDataLakeStoreTrustedIdProvider.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -ms.assetid: 5C788778-58A4-4798-AB66-1D3562BB9338 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/add-azurermdatalakestoretrustedidprovider -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Add-AzureRmDataLakeStoreTrustedIdProvider.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Add-AzureRmDataLakeStoreTrustedIdProvider.md ---- - -# Add-AzureRmDataLakeStoreTrustedIdProvider - -## SYNOPSIS -Adds a trusted identity provider to the specified Data Lake Store account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmDataLakeStoreTrustedIdProvider [-Account] <String> [-Name] <String> [-ProviderEndpoint] <String> - [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmDataLakeStoreTrustedIdProvider** cmdlet adds a trusted identity provider to the specified Data Lake Store account. - -## EXAMPLES - -### Example 1: Add a trusted identity provider -``` -PS C:\> Add-AzureRmDataLakeStoreTrustedIdProvider -AccountName "ContosoADL" -Name MyProvider -ProviderEndpoint "https://sts.windows.net/6b04908c-b91f-40ce-8024-7ee8a4fd6150" -``` - -Adds the provider "MyProvider" to account "ContosoADL" with the provider endpoint "https://sts.windows.net/6b04908c-b91f-40ce-8024-7ee8a4fd6150" - -## PARAMETERS - -### -Account -The name of the Data Lake Store account to add the specified trusted identity provider to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the trusted identity provider to add - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProviderEndpoint -The valid trusted provider endpoint in the format: https://sts.windows.net/\<provider identity\>" - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of resource group under which the account to add the trusted identity provider is. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreTrustedIdProvider - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Add-AzureRmDataLakeStoreVirtualNetworkRule.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Add-AzureRmDataLakeStoreVirtualNetworkRule.md deleted file mode 100644 index 893d73ef66..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Add-AzureRmDataLakeStoreVirtualNetworkRule.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/add-azurermdatalakestorevirtualnetworkrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Add-AzureRmDataLakeStoreVirtualNetworkRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Add-AzureRmDataLakeStoreVirtualNetworkRule.md ---- - -# Add-AzureRmDataLakeStoreVirtualNetworkRule - -## SYNOPSIS -Adds a virtual network rule to the specified Data Lake Store account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmDataLakeStoreVirtualNetworkRule [-Account] <String> [-Name] <String> [-SubnetId] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmDataLakeStoreVirtualNetworkRule** cmdlet adds a virtual network rule to the specified Data Lake Store account. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Add-AzureRmDataLakeStoreVirtualNetworkRule -Account "dls" -Name "myVNET" -SubnetId "testId" - -ResourceGroupName : -AccountName : -VirtualNetworkRuleName : myVNET -VirtualNetworkSubnetId : /subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.Network/virtualNetworks/myVNET/subnets/testId -IgnoreMissingVnetServiceEndpoint : -State : -``` - -This creates a new virtual network rule called "myVNET" in account "dls" with a subnet id "testId" - -## PARAMETERS - -### -Account -The Data Lake Store account to add the virtual network rule to - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the virtual network rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubnetId -The subnetId of the virtual network rule - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreVirtualNetworkRule - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/AzureRM.DataLakeStore.md b/azurermps-6.13.0/AzureRM.DataLakeStore/AzureRM.DataLakeStore.md deleted file mode 100644 index 0aa3ac8b3d..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/AzureRM.DataLakeStore.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -Module Name: AzureRM.DataLakeStore -Module Guid: 90dfd814-abce-4e1f-99b6-fe16760c079a -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore -Help Version: 1.0.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/AzureRM.DataLakeStore.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/AzureRM.DataLakeStore.md ---- - -# AzureRM.DataLakeStore Module -## Description -The topics in this section document the Azure PowerShell cmdlets for Azure Data Lake Store in the Azure Resource Manager (ARM) framework. The cmdlets exist in the Microsoft.Azure.Commands.DataLakeStore namespace. These cmdlets work only with Azure Data Lake Storage Gen1 accounts. - -## AzureRM.DataLakeStore Cmdlets -### [Add-AzureRmDataLakeStoreFirewallRule](Add-AzureRmDataLakeStoreFirewallRule.md) -Adds a firewall rule to the specified Data Lake Store account. - -### [Add-AzureRmDataLakeStoreItemContent](Add-AzureRmDataLakeStoreItemContent.md) -Adds content to an item in a Data Lake Store. - -### [Add-AzureRmDataLakeStoreTrustedIdProvider](Add-AzureRmDataLakeStoreTrustedIdProvider.md) -Adds a trusted identity provider to the specified Data Lake Store account. - -### [Add-AzureRmDataLakeStoreVirtualNetworkRule](Add-AzureRmDataLakeStoreVirtualNetworkRule.md) -Adds a virtual network rule to the specified Data Lake Store account. - -### [Enable-AzureRmDataLakeStoreKeyVault](Enable-AzureRmDataLakeStoreKeyVault.md) -Attempts to enable a user managed Key Vault for encryption of the specified Data Lake Store account. - -### [Export-AzureRmDataLakeStoreChildItemProperties](Export-AzureRmDataLakeStoreChildItemProperties.md) -Exports the properties (Disk usage and Acl) for the entire tree from the specified path to a ouput path - -### [Export-AzureRmDataLakeStoreItem](Export-AzureRmDataLakeStoreItem.md) -Downloads a file from Data Lake Store. - -### [Get-AzureRmDataLakeStoreAccount](Get-AzureRmDataLakeStoreAccount.md) -Gets details of a Data Lake Store account. - -### [Get-AzureRmDataLakeStoreChildItem](Get-AzureRmDataLakeStoreChildItem.md) -Gets the list of items in a folder in Data Lake Store. - -### [Get-AzureRmDataLakeStoreChildItemSummary](Get-AzureRmDataLakeStoreChildItemSummary.md) -Gets the summary of total size, files and directories contained in the path specified - -### [Get-AzureRmDataLakeStoreFirewallRule](Get-AzureRmDataLakeStoreFirewallRule.md) -Gets the specified firewall rules in the specified Data Lake Store. -If no firewall rule is specified, then lists all firewall rules for the account. - -### [Get-AzureRmDataLakeStoreItem](Get-AzureRmDataLakeStoreItem.md) -Gets the details of a file or folder in Data Lake Store. - -### [Get-AzureRmDataLakeStoreItemAclEntry](Get-AzureRmDataLakeStoreItemAclEntry.md) -Gets an entry in the ACL of a file or folder in Data Lake Store. - -### [Get-AzureRmDataLakeStoreItemContent](Get-AzureRmDataLakeStoreItemContent.md) -Gets the contents of a file in Data Lake Store. - -### [Get-AzureRmDataLakeStoreItemOwner](Get-AzureRmDataLakeStoreItemOwner.md) -Gets the owner of a file or folder in Data Lake Store. - -### [Get-AzureRmDataLakeStoreItemPermission](Get-AzureRmDataLakeStoreItemPermission.md) -Gets the permission octal of a file or folder in Data Lake Store. - -### [Get-AzureRmDataLakeStoreTrustedIdProvider](Get-AzureRmDataLakeStoreTrustedIdProvider.md) -Gets the specified trusted identity provider in the specified Data Lake Store. -If no provider is specified, then lists all providers for the account. - -### [Get-AzureRmDataLakeStoreVirtualNetworkRule](Get-AzureRmDataLakeStoreVirtualNetworkRule.md) -Gets the specified virtual network rules in the specified Data Lake Store. -If no virtual network rule is specified, then lists all virtual network rules for the account. - -### [Import-AzureRmDataLakeStoreItem](Import-AzureRmDataLakeStoreItem.md) -Uploads a local file or directory to a Data Lake Store. - -### [Join-AzureRmDataLakeStoreItem](Join-AzureRmDataLakeStoreItem.md) -Joins one or more files to create one file in Data Lake Store. - -### [Move-AzureRmDataLakeStoreItem](Move-AzureRmDataLakeStoreItem.md) -Moves or renames a file or folder in Data Lake Store. - -### [New-AzureRmDataLakeStoreAccount](New-AzureRmDataLakeStoreAccount.md) -Creates a new Data Lake Store account. - -### [New-AzureRmDataLakeStoreItem](New-AzureRmDataLakeStoreItem.md) -Creates a new file or folder in Data Lake Store. - -### [Remove-AzureRmDataLakeStoreAccount](Remove-AzureRmDataLakeStoreAccount.md) -Deletes a Data Lake Store account permanently. - -### [Remove-AzureRmDataLakeStoreFirewallRule](Remove-AzureRmDataLakeStoreFirewallRule.md) -Removes the specified firewall rule in the specified Data Lake Store. - -### [Remove-AzureRmDataLakeStoreItem](Remove-AzureRmDataLakeStoreItem.md) -Deletes a file or folder in Data Lake Store. - -### [Remove-AzureRmDataLakeStoreItemAcl](Remove-AzureRmDataLakeStoreItemAcl.md) -Clears the ACL of a file or folder in Data Lake Store. - -### [Remove-AzureRmDataLakeStoreItemAclEntry](Remove-AzureRmDataLakeStoreItemAclEntry.md) -Removes an entry from the ACL of a file or folder in Data Lake Store. - -### [Remove-AzureRmDataLakeStoreTrustedIdProvider](Remove-AzureRmDataLakeStoreTrustedIdProvider.md) -Removes the specified trusted identity provider in the specified Data Lake Store. - -### [Remove-AzureRmDataLakeStoreVirtualNetworkRule](Remove-AzureRmDataLakeStoreVirtualNetworkRule.md) -Removes the specified virtual network rule in the specified Data Lake Store. - -### [Set-AzureRmDataLakeStoreAccount](Set-AzureRmDataLakeStoreAccount.md) -Modifies a Data Lake Store account. - -### [Set-AzureRmDataLakeStoreFirewallRule](Set-AzureRmDataLakeStoreFirewallRule.md) -Modifies the specified firewall rule in the specified Data Lake Store. - -### [Set-AzureRmDataLakeStoreItemAcl](Set-AzureRmDataLakeStoreItemAcl.md) -Modifies the ACL of a file or folder in Data Lake Store. - -### [Set-AzureRmDataLakeStoreItemAclEntry](Set-AzureRmDataLakeStoreItemAclEntry.md) -Modifies an entry in the ACL of a file or folder in Data Lake Store. - -### [Set-AzureRmDataLakeStoreItemExpiry](Set-AzureRmDataLakeStoreItemExpiry.md) -Sets or removes the expire time for a file in an Azure Data Lake Store account. - -### [Set-AzureRmDataLakeStoreItemOwner](Set-AzureRmDataLakeStoreItemOwner.md) -Modifies the owner of a file or folder in Data Lake Store. - -### [Set-AzureRmDataLakeStoreItemPermission](Set-AzureRmDataLakeStoreItemPermission.md) -Modifies the permission octal of a file or folder in Data Lake Store. - -### [Set-AzureRmDataLakeStoreTrustedIdProvider](Set-AzureRmDataLakeStoreTrustedIdProvider.md) -Modifies the specified trusted identity provider in the specified Data Lake Store. - -### [Set-AzureRmDataLakeStoreVirtualNetworkRule](Set-AzureRmDataLakeStoreVirtualNetworkRule.md) -Modifies the specified virtual network rule in the specified Data Lake Store. - -### [Test-AzureRmDataLakeStoreAccount](Test-AzureRmDataLakeStoreAccount.md) -Tests the existence of a Data Lake Store account. - -### [Test-AzureRmDataLakeStoreItem](Test-AzureRmDataLakeStoreItem.md) -Tests the existence of a file or folder in Data Lake Store. - diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Enable-AzureRmDataLakeStoreKeyVault.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Enable-AzureRmDataLakeStoreKeyVault.md deleted file mode 100644 index 0655687e4a..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Enable-AzureRmDataLakeStoreKeyVault.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/enable-azurermdatalakestorekeyvault -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Enable-AzureRmDataLakeStoreKeyVault.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Enable-AzureRmDataLakeStoreKeyVault.md ---- - -# Enable-AzureRmDataLakeStoreKeyVault - -## SYNOPSIS -Attempts to enable a user managed Key Vault for encryption of the specified Data Lake Store account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Enable-AzureRmDataLakeStoreKeyVault [-Account] <String> [-ResourceGroupName <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Enable-AzureRmDataLakeStoreKeyVault** cmdlet attempts to enable a user managed Key Vault for encryption of the specified Data Lake Store account. - -## EXAMPLES - -### Example 1: Enable the Key Vault for the ContosoADLS account -``` -PS C:\>Enable-AzureRmDataLakeStoreKeyVault -Name "ContosoADLS" -``` - -This command attempts to enable the user managed Key Vault for the Data Lake Store account named ContosoADLS. - -## PARAMETERS - -### -Account -The Data Lake Store account to enable the user managed Key Vault for - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of resource group associated with the account. If not specified will attempt to be discovered. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[New-AzureRmDataLakeStoreAccount](./New-AzureRmDataLakeStoreAccount.md) - -[Set-AzureRmDataLakeStoreAccount](./Set-AzureRmDataLakeStoreAccount.md) - diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Export-AzureRmDataLakeStoreChildItemProperties.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Export-AzureRmDataLakeStoreChildItemProperties.md deleted file mode 100644 index a193100ef4..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Export-AzureRmDataLakeStoreChildItemProperties.md +++ /dev/null @@ -1,301 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/get-azureatalakestorechilditemproperties -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Export-AzureRmDataLakeStoreChildItemProperties.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Export-AzureRmDataLakeStoreChildItemProperties.md ---- - -# Export-AzureRmDataLakeStoreChildItemProperties - -## SYNOPSIS -Exports the properties (Disk usage and Acl) for the entire tree from the specified path to a ouput path - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetDiskUsage -``` -Export-AzureRmDataLakeStoreChildItemProperties [-Account] <String> [-Path] <DataLakeStorePathInstance> - [-OutputPath] <String> [-SaveToAdl] [-IncludeFile] [-MaximumDepth <Int32>] [-Concurrency <Int32>] - [-GetDiskUsage] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### GetAllProperties -``` -Export-AzureRmDataLakeStoreChildItemProperties [-Account] <String> [-Path] <DataLakeStorePathInstance> - [-OutputPath] <String> [-SaveToAdl] [-IncludeFile] [-MaximumDepth <Int32>] [-Concurrency <Int32>] - [-GetDiskUsage] [-GetAcl] [-HideConsistentAcl] [-PassThru] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### GetAclDump -``` -Export-AzureRmDataLakeStoreChildItemProperties [-Account] <String> [-Path] <DataLakeStorePathInstance> - [-OutputPath] <String> [-SaveToAdl] [-IncludeFile] [-MaximumDepth <Int32>] [-Concurrency <Int32>] [-GetAcl] - [-HideConsistentAcl] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Export-AzureRmDataLakeStoreChildItemProperties** is used to report the ADLS space usage or/and ACL usage for the given directory and it's sub directories and files. - -## EXAMPLES - -### Example 1: Get the disk usage and ACL usage for all subdirectories and files -``` -PS C:\> Export-AzureRmDataLakeStoreChildItemProperties -Account ContosoADL -Path /a -OutputPath "C:\Users\contoso\Desktop\DumpFile.txt" -GetAcl -GetDiskUsage -IncludeFile -``` - -Get the disk usage and ACL usage for all subdirectories and files under /a. IncludeFile ensures the usage is reported for files also - -### Example 2: Get the ACL usage for all subdirectories and files with the consistent ACL hidden -``` -PS C:\> $fullAcl="user:contoso-userid:--x|user::rwx|other::---|group::rwx" -PS C:\> $newFullAcl = $fullAcl.Split("{|}"); -PS C:\> Set-AzureRmDataLakeStoreItemAcl -Account ContosoADL -Path /a -Acl $newFullAcl -Recurse -Debug - -PS C:\> Export-AzureRmDataLakeStoreChildItemProperties -Account ContosoADL -Path /a -OutputPath "C:\Users\contoso\Desktop\DumpFile.txt" -GetAcl -HideConsistentAcl -IncludeFile -``` - -Get the ACL usage for all subdirectories and files under /a. IncludeFile ensures the usage is reported for files also. HideconsistentAcl in this case will show the Acl of /a, not it's children since all of the children has same acl as /a. This flag skips the acl ouput of subtree if all it's acls are same as the root. - -## PARAMETERS - -### -Account -The Data Lake Store account to execute the filesystem operation in - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Concurrency -Indicates the number of files/directories processed in parallel. -Default will be computed as a best effort based on system specification. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GetAcl -Retrieves the acl starting from the root path - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: GetAllProperties, GetAclDump -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GetDiskUsage -Retrieves the disk usage starting from the root path - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: GetDiskUsage, GetAllProperties -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HideConsistentAcl -Do not show directory subtree if the ACLs are the same throughout the entire subtree. This makes it easier to see only the paths up to which the ACLs differ.For example if all files and folders under /a/b are the same, do not show the subtreeunder /a/b, and just output /a/b with 'True' in the Consistent ACL columnCannot be set if IncludeFiles is not set, because consistent Acl cannot be determined without retrieving acls for the files. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: GetAllProperties, GetAclDump -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IncludeFile -Show stats at file level (default is to show directory-level info only) - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaximumDepth -Maximum depth from the root directory till which disk usage or acl is displayed - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OutputPath -Path to output file. Can be a Local path or Adl Path. By default it is local. If SaveToAdl is pecified then it is an ADL path in the same account - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates a boolean response should be returned indicating the result of the delete operation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -The path in the specified Data Lake account that should be retrieve. -Can be a file or folder In the format '/folder/file.txt', where the first '/' after the DNS indicates the root of the file system. - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SaveToAdl -If passed then saves the dump file to ADL. -The DumpFile wil be a ADL path in that case - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance - -### System.Management.Automation.SwitchParameter - -### System.Int32 - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Export-AzureRmDataLakeStoreItem.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Export-AzureRmDataLakeStoreItem.md deleted file mode 100644 index 30c650c680..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Export-AzureRmDataLakeStoreItem.md +++ /dev/null @@ -1,270 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -ms.assetid: B10B1F5D-5566-4129-9D42-05A6D3B72C9E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/export-azurermdatalakestoreitem -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Export-AzureRmDataLakeStoreItem.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Export-AzureRmDataLakeStoreItem.md ---- - -# Export-AzureRmDataLakeStoreItem - -## SYNOPSIS -Downloads a file from Data Lake Store. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NoDiagnosticLogging (Default) -``` -Export-AzureRmDataLakeStoreItem [-Account] <String> [-Path] <DataLakeStorePathInstance> [-Destination] <String> - [-Recurse] [-Resume] [-Force] [-Concurrency <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### IncludeDiagnosticLogging -``` -Export-AzureRmDataLakeStoreItem [-Account] <String> [-Path] <DataLakeStorePathInstance> [-Destination] <String> - [-Recurse] [-Resume] [-Force] [-Concurrency <Int32>] [-DiagnosticLogLevel <LogLevel>] - -DiagnosticLogPath <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Export-AzureRmDataLakeStoreItem** cmdlet downloads a file from Data Lake Store. - -## EXAMPLES - -### Example 1: Download an item from the Data Lake Store -``` -PS C:\>Export-AzureRmDataLakeStoreItem -AccountName "ContosoADL" -Path /myFiles/TestSource.csv -Destination "C:\Test.csv" -Concurrency 4 -``` - -This command downloads the file TestSource.csv from the Data Lake Store to C:\Test.csv with a concurrency of 4. - -## PARAMETERS - -### -Account -Specifies the name of the Data Lake Store account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Concurrency -Indicates the number of files or chunks to download in parallel. Default will be computed as a best effort based on system specifications. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Destination -Specifies the local file path to which to download the file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DiagnosticLogLevel -Optionally indicates the diagnostic log level to use to record events during the file or folder import. Default is Error. - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.LogLevel -Parameter Sets: IncludeDiagnosticLogging -Aliases: -Accepted values: Debug, Information, Error, None - -Required: False -Position: Named -Default value: Error -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DiagnosticLogPath -Specifies the path for the diagnostic log to record events to during the file or folder import. - -```yaml -Type: System.String -Parameter Sets: IncludeDiagnosticLogging -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Indicates that this operation can overwrite the destination file if it already exists. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the path of the item to download from the Data Lake Store, starting from the root directory (/). - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Recurse -Indicates that a folder download is recursive. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Resume -Indicates that the file(s) being copied are a continuation of a previous download. -This will cause the system to attempt to resume from the last file that was not fully downloaded. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance - -### System.Management.Automation.SwitchParameter - -### System.Int32 - -### Microsoft.Azure.Commands.DataLakeStore.Models.LogLevel - -## OUTPUTS - -### System.String -The path where the file or folder was downloaded to. - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDataLakeStoreItem](./Get-AzureRmDataLakeStoreItem.md) - -[Import-AzureRmDataLakeStoreItem](./Import-AzureRmDataLakeStoreItem.md) - -[Join-AzureRmDataLakeStoreItem](./Join-AzureRmDataLakeStoreItem.md) - -[Move-AzureRmDataLakeStoreItem](./Move-AzureRmDataLakeStoreItem.md) - -[New-AzureRmDataLakeStoreItem](./New-AzureRmDataLakeStoreItem.md) - -[Remove-AzureRmDataLakeStoreItem](./Remove-AzureRmDataLakeStoreItem.md) - -[Test-AzureRmDataLakeStoreItem](./Test-AzureRmDataLakeStoreItem.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreAccount.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreAccount.md deleted file mode 100644 index 9ce89dccf7..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreAccount.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -ms.assetid: 234D579E-B62D-4D70-8D2E-22AC0D9AC513 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/get-azurermdatalakestoreaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Get-AzureRmDataLakeStoreAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Get-AzureRmDataLakeStoreAccount.md ---- - -# Get-AzureRmDataLakeStoreAccount - -## SYNOPSIS -Gets details of a Data Lake Store account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetAllInSubscription (Default) -``` -Get-AzureRmDataLakeStoreAccount [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetByResourceGroup -``` -Get-AzureRmDataLakeStoreAccount [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### GetBySpecificAccount -``` -Get-AzureRmDataLakeStoreAccount [[-ResourceGroupName] <String>] [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDataLakeStoreAccount** cmdlet gets details of a Data Lake Store account. - -## EXAMPLES - -### Example 1: Get a Data Lake Store account -``` -PS C:\>Get-AzureRmDataLakeStoreAccount -Name "ContosoADL" -``` - -This command gets the account named ContosoADL. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the account to get. - -```yaml -Type: System.String -Parameter Sets: GetBySpecificAccount -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the Data Lake Store account to get. - -```yaml -Type: System.String -Parameter Sets: GetByResourceGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: GetBySpecificAccount -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataLakeStore.Models.PSDataLakeStoreAccount - -## NOTES - -## RELATED LINKS - -[New-AzureRmDataLakeStoreAccount](./New-AzureRmDataLakeStoreAccount.md) - -[Remove-AzureRmDataLakeStoreAccount](./Remove-AzureRmDataLakeStoreAccount.md) - -[Set-AzureRmDataLakeStoreAccount](./Set-AzureRmDataLakeStoreAccount.md) - -[Test-AzureRmDataLakeStoreAccount](./Test-AzureRmDataLakeStoreAccount.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreChildItem.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreChildItem.md deleted file mode 100644 index f34b0aabe4..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreChildItem.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -ms.assetid: CC0E73BD-2063-4CA2-BBBA-1FB6AE04DADE -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/get-azurermdatalakestorechilditem -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Get-AzureRmDataLakeStoreChildItem.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Get-AzureRmDataLakeStoreChildItem.md ---- - -# Get-AzureRmDataLakeStoreChildItem - -## SYNOPSIS -Gets the list of items in a folder in Data Lake Store. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmDataLakeStoreChildItem [-Account] <String> [-Path] <DataLakeStorePathInstance> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDataLakeStoreChildItem** cmdlet gets the list of items in a folder in Data Lake Store. - -## EXAMPLES - -### Example 1: Get the child items for a folder -``` -PS C:\>Get-AzureRmDataLakeStoreChildItem -AccountName "ContosoADL" -Path "/MyFiles/" -``` - -This command gets the child items for the MyFiles folder. - -## PARAMETERS - -### -Account -Specifies the name of the Data Lake Store account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the Data Lake Store path of the folder, starting with the root directory (/). - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance - -## OUTPUTS - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreItem - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreChildItemSummary.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreChildItemSummary.md deleted file mode 100644 index 3a173c617b..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreChildItemSummary.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/get-azureatalakestorechilditemsummary -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Get-AzureRmDataLakeStoreChildItemSummary.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Get-AzureRmDataLakeStoreChildItemSummary.md ---- - -# Get-AzureRmDataLakeStoreChildItemSummary - -## SYNOPSIS -Gets the summary of total size, files and directories contained in the path specified - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmDataLakeStoreChildItemSummary [-Account] <String> [-Path] <DataLakeStorePathInstance> - [-Concurrency <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDataLakeStoreChildItemSummary** retrieves the content summary for a given path. It recursively computes total number of files, directories and total size of all the files under the given path. - -## EXAMPLES - -### Example 1: Get the content summary of a folder -``` -PS C:\> Get-AzureRmDataLakeStoreChildItemSummary -Account ContosoADL -Path /a -Concurrency 128 -``` - -It lists number of total directories, files and their size contained under /a. - -## PARAMETERS - -### -Account -The Data Lake Store account to execute the filesystem operation in - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Concurrency -Indicates the number of files/directories processed in parallel. -Default will be computed as a best effort based on system specification. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -The path in the specified Data Lake account that should be retrieve. -Can be a file or folder In the format '/folder/file.txt', where the first '/' after the DNS indicates the root of the file system. - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance - -### System.Int32 - -## OUTPUTS - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreChildItemSummary - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreFirewallRule.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreFirewallRule.md deleted file mode 100644 index df83928f7a..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreFirewallRule.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -ms.assetid: 7D27F7B1-BAF8-4A01-8BA7-A75A4CFAE370 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/get-azurermdatalakestorefirewallrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Get-AzureRmDataLakeStoreFirewallRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Get-AzureRmDataLakeStoreFirewallRule.md ---- - -# Get-AzureRmDataLakeStoreFirewallRule - -## SYNOPSIS -Gets the specified firewall rules in the specified Data Lake Store. -If no firewall rule is specified, then lists all firewall rules for the account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmDataLakeStoreFirewallRule [-Account] <String> [[-Name] <String>] [[-ResourceGroupName] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmDataLakeStoreFirewallRule cmdlet gets the specified firewall rules in the specified Data Lake Store. -If no firewall rule is specified, then lists all firewall rules for the account. - -## EXAMPLES - -### Example 1: Retrieve a specific firewall rule -``` -PS C:\> Get-AzureRmDataLakeStoreFirewallRule -AccountName "ContosoADL" -Name MyFirewallRule -``` - -Returns the firewall rule named "MyFirewallRule" from account "ContosoADL" - -### Example 2: List all firewall rules in an account -``` -PS C:\> Get-AzureRmDataLakeStoreFirewallRule -AccountName "ContosoADL" -``` - -Returns all firewall rules in account "ContosoADL" - -## PARAMETERS - -### -Account -The Data Lake Store account to retrieve the firewall rule from. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the firewall rule to retrieve - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of resource group under which want to retrieve the specified account's specified firewall rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreFirewallRule - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreItem.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreItem.md deleted file mode 100644 index d67a14ff30..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreItem.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -ms.assetid: ECA70C6C-E0B0-445D-BCAD-041625FAC632 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/get-azurermdatalakestoreitem -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Get-AzureRmDataLakeStoreItem.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Get-AzureRmDataLakeStoreItem.md ---- - -# Get-AzureRmDataLakeStoreItem - -## SYNOPSIS -Gets the details of a file or folder in Data Lake Store. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmDataLakeStoreItem [-Account] <String> [-Path] <DataLakeStorePathInstance> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDataLakeStoreItem** cmdlet gets the details of a file or folder in Data Lake Store. - -## EXAMPLES - -### Example 1: Get details of a file from the Data Lake Store -``` -PS C:\>Get-AzureRmDataLakeStoreItem -AccountName "ContosoADL" -Path "/MyFiles/Test.csv" -``` - -This command gets the details of the file Test.csv from the Data Lake Store. - -## PARAMETERS - -### -Account -Specifies the name of the Data Lake Store account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the Data Lake Store path from which to get details of an item, starting with the root directory (/). - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance - -## OUTPUTS - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreItem - -## NOTES - -## RELATED LINKS - -[Export-AzureRmDataLakeStoreItem](./Export-AzureRmDataLakeStoreItem.md) - -[Get-AzureRmDataLakeStoreChildItem](./Get-AzureRmDataLakeStoreChildItem.md) - -[Import-AzureRmDataLakeStoreItem](./Import-AzureRmDataLakeStoreItem.md) - -[Join-AzureRmDataLakeStoreItem](./Join-AzureRmDataLakeStoreItem.md) - -[Move-AzureRmDataLakeStoreItem](./Move-AzureRmDataLakeStoreItem.md) - -[New-AzureRmDataLakeStoreItem](./New-AzureRmDataLakeStoreItem.md) - -[Remove-AzureRmDataLakeStoreItem](./Remove-AzureRmDataLakeStoreItem.md) - -[Test-AzureRmDataLakeStoreItem](./Test-AzureRmDataLakeStoreItem.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreItemAclEntry.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreItemAclEntry.md deleted file mode 100644 index 9321c5664a..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreItemAclEntry.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -ms.assetid: DFE8C373-2BBA-4A4E-B4B1-926373E68FC4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/get-azurermdatalakestoreitemaclentry -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Get-AzureRmDataLakeStoreItemAclEntry.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Get-AzureRmDataLakeStoreItemAclEntry.md ---- - -# Get-AzureRmDataLakeStoreItemAclEntry - -## SYNOPSIS -Gets an entry in the ACL of a file or folder in Data Lake Store. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmDataLakeStoreItemAclEntry [-Account] <String> [-Path] <DataLakeStorePathInstance> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDataLakeStoreItemAclEntry** cmdlet gets an entry (ACE) in the access control list (ACL) of a file or folder in Data Lake Store. - -## EXAMPLES - -### Example 1: Get the ACL for a folder -``` -PS C:\> Get-AzureRmDataLakeStoreItemAclEntry -AccountName 'ContosoADL' -Path '/' -``` - -This command gets the ACL for the root directory of the specified Data Lake Store account - -## PARAMETERS - -### -Account -Specifies the name of the Data Lake Store account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the Data Lake Store path of the item for which this cmdlet gets an ACE, starting with the root directory (/). - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance - -## OUTPUTS - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreItemAce - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmDataLakeStoreItemAclEntry](./Remove-AzureRmDataLakeStoreItemAclEntry.md) - -[Set-AzureRmDataLakeStoreItemAclEntry](./Set-AzureRmDataLakeStoreItemAclEntry.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreItemContent.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreItemContent.md deleted file mode 100644 index c69e806eaa..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreItemContent.md +++ /dev/null @@ -1,268 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -ms.assetid: 15DFF66F-3D78-422B-BA40-71058DE66BA2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/get-azurermdatalakestoreitemcontent -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Get-AzureRmDataLakeStoreItemContent.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Get-AzureRmDataLakeStoreItemContent.md ---- - -# Get-AzureRmDataLakeStoreItemContent - -## SYNOPSIS -Gets the contents of a file in Data Lake Store. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### PreviewFileContent (Default) -``` -Get-AzureRmDataLakeStoreItemContent [-Account] <String> [-Path] <DataLakeStorePathInstance> [[-Offset] <Int64>] - [[-Length] <Int64>] [[-Encoding] <FileSystemCmdletProviderEncoding>] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### PreviewFileRowsFromHead -``` -Get-AzureRmDataLakeStoreItemContent [-Account] <String> [-Path] <DataLakeStorePathInstance> [[-Head] <Int32>] - [[-Encoding] <FileSystemCmdletProviderEncoding>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### PreviewFileRowsFromTail -``` -Get-AzureRmDataLakeStoreItemContent [-Account] <String> [-Path] <DataLakeStorePathInstance> [[-Tail] <Int32>] - [[-Encoding] <FileSystemCmdletProviderEncoding>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDataLakeStoreItemContent** cmdlet gets the contents of a file in Data Lake Store. - -## EXAMPLES - -### Example 1: Get the contents of a file -``` -PS C:\>Get-AzureRmDataLakeStoreItemContent -AccountName "ContosoADL" -Path "/MyFile.txt" -``` - -This command gets the contents of the file MyFile.txt in the ContosoADL account. - -### Example 2: Get the first two rows of a file -``` -PS C:\>Get-AzureRmDataLakeStoreItemContent -AccountName "ContosoADL" -Path "/MyFile.txt" -Head 2 -``` - -This command gets the first two new line separated rows in the file MyFile.txt in the ContosoADL account. - -## PARAMETERS - -### -Account -Specifies the name of the Data Lake Store account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Encoding -Specifies the encoding for the item to create. -The acceptable values for this parameter are: -- Unknown -- String -- Unicode -- Byte -- BigEndianUnicode -- UTF8 -- UTF7 -- Ascii -- Default -- Oem -- BigEndianUTF32 - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.FileSystemCmdletProviderEncoding -Parameter Sets: (All) -Aliases: -Accepted values: Unknown, String, Unicode, Byte, BigEndianUnicode, UTF8, UTF7, UTF32, Ascii, Default, Oem, BigEndianUTF32 - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: PreviewFileContent -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Head -The number of rows (new line delimited) from the beginning of the file to preview. If no new line is encountered in the first 4mb of data, only that data will be returned. - -```yaml -Type: System.Int32 -Parameter Sets: PreviewFileRowsFromHead -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Length -Specifies the length, in bytes, of the content to get. - -```yaml -Type: System.Int64 -Parameter Sets: PreviewFileContent -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Offset -Specifies the number of bytes to skip in a file before getting content. - -```yaml -Type: System.Int64 -Parameter Sets: PreviewFileContent -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the Data Lake Store path of a file, starting with the root directory (/). - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tail -The number of rows (new line delimited) from the end of the file to preview. If no new line is encountered in the first 4mb of data, only that data will be returned. - -```yaml -Type: System.Int32 -Parameter Sets: PreviewFileRowsFromTail -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance - -### System.Int32 - -### System.Int64 - -### Microsoft.Azure.Commands.DataLakeStore.Models.FileSystemCmdletProviderEncoding - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Byte -The byte stream representation of the file contents retrieved. - -### System.String -The string representation (in the specified encoding) of the file contents retrieved. - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreItemOwner.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreItemOwner.md deleted file mode 100644 index fd7a6ca705..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreItemOwner.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -ms.assetid: 335588D4-4D2C-4DBD-B6B2-B1227C4AF9A9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/get-azurermdatalakestoreitemowner -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Get-AzureRmDataLakeStoreItemOwner.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Get-AzureRmDataLakeStoreItemOwner.md ---- - -# Get-AzureRmDataLakeStoreItemOwner - -## SYNOPSIS -Gets the owner of a file or folder in Data Lake Store. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmDataLakeStoreItemOwner [-Account] <String> [-Path] <DataLakeStorePathInstance> [-Type] <Owner> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDataLakeStoreItemOwner** cmdlet gets the owner of a file or folder in Data Lake Store. - -## EXAMPLES - -### Example 1: Get the owner for a directory -``` -PS C:\>Get-AzureRmDataLakeStoreItemOwner -AccountName "ContosoADL" -Path / -Type User -``` - -This command gets the user owner for the root directory of the ContosoADL account. - -## PARAMETERS - -### -Account -Specifies the name of the Data Lake Store account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the Data Lake Store path of an item, starting with the root directory (/). - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Type -Specifies the type of owner to get. -The acceptable values for this parameter are: User and Group. - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreEnums+Owner -Parameter Sets: (All) -Aliases: -Accepted values: User, Group - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreEnums+Owner - -## OUTPUTS - -### System.String -The owner of the specified item. - -## NOTES - -## RELATED LINKS - -[Set-AzureRmDataLakeStoreItemOwner](./Set-AzureRmDataLakeStoreItemOwner.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreItemPermission.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreItemPermission.md deleted file mode 100644 index 18674d8db6..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreItemPermission.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -ms.assetid: 476E889F-C763-4EFA-AFD6-B037BA6BA0A1 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/get-azurermdatalakestoreitempermission -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Get-AzureRmDataLakeStoreItemPermission.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Get-AzureRmDataLakeStoreItemPermission.md ---- - -# Get-AzureRmDataLakeStoreItemPermission - -## SYNOPSIS -Gets the permission octal of a file or folder in Data Lake Store. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmDataLakeStoreItemPermission [-Account] <String> [-Path] <DataLakeStorePathInstance> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDataLakeStoreItemPermission** cmdlet gets the permission octal of a file or folder in Data Lake Store. - -## EXAMPLES - -### Example 1: Set the permission octal for a file -``` -PS C:\>Get-AzureRmDataLakeStoreItemPermission -AccountName "ContosoADL" -Path "/file.txt" -``` - -This command gets the permission octal for a file. - -## PARAMETERS - -### -Account -Specifies the Data Lake Store account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the Data Lake Store path of the file or folder, starting with the root directory (/). - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance - -## OUTPUTS - -### System.String -The string representation of the ownership octal - -## NOTES -* Alias: Get-AdlStoreItemPermission - -## RELATED LINKS - -[Set-AzureRmDataLakeStoreItemPermission](./Set-AzureRmDataLakeStoreItemPermission.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreTrustedIdProvider.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreTrustedIdProvider.md deleted file mode 100644 index ce7511ec68..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreTrustedIdProvider.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -ms.assetid: D79080D5-2785-4C46-86FD-FDAA11117D17 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/get-azurermdatalakestoretrustedidprovider -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Get-AzureRmDataLakeStoreTrustedIdProvider.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Get-AzureRmDataLakeStoreTrustedIdProvider.md ---- - -# Get-AzureRmDataLakeStoreTrustedIdProvider - -## SYNOPSIS -Gets the specified trusted identity provider in the specified Data Lake Store. -If no provider is specified, then lists all providers for the account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmDataLakeStoreTrustedIdProvider [-Account] <String> [[-Name] <String>] - [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDataLakeStoreTrustedIdProvider** cmdlet gets the specified trusted identity provider in the specified Data Lake Store. -If no provider is specified, then lists all providers for the account. - -## EXAMPLES - -### Example 1: Get a specific trusted identity provider -``` -PS C:\> Get-AzureRmDataLakeStoreTrustedIdProvider -AccountName "ContosoADL" -Name MyProvider -``` - -Returns the provider named "MyProvider" from account "ContosoADL" - -### Example 2: List all providers in an account -``` -PS C:\> Get-AzureRmDataLakeStoreTrustedIdProvider -AccountName "ContosoADL" -``` - -Lists all providers under the account "ContosoADL" - -## PARAMETERS - -### -Account -The Data Lake Store account to retrieve the trusted identity provider from - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the trusted identity provider to retrieve - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of resource group under which want to retrieve the specified account's specified trusted identity provider. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreTrustedIdProvider - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreVirtualNetworkRule.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreVirtualNetworkRule.md deleted file mode 100644 index 68a90be88d..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Get-AzureRmDataLakeStoreVirtualNetworkRule.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/get-azurermdatalakestorevirtualnetworkrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Get-AzureRmDataLakeStoreVirtualNetworkRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Get-AzureRmDataLakeStoreVirtualNetworkRule.md ---- - -# Get-AzureRmDataLakeStoreVirtualNetworkRule - -## SYNOPSIS -Gets the specified virtual network rules in the specified Data Lake Store. -If no virtual network rule is specified, then lists all virtual network rules for the account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmDataLakeStoreVirtualNetworkRule [-Account] <String> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmDataLakeStoreVirtualNetworkRule cmdlet gets the specified virtual network rules in the specified Data Lake Store. -If no virtual network rule is specified, then lists all virtual network rules for the account. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmDataLakeStoreVirtualNetworkRule -Account "dls" -Name "myVNET" - -ResourceGroupName : -AccountName : -VirtualNetworkRuleName : myVNET -VirtualNetworkSubnetId : /subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.Network/virtualNetworks/myVNET/subnets/testId -IgnoreMissingVnetServiceEndpoint : -State : -``` - -Returns the virtual network rule named "myVNET" from account "dls" - -## PARAMETERS - -### -Account -The Data Lake Store account to get the virtual network rule from - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the virtual network rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreVirtualNetworkRule - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Import-AzureRmDataLakeStoreItem.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Import-AzureRmDataLakeStoreItem.md deleted file mode 100644 index 83888cc563..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Import-AzureRmDataLakeStoreItem.md +++ /dev/null @@ -1,284 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -ms.assetid: 90630395-8747-4446-A879-323274811956 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/import-azurermdatalakestoreitem -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Import-AzureRmDataLakeStoreItem.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Import-AzureRmDataLakeStoreItem.md ---- - -# Import-AzureRmDataLakeStoreItem - -## SYNOPSIS -Uploads a local file or directory to a Data Lake Store. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NoDiagnosticLogging (Default) -``` -Import-AzureRmDataLakeStoreItem [-Account] <String> [-Path] <String> [-Destination] <DataLakeStorePathInstance> - [-Recurse] [-Resume] [-ForceBinary] [-Force] [-Concurrency <Int32>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### IncludeDiagnosticLogging -``` -Import-AzureRmDataLakeStoreItem [-Account] <String> [-Path] <String> [-Destination] <DataLakeStorePathInstance> - [-Recurse] [-Resume] [-ForceBinary] [-Force] [-Concurrency <Int32>] [-DiagnosticLogLevel <LogLevel>] - -DiagnosticLogPath <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Import-AzureRmDataLakeStoreItem** cmdlet uploads a local file or directory to a Data Lake Store. - -## EXAMPLES - -### Example 1: Upload a file -``` -PS C:\>Import-AzureRmDataLakeStoreItem -AccountName "ContosoADL" -Path "C:\SrcFile.csv" -Destination "/MyFiles/File.csv" -Concurrency 4 -``` - -This command uploads the file SrcFile.csv and adds it to the MyFiles folder in the Data Lake Store as File.csv with a concurrency of 4. - -## PARAMETERS - -### -Account -Specifies the name of the Data Lake Store account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Concurrency -Indicates the number of files or chunks to upload in parallel. Default will be computed as a best effort based on system specifications. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Destination -Specifies the Data Lake Store path to which to upload a file or folder, starting with the root directory (/). - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DiagnosticLogLevel -Optionally indicates the diagnostic log level to use to record events during the file or folder import. Default is Error. - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.LogLevel -Parameter Sets: IncludeDiagnosticLogging -Aliases: -Accepted values: Debug, Information, Error, None - -Required: False -Position: Named -Default value: Error -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DiagnosticLogPath -Specifies the path for the diagnostic log to record events to during the file or folder import. - -```yaml -Type: System.String -Parameter Sets: IncludeDiagnosticLogging -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Indicates that this operation can overwrite the destination file if it already exists. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ForceBinary -Indicates that the file(s) being copied should be copied with no concern for new line preservation across appends. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the local path of the file or folder to upload. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Recurse -Indicates that this operation should upload all items in all subfolders. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Resume -Indicates that the file(s) being copied are a continuation of a previous upload. This will cause the system to attempt to resume from the last file that was not fully uploaded. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance - -### System.Management.Automation.SwitchParameter - -### System.Int32 - -### Microsoft.Azure.Commands.DataLakeStore.Models.LogLevel - -## OUTPUTS - -### System.String -The full path in the Data Lake Store account to the uploaded file or folder. - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDataLakeStoreItem](./Get-AzureRmDataLakeStoreItem.md) - -[Export-AzureRmDataLakeStoreItem](./Export-AzureRmDataLakeStoreItem.md) - -[Join-AzureRmDataLakeStoreItem](./Join-AzureRmDataLakeStoreItem.md) - -[Move-AzureRmDataLakeStoreItem](./Move-AzureRmDataLakeStoreItem.md) - -[New-AzureRmDataLakeStoreItem](./New-AzureRmDataLakeStoreItem.md) - -[Remove-AzureRmDataLakeStoreItem](./Remove-AzureRmDataLakeStoreItem.md) - -[Test-AzureRmDataLakeStoreItem](./Test-AzureRmDataLakeStoreItem.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Join-AzureRmDataLakeStoreItem.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Join-AzureRmDataLakeStoreItem.md deleted file mode 100644 index d517e2cc25..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Join-AzureRmDataLakeStoreItem.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -ms.assetid: 4E9EA2E9-4BE2-4530-BC2B-D369C016CD8C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/join-azurermdatalakestoreitem -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Join-AzureRmDataLakeStoreItem.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Join-AzureRmDataLakeStoreItem.md ---- - -# Join-AzureRmDataLakeStoreItem - -## SYNOPSIS -Joins one or more files to create one file in Data Lake Store. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Join-AzureRmDataLakeStoreItem [-Account] <String> [-Paths] <DataLakeStorePathInstance[]> - [-Destination] <DataLakeStorePathInstance> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Join-AzureRmDataLakeStoreItem** cmdlet joins one or more files to create one file in Data Lake Store. - -## EXAMPLES - -### Example 1: Join two items -``` -PS C:\>Join-AzureRmDataLakeStoreItem -AccountName "ContosoADL" -Paths "/MyFiles/File01.txt","/MyFiles/File02.txt" -Destination "/MyFiles/CombinedFile.txt" -``` - -This command joins File01.txt and File02.txt to create the file CombinedFile.txt. - -## PARAMETERS - -### -Account -Specifies the name of the Data Lake Store account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Destination -Specifies the Data Lake Store path for the joined item, starting with the root directory (/). - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Indicates that this operation can overwrite the destination file if it already exists. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Paths -Specifies an array of Data Lake Store paths of the files to combine, starting with the root directory (/). - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance[] -Parameter Sets: (All) -Aliases: Path - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance[] - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.String -The full path to the resulting file from the joined files. - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDataLakeStoreItem](./Get-AzureRmDataLakeStoreItem.md) - -[Export-AzureRmDataLakeStoreItem](./Export-AzureRmDataLakeStoreItem.md) - -[Import-AzureRmDataLakeStoreItem](./Import-AzureRmDataLakeStoreItem.md) - -[New-AzureRmDataLakeStoreItem](./New-AzureRmDataLakeStoreItem.md) - -[Remove-AzureRmDataLakeStoreItem](./Remove-AzureRmDataLakeStoreItem.md) - -[Test-AzureRmDataLakeStoreItem](./Test-AzureRmDataLakeStoreItem.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Move-AzureRmDataLakeStoreItem.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Move-AzureRmDataLakeStoreItem.md deleted file mode 100644 index ddbaaa09bd..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Move-AzureRmDataLakeStoreItem.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -ms.assetid: 00CCA9B8-7C57-4FC0-9BD1-5FC16010E820 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/move-azurermdatalakestoreitem -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Move-AzureRmDataLakeStoreItem.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Move-AzureRmDataLakeStoreItem.md ---- - -# Move-AzureRmDataLakeStoreItem - -## SYNOPSIS -Moves or renames a file or folder in Data Lake Store. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Move-AzureRmDataLakeStoreItem [-Account] <String> [-Path] <DataLakeStorePathInstance> - [-Destination] <DataLakeStorePathInstance> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Move-AzureRmDataLakeStoreItem** cmdlet moves or renames a file or folder in Data Lake Store. - -## EXAMPLES - -### Example 1: Move and rename an item -``` -PS C:\>Move-AzureRmDataLakeStoreItem -AccountName "ContosoADL" -Path "/Original/Path/File.txt" -Destination "/New/Path/RenamedFile.txt" -``` - -This command renames the item File.txt to RenamedFile.txt and moves it to a different folder. - -## PARAMETERS - -### -Account -Specifies the name of the Data Lake Store account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Destination -Specifies the Data Lake Store path to which to move the item, starting with the root directory (/). - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Indicates that this operation can overwrite the destination file if it already exists. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the Data Lake Store path of the item to move or rename, starting with the root directory (/). - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.String -The full path to the moved file or folder. - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDataLakeStoreItem](./Get-AzureRmDataLakeStoreItem.md) - -[Export-AzureRmDataLakeStoreItem](./Export-AzureRmDataLakeStoreItem.md) - -[Import-AzureRmDataLakeStoreItem](./Import-AzureRmDataLakeStoreItem.md) - -[New-AzureRmDataLakeStoreItem](./New-AzureRmDataLakeStoreItem.md) - -[Remove-AzureRmDataLakeStoreItem](./Remove-AzureRmDataLakeStoreItem.md) - -[Test-AzureRmDataLakeStoreItem](./Test-AzureRmDataLakeStoreItem.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/New-AzureRmDataLakeStoreAccount.md b/azurermps-6.13.0/AzureRM.DataLakeStore/New-AzureRmDataLakeStoreAccount.md deleted file mode 100644 index f137f8aa77..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/New-AzureRmDataLakeStoreAccount.md +++ /dev/null @@ -1,257 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -ms.assetid: 58AAA284-45A3-4360-B321-FBE0A3F5D7A9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/new-azurermdatalakestoreaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/New-AzureRmDataLakeStoreAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/New-AzureRmDataLakeStoreAccount.md ---- - -# New-AzureRmDataLakeStoreAccount - -## SYNOPSIS -Creates a new Data Lake Store account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### UserOrSystemAssignedEncryption (Default) -``` -New-AzureRmDataLakeStoreAccount [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> - [[-DefaultGroup] <String>] [[-Tag] <Hashtable>] [[-Encryption] <EncryptionConfigType>] - [[-KeyVaultId] <String>] [[-KeyName] <String>] [[-KeyVersion] <String>] [-Tier <TierType>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### DisableEncryption -``` -New-AzureRmDataLakeStoreAccount [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> - [[-DefaultGroup] <String>] [[-Tag] <Hashtable>] [-DisableEncryption] [-Tier <TierType>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmDataLakeStoreAccount** cmdlet creates a new Data Lake Store account. - -## EXAMPLES - -### Example 1: Create an account -``` -PS C:\>New-AzureRmDataLakeStoreAccount -Name "ContosoADL" -ResourceGroupName "ContosoOrg" -Location "East US 2" -``` - -This command creates a Data Lake Store account named ContosoADL for the East US 2 location. - -## PARAMETERS - -### -DefaultGroup -Specifies the object ID of the AzureActive Directory group to use as the default group owner for new files and folders. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableEncryption -Indicates that the account will not have any form of encryption applied to it. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: DisableEncryption -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Encryption -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.DataLake.Store.Models.EncryptionConfigType] -Parameter Sets: UserOrSystemAssignedEncryption -Aliases: -Accepted values: UserManaged, ServiceManaged - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyName -```yaml -Type: System.String -Parameter Sets: UserOrSystemAssignedEncryption -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyVaultId -```yaml -Type: System.String -Parameter Sets: UserOrSystemAssignedEncryption -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyVersion -```yaml -Type: System.String -Parameter Sets: UserOrSystemAssignedEncryption -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the location to use for the account. -The acceptable values for this parameter are: -- East US 2 - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the account to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Specifies tags as key-value pairs. -You can use tags to identify a Data Lake Store account from other Azure resources. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tier -The desired commitment tier for this account to use. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.DataLake.Store.Models.TierType] -Parameter Sets: (All) -Aliases: -Accepted values: Consumption, Commitment1TB, Commitment10TB, Commitment100TB, Commitment500TB, Commitment1PB, Commitment5PB - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -### System.Nullable`1[[Microsoft.Azure.Management.DataLake.Store.Models.EncryptionConfigType, Microsoft.Azure.Management.DataLake.Store, Version=2.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -### System.Management.Automation.SwitchParameter - -### System.Nullable`1[[Microsoft.Azure.Management.DataLake.Store.Models.TierType, Microsoft.Azure.Management.DataLake.Store, Version=2.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -## OUTPUTS - -### Microsoft.Azure.Commands.DataLakeStore.Models.PSDataLakeStoreAccount - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDataLakeStoreAccount](./Get-AzureRmDataLakeStoreAccount.md) - -[Remove-AzureRmDataLakeStoreAccount](./Remove-AzureRmDataLakeStoreAccount.md) - -[Set-AzureRmDataLakeStoreAccount](./Set-AzureRmDataLakeStoreAccount.md) - -[Test-AzureRmDataLakeStoreAccount](./Test-AzureRmDataLakeStoreAccount.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/New-AzureRmDataLakeStoreItem.md b/azurermps-6.13.0/AzureRM.DataLakeStore/New-AzureRmDataLakeStoreItem.md deleted file mode 100644 index 9991815891..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/New-AzureRmDataLakeStoreItem.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -ms.assetid: A8222AB8-0003-4AC6-8114-294ABE8054CE -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/new-azurermdatalakestoreitem -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/New-AzureRmDataLakeStoreItem.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/New-AzureRmDataLakeStoreItem.md ---- - -# New-AzureRmDataLakeStoreItem - -## SYNOPSIS -Creates a new file or folder in Data Lake Store. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmDataLakeStoreItem [-Account] <String> [-Path] <DataLakeStorePathInstance> [[-Value] <Object>] - [[-Encoding] <FileSystemCmdletProviderEncoding>] [-Folder] [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmDataLakeStoreItem** cmdlet creates a new file or folder in Data Lake Store. - -## EXAMPLES - -### Example 1: Create a new file and a new folder -``` -PS C:\>New-AzureRmDataLakeStoreItem -AccountName "ContosoADL" -Path "/NewFile.txt" -PS C:\> New-AzureRmDataLakeStoreItem -AccountName "ContosoADL" -Path "/NewFolder" -Folder -``` - -The first command creates the file NewFile.txt for the specified account. -The second command creates the folder NewFolder at the root folder. - -## PARAMETERS - -### -Account -Specifies the name of the Data Lake Store account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Encoding -Specifies the encoding for the item to create. -The acceptable values for this parameter are: -- Unknown -- String -- Unicode -- Byte -- BigEndianUnicode -- UTF8 -- UTF7 -- Ascii -- Default -- Oem -- BigEndianUTF32 - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.FileSystemCmdletProviderEncoding -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Folder -Indicates that this operation creates a folder. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Indicates that this operation can overwrite the destination item if it already exists. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the Data Lake Store path of the item to create, starting with the root directory (/). - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Value -Specifies the content to add to the item you create. - -```yaml -Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance - -### System.Object - -### Microsoft.Azure.Commands.DataLakeStore.Models.FileSystemCmdletProviderEncoding - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.String -The full path to the created file or folder. - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDataLakeStoreItem](./Get-AzureRmDataLakeStoreItem.md) - -[Export-AzureRmDataLakeStoreItem](./Export-AzureRmDataLakeStoreItem.md) - -[Import-AzureRmDataLakeStoreItem](./Import-AzureRmDataLakeStoreItem.md) - -[New-AzureRmDataLakeStoreItem](./New-AzureRmDataLakeStoreItem.md) - -[Remove-AzureRmDataLakeStoreItem](./Remove-AzureRmDataLakeStoreItem.md) - -[Test-AzureRmDataLakeStoreItem](./Test-AzureRmDataLakeStoreItem.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Remove-AzureRmDataLakeStoreAccount.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Remove-AzureRmDataLakeStoreAccount.md deleted file mode 100644 index 104f5448a3..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Remove-AzureRmDataLakeStoreAccount.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -ms.assetid: 585D6C4D-EA80-4E6B-8C36-E7632430431F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/remove-azurermdatalakestoreaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Remove-AzureRmDataLakeStoreAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Remove-AzureRmDataLakeStoreAccount.md ---- - -# Remove-AzureRmDataLakeStoreAccount - -## SYNOPSIS -Deletes a Data Lake Store account permanently. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmDataLakeStoreAccount [-Name] <String> [[-ResourceGroupName] <String>] [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmDataLakeStoreAccount** cmdlet deletes a Data Lake Store account permanently. - -## EXAMPLES - -### Example 1: Remove a Data Lake Store account -``` -PS C:\>Remove-AzureRmDataLakeStoreAccount -Name "ContosoADL" -``` - -This command removes the account named ContosoADL from the Data Lake Store. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the account to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group that contains the account to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDataLakeStoreAccount](./Get-AzureRmDataLakeStoreAccount.md) - -[New-AzureRmDataLakeStoreAccount](./New-AzureRmDataLakeStoreAccount.md) - -[Set-AzureRmDataLakeStoreAccount](./Set-AzureRmDataLakeStoreAccount.md) - -[Test-AzureRmDataLakeStoreAccount](./Test-AzureRmDataLakeStoreAccount.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Remove-AzureRmDataLakeStoreFirewallRule.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Remove-AzureRmDataLakeStoreFirewallRule.md deleted file mode 100644 index ac2d5271bd..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Remove-AzureRmDataLakeStoreFirewallRule.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -ms.assetid: 6C7A7E1A-87A2-4F0D-9091-413C111F47F0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/remove-azurermdatalakestorefirewallrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Remove-AzureRmDataLakeStoreFirewallRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Remove-AzureRmDataLakeStoreFirewallRule.md ---- - -# Remove-AzureRmDataLakeStoreFirewallRule - -## SYNOPSIS -Removes the specified firewall rule in the specified Data Lake Store. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmDataLakeStoreFirewallRule [-Account] <String> [[-Name] <String>] [-PassThru] - [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmDataLakeStoreFirewallRule** cmdlet removes the specified firewall rule in the specified Data Lake Store. - -## EXAMPLES - -### Example 1: Remove a firewall rule from an account -``` -PS C:\> Remove-AzureRmDataLakeStoreFirewallRule -AccountName "ContosoADL" -Name MyFirewallRule -``` - -Removes firewall rule "MyFirewallRule" from account "ContosoADL" - -## PARAMETERS - -### -Account -The Data Lake Store account to update the firewall rule in - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the firewall rule to delete. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates a boolean response should be returned indicating the result of the delete operation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the account to remove the firewall rule from. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Remove-AzureRmDataLakeStoreItem.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Remove-AzureRmDataLakeStoreItem.md deleted file mode 100644 index 631ba6fe81..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Remove-AzureRmDataLakeStoreItem.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -ms.assetid: 164DC871-0F0C-4E71-A37A-2B85CE65C2C4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/remove-azurermdatalakestoreitem -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Remove-AzureRmDataLakeStoreItem.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Remove-AzureRmDataLakeStoreItem.md ---- - -# Remove-AzureRmDataLakeStoreItem - -## SYNOPSIS -Deletes a file or folder in Data Lake Store. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmDataLakeStoreItem [-Account] <String> [-Paths] <DataLakeStorePathInstance[]> [-Recurse] [-Force] - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmDataLakeStoreItem** cmdlet deletes a file or folder in Data Lake Store. - -## EXAMPLES - -### Example 1: Remove multiple items -``` -PS C:\>Remove-AzureRmDataLakeStoreItem -AccountName "ContosoADL" -Paths "/File01.txt","/MyFiles/File.csv" -``` - -This command removes the files File01.txt and File.csv from the Data Lake Store. - -## PARAMETERS - -### -Account -Specifies the name of the Data Lake Store account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Paths -Specifies an array of Data Lake Store paths of the files to remove, starting with the root directory (/). - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Recurse -Indicates that this operation deletes all items in the target folder, including subfolders. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance[] - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDataLakeStoreItem](./Get-AzureRmDataLakeStoreItem.md) - -[Export-AzureRmDataLakeStoreItem](./Export-AzureRmDataLakeStoreItem.md) - -[Import-AzureRmDataLakeStoreItem](./Import-AzureRmDataLakeStoreItem.md) - -[Join-AzureRmDataLakeStoreItem](./Join-AzureRmDataLakeStoreItem.md) - -[New-AzureRmDataLakeStoreItem](./New-AzureRmDataLakeStoreItem.md) - -[Test-AzureRmDataLakeStoreItem](./Test-AzureRmDataLakeStoreItem.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Remove-AzureRmDataLakeStoreItemAcl.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Remove-AzureRmDataLakeStoreItemAcl.md deleted file mode 100644 index 2a9b0ca011..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Remove-AzureRmDataLakeStoreItemAcl.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -ms.assetid: D3E8A6A6-C6C5-46B0-914B-75088A6F6011 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/remove-azurermdatalakestoreitemacl -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Remove-AzureRmDataLakeStoreItemAcl.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Remove-AzureRmDataLakeStoreItemAcl.md ---- - -# Remove-AzureRmDataLakeStoreItemAcl - -## SYNOPSIS -Clears the ACL of a file or folder in Data Lake Store. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmDataLakeStoreItemAcl [-Account] <String> [-Path] <DataLakeStorePathInstance> [-Default] [-Force] - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmDataLakeStoreItemAcl** cmdlet clears the access control list (ACL) of a file or folder in Data Lake Store. - -## EXAMPLES - -### Example 1: Remove the ACL from a folder -``` -PS C:\>Remove-AzureRmDataLakeStoreItemAcl -AccountName "ContosoADL" -Path "/" -``` - -This command removes the ACL for the root directory for the ContosoADL account. - -## PARAMETERS - -### -Account -Specifies the Data Lake Store account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Default -Indicates that the cmdlet removes the default ACL for a file or a folder. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates a boolean response should be returned indicating the result of the delete operation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the Data Lake Store path of the item, starting with the root directory (/). - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES -* Alias: Remove-AdlStoreAcl - -## RELATED LINKS - -[Get-AzureRmDataLakeStoreItemAclEntry](./Get-AzureRmDataLakeStoreItemAclEntry.md) - -[Set-AzureRmDataLakeStoreItemAcl](./Set-AzureRmDataLakeStoreItemAcl.md) - -[Set-AzureRmDataLakeStoreItemAclEntry](./Set-AzureRmDataLakeStoreItemAclEntry.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Remove-AzureRmDataLakeStoreItemAclEntry.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Remove-AzureRmDataLakeStoreItemAclEntry.md deleted file mode 100644 index da0665edf9..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Remove-AzureRmDataLakeStoreItemAclEntry.md +++ /dev/null @@ -1,293 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -ms.assetid: 33E7607E-C2BC-4F46-9038-91AC92041F00 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/remove-azurermdatalakestoreitemaclentry -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Remove-AzureRmDataLakeStoreItemAclEntry.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Remove-AzureRmDataLakeStoreItemAclEntry.md ---- - -# Remove-AzureRmDataLakeStoreItemAclEntry - -## SYNOPSIS -Removes an entry from the ACL of a file or folder in Data Lake Store. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RemoveByACLObject (Default) -``` -Remove-AzureRmDataLakeStoreItemAclEntry [-Account] <String> [-Path] <DataLakeStorePathInstance> - [-Acl] <DataLakeStoreItemAce[]> [-PassThru] [-Recurse] [-Concurrency <Int32>] [-ShowProgress] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RemoveSpecificACE -``` -Remove-AzureRmDataLakeStoreItemAclEntry [-Account] <String> [-Path] <DataLakeStorePathInstance> - [-AceType] <AceType> [[-Id] <Guid>] [-Default] [-PassThru] [-Recurse] [-Concurrency <Int32>] [-ShowProgress] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmDataLakeStoreItemAclEntry** cmdlet removes an entry (ACE) from the access control list (ACL) of a file or folder in Data Lake Store. - -## EXAMPLES - -### Example 1: Remove a user entry -``` -PS C:\>Remove-AzureRmDataLakeStoreItemAclEntry -AccountName "ContosoADL" -Path / -AceType User -Id (Get-AzureRmADUser -Mail "PattiFuller@contoso.com").ObjectId -``` - -This command removes the user ACE for Patti Fuller from the ContosoADL account. - -### Example 2: Remove a user entry recursively -``` -PS C:\>Remove-AzureRmDataLakeStoreItemAclEntry -AccountName "ContosoADL" -Path / -AceType User -Id (Get-AzureRmADUser -Mail "PattiFuller@contoso.com").ObjectId -Recurse -Concurrency 128 -``` - -### Example 3: Remove permissions for an ACE recursively using Acl object -``` -PS C:\>$fullAcl="user:userid1,default:user:userid1 -PS C:\>$newFullAcl = $fullAcl.Split("{,}") -PS C:\>Remove-AzureRmDataLakeStoreItemAclEntry -AccountName "ContosoADL" -Path / -Acl $newFullAcl -Recurse -Concurrency 128 -``` - -This command removes the user ACE for Patti Fuller from the root and recursively from all it's subdirectories and files for account ContosoADL. - -## PARAMETERS - -### -Account -Specifies the name of the Data Lake Store account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AceType -Specifies the type of ACE to remove. -The acceptable values for this parameter are: -- User -- Group -- Mask -- Other - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreEnums+AceType -Parameter Sets: RemoveSpecificACE -Aliases: -Accepted values: User, Group, Mask, Other - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Acl -Specifies the ACL object that contains the entries to be removed. - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreItemAce[] -Parameter Sets: RemoveByACLObject -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Concurrency -Number of files/directories processed in parallel. Optional: a reasonable default will be selected - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Default -Indicates that this operation removes the default ACE from the specified ACL. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: RemoveSpecificACE -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the object ID of the AzureActive Directory user, group, or service principal for which to remove an ACE. - -```yaml -Type: System.Guid -Parameter Sets: RemoveSpecificACE -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates a boolean response should be returned indicating the result of the delete operation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the Data Lake Store path of the item from which to remove an ACE, starting with the root directory (/). - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Recurse -Indicates the ACL to be removed recursively to the child subdirectories and files - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ShowProgress -If passed then progress status is showed. Only applicable when recursive Acl remove is done. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreItemAce[] - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreEnums+AceType - -### System.Guid - -### System.Management.Automation.SwitchParameter - -### System.Int32 - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Set-AzureRmDataLakeStoreItemAclEntry](./Set-AzureRmDataLakeStoreItemAclEntry.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Remove-AzureRmDataLakeStoreTrustedIdProvider.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Remove-AzureRmDataLakeStoreTrustedIdProvider.md deleted file mode 100644 index 887d7043b5..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Remove-AzureRmDataLakeStoreTrustedIdProvider.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -ms.assetid: 30C10687-F172-4663-8D4A-F0DDEA5C3741 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/remove-azurermdatalakestoretrustedidprovider -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Remove-AzureRmDataLakeStoreTrustedIdProvider.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Remove-AzureRmDataLakeStoreTrustedIdProvider.md ---- - -# Remove-AzureRmDataLakeStoreTrustedIdProvider - -## SYNOPSIS -Removes the specified trusted identity provider in the specified Data Lake Store. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmDataLakeStoreTrustedIdProvider [-Account] <String> [[-Name] <String>] [-PassThru] - [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmDataLakeStoreTrustedIdProvider** cmdlet removes the specified trusted identity provider in the specified Data Lake Store. - -## EXAMPLES - -### Example 1: Remove a trusted identity provider. -``` -PS C:\> Remove-AzureRmDataLakeStoreTrustedIdProvider -AccountName "ContosoADL" -Name MyProvider -``` - -Removes the provider "MyProvider" from account "ContosoADL" - -## PARAMETERS - -### -Account -The Data Lake Store account to remove the trusted identity provider from - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the trusted identity provider. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates a boolean response should be returned indicating the result of the delete operation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the account to remove the trusted identity provider from. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Remove-AzureRmDataLakeStoreVirtualNetworkRule.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Remove-AzureRmDataLakeStoreVirtualNetworkRule.md deleted file mode 100644 index 8e94fcc82b..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Remove-AzureRmDataLakeStoreVirtualNetworkRule.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/remove-azurermdatalakestorevirtualnetworkrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Remove-AzureRmDataLakeStoreVirtualNetworkRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Remove-AzureRmDataLakeStoreVirtualNetworkRule.md ---- - -# Remove-AzureRmDataLakeStoreVirtualNetworkRule - -## SYNOPSIS -Removes the specified virtual network rule in the specified Data Lake Store. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmDataLakeStoreVirtualNetworkRule [-Account] <String> -Name <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmDataLakeStoreVirtualNetworkRule** cmdlet removes the specified virtual network rule in the specified Data Lake Store. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-AzureRmDataLakeStoreVirtualNetworkRule -Account "dls" -Name "myVNET" -``` - -Removes virtual network rule "myVNET" from account "dls" - -## PARAMETERS - -### -Account -The Data Lake Store account to update the virtual network rule in - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the virtual network rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates a boolean response should be returned indicating the result of the delete operation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreAccount.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreAccount.md deleted file mode 100644 index 21fb867061..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreAccount.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -ms.assetid: 0EB5C25C-D0A1-4444-AEA2-C963D5069CFC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/set-azurermdatalakestoreaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Set-AzureRmDataLakeStoreAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Set-AzureRmDataLakeStoreAccount.md ---- - -# Set-AzureRmDataLakeStoreAccount - -## SYNOPSIS -Modifies a Data Lake Store account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmDataLakeStoreAccount [-Name] <String> [[-DefaultGroup] <String>] [[-Tag] <Hashtable>] - [[-TrustedIdProviderState] <TrustedIdProviderState>] [[-FirewallState] <FirewallState>] - [[-ResourceGroupName] <String>] [-Tier <TierType>] [-AllowAzureIpState <FirewallAllowAzureIpsState>] - [-KeyVersion <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDataLakeStoreAccount** cmdlet modifies a Data Lake Store account. - -## EXAMPLES - -### Example 1: Add a tag to an account -``` -PS C:\>Set-AzureRmDataLakeStoreAccount -Name "ContosoADL" -Tags @{"stage"="production"} -``` - -This command adds the specified tag to the Data Lake Store account named ContosoADL. - -## PARAMETERS - -### -AllowAzureIpState -Optionally allow/block Azure originating IPs through the firewall. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.DataLake.Store.Models.FirewallAllowAzureIpsState] -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultGroup -Specifies the ID of an AzureActive Directory group. -This group is the default group for files and folders that you create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FirewallState -Optionally enable or disable existing firewall rules. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.DataLake.Store.Models.FirewallState] -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyVersion -If the encryption type is User assigned, the user can rotate their key version with this parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a Data Lake Store account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the Data Lake Store account to modify. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Specifies tags as key-value pairs. -You can use tags to identify a Data Lake Store account from other Azure resources. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tier -The desired commitment tier for this account to use. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.DataLake.Store.Models.TierType] -Parameter Sets: (All) -Aliases: -Accepted values: Consumption, Commitment1TB, Commitment10TB, Commitment100TB, Commitment500TB, Commitment1PB, Commitment5PB - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TrustedIdProviderState -Optionally enable or disable the existing trusted ID providers. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.DataLake.Store.Models.TrustedIdProviderState] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -### System.Nullable`1[[Microsoft.Azure.Management.DataLake.Store.Models.TrustedIdProviderState, Microsoft.Azure.Management.DataLake.Store, Version=2.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -### System.Nullable`1[[Microsoft.Azure.Management.DataLake.Store.Models.FirewallState, Microsoft.Azure.Management.DataLake.Store, Version=2.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -### System.Nullable`1[[Microsoft.Azure.Management.DataLake.Store.Models.TierType, Microsoft.Azure.Management.DataLake.Store, Version=2.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -### System.Nullable`1[[Microsoft.Azure.Management.DataLake.Store.Models.FirewallAllowAzureIpsState, Microsoft.Azure.Management.DataLake.Store, Version=2.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -## OUTPUTS - -### Microsoft.Azure.Commands.DataLakeStore.Models.PSDataLakeStoreAccount - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDataLakeStoreAccount](./Get-AzureRmDataLakeStoreAccount.md) - -[New-AzureRmDataLakeStoreAccount](./New-AzureRmDataLakeStoreAccount.md) - -[Remove-AzureRmDataLakeStoreAccount](./Remove-AzureRmDataLakeStoreAccount.md) - -[Test-AzureRmDataLakeStoreAccount](./Test-AzureRmDataLakeStoreAccount.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreFirewallRule.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreFirewallRule.md deleted file mode 100644 index 3f86b98fbf..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreFirewallRule.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -ms.assetid: 9983EA1E-2515-4F5D-8476-8D0EE9837E88 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/set-azurermdatalakestorefirewallrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Set-AzureRmDataLakeStoreFirewallRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Set-AzureRmDataLakeStoreFirewallRule.md ---- - -# Set-AzureRmDataLakeStoreFirewallRule - -## SYNOPSIS -Modifies the specified firewall rule in the specified Data Lake Store. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmDataLakeStoreFirewallRule [-Account] <String> [-Name] <String> [[-StartIpAddress] <String>] - [[-EndIpAddress] <String>] [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDataLakeStoreFirewallRule** cmdlet modifies the specified firewall rule in the specified Data Lake Store. - -## EXAMPLES - -### Example 1: Update the start and end IP range for a firewall rule -``` -PS C:\> Set-AzureRmDataLakeStoreFirewallRule -AccountName "ContosoADL" -Name MyFirewallRule -StartIpAddress "127.0.0.1" -EndIpAddress "127.0.0.2" -``` - -Updates the firewall rule "MyFirewallRule" in account "ContosoADL" to have a range of 127.0.0.1 - 127.0.0.2 - -## PARAMETERS - -### -Account -The Data Lake Store account to update the firewall rule in - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndIpAddress -The end of the valid ip range for the firewall rule - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The name of the firewall rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the account to update the firewall rule for. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartIpAddress -The start of the valid ip range for the firewall rule - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreFirewallRule - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreItemAcl.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreItemAcl.md deleted file mode 100644 index 5df18cc578..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreItemAcl.md +++ /dev/null @@ -1,224 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -ms.assetid: FFB335D4-AE3E-4788-B6FD-9AFC36F52B61 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/set-azurermdatalakestoreitemacl -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Set-AzureRmDataLakeStoreItemAcl.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Set-AzureRmDataLakeStoreItemAcl.md ---- - -# Set-AzureRmDataLakeStoreItemAcl - -## SYNOPSIS -Modifies the ACL of a file or folder in Data Lake Store. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmDataLakeStoreItemAcl [-Account] <String> [-Path] <DataLakeStorePathInstance> - [-Acl] <DataLakeStoreItemAce[]> [-PassThru] [-Recurse] [-Concurrency <Int32>] [-ShowProgress] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDataLakeStoreItemAcl** cmdlet modifies the access control list (ACL) of a file or folder in Data Lake Store. - -## EXAMPLES - -### Example 1: Set the ACL for a file and a folder -``` -PS C:\>$ACL = Get-AzureRmDataLakeStoreItemAclEntry -AccountName "ContosoADL" -Path / -PS C:\> Set-AzureRmDataLakeStoreItemAcl -AccountName "ContosoADL" -Path "/MyFiles/Test.txt" -Acl $ACL -``` - -The first command gets the ACL for the root directory of the ContosoADL account, and then stores it in the $ACL variable. -The second command sets the ACL for the file Test.txt to the one in $ACL. - -### Example 2: Set the ACL for folder recursively -``` -PS C:\>$ACL = Get-AzureRmDataLakeStoreItemAclEntry -AccountName "ContosoADL" -Path /Folder1 -PS C:\> Set-AzureRmDataLakeStoreItemAcl -AccountName "ContosoADL" -Path "/Folder2" -Acl $ACL -Recurse -Concurrency 128 -``` - -The first command gets the ACL for the directory Folder1 of the ContosoADL account, and then stores it in the $ACL variable. -The second command sets the ACL recursively to Folder2 and its sub directories and files to the one in $ACL. - -## PARAMETERS - -### -Account -Specifies the name of the Data Lake Store account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Acl -Specifies an ACL for a file or a folder. - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreItemAce[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Concurrency -Number of files/directories processed in parallel. Optional: a reasonable default will be selected. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Indicates the resulting ACL should be returned. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the Data Lake Store path of the file or folder, starting with the root directory (/). - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Recurse -Indicates the ACL to be set recursively to the child subdirectories and files - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ShowProgress -If passed then progress status is showed. Only applicable when recursive Acl set is done. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreItemAce[] - -### System.Management.Automation.SwitchParameter - -### System.Int32 - -## OUTPUTS - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreItemAce -If PassThru is specified, will return the resulting list of ACL entries. - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreItemAclEntry.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreItemAclEntry.md deleted file mode 100644 index be081a3bc7..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreItemAclEntry.md +++ /dev/null @@ -1,321 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -ms.assetid: 0671D833-8B3A-4480-A576-92F1A9E8CE92 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/set-azurermdatalakestoreitemaclentry -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Set-AzureRmDataLakeStoreItemAclEntry.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Set-AzureRmDataLakeStoreItemAclEntry.md ---- - -# Set-AzureRmDataLakeStoreItemAclEntry - -## SYNOPSIS -Modifies an entry in the ACL of a file or folder in Data Lake Store. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByACLObject (Default) -``` -Set-AzureRmDataLakeStoreItemAclEntry [-Account] <String> [-Path] <DataLakeStorePathInstance> - [-Acl] <DataLakeStoreItemAce[]> [-PassThru] [-Recurse] [-Concurrency <Int32>] [-ShowProgress] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetSpecificACE -``` -Set-AzureRmDataLakeStoreItemAclEntry [-Account] <String> [-Path] <DataLakeStorePathInstance> - [-AceType] <AceType> [[-Id] <Guid>] [-Permissions] <Permission> [-Default] [-PassThru] [-Recurse] - [-Concurrency <Int32>] [-ShowProgress] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDataLakeStoreItemAclEntry** cmdlet modifies an entry (ACE) in the access control list (ACL) of a file or folder in Data Lake Store. - -## EXAMPLES - -### Example 1: Modify permissions for an ACE -``` -PS C:\>Set-AzureRmDataLakeStoreItemAclEntry -AccountName "ContosoADL" -Path / -AceType User -Id (Get-AzureRmADUser -Mail "PattiFuller@contoso.com").ObjectId -Permissions All -``` - -This command modifies the ACE for Patti Fuller to have all permissions. - -### Example 2: Modify permissions for an ACE recursively -``` -PS C:\>Set-AzureRmDataLakeStoreItemAclEntry -AccountName "ContosoADL" -Path / -AceType User -Id (Get-AzureRmADUser -Mail "PattiFuller@contoso.com").ObjectId -Permissions All -Recurse -Concurrency 128 -``` - -### Example 3: Modify permissions for an ACE recursively using Acl object -``` -PS C:\>$fullAcl="user:userid1:--x,default:user:userid1:--x" -PS C:\>$newFullAcl = $fullAcl.Split("{,}") -PS C:\>Set-AzureRmDataLakeStoreItemAclEntry -AccountName "ContosoADL" -Path / -Acl $newFullAcl -Recurse -Concurrency 128 -``` - -This command recursively modifies the ACE for Patti Fuller to have all permissions to root and all its subdirectories and files. - -## PARAMETERS - -### -Account -Specifies the name of the Data Lake Store account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AceType -Specifies the type of ACE to modify. -The acceptable values for this parameter are: -- User -- Group -- Mask -- Other - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreEnums+AceType -Parameter Sets: SetSpecificACE -Aliases: -Accepted values: User, Group, Mask, Other - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Acl -Specifies the ACL object that contains the entries to modify. - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreItemAce[] -Parameter Sets: SetByACLObject -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Concurrency -Number of files/directories processed in parallel. Optional: a reasonable default will be selected - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Default -Indicates that this operation modifies the default ACE from the specified ACL. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: SetSpecificACE -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the object ID of the AzureActive Directory user, group, or service principal for which to modify an ACE. - -```yaml -Type: System.Guid -Parameter Sets: SetSpecificACE -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates the resulting ACL should be returned. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the Data Lake Store path of the item for which to modify an ACE, starting with the root directory (/). - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Permissions -Specifies the permissions for the ACE. -The acceptable values for this parameter are: -- None -- Execute -- Write -- WriteExecute -- Read -- ReadExecute -- ReadWrite -- All - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreEnums+Permission -Parameter Sets: SetSpecificACE -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Recurse -Indicates the ACL to be modified recursively to the child subdirectories and files - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ShowProgress -If passed then progress status is showed. Only applicable when recursive Acl modify is done. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreItemAce[] - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreEnums+AceType - -### System.Guid - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreEnums+Permission - -### System.Management.Automation.SwitchParameter - -### System.Int32 - -## OUTPUTS - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreItemAce -If PassThru is specified, will return the resulting list of ACL entries. - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmDataLakeStoreItemAclEntry](./Remove-AzureRmDataLakeStoreItemAclEntry.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreItemExpiry.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreItemExpiry.md deleted file mode 100644 index c345e6ccf6..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreItemExpiry.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/set-azurermdatalakestoreitemexpiry -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Set-AzureRmDataLakeStoreItemExpiry.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Set-AzureRmDataLakeStoreItemExpiry.md ---- - -# Set-AzureRmDataLakeStoreItemExpiry - -## SYNOPSIS -Sets or removes the expire time for a file in an Azure Data Lake Store account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetAbsoluteNeverExpireExpiry (Default) -``` -Set-AzureRmDataLakeStoreItemExpiry [-Account] <String> [-Path] <DataLakeStorePathInstance> - [[-Expiration] <DateTimeOffset>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### SetRelativeExpiry -``` -Set-AzureRmDataLakeStoreItemExpiry [-Account] <String> [-Path] <DataLakeStorePathInstance> - [-RelativeFileExpiryOption] <PathRelativeExpiryOptions> [[-RelativeTime] <Int64>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDataLakeStoreItemExpiry** cmdlet sets or removes the expire time for a file in an Azure Data Lake Store account. - -## EXAMPLES - -### Example 1: Set the expiration time for a file -``` -PS C:\> Set-AzureRmDataLakeStoreItemExpiry -AccountName "ContosoADL" -Path /myfile.txt -Expiration [DateTimeOffset]::Now.AddHours(2) -``` - -Sets expiration on the file myfile.txt in account ContosoADL to be two hours from now. -This will cause the file to expire (be marked for delete) in two hours. - -### Example 2: Remove the expiration on a file -``` -PS C:\> Set-AzureRmDataLakeStoreItemExpiry -AccountName "ContosoADL" -Path /myfile.txt -``` - -Removes any expiration that was previously set on file 'myfile.txt' in account 'ContosoADL'. -This means the file will not automatically expire (be marked for delete) and will need to be manually deleted or set to expire again. - -### Example 3: Set expiration time for a file relative to now -``` -PS C:\> Set-AdlStoreItemExpiry -Account "ContosoADL" -path /myfile.txt -RelativeFileExpiryOption RelativeToNow -RelativeTime 240000 -PS C:\> Set-AdlStoreItemExpiry -Account "ContosoADL" -path /myfile.txt -RelativeFileExpiryOption RelativeToCreationDate -RelativeTime 240000 -``` - -The first command sets the expiration time of the file /myfile.txt 240 seconds relative to current time at server. -The second command sets the expiration time of the file /myfile.txt 240 seconds relative to creation time at server. - -## PARAMETERS - -### -Account -Specifies the Data Lake Store account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expiration -The absolute expiration time for the specified file. -If no value or set to MaxValue, the file will never expire. - -```yaml -Type: System.DateTimeOffset -Parameter Sets: SetAbsoluteNeverExpireExpiry -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the Data Lake Store path of the file item for which to set or remove expiry. - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RelativeFileExpiryOption -Relative expiry options. RelativeToNow or RelativeToCreationDate are current options - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreEnums+PathRelativeExpiryOptions -Parameter Sets: SetRelativeExpiry -Aliases: -Accepted values: RelativeToNow, RelativeToCreationDate - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RelativeTime -The relative time in milliseconds with respect to now or creation time - -```yaml -Type: System.Int64 -Parameter Sets: SetRelativeExpiry -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance - -### System.DateTimeOffset - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreEnums+PathRelativeExpiryOptions - -### System.Int64 - -## OUTPUTS - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreItem - -## NOTES -Alias: Set-AdlStoreItemExpiry - -## RELATED LINKS - -[Get-AzureRmDataLakeStoreItem](./Get-AzureRmDataLakeStoreItem.md) - diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreItemOwner.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreItemOwner.md deleted file mode 100644 index 0b7867226a..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreItemOwner.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -ms.assetid: 415C5854-FE03-4D4E-BE84-408EA5F95E34 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/set-azurermdatalakestoreitemowner -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Set-AzureRmDataLakeStoreItemOwner.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Set-AzureRmDataLakeStoreItemOwner.md ---- - -# Set-AzureRmDataLakeStoreItemOwner - -## SYNOPSIS -Modifies the owner of a file or folder in Data Lake Store. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmDataLakeStoreItemOwner [-Account] <String> [-Path] <DataLakeStorePathInstance> [-Type] <Owner> - [-Id] <Guid> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDataLakeStoreItemOwner** cmdlet modifies the owner of a file or folder in Data Lake Store. - -## EXAMPLES - -### Example 1: Set the owner for an item -``` -PS C:\>Set-AzureRmDataLakeStoreItemOwner -AccountName "ContosoADL" -Path / -Type User -Id (Get-AzureRmADUser -Mail "PattiFuller@contoso.com").ObjectId -``` - -This command sets the owner for the root directory to Patti Fuller. - -## PARAMETERS - -### -Account -Specifies the name of the Data Lake Store account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the object ID of the AzureActive Directory user, group, or service principal to use as the owner. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates the resulting updated owner should be returned. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the Data Lake Store path of the item to modify, starting with the root directory (/). - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Type -Specifies the type of owner to set. -The acceptable values for this parameter are: User and Group. - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreEnums+Owner -Parameter Sets: (All) -Aliases: -Accepted values: User, Group - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreEnums+Owner - -### System.Guid - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDataLakeStoreItemOwner](./Get-AzureRmDataLakeStoreItemOwner.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreItemPermission.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreItemPermission.md deleted file mode 100644 index cf8dff8312..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreItemPermission.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -ms.assetid: 6ACE045E-67AD-40FE-86E4-450AF522F174 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/set-azurermdatalakestoreitempermission -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Set-AzureRmDataLakeStoreItemPermission.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Set-AzureRmDataLakeStoreItemPermission.md ---- - -# Set-AzureRmDataLakeStoreItemPermission - -## SYNOPSIS -Modifies the permission octal of a file or folder in Data Lake Store. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmDataLakeStoreItemPermission [-Account] <String> [-Path] <DataLakeStorePathInstance> - [-Permission] <Int32> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDataLakeStoreItemPermission** cmdlet modifies the permission octal of a file or folder in Data Lake Store. - -## EXAMPLES - -### Example 1: Set the permission octal for an item -``` -PS C:\>Set-AzureRmDataLakeStoreItemPermission -AccountName "ContosoADL" -Path "/file.txt" -Permission 0770 -``` - -This command sets the permission octal for a file to 0770, which translates to clearing the sticky bit, setting read/write/execute permissions for the owner of the file, setting read/write/execute permissions for the owning group of the file, and clearing read/write/execute permissions for other. - -## PARAMETERS - -### -Account -Specifies the Data Lake Store account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the Data Lake Store path of the file or folder, starting with the root directory (/). - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Permission -The permissions to set for the file or folder, expressed as an octal (e.g. -'777') - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance - -### System.Int32 - -## OUTPUTS - -### System.Boolean - -## NOTES -* Alias: Set-AdlStoreItemPermission - -## RELATED LINKS - -[Get-AzureRmDataLakeStoreItemPermission](./Get-AzureRmDataLakeStoreItemPermission.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreTrustedIdProvider.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreTrustedIdProvider.md deleted file mode 100644 index 49387a00f7..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreTrustedIdProvider.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -ms.assetid: BDEF8BAA-0C64-465D-9ED4-6FEFC1E850CC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/set-azurermdatalakestoretrustedidprovider -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Set-AzureRmDataLakeStoreTrustedIdProvider.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Set-AzureRmDataLakeStoreTrustedIdProvider.md ---- - -# Set-AzureRmDataLakeStoreTrustedIdProvider - -## SYNOPSIS -Modifies the specified trusted identity provider in the specified Data Lake Store. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmDataLakeStoreTrustedIdProvider [-Account] <String> [-Name] <String> [-ProviderEndpoint] <String> - [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDataLakeStoreTrustedIdProvider** cmdlet modifies the specified trusted identity provider in the specified Data Lake Store. - -## EXAMPLES - -### Example 1: Update a Trusted Identity Provider Endpoint -``` -PS C:\> Set-AzureRmDataLakeStoreTrustedIdProvider -AccountName "ContosoADL" -Name MyProvider -ProviderEndpoint "https://sts.windows.net/6b04908c-b91f-40ce-8024-7ee8a4fd6150" -``` - -This updates the provider endpoing for firewall rule "MyProvider" in account "ContosoADL" to "https://sts.windows.net/6b04908c-b91f-40ce-8024-7ee8a4fd6150" - -## PARAMETERS - -### -Account -The Data Lake Store account to add the trusted identity provider to - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the trusted identity provider. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProviderEndpoint -The valid trusted provider endpoint in the format: https://sts.windows.net/\<provider identity\> - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the account to update the trusted identity provider for. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreTrustedIdProvider - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreVirtualNetworkRule.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreVirtualNetworkRule.md deleted file mode 100644 index 3fd446248a..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Set-AzureRmDataLakeStoreVirtualNetworkRule.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/set-azurermdatalakestorevirtualnetworkrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Set-AzureRmDataLakeStoreVirtualNetworkRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Set-AzureRmDataLakeStoreVirtualNetworkRule.md ---- - -# Set-AzureRmDataLakeStoreVirtualNetworkRule - -## SYNOPSIS -Modifies the specified virtual network rule in the specified Data Lake Store. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmDataLakeStoreVirtualNetworkRule [-Account] <String> [-Name] <String> [-SubnetId <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDataLakeStoreVirtualNetworkRule** cmdlet modifies the specified virtual network rule in the specified Data Lake Store. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Set-AzureRmDataLakeStoreVirtualNetworkRule -Account "dls" -Name "myVNET" -SubnetId "updatedId" - -ResourceGroupName : -AccountName : -VirtualNetworkRuleName : myVNET -VirtualNetworkSubnetId : /subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.Network/virtualNetworks/myVNET/subnets/updatedId -IgnoreMissingVnetServiceEndpoint : -State : -``` - -Updates the subnet id of virtual network rule "myVNET" in account "dls" to "updatedId" - -## PARAMETERS - -### -Account -The Data Lake Store account to update the virtual network rule in - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the virtual network rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubnetId -The start of the valid ip range for the virtual network rule - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreVirtualNetworkRule - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Test-AzureRmDataLakeStoreAccount.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Test-AzureRmDataLakeStoreAccount.md deleted file mode 100644 index 3cab010175..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Test-AzureRmDataLakeStoreAccount.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -ms.assetid: 613DE097-65E0-4F08-839D-F9B53F772382 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/test-azurermdatalakestoreaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Test-AzureRmDataLakeStoreAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Test-AzureRmDataLakeStoreAccount.md ---- - -# Test-AzureRmDataLakeStoreAccount - -## SYNOPSIS -Tests the existence of a Data Lake Store account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Test-AzureRmDataLakeStoreAccount [-Name] <String> [[-ResourceGroupName] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Test-AzureRmDataLakeStoreAccount** cmdlet tests the existence of a Data Lake Store account. - -## EXAMPLES - -### Example 1: Test an account -``` -PS C:\>Test-AzureRmDataLakeStoreAccount -Name "ContosoADL" -``` - -This command tests whether the account named ContosoADL exists. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Data Lake Store account to test. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the account to test. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDataLakeStoreAccount](./Get-AzureRmDataLakeStoreAccount.md) - -[New-AzureRmDataLakeStoreAccount](./New-AzureRmDataLakeStoreAccount.md) - -[Remove-AzureRmDataLakeStoreAccount](./Remove-AzureRmDataLakeStoreAccount.md) - -[Set-AzureRmDataLakeStoreAccount](./Set-AzureRmDataLakeStoreAccount.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataLakeStore/Test-AzureRmDataLakeStoreItem.md b/azurermps-6.13.0/AzureRM.DataLakeStore/Test-AzureRmDataLakeStoreItem.md deleted file mode 100644 index cecec674a8..0000000000 --- a/azurermps-6.13.0/AzureRM.DataLakeStore/Test-AzureRmDataLakeStoreItem.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataLakeStore.dll-Help.xml -Module Name: AzureRM.DataLakeStore -ms.assetid: 0937A390-6AC2-4611-AA6C-99936AC0ABFD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datalakestore/test-azurermdatalakestoreitem -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Test-AzureRmDataLakeStoreItem.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataLakeStore/Commands.DataLakeStore/help/Test-AzureRmDataLakeStoreItem.md ---- - -# Test-AzureRmDataLakeStoreItem - -## SYNOPSIS -Tests the existence of a file or folder in Data Lake Store. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Test-AzureRmDataLakeStoreItem [-Account] <String> [-Path] <DataLakeStorePathInstance> [[-PathType] <PathType>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Test-AzureRmDataLakeStoreItem** cmdlet tests the existence of a file or folder in Data Lake Store. - -## EXAMPLES - -### Example 1: Test a file -``` -PS C:\>Test-AzureRmDataLakeStoreItem -AccountName "ContosoADL" -Path "/MyFiles/Test.csv" -``` - -This command tests whether the file Test.csv exists in the ContosoADL account. - -## PARAMETERS - -### -Account -Specifies the name of the Data Lake Store account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AccountName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the Data Lake Store path of the item to test, starting with the root directory (/). - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PathType -Specifies the type of item to test. -The acceptable values for this parameter are: -- Any -- File -- Folder - -```yaml -Type: Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreEnums+PathType -Parameter Sets: (All) -Aliases: -Accepted values: Any, File, Folder - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance - -### Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStoreEnums+PathType - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Export-AzureRmDataLakeStoreItem](./Export-AzureRmDataLakeStoreItem.md) - -[Get-AzureRmDataLakeStoreItem](./Get-AzureRmDataLakeStoreItem.md) - -[Import-AzureRmDataLakeStoreItem](./Import-AzureRmDataLakeStoreItem.md) - -[Join-AzureRmDataLakeStoreItem](./Join-AzureRmDataLakeStoreItem.md) - -[Move-AzureRmDataLakeStoreItem](./Move-AzureRmDataLakeStoreItem.md) - -[Remove-AzureRmDataLakeStoreItem](./Remove-AzureRmDataLakeStoreItem.md) - - diff --git a/azurermps-6.13.0/AzureRM.DataMigration/AzureRM.DataMigration.md b/azurermps-6.13.0/AzureRM.DataMigration/AzureRM.DataMigration.md deleted file mode 100644 index 21036abc22..0000000000 --- a/azurermps-6.13.0/AzureRM.DataMigration/AzureRM.DataMigration.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -Module Name: AzureRM.DataMigration -Module Guid: 150d9544-6348-4373-806f-10cd0b4de4cb -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.datamigration -Help Version: 0.1.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/AzureRM.DataMigration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/AzureRM.DataMigration.md ---- - -# AzureRM.DataMigration Module -## Description -{{Azure DataMigration Service Module}} - -## AzureRM.DataMigration Cmdlets -### [Get-AzureRmDataMigrationProject](Get-AzureRmDataMigrationProject.md) -Retrieves the properties of an Azure Database Migration project. - -### [Get-AzureRmDataMigrationService](Get-AzureRmDataMigrationService.md) -Retrieves the properties associated with an instance of the Azure Database Migration Service. - -### [Get-AzureRmDataMigrationTask](Get-AzureRmDataMigrationTask.md) -Retrieves the PSProjectTask object associated with an Azure Database Migration Service migration task. - -### [New-AzureRmDataMigrationCommand(Get-AzureRmDataMigrationCommand.md) -Creates a new command to be executed on an existing Azure Database Migration Service migration task. - -### [New-AzureRmDataMigrationConnectionInfo](New-AzureRmDataMigrationConnectionInfo.md) -Creates a new Connection Info object specifying the server type and name for connection. - -### [New-AzureRmDataMigrationDatabaseInfo](New-AzureRmDataMigrationDatabaseInfo.md) -Creates the DatabaseInfo object for the Azure Database Migration Service, which specifies the database source for migration. - -### [New-AzureRmDataMigrationFileShare](New-AzureRmDataMigrationFileShare.md) -Creates the FileShare object for the Azure Database Migration Service, which specifies the local network share to take the source database backups to. - -### [New-AzureRmDataMigrationProject](New-AzureRmDataMigrationProject.md) -Creates a new Azure Database Migration Service project. - -### [New-AzureRmDataMigrationSelectedDB](New-AzureRmDataMigrationSelectedDB.md) -Creates a database input object that contains information about source and target databases for migration. - -### [New-AzureRmDataMigrationService](New-AzureRmDataMigrationService.md) -Creates a new instance of the Azure Database Migration Service. - -### [New-AzureRmDataMigrationSyncSelectedDB](New-AzureRmDataMigrationSyncSelectedDB.md) -Creates a database input object for sync scenarios that contains information about source and target databases for migration. - -### [New-AzureRmDataMigrationTask](New-AzureRmDataMigrationTask.md) -Creates and starts a data migration task in the Azure Database Migration Service. - -### [Remove-AzureRmDataMigrationProject](Remove-AzureRmDataMigrationProject.md) -Removes an Azure Database Migration Service project from Azure. - -### [Remove-AzureRmDataMigrationService](Remove-AzureRmDataMigrationService.md) -Removes an instance of the Azure Database Migration Service from Azure. - -### [Remove-AzureRmDataMigrationTask](Remove-AzureRmDataMigrationTask.md) -Removes an Azure Database Migration Service task from Azure. - -### [Start-AzureRmDataMigrationService](Start-AzureRmDataMigrationService.md) -Starts an instance of the Azure Database Migration Service in a stopped state. - -### [Stop-AzureRmDataMigrationService](Stop-AzureRmDataMigrationService.md) -Stops an instance of the Azure Database Migration Service that is in a running state. - -### [Stop-AzureRmDataMigrationTask](Stop-AzureRmDataMigrationTask.md) -Stops an Azure Database Migration Service task that is in a running state. - diff --git a/azurermps-6.13.0/AzureRM.DataMigration/Get-AzureRmDataMigrationProject.md b/azurermps-6.13.0/AzureRM.DataMigration/Get-AzureRmDataMigrationProject.md deleted file mode 100644 index a960e9eec7..0000000000 --- a/azurermps-6.13.0/AzureRM.DataMigration/Get-AzureRmDataMigrationProject.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataMigration.dll-Help.xml -Module Name: AzureRM.DataMigration -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datamigration/Get-AzureRmDataMigrationProject -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/Get-AzureRmDataMigrationProject.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/Get-AzureRmDataMigrationProject.md ---- - -# Get-AzureRmDataMigrationProject - -## SYNOPSIS -Retrieves the properties of an Azure Database Migration project. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ComponentNameParameterSet (Default) -``` -Get-AzureRmDataMigrationProject -ResourceGroupName <String> -ServiceName <String> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ComponentObjectParameterSet -``` -Get-AzureRmDataMigrationProject [-InputObject] <PSDataMigrationService> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Get-AzureRmDataMigrationProject [-ResourceId] <String> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmDataMigrationProject cmdlet retrieves the properties of an Azure Database Migration project. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmDataMigrationProject -ServiceName testService -Name testProject -ResourceGroup testResourceGroup -``` - -The above example retrieves Azure Database Migration project named TestProject in the resource group called testResourceGroup and under service called testService - -### Example 2 -``` -PS C:\> Get-AzureRmDataMigrationProject -InputObject $myService -``` - -The above example retrieves the Azure Database Migration project based on PSProject object input parameter passed in. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -PSDataMigrationService Object. - -```yaml -Type: Microsoft.Azure.Commands.DataMigration.Models.PSDataMigrationService -Parameter Sets: ComponentObjectParameterSet -Aliases: DataMigrationService - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the project. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ProjectName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -DataMigrationService Resource Id. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceName -Database Migration Service Name. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataMigration.Models.PSDataMigrationService -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataMigration.Models.PSProject - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataMigration/Get-AzureRmDataMigrationService.md b/azurermps-6.13.0/AzureRM.DataMigration/Get-AzureRmDataMigrationService.md deleted file mode 100644 index 6ab4d911b3..0000000000 --- a/azurermps-6.13.0/AzureRM.DataMigration/Get-AzureRmDataMigrationService.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataMigration.dll-Help.xml -Module Name: AzureRM.DataMigration -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datamigration/Get-AzureRmDataMigrationService -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/Get-AzureRmDataMigrationService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/Get-AzureRmDataMigrationService.md ---- - -# Get-AzureRmDataMigrationService - -## SYNOPSIS -Retrieves the properties associated with an instance of the Azure Database Migration Service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceGroupSet (Default) -``` -Get-AzureRmDataMigrationService [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Get-AzureRmDataMigrationService [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ServiceNameGroupSet -``` -Get-AzureRmDataMigrationService [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmDataMigrationService cmdlet retrieves the properties associated with an instance of the Azure Database Migration Service based on Service name and Azure Resource Group name as input parameters. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmDataMigrationService -ResourceGroupName testResourceGroup -Name testService -``` - -The above example retrieves the properties of the Azure Database Migration Service instance called testService. - -### Example 2 -``` -PS C:\> Get-AzureRmDataMigrationService -ResourceGroupName testResourceGroup -``` - -The above example retrieves Azure Database Migration Services in the resource group called testResourceGroup. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of Database Migration Service. - -```yaml -Type: System.String -Parameter Sets: ServiceNameGroupSet -Aliases: ServiceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupSet -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ServiceNameGroupSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -DataMigrationService Resource Id. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataMigration.Models.PSDataMigrationService - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataMigration/Get-AzureRmDataMigrationTask.md b/azurermps-6.13.0/AzureRM.DataMigration/Get-AzureRmDataMigrationTask.md deleted file mode 100644 index b4d3cd56ec..0000000000 --- a/azurermps-6.13.0/AzureRM.DataMigration/Get-AzureRmDataMigrationTask.md +++ /dev/null @@ -1,311 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataMigration.dll-Help.xml -Module Name: AzureRM.DataMigration -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datamigration/Get-AzureRmDataMigrationTask -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/Get-AzureRmDataMigrationTask.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/Get-AzureRmDataMigrationTask.md ---- - -# Get-AzureRmDataMigrationTask - -## SYNOPSIS -Retrieves the PSProjectTask object associated with an Azure Database Migration Service migration task. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ListByComponent (Default) -``` -Get-AzureRmDataMigrationTask -ResourceGroupName <String> -ServiceName <String> -ProjectName <String> - [-TaskType <TaskTypeEnum>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ListByInputObject -``` -Get-AzureRmDataMigrationTask [-InputObject] <PSProject> [-TaskType <TaskTypeEnum>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetByInputObject -``` -Get-AzureRmDataMigrationTask [-InputObject] <PSProject> -Name <String> [-Expand] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetByInputObjectResultType -``` -Get-AzureRmDataMigrationTask [-InputObject] <PSProject> -Name <String> [-Expand] -ResultType <ResultTypeEnum> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ListByResourceId -``` -Get-AzureRmDataMigrationTask [-ResourceId] <String> [-TaskType <TaskTypeEnum>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetByResourceId -``` -Get-AzureRmDataMigrationTask [-ResourceId] <String> -Name <String> [-Expand] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetByResourceIdResultType -``` -Get-AzureRmDataMigrationTask [-ResourceId] <String> -Name <String> [-Expand] -ResultType <ResultTypeEnum> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetByComponent -``` -Get-AzureRmDataMigrationTask -ResourceGroupName <String> -ServiceName <String> -ProjectName <String> - [-Name <String>] [-Expand] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetByComponentResultType -``` -Get-AzureRmDataMigrationTask -ResourceGroupName <String> -ServiceName <String> -ProjectName <String> - -Name <String> [-Expand] -ResultType <ResultTypeEnum> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmDataMigrationTask cmdlet retrieves the properties associated with an Azure Database Migration Service migration task. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get -AzureRmDataMigrationTask -TaskName myTestTask -ServiceName myTestService -ProjectName MyTestProject -ResourceGroupName MyResourceGroup -Expand -``` - -The above example illustrates the use of Get-AzureRmDataMigrationTask cmdlet to retrieve the properties associated with an Azure Database Migration Service migration task based on task name passed in as input parameter - -### Example 2 -``` -PS C:\> Get -AzureRmDataMigrationTask -Project $myProject -``` - -The above example illustrates the use of Get-AzureRmDataMigrationTask cmdlet to retrieve all of the migration tasks associated with PSProject object passed in as input parameter - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expand -Expand output - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: GetByInputObject, GetByResourceId, GetByComponent -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: GetByInputObjectResultType, GetByResourceIdResultType, GetByComponentResultType -Aliases: - -Required: True -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -PSProject Object. - -```yaml -Type: Microsoft.Azure.Commands.DataMigration.Models.PSProject -Parameter Sets: ListByInputObject -Aliases: Project - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -```yaml -Type: Microsoft.Azure.Commands.DataMigration.Models.PSProject -Parameter Sets: GetByInputObject, GetByInputObjectResultType -Aliases: Project - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the task. - -```yaml -Type: System.String -Parameter Sets: GetByInputObject, GetByInputObjectResultType, GetByResourceId, GetByResourceIdResultType, GetByComponentResultType -Aliases: TaskName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: GetByComponent -Aliases: TaskName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -The name of the project. - -```yaml -Type: System.String -Parameter Sets: ListByComponent, GetByComponent, GetByComponentResultType -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: ListByComponent, GetByComponent, GetByComponentResultType -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Project Resource Id. - -```yaml -Type: System.String -Parameter Sets: ListByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: GetByResourceId, GetByResourceIdResultType -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResultType -Expand output of given result type. - -```yaml -Type: Microsoft.Azure.Commands.DataMigration.Models.ResultTypeEnum -Parameter Sets: GetByInputObjectResultType, GetByResourceIdResultType, GetByComponentResultType -Aliases: -Accepted values: MigrationLevelOutput, DatabaseLevelOutput, TableLevelOutput, MigrationValidationOutput, MigrationValidationDatabaseLevelOutput, LoginLevelOutput, AgentJobLevelOutput - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceName -Database Migration Service Name. - -```yaml -Type: System.String -Parameter Sets: ListByComponent, GetByComponent, GetByComponentResultType -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TaskType -Filter by TaskType. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Commands.DataMigration.Models.TaskTypeEnum] -Parameter Sets: ListByComponent, ListByInputObject, ListByResourceId -Aliases: -Accepted values: MigrateSqlServerSqlDb, ConnectToSourceSqlServer, ConnectToTargetSqlDb, GetUserTablesSql, ConnectToTargetSqlDbMi, MigrateSqlServerSqlDbMi, ValidateSqlServerSqlDbMi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataMigration.Models.PSProject -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataMigration.Models.PSProjectTask - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataMigration/Invoke-AzureRmDataMigrationCommand.md b/azurermps-6.13.0/AzureRM.DataMigration/Invoke-AzureRmDataMigrationCommand.md deleted file mode 100644 index 2e37ce235d..0000000000 --- a/azurermps-6.13.0/AzureRM.DataMigration/Invoke-AzureRmDataMigrationCommand.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataMigration.dll-Help.xml -Module Name: AzureRM.DataMigration -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datamigration/Invoke-AzureRmDataMigrationCommand -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/Invoke-AzureRmDataMigrationCommand.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/Invoke-AzureRmDataMigrationCommand.md ---- - -# Invoke-AzureRmDataMigrationCommand - -## SYNOPSIS -Creates a new command to be executed on an existing DMS task. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Invoke-AzureRmDataMigrationCommand -CommandType <String> -ResourceGroupName <String> -ServiceName <String> - -ProjectName <String> -TaskName <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmDataMigrationCommand cmdlet creates a new command task to be run on an existing migration task. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $command = New-AzureRmDmsCommand -CommandType Complete -ResourceGroupName $rg.ResourceGroupName -ServiceName $service.Name -ProjectName -TaskName $taskName -DatabaseName $output.DatabaseName -``` - -The above examples uses the New-AzureRmDmsCommand cmdlet to create a command for an existing service, project, and task - -## PARAMETERS - -### -CommandType -Command Type. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -The name of the project. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceName -Database Migration Service Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TaskName -The name of the task the command is run on. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.DataMigration.Models.CommandProperties - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataMigration/New-AzureRmDataMigrationConnectionInfo.md b/azurermps-6.13.0/AzureRM.DataMigration/New-AzureRmDataMigrationConnectionInfo.md deleted file mode 100644 index 0d7acbeba0..0000000000 --- a/azurermps-6.13.0/AzureRM.DataMigration/New-AzureRmDataMigrationConnectionInfo.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataMigration.dll-Help.xml -Module Name: AzureRM.DataMigration -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datamigration/New-AzureRmDataMigrationConnectionInfo -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/New-AzureRmDataMigrationConnectionInfo.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/New-AzureRmDataMigrationConnectionInfo.md ---- - -# New-AzureRmDataMigrationConnectionInfo - -## SYNOPSIS -Creates a new Connection Info object specifying the server type and name for connection. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmDataMigrationConnectionInfo -ServerType <ServerTypeEnum> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmDataMigrationConnectionInfo cmdlet creates new a Connection Info object specifying the server type for connection. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmDmsConnInfo -ServerType SQL -DataSource mySourceServer -AuthType SqlAuthentication -TrustServerCertificate:$true -``` - -The preceding example creates a new Connection Info object providing SQL as ServerType parameter. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerType -Enum that describes server type to connect to. Currently supported values are SQL for SQL Server, Azure SQL Managed Instance and Azure SQL Database. - -```yaml -Type: Microsoft.Azure.Commands.DataMigration.Models.ServerTypeEnum -Parameter Sets: (All) -Aliases: -Accepted values: SQL - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Management.DataMigration.Models.ConnectionInfo - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataMigration/New-AzureRmDataMigrationDatabaseInfo.md b/azurermps-6.13.0/AzureRM.DataMigration/New-AzureRmDataMigrationDatabaseInfo.md deleted file mode 100644 index c3b81e75eb..0000000000 --- a/azurermps-6.13.0/AzureRM.DataMigration/New-AzureRmDataMigrationDatabaseInfo.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataMigration.dll-Help.xml -Module Name: AzureRM.DataMigration -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datamigration/New-AzureRmDataMigrationDatabaseInfo -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/New-AzureRmDataMigrationDatabaseInfo.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/New-AzureRmDataMigrationDatabaseInfo.md ---- - -# New-AzureRmDataMigrationDatabaseInfo - -## SYNOPSIS -Creates the DatabaseInfo object for the Azure Database Migration Service, which specifies the database source for migration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmDataMigrationDatabaseInfo -SourceDatabaseName <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmDataMigrationDatabaseInfo cmdlet creates the DatabaseInfo object that specifies the source database instance to be migrated. Database name is taken in as input parameter. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmDataMigrationDatabaseInfo -SourceDatabaseName 'AdventureWorks2016' -``` - -The preceding example creates a new DatabaseInfo object for the source database **AdventureWorks2016**. -This script assumes that you are already logged into your Azure account. You can confirm your login status by using the Get-AzureSubscription cmdlet. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceDatabaseName -Source Database Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: SourceDBName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Management.DataMigration.Models.DatabaseInfo - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataMigration/New-AzureRmDataMigrationFileShare.md b/azurermps-6.13.0/AzureRM.DataMigration/New-AzureRmDataMigrationFileShare.md deleted file mode 100644 index 4b6dbf55b1..0000000000 --- a/azurermps-6.13.0/AzureRM.DataMigration/New-AzureRmDataMigrationFileShare.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataMigration.dll-Help.xml -Module Name: AzureRM.DataMigration -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datamigration/New-AzureRmDataMigrationFileShare -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/New-AzureRmDataMigrationFileShare.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/New-AzureRmDataMigrationFileShare.md ---- - -# New-AzureRmDataMigrationFileShare - -## SYNOPSIS -Creates the FileShare object for the Azure Database Migration Service, which specifies the local network share to take the source database backups to. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmDataMigrationFileShare -Path <String> -Credential <PSCredential> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmDataMigrationFileShare cmdlet creates the FileShare object that specifies the local network share that Azure Database Migration Service can take source database backups to. The service account running source SQL Server instance must have write privileges on this network share. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmDmsFileShare -Path $fileSharePath -Credential $fileShareCred - -UserName Password Path --------- -------- ---- -domain\user testadmin123 \\fileshare\folder1 -``` - -## PARAMETERS - -### -Credential -Credentials to access the file share. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -File share path. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Management.DataMigration.Models.MigrateSqlServerSqlDbDatabaseInput - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataMigration/New-AzureRmDataMigrationProject.md b/azurermps-6.13.0/AzureRM.DataMigration/New-AzureRmDataMigrationProject.md deleted file mode 100644 index 9b54edef82..0000000000 --- a/azurermps-6.13.0/AzureRM.DataMigration/New-AzureRmDataMigrationProject.md +++ /dev/null @@ -1,283 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataMigration.dll-Help.xml -Module Name: AzureRM.DataMigration -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datamigration/New-AzureRmDataMigrationProject -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/New-AzureRmDataMigrationProject.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/New-AzureRmDataMigrationProject.md ---- - -# New-AzureRmDataMigrationProject - -## SYNOPSIS -Creates a new Azure Database Migration Service project. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ComponentNameParameterSet (Default) -``` -New-AzureRmDataMigrationProject -ResourceGroupName <String> -ServiceName <String> -Location <String> - -Name <String> -SourceType <String> -TargetType <String> [-SourceConnection <ConnectionInfo>] - [-TargetConnection <ConnectionInfo>] [-DatabaseInfo <DatabaseInfo[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ComponentObjectParameterSet -``` -New-AzureRmDataMigrationProject [-InputObject] <PSDataMigrationService> -Location <String> -Name <String> - -SourceType <String> -TargetType <String> [-SourceConnection <ConnectionInfo>] - [-TargetConnection <ConnectionInfo>] [-DatabaseInfo <DatabaseInfo[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -New-AzureRmDataMigrationProject [-ResourceId] <String> -Location <String> -Name <String> -SourceType <String> - -TargetType <String> [-SourceConnection <ConnectionInfo>] [-TargetConnection <ConnectionInfo>] - [-DatabaseInfo <DatabaseInfo[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmDataMigrationProject cmdlet creates a new Azure Database Migration Service project. This cmdlet takes in all necessary parameters, such as the name of the Azure Resource Group, the name of Azure Data Migration Service in which new project is to be created, the region in which the project is to be created, the unique name of the new project, the source and target connection objects, and the target type object, as input for the list of databases to migrate. Use the New-AzureRmDataMigrationConnectionInfo cmdlet to create a new ConnectionInfo object for both the source and target connections. The list of Microsoft.Azure.Management.DataMigration.Models.DatabaseInfo is expected for selected databases; this object can be created by using New-AzureRmDataMigrationDatabaseInfo cmdlet. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmDataMigrationProject -ResourceGroupName MyResourceGroup -ServiceName TestService -ProjectName MyDMSProject -Location "central us" -SourceType SQL -TargetType SQLDB -SourceConnection $sourceConnInfo -TargetConnection $targetConnInfo -DatabaseInfo $dbList -``` - -The above example shows how to create new project named MyDMSProject located in Central US region under the Azure Database Migration Service instance named TestService. - -## PARAMETERS - -### -DatabaseInfo -Database Infos. - -```yaml -Type: Microsoft.Azure.Management.DataMigration.Models.DatabaseInfo[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -PSDataMigrationService Object. - -```yaml -Type: Microsoft.Azure.Commands.DataMigration.Models.PSDataMigrationService -Parameter Sets: ComponentObjectParameterSet -Aliases: DataMigrationService - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Location -The location of the Azure Database Migration Service instance. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the project. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ProjectName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -DataMigrationService Resource Id. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceName -The name of the Azure Database Migration Service instance. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceConnection -Source Connection Info. - -```yaml -Type: Microsoft.Azure.Management.DataMigration.Models.ConnectionInfo -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceType -Source platform type for project. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetConnection -Target connection information. - -```yaml -Type: Microsoft.Azure.Management.DataMigration.Models.ConnectionInfo -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetType -Target platform type for project. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataMigration.Models.PSDataMigrationService -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataMigration.Models.PSProject - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataMigration/New-AzureRmDataMigrationSelectedDBObject.md b/azurermps-6.13.0/AzureRM.DataMigration/New-AzureRmDataMigrationSelectedDBObject.md deleted file mode 100644 index 3ef569febf..0000000000 --- a/azurermps-6.13.0/AzureRM.DataMigration/New-AzureRmDataMigrationSelectedDBObject.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataMigration.dll-Help.xml -Module Name: AzureRM.DataMigration -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datamigration/New-AzureRmDataMigrationSelectedDBObject -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/New-AzureRmDataMigrationSelectedDBObject.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/New-AzureRmDataMigrationSelectedDBObject.md ---- - -# New-AzureRmDataMigrationSelectedDBObject - -## SYNOPSIS -Creates a database input object that contains information about source and target databases for migration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### MigrateSqlServerSqlDb (Default) -``` -New-AzureRmDataMigrationSelectedDBObject -SourceDatabaseName <String> -TargetDatabaseName <String> - [-MigrateSqlServerSqlDb] [-MakeSourceDbReadOnly] - [-TableMap <System.Collections.Generic.IDictionary`2[System.String,System.String]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### MigrateSqlServerSqlDbMi -``` -New-AzureRmDataMigrationSelectedDBObject -SourceDatabaseName <String> -TargetDatabaseName <String> - [-MigrateSqlServerSqlDbMi] [-BackupFileShare <FileShare>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmDataMigrationSelectedDB cmdlet creates a database info object that contains information about source and target databases, as well as the table mappings, for migration. This cmdlet can be used as a parameter with the New-AzureRmDataMigrationTask cmdlet. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmDataMigrationSelectedDB -MigrateSqlServerSqlDb -Name "HR" -TargetDatabaseName "HR_PSTEST" -TableMap $tableMap - -Name TargetDatabaseName MakeSourceDbReadOnly TableMap ----- ------------------ -------------------- -------- -HR HR_PSTEST False {[HR.COUNTRIES, HR.COUNTRIES]} -``` - - -### Example 2 -``` -PS C:\> New-AzureRmDataMigrationSelectedDB -MigrateSqlServerSqlDbMi -Name "HR" -TargetDatabaseName "HR_PSTEST" -BackupFileShare $backupFileShare - -Name RestoreDatabaseName BackupFileShare ----- ------------------- --------------- -HR HRTest Microsoft.Azure.Management.DataMigration.Models.FileShare -``` - - -## PARAMETERS - -### -BackupFileShare -File share where the source server database files for this database should be backed up. -Use this setting to override file share information for each database. -Use fully qualified domain name for the server. - -```yaml -Type: Microsoft.Azure.Management.DataMigration.Models.FileShare -Parameter Sets: MigrateSqlServerSqlDbMi -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MakeSourceDbReadOnly -Set Database to readonly before migration - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: MigrateSqlServerSqlDb -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MigrateSqlServerSqlDb -Set migration type to SQL Server to SQL DB Migration. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: MigrateSqlServerSqlDb -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MigrateSqlServerSqlDbMi -Set migration type to SQL Server to SQL DB MI Migration. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: MigrateSqlServerSqlDbMi -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceDatabaseName -The name of the source database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TableMap -mapping of source to target tables - -```yaml -Type: System.Collections.Generic.IDictionary`2[System.String,System.String] -Parameter Sets: MigrateSqlServerSqlDb -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetDatabaseName -The name of the target database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.DataMigration.Models.FileShare - -## OUTPUTS - -### Microsoft.Azure.Management.DataMigration.Models.MigrateSqlServerSqlDbDatabaseInput - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataMigration/New-AzureRmDataMigrationService.md b/azurermps-6.13.0/AzureRM.DataMigration/New-AzureRmDataMigrationService.md deleted file mode 100644 index bb9bfdf92d..0000000000 --- a/azurermps-6.13.0/AzureRM.DataMigration/New-AzureRmDataMigrationService.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataMigration.dll-Help.xml -Module Name: AzureRM.DataMigration -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datamigration/New-AzureRmDataMigrationService -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/New-AzureRmDataMigrationService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/New-AzureRmDataMigrationService.md ---- - -# New-AzureRmDataMigrationService - -## SYNOPSIS -Creates a new instance of the Azure Database Migration Service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmDataMigrationService -ResourceGroupName <String> -Name <String> -Location <String> -Sku <String> - -VirtualSubnetId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmDataMigrationService cmdlet creates a new instance of the Azure Database Migration Service. This cmdlet takes in name of existing Azure Resource Group, the unique name for the new instance of the Azure Database Migration Service to be created, the region in which the instance is provisioned, the name of the DMS Worker SKU, and the name of the Azure Virtual Subnet on which the service is to reside. There is no parameter for subscription name, because it is expected for the user to specify the default subscription of the Azure login session or execute Get-AzureRmSubscription -SubscriptionName "MySubscription" | Select-AzureRmSubscription to select another subscription. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmDataMigrationService -ResourceGroupName myResourceGroup -Name TestService -Location "Central US" -Sku Basic_2vCores -VirtualSubnetId $virtualSubNetId -``` - -The above example shows how to create a new instance of the Azure Database Migration Service named TestService in Central US region. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The location of the Azure Database Migration Service instance to be created, which corresponds to an Azure region. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Database Migration Service Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ServiceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sku -The sku for the Azure Database Migration Service instance. Possible values currently are Basic_1vCore,Basic_2vCores,GeneralPurpose_4vCores - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualSubnetId -The name of the subnet under the specified virtual network to use for the Azure Database Migration Service instance. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.DataMigration.Models.PSDataMigrationService - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataMigration/New-AzureRmDataMigrationSyncSelectedDBObject.md b/azurermps-6.13.0/AzureRM.DataMigration/New-AzureRmDataMigrationSyncSelectedDBObject.md deleted file mode 100644 index 1c353282e8..0000000000 --- a/azurermps-6.13.0/AzureRM.DataMigration/New-AzureRmDataMigrationSyncSelectedDBObject.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataMigration.dll-Help.xml -Module Name: AzureRM.DataMigration -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datamigration/New-AzureRmDataMigrationSyncSelectedDBObject -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/New-AzureRmDataMigrationSyncSelectedDBObject.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/New-AzureRmDataMigrationSyncSelectedDBObject.md ---- - -# New-AzureRmDataMigrationSyncSelectedDBObject - -## SYNOPSIS -Creates a database info object specific to the sync scenario to be used for a migration task. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmDataMigrationSyncSelectedDBObject -TargetDatabaseName <String> -SchemaName <String> - -TableMap <Hashtable> [-MigrationSetting <Hashtable>] [-SourceSetting <Hashtable>] - [-TargetSetting <Hashtable>] -SourceDatabaseName <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION - -The New-AzureRmDataMigrationSyncSelectedDB cmdlet creates a database info object specific to the sync scenario which contains information about source and target databases. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $tableMap = New-Object 'system.collections.hashtable' - $tableMap.Add("dbo.TestTable1", "dbo.TestTable1") - $tableMap.Add("dbo.TestTable2","dbo.TestTable2") - - $selectedDbs = New-AzureRmDmsSyncSelectedDBObject - -TargetDatabaseName DatabaseName ` - -SchemaName dbo ` - -TableMap $tableMap ` - -SourceDatabaseName DatabaseName -``` - -This example creates a database metadata object describing the migrating settings for $DatabaseName to database $DatabaseName. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MigrationSetting -Migration settings which tune the migration behavior - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SchemaName -Schema name to be migrated - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceDatabaseName -The name of the source database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceSetting -Source settings to tune source endpoint migration behavior - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TableMap -Mapping of source to target tables - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetDatabaseName -The name of the target database - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetSetting -Target settings to tune target endpoint migration behavior - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Management.DataMigration.Models.MigrateSqlServerSqlDbSyncTaskInput - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataMigration/New-AzureRmDataMigrationTask.md b/azurermps-6.13.0/AzureRM.DataMigration/New-AzureRmDataMigrationTask.md deleted file mode 100644 index c5970feb66..0000000000 --- a/azurermps-6.13.0/AzureRM.DataMigration/New-AzureRmDataMigrationTask.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataMigration.dll-Help.xml -Module Name: AzureRM.DataMigration -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datamigration/New-AzureRmDataMigrationTask -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/New-AzureRmDataMigrationTask.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/New-AzureRmDataMigrationTask.md ---- - -# New-AzureRmDataMigrationTask - -## SYNOPSIS -Creates and starts a data migration task in the Azure Database Migration Service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ComponentNameParameterSet (Default) -``` -New-AzureRmDataMigrationTask -TaskType <TaskTypeEnum> -ResourceGroupName <String> -ServiceName <String> - -ProjectName <String> -Name <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ComponentObjectParameterSet -``` -New-AzureRmDataMigrationTask [-InputObject] <PSProject> -TaskType <TaskTypeEnum> -Name <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -New-AzureRmDataMigrationTask [-ResourceId] <String> -TaskType <TaskTypeEnum> -Name <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmDataMigrationTask cmdlet creates data migration task. This cmdlet takes in parameters for Task Type enumerator, Azure Resource Group, name of associated Azure Database Migration Service and Project as input. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmDmsTask -TaskType MigrateSqlServerSqlDb -ResourceGroupName myResourceGroup -ServiceName TestService -ProjectName myDMSProject -TaskName MyMigrationTask -SourceConnection $sourceConnInfo -SourceCred $sourceCred -TargetConnection $targetConnInfo -TargetCred $targetCred -SelectedDatabase $selectedDbs -``` - -This example script shows how to create a new Data Migration Task named MyMigrationTask in the project named myDMSProject and service named TestService. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -PSProject Object. - -```yaml -Type: Microsoft.Azure.Commands.DataMigration.Models.PSProject -Parameter Sets: ComponentObjectParameterSet -Aliases: Project - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the task. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: TaskName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -The name of the project. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Project Resource Id. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceName -Database Migration Service Name. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TaskType -Task Type. - -```yaml -Type: Microsoft.Azure.Commands.DataMigration.Models.TaskTypeEnum -Parameter Sets: (All) -Aliases: -Accepted values: MigrateSqlServerSqlDb, ConnectToSourceSqlServer, ConnectToTargetSqlDb, GetUserTablesSql, ConnectToTargetSqlDbMi, MigrateSqlServerSqlDbMi, ValidateSqlServerSqlDbMi - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataMigration.Models.PSProject -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DataMigration.Models.PSProjectTask - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataMigration/Remove-AzureRmDataMigrationProject.md b/azurermps-6.13.0/AzureRM.DataMigration/Remove-AzureRmDataMigrationProject.md deleted file mode 100644 index 2382744c2a..0000000000 --- a/azurermps-6.13.0/AzureRM.DataMigration/Remove-AzureRmDataMigrationProject.md +++ /dev/null @@ -1,242 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataMigration.dll-Help.xml -Module Name: AzureRM.DataMigration -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datamigration/Remove-AzureRmDataMigrationProject -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/Remove-AzureRmDataMigrationProject.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/Remove-AzureRmDataMigrationProject.md ---- - -# Remove-AzureRmDataMigrationProject - -## SYNOPSIS -Removes an Azure Database Migration Service project from Azure. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ComponentNameParameterSet (Default) -``` -Remove-AzureRmDataMigrationProject -ResourceGroupName <String> -ServiceName <String> -Name <String> [-Force] - [-DeleteRunningTask] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ComponentObjectParameterSet -``` -Remove-AzureRmDataMigrationProject [-InputObject] <PSProject> [-Force] [-DeleteRunningTask] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Remove-AzureRmDataMigrationProject [-ResourceId] <String> [-Force] [-DeleteRunningTask] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmDataMigrationProject cmdlet removes an Azure Database Migration Service project from Azure. Supplying the DeleteRunningTask parameter removes all of the Azure Database Migration Service tasks associated with the project that is being removed. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmDataMigrationProject -ResourceGroupName myResourceGroup -ServiceName myDMService -ProjectName myDMProject -``` - -The above example removes the Azure Database Migration Service project called myDMProject from Azure based on name as input parameter - -### Example 2 -``` -PS C:\> Remove-AzureRmDataMigrationProject -InputObject $myDMSProject -``` - -The above example removes the Azure Database Migration Service project based on PSProject object as input parameter. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeleteRunningTask -Delete any running task - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Skip confirmation message for performing the action - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -PSProject Object. - -```yaml -Type: Microsoft.Azure.Commands.DataMigration.Models.PSProject -Parameter Sets: ComponentObjectParameterSet -Aliases: Project - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the project. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: ProjectName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an true/false. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Project Resource Id. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceName -Database Migration Service Name. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataMigration.Models.PSProject -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataMigration/Remove-AzureRmDataMigrationService.md b/azurermps-6.13.0/AzureRM.DataMigration/Remove-AzureRmDataMigrationService.md deleted file mode 100644 index 938743aed3..0000000000 --- a/azurermps-6.13.0/AzureRM.DataMigration/Remove-AzureRmDataMigrationService.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataMigration.dll-Help.xml -Module Name: AzureRM.DataMigration -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datamigration/Remove-AzureRmDataMigrationService -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/Remove-AzureRmDataMigrationService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/Remove-AzureRmDataMigrationService.md ---- - -# Remove-AzureRmDataMigrationService - -## SYNOPSIS -Removes an instance of the Azure Database Migration Service from Azure. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ComponentNameParameterSet (Default) -``` -Remove-AzureRmDataMigrationService -ResourceGroupName <String> -Name <String> [-Force] [-DeleteRunningTask] - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ComponentObjectParameterSet -``` -Remove-AzureRmDataMigrationService [-InputObject] <PSDataMigrationService> [-Force] [-DeleteRunningTask] - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Remove-AzureRmDataMigrationService [-ResourceId] <String> [-Force] [-DeleteRunningTask] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmDataMigrationService cmdlet removes an instance of the Azure Database Migration Service from Azure. Supplying the DeleteRunningTask parameter removes all of the Azure Database Migration Service tasks associated with the service that is being removed. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmDataMigrationService -ResourceGroupName MyResourceGroup -ServiceName TestService -``` - -The above example removes an instance of the Azure Database Migration Service named TestService that is contained in an Azure Resource Group named MyResourceGroup. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeleteRunningTask -Delete any running task - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Skip confirmation message for performing the action - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -PSDataMigrationService Object. - -```yaml -Type: Microsoft.Azure.Commands.DataMigration.Models.PSDataMigrationService -Parameter Sets: ComponentObjectParameterSet -Aliases: DataMigrationService - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the Database Migration Service. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: ServiceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an true/false. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -DataMigrationService Resource Id. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataMigration.Models.PSDataMigrationService -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataMigration/Remove-AzureRmDataMigrationTask.md b/azurermps-6.13.0/AzureRM.DataMigration/Remove-AzureRmDataMigrationTask.md deleted file mode 100644 index f06b450892..0000000000 --- a/azurermps-6.13.0/AzureRM.DataMigration/Remove-AzureRmDataMigrationTask.md +++ /dev/null @@ -1,243 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataMigration.dll-Help.xml -Module Name: AzureRM.DataMigration -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datamigration/Remove-AzureRmDataMigrationTask -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/Remove-AzureRmDataMigrationTask.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/Remove-AzureRmDataMigrationTask.md ---- - -# Remove-AzureRmDataMigrationTask - -## SYNOPSIS -Removes an Azure Database Migration Service task from Azure. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ComponentNameParameterSet (Default) -``` -Remove-AzureRmDataMigrationTask -ResourceGroupName <String> -ServiceName <String> -ProjectName <String> - -Name <String> [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ComponentObjectParameterSet -``` -Remove-AzureRmDataMigrationTask [-InputObject] <PSProjectTask> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Remove-AzureRmDataMigrationTask [-ResourceId] <String> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmDataMigrationTask cmdlet removes an Azure Database Migration Service task from Azure. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmDataMigrationTask -TaskName TestTask -ProjectName myTestProject -ServiceName MyTestService - -ResourceGroupName MyResourceGroup -``` - -The preceding example removes an Azure Database Migration Service task named TestTask from Azure based on task name parameter. - -### Example 2 -``` -PS C:\> Remove-AzureRmDataMigrationTask -InputObject $TestTask -``` - -The preceding example removes an Azure Database Migration Service task based on PSProjectTask object passed in. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Skip confirmation message for performing the action - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -PSProjectTask Object. - -```yaml -Type: Microsoft.Azure.Commands.DataMigration.Models.PSProjectTask -Parameter Sets: ComponentObjectParameterSet -Aliases: ProjectTask - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the task. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: TaskName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an true/false. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -The name of the project. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Project Resource Id. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceName -Database Migration Service Name. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataMigration.Models.PSProjectTask -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataMigration/Start-AzureRmDataMigrationService.md b/azurermps-6.13.0/AzureRM.DataMigration/Start-AzureRmDataMigrationService.md deleted file mode 100644 index 94ccd6e3f6..0000000000 --- a/azurermps-6.13.0/AzureRM.DataMigration/Start-AzureRmDataMigrationService.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataMigration.dll-Help.xml -Module Name: AzureRM.DataMigration -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datamigration/Start-AzureRmDataMigrationService -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/Start-AzureRmDataMigrationService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/Start-AzureRmDataMigrationService.md ---- - -# Start-AzureRmDataMigrationService - -## SYNOPSIS -Starts an instance of the Azure Database Migration Service in a stopped state. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ComponentNameParameterSet (Default) -``` -Start-AzureRmDataMigrationService -ResourceGroupName <String> -Name <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ComponentObjectParameterSet -``` -Start-AzureRmDataMigrationService [-InputObject] <PSDataMigrationService> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Start-AzureRmDataMigrationService [-ResourceId] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Start-AzureRmDataMigrationService cmdlet starts an instance of the Azure Database Migration Service in a stopped state. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Start-AzureRmDataMigrationService -ResourceGroupName MyResourceGroup -ServiceName TestService -``` - -The above example starts an Azure Database Migration Service instance named Test Service in a stopped state based on service name passed in as input - -### Example 2 -``` -PS C:\> Start-AzureRmDataMigrationService -InputObject $TestService -``` - -The above example starts an Azure Database Migration Service instance based on PSDataMigrationService passed in as input parameter - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -PSDataMigrationService Object. - -```yaml -Type: Microsoft.Azure.Commands.DataMigration.Models.PSDataMigrationService -Parameter Sets: ComponentObjectParameterSet -Aliases: DataMigrationService - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Database Migration Service Name. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: ServiceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an true/false. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -DataMigrationService Resource Id. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataMigration.Models.PSDataMigrationService -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataMigration/Stop-AzureRmDataMigrationService.md b/azurermps-6.13.0/AzureRM.DataMigration/Stop-AzureRmDataMigrationService.md deleted file mode 100644 index 7636e87510..0000000000 --- a/azurermps-6.13.0/AzureRM.DataMigration/Stop-AzureRmDataMigrationService.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataMigration.dll-Help.xml -Module Name: AzureRM.DataMigration -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datamigration/Stop-AzureRmDataMigrationService -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/Stop-AzureRmDataMigrationService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/Stop-AzureRmDataMigrationService.md ---- - -# Stop-AzureRmDataMigrationService - -## SYNOPSIS -Stops an instance of the Azure Database Migration Service that is in a running state. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ComponentNameParameterSet (Default) -``` -Stop-AzureRmDataMigrationService -ResourceGroupName <String> -Name <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ComponentObjectParameterSet -``` -Stop-AzureRmDataMigrationService [-InputObject] <PSDataMigrationService> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Stop-AzureRmDataMigrationService [-ResourceId] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Stop-AzureRmDataMigrationService cmdlet stops an instance of the Azure Database Migration Service that is in a running state. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Stop-AzureRmDataMigrationService -ResourceGroupName MyResourceGroup -ServiceName TestService -``` - -The above example stops an instance of the Azure Database Migration Service called TestService based on service name passed in as input parameter - -### Example 2 -``` -PS C:\> Stop-AzureRmDataMigrationService -InputObject $TestService -``` - -The above example stops an instance of the Azure Database Migration Service based on PSDataMigrationService object passed as input parameter. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -PSDataMigrationService Object. - -```yaml -Type: Microsoft.Azure.Commands.DataMigration.Models.PSDataMigrationService -Parameter Sets: ComponentObjectParameterSet -Aliases: DataMigrationService - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Database Migration Service Name. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: ServiceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an true/false. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -DataMigrationService Resource Id. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataMigration.Models.PSDataMigrationService -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DataMigration/Stop-AzureRmDataMigrationTask.md b/azurermps-6.13.0/AzureRM.DataMigration/Stop-AzureRmDataMigrationTask.md deleted file mode 100644 index f2b86066aa..0000000000 --- a/azurermps-6.13.0/AzureRM.DataMigration/Stop-AzureRmDataMigrationTask.md +++ /dev/null @@ -1,227 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DataMigration.dll-Help.xml -Module Name: AzureRM.DataMigration -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.datamigration/Stop-AzureRmDataMigrationTask -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/Stop-AzureRmDataMigrationTask.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DataMigration/Commands.DataMigration/help/Stop-AzureRmDataMigrationTask.md ---- - -# Stop-AzureRmDataMigrationTask - -## SYNOPSIS -Stops an Azure Database Migration Service task that is in a running state. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ComponentNameParameterSet (Default) -``` -Stop-AzureRmDataMigrationTask -ResourceGroupName <String> -ServiceName <String> -ProjectName <String> - -Name <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ComponentObjectParameterSet -``` -Stop-AzureRmDataMigrationTask [-InputObject] <PSProjectTask> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Stop-AzureRmDataMigrationTask [-ResourceId] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Stop-AzureRmDataMigrationTask cmdlet stops database migration activity in running state. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Stop-AzureRmDataMigrationTask -ResourceGroupName MyResourceGroup -ServiceName TestService -ProjectName myDMSProject -Name myDMSTask -``` - -Above example stops Azure Database Migration Service task named myDMSTask associated with project myDMSProject and Azure Database Migration Service instance named TestService - -### Example 2 -``` -PS C:\> Stop-AzureRmDataMigrationTask -InputObject $MyDMSTask -``` - -Above example stops Azure Database Migration Service task passed in as input parameter PSProjectTask object - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -PSProjectTask Object. - -```yaml -Type: Microsoft.Azure.Commands.DataMigration.Models.PSProjectTask -Parameter Sets: ComponentObjectParameterSet -Aliases: ProjectTask - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the task. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: TaskName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an true/false. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -The name of the project. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group . - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -ProjectTask Resource Id. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceName -Database Migration Service Name. - -```yaml -Type: System.String -Parameter Sets: ComponentNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.DataMigration.Models.PSProjectTask -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DevSpaces/AzureRM.DevSpaces.md b/azurermps-6.13.0/AzureRM.DevSpaces/AzureRM.DevSpaces.md deleted file mode 100644 index 890c935492..0000000000 --- a/azurermps-6.13.0/AzureRM.DevSpaces/AzureRM.DevSpaces.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -Module Name: AzureRM.DevSpaces -Module Guid: 4ff83407-3957-414b-9855-6808a10e8955 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.devspaces -Help Version: 0.0.1.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DevSpaces/Commands.DevSpaces/help/AzureRM.DevSpaces.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DevSpaces/Commands.DevSpaces/help/AzureRM.DevSpaces.md ---- - -# AzureRM.DevSpaces Module -## Description -Commands to interact with Azure DevSpaces Controller. - -## AzureRM.DevSpaces Cmdlets -### [Get-AzureRmDevSpacesController](Get-AzureRmDevSpacesController.md) -Get or list Azure DevSpaces controller. - -### [New-AzureRmDevSpacesController](New-AzureRmDevSpacesController.md) -Create a new Azure DevSpaces controller. - -### [Remove-AzureRmDevSpacesController](Remove-AzureRmDevSpacesController.md) -Delete a DevSpaces controller. - -### [Update-AzureRmDevSpacesController](Update-AzureRmDevSpacesController.md) -Update the DevSpaces controller to add tags. - diff --git a/azurermps-6.13.0/AzureRM.DevSpaces/Get-AzureRmDevSpacesController.md b/azurermps-6.13.0/AzureRM.DevSpaces/Get-AzureRmDevSpacesController.md deleted file mode 100644 index 1651952d89..0000000000 --- a/azurermps-6.13.0/AzureRM.DevSpaces/Get-AzureRmDevSpacesController.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DevSpaces.dll-Help.xml -Module Name: AzureRM.DevSpaces -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.devspaces/get-azureevspacescontroller -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DevSpaces/Commands.DevSpaces/help/Get-AzureRmDevSpacesController.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DevSpaces/Commands.DevSpaces/help/Get-AzureRmDevSpacesController.md ---- - -# Get-AzureRmDevSpacesController - -## SYNOPSIS -Get or list Azure DevSpaces controller. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ListDevSpacesControllerParameterSet (Default) -``` -Get-AzureRmDevSpacesController [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### DevSpacesControllerNameParameterSet -``` -Get-AzureRmDevSpacesController [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Get or list Azure DevSpaces controller. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmDevSpacesController - -Name Resource Group Location Provisioning State ----------- -------------- -------- ------------------ -devSpaceControllerName devSpaceResourceGroup eastus Succeeded -``` - -List all controllers in a subscription. - -### Example 2 -```powershell -PS C:\> Get-AzureRmDevSpacesController --ResourceGroupName devSpaceResourceGroup -Name devSpaceControllerName - -Name Resource Group Location Provisioning State ----------- -------------- -------- ------------------ -devSpaceControllerName devSpaceResourceGroup eastus Succeeded -``` - -Get a DevSpaces controllers in a subscription. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -DevSpaces controller name. - -```yaml -Type: System.String -Parameter Sets: DevSpacesControllerNameParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource group name - -```yaml -Type: System.String -Parameter Sets: ListDevSpacesControllerParameterSet -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: DevSpacesControllerNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.DevSpaces.Models.PSController - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DevSpaces/New-AzureRmDevSpacesController.md b/azurermps-6.13.0/AzureRM.DevSpaces/New-AzureRmDevSpacesController.md deleted file mode 100644 index 6ececbd554..0000000000 --- a/azurermps-6.13.0/AzureRM.DevSpaces/New-AzureRmDevSpacesController.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DevSpaces.dll-Help.xml -Module Name: AzureRM.DevSpaces -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.devspaces/new-azureevspacescontroller -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DevSpaces/Commands.DevSpaces/help/New-AzureRmDevSpacesController.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DevSpaces/Commands.DevSpaces/help/New-AzureRmDevSpacesController.md ---- - -# New-AzureRmDevSpacesController - -## SYNOPSIS -Create a new Azure DevSpaces controller. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmDevSpacesController [-ResourceGroupName] <String> [-Name] <String> - [-TargetResourceGroupName] <String> [-TargetClusterName] <String> [-Tag <Hashtable>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Create a new Azure DevSpaces controller. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-AzureRmDevSpacesController -ResourceGroupName devSpaceResourceGroup -Name devSpaceControllerName -TargetResourceGroupName clusterResourceGroup -TargetClusterName clusterName - -Name Resource Group Location Provisioning State ----------- -------------- -------- ------------------ -devSpaceControllerName devSpaceResourceGroup eastus Succeeded -``` - -Crreate a DevSpaces controller in resourcegroup devSpaceResourceGroup with a name devSpaceName. Use clusterName cluster as a target for this controller. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -DevSpaces Controller Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -A hash table which represents resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetClusterName -Target Cluster Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetResourceGroupName -Target Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.DevSpaces.Models.PSController - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DevSpaces/Remove-AzureRmDevSpacesController.md b/azurermps-6.13.0/AzureRM.DevSpaces/Remove-AzureRmDevSpacesController.md deleted file mode 100644 index d2798ec77b..0000000000 --- a/azurermps-6.13.0/AzureRM.DevSpaces/Remove-AzureRmDevSpacesController.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DevSpaces.dll-Help.xml -Module Name: AzureRM.DevSpaces -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.devspaces/remove-azureevspacescontroller -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DevSpaces/Commands.DevSpaces/help/Remove-AzureRmDevSpacesController.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DevSpaces/Commands.DevSpaces/help/Remove-AzureRmDevSpacesController.md ---- - -# Remove-AzureRmDevSpacesController - -## SYNOPSIS -Delete a DevSpaces controller. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DevSpacesControllerNameParameterSet (Default) -``` -Remove-AzureRmDevSpacesController [-ResourceGroupName] <String> [-Name] <String> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Remove-AzureRmDevSpacesController -ResourceId <String> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectParameterSet -``` -Remove-AzureRmDevSpacesController -InputObject <PSController> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Delete a DevSpaces controller. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-AzureRmDevSpacesController -ResourceGroupName devSpaceResourceGroup -Name devSpaceControllerName -``` - -Delete a DevSpaces controller named devSpaceControllerName. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -A PSController object, normally passed through the pipeline. - -```yaml -Type: Microsoft.Azure.Commands.DevSpaces.Models.PSController -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -DevSpaces controller name. - -```yaml -Type: System.String -Parameter Sets: DevSpacesControllerNameParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true if delete is successful - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource group name - -```yaml -Type: System.String -Parameter Sets: DevSpacesControllerNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The DevSpaces resource id - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DevSpaces.Models.PSController -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DevSpaces/Update-AzureRmDevSpacesController.md b/azurermps-6.13.0/AzureRM.DevSpaces/Update-AzureRmDevSpacesController.md deleted file mode 100644 index bbde514ed7..0000000000 --- a/azurermps-6.13.0/AzureRM.DevSpaces/Update-AzureRmDevSpacesController.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DevSpaces.dll-Help.xml -Module Name: AzureRM.DevSpaces -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.devspaces/update-azureevspacescontroller -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DevSpaces/Commands.DevSpaces/help/Update-AzureRmDevSpacesController.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DevSpaces/Commands.DevSpaces/help/Update-AzureRmDevSpacesController.md ---- - -# Update-AzureRmDevSpacesController - -## SYNOPSIS -Update the DevSpaces controller to add tags. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DevSpacesControllerNameParameterSet (Default) -``` -Update-AzureRmDevSpacesController [-ResourceGroupName] <String> [-Name] <String> [-Tag <Hashtable>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Update-AzureRmDevSpacesController -ResourceId <String> [-Tag <Hashtable>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectParameterSet -``` -Update-AzureRmDevSpacesController -InputObject <PSController> [-Tag <Hashtable>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Update the DevSpaces controller to add tags. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Update-AzureRmDevSpacesController -ResourceGroupName devSpaceResourceGroup -Name devSpaceControllerName -Tag @{ tagKey="tagValue"} - -Name Resource Group Location Provisioning State ----------- -------------- -------- ------------------ -devSpaceControllerName devSpaceResourceGroup eastus Succeeded -``` - -Tag a DevSpaces contoller. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -A PSController object, normally passed through the pipeline. - -```yaml -Type: Microsoft.Azure.Commands.DevSpaces.Models.PSController -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -DevSpaces controller name. - -```yaml -Type: System.String -Parameter Sets: DevSpacesControllerNameParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource group name - -```yaml -Type: System.String -Parameter Sets: DevSpacesControllerNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The DevSpaces resource id - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -A hash table which represents resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.DevSpaces.Models.PSController -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.DevSpaces.Models.PSController - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DevTestLabs/AzureRM.DevTestLabs.md b/azurermps-6.13.0/AzureRM.DevTestLabs/AzureRM.DevTestLabs.md deleted file mode 100644 index 03e8a0b216..0000000000 --- a/azurermps-6.13.0/AzureRM.DevTestLabs/AzureRM.DevTestLabs.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -Module Name: AzureRM.DevTestLabs -Module Guid: be2ca175-bfb9-4601-b01c-4de13eb2105c -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.devtestlabs -Help Version: 4.0.4.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DevTestLabs/Commands.DevTestLabs/help/AzureRM.DevTestLabs.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DevTestLabs/Commands.DevTestLabs/help/AzureRM.DevTestLabs.md ---- - -# AzureRM.DevTestLabs Module -## Description -This topic displays help topics for the DevTest Labs feature in Azure App Service cmdlets. - -## AzureRM.DevTestLabs Cmdlets -### [Get-AzureRmDtlAllowedVMSizesPolicy](Get-AzureRmDtlAllowedVMSizesPolicy.md) -Gets the allowed virtual machine sizes policy of a lab in DevTest Labs. - -### [Get-AzureRmDtlAutoShutdownPolicy](Get-AzureRmDtlAutoShutdownPolicy.md) -Gets the auto shutdown policy of a lab in DevTest Labs. - -### [Get-AzureRmDtlAutoStartPolicy](Get-AzureRmDtlAutoStartPolicy.md) -Gets the auto start policy of a lab in DevTest Labs. - -### [Get-AzureRmDtlVMsPerLabPolicy](Get-AzureRmDtlVMsPerLabPolicy.md) -Gets the virtual machines per lab policy of a lab in DevTest Labs. - -### [Get-AzureRmDtlVMsPerUserPolicy](Get-AzureRmDtlVMsPerUserPolicy.md) -Gets the virtual machines per user policy of a lab in DevTest Labs. - -### [Set-AzureRmDtlAllowedVMSizesPolicy](Set-AzureRmDtlAllowedVMSizesPolicy.md) -Sets the allowed virtual machine sizes policy of a lab in DevTest Labs. - -### [Set-AzureRmDtlAutoShutdownPolicy](Set-AzureRmDtlAutoShutdownPolicy.md) -Sets the auto shutdown policy of a lab DevTest Labs. - -### [Set-AzureRmDtlAutoStartPolicy](Set-AzureRmDtlAutoStartPolicy.md) -Sets the auto start policy of a lab in DevTest Labs. - -### [Set-AzureRmDtlVMsPerLabPolicy](Set-AzureRmDtlVMsPerLabPolicy.md) -Sets the virtual machines per lab policy of a lab in DevTest Labs. - -### [Set-AzureRmDtlVMsPerUserPolicy](Set-AzureRmDtlVMsPerUserPolicy.md) -Sets the virtual machines per user policy of a lab in DevTest Labs. - diff --git a/azurermps-6.13.0/AzureRM.DevTestLabs/Get-AzureRmDtlAllowedVMSizesPolicy.md b/azurermps-6.13.0/AzureRM.DevTestLabs/Get-AzureRmDtlAllowedVMSizesPolicy.md deleted file mode 100644 index cc51d5300b..0000000000 --- a/azurermps-6.13.0/AzureRM.DevTestLabs/Get-AzureRmDtlAllowedVMSizesPolicy.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DevTestLabs.dll-Help.xml -Module Name: AzureRM.DevTestLabs -ms.assetid: 869167AA-54F8-4A1C-AC08-5555A63EE1BC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.devtestlabs/get-azurermdtlallowedvmsizespolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DevTestLabs/Commands.DevTestLabs/help/Get-AzureRmDtlAllowedVMSizesPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DevTestLabs/Commands.DevTestLabs/help/Get-AzureRmDtlAllowedVMSizesPolicy.md ---- - -# Get-AzureRmDtlAllowedVMSizesPolicy - -## SYNOPSIS -Gets the allowed virtual machine sizes policy of a lab in DevTest Labs. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmDtlAllowedVMSizesPolicy [-LabName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDtlAllowedVMSizesPolicy** cmdlet gets the allowed virtual machine sizes policy, which allows you to specify a list of virtual machine sizes allowed in the lab. -The cmdlet returns the enabled or disabled status of the policy and a list of all the allowed virtual machine sizes that you have set in the specified policy. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LabName -Specifies the name of the lab for which this cmdlet gets virtual machines size policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the lab belongs to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DevTestLabs.Models.PSPolicy - -## NOTES - -## RELATED LINKS - -[Set-AzureRmDtlAllowedVMSizesPolicy](./Set-AzureRmDtlAllowedVMSizesPolicy.md) - -[Azure Development Test Lab Cmdlets](./AzureRM.DevTestLabs.md) - - diff --git a/azurermps-6.13.0/AzureRM.DevTestLabs/Get-AzureRmDtlAutoShutdownPolicy.md b/azurermps-6.13.0/AzureRM.DevTestLabs/Get-AzureRmDtlAutoShutdownPolicy.md deleted file mode 100644 index 5f79876227..0000000000 --- a/azurermps-6.13.0/AzureRM.DevTestLabs/Get-AzureRmDtlAutoShutdownPolicy.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DevTestLabs.dll-Help.xml -Module Name: AzureRM.DevTestLabs -ms.assetid: 52DD0511-915F-4144-B47F-E4B7AF403AA5 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.devtestlabs/get-azurermdtlautoshutdownpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DevTestLabs/Commands.DevTestLabs/help/Get-AzureRmDtlAutoShutdownPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DevTestLabs/Commands.DevTestLabs/help/Get-AzureRmDtlAutoShutdownPolicy.md ---- - -# Get-AzureRmDtlAutoShutdownPolicy - -## SYNOPSIS -Gets the auto shutdown policy of a lab in DevTest Labs. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmDtlAutoShutdownPolicy [-LabName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDtlAutoShutdownPolicy** cmdlet gets the auto shutdown policy of a lab, which allows you to automatically shut down all the virtual machines in a lab at a specified time of the day. -The cmdlet returns whether the status of the policy is enabled, and the time of day that you have set to automatically shut down the lab virtual machines. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LabName -Specifies the name of the lab for which this cmdlet gets the auto shutdown policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the lab belongs to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DevTestLabs.Models.PSSchedule - -## NOTES - -## RELATED LINKS - -[Set-AzureRmDtlAutoShutdownPolicy](./Set-AzureRmDtlAutoShutdownPolicy.md) - - diff --git a/azurermps-6.13.0/AzureRM.DevTestLabs/Get-AzureRmDtlAutoStartPolicy.md b/azurermps-6.13.0/AzureRM.DevTestLabs/Get-AzureRmDtlAutoStartPolicy.md deleted file mode 100644 index aac8dbff34..0000000000 --- a/azurermps-6.13.0/AzureRM.DevTestLabs/Get-AzureRmDtlAutoStartPolicy.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DevTestLabs.dll-Help.xml -Module Name: AzureRM.DevTestLabs -ms.assetid: 9FD4DB8C-B242-4F9A-92E5-0B3EDED00521 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.devtestlabs/get-azurermdtlautostartpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DevTestLabs/Commands.DevTestLabs/help/Get-AzureRmDtlAutoStartPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DevTestLabs/Commands.DevTestLabs/help/Get-AzureRmDtlAutoStartPolicy.md ---- - -# Get-AzureRmDtlAutoStartPolicy - -## SYNOPSIS -Gets the auto start policy of a lab in DevTest Labs. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmDtlAutoStartPolicy [-LabName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDtlAutoStartPolicy** cmdlet gets the auto start policy of a lab which schedules lab virtual machines for automatic start. -The cmdlet returns the enabled or disabled status of the policy and the days of the week and time of day that you have set to allow lab virtual machines to be scheduled for automatic start. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LabName -Specifies the name of the lab for which this cmdlet gets the auto start policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the lab belongs to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DevTestLabs.Models.PSSchedule - -## NOTES - -## RELATED LINKS - -[Set-AzureRmDtlAutoStartPolicy](./Set-AzureRmDtlAutoStartPolicy.md) - - diff --git a/azurermps-6.13.0/AzureRM.DevTestLabs/Get-AzureRmDtlVMsPerLabPolicy.md b/azurermps-6.13.0/AzureRM.DevTestLabs/Get-AzureRmDtlVMsPerLabPolicy.md deleted file mode 100644 index cd5d4eac37..0000000000 --- a/azurermps-6.13.0/AzureRM.DevTestLabs/Get-AzureRmDtlVMsPerLabPolicy.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DevTestLabs.dll-Help.xml -Module Name: AzureRM.DevTestLabs -ms.assetid: A3F653C7-6F9D-4B2B-81F8-0A012D80ECC7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.devtestlabs/get-azurermdtlvmsperlabpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DevTestLabs/Commands.DevTestLabs/help/Get-AzureRmDtlVMsPerLabPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DevTestLabs/Commands.DevTestLabs/help/Get-AzureRmDtlVMsPerLabPolicy.md ---- - -# Get-AzureRmDtlVMsPerLabPolicy - -## SYNOPSIS -Gets the virtual machines per lab policy of a lab in DevTest Labs. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmDtlVMsPerLabPolicy [-LabName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDtlVMsPerLabPolicy** cmdlet gets the virtual machines per lab policy of a lab, which allows you set the total number of virtual machines allowed in a lab. -The cmdlet returns the enabled or disabled status of the policy, and the total number of virtual machines allowed in the lab that you have set in the policy. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LabName -Specifies the name of the lab for which this cmdlet gets the virtual machines. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the lab belongs to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DevTestLabs.Models.PSPolicy - -## NOTES - -## RELATED LINKS - -[Set-AzureRmDtlVMsPerLabPolicy](./Set-AzureRmDtlVMsPerLabPolicy.md) - - diff --git a/azurermps-6.13.0/AzureRM.DevTestLabs/Get-AzureRmDtlVMsPerUserPolicy.md b/azurermps-6.13.0/AzureRM.DevTestLabs/Get-AzureRmDtlVMsPerUserPolicy.md deleted file mode 100644 index 46be54f0cd..0000000000 --- a/azurermps-6.13.0/AzureRM.DevTestLabs/Get-AzureRmDtlVMsPerUserPolicy.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DevTestLabs.dll-Help.xml -Module Name: AzureRM.DevTestLabs -ms.assetid: 5029179A-99A5-4350-A8E5-D15ABA59CC93 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.devtestlabs/get-azurermdtlvmsperuserpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DevTestLabs/Commands.DevTestLabs/help/Get-AzureRmDtlVMsPerUserPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DevTestLabs/Commands.DevTestLabs/help/Get-AzureRmDtlVMsPerUserPolicy.md ---- - -# Get-AzureRmDtlVMsPerUserPolicy - -## SYNOPSIS -Gets the virtual machines per user policy of a lab in DevTest Labs. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmDtlVMsPerUserPolicy [-LabName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDtlVMsPerUserPolicy** cmdlet gets the virtual machines per user policy of a lab, which allows you to set the maximum number of virtual machines allowed per user. -The cmdlet returns the enabled or disabled status of the policy and the maximum number of virtual machines allowed per user that you have set in the policy. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LabName -Specifies the name of the lab for which this cmdlet gets the virtual machine per user policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the lab belongs to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DevTestLabs.Models.PSPolicy - -## NOTES - -## RELATED LINKS - -[Set-AzureRmDtlVMsPerUserPolicy](./Set-AzureRmDtlVMsPerUserPolicy.md) - - diff --git a/azurermps-6.13.0/AzureRM.DevTestLabs/Set-AzureRmDtlAllowedVMSizesPolicy.md b/azurermps-6.13.0/AzureRM.DevTestLabs/Set-AzureRmDtlAllowedVMSizesPolicy.md deleted file mode 100644 index d4d7f68cc8..0000000000 --- a/azurermps-6.13.0/AzureRM.DevTestLabs/Set-AzureRmDtlAllowedVMSizesPolicy.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DevTestLabs.dll-Help.xml -Module Name: AzureRM.DevTestLabs -ms.assetid: AAABDD1D-71BF-409C-B50B-9BE861D84229 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.devtestlabs/set-azurermdtlallowedvmsizespolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DevTestLabs/Commands.DevTestLabs/help/Set-AzureRmDtlAllowedVMSizesPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DevTestLabs/Commands.DevTestLabs/help/Set-AzureRmDtlAllowedVMSizesPolicy.md ---- - -# Set-AzureRmDtlAllowedVMSizesPolicy - -## SYNOPSIS -Sets the allowed virtual machine sizes policy of a lab in DevTest Labs. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Enable (Default) -``` -Set-AzureRmDtlAllowedVMSizesPolicy [[-VmSizes] <String[]>] [-Enable] [-LabName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### Disable -``` -Set-AzureRmDtlAllowedVMSizesPolicy [[-VmSizes] <String[]>] [-Disable] [-LabName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDtlAllowedVMSizesPolicy** cmdlet sets the allowed virtual machine sizes policy, which specifies a list of virtual machine sizes allowed in a lab. -The cmdlet uses the specified resource group and name of the lab to set the policy. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disable -Indicates that this cmdlet disables the policy. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Disable -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enable -Indicates that this cmdlet enables the policy. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Enable -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LabName -Specifies the name of the lab for which this cmdlet sets the virtual machine sizes policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the lab belongs to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VmSizes -Specifies, as a string array, the list of virtual machine sizes allowed in the lab. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DevTestLabs.Models.PSPolicy - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDtlAllowedVMSizesPolicy](./Get-AzureRmDtlAllowedVMSizesPolicy.md) - - diff --git a/azurermps-6.13.0/AzureRM.DevTestLabs/Set-AzureRmDtlAutoShutdownPolicy.md b/azurermps-6.13.0/AzureRM.DevTestLabs/Set-AzureRmDtlAutoShutdownPolicy.md deleted file mode 100644 index 25b0e33bb0..0000000000 --- a/azurermps-6.13.0/AzureRM.DevTestLabs/Set-AzureRmDtlAutoShutdownPolicy.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DevTestLabs.dll-Help.xml -Module Name: AzureRM.DevTestLabs -ms.assetid: 8AAD9309-5763-4903-AF6A-1E50310146C0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.devtestlabs/set-azurermdtlautoshutdownpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DevTestLabs/Commands.DevTestLabs/help/Set-AzureRmDtlAutoShutdownPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DevTestLabs/Commands.DevTestLabs/help/Set-AzureRmDtlAutoShutdownPolicy.md ---- - -# Set-AzureRmDtlAutoShutdownPolicy - -## SYNOPSIS -Sets the auto shutdown policy of a lab DevTest Labs. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Enable (Default) -``` -Set-AzureRmDtlAutoShutdownPolicy [[-Time] <DateTime>] [-Enable] [-LabName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### Disable -``` -Set-AzureRmDtlAutoShutdownPolicy [[-Time] <DateTime>] [-Disable] [-LabName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDtlAutoShutdownPolicy** cmdlet sets the auto shutdown policy of a lab, which automatically shuts down all the virtual machines in the lab at a specified time of the day. -The cmdlet uses the specified resource group and name of the lab to set the policy. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disable -Indicates that the cmdlet disables the policy in the lab. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Disable -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enable -Indicates that the cmdlet enables the policy in the lab. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Enable -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LabName -Specifies the name of the lab for which this cmdlet sets the auto shutdown policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the lab belongs to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Time -Specifies the time, as a **DateTime** object, for when the virtual machines in the lab must shut down. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DevTestLabs.Models.PSSchedule - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDtlAutoShutdownPolicy](./Get-AzureRmDtlAutoShutdownPolicy.md) - - diff --git a/azurermps-6.13.0/AzureRM.DevTestLabs/Set-AzureRmDtlAutoStartPolicy.md b/azurermps-6.13.0/AzureRM.DevTestLabs/Set-AzureRmDtlAutoStartPolicy.md deleted file mode 100644 index 4360bd3d43..0000000000 --- a/azurermps-6.13.0/AzureRM.DevTestLabs/Set-AzureRmDtlAutoStartPolicy.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DevTestLabs.dll-Help.xml -Module Name: AzureRM.DevTestLabs -ms.assetid: 3FADEC2E-4A2B-46EB-8A94-CF48D717C7FC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.devtestlabs/set-azurermdtlautostartpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DevTestLabs/Commands.DevTestLabs/help/Set-AzureRmDtlAutoStartPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DevTestLabs/Commands.DevTestLabs/help/Set-AzureRmDtlAutoStartPolicy.md ---- - -# Set-AzureRmDtlAutoStartPolicy - -## SYNOPSIS -Sets the auto start policy of a lab in DevTest Labs. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Enable (Default) -``` -Set-AzureRmDtlAutoStartPolicy [[-Time] <DateTime>] [[-Days] <DayOfWeek[]>] [-Enable] [-LabName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### Disable -``` -Set-AzureRmDtlAutoStartPolicy [[-Time] <DateTime>] [[-Days] <DayOfWeek[]>] [-Disable] [-LabName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDtlAutoStartPolicy** cmdlet sets the auto start policy of a lab, which allows lab virtual machines to be scheduled for automatic start. -The cmdlet uses the specified resource group and name of the lab to set the policy. - -## EXAMPLES - -## PARAMETERS - -### -Days -Specifies, as an array, the days of the week for when the virtual machines of the lab must be started. - -```yaml -Type: System.DayOfWeek[] -Parameter Sets: (All) -Aliases: -Accepted values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disable -Indicates that this cmdlet disables the policy for the virtual machines in the lab. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Disable -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enable -Indicates that this cmdlet enables the policy for the virtual machines in the lab. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Enable -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LabName -Specifies the name of the lab for which this cmdlet sets the automatic start policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the lab belongs to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Time -Specifies the time when the virtual machines of the lab must be started. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DevTestLabs.Models.PSSchedule - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDtlAutoStartPolicy](./Get-AzureRmDtlAutoStartPolicy.md) - - diff --git a/azurermps-6.13.0/AzureRM.DevTestLabs/Set-AzureRmDtlVMsPerLabPolicy.md b/azurermps-6.13.0/AzureRM.DevTestLabs/Set-AzureRmDtlVMsPerLabPolicy.md deleted file mode 100644 index b48b376362..0000000000 --- a/azurermps-6.13.0/AzureRM.DevTestLabs/Set-AzureRmDtlVMsPerLabPolicy.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DevTestLabs.dll-Help.xml -Module Name: AzureRM.DevTestLabs -ms.assetid: D2A7ECF6-E2B1-4BD5-BEA6-C9EC0C7377BA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.devtestlabs/set-azurermdtlvmsperlabpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DevTestLabs/Commands.DevTestLabs/help/Set-AzureRmDtlVMsPerLabPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DevTestLabs/Commands.DevTestLabs/help/Set-AzureRmDtlVMsPerLabPolicy.md ---- - -# Set-AzureRmDtlVMsPerLabPolicy - -## SYNOPSIS -Sets the virtual machines per lab policy of a lab in DevTest Labs. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Enable (Default) -``` -Set-AzureRmDtlVMsPerLabPolicy [[-MaxVMs] <Int32>] [-Enable] [-LabName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Disable -``` -Set-AzureRmDtlVMsPerLabPolicy [[-MaxVMs] <Int32>] [-Disable] [-LabName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDtlVMsPerLabPolicy** cmdlet sets the virtual machines per lab policy of a lab, which sets the total number of virtual machines allowed in a lab. -The cmdlet uses the specified resource group and name of the lab to set the policy. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disable -Indicates that this cmdlet disables the policy of the lab. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Disable -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enable -Indicates that this cmdlet enables the policy of the lab. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Enable -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LabName -Specifies the name of the lab for which this cmdlet sets the virtual machines per lab policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaxVMs -Specifies the maximum number of virtual machines that can be created in the lab. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the lab belongs to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DevTestLabs.Models.PSPolicy - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDtlVMsPerLabPolicy](./Get-AzureRmDtlVMsPerLabPolicy.md) - - diff --git a/azurermps-6.13.0/AzureRM.DevTestLabs/Set-AzureRmDtlVMsPerUserPolicy.md b/azurermps-6.13.0/AzureRM.DevTestLabs/Set-AzureRmDtlVMsPerUserPolicy.md deleted file mode 100644 index e4d033da68..0000000000 --- a/azurermps-6.13.0/AzureRM.DevTestLabs/Set-AzureRmDtlVMsPerUserPolicy.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DevTestLabs.dll-Help.xml -Module Name: AzureRM.DevTestLabs -ms.assetid: D00E04D9-C91F-4F89-8867-0A026C274F27 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.devtestlabs/set-azurermdtlvmsperuserpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DevTestLabs/Commands.DevTestLabs/help/Set-AzureRmDtlVMsPerUserPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DevTestLabs/Commands.DevTestLabs/help/Set-AzureRmDtlVMsPerUserPolicy.md ---- - -# Set-AzureRmDtlVMsPerUserPolicy - -## SYNOPSIS -Sets the virtual machines per user policy of a lab in DevTest Labs. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Enable (Default) -``` -Set-AzureRmDtlVMsPerUserPolicy [[-MaxVMs] <Int32>] [-Enable] [-LabName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Disable -``` -Set-AzureRmDtlVMsPerUserPolicy [[-MaxVMs] <Int32>] [-Disable] [-LabName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDtlVMsPerUserPolicy** cmdlet sets the virtual machines per user policy of a lab, which sets the maximum number of virtual machines allowed per user. -The cmdlet uses the specified resource group and name of the lab to set the policy. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disable -Indicates that this cmdlet disables the policy for the lab. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Disable -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enable -Indicates that this cmdlet enables the policy for the lab. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Enable -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LabName -Specifies the name of the lab for which this cmdlet sets the virtual machines per user policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaxVMs -Specifies the maximum number of virtual machines that can be created in the lab. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the lab belongs to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.DevTestLabs.Models.PSPolicy - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDtlVMsPerUserPolicy](./Get-AzureRmDtlVMsPerUserPolicy.md) - - diff --git a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Add-AzureRmIoTDeviceProvisioningServiceAccessPolicy.md b/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Add-AzureRmIoTDeviceProvisioningServiceAccessPolicy.md deleted file mode 100644 index 9b98267d6e..0000000000 --- a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Add-AzureRmIoTDeviceProvisioningServiceAccessPolicy.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DeviceProvisioningServices.dll-Help.xml -Module Name: AzureRM.DeviceProvisioningServices -online version: -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/Add-AzureRmIoTDeviceProvisioningServiceAccessPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/Add-AzureRmIoTDeviceProvisioningServiceAccessPolicy.md ---- - -# Add-AzureRmIoTDeviceProvisioningServiceAccessPolicy - -## SYNOPSIS -Add a new shared access policy in an Azure IoT Hub device provisioning service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceSet (Default) -``` -Add-AzureRmIoTDeviceProvisioningServiceAccessPolicy [-ResourceGroupName] <String> [-Name] <String> - [-KeyName] <String> [-Permissions] <String[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### InputObjectSet -``` -Add-AzureRmIoTDeviceProvisioningServiceAccessPolicy [-DpsObject] <PSProvisioningServiceDescription> - [-KeyName] <String> [-Permissions] <String[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ResourceIdSet -``` -Add-AzureRmIoTDeviceProvisioningServiceAccessPolicy [-ResourceId] <String> [-KeyName] <String> - [-Permissions] <String[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -For an introduction to Azure IoT Hub Device Provisioning Service, see https://docs.microsoft.com/en-us/azure/iot-dps/about-iot-dps. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Add-AzureRmIoTDeviceProvisioningServiceAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" -KeyName "mypolicy" -Permissions "ServiceConfig, EnrollmentWrite" - -ResourceGroupName : myresourcegroup -Name : myiotdps -KeyName : mypolicy -PrimaryKey : hyZJm8W7rra9O7eKhkLu9m/CIPPt9x1NXVMbMJa1rvg= -SecondaryKey : vbIwGCBQCIbS5BKFKdddM6uZHLhNTuz9r8CZYgmTmpY= -Rights : ServiceConfig, EnrollmentWrite -``` - -Add a new shared access policy in an Azure IoT Hub device provisioning service with EnrollmentWrite and ServiceConfig rights. - -### Example 2 -``` -PS C:\> Add-AzureRmIoTDpsAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" -KeyName "mypolicy2" -Permissions "EnrollmentRead" - -KeyName Rights -------- ------ -mypolicy1 ServiceConfig, EnrollmentWrite -mypolicy2 EnrollmentRead -``` - -Add a new shared access policy in an Azure IoT Hub device provisioning service with EnrollmentRead right. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DpsObject -IoT Device Provisioning Service Object - -```yaml -Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription -Parameter Sets: InputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -KeyName -IoT Device Provisioning Service access policy key name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the IoT Device Provisioning Service - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Permissions -IoT Device Provisioning Service access policy permissions - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: -Accepted values: ServiceConfig, EnrollmentRead, EnrollmentWrite, DeviceConnect, RegistrationStatusRead, RegistrationStatusWrite - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -IoT Device Provisioning Service Resource Id - -```yaml -Type: System.String -Parameter Sets: ResourceIdSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription -Parameters: DpsObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSSharedAccessSignatureAuthorizationRuleAccessRightsDescription - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Add-AzureRmIoTDeviceProvisioningServiceCertificate.md b/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Add-AzureRmIoTDeviceProvisioningServiceCertificate.md deleted file mode 100644 index 42807f6db9..0000000000 --- a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Add-AzureRmIoTDeviceProvisioningServiceCertificate.md +++ /dev/null @@ -1,251 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DeviceProvisioningServices.dll-Help.xml -Module Name: AzureRM.DeviceProvisioningServices -online version: -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/Add-AzureRmIoTDeviceProvisioningServiceCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/Add-AzureRmIoTDeviceProvisioningServiceCertificate.md ---- - -# Add-AzureRmIoTDeviceProvisioningServiceCertificate - -## SYNOPSIS -Create/update an Azure IoT Hub Device Provisioning Service certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceSet (Default) -``` -Add-AzureRmIoTDeviceProvisioningServiceCertificate [-ResourceGroupName] <String> [-Name] <String> - [-CertificateName] <String> [-Path] <String> [-Etag <String>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectSet -``` -Add-AzureRmIoTDeviceProvisioningServiceCertificate [-InputObject] <PSCertificateResponse> - [-CertificateName] <String> [-Path] <String> [-Etag <String>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdSet -``` -Add-AzureRmIoTDeviceProvisioningServiceCertificate [-ResourceId] <String> [-CertificateName] <String> - [-Path] <String> [-Etag <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Uploads a new certificate or to replace the existing certificate with the same name. -For a detailed explanation of CA certificates in Azure IoT Hub Device Provisioning Service, see https://docs.microsoft.com/en-us/azure/iot-dps/how-to-verify-certificates. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Add-AzureRmIoTDeviceProvisioningServiceCertificate -ResourceGroupName "myresourcegroup" -Name "myiotdps" -CertificateName "mycertificate" -Path "c:\mycertificate.cer" - -Id : /subscriptions/377cxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Devices/provisioningServices/myiotdps/certificates/mycertificate -ResourceGroupName : myresourcegroup -Name : myiotdps -CertificateName : mycertificate -Subject : CN=mycertificate -Thumbprint : 38303FC7371EC78DDE3E18D712C8414EE50969C7 -Status : Unverified -Expiry : 1/01/2027 16:01 -Created : 1/01/2017 16:01 -Etag : AAAAAAFpGcA= -``` - -Upload a CA certificate CER file to an Azure IoT Hub device provisioning service. - -### Example 2 -``` -PS C:\> Add-AzureRmIoTDpsCertificate -ResourceGroupName "myresourcegroup" -Name "myiotdps" -CertificateName "mycertificate" -Path "c:\mycertificate.cer" -Etag "AAAAAAFpGcA=" - -Id : /subscriptions/377cxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Devices/provisioningServices/myiothub/certificates/mycertificate -ResourceGroupName : myresourcegroup -Name : myiotdps -CertificateName : mycertificate -Subject : CN=mycertificate -Thumbprint : 38303FC7371EC13DDE3E18D712C8414EE50969C7 -Status : Unverified -Expiry : 1/01/2027 16:01 -Created : 1/01/2017 16:01 -Etag : AAAAAAFpObE= -``` - -Updates a CA certificate in an IoT hub device provisioning service by uploading a new CER file. - -## PARAMETERS - -### -CertificateName -Name of the Iot device provisioning service certificate - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Etag -Etag of the Certificate - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -IoT Device Provisioning Service Certificate Object - -```yaml -Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSCertificateResponse -Parameter Sets: InputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the IoT Device Provisioning Service - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -base-64 representation of X509 certificate .cer file or .pem file path - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -IoT Device Provisioning Service Certificate Resource Id - -```yaml -Type: System.String -Parameter Sets: ResourceIdSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSCertificateResponse -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSCertificateResponse - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Add-AzureRmIoTDeviceProvisioningServiceLinkedHub.md b/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Add-AzureRmIoTDeviceProvisioningServiceLinkedHub.md deleted file mode 100644 index 05222fc9eb..0000000000 --- a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Add-AzureRmIoTDeviceProvisioningServiceLinkedHub.md +++ /dev/null @@ -1,258 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DeviceProvisioningServices.dll-Help.xml -Module Name: AzureRM.DeviceProvisioningServices -online version: -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/Add-AzureRmIoTDeviceProvisioningServiceLinkedHub.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/Add-AzureRmIoTDeviceProvisioningServiceLinkedHub.md ---- - -# Add-AzureRmIoTDeviceProvisioningServiceLinkedHub - -## SYNOPSIS -Linked IoT hub to an Azure IoT Hub device provisioning service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceSet (Default) -``` -Add-AzureRmIoTDeviceProvisioningServiceLinkedHub [-ResourceGroupName] <String> [-Name] <String> - [-IotHubConnectionString] <String> [-IotHubLocation] <String> [-AllocationWeight <Int32>] - [-ApplyAllocationPolicy] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectSet -``` -Add-AzureRmIoTDeviceProvisioningServiceLinkedHub [-DpsObject] <PSProvisioningServiceDescription> - [-IotHubConnectionString] <String> [-IotHubLocation] <String> [-AllocationWeight <Int32>] - [-ApplyAllocationPolicy] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdSet -``` -Add-AzureRmIoTDeviceProvisioningServiceLinkedHub [-ResourceId] <String> [-IotHubConnectionString] <String> - [-IotHubLocation] <String> [-AllocationWeight <Int32>] [-ApplyAllocationPolicy] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -For an introduction to Azure IoT Hub Device Provisioning Service, see https://docs.microsoft.com/en-us/azure/iot-dps/about-iot-dps. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Add-AzureRmIoTDeviceProvisioningServiceLinkedHub -ResourceGroupName "myresourcegroup" -Name "myiotdps" -IotHubConnectionString $hubConnectionString -IotHubLocation "eastus" - -ResourceGroupName : myresourcegroup -Name : myiotdps -LinkedHubName : myiothub.azure-devices.net -ConnectionString : HostName=myiothub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=**** -AllocationWeight : -ApplyAllocationPolicy : -Location : eastus -``` - -Linked IoT hub to an Azure IoT Hub device provisioning service. - -### Example 2 -``` -PS C:\> Add-AzureRmIoTDpsHub -ResourceGroupName "myresourcegroup" -Name "myiotdps" -IotHubConnectionString $hubConnectionString -IotHubLocation "eastus" -AllocationWeight 10 -ApplyAllocationPolicy $false - -LinkedHubName Location AllocationWeight ApplyAllocationPolicy -------------- -------- ---------------- --------------------- -myiothub1.azure-devices.net eastus 2 true -myiothub2.azure-devices.net westus2 10 false -``` - -Linked IoT hub to an Azure IoT Hub device provisioning service with AllocationWeight and ApplyAllocationPolicy. - -## PARAMETERS - -### -AllocationWeight -Allocation weight of the IoT Hub - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplyAllocationPolicy -A boolean indicating whether to apply allocation policy to the IoT Hub - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DpsObject -IoT Device Provisioning Service Object - -```yaml -Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription -Parameter Sets: InputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IotHubConnectionString -Connection String of the Iot Hub resource. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IotHubLocation -Location of the Iot Hub - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the IoT Device Provisioning Service - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -IoT Device Provisioning Service Resource Id - -```yaml -Type: System.String -Parameter Sets: ResourceIdSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription -Parameters: DpsObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSIotHubDefinitionDescription - -### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSIotHubDefinitions - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/AzureRM.DeviceProvisioningServices.md b/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/AzureRM.DeviceProvisioningServices.md deleted file mode 100644 index 680d045ba3..0000000000 --- a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/AzureRM.DeviceProvisioningServices.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -Module Name: AzureRM.DeviceProvisioningServices -Module Guid: a9f5b86f-63be-4e7a-8e16-c8c7c36cae40 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.deviceprovisioningservices -Help Version: 1.0.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/AzureRM.DeviceProvisioningServices.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/AzureRM.DeviceProvisioningServices.md ---- - -# AzureRM.DeviceProvisioningServices Module -## Description -Commands for Managing Azure IoT Hub Device Provisioning Service. - -## AzureRM.DeviceProvisioningServices Cmdlets -### [Add-AzureRmIoTDeviceProvisioningServiceAccessPolicy](Add-AzureRmIoTDeviceProvisioningServiceAccessPolicy.md) -Add a new shared access policy in an Azure IoT Hub device provisioning service. - -### [Add-AzureRmIoTDeviceProvisioningServiceCertificate](Add-AzureRmIoTDeviceProvisioningServiceCertificate.md) -Create/update an Azure IoT Hub Device Provisioning Service certificate. - -### [Add-AzureRmIoTDeviceProvisioningServiceLinkedHub](Add-AzureRmIoTDeviceProvisioningServiceLinkedHub.md) -Linked IoT hub to an Azure IoT Hub device provisioning service. - -### [Get-AzureRmIoTDeviceProvisioningService](Get-AzureRmIoTDeviceProvisioningService.md) -List all or show details of Azure IoT Hub device provisioning services. - -### [Get-AzureRmIoTDeviceProvisioningServiceAccessPolicy](Get-AzureRmIoTDeviceProvisioningServiceAccessPolicy.md) -List all or show details of shared access policies in an Azure IoT Hub device provisioning service. - -### [Get-AzureRmIoTDeviceProvisioningServiceCertificate](Get-AzureRmIoTDeviceProvisioningServiceCertificate.md) -Lists all certificates or a particular certificate contained within an Azure IoT Hub Device Provisioning Service. - -### [Get-AzureRmIoTDeviceProvisioningServiceLinkedHub](Get-AzureRmIoTDeviceProvisioningServiceLinkedHub.md) -List all or show details of linked IoT hubs in an Azure IoT Hub device provisioning service. - -### [New-AzureRmIoTDeviceProvisioningService](New-AzureRmIoTDeviceProvisioningService.md) -Create an Azure IoT Hub device provisioning service. - -### [New-AzureRmIoTDeviceProvisioningServiceCertificateVerificationCode](New-AzureRmIoTDeviceProvisioningServiceCertificateVerificationCode.md) -Generate a verification code for an Azure IoT Hub Device Provisioning Service certificate. - -### [Remove-AzureRmIoTDeviceProvisioningService](Remove-AzureRmIoTDeviceProvisioningService.md) -Delete an Azure IoT Hub device provisioning service. - -### [Remove-AzureRmIoTDeviceProvisioningServiceAccessPolicy](Remove-AzureRmIoTDeviceProvisioningServiceAccessPolicy.md) -Delete a shared access policies in an Azure IoT Hub device provisioning service. - -### [Remove-AzureRmIoTDeviceProvisioningServiceCertificate](Remove-AzureRmIoTDeviceProvisioningServiceCertificate.md) -Delete an Azure IoT Hub Device Provisioning Service certificate. - -### [Remove-AzureRmIoTDeviceProvisioningServiceLinkedHub](Remove-AzureRmIoTDeviceProvisioningServiceLinkedHub.md) -Delete a linked IoT hub in an Azure IoT Hub device provisioning service. - -### [Set-AzureRmIoTDeviceProvisioningServiceCertificate](Set-AzureRmIoTDeviceProvisioningServiceCertificate.md) -Verify an Azure IoT Hub Device Provisioning Service certificate. - -### [Update-AzureRmIoTDeviceProvisioningService](Update-AzureRmIoTDeviceProvisioningService.md) -Update an Azure IoT Hub device provisioning service. - -### [Update-AzureRmIoTDeviceProvisioningServiceAccessPolicy](Update-AzureRmIoTDeviceProvisioningServiceAccessPolicy.md) -Update a shared access policy in an Azure IoT Hub device provisioning service. - -### [Update-AzureRmIoTDeviceProvisioningServiceLinkedHub](Update-AzureRmIoTDeviceProvisioningServiceLinkedHub.md) -Update a linked IoT hub in an Azure IoT Hub device provisioning service. - diff --git a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Get-AzureRmIoTDeviceProvisioningService.md b/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Get-AzureRmIoTDeviceProvisioningService.md deleted file mode 100644 index 603899fc3a..0000000000 --- a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Get-AzureRmIoTDeviceProvisioningService.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DeviceProvisioningServices.dll-Help.xml -Module Name: AzureRM.DeviceProvisioningServices -online version: -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/Get-AzureRmIoTDeviceProvisioningService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/Get-AzureRmIoTDeviceProvisioningService.md ---- - -# Get-AzureRmIoTDeviceProvisioningService - -## SYNOPSIS -List all or show details of Azure IoT Hub device provisioning services. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ListIotDpsByResourceGroup (Default) -``` -Get-AzureRmIoTDeviceProvisioningService [-ResourceGroupName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetIotDpsByName -``` -Get-AzureRmIoTDeviceProvisioningService -ResourceGroupName <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -For an introduction to Azure IoT Hub Device Provisioning Service, see https://docs.microsoft.com/en-us/azure/iot-dps/about-iot-dps. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmIoTDeviceProvisioningService - -ResourceGroupName Name Location ServiceOperationsHostName IotHubs AllocationPolicy Tags State ------------------ ---- -------- ------------------------- ------- ---------------- ---- ----- -myresourcegroup0 myiotdps0 eastus myiotdps0.azure-devices-provisioning.net 0 Static 0 Active -myresourcegroup1 myiotdps1 eastus myiotdps1.azure-devices-provisioning.net 4 Hashed 0 Active -myresourcegroup1 myiotdps2 westus myiotdps2.azure-devices-provisioning.net 4 GeoLatency 0 Active -``` - -List all Azure IoT Hub device provisioning services in a subscription. - -### Example 2 -``` -PS C:\> Get-AzureRmIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" - -ResourceGroupName Name Location ServiceOperationsHostName IotHubs AllocationPolicy Tags State ------------------ ---- -------- ------------------------- ------- ---------------- ---- ----- -myresourcegroup myiotdps1 eastus myiotdps1.azure-devices-provisioning.net 1 Hashed 0 Active -myresourcegroup myiotdps2 westus myiotdps2.azure-devices-provisioning.net 4 GeoLatency 0 Active -``` - -List all Azure IoT Hub device provisioning services in the resource group 'myresourcegroup'. - -### Example 3 -``` -PS C:\> Get-AzureRmIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" -Name "myiotdps" - -ResourceGroupName : myresourcegroup -Name : myiotdps -Location : eastus -Type : Microsoft.Devices/provisioningServices -ServiceOperationsHostName : myiotdps.azure-devices-provisioning.net -IotHubs : 0 -State : Active -AllocationPolicy : Hashed -Tags : {} -SkuName : S1 -SkuTier : Standard -Etag : AAAAAAAT52k= -``` - -Show details of an Azure IoT Hub device provisioning service 'myiotdps'. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the IoT Device Provisioning Service - -```yaml -Type: System.String -Parameter Sets: GetIotDpsByName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group - -```yaml -Type: System.String -Parameter Sets: ListIotDpsByResourceGroup -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: GetIotDpsByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Get-AzureRmIoTDeviceProvisioningServiceAccessPolicy.md b/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Get-AzureRmIoTDeviceProvisioningServiceAccessPolicy.md deleted file mode 100644 index 7a128674c9..0000000000 --- a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Get-AzureRmIoTDeviceProvisioningServiceAccessPolicy.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DeviceProvisioningServices.dll-Help.xml -Module Name: AzureRM.DeviceProvisioningServices -online version: -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/Get-AzureRmIoTDeviceProvisioningServiceAccessPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/Get-AzureRmIoTDeviceProvisioningServiceAccessPolicy.md ---- - -# Get-AzureRmIoTDeviceProvisioningServiceAccessPolicy - -## SYNOPSIS -List all or show details of shared access policies in an Azure IoT Hub device provisioning service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceSet (Default) -``` -Get-AzureRmIoTDeviceProvisioningServiceAccessPolicy [-ResourceGroupName] <String> [-Name] <String> - [-KeyName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### InputObjectSet -``` -Get-AzureRmIoTDeviceProvisioningServiceAccessPolicy [-DpsObject] <PSProvisioningServiceDescription> - [-KeyName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceIdSet -``` -Get-AzureRmIoTDeviceProvisioningServiceAccessPolicy [-ResourceId] <String> [-KeyName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -For an introduction to Azure IoT Hub Device Provisioning Service, see https://docs.microsoft.com/en-us/azure/iot-dps/about-iot-dps. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmIoTDeviceProvisioningServiceAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" - -KeyName Rights -------- ------ -mypolicy1 ServiceConfig, DeviceConnect, EnrollmentWrite -mypolicy2 EnrollmentWrite -``` - -List all shared access policies in "myiotdps". - -### Example 2 -``` -PS C:\> Get-AzureRmIoTDeviceProvisioningServiceAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" -KeyName "mypolicy" - -ResourceGroupName : myresourcegroup -Name : myiotdps -KeyName : mypolicy -PrimaryKey : hyZJm8W7rra9O7eKhkLu9m/CIPPt9x1NXVMbMJa1rvg= -SecondaryKey : vbIwGCBQCIbS5BKFKdddM6uZHLhNTuz9r8CZYgmTmpY= -Rights : ServiceConfig, DeviceConnect, EnrollmentWrite -``` - -Show details of shared access policy "mypolicy" in an Azure IoT Hub device provisioning service. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DpsObject -IoT Device Provisioning Service Object - -```yaml -Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription -Parameter Sets: InputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -KeyName -IoT Device Provisioning Service access policy key name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the IoT Device Provisioning Service - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -IoT Device Provisioning Service Resource Id - -```yaml -Type: System.String -Parameter Sets: ResourceIdSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription -Parameters: DpsObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSSharedAccessSignatureAuthorizationRuleAccessRightsDescription - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Get-AzureRmIoTDeviceProvisioningServiceCertificate.md b/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Get-AzureRmIoTDeviceProvisioningServiceCertificate.md deleted file mode 100644 index a981f0b85f..0000000000 --- a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Get-AzureRmIoTDeviceProvisioningServiceCertificate.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DeviceProvisioningServices.dll-Help.xml -Module Name: AzureRM.DeviceProvisioningServices -online version: -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/Get-AzureRmIoTDeviceProvisioningServiceCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/Get-AzureRmIoTDeviceProvisioningServiceCertificate.md ---- - -# Get-AzureRmIoTDeviceProvisioningServiceCertificate - -## SYNOPSIS -Lists all certificates or a particular certificate contained within an Azure IoT Hub Device Provisioning Service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceSet (Default) -``` -Get-AzureRmIoTDeviceProvisioningServiceCertificate [-ResourceGroupName] <String> [-Name] <String> - [-CertificateName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### InputObjectSet -``` -Get-AzureRmIoTDeviceProvisioningServiceCertificate [-DpsObject] <PSProvisioningServiceDescription> - [-CertificateName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceIdSet -``` -Get-AzureRmIoTDeviceProvisioningServiceCertificate [-ResourceId] <String> [-CertificateName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -For a detailed explanation of CA certificates in Azure IoT Hub Device Provisioning Service, see https://docs.microsoft.com/en-us/azure/iot-dps/how-to-verify-certificates. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmIoTDeviceProvisioningServiceCertificate -ResourceGroupName "myresourcegroup" -Name "myiotdps" -CertificateName "mycertificate" - -Id : /subscriptions/377cxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Devices/provisioningServices/myiotdps/certificates/mycertificate -ResourceGroupName : myresourcegroup -Name : myiotdps -CertificateName : mycertificate -Subject : CN=mycertificate -Thumbprint : 38303FC7371EC78DDE3E18D712C8414EE50969C7 -Status : Unverified -Expiry : 1/01/2027 16:01 -Created : 1/01/2017 16:01 -Etag : AAAAAAFpGcA= -``` - -Show details about "mycertificate" in an Azure IoT Hub device provisioning service. - -### Example 2 -``` -PS C:\> Get-AzureRmIoTDps -ResourceGroupName "myresourcegroup" -Name "myiotdps" | Get-AzureRmIoTDpsCertificate - -ResourceGroupName Name CertificateName Status Expiry ------------------ ---- --------------- ------ ------ -myresourcegroup myiotdps mycert1 Unverified 12/04/2027 13:12 -myresourcegroup myiotdps mycert2 Unverified 12/04/2027 13:12 -``` - -List all certificates in "myiotdps" using pipeline. - -## PARAMETERS - -### -CertificateName -Name of the Certificate - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DpsObject -IoT Device Provisioning Service Object - -```yaml -Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription -Parameter Sets: InputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the IoT Device Provisioning Service - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -IoT Device Provisioning Service Resource Id - -```yaml -Type: System.String -Parameter Sets: ResourceIdSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription -Parameters: DpsObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSCertificateResponse - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Get-AzureRmIoTDeviceProvisioningServiceLinkedHub.md b/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Get-AzureRmIoTDeviceProvisioningServiceLinkedHub.md deleted file mode 100644 index 231d6b73d3..0000000000 --- a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Get-AzureRmIoTDeviceProvisioningServiceLinkedHub.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DeviceProvisioningServices.dll-Help.xml -Module Name: AzureRM.DeviceProvisioningServices -online version: -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/Get-AzureRmIoTDeviceProvisioningServiceLinkedHub.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/Get-AzureRmIoTDeviceProvisioningServiceLinkedHub.md ---- - -# Get-AzureRmIoTDeviceProvisioningServiceLinkedHub - -## SYNOPSIS -List all or show details of linked IoT hubs in an Azure IoT Hub device provisioning service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceSet (Default) -``` -Get-AzureRmIoTDeviceProvisioningServiceLinkedHub [-ResourceGroupName] <String> [-Name] <String> - [-LinkedHubName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### InputObjectSet -``` -Get-AzureRmIoTDeviceProvisioningServiceLinkedHub [-DpsObject] <PSProvisioningServiceDescription> - [-LinkedHubName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceIdSet -``` -Get-AzureRmIoTDeviceProvisioningServiceLinkedHub [-ResourceId] <String> [-LinkedHubName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -For an introduction to Azure IoT Hub Device Provisioning Service, see https://docs.microsoft.com/en-us/azure/iot-dps/about-iot-dps. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmIoTDeviceProvisioningServiceLinkedHub -ResourceGroupName "myresourcegroup" -Name "myiotdps" - -LinkedHubName Location AllocationWeight ApplyAllocationPolicy -------------- -------- ---------------- --------------------- -myiothub1.azure-devices.net eastus 2 -myiothub2.azure-devices.net westus2 true -``` - -List all linked IoT hubs in "myiotdps". - -### Example 2 -``` -PS C:\> Get-AzureRmIoTDpsHub -ResourceGroupName "myresourcegroup" -Name "myiotdps" -LinkedHubName "myiothub1" - -ResourceGroupName : myresourcegroup -Name : myiotdps -LinkedHubName : myiothub1.azure-devices.net -ConnectionString : HostName=myiothub1.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=**** -AllocationWeight : 2 -ApplyAllocationPolicy : -Location : eastus -``` - -Show details of linked IoT hub "myiothub1" in an Azure IoT Hub device provisioning service. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DpsObject -IoT Device Provisioning Service Object - -```yaml -Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription -Parameter Sets: InputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LinkedHubName -Host name of linked IoT Hub - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the IoT Device Provisioning Service - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -IoT Device Provisioning Service Resource Id - -```yaml -Type: System.String -Parameter Sets: ResourceIdSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription -Parameters: DpsObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSIotHubDefinitionDescription - -### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSIotHubDefinitions - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/New-AzureRmIoTDeviceProvisioningService.md b/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/New-AzureRmIoTDeviceProvisioningService.md deleted file mode 100644 index 57fbd86c39..0000000000 --- a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/New-AzureRmIoTDeviceProvisioningService.md +++ /dev/null @@ -1,208 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DeviceProvisioningServices.dll-Help.xml -Module Name: AzureRM.DeviceProvisioningServices -online version: -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/New-AzureRmIoTDeviceProvisioningService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/New-AzureRmIoTDeviceProvisioningService.md ---- - -# New-AzureRmIoTDeviceProvisioningService - -## SYNOPSIS -Create an Azure IoT Hub device provisioning service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmIoTDeviceProvisioningService [-ResourceGroupName] <String> [-Name] <String> [-Location <String>] - [-AllocationPolicy <String>] [-SkuName <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -For an introduction to Azure IoT Hub Device Provisioning Service, see https://docs.microsoft.com/en-us/azure/iot-dps/about-iot-dps. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" -Name "myiotdps" - -ResourceGroupName : myresourcegroup -Name : myiotdps -Location : westus -Type : Microsoft.Devices/provisioningServices -ServiceOperationsHostName : myiotdps.azure-devices-provisioning.net -IotHubs : 0 -State : Active -AllocationPolicy : Hashed -Tags : {} -SkuName : S1 -SkuTier : Standard -Etag : AAAAAAAT52k= -``` - -Create an Azure IoT Hub device provisioning service with the standard pricing tier S1, in the region of the resource group. - -### Example 2 -``` -PS C:\> New-AzureRmIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" -Name "myiotdps" -Location "eastus" - -ResourceGroupName : myresourcegroup -Name : myiotdps -Location : eastus -Type : Microsoft.Devices/provisioningServices -ServiceOperationsHostName : myiotdps.azure-devices-provisioning.net -IotHubs : 0 -State : Active -AllocationPolicy : Hashed -Tags : {} -SkuName : S1 -SkuTier : Standard -Etag : AAAAAAAPoOk= -``` - -Create an Azure IoT Hub device provisioning service with the standard pricing tier S1, in the 'eastus' region. - -## PARAMETERS - -### -AllocationPolicy -IoT Device Provisioning Service Allocation policy - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Hashed, GeoLatency, Static - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Location - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the IoT Device Provisioning Service - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkuName -Sku - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: S1 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/New-AzureRmIoTDeviceProvisioningServiceCertificateVerificationCode.md b/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/New-AzureRmIoTDeviceProvisioningServiceCertificateVerificationCode.md deleted file mode 100644 index abfcad126b..0000000000 --- a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/New-AzureRmIoTDeviceProvisioningServiceCertificateVerificationCode.md +++ /dev/null @@ -1,236 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DeviceProvisioningServices.dll-Help.xml -Module Name: AzureRM.DeviceProvisioningServices -online version: -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/New-AzureRmIoTDeviceProvisioningServiceCertificateVerificationCode.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/New-AzureRmIoTDeviceProvisioningServiceCertificateVerificationCode.md ---- - -# New-AzureRmIoTDeviceProvisioningServiceCertificateVerificationCode - -## SYNOPSIS -Generate a verification code for an Azure IoT Hub Device Provisioning Service certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceSet (Default) -``` -New-AzureRmIoTDeviceProvisioningServiceCertificateVerificationCode [-ResourceGroupName] <String> - [-Name] <String> [-CertificateName] <String> [-Etag] <String> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectSet -``` -New-AzureRmIoTDeviceProvisioningServiceCertificateVerificationCode [-InputObject] <PSCertificateResponse> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdSet -``` -New-AzureRmIoTDeviceProvisioningServiceCertificateVerificationCode [-ResourceId] <String> [-Etag] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -This verification code is used to complete the proof of possession step for a certificate. Use this verification code as the CN of a new certificate signed with the root certificates private key. -For a detailed explanation of CA certificates in Azure IoT Hub Device Provisioning Service, see https://docs.microsoft.com/en-us/azure/iot-dps/how-to-verify-certificates. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmIoTDeviceProvisioningServiceCertificateVerificationCode -ResourceGroupName "myresourcegroup" -Name "myiotdps" -CertificateName "mycertificate" -Etag "AAAAAAFPazE=" - -Id : /subscriptions/377cxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Devices/provisioningServices/myiotdps/certificates/mycertificate -ResourceGroupName : myresourcegroup -Name : myiotdps -CertificateName : mycertificate -Subject : CN=mycertificate -Thumbprint : 38303FC7371EC78DDE3E18D712C8414EE50969C7 -VerificationCode : A901A843EFF75419AC1F0EB460E85DF153092A0547AA30F5 -Status : Unverified -Expiry : 1/01/2027 16:01 -Created : 1/01/2017 16:01 -Etag : AAAAAAFpGcA= -``` - -Generate a verification code for "mycertificate". - -### Example 2 -``` -PS C:\> Get-AzureRmIoTDpsCertificate -ResourceGroupName "myresourcegroup" -Name "myiotdps" -CertificateName "mycertificate" | New-AzureRmIoTDpsCVC - -Id : /subscriptions/377cxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Devices/provisioningServices/myiotdps/certificates/mycertificate -ResourceGroupName : myresourcegroup -Name : myiotdps -CertificateName : mycertificate -Subject : CN=mycertificate -Thumbprint : 38303FC7371EC78DDE3E18D712C8414EE50969C7 -VerificationCode : A901A843EFF75419AC1F0EB460E85DF153092A0547AA30F5 -Status : Unverified -Expiry : 1/01/2027 16:01 -Created : 1/01/2017 16:01 -Etag : AAAAAAFpGcA= -``` - -Generate a verification code for "mycertificate" using pipeline. - -## PARAMETERS - -### -CertificateName -Name of the Iot device provisioning service certificate - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Etag -Etag of the Certificate - -```yaml -Type: System.String -Parameter Sets: ResourceSet, ResourceIdSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -IoT Device Provisioning Service Certificate Object - -```yaml -Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSCertificateResponse -Parameter Sets: InputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the IoT Device Provisioning Service - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -IoT Device Provisioning Service Certificate Resource Id - -```yaml -Type: System.String -Parameter Sets: ResourceIdSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSCertificateResponse -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSVerificationCodeResponse - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Remove-AzureRmIoTDeviceProvisioningService.md b/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Remove-AzureRmIoTDeviceProvisioningService.md deleted file mode 100644 index 8beee162ee..0000000000 --- a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Remove-AzureRmIoTDeviceProvisioningService.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DeviceProvisioningServices.dll-Help.xml -Module Name: AzureRM.DeviceProvisioningServices -online version: -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/Remove-AzureRmIoTDeviceProvisioningService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/Remove-AzureRmIoTDeviceProvisioningService.md ---- - -# Remove-AzureRmIoTDeviceProvisioningService - -## SYNOPSIS -Delete an Azure IoT Hub device provisioning service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceSet (Default) -``` -Remove-AzureRmIoTDeviceProvisioningService [-ResourceGroupName] <String> [-Name] <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectSet -``` -Remove-AzureRmIoTDeviceProvisioningService [-InputObject] <PSProvisioningServiceDescription> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdSet -``` -Remove-AzureRmIoTDeviceProvisioningService [-ResourceId] <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -For an introduction to Azure IoT Hub Device Provisioning Service, see https://docs.microsoft.com/en-us/azure/iot-dps/about-iot-dps. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" -Name "myiotdps" -PassThru - -True -``` - -Delete an Azure IoT Hub device provisioning service 'myiotdps'. - -### Example 2 -``` -PS C:\> Get-AzureRmIotDps -ResourceGroupName "myresourcegroup" -Name "myiotdps" | Remove-AzureRmIotDps -``` - -Delete an Azure IoT Hub device provisioning service 'myiotdps' using pipeline. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -IoT Device Provisioning Service Object - -```yaml -Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription -Parameter Sets: InputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the IoT Device Provisioning Service - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -IoT Device Provisioning Service Resource Id - -```yaml -Type: System.String -Parameter Sets: ResourceIdSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Remove-AzureRmIoTDeviceProvisioningServiceAccessPolicy.md b/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Remove-AzureRmIoTDeviceProvisioningServiceAccessPolicy.md deleted file mode 100644 index 3150694be8..0000000000 --- a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Remove-AzureRmIoTDeviceProvisioningServiceAccessPolicy.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DeviceProvisioningServices.dll-Help.xml -Module Name: AzureRM.DeviceProvisioningServices -online version: -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/Remove-AzureRmIoTDeviceProvisioningServiceAccessPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/Remove-AzureRmIoTDeviceProvisioningServiceAccessPolicy.md ---- - -# Remove-AzureRmIoTDeviceProvisioningServiceAccessPolicy - -## SYNOPSIS -Delete a shared access policies in an Azure IoT Hub device provisioning service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceSet (Default) -``` -Remove-AzureRmIoTDeviceProvisioningServiceAccessPolicy [-ResourceGroupName] <String> [-Name] <String> - [-KeyName] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### InputObjectSet -``` -Remove-AzureRmIoTDeviceProvisioningServiceAccessPolicy - [-InputObject] <PSSharedAccessSignatureAuthorizationRuleAccessRightsDescription> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdSet -``` -Remove-AzureRmIoTDeviceProvisioningServiceAccessPolicy [-ResourceId] <String> [-KeyName] <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -For an introduction to Azure IoT Hub Device Provisioning Service, see https://docs.microsoft.com/en-us/azure/iot-dps/about-iot-dps. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmIoTDeviceProvisioningServiceAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" -KeyName "mypolicy" -PassThru - -True -``` - -Delete shared access policy "mypolicy" in an Azure IoT Hub device provisioning service. - -### Example 2 -``` -PS C:\> Get-AzureRmIoTDpsAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" -KeyName "mypolicy" | Remove-AzureRmIoTDpsAccessPolicy -``` - -Delete shared access policy "mypolicy" in an Azure IoT Hub device provisioning service using pipeline. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -IoT Device Provisioning Service Object - -```yaml -Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSSharedAccessSignatureAuthorizationRuleAccessRightsDescription -Parameter Sets: InputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -KeyName -IoT Device Provisioning Service access policy key name - -```yaml -Type: System.String -Parameter Sets: ResourceSet, ResourceIdSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the IoT Device Provisioning Service - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -IoT Device Provisioning Service Resource Id - -```yaml -Type: System.String -Parameter Sets: ResourceIdSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSSharedAccessSignatureAuthorizationRuleAccessRightsDescription -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Remove-AzureRmIoTDeviceProvisioningServiceCertificate.md b/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Remove-AzureRmIoTDeviceProvisioningServiceCertificate.md deleted file mode 100644 index aadccd3f6a..0000000000 --- a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Remove-AzureRmIoTDeviceProvisioningServiceCertificate.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DeviceProvisioningServices.dll-Help.xml -Module Name: AzureRM.DeviceProvisioningServices -online version: -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/Remove-AzureRmIoTDeviceProvisioningServiceCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/Remove-AzureRmIoTDeviceProvisioningServiceCertificate.md ---- - -# Remove-AzureRmIoTDeviceProvisioningServiceCertificate - -## SYNOPSIS -Delete an Azure IoT Hub Device Provisioning Service certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceSet (Default) -``` -Remove-AzureRmIoTDeviceProvisioningServiceCertificate [-ResourceGroupName] <String> [-Name] <String> - [-CertificateName] <String> [-Etag] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### InputObjectSet -``` -Remove-AzureRmIoTDeviceProvisioningServiceCertificate [-InputObject] <PSCertificateResponse> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdSet -``` -Remove-AzureRmIoTDeviceProvisioningServiceCertificate [-ResourceId] <String> [-Etag] <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -For a detailed explanation of CA certificates in Azure IoT Hub Device Provisioning Service, see https://docs.microsoft.com/en-us/azure/iot-dps/how-to-verify-certificates. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmIoTDeviceProvisioningServiceCertificate -ResourceGroupName "myresourcegroup" -Name "myiotdps" -CertificateName "mycertificate" -Etag "AAAAAAFPazE=" -PassThru - -True -``` - -Delete "mycertificate" in an Azure IoT Hub device provisioning service. - -## PARAMETERS - -### -CertificateName -Name of the Certificate - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Etag -Etag of the Certificate - -```yaml -Type: System.String -Parameter Sets: ResourceSet, ResourceIdSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -IoT Device Provisioning Service Certificate Object - -```yaml -Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSCertificateResponse -Parameter Sets: InputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the IoT Device Provisioning Service - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -IoT Device Provisioning Service Certificate Resource Id - -```yaml -Type: System.String -Parameter Sets: ResourceIdSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSCertificateResponse -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Remove-AzureRmIoTDeviceProvisioningServiceLinkedHub.md b/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Remove-AzureRmIoTDeviceProvisioningServiceLinkedHub.md deleted file mode 100644 index 66c1940211..0000000000 --- a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Remove-AzureRmIoTDeviceProvisioningServiceLinkedHub.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DeviceProvisioningServices.dll-Help.xml -Module Name: AzureRM.DeviceProvisioningServices -online version: -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/Remove-AzureRmIoTDeviceProvisioningServiceLinkedHub.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/Remove-AzureRmIoTDeviceProvisioningServiceLinkedHub.md ---- - -# Remove-AzureRmIoTDeviceProvisioningServiceLinkedHub - -## SYNOPSIS -Delete a linked IoT hub in an Azure IoT Hub device provisioning service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceSet (Default) -``` -Remove-AzureRmIoTDeviceProvisioningServiceLinkedHub [-ResourceGroupName] <String> [-Name] <String> - [-LinkedHubName] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### InputObjectSet -``` -Remove-AzureRmIoTDeviceProvisioningServiceLinkedHub [-InputObject] <PSIotHubDefinitionDescription> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdSet -``` -Remove-AzureRmIoTDeviceProvisioningServiceLinkedHub [-ResourceId] <String> [-LinkedHubName] <String> - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -For an introduction to Azure IoT Hub Device Provisioning Service, see https://docs.microsoft.com/en-us/azure/iot-dps/about-iot-dps. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmIoTDeviceProvisioningServiceLinkedHub -ResourceGroupName "myresourcegroup" -Name "myiotdps" -LinkedHubName "myiothub" -PassThru - -True -``` - -Delete linked IoT hub "myiothub" in an Azure IoT Hub device provisioning service. - -### Example 2 -``` -PS C:\> Get-AzureRmIoTDpsHub -ResourceGroupName "myresourcegroup" -Name "myiotdps" -LinkedHubName "myiothub" | Remove-AzureRmIoTDpsHub -``` - -Delete linked IoT hub "myiothub" in an Azure IoT Hub device provisioning service using pipeline. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -IoT Device Provisioning Service Object - -```yaml -Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSIotHubDefinitionDescription -Parameter Sets: InputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LinkedHubName -Host name of linked IoT Hub - -```yaml -Type: System.String -Parameter Sets: ResourceSet, ResourceIdSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the IoT Device Provisioning Service - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -IoT Device Provisioning Service Resource Id - -```yaml -Type: System.String -Parameter Sets: ResourceIdSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSIotHubDefinitionDescription -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Set-AzureRmIoTDeviceProvisioningServiceCertificate.md b/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Set-AzureRmIoTDeviceProvisioningServiceCertificate.md deleted file mode 100644 index b8f70883fb..0000000000 --- a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Set-AzureRmIoTDeviceProvisioningServiceCertificate.md +++ /dev/null @@ -1,249 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DeviceProvisioningServices.dll-Help.xml -Module Name: AzureRM.DeviceProvisioningServices -online version: -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/Set-AzureRmIoTDeviceProvisioningServiceCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/Set-AzureRmIoTDeviceProvisioningServiceCertificate.md ---- - -# Set-AzureRmIoTDeviceProvisioningServiceCertificate - -## SYNOPSIS -Verify an Azure IoT Hub Device Provisioning Service certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceSet (Default) -``` -Set-AzureRmIoTDeviceProvisioningServiceCertificate [-ResourceGroupName] <String> [-Name] <String> - [-CertificateName] <String> [-Etag] <String> [-Path] <String> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectSet -``` -Set-AzureRmIoTDeviceProvisioningServiceCertificate [-InputObject] <PSCertificateResponse> [-Path] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdSet -``` -Set-AzureRmIoTDeviceProvisioningServiceCertificate [-ResourceId] <String> [-Etag] <String> [-Path] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Verify a certificate by uploading a verification certificate containing the verification code obtained by calling generate-verification-code. This is the last step in the proof of possession process. -For a detailed explanation of CA certificates in Azure IoT Hub Device Provisioning Service, see https://docs.microsoft.com/en-us/azure/iot-dps/how-to-verify-certificates - -## EXAMPLES - -### Example 1 -``` -PS C:\> Set-AzureRmIoTDeviceProvisioningServiceCertificate -ResourceGroupName "myresourcegroup" -Name "myiotdps" -CertificateName "mycertificate" -Path "c:\mycertificate.cer" -Etag "AAAAAAFpGcA=" - -Id : /subscriptions/377cxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Devices/provisioningServices/myiotdps/certificates/mycertificate -ResourceGroupName : myresourcegroup -Name : myiotdps -CertificateName : mycertificate -Subject : CN=mycertificate -Thumbprint : 38303FC7371EC78DDE3E18D712C8414EE50969C7 -Status : Verified -Expiry : 1/01/2027 16:01 -Created : 1/01/2017 16:01 -Etag : AAAAAAFpGcA= -``` - -Verify ownership of the "mycertificate" private key. - -### Example 2 -``` -PS C:\> Get-AzureRmIoTDpsCertificate -ResourceGroupName "myresourcegroup" -Name "myiotdps" -CertificateName "mycertificate" | Set-AzureRmIoTDpsCertificate -Path "c:\mycertificate.cer" - -Id : /subscriptions/377cxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Devices/provisioningServices/myiotdps/certificates/mycertificate -ResourceGroupName : myresourcegroup -Name : myiotdps -CertificateName : mycertificate -Subject : CN=mycertificate -Thumbprint : 38303FC7371EC78DDE3E18D712C8414EE50969C7 -Status : Verified -Expiry : 1/01/2027 16:01 -Created : 1/01/2017 16:01 -Etag : AAAAAAFpGcA= -``` - -Verify ownership of the "mycertificate" private key using pipeline. - -## PARAMETERS - -### -CertificateName -Name of the Iot device provisioning service certificate - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Etag -Etag of the Certificate - -```yaml -Type: System.String -Parameter Sets: ResourceSet, ResourceIdSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -IoT Device Provisioning Service Certificate Object - -```yaml -Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSCertificateResponse -Parameter Sets: InputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the IoT Device Provisioning Service - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -base-64 representation of X509 certificate .cer file or .pem file path - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -IoT Device Provisioning Service Certificate Resource Id - -```yaml -Type: System.String -Parameter Sets: ResourceIdSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSCertificateResponse -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSCertificateResponse - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Update-AzureRmIoTDeviceProvisioningService.md b/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Update-AzureRmIoTDeviceProvisioningService.md deleted file mode 100644 index 3566458342..0000000000 --- a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Update-AzureRmIoTDeviceProvisioningService.md +++ /dev/null @@ -1,289 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DeviceProvisioningServices.dll-Help.xml -Module Name: AzureRM.DeviceProvisioningServices -online version: -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/Update-AzureRmIoTDeviceProvisioningService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/Update-AzureRmIoTDeviceProvisioningService.md ---- - -# Update-AzureRmIoTDeviceProvisioningService - -## SYNOPSIS -Update an Azure IoT Hub device provisioning service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceUpdateSet (Default) -``` -Update-AzureRmIoTDeviceProvisioningService [-ResourceGroupName] <String> [-Name] <String> [-Tag] <Hashtable> - [-Reset] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectUpdateSet -``` -Update-AzureRmIoTDeviceProvisioningService [-InputObject] <PSProvisioningServiceDescription> [-Tag] <Hashtable> - [-Reset] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectCreateUpdateSet -``` -Update-AzureRmIoTDeviceProvisioningService [-InputObject] <PSProvisioningServiceDescription> - [-AllocationPolicy] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ResourceIdUpdateSet -``` -Update-AzureRmIoTDeviceProvisioningService [-ResourceId] <String> [-Tag] <Hashtable> [-Reset] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdCreateUpdateSet -``` -Update-AzureRmIoTDeviceProvisioningService [-ResourceId] <String> [-AllocationPolicy] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceCreateUpdateSet -``` -Update-AzureRmIoTDeviceProvisioningService [-ResourceGroupName] <String> [-Name] <String> - [-AllocationPolicy] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -For an introduction to Azure IoT Hub Device Provisioning Service, see https://docs.microsoft.com/en-us/azure/iot-dps/about-iot-dps. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Update-AzureRmIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" -Name "myiotdps" -AllocationPolicy "GeoLatency" - -ResourceGroupName : myresourcegroup -Name : myiotdps -Type : Microsoft.Devices/provisioningServices -ServiceOperationsHostName : myiotdps.azure-devices-provisioning.net -IotHubs : 0 -State : Active -AllocationPolicy : GeoLatency -Tags : {} -SkuName : S1 -SkuTier : Standard -Etag : AAAAAAAT52k= -``` - -Update Allocation Policy to "GeoLatency" of an Azure IoT Hub device provisioning service "myiotdps". - -### Example 2 -``` -PS C:\> Update-AzureRmIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" -Name "myiotdps" -Tag @tags - -ResourceGroupName : myresourcegroup -Name : myiotdps -Type : Microsoft.Devices/provisioningServices -ServiceOperationsHostName : myiotdps.azure-devices-provisioning.net -IotHubs : 0 -State : Active -AllocationPolicy : Hashed -Tags : {['key1','Value1']} -SkuName : S1 -SkuTier : Standard -Etag : AAAAAAAPoOk= -``` - -Add "@tags" to the Tag of an Azure IoT Hub device provisioning service "myiotdps". - -### Example 3 -``` -PS C:\> Get-AzureRmIoTDps -ResourceGroupName "myresourcegroup" -Name "myiotdps" | Update-AzureRmIoTDps -Tag @tags -Reset - -ResourceGroupName : myresourcegroup -Name : myiotdps -Type : Microsoft.Devices/provisioningServices -ServiceOperationsHostName : myiotdps.azure-devices-provisioning.net -IotHubs : 0 -State : Active -AllocationPolicy : Hashed -Tags : {['key1','Value1']} -SkuName : S1 -SkuTier : Standard -Etag : AAAAAAAS1dY= -``` - -Delete Tag and add new "@tags" to the Tag of an Azure IoT Hub device provisioning service "myiotdps" using pipeline. - -## PARAMETERS - -### -AllocationPolicy -IoT Device Provisioning Service Allocation policy - -```yaml -Type: System.String -Parameter Sets: InputObjectCreateUpdateSet, ResourceIdCreateUpdateSet, ResourceCreateUpdateSet -Aliases: -Accepted values: Hashed, GeoLatency, Static - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -IoT Device Provisioning Service Object - -```yaml -Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription -Parameter Sets: InputObjectUpdateSet, InputObjectCreateUpdateSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the IoT Device Provisioning Service - -```yaml -Type: System.String -Parameter Sets: ResourceUpdateSet, ResourceCreateUpdateSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Reset -Reset IoT Device Provisioning Service Tags - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ResourceUpdateSet, InputObjectUpdateSet, ResourceIdUpdateSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group - -```yaml -Type: System.String -Parameter Sets: ResourceUpdateSet, ResourceCreateUpdateSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -IoT Device Provisioning Service Resource Id - -```yaml -Type: System.String -Parameter Sets: ResourceIdUpdateSet, ResourceIdCreateUpdateSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -IoT Device Provisioning Service Tag collection - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: ResourceUpdateSet, InputObjectUpdateSet, ResourceIdUpdateSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSProvisioningServiceDescription - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Update-AzureRmIoTDeviceProvisioningServiceAccessPolicy.md b/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Update-AzureRmIoTDeviceProvisioningServiceAccessPolicy.md deleted file mode 100644 index 8ff8629338..0000000000 --- a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Update-AzureRmIoTDeviceProvisioningServiceAccessPolicy.md +++ /dev/null @@ -1,227 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DeviceProvisioningServices.dll-Help.xml -Module Name: AzureRM.DeviceProvisioningServices -online version: -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/Update-AzureRmIoTDeviceProvisioningServiceAccessPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/Update-AzureRmIoTDeviceProvisioningServiceAccessPolicy.md ---- - -# Update-AzureRmIoTDeviceProvisioningServiceAccessPolicy - -## SYNOPSIS -Update a shared access policy in an Azure IoT Hub device provisioning service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceSet (Default) -``` -Update-AzureRmIoTDeviceProvisioningServiceAccessPolicy [-ResourceGroupName] <String> [-Name] <String> - [-KeyName] <String> [-Permissions] <String[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### InputObjectSet -``` -Update-AzureRmIoTDeviceProvisioningServiceAccessPolicy - [-InputObject] <PSSharedAccessSignatureAuthorizationRuleAccessRightsDescription> [-Permissions] <String[]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdSet -``` -Update-AzureRmIoTDeviceProvisioningServiceAccessPolicy [-ResourceId] <String> [-KeyName] <String> - [-Permissions] <String[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -For an introduction to Azure IoT Hub Device Provisioning Service, see https://docs.microsoft.com/en-us/azure/iot-dps/about-iot-dps. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Update-AzureRmIoTDeviceProvisioningServiceAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" -KeyName "mypolicy" -Permissions "EnrollmentWrite" - -ResourceGroupName : myresourcegroup -Name : myiotdps -KeyName : mypolicy -PrimaryKey : hyZJm8W7rra9O7eKhkLu9m/CIPPt9x1NXVMbMJa1rvg= -SecondaryKey : vbIwGCBQCIbS5BKFKdddM6uZHLhNTuz9r8CZYgmTmpY= -Rights : EnrollmentWrite -``` - -Update access policy "mypolicy" in an Azure IoT Hub device provisioning service with EnrollmentWrite right. - -### Example 1 -``` -PS C:\> Get-AzureRmIoTDpsAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" -KeyName "mypolicy" | Update-AzureRmIoTDpsAccessPolicy -Permissions "EnrollmentWrite" - -ResourceGroupName : myresourcegroup -Name : myiotdps -KeyName : mypolicy -PrimaryKey : hyZJm8W7rra9O7eKhkLu9m/CIPPt9x1NXVMbMJa1rvg= -SecondaryKey : vbIwGCBQCIbS5BKFKdddM6uZHLhNTuz9r8CZYgmTmpY= -Rights : EnrollmentWrite -``` - -Update access policy "mypolicy" in an Azure IoT Hub device provisioning service with EnrollmentWrite right using pipeline. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -IoT Device Provisioning Service Object - -```yaml -Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSSharedAccessSignatureAuthorizationRuleAccessRightsDescription -Parameter Sets: InputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -KeyName -IoT Device Provisioning Service access policy key name - -```yaml -Type: System.String -Parameter Sets: ResourceSet, ResourceIdSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the IoT Device Provisioning Service - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Permissions -IoT Device Provisioning Service access policy permissions - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: -Accepted values: ServiceConfig, EnrollmentRead, EnrollmentWrite, DeviceConnect, RegistrationStatusRead, RegistrationStatusWrite - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -IoT Device Provisioning Service Resource Id - -```yaml -Type: System.String -Parameter Sets: ResourceIdSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSSharedAccessSignatureAuthorizationRuleAccessRightsDescription -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSSharedAccessSignatureAuthorizationRuleAccessRightsDescription - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Update-AzureRmIoTDeviceProvisioningServiceLinkedHub.md b/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Update-AzureRmIoTDeviceProvisioningServiceLinkedHub.md deleted file mode 100644 index 44de49fe00..0000000000 --- a/azurermps-6.13.0/AzureRM.DeviceProvisioningServices/Update-AzureRmIoTDeviceProvisioningServiceLinkedHub.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.DeviceProvisioningServices.dll-Help.xml -Module Name: AzureRM.DeviceProvisioningServices -online version: -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/Update-AzureRmIoTDeviceProvisioningServiceLinkedHub.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/DeviceProvisioningServices/Commands.DeviceProvisioningServices/help/Update-AzureRmIoTDeviceProvisioningServiceLinkedHub.md ---- - -# Update-AzureRmIoTDeviceProvisioningServiceLinkedHub - -## SYNOPSIS -Update a linked IoT hub in an Azure IoT Hub device provisioning service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceSet (Default) -``` -Update-AzureRmIoTDeviceProvisioningServiceLinkedHub [-ResourceGroupName] <String> [-Name] <String> - [-LinkedHubName] <String> [-AllocationWeight <Int32>] [-ApplyAllocationPolicy] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectSet -``` -Update-AzureRmIoTDeviceProvisioningServiceLinkedHub [-InputObject] <PSIotHubDefinitionDescription> - [-AllocationWeight <Int32>] [-ApplyAllocationPolicy] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ResourceIdSet -``` -Update-AzureRmIoTDeviceProvisioningServiceLinkedHub [-ResourceId] <String> [-LinkedHubName] <String> - [-AllocationWeight <Int32>] [-ApplyAllocationPolicy] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -For an introduction to Azure IoT Hub Device Provisioning Service, see https://docs.microsoft.com/en-us/azure/iot-dps/about-iot-dps. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Update-AzureRmIoTDeviceProvisioningServiceLinkedHub -ResourceGroupName "myresourcegroup" -Name "myiotdps" -LinkedHubName "myiothub" -AllocationWeight 10 -ApplyAllocationPolicy $true - -ResourceGroupName : myresourcegroup -Name : myiotdps -LinkedHubName : myiothub.azure-devices.net -ConnectionString : HostName=myiothub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=**** -AllocationWeight : 10 -ApplyAllocationPolicy : True -Location : eastus -``` - -Update linked IoT hub "myiothub.azure-devices.net" in an Azure IoT Hub device provisioning service. - -## PARAMETERS - -### -AllocationWeight -Allocation weight of the IoT Hub - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplyAllocationPolicy -Apply allocation policy to the IoT Hub - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -IoT Device Provisioning Service Object - -```yaml -Type: Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSIotHubDefinitionDescription -Parameter Sets: InputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LinkedHubName -Host name of linked IoT Hub - -```yaml -Type: System.String -Parameter Sets: ResourceSet, ResourceIdSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the IoT Device Provisioning Service - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -IoT Device Provisioning Service Resource Id - -```yaml -Type: System.String -Parameter Sets: ResourceIdSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSIotHubDefinitionDescription -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.DeviceProvisioningServices.Models.PSIotHubDefinitionDescription - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Dns/Add-AzureRmDnsRecordConfig.md b/azurermps-6.13.0/AzureRM.Dns/Add-AzureRmDnsRecordConfig.md deleted file mode 100644 index fe623a4970..0000000000 --- a/azurermps-6.13.0/AzureRM.Dns/Add-AzureRmDnsRecordConfig.md +++ /dev/null @@ -1,472 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Dns.dll-Help.xml -Module Name: AzureRM.Dns -ms.assetid: CD119EBE-E1A4-4E9D-B3BA-FDAF89BF0DDB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.dns/add-azurermdnsrecordconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Dns/Commands.Dns/help/Add-AzureRmDnsRecordConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Dns/Commands.Dns/help/Add-AzureRmDnsRecordConfig.md ---- - -# Add-AzureRmDnsRecordConfig - -## SYNOPSIS -Adds a DNS record to a local record set object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### A -``` -Add-AzureRmDnsRecordConfig -RecordSet <DnsRecordSet> -Ipv4Address <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### AAAA -``` -Add-AzureRmDnsRecordConfig -RecordSet <DnsRecordSet> -Ipv6Address <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### NS -``` -Add-AzureRmDnsRecordConfig -RecordSet <DnsRecordSet> -Nsdname <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### MX -``` -Add-AzureRmDnsRecordConfig -RecordSet <DnsRecordSet> -Exchange <String> -Preference <UInt16> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### PTR -``` -Add-AzureRmDnsRecordConfig -RecordSet <DnsRecordSet> -Ptrdname <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### TXT -``` -Add-AzureRmDnsRecordConfig -RecordSet <DnsRecordSet> -Value <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### SRV -``` -Add-AzureRmDnsRecordConfig -RecordSet <DnsRecordSet> -Priority <UInt16> -Target <String> -Port <UInt16> - -Weight <UInt16> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### CNAME -``` -Add-AzureRmDnsRecordConfig -RecordSet <DnsRecordSet> -Cname <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### Caa -``` -Add-AzureRmDnsRecordConfig -RecordSet <DnsRecordSet> -CaaFlags <Byte> -CaaTag <String> -CaaValue <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmDnsRecordConfig** cmdlet adds a Domain Name System (DNS) record to a **RecordSet** object. -The **RecordSet** object is an offline object, and changes to it do not change the DNS responses until after you run the Set-AzureRmDnsRecordSet cmdlet to persist the change to the Microsoft Azure DNS service. -SOA records are created when a DNS zone is created, and are removed when the DNS zone is deleted. -You cannot add or remove SOA records, but you can edit them. -You can pass the **RecordSet** object to this cmdlet as a parameter or by using the pipeline operator. - -## EXAMPLES - -### Example 1: Add an A record to a record set -``` -PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name www -RecordType A -ResouceGroupName MyResourceGroup -ZoneName myzone.com -PS C:\> Add-AzureRmDnsRecordConfig -RecordSet $RecordSet -Ipv4Address 1.2.3.4 -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet - -# You can also pipe the above sequence: - -PS C:\> Get-AzureRmDnsRecordSet -Name www -RecordType A -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzureRmDnsRecordConfig -Ipv4Address 1.2.3.4 | Set-AzureRmDnsRecordSet -``` - -This example adds an A record to an existing record set. - -### Example 2: Add an AAAA record to a record set -``` -PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name www -RecordType AAAA -ResouceGroupName MyResourceGroup -ZoneName myzone.com -PS C:\> Add-AzureRmDnsRecordConfig -RecordSet $RecordSet -Ipv6Address 2001:DB80:4009:1803::1005 -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet - -# You can also pipe the above sequence: - -PS C:\> Get-AzureRmDnsRecordSet -Name www -RecordType AAAA -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzureRmDnsRecordConfig -Ipv6Address 2001:DB80:4009:1803::1005 | Set-AzureRmDnsRecordSet -``` - -This example adds an AAAA record to an existing record set. - -### Example 3: Add a CNAME record to a record set -``` -PS C:\>$RecordSet = Get-AzureRmDnsRecordSet -Name www -RecordType CNAME -ResouceGroupName MyResourceGroup -ZoneName myzone.com -PS C:\> Add-AzureRmDnsRecordConfig -RecordSet $RecordSet -Cname contoso.com -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet - -# You can also pipe the above sequence: - -PS C:\> Get-AzureRmDnsRecordSet -Name www -RecordType CNAME -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzureRmDnsRecordConfig -Cname contoso.com | Set-AzureRmDnsRecordSet -``` - -This example adds a CNAME record to an existing record set. -Because a CNAME record set can contain at most one record, it must initially be an empty record set, or existing records must be removed using Remove-AzureRmDnsRecordConfig. - -### Example 4: Add an MX record to a record set -``` -PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name "@" -RecordType MX -ResouceGroupName MyResourceGroup -ZoneName myzone.com -PS C:\> Add-AzureRmDnsRecordConfig -Exchange mail.microsoft.com -Preference 5 -RecordSet $RecordSet -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet - -# You can also pipe the above sequence: - -PS C:\> Get-AzureRmDnsRecordSet -Name "@" -RecordType MX -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzureRmDnsRecordConfig -Exchange mail.microsoft.com -Preference 5 | Set-AzureRmDnsRecordSet -``` - -This example adds an MX record to an existing record set. -The record name "@" indicates a record set at the zone apex. - -### Example 5: Add an NS record to a record set -``` -PS C:\>$RecordSet = Get-AzureRmDnsRecordSet -Name abc -RecordType NS -ResouceGroupName MyResourceGroup -ZoneName myzone.com -PS C:\> Add-AzureRmDnsRecordConfig -Nsdname ns1.myzone.com -RecordSet $RecordSet -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet - -# You can also pipe the above sequence: - -PS C:\> Get-AzureRmDnsRecordSet -Name abc -RecordType NS -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzureRmDnsRecordConfig -Nsdname ns1.myzone.com | Set-AzureRmDnsRecordSet -``` - -This example adds an NS record to an existing record set. - -### Example 6: Add a PTR record to a record set -``` -PS C:\>$RecordSet = Get-AzureRmDnsRecordSet -Name 4 -RecordType PTR -ResouceGroupName MyResourceGroup -ZoneName 3.2.1.in-addr.arpa -PS C:\> Add-AzureRmDnsRecordConfig -Ptrdname www.contoso.com -RecordSet $RecordSet -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet - -# The above sequence can also be piped: - -PS C:\> Get-AzureRmDnsRecordSet -Name 4 -RecordType PTR -ResouceGroupName MyResourceGroup -ZoneName 3.2.1.in-addr.arpa | Add-AzureRmDnsRecordConfig -Ptrdname www.contoso.com | Set-AzureRmDnsRecordSet -``` - -This example adds a PTR record to an existing record set. - -### Example 7: Add an SRV record to a record set -``` -PS C:\>$RecordSet = Get-AzureRmDnsRecordSet -Name _sip._tcp -RecordType SRV -ResouceGroupName MyResourceGroup -ZoneName myzone.com -PS C:\> Add-AzureRmDnsRecordConfig -RecordSet $RecordSet -Priority 0 -Weight 5 -Port 8080 -Target target.example.com -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet - -# The above sequence can also be piped: - -PS C:\> Get-AzureRmDnsRecordSet -Name _sip._tcp -RecordType SRV -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzureRmDnsRecordConfig -Priority 0 -Weight 5 -Port 8080 -Target target.example.com | Set-AzureRmDnsRecordSet -``` - -This example adds an SRV record to an existing record set. - -### Example 8: Add a TXT record to a record set -``` -PS C:\>$RecordSet = Get-AzureRmDnsRecordSet -Name text -RecordType TXT -ResouceGroupName MyResourceGroup -ZoneName myzone.com -PS C:\> Add-AzureRmDnsRecordConfig -RecordSet $RecordSet -Value "This is a TXT Record" -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet - -# The above sequence can also be piped: - -PS C:\> Get-AzureRmDnsRecordSet -Name text -RecordType TXT -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzureRmDnsRecordConfig -Value "This is a TXT Record" | Set-AzureRmDnsRecordSet -``` - -This example adds a TXT record to an existing record set. - -## PARAMETERS - -### -CaaFlags -The flags for the CAA record to add. Must be a number between 0 and 255. - -```yaml -Type: System.Byte -Parameter Sets: Caa -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CaaTag -The tag field of the CAA record to add. - -```yaml -Type: System.String -Parameter Sets: Caa -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CaaValue -The value field for the CAA record to add. - -```yaml -Type: System.String -Parameter Sets: Caa -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Cname -Specifies the domain name for a canonical name (CNAME) record. - -```yaml -Type: System.String -Parameter Sets: CNAME -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Exchange -Specifies the mail exchange server name for a mail exchange (MX) record. - -```yaml -Type: System.String -Parameter Sets: MX -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Ipv4Address -Specifies an IPv4 address for an A record. - -```yaml -Type: System.String -Parameter Sets: A -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Ipv6Address -Specifies an IPv6 address for an AAAA record. - -```yaml -Type: System.String -Parameter Sets: AAAA -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Nsdname -Specifies the name server name for a name server (NS) record. - -```yaml -Type: System.String -Parameter Sets: NS -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Port -Specifies the port for a service (SRV) record. - -```yaml -Type: System.UInt16 -Parameter Sets: SRV -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Preference -Specifies the preference for an MX record. - -```yaml -Type: System.UInt16 -Parameter Sets: MX -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Priority -Specifies the priority for an SRV record. - -```yaml -Type: System.UInt16 -Parameter Sets: SRV -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Ptrdname -Specifies the target domain name of a pointer resource (PTR) record. - -```yaml -Type: System.String -Parameter Sets: PTR -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RecordSet -Specifies the **RecordSet** object to edit. - -```yaml -Type: Microsoft.Azure.Commands.Dns.DnsRecordSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Target -Specifies the target for an SRV record. - -```yaml -Type: System.String -Parameter Sets: SRV -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Value -Specifies the value for a TXT record. - -```yaml -Type: System.String -Parameter Sets: TXT -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Weight -Specifies the weight for an SRV record. - -```yaml -Type: System.UInt16 -Parameter Sets: SRV -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Dns.DnsRecordSet -Parameters: RecordSet (ByValue) - -### System.String - -### System.UInt16 - -### System.Byte - -## OUTPUTS - -### Microsoft.Azure.Commands.Dns.DnsRecordSet - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDnsRecordSet](./Get-AzureRmDnsRecordSet.md) - -[Remove-AzureRmDnsRecordConfig](./Remove-AzureRmDnsRecordConfig.md) - -[Set-AzureRmDnsRecordSet](./Set-AzureRmDnsRecordSet.md) diff --git a/azurermps-6.13.0/AzureRM.Dns/AzureRM.DNS.md b/azurermps-6.13.0/AzureRM.Dns/AzureRM.DNS.md deleted file mode 100644 index 85beb7d67b..0000000000 --- a/azurermps-6.13.0/AzureRM.Dns/AzureRM.DNS.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -Module Name: AzureRM.Dns -Module Guid: 5e5ed8bc-27bf-4380-9de1-4b22ba0920b2 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.dns -Help Version: 4.1.2.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Dns/Commands.Dns/help/AzureRM.DNS.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Dns/Commands.Dns/help/AzureRM.DNS.md ---- - -# AzureRM.Dns Module -## Description -This topic displays help topics for the Azure DNS Cmdlets. - -## AzureRM.Dns Cmdlets -### [Add-AzureRmDnsRecordConfig](Add-AzureRmDnsRecordConfig.md) -Adds a DNS record to a local record set object. - -### [Get-AzureRmDnsRecordSet](Get-AzureRmDnsRecordSet.md) -Gets a DNS record set. - -### [Get-AzureRmDnsZone](Get-AzureRmDnsZone.md) -Gets a DNS zone. - -### [New-AzureRmDnsRecordConfig](New-AzureRmDnsRecordConfig.md) -Creates a new DNS record local object. - -### [New-AzureRmDnsRecordSet](New-AzureRmDnsRecordSet.md) -Creates a DNS record set. - -### [New-AzureRmDnsZone](New-AzureRmDnsZone.md) -Creates a new DNS zone. - -### [Remove-AzureRmDnsRecordConfig](Remove-AzureRmDnsRecordConfig.md) -Removes a DNS record from a local record set object. - -### [Remove-AzureRmDnsRecordSet](Remove-AzureRmDnsRecordSet.md) -Deletes a record set. - -### [Remove-AzureRmDnsZone](Remove-AzureRmDnsZone.md) -Removes a DNS zone from a resource group. - -### [Set-AzureRmDnsRecordSet](Set-AzureRmDnsRecordSet.md) -Updates a DNS record set. - -### [Set-AzureRmDnsZone](Set-AzureRmDnsZone.md) -Updates the properties of a DNS zone. - diff --git a/azurermps-6.13.0/AzureRM.Dns/Get-AzureRmDnsRecordSet.md b/azurermps-6.13.0/AzureRM.Dns/Get-AzureRmDnsRecordSet.md deleted file mode 100644 index f042d9d02c..0000000000 --- a/azurermps-6.13.0/AzureRM.Dns/Get-AzureRmDnsRecordSet.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Dns.dll-Help.xml -Module Name: AzureRM.Dns -ms.assetid: 40179CF3-7896-4C45-BC18-4CB653B245B6 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.dns/get-azurermdnsrecordset -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Dns/Commands.Dns/help/Get-AzureRmDnsRecordSet.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Dns/Commands.Dns/help/Get-AzureRmDnsRecordSet.md ---- - -# Get-AzureRmDnsRecordSet - -## SYNOPSIS -Gets a DNS record set. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Fields -``` -Get-AzureRmDnsRecordSet [-Name <String>] -ZoneName <String> -ResourceGroupName <String> - [-RecordType <RecordType>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### Object -``` -Get-AzureRmDnsRecordSet [-Name <String>] -Zone <DnsZone> [-RecordType <RecordType>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDnsRecordSet** cmdlet gets the Domain Name System (DNS) record set with the specified name and type, in the specified zone. -If you do not specify the *Name* or *RecordType* parameters, this cmdlet returns all record sets of the specified type in the zone. -If you specify the *RecordType* parameter but not the *Name* parameter, this cmdlet returns all record sets of the specified record type. -You can use the pipeline operator to pass a **DnsZone** object to this cmdlet, or you can pass a **DnsZone** object as the *Zone* parameter, or alternatively you can specify the zone and resource group by name. - -## EXAMPLES - -### Example 1: Get record sets with a specified name and type -``` -PS C:\>$RecordSet = Get-AzureRmDnsRecordSet -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" -Name "www" -RecordType A -``` - -This command gets the record set of record type A named www in the specified resource group and zone, and then stores it in the $RecordSet variable. -Because the *Name* and *RecordType* parameters are specified, only one **RecordSet** object is returned. - -### Example 2: Get record sets of a specified type -``` -PS C:\>$RecordSets = Get-AzureRmDnsRecordSet -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" -RecordType A -``` - -This command gets an array of all record sets of record type A in the zone named myzone.com in the resource group named MyResourceGroup, and then stores them in the $RecordSets variable. - -### Example 3: Get all record sets in a zone -``` -PS C:\>$RecordSets = Get-AzureRmDnsRecordSet -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" -``` - -This command gets an array of all record sets in the zone named myzone.com in the resource group named MyResourceGroup, and then stores them in the $RecordSets variable. - -### Example 4: Get all record sets in a zone, using a DnsZone object -``` -PS C:\> $Zone = Get-AzureRmDnsZone -Name "myzone.com" -ResourceGroupName "MyResourceGroup" -PS C:\> $RecordSets = Get-AzureRmDnsRecordSet -Zone $Zone -``` - -This example is equivalent to Example 3 above. -This time, the zone is specified using a zone object. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the **RecordSet** to get. -If you do not specify the *Name* parameter, all record sets of the specified type are returned. - -```yaml -Type: System.String -Parameter Sets: Fields -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: Object -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RecordType -Specifies the type of DNS record that this cmdlet gets. -Valid values are: -- A -- AAAA -- CNAME -- MX -- NS -- PTR -- SOA -- SRV -- TXT -If you do not specify the *RecordType* parameter, you must also omit the *Name* parameter. -This cmdlet then returns all record sets in the zone (of all names and types). - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.Dns.Models.RecordType] -Parameter Sets: (All) -Aliases: -Accepted values: A, AAAA, CAA, CNAME, MX, NS, PTR, SOA, SRV, TXT - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group that contains the DNS zone. -The zone name must also be specified, using the *ZoneName* parameter. -Alternatively, you can specify the zone and resource group by passing in a **DnsZone** object using the *Zone* parameter. - -```yaml -Type: System.String -Parameter Sets: Fields -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Zone -Specifies the DNS zone that contains the record set that this cmdlet gets. -Alternatively, you can specify the zone using the *ZoneName* and *ResourceGroupName* parameters. - -```yaml -Type: Microsoft.Azure.Commands.Dns.DnsZone -Parameter Sets: Object -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ZoneName -Specifies the name of the DNS zone that contains the record set to get. -The resource group containing the zone must also be specified, using the *ResourceGroupName* parameter. -Alternatively, you can specify the zone and resource group by passing in a DNS Zone object using the *Zone* parameter. - -```yaml -Type: System.String -Parameter Sets: Fields -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Dns.DnsZone -Parameters: Zone (ByValue) - -### System.Nullable`1[[Microsoft.Azure.Management.Dns.Models.RecordType, Microsoft.Azure.Management.Dns, Version=2.1.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Dns.DnsRecordSet - -## NOTES - -## RELATED LINKS - -[New-AzureRmDnsRecordSet](./New-AzureRmDnsRecordSet.md) - -[Remove-AzureRmDnsRecordSet](./Remove-AzureRmDnsRecordSet.md) - -[Set-AzureRmDnsRecordSet](./Set-AzureRmDnsRecordSet.md) - - diff --git a/azurermps-6.13.0/AzureRM.Dns/Get-AzureRmDnsZone.md b/azurermps-6.13.0/AzureRM.Dns/Get-AzureRmDnsZone.md deleted file mode 100644 index 2eaf1080f3..0000000000 --- a/azurermps-6.13.0/AzureRM.Dns/Get-AzureRmDnsZone.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Dns.dll-Help.xml -Module Name: AzureRM.Dns -ms.assetid: B831ABE6-348C-4DD6-9295-18D23A1FDF63 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.dns/get-azurermdnszone -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Dns/Commands.Dns/help/Get-AzureRmDnsZone.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Dns/Commands.Dns/help/Get-AzureRmDnsZone.md ---- - -# Get-AzureRmDnsZone - -## SYNOPSIS -Gets a DNS zone. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Default (Default) -``` -Get-AzureRmDnsZone [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceGroup -``` -Get-AzureRmDnsZone [-Name <String>] -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDnsZone** cmdlet gets a Domain Name System (DNS) zone from the specified resource group. -If you specify the *Name* parameter, a single **DnsZone** object is returned. -If you do not specify the *Name* parameter, an array containing all of the zones in the specified resource group is returned. -You can use the **DnsZone** object to update the zone, for example you can add **RecordSet** objects to it. - -## EXAMPLES - -### Example 1: Get a zone -``` -PS C:\> $Zone = Get-AzureRmDnsZone -ResourceGroupName "MyResourceGroup" -Name "myzone.com" -``` - -This example gets the DNS zone named myzone.com from the specified resource group, and then stores it in the $Zone variable. - -### Example 2: Get all of the zones in a resource group -``` -PS C:\> $Zones = Get-AzureRmDnsZone -ResourceGroupName "MyResourceGroup" -``` - -This example gets all of the DNS zones in the specified resource group, and then stores it in the $Zones variable. - -### Example 3: Get all of the zones in a subscription -``` -PS C:\> $Zones = Get-AzureRmDnsZone -``` - -This example gets all of the DNS zones in the current Azure subscription, and then stores them in the $Zones variable. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the DNS zone to get. -If you do not specify a value for the *Name* parameter, this cmdlet gets all DNS zones in the specified resource group. -If you also omit the *ResourceGroupName* parameter, this cmdlet gets all DNS zones in the current Azure subscription. - -```yaml -Type: System.String -Parameter Sets: ResourceGroup -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the DNS zone to get. -If you do not specify the *ResourceGroupName*, then you must also omit the *Name* parameter. -In this case, this cmdlet gets all DNS zones in the current Azure subscription. - -```yaml -Type: System.String -Parameter Sets: ResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Dns.DnsZone - -## NOTES - -## RELATED LINKS - -[New-AzureRmDnsZone](./New-AzureRmDnsZone.md) - -[Remove-AzureRmDnsZone](./Remove-AzureRmDnsZone.md) - -[Set-AzureRmDnsZone](./Set-AzureRmDnsZone.md) diff --git a/azurermps-6.13.0/AzureRM.Dns/New-AzureRmDnsRecordConfig.md b/azurermps-6.13.0/AzureRM.Dns/New-AzureRmDnsRecordConfig.md deleted file mode 100644 index 7fc9bc1359..0000000000 --- a/azurermps-6.13.0/AzureRM.Dns/New-AzureRmDnsRecordConfig.md +++ /dev/null @@ -1,449 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Dns.dll-Help.xml -Module Name: AzureRM.Dns -ms.assetid: AD97BCAF-69BA-4C16-8B57-AB243D796B71 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.dns/new-azurermdnsrecordconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Dns/Commands.Dns/help/New-AzureRmDnsRecordConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Dns/Commands.Dns/help/New-AzureRmDnsRecordConfig.md ---- - -# New-AzureRmDnsRecordConfig - -## SYNOPSIS -Creates a new DNS record local object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### A -``` -New-AzureRmDnsRecordConfig -Ipv4Address <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### Aaaa -``` -New-AzureRmDnsRecordConfig -Ipv6Address <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### Ns -``` -New-AzureRmDnsRecordConfig -Nsdname <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### Mx -``` -New-AzureRmDnsRecordConfig -Exchange <String> -Preference <UInt16> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### Ptr -``` -New-AzureRmDnsRecordConfig -Ptrdname <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### Txt -``` -New-AzureRmDnsRecordConfig -Value <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### Srv -``` -New-AzureRmDnsRecordConfig -Priority <UInt16> -Target <String> -Port <UInt16> -Weight <UInt16> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### CName -``` -New-AzureRmDnsRecordConfig -Cname <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### Caa -``` -New-AzureRmDnsRecordConfig -CaaFlags <Byte> -CaaTag <String> -CaaValue <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmDnsRecordConfig** cmdlet creates a local **DnsRecord** object. -An array of these objects is passed to the New-AzureRmDnsRecordSet cmdlet using the *DnsRecords* parameter to specify the records to create in the record set. - -## EXAMPLES - -### Example 1: Create a RecordSet of type A -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -IPv4Address 1.2.3.4 -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records - -# When creating a RecordSet containing a single record, the above sequence can also be condensed into a single line: - -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords (New-AzureRmDnsRecordConfig -IPv4Address 1.2.3.4) - -# To create a record set containing multiple records, use New-AzureRmDnsRecordConfig to add each record to the $Records array, -# then call New-AzureRmDnsRecordSet, as follows: - -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -IPv4Address 1.2.3.4 -PS C:\> $Records += New-AzureRmDnsRecordConfig -IPv4Address 5.6.7.8 -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records -``` - -This example creates a **RecordSet** named www in the zone myzone.com. -The record set is of type A and has a TTL of 1 hour (3600 seconds). -It contains a single DNS record. - -### Example 2: Create a RecordSet of type AAAA -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -Ipv6Address 2001:db8::1 -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType AAAA -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records -``` - -This example creates a **RecordSet** named www in the zone myzone.com. -The record set is of type AAAA and has a TTL of 1 hour (3600 seconds). -It contains a single DNS record. -To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. - -### Example 3: Create a RecordSet of type CNAME -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -Cname www.contoso.com -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType CNAME -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records -``` - -This example creates a **RecordSet** named www in the zone myzone.com. -The record set is of type CNAME and has a TTL of 1 hour (3600 seconds). -It contains a single DNS record. -To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. - -### Example 4: Create a RecordSet of type MX -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -Exchange "mail.microsoft.com" -Preference 5 -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType AAAA -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records -``` - -This command creates a **RecordSet** named www in the zone myzone.com. -The record set is of type MX and has a TTL of 1 hour (3600 seconds). -It contains a single DNS record. -To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. - -### Example 5: Create a RecordSet of type NS -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -Nsdname ns1-01.azure-dns.com -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "ns1" -RecordType NS -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records -``` - -This command creates a **RecordSet** named ns1 in the zone myzone.com. -The record set is of type NS and has a TTL of 1 hour (3600 seconds). -It contains a single DNS record. -To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. - -### Example 6: Create a RecordSet of type PTR -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -Ptrdname www.contoso.com -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "4" -RecordType PTR -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "3.2.1.in-addr.arpa" -DnsRecords $Records -``` - -This command creates a **RecordSet** named 4 in the zone 3.2.1.in-addr.arpa. -The record set is of type PTR and has a TTL of 1 hour (3600 seconds). -It contains a single DNS record. -To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. - -### Example 7: Create a RecordSet of type SRV -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -Priority 0 -Weight 5 -Port 8080 -Target sipservice.contoso.com -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "_sip._tcp" -RecordType SRV -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records -``` - -This command creates a **RecordSet** named _sip._tcp in the zone myzone.com. -The record set is of type SRV and has a TTL of 1 hour (3600 seconds). -It contains a single DNS record, pointing to the IP address 2001.2.3.4. -The service (sip) and the protocol (tcp) are specified as part of the record set name, not as part of the record data. -To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. - -### Example 8: Create a RecordSet of type TXT -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -Value "This is a TXT Record" -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "text" -RecordType TXT -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records -``` - -This command creates a **RecordSet** named text in the zone myzone.com. -The record set is of type TXT and has a TTL of 1 hour (3600 seconds). -It contains a single DNS record. -To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. - -## PARAMETERS - -### -CaaFlags -The flags for the CAA record to add. Must be a number between 0 and 255. - -```yaml -Type: System.Byte -Parameter Sets: Caa -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CaaTag -The tag field of the CAA record to add. - -```yaml -Type: System.String -Parameter Sets: Caa -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CaaValue -The value field for the CAA record to add. - -```yaml -Type: System.String -Parameter Sets: Caa -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Cname -Specifies the domain name for a canonical name (CNAME) record. - -```yaml -Type: System.String -Parameter Sets: CName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Exchange -Specifies the mail exchange server name for a mail exchange (MX) record. - -```yaml -Type: System.String -Parameter Sets: Mx -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Ipv4Address -Specifies an IPv4 address for an A record. - -```yaml -Type: System.String -Parameter Sets: A -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Ipv6Address -Specifies an IPv6 address for an AAAA record. - -```yaml -Type: System.String -Parameter Sets: Aaaa -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Nsdname -Specifies the name server name for a name server (NS) record. - -```yaml -Type: System.String -Parameter Sets: Ns -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Port -Specifies the port for a service (SRV) record. - -```yaml -Type: System.UInt16 -Parameter Sets: Srv -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Preference -Specifies the preference for an MX record. - -```yaml -Type: System.UInt16 -Parameter Sets: Mx -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Priority -Specifies the priority for an SRV record. - -```yaml -Type: System.UInt16 -Parameter Sets: Srv -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Ptrdname -Specifies the target domain name of a pointer resource (PTR) record. - -```yaml -Type: System.String -Parameter Sets: Ptr -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Target -Specifies the target for an SRV record. - -```yaml -Type: System.String -Parameter Sets: Srv -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Value -Specifies the value for a TXT record. - -```yaml -Type: System.String -Parameter Sets: Txt -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Weight -Specifies the weight for an SRV record. - -```yaml -Type: System.UInt16 -Parameter Sets: Srv -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.UInt16 - -### System.Byte - -## OUTPUTS - -### Microsoft.Azure.Commands.Dns.DnsRecordBase - -## NOTES - -## RELATED LINKS - -[Add-AzureRmDnsRecordConfig](./Add-AzureRmDnsRecordConfig.md) - -[New-AzureRmDnsRecordSet](./New-AzureRmDnsRecordSet.md) - -[Remove-AzureRmDnsRecordConfig](./Remove-AzureRmDnsRecordConfig.md) diff --git a/azurermps-6.13.0/AzureRM.Dns/New-AzureRmDnsRecordSet.md b/azurermps-6.13.0/AzureRM.Dns/New-AzureRmDnsRecordSet.md deleted file mode 100644 index 180282998e..0000000000 --- a/azurermps-6.13.0/AzureRM.Dns/New-AzureRmDnsRecordSet.md +++ /dev/null @@ -1,478 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Dns.dll-Help.xml -Module Name: AzureRM.Dns -ms.assetid: 45DF71E0-77E1-4D20-AD09-2C06680F659F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.dns/new-azurermdnsrecordset -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Dns/Commands.Dns/help/New-AzureRmDnsRecordSet.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Dns/Commands.Dns/help/New-AzureRmDnsRecordSet.md ---- - -# New-AzureRmDnsRecordSet - -## SYNOPSIS -Creates a DNS record set. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Fields (Default) -``` -New-AzureRmDnsRecordSet -Name <String> -ZoneName <String> -ResourceGroupName <String> -Ttl <UInt32> - -RecordType <RecordType> [-Metadata <Hashtable>] [-DnsRecords <DnsRecordBase[]>] [-Overwrite] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### AliasFields -``` -New-AzureRmDnsRecordSet -Name <String> -ZoneName <String> -ResourceGroupName <String> [-Ttl <UInt32>] - -RecordType <RecordType> -TargetResourceId <String> [-Metadata <Hashtable>] [-DnsRecords <DnsRecordBase[]>] - [-Overwrite] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Object -``` -New-AzureRmDnsRecordSet -Name <String> -Zone <DnsZone> -Ttl <UInt32> -RecordType <RecordType> - [-Metadata <Hashtable>] [-DnsRecords <DnsRecordBase[]>] [-Overwrite] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### AliasObject -``` -New-AzureRmDnsRecordSet -Name <String> -Zone <DnsZone> [-Ttl <UInt32>] -RecordType <RecordType> - -TargetResourceId <String> [-Metadata <Hashtable>] [-DnsRecords <DnsRecordBase[]>] [-Overwrite] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmDnsRecordSet** cmdlet creates a new Domain Name System (DNS) record set with the specified name and type in the specified zone. -A **RecordSet** object is a set of DNS records with the same name and type. -Note that the name is relative to the zone and not the fully qualified name. -The *DnsRecords* parameter specifies the records in the record set. -This parameter takes an array of DNS records, constructed using New-AzureRmDnsRecordConfig. -You can use the pipeline operator to pass a **DnsZone** object to this cmdlet, or you can pass a **DnsZone** object as the *Zone* parameter, or alternatively you can specify the zone by name. -You can use the *Confirm* parameter and $ConfirmPreference Windows PowerShell variable to control whether the cmdlet prompts you for confirmation. -If a matching **RecordSet** already exists (same name and record type), you must specify the *Overwrite* parameter, otherwise the cmdlet will not create a new **RecordSet** . - -## EXAMPLES - -### Example 1: Create a RecordSet of type A -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -IPv4Address 1.2.3.4 -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records - -# When creating a RecordSet containing a single record, the above sequence can also be condensed into a single line: - -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords (New-AzureRmDnsRecordConfig -IPv4Address 1.2.3.4) - -# To create a record set containing multiple records, use New-AzureRmDnsRecordConfig to add each record to the $Records array, -# then call New-AzureRmDnsRecordSet, as follows: - -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -IPv4Address 1.2.3.4 -PS C:\> $Records += New-AzureRmDnsRecordConfig -IPv4Address 5.6.7.8 -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records -``` - -This example creates a **RecordSet** named www in the zone myzone.com. -The record set is of type A and has a TTL of 1 hour (3600 seconds). -It contains a single DNS record. - -### Example 2: Create a RecordSet of type AAAA -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -Ipv6Address 2001:db8::1 -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType AAAA -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records -``` - -This example creates a **RecordSet** named www in the zone myzone.com. -The record set is of type AAAA and has a TTL of 1 hour (3600 seconds). -It contains a single DNS record. -To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. - -### Example 3: Create a RecordSet of type CNAME -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -Cname www.contoso.com -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType CNAME -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records -``` - -This example creates a **RecordSet** named www in the zone myzone.com. -The record set is of type CNAME and has a TTL of 1 hour (3600 seconds). -It contains a single DNS record. -To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. - -### Example 4: Create a RecordSet of type MX -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -Exchange "mail.microsoft.com" -Preference 5 -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType AAAA -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records -``` - -This command creates a **RecordSet** named www in the zone myzone.com. -The record set is of type MX and has a TTL of 1 hour (3600 seconds). -It contains a single DNS record. -To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. - -### Example 5: Create a RecordSet of type NS -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -Nsdname ns1-01.azure-dns.com -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "ns1" -RecordType NS -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records -``` - -This command creates a **RecordSet** named ns1 in the zone myzone.com. -The record set is of type NS and has a TTL of 1 hour (3600 seconds). -It contains a single DNS record. -To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. - -### Example 6: Create a RecordSet of type PTR -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -Ptrdname www.contoso.com -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "4" -RecordType PTR -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "3.2.1.in-addr.arpa" -DnsRecords $Records -``` - -This command creates a **RecordSet** named 4 in the zone 3.2.1.in-addr.arpa. -The record set is of type PTR and has a TTL of 1 hour (3600 seconds). -It contains a single DNS record. -To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. - -### Example 7: Create a RecordSet of type SRV -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -Priority 0 -Weight 5 -Port 8080 -Target sipservice.contoso.com -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "_sip._tcp" -RecordType SRV -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records -``` - -This command creates a **RecordSet** named _sip._tcp in the zone myzone.com. -The record set is of type SRV and has a TTL of 1 hour (3600 seconds). -It contains a single DNS record, pointing to the IP address 2001.2.3.4. -The service (sip) and the protocol (tcp) are specified as part of the record set name, not as part of the record data. -To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. - -### Example 8: Create a RecordSet of type TXT -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -Value "This is a TXT Record" -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "text" -RecordType TXT -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records -``` - -This command creates a **RecordSet** named text in the zone myzone.com. -The record set is of type TXT and has a TTL of 1 hour (3600 seconds). -It contains a single DNS record. -To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. - -### Example 9: Create a RecordSet at the zone apex -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -Ipv4Address 1.2.3.4 -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "@" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records -``` - -This command creates a **RecordSet** at the apex (or root) of the zone myzone.com. -To do this, the record set name is specified as "@" (including the double-quotes). -You cannot create CNAME records at the apex of a zone. -This is a constraint of the DNS standards; it is not a limitation of Azure DNS. -To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. - -### Example 10: Create a wildcard Record Set -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -Ipv4Address 1.2.3.4 -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "*" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records -``` - -This command creates a **RecordSet** named * in the zone myzone.com. -This is a wildcard record set. -To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. - -### Example 11: Create an empty record set -``` -PS C:\>$RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords @() -``` - -This command creates a **RecordSet** named www in the zone myzone.com. -The record set is of type A and has a TTL of 1 hour (3600 seconds). -This is an empty record set, which acts as a placeholder to which you can later add records. - -### Example 12: Create a record set and suppress all confirmation -``` -PS C:\>$RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords (New-AzureRmDnsRecordConfig -Ipv4Address 1.2.3.4) -Confirm:$False -Overwrite -``` - -This command creates a **RecordSet**. -The *Overwrite* parameter ensures that this record set overwrites any pre-existing record set with the same name and type (existing records in that record set are lost). -The *Confirm* parameter with a value of $False suppresses the confirmation prompt. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DnsRecords -Specifies the array of DNS records to include in the record set. -You can use the New-AzureRmDnsRecordConfig cmdlet to create DNS record objects. -See the examples for more information. - -```yaml -Type: Microsoft.Azure.Commands.Dns.DnsRecordBase[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Metadata -Specifies an array of metadata to associate with the RecordSet. -Metadata is specified using name-value pairs that are represented as hash tables, for example @(@{"Name"="dept"; "Value"="shopping"}, @{"Name"="env"; "Value"="production"}). - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the **RecordSet** to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Overwrite -Indicates that this cmdlet overwrites the specified **RecordSet** if it already exists. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecordType -Specifies the type of DNS record to create. -Valid values are: -- A -- AAAA -- CNAME -- MX -- NS -- PTR -- SRV -- TXT -SOA records are created automatically when the zone is created and cannot be created manually. - -```yaml -Type: Microsoft.Azure.Management.Dns.Models.RecordType -Parameter Sets: (All) -Aliases: -Accepted values: A, AAAA, CAA, CNAME, MX, NS, PTR, SOA, SRV, TXT - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group that contains the DNS zone. -You must also specify the *ZoneName* parameter to specify the zone name. -Alternatively, you can specify the zone and resource group by passing in a DNS Zone object using the *Zone* parameter. - -```yaml -Type: System.String -Parameter Sets: Fields, AliasFields -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetResourceId -Alias Target Resource Id. - -```yaml -Type: System.String -Parameter Sets: AliasFields, AliasObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Ttl -Specifies the Time to Live (TTL) for the DNS RecordSet. - -```yaml -Type: System.UInt32 -Parameter Sets: Fields, Object -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.UInt32 -Parameter Sets: AliasFields, AliasObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Zone -Specifies the DnsZone in which to create the **RecordSet**. -Alternatively, you can specify the zone using the *ZoneName* and *ResourceGroupName* parameters. - -```yaml -Type: Microsoft.Azure.Commands.Dns.DnsZone -Parameter Sets: Object, AliasObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ZoneName -Specifies the name of the zone in which to create the **RecordSet**. -You must also specify the resource group containing the zone using the *ResourceGroupName* parameter. -Alternatively, you can specify the zone and resource group by passing in a DNS Zone object using the *Zone* parameter. - -```yaml -Type: System.String -Parameter Sets: Fields, AliasFields -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Dns.DnsZone -Parameters: Zone (ByValue) - -### System.UInt32 - -### Microsoft.Azure.Management.Dns.Models.RecordType - -### System.Collections.Hashtable - -### Microsoft.Azure.Commands.Dns.DnsRecordBase[] -Parameters: DnsRecords (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Dns.DnsRecordSet - -## NOTES -You can use the *Confirm* parameter to control whether this cmdlet prompts you for confirmation. -By default, the cmdlet prompts you for confirmation if the $ConfirmPreference Windows PowerShell variable has a value of Medium or lower. -If you specify *Confirm* or *Confirm:$True*, this cmdlet prompts you for confirmation before it runs. -If you specify *Confirm:$False*, the cmdlet does not prompt you for confirmation. - -## RELATED LINKS - -[Add-AzureRmDnsRecordConfig](./Add-AzureRmDnsRecordConfig.md) - -[Get-AzureRmDnsRecordSet](./Get-AzureRmDnsRecordSet.md) - -[New-AzureRmDnsRecordConfig](./New-AzureRmDnsRecordConfig.md) - -[Remove-AzureRmDnsRecordSet](./Remove-AzureRmDnsRecordSet.md) - -[Set-AzureRmDnsRecordSet](./Set-AzureRmDnsRecordSet.md) diff --git a/azurermps-6.13.0/AzureRM.Dns/New-AzureRmDnsZone.md b/azurermps-6.13.0/AzureRM.Dns/New-AzureRmDnsZone.md deleted file mode 100644 index 2a1361c758..0000000000 --- a/azurermps-6.13.0/AzureRM.Dns/New-AzureRmDnsZone.md +++ /dev/null @@ -1,273 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Dns.dll-Help.xml -Module Name: AzureRM.Dns -ms.assetid: B78F3E8B-C7D2-458C-AB23-06F584FE97E0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.dns/new-azurermdnszone -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Dns/Commands.Dns/help/New-AzureRmDnsZone.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Dns/Commands.Dns/help/New-AzureRmDnsZone.md ---- - -# New-AzureRmDnsZone - -## SYNOPSIS -Creates a new DNS zone. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Ids (Default) -``` -New-AzureRmDnsZone -Name <String> -ResourceGroupName <String> [-ZoneType <ZoneType>] [-Tag <Hashtable>] - [-RegistrationVirtualNetworkId <System.Collections.Generic.List`1[System.String]>] - [-ResolutionVirtualNetworkId <System.Collections.Generic.List`1[System.String]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Objects -``` -New-AzureRmDnsZone -Name <String> -ResourceGroupName <String> [-ZoneType <ZoneType>] [-Tag <Hashtable>] - [-RegistrationVirtualNetwork <System.Collections.Generic.List`1[Microsoft.Azure.Management.Internal.Network.Common.IResourceReference]>] - [-ResolutionVirtualNetwork <System.Collections.Generic.List`1[Microsoft.Azure.Management.Internal.Network.Common.IResourceReference]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmDnsZone** cmdlet creates a new Domain Name System (DNS) zone in the specified -resource group. You must specify a unique DNS zone name for the *Name* parameter or the cmdlet will -return an error. After the zone is created, use the New-AzureRmDnsRecordSet cmdlet to create record -sets in the zone. -You can use the *Confirm* parameter and $ConfirmPreference Windows PowerShell variable to control -whether the cmdlet prompts you for confirmation. - -## EXAMPLES - -### Example 1: Create a DNS zone -``` -PS C:\>$Zone = New-AzureRmDnsZone -Name "myzone.com" -ResourceGroupName "MyResourceGroup" -``` - -This command creates a new DNS zone named myzone.com in the specified resource group, and then -stores it in the $Zone variable. - -### Example 2: Create a Private DNS zone by specifying virtual network IDs -``` -PS C:\>$ResVirtualNetworkId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testresgroup/providers/Microsoft.Network/virtualNetworks/resvnet" -PS C:\>$Zone = New-AzureRmDnsZone -Name "myprivatezone.com" -ResourceGroupName "MyResourceGroup" -ZoneType Private -ResolutionVirtualNetworkId @($ResVirtualNetworkId) -``` - -This command creates a new Private DNS zone named myprivatezone.com in the specified resource group with -an associated resolution virtual network (specifying its ID), and then stores it in the $Zone variable. - -### Example 3: Create a Private DNS zone by specifying virtual network objects -``` -PS C:\>$ResVirtualNetwork = Get-AzureRmVirtualNetwork -Name "resvnet" -ResourceGroupName "testresgroup" -PS C:\>$Zone = New-AzureRmDnsZone -Name "myprivatezone.com" -ResourceGroupName "MyResourceGroup" -ZoneType Private -ResolutionVirtualNetwork @($ResVirtualNetwork) -``` - -This command creates a new Private DNS zone named myprivatezone.com in the specified resource group with -an associated resolution virtual network (referred to by $ResVirtualNetwork variable), and then stores it -in the $Zone variable. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the DNS zone to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RegistrationVirtualNetwork -The list of virtual networks that will register virtual machine hostnames records in this DNS zone, only available for private zones. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Internal.Network.Common.IResourceReference] -Parameter Sets: Objects -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RegistrationVirtualNetworkId -The list of virtual network IDs that will register virtual machine hostnames records in this DNS zone, only available for private zones. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: Ids -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResolutionVirtualNetwork -The list of virtual networks able to resolve records in this DNS zone, only available for private zones. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Internal.Network.Common.IResourceReference] -Parameter Sets: Objects -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResolutionVirtualNetworkId -The list of virtual network IDs able to resolve records in this DNS zone, only available for private zones. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: Ids -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group in which to create the zone. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ZoneType -The type of the zone, Public or Private. Zones without a type or with a type of Public are made available on the public DNS serving plane for use in the DNS hierarchy. Zones with a type of Private are only visible from with the set of associated virtual networks (this feature is in preview). This property cannot be changed for a zone. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.Dns.Models.ZoneType] -Parameter Sets: (All) -Aliases: -Accepted values: Public, Private - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[Microsoft.Azure.Management.Dns.Models.ZoneType, Microsoft.Azure.Management.Dns, Version=2.1.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -### System.Collections.Hashtable - -### System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Management.Internal.Network.Common.IResourceReference, Microsoft.Azure.Commands.Common.Network, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Dns.DnsZone - -## NOTES -You can use the *Confirm* parameter to control whether this cmdlet prompts you for confirmation. -By default, the cmdlet prompts you for confirmation if the $ConfirmPreference Windows PowerShell variable has a value of Medium or lower. -If you specify *Confirm* or *Confirm:$True*, this cmdlet prompts you for confirmation before it runs. -If you specify *Confirm:$False*, the cmdlet does not prompt you for confirmation. - -## RELATED LINKS - -[Get-AzureRmDnsZone](./Get-AzureRmDnsZone.md) - -[New-AzureRmDnsRecordSet](./New-AzureRmDnsRecordSet.md) - -[Remove-AzureRmDnsZone](./Remove-AzureRmDnsZone.md) diff --git a/azurermps-6.13.0/AzureRM.Dns/Remove-AzureRmDnsRecordConfig.md b/azurermps-6.13.0/AzureRM.Dns/Remove-AzureRmDnsRecordConfig.md deleted file mode 100644 index 151f23ad9b..0000000000 --- a/azurermps-6.13.0/AzureRM.Dns/Remove-AzureRmDnsRecordConfig.md +++ /dev/null @@ -1,487 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Dns.dll-Help.xml -Module Name: AzureRM.Dns -ms.assetid: D1A2326C-CD41-45A6-B37A-FC6176193B01 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.dns/remove-azurermdnsrecordconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Dns/Commands.Dns/help/Remove-AzureRmDnsRecordConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Dns/Commands.Dns/help/Remove-AzureRmDnsRecordConfig.md ---- - -# Remove-AzureRmDnsRecordConfig - -## SYNOPSIS -Removes a DNS record from a local record set object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### A -``` -Remove-AzureRmDnsRecordConfig -RecordSet <DnsRecordSet> -Ipv4Address <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### AAAA -``` -Remove-AzureRmDnsRecordConfig -RecordSet <DnsRecordSet> -Ipv6Address <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### NS -``` -Remove-AzureRmDnsRecordConfig -RecordSet <DnsRecordSet> -Nsdname <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### MX -``` -Remove-AzureRmDnsRecordConfig -RecordSet <DnsRecordSet> -Exchange <String> -Preference <UInt16> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### PTR -``` -Remove-AzureRmDnsRecordConfig -RecordSet <DnsRecordSet> -Ptrdname <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### TXT -``` -Remove-AzureRmDnsRecordConfig -RecordSet <DnsRecordSet> -Value <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SRV -``` -Remove-AzureRmDnsRecordConfig -RecordSet <DnsRecordSet> -Priority <UInt16> -Target <String> -Port <UInt16> - -Weight <UInt16> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### CNAME -``` -Remove-AzureRmDnsRecordConfig -RecordSet <DnsRecordSet> -Cname <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### Caa -``` -Remove-AzureRmDnsRecordConfig -RecordSet <DnsRecordSet> -CaaFlags <Byte> -CaaTag <String> -CaaValue <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmDnsRecordConfig** cmdlet removes a Domain Name System (DNS) record from a record set. -The **RecordSet** object is an offline object, and changes to it do not change the DNS responses until after you run the Set-AzureRmDnsRecordSet cmdlet to persist the change to the Microsoft Azure DNS service. -To remove a record, all the fields for that record type must match exactly. -You cannot add or remove SOA records. -SOA records are automatically created when a DNS zone is created and automatically deleted when the DNS zone is deleted. -You can pass the **RecordSet** object to this cmdlet as a parameter or by using the pipeline operator. - -## EXAMPLES - -### Example 1: Remove an A record from a record set -``` -PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name "www" -RecordType A -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" -PS C:\> Remove-AzureRmDnsRecordConfig -RecordSet $RecordSet -Ipv4Address 1.2.3.4 -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet - -# The above sequence can also be piped: - -PS C:\> Get-AzureRmDnsRecordSet -Name "www" -RecordType A -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzureRmDnsRecordConfig -Ipv4Address 1.2.3.4 | Set-AzureRmDnsRecordSet -``` - -This example removes an A record from an existing record set. -If this is the only record in the record set, the result will be an empty record set. -To remove a record set entirely, see Remove-AzureRmDnsRecordSet. - -### Example 2: Remove an AAAA record from a record set -``` -PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name "www" -RecordType AAAA -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" -PS C:\> Remove-AzureRmDnsRecordConfig -RecordSet $RecordSet -Ipv6Address 2001:DB80:4009:1803::1005 -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet - -# The above sequence can also be piped: - -PS C:\> Get-AzureRmDnsRecordSet -Name "www" -RecordType AAAA -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzureRmDnsRecordConfig -Ipv6Address 2001:DB80:4009:1803::1005 | Set-AzureRmDnsRecordSet -``` - -This example removes an AAAA record from an existing record set. -If this is the only record in the record set, the result will be an empty record set. -To remove a record set entirely, see Remove-AzureRmDnsRecordSet. - -### Example 3: Remove a CNAME record from a record set -``` -PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name "www" -RecordType CNAME -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" -PS C:\> Remove-AzureRmDnsRecordConfig -RecordSet $RecordSet -Cname contoso.com -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet - -# The above sequence can also be piped: - -PS C:\> Get-AzureRmDnsRecordSet -Name "www" -RecordType CNAME -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzureRmDnsRecordConfig -Cname contoso.com | Set-AzureRmDnsRecordSet -``` - -This example removes a CNAME record from an existing record set. -Because a CNAME record set can contain at most one record, the result is an empty record set. - -### Example 4: Remove an MX record from a record set -``` -PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name "@" -RecordType MX -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" -PS C:\> Remove-AzureRmDnsRecordConfig -Exchange mail.microsoft.com -Preference 5 -RecordSet $RecordSet -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet - -# The above sequence can also be piped: - -PS C:\> Get-AzureRmDnsRecordSet -Name "@" -RecordType MX -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzureRmDnsRecordConfig -Exchange mail.microsoft.com -Preference 5 | Set-AzureRmDnsRecordSet -``` - -This example removes an MX record from an existing record set. -The record name "@" indicates a record set at the zone apex. -If this is the only record in the record set, the result is an empty record set. -To remove a record set entirely, see Remove-AzureRmDnsRecordSet. - -### Example 5: Remove an NS record from a record set -``` -PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name "abc" -RecordType NS -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" -PS C:\> Remove-AzureRmDnsRecordConfig -Nsdname ns1.myzone.com -RecordSet $RecordSet -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet - -# The above sequence can also be piped: - -PS C:\> Get-AzureRmDnsRecordSet -Name "abc" -RecordType NS -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzureRmDnsRecordConfig -Nsdname "ns1.myzone.com" | Set-AzureRmDnsRecordSet -``` - -This example removes an NS record from an existing record set. -If this is the only record in the record set, the result is an empty record set. -To remove a record set entirely, see Remove-AzureRmDnsRecordSet. - -### Example 6: Remove a PTR record from a record set -``` -PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name "4" -RecordType PTR -ResouceGroupName "MyResourceGroup" -ZoneName 3.2.1.in-addr.arpa -PS C:\> Remove-AzureRmDnsRecordConfig -Ptrdname www.contoso.com -RecordSet $RecordSet -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet - -# The above sequence can also be piped: - -PS C:\> Get-AzureRmDnsRecordSet -Name "4" -RecordType PTR -ResouceGroupName "MyResourceGroup" -ZoneName "3.2.1.in-addr.arpa" | Remove-AzureRmDnsRecordConfig -Ptrdname www.contoso.com | Set-AzureRmDnsRecordSet -``` - -This example removes a PTR record from an existing record set. -If this is the only record in the record set, the result is an empty record set. -To remove a record set entirely, see Remove-AzureRmDnsRecordSet. - -### Example 7: Remove an SRV record from a record set -``` -PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name "_sip._tcp" -RecordType SRV -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" -PS C:\> Remove-AzureRmDnsRecordConfig -RecordSet $RecordSet -Priority 0 -Weight 5 -Port 8080 -Target target.example.com -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet - -# The above sequence can also be piped: - -PS C:\> Get-AzureRmDnsRecordSet -Name "_sip._tcp" -RecordType SRV -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzureRmDnsRecordConfig -Priority 0 -Weight 5 -Port 8080 -Target target.example.com | Set-AzureRmDnsRecordSet -``` - -This example removes an SRV record from an existing record set. -If this is the only record in the record set, the result is an empty record set. -To remove a record set entirely, see Remove-AzureRmDnsRecordSet. - -### Example 8: Remove a TXT record from a record set -``` -PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name "text" -RecordType TXT -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" -PS C:\> Remove-AzureRmDnsRecordConfig -RecordSet $RecordSet -Value "This is a TXT Record" -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet - -# The above sequence can also be piped: - -PS C:\> Get-AzureRmDnsRecordSet -Name "text" -RecordType TXT -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzureRmDnsRecordConfig -Value "This is a TXT Record" | Set-AzureRmDnsRecordSet -``` - -This example removes a TXT record from an existing record set. -If this is the only record in the record set, the result is an empty record set. -To remove a record set entirely, see Remove-AzureRmDnsRecordSet. - -## PARAMETERS - -### -CaaFlags -The flags for the CAA record to add. Must be a number between 0 and 255. - -```yaml -Type: System.Byte -Parameter Sets: Caa -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CaaTag -The tag field of the CAA record to add. - -```yaml -Type: System.String -Parameter Sets: Caa -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CaaValue -The value field for the CAA record to add. - -```yaml -Type: System.String -Parameter Sets: Caa -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Cname -Specifies the domain name for a canonical name (CNAME) record. - -```yaml -Type: System.String -Parameter Sets: CNAME -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Exchange -Specifies the mail exchange server name for a mail exchange (MX) record. - -```yaml -Type: System.String -Parameter Sets: MX -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Ipv4Address -Specifies an IPv4 address for an A record. - -```yaml -Type: System.String -Parameter Sets: A -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Ipv6Address -Specifies an IPv6 address for an AAAA record. - -```yaml -Type: System.String -Parameter Sets: AAAA -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Nsdname -Specifies the name server for a name server (NS) record. - -```yaml -Type: System.String -Parameter Sets: NS -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Port -Specifies the port for a service (SRV) record. - -```yaml -Type: System.UInt16 -Parameter Sets: SRV -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Preference -Specifies the preference for an MX record. - -```yaml -Type: System.UInt16 -Parameter Sets: MX -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Priority -Specifies the priority for an SRV record. - -```yaml -Type: System.UInt16 -Parameter Sets: SRV -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Ptrdname -Specifies the target domain name of a pointer (PTR) record. - -```yaml -Type: System.String -Parameter Sets: PTR -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RecordSet -Specifies the **RecordSet** object that contains the record to remove. - -```yaml -Type: Microsoft.Azure.Commands.Dns.DnsRecordSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Target -Specifies the target for an SRV record. - -```yaml -Type: System.String -Parameter Sets: SRV -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Value -Specifies the value for a TXT record. - -```yaml -Type: System.String -Parameter Sets: TXT -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Weight -Specifies the weight for an SRV record. - -```yaml -Type: System.UInt16 -Parameter Sets: SRV -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Dns.DnsRecordSet -Parameters: RecordSet (ByValue) - -### System.String - -### System.UInt16 - -### System.Byte - -## OUTPUTS - -### Microsoft.Azure.Commands.Dns.DnsRecordSet - -## NOTES - -## RELATED LINKS - -[Add-AzureRmDnsRecordConfig](./Add-AzureRmDnsRecordConfig.md) - -[Get-AzureRmDnsRecordSet](./Get-AzureRmDnsRecordSet.md) - -[Set-AzureRmDnsRecordSet](./Set-AzureRmDnsRecordSet.md) diff --git a/azurermps-6.13.0/AzureRM.Dns/Remove-AzureRmDnsRecordSet.md b/azurermps-6.13.0/AzureRM.Dns/Remove-AzureRmDnsRecordSet.md deleted file mode 100644 index c3a19e498f..0000000000 --- a/azurermps-6.13.0/AzureRM.Dns/Remove-AzureRmDnsRecordSet.md +++ /dev/null @@ -1,297 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Dns.dll-Help.xml -Module Name: AzureRM.Dns -ms.assetid: 505562A4-30BC-44E7-94EF-579763B8D794 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.dns/remove-azurermdnsrecordset -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Dns/Commands.Dns/help/Remove-AzureRmDnsRecordSet.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Dns/Commands.Dns/help/Remove-AzureRmDnsRecordSet.md ---- - -# Remove-AzureRmDnsRecordSet - -## SYNOPSIS -Deletes a record set. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Fields -``` -Remove-AzureRmDnsRecordSet -Name <String> -RecordType <RecordType> -ZoneName <String> - -ResourceGroupName <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### Mixed -``` -Remove-AzureRmDnsRecordSet -Name <String> -RecordType <RecordType> -Zone <DnsZone> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Object -``` -Remove-AzureRmDnsRecordSet -RecordSet <DnsRecordSet> [-Overwrite] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmDnsRecordSet** cmdlet deletes the specified record set from the specified zone. -You cannot delete SOA or name server (NS) records that are automatically created at the zone apex. -You can pass a **RecordSet** object to this cmdlet by using the pipeline operator or as a parameter. -To identify a record set by name and type without using a **RecordSet** object, you must pass the zone as a **DnsZone** object to this cmdlet by using the pipeline operator or as a parameter, or alternatively you can specify the *ZoneName* and *ResourceGroupName* parameters. -You can use the Confirm parameter and $ConfirmPreference Windows PowerShell variable to control whether the cmdlet prompts you for confirmation. -When specifying the record set using a **RecordSet** object, the record set is not deleted if it has been changed in Azure DNS since the local **RecordSet** object was retrieved. -This provides protection for concurrent changes. -You can suppress this by using the *Overwrite* parameter, which deletes the record set regardless of concurrent changes. - -## EXAMPLES - -### Example 1: Remove a record set -``` -PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name "www" -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" -PS C:\> Remove-AzureRmDnsRecordSet -RecordSet $RecordSet -``` - -The first command gets the specified record set, and then stores it in the $RecordSet variable.The second command removes the record set in $RecordSet. - -### Example 2: Remove a record set and suppress all confirmation -``` -PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name "www" -ZoneName "myzone.com" -ResourceGroupName "MyResourceGroup" -PS C:\> Remove-AzureRmDnsRecordSet -RecordSet $RecordSet -Confirm:$False -Overwrite - -# Alternatively, the record set can be removed as follows. In this case, -# because the record set is specified by name rather than by object, the -# Overwrite parameter is not applicable. - -PS C:\> Remove-AzureRmDnsRecordSet -Name "www" -ZoneName "myzone.com" -ResourceGroupName "MyResourceGroup" -Confirm:$False -``` - -The first command gets the specified record set. -The second command deletes the record set, even if it has changed in the meantime. -Confirmation prompts are suppressed. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the **RecordSet** to remove. -When specifying the record set by name, the DNS zone must be specified using either the *Zone* parameter or the *ZoneName* and *ResourceGroupName* parameters. -Alternatively, the record set can be specified using a **RecordSet** object, passed using the *RecordSet* parameter. - -```yaml -Type: System.String -Parameter Sets: Fields, Mixed -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Overwrite -When specifying the record set using a **RecordSet** object, the record set is not deleted if it has been changed in Azure DNS since the local **RecordSet** object was retrieved. -This provides protection for concurrent changes. -This can be suppressed using the *Overwrite* parameter, which deletes the record set regardless of concurrent changes. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Object -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -passthru - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecordSet -Specifies the **RecordSet** object to remove. -Alternatively, the record set can be specified using the *Name* and *Zone* parameters, or using the *Name*, *ZoneName*, and *ResourceGroupName* parameters. - -```yaml -Type: Microsoft.Azure.Commands.Dns.DnsRecordSet -Parameter Sets: Object -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RecordType -Specifies the type of DNS record. -Valid values are: -- A -- AAAA -- CNAME -- MX -- NS -- PTR -- SRV -- TXT -SOA records are deleted automatically when the zone is deleted. -You cannot manually delete SOA records. - -```yaml -Type: Microsoft.Azure.Management.Dns.Models.RecordType -Parameter Sets: Fields, Mixed -Aliases: -Accepted values: A, AAAA, CAA, CNAME, MX, NS, PTR, SOA, SRV, TXT - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group that contains the DNS zone that contains the **RecordSet** to delete. -This parameter is applicable only when the record set and DNS zone are specified using the *Name* and *ZoneName* parameters. -Alternatively, you can specify the record set using either the *RecordSet* parameter, or the *Name* and *Zone* parameters. - -```yaml -Type: System.String -Parameter Sets: Fields -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Zone -Specifies the DNS zone that contains the **RecordSet** to delete. -This parameter is applicable only when specifying the record set using the *Name* parameter. -Alternatively, you can specify the record set using either the *RecordSet* parameter, or the *Name*, *ZoneName*, and *ResourceGroupName* parameters. - -```yaml -Type: Microsoft.Azure.Commands.Dns.DnsZone -Parameter Sets: Mixed -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ZoneName -Specifies the name of the zone that contains the **RecordSet** to delete. -You must also specify the *Name* and *ResourceGroupName* parameters. -Alternatively, the record set can be specified using either the *RecordSet* parameter, or the *Name* and *Zone* parameters. - -```yaml -Type: System.String -Parameter Sets: Fields -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.Dns.Models.RecordType - -### System.String - -### Microsoft.Azure.Commands.Dns.DnsZone -Parameters: Zone (ByValue) - -### Microsoft.Azure.Commands.Dns.DnsRecordSet -Parameters: RecordSet (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES -You can use the *Confirm* parameter to control whether this cmdlet prompts you for confirmation. -By default, the cmdlet prompts you for confirmation if the $ConfirmPreference Windows PowerShell variable has a value of Medium or lower. -If you specify *Confirm* or *Confirm:$True*, this cmdlet prompts you for confirmation before it runs. -If you specify *Confirm:$False*, the cmdlet does not prompt you for confirmation. - -## RELATED LINKS - -[Get-AzureRmDnsRecordSet](./Get-AzureRmDnsRecordSet.md) - -[New-AzureRmDnsRecordSet](./New-AzureRmDnsRecordSet.md) - -[Set-AzureRmDnsRecordSet](./Set-AzureRmDnsRecordSet.md) diff --git a/azurermps-6.13.0/AzureRM.Dns/Remove-AzureRmDnsZone.md b/azurermps-6.13.0/AzureRM.Dns/Remove-AzureRmDnsZone.md deleted file mode 100644 index a819dae93e..0000000000 --- a/azurermps-6.13.0/AzureRM.Dns/Remove-AzureRmDnsZone.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Dns.dll-Help.xml -Module Name: AzureRM.Dns -ms.assetid: A8E230A0-5057-40BC-81CD-6D397A503A84 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.dns/remove-azurermdnszone -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Dns/Commands.Dns/help/Remove-AzureRmDnsZone.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Dns/Commands.Dns/help/Remove-AzureRmDnsZone.md ---- - -# Remove-AzureRmDnsZone - -## SYNOPSIS -Removes a DNS zone from a resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Fields -``` -Remove-AzureRmDnsZone -Name <String> -ResourceGroupName <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Object -``` -Remove-AzureRmDnsZone -Zone <DnsZone> [-Overwrite] [-PassThru] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmDnsZone** cmdlet permanently deletes a Domain Name System (DNS) zone from a specified resource group. -All record sets contained in the zone are also deleted. -You can pass a **DnsZone** object using the *Name* parameter or by using the pipeline operator, or alternatively you can specify the *ZoneName* and *ResourceGroupName* parameters. -You can use the Confirm parameter and $ConfirmPreference Windows PowerShell variable to control whether the cmdlet prompts you for confirmation. -When specifying the zone using a **DnsZone** object (passed via the pipeline or *Zone* parameter), the zone is not deleted if it has been changed in Azure DNS since the local **DnsZone** object was retrieved (only operations directly on the DNS zone resource count as changes, operations on record sets within the zone do not). -This provides protection for concurrent zone changes. -This can be suppressed using the *Overwrite* parameter, which deletes the zone regardless of concurrent changes. - -## EXAMPLES - -### Example 1: Remove a zone -``` -PS C:\>Remove-AzureRmDnsZone -Name "myzone.com" -ResourceGroupName "MyResourceGroup" -``` - -This command removes the zone named myzone.com from the resource group named MyResourceGroup. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the DNS zone that this cmdlet removes. -You must also specify the *ResourceGroupName* parameter. -Alternatively, you can specify the DNS zone using the *Zone* parameter. - -```yaml -Type: System.String -Parameter Sets: Fields -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Overwrite -When specifying the zone using a **DnsZone** object (passed via the pipeline or *Zone* parameter), the zone is not deleted if it has been changed in Azure DNS since the local **DnsZone** object was retrieved (only operations directly on the DNS zone resource count as changes, operations on record sets within the zone do not). -This provides protection for concurrent zone changes. -This can be suppressed using the *Overwrite* parameter, which deletes the zone regardless of concurrent changes. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Object -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -passthru - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the zone to remove. -You must also specify the *ZoneName* parameter. -Alternatively, you can specify the DNS zone using a **DnsZone** object, passed via either the pipeline or the *Zone* parameter. - -```yaml -Type: System.String -Parameter Sets: Fields -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Zone -Specifies the DNS zone to delete. -The **DnsZone** object passed can also be passed via the pipeline. -Alternatively, you can specify the DNS zone to delete by using the *ZoneName* and *ResourceGroupName* parameters. - -```yaml -Type: Microsoft.Azure.Commands.Dns.DnsZone -Parameter Sets: Object -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Dns.DnsZone -Parameters: Zone (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES -Due to the potentially high impact of deleting a DNS zone, by default, this cmdlet prompts for confirmation if the $ConfirmPreference Windows PowerShell variable has any value other than None. -If you specify *Confirm* or *Confirm:$True*, this cmdlet prompts you for confirmation before it runs. -If you specify *Confirm:$False*, the cmdlet does not prompt you for confirmation. - -## RELATED LINKS - -[Get-AzureRmDnsZone](./Get-AzureRmDnsZone.md) - -[New-AzureRmDnsZone](./New-AzureRmDnsZone.md) - -[Set-AzureRmDnsZone](./Set-AzureRmDnsZone.md) diff --git a/azurermps-6.13.0/AzureRM.Dns/Set-AzureRmDnsRecordSet.md b/azurermps-6.13.0/AzureRM.Dns/Set-AzureRmDnsRecordSet.md deleted file mode 100644 index 0a7874768a..0000000000 --- a/azurermps-6.13.0/AzureRM.Dns/Set-AzureRmDnsRecordSet.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Dns.dll-Help.xml -Module Name: AzureRM.Dns -ms.assetid: 99E6C4DD-11AF-4DC0-848B-39811240BE06 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.dns/set-azurermdnsrecordset -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Dns/Commands.Dns/help/Set-AzureRmDnsRecordSet.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Dns/Commands.Dns/help/Set-AzureRmDnsRecordSet.md ---- - -# Set-AzureRmDnsRecordSet - -## SYNOPSIS -Updates a DNS record set. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmDnsRecordSet -RecordSet <DnsRecordSet> [-Overwrite] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDnsRecordSet** cmdlet updates a record set in the Azure DNS service from a local **RecordSet** object. -You can pass a **RecordSet** object as a parameter or by using the pipeline operator. -You can use the *Confirm* parameter and $ConfirmPreference Windows PowerShell variable to control whether the cmdlet prompts you for confirmation. -The record set is not updated if it has been changed in Azure DNS since the local **RecordSet** object was retrieved. -This provides protection for concurrent changes. -You can suppress this behavior using the *Overwrite* parameter, which updates the record set regardless of concurrent changes. - -## EXAMPLES - -### Example 1: Update a record set -``` -PS C:\>$RecordSet = Get-AzureRmDnsRecordSet -ResourceGroupName MyResourceGroup -ZoneName myzone.com -Name www -RecordType A -PS C:\> Add-AzureRmDnsRecordConfig -RecordSet $RecordSet -Ipv4Address 172.16.0.0 -PS C:\> Add-AzureRmDnsRecordConfig -RecordSet $RecordSet -Ipv4Address 172.31.255.255 -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet - -# These cmdlets can also be piped: - -PS C:\> Get-AzureRmDnsRecordSet -ResourceGroupName MyResourceGroup -ZoneName myzone.com -Name www -RecordType A | Add-AzureRmDnsRecordConfig -Ipv4Address 172.16.0.0 | Add-AzureRmDnsRecordConfig -Ipv4Address 172.31.255.255 | Set-AzureRmDnsRecordSet -``` - -The first command uses the Get-AzureRmDnsRecordSet cmdlet to get the specified record set, and then stores it in the $RecordSet variable. -The second and third commands are off-line operations to add two A records to the record set. -The final command uses the **Set-AzureRmDnsRecordSet** cmdlet to commit the update. - -### Example 2: Update an SOA record -``` -PS C:\>$RecordSet = Get-AzureRmDnsRecordSet -Name "@" -RecordType SOA -Zone $Zone -PS C:\> $RecordSet.Records[0].Email = "admin.myzone.com" -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet -``` - -The first command uses the **Get-AzureRmDnsRecordset** cmdlet to get the specified record set, and then stores it in the $RecordSet variable. -The second command updates the specified SOA record in $RecordSet. -The final command uses the **Set-AzureRmDnsRecordSet** cmdlet to propagate the update in $RecordSet. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Overwrite -Indicates to update the record set regardless of concurrent changes. -The record set will not be updated if it has been changed in Azure DNS since the local **RecordSet** object was retrieved. -This provides protection for concurrent changes. -To suppress this behavior, you can use the *Overwrite* parameter, which results in the record set being updated regardless of concurrent changes. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecordSet -Specifies the **RecordSet** to update. - -```yaml -Type: Microsoft.Azure.Commands.Dns.DnsRecordSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Dns.DnsRecordSet -Parameters: RecordSet (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Dns.DnsRecordSet - -## NOTES -You can use the *Confirm* parameter to control whether this cmdlet prompts you for confirmation. -By default, the cmdlet prompts you for confirmation if the $ConfirmPreference Windows PowerShell variable has a value of Medium or lower. -If you specify *Confirm* or *Confirm:$True*, this cmdlet prompts you for confirmation before it runs. -If you specify *Confirm:$False*, the cmdlet does not prompt you for confirmation. - -## RELATED LINKS - -[Get-AzureRmDnsRecordSet](./Get-AzureRmDnsRecordSet.md) - -[New-AzureRmDnsRecordSet](./New-AzureRmDnsRecordSet.md) - -[Remove-AzureRmDnsRecordSet](./Remove-AzureRmDnsRecordSet.md) diff --git a/azurermps-6.13.0/AzureRM.Dns/Set-AzureRmDnsZone.md b/azurermps-6.13.0/AzureRM.Dns/Set-AzureRmDnsZone.md deleted file mode 100644 index 0d781ed4ed..0000000000 --- a/azurermps-6.13.0/AzureRM.Dns/Set-AzureRmDnsZone.md +++ /dev/null @@ -1,315 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Dns.dll-Help.xml -Module Name: AzureRM.Dns -ms.assetid: E37ADC54-A37B-41BF-BE94-9E4052C234BB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.dns/set-azurermdnszone -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Dns/Commands.Dns/help/Set-AzureRmDnsZone.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Dns/Commands.Dns/help/Set-AzureRmDnsZone.md ---- - -# Set-AzureRmDnsZone - -## SYNOPSIS -Updates the properties of a DNS zone. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Fields (Default) -``` -Set-AzureRmDnsZone -Name <String> -ResourceGroupName <String> [-Tag <Hashtable>] - [-RegistrationVirtualNetworkId <System.Collections.Generic.List`1[System.String]>] - [-ResolutionVirtualNetworkId <System.Collections.Generic.List`1[System.String]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### FieldsObjects -``` -Set-AzureRmDnsZone -Name <String> -ResourceGroupName <String> [-Tag <Hashtable>] - [-RegistrationVirtualNetwork <System.Collections.Generic.List`1[Microsoft.Azure.Management.Internal.Network.Common.IResourceReference]>] - [-ResolutionVirtualNetwork <System.Collections.Generic.List`1[Microsoft.Azure.Management.Internal.Network.Common.IResourceReference]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Object -``` -Set-AzureRmDnsZone -Zone <DnsZone> [-Overwrite] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDnsZone** cmdlet updates the specified DNS zone in the Azure DNS service. -This cmdlet does not update the record sets in the zone. -You can pass a **DnsZone** object as a parameter or by using the pipeline operator, or -alternatively you can specify the *ZoneName* and *ResourceGroupName* parameters. -You can use the *Confirm* parameter and $ConfirmPreference Windows PowerShell variable to control -whether the cmdlet prompts you for confirmation. -When passing a DNS zone as an object (using the Zone object or via the pipeline), it is not updated -if it has been changed in Azure DNS since the local DnsZone object was retrieved. This provides -protection for concurrent changes. You can suppress this behavior with the *Overwrite* parameter, -which updates the zone regardless of concurrent changes. - -## EXAMPLES - -### Example 1: Update a DNS zone -``` -PS C:\>$Zone = Get-AzureRmDnsZone -Name "myzone.com" -ResourceGroupName "MyResourceGroup" -PS C:\> $Zone.Tags = @(@{"Name"="Dept"; "Value"="Electrical"}) -PS C:\> Set-AzureRmDnsZone -Zone $Zone -``` - -The first command gets the zone named myzone.com from the specified resource group, and then stores -it in the $Zone variable. -The second command updates the tags for $Zone. -The final command commits the change. - -### Example 2: Update tags for a zone -``` -PS C:\>Set-AzureRmDNSZone -ResourceGroupName "MyResourceGroup" -Name "myzone.com" -Tag @(@{"Name"="Dept"; "Value"="Electrical"}) -``` - -This command updates the tags for the zone named myzone.com without first explicitly getting the -zone. - -### Example 3: Associating a private zone with a virtual network by specifying its ID -``` -PS C:\>$vnet = Get-AzureRmVirualNetwork -ResourceGroupName "MyResourceGroup" -Name "myvnet" -PS C:\>Set-AzureRmDNSZone -ResourceGroupName "MyResourceGroup" -Name "myprivatezone.com" -RegistrationVirtualNetworkId @($vnet.Id) -``` - -This command associates the Private DNS zone myprivatezone.com with the virtual network myvnet as a registration network -by specifying its ID. - -### Example 4: Associating a private zone with a virtual network by specifying the network object. -``` -PS C:\>$vnet = Get-AzureRmVirualNetwork -ResourceGroupName "MyResourceGroup" -Name "myvnet" -PS C:\>Set-AzureRmDNSZone -ResourceGroupName "MyResourceGroup" -Name "myprivatezone.com" -RegistrationVirtualNetwork @($vnet) -``` - -This command associates the Private DNS zone myprivatezone.com with the virtual network myvnet as a registration network -by passing the virtual network object represented by $vnet variable to the Set-AzureRmDnsZone cmdlet. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the DNS zone to update. - -```yaml -Type: System.String -Parameter Sets: Fields, FieldsObjects -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Overwrite -When passing a DNS zone as an object (using the Zone object or via the pipeline), it is not updated -if it has been changed in Azure DNS since the local DnsZone object was retrieved. This provides -protection for concurrent changes. You can suppress this behavior with the *Overwrite* parameter, -which updates the zone regardless of concurrent changes. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Object -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegistrationVirtualNetwork -The list of virtual networks that will register virtual machine hostnames records in this DNS zone, only available for private zones. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Internal.Network.Common.IResourceReference] -Parameter Sets: FieldsObjects -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RegistrationVirtualNetworkId -The list of virtual network IDs that will register virtual machine hostnames records in this DNS zone, only available for private zones. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: Fields -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResolutionVirtualNetwork -The list of virtual networks able to resolve records in this DNS zone, only available for private zones. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Internal.Network.Common.IResourceReference] -Parameter Sets: FieldsObjects -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResolutionVirtualNetworkId -The list of virtual network IDs able to resolve records in this DNS zone, only available for private zones. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: Fields -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the zone to update. -You must also specify the ZoneName parameter. -Alternatively, you can specify the zone using a DnsZone object with the *Zone* parameter or the pipeline. - -```yaml -Type: System.String -Parameter Sets: Fields, FieldsObjects -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: Fields, FieldsObjects -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Zone -Specifies the DNS zone to update. -Alternatively, you can specify the zone using the *ZoneName* and *ResourceGroupName* parameters. - -```yaml -Type: Microsoft.Azure.Commands.Dns.DnsZone -Parameter Sets: Object -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -### System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Management.Internal.Network.Common.IResourceReference, Microsoft.Azure.Commands.Common.Network, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] - -### Microsoft.Azure.Commands.Dns.DnsZone -Parameters: Zone (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Dns.DnsZone - -## NOTES -You can use the *Confirm* parameter to control whether this cmdlet prompts you for confirmation. -By default, the cmdlet prompts you for confirmation if the $ConfirmPreference Windows PowerShell variable has a value of Medium or lower. -If you specify *Confirm* or *Confirm:$True*, this cmdlet prompts you for confirmation before it runs. -If you specify *Confirm:$False*, the cmdlet does not prompt you for confirmation. - -## RELATED LINKS - -[Get-AzureRmDnsZone](./Get-AzureRmDnsZone.md) - -[New-AzureRmDnsZone](./New-AzureRmDnsZone.md) - -[Remove-AzureRmDnsZone](./Remove-AzureRmDnsZone.md) diff --git a/azurermps-6.13.0/AzureRM.EventGrid/AzureRM.EventGrid.md b/azurermps-6.13.0/AzureRM.EventGrid/AzureRM.EventGrid.md deleted file mode 100644 index fd2ede3355..0000000000 --- a/azurermps-6.13.0/AzureRM.EventGrid/AzureRM.EventGrid.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -Module Name: AzureRM.EventGrid -Module Guid: 53BF7132-5BB4-46EB-AC05-61A49A6CD5EB -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventgrid -Help Version: 1.0.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventGrid/Commands.EventGrid/help/AzureRM.EventGrid.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventGrid/Commands.EventGrid/help/AzureRM.EventGrid.md ---- - -# AzureRM.EventGrid Module -## Description -This topic displays help for the Azure Event Grid PowerShell resource manager cmdlets. - -## AzureRM.EventGrid Cmdlets -### [Get-AzureRmEventGridSubscription](Get-AzureRmEventGridSubscription.md) -Gets the details of an event subscription, or gets a list of all event subscriptions in the current Azure subscription. - -### [Get-AzureRmEventGridTopic](Get-AzureRmEventGridTopic.md) -Gets the details of an Event Grid topic, or gets a list of all Event Grid topics in the current Azure subscription. - -### [Get-AzureRmEventGridTopicKey](Get-AzureRmEventGridTopicKey.md) -Gets the shared access keys used to publish events to an Event Grid topic. - -### [Get-AzureRmEventGridTopicType](Get-AzureRmEventGridTopicType.md) -Gets the details about the topic types supported by Azure Event Grid. - -### [New-AzureRmEventGridSubscription](New-AzureRmEventGridSubscription.md) -Creates a new Azure Event Grid Event Subscription to a topic, Azure resource, Azure subscription or Resource Group. - -### [New-AzureRmEventGridTopic](New-AzureRmEventGridTopic.md) -Creates a new Azure Event Grid Topic. - -### [New-AzureRmEventGridTopicKey](New-AzureRmEventGridTopicKey.md) -Regenerates the shared access key for an Azure Event Grid Topic. - -### [Remove-AzureRmEventGridSubscription](Remove-AzureRmEventGridSubscription.md) -Removes an Azure Event Grid event subscription. - -### [Remove-AzureRmEventGridTopic](Remove-AzureRmEventGridTopic.md) -Removes an Azure Event Grid Topic. - -### [Set-AzureRmEventGridTopic](Set-AzureRmEventGridTopic.md) -Sets the properties of an Event Grid topic. - -### [Update-AzureRmEventGridSubscription](Update-AzureRmEventGridSubscription.md) -Update the properties of an Event Grid event subscription. - diff --git a/azurermps-6.13.0/AzureRM.EventGrid/Get-AzureRmEventGridSubscription.md b/azurermps-6.13.0/AzureRM.EventGrid/Get-AzureRmEventGridSubscription.md deleted file mode 100644 index 6a972af355..0000000000 --- a/azurermps-6.13.0/AzureRM.EventGrid/Get-AzureRmEventGridSubscription.md +++ /dev/null @@ -1,282 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventGrid.dll-Help.xml -Module Name: AzureRM.EventGrid -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventgrid/get-azurermeventgridsubscription -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventGrid/Commands.EventGrid/help/Get-AzureRmEventGridSubscription.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventGrid/Commands.EventGrid/help/Get-AzureRmEventGridSubscription.md ---- - -# Get-AzureRmEventGridSubscription - -## SYNOPSIS -Gets the details of an event subscription, or gets a list of all event subscriptions in the current Azure subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### EventSubscriptionTopicNameParameterSet (Default) -``` -Get-AzureRmEventGridSubscription [[-EventSubscriptionName] <String>] [[-ResourceGroupName] <String>] - [[-TopicName] <String>] [-IncludeFullEndpointUrl] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ResourceIdEventSubscriptionParameterSet -``` -Get-AzureRmEventGridSubscription [[-EventSubscriptionName] <String>] [-ResourceId] <String> - [-IncludeFullEndpointUrl] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### EventSubscriptionTopicTypeNameParameterSet -``` -Get-AzureRmEventGridSubscription [[-ResourceGroupName] <String>] [[-TopicTypeName] <String>] - [[-Location] <String>] [-IncludeFullEndpointUrl] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### EventSubscriptionInputObjectSet -``` -Get-AzureRmEventGridSubscription [-InputObject] <PSTopic> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmEventGridSubscription cmdlet gets either the details of a specified Event Grid subscription, or a list of all Event Grid subscriptions in the current Azure subscription or resource group. -If the event subscription name is provided, the details of a single Event Grid subscription is returned. -If the event subscription name is not provided, a list of all event subscriptions is returned. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmEventGridSubscription -ResourceGroupName MyResourceGroupName -TopicName Topic1 -EventSubscriptionName EventSubscription1 -``` - -Gets the details of event subscription \`EventSubscription1\` created for topic \`Topic1\` in resource group \`MyResourceGroupName\`. - -### Example 2 -``` -PS C:\> Get-AzureRmEventGridSubscription -ResourceGroupName MyResourceGroupName -TopicName Topic1 -EventSubscriptionName EventSubscription1 -IncludeFullEndpointUrl -``` - -Gets the details of event subscription \`EventSubscription1\` created for topic \`Topic1\` in resource group \`MyResourceGroupName\`, including the full endpoint URL if it is a webhook based event subscription. - -### Example 3 -``` -PS C:\> Get-AzureRmEventGridSubscription -ResourceGroupName MyResourceGroupName -TopicName Topic1 -``` - -Get a list of all the event subscriptions created for topic \`Topic1\` in resource group \`MyResourceGroupName\`. - -### Example 4 -``` -PS C:\> Get-AzureRmEventGridSubscription -ResourceGroupName MyResourceGroupName -EventSubscriptionName EventSubscription1 -``` - -Gets the details of event subscription \`EventSubscription1\` created for resource group \`MyResourceGroupName\`. - -### Example 5 -``` -PS C:\> Get-AzureRmEventGridSubscription -EventSubscriptionName EventSubscription1 -``` - -Gets the details of event subscription \`EventSubscription1\` created for the currently selected Azure subscription. - -### Example 6 -``` -PS C:\> Get-AzureRmEventGridSubscription -ResourceGroupName MyResourceGroupName -``` - -Gets the list of all global event subscriptions created under the resource group \`MyResourceGroupName\`. - -### Example 7 -``` -PS C:\> Get-AzureRmEventGridSubscription -``` - -Gets the list of all global event subscriptions created under the currently selected Azure subscription. - -### Example 8 -``` -PS C:\> Get-AzureRmEventGridSubscription -ResourceGroupName MyResourceGroupName -Location westus2 -``` - -Gets the list of all regional event subscriptions created under resource group \`MyResourceGroupName\` in the specified location \`westus2\`. - -### Example 9 -``` -PS C:\> Get-AzureRmEventGridSubscription -ResourceId "/subscriptions/$subscriptionId/resourceGroups/$resourceGroupName/providers/Microsoft.EventHub/namespaces/$namespaceName" -``` - -Gets the list of all event subscriptions created for the specified EventHub namespace. - -### Example 10 -``` -PS C:\> Get-AzureRmEventGridSubscription -TopicTypeName "Microsoft.EventHub.Namespaces" -Location $location -``` - -Gets the list of all event subscriptions created for the specified topic type (EventHub namespaces) in the specified location. - -### Example 11 -``` -PS C:\> Get-AzureRmEventGridSubscription -TopicTypeName "Microsoft.Resources.ResourceGroups" -ResourceGroupName MyResourceGroupName -``` - -Gets the list of all event subscriptions created for the specific resource group. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventSubscriptionName -The name of the event subscription - -```yaml -Type: System.String -Parameter Sets: EventSubscriptionTopicNameParameterSet, ResourceIdEventSubscriptionParameterSet -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IncludeFullEndpointUrl -Include the full endpoint URL of the event subscription destination. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: EventSubscriptionTopicNameParameterSet, ResourceIdEventSubscriptionParameterSet, EventSubscriptionTopicTypeNameParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -EventGrid Event Subscription object. - -```yaml -Type: Microsoft.Azure.Commands.EventGrid.Models.PSTopic -Parameter Sets: EventSubscriptionInputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Location -Location - -```yaml -Type: System.String -Parameter Sets: EventSubscriptionTopicTypeNameParameterSet -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: EventSubscriptionTopicNameParameterSet, EventSubscriptionTopicTypeNameParameterSet -Aliases: ResourceGroup - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Identifier of the resource to which event subscriptions have been created. - -```yaml -Type: System.String -Parameter Sets: ResourceIdEventSubscriptionParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TopicName -EventGrid Topic Name. - -```yaml -Type: System.String -Parameter Sets: EventSubscriptionTopicNameParameterSet -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TopicTypeName -TopicType name - -```yaml -Type: System.String -Parameter Sets: EventSubscriptionTopicTypeNameParameterSet -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.EventGrid.Models.PSTopic -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.EventGrid.Models.PSEventSubscription - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.EventGrid/Get-AzureRmEventGridTopic.md b/azurermps-6.13.0/AzureRM.EventGrid/Get-AzureRmEventGridTopic.md deleted file mode 100644 index fb852533ae..0000000000 --- a/azurermps-6.13.0/AzureRM.EventGrid/Get-AzureRmEventGridTopic.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventGrid.dll-Help.xml -Module Name: AzureRM.EventGrid -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventgrid/get-azurermeventgridtopic -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventGrid/Commands.EventGrid/help/Get-AzureRmEventGridTopic.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventGrid/Commands.EventGrid/help/Get-AzureRmEventGridTopic.md ---- - -# Get-AzureRmEventGridTopic - -## SYNOPSIS -Gets the details of an Event Grid topic, or gets a list of all Event Grid topics in the current Azure subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceGroupNameParameterSet (Default) -``` -Get-AzureRmEventGridTopic [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### TopicNameParameterSet -``` -Get-AzureRmEventGridTopic [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceIdEventSubscriptionParameterSet -``` -Get-AzureRmEventGridTopic [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmEventGridTopic cmdlet gets either the details of a specified Event Grid Topic, or a list of all Event Grid topics in the current Azure subscription. -If the topic name is provided, the details of a single Event Grid Topic is returned. -If the topic name is not provided, a list of topics is returned. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmEventGridTopic -ResourceGroup MyResourceGroupName -Name Topic1 -``` - -Gets the details of Event Grid topic \`Topic1\` in resource group \`MyResourceGroupName\`. - -### Example 2 -``` -PS C:\> Get-AzureRmEventGridTopic -ResourceId "/subscriptions/$subscriptionId/resourceGroups/MyResourceGroupName/providers/Microsoft.EventGrid/topics/Topic1" -``` - -Gets the details of Event Grid topic \`Topic1\` in resource group \`MyResourceGroupName\`. - -### Example 3 -``` -PS C:\> Get-AzureRmEventGridTopic -ResourceGroup MyResourceGroupName -``` - -List all the Event Grid topics in resource group \`MyResourceGroupName\`. - -### Example 4 -``` -PS C:\> Get-AzureRmEventGridTopic -``` - -List all the Event Grid topics in the subscription. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -EventGrid Topic Name. - -```yaml -Type: System.String -Parameter Sets: TopicNameParameterSet -Aliases: TopicName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupNameParameterSet -Aliases: ResourceGroup - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: TopicNameParameterSet -Aliases: ResourceGroup - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Resource Identifier representing the Event Grid Topic. - -```yaml -Type: System.String -Parameter Sets: ResourceIdEventSubscriptionParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.EventGrid.Models.PSTopic - -### Microsoft.Azure.Commands.EventGrid.Models.PSTopicListInstance - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.EventGrid/Get-AzureRmEventGridTopicKey.md b/azurermps-6.13.0/AzureRM.EventGrid/Get-AzureRmEventGridTopicKey.md deleted file mode 100644 index 2b6d529829..0000000000 --- a/azurermps-6.13.0/AzureRM.EventGrid/Get-AzureRmEventGridTopicKey.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventGrid.dll-Help.xml -Module Name: AzureRM.EventGrid -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventgrid/get-azurermeventgridtopickey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventGrid/Commands.EventGrid/help/Get-AzureRmEventGridTopicKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventGrid/Commands.EventGrid/help/Get-AzureRmEventGridTopicKey.md ---- - -# Get-AzureRmEventGridTopicKey - -## SYNOPSIS -Gets the shared access keys used to publish events to an Event Grid topic. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### TopicNameParameterSet (Default) -``` -Get-AzureRmEventGridTopicKey [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### TopicInputObjectParameterSet -``` -Get-AzureRmEventGridTopicKey [-InputObject] <PSTopic> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ResourceIdEventSubscriptionParameterSet -``` -Get-AzureRmEventGridTopicKey [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -Gets the shared access keys used to publish events to an Event Grid topic. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmEventGridTopicKey -ResourceGroup MyResourceGroupName -Name Topic1 -``` - -Gets the shared access keys of Event Grid topic \`Topic1\` in resource group \`MyResourceGroupName\`. - -### Example 2 -``` -PS C:\> Get-AzureRmEventGridTopic -ResourceGroup MyResourceGroupName -Name Topic1 | Get-AzureRmEventGridTopicKey -``` - -Gets the shared access keys of Event Grid topic \`Topic1\` in resource group \`MyResourceGroupName\`. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -EventGrid Topic object. - -```yaml -Type: Microsoft.Azure.Commands.EventGrid.Models.PSTopic -Parameter Sets: TopicInputObjectParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -EventGrid Topic Name. - -```yaml -Type: System.String -Parameter Sets: TopicNameParameterSet -Aliases: TopicName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: TopicNameParameterSet -Aliases: ResourceGroup - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Resource Identifier representing the Event Grid Topic. - -```yaml -Type: System.String -Parameter Sets: ResourceIdEventSubscriptionParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.EventGrid.Models.PSTopic -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Management.EventGrid.Models.TopicSharedAccessKeys - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.EventGrid/Get-AzureRmEventGridTopicType.md b/azurermps-6.13.0/AzureRM.EventGrid/Get-AzureRmEventGridTopicType.md deleted file mode 100644 index 8ac751216e..0000000000 --- a/azurermps-6.13.0/AzureRM.EventGrid/Get-AzureRmEventGridTopicType.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventGrid.dll-Help.xml -Module Name: AzureRM.EventGrid -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventgrid/get-azurermeventgridtopictype -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventGrid/Commands.EventGrid/help/Get-AzureRmEventGridTopicType.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventGrid/Commands.EventGrid/help/Get-AzureRmEventGridTopicType.md ---- - -# Get-AzureRmEventGridTopicType - -## SYNOPSIS -Gets the details about the topic types supported by Azure Event Grid. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmEventGridTopicType [[-Name] <String>] [-IncludeEventTypeData] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Gets the details of topic types supported by Azure Event Grid. -If a topic type name is specified, details about that topic type are returned. -If a topic type name is not specified, details about all topic types are returned. -If IncludeEventTypes is specified, information about event types supported by each topic type is included in the response. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmEventGridTopicType -``` - -Gets a list of the topic types. - -### Example 2 -``` -PS C:\> Get-AzureRmEventGridTopicType -Name "Microsoft.Storage.StorageAccounts" -``` - -Gets information about the StorageAccounts topic type. - -### Example 3 -``` -PS C:\> Get-AzureRmEventGridTopicType -Name "Microsoft.Storage.StorageAccounts" -IncludeEventTypeData -``` - -Gets information about the StorageAccounts topic type, including the event types supported by StorageAccounts. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeEventTypeData -If specified, the response will include the event types supported by a topic type. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -EventGrid Topic Type Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.EventGrid.Models.PSTopicTypeInfoListInstance - -### Microsoft.Azure.Commands.EventGrid.Models.PSTopicTypeInfo - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.EventGrid/New-AzureRmEventGridSubscription.md b/azurermps-6.13.0/AzureRM.EventGrid/New-AzureRmEventGridSubscription.md deleted file mode 100644 index 0f2242fc6a..0000000000 --- a/azurermps-6.13.0/AzureRM.EventGrid/New-AzureRmEventGridSubscription.md +++ /dev/null @@ -1,453 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventGrid.dll-Help.xml -Module Name: AzureRM.EventGrid -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventgrid/new-azurermeventgridsubscription -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventGrid/Commands.EventGrid/help/New-AzureRmEventGridSubscription.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventGrid/Commands.EventGrid/help/New-AzureRmEventGridSubscription.md ---- - -# New-AzureRmEventGridSubscription - -## SYNOPSIS -Creates a new Azure Event Grid Event Subscription to a topic, Azure resource, Azure subscription or Resource Group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceGroupNameParameterSet (Default) -``` -New-AzureRmEventGridSubscription [-EventSubscriptionName] <String> [-Endpoint] <String> - [[-ResourceGroupName] <String>] [[-EndpointType] <String>] [[-SubjectBeginsWith] <String>] - [[-SubjectEndsWith] <String>] [-SubjectCaseSensitive] [[-IncludedEventType] <String[]>] [[-Label] <String[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdEventSubscriptionParameterSet -``` -New-AzureRmEventGridSubscription [-ResourceId] <String> [-EventSubscriptionName] <String> [-Endpoint] <String> - [[-EndpointType] <String>] [[-SubjectBeginsWith] <String>] [[-SubjectEndsWith] <String>] - [-SubjectCaseSensitive] [[-IncludedEventType] <String[]>] [[-Label] <String[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### EventSubscriptionInputObjectSet -``` -New-AzureRmEventGridSubscription [-InputObject] <PSTopic> [-EventSubscriptionName] <String> - [-Endpoint] <String> [[-EndpointType] <String>] [[-SubjectBeginsWith] <String>] [[-SubjectEndsWith] <String>] - [-SubjectCaseSensitive] [[-IncludedEventType] <String[]>] [[-Label] <String[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### CustomTopicEventSubscriptionParameterSet -``` -New-AzureRmEventGridSubscription [-EventSubscriptionName] <String> [-Endpoint] <String> - [-ResourceGroupName] <String> [-TopicName] <String> [[-EndpointType] <String>] [[-SubjectBeginsWith] <String>] - [[-SubjectEndsWith] <String>] [-SubjectCaseSensitive] [[-IncludedEventType] <String[]>] [[-Label] <String[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Create a new event subscription to an Azure Event Grid topic, a supported Azure resource, an Azure subscription or Resource Group. -To create an event subscription to the currently selected Azure subscription, specify the event subscription name and the destination endpoint. -To create an event subscription to a resource group, specify the resource group name in addition to the event subscription name and the destination endpoint. -To create an event subscription to an Azure Event Grid topic, specify the topic name as well. -To create an event subscription to a supported Azure resource, specify the full resource ID of the resource. To view the list of supported types, run the Get-AzureRmEventGridTopicType cmdlet. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmEventGridSubscription -ResourceGroup MyResourceGroup -TopicName Topic1 -Endpoint https://requestb.in/19qlscd1 -EventSubscriptionName EventSubscription1 -``` - -Creates a new event subscription \`EventSubscription1\` to an Azure Event Grid topic \`Topic1\` in resource group \`MyResourceGroupName\` with the webhook destination endpoint `https://requestb.in/19qlscd1`. This event subscription uses default filters. - -### Example 2 -``` -PS C:\> New-AzureRmEventGridSubscription -ResourceGroup MyResourceGroupName -Endpoint https://requestb.in/19qlscd1 -EventSubscriptionName EventSubscription1 -``` - -Creates a new event subscription \`EventSubscription1\` to a resource group \`MyResourceGroupName\` with the webhook destination endpoint `https://requestb.in/19qlscd1`. This event subscription uses default filters. - -### Example 3 -``` -PS C:\> New-AzureRmEventGridSubscription -Endpoint https://requestb.in/19qlscd1 -EventSubscriptionName EventSubscription1 -``` - -Creates a new event subscription \`EventSubscription1\` to the currently selected Azure subscription with the webhook destination endpoint `https://requestb.in/19qlscd1`. This event subscription uses default filters. - -### Example 4 -``` -PS C:\> $includedEventTypes = "Microsoft.Resources.ResourceWriteFailure", "Microsoft.Resources.ResourceWriteSuccess" -PS C:\> $labels = "Finance", "HR" -PS C:\> New-AzureRmEventGridSubscription -Endpoint https://requestb.in/19qlscd1 -EventSubscriptionName EventSubscription1 -SubjectBeginsWith "TestPrefix" -SubjectEndsWith "TestSuffix" -IncludedEventType $includedEventTypes -Label $labels -``` - -Creates a new event subscription \`EventSubscription1\` to the currently selected Azure subscription with the webhook destination endpoint `https://requestb.in/19qlscd1`. This event subscription specifies the additional filters for event types and subject, and only events matching those filters will be delivered to the destination endpoint. - -### Example 5 -``` -PS C:\> New-AzureRmEventGridSubscription -EventSubscriptionName EventSubscription1 -EndpointType "eventhub" -Endpoint "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1" -``` - -Creates a new event subscription \`EventSubscription1\` to the currently selected Azure subscription with the specified event hub as the destination for events. This event subscription uses default filters. - -### Example 6 -``` -PS C:\> New-AzureRmEventGridSubscription -ResourceId "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace" -Endpoint https://requestb.in/19qlscd1 -EventSubscriptionName EventSubscription1 -``` - -Creates a new event subscription \`EventSubscription1\` to an EventHub namespace with the specified webhhok destination endpoint `https://requestb.in/19qlscd1`. This event subscription uses default filters. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Endpoint -Event subscription destination endpoint. -This can be a webhook URL or the Azure resource ID of an EventHub. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: EventSubscriptionInputObjectSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EndpointType -Endpoint Type. -This can be webhook or eventhub - -```yaml -Type: System.String -Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet -Aliases: -Accepted values: webhook, eventhub - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: EventSubscriptionInputObjectSet -Aliases: -Accepted values: webhook, eventhub - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EventSubscriptionName -The name of the event subscription - -```yaml -Type: System.String -Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: EventSubscriptionInputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IncludedEventType -Filter that specifies a list of event types to include.If not specified, all event types will be included. - -```yaml -Type: System.String[] -Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String[] -Parameter Sets: EventSubscriptionInputObjectSet -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -EventGrid Topic object. - -```yaml -Type: Microsoft.Azure.Commands.EventGrid.Models.PSTopic -Parameter Sets: EventSubscriptionInputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Label -Labels for the event subscription - -```yaml -Type: System.String[] -Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String[] -Parameter Sets: EventSubscriptionInputObjectSet -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group of the topic. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupNameParameterSet -Aliases: ResourceGroup - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: CustomTopicEventSubscriptionParameterSet -Aliases: ResourceGroup - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The identifier of the resource to which the event subscription should be created. - -```yaml -Type: System.String -Parameter Sets: ResourceIdEventSubscriptionParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubjectBeginsWith -Filter that specifies that only events matching the specified subject prefix will be included. -If not specified, events with all subject prefixes will be included. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: EventSubscriptionInputObjectSet -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubjectCaseSensitive -Filter that specifies that the subject field should be compared in a case sensitive manner. -If not specified, subject will be compared in a case insensitive manner. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubjectEndsWith -Filter that specifies that only events matching the specified subject suffix will be included. -If not specified, events with all subject suffixes will be included. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: EventSubscriptionInputObjectSet -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TopicName -The name of the topic to which the event subscription should be created. - -```yaml -Type: System.String -Parameter Sets: CustomTopicEventSubscriptionParameterSet -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.EventGrid.Models.PSTopic -Parameters: InputObject (ByValue) - -### System.String[] - -## OUTPUTS - -### Microsoft.Azure.Commands.EventGrid.Models.PSEventSubscription - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.EventGrid/New-AzureRmEventGridTopic.md b/azurermps-6.13.0/AzureRM.EventGrid/New-AzureRmEventGridTopic.md deleted file mode 100644 index 69d83afd48..0000000000 --- a/azurermps-6.13.0/AzureRM.EventGrid/New-AzureRmEventGridTopic.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventGrid.dll-Help.xml -Module Name: AzureRM.EventGrid -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventgrid/new-azurermeventgridtopic -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventGrid/Commands.EventGrid/help/New-AzureRmEventGridTopic.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventGrid/Commands.EventGrid/help/New-AzureRmEventGridTopic.md ---- - -# New-AzureRmEventGridTopic - -## SYNOPSIS -Creates a new Azure Event Grid Topic. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmEventGridTopic [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> - [[-Tag] <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Creates a new Azure Event Grid Topic. Once the topic is created, an application can publish events to the topic endpoint. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmEventGridTopic -ResourceGroupName MyResourceGroupName -Name Topic1 -Location westus2 -``` - -Creates an Event Grid topic \`Topic1\` in the specified geographic location \`westus2\`, in resource group \`MyResourceGroupName\`. - -### Example 2 -``` -PS C:\> New-AzureRmEventGridTopic -ResourceGroupName MyResourceGroupName -Name Topic1 -Location westus2 -Tag @{ Department="Finance"; Environment="Test" } -``` - -Creates an Event Grid topic \`Topic1\` in the specified geographic location \`westus2\`, in resource group \`MyResourceGroupName\` with the specified tags "Department" and "Environment". - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The location of the topic - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The name of the topic. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: TopicName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group in which the topic should be created. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Hashtables which represents resource Tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.EventGrid.Models.PSTopic - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.EventGrid/New-AzureRmEventGridTopicKey.md b/azurermps-6.13.0/AzureRM.EventGrid/New-AzureRmEventGridTopicKey.md deleted file mode 100644 index 1b8441d9f0..0000000000 --- a/azurermps-6.13.0/AzureRM.EventGrid/New-AzureRmEventGridTopicKey.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventGrid.dll-Help.xml -Module Name: AzureRM.EventGrid -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventgrid/new-azurermeventgridtopickey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventGrid/Commands.EventGrid/help/New-AzureRmEventGridTopicKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventGrid/Commands.EventGrid/help/New-AzureRmEventGridTopicKey.md ---- - -# New-AzureRmEventGridTopicKey - -## SYNOPSIS -Regenerates the shared access key for an Azure Event Grid Topic. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### TopicNameParameterSet (Default) -``` -New-AzureRmEventGridTopicKey [-ResourceGroupName] <String> [-TopicName] <String> [-KeyName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### TopicInputObjectParameterSet -``` -New-AzureRmEventGridTopicKey [-KeyName] <String> [-InputObject] <PSTopic> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdEventSubscriptionParameterSet -``` -New-AzureRmEventGridTopicKey [-KeyName] <String> [-ResourceId] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Regenerates the shared access key for an Azure Event Grid Topic. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmEventGridTopicKey -ResourceGroup MyResourceGroupName -TopicName Topic1 -KeyName key1 -``` - -Regenerate the key corresponding to key \'key1'\ of Event Grid topic \`Topic1\` in resource group \`MyResourceGroupName\`. - -### Example 2 -``` -PS C:\> Get-AzureRmEventGridTopic -ResourceGroup MyResourceGroupName -Name Topic1 | New-AzureRmEventGridTopicKey -KeyName "key1" -``` - -Regenerate the key corresponding to key \'key1'\ of Event Grid topic \`Topic1\` in resource group \`MyResourceGroupName\`. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -EventGrid Topic object. - -```yaml -Type: Microsoft.Azure.Commands.EventGrid.Models.PSTopic -Parameter Sets: TopicInputObjectParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -KeyName -The name of the key that needs to be regenerated - -```yaml -Type: System.String -Parameter Sets: TopicNameParameterSet, ResourceIdEventSubscriptionParameterSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: TopicInputObjectParameterSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource group name. - -```yaml -Type: System.String -Parameter Sets: TopicNameParameterSet -Aliases: ResourceGroup - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Resource Identifier representing the Event Grid Topic. - -```yaml -Type: System.String -Parameter Sets: ResourceIdEventSubscriptionParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TopicName -The name of the topic. - -```yaml -Type: System.String -Parameter Sets: TopicNameParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.EventGrid.Models.PSTopic -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Management.EventGrid.Models.TopicSharedAccessKeys - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.EventGrid/Remove-AzureRmEventGridSubscription.md b/azurermps-6.13.0/AzureRM.EventGrid/Remove-AzureRmEventGridSubscription.md deleted file mode 100644 index b23c66e77e..0000000000 --- a/azurermps-6.13.0/AzureRM.EventGrid/Remove-AzureRmEventGridSubscription.md +++ /dev/null @@ -1,262 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventGrid.dll-Help.xml -Module Name: AzureRM.EventGrid -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventgrid/remove-azurermeventgridsubscription -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventGrid/Commands.EventGrid/help/Remove-AzureRmEventGridSubscription.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventGrid/Commands.EventGrid/help/Remove-AzureRmEventGridSubscription.md ---- - -# Remove-AzureRmEventGridSubscription - -## SYNOPSIS -Removes an Azure Event Grid event subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceGroupNameParameterSet (Default) -``` -Remove-AzureRmEventGridSubscription [-EventSubscriptionName] <String> [[-ResourceGroupName] <String>] - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdEventSubscriptionParameterSet -``` -Remove-AzureRmEventGridSubscription [-ResourceId] <String> [-EventSubscriptionName] <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### EventSubscriptionInputObjectSet -``` -Remove-AzureRmEventGridSubscription [-InputObject] <PSTopic> [-EventSubscriptionName] <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### TopicNameParameterSet -``` -Remove-AzureRmEventGridSubscription [-EventSubscriptionName] <String> [-ResourceGroupName] <String> - [-TopicName] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Removes an Azure Event Grid event subscription for an Azure Event Grid topic, a resource, an Azure subscription or resource group. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmEventGridSubscription -ResourceGroup MyResourceGroup -TopicName Topic1 -EventSubscriptionName EventSubscription1 -``` - -Removes the event subscription \`EventSubscription1\` to an Azure Event Grid topic \`Topic1\` in resource group \`MyResourceGroupName\`. - -### Example 2 -``` -PS C:\> Remove-AzureRmEventGridSubscription -ResourceGroupName MyResourceGroupName -EventSubscriptionName EventSubscription1 -``` - -Removes the event subscription \`EventSubscription1\` to a resource group \`MyResourceGroupName\`. - -### Example 3 -``` -PS C:\> Remove-AzureRmEventGridSubscription -EventSubscriptionName EventSubscription1 -``` - -Removes the event subscription \`EventSubscription1\` to the default Azure subscription. - -### Example 4 -``` -PS C:\> Get-AzureRmResource -ResourceId "/subscriptions/$subscriptionId/resourceGroups/$resourceGroupName/providers/Microsoft.EventHub/namespaces/$namespaceName" | Remove-AzureRmEventGridSubscription -EventSubscriptionName EventSubscription1 -``` - -Removes the event subscription \`EventSubscription1\` to an Event Hub namespace. - -### Example 5 -``` -PS C:\> Get-AzureRmEventGridTopic -ResourceGroup MyResourceGroup -TopicName Topic1 | Remove-AzureRmEventGridSubscription -EventSubscriptionName EventSubscription1 -``` - -Removes the event subscription \`EventSubscription1\` to an Event Grid Topic. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventSubscriptionName -Name of the event subscription that needs to be removed. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, TopicNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: EventSubscriptionInputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -EventGrid EventSubscription object. - -```yaml -Type: Microsoft.Azure.Commands.EventGrid.Models.PSTopic -Parameter Sets: EventSubscriptionInputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns the status of the Remove operation. By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupNameParameterSet -Aliases: ResourceGroup - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: TopicNameParameterSet -Aliases: ResourceGroup - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Identifier of the resource whose event subscription needs to be removed. - -```yaml -Type: System.String -Parameter Sets: ResourceIdEventSubscriptionParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TopicName -Event Grid Topic Name. - -```yaml -Type: System.String -Parameter Sets: TopicNameParameterSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.EventGrid.Models.PSTopic -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.EventGrid/Remove-AzureRmEventGridTopic.md b/azurermps-6.13.0/AzureRM.EventGrid/Remove-AzureRmEventGridTopic.md deleted file mode 100644 index e667339ba2..0000000000 --- a/azurermps-6.13.0/AzureRM.EventGrid/Remove-AzureRmEventGridTopic.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventGrid.dll-Help.xml -Module Name: AzureRM.EventGrid -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventgrid/remove-azurermeventgridtopic -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventGrid/Commands.EventGrid/help/Remove-AzureRmEventGridTopic.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventGrid/Commands.EventGrid/help/Remove-AzureRmEventGridTopic.md ---- - -# Remove-AzureRmEventGridTopic - -## SYNOPSIS -Removes an Azure Event Grid Topic. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### TopicNameParameterSet (Default) -``` -Remove-AzureRmEventGridTopic [-ResourceGroupName] <String> [-Name] <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdEventSubscriptionParameterSet -``` -Remove-AzureRmEventGridTopic [-ResourceId] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### TopicInputObjectParameterSet -``` -Remove-AzureRmEventGridTopic [-InputObject] <PSTopic> [-PassThru] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Removes an Azure Event Grid Topic. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmEventGridTopic -ResourceGroupName MyResourceGroupName -Name Topic1 -``` - -Removes the Event Grid topic \`Topic1\` in resource group \`MyResourceGroupName\`. - -### Example 2 -``` -PS C:\> Get-AzureRmResource -ResourceId "/subscriptions/$subscriptionId/resourceGroups/MyResourceGroupName/providers/Microsoft.EventGrid/topics/Topic1" | Remove-AzureRmEventGridTopic -``` - -Removes the Event Grid topic \`Topic1\` in resource group \`MyResourceGroupName\`. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -EventGrid Topic object. - -```yaml -Type: Microsoft.Azure.Commands.EventGrid.Models.PSTopic -Parameter Sets: TopicInputObjectParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -EventGrid Topic Name. - -```yaml -Type: System.String -Parameter Sets: TopicNameParameterSet -Aliases: TopicName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns the status of the Remove operation. By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: TopicNameParameterSet -Aliases: ResourceGroup - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -EventGrid Topic ResourceID. - -```yaml -Type: System.String -Parameter Sets: ResourceIdEventSubscriptionParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.EventGrid.Models.PSTopic -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.EventGrid/Set-AzureRmEventGridTopic.md b/azurermps-6.13.0/AzureRM.EventGrid/Set-AzureRmEventGridTopic.md deleted file mode 100644 index 71a648e918..0000000000 --- a/azurermps-6.13.0/AzureRM.EventGrid/Set-AzureRmEventGridTopic.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventGrid.dll-Help.xml -Module Name: AzureRM.EventGrid -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventgrid/set-azurermeventgridtopic -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventGrid/Commands.EventGrid/help/Set-AzureRmEventGridTopic.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventGrid/Commands.EventGrid/help/Set-AzureRmEventGridTopic.md ---- - -# Set-AzureRmEventGridTopic - -## SYNOPSIS -Sets the properties of an Event Grid topic. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### TopicNameParameterSet (Default) -``` -Set-AzureRmEventGridTopic [-ResourceGroupName] <String> [-Name] <String> [-Tag] <Hashtable> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdEventSubscriptionParameterSet -``` -Set-AzureRmEventGridTopic [-ResourceId] <String> [-Tag] <Hashtable> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### TopicInputObjectParameterSet -``` -Set-AzureRmEventGridTopic [-InputObject] <PSTopic> [-Tag] <Hashtable> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Sets the properties of an Event Grid topic. This can be used to replace the tags of an Event Grid topic. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Set-AzureRmEventGridTopic -ResourceGroup MyResourceGroupName -Name Topic1 -Tag @{ Department="Finance"; Environment="Test" } -``` - -Sets the properties of the Event Grid topic \`Topic1\` in resource group \`MyResourceGroupName\` to replace the tags with the specified tags "Department" and "Environment". - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -EventGrid Topic object. - -```yaml -Type: Microsoft.Azure.Commands.EventGrid.Models.PSTopic -Parameter Sets: TopicInputObjectParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -EventGrid Topic Name. - -```yaml -Type: System.String -Parameter Sets: TopicNameParameterSet -Aliases: TopicName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: TopicNameParameterSet -Aliases: ResourceGroup - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -EventGrid Topic ResourceID. - -```yaml -Type: System.String -Parameter Sets: ResourceIdEventSubscriptionParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Hashtables which represents resource Tag. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: TopicNameParameterSet, ResourceIdEventSubscriptionParameterSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: TopicInputObjectParameterSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.EventGrid.Models.PSTopic -Parameters: InputObject (ByValue) - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.EventGrid.Models.PSTopic - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.EventGrid/Update-AzureRmEventGridSubscription.md b/azurermps-6.13.0/AzureRM.EventGrid/Update-AzureRmEventGridSubscription.md deleted file mode 100644 index 83b548e609..0000000000 --- a/azurermps-6.13.0/AzureRM.EventGrid/Update-AzureRmEventGridSubscription.md +++ /dev/null @@ -1,330 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventGrid.dll-Help.xml -Module Name: AzureRM.EventGrid -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventgrid/update-azurermeventgridsubscription -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventGrid/Commands.EventGrid/help/Update-AzureRmEventGridSubscription.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventGrid/Commands.EventGrid/help/Update-AzureRmEventGridSubscription.md ---- - -# Update-AzureRmEventGridSubscription - -## SYNOPSIS -Update the properties of an Event Grid event subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceGroupNameParameterSet (Default) -``` -Update-AzureRmEventGridSubscription [-EventSubscriptionName] <String> [[-ResourceGroupName] <String>] - [-EndpointType <String>] [-Endpoint <String>] [-SubjectBeginsWith <String>] [-SubjectEndsWith <String>] - [-IncludedEventType <String[]>] [-Label <String[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ResourceIdEventSubscriptionParameterSet -``` -Update-AzureRmEventGridSubscription [-ResourceId] <String> [-EventSubscriptionName] <String> - [-EndpointType <String>] [-Endpoint <String>] [-SubjectBeginsWith <String>] [-SubjectEndsWith <String>] - [-IncludedEventType <String[]>] [-Label <String[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### EventSubscriptionInputObjectSet -``` -Update-AzureRmEventGridSubscription [-InputObject] <PSEventSubscription> [-EndpointType <String>] - [-Endpoint <String>] [-SubjectBeginsWith <String>] [-SubjectEndsWith <String>] [-IncludedEventType <String[]>] - [-Label <String[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### CustomTopicEventSubscriptionParameterSet -``` -Update-AzureRmEventGridSubscription [-EventSubscriptionName] <String> [-ResourceGroupName] <String> - [-TopicName] <String> [-EndpointType <String>] [-Endpoint <String>] [-SubjectBeginsWith <String>] - [-SubjectEndsWith <String>] [-IncludedEventType <String[]>] [-Label <String[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Update the properties of an Event Grid event subscription. This can be used to update the filter, destination, or labels of an existing event subscription. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Update-AzureRmEventGridSubscription -EventSubscriptionName ES1 -TopicName Topic1 -ResourceGroup MyResourceGroupName -Endpoint https://requestb.in/1kxxoui1 -``` - -Updates the endpoint of the event subscription \`ES1\` for topic \`Topic1\` in resource group \`MyResourceGroupName\` to \`https://requestb.in/1kxxoui1\` - -### Example 2 -``` -PS C:\> Get-AzureRmEventGridSubscription -EventSubscriptionName ES1 -TopicName Topic1 -ResourceGroup MyResourceGroupName | Update-AzureRmEventGridSubscription -Endpoint https://requestb.in/1kxxoui1 -``` - -Updates the endpoint of the event subscription \`ES1\` for topic \`Topic1\` in resource group \`MyResourceGroupName\` to \`https://requestb.in/1kxxoui1\` - -### Example 3 -``` -PS C:\> Update-AzureRmEventGridSubscription -EventSubscriptionName ES1 -ResourceId "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace" -Endpoint https://requestb.in/1kxxoui1 -SubjectEndsWith "jpg" -``` - -Updates the properties of the event subscription \`ES1\` for the EventHub namespace ContosoNamespace with the new endpoint as \`https://requestb.in/1kxxoui1\` and the new SubjectEndsWith filter as \`jpg\` - -### Example 4 -``` -PS C:\> $labels = "Finance", "HR" -PS C:\> Update-AzureRmEventGridSubscription -EventSubscriptionName ES1 -ResourceGroup MyResourceGroupName -Label $labels -``` - -Updates the properties of the event subscription \`ES1\` for the resource group \`MyResourceGroupName\` with the new labels $labels. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Endpoint -Event subscription destination endpoint. -This can be a webhook URL or the Azure resource ID of an EventHub. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndpointType -Endpoint Type. -This can be webhook or eventhub - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: webhook, eventhub - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventSubscriptionName -The name of the event subscription - -```yaml -Type: System.String -Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IncludedEventType -Filter that specifies a list of event types to include.If not specified, all event types will be included. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -EventGridSubscription object. - -```yaml -Type: Microsoft.Azure.Commands.EventGrid.Models.PSEventSubscription -Parameter Sets: EventSubscriptionInputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Label -Labels for the event subscription - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group of the topic. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupNameParameterSet -Aliases: ResourceGroup - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: CustomTopicEventSubscriptionParameterSet -Aliases: ResourceGroup - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The identifier of the resource to which the event subscription was created. - -```yaml -Type: System.String -Parameter Sets: ResourceIdEventSubscriptionParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubjectBeginsWith -Filter that specifies that only events matching the specified subject prefix will be included. -If not specified, events with all subject prefixes will be included. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubjectEndsWith -Filter that specifies that only events matching the specified subject suffix will be included. -If not specified, events with all subject suffixes will be included. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TopicName -The name of the topic to which the event subscription should be created. - -```yaml -Type: System.String -Parameter Sets: CustomTopicEventSubscriptionParameterSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.EventGrid.Models.PSEventSubscription -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.EventGrid.Models.PSEventSubscription - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.EventHub/AzureRM.EventHub.md b/azurermps-6.13.0/AzureRM.EventHub/AzureRM.EventHub.md deleted file mode 100644 index d7a1f11e53..0000000000 --- a/azurermps-6.13.0/AzureRM.EventHub/AzureRM.EventHub.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -Module Name: AzureRM.EventHub -Module Guid: 5728d353-7ad5-42d8-b00a-46aaecf07b91 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventhub -Help Version: 4.0.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/AzureRM.EventHub.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/AzureRM.EventHub.md ---- - -# AzureRM.EventHub Module -## Description -This topic displays help for the Azure Event Hub PowerShell resource manager cmdlets. - -## AzureRM.EventHub Cmdlets -### [Get-AzureRmEventHub](Get-AzureRmEventHub.md) -Gets the details of a single Event Hub, or gets a list of Event Hubs. - -### [Get-AzureRmEventHubAuthorizationRule](Get-AzureRmEventHubAuthorizationRule.md) -Gets the details of an authorization rule, or gets a list of authorization rules. - -### [Get-AzureRmEventHubConsumerGroup](Get-AzureRmEventHubConsumerGroup.md) -Gets the details of a specified Event Hubs consumer group, or gets a list of consumer groups in an Event Hub. - -### [Get-AzureRmEventHubGeoDRConfiguration](Get-AzureRmEventHubGeoDRConfiguration.md) -Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace - -### [Get-AzureRmEventHubKey](Get-AzureRmEventHubKey.md) -Gets the primary key details of the specified Event Hubs authorization rule. - -### [Get-AzureRmEventHubNamespace](Get-AzureRmEventHubNamespace.md) -Gets the details of an Event Hubs namespace, or gets a list of all Event Hubs namespaces in the current Azure subscription. - -### [New-AzureRmEventHub](New-AzureRmEventHub.md) -Creates a new Event Hub. - -### [New-AzureRmEventHubAuthorizationRule](New-AzureRmEventHubAuthorizationRule.md) -Creates a new Event Hubs authorization rule for namespace or eventhub. - -### [New-AzureRmEventHubConsumerGroup](New-AzureRmEventHubConsumerGroup.md) -Creates a new consumer group for the specified Event Hub. - -### [New-AzureRmEventHubGeoDRConfiguration](New-AzureRmEventHubGeoDRConfiguration.md) -Creates an new Alias(Disaster Recovery configuration) - -### [New-AzureRmEventHubKey](New-AzureRmEventHubKey.md) -Creates a new primary or secondary key for the specified Event Hubs authorization rule. - -### [New-AzureRmEventHubNamespace](New-AzureRmEventHubNamespace.md) -Creates an Event Hubs namespace. - -### [Remove-AzureRmEventHub](Remove-AzureRmEventHub.md) -Removes the specified Event Hub. - -### [Remove-AzureRmEventHubAuthorizationRule](Remove-AzureRmEventHubAuthorizationRule.md) -Removes the specified Event Hub authorization rule. - -### [Remove-AzureRmEventHubConsumerGroup](Remove-AzureRmEventHubConsumerGroup.md) -Deletes the specified Event Hubs consumer group. - -### [Remove-AzureRmEventHubGeoDRConfiguration](Remove-AzureRmEventHubGeoDRConfiguration.md) -Deletes an Alias(Disaster Recovery configuration) - -### [Remove-AzureRmEventHubNamespace](Remove-AzureRmEventHubNamespace.md) -Removes the specified Event Hubs namespace. - -### [Set-AzureRmEventHub](Set-AzureRmEventHub.md) -Updates the specified Event Hub. - -### [Set-AzureRmEventHubAuthorizationRule](Set-AzureRmEventHubAuthorizationRule.md) -Updates the specified authorization rule on an Event Hub. - -### [Set-AzureRmEventHubConsumerGroup](Set-AzureRmEventHubConsumerGroup.md) -Updates the specified Event Hubs consumer group. - -### [Set-AzureRmEventHubGeoDRConfigurationBreakPair](Set-AzureRmEventHubGeoDRConfigurationBreakPair.md) -This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces - -### [Set-AzureRmEventHubGeoDRConfigurationFailOver](Set-AzureRmEventHubGeoDRConfigurationFailOver.md) -Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace - -### [Set-AzureRmEventHubNamespace](Set-AzureRmEventHubNamespace.md) -Updates the specified Event Hubs namespace. - -### [Test-AzureRmEventHubName](Test-AzureRmEventHubName.md) -Checks the Availability of the given NameSpace Name or Alias (DR Configuration Name) - diff --git a/azurermps-6.13.0/AzureRM.EventHub/Get-AzureRmEventHub.md b/azurermps-6.13.0/AzureRM.EventHub/Get-AzureRmEventHub.md deleted file mode 100644 index 551bffe072..0000000000 --- a/azurermps-6.13.0/AzureRM.EventHub/Get-AzureRmEventHub.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventHub.dll-Help.xml -Module Name: AzureRM.EventHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventhub/get-azurermeventhub -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Get-AzureRmEventHub.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Get-AzureRmEventHub.md ---- - -# Get-AzureRmEventHub - -## SYNOPSIS -Gets the details of a single Event Hub, or gets a list of Event Hubs. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmEventHub [-ResourceGroupName] <String> [-Namespace] <String> [[-Name] <String>] [-MaxCount <Int32>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmEventHub cmdlet returns either the details of an Event Hub, or a list of all Event Hubs in the current namespace. -If the Event Hub name is provided, the details of a single Event Hub are returned. -If an Event Hub name is not provided, a list of all Event Hubs in the specified namespace is returned. - -## EXAMPLES - -### Example 1 - specified EventHub -``` -PS C:\> Get-AzureRmEventHub -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -EventHubName MyEventHubName -``` - -Returns the details of the Event Hub \`MyEventHubName\`. - -### Example 2 - List of EventHub in specified Namespace -``` -PS C:\> Get-AzureRmEventHub -ResourceGroup MyResourceGroupName -NamespaceName MyNamespaceName -``` - -Returns a list of Event Hubs in the namespace \`MyNamespaceName\`. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxCount -Determine the maximum number of EventHubs to return. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -EventHub Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: EventHubName - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.EventHub.Models.PSEventHubAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.EventHub/Get-AzureRmEventHubAuthorizationRule.md b/azurermps-6.13.0/AzureRM.EventHub/Get-AzureRmEventHubAuthorizationRule.md deleted file mode 100644 index 3acdca561a..0000000000 --- a/azurermps-6.13.0/AzureRM.EventHub/Get-AzureRmEventHubAuthorizationRule.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventHub.dll-Help.xml -Module Name: AzureRM.EventHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventhub/get-azurermeventhubauthorizationrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Get-AzureRmEventHubAuthorizationRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Get-AzureRmEventHubAuthorizationRule.md ---- - -# Get-AzureRmEventHubAuthorizationRule - -## SYNOPSIS -Gets the details of an authorization rule, or gets a list of authorization rules. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NamespaceAuthorizationRuleSet (Default) -``` -Get-AzureRmEventHubAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### EventhubAuthorizationRuleSet -``` -Get-AzureRmEventHubAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [-Eventhub] <String> - [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### AliasAuthoRuleSet -``` -Get-AzureRmEventHubAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [-AliasName] <String> - [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmEventHubAuthorizationRule cmdlet gets either the details of an authorization rule, or a list of all authorization rules for a specified Event Hub. -If the name of an authorization rule is provided, the details of that single authorization rule are returned. -If the name of an authorization rule is not provided, a list of all authorization rules for the specified Event Hub is returned. -If (Disaster Recovery) Alias name provided, the details of authorization rule of the Namespace for Alias configured is returned. - -## EXAMPLES - -### Example 1.0 - AuthorizationRule for namespace -``` -PS C:\> Get-AzureRmEventHubAuthorizationRule -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -Name MyAuthRuleName -``` - -Gets the authorization rule \`MyAuthRuleName\` in the namespace \`MyNamespaceName\`. - -### Example 1.1 - AuthorizationRules for namespace -``` -PS C:\> Get-AzureRmEventHubAuthorizationRule -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -EventHubName MyEventHubName -``` - -Gets a list of all authorization rules in the namespace \`MyNamespaceName\`. - -### Example 2.0 - AuthorizationRule for EventHub -``` -PS C:\> Get-AzureRmEventHubAuthorizationRule -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -EventHubName MyEventHubName -Name MyAuthRuleName -``` - -Gets the authorization rule \`MyAuthRuleName\` in the Event Hub \`MyEventHubName\`, which is scoped by the namespace \`MyNamespaceName\`. - -### Example 2.1 - AuthorizationRules for EventHub -``` -PS C:\> Get-AzureRmEventHubAuthorizationRule -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -EventHubName MyEventHubName -``` - -Gets list authorization rules in the Event Hub \`MyEventHubName\`, which is scoped by the namespace \`MyNamespaceName\`. - -### Example 3.0 - AuthorizationRule for Alias (GeoRecovery Configuration) -``` -PS C:\> Get-AzureRmEventHubAuthorizationRule -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -AliasName MyAliasNameName -Name MyAuthRuleName -``` - -Gets the authorization rule \`MyAuthRuleName\` in the namespace \`MyNamespaceName\`. - -### Example 3.1 -AuthorizationRules for Alias (GeoRecovery Configuration) -``` -PS C:\> Get-AzureRmEventHubAuthorizationRule -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -AliasName MyAliasNameName -``` - -Gets a list of all authorization rule \`MyAuthRuleName\` in the namespace \`MyNamespaceName\`. - -## PARAMETERS - -### -AliasName -Alias Name - -```yaml -Type: System.String -Parameter Sets: AliasAuthoRuleSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Eventhub -Eventhub Name - -```yaml -Type: System.String -Parameter Sets: EventhubAuthorizationRuleSet -Aliases: EventHubName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -AuthorizationRule Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AuthorizationRuleName - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.EventHub.Models.PSSharedAccessAuthorizationRuleAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.EventHub/Get-AzureRmEventHubConsumerGroup.md b/azurermps-6.13.0/AzureRM.EventHub/Get-AzureRmEventHubConsumerGroup.md deleted file mode 100644 index 3311063117..0000000000 --- a/azurermps-6.13.0/AzureRM.EventHub/Get-AzureRmEventHubConsumerGroup.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventHub.dll-Help.xml -Module Name: AzureRM.EventHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventhub/get-azurermeventhubconsumergroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Get-AzureRmEventHubConsumerGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Get-AzureRmEventHubConsumerGroup.md ---- - -# Get-AzureRmEventHubConsumerGroup - -## SYNOPSIS -Gets the details of a specified Event Hubs consumer group, or gets a list of consumer groups in an Event Hub. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmEventHubConsumerGroup [-ResourceGroupName] <String> [-Namespace] <String> [-EventHub] <String> - [[-Name] <String>] [-MaxCount <Int32>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmEventHubConsumerGroup cmdlet gets either the details of a specified Event Hubs consumer group, or a list of consumer groups in a given Event Hub. -If the name of a consumer group is provided, the details of a single consumer group details are returned. -If the name of a consumer group is not provided, a list of consumer groups in the specified Event Hub is returned. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmEventHubConsumerGroup -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -EventHubName MyEventHubName -ConsumerGroupName MyConsumerGroupName -``` - -Gets the consumer group \`MyConsumerGroupName\` in the Event Hub \`MyEventHubName\`, which exists in the namespace \`MyNamespaceName\` with resource group \`MyResourceGroupName\`. - -### Example 2 -``` -PS C:\> Get-AzureRmEventHubConsumerGroup -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -EventHubName MyEventHubName -``` - -Gets a list of consumer groups in the Event Hub \`MyEventHubName\`, which exists in the namespace \`MyNamespaceName\` with resource group \`MyResourceGroupName\`. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventHub -EventHub Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: EventHubName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaxCount -Determine the maximum number of ConsumerGroups to return. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -ConsumerGroup Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ConsumerGroupName - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.EventHub.Models.PSConsumerGroupAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.EventHub/Get-AzureRmEventHubGeoDRConfiguration.md b/azurermps-6.13.0/AzureRM.EventHub/Get-AzureRmEventHubGeoDRConfiguration.md deleted file mode 100644 index 390e32eda8..0000000000 --- a/azurermps-6.13.0/AzureRM.EventHub/Get-AzureRmEventHubGeoDRConfiguration.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventHub.dll-Help.xml -Module Name: AzureRM.EventHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventhub/get-azurermeventhubGeodrconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Get-AzureRmEventHubGeoDRConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Get-AzureRmEventHubGeoDRConfiguration.md ---- - -# Get-AzureRmEventHubGeoDRConfiguration - -## SYNOPSIS -Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GeoDRParameterSet (Default) -``` -Get-AzureRmEventHubGeoDRConfiguration [-ResourceGroupName] <String> [-Namespace] <String> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### NamespaceInputObjectSet -``` -Get-AzureRmEventHubGeoDRConfiguration [-InputObject] <PSNamespaceAttributes> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Get-AzureRmEventHubGeoDRConfiguration [-ResourceId] <String> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmEventHubGeoDRConfiguration** Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmEventHubGeoDRConfiguration -ResourceGroupName "SampleResourceGroup" -Namespace "SampleNamespace_Primary" -Name "SampleDRCongifName" - -Name : SampleDRCongifName -Id : /subscriptions/{SubscriptionId}/resourceGroups/SampleResourceGroup/providers/Microsoft.EventHub/namespaces/SampleNamespace_Primary/disasterRecoveryConfigs/SampleDRCongifName -Type : Microsoft.EventHub/Namespaces/disasterrecoveryconfigs -ProvisioningState : Accepted -PartnerNamespace : SampleNamespace_Secondary -AlternateName : -Role : Primary -PendingReplicationOperationsCount : 0 -``` - -Retrieves alias "SampleDRCongifName" configuration for primary namespace "SampleNamespace_Primary" - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Namespace Object - -```yaml -Type: Microsoft.Azure.Commands.EventHub.Models.PSNamespaceAttributes -Parameter Sets: NamespaceInputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -DR Configuration Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: GeoDRParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: GeoDRParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Namespace Resource Id - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.EventHub.Models.PSNamespaceAttributes -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.EventHub.Models.PSEventHubDRConfigurationAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.EventHub/Get-AzureRmEventHubKey.md b/azurermps-6.13.0/AzureRM.EventHub/Get-AzureRmEventHubKey.md deleted file mode 100644 index 09cce8d74d..0000000000 --- a/azurermps-6.13.0/AzureRM.EventHub/Get-AzureRmEventHubKey.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventHub.dll-Help.xml -Module Name: AzureRM.EventHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventhub/get-azurermeventhubkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Get-AzureRmEventHubKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Get-AzureRmEventHubKey.md ---- - -# Get-AzureRmEventHubKey - -## SYNOPSIS -Gets the primary key details of the specified Event Hubs authorization rule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NamespaceAuthorizationRuleSet (Default) -``` -Get-AzureRmEventHubKey [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### EventhubAuthorizationRuleSet -``` -Get-AzureRmEventHubKey [-ResourceGroupName] <String> [-Namespace] <String> [-EventHub] <String> - [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### AliasAuthoRuleSet -``` -Get-AzureRmEventHubKey [-ResourceGroupName] <String> [-Namespace] <String> [-AliasName] <String> - [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmEventHubKey cmdlet returns Primary and Secondary connectionstrings and keys details of the specified NameSpace/Event Hubs/Alias authorization rule. - -## EXAMPLES - -### Example 1 - Namespace -``` -PS C:\> Get-AzureRmEventHubKey -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -AuthorizationRuleName MyAuthRuleName -``` - -### Example 2 - EventHub -``` -PS C:\> Get-AzureRmEventHubKey -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -EventHubName MyEventHubName -AuthorizationRuleName MyAuthRuleName -``` - -Gets details of Primary and Secondary connectionstrings and keys for the authorization rule \`MyAuthRuleName\`. - -### Example 3 - Alias (GeoRecovery Configuration) -``` -PS C:\> Get-AzureRmEventHubKey -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -EventHubName MyEventHubName -AliasName MyAliasName -Name MyAuthRuleName -``` - -Gets details of Primary, Secondary, AliasPrimary and AliasSecondary connectionstrings and keys for the authorization rule \`MyAuthRuleName\`. - -## PARAMETERS - -### -AliasName -Alias Name - -```yaml -Type: System.String -Parameter Sets: AliasAuthoRuleSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventHub -EventHub Name - -```yaml -Type: System.String -Parameter Sets: EventhubAuthorizationRuleSet -Aliases: EventHubName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -AuthorizationRule Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AuthorizationRuleName - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.EventHub.Models.PSListKeysAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.EventHub/Get-AzureRmEventHubNamespace.md b/azurermps-6.13.0/AzureRM.EventHub/Get-AzureRmEventHubNamespace.md deleted file mode 100644 index 326fd6de0c..0000000000 --- a/azurermps-6.13.0/AzureRM.EventHub/Get-AzureRmEventHubNamespace.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventHub.dll-Help.xml -Module Name: AzureRM.EventHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventhub/get-azurermeventhubnamespace -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Get-AzureRmEventHubNamespace.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Get-AzureRmEventHubNamespace.md ---- - -# Get-AzureRmEventHubNamespace - -## SYNOPSIS -Gets the details of an Event Hubs namespace, or gets a list of all Event Hubs namespaces in the current Azure subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmEventHubNamespace [[-ResourceGroupName] <String>] [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmEventHubNamespace cmdlet gets either the details of a specified Event Hubs namespace, or a list of all Event Hubs namespaces in the current Azure subscription. -If the namespace name is provided, the details of a single Event Hubs namespace is returned. -If the namespace name is not provided, a list of namespaces is returned. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmEventHubNamespace -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -``` - -Gets the details of namespace \`MyNamespaceName\` in the resource group \`MyResourceGroupName\`. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -EventHub Namespace Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.EventHub.Models.PSNamespaceAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.EventHub/New-AzureRmEventHub.md b/azurermps-6.13.0/AzureRM.EventHub/New-AzureRmEventHub.md deleted file mode 100644 index 17c64ef627..0000000000 --- a/azurermps-6.13.0/AzureRM.EventHub/New-AzureRmEventHub.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventHub.dll-Help.xml -Module Name: AzureRM.EventHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventhub/new-azurermeventhub -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/New-AzureRmEventHub.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/New-AzureRmEventHub.md ---- - -# New-AzureRmEventHub - -## SYNOPSIS -Creates a new Event Hub. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### EventhubPropertiesSet (Default) -``` -New-AzureRmEventHub [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - [-MessageRetentionInDays <Int64>] [-PartitionCount <Int64>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### EventhubInputObjectSet -``` -New-AzureRmEventHub [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - [-InputObject <PSEventHubAttributes>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmEventHub cmdlet creates a new Azure Event Hub. -To create Eventhub with Capture description properties, please follow the below steps (Examples 2). - -## EXAMPLES - -### Example 1 - Create new EventHub -``` -PS C:\> New-AzureRmEventHub -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -Name MyEventHubName -``` - -Creates an Event Hub named \`MyEventHubName\` with a 3-day message retention period and two partitions, in the \`WestUS\` location, with resource group \`MyResourceGroupName\`. - -### Example 2 Update Eventhub with 'CaptureDescription' -``` -PS C:\> New-AzureRmEventHub -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -Name MyEventHubName -MessageRetentionInDays 3 -PartitionCount 2 - -PS C:\> $CreatedEventHub = Get-AzureRmEventHub -ResourceGroupName MyResourceGroupName -Namespace MyNamespaceName -Name MyEventHubName - -PS C:\> $createdEventHub.CaptureDescription = New-Object -TypeName Microsoft.Azure.Commands.EventHub.Models.CaptureDescriptionAttributes - -PS C:\> $createdEventHub.CaptureDescription.Enabled = $true -PS C:\> $createdEventHub.CaptureDescription.IntervalInSeconds = 120 -PS C:\> $createdEventHub.CaptureDescription.Encoding = "Avro" -PS C:\> $createdEventHub.CaptureDescription.SizeLimitInBytes = 10485763 -PS C:\> $createdEventHub.CaptureDescription.Destination.Name = "EventHubArchive.AzureBlockBlob" -PS C:\> $createdEventHub.CaptureDescription.Destination.BlobContainer = "container" -PS C:\> $createdEventHub.CaptureDescription.Destination.ArchiveNameFormat = "{Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}" -PS C:\> $createdEventHub.CaptureDescription.Destination.StorageAccountResourceId = "/subscriptions/{SubscriptionId}/resourceGroups/MyResourceGroupName/providers/Microsoft.ClassicStorage/storageAccounts/arjunteststorage" -PS C:\> Set-AzureRmEventHub -ResourceGroupName MyResourceGroupName -Namespace MyNamespaceName -Name MyEventHubName -InputObject MyCreatedEventHub -messageRetentionInDays 4 -partitionCount 2 -``` - -Creates an Event Hub named \`MyEventHubName\` with a 3-day message retention period, 2 partitions and CaptureDescription properties in the \`WestUS\` location, with resource group \`MyResourceGroupName\`. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -EventHub Input object - -```yaml -Type: Microsoft.Azure.Commands.EventHub.Models.PSEventHubAttributes -Parameter Sets: EventhubInputObjectSet -Aliases: EventHubObj - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MessageRetentionInDays -Eventhub Message Retention In Days - -```yaml -Type: System.Nullable`1[System.Int64] -Parameter Sets: EventhubPropertiesSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Eventhub Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: EventHubName - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PartitionCount -Eventhub PartitionCount - -```yaml -Type: System.Nullable`1[System.Int64] -Parameter Sets: EventhubPropertiesSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.EventHub.Models.PSEventHubAttributes - -### System.Nullable`1[[System.Int64, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.EventHub.Models.PSEventHubAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.EventHub/New-AzureRmEventHubAuthorizationRule.md b/azurermps-6.13.0/AzureRM.EventHub/New-AzureRmEventHubAuthorizationRule.md deleted file mode 100644 index 0c8eccd362..0000000000 --- a/azurermps-6.13.0/AzureRM.EventHub/New-AzureRmEventHubAuthorizationRule.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventHub.dll-Help.xml -Module Name: AzureRM.EventHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventhub/new-azurermeventhubauthorizationrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/New-AzureRmEventHubAuthorizationRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/New-AzureRmEventHubAuthorizationRule.md ---- - -# New-AzureRmEventHubAuthorizationRule - -## SYNOPSIS -Creates a new Event Hubs authorization rule for namespace or eventhub. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NamespaceAuthorizationRuleSet (Default) -``` -New-AzureRmEventHubAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - -Rights <String[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### EventhubAuthorizationRuleSet -``` -New-AzureRmEventHubAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [-EventHub] <String> - [-Name] <String> -Rights <String[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmEventHubAuthorizationRule cmdlet creates a new Event Hubs authorization rule. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmEventHubAuthorizationRule -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -AuthorizationRuleName MyAuthRuleName -Rights @("Listen","Send") -``` - -Creates an authorization rule \`MyAuthRuleName\` granting Listen and Send rights to the namespace \`MyNamespaceName\`, with resource group \`MyResourceGroupName\`. - -### Example 2 -``` -PS C:\> New-AzureRmEventHubAuthorizationRule -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -EventHubName MyEventHubName -AuthorizationRuleName MyAuthRuleName -Rights @("Listen","Send") -``` - -Creates an authorization rule \`MyAuthRuleName\` granting Listen and Send rights to the Event Hub \`MyEventHubName\` in namespace \`MyNamespaceName\`, with resource group \`MyResourceGroupName\`. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventHub -EventHub Name - -```yaml -Type: System.String -Parameter Sets: EventhubAuthorizationRuleSet -Aliases: EventHubName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -AuthorizationRule Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AuthorizationRuleName - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Rights -Rights, e.g. -"Listen","Send","Manage" - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: -Accepted values: Listen, Send, Manage - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.String[] - -## OUTPUTS - -### Microsoft.Azure.Commands.EventHub.Models.PSSharedAccessAuthorizationRuleAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.EventHub/New-AzureRmEventHubConsumerGroup.md b/azurermps-6.13.0/AzureRM.EventHub/New-AzureRmEventHubConsumerGroup.md deleted file mode 100644 index fd0be5d874..0000000000 --- a/azurermps-6.13.0/AzureRM.EventHub/New-AzureRmEventHubConsumerGroup.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventHub.dll-Help.xml -Module Name: AzureRM.EventHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventhub/new-azurermeventhubconsumergroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/New-AzureRmEventHubConsumerGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/New-AzureRmEventHubConsumerGroup.md ---- - -# New-AzureRmEventHubConsumerGroup - -## SYNOPSIS -Creates a new consumer group for the specified Event Hub. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmEventHubConsumerGroup [-ResourceGroupName] <String> [-Namespace] <String> [-EventHub] <String> - [-Name] <String> [[-UserMetadata] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Creates a new consumer group for the specified Event Hub. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmEventHubConsumerGroup -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -EventHubName MyEventHubName -ConsumerGroupName MyConsumerGroupName -``` - -Creates the consumer group \`MyConsumerGroupName\` in the Event Hub \`MyEventHubName\`, scoped to the namespace \`MyNamespaceName\`, with resource group \`MyResourceGroupName\`. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventHub -EventHub Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: EventHubName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -ConsumerGroup Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ConsumerGroupName - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserMetadata -User Metadata for ConsumerGroup - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.EventHub.Models.PSConsumerGroupAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.EventHub/New-AzureRmEventHubGeoDRConfiguration.md b/azurermps-6.13.0/AzureRM.EventHub/New-AzureRmEventHubGeoDRConfiguration.md deleted file mode 100644 index 09cb1a3bb0..0000000000 --- a/azurermps-6.13.0/AzureRM.EventHub/New-AzureRmEventHubGeoDRConfiguration.md +++ /dev/null @@ -1,243 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventHub.dll-Help.xml -Module Name: AzureRM.EventHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventhub/new-azurermeventhubGeodrconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/New-AzureRmEventHubGeoDRConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/New-AzureRmEventHubGeoDRConfiguration.md ---- - -# New-AzureRmEventHubGeoDRConfiguration - -## SYNOPSIS -Creates an new Alias(Disaster Recovery configuration) - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GeoDRParameterSet (Default) -``` -New-AzureRmEventHubGeoDRConfiguration [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - [-PartnerNamespace] <String> [-AlternateName <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### NamespaceInputObjectSet -``` -New-AzureRmEventHubGeoDRConfiguration [-InputObject] <PSNamespaceAttributes> [-Name] <String> - [-PartnerNamespace] <String> [-AlternateName <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### NamespaceResourceIdParameterSet -``` -New-AzureRmEventHubGeoDRConfiguration [-ResourceId] <String> [-Name] <String> [-PartnerNamespace] <String> - [-AlternateName <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmEventHubGeoDRConfiguration** cmdlet Creates a new Alias(Disaster Recovery configuration) - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmEventHubGeoDRConfiguration -ResourceGroupName "SampleResourceGroup" -Namespace "SampleNamespace_Primary" -Name "SampleDRCongifName" -PartnerNamespace "SampleNamespace_Secondary" - -Name : SampleDRCongifName -Id : /subscriptions/{SubscriptionId}/resourceGroups/SampleResourceGroup/providers/Microsoft.EventHub/namespaces/SampleNamespace_Primary/disasterRecoveryConfigs/SampleDRCongifName -Type : Microsoft.EventHub/Namespaces/disasterrecoveryconfigs -ProvisioningState : Accepted -PartnerNamespace : SampleNamespace_Secondary -Role : Primary -``` - -Creates an alias "SampleDRCongifName" with primary namespace "SampleNamespace_Primary" with secondary namespace "SampleNamespace_Secondary" - -## PARAMETERS - -### -AlternateName -AlternateName required when DR configuration name is same as Primary Namespace - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Namespace Object - -```yaml -Type: Microsoft.Azure.Commands.EventHub.Models.PSNamespaceAttributes -Parameter Sets: NamespaceInputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -DR Configuration Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: GeoDRParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PartnerNamespace -DR Configuration PartnerNamespace - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: GeoDRParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Namespace Resource Id - -```yaml -Type: System.String -Parameter Sets: NamespaceResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.EventHub.Models.PSNamespaceAttributes -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.EventHub.Models.PSEventHubDRConfigurationAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.EventHub/New-AzureRmEventHubKey.md b/azurermps-6.13.0/AzureRM.EventHub/New-AzureRmEventHubKey.md deleted file mode 100644 index e2b2b4ebbe..0000000000 --- a/azurermps-6.13.0/AzureRM.EventHub/New-AzureRmEventHubKey.md +++ /dev/null @@ -1,216 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventHub.dll-Help.xml -Module Name: AzureRM.EventHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventhub/new-azurermeventhubkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/New-AzureRmEventHubKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/New-AzureRmEventHubKey.md ---- - -# New-AzureRmEventHubKey - -## SYNOPSIS -Creates a new primary or secondary key for the specified Event Hubs authorization rule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NamespaceAuthorizationRuleSet (Default) -``` -New-AzureRmEventHubKey [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - [-RegenerateKey] <String> [[-KeyValue] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### EventhubAuthorizationRuleSet -``` -New-AzureRmEventHubKey [-ResourceGroupName] <String> [-Namespace] <String> [-EventHub] <String> - [-Name] <String> [-RegenerateKey] <String> [[-KeyValue] <String>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmEventHubKey cmdlet regenerates the primary or secondary SAS key for the specified Event Hubs authorization rule. - -## EXAMPLES - -### Example 1.1 - Namespace - AuthorizationRule PrimaryKey -``` -PS C:\> New-AzureRmEventHubKey -ResourceGroup MyResourceGroupName -Namespace MyNamespaceName -Name MyAuthRuleName -RegenerateKey PrimaryKey -``` - -Regenerates the primary key for the authorization rule \`MyAuthRuleName\`. - -### Example 1.2 - EventHub - AuthorizationRule PrimaryKey -``` -PS C:\> New-AzureRmEventHubKey -ResourceGroup MyResourceGroupName -Namespace MyNamespaceName -EventHub MyEventHubName -Name MyAuthRuleName -RegenerateKey PrimaryKey -``` - -Regenerates the primary key for the authorization rule \`MyAuthRuleName\`. - -### Example 2.1 - Namespace - AuthorizationRule SecondaryKey -``` -PS C:\> New-AzureRmEventHubKey -ResourceGroup MyResourceGroupName -Namespace MyNamespaceName -Name MyAuthRuleName -RegenerateKey SecondaryKey -``` - -### Example 2.2 - EventHub - AuthorizationRule SecondaryKey -``` -PS C:\> New-AzureRmEventHubKey -ResourceGroup MyResourceGroupName -Namespace MyNamespaceName -EventHub MyEventHubName -Name MyAuthRuleName -RegenerateKey SecondaryKey -``` - -Regenerates the secondary key for the authorization rule \`MyAuthRuleName\`. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventHub -EventHub Name - -```yaml -Type: System.String -Parameter Sets: EventhubAuthorizationRuleSet -Aliases: EventHubName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyValue -A base64-encoded 256-bit key for signing and validating the SAS token. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -AuthorizationRule Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AuthorizationRuleName - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RegenerateKey -Regenerate Keys - 'PrimaryKey'/'SecondaryKey' - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: PrimaryKey, SecondaryKey - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.EventHub.Models.PSListKeysAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.EventHub/New-AzureRmEventHubNamespace.md b/azurermps-6.13.0/AzureRM.EventHub/New-AzureRmEventHubNamespace.md deleted file mode 100644 index 801d24cf84..0000000000 --- a/azurermps-6.13.0/AzureRM.EventHub/New-AzureRmEventHubNamespace.md +++ /dev/null @@ -1,258 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventHub.dll-Help.xml -Module Name: AzureRM.EventHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventhub/new-azurermeventhubnamespace -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/New-AzureRmEventHubNamespace.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/New-AzureRmEventHubNamespace.md ---- - -# New-AzureRmEventHubNamespace - -## SYNOPSIS -Creates an Event Hubs namespace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NamespaceParameterSet (Default) -``` -New-AzureRmEventHubNamespace [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> - [[-SkuName] <String>] [[-SkuCapacity] <Int32>] [[-Tag] <Hashtable>] [-EnableKafka] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### AutoInflateParameterSet -``` -New-AzureRmEventHubNamespace [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> - [[-SkuName] <String>] [[-SkuCapacity] <Int32>] [[-Tag] <Hashtable>] [-EnableAutoInflate] - [[-MaximumThroughputUnits] <Int32>] [-EnableKafka] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmEventHubNamespace cmdlet creates a new namespace of type Event Hubs. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmEventHubNamespace -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -Location MyLocation -``` - -Creates an Event Hubs namespace \`MyNamespaceName\` in the specified geographic location \`MyLocation\`, in resource group \`MyResourceGroupName\`. - -### Example 2 -``` -PS C:\> New-AzureRmEventHubNamespace -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -Location MyLocation -EnableAutoInflate -MaximumThroughputUnits 10 -``` - -Creates an Event Hubs namespace \`MyNamespaceName\` in the specified geographic location \`MyLocation\`, in resource group \`MyResourceGroupName\` and AutoInflate is enabled with MaximumThroughputUnits 10. - -### Example 3 - Kafka enabled namespace -``` -PS C:\> New-AzureRmEventHubNamespace -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -Location MyLocation -EnableAutoInflate -EnableKafka -``` - -Creates an Event Hubs namespace \`MyNamespaceName\` in the specified geographic location \`MyLocation\`, in resource group \`MyResourceGroupName\` with Kafka and AutoInflate enabled. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableAutoInflate -Indicates whether AutoInflate is enabled - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: AutoInflateParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableKafka -enabling or disabling Kafka for namespace - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: AutoInflateParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -EventHub Namespace Location. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaximumThroughputUnits -Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: AutoInflateParameterSet -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -EventHub Namespace Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuCapacity -The eventhub throughput units. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuName -Namespace Sku Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Basic, Standard, Premium - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Hashtables which represents resource Tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - - -## OUTPUTS - -### Microsoft.Azure.Commands.EventHub.Models.PSNamespaceAttributes - - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.EventHub/Remove-AzureRmEventHub.md b/azurermps-6.13.0/AzureRM.EventHub/Remove-AzureRmEventHub.md deleted file mode 100644 index 4ca26d9361..0000000000 --- a/azurermps-6.13.0/AzureRM.EventHub/Remove-AzureRmEventHub.md +++ /dev/null @@ -1,240 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventHub.dll-Help.xml -Module Name: AzureRM.EventHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventhub/remove-azurermeventhub -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Remove-AzureRmEventHub.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Remove-AzureRmEventHub.md ---- - -# Remove-AzureRmEventHub - -## SYNOPSIS -Removes the specified Event Hub. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### EventhubDefaultSet (Default) -``` -Remove-AzureRmEventHub [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> [-PassThru] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### EventhubInputObjectSet -``` -Remove-AzureRmEventHub [-InputObject] <PSEventHubAttributes> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### EventhubResourceIdParameterSet -``` -Remove-AzureRmEventHub [-ResourceId] <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmEventHub cmdlet removes and deletes the specified Event Hub from the given namespace. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmEventHub -ResourceGroupName MyResourceGroupName -Namespace MyNamespaceName -Name MyEventHubName -``` - -Removes the Event Hub \`MyEventHubName\`. - -### Example 2.1 - InputObject - Using Variable: -``` -PS C:\> $inputobject = Get-AzureRmEventHub <params> -PS C:\> Remove-AzureRmEventHub -InputObject $inputobject -``` - -### Example 2.2 - InputObject Using Piping: -``` -PS C:\> Get-AzureRmEventHub <params> | Remove-AzureRmEventHub -``` - -### Example 3.1 - ResourceId - Using Variable: -``` -PS C:\> $resourceid = Get-AzureRmEventHub <params> -PS C:\> Remove-AzureRmEventHub -ResourceId $resourceid.Id -``` - -### Example 3.1 - ResourceId - Using string: -``` -PS C:\> Remove-AzureRmEventHub -ResourceId "/subscriptions/xxxx-xxxxx-xxxxxx-xxxxxx/resourceGroups/ResourceGroupName/providers/Microsoft.EventHub/namespaces/NamespaceName/eventhubs/EventHubName" -``` - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Eventhub Object - -```yaml -Type: Microsoft.Azure.Commands.EventHub.Models.PSEventHubAttributes -Parameter Sets: EventhubInputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -EventHub Name - -```yaml -Type: System.String -Parameter Sets: EventhubDefaultSet -Aliases: EventHubName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: EventhubDefaultSet -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Specifying this will return true if the command was successful. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: EventhubDefaultSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Eventhub Resource Id - -```yaml -Type: System.String -Parameter Sets: EventhubResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.EventHub.Models.PSEventHubAttributes -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.EventHub/Remove-AzureRmEventHubAuthorizationRule.md b/azurermps-6.13.0/AzureRM.EventHub/Remove-AzureRmEventHubAuthorizationRule.md deleted file mode 100644 index d74fe9c5c6..0000000000 --- a/azurermps-6.13.0/AzureRM.EventHub/Remove-AzureRmEventHubAuthorizationRule.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventHub.dll-Help.xml -Module Name: AzureRM.EventHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventhub/remove-azurermeventhubauthorizationrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Remove-AzureRmEventHubAuthorizationRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Remove-AzureRmEventHubAuthorizationRule.md ---- - -# Remove-AzureRmEventHubAuthorizationRule - -## SYNOPSIS -Removes the specified Event Hub authorization rule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NamespaceAuthorizationRuleSet (Default) -``` -Remove-AzureRmEventHubAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### EventhubAuthorizationRuleSet -``` -Remove-AzureRmEventHubAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> - [-EventHub] <String> [-Name] <String> [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmEventHubAuthorizationRule cmdlet removes and deletes the specified authorization rule from the given Event Hub. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmEventHubAuthorizationRule -ResourceGroupName MyResourceGroupName -Namespace MyNamespaceName -Name MyAuthRuleName -``` - -Removes the authorization rule \`MyAuthRuleName\` from the Namespace \`MyNamespaceName\`. - -### Example 2 -``` -PS C:\> Remove-AzureRmEventHubAuthorizationRule -ResourceGroupName MyResourceGroupName -Namespace MyNamespaceName -EventHub MyEventHubName -Name MyAuthRuleName -``` - -Removes the authorization rule \`MyAuthRuleName\` from the Event Hub \`MyEventHubName\`. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventHub -EventHub Name - -```yaml -Type: System.String -Parameter Sets: EventhubAuthorizationRuleSet -Aliases: EventHubName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -AuthorizationRule Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AuthorizationRuleName - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.EventHub/Remove-AzureRmEventHubConsumerGroup.md b/azurermps-6.13.0/AzureRM.EventHub/Remove-AzureRmEventHubConsumerGroup.md deleted file mode 100644 index 2f24447892..0000000000 --- a/azurermps-6.13.0/AzureRM.EventHub/Remove-AzureRmEventHubConsumerGroup.md +++ /dev/null @@ -1,256 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventHub.dll-Help.xml -Module Name: AzureRM.EventHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventhub/remove-azurermeventhubconsumergroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Remove-AzureRmEventHubConsumerGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Remove-AzureRmEventHubConsumerGroup.md ---- - -# Remove-AzureRmEventHubConsumerGroup - -## SYNOPSIS -Deletes the specified Event Hubs consumer group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ConsumergroupPropertiesSet (Default) -``` -Remove-AzureRmEventHubConsumerGroup [-ResourceGroupName] <String> [-Namespace] <String> [-EventHub] <String> - [-Name] <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ConsumergroupInputObjectSet -``` -Remove-AzureRmEventHubConsumerGroup [-InputObject] <PSConsumerGroupAttributes> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ConsumergroupResourceIdParameterSet -``` -Remove-AzureRmEventHubConsumerGroup [-ResourceId] <String> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmEventHubConsumerGroup cmdlet removes and deletes the specified consumer group from the given Event Hub. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmEventHubConsumerGroup -ResourceGroupName MyResourceGroupName -Namespace MyNamespaceName -EventHub MyEventHubName -Name MyConsumerGroupName -``` - -Deletes the consumer group \`MyConsumerGroupName\` from the Event Hub \`MyEventHubName\`, scoped to the \`MyNamespaceName\` namespace. - -### Example 2.1 - InputObject - Using Variable -``` -PS C:\> $inputobject = Get-AzureRmEventHubConsumerGroup <params> -PS C:\> Remove-AzureRmEventHubConsumerGroup -InputObject $inputobject -``` - -### Example 2.2 - InputObject - Using Piping -``` -PS C:\> Get-AzureRmEventHubConsumerGroup <params> | Remove-AzureRmEventHubConsumerGroup -``` - -### Example 3.1 - ResourceId Using Vairable -``` -PS C:\> $resourceid = Get-AzureRmEventHubConsumerGroup <params> -PS C:\> Remove-AzureRmEventHubConsumerGroup -ResourceId $resourceid.Id -``` - -### Example 3.2 - ResourceId Using string -``` -PS C:\> Remove-AzureRmEventHubConsumerGroup -ResourceId "/subscriptions/xxx-xxxx-xxxxx-xxxxx/resourceGroups/ResourceGroupName/providers/Microsoft.EventHub/namespaces/NamespaceName/eventhubs/EventHubName/consumergroups/ConsumerGroupName" -``` - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventHub -EventHub Name - -```yaml -Type: System.String -Parameter Sets: ConsumergroupPropertiesSet -Aliases: EventHubName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -ConsumerGroup Object - -```yaml -Type: Microsoft.Azure.Commands.EventHub.Models.PSConsumerGroupAttributes -Parameter Sets: ConsumergroupInputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -ConsumerGroup Name - -```yaml -Type: System.String -Parameter Sets: ConsumergroupPropertiesSet -Aliases: ConsumerGroupName - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: ConsumergroupPropertiesSet -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Specifying this will return true if the command was successful. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: ConsumergroupPropertiesSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -ConsumerGroup Resource Id - -```yaml -Type: System.String -Parameter Sets: ConsumergroupResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.EventHub.Models.PSConsumerGroupAttributes -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.EventHub/Remove-AzureRmEventHubGeoDRConfiguration.md b/azurermps-6.13.0/AzureRM.EventHub/Remove-AzureRmEventHubGeoDRConfiguration.md deleted file mode 100644 index af9c7c033e..0000000000 --- a/azurermps-6.13.0/AzureRM.EventHub/Remove-AzureRmEventHubGeoDRConfiguration.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventHub.dll-Help.xml -Module Name: AzureRM.EventHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventhub/remove-azurermeventhubGeodrconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Remove-AzureRmEventHubGeoDRConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Remove-AzureRmEventHubGeoDRConfiguration.md ---- - -# Remove-AzureRmEventHubGeoDRConfiguration - -## SYNOPSIS -Deletes an Alias(Disaster Recovery configuration) - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GeoDRParameterSet (Default) -``` -Remove-AzureRmEventHubGeoDRConfiguration [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### GeoDRConfigurationInputObjectSet -``` -Remove-AzureRmEventHubGeoDRConfiguration [-InputObject] <PSEventHubDRConfigurationAttributes> [-PassThru] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### GeoDRConfigResourceIdParameterSet -``` -Remove-AzureRmEventHubGeoDRConfiguration [-ResourceId] <String> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmEventHubGeoDRConfiguration** cmdlet deletes an Alias(Disaster Recovery configuration) - -## EXAMPLES - -### Example 1 -``` -PS C:\>Remove-AzureRmEventHubGeoDRConfiguration -ResourceGroupName "SampleResourceGroup" -Namespace "SampleNamespace_Secondary" -Name "SampleDRCongifName" -``` - -Deletes an Alias (Disaster Recovery configuration) - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Eventhub GeoDR Configuration Object - -```yaml -Type: Microsoft.Azure.Commands.EventHub.Models.PSEventHubDRConfigurationAttributes -Parameter Sets: GeoDRConfigurationInputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Alias (GeoDR) - -```yaml -Type: System.String -Parameter Sets: GeoDRParameterSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: GeoDRParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: GeoDRParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -GeoDRConfiguration Resource Id - -```yaml -Type: System.String -Parameter Sets: GeoDRConfigResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.EventHub.Models.PSEventHubDRConfigurationAttributes -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.EventHub/Remove-AzureRmEventHubNamespace.md b/azurermps-6.13.0/AzureRM.EventHub/Remove-AzureRmEventHubNamespace.md deleted file mode 100644 index 5b659f8825..0000000000 --- a/azurermps-6.13.0/AzureRM.EventHub/Remove-AzureRmEventHubNamespace.md +++ /dev/null @@ -1,230 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventHub.dll-Help.xml -Module Name: AzureRM.EventHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventhub/remove-azurermeventhubnamespace -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Remove-AzureRmEventHubNamespace.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Remove-AzureRmEventHubNamespace.md ---- - -# Remove-AzureRmEventHubNamespace - -## SYNOPSIS -Removes the specified Event Hubs namespace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NamespaceParameterSet (Default) -``` -Remove-AzureRmEventHubNamespace [-ResourceGroupName] <String> [-Name] <String> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### NamespaceInputObjectSet -``` -Remove-AzureRmEventHubNamespace [-InputObject] <PSNamespaceAttributes> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### NamespaceResourceIdParameterSet -``` -Remove-AzureRmEventHubNamespace [-ResourceId] <String> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmEventHubNamespace cmdlet removes and deletes the specified Event Hubs namespace. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmEventHubNamespace -ResourceGroupName MyResourceGroupName -Name MyNamespaceName -``` - -Removes the Event Hubs namespace \`MyNamespaceName\` in resource group \`MyResourceGroupName\`. - -### Example 2.1 - InputObject - Using Variable: -``` -PS C:\> $inputObject = Get-AzureRmEventHubNamespace <params> -PS C:\> Remove-AzureRmEventHubNamespace -InputObject $inputObject -``` - -### Example 2.1 - InputObject - Using Piping: -``` -PS C:\> Get-AzureRmEventHubNamespace <params> | Remove-AzureRmEventHubNamespace -``` - -### Example 3.1 - ResourceId - Using Variable -``` -PS C:\> $resourceid = Get-AzureRmEventHubNamespace <params> -PS C:\> Remove-AzureRmEventHubNamespace -ResourceId $resourceid.Id -``` - -### Example 3.2 - ResourceId - Using Piping: -``` -PS C:\> Get-AzureRmResource -ResourceType Microsoft.EventHub/Namespaces | Remove-AzureRmEventHubNamespace -``` - -### Example 3.3 - ResourceId - Using String: -``` -PS C:\> Remove-AzureRmEventHubNamespace -ResourceId "/subscriptions/xxx-xxxxx-xxxxxx-xxxxxx/resourceGroups/ResourceGroupName/providers/Microsoft.EventHub/namespaces/NamespaceName" -``` - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -EventHubs Namespace Object - -```yaml -Type: Microsoft.Azure.Commands.EventHub.Models.PSNamespaceAttributes -Parameter Sets: NamespaceInputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -EventHub Namespace Name - -```yaml -Type: System.String -Parameter Sets: NamespaceParameterSet -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Specifying this will return true if the command was successful. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: NamespaceParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -EventHubs Namespace Resource Id - -```yaml -Type: System.String -Parameter Sets: NamespaceResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.EventHub.Models.PSNamespaceAttributes -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.EventHub/Set-AzureRmEventHub.md b/azurermps-6.13.0/AzureRM.EventHub/Set-AzureRmEventHub.md deleted file mode 100644 index 98b72b30e2..0000000000 --- a/azurermps-6.13.0/AzureRM.EventHub/Set-AzureRmEventHub.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventHub.dll-Help.xml -Module Name: AzureRM.EventHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventhub/set-azurermeventhub -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Set-AzureRmEventHub.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Set-AzureRmEventHub.md ---- - -# Set-AzureRmEventHub - -## SYNOPSIS -Updates the specified Event Hub. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### EventhubInputObjectSet -``` -Set-AzureRmEventHub [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - [-InputObject <PSEventHubAttributes>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### EventhubPropertiesSet -``` -Set-AzureRmEventHub [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - [-messageRetentionInDays <Int64>] [-partitionCount <Int64>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Set-AzureRmEventHub cmdlet updates the properties of the specified Event Hub. - -## EXAMPLES - -### Example 1 -To update Eventhub with Capture description properties, please follow the below steps. - -``` -PS C:\> $CreatedEventHub = Get-AzureRmEventHub -ResourceGroupName MyResourceGroupName -Namespace MyNamespaceName -Name MyEventHubName -PS C:\> $createdEventHub.CaptureDescription = New-Object -TypeName Microsoft.Azure.Commands.EventHub.Models.PSCaptureDescriptionAttributes -PS C:\> $createdEventHub.CaptureDescription.Enabled = $true -PS C:\> $createdEventHub.CaptureDescription.IntervalInSeconds = 120 -PS C:\> $createdEventHub.CaptureDescription.Encoding = "Avro" -PS C:\> $createdEventHub.CaptureDescription.SizeLimitInBytes = 10485763 -PS C:\> $createdEventHub.CaptureDescription.Destination.Name = "EventHubArchive.AzureBlockBlob" -PS C:\> $createdEventHub.CaptureDescription.Destination.BlobContainer = "container" -PS C:\> $createdEventHub.CaptureDescription.Destination.ArchiveNameFormat = "{Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}" -PS C:\> $createdEventHub.CaptureDescription.Destination.StorageAccountResourceId = "/subscriptions/{SubscriptionId}/resourceGroups/MyResourceGroupName/providers/Microsoft.ClassicStorage/storageAccounts/arjunteststorage" -PS C:\> Set-AzureRmEventHub -ResourceGroupName MyResourceGroupName -Namespace MyNamespaceName -Name MyEventHubName -InputObject MyCreatedEventHub -messageRetentionInDays 4 -partitionCount 2 -``` - -Updates the Event Hub \`MyEventHubName\` represented by the \`MyCreatedEventHub\` object, setting the message retention period to 4 days, the number of partitions to 2 and CaptureDescription properties - -### Example 2 -``` -PS C:\> Set-AzureRmEventHub -ResourceGroupName MyResourceGroupName -Namespace MyNamespaceName -Name MyEventHubName -InputObject MyCreatedEventHub -messageRetentionInDays 4 -partitionCount 2 -``` - -Updates the Event Hub \`MyEventHubName\` represented by the \`MyCreatedEventHub\` object, setting the message retention period to 4 days, and the number of partitions to 2. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -EventHub object - -```yaml -Type: Microsoft.Azure.Commands.EventHub.Models.PSEventHubAttributes -Parameter Sets: EventhubInputObjectSet -Aliases: EventHubObj - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -messageRetentionInDays -Eventhub Message Retention In Days - -```yaml -Type: System.Nullable`1[System.Int64] -Parameter Sets: EventhubPropertiesSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Namespace Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: EventHubName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -partitionCount -Eventhub PartitionCount - -```yaml -Type: System.Nullable`1[System.Int64] -Parameter Sets: EventhubPropertiesSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.EventHub.Models.PSEventHubAttributes - -### System.Nullable`1[[System.Int64, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.EventHub.Models.PSEventHubAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.EventHub/Set-AzureRmEventHubAuthorizationRule.md b/azurermps-6.13.0/AzureRM.EventHub/Set-AzureRmEventHubAuthorizationRule.md deleted file mode 100644 index aa08a838e2..0000000000 --- a/azurermps-6.13.0/AzureRM.EventHub/Set-AzureRmEventHubAuthorizationRule.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventHub.dll-Help.xml -Module Name: AzureRM.EventHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventhub/set-azurermeventhubauthorizationrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Set-AzureRmEventHubAuthorizationRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Set-AzureRmEventHubAuthorizationRule.md ---- - -# Set-AzureRmEventHubAuthorizationRule - -## SYNOPSIS -Updates the specified authorization rule on an Event Hub. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NamespaceAuthorizationRuleSet (Default) -``` -Set-AzureRmEventHubAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - [[-InputObject] <PSSharedAccessAuthorizationRuleAttributes>] [[-Rights] <String[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### EventhubAuthorizationRuleSet -``` -Set-AzureRmEventHubAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [-EventHub] <String> - [-Name] <String> [[-InputObject] <PSSharedAccessAuthorizationRuleAttributes>] [[-Rights] <String[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### AuthoRuleInputObjectSet -``` -Set-AzureRmEventHubAuthorizationRule [-ResourceGroupName] <String> [-Name] <String> - [-InputObject] <PSSharedAccessAuthorizationRuleAttributes> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Set-AzureRmEventHubAuthorizationRule cmdlet updates the specified authorization rule on the given Event Hub. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Set-AzureRmEventHubAuthorizationRule -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -EventHubName MyEventHubName -AuthorizationRuleName MyAuthRuleName -Rights @("Manage") -``` - -Updates the authorization rule \`MyAuthRuleName\` to grant Manage rights to the Event Hub \`MyEventHubName\`, scoped by the namespace \`MyNamespaceName\`. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventHub -EventHub Name - -```yaml -Type: System.String -Parameter Sets: EventhubAuthorizationRuleSet -Aliases: EventHubName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -AuthorizationRule Object - -```yaml -Type: Microsoft.Azure.Commands.EventHub.Models.PSSharedAccessAuthorizationRuleAttributes -Parameter Sets: NamespaceAuthorizationRuleSet, EventhubAuthorizationRuleSet -Aliases: AuthRuleObj - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -```yaml -Type: Microsoft.Azure.Commands.EventHub.Models.PSSharedAccessAuthorizationRuleAttributes -Parameter Sets: AuthoRuleInputObjectSet -Aliases: AuthRuleObj - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -AuthorizationRule Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AuthorizationRuleName - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: NamespaceAuthorizationRuleSet, EventhubAuthorizationRuleSet -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Rights -Rights, e.g. -@("Listen","Send","Manage") - -```yaml -Type: System.String[] -Parameter Sets: NamespaceAuthorizationRuleSet, EventhubAuthorizationRuleSet -Aliases: -Accepted values: Listen, Send, Manage - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.EventHub.Models.PSSharedAccessAuthorizationRuleAttributes -Parameters: InputObject (ByValue) - -### System.String[] - -## OUTPUTS - -### Microsoft.Azure.Commands.EventHub.Models.PSSharedAccessAuthorizationRuleAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.EventHub/Set-AzureRmEventHubConsumerGroup.md b/azurermps-6.13.0/AzureRM.EventHub/Set-AzureRmEventHubConsumerGroup.md deleted file mode 100644 index 5eea25c153..0000000000 --- a/azurermps-6.13.0/AzureRM.EventHub/Set-AzureRmEventHubConsumerGroup.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventHub.dll-Help.xml -Module Name: AzureRM.EventHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventhub/set-azurermeventhubconsumergroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Set-AzureRmEventHubConsumerGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Set-AzureRmEventHubConsumerGroup.md ---- - -# Set-AzureRmEventHubConsumerGroup - -## SYNOPSIS -Updates the specified Event Hubs consumer group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmEventHubConsumerGroup [-ResourceGroupName] <String> [-Namespace] <String> [-EventHub] <String> - [-Name] <String> [[-UserMetadata] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The Set-AzureRmEventHubConsumerGroup cmdlet updates the specified Event Hubs consumer group. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Set-AzureRmEventHubConsumerGroup -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -EventHubName MyEventHubName -ConsumerGroupName MyConsumerGroupName -UserMetadata "Testing" -``` - -Sets the user metadata of the consumer group \`MyConsumerGroupName\` to "Testing." - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventHub -EventHub Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: EventHubName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -ConsumerGroup Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ConsumerGroupName - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserMetadata -User Metadata for ConsumerGroup - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.EventHub.Models.PSConsumerGroupAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.EventHub/Set-AzureRmEventHubGeoDRConfigurationBreakPair.md b/azurermps-6.13.0/AzureRM.EventHub/Set-AzureRmEventHubGeoDRConfigurationBreakPair.md deleted file mode 100644 index ffb872aed2..0000000000 --- a/azurermps-6.13.0/AzureRM.EventHub/Set-AzureRmEventHubGeoDRConfigurationBreakPair.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventHub.dll-Help.xml -Module Name: AzureRM.EventHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventhub/set-azurermeventhubgeodrconfigurationbreakpair -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Set-AzureRmEventHubGeoDRConfigurationBreakPair.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Set-AzureRmEventHubGeoDRConfigurationBreakPair.md ---- - -# Set-AzureRmEventHubGeoDRConfigurationBreakPair - -## SYNOPSIS -This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GeoDRParameterSet (Default) -``` -Set-AzureRmEventHubGeoDRConfigurationBreakPair [-ResourceGroupName] <String> [-Namespace] <String> - [-Name] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### GeoDRConfigurationInputObjectSet -``` -Set-AzureRmEventHubGeoDRConfigurationBreakPair [-InputObject] <PSEventHubDRConfigurationAttributes> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### GeoDRConfigResourceIdParameterSet -``` -Set-AzureRmEventHubGeoDRConfigurationBreakPair [-ResourceId] <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmEventHubGeoDRConfigurationBreakPair** cmdlet disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces - -## EXAMPLES - -### Example -``` -PS C:\> Set-AzureRmEventHubGeoDRConfigurationBreakPair -ResourceGroupName "SampleResourceGroup" -Namespace "SampleNamespace_Primary" -Name "SampleDRCongifName" -``` - -This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Eventhub GeoDR Configuration Object - -```yaml -Type: Microsoft.Azure.Commands.EventHub.Models.PSEventHubDRConfigurationAttributes -Parameter Sets: GeoDRConfigurationInputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -DR Configuration Name - -```yaml -Type: System.String -Parameter Sets: GeoDRParameterSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - Primary Namespace - -```yaml -Type: System.String -Parameter Sets: GeoDRParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: GeoDRParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -GeoDRConfiguration Resource Id - -```yaml -Type: System.String -Parameter Sets: GeoDRConfigResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.EventHub.Models.PSEventHubDRConfigurationAttributes -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.EventHub/Set-AzureRmEventHubGeoDRConfigurationFailOver.md b/azurermps-6.13.0/AzureRM.EventHub/Set-AzureRmEventHubGeoDRConfigurationFailOver.md deleted file mode 100644 index a62980ec08..0000000000 --- a/azurermps-6.13.0/AzureRM.EventHub/Set-AzureRmEventHubGeoDRConfigurationFailOver.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventHub.dll-Help.xml -Module Name: AzureRM.EventHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventhub/set-azurermeventhubgeodrconfigurationfailover -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Set-AzureRmEventHubGeoDRConfigurationFailOver.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Set-AzureRmEventHubGeoDRConfigurationFailOver.md ---- - -# Set-AzureRmEventHubGeoDRConfigurationFailOver - -## SYNOPSIS -Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GeoDRParameterSet (Default) -``` -Set-AzureRmEventHubGeoDRConfigurationFailOver [-ResourceGroupName] <String> [-Namespace] <String> - [-Name] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### GeoDRConfigurationInputObjectSet -``` -Set-AzureRmEventHubGeoDRConfigurationFailOver [-InputObject] <PSEventHubDRConfigurationAttributes> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### GeoDRConfigResourceIdParameterSet -``` -Set-AzureRmEventHubGeoDRConfigurationFailOver [-ResourceId] <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmEventHubGeoDRConfigurationFailOver** cmdlet envokes GEO DR failover and reconfigure the alias to point to the secondary namespace - -## EXAMPLES - -### Example 1 -``` -PS C:\>Set-AzureRmEventHubGeoDRConfigurationFailOver -ResourceGroupName "SampleResourceGroup" -Namespace "SampleNamespace_Secondary" -Name "SampleDRCongifName" -``` - -Invokes the Failover over alias "SampleDRCongifName", reconfigures and point to Secondary namespace "SampleNamespace_Secondary" - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Eventhub GeoDR Configuration Object - -```yaml -Type: Microsoft.Azure.Commands.EventHub.Models.PSEventHubDRConfigurationAttributes -Parameter Sets: GeoDRConfigurationInputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -DR Configuration Name - -```yaml -Type: System.String -Parameter Sets: GeoDRParameterSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - Secondary Namespace - -```yaml -Type: System.String -Parameter Sets: GeoDRParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: GeoDRParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -GeoDRConfiguration Resource Id - -```yaml -Type: System.String -Parameter Sets: GeoDRConfigResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.EventHub.Models.PSEventHubDRConfigurationAttributes -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.EventHub/Set-AzureRmEventHubNamespace.md b/azurermps-6.13.0/AzureRM.EventHub/Set-AzureRmEventHubNamespace.md deleted file mode 100644 index 640575cbd8..0000000000 --- a/azurermps-6.13.0/AzureRM.EventHub/Set-AzureRmEventHubNamespace.md +++ /dev/null @@ -1,257 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventHub.dll-Help.xml -Module Name: AzureRM.EventHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventhub/set-azurermeventhubnamespace -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Set-AzureRmEventHubNamespace.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Set-AzureRmEventHubNamespace.md ---- - -# Set-AzureRmEventHubNamespace - -## SYNOPSIS -Updates the specified Event Hubs namespace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NamespaceParameterSet (Default) -``` -Set-AzureRmEventHubNamespace [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> - [[-SkuName] <String>] [[-SkuCapacity] <Int32>] [[-State] <NamespaceState>] [[-Tag] <Hashtable>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### AutoInflateParameterSet -``` -Set-AzureRmEventHubNamespace [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> - [[-SkuName] <String>] [[-SkuCapacity] <Int32>] [[-State] <NamespaceState>] [[-Tag] <Hashtable>] - [-EnableAutoInflate] [-MaximumThroughputUnits <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Set-AzureRmEventHubNamespace cmdlet updates the properties of the specified Event Hubs namespace. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Set-AzureRmEventHubNamespace -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -Location "WestUS" -State Created -``` - -Updates the state of namespace \`MyNamespaceName\` to Created . - -### Example 2 -``` -PS C:\> Set-AzureRmEventHubNamespace -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -Location "WestUS" -State Created -EnableAutoInflate -MaximumThroughputUnits 10 -``` - -Updates the state of namespace \`MyNamespaceName\` with AutoInflate = enabled and MaximumThroughputUnits = 10 - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableAutoInflate -Indicates whether AutoInflate is enabled - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: AutoInflateParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -EventHub Namespace Location. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaximumThroughputUnits -Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: AutoInflateParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -EventHub Namespace Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuCapacity -The eventhub throughput units. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuName -Namespace Sku Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Basic, Standard, Premium - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -Disable/Enable Namespace. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Commands.EventHub.Models.NamespaceState] -Parameter Sets: (All) -Aliases: -Accepted values: Unknown, Active, Disabled - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Hashtables which represents resource Tag. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Nullable`1[[Microsoft.Azure.Commands.EventHub.Models.NamespaceState, Microsoft.Azure.Commands.EventHub, Version=0.6.7.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.EventHub.Models.PSNamespaceAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.EventHub/Test-AzureRmEventHubName.md b/azurermps-6.13.0/AzureRM.EventHub/Test-AzureRmEventHubName.md deleted file mode 100644 index f37bd7b9d4..0000000000 --- a/azurermps-6.13.0/AzureRM.EventHub/Test-AzureRmEventHubName.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.EventHub.dll-Help.xml -Module Name: AzureRM.EventHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.eventhub/test-azurermeventhubname -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Test-AzureRmEventHubName.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/EventHub/Commands.EventHub/help/Test-AzureRmEventHubName.md ---- - -# Test-AzureRmEventHubName - -## SYNOPSIS -Checks the Availability of the given NameSpace Name or Alias (DR Configuration Name) - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NamespaceCheckNameAvailabilitySet (Default) -``` -Test-AzureRmEventHubName [-Namespace] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### AliasCheckNameAvailabilitySet -``` -Test-AzureRmEventHubName [-ResourceGroupName] <String> [-Namespace] <String> [-AliasName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Test-AzureRmEventhubName** Cmdlet Check Availability of the NameSpace Name or Alias (DR Configuration Name) - -## EXAMPLES - -### Example 1 -``` -PS C:\> Test-AzureRmEventhubName -Namespace MyNameSapceName -``` - -Returns the status on availability of the namespace name 'MyNameSapceName' as True if available - -### Example 2 -``` -PS C:\> Test-AzureRmEventhubName -Namespace MyNameSapceName -``` - -Returns the status on availability of the namespace name 'MyNameSapceName' as False with Reason - -### Example 3 -``` -PS C:\> Test-AzureRmEventhubName -ResourceGroupName MyResourceGroup -Namespace Test123 -AliasName myAliasName -``` - -Returns the status on availability of the alias name 'myAliasName' for namespace 'MyNameSapceName' as True if available - -## PARAMETERS - -### -AliasName -DR Configuration Name - Alias Name - -```yaml -Type: System.String -Parameter Sets: AliasCheckNameAvailabilitySet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Namespace -Eventhub Namespace Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: AliasCheckNameAvailabilitySet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.EventHub.Models.PSCheckNameAvailabilityResultAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.FrontDoor/AzureRM.FrontDoor.md b/azurermps-6.13.0/AzureRM.FrontDoor/AzureRM.FrontDoor.md deleted file mode 100644 index b0c279df8d..0000000000 --- a/azurermps-6.13.0/AzureRM.FrontDoor/AzureRM.FrontDoor.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -Module Name: AzureRM.FrontDoor -Module Guid: 91832aaa-dc11-4583-8239-adb7df531604 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.frontdoor -Help Version: 0.1.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/AzureRM.FrontDoor.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/AzureRM.FrontDoor.md ---- - -# AzureRM.FrontDoor Module -## Description -The topics in this section document the Azure PowerShell cmdlets for Azure Front Door Service in the Azure Resource Manager (ARM) framework. The cmdlets exist in the Microsoft.Azure.Commands.FrontDoor namespace. - -## AzureRM.FrontDoor Cmdlets -### [Get-AzureRmFrontDoor](Get-AzureRmFrontDoor.md) -Get Front Door load balancer - -### [Get-AzureRmFrontDoorFireWallPolicy](Get-AzureRmFrontDoorFireWallPolicy.md) -Get WAF policy - -### [New-AzureRmFrontDoor](New-AzureRmFrontDoor.md) -Create a new Azure Front Door load balancer - -### [New-AzureRmFrontDoorBackendObject](New-AzureRmFrontDoorBackendObject.md) -Create a PSBackend object - -### [New-AzureRmFrontDoorBackendPoolObject](New-AzureRmFrontDoorBackendPoolObject.md) -Create a PSBackendPool object for Front Door creation - -### [New-AzureRmFrontDoorCustomRuleObject](New-AzureRmFrontDoorCustomRuleObject.md) -Create CustomRule Object for WAF policy creation - -### [New-AzureRmFrontDoorFireWallPolicy](New-AzureRmFrontDoorFireWallPolicy.md) -Create WAF policy - -### [New-AzureRmFrontDoorFrontendEndpointObject](New-AzureRmFrontDoorFrontendEndpointObject.md) -Create a PSFrontendEndpoint Object for Front Door creation - -### [New-AzureRmFrontDoorHealthProbeSettingObject](New-AzureRmFrontDoorHealthProbeSettingObject.md) -Create a PSHealthProbeSetting object for Front Door creation - -### [New-AzureRmFrontDoorLoadBalancingSettingObject](New-AzureRmFrontDoorLoadBalancingSettingObject.md) -Create a PSLoadBalancingSetting object for Front Door creation - -### [New-AzureRmFrontDoorManagedRuleObject](New-AzureRmFrontDoorManagedRuleObject.md) -Create ManagedRule Object for WAF policy creation - -### [New-AzureRmFrontDoorMatchConditionObject](New-AzureRmFrontDoorMatchConditionObject.md) -Create MatchCondition Object for WAF policy creation - -### [New-AzureRmFrontDoorRoutingRuleObject](New-AzureRmFrontDoorRoutingRuleObject.md) -Create a PSRoutingRuleObject for Front Door creation - -### [New-AzureRmFrontDoorRuleGroupOverrideObject](New-AzureRmFrontDoorRuleGroupOverrideObject.md) -Create RuleGroupOverride Object for WAF policy creation - -### [Remove-AzureRmFrontDoor](Remove-AzureRmFrontDoor.md) -Remove Front Door load balancer - -### [Remove-AzureRmFrontDoorContent](Remove-AzureRmFrontDoorContent.md) -Remove contents in Front Door - -### [Remove-AzureRmFrontDoorFireWallPolicy](Remove-AzureRmFrontDoorFireWallPolicy.md) -Remove WAF policy - -### [Set-AzureRmFrontDoor](Set-AzureRmFrontDoor.md) -Update a Front Door load balancer - -### [Set-AzureRmFrontDoorFireWallPolicy](Set-AzureRmFrontDoorFireWallPolicy.md) -update WAF policy - diff --git a/azurermps-6.13.0/AzureRM.FrontDoor/Get-AzureRmFrontDoor.md b/azurermps-6.13.0/AzureRM.FrontDoor/Get-AzureRmFrontDoor.md deleted file mode 100644 index 5b5d9704c6..0000000000 --- a/azurermps-6.13.0/AzureRM.FrontDoor/Get-AzureRmFrontDoor.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.FrontDoor.dll-Help.xml -Module Name: AzureRM.FrontDoor -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.frontdoor/get-azurermfrontdoor -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/Get-AzureRmFrontDoor.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/Get-AzureRmFrontDoor.md ---- - -# Get-AzureRmFrontDoor - -## SYNOPSIS -Get Front Door load balancer - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmFrontDoor [-ResourceGroupName <String>] [-Name <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmFrontDoor** cmdletGet gets all existing Front Doors in the current subscription that matches provided information. - -## EXAMPLES - -### Example 1: Get all FrontDoors in the current subscription. -```powershell -PS C:\> Get-AzureRmFrontDoor - -FriendlyName : frontdoor1 -RoutingRules : {routingrule1} -BackendPools : {backendpool1} -HealthProbeSettings : {healthProbeSetting1} -LoadBalancingSettings : {loadbalancingsetting1} -FrontendEndpoints : {frontendendpoint1} -EnabledState : Enabled -ResourceState : Enabled -ProvisioningState : Succeeded -Cname : -Tags : {tag1, tag2} -Id : /subscriptions/{guid}/resourcegroups/{guid1}/providers/M - icrosoft.Network/frontdoors/frontdoor1 -Name : frontdoor1 -Type : Microsoft.Network/frontdoor1 - -FriendlyName : frontdoor1 -RoutingRules : {routingrule1} -BackendPools : {backendpool1} -HealthProbeSettings : {healthProbeSetting1} -LoadBalancingSettings : {loadbalancingsetting1} -FrontendEndpoints : {frontendendpoint1} -EnabledState : Enabled -ResourceState : Enabled -ProvisioningState : Succeeded -Cname : -Tags : {tag1, tag2} -Id : /subscriptions/{guid}/resourcegroups/{guid2}/providers/M - icrosoft.Network/frontdoors/frontdoor1 -Name : frontdoor1 -Type : Microsoft.Network/frontdoor1 -``` - -Get all FrontDoors in the current subscription. - -### Example 2: Get all FrontDoors in resource group "rg1" in the current subscription. -```powershell -PS C:\> Get-AzureRmFrontDoor -ResourceGroupName "rg1" - -FriendlyName : frontdoor1 -RoutingRules : {routingrule1} -BackendPools : {backendpool1} -HealthProbeSettings : {healthProbeSetting1} -LoadBalancingSettings : {loadbalancingsetting1} -FrontendEndpoints : {frontendendpoint1} -EnabledState : Enabled -ResourceState : Enabled -ProvisioningState : Succeeded -Cname : -Tags : {tag1, tag2} -Id : /subscriptions/{guid}/resourcegroups/rg1/providers/M - icrosoft.Network/frontdoors/frontdoor1 -Name : frontdoor1 -Type : Microsoft.Network/frontdoor1 - -FriendlyName : frontdoor2 -RoutingRules : {routingrule1} -BackendPools : {backendpool1} -HealthProbeSettings : {healthProbeSetting1} -LoadBalancingSettings : {loadbalancingsetting1} -FrontendEndpoints : {frontendendpoint1} -EnabledState : Enabled -ResourceState : Enabled -ProvisioningState : Succeeded -Cname : -Tags : {tag1, tag2} -Id : /subscriptions/{guid}/resourcegroups/rg1/providers/M - icrosoft.Network/frontdoors/frontdoor1 -Name : frontdoor1 -Type : Microsoft.Network/frontdoor1 -``` - -Get all FrontDoors in resource group "rg1" in the current subscription. - -### Example 3: Get the FrontDoors in resource group "rg1" with name "frontDoor1" in the current subscription. -```powershell -PS C:\> Get-AzureRmFrontDoor -ResourceGroupName "rg1" -Name "frontDoor1" - -FriendlyName : frontdoor1 -RoutingRules : {routingrule1} -BackendPools : {backendpool1} -HealthProbeSettings : {healthProbeSetting1} -LoadBalancingSettings : {loadbalancingsetting1} -FrontendEndpoints : {frontendendpoint1} -EnabledState : Enabled -ResourceState : Enabled -ProvisioningState : Succeeded -Cname : -Tags : {tag1, tag2} -Id : /subscriptions/{guid}/resourcegroups/rg1/providers/M - icrosoft.Network/frontdoors/frontdoor1 -Name : frontdoor1 -Type : Microsoft.Network/frontdoor1 -``` - -Get the FrontDoors in resource group "rg1" with name "frontDoor1" in the current subscription. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Front Door name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.FrontDoor.Models.PSFrontDoor - -## NOTES - -## RELATED LINKS - -[New-AzureRmFrontDoor](./New-AzureRmFrontDoor.md) -[Set-AzureRmFrontDoor](./Set-AzureRmFrontDoor.md) -[Remove-AzureRmFrontDoor](./Remove-AzureRmFrontDoor.md) diff --git a/azurermps-6.13.0/AzureRM.FrontDoor/Get-AzureRmFrontDoorFireWallPolicy.md b/azurermps-6.13.0/AzureRM.FrontDoor/Get-AzureRmFrontDoorFireWallPolicy.md deleted file mode 100644 index 133e0e366f..0000000000 --- a/azurermps-6.13.0/AzureRM.FrontDoor/Get-AzureRmFrontDoorFireWallPolicy.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.FrontDoor.dll-Help.xml -Module Name: AzureRM.FrontDoor -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.frontdoor/get-azurermfrontdoorfirewallpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/Get-AzureRmFrontDoorFireWallPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/Get-AzureRmFrontDoorFireWallPolicy.md ---- - -# Get-AzureRmFrontDoorFireWallPolicy - -## SYNOPSIS -Get WAF policy - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmFrontDoorFireWallPolicy -ResourceGroupName <String> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmFrontDoorFireWallPolicy** cmdletGet gets WAF policy in a resource group under the current subscription - -## EXAMPLES - -### Example 1: Get a WAF policy called $Name in $resourceGroup -```powershell -PS C:\> Get-AzureRmFrontDoorFireWallPolicy -Name $Name -ResourceGroupName $resourceGroup - -PolicyMode : Prevention -PolicyEnabledState : Enabled -CustomRules : {Rule1} -ManagedRules : {Microsoft.Azure.Commands.FrontDoor.Models.PSAzureManagedRule} -Etag : -ProvisioningState : Succeeded -Tags : -Id : /subscriptions/{subid}/resourcegroups/{resourceGroupName}/providers/Micr - osoft.Network/frontdoorwebapplicationfirewallpolicies/{Name} -Name : {Name} -Type : -``` - -Get a WAF policy called $Name in $resourceGroup - -### Example 2: Get all WAF policy in $resourceGroup -```powershell -PS C:\> Get-AzureRmFrontDoorFireWallPolicy -ResourceGroupName $resourceGroup - -PolicyMode : Prevention -PolicyEnabledState : Enabled -CustomRules : {Rule1} -ManagedRules : {Microsoft.Azure.Commands.FrontDoor.Models.PSAzureManagedRule} -Etag : -ProvisioningState : Succeeded -Tags : -Id : /subscriptions/{subid}/resourcegroups/{resourceGroupName}/providers/Micr - osoft.Network/frontdoorwebapplicationfirewallpolicies/{Name1} -Name : {Name1} -Type : - -PolicyMode : Prevention -PolicyEnabledState : Enabled -CustomRules : {Rule1} -ManagedRules : {Microsoft.Azure.Commands.FrontDoor.Models.PSAzureManagedRule} -Etag : -ProvisioningState : Succeeded -Tags : -Id : /subscriptions/{subid}/resourcegroups/{resourceGroupName}/providers/Micr - osoft.Network/frontdoorwebapplicationfirewallpolicies/{Name2} -Name : {Name2} -Type : -``` - -Get all WAF policy in $resourceGroup - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -FireWallPolicy name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.FrontDoor.Models.PSPolicy - -## NOTES - -## RELATED LINKS - -[New-AzureRmFrontDoorFireWallPolicy](./New-AzureRmFrontDoorFireWallPolicy.md) -[Set-AzureRmFrontDoorFireWallPolicy](./Set-AzureRmFrontDoorFireWallPolicy.md) -[Remove-AzureRmFrontDoorFireWallPolicy](./Remove-AzureRmFrontDoorFireWallPolicy.md) diff --git a/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoor.md b/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoor.md deleted file mode 100644 index b557d7c6a3..0000000000 --- a/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoor.md +++ /dev/null @@ -1,262 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.FrontDoor.dll-Help.xml -Module Name: AzureRM.FrontDoor -online version: The corresponding URL should be the following: https://docs.microsoft.com/en-us/powershell/module/azurerm.frontdoor/new-azurermfrontdoor -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/New-AzureRmFrontDoor.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/New-AzureRmFrontDoor.md ---- - -# New-AzureRmFrontDoor - -## SYNOPSIS -Create a new Azure Front Door load balancer - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmFrontDoor -ResourceGroupName <String> -Name <String> -RoutingRule <PSRoutingRule[]> - -BackendPool <PSBackendPool[]> -FrontendEndpoint <PSFrontendEndpoint[]> - -LoadBalancingSetting <PSLoadBalancingSetting[]> -HealthProbeSetting <PSHealthProbeSetting[]> - [-Tag <Hashtable>] [-EnabledState <PSEnabledState>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmFrontDoor** cmdlet creates a new Azure Front Door load balancer in the specified resource group under current subscription - -## EXAMPLES - -### Example 1: Create a Front Door based on given parameters. -```powershell -PS C:\> New-AzureRmFrontDoor -Name "frontDoor1" -ResourceGroupName "rg1" -RoutingRule $routingrule1 -BackendPool $backendpool1 -FrontendEndpoint $frontendEndpoint1 -LoadBalancingSetting $loadBalancingSetting1 -HealthProbeSetting $healthProbeSetting1 - -FriendlyName : frontdoor1 -RoutingRules : {routingrule1} -BackendPools : {backendpool1} -HealthProbeSettings : {healthProbeSetting1} -LoadBalancingSettings : {loadbalancingsetting1} -FrontendEndpoints : {frontendendpoint1} -EnabledState : Enabled -ResourceState : Enabled -ProvisioningState : Succeeded -Cname : -Tags : {tag1, tag2} -Id : /subscriptions/{guid}/resourcegroups/rg1/providers/M - icrosoft.Network/frontdoors/frontdoor1 -Name : frontdoor1 -Type : Microsoft.Network/frontdoor1 -``` - -Create a Front Door based on given parameters. - -## PARAMETERS - -### -BackendPool -Backendpools available to routing rule. - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSBackendPool[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnabledState -EnabledState of the Front Door load balancer. -Default value is Enabled - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSEnabledState -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendEndpoint -Frontend endpoints available to routing rule. - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSFrontendEndpoint[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HealthProbeSetting -Health probe settings associated with this Front Door instance. - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSHealthProbeSetting[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancingSetting -Load balancing settings associated with this Front Door instance. - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSLoadBalancingSetting[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Front Door name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name that the Front Door will be created in. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RoutingRule -Routing rules associated with this FrontDoor - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSRoutingRule[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -The tags associate with the FrontDoor. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.FrontDoor.Models.PSFrontDoor - -## NOTES - -## RELATED LINKS - -[Get-AzureRmFrontDoor](./Get-AzureRmFrontDoor.md) -[Set-AzureRmFrontDoor](./Set-AzureRmFrontDoor.md) -[Remove-AzureRmFrontDoor](./Remove-AzureRmFrontDoor.md) -[New-AzureRmFrontDoorRoutingRuleObject](./New-AzureRmFrontDoorRoutingRuleObject.md) -[New-AzureRmFrontDoorHealthProbeSettingObject](./New-AzureRmFrontDoorHealthProbeSettingObject.md) -[New-AzureRmFrontDoorLoadBalancingSettingObject](./New-AzureRmFrontDoorLoadBalancingSettingObject.md) -[New-AzureRmFrontDoorFrontendEndpointObject](./New-AzureRmFrontDoorFrontendEndpointObject.md) -[New-AzureRmFrontDoorBackendPoolObject](./New-AzureRmFrontDoorBackendPoolObject.md) diff --git a/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorBackendObject.md b/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorBackendObject.md deleted file mode 100644 index 9ec1a5dfdb..0000000000 --- a/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorBackendObject.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.FrontDoor.dll-Help.xml -Module Name: AzureRM.FrontDoor -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.frontdoor/new-azurermfrontdoorbackendobject -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/New-AzureRmFrontDoorBackendObject.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/New-AzureRmFrontDoorBackendObject.md ---- - -# New-AzureRmFrontDoorBackendObject - -## SYNOPSIS -Create a PSBackend object - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmFrontDoorBackendObject -Address <String> [-HttpPort <Int32>] [-HttpsPort <Int32>] - [-Priority <Int32>] [-Weight <Int32>] [-EnabledState <PSEnabledState>] [-BackendHostHeader <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Create a PSBackend object for Front Door creation - -## EXAMPLES - -### Example 1 -```powershell -PS C:\>New-AzureRmFrontDoorBackendObject -Address "contoso1.azurewebsites.net" - - -Address : contoso1.azurewebsites.net -HttpPort : 80 -HttpsPort : 443 -Priority : 1 -Weight : 50 -BackendHostHeader : -EnabledState : Enabled -``` - -Create a PSBackend object for Front Door creation - -## PARAMETERS - -### -Address -Location of the backend (IP address or FQDN) - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendHostHeader -The value to use as the host header sent to the backend. -Default value is the backend address. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnabledState -Whether to enable use of this backend. -Default value is Enabled - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSEnabledState -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPort -The HTTP TCP port number. -Must be between 1 and 65535. -Default value is 80. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpsPort -The HTTPS TCP port number. -Must be between 1 and 65535. -Default value is 443 - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -Priority to use for load balancing. -Must be between 1 and 5. -Default value is 1 - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Weight -Weight of this endpoint for load balancing purposes. -Must be between 1 and 1000. -Default value is 50 - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.FrontDoor.Models.PSBackend - -## NOTES - -## RELATED LINKS - -[New-AzureRmFrontDoorBackendPoolObject](./New-AzureRmFrontDoorBackendPoolObject.md) diff --git a/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorBackendPoolObject.md b/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorBackendPoolObject.md deleted file mode 100644 index e597a1c8ab..0000000000 --- a/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorBackendPoolObject.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.FrontDoor.dll-Help.xml -Module Name: AzureRM.FrontDoor -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.frontdoor/new-azurermfrontdoorbackendpoolobject -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/New-AzureRmFrontDoorBackendPoolObject.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/New-AzureRmFrontDoorBackendPoolObject.md ---- - -# New-AzureRmFrontDoorBackendPoolObject - -## SYNOPSIS -Create a PSBackendPool object for Front Door creation - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmFrontDoorBackendPoolObject -ResourceGroupName <String> -Name <String> -FrontDoorName <String> - -Backend <PSBackend[]> -LoadBalancingSettingsName <String> -HealthProbeSettingsName <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Create a PSBackendPool object for Front Door creation - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-AzureRmFrontDoorBackendPoolObject -Name "backendpool1" -FrontDoorName $Name -ResourceGroupName $resourceGroupName -Backend $backend1 -He -althProbeSettingsName "healthProbeSetting1" -LoadBalancingSettingsName "loadBalancingSetting1" - - -Backends : {Microsoft.Azure.Commands.FrontDoor.Models.PSBackend} -LoadBalancingSettingRef : /subscriptions/{subid}/resourceGroups/{resourceGroupName}/providers - /Microsoft.Network/frontDoors/frontdoor5/LoadBalancingSettings/loadBalancingSetting1 -HealthProbeSettingRef : /subscriptions/{subid}/resourceGroups/{resourceGroupName}/providers - /Microsoft.Network/frontDoors/frontdoor5/HealthProbeSettings/healthProbeSetting1 -EnabledState : Enabled -ResourceState : -Id : -Name : backendpool1 -Type : -``` - -Create a PSBackendPool object for Front Door creation - -## PARAMETERS - -### -Backend -The set of backends for this pool. - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSBackend[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontDoorName -The name of the Front Door to which this routing rule belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HealthProbeSettingsName -The name of the health probe settings for this backend pool - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancingSettingsName -The name of the load balancing settings for this backend pool - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -BackendPool name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name that the RoutingRule will be created in. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.FrontDoor.Models.PSBackendPool - -## NOTES - -## RELATED LINKS - -[New-AzureRmFrontDoor](./New-AzureRmFrontDoor.md) -[Set-AzureRmFrontDoor](./Set-AzureRmFrontDoor.md) -[New-AzureRmFrontDoorBackendObject](./New-AzureRmFrontDoorBackendObject.md) diff --git a/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorCustomRuleObject.md b/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorCustomRuleObject.md deleted file mode 100644 index cb173ff56b..0000000000 --- a/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorCustomRuleObject.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.FrontDoor.dll-Help.xml -Module Name: AzureRM.FrontDoor -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.frontdoor/new-azurermfrontdoorcustomruleobject -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/New-AzureRmFrontDoorCustomRuleObject.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/New-AzureRmFrontDoorCustomRuleObject.md ---- - -# New-AzureRmFrontDoorCustomRuleObject - -## SYNOPSIS -Create CustomRule Object for WAF policy creation - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmFrontDoorCustomRuleObject -Name <String> -RuleType <PSCustomRuleType> - -MatchCondition <PSMatchCondition[]> -Action <PSAction> -Priority <Int32> - [-RateLimitDurationInMinutes <Int32>] [-RateLimitThreshold <Int32>] [-Transform <String[]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Create CustomRule Object for WAF policy creation - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-AzureRmFrontDoorCustomRuleObject -Name "Rule1" -RuleType MatchRule -MatchCondition $matchCondition1 -Action Block -Priority 2 - -RuleType : MatchRule -Action : Block -MatchConditions : {Microsoft.Azure.Commands.FrontDoor.Models.PSMatchCondition} -Priority : 2 -RateLimitDurationInMinutes : 1 -RateLimitThreshold : -Name : Rule1 -Etag : -Transforms : -``` - -Create a CustomRule Object - -## PARAMETERS - -### -Action -Type of Actions. -Possible values include: 'Allow', 'Block', 'Log' - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSAction -Parameter Sets: (All) -Aliases: -Accepted values: Allow, Block, Log - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MatchCondition -List of match conditions. - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSMatchCondition[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the rule - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -Describes priority of the rule. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RateLimitDurationInMinutes -Rate limit duration. Default - 1 minute - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RateLimitThreshold -Rate limit thresold - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RuleType -Type of the rule. -Possible values include: 'MatchRule', 'RateLimitRule' - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSCustomRuleType -Parameter Sets: (All) -Aliases: -Accepted values: RateLimitRule, MatchRule - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Transform -List of transforms - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.FrontDoor.Models.PSCustomRule - -## NOTES - -## RELATED LINKS - -[New-AzureRmFrontDoorFireWallPolicy](./New-AzureRmFrontDoorFireWallPolicy.md) -[Set-AzureRmFrontDoorFireWallPolicy](./Set-AzureRmFrontDoorFireWallPolicy.md) diff --git a/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorFireWallPolicy.md b/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorFireWallPolicy.md deleted file mode 100644 index 6272750799..0000000000 --- a/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorFireWallPolicy.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.FrontDoor.dll-Help.xml -Module Name: AzureRM.FrontDoor -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.frontdoor/new-azurermfrontdoorfirewallpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/New-AzureRmFrontDoorFireWallPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/New-AzureRmFrontDoorFireWallPolicy.md ---- - -# New-AzureRmFrontDoorFireWallPolicy - -## SYNOPSIS -Create WAF policy - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmFrontDoorFireWallPolicy -ResourceGroupName <String> -Name <String> [-EnabledState <PSEnabledState>] - [-Mode <PSMode>] [-Customrule <PSCustomRule[]>] [-ManagedRule <PSManagedRule[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmFrontDoorFireWallPolicy** cmdlet creates a new Azure WAF policy in the specified resource group under current subscription - -## EXAMPLES - -### Example 1: Create WAF policy -```powershell -PS C:\> New-AzureRmFrontDoorFireWallPolicy -Name $Name -ResourceGroupName $resourceGroupName -Customrule $customRule1 -ManagedRule $managedRule1 -En -abledState Enabled -Mode Prevention - - -PolicyMode : Prevention -PolicyEnabledState : Enabled -CustomRules : {Rule1} -ManagedRules : {Microsoft.Azure.Commands.FrontDoor.Models.PSAzureManagedRule} -Etag : -ProvisioningState : Succeeded -Tags : -Id : /subscriptions/{subid}/resourcegroups/{resourceGroupName}/providers/Micr - osoft.Network/frontdoorwebapplicationfirewallpolicies/{Name} -Name : {Name} -Type : -``` - -Create WAF policy - -## PARAMETERS - -### -Customrule -Custom rules inside the policy - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSCustomRule[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnabledState -Whether the policy is in enabled state or disabled state. -Possible values include: 'Disabled', 'Enabled' - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSEnabledState -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedRule -Managed rules inside the policy - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSManagedRule[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mode -Describes if it is in detection mode or prevention mode at policy level. -Possible values include:'Prevention', 'Detection' - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSMode -Parameter Sets: (All) -Aliases: -Accepted values: Prevention, Detection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApplicationFireWallPolicy name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.FrontDoor.Models.PSPolicy - -## NOTES - -## RELATED LINKS - -[Set-AzureRmFrontDoorFireWallPolicy](./Set-AzureRmFrontDoorFireWallPolicy.md) -[Get-AzureRmFrontDoorFireWallPolicy](./Get-AzureRmFrontDoorFireWallPolicy.md) -[Remove-AzureRmFrontDoorFireWallPolicy](./Remove-AzureRmFrontDoorFireWallPolicy.md) -[New-AzureRmFrontDoorManagedRuleObject](./New-AzureRmFrontDoorManagedRuleObject.md) -[New-AzureRmFrontDoorCustomRuleObject](./New-AzureRmFrontDoorManagedRuleObject.md) diff --git a/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorFrontendEndpointObject.md b/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorFrontendEndpointObject.md deleted file mode 100644 index 780a81627b..0000000000 --- a/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorFrontendEndpointObject.md +++ /dev/null @@ -1,263 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.FrontDoor.dll-Help.xml -Module Name: AzureRM.FrontDoor -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.frontdoor/new-azurermfrontdoorfrontendendpointobject -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/New-AzureRmFrontDoorFrontendEndpointObject.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/New-AzureRmFrontDoorFrontendEndpointObject.md ---- - -# New-AzureRmFrontDoorFrontendEndpointObject - -## SYNOPSIS -Create a PSFrontendEndpoint Object for Front Door creation - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmFrontDoorFrontendEndpointObject -Name <String> -HostName <String> - [-SessionAffinityEnabledState <PSEnabledState>] [-SessionAffinityTtlInSeconds <Int32>] - [-WebApplicationFirewallPolicyLink <String>] [-CertificateSource <PSCertificateSource>] - [-ProtocolType <PSProtocolType>] [-Vault <String>] [-SecretName <String>] [-SecretVersion <String>] - [-CertificateType <PSCertificateType>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Create a PSFrontendEndpoint Object for Front Door creation - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-AzureRmFrontDoorFrontendEndpointObject -Name "frontendendpoint1" -HostName $hostName - - -HostName : frontdoor5.azurefd.net -SessionAffinityEnabledState : Disabled -SessionAffinityTtlSeconds : 0 -WebApplicationFirewallPolicyLink : -Backends : -CustomHttpsProvisioningState : -CustomHttpsProvisioningSubstate : -CertificateSource : AzureKeyVault -ProtocolType : ServerNameIndication -Vault : -SecretName : -SecretVersion : -CertificateType : Shared -ResourceState : -Id : -Name : frontendendpoint1 -Type : -``` - -Create a PSFrontendEndpoint Object for Front Door creation - -## PARAMETERS - -### -CertificateSource -The source of the SSL certificate - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSCertificateSource -Parameter Sets: (All) -Aliases: -Accepted values: AzureKeyVault, FrontDoor - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CertificateType -the type of the certificate used for secure connections to a frontendEndpoint - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSCertificateType -Parameter Sets: (All) -Aliases: -Accepted values: Shared, Dedicated - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostName -The host name of the frontendEndpoint. -Must be a domain name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Frontend endpoint name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtocolType -The TLS extension protocol that is used for secure delivery - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSProtocolType -Parameter Sets: (All) -Aliases: -Accepted values: ServerNameIndication, IPBased - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecretName -The name of the Key Vault secret representing the full certificate PFX - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecretVersion -The version of the Key Vault secret representing the full certificate PFX - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SessionAffinityEnabledState -Whether to allow session affinity on this host. -Default value is Disabled - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSEnabledState -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SessionAffinityTtlInSeconds -The TTL to use in seconds for session affinity, if applicable. -Default value is 0 - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Vault -The Key Vault containing the SSL certificate - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApplicationFirewallPolicyLink -The resource id of Web Application Firewall policy for each host (if applicable) - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.FrontDoor.Models.PSFrontendEndpoint - -## NOTES - -## RELATED LINKS - -[New-AzureRmFrontDoor](./New-AzureRmFrontDoor.md) -[Set-AzureRmFrontDoor](./Set-AzureRmFrontDoor.md) diff --git a/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorHealthProbeSettingObject.md b/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorHealthProbeSettingObject.md deleted file mode 100644 index 10fdff9edf..0000000000 --- a/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorHealthProbeSettingObject.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.FrontDoor.dll-Help.xml -Module Name: AzureRM.FrontDoor -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.frontdoor/new-azurermfrontdoorhealthprobesettingobject -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/New-AzureRmFrontDoorHealthProbeSettingObject.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/New-AzureRmFrontDoorHealthProbeSettingObject.md ---- - -# New-AzureRmFrontDoorHealthProbeSettingObject - -## SYNOPSIS -Create a PSHealthProbeSetting object for Front Door creation - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmFrontDoorHealthProbeSettingObject -Name <String> [-Path <String>] [-Protocol <PSProtocol>] - [-IntervalInSeconds <Int32>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Create a PSHealthProbeSetting object for Front Door creation - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-AzureRmFrontDoorHealthProbeSettingObject -Name "healthProbeSetting1" - - -Path : / -Protocol : Http -IntervalInSeconds : 30 -ResourceState : -Id : -Name : healthProbeSetting1 -Type : -``` - -Create a PSHealthProbeSetting object for Front Door creation - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IntervalInSeconds -The number of seconds between health probes. -Default value is 30 - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -health probe setting name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -The path to use for the health probe. -Default is / - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Protocol scheme to use for this probe -Default value is HTTP - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSProtocol -Parameter Sets: (All) -Aliases: -Accepted values: Http, Https - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.FrontDoor.Models.PSHealthProbeSetting - -## NOTES - -## RELATED LINKS - -[New-AzureRmFrontDoor](./New-AzureRmFrontDoor.md) -[Set-AzureRmFrontDoor](./Set-AzureRmFrontDoor.md) diff --git a/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorLoadBalancingSettingObject.md b/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorLoadBalancingSettingObject.md deleted file mode 100644 index 7a0678b8e8..0000000000 --- a/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorLoadBalancingSettingObject.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.FrontDoor.dll-Help.xml -Module Name: AzureRM.FrontDoor -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.frontdoor/new-azurermfrontdoorloadbalancingsettingobject -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/New-AzureRmFrontDoorLoadBalancingSettingObject.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/New-AzureRmFrontDoorLoadBalancingSettingObject.md ---- - -# New-AzureRmFrontDoorLoadBalancingSettingObject - -## SYNOPSIS -Create a PSLoadBalancingSetting object for Front Door creation - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmFrontDoorLoadBalancingSettingObject -Name <String> [-SampleSize <Int32>] - [-SuccessfulSamplesRequired <Int32>] [-AdditionalLatencyInMilliseconds <Int32>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Create a PSLoadBalancingSetting object for Front Door creation - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-AzureRmFrontDoorLoadBalancingSettingObject -Name "loadbalancingsetting1" - - -SampleSize : 4 -AdditionalLatencyMilliseconds : 0 -SuccessfulSamplesRequired : 2 -ResourceState : -Id : -Name : loadbalancingsetting1 -Type : -``` - -Create a PSLoadBalancingSetting object for Front Door creation - -## PARAMETERS - -### -AdditionalLatencyInMilliseconds -The additional latency in milliseconds for probes to fall into the lowest latency bucket. -Default value is 0 - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -health probe setting name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SampleSize -The number of samples to consider for load balancing decisions. -Default value is 4 - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SuccessfulSamplesRequired -The number of samples within the sample period that must succeed -Default value is 2 - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.FrontDoor.Models.PSLoadBalancingSetting - -## NOTES - -## RELATED LINKS - -[New-AzureRmFrontDoor](./New-AzureRmFrontDoor.md) -[Set-AzureRmFrontDoor](./Set-AzureRmFrontDoor.md) diff --git a/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorManagedRuleObject.md b/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorManagedRuleObject.md deleted file mode 100644 index b970ee00a6..0000000000 --- a/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorManagedRuleObject.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.FrontDoor.dll-Help.xml -Module Name: AzureRM.FrontDoor -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.frontdoor/new-azurermfrontdoormanagedruleobject -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/New-AzureRmFrontDoorManagedRuleObject.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/New-AzureRmFrontDoorManagedRuleObject.md ---- - -# New-AzureRmFrontDoorManagedRuleObject - -## SYNOPSIS -Create ManagedRule Object for WAF policy creation - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmFrontDoorManagedRuleObject -Priority <Int32> [-Version <String>] - [-RuleGroupOverride <PSAzureRuleGroupOverride[]>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -Create ManagedRule Object for WAF policy creation - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-AzureRmFrontDoor -ManagedRuleObject -Priority 1 -Version 0 -RuleGroupOverride $override1 - -RuleGroupOverrides Priority Version ------------------- -------- ------- -{Microsoft.Azure.Commands.FrontDoor.Models.PSAzureRuleGroupOverride} 1 0 -``` - -Create a ManagedRule Object - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -Describes priority of the rule - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RuleGroupOverride -List of azure managed provider override configuration - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSAzureRuleGroupOverride[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Version -Version of the ruleset - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.FrontDoor.Models.PSAzureManagedRule - -## NOTES - -## RELATED LINKS - -[New-AzureRmFrontDoorFireWallPolicy](./New-AzureRmFrontDoorFireWallPolicy.md) -[Set-AzureRmFrontDoorFireWallPolicy](./Set-AzureRmFrontDoorFireWallPolicy.md) -[New-AzureRmFrontDoorRuleGroupOverrideObject](./New-AzureRmFrontDoorRuleGroupOverrideObject.md) diff --git a/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorMatchConditionObject.md b/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorMatchConditionObject.md deleted file mode 100644 index a00c59c7e7..0000000000 --- a/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorMatchConditionObject.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.FrontDoor.dll-Help.xml -Module Name: AzureRM.FrontDoor -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.frontdoor/new-azurermfrontdoormatchconditionobject -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/New-AzureRmFrontDoorMatchConditionObject.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/New-AzureRmFrontDoorMatchConditionObject.md ---- - -# New-AzureRmFrontDoorMatchConditionObject - -## SYNOPSIS -Create MatchCondition Object for WAF policy creation - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmFrontDoorMatchConditionObject -MatchVariable <PSMatchVariable> - -OperatorProperty <PSOperatorProperty> -MatchValue <String[]> [-Selector <String>] - [-NegateCondition <Boolean>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Create MatchCondition Object for WAF policy creation - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-AzureRmFrontDoorMatchConditionObject -MatchVariable RequestHeader -OperatorProperty Contains -Selector "UserAgent" -MatchValue "Windows" - - -MatchVariable : RequestHeader -OperatorProperty : Contains -MatchValue : {Windows} -Selector : UserAgent -NegateCondition : False -``` - -Create a MatchCondition object - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MatchValue -Match value. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MatchVariable -Match Variable. -Possible values include: 'RemoteAddr', 'RequestMethod', 'QueryString', 'PostArgs','RequestUri', 'RequestHeader', 'RequestBody' - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSMatchVariable -Parameter Sets: (All) -Aliases: -Accepted values: RemoteAddr, RequestMethod, QueryString, PostArgs, RequestUri, RequestHeader, RequestBody - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NegateCondition -Describes if this is negate condition or not -Default value is false - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OperatorProperty -Describes operator to be matched. -Possible values include: 'Any', 'IPMatch', 'GeoMatch', 'Equal', 'Contains', 'LessThan', 'GreaterThan', 'LessThanOrEqual', 'GreaterThanOrEqual', 'BeginsWith', 'EndsWith'' - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSOperatorProperty -Parameter Sets: (All) -Aliases: -Accepted values: Any, IPMatch, GeoMatch, Equal, Contains, LessThan, GreaterThan, LessThanOrEqual, GreaterThanOrEqual, BeginsWith, EndsWith - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Selector -Name of selector in RequestHeader or RequestBody to be matched - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.FrontDoor.Models.PSMatchCondition - -## NOTES - -## RELATED LINKS - -[New-AzureRmFrontDoorCustomRuleObject](./New-AzureRmFrontDoorCustomRuleObject.md) diff --git a/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorRoutingRuleObject.md b/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorRoutingRuleObject.md deleted file mode 100644 index 86b3c59605..0000000000 --- a/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorRoutingRuleObject.md +++ /dev/null @@ -1,299 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.FrontDoor.dll-Help.xml -Module Name: AzureRM.FrontDoor -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.frontdoor/new-azurermfrontdoorroutingruleobject -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/New-AzureRmFrontDoorRoutingRuleObject.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/New-AzureRmFrontDoorRoutingRuleObject.md ---- - -# New-AzureRmFrontDoorRoutingRuleObject - -## SYNOPSIS -Create a PSRoutingRuleObject for Front Door creation - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmFrontDoorRoutingRuleObject -ResourceGroupName <String> -FrontDoorName <String> -Name <String> - -FrontendEndpointName <String[]> -BackendPoolName <String> [-AcceptedProtocol <PSProtocol[]>] - [-PatternToMatch <String[]>] [-CustomForwardingPath <String>] [-ForwardingProtocol <PSForwardingProtocol>] - [-EnableCaching <Boolean>] [-QueryParameterStripDirective <PSQueryParameterStripDirective>] - [-DynamicCompression <PSEnabledState>] [-EnabledState <PSEnabledState>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Create a PSRoutingRuleObject for Front Door creation - -## EXAMPLES - -### Example 1: Create a PSRoutingRuleObject for Front Door creation -```powershell -PS C:\> New-AzureRmFrontDoorRoutingRuleObject -Name $routingRuleName -FrontDoorName $frontDoorName -ResourceGroupName -FrontendEndpointName "frontendEndpoint1" -BackendPoolName "backendPool1" - -FrontendEndpointIds : {/subscriptions/{subid}/resourceGroups/{rgname}/pro - viders/Microsoft.Network/frontDoors/{frontdoorname}/FrontendEndpoints/frontendEndpoint1} -AcceptedProtocols : {Http, Https} -PatternsToMatch : {/*} -ForwardingProtocol : MatchRequest -CustomForwardingPath : -QueryParameterStripDirective : StripAll -DynamicCompression : Enabled -HealthProbeSettings : -BackendPoolId : /subscriptions/{subid}/resourceGroups/{rgname}/prov - iders/Microsoft.Network/frontDoors/{frontdoorname}/BackendPools/backendPool1 -EnableCaching : Disabled -EnabledState : Enabled -ResourceState : -Id : -Name : routingrule1 -Type : -``` - -Create a PSRoutingRuleObject for Front Door creation - -## PARAMETERS - -### -AcceptedProtocol -Protocol schemes to match for this rule. -Default value is {Https, Http} - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSProtocol[] -Parameter Sets: (All) -Aliases: -Accepted values: Http, Https - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendPoolName -Resource id of the BackendPool which this rule routes to - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomForwardingPath -The custom path used to rewrite resource paths matched by this rule. -Leave empty to use incoming path. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DynamicCompression -Whether to enable dynamic compression for cached content when caching is enabled. -Default value is Enabled - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSEnabledState -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableCaching -Whether to enable caching for this route. -Default value is false - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnabledState -Whether to enable use of this rule. -Default value is Enabled - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSEnabledState -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForwardingProtocol -The protocol this rule will use when forwarding traffic to backends -Default value is MatchRequest. - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSForwardingProtocol -Parameter Sets: (All) -Aliases: -Accepted values: HttpOnly, HttpsOnly, MatchRequest - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontDoorName -The name of the Front Door to which this routing rule belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendEndpointName -The names of Frontend endpoints associated with this rule - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -RoutingRule name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PatternToMatch -The route patterns of the rule, Must not have any * except possibly after the final / at the end of the path. -Default value is /* - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QueryParameterStripDirective -The treatment of URL query terms when forming the cache key. -Default value is StripAll - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSQueryParameterStripDirective -Parameter Sets: (All) -Aliases: -Accepted values: StripNone, StripAll - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name that the RoutingRule will be created in. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.FrontDoor.Models.PSRoutingRule - -## NOTES - -## RELATED LINKS - -[New-AzureRmFrontDoor](./New-AzureRmFrontDoor.md) -[Set-AzureRmFrontDoor](./Set-AzureRmFrontDoor.md) diff --git a/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorRuleGroupOverrideObject.md b/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorRuleGroupOverrideObject.md deleted file mode 100644 index 7a3ab519a4..0000000000 --- a/azurermps-6.13.0/AzureRM.FrontDoor/New-AzureRmFrontDoorRuleGroupOverrideObject.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.FrontDoor.dll-Help.xml -Module Name: AzureRM.FrontDoor -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.frontdoor/new-azurermfrontdoorrulegroupoverrideobject -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/New-AzureRmFrontDoorRuleGroupOverrideObject.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/New-AzureRmFrontDoorRuleGroupOverrideObject.md ---- - -# New-AzureRmFrontDoorRuleGroupOverrideObject - -## SYNOPSIS -Create RuleGroupOverride Object for WAF policy creation - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmFrontDoorRuleGroupOverrideObject -Override <PSRuleGroupOverride> -Action <PSAction> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Create RuleGroupOverride Object for WAF policy creation - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-AzureRmFrontDoorRuleGroupOverrideObject -Override SqlInjection -Action Block - -Action RuleGroupOverride ------- ----------------- - Block SqlInjection -``` - -Create a RuleGroupOverride Object - -## PARAMETERS - -### -Action -Type of Actions. -Possible values include: 'Allow', 'Block', 'Log' - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSAction -Parameter Sets: (All) -Aliases: -Accepted values: Allow, Block, Log - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Override -Describes overrideruleGroup. -Possible values include: 'SqlInjection', 'XSS' - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSRuleGroupOverride -Parameter Sets: (All) -Aliases: -Accepted values: SqlInjection, XSS - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.FrontDoor.Models.PSAzureRuleGroupOverride - -## NOTES - -## RELATED LINKS - -[New-AzureRmFrontDoorManagedRuleObject](./New-AzureRmFrontDoorManagedRuleObject.md) diff --git a/azurermps-6.13.0/AzureRM.FrontDoor/Remove-AzureRmFrontDoor.md b/azurermps-6.13.0/AzureRM.FrontDoor/Remove-AzureRmFrontDoor.md deleted file mode 100644 index b4b854a2c9..0000000000 --- a/azurermps-6.13.0/AzureRM.FrontDoor/Remove-AzureRmFrontDoor.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.FrontDoor.dll-Help.xml -Module Name: AzureRM.FrontDoor -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.frontdoor/remove-azurermfrontdoor -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/Remove-AzureRmFrontDoor.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/Remove-AzureRmFrontDoor.md ---- - -# Remove-AzureRmFrontDoor - -## SYNOPSIS -Remove Front Door load balancer - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFieldsParameterSet (Default) -``` -Remove-AzureRmFrontDoor -ResourceGroupName <String> -Name <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByObjectParameterSet -``` -Remove-AzureRmFrontDoor -InputObject <PSFrontDoor> [-PassThru] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Remove-AzureRmFrontDoor -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmFrontDoor** cmdlet removes a Front Door load balancer under the current subscription - -## EXAMPLES - -### Example 1: Remove "frontdoor1" in resource group "rg1" under the current subscription. -```powershell -PS C:\> Remove-AzureRmFrontDoor -Name "frontdoor1" -ResourceGroupName "rg1" -``` - -Remove "frontdoor1" in resource group "rg1" under the current subscription. - -### Example 2: Remove all FrontDoors in resource group "rg1" under the current subscription. -```powershell -PS C:\> Get-AzureRmFrontDoor -ResourceGroupName "rg1" | Remove-AzureRmFrontDoor -``` - -Remove all FrontDoors in resource group "rg1" under the current subscription. - -### Example 3: Remove all FrontDoors under the current subscription. -```powershell -PS C:\> Get-AzureRmFrontDoor | Remove-AzureRmFrontDoor -``` - -Remove all FrontDoors under the current subscription. - -### Example 4: Remove all FrontDoors with name "frontdoor1" under the current subscription. -```powershell -PS C:\> Remove-AzureRmFrontDoor -Name "frontdoor1" | Remove-AzureRmFrontDoor -``` - -Remove all FrontDoors with name "frontdoor1" under the current subscription. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The Front Door object to delete. - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSFrontDoor -Parameter Sets: ByObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the Front Door to delete. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Return object (if specified). - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group to which the Front Door belongs. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Resource Id of the Front Door to delete - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.FrontDoor.Models.PSFrontDoor - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[New-AzureRmFrontDoor](./New-AzureRmFrontDoor.md) -[Get-AzureRmFrontDoor](./Get-AzureRmFrontDoor.md) diff --git a/azurermps-6.13.0/AzureRM.FrontDoor/Remove-AzureRmFrontDoorContent.md b/azurermps-6.13.0/AzureRM.FrontDoor/Remove-AzureRmFrontDoorContent.md deleted file mode 100644 index 7ad13276ba..0000000000 --- a/azurermps-6.13.0/AzureRM.FrontDoor/Remove-AzureRmFrontDoorContent.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.FrontDoor.dll-Help.xml -Module Name: AzureRM.FrontDoor -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.frontdoor/remove-azurermfrontdoorcontent -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/Remove-AzureRmFrontDoorContent.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/Remove-AzureRmFrontDoorContent.md ---- - -# Remove-AzureRmFrontDoorContent - -## SYNOPSIS -Remove contents in Front Door - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmFrontDoorContent -ResourceGroupName <String> -Name <String> -ContentPath <String[]> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Remove-AzureRmFrontDoorContent purges cached contents in a Front Door - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-AzureRmFrontDoorContent -ResourceGroupName $ResourceGroupName -Name $FrontDoorName -ContentPath "/*" -``` - -## PARAMETERS - -### -ContentPath -The paths to the content to be purged. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Front Door name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Return object (if specified). - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name of the Front Door - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.FrontDoor/Remove-AzureRmFrontDoorFireWallPolicy.md b/azurermps-6.13.0/AzureRM.FrontDoor/Remove-AzureRmFrontDoorFireWallPolicy.md deleted file mode 100644 index ffee827189..0000000000 --- a/azurermps-6.13.0/AzureRM.FrontDoor/Remove-AzureRmFrontDoorFireWallPolicy.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.FrontDoor.dll-Help.xml -Module Name: AzureRM.FrontDoor -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.frontdoor/remove-azurermfrontdoorfirewallpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/Remove-AzureRmFrontDoorFireWallPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/Remove-AzureRmFrontDoorFireWallPolicy.md ---- - -# Remove-AzureRmFrontDoorFireWallPolicy - -## SYNOPSIS -Remove WAF policy - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFieldsParameterSet (Default) -``` -Remove-AzureRmFrontDoorFireWallPolicy -ResourceGroupName <String> -Name <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByObjectParameterSet -``` -Remove-AzureRmFrontDoorFireWallPolicy -InputObject <PSPolicy> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Remove-AzureRmFrontDoorFireWallPolicy -ResourceId <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmFrontDoor** cmdlet removes a WAF policy under the current subscription - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-AzureRmFrontDoorFireWallPolicy -Name $name -ResourceGroupName $resourceGroup -``` - -Remove the WAF policy called $name in $resourceGroup. - -### Example 2 -```powershell -PS C:\> Get--AzureRmFrontDoorFireWallPolicy -ResourceGroupName $resourceGroup | Remove-AzureRmFrontDoorFireWallPolicy -``` - -Remove all WAF policy in $resourceGroup. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The WAF policy object to delete. - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSPolicy -Parameter Sets: ByObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the WAF policy to delete. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Return object (if specified). - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group to which the WAF policy belongs. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Resource Id of the WAF policy to delete - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.FrontDoor.Models.PSPolicy - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[New-AzureRmFrontDoorFireWallPolicy](./New-AzureRmFrontDoorFireWallPolicy.md) -[Get-AzureRmFrontDoorFireWallPolicy](./Get-AzureRmFrontDoorFireWallPolicy.md) diff --git a/azurermps-6.13.0/AzureRM.FrontDoor/Set-AzureRmFrontDoor.md b/azurermps-6.13.0/AzureRM.FrontDoor/Set-AzureRmFrontDoor.md deleted file mode 100644 index b5e34729b1..0000000000 --- a/azurermps-6.13.0/AzureRM.FrontDoor/Set-AzureRmFrontDoor.md +++ /dev/null @@ -1,357 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.FrontDoor.dll-Help.xml -Module Name: AzureRM.FrontDoor -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.frontdoor/set-azurermfrontdoor -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/Set-AzureRmFrontDoor.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/Set-AzureRmFrontDoor.md ---- - -# Set-AzureRmFrontDoor - -## SYNOPSIS -Update a Front Door load balancer - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFieldsParameterSet (Default) -``` -Set-AzureRmFrontDoor -ResourceGroupName <String> -Name <String> [-RoutingRule <PSRoutingRule[]>] - [-BackendPool <PSBackendPool[]>] [-FrontendEndpoint <PSFrontendEndpoint[]>] - [-LoadBalancingSetting <PSLoadBalancingSetting[]>] [-HealthProbeSetting <PSHealthProbeSetting[]>] - [-Tag <Hashtable>] [-EnabledState <PSEnabledState>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ByObjectParameterSet -``` -Set-AzureRmFrontDoor -InputObject <PSFrontDoor> [-RoutingRule <PSRoutingRule[]>] - [-BackendPool <PSBackendPool[]>] [-FrontendEndpoint <PSFrontendEndpoint[]>] - [-LoadBalancingSetting <PSLoadBalancingSetting[]>] [-HealthProbeSetting <PSHealthProbeSetting[]>] - [-Tag <Hashtable>] [-EnabledState <PSEnabledState>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Set-AzureRmFrontDoor -ResourceId <String> [-RoutingRule <PSRoutingRule[]>] [-BackendPool <PSBackendPool[]>] - [-FrontendEndpoint <PSFrontendEndpoint[]>] [-LoadBalancingSetting <PSLoadBalancingSetting[]>] - [-HealthProbeSetting <PSHealthProbeSetting[]>] [-Tag <Hashtable>] [-EnabledState <PSEnabledState>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmFrontDoor** cmdlet updates a Front Door load balancer. If input parameters are not provided, old parameters from the existing Front Door will be used. - -## EXAMPLES - -### Example 1: update an existing Front Door with FrontDoorName and ResourceGroupName. -```powershell -PS C:\> Set-AzureRmFrontDoor -Name "frontDoor1" -ResourceGroupName "resourceGroup1" -RoutingRule $routingrule1 -BackendPool $backendpool1 -FrontendEndpoint $frontendEndpoint1 -LoadBalancingSetting $loadBalancingSetting1 -HealthProbeSetting $healthProbeSetting1 - -FriendlyName : frontdoor1 -RoutingRules : {routingrule1} -BackendPools : {backendpool1} -HealthProbeSettings : {healthProbeSetting1} -LoadBalancingSettings : {loadbalancingsetting1} -FrontendEndpoints : {frontendendpoint1} -EnabledState : Enabled -ResourceState : Enabled -ProvisioningState : Succeeded -Cname : -Tags : {tag1, tag2} -Id : /subscriptions/{guid}/resourcegroups/{guid}/providers/M - icrosoft.Network/frontdoors/frontdoor1 -Name : frontdoor1 -Type : Microsoft.Network/frontdoor1 -``` - -update an existing FrontDoor. - -### Example 2: update an existing Front Door with PSFrontDoor object. -```powershell -PS C:\> Set-AzureRmFrontDoor -InputObject $frontDoor1 -RoutingRule $routingrule1 -BackendPool $backendpool1 -FrontendEndpoint $frontendEndpoint1 -LoadBalancingSetting $loadBalancingSetting1 -HealthProbeSetting $healthProbeSetting1 - -FriendlyName : frontdoor1 -RoutingRules : {routingrule1} -BackendPools : {backendpool1} -HealthProbeSettings : {healthProbeSetting1} -LoadBalancingSettings : {loadbalancingsetting1} -FrontendEndpoints : {frontendendpoint1} -EnabledState : Enabled -ResourceState : Enabled -ProvisioningState : Succeeded -Cname : -Tags : {tag1, tag2} -Id : /subscriptions/{guid}/resourcegroups/{guid}/providers/M - icrosoft.Network/frontdoors/frontdoor1 -Name : frontdoor1 -Type : Microsoft.Network/frontdoor1 -``` - -update an existing FrontDoor. - -### Example 3: update an existing Front Door with ResourceId -```powershell -PS C:\> Set-AzureRmFrontDoor -ResourceId {resourceId} -RoutingRule $routingrule1 -BackendPool $backendpool1 -FrontendEndpoint $frontendEndpoint1 -LoadBalancingSetting $loadBalancingSetting1 -HealthProbeSetting $healthProbeSetting1 - -FriendlyName : frontdoor1 -RoutingRules : {routingrule1} -BackendPools : {backendpool1} -HealthProbeSettings : {healthProbeSetting1} -LoadBalancingSettings : {loadbalancingsetting1} -FrontendEndpoints : {frontendendpoint1} -EnabledState : Enabled -ResourceState : Enabled -ProvisioningState : Succeeded -Cname : -Tags : {tag1, tag2} -Id : /subscriptions/{guid}/resourcegroups/{guid}/providers/M - icrosoft.Network/frontdoors/frontdoor1 -Name : frontdoor1 -Type : Microsoft.Network/frontdoor1 -``` - -update an existing FrontDoor. - -## PARAMETERS - -### -BackendPool -Backendpools available to routing rule. - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSBackendPool[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnabledState -Operational status of the Front Door load balancer. - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSEnabledState -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendEndpoint -Frontend endpoints available to routing rule. - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSFrontendEndpoint[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HealthProbeSetting -Health probe settings associated with this Front Door instance. - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSHealthProbeSetting[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The Front Door object to update. - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSFrontDoor -Parameter Sets: ByObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LoadBalancingSetting -Load balancing settings associated with this Front Door instance. - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSLoadBalancingSetting[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the Front Door to update. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group to which the Front Door belongs. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Resource Id of the Front Door to update - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RoutingRule -Routing rules associated with this FrontDoor - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSRoutingRule[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -The tags associate with the FrontDoor. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.FrontDoor.Models.PSFrontDoor - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.FrontDoor.Models.PSFrontDoor - -## NOTES - -## RELATED LINKS - -[New-AzureRmFrontDoor](./New-AzureRmFrontDoor.md) -[Get-AzureRmFrontDoor](./Get-AzureRmFrontDoor.md) -[Remove-AzureRmFrontDoor](./Remove-AzureRmFrontDoor.md) -[New-AzureRmFrontDoorRoutingRuleObject](./New-AzureRmFrontDoorRoutingRuleObject.md) -[New-AzureRmFrontDoorHealthProbeSettingObject](./New-AzureRmFrontDoorHealthProbeSettingObject.md) -[New-AzureRmFrontDoorLoadBalancingSettingObject](./New-AzureRmFrontDoorLoadBalancingSettingObject.md) -[New-AzureRmFrontDoorFrontendEndpointObject](./New-AzureRmFrontDoorFrontendEndpointObject.md) -[New-AzureRmFrontDoorBackendPoolObject](./New-AzureRmFrontDoorBackendPoolObject.md) diff --git a/azurermps-6.13.0/AzureRM.FrontDoor/Set-AzureRmFrontDoorFireWallPolicy.md b/azurermps-6.13.0/AzureRM.FrontDoor/Set-AzureRmFrontDoorFireWallPolicy.md deleted file mode 100644 index 97c8dc14ca..0000000000 --- a/azurermps-6.13.0/AzureRM.FrontDoor/Set-AzureRmFrontDoorFireWallPolicy.md +++ /dev/null @@ -1,301 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.FrontDoor.dll-Help.xml -Module Name: AzureRM.FrontDoor -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.frontdoor/set-azurermfrontdoorfirewallpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/Set-AzureRmFrontDoorFireWallPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/FrontDoor/Commands.FrontDoor/help/Set-AzureRmFrontDoorFireWallPolicy.md ---- - -# Set-AzureRmFrontDoorFireWallPolicy - -## SYNOPSIS -update WAF policy - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFieldsParameterSet (Default) -``` -Set-AzureRmFrontDoorFireWallPolicy -ResourceGroupName <String> -Name <String> [-EnabledState <PSEnabledState>] - [-Mode <PSMode>] [-Customrule <PSCustomRule[]>] [-ManagedRule <PSManagedRule[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByObjectParameterSet -``` -Set-AzureRmFrontDoorFireWallPolicy -InputObject <PSPolicy> [-EnabledState <PSEnabledState>] [-Mode <PSMode>] - [-Customrule <PSCustomRule[]>] [-ManagedRule <PSManagedRule[]>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Set-AzureRmFrontDoorFireWallPolicy -ResourceId <String> [-EnabledState <PSEnabledState>] [-Mode <PSMode>] - [-Customrule <PSCustomRule[]>] [-ManagedRule <PSManagedRule[]>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmFrontDoor** cmdlet updates an existing WAF policy. If input parameters are not provided, old parameters from the existing WAF policy will be used. - -## EXAMPLES - -### Example 1: update an existing WAF policy -```powershell -PS C:\> Set-AzureRmFrontDoorFireWallPolicy -Name $name -ResourceGroupName $resourceGroup -Customrule $customRule -ManagedRule $managedRule -EnabledState $enabledState -Mode $node - -PolicyMode : Prevention -PolicyEnabledState : Enabled -CustomRules : {Rule1} -ManagedRules : {Microsoft.Azure.Commands.FrontDoor.Models.PSAzureManagedRule} -Etag : -ProvisioningState : Succeeded -Tags : -Id : /subscriptions/{subid}/resourcegroups/{resourceGroupName}/providers/Micr - osoft.Network/frontdoorwebapplicationfirewallpolicies/{Name} -Name : {Name} -Type : -``` - -update an existing WAF policy - -### Example 2: update an existing WAF policy -```powershell -PS C:\> Set-AzureRmFrontDoorFireWallPolicy -InputObject $policy1 -Customrule $customRule -ManagedRule $managedRule -EnabledState $enabledState -Mode $mode - -PolicyMode : Prevention -PolicyEnabledState : Enabled -CustomRules : {Rule1} -ManagedRules : {Microsoft.Azure.Commands.FrontDoor.Models.PSAzureManagedRule} -Etag : -ProvisioningState : Succeeded -Tags : -Id : /subscriptions/{subid}/resourcegroups/{resourceGroupName}/providers/Micr - osoft.Network/frontdoorwebapplicationfirewallpolicies/{Name} -Name : {Name} -Type : -``` - -update an existing WAF policy - -### Example 3: update an existing WAF policy -```powershell -PS C:\> Set-AzureRmFrontDoorFireWallPolicy -ResourceId $resourcdId -Customrule $customRule -ManagedRule $managedRule -EnabledState $enabledState -Mode $mode - -PolicyMode : Prevention -PolicyEnabledState : Enabled -CustomRules : {Rule1} -ManagedRules : {Microsoft.Azure.Commands.FrontDoor.Models.PSAzureManagedRule} -Etag : -ProvisioningState : Succeeded -Tags : -Id : /subscriptions/{subid}/resourcegroups/{resourceGroupName}/providers/Micr - osoft.Network/frontdoorwebapplicationfirewallpolicies/{Name} -Name : {Name} -Type : -``` - -update an existing WAF policy - -### Example 4: update all WAF policies in $resourceGroup -```powershell -PS C:\> Get-AzureRmFrontDoorFireWallPolicy -ResourceGroupName $resourceGroup | Set-AzureRmFrontDoorFireWallPolicy -Customrule $customRule -ManagedRule $managedRule -EnabledState $enabledState -Mode $mode -``` - -update all WAF policies in $resourceGroup - -## PARAMETERS - -### -Customrule -Custom rules inside the policy - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSCustomRule[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnabledState -Whether the policy is in enabled state or disabled state. -Possible values include: 'Disabled', 'Enabled' - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSEnabledState -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The FireWallPolicy object to update. - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSPolicy -Parameter Sets: ByObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ManagedRule -Managed rules inside the policy - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSManagedRule[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mode -Describes if it is in detection mode or prevention mode at policy level. -Possible values include:'Prevention', 'Detection' - -```yaml -Type: Microsoft.Azure.Commands.FrontDoor.Models.PSMode -Parameter Sets: (All) -Aliases: -Accepted values: Prevention, Detection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the FireWallPolicy to update. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group to which the FireWallPolicy belongs. - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Resource Id of the FireWallPolicy to update - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.FrontDoor.Models.PSPolicy - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.FrontDoor.Models.PSPolicy - -## NOTES - -## RELATED LINKS - -[New-AzureRmFrontDoorFireWallPolicy](./New-AzureRmFrontDoorFireWallPolicy.md) -[Get-AzureRmFrontDoorFireWallPolicy](./Get-AzureRmFrontDoorFireWallPolicy.md) -[New-AzureRmFrontDoorManagedRuleObject](./New-AzureRmFrontDoorManagedRuleObject.md) -[New-AzureRmFrontDoorCustomRuleObject](./New-AzureRmFrontDoorManagedRuleObject.md) diff --git a/azurermps-6.13.0/AzureRM.HDInsight/Add-AzureRmHDInsightClusterIdentity.md b/azurermps-6.13.0/AzureRM.HDInsight/Add-AzureRmHDInsightClusterIdentity.md deleted file mode 100644 index a6c9f729c1..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/Add-AzureRmHDInsightClusterIdentity.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: A40AB6AB-D3CB-4A6C-B614-0B22085759DA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/add-azurermhdinsightclusteridentity -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightClusterIdentity.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightClusterIdentity.md ---- - -# Add-AzureRmHDInsightClusterIdentity - -## SYNOPSIS -Adds a cluster identity to a cluster configuration object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### CertificateFilePath (Default) -``` -Add-AzureRmHDInsightClusterIdentity [-Config] <AzureHDInsightConfig> [-ObjectId] <Guid> - [-CertificateFilePath] <String> [-CertificatePassword] <String> [[-AadTenantId] <Guid>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### CertificateFileContents -``` -Add-AzureRmHDInsightClusterIdentity [-Config] <AzureHDInsightConfig> [-ObjectId] <Guid> - [-CertificateFileContents] <Byte[]> [-CertificatePassword] <String> [[-AadTenantId] <Guid>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmHDInsightClusterIdentity** cmdlet adds a cluster identity to the Azure HDInsight configuration object created by the New-AzureRmHDInsightClusterConfig cmdlet. - -## EXAMPLES - -### Example 1: Add Cluster Identity info to the cluster configuration object -``` -PS C:\># Primary storage account info -PS C:\> $storageAccountResourceGroupName = "Group" -PS C:\> $storageAccountName = "yourstorageacct001" -PS C:\> $storageAccountKey = (Get-AzureRmStorageAccountKey -ResourceGroupName $storageAccountResourceGroupName -Name $storageAccountName)[0].value -PS C:\> $storageContainer = "container001" - -# Cluster configuration info -PS C:\> $location = "East US 2" -PS C:\> $clusterResourceGroupName = "Group" -PS C:\> $clusterName = "your-hadoop-001" -PS C:\> $clusterCreds = Get-Credential - -# If the cluster's resource group doesn't exist yet, run: -# New-AzureRmResourceGroup -Name $clusterResourceGroupName -Location $location - -# Cluster Identity values -PS C:\> $tenantId = (Get-AzureRmContext).Tenant.TenantId -PS C:\> $objectId = "<Azure AD Service Principal Object ID>" -PS C:\> $certificateFilePath = "<Path to Azure AD Service Principal Certificate>" -PS C:\> $certificatePassword = "<Password for Azure AD Service Principal Certificate>" - -# Create the cluster -PS C:\> New-AzureRmHDInsightClusterConfig ` - | Add-AzureRmHDInsightClusterIdentity ` - -AadTenantId $tenantId ` - -ObjectId $objectId ` - -CertificateFilePath $certificateFilePath ` - -CertificatePassword $certificatePassword ` - | New-AzureRmHDInsightCluster ` - -ClusterType Hadoop ` - -OSType Windows ` - -ClusterSizeInNodes 4 ` - -ResourceGroupName $clusterResourceGroupName ` - -ClusterName $clusterName ` - -HttpCredential $clusterCreds ` - -Location $location ` - -DefaultStorageAccountName "$storageAccountName.blob.core.windows.net" ` - -DefaultStorageAccountKey $storageAccountKey ` - -DefaultStorageContainer $storageAccountContainer -``` - -This command adds Cluster Identity info to the cluster named your-hadoop-001, allowing the cluster to access Azure Data Lake Store. - -## PARAMETERS - -### -AadTenantId -Specifies the Microsoft Entra tenant ID that will be used when accessing Azure Data Lake Store. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CertificateFileContents -Specifies file contents of the certificate that will be used when accessing Azure Data Lake Store. - -```yaml -Type: System.Byte[] -Parameter Sets: CertificateFileContents -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CertificateFilePath -Specifies the file path to the certificate that will be used to authenticate as the Service Principal. -The cluster will use this when accessing Azure Data Lake Store. - -```yaml -Type: System.String -Parameter Sets: CertificateFilePath -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CertificatePassword -Specifies the password for the certificate that will be used to authenticate as the Service Principal. -The cluster will use this when accessing Azure Data Lake Store. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Config -Specifies the HDInsight cluster configuration object that this cmdlet modifies. -This object is created by the New-AzureRmHDInsightClusterConfig cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ObjectId -Specifies the Microsoft Entra object ID (a GUID) of the Microsoft Entra service principal that represents the cluster. -The cluster will use this when accessing Azure Data Lake Store. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig -Parameters: Config (ByValue) - -### System.Guid -Parameters: ObjectId (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig - -## NOTES - -## RELATED LINKS - -[New-AzureRmHDInsightClusterConfig](./New-AzureRmHDInsightClusterConfig.md) diff --git a/azurermps-6.13.0/AzureRM.HDInsight/Add-AzureRmHDInsightComponentVersion.md b/azurermps-6.13.0/AzureRM.HDInsight/Add-AzureRmHDInsightComponentVersion.md deleted file mode 100644 index 2048840424..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/Add-AzureRmHDInsightComponentVersion.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: 774848C9-47A1-4C43-B6FA-B3C0C3C76470 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/add-azurermhdinsightcomponentversion -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightComponentVersion.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightComponentVersion.md ---- - -# Add-AzureRmHDInsightComponentVersion - -## SYNOPSIS -Adds a version for a service running in a cluster to a cluster configuration object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmHDInsightComponentVersion [-Config] <AzureHDInsightConfig> [-ComponentName] <String> - [-ComponentVersion] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The Add-AzureRmHDInsightComponentVersion cmdlet adds a version for a service running in a cluster to the Azure HDInsight configuration object created by the New-AzureRmHDInsightClusterConfig cmdlet. - -## EXAMPLES - -### Example 1: Add a version for Spark to the cluster configuration object. -``` -PS C:\> # Primary storage account info - $storageAccountResourceGroupName = "Group" - $storageAccountName = "yourstorageacct001" - $storageAccountKey = Get-AzureStorageAccountKey ` - -ResourceGroupName $storageAccountResourceGroupName ` - -Name $storageAccountName | %{ $_.Key1 } - $storageContainer = "container001" - - # Cluster configuration info - $location = "East US 2" - $clusterResourceGroupName = "Group" - $clusterName = "your-spark-001" - $clusterCreds = Get-Credential - $sshClusterCreds = Get-Credential - - # If the cluster's resource group doesn't exist yet, run: - # New-AzureRmResourceGroup -Name $clusterResourceGroupName -Location $location - - # Create the cluster - New-AzureRmHDInsightClusterConfig ` - | Add-AzureRmHDInsightComponentVersion ` - -ComponentName "Spark" ` - -ComponentVersion "2.0" ` - | New-AzureRmHDInsightCluster ` - -ClusterType Spark ` - -OSType Linux ` - -ClusterSizeInNodes 4 ` - -ResourceGroupName $clusterResourceGroupName ` - -ClusterName $clusterName ` - -HttpCredential $clusterCreds ` - -Location $location ` - -DefaultStorageAccountName "$storageAccountName.blob.core.contoso.net" ` - -DefaultStorageAccountKey $storageAccountKey ` - -DefaultStorageContainer $storageContainer ` - -SshCredential $sshCredentials ` - -Version "3.5" -``` - -This command adds the version of Spark to the HDInsight cluster named 'your-spark-001'. - -## PARAMETERS - -### -ComponentName -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComponentVersion -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Config -```yaml -Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig -Parameters: Config (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.HDInsight/Add-AzureRmHDInsightConfigValues.md b/azurermps-6.13.0/AzureRM.HDInsight/Add-AzureRmHDInsightConfigValues.md deleted file mode 100644 index 932572c261..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/Add-AzureRmHDInsightConfigValues.md +++ /dev/null @@ -1,408 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: 4C3CF283-DD4F-4D2A-ABEC-84AC7B005D6A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/add-azurermhdinsightconfigvalues -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightConfigValues.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightConfigValues.md ---- - -# Add-AzureRmHDInsightConfigValues - -## SYNOPSIS -Adds a Hadoop configuration value customization and/or a Hive shared library customization to a cluster configuration object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Spark1 -``` -Add-AzureRmHDInsightConfigValues [-Config] <AzureHDInsightConfig> [-Core <Hashtable>] [-HiveSite <Hashtable>] - [-HiveEnv <Hashtable>] [-OozieSite <Hashtable>] [-OozieEnv <Hashtable>] [-WebHCat <Hashtable>] - [-HBaseSite <Hashtable>] [-HBaseEnv <Hashtable>] [-Storm <Hashtable>] [-Yarn <Hashtable>] - [-MapRed <Hashtable>] [-Tez <Hashtable>] [-Hdfs <Hashtable>] [-RServer <Hashtable>] - [-SparkDefaults <Hashtable>] [-SparkThriftConf <Hashtable>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### Spark2 -``` -Add-AzureRmHDInsightConfigValues [-Config] <AzureHDInsightConfig> [-Core <Hashtable>] [-HiveSite <Hashtable>] - [-HiveEnv <Hashtable>] [-OozieSite <Hashtable>] [-OozieEnv <Hashtable>] [-WebHCat <Hashtable>] - [-HBaseSite <Hashtable>] [-HBaseEnv <Hashtable>] [-Storm <Hashtable>] [-Yarn <Hashtable>] - [-MapRed <Hashtable>] [-Tez <Hashtable>] [-Hdfs <Hashtable>] [-RServer <Hashtable>] - [-Spark2Defaults <Hashtable>] [-Spark2ThriftConf <Hashtable>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmHDInsightConfigValues** cmdlet adds a Hadoop configuration value customization, such as core-site.xml or hive-site.xml, and/or a Hive shared library customization to the HDInsight configuration object created by the New-AzureRmHDInsightClusterConfig cmdlet. - -## EXAMPLES - -### Example 1: Add a custom configuration value to the cluster configuration object -``` -PS C:\># Primary storage account info -PS C:\> $storageAccountResourceGroupName = "Group" -PS C:\> $storageAccountName = "yourstorageacct001" -PS C:\> $storageAccountKey = (Get-AzureRmStorageAccountKey -ResourceGroupName $storageAccountResourceGroupName -Name $storageAccountName)[0].value - -PS C:\> $storageContainer = "container001" - -# Cluster configuration info -PS C:\> $location = "East US 2" -PS C:\> $clusterResourceGroupName = "Group" -PS C:\> $clusterName = "your-hadoop-001" -PS C:\> $clusterCreds = Get-Credential - -# If the cluster's resource group doesn't exist yet, run: -# New-AzureRmResourceGroup -Name $clusterResourceGroupName -Location $location - -# Config values -PS C:\> $coreConfigs = @{"io.file.buffer.size"="300000"} -PS C:\> $mapRedConfigs = @{"mapred.map.max.attempts"="2"} - -# Create the cluster -PS C:\> New-AzureRmHDInsightClusterConfig ` - | Add-AzureRmHDInsightConfigValues ` - -Core $coreConfigs ` - -MapRed $mapRedConfigs ` - | New-AzureRmHDInsightCluster ` - -ClusterType Hadoop ` - -OSType Windows ` - -ClusterSizeInNodes 4 ` - -ResourceGroupName $clusterResourceGroupName ` - -ClusterName $clusterName ` - -HttpCredential $clusterCreds ` - -Location $location ` - -DefaultStorageAccountName "$storageAccountName.blob.core.windows.net" ` - -DefaultStorageAccountKey $storageAccountKey ` - -DefaultStorageContainer $storageAccountContainer -``` - -This command adds a Hadoop configuration value to the cluster named your-hadoop-001. - -## PARAMETERS - -### -Config -Specifies the HDInsight cluster configuration object that this cmdlet modifies. -This object is created by the New-AzureRmHDInsightClusterConfig cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Core -Specifies the Core Site configurations of this HDInsight cluster. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HBaseEnv -Specifies the HBase Env configurations of this HDInsight cluster. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HBaseSite -Specifies the HBase Site configurations of this HDInsight cluster. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Hdfs -Specifies the HDFS configurations of this HDInsight cluster. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HiveEnv -Specifies the Hive Env configurations of this HDInsight cluster. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HiveSite -Specifies the Hive Site configurations of this HDInsight cluster. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MapRed -Specifies the MapRed Site configurations of this HDInsight cluster. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OozieEnv -Specifies the Oozie Env configurations of this HDInsight cluster. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OozieSite -Specifies the Oozie Site configurations of this HDInsight cluster. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RServer -Specifies the RServer configurations. Valid only for RServer clusters. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Spark2Defaults -Specifies the Spark2 Defaults configurations of this HDInsight cluster. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: Spark2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Spark2ThriftConf -Specifies the Spark2 Thrift SparkConf configurations of this HDInsight cluster. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: Spark2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SparkDefaults -Specifies the Spark Defaults configurations of this HDInsight cluster. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: Spark1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SparkThriftConf -Specifies the Spark Thrift SparkConf configurations of this HDInsight cluster. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: Spark1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Storm -Specifies the Storm Site configurations of this HDInsight cluster. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tez -Specifies the Tez Site configurations of this HDInsight cluster. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebHCat -Specifies the WebHCat Site configurations of this HDInsight cluster. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Yarn -Specifies the YARN Site configurations of this HDInsight cluster. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig -Parameters: Config (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig - -## NOTES - -## RELATED LINKS - -[New-AzureRmHDInsightClusterConfig](./New-AzureRmHDInsightClusterConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.HDInsight/Add-AzureRmHDInsightMetastore.md b/azurermps-6.13.0/AzureRM.HDInsight/Add-AzureRmHDInsightMetastore.md deleted file mode 100644 index b129de8255..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/Add-AzureRmHDInsightMetastore.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: 8BD3B8BD-DC87-4A94-9FCA-611D11D5E065 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/add-azurermhdinsightmetastore -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightMetastore.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightMetastore.md ---- - -# Add-AzureRmHDInsightMetastore - -## SYNOPSIS -Adds a SQL Database to serve as a Hive or Oozie metastore to a cluster configuration object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmHDInsightMetastore [-Config] <AzureHDInsightConfig> [-MetastoreType] <AzureHDInsightMetastoreType> - [-SqlAzureServerName] <String> [-DatabaseName] <String> [-Credential] <PSCredential> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmHDInsightMetastore** cmdlet adds a Hive or Oozie metastore to the HDInsight configuration object created by the New-AzureRmHDInsightClusterConfig cmdlet. -A metastore is a SQL Database that can used to store metadata for Hive, Oozie, or both. - -## EXAMPLES - -### Example 1: Add a SQL database metastore to the cluster configuration object -``` -PS C:\># Primary storage account info -PS C:\> $storageAccountResourceGroupName = "Group" -PS C:\> $storageAccountName = "yourstorageacct001" -PS C:\> $storageAccountKey = (Get-AzureRmStorageAccountKey -ResourceGroupName $storageAccountResourceGroupName -Name $storageAccountName)[0].value - - -PS C:\> $storageContainer = "container001" - -# Cluster configuration info -PS C:\> $location = "East US 2" -PS C:\> $clusterResourceGroupName = "Group" -PS C:\> $clusterName = "your-hadoop-001" -PS C:\> $clusterCreds = Get-Credential - -# If the cluster's resource group doesn't exist yet, run: -# New-AzureRmResourceGroup -Name $clusterResourceGroupName -Location $location - -# Hive metastore info -PS C:\> $hiveSqlServer = "your-sqlserver-001" -PS C:\> $hiveDb = "your-sqldb-001" -PS C:\> $hiveCreds = Get-Credential - -# Oozie metastore info -PS C:\> $oozieSqlServer = "your-sqlserver-001" -PS C:\> $oozieDb = "your-sqldb-002" -PS C:\> $oozieCreds = Get-Credential - -# Create the cluster -PS C:\> New-AzureRmHDInsightClusterConfig ` - | Add-AzureRmHDInsightMetastore ` - -SqlAzureServerName "$oozieSqlServer.database.contoso.net" ` - -DatabaseName $oozieDb ` - -Credential $oozieCreds ` - -MetastoreType OozieMetastore ` - | Add-AzureRmHDInsightMetastore ` - -SqlAzureServerName "$hiveSqlServer.database.contoso.net" ` - -DatabaseName $hiveDb ` - -Credential $hiveCreds ` - -MetastoreType HiveMetastore ` - | New-AzureRmHDInsightCluster ` - -ClusterType Hadoop ` - -OSType Windows ` - -ClusterSizeInNodes 4 ` - -ResourceGroupName $clusterResourceGroupName ` - -ClusterName $clusterName ` - -HttpCredential $clusterCreds ` - -Location $location ` - -DefaultStorageAccountName "$storageAccountName.blob.core.contoso.net" ` - -DefaultStorageAccountKey $storageAccountKey ` - -DefaultStorageContainer $storageContainer -``` - -This command adds a SQL database metastore to the cluster named your-hadoop-001. - -## PARAMETERS - -### -Config -Specifies the HDInsight cluster configuration object that this cmdlet modifies. -This object is created by the **New-AzureRmHDInsightClusterConfig** cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Credential -Specifies the credentials to use for the AzureSQL Server database. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the database on the AzureSQL Server instance to use for this metastore. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MetastoreType -Specifies the type of metastore. -Possible values are HiveMetastore or OozieMetastore. - -```yaml -Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightMetastoreType -Parameter Sets: (All) -Aliases: -Accepted values: HiveMetastore, OozieMetastore - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SqlAzureServerName -Specifies the AzureSQL Server instance to use for this metastore. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig -Parameters: Config (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig - -## NOTES - -## RELATED LINKS - -[New-AzureRmHDInsightClusterConfig](./New-AzureRmHDInsightClusterConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.HDInsight/Add-AzureRmHDInsightScriptAction.md b/azurermps-6.13.0/AzureRM.HDInsight/Add-AzureRmHDInsightScriptAction.md deleted file mode 100644 index 9f12a9e8ec..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/Add-AzureRmHDInsightScriptAction.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: 8F0634BD-D817-4365-B6D1-924DC36AE4C9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/add-azurermhdinsightscriptaction -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightScriptAction.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightScriptAction.md ---- - -# Add-AzureRmHDInsightScriptAction - -## SYNOPSIS -Adds a script action to a cluster configuration object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmHDInsightScriptAction [-Config] <AzureHDInsightConfig> [-NodeType] <ClusterNodeType> [-Uri] <Uri> - [-Name] <String> [[-Parameters] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmHDInsightScriptAction** cmdlet adds script actions to the HDInsight configuration object created by the New-AzureRmHDInsightClusterConfig cmdlet. -Script actions provide functionality that is used to install additional software or to change the configuration of applications that run on a Hadoop cluster by using Windows PowerShell or Bash scripts (for Windows or Linux clusters, respectively). -A script action runs on the cluster nodes when HDInsight clusters are deployed, and they run after nodes in the cluster complete HDInsight configuration. -The script action runs under system administrator account privileges and provides full access rights to the cluster nodes. -You can provide each cluster with a list of script actions to run in a specified sequence. - -## EXAMPLES - -### Example 1: Add a script action to the cluster configuration object -``` -PS C:\># Primary storage account info -PS C:\> $storageAccountResourceGroupName = "Group" -PS C:\> $storageAccountName = "yourstorageacct001" -PS C:\> $storageAccountKey = (Get-AzureRmStorageAccountKey -ResourceGroupName $storageAccountResourceGroupName -Name $storageAccountName)[0].value - - -PS C:\> $storageContainer = "container001" - -# Script action info -PS C:\> $scriptActionName = "<script action name>" -PS C:\> $scriptActionURI = "<script action URI>" -PS C:\> $scriptActionParameters = "<script action parameters>" - -# Cluster configuration info -PS C:\> $location = "East US 2" -PS C:\> $clusterResourceGroupName = "Group" -PS C:\> $clusterName = "your-hadoop-001" -PS C:\> $clusterCreds = Get-Credential - -# If the cluster's resource group doesn't exist yet, run: -# New-AzureRmResourceGroup -Name $clusterResourceGroupName -Location $location - -# Create the cluster -PS C:\> New-AzureRmHDInsightClusterConfig ` - | Add-AzureRmHDInsightScriptAction ` - -Name $scriptActionName ` - -Uri $scriptActionURI ` - -Parameters $scriptActionParameters ` - -NodeType Worker ` - | Add-AzureRmHDInsightScriptAction ` - -Name $scriptActionName ` - -Uri $scriptActionURI ` - -Parameters $scriptActionParameters ` - -NodeType Head ` - | New-AzureRmHDInsightCluster ` - -ClusterType Hadoop ` - -OSType Windows ` - -ClusterSizeInNodes 4 ` - -ResourceGroupName $clusterResourceGroupName ` - -ClusterName $clusterName ` - -HttpCredential $clusterCreds ` - -Location $location ` - -DefaultStorageAccountName "$storageAccountName.blob.core.contoso.net" ` - -DefaultStorageAccountKey $storageAccountKey ` - -DefaultStorageContainer $storageContainer -``` - -This command adds a script action for the Head and Worker nodes of the your-hadoop-001 cluster, to be run at the end of cluster creation. - -## PARAMETERS - -### -Config -Specifies the HDInsight cluster configuration object that this cmdlet modifies. -This object is created by the **New-AzureRmHDInsightClusterConfig** cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the script action. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NodeType -Specifies the node type on which to run the script action. -The acceptable values for this parameter are: -- HeadNode -- WorkerNode -- ZookeeperNode - -```yaml -Type: Microsoft.Azure.Management.HDInsight.Models.ClusterNodeType -Parameter Sets: (All) -Aliases: -Accepted values: HeadNode, WorkerNode, ZookeeperNode, EdgeNode - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Parameters -Specifies the parameters for the script action. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Uri -Specifies the public URI for the script action (a PowerShell or Bash script). - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig -Parameters: Config (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig - -## NOTES - -## RELATED LINKS - -[New-AzureRmHDInsightClusterConfig](./New-AzureRmHDInsightClusterConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.HDInsight/Add-AzureRmHDInsightSecurityProfile.md b/azurermps-6.13.0/AzureRM.HDInsight/Add-AzureRmHDInsightSecurityProfile.md deleted file mode 100644 index 8a4de17a44..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/Add-AzureRmHDInsightSecurityProfile.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: FB37494B-4035-45B7-88AB-DF33CEEF0D0A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/add-azurermhdinsightsecurityprofile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightSecurityProfile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightSecurityProfile.md ---- - -# Add-AzureRmHDInsightSecurityProfile - -## SYNOPSIS -Adds a security profileto a cluster configuration object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmHDInsightSecurityProfile [-Config] <AzureHDInsightConfig> -Domain <String> - -DomainUserCredential <PSCredential> -OrganizationalUnitDN <String> -LdapsUrls <String[]> - [-ClusterUsersGroupDNs <String[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Security profile is used to create a secure cluster by kerberizing it. -Security profile contains configuration related joining the cluster to Active Directory Domain. - -## EXAMPLES - -### Example 1 -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -ClusterUsersGroupDNs -Distinguished names of the Active Directory groups that will be available in Ambari and Ranger - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Config -Specifies the HDInsight cluster configuration object that this cmdlet modifies. -This object is created by the New-AzureRmHDInsightClusterConfig cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -Active Directory domain for the cluster - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainUserCredential -A domain user account credential with sufficient permissions for creating the cluster. -Username should be in user@domain format - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LdapsUrls -Urls of one or multiple LDAPS servers for the Active Directory - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationalUnitDN -Distinguished name of the organizational unit in the Active directory where user and computer accounts will be created - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig -Parameters: Config (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightSecurityProfile - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.HDInsight/Add-AzureRmHDInsightStorage.md b/azurermps-6.13.0/AzureRM.HDInsight/Add-AzureRmHDInsightStorage.md deleted file mode 100644 index 6c5e91df57..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/Add-AzureRmHDInsightStorage.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: 2C2AF43D-18BF-4036-A355-FC27E406B18A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/add-azurermhdinsightstorage -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightStorage.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightStorage.md ---- - -# Add-AzureRmHDInsightStorage - -## SYNOPSIS -Adds an Azure Storage key to a cluster configuration object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmHDInsightStorage [-Config] <AzureHDInsightConfig> [-StorageAccountName] <String> - [-StorageAccountKey] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmHDInsightStorage** cmdlet adds an Azure Storage account entry to the Azure HDInsight configuration object created by the New-AzureRmHDInsightClusterConfig cmdlet. - -## EXAMPLES - -### Example 1: Add an Azure storage key to the cluster configuration object -``` -PS C:\># Primary storage account info -PS C:\> $storageAccountResourceGroupName = "Group" -PS C:\> $storageAccountName = "yourstorageacct001" -PS C:\> $storageAccountKey = (Get-AzureRmStorageAccountKey -ResourceGroupName $storageAccountResourceGroupName -Name $storageAccountName)[0].value - - -PS C:\> $storageContainer = "container001" - -# Cluster configuration info -PS C:\> $location = "East US 2" -PS C:\> $clusterResourceGroupName = "Group" -PS C:\> $clusterName = "your-hadoop-001" -PS C:\> $clusterCreds = Get-Credential - -# If the cluster's resource group doesn't exist yet, run: -# New-AzureRmResourceGroup -Name $clusterResourceGroupName -Location $location - -# Second storage account info -PS C:\> $secondStorageAccountResourceGroupName = "Group" -PS C:\> $secondStorageAccountName = "yourstorageacct002" -PS C:\> $secondStorageAccountKey = Get-AzureRmStorageAccountKey ` -PS C:\> -ResourceGroupName $secondStorageAccountResourceGroupName ` - -Name $secondStorageAccountName | %{ $_.Key1 } - -# Create the cluster -PS C:\> New-AzureRmHDInsightClusterConfig ` - | Add-AzureRmHDInsightStorage ` - -StorageAccountName "$secondStorageAccountName.blob.core.contoso.net" ` - -StorageAccountKey $key2 ` - | New-AzureRmHDInsightCluster ` - -ClusterType Hadoop ` - -OSType Windows ` - -ClusterSizeInNodes 4 ` - -ResourceGroupName $clusterResourceGroupName ` - -ClusterName $clusterName ` - -HttpCredential $clusterCreds ` - -Location $location ` - -DefaultStorageAccountName "$storageAccountName.blob.core.contoso.net" ` - -DefaultStorageAccountKey $storageAccountKey ` - -DefaultStorageContainer $storageContainer -``` - -This command adds an blob storage account entry to the HDInsight configuration named your-hadoop-001. - -## PARAMETERS - -### -Config -Specifies the HDInsight cluster configuration object that this cmdlet modifies. -This object is created by the **New-AzureRmHDInsightClusterConfig** cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageAccountKey -Specifies the storage account key for the storage account to be added to the new cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageAccountName -Specifies the storage account name for the storage account to be added to the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig -Parameters: Config (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig - -## NOTES - -## RELATED LINKS - -[New-AzureRmHDInsightClusterConfig](./New-AzureRmHDInsightClusterConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.HDInsight/AzureRM.HDInsight.md b/azurermps-6.13.0/AzureRM.HDInsight/AzureRM.HDInsight.md deleted file mode 100644 index 1c2d83061b..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/AzureRM.HDInsight.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -Module Name: AzureRM.HDInsight -Module Guid: 3fd1475f-cb23-4ffb-bf08-33d94b7d1acb -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight -Help Version: 4.1.2.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/AzureRM.HDInsight.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/AzureRM.HDInsight.md ---- - -# AzureRM.HDInsight Module -## Description -The topics in this section document the Azure PowerShell cmdlets for Microsoft Azure HDInsight in the Azure Resource Manager (ARM) framework. These cmdlets are used to manage HDInsight clusters and the jobs that run on them. The cmdlets exist in the Microsoft.Azure.Commands.HDInsight namespace. - -## AzureRM.HDInsight Cmdlets -### [Add-AzureRmHDInsightClusterIdentity](Add-AzureRmHDInsightClusterIdentity.md) -Adds a cluster identity to a cluster configuration object. - -### [Add-AzureRmHDInsightComponentVersion](Add-AzureRmHDInsightComponentVersion.md) -Adds a version for a service running in a cluster to a cluster configuration object. - -### [Add-AzureRmHDInsightConfigValues](Add-AzureRmHDInsightConfigValues.md) -Adds a Hadoop configuration value customization and/or a Hive shared library customization to a cluster configuration object. - -### [Add-AzureRmHDInsightMetastore](Add-AzureRmHDInsightMetastore.md) -Adds a SQL Database to serve as a Hive or Oozie metastore to a cluster configuration object. - -### [Add-AzureRmHDInsightScriptAction](Add-AzureRmHDInsightScriptAction.md) -Adds a script action to a cluster configuration object. - -### [Add-AzureRmHDInsightSecurityProfile](Add-AzureRmHDInsightSecurityProfile.md) -Adds a security profileto a cluster configuration object. - -### [Add-AzureRmHDInsightStorage](Add-AzureRmHDInsightStorage.md) -Adds an Azure Storage key to a cluster configuration object. - -### [Disable-AzureRmHDInsightOperationsManagementSuite](Disable-AzureRmHDInsightOperationsManagementSuite.md) -Disables Operations Management Suite (OMS) in a HDInsight cluster and relevant logs will stop flowing to the OMS workspace specified during enable. - -### [Enable-AzureRmHDInsightOperationsManagementSuite](Enable-AzureRmHDInsightOperationsManagementSuite.md) -Enables Operations Management Suite (OMS) in a HDInsight cluster and relevant logs will be sent to the OMS workspace specified during enable. - -### [Get-AzureRmHDInsightCluster](Get-AzureRmHDInsightCluster.md) -Gets and lists all of the Azure HDInsight clusters associated with the current subscription or a specified resource group, or retrieves a specific cluster. - -### [Get-AzureRmHDInsightJob](Get-AzureRmHDInsightJob.md) -Gets the list of jobs from a cluster and lists them in reverse chronological order, or retrieves a specific job. - -### [Get-AzureRmHDInsightJobOutput](Get-AzureRmHDInsightJobOutput.md) -Gets the log output for a job from the storage account associated with a specified cluster. - -### [Get-AzureRmHDInsightOperationsManagementSuite](Get-AzureRmHDInsightOperationsManagementSuite.md) -Gets the status of Operations Management Suite (OMS) installation on the cluster. - -### [Get-AzureRmHDInsightPersistedScriptAction](Get-AzureRmHDInsightPersistedScriptAction.md) -Gets the persisted script actions for a cluster and lists them in chronological order, or gets details for a specified persisted script action. - -### [Get-AzureRmHDInsightProperties](Get-AzureRmHDInsightProperties.md) -Gets properties about the HDInsight service, such as available locations and capacity. - -### [Get-AzureRmHDInsightScriptActionHistory](Get-AzureRmHDInsightScriptActionHistory.md) -Gets the script action history for a cluster and lists it in reverse chronological order, or gets details of a previously executed script action. - -### [Grant-AzureRmHDInsightHttpServicesAccess](Grant-AzureRmHDInsightHttpServicesAccess.md) -Grants HTTP access to the cluster. - -### [Grant-AzureRmHDInsightRdpServicesAccess](Grant-AzureRmHDInsightRdpServicesAccess.md) -Grants RDP access to the Windows cluster. - -### [Invoke-AzureRmHDInsightHiveJob](Invoke-AzureRmHDInsightHiveJob.md) -Submits a Hive query to an HDInsight cluster and retrieves query results in one operation. - -### [New-AzureRmHDInsightCluster](New-AzureRmHDInsightCluster.md) -Creates an Azure HDInsight cluster in the specified resource group for the current subscription. - -### [New-AzureRmHDInsightClusterConfig](New-AzureRmHDInsightClusterConfig.md) -Creates a non-persisted cluster configuration object that describes an Azure HDInsight cluster configuration. - -### [New-AzureRmHDInsightHiveJobDefinition](New-AzureRmHDInsightHiveJobDefinition.md) -Creates a Hive job object. - -### [New-AzureRmHDInsightMapReduceJobDefinition](New-AzureRmHDInsightMapReduceJobDefinition.md) -Creates a MapReduce job object. - -### [New-AzureRmHDInsightPigJobDefinition](New-AzureRmHDInsightPigJobDefinition.md) -Creates a Pig job object. - -### [New-AzureRmHDInsightSqoopJobDefinition](New-AzureRmHDInsightSqoopJobDefinition.md) -Creates a Sqoop job object. - -### [New-AzureRmHDInsightStreamingMapReduceJobDefinition](New-AzureRmHDInsightStreamingMapReduceJobDefinition.md) -Creates a Streaming MapReduce job object. - -### [Remove-AzureRmHDInsightCluster](Remove-AzureRmHDInsightCluster.md) -Removes the specified HDInsight cluster from the current subscription. - -### [Remove-AzureRmHDInsightPersistedScriptAction](Remove-AzureRmHDInsightPersistedScriptAction.md) -Removes an persisted script action from an HDInsight cluster. - -### [Revoke-AzureRmHDInsightHttpServicesAccess](Revoke-AzureRmHDInsightHttpServicesAccess.md) -Disables HTTP access to the cluster. - -### [Revoke-AzureRmHDInsightRdpServicesAccess](Revoke-AzureRmHDInsightRdpServicesAccess.md) -Disables RDP access to a Windows cluster. - -### [Set-AzureRmHDInsightClusterSize](Set-AzureRmHDInsightClusterSize.md) -Sets the number of Worker nodes in a specified cluster. - -### [Set-AzureRmHDInsightDefaultStorage](Set-AzureRmHDInsightDefaultStorage.md) -Sets the default Storage account setting in a cluster configuration object. - -### [Set-AzureRmHDInsightPersistedScriptAction](Set-AzureRmHDInsightPersistedScriptAction.md) -Sets a previously executed script action to be a persisted script action. - -### [Start-AzureRmHDInsightJob](Start-AzureRmHDInsightJob.md) -Starts a defined Azure HDInsight job on a specified cluster. - -### [Stop-AzureRmHDInsightJob](Stop-AzureRmHDInsightJob.md) -Stops a specified running job on a cluster. - -### [Submit-AzureRmHDInsightScriptAction](Submit-AzureRmHDInsightScriptAction.md) -Submits a new script action to an Azure HDInsight cluster. - -### [Use-AzureRmHDInsightCluster](Use-AzureRmHDInsightCluster.md) -Selects a cluster to be used with the Invoke-RmAzureHDInsightHiveJob cmdlet. - -### [Wait-AzureRmHDInsightJob](Wait-AzureRmHDInsightJob.md) -Waits for the completion or failure of a specified job. - diff --git a/azurermps-6.13.0/AzureRM.HDInsight/Disable-AzureRmHDInsightOperationsManagementSuite.md b/azurermps-6.13.0/AzureRM.HDInsight/Disable-AzureRmHDInsightOperationsManagementSuite.md deleted file mode 100644 index 507f9ba487..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/Disable-AzureRmHDInsightOperationsManagementSuite.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/disable-azurermhdinsightoperationsmanagementsuite -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Disable-AzureRmHDInsightOperationsManagementSuite.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Disable-AzureRmHDInsightOperationsManagementSuite.md ---- - -# Disable-AzureRmHDInsightOperationsManagementSuite - -## SYNOPSIS -Disables Operations Management Suite (OMS) in a HDInsight cluster and relevant logs will stop flowing to the OMS workspace specified during enable. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Disable-AzureRmHDInsightOperationsManagementSuite [-Name] <String> [-ResourceGroupName <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Disable-AzureRmHDInsightOperationsManagementSuite** cmdlet disables Operations Management Suite (OMS) in a Azure HDInsight cluster. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Disable-AzureRmHDInsightOMS -Name testcluster - -ErrorInfo : - -State : Succeeded - -RequestId : 1417ad86-d055-48cd-9d68-a5c19a212a3a - -StatusCode : OK -``` - -Operations Management Suite (OMS) will be disabled on the HDInsight cluster and relevant logs will stop flowing to the OMS workspace. - -### Example 2 -``` -PS C:\> Disable-AzureRmHDInsightOMS -Name testcluster -ResourceGroupName testrg - -ErrorInfo : - -State : Succeeded - -RequestId : 1417ad86-d055-48cd-9d68-a5c19a212a3a - -StatusCode : OK -``` - -Operations Management Suite (OMS) will be disabled on the HDInsight cluster and relevant logs will stop flowing to the OMS workspace. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the cluster to disable Operations Management Suite(OMS). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ClusterName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.HDInsight.Models.OperationResource - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.HDInsight/Enable-AzureRmHDInsightOperationsManagementSuite.md b/azurermps-6.13.0/AzureRM.HDInsight/Enable-AzureRmHDInsightOperationsManagementSuite.md deleted file mode 100644 index fde9983d06..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/Enable-AzureRmHDInsightOperationsManagementSuite.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/enable-azurermhdinsightoperationsmanagementsuite -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Enable-AzureRmHDInsightOperationsManagementSuite.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Enable-AzureRmHDInsightOperationsManagementSuite.md ---- - -# Enable-AzureRmHDInsightOperationsManagementSuite - -## SYNOPSIS -Enables Operations Management Suite (OMS) in a HDInsight cluster and relevant logs will be sent to the OMS workspace specified during enable. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Enable-AzureRmHDInsightOperationsManagementSuite [-Name] <String> [-WorkspaceId] <String> - [-PrimaryKey] <String> [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Enable-AzureRmHDInsightOperationsManagementSuite** cmdlet enables Operations Management Suite (OMS) in a Azure HDInsight cluster. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Enable-AzureRmHDInsightOMS -Name testcluster -WorkspaceId 1d364e89-bb71-4503-aa3d-a23535aea7bd -PrimaryKey <key for workspace 1d364e89-bb71-4503-aa3d-a23535aea7bd> - -ErrorInfo : - -State : Succeeded - -RequestId : 1417ad86-d055-48cd-9d68-a5c19a212a3a - -StatusCode : OK -``` - -Operations Management Suite (OMS) will be enabled on the HDInsight cluster and relevant logs will be sent to the OMS workspace with id 1d364e89-bb71-4503-aa3d-a23535aea7bd - -### Example 2 -``` -PS C:\> Enable-AzureRmHDInsightOMS -Name testcluster -ResourceGroupName testrg -WorkspaceId 1d364e89-bb71-4503-aa3d-a23535aea7bd -PrimaryKey <key for workspace 1d364e89-bb71-4503-aa3d-a23535aea7bd> - -ErrorInfo : - -State : Succeeded - -RequestId : 1417ad86-d055-48cd-9d68-a5c19a212a3a - -StatusCode : OK -``` - -Operations Management Suite (OMS) will be enabled on the HDInsight cluster and relevant logs will be sent to the OMS workspace with id 1d364e89-bb71-4503-aa3d-a23535aea7bd - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the cluster to enable Operations Management Suite(OMS). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ClusterName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PrimaryKey -The primary key of the Operations Management Suite(OMS) workspace. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WorkspaceId -The id of the Operations Management Suite(OMS) workspace. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.HDInsight.Models.OperationResource - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.HDInsight/Get-AzureRmHDInsightCluster.md b/azurermps-6.13.0/AzureRM.HDInsight/Get-AzureRmHDInsightCluster.md deleted file mode 100644 index f4a8ba0d2d..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/Get-AzureRmHDInsightCluster.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: FA154E07-EA26-4688-986E-C53C3A9E4F06 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/get-azurermhdinsightcluster -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightCluster.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightCluster.md ---- - -# Get-AzureRmHDInsightCluster - -## SYNOPSIS -Gets and lists all of the Azure HDInsight clusters associated with the current subscription or a specified resource group, or retrieves a specific cluster. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmHDInsightCluster [[-ResourceGroupName] <String>] [[-ClusterName] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmHDInsightCluster** cmdlet lists the Azure HDInsight service clusters for the current subscription. -Use the *ClusterName* parameter to get details for a specific cluster. - -## EXAMPLES - -### Example 1: List all Azure HDInsight clusters -``` -PS C:\>Get-AzureRmHDInsightCluster -``` - -This command lists all the Azure HDInsight clusters. - -## PARAMETERS - -### -ClusterName -Specifies the name of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightCluster - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmHDInsightCluster](./Remove-AzureRmHDInsightCluster.md) - -[Use-AzureRmHDInsightCluster](./Use-AzureRmHDInsightCluster.md) - - diff --git a/azurermps-6.13.0/AzureRM.HDInsight/Get-AzureRmHDInsightJob.md b/azurermps-6.13.0/AzureRM.HDInsight/Get-AzureRmHDInsightJob.md deleted file mode 100644 index b4ca8a4d1a..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/Get-AzureRmHDInsightJob.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: AFE90092-8B25-4897-8D3A-3E732CC5CBA6 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/get-azurermhdinsightjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightJob.md ---- - -# Get-AzureRmHDInsightJob - -## SYNOPSIS -Gets the list of jobs from a cluster and lists them in reverse chronological order, or retrieves a specific job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmHDInsightJob [-ClusterName] <String> [-HttpCredential] <PSCredential> [[-JobId] <String>] - [-NumOfJobs <Int32>] [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmHDInsightJob** cmdlet gets recent jobs for a specified Azure HDInsight cluster in reverse chronological order, with the most recent job at the top of the list. -Get a specific job by providing the *JobId* parameter. - -## EXAMPLES - -### Example 1: Get recent jobs for a specified Azure HDInsight cluster -``` -PS C:\># Cluster info -PS C:\> $clusterName = "your-hadoop-001" -PS C:\> $clusterCreds = Get-Credential - -# Hive job details -PS C:\> $statusFolder = "tempStatusFolder/" -PS C:\> $query = "SHOW TABLES" - -PS C:\> New-AzureRmHDInsightHiveJobDefinition -StatusFolder $statusFolder ` - -Query $query ` - | Start-AzureRmHDInsightJob -ClusterName $clusterName ` - -ClusterCredential $clusterCreds ` - | Get-AzureRmHDInsightJob -ClusterName $clusterName ` - -ClusterCredential $clusterCreds -``` - -This command gets all recent jobs for the cluster named your-hadoop-001. - -## PARAMETERS - -### -ClusterName -Specifies the name of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpCredential -Specifies the cluster login (HTTP) credentials for the cluster. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: ClusterCredential - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobId -Specifies the job ID of the job to get. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumOfJobs -Specifies the number of jobs to retrieve. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightJob - -## NOTES - -## RELATED LINKS - -[New-AzureRmHDInsightHiveJobDefinition](./New-AzureRmHDInsightHiveJobDefinition.md) - -[Start-AzureRmHDInsightJob](./Start-AzureRmHDInsightJob.md) - -[Stop-AzureRmHDInsightJob](./Stop-AzureRmHDInsightJob.md) - -[Wait-AzureRmHDInsightJob](./Wait-AzureRmHDInsightJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.HDInsight/Get-AzureRmHDInsightJobOutput.md b/azurermps-6.13.0/AzureRM.HDInsight/Get-AzureRmHDInsightJobOutput.md deleted file mode 100644 index bbb1cff8f8..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/Get-AzureRmHDInsightJobOutput.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: 5871C962-27D7-4EC8-927E-D4CAE5F23C58 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/get-azurermhdinsightjoboutput -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightJobOutput.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightJobOutput.md ---- - -# Get-AzureRmHDInsightJobOutput - -## SYNOPSIS -Gets the log output for a job from the storage account associated with a specified cluster. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmHDInsightJobOutput [-ClusterName] <String> [-JobId] <String> [[-DefaultContainer] <String>] - [[-DefaultStorageAccountName] <String>] [[-DefaultStorageAccountKey] <String>] - [-HttpCredential] <PSCredential> [-ResourceGroupName <String>] [-DisplayOutputType <JobDisplayOutputType>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmHDInsightJobOutput** cmdlet gets the log output for a job from the Storage account associated with an Azure HDInsight cluster. - -## EXAMPLES - -### Example 1: Get the log output for a job -``` -PS C:\># Cluster info -PS C:\> $clusterName = "your-hadoop-001" -PS C:\> $clusterCreds = Get-Credential - -# Hive job details -PS C:\> $statusFolder = "<status folder>" -PS C:\> $query = "<query here>" - -PS C:\> New-AzureRmHDInsightHiveJobDefinition -StatusFolder $statusFolder ` - -Query $query ` - | Start-AzureRmHDInsightJob ` - -ClusterName $clusterName ` - -ClusterCredential $clusterCreds ` - | Get-AzureRmHDInsightJobOutput ` - -ClusterName $clusterName ` - -ClusterCredential $clusterCreds -``` - -This command gets the log output from the cluster named your-hadoop-001. - -## PARAMETERS - -### -ClusterName -Specifies the name of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultContainer -Specifies the default container name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultStorageAccountKey -Specifies the default Storage account key. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultStorageAccountName -Specifies the default Storage account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayOutputType -Specifies the job output type being requested. -The acceptable values for this parameter are: -- StandardOutput -- StandardError - -```yaml -Type: Microsoft.Azure.Commands.HDInsight.Models.Job.JobDisplayOutputType -Parameter Sets: (All) -Aliases: -Accepted values: StandardOutput, StandardError - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpCredential -Specifies the cluster login (HTTP) credentials for the cluster. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: ClusterCredential - -Required: True -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobId -Specifies the job ID of the job whose output will be fetched. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[New-AzureRmHDInsightHiveJobDefinition](./New-AzureRmHDInsightHiveJobDefinition.md) - -[Start-AzureRmHDInsightJob](./Start-AzureRmHDInsightJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.HDInsight/Get-AzureRmHDInsightOperationsManagementSuite.md b/azurermps-6.13.0/AzureRM.HDInsight/Get-AzureRmHDInsightOperationsManagementSuite.md deleted file mode 100644 index 7294f4d172..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/Get-AzureRmHDInsightOperationsManagementSuite.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/get-azurermhdinsightoperationsmanagementsuite -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightOperationsManagementSuite.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightOperationsManagementSuite.md ---- - -# Get-AzureRmHDInsightOperationsManagementSuite - -## SYNOPSIS -Gets the status of Operations Management Suite (OMS) installation on the cluster. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmHDInsightOperationsManagementSuite [-Name] <String> [-ResourceGroupName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmHDInsightOperationsManagementSuite** cmdlet gets the status of OMS installation in an Azure HDInsight cluster. If OMS is enabled then it will also return the OMS workspace id. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmHDInsightOMS -Name testcluster - -ClusterMonitoringEnabled - -{'ClusterMonitoringEnabled':'true', 'workspaceId':'1d364e89-bb71-4503-aa3d-a23535aea7bd'} -``` - -Operations Management Suite (OMS) is enabled on the cluster because the ClusterMonitoringEnabled property is true. The OMS workspace id where the logs are flowing is 1d364e89-bb71-4503-aa3d-a23535aea7bd - -### Example 2 -``` -PS C:\> Get-AzureRmHDInsightOMS -Name testcluster -ResourceGroupName testrg - -ClusterMonitoringEnabled - -{'ClusterMonitoringEnabled':'true', 'workspaceId':'1d364e89-bb71-4503-aa3d-a23535aea7bd'} -``` - -Operations Management Suite (OMS) is enabled on the cluster because the ClusterMonitoringEnabled property is true. The OMS workspace id where the logs are flowing is 1d364e89-bb71-4503-aa3d-a23535aea7bd - -### Example 3 -``` -PS C:\> Get-AzureRmHDInsightOMS -Name testcluster - -ClusterMonitoringEnabled - -{'ClusterMonitoringEnabled':'false'} -``` - -Operations Management Suite (OMS) is disabled on the cluster because the ClusterMonitoringEnabled property is false. - -### Example 4 -``` -PS C:\> Get-AzureRmHDInsightOMS -Name testcluster -ResourceGroupName testrg - -ClusterMonitoringEnabled - -{'ClusterMonitoringEnabled':'false'} -``` - -Operations Management Suite (OMS) is disabled on the cluster because the ClusterMonitoringEnabled property is false. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the cluster to get the status of Operations Management Suite(OMS). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ClusterName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.HDInsight.Models.Management.AzureHDInsightOMS - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.HDInsight/Get-AzureRmHDInsightPersistedScriptAction.md b/azurermps-6.13.0/AzureRM.HDInsight/Get-AzureRmHDInsightPersistedScriptAction.md deleted file mode 100644 index 252f6a1a78..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/Get-AzureRmHDInsightPersistedScriptAction.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: 2B7C1B83-EEEA-4BD1-9E9B-1F3070295995 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/get-azurermhdinsightpersistedscriptaction -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightPersistedScriptAction.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightPersistedScriptAction.md ---- - -# Get-AzureRmHDInsightPersistedScriptAction - -## SYNOPSIS -Gets the persisted script actions for a cluster and lists them in chronological order, or gets details for a specified persisted script action. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmHDInsightPersistedScriptAction [-ClusterName] <String> [[-Name] <String>] - [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmHDInsightPersistedScriptAction** cmdlet gets the persisted script actions for an Azure HDInsight cluster and lists them in chronological order, or gets details for a specified persisted script action. - -## EXAMPLES - -### Example 1: Get the persisted script actions on a cluster -``` -PS C:\>Get-AzureRmHDInsightPersistedScriptAction -ClusterName "your-hadoop-001" -``` - -This command gets persisted script actions on the cluster named your-hadoop-001. - -## PARAMETERS - -### -ClusterName -Specifies the name of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the persisted script action. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.HDInsight.Models.Management.AzureHDInsightRuntimeScriptAction - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmHDInsightPersistedScriptAction](./Remove-AzureRmHDInsightPersistedScriptAction.md) - -[Set-AzureRmHDInsightPersistedScriptAction](./Set-AzureRmHDInsightPersistedScriptAction.md) - - diff --git a/azurermps-6.13.0/AzureRM.HDInsight/Get-AzureRmHDInsightProperties.md b/azurermps-6.13.0/AzureRM.HDInsight/Get-AzureRmHDInsightProperties.md deleted file mode 100644 index 83f4b7d980..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/Get-AzureRmHDInsightProperties.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: 606C5453-F841-4574-95F8-5CC29A4186E1 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/get-azurermhdinsightproperties -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightProperties.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightProperties.md ---- - -# Get-AzureRmHDInsightProperties - -## SYNOPSIS -Gets properties about the HDInsight service, such as available locations and capacity. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmHDInsightProperties [-Location] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmHDInsightProperties** cmdlet gets properties specific to Azure HDInsight, such as the list of available locations, HDInsight cluster versions, and available compute capacity. - -## EXAMPLES - -### Example 1: Get the properties of an Azure HDInsight cluster -``` -PS C:\>Get-AzureRmHDInsightProperties -Location "East US 2" -``` - -This command gets properties from an HDInsight service from location East US 2. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location for which to fetch HDInsight properties. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Management.HDInsight.Models.CapabilitiesResponse - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.HDInsight/Get-AzureRmHDInsightScriptActionHistory.md b/azurermps-6.13.0/AzureRM.HDInsight/Get-AzureRmHDInsightScriptActionHistory.md deleted file mode 100644 index 484adb1019..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/Get-AzureRmHDInsightScriptActionHistory.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: CE690DB0-0CD4-4841-B219-C208173D4730 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/get-azurermhdinsightscriptactionhistory -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightScriptActionHistory.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightScriptActionHistory.md ---- - -# Get-AzureRmHDInsightScriptActionHistory - -## SYNOPSIS -Gets the script action history for a cluster and lists it in reverse chronological order, or gets details of a previously executed script action. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmHDInsightScriptActionHistory [-ClusterName] <String> [[-ScriptExecutionId] <Int64>] - [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmHDInsightScriptActionHistory** cmdlet gets the script action history for an Azure HDInsight cluster and lists it in reverse chronological order, or gets details of a previously executed script action. - -## EXAMPLES - -### Example 1: Get the history of script actions executions for a cluster -``` -PS C:\>Get-AzureRmHDInsightScriptActionHistory -ClusterName "your-hadoop-001" -``` - -This command gets the history of script actions for the cluster your-hadoop-001. - -## PARAMETERS - -### -ClusterName -Specifies the name of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScriptExecutionId -Specifies the execution ID of the executed script action. - -```yaml -Type: System.Nullable`1[System.Int64] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.HDInsight.Models.Management.AzureHDInsightRuntimeScriptActionDetail - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.HDInsight/Grant-AzureRmHDInsightHttpServicesAccess.md b/azurermps-6.13.0/AzureRM.HDInsight/Grant-AzureRmHDInsightHttpServicesAccess.md deleted file mode 100644 index 0652e19a4a..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/Grant-AzureRmHDInsightHttpServicesAccess.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: 3F321D94-2B0B-48CA-9778-8090373F7FE0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/grant-azurermhdinsighthttpservicesaccess -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Grant-AzureRmHDInsightHttpServicesAccess.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Grant-AzureRmHDInsightHttpServicesAccess.md ---- - -# Grant-AzureRmHDInsightHttpServicesAccess - -## SYNOPSIS -Grants HTTP access to the cluster. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Grant-AzureRmHDInsightHttpServicesAccess [-ClusterName] <String> [-HttpCredential] <PSCredential> - [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Grant-AzureRmHDInsightHttpServicesAccess** cmdlet grants HTTP access to an Azure HDInsight cluster using ODBC, Ambari, Oozie and web services. - -## EXAMPLES - -### Example 1: Grant HTTP access to an Azure HDInsight cluster -``` -PS C:\># Cluster info -PS C:\> $clusterName = "your-hadoop-001" -PS C:\> $clusterCreds = Get-Credential - -PS C:\> Grant-AzureRmHDInsightHttpServicesAccess ` - -ClusterName $clusterName ` - -HttpCredential $newClusterCreds -``` - -This command grants HTTP access to the cluster named your-hadoop-001. - -## PARAMETERS - -### -ClusterName -Specifies the name of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpCredential -Specifies the cluster login (HTTP) credentials for the cluster. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Management.HDInsight.Models.HttpConnectivitySettings - -## NOTES - -## RELATED LINKS - -[Revoke-AzureRmHDInsightHttpServicesAccess](./Revoke-AzureRmHDInsightHttpServicesAccess.md) - - diff --git a/azurermps-6.13.0/AzureRM.HDInsight/Grant-AzureRmHDInsightRdpServicesAccess.md b/azurermps-6.13.0/AzureRM.HDInsight/Grant-AzureRmHDInsightRdpServicesAccess.md deleted file mode 100644 index ecc304610c..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/Grant-AzureRmHDInsightRdpServicesAccess.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: 6288DD8A-FF23-4B12-A065-856DBAE200E8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/grant-azurermhdinsightrdpservicesaccess -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Grant-AzureRmHDInsightRdpServicesAccess.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Grant-AzureRmHDInsightRdpServicesAccess.md ---- - -# Grant-AzureRmHDInsightRdpServicesAccess - -## SYNOPSIS -Grants RDP access to the Windows cluster. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Grant-AzureRmHDInsightRdpServicesAccess [-ClusterName] <String> [-RdpCredential] <PSCredential> - [-RdpAccessExpiry] <DateTime> [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Grant-AzureRmHDInsightRdpServicesAccess** cmdlet enables Remote Desktop Protocol (RDP) to access to a Windows-based Azure HDInsight cluster. - -## EXAMPLES - -### Example 1: Grant RDP access to an Azure HDInsight cluster -``` -PS C:\># Cluster info -PS C:\> $clusterName = "your-hadoop-001" -PS C:\> $clusterCreds = Get-Credential - -PS C:\> Grant-AzureRmHDInsightRdpServicesAccess ` - -ClusterName $clusterName ` - -RdpCredential $newRdpCreds ` - -RdpAccessExpiry $newRdpExpiry -``` - -This command grants RDP access to the cluster named your-hadoop-001. - -## PARAMETERS - -### -ClusterName -Specifies the name of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RdpAccessExpiry -Specifies the expiration, as a **DateTime** object, for RDP access to a cluster. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RdpCredential -Specifies the RDP credentials for the cluster. -This is only for Windows clusters. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Revoke-AzureRmHDInsightRdpServicesAccess](./Revoke-AzureRmHDInsightRdpServicesAccess.md) - - diff --git a/azurermps-6.13.0/AzureRM.HDInsight/Invoke-AzureRmHDInsightHiveJob.md b/azurermps-6.13.0/AzureRM.HDInsight/Invoke-AzureRmHDInsightHiveJob.md deleted file mode 100644 index 01075961e7..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/Invoke-AzureRmHDInsightHiveJob.md +++ /dev/null @@ -1,268 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: 3C6DCC81-82F7-4044-AFBC-4EE1BCC306F2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/invoke-azurermhdinsighthivejob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Invoke-AzureRmHDInsightHiveJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Invoke-AzureRmHDInsightHiveJob.md ---- - -# Invoke-AzureRmHDInsightHiveJob - -## SYNOPSIS -Submits a Hive query to an HDInsight cluster and retrieves query results in one operation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Invoke-AzureRmHDInsightHiveJob [-Arguments <String[]>] [-Files <String[]>] [-StatusFolder <String>] - [-Defines <Hashtable>] [-File <String>] [-JobName <String>] [-Query <String>] [-RunAsFileJob] - [-DefaultContainer <String>] [-DefaultStorageAccountName <String>] [-DefaultStorageAccountKey <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Invoke-AzureRmHDInsightHiveJob** cmdlet submits a Hive query to an Azure HDInsight cluster and retrieves query results in one operation. -Use the Use-AzureRmHDInsightCluster cmdlet before calling **Invoke-AzureRmHDInsightHiveJob** to specify which cluster will be used for the query. - -## EXAMPLES - -### Example 1: Submit a Hive query to an Azure HDInsight cluster -``` -PS C:\># Primary storage account info -PS C:\> $storageAccountResourceGroupName = "Group" -PS C:\> $storageAccountName = "yourstorageacct001" -PS C:\> $storageAccountKey = (Get-AzureRmStorageAccountKey -ResourceGroupName $storageAccountResourceGroupName -Name $storageAccountName)[0].value - - -PS C:\> $storageContainer = "container001" - -# Cluster info -PS C:\> $clusterName = "your-hadoop-001" -PS C:\> $clusterCreds = Get-Credential - -# Hive job details -PS C:\> $statusFolder = "tempStatusFolder/" -PS C:\> $query = "SHOW TABLES" - -PS C:\> Use-AzureRmHDInsightCluster ` - -ClusterCredential $clusterCreds ` - -ClusterName $clusterName - -PS C:\> Invoke-AzureRmHDInsightHiveJob -StatusFolder $statusFolder ` - -Query $query ` - -DefaultContainer $storageAccountContainer ` - -DefaultStorageAccountName "$storageAccountName.blob.core.windows.net" ` - -DefaultStorageAccountKey $storageAccountKey -``` - -This command submits the query SHOW TABLES to the cluster named your-hadoop-001. - -## PARAMETERS - -### -Arguments -Specifies an array of arguments for the job. -The arguments are passed as command-line arguments to each task. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultContainer -Specifies the name of the default container in the default Azure Storage account that an HDInsight cluster uses. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultStorageAccountKey -Specifies the account key for the default storage account that the HDInsight cluster uses. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultStorageAccountName -Specifies the name of the default storage account that the HDInsight cluster uses. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Defines -Specifies Hadoop configuration values to set when a job runs. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -File -Specifies the path to a file in Azure Storage that contains the query to run. -You can use this parameter instead of the *Query* parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Files -Specifies a collection of files that are required for a Hive job. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobName -Specifies the name of a Hive job. -If you do not specify this parameter, this cmdlet uses the default value: "Hive: \<first 100 characters of Query\>". - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Query -Specifies the Hive query. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RunAsFileJob -Indicates that this cmdlet creates a file in the default Azure storage account in which to store a query. -This cmdlet submits the job that references this file as a script to run. -You can use this functionality to handle special characters such as percent sign (%) that would fail on a job submission through Templeton, because Templeton interprets a query with a percent sign as a URL parameter. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StatusFolder -Specifies the location of the folder that contains standard outputs and error outputs for a job. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Use-AzureRmHDInsightCluster](./Use-AzureRmHDInsightCluster.md) - - diff --git a/azurermps-6.13.0/AzureRM.HDInsight/New-AzureRmHDInsightCluster.md b/azurermps-6.13.0/AzureRM.HDInsight/New-AzureRmHDInsightCluster.md deleted file mode 100644 index f9cdafcc57..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/New-AzureRmHDInsightCluster.md +++ /dev/null @@ -1,753 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: 691AC991-3249-487C-A0DF-C579ED7D00E7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/new-azurermhdinsightcluster -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightCluster.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightCluster.md ---- - -# New-AzureRmHDInsightCluster - -## SYNOPSIS -Creates an Azure HDInsight cluster in the specified resource group for the current subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Default (Default) -``` -New-AzureRmHDInsightCluster [-Location] <String> [-ResourceGroupName] <String> [-ClusterName] <String> - [-ClusterSizeInNodes] <Int32> [-HttpCredential] <PSCredential> [[-DefaultStorageAccountName] <String>] - [[-DefaultStorageAccountKey] <String>] [-DefaultStorageAccountType <StorageType>] - [-Config <AzureHDInsightConfig>] [-OozieMetastore <AzureHDInsightMetastore>] - [-HiveMetastore <AzureHDInsightMetastore>] - [-AdditionalStorageAccounts <System.Collections.Generic.Dictionary`2[System.String,System.String]>] - [-Configurations <System.Collections.Generic.Dictionary`2[System.String,System.Collections.Generic.Dictionary`2[System.String,System.String]]>] - [-ScriptActions <System.Collections.Generic.Dictionary`2[Microsoft.Azure.Management.HDInsight.Models.ClusterNodeType,System.Collections.Generic.List`1[Microsoft.Azure.Commands.HDInsight.Models.Management.AzureHDInsightScriptAction]]>] - [-DefaultStorageContainer <String>] [-DefaultStorageRootPath <String>] [-Version <String>] - [-HeadNodeSize <String>] [-WorkerNodeSize <String>] [-EdgeNodeSize <String>] [-ZookeeperNodeSize <String>] - [-ClusterType <String>] - [-ComponentVersion <System.Collections.Generic.Dictionary`2[System.String,System.String]>] - [-VirtualNetworkId <String>] [-SubnetName <String>] [-OSType <OSType>] [-ClusterTier <Tier>] - [-SshCredential <PSCredential>] [-SshPublicKey <String>] [-RdpCredential <PSCredential>] - [-RdpAccessExpiry <DateTime>] [-ObjectId <Guid>] [-CertificatePassword <String>] [-AadTenantId <Guid>] - [-SecurityProfile <AzureHDInsightSecurityProfile>] [-DisksPerWorkerNode <Int32>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### CertificateFilePath -``` -New-AzureRmHDInsightCluster [-Location] <String> [-ResourceGroupName] <String> [-ClusterName] <String> - [-ClusterSizeInNodes] <Int32> [-HttpCredential] <PSCredential> [[-DefaultStorageAccountName] <String>] - [[-DefaultStorageAccountKey] <String>] [-DefaultStorageAccountType <StorageType>] - [-Config <AzureHDInsightConfig>] [-OozieMetastore <AzureHDInsightMetastore>] - [-HiveMetastore <AzureHDInsightMetastore>] - [-AdditionalStorageAccounts <System.Collections.Generic.Dictionary`2[System.String,System.String]>] - [-Configurations <System.Collections.Generic.Dictionary`2[System.String,System.Collections.Generic.Dictionary`2[System.String,System.String]]>] - [-ScriptActions <System.Collections.Generic.Dictionary`2[Microsoft.Azure.Management.HDInsight.Models.ClusterNodeType,System.Collections.Generic.List`1[Microsoft.Azure.Commands.HDInsight.Models.Management.AzureHDInsightScriptAction]]>] - [-DefaultStorageContainer <String>] [-DefaultStorageRootPath <String>] [-Version <String>] - [-HeadNodeSize <String>] [-WorkerNodeSize <String>] [-EdgeNodeSize <String>] [-ZookeeperNodeSize <String>] - [-ClusterType <String>] - [-ComponentVersion <System.Collections.Generic.Dictionary`2[System.String,System.String]>] - [-VirtualNetworkId <String>] [-SubnetName <String>] [-OSType <OSType>] [-ClusterTier <Tier>] - [-SshCredential <PSCredential>] [-SshPublicKey <String>] [-RdpCredential <PSCredential>] - [-RdpAccessExpiry <DateTime>] [-ObjectId <Guid>] [-CertificateFilePath <String>] - [-CertificatePassword <String>] [-AadTenantId <Guid>] [-SecurityProfile <AzureHDInsightSecurityProfile>] - [-DisksPerWorkerNode <Int32>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### CertificateFileContents -``` -New-AzureRmHDInsightCluster [-Location] <String> [-ResourceGroupName] <String> [-ClusterName] <String> - [-ClusterSizeInNodes] <Int32> [-HttpCredential] <PSCredential> [[-DefaultStorageAccountName] <String>] - [[-DefaultStorageAccountKey] <String>] [-DefaultStorageAccountType <StorageType>] - [-Config <AzureHDInsightConfig>] [-OozieMetastore <AzureHDInsightMetastore>] - [-HiveMetastore <AzureHDInsightMetastore>] - [-AdditionalStorageAccounts <System.Collections.Generic.Dictionary`2[System.String,System.String]>] - [-Configurations <System.Collections.Generic.Dictionary`2[System.String,System.Collections.Generic.Dictionary`2[System.String,System.String]]>] - [-ScriptActions <System.Collections.Generic.Dictionary`2[Microsoft.Azure.Management.HDInsight.Models.ClusterNodeType,System.Collections.Generic.List`1[Microsoft.Azure.Commands.HDInsight.Models.Management.AzureHDInsightScriptAction]]>] - [-DefaultStorageContainer <String>] [-DefaultStorageRootPath <String>] [-Version <String>] - [-HeadNodeSize <String>] [-WorkerNodeSize <String>] [-EdgeNodeSize <String>] [-ZookeeperNodeSize <String>] - [-ClusterType <String>] - [-ComponentVersion <System.Collections.Generic.Dictionary`2[System.String,System.String]>] - [-VirtualNetworkId <String>] [-SubnetName <String>] [-OSType <OSType>] [-ClusterTier <Tier>] - [-SshCredential <PSCredential>] [-SshPublicKey <String>] [-RdpCredential <PSCredential>] - [-RdpAccessExpiry <DateTime>] [-ObjectId <Guid>] [-CertificateFileContents <Byte[]>] - [-CertificatePassword <String>] [-AadTenantId <Guid>] [-SecurityProfile <AzureHDInsightSecurityProfile>] - [-DisksPerWorkerNode <Int32>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureHDInsightCluster creates an Azure HDInsight cluster by using the specified parameters or by using a configuration object that is created by using the New-AzureRmHDInsightClusterConfig cmdlet. - -## EXAMPLES - -### Example 1: Create an Azure HDInsight cluster -``` -PS C:\&gt; # Primary storage account info - $storageAccountResourceGroupName = "Group" - $storageAccountName = "yourstorageacct001" - $storageAccountKey = Get-AzureStorageAccountKey ` - -ResourceGroupName $storageAccountResourceGroupName ` - -Name $storageAccountName | %{ $_.Key1 } - $storageContainer = "container002" - - # Cluster configuration info - $location = "East US 2" - $clusterResourceGroupName = "Group" - $clusterName = "your-hadoop-002" - $clusterCreds = Get-Credential - - # If the cluster's resource group doesn't exist yet, run: - # New-AzureRMResourceGroup -Name $clusterResourceGroupName -Location $location - - # Create the cluster - New-AzureRmHDInsightCluster ` - -ClusterType Hadoop ` - -OSType Windows ` - -ClusterSizeInNodes 4 ` - -ResourceGroupName $clusterResourceGroupName ` - -ClusterName $clusterName ` - -HttpCredential $clusterCreds ` - -Location $location ` - -DefaultStorageAccountName "$storageAccountName.blob.core.contoso.net" ` - -DefaultStorageAccountKey $storageAccountKey ` - -DefaultStorageContainer $storageContainer -``` - -This command creates a cluster in the current subscription. - -## PARAMETERS - -### -AadTenantId -Specifies the Microsoft Entra tenant ID that will be used when accessing Azure Data Lake Store. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AdditionalStorageAccounts -Specifies the additional Azure Storage accounts for the cluster. -You can alternatively use the Add-AzureRmHDInsightStorage cmdlet. - -```yaml -Type: System.Collections.Generic.Dictionary`2[System.String,System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CertificateFileContents -Specifies file contents of the certificate that will be used when accessing Azure Data Lake Store. - -```yaml -Type: System.Byte[] -Parameter Sets: CertificateFileContents -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CertificateFilePath -Specifies the file path to the certificate that will be used to authenticate as the Service Principal. -The cluster will use this when accessing Azure Data Lake Store. - -```yaml -Type: System.String -Parameter Sets: CertificateFilePath -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CertificatePassword -Specifies the password for the certificate that will be used to authenticate as the Service Principal. -The cluster will use this when accessing Azure Data Lake Store. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClusterName -Specifies the name of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClusterSizeInNodes -Specifies the number of Worker nodes for the cluster. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClusterTier -Specifies the HDInsight cluster tier. -By default, this is Standard. -The Premium tier can only be used with Linux clusters, and it enables the use of some new features. - -```yaml -Type: Microsoft.Azure.Management.HDInsight.Models.Tier -Parameter Sets: (All) -Aliases: -Accepted values: Standard, Premium - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClusterType -Specifies the type of cluster to create. -Options are: Hadoop, HBase, Storm, Spark - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComponentVersion -```yaml -Type: System.Collections.Generic.Dictionary`2[System.String,System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Config -Specifies the cluster object to be used to create the cluster. -This object can be created by using the New-AzureRmHDInsightClusterConfig cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Configurations -Specifies the configurations of this HDInsight cluster. -You can alternatively use the Add-AzureRmHDInsightConfigValues cmdlet. - -```yaml -Type: System.Collections.Generic.Dictionary`2[System.String,System.Collections.Generic.Dictionary`2[System.String,System.String]] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultStorageAccountKey -Specifies the account key for the default Azure Storage account that the HDInsight cluster will use. -You can alternatively use the Set-AzureRmHDInsightDefaultStorage cmdlet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultStorageAccountName -Specifies the name of the default Azure Storage account that the HDInsight cluster will use. -You can alternatively use the Set-AzureRmHDInsightDefaultStorage cmdlet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultStorageAccountType -Specifies the type of the default storage account that the HDInsight cluster will use. Possible values are AzureStorage and AzureDataLakeStore. Defaults to AzureStorage if not specified. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Commands.HDInsight.Models.Management.StorageType] -Parameter Sets: (All) -Aliases: -Accepted values: AzureStorage, AzureDataLakeStore - -Required: False -Position: Named -Default value: AzureStorage -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultStorageContainer -Specifies the name of the default container in the default Azure storage account that the HDInsight cluster will use. -You can alternatively use the Set-AzureRmHDInsightDefaultStorage cmdlet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultStorageRootPath -Specifies the path-prefix in the Data Lake Store Account that the HDInsight cluster will use as the default filesystem. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisksPerWorkerNode -Specifies the number of disks for worker node role in the cluster. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EdgeNodeSize -Specifies the size of the virtual machine for the edge node. Use Get-AzureRmVMSize for acceptable VM sizes, and see HDInsight's pricing page. This parameter is valid only for RServer clusters. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HeadNodeSize -Specifies the size of the virtual machine for the Head node. -Use Get-AzureRmVMSize for acceptable VM sizes, and see HDInsight's pricing page. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HiveMetastore -Specifies the SQL Database to store Hive metadata. -You can alternatively use the Add-AzureRmHDInsightMetastore cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightMetastore -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpCredential -Specifies the cluster login (HTTP) credentials for the cluster. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location for the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ObjectId -Specifies the Microsoft Entra object ID (a GUID) of the Microsoft Entra service principal that represents the cluster. -The cluster will use this when accessing Azure Data Lake Store. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OozieMetastore -Specifies the SQL Database to store Oozie metadata. -You can alternatively use the Add-AzureRmHDInsightMetastore cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightMetastore -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OSType -Specifies the operating system for the cluster. -Options are: Windows, Linux - -```yaml -Type: Microsoft.Azure.Management.HDInsight.Models.OSType -Parameter Sets: (All) -Aliases: -Accepted values: Windows, Linux - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RdpAccessExpiry -Specifies the expiration, as a DateTime object, for Remote Desktop Protocol (RDP) access to a cluster. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RdpCredential -Specifies the Remote Desktop (RDP) credentials for the cluster. -This is only for Windows clusters. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScriptActions -Specifies the script actions to run on the cluster at the end of cluster creation. -You can alternatively use Add-AzureRmHDInsightScriptAction. - -```yaml -Type: System.Collections.Generic.Dictionary`2[Microsoft.Azure.Management.HDInsight.Models.ClusterNodeType,System.Collections.Generic.List`1[Microsoft.Azure.Commands.HDInsight.Models.Management.AzureHDInsightScriptAction]] -Parameter Sets: (All) -Aliases: -Accepted values: HeadNode, WorkerNode, ZookeeperNode, EdgeNode - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecurityProfile -Specifies the security related properties used to create a secure cluster. -You can alternatively use the Add-AzureRmHDInsightSecurityProfile cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightSecurityProfile -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SshCredential -Specifies the SSH credential to be used for SSH connections. -This is only for Linux clusters. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SshPublicKey -Specifies the public key to be used for SSH connections. -This is only for Linux clusters. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetName -Specifies the name of a subnet within the chosen virtual network for the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Version -Specifies the HDI version of the HDInsight cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkId -Specifies the ID of the virtual network into which to provision the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkerNodeSize -Specifies the size of the virtual machine for the Worker node. -Use Get-AzureRmVMSize for acceptable VM sizes, and see HDInsight's pricing page. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZookeeperNodeSize -Specifies the size of the virtual machine for the Zookeeper node. -Use Get-AzureRmVMSize for acceptable VM sizes, and see HDInsight's pricing page. -This parameter is valid only for HBase or Storm clusters. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig -Parameters: Config (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightCluster - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight - -## RELATED LINKS - -[New-AzureRmHDInsightClusterConfig](./New-AzureRmHDInsightClusterConfig.md) diff --git a/azurermps-6.13.0/AzureRM.HDInsight/New-AzureRmHDInsightClusterConfig.md b/azurermps-6.13.0/AzureRM.HDInsight/New-AzureRmHDInsightClusterConfig.md deleted file mode 100644 index 83308255ed..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/New-AzureRmHDInsightClusterConfig.md +++ /dev/null @@ -1,367 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: 2C06626F-E5A9-48C2-AEA2-B448AD254C2E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/new-azurermhdinsightclusterconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightClusterConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightClusterConfig.md ---- - -# New-AzureRmHDInsightClusterConfig - -## SYNOPSIS -Creates a non-persisted cluster configuration object that describes an Azure HDInsight cluster configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmHDInsightClusterConfig [-DefaultStorageAccountName <String>] [-DefaultStorageAccountKey <String>] - [-DefaultStorageAccountType <StorageType>] [-OozieMetastore <AzureHDInsightMetastore>] - [-HiveMetastore <AzureHDInsightMetastore>] [-HeadNodeSize <String>] [-WorkerNodeSize <String>] - [-EdgeNodeSize <String>] [-ZookeeperNodeSize <String>] [-ClusterType <String>] [-ClusterTier <Tier>] - [-ObjectId <Guid>] [-CertificateFileContents <Byte[]>] [-CertificateFilePath <String>] - [-CertificatePassword <String>] [-AadTenantId <Guid>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmHDInsightClusterConfig** cmdlet creates a non-persisted object that describes an Azure HDInsight cluster configuration. - -## EXAMPLES - -### Example 1: Create a cluster configuration object -``` -PS C:\># Primary storage account info -PS C:\> $storageAccountResourceGroupName = "Group" -PS C:\> $storageAccountName = "yourstorageacct001" -PS C:\> $storageAccountKey = (Get-AzureRmStorageAccountKey -ResourceGroupName $storageAccountResourceGroupName -Name $storageAccountName)[0].value - - -PS C:\> $storageContainer = "container002" - -# Cluster configuration info -PS C:\> $location = "East US 2" -PS C:\> $clusterResourceGroupName = "Group" -PS C:\> $clusterName = "your-hadoop-002" -PS C:\> $clusterCreds = Get-Credential - -# If the cluster's resource group doesn't exist yet, run: -# New-AzureRmResourceGroup -Name $clusterResourceGroupName -Location $location - -# Create the cluster -PS C:\> New-AzureRmHDInsightClusterConfig ` - | Add-AzureRmHDInsightStorage ` - -StorageAccountName "$secondStorageAccountName.blob.core.contoso.net" ` - -StorageAccountKey $key2 ` - | New-AzureRmHDInsightCluster ` - -ClusterType Hadoop ` - -OSType Windows ` - -ClusterSizeInNodes 4 ` - -ResourceGroupName $clusterResourceGroupName ` - -ClusterName $clusterName ` - -HttpCredential $clusterCreds ` - -Location $location ` - -DefaultStorageAccountName "$storageAccountName.blob.core.contoso.net" ` - -DefaultStorageAccountKey $storageAccountKey ` - -DefaultStorageContainer $storageContainer -``` - -This command creates a cluster configuration object. - -## PARAMETERS - -### -AadTenantId -Specifies the Microsoft Entra tenant ID that will be used when accessing Azure Data Lake Store. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CertificateFileContents -Specifies file contents of the certificate that will be used when accessing Azure Data Lake Store. - -```yaml -Type: System.Byte[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CertificateFilePath -Specifies the file path to the certificate that will be used to authenticate as the Service Principal. -The cluster will use this when accessing Azure Data Lake Store. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CertificatePassword -Specifies the password for the certificate that will be used to authenticate as the Service Principal. -The cluster will use this when accessing Azure Data Lake Store. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClusterTier -Specifies the HDInsight cluster tier. -The acceptable values for this parameter are: -- Standard -- Premium -The default value is Standard. -The Premium tier can only be used with Linux clusters, and it enables the use of some new features. - -```yaml -Type: Microsoft.Azure.Management.HDInsight.Models.Tier -Parameter Sets: (All) -Aliases: -Accepted values: Standard, Premium - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClusterType -Specifies the type of cluster to create. -The acceptable values for this parameter are: -- Hadoop -- HBase -- Storm -- Spark - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultStorageAccountKey -Specifies the account key for the default Azure Storage account that the HDInsight cluster will use. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultStorageAccountName -Specifies the name of the default storage account that the HDInsight cluster will use. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultStorageAccountType -Specifies the type of the default storage account that the HDInsight cluster will use. Possible values are AzureStorage and AzureDataLakeStore. - -```yaml -Type: Microsoft.Azure.Commands.HDInsight.Models.Management.StorageType -Parameter Sets: (All) -Aliases: -Accepted values: AzureStorage, AzureDataLakeStore - -Required: False -Position: Named -Default value: AzureStorage -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EdgeNodeSize -Specifies the size of the virtual machine for the edge node. Use Get-AzureRmVMSize for acceptable VM sizes, and see HDInsight's pricing page. This parameter is valid only for RServer clusters. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HeadNodeSize -Specifies the size of the virtual machine for the Head node. -Use Get-AzureRMVMSize for acceptable VM sizes, and see HDInsight's pricing page. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HiveMetastore -Specifies the metastore to store Hive metadata. -You can alternatively use the Add-AzureRmHDInsightMetastore cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightMetastore -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ObjectId -Specifies the Microsoft Entra object ID (a GUID) of the Microsoft Entra service principal that represents the cluster. -The cluster will use this when accessing Azure Data Lake Store. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OozieMetastore -Specifies the metastore to store Oozie metadata. -You can alternatively use the **Add-AzureRmHDInsightMetastore** cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightMetastore -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkerNodeSize -Specifies the size of the virtual machine for the Worker node. -Use Get-AzureRMVMSize for acceptable VM sizes, and see HDInsight's pricing page. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZookeeperNodeSize -Specifies the size of the virtual machine for the Zookeeper node. -Use Get-AzureRMVMSize for acceptable VM sizes, and see HDInsight's pricing page. -This parameter is valid only for HBase or Storm clusters. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig - -## NOTES - -## RELATED LINKS - -[Add-AzureRmHDInsightStorage](./Add-AzureRmHDInsightStorage.md) diff --git a/azurermps-6.13.0/AzureRM.HDInsight/New-AzureRmHDInsightHiveJobDefinition.md b/azurermps-6.13.0/AzureRM.HDInsight/New-AzureRmHDInsightHiveJobDefinition.md deleted file mode 100644 index 2a1f358a3d..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/New-AzureRmHDInsightHiveJobDefinition.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: 580D3388-4E18-4E67-866F-1FCF5E54AB3A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/new-azurermhdinsighthivejobdefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightHiveJobDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightHiveJobDefinition.md ---- - -# New-AzureRmHDInsightHiveJobDefinition - -## SYNOPSIS -Creates a Hive job object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmHDInsightHiveJobDefinition [-Arguments <String[]>] [-Files <String[]>] [-StatusFolder <String>] - [-Defines <Hashtable>] [-File <String>] [-JobName <String>] [-Query <String>] [-RunAsFileJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmHDInsightHiveJobDefinition** cmdlet defines a Hive job object for use with an Azure HDInsight cluster. - -## EXAMPLES - -### Example 1: Create a Hive job definition -``` -PS C:\># Cluster info -PS C:\>$clusterName = "your-hadoop-001" -PS C:\>$clusterCreds = Get-Credential - -# Hive job details -PS C:\>$statusFolder = "<status folder>" -PS C:\>$query = "SHOW TABLES" - -PS C:\>New-AzureRmHDInsightHiveJobDefinition -StatusFolder $statusFolder ` - -Query $query ` - | Start-AzureRmHDInsightJob ` - -ClusterName $clusterName ` - -ClusterCredential $clusterCreds -``` - -This command creates a Hive job definition. - -## PARAMETERS - -### -Arguments -Specifies an array of arguments for the job. -The arguments are passed as command-line arguments to each task. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Defines -Specifies Hadoop configuration values to set for when the job runs. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -File -Specifies the path to a file that contains the query to run. -The file must be available on the storage account associated with the cluster. -You can use this parameter instead of the *Query* parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Files -Specifies a collection of files that are associated with a Hive job. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobName -Specifies the name of the job. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Query -Specifies the Hive query. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RunAsFileJob -Indicates that this cmdlet creates a file in the default Azure storage account in which to store a query. -This cmdlet submits the job that references this file as a script to run. -You can use this functionality to handle special characters such as percent sign (%) that would fail on a job submission through Templeton, because Templeton interprets a query with a percent sign as a URL parameter. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StatusFolder -Specifies the location of the folder that contains standard outputs and error outputs for a job. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightHiveJobDefinition - -## NOTES - -## RELATED LINKS - -[Start-AzureRmHDInsightJob](./Start-AzureRmHDInsightJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.HDInsight/New-AzureRmHDInsightMapReduceJobDefinition.md b/azurermps-6.13.0/AzureRM.HDInsight/New-AzureRmHDInsightMapReduceJobDefinition.md deleted file mode 100644 index e3709111d8..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/New-AzureRmHDInsightMapReduceJobDefinition.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: 6BF6F9A7-BED3-4CCE-9E0A-46ECBFF55DA9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/new-azurermhdinsightmapreducejobdefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightMapReduceJobDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightMapReduceJobDefinition.md ---- - -# New-AzureRmHDInsightMapReduceJobDefinition - -## SYNOPSIS -Creates a MapReduce job object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmHDInsightMapReduceJobDefinition [-Arguments <String[]>] [-Files <String[]>] [-StatusFolder <String>] - -ClassName <String> [-Defines <Hashtable>] -JarFile <String> [-JobName <String>] [-LibJars <String[]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmHDInsightMapReduceJobDefinition** cmdlet defines a new MapReduce job for use with an Azure HDInsight cluster. - -## EXAMPLES - -### Example 1: Create a MapReduce job definition -``` -PS C:\># Cluster info -PS C:\>$clusterName = "your-hadoop-001" -PS C:\>$clusterCreds = Get-Credential - -PS C:\>New-AzureRmHDInsightMapReduceJobDefinition -StatusFolder $statusFolder ` - -ClassName $className ` - -JarFile $jarFilePath ` - | Start-AzureRmHDInsightJob ` - -ClusterName $clusterName ` - -ClusterCredential $clusterCreds -``` - -This command creates a MapReduce job definition. - -## PARAMETERS - -### -Arguments -Specifies an array of arguments for the job. -The arguments are passed as command-line arguments to each task. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClassName -Specifies the job class in the JAR file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Defines -Specifies Hadoop configuration values to set for when the job runs. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Files -Specifies a collection of files that are associated with a Hive job. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JarFile -Specifies the JAR file to use for the job. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobName -Specifies the name of the job. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LibJars -Specifies the lib JARS for the job. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StatusFolder -Specifies the location of the folder that contains standard outputs and error outputs for a job. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightMapReduceJobDefinition - -## NOTES - -## RELATED LINKS - -[Start-AzureRmHDInsightJob](./Start-AzureRmHDInsightJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.HDInsight/New-AzureRmHDInsightPigJobDefinition.md b/azurermps-6.13.0/AzureRM.HDInsight/New-AzureRmHDInsightPigJobDefinition.md deleted file mode 100644 index 41a7b0c848..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/New-AzureRmHDInsightPigJobDefinition.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: B9BA5FD1-A4F8-4E24-8FCB-847649B82AB6 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/new-azurermhdinsightpigjobdefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightPigJobDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightPigJobDefinition.md ---- - -# New-AzureRmHDInsightPigJobDefinition - -## SYNOPSIS -Creates a Pig job object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmHDInsightPigJobDefinition [-Arguments <String[]>] [-Files <String[]>] [-StatusFolder <String>] - [-File <String>] [-Query <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmHDInsightPigJobDefinition** cmdlet defines a Pig job object for use with an Azure HDInsight cluster. - -## EXAMPLES - -### Example 1: Create a Pig job definition -``` -PS C:\># Cluster info -PS C:\>$clusterName = "your-hadoop-001" -PS C:\>$clusterCreds = Get-Credential - -# Pig job details -PS C:\>$statusFolder = "tempStatusFolder/" -PS C:\>$query = "SHOW TABLES" - -PS C:\>New-AzureRmHDInsightPigJobDefinition -StatusFolder $statusFolder ` - -Query $query ` - | Start-AzureRmHDInsightJob ` - -ClusterName $clusterName ` - -ClusterCredential $clusterCreds -``` - -This command creates a Pig job definition. - -## PARAMETERS - -### -Arguments -Specifies an array of arguments for the job. -The arguments are passed as command-line arguments to each task. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -File -Specifies the path to a file that contains the query to run. -The file must be available on the storage account associated with the cluster. -You can use this parameter instead of the *Query* parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Files -Specifies a collection of files that are associated with a Hive job. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Query -Specifies the Pig query. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StatusFolder -Specifies the location of the folder that contains standard outputs and error outputs for a job. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightPigJobDefinition - -## NOTES - -## RELATED LINKS - -[Start-AzureRmHDInsightJob](./Start-AzureRmHDInsightJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.HDInsight/New-AzureRmHDInsightSqoopJobDefinition.md b/azurermps-6.13.0/AzureRM.HDInsight/New-AzureRmHDInsightSqoopJobDefinition.md deleted file mode 100644 index f94e9665dd..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/New-AzureRmHDInsightSqoopJobDefinition.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: 4ED47646-542B-4983-B46B-B603BE33D499 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/new-azurermhdinsightsqoopjobdefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightSqoopJobDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightSqoopJobDefinition.md ---- - -# New-AzureRmHDInsightSqoopJobDefinition - -## SYNOPSIS -Creates a Sqoop job object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmHDInsightSqoopJobDefinition [-Files <String[]>] [-StatusFolder <String>] [-File <String>] - [-Command <String>] [-LibDir <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmHDInsightSqoopJobDefinition** cmdlet defines a Sqoop job object for use with an Azure HDInsight cluster. - -## EXAMPLES - -### Example 1: Create a Sqoop job definition -``` -PS C:\># Cluster info -PS C:\>$clusterName = "your-hadoop-001" -PS C:\>$clusterCreds = Get-Credential - -PS C:\>New-AzureRmHDInsightSqoopJobDefinition -StatusFolder $statusFolder ` - -Command $sqoopCommand ` - | Start-AzureRmHDInsightJob -ClusterName $clusterName ` - -ClusterCredential $clusterCreds -``` - -This command creates a Sqoop job definition. - -## PARAMETERS - -### -Command -Specifies the Sqoop command. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -File -Specifies the path to a file that contains the query to run. -The file must be available on the Storage account associated with the cluster. -You can use this parameter instead of the *Query* parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Files -Specifies a collection of files that are associated with a Hive job. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LibDir -Specifies the library directory for the Sqoop job. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StatusFolder -Specifies the location of the folder that contains standard outputs and error outputs for a job. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightSqoopJobDefinition - -## NOTES - -## RELATED LINKS - -[Start-AzureRmHDInsightJob](./Start-AzureRmHDInsightJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.HDInsight/New-AzureRmHDInsightStreamingMapReduceJobDefinition.md b/azurermps-6.13.0/AzureRM.HDInsight/New-AzureRmHDInsightStreamingMapReduceJobDefinition.md deleted file mode 100644 index 8845628935..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/New-AzureRmHDInsightStreamingMapReduceJobDefinition.md +++ /dev/null @@ -1,237 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: 17CB76E7-2F91-4EFE-9DA3-F083F02235E1 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/new-azurermhdinsightstreamingmapreducejobdefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightStreamingMapReduceJobDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightStreamingMapReduceJobDefinition.md ---- - -# New-AzureRmHDInsightStreamingMapReduceJobDefinition - -## SYNOPSIS -Creates a Streaming MapReduce job object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmHDInsightStreamingMapReduceJobDefinition [-Arguments <String[]>] [-File <String>] - [-Files <String[]>] [-StatusFolder <String>] [-CommandEnvironment <Hashtable>] [-Defines <Hashtable>] - -InputPath <String> [-Mapper <String>] [-OutputPath <String>] [-Reducer <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmHDInsightStreamingMapReduceJobDefinition** cmdlet defines a Streaming MapReduce job object for use with an Azure HDInsight cluster. - -## EXAMPLES - -### Example 1: Create a Streaming MapReduce job definition -``` -PS C:\># Cluster info -PS C:\>$clusterName = "your-hadoop-001" -PS C:\>$clusterCreds = Get-Credential - -# Streaming MapReduce job details -PS C:\>$statusFolder = "tempStatusFolder/" -PS C:\>$query = "SHOW TABLES" - -PS C:\>New-AzureRmHDInsightStreamingMapReduceJobDefinition -StatusFolder $statusFolder ` - -Query $query ` - | Start-AzureRmHDInsightJob ` - -ClusterName $clusterName ` - -ClusterCredential $clusterCreds -``` - -This command creates a Streaming MapReduce job definition. - -## PARAMETERS - -### -Arguments -Specifies an array of arguments for the job. -The arguments are passed as command-line arguments to each task. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CommandEnvironment -Specifies an array of command-line environment variables to set when a job runs on worker nodes. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Defines -Specifies Hadoop configuration values to set for when the job runs. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -File -Specifies the path to a file that contains a query to run. -You can use this parameter instead of the *Query* parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Files -Specifies a collection of files that are associated with a Hive job. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputPath -Specifies the path to the input files. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mapper -Specifies a Mapper file name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutputPath -Specifies the path for the job output. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Reducer -Specifies a Reducer file name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StatusFolder -Specifies the location of the folder that contains standard outputs and error outputs for a job. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightStreamingMapReduceJobDefinition - -## NOTES - -## RELATED LINKS - -[Start-AzureRmHDInsightJob](./Start-AzureRmHDInsightJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.HDInsight/Remove-AzureRmHDInsightCluster.md b/azurermps-6.13.0/AzureRM.HDInsight/Remove-AzureRmHDInsightCluster.md deleted file mode 100644 index 4e54998f49..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/Remove-AzureRmHDInsightCluster.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: 87B3C102-0A8C-4FFA-8429-594D2360AC32 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/remove-azurermhdinsightcluster -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Remove-AzureRmHDInsightCluster.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Remove-AzureRmHDInsightCluster.md ---- - -# Remove-AzureRmHDInsightCluster - -## SYNOPSIS -Removes the specified HDInsight cluster from the current subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmHDInsightCluster [-ClusterName] <String> [-ResourceGroupName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmHDInsightCluster** cmdlet removes the specified HDInsight service cluster from a subscription. -This operation also deletes any data stored in the Hadoop Distributed File System (HDFS) on the cluster. -Data stored in the associated Azure Storage account is not deleted. -Data stored in external metastores is not deleted. - -## EXAMPLES - -### Example 1: Delete an Azure HDInsight cluster -``` -PS C:\>Remove-AzureRmHDInsightCluster -ClusterName "your-hadoop-001" -``` - -This command removes the cluster named your-hadoop-001. - -## PARAMETERS - -### -ClusterName -Specifies the name of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Management.HDInsight.Models.ClusterGetResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmHDInsightCluster](./Get-AzureRmHDInsightCluster.md) - -[Use-AzureRmHDInsightCluster](./Use-AzureRmHDInsightCluster.md) - - diff --git a/azurermps-6.13.0/AzureRM.HDInsight/Remove-AzureRmHDInsightPersistedScriptAction.md b/azurermps-6.13.0/AzureRM.HDInsight/Remove-AzureRmHDInsightPersistedScriptAction.md deleted file mode 100644 index 8748488deb..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/Remove-AzureRmHDInsightPersistedScriptAction.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: 08D1D6AC-D064-4E2D-9C22-0B65E7BE4DA7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/remove-azurermhdinsightpersistedscriptaction -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Remove-AzureRmHDInsightPersistedScriptAction.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Remove-AzureRmHDInsightPersistedScriptAction.md ---- - -# Remove-AzureRmHDInsightPersistedScriptAction - -## SYNOPSIS -Removes an persisted script action from an HDInsight cluster. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmHDInsightPersistedScriptAction [-ClusterName] <String> [-Name] <String> - [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmHDInsightPersistedScriptAction** cmdlet removes a persisted script action from the specified Azure HDInsight cluster's list of persisted script actions. -The removed script will no longer be executed when the cluster is scaled up. - -## EXAMPLES - -### Example 1: Remove a script action from the list of persisted script actions on a cluster -``` -PS C:\>Remove-AzureRmHDInsightPersistedScriptAction ` - -ClusterName "your-hadoop-001" ` - -Name "Scriptaction" -``` - -This command removes the script action named Scriptaction from the list of persisted script actions on the specified cluster. - -## PARAMETERS - -### -ClusterName -Specifies the name of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the persisted script action to be removed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmHDInsightPersistedScriptAction](./Get-AzureRmHDInsightPersistedScriptAction.md) - -[Set-AzureRmHDInsightPersistedScriptAction](./Set-AzureRmHDInsightPersistedScriptAction.md) - - diff --git a/azurermps-6.13.0/AzureRM.HDInsight/Revoke-AzureRmHDInsightHttpServicesAccess.md b/azurermps-6.13.0/AzureRM.HDInsight/Revoke-AzureRmHDInsightHttpServicesAccess.md deleted file mode 100644 index ce9329fb6e..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/Revoke-AzureRmHDInsightHttpServicesAccess.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: 670EAFC0-3F8D-4F3D-8B62-448F04378F8B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/revoke-azurermhdinsighthttpservicesaccess -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Revoke-AzureRmHDInsightHttpServicesAccess.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Revoke-AzureRmHDInsightHttpServicesAccess.md ---- - -# Revoke-AzureRmHDInsightHttpServicesAccess - -## SYNOPSIS -Disables HTTP access to the cluster. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Revoke-AzureRmHDInsightHttpServicesAccess [-ClusterName] <String> [-ResourceGroupName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Revoke-AzureRmHDInsightHttpServicesAccess** cmdlet disables HTTP access to an Azure HDInsight cluster for ODBC, Ambari, Oozie and webHCatalog web services. - -## EXAMPLES - -### Example 1: Disable HTTP access to a cluster -``` -PS C:\>Revoke-AzureRmHDInsightHttpServicesAccess ` - -ClusterName "your-hadoop_001" -``` - -This command revokes HTTP access to the cluster named your-hadoop_001. - -## PARAMETERS - -### -ClusterName -Specifies the name of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Management.HDInsight.Models.HttpConnectivitySettings - -## NOTES - -## RELATED LINKS - -[Grant-AzureRmHDInsightHttpServicesAccess](./Grant-AzureRmHDInsightHttpServicesAccess.md) - - diff --git a/azurermps-6.13.0/AzureRM.HDInsight/Revoke-AzureRmHDInsightRdpServicesAccess.md b/azurermps-6.13.0/AzureRM.HDInsight/Revoke-AzureRmHDInsightRdpServicesAccess.md deleted file mode 100644 index 5db971d30e..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/Revoke-AzureRmHDInsightRdpServicesAccess.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: 8C6D9533-68FD-4AFF-91FB-8307A8C8EAEB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/revoke-azurermhdinsightrdpservicesaccess -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Revoke-AzureRmHDInsightRdpServicesAccess.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Revoke-AzureRmHDInsightRdpServicesAccess.md ---- - -# Revoke-AzureRmHDInsightRdpServicesAccess - -## SYNOPSIS -Disables RDP access to a Windows cluster. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Revoke-AzureRmHDInsightRdpServicesAccess [-ClusterName] <String> [-ResourceGroupName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Revoke-AzureRmHDInsightRdpServicesAccess** cmdlet disables Remote Desktop Protocol (RDP) access to a Windows-based Azure HDInsight cluster. - -## EXAMPLES - -### Example 1: Disable RDP access to a specified cluster -``` -PS C:\>Revoke-AzureRmHDInsightRdpServicesAccess -ClusterName "your-hadoop-001" -``` - -This command revokes RDP access to the cluster named your-hadoop-001. - -## PARAMETERS - -### -ClusterName -Specifies the name of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Grant-AzureRmHDInsightRdpServicesAccess](./Grant-AzureRmHDInsightRdpServicesAccess.md) - - diff --git a/azurermps-6.13.0/AzureRM.HDInsight/Set-AzureRmHDInsightClusterSize.md b/azurermps-6.13.0/AzureRM.HDInsight/Set-AzureRmHDInsightClusterSize.md deleted file mode 100644 index f73cce72b6..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/Set-AzureRmHDInsightClusterSize.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: A9A8C4B9-6346-4186-9D73-3A56437BFB2F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/set-azurermhdinsightclustersize -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Set-AzureRmHDInsightClusterSize.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Set-AzureRmHDInsightClusterSize.md ---- - -# Set-AzureRmHDInsightClusterSize - -## SYNOPSIS -Sets the number of Worker nodes in a specified cluster. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmHDInsightClusterSize [-ClusterName] <String> [-TargetInstanceCount] <Int32> - [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmHDInsightClusterSize** cmdlet sets the number of Worker nodes in a specified Azure HDInsight cluster. - -## EXAMPLES - -### Example 1: Set the size of a specified cluster -``` -PS C:\>Set-AzureRmHDInsightClusterSize -ClusterName "your-hadoop-001" -TargetInstanceCount 6 -``` - -This command sets the size of the cluster named your-hadoop-001. - -## PARAMETERS - -### -ClusterName -Specifies the name of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetInstanceCount -Specifies the desired number of Worker nodes in the cluster. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Management.HDInsight.Models.Cluster - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.HDInsight/Set-AzureRmHDInsightDefaultStorage.md b/azurermps-6.13.0/AzureRM.HDInsight/Set-AzureRmHDInsightDefaultStorage.md deleted file mode 100644 index b361af4818..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/Set-AzureRmHDInsightDefaultStorage.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: 37E41DA2-B65B-4AA2-B6AB-F93CCA881C72 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/set-azurermhdinsightdefaultstorage -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Set-AzureRmHDInsightDefaultStorage.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Set-AzureRmHDInsightDefaultStorage.md ---- - -# Set-AzureRmHDInsightDefaultStorage - -## SYNOPSIS -Sets the default Storage account setting in a cluster configuration object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmHDInsightDefaultStorage [-Config] <AzureHDInsightConfig> [-StorageAccountName] <String> - [[-StorageAccountKey] <String>] [-StorageAccountType <StorageType>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmHDInsightDefaultStorage** cmdlet sets the default Storage account setting in the Azure HDInsight cluster configuration object created by the New-AzureRmHDInsightClusterConfig cmdlet. - -## EXAMPLES - -### Example 1: Set the default storage account for the cluster configuration object -``` -PS C:\># Primary storage account info -PS C:\> $storageAccountResourceGroupName = "Group" -PS C:\> $storageAccountName = "yourstorageacct001" -PS C:\> $storageAccountKey = (Get-AzureRmStorageAccountKey -ResourceGroupName $storageAccountResourceGroupName -Name $storageAccountName)[0].value - - -PS C:\>$storageContainer = "container002" - -# Cluster configuration info -PS C:\> $location = "East US 2" -PS C:\> $clusterResourceGroupName = "Group" -PS C:\> $clusterName = "your-hadoop-002" -PS C:\> $clusterCreds = Get-Credential - -# If the cluster's resource group doesn't exist yet, run: -# New-AzureRMResourceGroup -Name $clusterResourceGroupName -Location $location - -# Create the cluster -PS C:\> New-AzureRmHDInsightClusterConfig ` - | Set-AzureRmHDInsightDefaultStorage ` - -StorageAccountName "$secondStorageAccountName.blob.core.contoso.net" ` - -StorageAccountKey $key2 ` - -StorageContainer $storageContainer ` - | New-AzureRmHDInsightCluster ` - -ClusterType Hadoop ` - -OSType Windows ` - -ClusterSizeInNodes 4 ` - -ResourceGroupName $clusterResourceGroupName ` - -ClusterName $clusterName ` - -HttpCredential $clusterCreds ` - -Location $location -``` - -This command sets the default Storage account for a cluster configuration object. - -## PARAMETERS - -### -Config -Specifies the HDInsight cluster configuration object that this cmdlet modifies. -This object is created by the **New-AzureRmHDInsightClusterConfig** cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageAccountKey -Specifies the account key for the default Azure Storage account that the HDInsight cluster will use. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageAccountName -Specifies the name of the default storage account that the HDInsight cluster will use. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageAccountType -Gets or sets the type of the default storage account. Defaults to AzureStorage - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Commands.HDInsight.Models.Management.StorageType] -Parameter Sets: (All) -Aliases: -Accepted values: AzureStorage, AzureDataLakeStore - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig -Parameters: Config (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.HDInsight/Set-AzureRmHDInsightPersistedScriptAction.md b/azurermps-6.13.0/AzureRM.HDInsight/Set-AzureRmHDInsightPersistedScriptAction.md deleted file mode 100644 index 7cfc0cf185..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/Set-AzureRmHDInsightPersistedScriptAction.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: 92F21752-4FB6-4162-B542-DA25ACA3340B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/set-azurermhdinsightpersistedscriptaction -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Set-AzureRmHDInsightPersistedScriptAction.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Set-AzureRmHDInsightPersistedScriptAction.md ---- - -# Set-AzureRmHDInsightPersistedScriptAction - -## SYNOPSIS -Sets a previously executed script action to be a persisted script action. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmHDInsightPersistedScriptAction [-ClusterName] <String> [-ScriptExecutionId] <Int64> - [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmHDInsightPersistedScriptAction** cmdlet sets a previously executed script action to be a persisted script action. -The specified script action must have previously succeeded. -The script action will run each time the Azure HDInsight cluster is scaled up. - -## EXAMPLES - -### Example 1: Set a previously successful script action to be persisted, or run on cluster scale up -``` -PS C:\>Set-AzureRmHDInsightPersistedScriptAction ` - -ClusterName "your-hadoop-001" ` - -ScriptExecutionId "<id>" -``` - -This command sets a previously successful script action to be a persisted script action. - -## PARAMETERS - -### -ClusterName -Specifies the name of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScriptExecutionId -Specifies the execution ID of the script action to promote to persisted. -This script action must have succeeded in order to be promoted. -You can find the script action execution ID using Get-AzureRmHDInsightScriptActionHistory. - -```yaml -Type: System.Int64 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmHDInsightPersistedScriptAction](./Get-AzureRmHDInsightPersistedScriptAction.md) - -[Remove-AzureRmHDInsightPersistedScriptAction](./Remove-AzureRmHDInsightPersistedScriptAction.md) - - diff --git a/azurermps-6.13.0/AzureRM.HDInsight/Start-AzureRmHDInsightJob.md b/azurermps-6.13.0/AzureRM.HDInsight/Start-AzureRmHDInsightJob.md deleted file mode 100644 index c16bbbee45..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/Start-AzureRmHDInsightJob.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: 0225C7CA-74B4-4ACC-870C-9539DF6ECC47 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/start-azurermhdinsightjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Start-AzureRmHDInsightJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Start-AzureRmHDInsightJob.md ---- - -# Start-AzureRmHDInsightJob - -## SYNOPSIS -Starts a defined Azure HDInsight job on a specified cluster. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Start-AzureRmHDInsightJob [-ClusterName] <String> [-JobDefinition] <AzureHDInsightJobDefinition> - [-HttpCredential] <PSCredential> [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Start-AzureRMHDInsightJob** cmdlet starts a defined Azure HDInsight job on a specified cluster. -This can be a MapReduce job, a Streaming MapReduce job, a Hive job, or a Pig job. - -## EXAMPLES - -### Example 1: Start a job on the specified cluster -``` -PS C:\># Cluster info -PS C:\> $clusterName = "your-hadoop-001" -PS C:\> $clusterCreds = Get-Credential - -# Hive job details -PS C:\> $statusFolder = "tempStatusFolder/" -PS C:\> $query = "SHOW TABLES" - -PS C:\> New-AzureRmHDInsightHiveJobDefinition -StatusFolder $statusFolder ` - -Query $query ` - | Start-AzureRmHDInsightJob ` - -ClusterName $clusterName ` - -ClusterCredential $clusterCreds -``` - -This command starts a job on the cluster named your-hadoop-001. - -## PARAMETERS - -### -ClusterName -Specifies the name of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpCredential -Specifies the cluster login (HTTP) credentials for the cluster. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: ClusterCredential - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobDefinition -Specifies the job to start on the Azure HDInsight cluster. - -```yaml -Type: Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightJobDefinition -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightJobDefinition -Parameters: JobDefinition (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightJob - -## NOTES - -## RELATED LINKS - -[Get-AzureRmHDInsightJob](./Get-AzureRmHDInsightJob.md) - -[New-AzureRmHDInsightHiveJobDefinition](./New-AzureRmHDInsightHiveJobDefinition.md) - -[Stop-AzureRmHDInsightJob](./Stop-AzureRmHDInsightJob.md) - -[Wait-AzureRmHDInsightJob](./Wait-AzureRmHDInsightJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.HDInsight/Stop-AzureRmHDInsightJob.md b/azurermps-6.13.0/AzureRM.HDInsight/Stop-AzureRmHDInsightJob.md deleted file mode 100644 index 435e026a10..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/Stop-AzureRmHDInsightJob.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: FD27C755-9AAF-42DA-8425-1661C92B6C68 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/stop-azurermhdinsightjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Stop-AzureRmHDInsightJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Stop-AzureRmHDInsightJob.md ---- - -# Stop-AzureRmHDInsightJob - -## SYNOPSIS -Stops a specified running job on a cluster. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Stop-AzureRmHDInsightJob [-ClusterName] <String> [-JobId] <String> [-HttpCredential] <PSCredential> - [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Stop-AzureRmHDInsightJob** cmdlet stops a specified running job on an Azure HDInsight cluster. - -## EXAMPLES - -### Example 1: Stop a job on the specified cluster -``` -PS C:\># Cluster info -PS C:\> $clusterName = "your-hadoop-001" -PS C:\> $clusterCreds = Get-Credential -PS C:\> Stop-AzureRmHDInsightJob ` - -ClusterName $clusterName ` - -ClusterCredential $clusterCreds ` - -JobId $jobId -``` - -This command stops a job on the cluster named your-hadoop-001. - -## PARAMETERS - -### -ClusterName -Specifies the name of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpCredential -Specifies the cluster login (HTTP) credentials for the cluster. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: ClusterCredential - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobId -Specifies the job ID of the job. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: JobId (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightJob - -## NOTES - -## RELATED LINKS - -[Get-AzureRmHDInsightJob](./Get-AzureRmHDInsightJob.md) - -[Start-AzureRmHDInsightJob](./Start-AzureRmHDInsightJob.md) - -[Wait-AzureRmHDInsightJob](./Wait-AzureRmHDInsightJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.HDInsight/Submit-AzureRmHDInsightScriptAction.md b/azurermps-6.13.0/AzureRM.HDInsight/Submit-AzureRmHDInsightScriptAction.md deleted file mode 100644 index 0ce381ac4f..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/Submit-AzureRmHDInsightScriptAction.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: 15C5D659-472B-41DD-806A-A0A175434EE3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/submit-azurermhdinsightscriptaction -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Submit-AzureRmHDInsightScriptAction.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Submit-AzureRmHDInsightScriptAction.md ---- - -# Submit-AzureRmHDInsightScriptAction - -## SYNOPSIS -Submits a new script action to an Azure HDInsight cluster. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Submit-AzureRmHDInsightScriptAction [-ClusterName] <String> [-Name] <String> [-Uri] <Uri> - [-NodeTypes] <RuntimeScriptActionClusterNodeType[]> [[-Parameters] <String>] [[-ApplicationName] <String>] - [-PersistOnSuccess] [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Submit-AzureRmHDInsightScriptAction** cmdlet submits a new script action to an Azure HDInsight cluster. -Use *PersistOnSuccess* to have the script action run each time the cluster is scaled up, as long as the script action initially succeeds. - -## EXAMPLES - -### Example 1: Submit a new script action to a running HDInsight cluster -``` -PS C:\>Submit-AzureRmHDInsightScriptAction ` - -ClusterName "your-hadoop-001" ` - -Name "scriptaction" ` - -Uri "<script action URI>" ` - -NodeTypes Worker -PersistOnSuccess -``` - -This command submits a script action to a running HDInsight cluster. - -## PARAMETERS - -### -ApplicationName -Specifies the application name for the script action. -When *ApplicationName* is specified, *PersistOnSuccess* should be set to False, nodes must contain only edgenode, and script action count should equal 1. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ClusterName -Specifies the name of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the script action. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NodeTypes -Specifies the node types on which to run the script action. - -```yaml -Type: Microsoft.Azure.Commands.HDInsight.Models.Management.RuntimeScriptActionClusterNodeType[] -Parameter Sets: (All) -Aliases: -Accepted values: HeadNode, WorkerNode, ZookeeperNode, EdgeNode - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Parameters -Specifies the parameters for the script action. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PersistOnSuccess -Indicates that the script action should run each time the cluster is scaled up. -This switch parameter is ignored if the script action initially fails. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Uri -Specifies the public URI for the script action (a PowerShell or Bash script). - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Uri - -### Microsoft.Azure.Commands.HDInsight.Models.Management.RuntimeScriptActionClusterNodeType[] - -## OUTPUTS - -### Microsoft.Azure.Commands.HDInsight.Models.Management.AzureHDInsightRuntimeScriptActionOperationResource - -## NOTES - -## RELATED LINKS - -[Add-AzureRmHDInsightScriptAction](./Add-AzureRmHDInsightScriptAction.md) - - diff --git a/azurermps-6.13.0/AzureRM.HDInsight/Use-AzureRmHDInsightCluster.md b/azurermps-6.13.0/AzureRM.HDInsight/Use-AzureRmHDInsightCluster.md deleted file mode 100644 index 50248c3004..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/Use-AzureRmHDInsightCluster.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: 92E876FE-AA7B-43AA-915F-D02AC5CEF0CA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/use-azurermhdinsightcluster -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Use-AzureRmHDInsightCluster.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Use-AzureRmHDInsightCluster.md ---- - -# Use-AzureRmHDInsightCluster - -## SYNOPSIS -Selects a cluster to be used with the Invoke-RmAzureHDInsightHiveJob cmdlet. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Use-AzureRmHDInsightCluster [-ClusterName] <String> [-HttpCredential] <PSCredential> - [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Use-AzureRmHDInsightCluster** cmdlet selects the Azure HDInsight cluster for the Invoke-AzureRmHDInsightHiveJob cmdlet to use to submit Hive jobs. - -## EXAMPLES - -### Example 1: Select a cluster for Hive query submission -``` -PS C:\># Cluster info -PS C:\>$clusterName = "your-hadoop-001" -PS C:\>$clusterCreds = Get-Credential - -PS C:\>Use-AzureRmHDInsightCluster ` - -ClusterName $clusterName ` - -ClusterCredential $clusterCreds -``` - -This command selects a cluster for a Hive query submission. - -## PARAMETERS - -### -ClusterName -Specifies the name of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpCredential -Specifies the cluster login (HTTP) credentials for the cluster. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: ClusterCredential - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Get-AzureRmHDInsightCluster](./Get-AzureRmHDInsightCluster.md) - -[Remove-AzureRmHDInsightCluster](./Remove-AzureRmHDInsightCluster.md) - - diff --git a/azurermps-6.13.0/AzureRM.HDInsight/Wait-AzureRmHDInsightJob.md b/azurermps-6.13.0/AzureRM.HDInsight/Wait-AzureRmHDInsightJob.md deleted file mode 100644 index a708a85dc2..0000000000 --- a/azurermps-6.13.0/AzureRM.HDInsight/Wait-AzureRmHDInsightJob.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml -Module Name: AzureRM.HDInsight -ms.assetid: 677E19F2-CC6C-4C16-B1FD-3A15D0FF1ECA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.hdinsight/wait-azurermhdinsightjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Wait-AzureRmHDInsightJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/HDInsight/Commands.HDInsight/help/Wait-AzureRmHDInsightJob.md ---- - -# Wait-AzureRmHDInsightJob - -## SYNOPSIS -Waits for the completion or failure of a specified job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Wait-AzureRmHDInsightJob [-ClusterName] <String> [-JobId] <String> [-HttpCredential] <PSCredential> - [-ResourceGroupName <String>] [-TimeoutInSeconds <Int32>] [-WaitIntervalInSeconds <Int32>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Wait-AzureRmHDInsightJob** cmdlet awaits the completion or failure of an Azure HDInsight job. - -## EXAMPLES - -### Example 1: Wait for the completion or failure of a job -``` -PS C:\># Cluster info -PS C:\> $clusterResourceGroupName = "Group" -PS C:\> $clusterName = "your-hadoop-001" -PS C:\> $clusterCreds = Get-Credential - -# Hive job details -PS C:\> $statusFolder = "tempStatusFolder/" -PS C:\> $query = "SHOW TABLES" - -PS C:\> New-AzureRmHDInsightHiveJobDefinition -StatusFolder $statusFolder ` - -Query $query ` - | Start-AzureRmHDInsightJob -ResourceGroupName $clusterResourceGroupName ` - -ClusterName $clusterName ` - -ClusterCredential $clusterCreds ` - | Wait-AzureRmHDInsightJob -ResourceGroupName $clusterResourceGroupName ` - -ClusterName $clusterName ` - -ClusterCredential $clusterCreds -``` - -This command waits for the completion or failure of a job. - -## PARAMETERS - -### -ClusterName -Specifies the name of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpCredential -Specifies the cluster login (HTTP) credentials for the cluster. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: ClusterCredential - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobId -Specifies the job ID of the job. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeoutInSeconds -The total time to wait for job completion, in seconds. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WaitIntervalInSeconds -The time to wait between job status checks, in seconds. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: JobId (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightJob - -## NOTES - -## RELATED LINKS - -[Get-AzureRmHDInsightJob](./Get-AzureRmHDInsightJob.md) - -[Start-AzureRmHDInsightJob](./Start-AzureRmHDInsightJob.md) - -[Stop-AzureRmHDInsightJob](./Stop-AzureRmHDInsightJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.Insights/Add-AzureRmAutoscaleSetting.md b/azurermps-6.13.0/AzureRM.Insights/Add-AzureRmAutoscaleSetting.md deleted file mode 100644 index 8a3883b2af..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/Add-AzureRmAutoscaleSetting.md +++ /dev/null @@ -1,258 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 7436F31F-9DCB-4365-BA6D-41BDB5D7FCB6 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/add-azurermautoscalesetting -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Add-AzureRmAutoscaleSetting.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Add-AzureRmAutoscaleSetting.md ---- - -# Add-AzureRmAutoscaleSetting - -## SYNOPSIS -Creates an Autoscale setting. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### UpdateAutoscaleSetting -``` -Add-AzureRmAutoscaleSetting -InputObject <PSAutoscaleSetting> -ResourceGroupName <String> [-DisableSetting] - [-AutoscaleProfile <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.AutoscaleProfile]>] - [-Notification <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.AutoscaleNotification]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### CreateAutoscaleSetting -``` -Add-AzureRmAutoscaleSetting -Location <String> -Name <String> -ResourceGroupName <String> [-DisableSetting] - [-AutoscaleProfile <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.AutoscaleProfile]>] - -TargetResourceId <String> - [-Notification <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.AutoscaleNotification]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmAutoscaleSetting** cmdlet creates an Autoscale setting. -This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating, modifying, or removing the resource. - -## EXAMPLES - -### Example 1: Create an Autoscale setting -``` -PS C:\>$Rule1 = New-AzureRmAutoscaleRule -MetricName "Requests" -MetricResourceId "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/mywebsite" -Operator GreaterThan -MetricStatistic Average -Threshold 10 -TimeGrain 00:01:00 -ScaleActionCooldown 00:05:00 -ScaleActionDirection Increase -ScaleActionScaleType ChangeCount -ScaleActionValue "1" - -PS C:\> $Rule2 = New-AzureRmAutoscaleRule -MetricName "Requests" -MetricResourceId "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/mywebsite" -Operator GreaterThan -MetricStatistic Average -Threshold 10 -TimeGrain 00:01:00 -ScaleActionCooldown 00:10:00 -ScaleActionDirection Increase -ScaleActionScaleType ChangeCount -ScaleActionValue "2" - -PS C:\> $Profile1 = New-AzureRmAutoscaleProfile -DefaultCapacity "1" -MaximumCapacity "10" -MinimumCapacity "1" -StartTimeWindow 2015-03-05T14:00:00 -EndTimeWindow 2015-03-05T14:30:00 -TimeWindowTimeZone GMT -Rules $Rule1, $Rule2 -Name "adios" - -PS C:\> $Profile2 = New-AzureRmAutoscaleProfile -DefaultCapacity "1" -MaximumCapacity "10" -MinimumCapacity "1" -Rules $Rule1, $Rule2 -Name "SecondProfileName" -RecurrenceFrequency Minute -ScheduleDays "1", "2", "3" -ScheduleHours 5, 10, 15 -ScheduleMinutes 15, 30, 45 -ScheduleTimeZone GMT - -PS C:\> Add-AzureRmAutoscaleSetting -Location "East US" -Name "MySetting" -ResourceGroupName "Default-Web-EastUS" -TargetResourceId "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm" -AutoscaleProfiles $Profile1, $Profile2 -``` - -The first two commands use New-AzureRmAutoscaleRule to create two Autoscale rules, $Rule1 and $Rule2. -The third and fourth commands use New-AzureRmAutoscaleProfile to create Autoscale profiles, $Profile1 and $Profile2, using $Rule1 and $Rule2. -The final command creates an Autoscale setting using the profiles in $Profile1 and $Profile2. - -## PARAMETERS - -### -AutoscaleProfile -Specifies a list of profiles to add to the Autoscale setting, or $Null to add no profile. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.AutoscaleProfile] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableSetting -Disables an existing Autoscale setting. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -The complete spec of an AutoscaleSetting - -```yaml -Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSAutoscaleSetting -Parameter Sets: UpdateAutoscaleSetting -Aliases: SettingSpec - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the Autoscale setting. - -```yaml -Type: System.String -Parameter Sets: CreateAutoscaleSetting -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Autoscale setting to create. - -```yaml -Type: System.String -Parameter Sets: CreateAutoscaleSetting -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Notification -Specifies a list of comma-separated notifications. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.AutoscaleNotification] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for the resource associated with the Autoscale setting. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetResourceId -Specifies the ID of the resource to autoscale. - -```yaml -Type: System.String -Parameter Sets: CreateAutoscaleSetting -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSAutoscaleSetting - -### System.String - -### System.Management.Automation.SwitchParameter - -### System.Collections.Generic.List`1[[Microsoft.Azure.Management.Monitor.Management.Models.AutoscaleProfile, Microsoft.Azure.Commands.Insights, Version=5.1.0.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Management.Monitor.Management.Models.AutoscaleNotification, Microsoft.Azure.Commands.Insights, Version=5.1.0.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSAddAutoscaleSettingOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutoscaleSetting](./Get-AzureRmAutoscaleSetting.md) - -[New-AzureRmAutoscaleProfile](./New-AzureRmAutoscaleProfile.md) - -[New-AzureRmAutoscaleRule](./New-AzureRmAutoscaleRule.md) - -[Remove-AzureRmAutoscaleSetting](./Remove-AzureRmAutoscaleSetting.md) - - diff --git a/azurermps-6.13.0/AzureRM.Insights/Add-AzureRmLogProfile.md b/azurermps-6.13.0/AzureRM.Insights/Add-AzureRmLogProfile.md deleted file mode 100644 index d5c2459b28..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/Add-AzureRmLogProfile.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 18D5B95E-4CF1-4C79-AE8B-9F4DA49B46A9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/add-azurermlogprofile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Add-AzureRmLogProfile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Add-AzureRmLogProfile.md ---- - -# Add-AzureRmLogProfile - -## SYNOPSIS -Creates a new activity log profile. This profile is used to either archive the activity log to an Azure storage account or stream it to an Azure event hub in the same subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmLogProfile -Name <String> [-StorageAccountId <String>] [-ServiceBusRuleId <String>] - [-RetentionInDays <Int32>] -Location <System.Collections.Generic.List`1[System.String]> - [-Category <System.Collections.Generic.List`1[System.String]>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmLogProfile** cmdlet creates a log profile. -- **Storage Account** - Only standard storage account (premium storage account is not supported) is supported. It could either be of type ARM or Classic. If it's logged to a storage account, the cost of storing the activity log is billed at normal standard storage rates. There could be only one log profile per subscription consequentially only one storage account per subscription can be used to export activity log. -- **Event Hub** - There could be only one log profile per subscription consequentially only one event hub per subscription can be used to export activity log. If activity log is streamed to an event hub, standard event hub pricing will apply. -In the activity log, events can pertain to a region or could be "Global". Global essentially means these events are region agnostics and are independent of region, in fact majority of events fall into this category. If the activity log profile is set from the portal, it implicitly adds "Global" along with any other region selected in the user interface. When using the cmdlet, the location as "Global" must be explicitly mentioned apart from any other region. -**Note** :- **Failing to set "Global" in the locations will result in a majority of activity log not getting exported.** -This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating, modifying, or removing the resource. - -## EXAMPLES - -### Example 1 : Add a new log profile to export the activity log matching the location condition to a storage account -``` -Add-AzureRmLogProfile -Location "Global","West US" -Name ExportLogProfile -StorageAccountId /subscriptions/40gpe80s-9sb7-4f07-9042-b1b6a92ja9fk/resourceGroups/activitylogRG/providers/Microsoft.Storage/storageAccounts/activitylogstorageaccount -``` - -## PARAMETERS - -### -Category -Specifies the list of categories. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the log profile. -Valid values: Run below cmdlet to get the latest list of locations. -Get-AzureLocation | Select DisplayName - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the profile. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RetentionInDays -Specifies the retention policy, in days. This is the number of days the logs are preserved in the storage account specified. To retain the data forever set this to **0**. If it's not specified, then it defaults to **0**. Normal standard storage or event hub billing rates will apply for data retention. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceBusRuleId -Specifies the ID of the Service Bus rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountId -Specifies the ID of the Storage account. ID is the fully qualified Resource ID of the storage account for example -/subscriptions/40gpe80s-9sb7-4f07-9042-b1b6a92ja9fk/resourceGroups/activitylogRG/providers/Microsoft.Storage/storageAccounts/activitylogstorageaccount - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSLogProfile - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLogProfile](./Get-AzureRmLogProfile.md) - -[Remove-AzureRmLogProfile](./Remove-AzureRmLogProfile.md) - - diff --git a/azurermps-6.13.0/AzureRM.Insights/Add-AzureRmMetricAlertRule.md b/azurermps-6.13.0/AzureRM.Insights/Add-AzureRmMetricAlertRule.md deleted file mode 100644 index 216c555c5a..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/Add-AzureRmMetricAlertRule.md +++ /dev/null @@ -1,344 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: A90564B5-57D7-48EB-976D-38C03D930289 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/add-azurermmetricalertrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Add-AzureRmMetricAlertRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Add-AzureRmMetricAlertRule.md ---- - -# Add-AzureRmMetricAlertRule - -## SYNOPSIS -Adds or updates a metric-based alert rule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmMetricAlertRule -WindowSize <TimeSpan> -Operator <ConditionOperator> -Threshold <Double> - -TargetResourceId <String> -MetricName <String> -TimeAggregationOperator <TimeAggregationOperator> - -Location <String> [-Description <String>] [-DisableRule] -ResourceGroupName <String> -Name <String> - [-Action <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.RuleAction]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmMetricAlertRule** cmdlet adds or updates a metric-based alert rule. -The added rule is associated with a resource group and has a name. -This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating, modifying, or removing the resource. - -## EXAMPLES - -### Example 1: Add a metric alert rule to a website -``` -PS C:\>Add-AzureRMMetricAlertRule -Name "metricRule5" -Location "East US" -ResourceGroup "Default-Web-EastUS" -Operator GreaterThan -Threshold 2 -WindowSize 00:05:00 -MetricName "Requests" -Description "Pura Vida" -TimeAggregationOperator Total -RequestId StatusCode ---------- ---------- -33574ccf-0b01-43b4-aa97-87e6bbcf1c11 Created -``` - -This command creates a metric alert rule for a website. - -### Example 2: Disable a rule -``` -PS C:\>Add-AzureRMMetricAlertRule -Name "metricRule5" -Location "East US" -ResourceGroup Default-Web-EastUS -Operator GreaterThan -Threshold 2 -WindowSize 00:05:00 -MetricName "Requests" -TimeAggregationOperator Total -RequestId StatusCode ---------- ---------- -96c489f1-8529-46e1-a76d-2c1463ca3116 OK -``` - -This command disables a rule. -If the rule does not exist, it creates it disabled. -If the rule exists, then it just disables it. - -### Example 3: Add a rule with actions -``` -PS C:\>Add-AzureRmMetricAlertRule -Name "metricRule5" -Location "East US" -ResourceGroup "Default-Web-EastUS" -Operator GreaterThan -Threshold 1 -TargetResourceId "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/mywebsite" -MetricName "Requests" -TimeAggregationOperator Total -RequestId StatusCode ---------- ---------- -9a5bc388-c7ac-4dc6-aa70-f4bc29c2c712 OK -``` - -This command creates a metric alert rule for a website. - -## PARAMETERS - -### -Action -Specifies a comma-separated list of actions. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.RuleAction] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisableRule -Disables the rule. -If you do not specify this parameter, the rule is enabled. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the location where the rule is defined. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MetricName -Specifies the name of the metric the rule is monitoring. -Specify this parameter only for metric-based rules. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Operator -Specifies the relational operator for the condition of the rule. -The acceptable values for this parameter are: -- GreaterThan -- GreaterThanOrEqual -- LessThan -- LessThanOrEqual - -```yaml -Type: Microsoft.Azure.Management.Monitor.Management.Models.ConditionOperator -Parameter Sets: (All) -Aliases: -Accepted values: GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for the rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetResourceId -Specifies the ID of the resource the rule is monitoring. NOTE: This property cannot be updated for an existing alert rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Threshold -Specifies the threshold of the rule. - -```yaml -Type: System.Double -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TimeAggregationOperator -Specifies the aggregation operator to apply to the time window when the rule is being evaluated. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.Monitor.Management.Models.TimeAggregationOperator] -Parameter Sets: (All) -Aliases: -Accepted values: Average, Minimum, Maximum, Total, Last - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowSize -Specifies the time window size for the rule to compute its data. - -```yaml -Type: System.TimeSpan -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.TimeSpan - -### Microsoft.Azure.Management.Monitor.Management.Models.ConditionOperator - -### System.Double - -### System.String - -### System.Nullable`1[[Microsoft.Azure.Management.Monitor.Management.Models.TimeAggregationOperator, Microsoft.Azure.Commands.Insights, Version=5.1.0.0, Culture=neutral, PublicKeyToken=null]] - -### System.Management.Automation.SwitchParameter - -### System.Collections.Generic.List`1[[Microsoft.Azure.Management.Monitor.Management.Models.RuleAction, Microsoft.Azure.Commands.Insights, Version=5.1.0.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSAddAlertRuleOperationResponse - -## NOTES - -## RELATED LINKS - -[Set-AzureRmActivityLogAlert](./Set-AzureRmActivityLogAlert.md) - -[Add-AzureRmWebtestAlertRule](./Add-AzureRmWebtestAlertRule.md) - -[Get-AzureRmAlertHistory](./Get-AzureRmAlertHistory.md) - -[Get-AzureRmAlertRule](./Get-AzureRmAlertRule.md) - -[New-AzureRmAlertRuleEmail](./New-AzureRmAlertRuleEmail.md) - -[New-AzureRmAlertRuleWebhook](./New-AzureRmAlertRuleWebhook.md) - -[Remove-AzureRmAlertRule](./Remove-AzureRmAlertRule.md) - - diff --git a/azurermps-6.13.0/AzureRM.Insights/Add-AzureRmWebtestAlertRule.md b/azurermps-6.13.0/AzureRM.Insights/Add-AzureRmWebtestAlertRule.md deleted file mode 100644 index 3325943200..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/Add-AzureRmWebtestAlertRule.md +++ /dev/null @@ -1,290 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: FBAE5F75-1E28-4F1C-A9ED-20075FFD4AC7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/add-azurermwebtestalertrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Add-AzureRmWebtestAlertRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Add-AzureRmWebtestAlertRule.md ---- - -# Add-AzureRmWebtestAlertRule - -## SYNOPSIS -Adds or updates a webtest alert rule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmWebtestAlertRule -MetricName <String> -TargetResourceUri <String> -WindowSize <TimeSpan> - -FailedLocationCount <Int32> [-MetricNamespace <String>] -Location <String> [-Description <String>] - [-DisableRule] -ResourceGroupName <String> -Name <String> - [-Action <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.RuleAction]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmWebtestAlertRule** cmdlet adds or updates an alert rule of either metric, event, or webtest type. -The added rule is associated to a resource group and has a name. -This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating, modifying, or removing the resource. - -## EXAMPLES - -### Example 1: Add a webtest alert rule -``` -PS C:\>Add-AzureRmWebtestAlertRule -Name "webtestRule" -Location "East US" -ResourceGroup "Default-Web-EastUS" -WindowSize 00:05:00 -MetricName "metric" -TargetResourceUri ":/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourcegroups/Default-Web-WestUS/providers/microsoft.insights/webtests/leowebtestr1-webtestr1" -Description "Nice Webtest rule" -Failed 3 -RequestId StatusCode ---------- ---------- -9a5bc388-c7ac-4dc6-aa70-f4bc29c2c712 OK -``` - -This command adds or updates a webtest alert rule. - -## PARAMETERS - -### -Action -Specifies a comma-separated list of actions. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.RuleAction] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisableRule -Disables the rule. -If you do not specify this parameter, the rule is enabled. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FailedLocationCount -Specifies the failed location count for the webtest rules. -This is similar to the threshold in the other types of rules. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the location where the rule is defined. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MetricName -Specifies the name of the metric. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MetricNamespace -Specifies the metric namespace for rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetResourceUri -Specifies the resource ID of the webtest. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowSize -Specifies the time window size for the rule to compute its data. - -```yaml -Type: System.TimeSpan -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.TimeSpan - -### System.Int32 - -### System.Management.Automation.SwitchParameter - -### System.Collections.Generic.List`1[[Microsoft.Azure.Management.Monitor.Management.Models.RuleAction, Microsoft.Azure.Commands.Insights, Version=5.1.0.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSAddAlertRuleOperationResponse - -## NOTES - -## RELATED LINKS - -[Set-AzureRmActivityLogAlert](./Set-AzureRmActivityLogAlert.md) - -[Add-AzureRmMetricAlertRule](./Add-AzureRmMetricAlertRule.md) - -[Get-AzureRmAlertHistory](./Get-AzureRmAlertHistory.md) - -[New-AzureRmAlertRuleWebhook](./New-AzureRmAlertRuleWebhook.md) - - diff --git a/azurermps-6.13.0/AzureRM.Insights/AzureRM.Insights.md b/azurermps-6.13.0/AzureRM.Insights/AzureRM.Insights.md deleted file mode 100644 index 2328f2f49a..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/AzureRM.Insights.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -Module Name: AzureRM.Insights -Module Guid: 698c387c-bd6b-41c6-82ce-721f1ef39548 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights -Help Version: 4.0.4.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/AzureRM.Insights.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/AzureRM.Insights.md ---- - -# AzureRM.Insights Module -## Description -This topic displays help topics for the Azure Insights Cmdlets. - -## AzureRM.Insights Cmdlets -### [Add-AzureRmAutoscaleSetting](Add-AzureRmAutoscaleSetting.md) -Creates an Autoscale setting. - -### [Add-AzureRmLogProfile](Add-AzureRmLogProfile.md) -Creates a new activity log profile. This profile is used to either archive the activity log to an Azure storage account or stream it to an Azure event hub in the same subscription. - -### [Add-AzureRmMetricAlertRule](Add-AzureRmMetricAlertRule.md) -Adds or updates a metric-based alert rule. - -### [Add-AzureRmWebtestAlertRule](Add-AzureRmWebtestAlertRule.md) -Adds or updates a webtest alert rule. - -### [Disable-AzureRmActivityLogAlert](Disable-AzureRmActivityLogAlert.md) -Disables an activity log alert and sets its tags. - -### [Enable-AzureRmActivityLogAlert](Enable-AzureRmActivityLogAlert.md) -Enables an activity log alert and sets its Tags. - -### [Get-AzureRmActionGroup](Get-AzureRmActionGroup.md) -Gets action group(s). - -### [Get-AzureRmActivityLogAlert](Get-AzureRmActivityLogAlert.md) -Gets one or more activity log alert resources. - -### [Get-AzureRmAlertHistory](Get-AzureRmAlertHistory.md) -Gets the history of alerts. - -### [Get-AzureRmAlertRule](Get-AzureRmAlertRule.md) -Gets alert rules. - -### [Get-AzureRmAutoscaleHistory](Get-AzureRmAutoscaleHistory.md) -Gets the Autoscale history. - -### [Get-AzureRmAutoscaleSetting](Get-AzureRmAutoscaleSetting.md) -Gets Autoscale settings. - -### [Get-AzureRmDiagnosticSetting](Get-AzureRmDiagnosticSetting.md) -Gets the logged categories and time grains. - -### [Get-AzureRmLog](Get-AzureRmLog.md) -Gets a log of events. - -### [Get-AzureRmLogProfile](Get-AzureRmLogProfile.md) -Gets a log profile. - -### [Get-AzureRmMetric](Get-AzureRmMetric.md) -Gets the metric values of a resource. - -### [Get-AzureRmMetricDefinition](Get-AzureRmMetricDefinition.md) -Gets metric definitions. - -### [New-AzureRmActionGroup](New-AzureRmActionGroup.md) -Creates an ActionGroup reference object in memory. - -### [New-AzureRmActionGroupReceiver](New-AzureRmActionGroupReceiver.md) -Creates an new action group receiver. - -### [New-AzureRmActivityLogAlertCondition](New-AzureRmActivityLogAlertCondition.md) -Creates an new activity log alert condition object in memory. - -### [New-AzureRmAlertRuleEmail](New-AzureRmAlertRuleEmail.md) -Creates an email action for an alert rule. - -### [New-AzureRmAlertRuleWebhook](New-AzureRmAlertRuleWebhook.md) -Creates an alert rule webhook. - -### [New-AzureRmAutoscaleNotification](New-AzureRmAutoscaleNotification.md) -Creates an Autoscale email notification. - -### [New-AzureRmAutoscaleProfile](New-AzureRmAutoscaleProfile.md) -Creates an Autoscale profile. - -### [New-AzureRmAutoscaleRule](New-AzureRmAutoscaleRule.md) -Creates an Autoscale rule. - -### [New-AzureRmAutoscaleWebhook](New-AzureRmAutoscaleWebhook.md) -Creates an Autoscale webhook. - -### [New-AzureRmMetricFilter](New-AzureRmMetricFilter.md) -Creates a metric dimension filter that can be used to query metrics. - -### [Remove-AzureRmActionGroup](Remove-AzureRmActionGroup.md) -Removes an action group. - -### [Remove-AzureRmActivityLogAlert](Remove-AzureRmActivityLogAlert.md) -Removes an activity log alert. - -### [Remove-AzureRmAlertRule](Remove-AzureRmAlertRule.md) -Removes an alert rule. - -### [Remove-AzureRmAutoscaleSetting](Remove-AzureRmAutoscaleSetting.md) -Removes an Autoscale setting. - -### [Remove-AzureRmDiagnosticSetting](Remove-AzureRmDiagnosticSetting.md) -Remove a diagnostic setting for the a resource. - -### [Remove-AzureRmLogProfile](Remove-AzureRmLogProfile.md) -Removes a log profile. - -### [Set-AzureRmActionGroup](Set-AzureRmActionGroup.md) -Creates a new or updates an existing action group. - -### [Set-AzureRmActivityLogAlert](Set-AzureRmActivityLogAlert.md) -Creates a new or sets an existing activity log alert. - -### [Set-AzureRmDiagnosticSetting](Set-AzureRmDiagnosticSetting.md) -Sets the logs and metrics settings for the resource. - diff --git a/azurermps-6.13.0/AzureRM.Insights/Disable-AzureRmActivityLogAlert.md b/azurermps-6.13.0/AzureRM.Insights/Disable-AzureRmActivityLogAlert.md deleted file mode 100644 index a095908b24..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/Disable-AzureRmActivityLogAlert.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: B5F2388E-0136-4F8A-8577-67CE2A45671E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/disable-azurermactivitylogalert -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Disable-AzureRmActivityLogAlert.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Disable-AzureRmActivityLogAlert.md ---- - -# Disable-AzureRmActivityLogAlert - -## SYNOPSIS -Disables an activity log alert and sets its tags. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DisableByNameAndResourceGroup -``` -Disable-AzureRmActivityLogAlert -Name <String> -ResourceGroupName <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### DisableByInputObject -``` -Disable-AzureRmActivityLogAlert -InputObject <PSActivityLogAlertResource> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### DisableByResourceId -``` -Disable-AzureRmActivityLogAlert -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Disable-AzureRmActivityLogAlert** cmdlet disables and activity log alert and allows setting its tags. -This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually patching the resource. - -## EXAMPLES - -### Example 1: Disable an activity log alert -``` -PS C:\>Disable-AzureRmActivityLogAlert -Name "alert1" -ResourceGroupName "Default-ActivityLogsAlerts" -``` - -This command disables the activity log alert called alert1 in the resource group Default-ActivityLogsAlerts. -This command changes the tags property of the activity log alert called alert1 and disables it. - -### Example 2: Disable an activity log alert using a PSActivityLogAlertResource object as input -``` -PS C:\>$obj = Get-AzureRmActivityLogAlert -ResourceGroup "Default-activityLogAlerts" -Name "alert1" -PS C:\>Disable-AzureRmActivityLogAlert -InputObject $obj -``` - -This command disables an activity log alert called alert1. For this it uses a PSActivityLogAlertResource object as input argument. - -### Example 3: Disable the ActivityLogAlert using the ResourceId parameter -``` -PS C:\>Find-AzureRmResource -ResourceGroupEquals "myResourceGroup" -ResourceNameEquals "myLogAlert" | Disable-AzureRmActivityLogAlert -``` - -This command disables the ActivityLogAlert using the ResourceId parameter from the pipe. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Sets the InputObject tags property of the call to extract the required name, resource group name, and the optional tag properties. - -```yaml -Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSActivityLogAlertResource -Parameter Sets: DisableByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the activity log alert. - -```yaml -Type: System.String -Parameter Sets: DisableByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group where the alert resource is going to exist. - -```yaml -Type: System.String -Parameter Sets: DisableByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Sets the ResourceId tags property of the call to extract the required name, resource group name properties. - -```yaml -Type: System.String -Parameter Sets: DisableByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSActivityLogAlertResource -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSActivityLogAlertResource - -## NOTES - -## RELATED LINKS - -[Set-AzureRmActivityLogAlert](./Set-AzureRmActivityLogAlert.md) - -[Get-AzureRmActivityLogAlert](./Get-AzureRmActivityLogAlert.md) - -[Remove-AzureRmActivityLogAlert](./Remove-AzureRmActivityLogAlert.md) - -[New-AzureRmActionGroup](./New-AzureRmActionGroup.md) - - - -[Enable-AzureRmActivityLogAlert](./Enable-AzureRmActivityLogAlert.md) diff --git a/azurermps-6.13.0/AzureRM.Insights/Enable-AzureRmActivityLogAlert.md b/azurermps-6.13.0/AzureRM.Insights/Enable-AzureRmActivityLogAlert.md deleted file mode 100644 index b1f88499f6..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/Enable-AzureRmActivityLogAlert.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: B5F2388E-0136-4F8A-8577-67CE2A45671E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/enable-azurermactivitylogalert -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Enable-AzureRmActivityLogAlert.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Enable-AzureRmActivityLogAlert.md ---- - -# Enable-AzureRmActivityLogAlert - -## SYNOPSIS -Enables an activity log alert and sets its Tags. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### EnableByNameAndResourceGroup -``` -Enable-AzureRmActivityLogAlert -Name <String> -ResourceGroupName <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### EnableByInputObject -``` -Enable-AzureRmActivityLogAlert -InputObject <PSActivityLogAlertResource> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### EnableByResourceId -``` -Enable-AzureRmActivityLogAlert -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Enable-AzureRmActivityLogAlert** cmdlet allows enabling an activity log alert and setting its tags. -This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually patching the resource. - -## EXAMPLES - -### Example 1: Disable an activity log alert -``` -PS C:\>Enable-AzureRmActivityLogAlert -Name "alert1" -ResourceGroupName "Default-ActivityLogsAlerts" -``` - -This command enables the activity log alert called alert1 in the resource group Default-ActivityLogsAlerts. - -### Example 2: Enable an activity log alert using a PSActivityLogAlertResource object as input -``` -PS C:\>$obj = Get-AzureRmActivityLogAlert -ResourceGroup "Default-activityLogAlerts" -Name "alert1" -PS C:\>Enable-AzureRmActivityLogAlert -InputObject $obj -``` - -This command enables an activity log alert called alert1. For this it uses a PSActivityLogAlertResource object as input argument. - -### Example 3: Enable the ActivityLogAlert using the ResourceId parameter -``` -PS C:\>Find-AzureRmResource -ResourceGroupEquals "myResourceGroup" -ResourceNameEquals "myLogAlert" | Enable-AzureRmActivityLogAlert -``` - -This command enables the ActivityLogAlert using the ResourceId parameter from the pipe. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Sets the InputObject tags property of the call to extract the required name, resource group name, and the optional tags properties. - -```yaml -Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSActivityLogAlertResource -Parameter Sets: EnableByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the activity log alert. - -```yaml -Type: System.String -Parameter Sets: EnableByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group where the alert resource is going to exist. - -```yaml -Type: System.String -Parameter Sets: EnableByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Sets the ResourceId tags property of the call to extract the required name, resource group name properties. - -```yaml -Type: System.String -Parameter Sets: EnableByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSActivityLogAlertResource -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSActivityLogAlertResource - -## NOTES - -## RELATED LINKS - -[Set-AzureRmActivityLogAlert](./Set-AzureRmActivityLogAlert.md) - -[Get-AzureRmActivityLogAlert](./Get-AzureRmActivityLogAlert.md) - -[Remove-AzureRmActivityLogAlert](./Remove-AzureRmActivityLogAlert.md) - -[New-AzureRmActionGroup](./New-AzureRmActionGroup.md) - - - -[Disable-AzureRmActivityLogAlert](./Disable-AzureRmActivityLogAlert.md) diff --git a/azurermps-6.13.0/AzureRM.Insights/Get-AzureRmActionGroup.md b/azurermps-6.13.0/AzureRM.Insights/Get-AzureRmActionGroup.md deleted file mode 100644 index aa4533ffba..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/Get-AzureRmActionGroup.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 1CA26790-C791-4BFD-B986-70F28E3B095B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/get-azurermactiongroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmActionGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmActionGroup.md ---- - -# Get-AzureRmActionGroup - -## SYNOPSIS -Gets action group(s). - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### BySubscriptionOrResourceGroup (Default) -``` -Get-AzureRmActionGroup [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByName -``` -Get-AzureRmActionGroup -ResourceGroupName <String> -Name <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmActionGroup** cmdlet gets one or more action groups. - -## EXAMPLES - -### Example 1: Get an action group by subscription ID -``` -PS C:\>Get-AzureRmActionGroup -``` - -This command lists all the action group for the current subscription. - -### Example 2: Get action groups for the given resource group -``` -PS C:\>Get-AzureRmActionGroup -ResourceGroup "Default-activityLogAlerts" -``` - -This command lists action groups for the given resource group. - -### Example 3: Get an action group. -``` -PS C:\>Get-AzureRmActionGroup -ResourceGroup "Default-activityLogAlerts" -Name "actionGroup1" -``` - -This command lists one (a list with a single element) action group. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the action group. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name - -```yaml -Type: System.String -Parameter Sets: BySubscriptionOrResourceGroup -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupResource - -## NOTES - -## RELATED LINKS - -[Set-AzureRmActionGroup](./Set-AzureRmActionGroup.md) -[Remove-AzureRmActionGroup](./Remove-AzureRmActionGroup.md) -[New-AzureRmActionGroupReceiver](./New-AzureRmActionGroupReceiver.md) diff --git a/azurermps-6.13.0/AzureRM.Insights/Get-AzureRmActivityLogAlert.md b/azurermps-6.13.0/AzureRM.Insights/Get-AzureRmActivityLogAlert.md deleted file mode 100644 index 6aba55c396..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/Get-AzureRmActivityLogAlert.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 85492E00-3776-4F20-A444-9C28CC6154B7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/get-azurermactivitylogalert -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmActivityLogAlert.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmActivityLogAlert.md ---- - -# Get-AzureRmActivityLogAlert - -## SYNOPSIS -Gets one or more activity log alert resources. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetByNameAndResourceGroup -``` -Get-AzureRmActivityLogAlert [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetByResourceGroup -``` -Get-AzureRmActivityLogAlert [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmActivityLogAlert** cmdlet gets one or more activity log alert resources. - -## EXAMPLES - -### Example 1: Get a activity log alerts by subscription ID -``` -PS C:\>Get-AzureRmActivityLogAlert -``` - -This command lists all the activity log alerts for the current subscription. - -### Example 2: Get activity log alerts for the given resource group -``` -PS C:\>Get-AzureRmActivityLogAlert -ResourceGroupName "Default-activityLogAlerts" -``` - -This command lists activity log alerts for the given resource group. - -### Example 3: Get an activity log alert. -``` -PS C:\>Get-AzureRmActivityLogAlert -ResourceGroupName "Default-activityLogAlerts" -Name "alert1" -``` - -This command lists one (a list with a single element) activity log alert. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the activity log alert. - -```yaml -Type: System.String -Parameter Sets: GetByNameAndResourceGroup -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group where the alert resource exists. -If Name is not null or empty, this parameter must contain and non empty string. - -```yaml -Type: System.String -Parameter Sets: GetByNameAndResourceGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: GetByResourceGroup -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSActivityLogAlertResource - -## NOTES - -## RELATED LINKS - -[Set-AzureRmActivityLogAlert](./Set-AzureRmActivityLogAlert.md) - -[Remove-AzureRmActivityLogAlert](./Remove-AzureRmActivityLogAlert.md) - -[New-AzureRmActionGroup](./New-AzureRmActionGroup.md) diff --git a/azurermps-6.13.0/AzureRM.Insights/Get-AzureRmAlertHistory.md b/azurermps-6.13.0/AzureRM.Insights/Get-AzureRmAlertHistory.md deleted file mode 100644 index 492b731af3..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/Get-AzureRmAlertHistory.md +++ /dev/null @@ -1,407 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 1EDFCAC4-6A66-4124-8192-B7F0D3C5BCFC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/get-azurermalerthistory -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmAlertHistory.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmAlertHistory.md ---- - -# Get-AzureRmAlertHistory - -## SYNOPSIS -Gets the history of alerts. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmAlertHistory [-ResourceId <String>] [-StartTime <DateTime>] [-EndTime <DateTime>] [-Status <String>] - [-Caller <String>] [-DetailedOutput] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmAlertHistory** cmdlet gets the history of alerts as they are enabled, disabled, fired, resolved, and so on. - -## EXAMPLES - -### Example 1: Get the alert history -``` -PS C:\>Get-AzureRmAlertHistory -StartTime 2015-02-11T11:00:00 -EndTime 2015-02-11T12:00:00 -DetailedOutput -Authorization : -Caller : Microsoft.Insights/alertRules -Claims : - http://schemas.xmlsoap.org/ws/2005/05/identity/claims/spn: Microsoft.Insights/alertRules -CorrelationId : /subscriptions/00001111-aaaa-2222-bbbb-3333cccc4444/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/incidents/L3N1YnNj - cmlwdGlvbnMvYTkzZmIwN2MtNmM5My00MGJlLWJmM2ItNGYwZGViYTEwZjRiL3Jlc291cmNlR3JvdXBzL0RlZmF1bHQtV2Vi - LUVhc3RVUy9wcm92aWRlcnMvbWljcm9zb2Z0Lmluc2lnaHRzL2FsZXJ0cnVsZXMvY2hlY2tydWxlMy00YjEzNTQwMS1hMzBj - LTQyMjQtYWUyMS1mYTUzYTViZDI1M2QwNjM1NTkyNzg4ODU3OTI5OTI2 -Description : 'CpuTime GreaterThan 3 ([Count]) in the last 5 minutes' has been resolved for Website: - garyyang1 (Default-Web-EastUS) -EventDataId : 769fab1c-fc9f-4e18-bc3a-fa79fbdd3616 -EventName : Alert -EventSource : microsoft.insights/alertrules -EventTimestamp : 2/11/2015 7:14:45 PM -HttpRequest : -Id : /subscriptions/00001111-aaaa-2222-bbbb-3333cccc4444/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/events/769fab1c-fc - 9f-4e18-bc3a-fa79fbdd3616/ticks/635592788857929926 -Level : Informational -OperationId : /subscriptions/00001111-aaaa-2222-bbbb-3333cccc4444/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/incidents/L3N1YnNj - cmlwdGlvbnMvYTkzZmIwN2MtNmM5My00MGJlLWJmM2ItNGYwZGViYTEwZjRiL3Jlc291cmNlR3JvdXBzL0RlZmF1bHQtV2Vi - LUVhc3RVUy9wcm92aWRlcnMvbWljcm9zb2Z0Lmluc2lnaHRzL2FsZXJ0cnVsZXMvY2hlY2tydWxlMy00YjEzNTQwMS1hMzBj - LTQyMjQtYWUyMS1mYTUzYTViZDI1M2QwNjM1NTkyNzg4ODU3OTI5OTI2 -OperationName : ResolveAlert -Properties : - RuleUri : /subscriptions/00001111-aaaa-2222-bbbb-3333cccc4444/resourceGroups/Default-Web- - EastUS/providers/microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d - RuleName : checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d - RuleDescription: - Threshold : 3 - WindowSizeInMinutes: 5 - Aggregation : Total - Operator : GreaterThan - MetricName : CpuTime - MetricUnit : Count -ResourceGroupName : Default-Web-EastUS -ResourceProviderName : microsoft.insights -ResourceId : /subscriptions/00001111-aaaa-2222-bbbb-3333cccc4444/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d -Status : Resolved -SubmissionTimestamp : 2/11/2015 7:14:45 PM -SubscriptionId : 00001111-aaaa-2222-bbbb-3333cccc4444 -SubStatus : -Authorization : -Caller : Microsoft.Insights/alertRules -Claims : - http://schemas.xmlsoap.org/ws/2005/05/identity/claims/spn: Microsoft.Insights/alertRules -CorrelationId : /subscriptions/00001111-aaaa-2222-bbbb-3333cccc4444/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/incidents/L3N1YnNj - cmlwdGlvbnMvYTkzZmIwN2MtNmM5My00MGJlLWJmM2ItNGYwZGViYTEwZjRiL3Jlc291cmNlR3JvdXBzL0RlZmF1bHQtV2Vi - LUVhc3RVUy9wcm92aWRlcnMvbWljcm9zb2Z0Lmluc2lnaHRzL2FsZXJ0cnVsZXMvY2hlY2tydWxlMy00YjEzNTQwMS1hMzBj - LTQyMjQtYWUyMS1mYTUzYTViZDI1M2QwNjM1NTkyNzgyODY1MDU5NTE0 -Description : 'CpuTime GreaterThan 3 ([Count]) in the last 5 minutes' was activated for Website: garyyang1 - (Default-Web-EastUS) -EventDataId : 66277c94-2097-4f5f-860d-e585f1206cd7 -EventName : Alert -EventSource : microsoft.insights/alertrules -EventTimestamp : 2/11/2015 7:04:46 PM -HttpRequest : -Id : /subscriptions/00001111-aaaa-2222-bbbb-3333cccc4444/resourceGroups/Default-Web-EastUS/providers/ - microsoft.web/sites/garyyang1/events/66277c94-2097-4f5f-860d-e585f1206cd7/ticks/6355927828650595 - 14 -Level : Error -OperationId : /subscriptions/00001111-aaaa-2222-bbbb-3333cccc4444/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/incidents/L3N1YnNj - cmlwdGlvbnMvYTkzZmIwN2MtNmM5My00MGJlLWJmM2ItNGYwZGViYTEwZjRiL3Jlc291cmNlR3JvdXBzL0RlZmF1bHQtV2Vi - LUVhc3RVUy9wcm92aWRlcnMvbWljcm9zb2Z0Lmluc2lnaHRzL2FsZXJ0cnVsZXMvY2hlY2tydWxlMy00YjEzNTQwMS1hMzBj - LTQyMjQtYWUyMS1mYTUzYTViZDI1M2QwNjM1NTkyNzgyODY1MDU5NTE0 -OperationName : ActivateAlert -Properties : - RuleUri : /subscriptions/00001111-aaaa-2222-bbbb-3333cccc4444/resourceGroups/Default-Web- - EastUS/providers/microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d - RuleName : checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d - RuleDescription: - Threshold : 3 - WindowSizeInMinutes: 5 - Aggregation : Total - Operator : GreaterThan - MetricName : CpuTime - MetricUnit : Count -ResourceGroupName : Default-Web-EastUS -ResourceProviderName : microsoft.web -ResourceId : /subscriptions/00001111-aaaa-2222-bbbb-3333cccc4444/resourceGroups/Default-Web-EastUS/providers/ - microsoft.web/sites/garyyang1 -Status : Activated -SubmissionTimestamp : 2/11/2015 7:04:46 PM -SubscriptionId : 00001111-aaaa-2222-bbbb-3333cccc4444 -SubStatus : -Authorization : -Caller : Microsoft.Insights/alertRules -Claims : - http://schemas.xmlsoap.org/ws/2005/05/identity/claims/spn: Microsoft.Insights/alertRules -CorrelationId : /subscriptions/00001111-aaaa-2222-bbbb-3333cccc4444/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/incidents/L3N1YnNj - cmlwdGlvbnMvYTkzZmIwN2MtNmM5My00MGJlLWJmM2ItNGYwZGViYTEwZjRiL3Jlc291cmNlR3JvdXBzL0RlZmF1bHQtV2Vi - LUVhc3RVUy9wcm92aWRlcnMvbWljcm9zb2Z0Lmluc2lnaHRzL2FsZXJ0cnVsZXMvY2hlY2tydWxlMy00YjEzNTQwMS1hMzBj - LTQyMjQtYWUyMS1mYTUzYTViZDI1M2QwNjM1NTkyNzgyODY1MDU5NTE0 -Description : 'CpuTime GreaterThan 3 ([Count]) in the last 5 minutes' was activated for Website: garyyang1 - (Default-Web-EastUS) -EventDataId : ec9f7b3c-c6ea-4b45-bd15-ff43e38491e3 -EventName : Alert -EventSource : microsoft.insights/alertrules -EventTimestamp : 2/11/2015 7:04:46 PM -HttpRequest : -Id : /subscriptions/00001111-aaaa-2222-bbbb-3333cccc4444/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/events/ec9f7b3c-c6 - ea-4b45-bd15-ff43e38491e3/ticks/635592782865059514 -Level : Error -OperationId : /subscriptions/00001111-aaaa-2222-bbbb-3333cccc4444/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/incidents/L3N1YnNj - cmlwdGlvbnMvYTkzZmIwN2MtNmM5My00MGJlLWJmM2ItNGYwZGViYTEwZjRiL3Jlc291cmNlR3JvdXBzL0RlZmF1bHQtV2Vi - LUVhc3RVUy9wcm92aWRlcnMvbWljcm9zb2Z0Lmluc2lnaHRzL2FsZXJ0cnVsZXMvY2hlY2tydWxlMy00YjEzNTQwMS1hMzBj - LTQyMjQtYWUyMS1mYTUzYTViZDI1M2QwNjM1NTkyNzgyODY1MDU5NTE0 -OperationName : ActivateAlert -Properties : - RuleUri : /subscriptions/00001111-aaaa-2222-bbbb-3333cccc4444/resourceGroups/Default-Web- - EastUS/providers/microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d - RuleName : checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d - RuleDescription: - Threshold : 3 - WindowSizeInMinutes: 5 - Aggregation : Total - Operator : GreaterThan - MetricName : CpuTime - MetricUnit : Count -ResourceGroupName : Default-Web-EastUS -ResourceProviderName : microsoft.insights -ResourceId : /subscriptions/00001111-aaaa-2222-bbbb-3333cccc4444/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d -Status : Activated -SubmissionTimestamp : 2/11/2015 7:04:46 PM -SubscriptionId : 00001111-aaaa-2222-bbbb-3333cccc4444 -SubStatus : -``` - -This command gets the alert history for the specified time frame for the current subscription. - -### Example 2: Get alert history for a specified resource -``` -PS C:\>Get-AzureRmAlertHistory -StartTime 2015-02-11T11:00:00 -EndTime 2015-02-11T12:00:00 -ResourceId "/subscriptions/00001111-aaaa-2222-bbbb-3333cccc4444/resourceGroups/Default-Web-EastUS/providers/microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d" -DetailedOutput - -Authorization : -Caller : Microsoft.Insights/alertRules -Claims : - http://schemas.xmlsoap.org/ws/2005/05/identity/claims/spn: Microsoft.Insights/alertRules -CorrelationId : /subscriptions/00001111-aaaa-2222-bbbb-3333cccc4444/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/incidents/L3N1YnNj - cmlwdGlvbnMvYTkzZmIwN2MtNmM5My00MGJlLWJmM2ItNGYwZGViYTEwZjRiL3Jlc291cmNlR3JvdXBzL0RlZmF1bHQtV2Vi - LUVhc3RVUy9wcm92aWRlcnMvbWljcm9zb2Z0Lmluc2lnaHRzL2FsZXJ0cnVsZXMvY2hlY2tydWxlMy00YjEzNTQwMS1hMzBj - LTQyMjQtYWUyMS1mYTUzYTViZDI1M2QwNjM1NTkyNzg4ODU3OTI5OTI2 -Description : 'CpuTime GreaterThan 3 ([Count]) in the last 5 minutes' has been resolved for Website: - garyyang1 (Default-Web-EastUS) -EventDataId : 769fab1c-fc9f-4e18-bc3a-fa79fbdd3616 -EventName : Alert -EventSource : microsoft.insights/alertrules -EventTimestamp : 2/11/2015 7:14:45 PM -HttpRequest : -Id : /subscriptions/00001111-aaaa-2222-bbbb-3333cccc4444/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/events/769fab1c-fc - 9f-4e18-bc3a-fa79fbdd3616/ticks/635592788857929926 -Level : Informational -OperationId : /subscriptions/00001111-aaaa-2222-bbbb-3333cccc4444/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/incidents/L3N1YnNj - cmlwdGlvbnMvYTkzZmIwN2MtNmM5My00MGJlLWJmM2ItNGYwZGViYTEwZjRiL3Jlc291cmNlR3JvdXBzL0RlZmF1bHQtV2Vi - LUVhc3RVUy9wcm92aWRlcnMvbWljcm9zb2Z0Lmluc2lnaHRzL2FsZXJ0cnVsZXMvY2hlY2tydWxlMy00YjEzNTQwMS1hMzBj - LTQyMjQtYWUyMS1mYTUzYTViZDI1M2QwNjM1NTkyNzg4ODU3OTI5OTI2 -OperationName : ResolveAlert -Properties : -RuleUri : /subscriptions/00001111-aaaa-2222-bbbb-3333cccc4444/resourceGroups/Default-Web- - EastUS/providers/microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d -RuleName : checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d -RuleDescription: -Threshold : 3 -WindowSizeInMinutes: 5 -Aggregation : Total -Operator : GreaterThan -MetricName : CpuTime -MetricUnit : Count -ResourceGroupName : Default-Web-EastUS -ResourceProviderName : microsoft.insights -ResourceId : /subscriptions/00001111-aaaa-2222-bbbb-3333cccc4444/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d -Status : Resolved -SubmissionTimestamp : 2/11/2015 7:14:45 PM -SubscriptionId : 00001111-aaaa-2222-bbbb-3333cccc4444 -SubStatus : -Authorization : -Caller : Microsoft.Insights/alertRules -Claims : - http://schemas.xmlsoap.org/ws/2005/05/identity/claims/spn: Microsoft.Insights/alertRules -CorrelationId : /subscriptions/00001111-aaaa-2222-bbbb-3333cccc4444/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/incidents/L3N1YnNj - cmlwdGlvbnMvYTkzZmIwN2MtNmM5My00MGJlLWJmM2ItNGYwZGViYTEwZjRiL3Jlc291cmNlR3JvdXBzL0RlZmF1bHQtV2Vi - LUVhc3RVUy9wcm92aWRlcnMvbWljcm9zb2Z0Lmluc2lnaHRzL2FsZXJ0cnVsZXMvY2hlY2tydWxlMy00YjEzNTQwMS1hMzBj - LTQyMjQtYWUyMS1mYTUzYTViZDI1M2QwNjM1NTkyNzgyODY1MDU5NTE0 -Description : 'CpuTime GreaterThan 3 ([Count]) in the last 5 minutes' was activated for Website: garyyang1 - (Default-Web-EastUS) -EventDataId : ec9f7b3c-c6ea-4b45-bd15-ff43e38491e3 -EventName : Alert -EventSource : microsoft.insights/alertrules -EventTimestamp : 2/11/2015 7:04:46 PM -HttpRequest : -Id : /subscriptions/00001111-aaaa-2222-bbbb-3333cccc4444/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/events/ec9f7b3c-c6 - ea-4b45-bd15-ff43e38491e3/ticks/635592782865059514 -Level : Error -OperationId : /subscriptions/00001111-aaaa-2222-bbbb-3333cccc4444/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/incidents/L3N1YnNj - cmlwdGlvbnMvYTkzZmIwN2MtNmM5My00MGJlLWJmM2ItNGYwZGViYTEwZjRiL3Jlc291cmNlR3JvdXBzL0RlZmF1bHQtV2Vi - LUVhc3RVUy9wcm92aWRlcnMvbWljcm9zb2Z0Lmluc2lnaHRzL2FsZXJ0cnVsZXMvY2hlY2tydWxlMy00YjEzNTQwMS1hMzBj - LTQyMjQtYWUyMS1mYTUzYTViZDI1M2QwNjM1NTkyNzgyODY1MDU5NTE0 -OperationName : ActivateAlert -Properties : -RuleUri : /subscriptions/00001111-aaaa-2222-bbbb-3333cccc4444/resourceGroups/Default-Web- - EastUS/providers/microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d -RuleName : checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d -RuleDescription: -Threshold : 3 -WindowSizeInMinutes: 5 -Aggregation : Total -Operator : GreaterThan -MetricName : CpuTime -MetricUnit : Count -ResourceGroupName : Default-Web-EastUS -ResourceProviderName : microsoft.insights -ResourceId : /subscriptions/00001111-aaaa-2222-bbbb-3333cccc4444/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d -Status : Activated -SubmissionTimestamp : 2/11/2015 7:04:46 PM -SubscriptionId : 00001111-aaaa-2222-bbbb-3333cccc4444 -SubStatus : -``` - -This command gets the alert rule-related events for a specified resource. - -## PARAMETERS - -### -Caller -Specifies the caller. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DetailedOutput -Displays full details in the output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EndTime -Specifies the end time of the query in local time. -The default is the current time. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Specifies the resource ID the rule is associated with. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartTime -Specifies the start time of the query in local time. -The default is the current local time minus one hour. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Status -Specifies the status. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.DateTime, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSEventData - -## NOTES - -## RELATED LINKS - - -[Add-AzureRmMetricAlertRule](./Add-AzureRmMetricAlertRule.md) - -[Add-AzureRmWebtestAlertRule](./Add-AzureRmWebtestAlertRule.md) - -[Get-AzureRmAlertRule](./Get-AzureRmAlertRule.md) - -[Remove-AzureRmAlertRule](./Remove-AzureRmAlertRule.md) - - diff --git a/azurermps-6.13.0/AzureRM.Insights/Get-AzureRmAlertRule.md b/azurermps-6.13.0/AzureRM.Insights/Get-AzureRmAlertRule.md deleted file mode 100644 index 1d890da298..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/Get-AzureRmAlertRule.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: A837077C-0A79-431C-93D2-799B2134EE69 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/get-azurermalertrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmAlertRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmAlertRule.md ---- - -# Get-AzureRmAlertRule - -## SYNOPSIS -Gets alert rules. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetByResourceGroup -``` -Get-AzureRmAlertRule -ResourceGroupName <String> [-DetailedOutput] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### GetByName -``` -Get-AzureRmAlertRule -ResourceGroupName <String> -Name <String> [-DetailedOutput] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetByResourceUri -``` -Get-AzureRmAlertRule -ResourceGroupName <String> -TargetResourceId <String> [-DetailedOutput] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmAlertRule** cmdlet gets an alert rule by its name or URI, or all alert rules from a specified resource group. - -## EXAMPLES - -### Example 1: Get alert rules for a resource group -``` -PS C:\>Get-AzureRmAlertRule -ResourceGroup "Default-Web-CentralUS" -``` - -This command gets all of the alert rules for the resource group named Default-Web-CentralUS. -The output does not contain details about the rules because the *DetailedOutput* parameter is not specified. - -### Example 2: Get an alert rule by name -``` -PS C:\>Get-AzureRmAlertRule -ResourceGroup "Default-Web-CentralUS" -Name "myalert-7da64548-214d-42ca-b12b-b245bb8f0ac8" -``` - -This command gets the alert rule named myalert-7da64548-214d-42ca-b12b-b245bb8f0ac8. -Because the *DetailedOutput* parameter is not specified, the output contains only basic information about the alert rule. - -### Example 3: Get an alert rule by name with detailed output -``` -PS C:\>Get-AzureRmAlertRule -ResourceGroup "Default-Web-CentralUS" -Name "myalert-7da64548-214d-42ca-b12b-b245bb8f0ac8" -DetailedOutput -``` - -This command gets the alert rule named myalert-7da64548-214d-42ca-b12b-b245bb8f0ac8. -The *DetailedOutput* parameter is specified, so the output is detailed. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DetailedOutput -Displays full details in the output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the alert rule to get. - -```yaml -Type: System.String -Parameter Sets: GetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetResourceId -Specifies the ID of the target resource. - -```yaml -Type: System.String -Parameter Sets: GetByResourceUri -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSAlertRule - -## NOTES - -## RELATED LINKS - - -[Add-AzureRmMetricAlertRule](./Add-AzureRmMetricAlertRule.md) - -[Add-AzureRmWebtestAlertRule](./Add-AzureRmWebtestAlertRule.md) - -[Get-AzureRmAlertHistory](./Get-AzureRmAlertHistory.md) - -[Remove-AzureRmAlertRule](./Remove-AzureRmAlertRule.md) - - diff --git a/azurermps-6.13.0/AzureRM.Insights/Get-AzureRmAutoscaleHistory.md b/azurermps-6.13.0/AzureRM.Insights/Get-AzureRmAutoscaleHistory.md deleted file mode 100644 index 2878cead93..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/Get-AzureRmAutoscaleHistory.md +++ /dev/null @@ -1,316 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: A70F4C03-E842-45D5-9323-DC5B14B569F1 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/get-azurermautoscalehistory -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmAutoscaleHistory.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmAutoscaleHistory.md ---- - -# Get-AzureRmAutoscaleHistory - -## SYNOPSIS -Gets the Autoscale history. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmAutoscaleHistory [-ResourceId <String>] [-StartTime <DateTime>] [-EndTime <DateTime>] - [-Status <String>] [-Caller <String>] [-DetailedOutput] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmAutoscaleHistory** cmdlet gets the history of events related to an Autoscale setting. - -## EXAMPLES - -### Example 1: Get all events associated with a subscription -``` -PS C:\>Get-AzureRmAutoscaleHistory -StartTime 2015-02-09T18:35:00 -EndTime 2015-02-09T18:40:00 -DetailedOutput -``` - -This command gets all of the Autoscale-related events associated with the current subscription. - -### Example 2: GetAutoscaleHistory for a particular resource -``` -PS C:\>Get-AzureRmAutoscaleHistory -StartTime 2015-02-09T18:35:00 -EndTime 2015-02-09T18:40:00 -ResourceId "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft.insights/autoscalesettings/DefaultServerFarm-Default-Web-EastUS" -DetailedOutput -Authorization : -Caller : Microsoft.Insights/autoscaleSettings -Claims : http://schemas.xmlsoap.org/ws/2005/05/identity/claims/spn: Microsoft.Insights/autoscaleSettings -CorrelationId : 00001111-aaaa-2222-bbbb-3333cccc4444 -Description : The autoscale engine attempting to scale resource '/subscriptions/a93fb07c-6c93-40be-bf3b-4f0deb - a10f4b/resourceGroups/Default-Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm' - from 1 instances count to 2 instances count. -EventDataId : c554f7ed-514c-449c-9338-13e15b4b56a3 -EventName : AutoscaleAction -EventSource : microsoft.insights/autoscalesettings -EventTimestamp : 2/10/2015 2:38:19 AM -HttpRequest : -Id : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/autoscalesettings/DefaultServerFarm-Default-Web-EastUS/events/c554f7ed-514c-4 - 49c-9338-13e15b4b56a3/ticks/635591326997519815 -Level : Informational -OperationId : 00001111-aaaa-2222-bbbb-3333cccc4444 -OperationName : ScaleUp -Properties : -Description : The autoscale engine attempting to scale resource '/subscriptions/a93fb07c-6c93 - -40be-bf3b-4f0deba10f4b/resourceGroups/Default-Web-EastUS/providers/microsoft.web/serverFarms/De - faultServerFarm' from 1 instances count to 2 instances count. -ResourceName : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web- - EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm -OldInstancesCount: 1 -NewInstancesCount: 2 -ActiveAutoscaleProfile: { - "Name": "No scheduled times", - "Capacity": { - "Minimum": "1", - "Maximum": "3", - "Default": "1" - }, - "Rules": [ - { - "MetricTrigger": { - "Name": "CpuPercentage", - "Namespace": "", - "Resource": "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default- - Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm", - "ResourceLocation": "East US", - "TimeGrain": "PT1M", - "Statistic": "Average", - "TimeWindow": "PT45M", - "TimeAggregation": "Average", - "Operator": "GreaterThanOrEqual", - "Threshold": 14.0, - "Source": "WebsiteDedicated:eastuswebspace:DefaultServerFarm" - }, - "ScaleAction": { - "Direction": "Increase", - "Type": "ChangeCount", - "Value": "1", - "Cooldown": "PT5M" - } - }, - { - "MetricTrigger": { - "Name": "CpuPercentage", - "Namespace": "", - "Resource": "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default- - Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm", - "ResourceLocation": "East US", - "TimeGrain": "PT1M", - "Statistic": "Average", - "TimeWindow": "PT45M", - "TimeAggregation": "Average", - "Operator": "LessThanOrEqual", - "Threshold": 4.0, - "Source": "WebsiteDedicated:eastuswebspace:DefaultServerFarm" - }, - "ScaleAction": { - "Direction": "Decrease", - "Type": "ChangeCount", - "Value": "1", - "Cooldown": "PT2H" - } - }, - { - "MetricTrigger": { - "Name": "BytesReceived", - "Namespace": "", - "Resource": "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default- - Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm", - "ResourceLocation": "East US", - "TimeGrain": "PT1M", - "Statistic": "Average", - "TimeWindow": "PT10M", - "TimeAggregation": "Average", - "Operator": "LessThanOrEqual", - "Threshold": 50.0, - "Source": "WebsiteDedicated:eastuswebspace:DefaultServerFarm" - }, - "ScaleAction": { - "Direction": "Decrease", - "Type": "ChangeCount", - "Value": "1", - "Cooldown": "PT10M" - } - }, - { - "MetricTrigger": { - "Name": "BytesReceived", - "Namespace": "", - "Resource": "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default- - Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm", - "ResourceLocation": "East US", - "TimeGrain": "PT1M", - "Statistic": "Average", - "TimeWindow": "PT5M", - "TimeAggregation": "Average", - "Operator": "GreaterThanOrEqual", - "Threshold": 100.0, - "Source": "WebsiteDedicated:eastuswebspace:DefaultServerFarm" - }, - "ScaleAction": { - "Direction": "Increase", - "Type": "ChangeCount", - "Value": "1", - "Cooldown": "PT10M" - } - } - ] - } -ResourceGroupName : Default-Web-EastUS -ResourceProviderName : microsoft.insights -ResourceId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/autoscalesettings/DefaultServerFarm-Default-Web-EastUS -Status : Succeeded -SubmissionTimestamp : 2/10/2015 2:38:19 AM -SubscriptionId : b93fb07a-6f93-30be-bf3e-4f0deca15f4f -SubStatus : -``` - -This command gets all Autoscale-related events associated with a particular resource identified by the resource's ID (essentially, the ResourceUri). - -## PARAMETERS - -### -Caller -Specifies a caller. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DetailedOutput -Indicates that this operation included detailed output. -If you do not specify this parameter, the output is summarized. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EndTime -Specifies the end time of the query in local time. -The default is the current time. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Specifies the resource ID to which the autoscale setting is associated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartTime -Specifies the start time of the query in local time. -This parameter is optional. -The default is the current local time minus one hour. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Status -Specifies a filter by status. -This parameter is optional. -The fault is an empty string (i.e. -no filter) - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.DateTime, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSEventData - -## NOTES - -## RELATED LINKS - -[Add-AzureRmAutoscaleSetting](./Add-AzureRmAutoscaleSetting.md) - -[Get-AzureRmAutoscaleSetting](./Get-AzureRmAutoscaleSetting.md) - -[Remove-AzureRmAutoscaleSetting](./Remove-AzureRmAutoscaleSetting.md) - - diff --git a/azurermps-6.13.0/AzureRM.Insights/Get-AzureRmAutoscaleSetting.md b/azurermps-6.13.0/AzureRM.Insights/Get-AzureRmAutoscaleSetting.md deleted file mode 100644 index 44d6ed8298..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/Get-AzureRmAutoscaleSetting.md +++ /dev/null @@ -1,290 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 989CE245-FD1D-4E1D-90A2-2D7DA3975D0B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/get-azurermautoscalesetting -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmAutoscaleSetting.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmAutoscaleSetting.md ---- - -# Get-AzureRmAutoscaleSetting - -## SYNOPSIS -Gets Autoscale settings. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmAutoscaleSetting -ResourceGroupName <String> [-Name <String>] [-DetailedOutput] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmAutoscaleSetting** cmdlet gets all Autoscale settings associated with a resource group or a specified Autoscale setting. - -## EXAMPLES - -### Example 1: Get Autoscale settings -``` -PS C:\>Get-AzureRmAutoscaleSetting -ResourceGroup "Default-Web-EastUS" -DetailedOutput -resourceId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft. - insights/autoscalesettings/DefaultServerFarm-Default-Web-EastUS -Location : East US -Name : DefaultServerFarm-Default-Web-EastUS -Properties : -Enabled : True -Profiles : -Capacity : -Default : 1 -Minimum : 3 -Maximum : 1 -FixedDate : -Name : No scheduled times -Recurrence : -Rules : -MetricTrigger : -MetricName : CpuPercentage -MetricResourceId : /subscriptions/a93fb07c-6c93-40be-bf3b-4f0deba10f4 - b/resourceGroups/Default-Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm -Operator : GreaterThanOrEqual -Statistic : Average -Threshold : 14 -TimeAggregation : Average -TimeGrain : 00:01:00 -TimeWindow : 00:45:00 -ScaleAction : -Cooldown : 00:05:00 -Direction : Increase -Type : ChangeCount -Value : 1 -MetricTrigger : -MetricName : CpuPercentage -MetricResourceId : /subscriptions/a93fb07c-6c93-40be-bf3b-4f0deba10f4 - b/resourceGroups/Default-Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm -Operator : LessThanOrEqual -Statistic : Average -Threshold : 4 -TimeAggregation : Average -TimeGrain : 00:01:00 -TimeWindow : 00:45:00 -ScaleAction : -Cooldown : 02:00:00 -Direction : Decrease -Type : ChangeCount -Value : 1 - -MetricTrigger : -MetricName : BytesReceived -MetricResourceId : /subscriptions/a93fb07c-6c93-40be-bf3b-4f0deba10f4 - b/resourceGroups/Default-Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm -Operator : LessThanOrEqual -Statistic : Average -Threshold : 50 -TimeAggregation : Average -TimeGrain : 00:01:00 -TimeWindow : 00:10:00 -ScaleAction : -Cooldown : 00:10:00 -Direction : Decrease -Type : ChangeCount -Value : 1 -MetricTrigger : -MetricName : BytesReceived -MetricResourceId : /subscriptions/a93fb07c-6c93-40be-bf3b-4f0deba10f4 - b/resourceGroups/Default-Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm -Operator : GreaterThanOrEqual -Statistic : Average -Threshold : 100 - TimeAggregation : Average -TimeGrain : 00:01:00 -TimeWindow : 00:05:00 -ScaleAction : -Cooldown : 00:10:00 - Direction : Increase -Type : ChangeCount -Value : 1 - TargetResourceId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/ - providers/microsoft.web/serverFarms/DefaultServerFarm -Tags : {[$type, Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, - Microsoft.WindowsAzure.Management.Common.Storage], [hidden-link:/subscriptions/a93fb07c-6c93-40be-bf3b-4f0 - deba10f4b/resourceGroups/Default-Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm, - Resource]} -``` - -This command gets the Autoscale settings assigned to the resource group Default-Web-EastUS. - -### Example 2: Get an Autoscale setting by name -``` -PS C:\>Get-AzureRmAutoscaleSetting -ResourceGroupName "Default-Web-EastUS" -Name "DefaultServerFarm-Default-Web-EastUS" -DetailedOutput -resourceId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft. - insights/autoscalesettings/DefaultServerFarm-Default-Web-EastUS -Location : East US -Name : DefaultServerFarm-Default-Web-EastUS -Properties : -Enabled : True -Profiles : -Capacity : -Default : 1 -Minimum : 3 -Maximum : 1 -FixedDate : -Name : No scheduled times -Recurrence : -Rules : -MetricTrigger : -MetricName : CpuPercentage -MetricResourceId : /subscriptions/a93fb07c-6c93-40be-bf3b-4f0deba10f4 - b/resourceGroups/Default-Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm -Operator : GreaterThanOrEqual -Statistic : Average -Threshold : 14 -TimeAggregation : Average -TimeGrain : 00:01:00 -TimeWindow : 00:45:00 -ScaleAction : -Cooldown : 00:05:00 -Direction : Increase -Type : ChangeCount -Value : 1 -MetricTrigger : -MetricName : CpuPercentage -MetricResourceId : /subscriptions/a93fb07c-6c93-40be-bf3b-4f0deba10f4 - b/resourceGroups/Default-Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm -Operator : LessThanOrEqual -Statistic : Average -Threshold : 4 -TimeAggregation : Average -TimeGrain : 00:01:00 -TimeWindow : 00:45:00 -ScaleAction : -Cooldown : 02:00:00 -Direction : Decrease -Type : ChangeCount -Value : 1 -MetricTrigger : -MetricName : BytesReceived -MetricResourceId : /subscriptions/a93fb07c-6c93-40be-bf3b-4f0deba10f4 - b/resourceGroups/Default-Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm -Operator : LessThanOrEqual -Statistic : Average -Threshold : 50 -TimeAggregation : Average -TimeGrain : 00:01:00 -TimeWindow : 00:10:00 -ScaleAction : -Cooldown : 00:10:00 -Direction : Decrease -Type : ChangeCount -Value : 1 -MetricTrigger : -MetricName : BytesReceived -MetricResourceId : /subscriptions/a93fb07c-6c93-40be-bf3b-4f0deba10f4 - b/resourceGroups/Default-Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm -Operator : GreaterThanOrEqual -Statistic : Average -Threshold : 100 -TimeAggregation : Average -TimeGrain : 00:01:00 -TimeWindow : 00:05:00 -ScaleAction : -Cooldown : 00:10:00 -Direction : Increase -Type : ChangeCount -Value : 1 -TargetResourceId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/ - providers/microsoft.web/serverFarms/DefaultServerFarm -Tags : {[$type, Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, - Microsoft.WindowsAzure.Management.Common.Storage], [hidden-link:/subscriptions/a93fb07c-6c93-40be-bf3b-4f0 - deba10f4b/resourceGroups/Default-Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm, - Resource]} -``` - -This command gets the Autoscale setting named DefaultServerFarm-Default-Web-EastUS. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DetailedOutput -Indicates that this operation displays full details in the output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the setting to get. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSAutoscaleSetting - -## NOTES - -## RELATED LINKS - -[Add-AzureRmAutoscaleSetting](./Add-AzureRmAutoscaleSetting.md) - -[Remove-AzureRmAutoscaleSetting](./Remove-AzureRmAutoscaleSetting.md) - - diff --git a/azurermps-6.13.0/AzureRM.Insights/Get-AzureRmDiagnosticSetting.md b/azurermps-6.13.0/AzureRM.Insights/Get-AzureRmDiagnosticSetting.md deleted file mode 100644 index 3d8aa02f20..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/Get-AzureRmDiagnosticSetting.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 60B497F6-98A2-4C60-B142-FF5CD123362D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/get-azurermdiagnosticsetting -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmDiagnosticSetting.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmDiagnosticSetting.md ---- - -# Get-AzureRmDiagnosticSetting - -## SYNOPSIS -Gets the logged categories and time grains. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmDiagnosticSetting [-ResourceId] <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDiagnosticSetting** cmdlet gets the categories and time grains that are logged for a resource. -A time grain is the aggregation interval of a metric. - -## EXAMPLES - -### Example 1: Get the status of the logging categories and time grains -``` -PS C:\>Get-AzureRmDiagnosticSetting -ResourceId "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/ResourceGroups/ContosoRG/providers/microsoft.keyvault/KeyVaults/ContosoKeyVault" -StorageAccountId : /subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/ResourceGroups/ContosoRG/providers/microsoft.storage/accounts/ContosoStorageAccount -StorageAccountName : ContosoStorageAccount001 -Metrics - -Logs -Enabled : True -Category : AuditEvent -``` - -This command gets the categories and time grains that are logged for an Azure Key Vault with a *ResourceId* of /subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/ResourceGroups/ContosoRG/providers/microsoft.keyvault/KeyVaults/ContosoKeyVault. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the diagnostic setting. If not given the call default to "service" as it was in the previous API. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Specifies the ID of the resource. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSServiceDiagnosticSettings - -## NOTES - -## RELATED LINKS - -[Set-AzureRmDiagnosticSetting](./Set-AzureRmDiagnosticSetting.md) -[Remove-AzureRmDiagnosticSetting](./Remove-AzureRmDiagnosticSetting.md) diff --git a/azurermps-6.13.0/AzureRM.Insights/Get-AzureRmLog.md b/azurermps-6.13.0/AzureRM.Insights/Get-AzureRmLog.md deleted file mode 100644 index 653db4a012..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/Get-AzureRmLog.md +++ /dev/null @@ -1,397 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 85492E00-3776-4F20-A444-9C28CC6154B7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/get-azurermlog -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmLog.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmLog.md ---- - -# Get-AzureRmLog - -## SYNOPSIS -Gets a log of events. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetByCorrelationId -``` -Get-AzureRmLog [-StartTime <DateTime>] [-EndTime <DateTime>] [-Status <String>] [-Caller <String>] - [-DetailedOutput] [-CorrelationId] <String> [-MaxRecord <Int32>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### GetByResourceId -``` -Get-AzureRmLog [-StartTime <DateTime>] [-EndTime <DateTime>] [-Status <String>] [-Caller <String>] - [-DetailedOutput] [-ResourceId] <String> [-MaxRecord <Int32>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### GetByResourceGroup -``` -Get-AzureRmLog [-StartTime <DateTime>] [-EndTime <DateTime>] [-Status <String>] [-Caller <String>] - [-DetailedOutput] [-ResourceGroupName] <String> [-MaxRecord <Int32>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetByResourceProvider -``` -Get-AzureRmLog [-StartTime <DateTime>] [-EndTime <DateTime>] [-Status <String>] [-Caller <String>] - [-DetailedOutput] [-ResourceProvider] <String> [-MaxRecord <Int32>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### GetBySubscription -``` -Get-AzureRmLog [-StartTime <DateTime>] [-EndTime <DateTime>] [-Status <String>] [-Caller <String>] - [-DetailedOutput] [-MaxRecord <Int32>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmLog** cmdlet gets a log of events. -The events can be associated with the current subscription ID, correlation ID, resource group, resource ID, or resource provider. - -## EXAMPLES - -### Example 1: Get an event log by subscription ID -``` -PS C:\>Get-AzureRmLog -``` - -This command lists at most 1000 events associated with the user's subscription ID that took place 7 days from the current date/time. - -### Example 2: Get an event log by subscription ID with a maximum number of events -``` -PS C:\>Get-AzureRmLog -MaxEvents 100 -``` - -This command lists at most 100 events associated with the user's subscription ID that took place 7 days from the current date/time. - -### Example 3: Get an event log by subscription ID with a start time. -``` -PS C:\>Get-AzureRmLog -StartTime 2017-06-01T10:30 -``` - -This command lists at most 1000 events associated with the user's subscription ID that took place on or after 2017-06-01T10:30 local time if that date/time is not older than 90 days from the current date/time. - -### Example 4: Get an event log by subscription ID with a start time and end time. -``` -PS C:\>Get-AzureRmLog -StartTime 2017-04-01T10:30 -EndTime 2017-04-14T11:30 -``` - -This command lists at most 1000 of the events associated with the user's subscription ID that took place on or after 2017-04-01T10:30 local time, and before 2017-04-14T11:30 local time if the whole date/time range is not older than 90 days from the current date/time, i.e.: the retention period. - -### Example 5: Get an event log by correlation ID -``` -PS C:\>Get-AzureRmLog -CorrelationId "00001111-aaaa-2222-bbbb-3333cccc4444" -``` - -This command lists at most 1000 events associated with the specified correlation ID that took place 7 days from the current date/time. -**NOTE**: this is usually only one event. - -### Example 6: Get an event log by correlation ID with a maximum number of events -``` -PS C:\>Get-AzureRmLog -CorrelationId "00001111-aaaa-2222-bbbb-3333cccc4444" -MaxEvents 100 -``` - -This command lists at most 100 events associated with the specified correlation ID that took place 7 days from the current date/time. -**NOTE**: this is usually only one event. - -### Example 7: Get an event log by correlation ID and start time -``` -PS C:\>Get-AzureRmLog -CorrelationId "00001111-aaaa-2222-bbbb-3333cccc4444" -StartTime 2017-05-22T04:30:00 -``` - -This command lists at most 1000 events associated with the specified correlation ID that took place on or after 2017-05-22T04:30:00 local time if the start time is not older than 90 days from the current date/time. -**NOTE**: this is usually only one event. - -### Example 8: Get an event log by correlation ID with start time and end time -``` -PS C:\>Get-AzureRmLog -CorrelationId "00001111-aaaa-2222-bbbb-3333cccc4444" -StartTime 2017-04-15T04:30:00 -EndTime 2017-04-25T12:30:00 -``` - -This command lists at most 1000 events associated with the specified correlation ID that took place on or after 2017-04-15T04:30 local time, but before 2017-04-25T12:30 local time if the whole date/time range is not older than 90 days from the current date/time, i.e.: the retention period. - -### Example 9: Get an event log for a resource group -``` -PS C:\>Get-AzureRmLog -ResourceGroupName "Contoso-Web-CentralUS" -``` - -This command lists at most 1000 the events associated with the specified resource group that took place 7 days from the current date/time. - -### Example 10: Get an event log for a resource group with a maximum number of events -``` -PS C:\>Get-AzureRmLog -ResourceGroup "Contoso-Web-CentralUS" -MaxEvents 100 -``` - -This command lists at most 100 events associated with the specified resource group that took place 7 days from the current date/time. - -### Example 11: Get an event log for a resource group by start time -``` -PS C:\>Get-AzureRmLog -ResourceGroup "Contoso-Web-CentralUS" -StartTime 2017-05-22T04:30:00 -``` - -This command lists at most 1000 evetns associated with the specified resource group that took place on or after 2017-05-22T04:30:00 local time if the start time is not older than 90 days from the current date/time. - -### Example 12: Get an event log for a resource group with a start time and end time -``` -PS C:\>Get-AzureRmLog -ResourceGroup "Contoso-Web-CentralUS" -StartTime 2017-04-15T04:30 -EndTime 2017-04-25T12:30 -``` - -This command lists at most 1000 events associated with the specified resource group that took place on or after 2017-04-15T04:30 local time, but before 2017-04-25T12:30 local time if the whole date/time range is not older than 90 days from the current date/time, i.e.: the retention period. - -### Example 13: Get an event log by resource ID -``` -PS C:\>Get-AzureRmLog -ResourceId "/subscriptions/623d50f1-4fa8-4e46-a967-a9214aed43ab/ResourceGroups/Contoso-Web-CentralUS/providers/Microsoft.Web/ServerFarms/Contoso1" -``` - -This command lists at most 1000 events associated with the specified resource ID that took place 7 days from the current date/time. - -### Example 14: Get an event log by resource ID with a maximum number of events -``` -PS C:\>Get-AzureRmLog -ResourceId "/subscriptions/623d50f1-4fa8-4e46-a967-a9214aed43ab/ResourceGroups/Contoso-Web-CentralUS/providers/Microsoft.Web/ServerFarms/Contoso1" -MaxEvents 100 -``` - -This command lists at most 100 events associated with the specified resource ID that took place 7 days from the current date/time. - -### Example 15: Get an event log by resource ID with a start time -``` -PS C:\>Get-AzureRmLog -ResourceId "/subscriptions/623d50f1-4fa8-4e46-a967-a9214aed43ab/ResourceGroups/Contoso-Web-CentralUS/providers/Microsoft.Web/ServerFarms/Contoso1" -StartTime 2017-05-22T04:30 -``` - -This command lists at most 1000 events associated with the specified resource ID that took place on or after 2017-05-22T04:30:00 local time if the start time is not older than 90 days from the current date/time. - -### Example 16: Get an event log by resource ID with a start time and end time -``` -PS C:\>Get-AzureRmLog -ResourceId "/subscriptions/623d50f1-4fa8-4e46-a967-a9214aed43ab/ResourceGroups/Contoso-Web-CentralUS/providers/Microsoft.Web/ServerFarms/Contoso1" -StartTime 2017-04-15T04:30 -EndTime 2017-04-25T12:30 -``` - -This command lists at most 1000 events associated with the specified resource ID that took place on or after 2017-04-15T04:30 local time, but before 2017-04-25T12:30 local time if the whole date/time range is not older than 90 days from the current date/time, i.e.: the retention period. - -### Example 17: Get an event log by resource provider -``` -PS C:\>Get-AzureRmLog -ResourceProvider "Microsoft.Web" -``` - -This command lists at most 1000 events associated with the specified resource provider that took place 7 days from the current date/time. - -### Example 18: Get an event log by resource provider with a maximum number of events -``` -PS C:\>Get-AzureRmLog -ResourceProvider "Microsoft.Web" -MaxEvents 100 -``` - -This command lists at most 100 events associated with the specified resource provider that took place 7 days from the current date/time. - -### Example 19: Get an event log by resource provider with a start time -``` -PS C:\>Get-AzureRmLog -ResourceProvider "Microsoft.Web" -StartTime 2017-05-22T04:30 -``` - -This command lists at most 1000 events associated with the specified resource provider that took place on or after 2017-05-22T04:30:00 local time if the start time is not older than 90 days from the current date/time. - -### Example 20: Get an event log by resource provider with a start time and end time -``` -PS C:\>Get-AzureRmLog -ResourceProvider "Microsoft.Web" -StartTime 2017-04-15T04:30 -EndTime 2017-04-25T12:30 -``` - -This command lists at most 1000 events associated with the specified resource provider that took place on or after 2017-04-15T04:30 local time, but before 2017-04-25T12:30 local time if the whole date/time range is not older than 90 days from the current date/time, i.e.: the retention period. - -## PARAMETERS - -### -Caller -Specifies a caller. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CorrelationId -Specifies the correlation ID. -This parameter is required. - -```yaml -Type: System.String -Parameter Sets: GetByCorrelationId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DetailedOutput -Indicates that this cmdlet displays detailed output. -By default, output is summarized. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Switch not present = False, i.e. output summarized -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EndTime -Specifies the end time of the query in local time. -The default value is the current time. -The value must be later than *StartTime*. -You can use the Get-Date cmdlet to get a **DateTime** object. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Current date (time: 00:00:00 AM) + 1 day -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaxRecord -Specifies the total number of records to fetch for the specified filter. -The default value is 1000 and the maximum value accepted is 100000. Negative values and 0 are ignored and the default value will be used. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 1000 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: GetByResourceGroup -Aliases: ResourceGroup - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Specifies the resource ID. - -```yaml -Type: System.String -Parameter Sets: GetByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceProvider -Specifies a filter by resource provider. - -```yaml -Type: System.String -Parameter Sets: GetByResourceProvider -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartTime -Specifies the start time of the query in local time. -The default value is *EndTime* minus seven days. -You can use the Get-Date cmdlet to get a **DateTime** object. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: EndTime - 7 days -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Status -Specifies the status. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Nullable`1[[System.DateTime, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.String - -### System.Management.Automation.SwitchParameter - -### System.Int32 - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSEventData - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Insights/Get-AzureRmLogProfile.md b/azurermps-6.13.0/AzureRM.Insights/Get-AzureRmLogProfile.md deleted file mode 100644 index d99cb774d6..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/Get-AzureRmLogProfile.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 019EFD94-4087-45F6-812D-FBDFE1B2E48A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/get-azurermlogprofile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmLogProfile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmLogProfile.md ---- - -# Get-AzureRmLogProfile - -## SYNOPSIS -Gets a log profile. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmLogProfile [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmLogProfile** cmdlet gets a log profile. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the log profile to get. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSLogProfileCollection - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLogProfile](./Add-AzureRmLogProfile.md) - -[Remove-AzureRmLogProfile](./Remove-AzureRmLogProfile.md) - - diff --git a/azurermps-6.13.0/AzureRM.Insights/Get-AzureRmMetric.md b/azurermps-6.13.0/AzureRM.Insights/Get-AzureRmMetric.md deleted file mode 100644 index 68931d6224..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/Get-AzureRmMetric.md +++ /dev/null @@ -1,446 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: EAFB9C98-000C-4EAC-A32D-6B0F1939AA2F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/get-azurermmetric -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmMetric.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmMetric.md ---- - -# Get-AzureRmMetric - -## SYNOPSIS -Gets the metric values of a resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetWithDefaultParameters (Default) -``` -Get-AzureRmMetric [-ResourceId] <String> [-TimeGrain <TimeSpan>] [-StartTime <DateTime>] [-EndTime <DateTime>] - [[-MetricName] <String[]>] [-DetailedOutput] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetWithFullParameters -``` -Get-AzureRmMetric [-ResourceId] <String> [-TimeGrain <TimeSpan>] [-AggregationType <AggregationType>] - [-StartTime <DateTime>] [-EndTime <DateTime>] [-Top <Int32>] [-OrderBy <String>] [-MetricNamespace <String>] - [-ResultType <ResultType>] [-MetricFilter <String>] [-MetricName] <String[]> [-DetailedOutput] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmMetric** cmdlet gets the metric values for a specified resource. - -## EXAMPLES - -### Example 1: Get a metric with summarized output -``` -PS C:\>Get-AzureRmMetric -ResourceId "/subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website3" -TimeGrain 00:01:00 -DimensionName : -DimensionValue : -Name : AverageResponseTime -EndTime : 3/20/2015 6:40:46 PM -MetricValues : {Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, - Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue...} -Properties : {} -ResourceId : /subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website3 -StartTime : 3/20/2015 5:40:00 PM -TimeGrain : 00:01:00 -Unit : Seconds -DimensionName : -DimensionValue : -Name : AverageMemoryWorkingSet -EndTime : 3/20/2015 6:40:46 PM -MetricValues : {Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, - Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue...} -Properties : {} -ResourceId : /subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website3 -StartTime : 3/20/2015 5:40:00 PM -TimeGrain : 00:01:00 -Unit : Bytes -``` - -This command gets the metric values for website3 with a time grain of 1 minute. - -### Example 2: Get a metric with detailed output -``` -PS C:\>Get-AzureRmMetric -ResourceId "/subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website3" -TimeGrain 00:01:00 -DetailedOutput -MetricValues : - Average : 0 - Count : 1 - Last : - Maximum : - Minimum : - Properties : - Timestamp : 3/20/2015 6:37:00 PM - Total : 0 - Average : 0.106 - Count : 1 - Last : - Maximum : - Minimum : - Properties : - Timestamp : 3/20/2015 6:39:00 PM - Total : 0.106 - Average : 0.064 - Count : 1 - Last : - Maximum : - Minimum : - Properties : - Timestamp : 3/20/2015 6:41:00 PM - Total : 0.064 -Properties : -DimensionName : -DimensionValue : -Name : AverageResponseTime -EndTime : 3/20/2015 6:43:33 PM -ResourceId : /subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website3 -StartTime : 3/20/2015 5:43:00 PM -TimeGrain : 00:01:00 -Unit : Seconds -``` - -This command gets the metric values for website3 with a time grain of 1 minute. -The output is detailed. - -### Example 3: Get detailed output for a specified metric -``` -PS C:\>Get-AzureRmMetric -ResourceId "/subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website3" -MetricNames "Requests" -TimeGrain 00:01:00 -DetailedOutput -MetricValues : - Average : 1 - Count : 1 - Last : - Maximum : - Minimum : - Properties : - Timestamp : 3/20/2015 6:39:00 PM - Total : 1 - Average : 1 - Count : 1 - Last : - Maximum : - Minimum : - Properties : - Timestamp : 3/20/2015 6:41:00 PM - Total : 1 - Average : 0 - Count : 1 - Last : - Maximum : - Minimum : - Properties : - Timestamp : 3/20/2015 6:43:00 PM - Total : 0 - Average : 1 - Count : 1 - Last : - Maximum : - Minimum : - Properties : - Timestamp : 3/20/2015 6:44:00 PM - Total : 1 - Average : 0 - Count : 1 - Last : - Maximum : - Minimum : - Properties : - Timestamp : 3/20/2015 6:45:00 PM - Total : 0 -Properties : -DimensionName : -DimensionValue : -Name : Requests -EndTime : 3/20/2015 6:47:56 PM -ResourceId : /subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website3 -StartTime : 3/20/2015 5:47:00 PM -TimeGrain : 00:01:00 -Unit : Count -``` - -This command gets detailed output for the Requests metric. - -### Example 4: Get summarized output for a specified metric with specified dimension filter -``` -PS C:\> $dimFilter = @((New-AzureRmMetricFilter -Dimension City -Operator eq -Values "Seattle","Toronto"), (New-AzureRmMetricDimensionFilter -Dimension AuthenticationType -Operator eq -Values User)) - -PS C:\> Get-AzureRmMetricValues -ResourceId <resourcId> -MetricName PageViews -TimeGrain PT5M -MetricFilter $dimFilter -StartTime 2018-02-01T12:00:00Z -EndTime 2018-02-01T12:10:00Z -AggregationType -Average -ResourceId : [ResourceId] -MetricNamespace : Microsoft.Insights/ApplicationInsights -Metric Name : - LocalizedValue : Page Views - Value : PageViews -Unit : Seconds -Timeseries : - City : Seattle - AuthenticationType : User - - Timestamp : 2018-02-01 12:00:00 PM - Average : 3518 - - Timestamp : 2018-02-01 12:05:00 PM - Average : 1984 - - City : Toronto - AuthenticationType : User - - Timestamp : 2018-02-01 12:00:00 PM - Average : 894 - - Timestamp : 2018-02-01 12:05:00 PM - Average : 967 -``` - -This command gets summarized output for the PageViews metric with specified dimesion filter and aggregation type. - -## PARAMETERS - -### -AggregationType -The aggregation type of the query - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.Monitor.Models.AggregationType] -Parameter Sets: GetWithFullParameters -Aliases: -Accepted values: None, Average, Count, Minimum, Maximum, Total - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DetailedOutput -Indicates that this cmdlet displays detailed output. -By default, output is summarized. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EndTime -Specifies the end time of the query in local time. -The default is the current time. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MetricFilter -Specifies the metric dimension filter to query metrics for. - -```yaml -Type: System.String -Parameter Sets: GetWithFullParameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MetricName -Specifies an array of names of metrics. - -```yaml -Type: System.String[] -Parameter Sets: GetWithDefaultParameters -Aliases: MetricNames - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String[] -Parameter Sets: GetWithFullParameters -Aliases: MetricNames - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MetricNamespace -Specifies the metric namespace to query metrics for. - -```yaml -Type: System.String -Parameter Sets: GetWithFullParameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OrderBy -Specifies the aggregation to use for sorting results and the direction of the sort (Example: sum asc). - -```yaml -Type: System.String -Parameter Sets: GetWithFullParameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Specifies the resource ID of the metric. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResultType -Specifies the result type to be returned (metadata or data). - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.Monitor.Models.ResultType] -Parameter Sets: GetWithFullParameters -Aliases: -Accepted values: Data, Metadata - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartTime -Specifies the start time of the query in local time. -The default is the current local time minus one hour. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TimeGrain -Specifies the time grain of the metric as a **TimeSpan** object in the format hh:mm:ss. - -```yaml -Type: System.TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Top -Specifies the maximum number of records to retrieve (default:10), to be specified with $filter. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: GetWithFullParameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.TimeSpan - -### System.Nullable`1[[Microsoft.Azure.Management.Monitor.Models.AggregationType, Microsoft.Azure.Management.Monitor, Version=0.19.1.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -### System.DateTime - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Nullable`1[[Microsoft.Azure.Management.Monitor.Models.ResultType, Microsoft.Azure.Management.Monitor, Version=0.19.1.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -### System.String[] - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSMetric - -## NOTES - -## RELATED LINKS - -[Get-AzureRmMetricDefinition](./Get-AzureRmMetricDefinition.md) -[New-AzureRmMetricFilter](./New-AzureRmMetricFilter.md) - - diff --git a/azurermps-6.13.0/AzureRM.Insights/Get-AzureRmMetricDefinition.md b/azurermps-6.13.0/AzureRM.Insights/Get-AzureRmMetricDefinition.md deleted file mode 100644 index a7300d9f8c..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/Get-AzureRmMetricDefinition.md +++ /dev/null @@ -1,232 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 7915A7AC-5A47-4868-B846-2896BCEBFAB2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/get-azurermmetricdefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmMetricDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmMetricDefinition.md ---- - -# Get-AzureRmMetricDefinition - -## SYNOPSIS -Gets metric definitions. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmMetricDefinition [-ResourceId] <String> [-MetricName <String[]>] [-MetricNamespace <String>] - [-DetailedOutput] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmMetricDefinition** cmdlet gets metric definitions. - -## EXAMPLES - -### Example 1: Get metric definitions for a resource -``` -PS C:\>Get-AzureRmMetricDefinition -ResourceId "/subscriptions/d33fb0c7-69d3-40be-e35b-4f0deba70fff/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website2" -Name : CpuTime -Dimensions : {} -MetricAvailabilities : {Microsoft.Azure.Insights.Models.MetricAvailability, - Microsoft.Azure.Insights.Models.MetricAvailability, - Microsoft.Azure.Insights.Models.MetricAvailability} -PrimaryAggregationType : Total -Properties : {} -ResourceUri : -Unit : Seconds -Name : Requests -Dimensions : {} -MetricAvailabilities : {Microsoft.Azure.Insights.Models.MetricAvailability, - Microsoft.Azure.Insights.Models.MetricAvailability, - Microsoft.Azure.Insights.Models.MetricAvailability} -PrimaryAggregationType : Total -Properties : {} -ResourceUri : -Unit : Count -``` - -This command gets the metrics definitions for the specified resource. - -### Example 2: Get metric definitions with detailed output -``` -PS C:\>Get-AzureRmMetricDefinition -ResourceId "/subscriptions/d33fb0c7-69d3-40be-e35b-4f0deba70fff/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website2" -DetailedOutput -Dimensions : -MetricAvailabilities : - Location : - Retention : 2.00:00:00 - Values : 00:01:00 - Location : - Retention : 30.00:00:00 - Values : 01:00:00 - Location : - Retention : 90.00:00:00 - Values : 1.00:00:00 -Name : CpuTime -Properties : -PrimaryAggregationType : Total -ResourceUri : -Unit : Seconds -Dimensions : -MetricAvailabilities : - Location : - Retention : 2.00:00:00 - Values : 00:01:00 - Location : - Retention : 30.00:00:00 - Values : 01:00:00 - Location : - Retention : 90.00:00:00 - Values : 1.00:00:00 -Name : Requests -Properties : -PrimaryAggregationType : Total -ResourceUri : -Unit : Count -``` - -This command gets the metric definitions for website2. -The output is detailed. - -### Example 3: Get metric definitions by name -``` -PS C:\>Get-AzureRmMetricDefinition -ResourceId "/subscriptions/d33fb0c7-69d3-40be-e35b-4f0deba70fff/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website2" -DetailedOutput -MetricNames "BytesSent,CpuTime" -MetricAvailabilities : - Location : - Retention : 2.00:00:00 - Values : 00:01:00 - Location : - Retention : 30.00:00:00 - Values : 01:00:00 - Location : - Retention : 90.00:00:00 - Values : 1.00:00:00 -Name : CpuTime -Properties : -PrimaryAggregationType : Total -ResourceUri : -Unit : Seconds -Dimensions : -MetricAvailabilities : - Location : - Retention : 2.00:00:00 - Values : 00:01:00 - Location : - Retention : 30.00:00:00 - Values : 01:00:00 - Location : - Retention : 90.00:00:00 - Values : 1.00:00:00 -Name : BytesSent -Properties : -PrimaryAggregationType : Total -ResourceUri : -Unit : Bytes -``` - -This command gets definitions for the BytesSent and CpuTime metrics. -The output is detailed. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DetailedOutput -Indicates that this operation included detailed output. -If you do not specify this parameter, the output is summarized. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MetricName -Specifies an array of names of metrics. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MetricNamespace -Specifies the metric namespace to query metric definitions for. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Specifies the resource ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.String[] - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSMetricDefinition - -## NOTES - -## RELATED LINKS - -[Get-AzureRmMetric](./Get-AzureRmMetric.md) -[New-AzureRmMetricFilter](./New-AzureRmMetricFilter.md) - - diff --git a/azurermps-6.13.0/AzureRM.Insights/New-AzureRmActionGroup.md b/azurermps-6.13.0/AzureRM.Insights/New-AzureRmActionGroup.md deleted file mode 100644 index 19e8a825c0..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/New-AzureRmActionGroup.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: A4C605DD-9B2E-4EE9-BD1F-1352D605C33F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/new-azurermactiongroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmActionGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmActionGroup.md ---- - -# New-AzureRmActionGroup - -## SYNOPSIS -Creates an ActionGroup reference object in memory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmActionGroup -ActionGroupId <String> - [-WebhookProperty <System.Collections.Generic.Dictionary`2[System.String,System.String]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmActionGroup** cmdlet creates an action group reference object in memory. - -## EXAMPLES - -### Example 1: Create an action group reference object in memory -``` -PS C:\>$dict = New-Object "System.Collections.Generic.Dictionary``2[System.String,System.String]" -PS C:\>$dict.Add('key1', 'value1') -PS C:\>$actionGrp1 = New-AzureRmActionGroup -ActionGroupId 'actiongr1' -WebhookProperties $dict -``` - -## PARAMETERS - -### -ActionGroupId -The Id/name of the action group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebhookProperty -The webhook properties of the action group - -```yaml -Type: System.Collections.Generic.Dictionary`2[System.String,System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Generic.Dictionary`2[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089],[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertActionGroup - -## NOTES - -## RELATED LINKS - -[Set-AzureRmActivityLogAlert](./Set-AzureRmActivityLogAlert.md) - -[Enable-AzureRmActivityLogAlert](./Enable-AzureRmActivityLogAlert.md) - -[Disable-AzureRmActivityLogAlert](./Disable-AzureRmActivityLogAlert.md) - -[Get-AzureRmActivityLogAlert](./Get-AzureRmActivityLogAlert.md) - -[Remove-AzureRmActivityLogAlert](./Remove-AzureRmActivityLogAlert.md) - - - diff --git a/azurermps-6.13.0/AzureRM.Insights/New-AzureRmActionGroupReceiver.md b/azurermps-6.13.0/AzureRM.Insights/New-AzureRmActionGroupReceiver.md deleted file mode 100644 index 785584b69d..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/New-AzureRmActionGroupReceiver.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 9830CD16-D797-47EB-BEF5-6CFE3454BCAA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/new-azurermactiongroupreceiver -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmActionGroupReceiver.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmActionGroupReceiver.md ---- - -# New-AzureRmActionGroupReceiver - -## SYNOPSIS -Creates an new action group receiver. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NewEmailReceiver (Default) -``` -New-AzureRmActionGroupReceiver -Name <String> [-EmailReceiver] -EmailAddress <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### NewSmsReceiver -``` -New-AzureRmActionGroupReceiver -Name <String> [-SmsReceiver] [-CountryCode <String>] -PhoneNumber <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### NewWebhookReceiver -``` -New-AzureRmActionGroupReceiver -Name <String> [-WebhookReceiver] -ServiceUri <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmActionGroupReceiver** cmdlet creates new action group receiver in memory. - -## EXAMPLES - -### Example 1: Create a new Email receiver in memory. -``` -PS C:\>$emailReceiver = New-AzureRmActionGroupReceiver -Name 'emailReceiver1' -EmailReceiver -EmailAddress 'user1@example.com' -``` - -This command creates a new Email receiver in memory. - -### Example 2: Create a new SMS receiver in memory. -``` -PS C:\>$smsReceiver = New-AzureRmActionGroupReceiver -Name 'smsReceiver1' -SmsReceiver -CountryCode '1' -PhoneNumber '5555555555' -``` - -This command creates a new SMS receiver in memory. - -### Example 3: Create a new webhook receiver in memory. -``` -PS C:\>$webhookReceiver = New-AzureRmActionGroupReceiver -Name 'webhookReceiver1' -SMSReceiver -ServiceUri 'http://test.com' -``` - -This command creates a new webhook receiver in memory. - -## PARAMETERS - -### -CountryCode -Specifies the country code for the SMS receiver. - -```yaml -Type: System.String -Parameter Sets: NewSmsReceiver -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddress -Specifies the address for the Email receiver. - -```yaml -Type: System.String -Parameter Sets: NewEmailReceiver -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EmailReceiver -Specifies to create an Email receiver - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: NewEmailReceiver -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name for the receiver. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PhoneNumber -Specifies the phone number for the SMS receiver. - -```yaml -Type: System.String -Parameter Sets: NewSmsReceiver -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceUri -Specifies the URI for the webhook receiver. - -```yaml -Type: System.String -Parameter Sets: NewWebhookReceiver -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SmsReceiver -Specifies to create a SMS receiver - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: NewSmsReceiver -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WebhookReceiver -Specifies to create a webhook receiver - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: NewWebhookReceiver -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupReceiverBase - -## NOTES - -## RELATED LINKS - -[Set-AzureRmActionGroup](./Set-AzureRmActionGroup.md) -[Get-AzureRmActionGroup](./Get-AzureRmActionGroup.md) -[Remove-AzureRmActionGroup](./Remove-AzureRmActionGroup.md) diff --git a/azurermps-6.13.0/AzureRM.Insights/New-AzureRmActivityLogAlertCondition.md b/azurermps-6.13.0/AzureRM.Insights/New-AzureRmActivityLogAlertCondition.md deleted file mode 100644 index 6fd8a40e49..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/New-AzureRmActivityLogAlertCondition.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 5E854358-CA9D-4336-BA6A-BF7B1FADAB50 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/new-azurermactivitylogalertcondition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmActivityLogAlertCondition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmActivityLogAlertCondition.md ---- - -# New-AzureRmActivityLogAlertCondition - -## SYNOPSIS -Creates an new activity log alert condition object in memory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmActivityLogAlertCondition -Field <String> -Equal <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmActivityLogAlertCondition** cmdlet creates new activity log alert condition object in memory. - -## EXAMPLES - -### Example 1: Create a new activity log alert condition object in memory. -``` -PS C:\>$condition = New-AzureRmActivityLogAlertCondition -Field "Requests" -Equal "OtherField" -``` - -This command creates a new activity log alert condition object in memory. -**NOTE**: when this cmdlet is used with Set-AzureRmActivityLogAlert at least one of these objects, passed as parameters, must have its Field equal to "Category". Otherwise, the backend responds with a 400 (BadRequest.) - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Equal -Specifies the equals property for the leaf condition. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Field -Specifies the field for the condition. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertLeafCondition - -## NOTES - -## RELATED LINKS - -[Set-AzureRmActivityLogAlert](./Set-AzureRmActivityLogAlert.md) - -[Enable-AzureRmActivityLogAlert](./Enable-AzureRmActivityLogAlert.md) - -[Disable-AzureRmActivityLogAlert](./Disable-AzureRmActivityLogAlert.md) - -[Get-AzureRmActivityLogAlert](./Get-AzureRmActivityLogAlert.md) - -[Remove-AzureRmActivityLogAlert](./Remove-AzureRmActivityLogAlert.md) - -[New-AzureRmActionGroup](./Get-AzureRmActionGroup.md) diff --git a/azurermps-6.13.0/AzureRM.Insights/New-AzureRmAlertRuleEmail.md b/azurermps-6.13.0/AzureRM.Insights/New-AzureRmAlertRuleEmail.md deleted file mode 100644 index af1b1a2b60..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/New-AzureRmAlertRuleEmail.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: B1000C10-265E-4465-B167-F1251470BE3E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/new-azurermalertruleemail -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAlertRuleEmail.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAlertRuleEmail.md ---- - -# New-AzureRmAlertRuleEmail - -## SYNOPSIS -Creates an email action for an alert rule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmAlertRuleEmail [[-CustomEmail] <String[]>] [-SendToServiceOwner] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmAlertRuleEmail** cmdlet creates an e-mail action for an alert rule. - -## EXAMPLES - -### Example 1: Create an alert rule email action for service owners -``` -PS C:\>New-AzureRmAlertRuleEmail -SendToServiceOwners -``` - -This command creates an alert rule email action to send for its service owners when an alert rule is fired. - -### Example 2: Create an alert rule email action for non-service owners -``` -PS C:\>New-AzureRmAlertRuleEmail -CustomEmails pattif@contoso.com,davidchew@contoso.net -``` - -This command creates an alert rule email action for the specified email addresses, but not for the service owners. - -### Example 3: Create an alert rule email action for service owners and non-service owners -``` -PS C:\>New-AzureRmAlertRuleEmail -CustomEmails pattif@contoso.net -SendToServiceOwners -``` - -This command creates an alert rule email action for the specified address and for its service owners. - -## PARAMETERS - -### -CustomEmail -Specifies a list of comma-separated e-mail addresses. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendToServiceOwner -Indicates that this operation sends an e-mail to the service owners when the rule fires. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String[] - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Management.Monitor.Management.Models.RuleEmailAction - -## NOTES - -## RELATED LINKS - - -[Add-AzureRmMetricAlertRule](./Add-AzureRmMetricAlertRule.md) - -[Add-AzureRmWebtestAlertRule](./Add-AzureRmWebtestAlertRule.md) - -[New-AzureRmAlertRuleWebhook](./New-AzureRmAlertRuleWebhook.md) - - diff --git a/azurermps-6.13.0/AzureRM.Insights/New-AzureRmAlertRuleWebhook.md b/azurermps-6.13.0/AzureRM.Insights/New-AzureRmAlertRuleWebhook.md deleted file mode 100644 index 8819ee91bd..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/New-AzureRmAlertRuleWebhook.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 0137ECA3-37E1-4064-8A65-A582519E9017 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/new-azurermalertrulewebhook -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAlertRuleWebhook.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAlertRuleWebhook.md ---- - -# New-AzureRmAlertRuleWebhook - -## SYNOPSIS -Creates an alert rule webhook. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmAlertRuleWebhook [-ServiceUri] <String> [[-Property] <Hashtable>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmAlertRuleWebhook** cmdlet creates an alert rule webhook. - -## EXAMPLES - -### Example 1: Create an alert rule webhook -``` -PS C:\>New-AzureRmAlertRuleWebhook -ServiceUri "http://contoso.com" -``` - -This command creates an alert rule webhook by specifying only the service URI. - -### Example 2: Create a webhook with one property -``` -PS C:\>$Actual = New-AzureRmAlertRuleWebhook -ServiceUri "http://contoso.com" -Properties @{prop1 = 'value1'} -``` - -This command creates an alert rule webhook for Contoso.com that has one property, and then stores it in the $Actual variable. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Property -Specifies the list of properties in the format @(property1 = 'value1',....). - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceUri -Specifies the service URI. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Management.Monitor.Management.Models.RuleWebhookAction - -## NOTES - -## RELATED LINKS - - -[Add-AzureRmMetricAlertRule](./Add-AzureRmMetricAlertRule.md) - -[Add-AzureRmWebtestAlertRule](./Add-AzureRmWebtestAlertRule.md) - -[New-AzureRmAlertRuleEmail](./New-AzureRmAlertRuleEmail.md) - -[New-AzureRmAutoscaleWebhook](./New-AzureRmAutoscaleWebhook.md) - - diff --git a/azurermps-6.13.0/AzureRM.Insights/New-AzureRmAutoscaleNotification.md b/azurermps-6.13.0/AzureRM.Insights/New-AzureRmAutoscaleNotification.md deleted file mode 100644 index b49fb5e7b5..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/New-AzureRmAutoscaleNotification.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: B5B5F494-D912-40D0-99E2-A62FAACA3EC9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/new-azurermautoscalenotification -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAutoscaleNotification.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAutoscaleNotification.md ---- - -# New-AzureRmAutoscaleNotification - -## SYNOPSIS -Creates an Autoscale email notification. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmAutoscaleNotification [[-Webhook] <WebhookNotification[]>] [[-CustomEmail] <String[]>] - [-SendEmailToSubscriptionAdministrator] [-SendEmailToSubscriptionCoAdministrator] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmAutoscaleNotification** cmdlet creates an email notification for Autoscale. - -## EXAMPLES - -### Example 1: Create an Autoscale email notification -``` -PS C:\>New-AzureRmAutoscaleNotification -CustomEmails "pattif@contoso.com, davidchew@contoso.net" -``` - -This command creates an Autosacale email notification for two specified addresses. - -### Example 2: Create an Autoscale email notification for the subscription administrator -``` -PS C:\>New-AzureRmAutoscaleNotification -SendEmailToSubscriptionAdministrator -``` - -This command creates an Autosacale email notification for the subscription administrator. - -## PARAMETERS - -### -CustomEmail -Specifies a comma-separated list of email addresses. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendEmailToSubscriptionAdministrator -Indicates that this operation sends an email notification to the subscription administrator. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SendEmailToSubscriptionCoAdministrator -Indicates that this operation sends an email notification to the subscription co-administrators. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Webhook -Specifies a comma-separated list of Autoscale webhooks. - -```yaml -Type: Microsoft.Azure.Management.Monitor.Management.Models.WebhookNotification[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.Monitor.Management.Models.WebhookNotification[] - -### System.String[] - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Management.Monitor.Management.Models.AutoscaleNotification - -## NOTES - -## RELATED LINKS - -[New-AzureRmAutoscaleWebhook](./New-AzureRmAutoscaleWebhook.md) - - diff --git a/azurermps-6.13.0/AzureRM.Insights/New-AzureRmAutoscaleProfile.md b/azurermps-6.13.0/AzureRM.Insights/New-AzureRmAutoscaleProfile.md deleted file mode 100644 index 31d4183ff5..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/New-AzureRmAutoscaleProfile.md +++ /dev/null @@ -1,380 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: A4C605DD-9B2E-4EE9-BD1F-1352D605C33F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/new-azurermautoscaleprofile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAutoscaleProfile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAutoscaleProfile.md ---- - -# New-AzureRmAutoscaleProfile - -## SYNOPSIS -Creates an Autoscale profile. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### CreateWithoutScheduledTimes -``` -New-AzureRmAutoscaleProfile -Name <String> -DefaultCapacity <String> -MaximumCapacity <String> - -MinimumCapacity <String> - -Rule <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ScaleRule]> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### CreateWithFixedDateScheduling -``` -New-AzureRmAutoscaleProfile -Name <String> -DefaultCapacity <String> -MaximumCapacity <String> - -MinimumCapacity <String> -StartTimeWindow <DateTime> -EndTimeWindow <DateTime> -TimeWindowTimeZone <String> - -Rule <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ScaleRule]> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### CreateUsingRecurrentScheduling -``` -New-AzureRmAutoscaleProfile -Name <String> -DefaultCapacity <String> -MaximumCapacity <String> - -MinimumCapacity <String> -RecurrenceFrequency <RecurrenceFrequency> - -ScheduleDay <System.Collections.Generic.List`1[System.String]> - -ScheduleHour <System.Collections.Generic.List`1[System.Nullable`1[System.Int32]]> - -ScheduleMinute <System.Collections.Generic.List`1[System.Nullable`1[System.Int32]]> - -ScheduleTimeZone <String> - -Rule <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ScaleRule]> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmAutoscaleProfile** cmdlet creates an Autoscale profile. - -## EXAMPLES - -### Example 1: Create single profile with a fixed date -``` -PS C:\>$Rule = New-AzureRmAutoscaleRule -MetricName "Requests" -MetricResourceId "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/mywebsite" -Operator GreaterThan -MetricStatistic Average -Threshold 10 -TimeGrain 00:01:00 -ScaleActionCooldown 00:05:00 -ScaleActionDirection Increase -ScaleActionScaleType ChangeCount -ScaleActionValue "1" - -PS C:\> $Profile = New-AzureRmAutoscaleProfile -DefaultCapacity "1" -MaximumCapacity "10" -MinimumCapacity "1" -StartTimeWindow 2015-03-05T14:00:00 -EndTimeWindow 2015-03-05T14:30:00 -TimeWindowTimeZone GMT -Rule $Rule -Name "Profile01" -Capacity : Microsoft.Azure.Management.Insights.Models.ScaleCapacity -FixedDate : Microsoft.Azure.Management.Insights.Models.TimeWindow -Name : adios -Recurrence : -Rules : {Microsoft.Azure.Management.Insights.Models.ScaleRule, - Microsoft.Azure.Management.Insights.Models.ScaleRule} -``` - -The first command creates an Autoscale rule named Requests, and then stores it in the $Rule variable. -The second command creates a profile named Profile01 with a fixed date using the rule in $Rule. - -### Example 2: Create a profile with a schedule -``` -PS C:\>$Rule = New-AzureRmAutoscaleRule -MetricName "Requests" -MetricResourceId "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/mywebsite" -Operator GreaterThan -MetricStatistic Average -Threshold 10 -TimeGrain 00:01:00 -ScaleActionCooldown 00:05:00 -ScaleActionDirection Increase -ScaleActionScaleType ChangeCount -ScaleActionValue "1" - -PS C:\> $Profile = New-AzureRmAutoscaleProfile -DefaultCapacity "1" -MaximumCapacity "10" -MinimumCapacity "1" -Rule $Rule -Name "SecondProfileName" -RecurrenceFrequency Minute -ScheduleDays "1", "2", "3" -ScheduleHours 5, 10, 15 -ScheduleMinutes 15, 30, 45 -ScheduleTimeZone GMT -Capacity : Microsoft.Azure.Management.Insights.Models.ScaleCapacity -FixedDate : -Name : secondProfileName -Recurrence : Microsoft.Azure.Management.Insights.Models.Recurrence -Rules : {Microsoft.Azure.Management.Insights.Models.ScaleRule, - Microsoft.Azure.Management.Insights.Models.ScaleRule} -``` - -The first command creates an Autoscale rule named Requests, and then stores it in the $Rule variable. -The second command creates a profile named SecondProfileName with a recurring schedule using the rule in $Rule. - -### Example 3: Create profiles with two rules -``` -PS C:\>$Rule1 = New-AzureRmAutoscaleRule -MetricName "Requests" -MetricResourceId "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/mywebsite" -Operator GreaterThan -MetricStatistic Average -Threshold 10 -TimeGrain 00:01:00 -ScaleActionCooldown 00:05:00 -ScaleActionDirection Increase -ScaleActionScaleType ChangeCount -ScaleActionValue "1" - -PS C:\> $Rule2 = New-AzureRmAutoscaleRule -MetricName "Requests" -MetricResourceId "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/mywebsite" -Operator GreaterThan -MetricStatistic Average -Threshold 10 -TimeGrain 00:01:00 -ScaleActionCooldown 00:10:00 -ScaleActionDirection Increase -ScaleActionScaleType ChangeCount -ScaleActionValue "2" - -PS C:\> $Profile1 = New-AzureRmAutoscaleProfile -DefaultCapacity "1" -MaximumCapacity "10" -MinimumCapacity "1" -StartTimeWindow 2015-03-05T14:00:00 -EndTimeWindow 2015-03-05T14:30:00 -TimeWindowTimeZone GMT -Rule $Rule1, $Rule2 -Name "ProfileName" - -PS C:\> $Profile2 = New-AzureRmAutoscaleProfile -DefaultCapacity "1" -MaximumCapacity "10" -MinimumCapacity "1" -Rule $Rule1, $Rule2 -Name "SecondProfileName" -RecurrenceFrequency Week -ScheduleDays "1" -ScheduleHours 5 -ScheduleMinutes 15 -ScheduleTimeZone UTC -Capacity : Microsoft.Azure.Management.Insights.Models.ScaleCapacity -FixedDate : Microsoft.Azure.Management.Insights.Models.TimeWindow -Name : profileName -Recurrence : -Rules : {Microsoft.Azure.Management.Insights.Models.ScaleRule, - Microsoft.Azure.Management.Insights.Models.ScaleRule} -Capacity : Microsoft.Azure.Management.Insights.Models.ScaleCapacity -FixedDate : -Name : secondProfileName -Recurrence : Microsoft.Azure.Management.Insights.Models.Recurrence -Rules : {Microsoft.Azure.Management.Insights.Models.ScaleRule, - Microsoft.Azure.Management.Insights.Models.ScaleRule} -``` - -The first two commands create rules, and store them in the variables $Rule1 and $Rule2, respectively. -The third command creates a profile named ProfileName using the rules in Rule1 and Rule2, and then stores it in the $Profile1 variable. -The final command creates a profile named SecondProfileName using the rules in Rule1 and Rule2, and then stores it in the $Profile2 variable. - -### Example 4: Create a profile with no schedule or fixed date -``` -PS C:\>$Rule = New-AzureRmAutoscaleRule -MetricName "Requests" -MetricResourceId "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/mywebsite" -Operator GreaterThan -MetricStatistic Average -Threshold 10 -TimeGrain 00:01:00 -ScaleActionCooldown 00:05:00 -ScaleActionDirection Increase -ScaleActionScaleType ChangeCount -ScaleActionValue "1" - -PS C:\> $Profile = New-AzureRmAutoscaleProfile -DefaultCapacity "1" -MaximumCapacity "10" -MinimumCapacity "1" -Rule $Rule -Name "ProfileName" -``` - -The first command creates an Autoscale rule named Requests, and then stores it in the $Rule variable. -The second command creates a profile without a schedule or a fixed date, and then stores it in the $Profile variable. - -## PARAMETERS - -### -DefaultCapacity -Specifies the default capacity. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndTimeWindow -Specifies the end of the time window. - -```yaml -Type: System.DateTime -Parameter Sets: CreateWithFixedDateScheduling -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaximumCapacity -Specifies the maximum capacity. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MinimumCapacity -Specifies the minimum capacity. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the profile to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RecurrenceFrequency -Specifies the frequency of recurrence. -The acceptable values for this parameter are: -- None -- Second -- Minute -- Hour -- Day -- Week -- Month -- Year -Not all of these values are supported. - -```yaml -Type: Microsoft.Azure.Management.Monitor.Management.Models.RecurrenceFrequency -Parameter Sets: CreateUsingRecurrentScheduling -Aliases: -Accepted values: None, Second, Minute, Hour, Day, Week, Month, Year - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Rule -Specifies the list of rules to add to the profile. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ScaleRule] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScheduleDay -Specifies the scheduled days. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: CreateUsingRecurrentScheduling -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScheduleHour -Specifies the scheduled hours. - -```yaml -Type: System.Collections.Generic.List`1[System.Nullable`1[System.Int32]] -Parameter Sets: CreateUsingRecurrentScheduling -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScheduleMinute -Specifies the scheduled minutes. - -```yaml -Type: System.Collections.Generic.List`1[System.Nullable`1[System.Int32]] -Parameter Sets: CreateUsingRecurrentScheduling -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScheduleTimeZone -Specifies the time zone of the schedule. - -```yaml -Type: System.String -Parameter Sets: CreateUsingRecurrentScheduling -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartTimeWindow -Specifies the start of the time window. - -```yaml -Type: System.DateTime -Parameter Sets: CreateWithFixedDateScheduling -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TimeWindowTimeZone -Specifies the time zone of the time window. - -```yaml -Type: System.String -Parameter Sets: CreateWithFixedDateScheduling -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.DateTime - -### Microsoft.Azure.Management.Monitor.Management.Models.RecurrenceFrequency - -### System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Collections.Generic.List`1[[System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Management.Monitor.Management.Models.ScaleRule, Microsoft.Azure.Commands.Insights, Version=5.1.0.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### Microsoft.Azure.Management.Monitor.Management.Models.AutoscaleProfile - -## NOTES - -## RELATED LINKS - -[Add-AzureRmAutoscaleSetting](./Add-AzureRmAutoscaleSetting.md) - -[Get-AzureRmAutoscaleHistory](./Get-AzureRmAutoscaleHistory.md) - -[Get-AzureRmAutoscaleSetting](./Get-AzureRmAutoscaleSetting.md) - -[New-AzureRmAutoscaleRule](./New-AzureRmAutoscaleRule.md) - -[Remove-AzureRmAutoscaleSetting](./Remove-AzureRmAutoscaleSetting.md) - - diff --git a/azurermps-6.13.0/AzureRM.Insights/New-AzureRmAutoscaleRule.md b/azurermps-6.13.0/AzureRM.Insights/New-AzureRmAutoscaleRule.md deleted file mode 100644 index 03fa9a5036..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/New-AzureRmAutoscaleRule.md +++ /dev/null @@ -1,325 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 5E854358-CA9D-4336-BA6A-BF7B1FADAB50 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/new-azurermautoscalerule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAutoscaleRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAutoscaleRule.md ---- - -# New-AzureRmAutoscaleRule - -## SYNOPSIS -Creates an Autoscale rule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmAutoscaleRule -MetricName <String> -MetricResourceId <String> -Operator <ComparisonOperationType> - -MetricStatistic <MetricStatisticType> -Threshold <Double> [-TimeAggregationOperator <TimeAggregationType>] - -TimeGrain <TimeSpan> [-TimeWindow <TimeSpan>] -ScaleActionCooldown <TimeSpan> - -ScaleActionDirection <ScaleDirection> [-ScaleActionScaleType <ScaleType>] -ScaleActionValue <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmAutoscaleRule** cmdlet creates an Autoscale rule. - -## EXAMPLES - -### Example 1: Create a rule -``` -PS C:\>$Rule = New-AzureRmAutoscaleRule -MetricName "Requests" -MetricResourceId "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/mywebsite" -Operator GreaterThan -MetricStatistic Average -Threshold 10 -TimeGrain 00:01:00 -ScaleActionCooldown 00:05:00 -ScaleActionDirection Increase -ScaleActionScaleType ChangeCount -ScaleActionValue "1" -MetricTrigger ScaleAction -------------- ----------- -Microsoft.Azure.Management.Insights.Models.MetricTrigger Microsoft.Azure.Management.Insights.Models.ScaleAction -``` - -This command creates a rule. - -### Example 2: Create two rules -``` -PS C:\>$Rule1 = New-AzureRmAutoscaleRule -MetricName "Requests" -MetricResourceId "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/mywebsite" -Operator GreaterThan -MetricStatistic Average -Threshold 10 -TimeGrain 00:01:00 -ScaleActionCooldown 00:05:00 -ScaleActionDirection Increase -ScaleActionScaleType ChangeCount -ScaleActionValue "1" - -PS C:\> $Rule2 = New-AzureRmAutoscaleRule -MetricName "Requests" -MetricResourceId "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/mywebsite" -Operator GreaterThan -MetricStatistic Average -Threshold 10 -TimeGrain 00:01:00 -ScaleActionCooldown 00:10:00 -ScaleActionDirection Increase -ScaleActionScaleType ChangeCount -ScaleActionValue "2" -MetricTrigger ScaleAction -------------- ----------- -Microsoft.Azure.Management.Insights.Models.MetricTrigger Microsoft.Azure.Management.Insights.Models.ScaleAction -Microsoft.Azure.Management.Insights.Models.MetricTrigger Microsoft.Azure.Management.Insights.Models.ScaleAction -``` - -The first command creates a rule for the Requests metric, and then stores it in the $Rule1 variable. -The second command creates a second rule for the Requests metric, and then stores it in the $Rule2 variable. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MetricName -Specifies the name of the metric. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MetricResourceId -Specifies the metric resource ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MetricStatistic -Specifies the metric statistic. -The acceptable values for this parameter are: -- Average -- Min -- Max -- Sum - -```yaml -Type: Microsoft.Azure.Management.Monitor.Management.Models.MetricStatisticType -Parameter Sets: (All) -Aliases: -Accepted values: Average, Min, Max, Sum - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Operator -Specifies the operator. -The acceptable values for this parameter are: -- Equals -- NotEquals -- GreaterThan -- GreaterThanOrEqual -- LessThan -- LessThanOrEqual - -```yaml -Type: Microsoft.Azure.Management.Monitor.Management.Models.ComparisonOperationType -Parameter Sets: (All) -Aliases: -Accepted values: Equals, NotEquals, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScaleActionCooldown -Specifies the Autoscale action cooldown time. - -```yaml -Type: System.TimeSpan -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScaleActionDirection -Specifies the scale action direction. -The acceptable values for this parameter are: -- None -- Increase -- Decrease - -```yaml -Type: Microsoft.Azure.Management.Monitor.Management.Models.ScaleDirection -Parameter Sets: (All) -Aliases: -Accepted values: None, Increase, Decrease - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScaleActionScaleType -Specifies the scale type. -The acceptable values for this parameter are: -- ChangeSize -- ChangeCount -- PercentChangeCount -- ExactCount - -```yaml -Type: Microsoft.Azure.Management.Monitor.Management.Models.ScaleType -Parameter Sets: (All) -Aliases: -Accepted values: ChangeCount, PercentChangeCount, ExactCount - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScaleActionValue -Specifies the action value. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Threshold -Specifies the threshold of the metric value. - -```yaml -Type: System.Double -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TimeAggregationOperator -Specifies the time aggregation operator. -The acceptable values for this parameter are: -- Average -- Minimum -- Maximum -- Last -- Total, Count - -```yaml -Type: Microsoft.Azure.Management.Monitor.Management.Models.TimeAggregationType -Parameter Sets: (All) -Aliases: -Accepted values: Average, Minimum, Maximum, Total, Count - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TimeGrain -Specifies the time grain. - -```yaml -Type: System.TimeSpan -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TimeWindow -Specifies the time window. - -```yaml -Type: System.TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Management.Monitor.Management.Models.ComparisonOperationType - -### Microsoft.Azure.Management.Monitor.Management.Models.MetricStatisticType - -### System.Double - -### Microsoft.Azure.Management.Monitor.Management.Models.TimeAggregationType - -### System.TimeSpan - -### Microsoft.Azure.Management.Monitor.Management.Models.ScaleDirection - -### Microsoft.Azure.Management.Monitor.Management.Models.ScaleType - -## OUTPUTS - -### Microsoft.Azure.Management.Monitor.Management.Models.ScaleRule - -## NOTES - -## RELATED LINKS - -[Add-AzureRmAutoscaleSetting](./Add-AzureRmAutoscaleSetting.md) - -[Get-AzureRmAutoscaleHistory](./Get-AzureRmAutoscaleHistory.md) - -[Get-AzureRmAutoscaleSetting](./Get-AzureRmAutoscaleSetting.md) - -[New-AzureRmAutoscaleProfile](./New-AzureRmAutoscaleProfile.md) - -[Remove-AzureRmAutoscaleSetting](./Remove-AzureRmAutoscaleSetting.md) - - diff --git a/azurermps-6.13.0/AzureRM.Insights/New-AzureRmAutoscaleWebhook.md b/azurermps-6.13.0/AzureRM.Insights/New-AzureRmAutoscaleWebhook.md deleted file mode 100644 index 48da245436..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/New-AzureRmAutoscaleWebhook.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 674A11E4-36B9-4075-9F4E-952BD9FF07A7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/new-azurermautoscalewebhook -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAutoscaleWebhook.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAutoscaleWebhook.md ---- - -# New-AzureRmAutoscaleWebhook - -## SYNOPSIS -Creates an Autoscale webhook. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmAutoscaleWebhook [-ServiceUri] <String> [[-Property] <Hashtable>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmAutoscaleWebhook** cmdlet creates an Autoscale webhook. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Property -Specifies the list of properties in the format @(property1 = 'value1',....). - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceUri -Specifies the service URI. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Management.Monitor.Management.Models.WebhookNotification - -## NOTES - -## RELATED LINKS - -[New-AzureRmAlertRuleWebhook](./New-AzureRmAlertRuleWebhook.md) - - diff --git a/azurermps-6.13.0/AzureRM.Insights/New-AzureRmMetricFilter.md b/azurermps-6.13.0/AzureRM.Insights/New-AzureRmMetricFilter.md deleted file mode 100644 index d1edd00ca5..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/New-AzureRmMetricFilter.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: B5F2388E-0136-4F8A-8577-67CE2A45671E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/new-azurermmetricfilter -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmMetricFilter.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmMetricFilter.md ---- - -# New-AzureRmMetricFilter - -## SYNOPSIS -Creates a metric dimension filter that can be used to query metrics. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmMetricFilter [-Dimension] <String> [-Operator] <String> [-Value] <String[]> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmMetricFilter** cmdlet creates a metric dimension filter that can be used to query metrics. - -## EXAMPLES - -### Example 1: Create a metric dimension filter -``` -PS C:\>New-AzureRmMetricFilter -Dimension City -Operator eq -Value "Seattle","New York" -``` - -This command creates metric dimension filter of the format "City eq 'Seattle' or City eq 'New York'". - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Dimension -The name of the metric dimension. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Operator -Specifies the operator used to select the metric dimension. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Value -Specifies the array of metric dimension values. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.String[] - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Get-AzureRmMetric](./Get-AzureRmMetric.md) -[Get-AzureRmMetricDefinition](./Get-AzureRmMetricDefinition.md) - diff --git a/azurermps-6.13.0/AzureRM.Insights/Remove-AzureRmActionGroup.md b/azurermps-6.13.0/AzureRM.Insights/Remove-AzureRmActionGroup.md deleted file mode 100644 index 249bdbf06d..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/Remove-AzureRmActionGroup.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 8D8FE2FE-03E7-453E-B968-E28B07E42EF2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/remove-azurermactiongroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Remove-AzureRmActionGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Remove-AzureRmActionGroup.md ---- - -# Remove-AzureRmActionGroup - -## SYNOPSIS -Removes an action group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByPropertyName (Default) -``` -Remove-AzureRmActionGroup -ResourceGroupName <String> -Name <String> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Remove-AzureRmActionGroup -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByInputObject -``` -Remove-AzureRmActionGroup -InputObject <PSActionGroupResource> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmActionGroup** cmdlet removes an action group. - -## EXAMPLES - -### Example 1: Remove an action group -``` -PS C:\>Remove-AzureRmActionGroup -ResourceGroup "Default-Web-CentralUS" -Name "myActionGroup" -RequestId StatusCode ---------- ---------- -2c6c159b-0e73-4a01-a67b-c32c1a0008a3 OK -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The action group resourc - -```yaml -Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupResource -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the action group. - -```yaml -Type: System.String -Parameter Sets: ByPropertyName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group nam - -```yaml -Type: System.String -Parameter Sets: ByPropertyName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The resource i - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupResource -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.AzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Set-AzureRmActionGroup](./Set-AzureRmActionGroup.md) -[Get-AzureRmActionGroup](./Get-AzureRmActionGroup.md) -[New-AzureRmActionGroupReceiver](./New-AzureRmActionGroupReceiver.md) diff --git a/azurermps-6.13.0/AzureRM.Insights/Remove-AzureRmActivityLogAlert.md b/azurermps-6.13.0/AzureRM.Insights/Remove-AzureRmActivityLogAlert.md deleted file mode 100644 index ee5a561dde..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/Remove-AzureRmActivityLogAlert.md +++ /dev/null @@ -1,208 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: C7EC21C7-1C7E-49B2-9B33-486532FCDAEC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/remove-azurermactivitylogalert -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Remove-AzureRmActivityLogAlert.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Remove-AzureRmActivityLogAlert.md ---- - -# Remove-AzureRmActivityLogAlert - -## SYNOPSIS -Removes an activity log alert. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RemoveByNameAndResourceGroup -``` -Remove-AzureRmActivityLogAlert -ResourceGroupName <String> -Name <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RemoveByInputObject -``` -Remove-AzureRmActivityLogAlert -InputObject <PSActivityLogAlertResource> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RemoveByResourceId -``` -Remove-AzureRmActivityLogAlert -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmActivityLogAlert** cmdlet removes an activity log alert. -This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually patching the resource. -This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating, modifying, or removing the resource. - -## EXAMPLES - -### Example 1: Remove an activity log alert -``` -PS C:\>Remove-AzureRmActivityLogAlert -ResourceGroup "Default-Web-CentralUS" -Name "myalert" -RequestId StatusCode ---------- ---------- -2c6c159b-0e73-4a01-a67b-c32c1a0008a3 OK -``` - -Removes an activity log alert using name and resource group name as inputs. - -### Example 2: Remove an activity log alert using a PSActivityLogAlertResource as input -``` -PS C:\>Get-AzureRmActivityLogAlert -ResourceGroup "Default-activityLogAlerts" -Name "alert1" | Remove-AzureRmActivityLogAlert -RequestId StatusCode ---------- ---------- -5c371547-80b0-4185-9b95-700b129de9d4 OK -``` - -Removes an activity log alert using a PSActivityLogAlertResource as input. - -### Example 3: Remove the ActivityLogAlert using the ResourceId parameter -``` -PS C:\>Find-AzureRmResource -ResourceGroupEquals "myResourceGroup" -ResourceNameEquals "myLogAlert" | Remove-AzureRmActivityLogAlert -``` - -This command removes the ActivityLogAlert using the ResourceId parameter from the pipe. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Sets the InputObject tags property of the call to extract the required name, and resource group name properties. - -```yaml -Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSActivityLogAlertResource -Parameter Sets: RemoveByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the activity log alert. - -```yaml -Type: System.String -Parameter Sets: RemoveByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group where the alert resource exists. - -```yaml -Type: System.String -Parameter Sets: RemoveByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Sets the ResourceId tags property of the call to extract the required name, resource group name properties. - -```yaml -Type: System.String -Parameter Sets: RemoveByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSActivityLogAlertResource -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.AzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Enable-AzureRmActivityLogAlert](./Enable-AzureRmActivityLogAlert.md) - -[Disable-AzureRmActivityLogAlert](./Disable-AzureRmActivityLogAlert.md) - -[Set-AzureRmActivityLogAlert](./Set-AzureRmActivityLogAlert.md) - -[Get-AzureRmActivityLogAlert](./Get-AzureRmActivityLogAlert.md) - -[New-AzureRmActionGroup](./New-AzureRmActionGroup.md) - - - diff --git a/azurermps-6.13.0/AzureRM.Insights/Remove-AzureRmAlertRule.md b/azurermps-6.13.0/AzureRM.Insights/Remove-AzureRmAlertRule.md deleted file mode 100644 index 8c9e1a6a0a..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/Remove-AzureRmAlertRule.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: C7EC21C7-1C7E-49B2-9B33-486532FCDAEC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/remove-azurermalertrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Remove-AzureRmAlertRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Remove-AzureRmAlertRule.md ---- - -# Remove-AzureRmAlertRule - -## SYNOPSIS -Removes an alert rule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmAlertRule -ResourceGroupName <String> -Name <String> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmAlertRule** cmdlet removes an alert rule. -You must specify the name of the alert rule and the resource group to which it is assigned. -This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating, modifying, or removing the resource. - -## EXAMPLES - -### Example 1: Remove an alert rule -``` -PS C:\>Remove-AzureRmAlertRule -ResourceGroup "Default-Web-CentralUS" -Name "myalert-7da64548-214d-42ca-b12b-b245bb8f0ac8" -RequestId StatusCode ---------- ---------- -2c6c159b-0e73-4a01-a67b-c32c1a0008a3 OK -``` - -This command removes the alert rule named myalert-7da64548-214d-42ca-b12b-b245bb8f0ac8 in the resource group Default-Web-CentralUS. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the alert rule to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for the alert rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.AzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Add-AzureRmMetricAlertRule](./Add-AzureRmMetricAlertRule.md) - -[Add-AzureRmWebtestAlertRule](./Add-AzureRmWebtestAlertRule.md) - -[Get-AzureRmAlertHistory](./Get-AzureRmAlertHistory.md) - -[Get-AzureRmAlertRule](./Get-AzureRmAlertRule.md) - - diff --git a/azurermps-6.13.0/AzureRM.Insights/Remove-AzureRmAutoscaleSetting.md b/azurermps-6.13.0/AzureRM.Insights/Remove-AzureRmAutoscaleSetting.md deleted file mode 100644 index fc5bde9b80..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/Remove-AzureRmAutoscaleSetting.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 6140E973-D7AB-4A28-A4FA-818E08129372 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/remove-azurermautoscalesetting -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Remove-AzureRmAutoscaleSetting.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Remove-AzureRmAutoscaleSetting.md ---- - -# Remove-AzureRmAutoscaleSetting - -## SYNOPSIS -Removes an Autoscale setting. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmAutoscaleSetting -ResourceGroupName <String> -Name <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmAutoscaleSetting** cmdlet removes an Autoscale setting. -You must specify the name of the setting and the name of the resource group to which it is assigned. -This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating, modifying, or removing the resource. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Autoscale setting to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.AzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Add-AzureRmAutoscaleSetting](./Add-AzureRmAutoscaleSetting.md) - -[Get-AzureRmAutoscaleSetting](./Get-AzureRmAutoscaleSetting.md) - - diff --git a/azurermps-6.13.0/AzureRM.Insights/Remove-AzureRmDiagnosticSetting.md b/azurermps-6.13.0/AzureRM.Insights/Remove-AzureRmDiagnosticSetting.md deleted file mode 100644 index 0fb2f2f03a..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/Remove-AzureRmDiagnosticSetting.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: B5F2388E-0136-4F8A-8577-67CE2A45671E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/remove-azurermdiagnosticsetting -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Remove-AzureRmDiagnosticSetting.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Remove-AzureRmDiagnosticSetting.md ---- - -# Remove-AzureRmDiagnosticSetting - -## SYNOPSIS -Remove a diagnostic setting for the a resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmDiagnosticSetting -ResourceId <String> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmDiagnosticSetting** cmdlet removes the diagnostic setting for the particular resource. -This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating, modifying, or removing the resource. - -## EXAMPLES - -### Example 1: Remove the default diagnostic setting (service) for a resource -``` -PS C:\>Remove-AzureRmDiagnosticSetting -ResourceId "Resource01" -``` - -This command removes the default diagnostic setting (service) for the resource called Resource01. - -### Example 2: Remove the default diagnostic setting identified by the given name for a resource -``` -PS C:\>Remove-AzureRmDiagnosticSetting -ResourceId "Resource01" -Name myDiagSetting -``` - -This command removes the diagnostic setting called myDiagSetting for the resource called Resource01. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the diagnostic setting. If not given the call default to "service" as it was in the previous API and this cmdlet will only disable all categories for metrics/logs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Specifies the ID of the resource. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.AzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDiagnosticSetting](./Get-AzureRmDiagnosticSetting.md) -[Set-AzureRmDiagnosticSetting](./Set-AzureRmDiagnosticSetting.md) diff --git a/azurermps-6.13.0/AzureRM.Insights/Remove-AzureRmLogProfile.md b/azurermps-6.13.0/AzureRM.Insights/Remove-AzureRmLogProfile.md deleted file mode 100644 index 7978acee35..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/Remove-AzureRmLogProfile.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: DDA137FD-4EB3-4FB7-A202-978922038AFC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/remove-azurermlogprofile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Remove-AzureRmLogProfile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Remove-AzureRmLogProfile.md ---- - -# Remove-AzureRmLogProfile - -## SYNOPSIS -Removes a log profile. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmLogProfile -Name <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmLogProfile** cmdlet removes a log profile. -This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating, modifying, or removing the resource. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the log profile to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.AzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLogProfile](./Add-AzureRmLogProfile.md) - -[Get-AzureRmLogProfile](./Get-AzureRmLogProfile.md) - - diff --git a/azurermps-6.13.0/AzureRM.Insights/Set-AzureRmActionGroup.md b/azurermps-6.13.0/AzureRM.Insights/Set-AzureRmActionGroup.md deleted file mode 100644 index 6062b02849..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/Set-AzureRmActionGroup.md +++ /dev/null @@ -1,288 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 4A6816DB-0E46-44F0-8AE9-180B1C4AAB22 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/set-azurermactiongroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Set-AzureRmActionGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Set-AzureRmActionGroup.md ---- - -# Set-AzureRmActionGroup - -## SYNOPSIS -Creates a new or updates an existing action group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByPropertyName (Default) -``` -Set-AzureRmActionGroup -ResourceGroupName <String> -Name <String> -ShortName <String> - -Receiver <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupReceiverBase]> - [-DisableGroup] [-Tag <System.Collections.Generic.IDictionary`2[System.String,System.String]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Set-AzureRmActionGroup -ShortName <String> - -Receiver <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupReceiverBase]> - [-DisableGroup] [-Tag <System.Collections.Generic.IDictionary`2[System.String,System.String]>] - -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByInputObject -``` -Set-AzureRmActionGroup [-ShortName <String>] [-DisableGroup] - [-Tag <System.Collections.Generic.IDictionary`2[System.String,System.String]>] - -InputObject <PSActionGroupResource> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmActionGroup** cmdlet creates a new or updates an existing action group - -## EXAMPLES - -### Example 1: Create an Action Group -``` -PS C:\>$email1 = New-AzureRmActionGroupReceiver -Name 'user1' -EmailReceiver -EmailAddress 'user1@example.com' -PS C:\>$sms1 = New-AzureRmActionGroupReceiver -Name 'user2' -SmsReceiver -CountryCode '1' -PhoneNumber '5555555555' -PS C:\>Set-AzureRmActionGroup -Name $actionGroupName -ResourceGroup $resourceGroupName -ShortName $shortName -Receiver $email1,$sms1 -``` - -The first two commands create two receivers. -The final command creates an Action Group including the two receivers. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableGroup -Disables the action group. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByPropertyName, ByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByInputObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -The action group resourc - -```yaml -Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupResource -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the action group. - -```yaml -Type: System.String -Parameter Sets: ByPropertyName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Receiver -The list of receivers of the action group. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupReceiverBase] -Parameter Sets: ByPropertyName, ByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group nam - -```yaml -Type: System.String -Parameter Sets: ByPropertyName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The resource i - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ShortName -The short name of the action group. - -```yaml -Type: System.String -Parameter Sets: ByPropertyName, ByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ByInputObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -The tags of the action group resourc - -```yaml -Type: System.Collections.Generic.IDictionary`2[System.String,System.String] -Parameter Sets: ByPropertyName, ByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Collections.Generic.IDictionary`2[System.String,System.String] -Parameter Sets: ByInputObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupReceiverBase, Microsoft.Azure.Commands.Insights, Version=5.1.0.0, Culture=neutral, PublicKeyToken=null]] - -### System.Management.Automation.SwitchParameter - -### System.Collections.Generic.IDictionary`2[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089],[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupResource -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupResource - -## NOTES - -## RELATED LINKS - -[Get-AzureRmActionGroup](./Get-AzureRmActionGroup.md) -[Remove-AzureRmActionGroup](./Remove-AzureRmActionGroup.md) -[New-AzureRmActionGroupReceiver](./New-AzureRmActionGroupReceiver.md) diff --git a/azurermps-6.13.0/AzureRM.Insights/Set-AzureRmActivityLogAlert.md b/azurermps-6.13.0/AzureRM.Insights/Set-AzureRmActivityLogAlert.md deleted file mode 100644 index 4d0e1dd3c6..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/Set-AzureRmActivityLogAlert.md +++ /dev/null @@ -1,467 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 7436F31F-9DCB-4365-BA6D-41BDB5D7FCB6 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/set-azurermactivitylogalert -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Set-AzureRmActivityLogAlert.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Set-AzureRmActivityLogAlert.md ---- - -# Set-AzureRmActivityLogAlert - -## SYNOPSIS -Creates a new or sets an existing activity log alert. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByNameAndResourceGroup -``` -Set-AzureRmActivityLogAlert -Location <String> -Name <String> -ResourceGroupName <String> - -Scope <System.Collections.Generic.List`1[System.String]> - -Condition <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertLeafCondition]> - -Action <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertActionGroup]> - [-DisableAlert] [-Description <String>] - [-Tag <System.Collections.Generic.Dictionary`2[System.String,System.String]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByResourceId -``` -Set-AzureRmActivityLogAlert [-Location <String>] [-Scope <System.Collections.Generic.List`1[System.String]>] - [-Condition <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertLeafCondition]>] - [-Action <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertActionGroup]>] - [-DisableAlert] [-Description <String>] - [-Tag <System.Collections.Generic.Dictionary`2[System.String,System.String]>] -ResourceId <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByInputObject -``` -Set-AzureRmActivityLogAlert [-Scope <System.Collections.Generic.List`1[System.String]>] - [-Condition <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertLeafCondition]>] - [-Action <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertActionGroup]>] - [-Description <String>] [-Tag <System.Collections.Generic.Dictionary`2[System.String,System.String]>] - -InputObject <PSActivityLogAlertResource> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmActivityLogAlert** cmdlet creates a new or sets an existing activity log alert. -For tags, conditions, and actions the objects must be created in advance and passed as parameters in this call as a comma separated (see the example below). -This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating/modifying the resource. -**NOTE**: This cmdlet and its related ones replaces the deprecated (November 2017) **Add-AzureRmLogAlertRule**. - -## EXAMPLES - -### Example 1: Create an Activity Log Alert -``` -PS C:\>$location = 'Global' -PS C:\>$alertName = 'myAlert' -PS C:\>$resourceGroupName = 'theResourceGroupName' -PS C:\>$condition1 = New-AzureRmActivityLogAlertCondition -Field 'field1' -Equals 'equals1' -PS C:\>$condition2 = New-AzureRmActivityLogAlertCondition -Field 'field2' -Equals 'equals2' -PS C:\>$dict = New-Object "System.Collections.Generic.Dictionary``2[System.String,System.String]" -PS C:\>$dict.Add('key1', 'value1') -PS C:\>$actionGrp1 = New-AzureRmActionGroup -ActionGroupId 'actiongr1' -WebhookProperties $dict -PS C:\>Set-AzureRmActivityLogAlert -Location $location -Name $alertName -ResourceGroupName $resourceGroupName -Scope 'scope1','scope2' -Action $actionGrp1 -Condition $condition1, $condition2 -``` - -The first four commands create leaf condition and action group. -The final command creates an Activity Log Alert using the condition and the action group. - -### Example 2: Create an Activity Log Alert disabled -``` -PS C:\>$location = 'Global' -PS C:\>$alertName = 'myAlert' -PS C:\>$resourceGroupName = 'theResourceGroupName' -PS C:\>$condition1 = New-AzureRmActivityLogAlertCondition -Field 'field1' -Equals 'equals1' -PS C:\>$condition2 = New-AzureRmActivityLogAlertCondition -Field 'field2' -Equals 'equals2' -PS C:\>$dict = New-Object "System.Collections.Generic.Dictionary``2[System.String,System.String]" -PS C:\>$dict.Add('key1', 'value1') -PS C:\>$actionGrp1 = New-AzureRmActionGroup -ActionGroupId 'actiongr1' -WebhookProperties $dict -PS C:\>Set-AzureRmActivityLogAlert -Location $location -Name $alertName -ResourceGroupName $resourceGroupName -Scope 'scope1','scope2' -Action $actionGrp1 -Condition $condition1, $condition2 -DisableAlert -``` - -The first four commands create leaf condition and action group. -The final command creates an Activity Log Alert using the condition and the action group, but it creates the alert disabled. - -### Example 3: Set an activity log alert based using a value from the pipe or the InputObject parameter -``` -PS C:\>Get-AzureRmActivityLogAlert -Name $alertName -ResourceGroupName $resourceGroupName | Set-AzureRmActivityLogAlert -PS C:\>$alert = Get-AzureRmActivityLogAlert -Name $alertName -ResourceGroupName $resourceGroupName -PS C:\>$alert.Description = 'Changing the description' -PS C:\>$alert.Enabled = $false -PS C:\>Set-AzureRmActivityLogAlert -InputObject $alert -``` - -The first command is similar to a nop, it sets the alert with the same values it already contained -The rest of the commands retrieve the alert rule, change the description and disable it, then use the InputObject parameter to persist those changes - -### Example 4: Set an activity log alert based using the ResourceId value from the pipe -``` -PS C:\>Find-AzureRmResource -ResourceGroupEquals "myResourceGroup" -ResourceNameEquals "myLogAlert" | Set-AzureRmActivityLogAlert -DisableAlert -``` - -If the given log alert rule exists this command disables it. - -## PARAMETERS - -### -Action -The list of action groups for the activity log alert. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertActionGroup] -Parameter Sets: SetByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertActionGroup] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertActionGroup] -Parameter Sets: SetByInputObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Condition -The list of conditions for the activity log alert. -**NOTE**: In the list of conditions there must be at least one with the Field equal to "Category". The backend responds with 400 (BadRequest) if this condition is not present. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertLeafCondition] -Parameter Sets: SetByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertLeafCondition] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertLeafCondition] -Parameter Sets: SetByInputObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The description of the alert resource. - -```yaml -Type: System.String -Parameter Sets: SetByNameAndResourceGroup, SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: SetByInputObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisableAlert -Allows the user to create a disabled the activity log alert. If not given, the alerts are created enabled. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: SetByNameAndResourceGroup, SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Sets the InputObject tags property of the call to extract the required name, and resource group name properties. - -```yaml -Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSActivityLogAlertResource -Parameter Sets: SetByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Location -The location where the activity log alert will exist. - -```yaml -Type: System.String -Parameter Sets: SetByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The name of the activity log alert. - -```yaml -Type: System.String -Parameter Sets: SetByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group where the alert resource is going to exist. - -```yaml -Type: System.String -Parameter Sets: SetByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Sets the ResourceId tags property of the call to extract the required name, resource group name properties. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Scope -The list of scopes for the activity log alert. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByInputObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Sets the tags property of the activity log alert resource. - -```yaml -Type: System.Collections.Generic.Dictionary`2[System.String,System.String] -Parameter Sets: SetByNameAndResourceGroup, SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Collections.Generic.Dictionary`2[System.String,System.String] -Parameter Sets: SetByInputObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertLeafCondition, Microsoft.Azure.Commands.Insights, Version=5.1.0.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertActionGroup, Microsoft.Azure.Commands.Insights, Version=5.1.0.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.Dictionary`2[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089],[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSActivityLogAlertResource -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSActivityLogAlertResource - -## NOTES - -## RELATED LINKS - -[Enable-AzureRmActivityLogAlert](./Enable-AzureRmActivityLogAlert.md) - -[Disable-AzureRmActivityLogAlert](./Disable-AzureRmActivityLogAlert.md) - -[Get-AzureRmActivityLogAlert](./Get-AzureRmActivityLogAlert.md) - -[Remove-AzureRmActivityLogAlert](./Remove-AzureRmActivityLogAlert.md) - -[New-AzureRmActionGroup](./New-AzureRmActionGroup.md) - - diff --git a/azurermps-6.13.0/AzureRM.Insights/Set-AzureRmDiagnosticSetting.md b/azurermps-6.13.0/AzureRM.Insights/Set-AzureRmDiagnosticSetting.md deleted file mode 100644 index af75896476..0000000000 --- a/azurermps-6.13.0/AzureRM.Insights/Set-AzureRmDiagnosticSetting.md +++ /dev/null @@ -1,419 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: B5F2388E-0136-4F8A-8577-67CE2A45671E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/set-azurermdiagnosticsetting -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Set-AzureRmDiagnosticSetting.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Insights/Commands.Insights/help/Set-AzureRmDiagnosticSetting.md ---- - -# Set-AzureRmDiagnosticSetting - -## SYNOPSIS -Sets the logs and metrics settings for the resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### OldSetDiagnosticSetting (Default) -``` -Set-AzureRmDiagnosticSetting -ResourceId <String> [-Name <String>] [-StorageAccountId <String>] - [-ServiceBusRuleId <String>] [-EventHubName <String>] [-EventHubAuthorizationRuleId <String>] - [-Enabled <Boolean>] [-Categories <System.Collections.Generic.List`1[System.String]>] - [-MetricCategory <System.Collections.Generic.List`1[System.String]>] - [-Timegrains <System.Collections.Generic.List`1[System.String]>] [-RetentionEnabled <Boolean>] - [-WorkspaceId <String>] [-RetentionInDays <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### NewSetDiagnosticSetting -``` -Set-AzureRmDiagnosticSetting -InputObject <PSServiceDiagnosticSettings> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDiagnosticSetting** cmdlet enables or disables each time grain and log category for the particular resource. -The logs and metrics are stored in the specified storage account. -This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating, modifying, or removing the resource. - -## EXAMPLES - -### Example 1: Enable all metrics and logs for a resource -``` -PS C:\>Set-AzureRmDiagnosticSetting -ResourceId "Resource01" -Enabled $True -``` - -This command enables all available metrics and logs for Resource01. - -### Example 2: Disable all metrics and logs -``` -PS C:\>Set-AzureRmDiagnosticSetting -ResourceId "Resource01" -Enabled $False -``` - -This command disables all available metrics and logs for the resource Resource01. - -### Example 3: Enable/disable multiple metrics categories -``` -PS C:\>Set-AzureRmDiagnosticSetting -ResourceId "Resource01" -Enabled $False -MetricCategory MetricCategory1,MetricCategory2 -StorageAccountId : <storageAccountId> -StorageAccountName : <storageAccountName> -Metrics - Enabled : False - Category : MetricCategory1 - Timegrain : PT1M - Enabled : False - Category : MetricCategory2 - Timegrain : PT1H - Enabled : True - Category : MetricCategory3 - Timegrain : PT1H -Logs - Enabled : True - Category : Category1 - Enabled : True - Category : Category2 - Enabled : True - Category : Category3 - Enabled : False - Category : Category4 -``` - -This command enables the metrics cateories called Category1 and Category2. -All the other categories remain the same. - -### Example 4: Enable/disable multiple log categories -``` -PS C:\>Set-AzureRmDiagnosticSetting -ResourceId "Resource01" -Enabled $True -Categories Category1,Category2 -StorageAccountId : <storageAccountId> -StorageAccountName : <storageAccountName> -Metrics - Enabled : False - Category : MetricCategory1 - Timegrain : PT1M - Enabled : False - Category : MetricCategory2 - Timegrain : PT1H - Enabled : True - Category : MetricCategory3 - Timegrain : PT1H -Logs - Enabled : True - Category : Category1 - Enabled : True - Category : Category2 - Enabled : True - Category : Category3 - Enabled : False - Category : Category4 -``` - -This command enables Category1 and Category2. -All the other metrics and logs categories remain the same. - -### Example 4: Enable a time grain and multiple categories -``` -PS C:\>Set-AzureRmDiagnosticSetting -ResourceId "Resource01" -Enabled $True -Categories Category1,Category2 -Timegrains PT1M -``` - -This command enables only Category1, Category2, and time grain PT1M. -All other time grains and categories are unchanged. - -### Example 5: Using pipeline -``` -PS C:\>Get-AzureRmDiagnosticSetting -ResourceId "Resource01" | Set-AzureRmDiagnosticSetting -``` - -This command uses the PowerShell pipeline to set (not change made) a diagnostic setting. - -## PARAMETERS - -### -Categories -Specifies the list of log categories to enable or disable, according to the value of *Enabled*. -If no category is specified, this command operates on all supported categories. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: OldSetDiagnosticSetting -Aliases: Category - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Indicates whether to enable diagnostics. -Specify $True to enable diagnostics, or $False to disable diagnostics. - -```yaml -Type: System.Boolean -Parameter Sets: OldSetDiagnosticSetting -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EventHubAuthorizationRuleId -The event hub authorization rule id - -```yaml -Type: System.String -Parameter Sets: OldSetDiagnosticSetting -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EventHubName -The event hub name - -```yaml -Type: System.String -Parameter Sets: OldSetDiagnosticSetting -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -The input object (possible from the pipeline.) The name and resourceId will be extracted from this object. - -```yaml -Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSServiceDiagnosticSettings -Parameter Sets: NewSetDiagnosticSetting -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -MetricCategory -The list of metric categories. -If no category is specified, this command operates on all supported categories. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: OldSetDiagnosticSetting -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The name of the diagnostic setting. The default value is **service**. - -```yaml -Type: System.String -Parameter Sets: OldSetDiagnosticSetting -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Specifies the ID of the resource. - -```yaml -Type: System.String -Parameter Sets: OldSetDiagnosticSetting -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RetentionEnabled -Indicates whether retention of diagnostic information is enabled. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: OldSetDiagnosticSetting -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RetentionInDays -Specifies the retention policy, in days. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: OldSetDiagnosticSetting -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceBusRuleId -The Service Bus Rule id. - -```yaml -Type: System.String -Parameter Sets: OldSetDiagnosticSetting -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountId -Specifies the ID of the Storage account in which to save the data. - -```yaml -Type: System.String -Parameter Sets: OldSetDiagnosticSetting -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Timegrains -Specifies the time grains to enable or disable for metrics, according to the value of *Enabled*. -If you do not specify a time grain, this command operates on all available time grains. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: OldSetDiagnosticSetting -Aliases: Timegrain - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WorkspaceId -The Id of the workspace - -```yaml -Type: System.String -Parameter Sets: OldSetDiagnosticSetting -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSServiceDiagnosticSettings -Parameters: InputObject (ByValue) - -### System.String - -### System.Boolean - -### System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSServiceDiagnosticSettings - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDiagnosticSetting](./Get-AzureRmDiagnosticSetting.md) -[Remove-AzureRmDiagnosticSetting](./Remove-AzureRmDiagnosticSetting.md) diff --git a/azurermps-6.13.0/AzureRM.IotCentral/AzureRM.IotCentral.md b/azurermps-6.13.0/AzureRM.IotCentral/AzureRM.IotCentral.md deleted file mode 100644 index e7eab4bb81..0000000000 --- a/azurermps-6.13.0/AzureRM.IotCentral/AzureRM.IotCentral.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -Module Name: AzureRM.IotCentral -Module Guid: df9fc69a-c019-403a-9013-eefa7eb5e27a -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.iotcentral -Help Version: 0.1.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotCentral/Commands.IotCentral/help/AzureRM.IotCentral.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotCentral/Commands.IotCentral/help/AzureRM.IotCentral.md ---- - -# AzureRM.IotCentral Module -## Description -Provides CRUD Management for IoT Central Applications. - -## AzureRM.IotCentral Cmdlets -### [Get-AzureRmIotCentralApp](Get-AzureRmIotCentralApp.md) -Gets properties for either one or several IoT Central Applications. - -### [New-AzureRmIotCentralApp](New-AzureRmIotCentralApp.md) -Creates a new IoT Central Application. - -### [Remove-AzureRmIotCentralApp](Remove-AzureRmIotCentralApp.md) -Deletes an IoT Central Application. - -### [Set-AzureRmIotCentralApp](Set-AzureRmIotCentralApp.md) -Updates the metadata for an IoT Central Application. - diff --git a/azurermps-6.13.0/AzureRM.IotCentral/Get-AzureRmIotCentralApp.md b/azurermps-6.13.0/AzureRM.IotCentral/Get-AzureRmIotCentralApp.md deleted file mode 100644 index d5bc3484b4..0000000000 --- a/azurermps-6.13.0/AzureRM.IotCentral/Get-AzureRmIotCentralApp.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotCentral.dll-Help.xml -Module Name: AzureRM.IotCentral -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iotcentral/get-azurermiotcentralapp -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotCentral/Commands.IotCentral/help/Get-AzureRmIotCentralApp.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotCentral/Commands.IotCentral/help/Get-AzureRmIotCentralApp.md ---- - -# Get-AzureRmIotCentralApp - -## SYNOPSIS -Gets properties for either one or several IoT Central Applications. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ListIotCentralAppsParameterSet (Default) -``` -Get-AzureRmIotCentralApp [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### InteractiveIotCentralParameterSet -``` -Get-AzureRmIotCentralApp [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Get-AzureRmIotCentralApp -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Gets the metadata for either a specific IoT Central Application, or all the applications in a Resource Group or Subscription, depending on Parameter Set. - -## EXAMPLES - -### Example 1 Get Specific IoT Central Application. -```powershell -PS C:\> Get-AzureRmIotCentralApp -ResourceGroupName "MyResourceGroupName" -Name "MyAppResourceName" -``` - -Gets the metadata for the specified IoT Central Application. - -Example Output: - -ResourceId : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroupName/providers/Microsoft - .IoTCentral/IoTApps/MyAppResourceName -Name : MyAppResourceName -Type : Microsoft.IoTCentral/IoTApps -Location : westus -Tag : {[key, val]} -Sku : Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralAppSkuInfo -ApplicationId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX -DisplayName : My Custom Display Name -Subdomain : MyAppSubdomain -Template : iotc-default@1.0.0 -SubscriptionId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX -ResourceGroupName : MyResourceGroupName - -### Example 2 Get IoT Central Applications in Subscription. -```powershell -PS C:\> Get-AzureRmIotCentralApp -``` - -Gets the metadata for all the IoT Central Applications in the current Subscription. - -Example Output: - -ResourceId : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroupName/providers/Microsoft - .IoTCentral/IoTApps/MyAppResourceName -Name : MyAppResourceName -Type : Microsoft.IoTCentral/IoTApps -Location : westus -Tag : {[key, val]} -Sku : Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralAppSkuInfo -ApplicationId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX -DisplayName : My Custom Display Name -Subdomain : MyAppSubdomain -Template : iotc-default@1.0.0 -SubscriptionId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX -ResourceGroupName : MyResourceGroupName - -ResourceId : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroupName2/providers/Microsoft - .IoTCentral/IoTApps/MyAppResourceName2 -Name : MyAppResourceName2 -Type : Microsoft.IoTCentral/IoTApps -Location : westus -Tag : {[key, val]} -Sku : Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralAppSkuInfo -ApplicationId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX -DisplayName : My Custom Display Name 2 -Subdomain : MyAppSubdomain2 -Template : iotc-default@1.0.0 -SubscriptionId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX -ResourceGroupName : MyResourceGroupName2 - -### Example 3 Get IoT Central Applications in Resource Group. -```powershell -PS C:\> Get-AzureRmIotCentralApp -ResourceGroupName "MyResourceGroupName" -``` - -Gets the metadata for all IoT Central Applications in the provided Resource Group. - -Example Output: - -ResourceId : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroupName/providers/Microsoft - .IoTCentral/IoTApps/MyAppResourceName -Name : MyAppResourceName -Type : Microsoft.IoTCentral/IoTApps -Location : westus -Tag : {[key, val]} -Sku : Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralAppSkuInfo -ApplicationId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX -DisplayName : My Custom Display Name -Subdomain : MyAppSubdomain -Template : iotc-default@1.0.0 -SubscriptionId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX -ResourceGroupName : MyResourceGroupName - -ResourceId : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroupName/providers/Microsoft - .IoTCentral/IoTApps/MyAppResourceName2 -Name : MyAppResourceName2 -Type : Microsoft.IoTCentral/IoTApps -Location : westus -Tag : {[key, val]} -Sku : Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralAppSkuInfo -ApplicationId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX -DisplayName : My Custom Display Name 2 -Subdomain : MyAppSubdomain2 -Template : iotc-default@1.0.0 -SubscriptionId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX -ResourceGroupName : MyResourceGroupName - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the Iot Central Application Resource. - -```yaml -Type: String -Parameter Sets: InteractiveIotCentralParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group. - -```yaml -Type: String -Parameter Sets: ListIotCentralAppsParameterSet -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: InteractiveIotCentralParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Iot Central Application Resource Id. - -```yaml -Type: String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -## OUTPUTS - -### Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralApp -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.IotCentral/New-AzureRmIotCentralApp.md b/azurermps-6.13.0/AzureRM.IotCentral/New-AzureRmIotCentralApp.md deleted file mode 100644 index 32b673549f..0000000000 --- a/azurermps-6.13.0/AzureRM.IotCentral/New-AzureRmIotCentralApp.md +++ /dev/null @@ -1,277 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotCentral.dll-Help.xml -Module Name: AzureRM.IotCentral -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iotcentral/new-azurermiotcentralapp -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotCentral/Commands.IotCentral/help/New-AzureRmIotCentralApp.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotCentral/Commands.IotCentral/help/New-AzureRmIotCentralApp.md ---- - -# New-AzureRmIotCentralApp - -## SYNOPSIS -Creates a new IoT Central Application. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmIotCentralApp [-Subdomain] <String> [-DisplayName <String>] [-Template <String>] [-Sku <String>] - [-Location <String>] [-Tag <Hashtable>] [-AsJob] [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Creates a new IoT Central Application with the provided properties and metadata. For an introduction to IoT Central, see https://docs.microsoft.com/en-us/azure/iot-central/. - -## EXAMPLES - -### Example 1 Create simple IoT Central Application. -```powershell -PS C:\> New-AzureRmIotCentralApp -ResourceGroupName "MyResourceGroupName" -Name "MyAppResourceName" -Subdomain "MyAppSubdomain" -``` - -Example Output: - -ResourceId : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroupName/providers/Microsoft - .IoTCentral/IoTApps/MyAppResourceName -Name : MyAppResourceName -Type : Microsoft.IoTCentral/IoTApps -Location : westus -Tag : -Sku : Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralAppSkuInfo -ApplicationId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX -DisplayName : MyAppResourceName -Subdomain : MyAppSubdomain -Template : iotc-default@1.0.0 -SubscriptionId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX -ResourceGroupName : MyResourceGroupName - -Create an IoT Central application in the standard pricing tier S1, in the region of the resource group. - -### Example 2 Create simple IoT Central Application. -```powershell -PS C:\> New-AzureRmIotCentralApp -ResourceGroupName "MyResourceGroupName" -Name "MyAppResourceName" -Subdomain "MyAppSubdomain" -Sku "S1" -DisplayName "My Custom Display Name" -Template "iotc-default" -Location "westus" -``` - -Example Output: - -ResourceId : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroupName/providers/Microsoft - .IoTCentral/IoTApps/MyAppResourceName -Name : MyAppResourceName -Type : Microsoft.IoTCentral/IoTApps -Location : westus -Tag : -Sku : Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralAppSkuInfo -ApplicationId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX -DisplayName : My Custom Display Name -Subdomain : MyAppSubdomain -Template : iotc-default@1.0.0 -SubscriptionId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX -ResourceGroupName : MyResourceGroupName - -Create an IoT Central application with the standard pricing tier S1 in the 'westus' region, with a custom display name, based on the iotc-default template. - -## PARAMETERS - -### -AsJob -Run cmdlet as a job in the background. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Custom display name for the IoT Central application. -Default is resource name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Location of your IoT Central application. -Default is the location of target resource group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Name of the Iot Central Application Resource. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sku -Pricing tier for IoT Central applications. -Default value is S1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: S1 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Subdomain -Subdomain for the IoT Central URL. -Each application must have a unique subdomain. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Iot Central Application Resource Tags. - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Template -IoT Central application template name. -Default is a custom application. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -### System.Collections.Hashtable -## OUTPUTS - -### Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralApp -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.IotCentral/Remove-AzureRmIotCentralApp.md b/azurermps-6.13.0/AzureRM.IotCentral/Remove-AzureRmIotCentralApp.md deleted file mode 100644 index beb42e9084..0000000000 --- a/azurermps-6.13.0/AzureRM.IotCentral/Remove-AzureRmIotCentralApp.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotCentral.dll-Help.xml -Module Name: AzureRM.IotCentral -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iotcentral/remove-azurermiotcentralapp -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotCentral/Commands.IotCentral/help/Remove-AzureRmIotCentralApp.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotCentral/Commands.IotCentral/help/Remove-AzureRmIotCentralApp.md ---- - -# Remove-AzureRmIotCentralApp - -## SYNOPSIS -Deletes an IoT Central Application. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceIdParameterSet (Default) -``` -Remove-AzureRmIotCentralApp [-PassThru] -ResourceId <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectParameterSet -``` -Remove-AzureRmIotCentralApp [-PassThru] -InputObject <PSIotCentralApp> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InteractiveIotCentralParameterSet -``` -Remove-AzureRmIotCentralApp [-PassThru] [-AsJob] [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Deletes an existing IoT Central Application. - -## EXAMPLES - -### Example 1 Delete and IoT Central Application -```powershell -PS C:\> Remove-AzureRmIotCentralApp -ResourceGroupName "MyResourceGroupName" -Name "MyAppResourceName" -``` - -Deletes the provided IoT Central Application. - -## PARAMETERS - -### -AsJob -Run cmdlet as a job in the background. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Iot Central Application Input Object. - -```yaml -Type: PSIotCentralApp -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the Iot Central Application Resource. - -```yaml -Type: String -Parameter Sets: InteractiveIotCentralParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group. - -```yaml -Type: String -Parameter Sets: InteractiveIotCentralParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Iot Central Application Resource Id. - -```yaml -Type: String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -### Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralApp -## OUTPUTS - -### System.Boolean -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.IotCentral/Set-AzureRmIotCentralApp.md b/azurermps-6.13.0/AzureRM.IotCentral/Set-AzureRmIotCentralApp.md deleted file mode 100644 index f275c0e946..0000000000 --- a/azurermps-6.13.0/AzureRM.IotCentral/Set-AzureRmIotCentralApp.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotCentral.dll-Help.xml -Module Name: AzureRM.IotCentral -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iotcentral/set-azurermiotcentralapp -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotCentral/Commands.IotCentral/help/Set-AzureRmIotCentralApp.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotCentral/Commands.IotCentral/help/Set-AzureRmIotCentralApp.md ---- - -# Set-AzureRmIotCentralApp - -## SYNOPSIS -Updates the metadata for an IoT Central Application. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceIdParameterSet (Default) -``` -Set-AzureRmIotCentralApp [-DisplayName <String>] [-Tag <Hashtable>] -ResourceId <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectParameterSet -``` -Set-AzureRmIotCentralApp [-DisplayName <String>] [-Tag <Hashtable>] -InputObject <PSIotCentralApp> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InteractiveIotCentralParameterSet -``` -Set-AzureRmIotCentralApp [-DisplayName <String>] [-Tag <Hashtable>] [-AsJob] [-ResourceGroupName] <String> - [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Update the metadata for an IoT Central Application. - -## EXAMPLES - -### Example 1 Update Display Name -```powershell -PS C:\> Set-AzureRmIotCentralApp -ResourceGroupName "MyResourceGroupName" -Name "MyAppResourceName" -DisplayName "My New Custom Display Name" -``` - -Update the Display name on an existing IoT Central Application. - -Example Output: - -ResourceId : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroupName/providers/Microsoft - .IoTCentral/IoTApps/MyAppResourceName -Name : MyAppResourceName -Type : Microsoft.IoTCentral/IoTApps -Location : westus -Tag : -Sku : Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralAppSkuInfo -ApplicationId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX -DisplayName : My New Custom Display Name -Subdomain : MyAppSubdomain -Template : iotc-default@1.0.0 -SubscriptionId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX -ResourceGroupName : MyResourceGroupName - -## PARAMETERS - -### -AsJob -Run cmdlet as a job in the background. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Custom Display Name of the Iot Central Application. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Iot Central Application Input Object. - -```yaml -Type: PSIotCentralApp -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the Iot Central Application Resource. - -```yaml -Type: String -Parameter Sets: InteractiveIotCentralParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group. - -```yaml -Type: String -Parameter Sets: InteractiveIotCentralParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Iot Central Application Resource Id. - -```yaml -Type: String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Iot Central Application Resource Tags. - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -### System.Collections.Hashtable -### Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralApp -## OUTPUTS - -### Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralApp -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.IotHub/Add-AzureRmIotHubCertificate.md b/azurermps-6.13.0/AzureRM.IotHub/Add-AzureRmIotHubCertificate.md deleted file mode 100644 index aadfdada94..0000000000 --- a/azurermps-6.13.0/AzureRM.IotHub/Add-AzureRmIotHubCertificate.md +++ /dev/null @@ -1,249 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml -Module Name: AzureRM.IotHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iothub/add-azurermiothubcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Add-AzureRmIotHubCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Add-AzureRmIotHubCertificate.md ---- - -# Add-AzureRmIotHubCertificate - -## SYNOPSIS -Create/update an Azure IoT Hub certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceSet (Default) -``` -Add-AzureRmIotHubCertificate [-ResourceGroupName] <String> [-Name] <String> [-CertificateName] <String> - [-Path] <String> [-Etag <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### InputObjectSet -``` -Add-AzureRmIotHubCertificate [-InputObject] <PSCertificateDescription> [-Path] <String> [-Etag <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdSet -``` -Add-AzureRmIotHubCertificate [-ResourceId] <String> [-Path] <String> [-Etag <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Uploads a new certificate or to replace the existing certificate with the same name. -For a detailed explanation of CA certificates in Azure IoT Hub, see https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-x509ca-overview - -## EXAMPLES - -### Example 1 -``` -PS C:\> Add-AzureRmIotHubCertificate -ResourceGroupName "myresourcegroup" -Name "myiothub" -CertificateName "mycertificate" -Path "c:\mycertificate.cer" - -Id : /subscriptions/377cxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Devices/IotHubs/myiothub/certificates/mycertificate -ResourceGroupName : myresourcegroup -Name : myiothub -CertificateName : mycertificate -Subject : CN=mycertificate -Thumbprint : 38303FC7371EC78DDE3E18D712C8414EE50969C7 -Status : Unverified -Expiry : 1/01/2027 16:01 -Created : 1/01/2017 16:01 -Etag : AAAAAAFpGcA= -``` - -Uploads a CA certificate CER file to an IoT hub. - -### Example 2 -``` -PS C:\> Add-AzureRmIotHubCertificate -ResourceGroupName "myresourcegroup" -Name "myiothub" -CertificateName "mycertificate" -Path "c:\mycertificate.cer" -Etag "AAAAAAFPazE=" - -Id : /subscriptions/377cxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Devices/IotHubs/myiothub/certificates/mycertificate -ResourceGroupName : myresourcegroup -Name : myiothub -CertificateName : mycertificate -Subject : CN=mycertificate -Thumbprint : 38303FC7371EC13DDE3E18D712C8414EE50969C7 -Status : Unverified -Expiry : 1/01/2027 16:01 -Created : 1/01/2017 16:01 -Etag : AAAAAAFpObE= -``` - -Updates a CA certificate in an IoT hub by uploading a new CER file. - -## PARAMETERS - -### -CertificateName -Name of the Certificate - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Etag -Etag of the Certificate - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Certificate Object - -```yaml -Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSCertificateDescription -Parameter Sets: InputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the Iot Hub - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -base-64 representation of X509 certificate .cer file or .pem file path. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Certificate Resource Id - -```yaml -Type: System.String -Parameter Sets: ResourceIdSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSCertificateDescription -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSCertificateDescription - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.IotHub/Add-AzureRmIotHubEventHubConsumerGroup.md b/azurermps-6.13.0/AzureRM.IotHub/Add-AzureRmIotHubEventHubConsumerGroup.md deleted file mode 100644 index 4565e32c5c..0000000000 --- a/azurermps-6.13.0/AzureRM.IotHub/Add-AzureRmIotHubEventHubConsumerGroup.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml -Module Name: AzureRM.IotHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iothub/add-azurermiothubeventhubconsumergroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Add-AzureRmIotHubEventHubConsumerGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Add-AzureRmIotHubEventHubConsumerGroup.md ---- - -# Add-AzureRmIotHubEventHubConsumerGroup - -## SYNOPSIS -Creates an eventhub consumer group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmIotHubEventHubConsumerGroup [-ResourceGroupName] <String> [-Name] <String> - [-EventHubEndpointName] <String> [-EventHubConsumerGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Creates a consumer group in the Eventhub associated with the specified IotHub. - -## EXAMPLES - -### Example 1: Add a consumer group to the telemetry eventhub -``` -PS C:\> Add-AzureRmIotHubEventHubConsumerGroup -ResourceGroupName "myresourcegroup" -Name "myiothub" -EventHubEndpointName "events" -EventHubConsumerGroupName "myconsumergroup" -``` - -Adds a new consumergroup named "myconsumergroup" to the eventhub for telemetry events in the iothub named "myiothub" - -### Example 2: Add a consumer group to the operations monitoring eventhub -``` -PS C:\> Add-AzureRmIotHubEventHubConsumerGroup -ResourceGroupName "myresourcegroup" -Name "myiothub" -EventHubEndpointName "operationsMonitoringEvents" -EventHubConsumerGroupName "myconsumergroup" -``` - -Adds a new consumergroup named "myconsumergroup" to the eventhub for operations monitoring events in the iothub named "myiothub" - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventHubConsumerGroupName -Name of the EventHub ConsumerGroup that you want to add. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventHubEndpointName -Name of the EventHub Endpoint. -Possible values events, operationsMonitoringEvents - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: events, operationsMonitoringEvents - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the Iot Hub - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.IotHub/Add-AzureRmIotHubKey.md b/azurermps-6.13.0/AzureRM.IotHub/Add-AzureRmIotHubKey.md deleted file mode 100644 index 6869e2e361..0000000000 --- a/azurermps-6.13.0/AzureRM.IotHub/Add-AzureRmIotHubKey.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml -Module Name: AzureRM.IotHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iothub/add-azurermiothubkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Add-AzureRmIotHubKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Add-AzureRmIotHubKey.md ---- - -# Add-AzureRmIotHubKey - -## SYNOPSIS -Creates an IotHub Key. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmIotHubKey [-ResourceGroupName] <String> [-Name] <String> [-KeyName] <String> [-PrimaryKey <String>] - [-SecondaryKey <String>] -Rights <PSAccessRights> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Creates a Key for the provided IotHub. -KeyNames are not unique and need to be managed carefully. - -## EXAMPLES - -### Example 1 Add a Key to an IotHub -``` -PS C:\> Add-AzureRmIotHubKey -ResourceGroupName "myresourcegroup" -Name "myiothub" -KeyName "newkey" -PrimaryKey "primarykey" -SecondaryKey "secondarykey" -Rights RegistryRead -``` - -Creates a key named "mykey" for the iothub "myiothub" with RegistryRead permissions. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyName -Name of the Key - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the IotHub - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PrimaryKey -The primary key - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Rights -The permissions for this IOTHub - -```yaml -Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSAccessRights -Parameter Sets: (All) -Aliases: -Accepted values: RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecondaryKey -The Secondary Key - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSSharedAccessSignatureAuthorizationRule - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.IotHub/Add-AzureRmIotHubRoute.md b/azurermps-6.13.0/AzureRM.IotHub/Add-AzureRmIotHubRoute.md deleted file mode 100644 index 946fc9c628..0000000000 --- a/azurermps-6.13.0/AzureRM.IotHub/Add-AzureRmIotHubRoute.md +++ /dev/null @@ -1,256 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml -Module Name: AzureRM.IotHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iothub/add-azurermiothubroute -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Add-AzureRmIotHubRoute.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Add-AzureRmIotHubRoute.md ---- - -# Add-AzureRmIotHubRoute - -## SYNOPSIS -Create a route in IoT Hub - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceSet (Default) -``` -Add-AzureRmIotHubRoute [-ResourceGroupName] <String> [-Name] <String> [-RouteName] <String> - [-Source] <PSRoutingSource> [-EndpointName] <String> [-Condition <String>] [-Enabled] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectSet -``` -Add-AzureRmIotHubRoute [-InputObject] <PSIotHub> [-RouteName] <String> [-Source] <PSRoutingSource> - [-EndpointName] <String> [-Condition <String>] [-Enabled] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ResourceIdSet -``` -Add-AzureRmIotHubRoute [-ResourceId] <String> [-RouteName] <String> [-Source] <PSRoutingSource> - [-EndpointName] <String> [-Condition <String>] [-Enabled] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Create a route to send specific data source and condition to a desired endpoint. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Add-AzureRmIotHubRoute -ResourceGroupName "myresourcegroup" -Name "myiothub" -RouteName R1 -Source DeviceMessages -EndpointName E1 - -RouteName : R1 -DataSource : DeviceMessages -EndpointNames : E1 -Condition : -IsEnabled : False -``` - -Create a new route "R1". - -## PARAMETERS - -### -Condition -Condition that is evaluated to apply the routing rule - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Enable route - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndpointName -Name of the routing endpoint - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -IotHub Object - -```yaml -Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub -Parameter Sets: InputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the Iot Hub - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -IotHub Resource Id - -```yaml -Type: System.String -Parameter Sets: ResourceIdSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RouteName -Name of the Route - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Source -Source of the route - -```yaml -Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingSource -Parameter Sets: (All) -Aliases: -Accepted values: Invalid, DeviceMessages, TwinChangeEvents, DeviceLifecycleEvents, DeviceJobLifecycleEvents - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub -System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSRouteMetadata - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.IotHub/Add-AzureRmIotHubRoutingEndpoint.md b/azurermps-6.13.0/AzureRM.IotHub/Add-AzureRmIotHubRoutingEndpoint.md deleted file mode 100644 index f5c3b1ffab..0000000000 --- a/azurermps-6.13.0/AzureRM.IotHub/Add-AzureRmIotHubRoutingEndpoint.md +++ /dev/null @@ -1,278 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml -Module Name: AzureRM.IotHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iothub/add-azurermiothubroutingendpoint -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Add-AzureRmIotHubRoutingEndpoint.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Add-AzureRmIotHubRoutingEndpoint.md ---- - -# Add-AzureRmIotHubRoutingEndpoint - -## SYNOPSIS -Add an endpoint to your IoT Hub - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceSet (Default) -``` -Add-AzureRmIotHubRoutingEndpoint [-ResourceGroupName] <String> [-Name] <String> [-EndpointName] <String> - [-EndpointType] <PSEndpointType> [-EndpointResourceGroup] <String> [-EndpointSubscriptionId] <String> - [-ConnectionString] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### InputObjectSet -``` -Add-AzureRmIotHubRoutingEndpoint [-InputObject] <PSIotHub> [-EndpointName] <String> - [-EndpointType] <PSEndpointType> [-EndpointResourceGroup] <String> [-EndpointSubscriptionId] <String> - [-ConnectionString] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ResourceIdSet -``` -Add-AzureRmIotHubRoutingEndpoint [-ResourceId] <String> [-EndpointName] <String> - [-EndpointType] <PSEndpointType> [-EndpointResourceGroup] <String> [-EndpointSubscriptionId] <String> - [-ConnectionString] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Add a new endpoint in your IoT Hub. To learn about the endpoints that are supported, see https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-endpoints - -## EXAMPLES - -### Example 1 -``` -PS C:\> Add-AzureRmIotHubRoutingEndpoint -ResourceGroupName "myresourcegroup" -Name "myiothub" -EndpointName E2 -EndpointType EventHub -EndpointResourceGroup resourcegroup1 -EndpointSubscriptionId 91d12343-a3de-345d-b2ea-135792468abc -ConnectionString 'Endpoint=sb://myeventhub1.servicebus.windows.net/;SharedAccessKeyName=access1;SharedAccessKey=*****=;EntityPath=event11' - -ResourceGroupName : resourcegroup1 -SubscriptionId : 91d12343-a3de-345d-b2ea-135792468abc -EndpointName : E2 -ConnectionString : Endpoint=sb://myeventhub1.servicebus.windows.net:5671/;SharedAccessKeyName=iothubroutes_myeventhub1;SharedAccessKey=****;EntityPath=event1 -``` - -Add a new endpoint "E2" of type EventHub to an "myiothub" IoT Hub. - -### Example 2 -``` -PS C:\> Add-AzureRmIotHubRoutingEndpoint -ResourceGroupName "myresourcegroup" -Name "myiothub" -EndpointName S1 -EndpointType AzureStorageContainer -EndpointResourceGroup resourcegroup1 -EndpointSubscriptionId 91d12343-a3de-345d-b2ea-135792468abc -ConnectionString 'DefaultEndpointsProtocol=https;AccountName=mystorage1;AccountKey=*****;EndpointSuffix=core.windows.net' -ContainerName container - -ResourceGroupName : resourcegroup1 -SubscriptionId : 91d12343-a3de-345d-b2ea-135792468abc -EndpointName : S1 -ContainerName : container -ConnectionString : DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=mystorage1;AccountKey=**** -FileNameFormat : {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm} -BatchFrequencyInSeconds : 300 -MaxChunkSizeInBytes : 314572800 -Encoding : avro -``` - -Add a new endpoint "S1" of type AzureStorageContainer to an "myiothub" IoT Hub. - -## PARAMETERS - -### -ConnectionString -Connection string of the Routing Endpoint - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndpointName -Name of the Routing Endpoint - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndpointResourceGroup -Resource group of the Endpoint resoure - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndpointSubscriptionId -SubscriptionId of the Endpoint resource - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndpointType -Type of the Routing Endpoint - -```yaml -Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSEndpointType -Parameter Sets: (All) -Aliases: -Accepted values: EventHub, ServiceBusQueue, ServiceBusTopic, AzureStorageContainer - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -IotHub Object - -```yaml -Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub -Parameter Sets: InputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the Iot Hub - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -IotHub Resource Id - -```yaml -Type: System.String -Parameter Sets: ResourceIdSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub -System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingEventHubEndpoint -Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingServiceBusQueueEndpoint -Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingServiceBusTopicEndpoint -Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingStorageContainerEndpoint - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.IotHub/AzureRM.IotHub.md b/azurermps-6.13.0/AzureRM.IotHub/AzureRM.IotHub.md deleted file mode 100644 index fe7cf8a595..0000000000 --- a/azurermps-6.13.0/AzureRM.IotHub/AzureRM.IotHub.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -Module Name: AzureRM.IotHub -Module Guid: 51a3a993-fe39-4f8f-a437-2cb751584af5 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.iothub -Help Version: 3.1.2.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/AzureRM.IotHub.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/AzureRM.IotHub.md ---- - -# AzureRM.IotHub Module -## Description -Commands for Managing Azure IotHubs - -## AzureRM.IotHub Cmdlets -### [Add-AzureRmIotHubCertificate](Add-AzureRmIotHubCertificate.md) -Create/update an Azure IoT Hub certificate. - -### [Add-AzureRmIotHubEventHubConsumerGroup](Add-AzureRmIotHubEventHubConsumerGroup.md) -Creates an eventhub consumer group. - -### [Add-AzureRmIotHubKey](Add-AzureRmIotHubKey.md) -Creates an IotHub Key. - -### [Add-AzureRmIotHubRoute](Add-AzureRmIotHubRoute.md) -Create a route in IoT Hub - -### [Add-AzureRmIotHubRoutingEndpoint](Add-AzureRmIotHubRoutingEndpoint.md) -Add an endpoint to your IoT Hub - -### [Get-AzureRmIotHub](Get-AzureRmIotHub.md) -Gets information about the IotHubs in a subscription. - -### [Get-AzureRmIotHubCertificate](Get-AzureRmIotHubCertificate.md) -Lists all certificates or a particular certificate contained within an Azure IoT Hub. - -### [Get-AzureRmIotHubCertificateVerificationCode](Get-AzureRmIotHubCertificateVerificationCode.md) -Generates a verification code for an Azure IoT Hub certificate. - -### [Get-AzureRmIotHubConnectionString](Get-AzureRmIotHubConnectionString.md) -Gets the IotHub connectionstrings. - -### [Get-AzureRmIotHubEventHubConsumerGroup](Get-AzureRmIotHubEventHubConsumerGroup.md) -Gets all the eventhub consumergroups. - -### [Get-AzureRmIotHubJob](Get-AzureRmIotHubJob.md) -Gets the information about an IotHub job. - -### [Get-AzureRmIotHubKey](Get-AzureRmIotHubKey.md) -Gets an IotHub Key. - -### [Get-AzureRmIotHubQuotaMetric](Get-AzureRmIotHubQuotaMetric.md) -Gets the Quota Metrics for an IotHub. - -### [Get-AzureRmIotHubRegistryStatistic](Get-AzureRmIotHubRegistryStatistic.md) -Gets the RegistryStatistics for an IotHub. - -### [Get-AzureRmIotHubRoute](Get-AzureRmIotHubRoute.md) -Get information about the route in IoT Hub - -### [Get-AzureRmIotHubRoutingEndpoint](Get-AzureRmIotHubRoutingEndpoint.md) -Get information on all the endpoints for your IoT Hub - -### [Get-AzureRmIotHubValidSku](Get-AzureRmIotHubValidSku.md) -Gets all valid skus that this IotHub can transition to. - -### [New-AzureRmIotHub](New-AzureRmIotHub.md) -Creates a new IotHub. - -### [New-AzureRmIotHubExportDevices](New-AzureRmIotHubExportDevices.md) -Creates a new export devices job. - -### [New-AzureRmIotHubImportDevices](New-AzureRmIotHubImportDevices.md) -Creates a new import devices job. - -### [Remove-AzureRmIotHub](Remove-AzureRmIotHub.md) -Deletes an IotHub. - -### [Remove-AzureRmIotHubCertificate](Remove-AzureRmIotHubCertificate.md) -Deletes an Azure IoT Hub certificate. - -### [Remove-AzureRmIotHubEventHubConsumerGroup](Remove-AzureRmIotHubEventHubConsumerGroup.md) -Deletes an eventhub consumergroup. - -### [Remove-AzureRmIotHubKey](Remove-AzureRmIotHubKey.md) -Removes an IotHub Key. - -### [Remove-AzureRmIotHubRoute](Remove-AzureRmIotHubRoute.md) -Delete a route in IoT Hub - -### [Remove-AzureRmIotHubRoutingEndpoint](Remove-AzureRmIotHubRoutingEndpoint.md) -Delete an endpoint for your IoT Hub - -### [Set-AzureRmIotHub](Set-AzureRmIotHub.md) -Updates the properties of an IotHub. - -### [Set-AzureRmIotHubRoute](Set-AzureRmIotHubRoute.md) -Update a route in IoT Hub - -### [Set-AzureRmIotHubVerifiedCertificate](Set-AzureRmIotHubVerifiedCertificate.md) -Verifies an Azure IoT Hub certificate. - -### [Test-AzureRmIotHubRoute](Test-AzureRmIotHubRoute.md) -Test routes in IoT Hub - -### [Update-AzureRmIotHub](Update-AzureRmIotHub.md) -Update an Azure IoT Hub. - diff --git a/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHub.md b/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHub.md deleted file mode 100644 index 4a3c38b8f1..0000000000 --- a/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHub.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml -Module Name: AzureRM.IotHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iothub/get-azurermiothub -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHub.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHub.md ---- - -# Get-AzureRmIotHub - -## SYNOPSIS -Gets information about the IotHubs in a subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ListIotHubsByResourceGroup (Default) -``` -Get-AzureRmIotHub [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### GetIotHubByName -``` -Get-AzureRmIotHub [-ResourceGroupName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -Gets information about the IotHubs in a subscription. -You can view all IotHub instances in a subscription, or filter your results by a resource group or a particular IotHub Name. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmIotHub -``` - -Gets all the IotHubs in the subscription. - -### Example 2 -``` -PS C:\> Get-AzureRmIotHub -ResourceGroupName "myresourcegroup" -``` - -Gets all the IotHubs in the subscription belonging to the resourcegroup named "myresourcegroup". - -### Example 3 -``` -PS C:\> Get-AzureRmIotHub -ResourceGroupName "myresourcegroup" -Name "myiothub" -``` - -Gets information about the IotHub named "myiothub". - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the IotHub - -```yaml -Type: System.String -Parameter Sets: GetIotHubByName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the ResourceGroup - -```yaml -Type: System.String -Parameter Sets: ListIotHubsByResourceGroup -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: GetIotHubByName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubCertificate.md b/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubCertificate.md deleted file mode 100644 index 1ca106f7e0..0000000000 --- a/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubCertificate.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml -Module Name: AzureRM.IotHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iothub/get-azurermiothubcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubCertificate.md ---- - -# Get-AzureRmIotHubCertificate - -## SYNOPSIS -Lists all certificates or a particular certificate contained within an Azure IoT Hub. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceSet (Default) -``` -Get-AzureRmIotHubCertificate [-ResourceGroupName] <String> [-Name] <String> [-CertificateName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### InputObjectSet -``` -Get-AzureRmIotHubCertificate [-InputObject] <PSIotHub> [-CertificateName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceIdSet -``` -Get-AzureRmIotHubCertificate [-ResourceId] <String> [-CertificateName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -For a detailed explanation of CA certificates in Azure IoT Hub, see https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-x509ca-overview - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmIotHubCertificate -ResourceGroupName "myresourcegroup" -Name "myiothub" - -ResourceGroupName Name CertificateName Status Expiry ------------------ ---- --------------- ------ ------ -myresourcegroup myiothub3 mycert1 Unverified 12/04/2027 13:12 -myresourcegroup myiothub mycert2 Unverified 12/04/2027 13:12 -``` - -List all certificates in MyIotHub - -### Example 2 -``` -PS C:\> Get-AzureRmIotHubCertificate -ResourceGroupName "myresourcegroup" -Name "myiothub" -CertificateName "mycertificate" - -Id : /subscriptions/377cxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Devices/IotHubs/myiothub/certificates/mycertificate -ResourceGroupName : myresourcegroup -Name : myiothub -CertificateName : mycertificate -Subject : CN=mycertificate -Thumbprint : 38303FC7371EC13DDE3E18D712C8414EE50969C7 -Status : Unverified -Expiry : 1/01/2027 16:01 -Created : 1/01/2017 16:01 -Etag : AAAAAAFpObE= -``` - -Show details about MyCertificate - -## PARAMETERS - -### -CertificateName -Name of the Certificate - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -IotHub Object - -```yaml -Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub -Parameter Sets: InputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the Iot Hub - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -IotHub Resource Id - -```yaml -Type: System.String -Parameter Sets: ResourceIdSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSCertificateDescription - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubCertificateVerificationCode.md b/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubCertificateVerificationCode.md deleted file mode 100644 index 32d7f37f87..0000000000 --- a/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubCertificateVerificationCode.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml -Module Name: AzureRM.IotHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iothub/get-azurermiothubcertificateverificationcode -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubCertificateVerificationCode.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubCertificateVerificationCode.md ---- - -# Get-AzureRmIotHubCertificateVerificationCode - -## SYNOPSIS -Generates a verification code for an Azure IoT Hub certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceSet (Default) -``` -Get-AzureRmIotHubCertificateVerificationCode [-ResourceGroupName] <String> [-Name] <String> - [-CertificateName] <String> [-Etag] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### InputObjectSet -``` -Get-AzureRmIotHubCertificateVerificationCode [-InputObject] <PSCertificateDescription> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceIdSet -``` -Get-AzureRmIotHubCertificateVerificationCode [-ResourceId] <String> [-Etag] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -This verification code is used to complete the proof of possession step for a certificate. Use this verification code as the CN of a new certificate signed with the root certificates private key. -For a detailed explanation of CA certificates in Azure IoT Hub, see https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-x509ca-overview - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmIotHubCertificateVerificationCode -ResourceGroupName "myresourcegroup" -Name "myiothub" -CertificateName "mycertificate" -Etag "AAAAAAFPazE=" - -Id : /subscriptions/377cxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Devices/IotHubs/myiothub/certificates/mycertificate -ResourceGroupName : myresourcegroup -Name : myiothub -CertificateName : mycertificate -Subject : CN=mycertificate -Thumbprint : 38303FC7371EC13DDE3E18D712C8414EE50969C7 -VerificationCode : 47292AB6260DB02CCD2D07C601B7303DD49858B6 -Status : Unverified -Expiry : 1/01/2027 16:01 -Created : 1/01/2017 16:01 -Etag : AAAAAAFpObE= -``` - -Generates a verification code for MyCertificate - -## PARAMETERS - -### -CertificateName -Name of the Certificate - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Etag -Etag of the Certificate - -```yaml -Type: System.String -Parameter Sets: ResourceSet, ResourceIdSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Certificate Object - -```yaml -Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSCertificateDescription -Parameter Sets: InputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the Iot Hub - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Certificate Resource Id - -```yaml -Type: System.String -Parameter Sets: ResourceIdSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSCertificateDescription -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSCertificateWithNonceDescription - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubConnectionString.md b/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubConnectionString.md deleted file mode 100644 index 205d50aa4c..0000000000 --- a/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubConnectionString.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml -Module Name: AzureRM.IotHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iothub/get-azurermiothubconnectionstring -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubConnectionString.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubConnectionString.md ---- - -# Get-AzureRmIotHubConnectionString - -## SYNOPSIS -Gets the IotHub connectionstrings. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmIotHubConnectionString [-ResourceGroupName] <String> [-Name] <String> [[-KeyName] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Gets the IotHub connectionstrings. -You can either get connectionstrings for all the keys or filter them by a specific key name. - -## EXAMPLES - -### Example 1 Get All IotHub connectionstrings -``` -PS C:\> Get-AzureRmIotHubConnectionString -ResourceGroupName "myresourcegroup" -Name "myiothub" -``` - -Gets the connectionstrings for all keys for the iothub named "myiothub" - -### Example 2 Get the IotHub connectionstrings for a specific key -``` -PS C:\> Get-AzureRmIotHubConnectionString -ResourceGroupName "myresourcegroup" -Name "myiothub" -KeyName "mykey" -``` - -Gets the connectionstrings for the key named "mykey" for the iothub named "myiothub" - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyName -Name of the Key - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the IotHub - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSSharedAccessSignatureAuthorizationRule - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubEventHubConsumerGroup.md b/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubEventHubConsumerGroup.md deleted file mode 100644 index 0ef4dcfe04..0000000000 --- a/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubEventHubConsumerGroup.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml -Module Name: AzureRM.IotHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iothub/get-azurermiothubeventhubconsumergroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubEventHubConsumerGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubEventHubConsumerGroup.md ---- - -# Get-AzureRmIotHubEventHubConsumerGroup - -## SYNOPSIS -Gets all the eventhub consumergroups. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmIotHubEventHubConsumerGroup [-ResourceGroupName] <String> [-Name] <String> - [-EventHubEndpointName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Gets all the eventhub consumergroups for the different EventHubs used by IotHub. - -## EXAMPLES - -### Example 1 Gets all the eventhub consumergroups for the telemetry eventhub -``` -PS C:\> Get-AzureRmIotHubEventHubConsumerGroup -ResourceGroupName "myresourcegroup" -Name "myiothub" -EventHubEndpointName "events" -``` - -Gets all the eventhub consumergroups for the telemetry eventhub for the iothub named myiothub - -### Example 2 Gets all the eventhub consumergroups for the operationsmonitoring eventhub -``` -PS C:\> Get-AzureRmIotHubEventHubConsumerGroup -ResourceGroupName "myresourcegroup" -Name "myiothub" -EventHubEndpointName "operationsMonitoringEvents" -``` - -Gets all the eventhub consumergroups for the operationsMonitoringEvents eventhub for the iothub named myiothub - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventHubEndpointName -Name of the Event Hub endpoint. -Possible values events, operationsMonitoringEvents - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: events, operationsMonitoringEvents - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Name of the IotHub - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSEventHubConsumerGroupInfo - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubJob.md b/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubJob.md deleted file mode 100644 index bdcfc32c9a..0000000000 --- a/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubJob.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml -Module Name: AzureRM.IotHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iothub/get-azurermiothubjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubJob.md ---- - -# Get-AzureRmIotHubJob - -## SYNOPSIS -Gets the information about an IotHub job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmIotHubJob [-ResourceGroupName] <String> [-Name] <String> [[-JobId] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Gets the information about an IotHub Job. -An IotHub Job gets created when an import or export operation is initialted using the New-AzureRmIotHubExportDevices or New-AzureRmIotHubImportDevices commands. -You can either list all the jobs or filter the jobs by the Job Identifier. - -## EXAMPLES - -### Example 1 List all Jobs -``` -PS C:\> Get-AzureRmIotHubJob -ResourceGroupName "myresourcegroup" -Name "myiothub" -``` - -Gets all the jobs for the IotHub named "myiothub" - -### Example 2 Get a specific Job -``` -PS C:\> Get-AzureRmIotHubJob -ResourceGroupName "myresourcegroup" -Name "myiothub" -JobId 3630fc31-4caa-43e8-a232-ea0577221cb2 -``` - -Gets information about the job with the identifier "3630fc31-4caa-43e8-a232-ea0577221cb2" for the IotHub named "myiothub" - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobId -The Job Identifier. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the IoT hub. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHubJobResponse - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubKey.md b/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubKey.md deleted file mode 100644 index 7cb21873ee..0000000000 --- a/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubKey.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml -Module Name: AzureRM.IotHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iothub/get-azurermiothubkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubKey.md ---- - -# Get-AzureRmIotHubKey - -## SYNOPSIS -Gets an IotHub Key. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmIotHubKey [-ResourceGroupName] <String> [-Name] <String> [[-KeyName] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Gets an IotHub Key. -You can either list all Keys or filter the list by a specific Key Name. - -## EXAMPLES - -### Example 1 Get all Keys -``` -PS C:\> Get-AzureRmIotHubKey -ResourceGroupName "myresourcegroup" -Name "myiothub" -``` - -Gets all the Keys for the IotHub named "myiothub" - -### Example 2 Get information for a specific Key -``` -PS C:\> Get-AzureRmIotHubKey -ResourceGroupName "myresourcegroup" -Name "myiothub" -KeyName "iothubowner" -``` - -Gets the information for a key named "iothubowner" for the IotHub named "myiothub" - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyName -Name of the Key - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the IoT hub. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSSharedAccessSignatureAuthorizationRule - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubQuotaMetric.md b/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubQuotaMetric.md deleted file mode 100644 index 1ef4e2df62..0000000000 --- a/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubQuotaMetric.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml -Module Name: AzureRM.IotHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iothub/get-azurermiothubquotametric -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubQuotaMetric.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubQuotaMetric.md ---- - -# Get-AzureRmIotHubQuotaMetric - -## SYNOPSIS -Gets the Quota Metrics for an IotHub. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmIotHubQuotaMetric [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Gets the Quota Metrics for an IotHub. - -## EXAMPLES - -### Example 1 Get the Quota Metrics -``` -PS C:\> Get-AzureRmIotHubQuotaMetric -ResourceGroupName "myresourcegroup" -Name "myiothub" -``` - -Gets the Quota Metric information for the IotHub named "myiothub" - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the IoT hub. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHubQuotaMetric - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubRegistryStatistic.md b/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubRegistryStatistic.md deleted file mode 100644 index 50c16f2970..0000000000 --- a/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubRegistryStatistic.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml -Module Name: AzureRM.IotHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iothub/get-azurermiothubregistrystatistic -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubRegistryStatistic.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubRegistryStatistic.md ---- - -# Get-AzureRmIotHubRegistryStatistic - -## SYNOPSIS -Gets the RegistryStatistics for an IotHub. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmIotHubRegistryStatistic [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Gets the RegistryStatistics for an IotHub. -This provides information about the number of total, enabled and disabled devices in an IotHub. - -## EXAMPLES - -### Example 1 Get the RegistryStatistics -``` -PS C:\> Get-AzureRmIotHubRegistryStatistic -ResourceGroupName "myresourcegroup" -Name "myiothub" -``` - -Gets the RegistryStatictics for the IotHub named "myiothub" - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the IoT hub. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHubRegistryStatistics - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubRoute.md b/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubRoute.md deleted file mode 100644 index cd2b08806f..0000000000 --- a/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubRoute.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml -Module Name: AzureRM.IotHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iothub/get-azurermiothubroute -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubRoute.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubRoute.md ---- - -# Get-AzureRmIotHubRoute - -## SYNOPSIS -Get information about the route in IoT Hub - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceSet (Default) -``` -Get-AzureRmIotHubRoute [-ResourceGroupName] <String> [-Name] <String> [-RouteName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### InputObjectSet -``` -Get-AzureRmIotHubRoute [-InputObject] <PSIotHub> [-RouteName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceIdSet -``` -Get-AzureRmIotHubRoute [-ResourceId] <String> [-RouteName <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -Get information on the route.You can get all routes from an IoT Hub, get routes to a type of endpoint or get routes to a specific endpoint. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmIotHubRoute -ResourceGroupName "myresourcegroup" -Name "myiothub" - -RouteName DataSource EndpointNames IsEnabled ---------- ---------- ------------- --------- -R1 DeviceMessages events False -R2 TwinChangeEvents E1 True -``` - -Get all route from "myiothub" IoT Hub. - -### Example 2 -``` -PS C:\> Get-AzureRmIotHubRoute -ResourceGroupName "myresourcegroup" -Name "myiothub" -RouteName R1 - -RouteName : R1 -DataSource : DeviceMessages -EndpointNames : events -Condition : true -IsEnabled : False -``` - -Get route information from "myiothub" IoT Hub. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -IotHub Object - -```yaml -Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub -Parameter Sets: InputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the Iot Hub - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -IotHub Resource Id - -```yaml -Type: System.String -Parameter Sets: ResourceIdSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RouteName -Name of the Route - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub -System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSRouteMetadata -System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Management.IotHub.Models.PSRouteProperties, Microsoft.Azure.Commands.IotHub, Version=3.1.3.0, Culture=neutral, PublicKeyToken=null]] - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubRoutingEndpoint.md b/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubRoutingEndpoint.md deleted file mode 100644 index f8e5ec89b0..0000000000 --- a/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubRoutingEndpoint.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml -Module Name: AzureRM.IotHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iothub/get-azurermiothubroutingendpoint -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubRoutingEndpoint.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubRoutingEndpoint.md ---- - -# Get-AzureRmIotHubRoutingEndpoint - -## SYNOPSIS -Get information on all the endpoints for your IoT Hub - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceSet (Default) -``` -Get-AzureRmIotHubRoutingEndpoint [-ResourceGroupName] <String> [-Name] <String> - [-EndpointType <PSEndpointType>] [-EndpointName <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### InputObjectSet -``` -Get-AzureRmIotHubRoutingEndpoint [-InputObject] <PSIotHub> [-EndpointType <PSEndpointType>] - [-EndpointName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceIdSet -``` -Get-AzureRmIotHubRoutingEndpoint [-ResourceId] <String> [-EndpointType <PSEndpointType>] - [-EndpointName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Get information on the endpoint. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmIotHubRoutingEndpoint -ResourceGroupName "myresourcegroup" -Name "myiothub" - -Name EndpointType AzureResource ----- ------------ ------------- -E1 EventHub resourcegroup1/event1 -E2 EventHub resourcegroup1/event2 -S1 AzureStorageContainer mystorage1/container -``` - -Get all the endpoints from "myiothub" IoT Hub. - -### Example 2 -``` -PS C:\> Get-AzureRmIotHubRoutingEndpoint -ResourceGroupName "myresourcegroup" -Name "myiothub" -EndpointType EventHub - -ResourceGroupName SubscriptionId EndpointName ------------------ -------------- ------------ -resourcegroup1 91d12343-a3de-345d-b2ea-135792468abc E1 -resourcegroup1 91d12343-a3de-345d-b2ea-135792468abc E2 -``` - -Get all the endpoints of type EventHub from "myiothub" IoT Hub. - -### Example 3 -``` -PS C:\> Get-AzureRmIotHubRoutingEndpoint -ResourceGroupName "myresourcegroup" -Name "myiothub" -EndpointType EventHub - -ResourceGroupName : resourcegroup1 -SubscriptionId : 91d12343-a3de-345d-b2ea-135792468abc -EndpointName : E1 -ConnectionString : Endpoint=sb://myeventhub1.servicebus.windows.net:5671/;SharedAccessKeyName=iothubroutes_myeventhub1;SharedAccessKey=****;EntityPath=event1 -``` - -Get all the endpoints of type EventHub from "myiothub" IoT Hub. - -### Example 4 -``` -PS C:\> Get-AzureRmIotHubRoutingEndpoint -ResourceGroupName "myresourcegroup" -Name "myiothub" -EndpointName E1 - -ResourceGroupName : resourcegroup1 -SubscriptionId : 91d12343-a3de-345d-b2ea-135792468abc -EndpointName : E1 -ConnectionString : Endpoint=sb://myeventhub1.servicebus.windows.net:5671/;SharedAccessKeyName=iothubroutes_myeventhub1;SharedAccessKey=****;EntityPath=event1 -``` - -Get an endpoint information from "myiothub" IoT Hub. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndpointName -Name of the Routing Endpoint - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndpointType -Type of the Routing Endpoint - -```yaml -Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSEndpointType -Parameter Sets: (All) -Aliases: -Accepted values: EventHub, ServiceBusQueue, ServiceBusTopic, AzureStorageContainer - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -IotHub Object - -```yaml -Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub -Parameter Sets: InputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the Iot Hub - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -IotHub Resource Id - -```yaml -Type: System.String -Parameter Sets: ResourceIdSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub -System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingEventHubEndpoint -System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingEventHubProperties, Microsoft.Azure.Commands.IotHub, Version=3.1.3.0, Culture=neutral, PublicKeyToken=null]] -Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingServiceBusQueueEndpoint -System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingServiceBusQueueEndpointProperties, Microsoft.Azure.Commands.IotHub, Version=3.1.3.0, Culture=neutral, PublicKeyToken=null]] -Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingServiceBusTopicEndpoint -System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingServiceBusTopicEndpointProperties, Microsoft.Azure.Commands.IotHub, Version=3.1.3.0, Culture=neutral, PublicKeyToken=null]] -Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingStorageContainerEndpoint -System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingStorageContainerProperties, Microsoft.Azure.Commands.IotHub, Version=3.1.3.0, Culture=neutral, PublicKeyToken=null]] -System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingCustomEndpoint, Microsoft.Azure.Commands.IotHub, Version=3.1.3.0, Culture=neutral, PublicKeyToken=null]] - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubValidSku.md b/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubValidSku.md deleted file mode 100644 index 7a5414aa70..0000000000 --- a/azurermps-6.13.0/AzureRM.IotHub/Get-AzureRmIotHubValidSku.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml -Module Name: AzureRM.IotHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iothub/get-azurermiothubvalidsku -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubValidSku.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubValidSku.md ---- - -# Get-AzureRmIotHubValidSku - -## SYNOPSIS -Gets all valid skus that this IotHub can transition to. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmIotHubValidSku [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Gets all the valid skus that this IotHub can transition to. -An IotHub cannot transition between free and the paid skus and vice versa. -You will have to delete and recreate the iothub if you want to achieve this. - -## EXAMPLES - -### Example 1 Get the valid skus -``` -PS C:\> Get-AzureRmIotHubValidSku -ResourceGroupName "myresourcegroup" -Name "myiothub" -``` - -Gets a list of all skus for the IotHub named "myiothub" - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the IoT hub. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHubSkuDescription - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.IotHub/New-AzureRmIotHub.md b/azurermps-6.13.0/AzureRM.IotHub/New-AzureRmIotHub.md deleted file mode 100644 index 7d412bf348..0000000000 --- a/azurermps-6.13.0/AzureRM.IotHub/New-AzureRmIotHub.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml -Module Name: AzureRM.IotHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iothub/new-azurermiothub -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/New-AzureRmIotHub.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/New-AzureRmIotHub.md ---- - -# New-AzureRmIotHub - -## SYNOPSIS -Creates a new IotHub. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmIotHub -ResourceGroupName <String> -Name <String> -SkuName <PSIotHubSku> -Units <Int64> - -Location <String> [-Properties <PSIotHubInputProperties>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Creates a new IotHub. -You can create the IotHub with either the default properties or specify the input proerties. - -## EXAMPLES - -### Example 1 Create a new IotHub with default properties -``` -PS C:\> New-AzureRmIotHub -ResourceGroupName "myresourcegroup" -Name "myiothub" -SkuName "S1" -Units 1 -Location "northeurope" -``` - -Creates a new IotHub named "myiothub" of the sku "S1", capacity 1 and location "northeurope". - -### Example 2 Create a new IotHub with the MaxDeliveryCount of the CloudtoDevice Queue set to 20 -``` -PS C:\> New-AzureRmIotHub -ResourceGroupName "myresourcegroup" -Name "myiothub" -SkuName "S1" -Units 1 -Location "northeurope" -Properties $properties -``` - -Creates a new IotHub named "myiothub" of the sku "S1", capacity 1 and location "northeurope" with advanced input properties represented by $properties. -$psCloudToDeviceProperties = New-Object Microsoft.Azure.Commands.Management.IotHub.Models.PSCloudToDeviceProperties -Property @{MaxDeliveryCount=20} $properties = New-Object Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHubInputProperties -Property @{CloudToDevice=$psCloudToDeviceProperties} New-AzureRmIotHub -ResourceGroupName "myresourcegroup" -Name "myiothub" -SkuName "S1" -Units 1 -Location "northeurope" -Properties $properties - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Location where the IoT hub needs to be created. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the IotHub - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Properties -Properties of the IoT hub. - -```yaml -Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHubInputProperties -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuName -Name of the sku - -```yaml -Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHubSku -Parameter Sets: (All) -Aliases: -Accepted values: F1, S1, S2, S3, B1, B2, B3 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Units -Number of units - -```yaml -Type: System.Int64 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.IotHub/New-AzureRmIotHubExportDevices.md b/azurermps-6.13.0/AzureRM.IotHub/New-AzureRmIotHubExportDevices.md deleted file mode 100644 index dc495e07fb..0000000000 --- a/azurermps-6.13.0/AzureRM.IotHub/New-AzureRmIotHubExportDevices.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml -Module Name: AzureRM.IotHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iothub/new-azurermiothubexportdevices -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/New-AzureRmIotHubExportDevices.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/New-AzureRmIotHubExportDevices.md ---- - -# New-AzureRmIotHubExportDevices - -## SYNOPSIS -Creates a new export devices job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmIotHubExportDevices [-ResourceGroupName] <String> [-Name] <String> - [-ExportBlobContainerUri] <String> [-ExcludeKeys] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Creates a new export devices job for the IotHub. -This will export all the devices to the specified container. -Refer to the following article on how to generate the SAS URI. -https://docs.microsoft.com/azure/iot-hub/iot-hub-bulk-identity-mgmt#get-the-container-sas-uri . - -## EXAMPLES - -### Example 1 Issue an export device request. -``` -PS C:\> New-AzureRmIotHubExportDevices -ResourceGroupName "myresourcegroup" -Name "myiothub" -ExportBlobContainerUri "https://mystorageaccount.blob.core.windows.net/mystoragecontainer?sv=2015-04-05&ss=bfqt&sr=c&srt=sco&sp=rwdl&se=2016-10-27T04:01:48Z&st=2016-10-26T20:01:48Z&spr=https&sig=QqpIhHsIMF8hNuFO%3D" -ExcludeKeys -``` - -Creates a new export device request for the IotHub "myiothub" excluding the keys. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeKeys -Allows to export devices without keys. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExportBlobContainerUri -The Uri to export the blob to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the IotHub - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHubJobResponse - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.IotHub/New-AzureRmIotHubImportDevices.md b/azurermps-6.13.0/AzureRM.IotHub/New-AzureRmIotHubImportDevices.md deleted file mode 100644 index e41a924212..0000000000 --- a/azurermps-6.13.0/AzureRM.IotHub/New-AzureRmIotHubImportDevices.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml -Module Name: AzureRM.IotHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iothub/new-azurermiothubimportdevices -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/New-AzureRmIotHubImportDevices.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/New-AzureRmIotHubImportDevices.md ---- - -# New-AzureRmIotHubImportDevices - -## SYNOPSIS -Creates a new import devices job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmIotHubImportDevices [-ResourceGroupName] <String> [-Name] <String> [-InputBlobContainerUri] <String> - [-OutputBlobContainerUri] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Creates a new import devices job for the IotHub. -This will import all the devices to the IotHub from the specified container. -Refer to the following article on how to generate the SAS URI. -https://docs.microsoft.com/azure/iot-hub/iot-hub-bulk-identity-mgmt#get-the-container-sas-uri . - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmIotHubImportDevices -ResourceGroupName "myresourcegroup" -Name "myiothub" -InputBlobContainerUri "https://mystorageaccount.blob.core.windows.net/mystoragecontainer?sv=2015-04-05&ss=bfqt&sr=c&srt=sco&sp=rwdl&se=2016-10-27T04:01:48Z&st=2016-10-26T20:01:48Z&spr=https&sig=QqpIhHsIMF8hNuFO%3D" -OutputBlobContainerUri "https://mystorageaccount.blob.core.windows.net/?sv=2015-04-05&ss=bfqt&sr=c&srt=sco&sp=rwdl&se=2016-10-27T04:01:48Z&st=2016-10-26T20:01:48Z&spr=https&sig=QqpIhHsIMF8hNuFO%3D" -``` - -Creates a new import device request for the IotHub "myiothub". - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputBlobContainerUri -Input Blob Container Uri for FileUpload - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the IotHub - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OutputBlobContainerUri -The Uri to write the output to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHubJobResponse - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.IotHub/Remove-AzureRmIotHub.md b/azurermps-6.13.0/AzureRM.IotHub/Remove-AzureRmIotHub.md deleted file mode 100644 index 7a37aaf6fa..0000000000 --- a/azurermps-6.13.0/AzureRM.IotHub/Remove-AzureRmIotHub.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml -Module Name: AzureRM.IotHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iothub/remove-azurermiothub -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Remove-AzureRmIotHub.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Remove-AzureRmIotHub.md ---- - -# Remove-AzureRmIotHub - -## SYNOPSIS -Deletes an IotHub. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmIotHub [-ResourceGroupName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Deletes an IotHub. - -## EXAMPLES - -### Example 1 Remove an IotHub -``` -PS C:\> Remove-AzureRmIotHub -ResourceGroupName "myresourcegroup" -Name "myiothub" -``` - -Removes an IotHub named "myiothub" - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the IotHub - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.IotHub/Remove-AzureRmIotHubCertificate.md b/azurermps-6.13.0/AzureRM.IotHub/Remove-AzureRmIotHubCertificate.md deleted file mode 100644 index 3d204d0f8c..0000000000 --- a/azurermps-6.13.0/AzureRM.IotHub/Remove-AzureRmIotHubCertificate.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml -Module Name: AzureRM.IotHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iothub/remove-azurermiothubcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Remove-AzureRmIotHubCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Remove-AzureRmIotHubCertificate.md ---- - -# Remove-AzureRmIotHubCertificate - -## SYNOPSIS -Deletes an Azure IoT Hub certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceSet (Default) -``` -Remove-AzureRmIotHubCertificate [-ResourceGroupName] <String> [-Name] <String> [-CertificateName] <String> - [-Etag] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### InputObjectSet -``` -Remove-AzureRmIotHubCertificate [-InputObject] <PSCertificateDescription> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdSet -``` -Remove-AzureRmIotHubCertificate [-ResourceId] <String> [-Etag] <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -For a detailed explanation of CA certificates in Azure IoT Hub, see https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-x509ca-overview - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmIotHubCertificate -ResourceGroupName "myresourcegroup" -Name "myiothub" -CertificateName "mycertificate" -Etag "AAAAAAFPazE=" -``` - -Deletes MyCertificate - -## PARAMETERS - -### -CertificateName -Name of the Certificate - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Etag -Etag of the Certificate - -```yaml -Type: System.String -Parameter Sets: ResourceSet, ResourceIdSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Certificate Object - -```yaml -Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSCertificateDescription -Parameter Sets: InputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the Iot Hub - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Certificate Resource Id - -```yaml -Type: System.String -Parameter Sets: ResourceIdSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSCertificateDescription -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.IotHub/Remove-AzureRmIotHubEventHubConsumerGroup.md b/azurermps-6.13.0/AzureRM.IotHub/Remove-AzureRmIotHubEventHubConsumerGroup.md deleted file mode 100644 index c6ab210e77..0000000000 --- a/azurermps-6.13.0/AzureRM.IotHub/Remove-AzureRmIotHubEventHubConsumerGroup.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml -Module Name: AzureRM.IotHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iothub/remove-azurermiothubeventhubconsumergroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Remove-AzureRmIotHubEventHubConsumerGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Remove-AzureRmIotHubEventHubConsumerGroup.md ---- - -# Remove-AzureRmIotHubEventHubConsumerGroup - -## SYNOPSIS -Deletes an eventhub consumergroup. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmIotHubEventHubConsumerGroup [-ResourceGroupName] <String> [-Name] <String> - [-EventHubEndpointName] <String> [-EventHubConsumerGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Deletes an eventhub consumergroup. - -## EXAMPLES - -### Example 1 Remove eventhub consumergroup from the telemetry eventhub -``` -PS C:\> Remove-AzureRmIotHubEventHubConsumerGroup -ResourceGroupName "myresourcegroup" -Name "myiothub" -EventHubEndpointName events -EventHubConsumerGroupName myconsumergroup -``` - -Removes the consumergroup named myconsumergroup from the IotHub named "myiothub" - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventHubConsumerGroupName -EventHub ConsumerGroup Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EventHubEndpointName -EventHub Endpoint Name. -Possible values events, operationsMonitoringEvents - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: events, operationsMonitoringEvents - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the IotHub - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.IotHub/Remove-AzureRmIotHubKey.md b/azurermps-6.13.0/AzureRM.IotHub/Remove-AzureRmIotHubKey.md deleted file mode 100644 index c915232b51..0000000000 --- a/azurermps-6.13.0/AzureRM.IotHub/Remove-AzureRmIotHubKey.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml -Module Name: AzureRM.IotHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iothub/remove-azurermiothubkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Remove-AzureRmIotHubKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Remove-AzureRmIotHubKey.md ---- - -# Remove-AzureRmIotHubKey - -## SYNOPSIS -Removes an IotHub Key. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmIotHubKey [-ResourceGroupName] <String> [-Name] <String> [-KeyName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Removes an IotHub Key. -If there are multiple keys with the same name the first one in the list is removed. - -## EXAMPLES - -### Example 1 Delete an IotHub -``` -PS C:\> Remove-AzureRmIotHubKey -ResourceGroupName "myresourcegroup" -Name "myiothub" -KeyName "iothubowner1" -``` - -Removes the key named iothubowner1 from the IotHub named "myiothub" - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyName -Name of the Key - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Name of the IotHub - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSSharedAccessSignatureAuthorizationRule - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.IotHub/Remove-AzureRmIotHubRoute.md b/azurermps-6.13.0/AzureRM.IotHub/Remove-AzureRmIotHubRoute.md deleted file mode 100644 index b8d8593359..0000000000 --- a/azurermps-6.13.0/AzureRM.IotHub/Remove-AzureRmIotHubRoute.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml -Module Name: AzureRM.IotHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iothub/remove-azurermiothubroute -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Remove-AzureRmIotHubRoute.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Remove-AzureRmIotHubRoute.md ---- - -# Remove-AzureRmIotHubRoute - -## SYNOPSIS -Delete a route in IoT Hub - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceSet (Default) -``` -Remove-AzureRmIotHubRoute [-ResourceGroupName] <String> [-Name] <String> [-RouteName <String>] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectSet -``` -Remove-AzureRmIotHubRoute [-InputObject] <PSIotHub> [-RouteName <String>] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdSet -``` -Remove-AzureRmIotHubRoute [-ResourceId] <String> [-RouteName <String>] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Delete a routes to an endpoint - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmIotHubRoute -ResourceGroupName "myresourcegroup" -Name "myiothub" -RouteName R1 -PassThru - -True -``` - -Delete route "R1" from "myiothub" IoT Hub. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -IotHub Object - -```yaml -Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub -Parameter Sets: InputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the Iot Hub - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Allows to return the boolean object. By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -IotHub Resource Id - -```yaml -Type: System.String -Parameter Sets: ResourceIdSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RouteName -Name of the Route - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub -System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.IotHub/Remove-AzureRmIotHubRoutingEndpoint.md b/azurermps-6.13.0/AzureRM.IotHub/Remove-AzureRmIotHubRoutingEndpoint.md deleted file mode 100644 index ee0a86cd32..0000000000 --- a/azurermps-6.13.0/AzureRM.IotHub/Remove-AzureRmIotHubRoutingEndpoint.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml -Module Name: AzureRM.IotHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iothub/remove-azurermiothubroutingendpoint -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Remove-AzureRmIotHubRoutingEndpoint.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Remove-AzureRmIotHubRoutingEndpoint.md ---- - -# Remove-AzureRmIotHubRoutingEndpoint - -## SYNOPSIS -Delete an endpoint for your IoT Hub - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceSet (Default) -``` -Remove-AzureRmIotHubRoutingEndpoint [-ResourceGroupName] <String> [-Name] <String> [-EndpointName <String>] - [-EndpointType <PSEndpointType>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### InputObjectSet -``` -Remove-AzureRmIotHubRoutingEndpoint [-InputObject] <PSIotHub> [-EndpointName <String>] - [-EndpointType <PSEndpointType>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ResourceIdSet -``` -Remove-AzureRmIotHubRoutingEndpoint [-ResourceId] <String> [-EndpointName <String>] - [-EndpointType <PSEndpointType>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Delete an endpoint. Remember to delete any routes that use this endpoint. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmIotHubRoutingEndpoint -ResourceGroupName "myresourcegroup" -Name "myiothub" -EndpointName E2 -PassThru - -True -``` - -Delete endpoint "E2" from "myiothub" IoT Hub. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndpointName -Name of the Routing Endpoint - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndpointType -Type of the Routing Endpoint - -```yaml -Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSEndpointType -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -IotHub Object - -```yaml -Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub -Parameter Sets: InputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the Iot Hub - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Allows to return the boolean object. By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -IotHub Resource Id - -```yaml -Type: System.String -Parameter Sets: ResourceIdSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub -System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingEventHubEndpoint -System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingEventHubProperties, Microsoft.Azure.Commands.IotHub, Version=3.1.3.0, Culture=neutral, PublicKeyToken=null]] -Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingServiceBusQueueEndpoint -System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingServiceBusQueueEndpointProperties, Microsoft.Azure.Commands.IotHub, Version=3.1.3.0, Culture=neutral, PublicKeyToken=null]] -Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingServiceBusTopicEndpoint -System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingServiceBusTopicEndpointProperties, Microsoft.Azure.Commands.IotHub, Version=3.1.3.0, Culture=neutral, PublicKeyToken=null]] -Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingStorageContainerEndpoint -System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingStorageContainerProperties, Microsoft.Azure.Commands.IotHub, Version=3.1.3.0, Culture=neutral, PublicKeyToken=null]] -System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingCustomEndpoint, Microsoft.Azure.Commands.IotHub, Version=3.1.3.0, Culture=neutral, PublicKeyToken=null]] - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.IotHub/Set-AzureRmIotHub.md b/azurermps-6.13.0/AzureRM.IotHub/Set-AzureRmIotHub.md deleted file mode 100644 index 48adb2f587..0000000000 --- a/azurermps-6.13.0/AzureRM.IotHub/Set-AzureRmIotHub.md +++ /dev/null @@ -1,392 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml -Module Name: AzureRM.IotHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iothub/set-azurermiothub -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Set-AzureRmIotHub.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Set-AzureRmIotHub.md ---- - -# Set-AzureRmIotHub - -## SYNOPSIS -Updates the properties of an IotHub. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### UpdateSku (Default) -``` -Set-AzureRmIotHub -ResourceGroupName <String> -Name <String> -SkuName <PSIotHubSku> [-Units <Int64>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### UpdateEventHubEndpointProperties -``` -Set-AzureRmIotHub -ResourceGroupName <String> -Name <String> -EventHubRetentionTimeInDays <Int64> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### UpdateFileUploadProperties -``` -Set-AzureRmIotHub -ResourceGroupName <String> -Name <String> [-FileUploadStorageConnectionString <String>] - [-FileUploadContainerName <String>] [-FileUploadSasUriTtl <TimeSpan>] [-FileUploadNotificationTtl <TimeSpan>] - [-FileUploadNotificationMaxDeliveryCount <Int32>] -EnableFileUploadNotifications <Boolean> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### UpdateCloudToDeviceProperties -``` -Set-AzureRmIotHub -ResourceGroupName <String> -Name <String> -CloudToDevice <PSCloudToDeviceProperties> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### UpdateOperationsMonitoringProperties -``` -Set-AzureRmIotHub -ResourceGroupName <String> -Name <String> - -OperationsMonitoringProperties <PSOperationsMonitoringProperties> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### UpdateRoutingProperties -``` -Set-AzureRmIotHub -ResourceGroupName <String> -Name <String> [-RoutingProperties <PSRoutingProperties>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### UpdateRouteProperties -``` -Set-AzureRmIotHub -ResourceGroupName <String> -Name <String> - [-Routes <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Management.IotHub.Models.PSRouteMetadata]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### UpdateFallbackRouteProperty -``` -Set-AzureRmIotHub -ResourceGroupName <String> -Name <String> [-FallbackRoute <PSFallbackRouteMetadata>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Updates the properties of an IotHub. - -## EXAMPLES - -### Example 1 Update the sku -``` -PS C:\> Set-AzureRmIotHub -ResourceGroupName "myresourcegroup" -Name "myiothub" -SkuName S1 -Units 5 -``` - -Update the sku to S1 and units to 5 for the IotHub named "myiothub" - -### Example 2 Update the eventhub properties -``` -PS C:\> Set-AzureRmIotHub -ResourceGroupName "myresourcegroup" -Name "myiothub" -EventHubRetentionTimeInDays 4 -``` - -Update the retention time in days to 4 for both the telemetry and operationsmonitoringevents events for the IotHub named "myiothub" - -## PARAMETERS - -### -CloudToDevice -The properties for the cloud to device command queue. - -```yaml -Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSCloudToDeviceProperties -Parameter Sets: UpdateCloudToDeviceProperties -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableFileUploadNotifications -Flag that specifies whether notifications should be enabled for file upload. - -```yaml -Type: System.Boolean -Parameter Sets: UpdateFileUploadProperties -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventHubRetentionTimeInDays -Retention time in days. - -```yaml -Type: System.Int64 -Parameter Sets: UpdateEventHubEndpointProperties -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FallbackRoute -Fallback Route for Routing - -```yaml -Type: Microsoft.Azure.Management.IotHub.Models.PSFallbackRouteMetadata -Parameter Sets: UpdateFallbackRouteProperty -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileUploadContainerName -The name of the container to upload the files to. - -```yaml -Type: System.String -Parameter Sets: UpdateFileUploadProperties -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileUploadNotificationMaxDeliveryCount -The maximum delivery count for file upload notifications. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: UpdateFileUploadProperties -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileUploadNotificationTtl -Time to live value for the messages in the file upload notification queue. - -```yaml -Type: System.TimeSpan -Parameter Sets: UpdateFileUploadProperties -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileUploadSasUriTtl -Time to live for the for the SAS Uri thats generated for file upload. - -```yaml -Type: System.TimeSpan -Parameter Sets: UpdateFileUploadProperties -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileUploadStorageConnectionString -The storage connection string to upload the files to. - -```yaml -Type: System.String -Parameter Sets: UpdateFileUploadProperties -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the IotHub - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OperationsMonitoringProperties -The properties related to operations monitoring. - -```yaml -Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSOperationsMonitoringProperties -Parameter Sets: UpdateOperationsMonitoringProperties -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Routes -Routes to be added for Routing - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Management.IotHub.Models.PSRouteMetadata] -Parameter Sets: UpdateRouteProperties -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RoutingProperties -The Routing properties for routing messages to external endpoints - -```yaml -Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingProperties -Parameter Sets: UpdateRoutingProperties -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkuName -Name of the Sku. - -```yaml -Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHubSku -Parameter Sets: UpdateSku -Aliases: -Accepted values: F1, S1, S2, S3, B1, B2, B3 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Units -Number of Units - -```yaml -Type: System.Int64 -Parameter Sets: UpdateSku -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.IotHub/Set-AzureRmIotHubRoute.md b/azurermps-6.13.0/AzureRM.IotHub/Set-AzureRmIotHubRoute.md deleted file mode 100644 index 1de9c8cf93..0000000000 --- a/azurermps-6.13.0/AzureRM.IotHub/Set-AzureRmIotHubRoute.md +++ /dev/null @@ -1,282 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml -Module Name: AzureRM.IotHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iothub/set-azurermiothubroute -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Set-AzureRmIotHubRoute.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Set-AzureRmIotHubRoute.md ---- - -# Set-AzureRmIotHubRoute - -## SYNOPSIS -Update a route in IoT Hub - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceSet (Default) -``` -Set-AzureRmIotHubRoute [-ResourceGroupName] <String> [-Name] <String> [-RouteName] <String> - [-Source <PSRoutingSource>] [-EndpointName <String>] [-Condition <String>] [-Enabled] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectSet -``` -Set-AzureRmIotHubRoute [-InputObject] <PSIotHub> [-RouteName] <String> [-Source <PSRoutingSource>] - [-EndpointName <String>] [-Condition <String>] [-Enabled] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ResourceIdSet -``` -Set-AzureRmIotHubRoute [-ResourceId] <String> [-RouteName] <String> [-Source <PSRoutingSource>] - [-EndpointName <String>] [-Condition <String>] [-Enabled] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Edit a route. You can update all the fields in a route including the data source, endpoint, routing query and also enable or disable the route. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Set-AzureRmIotHubRoute -ResourceGroupName "myresourcegroup" -Name "myiothub" -RouteName R1 -Source TwinChangeEvents - -RouteName : R1 -DataSource : TwinChangeEvents -EndpointNames : events -Condition : true -IsEnabled : False -``` - -Updating the route information. - -### Example 2 -```powershell -PS C:\> Set-AzureRmIotHubRoute -ResourceGroupName "myresourcegroup" -Name "myiothub" -RouteName R1 -EndpointName E1 - -RouteName : R1 -DataSource : TwinChangeEvents -EndpointNames : E1 -Condition : true -IsEnabled : False -``` - -Updating the route information. - -### Example 3 -```powershell -PS C:\> Set-AzureRmIotHubRoute -ResourceGroupName "myresourcegroup" -Name "myiothub" -RouteName R1 -Enabled - -RouteName : R1 -DataSource : TwinChangeEvents -EndpointNames : E1 -Condition : true -IsEnabled : True -``` - -Updating the route information. - -## PARAMETERS - -### -Condition -Condition that is evaluated to apply the routing rule - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Enable route - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndpointName -Name of the routing endpoint - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -IotHub Object - -```yaml -Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub -Parameter Sets: InputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the Iot Hub - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -IotHub Resource Id - -```yaml -Type: System.String -Parameter Sets: ResourceIdSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RouteName -Name of the Route - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Source -Source of the route - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingSource] -Parameter Sets: (All) -Aliases: -Accepted values: Invalid, DeviceMessages, TwinChangeEvents, DeviceLifecycleEvents, DeviceJobLifecycleEvents - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub -System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSRouteMetadata - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.IotHub/Set-AzureRmIotHubVerifiedCertificate.md b/azurermps-6.13.0/AzureRM.IotHub/Set-AzureRmIotHubVerifiedCertificate.md deleted file mode 100644 index b6c1fc4e19..0000000000 --- a/azurermps-6.13.0/AzureRM.IotHub/Set-AzureRmIotHubVerifiedCertificate.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml -Module Name: AzureRM.IotHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iothub/set-azurermiothubverifiedcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Set-AzureRmIotHubVerifiedCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Set-AzureRmIotHubVerifiedCertificate.md ---- - -# Set-AzureRmIotHubVerifiedCertificate - -## SYNOPSIS -Verifies an Azure IoT Hub certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceSet (Default) -``` -Set-AzureRmIotHubVerifiedCertificate [-ResourceGroupName] <String> [-Name] <String> [-CertificateName] <String> - [-Etag] <String> [-Path] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### InputObjectSet -``` -Set-AzureRmIotHubVerifiedCertificate [-InputObject] <PSCertificateDescription> [-Path] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdSet -``` -Set-AzureRmIotHubVerifiedCertificate [-ResourceId] <String> [-Etag] <String> [-Path] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Verifies a certificate by uploading a verification certificate containing the verification code obtained by cmdlet Get-AzureRmIotHubCertificateVerificationCode. This is the last step in the proof of possession process. -For a detailed explanation of CA certificates in Azure IoT Hub, see https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-x509ca-overview - -## EXAMPLES - -### Example 1 -``` -PS C:\> Set-AzureRmIotHubVerifiedCertificate -ResourceGroupName "myresourcegroup" -Name "myiothub" -CertificateName "mycertificate" -Path "c:\myverifiedcertificate.cer" -Etag "AAAAAAFPazE=" - -Id : /subscriptions/377cxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Devices/IotHubs/myiothub/certificates/mycertificate -ResourceGroupName : myresourcegroup -Name : myiothub -CertificateName : mycertificate -Subject : CN=mycertificate -Thumbprint : 38303FC7371EC13DDE3E18D712C8414EE50969C7 -Status : Verified -Expiry : 1/01/2027 16:01 -Created : 1/01/2017 16:01 -Etag : AAAAAAFpObE= -``` - -Verifies ownership of the MyCertificate private key. - -## PARAMETERS - -### -CertificateName -Name of the Certificate - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Etag -Etag of the Certificate - -```yaml -Type: System.String -Parameter Sets: ResourceSet, ResourceIdSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Certificate Object - -```yaml -Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSCertificateDescription -Parameter Sets: InputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the Iot Hub - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -base-64 representation of X509 certificate .cer file or .pem file path. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group - -```yaml -Type: System.String -Parameter Sets: ResourceSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Certificate Resource Id - -```yaml -Type: System.String -Parameter Sets: ResourceIdSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSCertificateDescription -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSCertificateDescription - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.IotHub/Test-AzureRmIotHubRoute.md b/azurermps-6.13.0/AzureRM.IotHub/Test-AzureRmIotHubRoute.md deleted file mode 100644 index 66de302ee5..0000000000 --- a/azurermps-6.13.0/AzureRM.IotHub/Test-AzureRmIotHubRoute.md +++ /dev/null @@ -1,288 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml -Module Name: AzureRM.IotHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iothub/test-azurermiothubroute -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Test-AzureRmIotHubRoute.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Test-AzureRmIotHubRoute.md ---- - -# Test-AzureRmIotHubRoute - -## SYNOPSIS -Test routes in IoT Hub - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceSet (Default) -``` -Test-AzureRmIotHubRoute [-Body <String>] [-AppProperty <Hashtable>] [-SystemProperty <Hashtable>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### InputObjectTestRouteSet -``` -Test-AzureRmIotHubRoute [-InputObject] <PSIotHub> [-RouteName] <String> [-Body <String>] - [-AppProperty <Hashtable>] [-SystemProperty <Hashtable>] [-ShowError] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### InputObjectTestAllRouteSet -``` -Test-AzureRmIotHubRoute [-InputObject] <PSIotHub> [-Source] <PSRoutingSource> [-Body <String>] - [-AppProperty <Hashtable>] [-SystemProperty <Hashtable>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### TestRouteSet -``` -Test-AzureRmIotHubRoute [-ResourceGroupName] <String> [-Name] <String> [-RouteName] <String> [-Body <String>] - [-AppProperty <Hashtable>] [-SystemProperty <Hashtable>] [-ShowError] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### TestAllRouteSet -``` -Test-AzureRmIotHubRoute [-ResourceGroupName] <String> [-Name] <String> [-Source] <PSRoutingSource> - [-Body <String>] [-AppProperty <Hashtable>] [-SystemProperty <Hashtable>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceIdTestRouteSet -``` -Test-AzureRmIotHubRoute [-ResourceId] <String> [-RouteName] <String> [-Body <String>] - [-AppProperty <Hashtable>] [-SystemProperty <Hashtable>] [-ShowError] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceIdTestAllRouteSet -``` -Test-AzureRmIotHubRoute [-ResourceId] <String> [-Source] <PSRoutingSource> [-Body <String>] - [-AppProperty <Hashtable>] [-SystemProperty <Hashtable>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -Test a specific route. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Test-AzureRmIotHubRoute -ResourceGroupName "myresourcegroup" -Name "myiothub" -Source DeviceMessages - -RouteName DataSource EndpointNames IsEnabled ---------- ---------- ------------- --------- -R1 DeviceMessages events True -R5 DeviceMessages E1 True -``` - -Test all route with source "DeviceMessges". - -### Example 2 -``` -PS C:\> Test-AzureRmIotHubRoute -ResourceGroupName "myresourcegroup" -Name "myiothub" -RouteName R1 - -Result : true -``` - -Test a specific route. - -### Example 3 -``` -PS C:\> Test-AzureRmIotHubRoute -ResourceGroupName "myresourcegroup" -Name "myiothub" -RouteName R1 -ShowError - -ErrorMessage Severity LocationStartLine LocationStartColumn LocationEndLine LocationEndColumn ------------- -------- ----------------- ------------------- --------------- ----------------- -Syntax error. error 1 29 1 30 -``` - -Test a specific route and showing the reason of failure. - -## PARAMETERS - -### -AppProperty -App properties of the route message - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -Body of the route message - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -IotHub Object - -```yaml -Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub -Parameter Sets: InputObjectTestRouteSet, InputObjectTestAllRouteSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the Iot Hub - -```yaml -Type: System.String -Parameter Sets: TestRouteSet, TestAllRouteSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group - -```yaml -Type: System.String -Parameter Sets: TestRouteSet, TestAllRouteSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -IotHub Resource Id - -```yaml -Type: System.String -Parameter Sets: ResourceIdTestRouteSet, ResourceIdTestAllRouteSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RouteName -Name of the Route - -```yaml -Type: System.String -Parameter Sets: InputObjectTestRouteSet, TestRouteSet, ResourceIdTestRouteSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowError -Show detailed error, if exist - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: InputObjectTestRouteSet, TestRouteSet, ResourceIdTestRouteSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Source -Source of the route - -```yaml -Type: Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingSource -Parameter Sets: InputObjectTestAllRouteSet, TestAllRouteSet, ResourceIdTestAllRouteSet -Aliases: -Accepted values: Invalid, DeviceMessages, TwinChangeEvents, DeviceLifecycleEvents, DeviceJobLifecycleEvents - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SystemProperty -System properties of the route message - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub -System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSTestRouteResult -Microsoft.Azure.Commands.Management.IotHub.Models.PSRouteCompilationError -System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Management.IotHub.Models.PSRouteProperties, Microsoft.Azure.Commands.IotHub, Version=3.1.3.0, Culture=neutral, PublicKeyToken=null]] - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.IotHub/Update-AzureRmIotHub.md b/azurermps-6.13.0/AzureRM.IotHub/Update-AzureRmIotHub.md deleted file mode 100644 index c97dc9d804..0000000000 --- a/azurermps-6.13.0/AzureRM.IotHub/Update-AzureRmIotHub.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml -Module Name: AzureRM.IotHub -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.iothub/update-azurermiothub -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Update-AzureRmIotHub.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/IotHub/Commands.IotHub/help/Update-AzureRmIotHub.md ---- - -# Update-AzureRmIotHub - -## SYNOPSIS -Update an Azure IoT Hub. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Update-AzureRmIotHub -ResourceGroupName <String> -Name <String> -Tag <Hashtable> [-Reset] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -You can update the tags properties of an IotHub. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Update-AzureRmIotHub -ResourceGroupName "myresourcegroup" -Name "myiotdps" -Tag @tags - -Id : /subscriptions/91d1xxxx-xxxx-xxxx-xxxx-xxxxxxxxddc0/resourceGroups/myresourcegroup/providers/Microsoft.De - vices/IotHubs/myiotdps -Name : myiotdps -Type : Microsoft.Devices/IotHubs -Location : East US -Tags : {[k1, v1]} -Properties : Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHubProperties -Sku : Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHubSkuInfo -``` - -Add "@tags" to the Tag of an Azure IoT Hub "myiotdps". - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the Iot Hub - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Reset -Reset IoTHub Tags - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Resource Group - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -IoTHub Tag collection - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.IotHub.Models.PSIotHub - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Add-AzureKeyVaultCertificate.md b/azurermps-6.13.0/AzureRM.KeyVault/Add-AzureKeyVaultCertificate.md deleted file mode 100644 index 3cb196c49e..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Add-AzureKeyVaultCertificate.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 89299823-3382-402D-9458-519466748051 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/add-azurekeyvaultcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Add-AzureKeyVaultCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Add-AzureKeyVaultCertificate.md ---- - -# Add-AzureKeyVaultCertificate - -## SYNOPSIS -Adds a certificate to a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureKeyVaultCertificate [-VaultName] <String> [-Name] <String> - [-CertificatePolicy] <PSKeyVaultCertificatePolicy> [-Tag <Hashtable>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureKeyVaultCertificate** cmdlet starts the process of enrolling for a certificate in a key vault in Azure Key Vault. - -## EXAMPLES - -### Example 1: Add a certificate -```powershell -PS C:\> $Policy = New-AzureKeyVaultCertificatePolicy -SecretContentType "application/x-pkcs12" -SubjectName "CN=contoso.com" -IssuerName "Self" -ValidityInMonths 6 -ReuseKeyOnRenewal -PS C:\> Add-AzureKeyVaultCertificate -VaultName "ContosoKV01" -Name "TestCert01" -CertificatePolicy $Policy - -Status : inProgress -CancellationRequested : False -CertificateSigningRequest : MIICpjCCAY4CAQAwFjEUMBIGA1UEAxMLY29udG9zby5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC73w3VRBOlgJ5Od1PjDh+2ytngNZp+ZP4fkuX8K1Ti5LA6Ih7eWx1fgAN/iTb6l - 5K6LvAIJvsTNVePMNxfSdaEIJ70Inm45wVU4A/kf+UxQWAYVMsBrLtDFWxnVhzf6n7RGYke6HLBj3j5ASb9g+olSs6eON25ibF0t+u6JC+sIR0LmVGar9Q0eZys1rdfzJBIKq+laOM7z2pJijb5ANqve9 - i7rH5mnhQk4V8WsRstOhYR9jgLqSSxokDoeaBClIOidSBYqVc1yNv4ASe1UWUCR7ZK6OQXiecNWSWPmgWEyawu6AR9eb1YotCr2ScheMOCxlm3103luitxrd8A7kMjAgMBAAGgSzBJBgkqhkiG9w0BCQ4 - xPDA6MA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwCQYDVR0TBAIwADANBgkqhkiG9w0BAQsFAAOCAQEAIHhsDJV37PKi8hor5eQf7+Tct1preIvSwqV0NF6Uo7O6 - YnC9Py7Wp7CHfKzuqeptUk2Tsu7B5dHB+o9Ypeeqw8fWhTN0GFGRKO7WjZQlDqL+lRNcjlFSaP022oIP0kmvVhBcmZqRQlALXccAaxEclFA/3y/aNj2gwWeKpH/pwAkZ39zMEzpQCaRfnQk7e3l4MV8cf - eC2HPYdRWkXxAeDcNPxBuVmKy49AzYvly+APNVDU3v66gxl3fIKrGRsKi2Cp/nO5rBxG2h8t+0Za4l/HJ7ZWR9wKbd/xg7JhdZZFVBxMHYzw8KQ0ys13x8HY+PXU92Y7yD3uC2Rcj+zbAf+Kg== -ErrorCode : -ErrorMessage : - -PS C:\> Get-AzureKeyVaultCertificateOperation -VaultName "ContosoKV01" -Name "TestCert01" -Status : completed -CancellationRequested : False -CertificateSigningRequest : MIICpjCCAY4CAQAwFjEUMBIGA1UEAxMLY29udG9zby5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC73w3VRBOlgJ5Od1PjDh+2ytngNZp+ZP4fkuX8K1Ti5LA6Ih7eWx1fgAN/iTb6l - 5K6LvAIJvsTNVePMNxfSdaEIJ70Inm45wVU4A/kf+UxQWAYVMsBrLtDFWxnVhzf6n7RGYke6HLBj3j5ASb9g+olSs6eON25ibF0t+u6JC+sIR0LmVGar9Q0eZys1rdfzJBIKq+laOM7z2pJijb5ANqve9 - i7rH5mnhQk4V8WsRstOhYR9jgLqSSxokDoeaBClIOidSBYqVc1yNv4ASe1UWUCR7ZK6OQXiecNWSWPmgWEyawu6AR9eb1YotCr2ScheMOCxlm3103luitxrd8A7kMjAgMBAAGgSzBJBgkqhkiG9w0BCQ4 - xPDA6MA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwCQYDVR0TBAIwADANBgkqhkiG9w0BAQsFAAOCAQEAIHhsDJV37PKi8hor5eQf7+Tct1preIvSwqV0NF6Uo7O6 - YnC9Py7Wp7CHfKzuqeptUk2Tsu7B5dHB+o9Ypeeqw8fWhTN0GFGRKO7WjZQlDqL+lRNcjlFSaP022oIP0kmvVhBcmZqRQlALXccAaxEclFA/3y/aNj2gwWeKpH/pwAkZ39zMEzpQCaRfnQk7e3l4MV8cf - eC2HPYdRWkXxAeDcNPxBuVmKy49AzYvly+APNVDU3v66gxl3fIKrGRsKi2Cp/nO5rBxG2h8t+0Za4l/HJ7ZWR9wKbd/xg7JhdZZFVBxMHYzw8KQ0ys13x8HY+PXU92Y7yD3uC2Rcj+zbAf+Kg== -ErrorCode : -ErrorMessage : - -PS C:\> Get-AzureKeyVaultCertificate -VaultName "ContosoKV01" -Name "TestCert01" - -Name : testCert01 -Certificate : [Subject] - CN=contoso.com - - [Issuer] - CN=contoso.com - - [Serial Number] - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - - [Not Before] - 2/8/2016 3:11:45 PM - - [Not After] - 8/8/2016 4:21:45 PM - - [Thumbprint] - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - -Thumbprint : XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX -Tags : -Enabled : True -Created : 2/8/2016 11:21:45 PM -Updated : 2/8/2016 11:21:45 PM -``` - -The first command uses the New-AzureKeyVaultCertificatePolicy cmdlet to create a certificate policy, and then stores it in the $Policy variable. -The second command uses **Add-AzureKeyVaultCertificate** to start the process to create a certificate. -The third command uses the Get-AzureKeyVaultCertificateOperation cmdlet to poll the operation to verify that it's complete. -The final command uses the Get-AzureKeyVaultCertificate cmdlet to get the certificate. - -## PARAMETERS - -### -CertificatePolicy -Specifies a **KeyVaultCertificatePolicy** object. - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificatePolicy -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the certificate to add. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: CertificateName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of a key vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificatePolicy -Parameters: CertificatePolicy (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateOperation - -## NOTES - -## RELATED LINKS - -[Get-AzureKeyVaultCertificate](./Get-AzureKeyVaultCertificate.md) - -[Import-AzureKeyVaultCertificate](./Import-AzureKeyVaultCertificate.md) - -[Remove-AzureKeyVaultCertificate](./Remove-AzureKeyVaultCertificate.md) diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Add-AzureKeyVaultCertificateContact.md b/azurermps-6.13.0/AzureRM.KeyVault/Add-AzureKeyVaultCertificateContact.md deleted file mode 100644 index 5ff37f7aac..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Add-AzureKeyVaultCertificateContact.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 2D3021B3-12C5-4797-8BF2-800E3CEAC56C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/add-azurekeyvaultcertificatecontact -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Add-AzureKeyVaultCertificateContact.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Add-AzureKeyVaultCertificateContact.md ---- - -# Add-AzureKeyVaultCertificateContact - -## SYNOPSIS -Adds a contact for certificate notifications. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Interactive (Default) -``` -Add-AzureKeyVaultCertificateContact [-VaultName] <String> [-EmailAddress] <String[]> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByObject -``` -Add-AzureKeyVaultCertificateContact [-InputObject] <PSKeyVault> [-EmailAddress] <String[]> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Add-AzureKeyVaultCertificateContact [-ResourceId] <String> [-EmailAddress] <String[]> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureKeyVaultCertificateContact** cmdlet adds a contact for a key vault for certificate notifications in Azure Key Vault. -The contact receives updates about events such as certificate close to expiry, certificate renewed, and so on. -These events are determined by the certificate policy. - -## EXAMPLES - -### Example 1: Add a key vault certificate contact -```powershell -PS C:\> Add-AzureKeyVaultCertificateContact -VaultName "ContosoKV01" -EmailAddress "patti.fuller@contoso.com" -PassThru - -Email VaultName ------ --------- -patti.fuller@contoso.com ContosoKV01 -``` - -This command adds Patti Fuller as a certificate contact for the ContosoKV01 key vault and returns the list of contacts for the "ContosoKV01" vault. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddress -Specifies the email address of the contact. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -KeyVault object. - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault -Parameter Sets: ByObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -KeyVault Resource Id. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault. - -```yaml -Type: System.String -Parameter Sets: Interactive -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateContact - -## NOTES - -## RELATED LINKS - -[Get-AzureKeyVaultCertificateContact](./Get-AzureKeyVaultCertificateContact.md) - -[Remove-AzureKeyVaultCertificateContact](./Remove-AzureKeyVaultCertificateContact.md) - diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Add-AzureKeyVaultKey.md b/azurermps-6.13.0/AzureRM.KeyVault/Add-AzureKeyVaultKey.md deleted file mode 100644 index a13038f7a8..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Add-AzureKeyVaultKey.md +++ /dev/null @@ -1,561 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 846F781C-73A3-4BBE-ABD9-897371109FBE -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/add-azurekeyvaultkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Add-AzureKeyVaultKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Add-AzureKeyVaultKey.md ---- - -# Add-AzureKeyVaultKey - -## SYNOPSIS -Creates a key in a key vault or imports a key into a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### InteractiveCreate (Default) -``` -Add-AzureKeyVaultKey [-VaultName] <String> [-Name] <String> -Destination <String> [-Disable] - [-KeyOps <String[]>] [-Expires <DateTime>] [-NotBefore <DateTime>] [-Tag <Hashtable>] [-Size <Int32>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InteractiveImport -``` -Add-AzureKeyVaultKey [-VaultName] <String> [-Name] <String> -KeyFilePath <String> - [-KeyFilePassword <SecureString>] [-Destination <String>] [-Disable] [-KeyOps <String[]>] - [-Expires <DateTime>] [-NotBefore <DateTime>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectCreate -``` -Add-AzureKeyVaultKey [-InputObject] <PSKeyVault> [-Name] <String> -Destination <String> [-Disable] - [-KeyOps <String[]>] [-Expires <DateTime>] [-NotBefore <DateTime>] [-Tag <Hashtable>] [-Size <Int32>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectImport -``` -Add-AzureKeyVaultKey [-InputObject] <PSKeyVault> [-Name] <String> -KeyFilePath <String> - [-KeyFilePassword <SecureString>] [-Destination <String>] [-Disable] [-KeyOps <String[]>] - [-Expires <DateTime>] [-NotBefore <DateTime>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdCreate -``` -Add-AzureKeyVaultKey [-ResourceId] <String> [-Name] <String> -Destination <String> [-Disable] - [-KeyOps <String[]>] [-Expires <DateTime>] [-NotBefore <DateTime>] [-Tag <Hashtable>] [-Size <Int32>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdImport -``` -Add-AzureKeyVaultKey [-ResourceId] <String> [-Name] <String> -KeyFilePath <String> - [-KeyFilePassword <SecureString>] [-Destination <String>] [-Disable] [-KeyOps <String[]>] - [-Expires <DateTime>] [-NotBefore <DateTime>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureKeyVaultKey** cmdlet creates a key in a key vault in Azure Key Vault, or imports a key into a key vault. -Use this cmdlet to add keys by using any of the following methods: -- Create a key in a hardware security module (HSM) in the Key Vault service. -- Create a key in software in the Key Vault service. -- Import a key from your own hardware security module (HSM) to HSMs in the Key Vault service. -- Import a key from a .pfx file on your computer. -- Import a key from a .pfx file on your computer to hardware security modules (HSMs) in the Key Vault service. -For any of these operations, you can provide key attributes or accept default settings. -If you create or import a key that has the same name as an existing key in your key vault, the -original key is updated with the values that you specify for the new key. You can access the -previous values by using the version-specific URI for that version of the key. To learn about key -versions and the URI structure, see [About Keys and Secrets](https://go.microsoft.com/fwlink/?linkid=518560) -in the Key Vault REST API documentation. -Note: To import a key from your own hardware security module, you must first generate a BYOK -package (a file with a .byok file name extension) by using the Azure Key Vault BYOK toolset. For -more information, see -[How to Generate and Transfer HSM-Protected Keys for Azure Key Vault](https://go.microsoft.com/fwlink/?LinkId=522252). -As a best practice, back up your key after it is created or updated, by using the -Backup-AzureKeyVaultKey cmdlet. There is no undelete functionality, so if you accidentally delete -your key or delete it and then change your mind, the key is not recoverable unless you have a -backup of it that you can restore. - -## EXAMPLES - -### Example 1: Create a key -```powershell -PS C:\> Add-AzureKeyVaultKey -VaultName 'contoso' -Name 'ITSoftware' -Destination 'Software' - -Vault Name : contoso -Name : ITSoftware -Version : 67da57e9cadf48a2ad8d366b115843ab -Id : https://contoso.vault.azure.net:443/keys/ITSoftware/67da57e9cadf48a2ad8d366b115843ab -Enabled : True -Expires : -Not Before : -Created : 5/21/2018 11:10:58 PM -Updated : 5/21/2018 11:10:58 PM -Purge Disabled : False -Tags : -``` - -This command creates a software-protected key named ITSoftware in the key vault named Contoso. - -### Example 2: Create an HSM-protected key -```powershell -PS C:\> Add-AzureKeyVaultKey -VaultName 'contoso' -Name 'ITHsm' -Destination 'HSM' - -Vault Name : contoso -Name : ITHsm -Version : 67da57e9cadf48a2ad8d366b115843ab -Id : https://contoso.vault.azure.net:443/keys/ITSoftware/67da57e9cadf48a2ad8d366b115843ab -Enabled : True -Expires : -Not Before : -Created : 5/21/2018 11:10:58 PM -Updated : 5/21/2018 11:10:58 PM -Purge Disabled : False -Tags : -``` - -This command creates an HSM-protected key in the key vault named Contoso. - -### Example 3: Create a key with non-default values -```powershell -PS C:\> $KeyOperations = 'decrypt', 'verify' -PS C:\> $Expires = (Get-Date).AddYears(2).ToUniversalTime() -PS C:\> $NotBefore = (Get-Date).ToUniversalTime() -PS C:\> $Tags = @{'Severity' = 'high'; 'Accounting' = "true"} -PS C:\> Add-AzureKeyVaultKey -VaultName 'contoso' -Name 'ITHsmNonDefault' -Destination 'HSM' -Expires $Expires -NotBefore $NotBefore -KeyOps $KeyOperations -Disable -Tag $Tags - -Vault Name : contoso -Name : ITHsmNonDefault -Version : 929bfc14db84439b823ffd1bedadaf5f -Id : https://contoso.vault.azure.net:443/keys/ITHsmNonDefault/929bfc14db84439b823ffd1bedadaf5f -Enabled : False -Expires : 5/21/2020 11:12:43 PM -Not Before : 5/21/2018 11:12:50 PM -Created : 5/21/2018 11:13:17 PM -Updated : 5/21/2018 11:13:17 PM -Purge Disabled : False -Tags : Name Value - Severity high - Accounting true -``` - -The first command stores the values decrypt and verify in the $KeyOperations variable. -The second command creates a **DateTime** object, defined in UTC, by using the **Get-Date** cmdlet. -That object specifies a time two years in the future. The command stores that date in the $Expires -variable. For more information, type `Get-Help Get-Date`. -The third command creates a **DateTime** object by using the **Get-Date** cmdlet. That object -specifies current UTC time. The command stores that date in the $NotBefore variable. -The final command creates a key named ITHsmNonDefault that is an HSM-protected key. The command -specifies values for allowed key operations stored $KeyOperations. The command specifies times for -the *Expires* and *NotBefore* parameters created in the previous commands, and tags for high -severity and IT. The new key is disabled. You can enable it by using the **Set-AzureKeyVaultKey** -cmdlet. - -### Example 4: Import an HSM-protected key -```powershell -PS C:\> Add-AzureKeyVaultKey -VaultName 'contoso' -Name 'ITByok' -KeyFilePath 'C:\Contoso\ITByok.byok' -Destination 'HSM' - -Vault Name : contoso -Name : ITByok -Version : 67da57e9cadf48a2ad8d366b115843ab -Id : https://contoso.vault.azure.net:443/keys/ITByok/67da57e9cadf48a2ad8d366b115843ab -Enabled : True -Expires : -Not Before : -Created : 5/21/2018 11:10:58 PM -Updated : 5/21/2018 11:10:58 PM -Purge Disabled : False -Tags : -``` - -This command imports the key named ITByok from the location that the *KeyFilePath* parameter -specifies. The imported key is an HSM-protected key. -To import a key from your own hardware security module, you must first generate a BYOK package (a file with a .byok file name extension) by using the Azure Key Vault BYOK toolset. -For more information, see -[How to Generate and Transfer HSM-Protected Keys for Azure Key Vault](https://go.microsoft.com/fwlink/?LinkId=522252). - -### Example 5: Import a software-protected key -```powershell -PS C:\> $Password = ConvertTo-SecureString -String 'Password' -AsPlainText -Force -PS C:\> Add-AzureKeyVaultKey -VaultName 'contoso' -Name 'ITPfx' -KeyFilePath 'C:\Contoso\ITPfx.pfx' -KeyFilePassword $Password - -Vault Name : contoso -Name : ITPfx -Version : 67da57e9cadf48a2ad8d366b115843ab -Id : https://contoso.vault.azure.net:443/keys/ITPfx/67da57e9cadf48a2ad8d366b115843ab -Enabled : True -Expires : -Not Before : -Created : 5/21/2018 11:10:58 PM -Updated : 5/21/2018 11:10:58 PM -Purge Disabled : False -Tags : -``` - -The first command converts a string into a secure string by using the **ConvertTo-SecureString** -cmdlet, and then stores that string in the $Password variable. For more information, type `Get-Help -ConvertTo-SecureString`. -The second command creates a software password in the Contoso key vault. The command specifies the -location for the key and the password stored in $Password. - -### Example 6: Import a key and assign attributes -```powershell -PS C:\> $Password = ConvertTo-SecureString -String 'password' -AsPlainText -Force -PS C:\> $Expires = (Get-Date).AddYears(2).ToUniversalTime() -PS C:\> $Tags = @{ 'Severity' = 'high'; 'Accounting' = "true" } -PS C:\> Add-AzureKeyVaultKey -VaultName 'contoso' -Name 'ITPfxToHSM' -Destination 'HSM' -KeyFilePath 'C:\Contoso\ITPfx.pfx' -KeyFilePassword $Password -Expires $Expires -Tag $Tags - -Vault Name : contoso -Name : ITPfxToHSM -Version : 929bfc14db84439b823ffd1bedadaf5f -Id : https://contoso.vault.azure.net:443/keys/ITPfxToHSM/929bfc14db84439b823ffd1bedadaf5f -Enabled : True -Expires : 5/21/2020 11:12:43 PM -Not Before : -Created : 5/21/2018 11:13:17 PM -Updated : 5/21/2018 11:13:17 PM -Purge Disabled : False -Tags : Name Value - Severity high - Accounting true -``` - -The first command converts a string into a secure string by using the **ConvertTo-SecureString** -cmdlet, and then stores that string in the $Password variable. -The second command creates a **DateTime** object by using the **Get-Date** cmdlet, and then stores -that object in the $Expires variable. -The third command creates the $tags variable to set tags for high severity and IT. -The final command imports a key as an HSM key from the specified location. The command specifies -the expiration time stored in $Expires and password stored in $Password, and applies the tags -stored in $tags. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Destination -Specifies whether to add the key as a software-protected key or an HSM-protected key in the Key Vault service. -Valid values are: HSM and Software. -Note: To use HSM as your destination, you must have a key vault that supports HSMs. For more -information about the service tiers and capabilities for Azure Key Vault, see the -[Azure Key Vault Pricing website](https://go.microsoft.com/fwlink/?linkid=512521). -This parameter is required when you create a new key. If you import a key by using the -*KeyFilePath* parameter, this parameter is optional: -- If you do not specify this parameter, and this cmdlet imports a key that has .byok file name -extension, it imports that key as an HSM-protected key. The cmdlet cannot import that key as -software-protected key. -- If you do not specify this parameter, and this cmdlet imports a key that has a .pfx file name -extension, it imports the key as a software-protected key. - -```yaml -Type: System.String -Parameter Sets: InteractiveCreate, InputObjectCreate, ResourceIdCreate -Aliases: -Accepted values: HSM, Software - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: InteractiveImport, InputObjectImport, ResourceIdImport -Aliases: -Accepted values: HSM, Software - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disable -Indicates that the key you are adding is set to an initial state of disabled. Any attempt to use -the key will fail. Use this parameter if you are preloading keys that you intend to enable later. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expires -Specifies the expiration time, as a **DateTime** object, for the key that this cmdlet adds. This -parameter uses Coordinated Universal Time (UTC). To obtain a **DateTime** object, use the -**Get-Date** cmdlet. For more information, type `Get-Help Get-Date`. If you do not specify this -parameter, the key does not expire. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Vault object. - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault -Parameter Sets: InputObjectCreate, InputObjectImport -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -KeyFilePassword -Specifies a password for the imported file as a **SecureString** object. To obtain a -**SecureString** object, use the **ConvertTo-SecureString** cmdlet. For more information, type -`Get-Help ConvertTo-SecureString`. You must specify this password to import a file with a .pfx file -name extension. - -```yaml -Type: System.Security.SecureString -Parameter Sets: InteractiveImport, InputObjectImport, ResourceIdImport -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyFilePath -Specifies the path of a local file that contains key material that this cmdlet imports. -The valid file name extensions are .byok and .pfx. -- If the file is a .byok file, the key is automatically protected by HSMs after the import and you -cannot override this default. -- If the file is a .pfx file, the key is automatically protected by software after the import. To -override this default, set the *Destination* parameter to HSM so that the key is HSM-protected. -When you specify this parameter, the *Destination* parameter is optional. - -```yaml -Type: System.String -Parameter Sets: InteractiveImport, InputObjectImport, ResourceIdImport -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyOps -Specifies an array of operations that can be performed by using the key that this cmdlet adds. -If you do not specify this parameter, all operations can be performed. -The acceptable values for this parameter are a comma-separated list of key operations as defined by -the [JSON Web Key (JWK) specification](https://go.microsoft.com/fwlink/?LinkID=613300): -- Encrypt -- Decrypt -- Wrap -- Unwrap -- Sign -- Verify - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the key to add to the key vault. This cmdlet constructs the fully qualified -domain name (FQDN) of a key based on the name that this parameter specifies, the name of the key -vault, and your current environment. The name must be a string of 1 through 63 characters in length -that contains only 0-9, a-z, A-Z, and - (the dash symbol). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: KeyName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotBefore -Specifies the time, as a **DateTime** object, before which the key cannot be used. This parameter -uses UTC. To obtain a **DateTime** object, use the **Get-Date** cmdlet. If you do not specify this -parameter, the key can be used immediately. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Vault Resource Id. - -```yaml -Type: System.String -Parameter Sets: ResourceIdCreate, ResourceIdImport -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Size -RSA key size, in bits. If not specified, the service will provide a safe default. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: InteractiveCreate, InputObjectCreate, ResourceIdCreate -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault to which this cmdlet adds the key. This cmdlet constructs the -FQDN of a key vault based on the name that this parameter specifies and your current environment. - -```yaml -Type: System.String -Parameter Sets: InteractiveCreate, InteractiveImport -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKey - -## NOTES - -## RELATED LINKS - -[Backup-AzureKeyVaultKey](./Backup-AzureKeyVaultKey.md) - -[Get-AzureKeyVaultKey](./Get-AzureKeyVaultKey.md) - -[Remove-AzureKeyVaultKey](./Remove-AzureKeyVaultKey.md) - diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Add-AzureKeyVaultManagedStorageAccount.md b/azurermps-6.13.0/AzureRM.KeyVault/Add-AzureKeyVaultManagedStorageAccount.md deleted file mode 100644 index 169ffea391..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Add-AzureKeyVaultManagedStorageAccount.md +++ /dev/null @@ -1,280 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/add-azurekeyvaultmanagedstorageaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Add-AzureKeyVaultManagedStorageAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Add-AzureKeyVaultManagedStorageAccount.md ---- - -# Add-AzureKeyVaultManagedStorageAccount - -## SYNOPSIS -Adds an existing Azure Storage Account to the specified key vault for its keys to be managed by the Key Vault service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureKeyVaultManagedStorageAccount [-VaultName] <String> [-AccountName] <String> - [-AccountResourceId] <String> [-ActiveKeyName] <String> [-DisableAutoRegenerateKey] - [-RegenerationPeriod <TimeSpan>] [-Disable] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Sets up an existing Azure Storage Account with Key Vault for Storage Account keys to be managed by -Key Vault. The Storage Account must already exist. The Storage Keys are never exposed to caller. -Key Vault auto regenerates and switches the active key based on the regeneration period. - -## EXAMPLES - -### Example 1: Set an Azure Storage Account with Key Vault to manage its keys -```powershell -PS C:\> $storage = Get-AzureRmStorageAccount -ResourceGroupName "mystorageResourceGroup" -StorageAccountName "mystorage" -PS C:\> $servicePrincipal = Get-AzureRmADServicePrincipal -ServicePrincipalName cfa8b339-82a2-471a-a3c9-0fc0be7a4093 -PS C:\> New-AzureRmRoleAssignment -ObjectId $servicePrincipal.Id -RoleDefinitionName 'Storage Account Key Operator Service Role' -Scope $storage.Id -PS C:\> $userPrincipalId = $(Get-AzureRmADUser -SearchString "developer@contoso.com").Id -PS C:\> Set-AzureRmKeyVaultAccessPolicy -VaultName $keyVaultName -ObjectId $userPrincipalId -PermissionsToStorage get, set -PS C:\> $regenerationPeriod = [System.Timespan]::FromDays(90) -PS C:\> Add-AzureKeyVaultManagedStorageAccount -VaultName 'myvault' -AccountName 'mystorageaccount' -AccountResourceId '/subscriptions/<subscription id>/resourceGroups/myresourcegroup/providers/Microsoft.Storage/storageAccounts/mystorageaccount' -ActiveKeyName 'key1' -RegenerationPeriod $regenerationPeriod - -Id : https://myvault.vault.azure.net:443/storage/mystorageaccount -Vault Name : myvault -AccountName : mystorageaccount -Account Resource Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.St - orage/storageAccounts/mystorageaccount -Active Key Name : key1 -Auto Regenerate Key : True -Regeneration Period : 90.00:00:00 -Enabled : True -Created : 5/21/2018 11:55:58 PM -Updated : 5/21/2018 11:55:58 PM -Tags : -``` - -Sets a Storage Account with Key Vault for its keys to be managed by Key Vault. The active key set -is 'key1'. This key will be used to generate sas tokens. Key Vault will regenerate 'key2' key after -the regeneration period from the time of this command and set it as the active key. This auto -regeneration process will continue between 'key1' and 'key2' with a gap of 90 days. - -### Example 2: Set a Classic Azure Storage Account with Key Vault to manage its keys -```powershell -PS C:\> $regenerationPeriod = [System.Timespan]::FromDays(90) -PS C:\> Add-AzureKeyVaultManagedStorageAccount -VaultName 'myvault' -AccountName 'mystorageaccount' -AccountResourceId '/subscriptions/<subscription id>/resourceGroups/myresourcegroup/providers/Microsoft.ClassicStorage/storageAccounts/mystorageaccount' -ActiveKeyName 'Primary' -RegenerationPeriod $regenerationPeriod - -Id : https://myvault.vault.azure.net:443/storage/mystorageaccount -Vault Name : myvault -AccountName : mystorageaccount -Account Resource Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myvault/providers/Microsoft.Cl - assicStorage/storageAccounts/mystorageaccount -Active Key Name : Primary -Auto Regenerate Key : True -Regeneration Period : 90.00:00:00 -Enabled : True -Created : 5/21/2018 11:55:58 PM -Updated : 5/21/2018 11:55:58 PM -Tags : -``` - -Sets a Classic Storage Account with Key Vault for its keys to be managed by Key Vault. The active -key set is 'Primary'. This key will be used to generate sas tokens. Key Vault will regenerate -'Secondary' key after the regeneration period from the time of this command and set it as the -active key. This auto regeneration process will continue between 'Primary' and 'Secondary' with a -gap of 90 days. - -## PARAMETERS - -### -AccountName -Key Vault managed storage account name. Cmdlet constructs the FQDN of a managed storage account -name from vault name, currently selected environment and manged storage account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: StorageAccountName, Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AccountResourceId -Azure resource id of the storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: StorageAccountResourceId - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ActiveKeyName -Name of the storage account key that must be used for generating sas tokens. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disable -Disables the use of managed storage account's key for generation of sas tokens. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableAutoRegenerateKey -Auto regenerate key. If true, then the managed storage account's inactive key gets auto regenerated -and becomes the new active key after the regeneration period. If false, then the keys of managed -storage account are not auto regenerated. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegenerationPeriod -Regeneration period. If auto regenerate key is enabled, this value specifies the timespan after -which managed storage account's inactive keygets auto regenerated and becomes the new active key. - -```yaml -Type: System.Nullable`1[System.TimeSpan] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.TimeSpan, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccount - -## NOTES - -## RELATED LINKS - -[AzureRM.KeyVault](/powershell/module/azurerm.keyvault) diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Add-AzureRmKeyVaultNetworkRule.md b/azurermps-6.13.0/AzureRM.KeyVault/Add-AzureRmKeyVaultNetworkRule.md deleted file mode 100644 index 8243ba0458..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Add-AzureRmKeyVaultNetworkRule.md +++ /dev/null @@ -1,260 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/add-azurermkeyvaultnetworkrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Add-AzureRmKeyVaultNetworkRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Add-AzureRmKeyVaultNetworkRule.md ---- - -# Add-AzureRmKeyVaultNetworkRule - -## SYNOPSIS -Adds a rule meant to restrict access to a key vault based on the client's internet address. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVaultName (Default) -``` -Add-AzureRmKeyVaultNetworkRule [-VaultName] <String> [[-ResourceGroupName] <String>] - [-IpAddressRange <String[]>] [-VirtualNetworkResourceId <String[]>] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByInputObject -``` -Add-AzureRmKeyVaultNetworkRule [-InputObject] <PSKeyVault> [-IpAddressRange <String[]>] - [-VirtualNetworkResourceId <String[]>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Add-AzureRmKeyVaultNetworkRule [-ResourceId] <String> [-IpAddressRange <String[]>] - [-VirtualNetworkResourceId <String[]>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmKeyVaultNetworkRule** cmdlet grants or restricts access to a key vault to a set of caller designated by their IP addresses or the virtual network to which they belong. The rule has the potential to restrict access for other users, applications, or security groups which have been granted permissions via the access policy. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> $frontendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" -ServiceEndpoint Microsoft.KeyVault -PS C:\> $virtualNetwork = New-AzureRmVirtualNetwork -Name myVNet -ResourceGroupName myRG -Location westus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet -PS C:\> $myNetworkResId = (Get-AzureRmVirtualNetwork -Name myVNet -ResourceGroupName myRG).Subnets[0].Id -PS C:\> Add-AzureRmKeyVaultNetworkRule -VaultName myvault -IpAddressRange "10.0.1.0/24" -VirtualNetworkResourceId $myNetworkResId -PassThru - -Vault Name : myvault -Resource Group Name : myRG -Location : westus -Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myRG/providers - /Microsoft.KeyVault/vaults/myvault -Vault URI : https://myvault.vault.azure.net/ -Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx -SKU : Standard -Enabled For Deployment? : True -Enabled For Template Deployment? : True -Enabled For Disk Encryption? : False -Soft Delete Enabled? : True -Access Policies : - Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx - Object ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx - Application ID : - Display Name : User Name (username@microsoft.com) - Permissions to Keys : get, create, delete, list, update, - import, backup, restore, recover - Permissions to Secrets : get, list, set, delete, backup, - restore, recover - Permissions to Certificates : get, delete, list, create, import, - update, deleteissuers, getissuers, listissuers, managecontacts, manageissuers, - setissuers, recover - Permissions to (Key Vault Managed) Storage : delete, deletesas, get, getsas, list, - listsas, regeneratekey, set, setsas, update - - -Network Rule Set : - Default Action : Allow - Bypass : AzureServices - IP Rules : 10.0.1.0/24 - Virtual Network Rules : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx- - xxxxxxxxxxxxx/resourcegroups/myRG/providers/microsoft.network/virtualnetworks/myvn - et/subnets/frontendsubnet - -Tags : -``` - -This command adds a network rule to the specified vault, allowing access to the specified IP address from the virtual network identified by $myNetworkResId. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -KeyVault object - -```yaml -Type: PSKeyVault -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IpAddressRange -Specifies allowed network IP address range of network rule. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -This Cmdlet does not return an object by default. -If this switch is specified, it returns the updated key vault object. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group associated with the key vault whose network rule is being modified. - -```yaml -Type: String -Parameter Sets: ByVaultName -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -KeyVault Resource Id - -```yaml -Type: String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of a key vault whose network rule is being modified. - -```yaml -Type: String -Parameter Sets: ByVaultName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkResourceId -Specifies allowed virtual network resource identifier of network rule. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.KeyVault/AzureRM.KeyVault.md b/azurermps-6.13.0/AzureRM.KeyVault/AzureRM.KeyVault.md deleted file mode 100644 index 52826a7c28..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/AzureRM.KeyVault.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -Module Name: AzureRM.KeyVault -Module Guid: D48CF693-4125-4D2D-8790-1514F44CE325 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault -Help Version: 4.0.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/AzureRM.KeyVault.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/AzureRM.KeyVault.md ---- - -# AzureRM.KeyVault Module -## Description -This topic displays help topics for the Azure Key Vault Cmdlets. - -## AzureRM.KeyVault Cmdlets -### [Add-AzureKeyVaultCertificate](Add-AzureKeyVaultCertificate.md) -Adds a certificate to a key vault. - -### [Add-AzureKeyVaultCertificateContact](Add-AzureKeyVaultCertificateContact.md) -Adds a contact for certificate notifications. - -### [Add-AzureKeyVaultKey](Add-AzureKeyVaultKey.md) -Creates a key in a key vault or imports a key into a key vault. - -### [Add-AzureKeyVaultManagedStorageAccount](Add-AzureKeyVaultManagedStorageAccount.md) -Adds an existing Azure Storage Account to the specified key vault for its keys to be managed by the Key Vault service. - -### [Backup-AzureKeyVaultCertificate](Backup-AzureKeyVaultCertificate.md) -Backs up a certificate in a key vault. - -### [Backup-AzureKeyVaultKey](Backup-AzureKeyVaultKey.md) -Backs up a key in a key vault. - -### [Backup-AzureKeyVaultManagedStorageAccount](Backup-AzureKeyVaultManagedStorageAccount.md) -Backs up a KeyVault-managed storage account. - -### [Backup-AzureKeyVaultSecret](Backup-AzureKeyVaultSecret.md) -Backs up a secret in a key vault. - -### [Get-AzureKeyVaultCertificate](Get-AzureKeyVaultCertificate.md) -Gets a certificate from a key vault. - -### [Get-AzureKeyVaultCertificateContact](Get-AzureKeyVaultCertificateContact.md) -Gets contacts that are registered for certificate notifications for a key vault. - -### [Get-AzureKeyVaultCertificateIssuer](Get-AzureKeyVaultCertificateIssuer.md) -Gets a certificate issuer for a key vault. - -### [Get-AzureKeyVaultCertificateOperation](Get-AzureKeyVaultCertificateOperation.md) -Gets the status of a certificate operation. - -### [Get-AzureKeyVaultCertificatePolicy](Get-AzureKeyVaultCertificatePolicy.md) -Gets the policy for a certificate in a key vault. - -### [Get-AzureKeyVaultKey](Get-AzureKeyVaultKey.md) -Gets Key Vault keys. - -### [Get-AzureKeyVaultManagedStorageAccount](Get-AzureKeyVaultManagedStorageAccount.md) -Gets Key Vault managed Azure Storage Accounts. - -### [Get-AzureKeyVaultManagedStorageSasDefinition](Get-AzureKeyVaultManagedStorageSasDefinition.md) -Gets Key Vault managed Storage SAS Definitions. - -### [Get-AzureKeyVaultSecret](Get-AzureKeyVaultSecret.md) -Gets the secrets in a key vault. - -### [Get-AzureRmKeyVault](Get-AzureRmKeyVault.md) -Gets key vaults. - -### [Import-AzureKeyVaultCertificate](Import-AzureKeyVaultCertificate.md) -Imports a certificate to a key vault. - -### [New-AzureKeyVaultCertificateAdministratorDetails](New-AzureKeyVaultCertificateAdministratorDetails.md) -Creates an in-memory certificate administrator details object. - -### [New-AzureKeyVaultCertificateOrganizationDetails](New-AzureKeyVaultCertificateOrganizationDetails.md) -Creates an in-memory certificate organization details object. - -### [New-AzureKeyVaultCertificatePolicy](New-AzureKeyVaultCertificatePolicy.md) -Creates an in-memory certificate policy object. - -### [New-AzureRmKeyVault](New-AzureRmKeyVault.md) -Creates a key vault. - -### [Remove-AzureKeyVaultCertificate](Remove-AzureKeyVaultCertificate.md) -Removes a certificate from a key vault. - -### [Remove-AzureKeyVaultCertificateContact](Remove-AzureKeyVaultCertificateContact.md) -Deletes a contact that is registered for certificate notifications from a key vault. - -### [Remove-AzureKeyVaultCertificateIssuer](Remove-AzureKeyVaultCertificateIssuer.md) -Deletes a certificate issuer from a key vault. - -### [Remove-AzureKeyVaultCertificateOperation](Remove-AzureKeyVaultCertificateOperation.md) -Deletes a certificate operation from a key vault. - -### [Remove-AzureKeyVaultKey](Remove-AzureKeyVaultKey.md) -Deletes a key in a key vault. - -### [Remove-AzureKeyVaultManagedStorageAccount](Remove-AzureKeyVaultManagedStorageAccount.md) -Removes a Key Vault managed Azure Storage Account and all associated SAS definitions. - -### [Remove-AzureKeyVaultManagedStorageSasDefinition](Remove-AzureKeyVaultManagedStorageSasDefinition.md) -Removes a Key Vault managed Azure Storage SAS definitions. - -### [Remove-AzureKeyVaultSecret](Remove-AzureKeyVaultSecret.md) -Deletes a secret in a key vault. - -### [Remove-AzureRmKeyVault](Remove-AzureRmKeyVault.md) -Deletes a key vault. - -### [Remove-AzureRmKeyVaultAccessPolicy](Remove-AzureRmKeyVaultAccessPolicy.md) -Removes all permissions for a user or application from a key vault. - -### [Restore-AzureKeyVaultCertificate](Restore-AzureKeyVaultCertificate.md) -Restores a certificate in a key vault from a backup file. - -### [Restore-AzureKeyVaultKey](Restore-AzureKeyVaultKey.md) -Creates a key in a key vault from a backed-up key. - -### [Restore-AzureKeyVaultManagedStorageAccount](Restore-AzureKeyVaultManagedStorageAccount.md) -Restores a managed storage account in a key vault from a backup file. - -### [Restore-AzureKeyVaultSecret](Restore-AzureKeyVaultSecret.md) -Creates a secret in a key vault from a backed-up secret. - -### [Set-AzureKeyVaultCertificateIssuer](Set-AzureKeyVaultCertificateIssuer.md) -Sets a certificate issuer in a key vault. - -### [Set-AzureKeyVaultCertificatePolicy](Set-AzureKeyVaultCertificatePolicy.md) -Creates or updates the policy for a certificate in a key vault. - -### [Set-AzureKeyVaultManagedStorageSasDefinition](Set-AzureKeyVaultManagedStorageSasDefinition.md) -Sets a Shared Access Signature (SAS) definition with Key Vault for a given Key Vault managed Azure Storage Account. - -### [Set-AzureKeyVaultSecret](Set-AzureKeyVaultSecret.md) -Creates or updates a secret in a key vault. - -### [Set-AzureRmKeyVaultAccessPolicy](Set-AzureRmKeyVaultAccessPolicy.md) -Grants or modifies existing permissions for a user, application, or security group to perform operations with a key vault. - -### [Stop-AzureKeyVaultCertificateOperation](Stop-AzureKeyVaultCertificateOperation.md) -Cancels a certificate operation in key vault. - -### [Undo-AzureKeyVaultCertificateRemoval](Undo-AzureKeyVaultCertificateRemoval.md) -Recovers a deleted certificate in a key vault into an active state. - -### [Undo-AzureKeyVaultKeyRemoval](Undo-AzureKeyVaultKeyRemoval.md) -Recovers a deleted key in a key vault into an active state. - -### [Undo-AzureKeyVaultManagedStorageAccountRemoval](Undo-AzureKeyVaultManagedStorageAccountRemoval.md) -Recovers a previously deleted KeyVault-managed storage account. - -### [Undo-AzureKeyVaultManagedStorageSasDefinitionRemoval](Undo-AzureKeyVaultManagedStorageSasDefinitionRemoval.md) -Recovers a previously deleted KeyVault-managed storage SAS definition. - -### [Undo-AzureKeyVaultSecretRemoval](Undo-AzureKeyVaultSecretRemoval.md) -Recovers a deleted secret in a key vault into an active state. - -### [Undo-AzureRmKeyVaultRemoval](Undo-AzureRmKeyVaultRemoval.md) -Recovers a deleted key vault into an active state. - -### [Update-AzureKeyVaultCertificate](Update-AzureKeyVaultCertificate.md) -Modifies editable attributes of a certificate. - -### [Update-AzureKeyVaultKey](Update-AzureKeyVaultKey.md) -Updates the attributes of a key in a key vault. - -### [Update-AzureKeyVaultManagedStorageAccount](Update-AzureKeyVaultManagedStorageAccount.md) -Update editable attributes of a Key Vault managed Azure Storage Account. - -### [Update-AzureKeyVaultManagedStorageAccountKey](Update-AzureKeyVaultManagedStorageAccountKey.md) -Regenerates the specified key of Key Vault managed Azure Storage Account. - -### [Update-AzureKeyVaultSecret](Update-AzureKeyVaultSecret.md) -Updates attributes of a secret in a key vault. - diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Backup-AzureKeyVaultCertificate.md b/azurermps-6.13.0/AzureRM.KeyVault/Backup-AzureKeyVaultCertificate.md deleted file mode 100644 index 207d48c338..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Backup-AzureKeyVaultCertificate.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/backup-azurekeyvaultcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Backup-AzureKeyVaultCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Backup-AzureKeyVaultCertificate.md ---- - -# Backup-AzureKeyVaultCertificate - -## SYNOPSIS -Backs up a certificate in a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByCertificateName (Default) -``` -Backup-AzureKeyVaultCertificate [-VaultName] <String> [-Name] <String> [[-OutputFile] <String>] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByCertificate -``` -Backup-AzureKeyVaultCertificate [-InputObject] <PSKeyVaultCertificateIdentityItem> [[-OutputFile] <String>] - [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Backup-AzureKeyVaultCertificate** cmdlet backs up a specified certificate in a key vault by downloading it and storing it in a file. -If the certificate has multiple versions, all its versions will be included in the backup. -Because the downloaded content is encrypted, it cannot be used outside of Azure Key Vault. -You can restore a backed-up certificate to any key vault in the subscription that it was backed up from, as long as the vault is in the same Azure geography. -Typical reasons to use this cmdlet are: -- You want to retain an offline copy of the certificate in case you accidentally delete the original from the vault. - -- You created a certificate using Key Vault and now want to clone the object into a different Azure region, so that you can use it from all instances of your distributed application. -Use the **Backup-AzureKeyVaultCertificate** cmdlet to retrieve the certificate in encrypted format and then use the **Restore-AzureKeyVaultCertificate** cmdlet -and specify a key vault in the second region. - -## EXAMPLES - -### Example 1: Back up a certificate with an automatically generated file name -```powershell -PS C:\Users\username\> Backup-AzureKeyVaultCertificate -VaultName 'mykeyvault' -Name 'mycert' - -C:\Users\username\mykeyvault-mycert-1527029447.01191 -``` - -This command retrieves the certificate named MyCert from the key vault named MyKeyVault and saves a backup of that certificate to a file that is automatically named for you, and displays the file name. - -### Example 2: Back up a certificate to a specified file name -```powershell -PS C:\> Backup-AzureKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyCert' -OutputFile 'C:\Backup.blob' - -C:\Backup.blob -``` - -This command retrieves the certificate named MyCert from the key vault named MyKeyVault and saves a backup of that certificate to a file named Backup.blob. - -### Example 3: Back up a previously retrieved certificate to a specified file name, overwriting the destination file without prompting. -```powershell -PS C:\> $cert = Get-AzureKeyVaultCertificate -VaultName 'MyKeyVault' -Name 'MyCert' -PS C:\> Backup-AzureKeyVaultCertificate -Certificate $cert -OutputFile 'C:\Backup.blob' -Force - -C:\Backup.blob -``` - -This command creates a backup of the certificate named $cert.Name in the vault named $cert.VaultName to a file named Backup.blob, silently overwriting the file if it exists already. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Overwrite the given file if it exists - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Secret to be backed up, pipelined in from the output of a retrieval call. - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIdentityItem -Parameter Sets: ByCertificate -Aliases: Certificate - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Secret name. -Cmdlet constructs the FQDN of a secret from vault name, currently selected environment and secret name. - -```yaml -Type: System.String -Parameter Sets: ByCertificateName -Aliases: SecretName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutputFile -Output file. -The output file to store the backup of the certificate. -If not specified, a default filename will be generated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: System.String -Parameter Sets: ByCertificateName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIdentityItem -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Backup-AzureKeyVaultKey.md b/azurermps-6.13.0/AzureRM.KeyVault/Backup-AzureKeyVaultKey.md deleted file mode 100644 index a3da5bb951..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Backup-AzureKeyVaultKey.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: A82392AA-B12B-443E-8704-7CF5A9F8ED58 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/backup-azurekeyvaultkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Backup-AzureKeyVaultKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Backup-AzureKeyVaultKey.md ---- - -# Backup-AzureKeyVaultKey - -## SYNOPSIS -Backs up a key in a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByKeyName (Default) -``` -Backup-AzureKeyVaultKey [-VaultName] <String> [-Name] <String> [[-OutputFile] <String>] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByKey -``` -Backup-AzureKeyVaultKey [-InputObject] <PSKeyVaultKeyIdentityItem> [[-OutputFile] <String>] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Backup-AzureKeyVaultKey** cmdlet backs up a specified key in a key vault by downloading it and storing it in a file. -If there are multiple versions of the key, all versions are included in the backup. -Because the downloaded content is encrypted, it cannot be used outside of Azure Key Vault. -You can restore a backed-up key to any key vault in the subscription that it was backed up from. -Typical reasons to use this cmdlet are: -- You want to escrow a copy of your key, so that you have an offline copy in case you accidentally delete your key in your key vault. - -- You created a key using Key Vault and now want to clone the key into a different Azure region, so that you can use it from all instances of your distributed application. -Use the **Backup-AzureKeyVaultKey** cmdlet to retrieve the key in encrypted format and then use the Restore-AzureKeyVaultKey cmdlet and specify a key vault in the second region. - -## EXAMPLES - -### Example 1: Back up a key with an automatically generated file name -```powershell -PS C:\Users\username\> Backup-AzureKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey' - -C:\Users\username\mykeyvault-mykey-1527029447.01191 -``` - -This command retrieves the key named MyKey from the key vault named MyKeyVault and saves a backup of that key to a file that is automatically named for you, and displays the file name. - -### Example 2: Back up a key to a specified file name -```powershell -PS C:\> Backup-AzureKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey' -OutputFile 'C:\Backup.blob' - -C:\Backup.blob -``` - -This command retrieves the key named MyKey from the key vaultnamed MyKeyVault and saves a backup of that key to a file named Backup.blob. - -### Example 3: Back up a previously retrieved key to a specified file name, overwriting the destination file without prompting. -```powershell -PS C:\> $key = Get-AzureKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey' -PS C:\> Backup-AzureKeyVaultKey -Key $key -OutputFile 'C:\Backup.blob' -Force - -C:\Backup.blob -``` - -This command creates a backup of the key named $key.Name in the vault named $key.VaultName to a file named Backup.blob, silently overwriting the file if it exists already. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Overwrite the given file if it exists - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Key bundle to back up, pipelined in from the output of a retrieval call. - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKeyIdentityItem -Parameter Sets: ByKey -Aliases: Key - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the key to back up. - -```yaml -Type: System.String -Parameter Sets: ByKeyName -Aliases: KeyName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutputFile -Specifies the output file in which the backup blob is stored. -If you do not specify this parameter, this cmdlet generates a file name for you. -If you specify the name of an existing output file, the operation will not complete and returns an error message that the backup file already exists. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault that contains the key to back up. - -```yaml -Type: System.String -Parameter Sets: ByKeyName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKeyIdentityItem -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Add-AzureKeyVaultKey](./Add-AzureKeyVaultKey.md) - -[Get-AzureKeyVaultKey](./Get-AzureKeyVaultKey.md) - -[Remove-AzureKeyVaultKey](./Remove-AzureKeyVaultKey.md) - -[Restore-AzureKeyVaultKey](./Restore-AzureKeyVaultKey.md) - diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Backup-AzureKeyVaultManagedStorageAccount.md b/azurermps-6.13.0/AzureRM.KeyVault/Backup-AzureKeyVaultManagedStorageAccount.md deleted file mode 100644 index 347deb836c..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Backup-AzureKeyVaultManagedStorageAccount.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/backup-azurekeyvaultmanagedstorageaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Backup-AzureKeyVaultManagedStorageAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Backup-AzureKeyVaultManagedStorageAccount.md ---- - -# Backup-AzureKeyVaultManagedStorageAccount - -## SYNOPSIS -Backs up a KeyVault-managed storage account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByStorageAccountName (Default) -``` -Backup-AzureKeyVaultManagedStorageAccount [-VaultName] <String> [-Name] <String> [[-OutputFile] <String>] - [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByStorageAccount -``` -Backup-AzureKeyVaultManagedStorageAccount [-InputObject] <PSKeyVaultManagedStorageAccountIdentityItem> - [[-OutputFile] <String>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Backup-AzureKeyVaultManagedStorageAccount** cmdlet backs up a specified managed storage account in a key vault by downloading it and storing it in a file. -Because the downloaded content is encrypted, it cannot be used outside of Azure Key Vault. -You can restore a backed-up storage account to any key vault in the subscription that it was backed up from, as long as the vault is in the same Azure geography. -Typical reasons to use this cmdlet are: -- You want to retain an offline copy of the storage account in case you accidentally delete the original from the vault. - -- You created a managed storage account using Key Vault and now want to clone the object into a different Azure region, so that you can use it from all instances of your distributed application. -Use the **Backup-AzureKeyVaultManagedStorageAccount** cmdlet to retrieve the managed storage account in encrypted format and then use the **Restore-AzureKeyVaultManagedStorageAccount** cmdlet -and specify a key vault in the second region. - -## EXAMPLES - -### Example 1: Back up a managed storage account with an automatically generated file name -```powershell -PS C:\Users\username\> Backup-AzureKeyVaultManagedStorageAccount -VaultName 'MyKeyVault' -Name 'MyMSAK' - -C:\Users\username\mykeyvault-mymsak-1527029447.01191 -``` - -This command retrieves the managed storage account named MyMSAK from the key vault named MyKeyVault and saves a backup of that managed storage account to a file that is automatically named for you, and displays the file name. - -### Example 2: Back up a managed storage account to a specified file name -```powershell -PS C:\> Backup-AzureKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyMSAK' -OutputFile 'C:\Backup.blob' - -C:\Backup.blob -``` - -This command retrieves the managed storage account named MyMSAK from the key vault named MyKeyVault and saves a backup of that managed storage account to a file named Backup.blob. - -### Example 3: Back up a previously retrieved managed storage account to a specified file name, overwriting the destination file without prompting. -```powershell -PS C:\> $msak = Get-AzureKeyVaultManagedStorageAccount -VaultName 'MyKeyVault' -Name 'MyMSAK' -PS C:\> Backup-AzureKeyVaultManagedStorageAccount -StorageAccount $msak -OutputFile 'C:\Backup.blob' -Force - -C:\Backup.blob -``` - -This command creates a backup of the managed storage account named $msak.Name in the vault named $msak.VaultName to a file named Backup.blob, silently overwriting the file if it exists already. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Overwrite the given file if it exists - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Storage account bundle to be backed up, pipelined in from the output of a retrieval call. - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccountIdentityItem -Parameter Sets: ByStorageAccount -Aliases: StorageAccount - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Secret name. -Cmdlet constructs the FQDN of a secret from vault name, currently selected environment and secret name. - -```yaml -Type: System.String -Parameter Sets: ByStorageAccountName -Aliases: StorageAccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutputFile -Output file. -The output file to store the storage account backup. -If not specified, a default filename will be generated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: System.String -Parameter Sets: ByStorageAccountName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccountIdentityItem -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Backup-AzureKeyVaultSecret.md b/azurermps-6.13.0/AzureRM.KeyVault/Backup-AzureKeyVaultSecret.md deleted file mode 100644 index 62a89ae7d8..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Backup-AzureKeyVaultSecret.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 80AAA327-77C6-4372-9461-FFED5A15E678 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/backup-azurekeyvaultsecret -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Backup-AzureKeyVaultSecret.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Backup-AzureKeyVaultSecret.md ---- - -# Backup-AzureKeyVaultSecret - -## SYNOPSIS -Backs up a secret in a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### BySecretName (Default) -``` -Backup-AzureKeyVaultSecret [-VaultName] <String> [-Name] <String> [[-OutputFile] <String>] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### BySecret -``` -Backup-AzureKeyVaultSecret [-InputObject] <PSKeyVaultSecretIdentityItem> [[-OutputFile] <String>] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Backup-AzureKeyVaultSecret** cmdlet backs up a specified secret in a key vault by downloading it and storing it in a file. -If there are multiple versions of the secret, all versions are included in the backup. -Because the downloaded content is encrypted, it cannot be used outside of Azure Key Vault. -You can restore a backed-up secret to any key vault in the subscription that it was backed up from. -Typical reasons to use this cmdlet are: -- You want to escrow a copy of your secret, so that you have an offline copy in case you accidentally delete your secret in your key vault. -- You added a secret to a key vault and now want to clone the secret into a different Azure region, so that you can use it from all instances of your distributed application. Use the Backup-AzureKeyVaultSecret cmdlet to retrieve the secret in encrypted format and then use the Restore-AzureKeyVaultSecret cmdlet and specify a key vault in the second region. (Note that the regions must belong to the same geography.) - -## EXAMPLES - -### Example 1: Back up a secret with an automatically generated file name -```powershell -PS C:\Users\username\> Backup-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret' - -C:\Users\username\mykeyvault-mysecret-1527029447.01191 -``` - -This command retrieves the secret named MySecret from the key vault named MyKeyVault and saves a backup of that secret to a file that is automatically named for you, and displays the file name. - -### Example 2: Back up a secret to a specified file name, overwriting the existing file without prompting -```powershell -PS C:\> Backup-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret' -OutputFile 'C:\Backup.blob' -Force - -C:\Backup.blob -``` - -This command retrieves the secret named MySecret from the key vaultnamed MyKeyVault and saves a backup of that secret to a file named Backup.blob. - -### Example 3: Back up a secret previously retrieved to a specified file name -```powershell -PS C:\> $secret = Get-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret' -PS C:\> Backup-AzureKeyVaultSecret -Secret $secret -OutputFile 'C:\Backup.blob' - -C:\Backup.blob -``` - -This command uses the $secret object's vault name and name to retrieves the secret and saves its backup to a file named Backup.blob. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Prompts you for confirmation before overwriting the output file, if that exists. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Secret to be backed up, pipelined in from the output of a retrieval call. - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultSecretIdentityItem -Parameter Sets: BySecret -Aliases: Secret - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the secret to back up. - -```yaml -Type: System.String -Parameter Sets: BySecretName -Aliases: SecretName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutputFile -Specifies the output file in which the backup blob is stored. -If you do not specify this parameter, this cmdlet generates a file name for you. -If you specify the name of an existing output file, the operation will not complete and returns an error message that the backup file already exists. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault that contains the secret to back up. - -```yaml -Type: System.String -Parameter Sets: BySecretName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultSecretIdentityItem -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Set-AzureKeyVaultSecret](./Set-AzureKeyVaultSecret.md) - -[Get-AzureKeyVaultSecret](./Get-AzureKeyVaultSecret.md) - -[Remove-AzureKeyVaultSecret](./Remove-AzureKeyVaultSecret.md) - -[Restore-AzureKeyVaultSecret](./Restore-AzureKeyVaultSecret.md) - diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultCertificate.md b/azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultCertificate.md deleted file mode 100644 index e659c80f6b..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultCertificate.md +++ /dev/null @@ -1,363 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 363FA51E-D075-4800-A4BE-BFF63FD25C90 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/get-azurekeyvaultcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultCertificate.md ---- - -# Get-AzureKeyVaultCertificate - -## SYNOPSIS -Gets a certificate from a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByName (Default) -``` -Get-AzureKeyVaultCertificate [-VaultName] <String> [[-Name] <String>] [-InRemovedState] - [-IncludePending] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByCertificateNameAndVersion -``` -Get-AzureKeyVaultCertificate [-VaultName] <String> [-Name] <String> [-Version] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByCertificateAllVersions -``` -Get-AzureKeyVaultCertificate [-VaultName] <String> [-Name] <String> [-IncludeVersions] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByNameInputObject -``` -Get-AzureKeyVaultCertificate [-InputObject] <PSKeyVault> [[-Name] <String>] [-InRemovedState] - [-IncludePending] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByCertificateNameAndVersionInputObject -``` -Get-AzureKeyVaultCertificate [-InputObject] <PSKeyVault> [-Name] <String> [-Version] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByCertificateAllVersionsInputObject -``` -Get-AzureKeyVaultCertificate [-InputObject] <PSKeyVault> [-Name] <String> [-IncludeVersions] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByNameResourceId -``` -Get-AzureKeyVaultCertificate [-ResourceId] <String> [[-Name] <String>] [-InRemovedState] - [-IncludePending] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByCertificateNameAndVersionResourceId -``` -Get-AzureKeyVaultCertificate [-ResourceId] <String> [-Name] <String> [-Version] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByCertificateAllVersionsResourceId -``` -Get-AzureKeyVaultCertificate [-ResourceId] <String> [-Name] <String> [-IncludeVersions] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureKeyVaultCertificate** cmdlet gets the specified certificate or the versions of a certificate from a key vault in Azure Key Vault. - -## EXAMPLES - -### Example 1: Get a certificate -```powershell -PS C:\> Get-AzureKeyVaultCertificate -VaultName "ContosoKV01" -Name "TestCert01" -Name : testCert01 -Certificate : [Subject] - CN=contoso.com - - [Issuer] - CN=contoso.com - - [Serial Number] - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - - [Not Before] - 2/8/2016 3:11:45 PM - - [Not After] - 8/8/2016 4:21:45 PM - - [Thumbprint] - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - -Thumbprint : XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX -Tags : -Enabled : True -Created : 2/8/2016 11:21:45 PM -Updated : 2/8/2016 11:21:45 PM -``` - -This command gets the certificate named TestCert01 from the key vault named ContosoKV01. - -### Example 2: Get all the certificates that have been deleted but not purged for this key vault. -```powershell -PS C:\> Get-AzureKeyVaultCertificate -VaultName 'contoso' -InRemovedState - -DeletedDate : 5/24/2018 6:08:32 PM -Enabled : True -Expires : 11/24/2018 6:08:13 PM -NotBefore : 5/24/2018 5:58:13 PM -Created : 5/24/2018 6:08:13 PM -Updated : 5/24/2018 6:08:13 PM -Tags : -VaultName : contoso -Name : test1 -Version : -Id : https://contoso.vault.azure.net:443/certificates/test1 - -ScheduledPurgeDate : 8/22/2018 6:10:47 PM -DeletedDate : 5/24/2018 6:10:47 PM -Enabled : True -Expires : 11/24/2018 6:09:44 PM -NotBefore : 5/24/2018 5:59:44 PM -Created : 5/24/2018 6:09:44 PM -Updated : 5/24/2018 6:09:44 PM -Tags : -VaultName : contoso -Name : test2 -Version : -Id : https://contoso.vault.azure.net:443/certificates/test2 -``` - -This command gets all the certificates that have been previously deleted, but not purged, in the key vault named Contoso. - -### Example 3: Gets the certificate MyCert that has been deleted but not purged for this key vault. -```powershell -PS C:\> Get-AzureKeyVaultCertificate -VaultName 'contoso' -Name 'test1' -InRemovedState - -Certificate : [Subject] - CN=contoso.com - - [Issuer] - CN=contoso.com - - [Serial Number] - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - - [Not Before] - 5/24/2018 10:58:13 AM - - [Not After] - 11/24/2018 10:08:13 AM - - [Thumbprint] - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - -KeyId : https://contoso.vault.azure.net:443/keys/test1/7fe415d5518240c1a6fce89986b8d334 -SecretId : https://contoso.vault.azure.net:443/secrets/test1/7fe415d5518240c1a6fce89986b8d334 -Thumbprint : XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX -RecoveryLevel : Recoverable+Purgeable -ScheduledPurgeDate : 8/22/2018 6:08:32 PM -DeletedDate : 5/24/2018 6:08:32 PM -Enabled : True -Expires : 11/24/2018 6:08:13 PM -NotBefore : 5/24/2018 5:58:13 PM -Created : 5/24/2018 6:08:13 PM -Updated : 5/24/2018 6:08:13 PM -Tags : -VaultName : contoso -Name : test1 -Version : 7fe415d5518240c1a6fce89986b8d334 -Id : https://contoso.vault.azure.net:443/certificates/test1/7fe415d5518240c1a6fce89986b8d334 -``` - -This command gets the certificate named 'MyCert' that has been previously deleted, but not purged, in the key vault named Contoso. -This command will return metadata such as the deletion date, and the scheduled purging date of this deleted certificate. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeVersions -Indicates that this operation gets all versions of the certificate. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByCertificateAllVersions, ByCertificateAllVersionsInputObject, ByCertificateAllVersionsResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -KeyVault object. - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault -Parameter Sets: ByNameInputObject, ByCertificateNameAndVersionInputObject, ByCertificateAllVersionsInputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InRemovedState -Specifies whether to include previously deleted certificates in the output - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByName, ByNameInputObject, ByNameResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the certificate to get. - -```yaml -Type: System.String -Parameter Sets: ByName, ByNameInputObject, ByNameResourceId -Aliases: CertificateName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ByCertificateNameAndVersion, ByCertificateAllVersions, ByCertificateNameAndVersionInputObject, ByCertificateAllVersionsInputObject, ByCertificateNameAndVersionResourceId, ByCertificateAllVersionsResourceId -Aliases: CertificateName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -KeyVault Resource Id. - -```yaml -Type: System.String -Parameter Sets: ByNameResourceId, ByCertificateNameAndVersionResourceId, ByCertificateAllVersionsResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of a key vault. - -```yaml -Type: System.String -Parameter Sets: ByName, ByCertificateNameAndVersion, ByCertificateAllVersions -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Version -Specifies the version of a certificate. - -```yaml -Type: System.String -Parameter Sets: ByCertificateNameAndVersion, ByCertificateNameAndVersionInputObject, ByCertificateNameAndVersionResourceId -Aliases: CertificateVersion - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludePending -Specifies whether to include pending certificates in the output - -```yaml -Type: SwitchParameter -Parameter Sets: ByName, ByNameInputObject, ByNameResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIdentityItem - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificate - -### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultCertificate - -### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultCertificateIdentityItem - -## NOTES - -## RELATED LINKS - -[Add-AzureKeyVaultCertificate](./Add-AzureKeyVaultCertificate.md) - -[Import-AzureKeyVaultCertificate](./Import-AzureKeyVaultCertificate.md) - -[Remove-AzureKeyVaultCertificate](./Remove-AzureKeyVaultCertificate.md) - diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultCertificateContact.md b/azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultCertificateContact.md deleted file mode 100644 index b8874dfefe..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultCertificateContact.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 200C68A3-A79C-4517-8E5D-8128F6C73A5C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/get-azurekeyvaultcertificatecontact -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultCertificateContact.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultCertificateContact.md ---- - -# Get-AzureKeyVaultCertificateContact - -## SYNOPSIS -Gets contacts that are registered for certificate notifications for a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### VaultName (Default) -``` -Get-AzureKeyVaultCertificateContact [-VaultName] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByInputObject -``` -Get-AzureKeyVaultCertificateContact [-InputObject] <PSKeyVault> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByResourceId -``` -Get-AzureKeyVaultCertificateContact [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureKeyVaultCertificateContact** cmdlet gets contacts that are registered for certificate notifications for a key vault in Azure Key Vault. - -## EXAMPLES - -### Example 1: Get all certificate contacts -```powershell -PS C:\> $Contacts = Get-AzureKeyVaultCertificateContact -VaultName "Contoso" - -Email VaultName ------ --------- -username@microsoft.com Contoso -username1@microsoft.com Contoso -``` - -This command gets all of the contacts for the certificate objects in the Contoso key vault, and then stores them in the $Contacts variable. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -KeyVault object. - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceId -KeyVault Id. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault. - -```yaml -Type: System.String -Parameter Sets: VaultName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateContact - -## NOTES - -## RELATED LINKS - -[Add-AzureKeyVaultCertificateContact](./Add-AzureKeyVaultCertificateContact.md) - -[Remove-AzureKeyVaultCertificateContact](./Remove-AzureKeyVaultCertificateContact.md) - diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultCertificateIssuer.md b/azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultCertificateIssuer.md deleted file mode 100644 index 7f30eee7ca..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultCertificateIssuer.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 5F856280-C561-47B5-AA96-27E34C86D604 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/get-azurekeyvaultcertificateissuer -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultCertificateIssuer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultCertificateIssuer.md ---- - -# Get-AzureKeyVaultCertificateIssuer - -## SYNOPSIS -Gets a certificate issuer for a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByName (Default) -``` -Get-AzureKeyVaultCertificateIssuer [-VaultName] <String> [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByInputObject -``` -Get-AzureKeyVaultCertificateIssuer [-InputObject] <PSKeyVault> [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByResourceId -``` -Get-AzureKeyVaultCertificateIssuer [-ResourceId] <String> [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureKeyVaultCertificateIssuer** cmdlet gets a specified certificate issuer or all certificate issuers for a key vault in Azure Key Vault. - -## EXAMPLES - -### Example 1: Get a certificate issuer -```powershell -PS C:\> Get-AzureKeyVaultCertificateIssuer -VaultName "Contosokv01" -Name "TestIssuer01" - -AccountId : 555 -ApiKey : -OrganizationDetails : Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateOrganizationDetails -Name : TestIssuer01 -IssuerProvider : Test -VaultName : Contosokv01 -``` - -This command gets the certificate issuer named TestIssuer01. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -KeyVault object. - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the certificate issuer to get. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: IssuerName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -KeyVault Resource Id. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of a key vault. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIssuerIdentityItem - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIssuer - -## NOTES - -## RELATED LINKS - -[Remove-AzureKeyVaultCertificateIssuer](./Remove-AzureKeyVaultCertificateIssuer.md) - -[Set-AzureKeyVaultCertificateIssuer](./Set-AzureKeyVaultCertificateIssuer.md) - - diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultCertificateOperation.md b/azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultCertificateOperation.md deleted file mode 100644 index 9a04e5b5f5..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultCertificateOperation.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 0743C43D-2A1F-4950-B0F3-1FED4014EEC5 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/get-azurekeyvaultcertificateoperation -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultCertificateOperation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultCertificateOperation.md ---- - -# Get-AzureKeyVaultCertificateOperation - -## SYNOPSIS -Gets the status of a certificate operation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByName (Default) -``` -Get-AzureKeyVaultCertificateOperation [-VaultName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByInputObject -``` -Get-AzureKeyVaultCertificateOperation [-InputObject] <PSKeyVaultCertificateIdentityItem> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureKeyVaultCertificateOperation** cmdlet gets the status of a certificate operation. - -## EXAMPLES - -### Example 1: Get the status of a certificate operation -```powershell -PS C:\> Get-AzureKeyVaultCertificateOperation -VaultName "contosoKV01" -Name "TestCert01" - -Id : https://contosoKV01.vault.azure.net/certificates/TestCert01/pending -Status : inProgress -StatusDetails : Pending certificate created. Certificate request is in progress. This may take some time - based on the issuer provider. Please check again later. -RequestId : 32a63e80568442a2892dafb9f7cf366t -Target : -Issuer : Self -CancellationRequested : False -CertificateSigningRequest : MIICpjCCAY4CAQAwFjEUMBIGA1UEAxMLY29udG9zby5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC73w3VRBOlgJ5Od1PjDh+2ytngNZp+ZP4fkuX8K1Ti5LA6Ih7eWx1fgAN/iTb6l - 5K6LvAIJvsTNVePMNxfSdaEIJ70Inm45wVU4A/kf+UxQWAYVMsBrLtDFWxnVhzf6n7RGYke6HLBj3j5ASb9g+olSs6eON25ibF0t+u6JC+sIR0LmVGar9Q0eZys1rdfzJBIKq+laOM7z2pJijb5ANqve9 - i7rH5mnhQk4V8WsRstOhYR9jgLqSSxokDoeaBClIOidSBYqVc1yNv4ASe1UWUCR7ZK6OQXiecNWSWPmgWEyawu6AR9eb1YotCr2ScheMOCxlm3103luitxrd8A7kMjAgMBAAGgSzBJBgkqhkiG9w0BCQ4 - xPDA6MA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwCQYDVR0TBAIwADANBgkqhkiG9w0BAQsFAAOCAQEAIHhsDJV37PKi8hor5eQf7+Tct1preIvSwqV0NF6Uo7O6 - YnC9Py7Wp7CHfKzuqeptUk2Tsu7B5dHB+o9Ypeeqw8fWhTN0GFGRKO7WjZQlDqL+lRNcjlFSaP022oIP0kmvVhBcmZqRQlALXccAaxEclFA/3y/aNj2gwWeKpH/pwAkZ39zMEzpQCaRfnQk7e3l4MV8cf - eC2HPYdRWkXxAeDcNPxBuVmKy49AzYvly+APNVDU3v66gxl3fIKrGRsKi2Cp/nO5rBxG2h8t+0Za4l/HJ7ZWR9wKbd/xg7JhdZZFVBxMHYzw8KQ0ys13x8HY+PXU92Y7yD3uC2Rcj+zbAf+Kg== -ErrorCode : -ErrorMessage : -Name : -VaultName : -``` - -This command gets the status of the certificate operation for TestCert01 on the ContosoKV01 key vault. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Certificate Object. - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIdentityItem -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a certificate. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: CertificateName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of a key vault. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIdentityItem -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateOperation - -## NOTES - -## RELATED LINKS - -[Remove-AzureKeyVaultCertificateOperation](./Remove-AzureKeyVaultCertificateOperation.md) - -[Stop-AzureKeyVaultCertificateOperation](./Stop-AzureKeyVaultCertificateOperation.md) - diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultCertificatePolicy.md b/azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultCertificatePolicy.md deleted file mode 100644 index 0f3c787402..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultCertificatePolicy.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 0729687C-3104-4136-A80D-16BAEBD6B76C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/get-azurekeyvaultcertificatepolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultCertificatePolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultCertificatePolicy.md ---- - -# Get-AzureKeyVaultCertificatePolicy - -## SYNOPSIS -Gets the policy for a certificate in a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### VaultAndCertName (Default) -``` -Get-AzureKeyVaultCertificatePolicy [-VaultName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### InputObject -``` -Get-AzureKeyVaultCertificatePolicy [-InputObject] <PSKeyVaultCertificateIdentityItem> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureKeyVaultCertificatePolicy** cmdlet gets the policy for a certificate in a key vault in Azure Key Vault. - -## EXAMPLES - -### Example 1: Get a certificate policy -```powershell -PS C:\ >Get-AzureKeyVaultCertificatePolicy -VaultName "ContosoKV01" -Name "TestCert01" - -SecretContentType : application/x-pkcs12 -Kty : RSA -KeySize : 2048 -Exportable : True -ReuseKeyOnRenewal : True -SubjectName : CN=contoso.com -DnsNames : -Ekus : {1.3.6.1.5.5.7.3.1, 1.3.6.1.5.5.7.3.2} -ValidityInMonths : 6 -IssuerName : Self -CertificateType : -RenewAtNumberOfDaysBeforeExpiry : -RenewAtPercentageLifetime : 80 -EmailAtNumberOfDaysBeforeExpiry : -EmailAtPercentageLifetime : -Enabled : True -Created : 2/8/2016 11:10:29 PM -Updated : 2/8/2016 11:10:29 PM -``` - -This command gets the certificate policy for TestCert01 certificate in the ContosoKV01 key vault. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Certificate Object. - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIdentityItem -Parameter Sets: InputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a certificate. - -```yaml -Type: System.String -Parameter Sets: VaultAndCertName -Aliases: CertificateName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of a key vault. - -```yaml -Type: System.String -Parameter Sets: VaultAndCertName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIdentityItem -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificatePolicy - -## NOTES - -## RELATED LINKS - -[New-AzureKeyVaultCertificatePolicy](./New-AzureKeyVaultCertificatePolicy.md) - -[Set-AzureKeyVaultCertificatePolicy](./Set-AzureKeyVaultCertificatePolicy.md) - diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultKey.md b/azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultKey.md deleted file mode 100644 index 285c9a8d29..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultKey.md +++ /dev/null @@ -1,391 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 2BE34AE1-06FA-4F66-8FDB-CED22C2E0978 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/get-azurekeyvaultkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultKey.md ---- - -# Get-AzureKeyVaultKey - -## SYNOPSIS -Gets Key Vault keys. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVaultName (Default) -``` -Get-AzureKeyVaultKey [-VaultName] <String> [[-Name] <String>] [-InRemovedState] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByKeyName -``` -Get-AzureKeyVaultKey [-VaultName] <String> [-Name] <String> [-Version] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByKeyVersions -``` -Get-AzureKeyVaultKey [-VaultName] <String> [-Name] <String> [-IncludeVersions] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByInputObjectVaultName -``` -Get-AzureKeyVaultKey [-InputObject] <PSKeyVault> [[-Name] <String>] [-InRemovedState] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByInputObjectKeyName -``` -Get-AzureKeyVaultKey [-InputObject] <PSKeyVault> [-Name] <String> [-Version] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByInputObjectKeyVersions -``` -Get-AzureKeyVaultKey [-InputObject] <PSKeyVault> [-Name] <String> [-IncludeVersions] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByResourceIdVaultName -``` -Get-AzureKeyVaultKey [-ResourceId] <String> [[-Name] <String>] [-InRemovedState] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByResourceIdKeyName -``` -Get-AzureKeyVaultKey [-ResourceId] <String> [-Name] <String> [-Version] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByResourceIdKeyVersions -``` -Get-AzureKeyVaultKey [-ResourceId] <String> [-Name] <String> [-IncludeVersions] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureKeyVaultKey** cmdlet gets Azure Key Vault keys. -This cmdlet gets a specific **Microsoft.Azure.Commands.KeyVault.Models.KeyBundle** or a list of all **KeyBundle** objects in a key vault or by version. - -## EXAMPLES - -### Example 1: Get all the keys in a key vault -```powershell -PS C:\> Get-AzureKeyVaultKey -VaultName 'contoso' - -Vault Name : contoso -Name : test1 -Version : -Id : https://contoso.vault.azure.net:443/keys/test1 -Enabled : True -Expires : 11/24/2018 6:08:13 PM -Not Before : 5/24/2018 5:58:13 PM -Created : 5/24/2018 6:08:13 PM -Updated : 5/24/2018 6:08:13 PM -Purge Disabled : False -Tags : - -Vault Name : contoso -Name : test2 -Version : -Id : https://contoso.vault.azure.net:443/keys/test2 -Enabled : True -Expires : 11/24/2018 6:09:44 PM -Not Before : 5/24/2018 5:59:44 PM -Created : 5/24/2018 6:09:44 PM -Updated : 5/24/2018 6:09:44 PM -Purge Disabled : False -Tags : -``` - -This command gets all the keys in the key vault named Contoso. - -### Example 2: Get the current version of a key -```powershell -PS C:\> Get-AzureKeyVaultKey -VaultName 'contoso' -KeyName 'test1' - -Vault Name : contoso -Name : test1 -Version : 7fe415d5518240c1a6fce89986b8d334 -Id : https://contoso.vault.azure.net:443/keys/test1/7fe415d5518240c1a6fce89986b8d334 -Enabled : True -Expires : 11/24/2018 6:08:13 PM -Not Before : 5/24/2018 5:58:13 PM -Created : 5/24/2018 6:08:13 PM -Updated : 5/24/2018 6:08:13 PM -Purge Disabled : False -Tags : -``` - -This command gets the current version of the key named test1 in the key vault named Contoso. - -### Example 3: Get all versions of a key -```powershell -PS C:\> Get-AzureKeyVaultKey -VaultName 'contoso' -KeyName 'test1' -IncludeVersions - -Vault Name : contoso -Name : test1 -Version : 7fe415d5518240c1a6fce89986b8d334 -Id : https://contoso.vault.azure.net:443/keys/test1/7fe415d5518240c1a6fce89986b8d334 -Enabled : True -Expires : 11/24/2018 6:08:13 PM -Not Before : 5/24/2018 5:58:13 PM -Created : 5/24/2018 6:08:13 PM -Updated : 5/24/2018 6:08:13 PM -Purge Disabled : False -Tags : - -Vault Name : contoso -Name : test1 -Version : e4e95940e669407fbdb4298bc21a3e1d -Id : https://contoso.vault.azure.net:443/keys/test1/e4e95940e669407fbdb4298bc21a3e1d -Enabled : False -Expires : 11/24/2018 6:08:08 PM -Not Before : 5/24/2018 5:58:08 PM -Created : 5/24/2018 6:08:08 PM -Updated : 5/24/2018 6:08:08 PM -Purge Disabled : False -Tags : -``` - -This command gets all versions the key named ITPfx in the key vaultnamed Contoso. - -### Example 4: Get a specific version of a key -```powershell -PS C:\> Get-AzureKeyVaultKey -VaultName 'contoso' -KeyName 'test1' -Version 'e4e95940e669407fbdb4298bc21a3e1d' - -Vault Name : contoso -Name : test1 -Version : e4e95940e669407fbdb4298bc21a3e1d -Id : https://contoso.vault.azure.net:443/keys/test1/e4e95940e669407fbdb4298bc21a3e1d -Enabled : False -Expires : 11/24/2018 6:08:08 PM -Not Before : 5/24/2018 5:58:08 PM -Created : 5/24/2018 6:08:08 PM -Updated : 5/24/2018 6:08:08 PM -Purge Disabled : False -Tags : -``` - -This command gets a specific version of the key named test1 in the key vault named Contoso. -After running this command, you can inspect various properties of the key by navigating the $Key object. - -### Example 5: Get all the keys that have been deleted but not purged for this key vault. -```powershell -PS C:\> Get-AzureKeyVaultKey -VaultName 'contoso' -InRemovedState - -Vault Name : contoso -Name : test3 -Id : https://contoso.vault.azure.net:443/keys/test3 -Deleted Date : 5/24/2018 8:32:42 PM -Scheduled Purge Date : 8/22/2018 8:32:42 PM -Enabled : True -Expires : -Not Before : -Created : 5/24/2018 8:32:27 PM -Updated : 5/24/2018 8:32:27 PM -Purge Disabled : False -Tags : -``` - -This command gets all the keys that have been previously deleted, but not purged, in the key vault named Contoso. - -### Example 6: Gets the key ITPfx that has been deleted but not purged for this key vault. -```powershell -PS C:\> Get-AzureKeyVaultKey -VaultName 'contoso' -KeyName 'test3' -InRemovedState - -Vault Name : contoso -Name : test3 -Id : https://contoso.vault.azure.net:443/keys/test3/1af807cc331a49d0b52b7c75e1b2366e -Deleted Date : 5/24/2018 8:32:42 PM -Scheduled Purge Date : 8/22/2018 8:32:42 PM -Enabled : True -Expires : -Not Before : -Created : 5/24/2018 8:32:27 PM -Updated : 5/24/2018 8:32:27 PM -Purge Disabled : False -Tags : -``` - -This command gets the key test3 that has been previously deleted, but not purged, in the key vault named Contoso. -This command will return metadata such as the deletion date, and the scheduled purging date of this deleted key. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeVersions -Indicates that this cmdlet gets all versions of a key. -The current version of a key is the first one on the list. -If you specify this parameter you must also specify the *Name* and *VaultName* parameters. -If you do not specify the *IncludeVersions* parameter, this cmdlet gets the current version of the key with the specified *Name*. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByKeyVersions, ByInputObjectKeyVersions, ByResourceIdKeyVersions -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -KeyVault object. - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault -Parameter Sets: ByInputObjectVaultName, ByInputObjectKeyName, ByInputObjectKeyVersions -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InRemovedState -Specifies whether to show the previously deleted keys in the output - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByVaultName, ByInputObjectVaultName, ByResourceIdVaultName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the key bundle to get. - -```yaml -Type: System.String -Parameter Sets: ByVaultName, ByInputObjectVaultName, ByResourceIdVaultName -Aliases: KeyName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ByKeyName, ByKeyVersions, ByInputObjectKeyName, ByInputObjectKeyVersions, ByResourceIdKeyName, ByResourceIdKeyVersions -Aliases: KeyName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -KeyVault Resource Id. - -```yaml -Type: System.String -Parameter Sets: ByResourceIdVaultName, ByResourceIdKeyName, ByResourceIdKeyVersions -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault from which this cmdlet gets keys. -This cmdlet constructs the fully qualified domain name (FQDN) of a key vault based on the name that this parameter specifies and your selected environment. - -```yaml -Type: System.String -Parameter Sets: ByVaultName, ByKeyName, ByKeyVersions -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Version -Specifies the key version. -This cmdlet constructs the FQDN of a key based on the key vault name, your currently selected environment, the key name, and the key version. - -```yaml -Type: System.String -Parameter Sets: ByKeyName, ByInputObjectKeyName, ByResourceIdKeyName -Aliases: KeyVersion - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKeyIdentityItem - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKey - -### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultKeyIdentityItem - -### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultKey - -## NOTES - -## RELATED LINKS - -[Add-AzureKeyVaultKey](./Add-AzureKeyVaultKey.md) - -[Remove-AzureKeyVaultKey](./Remove-AzureKeyVaultKey.md) - -[Undo-AzureKeyVaultKeyRemoval](./Undo-AzureKeyVaultKeyRemoval.md) - - diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultManagedStorageAccount.md b/azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultManagedStorageAccount.md deleted file mode 100644 index 9eed35a62a..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultManagedStorageAccount.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/get-azurekeyvaultmanagedstorageaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultManagedStorageAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultManagedStorageAccount.md ---- - -# Get-AzureKeyVaultManagedStorageAccount - -## SYNOPSIS -Gets Key Vault managed Azure Storage Accounts. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByAccountName (Default) -``` -Get-AzureKeyVaultManagedStorageAccount [-VaultName] <String> [[-AccountName] <String>] [-InRemovedState] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByInputObject -``` -Get-AzureKeyVaultManagedStorageAccount [-InputObject] <PSKeyVault> [-InRemovedState] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByResourceId -``` -Get-AzureKeyVaultManagedStorageAccount [-ResourceId] <String> [-InRemovedState] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Gets a Key Vault managed Azure Storage Account if the name of the account is specified and the account keys are managed by the specified vault. If the account name is not specified, then all the accounts whose keys are managed by specified vault are listed. - -## EXAMPLES - -### Example 1: List all Key Vault managed Storage Accounts -```powershell -PS C:\> Get-AzureKeyVaultManagedStorageAccount -VaultName 'myvault' - -Id : https://myvault.vault.azure.net:443/storage/mystorageaccount -Vault Name : myvault -AccountName : mystorageaccount -Account Resource Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.St - orage/storageAccounts/mystorageaccount -Enabled : True -Created : 4/25/2018 1:50:32 AM -Updated : 4/25/2018 1:50:32 AM -Tags : -``` - -Lists all the accounts whose keys are managed by vault 'myvault' - -### Example 2: Get a Key Vault managed Storage Account -```powershell -PS C:\> Get-AzureKeyVaultManagedStorageAccount -VaultName 'myvault' -Name 'mystorageaccount' - -Id : https://myvault.vault.azure.net:443/storage/mystorageaccount -Vault Name : myvault -AccountName : mystorageaccount -Account Resource Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/maddie1/providers/Microsoft.St - orage/storageAccounts/mystorageaccount -Active Key Name : key2 -Auto Regenerate Key : False -Regeneration Period : 90.00:00:00 -Enabled : True -Created : 4/25/2018 1:50:32 AM -Updated : 4/25/2018 1:50:32 AM -Tags : -``` - -Gets the details of Key Vault managed Storage Account of 'mystorageaccount' if its keys are managed by vault 'myvault' - -## PARAMETERS - -### -AccountName -Key Vault managed storage account name. Cmdlet constructs the FQDN of a managed storage account name from vault name, currently selected environment and manged storage account name. - -```yaml -Type: System.String -Parameter Sets: ByAccountName -Aliases: StorageAccountName, Name - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Vault object. - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InRemovedState -Specifies whether to show the previously deleted storage accounts in the output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Vault resource id. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: System.String -Parameter Sets: ByAccountName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccountIdentityItem - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccount - -### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultManagedStorageAccountIdentityItem - -### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultManagedStorageAccount - -## NOTES - -## RELATED LINKS - -[Azure Key Vault cmdlets](/powershell/module/azurerm.keyvault/) diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultManagedStorageSasDefinition.md b/azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultManagedStorageSasDefinition.md deleted file mode 100644 index b5332ade8f..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultManagedStorageSasDefinition.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/get-azurekeyvaultmanagedstoragesasdefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultManagedStorageSasDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultManagedStorageSasDefinition.md ---- - -# Get-AzureKeyVaultManagedStorageSasDefinition - -## SYNOPSIS -Gets Key Vault managed Storage SAS Definitions. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByDefinitionName (Default) -``` -Get-AzureKeyVaultManagedStorageSasDefinition [-VaultName] <String> [-AccountName] <String> [[-Name] <String>] - [-InRemovedState] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByInputObject -``` -Get-AzureKeyVaultManagedStorageSasDefinition [-InputObject] <PSKeyVaultManagedStorageAccountIdentityItem> - [[-Name] <String>] [-InRemovedState] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Gets a Key Vault managed Storage SAS Definition if the name of the definition is specified. If the definition name is not specified, then all the SAS definitions associated with the specified Key Vault managed Storage Account in the vault are listed. - -## EXAMPLES - -### Example 1: List all Key Vault managed Storage SAS Definitions -```powershell -PS C:\> Get-AzureKeyVaultManagedStorageSasDefinition -VaultName 'myvault' -AccountName 'mystorageaccount' - -Id : https://myvault.vault.azure.net:443/storage/mystorageaccount/sas/accountsas -Vault Name : myvault -AccountName : mystorageaccount -Name : accountsas -Enabled : True -Created : 5/24/2018 9:11:08 PM -Updated : 5/24/2018 9:11:08 PM -Tags : -``` - -Lists all the SAS definitions associated with Key Vault managed Storage Account 'mystorageaccount' managed by vault 'myvault' - -### Example 2: Get a Key Vault managed Storage Account -```powershell -PS C:\> Get-AzureKeyVaultManagedStorageSasDefinition -VaultName 'myvault' -AccountName 'mystorageaccount' -Name 'accountsas' - -Id : https://myvault.vault.azure.net:443/storage/mystorageaccount/sas/accountsas -Secret Id : https://myvault.vault.azure.net/secrets/mystorageaccount-accountsas -Vault Name : myvault -AccountName : mystorageaccount -Name : accountsas -Parameter : -Enabled : True -Created : 5/24/2018 9:11:08 PM -Updated : 5/24/2018 9:11:08 PM -Tags : -``` - -Gets the details of SAS Definition 'accountsas' associated with Key Vault managed Storage Account 'mystorageaccount' managed by vault 'myvault'. - -## PARAMETERS - -### -AccountName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: System.String -Parameter Sets: ByDefinitionName -Aliases: StorageAccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -ManagedStorageAccount object. - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccountIdentityItem -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InRemovedState -Specifies whether to show the previously deleted storage sas definitions in the output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Storage sas definition name. -Cmdlet constructs the FQDN of a storage sas definition from vault name, currently selected environment, storage account name and sas definition name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: SasDefinitionName - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: System.String -Parameter Sets: ByDefinitionName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccountIdentityItem -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageSasDefinitionIdentityItem - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageSasDefinition - -### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultManagedStorageSasDefinition - -### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultManagedStorageSasDefinitionIdentityItem - -## NOTES - -## RELATED LINKS - -[Azure Key Vault cmdlets](/powershell/module/azurerm.keyvault/) diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultSecret.md b/azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultSecret.md deleted file mode 100644 index 0678e8e13e..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Get-AzureKeyVaultSecret.md +++ /dev/null @@ -1,413 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 8C9B33EE-10DE-4803-B76D-FE9FC2AC3372 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/get-azurekeyvaultsecret -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultSecret.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultSecret.md ---- - -# Get-AzureKeyVaultSecret - -## SYNOPSIS -Gets the secrets in a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVaultName (Default) -``` -Get-AzureKeyVaultSecret [-VaultName] <String> [[-Name] <String>] [-InRemovedState] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### BySecretName -``` -Get-AzureKeyVaultSecret [-VaultName] <String> [-Name] <String> [-Version] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### BySecretVersions -``` -Get-AzureKeyVaultSecret [-VaultName] <String> [-Name] <String> [-IncludeVersions] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByInputObjectVaultName -``` -Get-AzureKeyVaultSecret [-InputObject] <PSKeyVault> [[-Name] <String>] [-InRemovedState] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByInputObjectSecretName -``` -Get-AzureKeyVaultSecret [-InputObject] <PSKeyVault> [-Name] <String> [-Version] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByInputObjectSecretVersions -``` -Get-AzureKeyVaultSecret [-InputObject] <PSKeyVault> [-Name] <String> [-IncludeVersions] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByResourceIdVaultName -``` -Get-AzureKeyVaultSecret [-ResourceId] <String> [[-Name] <String>] [-InRemovedState] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByResourceIdSecretName -``` -Get-AzureKeyVaultSecret [-ResourceId] <String> [-Name] <String> [-Version] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByResourceIdSecretVersions -``` -Get-AzureKeyVaultSecret [-ResourceId] <String> [-Name] <String> [-IncludeVersions] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureKeyVaultSecret** cmdlet gets secrets in a key vault. -This cmdlet gets a specific secret or all the secrets in a key vault. - -## EXAMPLES - -### Example 1: Get all current versions of all secrets in a key vault -```powershell -PS C:\> Get-AzureKeyVaultSecret -VaultName 'Contoso' - -Vault Name : contoso -Name : secret1 -Version : -Id : https://contoso.vault.azure.net:443/secrets/secret1 -Enabled : True -Expires : 4/6/2018 3:59:43 PM -Not Before : -Created : 4/5/2018 11:46:28 PM -Updated : 4/6/2018 11:30:17 PM -Content Type : -Tags : - -Vault Name : contoso -Name : secret2 -Version : -Id : https://contoso.vault.azure.net:443/secrets/secret2 -Enabled : True -Expires : -Not Before : -Created : 4/11/2018 11:45:06 PM -Updated : 4/11/2018 11:45:06 PM -Content Type : -Tags : -``` - -This command gets the current versions of all secrets in the key vault named Contoso. - -### Example 2: Get all versions of a specific secret -```powershell -PS C:\> Get-AzureKeyVaultSecret -VaultName 'Contoso' -Name 'secret1' -IncludeVersions - -Vault Name : contoso -Name : secret1 -Version : 7128133570f84a71b48d7d0550deb74c -Id : https://contoso.vault.azure.net:443/secrets/secret1/7128133570f84a71b48d7d0550deb74c -Enabled : True -Expires : 4/6/2018 3:59:43 PM -Not Before : -Created : 4/5/2018 11:46:28 PM -Updated : 4/6/2018 11:30:17 PM -Content Type : -Tags : - -Vault Name : contoso -Name : secret1 -Version : 5d1a74ba2c454439886fb8509b6cab3c -Id : https://contoso.vault.azure.net:443/secrets/secret1/5d1a74ba2c454439886fb8509b6cab3c -Enabled : True -Expires : -Not Before : -Created : 4/5/2018 11:44:50 PM -Updated : 4/5/2018 11:44:50 PM -Content Type : -Tags : -``` - -This command gets all versions of the secret named secret1 in the key vault named Contoso. - -### Example 3: Get the current version of a specific secret -```powershell -PS C:\> Get-AzureKeyVaultSecret -VaultName 'Contoso' -Name 'secret1' - -Vault Name : contoso -Name : secret1 -Version : 7128133570f84a71b48d7d0550deb74c -Id : https://contoso.vault.azure.net:443/secrets/secret1/7128133570f84a71b48d7d0550deb74c -Enabled : True -Expires : 4/6/2018 3:59:43 PM -Not Before : -Created : 4/5/2018 11:46:28 PM -Updated : 4/6/2018 11:30:17 PM -Content Type : -Tags : -``` - -This command gets the current version of the secret named secret1 in the key vault named Contoso. - -### Example 4: Get a specific version of a specific secret -```powershell -PS C:\> Get-AzureKeyVaultSecret -VaultName 'Contoso' -Name 'secret1' -Version '5d1a74ba2c454439886fb8509b6cab3c' - -Vault Name : contoso -Name : secret1 -Version : 5d1a74ba2c454439886fb8509b6cab3c -Id : https://contoso.vault.azure.net:443/secrets/secret1/5d1a74ba2c454439886fb8509b6cab3c -Enabled : True -Expires : -Not Before : -Created : 4/5/2018 11:44:50 PM -Updated : 4/5/2018 11:44:50 PM -Content Type : -Tags : -``` - -This command gets a specific version of the secret named secret1 in the key vault named Contoso. - -### Example 5: Get the plain text value of the current version of a specific secret -```powershell -PS C:\> $secret = Get-AzureKeyVaultSecret -VaultName 'Contoso' -Name 'ITSecret' -PS C:\> Write-Host "Secret Value is:" $secret.SecretValueText - -Secret Value is: P@ssw0rd -``` - -These commands get the current version of a secret named ITSecret, and then displays the plain text value of that secret. - -### Example 6: Get all the secrets that have been deleted but not purged for this key vault. -```powershell -PS C:\> Get-AzureKeyVaultSecret -VaultName 'Contoso' -InRemovedState - -Vault Name : contoso -Name : secret1 -Id : https://contoso.vault.azure.net:443/secrets/secret1 -Deleted Date : 4/4/2018 8:51:58 PM -Scheduled Purge Date : 7/3/2018 8:51:58 PM -Enabled : True -Expires : -Not Before : -Created : 4/4/2018 8:51:03 PM -Updated : 4/4/2018 8:51:03 PM -Content Type : -Tags : - -Vault Name : contoso -Name : secret2 -Id : https://contoso.vault.azure.net:443/secrets/secret2 -Deleted Date : 5/7/2018 7:56:34 PM -Scheduled Purge Date : 8/5/2018 7:56:34 PM -Enabled : True -Expires : -Not Before : -Created : 4/6/2018 8:39:15 PM -Updated : 4/6/2018 10:11:24 PM -Content Type : -Tags : -``` - -This command gets all the secrets that have been previously deleted, but not purged, in the key vault named Contoso. - -### Example 7: Gets the secret ITSecret that has been deleted but not purged for this key vault. -```powershell -PS C:\> Get-AzureKeyVaultSecret -VaultName 'Contoso' -KeyName 'secret1' -InRemovedState - -Vault Name : contoso -Name : secret1 -Version : 689d23346e9c42a2a64f4e3d75094dcc -Id : https://contoso.vault.azure.net:443/secrets/secret1/689d23346e9c42a2a64f4e3d75094dcc -Deleted Date : 4/4/2018 8:51:58 PM -Scheduled Purge Date : 7/3/2018 8:51:58 PM -Enabled : True -Expires : -Not Before : -Created : 4/4/2018 8:51:03 PM -Updated : 4/4/2018 8:51:03 PM -Content Type : -Tags : -``` - -This command gets the secret 'secret1' that has been previously deleted, but not purged, in the key vault named Contoso. -This command will return metadata such as the deletion date, and the scheduled purging date of this deleted secret. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeVersions -Indicates that this cmdlet gets all versions of a secret. -The current version of a secret is the first one on the list. -If you specify this parameter you must also specify the *Name* and *VaultName* parameters. -If you do not specify the *IncludeVersions* parameter, this cmdlet gets the current version of the secret with the specified *Name*. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: BySecretVersions, ByInputObjectSecretVersions, ByResourceIdSecretVersions -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -KeyVault Object. - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault -Parameter Sets: ByInputObjectVaultName, ByInputObjectSecretName, ByInputObjectSecretVersions -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InRemovedState -Specifies whether to show the previously deleted secrets in the output - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByVaultName, ByInputObjectVaultName, ByResourceIdVaultName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the secret to get. - -```yaml -Type: System.String -Parameter Sets: ByVaultName, ByInputObjectVaultName, ByResourceIdVaultName -Aliases: SecretName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: BySecretName, BySecretVersions, ByInputObjectSecretName, ByInputObjectSecretVersions, ByResourceIdSecretName, ByResourceIdSecretVersions -Aliases: SecretName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -KeyVault Resource Id. - -```yaml -Type: System.String -Parameter Sets: ByResourceIdVaultName, ByResourceIdSecretName, ByResourceIdSecretVersions -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault to which the secret belongs. -This cmdlet constructs the fully qualified domain name (FQDN) of a key vault based on the name that this parameter specifies and your current environment. - -```yaml -Type: System.String -Parameter Sets: ByVaultName, BySecretName, BySecretVersions -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Version -Specifies the secret version. -This cmdlet constructs the FQDN of a secret based on the key vault name, your currently selected environment, the secret name, and the secret version. - -```yaml -Type: System.String -Parameter Sets: BySecretName, ByInputObjectSecretName, ByResourceIdSecretName -Aliases: SecretVersion - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultSecretIdentityItem - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultSecret - -### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultSecretIdentityItem - -### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultSecret - -## NOTES - -## RELATED LINKS - -[Remove-AzureKeyVaultSecret](./Remove-AzureKeyVaultSecret.md) - -[Undo-AzureKeyVaultSecretRemoval](./Undo-AzureKeyVaultSecretRemoval.md) - -[Set-AzureKeyVaultSecret](./Set-AzureKeyVaultSecret.md) - diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Get-AzureRmKeyVault.md b/azurermps-6.13.0/AzureRM.KeyVault/Get-AzureRmKeyVault.md deleted file mode 100644 index 1d3b73cc08..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Get-AzureRmKeyVault.md +++ /dev/null @@ -1,300 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: A7C287C4-E9FD-407A-91BD-EFA17C33FC8B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/get-azurermkeyvault -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureRmKeyVault.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureRmKeyVault.md ---- - -# Get-AzureRmKeyVault - -## SYNOPSIS -Gets key vaults. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ListAllVaultsInSubscription (Default) -``` -Get-AzureRmKeyVault [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetVaultByName -``` -Get-AzureRmKeyVault [[-VaultName] <String>] [[-ResourceGroupName] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByDeletedVault -``` -Get-AzureRmKeyVault [-VaultName] <String> [-Location] <String> [-InRemovedState] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ListAllDeletedVaultsInSubscription -``` -Get-AzureRmKeyVault [-InRemovedState] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmKeyVault** cmdlet gets information about the key vaults in a subscription. You can -view all key vaults instances in a subscription, or filter your results by a resource group or a -particular key vault. -Note that although specifying the resource group is optional for this cmdlet when you get a single -key vault, you should do so for better performance. - -## EXAMPLES - -### Example 1: Get all key vaults in your current subscription -```powershell -PS C:\> Get-AzureRMKeyVault - -Vault Name : myvault1 -Resource Group Name : myrg -Location : westus -Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.Ke - yVault/vaults/myvault1 -Tags : - - -Vault Name : myvault2 -Resource Group Name : myrg1 -Location : westus -Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg1/providers/Microsoft.Ke - yVault/vaults/myvault2 -Tags : - -Vault Name : myvault3 -Resource Group Name : myrg1 -Location : westus -Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg1/providers/Microsoft.Ke - yVault/vaults/myvault3 -Tags : -``` - -This command gets all the key vaults in your current subscription. - -### Example 2: Get a specific key vault -```powershell -PS C:\> Get-AzureRMKeyVault -VaultName 'myvault' - -Vault Name : myvault -Resource Group Name : myrg -Location : westus -Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers - /Microsoft.KeyVault/vaults/myvault -Vault URI : https://myvault.vault.azure.net/ -Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx -SKU : Standard -Enabled For Deployment? : True -Enabled For Template Deployment? : True -Enabled For Disk Encryption? : False -Soft Delete Enabled? : True -Access Policies : - Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx - Object ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx - Application ID : - Display Name : User Name (username@microsoft.com) - Permissions to Keys : get, create, delete, list, update, - import, backup, restore, recover - Permissions to Secrets : get, list, set, delete, backup, - restore, recover - Permissions to Certificates : get, delete, list, create, import, - update, deleteissuers, getissuers, listissuers, managecontacts, manageissuers, - setissuers, recover - Permissions to (Key Vault Managed) Storage : delete, deletesas, get, getsas, list, - listsas, regeneratekey, set, setsas, update - -Tags : -``` - -This command gets the key vault named myvault in your current subscription. - -### Example 3: Get key vaults in a resource group -```powershell -PS C:\> Get-AzureRmKeyVault -ResourceGroupName 'myrg1' - -Vault Name : myvault2 -Resource Group Name : myrg1 -Location : westus -Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg1/providers/Microsoft.Ke - yVault/vaults/myvault2 -Tags : - -Vault Name : myvault3 -Resource Group Name : myrg1 -Location : westus -Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg1/providers/Microsoft.Ke - yVault/vaults/myvault3 -Tags : -``` - -This command gets all the key vaults in the resource group named ContosoPayRollResourceGroup. - -### Example 4: Get all deleted key vaults in your current subscription -```powershell -PS C:\> Get-AzureRmKeyVault -InRemovedState - -Vault Name : myvault4 -Location : westus -Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/providers/Microsoft.KeyVault/locations/westu - s/deletedVaults/myvault4 -Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.K - eyVault/vaults/myvault4 -Deletion Date : 5/24/2018 9:33:24 PM -Scheduled Purge Date : 8/22/2018 9:33:24 PM -Tags : -``` - -This command gets all the deleted key vaults in your current subscription. - -### Example 5: Get a deleted key vault -```powershell -PS C:\> Get-AzureRMKeyVault -VaultName 'myvault4' -Location 'westus' -InRemovedState - -Vault Name : myvault4 -Location : westus -Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/providers/Microsoft.KeyVault/locations/westu - s/deletedVaults/myvault4 -Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.K - eyVault/vaults/myvault4 -Deletion Date : 5/24/2018 9:33:24 PM -Scheduled Purge Date : 8/22/2018 9:33:24 PM -Tags : -``` - -This command gets the deleted key vault information named myvault4 in your current -subscription and in westus region. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InRemovedState -Specifies whether to show the previously deleted vaults in the output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByDeletedVault, ListAllDeletedVaultsInSubscription -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The location of the deleted vault. - -```yaml -Type: System.String -Parameter Sets: ByDeletedVault -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group associated with the key vault or key vaults being queried. - -```yaml -Type: System.String -Parameter Sets: GetVaultByName -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: ListAllVaultsInSubscription -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault. - -```yaml -Type: System.String -Parameter Sets: GetVaultByName -Aliases: Name - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ByDeletedVault -Aliases: Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultIdentityItem - -### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVault - -## NOTES - -## RELATED LINKS - -[New-AzureRmKeyVault](./New-AzureRmKeyVault.md) - -[Remove-AzureRmKeyVault](./Remove-AzureRmKeyVault.md) diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Import-AzureKeyVaultCertificate.md b/azurermps-6.13.0/AzureRM.KeyVault/Import-AzureKeyVaultCertificate.md deleted file mode 100644 index 535fe7d2ad..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Import-AzureKeyVaultCertificate.md +++ /dev/null @@ -1,260 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: D4188DC6-A8AB-4B45-9781-94B74C338C63 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/import-azurekeyvaultcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Import-AzureKeyVaultCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Import-AzureKeyVaultCertificate.md ---- - -# Import-AzureKeyVaultCertificate - -## SYNOPSIS -Imports a certificate to a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ImportCertificateFromFile (Default) -``` -Import-AzureKeyVaultCertificate [-VaultName] <String> [-Name] <String> -FilePath <String> - [-Password <SecureString>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ImportWithPrivateKeyFromString -``` -Import-AzureKeyVaultCertificate [-VaultName] <String> [-Name] <String> -CertificateString <String> - [-Password <SecureString>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ImportWithPrivateKeyFromCollection -``` -Import-AzureKeyVaultCertificate [-VaultName] <String> [-Name] <String> - [-CertificateCollection] <X509Certificate2Collection> [-Tag <Hashtable>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Import-AzureKeyVaultCertificate** cmdlet imports a certificate into a key vault. -You can create the certificate to import by using one of the following methods: -- Use the New-AzureKeyVaultCertificateSigningRequest cmdlet to create a certificate signing request and submit it to a certificate authority. -- Use an existing certificate package file, such as a .pfx or .p12 file, which contains both the certificate and private key. - -## EXAMPLES - -### Example 1: Import a key vault certificate -```powershell -PS C:\> $Password = ConvertTo-SecureString -String "123" -AsPlainText -Force -PS C:\> Import-AzureKeyVaultCertificate -VaultName "ContosoKV01" -Name "ImportCert01" -FilePath "C:\Users\contosoUser\Desktop\import.pfx" -Password $Password - -Name : importCert01 -Certificate : [Subject] - CN=contoso.com - - [Issuer] - CN=contoso.com - - [Serial Number] - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - - [Not Before] - 2/8/2016 3:11:45 PM - - [Not After] - 8/8/2016 4:21:45 PM - - [Thumbprint] - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - -Thumbprint : XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX -Tags : -Enabled : True -Created : 2/8/2016 11:50:43 PM -Updated : 2/8/2016 11:50:43 PM -``` - -The first command uses the ConvertTo-SecureString cmdlet to create a secure password, and then -stores it in the $Password variable. -The second command imports the certificate named ImportCert01 into the CosotosoKV01 key vault. - -## PARAMETERS - -### -CertificateCollection -Specifies the certificate collection to add to a key vault. - -```yaml -Type: System.Security.Cryptography.X509Certificates.X509Certificate2Collection -Parameter Sets: ImportWithPrivateKeyFromCollection -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CertificateString -Specifies a certificate string. - -```yaml -Type: System.String -Parameter Sets: ImportWithPrivateKeyFromString -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FilePath -Specifies the path of the certificate file that this cmdlet imports. - -```yaml -Type: System.String -Parameter Sets: ImportCertificateFromFile -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the certificate name. This cmdlet constructs the fully qualified domain name (FQDN) of a -certificate from key vault name, currently selected environment, and certificate name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: CertificateName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Password -Specifies the password for a certificate file. - -```yaml -Type: System.Security.SecureString -Parameter Sets: ImportCertificateFromFile, ImportWithPrivateKeyFromString -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the key vault name into which this cmdlet imports certificates. -This cmdlet constructs the fully qualified domain name (FQDN) of a key vault based on the name and currently selected environment. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Security.Cryptography.X509Certificates.X509Certificate2Collection -Parameters: CertificateCollection (ByValue) - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificate - -## NOTES - -## RELATED LINKS - -[Remove-AzureKeyVaultCertificate](./Remove-AzureKeyVaultCertificate.md) diff --git a/azurermps-6.13.0/AzureRM.KeyVault/New-AzureKeyVaultCertificateAdministratorDetails.md b/azurermps-6.13.0/AzureRM.KeyVault/New-AzureKeyVaultCertificateAdministratorDetails.md deleted file mode 100644 index 8c293fd05a..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/New-AzureKeyVaultCertificateAdministratorDetails.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 775AB0E8-EC3C-4F96-8AF8-51C1DFEEF082 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/new-azurekeyvaultcertificateadministratordetails -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/New-AzureKeyVaultCertificateAdministratorDetails.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/New-AzureKeyVaultCertificateAdministratorDetails.md ---- - -# New-AzureKeyVaultCertificateAdministratorDetails - -## SYNOPSIS -Creates an in-memory certificate administrator details object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureKeyVaultCertificateAdministratorDetails [-FirstName <String>] [-LastName <String>] - [-EmailAddress <String>] [-PhoneNumber <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureKeyVaultCertificateAdministratorDetails** cmdlet creates an in-memory certificate administrator details object. - -## EXAMPLES - -### Example 1: Create a certificate administrator details object -``` -PS C:\> $AdminDetails = New-AzureKeyVaultCertificateAdministratorDetails -FirstName "Patti" -LastName "Fuller" -EmailAddress "patti.fuller@contoso.com" -PhoneNumber "5553334444" -PS C:\> $AdminDetails - -FirstName LastName EmailAddress PhoneNumber ---------- -------- ------------ ----------- -Patti Fuller patti.fuller@contoso.com 5553334444 -``` - -This command creates an in-memory certificate administrator details object, and then stores it in the $AdminDetails variable. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddress -Specifies the email address for the certificate administrator. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FirstName -Specifies the first name of the certificate administrator. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LastName -Specifies the last name of the certificate administrator. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PhoneNumber -Specifies the phone number of the certificate administrator. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateAdministratorDetails - -## NOTES - -## RELATED LINKS - -[New-AzureKeyVaultCertificateOrganizationDetails](./New-AzureKeyVaultCertificateOrganizationDetails.md) - diff --git a/azurermps-6.13.0/AzureRM.KeyVault/New-AzureKeyVaultCertificateOrganizationDetails.md b/azurermps-6.13.0/AzureRM.KeyVault/New-AzureKeyVaultCertificateOrganizationDetails.md deleted file mode 100644 index fe79e1b9bd..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/New-AzureKeyVaultCertificateOrganizationDetails.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 0E1C05B0-8CF6-4C03-AA05-B13A4059A280 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/new-azurekeyvaultcertificateorganizationdetails -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/New-AzureKeyVaultCertificateOrganizationDetails.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/New-AzureKeyVaultCertificateOrganizationDetails.md ---- - -# New-AzureKeyVaultCertificateOrganizationDetails - -## SYNOPSIS -Creates an in-memory certificate organization details object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureKeyVaultCertificateOrganizationDetails [-Id <String>] - [-AdministratorDetails <System.Collections.Generic.List`1[Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateAdministratorDetails]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureKeyVaultCertificateOrganizationDetails** cmdlet creates an in-memory certificate organization details object. - -## EXAMPLES - -### Example 1: Create an organization details object -```powershell -PS C:\> $AdminDetails = New-AzureKeyVaultCertificateAdministratorDetails -FirstName "Patti" -LastName "Fuller" -EmailAddress "Patti.Fuller@contoso.com" -PhoneNumber "1234567890" -PS C:\> New-AzureKeyVaultCertificateOrganizationDetails -AdministratorDetails $AdminDetails - -Id AdministratorDetails --- -------------------- - {Patti} -``` - -The first command creates a certificate administrator details object, and then stores it in the $AdminDetails variable. -The second command creates a certificate organization details object, and then stores it in the $OrgDetails variable. - -## PARAMETERS - -### -AdministratorDetails -Specifies the certificate organization administrators. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateAdministratorDetails] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the identifier for the organization. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateAdministratorDetails, Microsoft.Azure.Commands.KeyVault, Version=5.1.0.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateOrganizationDetails - -## NOTES - -## RELATED LINKS - -[New-AzureKeyVaultCertificateAdministratorDetails](./New-AzureKeyVaultCertificateAdministratorDetails.md) - diff --git a/azurermps-6.13.0/AzureRM.KeyVault/New-AzureKeyVaultCertificatePolicy.md b/azurermps-6.13.0/AzureRM.KeyVault/New-AzureKeyVaultCertificatePolicy.md deleted file mode 100644 index e83127c98b..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/New-AzureKeyVaultCertificatePolicy.md +++ /dev/null @@ -1,412 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 25E0F0E9-BF8C-49DF-87BA-31E2103A29A9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/new-azurekeyvaultcertificatepolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/New-AzureKeyVaultCertificatePolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/New-AzureKeyVaultCertificatePolicy.md ---- - -# New-AzureKeyVaultCertificatePolicy - -## SYNOPSIS -Creates an in-memory certificate policy object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SubjectName (Default) -``` -New-AzureKeyVaultCertificatePolicy [-IssuerName] <String> [-SubjectName] <String> - [-RenewAtNumberOfDaysBeforeExpiry <Int32>] [-RenewAtPercentageLifetime <Int32>] [-SecretContentType <String>] - [-ReuseKeyOnRenewal] [-Disabled] - [-KeyUsage <System.Collections.Generic.List`1[System.Security.Cryptography.X509Certificates.X509KeyUsageFlags]>] - [-Ekus <System.Collections.Generic.List`1[System.String]>] [-ValidityInMonths <Int32>] - [-CertificateType <String>] [-EmailAtNumberOfDaysBeforeExpiry <Int32>] [-EmailAtPercentageLifetime <Int32>] - [-KeyType <String>] [-KeyNotExportable] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### DNSNames -``` -New-AzureKeyVaultCertificatePolicy [-IssuerName] <String> [[-SubjectName] <String>] - [-DnsName] <System.Collections.Generic.List`1[System.String]> [-RenewAtNumberOfDaysBeforeExpiry <Int32>] - [-RenewAtPercentageLifetime <Int32>] [-SecretContentType <String>] [-ReuseKeyOnRenewal] [-Disabled] - [-KeyUsage <System.Collections.Generic.List`1[System.Security.Cryptography.X509Certificates.X509KeyUsageFlags]>] - [-Ekus <System.Collections.Generic.List`1[System.String]>] [-ValidityInMonths <Int32>] - [-CertificateType <String>] [-EmailAtNumberOfDaysBeforeExpiry <Int32>] [-EmailAtPercentageLifetime <Int32>] - [-KeyType <String>] [-KeyNotExportable] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureKeyVaultCertificatePolicy** cmdlet creates an in-memory certificate policy object for Azure Key Vault. - -## EXAMPLES - -### Example 1: Create a certificate policy -```powershell -PS C:\> New-AzureKeyVaultCertificatePolicy -SecretContentType "application/x-pkcs12" -SubjectName "CN=contoso.com" -IssuerName "Self" -ValidityInMonths 6 -ReuseKeyOnRenewal - -SecretContentType : application/x-pkcs12 -Kty : -KeySize : 2048 -Exportable : -ReuseKeyOnRenewal : True -SubjectName : CN=contoso.com -DnsNames : -KeyUsage : -Ekus : -ValidityInMonths : 6 -IssuerName : Self -CertificateType : -RenewAtNumberOfDaysBeforeExpiry : -RenewAtPercentageLifetime : -EmailAtNumberOfDaysBeforeExpiry : -EmailAtPercentageLifetime : -CertificateTransparency : -Enabled : True -Created : -Updated : -``` - -This command creates a certificate policy that is valid for six months and reuses the key to renew the certificate. - -## PARAMETERS - -### -CertificateType -Specifies the type of certificate to the issuer. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disabled -Indicates that the certificate policy is disabled. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DnsName -Specifies the DNS names in the certificate. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: DNSNames -Aliases: DnsNames - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Ekus -Specifies the enhanced key usages (EKUs) in the certificate. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EmailAtNumberOfDaysBeforeExpiry -Specifies how many days before expiry the automatic notification process begins. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EmailAtPercentageLifetime -Specifies the percentage of the lifetime after which the automatic process for the notification begins. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IssuerName -Specifies the name of the issuer for the certificate. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyNotExportable -Indicates that the key is not exportable. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyType -Specifies the key type of the key that backs the certificate. -The acceptable values for this parameter are: -- RSA -- RSA-HSM - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: RSA, RSA-HSM - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyUsage -Specifies the key usages in the certificate. - -```yaml -Type: System.Collections.Generic.List`1[System.Security.Cryptography.X509Certificates.X509KeyUsageFlags] -Parameter Sets: (All) -Aliases: -Accepted values: None, EncipherOnly, CrlSign, KeyCertSign, KeyAgreement, DataEncipherment, KeyEncipherment, NonRepudiation, DigitalSignature, DecipherOnly - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RenewAtNumberOfDaysBeforeExpiry -Specifies the number of days before expiry after which the automatic process for certificate renewal begins. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RenewAtPercentageLifetime -Specifies the percentage of the lifetime after which the automatic process for certificate renewal begins. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReuseKeyOnRenewal -Indicates that the certificate reuse the key during renewal. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecretContentType -Specifies the content type of the new key vault secret. -The acceptable values for this parameter are: -- application/x-pkcs12 -- application/x-pem-file - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: application/x-pkcs12, application/x-pem-file - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubjectName -Specifies the subject name of the certificate. - -```yaml -Type: System.String -Parameter Sets: SubjectName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: DNSNames -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ValidityInMonths -Specifies the number of months the certificate is valid. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Management.Automation.SwitchParameter - -### System.Collections.Generic.List`1[[System.Security.Cryptography.X509Certificates.X509KeyUsageFlags, System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificatePolicy - -## NOTES - -## RELATED LINKS - -[Get-AzureKeyVaultCertificatePolicy](./Get-AzureKeyVaultCertificatePolicy.md) - -[Set-AzureKeyVaultCertificatePolicy](./Set-AzureKeyVaultCertificatePolicy.md) - diff --git a/azurermps-6.13.0/AzureRM.KeyVault/New-AzureRmKeyVault.md b/azurermps-6.13.0/AzureRM.KeyVault/New-AzureRmKeyVault.md deleted file mode 100644 index ffe554893f..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/New-AzureRmKeyVault.md +++ /dev/null @@ -1,338 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 4C40DAC9-5C0B-4AFD-9BDB-D407E0B9F701 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/new-azurermkeyvault -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/New-AzureRmKeyVault.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/New-AzureRmKeyVault.md ---- - -# New-AzureRmKeyVault - -## SYNOPSIS -Creates a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmKeyVault [-Name] <String> [-ResourceGroupName] <String> [-Location] <String> [-EnabledForDeployment] - [-EnabledForTemplateDeployment] [-EnabledForDiskEncryption] [-EnableSoftDelete] [-EnablePurgeProtection] - [-Sku <SkuName>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmKeyVault** cmdlet creates a key vault in the specified resource group. This cmdlet -also grants permissions to the currently logged on user to add, remove, or list keys and secrets in -the key vault. -Note: If you see the error **The subscription is not registered to use namespace -'Microsoft.KeyVault'** when you try to create your new key vault, run -**Register-AzureRmResourceProvider -ProviderNamespace "Microsoft.KeyVault"** and then rerun your -**New-AzureRmKeyVault** command. For more information, see Register-AzureRmResourceProvider. - -## EXAMPLES - -### Example 1: Create a Standard key vault -```powershell -PS C:\> New-AzureRmKeyVault -VaultName 'Contoso03Vault' -ResourceGroupName 'Group14' -Location 'East US' - -Vault Name : contoso03vault -Resource Group Name : group14 -Location : East US -Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/group14/providers - /Microsoft.KeyVault/vaults/contoso03vault -Vault URI : https://contoso03vault.vault.azure.net/ -Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx -SKU : Standard -Enabled For Deployment? : False -Enabled For Template Deployment? : False -Enabled For Disk Encryption? : False -Soft Delete Enabled? : -Access Policies : - Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx - Object ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx - Application ID : - Display Name : User Name (username@microsoft.com) - Permissions to Keys : get, create, delete, list, update, - import, backup, restore, recover - Permissions to Secrets : get, list, set, delete, backup, - restore, recover - Permissions to Certificates : get, delete, list, create, import, - update, deleteissuers, getissuers, listissuers, managecontacts, manageissuers, - setissuers, recover, backup, restore - Permissions to (Key Vault Managed) Storage : delete, deletesas, get, getsas, list, - listsas, regeneratekey, set, setsas, update, recover, backup, restore - -Tags : -``` - -This command creates a key vault named Contoso03Vault, in the Azure region East US. The command -adds the key vault to the resource group named Group14. Because the command does not specify a -value for the *SKU* parameter, it creates a Standard key vault. - -### Example 2: Create a Premium key vault -```powershell -PS C:\>New-AzureRmKeyVault -VaultName 'Contoso03Vault' -ResourceGroupName 'Group14' -Location 'East US' -Sku 'Premium' - -Vault Name : contoso03vault -Resource Group Name : group14 -Location : East US -Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/group14/providers - /Microsoft.KeyVault/vaults/contoso03vault -Vault URI : https://contoso03vault.vault.azure.net/ -Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx -SKU : Premium -Enabled For Deployment? : False -Enabled For Template Deployment? : False -Enabled For Disk Encryption? : False -Soft Delete Enabled? : -Access Policies : - Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx - Object ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx - Application ID : - Display Name : User Name (username@microsoft.com) - Permissions to Keys : get, create, delete, list, update, - import, backup, restore, recover - Permissions to Secrets : get, list, set, delete, backup, - restore, recover - Permissions to Certificates : get, delete, list, create, import, - update, deleteissuers, getissuers, listissuers, managecontacts, manageissuers, - setissuers, recover, backup, restore - Permissions to (Key Vault Managed) Storage : delete, deletesas, get, getsas, list, - listsas, regeneratekey, set, setsas, update, recover, backup, restore - -Tags : -``` - -This command creates a key vault, just like the previous example. However, it specifies a value of -Premium for the *SKU* parameter to create a Premium key vault. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnabledForDeployment -Enables the Microsoft.Compute resource provider to retrieve secrets from this key vault when this -key vault is referenced in resource creation, for example when creating a virtual machine. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnabledForDiskEncryption -Enables the Azure disk encryption service to get secrets and unwrap keys from this key vault. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnabledForTemplateDeployment -Enables Azure Resource Manager to get secrets from this key vault when this key vault is referenced in a template deployment. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnablePurgeProtection -If specified, protection against immediate deletion is enabled for this vault; requires soft delete to be enabled as well. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableSoftDelete -Specifies that the soft-delete functionality is enabled for this key vault. When soft-delete is enabled, for a grace period, you can recover this key vault and its contents after it is deleted. -For more information about this functionality, see [Azure Key Vault soft-delete overview](https://docs.microsoft.com/azure/key-vault/key-vault-ovw-soft-delete). For how-to instructions, see [How to use Key Vault soft-delete with PowerShell](https://docs.microsoft.com/azure/key-vault/key-vault-soft-delete-powershell). - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the Azure region in which to create the key vault. Use the command [Get-AzureRmLocation](/powershell/module/azurerm.resources/get-azurermlocation) to see your choices. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name of the key vault to create. The name can be any combination of letters, digits, or hyphens. The name must start and end with a letter or digit. The name must be universally unique. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: VaultName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an existing resource group in which to create the key vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -Specifies the SKU of the key vault instance. For information about which features are available for each SKU, see the Azure Key Vault Pricing website (https://go.microsoft.com/fwlink/?linkid=512521). - -```yaml -Type: Microsoft.Azure.Management.KeyVault.Models.SkuName -Parameter Sets: (All) -Aliases: -Accepted values: Standard, Premium - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -### Microsoft.Azure.Management.KeyVault.Models.SkuName - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault - -## NOTES - -## RELATED LINKS - -[Get-AzureRmKeyVault](./Get-AzureRmKeyVault.md) - -[Remove-AzureRmKeyVault](./Remove-AzureRmKeyVault.md) diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureKeyVaultCertificate.md b/azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureKeyVaultCertificate.md deleted file mode 100644 index 967771498f..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureKeyVaultCertificate.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 34985F06-4D8D-463B-B113-972666D18485 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/remove-azurekeyvaultcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultCertificate.md ---- - -# Remove-AzureKeyVaultCertificate - -## SYNOPSIS -Removes a certificate from a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVaultNameAndName (Default) -``` -Remove-AzureKeyVaultCertificate [-VaultName] <String> [-Name] <String> [-InRemovedState] [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByObject -``` -Remove-AzureKeyVaultCertificate [-InputObject] <PSKeyVaultCertificateIdentityItem> [-InRemovedState] [-Force] - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureKeyVaultCertificate** cmdlet removes a certificate from a key vault. - -## EXAMPLES - -### Example 1: Remove a certificate -```powershell -PS C:\> Remove-AzureKeyVaultCertificate -VaultName "ContosoKV01" -Name "SelfSigned01" -PassThru -Force - -Certificate : [Subject] - CN=contoso.com - - [Issuer] - CN=contoso.com - - [Serial Number] - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - - [Not Before] - 4/11/2018 4:28:39 PM - - [Not After] - 10/11/2018 4:38:39 PM - - [Thumbprint] - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - -KeyId : https://contosokv01.vault.azure.net:443/keys/selfsigned01/968c3920884a435abf8faea11f565456 -SecretId : https://contosokv01.vault.azure.net:443/secrets/selfsigned01/968c3920884a435abf8faea11f565456 -Thumbprint : XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX -RecoveryLevel : Purgeable -ScheduledPurgeDate : -DeletedDate : -Enabled : True -Expires : 10/11/2018 11:38:39 PM -NotBefore : 4/11/2018 11:28:39 PM -Created : 4/11/2018 11:38:39 PM -Updated : 4/11/2018 11:38:39 PM -Tags : -VaultName : ContosoKV01 -Name : SelfSigned01 -Version : 968c3920884a435abf8faea11f565456 -Id : https://contosokv01.vault.azure.net:443/certificates/selfsigned01/968c3920884a435abf8faea11f565456 -``` - -This command removes the certificate named SelfSigned01 from the key vault named ContosoKV01. -This command specifies the *Force* parameter. -Therefore, the cmdlet does not prompt you for confirmation. - -### Example 2: Purge the deleted certificate from the key vault permanently -```powershell -PS C:\> Remove-AzureKeyVaultCertificate -VaultName 'Contoso' -Name 'MyCert' -InRemovedState -``` - -This command permanently removes the certificate named 'MyCert' from the key vault named 'Contoso'. -Executing this cmdlet requires the 'purge' permission, which must have been previously and explicitly granted to the user on this key vault. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Certificate Object. - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIdentityItem -Parameter Sets: ByObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InRemovedState -If present, removes the previously deleted certificate permanently - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the certificate that this cmdlet removes from a key vault. -This cmdlet constructs the fully qualified domain name (FQDN) of a certificate based on the name that this parameter specifies, the name of the key vault, and your current environment. - -```yaml -Type: System.String -Parameter Sets: ByVaultNameAndName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault from which this cmdlet removes a certificate. -This cmdlet constructs the FQDN of a key vault based on the name that this parameter specifies and your current environment. - -```yaml -Type: System.String -Parameter Sets: ByVaultNameAndName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIdentityItem -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultCertificate - -## NOTES - -## RELATED LINKS - -[Add-AzureKeyVaultCertificate](./Add-AzureKeyVaultCertificate.md) - -[Get-AzureKeyVaultCertificate](./Get-AzureKeyVaultCertificate.md) - -[Import-AzureKeyVaultCertificate](./Import-AzureKeyVaultCertificate.md) - -[Undo-AzureKeyVaultCertificateRemoval](./Undo-AzureKeyVaultCertificateRemoval.md) diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureKeyVaultCertificateContact.md b/azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureKeyVaultCertificateContact.md deleted file mode 100644 index b66bbefabd..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureKeyVaultCertificateContact.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 35FAA57F-B2BD-4E43-8238-12F7A8269E4D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/remove-azurekeyvaultcertificatecontact -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultCertificateContact.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultCertificateContact.md ---- - -# Remove-AzureKeyVaultCertificateContact - -## SYNOPSIS -Deletes a contact that is registered for certificate notifications from a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByName (Default) -``` -Remove-AzureKeyVaultCertificateContact [-VaultName] <String> [-EmailAddress] <String[]> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByObject -``` -Remove-AzureKeyVaultCertificateContact [-InputObject] <PSKeyVault> [-EmailAddress] <String[]> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Remove-AzureKeyVaultCertificateContact [-ResourceId] <String> [-EmailAddress] <String[]> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureKeyVaultCertificateContact** cmdlet deletes a contact that is registered for certificate notifications from a key vault. - -## EXAMPLES - -### Example 1: Remove a certificate contact -```powershell -PS C:\> Remove-AzureKeyVaultCertificateContact -VaultName "Contoso01" -EmailAddress "patti.fuller@contoso.com" -PassThru - -Email VaultName ------ --------- -user1@microsoft.com mvault2 -user2@microsoft.com mvault2 -user3@microsoft.com mvault2 -user4@microsoft.com mvault2 -``` - -This command removes Patti Fuller as a certificate contact for the Contoso01 key vault. If PassThru is specified, the cmdlet returns the list of remaining certificate contacts. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddress -Specifies the email address of the contact to remove. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -KeyVault object. - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault -Parameter Sets: ByObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -KeyVault Resource Id. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of a key vault. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateContact - -## NOTES - -## RELATED LINKS - -[Add-AzureKeyVaultCertificateContact](./Add-AzureKeyVaultCertificateContact.md) - -[Get-AzureKeyVaultCertificateContact](./Get-AzureKeyVaultCertificateContact.md) - diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureKeyVaultCertificateIssuer.md b/azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureKeyVaultCertificateIssuer.md deleted file mode 100644 index adc92740f9..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureKeyVaultCertificateIssuer.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: FC14F6BF-BD8F-45E0-9CAA-A937E5E56288 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/remove-azurekeyvaultcertificateissuer -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultCertificateIssuer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultCertificateIssuer.md ---- - -# Remove-AzureKeyVaultCertificateIssuer - -## SYNOPSIS -Deletes a certificate issuer from a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Default (Default) -``` -Remove-AzureKeyVaultCertificateIssuer [-VaultName] <String> [-Name] <String> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObject -``` -Remove-AzureKeyVaultCertificateIssuer [-InputObject] <PSKeyVaultCertificateIssuerIdentityItem> [-Force] - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureKeyVaultCertificateIssuer** cmdlet deletes a certificate issuer from a key vault. - -## EXAMPLES - -### Example 1: Remove a certificate issuer -```powershell -PS C:\> Remove-AzureKeyVaultCertificateIssuer -VaultName "ContosoKV01" -Name "TestIssuer01" -Force - -AccountId : -ApiKey : -OrganizationDetails : -Name : TestIssuer01 -IssuerProvider : test -VaultName : ContosoKV01 -``` - -This command removes the certificate issuer named TestIssuer01 from the ContosoKV01 key vault. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Certificate Issuer Object - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIssuerIdentityItem -Parameter Sets: InputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the issuer to remove. - -```yaml -Type: System.String -Parameter Sets: Default -Aliases: IssuerName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of a key vault. - -```yaml -Type: System.String -Parameter Sets: Default -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIssuerIdentityItem -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIssuer - -## NOTES - -## RELATED LINKS - -[Get-AzureKeyVaultCertificateIssuer](./Get-AzureKeyVaultCertificateIssuer.md) - -[Set-AzureKeyVaultCertificateIssuer](./Set-AzureKeyVaultCertificateIssuer.md) - - diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureKeyVaultCertificateOperation.md b/azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureKeyVaultCertificateOperation.md deleted file mode 100644 index c0ad588a5a..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureKeyVaultCertificateOperation.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 2659C06A-AE5B-4F7B-B9EF-069A74E12560 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/remove-azurekeyvaultcertificateoperation -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultCertificateOperation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultCertificateOperation.md ---- - -# Remove-AzureKeyVaultCertificateOperation - -## SYNOPSIS -Deletes a certificate operation from a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Default -``` -Remove-AzureKeyVaultCertificateOperation [-VaultName] <String> [-Name] <String> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObject -``` -Remove-AzureKeyVaultCertificateOperation [-InputObject] <PSKeyVaultCertificateOperation> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureKeyVaultCertificateOperation** cmdlet deletes a certificate operation from a key vault. - -## EXAMPLES - -### Example 1: Remove a certificate operation -```powershell -PS C:\> Remove-AzureKeyVaultCertificateOperation -VaultName "ContosoKV01" -Name "TestCert01" -Force - -Id : https://contosokv01.vault.azure.net/certificates/testcert01/pending -Status : completed -StatusDetails : -RequestId : f5dfd2ae486149a594dc98e800dceaaa -Target : https://contosokv01.vault.azure.net/certificates/testcert01 -Issuer : Self -CancellationRequested : False -CertificateSigningRequest : MIICpjCCAY4CAQAwFjEUMBIGA1UEAxMLY29udG9zby5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC73w3VRBOlgJ5Od1PjDh+2ytngNZp+ZP4fkuX8K1Ti5LA6Ih7eWx1fgAN/iTb6l - 5K6LvAIJvsTNVePMNxfSdaEIJ70Inm45wVU4A/kf+UxQWAYVMsBrLtDFWxnVhzf6n7RGYke6HLBj3j5ASb9g+olSs6eON25ibF0t+u6JC+sIR0LmVGar9Q0eZys1rdfzJBIKq+laOM7z2pJijb5ANqve9 - i7rH5mnhQk4V8WsRstOhYR9jgLqSSxokDoeaBClIOidSBYqVc1yNv4ASe1UWUCR7ZK6OQXiecNWSWPmgWEyawu6AR9eb1YotCr2ScheMOCxlm3103luitxrd8A7kMjAgMBAAGgSzBJBgkqhkiG9w0BCQ4 - xPDA6MA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwCQYDVR0TBAIwADANBgkqhkiG9w0BAQsFAAOCAQEAIHhsDJV37PKi8hor5eQf7+Tct1preIvSwqV0NF6Uo7O6 - YnC9Py7Wp7CHfKzuqeptUk2Tsu7B5dHB+o9Ypeeqw8fWhTN0GFGRKO7WjZQlDqL+lRNcjlFSaP022oIP0kmvVhBcmZqRQlALXccAaxEclFA/3y/aNj2gwWeKpH/pwAkZ39zMEzpQCaRfnQk7e3l4MV8cf - eC2HPYdRWkXxAeDcNPxBuVmKy49AzYvly+APNVDU3v66gxl3fIKrGRsKi2Cp/nO5rBxG2h8t+0Za4l/HJ7ZWR9wKbd/xg7JhdZZFVBxMHYzw8KQ0ys13x8HY+PXU92Y7yD3uC2Rcj+zbAf+Kg== - == -ErrorCode : -ErrorMessage : -Name : -VaultName : -``` - -This command removes the certificate operation named TestCert01 from the ContosoKV01 key vault without prompting for confirmation. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Operation object - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateOperation -Parameter Sets: InputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a certificate. - -```yaml -Type: System.String -Parameter Sets: Default -Aliases: CertificateName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of a key vault. - -```yaml -Type: System.String -Parameter Sets: Default -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateOperation -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateOperation - -## NOTES - -## RELATED LINKS - -[Get-AzureKeyVaultCertificateOperation](./Get-AzureKeyVaultCertificateOperation.md) - -[Stop-AzureKeyVaultCertificateOperation](./Stop-AzureKeyVaultCertificateOperation.md) - diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureKeyVaultKey.md b/azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureKeyVaultKey.md deleted file mode 100644 index b5109bb079..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureKeyVaultKey.md +++ /dev/null @@ -1,248 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 817BF177-519F-47BA-86CF-4591FB402E2Dl -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/remove-azurekeyvaultkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultKey.md ---- - -# Remove-AzureKeyVaultKey - -## SYNOPSIS -Deletes a key in a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVaultName (Default) -``` -Remove-AzureKeyVaultKey [-VaultName] <String> [-Name] <String> [-Force] [-PassThru] [-InRemovedState] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByInputObject -``` -Remove-AzureKeyVaultKey [-InputObject] <PSKeyVaultKeyIdentityItem> [-Force] [-PassThru] [-InRemovedState] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureKeyVaultKey cmdlet deletes a key in a key vault. -If the key was accidentally deleted the key can be recovered using Undo-AzureKeyVaultKeyRemoval by a user with special 'recover' permissions. -This cmdlet has a value of high for the **ConfirmImpact** property. - -## EXAMPLES - -### Example 1: Remove a key from a key vault -```powershell -PS C:\> Remove-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -PassThru - -Vault Name : contoso -Name : key2 -Id : https://contoso.vault.azure.net:443/keys/itsoftware/fdad15793ba0437e960497908ef9eb32 -Deleted Date : 5/24/2018 11:28:25 PM -Scheduled Purge Date : 8/22/2018 11:28:25 PM -Enabled : False -Expires : 10/11/2018 11:32:49 PM -Not Before : 4/11/2018 11:22:49 PM -Created : 4/12/2018 10:16:38 PM -Updated : 4/12/2018 10:16:38 PM -Purge Disabled : False -Tags : -``` - -This command removes the key named ITSoftware from the key vault named Contoso. - -### Example 2: Remove a key without user confirmation -```powershell -PS C:\> Remove-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -Force -``` - -This command removes the key named ITSoftware from the key vault named Contoso. -The command specifies the *Force* parameter, and, therefore, the cmdlet does not prompt you for confirmation. - -### Example 3: Purge a deleted key from the key vault permanently -```powershell -PS C:\> Remove-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -InRemovedState -``` - -This command removes the key named ITSoftware from the key vault named Contoso permanently. -Executing this cmdlet requires the 'purge' permission, which must have been previously and explicitly granted to the user for this key vault. - -### Example 4: Remove keys by using the pipeline operator -```powershell -PS C:\> Get-AzureKeyVaultKey -VaultName 'Contoso' | Where-Object {$_.Attributes.Enabled -eq $False} | Remove-AzureKeyVaultKey -``` - -This command gets all the keys in the key vault named Contoso, and passes them to the **Where-Object** cmdlet by using the pipeline operator. -That cmdlet passes the keys that have a value of $False for the **Enabled** attribute to the current cmdlet. -That cmdlet removes those keys. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -KeyBundle Object - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKeyIdentityItem -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InRemovedState -Remove the previously deleted key permanently. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the key to remove. -This cmdlet constructs the fully qualified domain name (FQDN) of a key based on the name that this parameter specifies, the name of the key vault, and your current environment. - -```yaml -Type: System.String -Parameter Sets: ByVaultName -Aliases: KeyName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a **Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKey** object. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault from which to remove the key. -This cmdlet constructs the FQDN of a key vault based on the name that this parameter specifies and your current environment. - -```yaml -Type: System.String -Parameter Sets: ByVaultName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKeyIdentityItem -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultKey - -## NOTES - -## RELATED LINKS - -[Add-AzureKeyVaultKey](./Add-AzureKeyVaultKey.md) - -[Get-AzureKeyVaultKey](./Get-AzureKeyVaultKey.md) - - -[Undo-AzureKeyVaultKeyRemoval](./Undo-AzureKeyVaultKeyRemoval.md) - diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureKeyVaultManagedStorageAccount.md b/azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureKeyVaultManagedStorageAccount.md deleted file mode 100644 index ff24070064..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureKeyVaultManagedStorageAccount.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/remove-azurekeyvaultmanagedstorageaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultManagedStorageAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultManagedStorageAccount.md ---- - -# Remove-AzureKeyVaultManagedStorageAccount - -## SYNOPSIS -Removes a Key Vault managed Azure Storage Account and all associated SAS definitions. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByDefinitionName (Default) -``` -Remove-AzureKeyVaultManagedStorageAccount [-VaultName] <String> [-AccountName] <String> [-InRemovedState] - [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByInputObject -``` -Remove-AzureKeyVaultManagedStorageAccount [-InputObject] <PSKeyVaultManagedStorageAccountIdentityItem> - [-InRemovedState] [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Disassociates an Azure Storage Account from Key Vault. This does not remove an Azure Storage Account but removes the account keys from being managed by Azure Key Vault. All associated Key Vault managed Storage SAS definitions are also removed. - -## EXAMPLES - -### Example 1: Remove a Key Vault managed Azure Storage Account and all associated SAS definitions. -```powershell -PS C:\> Remove-AzureKeyVaultManagedStorageAccount -VaultName 'myvault' -AccountName 'mystorageaccount' -PassThru - -Id : https://myvault.vault.azure.net:443/storage/mystorageaccount -Vault Name : myvault -AccountName : mystorageaccount -Account Resource Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.St - orage/storageAccounts/mystorageaccount -Enabled : True -Created : 4/25/2018 1:50:32 AM -Updated : 4/25/2018 1:50:32 AM -Tags : -``` - -Disassociates Azure Storage Account 'mystorageaccount' from Key Vault 'myvault' and stops Key Vault from managing its keys. The account 'mystorageaccount' will not be removed. All Key Vault managed Storage SAS definitions associated with this account will be removed. - -### Example 2: Remove a Key Vault managed Azure Storage Account and all associated SAS definitions without user confirmation. -```powershell -PS C:\> Remove-AzureKeyVaultManagedStorageAccount -VaultName 'myvault' -AccountName 'mystorageaccount' -PassThru -Force - -Id : https://myvault.vault.azure.net:443/storage/mystorageaccount -Vault Name : myvault -AccountName : mystorageaccount -Account Resource Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.St - orage/storageAccounts/mystorageaccount -Enabled : True -Created : 4/25/2018 1:50:32 AM -Updated : 4/25/2018 1:50:32 AM -Tags : -``` - -Disassociates Azure Storage Account 'mystorageaccount' from Key Vault 'myvault' and stops Key Vault from managing its keys. The account 'mystorageaccount' will not be removed. All Key Vault managed Storage SAS definitions associated with this account will be removed. - -### Example 3: Permanently delete (purge) a Key Vault managed Azure Storage Account and all associated SAS definitions from a soft-delete-enabled vault. -```powershell -PS C:\> Remove-AzureKeyVaultManagedStorageAccount -VaultName 'myvault' -AccountName 'mystorageaccount' -PS C:\> Get-AzureKeyVaultManagedStorageAccount -VaultName 'myvault' -AccountName 'mystorageaccount' -InRemovedState -PS C:\> Remove-AzureKeyVaultManagedStorageAccount -VaultName 'myvault' -AccountName 'mystorageaccount' -InRemovedState -``` - -The example assumes that soft-delete is enabled for this vault. Verify whether that is the case by examining the vault properties, or the RecoveryLevel attribute of an entity in the vault. -The first cmdlet disassociates Azure Storage Account 'mystorageaccount' from Key Vault 'myvault' and stops Key Vault from managing its keys. The account 'mystorageaccount' will not be removed. All Key Vault managed Storage SAS definitions associated with this account will be removed. -The second cmdlet verifies that the storage account is in a deleted, but recoverable state. Reaching this state may require some time, please allow ~30s before attempting. -The third cmdlet permanently removes the storage account - recovery will no longer be possible. - -## PARAMETERS - -### -AccountName -Key Vault managed storage account name. Cmdlet constructs the FQDN of a managed storage account name from vault name, currently selected environment and manged storage account name. - -```yaml -Type: System.String -Parameter Sets: ByDefinitionName -Aliases: StorageAccountName, Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -ManagedStorageAccount object. - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccountIdentityItem -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InRemovedState -Permanently remove the previously deleted managed storage account. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Cmdlet does not return an object by default. -If this switch is specified, cmdlet returns the managed storage account that was deleted. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: System.String -Parameter Sets: ByDefinitionName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccountIdentityItem -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultManagedStorageAccount - -## NOTES - -## RELATED LINKS - -[Azure Key Vault cmdlets](/powershell/module/azurerm.keyvault/) diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureKeyVaultManagedStorageSasDefinition.md b/azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureKeyVaultManagedStorageSasDefinition.md deleted file mode 100644 index 6e56748970..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureKeyVaultManagedStorageSasDefinition.md +++ /dev/null @@ -1,227 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/remove-azurekeyvaultmanagedstoragesasdefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultManagedStorageSasDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultManagedStorageSasDefinition.md ---- - -# Remove-AzureKeyVaultManagedStorageSasDefinition - -## SYNOPSIS -Removes a Key Vault managed Azure Storage SAS definitions. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByDefinitionName (Default) -``` -Remove-AzureKeyVaultManagedStorageSasDefinition [-VaultName] <String> [-AccountName] <String> [-Name] <String> - [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByInputObject -``` -Remove-AzureKeyVaultManagedStorageSasDefinition - [-InputObject] <PSKeyVaultManagedStorageSasDefinitionIdentityItem> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Removes a Key Vault managed Azure Storage SAS definitions. This also removes the secret used to get the SAS token per this SAS definition. - -## EXAMPLES - -### Example 1: Remove a Key Vault managed Azure Storage SAS definition. -```powershell -PS C:\> Remove-AzureKeyVaultManagedStorageAccount -VaultName 'myvault' -AccountName 'mystorageaccount' -Name 'mysasdef' -PassThru - -Id : https://myvault.vault.azure.net:443/storage/mystorageaccount/sas/mysasdef -Vault Name : myvault -AccountName : mystorageaccount -Name : mysasdef -Enabled : True -Created : 5/24/2018 9:11:08 PM -Updated : 5/24/2018 9:11:08 PM -Tags : -``` - -Removes a Key Vault managed Storage SAS definition 'mysasdef' associated with the account 'mystorageaccount' in vault 'myvault'. - -### Example 2: Remove a Key Vault managed Azure Storage SAS definition without user confirmation. -```powershell -PS C:\> Remove-AzureKeyVaultManagedStorageAccount -VaultName 'myvault' -AccountName 'mystorageaccount' -Name 'mysasdef' -PassThru -Force - -Id : https://myvault.vault.azure.net:443/storage/mystorageaccount/sas/mysasdef -Vault Name : myvault -AccountName : mystorageaccount -Name : mysasdef -Enabled : True -Created : 5/24/2018 9:11:08 PM -Updated : 5/24/2018 9:11:08 PM -Tags : -``` - -Removes a Key Vault managed Storage SAS definition 'mysasdef' associated with the account 'mystorageaccount' in vault 'myvault'. - -## PARAMETERS - -### -AccountName -Storage account name. -Cmdlet constructs the FQDN of a managed storage account name from vault name, currently selected environment and storage account name. - -```yaml -Type: System.String -Parameter Sets: ByDefinitionName -Aliases: StorageAccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -ManagedStorageSasDefinition object. - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageSasDefinitionIdentityItem -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Storage sas definition name. -Cmdlet constructs the FQDN of a storage sas definition from vault name, currently selected environment, storage account name and sas definition name. - -```yaml -Type: System.String -Parameter Sets: ByDefinitionName -Aliases: SasDefinitionName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Cmdlet does not return an object by default. -If this switch is specified, cmdlet returns the managed storage account that was deleted. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: System.String -Parameter Sets: ByDefinitionName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageSasDefinitionIdentityItem -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultManagedStorageSasDefinition - -## NOTES - -## RELATED LINKS - -[Azure Key Vault cmdlets](/powershell/module/azurerm.keyvault/) diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureKeyVaultSecret.md b/azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureKeyVaultSecret.md deleted file mode 100644 index a7307d798d..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureKeyVaultSecret.md +++ /dev/null @@ -1,252 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/remove-azurekeyvaultsecret -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultSecret.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultSecret.md ---- - -# Remove-AzureKeyVaultSecret - -## SYNOPSIS -Deletes a secret in a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVaultName (Default) -``` -Remove-AzureKeyVaultSecret [-VaultName] <String> [-Name] <String> [-Force] [-PassThru] [-InRemovedState] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByInputObject -``` -Remove-AzureKeyVaultSecret [-InputObject] <PSKeyVaultSecretIdentityItem> [-Force] [-PassThru] [-InRemovedState] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureKeyVaultSecret cmdlet deletes a secret in a key vault. -If the secret was accidentally deleted the secret can be recovered using Undo-AzureKeyVaultSecretRemoval by a user with special 'recover' permissions. -This cmdlet has a value of high for the **ConfirmImpact** property. - -## EXAMPLES - -### Example 1: Remove a secret from a key vault -```powershell -PS C:\> Remove-AzureKeyVaultSecret -VaultName 'Contoso' -Name 'FinanceSecret' -PassThru - -Vault Name : Contoso -Name : FinanceSecret -Version : f622abc7b1394092812f1eb0f85dc91c -Id : https://contoso.vault.azure.net:443/secrets/financesecret/f622abc7b1394092812f1eb0f85dc91c -Deleted Date : 5/25/2018 4:45:34 PM -Scheduled Purge Date : 8/23/2018 4:45:34 PM -Enabled : True -Expires : -Not Before : -Created : 4/19/2018 5:56:02 PM -Updated : 4/26/2018 7:48:40 PM -Content Type : -Tags : -``` - -This command removes the secret named FinanceSecret from the key vault named Contoso.' - -### Example 2: Remove a secret from a key vault without user confirmation -```powershell -PS C:\> Remove-AzureKeyVaultSecret -VaultName 'Contoso' -Name 'FinanceSecret' -PassThru -Force - -Vault Name : Contoso -Name : FinanceSecret -Version : f622abc7b1394092812f1eb0f85dc91c -Id : https://contoso.vault.azure.net:443/secrets/financesecret/f622abc7b1394092812f1eb0f85dc91c -Deleted Date : 5/25/2018 4:45:34 PM -Scheduled Purge Date : 8/23/2018 4:45:34 PM -Enabled : True -Expires : -Not Before : -Created : 4/19/2018 5:56:02 PM -Updated : 4/26/2018 7:48:40 PM -Content Type : -Tags : -``` - -This command removes the secret named FinanceSecret from the key vault named Contoso. -The command specifies the *Force* and *Confirm* parameters, and, therefore, the cmdlet does not prompt you for confirmation. - -### Example 3: Purge deleted secret from the key vault permanently -```powershell -PS C:\> Remove-AzureKeyVaultSecret -VaultName 'Contoso' -Name 'FinanceSecret' -InRemovedState -``` - -This command premoves the secret named FinanceSecret from the key vault named Contoso permanently. -Executing this cmdlet requires the 'purge' permission, which must have been previously and explicitly granted to the user for this key vault. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Key Vault Secret Object - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultSecretIdentityItem -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InRemovedState -If present, removes the previously deleted secret permanently. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a secret. -This cmdlet constructs the fully qualified domain name (FQDN) of a secret based on the name that this parameter specifies, the name of the key vault, and your current environment. - -```yaml -Type: System.String -Parameter Sets: ByVaultName -Aliases: SecretName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a **Microsoft.Azure.Commands.KeyVault.Models.Secret** object. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault to which the secret belongs. -This cmdlet constructs the FQDN of a key vault based on the name that this parameter specifies and your current environment. - -```yaml -Type: System.String -Parameter Sets: ByVaultName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultSecretIdentityItem -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultSecret - -## NOTES - -## RELATED LINKS - -[Get-AzureKeyVaultSecret](./Get-AzureKeyVaultSecret.md) - -[Set-AzureKeyVaultSecret](./Set-AzureKeyVaultSecret.md) - -[Undo-AzureKeyVaultSecretRemoval](./Undo-AzureKeyVaultSecretRemoval.md) - diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureRmKeyVault.md b/azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureRmKeyVault.md deleted file mode 100644 index 7d2dd9ce1a..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureRmKeyVault.md +++ /dev/null @@ -1,299 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 7A929BA8-02D9-4BBE-AFF3-B8781F8DDAD9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/remove-azurermkeyvault -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureRmKeyVault.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureRmKeyVault.md ---- - -# Remove-AzureRmKeyVault - -## SYNOPSIS -Deletes a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByAvailableVault (Default) -``` -Remove-AzureRmKeyVault [-VaultName] <String> [[-ResourceGroupName] <String>] [[-Location] <String>] [-Force] - [-AsJob] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByDeletedVault -``` -Remove-AzureRmKeyVault [-VaultName] <String> [-Location] <String> [-InRemovedState] [-Force] [-AsJob] - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectByAvailableVault -``` -Remove-AzureRmKeyVault [-InputObject] <PSKeyVault> [-Force] [-AsJob] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectByDeletedVault -``` -Remove-AzureRmKeyVault [-InputObject] <PSKeyVault> [-InRemovedState] [-Force] [-AsJob] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdByAvailableVault -``` -Remove-AzureRmKeyVault [-ResourceId] <String> [[-Location] <String>] [-Force] [-AsJob] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdByDeletedVault -``` -Remove-AzureRmKeyVault [-ResourceId] <String> [-Location] <String> [-InRemovedState] [-Force] [-AsJob] - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmKeyVault** cmdlet deletes the specified key vault. -It also deletes all keys and secrets contained in that instance. -Note that although specifying the resource group is optional for this cmdlet, you should so for better performance. - -## EXAMPLES - -### Example 1: Remove a key vault -```powershell -PS C:\> Remove-AzureRmKeyVault -VaultName "Contoso03Vault" -PassThru - -True -``` - -This command removes the key vault named Contoso03Vault from your current subscription. - -### Example 2: Remove a key vault from a specified resource group -```powershell -PS C:\> Remove-AzureRmKeyVault -VaultName "Contoso03Vault" -ResourceGroupName "Group14" -PassThru - -True -``` - -This command removes the key vault named Contoso03Vault from the named resource group. -If you do not specify the resource group name, the cmdlet searches for the named key vault to delete in your current subscription. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Indicates that the cmdlet does not prompt you for confirmation. -By default, this cmdlet prompts you to confirm that you want to delete the key vault. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Key Vault object to be deleted. - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault -Parameter Sets: InputObjectByAvailableVault, InputObjectByDeletedVault -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InRemovedState -Remove the previously deleted vault permanently. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByDeletedVault, InputObjectByDeletedVault, ResourceIdByDeletedVault -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The location of the deleted vault. - -```yaml -Type: System.String -Parameter Sets: ByAvailableVault, ResourceIdByAvailableVault -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ByDeletedVault, ResourceIdByDeletedVault -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -This Cmdlet does not return an object by default. If this switch is specified, it returns true if successful. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: ByAvailableVault -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -KeyVault Resource Id. - -```yaml -Type: System.String -Parameter Sets: ResourceIdByAvailableVault, ResourceIdByDeletedVault -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault to remove. - -```yaml -Type: System.String -Parameter Sets: ByAvailableVault, ByDeletedVault -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmKeyVault](./Get-AzureRmKeyVault.md) - -[New-AzureRmKeyVault](./New-AzureRmKeyVault.md) diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureRmKeyVaultAccessPolicy.md b/azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureRmKeyVaultAccessPolicy.md deleted file mode 100644 index b8eb85aef8..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureRmKeyVaultAccessPolicy.md +++ /dev/null @@ -1,449 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: AE7B103B-23ED-4A66-A0DC-14FB0DF38FA8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/remove-azurermkeyvaultaccesspolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureRmKeyVaultAccessPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureRmKeyVaultAccessPolicy.md ---- - -# Remove-AzureRmKeyVaultAccessPolicy - -## SYNOPSIS -Removes all permissions for a user or application from a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByUserPrincipalName (Default) -``` -Remove-AzureRmKeyVaultAccessPolicy [-VaultName] <String> [[-ResourceGroupName] <String>] - -UserPrincipalName <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByObjectId -``` -Remove-AzureRmKeyVaultAccessPolicy [-VaultName] <String> [[-ResourceGroupName] <String>] -ObjectId <String> - [-ApplicationId <Guid>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByServicePrincipalName -``` -Remove-AzureRmKeyVaultAccessPolicy [-VaultName] <String> [[-ResourceGroupName] <String>] - -ServicePrincipalName <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByEmail -``` -Remove-AzureRmKeyVaultAccessPolicy [-VaultName] <String> [[-ResourceGroupName] <String>] -EmailAddress <String> - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ForVault -``` -Remove-AzureRmKeyVaultAccessPolicy [-VaultName] <String> [[-ResourceGroupName] <String>] - [-EnabledForDeployment] [-EnabledForTemplateDeployment] [-EnabledForDiskEncryption] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectByObjectId -``` -Remove-AzureRmKeyVaultAccessPolicy [-InputObject] <PSKeyVault> -ObjectId <String> [-ApplicationId <Guid>] - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectByServicePrincipalName -``` -Remove-AzureRmKeyVaultAccessPolicy [-InputObject] <PSKeyVault> -ServicePrincipalName <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectByUserPrincipalName -``` -Remove-AzureRmKeyVaultAccessPolicy [-InputObject] <PSKeyVault> -UserPrincipalName <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectByEmail -``` -Remove-AzureRmKeyVaultAccessPolicy [-InputObject] <PSKeyVault> -EmailAddress <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectForVault -``` -Remove-AzureRmKeyVaultAccessPolicy [-InputObject] <PSKeyVault> [-EnabledForDeployment] - [-EnabledForTemplateDeployment] [-EnabledForDiskEncryption] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdByObjectId -``` -Remove-AzureRmKeyVaultAccessPolicy [-ResourceId] <String> -ObjectId <String> [-ApplicationId <Guid>] - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdByServicePrincipalName -``` -Remove-AzureRmKeyVaultAccessPolicy [-ResourceId] <String> -ServicePrincipalName <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdByUserPrincipalName -``` -Remove-AzureRmKeyVaultAccessPolicy [-ResourceId] <String> -UserPrincipalName <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdByEmail -``` -Remove-AzureRmKeyVaultAccessPolicy [-ResourceId] <String> -EmailAddress <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdForVault -``` -Remove-AzureRmKeyVaultAccessPolicy [-ResourceId] <String> [-EnabledForDeployment] - [-EnabledForTemplateDeployment] [-EnabledForDiskEncryption] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmKeyVaultAccessPolicy** cmdlet removes all permissions for a user or application or for all users and applications from a key vault. -Even if you remove all permissions, the owner of the Azure subscription that contains the key vault can add permissions to the key vault. -Note that although specifying the resource group is optional for this cmdlet, you should do so for better performance. - -## EXAMPLES - -### Example 1: Remove permissions for a user -```powershell -PS C:\> Remove-AzureRmKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -UserPrincipalName 'PattiFuller@contoso.com' -PassThru - -Vault Name : Contoso03Vault -Resource Group Name : myrg -Location : westus -Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers - /Microsoft.KeyVault/vaults/contoso03vault -Vault URI : https://contoso03vault.vault.azure.net/ -Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx -SKU : Standard -Enabled For Deployment? : False -Enabled For Template Deployment? : False -Enabled For Disk Encryption? : False -Soft Delete Enabled? : -Access Policies : - Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx - Object ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx - Application ID : - Display Name : User Name (username@microsoft.com) - Permissions to Keys : - Permissions to Secrets : - Permissions to Certificates : get, create - Permissions to (Key Vault Managed) Storage : - - -Network Rule Set : - Default Action : Allow - Bypass : AzureServices - IP Rules : - Virtual Network Rules : - -Tags : -``` - -This command removes all the permissions that a user PattiFuller@contoso.com has on the key vault named Contoso03Vault. If -PassThru is specified, the KeyVault object is returned. - -### Example 2: Remove permissions for an application -```powershell -PS C:\> Remove-AzureRmKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -ServicePrincipalName 'http://payroll.contoso.com' -``` - -This command removes all the permissions that an application has on the key vault named Contoso03Vault. -This example identifies the application by using the service principal name registered in Microsoft Entra ID, `http://payroll.contoso.com`. - -### Example 3: Remove permissions for an application by using its object ID -```powershell -PS C:\> Remove-AzureRmKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -ObjectID 00001111-aaaa-2222-bbbb-3333cccc4444 -``` - -This command removes all the permissions that an application has on the key vault named Contoso03Vault. -This example identifies the application by the object ID of the service principal. - -### Example 4: Remove permissions for the Microsoft.Compute resource provider -```powershell -PS C:\> Remove-AzureRmKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -ResourceGroupName 'Group14' -EnabledForDeployment -``` - -This command removes permission for the Microsoft.Compute resource provider to get secrets from the Contoso03Vault. - -## PARAMETERS - -### -ApplicationId -Specifies the ID of application whose permissions should be removed - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: ByObjectId, InputObjectByObjectId, ResourceIdByObjectId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddress -Specifies the user email address of the user whose access you want to remove. - -```yaml -Type: System.String -Parameter Sets: ByEmail, InputObjectByEmail, ResourceIdByEmail -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnabledForDeployment -If specified, disables the retrieval of secrets from this key vault by the Microsoft.Compute resource provider when referenced in resource creation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ForVault, InputObjectForVault, ResourceIdForVault -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnabledForDiskEncryption -If specified, disables the retrieval of secrets from this key vault by Azure Disk Encryption. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ForVault, InputObjectForVault, ResourceIdForVault -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnabledForTemplateDeployment -If specified, disables the retrieval of secrets from this key vault by Azure Resource Manager when referenced in templates. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ForVault, InputObjectForVault, ResourceIdForVault -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Key Vault object. - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault -Parameter Sets: InputObjectByObjectId, InputObjectByServicePrincipalName, InputObjectByUserPrincipalName, InputObjectByEmail, InputObjectForVault -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ObjectId -Specifies the object ID of the user or service principal in Microsoft Entra ID for which to remove permissions. - -```yaml -Type: System.String -Parameter Sets: ByObjectId, InputObjectByObjectId, ResourceIdByObjectId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group associated with the key vault whose access policy is being modified. -If not specified, this cmdlet searches for the key vault in the current subscription. - -```yaml -Type: System.String -Parameter Sets: ByUserPrincipalName, ByObjectId, ByServicePrincipalName, ByEmail, ForVault -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -KeyVault Resource Id. - -```yaml -Type: System.String -Parameter Sets: ResourceIdByObjectId, ResourceIdByServicePrincipalName, ResourceIdByUserPrincipalName, ResourceIdByEmail, ResourceIdForVault -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServicePrincipalName -Specifies the service principal name of the application whose permissions you want to remove. -Specify the application ID, also known as client ID, registered for the application in Microsoft Entra ID. - -```yaml -Type: System.String -Parameter Sets: ByServicePrincipalName, InputObjectByServicePrincipalName, ResourceIdByServicePrincipalName -Aliases: SPN - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserPrincipalName -Specifies the user principal name of the user whose access you want to remove. - -```yaml -Type: System.String -Parameter Sets: ByUserPrincipalName, InputObjectByUserPrincipalName, ResourceIdByUserPrincipalName -Aliases: UPN - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault. -This cmdlet removes permissions for the key vault that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByUserPrincipalName, ByObjectId, ByServicePrincipalName, ByEmail, ForVault -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault - -## NOTES - -## RELATED LINKS - -[Set-AzureRmKeyVaultAccessPolicy](./Set-AzureRmKeyVaultAccessPolicy.md) diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureRmKeyVaultNetworkRule.md b/azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureRmKeyVaultNetworkRule.md deleted file mode 100644 index b3a8a0f9e2..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Remove-AzureRmKeyVaultNetworkRule.md +++ /dev/null @@ -1,256 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/add-azurermkeyvaultnetworkrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureRmKeyVaultNetworkRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureRmKeyVaultNetworkRule.md ---- - -# Remove-AzureRmKeyVaultNetworkRule - -## SYNOPSIS -Removes a network rule from a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVaultName (Default) -``` -Remove-AzureRmKeyVaultNetworkRule [-VaultName] <String> [[-ResourceGroupName] <String>] - [-IpAddressRange <String[]>] [-VirtualNetworkResourceId <String[]>] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByInputObject -``` -Remove-AzureRmKeyVaultNetworkRule [-InputObject] <PSKeyVault> [-IpAddressRange <String[]>] - [-VirtualNetworkResourceId <String[]>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Remove-AzureRmKeyVaultNetworkRule [-ResourceId] <String> [-IpAddressRange <String[]>] - [-VirtualNetworkResourceId <String[]>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Removes a network rule from a key vault. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> $myNetworkResId = (Get-AzureRmVirtualNetwork -Name myVNetName -ResourceGroupName myRG).Subnets[0].Id -PS C:\> Remove-AzureRmKeyVaultNetworkRule -VaultName myVault -IpAddressRange "10.0.0.1/26" -VirtualNetworkResourceId $myNetworkResId -PassThru - -Vault Name : myVault -Resource Group Name : myrg -Location : West US -Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers - /Microsoft.KeyVault/vaults/myvault -Vault URI : https://myvault.vault.azure.net/ -Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx -SKU : Standard -Enabled For Deployment? : False -Enabled For Template Deployment? : False -Enabled For Disk Encryption? : False -Soft Delete Enabled? : -Access Policies : - Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx - Object ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx - Application ID : - Display Name : User Name (username@microsoft.com) - Permissions to Keys : get, create, delete, list, update, - import, backup, restore, recover - Permissions to Secrets : get, list, set, delete, backup, - restore, recover - Permissions to Certificates : get, delete, list, create, import, - update, deleteissuers, getissuers, listissuers, managecontacts, manageissuers, - setissuers, recover, backup, restore - Permissions to (Key Vault Managed) Storage : delete, deletesas, get, getsas, list, - listsas, regeneratekey, set, setsas, update, recover, backup, restore - - -Network Rule Set : - Default Action : Allow - Bypass : AzureServices - IP Rules : - Virtual Network Rules : - -Tags : -``` - -This command removes a network rule from the specified vault, provided a rule is found matching the specified IP address and the virtual network resource identifier. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -KeyVault object - -```yaml -Type: PSKeyVault -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IpAddressRange -Specifies allowed network IP address range of network rule. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -This Cmdlet does not return an object by default. -If this switch is specified, it returns the updated key vault object. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group associated with the key vault whose network rule is being modified. - -```yaml -Type: String -Parameter Sets: ByVaultName -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -KeyVault Resource Id - -```yaml -Type: String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of a key vault whose network rule is being modified. - -```yaml -Type: String -Parameter Sets: ByVaultName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkResourceId -Specifies allowed virtual network resource identifier of network rule. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Restore-AzureKeyVaultCertificate.md b/azurermps-6.13.0/AzureRM.KeyVault/Restore-AzureKeyVaultCertificate.md deleted file mode 100644 index f072bfe2e2..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Restore-AzureKeyVaultCertificate.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/restore-azurekeyvaultcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Restore-AzureKeyVaultCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Restore-AzureKeyVaultCertificate.md ---- - -# Restore-AzureKeyVaultCertificate - -## SYNOPSIS -Restores a certificate in a key vault from a backup file. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVaultName (Default) -``` -Restore-AzureKeyVaultCertificate [-VaultName] <String> [-InputFile] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByInputObject -``` -Restore-AzureKeyVaultCertificate [-InputObject] <PSKeyVault> [-InputFile] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Restore-AzureKeyVaultCertificate [-ResourceId] <String> [-InputFile] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Restore-AzureKeyVaultCertificate** cmdlet creates a certificate in the specified key vault from a backup file. -This certificate is a replica of the backed-up certificate in the input file and has the same name as the original certificate. -If the key vault already contains a certificate by the same name, this cmdlet fails instead of overwriting the original certificate. -If the backup contains multiple versions of a certificate, all versions are restored. -The key vault that you restore the certificate into can be different from the key vault that you backed up the certificate from. -However, the key vault must use the same subscription and be in an Azure region in the same geography (for example, North America). -See the Microsoft Azure Trust Center (https://azure.microsoft.com/support/trust-center/) for the mapping of Azure regions to geographies. - -## EXAMPLES - -### Example 1: Restore a backed-up certificate -```powershell -PS C:\> Restore-AzureKeyVaultCertificate -VaultName 'MyKeyVault' -InputFile "C:\Backup.blob" - -Certificate : [Subject] - CN=contoso.com - - [Issuer] - CN=contoso.com - - [Serial Number] - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - - [Not Before] - 5/25/2018 3:47:41 AM - - [Not After] - 11/25/2018 2:57:41 AM - - [Thumbprint] - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - -KeyId : https://mykeyvault.vault.azure.net:443/keys/cert1/bd406f6d6b3a41a1a1c633494d8c3c3a -SecretId : https://mykeyvault.vault.azure.net:443/secrets/cert1/bd406f6d6b3a41a1a1c633494d8c3c3a -Thumbprint : XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX -RecoveryLevel : Purgeable -Enabled : True -Expires : 11/25/2018 10:57:41 AM -NotBefore : 5/25/2018 10:47:41 AM -Created : 5/25/2018 10:57:41 AM -Updated : 5/25/2018 10:57:41 AM -Tags : -VaultName : MyKeyVault -Name : cert1 -Version : bd406f6d6b3a41a1a1c633494d8c3c3a -Id : https://mykeyvault.vault.azure.net:443/certificates/cert1/bd406f6d6b3a41a1a1c633494d8c3c3a -``` - -This command restores a certificate, including all of its versions, from the backup file named Backup.blob into the key vault named MyKeyVault. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputFile -Input file. -The input file containing the backed-up blob - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -KeyVault object - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceId -KeyVault Resource Id - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: System.String -Parameter Sets: ByVaultName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificate - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Restore-AzureKeyVaultKey.md b/azurermps-6.13.0/AzureRM.KeyVault/Restore-AzureKeyVaultKey.md deleted file mode 100644 index 21653c10a7..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Restore-AzureKeyVaultKey.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: C4E7ACDF-22FB-4D49-93B3-69E787B7E0CD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/restore-azurekeyvaultkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Restore-AzureKeyVaultKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Restore-AzureKeyVaultKey.md ---- - -# Restore-AzureKeyVaultKey - -## SYNOPSIS -Creates a key in a key vault from a backed-up key. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVaultName (Default) -``` -Restore-AzureKeyVaultKey [-VaultName] <String> [-InputFile] <String> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByInputObject -``` -Restore-AzureKeyVaultKey [-InputObject] <PSKeyVault> [-InputFile] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Restore-AzureKeyVaultKey [-ResourceId] <String> [-InputFile] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Restore-AzureKeyVaultKey** cmdlet creates a key in the specified key vault. -This key is a replica of the backed-up key in the input file and has the same name as the original key. -If the key vault already has a key by the same name, this cmdlet fails instead of overwriting the original key. -If the backup contains multiple versions of a key, all versions are restored. -The key vault that you restore the key into can be different from the key vault that you backed up the key from. -However, the key vault must use the same subscription and be in an Azure region in the same geography (for example, North America). -See the Microsoft Azure Trust Center (https://azure.microsoft.com/support/trust-center/) for the mapping of Azure regions to geographies. - -## EXAMPLES - -### Example 1: Restore a backed-up key -```powershell -PS C:\> Restore-AzureKeyVaultKey -VaultName 'MyKeyVault' -InputFile "C:\Backup.blob" - -Vault Name : MyKeyVault -Name : key1 -Version : 394f9379a47a4e2086585468de6c7ae5 -Id : https://mykeyvault.vault.azure.net:443/keys/key1/394f9379a47a4e2086585468de6c7ae5 -Enabled : True -Expires : -Not Before : -Created : 4/6/2018 11:31:36 PM -Updated : 4/6/2018 11:35:04 PM -Purge Disabled : False -Tags : -``` - -This command restores a key, including all of its versions, from the backup file named Backup.blob into the key vault named MyKeyVault. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputFile -Specifies the input file that contains the backup of the key to restore. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -KeyVault object - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceId -KeyVault Resource Id - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault into which to restore the key. - -```yaml -Type: System.String -Parameter Sets: ByVaultName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKey - -## NOTES - -## RELATED LINKS - -[Add-AzureKeyVaultKey](./Add-AzureKeyVaultKey.md) - -[Backup-AzureKeyVaultKey](./Backup-AzureKeyVaultKey.md) - -[Get-AzureKeyVaultKey](./Get-AzureKeyVaultKey.md) - -[Remove-AzureKeyVaultKey](./Remove-AzureKeyVaultKey.md) - diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Restore-AzureKeyVaultManagedStorageAccount.md b/azurermps-6.13.0/AzureRM.KeyVault/Restore-AzureKeyVaultManagedStorageAccount.md deleted file mode 100644 index f228ccd58f..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Restore-AzureKeyVaultManagedStorageAccount.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/restore-azurekeyvaultmanagedstorageaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Restore-AzureKeyVaultManagedStorageAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Restore-AzureKeyVaultManagedStorageAccount.md ---- - -# Restore-AzureKeyVaultManagedStorageAccount - -## SYNOPSIS -Restores a managed storage account in a key vault from a backup file. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVaultName (Default) -``` -Restore-AzureKeyVaultManagedStorageAccount [-VaultName] <String> [-InputFile] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByInputObject -``` -Restore-AzureKeyVaultManagedStorageAccount [-InputObject] <PSKeyVault> [-InputFile] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Restore-AzureKeyVaultManagedStorageAccount [-ResourceId] <String> [-InputFile] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Restore-AzureKeyVaultManagedStorageAccount** cmdlet creates a managed storage account in the specified key vault from a backup file. -This managed storage account is a replica of the backed-up managed storage account in the input file and has the same name as the original. -If the key vault already contains a managed storage account by the same name, this cmdlet fails instead of overwriting the original. -The key vault that you restore the managed storage account into can be different from the key vault that you backed up the managed storage account from. -However, the key vault must use the same subscription and be in an Azure region in the same geography (for example, North America). -See the Microsoft Azure Trust Center (https://azure.microsoft.com/support/trust-center/) for the mapping of Azure regions to geographies. - -## EXAMPLES - -### Example 1: Restore a backed-up managed storage account -```powershell -PS C:\> Restore-AzureKeyVaultManagedStorageAccount -VaultName 'MyKeyVault' -InputFile "C:\Backup.blob" - -Id : https://mykeyvault.vault.azure.net:443/storage/mystorageaccount -Vault Name : MyKeyVault -AccountName : mystorageaccount -Account Resource Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.St - orage/storageAccounts/mystorageaccount -Active Key Name : key1 -Auto Regenerate Key : True -Regeneration Period : 90.00:00:00 -Enabled : True -Created : 5/21/2018 11:55:58 PM -Updated : 5/21/2018 11:55:58 PM -Tags : -``` - -This command restores a managed storage account, including all of its versions, from the backup file named Backup.blob into the key vault named MyKeyVault. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputFile -Input file. -The input file containing the backed-up blob - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -KeyVault object - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceId -KeyVault Resource Id - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: System.String -Parameter Sets: ByVaultName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccount - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Restore-AzureKeyVaultSecret.md b/azurermps-6.13.0/AzureRM.KeyVault/Restore-AzureKeyVaultSecret.md deleted file mode 100644 index 18da2452ef..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Restore-AzureKeyVaultSecret.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 70DB088D-4AF5-406B-8D66-118A0F766041 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/restore-azurekeyvaultsecret -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Restore-AzureKeyVaultSecret.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Restore-AzureKeyVaultSecret.md ---- - -# Restore-AzureKeyVaultSecret - -## SYNOPSIS -Creates a secret in a key vault from a backed-up secret. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVaultName (Default) -``` -Restore-AzureKeyVaultSecret [-VaultName] <String> [-InputFile] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByInputObject -``` -Restore-AzureKeyVaultSecret [-InputObject] <PSKeyVault> [-InputFile] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Restore-AzureKeyVaultSecret [-ResourceId] <String> [-InputFile] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Restore-AzureKeyVaultSecret** cmdlet creates a secret in the specified key vault. -This secret is a replica of the backed-up secret in the input file and has the same name as the original secret. -If the key vault already has a secret by the same name, this cmdlet fails instead of overwriting the original secret. -If the backup contains multiple versions of a secret, all versions are restored. -The key vault that you restore the secret into can be different from the key vault that you backed up the secret from. -However, the key vault must use the same subscription and be in an Azure region in the same geography (for example, North America). -See the Microsoft Azure Trust Center (https://azure.microsoft.com/support/trust-center/) for the mapping of Azure regions to geographies. - -## EXAMPLES - -### Example 1: Restore a backed-up secret -```powershell -PS C:\> Restore-AzureKeyVaultSecret -VaultName 'contoso' -InputFile "C:\Backup.blob" - -Vault Name : contoso -Name : secret1 -Version : 7128133570f84a71b48d7d0550deb74c -Id : https://contoso.vault.azure.net:443/secrets/secret1/7128133570f84a71b48d7d0550deb74c -Enabled : True -Expires : 4/6/2018 3:59:43 PM -Not Before : -Created : 4/5/2018 11:46:28 PM -Updated : 4/6/2018 11:30:17 PM -Content Type : -Tags : -``` - -This command restores a secret, including all of its versions, from the backup file named Backup.blob into the key vault named contoso. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputFile -Specifies the input file that contains the backup of the secret to restore. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -KeyVault object - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceId -KeyVault Resource Id - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault into which to restore the secret. - -```yaml -Type: System.String -Parameter Sets: ByVaultName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultSecret - -## NOTES - -## RELATED LINKS - -[Set-AzureKeyVaultSecret](./Set-AzureKeyVaultSecret.md) - -[Backup-AzureKeyVaultSecret](./Backup-AzureKeyVaultSecret.md) - -[Get-AzureKeyVaultSecret](./Get-AzureKeyVaultSecret.md) - -[Remove-AzureKeyVaultSecret](./Remove-AzureKeyVaultSecret.md) - diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Set-AzureKeyVaultCertificateIssuer.md b/azurermps-6.13.0/AzureRM.KeyVault/Set-AzureKeyVaultCertificateIssuer.md deleted file mode 100644 index 1b8668c93a..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Set-AzureKeyVaultCertificateIssuer.md +++ /dev/null @@ -1,248 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 4C2C77F7-ECE4-4106-8AF1-256A496A977B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/set-azurekeyvaultcertificateissuer -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultCertificateIssuer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultCertificateIssuer.md ---- - -# Set-AzureKeyVaultCertificateIssuer - -## SYNOPSIS -Sets a certificate issuer in a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Expanded (Default) -``` -Set-AzureKeyVaultCertificateIssuer [-VaultName] <String> [-Name] <String> -IssuerProvider <String> - [-AccountId <String>] [-ApiKey <SecureString>] - [-OrganizationDetails <PSKeyVaultCertificateOrganizationDetails>] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByValue -``` -Set-AzureKeyVaultCertificateIssuer [-VaultName] <String> [-Name] <String> - -InputObject <PSKeyVaultCertificateIssuerIdentityItem> [-PassThru] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Set-AzureKeyVaultCertificateIssuer cmdlet sets a certificate issuer in a key vault. - -## EXAMPLES - -### Example 1: Set a certificate issuer -```powershell -PS C:\> $AdminDetails = New-AzureKeyVaultCertificateAdministratorDetails -FirstName user -LastName name -EmailAddress username@microsoft.com -PS C:\> $OrgDetails = New-AzureKeyVaultCertificateOrganizationDetails -AdministrationDetails $AdminDetails -PS C:\> $Password = ConvertTo-SecureString -String P@ssw0rd -AsPlainText -Force -PS C:\> Set-AzureKeyVaultCertificateIssuer -VaultName "Contosokv01" -Name "TestIssuer01" -IssuerProvider "Test" -AccountId "555" -ApiKey $Password -OrganizationDetails $OrgDetails -PassThru - -AccountId : 555 -ApiKey : -OrganizationDetails : Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateOrganizationDetails -Name : TestIssuer01 -IssuerProvider : Test -VaultName : Contosokv01 -``` - -This command sets the properties for a certificate issuer. - -## PARAMETERS - -### -AccountId -Specifies the account ID for the certificate issuer. - -```yaml -Type: System.String -Parameter Sets: Expanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApiKey -Specifies the API key for the certificate issuer. - -```yaml -Type: System.Security.SecureString -Parameter Sets: Expanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the certificate issuer to set. - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIssuerIdentityItem -Parameter Sets: ByValue -Aliases: Issuer - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IssuerProvider -Specifies the type of certificate issuer. - -```yaml -Type: System.String -Parameter Sets: Expanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Issuer. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: IssuerName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationDetails -Organization details to be used with the issuer. - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateOrganizationDetails -Parameter Sets: Expanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateOrganizationDetails -Parameters: OrganizationDetails (ByValue) - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIssuerIdentityItem -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificatePolicy - -## NOTES - -## RELATED LINKS - -[Get-AzureKeyVaultCertificateIssuer](./Get-AzureKeyVaultCertificateIssuer.md) - -[Remove-AzureKeyVaultCertificateIssuer](./Remove-AzureKeyVaultCertificateIssuer.md) - diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Set-AzureKeyVaultCertificatePolicy.md b/azurermps-6.13.0/AzureRM.KeyVault/Set-AzureKeyVaultCertificatePolicy.md deleted file mode 100644 index cac1299adc..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Set-AzureKeyVaultCertificatePolicy.md +++ /dev/null @@ -1,476 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 28BC1B99-946C-4A8D-9581-4D5CC0BCEF8B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/set-azurekeyvaultcertificatepolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultCertificatePolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultCertificatePolicy.md ---- - -# Set-AzureKeyVaultCertificatePolicy - -## SYNOPSIS -Creates or updates the policy for a certificate in a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ExpandedRenewPercentage (Default) -``` -Set-AzureKeyVaultCertificatePolicy [-VaultName] <String> [-Name] <String> [-RenewAtPercentageLifetime <Int32>] - [-SecretContentType <String>] [-ReuseKeyOnRenewal <Boolean>] [-Disabled] [-SubjectName <String>] - [-DnsName <System.Collections.Generic.List`1[System.String]>] - [-KeyUsage <System.Collections.Generic.List`1[System.Security.Cryptography.X509Certificates.X509KeyUsageFlags]>] - [-Ekus <System.Collections.Generic.List`1[System.String]>] [-ValidityInMonths <Int32>] [-IssuerName <String>] - [-CertificateType <String>] [-EmailAtNumberOfDaysBeforeExpiry <Int32>] [-EmailAtPercentageLifetime <Int32>] - [-KeyType <String>] [-KeyNotExportable] [-CertificateTransparency <Boolean>] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByValue -``` -Set-AzureKeyVaultCertificatePolicy [-VaultName] <String> [-Name] <String> - [-InputObject] <PSKeyVaultCertificatePolicy> [-EmailAtNumberOfDaysBeforeExpiry <Int32>] - [-EmailAtPercentageLifetime <Int32>] [-KeyType <String>] [-CertificateTransparency <Boolean>] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ExpandedRenewNumber -``` -Set-AzureKeyVaultCertificatePolicy [-VaultName] <String> [-Name] <String> - -RenewAtNumberOfDaysBeforeExpiry <Int32> [-SecretContentType <String>] [-ReuseKeyOnRenewal <Boolean>] - [-Disabled] [-SubjectName <String>] [-DnsName <System.Collections.Generic.List`1[System.String]>] - [-KeyUsage <System.Collections.Generic.List`1[System.Security.Cryptography.X509Certificates.X509KeyUsageFlags]>] - [-Ekus <System.Collections.Generic.List`1[System.String]>] [-ValidityInMonths <Int32>] [-IssuerName <String>] - [-CertificateType <String>] [-EmailAtNumberOfDaysBeforeExpiry <Int32>] [-EmailAtPercentageLifetime <Int32>] - [-KeyType <String>] [-KeyNotExportable] [-CertificateTransparency <Boolean>] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureKeyVaultCertificatePolicy** cmdlet creates or updates the policy for a certificate in a key vault. - -## EXAMPLES - -### Example 1: Set a certificate policy -```powershell -PS C:\> Set-AzureKeyVaultCertificatePolicy -VaultName "ContosoKV01" -Name "TestCert01" -SecretContentType "application/x-pkcs12" -SubjectName "CN=contoso.com" -IssuerName "Self" -ValidityInMonths 6 -ReuseKeyOnRenewal $True -PassThru - -SecretContentType : application/x-pkcs12 -Kty : -KeySize : 2048 -Exportable : -ReuseKeyOnRenewal : True -SubjectName : CN=contoso.com -DnsNames : -KeyUsage : -Ekus : -ValidityInMonths : 6 -IssuerName : Self -CertificateType : -RenewAtNumberOfDaysBeforeExpiry : -RenewAtPercentageLifetime : -EmailAtNumberOfDaysBeforeExpiry : -EmailAtPercentageLifetime : -CertificateTransparency : -Enabled : True -Created : -Updated : -``` - -This command sets the policy for the TestCert01 certificate in the ContosoKV01 key vault. - -## PARAMETERS - -### -CertificateTransparency -Indicates whether certificate transparency is enabled for this certificate/issuer; if not specified, the default is 'true' - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CertificateType -Specifies the type of certificate to the issuer. - -```yaml -Type: System.String -Parameter Sets: ExpandedRenewPercentage, ExpandedRenewNumber -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disabled -Indicates that the certificate policy is disabled. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ExpandedRenewPercentage, ExpandedRenewNumber -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DnsName -Specifies the subject name of the certificate. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: ExpandedRenewPercentage, ExpandedRenewNumber -Aliases: DnsNames - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Ekus -Specifies the enhanced key usages (EKUs) in the certificate. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: ExpandedRenewPercentage, ExpandedRenewNumber -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAtNumberOfDaysBeforeExpiry -Specifies the number of days before expiration when automatic renewal should start. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAtPercentageLifetime -Specifies the percentage of the lifetime after which the automatic process for the notification begins. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the certificate policy. - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificatePolicy -Parameter Sets: ByValue -Aliases: CertificatePolicy - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -IssuerName -Specifies the name of the issuer for this certificate. - -```yaml -Type: System.String -Parameter Sets: ExpandedRenewPercentage, ExpandedRenewNumber -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyNotExportable -Indicates that the key is not exportable. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ExpandedRenewPercentage, ExpandedRenewNumber -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyType -Specifies the key type of the key that backs the certificate. -The acceptable values for this parameter are: -- RSA -- RSA-HSM - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: RSA, RSA-HSM - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyUsage -Specifies the key usages in the certificate. - -```yaml -Type: System.Collections.Generic.List`1[System.Security.Cryptography.X509Certificates.X509KeyUsageFlags] -Parameter Sets: ExpandedRenewPercentage, ExpandedRenewNumber -Aliases: -Accepted values: None, EncipherOnly, CrlSign, KeyCertSign, KeyAgreement, DataEncipherment, KeyEncipherment, NonRepudiation, DigitalSignature, DecipherOnly - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the certificate. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: CertificateName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RenewAtNumberOfDaysBeforeExpiry -Specifies the number of days before expiry after which the automatic process for certificate renewal begins. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: ExpandedRenewNumber -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RenewAtPercentageLifetime -Specifies the percentage of the lifetime after which the automatic process for certificate renewal begins. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: ExpandedRenewPercentage -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReuseKeyOnRenewal -Indicates that the certificate reuse the key during renewal. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: ExpandedRenewPercentage, ExpandedRenewNumber -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecretContentType -Specifies the content type of the new key vault secret. -The acceptable values for this parameter are: -- application/x-pkcs12 -- application/x-pem-file - -```yaml -Type: System.String -Parameter Sets: ExpandedRenewPercentage, ExpandedRenewNumber -Aliases: -Accepted values: application/x-pkcs12, application/x-pem-file - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubjectName -Specifies the subject name of the certificate. - -```yaml -Type: System.String -Parameter Sets: ExpandedRenewPercentage, ExpandedRenewNumber -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ValidityInMonths -Specifies the number of months the certificate is valid. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: ExpandedRenewPercentage, ExpandedRenewNumber -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of a key vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificatePolicy - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificatePolicy - -## NOTES - -## RELATED LINKS - -[Get-AzureKeyVaultCertificatePolicy](./Get-AzureKeyVaultCertificatePolicy.md) - -[New-AzureKeyVaultCertificatePolicy](./New-AzureKeyVaultCertificatePolicy.md) - diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Set-AzureKeyVaultManagedStorageSasDefinition.md b/azurermps-6.13.0/AzureRM.KeyVault/Set-AzureKeyVaultManagedStorageSasDefinition.md deleted file mode 100644 index 8499dd93de..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Set-AzureKeyVaultManagedStorageSasDefinition.md +++ /dev/null @@ -1,267 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/set-azurekeyvaultmanagedstoragesasdefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultManagedStorageSasDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultManagedStorageSasDefinition.md ---- - -# Set-AzureKeyVaultManagedStorageSasDefinition - -## SYNOPSIS -Sets a Shared Access Signature (SAS) definition with Key Vault for a given Key Vault managed Azure Storage Account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Default (Default) -``` -Set-AzureKeyVaultManagedStorageSasDefinition [-VaultName] <String> [-AccountName] <String> [-Name] <String> - [-TemplateUri] <String> [-SasType] <String> [-Disable] [-Tag <Hashtable>] -ValidityPeriod <TimeSpan> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByInputObject -``` -Set-AzureKeyVaultManagedStorageSasDefinition [-InputObject] <PSKeyVaultManagedStorageAccountIdentityItem> - [-Name] <String> [-TemplateUri] <String> [-SasType] <String> [-Disable] [-Tag <Hashtable>] - -ValidityPeriod <TimeSpan> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Sets a Shared Access Signature (SAS) definition with a given Key Vault managed Azure Storage -Account. This also sets a secret which can be used to get the SAS token per this SAS definition. -SAS token is generated using these parameters and the active key of the Key Vault managed Azure -Storage Account. - -## EXAMPLES - -### Example 1 : Set an account-type SAS definition, and obtain a current SAS token based on it -```powershell -PS C:\> $sa = Get-AzureRmStorageAccount -Name mysa -ResourceGroupName myrg -PS C:\> $kv = Get-AzureRmKeyVault -VaultName mykv -PS C:\> Add-AzureKeyVaultManagedStorageAccount -VaultName $kv.VaultName -AccountName $sa.StorageAccountName -AccountResourceId $sa.Id -ActiveKeyName key1 -RegenerationPeriod 180 -PS C:\> $sctx = New-AzureStorageContext -StorageAccountName $sa.StorageAccountName -Protocol Https -StorageAccountKey Key1 -PS C:\> $start = [System.DateTime]::Now.AddDays(-1) -PS C:\> $end = [System.DateTime]::Now.AddMonths(1) -PS C:\> $at = New-AzureStorageAccountSasToken -Service blob,file,Table,Queue -ResourceType Service,Container,Object -Permission "racwdlup" -Protocol HttpsOnly -StartTime $start -ExpiryTime $end -Context $sctx -PS C:\> $sas = Set-AzureKeyVaultManagedStorageSasDefinition -AccountName $sa.StorageAccountName -VaultName $kv.VaultName -Name accountsas -TemplateUri $at -SasType 'account' -ValidityPeriod ([System.Timespan]::FromDays(30)) -PS C:\> Get-AzureKeyVaultSecret -VaultName $kv.VaultName -Name $sas.Sid.Substring($sas.Sid.LastIndexOf('/')+1) -``` - -Sets an account SAS definition 'accountsas' on a KeyVault-managed storage account 'mysa' in vault 'mykv'. Specifically, the sequence above performs the following: - - gets a (pre-existing) storage account - - gets a (pre-existing) key vault - - adds a KeyVault-managed storage account to the vault, setting Key1 as the active key, and with a regeneration period of 180 days - - sets a storage context for the specified storage account, with Key1 - - creates an account SAS token for services Blob, File, Table and Queue, for resource types Service, Container and Object, with all permissions, over https and with the specified start and end dates - - sets a KeyVault-managed storage SAS definition in the vault, with the template uri as the SAS token created above, of SAS type 'account' and valid for 30 days - - retrieves the actual access token from the KeyVault secret corresponding to the SAS definition - -## PARAMETERS - -### -AccountName -Key Vault managed storage account name. Cmdlet constructs the FQDN of a managed storage account -name from vault name, currently selected environment and manged storage account name. - -```yaml -Type: System.String -Parameter Sets: Default -Aliases: StorageAccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disable -Disables the use of sas definition for generation of sas token. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -ManagedStorageAccount object. - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccountIdentityItem -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Storage sas definition name. Cmdlet constructs the FQDN of a storage sas definition from vault -name, currently selected environment, storage account name and sas definition name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: SasDefinitionName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SasType -Storage SAS type. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TemplateUri -Storage SAS definition template uri. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ValidityPeriod -Validity period that will get used to set the expiry time of sas token from the time it gets generated - -```yaml -Type: System.Nullable`1[System.TimeSpan] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: System.String -Parameter Sets: Default -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccountIdentityItem -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageSasDefinition - -## NOTES - -## RELATED LINKS - -[Azure​RM.​Key​Vault](/powershell/module/azurerm.keyvault/) diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Set-AzureKeyVaultSecret.md b/azurermps-6.13.0/AzureRM.KeyVault/Set-AzureKeyVaultSecret.md deleted file mode 100644 index dae370ffeb..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Set-AzureKeyVaultSecret.md +++ /dev/null @@ -1,308 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 9FC72DE9-46BB-4CB5-9880-F53756DBE012 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/set-azurekeyvaultsecret -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultSecret.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultSecret.md ---- - -# Set-AzureKeyVaultSecret - -## SYNOPSIS -Creates or updates a secret in a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Default (Default) -``` -Set-AzureKeyVaultSecret [-VaultName] <String> [-Name] <String> [-SecretValue] <SecureString> [-Disable] - [-Expires <DateTime>] [-NotBefore <DateTime>] [-ContentType <String>] [-Tag <Hashtable>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObject -``` -Set-AzureKeyVaultSecret [-InputObject] <PSKeyVaultSecretIdentityItem> [-SecretValue] <SecureString> [-Disable] - [-Expires <DateTime>] [-NotBefore <DateTime>] [-ContentType <String>] [-Tag <Hashtable>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureKeyVaultSecret** cmdlet creates or updates a secret in a key vault in Azure Key -Vault. If the secret does not exist, this cmdlet creates it. If the secret already exists, this -cmdlet creates a new version of that secret. - -## EXAMPLES - -### Example 1: Modify the value of a secret using default attributes -```powershell -PS C:\> $Secret = ConvertTo-SecureString -String 'Password' -AsPlainText -Force -PS C:\> Set-AzureKeyVaultSecret -VaultName 'Contoso' -Name 'ITSecret' -SecretValue $Secret - -Vault Name : Contoso -Name : ITSecret -Version : 8b5c0cb0326e4350bd78200fac932b51 -Id : https://contoso.vault.azure.net:443/secrets/ITSecret/8b5c0cb0326e4350bd78200fac932b51 -Enabled : True -Expires : -Not Before : -Created : 5/25/2018 6:39:30 PM -Updated : 5/25/2018 6:39:30 PM -Content Type : -Tags : -``` - -The first command converts a string into a secure string by using the **ConvertTo-SecureString** -cmdlet, and then stores that string in the $Secret variable. For more information, type `Get-Help -ConvertTo-SecureString`. -The second command modifies value of the secret named ITSecret in the key vault named Contoso. The -secret value becomes the value stored in $Secret. - -### Example 2: Modify the value of a secret using custom attributes -```powershell -PS C:\> $Secret = ConvertTo-SecureString -String 'Password' -AsPlainText -Force -PS C:\> $Expires = (Get-Date).AddYears(2).ToUniversalTime() -PS C:\> $NBF =(Get-Date).ToUniversalTime() -PS C:\> $Tags = @{ 'Severity' = 'medium'; 'IT' = 'true'} -PS C:\> $ContentType = 'txt' -PS C:\> Set-AzureKeyVaultSecret -VaultName 'Contoso' -Name 'ITSecret' -SecretValue $Secret -Expires $Expires -NotBefore $NBF -ContentType $ContentType -Disable -Tags $Tags - -Vault Name : Contoso -Name : ITSecret -Version : a2c150be3ea24dd6b8286986e6364851 -Id : https://contoso.vault.azure.net:443/secrets/ITSecret/a2c150be3ea24dd6b8286986e6364851 -Enabled : False -Expires : 5/25/2020 6:40:00 PM -Not Before : 5/25/2018 6:40:05 PM -Created : 5/25/2018 6:41:22 PM -Updated : 5/25/2018 6:41:22 PM -Content Type : txt -Tags : Name Value - Severity medium - IT true -``` - -The first command converts a string into a secure string by using the **ConvertTo-SecureString** -cmdlet, and then stores that string in the $Secret variable. For more information, type `Get-Help -ConvertTo-SecureString`. -The next commands define custom attributes for the expiry date, tags, and context type, and store -the attributes in variables. -The final command modifies values of the secret named ITSecret in the key vault named Contoso, by -using the values specified previously as variables. - -## PARAMETERS - -### -ContentType -Specifies the content type of a secret. -To delete the existing content type, specify an empty string. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disable -Indicates that this cmdlet disables a secret. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expires -Specifies the expiration time, as a **DateTime** object, for the secret that this cmdlet updates. -This parameter uses Coordinated Universal Time (UTC). To obtain a **DateTime** object, use the -**Get-Date** cmdlet. For more information, type `Get-Help Get-Date`. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Secret object - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultSecretIdentityItem -Parameter Sets: InputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a secret to modify. This cmdlet constructs the fully qualified domain name -(FQDN) of a secret based on the name that this parameter specifies, the name of the key vault, and -your current environment. - -```yaml -Type: System.String -Parameter Sets: Default -Aliases: SecretName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotBefore -Specifies the time, as a **DateTime** object, before which the secret cannot be used. This -parameter uses UTC. To obtain a **DateTime** object, use the **Get-Date** cmdlet. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecretValue -Specifies the value for the secret as a **SecureString** object. To obtain a **SecureString** -object, use the **ConvertTo-SecureString** cmdlet. For more information, type `Get-Help -ConvertTo-SecureString`. - -```yaml -Type: System.Security.SecureString -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault to which this secret belongs. This cmdlet constructs the FQDN -of a key vault based on the name that this parameter specifies and your current environment. - -```yaml -Type: System.String -Parameter Sets: Default -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultSecretIdentityItem -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultSecret - -## NOTES - -## RELATED LINKS - -[Get-AzureKeyVaultSecret](./Get-AzureKeyVaultSecret.md) - -[Remove-AzureKeyVaultSecret](./Remove-AzureKeyVaultSecret.md) diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Set-AzureRmKeyVaultAccessPolicy.md b/azurermps-6.13.0/AzureRM.KeyVault/Set-AzureRmKeyVaultAccessPolicy.md deleted file mode 100644 index 7a07b089df..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Set-AzureRmKeyVaultAccessPolicy.md +++ /dev/null @@ -1,677 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 636FAD5B-8C39-4E5C-8978-6845C6B89BC0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/set-azurermkeyvaultaccesspolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureRmKeyVaultAccessPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureRmKeyVaultAccessPolicy.md ---- - -# Set-AzureRmKeyVaultAccessPolicy - -## SYNOPSIS -Grants or modifies existing permissions for a user, application, or security group to perform operations with a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByUserPrincipalName (Default) -``` -Set-AzureRmKeyVaultAccessPolicy [-VaultName] <String> [[-ResourceGroupName] <String>] - -UserPrincipalName <String> [-PermissionsToKeys <String[]>] [-PermissionsToSecrets <String[]>] - [-PermissionsToCertificates <String[]>] [-PermissionsToStorage <String[]>] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByObjectId -``` -Set-AzureRmKeyVaultAccessPolicy [-VaultName] <String> [[-ResourceGroupName] <String>] -ObjectId <String> - [-ApplicationId <Guid>] [-PermissionsToKeys <String[]>] [-PermissionsToSecrets <String[]>] - [-PermissionsToCertificates <String[]>] [-PermissionsToStorage <String[]>] [-BypassObjectIdValidation] - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByServicePrincipalName -``` -Set-AzureRmKeyVaultAccessPolicy [-VaultName] <String> [[-ResourceGroupName] <String>] - -ServicePrincipalName <String> [-PermissionsToKeys <String[]>] [-PermissionsToSecrets <String[]>] - [-PermissionsToCertificates <String[]>] [-PermissionsToStorage <String[]>] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByEmailAddress -``` -Set-AzureRmKeyVaultAccessPolicy [-VaultName] <String> [[-ResourceGroupName] <String>] -EmailAddress <String> - [-PermissionsToKeys <String[]>] [-PermissionsToSecrets <String[]>] [-PermissionsToCertificates <String[]>] - [-PermissionsToStorage <String[]>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ForVault -``` -Set-AzureRmKeyVaultAccessPolicy [-VaultName] <String> [[-ResourceGroupName] <String>] [-EnabledForDeployment] - [-EnabledForTemplateDeployment] [-EnabledForDiskEncryption] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectByObjectId -``` -Set-AzureRmKeyVaultAccessPolicy [-InputObject] <PSKeyVaultIdentityItem> -ObjectId <String> - [-ApplicationId <Guid>] [-PermissionsToKeys <String[]>] [-PermissionsToSecrets <String[]>] - [-PermissionsToCertificates <String[]>] [-PermissionsToStorage <String[]>] [-BypassObjectIdValidation] - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectByServicePrincipalName -``` -Set-AzureRmKeyVaultAccessPolicy [-InputObject] <PSKeyVaultIdentityItem> -ServicePrincipalName <String> - [-PermissionsToKeys <String[]>] [-PermissionsToSecrets <String[]>] [-PermissionsToCertificates <String[]>] - [-PermissionsToStorage <String[]>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### InputObjectByUserPrincipalName -``` -Set-AzureRmKeyVaultAccessPolicy [-InputObject] <PSKeyVaultIdentityItem> -UserPrincipalName <String> - [-PermissionsToKeys <String[]>] [-PermissionsToSecrets <String[]>] [-PermissionsToCertificates <String[]>] - [-PermissionsToStorage <String[]>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### InputObjectByEmailAddress -``` -Set-AzureRmKeyVaultAccessPolicy [-InputObject] <PSKeyVaultIdentityItem> -EmailAddress <String> - [-PermissionsToKeys <String[]>] [-PermissionsToSecrets <String[]>] [-PermissionsToCertificates <String[]>] - [-PermissionsToStorage <String[]>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### InputObjectForVault -``` -Set-AzureRmKeyVaultAccessPolicy [-InputObject] <PSKeyVaultIdentityItem> [-EnabledForDeployment] - [-EnabledForTemplateDeployment] [-EnabledForDiskEncryption] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdByObjectId -``` -Set-AzureRmKeyVaultAccessPolicy [-ResourceId] <String> -ObjectId <String> [-ApplicationId <Guid>] - [-PermissionsToKeys <String[]>] [-PermissionsToSecrets <String[]>] [-PermissionsToCertificates <String[]>] - [-PermissionsToStorage <String[]>] [-BypassObjectIdValidation] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdByServicePrincipalName -``` -Set-AzureRmKeyVaultAccessPolicy [-ResourceId] <String> -ServicePrincipalName <String> - [-PermissionsToKeys <String[]>] [-PermissionsToSecrets <String[]>] [-PermissionsToCertificates <String[]>] - [-PermissionsToStorage <String[]>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ResourceIdByUserPrincipalName -``` -Set-AzureRmKeyVaultAccessPolicy [-ResourceId] <String> -UserPrincipalName <String> - [-PermissionsToKeys <String[]>] [-PermissionsToSecrets <String[]>] [-PermissionsToCertificates <String[]>] - [-PermissionsToStorage <String[]>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ResourceIdByEmailAddress -``` -Set-AzureRmKeyVaultAccessPolicy [-ResourceId] <String> -EmailAddress <String> [-PermissionsToKeys <String[]>] - [-PermissionsToSecrets <String[]>] [-PermissionsToCertificates <String[]>] [-PermissionsToStorage <String[]>] - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdForVault -``` -Set-AzureRmKeyVaultAccessPolicy [-ResourceId] <String> [-EnabledForDeployment] [-EnabledForTemplateDeployment] - [-EnabledForDiskEncryption] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmKeyVaultAccessPolicy** cmdlet grants or modifies existing permissions for a user, application, or security group to perform the specified operations with a key vault. It does not modify the permissions that other users, applications, or security groups have on the key vault. -If you are setting permissions for a security group, this operation affects only users in that security group. -The following directories must all be the same Azure directory: -- The default directory of the Azure subscription in which the key vault resides. -- The Azure directory that contains the user or application group that you are granting permissions to. -Examples of scenarios when these conditions are not met and this cmdlet will not work are: -- Authorizing a user from a different organization to manage your key vault. -Each organization has its own directory. -- Your Azure account has multiple directories. -If you register an application in a directory other than the default directory, you cannot authorize that application to use your key vault. -The application must be in the default directory. -Note that although specifying the resource group is optional for this cmdlet, you should do so for better performance. - -## EXAMPLES - -### Example 1: Grant permissions to a user for a key vault and modify the permissions -```powershell -PS C:\> Set-AzureRmKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -UserPrincipalName 'PattiFuller@contoso.com' -PermissionsToKeys create,import,delete,list -PermissionsToSecrets set,delete -PassThru - -Vault Name : Contoso03Vault -Resource Group Name : myrg -Location : westus -Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers - /Microsoft.KeyVault/vaults/contoso03vault -Vault URI : https://contoso03vault.vault.azure.net/ -Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx -SKU : Standard -Enabled For Deployment? : True -Enabled For Template Deployment? : False -Enabled For Disk Encryption? : False -Soft Delete Enabled? : True -Access Policies : - Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx - Object ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx - Application ID : - Display Name : User Name (username@microsoft.com) - Permissions to Keys : create, import, delete, list - Permissions to Secrets : set, delete - Permissions to Certificates : - Permissions to (Key Vault Managed) Storage : - -Tags : - -PS C:\> Set-AzureRmKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -UserPrincipalName 'PattiFuller@contoso.com' -PermissionsToSecrets set,delete,get -PassThru - -Vault Name : Contoso03Vault -Resource Group Name : myrg -Location : westus -Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers - /Microsoft.KeyVault/vaults/contoso03vault -Vault URI : https://contoso03vault.vault.azure.net/ -Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx -SKU : Standard -Enabled For Deployment? : True -Enabled For Template Deployment? : False -Enabled For Disk Encryption? : False -Soft Delete Enabled? : True -Access Policies : - Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx - Object ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx - Application ID : - Display Name : User Name (username@microsoft.com) - Permissions to Keys : create, import, delete, list - Permissions to Secrets : set, delete, get - Permissions to Certificates : - Permissions to (Key Vault Managed) Storage : - -Tags : - -PS C:\> Set-AzureRmKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -UserPrincipalName 'PattiFuller@contoso.com' -PermissionsToKeys @() -PassThru - -Vault Name : Contoso03Vault -Resource Group Name : myrg -Location : westus -Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers - /Microsoft.KeyVault/vaults/contoso03vault -Vault URI : https://contoso03vault.vault.azure.net/ -Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx -SKU : Standard -Enabled For Deployment? : True -Enabled For Template Deployment? : False -Enabled For Disk Encryption? : False -Soft Delete Enabled? : True -Access Policies : - Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx - Object ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx - Application ID : - Display Name : User Name (username@microsoft.com) - Permissions to Keys : - Permissions to Secrets : set, delete, get - Permissions to Certificates : - Permissions to (Key Vault Managed) Storage : - -Tags : -``` - -The first command grants permissions for a user in your Microsoft Entra ID, PattiFuller@contoso.com, to perform operations on keys and secrets with a key vault named Contoso03Vault. The *PassThru* parameter results in the updated object being returned by the cmdlet. -The second command modifies the permissions that were granted to PattiFuller@contoso.com in the first command, to now allow getting secrets in addition to setting and deleting them. The permissions to key operations remain unchanged after this command. -The final command further modifies the existing permissions for PattiFuller@contoso.com to remove all permissions to key operations. The permissions to secret operations remain unchanged after this command. - -### Example 2: Grant permissions for an application service principal to read and write secrets -```powershell -PS C:\> Set-AzureRmKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -ServicePrincipalName 'http://payroll.contoso.com' -PermissionsToSecrets Get,Set -``` - -This command grants permissions for an application for a key vault named Contoso03Vault. -The *ServicePrincipalName* parameter specifies the application. The application must be registered in your Microsoft Entra ID. The value of the *ServicePrincipalName* parameter must be either the service principal name of the application or the application ID GUID. -This example specifies the service principal name `http://payroll.contoso.com`, and the command grants the application permissions to read and write secrets. - -### Example 3: Grant permissions for an application using its object ID -```powershell -PS C:\> Set-AzureRmKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 -PermissionsToSecrets Get,Set -``` - -This command grants the application permissions to read and write secrets. -This example specifies the application using the object ID of the service principal of the application. - -### Example 4: Grant permissions for a user principal name -```powershell -PS C:\> Set-AzureRmKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -UserPrincipalName 'PattiFuller@contoso.com' -PermissionsToSecrets Get,List,Set -``` - -This command grants get, list, and set permissions for the specified user principal name for access to secrets. - -### Example 5: Enable secrets to be retrieved from a key vault by the Microsoft.Compute resource provider -```powershell -PS C:\> Set-AzureRmKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -ResourceGroupName 'Group14' -EnabledForDeployment -``` - -This command grants the permissions for secrets to be retrieved from the Contoso03Vault key vault by the Microsoft.Compute resource provider. - -### Example 6: Grant permissions to a security group -```powershell -PS C:\> Get-AzureRmADGroup -PS C:\> Set-AzureRmKeyVaultAccessPolicy -VaultName 'myownvault' -ObjectId (Get-AzureRmADGroup -SearchString 'group2')[0].Id -PermissionsToKeys get, set -PermissionsToSecrets get, set -``` - -The first command uses the Get-AzureRmADGroup cmdlet to get all Active Directory groups. From the output, you see 3 groups returned, named **group1**, **group2**, and **group3**. Multiple groups can have the same name but always have a unique ObjectId. When more than one group that has the same name is returned, use the ObjectId in the output to identify the one you want to use. -You then use the output of this command with Set-AzureRmKeyVaultAccessPolicy to grant permissions to group2 for your key vault, named **myownvault**. This example enumerates the groups named 'group2' inline in the same command line. -There may be multiple groups in the returned list that are named 'group2'. -This example picks the first one, indicated by index \[0\] in the returned list. - -### Example 7: Grant Azure Information Protection access to the customer-managed tenant key (BYOK) -```powershell -PS C:\> Set-AzureRmKeyVaultAccessPolicy -VaultName 'Contoso04Vault' -ServicePrincipalName 00000012-0000-0000-c000-000000000000 -PermissionsToKeys decrypt,sign,get -``` - -This command authorizes Azure Information Protection to use a customer-managed key (the bring your own key, or "BYOK" scenario) as the Azure Information Protection tenant key. -When you run this command, specify your own key vault name but you must specify the *ServicePrincipalName* parameter with the GUID **00000012-0000-0000-c000-000000000000** and specify the permissions in the example. - -## PARAMETERS - -### -ApplicationId -For future use. - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: ByObjectId, InputObjectByObjectId, ResourceIdByObjectId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BypassObjectIdValidation -Enables you to specify an object ID without validating that the object exists in Microsoft Entra ID. -Use this parameter only if you want to grant access to your key vault to an object ID that refers to a delegated security group from another Azure tenant. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByObjectId, InputObjectByObjectId, ResourceIdByObjectId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddress -Specifies the user email address of the user to whom to grant permissions. -This email address must exist in the directory associated with the current subscription and be unique. - -```yaml -Type: System.String -Parameter Sets: ByEmailAddress, InputObjectByEmailAddress, ResourceIdByEmailAddress -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnabledForDeployment -Enables the Microsoft.Compute resource provider to retrieve secrets from this key vault when this key vault is referenced in resource creation, for example when creating a virtual machine. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ForVault, InputObjectForVault, ResourceIdForVault -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnabledForDiskEncryption -Enables the Azure disk encryption service to get secrets and unwrap keys from this key vault. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ForVault, InputObjectForVault, ResourceIdForVault -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnabledForTemplateDeployment -Enables Azure Resource Manager to get secrets from this key vault when this key vault is referenced in a template deployment. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ForVault, InputObjectForVault, ResourceIdForVault -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Key Vault Object - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultIdentityItem -Parameter Sets: InputObjectByObjectId, InputObjectByServicePrincipalName, InputObjectByUserPrincipalName, InputObjectByEmailAddress, InputObjectForVault -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ObjectId -Specifies the object ID of the user or service principal in Microsoft Entra ID for which to grant permissions. - -```yaml -Type: System.String -Parameter Sets: ByObjectId, InputObjectByObjectId, ResourceIdByObjectId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PermissionsToCertificates -Specifies an array of certificate permissions to grant to a user or service principal. -The acceptable values for this parameter: -- Get -- List -- Delete -- Create -- Import -- Update -- Managecontacts -- Getissuers -- Listissuers -- Setissuers -- Deleteissuers -- Manageissuers -- Recover -- Backup -- Restore -- Purge - -```yaml -Type: System.String[] -Parameter Sets: ByUserPrincipalName, ByObjectId, ByServicePrincipalName, ByEmailAddress, InputObjectByObjectId, InputObjectByServicePrincipalName, InputObjectByUserPrincipalName, InputObjectByEmailAddress, ResourceIdByObjectId, ResourceIdByServicePrincipalName, ResourceIdByUserPrincipalName, ResourceIdByEmailAddress -Aliases: -Accepted values: get, list, delete, create, import, update, managecontacts, getissuers, listissuers, setissuers, deleteissuers, manageissuers, recover, purge, backup, restore - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PermissionsToKeys -Specifies an array of key operation permissions to grant to a user or service principal. -The acceptable values for this parameter: -- Decrypt -- Encrypt -- UnwrapKey -- WrapKey -- Verify -- Sign -- Get -- List -- Update -- Create -- Import -- Delete -- Backup -- Restore -- Recover -- Purge - -```yaml -Type: System.String[] -Parameter Sets: ByUserPrincipalName, ByObjectId, ByServicePrincipalName, ByEmailAddress, InputObjectByObjectId, InputObjectByServicePrincipalName, InputObjectByUserPrincipalName, InputObjectByEmailAddress, ResourceIdByObjectId, ResourceIdByServicePrincipalName, ResourceIdByUserPrincipalName, ResourceIdByEmailAddress -Aliases: -Accepted values: decrypt, encrypt, unwrapKey, wrapKey, verify, sign, get, list, update, create, import, delete, backup, restore, recover, purge - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PermissionsToSecrets -Specifies an array of secret operation permissions to grant to a user or service principal. -The acceptable values for this parameter: -- Get -- List -- Set -- Delete -- Backup -- Restore -- Recover -- Purge - -```yaml -Type: System.String[] -Parameter Sets: ByUserPrincipalName, ByObjectId, ByServicePrincipalName, ByEmailAddress, InputObjectByObjectId, InputObjectByServicePrincipalName, InputObjectByUserPrincipalName, InputObjectByEmailAddress, ResourceIdByObjectId, ResourceIdByServicePrincipalName, ResourceIdByUserPrincipalName, ResourceIdByEmailAddress -Aliases: -Accepted values: get, list, set, delete, backup, restore, recover, purge - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PermissionsToStorage -Specifies managed storage account and SaS-definition operation permissions to grant to a user or service principal. - -```yaml -Type: System.String[] -Parameter Sets: ByUserPrincipalName, ByObjectId, ByServicePrincipalName, ByEmailAddress, InputObjectByObjectId, InputObjectByServicePrincipalName, InputObjectByUserPrincipalName, InputObjectByEmailAddress, ResourceIdByObjectId, ResourceIdByServicePrincipalName, ResourceIdByUserPrincipalName, ResourceIdByEmailAddress -Aliases: -Accepted values: get, list, delete, set, update, regeneratekey, getsas, listsas, deletesas, setsas, recover, backup, restore, purge - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: ByUserPrincipalName, ByObjectId, ByServicePrincipalName, ByEmailAddress, ForVault -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Key Vault Resource Id - -```yaml -Type: System.String -Parameter Sets: ResourceIdByObjectId, ResourceIdByServicePrincipalName, ResourceIdByUserPrincipalName, ResourceIdByEmailAddress, ResourceIdForVault -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServicePrincipalName -Specifies the service principal name of the application to which to grant permissions. -Specify the application ID, also known as client ID, registered for the application in Microsoft Entra ID. The application with the service principal name that this parameter specifies must be registered in the Azure directory that contains your current subscription. - -```yaml -Type: System.String -Parameter Sets: ByServicePrincipalName, InputObjectByServicePrincipalName, ResourceIdByServicePrincipalName -Aliases: SPN - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserPrincipalName -Specifies the user principal name of the user to whom to grant permissions. -This user principal name must exist in the directory associated with the current subscription. - -```yaml -Type: System.String -Parameter Sets: ByUserPrincipalName, InputObjectByUserPrincipalName, ResourceIdByUserPrincipalName -Aliases: UPN - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of a key vault. -This cmdlet modifies the access policy for the key vault that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ByUserPrincipalName, ByObjectId, ByServicePrincipalName, ByEmailAddress, ForVault -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultIdentityItem -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault - -## NOTES - -## RELATED LINKS - -[Get-AzureRmKeyVault](./Get-AzureRmKeyVault.md) - -[Remove-AzureRmKeyVaultAccessPolicy](./Remove-AzureRmKeyVaultAccessPolicy.md) diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Stop-AzureKeyVaultCertificateOperation.md b/azurermps-6.13.0/AzureRM.KeyVault/Stop-AzureKeyVaultCertificateOperation.md deleted file mode 100644 index 55a51fb5b1..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Stop-AzureKeyVaultCertificateOperation.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 3B042D79-658F-41F0-BD4D-9955F2E71CA1 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/stop-azurekeyvaultcertificateoperation -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Stop-AzureKeyVaultCertificateOperation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Stop-AzureKeyVaultCertificateOperation.md ---- - -# Stop-AzureKeyVaultCertificateOperation - -## SYNOPSIS -Cancels a certificate operation in key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Default (Default) -``` -Stop-AzureKeyVaultCertificateOperation [-VaultName] <String> [-Name] <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObject -``` -Stop-AzureKeyVaultCertificateOperation [-InputObject] <PSKeyVaultCertificateOperation> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Stop-AzureKeyVaultCertificateOperation** cmdlet cancels a certificate operation in the Azure Key Vault service. - -## EXAMPLES - -### Example 1: Cancel a certificate operation -```powershell -PS C:\> Stop-AzureKeyVaultCertificateOperation -VaultName "Contoso01" -Name "TestCert02" -Force - -Status : inProgress -CancellationRequested : True -CertificateSigningRequest : MIICpjCCAY4CAQAwFjEUMBIGA1UEAxMLY29udG9zby5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCVr6EVwsd48qDVORsF4V4w4N1aQCUirFW7b+kwoTvSOL4SfMiWcPmno0uxmQQoh - gz157bC3sKFLyBUsGCmS4i7uWkBOSEpCh8L3FKU4XMqRROlUM9AqswzB0e1sURCqevEJA80xFpfTgkeqpm44m4jr6p7gu+h1PBf9Dt7b43Gybde5DUlGrrOiTkOIAF0eU2iNVeHOapoj8m1XHmzO1BARs - oa0pSDxO/aMgeuq/QPkWG64Iiw55U20byKZ86u3Y4g192HsPwsrHkf9ZSYR2M9BYM3YGoT/dkCmAtP4LQAsOwf1+S0a/TwRtrnoOHbPFI6HYSY3TY1iqzZ9xItfgalAgMBAAGgSzBJBgkqhkiG9w0BCQ4 - xPDA6MA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwCQYDVR0TBAIwADANBgkqhkiG9w0BAQsFAAOCAQEAjxUX5PGhri9qJTxSleGEbMVkxhhn3nuPUgxujEzrcQVr - fZAACJHbOnga/QYwpxumKWnkX9YdWxb58PPn+nLV2gYP3eYEyJ4DR9XDcKpoQxZahUdqD3JZXhWPIcN05tw9Fuq8ziw94BjLZW3h3iDamqkBnysJYW58FBp1H8Ejqk0Iynbo0V223Innq/7QB2fVwe3ZJ - JecT8YxHJjVQ5psdDpEWgLUG/DFiAPHdwupI7JjvtvQmT3AotL0x5GNx2bWNH5hHIXsX4bnbxZgNQnTB2w3tQ3QeuKt8fUx2S0xtxPllaCUul6efa84TNqdMcMfyxCarIwDP6qdhS+CDU1uUA== -ErrorCode : -ErrorMessage : -``` - -This command cancels the TestCert02 certificate operation. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Operation object - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateOperation -Parameter Sets: InputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a certificate. - -```yaml -Type: System.String -Parameter Sets: Default -Aliases: CertificateName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of a key vault. - -```yaml -Type: System.String -Parameter Sets: Default -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateOperation -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateOperation - -## NOTES - -## RELATED LINKS - -[Get-AzureKeyVaultCertificateOperation](./Get-AzureKeyVaultCertificateOperation.md) - -[Remove-AzureKeyVaultCertificateOperation](./Remove-AzureKeyVaultCertificateOperation.md) - diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Undo-AzureKeyVaultCertificateRemoval.md b/azurermps-6.13.0/AzureRM.KeyVault/Undo-AzureKeyVaultCertificateRemoval.md deleted file mode 100644 index 2cc2298312..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Undo-AzureKeyVaultCertificateRemoval.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/undo-azurekeyvaultcertificateremoval -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Undo-AzureKeyVaultCertificateRemoval.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Undo-AzureKeyVaultCertificateRemoval.md ---- - -# Undo-AzureKeyVaultCertificateRemoval - -## SYNOPSIS -Recovers a deleted certificate in a key vault into an active state. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Default (Default) -``` -Undo-AzureKeyVaultCertificateRemoval [-VaultName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObject -``` -Undo-AzureKeyVaultCertificateRemoval [-InputObject] <PSDeletedKeyVaultCertificateIdentityItem> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Undo-AzureKeyVaultCertificateRemoval** cmdlet will recover a previously deleted certificate. -The recovered certificate will be active and can be used for all operations. -Caller needs to have 'recover' permission in order to perform this operation. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Undo-AzureKeyVaultCertificateRemoval -VaultName 'MyKeyVault' -Name 'MyCertificate' - -Certificate : [Subject] - CN=contoso.com - - [Issuer] - CN=contoso.com - - [Serial Number] - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - - [Not Before] - 5/24/2018 10:58:13 AM - - [Not After] - 11/24/2018 10:08:13 AM - - [Thumbprint] - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - -KeyId : https://mykeyvault.vault.azure.net:443/keys/mycertificate/7fe415d5518240c1a6fce89986b8d334 -SecretId : https://mykeyvault.vault.azure.net:443/secrets/mycertificate/7fe415d5518240c1a6fce89986b8d334 -Thumbprint : XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX -RecoveryLevel : Recoverable+Purgeable -Enabled : True -Expires : 11/24/2018 6:08:13 PM -NotBefore : 5/24/2018 5:58:13 PM -Created : 5/24/2018 6:08:13 PM -Updated : 5/24/2018 6:08:13 PM -Tags : -VaultName : MyKeyVault -Name : MyCertificate -Version : 7fe415d5518240c1a6fce89986b8d334 -Id : https://mykeyvault.vault.azure.net:443/certificates/mycertificate/7fe415d5518240c1a6fce89986b8d334 -``` - -This command will recover the certificate 'MyCertificate' that was previously deleted, into an active and usable state. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Deleted Certificate object - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultCertificateIdentityItem -Parameter Sets: InputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Certificate name. -Cmdlet constructs the FQDN of a certificate from vault name, currently selected environment and certificate name. - -```yaml -Type: System.String -Parameter Sets: Default -Aliases: CertificateName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: System.String -Parameter Sets: Default -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultCertificateIdentityItem -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificate - -## NOTES - -## RELATED LINKS - -[Remove-AzureKeyVaultCertificate](./Remove-AzureKeyVaultCertificate.md) - -[Get-AzureKeyVaultCertificate](./Get-AzureKeyVaultCertificate.md) diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Undo-AzureKeyVaultKeyRemoval.md b/azurermps-6.13.0/AzureRM.KeyVault/Undo-AzureKeyVaultKeyRemoval.md deleted file mode 100644 index 71fff1da25..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Undo-AzureKeyVaultKeyRemoval.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/undo-azurekeyvaultkeyremoval -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Undo-AzureKeyVaultKeyRemoval.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Undo-AzureKeyVaultKeyRemoval.md ---- - -# Undo-AzureKeyVaultKeyRemoval - -## SYNOPSIS -Recovers a deleted key in a key vault into an active state. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Default (Default) -``` -Undo-AzureKeyVaultKeyRemoval [-VaultName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObject -``` -Undo-AzureKeyVaultKeyRemoval [-InputObject] <PSDeletedKeyVaultKeyIdentityItem> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Undo-AzureKeyVaultKeyRemoval** cmdlet will recover a previously deleted key. -The recovered key will be active and can be used for all normal key operations. -Caller needs to have 'recover' permission in order to perform this operation. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Undo-AzureKeyVaultKeyRemoval -VaultName 'MyKeyVault' -Name 'MyKey' - -Vault Name : MyKeyVault -Name : MyKey -Version : 1af807cc331a49d0b52b7c75e1b2366e -Id : https://mykeybault.vault.azure.net:443/keys/mykey/1af807cc331a49d0b52b7c75e1b2366e -Enabled : True -Expires : -Not Before : -Created : 5/24/2018 8:32:27 PM -Updated : 5/24/2018 8:32:27 PM -Purge Disabled : False -Tags : -``` - -This command will recover the key 'MyKey' that was previously deleted, into an active and usable state. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Deleted key object - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultKeyIdentityItem -Parameter Sets: InputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Key name. -Cmdlet constructs the FQDN of a key from vault name, currently selected environment and key name. - -```yaml -Type: System.String -Parameter Sets: Default -Aliases: KeyName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: System.String -Parameter Sets: Default -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultKeyIdentityItem -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKey - -## NOTES - -## RELATED LINKS - -[Remove-AzureKeyVaultKey](./Remove-AzureKeyVaultKey.md) - -[Add-AzureKeyVaultKey](./Add-AzureKeyVaultKey.md) - -[Get-AzureKeyVaultKey](./Get-AzureKeyVaultKey.md) - diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Undo-AzureKeyVaultManagedStorageAccountRemoval.md b/azurermps-6.13.0/AzureRM.KeyVault/Undo-AzureKeyVaultManagedStorageAccountRemoval.md deleted file mode 100644 index 74938e8f1c..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Undo-AzureKeyVaultManagedStorageAccountRemoval.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/undo-azurekeyvaultmanagedstorageaccountremoval -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Undo-AzureKeyVaultManagedStorageAccountRemoval.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Undo-AzureKeyVaultManagedStorageAccountRemoval.md ---- - -# Undo-AzureKeyVaultManagedStorageAccountRemoval - -## SYNOPSIS -Recovers a previously deleted KeyVault-managed storage account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Default (Default) -``` -Undo-AzureKeyVaultManagedStorageAccountRemoval [-VaultName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObject -``` -Undo-AzureKeyVaultManagedStorageAccountRemoval - [-InputObject] <PSDeletedKeyVaultManagedStorageAccountIdentityItem> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Undo-AzureKeyVaultManagedStorageAccountRemoval** command recovers a previously deleted managed storage account, provided that soft delete is enabled for this vault, and that the attempt to recover occurs during the recovery interval. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureKeyVaultManagedStorageAccount -VaultName myVault -Name myAccount -InRemovedState -PS C:\> Undo-AzureKeyVaultManagedStorageAccountRemoval -VaultName myVault -Name myAccount - -Id : https://myvault.vault.azure.net:443/storage/myaccount -Vault Name : myVault -AccountName : myAccount -Account Resource Id : /subscriptions/8bc48661-1801-4b7a-8ca1-6a3cadfb4870/resourceGroups/myrg/providers/Microsoft.St - orage/storageAccounts/myaccount -Active Key Name : key2 -Auto Regenerate Key : False -Regeneration Period : 90.00:00:00 -Enabled : True -Created : 4/25/2018 1:50:32 AM -Updated : 4/25/2018 1:50:32 AM -Tags : -``` - -This sequence of commands determines whether the specified storage account exists in the vault in a deleted state; the subsequent command recovers the deleted storage account, bringing it back into an active state. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Deleted Managed Storage Account object - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultManagedStorageAccountIdentityItem -Parameter Sets: InputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the KeyVault managed storage account. -Cmdlet constructs the FQDN of the target from vault name, currently selected environment and the name of the managed storage account. - -```yaml -Type: System.String -Parameter Sets: Default -Aliases: StorageAccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: System.String -Parameter Sets: Default -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultManagedStorageAccountIdentityItem -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccount - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Undo-AzureKeyVaultManagedStorageSasDefinitionRemoval.md b/azurermps-6.13.0/AzureRM.KeyVault/Undo-AzureKeyVaultManagedStorageSasDefinitionRemoval.md deleted file mode 100644 index f9b8df2a4e..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Undo-AzureKeyVaultManagedStorageSasDefinitionRemoval.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/undo-azurekeyvaultmanagedstoragesasdefinitionremoval -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Undo-AzureKeyVaultManagedStorageSasDefinitionRemoval.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Undo-AzureKeyVaultManagedStorageSasDefinitionRemoval.md ---- - -# Undo-AzureKeyVaultManagedStorageSasDefinitionRemoval - -## SYNOPSIS -Recovers a previously deleted KeyVault-managed storage SAS definition. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Default (Default) -``` -Undo-AzureKeyVaultManagedStorageSasDefinitionRemoval [-VaultName] <String> [-AccountName] <String> - [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObject -``` -Undo-AzureKeyVaultManagedStorageSasDefinitionRemoval [-AccountName] <String> - [-InputObject] <PSDeletedKeyVaultManagedStorageSasDefinitionIdentityItem> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Undo-AzureKeyVaultManagedStorageSasDefinitionRemoval** command recovers a previously deleted managed storage SAS definition, provided that soft delete is enabled for this vault, and that the attempt to recover occurs during the recovery interval. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureKeyVaultManagedStorageSasDefinition -VaultName myVault -AccountName myAccount -Name mySasName -InRemovedState -PS C:\> Undo-AzureKeyVaultManagedStorageSasDefinitionRemoval -VaultName myVault -AccountName myAccount -Name mySasName - -Id : https://myvault.vault.azure.net:443/storage/myaccount/sas/mysasname -Secret Id : https://myvault.vault.azure.net/secrets/myaccount-mysasname -Vault Name : myVault -AccountName : myAccount -Name : mySasName -Parameter : -Enabled : True -Created : 5/24/2018 9:11:08 PM -Updated : 5/24/2018 9:11:08 PM -Tags : -``` - -This sequence of commands determines whether the specified storage SAS definition exists in the vault in a deleted state; the subsequent command recovers the deleted sas definition, bringing it back into an active state. - -## PARAMETERS - -### -AccountName -KeyVault-managed storage account name. -Cmdlet constructs the FQDN of a managed storage SAS definition from vault name, currently-selected environment and managed storage account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: StorageAccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Deleted managed storage SAS definition object - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultManagedStorageSasDefinitionIdentityItem -Parameter Sets: InputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the KeyVault-managed storage SAS definition. -Cmdlet constructs the FQDN of the target from vault name, currently-selected environment, the name of the managed storage account and the name of the SAS definition. - -```yaml -Type: System.String -Parameter Sets: Default -Aliases: SasDefinitionName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: System.String -Parameter Sets: Default -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultManagedStorageSasDefinitionIdentityItem -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageSasDefinition - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Undo-AzureKeyVaultSecretRemoval.md b/azurermps-6.13.0/AzureRM.KeyVault/Undo-AzureKeyVaultSecretRemoval.md deleted file mode 100644 index 281ed41b9f..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Undo-AzureKeyVaultSecretRemoval.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/undo-azurekeyvaultsecretremoval -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Undo-AzureKeyVaultSecretRemoval.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Undo-AzureKeyVaultSecretRemoval.md ---- - -# Undo-AzureKeyVaultSecretRemoval - -## SYNOPSIS -Recovers a deleted secret in a key vault into an active state. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Default (Default) -``` -Undo-AzureKeyVaultSecretRemoval [-VaultName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObject -``` -Undo-AzureKeyVaultSecretRemoval [-InputObject] <PSDeletedKeyVaultSecretIdentityItem> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Undo-AzureKeyVaultSecretRemoval** cmdlet will recover a previously deleted secret. -The recovered secret will be active and can be used for all normal secret operations. -Caller needs to have 'recover' permission in order to perform this operation. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Undo-AzureKeyVaultSecretRemoval -VaultName 'MyKeyVault' -Name 'MySecret' - -Vault Name : MyKeyVault -Name : MySecret -Version : f622abc7b1394092812f1eb0f85dc91c -Id : https://mykeyvault.vault.azure.net:443/secrets/mysecret/f622abc7b1394092812f1eb0f85dc91c -Enabled : True -Expires : -Not Before : -Created : 4/19/2018 5:56:02 PM -Updated : 4/26/2018 7:48:40 PM -Content Type : -Tags : -``` - -This command will recover the secret 'MySecret' that was previously deleted, into an active and usable state. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Deleted secret object - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultSecretIdentityItem -Parameter Sets: InputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Secret name. -Cmdlet constructs the FQDN of a secret from vault name, currently selected environment and secret name. - -```yaml -Type: System.String -Parameter Sets: Default -Aliases: SecretName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: System.String -Parameter Sets: Default -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVaultSecretIdentityItem -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultSecret - -## NOTES - -## RELATED LINKS - -[Remove-AzureKeyVaultSecret](./Remove-AzureKeyVaultSecret.md) - - -[Get-AzureKeyVaultSecret](./Get-AzureKeyVaultSecret.md) diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Undo-AzureRmKeyVaultRemoval.md b/azurermps-6.13.0/AzureRM.KeyVault/Undo-AzureRmKeyVaultRemoval.md deleted file mode 100644 index b66f3997f1..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Undo-AzureRmKeyVaultRemoval.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/undo-azurermkeyvaultremoval -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Undo-AzureRmKeyVaultRemoval.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Undo-AzureRmKeyVaultRemoval.md ---- - -# Undo-AzureRmKeyVaultRemoval - -## SYNOPSIS -Recovers a deleted key vault into an active state. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Default (Default) -``` -Undo-AzureRmKeyVaultRemoval [-VaultName] <String> [-ResourceGroupName] <String> [-Location] <String> - [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObject -``` -Undo-AzureRmKeyVaultRemoval [-InputObject] <PSDeletedKeyVault> [-Tag <Hashtable>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Undo-AzureRmKeyVaultRemoval** cmdlet will recover a previously deleted key vault. The -recovered vault will be active after recovery - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Undo-AzureRmKeyVaultRemoval -VaultName 'MyKeyVault' -ResourceGroupName 'MyResourceGroup' -Location 'eastus2' -Tag @{"x"= "y"} - -Vault Name : MyKeyVault -Resource Group Name : MyResourceGroup -Location : eastus2 -Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers - /Microsoft.KeyVault/vaults/mykeyvault -Vault URI : https://mykeyvault.vault.azure.net/ -Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx -SKU : Standard -Enabled For Deployment? : True -Enabled For Template Deployment? : True -Enabled For Disk Encryption? : True -Soft Delete Enabled? : True -Access Policies : - Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx - Object ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx - Application ID : - Display Name : User Name (username@microsoft.com) - Permissions to Keys : get, create, delete, list, update, - import, backup, restore, recover - Permissions to Secrets : get, list, set, delete, backup, - restore, recover - Permissions to Certificates : get, delete, list, create, import, - update, deleteissuers, getissuers, listissuers, managecontacts, manageissuers, - setissuers, recover - Permissions to (Key Vault Managed) Storage : delete, deletesas, get, getsas, list, - listsas, regeneratekey, set, setsas, update - -Tags : - Name Value - ==== ===== - x y -``` - -This command will recover the key vault 'MyKeyVault' that was previously deleted from eastus2 -region and 'MyResourceGroup' resource group, into an active and usable state. It also replaces the -tags with new tag. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Deleted vault object - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVault -Parameter Sets: InputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Location -Specifies the deleted vault original Azure region. - -```yaml -Type: System.String -Parameter Sets: Default -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an existing resource group in which to create the key vault. - -```yaml -Type: System.String -Parameter Sets: Default -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: System.String -Parameter Sets: Default -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedKeyVault -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmKeyVault](./Remove-AzureRmKeyVault.md) - -[New-AzureRmKeyVault](./New-AzureRmKeyVault.md) - -[Get-AzureRmKeyVault](./Get-AzureRmKeyVault.md) diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Update-AzureKeyVaultCertificate.md b/azurermps-6.13.0/AzureRM.KeyVault/Update-AzureKeyVaultCertificate.md deleted file mode 100644 index b4af61ea25..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Update-AzureKeyVaultCertificate.md +++ /dev/null @@ -1,250 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/update-azurekeyvaultcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Update-AzureKeyVaultCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Update-AzureKeyVaultCertificate.md ---- - -# Update-AzureKeyVaultCertificate - -## SYNOPSIS -Modifies editable attributes of a certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByName (Default) -``` -Update-AzureKeyVaultCertificate [-VaultName] <String> [-Name] <String> [[-Version] <String>] - [-Enable <Boolean>] [-Tag <Hashtable>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ByInputObject -``` -Update-AzureKeyVaultCertificate [-InputObject] <PSKeyVaultCertificateIdentityItem> [[-Version] <String>] - [-Enable <Boolean>] [-Tag <Hashtable>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureKeyVaultCertificate** cmdlet modifies the editable attributes of a certificate. - -## EXAMPLES - -### Example 1: Modify the tags associated with a certificate -```powershell -PS C:\> $Tags = @{ "Team" = "Azure" ; "Role" = "Engg" } -PS C:\> Update-AzureKeyVaultCertificate -VaultName "ContosoKV01" -Name "TestCert01" -Tag $Tags -PassThru - -Name : TestCert01 -Certificate : [Subject] - CN=AZURE - - [Issuer] - CN=AZURE - - [Serial Number] - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - - [Not Before] - 7/27/2016 6:50:01 PM - - [Not After] - 7/27/2018 7:00:01 PM - - [Thumbprint] - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - -Id : https://ContosoKV01.vault.azure.net:443/certificates/TestCert01 -KeyId : https://ContosoKV01.vault.azure.net:443/keys/TestCert01 -SecretId : https://ContosoKV01.vault.azure.net:443/secrets/TestCert01 -Thumbprint : XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX -Tags : {[Role, Engg], [Team, Azure]} -Enabled : True -Created : 7/28/2016 2:00:01 AM -Updated : 8/1/2016 5:37:48 PM -``` - -The first command assigns an array of key/value pairs to the $Tags variable. -The second command sets the tags value of the certificate named TestCert01 to be $Tags. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enable -If present, enable a certificate if value is true. -Disable a certificate if value is false. -If not specified, the existing value of the certificate's enabled/disabled state remains unchanged. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Certificate object - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIdentityItem -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Certificate name. -Cmdlet constructs the FQDN of a secret from vault name, currently selected environment and secret name. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: CertificateName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Cmdlet does not return object by default. -If this switch is specified, return certificate object. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -A hashtable representing certificate tags. -If not specified, the existing tags of the sertificate remain unchanged. -Remove a tag by specifying an empty Hashtable. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Version -Certificate version. -Cmdlet constructs the FQDN of a certificate from vault name, currently selected environment, certificate name and certificate version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: CertificateVersion - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIdentityItem -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificate - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Update-AzureKeyVaultKey.md b/azurermps-6.13.0/AzureRM.KeyVault/Update-AzureKeyVaultKey.md deleted file mode 100644 index 5a4f1b4433..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Update-AzureKeyVaultKey.md +++ /dev/null @@ -1,306 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/update-azurekeyvaultkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Update-AzureKeyVaultKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Update-AzureKeyVaultKey.md ---- - -# Update-AzureKeyVaultKey - -## SYNOPSIS -Updates the attributes of a key in a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Default (Default) -``` -Update-AzureKeyVaultKey [-VaultName] <String> [-Name] <String> [[-Version] <String>] [-Enable <Boolean>] - [-Expires <DateTime>] [-NotBefore <DateTime>] [-KeyOps <String[]>] [-Tag <Hashtable>] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObject -``` -Update-AzureKeyVaultKey [-InputObject] <PSKeyVaultKeyIdentityItem> [[-Version] <String>] [-Enable <Boolean>] - [-Expires <DateTime>] [-NotBefore <DateTime>] [-KeyOps <String[]>] [-Tag <Hashtable>] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureKeyVaultKey** cmdlet updates the editable attributes of a key in a key vault. - -## EXAMPLES - -### Example 1: Modify a key to enable it, and set the expiration date and tags -```powershell -PS C:\> $Expires = (Get-Date).AddYears(2).ToUniversalTime() -PS C:\> $Tags = @{'Severity' = 'high'; 'Accounting' = 'true'} -PS C:\> Update-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -Expires $Expires -Enable $True -Tag $Tags -PassThru - -Vault Name : Contoso -Name : ITSoftware -Version : 394f9379a47a4e2086585468de6c7ae5 -Id : https://Contoso.vault.azure.net:443/keys/ITSoftware/394f9379a47a4e2086585468de6c7ae5 -Enabled : True -Expires : 5/25/2020 7:58:07 PM -Not Before : -Created : 4/6/2018 11:31:36 PM -Updated : 5/25/2018 7:59:02 PM -Purge Disabled : False -Tags : Name Value - Severity high - Accounting true -``` - -The first command creates a **DateTime** object by using the **Get-Date** cmdlet. That object -specifies a time two years in the future. The command stores that date in the $Expires variable. -For more information, type `Get-Help Get-Date`. -The second command creates a variable to store tag values of high severity and Accounting. -The final command modifies a key named ITSoftware. The command enables the key, sets its expiration -time to the time stored in $Expires, and sets the tags that are stored in $Tags. - -### Example 2: Modify a key to delete all tags -```powershell -PS C:\> Update-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -Version '394f9379a47a4e2086585468de6c7ae5' -Tag @{} - -Vault Name : Contoso -Name : ITSoftware -Version : 394f9379a47a4e2086585468de6c7ae5 -Id : https://Contoso.vault.azure.net:443/keys/ITSoftware/394f9379a47a4e2086585468de6c7ae5 -Enabled : True -Expires : 5/25/2020 7:58:07 PM -Not Before : -Created : 4/6/2018 11:31:36 PM -Updated : 5/25/2018 8:00:08 PM -Purge Disabled : False -Tags : -``` - -This commands deletes all tags for a specific version of a key named ITSoftware. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enable -Value of true enables the key and a value of false disabless the key. -If not specified, the existing enabled/disabled state remains unchanged. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expires -The expiration time of a key in UTC time. -If not specified, the existing expiration time of the key remains unchanged. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Key object - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKeyIdentityItem -Parameter Sets: InputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -KeyOps -The operations that can be performed with the key. -If not specified, the existing key operations of the key remain unchanged. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Key name. -Cmdlet constructs the FQDN of a key from vault name, currently selected environment and key name. - -```yaml -Type: System.String -Parameter Sets: Default -Aliases: KeyName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotBefore -The UTC time before which key can't be used. -If not specified, the existing NotBefore attribute of the key remains unchanged. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Cmdlet does not return an object by default. -If this switch is specified, returns the updated key bundle object. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -A hashtable represents key tags. -If not specified, the existings tags of the key remain unchanged. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: System.String -Parameter Sets: Default -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Version -Key version. -Cmdlet constructs the FQDN of a key from vault name, currently selected environment, key name and key version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: KeyVersion - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKeyIdentityItem -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKey - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Update-AzureKeyVaultManagedStorageAccount.md b/azurermps-6.13.0/AzureRM.KeyVault/Update-AzureKeyVaultManagedStorageAccount.md deleted file mode 100644 index 0eeef76e1e..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Update-AzureKeyVaultManagedStorageAccount.md +++ /dev/null @@ -1,272 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/update-azurekeyvaultmanagedstorageaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Update-AzureKeyVaultManagedStorageAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Update-AzureKeyVaultManagedStorageAccount.md ---- - -# Update-AzureKeyVaultManagedStorageAccount - -## SYNOPSIS -Update editable attributes of a Key Vault managed Azure Storage Account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByDefinitionName (Default) -``` -Update-AzureKeyVaultManagedStorageAccount [-VaultName] <String> [-AccountName] <String> - [-ActiveKeyName <String>] [-AutoRegenerateKey <Boolean>] [-RegenerationPeriod <TimeSpan>] [-Enable <Boolean>] - [-Tag <Hashtable>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByInputObject -``` -Update-AzureKeyVaultManagedStorageAccount [-InputObject] <PSKeyVaultManagedStorageAccountIdentityItem> - [-ActiveKeyName <String>] [-AutoRegenerateKey <Boolean>] [-RegenerationPeriod <TimeSpan>] [-Enable <Boolean>] - [-Tag <Hashtable>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Update the editable attributes of a Key Vault managed Azure Storage Account. - -## EXAMPLES - -### Example 1: Update the active key to 'key2' on a Key Vault managed Azure Storage Account. -```powershell -PS C:\> Update-AzureKeyVaultManagedStorageAccount -VaultName 'myvault' -AccountName 'mystorageaccount' -ActiveKeyName 'key2' - -Id : https://myvault.vault.azure.net:443/storage/mystorageaccount -Vault Name : myvault -AccountName : mystorageaccount -Account Resource Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.St - orage/storageAccounts/mystorageaccount -Active Key Name : key2 -Auto Regenerate Key : True -Regeneration Period : 90.00:00:00 -Enabled : True -Created : 5/21/2018 11:55:58 PM -Updated : 5/21/2018 11:55:58 PM -Tags : -``` - -Updates the Key Vault managed Azure Storage Account active key to 'key2'. 'key2' will be used to -generate SAS tokens after this update. - -## PARAMETERS - -### -AccountName -Key Vault managed storage account name. Cmdlet constructs the FQDN of a managed storage account -name from vault name, currently selected environment and manged storage account name. - -```yaml -Type: System.String -Parameter Sets: ByDefinitionName -Aliases: StorageAccountName, Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ActiveKeyName -Active key name. -If not specified, the existing value of managed storage account's active key name remains unchanged - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoRegenerateKey -Auto regenerate key. -If not specified, the existing value of auto regenerate key of managed storage account remains unchanged - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enable -If present, enables a use of a managed storage account key for sas token generation if value is -true. Disables use of a managed storage account key for sas token generation if value is false. If -not specified, the existing value of the storage account's enabled/disabled state remains -unchanged. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -ManagedStorageAccount object. - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccountIdentityItem -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Cmdlet does not return object by default. If this switch is specified, return managed storage -account object. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegenerationPeriod -Regeneration period. If auto regenerate key is enabled, this value specifies the timespan after -which managed storage account's inactive keygets auto regenerated and becomes the active key. If -not specified, the existing value of regeneration period of keys of managed storage account remains -unchanged - -```yaml -Type: System.Nullable`1[System.TimeSpan] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: System.String -Parameter Sets: ByDefinitionName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccountIdentityItem -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccount - -## NOTES - -## RELATED LINKS - -[AzureRM.KeyVault](/powershell/module/azurerm.keyvault) diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Update-AzureKeyVaultManagedStorageAccountKey.md b/azurermps-6.13.0/AzureRM.KeyVault/Update-AzureKeyVaultManagedStorageAccountKey.md deleted file mode 100644 index 5c4fa4d6b5..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Update-AzureKeyVaultManagedStorageAccountKey.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/update-azurekeyvaultmanagedstorageaccountkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Update-AzureKeyVaultManagedStorageAccountKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Update-AzureKeyVaultManagedStorageAccountKey.md ---- - -# Update-AzureKeyVaultManagedStorageAccountKey - -## SYNOPSIS -Regenerates the specified key of Key Vault managed Azure Storage Account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByDefinitionName (Default) -``` -Update-AzureKeyVaultManagedStorageAccountKey [-VaultName] <String> [-AccountName] <String> [-KeyName] <String> - [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByInputObject -``` -Update-AzureKeyVaultManagedStorageAccountKey [-InputObject] <PSKeyVaultManagedStorageAccountIdentityItem> - [-KeyName] <String> [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Regenerates the specified key of Key Vault managed Azure Storage Account and sets the key as the active key. Key Vault proxies the call to Azure Resource Manager to regenerate the key. The caller must posses permissions to regenerate keys on given Azure Storage Account. - -## EXAMPLES - -### Example 1: Regenerate a key -```powershell -PS C:\> Update-AzureKeyVaultManagedStorageAccountKey -VaultName 'myvault' -AccountName 'mystorageaccount' -KeyName 'key1' - -Id : https://myvault.vault.azure.net:443/storage/mystorageaccount -Vault Name : myvault -AccountName : mystorageaccount -Account Resource Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.St - orage/storageAccounts/mystorageaccount -Active Key Name : key1 -Auto Regenerate Key : True -Regeneration Period : 90.00:00:00 -Enabled : True -Created : 5/21/2018 11:55:58 PM -Updated : 5/21/2018 11:55:58 PM -Tags : -``` - -Regenerates 'key1' of account 'mystorageaccount' and sets 'key1' as the active of the Key Vault managed Azure Storage Account. - -## PARAMETERS - -### -AccountName -Key Vault managed storage account name. Cmdlet constructs the FQDN of a managed storage account name from vault name, currently selected environment and manged storage account name. - -```yaml -Type: System.String -Parameter Sets: ByDefinitionName -Aliases: StorageAccountName, Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -ManagedStorageAccount object. - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccountIdentityItem -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -KeyName -Name of storage account key to regenerate and make active. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Cmdlet does not return an object by default. -If this switch is specified, cmdlet returns the managed storage account that was deleted. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: System.String -Parameter Sets: ByDefinitionName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccountIdentityItem -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultManagedStorageAccount - -## NOTES - -## RELATED LINKS - -[Azure Key Vault PowerShell cmdlets](/powershell/module/azurerm.keyvault/) diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Update-AzureKeyVaultSecret.md b/azurermps-6.13.0/AzureRM.KeyVault/Update-AzureKeyVaultSecret.md deleted file mode 100644 index 9635c49342..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Update-AzureKeyVaultSecret.md +++ /dev/null @@ -1,325 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/update-azurekeyvaultsecret -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Update-AzureKeyVaultSecret.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Update-AzureKeyVaultSecret.md ---- - -# Update-AzureKeyVaultSecret - -## SYNOPSIS -Updates attributes of a secret in a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Default (Default) -``` -Update-AzureKeyVaultSecret [-VaultName] <String> [-Name] <String> [[-Version] <String>] [-Enable <Boolean>] - [-Expires <DateTime>] [-NotBefore <DateTime>] [-ContentType <String>] [-Tag <Hashtable>] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObject -``` -Update-AzureKeyVaultSecret [-InputObject] <PSKeyVaultSecretIdentityItem> [[-Version] <String>] - [-Enable <Boolean>] [-Expires <DateTime>] [-NotBefore <DateTime>] [-ContentType <String>] [-Tag <Hashtable>] - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureKeyVaultSecret** cmdlet updates editable attributes of a secret in a key vault. - -## EXAMPLES - -### Example 1: Modify the attributes of a secret -```powershell -PS C:\> $Expires = (Get-Date).AddYears(2).ToUniversalTime() -PS C:\> $Nbf = (Get-Date).ToUniversalTime() -PS C:\> $Tags = @{ 'Severity' = 'medium'; 'HR' = 'true'} -PS C:\> $ContentType= 'xml' -PS C:\> Update-AzureKeyVaultSecret -VaultName 'ContosoVault' -Name 'HR' -Expires $Expires -NotBefore $Nbf -ContentType $ContentType -Enable $True -Tag $Tags -PassThru - -Vault Name : ContosoVault -Name : HR -Version : d476edfcd3544017a03bc49c1f3abec0 -Id : https://ContosoVault.vault.azure.net:443/secrets/HR/d476edfcd3544017a03bc49c1f3abec0 -Enabled : True -Expires : 5/25/2020 8:01:58 PM -Not Before : 5/25/2018 8:02:02 PM -Created : 4/11/2018 11:45:06 PM -Updated : 5/25/2018 8:02:45 PM -Content Type : xml -Tags : Name Value - Severity medium - HR true -``` - -The first four commands define attributes for the expiry date, the NotBefore date, tags, and -context type, and store the attributes in variables. -The final command modifies the attributes for the secret named HR in the key vault named -ContosoVault, using the stored variables. - -### Example 2: Delete the tags and content type for a secret -``` -PS C:\> Update-AzureKeyVaultSecret -VaultName 'ContosoVault' -Name 'HR' -Version '9EEA45C6EE50490B9C3176A80AC1A0DF' -ContentType '' -Tag -@{} -``` - -This command deletes the tags and the content type for the specified version of the secret named HR -in the key vault named Contoso. - -### Example 3: Disable the current version of secrets whose name begins with IT -``` -PS C:\> $Vault = 'ContosoVault' -PS C:\> $Prefix = 'IT' -PS C:\> Get-AzureKeyVaultSecret $Vault | Where-Object {$_.Name -like $Prefix + '*'} | Update-AzureKeyVaultSecret -Enable $False -``` - -The first command stores the string value Contoso in the $Vault variable. -The second command stores the string value IT in the $Prefix variable. -The third command uses the Get-AzureKeyVaultSecret cmdlet to get the secrets in the specified key -vault, and then passes those secrets to the **Where-Object** cmdlet. The **Where-Object** cmdlet -filters the secrets for names that begin with the characters IT. The command pipes the secrets that -match the filter to the Update-AzureKeyVaultSecret cmdlet, which disables them. - -### Example 4: Set the ContentType for all versions of a secret -``` -PS C:\> $VaultName = 'ContosoVault' -PS C:\> $Name = 'HR' -PS C:\> $ContentType = 'xml' -PS C:\> Get-AzureKeyVaultKey -VaultName $VaultName -Name $Name -IncludeVersions | Update-AzureKeyVaultSecret -ContentType $ContentType -``` - -The first three commands define string variables to use for the *VaultName*, *Name*, and -*ContentType* parameters. The fourth command uses the Get-AzureKeyVaultKey cmdlet to get the -specified keys, and pipes the keys to the Update-AzureKeyVaultSecret cmdlet to set their -content type to XML. - -## PARAMETERS - -### -ContentType -Secret's content type. -If not specified, the existing value of the secret's content type remains unchanged. -Remove the existing content type value by specifying an empty string. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enable -If present, enable a secret if value is true. -Disable a secret if value is false. -If not specified, the existing value of the secret's enabled/disabled state remains unchanged. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expires -The expiration time of a secret in UTC time. -If not specified, the existing value of the secret's expiration time remains unchanged. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Secret object - -```yaml -Type: Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultSecretIdentityItem -Parameter Sets: InputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Secret name. -Cmdlet constructs the FQDN of a secret from vault name, currently selected environment and secret name. - -```yaml -Type: System.String -Parameter Sets: Default -Aliases: SecretName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotBefore -The UTC time before which secret can't be used. -If not specified, the existing value of the secret's NotBefore attribute remains unchanged. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Cmdlet does not return object by default. -If this switch is specified, return Secret object. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -A hashtable representing secret tags. -If not specified, the existing tags of the secret remain unchanged. -Remove a tag by specifying an empty Hashtable. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: System.String -Parameter Sets: Default -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Version -Secret version. -Cmdlet constructs the FQDN of a secret from vault name, currently selected environment, secret name and secret version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: SecretVersion - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultSecretIdentityItem -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultSecret - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.KeyVault/Update-AzureRmKeyVaultNetworkRuleSet.md b/azurermps-6.13.0/AzureRM.KeyVault/Update-AzureRmKeyVaultNetworkRuleSet.md deleted file mode 100644 index 33a0080f51..0000000000 --- a/azurermps-6.13.0/AzureRM.KeyVault/Update-AzureRmKeyVaultNetworkRuleSet.md +++ /dev/null @@ -1,295 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/update-azurermkeyvaultnetworkruleset -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Update-AzureRmKeyVaultNetworkRuleSet.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/KeyVault/Commands.KeyVault/help/Update-AzureRmKeyVaultNetworkRuleSet.md ---- - -# Update-AzureRmKeyVaultNetworkRuleSet - -## SYNOPSIS -Updates the network rule set on a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVaultName (Default) -``` -Update-AzureRmKeyVaultNetworkRuleSet [-VaultName] <String> [[-ResourceGroupName] <String>] - [-DefaultAction <PSKeyVaultNetworkRuleDefaultActionEnum>] [-Bypass <PSKeyVaultNetworkRuleBypassEnum>] - [-IpAddressRange <String[]>] [-VirtualNetworkResourceId <String[]>] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByInputObject -``` -Update-AzureRmKeyVaultNetworkRuleSet [-InputObject] <PSKeyVault> - [-DefaultAction <PSKeyVaultNetworkRuleDefaultActionEnum>] [-Bypass <PSKeyVaultNetworkRuleBypassEnum>] - [-IpAddressRange <String[]>] [-VirtualNetworkResourceId <String[]>] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Update-AzureRmKeyVaultNetworkRuleSet [-ResourceId] <String> - [-DefaultAction <PSKeyVaultNetworkRuleDefaultActionEnum>] [-Bypass <PSKeyVaultNetworkRuleBypassEnum>] - [-IpAddressRange <String[]>] [-VirtualNetworkResourceId <String[]>] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureRmKeyVaultNetworkRuleSet** command updates the network rules in effect on the specified key vault. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> $frontendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" -ServiceEndpoint Microsoft.KeyVault -PS C:\> $virtualNetwork = New-AzureRmVirtualNetwork -Name myVNet -ResourceGroupName myRG -Location westus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet -PS C:\> $myNetworkResId = (Get-AzureRmVirtualNetwork -Name myVNet -ResourceGroupName myRG).Subnets[0].Id -PS C:\> Update-AzureRmKeyVaultNetworkRuleSet -VaultName 'myVault' -ResourceGroupName myRG -Bypass AzureServices -IpAddressRange "10.0.1.0/24" -VirtualNetworkResourceId $myNetworkResId -PassThru - -Vault Name : myVault -Resource Group Name : myRG -Location : West US -Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers - /Microsoft.KeyVault/vaults/myvault -Vault URI : https://myvault.vault.azure.net/ -Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx -SKU : Standard -Enabled For Deployment? : False -Enabled For Template Deployment? : False -Enabled For Disk Encryption? : False -Soft Delete Enabled? : -Access Policies : - Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx - Object ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx - Application ID : - Display Name : User Name (username@microsoft.com) - Permissions to Keys : get, create, delete, list, update, - import, backup, restore, recover - Permissions to Secrets : get, list, set, delete, backup, - restore, recover - Permissions to Certificates : get, delete, list, create, import, - update, deleteissuers, getissuers, listissuers, managecontacts, manageissuers, - setissuers, recover, backup, restore - Permissions to (Key Vault Managed) Storage : delete, deletesas, get, getsas, list, - listsas, regeneratekey, set, setsas, update, recover, backup, restore - - -Network Rule Set : - Default Action : Allow - Bypass : AzureServices - IP Rules : 10.0.1.0/24 - Virtual Network Rules : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx- - xxxxxxxxxxxxx/resourcegroups/myrg/providers/microsoft.network/virtualnetworks/myvn - et/subnets/frontendsubnet - -Tags : -``` - -This command updates the network ruleset on the vault named 'myVault' for the specified IP range and the virtual network, allowing bypassing of the network rule for Azure services. - -## PARAMETERS - -### -Bypass -Specifies bypass of network rule. - -```yaml -Type: PSKeyVaultNetworkRuleBypassEnum -Parameter Sets: (All) -Aliases: -Accepted values: None, AzureServices - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultAction -Specifies default action of network rule. - -```yaml -Type: PSKeyVaultNetworkRuleDefaultActionEnum -Parameter Sets: (All) -Aliases: -Accepted values: Allow, Deny - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -KeyVault object - -```yaml -Type: PSKeyVault -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IpAddressRange -Specifies allowed network IP address range of network rule. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -This Cmdlet does not return an object by default. -If this switch is specified, it returns the updated key vault object. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group associated with the key vault whose network rule is being modified. - -```yaml -Type: String -Parameter Sets: ByVaultName -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -KeyVault Resource Id - -```yaml -Type: String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of a key vault whose network rule is being modified. - -```yaml -Type: String -Parameter Sets: ByVaultName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkResourceId -Specifies allowed virtual network resource identifier of network rule. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.LogicApp/AzureRM.LogicApp.md b/azurermps-6.13.0/AzureRM.LogicApp/AzureRM.LogicApp.md deleted file mode 100644 index 84784a5880..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/AzureRM.LogicApp.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -Module Name: AzureRM.LogicApp -Module Guid: 8a7d44bb-e747-4265-8f22-b3937961d709 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp -Help Version: 4.0.3.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/AzureRM.LogicApp.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/AzureRM.LogicApp.md ---- - -# AzureRM.LogicApp Module -## Description -This topic displays help topics for the Logic Apps cmdlets. - -## AzureRM.LogicApp Cmdlets -### [Get-AzureRmIntegrationAccount](Get-AzureRmIntegrationAccount.md) -Gets integration accounts. - -### [Get-AzureRmIntegrationAccountAgreement](Get-AzureRmIntegrationAccountAgreement.md) -Gets an integration account agreement. - -### [Get-AzureRmIntegrationAccountCallbackUrl](Get-AzureRmIntegrationAccountCallbackUrl.md) -Gets an integration account callback URL. - -### [Get-AzureRmIntegrationAccountCertificate](Get-AzureRmIntegrationAccountCertificate.md) -Gets integration account certificates from a resource group. - -### [Get-AzureRmIntegrationAccountGeneratedIcn](Get-AzureRmIntegrationAccountGeneratedIcn.md) -This cmdlet retrieves the current value of the generated interchange control number per agreement. - -### [Get-AzureRmIntegrationAccountMap](Get-AzureRmIntegrationAccountMap.md) -Gets an integration account map. - -### [Get-AzureRmIntegrationAccountPartner](Get-AzureRmIntegrationAccountPartner.md) -Gets integration account partners. - -### [Get-AzureRmIntegrationAccountReceivedIcn](Get-AzureRmIntegrationAccountReceivedIcn.md) -This cmdlet retrieves a specific received interchange control number per agreement and control number value. - -### [Get-AzureRmIntegrationAccountSchema](Get-AzureRmIntegrationAccountSchema.md) -Gets integration account schemas. - -### [Get-AzureRmLogicApp](Get-AzureRmLogicApp.md) -Gets a logic app from a resource group. - -### [Get-AzureRmLogicAppRunAction](Get-AzureRmLogicAppRunAction.md) -Gets an action from a logic app run. - -### [Get-AzureRmLogicAppRunHistory](Get-AzureRmLogicAppRunHistory.md) -Gets the run history of a logic app. - -### [Get-AzureRmLogicAppTrigger](Get-AzureRmLogicAppTrigger.md) -Gets the triggers of a logic app. - -### [Get-AzureRmLogicAppTriggerCallbackUrl](Get-AzureRmLogicAppTriggerCallbackUrl.md) -Gets a Logic App trigger callback URL. - -### [Get-AzureRmLogicAppTriggerHistory](Get-AzureRmLogicAppTriggerHistory.md) -Gets the history of triggers in a logic app. - -### [Get-AzureRmLogicAppUpgradedDefinition](Get-AzureRmLogicAppUpgradedDefinition.md) -Gets the upgraded definition for a logic app. - -### [New-AzureRmIntegrationAccount](New-AzureRmIntegrationAccount.md) -Creates an integration account. - -### [New-AzureRmIntegrationAccountAgreement](New-AzureRmIntegrationAccountAgreement.md) -Creates an integration account agreement. - -### [New-AzureRmIntegrationAccountCertificate](New-AzureRmIntegrationAccountCertificate.md) -Creates an integration account certificate. - -### [New-AzureRmIntegrationAccountMap](New-AzureRmIntegrationAccountMap.md) -Creates an integration account map. - -### [New-AzureRmIntegrationAccountPartner](New-AzureRmIntegrationAccountPartner.md) -Creates an integration account partner. - -### [New-AzureRmIntegrationAccountSchema](New-AzureRmIntegrationAccountSchema.md) -Creates an integration account schema. - -### [New-AzureRmLogicApp](New-AzureRmLogicApp.md) -Creates a logic app in a resource group. - -### [Remove-AzureRmIntegrationAccount](Remove-AzureRmIntegrationAccount.md) -Removes an integration account. - -### [Remove-AzureRmIntegrationAccountAgreement](Remove-AzureRmIntegrationAccountAgreement.md) -Removes an integration account agreement. - -### [Remove-AzureRmIntegrationAccountCertificate](Remove-AzureRmIntegrationAccountCertificate.md) -Removes an integration account certificate from a resource group. - -### [Remove-AzureRmIntegrationAccountMap](Remove-AzureRmIntegrationAccountMap.md) -Removes an integration account map. - -### [Remove-AzureRmIntegrationAccountPartner](Remove-AzureRmIntegrationAccountPartner.md) -Removes an integration account partner. - -### [Remove-AzureRmIntegrationAccountReceivedIcn](Remove-AzureRmIntegrationAccountReceivedIcn.md) -This cmdlet removes a specific received interchange control number per agreement and control number value. - -### [Remove-AzureRmIntegrationAccountSchema](Remove-AzureRmIntegrationAccountSchema.md) -Removes an integration account schema. - -### [Remove-AzureRmLogicApp](Remove-AzureRmLogicApp.md) -Removes a logic app from a resource group. - -### [Set-AzureRmIntegrationAccount](Set-AzureRmIntegrationAccount.md) -Modifies an integration account. - -### [Set-AzureRmIntegrationAccountAgreement](Set-AzureRmIntegrationAccountAgreement.md) -Modifies an integration account agreement. - -### [Set-AzureRmIntegrationAccountCertificate](Set-AzureRmIntegrationAccountCertificate.md) -Modifies an integration account certificate. - -### [Set-AzureRmIntegrationAccountGeneratedIcn](Set-AzureRmIntegrationAccountGeneratedIcn.md) -Updates the integration account generated interchange control number (ICN) in the Azure resource group. - -### [Set-AzureRmIntegrationAccountMap](Set-AzureRmIntegrationAccountMap.md) -Modifies an integration account map. - -### [Set-AzureRmIntegrationAccountPartner](Set-AzureRmIntegrationAccountPartner.md) -Modifies an integration account partner. - -### [Set-AzureRmIntegrationAccountReceivedIcn](Set-AzureRmIntegrationAccountReceivedIcn.md) -Updates the integration account received interchange control number (ICN) in the Azure resource group. - -### [Set-AzureRmIntegrationAccountSchema](Set-AzureRmIntegrationAccountSchema.md) -Modifies an integration account schema. - -### [Set-AzureRmLogicApp](Set-AzureRmLogicApp.md) -Modifies a logic app in a resource group. - -### [Start-AzureRmLogicApp](Start-AzureRmLogicApp.md) -Runs a logic app in a resource group. - -### [Stop-AzureRmLogicAppRun](Stop-AzureRmLogicAppRun.md) -Cancels a run of a logic app. - -### [Test-AzureRmLogicApp](Test-AzureRmLogicApp.md) -Validates a logic app definition. - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccount.md b/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccount.md deleted file mode 100644 index 807884fa42..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccount.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: 7BCF2086-05FA-43FB-9D19-7277374CB03E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/get-azurermintegrationaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccount.md ---- - -# Get-AzureRmIntegrationAccount - -## SYNOPSIS -Gets integration accounts. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmIntegrationAccount [-ResourceGroupName <String>] [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmIntegrationAccount** cmdlet gets integration accounts from a resource group. -Specify an integration account name and resource group name. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Get an integration account by name -``` -PS C:\>Get-AzureRmIntegrationAccount -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31 -Name : IntegrationAccount31 -Type : Microsoft.Logic/integrationAccounts -Location : brazilsouth -Sku : -CreatedTime : 3/26/2016 4:26:07 PM -ChangedTime : 3/26/2016 4:26:07 PM -``` - -This command gets an integration account named IntegrationAccount31 from the specified resource group. - -### Example 2: Get integration accounts in a resource group -``` -PS C:\>Get-AzureRmIntegrationAccount -ResourceGroupName "ResourceGroup11" -Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup1/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31 -Name : IntegrationAccount31 -Type : Microsoft.Logic/integrationAccounts -Location : brazilsouth -Sku : -CreatedTime : 3/26/2016 4:26:07 PM -ChangedTime : 3/26/2016 4:26:07 PM -``` - -This command gets integration accounts from a resource group named ResourceGroup11. - -### Example 3: Get all integration accounts -``` -PS C:\>Get-AzureRmIntegrationAccount -Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31 -Name : IntegrationAccount31 -Type : Microsoft.Logic/integrationAccounts -Location : brazilsouth -Sku : -CreatedTime : 3/26/2016 4:26:07 PM -ChangedTime : 3/26/2016 4:26:07 PM -``` - -This command gets all the integration accounts in your Azure subscription. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of an integration account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: IntegrationAccountName, ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Logic.Models.IntegrationAccount - -## NOTES - -## RELATED LINKS - -[Get-AzureRmIntegrationAccountCallbackUrl](./Get-AzureRmIntegrationAccountCallbackUrl.md) - -[New-AzureRmIntegrationAccount](./New-AzureRmIntegrationAccount.md) - -[Remove-AzureRmIntegrationAccount](./Remove-AzureRmIntegrationAccount.md) - -[Set-AzureRmIntegrationAccount](./Set-AzureRmIntegrationAccount.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccountAgreement.md b/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccountAgreement.md deleted file mode 100644 index bbd995331d..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccountAgreement.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: 70C96DFC-F265-4792-AE62-DD224A4EE237 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/get-azurermintegrationaccountagreement -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountAgreement.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountAgreement.md ---- - -# Get-AzureRmIntegrationAccountAgreement - -## SYNOPSIS -Gets an integration account agreement. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmIntegrationAccountAgreement [-ResourceGroupName <String>] [-Name <String>] [-AgreementName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmIntegrationAccountAgreement** cmdlet gets an integration account agreement from an Azure resource group. -Specify the integration account name, resource group name, and agreement name. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Get an integration account agreement -``` -PS C:\>Get-AzureRmIntegrationAccountAgreement -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -AgreementName "IntegrationAccountAgreement06" -Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/TestIntegrationAccount/agreements/IntegrationAccount31 -Name : IntegrationAccount31 -Type : Microsoft.Logic/integrationAccounts/agreements -CreatedTime : 3/24/2016 9:08:46 PM -ChangedTime : 3/24/2016 9:08:59 PM -AgreementType : AS2 -HostPartner : TestHost -GuestPartner : TestGuest -HostIdentityQualifier : XX -HostIdentityValue : BB -GuestIdentityQualifier : ZZ -GuestIdentityValue : AA -Content : {"AS2":{"ReceiveAgreement":{"SenderBusinessIdentity":{"Qualifier":"AA","Value":"AA"},"ReceiverBusinessIdentity":{"Qualifier":"ZZ - ","Value":"ZZ"},"ProtocolSettings":{"MessageConnectionSettings":{"IgnoreCertificateNameMismatch":true,"SupportHttpStatusCodeCont - . . . -``` - -This command gets an integration account agreement named IntegrationAccountAgreement06. - -### Example 2: Get integration account agreements by resource group name -``` -PS C:\>Get-AzureRmIntegrationAccountAgreement -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/TestIntegrationAccount/agreements/IntegrationAccount31 -Name : IntegrationAccount31 -Type : Microsoft.Logic/integrationAccounts/agreements -CreatedTime : 3/24/2016 9:08:46 PM -ChangedTime : 3/24/2016 9:08:59 PM -AgreementType : AS2 -HostPartner : TestHost -GuestPartner : TestGuest -HostIdentityQualifier : XX -HostIdentityValue : BB -GuestIdentityQualifier : ZZ -GuestIdentityValue : AA -Content : {"AS2":{"ReceiveAgreement":{"SenderBusinessIdentity":{"Qualifier":"AA","Value":"AA"},"ReceiverBusinessIdentity":{"Qualifier":"ZZ - ","Value":"ZZ"},"ProtocolSettings":{"MessageConnectionSettings":{"IgnoreCertificateNameMismatch":true,"SupportHttpStatusCodeCont - . . . -``` - -This command gets the integration account agreements by resource group name. - -## PARAMETERS - -### -AgreementName -Specifies the name of an integration account agreement. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of an integration account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: IntegrationAccountName, ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Logic.Models.IntegrationAccountAgreement - -## NOTES - -## RELATED LINKS - -[New-AzureRmIntegrationAccountAgreement](./New-AzureRmIntegrationAccountAgreement.md) - -[Remove-AzureRmIntegrationAccountAgreement](./Remove-AzureRmIntegrationAccountAgreement.md) - -[Set-AzureRmIntegrationAccountAgreement](./Set-AzureRmIntegrationAccountAgreement.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccountCallbackUrl.md b/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccountCallbackUrl.md deleted file mode 100644 index 04e2390a95..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccountCallbackUrl.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: 4813EE2B-16C4-4716-B6DD-9447A0B46F3D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/get-azurermintegrationaccountcallbackurl -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountCallbackUrl.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountCallbackUrl.md ---- - -# Get-AzureRmIntegrationAccountCallbackUrl - -## SYNOPSIS -Gets an integration account callback URL. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmIntegrationAccountCallbackUrl -ResourceGroupName <String> -Name <String> [-NotAfter <DateTime>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmIntegrationAccountCallbackUrl** cmdlet gets an integration account callback URL from a resource group. -This cmdlet returns a **CallbackUrl** object that represents the integration account callback URL. -Specify the integration account name and resource group name. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Get an integration account callback URL -``` -PS C:\>Get-AzureRmIntegrationAccountCallbackUrl -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -NotAfter "03/25/2016 18:23:22" -CallBackUrl : https://<baseurl>/integrationAccounts/8811f0155a364b5e9618ba28f7180601?api-version=2015-08-01-preview&se=2016-03 - -25T18%3A23%3A22.0000000Z&sp=%2F%2Fread&sv=1.0&sig=<value> -``` - -This command gets an integration account callback URL. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of an integration account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: IntegrationAccountName, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NotAfter -Specifies the expiry date for the callback URL. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Logic.Models.CallbackUrl - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLogicAppTriggerCallbackUrl](./Get-AzureRmLogicAppTriggerCallbackUrl.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccountCertificate.md b/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccountCertificate.md deleted file mode 100644 index d01a467f30..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccountCertificate.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: C0086E73-CCB1-4B75-B367-C79E17738122 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/get-azurermintegrationaccountcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountCertificate.md ---- - -# Get-AzureRmIntegrationAccountCertificate - -## SYNOPSIS -Gets integration account certificates from a resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmIntegrationAccountCertificate [-ResourceGroupName <String>] [-Name <String>] - [-CertificateName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmIntegrationAccountCertificate** cmdlet gets integration account certificates from a resource group. -Specify the integration account name, resource group name, and certificate name. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Get an integration account certificate -``` -PS C:\>Get-AzureRmIntegrationAccountCertificate -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -CertificateName "IntegrationAccountCertificate01" -Id : /subscriptions/<SusbcriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegartionAccount31/certificates/IntegrationAccountCertificate01 -Name : IntegrationAccountCertificate01 -Type : Microsoft.Logic/integrationAccounts/certificates -CreatedTime : 3/26/2016 6:59:07 PM -ChangedTime : 3/26/2016 6:59:07 PM -KeyName : TestKey -KeyVersion : 1.0 -KeyVaultId : /subscriptions/<SusbcriptionId/resourcegroups/ResourceGroup11/providers/microsoft.keyvault/vaults/<name> -KeyVaultName : testkeyvault -KeyVaultName : testkeyvault -PublicCertificate : -MetaData : -``` - -This command gets the integration account certificate named IntegrationAccountCertificate01. - -### Example 2: Get integration account certificates by integration account name -``` -PS C:\>Get-AzureRmIntegrationAccountCertificate -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -Id : /subscriptions/<SusbcriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegartionAccount31/certificates/IntegrationAccountCertificate01 -Name : IntegrationAccountCertificate01 -Type : Microsoft.Logic/integrationAccounts/certificates -CreatedTime : 3/26/2016 6:59:07 PM -ChangedTime : 3/26/2016 6:59:07 PM -KeyName : TestKey -KeyVersion : 1.0 -KeyVaultId : /subscriptions/<SusbcriptionId>/resourcegroups/ResourceGroup11/providers/microsoft.keyvault/vaults/<name> -KeyVaultName : testkeyvault -KeyVaultName : testkeyvault -PublicCertificate : -MetaData : -``` - -This command gets the integration account certificates for the integration account named IntegrationAccount31. - -## PARAMETERS - -### -CertificateName -Specifies the name of an integration account certificate. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of an integration account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: IntegrationAccountName, ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Logic.Models.IntegrationAccountCertificate - -## NOTES - -## RELATED LINKS - -[New-AzureRmIntegrationAccountCertificate](./New-AzureRmIntegrationAccountCertificate.md) - -[Remove-AzureRmIntegrationAccountCertificate](./Remove-AzureRmIntegrationAccountCertificate.md) - -[Set-AzureRmIntegrationAccountCertificate](./Set-AzureRmIntegrationAccountCertificate.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccountGeneratedIcn.md b/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccountGeneratedIcn.md deleted file mode 100644 index aa3839064d..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccountGeneratedIcn.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/get-azurermintegrationaccountgeneratedicn -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountGeneratedIcn.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountGeneratedIcn.md ---- - -# Get-AzureRmIntegrationAccountGeneratedIcn - -## SYNOPSIS -This cmdlet retrieves the current value of the generated interchange control number per agreement. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmIntegrationAccountGeneratedIcn -ResourceGroupName <String> -Name <String> [-AgreementName <String>] - [-AgreementType <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet is meant to be used in disaster recovery scenarios to retrieve the current value of the generated interchange control number so to write back an increased value with Set-AzureRmIntegrationAccountGeneratedIcn. -The interchange control number should be increased to avoid duplicate interchange control numbers for the numbers that could not yet be replicated to the passive region when the disaster happened in the active region. -Please do provide the "-AgreementType" parameter to specify whether X12 or Edifact control numbers to return - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmIntegrationAccountGeneratedIcn -AgreementType "X12" -ResourceGroupName "ResourceGroup1" -Name "IntegrationAccount1" -AgreementName "X12IntegrationAccountAgreement" -ControlNumber : 1000 -ControlNumberChangedTime : 2/15/2017 12:36:00 AM -IsMessageProcessingFailed: -``` - -This command gets the integration account generated X12 interchange control number by agreement name. Please make sure agreement specified is of type "X12" - -### Example 2 -``` -PS C:\> Get-AzureRmIntegrationAccountGeneratedIcn -AgreementType "Edifact" -ResourceGroupName "ResourceGroup1" -Name "IntegrationAccount1" -AgreementName "EdifactIntegrationAccountAgreement" -ControlNumber : 1000 -ControlNumberChangedTime : 2/15/2017 12:36:00 AM -IsMessageProcessingFailed: -``` - -This command gets the integration account generated Edifact interchange control number by agreement name. Please make sure agreement specified is of type "Edifact" - -### Example 3 -``` -PS C:\> Get-AzureRmIntegrationAccountGeneratedIcn -AgreementType "X12" -ResourceGroupName "ResourceGroup1" -Name "IntegrationAccount1" -ControlNumber : 1000 -ControlNumberChangedTime : 2/22/2017 8:05:41 PM -AgreementName : X12IntegrationAccountAgreement1 -IsMessageProcessingFailed: - -ControlNumber : 1000 -ControlNumberChangedTime : 2/22/2017 8:05:41 PM -AgreementName : X12IntegrationAccountAgreement2 -IsMessageProcessingFailed: - -ControlNumber : No generated control number was found for this agreement. -ControlNumberChangedTime : 1/1/0001 12:00:00 AM -AgreementName : X12IntegrationAccountAgreement3 -IsMessageProcessingFailed: -``` - -This command gets all the generated X12 interchange control numbers by integration account name. - -## PARAMETERS - -### -AgreementName -The integration account agreement name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AgreementType -The integration account agreement type. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: MessageType -Accepted values: X12, Edifact - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The integration account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The integration account resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.LogicApp.Utilities.IntegrationAccountControlNumber - -## NOTES - -## RELATED LINKS - -[Set-AzureRmIntegrationAccountGeneratedIcn](./Set-AzureRmIntegrationAccountGeneratedIcn.md) - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccountMap.md b/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccountMap.md deleted file mode 100644 index 39c751662d..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccountMap.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: 4F65A8B3-A250-41C1-9AA5-DBEB3193C401 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/get-azurermintegrationaccountmap -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountMap.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountMap.md ---- - -# Get-AzureRmIntegrationAccountMap - -## SYNOPSIS -Gets an integration account map. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmIntegrationAccountMap [-ResourceGroupName <String>] [-Name <String>] [-MapName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmIntegrationAccountMap** cmdlet gets integration account map from a resource group. -Specifying the integration account name, resource group name, and map name. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Get an integration account map -``` -PS C:\>Get-AzureRmIntegrationAccountMap -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -MapName "IntegrationAccountMap47" -Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31/maps/IntegrationAccountMap47 -Name : IntegrationAccountMap47 -Type : Microsoft.Logic/integrationAccounts/maps -CreatedTime : 3/24/2016 10:34:26 PM -ChangedTime : 3/24/2016 10:34:26 PM -MapType : Xslt -ContentType : -ContentLink : https://<baseurl>/integrationaccounts8811f0155a364b5e9618ba28f7180601/99D1E_XSLT_INTEGRATIONACCOUNT - MAP1-9A960F9B71C844CDB09D4922B3BCFF61?sv=2014-02-14&sr=b&sig=<value> -ContentSize : 3056 -Metadata : -``` - -This command gets an integration account map named IntegrationAccountMap47 in the specified resource group. - -### Example 2: Get integration account maps by integration account name -``` -PS C:\>Get-AzureRmIntegrationAccountMap -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31/maps/IntegrationAccountMap47 -Name : IntegrationAccountMap47 -Type : Microsoft.Logic/integrationAccounts/maps -CreatedTime : 3/24/2016 10:34:26 PM -ChangedTime : 3/24/2016 10:34:26 PM -MapType : Xslt -ContentType : -ContentLink : https://<baseurl>/integrationaccounts8811f0155a364b5e9618ba28f7180601/99D1E_XSLT_INTEGRATIONACCOUNT - MAP1-9A960F9B71C844CDB09D4922B3BCFF61?sv=2014-02-14&sr=b&sig=<value> -ContentSize : 3056 -Metadata : -``` - -This command gets the integration account maps by integration account name. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MapName -Specifies the name of an integration account map. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name for the integration account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: IntegrationAccountName, ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Logic.Models.IntegrationAccountMap - -## NOTES - -## RELATED LINKS - -[New-AzureRmIntegrationAccountMap](./New-AzureRmIntegrationAccountMap.md) - -[Remove-AzureRmIntegrationAccountMap](./Remove-AzureRmIntegrationAccountMap.md) - -[Set-AzureRmIntegrationAccountMap](./Set-AzureRmIntegrationAccountMap.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccountPartner.md b/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccountPartner.md deleted file mode 100644 index 681917b8a0..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccountPartner.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: 6E84E26F-8150-41F8-8823-CEED05619A75 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/get-azurermintegrationaccountpartner -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountPartner.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountPartner.md ---- - -# Get-AzureRmIntegrationAccountPartner - -## SYNOPSIS -Gets integration account partners. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmIntegrationAccountPartner [-ResourceGroupName <String>] [-Name <String>] [-PartnerName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmIntegrationAccountPartner** cmdlet gets integration account partners from a resource group. -Specify the integration account name, resource group name, and partner name. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Get an integration account partner -``` -PS C:\>Get-AzureRmIntegrationAccountPartner -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -PartnerName "IntegrationAccountPartner22" -Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/TestIntegrationAccount/partners/IntegrationAccountPartner31 -Name : IntegrationAccountPartner31 -Type : Microsoft.Logic/integrationAccounts/partners -PartnerType : B2B -CreatedTime : 3/24/2016 8:46:05 PM -ChangedTime : 3/24/2016 8:47:47 PM -BusinessIdentities : {"Qualifier":"CC","Value":"FF"} -Metadata : -``` - -This command gets the integration account partner named IntegrationAccountPartner22. - -### Example 2: Get an integration account partners by using an integration account name -``` -PS C:\>Get-AzureRmIntegrationAccountPartner -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/TestIntegrationAccount/partners/IntegrationAccountPartner31 -Name : IntegrationAccountPartner31 -Type : Microsoft.Logic/integrationAccounts/partners -PartnerType : B2B -CreatedTime : 3/24/2016 8:46:05 PM -ChangedTime : 3/24/2016 8:47:47 PM -BusinessIdentities : {"Qualifier":"CC","Value":"FF"} -Metadata : -``` - -This command gets the integration account partners for the integration account named IntegrationAccount31. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of an integration account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: IntegrationAccountName, ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PartnerName -Specifies the name of the integration account partner. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Logic.Models.IntegrationAccountPartner - -## NOTES - -## RELATED LINKS - -[New-AzureRmIntegrationAccountPartner](./New-AzureRmIntegrationAccountPartner.md) - -[Remove-AzureRmIntegrationAccountPartner](./Remove-AzureRmIntegrationAccountPartner.md) - -[Set-AzureRmIntegrationAccountPartner](./Set-AzureRmIntegrationAccountPartner.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccountReceivedIcn.md b/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccountReceivedIcn.md deleted file mode 100644 index dda234078e..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccountReceivedIcn.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/get-azurermintegrationaccountreceivedicn -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountReceivedIcn.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountReceivedIcn.md ---- - -# Get-AzureRmIntegrationAccountReceivedIcn - -## SYNOPSIS -This cmdlet retrieves a specific received interchange control number per agreement and control number value. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmIntegrationAccountReceivedIcn -ResourceGroupName <String> -Name <String> -AgreementName <String> - -ControlNumberValue <String> [-AgreementType <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet is meant to be used in disaster recovery scenarios to validate the presence of a received interchange control number and optionally to remove that entity with Remove-AzureRmIntegrationAccountReceivedIcn. -Please do provide the "-AgreementType" parameter to specify whether X12 or Edifact control numbers to return - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmIntegrationAccountReceivedIcn -AgreementType "X12" -ResourceGroupName "groupName" -Name "accountName" -AgreementName "X12AgreementName" -ControlNumberValue "000000641" -ControlNumber : 000000641 -ControlNumberChangedTime : 2/15/2017 12:36:00 AM -IsMessageProcessingFailed: False -``` - -This command gets the X12 integration account received interchange control number by agreement name and control number value. - -### Example 2 -``` -PS C:\> Get-AzureRmIntegrationAccountReceivedIcn -AgreementType "Edifact" -ResourceGroupName "groupName" -Name "accountName" -AgreementName "EdifactAgreementName" -ControlNumberValue "000000641" -ControlNumber : 000000641 -ControlNumberChangedTime : 2/15/2017 12:36:00 AM -IsMessageProcessingFailed: False -``` - -This command gets the Edifact integration account received interchange control number by agreement name and control number value. - -## PARAMETERS - -### -AgreementName -The integration account agreement name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AgreementType -The integration account agreement type. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: MessageType -Accepted values: X12, Edifact - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ControlNumberValue -The integration account control number value. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The integration account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The integration account resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.LogicApp.Utilities.IntegrationAccountControlNumber - -## NOTES - -## RELATED LINKS - -[Set-AzureRmIntegrationAccountReceivedIcn](./Set-AzureRmIntegrationAccountReceivedIcn.md) - -[Remove-AzureRmIntegrationAccountReceivedIcn](./Remove-AzureRmIntegrationAccountReceivedIcn.md) diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccountSchema.md b/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccountSchema.md deleted file mode 100644 index af9c244323..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmIntegrationAccountSchema.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: 6C16B04B-459A-4B2C-B7DF-AC4D16FF7281 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/get-azurermintegrationaccountschema -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountSchema.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountSchema.md ---- - -# Get-AzureRmIntegrationAccountSchema - -## SYNOPSIS -Gets integration account schemas. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmIntegrationAccountSchema [-ResourceGroupName <String>] [-Name <String>] [-SchemaName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmIntegrationAccountSchema** cmdlet gets integration account schemas. -Specifying the integration account name, resource group name, and schema name. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Get an integration account schema -``` -PS C:\>Get-AzureRmIntegrationAccountSchema -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -SchemaName "IntegrationAccountSchema43" -Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31/schemas/IntegrationAccountSchema43 -Name : IntegrationAccountSchema43 -Type : Microsoft.Logic/integrationAccounts/schemas -CreatedTime : 3/25/2016 5:42:58 PM -ChangedTime : 3/25/2016 5:42:58 PM -SchemaType : Xml -ContentType : -ContentLink : https://<baseurl>/integrationaccounts469af4f3cf4047b7ac3a08c87948ec5f/3839E_XML_INTEGRATIONACCOUNTSCHEMA43-5A86631F61F - 14513AA1185A52C6B2874?sv=2014-02-14&sr=b&sig=<value> -ContentSize : 7901 -MetaData : -``` - -This command gets the integration account schema named IntegrationAccountSchema43. - -### Example 2: Get integration account schemas for a resource group -``` -PS C:\>Get-AzureRmIntegrationAccountSchema -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31/schemas/IntegrationAccountSchema43 -Name : IntegrationAccountSchema43 -Type : Microsoft.Logic/integrationAccounts/schemas -CreatedTime : 3/25/2016 5:42:58 PM -ChangedTime : 3/25/2016 5:42:58 PM -SchemaType : Xml -ContentType : -ContentLink : https://<baseurl>/integrationaccounts469af4f3cf4047b7ac3a08c87948ec5f/3839E_XML_INTEGRATIONACCOUNTSCHEMA43-5A86631F61F - 14513AA1185A52C6B2874?sv=2014-02-14&sr=b&sig=<value> -ContentSize : 7901 -MetaData : -``` - -This command gets the integration account schemas for the resource group named ResourceGroup11. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of an integration account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: IntegrationAccountName, ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SchemaName -Specifies the name of an integration account schema. -Specifies the name of a schema. -. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Logic.Models.IntegrationAccountSchema - -## NOTES - -## RELATED LINKS - -[New-AzureRmIntegrationAccountSchema](./New-AzureRmIntegrationAccountSchema.md) - -[Remove-AzureRmIntegrationAccountSchema](./Remove-AzureRmIntegrationAccountSchema.md) - -[Set-AzureRmIntegrationAccountSchema](./Set-AzureRmIntegrationAccountSchema.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmLogicApp.md b/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmLogicApp.md deleted file mode 100644 index 7850055c68..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmLogicApp.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: 7BFCD982-EC80-418B-BB52-C9941D028F76 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/get-azurermlogicapp -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicApp.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicApp.md ---- - -# Get-AzureRmLogicApp - -## SYNOPSIS -Gets a logic app from a resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmLogicApp -ResourceGroupName <String> -Name <String> [-Version <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmLogicApp** cmdlet gets a logic app. -This cmdlet returns a **Workflow** object. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Get a logic app from a resource group -``` -PS C:\>Get-AzureRmLogicApp -ResourceGroupName "ResourceGroup11" -Name "LogicApp03" -Id : /subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourceGroups/LogicAppCmdletTest/providers/Microsoft.Logic/workflows/LogicApp03 -Name : LogicApp03 -Type : Microsoft.Logic/workflows -Location : westus -ChangedTime : 1/13/2016 2:41:39 PM -CreatedTime : 1/13/2016 2:41:39 PM -AccessEndpoint : https://westus.logic.azure.com:443/subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourcegroups/ResourceGroup11/providers/Microsoft.Logic/workflows/LogicApp03 -State : Enabled -DefinitionLinkUri : -DefinitionLinkContentVersion : -Definition : {$schema, contentVersion, parameters, triggers...} -ParametersLinkUri : -ParametersLinkContentVersion : -Parameters : {[destinationUri, Microsoft.Azure.Management.Logic.Models.WorkflowParameter]} -SkuName : Standard -PlanName : StandardServicePlan -PlanType : Microsoft.Web/ServerFarms -PlanId : /subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourceGroups/ResourceGroup11/providers/Microsoft.Web/serverfarms/StandardServicePlan -Version : 08587489107859952120 -``` - -This command gets a logic app from the resource group named ResourceGroup11. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the logic app that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name for a resource group in which this cmdlet gets a logic app. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Version -Specifies the version of a logic app. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Logic.Models.Workflow - -### Microsoft.Azure.Management.Logic.Models.WorkflowVersion - -## NOTES - -## RELATED LINKS - -[New-AzureRmLogicApp](./New-AzureRmLogicApp.md) - -[Remove-AzureRmLogicApp](./Remove-AzureRmLogicApp.md) - -[Set-AzureRmLogicApp](./Set-AzureRmLogicApp.md) - -[Start-AzureRmLogicApp](./Start-AzureRmLogicApp.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmLogicAppRunAction.md b/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmLogicAppRunAction.md deleted file mode 100644 index 5988b096b5..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmLogicAppRunAction.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: 2EA28B90-4BAE-45DF-BD2E-60C74F53FB7B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/get-azurermlogicapprunaction -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppRunAction.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppRunAction.md ---- - -# Get-AzureRmLogicAppRunAction - -## SYNOPSIS -Gets an action from a logic app run. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmLogicAppRunAction -ResourceGroupName <String> -Name <String> -RunName <String> - [-ActionName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmLogicAppRunAction** cmdlet gets an action from a logic app run. -This cmdlet returns a **WorkflowRunAction** objects. -Specify the logic app, resource group, and run. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Get an action from a Logic App run -``` -PS C:\>Get-AzureRmLogicAppActionRun -ResourceGroupName "ResourceGroup11" -Name "LogicApp05" -RunName "LogicAppRun56" -ActionName "LogicAppAction01" -Code : NotFound -EndTime : 1/13/2016 2:42:56 PM -Error : -InputsLink : Microsoft.Azure.Management.Logic.Models.ContentLink -Name : LogicAppAction01 -OutputsLink : Microsoft.Azure.Management.Logic.Models.ContentLink -StartTime : 1/13/2016 2:42:55 PM -Status : Failed -TrackingId : -Type : -``` - -This command gets a specific Logic App action from the logic app named LogicApp05 for the run named LogicAppRun56. - -### Example 2: Get all the actions from a Logic App run -``` -PS C:\>Get-AzureRmLogicAppActionRun -ResourceGroupName "ResourceGroup11" -Name "LogicApp05" -RunName "LogicAppRun56" -Code : NotFound -EndTime : 1/13/2016 2:42:56 PM -Error : -InputsLink : Microsoft.Azure.Management.Logic.Models.ContentLink -Name : LogicAppAction1 -OutputsLink : Microsoft.Azure.Management.Logic.Models.ContentLink -StartTime : 1/13/2016 2:42:55 PM -Status : Failed -TrackingId : -Type : -``` - -This command gets all Logic App actions from a run named LogicAppRun56 of a logic app named LogicApp05. - -## PARAMETERS - -### -ActionName -Specifies the name of an action in a logic app run. -This cmdlet gets the action that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a logic app for which this cmdlet gets an action. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group in which this cmdlet gets an action. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RunName -Specifies the name of a run of a logic app. -This cmdlet gets an action for the run that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Logic.Models.WorkflowRunAction - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLogicAppRunHistory](./Get-AzureRmLogicAppRunHistory.md) - -[Stop-AzureRmLogicAppRun](./Stop-AzureRmLogicAppRun.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmLogicAppRunHistory.md b/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmLogicAppRunHistory.md deleted file mode 100644 index acfd83d15a..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmLogicAppRunHistory.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: F271BCB1-6D43-48E5-BB51-00288F57BFFB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/get-azurermlogicapprunhistory -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppRunHistory.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppRunHistory.md ---- - -# Get-AzureRmLogicAppRunHistory - -## SYNOPSIS -Gets the run history of a logic app. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmLogicAppRunHistory -ResourceGroupName <String> -Name <String> [-RunName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmLogicAppRunHistory** cmdlet gets the run history of a logic app. -This cmdlet returns a collection of **WorkflowRun** objects. -Specify the logic app and resource group. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Get the run history of a logic app -``` -PS C:\>Get-AzureRmLogicAppActionRunHistory -ResourceGroupName "Resourcegroup11" -Name "LogicApp03" -CorrelationId : 00001111-aaaa-2222-bbbb-3333cccc4444 -EndTime : 1/13/2016 2:46:55 PM -Error : {code, message} -Name : 08587489104702792076 -Outputs : {} -StartTime : 1/13/2016 2:46:55 PM -Status : Failed -TriggerName : -LogicAppName : LogicApp03 -LogicAppVersion : 08587489107859952540 - -CorrelationId : 00001111-aaaa-2222-bbbb-3333cccc4444 -EndTime : 1/13/2016 2:42:56 PM -Error : {code, message} -Name : 08587489107100664541 -Outputs : {} -StartTime : 1/13/2016 2:42:55 PM -Status : Failed -TriggerName : httpTrigger -LogicAppName : LogicApp03 -LogicAppVersion : 08587489107859952120 -``` - -This command gets the run history of a logic app named LogicApp03. - -### Example 2: Get a logic app run -``` -PS C:\>Get-AzureRmLogicAppActionRunHistory -ResourceGroupName "Resourcegroup11" -Name "LogicApp03" -RunName "08587489104702792076" -CorrelationId : 00001111-aaaa-2222-bbbb-3333cccc4444 -EndTime : 1/13/2016 2:46:55 PM -Error : {code, message} -Name : 08587489104702792076 -Outputs : {} -StartTime : 1/13/2016 2:46:55 PM -Status : Failed -TriggerName : -LogicAppName : LogicApp03 -LogicAppVersion : 08587489107859952120 -``` - -This command gets a specific logic app run for the logic app named LogicApp03. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the logic app for which this cmdlet gets run history. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group that contains the logic app. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RunName -Specifies the run name of a logic app. -This cmdlet gets the workflow run that this cmdlet specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Logic.Models.WorkflowRun - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLogicAppRunAction](./Get-AzureRmLogicAppRunAction.md) - -[Start-AzureRmLogicApp](./Start-AzureRmLogicApp.md) - -[Stop-AzureRmLogicAppRun](./Stop-AzureRmLogicAppRun.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmLogicAppTrigger.md b/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmLogicAppTrigger.md deleted file mode 100644 index 1f629b72d4..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmLogicAppTrigger.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: 5307F1F1-E84C-4949-A557-99EF0012C3DF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/get-azurermlogicapptrigger -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppTrigger.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppTrigger.md ---- - -# Get-AzureRmLogicAppTrigger - -## SYNOPSIS -Gets the triggers of a logic app. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmLogicAppTrigger -ResourceGroupName <String> -Name <String> [-TriggerName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmLogicAppTrigger** cmdlet gets triggers from a logic app. -This cmdlet returns a **WorkflowTrigger** object. -Specify the workflow, resource group, and trigger. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Get a trigger of a logic app -``` -PS C:\>Get-AzureRmLogicAppTrigger -ResourceGroupName "ResourceGroup11" -Name "LogicApp05" -TriggerName "Trigger01" -ChangedTime : 1/14/2016 11:45:07 AM -CreatedTime : 1/13/2016 2:42:26 PM -LastExecutionTime : 1/14/2016 11:45:07 AM -Name : Trigger01 -NextExecutionTime : 1/14/2016 12:45:07 PM -RecurrenceFrequency : Minute -RecurrenceInterval : 60 -Status : Waiting -Type : Microsoft.Logic/workflows/triggers -LogicAppName : LogicApp05 -LogicAppVersion : 08587489107406290826 -``` - -This command gets the trigger named Trigger01 from the logic app named LogicApp05. - -### Example 2: Get all triggers of a logic app -``` -PS C:\>Get-AzureRmLogicAppTrigger -ResourceGroupName "ResourceGroup11" -Name "LogicApp07" -ChangedTime : 1/14/2016 11:45:07 AM -CreatedTime : 1/13/2016 2:42:26 PM -LastExecutionTime : 1/14/2016 11:45:07 AM -Name : Trigger02 -NextExecutionTime : 1/14/2016 12:45:07 PM -RecurrenceFrequency : Minute -RecurrenceInterval : 60 -Status : Waiting -Type : Microsoft.Logic/workflows/triggers -LogicAppName : LogicApp07 -LogicAppVersion : 08587489107406290826 -``` - -This command gets the triggers of the logic app named LogicApp07. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the logic app from which this cmdlet gets a trigger. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group in which this cmdlet gets a trigger. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TriggerName -Specifies the name of the trigger that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Logic.Models.WorkflowTrigger - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLogicAppTriggerHistory](./Get-AzureRmLogicAppTriggerHistory.md) - -[Start-AzureRmLogicApp](./Start-AzureRmLogicApp.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmLogicAppTriggerCallbackUrl.md b/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmLogicAppTriggerCallbackUrl.md deleted file mode 100644 index e4e3c02c2b..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmLogicAppTriggerCallbackUrl.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: F523CFA0-427B-41AF-9C2D-EB54EC96C04B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/get-azurermlogicapptriggercallbackurl -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppTriggerCallbackUrl.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppTriggerCallbackUrl.md ---- - -# Get-AzureRmLogicAppTriggerCallbackUrl - -## SYNOPSIS -Gets a Logic App trigger callback URL. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmLogicAppTriggerCallbackUrl -ResourceGroupName <String> -Name <String> -TriggerName <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmLogicAppTriggerCallbackUrl** cmdlet gets a Logic App trigger callback URL from a resource group. -This cmdlet returns a **WorkflowTriggerCallbackUrl** object that represents the callback URL. -Specify the resource group name, logic app name, and trigger name. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Get a Logic App trigger callback URL -``` -PS C:\>Get-AzureRmLogicAppTriggerCallbackUrl -ResourceGroupName "ResourceGroup11" -Name "LogicApp1" -TriggerName "manual" -Value ------ -https://prod-03.westus.logic.azure.com:443/workflows/c4ed9335bc864140a11f4508d19acea3/triggers/manual/run?api-version=2016-06-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=<value> -``` - -This command gets a Logic App trigger callback URL. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a logic app. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TriggerName -Specifies the name of a trigger. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Logic.Models.WorkflowTriggerCallbackUrl - -## NOTES - -## RELATED LINKS - -[Get-AzureRmIntegrationAccountCallbackUrl](./Get-AzureRmIntegrationAccountCallbackUrl.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmLogicAppTriggerHistory.md b/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmLogicAppTriggerHistory.md deleted file mode 100644 index 7824aac271..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmLogicAppTriggerHistory.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: C1F6BBF9-0DB5-46FD-B8A8-9029B0AB6166 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/get-azurermlogicapptriggerhistory -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppTriggerHistory.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppTriggerHistory.md ---- - -# Get-AzureRmLogicAppTriggerHistory - -## SYNOPSIS -Gets the history of triggers in a logic app. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmLogicAppTriggerHistory -ResourceGroupName <String> -Name <String> -TriggerName <String> - [-HistoryName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmLogicAppTriggerHistory** cmdlet gets the history of triggers in a logic app in the Logic Apps feature. -This cmdlet returns a **WorkflowTriggerHistory** object. -Specify the logic app, resource group, and trigger. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Get a trigger history of a logic app -``` -PS C:\>Get-AzureRmLogicAppTriggerHistory -ResourceGroupName "Resourcegroup11" -Name "LogicApp03" -TriggerName "Trigger01" -HistoryName "08587489107387695768" -Code : BadRequest -EndTime : 1/13/2016 2:42:26 PM -Error : {code, message} -Fired : False -InputsLink : https://flowprodcu02by01.blob.core.windows.net/flow3ea9ffd11c684c9f9f258b1a6ea5cb6020160113t000000zcontent/A7392_d1e831de68ac4ef89d19a40f05e663 - cb_httpTrigger:5Finputs:2Ejson?sv=2014-02-14&sr=b&sig=&se=2016-01-14T16%3A15%3A16Z&sp=r -Name : 08587489107387695768 -OutputsLink : -Run : -StartTime : 1/13/2016 2:42:26 PM -Status : Failed -TrackingId : f88a499b-f80f-4a28-9bbf-c4cc0d129700 -Type : Microsoft.Logic/workflows/triggers/histories -``` - -This command gets a specific logic app trigger history for a trigger in the logic app named LogicApp03. - -### Example 2: Get trigger histories of a logic app -``` -PS C:\>Get-AzureRmLogicAppTriggerHistory -ResourceGroupName "ResourceGroup11" -Name "LogicApp07" -TriggerName "Trigger01" -Code : BadRequest -EndTime : 1/13/2016 2:43:33 PM -Error : {code, message} -Fired : False -InputsLink : https://flowprodcu02by01.blob.core.windows.net/flow3ea9ffd11c684c9f9f258b1a6ea5cb6020160113t000000zcontent/CAB46_60e2ad0f0e1947e8b5798716914c5d - b6_httpTrigger:5Finputs:2Ejson?sv=2014-02-14&sr=b&sig=&se=2016-01-14T16%3A18%3A27Z&sp=r -Name : 08587489106716457817 -OutputsLink : -Run : -StartTime : 1/13/2016 2:43:33 PM -Status : Failed -TrackingId : c91a63f1-48b4-4eae-91eb-8f6dbfa9fe06 -Type : Microsoft.Logic/workflows/triggers/histories - -Code : BadRequest -EndTime : 1/13/2016 2:42:26 PM -Error : {code, message} -Fired : False -InputsLink : https://flowprodcu02by01.blob.core.windows.net/flow3ea9ffd11c684c9f9f258b1a6ea5cb6020160113t000000zcontent/A7392_d1e831de68ac4ef89d19a40f05e663 - cb_httpTrigger:5Finputs:2Ejson?sv=2014-02-14&sr=b&sig=&se=2016-01-14T16%3A18%3A27Z&sp=r -Name : 08587489107387695768 -OutputsLink : -Run : -StartTime : 1/13/2016 2:42:26 PM -Status : Failed -TrackingId : f88a499b-f80f-4a28-9bbf-c4cc0d129700 -Type : Microsoft.Logic/workflows/triggers/histories -``` - -This command gets the workflow trigger histories for a trigger in the logic app named LogicApp07. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HistoryName -Specifies the name of the history that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the logic app for which this cmdlet gets trigger history. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group in which this cmdlet gets history. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TriggerName -Specifies the name of the trigger for which this cmdlet gets history. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Logic.Models.WorkflowTriggerHistory - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLogicAppRunHistory](./Get-AzureRmLogicAppRunHistory.md) - -[Get-AzureRmLogicAppTrigger](./Get-AzureRmLogicAppTrigger.md) - -[Start-AzureRmLogicApp](./Start-AzureRmLogicApp.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmLogicAppUpgradedDefinition.md b/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmLogicAppUpgradedDefinition.md deleted file mode 100644 index 7ee36057fd..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Get-AzureRmLogicAppUpgradedDefinition.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: B7FED447-C398-47D7-AF1B-A3E4FDAD0B41 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/get-azurermlogicappupgradeddefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppUpgradedDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppUpgradedDefinition.md ---- - -# Get-AzureRmLogicAppUpgradedDefinition - -## SYNOPSIS -Gets the upgraded definition for a logic app. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmLogicAppUpgradedDefinition -ResourceGroupName <String> -Name <String> -TargetSchemaVersion <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmLogicAppUpgradedDefinition** cmdlet gets the upgraded definition for the schema version and logic app from a resource group. -This cmdlet returns an object that represents the definition of the upgraded logic app. -Specify the resource group name, logic app name, and target schema version. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Get a logic app upgraded definition -``` -PS C:\>$UpgradedDefinition = Get-AzureRmLogicAppUpgradedDefinition -ResourceGroupName "ResourceGroup11" -Name "LogicApp01" -TargetSchemaVersion "2016-06-01" -$UpgradedDefinition.ToString() -{ - - "$schema": "http://schema.management.azure.com/providers/Microsoft.Logic/schemas/2016-06-01/workflowdefinition.json#", - - "contentVersion": "1.0.0.0", - - "parameters": {}, - - "triggers": { - - "httpTrigger": { - - "recurrence": { - - "frequency": "Hour", - - "interval": 1 - - }, - - "type": "Http", - - "inputs": { - - "method": "GET", - - "uri": "http://www.bing.com" - - }, - - "conditions": [ - - { - - "expression": "@bool('true')" - - } - - ] - - }, - - "manualTrigger": { - - "type": "Request", - - "kind": "Http" - - } - - }, - - "actions": { - - "httpScope": { - - "actions": { - - "http": { - - "runAfter": {}, - - "type": "Http", - - "inputs": { - - "method": "GET", - - "uri": "http://www.bing.com" - - } - - } - - }, - - "runAfter": {}, - - "else": { - - "actions": {} - - }, - - "expression": "@bool('true')", - - "type": "If" - - }, - - "http1Scope": { - - "actions": { - - "http1": { - - "runAfter": {}, - - "type": "Http", - - "inputs": { - - "method": "GET", - - "uri": "http://www.bing.com" - - } - - } - - }, - - "runAfter": {}, - - "else": { - - "actions": {} - - }, - - "expression": "@bool('true')", - - "type": "If" - - } - - }, - - "outputs": { - - "output1": { - - "type": "String", - - "value": "true" - - } - - } - -} -``` - -The first command gets the definition for the logic app upgraded to the specified target schema version. -The command stores the definition in the $UpgradedDefinition variable. -The second command displays the contents of $UpgradedDefinition as a string. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a logic app. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetSchemaVersion -Specifies the target schema version of the definition. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLogicApp](./Get-AzureRmLogicApp.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/New-AzureRmIntegrationAccount.md b/azurermps-6.13.0/AzureRM.LogicApp/New-AzureRmIntegrationAccount.md deleted file mode 100644 index 43e9b79d82..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/New-AzureRmIntegrationAccount.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: 5F1A4FE0-CB57-45D3-9F08-879469A61E1E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/new-azurermintegrationaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccount.md ---- - -# New-AzureRmIntegrationAccount - -## SYNOPSIS -Creates an integration account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmIntegrationAccount -ResourceGroupName <String> -Name <String> -Location <String> [-Sku <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmIntegrationAccount** cmdlet creates an integration account. -This cmdlet returns an object that represents the integration account.Specify a name, location, resource group name, and SKU name. -Template parameter file values that you specify at the command line take precedence over template parameter values in a template parameter object. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Create an integration account -``` -PS C:\>New-AzureRmIntegrationAccount -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -Location "brazilsouth" -Sku "Standard" -Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31 -Name : IntegrationAccount31 -Type : Microsoft.Logic/integrationAccounts -Location : brazilsouth -Sku : -CreatedTime : 3/26/2016 4:26:07 PM -ChangedTime : 3/26/2016 4:26:07 PM -``` - -This command creates an integration account named IntegrationAccount31 in the specified resource group. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies a location for the integration account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the integration account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: IntegrationAccountName, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -Specifies a SKU name for the integration account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Logic.Models.IntegrationAccount - -## NOTES - -## RELATED LINKS - -[Get-AzureRmIntegrationAccount](./Get-AzureRmIntegrationAccount.md) - -[Remove-AzureRmIntegrationAccount](./Remove-AzureRmIntegrationAccount.md) - -[Set-AzureRmIntegrationAccount](./Set-AzureRmIntegrationAccount.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/New-AzureRmIntegrationAccountAgreement.md b/azurermps-6.13.0/AzureRM.LogicApp/New-AzureRmIntegrationAccountAgreement.md deleted file mode 100644 index 04e6e95578..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/New-AzureRmIntegrationAccountAgreement.md +++ /dev/null @@ -1,334 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: B8998AAA-05FC-4029-A284-B64E23326B22 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/new-azurermintegrationaccountagreement -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccountAgreement.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccountAgreement.md ---- - -# New-AzureRmIntegrationAccountAgreement - -## SYNOPSIS -Creates an integration account agreement. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmIntegrationAccountAgreement -ResourceGroupName <String> -Name <String> -AgreementName <String> - -AgreementType <String> -GuestPartner <String> -HostPartner <String> -GuestIdentityQualifier <String> - -GuestIdentityQualifierValue <String> -HostIdentityQualifier <String> -HostIdentityQualifierValue <String> - [-AgreementContent <String>] [-AgreementContentFilePath <String>] [-Metadata <Object>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmIntegrationAccountAgreement** cmdlet creates an integration account agreement. -This cmdlet returns an object that represents the integration account agreement. -Specify the integration account name, resource group name, agreement name, type, partner name, partner qualifiers, and agreement content. -Template parameter file values that you specify at the command line take precedence over template parameter values in a template parameter object. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Create a integration account agreement -``` -PS C:\>New-AzureRmIntegrationAccountAgreement -Name "IntegrationAccount31"-ResourceGroupName "ResourceGroup11" -AgreementName "IntegrationAccountAgreement06" -AgreementType "X12" -GuestPartner "GuestPartner" -HostPartner "HostPartner" -GuestIdentityQualifier "BB" -HostIdentityQualifier "AA" -AgreementContentFilePath "C:\temp\AgreementContent.json" -Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31/agreements/IntegrationAccountAgreement06 -Name : IntegrationAccountAgreement06 -Type : Microsoft.Logic/integrationAccounts/agreements -CreatedTime : 3/26/2016 6:43:52 PM -ChangedTime : 3/26/2016 6:43:52 PM -AgreementType : X12 -HostPartner : HostPartner -GuestPartner : GuestPartner -HostIdentityQualifier : AA -HostIdentityValue : AA -GuestIdentityQualifier : BB -GuestIdentityValue : BB -Content : {"AS2":null,"X12":{"ReceiveAgreement":{"SenderBusinessIdentity":{"Qualifier":"AA","Value":"AA"},"ReceiverBusinessIdentity":{"Qualifier":"ZZ","Valu - e":"ZZ"},"ProtocolSettings":{"ValidationSettings":{"ValidateCharacterSet":true,"CheckDuplicateInterchangeControlNumber":false,"InterchangeControlN - - . . . -``` - -This command creates an integration account agreement in the specified Azure resource group. - -## PARAMETERS - -### -AgreementContent -Specifies agreement content, in JavaScript Object Notation (JSON) format, for the agreement. -Specify either this parameter or the *AgreementContentFilePath* parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AgreementContentFilePath -Specifies the file path of agreement content for the agreement. -Specify either this parameter or the *AgreementContent* parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AgreementName -Specifies a name for the integration account agreement. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AgreementType -Specifies the integration account agreement type. -The acceptable values for this parameter are: -- X12 -- AS2 -- Edifact - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: X12, AS2, Edifact - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GuestIdentityQualifier -Specifies a name business identity qualifier for the guest partner. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GuestIdentityQualifierValue -The integration account agreement guest identity qualifier value. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GuestPartner -Specifies the name of the guest partner. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostIdentityQualifier -Specifies a name business identity qualifier for the host partner. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostIdentityQualifierValue -The integration account agreement host identity qualifier value. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostPartner -Specifies the name of the host partner. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Metadata -Specifies a metadata object for the agreement. - -```yaml -Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the integration account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: IntegrationAccountName, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Logic.Models.IntegrationAccountAgreement - -## NOTES - -## RELATED LINKS - -[Get-AzureRmIntegrationAccountAgreement](./Get-AzureRmIntegrationAccountAgreement.md) - -[Remove-AzureRmIntegrationAccountAgreement](./Remove-AzureRmIntegrationAccountAgreement.md) - -[Set-AzureRmIntegrationAccountAgreement](./Set-AzureRmIntegrationAccountAgreement.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/New-AzureRmIntegrationAccountCertificate.md b/azurermps-6.13.0/AzureRM.LogicApp/New-AzureRmIntegrationAccountCertificate.md deleted file mode 100644 index 01b239bafc..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/New-AzureRmIntegrationAccountCertificate.md +++ /dev/null @@ -1,309 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: BB1B49CD-B42F-4222-B0BA-0AA4CE3C95E0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/new-azurermintegrationaccountcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccountCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccountCertificate.md ---- - -# New-AzureRmIntegrationAccountCertificate - -## SYNOPSIS -Creates an integration account certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### PrivateKey -``` -New-AzureRmIntegrationAccountCertificate -ResourceGroupName <String> -Name <String> -CertificateName <String> - -KeyName <String> -KeyVersion <String> -KeyVaultId <String> [-PublicCertificateFilePath <String>] - [-Metadata <Object>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### PublicKey -``` -New-AzureRmIntegrationAccountCertificate -ResourceGroupName <String> -Name <String> -CertificateName <String> - [-KeyName <String>] [-KeyVersion <String>] [-KeyVaultId <String>] -PublicCertificateFilePath <String> - [-Metadata <Object>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Both -``` -New-AzureRmIntegrationAccountCertificate -ResourceGroupName <String> -Name <String> -CertificateName <String> - -KeyName <String> -KeyVersion <String> -KeyVaultId <String> -PublicCertificateFilePath <String> - [-Metadata <Object>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmIntegrationAccountCertificate** cmdlet creates an integration account certificate. -This cmdlet returns an object that represents the integration account certificate. -Specify the integration account name, resource group name, certificate name, key name, key version, and key vault ID. -Template parameter file values that you specify at the command line take precedence over template parameter values in a template parameter object. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Create an integration account certificate -``` -PS C:\>New-AzureRmIntegrationAccountCertificate -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -CertificateName "IntegrationAccountCertificate01" -KeyName "TestKey" -KeyVersion "1.0" -KeyVaultId "/subscriptions/<subscriptionId>/resourcegroups/ResourceGroup11/providers/microsoft.keyvault/vaults/keyvault" -PublicCertificateFilePath "c:\temp\Certificate.cer" -Id : /subscriptions/<SusbcriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegartionAccount31/certificates/IntegrationAccountCertificate01 -Name : IntegrationAccountCertificate01 -Type : Microsoft.Logic/integrationAccounts/certificates -CreatedTime : 3/26/2016 6:59:07 PM -ChangedTime : 3/26/2016 6:59:07 PM -KeyName : TestKey -KeyVersion : 1.0 -KeyVaultId : /subscriptions/<SusbcriptionId>/resourcegroups/ResourceGroup11/providers/microsoft.keyvault/vaults/<name> -KeyVaultName : testkeyvault -KeyVaultName : testkeyvault -PublicCertificate : -MetaData : -``` - -This command creates the integration account certificate in the specified resource group. - -## PARAMETERS - -### -CertificateName -Specifies a name for the integration account certificate. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyName -Specifies the name of the certificate key in the key vault. - -```yaml -Type: System.String -Parameter Sets: PrivateKey, Both -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: PublicKey -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyVaultId -Specifies a key vault ID. - -```yaml -Type: System.String -Parameter Sets: PrivateKey, Both -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: PublicKey -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyVersion -Specifies the version of the certificate key in the key vault. - -```yaml -Type: System.String -Parameter Sets: PrivateKey, Both -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: PublicKey -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Metadata -Specifies a metadata object for the certificate. - -```yaml -Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of an integration account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: IntegrationAccountName, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicCertificateFilePath -Specifies the path of a public certificate (.cer) file. - -```yaml -Type: System.String -Parameter Sets: PrivateKey -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: PublicKey, Both -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Logic.Models.IntegrationAccountCertificate - -## NOTES - -## RELATED LINKS - -[Get-AzureRmIntegrationAccountCertificate](./Get-AzureRmIntegrationAccountCertificate.md) - -[Remove-AzureRmIntegrationAccountCertificate](./Remove-AzureRmIntegrationAccountCertificate.md) - -[Set-AzureRmIntegrationAccountCertificate](./Set-AzureRmIntegrationAccountCertificate.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/New-AzureRmIntegrationAccountMap.md b/azurermps-6.13.0/AzureRM.LogicApp/New-AzureRmIntegrationAccountMap.md deleted file mode 100644 index e0556f3e1c..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/New-AzureRmIntegrationAccountMap.md +++ /dev/null @@ -1,250 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: DF71430C-F33F-409B-A550-CC7285252E91 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/new-azurermintegrationaccountmap -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccountMap.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccountMap.md ---- - -# New-AzureRmIntegrationAccountMap - -## SYNOPSIS -Creates an integration account map. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmIntegrationAccountMap -ResourceGroupName <String> -Name <String> -MapName <String> - [-MapFilePath <String>] [-MapDefinition <String>] [-MapType <String>] [-ContentType <String>] - [-Metadata <Object>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmIntegrationAccountMap** cmdlet creates an integration account map. -This cmdlet returns an object that represents the integration account map. -Specifying the integration account name, resource group name, map name, and map definition. -Template parameter file values that you specify at the command line take precedence over template parameter values in a template parameter object. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Create an integration account map -``` -PS C:\>New-AzureRmIntegrationAccountMap -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -MapName "IntegrationAccountMap47" -MapDefinition $MapContent -Id : /subscriptions/<SusbcriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegartionAccount31/maps/IntegrationAccountMap47 -Name : IntegrationAccountMap47 -Type : Microsoft.Logic/integrationAccounts/maps -CreatedTime : 3/26/2016 7:12:22 PM -ChangedTime : 3/26/2016 7:12:22 PM -MapType : Xslt -ContentLink : https://<baseurl>/integrationaccounts68a13b6b49f14995ba7c5f3aedcbd7ad/99D1E_XSLT_INTEGRATIONACCOUNTMAP47-9C97D973088B4256A1893B - BCB1F85246?sv=2014-02-14&sr=b&sig=<value> -ContentSize : 3056 -Metadata : -``` - -This command creates the integration account map in the specified resource group. -The command specifies a map definition stored in the $MapContent variable by a previous command. - -## PARAMETERS - -### -ContentType -Specifies a content type for the integration account map. -This cmdlet supports application/xml as a map content type. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MapDefinition -Specifies a definition object for integration account map. -Specify either this parameter or the *MapFilePath* parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MapFilePath -Specifies the file path of a definition for the integration account map. -Specify either this parameter or the *MapDefinition* parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MapName -Specifies a name for the integration account map. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MapType -Specifies the type for the integration account map. -This cmdlet supports Xslt as a map type. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Xslt - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Metadata -Specifies a metadata object for the map. - -```yaml -Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the integration account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: IntegrationAccountName, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Logic.Models.IntegrationAccountMap - -## NOTES - -## RELATED LINKS - -[Get-AzureRmIntegrationAccountMap](./Get-AzureRmIntegrationAccountMap.md) - -[Remove-AzureRmIntegrationAccountMap](./Remove-AzureRmIntegrationAccountMap.md) - -[Set-AzureRmIntegrationAccountMap](./Set-AzureRmIntegrationAccountMap.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/New-AzureRmIntegrationAccountPartner.md b/azurermps-6.13.0/AzureRM.LogicApp/New-AzureRmIntegrationAccountPartner.md deleted file mode 100644 index eab6669ff6..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/New-AzureRmIntegrationAccountPartner.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: 2B5FC268-4888-4AEB-B125-7263CF2E4DCD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/new-azurermintegrationaccountpartner -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccountPartner.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccountPartner.md ---- - -# New-AzureRmIntegrationAccountPartner - -## SYNOPSIS -Creates an integration account partner. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmIntegrationAccountPartner -ResourceGroupName <String> -Name <String> -PartnerName <String> - [-PartnerType <String>] -BusinessIdentities <Object> [-Metadata <Object>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmIntegrationAccountPartner** cmdlet creates an integration account partner. -This cmdlet returns an object that represents the integration account partner. -Specify the integration account name, resource group name, partner name, and partner identities. -Template parameter file values that you specify at the command line take precedence over template parameter values in a template parameter object. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Create an integration account partner -``` -PS C:\>New-AzureRmIntegrationAccountPartner -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -PartnerName "IntegrationAccountPartner22" -PartnerType "B2B" -BusinessIdentities $BusinessIdentities -Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31/partners/IntegrationAccountPartner1 -Name : IntegrationAccountPartner1 -Type : Microsoft.Logic/integrationAccounts/partners -PartnerType : B2B -CreatedTime : 3/26/2016 7:29:30 PM -ChangedTime : 3/26/2016 7:29:30 PM -BusinessIdentities : [{"Qualifier":"ZZ","Value":"AA"},{"Qualifier":"XX","Value":"GG"}] -Metadata : -``` - -This command creates the integration account partner named IntegrationAccountPartner22 in the specified resource group. - -## PARAMETERS - -### -BusinessIdentities -Specifies business identities for the integration account partner. -Specify a hash table. - -```yaml -Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Metadata -Specifies a metadata object for the partner. - -```yaml -Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of an integration account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: IntegrationAccountName, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PartnerName -Specifies a name for the integration account partner. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PartnerType -Specifies the type of the integration account. -This parameter supports the type B2B. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: B2B - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Logic.Models.IntegrationAccountPartner - -## NOTES - -## RELATED LINKS - -[Get-AzureRmIntegrationAccountPartner](./Get-AzureRmIntegrationAccountPartner.md) - -[Remove-AzureRmIntegrationAccountPartner](./Remove-AzureRmIntegrationAccountPartner.md) - -[Set-AzureRmIntegrationAccountPartner](./Set-AzureRmIntegrationAccountPartner.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/New-AzureRmIntegrationAccountSchema.md b/azurermps-6.13.0/AzureRM.LogicApp/New-AzureRmIntegrationAccountSchema.md deleted file mode 100644 index 8ac8a89d7d..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/New-AzureRmIntegrationAccountSchema.md +++ /dev/null @@ -1,248 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: 91FFBEE9-A488-49ED-8C6C-2DE891CE0749 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/new-azurermintegrationaccountschema -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccountSchema.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccountSchema.md ---- - -# New-AzureRmIntegrationAccountSchema - -## SYNOPSIS -Creates an integration account schema. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmIntegrationAccountSchema -ResourceGroupName <String> -Name <String> -SchemaName <String> - [-SchemaFilePath <String>] [-SchemaDefinition <String>] [-SchemaType <String>] [-ContentType <String>] - [-Metadata <Object>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmIntegrationAccountSchema** cmdlet creates an integration account schema. -This cmdlet returns an object that represents the integration account schema. -Specify the integration account name, resource group name, schema name, and schema definition. -Template parameter file values that you specify at the command line take precedence over template parameter values in a template parameter object. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Create the integration account schema -``` -PS C:\>New-AzureRmIntegrationAccountSchema -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -SchemaName "IntegrationAccountSchema1" -SchemaFilePath "c:\temp\schema1" -Id : /subscriptions/<SusbcriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31/schemas/IntegrationAccountSchema1 -Name : IntegrationAccountSchema1 -Type : Microsoft.Logic/integrationAccounts/schemas -CreatedTime : 3/26/2016 7:21:10 PM -ChangedTime : 3/26/2016 7:21:10 PM -SchemaType : Xml -ContentLink : https://<baseurl>/integrationaccounts68a13b6b49f14995ba7c5f3aedcbd7ad/3839E_XML_INTEGRATIONACCOUNTSCHEMA2-5A6650B914454A2CAB16 - B4A8D3F9840D?sv=2014-02-14&sr=b&sig=<value> -ContentSize : 7901 -``` - -This command creates the integration account schema named IntegrationAccountSchema1 in the specified resource group. - -## PARAMETERS - -### -ContentType -Specifies a content type for the integration account schema. -This cmdlet supports application/xml as a map content type. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Metadata -Specifies a metadata object for the schema. - -```yaml -Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of an integration account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: IntegrationAccountName, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SchemaDefinition -Specifies a definition object for integration account schema. -Specify either this parameter or the *SchemaFilePath* parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SchemaFilePath -Specifies the file path of a definition for the integration account schema. -Specify either this parameter or the *SchemaDefinition* parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SchemaName -Specifies a name for the integration account schema. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SchemaType -Specifies the type for the integration account schema. -This parameter supports Xml as the type. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Xml - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Logic.Models.IntegrationAccountSchema - -## NOTES - -## RELATED LINKS - -[Get-AzureRmIntegrationAccountSchema](./Get-AzureRmIntegrationAccountSchema.md) - -[Remove-AzureRmIntegrationAccountSchema](./Remove-AzureRmIntegrationAccountSchema.md) - -[Set-AzureRmIntegrationAccountSchema](./Set-AzureRmIntegrationAccountSchema.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/New-AzureRmLogicApp.md b/azurermps-6.13.0/AzureRM.LogicApp/New-AzureRmLogicApp.md deleted file mode 100644 index f4c3d1c365..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/New-AzureRmLogicApp.md +++ /dev/null @@ -1,372 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: 8679240C-EA47-41C5-B8C1-A3C99547F42B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/new-azurermlogicapp -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmLogicApp.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmLogicApp.md ---- - -# New-AzureRmLogicApp - -## SYNOPSIS -Creates a logic app in a resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### LogicAppWithDefinitionParameterSet -``` -New-AzureRmLogicApp -ResourceGroupName <String> -Name <String> -Location <String> [-State <String>] - -Definition <Object> [-IntegrationAccountId <String>] [-Parameters <Object>] [-ParameterFilePath <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### LogicAppWithDefinitionFileParameterSet -``` -New-AzureRmLogicApp -ResourceGroupName <String> -Name <String> -Location <String> [-State <String>] - -DefinitionFilePath <String> [-IntegrationAccountId <String>] [-Parameters <Object>] - [-ParameterFilePath <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmLogicApp** cmdlet creates a logic app by using the Logic Apps feature. -A logic app is a collection of actions or triggers defined in Logic App definition. -This cmdlet returns a **Workflow** object. -You can create a logic app by specifying a name, location, Logic App definition, resource group, and plan. -A Logic App definition and parameters are formatted in JavaScript Object Notation (JSON). -You can use a logic app as a template for definition and parameters. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. -Template parameter file values that you specify at the command line take precedence over template parameter values in a template parameter object. - -## EXAMPLES - -### Example 1: Create a logic app by using definition and parameter file paths -``` -PS C:\>New-AzureRmLogicApp -ResourceGroupName "ResourceGroup11" -Name "LogicApp03" -State "Enabled" -AppServicePlan "ServicePlan01" -DefinitionFilePath "d:\workflows\Definition03.json" -ParameterFilePath "d:\workflows\Parameters03.json" -Id : /subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourceGroups/LogicAppCmdletTest/providers/Microsoft.Logic/workflows/LogicApp03 -Name : LogicApp03 -Type : Microsoft.Logic/workflows -Location : westus -ChangedTime : 1/13/2016 2:41:39 PM -CreatedTime : 1/13/2016 2:41:39 PM -AccessEndpoint : https://westus.logic.azure.com:443/subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourcegroups/ResourceGroup1/providers/Microsoft.Logic/workflows/LogicApp1 -State : Enabled -DefinitionLinkUri : -DefinitionLinkContentVersion : -Definition : {$schema, contentVersion, parameters, triggers...} -ParametersLinkUri : -ParametersLinkContentVersion : -Parameters : {[destinationUri, Microsoft.Azure.Management.Logic.Models.WorkflowParameter]} -SkuName : Standard -PlanName : ServicePlan01 -PlanType : Microsoft.Web/ServerFarms -PlanId : /subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourceGroups/ResourceGroup11/providers/Microsoft.Web/serverfarms/ServicePlan1 -Version : 08587489107859952120 -``` - -This command creates a logic app in the specified resource group. -The logic app includes the definition and parameters specified by file paths. - -### Example 2: Create a logic app by using definition and parameter objects -``` -PS C:\>New-AzureRmLogicApp -ResourceGroupName "ResourceGroup11" -Name "LogicApp05" -Location "westus" -State "Enabled" -AppServicePlan "ServicePlan01" -Definition [IO.File]::ReadAllText("d:\Workflows\Definition.json") -Parameters @{name1="value1", name2="value2"} -Id : /subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourceGroups/LogicAppCmdletTest/providers/Microsoft.Logic/workflows/LogicApp05 -Name : LogicApp05 -Type : Microsoft.Logic/workflows -Location : westus -ChangedTime : 1/13/2016 2:41:39 PM -CreatedTime : 1/13/2016 2:41:39 PM -AccessEndpoint : https://westus.logic.azure.com:443/subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourcegroups/ResourceGroup11/providers/Microsoft.Logic/workflows/LogicApp05 -State : Enabled -DefinitionLinkUri : -DefinitionLinkContentVersion : -Definition : {$schema, contentVersion, parameters, triggers...} -ParametersLinkUri : -ParametersLinkContentVersion : -Parameters : {[destinationUri, Microsoft.Azure.Management.Logic.Models.WorkflowParameter]} -SkuName : Standard -PlanName : ServicePlan1 -PlanType : Microsoft.Web/ServerFarms -PlanId : /subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourceGroups/ResourceGroup11/providers/Microsoft.Web/serverfarms/ServicePlan1 -Version : 08587489107859952120 -``` - -This command creates a logic app in the specified resource group resource group. - -### Example 3: Create a logic app by using the pipeline to specify the resource group -``` -PS C:\>Get-AzureRmResourceGroup -ResourceGroupName "ResourceGroup11" | New-AzureRmLogicApp -Name "LogicApp11" -State "Enabled" -AppServicePlan "ServicePlan01" -DefinitionFilePath "d:\Workflow\Definition.json" -ParameterFilePath "d:\Workflow\Parameters.json" -Id : /subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourceGroups/LogicAppCmdletTest/providers/Microsoft.Logic/workflows/LogicApp11 -Name : LogicApp11 -Type : Microsoft.Logic/workflows -Location : westus -ChangedTime : 1/13/2016 2:41:39 PM -CreatedTime : 1/13/2016 2:41:39 PM -AccessEndpoint : https://westus.logic.azure.com:443/subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourcegroups/ResourceGroup11/providers/Microsoft.Logic/workflows/LogicApp11 -State : Enabled -DefinitionLinkUri : -DefinitionLinkContentVersion : -Definition : {$schema, contentVersion, parameters, triggers...} -ParametersLinkUri : -ParametersLinkContentVersion : -Parameters : {[destinationUri, Microsoft.Azure.Management.Logic.Models.WorkflowParameter]} -SkuName : Standard -PlanName : ServicePlan01 -PlanType : Microsoft.Web/ServerFarms -PlanId : /subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourceGroups/ResourceGroup11/providers/Microsoft.Web/serverfarms/ServicePlan01 -Version : 08587489107859952120 -``` - -This command gets the resource group named ResourceGroup11 by using the Get-AzureRmResourceGroup cmdlet. -The command passes that resource group to the current cmdlet by using the pipeline operator. -The current cmdlet creates a logic app in that resource group. -The logic app includes the definition and parameters specified by file paths. - -### Example 4: Create a logic app based on an existing logic app -``` -PS C:\>$Workflow = Get-AzureRmLogicApp -ResourceGroupName "ResourceGroup11" -Name "LogicApp03" -PS C:\> New-AzureRmLogicApp -ResourceGroupName "ResourceGroup11" -Name "LogicApp13" -State "Enabled" -AppServicePlan "ServicePlan01" -Definition $Workflow.Definition -Parameters $Workflow.Parameters -Id : /subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourceGroups/LogicAppCmdletTest/providers/Microsoft.Logic/workflows/LogicApp13 -Name : LogicApp13 -Type : Microsoft.Logic/workflows -Location : westus -ChangedTime : 1/13/2016 2:41:39 PM -CreatedTime : 1/13/2016 2:41:39 PM -AccessEndpoint : https://westus.logic.azure.com:443/subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourcegroups/ResourceGroup11/providers/Microsoft.Logic/workflows/LogicApp13 -State : Enabled -DefinitionLinkUri : -DefinitionLinkContentVersion : -Definition : {$schema, contentVersion, parameters, triggers...} -ParametersLinkUri : -ParametersLinkContentVersion : -Parameters : {[destinationUri, Microsoft.Azure.Management.Logic.Models.WorkflowParameter]} -SkuName : Standard -PlanName : ServicePlan01 -PlanType : Microsoft.Web/ServerFarms -PlanId : /subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourceGroups/ResourceGroup11/providers/Microsoft.Web/serverfarms/ServicePlan01 -Version : 08587489107859952120 -``` - -The first command gets the logic app named LogicApp03 by using the Get-AzureRmLogicApp cmdlet. -The command stores the logic app in the $Workflow variable. -The second command creates a new logic app that uses the definition and parameters of the logic app stored in $Workflow. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Definition -Specifies the definition for your logic app as an object or a string in JavaScript Object Notataion (JSON) format. - -```yaml -Type: System.Object -Parameter Sets: LogicAppWithDefinitionParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefinitionFilePath -Specifies the definition of a logic app as the path of a definition file in JSON format. - -```yaml -Type: System.String -Parameter Sets: LogicAppWithDefinitionFileParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IntegrationAccountId -Specifies an integration account ID for the logic app. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the logic app. -Enter an Azure data center location, such as West US or Southeast Asia. -You can place a logic app in any location. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name for the logic app. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParameterFilePath -Specifies the path of a JSON formatted parameter file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Parameters -Specifies a parameters collection object for the Logic App. -Specify a hash table, Dictionary\<string\>, or Dictionary\<string, WorkflowParameter\>. - -```yaml -Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -Specifies the state of the logic app. -The acceptable values for this parameter are: Enabled and Disabled. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLogicApp](./Get-AzureRmLogicApp.md) - -[Remove-AzureRmLogicApp](./Remove-AzureRmLogicApp.md) - -[Set-AzureRmLogicApp](./Set-AzureRmLogicApp.md) - -[Start-AzureRmLogicApp](./Start-AzureRmLogicApp.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Remove-AzureRmIntegrationAccount.md b/azurermps-6.13.0/AzureRM.LogicApp/Remove-AzureRmIntegrationAccount.md deleted file mode 100644 index 6f33169ad1..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Remove-AzureRmIntegrationAccount.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: 607FBE75-727D-4388-9504-94AD31BCDBBF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/remove-azurermintegrationaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccount.md ---- - -# Remove-AzureRmIntegrationAccount - -## SYNOPSIS -Removes an integration account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmIntegrationAccount -ResourceGroupName <String> -Name <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmIntegrationAccount** cmdlet removes an integration account from a resource group. -Specify the integration account name and resource group name. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Remove an integration account -``` -PS C:\>Remove-AzureRmIntegrationAccount -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -Force -``` - -This command removes an integration account named IntegrationAccount31. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the integration account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: IntegrationAccountName, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[New-AzureRmIntegrationAccount](./New-AzureRmIntegrationAccount.md) - -[Set-AzureRmIntegrationAccount](./Set-AzureRmIntegrationAccount.md) - -[Get-AzureRmIntegrationAccount](./Get-AzureRmIntegrationAccount.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Remove-AzureRmIntegrationAccountAgreement.md b/azurermps-6.13.0/AzureRM.LogicApp/Remove-AzureRmIntegrationAccountAgreement.md deleted file mode 100644 index 602756f84a..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Remove-AzureRmIntegrationAccountAgreement.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: EBDBB9F0-CA2E-4E4F-9034-3D0FAB88E442 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/remove-azurermintegrationaccountagreement -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountAgreement.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountAgreement.md ---- - -# Remove-AzureRmIntegrationAccountAgreement - -## SYNOPSIS -Removes an integration account agreement. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmIntegrationAccountAgreement -ResourceGroupName <String> -Name <String> -AgreementName <String> - [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmIntegrationAccountAgreement** cmdlet removes an integration account agreement from an Azure resource group. -Specify the integration account name, resource group name, and agreement name. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Remove an integration account agreement by name -``` -PS C:\>Remove-AzureRmIntegrationAccountAgreement -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -AgreementName "IntegrationAccountAgreement06" -Force -``` - -This command removes the integration account agreement named IntegrationAccountAgreement06. -The command does not prompt you for confirmation. - -## PARAMETERS - -### -AgreementName -Specifies the name of the integration account agreement. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of an integration account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: IntegrationAccountName, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmIntegrationAccountAgreement](./Get-AzureRmIntegrationAccountAgreement.md) - -[New-AzureRmIntegrationAccountAgreement](./New-AzureRmIntegrationAccountAgreement.md) - -[Set-AzureRmIntegrationAccountAgreement](./Set-AzureRmIntegrationAccountAgreement.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Remove-AzureRmIntegrationAccountCertificate.md b/azurermps-6.13.0/AzureRM.LogicApp/Remove-AzureRmIntegrationAccountCertificate.md deleted file mode 100644 index c73357c690..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Remove-AzureRmIntegrationAccountCertificate.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: F9871519-F470-470C-8CCE-A674B6B5A3EE -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/remove-azurermintegrationaccountcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountCertificate.md ---- - -# Remove-AzureRmIntegrationAccountCertificate - -## SYNOPSIS -Removes an integration account certificate from a resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmIntegrationAccountCertificate -ResourceGroupName <String> -Name <String> - -CertificateName <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmIntegrationAccountCertificate** cmdlet removes an integration account certificate from a resource group. -Specify the integration account name, resource group name, and certificate name. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Remove an integration account certificate -``` -PS C:\>Remove-AzureRmIntegrationAccountCertificate -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -CertificateName "IntegrationAccountCertificate01" -``` - -This command removes the integration account certificate named IntegrationAccount31. - -## PARAMETERS - -### -CertificateName -Specifies the name of an integration account certificate. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of an integration account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: IntegrationAccountName, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmIntegrationAccountCertificate](./Get-AzureRmIntegrationAccountCertificate.md) - -[New-AzureRmIntegrationAccountCertificate](./New-AzureRmIntegrationAccountCertificate.md) - -[Set-AzureRmIntegrationAccountCertificate](./Set-AzureRmIntegrationAccountCertificate.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Remove-AzureRmIntegrationAccountMap.md b/azurermps-6.13.0/AzureRM.LogicApp/Remove-AzureRmIntegrationAccountMap.md deleted file mode 100644 index 2e04fba98d..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Remove-AzureRmIntegrationAccountMap.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: 7AAF2ACC-84ED-449C-B1E8-F074463F44EB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/remove-azurermintegrationaccountmap -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountMap.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountMap.md ---- - -# Remove-AzureRmIntegrationAccountMap - -## SYNOPSIS -Removes an integration account map. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmIntegrationAccountMap -ResourceGroupName <String> -Name <String> -MapName <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmIntegrationAccountMap** cmdlet removes an integration account map from a resource group. -Specify the integration account name, resource group name, and map name. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Remove an integration account map -``` -PS C:\>Remove-AzureRmIntegrationAccountMap -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -MapName "IntegrationAccountMap47" -``` - -This command removes the integration account map named IntegrationAccountMap47. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MapName -Specifies the name of the integration account map. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the integration account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: IntegrationAccountName, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmIntegrationAccountMap](./Get-AzureRmIntegrationAccountMap.md) - -[New-AzureRmIntegrationAccountMap](./New-AzureRmIntegrationAccountMap.md) - -[Set-AzureRmIntegrationAccountMap](./Set-AzureRmIntegrationAccountMap.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Remove-AzureRmIntegrationAccountPartner.md b/azurermps-6.13.0/AzureRM.LogicApp/Remove-AzureRmIntegrationAccountPartner.md deleted file mode 100644 index f36e710825..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Remove-AzureRmIntegrationAccountPartner.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: E8A557EA-FE3F-4433-BFDE-B4D73DF8467C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/remove-azurermintegrationaccountpartner -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountPartner.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountPartner.md ---- - -# Remove-AzureRmIntegrationAccountPartner - -## SYNOPSIS -Removes an integration account partner. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmIntegrationAccountPartner -ResourceGroupName <String> -Name <String> -PartnerName <String> - [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmIntegrationAccountPartner** cmdlet removes an integration account partner from a resource group. -Specify the integration account name, resource group name, and partner name. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Remove an integration account partner -``` -PS C:\>Remove-AzureRmIntegrationAccountPartner -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -PartnerName "IntegrationAccountPartner1" -``` - -This command removes the integration account partner named IntegrationAccountPartner1. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of an integration account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: IntegrationAccountName, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PartnerName -Specifies the name of the integration account partner. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmIntegrationAccountPartner](./Get-AzureRmIntegrationAccountPartner.md) - -[New-AzureRmIntegrationAccountPartner](./New-AzureRmIntegrationAccountPartner.md) - -[Set-AzureRmIntegrationAccountPartner](./Set-AzureRmIntegrationAccountPartner.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Remove-AzureRmIntegrationAccountReceivedIcn.md b/azurermps-6.13.0/AzureRM.LogicApp/Remove-AzureRmIntegrationAccountReceivedIcn.md deleted file mode 100644 index adbef1be6a..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Remove-AzureRmIntegrationAccountReceivedIcn.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/remove-azurermintegrationaccountreceivedicn -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountReceivedIcn.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountReceivedIcn.md ---- - -# Remove-AzureRmIntegrationAccountReceivedIcn - -## SYNOPSIS -This cmdlet removes a specific received interchange control number per agreement and control number value. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmIntegrationAccountReceivedIcn -ResourceGroupName <String> -Name <String> -AgreementName <String> - -ControlNumberValue <String> [-AgreementType <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet is meant to be used in disaster recovery scenarios to remove a received interchange control number from the integration account so that the B2B connector may process again the message when duplicate number detection is enabled. -In rare occasions the received interchange control number may be reserved shortly before a disaster and before the B2B connector rejects the interchange as erroneous. -In such occasions the operation may want to enable the recovery site to process again the same interchange after its payload is corrected. -Please do provide the "-AgreementType" parameter to specify whether X12 or Edifact control numbers to return - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmIntegrationAccountReceivedIcn -AgreementType "X12" -ResourceGroupName "groupName" -Name "accountName" -AgreementName "X12AgreementName" -ControlNumberValue "000000641" -Get-AzureRmIntegrationAccountReceivedIcn : The existing recevied control number '000000641' for agreement 'X12AgreementName' is not in a valid format. -At line:1 char:1 -+ Get-AzureRmIntegrationAccountReceivedIcn -ResourceGroupName "groupName ... -+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - + CategoryInfo : CloseError: (:) [Get-AzureRmIntegrationAccountReceivedIcn], PSInvalidOperationException - + FullyQualifiedErrorId : Microsoft.Azure.Commands.LogicApp.Cmdlets.GetAzureIntegrationAccountReceivedIcnCommand - -PS C:\> Remove-AzureRmIntegrationAccountReceivedIcn -AgreementType "X12" -ResourceGroupName "groupName" -Name "accountName" -AgreementName "X12AgreementName" -ControlNumberValue "000000641" -PS C:\> Get-AzureRmIntegrationAccountReceivedIcn -AgreementType "X12" -ResourceGroupName "groupName" -Name "accountName" -AgreementName "X12AgreementName" -ControlNumberValue "000000641" -Get-AzureRmIntegrationAccountReceivedIcn : The session 'X12-ICN-X12AgreementName-000000641' could not be found in integration account 'accountName'. -At line:1 char:1 -+ Get-AzureRmIntegrationAccountReceivedIcn -ResourceGroupName "groupName ... -+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - + CategoryInfo : CloseError: (:) [Get-AzureRmIntegrationAccountReceivedIcn], CloudException - + FullyQualifiedErrorId : Microsoft.Azure.Commands.LogicApp.Cmdlets.GetAzureIntegrationAccountReceivedIcnCommand -``` - -Attempts to get a received X12 interchange control number which content is not in a valid format. -Removes the received X12 interchange control number. -Confirms the received X12 interchange control number was removed by attempting to get it again. - -### Example 2 -``` -PS C:\> Get-AzureRmIntegrationAccountReceivedIcn -AgreementType "Edifact" -ResourceGroupName "groupName" -Name "accountName" -AgreementName "EdifactAgreementName" -ControlNumberValue "000000641" -Get-AzureRmIntegrationAccountReceivedIcn : The existing recevied control number '000000641' for agreement 'EdifactAgreementName' is not in a valid format. -At line:1 char:1 -+ Get-AzureRmIntegrationAccountReceivedIcn -ResourceGroupName "groupName ... -+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - + CategoryInfo : CloseError: (:) [Get-AzureRmIntegrationAccountReceivedIcn], PSInvalidOperationException - + FullyQualifiedErrorId : Microsoft.Azure.Commands.LogicApp.Cmdlets.GetAzureIntegrationAccountReceivedIcnCommand - -PS C:\> Remove-AzureRmIntegrationAccountReceivedIcn -AgreementType "Edifact" -ResourceGroupName "groupName" -Name "accountName" -AgreementName "EdifactAgreementName" -ControlNumberValue "000000641" -PS C:\> Get-AzureRmIntegrationAccountReceivedIcn -AgreementType "Edifact" -ResourceGroupName "groupName" -Name "accountName" -AgreementName "EdifactAgreementName" -ControlNumberValue "000000641" -Get-AzureRmIntegrationAccountReceivedIcn : The session 'Edifact-ICN-EdifactAgreementName-000000641' could not be found in integration account 'accountName'. -At line:1 char:1 -+ Get-AzureRmIntegrationAccountReceivedIcn -ResourceGroupName "groupName ... -+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - + CategoryInfo : CloseError: (:) [Get-AzureRmIntegrationAccountReceivedIcn], CloudException - + FullyQualifiedErrorId : Microsoft.Azure.Commands.LogicApp.Cmdlets.GetAzureIntegrationAccountReceivedIcnCommand -``` - -Attempts to get a received Edifact interchange control number which content is not in a valid format. -Removes the received Edifact interchange control number. -Confirms the received Edifact interchange control number was removed by attempting to get it again. - -## PARAMETERS - -### -AgreementName -The integration account agreement name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AgreementType -The integration account agreement type. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: MessageType -Accepted values: X12, Edifact - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ControlNumberValue -The integration account control number value. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The integration account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: IntegrationAccountName, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The integration account resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmIntegrationAccountReceivedIcn](./Get-AzureRmIntegrationAccountReceivedIcn.md) -[Set-AzureRmIntegrationAccountReceivedIcn](./Set-AzureRmIntegrationAccountReceivedIcn.md) - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Remove-AzureRmIntegrationAccountSchema.md b/azurermps-6.13.0/AzureRM.LogicApp/Remove-AzureRmIntegrationAccountSchema.md deleted file mode 100644 index a9b1975e2b..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Remove-AzureRmIntegrationAccountSchema.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: 56550997-21D9-4F85-B23A-677625482547 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/remove-azurermintegrationaccountschema -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountSchema.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountSchema.md ---- - -# Remove-AzureRmIntegrationAccountSchema - -## SYNOPSIS -Removes an integration account schema. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmIntegrationAccountSchema -ResourceGroupName <String> -Name <String> -SchemaName <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmIntegrationAccountSchema** cmdlet removes an integration account schema from a resource group. -Specifying the integration account name, resource group name, and schema name. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Remove an integration account schema -``` -PS C:\>Remove-AzureRmIntegrationAccountSchema -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -SchemaName "IntegrationAccountSchema43" -``` - -This command removes an integration account schema named IntegrationAccountSchema43. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the integration account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: IntegrationAccountName, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SchemaName -Specifies the name of an integration account schema. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmIntegrationAccountSchema](./Get-AzureRmIntegrationAccountSchema.md) - -[New-AzureRmIntegrationAccountSchema](./New-AzureRmIntegrationAccountSchema.md) - -[Set-AzureRmIntegrationAccountSchema](./Set-AzureRmIntegrationAccountSchema.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Remove-AzureRmLogicApp.md b/azurermps-6.13.0/AzureRM.LogicApp/Remove-AzureRmLogicApp.md deleted file mode 100644 index ea89fb6f26..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Remove-AzureRmLogicApp.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: 39D1576D-7042-4A62-AB41-0B5131C150D5 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/remove-azurermlogicapp -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmLogicApp.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmLogicApp.md ---- - -# Remove-AzureRmLogicApp - -## SYNOPSIS -Removes a logic app from a resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmLogicApp -ResourceGroupName <String> -Name <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmLogicApp** cmdlet removes a logic app from a resource group by using the Logic Apps feature. -Specify the logic app and resource group. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Remove a logic app -``` -PS C:\>Remove-AzureRmLogicApp -ResourceGroupName "ResourceGroup11" -Name "LogicApp03" -Force -``` - -This command removes a logic app from a resource group. -The command includes the *Force* parameter, which prevents the command from prompting you for confirmation. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the logic app that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the logic app that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLogicApp](./Get-AzureRmLogicApp.md) - -[New-AzureRmLogicApp](./New-AzureRmLogicApp.md) - -[Set-AzureRmLogicApp](./Set-AzureRmLogicApp.md) - -[Start-AzureRmLogicApp](./Start-AzureRmLogicApp.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmIntegrationAccount.md b/azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmIntegrationAccount.md deleted file mode 100644 index 36cfa6e9d3..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmIntegrationAccount.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: F6D9EA59-BA61-4117-8771-9B190424BFF8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/set-azurermintegrationaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccount.md ---- - -# Set-AzureRmIntegrationAccount - -## SYNOPSIS -Modifies an integration account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmIntegrationAccount -ResourceGroupName <String> -Name <String> [-Location <String>] [-Sku <String>] - [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmIntegrationAccount** cmdlet modifies an integration account. -This cmdlet returns an object that represents the integration account. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Modify an integration account -``` -PS C:\>Set-AzureRmIntegrationAccount -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -Sku "Free" -Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31 -Name : IntegrationAccount31 -Type : Microsoft.Logic/integrationAccounts -Location : brazilsouth -Sku : -CreatedTime : 3/26/2016 4:26:07 PM -ChangedTime : 3/26/2016 4:26:07 PM -``` - -This command modifies an integration account named IntegrationAccount31 in the specified resource group. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies a location for the integration account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the integration account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: IntegrationAccountName, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -Specifies a SKU name for the integration account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Logic.Models.IntegrationAccount - -## NOTES - -## RELATED LINKS - -[Get-AzureRmIntegrationAccount](./Get-AzureRmIntegrationAccount.md) - -[New-AzureRmIntegrationAccount](./New-AzureRmIntegrationAccount.md) - -[Remove-AzureRmIntegrationAccount](./Remove-AzureRmIntegrationAccount.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmIntegrationAccountAgreement.md b/azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmIntegrationAccountAgreement.md deleted file mode 100644 index cbaa24cad5..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmIntegrationAccountAgreement.md +++ /dev/null @@ -1,347 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: 5FDD6C6A-9F6A-44C3-B332-B528F648DFDB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/set-azurermintegrationaccountagreement -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountAgreement.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountAgreement.md ---- - -# Set-AzureRmIntegrationAccountAgreement - -## SYNOPSIS -Modifies an integration account agreement. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmIntegrationAccountAgreement -ResourceGroupName <String> -Name <String> -AgreementName <String> - [-AgreementType <String>] [-GuestPartner <String>] [-HostPartner <String>] [-GuestIdentityQualifier <String>] - [-GuestIdentityQualifierValue <String>] [-HostIdentityQualifier <String>] - [-HostIdentityQualifierValue <String>] [-AgreementContent <String>] [-AgreementContentFilePath <String>] - [-Metadata <Object>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmIntegrationAccountAgreement** cmdlet modifies an integration account agreement. -This cmdlet returns an object that represents the integration account agreement. -Specify the integration account name, resource group name, and agreement name. -Template parameter file values that you specify at the command line take precedence over template parameter values in a template parameter object. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Update an integration account agreement -``` -PS C:\>Set-AzureRmIntegrationAccountAgreement -Name "IntegrationAccount31"-ResourceGroupName "ResourceGroup11" -AgreementName "IntegrationAccountAgreement06" -AgreementType "X12" -GuestPartner "GuestPartner" -HostPartner "HostPartner" -GuestIdentityQualifier "BB" -HostIdentityQualifier "AA" -AgreementContentFilePath "C:\temp\AgreementContent.json" -Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31/agreements/IntegrationAccountAgreement06 -Name : IntegrationAccountAgreement06 -Type : Microsoft.Logic/integrationAccounts/agreements -CreatedTime : 3/26/2016 6:43:52 PM -ChangedTime : 3/26/2016 6:43:52 PM -AgreementType : X12 -HostPartner : HostPartner -GuestPartner : GuestPartner -HostIdentityQualifier : AA -HostIdentityValue : AA -GuestIdentityQualifier : BB -GuestIdentityValue : BB -Content : {"AS2":null,"X12":{"ReceiveAgreement":{"SenderBusinessIdentity":{"Qualifier":"AA","Value":"AA"},"ReceiverBusinessIdentity":{"Qualifier":"ZZ","Valu - e":"ZZ"},"ProtocolSettings":{"ValidationSettings":{"ValidateCharacterSet":true,"CheckDuplicateInterchangeControlNumber":false,"InterchangeControlN - . . . -``` - -This command updates an integration account agreement in the specified Azure resource group. - -## PARAMETERS - -### -AgreementContent -Specifies agreement content, in JavaScript Object Notation (JSON) format, for the agreement. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AgreementContentFilePath -Specifies the file path of agreement content for the agreement. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AgreementName -Specifies the name of the integration account agreement. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AgreementType -Specifies the integration account agreement type. -The acceptable values for this parameter are: -- X12 -- AS2 -- Edifact - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: X12, AS2, Edifact - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GuestIdentityQualifier -Specifies a name business identity qualifier for the guest partner. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GuestIdentityQualifierValue -The integration account agreement guest identity qualifier value. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GuestPartner -Specifies the name of the guest partner. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostIdentityQualifier -Specifies a name business identity qualifier for the host partner. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostIdentityQualifierValue -The integration account agreement host identity qualifier value. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostPartner -Specifies the name of the host partner. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Metadata -Specifies a metadata object for the agreement. - -```yaml -Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of an integration account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: IntegrationAccountName, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Logic.Models.IntegrationAccountAgreement - -## NOTES - -## RELATED LINKS - -[Get-AzureRmIntegrationAccountAgreement](./Get-AzureRmIntegrationAccountAgreement.md) - -[New-AzureRmIntegrationAccountAgreement](./New-AzureRmIntegrationAccountAgreement.md) - -[Remove-AzureRmIntegrationAccountAgreement](./Remove-AzureRmIntegrationAccountAgreement.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmIntegrationAccountCertificate.md b/azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmIntegrationAccountCertificate.md deleted file mode 100644 index 645e4f7091..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmIntegrationAccountCertificate.md +++ /dev/null @@ -1,261 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: D9CA9515-5C19-4D63-8D4D-0B288E9309E9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/set-azurermintegrationaccountcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountCertificate.md ---- - -# Set-AzureRmIntegrationAccountCertificate - -## SYNOPSIS -Modifies an integration account certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmIntegrationAccountCertificate -ResourceGroupName <String> -Name <String> -CertificateName <String> - [-KeyName <String>] [-KeyVersion <String>] [-KeyVaultId <String>] [-PublicCertificateFilePath <String>] - [-Metadata <Object>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmIntegrationAccountCertificate** cmdlet modifies an integration account certificate. -This cmdlet returns an object that represents the integration account certificate. -Specifying the integration account name, resource group name, and certificate name. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Modify an integration account certificate -``` -PS C:\>Set-AzureRmIntegrationAccountCertificate -ResourceGroupName "ResourceGroup11" -Name "IntegartionAccount31" -CertificateName "IntegrationAccountCertificate01" -KeyName "TestKey" -KeyVersion "1.0" -KeyVaultId "/subscriptions/<subscriptionId>/resourcegroups/ResourceGroup11/providers/microsoft.keyvault/vaults/keyvault" -PublicCertificateFilePath "c:\temp\Certificate.cer" -Id : /subscriptions/<SusbcriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegartionAccount31/certificates/IntegrationAccountCertificate01 -Name : IntegrationAccountCertificate01 -Type : Microsoft.Logic/integrationAccounts/certificates -CreatedTime : 3/26/2016 6:59:07 PM -ChangedTime : 3/26/2016 6:59:07 PM -KeyName : TestKey -KeyVersion : 1.0 -KeyVaultId : /subscriptions/<SusbcriptionId/resourcegroups/ResourceGroup11/providers/microsoft.keyvault/vaults/testkeyvault -KeyVaultName : testkeyvault -KeyVaultName : testkeyvault -PublicCertificate : -MetaData : -``` - -This command modifies the integration account certificate in the specified resource group. - -## PARAMETERS - -### -CertificateName -Specifies the name of an integration account certificate. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyName -Specifies the name of a certificate key in the key vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyVaultId -Specifies a key vault ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyVersion -Specifies the version of the certificate key in the key vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Metadata -Specifies a metadata object for the certificate. - -```yaml -Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the integration account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: IntegrationAccountName, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublicCertificateFilePath -Specifies the path of a public certificate (.cer) file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Logic.Models.IntegrationAccountCertificate - -## NOTES - -## RELATED LINKS - -[Get-AzureRmIntegrationAccountCertificate](./Get-AzureRmIntegrationAccountCertificate.md) - -[New-AzureRmIntegrationAccountCertificate](./New-AzureRmIntegrationAccountCertificate.md) - -[Remove-AzureRmIntegrationAccountCertificate](./Remove-AzureRmIntegrationAccountCertificate.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmIntegrationAccountGeneratedIcn.md b/azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmIntegrationAccountGeneratedIcn.md deleted file mode 100644 index bda1bd52c5..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmIntegrationAccountGeneratedIcn.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/set-azurermintegrationaccountgeneratedicn -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountGeneratedIcn.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountGeneratedIcn.md ---- - -# Set-AzureRmIntegrationAccountGeneratedIcn - -## SYNOPSIS -Updates the integration account generated interchange control number (ICN) in the Azure resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmIntegrationAccountGeneratedIcn -ResourceGroupName <String> -Name <String> -AgreementName <String> - -ControlNumber <String> [-AgreementType <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Set-AzureRmIntegrationAccountGeneratedIcn cmdlet updates an existing integration account generated interchange control number (ICN) and returns an object that represents the integration account generated interchange control number. -Use this cmdlet to update an integration account generated interchange control number. -You can update an integration account generated interchange control number by specifying the integration account name, resource group name and agreement name. -You cannot create a new integration account generated interchange control number with this command. -To use the dynamic parameters, just type them in the command, or type a hyphen sign(-) to indicate a parameter name and then press the TAB key repeatedly to cycle through the available parameters. -If you miss a required template parameter, the cmdlet prompts you for the value. -Template parameter file values that you specify at the command line take precedence over template parameter values in a template parameter object. -Please do provide the "-AgreementType" parameter to specify whether X12 or Edifact control numbers to return - -## EXAMPLES - -### Example 1 -``` -PS C:\> $resourceGroup.ResourceGroupName = "ResourceGroup1" -PS C:\> $integrationAccountName = "IntegrationAccount1" -PS C:\> $integrationAccountAgreementName = "X12IntegrationAccountAgreement" -PS C:\> $initialControlNumber = Get-AzureRmIntegrationAccountGeneratedIcn -AgreementType X12 -ResourceGroupName $resourceGroup.ResourceGroupName -Name $integrationAccountName -AgreementName $integrationAccountAgreementName -PS C:\> $incrementedControlNumberValue = [convert]::ToString([convert]::ToInt32($initialControlNumber.ControlNumber, 10) + 100, 10) -PS C:\> Set-AzureRmIntegrationAccountGeneratedIcn -ResourceGroupName $resourceGroup.ResourceGroupName -Name $integrationAccountName -AgreementName $integrationAccountAgreementName -ControlNumber $incrementedControlNumberValue -ControlNumber : 1100 -ControlNumberChangedTime : 2/15/2017 12:36:00 AM -IsMessageProcessingFailed: -``` - -This command gets the integration account generated X12 interchange control number for a specific integration account agreement, increase its value by 100 then writes back the updated value. - -### Example 2 -``` -PS C:\> $resourceGroup.ResourceGroupName = "ResourceGroup1" -PS C:\> $integrationAccountName = "IntegrationAccount1" -PS C:\> $integrationAccountAgreementName = "EdifactIntegrationAccountAgreement" -PS C:\> $initialControlNumber = Get-AzureRmIntegrationAccountGeneratedIcn -AgreementType EdifactIntegrationAccountAgreement -ResourceGroupName $resourceGroup.ResourceGroupName -Name $integrationAccountName -AgreementName $integrationAccountAgreementName -PS C:\> $incrementedControlNumberValue = [convert]::ToString([convert]::ToInt32($initialControlNumber.ControlNumber, 10) + 100, 10) -PS C:\> Set-AzureRmIntegrationAccountGeneratedIcn -ResourceGroupName $resourceGroup.ResourceGroupName -Name $integrationAccountName -AgreementName $integrationAccountAgreementName -ControlNumber $incrementedControlNumberValue -ControlNumber : 1100 -ControlNumberChangedTime : 2/15/2017 12:36:00 AM -IsMessageProcessingFailed: -``` - -This command gets the integration account generated EdifactIntegrationAccountAgreement interchange control number for a specific integration account agreement, increase its value by 100 then writes back the updated value. - -## PARAMETERS - -### -AgreementName -The integration account agreement name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AgreementType -The integration account agreement type. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: MessageType -Accepted values: X12, Edifact - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ControlNumber -The generated control number new value. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The integration account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The integration account resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.LogicApp.Utilities.IntegrationAccountControlNumber - -## NOTES - -## RELATED LINKS - -[Get-AzureRmIntegrationAccountGeneratedIcn](./Get-AzureRmIntegrationAccountGeneratedIcn.md) - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmIntegrationAccountMap.md b/azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmIntegrationAccountMap.md deleted file mode 100644 index 332aad7db9..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmIntegrationAccountMap.md +++ /dev/null @@ -1,263 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: 7EF87BE5-FB10-4E5D-A12F-7F50EE6DAD57 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/set-azurermintegrationaccountmap -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountMap.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountMap.md ---- - -# Set-AzureRmIntegrationAccountMap - -## SYNOPSIS -Modifies an integration account map. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmIntegrationAccountMap -ResourceGroupName <String> -Name <String> -MapName <String> - [-MapFilePath <String>] [-MapDefinition <String>] [-MapType <String>] [-ContentType <String>] - [-Metadata <Object>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmIntegrationAccountMap** cmdlet modifies an integration account map. -This cmdlet returns an object that represents the integration account map. -Specify the integration account name, resource group name, and map name. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Modify an integration account map -``` -PS C:\>Set-AzureRmIntegrationAccountMap -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -MapName "IntegrationAccountMap47" -MapDefinition $MapContent -Id : /subscriptions/<SusbcriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegartionAccount31/maps/IntegrationAccountMap47 -Name : IntegrationAccountMap47 -Type : Microsoft.Logic/integrationAccounts/maps -CreatedTime : 3/26/2016 7:12:22 PM -ChangedTime : 3/26/2016 7:12:22 PM -MapType : Xslt -ContentLink : https://<baseurl>/integrationaccounts68a13b6b49f14995ba7c5f3aedcbd7ad/99D1E_XSLT_INTEGRATIONACCOUNTMAP47-9C97D973088B4256A1893B - BCB1F85246?sv=2014-02-14&sr=b&sig=<value> -ContentSize : 3056 -Metadata : -``` - -This command modifies the integration account map in the specified resource group. -The command specifies a map definition stored in the $MapContent variable by a previous command. - -## PARAMETERS - -### -ContentType -Specifies a content type for the integration account map. -This cmdlet supports application/xml as a map content type. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MapDefinition -Specifies a definition object for integration account map. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MapFilePath -Specifies the file path of a definition for the integration account map. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MapName -Specifies the name of an integration account map. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MapType -Specifies the type for the integration account map. -This cmdlet supports Xslt as a map type. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Xslt - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Metadata -Specifies a metadata object for the map. - -```yaml -Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the integration account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: IntegrationAccountName, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Logic.Models.IntegrationAccountMap - -## NOTES - -## RELATED LINKS - -[Get-AzureRmIntegrationAccountMap](./Get-AzureRmIntegrationAccountMap.md) - -[New-AzureRmIntegrationAccountMap](./New-AzureRmIntegrationAccountMap.md) - -[Remove-AzureRmIntegrationAccountMap](./Remove-AzureRmIntegrationAccountMap.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmIntegrationAccountPartner.md b/azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmIntegrationAccountPartner.md deleted file mode 100644 index 84e756f217..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmIntegrationAccountPartner.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: 9B3B6AD4-C37C-4877-9864-9FB2E3B0BDAB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/set-azurermintegrationaccountpartner -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountPartner.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountPartner.md ---- - -# Set-AzureRmIntegrationAccountPartner - -## SYNOPSIS -Modifies an integration account partner. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmIntegrationAccountPartner -ResourceGroupName <String> -Name <String> -PartnerName <String> - [-PartnerType <String>] [-BusinessIdentities <Object>] [-Metadata <Object>] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmIntegrationAccountPartner** cmdlet modifies an integration account partner. -This cmdlet returns an object that represents the integration account partner. -Specify the integration account name, resource group name, and partner name. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Modify an integration account partner -``` -PS C:\>Set-AzureRmIntegrationAccountPartner -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -PartnerName "IntegrationAccountPartner22" -PartnerType "B2B" -BusinessIdentities $BusinessIdentities -Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31/partners/IntegrationAccountPartner1 -Name : IntegrationAccountPartner1 -Type : Microsoft.Logic/integrationAccounts/partners -PartnerType : B2B -CreatedTime : 3/26/2016 7:29:30 PM -ChangedTime : 3/26/2016 7:29:30 PM -BusinessIdentities : [{"Qualifier":"ZZ","Value":"AA"},{"Qualifier":"XX","Value":"GG"}] -Metadata -``` - -This command modify the integration account partner named IntegrationAccountPartner22 in the specified resource group. - -## PARAMETERS - -### -BusinessIdentities -Specifies business identities for the integration account partner. -Specify a hash table. - -```yaml -Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Metadata -Specifies a metadata object for the partner. - -```yaml -Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of an integration account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: IntegrationAccountName, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PartnerName -Specifies the name of the integration account partner. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PartnerType -Specifies the type of the integration account. -This parameter supports the type B2B. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: B2B - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Logic.Models.IntegrationAccountPartner - -## NOTES - -## RELATED LINKS - -[Get-AzureRmIntegrationAccountPartner](./Get-AzureRmIntegrationAccountPartner.md) - -[New-AzureRmIntegrationAccountPartner](./New-AzureRmIntegrationAccountPartner.md) - -[Remove-AzureRmIntegrationAccountPartner](./Remove-AzureRmIntegrationAccountPartner.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmIntegrationAccountReceivedIcn.md b/azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmIntegrationAccountReceivedIcn.md deleted file mode 100644 index 79b00d1570..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmIntegrationAccountReceivedIcn.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/set-azurermintegrationaccountreceivedicn -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountReceivedIcn.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountReceivedIcn.md ---- - -# Set-AzureRmIntegrationAccountReceivedIcn - -## SYNOPSIS -Updates the integration account received interchange control number (ICN) in the Azure resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmIntegrationAccountReceivedIcn -ResourceGroupName <String> -Name <String> -AgreementName <String> - -ControlNumberValue <String> -IsMessageProcessingFailed <Boolean> [-AgreementType <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Set-AzureRmIntegrationAccountGeneratedIcn cmdlet updates an existing integration account received interchange control number (ICN) and returns an object that represents the integration account received interchange control number. -Use this cmdlet to update an integration account received interchange control number's message processing status. -You can update an integration account received interchange control number by specifying the integration account name, resource group name, agreement name, control number value and message processing status. -You cannot create a new integration account received interchange control number with this command. -To use the dynamic parameters, just type them in the command, or type a hyphen sign(-) to indicate a parameter name and then press the TAB key repeatedly to cycle through the available parameters. -If you miss a required template parameter, the cmdlet prompts you for the value. -Template parameter file values that you specify at the command line take precedence over template parameter values in a template parameter object. -Please do provide the "-AgreementType" parameter to specify whether X12 or Edifact control numbers to return - -## EXAMPLES - -### Example 1 -``` -PS C:\> Set-AzureRmIntegrationAccountGeneratedIcn -AgreementType "X12" -ResourceGroupName "ResourceGroup1" -Name "IntegrationAccount1" -AgreementName "X12IntegrationAccountAgreement" -ControlNumber "123" -IsMessageProcessingFailed $true -ControlNumber : 1100 -ControlNumberChangedTime : 2/15/2017 12:36:00 AM -IsMessageProcessingFailed : True -``` - -This command updates the integration account received X12 interchange control number for a specific integration account agreement and value with message processing status failed. - -### Example 2 -``` -PS C:\> Set-AzureRmIntegrationAccountGeneratedIcn -AgreementType "Edifact" -ResourceGroupName "ResourceGroup1" -Name "IntegrationAccount1" -AgreementName "EdifactIntegrationAccountAgreement" -ControlNumber "123" -IsMessageProcessingFailed $true -ControlNumber : 1100 -ControlNumberChangedTime : 2/15/2017 12:36:00 AM -IsMessageProcessingFailed : True -``` - -This command updates the integration account received Edifact interchange control number for a specific integration account agreement and value with message processing status failed. - -## PARAMETERS - -### -AgreementName -The integration account agreement name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AgreementType -The integration account agreement type (X12 or Edifact). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: MessageType -Accepted values: X12, Edifact - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ControlNumberValue -The integration account control number value. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsMessageProcessingFailed -The received message processing status. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The integration account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The integration account resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.LogicApp.Utilities.IntegrationAccountControlNumber - -## NOTES - -## RELATED LINKS - -[Get-AzureRmIntegrationAccountReceivedIcn](./Get-AzureRmIntegrationAccountReceivedIcn.md) -[Remove-AzureRmIntegrationAccountReceivedIcn](./Remove-AzureRmIntegrationAccountReceivedIcn.md) diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmIntegrationAccountSchema.md b/azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmIntegrationAccountSchema.md deleted file mode 100644 index dcf35f84bc..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmIntegrationAccountSchema.md +++ /dev/null @@ -1,262 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: 3D4E44E3-0B55-4699-944F-412EE80CEEEF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/set-azurermintegrationaccountschema -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountSchema.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountSchema.md ---- - -# Set-AzureRmIntegrationAccountSchema - -## SYNOPSIS -Modifies an integration account schema. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmIntegrationAccountSchema -ResourceGroupName <String> -Name <String> -SchemaName <String> - [-SchemaFilePath <String>] [-SchemaDefinition <String>] [-SchemaType <String>] [-ContentType <String>] - [-Metadata <Object>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmIntegrationAccountSchema** cmdlet modifies an integration account schema. -This cmdlet returns an object that represents the integration account schema. -Specify the integration account name, resource group name, and schema name. -Template parameter file values that you specify at the command line take precedence over template parameter values in a template parameter object. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Modify an integration account schema -``` -PS C:\>Set-AzureRmIntegrationAccountSchema -ResourceGroupName "ResourceGroup11" -Name "IntegrationAccount31" -SchemaName "IntegrationAccountSchema43" -SchemaFilePath "c:\temp\schema1" -Id : /subscriptions/<SusbcriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31/schemas/IntegrationAccountSchema43 -Name : IntegrationAccountSchema43 -Type : Microsoft.Logic/integrationAccounts/schemas -CreatedTime : 3/26/2016 7:21:10 PM -ChangedTime : 3/26/2016 7:21:10 PM -SchemaType : Xml -ContentLink : https://<baseurl>/integrationaccounts68a13b6b49f14995ba7c5f3aedcbd7ad/3839E_XML_INTEGRATIONACCOUNTSCHEMA2-5A6650B914454A2CAB16 - B4A8D3F9840D?sv=2014-02-14&sr=b&sig=<value> -ContentSize : 7901 -``` - -This command modifies the integration account schema named IntegrationAccountSchema43. - -## PARAMETERS - -### -ContentType -Specifies a content type for the integration account schema. -This cmdlet supports application/xml as a map content type. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Metadata -Specifies a metadata object for the schema. - -```yaml -Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the integration account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: IntegrationAccountName, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SchemaDefinition -Specifies a definition object for integration account schema. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SchemaFilePath -Specifies the file path of a definition for the integration account schema. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SchemaName -Specifies the name of the integration account schema. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SchemaType -Specifies the type for the integration account schema. -This parameter supports Xml as the type. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Xml - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Logic.Models.IntegrationAccountSchema - -## NOTES - -## RELATED LINKS - -[Get-AzureRmIntegrationAccountSchema](./Get-AzureRmIntegrationAccountSchema.md) - -[New-AzureRmIntegrationAccountSchema](./New-AzureRmIntegrationAccountSchema.md) - -[Remove-AzureRmIntegrationAccountSchema](./Remove-AzureRmIntegrationAccountSchema.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmLogicApp.md b/azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmLogicApp.md deleted file mode 100644 index 133ed22865..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Set-AzureRmLogicApp.md +++ /dev/null @@ -1,316 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: AEDA89D3-EF80-4E56-9B97-677EC8F3959D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/set-azurermlogicapp -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmLogicApp.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmLogicApp.md ---- - -# Set-AzureRmLogicApp - -## SYNOPSIS -Modifies a logic app in a resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Consumption (Default) -``` -Set-AzureRmLogicApp -ResourceGroupName <String> -Name <String> [-UseConsumptionModel] [-State <String>] - [-Definition <Object>] [-DefinitionFilePath <String>] [-IntegrationAccountId <String>] [-Parameters <Object>] - [-ParameterFilePath <String>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### HostingPlan -``` -Set-AzureRmLogicApp -ResourceGroupName <String> -Name <String> [-AppServicePlan <String>] [-State <String>] - [-Definition <Object>] [-DefinitionFilePath <String>] [-IntegrationAccountId <String>] [-Parameters <Object>] - [-ParameterFilePath <String>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmLogicApp** cmdlet modifies a logic app by using the Logic Apps feature. -A logic app is a collection of actions or triggers defined in Logic App definition. -This cmdlet returns a **Workflow** object. -You can modify a logic app by specifying a name, location, Logic App definition, resource group, and plan. -A Logic App definition and parameters are formatted in JavaScript Object Notation (JSON). -You can use a logic app as a template for definition and parameters. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. -Template parameter file values that you specify at the command line take precedence over template parameter values in a template parameter object. - -## EXAMPLES - -### Example 1: Modify a logic app -``` -PS C:\>Set-AzureRmLogicApp -ResourceGroupName "ResourceGroup11" -Name "LogicApp17" -State "Enabled" -AppServicePlan "ServicePlan01" -DefinitionFilePath "d:\workflows\Definition17.json" -ParameterFilePath "d:\workflows\Parameters17.json" -Id : /subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourceGroups/LogicAppCmdletTest/providers/Microsoft.Logic/workflows/LogicApp1 -Name : LogicApp17 -Type : Microsoft.Logic/workflows -Location : westus -ChangedTime : 1/13/2016 2:41:39 PM -CreatedTime : 1/13/2016 2:41:39 PM -AccessEndpoint : https://westus.logic.azure.com:443/subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourcegroups/ResourceGroup11/providers/Microsoft.Logic/workflows/LogicApp17 -State : Enabled -DefinitionLinkUri : -DefinitionLinkContentVersion : -Definition : {$schema, contentVersion, parameters, triggers...} -ParametersLinkUri : -ParametersLinkContentVersion : -Parameters : {[destinationUri, Microsoft.Azure.Management.Logic.Models.WorkflowParameter]} -SkuName : Standard -PlanName : ServicePlan01 -PlanType : Microsoft.Web/ServerFarms -PlanId : /subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourceGroups/ResourceGroup11/providers/Microsoft.Web/serverfarms/ServicePlan17 -Version : 08587489107859952120 -``` - -This command modifies a logic app. - -## PARAMETERS - -### -AppServicePlan -Specifies the name of a plan. - -```yaml -Type: System.String -Parameter Sets: HostingPlan -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Definition -Specifies the definition of a logic app as an object or a string in JavaScript Object Notation (JSON) format. - -```yaml -Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefinitionFilePath -Specifies the definition of a logic app as the path of a definition file in JSON format. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IntegrationAccountId -Specifies an integration account ID for the logic app. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a logic app. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParameterFilePath -Specifies the path of a JSON formatted parameter file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Parameters -Specifies a parameters collection object for the Logic App. -Specify a hash table, Dictionary\<string\>, or Dictionary\<string, WorkflowParameter\>. - -```yaml -Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -Specifies the state of the logic app. -The acceptable values for this parameter are: Enabled and Disabled. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseConsumptionModel -Indicates that the logic app billing use the consumption based model. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Consumption -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLogicApp](./Get-AzureRmLogicApp.md) - -[New-AzureRmLogicApp](./New-AzureRmLogicApp.md) - -[Remove-AzureRmLogicApp](./Remove-AzureRmLogicApp.md) - -[Start-AzureRmLogicApp](./Start-AzureRmLogicApp.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Start-AzureRmLogicApp.md b/azurermps-6.13.0/AzureRM.LogicApp/Start-AzureRmLogicApp.md deleted file mode 100644 index d540e70a38..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Start-AzureRmLogicApp.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: 50C359FC-D98C-4C2C-87EE-BE9A25C3EDC6 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/start-azurermlogicapp -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Start-AzureRmLogicApp.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Start-AzureRmLogicApp.md ---- - -# Start-AzureRmLogicApp - -## SYNOPSIS -Runs a logic app in a resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Start-AzureRmLogicApp -ResourceGroupName <String> -Name <String> [-Parameters <Object>] -TriggerName <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Start-AzureRmLogicApp** cmdlet runs a logic app by using the Logic Apps feature. -Specify a name, resource group, and trigger. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Run a logic app -``` -PS C:\>Start-AzureRmLogicApp -ResourceGroupName "ResourceGroup11" -Name "LogicApp03" -TriggerName "Trigger22" -``` - -This command runs the logic app in the resource group named ResourceGroup11. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the logic app that this cmdlet starts. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Parameters -Specifies a parameters collection object of the logic app. -Specify a hash table, Dictionary\<string\>, or Dictionary\<string, WorkflowParameter\>. - -```yaml -Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the logic app that this cmdlet starts. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TriggerName -Specifies the name of the trigger of the logic app that this cmdlet starts. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLogicApp](./Get-AzureRmLogicApp.md) - -[Get-AzureRmLogicAppRunHistory](./Get-AzureRmLogicAppRunHistory.md) - -[New-AzureRmLogicApp](./New-AzureRmLogicApp.md) - -[Remove-AzureRmLogicApp](./Remove-AzureRmLogicApp.md) - -[Set-AzureRmLogicApp](./Set-AzureRmLogicApp.md) - -[Stop-AzureRmLogicAppRun](./Stop-AzureRmLogicAppRun.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Stop-AzureRmLogicAppRun.md b/azurermps-6.13.0/AzureRM.LogicApp/Stop-AzureRmLogicAppRun.md deleted file mode 100644 index f0c172a9f1..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Stop-AzureRmLogicAppRun.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: 3308F901-4C9F-424D-8BEB-877A6038B246 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/stop-azurermlogicapprun -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Stop-AzureRmLogicAppRun.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Stop-AzureRmLogicAppRun.md ---- - -# Stop-AzureRmLogicAppRun - -## SYNOPSIS -Cancels a run of a logic app. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Stop-AzureRmLogicAppRun -ResourceGroupName <String> -Name <String> -RunName <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Stop-AzureRmLogicAppRun** cmdlet cancels a run of a logic app. -Specify the logic app, resource group, and run. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Cancel a run of a logic app -``` -PS C:\>Stop-AzureRmLogicAppRun -ResourceGroupName "ResourceGroup11" -Name "LogicApp03" -RunName "08587489104702792076" -Force -``` - -This command cancels a run of the logic app named LogicApp03. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a logic app for which this cmdlet cancels a run. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name for a resource group in which this cmdlet cancels a run. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RunName -Specifies the name of a logic app run that this cmdlet cancels. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Start-AzureRmLogicApp](./Start-AzureRmLogicApp.md) - - diff --git a/azurermps-6.13.0/AzureRM.LogicApp/Test-AzureRmLogicApp.md b/azurermps-6.13.0/AzureRM.LogicApp/Test-AzureRmLogicApp.md deleted file mode 100644 index a98e747139..0000000000 --- a/azurermps-6.13.0/AzureRM.LogicApp/Test-AzureRmLogicApp.md +++ /dev/null @@ -1,242 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml -Module Name: AzureRM.LogicApp -ms.assetid: 929F4593-2A71-49B9-87F8-F24FA9F6E314 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.logicapp/test-azurermlogicapp -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Test-AzureRmLogicApp.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/LogicApp/Commands.LogicApp/help/Test-AzureRmLogicApp.md ---- - -# Test-AzureRmLogicApp - -## SYNOPSIS -Validates a logic app definition. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### LogicAppWithDefinitionParameterSet -``` -Test-AzureRmLogicApp -ResourceGroupName <String> -Name <String> -Location <String> [-State <String>] - [-Definition <Object>] [-IntegrationAccountId <String>] [-Parameters <Object>] [-ParameterFilePath <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### LogicAppWithDefinitionFileParameterSet -``` -Test-AzureRmLogicApp -ResourceGroupName <String> -Name <String> -Location <String> [-State <String>] - [-DefinitionFilePath <String>] [-IntegrationAccountId <String>] [-Parameters <Object>] - [-ParameterFilePath <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Test-AzureRmLogicApp** cmdlet validates a logic app definition in a resource group. -Specify the logic app name, resource group name, location, state, integration account ID, or parameters. -This module supports dynamic parameters. -To use a dynamic parameter, type it in the command. -To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required template parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -### Example 1: Validate a logic app by using file paths -``` -PS C:\>Test-AzureRmLogicApp -ResourceGroupName "ResourceGroup11" -Name "LogicApp01" -Location "westus" -State "Enabled" -DefinitionFilePath "d:\workflows\Definition.json" -ParameterFilePath "d:\workflows\Parameters.json" -``` - -This command validates a logic app named LogicApp01 in the specified resource group. -The command specifies definition and parameter file paths. - -### Example 2: Validate a logic app by using objects -``` -PS C:\>Test-AzureRmLogicApp -ResourceGroupName "ResourceGroup11" -Name "LogicApp01" -Location "westus" -State "Enabled" -Definition [IO.File]::ReadAllText("d:\Workflows\Definition.json") -Parameters @{name1="value1", name2="value2"} -``` - -This command validates a logic app named LogicApp01 in the specified resource group. -The command specifies definition and parameter objects. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Definition -Specifies the definition of a logic app as an object or a string in JavaScript Object Notation (JSON) format. - -```yaml -Type: System.Object -Parameter Sets: LogicAppWithDefinitionParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefinitionFilePath -Specifies the definition of your logic app as the path of a definition file in JSON format. - -```yaml -Type: System.String -Parameter Sets: LogicAppWithDefinitionFileParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IntegrationAccountId -Specifies an integration account ID for the logic app. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the logic app. -Enter an Azure data center location, such as West US or Southeast Asia. -You can place a logic app in any location. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the logic app. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ParameterFilePath -Specifies the path of a JSON formatted parameter file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Parameters -Specifies a parameters collection object of the logic app. -Specify a hash table, Dictionary\<string\>, or Dictionary\<string, WorkflowParameter\>. - -```yaml -Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -Specifies a state of the logic app. -The acceptable values for this parameter are: Enabled and Disabled. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLogicApp](./Get-AzureRmLogicApp.md) - -[New-AzureRmLogicApp](./New-AzureRmLogicApp.md) - -[Remove-AzureRmLogicApp](./Remove-AzureRmLogicApp.md) - -[Set-AzureRmLogicApp](./Set-AzureRmLogicApp.md) - -[Start-AzureRmLogicApp](./Start-AzureRmLogicApp.md) - - diff --git a/azurermps-6.13.0/AzureRM.MachineLearning/Add-AzureRmMlWebServiceRegionalProperty.md b/azurermps-6.13.0/AzureRM.MachineLearning/Add-AzureRmMlWebServiceRegionalProperty.md deleted file mode 100644 index 1d03d6535c..0000000000 --- a/azurermps-6.13.0/AzureRM.MachineLearning/Add-AzureRmMlWebServiceRegionalProperty.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml -Module Name: AzureRM.MachineLearning -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.machinelearning/add-azurermmlwebserviceregionalproperty -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Add-AzureRmMlWebServiceRegionalProperty.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Add-AzureRmMlWebServiceRegionalProperty.md ---- - -# Add-AzureRmMlWebServiceRegionalProperty - -## SYNOPSIS -Creates regional web service properties. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmMlWebServiceRegionalProperty -ResourceGroupName <String> -Name <String> -Region <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Creates Azure Machine Learning regional properties for an existing web service. - -## EXAMPLES - -### Example 1: Add new regional properties for West Central US - -``` -Add-AzureRmMlWebServiceRegionalProperty -ResourceGroupName "myresourcegroup" -Name "mywebservicename" -Region westcentralus -``` - -This example command creates regional property for a web service in the "West Central US" region. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name for the web service. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Region -The region in which to create the web service properties. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group in which the web service belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, machine, machine learning, azureml - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.MachineLearning/AzureRM.MachineLearning.md b/azurermps-6.13.0/AzureRM.MachineLearning/AzureRM.MachineLearning.md deleted file mode 100644 index cd4cc3e7bf..0000000000 --- a/azurermps-6.13.0/AzureRM.MachineLearning/AzureRM.MachineLearning.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -Module Name: AzureRM.MachineLearning -Module Guid: bb030259-49f9-46ef-806f-2a3f5a2e018e -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.machinelearning -Help Version: 1.0.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/AzureRM.MachineLearning.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/AzureRM.MachineLearning.md ---- - -# AzureRM.MachineLearning Module -## Description -Machine Learning Web Services cmdlets for Azure Resource Manager - -## AzureRM.MachineLearning Cmdlets -### [Add-AzureRmMlWebServiceRegionalProperty](Add-AzureRmMlWebServiceRegionalProperty.md) -Creates regional web service properties. - -### [Export-AzureRmMlWebService](Export-AzureRmMlWebService.md) -Exports the web service definition object as a JSON formatted string. - -### [Get-AzureRmMlCommitmentAssociation](Get-AzureRmMlCommitmentAssociation.md) -Retrieves the summary information for one or more commitment associations. - -### [Get-AzureRmMlCommitmentPlan](Get-AzureRmMlCommitmentPlan.md) -Retrieves the summary information for one or more commitment plans. - -### [Get-AzureRmMlCommitmentPlanUsageHistory](Get-AzureRmMlCommitmentPlanUsageHistory.md) -Retrieves usage history information for a specified commitment plan. - -### [Get-AzureRmMlWebService](Get-AzureRmMlWebService.md) -Retrieves the summary information for one or more web services. - -### [Get-AzureRmMlWebServiceKeys](Get-AzureRmMlWebServiceKeys.md) -Retrieves the web service's keys. - -### [Import-AzureRmMlWebService](Import-AzureRmMlWebService.md) -Imports a JSON object into a web service definition. - -### [Move-AzureRmMlCommitmentAssociation](Move-AzureRmMlCommitmentAssociation.md) -Moves a commitment association from one commitment plan to another. - -### [New-AzureRmMlCommitmentPlan](New-AzureRmMlCommitmentPlan.md) -Creates a new commitment plan. - -### [New-AzureRmMlWebService](New-AzureRmMlWebService.md) -Creates a new web service. - -### [Remove-AzureRmMlCommitmentPlan](Remove-AzureRmMlCommitmentPlan.md) -Deletes a commitment plan. - -### [Remove-AzureRmMlWebService](Remove-AzureRmMlWebService.md) -Deletes a web service. - -### [Update-AzureRmMlCommitmentPlan](Update-AzureRmMlCommitmentPlan.md) -Updates properties of an existing commitment plan resource. - -### [Update-AzureRmMlWebService](Update-AzureRmMlWebService.md) -Updates properties of an existing web service resource. - diff --git a/azurermps-6.13.0/AzureRM.MachineLearning/Export-AzureRmMlWebService.md b/azurermps-6.13.0/AzureRM.MachineLearning/Export-AzureRmMlWebService.md deleted file mode 100644 index c4d9964a3a..0000000000 --- a/azurermps-6.13.0/AzureRM.MachineLearning/Export-AzureRmMlWebService.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml -Module Name: AzureRM.MachineLearning -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.machinelearning/export-azurermmlwebservice -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Export-AzureRmMlWebService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Export-AzureRmMlWebService.md ---- - -# Export-AzureRmMlWebService - -## SYNOPSIS -Exports the web service definition object as a JSON formatted string. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ExportToFile -``` -Export-AzureRmMlWebService -WebService <WebService> -OutputFile <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ExportToJSON -``` -Export-AzureRmMlWebService -WebService <WebService> [-ToJsonString] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Exports the definition object for the specified web servive as a JSON formatted string. -You can return the string immediately or save it to a file. - -## EXAMPLES - -### Example 1: Export as string -``` -Export-AzureRmMlWebService -WebService $svc -ToJsonString -``` - -### Example 2: Export to file -``` -Export-AzureRmMlWebService -WebService $svc -OutputFile "C:\mlservice.json" -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutputFile -The file path for exported definition. - -```yaml -Type: System.String -Parameter Sets: ExportToFile -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ToJsonString -Specifies that the definition will be exported as a JSON string. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ExportToJSON -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebService -The web service definition object to be exported. - -```yaml -Type: Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService -Parameters: WebService (ByValue) - -## OUTPUTS - -### System.String - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, machine, machine learning, azureml - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.MachineLearning/Get-AzureRmMlCommitmentAssociation.md b/azurermps-6.13.0/AzureRM.MachineLearning/Get-AzureRmMlCommitmentAssociation.md deleted file mode 100644 index 6133dc7dd4..0000000000 --- a/azurermps-6.13.0/AzureRM.MachineLearning/Get-AzureRmMlCommitmentAssociation.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml -Module Name: AzureRM.MachineLearning -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.machinelearning/get-azurermmlcommitmentassociation -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlCommitmentAssociation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlCommitmentAssociation.md ---- - -# Get-AzureRmMlCommitmentAssociation - -## SYNOPSIS -Retrieves the summary information for one or more commitment associations. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmMlCommitmentAssociation -ResourceGroupName <String> -CommitmentPlanName <String> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Retrieves commitment association information. -Depending on the paramenters passed, the cmdlet returns a specific commitment association or a collection of commitment associations for the specified commitment plan. - -## EXAMPLES - -### Example 1: Get a specific commitment association -``` -Get-AzureRmMlCommitmentAssociation -ResourceGroupName "MyResourceGroup" -CommitmentPlanName "MyCommitmentPlanName" -Name "MyCommitmentAssociationName" -``` - -### Example 2: Get all commitment associations for the specified commitment plan -``` -Get-AzureRmMlCommitmentAssociation -ResourceGroupName "MyResourceGroup" -CommitmentPlanName "MyCommitmentPlanName" -``` - -## PARAMETERS - -### -CommitmentPlanName -The name of the Azure ML commitment plan which has one or more commitment associations. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the Azure ML commitment association. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group for the Azure ML commitment association. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Management.MachineLearning.CommitmentPlans.Models.CommitmentPlan - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, machine, machine learning, azureml - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.MachineLearning/Get-AzureRmMlCommitmentPlan.md b/azurermps-6.13.0/AzureRM.MachineLearning/Get-AzureRmMlCommitmentPlan.md deleted file mode 100644 index 109ad21127..0000000000 --- a/azurermps-6.13.0/AzureRM.MachineLearning/Get-AzureRmMlCommitmentPlan.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml -Module Name: AzureRM.MachineLearning -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.machinelearning/get-azurermmlcommitmentplan -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlCommitmentPlan.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlCommitmentPlan.md ---- - -# Get-AzureRmMlCommitmentPlan - -## SYNOPSIS -Retrieves the summary information for one or more commitment plans. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmMlCommitmentPlan [-ResourceGroupName <String>] [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Retrieves commitment plan information. -Depending on the paramenters passed, the cmdlet returns the a specific commitment plan, a collection of commitment plans for a specified resource group within the current subscription, or a collection of commitment plans within the current subscription. - -## EXAMPLES - -### Example 1: Get a specific commitment plan -``` -Get-AzureRmMlCommitmentPlan -ResourceGroupName "MyResourceGroup" -Name "MyCommitmentPlanName" -``` - -### Example 2: Get all commitment plan resources in current subscription -``` -Get-AzureRmMlCommitmentPlan -``` - -### Example 3: Get all commitment plans in the current subscription and given resource group -``` -Get-AzureRmMlCommitmentPlan -ResourceGroupName "MyResourceGroup" -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the commitment plan. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group for the Azure ML commitment plan. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Management.MachineLearning.CommitmentPlans.Models.CommitmentPlan - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, machine, machine learning, azureml - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.MachineLearning/Get-AzureRmMlCommitmentPlanUsageHistory.md b/azurermps-6.13.0/AzureRM.MachineLearning/Get-AzureRmMlCommitmentPlanUsageHistory.md deleted file mode 100644 index 4098ccefb5..0000000000 --- a/azurermps-6.13.0/AzureRM.MachineLearning/Get-AzureRmMlCommitmentPlanUsageHistory.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml -Module Name: AzureRM.MachineLearning -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.machinelearning/get-azurermmlcommitmentplanusagehistory -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlCommitmentPlanUsageHistory.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlCommitmentPlanUsageHistory.md ---- - -# Get-AzureRmMlCommitmentPlanUsageHistory - -## SYNOPSIS -Retrieves usage history information for a specified commitment plan. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmMlCommitmentPlanUsageHistory -ResourceGroupName <String> -Name <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Retrieves usage history information for a specified commitment plan, including resources used and resources remaining within the plan. - -## EXAMPLES - -### Example 1: Get usage history for a specific commitment plan -``` -Get-AzureRmMlCommitmentPlanUsageHistory -ResourceGroupName "MyResourceGroup" -Name "MyCommitmentPlanName" -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the Azure ML commitment plan. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group for the Azure ML commitment plan. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Management.MachineLearning.CommitmentPlans.Models.PlanUsageHistory - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, machine, machine learning, azureml - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.MachineLearning/Get-AzureRmMlWebService.md b/azurermps-6.13.0/AzureRM.MachineLearning/Get-AzureRmMlWebService.md deleted file mode 100644 index b9255a9ad7..0000000000 --- a/azurermps-6.13.0/AzureRM.MachineLearning/Get-AzureRmMlWebService.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml -Module Name: AzureRM.MachineLearning -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.machinelearning/get-azurermmlwebservice -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlWebService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlWebService.md ---- - -# Get-AzureRmMlWebService - -## SYNOPSIS -Retrieves the summary information for one or more web services. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmMlWebService [-ResourceGroupName <String>] [-Name <String>] [-Region <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Retrieves web service defintion information. -Depending on the paramenters passed, the cmdlet returns the defintion for a specific web service, a collection of defintions for the web services for a specified resource group within the current subscription, or a collection of defintions for the web services within the current subscription. - -## EXAMPLES - -### Example 1: Get details of specific web service -``` -Get-AzureRmMlWebService -ResourceGroupName "myresourcegroup" -Name "mywebservicename" -``` - -### Example 2: Get all web service resources in current subscription -``` -Get-AzureRmMlWebService -``` - -### Example 3: Get all web services in the current subscription and given resource group -``` -Get-AzureRmMlWebService -ResourceGroupName "myresourcegroup" -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the web service for which the details are retrieved. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Region -The name of regio - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group from which the details for the web service are retrieved. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, machine, machine learning, azureml - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.MachineLearning/Get-AzureRmMlWebServiceKeys.md b/azurermps-6.13.0/AzureRM.MachineLearning/Get-AzureRmMlWebServiceKeys.md deleted file mode 100644 index 63d586b852..0000000000 --- a/azurermps-6.13.0/AzureRM.MachineLearning/Get-AzureRmMlWebServiceKeys.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml -Module Name: AzureRM.MachineLearning -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.machinelearning/get-azurermmlwebservicekeys -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlWebServiceKeys.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlWebServiceKeys.md ---- - -# Get-AzureRmMlWebServiceKeys - -## SYNOPSIS -Retrieves the web service's keys. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetByNameAndResourceGroup -``` -Get-AzureRmMlWebServiceKeys -ResourceGroupName <String> -Name <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetByInstance -``` -Get-AzureRmMlWebServiceKeys -MlWebService <WebService> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -Gets the access keys for the Azure Machine Learning web service's runtime APIs. - -## EXAMPLES - -### Example 1 - Get the keys for a web service specified by resource group and name -``` -Get-AzureRmMlWebServiceKeys -ResourceGroupName "myresourcegroup" -Name "mywebservicename" -``` - -### Example 2 - Get keys for web service instance -``` -Get-AzureRmMlWebServiceKeys -MlWebService $mlService -``` - -$mlService is an object of type Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MlWebService -The name of the web service for which the access keys are retrieved. - -```yaml -Type: Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService -Parameter Sets: GetByInstance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the web service for which the access keys are retrieved. - -```yaml -Type: System.String -Parameter Sets: GetByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group for the web service. - -```yaml -Type: System.String -Parameter Sets: GetByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService -Parameters: MlWebService (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebServiceKeys - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, machine, machine learning, azureml - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.MachineLearning/Import-AzureRmMlWebService.md b/azurermps-6.13.0/AzureRM.MachineLearning/Import-AzureRmMlWebService.md deleted file mode 100644 index 757afbf61f..0000000000 --- a/azurermps-6.13.0/AzureRM.MachineLearning/Import-AzureRmMlWebService.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml -Module Name: AzureRM.MachineLearning -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.machinelearning/import-azurermmlwebservice -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Import-AzureRmMlWebService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Import-AzureRmMlWebService.md ---- - -# Import-AzureRmMlWebService - -## SYNOPSIS -Imports a JSON object into a web service definition. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ImportFromJSONFile -``` -Import-AzureRmMlWebService -InputFile <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ImportFromJSONString. -``` -Import-AzureRmMlWebService -JsonString <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Import-AzureRmMlWebService cmdlet imports , specified either directly or in a referenced file, and creates a web service definition object that can be passed to the New-AzureRmMlWebService cmdlet. - -## EXAMPLES - -### Example 1: Import from string -``` -Import-AzureRmMlWebService -JsonString $jsonDefinition -``` - -### Example 2: Import from file path -``` -Import-AzureRmMlWebService -InputFile "C:\mlservice.json" -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputFile -The path to the file containing the web service definition to import. - -```yaml -Type: System.String -Parameter Sets: ImportFromJSONFile -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JsonString -The JSON formatted string containing the web service definition to import. - -```yaml -Type: System.String -Parameter Sets: ImportFromJSONString. -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, machine, machine learning, azureml - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.MachineLearning/Move-AzureRmMlCommitmentAssociation.md b/azurermps-6.13.0/AzureRM.MachineLearning/Move-AzureRmMlCommitmentAssociation.md deleted file mode 100644 index 0ee8ede784..0000000000 --- a/azurermps-6.13.0/AzureRM.MachineLearning/Move-AzureRmMlCommitmentAssociation.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml -Module Name: AzureRM.MachineLearning -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.machinelearning/move-azurermmlcommitmentassociation -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Move-AzureRmMlCommitmentAssociation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Move-AzureRmMlCommitmentAssociation.md ---- - -# Move-AzureRmMlCommitmentAssociation - -## SYNOPSIS -Moves a commitment association from one commitment plan to another. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Move-AzureRmMlCommitmentAssociation -ResourceGroupName <String> -CommitmentPlanName <String> -Name <String> - -DestinationPlanId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Moves a commitment association resource from its parent commitment plan to another commitment plan. - -## EXAMPLES - -### Example 1: Move a commitment association -``` -Get-AzureRmMlCommitmentAssociation -ResourceGroupName "MyResourceGroup" -CommitmentPlanName "SourceCommitmentPlanName" -Name "MyCommitmentAssociationName" -DestinationPlanId "/subscriptions/MySubscriptionId/resourceGroups/MyResourceGroup/providers/Microsoft.MachineLearning/commitmentPlans/DestinationCommitmentPlanName" -``` - -## PARAMETERS - -### -CommitmentPlanName -The name of the Azure ML commitment plan. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationPlanId -The Azure resource ID of the destination Azure ML commitment plan. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the Azure ML commitment association. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group for the Azure ML commitment association. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Management.MachineLearning.CommitmentPlans.Models.CommitmentPlan - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, machine, machine learning, azureml - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.MachineLearning/New-AzureRmMlCommitmentPlan.md b/azurermps-6.13.0/AzureRM.MachineLearning/New-AzureRmMlCommitmentPlan.md deleted file mode 100644 index 4591ba9358..0000000000 --- a/azurermps-6.13.0/AzureRM.MachineLearning/New-AzureRmMlCommitmentPlan.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml -Module Name: AzureRM.MachineLearning -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.machinelearning/new-azurermmlcommitmentplan -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/New-AzureRmMlCommitmentPlan.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/New-AzureRmMlCommitmentPlan.md ---- - -# New-AzureRmMlCommitmentPlan - -## SYNOPSIS -Creates a new commitment plan. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmMlCommitmentPlan -ResourceGroupName <String> -Location <String> -Name <String> -SkuName <String> - -SkuTier <String> [-SkuCapacity <Int32>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Creates an Azure Machine Learning commitment plan in an existing resource group. -If a commitment plan with the same name exists in the resource group, the call acts as an update operation and the existing commitment plan is overwritten. - -## EXAMPLES - -### Example 1: Create a new commitment plan -``` -New-AzureRmMlCommitmentPlan -ResourceGroupName "MyResourceGroup" -Name "MyCommitmentPlanName" -Location "South Central US" -SkuName DevTest -SkuTier Standard -SkuCapacity 1 -``` - -Creates a new Azure Machine Learning commitment plan named "MyCommitmentPlanName" in the "MyResourceGroup" group and South Central US region. In this example, the SKU DevTest/Standard is used, meaning the resources provided by the commitment plan will be definied by the limits of DevTest/Standard. The SkuCapacity in this example is 1, meaning the cost of the plan will be 1x the cost of DevTest, and the resources the plan contains will be 1x what DevTest provides. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The location of the Azure ML commitment plan. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the Azure ML commitment plan. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group for the Azure ML commitment plan. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkuCapacity -The capacity of the SKU to use when provisioning the Azure ML commitment plan. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkuName -The name of the SKU to use when provisioning the Azure ML commitment plan. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkuTier -The tier of the SKU to use when provisioning the Azure ML commitment plan. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Management.MachineLearning.CommitmentPlans.Models.CommitmentPlan - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, machine, machine learning, azureml - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.MachineLearning/New-AzureRmMlWebService.md b/azurermps-6.13.0/AzureRM.MachineLearning/New-AzureRmMlWebService.md deleted file mode 100644 index b4f2746fa5..0000000000 --- a/azurermps-6.13.0/AzureRM.MachineLearning/New-AzureRmMlWebService.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml -Module Name: AzureRM.MachineLearning -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.machinelearning/new-azurermmlwebservice -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/New-AzureRmMlWebService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/New-AzureRmMlWebService.md ---- - -# New-AzureRmMlWebService - -## SYNOPSIS -Creates a new web service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### CreateFromFile -``` -New-AzureRmMlWebService -ResourceGroupName <String> -Location <String> -Name <String> -DefinitionFile <String> - [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### CreateFromInstance -``` -New-AzureRmMlWebService -ResourceGroupName <String> -Location <String> -Name <String> - -NewWebServiceDefinition <WebService> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Creates an Azure Machine Learning web service in an existing resource group. -If a web service with the same name exists in the resource group, the call acts as an update operation and the existing web service is overwritten. - -## EXAMPLES - -### Example 1: Create a new service from a Json file based definition -``` -New-AzureRmMlWebService -ResourceGroupName "myresourcegroup" -Name "mywebservicename" -Location "South Central US" -DefinitionFile "C:\mlservice.json" -``` - -Creates a new Azure Machine Learning web service named "mywebservicename" in the "myresourcegroup" group and South Central US region, based on the definition present in the referenced json file. - -### Example 2: Create a new service from an object instance -``` -New-AzureRmMlWebService -ResourceGroupName "myresourcegroup" -Name "mywebservicename" -Location "South Central US" -NewWebServiceDefinition $serviceDefinitionObject -``` - -You can obtain a web service object instance to customize before publishing as a resource by using the Import-AzureRmMlWebService cmdlet. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefinitionFile -Specifes the path to the file containing the JSON format definition of the web service. -You can find the latest specification for the web service definition in the swagger spec under https://github.com/Azure/azure-rest-api-specs/blob/master/specification/machinelearning/resource-manager/Microsoft.MachineLearning/. - -```yaml -Type: System.String -Parameter Sets: CreateFromFile -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The region of the web service. -Enter an Azure data center region, such as "West US" or "Southeast Asia". -You can place a web service in any region that supports resources of that type. -The web service does not have to be in the same region your Azure subscription or the same region as its resource group. -Resource groups can contain web services from different regions. -To determine which regions support each resource type, use the Get-AzureRmResourceProvider with the ProviderNamespace parameter cmdlet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name for the web service. -The name must be unique in the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewWebServiceDefinition -The definition for the new web service, containing all the properties that make up the service. -This parameter is required and represents an instance of the Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService class. -You can find the latest specification for the web service definition in the swagger spec under https://github.com/Azure/azure-rest-api-specs/blob/master/specification/machinelearning/resource-manager/Microsoft.MachineLearning/stable/2017-01-01/webservices.json. - -```yaml -Type: Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService -Parameter Sets: CreateFromInstance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group in which to place the web service. -Enter an Azure data center region, such as "West US" or "Southeast Asia". -You can place a web service in any region that supports resources of that type. -The web service does not have to be in the same region your Azure subscription or the same region as its resource group. -Resource groups can contain web services from different regions. -To determine which regions support each resource type, use the Get-AzureRmResourceProvider with the ProviderNamespace parameter cmdlet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService -Parameters: NewWebServiceDefinition (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, machine, machine learning, azureml - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.MachineLearning/Remove-AzureRmMlCommitmentPlan.md b/azurermps-6.13.0/AzureRM.MachineLearning/Remove-AzureRmMlCommitmentPlan.md deleted file mode 100644 index 0b71206ef5..0000000000 --- a/azurermps-6.13.0/AzureRM.MachineLearning/Remove-AzureRmMlCommitmentPlan.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml -Module Name: AzureRM.MachineLearning -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.machinelearning/remove-azurermmlcommitmentplan -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Remove-AzureRmMlCommitmentPlan.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Remove-AzureRmMlCommitmentPlan.md ---- - -# Remove-AzureRmMlCommitmentPlan - -## SYNOPSIS -Deletes a commitment plan. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RemoveByNameAndResourceGroup -``` -Remove-AzureRmMlCommitmentPlan -ResourceGroupName <String> -Name <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RemoveByObject -``` -Remove-AzureRmMlCommitmentPlan -MlCommitmentPlan <CommitmentPlan> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Deletes an Azure Machine Learning commitment plan. Note that commitment plans which have commitment associations cannot be deleted. Commitment associations can only be deleted by their target resource. For example, if you delete an Azure Machine Learning web service, the commitment association which associates the web service to a commitment plan will also be deleted. - -## EXAMPLES - -### Example 1: Delete a commitment plan -``` -Remove-AzureRmMlCommitmentPlan -ResourceGroupName "MyResourceGroup" -Name "MyCommitmentPlanName" -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MlCommitmentPlan -The machine learning web service object. - -```yaml -Type: Microsoft.Azure.Management.MachineLearning.CommitmentPlans.Models.CommitmentPlan -Parameter Sets: RemoveByObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the Azure ML commitment plan. - -```yaml -Type: System.String -Parameter Sets: RemoveByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group for the Azure ML commitment plan. - -```yaml -Type: System.String -Parameter Sets: RemoveByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.MachineLearning.CommitmentPlans.Models.CommitmentPlan -Parameters: MlCommitmentPlan (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, machine, machine learning, azureml - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.MachineLearning/Remove-AzureRmMlWebService.md b/azurermps-6.13.0/AzureRM.MachineLearning/Remove-AzureRmMlWebService.md deleted file mode 100644 index 635435c90b..0000000000 --- a/azurermps-6.13.0/AzureRM.MachineLearning/Remove-AzureRmMlWebService.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml -Module Name: AzureRM.MachineLearning -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.machinelearning/remove-azurermmlwebservice -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Remove-AzureRmMlWebService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Remove-AzureRmMlWebService.md ---- - -# Remove-AzureRmMlWebService - -## SYNOPSIS -Deletes a web service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RemoveByNameAndResourceGroup -``` -Remove-AzureRmMlWebService -ResourceGroupName <String> -Name <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RemoveByObject -``` -Remove-AzureRmMlWebService -MlWebService <WebService> [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Deletes a Azure Machine Learning web service referenced by resource group and name. - -## EXAMPLES - -### Example 1 -``` -Remove-AzureRmMlWebService -ResourceGroupName "myresourcegroup" -Name "mywebservicename" -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MlWebService -The web service to be removed. - -```yaml -Type: Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService -Parameter Sets: RemoveByObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the web service to be removed. - -```yaml -Type: System.String -Parameter Sets: RemoveByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group of the web service. - -```yaml -Type: System.String -Parameter Sets: RemoveByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService -Parameters: MlWebService (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, machine, machine learning, azureml - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.MachineLearning/Update-AzureRmMlCommitmentPlan.md b/azurermps-6.13.0/AzureRM.MachineLearning/Update-AzureRmMlCommitmentPlan.md deleted file mode 100644 index ed4023b973..0000000000 --- a/azurermps-6.13.0/AzureRM.MachineLearning/Update-AzureRmMlCommitmentPlan.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml -Module Name: AzureRM.MachineLearning -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.machinelearning/update-azurermmlcommitmentplan -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Update-AzureRmMlCommitmentPlan.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Update-AzureRmMlCommitmentPlan.md ---- - -# Update-AzureRmMlCommitmentPlan - -## SYNOPSIS -Updates properties of an existing commitment plan resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Update-AzureRmMlCommitmentPlan -ResourceGroupName <String> -Name <String> -SkuName <String> -SkuTier <String> - [-SkuCapacity <Int32>] [-Tag <Hashtable>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Updates an existing commitment plan resource. Note that most properties of the commitment plan are immutable and cannot be modified. Properties which can be modified include Sku (allowing you to migrate the commitment plan from one SKU to another) and Tags. - -## EXAMPLES - -### Example 1: Update a commitment plan -``` -Update-AzureRmMlCommitmentPlan -ResourceGroupName "MyResourceGroup" -Name "MyCommitmentPlanName" -Tags @{'MyTagKey'='MyTagValue'} -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the Azure ML commitment plan. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group for the Azure ML commitment plan. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkuCapacity -The capacity of the SKU to use when updating the Azure ML commitment plan. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkuName -The name of the SKU to use when updating the Azure ML commitment plan. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkuTier -The tier of the SKU to use when updating the Azure ML commitment plan. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Tags for the commitment plan resource. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Management.MachineLearning.CommitmentPlans.Models.CommitmentPlan - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, machine, machine learning, azureml - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.MachineLearning/Update-AzureRmMlWebService.md b/azurermps-6.13.0/AzureRM.MachineLearning/Update-AzureRmMlWebService.md deleted file mode 100644 index c902e38dfb..0000000000 --- a/azurermps-6.13.0/AzureRM.MachineLearning/Update-AzureRmMlWebService.md +++ /dev/null @@ -1,366 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml -Module Name: AzureRM.MachineLearning -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.machinelearning/update-azurermmlwebservice -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Update-AzureRmMlWebService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Update-AzureRmMlWebService.md ---- - -# Update-AzureRmMlWebService - -## SYNOPSIS -Updates properties of an existing web service resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### UpdateFromParameters -``` -Update-AzureRmMlWebService -ResourceGroupName <String> -Name <String> [-Title <String>] [-Description <String>] - [-IsReadOnly] [-Keys <WebServiceKeys>] [-StorageAccountKey <String>] [-Diagnostics <DiagnosticsConfiguration>] - [-RealtimeConfiguration <RealtimeConfiguration>] [-Assets <Hashtable>] - [-Input <ServiceInputOutputSpecification>] [-Output <ServiceInputOutputSpecification>] - [-Parameters <Hashtable>] [-Package <GraphPackage>] [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### UpdateFromObject -``` -Update-AzureRmMlWebService -ResourceGroupName <String> -Name <String> -ServiceUpdates <WebService> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Update-AzureRmMlWebService cmdlet allows you to update the non-static properties of a web service. -The cmdlet works as a patch operation. -Pass only the properties that you want modified. - -## EXAMPLES - -### Example 1: Selective update arguments -``` -Update-AzureRmMlWebService -ResourceGroupName "myresourcegroup" -Name "mywebservicename" -Description "new update to description" -Keys @{Primary='changed primary key'} -Diagnostics @{Level='All'} -``` - -Here, we change the description, primary access key and enable the diagnostics collection for all traces during runtime for the web service. - -### Example 2: Update based on a web service instance -``` -$updates = @{ Properties = @{ Title="New Title"; RealtimeConfiguration = @{ MaxConcurrentCalls=25 }}} - -Update-AzureRmMlWebService -ResourceGroupName "myresourcegroup" -Name "mywebservicename" -ServiceUpdates $updates -``` - -The example first creates a web service definition, that only contains the fields to be updated, and then calls the Update-AzureRmMlWebService to apply them using the ServiceUpdates parameter. - -## PARAMETERS - -### -Assets -The set of assets (e.g. modules, datasets) that make up the web service. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: UpdateFromParameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The new value for the web service's description. -This is visible in the service's Swagger API schema. - -```yaml -Type: System.String -Parameter Sets: UpdateFromParameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Diagnostics -The settings that control the diagnostics traces collection for the web service. - -```yaml -Type: Microsoft.Azure.Management.MachineLearning.WebServices.Models.DiagnosticsConfiguration -Parameter Sets: UpdateFromParameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Input -The definition for the web service's input(s), provided as a Swagger schema construct. - -```yaml -Type: Microsoft.Azure.Management.MachineLearning.WebServices.Models.ServiceInputOutputSpecification -Parameter Sets: UpdateFromParameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsReadOnly -Specifies that this web serviceis readonly. -Once set, the web service can longer be updated, including changing the value of this property, and can only be deleted. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: UpdateFromParameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Keys -Updates one or both of the access keys used to authenticate calls to the service's runtime APIs. - -```yaml -Type: Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebServiceKeys -Parameter Sets: UpdateFromParameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the web service resource to be updated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Output -The definition for the web service's output(s), provided as a Swagger schema construct. - -```yaml -Type: Microsoft.Azure.Management.MachineLearning.WebServices.Models.ServiceInputOutputSpecification -Parameter Sets: UpdateFromParameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Package -The definition of the graph package that defines this web service. - -```yaml -Type: Microsoft.Azure.Management.MachineLearning.WebServices.Models.GraphPackage -Parameter Sets: UpdateFromParameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Parameters -The set of global parameters values defined for the web service, given as a global parameter name -\> default value collection. -If no default value is specified, the parameter is considered to be required. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: UpdateFromParameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RealtimeConfiguration -Updates for the configuration of the service's realtime endpoint. - -```yaml -Type: Microsoft.Azure.Management.MachineLearning.WebServices.Models.RealtimeConfiguration -Parameter Sets: UpdateFromParameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group that contains the web service to be updated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceUpdates -A set of updates to apply to the web service provided as a web service definition instance. -Only non-static fields are modified. - -```yaml -Type: Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService -Parameter Sets: UpdateFromObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -StorageAccountKey -Rotates the access key for the storage account associated with the web service. - -```yaml -Type: System.String -Parameter Sets: UpdateFromParameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Title -The new value for the web service's title. -This is visible in the service's Swagger API schema. - -```yaml -Type: System.String -Parameter Sets: UpdateFromParameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService -Parameters: ServiceUpdates (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, machine, machine learning, azureml - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.MachineLearningCompute/AzureRM.MachineLearningCompute.md b/azurermps-6.13.0/AzureRM.MachineLearningCompute/AzureRM.MachineLearningCompute.md deleted file mode 100644 index f2aef59078..0000000000 --- a/azurermps-6.13.0/AzureRM.MachineLearningCompute/AzureRM.MachineLearningCompute.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -Module Name: AzureRM.MachineLearningCompute -Module Guid: bb030259-49f9-46ef-806f-2a3f5a2e018f -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.machinelearningcompute -Help Version: 0.4.2.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearningCompute/Commands.MachineLearningCompute/help/AzureRM.MachineLearningCompute.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearningCompute/Commands.MachineLearningCompute/help/AzureRM.MachineLearningCompute.md ---- - -# AzureRM.MachineLearningCompute Module -## Description -This topic displays help topics for the Azure Machine Learning Compute Cmdlets. - -## AzureRM.MachineLearningCompute Cmdlets -### [Get-AzureRmMlOpCluster](Get-AzureRmMlOpCluster.md) -Gets an operationalization cluster object. - -### [Get-AzureRmMlOpClusterKey](Get-AzureRmMlOpClusterKey.md) -Gets the access keys associated with an operationalization cluster. - -### [New-AzureRmMlOpCluster](New-AzureRmMlOpCluster.md) -Creates a new operationalization cluster. - -### [Remove-AzureRmMlOpCluster](Remove-AzureRmMlOpCluster.md) -Removes an operationalization cluster. - -### [Set-AzureRmMlOpCluster](Set-AzureRmMlOpCluster.md) -Sets the properties of an operationalization cluster. - -### [Test-AzureRmMlOpClusterSystemServicesUpdateAvailability](Test-AzureRmMlOpClusterSystemServicesUpdateAvailability.md) -Checks if there are updates available for the system services associated with an operationalization cluster. - -### [Update-AzureRmMlOpClusterSystemService](Update-AzureRmMlOpClusterSystemService.md) -Starts an update on the operationalization cluster's system services. - diff --git a/azurermps-6.13.0/AzureRM.MachineLearningCompute/Get-AzureRmMlOpCluster.md b/azurermps-6.13.0/AzureRM.MachineLearningCompute/Get-AzureRmMlOpCluster.md deleted file mode 100644 index 8634ebbc8b..0000000000 --- a/azurermps-6.13.0/AzureRM.MachineLearningCompute/Get-AzureRmMlOpCluster.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.MachineLearningCompute.dll-Help.xml -Module Name: AzureRM.MachineLearningCompute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.machinelearningcompute/get-azurermmlopcluster -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearningCompute/Commands.MachineLearningCompute/help/Get-AzureRmMlOpCluster.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearningCompute/Commands.MachineLearningCompute/help/Get-AzureRmMlOpCluster.md ---- - -# Get-AzureRmMlOpCluster - -## SYNOPSIS -Gets an operationalization cluster object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetByName -``` -Get-AzureRmMlOpCluster -ResourceGroupName <String> -Name <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### GetByResourceGroup -``` -Get-AzureRmMlOpCluster [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -Gets an operationalization cluster object by name, or by resource group, or by subscription. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmMlOpCluster -ResourceGroupName my-group -Name my-cluster -``` - -Gets a specific operationalization cluster by name. - -### Example 2 -``` -PS C:\> Get-AzureRmMlOpCluster -ResourceGroupName my-group -``` - -Gets all the operationalization clusters in a resource group. - -### Example 3 -``` -PS C:\> Get-AzureRmMlOpCluster -``` - -Gets all the operationalization clusters in a subscription. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the operationalization cluster. - -```yaml -Type: System.String -Parameter Sets: GetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group for the operationalization cluster. - -```yaml -Type: System.String -Parameter Sets: GetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: GetByResourceGroup -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.MachineLearningCompute.Models.PSOperationalizationCluster - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.MachineLearningCompute/Get-AzureRmMlOpClusterKey.md b/azurermps-6.13.0/AzureRM.MachineLearningCompute/Get-AzureRmMlOpClusterKey.md deleted file mode 100644 index 741f0ba209..0000000000 --- a/azurermps-6.13.0/AzureRM.MachineLearningCompute/Get-AzureRmMlOpClusterKey.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.MachineLearningCompute.dll-Help.xml -Module Name: AzureRM.MachineLearningCompute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.machinelearningcompute/get-azurermmlopclusterkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearningCompute/Commands.MachineLearningCompute/help/Get-AzureRmMlOpClusterKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearningCompute/Commands.MachineLearningCompute/help/Get-AzureRmMlOpClusterKey.md ---- - -# Get-AzureRmMlOpClusterKey - -## SYNOPSIS -Gets the access keys associated with an operationalization cluster. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetByNameAndResourceGroup -``` -Get-AzureRmMlOpClusterKey -ResourceGroupName <String> -Name <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### GetByInputObject -``` -Get-AzureRmMlOpClusterKey -InputObject <PSOperationalizationCluster> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### GetByResourceId -``` -Get-AzureRmMlOpClusterKey -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The keys for the storage account, container registry, and other services associated with the operationalization cluster are not returned when getting the cluster properties. A specific call to retrieve the keys must be made since they are sensitive information. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmMlOpClusterKey -ResourceGroupName my-group -Name my-cluster -``` - -Returns the secret keys for the services associated with the operationalization cluster. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The operationalization cluster object. - -```yaml -Type: Microsoft.Azure.Commands.MachineLearningCompute.Models.PSOperationalizationCluster -Parameter Sets: GetByInputObject -Aliases: Cluster - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the operationalization cluster. - -```yaml -Type: System.String -Parameter Sets: GetByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group for the operationalization cluster. - -```yaml -Type: System.String -Parameter Sets: GetByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource id for the operationalization cluster. - -```yaml -Type: System.String -Parameter Sets: GetByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.MachineLearningCompute.Models.PSOperationalizationCluster -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.MachineLearningCompute.Models.PSOperationalizationClusterCredentials - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.MachineLearningCompute/New-AzureRmMlOpCluster.md b/azurermps-6.13.0/AzureRM.MachineLearningCompute/New-AzureRmMlOpCluster.md deleted file mode 100644 index 6959a29e58..0000000000 --- a/azurermps-6.13.0/AzureRM.MachineLearningCompute/New-AzureRmMlOpCluster.md +++ /dev/null @@ -1,417 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.MachineLearningCompute.dll-Help.xml -Module Name: AzureRM.MachineLearningCompute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.machinelearningcompute/new-azurermmlopcluster -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearningCompute/Commands.MachineLearningCompute/help/New-AzureRmMlOpCluster.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearningCompute/Commands.MachineLearningCompute/help/New-AzureRmMlOpCluster.md ---- - -# New-AzureRmMlOpCluster - -## SYNOPSIS -Creates a new operationalization cluster. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### CreateWithInputObject -``` -New-AzureRmMlOpCluster -ResourceGroupName <String> -Name <String> -InputObject <PSOperationalizationCluster> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### CreateWithParameters -``` -New-AzureRmMlOpCluster -ResourceGroupName <String> -Name <String> -Location <String> -ClusterType <String> - [-OrchestratorType <String>] [-ClientId <String>] [-Secret <String>] [-Description <String>] - [-MasterCount <Int32>] [-AgentCount <Int32>] [-AgentVmSize <String>] - [-GlobalServiceConfigurationETag <String>] [-SslStatus <String>] [-SslCertificate <String>] [-SslKey <String>] - [-SslCName <String>] [-StorageAccount <String>] [-AzureContainerRegistry <String>] - [-DefaultProfile <IAzureContextContainer>] [-GlobalServiceConfigurationAdditionalProperties <Hashtable>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Creates a new operationalization cluster. This will create a cluster object, a container service if needed, application insights, and an azure container registry. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmMlOpCluster -ResourceGroupName my-group -Name my-cluster -Location "East US 2" -ClusterType "ACS" -OrchestratorType "Kubernetes" -ClientId "abc" -Secret "xyz" -``` - -Creates a new operationalization cluster with azure container service and Kubernetes as the orchestrator. - -### Example 2 -``` -PS C:\> New-AzureRmMlOpCluster -ResourceGroupName my-group -Name my-cluster -Location "East US 2" -ClusterType "Local" -``` - -Creates a new operationalization cluster locally. This creates an azure container registry, application insights, and storage account, but does not create a container service. - -## PARAMETERS - -### -AgentCount -The number of agent nodes in the ACS cluster. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: CreateWithParameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AgentVmSize -The number of agent nodes in the ACS cluster. - -```yaml -Type: System.String -Parameter Sets: CreateWithParameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AzureContainerRegistry -The URI to the azure container registry to use instead of creating one. - -```yaml -Type: System.String -Parameter Sets: CreateWithParameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientId -The ACS cluster's orchestrator service principal id. - -```yaml -Type: System.String -Parameter Sets: CreateWithParameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClusterType -The operationalization cluster type. - -```yaml -Type: System.String -Parameter Sets: CreateWithParameters -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The number of master nodes in the ACS cluster. - -```yaml -Type: System.String -Parameter Sets: CreateWithParameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GlobalServiceConfigurationAdditionalProperties -Additional properties for the global service configuration. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: CreateWithParameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GlobalServiceConfigurationETag -The configuration ETag for updates. - -```yaml -Type: System.String -Parameter Sets: CreateWithParameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The operationalization cluster properties. - -```yaml -Type: Microsoft.Azure.Commands.MachineLearningCompute.Models.PSOperationalizationCluster -Parameter Sets: CreateWithInputObject -Aliases: Cluster - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The operationalization cluster's location. - -```yaml -Type: System.String -Parameter Sets: CreateWithParameters -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MasterCount -The number of master nodes in the ACS cluster. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: CreateWithParameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the operationalization cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrchestratorType -The ACS cluster's orchestrator type. - -```yaml -Type: System.String -Parameter Sets: CreateWithParameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group for the operationalization cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Secret -The ACS cluster's orchestrator service principal secret. - -```yaml -Type: System.String -Parameter Sets: CreateWithParameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SslCertificate -The SSL certificate data in PEM format encoded as base64 string. - -```yaml -Type: System.String -Parameter Sets: CreateWithParameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SslCName -The CName for the SSL certificate. - -```yaml -Type: System.String -Parameter Sets: CreateWithParameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SslKey -The SSL key data in PEM format encoded as base64 string. - -```yaml -Type: System.String -Parameter Sets: CreateWithParameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SslStatus -SSL status. -Possible values are 'Enabled' and 'Disabled'. - -```yaml -Type: System.String -Parameter Sets: CreateWithParameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageAccount -The URI to the storage account to use instead of creating one. - -```yaml -Type: System.String -Parameter Sets: CreateWithParameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.MachineLearningCompute.Models.PSOperationalizationCluster - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.MachineLearningCompute/Remove-AzureRmMlOpCluster.md b/azurermps-6.13.0/AzureRM.MachineLearningCompute/Remove-AzureRmMlOpCluster.md deleted file mode 100644 index d5064cbc22..0000000000 --- a/azurermps-6.13.0/AzureRM.MachineLearningCompute/Remove-AzureRmMlOpCluster.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.MachineLearningCompute.dll-Help.xml -Module Name: AzureRM.MachineLearningCompute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.machinelearningcompute/remove-azurermmlopcluster -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearningCompute/Commands.MachineLearningCompute/help/Remove-AzureRmMlOpCluster.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearningCompute/Commands.MachineLearningCompute/help/Remove-AzureRmMlOpCluster.md ---- - -# Remove-AzureRmMlOpCluster - -## SYNOPSIS -Removes an operationalization cluster. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RemoveByNameAndResourceGroup (Default) -``` -Remove-AzureRmMlOpCluster -ResourceGroupName <String> -Name <String> [-IncludeAllResources] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RemoveByInputObject -``` -Remove-AzureRmMlOpCluster -InputObject <PSOperationalizationCluster> [-IncludeAllResources] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RemoveByResourceId -``` -Remove-AzureRmMlOpCluster -ResourceId <String> [-IncludeAllResources] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Removes an operationalization cluster. Some resources associated with the cluster might not all be removed. For example, the Azure container service will get removed, but the associated VMs do not. The storage account, container registry, and application insights are not removed for diagnostic information. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmMlOpCluster -ResourceGroupName my-group -Name my-cluster -``` - -### Example 2 -``` -PS C:\> Get-AzureRmMlOpCluster -ResourceGroupName my-group -Name my-cluster | Remove-AzureRmMlOpCluster -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeAllResources -Removes all resources that were created with the cluster. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The operationalization cluster object. - -```yaml -Type: Microsoft.Azure.Commands.MachineLearningCompute.Models.PSOperationalizationCluster -Parameter Sets: RemoveByInputObject -Aliases: Cluster - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the operationalization cluster. - -```yaml -Type: System.String -Parameter Sets: RemoveByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group for the operationalization cluster. - -```yaml -Type: System.String -Parameter Sets: RemoveByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource id for the operationalization cluster. - -```yaml -Type: System.String -Parameter Sets: RemoveByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.MachineLearningCompute.Models.PSOperationalizationCluster -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.MachineLearningCompute/Set-AzureRmMlOpCluster.md b/azurermps-6.13.0/AzureRM.MachineLearningCompute/Set-AzureRmMlOpCluster.md deleted file mode 100644 index 342240bc4e..0000000000 --- a/azurermps-6.13.0/AzureRM.MachineLearningCompute/Set-AzureRmMlOpCluster.md +++ /dev/null @@ -1,325 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.MachineLearningCompute.dll-Help.xml -Module Name: AzureRM.MachineLearningCompute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.machinelearningcompute/set-azurermmlopcluster -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearningCompute/Commands.MachineLearningCompute/help/Set-AzureRmMlOpCluster.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearningCompute/Commands.MachineLearningCompute/help/Set-AzureRmMlOpCluster.md ---- - -# Set-AzureRmMlOpCluster - -## SYNOPSIS -Sets the properties of an operationalization cluster. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByIndividualParameters (Default) -``` -Set-AzureRmMlOpCluster -ResourceGroupName <String> -Name <String> [-AgentCount <Int32>] [-SslStatus <String>] - [-SslCertificate <String>] [-SslKey <String>] [-SslCName <String>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByInputObject -``` -Set-AzureRmMlOpCluster -InputObject <PSOperationalizationCluster> [-AgentCount <Int32>] [-SslStatus <String>] - [-SslCertificate <String>] [-SslKey <String>] [-SslCName <String>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByResourceId -``` -Set-AzureRmMlOpCluster -ResourceId <String> [-AgentCount <Int32>] [-SslStatus <String>] - [-SslCertificate <String>] [-SslKey <String>] [-SslCName <String>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Sets all the properties of an operationalization cluster. Since it sets all the properties when using a cluster -object a fully valid input object must be passed. Read-only properties will be ignored. Only some properties -are currently updatable, as shown in the parameter sets. - -## EXAMPLES - -### Example 1 -Update a cluster using individual parameters. - -``` -PS C:\> Set-AzureRmMlOpCluster -ResourceGroupName my-rg -ClusterName my-cluster -AgentCount 5 -``` - -### Example 2 -Update a cluster using an input object. - -``` -PS C:\> $cluster = Get-AzureRmMlOpCluster -ResourceGroupName my-rg -ClusterName my-cluster -PS C:\> $cluster.ContainerService.AgentCount = 5 -PS C:\> Set-AzureRmMlOpCluster -InputObject $cluster -``` - -## PARAMETERS - -### -AgentCount -The number of agent nodes in the ACS cluster. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: SetByIndividualParameters, SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: SetByInputObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The operationalization cluster properties. - -```yaml -Type: Microsoft.Azure.Commands.MachineLearningCompute.Models.PSOperationalizationCluster -Parameter Sets: SetByInputObject -Aliases: Cluster - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the operationalization cluster. - -```yaml -Type: System.String -Parameter Sets: SetByIndividualParameters -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group for the operationalization cluster. - -```yaml -Type: System.String -Parameter Sets: SetByIndividualParameters -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource id for the operationalization cluster. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SslCertificate -The SSL certificate data in PEM format. - -```yaml -Type: System.String -Parameter Sets: SetByIndividualParameters, SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: SetByInputObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SslCName -The CName for the SSL certificate. - -```yaml -Type: System.String -Parameter Sets: SetByIndividualParameters, SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: SetByInputObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SslKey -The SSL key data in PEM format. - -```yaml -Type: System.String -Parameter Sets: SetByIndividualParameters, SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: SetByInputObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SslStatus -SSL status. -Possible values are 'Enabled' and 'Disabled'. - -```yaml -Type: System.String -Parameter Sets: SetByIndividualParameters, SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: SetByInputObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.MachineLearningCompute.Models.PSOperationalizationCluster -Parameters: InputObject (ByValue) - -### System.String - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.MachineLearningCompute.Models.PSOperationalizationCluster - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.MachineLearningCompute/Test-AzureRmMlOpClusterSystemServicesUpdateAvailability.md b/azurermps-6.13.0/AzureRM.MachineLearningCompute/Test-AzureRmMlOpClusterSystemServicesUpdateAvailability.md deleted file mode 100644 index 35b5f03a49..0000000000 --- a/azurermps-6.13.0/AzureRM.MachineLearningCompute/Test-AzureRmMlOpClusterSystemServicesUpdateAvailability.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.MachineLearningCompute.dll-Help.xml -Module Name: AzureRM.MachineLearningCompute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.machinelearningcompute/test-azurermmlopclustersystemservicesupdateavailability -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearningCompute/Commands.MachineLearningCompute/help/Test-AzureRmMlOpClusterSystemServicesUpdateAvailability.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearningCompute/Commands.MachineLearningCompute/help/Test-AzureRmMlOpClusterSystemServicesUpdateAvailability.md ---- - -# Test-AzureRmMlOpClusterSystemServicesUpdateAvailability - -## SYNOPSIS -Checks if there are updates available for the system services associated with an operationalization cluster. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### TestByNameAndResourceGroup -``` -Test-AzureRmMlOpClusterSystemServicesUpdateAvailability -ResourceGroupName <String> -Name <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### TestByInputObject -``` -Test-AzureRmMlOpClusterSystemServicesUpdateAvailability -InputObject <PSOperationalizationCluster> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### TestByResourceId -``` -Test-AzureRmMlOpClusterSystemServicesUpdateAvailability -ResourceId <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -System services receive updates independently from the operationalization cluster. Using this cmdlet will let the user know if Invoke-AzureRmMlOpClusterSystemServicesUpdate. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Test-AzureRmMlOpClusterSystemServicesUpdateAvailability -ResourceGroupName my-group -Name my-cluster -``` - -### Example 2 -``` -PS C:\> Get-AzureRmMlOpCluster | Test-AzureRmMlOpClusterSystemServicesUpdateAvailability -``` - -### Example 3 -``` -PS C:\> Find-AzureRmResource -ResourceType Microsoft.MachineLearningCompute/operationalizationClusters | Test-AzureRmMlOpClusterSystemServicesUpdateAvailability -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The operationalization cluster object. - -```yaml -Type: Microsoft.Azure.Commands.MachineLearningCompute.Models.PSOperationalizationCluster -Parameter Sets: TestByInputObject -Aliases: Cluster - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the operationalization cluster. - -```yaml -Type: System.String -Parameter Sets: TestByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group for the operationalization cluster. - -```yaml -Type: System.String -Parameter Sets: TestByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource id for the operationalization cluster. - -```yaml -Type: System.String -Parameter Sets: TestByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.MachineLearningCompute.Models.PSOperationalizationCluster -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.MachineLearningCompute.Models.PSCheckSystemServicesUpdatesAvailableResponse - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.MachineLearningCompute/Update-AzureRmMlOpClusterSystemService.md b/azurermps-6.13.0/AzureRM.MachineLearningCompute/Update-AzureRmMlOpClusterSystemService.md deleted file mode 100644 index 755e9f7901..0000000000 --- a/azurermps-6.13.0/AzureRM.MachineLearningCompute/Update-AzureRmMlOpClusterSystemService.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.MachineLearningCompute.dll-Help.xml -Module Name: AzureRM.MachineLearningCompute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.machinelearningcompute/update-azurermmlopclustersystemservice -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearningCompute/Commands.MachineLearningCompute/help/Update-AzureRmMlOpClusterSystemService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MachineLearningCompute/Commands.MachineLearningCompute/help/Update-AzureRmMlOpClusterSystemService.md ---- - -# Update-AzureRmMlOpClusterSystemService - -## SYNOPSIS -Starts an update on the operationalization cluster's system services. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### StartUpdateWithNameAndResourceGroup -``` -Update-AzureRmMlOpClusterSystemService -ResourceGroupName <String> -Name <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### StartUpdateWithInputObject -``` -Update-AzureRmMlOpClusterSystemService -InputObject <PSOperationalizationCluster> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### StartUpdateWithResourceId -``` -Update-AzureRmMlOpClusterSystemService -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The system services can be updated independently from the operationalization cluster. To start an update on the system services use this cmdlet. If no update is available an update will still be started and will return successfully. Once the update is finished it reports when it started, finished, and if it was successful. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Update-AzureRmMlOpClusterSystemService -ResourceGroupName my-group -Name my-cluster -``` - -Starts a system services update on the specified cluster. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The operationalization cluster object. - -```yaml -Type: Microsoft.Azure.Commands.MachineLearningCompute.Models.PSOperationalizationCluster -Parameter Sets: StartUpdateWithInputObject -Aliases: Cluster - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the operationalization cluster. - -```yaml -Type: System.String -Parameter Sets: StartUpdateWithNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group for the operationalization cluster. - -```yaml -Type: System.String -Parameter Sets: StartUpdateWithNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource id for the operationalization cluster. - -```yaml -Type: System.String -Parameter Sets: StartUpdateWithResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.MachineLearningCompute.Models.PSOperationalizationCluster -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.MachineLearningCompute.Models.PSUpdateSystemServicesResponse - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ManagedServiceIdentity/AzureRM.ManagedServiceIdentity.md b/azurermps-6.13.0/AzureRM.ManagedServiceIdentity/AzureRM.ManagedServiceIdentity.md deleted file mode 100644 index 2756aa4f29..0000000000 --- a/azurermps-6.13.0/AzureRM.ManagedServiceIdentity/AzureRM.ManagedServiceIdentity.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -Module Name: AzureRM.ManagedServiceIdentity -Module Guid: 2a27df8b-15e3-4fb9-b885-22c6bcafc203 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.managedserviceidentity -Help Version: 1.0.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ManagedServiceIdentity/Commands.ManagedServiceIdentity/help/AzureRM.ManagedServiceIdentity.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ManagedServiceIdentity/Commands.ManagedServiceIdentity/help/AzureRM.ManagedServiceIdentity.md ---- - -# AzureRM.ManagedServiceIdentity Module -## Description -This topic displays the help topics for the Azure Managed Service Identity Cmdlets. - -## AzureRM.ManagedServiceIdentity Cmdlets -### [Get-AzureRmUserAssignedIdentity](Get-AzureRmUserAssignedIdentity.md) -Gets User Assigned Identity/identities. - -### [New-AzureRmUserAssignedIdentity](New-AzureRmUserAssignedIdentity.md) -Creates a new User Assigned Identity or updates an existing User Assigned Identity. - -### [Remove-AzureRmUserAssignedIdentity](Remove-AzureRmUserAssignedIdentity.md) -Removes a User Assigned Identity. - diff --git a/azurermps-6.13.0/AzureRM.ManagedServiceIdentity/Get-AzureRmUserAssignedIdentity.md b/azurermps-6.13.0/AzureRM.ManagedServiceIdentity/Get-AzureRmUserAssignedIdentity.md deleted file mode 100644 index f0128a6376..0000000000 --- a/azurermps-6.13.0/AzureRM.ManagedServiceIdentity/Get-AzureRmUserAssignedIdentity.md +++ /dev/null @@ -1,227 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ManagedServiceIdentity.dll-Help.xml -Module Name: AzureRM.ManagedServiceIdentity -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.managedserviceidentity/get-azurermuserassignedidentity -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ManagedServiceIdentity/Commands.ManagedServiceIdentity/help/Get-AzureRmUserAssignedIdentity.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ManagedServiceIdentity/Commands.ManagedServiceIdentity/help/Get-AzureRmUserAssignedIdentity.md ---- - -# Get-AzureRmUserAssignedIdentity - -## SYNOPSIS -Gets User Assigned Identity/identities. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SuscriptionParameterSet (Default) -``` -Get-AzureRmUserAssignedIdentity [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceGroupParameterSet -``` -Get-AzureRmUserAssignedIdentity -ResourceGroupName <String> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmUserAssignedIdentity** gets existing user assigned identities. - -## EXAMPLES - -### Example 1 -This example cmdlet gets the User Assigned Identity with name **ID1** under the resource group **PSRG** - -```powershell -PS C:\> Get-AzureRmUserAssignedIdentity -ResourceGroupName PSRG -Name ID1 - -Id : /subscriptions/586d0246-0344-49dc-a790-59c916b0c309/resourcegroups/PSRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ID1 - -ResourceGroupName : PSRG - -Name : ID1 - -Location : westus - -TenantId : 00001111-aaaa-2222-bbbb-3333cccc4444 - -PrincipalId : 00001111-aaaa-2222-bbbb-3333cccc4444 - -ClientId : 00001111-aaaa-2222-bbbb-3333cccc4444 - -ClientSecretUrl : https://control-westus.identity.azure.net/subscriptions/586d0246-0344-49dc-a790-59c916b0c309/resourcegroups/PSRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ID1/credentials?tid=00001111-aaaa-2222-bbbb-3333cccc4444&oid=00001111-aaaa-2222-bbbb-3333cccc4444&aid=00001111-aaaa-2222-bbbb-3333cccc4444 - -Type : Microsoft.ManagedIdentity/userAssignedIdentities -``` - -### Example 2 -This example cmdlet gets all the User Assigned Identities under the resource group **PSRG** - -```powershell -PS C:\> Get-AzureRmUserAssignedIdentity -ResourceGroupName PSRG - -Id : /subscriptions/586d0246-0344-49dc-a790-59c916b0c309/resourcegroups/PSRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ID1 - -ResourceGroupName : PSRG - -Name : ID1 - -Location : westus - -TenantId : 00001111-aaaa-2222-bbbb-3333cccc4444 - -PrincipalId : 00001111-aaaa-2222-bbbb-3333cccc4444 - -ClientId : 00001111-aaaa-2222-bbbb-3333cccc4444 - -ClientSecretUrl : https://control-westus.identity.azure.net/subscriptions/586d0246-0344-49dc-a790-59c916b0c309/resourcegroups/PSRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ID1/credentials?tid=00001111-aaaa-2222-bbbb-3333cccc4444&oid=00001111-aaaa-2222-bbbb-3333cccc4444&aid=00001111-aaaa-2222-bbbb-3333cccc4444 - -Type : Microsoft.ManagedIdentity/userAssignedIdentities - - -Id : /subscriptions/586d0246-0344-49dc-a790-59c916b0c309/resourcegroups/PSRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ID2 - -ResourceGroupName : PSRG - -Name : ID2 - -Location : westus - -TenantId : 00001111-aaaa-2222-bbbb-3333cccc4444 - -PrincipalId : 00001111-aaaa-2222-bbbb-3333cccc4444 - -ClientId : 00001111-aaaa-2222-bbbb-3333cccc4444 - -ClientSecretUrl : https://control-westus.identity.azure.net/subscriptions/586d0246-0344-49dc-a790-59c916b0c309/resourcegroups/PSRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ID2/credentials?tid=00001111-aaaa-2222-bbbb-3333cccc4444&oid=00001111-aaaa-2222-bbbb-3333cccc4444&aid=00001111-aaaa-2222-bbbb-3333cccc4444 - -Type : Microsoft.ManagedIdentity/userAssignedIdentities -``` - -### Example 3 -This example cmdlet gets all the User Assigned Identities under the subscription. - -```powershell -PS C:\> Get-AzureRmUserAssignedIdentity - -Id : /subscriptions/586d0246-0344-49dc-a790-59c916b0c309/resourcegroups/PSRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ID1 - -ResourceGroupName : PSRG - -Name : ID1 - -Location : westus - -TenantId : 00001111-aaaa-2222-bbbb-3333cccc4444 - -PrincipalId : 00001111-aaaa-2222-bbbb-3333cccc4444 - -ClientId : 00001111-aaaa-2222-bbbb-3333cccc4444 - -ClientSecretUrl : https://control-westus.identity.azure.net/subscriptions/586d0246-0344-49dc-a790-59c916b0c309/resourcegroups/PSRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ID1/credentials?tid=00001111-aaaa-2222-bbbb-3333cccc4444&oid=00001111-aaaa-2222-bbbb-3333cccc4444&aid=00001111-aaaa-2222-bbbb-3333cccc4444 - -Type : Microsoft.ManagedIdentity/userAssignedIdentities - - -Id : /subscriptions/586d0246-0344-49dc-a790-59c916b0c309/resourcegroups/PSRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ID2 - -ResourceGroupName : PSRG - -Name : ID2 - -Location : westus - -TenantId : 00001111-aaaa-2222-bbbb-3333cccc4444 - -PrincipalId : 00001111-aaaa-2222-bbbb-3333cccc4444 - -ClientId : 00001111-aaaa-2222-bbbb-3333cccc4444 - -ClientSecretUrl : https://control-westus.identity.azure.net/subscriptions/586d0246-0344-49dc-a790-59c916b0c309/resourcegroups/PSRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ID2/credentials?tid=00001111-aaaa-2222-bbbb-3333cccc4444&oid=00001111-aaaa-2222-bbbb-3333cccc4444&aid=00001111-aaaa-2222-bbbb-3333cccc4444 - -Type : Microsoft.ManagedIdentity/userAssignedIdentities - - -Id : /subscriptions/586d0246-0344-49dc-a790-59c916b0c309/resourcegroups/PSRG2/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ID1 - -ResourceGroupName : PSRG2 - -Name : ID1 - -Location : westus - -TenantId : 00001111-aaaa-2222-bbbb-3333cccc4444 - -PrincipalId : 00001111-aaaa-2222-bbbb-3333cccc4444 - -ClientId : 00001111-aaaa-2222-bbbb-3333cccc4444 - -ClientSecretUrl : https://control-westus.identity.azure.net/subscriptions/586d0246-0344-49dc-a790-59c916b0c309/resourcegroups/PSRG2/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ID1/credentials?tid=00001111-aaaa-2222-bbbb-3333cccc4444&oid=00001111-aaaa-2222-bbbb-3333cccc4444&aid=00001111-aaaa-2222-bbbb-3333cccc4444 - -Type : Microsoft.ManagedIdentity/userAssignedIdentities -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Identity name. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ManagedServiceIdentity.Models.PsUserAssignedIdentity - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ManagedServiceIdentity/New-AzureRmUserAssignedIdentity.md b/azurermps-6.13.0/AzureRM.ManagedServiceIdentity/New-AzureRmUserAssignedIdentity.md deleted file mode 100644 index d7cc9d67d0..0000000000 --- a/azurermps-6.13.0/AzureRM.ManagedServiceIdentity/New-AzureRmUserAssignedIdentity.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ManagedServiceIdentity.dll-Help.xml -Module Name: AzureRM.ManagedServiceIdentity -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.managedserviceidentity/new-azurermuserassignedidentity -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ManagedServiceIdentity/Commands.ManagedServiceIdentity/help/New-AzureRmUserAssignedIdentity.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ManagedServiceIdentity/Commands.ManagedServiceIdentity/help/New-AzureRmUserAssignedIdentity.md ---- - -# New-AzureRmUserAssignedIdentity - -## SYNOPSIS -Creates a new User Assigned Identity or updates an existing User Assigned Identity. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmUserAssignedIdentity [-ResourceGroupName] <String> [-Name] <String> [-Location <String>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-Tag <Hashtable>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmUserAssignedIdentity** cmdlet creates a new User Assigned Identity. When used with an already existing identity, it updated the identity. -To add Azure Resource Manager tags to the identity, please use the Set-AzureRmResource cmdlet. - -## EXAMPLES - -### Example 1 -This example cmdlet creates a new User Assigned Identity with name **ID1** under resource group **PSRG** in the location of the ResourceGroup. - -```powershell -PS C:\> New-AzureRmUserAssignedIdentity -ResourceGroupName PSRG -Name ID1 - -Id : /subscriptions/586d0246-0344-49dc-a790-59c916b0c309/resourcegroups/PSRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ID1 - -ResourceGroupName : PSRG - -Name : ID1 - -Location : centralus - -TenantId : 00001111-aaaa-2222-bbbb-3333cccc4444 - -PrincipalId : 00001111-aaaa-2222-bbbb-3333cccc4444 - -ClientId : 00001111-aaaa-2222-bbbb-3333cccc4444 - -ClientSecretUrl : https://control-westus.identity.azure.net/subscriptions/586d0246-0344-49dc-a790-59c916b0c309/resourcegroups/PSRG1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ID1/credentials?tid=00001111-aaaa-2222-bbbb-3333cccc4444&oid=00001111-aaaa-2222-bbbb-3333cccc4444&aid=00001111-aaaa-2222-bbbb-3333cccc4444 - -Type : Microsoft.ManagedIdentity/userAssignedIdentities -``` - -### Example 2 -This example cmdlet creates a new User Assigned Identity with name **ID1** under the resource group **PSRG** in the westus region. - -```powershell -PS C:\> New-AzureRmUserAssignedIdentity -ResourceGroupName PSRG -Name ID1 -Location westus - -Id : /subscriptions/586d0246-0344-49dc-a790-59c916b0c309/resourcegroups/PSRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ID1 - -ResourceGroupName : PSRG - -Name : ID1 - -Location : westus - -TenantId : 00001111-aaaa-2222-bbbb-3333cccc4444 - -PrincipalId : 00001111-aaaa-2222-bbbb-3333cccc4444 - -ClientId : 00001111-aaaa-2222-bbbb-3333cccc4444 - -ClientSecretUrl : https://control-westus.identity.azure.net/subscriptions/586d0246-0344-49dc-a790-59c916b0c309/resourcegroups/PSRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ID1/credentials?tid=00001111-aaaa-2222-bbbb-3333cccc4444&oid=00001111-aaaa-2222-bbbb-3333cccc4444&aid=00001111-aaaa-2222-bbbb-3333cccc4444 - -Type : Microsoft.ManagedIdentity/userAssignedIdentities -``` - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The Azure region name where the Identity should be created. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The Identity name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -The Azure Resource Manager tags associated with the identity. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.ManagedServiceIdentity.Models.PsUserAssignedIdentity - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ManagedServiceIdentity/Remove-AzureRmUserAssignedIdentity.md b/azurermps-6.13.0/AzureRM.ManagedServiceIdentity/Remove-AzureRmUserAssignedIdentity.md deleted file mode 100644 index 9de1cb9a03..0000000000 --- a/azurermps-6.13.0/AzureRM.ManagedServiceIdentity/Remove-AzureRmUserAssignedIdentity.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ManagedServiceIdentity.dll-Help.xml -Module Name: AzureRM.ManagedServiceIdentity -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.managedserviceidentity/remove-azurermuserassignedidentity -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ManagedServiceIdentity/Commands.ManagedServiceIdentity/help/Remove-AzureRmUserAssignedIdentity.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ManagedServiceIdentity/Commands.ManagedServiceIdentity/help/Remove-AzureRmUserAssignedIdentity.md ---- - -# Remove-AzureRmUserAssignedIdentity - -## SYNOPSIS -Removes a User Assigned Identity. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceGroupAndNameParameterSet (Default) -``` -Remove-AzureRmUserAssignedIdentity [-ResourceGroupName] <String> [-Name] <String> [-AsJob] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectParameterSet -``` -Remove-AzureRmUserAssignedIdentity -InputObject <PsUserAssignedIdentity> [-AsJob] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Remove-AzureRmUserAssignedIdentity -ResourceId <String> [-AsJob] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmUserAssignedIdentity** deletes the specified User Assigned Identity. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-AzurRmUserAssignedIdentity -ResourceGroupName PSRG -Name ID1 -``` - -This example cmdlet deletes the identity **ID1** under resource group **PSRG**. -True - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -{{Fill Force Description}} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The Identity object. - -```yaml -Type: Microsoft.Azure.Commands.ManagedServiceIdentity.Models.PsUserAssignedIdentity -Parameter Sets: InputObjectParameterSet -Aliases: Identity - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The Identity name. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupAndNameParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupAndNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The Identity's resource id. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ManagedServiceIdentity.Models.PsUserAssignedIdentity -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ManagementPartner/AzureRM.ManagementPartner.md b/azurermps-6.13.0/AzureRM.ManagementPartner/AzureRM.ManagementPartner.md deleted file mode 100644 index 7570d62077..0000000000 --- a/azurermps-6.13.0/AzureRM.ManagementPartner/AzureRM.ManagementPartner.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -Module Name: AzureRM.ManagementPartner -Module Guid: bf60f35d-6c0b-42f2-be30-eb333a31279d -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.managementpartner -Help Version: 0.1.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ManagementPartner/Commands.Partner/help/AzureRM.ManagementPartner.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ManagementPartner/Commands.Partner/help/AzureRM.ManagementPartner.md ---- - -# AzureRM.ManagementPartner Module -## Description -Management Partner cmdlets for Azure Resource Manager. - -## AzureRM.ManagementPartner Cmdlets -### [Get-AzureRmManagementPartner](Get-AzureRmManagementPartner.md) -Gets the Microsoft Partner Network(MPN) ID of the current authenticated user or service principal. - -### [New-AzureRmManagementPartner](New-AzureRmManagementPartner.md) -Associates a Microsoft Partner Network(MPN) ID to the current authenticated user or service principal. - -### [Remove-AzureRmManagementPartner](Remove-AzureRmManagementPartner.md) -Delete the Microsoft Partner Network(MPN) ID of the current authenticated user or service principal. - -### [Update-AzureRmManagementPartner](Update-AzureRmManagementPartner.md) -Updates the Microsoft Partner Network(MPN) ID of the current authenticated user or service principal. - diff --git a/azurermps-6.13.0/AzureRM.ManagementPartner/Get-AzureRmManagementPartner.md b/azurermps-6.13.0/AzureRM.ManagementPartner/Get-AzureRmManagementPartner.md deleted file mode 100644 index 42506aab0f..0000000000 --- a/azurermps-6.13.0/AzureRM.ManagementPartner/Get-AzureRmManagementPartner.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ManagementPartner.dll-Help.xml -Module Name: AzureRM.ManagementPartner -online version: https://docs.microsoft.com/en-us/powershell/module/get-azurermmanagementpartner -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ManagementPartner/Commands.Partner/help/Get-AzureRmManagementPartner.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ManagementPartner/Commands.Partner/help/Get-AzureRmManagementPartner.md ---- - -# Get-AzureRmManagementPartner - -## SYNOPSIS -Gets the Microsoft Partner Network(MPN) ID of the current authenticated user or service principal. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmManagementPartner [[-PartnerId] <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -Gets the Microsoft Partner Network(MPN) ID of the current authenticated user or service principal. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmManagementPartner -PartnerId : 4977985 -PartnerName : Test_Test_DPORTest -TenantId : 00001111-aaaa-2222-bbbb-3333cccc4444 -ObjectId : 00001111-aaaa-2222-bbbb-3333cccc4444 -State : Active -``` - -Get the current management partner id - -### Example 2 -```powershell -PS C:\> Get-AzureRmManagementPartner -PartnerId 4977985 -PartnerId : 4977985 -PartnerName : Test_Test_DPORTest -TenantId : 00001111-aaaa-2222-bbbb-3333cccc4444 -ObjectId : 00001111-aaaa-2222-bbbb-3333cccc4444 -State : Active -``` - -Get the current management partner id using a partner id, if they don't match, it will fail - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PartnerId -The management partner id, it is a 6 digits number - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.ManagementPartner.PSManagementPartner - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmManagementPartner](./Remove-AzureRmManagementPartner.md) - -[New-AzureRmManagementPartner](./New-AzureRmManagementPartner.md) - -[Update-AzureRmManagementPartner](./Update-AzureRmManagementPartner.md) diff --git a/azurermps-6.13.0/AzureRM.ManagementPartner/New-AzureRmManagementPartner.md b/azurermps-6.13.0/AzureRM.ManagementPartner/New-AzureRmManagementPartner.md deleted file mode 100644 index 0c16b91157..0000000000 --- a/azurermps-6.13.0/AzureRM.ManagementPartner/New-AzureRmManagementPartner.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ManagementPartner.dll-Help.xml -Module Name: AzureRM.ManagementPartner -online version: https://go.microsoft.com/fwlink/?LinkID=393044 -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ManagementPartner/Commands.Partner/help/New-AzureRmManagementPartner.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ManagementPartner/Commands.Partner/help/New-AzureRmManagementPartner.md ---- - -# New-AzureRmManagementPartner - -## SYNOPSIS -Associates a Microsoft Partner Network(MPN) ID to the current authenticated user or service principal. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmManagementPartner [-PartnerId] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Associates a Microsoft Partner Network(MPN) ID to the current authenticated user or service principal. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-AzureRmManagementPartner -PartnerId 4977985 -PartnerId : 4977985 -PartnerName : Test_Test_DPORTest -TenantId : 00001111-aaaa-2222-bbbb-3333cccc4444 -ObjectId : 00001111-aaaa-2222-bbbb-3333cccc4444 -State : Active -``` - -Add a management partner - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PartnerId -The management partner id, it is a 6 digits number - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.ManagementPartner.PSManagementPartner - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmManagementPartner](./Remove-AzureRmManagementPartner.md) - -[Get-AzureRmManagementPartner](./Get-AzureRmManagementPartner.md) - -[Update-AzureRmManagementPartner](./Update-AzureRmManagementPartner.md) diff --git a/azurermps-6.13.0/AzureRM.ManagementPartner/Remove-AzureRmManagementPartner.md b/azurermps-6.13.0/AzureRM.ManagementPartner/Remove-AzureRmManagementPartner.md deleted file mode 100644 index cc1a16e74a..0000000000 --- a/azurermps-6.13.0/AzureRM.ManagementPartner/Remove-AzureRmManagementPartner.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ManagementPartner.dll-Help.xml -Module Name: AzureRM.ManagementPartner -online version: https://go.microsoft.com/fwlink/?LinkID=393045 -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ManagementPartner/Commands.Partner/help/Remove-AzureRmManagementPartner.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ManagementPartner/Commands.Partner/help/Remove-AzureRmManagementPartner.md ---- - -# Remove-AzureRmManagementPartner - -## SYNOPSIS -Delete the Microsoft Partner Network(MPN) ID of the current authenticated user or service principal. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmManagementPartner [-PartnerId] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Delete the Microsoft Partner Network(MPN) ID of the current authenticated user or service principal. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\>Remove-AzureRmManagementPartner -PartnerId 123457 -PassThru -true -``` - -Remove management partner - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PartnerId -The management partner id, it is a 6 digits number - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[New-AzureRmManagementPartner](./New-AzureRmManagementPartner.md) - -[Get-AzureRmManagementPartner](./Get-AzureRmManagementPartner.md) - -[Update-AzureRmManagementPartner](./Update-AzureRmManagementPartner.md) diff --git a/azurermps-6.13.0/AzureRM.ManagementPartner/Update-AzureRmManagementPartner.md b/azurermps-6.13.0/AzureRM.ManagementPartner/Update-AzureRmManagementPartner.md deleted file mode 100644 index ed726eb740..0000000000 --- a/azurermps-6.13.0/AzureRM.ManagementPartner/Update-AzureRmManagementPartner.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ManagementPartner.dll-Help.xml -Module Name: AzureRM.ManagementPartner -online version: https://go.microsoft.com/fwlink/?LinkID=393054 -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ManagementPartner/Commands.Partner/help/Update-AzureRmManagementPartner.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ManagementPartner/Commands.Partner/help/Update-AzureRmManagementPartner.md ---- - -# Update-AzureRmManagementPartner - -## SYNOPSIS -Updates the Microsoft Partner Network(MPN) ID of the current authenticated user or service principal. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Update-AzureRmManagementPartner [-PartnerId] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Updates the Microsoft Partner Network(MPN) ID of the current authenticated user or service principal. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Update-AzureRmManagementPartner -PartnerId 4977985 -PartnerId : 4977985 -PartnerName : Test_Test_DPORTest -TenantId : 00001111-aaaa-2222-bbbb-3333cccc4444 -ObjectId : 00001111-aaaa-2222-bbbb-3333cccc4444 -State : Active -``` - -Update the management partner to a new one - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PartnerId -The management partner id, it is a 6 digits number - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.ManagementPartner.PSManagementPartner - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmManagementPartner](./Remove-AzureRmManagementPartner.md) - -[New-AzureRmManagementPartner](./New-AzureRmManagementPartner.md) - -[Get-AzureRmManagementPartner](./Get-AzureRmManagementPartner.md) diff --git a/azurermps-6.13.0/AzureRM.Maps/AzureRM.Maps.md b/azurermps-6.13.0/AzureRM.Maps/AzureRM.Maps.md deleted file mode 100644 index 6c2fed1738..0000000000 --- a/azurermps-6.13.0/AzureRM.Maps/AzureRM.Maps.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -Module Name: AzureRM.Maps -Module Guid: bf60f35d-6c0b-42f2-be30-eb333a31279d -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.maps -Help Version: 1.0.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Maps/Commands.Maps/help/AzureRM.Maps.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Maps/Commands.Maps/help/AzureRM.Maps.md ---- - -# AzureRM.Maps Module -## Description -This topic displays help for the Azure Maps Cmdlets. - -## AzureRM.Maps Cmdlets -### [Get-AzureRmMapsAccount](Get-AzureRmMapsAccount.md) -Gets the account. - -### [Get-AzureRmMapsAccountKey](Get-AzureRmMapsAccountKey.md) -Gets the API keys for an account. -These keys are the authentication mechanism used in subsequent calls to Azure Maps. - -### [New-AzureRmMapsAccount](New-AzureRmMapsAccount.md) -Creates an Azure Maps account. - -### [New-AzureRmMapsAccountKey](New-AzureRmMapsAccountKey.md) -Regenerates an account key. - -### [Remove-AzureRmMapsAccount](Remove-AzureRmMapsAccount.md) -Deletes an Azure Maps account. - diff --git a/azurermps-6.13.0/AzureRM.Maps/Get-AzureRmMapsAccount.md b/azurermps-6.13.0/AzureRM.Maps/Get-AzureRmMapsAccount.md deleted file mode 100644 index f1cff52a4f..0000000000 --- a/azurermps-6.13.0/AzureRM.Maps/Get-AzureRmMapsAccount.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Maps.dll-Help.xml -Module Name: AzureRM.Maps -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.maps/get-azurermmapsaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Maps/Commands.Maps/help/Get-AzureRmMapsAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Maps/Commands.Maps/help/Get-AzureRmMapsAccount.md ---- - -# Get-AzureRmMapsAccount - -## SYNOPSIS -Gets the account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceGroupParameterSet (Default) -``` -Get-AzureRmMapsAccount [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### AccountNameParameterSet -``` -Get-AzureRmMapsAccount [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Get-AzureRmMapsAccount [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmMapsAccount cmdlet gets a provisioned Azure Maps account, either by resource group and name, or by resource id. -Additionally, it can return a list of all accounts in the ResourceGroup, or all Azure Maps accounts for the current subscription. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmMapsAccount -ResourceGroupName MyResourceGroup -Name MyAccount - -ResourceGroupName AccountName Id ------------------ ----------- -- -MyResourceGroup MyAccount /subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/MyResourceGroup/providers/Microsoft.Maps/accounts/MyAccount -``` - -Gets the account named MyAccount in the resource group MyResourceGroup, if it exists. - -### Example 2 -```powershell -PS C:\> Get-AzureRmMapsAccount -ResourceGroupName MyResourceGroup - -ResourceGroupName AccountName Id ------------------ ----------- -- -MyResourceGroup MyAccount /subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/MyResourceGroup/providers/Microsoft.Maps/accounts/MyAccount -[...] -``` - -Gets all Azure Maps accounts in the resource group MyResourceGroup. - -### Example 3 -```powershell -PS C:\> Get-AzureRmMapsAccount - -ResourceGroupName AccountName Id ------------------ ----------- -- -[...] -MyResourceGroup MyAccount /subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/MyResourceGroup/providers/Microsoft.Maps/accounts/MyAccount -[...] -``` - -Gets all Azure Maps accounts in the current subscription. - -### Example 4 -```powershell -PS C:\> Get-AzureRmMapsAccount -ResourceId /subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/MyResourceGroup/providers/Microsoft.Maps/accounts/MyAccount - -ResourceGroupName AccountName Id ------------------ ----------- -- -MyResourceGroup MyAccount /subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/MyResourceGroup/providers/Microsoft.Maps/accounts/MyAccount -``` - -Gets the Maps account specified by the Resource Id. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Maps Account Name. - -```yaml -Type: System.String -Parameter Sets: AccountNameParameterSet -Aliases: MapsAccountName, AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupParameterSet -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: AccountNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Maps Account ResourceId. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Maps.Models.PSMapsAccount - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Maps/Get-AzureRmMapsAccountKey.md b/azurermps-6.13.0/AzureRM.Maps/Get-AzureRmMapsAccountKey.md deleted file mode 100644 index 976f4c06f9..0000000000 --- a/azurermps-6.13.0/AzureRM.Maps/Get-AzureRmMapsAccountKey.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Maps.dll-Help.xml -Module Name: AzureRM.Maps -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.maps/get-azurermmapsaccountkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Maps/Commands.Maps/help/Get-AzureRmMapsAccountKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Maps/Commands.Maps/help/Get-AzureRmMapsAccountKey.md ---- - -# Get-AzureRmMapsAccountKey - -## SYNOPSIS -Gets the API keys for an account. -These keys are the authentication mechanism used in subsequent calls to Azure Maps. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameParameterSet (Default) -``` -Get-AzureRmMapsAccountKey [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### InputObjectParameterSet -``` -Get-AzureRmMapsAccountKey [-InputObject <PSMapsAccount>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Get-AzureRmMapsAccountKey [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmMapsAccountKey cmdlet gets the API keys for a provisioned Azure Maps account. -An Azure Maps account has two API keys: Primary and Secondary. -The keys enable interaction with the Azure Maps account endpoint. -Use New-AzureRmMapsAccountKey (New-AzureRmMapsAccountKey.md)to regenerate a key. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmMapsAccountKey -ResourceGroupName MyResourceGroup -Name MyAccount - -PrimaryKey SecondaryKey ----------- ------------ -******************************************* ******************************************* -``` - -Returns the keys for the account named MyAccount in the resource group MyResourceGroup. - -### Example 2 -```powershell -PS C:\> Get-AzureRmMapsAccountKey -ResourceId /subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/MyResourceGroup/providers/Microsoft.Maps/accounts/MyAccount - -PrimaryKey SecondaryKey ----------- ------------ -******************************************* ******************************************* -``` - -Returns the keys for the specified Azure Maps Account. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Maps Account piped from Get-AzureRmMapsAccount. - -```yaml -Type: Microsoft.Azure.Commands.Maps.Models.PSMapsAccount -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Maps Account Name. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet -Aliases: MapsAccountName, AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Maps Account ResourceId. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Maps.Models.PSMapsAccount -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Maps.Models.PSMapsAccountKeys - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Maps/New-AzureRmMapsAccount.md b/azurermps-6.13.0/AzureRM.Maps/New-AzureRmMapsAccount.md deleted file mode 100644 index 81cea81aa2..0000000000 --- a/azurermps-6.13.0/AzureRM.Maps/New-AzureRmMapsAccount.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Maps.dll-Help.xml -Module Name: AzureRM.Maps -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.maps/new-azurermmapsaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Maps/Commands.Maps/help/New-AzureRmMapsAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Maps/Commands.Maps/help/New-AzureRmMapsAccount.md ---- - -# New-AzureRmMapsAccount - -## SYNOPSIS -Creates an Azure Maps account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmMapsAccount [-ResourceGroupName] <String> [-Name] <String> [-SkuName] <String> [-Tag <Hashtable[]>] - [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmMapsAccount cmdlet creates an Azure Maps account with the specified SKU. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-AzureRmMapsAccount -ResourceGroupName MyResourceGroup -Name MyAccount -SkuName S0 -Tags @{Name="test";Value="true"} - -ResourceGroupName AccountName Id ------------------ ----------- -- -MyResourceGroup MyAccount /subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/MyResourceGroup/providers/Microsoft.Maps/accounts/MyAccount -``` - -Creates a new Azure Maps account named MyAccount in the resource group MyResourceGroup with the SKU S0 and a tag. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Don't ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Maps Account Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: MapsAccountName, AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuName -Maps Account Sku Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: S0 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Maps Account Tags. - -```yaml -Type: System.Collections.Hashtable[] -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Maps.Models.PSMapsAccount - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Maps/New-AzureRmMapsAccountKey.md b/azurermps-6.13.0/AzureRM.Maps/New-AzureRmMapsAccountKey.md deleted file mode 100644 index 6d1d301dea..0000000000 --- a/azurermps-6.13.0/AzureRM.Maps/New-AzureRmMapsAccountKey.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Maps.dll-Help.xml -Module Name: AzureRM.Maps -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.maps/new-azurermmapsaccountkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Maps/Commands.Maps/help/New-AzureRmMapsAccountKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Maps/Commands.Maps/help/New-AzureRmMapsAccountKey.md ---- - -# New-AzureRmMapsAccountKey - -## SYNOPSIS -Regenerates an account key. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameParameterSet (Default) -``` -New-AzureRmMapsAccountKey [-ResourceGroupName] <String> [-Name] <String> [-KeyName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectParameterSet -``` -New-AzureRmMapsAccountKey [-KeyName] <String> [-InputObject <PSMapsAccount>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -New-AzureRmMapsAccountKey [-KeyName] <String> [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmMapsAccountKey cmdlet regenerates an API key for a Azure Maps account. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-AzureRmMapsAccountKey -ResourceGroupName MyResourceGroup -Name MyAccount -KeyName Primary - -Confirm -Are you sure you want to perform this action? -Performing the operation "Regenerating Key Primary for account MyAccount." on target "MyAccount". -[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y - -Id PrimaryKey SecondaryKey --- ---------- ------------ -/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/MyResourceGroup/providers/Microsoft.Maps/accounts/MyAccount ******************************************* ******************************************* -``` - -Regenerates the Primary API Key for the account MyAccount in the resource group MyResourceGroup. - -### Example 2 -```powershell -PS C:\> New-AzureRmMapsAccountKey -ResourceId /subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/MyResourceGroup/providers/Microsoft.Maps/accounts/MyAccount -KeyName Secondary - -Confirm -Are you sure you want to perform this action? -Performing the operation "Regenerating Key Secondary for account MyAccount." on target "MyAccount". -[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y - -Id PrimaryKey SecondaryKey --- ---------- ------------ -/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/MyResourceGroup/providers/Microsoft.Maps/accounts/MyAccount ******************************************* ******************************************* -``` - -Regenerates the Secondary API Key for the specified Azure Maps Account. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Maps Account piped from Get-AzureRmMapsAccount. - -```yaml -Type: Microsoft.Azure.Commands.Maps.Models.PSMapsAccount -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -KeyName -Maps Account Key. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Primary, Secondary - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Maps Account Name. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet -Aliases: MapsAccountName, AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Maps Account ResourceId. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Maps.Models.PSMapsAccount -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Management.Maps.Models.MapsAccountKeys - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Maps/Remove-AzureRmMapsAccount.md b/azurermps-6.13.0/AzureRM.Maps/Remove-AzureRmMapsAccount.md deleted file mode 100644 index d1c0b3ad5f..0000000000 --- a/azurermps-6.13.0/AzureRM.Maps/Remove-AzureRmMapsAccount.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Maps.dll-Help.xml -Module Name: AzureRM.Maps -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.maps/remove-azurermmapsaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Maps/Commands.Maps/help/Remove-AzureRmMapsAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Maps/Commands.Maps/help/Remove-AzureRmMapsAccount.md ---- - -# Remove-AzureRmMapsAccount - -## SYNOPSIS -Deletes an Azure Maps account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameParameterSet (Default) -``` -Remove-AzureRmMapsAccount [-ResourceGroupName] <String> [-Name] <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectParameterSet -``` -Remove-AzureRmMapsAccount [-InputObject <PSMapsAccount>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Remove-AzureRmMapsAccount [-ResourceId] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmMapsAccount cmdlet deletes the specified Azure Maps account. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-AzureRmMapsAccount -ResourceGroupName MyResourceGroup -Name MyAccount - -Confirm -Are you sure you want to perform this action? -Performing the operation "Deleting account MyAccount." on target "MyAccount". -[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y -``` - -Deletes the account MyAccount from the resource group MyResourceGroup. - -### Example 2 -``` -PS C:\> Remove-AzureRmMapsAccount -ResourceId /subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/MyResourceGroup/providers/Microsoft.Maps/accounts/MyAccount - -Confirm -Are you sure you want to perform this action? -Performing the operation "Deleting account MyAccount." on target "MyAccount". -[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y -``` - -Deletes the specified Azure Maps Account. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Maps Account piped from Get-AzureRmMapsAccount. - -```yaml -Type: Microsoft.Azure.Commands.Maps.Models.PSMapsAccount -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Maps Account Name. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet -Aliases: MapsAccountName, AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Return whether the specified account was successfully deleted or not. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Maps Account ResourceId. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Maps.Models.PSMapsAccount -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.MarketplaceOrdering/AzureRM.MarketplaceOrdering.md b/azurermps-6.13.0/AzureRM.MarketplaceOrdering/AzureRM.MarketplaceOrdering.md deleted file mode 100644 index 9b2d148baf..0000000000 --- a/azurermps-6.13.0/AzureRM.MarketplaceOrdering/AzureRM.MarketplaceOrdering.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -Module Name: AzureRM.MarketplaceOrdering -Module Guid: 6e0e216b-1dff-4992-b943-b3a4f14679ab -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.marketplaceordering -Help Version: 0.1.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MarketplaceOrdering/Commands.MarketplaceOrdering/help/AzureRM.MarketplaceOrdering.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MarketplaceOrdering/Commands.MarketplaceOrdering/help/AzureRM.MarketplaceOrdering.md ---- - -# AzureRM.MarketplaceOrdering Module -## Description -The topics in this section document the Azure PowerShell cmdlets for Azure MarketplaceOrdering in the Azure Resource Manager (ARM) framework. The cmdlets exist in the Microsoft.Azure.Commands.MarketplaceOrdering namespace. These cmdlets allow azure users to accept the legal terms for a marketplace offering further allowing programmatic deployment for these solutions. Users may also reject set of legal terms already accepted. - -## AzureRM.MarketplaceOrdering Cmdlets -### [Get-AzureRmMarketplaceTerms](Get-AzureRmMarketplaceTerms.md) -Get the agreement terms for a given publisher id(Publisher), offer id(Product) and plan id(Name). The terms object which is returned by this command should be passed to Set-AzureRmMarketplaceTerms to accept the legal terms. - -### [Set-AzureRmMarketplaceTerms](Set-AzureRmMarketplaceTerms.md) -Accept or reject terms for a given publisher id(Publisher), offer id(Product) and plan id(Name). Please use Get-AzureRmMarketplaceTerms to get the agreement terms. - diff --git a/azurermps-6.13.0/AzureRM.MarketplaceOrdering/Get-AzureRmMarketplaceTerms.md b/azurermps-6.13.0/AzureRM.MarketplaceOrdering/Get-AzureRmMarketplaceTerms.md deleted file mode 100644 index dcfeccb2a3..0000000000 --- a/azurermps-6.13.0/AzureRM.MarketplaceOrdering/Get-AzureRmMarketplaceTerms.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.MarketplaceOrdering.dll-Help.xml -Module Name: AzureRM.MarketplaceOrdering -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.marketplaceordering/get-azurermmarketplaceterms -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MarketplaceOrdering/Commands.MarketplaceOrdering/help/Get-AzureRmMarketplaceTerms.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MarketplaceOrdering/Commands.MarketplaceOrdering/help/Get-AzureRmMarketplaceTerms.md ---- - -# Get-AzureRmMarketplaceTerms - -## SYNOPSIS -Get the agreement terms for a given publisher id(Publisher), offer id(Product) and plan id(Name). The terms object which is returned by this command should be passed to Set-AzureRmMarketplaceTerms to accept the legal terms. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmMarketplaceTerms -Publisher <String> -Product <String> -Name <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmMarketplaceTerms** cmdlet returns terms for given publisher id(Publisher), offer id(Product) and plan id(Name) tuple. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmMarketplaceTerms -Publisher "microsoft-ads" -Product "windows-data-science-vm" -Name "windows2016" -Publisher : microsoft-ads -Product : windows-data-science-vm -Plan : windows2016 -LicenseTextLink : <LicenseTextLink> -PrivacyPolicyLink : <PrivacyPolicyLink> -Signature : <Signature> -Accepted : True -RetrieveDatetime : <RetrieveDatetime> -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Plan identifier string of image being deployed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Product -Offer identifier string of image being deployed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Publisher -Publisher identifier string of image being deployed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.MarketplaceOrdering.Models.PSAgreementTerms - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.MarketplaceOrdering/Set-AzureRmMarketplaceTerms.md b/azurermps-6.13.0/AzureRM.MarketplaceOrdering/Set-AzureRmMarketplaceTerms.md deleted file mode 100644 index 51c9528aa2..0000000000 --- a/azurermps-6.13.0/AzureRM.MarketplaceOrdering/Set-AzureRmMarketplaceTerms.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.MarketplaceOrdering.dll-Help.xml -Module Name: AzureRM.MarketplaceOrdering -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.marketplaceordering/set-azurermmarketplaceterms -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MarketplaceOrdering/Commands.MarketplaceOrdering/help/Set-AzureRmMarketplaceTerms.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/MarketplaceOrdering/Commands.MarketplaceOrdering/help/Set-AzureRmMarketplaceTerms.md ---- - -# Set-AzureRmMarketplaceTerms - -## SYNOPSIS -Accept or reject terms for a given publisher id(Publisher), offer id(Product) and plan id(Name). Please use Get-AzureRmMarketplaceTerms to get the agreement terms. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### AgreementAcceptParameterSet (Default) -``` -Set-AzureRmMarketplaceTerms -Publisher <String> -Product <String> -Name <String> [-Accept] - [-Terms <PSAgreementTerms>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### AgreementRejectParameterSet -``` -Set-AzureRmMarketplaceTerms -Publisher <String> -Product <String> -Name <String> [-Reject] - [-Terms <PSAgreementTerms>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### InputObjectAcceptParameterSet -``` -Set-AzureRmMarketplaceTerms [-Accept] [-InputObject] <PSAgreementTerms> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectRejectParameterSet -``` -Set-AzureRmMarketplaceTerms [-Reject] [-InputObject] <PSAgreementTerms> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmMarketplaceTerms** cmdlet saves the terms object for given publisher id(Publisher), offer id(Product) and plan id(Name) tuple. - -## EXAMPLES - -### Example 1 -Get the marketplace publisher agreement -``` -PS C:\> Get-AzureRmMarketplaceTerms -Publisher "microsoft-ads" -Product "windows-data-science-vm" -Name "windows2016" | Set-AzureRmMarketplaceTerms -Accept -``` - -### Example 2 -Set the publisher agreement to 'Accept'. Get the value for the 'Terms' parameter from the 'Get-AzureRmMarketplaceTerms' cmdlet -``` -PS C:\> Set-AzureRmMarketplaceTerms -Publisher "microsoft-ads" -Product "windows-data-science-vm" -Name "windows2016" -Terms $agreementTerms -Accept -``` - - -## PARAMETERS - -### -Accept -Pass this to accept the legal terms. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: AgreementAcceptParameterSet, InputObjectAcceptParametrSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Terms object returned in Get-AzureRmMarketplaceTerms cmdlet. This is a mandatory parameter if Accepted paramter is true. - -```yaml -Type: Microsoft.Azure.Commands.MarketplaceOrdering.Models.PSAgreementTerms -Parameter Sets: InputObjectAcceptParametrSet, InputObjectRejectParametrSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Plan identifier string of image being deployed. - -```yaml -Type: System.String -Parameter Sets: AgreementAcceptParameterSet, AgreementRejectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Product -Offer identifier string of image being deployed. - -```yaml -Type: System.String -Parameter Sets: AgreementAcceptParameterSet, AgreementRejectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Publisher -Publisher identifier string of image being deployed. - -```yaml -Type: System.String -Parameter Sets: AgreementAcceptParameterSet, AgreementRejectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Reject -Pass this to reject the legal terms. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: AgreementRejectParameterSet, InputObjectRejectParametrSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Terms -Terms object returned in Get-AzureRmMarketplaceTerms cmdlet. This is a mandatory parameter if Accepted paramter is true. - -```yaml -Type: Microsoft.Azure.Commands.MarketplaceOrdering.Models.PSAgreementTerms -Parameter Sets: AgreementAcceptParameterSet, AgreementRejectParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.MarketplaceOrdering.Models.PSAgreementTerms -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.MarketplaceOrdering.Models.PSAgreementTerms - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Media/AzureRM.Media.md b/azurermps-6.13.0/AzureRM.Media/AzureRM.Media.md deleted file mode 100644 index 4477318bc1..0000000000 --- a/azurermps-6.13.0/AzureRM.Media/AzureRM.Media.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -Module Name: AzureRM.Media -Module Guid: c66edca6-2e57-4550-905e-f5cc104de25e -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.media -Help Version: 0.9.2.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Media/Commands.Media/help/AzureRM.Media.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Media/Commands.Media/help/AzureRM.Media.md ---- - -# AzureRM.Media Module -## Description -This topic displays help topics for the Media Service web service feature in Azure App Service cmdlets. - -## AzureRM.Media Cmdlets -### [Get-AzureRmMediaService](Get-AzureRmMediaService.md) -Gets information about a media service. - -### [Get-AzureRmMediaServiceKeys](Get-AzureRmMediaServiceKeys.md) -Gets key information for accessing the REST endpoint associated with the media service. - -### [Get-AzureRmMediaServiceNameAvailability](Get-AzureRmMediaServiceNameAvailability.md) -Checks whether a media service name is available. -Media service names are globally unique. - -### [New-AzureRmMediaService](New-AzureRmMediaService.md) -Creates a media service if the media service already exists, all its properties are updated with the input provided. - -### [New-AzureRmMediaServiceStorageConfig](New-AzureRmMediaServiceStorageConfig.md) -Create a storage account configuration for the media service cmdlets. - -### [Remove-AzureRmMediaService](Remove-AzureRmMediaService.md) -Removes a media service. - -### [Set-AzureRmMediaService](Set-AzureRmMediaService.md) -Modifies specified properties of an existing media service. - -### [Set-AzureRmMediaServiceKey](Set-AzureRmMediaServiceKey.md) -Regenerates a key used for accessing the REST endpoint associated with the media service. - -### [Sync-AzureRmMediaServiceStorageKeys](Sync-AzureRmMediaServiceStorageKeys.md) -Synchronizes storage account keys for a storage account associated with the media service. - diff --git a/azurermps-6.13.0/AzureRM.Media/Get-AzureRmMediaService.md b/azurermps-6.13.0/AzureRM.Media/Get-AzureRmMediaService.md deleted file mode 100644 index 3bef4bf60f..0000000000 --- a/azurermps-6.13.0/AzureRM.Media/Get-AzureRmMediaService.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Media.dll-Help.xml -Module Name: AzureRM.Media -ms.assetid: 9843D191-CBC4-481A-BD36-D7B2D7917BD9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.media/get-azurermmediaservice -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Media/Commands.Media/help/Get-AzureRmMediaService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Media/Commands.Media/help/Get-AzureRmMediaService.md ---- - -# Get-AzureRmMediaService - -## SYNOPSIS -Gets information about a media service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceGroupParameterSet -``` -Get-AzureRmMediaService [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### AccountNameParameterSet -``` -Get-AzureRmMediaService [-ResourceGroupName] <String> [-AccountName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmMediaService** cmdlet gets information about a media service. - -## EXAMPLES - -### Example 1: Get all media services in a resource group -``` -PS C:\>Get-AzureRmMediaService -ResourceGroupName "ResourceGroup001" -``` - -This command gets properties for all media services in the resource group named ResourceGroup001. - -### Example 2: Get media service properties -``` -PS C:\>Get-AzureRmMediaService -ResourceGroupName "ResourceGroup002" -AccountName "MediaService1" -``` - -This command gets the properties of the media service named MediaService1 that belongs to the resource group named ResourceGroup002. - -## PARAMETERS - -### -AccountName -Specifies the name of the media service that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: AccountNameParameterSet -Aliases: Name, ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the media service. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Media.Models.PSMediaService - -## NOTES - -## RELATED LINKS - -[New-AzureRmMediaService](./New-AzureRmMediaService.md) - -[Remove-AzureRmMediaService](./Remove-AzureRmMediaService.md) - -[Set-AzureRmMediaService](./Set-AzureRmMediaService.md) - - diff --git a/azurermps-6.13.0/AzureRM.Media/Get-AzureRmMediaServiceKeys.md b/azurermps-6.13.0/AzureRM.Media/Get-AzureRmMediaServiceKeys.md deleted file mode 100644 index d2421ecaba..0000000000 --- a/azurermps-6.13.0/AzureRM.Media/Get-AzureRmMediaServiceKeys.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Media.dll-Help.xml -Module Name: AzureRM.Media -ms.assetid: 2099938F-5325-416C-AE10-6813546A1055 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.media/get-azurermmediaservicekeys -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Media/Commands.Media/help/Get-AzureRmMediaServiceKeys.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Media/Commands.Media/help/Get-AzureRmMediaServiceKeys.md ---- - -# Get-AzureRmMediaServiceKeys - -## SYNOPSIS -Gets key information for accessing the REST endpoint associated with the media service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmMediaServiceKeys [-ResourceGroupName] <String> [-AccountName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmMediaServiceKeys** cmdlet gets key information for accessing the Representational State Transfer (REST) endpoint associated with the Azure media service. - -## EXAMPLES - -### Example 1: Get the key information for accessing the media service -``` -PS C:\>Get-AzureRmMediaServiceKeys -ResourceGroupName "ResourceGroup001" -AccountName "MediaService001" -``` - -This command gets the key information for accessing the media service named MediaService001 that belongs to the resource group named ResourceGroup001. - -## PARAMETERS - -### -AccountName -Specifies the name of the media service that this cmdlet gets the media service keys from. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the media service. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Media.Models.PSServiceKeys - -## NOTES - -## RELATED LINKS - -[Set-AzureRmMediaServiceKey](./Set-AzureRmMediaServiceKey.md) - - diff --git a/azurermps-6.13.0/AzureRM.Media/Get-AzureRmMediaServiceNameAvailability.md b/azurermps-6.13.0/AzureRM.Media/Get-AzureRmMediaServiceNameAvailability.md deleted file mode 100644 index e5922c3ddf..0000000000 --- a/azurermps-6.13.0/AzureRM.Media/Get-AzureRmMediaServiceNameAvailability.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Media.dll-Help.xml -Module Name: AzureRM.Media -ms.assetid: 23C6C9D3-A745-46C8-AB2C-B874223FBFFF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.media/get-azurermmediaservicenameavailability -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Media/Commands.Media/help/Get-AzureRmMediaServiceNameAvailability.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Media/Commands.Media/help/Get-AzureRmMediaServiceNameAvailability.md ---- - -# Get-AzureRmMediaServiceNameAvailability - -## SYNOPSIS -Checks whether a media service name is available. -Media service names are globally unique. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmMediaServiceNameAvailability [-DefaultProfile <IAzureContextContainer>] [-AccountName] <String> - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmMediaServiceNameAvailability** cmdlet checks whether a media service name is available. -Media service names are globally unique. - -## EXAMPLES - -### Example 1: Check whether a Media Service name is available -``` -PS C:\>Get-AzureRmMediaServiceNameAvailability -AccountName "MediaService1" -``` - -This command checks if the name MediaService1 is available. - -## PARAMETERS - -### -AccountName -Specifies the name of the media service that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Media.Models.PSCheckNameAvailabilityOutput - -## NOTES - -## RELATED LINKS - -[Get-AzureRmMediaService](./Get-AzureRmMediaService.md) - -[New-AzureRmMediaService](./New-AzureRmMediaService.md) - -[Remove-AzureRmMediaService](./Remove-AzureRmMediaService.md) - -[Set-AzureRmMediaService](./Set-AzureRmMediaService.md) - - diff --git a/azurermps-6.13.0/AzureRM.Media/New-AzureRmMediaService.md b/azurermps-6.13.0/AzureRM.Media/New-AzureRmMediaService.md deleted file mode 100644 index a32aed308b..0000000000 --- a/azurermps-6.13.0/AzureRM.Media/New-AzureRmMediaService.md +++ /dev/null @@ -1,268 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Media.dll-Help.xml -Module Name: AzureRM.Media -ms.assetid: 5CEA7323-4CF7-42B2-BA94-BB3C8F73D2E9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.media/new-azurermmediaservice -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Media/Commands.Media/help/New-AzureRmMediaService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Media/Commands.Media/help/New-AzureRmMediaService.md ---- - -# New-AzureRmMediaService - -## SYNOPSIS -Creates a media service if the media service already exists, all its properties are updated with the input provided. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### StorageAccountIdParamSet -``` -New-AzureRmMediaService [-ResourceGroupName] <String> [-AccountName] <String> [-Location] <String> - [-StorageAccountId] <String> [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### StorageAccountsParamSet -``` -New-AzureRmMediaService [-ResourceGroupName] <String> [-AccountName] <String> [-Location] <String> - [-StorageAccounts] <PSStorageAccount[]> [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmMediaService** cmdlet creates a media service. -If the media service already exists, this cmdlet update its properties. - -## EXAMPLES - -### Example1: Create a media service with the primary storage account only -``` -PS C:\># Variables -## Global -$ResourceGroupName = "ResourceGroup001" -$Location = "East US" - -## Storage -$StorageName = "Storage1" -$StorageType = "Standard_GRS" - -## Media Service -$Tags = @{"tag1" = "value1"; "tag2" = "value2"} -$MediaServiceName = "MediaService1" - -# Resource Group -PS C:\> New-AzureRmResourceGroup -Name $ResourceGroupName -Location $Location - -# Storage -$StorageAccount = New-AzureRmStorageAccount -ResourceGroupName $ResourceGroupName -Name $StorageName -Location $Location -Type $StorageType - -# Media Service -PS C:\> New-AzureRmMediaService -ResourceGroupName $ResourceGroupName -AccountName $MediaServiceName -Location $Location -StorageAccountId $StorageAccount.Id -Tags $Tags -``` - -This example shows how to create a media service with specifying primary storage account only. -This script uses several other cmdlets. - -### Example 2: Create a media service with multiple storage -``` -PS C:\># Variables - -## Global -$ResourceGroupName = "ResourceGroup001" -$Location = "East US" - -## Storage -$StorageName1 = "storage1" -$StorageName2 = "storage2" -$StorageType = "Standard_GRS" - -## Media Service -$Tags = @{"tag1" = "value1"; "tag2" = "value2"} -$MediaServiceName = "MediaService1" - -# Resource Group -PS C:\> New-AzureRmResourceGroup -Name $ResourceGroupName -Location $Location - -# Storage -$StorageAccount1 = New-AzureRmStorageAccount -ResourceGroupName $ResourceGroupName -Name $StorageName1 -Location $Location -Type $StorageType - - -$StorageAccount2 = New-AzureRmStorageAccount -ResourceGroupName $ResourceGroupName -Name $StorageName2 -Location $Location -Type $StorageType - -# Media Service - -## Setup the storage configuration object. -PS C:\> $PrimaryStorageAccount = New-AzureRmMediaServiceStorageConfig -StorageAccountId $StorageAccount1.Id -IsPrimary -PS C:\> $SecondaryStorageAccount = New-AzureRmMediaServiceStorageConfig -StorageAccountId $StorageAccount2.Id -PS C:\> $StorageAccounts = @($PrimaryStorageAccount, $SecondaryStorageAccount) - -## Create a media service.New-AzureRmMediaService -ResourceGroupName $ResourceGroupName -AccountName $MediaServiceName -Location $Location -StorageAccounts $StorageAccounts -Tags $Tags -``` - -This example shows how to create a media service with multiple storage accounts. -This script uses several other cmdlets. - -## PARAMETERS - -### -AccountName -Specifies the name of the media service that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the region that this cmdlet creates the media service in. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the media service is assigned to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountId -Specifies the storage account associated with the media service account. - -```yaml -Type: System.String -Parameter Sets: StorageAccountIdParamSet -Aliases: Id - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccounts -Specifies an array of storage accounts to associate with the media service. - -```yaml -Type: Microsoft.Azure.Commands.Media.Models.PSStorageAccount[] -Parameter Sets: StorageAccountsParamSet -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -The tags associated with the media service account. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Media.Models.PSStorageAccount[] - -## OUTPUTS - -### Microsoft.Azure.Commands.Media.Models.PSMediaService - -## NOTES - -## RELATED LINKS - -[Get-AzureRmMediaService](./Get-AzureRmMediaService.md) - -[Remove-AzureRmMediaService](./Remove-AzureRmMediaService.md) - -[Set-AzureRmMediaService](./Set-AzureRmMediaService.md) - - diff --git a/azurermps-6.13.0/AzureRM.Media/New-AzureRmMediaServiceStorageConfig.md b/azurermps-6.13.0/AzureRM.Media/New-AzureRmMediaServiceStorageConfig.md deleted file mode 100644 index eac76fbd65..0000000000 --- a/azurermps-6.13.0/AzureRM.Media/New-AzureRmMediaServiceStorageConfig.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Media.dll-Help.xml -Module Name: AzureRM.Media -ms.assetid: 4D64CA4D-1066-4D3E-9317-60D37D9DE2BB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.media/new-azurermmediaservicestorageconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Media/Commands.Media/help/New-AzureRmMediaServiceStorageConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Media/Commands.Media/help/New-AzureRmMediaServiceStorageConfig.md ---- - -# New-AzureRmMediaServiceStorageConfig - -## SYNOPSIS -Create a storage account configuration for the media service cmdlets. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmMediaServiceStorageConfig [-DefaultProfile <IAzureContextContainer>] [-StorageAccountId] <String> - [-IsPrimary] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmMediaServiceStorageConfig** cmdlet creates a storage account configuration for the media service cmdlets. - -## EXAMPLES - -### Example 1: Create a storage account configuration for the media service cmdlets -``` -PS C:\> -$StorageAccount = New-AzureRmStorageAccount -ResourceGroupName $ResourceGroupName -Name "Storage1" -Location "East US" -Type "Standard_GRS" - -PS C:\> New-AzureRmMediaServiceStorageConfig -StorageAccountId $StorageAccount.Id -IsPrimary -``` - -The first command creates a storage account object by using **the New-AzureRmStorageAccount** cmdlet. -The command names this storage account Storage1 and the type is named Standard_GRS and stores the result in the variable named $StorageAccount. -The second command creates a storage configuration object as the primary storage account associated with the media service using the storage account ID information stored in the $StorageAccount variable. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsPrimary -Indicates that the cmdlet creates the storage account as the primary storage for the media service. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageAccountId -Specifies the ID of the storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Media.Models.PSStorageAccount - -## NOTES - -## RELATED LINKS - -[Sync-AzureRmMediaServiceStorageKeys](./Sync-AzureRmMediaServiceStorageKeys.md) - - diff --git a/azurermps-6.13.0/AzureRM.Media/Remove-AzureRmMediaService.md b/azurermps-6.13.0/AzureRM.Media/Remove-AzureRmMediaService.md deleted file mode 100644 index 99c25b2fc2..0000000000 --- a/azurermps-6.13.0/AzureRM.Media/Remove-AzureRmMediaService.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Media.dll-Help.xml -Module Name: AzureRM.Media -ms.assetid: 6AB6C366-4925-4370-A33E-EDAF4BE1E230 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.media/remove-azurermmediaservice -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Media/Commands.Media/help/Remove-AzureRmMediaService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Media/Commands.Media/help/Remove-AzureRmMediaService.md ---- - -# Remove-AzureRmMediaService - -## SYNOPSIS -Removes a media service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmMediaService [-ResourceGroupName] <String> [-AccountName] <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmMediaService** cmdlet removes a media service. - -## EXAMPLES - -### Example 1: Remove a media service -``` -PS C:\>Remove-AzureRmMediaService -ResourceGroupName "ResourceGroup001" -AccountName "MediaService0011" -``` - -This command removes the media service named MediaService0011 in the resource group named ResourceGroup001. - -## PARAMETERS - -### -AccountName -Specifies the name of the media service that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the media service. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmMediaService](./Get-AzureRmMediaService.md) - -[New-AzureRmMediaService](./New-AzureRmMediaService.md) - -[Set-AzureRmMediaService](./Set-AzureRmMediaService.md) - - diff --git a/azurermps-6.13.0/AzureRM.Media/Set-AzureRmMediaService.md b/azurermps-6.13.0/AzureRM.Media/Set-AzureRmMediaService.md deleted file mode 100644 index 2dd315302b..0000000000 --- a/azurermps-6.13.0/AzureRM.Media/Set-AzureRmMediaService.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Media.dll-Help.xml -Module Name: AzureRM.Media -ms.assetid: 0FA49058-F3A7-4ED9-93F2-0C84BC130FB7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.media/set-azurermmediaservice -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Media/Commands.Media/help/Set-AzureRmMediaService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Media/Commands.Media/help/Set-AzureRmMediaService.md ---- - -# Set-AzureRmMediaService - -## SYNOPSIS -Modifies specified properties of an existing media service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmMediaService [-ResourceGroupName] <String> [-AccountName] <String> [-Tag <Hashtable>] - [-StorageAccounts <PSStorageAccount[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmMediaService** cmdlet modifies specified properties of an existing media service. - -## EXAMPLES - -### Example 1: Modify an existing media service -``` -PS C:\>$Tags = @{"tag1" = "value1"; "tag2" = "value2"} -Set-AzureRmMediaService -ResourceGroupName "ResourceGroup123" -AccountName "MediaService001" -Tags $Tags -StorageAccounts $StorageAccounts -``` - -The first command creates a series of tags and stores those tags in the variable named $Tags. -This second command updates the media service named MediaService001 that belongs to the resource group named ResourceGroup123 with the tags stored in $Tags variable. -The command also uses an array of storage configuration objects stored in $StorageAccounts variable. - -## PARAMETERS - -### -AccountName -Specifies the name of the media service that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the media service. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccounts -Specifies an array of storage accounts that this cmdlet associates with the media service. - -```yaml -Type: Microsoft.Azure.Commands.Media.Models.PSStorageAccount[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -The tags associated with the media account. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -### Microsoft.Azure.Commands.Media.Models.PSStorageAccount[] - -## OUTPUTS - -### Microsoft.Azure.Commands.Media.Models.PSMediaService - -## NOTES - -## RELATED LINKS - -[Get-AzureRmMediaService](./Get-AzureRmMediaService.md) - -[New-AzureRmMediaService](./New-AzureRmMediaService.md) - -[Remove-AzureRmMediaService](./Remove-AzureRmMediaService.md) - - diff --git a/azurermps-6.13.0/AzureRM.Media/Set-AzureRmMediaServiceKey.md b/azurermps-6.13.0/AzureRM.Media/Set-AzureRmMediaServiceKey.md deleted file mode 100644 index 4db1e1acc8..0000000000 --- a/azurermps-6.13.0/AzureRM.Media/Set-AzureRmMediaServiceKey.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Media.dll-Help.xml -Module Name: AzureRM.Media -ms.assetid: D28EB28D-DBC6-48D5-AB0A-C56F56CD0104 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.media/set-azurermmediaservicekey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Media/Commands.Media/help/Set-AzureRmMediaServiceKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Media/Commands.Media/help/Set-AzureRmMediaServiceKey.md ---- - -# Set-AzureRmMediaServiceKey - -## SYNOPSIS -Regenerates a key used for accessing the REST endpoint associated with the media service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmMediaServiceKey [-ResourceGroupName] <String> [-AccountName] <String> [-KeyType] <KeyType> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmMediaServiceKey** cmdlet regenerates a key used for accessing the Representational State Transfer (REST) endpoint associated with the media service. - -## EXAMPLES - -### Example 1: Regenerate the primary key used for accessing the Media Service -``` -PS C:\>Set-AzureRmMediaServiceKey -ResourceGroupName "ResourceGroup004" -AccountName "MediaService001" -KeyType Primary -``` - -This command regenerates the primary key for the media service named MediaService001 that belongs to the resource group named ResourceGroup004. - -### Example 2: Regenerates the secondary key used for accessing the Media Service -``` -PS C:\>Set-AzureRmMediaServiceKey -ResourceGroupName "Resourcegroup123" -AccountName "MediaService002" -KeyType Secondary -``` - -This command regenerates the secondary key for the media service named MediaService002 that belongs to the resource group named Resourcegroup123. - -## PARAMETERS - -### -AccountName -Specifies the name of the media service that this cmdlet regenerates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyType -Specifies the key type of the media service. -The acceptable values for this parameter are: Primary or Secondary. - -```yaml -Type: Microsoft.Azure.Management.Media.Models.KeyType -Parameter Sets: (All) -Aliases: -Accepted values: Primary, Secondary - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the media service. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Media.Models.PSServiceKey - -## NOTES - -## RELATED LINKS - -[Get-AzureRmMediaServiceKeys](./Get-AzureRmMediaServiceKeys.md) - - diff --git a/azurermps-6.13.0/AzureRM.Media/Sync-AzureRmMediaServiceStorageKeys.md b/azurermps-6.13.0/AzureRM.Media/Sync-AzureRmMediaServiceStorageKeys.md deleted file mode 100644 index 94ceaa5030..0000000000 --- a/azurermps-6.13.0/AzureRM.Media/Sync-AzureRmMediaServiceStorageKeys.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Media.dll-Help.xml -Module Name: AzureRM.Media -ms.assetid: F395E192-80FA-421D-A389-8C5C0C2267E4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.media/sync-azurermmediaservicestoragekeys -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Media/Commands.Media/help/Sync-AzureRmMediaServiceStorageKeys.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Media/Commands.Media/help/Sync-AzureRmMediaServiceStorageKeys.md ---- - -# Sync-AzureRmMediaServiceStorageKeys - -## SYNOPSIS -Synchronizes storage account keys for a storage account associated with the media service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Sync-AzureRmMediaServiceStorageKeys [-ResourceGroupName] <String> [-AccountName] <String> - [-StorageAccountId] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Sync-AzureRmMediaServiceStorageKeys** cmdlet synchronizes storage account keys for a storage account associated with the media service. - -## EXAMPLES - -### Example 1: Synchronize storage account keys for a storage account associated with the media service -``` -PS C:\>$StorageAccount = Get-AzureRmStorageAccount -ResourceGroupName "ResourceGroup001" -Name "Storage135" -PS C:\> Sync-AzureRmMediaServiceStorageKeys -ResourceGroupName "ResourceGroup001" -AccoutName "MediasService001" -StorageAccoutId $StorageAccount.Id -``` - -The first command uses the Get-AzureRmStorageAccount cmdlet to get the storage account named Storage135 that belongs to ResourceGroup001 and stores the result in the variable named $StorageAccount. -The second command synchronizes the storage account keys for the media service named MediaService001 using the **Id** property contained in the $StorageAccount variable. - -## PARAMETERS - -### -AccountName -Specifies the name of the media service that this cmdlet synchronizes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the media service. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountId -Specifies the storage account ID associated with the media service account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Id - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayAuthenticationCertificate.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayAuthenticationCertificate.md deleted file mode 100644 index 6e84628775..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayAuthenticationCertificate.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 38855E74-F30C-43DF-8D94-ABD7872BCE11 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermapplicationgatewayauthenticationcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmApplicationGatewayAuthenticationCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmApplicationGatewayAuthenticationCertificate.md ---- - -# Add-AzureRmApplicationGatewayAuthenticationCertificate - -## SYNOPSIS -Adds an authentication certificate to an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmApplicationGatewayAuthenticationCertificate -ApplicationGateway <PSApplicationGateway> - -Name <String> -CertificateFile <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmApplicationGatewayAuthenticationCertificate** cmdlet adds an authentication certificate to an Azure application gateway. - -## EXAMPLES - -## PARAMETERS - -### -ApplicationGateway -Specifies the name of application gateway for which this cmdlet adds an authentication certificate. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CertificateFile -Specifies the path of the authentication certificate that this cmdlet adds. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a certificate that this cmdlet adds to the application gateway. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Get-AzureRmApplicationGatewayAuthenticationCertificate](./Get-AzureRmApplicationGatewayAuthenticationCertificate.md) - -[New-AzureRmApplicationGatewayAuthenticationCertificate](./New-AzureRmApplicationGatewayAuthenticationCertificate.md) - -[Remove-AzureRmApplicationGatewayAuthenticationCertificate](./Remove-AzureRmApplicationGatewayAuthenticationCertificate.md) - -[Set-AzureRmApplicationGatewayAuthenticationCertificate](./Set-AzureRmApplicationGatewayAuthenticationCertificate.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayBackendAddressPool.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayBackendAddressPool.md deleted file mode 100644 index 1e1db4cb1f..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayBackendAddressPool.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 6FBFAEFF-786D-440A-94B2-8C27BE033A0A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermapplicationgatewaybackendaddresspool -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmApplicationGatewayBackendAddressPool.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmApplicationGatewayBackendAddressPool.md ---- - -# Add-AzureRmApplicationGatewayBackendAddressPool - -## SYNOPSIS -Adds a back-end address pool to an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmApplicationGatewayBackendAddressPool -ApplicationGateway <PSApplicationGateway> -Name <String> - [-BackendIPAddresses <System.Collections.Generic.List`1[System.String]>] - [-BackendFqdns <System.Collections.Generic.List`1[System.String]>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmApplicationGatewayBackendAddressPool** cmdlet adds a back-end address pool to an application gateway. -A back-end address can be specified using an IP address, a fully-qualified domain name (FQDN) or IP configuration IDs. - -## EXAMPLES - -### Example 1: Add a back-end address pool by using a back-end server FQDN -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Add-AzureRmApplicationGatewayBackendAddressPool -ApplicationGateway $AppGw -Name "Pool02" -BackendFqdns "contoso1.com", " contoso1.com" -``` - -The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01, and stores it in the $AppGw variable.The second command adds the back-end address pool of the application gateway stored in $AppGw by using FQDNs. - -### Example 2: Add a back-end address pool by using backend server IP addresses -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Add -AzureApplicationGatewayBackendAddressPool -ApplicationGateway $ AppGw -Name "Pool02" -BackendIPAddresses "10.10.10.10", "10.10.10.11" -``` - -The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01, and stores it in the $AppGw variable.The second command adds the back-end address pool of the application gateway stored in $AppGw by using IP addresses. - -### Example 3: Seta back-end address pool by using the ID of the backend server's IP address -``` -PS C:\>$Nic01 = Get-AzureRmNetworkInterface -Name "Nic01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Nic02 = Get-AzureRmNetworkInterface -Name "Nic02" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Add-AzureRmApplicationGatewayBackendAddressPool -ApplicationGateway $ AppGw -Name "Pool02" -BackendIPConfigurationIds $nic01.Properties.IpConfigurations[0].Id, $nic02.Properties.IpConfiguration[0].Id -``` - -The first command gets a network interface object named Nic01 that belongs to the resource group named ResourceGroup01, and stores it in the $Nic01 variable.The second command gets a network interface object named Nic02 that belongs to the resource group named ResourceGroup02, and stores it in the $Nic02 variable.The third command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01, and stores it in the $AppGw variable.The forth command uses the back-end IP configuration IDs from $Nic01 and $Nic02 to add the back-end address pool of the application gateway stored in $AppGw. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway to which this cmdlet adds a back-end address pool. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -BackendFqdns -Specifies a list of backend FQDNs which this cmdlet adds as a back-end server pool. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendIPAddresses -Specifies a list of back-end IP addresses which this cmdlet adds as a back-end server pool. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the back-end server pool that this cmdlet adds. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGatewayBackendAddressPool](./Get-AzureRmApplicationGatewayBackendAddressPool.md) - -[Get-AzureRmApplicationGatewayBackendAddressPool](./Get-AzureRmApplicationGatewayBackendAddressPool.md) - -[New-AzureRmApplicationGatewayBackendAddressPool](./New-AzureRmApplicationGatewayBackendAddressPool.md) - -[Remove-AzureRmApplicationGatewayBackendAddressPool](./Remove-AzureRmApplicationGatewayBackendAddressPool.md) - -[Set-AzureRmApplicationGatewayBackendAddressPool](./Set-AzureRmApplicationGatewayBackendAddressPool.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayBackendHttpSettings.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayBackendHttpSettings.md deleted file mode 100644 index 0c977cc4c2..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayBackendHttpSettings.md +++ /dev/null @@ -1,314 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermapplicationgatewaybackendhttpsettings -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmApplicationGatewayBackendHttpSettings.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmApplicationGatewayBackendHttpSettings.md ---- - -# Add-AzureRmApplicationGatewayBackendHttpSettings - -## SYNOPSIS -Adds back-end HTTP settings to an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmApplicationGatewayBackendHttpSettings -ApplicationGateway <PSApplicationGateway> -Name <String> - -Port <Int32> -Protocol <String> -CookieBasedAffinity <String> [-RequestTimeout <Int32>] - [-ConnectionDraining <PSApplicationGatewayConnectionDraining>] [-ProbeId <String>] - [-Probe <PSApplicationGatewayProbe>] - [-AuthenticationCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate]>] - [-TrustedRootCertificate <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayTrustedRootCertificate]>] - [-PickHostNameFromBackendAddress] [-HostName <String>] [-AffinityCookieName <String>] [-Path <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Add-AzureRmApplicationGatewayBackendHttpSettings cmdlet adds back-end HTTP settings to an application gateway. -Back-end HTTP settings are applied to all back-end servers in the pool. - -## EXAMPLES - -### Example 1: Add back-end HTTP settings to an application gateway -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Add-AzureRmApplicationGatewayBackendHttpSettings -ApplicationGateway $AppGw -Name "Setting02" -Port 88 -Protocol "HTTP" -CookieBasedAffinity "Disabled" -``` - -The first command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $AppGw variable.The second command adds back-end HTTP settings to the application gateway, setting the port to 88 and the protocol to HTTP and names the settings Setting02. - -## PARAMETERS - -### -AffinityCookieName -Cookie name to use for the affinity cookie - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationGateway -Specifies the name of application gateway for which this cmdlet adds settings. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AuthenticationCertificates -Specifies authentication certificates for the application gateway. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionDraining -Connection draining of the backend http settings resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayConnectionDraining -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CookieBasedAffinity -Specifies whether cookie-based affinity should be enabled or disabled for the backend server pool. -The acceptable values for this parameter are: Disabled, Enabled. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostName -Sets host header to be sent to the backend servers. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the back-end HTTP settings which this cmdlet adds. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Path which should be used as a prefix for all HTTP requests. -If no value is provided for this parameter, then no path will be prefixed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PickHostNameFromBackendAddress -Flag if host header should be picked from the host name of the backend server. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Port -Specifies the port of the back-end server pool. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Probe -Specifies a probe to associate with a back-end server. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayProbe -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeId -Specifies the ID of the probe to associate with the back-end server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol for communication between application gateway and back-end servers. -The acceptable values for this parameter are: Http and Https. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Http, Https - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestTimeout -Specifies the request time-out value. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrustedRootCertificate -Application gateway Trusted Root Certificates - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayTrustedRootCertificate] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGatewayBackendHttpSettings]() - -[New-AzureRmApplicationGatewayBackendHttpSettings]() - -[Remove-AzureRmApplicationGatewayBackendHttpSettings]() - -[Set-AzureRmApplicationGatewayBackendHttpSettings]() - diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayCustomError.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayCustomError.md deleted file mode 100644 index eae2dfe204..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayCustomError.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermapplicationgatewaycustomerror -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmApplicationGatewayCustomError.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmApplicationGatewayCustomError.md ---- - -# Add-AzureRmApplicationGatewayCustomError - -## SYNOPSIS -Adds a custom error to an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmApplicationGatewayCustomError -ApplicationGateway <PSApplicationGateway> -StatusCode <String> - -CustomErrorPageUrl <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmApplicationGatewayCustomError** cmdlet adds a custom error to an application gateway. - -## EXAMPLES - -### Example 1: Adds custom error to application gateway level -```powershell -PS C:\> $customError502Url = "https://mycustomerrorpages.blob.core.windows.net/errorpages/502.htm" -PS C:\> $updatedgateway = Add-AzureRmApplicationGatewayCustomError -ApplicationGateway $appgw -StatusCode HttpStatus502 -CustomErrorPageUrl $customError502Url -``` - -This command adds a custom error of http status code 502 to the application gateway $appgw, and return the updated gateway. - -## PARAMETERS - -### -ApplicationGateway -The Application Gateway - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CustomErrorPageUrl -Error page URL of the application gateway customer error. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StatusCode -Status code of the application gateway customer error. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayFrontendIPConfig.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayFrontendIPConfig.md deleted file mode 100644 index f4e1d74b8d..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayFrontendIPConfig.md +++ /dev/null @@ -1,234 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 0ECE4232-EA5D-46A0-8260-69646E27FA9A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermapplicationgatewayfrontendipconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmApplicationGatewayFrontendIPConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmApplicationGatewayFrontendIPConfig.md ---- - -# Add-AzureRmApplicationGatewayFrontendIPConfig - -## SYNOPSIS -Adds a front-end IP configuration to an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -Add-AzureRmApplicationGatewayFrontendIPConfig -ApplicationGateway <PSApplicationGateway> -Name <String> - [-PrivateIPAddress <String>] [-SubnetId <String>] [-PublicIPAddressId <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -Add-AzureRmApplicationGatewayFrontendIPConfig -ApplicationGateway <PSApplicationGateway> -Name <String> - [-PrivateIPAddress <String>] [-Subnet <PSSubnet>] [-PublicIPAddress <PSPublicIpAddress>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmApplicationGatewayFrontendIPConfig** cmdlet adds a front-end IP configuration to an application gateway. -An application gateway supports two types of front-end IP configurations: -- Public IP addresses -- Private IP addresses using internal load-balancing (ILB) -An application gateway can have at most one public IP and one private IP. -Add the public IP address and private IP address as separate front-end IPs. - -## EXAMPLES - -### Example 1: Add a public IP as the front-end IP address -``` -PS C:\>$PublicIp = New-AzureRmPublicIpAddress -ResourceGroupName "ResourceGroup01" -Name "PublicIp01" -location "West US" -AllocationMethod Dynamic -PS C:\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Add-AzureRmApplicationGatewayFrontendIPConfig -ApplicationGateway $AppGw -Name "FrontEndIp01" -PublicIPAddress $PublicIp -``` - -The first command creates a public IP address object and stores it in the $PublicIp variable. -The second command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01, and stores it in the $AppGw variable. -The third command adds the front-end IP configuration named FrontEndIp01, for the gateway in $AppGw, using the address stored in $PublicIp. - -### Example 2: Add a static private IP as the front-end IP address -``` -PS C:\>$VNet = Get-AzureRmvirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $VNet -PS C:\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Add-AzureRmApplicationGatewayFrontendIPConfig -ApplicationGateway $AppGw -Name "FrontendIP02" -Subnet $Subnet -PrivateIPAddress 10.0.1.1 -``` - -The first command gets a virtual network named VNet01 that belongs to the resource group named ResourceGroup01, and stores it in the $VNet variable. -The second command gets a subnet configuration named Subnet01 using $VNet from the first command and stores it in the $Subnet variable. -The third command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01, and stores it in the $AppGw variable. -The fourth command adds a front-end IP configuration named FrontendIP02 using $Subnet from the second command and the private IP address 10.0.1.1. - -### Example 3: Add a dynamic private IP as the front-end IP address -``` -PS C:\>$VNet = Get-AzureRmvirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $VNet -PS C:\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Add-AzureRmApplicationGatewayFrontendIPConfig -ApplicationGateway $AppGw -Name "FrontendIP02" -Subnet $Subnet -``` - -The first command gets a virtual network named VNet01 that belongs to the resource group named ResourceGroup01, and stores it in the $VNet variable. -The second command gets a subnet configuration named Subnet01 using $VNet from the first command and stores it in the $Subnet variable. -The third command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01, and stores it in the $AppGw variable. -The fourth command adds a front-end IP configuration named FrontendIP02 using $Subnet from the second command. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway to which this cmdlet adds a front-end IP configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the front-end IP configuration to add. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateIPAddress -Specifies the private IP address to add as a front-end IP for the application gateway. -If specified, this IP is statically allocated from the subnet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIPAddress -Specifies the public IP address which this cmdlet adds as a front-end IP address for the application gateway. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIPAddressId -Specifies the ID of the public IP address which this cmdlet adds as a front-end IP address for the application gateway. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subnet -Specifies the subnet which this cmdlet adds as front-end IP configuration. -If you specify this parameter, it implies that the application gateway supports a private IP based-configuration. -If the *PrivateIPAddress* parameter is specified, it should belong to this subnet. -If *PrivateIPAddress* is not specified, one of the IP addresses from this subnet is dynamically picked up as the front-end IP address of the application gateway. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSSubnet -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetId -Specifies the subnet ID which this cmdlet adds as the front-end IP configuration. -Passing subnet implies private IP. -If the *PrivateIPAddresss* parameter is specified, it should belong to this subnet. -Otherwise, one of the IP from this subnet is dynamically picked up as the front-end IP of the application gateway. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGatewayFrontendIPConfig](./Get-AzureRmApplicationGatewayFrontendIPConfig.md) - -[New-AzureRmApplicationGatewayFrontendIPConfig](./New-AzureRmApplicationGatewayFrontendIPConfig.md) - -[Remove-AzureRmApplicationGatewayFrontendIPConfig](./Remove-AzureRmApplicationGatewayFrontendIPConfig.md) - -[Set-AzureRmApplicationGatewayFrontendIPConfig](./Set-AzureRmApplicationGatewayFrontendIPConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayFrontendPort.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayFrontendPort.md deleted file mode 100644 index 3df6f01953..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayFrontendPort.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 40198C86-A4EB-494A-86D5-DF632518EB95 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermapplicationgatewayfrontendport -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmApplicationGatewayFrontendPort.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmApplicationGatewayFrontendPort.md ---- - -# Add-AzureRmApplicationGatewayFrontendPort - -## SYNOPSIS -Adds a front-end port to an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmApplicationGatewayFrontendPort -ApplicationGateway <PSApplicationGateway> -Name <String> - -Port <Int32> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmApplicationGatewayFrontendPort** cmdlet adds a front-end port to an application gateway. - -## EXAMPLES - -### Example 1: Add a front-end port to an application gateway -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Add-AzureRmApplicationGatewayFrontendPort -ApplicationGateway $AppGw -Name "FrontEndPort01" -Port 80 -``` - -The first command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $AppGw variable. -The second command adds port 80 as a front-end port for the application gateway stored in $AppGw and names the port FrontEndPort01. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway to which this cmdlet adds a front-end port. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the front-end port. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Port -Specifies the port number. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGatewayFrontendPort](./Get-AzureRmApplicationGatewayFrontendPort.md) - -[New-AzureRmApplicationGatewayFrontendPort](./New-AzureRmApplicationGatewayFrontendPort.md) - -[Remove-AzureRmApplicationGatewayFrontendPort](./Remove-AzureRmApplicationGatewayFrontendPort.md) - -[Set-AzureRmApplicationGatewayFrontendPort](./Set-AzureRmApplicationGatewayFrontendPort.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayHttpListener.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayHttpListener.md deleted file mode 100644 index f970b05187..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayHttpListener.md +++ /dev/null @@ -1,268 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 1E192553-61D8-4449-936B-68CF866C710C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermapplicationgatewayhttplistener -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmApplicationGatewayHttpListener.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmApplicationGatewayHttpListener.md ---- - -# Add-AzureRmApplicationGatewayHttpListener - -## SYNOPSIS -Adds an HTTP listener to an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -Add-AzureRmApplicationGatewayHttpListener -ApplicationGateway <PSApplicationGateway> -Name <String> - [-FrontendIPConfigurationId <String>] [-FrontendPortId <String>] [-SslCertificateId <String>] - [-HostName <String>] [-RequireServerNameIndication <String>] -Protocol <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -Add-AzureRmApplicationGatewayHttpListener -ApplicationGateway <PSApplicationGateway> -Name <String> - [-FrontendIPConfiguration <PSApplicationGatewayFrontendIPConfiguration>] - [-FrontendPort <PSApplicationGatewayFrontendPort>] [-SslCertificate <PSApplicationGatewaySslCertificate>] - [-HostName <String>] [-RequireServerNameIndication <String>] -Protocol <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmApplicationGatewayHttpListener** cmdlet adds a HTTP listener to an application gateway. - -## EXAMPLES - -### Example 1: Add a HTTP listener -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Appgw = Add-AzureRmApplicationGatewayHttpListener -ApplicationGateway $AppGw -Name "listener01" -Protocol "Http" -FrontendIpConfiguration $FIP01 -FrontendPort $FP01 -``` - -The first command gets the application gateway and stores it in the $AppGw variable.The second command adds the HTTP listener to the application gateway. - -### Example 2: Add a HTTPS listener with SSL -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Add-AzureRmApplicationGatewayHttpListener -ApplicationGateway $AppGw -Name "Listener01" -Protocol "Https" -FrontendIpConfiguration $FIP01 -FrontendPort $FP01 -SslCertificate $SSLCert01 -``` - -The first command gets the application gateway and stores it in the $AppGw variable. -The second command adds the listener, which uses the HTTPS protocol, to the application gateway. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway to which this cmdlet adds an HTTP listener. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIPConfiguration -Specifies the application gateway front-end IP resource object. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendIPConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIPConfigurationId -Specifies the application gateway front-end IP ID. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendPort -Specifies the application gateway front-end port object. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendPort -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendPortId -Specifies the application gateway front-end port ID. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostName -Specifies the host name that this cmdlet adds a HTTP listener to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the front-end port that this command adds. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol of the HTTP listener. -Both HTTP and HTTPS are supported. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Http, Https - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequireServerNameIndication -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: true, false - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SslCertificate -Specifies the SSL certificate of the HTTP listener. -Must be specified if HTTPS is chosen as listener protocol. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslCertificate -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SslCertificateId -Specifies the SSL certificate ID of the HTTP listener. -Must be specified if HTTPS is chosen as listener protocol. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGatewayHttpListener](./Get-AzureRmApplicationGatewayHttpListener.md) - -[New-AzureRmApplicationGatewayHttpListener](./New-AzureRmApplicationGatewayHttpListener.md) - -[Remove-AzureRmApplicationGatewayHttpListener](./Remove-AzureRmApplicationGatewayHttpListener.md) - -[Set-AzureRmApplicationGatewayHttpListener](./Set-AzureRmApplicationGatewayHttpListener.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayHttpListenerCustomError.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayHttpListenerCustomError.md deleted file mode 100644 index 4c9ac17edc..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayHttpListenerCustomError.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermapplicationgatewayhttplistenercustomerror -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmApplicationGatewayHttpListenerCustomError.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmApplicationGatewayHttpListenerCustomError.md ---- - -# Add-AzureRmApplicationGatewayHttpListenerCustomError - -## SYNOPSIS -Adds a custom error to a http listener of an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmApplicationGatewayHttpListenerCustomError -HttpListener <PSApplicationGatewayHttpListener> - -StatusCode <String> -CustomErrorPageUrl <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmApplicationGatewayCustomError** cmdlet adds a custom error to a http listener of an application gateway. - -## EXAMPLES - -### Example 1: Adds custom error to http listener level -```powershell -PS C:\> $customError502Url = "https://mycustomerrorpages.blob.core.windows.net/errorpages/502.htm" -PS C:\> $updatedlistener = Add-AzureRmApplicationGatewayCustomError -HttpListener $listener01 -StatusCode HttpStatus502 -CustomErrorPageUrl $customError502Url -``` - -This command adds a custom error of http status code 502 to the http listener $listener01, and return the updated listener. - -## PARAMETERS - -### -CustomErrorPageUrl -Error page URL of the application gateway customer error. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpListener -The Application Gateway Http Listener - -```yaml -Type: PSApplicationGatewayHttpListener -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -StatusCode -Status code of the application gateway customer error. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayIPConfiguration.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayIPConfiguration.md deleted file mode 100644 index e2ab5e69c9..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayIPConfiguration.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 5358C08F-A1EB-457E-85B1-7F12396A873A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermapplicationgatewayipconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmApplicationGatewayIPConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmApplicationGatewayIPConfiguration.md ---- - -# Add-AzureRmApplicationGatewayIPConfiguration - -## SYNOPSIS -Adds an IP configuration to an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -Add-AzureRmApplicationGatewayIPConfiguration -ApplicationGateway <PSApplicationGateway> -Name <String> - [-SubnetId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -Add-AzureRmApplicationGatewayIPConfiguration -ApplicationGateway <PSApplicationGateway> -Name <String> - [-Subnet <PSSubnet>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmApplicationGatewayIPConfiguration** cmdlet adds an IP configuration to an application gateway. -IP configurations contain the subnet in which the application gateway is deployed. - -## EXAMPLES - -### Example 1: Add an virtual network configuration to an application gateway -``` -PS C:\>$Vnet = Get-AzureRmVirtualNetwork -Name "Vnet01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $Vnet -PS C:\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Add-AzureRmApplicationGatewayIPConfiguration -ApplicationGateway $AppGw -Name "Appgwsubnet01" -Subnet $Subnet -``` - -The first command creates a virtual network. -The second command creates a subnet using the previously created virtual network. -The third command gets the application gateway and stores it in the $AppGw variable. -The fouth command adds the IP configuration to the application gateway stored in $AppGw. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway to which this cmdlet adds an IP configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the IP configuration to add. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subnet -Specifies a subnet. -This is the subnet in which the application gateway is deployed. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSSubnet -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetId -Specifies a subnet ID. -This is the subnet in which the application gateway is deployed. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGatewayIPConfiguration](./Get-AzureRmApplicationGatewayIPConfiguration.md) - -[New-AzureRmApplicationGatewayIPConfiguration](./New-AzureRmApplicationGatewayIPConfiguration.md) - -[Remove-AzureRmApplicationGatewayIPConfiguration](./Remove-AzureRmApplicationGatewayIPConfiguration.md) - -[Set-AzureRmApplicationGatewayIPConfiguration](./Set-AzureRmApplicationGatewayIPConfiguration.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayProbeConfig.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayProbeConfig.md deleted file mode 100644 index 91b8bcfea0..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayProbeConfig.md +++ /dev/null @@ -1,260 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermapplicationgatewayprobeconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmApplicationGatewayProbeConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmApplicationGatewayProbeConfig.md ---- - -# Add-AzureRmApplicationGatewayProbeConfig - -## SYNOPSIS -Adds a health probe to an Application Gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmApplicationGatewayProbeConfig -ApplicationGateway <PSApplicationGateway> -Name <String> - -Protocol <String> [-HostName <String>] -Path <String> -Interval <Int32> -Timeout <Int32> - -UnhealthyThreshold <Int32> [-PickHostNameFromBackendHttpSettings] [-MinServers <Int32>] - [-Match <PSApplicationGatewayProbeHealthResponseMatch>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Add-AzureRmApplicationGatewayProbeConfig cmdlet adds a health probe to an Application Gateway. - -## EXAMPLES - -### Example 1: Add a health probe to an application gateway -``` -PS C:\>$Probe = Add-AzureRmApplicationGatewayProbeConfig -ApplicationGateway Gateway -Name "Probe01" -Protocol Http -HostName "contoso.com" -Path "/path/custompath.htm" -Interval 30 -Timeout 120 -UnhealthyThreshold 8 -``` - -This command adds a health probe named Probe01 for the application gateway named Gateway. -The command also sets the unhealthy threshold to 8 retries and times out after 120 seconds. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway to which this cmdlet adds a probe. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostName -Specifies the host name that this cmdlet sends the probe to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Interval -Specifies the probe interval in seconds. -This is the time interval between two consecutive probes. -This value is between 1 second and 86400 seconds. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Match -Body that must be contained in the health response. -Default value is empty - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayProbeHealthResponseMatch -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinServers -Minimum number of servers that are always marked healthy. -Default value is 0 - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the probe. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the relative path of probe. -Valid path start with the slash character (/). -The probe is sent to \<Protocol\>://\<host\>:\<port\>\<path\>. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PickHostNameFromBackendHttpSettings -Whether the host header should be picked from the backend http settings. -Default value is false - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol used to send probe. -This cmdlet supports HTTP only. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Http, Https - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Timeout -Specifies the probe timeout in seconds. -This cmdlet marks the probe as failed if a valid response is not received with this timeout period. -Valid values are between 1 second and 86400 seconds. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UnhealthyThreshold -Specifies the probe retry count. -The backend server is marked down after consecutive probe failure count reaches the unhealthy threshold. -Valid values are between 1 second and 20 seconds. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Add a probe to an existing application gateway](https://azure.microsoft.com/en-us/documentation/articles/application-gateway-create-probe-ps/#add-a-probe-to-an-existing-application-gateway) - -[Get-AzureRmApplicationGatewayProbeConfig]() - -[New-AzureRmApplicationGatewayProbeConfig]() - -[Remove-AzureRmApplicationGatewayProbeConfig]() - -[Set-AzureRmApplicationGatewayProbeConfig]() - diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayRedirectConfiguration.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayRedirectConfiguration.md deleted file mode 100644 index 321b14d365..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayRedirectConfiguration.md +++ /dev/null @@ -1,208 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermapplicationgatewayredirectconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmApplicationGatewayRedirectConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmApplicationGatewayRedirectConfiguration.md ---- - -# Add-AzureRmApplicationGatewayRedirectConfiguration - -## SYNOPSIS -Adds a redirect configuration to an Application Gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -Add-AzureRmApplicationGatewayRedirectConfiguration -ApplicationGateway <PSApplicationGateway> -Name <String> - -RedirectType <String> [-TargetListenerID <String>] [-IncludePath <Boolean>] [-IncludeQueryString <Boolean>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -Add-AzureRmApplicationGatewayRedirectConfiguration -ApplicationGateway <PSApplicationGateway> -Name <String> - -RedirectType <String> [-TargetListener <PSApplicationGatewayHttpListener>] [-IncludePath <Boolean>] - [-IncludeQueryString <Boolean>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByURL -``` -Add-AzureRmApplicationGatewayRedirectConfiguration -ApplicationGateway <PSApplicationGateway> -Name <String> - -RedirectType <String> [-TargetUrl <String>] [-IncludePath <Boolean>] [-IncludeQueryString <Boolean>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmApplicationGatewayRedirectConfiguration** cmdlet adds a redirect configuration to an Application Gateway. - -## EXAMPLES - -### Example 1 -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\>$Appgw = Add-AzureRmApplicationGatewayRedirectConfiguration -ApplicationGateway $AppGw -Name "Redirect01" -RedirectType Permanent -TargetListener $listener01 -``` - -The first command gets the application gateway and stores it in the $AppGw variable. -The second command adds the redirect configuration to the application gateway. - -## PARAMETERS - -### -ApplicationGateway -The applicationGateway - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludePath -Include path in the redirected url. -Default is true. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeQueryString -Include query string in the redirected url. -Default is true. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the Redirect Configuration - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedirectType -The type of redirect - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Permanent, Found, SeeOther, Temporary - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetListener -HTTPListener to redirect the request to - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetListenerID -ID of listener to redirect the request to - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetUrl -Target URL fo redirection - -```yaml -Type: System.String -Parameter Sets: SetByURL -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayRequestRoutingRule.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayRequestRoutingRule.md deleted file mode 100644 index fd9c1fb89d..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayRequestRoutingRule.md +++ /dev/null @@ -1,287 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: BBA600C2-4813-4C12-8447-E770A949DA32 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermapplicationgatewayrequestroutingrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmApplicationGatewayRequestRoutingRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmApplicationGatewayRequestRoutingRule.md ---- - -# Add-AzureRmApplicationGatewayRequestRoutingRule - -## SYNOPSIS -Adds a request routing rule to an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -Add-AzureRmApplicationGatewayRequestRoutingRule -ApplicationGateway <PSApplicationGateway> -Name <String> - -RuleType <String> [-BackendHttpSettingsId <String>] [-HttpListenerId <String>] - [-BackendAddressPoolId <String>] [-UrlPathMapId <String>] [-RedirectConfigurationId <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -Add-AzureRmApplicationGatewayRequestRoutingRule -ApplicationGateway <PSApplicationGateway> -Name <String> - -RuleType <String> [-BackendHttpSettings <PSApplicationGatewayBackendHttpSettings>] - [-HttpListener <PSApplicationGatewayHttpListener>] - [-BackendAddressPool <PSApplicationGatewayBackendAddressPool>] [-UrlPathMap <PSApplicationGatewayUrlPathMap>] - [-RedirectConfiguration <PSApplicationGatewayRedirectConfiguration>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmApplicationGatewayRequestRoutingRule** cmdlet adds a request routing rule to an application gateway. - -## EXAMPLES - -### Example 1: Add a request routing rule to an application gateway -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Appgw = Add-AzureRmApplicationGatewayRequestRoutingRule -ApplicationGateway $AppGw -Name "Rule01" -RuleType Basic -BackendHttpSettings $Setting -HttpListener $Listener -BackendAddressPool $Pool -``` - -The first command gets the application gateway and stores it in the $AppGw variable. -The second command adds the request routing rule to the application gateway. - -## PARAMETERS - -### -ApplicationGateway -Specifies an application gateway to which this cmdlet adds a request routing rule. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -BackendAddressPool -Specifies an application gateway back-end address pool object. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendAddressPoolId -Specifies an application gateway back-end address pool ID. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendHttpSettings -Specifies a back-end HTTP settings object for an application gateway. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendHttpSettingsId -Specifies a backend HTTP settings ID for an application gateway. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpListener -Specifies application gateway HTTP listener object. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpListenerId -Specifies application gateway HTTP listener ID. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of request routing rule this cmdlet adds. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedirectConfiguration -Application gateway RedirectConfiguration - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRedirectConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedirectConfigurationId -ID of the application gateway RedirectConfiguration - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RuleType -Specifies the type of request routing rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Basic, PathBasedRouting - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UrlPathMap -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayUrlPathMap -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UrlPathMapId -Specifies the URL path map ID for the routing rule. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGatewayRequestRoutingRule](./Get-AzureRmApplicationGatewayRequestRoutingRule.md) - -[New-AzureRmApplicationGatewayRequestRoutingRule](./New-AzureRmApplicationGatewayRequestRoutingRule.md) - -[Remove-AzureRmApplicationGatewayRequestRoutingRule](./Remove-AzureRmApplicationGatewayRequestRoutingRule.md) - -[Set-AzureRmApplicationGatewayRequestRoutingRule](./Set-AzureRmApplicationGatewayRequestRoutingRule.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewaySslCertificate.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewaySslCertificate.md deleted file mode 100644 index 0671f6c3a2..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewaySslCertificate.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 7EC4C642-1D23-4699-AE00-6E180C38271E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermapplicationgatewaysslcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmApplicationGatewaySslCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmApplicationGatewaySslCertificate.md ---- - -# Add-AzureRmApplicationGatewaySslCertificate - -## SYNOPSIS -Adds an SSL certificate to an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmApplicationGatewaySslCertificate -ApplicationGateway <PSApplicationGateway> -Name <String> - -CertificateFile <String> -Password <SecureString> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmApplicationGatewaySslCertificate** cmdlet adds an SSL certificate to an application gateway. - -## EXAMPLES - -### Example 1: Add an SSL certificate to an application gateway. -``` -PS C:\> $AppGW = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $password = ConvertTo-SecureString "P@ssw0rd" -AsPlainText -Force -PS C:\> $AppGW = Add-AzureRmApplicationGatewaySslCertificate -ApplicationGateway $AppGW -Name "Cert01" -CertificateFile "D:\cert01.pfx" -Password $password -``` - -This command gets an application gateway named ApplicationGateway01 and then adds an SSL certificate named Cert01 to it. - -## PARAMETERS - -### -ApplicationGateway -Specifies the name of application gateway to which this cmdlet adds an SSL certificate. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CertificateFile -Specifies the .pfx file of an SSL certificate that this cmdlet adds. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the SSL certificate that this cmdlet adds. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -Specifies the password of the SSL certificate that this cmdlet adds. - -```yaml -Type: System.Security.SecureString -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGatewaySslCertificate](./Get-AzureRmApplicationGatewaySslCertificate.md) - -[New-AzureRmApplicationGatewaySslCertificate](./New-AzureRmApplicationGatewaySslCertificate.md) - -[Remove-AzureRmApplicationGatewaySslCertificate](./Remove-AzureRmApplicationGatewaySslCertificate.md) - -[Set-AzureRmApplicationGatewaySslCertificate](./Set-AzureRmApplicationGatewaySslCertificate.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayTrustedRootCertificate.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayTrustedRootCertificate.md deleted file mode 100644 index eac6e198ba..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayTrustedRootCertificate.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermapplicationgatewaytrustedrootcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmApplicationGatewayTrustedRootCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmApplicationGatewayTrustedRootCertificate.md ---- - -# Add-AzureRmApplicationGatewayTrustedRootCertificate - -## SYNOPSIS -Adds a trusted root certificate to an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmApplicationGatewayTrustedRootCertificate -ApplicationGateway <PSApplicationGateway> -Name <String> - -CertificateFile <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmApplicationGatewayTrustedRootCertificate** cmdlet adds a trusted root certificate to an Azure application gateway. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> $gw = Get-AzureRmApplicationGateway -Name $appgwName -ResourceGroupName $resgpName -PS C:\> $gw = Add-AzureRmApplicationGatewayTrustedRootCertificate -ApplicationGateway $gw -Name $certName --CertificateFile ".\rootCA.cer" -PS C:\> $gw = Add-AzureRmApplicationGatewayBackendHttpSetting -Name $poolSetting01Name -Port 443 -Protocol Https -CookieBasedAffinity Enabled -PickHostNameFromBackendAddress -TrustedRootCertificate $gw.TrustedRootCertificates[0] -PS C:\> $gw = Set-AzureRmApplicationGateway -ApplicationGateway $gw -``` - -The first command gets the application gateway and stores it in $gw variable. -The second command addes a new trusted root certificate to Application Gateway taking path of the root certificate as input. -The third command creates new backend http setting using trusted root certificate for validating the backend server certificate against. -The fouth command updates the Application Gateway. - -## PARAMETERS - -### -ApplicationGateway -The applicationGateway - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CertificateFile -Path of certificate CER file - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the TrustedRoot certificate - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayUrlPathMapConfig.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayUrlPathMapConfig.md deleted file mode 100644 index 7ec147db3c..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmApplicationGatewayUrlPathMapConfig.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 9D9D079C-5557-40DC-8CFB-1DCD446D9109 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermapplicationgatewayurlpathmapconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmApplicationGatewayUrlPathMapConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmApplicationGatewayUrlPathMapConfig.md ---- - -# Add-AzureRmApplicationGatewayUrlPathMapConfig - -## SYNOPSIS -Adds an array of URL path mappings to a backend server pool. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -Add-AzureRmApplicationGatewayUrlPathMapConfig -ApplicationGateway <PSApplicationGateway> -Name <String> - -PathRules <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPathRule]> - [-DefaultBackendAddressPoolId <String>] [-DefaultBackendHttpSettingsId <String>] - [-DefaultRedirectConfigurationId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -Add-AzureRmApplicationGatewayUrlPathMapConfig -ApplicationGateway <PSApplicationGateway> -Name <String> - -PathRules <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPathRule]> - [-DefaultBackendAddressPool <PSApplicationGatewayBackendAddressPool>] - [-DefaultBackendHttpSettings <PSApplicationGatewayBackendHttpSettings>] - [-DefaultRedirectConfiguration <PSApplicationGatewayRedirectConfiguration>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmApplicationGatewayUrlPathMapConfig** cmdlet adds an array of URL path mappings to a back end server pool. - -## EXAMPLES - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway to which this cmdlet adds a URL path map configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultBackendAddressPool -Specifies the default backend address pool to route in case none of the rules specified in the *pathRules* parameter match. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultBackendAddressPoolId -Specifies the default backend address pool ID. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultBackendHttpSettings -Specifies the default backend HTTP settings to use in case none of the rules specified in the *pathRules* parameter match. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultBackendHttpSettingsId -Specifies the default backend HTTP settings ID. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultRedirectConfiguration -Application gateway default RedirectConfiguration - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRedirectConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultRedirectConfigurationId -ID of the application gateway default RedirectConfiguration - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the URL path map name that this cmdlet adds to the backend server pool. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PathRules -Specifies a list of path rules. -The path rules are order sensitive, they are applied in order they are specified. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPathRule] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGatewayUrlPathMapConfig](./Get-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[New-AzureRmApplicationGatewayUrlPathMapConfig](./New-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[Remove-AzureRmApplicationGatewayUrlPathMapConfig](./Remove-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[Set-AzureRmApplicationGatewayUrlPathMapConfig](./Set-AzureRmApplicationGatewayUrlPathMapConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmDelegation.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmDelegation.md deleted file mode 100644 index 2de2bc15f8..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmDelegation.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermdelegation -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmDelegation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmDelegation.md ---- - -# Add-AzureRmDelegation - -## SYNOPSIS -Adds a delegation to a subnet. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmDelegation -Name <String> -ServiceName <String> -Subnet <PSSubnet> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmDelegation** cmdlet adds a service delegation to an Azure subnet. - -## EXAMPLES - -### 1: Adding a delegation -```powershell -PS C:\> $vnet = Get-AzureRmVirtualNetwork -Name "myVNet" -ResourceGroupName "myResourceGroup" -PS C:\> $subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name "mySubnet" -VirtualNetwork $vnet -PS C:\> $subnet = Add-AzureRmDelegation -Name "myDelegation" -ServiceName "Microsoft.Sql/servers" -Subnet $subnet -PS C:\> Set-AzureRmVirtualNetwork $vnet -``` - -The first command retrieves the virtual network on which the subnet lies. The second command isolates out the subnet of interest - the one which you want to delegate. The third command adds a delegation to the subnet. This particular example would be useful when you want to enable SQL to create interface endpoints in this subnet. The final command sends the updated subnet to the server to actually update your subnet. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the delegation - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceName -The name of the service to which the subnet should be delegated - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Subnet -The subnet - -```yaml -Type: PSSubnet -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Network.Models.PSSubnet - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSSubnet - -## NOTES - -## RELATED LINKS -[Get-AzureRmVirtualNetwork](./Get-AzureRmVirtualNetwork.md) -[Get-AzureRmVirtualNetworkSubnetConfig](./Get-AzureRmVirtualNetworkSubnetConfig.md) -[Set-AzureRmVirtualNetwork](./Set-AzureRmVirtualNetwork.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmExpressRouteCircuitAuthorization.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmExpressRouteCircuitAuthorization.md deleted file mode 100644 index a4fd29ef82..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmExpressRouteCircuitAuthorization.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 9994E2B2-20A1-4E95-9A9F-379B8B63F7F5 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermexpressroutecircuitauthorization -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmExpressRouteCircuitAuthorization.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmExpressRouteCircuitAuthorization.md ---- - -# Add-AzureRmExpressRouteCircuitAuthorization - -## SYNOPSIS -Adds an ExpressRoute circuit authorization. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmExpressRouteCircuitAuthorization -Name <String> -ExpressRouteCircuit <PSExpressRouteCircuit> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmExpressRouteCircuitAuthorization** cmdlet adds an authorization to an ExpressRoute -circuit. ExpressRoute circuits connect your on-premises network to the Microsoft cloud by using a -connectivity provider instead of the public Internet. The owner of an ExpressRoute circuit can -create as many as 10 authorizations for each circuit; these authorizations generate an -authorization key that can be used by a virtual network owner to connect his or her network to the -circuit (one authorization per virtual network). **Add-AzureRmExpressRouteCircuitAuthorization** -adds a new authorization to a circuit and, at the same time, generates the corresponding -authorization key. These keys can be viewed at any time by running the -Get-AzureRmExpressRouteCircuitAuthorization cmdlet and, as needed, can then be copied and forwarded -to the appropriate network owner. -Note that, after running **Add-AzureRmExpressRouteCircuitAuthorization**, you must call the -Set-AzureRmExpressRouteCircuit cmdlet to activate the key. If you do not call -**Set-AzureRmExpressRouteCircuit** the authorization will be added to the circuit but will not be -enabled for use. - -## EXAMPLES - -### Example 1: Add an authorization to the specified ExpressRoute circuit -``` -$Circuit = Get-AzureRmExpressRouteCircuit -Name "ContosoCircuit" -ResourceGroupName "ContosoResourceGroup" -Add-AzureRmExpressRouteCircuitAuthorization -Name "ContosoCircuitAuthorization" -Circuit $Circuit -Set-AzureRmExpressRouteCircuit -ExpressRouteCircuit $Circuit -``` - -The commands in this example add a new authorization to an existing ExpressRoute circuit. The first -command uses **Get-AzureRmExpressRouteCircuit** to create an object reference to a circuit named -ContosoCircuit. That object reference is stored in a variable named $Circuit. -In the second command, the **Add-AzureRmExpressRouteCircuitAuthorization** cmdlet is used to add a -new authorization (ContosoCircuitAuthorization) to the ExpressRoute circuit. This command adds the -authorization but does not activate that authorization. Activating an authorization requires the -**Set-AzureRmExpressRouteCircuit** shown in the final command in the example. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpressRouteCircuit -Specifies the ExpressRoute circuit that this cmdlet adds the authorization to. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the circuit authorization to be added. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit -Parameters: ExpressRouteCircuit (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit - -## NOTES - -## RELATED LINKS - -[Get-AzureRmExpressRouteCircuit](./Get-AzureRmExpressRouteCircuit.md) - -[Get-AzureRmExpressRouteCircuitAuthorization](./Get-AzureRmExpressRouteCircuitAuthorization.md) - -[New-AzureRmExpressRouteCircuitAuthorization](./New-AzureRmExpressRouteCircuitAuthorization.md) - -[Remove-AzureRmExpressRouteCircuitAuthorization](./Remove-AzureRmExpressRouteCircuitAuthorization.md) - -[Set-AzureRmExpressRouteCircuit](./Set-AzureRmExpressRouteCircuit.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmExpressRouteCircuitConnectionConfig.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmExpressRouteCircuitConnectionConfig.md deleted file mode 100644 index d373c99f92..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmExpressRouteCircuitConnectionConfig.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 7b4a8c9f-874c-4a27-b87e-c8ad7e73188d -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermexpressroutecircuitconnectionconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmExpressRouteCircuitConnectionConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmExpressRouteCircuitConnectionConfig.md ---- - -# Add-AzureRmExpressRouteCircuitConnectionConfig - -## SYNOPSIS -Adds a circuit connection configuration to Private Peering of an Express Route Circuit. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Add-AzureRmExpressRouteCircuitConnectionConfig [-Name] <String> [-ExpressRouteCircuit] <PSExpressRouteCircuit> - [-AddressPrefix] <String> [-AuthorizationKey <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### SetByResourceId -``` -Add-AzureRmExpressRouteCircuitConnectionConfig [-Name] <String> [-ExpressRouteCircuit] <PSExpressRouteCircuit> - [-PeerExpressRouteCircuitPeering] <String> [-AddressPrefix] <String> [-AuthorizationKey <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmExpressRouteCircuitConnectionConfig** cmdlet adds a circuit connection configuration to -private peering for an ExpressRoute circuit. This allows peering two Express Route Circuits -across regions or subscriptions.Note that, after running **Add-AzureRmExpressRouteCircuitPeeringConfig**, -you must call the Set-AzureRmExpressRouteCircuit cmdlet to activate the configuration. - -## EXAMPLES - -### Example 1: Add a circuit connection resource to an existing ExpressRoute circuit -``` -$circuit_init = Get-AzureRmExpressRouteCircuit -Name $initiatingCircuitName -ResourceGroupName $rg -$circuit_peer = Get-AzureRmExpressRouteCircuit -Name $peeringCircuitName -ResourceGroupName $rg -$addressSpace = '60.0.0.0/29' -Add-AzureRmExpressRouteCircuitConnectionConfig -Name $circuitConnectionName -ExpressRouteCircuit $circuit_init -PeerExpressRouteCircuitPeering $circuit_peer.Peerings[0].Id -AddressPrefix $addressSpace -AuthorizationKey $circuit_peer.Authorizations[0].AuthorizationKey -Set-AzureRmExpressRouteCircuit -ExpressRouteCircuit $circuit_init -``` - -### Example 2: Add a circuit connection configuration using Piping to an existing ExpressRoute Circuit -``` -$circuit_peer = Get-AzureRmExpressRouteCircuit -Name $peeringCircuitName -ResourceGroupName $rg -$addressSpace = '60.0.0.0/29' -Get-AzureRmExpressRouteCircuit -Name $initiatingCircuitName -ResourceGroupName $rg|Add-AzureRmExpressRouteCircuitConnectionConfig -Name $circuitConnectionName -PeerExpressRouteCircuitPeering $circuit_peer.Peerings[0].Id -AddressPrefix $addressSpace -AuthorizationKey $circuit_peer.Authorizations[0].AuthorizationKey |Set-AzureRmExpressRouteCircuit -``` - -## PARAMETERS - -### -AddressPrefix -A minimum /29 customer address space to create VxLan tunnels between Express Route Circuits - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthorizationKey -Authorization Key to peer Express Route Circuit in another subscription. Authorization on peer circuit can be created using existing commands. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpressRouteCircuit -The ExpressRoute circuit being modified. This is Azure object returned by the -**Get-AzureRmExpressRouteCircuit** cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the circuit connection resource to be added. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PeerExpressRouteCircuitPeering -Resource Id for Private Peering of remote circuit which will be peered with the current circuit. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit -Parameters: ExpressRouteCircuit (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit - -## NOTES - -## RELATED LINKS - -[Get-AzureRmExpressRouteCircuit](Get-AzureRmExpressRouteCircuit.md) - -[Get-AzureRmExpressRouteCircuitConnectionConfig](Get-AzureRmExpressRouteCircuitConnectionConfig.md) - -[Remove-AzureRmExpressRouteCircuitConnectionConfig](Remove-AzureRmExpressRouteCircuitConnectionConfig.md) - - - - - -[Set-AzureRmExpressRouteCircuit](Set-AzureRmExpressRouteCircuit.md) - -[Get-AzureRmExpressRouteCircuit](Get-AzureRmExpressRouteCircuit.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmExpressRouteCircuitPeeringConfig.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmExpressRouteCircuitPeeringConfig.md deleted file mode 100644 index cc19837409..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmExpressRouteCircuitPeeringConfig.md +++ /dev/null @@ -1,361 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: C44AD23A-E575-418C-BE90-323B44D6D2E8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermexpressroutecircuitpeeringconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmExpressRouteCircuitPeeringConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmExpressRouteCircuitPeeringConfig.md ---- - -# Add-AzureRmExpressRouteCircuitPeeringConfig - -## SYNOPSIS -Adds a peering configuration to an ExpressRoute circuit. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Add-AzureRmExpressRouteCircuitPeeringConfig -Name <String> -ExpressRouteCircuit <PSExpressRouteCircuit> - -PeeringType <String> -PeerASN <UInt32> -PrimaryPeerAddressPrefix <String> - -SecondaryPeerAddressPrefix <String> -VlanId <Int32> [-SharedKey <String>] - [-MicrosoftConfigAdvertisedPublicPrefixes <System.Collections.Generic.List`1[System.String]>] - [-MicrosoftConfigCustomerAsn <Int32>] [-MicrosoftConfigRoutingRegistryName <String>] - [-PeerAddressType <String>] [-LegacyMode <Boolean>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### MicrosoftPeeringConfigRoutFilterId -``` -Add-AzureRmExpressRouteCircuitPeeringConfig -Name <String> -ExpressRouteCircuit <PSExpressRouteCircuit> - -PeeringType <String> -PeerASN <UInt32> -PrimaryPeerAddressPrefix <String> - -SecondaryPeerAddressPrefix <String> -VlanId <Int32> [-SharedKey <String>] - [-MicrosoftConfigAdvertisedPublicPrefixes <System.Collections.Generic.List`1[System.String]>] - [-MicrosoftConfigCustomerAsn <Int32>] [-MicrosoftConfigRoutingRegistryName <String>] -RouteFilterId <String> - [-PeerAddressType <String>] [-LegacyMode <Boolean>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### MicrosoftPeeringConfigRoutFilter -``` -Add-AzureRmExpressRouteCircuitPeeringConfig -Name <String> -ExpressRouteCircuit <PSExpressRouteCircuit> - -PeeringType <String> -PeerASN <UInt32> -PrimaryPeerAddressPrefix <String> - -SecondaryPeerAddressPrefix <String> -VlanId <Int32> [-SharedKey <String>] - [-MicrosoftConfigAdvertisedPublicPrefixes <System.Collections.Generic.List`1[System.String]>] - [-MicrosoftConfigCustomerAsn <Int32>] [-MicrosoftConfigRoutingRegistryName <String>] - -RouteFilter <PSRouteFilter> [-PeerAddressType <String>] [-LegacyMode <Boolean>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmExpressRouteCircuitPeeringConfig** cmdlet adds a peering configuration to an -ExpressRoute circuit. ExpressRoute circuits connect your on-premises network to the Microsoft cloud -by using a connectivity provider instead of the public Internet. Note that, after running -**Add-AzureRmExpressRouteCircuitPeeringConfig**, you must call the Set-AzureRmExpressRouteCircuit -cmdlet to activate the configuration. - -## EXAMPLES - -### Example 1: Add a peer to an existing ExpressRoute circuit -``` -$circuit = Get-AzureRmExpressRouteCircuit -Name $CircuitName -ResourceGroupName $rg -$parameters = @{ - Name = 'AzurePrivatePeering' - Circuit = $circuit - PeeringType = 'AzurePrivatePeering' - PeerASN = 100 - PrimaryPeerAddressPrefix = '10.6.1.0/30' - SecondaryPeerAddressPrefix = '10.6.2.0/30' - VlanId = 200 -} -Add-AzureRmExpressRouteCircuitPeeringConfig @parameters -Set-AzureRmExpressRouteCircuit -ExpressRouteCircuit $circuit -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpressRouteCircuit -The ExpressRoute circuit being modified. This is Azure object returned by the -**Get-AzureRmExpressRouteCircuit** cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LegacyMode -The legacy mode of the Peering - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MicrosoftConfigAdvertisedPublicPrefixes -For a PeeringType of MicrosoftPeering, you must provide a list of all prefixes you plan to -advertise over the BGP session. Only public IP address prefixes are accepted. You can send a comma -separated list if you plan to send a set of prefixes. These prefixes must be registered to you in -a Routing Registry Name (RIR / IRR). - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MicrosoftConfigCustomerAsn -If you are advertising prefixes that are not registered to the peering AS number, you can specify -the AS number to which they are registered. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MicrosoftConfigRoutingRegistryName -The Routing Registry Name (RIR / IRR) to which the AS number and prefixes are registered. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the peering relationship to be added. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PeerAddressType -PeerAddressType - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: IPv4, IPv6 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PeerASN -The AS number of your ExpressRoute circuit. This must be a Public ASN when the PeeringType is -AzurePublicPeering. - -```yaml -Type: System.UInt32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PeeringType -The acceptable values for this parameter are: `AzurePrivatePeering`, `AzurePublicPeering`, and -`MicrosoftPeering` - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: AzurePrivatePeering, AzurePublicPeering, MicrosoftPeering - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimaryPeerAddressPrefix -This is the IP Address range for the primary routing path of this peering relationship. This must -be a /30 CIDR subnet. The first odd-numbered address in this subnet should be assigned to your -router interface. Azure will configure the next even-numbered address to the Azure router interface. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteFilter -This is an existing RouteFilter object. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSRouteFilter -Parameter Sets: MicrosoftPeeringConfigRoutFilter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RouteFilterId -This is the resource Id of an existing RouteFilter object. - -```yaml -Type: System.String -Parameter Sets: MicrosoftPeeringConfigRoutFilterId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecondaryPeerAddressPrefix -This is the IP Address range for the secondary routing path of this peering relationship. This must -be a /30 CIDR subnet. The first odd-numbered address in this subnet should be assigned to your -router interface. Azure will configure the next even-numbered address to the Azure router interface. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharedKey -This is an optional MD5 hash used as a pre-shared key for the peering configuration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VlanId -This is the Id number of the VLAN assigned for this peering. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit -Parameters: ExpressRouteCircuit (ByValue) - -### System.String - -### Microsoft.Azure.Commands.Network.Models.PSRouteFilter - -### System.Boolean - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit - -## NOTES - -## RELATED LINKS - -[Get-AzureRmExpressRouteCircuit](Get-AzureRmExpressRouteCircuit.md) - -[New-AzureRmExpressRouteCircuitPeeringConfig](New-AzureRmExpressRouteCircuitPeeringConfig.md) - -[Remove-AzureRmExpressRouteCircuitPeeringConfig](Remove-AzureRmExpressRouteCircuitPeeringConfig.md) - -[Set-AzureRmExpressRouteCircuit](Set-AzureRmExpressRouteCircuit.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmLoadBalancerBackendAddressPoolConfig.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmLoadBalancerBackendAddressPoolConfig.md deleted file mode 100644 index 5bb0acbc9e..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmLoadBalancerBackendAddressPoolConfig.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 9EB11283-0189-4333-8142-DCC3F770F91A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermloadbalancerbackendaddresspoolconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmLoadBalancerBackendAddressPoolConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmLoadBalancerBackendAddressPoolConfig.md ---- - -# Add-AzureRmLoadBalancerBackendAddressPoolConfig - -## SYNOPSIS -Adds a backend address pool configuration to a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmLoadBalancerBackendAddressPoolConfig -LoadBalancer <PSLoadBalancer> -Name <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmLoadBalancerBackend** cmdlet adds a backend address pool to an Azure load balancer. - -## EXAMPLES - -### Example 1 Add a backend address pool configuration to a load balancer -``` -PS C:\>Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "myrg" | Add-AzureRmLoadBalancerBackendAddressPoolConfig -Name "BackendAddressPool02" | Set-AzureRmLoadBalancer -``` - -This command gets the load balancer named MyLoadBalancer, adds the backend address pool named BackendAddressPool02 to MyLoadBalancer, and then uses the **Set-AzureRmLoadBalancer** cmdlet to update MyLoadBalancer. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancer -Specifies a **LoadBalancer** object. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the backend address pool configuration to add. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameters: LoadBalancer (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[Get-AzureRmNetworkInterface](./Get-AzureRmNetworkInterface.md) - -[Get-AzureRmLoadBalancerBackendAddressPoolConfig](./Get-AzureRmLoadBalancerBackendAddressPoolConfig.md) - -[New-AzureRmLoadBalancerBackendAddressPoolConfig](./New-AzureRmLoadBalancerBackendAddressPoolConfig.md) - -[Remove-AzureRmLoadBalancerBackendAddressPoolConfig](./Remove-AzureRmLoadBalancerBackendAddressPoolConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmLoadBalancerFrontendIpConfig.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmLoadBalancerFrontendIpConfig.md deleted file mode 100644 index 79f35a4f0d..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmLoadBalancerFrontendIpConfig.md +++ /dev/null @@ -1,280 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 07FF274A-F365-44E5-A66B-6740CD165664 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermloadbalancerfrontendipconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmLoadBalancerFrontendIpConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmLoadBalancerFrontendIpConfig.md ---- - -# Add-AzureRmLoadBalancerFrontendIpConfig - -## SYNOPSIS -Adds a front-end IP configuration to a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceSubnet (Default) -``` -Add-AzureRmLoadBalancerFrontendIpConfig -LoadBalancer <PSLoadBalancer> -Name <String> - [-PrivateIpAddress <String>] [-Zone <System.Collections.Generic.List`1[System.String]>] -Subnet <PSSubnet> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByResourceIdSubnet -``` -Add-AzureRmLoadBalancerFrontendIpConfig -LoadBalancer <PSLoadBalancer> -Name <String> - [-PrivateIpAddress <String>] [-Zone <System.Collections.Generic.List`1[System.String]>] -SubnetId <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByResourceIdPublicIpAddress -``` -Add-AzureRmLoadBalancerFrontendIpConfig -LoadBalancer <PSLoadBalancer> -Name <String> - [-Zone <System.Collections.Generic.List`1[System.String]>] -PublicIpAddressId <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByResourcePublicIpAddress -``` -Add-AzureRmLoadBalancerFrontendIpConfig -LoadBalancer <PSLoadBalancer> -Name <String> - [-Zone <System.Collections.Generic.List`1[System.String]>] -PublicIpAddress <PSPublicIpAddress> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmLoadBalancerFrontendIpConifg** cmdlet adds a front-end IP configuration to an Azure load balancer. - -## EXAMPLES - -### Example 1 Add a front-end IP configuration with a dynamic IP address -``` -PS C:\>$Subnet = Get-AzureRmVirtualNetwork -Name "MyVnet" -ResourceGroupName "MyRg" | Get-AzureRmVirtualNetworkSubnetConfig -Name "MySubnet" -PS C:\> Get-AzureRmLoadBalancer -Name "MyLB" -ResourceGroupName "NrpTest" | Add-AzureRmLoadBalancerFrontendIpConfig -Name "FrontendName" -Subnet $Subnet | Set-AzureRmLoadBalancer -``` - -The first command gets the Azure virtual network named MyVnet and passes the result using the pipeline to the **Get-AzureRmVirtualNetworkSubnetConfig** cmdlet to get the subnet named MySubnet. -The command then stores the result in the variable named $Subnet. -The second command gets the load balancer named MyLB and passes the result to the **Add-AzureRmLoadBalancerFrontendIpConfig** cmdlet that adds a front-end IP configuration to the load balancer with a dynamic private IP address from the subnet stored in the variable named $MySubnet. - -### Example 2 Add a front-end IP configuration with a static IP address -``` -PS C:\>$Subnet = Get-AzureRmVirtualNetwork -Name "MyVnet" -ResourceGroupName "RG001" | Get-AzureRmVirtualNetworkSubnetConfig -Name "MySubnet" -PS C:\> Get-AzureRmLoadBalancer -Name "MyLB" -ResourceGroupName "NrpTest" | Add-AzureRmLoadBalancerFrontendIpConfig -Name "FrontendName" -Subnet $Subnet -PrivateIpAddress "10.0.1.6" | Set-AzureRmLoadBalancer -``` - -The first command gets the Azure virtual network named MyVnet and passes the result using the pipeline to the **Get-AzureRmVirtualNetworkSubnetConfig** cmdlet to get the subnet named MySubnet. -The command then stores the result in the variable named $Subnet. -The second command gets the load balancer named MyLB and passes the result to the **Add-AzureRmLoadBalancerFrontendIpConfig** cmdlet that adds a front-end IP configuration to the load balancer with a static private IP address from the subnet stored in the variable named $Subnet. - -### Example 3 Add a front-end IP configuration with a public IP address -``` -PS C:\>$PublicIp = Get-AzureRmPublicIpAddress -ResourceGroupName "myRG" -Name "MyPub" -PS C:\> Get-AzureRmLoadBalancer -Name "MyLB" -ResourceGroupName "NrpTest" | Add-AzureRmLoadBalancerFrontendIpConfig -Name "FrontendName" -PublicIpAddress $PublicIp | Set-AzureRmLoadBalancer -``` - -The first command gets the Azure public IP address named MyPub and stores the result in the variable named $PublicIp. -The second command gets the load balancer named MyLB and passes the result to the **Add-AzureRmLoadBalancerFrontendIpConfig** cmdlet that adds a front-end IP configuration to the load balancer with public IP address stored in the variable named $PublicIp. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancer -Specifies a **LoadBalancer** object. -This cmdlet adds a front-end IP configuration to the load balancer that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the front-end IP configuration to add. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateIpAddress -Specifies the private IP address to associate with a front-end IP configuration. - -```yaml -Type: System.String -Parameter Sets: SetByResourceSubnet, SetByResourceIdSubnet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublicIpAddress -Specifies the public IP address to associate with a front-end IP configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress -Parameter Sets: SetByResourcePublicIpAddress -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublicIpAddressId -Specifes the ID of the public IP address in which to add a front-end IP configuration. - -```yaml -Type: System.String -Parameter Sets: SetByResourceIdPublicIpAddress -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Subnet -Specifies the subnet object in which to add a front-end IP configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSSubnet -Parameter Sets: SetByResourceSubnet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubnetId -Specifies the ID of the subnet in which to add a front-end IP configuration. - -```yaml -Type: System.String -Parameter Sets: SetByResourceIdSubnet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Zone -A list of availability zones denoting the IP allocated for the resource needs to come from. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameters: LoadBalancer (ByValue) - -### System.Collections.Generic.List\`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLoadBalancerFrontendIpConfig](./Get-AzureRmLoadBalancerFrontendIpConfig.md) - -[Get-AzureRmVirtualNetwork](./Get-AzureRmVirtualNetwork.md) - -[Get-AzureRmVirtualNetworkSubnetConfig](./Get-AzureRmVirtualNetworkSubnetConfig.md) - -[New-AzureRmLoadBalancerFrontendIpConfig](./New-AzureRmLoadBalancerFrontendIpConfig.md) - -[Remove-AzureRmLoadBalancerFrontendIpConfig](./Remove-AzureRmLoadBalancerFrontendIpConfig.md) - -[Set-AzureRmLoadBalancerFrontendIpConfig](./Set-AzureRmLoadBalancerFrontendIpConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmLoadBalancerInboundNatPoolConfig.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmLoadBalancerInboundNatPoolConfig.md deleted file mode 100644 index b658bced2f..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmLoadBalancerInboundNatPoolConfig.md +++ /dev/null @@ -1,257 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: EB4DF001-AD05-4747-972B-5E4194A404C8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermloadbalancerinboundnatpoolconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmLoadBalancerInboundNatPoolConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmLoadBalancerInboundNatPoolConfig.md ---- - -# Add-AzureRmLoadBalancerInboundNatPoolConfig - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Add-AzureRmLoadBalancerInboundNatPoolConfig -LoadBalancer <PSLoadBalancer> -Name <String> -Protocol <String> - -FrontendPortRangeStart <Int32> -FrontendPortRangeEnd <Int32> -BackendPort <Int32> - [-IdleTimeoutInMinutes <Int32>] [-EnableFloatingIP] [-EnableTcpReset] - [-FrontendIpConfiguration <PSFrontendIPConfiguration>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### SetByResourceId -``` -Add-AzureRmLoadBalancerInboundNatPoolConfig -LoadBalancer <PSLoadBalancer> -Name <String> -Protocol <String> - -FrontendPortRangeStart <Int32> -FrontendPortRangeEnd <Int32> -BackendPort <Int32> - [-IdleTimeoutInMinutes <Int32>] [-EnableFloatingIP] [-EnableTcpReset] [-FrontendIpConfigurationId <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION - -## EXAMPLES - -### 1: Add -``` -PS C:\> $slb = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -PS C:\> $feIpConfig = Get-AzureRmLoadBalancerFrontendIpConfig -Name "FrontendName" -Loadbalancer $slb -PS C:\> $slb | Add-AzureRmLoadBalancerInboundNatPoolConfig -Name "myInboundNatPool" -Protocol TCP -FrontendIPConfigurationId $feIpConfig.Id -FrontendPortRangeStart 1001 -FrontendPortRangeEnd 2000 -BackendPort 1001 -``` - -## PARAMETERS - -### -BackendPort -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableFloatingIP -Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableTcpReset -Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIpConfiguration -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FrontendIpConfigurationId -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FrontendPortRangeEnd -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FrontendPortRangeStart -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IdleTimeoutInMinutes -The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancer -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameters: LoadBalancer (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmLoadBalancerInboundNatRuleConfig.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmLoadBalancerInboundNatRuleConfig.md deleted file mode 100644 index 081aee1942..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmLoadBalancerInboundNatRuleConfig.md +++ /dev/null @@ -1,277 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: EE8F5D57-1ECE-4F23-9A5B-F226DD2C5ECB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermloadbalancerinboundnatruleconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmLoadBalancerInboundNatRuleConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmLoadBalancerInboundNatRuleConfig.md ---- - -# Add-AzureRmLoadBalancerInboundNatRuleConfig - -## SYNOPSIS -Adds an inbound NAT rule configuration to a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Add-AzureRmLoadBalancerInboundNatRuleConfig -LoadBalancer <PSLoadBalancer> -Name <String> [-Protocol <String>] - [-FrontendPort <Int32>] [-BackendPort <Int32>] [-IdleTimeoutInMinutes <Int32>] [-EnableFloatingIP] - [-EnableTcpReset] [-FrontendIpConfiguration <PSFrontendIPConfiguration>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByResourceId -``` -Add-AzureRmLoadBalancerInboundNatRuleConfig -LoadBalancer <PSLoadBalancer> -Name <String> [-Protocol <String>] - [-FrontendPort <Int32>] [-BackendPort <Int32>] [-IdleTimeoutInMinutes <Int32>] [-EnableFloatingIP] - [-EnableTcpReset] [-FrontendIpConfigurationId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmLoadBalancerInboundNatRuleConfig** cmdlet adds an inbound network address translation (NAT) rule configuration to an Azure load balancer. - -## EXAMPLES - -### Example 1: Add an inbound NAT rule configuration to a load balancer -``` -PS C:\>$slb = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -PS C:\> $slb | Add-AzureRmLoadBalancerInboundNatRuleConfig -Name "NewNatRule" -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol "Tcp" -FrontendPort 3350 -BackendPort 3350 -EnableFloatingIP -``` - -The first command gets the load balancer named MyloadBalancer, and then stores it in the variable $slb. -The second command uses the pipeline operator to pass the load balancer in $slb to **Add-AzureRmLoadBalancerInboundNatRuleConfig**, which adds an inbound NAT rule configuration to the load balancer. - -## PARAMETERS - -### -BackendPort -Specifies the backend port for traffic matched by a rule configuration. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableFloatingIP -Indicates that this cmdlet enables a floating IP address for a rule configuration. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableTcpReset -Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIpConfiguration -Specifies a list of front-end IP addresses to associate with an inbound NAT rule configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FrontendIpConfigurationId -Specifies an ID for a front-end IP address configuration. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FrontendPort -Specifies the front-end port that is matched by a rule configuration. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IdleTimeoutInMinutes -Specifies the length of time, in minutes, that the state of conversations is maintained in a load balancer. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancer -Specifies a **LoadBalancer** object. -This cmdlet adds an inbound NAT rule configuration to the load balancer that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the inbound NAT rule configuration to add. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol that is matched by an inbound NAT rule. -The acceptable values for this parameter are: Tcp or Udp. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameters: LoadBalancer (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[Get-AzureRmLoadBalancerInboundNatRuleConfig](./Get-AzureRmLoadBalancerInboundNatRuleConfig.md) - -[New-AzureRmLoadBalancerInboundNatRuleConfig](./New-AzureRmLoadBalancerInboundNatRuleConfig.md) - -[Remove-AzureRmLoadBalancerInboundNatRuleConfig](./Remove-AzureRmLoadBalancerInboundNatRuleConfig.md) - -[Set-AzureRmLoadBalancer](./Set-AzureRmLoadBalancer.md) - -[Set-AzureRmLoadBalancerInboundNatRuleConfig](./Set-AzureRmLoadBalancerInboundNatRuleConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmLoadBalancerOutboundRuleConfig.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmLoadBalancerOutboundRuleConfig.md deleted file mode 100644 index b7003881c4..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmLoadBalancerOutboundRuleConfig.md +++ /dev/null @@ -1,254 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermloadbalanceroutboundruleconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmLoadBalancerOutboundRuleConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmLoadBalancerOutboundRuleConfig.md ---- - -# Add-AzureRmLoadBalancerOutboundRuleConfig - -## SYNOPSIS -Adds an outbound rule configuration to a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Add-AzureRmLoadBalancerOutboundRuleConfig -LoadBalancer <PSLoadBalancer> -Name <String> - [-AllocatedOutboundPort <Int32>] -Protocol <String> [-EnableTcpReset] [-IdleTimeoutInMinutes <Int32>] - -FrontendIpConfiguration <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSResourceId]> - -BackendAddressPool <PSBackendAddressPool> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### SetByResourceId -``` -Add-AzureRmLoadBalancerOutboundRuleConfig -LoadBalancer <PSLoadBalancer> -Name <String> - [-AllocatedOutboundPort <Int32>] -Protocol <String> [-EnableTcpReset] [-IdleTimeoutInMinutes <Int32>] - -FrontendIpConfiguration <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSResourceId]> - -BackendAddressPoolId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmLoadBalancerOutboundRuleConfig** cmdlet adds an outbound rule configuration to an Azure load balancer. - -## EXAMPLES - -### Example 1: Add an outbound rule configuration to a load balancer -```powershell -PS C:\>$slb = Get-AzureRmLoadBalancer -ResourceGroupName "MyResourceGroup" -Name "MyLoadBalancer" -PS C:\>$slb | Add-AzureRmLoadBalancerOutboundRuleConfig -Name "NewRule" -Protocol "Tcp" -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -BackendAddressPool $slb.BackendAddressPools[0] -``` - -The first command gets the load balancer named MyLoadBalancer, and then stores it in the variable $slb. -The second command uses the pipeline operator to pass the load balancer in $slb to **Add-AzureRmLoadBalancerOutboundRuleConfig**, which adds an outbound rule configuration to the load balancer. - -## PARAMETERS - -### -AllocatedOutboundPort -The number of outbound ports to be used for NAT. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BackendAddressPool -A reference to a pool of DIPs. -Outbound traffic is randomly load balanced across IPs in the backend IPs. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BackendAddressPoolId -A reference to a pool of DIPs. -Outbound traffic is randomly load balanced across IPs in the backend IPs. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableTcpReset -Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. -This element is only used when the protocol is set to TCP. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIpConfiguration -The Frontend IP addresses of the load balancer. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSResourceId] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IdleTimeoutInMinutes -The timeout for the TCP idle connection - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancer -The reference of the load balancer resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the outbound rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Protocol - TCP, UDP or All - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -System.Int32 -System.String -System.Collections.Generic.List\`1[[Microsoft.Azure.Commands.Network.Models.PSResourceId, Microsoft.Azure.Commands.Network, Version=6.5.0.0, Culture=neutral, PublicKeyToken=null]] -Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmLoadBalancerProbeConfig.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmLoadBalancerProbeConfig.md deleted file mode 100644 index e5c88e2f1c..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmLoadBalancerProbeConfig.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 6F9BAB0B-7DC7-4672-B2B5-8B139D652DDD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermloadbalancerprobeconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmLoadBalancerProbeConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmLoadBalancerProbeConfig.md ---- - -# Add-AzureRmLoadBalancerProbeConfig - -## SYNOPSIS -Adds a probe configuration to a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmLoadBalancerProbeConfig -LoadBalancer <PSLoadBalancer> -Name <String> [-Protocol <String>] - -Port <Int32> -IntervalInSeconds <Int32> -ProbeCount <Int32> [-RequestPath <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmLoadBalancerProbeConfig** cmdlet adds a probe configuration to an Azure load balancer. - -## EXAMPLES - -### Example 1 Add a probe configuration to a load balancer -``` -PS C:\>Get-AzureRmLoadBalancer -Name "myLb" -ResourceGroupName "myRg" | Add-AzureRmLoadBalancerProbeConfig -Name "probeName" -RequestPath healthcheck2.aspx -Protocol http -Port 81 -IntervalInSeconds 16 -ProbeCount 3 | Set-AzureRmLoadBalancer -``` - -This command gets the load balancer named myLb, adds the specified probe configuration to it, and then uses the **Set-AzureRmLoadBalancer** cmdlet to update the load balancer. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IntervalInSeconds -Specifies the interval, in seconds, between probes to each instance of the load-balanced service. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancer -Specifies a **LoadBalancer** object. -This cmdlet adds a probe configuration to the load balancer that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the probe configuration to add. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Port -Specifies the port on which probes should connect to a load-balanced service. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProbeCount -Specifies the number of per-instance consecutive failures for an instance to be considered unhealthy. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol to use for the probe. -The acceptable values for this parameter are: Tcp or Http. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RequestPath -Specifies the path in the load-balanced service to probe to determine health. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameters: LoadBalancer (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLoadBalancerProbeConfig](./Get-AzureRmLoadBalancerProbeConfig.md) - -[New-AzureRmLoadBalancerProbeConfig](./New-AzureRmLoadBalancerProbeConfig.md) - -[Remove-AzureRmLoadBalancerProbeConfig](./Remove-AzureRmLoadBalancerProbeConfig.md) - -[Set-AzureRmLoadBalancer](./Set-AzureRmLoadBalancer.md) - -[Set-AzureRmLoadBalancerProbeConfig](./Set-AzureRmLoadBalancerProbeConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmLoadBalancerRuleConfig.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmLoadBalancerRuleConfig.md deleted file mode 100644 index d67c536ab3..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmLoadBalancerRuleConfig.md +++ /dev/null @@ -1,367 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 2AE5E9B8-7344-407B-9317-47709F10FCD8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermloadbalancerruleconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmLoadBalancerRuleConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmLoadBalancerRuleConfig.md ---- - -# Add-AzureRmLoadBalancerRuleConfig - -## SYNOPSIS -Adds a rule configuration to a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Add-AzureRmLoadBalancerRuleConfig -LoadBalancer <PSLoadBalancer> -Name <String> [-Protocol <String>] - [-LoadDistribution <String>] [-FrontendPort <Int32>] [-BackendPort <Int32>] [-IdleTimeoutInMinutes <Int32>] - [-EnableFloatingIP] [-EnableTcpReset] [-DisableOutboundSNAT] - [-FrontendIpConfiguration <PSFrontendIPConfiguration>] [-BackendAddressPool <PSBackendAddressPool>] - [-Probe <PSProbe>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByResourceId -``` -Add-AzureRmLoadBalancerRuleConfig -LoadBalancer <PSLoadBalancer> -Name <String> [-Protocol <String>] - [-LoadDistribution <String>] [-FrontendPort <Int32>] [-BackendPort <Int32>] [-IdleTimeoutInMinutes <Int32>] - [-EnableFloatingIP] [-EnableTcpReset] [-DisableOutboundSNAT] [-FrontendIpConfigurationId <String>] - [-BackendAddressPoolId <String>] [-ProbeId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmLoadBalancerRuleConfig** cmdlet adds a rule configuration to an Azure load balancer. - -## EXAMPLES - -### Example 1: Add a rule configuration to a load balancer -``` -PS C:\>$slb = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -PS C:\> $slb | Add-AzureRmLoadBalancerRuleConfig -Name "NewRule" -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol "Tcp" -FrontendPort 3350 -BackendPort 3350 -EnableFloatingIP -``` - -The first command gets the load balancer named MyLoadBalancer, and then stores it in the variable $slb. -The second command uses the pipeline operator to pass the load balancer in $slb to **Add-AzureRmLoadBalancerRuleConfig**, which adds the rule configuration named NewRule. - -## PARAMETERS - -### -BackendAddressPool -Specifies the backend address pool to associate with a load balancer rule configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BackendAddressPoolId -Specifies the ID of a **BackendAddressPool** object to associate with a load balancer rule configuration. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BackendPort -Specifies the backend port for traffic that is matched by a load balancer rule configuration. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableOutboundSNAT -Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableFloatingIP -Indicates that this cmdlet enables a floating IP address for a rule configuration. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableTcpReset -Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIpConfiguration -Specifies a list of front-end IP addresses to associate with a load balancer rule configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FrontendIpConfigurationId -Specifies the ID for a front-end IP address configuration. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FrontendPort -Specifies the front-end port that is matched by a load balancer rule configuration. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IdleTimeoutInMinutes -Specifies the length of time, in minutes, that the state of conversations is maintained in the load balancer. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancer -Specifies a **LoadBalancer** object. -This cmdlet adds a rule configuration to the load balancer that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -LoadDistribution -Specifies a load distribution. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the load balancer rule configuration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Probe -Specifies a probe to associate with a load balancer rule configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSProbe -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProbeId -Specifies the ID of the probe to associate with a load balancer rule configuration. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Protocol -Specfies the protocol that is matched by a load balancer rule. -The acceptable values for this parameter are: Tcp or Udp. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameters: LoadBalancer (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[Get-AzureRmLoadBalancerRuleConfig](./Get-AzureRmLoadBalancerRuleConfig.md) - -[New-AzureRmLoadBalancerRuleConfig](./New-AzureRmLoadBalancerRuleConfig.md) - -[Remove-AzureRmLoadBalancerRuleConfig](./Remove-AzureRmLoadBalancerRuleConfig.md) - -[Set-AzureRmLoadBalancerRuleConfig](./Set-AzureRmLoadBalancerRuleConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmNetworkInterfaceIpConfig.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmNetworkInterfaceIpConfig.md deleted file mode 100644 index 9f4d709035..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmNetworkInterfaceIpConfig.md +++ /dev/null @@ -1,377 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 7610228A-61F9-41B8-A42A-CD7C793BB33F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermnetworkinterfaceipconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmNetworkInterfaceIpConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmNetworkInterfaceIpConfig.md ---- - -# Add-AzureRmNetworkInterfaceIpConfig - -## SYNOPSIS -Adds a network interface IP configuration to a network interface. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Add-AzureRmNetworkInterfaceIpConfig -Name <String> -NetworkInterface <PSNetworkInterface> - [-PrivateIpAddressVersion <String>] [-PrivateIpAddress <String>] [-Primary] [-Subnet <PSSubnet>] - [-PublicIpAddress <PSPublicIpAddress>] - [-LoadBalancerBackendAddressPool <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool]>] - [-LoadBalancerInboundNatRule <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSInboundNatRule]>] - [-ApplicationGatewayBackendAddressPool <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool]>] - [-ApplicationSecurityGroup <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResourceId -``` -Add-AzureRmNetworkInterfaceIpConfig -Name <String> -NetworkInterface <PSNetworkInterface> - [-PrivateIpAddressVersion <String>] [-PrivateIpAddress <String>] [-Primary] [-SubnetId <String>] - [-PublicIpAddressId <String>] - [-LoadBalancerBackendAddressPoolId <System.Collections.Generic.List`1[System.String]>] - [-LoadBalancerInboundNatRuleId <System.Collections.Generic.List`1[System.String]>] - [-ApplicationGatewayBackendAddressPoolId <System.Collections.Generic.List`1[System.String]>] - [-ApplicationSecurityGroupId <System.Collections.Generic.List`1[System.String]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmNetworkInterfaceIpConfig** cmdlet adds a network interface IP configuration to an Azure network interface. - -## EXAMPLES - -### Example 1: Add a new IP configuration with an application security group -``` -$subnet = New-AzureRmVirtualNetworkSubnetConfig -Name MySubnet -AddressPrefix 10.0.1.0/24 -$vnet = New-AzureRmvirtualNetwork -Name MyVNET -ResourceGroupName MyResourceGroup -Location "West US" -AddressPrefix 10.0.0.0/16 -Subnet $subnet - -$nic = New-AzureRmNetworkInterface -Name MyNetworkInterface -ResourceGroupName MyResourceGroup -Location "West US" -Subnet $vnet.Subnets[0] - -$asg = New-AzureRmApplicationSecurityGroup -ResourceGroupName MyResourceGroup -Name MyASG -Location "West US" - -$nic | Set-AzureRmNetworkInterfaceIpConfig -Name $nic.IpConfigurations[0].Name -Subnet $vnet.Subnets[0] -ApplicationSecurityGroup $asg | Set-AzureRmNetworkInterface - -$nic | Add-AzureRmNetworkInterfaceIpConfig -Name MyNewIpConfig -Subnet $vnet.Subnets[0] -ApplicationSecurityGroup $asg | Set-AzureRmNetworkInterface -``` - -In this example, we create a new network interface MyNetworkInterface that belongs to a subnet in the new virtual network MyVNET. We also create an empty application security group MyASG to associate with the IP configurations in the network interface. Once both objects are created, we link the default IP configuration to the MyASG object. At last, we create a new IP configuration in the network interface also linked to the application security group object. - -## PARAMETERS - -### -ApplicationGatewayBackendAddressPool -Specifies a collection of application gateway backend address pool references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationGatewayBackendAddressPoolId -Specifies a collection of application gateway backend address pool references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationSecurityGroup -Specifies a collection of application security group references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationSecurityGroupId -Specifies a collection of application security group references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancerBackendAddressPool -Specifies a collection of load balancer backend address pool references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancerBackendAddressPoolId -Specifies a collection of load balancer backend address pool references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancerInboundNatRule -Specifies a collection of load balancer inbound network address translation (NAT) rule references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSInboundNatRule] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancerInboundNatRuleId -Specifies a collection of load balancer inbound NAT rule references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network interface IP configuration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkInterface -Specifies a **NetworkInterface** object. -This cmdlet adds a network interface IP configuration to the object that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkInterface -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Primary -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateIpAddress -Specifies the static IP address of the network interface IP configuration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateIpAddressVersion -Specifies the IP address version of a network interface IP configuration. -The acceptable values for this parameter are: -- IPv4 -- IPv6 - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: IPv4, IPv6 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIpAddress -Specifies a **PublicIPAddress** object. -This cmdlet creates a reference to a public IP Address to associate with this network interface IP configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIpAddressId -This cmdlet creates a reference to a public IP Address to associate with this network interface IP configuration. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subnet -Specifies a **Subnet** object. -This cmdlet creates a reference to a subnet in which this network interface IP configuration is created. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSSubnet -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetId -This cmdlet creates a reference to a subnet in which this network interface IP configuration is created. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface -Parameters: NetworkInterface (ByValue) - -### System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSInboundNatRule, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Get-AzureRmNetworkInterfaceIpConfig](./Get-AzureRmNetworkInterfaceIpConfig.md) - -[New-AzureRmNetworkInterfaceIpConfig](./New-AzureRmNetworkInterfaceIpConfig.md) - -[Remove-AzureRmNetworkInterfaceIpConfig](./Remove-AzureRmNetworkInterfaceIpConfig.md) - -[Set-AzureRmNetworkInterfaceIpConfig](./Set-AzureRmNetworkInterfaceIpConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmNetworkInterfaceTapConfig.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmNetworkInterfaceTapConfig.md deleted file mode 100644 index 5dcd65d647..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmNetworkInterfaceTapConfig.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermnetworkinterfacetapconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmNetworkInterfaceTapConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmNetworkInterfaceTapConfig.md ---- - -# Add-AzureRmNetworkInterfaceTapConfig - -## SYNOPSIS -Creates a TapConfiguration resource associated to a NetworkInterface. This will reference to an existing VirtualNetworkTap resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Add-AzureRmNetworkInterfaceTapConfig -NetworkInterface <PSNetworkInterface> -Name <String> - [-VirtualNetworkTap <PSVirtualNetworkTap>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### SetByResourceId -``` -Add-AzureRmNetworkInterfaceTapConfig -NetworkInterface <PSNetworkInterface> -Name <String> - [-VirtualNetworkTapId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmNetworkInterfaceTapConfig** cmdlet creates a TapConfiguration resource associated to a NetworkInterface. This will reference to an existing VirtualNetworkTap resource. - -## EXAMPLES - -### Example 1: Add TapConfiguration to a given NetworkInterface -``` -PS C:\>Add-AzureRmNetworkInterfaceTapConfig -NetworkInterface $sourceNic -VirtualNetworkTap $vVirtualNetworkTap -Name 'myTapConfig' -``` - -Add the TapConfiguration to a sourceNic. The traffic from sourceNic VM will be mirrored to destination VM referred in vVirtualNetworkTap resource. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the tap configuration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkInterface -The reference of the network interface resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkInterface -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -VirtualNetworkTap -The reference of the virtual network tap resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkTap -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkTapId -The reference of the virtual network tap resource. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface - -### System.String - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkTap - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmNetworkSecurityRuleConfig.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmNetworkSecurityRuleConfig.md deleted file mode 100644 index 9159f6555f..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmNetworkSecurityRuleConfig.md +++ /dev/null @@ -1,371 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 9160A21D-0F83-415B-830B-F35C8B863E90 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermnetworksecurityruleconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmNetworkSecurityRuleConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmNetworkSecurityRuleConfig.md ---- - -# Add-AzureRmNetworkSecurityRuleConfig - -## SYNOPSIS -Adds a network security rule configuration to a network security group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Add-AzureRmNetworkSecurityRuleConfig -Name <String> -NetworkSecurityGroup <PSNetworkSecurityGroup> - [-Description <String>] [-Protocol <String>] - [-SourcePortRange <System.Collections.Generic.List`1[System.String]>] - [-DestinationPortRange <System.Collections.Generic.List`1[System.String]>] - [-SourceAddressPrefix <System.Collections.Generic.List`1[System.String]>] - [-DestinationAddressPrefix <System.Collections.Generic.List`1[System.String]>] - [-SourceApplicationSecurityGroup <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup]>] - [-DestinationApplicationSecurityGroup <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup]>] - [-Access <String>] [-Priority <Int32>] [-Direction <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### SetByResourceId -``` -Add-AzureRmNetworkSecurityRuleConfig -Name <String> -NetworkSecurityGroup <PSNetworkSecurityGroup> - [-Description <String>] [-Protocol <String>] - [-SourcePortRange <System.Collections.Generic.List`1[System.String]>] - [-DestinationPortRange <System.Collections.Generic.List`1[System.String]>] - [-SourceAddressPrefix <System.Collections.Generic.List`1[System.String]>] - [-DestinationAddressPrefix <System.Collections.Generic.List`1[System.String]>] - [-SourceApplicationSecurityGroupId <System.Collections.Generic.List`1[System.String]>] - [-DestinationApplicationSecurityGroupId <System.Collections.Generic.List`1[System.String]>] [-Access <String>] - [-Priority <Int32>] [-Direction <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmNetworkSecurityRuleConfig** cmdlet adds a network security rule configuration to an Azure network security group. - -## EXAMPLES - -### 1: Adding a network security group -``` -Get-AzureRmNetworkSecurityGroup -Name nsg1 -ResourceGroupName rg1 | -Add-AzureRmNetworkSecurityRuleConfig -Name rdp-rule -Description "Allow RDP" -Access - Allow -Protocol Tcp -Direction Inbound -Priority 100 -SourceAddressPrefix Internet - -SourcePortRange * -DestinationAddressPrefix * -DestinationPortRange 3389 | - Set-AzureRmNetworkSecurityGroup -``` - -The first command retrieves an Azure network security group named "nsg1" from resource group "rg1". The second command adds a network security rule named "rdp-rule" that allows traffic from internet on port 3389 to the retrieved network security group object. Persists the modified Azure network security group. - -### 2: Adding a new security rule with application security groups -``` -$srcAsg = New-AzureRmApplicationSecurityGroup -ResourceGroupName MyResourceGroup -Name srcAsg -Location "West US" -$destAsg = New-AzureRmApplicationSecurityGroup -ResourceGroupName MyResourceGroup -Name destAsg -Location "West US" - -Get-AzureRmNetworkSecurityGroup -Name nsg1 -ResourceGroupName rg1 | -Add-AzureRmNetworkSecurityRuleConfig -Name rdp-rule -Description "Allow RDP" -Access - Allow -Protocol Tcp -Direction Inbound -Priority 100 -SourceApplicationSecurityGroup - $srcAsg -SourcePortRange * -DestinationApplicationSecurityGroup $destAsg -DestinationPortRange 3389 | -Set-AzureRmNetworkSecurityGroup -``` - -First, we create two new application security groups. Then, we retrieve an Azure network security group named "nsg1" from resource group "rg1". and add a network security rule named "rdp-rule" to it. The rule allows traffic from all the IP configurations in the application security group "srcAsg" to all the IP configurations in "destAsg" on port 3389. After adding the rule, we persist the modified Azure network security group. - -## PARAMETERS - -### -Access -Specifies whether network traffic is allowed or denied. -The acceptable values for this parameter are: Allow and Deny. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Allow, Deny - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of a network security rule configuration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationAddressPrefix -Specifies a destination address prefix. -The acceptable values for this parameter are: -- A Classless Interdomain Routing (CIDR) address -- A destination IP address range -- A wildcard character (*) to match any IP address -You can use tags such as VirtualNetwork, AzureLoadBalancer, and Internet. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationApplicationSecurityGroup -The application security group set as destination for the rule. It cannot be used with 'DestinationAddressPrefix' parameter. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationApplicationSecurityGroupId -The application security group set as destination for the rule. It cannot be used with 'DestinationAddressPrefix' parameter. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationPortRange -Specifies a destination port or range. -The acceptable values for this parameter are: -- An integer -- A range of integers between 0 and 65535 -- A wildcard character (*) to match any port - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Direction -Specifies whether a rule is evaluated on incoming or outgoing traffic. -The acceptable values for this parameter are: Inbound and Outbound. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Inbound, Outbound - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a network security rule configuration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkSecurityGroup -Specifies a **NetworkSecurityGroup** object. -This cmdlet adds a network security rule configuration to the object that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Priority -Specifies the priority of a rule configuration. -The acceptable values for this parameter are: An integer between 100 and 4096. -The priority number must be unique for each rule in the collection. -The lower the priority number, the higher the priority of the rule. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the network protocol that a rule configuration applies to. -The acceptable values for this parameter are: -- Tcp -- Udp -- Wildcard character (*) to match both - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Tcp, Udp, * - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceAddressPrefix -Specifies a source address prefix. -The acceptable values for this parameter are: -- A CIDR -- A source IP range -- A wildcard character (*) to match any IP address. -You can also use tags such as VirtualNetwork, AzureLoadBalancer and Internet. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceApplicationSecurityGroup -The application security group set as source for the rule. It cannot be used with 'SourceAddressPrefix' parameter. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceApplicationSecurityGroupId -The application security group set as source for the rule. It cannot be used with 'SourceAddressPrefix' parameter. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourcePortRange -Specifies a source port or range. -This value is expressed as an integer, as a range between 0 and 65535, or as a wildcard character (*) to match any source port. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup -Parameters: NetworkSecurityGroup (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup - -## NOTES - -## RELATED LINKS - -[Get-AzureRmNetworkSecurityRuleConfig](./Get-AzureRmNetworkSecurityRuleConfig.md) - -[New-AzureRmNetworkSecurityRuleConfig](./New-AzureRmNetworkSecurityRuleConfig.md) - -[Remove-AzureRmNetworkSecurityRuleConfig](./Remove-AzureRmNetworkSecurityRuleConfig.md) - -[Set-AzureRmNetworkSecurityRuleConfig](./Set-AzureRmNetworkSecurityRuleConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmRouteConfig.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmRouteConfig.md deleted file mode 100644 index 639c2d18e7..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmRouteConfig.md +++ /dev/null @@ -1,256 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: C868DFA4-8A9D-4108-B88B-ACD7F100A63C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermrouteconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmRouteConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmRouteConfig.md ---- - -# Add-AzureRmRouteConfig - -## SYNOPSIS -Adds a route to a route table. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmRouteConfig -RouteTable <PSRouteTable> [-Name <String>] [-AddressPrefix <String>] - [-NextHopType <String>] [-NextHopIpAddress <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmRouteConfig** cmdlet adds a route to an Azure route table. - -## EXAMPLES - -### Example 1: Add a route to a route table -``` -PS C:\>$RouteTable = Get-AzureRmRouteTable -ResourceGroupName "ResourceGroup11" -Name "RouteTable01" -PS C:\> Add-AzureRmRouteConfig -Name "Route13" -AddressPrefix 10.3.0.0/16 -NextHopType "VnetLocal" -RouteTable $RouteTable -``` - -The first command gets a route table named RouteTable01 by using the Get-AzureRmRouteTable cmdlet. -The command stores the table in the $RouteTable variable. -The second command adds a route named Route13 to the route table stored in $RouteTable. -This route forwards packets to the local virtual network. - -### Example 2: Add a route to a route table by using the pipeline -``` -PS C:\>Get-AzureRmRouteTable -ResourceGroupName "ResourceGroup11" -Name "RouteTable01" | Add-AzureRmRouteConfig -Name "Route02" -AddressPrefix 10.2.0.0/16 -NextHopType VnetLocal | Set-AzureRmRouteTable -Name : routetable01 -ResourceGroupName : ResourceGroup11 -Location : eastus -Id : /subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Microsoft.Networ - k/routeTables/routetable01 -Etag : W/"f13e1bc8-d41f-44d0-882d-b8b5a1134f59" -ProvisioningState : Succeeded -Tags : -Routes : [ - { - "Name": "route07", - "Etag": "W/\"f13e1bc8-d41f-44d0-882d-b8b5a1134f59\"", - "Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro - soft.Network/routeTables/routetable01/routes/route07", - "AddressPrefix": "10.1.0.0/16", - "NextHopType": "VnetLocal", - "NextHopIpAddress": null, - "ProvisioningState": "Succeeded" - }, - { - "Name": "route02", - "Etag": "W/\"f13e1bc8-d41f-44d0-882d-b8b5a1134f59\"", - "Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro - soft.Network/routeTables/routetable01/routes/route02", - "AddressPrefix": "10.2.0.0/16", - "NextHopType": "VnetLocal", - "NextHopIpAddress": null, - "ProvisioningState": "Succeeded" - }, - { - "Name": "route13", - "Etag": null, - "Id": null, - "AddressPrefix": "10.3.0.0/16", - "NextHopType": "VnetLocal", - "NextHopIpAddress": null, - "ProvisioningState": null - } - ] -Subnets : [] -``` - -This command gets the route table named RouteTable01 by using **Get-AzureRmRouteTable**. -The command passes that table to the current cmdlet by using the pipeline operator. -The current cmdlet adds the route named Route02, and then passes the result to the **Set-AzureRmRouteTable** cmdlet, which updates the table to reflect your changes. - -## PARAMETERS - -### -AddressPrefix -Specifies the destination, in Classless Interdomain Routing (CIDR) format, to which the route applies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name of the route to add to the route table. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NextHopIpAddress -Specifies the IP address of a virtual appliance that you add to your Azure virtual network. -This route forwards packets to that address. -Specify this parameter only if you specify a value of VirtualAppliance for the *NextHopType* parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NextHopType -Specifies how this route forwards packets. -The acceptable values for this parameter are: -- Internet. -The default Internet gateway provided by Azure. -- None. -If you specify this value, the route does not forward packets. -- VirtualAppliance. -A virtual appliance that you add to your Azure virtual network. -- VirtualNetworkGateway. -An Azure server-to-server virtual private network gateway. -- VnetLocal. -The local virtual network. -If you have two subnets, 10.1.0.0/16 and 10.2.0.0/16 in the same virtual network, select a value of VnetLocal for each subnet to forward to the other subnet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RouteTable -Specifies the route table to which this cmdlet adds a route. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSRouteTable -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteTable - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteTable - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRouteConfig](./Get-AzureRmRouteConfig.md) - -[Get-AzureRmRouteTable](./Get-AzureRmRouteTable.md) - -[New-AzureRmRouteConfig](./New-AzureRmRouteConfig.md) - -[Remove-AzureRmRouteConfig](./Remove-AzureRmRouteConfig.md) - -[Set-AzureRmRouteConfig](./Set-AzureRmRouteConfig.md) - -[Set-AzureRmRouteTable](./Set-AzureRmRouteTable.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmRouteFilterRuleConfig.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmRouteFilterRuleConfig.md deleted file mode 100644 index 9f1e196b9b..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmRouteFilterRuleConfig.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermroutefilterruleconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmRouteFilterRuleConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmRouteFilterRuleConfig.md ---- - -# Add-AzureRmRouteFilterRuleConfig - -## SYNOPSIS -Adds a route filter rule to a route filter. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmRouteFilterRuleConfig -RouteFilter <PSRouteFilter> [-Force] -Name <String> -Access <String> - -RouteFilterRuleType <String> -CommunityList <System.Collections.Generic.List`1[System.String]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Add-AzureRmRouteFilterRuleConfig cmdlet adds a route filter rule to an Azure route filter. - -## EXAMPLES - -### Example 1: Add a route filter rule to a route filter -``` -PS C:\>$RouteFilter = Get-AzureRmRouteFilter -ResourceGroupName "ResourceGroup11" -Name "routefilter01" - PS C:\> Add-AzureRmRouteFilterRuleConfig -Name "rule13" -Access Allow -RouteFilterRuleType Community -RouteFilter $RouteFilter -``` - -The first command gets a route filter named routefilter01 by using the Get-AzureRmRouteFilter cmdlet. -The command stores the filter in the $RouteFilter variable. - -## PARAMETERS - -### -Access -Specifies the access of the route filter rule, Valid values are Deny or Allow. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Allow, Deny - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CommunityList -The list of community value that route filter will filter on - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation if you want to overrite a resource - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name of the route filter rule to add to the route filter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteFilter -Specifies the route filter to which this cmdlet adds a route filter rule. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSRouteFilter -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RouteFilterRuleType -Specifies the route filter rule type. -Valid values are: Community - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Community - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteFilter -Parameters: RouteFilter (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteFilter - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Get-AzureRmRouteFilterRuleConfig](./Get-AzureRmRouteFilterRuleConfig.md) - -[Get-AzureRmRouteFilter](./Get-AzureRmRouteFilter.md) - - - - -[Set-AzureRmRouteFilter](./Set-AzureRmRouteFilter.md) - diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmServiceEndpointPolicyDefinition.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmServiceEndpointPolicyDefinition.md deleted file mode 100644 index d42f7fb4c1..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmServiceEndpointPolicyDefinition.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermserviceendpointpolicydefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmServiceEndpointPolicyDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmServiceEndpointPolicyDefinition.md ---- - -# Add-AzureRmServiceEndpointPolicyDefinition - -## SYNOPSIS -Adds a service endpoint policy definition to a specified policy. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmServiceEndpointPolicyDefinition -Name <String> -ServiceEndpointPolicy <PSServiceEndpointPolicy> - [-Description <String>] [-ServiceResource <System.Collections.Generic.List`1[System.String]>] - [-Service <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmServiceEndpointPolicyDefinition** cmdlet add a service endpoint policy definition to the policy. - -## EXAMPLES - -### Example 1: Updates a service endpoint policy definition in a service endpoint policy -``` -$policydef= New-AzureRmServiceEndpointPolicyDefinition -Name "ServiceEndpointPolicyDefinition1" -ResourceGroupName "ResourceGroup01" -Service "Microsoft.Storage" -ServiceResources "subscriptions/sub1" -Description "New Definition" -``` - -This command updated the service endpoint policy definition with name ServiceEndpointPolicyDefinition1, service Microsoft.Storage, service resources subscriptions/sub1 and -description "New Definition" that belongs to the resource group named ResourceGroup01 and stores it in the $policydef variable. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The description of the definition - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the service endpoint policy definition - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Service -Name of the service - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceEndpointPolicy -The ServiceEndpointPolicy - -```yaml -Type: PSServiceEndpointPolicy -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServiceResource -List of service resources - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy - - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy - - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmVirtualNetworkGatewayIpConfig.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmVirtualNetworkGatewayIpConfig.md deleted file mode 100644 index 5f0023b3f8..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmVirtualNetworkGatewayIpConfig.md +++ /dev/null @@ -1,269 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: BCB64535-FF37-46EF-85AF-7286BB67787B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermvirtualnetworkgatewayipconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmVirtualNetworkGatewayIpConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmVirtualNetworkGatewayIpConfig.md ---- - -# Add-AzureRmVirtualNetworkGatewayIpConfig - -## SYNOPSIS -Adds an IP configuration to a virtual network gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -Add-AzureRmVirtualNetworkGatewayIpConfig -VirtualNetworkGateway <PSVirtualNetworkGateway> -Name <String> - [-PrivateIpAddress <String>] [-SubnetId <String>] [-PublicIpAddressId <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByResource -``` -Add-AzureRmVirtualNetworkGatewayIpConfig -VirtualNetworkGateway <PSVirtualNetworkGateway> -Name <String> - [-PrivateIpAddress <String>] [-Subnet <PSSubnet>] [-PublicIpAddress <PSPublicIpAddress>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVirtualNetworkGatewayIpConfig** cmdlet adds an IP configuration to a virtual network gateway. - -## EXAMPLES - -### Example 1 -``` -Add-AzureRmVirtualNetworkGatewayIpConfig -VirtualNetworkGateway $gw -Name GWIPConfig2 -Subnet $subnet -PublicIpAddress $gwpip2 - - -Name : VNet7GW -ResourceGroupName : VPNGatewayV3 -Location : eastus -Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VPNGatewayV3/providers/Microsoft.Network/virtualNetworkGateways/VNet7GW -Etag : W/"d27a784f-3c3f-4150-863d-764649b6e8e7" -ResourceGuid : 3c2478a7-d5d4-4e80-8532-7ea2ad577598 -ProvisioningState : Succeeded -Tags : -IpConfigurations : [ - { - "PrivateIpAllocationMethod": "Dynamic", - "Subnet": { - "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VPNGatewayV3/providers/Microsoft.Network/virtualNetworks/Vnet7/subnets/GatewaySubnet" - }, - "PublicIpAddress": { - "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VPNGatewayV3/providers/Microsoft.Network/publicIPAddresses/VNet7GW_IP" - }, - "Name": "default", - "Etag": "W/\"d27a784f-3c3f-4150-863d-764649b6e8e7\"", - "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VPNGatewayV3/providers/Microsoft.Network/virtualNetworkGateways/VNet7GW/ipConfigurations/default" - }, - { - "PrivateIpAllocationMethod": "Dynamic", - "PublicIpAddress": { - "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VPNGatewayV3/providers/Microsoft.Network/publicIPAddresses/delIPConfig" - }, - "Name": "GWIPConfig2", - "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroupNotSet/providers/Microsoft.Network/virtualNetworkGateways/VirtualNetworkGatewayNameNotSet/virtualNetworkGatewayIpConfiguration/GWIPConfig2" - } - ] -GatewayType : Vpn -VpnType : RouteBased -EnableBgp : True -ActiveActive : False -GatewayDefaultSite : null -Sku : { - "Capacity": 2, - "Name": "VpnGw1", - "Tier": "VpnGw1" - } -VpnClientConfiguration : null -BgpSettings : { - "Asn": 65534, - "BgpPeeringAddress": "10.7.255.254", - "PeerWeight": 0 - } -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the gateway IP configuration to add. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateIpAddress -Specifies the private IP address. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIpAddress -Specifies the public IP address. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIpAddressId -Specifies the ID of the public IP address. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subnet -Specifies a **PSSubnet** object. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSSubnet -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetId -Specifies the ID of the subnet. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkGateway -Specifies a **PSVirtualNetworkGateway** object. -This cmdlet modifies the **PSVirtualNetworkGateway** object that you specify. -You can use the Get-AzureRmVirtualNetworkGateway cmdlet to retrieve a **PSVirtualNetworkGateway** object. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway -Parameters: VirtualNetworkGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVirtualNetworkGateway](./Get-AzureRmVirtualNetworkGateway.md) - -[New-AzureRmVirtualNetworkGatewayIpConfig](./New-AzureRmVirtualNetworkGatewayIpConfig.md) - -[Remove-AzureRmVirtualNetworkGatewayIpConfig](./Remove-AzureRmVirtualNetworkGatewayIpConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmVirtualNetworkPeering.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmVirtualNetworkPeering.md deleted file mode 100644 index 35ea7a1f14..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmVirtualNetworkPeering.md +++ /dev/null @@ -1,242 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 13901193-8C68-4969-ADCD-2E82EA714354 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermvirtualnetworkpeering -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmVirtualNetworkPeering.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmVirtualNetworkPeering.md ---- - -# Add-AzureRmVirtualNetworkPeering - -## SYNOPSIS -Creates a peering between two virtual networks. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmVirtualNetworkPeering -Name <String> -VirtualNetwork <PSVirtualNetwork> - -RemoteVirtualNetworkId <String> [-BlockVirtualNetworkAccess] [-AllowForwardedTraffic] [-AllowGatewayTransit] - [-UseRemoteGateways] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVirtualNetworkPeering** cmdlet creates a peering between two virtual networks. - -## EXAMPLES - -### Example 1: Create a peering between two virtual networks in the same region -``` -# Variables for common values used throughout the script. -$rgName='myResourceGroup' -$location='eastus' - -# Create a resource group. -New-AzureRmResourceGroup -Name $rgName -Location $location - -# Create virtual network 1. -$vnet1 = New-AzureRmVirtualNetwork -ResourceGroupName $rgName -Name 'myVnet1' -AddressPrefix '10.0.0.0/16' -Location $location - -# Create virtual network 2. -$vnet2 = New-AzureRmVirtualNetwork -ResourceGroupName $rgName -Name 'myVnet2' -AddressPrefix '10.1.0.0/16' -Location $location - -# Peer VNet1 to VNet2. -Add-AzureRmVirtualNetworkPeering -Name myVnet1ToMyVnet2' -VirtualNetwork $vnet1 -RemoteVirtualNetworkId $vnet2.Id - -# Peer VNet2 to VNet1. -Add-AzureRmVirtualNetworkPeering -Name 'myVnet2ToMyVnet1' -VirtualNetwork $vnet2 -RemoteVirtualNetworkId $vnet1.Id -``` - -Note that a peering link must be created from vnet1 to vnet2 and vice versa in order for peering to work. - -### Example 2: Create a peering between two virtual networks in different regions -``` -# Variables for common values used throughout the script. -$rgName='myResourceGroup' - -# Create a resource group. -New-AzureRmResourceGroup -Name $rgName -Location westcentralus - -# Create virtual network 1. -$vnet1 = New-AzureRmVirtualNetwork -ResourceGroupName $rgName -Name 'myVnet1' -AddressPrefix '10.0.0.0/16' -Location westcentralus - -# Create virtual network 2. -$vnet2 = New-AzureRmVirtualNetwork -ResourceGroupName $rgName -Name 'myVnet2' -AddressPrefix '10.1.0.0/16' -Location candacentral - -# Peer VNet1 to VNet2. -Add-AzureRmVirtualNetworkPeering -Name myVnet1ToMyVnet2' -VirtualNetwork $vnet1 -RemoteVirtualNetworkId $vnet2.Id - -# Peer VNet2 to VNet1. -Add-AzureRmVirtualNetworkPeering -Name 'myVnet2ToMyVnet1' -VirtualNetwork $vnet2 -RemoteVirtualNetworkId $vnet1.Id -``` - -Here 'myVnet1' in US West Central is peered with 'myVnet2' in Canada Central. - -## PARAMETERS - -### -AllowForwardedTraffic -Indicates that this cmdlet allows the forwarded traffic from the virtual machines in the remote virtual network. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowGatewayTransit -Flag to allow gatewayLinks be used in remote virtual network's link to this virtual network - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlockVirtualNetworkAccess -Indicates that this cmdlet blocks the virtual machines in the linked virtual network space to access all the virtual machines in local virtual network space. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual network peering. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteVirtualNetworkId -Specifies the ID of the remote virtual network. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -UseRemoteGateways -Indicates that this cmdlet allows remote gateways on this virtual network. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetwork -Specifies the parent virtual network. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork -Parameters: VirtualNetwork (ByValue) - -### System.String -Parameters: RemoteVirtualNetworkId (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkPeering - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVirtualNetwork](./Get-AzureRmVirtualNetwork.md) - -[Get-AzureRmVirtualNetworkPeering](./Get-AzureRmVirtualNetworkPeering.md) - -[Remove-AzureRmVirtualNetworkPeering](./Remove-AzureRmVirtualNetworkPeering.md) - -[Set-AzureRmVirtualNetworkPeering](./Set-AzureRmVirtualNetworkPeering.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmVirtualNetworkSubnetConfig.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmVirtualNetworkSubnetConfig.md deleted file mode 100644 index 1e2ab5dc98..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmVirtualNetworkSubnetConfig.md +++ /dev/null @@ -1,269 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: B8B632B5-9D3B-4352-B4C8-49C00472B3A7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermvirtualnetworksubnetconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmVirtualNetworkSubnetConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmVirtualNetworkSubnetConfig.md ---- - -# Add-AzureRmVirtualNetworkSubnetConfig - -## SYNOPSIS -Adds a subnet configuration to a virtual network. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Add-AzureRmVirtualNetworkSubnetConfig -Name <String> -VirtualNetwork <PSVirtualNetwork> - -AddressPrefix <System.Collections.Generic.List`1[System.String]> - [-NetworkSecurityGroup <PSNetworkSecurityGroup>] [-RouteTable <PSRouteTable>] - [-ServiceEndpoint <System.Collections.Generic.List`1[System.String]>] - [-ServiceEndpointPolicy <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy]>] - [-Delegation <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSDelegation]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResourceId -``` -Add-AzureRmVirtualNetworkSubnetConfig -Name <String> -VirtualNetwork <PSVirtualNetwork> - -AddressPrefix <System.Collections.Generic.List`1[System.String]> [-NetworkSecurityGroupId <String>] - [-RouteTableId <String>] [-ServiceEndpoint <System.Collections.Generic.List`1[System.String]>] - [-ServiceEndpointPolicy <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy]>] - [-Delegation <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSDelegation]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVirtualNetworkSubnetConfig** cmdlet adds a subnet configuration to an existing Azure virtual network. - -## EXAMPLES - -### 1: Add a subnet to an existing virtual network -``` -New-AzureRmResourceGroup -Name TestResourceGroup -Location centralus - $frontendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" - $virtualNetwork = New-AzureRmVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet - Add-AzureRmVirtualNetworkSubnetConfig -Name backendSubnet -VirtualNetwork $virtualNetwork -AddressPrefix "10.0.2.0/24" - $virtualNetwork | Set-AzureRmVirtualNetwork -``` - - This example first creates a resource group as a container of the resources to be created. It then creates a subnet configuration and uses it to create a virtual network. The - Add-AzureRmVirtualNetworkSubnetConfig is then used to add a subnet to the in-memory representation of the virtual network. The Set-AzureRmVirtualNetwork command updates the existing virtual - network with the new subnet. - -### 2: Add a delegation to a subnet being added to an existing virtual network -```powershell -PS C:\> $vnet = Get-AzureRmVirtualNetwork -Name "myVNet" -ResourceGroupName "myResourceGroup" -PS C:\> $delegation = New-AzureRmDelegation -Name "myDelegation" -ServiceName "Microsoft.Sql/servers" -PS C:\> Add-AzureRmVirtualNetworkSubnetConfig -Name "mySubnet" -VirtualNetwork $vnet -AddressPrefix "10.0.2.0/24" -Delegation $delegation | Set-AzureRmVirtualNetwork -``` - -This example first gets an existing vnet. -Then, it creates a delegation object in memory. -Finally, it creates a new subnet with that delegation that is added to the vnet. The modified configuration is then sent to the server. - -## PARAMETERS - -### -AddressPrefix -Specifies a range of IP addresses for a subnet configuration. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Delegation -List of services that have permission to perform operations on this subnet. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSDelegation] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the subnet configuration to add. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkSecurityGroup -Specifies a **NetworkSecurityGroup** object. -This cmdlet adds a virtual network subnet configuration to the object that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkSecurityGroupId -Specifies the ID of a network security group. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RouteTable -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSRouteTable -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RouteTableId -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceEndpoint -Service Endpoint Value - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceEndpointPolicy -Service Endpoint Policies - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetwork -Specifies the **VirtualNetwork** object in which to add a subnet configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork - -### System.String - -### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup - -### Microsoft.Azure.Commands.Network.Models.PSRouteTable - -### System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy, Microsoft.Azure.Commands.Network, Version=6.7.0.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSDelegation, Microsoft.Azure.Commands.Network, Version=6.7.0.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVirtualNetworkSubnetConfig](./Get-AzureRmVirtualNetworkSubnetConfig.md) - -[New-AzureRmVirtualNetworkSubnetConfig](./New-AzureRmVirtualNetworkSubnetConfig.md) - -[Remove-AzureRmVirtualNetworkSubnetConfig](./Remove-AzureRmVirtualNetworkSubnetConfig.md) - -[Set-AzureRmVirtualNetworkSubnetConfig](./Set-AzureRmVirtualNetworkSubnetConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmVpnClientRevokedCertificate.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmVpnClientRevokedCertificate.md deleted file mode 100644 index eb3a2c6331..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmVpnClientRevokedCertificate.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 90FB7B88-844E-4783-A10F-04D7BA47C030 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermvpnclientrevokedcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmVpnClientRevokedCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmVpnClientRevokedCertificate.md ---- - -# Add-AzureRmVpnClientRevokedCertificate - -## SYNOPSIS -Adds a VPN client-revocation certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmVpnClientRevokedCertificate -VpnClientRevokedCertificateName <String> - -VirtualNetworkGatewayName <String> -ResourceGroupName <String> -Thumbprint <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVpnClientRevokedCertificate** cmdlet assigns a client-revocation certificate to a virtual network gateway. -Client-revocation certificates prevent client computers from using the specified certificate for authentication. -You need to specify both the certificate name and the certificate thumbprint to use this cmdlet. - -## EXAMPLES - -### Example 1: Add a new client-revocation certificate to a virtual network gateway -``` -PS C:\>Add-AzureRmVpnClientRevokedCertificate -VirtualNetworkGatewayName "ContosoVirtualNetwork" -ResourceGroupName "ContosoResourceGroup" -VpnClientRevokedCertificateName "ContosoRevokedClientCertificate"-Thumbprint "E3A38EBA60CAA1C162785A2E1C44A15AD450199C3" -``` - -This command adds a new client-revocation certificate to the virtual network gateway named ContosoVirtualNetwork. -In order to add the certificate, you must specify both the certificate name and the certificate thumbprint. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the virtual network gateway is assigned to. -Resource groups categorize items to help simplify inventory management and general Azure administration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Thumbprint -Specifies the unique identifier of the certificate being added. -For example: --Thumbprint "E3A38EBA60CAA1C162785A2E1C44A15AD450199C3" -You can get thumbprint information for your certificates by using a Windows PowerShell command similar to this: `Get-ChildItem -Path Cert:\LocalMachine\Root`. -The preceding command gets information for all the local computer certificates found in the root certificate store. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkGatewayName -Specifies the name of the virtual network gateway where the certificate should be added. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VpnClientRevokedCertificateName -Specifies the name of the VPN client certificate to be added. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVpnClientRevokedCertificate](./Get-AzureRmVpnClientRevokedCertificate.md) - -[New-AzureRmVpnClientRevokedCertificate](./New-AzureRmVpnClientRevokedCertificate.md) - -[Remove-AzureRmVpnClientRevokedCertificate](./Remove-AzureRmVpnClientRevokedCertificate.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmVpnClientRootCertificate.md b/azurermps-6.13.0/AzureRM.Network/Add-AzureRmVpnClientRootCertificate.md deleted file mode 100644 index 731a517674..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Add-AzureRmVpnClientRootCertificate.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: B9153CA9-06D1-4EF3-9863-D649C2EBAEAA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermvpnclientrootcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmVpnClientRootCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Add-AzureRmVpnClientRootCertificate.md ---- - -# Add-AzureRmVpnClientRootCertificate - -## SYNOPSIS -Adds a VPN client root certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmVpnClientRootCertificate -VpnClientRootCertificateName <String> -VirtualNetworkGatewayName <String> - -ResourceGroupName <String> -PublicCertData <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVpnClientRootCertificate** cmdlet adds a root certificate to a virtual network gateway. -Root certificates are X.509 certificates that identify your Root Certification Authority. -By design, all certificates used on the gateway trust the root certificate. -This cmdlet assigns an existing certificate as a gateway root certificate. -If you do not have an X.509 certificate available you can generate one through your public key infrastructure or use a certificate generator such as makecert.exe. -To add a root certificate, you must specify the certificate name and provide a text-only representation of the certificate (see *the PublicCertData* parameter for more information). -Azure allows you to assign more than one root certificate to a gateway. -Multiple root certificates are often deployed by organizations that include users from more than one company. - -## EXAMPLES - -### Example 1: Add a client root certificate to a virtual gateway -``` -PS C:\>$Text = Get-Content -Path "C:\Azure\Certificates\ExportedCertficate.cer" -PS C:\> $CertificateText = for ($i=1; $i -lt $Text.Length -1 ; $i++){$Text[$i]} -PS C:\> Add-AzureRmVpnClientRootCertificate -PublicCertData $CertificateText -ResourceGroupName "ContosoResourceGroup" -VirtualNetworkGatewayName "ContosoVirtualGateway" -VpnClientRootCertificateName "ContosoClientRootCertificate" -``` - -This example adds a client root certificate to a virtual gateway named ContosoVirtualGateway. -The first command uses the **Get-Content** cmdlet to get a previously-exported text representation of the root certificate and stores that text data the variable named $Text. -The second command then uses a for loop to extract all the text except for the first line and the last line. -The extracted text is stored in a variable named $CertificateText. -The third command then uses the text stored in $CertificateText with the **Add-AzureRmVpnClientRootCertificate** cmdlet to add the root certificate to the gateway. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicCertData -Specifies the text representation of the root certificate to be added. -To obtain the text representation, export your certificate in .cer format (using Base64 encoding), then open the resulting file in a text editor. -When you do that, you will see output similar to the following (note that the actual output will contain many more lines of text than the abbreviated sample shown here): ------ BEGIN CERTIFICATE ----- -MIIC13FAAXC3671Auij9HHgUNEW8343NMJklo09982CVVFAw8w ------ END CERTIFICATE ----- -The PublicCertData is made up of all the lines between the first line (----- BEGIN CERTIFICATE -----) and the last line (----- END CERTIFICATE -----) in the file. -You can retrieve this data by using Windows PowerShell commands similar to this: `$Text = Get-Content -Path "C:\Azure\Certificates\ExportedCertficate.cer"` -`$CertificateText = for ($i=1; $i -lt $Text.Length -1 ; $i++){$Text\[$i\]}` - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the root certificate is assigned to. -Resource groups categorize items to help simplify inventory management and general Azure administration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkGatewayName -Specifies the name of the virtual network gateway where the certificate is added. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VpnClientRootCertificateName -Specifies the name of the client root certificate that this cmdlet adds. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVpnClientRootCertificate](./Get-AzureRmVpnClientRootCertificate.md) - -[New-AzureRmVpnClientRootCertificate](./New-AzureRmVpnClientRootCertificate.md) - -[Remove-AzureRmVpnClientRootCertificate](./Remove-AzureRmVpnClientRootCertificate.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/AzureRM.Network.md b/azurermps-6.13.0/AzureRM.Network/AzureRM.Network.md deleted file mode 100644 index de77deb013..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/AzureRM.Network.md +++ /dev/null @@ -1,1111 +0,0 @@ ---- -Module Name: AzureRM.Network -Module Guid: eb75c732-e274-4a20-b502-e9958e63484a -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.network -Help Version: 5.4.2.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/AzureRM.Network.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/AzureRM.Network.md ---- - -# AzureRM.Network Module -## Description -This topic displays help topics for the Azure Network Cmdlets. - -## AzureRM.Network Cmdlets -### [Add-AzureRmApplicationGatewayAuthenticationCertificate](Add-AzureRmApplicationGatewayAuthenticationCertificate.md) -Adds an authentication certificate to an application gateway. - -### [Add-AzureRmApplicationGatewayBackendAddressPool](Add-AzureRmApplicationGatewayBackendAddressPool.md) -Adds a back-end address pool to an application gateway. - -### [Add-AzureRmApplicationGatewayBackendHttpSettings](Add-AzureRmApplicationGatewayBackendHttpSettings.md) -Adds back-end HTTP settings to an application gateway. - -### [Add-AzureRmApplicationGatewayFrontendIPConfig](Add-AzureRmApplicationGatewayFrontendIPConfig.md) -Adds a front-end IP configuration to an application gateway. - -### [Add-AzureRmApplicationGatewayFrontendPort](Add-AzureRmApplicationGatewayFrontendPort.md) -Adds a front-end port to an application gateway. - -### [Add-AzureRmApplicationGatewayHttpListener](Add-AzureRmApplicationGatewayHttpListener.md) -Adds an HTTP listener to an application gateway. - -### [Add-AzureRmApplicationGatewayIPConfiguration](Add-AzureRmApplicationGatewayIPConfiguration.md) -Adds an IP configuration to an application gateway. - -### [Add-AzureRmApplicationGatewayProbeConfig](Add-AzureRmApplicationGatewayProbeConfig.md) -Adds a health probe to an Application Gateway. - -### [Add-AzureRmApplicationGatewayRedirectConfiguration](Add-AzureRmApplicationGatewayRedirectConfiguration.md) -Adds a redirect configuration to an Application Gateway. - -### [Add-AzureRmApplicationGatewayRequestRoutingRule](Add-AzureRmApplicationGatewayRequestRoutingRule.md) -Adds a request routing rule to an application gateway. - -### [Add-AzureRmApplicationGatewaySslCertificate](Add-AzureRmApplicationGatewaySslCertificate.md) -Adds an SSL certificate to an application gateway. - -### [Add-AzureRmApplicationGatewayTrustedRootCertificate](Add-AzureRmApplicationGatewayTrustedRootCertificate.md) -Adds a trusted root certificate to an application gateway. - -### [Add-AzureRmApplicationGatewayUrlPathMapConfig](Add-AzureRmApplicationGatewayUrlPathMapConfig.md) -Adds an array of URL path mappings to a backend server pool. - -### [Add-AzureRmExpressRouteCircuitAuthorization](Add-AzureRmExpressRouteCircuitAuthorization.md) -Adds an ExpressRoute circuit authorization. - -### [Add-AzureRmExpressRouteCircuitConnectionConfig](Add-AzureRmExpressRouteCircuitConnectionConfig.md) -Adds a circuit connection configuration to Private Peering of an Express Route Circuit. - -### [Add-AzureRmExpressRouteCircuitPeeringConfig](Add-AzureRmExpressRouteCircuitPeeringConfig.md) -Adds a peering configuration to an ExpressRoute circuit. - -### [Add-AzureRmLoadBalancerBackendAddressPoolConfig](Add-AzureRmLoadBalancerBackendAddressPoolConfig.md) -Adds a backend address pool configuration to a load balancer. - -### [Add-AzureRmLoadBalancerFrontendIpConfig](Add-AzureRmLoadBalancerFrontendIpConfig.md) -Adds a front-end IP configuration to a load balancer. - -### [Add-AzureRmLoadBalancerInboundNatPoolConfig](Add-AzureRmLoadBalancerInboundNatPoolConfig.md) - - -### [Add-AzureRmLoadBalancerInboundNatRuleConfig](Add-AzureRmLoadBalancerInboundNatRuleConfig.md) -Adds an inbound NAT rule configuration to a load balancer. - -### [Add-AzureRmLoadBalancerOutboundRuleConfig](Add-AzureRmLoadBalancerOutboundRuleConfig.md) -Adds an outbound rule configuration to a load balancer. - -### [Add-AzureRmLoadBalancerProbeConfig](Add-AzureRmLoadBalancerProbeConfig.md) -Adds a probe configuration to a load balancer. - -### [Add-AzureRmLoadBalancerRuleConfig](Add-AzureRmLoadBalancerRuleConfig.md) -Adds a rule configuration to a load balancer. - -### [Add-AzureRmNetworkInterfaceIpConfig](Add-AzureRmNetworkInterfaceIpConfig.md) -Adds a network interface IP configuration to a network interface. - -### [Add-AzureRmNetworkInterfaceTapConfig](Add-AzureRmNetworkInterfaceTapConfig.md) -{{Fill in the Synopsis}} - -### [Add-AzureRmNetworkSecurityRuleConfig](Add-AzureRmNetworkSecurityRuleConfig.md) -Adds a network security rule configuration to a network security group. - -### [Add-AzureRmRouteConfig](Add-AzureRmRouteConfig.md) -Adds a route to a route table. - -### [Add-AzureRmRouteFilterRuleConfig](Add-AzureRmRouteFilterRuleConfig.md) -Adds a route filter rule to a route filter. - -### [Add-AzureRmServiceEndpointPolicyDefinition](Add-AzureRmServiceEndpointPolicyDefinition.md) -{{Fill in the Synopsis}} - -### [Add-AzureRmVirtualNetworkGatewayIpConfig](Add-AzureRmVirtualNetworkGatewayIpConfig.md) -Adds an IP configuration to a virtual network gateway. - -### [Add-AzureRmVirtualNetworkPeering](Add-AzureRmVirtualNetworkPeering.md) -Creates a peering between two virtual networks. - -### [Add-AzureRmVirtualNetworkSubnetConfig](Add-AzureRmVirtualNetworkSubnetConfig.md) -Adds a subnet configuration to a virtual network. - -### [Add-AzureRmVpnClientRevokedCertificate](Add-AzureRmVpnClientRevokedCertificate.md) -Adds a VPN client-revocation certificate. - -### [Add-AzureRmVpnClientRootCertificate](Add-AzureRmVpnClientRootCertificate.md) -Adds a VPN client root certificate. - -### [Get-AzureRmApplicationGateway](Get-AzureRmApplicationGateway.md) -Gets an application gateway. - -### [Get-AzureRmApplicationGatewayAuthenticationCertificate](Get-AzureRmApplicationGatewayAuthenticationCertificate.md) -Gets an authentication certificate for an application gateway. - -### [Get-AzureRmApplicationGatewayAutoscaleConfiguration](Get-AzureRmApplicationGatewayAutoscaleConfiguration.md) -Gets the autoscale configuration for an application gateway. - -### [Get-AzureRmApplicationGatewayAvailableSslOptions](Get-AzureRmApplicationGatewayAvailableSslOptions.md) -Gets all available ssl options for ssl policy for Application Gateway. - -### [Get-AzureRmApplicationGatewayAvailableWafRuleSets](Get-AzureRmApplicationGatewayAvailableWafRuleSets.md) -Gets all available web application firewall rule sets. - -### [Get-AzureRmApplicationGatewayBackendAddressPool](Get-AzureRmApplicationGatewayBackendAddressPool.md) -Gets a back-end address pool for an application gateway. - -### [Get-AzureRmApplicationGatewayBackendHealth](Get-AzureRmApplicationGatewayBackendHealth.md) -Gets application gateway backend health. - -### [Get-AzureRmApplicationGatewayBackendHttpSettings](Get-AzureRmApplicationGatewayBackendHttpSettings.md) -Gets the back-end HTTP settings of an application gateway. - -### [Get-AzureRmApplicationGatewayConnectionDraining](Get-AzureRmApplicationGatewayConnectionDraining.md) -Gets the connection draining configuration of a back-end HTTP settings object. - -### [Get-AzureRmApplicationGatewayFrontendIPConfig](Get-AzureRmApplicationGatewayFrontendIPConfig.md) -Gets the front-end IP configuration of an application gateway. - -### [Get-AzureRmApplicationGatewayFrontendPort](Get-AzureRmApplicationGatewayFrontendPort.md) -Gets the front-end port of an application gateway. - -### [Get-AzureRmApplicationGatewayHttpListener](Get-AzureRmApplicationGatewayHttpListener.md) -Gets the HTTP listener of an application gateway. - -### [Get-AzureRmApplicationGatewayIPConfiguration](Get-AzureRmApplicationGatewayIPConfiguration.md) -Gets the IP configuration of an application gateway. - -### [Get-AzureRmApplicationGatewayProbeConfig](Get-AzureRmApplicationGatewayProbeConfig.md) -Gets an existing health probe configuration from an Application Gateway. - -### [Get-AzureRmApplicationGatewayRedirectConfiguration](Get-AzureRmApplicationGatewayRedirectConfiguration.md) -Gets an existing redirect configuration from an Application Gateway. - -### [Get-AzureRmApplicationGatewayRequestRoutingRule](Get-AzureRmApplicationGatewayRequestRoutingRule.md) -Gets the request routing rule of an application gateway. - -### [Get-AzureRmApplicationGatewaySku](Get-AzureRmApplicationGatewaySku.md) -Gets the SKU of an application gateway. - -### [Get-AzureRmApplicationGatewaySslCertificate](Get-AzureRmApplicationGatewaySslCertificate.md) -Gets an SSL certificate for an application gateway. - -### [Get-AzureRmApplicationGatewaySslPolicy](Get-AzureRmApplicationGatewaySslPolicy.md) -Gets the SSL policy of an application gateway. - -### [Get-AzureRmApplicationGatewaySslPredefinedPolicy](Get-AzureRmApplicationGatewaySslPredefinedPolicy.md) -Gets Predefined SSL Policies provided by Application Gateway. - -### [Get-AzureRmApplicationGatewayTrustedRootCertificate](Get-AzureRmApplicationGatewayTrustedRootCertificate.md) -Gets Trusted Root Certificates of an application gateway. - -### [Get-AzureRmApplicationGatewayUrlPathMapConfig](Get-AzureRmApplicationGatewayUrlPathMapConfig.md) -Gets an array of URL path mappings to a backend server pool. - -### [Get-AzureRmApplicationGatewayWebApplicationFirewallConfiguration](Get-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md) -Gets the WAF configuration of an application gateway. - -### [Get-AzureRmApplicationSecurityGroup](Get-AzureRmApplicationSecurityGroup.md) -Gets an application security group. - -### [Get-AzureRmBgpServiceCommunity](Get-AzureRmBgpServiceCommunity.md) -Provides a list of all services / regions, BGP communities, and associated prefixes. - -### [Get-AzureRmDdosProtectionPlan](Get-AzureRmDdosProtectionPlan.md) -Gets a DDoS protection plan. - -### [Get-AzureRmEffectiveNetworkSecurityGroup](Get-AzureRmEffectiveNetworkSecurityGroup.md) -Gets the effective network security group of a network interface. - -### [Get-AzureRmEffectiveRouteTable](Get-AzureRmEffectiveRouteTable.md) -Gets the effective route table of a network interface. - -### [Get-AzureRmExpressRouteCircuit](Get-AzureRmExpressRouteCircuit.md) -Gets an Azure ExpressRoute circuit from Azure. - -### [Get-AzureRmExpressRouteCircuitARPTable](Get-AzureRmExpressRouteCircuitARPTable.md) -Gets the ARP table from an ExpressRoute circuit. - -### [Get-AzureRmExpressRouteCircuitAuthorization](Get-AzureRmExpressRouteCircuitAuthorization.md) -Gets information about ExpressRoute circuit authorizations. - -### [Get-AzureRmExpressRouteCircuitConnectionConfig](Get-AzureRmExpressRouteCircuitConnectionConfig.md) -Gets an ExpressRoute circuit connection configuration associated with Private Peering of ExpressRouteCircuit. - -### [Get-AzureRmExpressRouteCircuitPeeringConfig](Get-AzureRmExpressRouteCircuitPeeringConfig.md) -Gets an ExpressRoute circuit peering configuration. - -### [Get-AzureRmExpressRouteCircuitRouteTable](Get-AzureRmExpressRouteCircuitRouteTable.md) -Gets a route table from an ExpressRoute circuit. - -### [Get-AzureRmExpressRouteCircuitRouteTableSummary](Get-AzureRmExpressRouteCircuitRouteTableSummary.md) -Gets a route table summary of an ExpressRoute circuit. - -### [Get-AzureRmExpressRouteCircuitStats](Get-AzureRmExpressRouteCircuitStats.md) -Gets usage statistics of an ExpressRoute circuit. - -### [Get-AzureRmExpressRoutePort](Get-AzureRmExpressRoutePort.md) -Gets an Azure ExpressRoutePort resource. - -### [Get-AzureRmExpressRoutePortLinkConfig](Get-AzureRmExpressRoutePortLinkConfig.md) -Gets an ExpressRoutePort's link configuration. - -### [Get-AzureRmExpressRoutePortsLocation](Get-AzureRmExpressRoutePortsLocation.md) -Gets a list of available locations of ExpressRoutePorts. Gets attributes of a location for a specified location. - -### [Get-AzureRmExpressRouteServiceProvider](Get-AzureRmExpressRouteServiceProvider.md) -Gets a list ExpressRoute service providers and their attributes. - -### [Get-AzureRmFirewall](Get-AzureRmFirewall.md) -Gets a Azure Firewall. - -### [Get-AzureRmLoadBalancer](Get-AzureRmLoadBalancer.md) -Gets a load balancer. - -### [Get-AzureRmLoadBalancerBackendAddressPoolConfig](Get-AzureRmLoadBalancerBackendAddressPoolConfig.md) -Gets a backend address pool configuration for a load balancer. - -### [Get-AzureRmLoadBalancerFrontendIpConfig](Get-AzureRmLoadBalancerFrontendIpConfig.md) -Gets a front-end IP configuration in a load balancer. - -### [Get-AzureRmLoadBalancerInboundNatPoolConfig](Get-AzureRmLoadBalancerInboundNatPoolConfig.md) - - -### [Get-AzureRmLoadBalancerInboundNatRuleConfig](Get-AzureRmLoadBalancerInboundNatRuleConfig.md) -Gets an inbound NAT rule configuration for a load balancer. - -### [Get-AzureRmLoadBalancerOutboundRuleConfig](Get-AzureRmLoadBalancerOutboundRuleConfig.md) -Gets an outbound rule configuration in a load balancer. - -### [Get-AzureRmLoadBalancerProbeConfig](Get-AzureRmLoadBalancerProbeConfig.md) -Gets a probe configuration for a load balancer. - -### [Get-AzureRmLoadBalancerRuleConfig](Get-AzureRmLoadBalancerRuleConfig.md) -Gets the rule configuration for a load balancer. - -### [Get-AzureRmLocalNetworkGateway](Get-AzureRmLocalNetworkGateway.md) -Gets a Local Network Gateway - -### [Get-AzureRmNetworkInterface](Get-AzureRmNetworkInterface.md) -Gets a network interface. - -### [Get-AzureRmNetworkInterfaceIpConfig](Get-AzureRmNetworkInterfaceIpConfig.md) -Gets a network interface IP configuration for a network interface. - -### [Get-AzureRmNetworkProfile](Get-AzureRmNetworkProfile.md) -Gets an existing network profile top level resource - -### [Get-AzureRmNetworkInterfaceTapConfig](Get-AzureRmNetworkInterfaceTapConfig.md) -{{Fill in the Synopsis}} - -### [Get-AzureRmNetworkSecurityGroup](Get-AzureRmNetworkSecurityGroup.md) -Gets a network security group. - -### [Get-AzureRmNetworkSecurityRuleConfig](Get-AzureRmNetworkSecurityRuleConfig.md) -Get a network security rule configuration for a network security group. - -### [Get-AzureRmNetworkUsage](Get-AzureRmNetworkUsage.md) -Lists network usages for a subscription - -### [Get-AzureRmNetworkWatcher](Get-AzureRmNetworkWatcher.md) -Gets the properties of a Network Watcher - -### [Get-AzureRmNetworkWatcherConnectionMonitor](Get-AzureRmNetworkWatcherConnectionMonitor.md) -Returns connection monitor with specified name or the list of connection monitors - -### [Get-AzureRmNetworkWatcherConnectionMonitorReport](Get-AzureRmNetworkWatcherConnectionMonitorReport.md) -Query a snapshot of the most recent connection states. - -### [Get-AzureRmNetworkWatcherFlowLogStatus](Get-AzureRmNetworkWatcherFlowLogStatus.md) -Gets the status of flow logging on a resource. - -### [Get-AzureRmNetworkWatcherNextHop](Get-AzureRmNetworkWatcherNextHop.md) -Gets the next hop from a VM. - -### [Get-AzureRmNetworkWatcherPacketCapture](Get-AzureRmNetworkWatcherPacketCapture.md) -Gets information and properties and status of a packet capture resource. - -### [Get-AzureRmNetworkWatcherReachabilityProvidersList](Get-AzureRmNetworkWatcherReachabilityProvidersList.md) -Lists all available internet service providers for a specified Azure region. - -### [Get-AzureRmNetworkWatcherReachabilityReport](Get-AzureRmNetworkWatcherReachabilityReport.md) -Gets the relative latency score for internet service providers from a specified location to Azure regions. - -### [Get-AzureRmNetworkWatcherSecurityGroupView](Get-AzureRmNetworkWatcherSecurityGroupView.md) -View the configured and effective network security group rules applied on a VM. - -### [Get-AzureRmNetworkWatcherTopology](Get-AzureRmNetworkWatcherTopology.md) -Gets a network level view of resources and their relationships in a resource group. - -### [Get-AzureRmNetworkWatcherTroubleshootingResult](Get-AzureRmNetworkWatcherTroubleshootingResult.md) -Gets the troubleshooting result from the previously run or currently running troubleshooting operation. - -### [Get-AzureRmPublicIpAddress](Get-AzureRmPublicIpAddress.md) -Gets a public IP address. - -### [Get-AzureRmPublicIpPrefix](Get-AzureRmPublicIpPrefix.md) -Gets a public IP prefix - -### [Get-AzureRmRouteConfig](Get-AzureRmRouteConfig.md) -Gets routes from a route table. - -### [Get-AzureRmRouteFilter](Get-AzureRmRouteFilter.md) -{{Fill in the Synopsis}} - -### [Get-AzureRmRouteFilterRuleConfig](Get-AzureRmRouteFilterRuleConfig.md) -{{Fill in the Synopsis}} - -### [Get-AzureRmRouteTable](Get-AzureRmRouteTable.md) -Gets route tables. - -### [Get-AzureRmServiceEndpointPolicy](Get-AzureRmServiceEndpointPolicy.md) -{{Fill in the Synopsis}} - -### [Get-AzureRmServiceEndpointPolicyDefinition](Get-AzureRmServiceEndpointPolicyDefinition.md) -{{Fill in the Synopsis}} - -### [Get-AzureRmVirtualHub](Get-AzureRmVirtualHub.md) -Gets an Azure VirtualHub by Name and ResourceGroupName or lists all Virtual Hubs by ResourceGroupName/Subscription. - -### [Get-AzureRmVirtualHubVnetConnection](Get-AzureRmVirtualHubVnetConnection.md) -Gets a Virtual Network Connection in a virtual hub or lists all virtual network connections in a virtual hub. - -### [Get-AzureRmVirtualNetwork](Get-AzureRmVirtualNetwork.md) -Gets a virtual network in a resource group. - -### [Get-AzureRmVirtualNetworkAvailableEndpointService](Get-AzureRmVirtualNetworkAvailableEndpointService.md) -Lists available endpoint services for location. - -### [Get-AzureRmVirtualNetworkGateway](Get-AzureRmVirtualNetworkGateway.md) -Gets a Virtual Network Gateway - -### [Get-AzureRmVirtualNetworkGatewayAdvertisedRoute](Get-AzureRmVirtualNetworkGatewayAdvertisedRoute.md) -Lists routes being advertised by an Azure virtual network gateway - -### [Get-AzureRmVirtualNetworkGatewayBGPPeerStatus](Get-AzureRmVirtualNetworkGatewayBGPPeerStatus.md) -Lists an Azure virtual network gateway's BGP peers - -### [Get-AzureRmVirtualNetworkGatewayConnection](Get-AzureRmVirtualNetworkGatewayConnection.md) -Gets a Virtual Network Gateway Connection - -### [Get-AzureRmVirtualNetworkGatewayConnectionSharedKey](Get-AzureRmVirtualNetworkGatewayConnectionSharedKey.md) -Displays the shared key used for the connection. - -### [Get-AzureRmVirtualNetworkGatewayConnectionVpnDeviceConfigScript](Get-AzureRmVirtualNetworkGatewayConnectionVpnDeviceConfigScript.md) -This commandlet takes the connection resource, VPN device brand, model, firmware version, and return the corresponding configuration script that customers can apply directly on their on-premises VPN devices. The script will follow the syntax of the selected device, and fill in the necessary parameters such as Azure gateway public IP addresses, virtual network address prefixes, VPN tunnel pre-shared key, etc. so customers can simply copy-paste to their VPN device configurations. - -### [Get-AzureRmVirtualNetworkGatewayLearnedRoute](Get-AzureRmVirtualNetworkGatewayLearnedRoute.md) -Lists routes learned by an Azure virtual network gateway - -### [Get-AzureRmVirtualNetworkGatewaySupportedVpnDevice](Get-AzureRmVirtualNetworkGatewaySupportedVpnDevice.md) -This commandlet returns a list of supported VPN device brands, models, and firmware versions. - -### [Get-AzureRmVirtualNetworkPeering](Get-AzureRmVirtualNetworkPeering.md) -Gets the virtual network peering. - -### [Get-AzureRmVirtualNetworkSubnetConfig](Get-AzureRmVirtualNetworkSubnetConfig.md) -Gets a subnet in a virtual network. - -### [Get-AzureRmVirtualNetworkTap](Get-AzureRmVirtualNetworkTap.md) -{{Fill in the Synopsis}} - -### [Get-AzureRmVirtualNetworkUsageList](Get-AzureRmVirtualNetworkUsageList.md) -Gets virtual network current usage. - -### [Get-AzureRmVirtualWan](Get-AzureRmVirtualWan.md) -Gets a Virtual WAN or all Virtual WANs in a resource group or subscription. - -### [Get-AzureRmVirtualWanVpnConfiguration](Get-AzureRmVirtualWanVpnConfiguration.md) -Gets the Vpn configuration for a subset of VpnSites connected to this WAN via VpnConnections. Uploads the generated Vpn -configuration to a storage blob specified by the customer. - -### [Get-AzureRmVpnClientConfiguration](Get-AzureRmVpnClientConfiguration.md) -Allows users to easily download the Vpn Profile package that was generated using the New-AzureRmVpnClientConfiguration commandlet. - -### [Get-AzureRmVpnClientIpsecParameter](Get-AzureRmVpnClientIpsecParameter.md) -Gets the vpn Ipsec parameters set on Virtual Network Gateway for Point to site connections. - -### [Get-AzureRmVpnClientPackage](Get-AzureRmVpnClientPackage.md) -Gets information about a VPN client package. - -### [Get-AzureRmVpnClientRevokedCertificate](Get-AzureRmVpnClientRevokedCertificate.md) -Gets information about VPN client-revocation certificates. - -### [Get-AzureRmVpnClientRootCertificate](Get-AzureRmVpnClientRootCertificate.md) -Gets information about VPN root certificates. - -### [Get-AzureRmVpnConnection](Get-AzureRmVpnConnection.md) -Gets a vpn connection by name or lists all vpn connections connected to a VpnGateway. - -### [Get-AzureRmVpnGateway](Get-AzureRmVpnGateway.md) -Gets a VpnGateway resource using ResourceGroupName and GatewayName OR lists all gateways by ResourceGroupName or SubscriptionId. - -### [Get-AzureRmVpnSite](Get-AzureRmVpnSite.md) -Gets an Azure VpnSite resource by name OR lists all VpnSites in a ResourceGroup or SubscriptionId. - -This is an RM representation of customer branches that are uploaded to Azure for S2S connectivity with a Cortex virtual hub. - -### [Move-AzureRmExpressRouteCircuit](Move-AzureRmExpressRouteCircuit.md) -Moves an ExpressRoute circuit from the classic deployment model to the Resource Manager deployment model. - -### [New-AzureRmApplicationGateway](New-AzureRmApplicationGateway.md) -Creates an application gateway. - -### [New-AzureRmApplicationGatewayAuthenticationCertificate](New-AzureRmApplicationGatewayAuthenticationCertificate.md) -Creates an authentication certificate for an application gateway. - -### [New-AzureRmApplicationGatewayAutoscaleConfiguration](New-AzureRmApplicationGatewayAutoscaleConfiguration.md) -Creates the autoscale configuration for an application gateway. - -### [New-AzureRmApplicationGatewayBackendAddressPool](New-AzureRmApplicationGatewayBackendAddressPool.md) -Creates a back-end address pool for an application gateway. - -### [New-AzureRmApplicationGatewayBackendHttpSettings](New-AzureRmApplicationGatewayBackendHttpSettings.md) -Creates back-end HTTP settings for an application gateway. - -### [New-AzureRmApplicationGatewayConnectionDraining](New-AzureRmApplicationGatewayConnectionDraining.md) -Creates a new connection draining configuration for back-end HTTP settings. - -### [New-AzureRmApplicationGatewayFirewallDisabledRuleGroupConfig](New-AzureRmApplicationGatewayFirewallDisabledRuleGroupConfig.md) -Creates a new disabled rule group configuration. - -### [New-AzureRmApplicationGatewayFirewallExclusionConfig](New-AzureRmApplicationGatewayFirewallExclusionConfig.md) -Creates a new exclusion rule list for application gateway waf - -### [New-AzureRmApplicationGatewayFrontendIPConfig](New-AzureRmApplicationGatewayFrontendIPConfig.md) -Creates a front-end IP configuration for an application gateway. - -### [New-AzureRmApplicationGatewayFrontendPort](New-AzureRmApplicationGatewayFrontendPort.md) -Creates a front-end port for an application gateway. - -### [New-AzureRmApplicationGatewayHttpListener](New-AzureRmApplicationGatewayHttpListener.md) -Creates an HTTP listener for an application gateway. - -### [New-AzureRmApplicationGatewayIPConfiguration](New-AzureRmApplicationGatewayIPConfiguration.md) -Creates an IP configuration for an application gateway. - -### [New-AzureRmApplicationGatewayPathRuleConfig](New-AzureRmApplicationGatewayPathRuleConfig.md) -Creates an application gateway path rule. - -### [New-AzureRmApplicationGatewayProbeConfig](New-AzureRmApplicationGatewayProbeConfig.md) -Creates a health probe. - -### [New-AzureRmApplicationGatewayProbeHealthResponseMatch](New-AzureRmApplicationGatewayProbeHealthResponseMatch.md) -Creates a health probe response match used by Health Probe for an application gateway. - -### [New-AzureRmApplicationGatewayRedirectConfiguration](New-AzureRmApplicationGatewayRedirectConfiguration.md) -Creates a redirect configuration for an application gateway. - -### [New-AzureRmApplicationGatewayRequestRoutingRule](New-AzureRmApplicationGatewayRequestRoutingRule.md) -Creates a request routing rule for an application gateway. - -### [New-AzureRmApplicationGatewaySku](New-AzureRmApplicationGatewaySku.md) -Creates a SKU for an application gateway. - -### [New-AzureRmApplicationGatewaySslCertificate](New-AzureRmApplicationGatewaySslCertificate.md) -Creates an SSL certificate for an Azure application gateway. - -### [New-AzureRmApplicationGatewaySslPolicy](New-AzureRmApplicationGatewaySslPolicy.md) -Creates an SSL policy for an application gateway. - -### [New-AzureRmApplicationGatewayTrustedRootCertificate](New-AzureRmApplicationGatewayTrustedRootCertificate.md) -Creates a Trusted Root Certificate for an application gateway. - -### [New-AzureRmApplicationGatewayUrlPathMapConfig](New-AzureRmApplicationGatewayUrlPathMapConfig.md) -Creates an array of URL path mappings to a backend server pool. - -### [New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration](New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md) -Creates a WAF configuration for an application gateway. - -### [New-AzureRmApplicationSecurityGroup](New-AzureRmApplicationSecurityGroup.md) -Creates an application security group. - -### [New-AzureRmContainerNicConfig](New-AzureRmContainerNicConfig.md) -Creates a new container network interface configuration object. - -### [New-AzureRmContainerNicConfigIpConfig](New-AzureRmContainerNicConfigIpConfig.md) -Creates a container nic configuration ip configuration object. - -### [New-AzureRmDdosProtectionPlan](New-AzureRmDdosProtectionPlan.md) -Creates a DDoS protection plan. - -### [New-AzureRmExpressRouteCircuit](New-AzureRmExpressRouteCircuit.md) -Creates an Azure express route circuit. - -### [New-AzureRmExpressRouteCircuitAuthorization](New-AzureRmExpressRouteCircuitAuthorization.md) -Creates an ExpressRoute circuit authorization. - -### [New-AzureRmExpressRouteCircuitPeeringConfig](New-AzureRmExpressRouteCircuitPeeringConfig.md) -Creates a new peering configuration to be added to an ExpressRoute circuit. - -### [New-AzureRmFirewall](New-AzureRmFirewall.md) -Creates a new Firewall in a resource group. - -### [New-AzureRmFirewallApplicationRule](New-AzureRmFirewallApplicationRule.md) -Creates a Firewall Application Rule. - -### [New-AzureRmFirewallApplicationRuleCollection](New-AzureRmFirewallApplicationRuleCollection.md) -Creates a collection of Firewall application rules. - -### [New-AzureRmFirewallNetworkRule](New-AzureRmFirewallNetworkRule.md) -Creates a Firewall Network Rule. - -### [New-AzureRmFirewallNetworkRuleCollection](New-AzureRmFirewallNetworkRuleCollection.md) -Creates a Azure Firewall Network Collection of Network rules. - -### [New-AzureRmExpressRoutePort](New-AzureRmExpressRoutePort.md) -Creates an ExpressRoutePort - -### [New-AzureRmIpsecPolicy](New-AzureRmIpsecPolicy.md) -Creates an IPSec Policy. - -### [New-AzureRmLoadBalancer](New-AzureRmLoadBalancer.md) -Creates a load balancer. - -### [New-AzureRmLoadBalancerBackendAddressPoolConfig](New-AzureRmLoadBalancerBackendAddressPoolConfig.md) -Creates a backend address pool configuration for a load balancer. - -### [New-AzureRmLoadBalancerFrontendIpConfig](New-AzureRmLoadBalancerFrontendIpConfig.md) -Creates a front-end IP configuration for a load balancer. - -### [New-AzureRmLoadBalancerInboundNatPoolConfig](New-AzureRmLoadBalancerInboundNatPoolConfig.md) - - -### [New-AzureRmLoadBalancerInboundNatRuleConfig](New-AzureRmLoadBalancerInboundNatRuleConfig.md) -Creates an inbound NAT rule configuration for a load balancer. - -### [New-AzureRmLoadBalancerOutboundRuleConfig](New-AzureRmLoadBalancerOutboundRuleConfig.md) -Creates an outbound rule configuration for a load balancer. - -### [New-AzureRmLoadBalancerProbeConfig](New-AzureRmLoadBalancerProbeConfig.md) -Creates a probe configuration for a load balancer. - -### [New-AzureRmLoadBalancerRuleConfig](New-AzureRmLoadBalancerRuleConfig.md) -Creates a rule configuration for a load balancer. - -### [New-AzureRmLocalNetworkGateway](New-AzureRmLocalNetworkGateway.md) -Creates a Local Network Gateway - -### [New-AzureRmNetworkInterface](New-AzureRmNetworkInterface.md) -Creates a network interface. - -### [New-AzureRmNetworkInterfaceIpConfig](New-AzureRmNetworkInterfaceIpConfig.md) -Creates a network interface IP configuration. - -### [New-AzureRmNetworkProfile](New-AzureRmNetworkProfile.md) -Creates a new network profile. - -### [New-AzureRmNetworkSecurityGroup](New-AzureRmNetworkSecurityGroup.md) -Creates a network security group. - -### [New-AzureRmNetworkSecurityRuleConfig](New-AzureRmNetworkSecurityRuleConfig.md) -Creates a network security rule configuration. - -### [New-AzureRmNetworkWatcher](New-AzureRmNetworkWatcher.md) -Creates a new Network Watcher resource. - -### [New-AzureRmNetworkWatcherConnectionMonitor](New-AzureRmNetworkWatcherConnectionMonitor.md) -Creates a connection monitor. - -### [New-AzureRmNetworkWatcherPacketCapture](New-AzureRmNetworkWatcherPacketCapture.md) -Creates a new packet capture resource and starts a packet capture session on a VM. - -### [New-AzureRmNetworkWatcherProtocolConfiguration](New-AzureRmNetworkWatcherProtocolConfiguration.md) -Creates a new protocol configuration object. - -### [New-AzureRmPacketCaptureFilterConfig](New-AzureRmPacketCaptureFilterConfig.md) -Creates a new packet capture filter object. - -### [New-AzureRmPublicIpAddress](New-AzureRmPublicIpAddress.md) -Creates a public IP address. - -### [New-AzureRmPublicIpPrefix](New-AzureRmPublicIpPrefix.md) -Creates a Public IP Prefix - -### [New-AzureRmPublicIpTag](New-AzureRmPublicIpTag.md) -Creates an IP Tag. - -### [New-AzureRmRouteConfig](New-AzureRmRouteConfig.md) -Creates a route for a route table. - -### [New-AzureRmRouteFilter](New-AzureRmRouteFilter.md) -Creates a route filter. - -### [New-AzureRmRouteFilterRuleConfig](New-AzureRmRouteFilterRuleConfig.md) -Creates a route filter rule for a route filter. - -### [New-AzureRmRouteTable](New-AzureRmRouteTable.md) -Creates a route table. - -### [New-AzureRmServiceEndpointPolicy](New-AzureRmServiceEndpointPolicy.md) -{{Fill in the Synopsis}} - -### [New-AzureRmServiceEndpointPolicyDefinition](New-AzureRmServiceEndpointPolicyDefinition.md) -{{Fill in the Synopsis}} - -### [New-AzureRmVirtualHub](New-AzureRmVirtualHub.md) -Creates an Azure VirtualHub resource. - -### [New-AzureRmVirtualHubRoute](New-AzureRmVirtualHubRoute.md) -Creates an Azure Virtual Hub Route object. - -### [New-AzureRmVirtualHubRouteTable](New-AzureRmVirtualHubRouteTable.md) -Creates an Azure Virtual Hub Route Table object. - -### [New-AzureRmVirtualHubVnetConnection](New-AzureRmVirtualHubVnetConnection.md) -The New-AzureRmVirtualHubVnetConnection cmdlet creates a HubVirtualNetworkConnection resource that peers a Virtual Network to the Azure Virtual Hub. - -### [New-AzureRmVirtualNetwork](New-AzureRmVirtualNetwork.md) -Creates a virtual network. - -### [New-AzureRmVirtualNetworkGateway](New-AzureRmVirtualNetworkGateway.md) -Creates a Virtual Network Gateway - -### [New-AzureRmVirtualNetworkGatewayConnection](New-AzureRmVirtualNetworkGatewayConnection.md) -Creates the Site-to-Site VPN connection between the virtual network gateway and the on-prem VPN device. - -### [New-AzureRmVirtualNetworkGatewayIpConfig](New-AzureRmVirtualNetworkGatewayIpConfig.md) -Creates an IP Configuration for a Virtual Network Gateway - -### [New-AzureRmVirtualNetworkSubnetConfig](New-AzureRmVirtualNetworkSubnetConfig.md) -Creates a virtual network subnet configuration. - -### [New-AzureRmVirtualNetworkTap](New-AzureRmVirtualNetworkTap.md) -{{Fill in the Synopsis}} - -### [New-AzureRmVirtualWan](New-AzureRmVirtualWan.md) -Creates an Azure Virtual WAN. - -### [New-AzureRmVpnClientConfiguration](New-AzureRmVpnClientConfiguration.md) -This command allows the users to create the Vpn profile package based on pre-configured vpn settings on the VPN gateway, in addition to some additional settings that users may need to configure, for e.g. some root certificates. - -### [New-AzureRmVpnClientIpsecParameter](New-AzureRmVpnClientIpsecParameter.md) -This command allows the users to create the Vpn ipsec parameters object specifying one or all values such as IpsecEncryption,IpsecIntegrity,IkeEncryption,IkeIntegrity,DhGroup,PfsGroup to set on the existing VPN gateway. - -### [New-AzureRmVpnClientIpsecPolicy](New-AzureRmVpnClientIpsecPolicy.md) -This command allows the users to create the Vpn ipsec policy object specifying one or all values such as IpsecEncryption,IpsecIntegrity,IkeEncryption,IkeIntegrity,DhGroup,PfsGroup to set on the VPN gateway. This command let output object is used to set vpn ipsec policy for both new / exisitng gateway. - -### [New-AzureRmVpnClientRevokedCertificate](New-AzureRmVpnClientRevokedCertificate.md) -Creates a new VPN client-revocation certificate. - -### [New-AzureRmVpnClientRootCertificate](New-AzureRmVpnClientRootCertificate.md) -Creates a new VPN client root certificate. - -### [New-AzureRmVpnConnection](New-AzureRmVpnConnection.md) -Creates a IPSec connection that connects a VpnGateway to a remote customer branch represented in RM as a VpnSite. - -### [New-AzureRmVpnGateway](New-AzureRmVpnGateway.md) -Creates a Scalable VPN Gateway. - -### [New-AzureRmVpnSite](New-AzureRmVpnSite.md) -Creates a new Azure VpnSite resource. This is an RM representation of customer branches that are uploaded to Azure -for S2S connectivity with a Cortex virtual hub. - -### [Remove-AzureRmApplicationGateway](Remove-AzureRmApplicationGateway.md) -Removes an application gateway. - -### [Remove-AzureRmApplicationGatewayAuthenticationCertificate](Remove-AzureRmApplicationGatewayAuthenticationCertificate.md) -Removes an authentication certificate from an application gateway. - -### [Remove-AzureRmApplicationGatewayAutoscaleConfiguration](Remove-AzureRmApplicationGatewayAutoscaleConfiguration.md) -Removes the autoscale configuration from an application gateway. - -### [Remove-AzureRmApplicationGatewayBackendAddressPool](Remove-AzureRmApplicationGatewayBackendAddressPool.md) -Removes a back-end address pool from an application gateway. - -### [Remove-AzureRmApplicationGatewayBackendHttpSettings](Remove-AzureRmApplicationGatewayBackendHttpSettings.md) -Removes back-end HTTP settings from an application gateway. - -### [Remove-AzureRmApplicationGatewayConnectionDraining](Remove-AzureRmApplicationGatewayConnectionDraining.md) -Removes the connection draining configuration of a back-end HTTP settings object. - -### [Remove-AzureRmApplicationGatewayFrontendIPConfig](Remove-AzureRmApplicationGatewayFrontendIPConfig.md) -Removes a front-end IP configuration from an application gateway. - -### [Remove-AzureRmApplicationGatewayFrontendPort](Remove-AzureRmApplicationGatewayFrontendPort.md) -Removes a front-end port from an application gateway. - -### [Remove-AzureRmApplicationGatewayHttpListener](Remove-AzureRmApplicationGatewayHttpListener.md) -Removes an HTTP listener from an application gateway. - -### [Remove-AzureRmApplicationGatewayIPConfiguration](Remove-AzureRmApplicationGatewayIPConfiguration.md) -Removes an IP configuration from an application gateway. - -### [Remove-AzureRmApplicationGatewayProbeConfig](Remove-AzureRmApplicationGatewayProbeConfig.md) -Removes a health probe from an existing application gateway. - -### [Remove-AzureRmApplicationGatewayRedirectConfiguration](Remove-AzureRmApplicationGatewayRedirectConfiguration.md) -Removes a redirect configuration from an existing Application Gateway. - -### [Remove-AzureRmApplicationGatewayRequestRoutingRule](Remove-AzureRmApplicationGatewayRequestRoutingRule.md) -Removes a request routing rule from an application gateway. - -### [Remove-AzureRmApplicationGatewaySslCertificate](Remove-AzureRmApplicationGatewaySslCertificate.md) -Removes an SSL certificate from an Azure application gateway. - -### [Remove-AzureRmApplicationGatewaySslPolicy](Remove-AzureRmApplicationGatewaySslPolicy.md) -Removes an SSL policy from an Azure application gateway. - -### [Remove-AzureRmApplicationGatewayTrustedRootCertificate](Remove-AzureRmApplicationGatewayTrustedRootCertificate.md) -Removes a Trusted Root Certificate from an application gateway. - -### [Remove-AzureRmApplicationGatewayUrlPathMapConfig](Remove-AzureRmApplicationGatewayUrlPathMapConfig.md) -Removes URL path mappings to a backend server pool. - -### [Remove-AzureRmApplicationSecurityGroup](Remove-AzureRmApplicationSecurityGroup.md) -Removes an application security group. - -### [Remove-AzureRmDdosProtectionPlan](Remove-AzureRmDdosProtectionPlan.md) -Removes a DDoS protection plan. - -### [Remove-AzureRmExpressRouteCircuit](Remove-AzureRmExpressRouteCircuit.md) -Removes an ExpressRoute circuit. - -### [Remove-AzureRmExpressRouteCircuitAuthorization](Remove-AzureRmExpressRouteCircuitAuthorization.md) -Removes an existing ExpressRoute configuration authorization. - -### [Remove-AzureRmExpressRouteCircuitConnectionConfig](Remove-AzureRmExpressRouteCircuitConnectionConfig.md) -Removes an ExpressRoute circuit connection configuration. - -### [Remove-AzureRmExpressRouteCircuitPeeringConfig](Remove-AzureRmExpressRouteCircuitPeeringConfig.md) -Removes an ExpressRoute circuit peering configuration. - -### [Remove-AzureRmFirewall](Remove-AzureRmFirewall.md) -Remove a Firewall. - -### [Remove-AzureRmExpressRoutePort](Remove-AzureRmExpressRoutePort.md) -Removes an ExpressRoutePort - -### [Remove-AzureRmLoadBalancer](Remove-AzureRmLoadBalancer.md) -Removes a load balancer. - -### [Remove-AzureRmLoadBalancerBackendAddressPoolConfig](Remove-AzureRmLoadBalancerBackendAddressPoolConfig.md) -Removes a backend address pool configuration from a load balancer. - -### [Remove-AzureRmLoadBalancerFrontendIpConfig](Remove-AzureRmLoadBalancerFrontendIpConfig.md) -Removes a front-end IP configuration from a load balancer. - -### [Remove-AzureRmLoadBalancerInboundNatPoolConfig](Remove-AzureRmLoadBalancerInboundNatPoolConfig.md) - - -### [Remove-AzureRmLoadBalancerInboundNatRuleConfig](Remove-AzureRmLoadBalancerInboundNatRuleConfig.md) -Removes an inbound NAT rule configuration from a load balancer. - -### [Remove-AzureRmLoadBalancerOutboundRuleConfig](Remove-AzureRmLoadBalancerOutboundRuleConfig.md) -Removes an outbound rule configuration from a load balancer. - -### [Remove-AzureRmLoadBalancerProbeConfig](Remove-AzureRmLoadBalancerProbeConfig.md) -Removes a probe configuration from a load balancer. - -### [Remove-AzureRmLoadBalancerRuleConfig](Remove-AzureRmLoadBalancerRuleConfig.md) -Removes a rule configuration for a load balancer. - -### [Remove-AzureRmLocalNetworkGateway](Remove-AzureRmLocalNetworkGateway.md) -Deletes a Local Network Gateway - -### [Remove-AzureRmNetworkInterface](Remove-AzureRmNetworkInterface.md) -Removes a network interface. - -### [Remove-AzureRmNetworkInterfaceIpConfig](Remove-AzureRmNetworkInterfaceIpConfig.md) -Removes a network interface IP configuration from a network interface. - -### [Remove-AzureRmNetworkProfile](Remove-AzureRmNetworkProfile.md) -Removes a network profile. - -### [Remove-AzureRmNetworkInterfaceTapConfig](Remove-AzureRmNetworkInterfaceTapConfig.md) -{{Fill in the Synopsis}} - -### [Remove-AzureRmNetworkSecurityGroup](Remove-AzureRmNetworkSecurityGroup.md) -Removes a network security group. - -### [Remove-AzureRmNetworkSecurityRuleConfig](Remove-AzureRmNetworkSecurityRuleConfig.md) -Removes a network security rule from a network security group. - -### [Remove-AzureRmNetworkWatcher](Remove-AzureRmNetworkWatcher.md) -Removes a Network Watcher. - -### [Remove-AzureRmNetworkWatcherConnectionMonitor](Remove-AzureRmNetworkWatcherConnectionMonitor.md) -Remove connection monitor. - -### [Remove-AzureRmNetworkWatcherPacketCapture](Remove-AzureRmNetworkWatcherPacketCapture.md) -Removes a packet capture resource. - -### [Remove-AzureRmPublicIpAddress](Remove-AzureRmPublicIpAddress.md) -Removes a public IP address. - -### [Remove-AzureRmPublicIpPrefix](Remove-AzureRmPublicIpPrefix.md) -Removes a public IP prefix - -### [Remove-AzureRmRouteConfig](Remove-AzureRmRouteConfig.md) -Removes a route from a route table. - -### [Remove-AzureRmRouteFilter](Remove-AzureRmRouteFilter.md) -{{Fill in the Synopsis}} - -### [Remove-AzureRmRouteFilterRuleConfig](Remove-AzureRmRouteFilterRuleConfig.md) -{{Fill in the Synopsis}} - -### [Remove-AzureRmRouteTable](Remove-AzureRmRouteTable.md) -Removes a route table. - -### [Remove-AzureRmServiceEndpointPolicy](Remove-AzureRmServiceEndpointPolicy.md) -{{Fill in the Synopsis}} - -### [Remove-AzureRmServiceEndpointPolicyDefinition](Remove-AzureRmServiceEndpointPolicyDefinition.md) -{{Fill in the Synopsis}} - -### [Remove-AzureRmVirtualHub](Remove-AzureRmVirtualHub.md) -Removes an Azure VirtualHub resource. - -### [Remove-AzureRmVirtualHubVnetConnection](Remove-AzureRmVirtualHubVnetConnection.md) -The Remove-AzureRmVirtualHubVnetConnection cmdlet removes an Azure Virtual Network Connection which peers a remote VNET to the hub VNET. - -### [Remove-AzureRmVirtualNetwork](Remove-AzureRmVirtualNetwork.md) -Removes a virtual network. - -### [Remove-AzureRmVirtualNetworkGateway](Remove-AzureRmVirtualNetworkGateway.md) -Deletes a Virtual Network Gateway - -### [Remove-AzureRmVirtualNetworkGatewayConnection](Remove-AzureRmVirtualNetworkGatewayConnection.md) -Deletes a Virtual Network Gateway Connection - -### [Remove-AzureRmVirtualNetworkGatewayDefaultSite](Remove-AzureRmVirtualNetworkGatewayDefaultSite.md) -Removes the default site from a virtual network gateway. - -### [Remove-AzureRmVirtualNetworkGatewayIpConfig](Remove-AzureRmVirtualNetworkGatewayIpConfig.md) -Removes an IP Configuration from a Virtual Network Gateway - -### [Remove-AzureRmVirtualNetworkPeering](Remove-AzureRmVirtualNetworkPeering.md) -Removes a virtual network peering. - -### [Remove-AzureRmVirtualNetworkSubnetConfig](Remove-AzureRmVirtualNetworkSubnetConfig.md) -Removes a subnet configuration from a virtual network. - -### [Remove-AzureRmVirtualNetworkTap](Remove-AzureRmVirtualNetworkTap.md) -{{Fill in the Synopsis}} - -### [Remove-AzureRmVirtualWan](Remove-AzureRmVirtualWan.md) -Removes an Azure Virtual WAN. - -### [Remove-AzureRmVpnClientIpsecParameter](Remove-AzureRmVpnClientIpsecParameter.md) -Removes Vpn custom ipsec policy set on Virtual Network Gateway resource. - -### [Remove-AzureRmVpnClientRevokedCertificate](Remove-AzureRmVpnClientRevokedCertificate.md) -Removes a VPN client-revocation certificate. - -### [Remove-AzureRmVpnClientRootCertificate](Remove-AzureRmVpnClientRootCertificate.md) -Removes an existing VPN client root certificate. - -### [Remove-AzureRmVpnConnection](Remove-AzureRmVpnConnection.md) -Removes a VpnConnection. - -### [Remove-AzureRmVpnGateway](Remove-AzureRmVpnGateway.md) -The Remove-AzureRmVpnGateway cmdlet removes an Azure VPN gateway. This is a gateway specific to Azure Virtual WAN's software defined connectivity. - -### [Remove-AzureRmVpnSite](Remove-AzureRmVpnSite.md) -Removes an Azure VpnSite resource. - -### [Reset-AzureRmVirtualNetworkGateway](Reset-AzureRmVirtualNetworkGateway.md) -Resets the Virtual Network Gateway - -### [Reset-AzureRmVirtualNetworkGatewayConnectionSharedKey](Reset-AzureRmVirtualNetworkGatewayConnectionSharedKey.md) -Resets the shared key of the virtual network gateway connection. - -### [Resize-AzureRmVirtualNetworkGateway](Resize-AzureRmVirtualNetworkGateway.md) -Resizes an existing virtual network gateway. - -### [Set-AzureRmApplicationGateway](Set-AzureRmApplicationGateway.md) -Updates an application gateway. - -### [Set-AzureRmApplicationGatewayAuthenticationCertificate](Set-AzureRmApplicationGatewayAuthenticationCertificate.md) -Updates an authentication certificate for an application gateway. - -### [Set-AzureRmApplicationGatewayAutoscaleConfiguration](Set-AzureRmApplicationGatewayAutoscaleConfiguration.md) -Updates the autoscale configuration for an application gateway. - -### [Set-AzureRmApplicationGatewayBackendAddressPool](Set-AzureRmApplicationGatewayBackendAddressPool.md) -Updates a back-end address pool for an application gateway. - -### [Set-AzureRmApplicationGatewayBackendHttpSettings](Set-AzureRmApplicationGatewayBackendHttpSettings.md) -Updates back-end HTTP settings for an application gateway. - -### [Set-AzureRmApplicationGatewayConnectionDraining](Set-AzureRmApplicationGatewayConnectionDraining.md) -Modifies the connection draining configuration of a back-end HTTP settings object. - -### [Set-AzureRmApplicationGatewayFrontendIPConfig](Set-AzureRmApplicationGatewayFrontendIPConfig.md) -Modifies a front-end IP address configuration. - -### [Set-AzureRmApplicationGatewayFrontendPort](Set-AzureRmApplicationGatewayFrontendPort.md) -Modifies a front-end port for an application gateway. - -### [Set-AzureRmApplicationGatewayHttpListener](Set-AzureRmApplicationGatewayHttpListener.md) -Modifies an HTTP listener for an application gateway. - -### [Set-AzureRmApplicationGatewayIPConfiguration](Set-AzureRmApplicationGatewayIPConfiguration.md) -Modifies an IP configuration for an application gateway. - -### [Set-AzureRmApplicationGatewayProbeConfig](Set-AzureRmApplicationGatewayProbeConfig.md) -Sets the health probe configuration on an existing Application Gateway. - -### [Set-AzureRmApplicationGatewayRedirectConfiguration](Set-AzureRmApplicationGatewayRedirectConfiguration.md) -Sets the redirect configuration on an existing Application Gateway. - -### [Set-AzureRmApplicationGatewayRequestRoutingRule](Set-AzureRmApplicationGatewayRequestRoutingRule.md) -Modifies a request routing rule for an application gateway. - -### [Set-AzureRmApplicationGatewaySku](Set-AzureRmApplicationGatewaySku.md) -Modifies the SKU of an application gateway. - -### [Set-AzureRmApplicationGatewaySslCertificate](Set-AzureRmApplicationGatewaySslCertificate.md) -Sets the goal state of an SSL certificate. - -### [Set-AzureRmApplicationGatewaySslPolicy](Set-AzureRmApplicationGatewaySslPolicy.md) -Modifies the SSL policy of an application gateway. - -### [Set-AzureRmApplicationGatewayTrustedRootCertificate](Set-AzureRmApplicationGatewayTrustedRootCertificate.md) -Updates a Trusted Root Certificate for an application gateway. - -### [Set-AzureRmApplicationGatewayUrlPathMapConfig](Set-AzureRmApplicationGatewayUrlPathMapConfig.md) -Sets configuration for an array of URL path mappings to a backend server pool. - -### [Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration](Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md) -Modifies the WAF configuration of an application gateway. - -### [Set-AzureRmExpressRouteCircuit](Set-AzureRmExpressRouteCircuit.md) -Modifies an ExpressRoute circuit. - -### [Set-AzureRmExpressRouteCircuitPeeringConfig](Set-AzureRmExpressRouteCircuitPeeringConfig.md) -Saves a modified ExpressRoute peering configuration. - -### [Set-AzureRmFirewall](Set-AzureRmFirewall.md) -Saves a modified Firewall. - -### [Set-AzureRmExpressRoutePort](Set-AzureRmExpressRoutePort.md) -Saves a modified ExpressRoutePort - -### [Set-AzureRmLoadBalancer](Set-AzureRmLoadBalancer.md) -Sets the goal state for a load balancer. - -### [Set-AzureRmLoadBalancerFrontendIpConfig](Set-AzureRmLoadBalancerFrontendIpConfig.md) -Sets the goal state for a front-end IP configuration in a load balancer. - -### [Set-AzureRmLoadBalancerInboundNatPoolConfig](Set-AzureRmLoadBalancerInboundNatPoolConfig.md) - - -### [Set-AzureRmLoadBalancerInboundNatRuleConfig](Set-AzureRmLoadBalancerInboundNatRuleConfig.md) -Sets an inbound NAT rule configuration for a load balancer. - -### [Set-AzureRmLoadBalancerOutboundRuleConfig](Set-AzureRmLoadBalancerOutboundRuleConfig.md) -Sets an outbound rule configuration for a load balancer. - -### [Set-AzureRmLoadBalancerProbeConfig](Set-AzureRmLoadBalancerProbeConfig.md) -Sets the goal state for a probe configuration. - -### [Set-AzureRmLoadBalancerRuleConfig](Set-AzureRmLoadBalancerRuleConfig.md) -Sets the goal state for a load balancer rule configuration. - -### [Set-AzureRmLocalNetworkGateway](Set-AzureRmLocalNetworkGateway.md) -Modifies a local network gateway. - -### [Set-AzureRmNetworkInterface](Set-AzureRmNetworkInterface.md) -Sets the goal state for a network interface. - -### [Set-AzureRmNetworkInterfaceIpConfig](Set-AzureRmNetworkInterfaceIpConfig.md) -Sets the goal state for an Azure network interface IP configuration. - -### [Set-AzureRmNetworkProfile](Set-AzureRmNetworkProfile.md) -Sets the goal state for an existing network profile - -### [Set-AzureRmNetworkInterfaceTapConfig](Set-AzureRmNetworkInterfaceTapConfig.md) -{{Fill in the Synopsis}} - -### [Set-AzureRmNetworkSecurityGroup](Set-AzureRmNetworkSecurityGroup.md) -Sets the goal state for a network security group. - -### [Set-AzureRmNetworkSecurityRuleConfig](Set-AzureRmNetworkSecurityRuleConfig.md) -Sets the goal state for a network security rule configuration. - -### [Set-AzureRmNetworkWatcherConfigFlowLog](Set-AzureRmNetworkWatcherConfigFlowLog.md) -Configures flow logging for a target resource. - -### [Set-AzureRmNetworkWatcherConnectionMonitor](Set-AzureRmNetworkWatcherConnectionMonitor.md) -Update a connection monitor. - -### [Set-AzureRmPublicIpAddress](Set-AzureRmPublicIpAddress.md) -Sets the goal state for a public IP address. - -### [Set-AzureRmPublicIpPrefix](Set-AzureRmPublicIpPrefix.md) -Sets the Tags for an existing PublicIpPrefix - -### [Set-AzureRmRouteConfig](Set-AzureRmRouteConfig.md) -Sets the goal state for a route. - -### [Set-AzureRmRouteFilter](Set-AzureRmRouteFilter.md) -{{Fill in the Synopsis}} - -### [Set-AzureRmRouteFilterRuleConfig](Set-AzureRmRouteFilterRuleConfig.md) -{{Fill in the Synopsis}} - -### [Set-AzureRmRouteTable](Set-AzureRmRouteTable.md) -Sets the goal state for a route table. - -### [Set-AzureRmServiceEndpointPolicy](Set-AzureRmServiceEndpointPolicy.md) -{{Fill in the Synopsis}} - -### [Set-AzureRmServiceEndpointPolicyDefinition](Set-AzureRmServiceEndpointPolicyDefinition.md) -{{Fill in the Synopsis}} - -### [Set-AzureRmVirtualNetwork](Set-AzureRmVirtualNetwork.md) -Sets the goal state for a virtual network. - -### [Set-AzureRmVirtualNetworkGateway](Set-AzureRmVirtualNetworkGateway.md) -Updates a virtual network gateway. - -### [Set-AzureRmVirtualNetworkGatewayConnection](Set-AzureRmVirtualNetworkGatewayConnection.md) -Configures a virtual network gateway connection. - -### [Set-AzureRmVirtualNetworkGatewayConnectionSharedKey](Set-AzureRmVirtualNetworkGatewayConnectionSharedKey.md) -Configures the shared key of the virtual network gateway connection. - -### [Set-AzureRmVirtualNetworkGatewayDefaultSite](Set-AzureRmVirtualNetworkGatewayDefaultSite.md) -Sets the default site for a virtual network gateway. - -### [Set-AzureRmVirtualNetworkGatewayVpnClientConfig](Set-AzureRmVirtualNetworkGatewayVpnClientConfig.md) -Sets the VPN client address pool for a virtual network gateway. - -### [Set-AzureRmVirtualNetworkPeering](Set-AzureRmVirtualNetworkPeering.md) -Configures a virtual network peering. - -### [Set-AzureRmVirtualNetworkSubnetConfig](Set-AzureRmVirtualNetworkSubnetConfig.md) -Configures the goal state for a subnet configuration in a virtual network. - -### [Set-AzureRmVirtualNetworkTap](Set-AzureRmVirtualNetworkTap.md) -{{Fill in the Synopsis}} - -### [Set-AzureRmVpnClientIpsecParameter](Set-AzureRmVpnClientIpsecParameter.md) -Sets the vpn ipsec parameters for existing virtual network gateway. - -### [Start-AzureRmApplicationGateway](Start-AzureRmApplicationGateway.md) -Starts an application gateway. - -### [Start-AzureRmNetworkWatcherConnectionMonitor](Start-AzureRmNetworkWatcherConnectionMonitor.md) -Start a connection monitor - -### [Start-AzureRmNetworkWatcherResourceTroubleshooting](Start-AzureRmNetworkWatcherResourceTroubleshooting.md) -Starts troubleshooting on a Networking resource in Azure. - -### [Stop-AzureRmApplicationGateway](Stop-AzureRmApplicationGateway.md) -Stops an application gateway - -### [Stop-AzureRmNetworkWatcherConnectionMonitor](Stop-AzureRmNetworkWatcherConnectionMonitor.md) -Stop a connection monitor - -### [Stop-AzureRmNetworkWatcherPacketCapture](Stop-AzureRmNetworkWatcherPacketCapture.md) -Stops a running packet capture session - -### [Test-AzureRmDnsAvailability](Test-AzureRmDnsAvailability.md) -Checks whether a domain name in the cloudapp.azure.com zone is available for use. - -### [Test-AzureRmNetworkWatcherConnectivity](Test-AzureRmNetworkWatcherConnectivity.md) -Returns connectivity information for a specified source VM and a destination. - -### [Test-AzureRmNetworkWatcherIPFlow](Test-AzureRmNetworkWatcherIPFlow.md) -Returns whether the packet is allowed or denied to or from a particular destination. - -### [Test-AzureRmPrivateIPAddressAvailability](Test-AzureRmPrivateIPAddressAvailability.md) -Test availability of a private IP address in a virtual network. - -### [Update-AzureRmVirtualHub](Update-AzureRmVirtualHub.md) -Updates a Virtual Hub to an intended goal state. - -### [Update-AzureRmVirtualWan](Update-AzureRmVirtualWan.md) -Updates an Azure Virtual WAN. - -### [Update-AzureRmVpnConnection](Update-AzureRmVpnConnection.md) -Updates a VpnConnection object to a goal state. - -### [Update-AzureRmVpnGateway](Update-AzureRmVpnGateway.md) -Update-AzureRmVpnGateway updates a scalable VPN Gateway to the appropriate goal state. - -### [Update-AzureRmVpnSite](Update-AzureRmVpnSite.md) -Updates a VpnSite representing a customer branch to an intended goal state. - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRMNetworkWatcherReachabilityReport.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRMNetworkWatcherReachabilityReport.md deleted file mode 100644 index 25c6651661..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRMNetworkWatcherReachabilityReport.md +++ /dev/null @@ -1,376 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermnetworkwatcherreachabilityreport -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRMNetworkWatcherReachabilityReport.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRMNetworkWatcherReachabilityReport.md ---- - -# Get-AzureRMNetworkWatcherReachabilityReport - -## SYNOPSIS -Gets the relative latency score for internet service providers from a specified location to Azure regions. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByName (Default) -``` -Get-AzureRMNetworkWatcherReachabilityReport -NetworkWatcherName <String> -ResourceGroupName <String> - [-Provider <System.Collections.Generic.List`1[System.String]>] - [-Location <System.Collections.Generic.List`1[System.String]>] -StartTime <DateTime> -EndTime <DateTime> - [-Country <String>] [-State <String>] [-City <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### SetByResource -``` -Get-AzureRMNetworkWatcherReachabilityReport -NetworkWatcher <PSNetworkWatcher> - [-Provider <System.Collections.Generic.List`1[System.String]>] - [-Location <System.Collections.Generic.List`1[System.String]>] -StartTime <DateTime> -EndTime <DateTime> - [-Country <String>] [-State <String>] [-City <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### SetByResourceId -``` -Get-AzureRMNetworkWatcherReachabilityReport -ResourceId <String> - [-Provider <System.Collections.Generic.List`1[System.String]>] - [-Location <System.Collections.Generic.List`1[System.String]>] -StartTime <DateTime> -EndTime <DateTime> - [-Country <String>] [-State <String>] [-City <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### SetByLocation -``` -Get-AzureRMNetworkWatcherReachabilityReport -NetworkWatcherLocation <String> - [-Provider <System.Collections.Generic.List`1[System.String]>] - [-Location <System.Collections.Generic.List`1[System.String]>] -StartTime <DateTime> -EndTime <DateTime> - [-Country <String>] [-State <String>] [-City <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmNetworkWatcherReachabilityReport gets the relative latency score for internet service providers from a specified location to Azure regions. - -## EXAMPLES - -### Example 1 -``` -$nw = Get-AzureRmNetworkWatcher -Name NetworkWatcher -ResourceGroupName NetworkWatcherRG -Get-AzureRmNetworkWatcherReachabilityReport -NetworkWatcher $nw -Location "West US" -Country "United States" -StartTime "2017-10-10" -EndTime "2017-10-12" - -"aggregationLevel" : "Country", -"providerLocation" : { - "country" : "United States" -}, -"reachabilityReport" : [ - { - "provider" : "Frontier Communications of America, Inc. - ASN 5650", - "azureLocation": "West US", - "latencies": [ - { - "timeStamp": "2017-10-10T00:00:00Z", - "score": 94 - }, - { - "timeStamp": "2017-10-11T00:00:00Z", - "score": 94 - }, - { - "timeStamp": "2017-10-12T00:00:00Z", - "score": 94 - } - ] - } -] -``` - -Gets relative latencies to Azure Data Center in West US from 2017-10-10 to 2017-10-12 inside United State. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -City -The name of the city. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Country -The name of the country. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndTime -The end time for the Azure reachability report. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Optional Azure regions to scope the query to. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherLocation -Location of the network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByLocation -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: ResourceName, Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Provider -List of Internet service providers. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The Id of network watcher resource. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartTime -The start time for the Azure reachability report. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -State -The name of the state. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameters: NetworkWatcher (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSAzureReachabilityReport - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, reachability, report - -## RELATED LINKS - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmNetworkWatcherProtocolConfiguration](./New-AzureRmNetworkWatcherProtocolConfiguration.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Test-AzureRmNetworkWatcherConnectivity](./Test-AzureRmNetworkWatcherConnectivity.md) - -[Stop-AzureRmNetworkWatcherConnectionMonitor](./Stop-AzureRmNetworkWatcherConnectionMonitor.md) - -[Start-AzureRmNetworkWatcherConnectionMonitor](./Start-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConnectionMonitor](./Set-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConfigFlowLog](./Set-AzureRmNetworkWatcherConfigFlowLog.md) - -[Remove-AzureRmNetworkWatcherConnectionMonitor](./Remove-AzureRmNetworkWatcherConnectionMonitor.md) - -[New-AzureRmNetworkWatcherConnectionMonitor](./New-AzureRmNetworkWatcherConnectionMonitor.md) - -[Get-AzureRmNetworkWatcherTroubleshootingResult](./Get-AzureRmNetworkWatcherTroubleshootingResult.md) - -[Get-AzureRMNetworkWatcherReachabilityReport](./Get-AzureRMNetworkWatcherReachabilityReport.md) - -[Get-AzureRmNetworkWatcherReachabilityProvidersList](./Get-AzureRmNetworkWatcherReachabilityProvidersList.md) - -[Get-AzureRmNetworkWatcherFlowLogStatus](./Get-AzureRmNetworkWatcherFlowLogStatus.md) - -[Get-AzureRmNetworkWatcherConnectionMonitorReport](./Get-AzureRmNetworkWatcherConnectionMonitorReport.md) - -[Get-AzureRmNetworkWatcherConnectionMonitor](./Get-AzureRmNetworkWatcherConnectionMonitor.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGateway.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGateway.md deleted file mode 100644 index 4e0542cd5f..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGateway.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 77CDEE77-FD5D-4C2D-B027-FF1F6FF6618E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgateway -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGateway.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGateway.md ---- - -# Get-AzureRmApplicationGateway - -## SYNOPSIS -Gets an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGateway [-Name <String>] [-ResourceGroupName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGateway** cmdlet gets an application gateway. - -## EXAMPLES - -### Example 1: Get a specified application gateway -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -``` - -This command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $AppGw variable. - -### Example 2: Get a list of application gateways in a resource group -``` -PS C:\>$AppGwList = Get-AzureRmApplicationGateway -ResourceGroupName "ResourceGroup01" -``` - -This command gets a list of all the application gateways in the resource group named ResourceGroup01 and stores it in the $AppGwList variable. - -### Example 3: Get a list of application gateways in a subscription -``` -PS C:\>$AppGwList = Get-AzureRmApplicationGateway -``` - -This command gets a list of all the application gateways in the subscription and stores it in the $AppGwList variable. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the application gateway that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the application gateway. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Stop-AzureRmApplicationGateway](./Stop-AzureRmApplicationGateway.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayAuthenticationCertificate.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayAuthenticationCertificate.md deleted file mode 100644 index 8b5bfe09f4..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayAuthenticationCertificate.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 706C918B-1D1A-476C-BB74-EBB4EE72AC0C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewayauthenticationcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayAuthenticationCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayAuthenticationCertificate.md ---- - -# Get-AzureRmApplicationGatewayAuthenticationCertificate - -## SYNOPSIS -Gets an authentication certificate for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayAuthenticationCertificate [-Name <String>] - -ApplicationGateway <PSApplicationGateway> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewayAuthenticationCertificate** cmdlet gets an authentication certificate for an Azure application gateway. - -## EXAMPLES - -## PARAMETERS - -### -ApplicationGateway -Specifies the name of application gateway for which this cmdlet gets an authentication certificate. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the authentication certificate that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayAuthenticationCertificate](./Add-AzureRmApplicationGatewayAuthenticationCertificate.md) - -[New-AzureRmApplicationGatewayAuthenticationCertificate](./New-AzureRmApplicationGatewayAuthenticationCertificate.md) - -[Remove-AzureRmApplicationGatewayAuthenticationCertificate](./Remove-AzureRmApplicationGatewayAuthenticationCertificate.md) - -[Set-AzureRmApplicationGatewayAuthenticationCertificate](./Set-AzureRmApplicationGatewayAuthenticationCertificate.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayAutoscaleConfiguration.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayAutoscaleConfiguration.md deleted file mode 100644 index 115bfb2dfb..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayAutoscaleConfiguration.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewayautoscaleconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayAutoscaleConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayAutoscaleConfiguration.md ---- - -# Get-AzureRmApplicationGatewayAutoscaleConfiguration - -## SYNOPSIS -Gets the Autoscale Configuration of the Application Gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayAutoscaleConfiguration -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewayAutoscaleConfiguration** cmdlet gets Autoscale Configuration of the Application Gateway. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> $gw = Get-AzureRmApplicationGateway -Name $appgwName -ResourceGroupName $resgpName -PS C:\> $autoscaleConfiguration = Get-AzureRmApplicationGatewayAutoscaleConfiguration -ApplicationGateway $gw -PS C:\> $autoscaleConfiguration.MinCapacity -``` - -The first command gets the application gateway and stores it in $gw variable. -The second command extracts out the autoscale configuration from the applicationg gateway. - -## PARAMETERS - -### -ApplicationGateway -The applicationGateway - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAutoscaleConfiguration - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayAvailableSslOptions.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayAvailableSslOptions.md deleted file mode 100644 index 4e9db97c19..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayAvailableSslOptions.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewayavailablessloptions -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayAvailableSslOptions.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayAvailableSslOptions.md ---- - -# Get-AzureRmApplicationGatewayAvailableSslOptions - -## SYNOPSIS -Gets all available ssl options for ssl policy for Application Gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayAvailableSslOptions [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewayAvailableSslOptions** cmdlet gets all available ssl options for ssl policy - -## EXAMPLES - -### Example 1 -``` -PS C:\>$sslOptions = Get-AzureRmApplicationGatewayAvailableSslOptions -``` - -This commands returns all available ssl options for ssl policy. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAvailableSslOptions - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayAvailableWafRuleSets.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayAvailableWafRuleSets.md deleted file mode 100644 index 63ce149a34..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayAvailableWafRuleSets.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewayavailablewafrulesets -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayAvailableWafRuleSets.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayAvailableWafRuleSets.md ---- - -# Get-AzureRmApplicationGatewayAvailableWafRuleSets - -## SYNOPSIS -Gets all available web application firewall rule sets. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayAvailableWafRuleSets [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewayAvailableWafRuleSets** cmdlet gets all available web application firewall rule sets. - -## EXAMPLES - -### Example 1 -``` -PS C:\>$availableRuleSets = Get-AzureRmApplicationGatewayAvailableWafRuleSets -``` - -This commands returns all the available web application firewall rule sets. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAvailableWafRuleSetsResult - -## NOTES -**List-AzureRmApplicationGatewayAvailableWafRuleSets** is an alias for the **Get-AzureRmApplicationGatewayAvailableWafRuleSets** cmdlet. - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayBackendAddressPool.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayBackendAddressPool.md deleted file mode 100644 index 645d4f1932..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayBackendAddressPool.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 4B2066B6-51D7-46D8-8A72-1A232B3E6589 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewaybackendaddresspool -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayBackendAddressPool.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayBackendAddressPool.md ---- - -# Get-AzureRmApplicationGatewayBackendAddressPool - -## SYNOPSIS -Gets a back-end address pool for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayBackendAddressPool [-Name <String>] -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION - -## EXAMPLES - -### Example 1: Get a specified back-end server pool -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $BackendPool = Get-AzureRmApplicationGatewayBackendAddressPool -Name "Pool01" -ApplicationGateway $AppGw -``` - -The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01 and stores it in the $AppGw variable. -The second command gets the back-end address pool associated with $AppGw named Pool01 and stores it in the $BackendPool variable. - -### Example 2: Get a list of back-end server pool -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $BackendPools = Get-AzureRmApplicationGatewayBackendAddressPool -ApplicationGateway $AppGw -``` - -The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01 and stores it in the $AppGw variable. -The second command gets a list of the back-end address pools associated with $AppGw, and stores the list in the $BackendPools variable. - -## PARAMETERS - -### -ApplicationGateway -The **Get-AzureRmApplicationGatewayBackendAddressPool** cmdlet gets a back-end address pool for an application gateway. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the back-end address pool that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayBackendAddressPool](./Add-AzureRmApplicationGatewayBackendAddressPool.md) - -[New-AzureRmApplicationGatewayBackendAddressPool](./New-AzureRmApplicationGatewayBackendAddressPool.md) - -[Remove-AzureRmApplicationGatewayBackendAddressPool](./Remove-AzureRmApplicationGatewayBackendAddressPool.md) - -[Set-AzureRmApplicationGatewayBackendAddressPool](./Set-AzureRmApplicationGatewayBackendAddressPool.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayBackendHealth.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayBackendHealth.md deleted file mode 100644 index 65743cbed7..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayBackendHealth.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: D5E928C3-26B6-4B7C-8A9C-F1F602BABF75 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewaybackendhealth -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayBackendHealth.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayBackendHealth.md ---- - -# Get-AzureRmApplicationGatewayBackendHealth - -## SYNOPSIS -Gets application gateway backend health. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayBackendHealth -Name <String> -ResourceGroupName <String> - [-ExpandResource <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmApplicationGatewayBackendHealth cmdlet gets application gateway backend health. - -## EXAMPLES - -### Example 1: Gets backend health without expanded resources. -``` -PS C:\>$BackendHealth = Get-AzureRmApplicationGatewayBackendHealth -Name ApplicationGateway01 -ResourceGroupName ResourceGroup01 -``` - -This command gets the backend health of application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $BackendHealth variable. - -### Example 1: Gets backend health with expanded resources. -``` -PS C:\>$BackendHealth = Get-AzureRmApplicationGatewayBackendHealth -Name ApplicationGateway01 -ResourceGroupName ResourceGroup01 -ExpandResource "backendhealth/applicationgatewayresource" -``` - -This command gets the backend health (with expanded resources) of application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $BackendHealth variable. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpandResource -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the application gateway that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the application gateway. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHealth - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Get-AzureRmApplicationGateway](./Get-AzureRmApplicationGateway.md) - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayBackendHttpSettings.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayBackendHttpSettings.md deleted file mode 100644 index 1be8ac9ffe..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayBackendHttpSettings.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewaybackendhttpsettings -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayBackendHttpSettings.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayBackendHttpSettings.md ---- - -# Get-AzureRmApplicationGatewayBackendHttpSettings - -## SYNOPSIS -Gets the back-end HTTP settings of an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayBackendHttpSettings [-Name <String>] -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmApplicationGatewayBackendHttpSettings cmdlet gets the back-end HTTP settings of an application gateway. - -## EXAMPLES - -### Example 1: Get back-end HTTP settings by name -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Settings = Get-AzureRmApplicationGatewayBackendHttpSettings -Name "Settings01" -ApplicationGateway $AppGw -``` - -The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01, and stores it in the $AppGw variable.The second command gets the HTTP settings named Settings01 for $AppGw and stores the settings in the $Settings variable. - -### Example 2: Get a collection of back-end HTTP settings -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $SettingsList = Get-AzureRmApplicationGatewayBackendHttpSettings -ApplicationGateway $AppGw -``` - -The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01, and stores it in the $AppGw variable.The second command gets the collection of HTTP settings for $AppGw and stores the settings in the $SettingsList variable. - -## PARAMETERS - -### -ApplicationGateway -Specifies an application gateway object that contains back-end HTTP settings. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the backend HTTP settings that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayBackendHttpSettings]() - -[New-AzureRmApplicationGatewayBackendHttpSettings]() - -[Remove-AzureRmApplicationGatewayBackendHttpSettings]() - -[Set-AzureRmApplicationGatewayBackendHttpSettings]() - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayConnectionDraining.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayConnectionDraining.md deleted file mode 100644 index b351509309..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayConnectionDraining.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewayconnectiondraining -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayConnectionDraining.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayConnectionDraining.md ---- - -# Get-AzureRmApplicationGatewayConnectionDraining - -## SYNOPSIS -Gets the connection draining configuration of a back-end HTTP settings object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayConnectionDraining -BackendHttpSettings <PSApplicationGatewayBackendHttpSettings> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewayConnectionDraining** cmdlet gets the connection draining configuration of a back-end HTTP settings object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Settings = Get-AzureRmApplicationGatewayBackendHttpSettings -Name "Settings01" -ApplicationGateway $AppGw -PS C:\> $ConnectionDraining = Get-AzureRmApplicationGatewayConnectionDraining -BackendHttpSettings $Settings -``` - -The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01 and stores it in the $AppGw variable. -The second command gets the back-end HTTP settings named Settings01 for $AppGw and stores the settings in the $Settings variable. -The last command gets the connection draining configuration from the back-end HTTP settings $Settings and stores it in the $ConnectionDraining variable. - -## PARAMETERS - -### -BackendHttpSettings -The backend http settings - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings -Parameters: BackendHttpSettings (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayConnectionDraining - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGateway](./Get-AzureRmApplicationGateway.md) - -[Get-AzureRmApplicationGatewayBackendHttpSettings](./Get-AzureRmApplicationGatewayBackendHttpSettings.md) - -[New-AzureRmApplicationGatewayConnectionDraining](./New-AzureRmApplicationGatewayConnectionDraining.md) - -[Remove-AzureRmApplicationGatewayConnectionDraining](./Remove-AzureRmApplicationGatewayConnectionDraining.md) - -[Set-AzureRmApplicationGatewayConnectionDraining](./Set-AzureRmApplicationGatewayConnectionDraining.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayCustomError.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayCustomError.md deleted file mode 100644 index ed66d328bf..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayCustomError.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewaycustomerror -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayCustomError.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayCustomError.md ---- - -# Get-AzureRmApplicationGatewayCustomError - -## SYNOPSIS -Gets custom error(s) from an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayCustomError [-StatusCode <String>] -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewayCustomError** cmdlet gets custom error(s) from an application gateway. - -## EXAMPLES - -### Example 1: Gets a custom error in an application gateway -```powershell -PS C:\> $ce = Get-AzureRmApplicationGatewayCustomError -ApplicationGateway $appgw -StatusCode HttpStatus502 -``` - -This command gets and returns the custom error of http status code 502 from the application gateway $appgw. - -### Example 2: Gets the list of all custom errors in an application gateway -```powershell -PS C:\> $ces = Get-AzureRmApplicationGatewayCustomError -ApplicationGateway $appgw -``` - -This command gets and returns the list of all custom errors from the application gateway $appgw. - -## PARAMETERS - -### -ApplicationGateway -The Application Gateway - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StatusCode -Status code of the application gateway customer error. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayCustomError - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayFrontendIPConfig.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayFrontendIPConfig.md deleted file mode 100644 index 456a28b218..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayFrontendIPConfig.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 364C41D0-A5DB-4AEF-853A-FE5A11AD9155 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewayfrontendipconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayFrontendIPConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayFrontendIPConfig.md ---- - -# Get-AzureRmApplicationGatewayFrontendIPConfig - -## SYNOPSIS -Gets the front-end IP configuration of an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayFrontendIPConfig [-Name <String>] -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewayFrontendIPConfig** cmdlet gets the front-end IP configuration of an application gateway. - -## EXAMPLES - -### Example 1: Get a specified front-end IP configuration -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $FrontEndIP= Get-AzureRmApplicationGatewayFrontendIPConfig -Name "FrontEndIP01" -ApplicationGateway $AppGw -``` - -The first command gets an application gateway named ApplicationGateway01 from the resource group named ResourceGroup01, and stores it in the $AppGw variable.The second command gets the front-end IP configuration named FrontEndIP01 from $AppGw and stores it in the $FrontEndIP variable. - -### Example 2: Get a list of front-end IP configurations -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $FrontEndIPs= Get-AzureRmApplicationGatewayFrontendIPConfig -ApplicationGateway $AppGw -``` - -The first command gets an application gateway named ApplicationGateway01 from the resource group named ResourceGroup01, and stores it in the $AppGw variable.The second command gets a list of the front-end IP configurations from $AppGw and stores it in the $FrontEndIPs variable. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway object that contains the front-end IP configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the front-end IP configuration that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendIPConfiguration - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayFrontendIPConfig](./Add-AzureRmApplicationGatewayFrontendIPConfig.md) - -[New-AzureRmApplicationGatewayFrontendIPConfig](./New-AzureRmApplicationGatewayFrontendIPConfig.md) - -[Remove-AzureRmApplicationGatewayFrontendIPConfig](./Remove-AzureRmApplicationGatewayFrontendIPConfig.md) - -[Set-AzureRmApplicationGatewayFrontendIPConfig](./Set-AzureRmApplicationGatewayFrontendIPConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayFrontendPort.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayFrontendPort.md deleted file mode 100644 index bc3c16dbd7..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayFrontendPort.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 4518D2A9-7DE7-4617-86E0-7778B8CFE48C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewayfrontendport -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayFrontendPort.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayFrontendPort.md ---- - -# Get-AzureRmApplicationGatewayFrontendPort - -## SYNOPSIS -Gets the front-end port of an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayFrontendPort [-Name <String>] -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewayFrontendPort** cmdlet gets the front-end port of an application gateway. - -## EXAMPLES - -### Example 1: Get a specified front-end port -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $FrontEndPort = Get-AzureRmApplicationGatewayFrontendPort -Name "FrontEndPort01" -ApplicationGateway $AppGw -``` - -The first command gets an application gateway named ApplicationGateway01 from the resource group named ResourceGroup01, and stores it in the $AppGw variable. -The second command gets the front-end port named FrontEndPort01 from $AppGw and stores it in the $FrontEndPort variable. - -### Example 2: Get a list of front-end ports -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $FrontEndPorts = Get-AzureRmApplicationGatewayFrontendPort -ApplicationGateway $AppGw -``` - -The first command gets an application gateway named ApplicationGateway01 from the resource group named ResourceGroup01, and stores it in the $AppGw variable. -The second command gets a list of the front-end ports from $AppGw and stores it in the $FrontEndPorts variable. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway object that contains the front-end port. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the front-end port to get. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendPort - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayFrontendPort](./Add-AzureRmApplicationGatewayFrontendPort.md) - -[New-AzureRmApplicationGatewayFrontendPort](./New-AzureRmApplicationGatewayFrontendPort.md) - -[Remove-AzureRmApplicationGatewayFrontendPort](./Remove-AzureRmApplicationGatewayFrontendPort.md) - -[Set-AzureRmApplicationGatewayFrontendPort](./Set-AzureRmApplicationGatewayFrontendPort.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayHttpListener.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayHttpListener.md deleted file mode 100644 index b594436c59..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayHttpListener.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 8D41EDAC-17D9-494B-8336-67906F4E1E81 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewayhttplistener -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayHttpListener.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayHttpListener.md ---- - -# Get-AzureRmApplicationGatewayHttpListener - -## SYNOPSIS -Gets the HTTP listener of an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayHttpListener [-Name <String>] -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewayHttpListener** cmdlet gets the HTTP listener of an application gateway. - -## EXAMPLES - -### Example 1: Get a specific HTTP listener -``` -PS C:\>$Appgw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Listener = Get-AzureRmApplicationGatewayHttpListener -Name "Listener01" -ApplicationGateway $Appgw -``` - -This command gets an HTTP listener named Listener01. - -### Example 2: Get a list of HTTP listeners -``` -PS C:\>$Appgw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Listeners = Get-AzureRmApplicationGatewayHttpListener -ApplicationGateway $Appgw -``` - -This command gets a list of HTTP listeners. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway object that contains the HTTP listener. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the HTTP listener which this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayHttpListener](./Add-AzureRmApplicationGatewayHttpListener.md) - -[New-AzureRmApplicationGatewayHttpListener](./New-AzureRmApplicationGatewayHttpListener.md) - -[Remove-AzureRmApplicationGatewayHttpListener](./Remove-AzureRmApplicationGatewayHttpListener.md) - -[Set-AzureRmApplicationGatewayHttpListener](./Set-AzureRmApplicationGatewayHttpListener.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayHttpListenerCustomError.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayHttpListenerCustomError.md deleted file mode 100644 index 49d1edc4a6..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayHttpListenerCustomError.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewayhttplistenercustomerror -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayHttpListenerCustomError.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayHttpListenerCustomError.md ---- - -# Get-AzureRmApplicationGatewayHttpListenerCustomError - -## SYNOPSIS -Gets custom error(s) from a http listener of an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayHttpListenerCustomError [-StatusCode <String>] - -HttpListener <PSApplicationGatewayHttpListener> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewayCustomError** cmdlet gets custom error(s) from a http listener of an application gateway. - -## EXAMPLES - -### Example 1: Gets a custom error in a http listener -```powershell -PS C:\> $ce = Get-AzureRmApplicationGatewayCustomError -HttpListener $listener01 -StatusCode HttpStatus502 -``` - -This command gets and returns the custom error of http status code 502 from the http listener $listener01. - -### Example 2: Gets the list of all custom errors in a http listener -```powershell -PS C:\> $ces = Get-AzureRmApplicationGatewayCustomError -HttpListener $listener01 -``` - -This command gets and returns the list of all custom errors from the http listener $listener01. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpListener -The Application Gateway Http Listener - -```yaml -Type: PSApplicationGatewayHttpListener -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -StatusCode -Status code of the application gateway customer error. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayCustomError - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayIPConfiguration.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayIPConfiguration.md deleted file mode 100644 index f3265c16e1..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayIPConfiguration.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 35562212-283C-4BB2-8B12-C3617A6760D0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewayipconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayIPConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayIPConfiguration.md ---- - -# Get-AzureRmApplicationGatewayIPConfiguration - -## SYNOPSIS -Gets the IP configuration of an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayIPConfiguration [-Name <String>] -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewayIPConfiguration** cmdlet gets the IP configuration of an application gateway. -The IP configuration contains the subnet in which the application gateway is deployed. - -## EXAMPLES - -### Example 1: Get a specific IP configuration -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $GatewaySubnet = Get-AzureRmApplicationGatewayIPConfiguration -Name "GatewaySubnet01" -ApplicationGateway $AppGw -``` - -The first command gets an application gateway and stores it in the $AppGw variable.The second command gets an IP configuration named GateSubnet01 from the gateway stored in $AppGw. - -### Example 2: Get a list of IP configurations -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $GatewaySubnets = Get-AzureRmApplicationGatewayIPConfiguration -ApplicationGateway $AppGw -``` - -The first command gets an application gateway and stores it in the $AppGw variable.The second command gets a list of all IP configurations. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway object that contains IP configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the IP configuration which this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayIPConfiguration - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayIPConfiguration](./Add-AzureRmApplicationGatewayIPConfiguration.md) - -[New-AzureRmApplicationGatewayIPConfiguration](./New-AzureRmApplicationGatewayIPConfiguration.md) - -[Remove-AzureRmApplicationGatewayIPConfiguration](./Remove-AzureRmApplicationGatewayIPConfiguration.md) - -[Set-AzureRmApplicationGatewayIPConfiguration](./Set-AzureRmApplicationGatewayIPConfiguration.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayProbeConfig.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayProbeConfig.md deleted file mode 100644 index 268b265fad..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayProbeConfig.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewayprobeconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayProbeConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayProbeConfig.md ---- - -# Get-AzureRmApplicationGatewayProbeConfig - -## SYNOPSIS -Gets an existing health probe configuration from an Application Gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayProbeConfig [-Name <String>] -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmApplicationGatewayProbeConfig cmdlet gets an existing health probe configuration from an Application Gateway. - -## EXAMPLES - -### Example 1: Get an existing probe from an application gateway -``` -PS C:\>Get-AzureRmApplicationGatewayProbeConfig -ApplicationGateway Gateway -Name "Probe02" -``` - -This command gets the health probe named Probe02 from the application gateway named Gateway. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway to which this cmdlet gets a probe configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the probe. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayProbe - -## NOTES - -## RELATED LINKS - -[Add a probe to an existing application gateway](https://azure.microsoft.com/en-us/documentation/articles/application-gateway-create-probe-ps/#add-a-probe-to-an-existing-application-gateway) - -[Add-AzureRmApplicationGatewayProbeConfig]() - -[New-AzureRmApplicationGatewayProbeConfig]() - -[Remove-AzureRmApplicationGatewayProbeConfig]() - -[Set-AzureRmApplicationGatewayProbeConfig]() - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayRedirectConfiguration.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayRedirectConfiguration.md deleted file mode 100644 index 4bb47d3d55..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayRedirectConfiguration.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewayredirectconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayRedirectConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayRedirectConfiguration.md ---- - -# Get-AzureRmApplicationGatewayRedirectConfiguration - -## SYNOPSIS -Gets an existing redirect configuration from an Application Gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayRedirectConfiguration [-Name <String>] -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewayRedirectConfiguration** cmdlet gets an existing redirect configuration from an Application Gateway. - -## EXAMPLES - -### Example 1 -``` -PS C:\>$AppGW = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $RedirectConfig = Get-AzureRmApplicationGatewayRedirectConfiguration -Name "Redirect01" -ApplicationGateway $AppGW -``` - -The first command gets the Application Gateway named ApplicationGateway01 and stores the result in the variable named $AppGW. -The second command gets the redirect configuration named Redirect01 from the Application Gateway stored in the variable named $AppGW. - -## PARAMETERS - -### -ApplicationGateway -The applicationGateway - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the request routing rule - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRedirectConfiguration - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayRequestRoutingRule.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayRequestRoutingRule.md deleted file mode 100644 index 9c8ae77312..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayRequestRoutingRule.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 57A6DB40-43EC-402C-9784-06817ECD99B8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewayrequestroutingrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayRequestRoutingRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayRequestRoutingRule.md ---- - -# Get-AzureRmApplicationGatewayRequestRoutingRule - -## SYNOPSIS -Gets the request routing rule of an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayRequestRoutingRule [-Name <String>] -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewayRequestRoutingRule** cmdlet gets the request routing rule of an application gateway. - -## EXAMPLES - -### Example 1: Get a specific request routing rule -``` -PS C:\>$AppGW = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Rule = Get-AzureRmApplicationGatewayRequestRoutingRule -"Rule01" -ApplicationGateway $AppGW -``` - -The first command gets the Application Gateway named ApplicationGateway01 and stores the result in the variable named $AppGW. -The second command gets the request routing rule named Rule01 from the Application Gateway stored in the variable named $AppGW. - -### Example 2: Get a list of request routing rules -``` -PS C:\>$AppGW = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Rules = Get-AzureRmApplicationGatewayRequestRoutingRule -ApplicationGateway $AppGW -``` - -The first command gets the Application Gateway named ApplicationGateway01 and stores the result in the variable named $AppGW. -The second command gets a list of request routing rules from the Application Gateway stored in the variable named $AppGW. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway object that contains request routing rule. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the request routing rule which this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRequestRoutingRule - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayRequestRoutingRule](./Add-AzureRmApplicationGatewayRequestRoutingRule.md) - -[New-AzureRmApplicationGatewayRequestRoutingRule](./New-AzureRmApplicationGatewayRequestRoutingRule.md) - -[Remove-AzureRmApplicationGatewayRequestRoutingRule](./Remove-AzureRmApplicationGatewayRequestRoutingRule.md) - -[Set-AzureRmApplicationGatewayRequestRoutingRule](./Set-AzureRmApplicationGatewayRequestRoutingRule.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewaySku.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewaySku.md deleted file mode 100644 index 041df4528d..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewaySku.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: F01CB88A-49E7-41D8-B4E7-F1A4DCDC6B84 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewaysku -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewaySku.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewaySku.md ---- - -# Get-AzureRmApplicationGatewaySku - -## SYNOPSIS -Gets the SKU of an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewaySku -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewaySku** cmdlet gets the stock keeping unit (SKU) of an application gateway. - -## EXAMPLES - -### Example 1: Get an application gateway SKU -``` -PS C:\>$AppGW = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $SKU = Get-AzureRmApplicationGatewaySku -ApplicationGateway $AppGW -``` - -The first command gets the Application Gateway named ApplicationGateway01 and stores the result in the variable named $AppGW. -The second command gets the SKU of an application gateway named ApplicationGateway01 and stores the result in the variable named $SKU. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway object. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySku - -## NOTES - -## RELATED LINKS - -[New-AzureRmApplicationGatewaySku](./New-AzureRmApplicationGatewaySku.md) - -[Set-AzureRmApplicationGatewaySku](./Set-AzureRmApplicationGatewaySku.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewaySslCertificate.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewaySslCertificate.md deleted file mode 100644 index 1addf9130d..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewaySslCertificate.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 919B3755-81D4-43FB-AE8C-B071329A61D9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewaysslcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewaySslCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewaySslCertificate.md ---- - -# Get-AzureRmApplicationGatewaySslCertificate - -## SYNOPSIS -Gets an SSL certificate for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewaySslCertificate [-Name <String>] -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewaySslCertificate** cmdlet gets an SSL certificate for an application gateway. - -## EXAMPLES - -### Example 1: Get a specific SSL certificate -``` -PS C:\>$AppGW = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Cert = Get-AzureRmApplicationGatewaySslCertificate -Name "Cert01" -ApplicationGateway $AppGW -``` - -The first command gets the Application Gateway named ApplicationGateway01 and stores the result in the variable named $AppGW. -The second command gets the SSL certificate named Cert01 from the application gateway stored in the variable named $AppGW. -The command stores the certificate in the variable named $Cert. - -### Example 2: Get a list of SSL certificates -``` -PS C:\>$AppGW = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Certs = Get-AzureRmApplicationGatewaySslCertificate -ApplicationGateway $AppGW -``` - -The first command gets the Application Gateway named ApplicationGateway01 and stores the result in the variable named $AppGW. -This second command gets a list of SSL certificates from the application gateway stored in the variable named $AppGW. -The command then stores the results in the variable named $Certs. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway object that contains the SSL certificate. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of SSL certificate pool that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslCertificate - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewaySslCertificate](./Add-AzureRmApplicationGatewaySslCertificate.md) - -[New-AzureRmApplicationGatewaySslCertificate](./New-AzureRmApplicationGatewaySslCertificate.md) - -[Remove-AzureRmApplicationGatewaySslCertificate](./Remove-AzureRmApplicationGatewaySslCertificate.md) - -[Set-AzureRmApplicationGatewaySslCertificate](./Set-AzureRmApplicationGatewaySslCertificate.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewaySslPolicy.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewaySslPolicy.md deleted file mode 100644 index 7570029a6f..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewaySslPolicy.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: AF02FFF8-F00D-4446-968F-F3C9008C39F0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewaysslpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewaySslPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewaySslPolicy.md ---- - -# Get-AzureRmApplicationGatewaySslPolicy - -## SYNOPSIS -Gets the SSL policy of an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewaySslPolicy -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewaySslPolicy** cmdlet gets the SSL policy of an application gateway. - -## EXAMPLES - -### 1: -``` -PS C:\>$AppGW = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $sslpolicy = Get-AzureRmApplicationGatewaySslPolicy -ApplicationGateway $AppGW -``` - -The first command gets the Application Gateway named ApplicationGateway01 and stores the result in the variable named $AppGW. -The second command gets the ssl policy from the Application Gateway stored in the variable named $AppGW. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway of the SSL policy that this cmdlet gets. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslPolicy - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[New-AzureRmApplicationGatewaySslPolicy](./New-AzureRmApplicationGatewaySslPolicy.md) - -[Set-AzureRmApplicationGatewaySslPolicy](./Set-AzureRmApplicationGatewaySslPolicy.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewaySslPredefinedPolicy.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewaySslPredefinedPolicy.md deleted file mode 100644 index 5eea8da2b3..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewaySslPredefinedPolicy.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewaysslpredefinedpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewaySslPredefinedPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewaySslPredefinedPolicy.md ---- - -# Get-AzureRmApplicationGatewaySslPredefinedPolicy - -## SYNOPSIS -Gets Predefined SSL Policies provided by Application Gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewaySslPredefinedPolicy [-Name <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewaySslPredefinedPolicy** cmdlet gets Predefined SSL Policies provided by Application Gateway. - -## EXAMPLES - -### Example 1 -``` -PS C:\>$policies = Get-AzureRmApplicationGatewaySslPredefinedPolicy -``` - -This commands returns all the predefined SSL policies. - -### Example 2 -``` -PS C:\>$policy = Get-AzureRmApplicationGatewaySslPredefinedPolicy -Name AppGwSslPolicy20170401 -``` - -This commands returns predefined policy with name AppGwSslPolicy20170401. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the ssl predefined policy - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslPredefinedPolicy - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayTrustedRootCertificate.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayTrustedRootCertificate.md deleted file mode 100644 index 051802fce4..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayTrustedRootCertificate.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewaytrustedrootcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayTrustedRootCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayTrustedRootCertificate.md ---- - -# Get-AzureRmApplicationGatewayTrustedRootCertificate - -## SYNOPSIS -Gets the Trusted Root Certificate with a specific name from the Application Gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayTrustedRootCertificate [-Name <String>] -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewayTrustedRootCertificate** cmdlet gets Trusted Root Certificate with a specific name from the Application Gateway. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> $gw = Get-AzureRmApplicationGateway -Name $appgwName -ResourceGroupName $resgpName -PS C:\> $trustedRootCert = Get-AzureRmApplicationGatewayTrustedRootCertificate -ApplicationGateway $gw -Name $certName --CertificateFile ".\rootCA.cer" -``` - -The first command gets the Application Gateway and stores it in $gw variable. -The second command gets the Trusted Root Certificate with a specified name from the Application Gateway. - -## PARAMETERS - -### -ApplicationGateway -The applicationGateway - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the TrustedRoot certificate - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayTrustedRootCertificate - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayUrlPathMapConfig.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayUrlPathMapConfig.md deleted file mode 100644 index a4551f1cc6..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayUrlPathMapConfig.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 000B32E9-FFFB-4165-87ED-F19A6E6CEE54 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewayurlpathmapconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayUrlPathMapConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayUrlPathMapConfig.md ---- - -# Get-AzureRmApplicationGatewayUrlPathMapConfig - -## SYNOPSIS -Gets an array of URL path mappings to a backend server pool. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayUrlPathMapConfig [-Name <String>] -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewayURLPathMapConfig** cmdlet gets an array of URL path mappings to a backend server pool. - -## EXAMPLES - -### Example 1: Get a URL path map configuration -``` -PS C:\>Get-AzureRmApplicationGatewayUrlPathMapConfig -ApplicationGateway Gateway -``` - -This command gets the URL path map configurations from the backend server located on the application gateway named Gateway. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway to which this cmdlet gets a URL path map configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the URL path map name in which this cmdlet get the path map configuration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayUrlPathMap - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayUrlPathMapConfig](./Add-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[New-AzureRmApplicationGatewayUrlPathMapConfig](./New-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[Remove-AzureRmApplicationGatewayUrlPathMapConfig](./Remove-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[Set-AzureRmApplicationGatewayUrlPathMapConfig](./Set-AzureRmApplicationGatewayUrlPathMapConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md deleted file mode 100644 index 261452ac88..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 5D887302-7678-44C0-86F3-CEF2EF8A0991 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewaywebapplicationfirewallconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md ---- - -# Get-AzureRmApplicationGatewayWebApplicationFirewallConfiguration - -## SYNOPSIS -Gets the WAF configuration of an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayWebApplicationFirewallConfiguration -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewayWebApplicationFirewallConfiguration** cmdlet gets the web application firewall (WAF) configuration of an application gateway. - -## EXAMPLES - -### Example 1: Get an application gateway web application firewall configuration -``` -PS C:\>$AppGW = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $FirewallConfig = Get-AzureRmApplicationGatewayWebApplicationFirewallConfiguration -ApplicationGateway $AppGW -``` - -The first command gets the application gateway named ApplicationGateway01, and then stores it in the $AppGW variable. -The second command gets the firewall configuration of the application gateway in $AppGW, and then stores it in $FirewallConfig. - -## PARAMETERS - -### -ApplicationGateway -Specifies an application gateway object. -You can use the Get-AzureRmApplicationGateway cmdlet to get an application gateway object. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayWebApplicationFirewallConfiguration - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGateway](./Get-AzureRmApplicationGateway.md) - -[New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration](./New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md) - -[Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration](./Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationSecurityGroup.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationSecurityGroup.md deleted file mode 100644 index e630f6d9d5..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmApplicationSecurityGroup.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationsecuritygroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationSecurityGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmApplicationSecurityGroup.md ---- - -# Get-AzureRmApplicationSecurityGroup - -## SYNOPSIS -Gets an application security group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationSecurityGroup [-ResourceGroupName <String>] [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationSecurityGroup** cmdlet gets an application security group. - -## EXAMPLES - -### Example 1: Retrieve all application security groups. -``` -PS C:\> Get-AzureRmApplicationSecurityGroup -``` - -The command above returns the all application security groups in the subscription. - -### Example 2: Retrieve application security groups in a resource group. -``` -PS C:\> Get-AzureRmApplicationSecurityGroup -ResourceGroupName MyResourceGroup -``` - -The command above returns all application security groups that belong to the resource group MyResourceGroup. - -### Example 3: Retrieve a specific application security group. -``` -PS C:\> Get-AzureRmApplicationSecurityGroup -ResourceGroupName MyResourceGroup -Name MyApplicationSecurityGroup -``` - -The command above returns the application security group MyApplicationSecurityGroup under the resource group MyResourceGroup. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup - -## NOTES - -## RELATED LINKS - -[New-AzureRmApplicationSecurityGroup](./New-AzureRmApplicationSecurityGroup.md) - -[Remove-AzureRmApplicationSecurityGroup](./Remove-AzureRmApplicationSecurityGroup.md) - -[Get-AzureRmNetworkSecurityRuleConfig](./Get-AzureRmNetworkSecurityRuleConfig.md) - -[Get-AzureRmNetworkInterfaceIpConfig](./Get-AzureRmNetworkInterfaceIpConfig.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmAvailableServiceDelegation.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmAvailableServiceDelegation.md deleted file mode 100644 index c7d2627eb1..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmAvailableServiceDelegation.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermavailableservicedelegation -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmAvailableServiceDelegation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmAvailableServiceDelegation.md ---- - -# Get-AzureRmAvailableServiceDelegation - -## SYNOPSIS -Get available service delegations in the region. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmAvailableServiceDelegation -Location <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmAvailableServiceDelegation** cmdlet allows you to retrieve all of the available service delegations for a subnet in the provided location. This cmdlet does *not* describe which delegations may co-exist on a single subnet. - -## EXAMPLES - -### 1: Getting all available service delegations -```powershell -PS C:\> Get-AzureRmAvailableServiceDelegation -Location "westus" - -Name : Microsoft.Web.serverFarms -Id : /subscriptions/subId/providers/Microsoft.Network/availableDelegations/Microsoft.Web.serverFarms -Type : Microsoft.Network/availableDelegations -ServiceName : Microsoft.Web/serverFarms -Actions : {Microsoft.Network/virtualNetworks/subnets/action} - -Name : Microsoft.Sql.servers -Id : /subscriptions/subId/providers/Microsoft.Network/availableDelegations/Microsoft.Sql.servers -Type : Microsoft.Network/availableDelegations -ServiceName : Microsoft.Sql/servers -Actions : {} -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The location. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSAvailableDelegation - -## NOTES - -## RELATED LINKS -[Add-AzureRmDelegation](./Add-AzureRmDelegation.md) -[New-AzureRmDelegation](./New-AzureRmDelegation.md) -[Remove-AzureRmDelegation](./Remove-AzureRmDelegation.md) -[Get-AzureRmDelegation](./Get-AzureRmDelegation.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmBgpServiceCommunity.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmBgpServiceCommunity.md deleted file mode 100644 index 4498651899..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmBgpServiceCommunity.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermbgpservicecommunity -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmBgpServiceCommunity.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmBgpServiceCommunity.md ---- - -# Get-AzureRmBgpServiceCommunity - -## SYNOPSIS -Provides a list of all services / regions, BGP communities, and associated prefixes. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmBgpServiceCommunity [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet provides a list of all services / regions, BGP communities, and associated prefixes. - -## EXAMPLES - -### Example 1 -``` -Get-AzureRmBgpServiceCommunity - -... - -Name : AzureCentralIndia -Id : /subscriptions//resourceGroups//providers/Microsoft.Network/bgpServiceCommunities/AzureCentralIndia -Type : Microsoft.Network/bgpServiceCommunities -BgpCommunities : [ - { - "ServiceSupportedRegion": "Global", - "CommunityName": "Azure Central India", - "CommunityValue": "12076:51017", - "CommunityPrefixes": [ - "13.71.0.0/18", - "20.190.146.0/25", - "40.79.214.0/24", - "40.81.224.0/19", - "40.87.224.0/22", - "40.112.39.0/25", - "40.112.39.128/26", - "40.126.18.0/25", - "52.136.24.0/24", - "52.140.64.0/18", - "52.159.64.0/19", - "52.172.128.0/17", - "52.239.135.64/26", - "52.239.202.0/24", - "52.245.96.0/22", - "52.253.168.0/22", - "104.47.210.0/23", - "104.211.64.0/20", - "104.211.81.0/24", - "104.211.82.0/23", - "104.211.84.0/22", - "104.211.88.0/21", - "104.211.96.0/19" - ], - "IsAuthorizedToUse": true, - "ServiceGroup": "Azure" - } - ] -... -``` - -This cmdlet provides a list of all services / regions, BGP communities, and associated prefixes. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSBgpServiceCommunity - -## NOTES - -## RELATED LINKS - -[Move-AzureRmExpressRouteCircuit](Move-AzureRmExpressRouteCircuit.md) - -[New-AzureRmExpressRouteCircuit](New-AzureRmExpressRouteCircuit.md) - -[Remove-AzureRmExpressRouteCircuit](Remove-AzureRmExpressRouteCircuit.md) - -[Set-AzureRmExpressRouteCircuit](Set-AzureRmExpressRouteCircuit.md) - -[Get-AzureRmRouteFilter](Get-AzureRmRouteFilter.md) - -[Get-AzureRmRouteFilterRuleConfig](Get-AzureRmRouteFilterRuleConfig.md) - -[Remove-AzureRmRouteFilter](Remove-AzureRmRouteFilter.md) - -[Remove-AzureRmRouteFilterRuleConfig](Remove-AzureRmRouteFilterRuleConfig.md) - -[Set-AzureRmRouteFilter](Set-AzureRmRouteFilter.md) - -[Set-AzureRmRouteFilterRuleConfig](Set-AzureRmRouteFilterRuleConfig.md) - -[New-AzureRmRouteFilter](New-AzureRmRouteFilter.md) - -[New-AzureRmRouteFilterRuleConfig](New-AzureRmRouteFilterRuleConfig.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmDdosProtectionPlan.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmDdosProtectionPlan.md deleted file mode 100644 index 92604a42b3..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmDdosProtectionPlan.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azuredosprotectionplan -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmDdosProtectionPlan.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmDdosProtectionPlan.md ---- - -# Get-AzureRmDdosProtectionPlan - -## SYNOPSIS -Gets a DDoS protection plan. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetByNameAndGroup -``` -Get-AzureRmDdosProtectionPlan -ResourceGroupName <String> -Name <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### List -``` -Get-AzureRmDdosProtectionPlan [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmDdosProtectionPlan cmdlet gets a DDoS protection plan. - -## EXAMPLES - -### Example 1: Get a specific DDoS protection plan -``` -D:\> Get-AzureRmDdosProtectionPlan -ResourceGroupName ResourceGroupName -Name DdosProtectionPlanName - - -Name : DdosProtectionPlanName -Id : /subscriptions/d1dbd366-9871-45ac-84b7-fb318152a9e0/resourceGroups/ResourceGroupName/providers/Microsoft.Network/ddosProtectionPlans/DdosProtectionPlanName -Etag : W/"a20e5592-9b51-423b-9758-b00cd322f744" -ProvisioningState : Succeeded -VirtualNetworks : [ - { - "Id": "/subscriptions/d1dbd366-9871-45ac-84b7-fb318152a9e0/resourceGroups/ResourceGroupName/providers/Microsoft.Network/virtualNetworks/VnetName" - } - ] -``` - -In this case, we need to specify both **ResourceGroupName** and **Name** attributes, which correspond to the resource group and the name of the DDoS protection plan, respectively. - -### Example 2: Get all DDoS protection plans in a resource group -``` -D:\> Get-AzureRmDdosProtectionPlan -ResourceGroupName ResourceGroupName - - -Name : DdosProtectionPlanName -Id : /subscriptions/d1dbd366-9871-45ac-84b7-fb318152a9e0/resourceGroups/ResourceGroupName/providers/Microsoft.Network/ddosProtectionPlans/DdosProtectionPlanName -Etag : W/"a20e5592-9b51-423b-9758-b00cd322f744" -ProvisioningState : Succeeded -VirtualNetworks : [ - { - "Id": "/subscriptions/d1dbd366-9871-45ac-84b7-fb318152a9e0/resourceGroups/ResourceGroupName/providers/Microsoft.Network/virtualNetworks/VnetName" - } - ] -``` - -In this scenario, we only specify the parameter **ResourceGroupName** to get a list of DDoS protection plans. - -### Example 2: Get all DDoS protection plans in a subscription -``` -D:\> Get-AzureRmDdosProtectionPlan - - -Name : DdosProtectionPlanName -Id : /subscriptions/d1dbd366-9871-45ac-84b7-fb318152a9e0/resourceGroups/ResourceGroupName/providers/Microsoft.Network/ddosProtectionPlans/DdosProtectionPlanName -Etag : W/"a20e5592-9b51-423b-9758-b00cd322f744" -ProvisioningState : Succeeded -VirtualNetworks : [ - { - "Id": "/subscriptions/d1dbd366-9871-45ac-84b7-fb318152a9e0/resourceGroups/ResourceGroupName/providers/Microsoft.Network/virtualNetworks/VnetName" - } - ] -``` - -Here, we do not specify any parameters to get a list of all DDoS protection plans in a subscription. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the DDoS protection plan. - -```yaml -Type: System.String -Parameter Sets: GetByNameAndGroup -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the DDoS protection plan resource group. - -```yaml -Type: System.String -Parameter Sets: GetByNameAndGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSDdosProtectionPlan - -## NOTES - -## RELATED LINKS - -[New-AzureRmDdosProtectionPlan](./New-AzureRmDdosProtectionPlan.md) - -[Remove-AzureRmDdosProtectionPlan](./Remove-AzureRmDdosProtectionPlan.md) - -[New-AzureRmVirtualNetwork](./New-AzureRmVirtualNetwork.md) - -[Set-AzureRmVirtualNetwork](./Set-AzureRmVirtualNetwork.md) - -[Get-AzureRmVirtualNetwork](./Get-AzureRmVirtualNetwork.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmDelegation.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmDelegation.md deleted file mode 100644 index e5d84a44d4..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmDelegation.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermdelegation -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmDelegation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmDelegation.md ---- - -# Get-AzureRmDelegation - -## SYNOPSIS -Get a delegation (or all of the delegations) on a given subnet. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmDelegation [-Name <String>] -Subnet <PSSubnet> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDelegation** cmdlet gets the named delegation from a subnet. If no delegation is named, it returns all of the delegations on the provided subnet. - -## EXAMPLES - -### 1: Retrieving a specific delegation -```powershell -PS C:\> $subnet = Get-AzureRmVirtualNetwork -Name "myVNet" -ResourceGroupName "myResourceGroup" | Get-AzureRmVirtualNetworkSubnetConfig -Name "mySubnet" -PS C:\> Get-AzureRmDelegation -Name "myDelegation" -Subnet $subnet - -ProvisioningState : Succeeded -ServiceName : Microsoft.Sql/servers -Actions : {} -Name : myDelegation -Etag : "thisisaguid" -Id : /subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mySubnet/delegations/myDelegation -``` - -The first line retrieves the subnet of interest. The second line shows the delegation information for the delegation called "myDelegation." - -### 2: Retrieving all subnet delegations -```powershell -PS C:\> $vnet = Get-AzureRmVirtualNetwork -Name "myVNet" -ResourceGroupName "myResourceGroup" | Get-AzureRmVirtualNetworkSubnetConfig -Name "mySubnet" -PS C:\> $delegations = Get-AzureRmDelegation -Subnet $subnet -``` - -The first line retrieves the subnet of interest. The second line stores a list of all of the delegations on _mySubnet_ in the $delegations variable. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the delegation - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subnet -The subnet - -```yaml -Type: PSSubnet -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSSubnet - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSDelegation - -## NOTES - -## RELATED LINKS -[Add-AzureRmDelegation](./Add-AzureRmDelegation.md) -[New-AzureRmDelegation](./New-AzureRmDelegation.md) -[Remove-AzureRmDelegation](./Remove-AzureRmDelegation.md) -[Get-AzureRmVirtualNetwork](./Get-AzureRmVirtualNetwork.md) -[Get-AzureRmVirtualNetworkSubnetConfig](./Get-AzureRmVirtualNetworkSubnetConfig.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmEffectiveNetworkSecurityGroup.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmEffectiveNetworkSecurityGroup.md deleted file mode 100644 index b3a5bb0acb..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmEffectiveNetworkSecurityGroup.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: B9409AD6-F761-4B80-8E08-DBB2356F567D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermeffectivenetworksecuritygroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmEffectiveNetworkSecurityGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmEffectiveNetworkSecurityGroup.md ---- - -# Get-AzureRmEffectiveNetworkSecurityGroup - -## SYNOPSIS -Gets the effective network security group of a network interface. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmEffectiveNetworkSecurityGroup -NetworkInterfaceName <String> [-ResourceGroupName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmEffectiveNetworkSecurityGroup** cmdlet returns the effective network security group that is applied on a network interface. - -## EXAMPLES - -### Example 1: Get the effective network security group on a network interface -``` -PS C:\>Get-AzureRmEffectiveNetworkSecurityGroup -NetworkInterfaceName "MyNetworkInterface" -ResourceGroupName "myResourceGroup" -``` - -This command gets all of the effective network security rules associated with the network interface named MyNetworkInterface in the resource group named myResourceGroup. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkInterfaceName -Specified the name of a network interface. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group of a network interface. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSEffectiveNetworkSecurityGroup - -## NOTES - -## RELATED LINKS - -[Get-AzureRmEffectiveRouteTable](./Get-AzureRmEffectiveRouteTable.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmEffectiveRouteTable.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmEffectiveRouteTable.md deleted file mode 100644 index efd6405736..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmEffectiveRouteTable.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 84FDB0F7-E6DE-4E1B-BD71-89535EDC6AA1 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermeffectiveroutetable -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmEffectiveRouteTable.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmEffectiveRouteTable.md ---- - -# Get-AzureRmEffectiveRouteTable - -## SYNOPSIS -Gets the effective route table of a network interface. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmEffectiveRouteTable -NetworkInterfaceName <String> [-ResourceGroupName <String>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmEffectiveRouteTable** cmdlet returns the effective route table that is applied on a network interface. - -## EXAMPLES - -### Example 1: Get the effective route table on a network interface -``` -PS C:\>Get-AzureRmEffectiveRouteTable -NetworkInterfaceName "MyNetworkInterface" -ResourceGroupName "MyResourceGroup" -``` - -This command gets the effective route table associated with network interface named MyNetworkInterface in the resource group named MyResourceGroup. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkInterfaceName -Specified the name of a network interface. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group of a network interface. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSEffectiveRoute - -## NOTES - -## RELATED LINKS - -[Get-AzureRmEffectiveNetworkSecurityGroup](./Get-AzureRmEffectiveNetworkSecurityGroup.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteCircuit.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteCircuit.md deleted file mode 100644 index d35a89818f..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteCircuit.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: C9954E3D-8645-473E-A6D4-86278C2F6BC1 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermexpressroutecircuit -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmExpressRouteCircuit.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmExpressRouteCircuit.md ---- - -# Get-AzureRmExpressRouteCircuit - -## SYNOPSIS -Gets an Azure ExpressRoute circuit from Azure. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmExpressRouteCircuit [-Name <String>] [-ResourceGroupName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmExpressRouteCircuit** cmdlet is used to retrieve an ExpressRoute circuit object -from your subscription. The circuit object returned can be used as input to other cmdlets that -operate on ExpressRoute circuits. - -## EXAMPLES - -### Example 1: Get the ExpressRoute circuit to be deleted -``` -Get-AzureRmExpressRouteCircuit -Name $CircuitName -ResourceGroupName $rg | Remove-AzureRmExpressRouteCircuit -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the ExpressRoute circuit. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group that contains the ExpressRoute circuit. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit - -## NOTES - -## RELATED LINKS - -[Move-AzureRmExpressRouteCircuit](Move-AzureRmExpressRouteCircuit.md) - -[New-AzureRmExpressRouteCircuit](New-AzureRmExpressRouteCircuit.md) - -[Remove-AzureRmExpressRouteCircuit](Remove-AzureRmExpressRouteCircuit.md) - -[Set-AzureRmExpressRouteCircuit](Set-AzureRmExpressRouteCircuit.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteCircuitARPTable.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteCircuitARPTable.md deleted file mode 100644 index 78444a1655..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteCircuitARPTable.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: F0370845-13D9-4FB5-B30E-826A22EBC5E0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermexpressroutecircuitarptable -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmExpressRouteCircuitARPTable.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmExpressRouteCircuitARPTable.md ---- - -# Get-AzureRmExpressRouteCircuitARPTable - -## SYNOPSIS -Gets the ARP table from an ExpressRoute circuit. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmExpressRouteCircuitARPTable -ResourceGroupName <String> -ExpressRouteCircuitName <String> - [-PeeringType <String>] -DevicePath <DevicePathEnum> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmExpressRouteCircuitARPTable** cmdlet retrieves the ARP table from both interfaces -of an ExpressRoute circuit. The ARP table provides a mapping of the IPv4 address to MAC address for -a particular peering. You can use the ARP table to validate layer 2 configuration and connectivity. - -## EXAMPLES - -### Example 1: Display the ARP table for an ExpressRoute peer -``` -Get-AzureRmExpressRouteCircuitARPTable -ResourceGroupName $RG -ExpressRouteCircuitName $CircuitName -PeeringType MicrosoftPeering -DevicePath Primary -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevicePath -The acceptable values for this parameter are: `Primary` or `Secondary` - -```yaml -Type: Microsoft.Azure.Commands.Network.DevicePathEnum -Parameter Sets: (All) -Aliases: -Accepted values: Primary, Secondary - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpressRouteCircuitName -The name of the ExpressRoute circuit being examined. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PeeringType -The acceptable values for this parameter are: `AzurePrivatePeering`, `AzurePublicPeering`, and -`MicrosoftPeering` - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: AzurePrivatePeering, AzurePublicPeering, MicrosoftPeering - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group containing the ExpressRoute circuit. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuitArpTable - -## NOTES - -## RELATED LINKS - -[Get-AzureRmExpressRouteCircuitRouteTable](Get-AzureRmExpressRouteCircuitRouteTable.md) - -[Get-AzureRmExpressRouteCircuitRouteTableSummary](Get-AzureRmExpressRouteCircuitRouteTableSummary.md) - -[Get-AzureRmExpressRouteCircuitStats](Get-AzureRmExpressRouteCircuitStats.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteCircuitAuthorization.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteCircuitAuthorization.md deleted file mode 100644 index c7a14b29fa..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteCircuitAuthorization.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 3D80F94B-AF9D-40C2-BE7E-2F32E5E926D2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermexpressroutecircuitauthorization -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmExpressRouteCircuitAuthorization.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmExpressRouteCircuitAuthorization.md ---- - -# Get-AzureRmExpressRouteCircuitAuthorization - -## SYNOPSIS -Gets information about ExpressRoute circuit authorizations. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmExpressRouteCircuitAuthorization [-Name <String>] -ExpressRouteCircuit <PSExpressRouteCircuit> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmExpressRouteCircuitAuthorization** cmdlet gets information about the -authorizations assigned to an ExpressRoute circuit. ExpressRoute circuits connect your on-premises -network to the Microsoft cloud by using a connectivity provider instead of the public Internet. The -owner of an ExpressRoute circuit can create as many as 10 authorizations for each circuit; these -authorizations generate an authorization key that can be used by a virtual network owner to connect -his or her network to the circuit (one authorization per virtual network). Authorization keys, as -well as other information about the authorization, can be viewed at any time by running -**Get-AzureRmExpressRouteCircuitAuthorization**. - -## EXAMPLES - -### Example 1: Get all ExpressRoute authorizations -``` -$Circuit = Get-AzureRmExpressRouteCircuit -Name "ContosoCircuit" -ResourceGroupName "ContosoResourceGroup" -Get-AzureRmExpressRouteCircuitAuthorization -Circuit $Circuit -``` - -These commands return information about all the ExpressRoute authorizations associated with an -ExpressRoute circuit. The first command uses the **Get-AzureRmExpressRouteCircuit** cmdlet to -create an object reference a circuit named ContosoCircuit; that object reference is stored in the -variable $Circuit. The second command then uses that object reference and the -**Get-AzureRmExpressRouteCircuitAuthorization** cmdlet to return information about the -authorizations associated with ContosoCircuit. - -### Example 2: Get all ExpressRoute authorizations using the Where-Object cmdlet -``` -$Circuit = Get-AzureRmExpressRouteCircuit -Name "ContosoCircuit" -ResourceGroupName "ContosoResourceGroup" - Get-AzureRmExpressRouteCircuitAuthorization -Circuit $Circuit | Where-Object {$_.AuthorizationUseStatus -eq "Available"} -``` - -These commands represent a variation on the commands used in Example 1. In this case, however, -information is returned only for those authorizations that are available for use (that is, for -authorizations that have not been assigned to a virtual network). To do this, the circuit -authorization information is returned in command 2 and is piped to the **Where-Object** cmdlet. -**Where-Object** then picks out only those authorizations where the *AuthorizationUseStatus* -property is set to Available. To list only those authorizations that are not available, use this -syntax for the Where clause: -`{$_.AuthorizationUseStatus -ne "Available"}` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpressRouteCircuit -Specifies the ExpressRoute circuit authorization. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the ExpressRoute circuit authorization that this cmdlet gets. --Name "ContosoCircuitAuthorization" - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit -Parameters: ExpressRouteCircuit (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuitAuthorization - -## NOTES - -## RELATED LINKS - -[Add-AzureRmExpressRouteCircuitAuthorization](./Add-AzureRmExpressRouteCircuitAuthorization.md) - -[Get-AzureRmExpressRouteCircuit](./Get-AzureRmExpressRouteCircuit.md) - -[New-AzureRmExpressRouteCircuitAuthorization](./New-AzureRmExpressRouteCircuitAuthorization.md) - -[Remove-AzureRmExpressRouteCircuitAuthorization](./Remove-AzureRmExpressRouteCircuitAuthorization.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteCircuitConnectionConfig.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteCircuitConnectionConfig.md deleted file mode 100644 index d1770b2732..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteCircuitConnectionConfig.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 59692f1f-9f1e-4a3c-8200-312c3806a9b7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermexpressroutecircuitconnectionconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmExpressRouteCircuitConnectionConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmExpressRouteCircuitConnectionConfig.md ---- - -# Get-AzureRmExpressRouteCircuitConnectionConfig - -## SYNOPSIS -Gets an ExpressRoute circuit connection configuration associated with Private Peering of ExpressRouteCircuit. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmExpressRouteCircuitConnectionConfig [-Name] <String> [-ExpressRouteCircuit] <PSExpressRouteCircuit> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmExpressRouteCircuitConnectionConfig** cmdlet retrieves the configuration of a circuit connection -associated with Private Peering for an ExpressRoute circuit. - -## EXAMPLES - -### Example 1: Display the circuit connection configuration for an ExpressRoute circuit -``` -$circuit_init = Get-AzureRmExpressRouteCircuit -Name $initiatingCircuitName -ResourceGroupName $rg -Get-AzureRmExpressRouteCircuitConnectionConfig -Name $circuitConnectionName -ExpressRouteCircuit $circuit_init -``` - -### Example 2: Get circuit connection resource associated with an ExpressRoute Circuit using piping -``` -Get-AzureRmExpressRouteCircuit -Name $initiatingCircuitName -ResourceGroupName $rg|Get-AzureRmExpressRouteCircuitConnectionConfig -Name $circuitConnectionName -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpressRouteCircuit -The ExpressRoute circuit object containing the circuit connection configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the circuit connection configuration to be retrieved. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit -Parameters: ExpressRouteCircuit (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuitConnection - -## NOTES - -## RELATED LINKS - -[Get-AzureRmExpressRouteCircuit](Get-AzureRmExpressRouteCircuit.md) - -[Add-AzureRmExpressRouteCircuitConnectionConfig](Add-AzureRmExpressRouteCircuitConnectionConfig.md) - -[Remove-AzureRmExpressRouteCircuitConnectionConfig](Remove-AzureRmExpressRouteCircuitConnectionConfig.md) - - - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteCircuitPeeringConfig.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteCircuitPeeringConfig.md deleted file mode 100644 index fad2578a6e..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteCircuitPeeringConfig.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 47C45467-F368-4993-937E-E7E975F400B5 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermexpressroutecircuitpeeringconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmExpressRouteCircuitPeeringConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmExpressRouteCircuitPeeringConfig.md ---- - -# Get-AzureRmExpressRouteCircuitPeeringConfig - -## SYNOPSIS -Gets an ExpressRoute circuit peering configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmExpressRouteCircuitPeeringConfig [-Name <String>] -ExpressRouteCircuit <PSExpressRouteCircuit> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmExpressRouteCircuitPeeringConfig** cmdlet retrieves the configuration of a peering -relationship for an ExpressRoute circuit. - -## EXAMPLES - -### Example 1: Display the peering configuration for an ExpressRoute circuit -``` -$ckt = Get-AzureRmExpressRouteCircuit -Name $CircuitName -ResourceGroupName $RG -Get-AzureRmExpressRouteCircuitPeeringConfig -Name "AzurePrivatePeering" -ExpressRouteCircuit $ckt -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpressRouteCircuit -The ExpressRoute circuit object containing the peering configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the peering configuration to be retrieved. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit -Parameters: ExpressRouteCircuit (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSPeering - -## NOTES - -## RELATED LINKS - -[Add-AzureRmExpressRouteCircuitPeeringConfig](Add-AzureRmExpressRouteCircuitPeeringConfig.md) - -[New-AzureRmExpressRouteCircuitPeeringConfig](New-AzureRmExpressRouteCircuitPeeringConfig.md) - -[Remove-AzureRmExpressRouteCircuitPeeringConfig](Remove-AzureRmExpressRouteCircuitPeeringConfig.md) - -[Set-AzureRmExpressRouteCircuit](Set-AzureRmExpressRouteCircuit.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteCircuitRouteTable.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteCircuitRouteTable.md deleted file mode 100644 index 115ee0e7cc..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteCircuitRouteTable.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: BA7F6BAC-6047-42B0-B8CA-0B36302951B0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermexpressroutecircuitroutetable -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmExpressRouteCircuitRouteTable.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmExpressRouteCircuitRouteTable.md ---- - -# Get-AzureRmExpressRouteCircuitRouteTable - -## SYNOPSIS -Gets a route table from an ExpressRoute circuit. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmExpressRouteCircuitRouteTable -ResourceGroupName <String> -ExpressRouteCircuitName <String> - [-PeeringType <String>] -DevicePath <DevicePathEnum> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmExpressRouteCircuitRouteTable** cmdlet retrieves a detailed route table of an -ExpressRoute circuit. The route table will show all routes or can be filtered to show routes for a -specific peering type. You can use the route table to validate your peering configuration and -connectivity. - -## EXAMPLES - -### Example 1: Display the route table for the primary path -``` -Get-AzureRmExpressRouteCircuitRouteTable -ResourceGroupName $RG -ExpressRouteCircuitName $CircuitName -DevicePath 'Primary' -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevicePath -The acceptable values for this parameter are: `Primary` or `Secondary` - -```yaml -Type: Microsoft.Azure.Commands.Network.DevicePathEnum -Parameter Sets: (All) -Aliases: -Accepted values: Primary, Secondary - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpressRouteCircuitName -The name of the ExpressRoute circuit being examined. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PeeringType -The acceptable values for this parameter are: `AzurePrivatePeering`, `AzurePublicPeering`, and -`MicrosoftPeering` - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: AzurePrivatePeering, AzurePublicPeering, MicrosoftPeering - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group containing the ExpressRoute circuit. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuitRoutesTable - -## NOTES - -## RELATED LINKS - -[Get-AzureRmExpressRouteCircuitARPTable](Get-AzureRmExpressRouteCircuitARPTable.md) - -[Get-AzureRmExpressRouteCircuitRouteTableSummary](Get-AzureRmExpressRouteCircuitRouteTableSummary.md) - -[Get-AzureRmExpressRouteCircuitStats](Get-AzureRmExpressRouteCircuitStats.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteCircuitRouteTableSummary.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteCircuitRouteTableSummary.md deleted file mode 100644 index 0959b6a76c..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteCircuitRouteTableSummary.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 2C603E0E-A19F-4EA6-B918-945007BE22FF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermexpressroutecircuitroutetablesummary -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmExpressRouteCircuitRouteTableSummary.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmExpressRouteCircuitRouteTableSummary.md ---- - -# Get-AzureRmExpressRouteCircuitRouteTableSummary - -## SYNOPSIS -Gets a route table summary of an ExpressRoute circuit. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmExpressRouteCircuitRouteTableSummary -ResourceGroupName <String> -ExpressRouteCircuitName <String> - [-PeeringType <String>] -DevicePath <DevicePathEnum> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmExpressRouteCircuitRouteTableSummary** cmdlet retrieves a summary of BGP neighbor -information for a particular routing context. This information is useful to determine for how long -a routing context has been established and the number of route prefixes advertised by the peering -router. - -## EXAMPLES - -### Example 1: Display the route summary for the primary path -``` -Get-AzureRmExpressRouteCircuitRouteTableSummary -ResourceGroupName $RG -ExpressRouteCircuitName $CircuitName -DevicePath 'Primary' -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevicePath -The acceptable values for this parameter are: `Primary` or `Secondary` - -```yaml -Type: Microsoft.Azure.Commands.Network.DevicePathEnum -Parameter Sets: (All) -Aliases: -Accepted values: Primary, Secondary - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpressRouteCircuitName -The name of the ExpressRoute circuit being examined. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PeeringType -The acceptable values for this parameter are: `AzurePrivatePeering`, `AzurePublicPeering`, and -`MicrosoftPeering` - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: AzurePrivatePeering, AzurePublicPeering, MicrosoftPeering - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group containing the ExpressRoute circuit. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuitRoutesTableSummary - -## NOTES - -## RELATED LINKS - -[Get-AzureRmExpressRouteCircuitARPTable](Get-AzureRmExpressRouteCircuitARPTable.md) - -[Get-AzureRmExpressRouteCircuitRouteTable](Get-AzureRmExpressRouteCircuitRouteTable.md) - -[Get-AzureRmExpressRouteCircuitStats](Get-AzureRmExpressRouteCircuitStats.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteCircuitStats.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteCircuitStats.md deleted file mode 100644 index b3a07f80ca..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteCircuitStats.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: CFE184E2-6DEF-4E92-A9C3-E82F29BB4FB8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermexpressroutecircuitstats -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmExpressRouteCircuitStats.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmExpressRouteCircuitStats.md ---- - -# Get-AzureRmExpressRouteCircuitStats - -## SYNOPSIS -Gets usage statistics of an ExpressRoute circuit. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmExpressRouteCircuitStats -ResourceGroupName <String> -ExpressRouteCircuitName <String> - [-PeeringType <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmExpressRouteCircuitStats** cmdlet retrieves traffic statistics for an ExpressRoute -circuit. The statistics include the number of bytes sent and received over both the primary and -secondary routes. - -## EXAMPLES - -### Example 1: Display the traffic statistics for an ExpressRoute peer -``` -Get-AzureRmExpressRouteCircuitStats -ResourceGroupName $RG -ExpressRouteCircuitName $CircuitName -PeeringType 'AzurePrivatePeering' -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpressRouteCircuitName -The name of the ExpressRoute circuit being examined. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PeeringType -The acceptable values for this parameter are: `AzurePrivatePeering`, `AzurePublicPeering`, and -`MicrosoftPeering` - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: AzurePrivatePeering, AzurePublicPeering, MicrosoftPeering - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group containing the ExpressRoute circuit. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuitStats - -## NOTES - -## RELATED LINKS - -[Get-AzureRmExpressRouteCircuitARPTable](Get-AzureRmExpressRouteCircuitARPTable.md) - -[Get-AzureRmExpressRouteCircuitRouteTable](Get-AzureRmExpressRouteCircuitRouteTable.md) - -[Get-AzureRmExpressRouteCircuitRouteTableSummary](Get-AzureRmExpressRouteCircuitRouteTableSummary.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRoutePort.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRoutePort.md deleted file mode 100644 index 762bd36ca1..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRoutePort.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermexpressrouteport -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmExpressRoutePort.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmExpressRoutePort.md ---- - -# Get-AzureRmExpressRoutePort - -## SYNOPSIS -Gets an Azure ExpressRoutePort resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceNameParameterSet (Default) -``` -Get-AzureRmExpressRoutePort [-ResourceGroupName <String>] [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Get-AzureRmExpressRoutePort -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmExpressRoutePort** cmdlet is used to retrieve an ExpressRoutePort object -from your subscription. The expressrouteport object returned can be used as input to other cmdlets that -operate on ExpressRoutePort. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmExpressRoutePort -Name $PortName -ResourceGroupName $rg -``` - -Gets the ExpressRoutePort object with name $PortName in resource group $rg in your subscription. - -### Example 2 -```powershell -PS C:\> Get-AzureRmExpressRoutePort -ResourceId $id -``` - -Gets the ExpressRoutePort object with ResourceId $id. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the ExpressRoutePort. - -```yaml -Type: System.String -Parameter Sets: ResourceNameParameterSet -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name of the ExpressRoutePort. - -```yaml -Type: System.String -Parameter Sets: ResourceNameParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -ResourceId of the express route port. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRoutePortLinkConfig.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRoutePortLinkConfig.md deleted file mode 100644 index a9c00a91a2..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRoutePortLinkConfig.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermexpressrouteportlinkconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmExpressRoutePortLinkConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmExpressRoutePortLinkConfig.md ---- - -# Get-AzureRmExpressRoutePortLinkConfig - -## SYNOPSIS -Gets an ExpressRoutePort link configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceNameParameterSet (Default) -``` -Get-AzureRmExpressRoutePortLinkConfig -ExpressRoutePort <PSExpressRoutePort> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Get-AzureRmExpressRoutePortLinkConfig -ExpressRoutePort <PSExpressRoutePort> -ResourceId <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmExpressRoutePortLinkConfig** cmdlet retrieves the configuration of a link -of an ExpressRoutePort. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmExpressRoutePortLinkConfig -ExpressRoutePort $erport -Name Link1 -``` - -Gets the Link1 configuration of ExpressRoutePort $erport - -### Example 2 -```powershell -PS C:\> Get-AzureRmExpressRoutePortLinkConfig -ExpressRoutePort $erport -ResourceId $id -``` - -Gets the configuration of link with ResourceId $id in ExpressRoutePort $erport - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpressRoutePort -The reference of the ExpressRoutePort resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the link. - -```yaml -Type: System.String -Parameter Sets: ResourceNameParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -ResourceId of the link. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteLink - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRoutePortsLocation.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRoutePortsLocation.md deleted file mode 100644 index ad3490ae57..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRoutePortsLocation.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermexpressrouteportslocation -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmExpressRoutePortsLocation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmExpressRoutePortsLocation.md ---- - -# Get-AzureRmExpressRoutePortsLocation - -## SYNOPSIS -Gets the locations at which ExpressRoutePort resources are available. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmExpressRoutePortsLocation [-LocationName <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmExpressRoutePortsLocation** cmdlet is used to retrieve the locations at which -ExpressRoutePort resources are available. Given a specific location as input, the cmdlet displays -the details of that location i.e., list of available bandwidths at that location. - - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmExpressRoutePortsLocation -``` - -Lists the locations at which ExpressRoutePort resources are available. - -### Example 2 -```powershell -PS C:\> Get-AzureRmExpressRoutePortsLocation -LocationName $loc -``` - -Lists the ExpressRoutePort bandwidths available at location $loc. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocationName -The name of the location. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRoutePortsLocation - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteServiceProvider.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteServiceProvider.md deleted file mode 100644 index 8e38f40a7f..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmExpressRouteServiceProvider.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 009F6E65-0268-4505-AEC1-FF379CB96804 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermexpressrouteserviceprovider -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmExpressRouteServiceProvider.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmExpressRouteServiceProvider.md ---- - -# Get-AzureRmExpressRouteServiceProvider - -## SYNOPSIS -Gets a list ExpressRoute service providers and their attributes. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmExpressRouteServiceProvider [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmExpressRouteServiceProvider** cmdlet retrieves a list ExpressRoute service -providers and their attributes. Attribute include location and bandwidth options. - -## EXAMPLES - -### Example 1: Get a list of service provider with locations in "Silicon Valley" -``` -Get-AzureRmExpressRouteServiceProvider | - Where-Object PeeringLocations -Contains "Silicon Valley" | - Select-Object Name -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteServiceProvider - -## NOTES - -## RELATED LINKS - -[Get-AzureRmExpressRouteCircuitARPTable](Get-AzureRmExpressRouteCircuitARPTable.md) - -[Get-AzureRmExpressRouteCircuitRouteTable](Get-AzureRmExpressRouteCircuitRouteTable.md) - -[Get-AzureRmExpressRouteCircuitRouteTableSummary](Get-AzureRmExpressRouteCircuitRouteTableSummary.md) - -[Get-AzureRmExpressRouteCircuitStats](Get-AzureRmExpressRouteCircuitStats.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmFirewall.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmFirewall.md deleted file mode 100644 index 219a432e1c..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmFirewall.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 91D58F60-F22A-454A-B04C-E5AEF33E9D06 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermfirewall -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmFirewall.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmFirewall.md ---- - -# Get-AzureRmFirewall - -## SYNOPSIS -Gets a Azure Firewall. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmFirewall [-Name <String>] [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmFirewall** cmdlet gets one or more Firewalls in a resource group. - -## EXAMPLES - -### 1: Retrieve all Firewalls in a resource group -``` -Get-AzureRmFirewall -ResourceGroupName rgName -``` - -This example retrieves all Firewalls in resource group "rgName". - -### 2: Retrieve a Firewall by name -``` -Get-AzureRmFirewall -ResourceGroupName rgName -Name azFw -``` - -This example retrieves Firewall named "azFw" in resource group "rgName". - -### 3: Retrieve a firewall and then add a application rule collection to the Firewall -``` -$azFw=Get-AzureRmFirewall -Name "azFw" -ResourceGroupName "rgName" -$appRule = New-AzureRmFirewallApplicationRule -Name R1 -Protocol "http:80","https:443" -TargetFqdn "*google.com", "*microsoft.com" -SourceAddress "10.0.0.0" -$appRuleCollection = New-AzureRmFirewallApplicationRuleCollection -Name "MyAppRuleCollection" -Priority 100 -Rule $appRule -ActionType "Allow" -$azFw.AddApplicationRuleCollection($appRuleCollection) -``` - -This example retrieves a firewall, then adds a application rule collection to the firewall by calling method AddApplicationRuleCollection. - -### 4: Retrieve a firewall and then add a network rule collection to the Firewall -``` -$azFw=Get-AzureRmFirewall -Name "azFw" -ResourceGroupName "rgName" -$netRule = New-AzureRmFirewallNetworkRule -Name "all-udp-traffic" -Description "Rule for all UDP traffic" -Protocol "Udp" -SourceAddress "*" -DestinationAddress "*" -DestinationPort "*" -$netRuleCollection = New-AzureRmFirewallNetworkRuleCollection -Name "MyNetworkRuleCollection" -Priority 100 -Rule $netRule -ActionType "Allow" -$azFw.AddNetworkRuleCollection($netRuleCollection) -``` - -This example retrieves a firewall, then adds a network rule collection to the firewall by calling method AddNetworkRuleCollection. - -### 5: Retrieve a firewall and then retrieve a application rule collection by name from the Firewall -``` -$azFw=Get-AzureRmFirewall -Name "azFw" -ResourceGroupName "rgName" -$getAppRc=$azFw.GetApplicationRuleCollectionByName("MyAppRuleCollection") -``` - -This example retrieves a firewall and then gets a rule collection by name, calling method GetApplicationRuleCollectionByName on the -firewall object. The rule collection name for method GetApplicationRuleCollectionByName is case-insensitive. - -### 6: Retrieve a firewall and then retrieve a network rule collection by name from the Firewall -``` -$azFw=Get-AzureRmFirewall -Name "azFw" -ResourceGroupName "rgName" -$getNetRc=$azFw.GetNetworkRuleCollectionByName("MyNetworkRuleCollection") -``` - -This example retrieves a firewall and then gets a rule collection by name, calling method GetNetworkRuleCollectionByName on the -firewall object. The rule collection name for method GetNetworkRuleCollectionByName is case-insensitive. - -### 7: Retrieve a firewall and then remove a application rule collection by name from the Firewall -``` -$azFw=Get-AzureRmFirewall -Name "azFw" -ResourceGroupName "rgName" -$azFw.RemoveApplicationRuleCollectionByName("MyAppRuleCollection") -``` - -This example retrieves a firewall and then removes a rule collection by name, calling method RemoveApplicationRuleCollectionByName on the -firewall object. The rule collection name for method RemoveApplicationRuleCollectionByName is case-insensitive. - -### 8: Retrieve a firewall and then remove a network rule collection by name from the Firewall -``` -$azFw=Get-AzureRmFirewall -Name "azFw" -ResourceGroupName "rgName" -$azFw.RemoveNetworkRuleCollectionByName("MyNetworkRuleCollection") -``` - -This example retrieves a firewall and then removes a rule collection by name, calling method RemoveNetworkRuleCollectionByName on the -firewall object. The rule collection name for method RemoveNetworkRuleCollectionByName is case-insensitive. - -### 9: Retrieve a firewall and then allocate the firewall -``` -$vnet=Get-AzureRmVirtualNetwork -Name "vnet" -ResourceGroupName "rgName" -$publicIp=Get-AzureRmPublicIpAddress -Name "firewallpip" -ResourceGroupName "rgName" -$azFw=Get-AzureRmFirewall -Name "azFw" -ResourceGroupName "rgName" -$azFw.Allocate($vnet, $publicIp) -``` - -This example retrieves a firewall and calls Allocate on the firewall to start the firewall service using the configuration -(application and network rule collections) associated with the firewall. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Firewall that this cmdlet gets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that Firewall belongs to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSAzureFirewall - -## NOTES - -## RELATED LINKS - -[New-AzureRmFirewall](./New-AzureRmFirewall.md) - -[Remove-AzureRmFirewall](./Remove-AzureRmFirewall.md) - -[Set-AzureRmFirewall](./Set-AzureRmFirewall.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmFirewallFqdnTag.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmFirewallFqdnTag.md deleted file mode 100644 index 482bdbfc12..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmFirewallFqdnTag.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 98CB62E1-0A18-4207-81FA-07CC60310896 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermfirewallfqdntag -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmFirewallFqdnTag.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmFirewallFqdnTag.md ---- - -# Get-AzureRmFirewallFqdnTag - -## SYNOPSIS -Gets the available Azure Firewall Fqdn Tags. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmFirewallFqdnTag [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmFirewallFqdnTag** cmdlet gets the list of FQDN Tags which can be used for Azure Firewall Application Rules - -## EXAMPLES - -### 1: Retrieve all available FQDN Tags -``` -Get-AzureRmFirewallFqdnTag -``` - -This example retrieves all available FQDN Tags. - -### 2: Use first available FQDN Tag in an Application Rule -``` -$fqdnTags = Get-AzureRmFirewallFqdnTag -New-AzureRmFirewallApplicationRule -Name AR -SourceAddress * -FqdnTag $fqdnTags[0].FqdnTagName -``` - -This example creates a Firewall Application Rule using the first available FQDN Tag - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSAzureFirewallFqdnTag - -## NOTES - -## RELATED LINKS - -[New-AzureRmFirewallApplicationRule](./New-AzureRmFirewallApplicationRule.md) - -[New-AzureRmFirewall](./New-AzureRmFirewall.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmInterfaceEndpoint.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmInterfaceEndpoint.md deleted file mode 100644 index b0378432c7..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmInterfaceEndpoint.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurerminterfaceendpoint -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmInterfaceEndpoint.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmInterfaceEndpoint.md ---- - -# Get-AzureRmInterfaceEndpoint - -## SYNOPSIS -The Get-AzureRmInterfaceEndpoint cmdlet gets a Interface Endpoint. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetByNameParameterSet (Default) -``` -Get-AzureRmInterfaceEndpoint [-Name <String>] -ResourceGroupName <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### GetByResourceIdParameterSet -``` -Get-AzureRmInterfaceEndpoint -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmInterfaceEndpoint** cmdlet gets a Interface Endpoint. - -## EXAMPLES - -### Example 1 -``` -$interfaceendpoint = Get-AzureRmInterfaceEndpoint -Name "InterfaceEndpoint1" -ResourceGroupName "ResourceGroup01" -``` - -This command gets the interface endpoint named InterfaceEndpoint1 that belongs to the resource group named ResourceGroup01 and stores it in the $interfaceendpoint variable. - -### Example 2 -``` -$interfaceendpoint = Get-AzureRmInterfaceEndpoint -ResourceId "/subscriptions/sub1/resourceGroups/chsriniIEtest1/providers/Microsoft.Network/interfaceEndpoints/ie1.10" - -``` - -This command gets the interface endpoint with resourceId /subscriptions/sub1/resourceGroups/chsriniIEtest1/providers/Microsoft.Network/interfaceEndpoints/ie1.10 and stores it in the $interfaceendpoint variable. - - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the interface endpoint - -```yaml -Type: String -Parameter Sets: GetByNameParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: String -Parameter Sets: GetByNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -{{Fill ResourceId Description}} - -```yaml -Type: String -Parameter Sets: GetByResourceIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSInterfaceEndpoint - - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmLoadBalancer.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmLoadBalancer.md deleted file mode 100644 index 38a7f30aa7..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmLoadBalancer.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 78F356F6-A621-4C27-B9CC-D103E74B3A33 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermloadbalancer -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmLoadBalancer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmLoadBalancer.md ---- - -# Get-AzureRmLoadBalancer - -## SYNOPSIS -Gets a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NoExpand (Default) -``` -Get-AzureRmLoadBalancer [-ResourceGroupName <String>] [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### Expand -``` -Get-AzureRmLoadBalancer -ResourceGroupName <String> -Name <String> -ExpandResource <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmLoadBalancer** cmdlet gets one or more Azure load balancers that are contained in a resource group. - -## EXAMPLES - -### Example 1: Get a load balancer -``` -PS C:\>Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -``` - -This command gets the load balancer named MyLoadBalancer. -A load balancer must exist before you can run this cmdlet. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpandResource -```yaml -Type: System.String -Parameter Sets: Expand -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -```yaml -Type: System.String -Parameter Sets: NoExpand -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: Expand -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -```yaml -Type: System.String -Parameter Sets: NoExpand -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: Expand -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[New-AzureRmLoadBalancer](./New-AzureRmLoadBalancer.md) - -[Remove-AzureRmLoadBalancer](./Remove-AzureRmLoadBalancer.md) - -[Set-AzureRmLoadBalancer](./Set-AzureRmLoadBalancer.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmLoadBalancerBackendAddressPoolConfig.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmLoadBalancerBackendAddressPoolConfig.md deleted file mode 100644 index 06bb3a1067..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmLoadBalancerBackendAddressPoolConfig.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: F421174A-B138-45EB-AF84-CB3CE5870F27 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermloadbalancerbackendaddresspoolconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmLoadBalancerBackendAddressPoolConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmLoadBalancerBackendAddressPoolConfig.md ---- - -# Get-AzureRmLoadBalancerBackendAddressPoolConfig - -## SYNOPSIS -Gets a backend address pool configuration for a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmLoadBalancerBackendAddressPoolConfig -LoadBalancer <PSLoadBalancer> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmLoadBalancerBackendAddressPoolConfig** cmdlet gets a single backend address pool or a list of backend address pools within a load balancer. - -## EXAMPLES - -### Example 1: Get the backend address pool -``` -PS C:\>$loadbalancer = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -PS C:\> Get-AzureRmLoadBalancerBackendAddressPoolConfig -Name "BackendAddressPool02" -LoadBalancer $loadbalancer -``` - -The first command gets an existing load balancer named MyLoadBalancer in the resource group named MyResourceGroup, and then stores it in the $loadbalancer variable. -The second command gets the associated backend address pool configuration named BackendAddressPool02 for the load balancer in $loadbalancer. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancer -Specifies the load balancer that is associated with the backend address pool to get. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the load balancer that contains the backend address pool to get. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameters: LoadBalancer (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerBackendAddressPoolConfig](./Add-AzureRmLoadBalancerBackendAddressPoolConfig.md) - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[New-AzureRmLoadBalancerBackendAddressPoolConfig](./New-AzureRmLoadBalancerBackendAddressPoolConfig.md) - -[Remove-AzureRmLoadBalancerBackendAddressPoolConfig](./Remove-AzureRmLoadBalancerBackendAddressPoolConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmLoadBalancerFrontendIpConfig.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmLoadBalancerFrontendIpConfig.md deleted file mode 100644 index dce08a3660..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmLoadBalancerFrontendIpConfig.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 6BEED413-E2E4-4557-BD31-2A655E790C1D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermloadbalancerfrontendipconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmLoadBalancerFrontendIpConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmLoadBalancerFrontendIpConfig.md ---- - -# Get-AzureRmLoadBalancerFrontendIpConfig - -## SYNOPSIS -Gets a front-end IP configuration in a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmLoadBalancerFrontendIpConfig -LoadBalancer <PSLoadBalancer> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmLoadBalancerFrontendIpConfig** cmdlet gets a front-end IP configuration or a list of front-end IP configurations in a load balancer. - -## EXAMPLES - -### Example 1: Get a front-end IP configuration in a load balancer -``` -PS C:\>$slb = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -PS C:\> Get-AzureRmLoadBalancerFrontendIpConfig -Name "MyFrontEnd" -LoadBalancer $slb -``` - -The first command gets the load balancer named MyLoadBalancer, and then stores it in the variable $slb. -The second command gets the front end IP configuration associated with that load balancer. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancer -Specifies the load balancer that is associated with the front-end IP configuration to get. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the load balancer that contains the front-end IP configuration to get. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameters: LoadBalancer (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerFrontendIpConfig](./Add-AzureRmLoadBalancerFrontendIpConfig.md) - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[New-AzureRmLoadBalancerFrontendIpConfig](./New-AzureRmLoadBalancerFrontendIpConfig.md) - -[Remove-AzureRmLoadBalancerFrontendIpConfig](./Remove-AzureRmLoadBalancerFrontendIpConfig.md) - -[Set-AzureRmLoadBalancerFrontendIpConfig](./Set-AzureRmLoadBalancerFrontendIpConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmLoadBalancerInboundNatPoolConfig.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmLoadBalancerInboundNatPoolConfig.md deleted file mode 100644 index 54f5c1cdb2..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmLoadBalancerInboundNatPoolConfig.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 614B0634-154A-449A-83E7-051DEF5A3BEE -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermloadbalancerinboundnatpoolconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmLoadBalancerInboundNatPoolConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmLoadBalancerInboundNatPoolConfig.md ---- - -# Get-AzureRmLoadBalancerInboundNatPoolConfig - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmLoadBalancerInboundNatPoolConfig -LoadBalancer <PSLoadBalancer> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION - -## EXAMPLES - -### 1: Get -``` -PS C:\> $slb = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -PS C:\> $slb | Get-AzureRmLoadBalancerInboundNatPoolConfig -Name myInboundNatPool -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancer -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameters: LoadBalancer (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSInboundNatPool - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmLoadBalancerInboundNatRuleConfig.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmLoadBalancerInboundNatRuleConfig.md deleted file mode 100644 index fe958b323d..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmLoadBalancerInboundNatRuleConfig.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 1FDA90C0-D01F-45E1-9149-16AD04046271 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermloadbalancerinboundnatruleconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmLoadBalancerInboundNatRuleConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmLoadBalancerInboundNatRuleConfig.md ---- - -# Get-AzureRmLoadBalancerInboundNatRuleConfig - -## SYNOPSIS -Gets an inbound NAT rule configuration for a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmLoadBalancerInboundNatRuleConfig -LoadBalancer <PSLoadBalancer> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmLoadBalancerInboundNatRuleConfig** cmdlet gets one or more inbound network address translation (NAT) rules in an Azure load balancer. - -## EXAMPLES - -### Example 1: Get an inbound NAT rule configuration -``` -PS C:\>$slb = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -PS C:\> Get-AzureRmLoadBalancerInboundNatRuleConfig -Name "MyInboundNatRule1" -LoadBalancer $slb -``` - -The first command gets the load balancer named MyLoadBalancer, and stores it in the variable $slb. -The second command gets the associated NAT rule named MyInboundNatRule1 from the load balancer in $slb. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancer -Specifies the load balancer that is associated with the inbound NAT rule configuration to get. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the inbound NAT rule configuration to get. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameters: LoadBalancer (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSInboundNatRule - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[New-AzureRmLoadBalancerInboundNatRuleConfig](./New-AzureRmLoadBalancerInboundNatRuleConfig.md) - -[Remove-AzureRmLoadBalancerInboundNatRuleConfig](./Remove-AzureRmLoadBalancerInboundNatRuleConfig.md) - -[Set-AzureRmLoadBalancerInboundNatRuleConfig](./Set-AzureRmLoadBalancerInboundNatRuleConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmLoadBalancerOutboundRuleConfig.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmLoadBalancerOutboundRuleConfig.md deleted file mode 100644 index d1889a9061..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmLoadBalancerOutboundRuleConfig.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermloadbalanceroutboundruleconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmLoadBalancerOutboundRuleConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmLoadBalancerOutboundRuleConfig.md ---- - -# Get-AzureRmLoadBalancerOutboundRuleConfig - -## SYNOPSIS -Gets an outbound rule configuration in a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmLoadBalancerOutboundRuleConfig -LoadBalancer <PSLoadBalancer> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmLoadBalancerOutboundRuleConfig** cmdlet gets an outbound rule configuration or a list of outbound rule configurations in a load balancer. - -## EXAMPLES - -### Example 1: Get an outbound rule configuration in a load balancer -```powershell -PS C:\>$slb = Get-AzureRmLoadBalancer -ResourceGroupName "MyResourceGroup" -Name "MyLoadBalancer" -PS C:\>Get-AzureRmLoadBalancerOutboundRuleConfig -LoadBalancer $slb -Name "MyRule" -``` - -The first command gets the load balancer named MyLoadBalancer, and then stores it in the variable $slb. -The second command gets the outbound rule configuration named MyRule associated with that load balancer. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancer -The reference of the load balancer resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the outbound rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSOutboundRule - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmLoadBalancerProbeConfig.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmLoadBalancerProbeConfig.md deleted file mode 100644 index 960067ed2b..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmLoadBalancerProbeConfig.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 278228EB-0126-4F27-A30F-51DC498C65FE -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermloadbalancerprobeconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmLoadBalancerProbeConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmLoadBalancerProbeConfig.md ---- - -# Get-AzureRmLoadBalancerProbeConfig - -## SYNOPSIS -Gets a probe configuration for a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmLoadBalancerProbeConfig -LoadBalancer <PSLoadBalancer> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmLoadBalancerProbeConfig** cmdlet gets one or more probe configurations for a load balancer. - -## EXAMPLES - -### Example 1: Get the probe configuration of a load balancer -``` -PS C:\>$slb = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -PS C:\> Get-AzureRmLoadBalancerProbeConfig -Name "MyProbe" -LoadBalancer $slb -``` - -The first command gets the load balancer named MyLoadBalancer, and then stores it in the variable $slb. -The second command gets the associated probe configuration named MyProbe from the load balancer in $slb. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancer -Specifies the load balancer that is associated with the probe configuration to get. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the probe configuration to get. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameters: LoadBalancer (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSProbe - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerProbeConfig](./Add-AzureRmLoadBalancerProbeConfig.md) - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[New-AzureRmLoadBalancerProbeConfig](./New-AzureRmLoadBalancerProbeConfig.md) - -[Remove-AzureRmLoadBalancerProbeConfig](./Remove-AzureRmLoadBalancerProbeConfig.md) - -[Set-AzureRmLoadBalancerProbeConfig](./Set-AzureRmLoadBalancerProbeConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmLoadBalancerRuleConfig.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmLoadBalancerRuleConfig.md deleted file mode 100644 index bc4179cae0..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmLoadBalancerRuleConfig.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: B2CF11FC-520C-4C14-9A1B-13F06B250B5D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermloadbalancerruleconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmLoadBalancerRuleConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmLoadBalancerRuleConfig.md ---- - -# Get-AzureRmLoadBalancerRuleConfig - -## SYNOPSIS -Gets the rule configuration for a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmLoadBalancerRuleConfig -LoadBalancer <PSLoadBalancer> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmLoadBalancerRuleConfig** cmdlet gets one or more rule configurations for a load balancer. - -## EXAMPLES - -### Example 1: Get the rule configuration of a load balancer -``` -PS C:\>$slb = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -PS C:\> Get-AzureRmLoadBalancerRuleConfig -Name "MyLBrulename" -LoadBalancer $slb -``` - -The first command gets the load balancer named MyLoadBalancer, and then stores it in the variable $slb. -The second command gets the associated rule configuration named MyLBrulename from the load balancer in $slb. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancer -Specifies the load balancer that is associated with the rule configuration to get. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the rule configuration to get. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameters: LoadBalancer (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancingRule - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerRuleConfig](./Add-AzureRmLoadBalancerRuleConfig.md) - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[Remove-AzureRmLoadBalancerRuleConfig](./Remove-AzureRmLoadBalancerRuleConfig.md) - -[Set-AzureRmLoadBalancerRuleConfig](./Set-AzureRmLoadBalancerRuleConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmLocalNetworkGateway.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmLocalNetworkGateway.md deleted file mode 100644 index b9010e0f45..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmLocalNetworkGateway.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: F8756DA1-7BB9-4CD5-9D81-E11FF7A26125 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermlocalnetworkgateway -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmLocalNetworkGateway.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmLocalNetworkGateway.md ---- - -# Get-AzureRmLocalNetworkGateway - -## SYNOPSIS -Gets a Local Network Gateway - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmLocalNetworkGateway [-Name <String>] -ResourceGroupName <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Local Network Gateway is the object representing your VPN device On-Premises. -The **Get-AzureRmLocalNetworkGateway** cmdlet returns the object representing your on-prem gateway based on Name and Resource Group Name. - -## EXAMPLES - -### 1: Get a Local Network Gateway -``` -Get-AzureRmLocalNetworkGateway -Name myLocalGW -ResourceGroupName myRG -``` - -Returns the object of the Local Network Gateway with the name "myLocalGW" within the resource group "myRG" - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLocalNetworkGateway - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkInterface.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkInterface.md deleted file mode 100644 index c8d04e7588..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkInterface.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: E066BBFA-2E03-431D-85D1-99F230B6AC59 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermnetworkinterface -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmNetworkInterface.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmNetworkInterface.md ---- - -# Get-AzureRmNetworkInterface - -## SYNOPSIS -Gets a network interface. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NoExpandStandAloneNic (Default) -``` -Get-AzureRmNetworkInterface [-Name <String>] [-ResourceGroupName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ExpandStandAloneNic -``` -Get-AzureRmNetworkInterface -Name <String> -ResourceGroupName <String> -ExpandResource <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### NoExpandScaleSetNic -``` -Get-AzureRmNetworkInterface [-Name <String>] -ResourceGroupName <String> [-VirtualMachineScaleSetName <String>] - [-VirtualMachineIndex <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ExpandScaleSetNic -``` -Get-AzureRmNetworkInterface -Name <String> -ResourceGroupName <String> -VirtualMachineScaleSetName <String> - -VirtualMachineIndex <String> -ExpandResource <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmNetworkInterface** cmdlet gets an Azure network interface or a list of Azure network interfaces in a resource group. - -## EXAMPLES - -### Example 1: Get all network interfaces -``` -PS C:\>Get-AzureRmNetworkInterface -``` - -This command gets all network interfaces for the current subscription. - -### Example 2: Get all network interfaces with a specific provisioning state -``` -PS C:\>Get-AzureRmNetworkInterface -ResourceGroupName "ResourceGroup1" | Where-Object {$_.ProvisioningState -eq 'Succeeded'} -``` - -This command gets all network interfaces in the resource group named ResourceGroup1 that has a provisioning state of succeeded. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpandResource -```yaml -Type: System.String -Parameter Sets: ExpandStandAloneNic, ExpandScaleSetNic -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network interface that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: NoExpandStandAloneNic, NoExpandScaleSetNic -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ExpandStandAloneNic, ExpandScaleSetNic -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group from which this cmdlet gets network interfaces. - -```yaml -Type: System.String -Parameter Sets: NoExpandStandAloneNic -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ExpandStandAloneNic, NoExpandScaleSetNic, ExpandScaleSetNic -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineIndex -Specifies the virtual machine index of the virtual machine scale set from which this cmdlet gets network interfaces. - -```yaml -Type: System.String -Parameter Sets: NoExpandScaleSetNic -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ExpandScaleSetNic -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSetName -Specifies the name of the virtual machine scale set from which this cmdlet gets network interfaces. - -```yaml -Type: System.String -Parameter Sets: NoExpandScaleSetNic -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ExpandScaleSetNic -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface - -## NOTES - -## RELATED LINKS - -[New-AzureRmNetworkInterface](./New-AzureRmNetworkInterface.md) - -[Remove-AzureRmNetworkInterface](./Remove-AzureRmNetworkInterface.md) - -[Set-AzureRmNetworkInterface](./Set-AzureRmNetworkInterface.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkInterfaceIpConfig.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkInterfaceIpConfig.md deleted file mode 100644 index 6f208f7dee..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkInterfaceIpConfig.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 1B39809C-90DA-4ECB-B949-D4A9A54ED982 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermnetworkinterfaceipconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmNetworkInterfaceIpConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmNetworkInterfaceIpConfig.md ---- - -# Get-AzureRmNetworkInterfaceIpConfig - -## SYNOPSIS -Gets a network interface IP configuration for a network interface. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmNetworkInterfaceIpConfig [-Name <String>] -NetworkInterface <PSNetworkInterface> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmNetworkInterfaceIPConfig** cmdlet gets a network interface IP configuration from an Azure network interface. - -## EXAMPLES - -### 1: Get an IP configuration of a network interface -``` -$nic1 = Get-AzureRmNetworkInterface -Name mynic -ResourceGroupName $myrg -Get-AzureRmNetworkInterfaceIpConfig -Name ipconfig1 -NetworkInterface $nic1 -``` - -The first command gets an existing network interface called mynic and stores it in the variable $nic1. The second - command gets the IP configuration called ipconfig1 of this network interface. - - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network IP configuration that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkInterface -Specifies a **NetworkInterface** object that contains the network IP configuration that this cmdlet gets. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkInterface -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface -Parameters: NetworkInterface (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkInterfaceIPConfiguration - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Add-AzureRmNetworkInterfaceIpConfig](./Add-AzureRmNetworkInterfaceIpConfig.md) - -[New-AzureRmNetworkInterfaceIpConfig](./New-AzureRmNetworkInterfaceIpConfig.md) - -[Remove-AzureRmNetworkInterfaceIpConfig](./Remove-AzureRmNetworkInterfaceIpConfig.md) - -[Set-AzureRmNetworkInterfaceIpConfig](./Set-AzureRmNetworkInterfaceIpConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkInterfaceTapConfig.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkInterfaceTapConfig.md deleted file mode 100644 index 0f8e9a5bc9..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkInterfaceTapConfig.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermnetworkinterfacetapconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmNetworkInterfaceTapConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmNetworkInterfaceTapConfig.md ---- - -# Get-AzureRmNetworkInterfaceTapConfig - -## SYNOPSIS -Gets a Tap configuration resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetByNameParameterSet (Default) -``` -Get-AzureRmNetworkInterfaceTapConfig -ResourceGroupName <String> -NetworkInterfaceName <String> - [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### GetByResourceIdParameterSet -``` -Get-AzureRmNetworkInterfaceTapConfig -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmNetworkInterfaceTapConfig** cmdlet gets an Azure Tap Configuration for a given resource group, network interface and tap configuration name or list of tap configurations in a resource group and network interface. - -## EXAMPLES - -### Example 1: Get all tap configurations for a given network interface -``` -PS C:\>Get-AzureRmNetworkInterfaceTapConfig -ResourceGroupName "ResourceGroup1" -NetworkInterface "sourceNicName" -``` - -This command gets tap configurations added for the given network interface. - -### Example 2: Get a given tap configuration -``` -PS C:\>Get-AzureRmNetworkInterface -ResourceGroupName "ResourceGroup1" -NetworkInterface "sourceNicName" -Name "tapconfigName" -``` - -This command gets specific tap configuration added for the given network interface. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the specific tap configuration. - -```yaml -Type: System.String -Parameter Sets: GetByNameParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkInterfaceName -The Network Interface name. - -```yaml -Type: System.String -Parameter Sets: GetByNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: GetByNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -ResourceId of the TapConfiguration resource - -```yaml -Type: System.String -Parameter Sets: GetByResourceIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkInterfaceTapConfiguration - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkProfile.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkProfile.md deleted file mode 100644 index 4e7c990bd5..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkProfile.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermnetworkprofile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmNetworkProfile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmNetworkProfile.md ---- - -# Get-AzureRmNetworkProfile - -## SYNOPSIS -Gets an existing network profile top level resource - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NoExpand (Default) -``` -Get-AzureRmNetworkProfile [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetByResourceNameExpandParameterSet -``` -Get-AzureRmNetworkProfile -ResourceGroupName <String> -Name <String> -ExpandResource <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetByResourceNameNoExpandParameterSet -``` -Get-AzureRmNetworkProfile [-ResourceGroupName <String>] [-Name <String>] -ExpandResource <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetByResourceIdExpandParameterSet -``` -Get-AzureRmNetworkProfile -ResourceId <String> -ExpandResource <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetByResourceIdNoExpandParameterSet -``` -Get-AzureRmNetworkProfile -ResourceId <String> -ExpandResource <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmNetworkProfile** cmdlet retrieves an existing network profile top level resource - -## EXAMPLES - -### Example 1 -```powershell -$networkProfile = Get-AzureRmNetworkProfile -Name np1 -ResourceGroupName rg1 -``` - -This retrieves the network profile np1 in resource group rg1 - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpandResource -The resource reference to be expanded. - -```yaml -Type: System.String -Parameter Sets: GetByResourceNameExpandParameterSet, GetByResourceNameNoExpandParameterSet, GetByResourceIdExpandParameterSet, GetByResourceIdNoExpandParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The name of the network profile. - -```yaml -Type: System.String -Parameter Sets: GetByResourceNameExpandParameterSet -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: GetByResourceNameNoExpandParameterSet -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name of the network profile. - -```yaml -Type: System.String -Parameter Sets: GetByResourceNameExpandParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: GetByResourceNameNoExpandParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource manager id of the network profile. - -```yaml -Type: System.String -Parameter Sets: GetByResourceIdExpandParameterSet, GetByResourceIdNoExpandParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkProfile - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkSecurityGroup.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkSecurityGroup.md deleted file mode 100644 index 4ed7a5243e..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkSecurityGroup.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 5AECCBD7-1FDE-4217-9F59-36328062E669 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermnetworksecuritygroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmNetworkSecurityGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmNetworkSecurityGroup.md ---- - -# Get-AzureRmNetworkSecurityGroup - -## SYNOPSIS -Gets a network security group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NoExpand -``` -Get-AzureRmNetworkSecurityGroup [-Name <String>] [-ResourceGroupName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### Expand -``` -Get-AzureRmNetworkSecurityGroup -Name <String> -ResourceGroupName <String> -ExpandResource <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmNetworkSecurityGroup** cmdlet gets an Azure network security group. - -## EXAMPLES - -### 1: Retrieve an existing network security group -``` -Get-AzureRmNetworkSecurityGroup -Name nsg1 -ResourceGroupName "rg1" -``` - -This command returns contents of Azure network security group "nsg1" in resource group "rg1" - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpandResource -```yaml -Type: System.String -Parameter Sets: Expand -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network security group that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: NoExpand -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: Expand -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the network security group belongs to. - -```yaml -Type: System.String -Parameter Sets: NoExpand -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: Expand -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup - -## NOTES - -## RELATED LINKS - -[New-AzureRmNetworkSecurityGroup](./New-AzureRmNetworkSecurityGroup.md) - -[Remove-AzureRmNetworkSecurityGroup](./Remove-AzureRmNetworkSecurityGroup.md) - -[Set-AzureRmNetworkSecurityGroup](./Set-AzureRmNetworkSecurityGroup.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkSecurityRuleConfig.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkSecurityRuleConfig.md deleted file mode 100644 index 2bde238349..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkSecurityRuleConfig.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 5A0D9326-3A8A-4156-8372-EBA93C1BB4E4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermnetworksecurityruleconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmNetworkSecurityRuleConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmNetworkSecurityRuleConfig.md ---- - -# Get-AzureRmNetworkSecurityRuleConfig - -## SYNOPSIS -Get a network security rule configuration for a network security group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmNetworkSecurityRuleConfig [-Name <String>] -NetworkSecurityGroup <PSNetworkSecurityGroup> - [-DefaultRules] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmNetworkSecurityRuleConfig** cmdlet gets a network security rule configuration for an Azure network security group. - -## EXAMPLES - -### 1: Retrieving a network security rule config -``` -Get-AzureRmNetworkSecurityGroup -Name nsg1 -ResourceGroupName rg1 - | Get-AzureRmNetworkSecurityRuleConfig -Name AllowInternetOutBound -DefaultRules -``` - -This command retrieves the default rule named "AllowInternetOutBound" from Azure network security group named "nsg1" in resource group "rg1" - -### 2: Retrieving a network security rule config using only the name -``` -Get-AzureRmNetworkSecurityGroup -Name nsg1 -ResourceGroupName rg1 - | Get-AzureRmNetworkSecurityRuleConfig -Name "rdp-rule" -``` - -This command retrieves user defined rule named "rdp-rule" from Azure network security group named "nsg1" in resource group "rg1" - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultRules -Indicates whether this cmdlet gets a user-created rule configuration or a default rule configuration. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network security rule configuration to get. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkSecurityGroup -Specifies a **NetworkSecurityGroup** object that contains the network security rule configuration to get. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup -Parameters: NetworkSecurityGroup (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSSecurityRule - -## NOTES - -## RELATED LINKS - -[Add-AzureRmNetworkSecurityRuleConfig](./Add-AzureRmNetworkSecurityRuleConfig.md) - -[New-AzureRmNetworkSecurityRuleConfig](./New-AzureRmNetworkSecurityRuleConfig.md) - -[Remove-AzureRmNetworkSecurityRuleConfig](./Remove-AzureRmNetworkSecurityRuleConfig.md) - -[Set-AzureRmNetworkSecurityRuleConfig](./Set-AzureRmNetworkSecurityRuleConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkUsage.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkUsage.md deleted file mode 100644 index 993964aba6..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkUsage.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermnetworkusage -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmNetworkUsage.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmNetworkUsage.md ---- - -# Get-AzureRmNetworkUsage - -## SYNOPSIS -Lists network usages for a subscription - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmNetworkUsage -Location <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmNetworkUsage cmdlet gets limits and current usage for Network resources. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmNetworkUsage -Location westcentralus - -ResourceType : Virtual Networks -CurrentValue : 6 -Limit : 50 - -ResourceType : Static Public IP Addresses -CurrentValue : 1 -Limit : 20 - -ResourceType : Network Security Groups -CurrentValue : 2 -Limit : 100 - -ResourceType : Public IP Addresses -CurrentValue : 6 -Limit : 60 - -ResourceType : Network Interfaces -CurrentValue : 1 -Limit : 300 - -ResourceType : Load Balancers -CurrentValue : 1 -Limit : 100 - -ResourceType : Application Gateways -CurrentValue : 1 -Limit : 50 - -ResourceType : Route Tables -CurrentValue : 0 -Limit : 100 - -ResourceType : Route Filters -CurrentValue : 0 -Limit : 1000 - -ResourceType : Network Watchers -CurrentValue : 1 -Limit : 1 - -ResourceType : Packet Captures -CurrentValue : 0 -Limit : 10 -``` - -Gets resources usage data in westcentralus region - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The location where resource usage is queried. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSUsage - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcher.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcher.md deleted file mode 100644 index 24fabddb71..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcher.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermnetworkwatcher -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmNetworkWatcher.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmNetworkWatcher.md ---- - -# Get-AzureRmNetworkWatcher - -## SYNOPSIS -Gets the properties of a Network Watcher - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Get -``` -Get-AzureRmNetworkWatcher -Name <String> -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### List -``` -Get-AzureRmNetworkWatcher [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### SetByLocation -``` -Get-AzureRmNetworkWatcher -Location <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmNetworkWatcher cmdlet gets one or more Azure Network Watcher resources. - -## EXAMPLES - -### Example 1: Get a Network Watcher -``` -Get-AzureRmNetworkWatcher -Name NetworkWatcher_westcentralus -ResourceGroup NetworkWatcherRG - -Name : NetworkWatcher_westcentralus -Id : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NetworkWatcherRG/providers/Microsoft.Network/networkWatchers/NetworkWatcher_westcentralus -Etag : W/"ac624778-0214-49b9-a04c-794863485fa6" -Location : westcentralus -Tags : -ProvisioningState : Succeeded -``` - -Gets the Network Watcher named NetworkWatcher_westcentralus in the resource group NetworkWatcherRG. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Location of the network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByLocation -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The network watcher name. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher - -## RELATED LINKS - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmNetworkWatcherProtocolConfiguration](./New-AzureRmNetworkWatcherProtocolConfiguration.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Test-AzureRmNetworkWatcherConnectivity](./Test-AzureRmNetworkWatcherConnectivity.md) - -[Stop-AzureRmNetworkWatcherConnectionMonitor](./Stop-AzureRmNetworkWatcherConnectionMonitor.md) - -[Start-AzureRmNetworkWatcherConnectionMonitor](./Start-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConnectionMonitor](./Set-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConfigFlowLog](./Set-AzureRmNetworkWatcherConfigFlowLog.md) - -[Remove-AzureRmNetworkWatcherConnectionMonitor](./Remove-AzureRmNetworkWatcherConnectionMonitor.md) - -[New-AzureRmNetworkWatcherConnectionMonitor](./New-AzureRmNetworkWatcherConnectionMonitor.md) - -[Get-AzureRmNetworkWatcherTroubleshootingResult](./Get-AzureRmNetworkWatcherTroubleshootingResult.md) - -[Get-AzureRMNetworkWatcherReachabilityReport](./Get-AzureRMNetworkWatcherReachabilityReport.md) - -[Get-AzureRmNetworkWatcherReachabilityProvidersList](./Get-AzureRmNetworkWatcherReachabilityProvidersList.md) - -[Get-AzureRmNetworkWatcherFlowLogStatus](./Get-AzureRmNetworkWatcherFlowLogStatus.md) - -[Get-AzureRmNetworkWatcherConnectionMonitorReport](./Get-AzureRmNetworkWatcherConnectionMonitorReport.md) - -[Get-AzureRmNetworkWatcherConnectionMonitor](./Get-AzureRmNetworkWatcherConnectionMonitor.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherConnectionMonitor.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherConnectionMonitor.md deleted file mode 100644 index 7c8db2d2b1..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherConnectionMonitor.md +++ /dev/null @@ -1,260 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermnetworkwatcher -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmNetworkWatcherConnectionMonitor.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmNetworkWatcherConnectionMonitor.md ---- - -# Get-AzureRmNetworkWatcherConnectionMonitor - -## SYNOPSIS -Returns connection monitor with specified name or the list of connection monitors - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByName (Default) -``` -Get-AzureRmNetworkWatcherConnectionMonitor -NetworkWatcherName <String> -ResourceGroupName <String> - [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -Get-AzureRmNetworkWatcherConnectionMonitor -NetworkWatcher <PSNetworkWatcher> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByLocation -``` -Get-AzureRmNetworkWatcherConnectionMonitor -Location <String> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResourceId -``` -Get-AzureRmNetworkWatcherConnectionMonitor -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmNetworkWatcherConnectionMonitor cmdlet returns the connection monitor with the specified name / resourceId or the list of connection monitors corresponding to the specified network watcher / location. - -## EXAMPLES - -### Example 1: Get connection monitor by name in the specified location -``` -PS C:\> Get-AzureRmNetworkWatcherConnectionMonitor -Location centraluseuap -Name cm - - -Name : cm -Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGro - ups/NetworkWatcherRG/providers/Microsoft.Network/networkWatcher - s/NetworkWatcher_centraluseuap/connectionMonitors/cm -Etag : W/"40961b58-e379-4204-a47b-0c477739b095" -ProvisioningState : Succeeded -Source : { - "ResourceId": "/subscriptions/96e68903-0a56-4819-9987-8d08ad6 - a1f99/resourceGroups/VarunRgCentralUSEUAP/providers/Microsoft.C - ompute/virtualMachines/irinavm", - "Port": 0 - } -Destination : { - "Address": "google.com", - "Port": 80 - } -MonitoringIntervalInSeconds : 60 -AutoStart : True -StartTime : 1/12/2018 7:19:28 PM -MonitoringStatus : Stopped -Location : centraluseuap -Type : Microsoft.Network/networkWatchers/connectionMonitors -Tags : { - "key1": "value1" - } -``` - -In this example we get connection monitor by name in the specified location. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Location of the network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByLocation -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The connection monitor name. - -```yaml -Type: System.String -Parameter Sets: SetByName, SetByResource, SetByLocation -Aliases: ConnectionMonitorName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID of the connection monitor. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameters: NetworkWatcher (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResult - -## NOTES -Keywords: azure, azurerm, arm, resource, connectivity, management, manager, network, networking, network watcher, connection monitor - -## RELATED LINKS - -[New-AzureRmNetworkWatcher]() - -[Get-AzureRmNetworkWatcher]() - -[Remove-AzureRmNetworkWatcher]() - -[Get-AzureRmNetworkWatcherNextHop]() - -[Get-AzureRmNetworkWatcherSecurityGroupView]() - -[Get-AzureRmNetworkWatcherTopology]() - -[Get-AzureRmNetworkWatcherTroubleshootingResult]() - -[New-AzureRmNetworkWatcherPacketCapture]() - -[New-AzureRmPacketCaptureFilterConfig]() - -[Get-AzureRmNetworkWatcherPacketCapture]() - -[Remove-AzureRmNetworkWatcherPacketCapture]() - -[Stop-AzureRmNetworkWatcherPacketCapture]() - -[Get-AzureRmNetworkWatcherConnectionMonitor]() - -[Get-AzureRmNetworkWatcherConnectionMonitorReport]() - -[Remove-AzureRmNetworkWatcherConnectionMonitor]() - -[Set-AzureRmNetworkWatcherConnectionMonitor]() - -[Stop-AzureRmNetworkWatcherConnectionMonitor]() - -[New-AzureRmNetworkWatcherConnectionMonitor]() - -[New-AzureRmNetworkWatcherProtocolConfiguration]() - -[Test-AzureRmNetworkWatcherIPFlow]() - -[Test-AzureRmNetworkWatcherConnectivity]() - -[Start-AzureRmNetworkWatcherResourceTroubleshooting]() - -[Start-AzureRmNetworkWatcherConnectionMonitor]() - -[Set-AzureRmNetworkWatcherConfigFlowLog]() - -[Get-AzureRMNetworkWatcherReachabilityReport]() - -[Get-AzureRmNetworkWatcherReachabilityProvidersList]() - -[Get-AzureRmNetworkWatcherFlowLogStatus]() diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherConnectionMonitorReport.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherConnectionMonitorReport.md deleted file mode 100644 index b3a5dbf072..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherConnectionMonitorReport.md +++ /dev/null @@ -1,430 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermnetworkwatcher -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmNetworkWatcherConnectionMonitorReport.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmNetworkWatcherConnectionMonitorReport.md ---- - -# Get-AzureRmNetworkWatcherConnectionMonitorReport - -## SYNOPSIS -Query a snapshot of the most recent connection states. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByName (Default) -``` -Get-AzureRmNetworkWatcherConnectionMonitorReport -NetworkWatcherName <String> -ResourceGroupName <String> - -Name <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -Get-AzureRmNetworkWatcherConnectionMonitorReport -NetworkWatcher <PSNetworkWatcher> -Name <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByLocation -``` -Get-AzureRmNetworkWatcherConnectionMonitorReport -Location <String> -Name <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResourceId -``` -Get-AzureRmNetworkWatcherConnectionMonitorReport -ResourceId <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByInputObject -``` -Get-AzureRmNetworkWatcherConnectionMonitorReport -InputObject <PSConnectionMonitorResult> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmNetworkWatcherConnectionMonitorReport cmdlet returns the report on the most recent connection states. - -## EXAMPLES - -### Example 1: Get the most recent connection snapshot of the connection monitor by name in the specified location -``` -PS C:\> Get-AzureRmNetworkWatcherConnectionMonitorReport -Location centraluseuap -Name cm - - -States : [ - { - "ConnectionState": "Reachable", - "StartTime": "2018-01-12T01:18:20Z", - "EvaluationState": "Completed", - "Hops": [ - { - "Type": "Source", - "Id": "1530e0f2-c9b7-4bc0-a205-cf7332cd8983", - "Address": "10.1.1.4", - "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP - /providers/Microsoft.Network/networkInterfaces/appNic0/ipConfigurations/ipconfig1", - "NextHopIds": [ - "b19b74b1-423d-4f0b-99cd-bcaed4d0b8a2" - ], - "Issues": [] - }, - { - "Type": "VirtualAppliance", - "Id": "b19b74b1-423d-4f0b-99cd-bcaed4d0b8a2", - "Address": "10.1.2.4", - "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP - /providers/Microsoft.Network/networkInterfaces/fwNic/ipConfigurations/ipconfig1", - "NextHopIds": [ - "80e46c56-2cf9-4106-8602-608a74832d41" - ], - "Issues": [] - }, - { - "Type": "VirtualAppliance", - "Id": "80e46c56-2cf9-4106-8602-608a74832d41", - "Address": "10.1.3.4", - "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP - /providers/Microsoft.Network/networkInterfaces/auNic/ipConfigurations/ipconfig1", - "NextHopIds": [ - "e17cf884-69db-43b8-9cd5-f920770a0dbe" - ], - "Issues": [] - }, - { - "Type": "VirtualNetwork", - "Id": "e17cf884-69db-43b8-9cd5-f920770a0dbe", - "Address": "10.1.4.4", - "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP - /providers/Microsoft.Network/networkInterfaces/dbNic0/ipConfigurations/ipconfig1", - "NextHopIds": [], - "Issues": [] - } - ] - }, - { - "ConnectionState": "Unreachable", - "StartTime": "2018-01-12T01:14:11Z", - "EvaluationState": "Completed", - "Hops": [ - { - "Type": "Source", - "Id": "b6251ff8-3d07-4fdf-98f8-04b168e1cf90", - "Address": "10.1.1.4", - "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP - /providers/Microsoft.Network/networkInterfaces/appNic0/ipConfigurations/ipconfig1", - "NextHopIds": [ - "de6d463b-47fb-4beb-afc4-d77782755313" - ], - "Issues": [ - { - "Origin": "Local", - "Severity": "Error", - "Type": "NetworkError", - "Context": [] - } - ] - }, - { - "Type": "VirtualAppliance", - "Id": "de6d463b-47fb-4beb-afc4-d77782755313", - "Address": "10.1.2.4", - "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP - /providers/Microsoft.Network/networkInterfaces/fwNic/ipConfigurations/ipconfig1", - "NextHopIds": [ - "0cbadb7e-cd99-4fa9-a832-eb4e0d112293" - ], - "Issues": [] - }, - { - "Type": "VirtualAppliance", - "Id": "0cbadb7e-cd99-4fa9-a832-eb4e0d112293", - "Address": "10.1.3.4", - "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP - /providers/Microsoft.Network/networkInterfaces/auNic/ipConfigurations/ipconfig1", - "NextHopIds": [ - "538005d1-994a-4350-9866-6985385beecf" - ], - "Issues": [] - }, - { - "Type": "VirtualNetwork", - "Id": "538005d1-994a-4350-9866-6985385beecf", - "Address": "10.1.4.4", - "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP - /providers/Microsoft.Network/networkInterfaces/dbNic0/ipConfigurations/ipconfig1", - "NextHopIds": [], - "Issues": [] - } - ] - }, - { - "ConnectionState": "Reachable", - "StartTime": "2018-01-11T23:54:05Z", - "EvaluationState": "Completed", - "Hops": [ - { - "Type": "Source", - "Id": "3dbec7e8-a37f-4acd-bc5f-86918fffba0e", - "Address": "10.1.1.4", - "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP - /providers/Microsoft.Network/networkInterfaces/appNic0/ipConfigurations/ipconfig1", - "NextHopIds": [ - "1a87cf61-1be6-4add-bba7-f84afbcf3726" - ], - "Issues": [] - }, - { - "Type": "VirtualAppliance", - "Id": "1a87cf61-1be6-4add-bba7-f84afbcf3726", - "Address": "10.1.2.4", - "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP - /providers/Microsoft.Network/networkInterfaces/fwNic/ipConfigurations/ipconfig1", - "NextHopIds": [ - "070c0740-308e-43ba-b72f-5d8d5a6537ec" - ], - "Issues": [] - }, - { - "Type": "VirtualAppliance", - "Id": "070c0740-308e-43ba-b72f-5d8d5a6537ec", - "Address": "10.1.3.4", - "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP - /providers/Microsoft.Network/networkInterfaces/auNic/ipConfigurations/ipconfig1", - "NextHopIds": [ - "760182e1-c88d-4cfc-a711-65e7e622a67a" - ], - "Issues": [] - }, - { - "Type": "VirtualNetwork", - "Id": "760182e1-c88d-4cfc-a711-65e7e622a67a", - "Address": "10.1.4.4", - "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP - /providers/Microsoft.Network/networkInterfaces/dbNic0/ipConfigurations/ipconfig1", - "NextHopIds": [], - "Issues": [] - } - ] - } - ] -``` - -In this example we query the most recent connection states of the specified connection monitor. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Connection monitor object. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResult -Parameter Sets: SetByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Location -Location of the network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByLocation -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The connection monitor name. - -```yaml -Type: System.String -Parameter Sets: SetByName, SetByResource, SetByLocation -Aliases: ConnectionMonitorName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID of the connection monitor. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameters: NetworkWatcher (ByValue) - -### System.String - -### Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResult -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorQueryResult - -## NOTES -Keywords: azure, azurerm, arm, resource, connectivity, management, manager, network, networking, network watcher, connection monitor - -## RELATED LINKS - -[New-AzureRmNetworkWatcher]() - -[Get-AzureRmNetworkWatcher]() - -[Remove-AzureRmNetworkWatcher]() - -[Get-AzureRmNetworkWatcherNextHop]() - -[Get-AzureRmNetworkWatcherSecurityGroupView]() - -[Get-AzureRmNetworkWatcherTopology]() - -[Get-AzureRmNetworkWatcherTroubleshootingResult]() - -[New-AzureRmNetworkWatcherPacketCapture]() - -[New-AzureRmPacketCaptureFilterConfig]() - -[Get-AzureRmNetworkWatcherPacketCapture]() - -[Remove-AzureRmNetworkWatcherPacketCapture]() - -[Stop-AzureRmNetworkWatcherPacketCapture]() - -[Get-AzureRmNetworkWatcherConnectionMonitor]() - -[Get-AzureRmNetworkWatcherConnectionMonitorReport]() - -[Remove-AzureRmNetworkWatcherConnectionMonitor]() - -[Set-AzureRmNetworkWatcherConnectionMonitor]() - -[Stop-AzureRmNetworkWatcherConnectionMonitor]() - -[New-AzureRmNetworkWatcherConnectionMonitor]() - -[New-AzureRmNetworkWatcherProtocolConfiguration]() - -[Test-AzureRmNetworkWatcherIPFlow]() - -[Test-AzureRmNetworkWatcherConnectivity]() - -[Start-AzureRmNetworkWatcherResourceTroubleshooting]() - -[Start-AzureRmNetworkWatcherConnectionMonitor]() - -[Set-AzureRmNetworkWatcherConfigFlowLog]() - -[Get-AzureRMNetworkWatcherReachabilityReport]() - -[Get-AzureRmNetworkWatcherReachabilityProvidersList]() - -[Get-AzureRmNetworkWatcherFlowLogStatus]() diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherFlowLogStatus.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherFlowLogStatus.md deleted file mode 100644 index d802170324..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherFlowLogStatus.md +++ /dev/null @@ -1,269 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermnetworkwatcherflowlogstatus -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmNetworkWatcherFlowLogStatus.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmNetworkWatcherFlowLogStatus.md ---- - -# Get-AzureRmNetworkWatcherFlowLogStatus - -## SYNOPSIS -Gets the status of flow logging on a resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Get-AzureRmNetworkWatcherFlowLogStatus -NetworkWatcher <PSNetworkWatcher> -TargetResourceId <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByName -``` -Get-AzureRmNetworkWatcherFlowLogStatus -NetworkWatcherName <String> -ResourceGroupName <String> - -TargetResourceId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByLocation -``` -Get-AzureRmNetworkWatcherFlowLogStatus -Location <String> -TargetResourceId <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmNetworkWatcherFlowLogStatus cmdlet Gets the status of flow logging on a resource. -The status includes whether or not flow logging is enabled for the resource provided, the configured storage account to send logs, and the retention policy for the logs. -Currently Network Security Groups are supported for flow logging. - -## EXAMPLES - -### Example 1: Get the Flow Logging Status for a Specified NSG -``` -PS C:\> $NW = Get-AzurermNetworkWatcher -ResourceGroupName NetworkWatcherRg -Name NetworkWatcher_westcentralus -PS C:\> $nsg = Get-AzureRmNetworkSecurityGroup -ResourceGroupName NSGRG -Name appNSG - -PS C:\> Get-AzureRmNetworkWatcherFlowLogStatus -NetworkWatcher $NW -TargetResourceId $nsg.Id - -TargetResourceId : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NSGRG/providers/Microsoft.Network/networkSecurityGroups/appNSG -Properties : { - "Enabled": true, - "RetentionPolicy": { - "Days": 0, - "Enabled": false - }, - "StorageId": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NSGRG/providers/Microsoft.Storage/storageAccounts/contosostorageacct123" - } -``` - -In this example we get the flow logging status for a Network Security Group. The specified NSG has flow logging enabled, and no retention policy set. - -### Example 2: Get the Flow Logging and Traffic Analytics Status for a Specified NSG -``` -PS C:\> $NW = Get-AzurermNetworkWatcher -ResourceGroupName NetworkWatcherRg -Name NetworkWatcher_westcentralus -PS C:\> $nsg = Get-AzureRmNetworkSecurityGroup -ResourceGroupName NSGRG -Name appNSG - -PS C:\> Get-AzureRmNetworkWatcherFlowLogStatus -NetworkWatcher $NW -TargetResourceId $nsg.Id - -TargetResourceId : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NSGRG/providers/Microsoft.Network/networkSecurityGroups/appNSG -StorageId : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NSGRG/providers/Microsoft.Storage/storageAccounts/contosostorageacct123 -Enabled : True -RetentionPolicy : { - "Days": 0, - "Enabled": false - } -FlowAnalyticsConfiguration : { - "networkWatcherFlowAnalyticsConfiguration": { - "enabled": true, - "workspaceId": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb", - "workspaceRegion": "WorkspaceLocation", - "workspaceResourceId": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourcegroups/WorkspaceRg/providers/microsoft.operationalinsights/workspaces/WorkspaceName" - } - } -``` - -In this example we get the flow logging and Traffic Analytics status for a Network Security Group. The specified NSG has flow logging and Traffic Analytics enabled, and no retention policy set. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Location of the network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByLocation -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetResourceId -The target resource ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameters: NetworkWatcher (ByValue) - -### System.String -Parameters: NetworkWatcherName (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSFlowLog - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, watcher, flow, logs, flowlog, logging - -## RELATED LINKS - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmNetworkWatcherProtocolConfiguration](./New-AzureRmNetworkWatcherProtocolConfiguration.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Test-AzureRmNetworkWatcherConnectivity](./Test-AzureRmNetworkWatcherConnectivity.md) - -[Stop-AzureRmNetworkWatcherConnectionMonitor](./Stop-AzureRmNetworkWatcherConnectionMonitor.md) - -[Start-AzureRmNetworkWatcherConnectionMonitor](./Start-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConnectionMonitor](./Set-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConfigFlowLog](./Set-AzureRmNetworkWatcherConfigFlowLog.md) - -[Remove-AzureRmNetworkWatcherConnectionMonitor](./Remove-AzureRmNetworkWatcherConnectionMonitor.md) - -[New-AzureRmNetworkWatcherConnectionMonitor](./New-AzureRmNetworkWatcherConnectionMonitor.md) - -[Get-AzureRmNetworkWatcherTroubleshootingResult](./Get-AzureRmNetworkWatcherTroubleshootingResult.md) - -[Get-AzureRMNetworkWatcherReachabilityReport](./Get-AzureRMNetworkWatcherReachabilityReport.md) - -[Get-AzureRmNetworkWatcherReachabilityProvidersList](./Get-AzureRmNetworkWatcherReachabilityProvidersList.md) - -[Get-AzureRmNetworkWatcherFlowLogStatus](./Get-AzureRmNetworkWatcherFlowLogStatus.md) - -[Get-AzureRmNetworkWatcherConnectionMonitorReport](./Get-AzureRmNetworkWatcherConnectionMonitorReport.md) - -[Get-AzureRmNetworkWatcherConnectionMonitor](./Get-AzureRmNetworkWatcherConnectionMonitor.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherNextHop.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherNextHop.md deleted file mode 100644 index 5cccee3195..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherNextHop.md +++ /dev/null @@ -1,286 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermnetworkwatchernexthop -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmNetworkWatcherNextHop.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmNetworkWatcherNextHop.md ---- - -# Get-AzureRmNetworkWatcherNextHop - -## SYNOPSIS -Gets the next hop from a VM. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Get-AzureRmNetworkWatcherNextHop -NetworkWatcher <PSNetworkWatcher> -TargetVirtualMachineId <String> - -DestinationIPAddress <String> -SourceIPAddress <String> [-TargetNetworkInterfaceId <String>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByName -``` -Get-AzureRmNetworkWatcherNextHop -NetworkWatcherName <String> -ResourceGroupName <String> - -TargetVirtualMachineId <String> -DestinationIPAddress <String> -SourceIPAddress <String> - [-TargetNetworkInterfaceId <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByLocation -``` -Get-AzureRmNetworkWatcherNextHop -Location <String> -TargetVirtualMachineId <String> - -DestinationIPAddress <String> -SourceIPAddress <String> [-TargetNetworkInterfaceId <String>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmNetworkWatcherNextHop cmdlet gets the next hop from a VM. -Next hop allows you to view the type of Azure resource, the associated IP address of that resource, and the routing table rule that is responsible for the route. - -## EXAMPLES - -### Example 1: Get the Next Hop when communicating with an Internet IP -``` -$nw = Get-AzurermResource | Where {$_.ResourceType -eq "Microsoft.Network/networkWatchers" -and $_.Location -eq "WestCentralUS" } -$networkWatcher = Get-AzureRmNetworkWatcher -Name $nw.Name -ResourceGroupName $nw.ResourceGroupName -$VM = Get-AzurermVM -ResourceGroupName ContosoResourceGroup -Name VM0 -$Nics = Get-AzureRmNetworkInterface | Where {$_.Id -eq $vm.NetworkInterfaceIDs.ForEach({$_})} -Get-AzureRmNetworkWatcherNextHop -NetworkWatcher $networkWatcher -TargetVirtualMachineId $VM.Id -SourceIPAddress $nics[0].IpConfigurations[0].PrivateIpAddress -DestinationIPAddress 204.79.197.200 - - -NextHopIpAddress NextHopType RouteTableId ----------------- ----------- ------------ - Internet System Route -``` - -Get's the Next Hop for outbound communication from the primary Network Interface on the specified Virtual Vachine to 204.79.197.200 (www.bing.com) - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationIPAddress -Destination IP address. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Location of the network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByLocation -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceIPAddress -Source IP address. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetNetworkInterfaceId -Target network interface Id. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetVirtualMachineId -The target virtual machine ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameters: NetworkWatcher (ByValue) - -### System.String -Parameters: NetworkWatcherName (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNextHopResult - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, next, hop - -## RELATED LINKS - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmNetworkWatcherProtocolConfiguration](./New-AzureRmNetworkWatcherProtocolConfiguration.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Test-AzureRmNetworkWatcherConnectivity](./Test-AzureRmNetworkWatcherConnectivity.md) - -[Stop-AzureRmNetworkWatcherConnectionMonitor](./Stop-AzureRmNetworkWatcherConnectionMonitor.md) - -[Start-AzureRmNetworkWatcherConnectionMonitor](./Start-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConnectionMonitor](./Set-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConfigFlowLog](./Set-AzureRmNetworkWatcherConfigFlowLog.md) - -[Remove-AzureRmNetworkWatcherConnectionMonitor](./Remove-AzureRmNetworkWatcherConnectionMonitor.md) - -[New-AzureRmNetworkWatcherConnectionMonitor](./New-AzureRmNetworkWatcherConnectionMonitor.md) - -[Get-AzureRmNetworkWatcherTroubleshootingResult](./Get-AzureRmNetworkWatcherTroubleshootingResult.md) - -[Get-AzureRMNetworkWatcherReachabilityReport](./Get-AzureRMNetworkWatcherReachabilityReport.md) - -[Get-AzureRmNetworkWatcherReachabilityProvidersList](./Get-AzureRmNetworkWatcherReachabilityProvidersList.md) - -[Get-AzureRmNetworkWatcherFlowLogStatus](./Get-AzureRmNetworkWatcherFlowLogStatus.md) - -[Get-AzureRmNetworkWatcherConnectionMonitorReport](./Get-AzureRmNetworkWatcherConnectionMonitorReport.md) - -[Get-AzureRmNetworkWatcherConnectionMonitor](./Get-AzureRmNetworkWatcherConnectionMonitor.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherPacketCapture.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherPacketCapture.md deleted file mode 100644 index bcd8a08140..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherPacketCapture.md +++ /dev/null @@ -1,240 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermnetworkwatcherpacketcapture -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmNetworkWatcherPacketCapture.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmNetworkWatcherPacketCapture.md ---- - -# Get-AzureRmNetworkWatcherPacketCapture - -## SYNOPSIS -Gets information and properties and status of a packet capture resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Get-AzureRmNetworkWatcherPacketCapture -NetworkWatcher <PSNetworkWatcher> [-PacketCaptureName <String>] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByName -``` -Get-AzureRmNetworkWatcherPacketCapture -NetworkWatcherName <String> -ResourceGroupName <String> - [-PacketCaptureName <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByLocation -``` -Get-AzureRmNetworkWatcherPacketCapture -Location <String> [-PacketCaptureName <String>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmNetworkWatcherPacketCapture gets the properties and status of a packet capture resource. - -## EXAMPLES - -### Example 1: Create a Packet Capture with multiple filters and retrieve its status -``` -$nw = Get-AzurermResource | Where {$_.ResourceType -eq "Microsoft.Network/networkWatchers" -and $_.Location -eq "WestCentralUS" } -$networkWatcher = Get-AzureRmNetworkWatcher -Name $nw.Name -ResourceGroupName $nw.ResourceGroupName - -$storageAccount = Get-AzureRmStorageAccount -ResourceGroupName contosoResourceGroup -Name contosostorage123 - -$filter1 = New-AzureRmPacketCaptureFilterConfig -Protocol TCP -RemoteIPAddress "1.1.1.1-255.255.255" -LocalIPAddress "10.0.0.3" -LocalPort "1-65535" -RemotePort "20;80;443" -$filter2 = New-AzureRmPacketCaptureFilterConfig -Protocol UDP -New-AzureRmNetworkWatcherPacketCapture -NetworkWatcher $networkWatcher -TargetVirtualMachineId $vm.Id -PacketCaptureName "PacketCaptureTest" -StorageAccountId $storageAccount.id -TimeLimitInSeconds 60 -Filters $filter1, $filter2 - -Get-AzureRmNetworkWatcherPacketCapture -NetworkWatcher $networkWatcher -PacketCaptureName "PacketCaptureTest" -``` - -In this example we create a packet capture named "PacketCaptureTest" with multiple filters and a time limit. Once the session is complete, it will be saved to the specified storage account. -We then call Get-AzureRmNetworkWatcherPacketCapture to retrieve the status of the capture session. -Note: The Azure Network Watcher extension must be installed on the target virtual machine to create packet captures. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Location of the network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByLocation -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PacketCaptureName -The packet capture name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameters: NetworkWatcher (ByValue) - -### System.String -Parameters: NetworkWatcherName (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSGetPacketCaptureResult - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, packet, capture, traffic - -## RELATED LINKS - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmNetworkWatcherProtocolConfiguration](./New-AzureRmNetworkWatcherProtocolConfiguration.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Test-AzureRmNetworkWatcherConnectivity](./Test-AzureRmNetworkWatcherConnectivity.md) - -[Stop-AzureRmNetworkWatcherConnectionMonitor](./Stop-AzureRmNetworkWatcherConnectionMonitor.md) - -[Start-AzureRmNetworkWatcherConnectionMonitor](./Start-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConnectionMonitor](./Set-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConfigFlowLog](./Set-AzureRmNetworkWatcherConfigFlowLog.md) - -[Remove-AzureRmNetworkWatcherConnectionMonitor](./Remove-AzureRmNetworkWatcherConnectionMonitor.md) - -[New-AzureRmNetworkWatcherConnectionMonitor](./New-AzureRmNetworkWatcherConnectionMonitor.md) - -[Get-AzureRmNetworkWatcherTroubleshootingResult](./Get-AzureRmNetworkWatcherTroubleshootingResult.md) - -[Get-AzureRMNetworkWatcherReachabilityReport](./Get-AzureRMNetworkWatcherReachabilityReport.md) - -[Get-AzureRmNetworkWatcherReachabilityProvidersList](./Get-AzureRmNetworkWatcherReachabilityProvidersList.md) - -[Get-AzureRmNetworkWatcherFlowLogStatus](./Get-AzureRmNetworkWatcherFlowLogStatus.md) - -[Get-AzureRmNetworkWatcherConnectionMonitorReport](./Get-AzureRmNetworkWatcherConnectionMonitorReport.md) - -[Get-AzureRmNetworkWatcherConnectionMonitor](./Get-AzureRmNetworkWatcherConnectionMonitor.md) - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherReachabilityProvidersList.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherReachabilityProvidersList.md deleted file mode 100644 index 4581eb1da5..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherReachabilityProvidersList.md +++ /dev/null @@ -1,320 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermnetworkwatcherreachabilityproviderslist -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmNetworkWatcherReachabilityProvidersList.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmNetworkWatcherReachabilityProvidersList.md ---- - -# Get-AzureRmNetworkWatcherReachabilityProvidersList - -## SYNOPSIS -Lists all available internet service providers for a specified Azure region. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByName (Default) -``` -Get-AzureRmNetworkWatcherReachabilityProvidersList -NetworkWatcherName <String> -ResourceGroupName <String> - [-Location <System.Collections.Generic.List`1[System.String]>] [-Country <String>] [-State <String>] - [-City <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -Get-AzureRmNetworkWatcherReachabilityProvidersList -NetworkWatcher <PSNetworkWatcher> - [-Location <System.Collections.Generic.List`1[System.String]>] [-Country <String>] [-State <String>] - [-City <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByLocation -``` -Get-AzureRmNetworkWatcherReachabilityProvidersList -NetworkWatcherLocation <String> - [-Location <System.Collections.Generic.List`1[System.String]>] [-Country <String>] [-State <String>] - [-City <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResourceId -``` -Get-AzureRmNetworkWatcherReachabilityProvidersList -ResourceId <String> - [-Location <System.Collections.Generic.List`1[System.String]>] [-Country <String>] [-State <String>] - [-City <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmNetworkWatcherReachabilityProvidersList lists all available internet service providers for a specified Azure region. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $nw = Get-AzureRmNetworkWatcher -Name NetworkWatcher -ResourceGroupName NetworkWatcherRG -PS C:\> Get-AzureRmNetworkWatcherReachabilityProvidersList -NetworkWatcher $nw -Location "West US" -Country "United States" -State "washington" -City "seattle" - -"countries" : [ - { - "countryName" : "United States", - "states" : [ - { - "stateName" : "washington", - "cities" : [ - { - "cityName" : "seattle", - "providers" : [ - "Comcast Cable Communications, Inc. - ASN 7922", - "Comcast Cable Communications, LLC - ASN 7922", - "Level 3 Communications, Inc. (GBLX) - ASN 3549", - "Qwest Communications Company, LLC - ASN 209" - ] - } - ] - } - ] - } -] -``` - -Lists all available providers in Seattle, WA for Azure Data Center in West US. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -City -The name of the city. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Country -The name of the country. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Optional Azure regions to scope the query to. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherLocation -Location of the network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByLocation -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: ResourceName, Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The Id of network watcher resource. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -The name of the state. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameters: NetworkWatcher (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSAvailableProvidersList - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, next, hop - -## RELATED LINKS - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmNetworkWatcherProtocolConfiguration](./New-AzureRmNetworkWatcherProtocolConfiguration.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Test-AzureRmNetworkWatcherConnectivity](./Test-AzureRmNetworkWatcherConnectivity.md) - -[Stop-AzureRmNetworkWatcherConnectionMonitor](./Stop-AzureRmNetworkWatcherConnectionMonitor.md) - -[Start-AzureRmNetworkWatcherConnectionMonitor](./Start-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConnectionMonitor](./Set-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConfigFlowLog](./Set-AzureRmNetworkWatcherConfigFlowLog.md) - -[Remove-AzureRmNetworkWatcherConnectionMonitor](./Remove-AzureRmNetworkWatcherConnectionMonitor.md) - -[New-AzureRmNetworkWatcherConnectionMonitor](./New-AzureRmNetworkWatcherConnectionMonitor.md) - -[Get-AzureRmNetworkWatcherTroubleshootingResult](./Get-AzureRmNetworkWatcherTroubleshootingResult.md) - -[Get-AzureRMNetworkWatcherReachabilityReport](./Get-AzureRMNetworkWatcherReachabilityReport.md) - -[Get-AzureRmNetworkWatcherReachabilityProvidersList](./Get-AzureRmNetworkWatcherReachabilityProvidersList.md) - -[Get-AzureRmNetworkWatcherFlowLogStatus](./Get-AzureRmNetworkWatcherFlowLogStatus.md) - -[Get-AzureRmNetworkWatcherConnectionMonitorReport](./Get-AzureRmNetworkWatcherConnectionMonitorReport.md) - -[Get-AzureRmNetworkWatcherConnectionMonitor](./Get-AzureRmNetworkWatcherConnectionMonitor.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherSecurityGroupView.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherSecurityGroupView.md deleted file mode 100644 index 3c046f1b9c..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherSecurityGroupView.md +++ /dev/null @@ -1,232 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermnetworkwatchersecuritygroupview -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmNetworkWatcherSecurityGroupView.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmNetworkWatcherSecurityGroupView.md ---- - -# Get-AzureRmNetworkWatcherSecurityGroupView - -## SYNOPSIS -View the configured and effective network security group rules applied on a VM. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Get-AzureRmNetworkWatcherSecurityGroupView -NetworkWatcher <PSNetworkWatcher> -TargetVirtualMachineId <String> - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByName -``` -Get-AzureRmNetworkWatcherSecurityGroupView -NetworkWatcherName <String> -ResourceGroupName <String> - -TargetVirtualMachineId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByLocation -``` -Get-AzureRmNetworkWatcherSecurityGroupView -Location <String> -TargetVirtualMachineId <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmNetworkWatcherSecurityGroupView enables you to view the configured and effective network security group rules applied on a VM. - -## EXAMPLES - -### Example 1: Make a Security Group View call on a VM -``` -$nw = Get-AzurermResource | Where {$_.ResourceType -eq "Microsoft.Network/networkWatchers" -and $_.Location -eq "WestCentralUS" } -$networkWatcher = Get-AzureRmNetworkWatcher -Name $nw.Name -ResourceGroupName $nw.ResourceGroupName -$VM = Get-AzurermVM -ResourceGroupName ContosoResourceGroup -Name VM0 -Get-AzureRmNetworkWatcherSecurityGroupView -NetworkWatcher $networkWatcher -TargetVirtualMachineId $VM.Id -``` - -In the above example, we first get the regional Network Watcher, then a VM in the region. -Then we make a Security Group View call on the specified VM. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Location of the network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByLocation -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetVirtualMachineId -The target VM Id - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameters: NetworkWatcher (ByValue) - -### System.String -Parameters: NetworkWatcherName (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSSecurityGroupViewResult - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, flow, ip - -## RELATED LINKS - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmNetworkWatcherProtocolConfiguration](./New-AzureRmNetworkWatcherProtocolConfiguration.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Test-AzureRmNetworkWatcherConnectivity](./Test-AzureRmNetworkWatcherConnectivity.md) - -[Stop-AzureRmNetworkWatcherConnectionMonitor](./Stop-AzureRmNetworkWatcherConnectionMonitor.md) - -[Start-AzureRmNetworkWatcherConnectionMonitor](./Start-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConnectionMonitor](./Set-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConfigFlowLog](./Set-AzureRmNetworkWatcherConfigFlowLog.md) - -[Remove-AzureRmNetworkWatcherConnectionMonitor](./Remove-AzureRmNetworkWatcherConnectionMonitor.md) - -[New-AzureRmNetworkWatcherConnectionMonitor](./New-AzureRmNetworkWatcherConnectionMonitor.md) - -[Get-AzureRmNetworkWatcherTroubleshootingResult](./Get-AzureRmNetworkWatcherTroubleshootingResult.md) - -[Get-AzureRMNetworkWatcherReachabilityReport](./Get-AzureRMNetworkWatcherReachabilityReport.md) - -[Get-AzureRmNetworkWatcherReachabilityProvidersList](./Get-AzureRmNetworkWatcherReachabilityProvidersList.md) - -[Get-AzureRmNetworkWatcherFlowLogStatus](./Get-AzureRmNetworkWatcherFlowLogStatus.md) - -[Get-AzureRmNetworkWatcherConnectionMonitorReport](./Get-AzureRmNetworkWatcherConnectionMonitorReport.md) - -[Get-AzureRmNetworkWatcherConnectionMonitor](./Get-AzureRmNetworkWatcherConnectionMonitor.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherTopology.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherTopology.md deleted file mode 100644 index 2167b9a7d6..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherTopology.md +++ /dev/null @@ -1,308 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermnetworkwatchertopology -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmNetworkWatcherTopology.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmNetworkWatcherTopology.md ---- - -# Get-AzureRmNetworkWatcherTopology - -## SYNOPSIS -Gets a network level view of resources and their relationships in a resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Get-AzureRmNetworkWatcherTopology -NetworkWatcher <PSNetworkWatcher> -TargetResourceGroupName <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByName -``` -Get-AzureRmNetworkWatcherTopology -NetworkWatcherName <String> -ResourceGroupName <String> - -TargetResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByLocation -``` -Get-AzureRmNetworkWatcherTopology -Location <String> -TargetResourceGroupName <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmNetworkWatcherTopology cmdlet a network level view of resources and their relationships in a resource group. -Note: If resources from multiple regions reside in the resource group, only the resources in the same region as the Network Watcher will be included in the JSON output. - -## EXAMPLES - -### Example 1: Get an Azure Topology -``` -$networkWatcher = Get-AzureRmNetworkWatcher -Name NetworkWatcher_westcentralus -ResourceGroup NetworkWatcherRG -Get-AzureRmNetworkWatcherTopology -NetworkWatcher $networkWatcher -ResourceGroupName testresourcegroup - -Id : e33d80cf-4f76-4b8f-b51c-5bb8eba80103 -CreatedDateTime : 0/00/0000 9:21:51 PM -LastModified : 0/00/0000 4:53:29 AM -TopologyResources : [ - { - "Name": "testresourcegroup-vnet", - "Id": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/virtualNetworks/testresourcegroup-vnet", - "Location": "westcentralus", - "TopologyAssociations": [ - { - "Name": "default", - "ResourceId": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/virtualNetworks/testresourcegroup-vnet/subnets/default", - "AssociationType": "Contains" - } - ] - }, - { - "Name": "default", - "Id": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/virtualNetworks/testresourcegroup-vnet/subnets/default", - "Location": "westcentralus", - "TopologyAssociations": [] - }, - { - "Name": "VM0", - "Id": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Compute/virtualMachines/VM0", - "TopologyAssociations": [ - { - "Name": "vm0131", - "ResourceId": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/networkInterfaces/vm0131", - "AssociationType": "Contains" - } - ] - }, - { - "Name": "vm0131", - "Id": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/networkInterfaces/vm0131", - "Location": "westcentralus", - "TopologyAssociations": [ - { - "Name": "VM0", - "ResourceId": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Compute/virtualMachines/VM0", - "AssociationType": "Associated" - }, - { - "Name": "VM0-nsg", - "ResourceId": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/networkSecurityGroups/VM0-nsg", - "AssociationType": "Associated" - }, - { - "Name": "default", - "ResourceId": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/virtualNetworks/testresourcegroup-vnet/subnets/default", - "AssociationType": "Associated" - }, - { - "Name": "VM0-ip", - "ResourceId": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/publicIPAddresses/VM0-ip", - "AssociationType": "Associated" - } - ] - }, - { - "Name": "VM0-nsg", - "Id": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/networkSecurityGroups/VM0-nsg", - "Location": "westcentralus", - "TopologyAssociations": [ - { - "Name": "default-allow-rdp", - "ResourceId": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/networkSecurityGroups/VM0-nsg/securityRules/default-allow-rdp", - "AssociationType": "Contains" - } - ] - }, - { - "Name": "default-allow-rdp", - "Id": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/networkSecurityGroups/VM0-nsg/securityRules/default-allow-rdp", - "Location": "westcentralus", - "TopologyAssociations": [] - }, - { - "Name": "VM0-ip", - "Id": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/publicIPAddresses/VM0-ip", - "Location": "westcentralus", - "TopologyAssociations": [ - { - "Name": "vm0131", - "ResourceId": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/networkInterfaces/vm0131", - "AssociationType": "Associated" - } - ] - } - ] -``` - -In this example we run the Get-AzureRmNetworkWatcherTopology cmdlet on a resource group that contains a VM, Nic, NSG, and public IP. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Location of the network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByLocation -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameters: NetworkWatcher (ByValue) - -### System.String -Parameters: NetworkWatcherName (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSTopology - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, topology, view - -## RELATED LINKS - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmNetworkWatcherProtocolConfiguration](./New-AzureRmNetworkWatcherProtocolConfiguration.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Test-AzureRmNetworkWatcherConnectivity](./Test-AzureRmNetworkWatcherConnectivity.md) - -[Stop-AzureRmNetworkWatcherConnectionMonitor](./Stop-AzureRmNetworkWatcherConnectionMonitor.md) - -[Start-AzureRmNetworkWatcherConnectionMonitor](./Start-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConnectionMonitor](./Set-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConfigFlowLog](./Set-AzureRmNetworkWatcherConfigFlowLog.md) - -[Remove-AzureRmNetworkWatcherConnectionMonitor](./Remove-AzureRmNetworkWatcherConnectionMonitor.md) - -[New-AzureRmNetworkWatcherConnectionMonitor](./New-AzureRmNetworkWatcherConnectionMonitor.md) - -[Get-AzureRmNetworkWatcherTroubleshootingResult](./Get-AzureRmNetworkWatcherTroubleshootingResult.md) - -[Get-AzureRMNetworkWatcherReachabilityReport](./Get-AzureRMNetworkWatcherReachabilityReport.md) - -[Get-AzureRmNetworkWatcherReachabilityProvidersList](./Get-AzureRmNetworkWatcherReachabilityProvidersList.md) - -[Get-AzureRmNetworkWatcherFlowLogStatus](./Get-AzureRmNetworkWatcherFlowLogStatus.md) - -[Get-AzureRmNetworkWatcherConnectionMonitorReport](./Get-AzureRmNetworkWatcherConnectionMonitorReport.md) - -[Get-AzureRmNetworkWatcherConnectionMonitor](./Get-AzureRmNetworkWatcherConnectionMonitor.md) - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherTroubleshootingResult.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherTroubleshootingResult.md deleted file mode 100644 index 7891a6bc4a..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmNetworkWatcherTroubleshootingResult.md +++ /dev/null @@ -1,224 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermnetworkwatchertroubleshootingresult -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmNetworkWatcherTroubleshootingResult.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmNetworkWatcherTroubleshootingResult.md ---- - -# Get-AzureRmNetworkWatcherTroubleshootingResult - -## SYNOPSIS -Gets the troubleshooting result from the previously run or currently running troubleshooting operation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Get-AzureRmNetworkWatcherTroubleshootingResult -NetworkWatcher <PSNetworkWatcher> -TargetResourceId <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByName -``` -Get-AzureRmNetworkWatcherTroubleshootingResult -NetworkWatcherName <String> -ResourceGroupName <String> - -TargetResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByLocation -``` -Get-AzureRmNetworkWatcherTroubleshootingResult -Location <String> -TargetResourceId <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmNetworkWatcherTroubleshootingResult cmdlet gets the troubleshooting result from the previously run or currently running Start-AzureRmNetworkWatcherResourceTroubleshooting operation. -If the troubleshooting operation is currently in progress, then this operation may take a few minutes to complete. Currently Virtual Network Gateways and Connections are supported. - -## EXAMPLES - -### Example 1: Start Troubleshooting on a Virtual Network Gateway and Retrieve Result -``` -$nw = Get-AzurermResource | Where {$_.ResourceType -eq "Microsoft.Network/networkWatchers" -and $_.Location -eq "WestCentralUS" } -$networkWatcher = Get-AzureRmNetworkWatcher -Name $nw.Name -ResourceGroupName $nw.ResourceGroupName - -$target = '/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{vnetGatewayName}' -$storageId = '/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{storageAccountName}' -$storagePath = 'https://{storageAccountName}.blob.core.windows.net/troubleshoot' - -Start-AzureRmNetworkWatcherResourceTroubleshooting -NetworkWatcher $networkWatcher -TargetResourceId $target -StorageId $storageId -StoragePath $storagePath - -Get-AzureRmNetworkWatcherTroubleshootingResult -NetworkWatcher $NW -TargetResourceId $target -``` - -The above sample starts troubleshooting on a virtual network gateway. The operation may take a few minutes to complete. -After troubleshooting has started, a Get-AzureRmNetworkWatcherTroubleshootingResult call is made to the resource to retrieve the result of this call. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Location of the network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByLocation -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetResourceId -The target resource ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameters: NetworkWatcher (ByValue) - -### System.String -Parameters: NetworkWatcherName (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSTroubleshootingResult - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, troubleshoot, VPN, connection - -## RELATED LINKS - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmNetworkWatcherProtocolConfiguration](./New-AzureRmNetworkWatcherProtocolConfiguration.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Test-AzureRmNetworkWatcherConnectivity](./Test-AzureRmNetworkWatcherConnectivity.md) - -[Stop-AzureRmNetworkWatcherConnectionMonitor](./Stop-AzureRmNetworkWatcherConnectionMonitor.md) - -[Start-AzureRmNetworkWatcherConnectionMonitor](./Start-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConnectionMonitor](./Set-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConfigFlowLog](./Set-AzureRmNetworkWatcherConfigFlowLog.md) - -[Remove-AzureRmNetworkWatcherConnectionMonitor](./Remove-AzureRmNetworkWatcherConnectionMonitor.md) - -[New-AzureRmNetworkWatcherConnectionMonitor](./New-AzureRmNetworkWatcherConnectionMonitor.md) - -[Get-AzureRmNetworkWatcherTroubleshootingResult](./Get-AzureRmNetworkWatcherTroubleshootingResult.md) - -[Get-AzureRMNetworkWatcherReachabilityReport](./Get-AzureRMNetworkWatcherReachabilityReport.md) - -[Get-AzureRmNetworkWatcherReachabilityProvidersList](./Get-AzureRmNetworkWatcherReachabilityProvidersList.md) - -[Get-AzureRmNetworkWatcherFlowLogStatus](./Get-AzureRmNetworkWatcherFlowLogStatus.md) - -[Get-AzureRmNetworkWatcherConnectionMonitorReport](./Get-AzureRmNetworkWatcherConnectionMonitorReport.md) - -[Get-AzureRmNetworkWatcherConnectionMonitor](./Get-AzureRmNetworkWatcherConnectionMonitor.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmPublicIpAddress.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmPublicIpAddress.md deleted file mode 100644 index 5a33a7c47e..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmPublicIpAddress.md +++ /dev/null @@ -1,271 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 0CD03BF8-8DB6-44BC-91F0-D863949DBD17 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermpublicipaddress -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmPublicIpAddress.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmPublicIpAddress.md ---- - -# Get-AzureRmPublicIpAddress - -## SYNOPSIS -Gets a public IP address. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NoExpandStandAloneIp (Default) -``` -Get-AzureRmPublicIpAddress [-Name <String>] [-ResourceGroupName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ExpandStandAloneIp -``` -Get-AzureRmPublicIpAddress -Name <String> -ResourceGroupName <String> -ExpandResource <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### NoExpandScaleSetIp -``` -Get-AzureRmPublicIpAddress [-Name <String>] -ResourceGroupName <String> [-VirtualMachineScaleSetName <String>] - [-VirtualMachineIndex <String>] [-NetworkInterfaceName <String>] [-IpConfigurationName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ExpandScaleSetIp -``` -Get-AzureRmPublicIpAddress -Name <String> -ResourceGroupName <String> -VirtualMachineScaleSetName <String> - -VirtualMachineIndex <String> -NetworkInterfaceName <String> -IpConfigurationName <String> - -ExpandResource <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmPublicIPAddress** cmdlet gets one or more public IP addresses in a resource group. - -## EXAMPLES - -### 1: Get a public IP resource -``` -$publicIp = Get-AzureRmPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName -``` - -This command gets a public IP address resource with name $publicIPName in the resource group $rgName. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpandResource -```yaml -Type: System.String -Parameter Sets: ExpandStandAloneIp, ExpandScaleSetIp -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IpConfigurationName -Network Interface IP Configuration Name. - -```yaml -Type: System.String -Parameter Sets: NoExpandScaleSetIp -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ExpandScaleSetIp -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the public IP address that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: NoExpandStandAloneIp, NoExpandScaleSetIp -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ExpandStandAloneIp, ExpandScaleSetIp -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkInterfaceName -Virtual Machine Network Interface Name. - -```yaml -Type: System.String -Parameter Sets: NoExpandScaleSetIp -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ExpandScaleSetIp -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the public IP address that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: NoExpandStandAloneIp -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ExpandStandAloneIp, NoExpandScaleSetIp, ExpandScaleSetIp -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineIndex -Virtual Machine Index. - -```yaml -Type: System.String -Parameter Sets: NoExpandScaleSetIp -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ExpandScaleSetIp -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSetName -Virtual Machine Scale Set Name. - -```yaml -Type: System.String -Parameter Sets: NoExpandScaleSetIp -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ExpandScaleSetIp -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress - -## NOTES - -## RELATED LINKS - -[New-AzureRmPublicIpAddress](./New-AzureRmPublicIpAddress.md) - -[Remove-AzureRmPublicIpAddress](./Remove-AzureRmPublicIpAddress.md) - -[Set-AzureRmPublicIpAddress](./Set-AzureRmPublicIpAddress.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmPublicIpPrefix.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmPublicIpPrefix.md deleted file mode 100644 index 6b8b93932b..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmPublicIpPrefix.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermpublicipprefix -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmPublicIpPrefix.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmPublicIpPrefix.md ---- - -# Get-AzureRmPublicIpPrefix - -## SYNOPSIS -Gets a public IP prefix - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### (Default) -``` -Get-AzureRmPublicIpPrefix [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetByNameParameterSet -``` -Get-AzureRmPublicIpPrefix [-Name <String>] -ResourceGroupName <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetByResourceIdParameterSet -``` -Get-AzureRmPublicIpPrefix -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmPublicIpPrefix** cmdlet gets one or more public IP prefixes in a resource group. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> $publicIpPrefix = Get-AzureRmPublicIpPrefix -ResourceGroupName $rgname -Name $prefixName -``` - -This command gets a public IP prefix resource with $prefixName in resource group $rgName - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: String -Parameter Sets: GetByNameParameterSet -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: String -Parameter Sets: GetByNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The resource Id. - -```yaml -Type: String -Parameter Sets: GetByResourceIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSPublicIpPrefix - - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmRouteConfig.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmRouteConfig.md deleted file mode 100644 index 20a27de171..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmRouteConfig.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: DBD40431-DD7A-42CB-83AA-568B1065A468 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermrouteconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmRouteConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmRouteConfig.md ---- - -# Get-AzureRmRouteConfig - -## SYNOPSIS -Gets routes from a route table. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmRouteConfig -RouteTable <PSRouteTable> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRouteConfig** cmdlet gets routes from an Azure route table. -You can specify a route by name. - -## EXAMPLES - -### Example 1: Get a route table -``` -PS C:\>Get-AzureRmRouteTable -ResourceGroupName "ResourceGroup11" -Name "RouteTable01" | Get-AzureRmRouteConfig -Name "Route07" -Name : route07 -Id : -Etag : -ProvisioningState : -AddressPrefix : 10.1.0.0/16 -NextHopType : VnetLocal -NextHopIpAddress : -``` - -This command gets the route table named RouteTable01 by using the **Get-AzureRmRouteTable** cmdlet. -The command passes that table to the current cmdlet by using the pipeline operator. -The current cmdlet gets the route named Route07 in the route table named RouteTable01. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the route that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteTable -Specifies the route table from which this cmdlet gets routes. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSRouteTable -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteTable - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRoute - -## NOTES - -## RELATED LINKS - -[Add-AzureRmRouteConfig](./Add-AzureRmRouteConfig.md) - -[Get-AzureRmRouteTable](./Get-AzureRmRouteTable.md) - -[New-AzureRmRouteConfig](./New-AzureRmRouteConfig.md) - -[Remove-AzureRmRouteConfig](./Remove-AzureRmRouteConfig.md) - -[Set-AzureRmRouteConfig](./Set-AzureRmRouteConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmRouteFilter.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmRouteFilter.md deleted file mode 100644 index 6c5349d728..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmRouteFilter.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermroutefilter -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmRouteFilter.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmRouteFilter.md ---- - -# Get-AzureRmRouteFilter - -## SYNOPSIS -{{Fill in the Synopsis}} - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NoExpand -``` -Get-AzureRmRouteFilter [-Name <String>] [-ResourceGroupName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### Expand -``` -Get-AzureRmRouteFilter -Name <String> -ResourceGroupName <String> -ExpandResource <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -{{Fill in the Description}} - -## EXAMPLES - -### Example 1 -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpandResource -The resource reference to be expanded. - -```yaml -Type: System.String -Parameter Sets: Expand -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: System.String -Parameter Sets: NoExpand -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: Expand -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: NoExpand -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: Expand -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteFilter - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmRouteFilterRuleConfig.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmRouteFilterRuleConfig.md deleted file mode 100644 index bfae0df075..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmRouteFilterRuleConfig.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermroutefilterruleconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmRouteFilterRuleConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmRouteFilterRuleConfig.md ---- - -# Get-AzureRmRouteFilterRuleConfig - -## SYNOPSIS -{{Fill in the Synopsis}} - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmRouteFilterRuleConfig [-Name <String>] -RouteFilter <PSRouteFilter> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -{{Fill in the Description}} - -## EXAMPLES - -### Example 1 -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the route filter rule - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteFilter -The RouteFilter - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSRouteFilter -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteFilter -Parameters: RouteFilter (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteFilterRule - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmRouteTable.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmRouteTable.md deleted file mode 100644 index ed803a1123..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmRouteTable.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 4F487FCA-930D-4D56-8D28-7693312E1A01 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermroutetable -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmRouteTable.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmRouteTable.md ---- - -# Get-AzureRmRouteTable - -## SYNOPSIS -Gets route tables. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NoExpand (Default) -``` -Get-AzureRmRouteTable [-ResourceGroupName <String>] [-Name <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### Expand -``` -Get-AzureRmRouteTable -ResourceGroupName <String> -Name <String> -ExpandResource <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRouteTable** cmdlet gets Azure route tables. -You can get a single route table, or get all the route tables in a resource group or in your subscription. - -## EXAMPLES - -### Example 1: Get a route table -``` -PS C:\>Get-AzureRmRouteTable -ResourceGroupName "ResourceGroup11" -Name "RouteTable01" -Name : routetable01 -ResourceGroupName : ResourceGroup11 -Location : eastus -Id : /subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Microsoft.Networ - k/routeTables/routetable01 -Etag : W/"db5f4e12-3f34-465b-92dd-0ab3bf6fc274" -ProvisioningState : Succeeded -Tags : -Routes : [ - { - "Name": "route07", - "Etag": "W/\"db5f4e12-3f34-465b-92dd-0ab3bf6fc274\"", - "Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro - soft.Network/routeTables/routetable01/routes/route07", - "AddressPrefix": "10.1.0.0/16", - "NextHopType": "VnetLocal", - "NextHopIpAddress": null, - "ProvisioningState": "Succeeded" - } - ] -Subnets : [] -``` - -This command gets the route table named RouteTable01 in the resource group named ResourceGroup11. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpandResource -```yaml -Type: System.String -Parameter Sets: Expand -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the route table that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: NoExpand -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: Expand -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the route tables that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: NoExpand -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: Expand -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteTable - -## NOTES - -## RELATED LINKS - -[New-AzureRmRouteTable](./New-AzureRmRouteTable.md) - -[Remove-AzureRmRouteTable](./Remove-AzureRmRouteTable.md) - -[Set-AzureRmRouteTable](./Set-AzureRmRouteTable.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmServiceEndpointPolicy.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmServiceEndpointPolicy.md deleted file mode 100644 index 50f3b04f49..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmServiceEndpointPolicy.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermserviceendpointpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmServiceEndpointPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmServiceEndpointPolicy.md ---- - -# Get-AzureRmServiceEndpointPolicy - -## SYNOPSIS -{{Fill in the Synopsis}} - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmServiceEndpointPolicy -Name <String> -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmServiceEndpointPolicy** cmdlet gets a service endpoint policy. - -## EXAMPLES - -### Example 1 -``` -$policy = Get-AzureRmServiceEndpointPolicy -Name "ServiceEndpointPolicy1" -ResourceGroupName "ResourceGroup01" -``` - -This command gets the service endpoint policy named ServiceEndpointPolicy1 that belongs to the resource group named ResourceGroup01 and stores it in the $policy variable. - -### Example 2 -``` -$policyList = Get-AzureRmServiceEndpointPolicy -ResourceGroupName "ResourceGroup01" -``` - -This command gets a list of all the service endpoint policies in the resource group named ResourceGroup01 and stores it in the $policyList variable. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the service endpoint policy - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy - - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmServiceEndpointPolicyDefinition.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmServiceEndpointPolicyDefinition.md deleted file mode 100644 index d6eecf80c4..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmServiceEndpointPolicyDefinition.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermserviceendpointpolicydefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmServiceEndpointPolicyDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmServiceEndpointPolicyDefinition.md ---- - -# Get-AzureRmServiceEndpointPolicyDefinition - -## SYNOPSIS -{{Fill in the Synopsis}} - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmServiceEndpointPolicyDefinition [-Name <String>] -ServiceEndpointPolicy <PSServiceEndpointPolicy> - -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmServiceEndpointPolicyDefinition** cmdlet gets a service endpoint policy definition. - -## EXAMPLES - -### Example 1 -``` -$policydef= Get-AzureRmServiceEndpointPolicyDefinition -Name "ServiceEndpointPolicyDefinition1" -ServiceEndpointPolicy $Policy -``` - -This command gets the service endpoint policy definition named ServiceEndpointPolicyDefinition1 in ServiceEndpointPolicy $Policy stores it in the $policydef variable. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the service endpoint policy definition - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -{{Fill ResourceId Description}} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceEndpointPolicy -The Service endpoint policy - -```yaml -Type: PSServiceEndpointPolicy -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicyDefinition - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualHub.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualHub.md deleted file mode 100644 index 464405071b..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualHub.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvirtualhub -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualHub.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualHub.md ---- - -# Get-AzureRmVirtualHub - -## SYNOPSIS -Gets an Azure VirtualHub by Name and ResourceGroupName or lists all Virtual Hubs by ResourceGroupName/Subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ListBySubscriptionId (Default) -``` -Get-AzureRmVirtualHub [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ListByResourceGroupName -``` -Get-AzureRmVirtualHub -ResourceGroupName <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -Gets an Azure VirtualHub by Name and ResourceGroupName or lists all Virtual Hubs by ResourceGroupName/Subscription. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> $virtualWan = New-AzureRmVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" -PS C:\> New-AzureRmVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" -PS C:\> Get-AzureRmVirtualHub -ResourceGroupName "testRG" -Name "westushub" - -VirtualWan : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualWans/myVirtualWAN -ResourceGroupName : testRG -Name : westushub -Id : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub -AddressPrefix : 10.0.1.0/24 -RouteTable : -VirtualNetworkConnections : {} -Location : West US -Type : Microsoft.Network/virtualHubs -ProvisioningState : Succeeded -``` - -The above will create a resource group "testRG", a Virtual WAN and a Virtual Hub in West US in that resource group in Azure. The virtual hub will have the address space "10.0.1.0/24". - -It then gets the virtual hub using its ResourceGroupName and ResourceName. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: System.String -Parameter Sets: ListByResourceGroupName -Aliases: ResourceName, VirtualHubName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ListByResourceGroupName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualHub - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualHubVnetConnection.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualHubVnetConnection.md deleted file mode 100644 index c568282df1..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualHubVnetConnection.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvirtualhubvnetconnection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualHubVnetConnection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualHubVnetConnection.md ---- - -# Get-AzureRmVirtualHubVnetConnection - -## SYNOPSIS -Gets a Virtual Network Connection in a virtual hub or lists all virtual network connections in a virtual hub. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVirtualHubName (Default) -``` -Get-AzureRmVirtualHubVnetConnection -ResourceGroupName <String> -ParentResourceName <String> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByVirtualHubObject -``` -Get-AzureRmVirtualHubVnetConnection -ParentObject <PSVirtualHub> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByVirtualHubResourceId -``` -Get-AzureRmVirtualHubVnetConnection -ParentResourceId <String> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Gets a Virtual Network Connection in a virtual hub or lists all virtual network connections in a virtual hub. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> $frontendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" -PS C:\> $backendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name backendSubnet -AddressPrefix "10.0.2.0/24" -PS C:\> $remoteVirtualNetwork = New-AzureRmVirtualNetwork -Name "MyVirtualNetwork" -ResourceGroupName "testRG" -Location "West US" -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet,$backendSubnet - -PS C:\> $virtualWan = New-AzureRmVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" -PS C:\> New-AzureRmVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" -PS C:\> New-AzureRmVirtualHubVnetConnection -ResourceGroupName "testRG" -VirtualHubName "westushub" -Name "testvnetconnection" -RemoteVirtualNetwork $remoteVirtualNetwork - -PS C:\> Get-AzureRmVirtualHubVnetConnection -ResourceGroupName testRG -VirtualHubName westushub -Name testvnetconnection - -Name : testvnetconnection -Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/hubVirtualNetworkConnections/testvnetconnection -RemoteVirtualNetwork : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualNetworks/MyVirtualNetwork -ProvisioningState : Succeeded -``` - -The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub in Central US in that resource group in Azure. A Virtual Network Connection will be created thereafter which will peer the Virtual Network to the Virtual Hub. - -After the hub virtual network connection is created, it gets the hub virtual network connection using its resource group name, the hub name and the connection name. - -### Example 2 - -```powershell -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> $frontendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" -PS C:\> $backendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name backendSubnet -AddressPrefix "10.0.2.0/24" -PS C:\> $remoteVirtualNetwork = New-AzureRmVirtualNetwork -Name "MyVirtualNetwork" -ResourceGroupName "testRG" -Location "West US" -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet,$backendSubnet -PS C:\> $virtualWan = New-AzureRmVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" -PS C:\> New-AzureRmVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" -PS C:\> New-AzureRmVirtualHubVnetConnection -ResourceGroupName "testRG" -VirtualHubName "westushub" -Name "testvnetconnection" -RemoteVirtualNetwork $remoteVirtualNetwork -PS C:\> Get-AzureRmVirtualHubVnetConnection -ResourceGroupName testRG -VirtualHubName westushub - -Name : testvnetconnection -Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/hubVirtualNetworkConnections/testvnetconnection -RemoteVirtualNetwork : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualNetworks/MyVirtualNetwork -ProvisioningState : Succeeded -``` - -The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub in Central US in that resource group in Azure. A Virtual Network Connection will be created thereafter which will peer the Virtual Network to the Virtual Hub. - -After the hub virtual network connection is created, it lists all the hub virtual network connection using its resource group name and the hub name. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName, HubVirtualNetworkConnectionName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParentObject -The parent resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub -Parameter Sets: ByVirtualHubObject -Aliases: VirtualHub, ParentVirtualHub - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ParentResourceId -The parent resource id. - -```yaml -Type: System.String -Parameter Sets: ByVirtualHubResourceId -Aliases: VirtualHubId, ParentVirtualHubId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ParentResourceName -The parent resource name. - -```yaml -Type: System.String -Parameter Sets: ByVirtualHubName -Aliases: VirtualHubName, ParentVirtualHubName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByVirtualHubName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSHubVirtualNetworkConnection - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetwork.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetwork.md deleted file mode 100644 index 1f4f22c2d6..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetwork.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: CBDF4BCB-7EB3-4D64-B19C-1314D4AB84E4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvirtualnetwork -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualNetwork.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualNetwork.md ---- - -# Get-AzureRmVirtualNetwork - -## SYNOPSIS -Gets a virtual network in a resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NoExpand -``` -Get-AzureRmVirtualNetwork [-Name <String>] [-ResourceGroupName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### Expand -``` -Get-AzureRmVirtualNetwork -Name <String> -ResourceGroupName <String> -ExpandResource <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVirtualNetwork** cmdlet gets one or more virtual networks n a resource group. - -## EXAMPLES - -### 1: Retrieve a virtual network -``` -Get-AzureRmVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup -``` - -This command gets the virtual network named MyVirtualNetwork in the resource group TestResourceGroup - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpandResource -```yaml -Type: System.String -Parameter Sets: Expand -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual network that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: NoExpand -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: Expand -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that virtual network belongs to. - -```yaml -Type: System.String -Parameter Sets: NoExpand -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: Expand -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork - -## NOTES - -## RELATED LINKS - -[New-AzureRmVirtualNetwork](./New-AzureRmVirtualNetwork.md) - -[Remove-AzureRmVirtualNetwork](./Remove-AzureRmVirtualNetwork.md) - -[Set-AzureRmVirtualNetwork](./Set-AzureRmVirtualNetwork.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkAvailableEndpointService.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkAvailableEndpointService.md deleted file mode 100644 index 10a3ddc6ec..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkAvailableEndpointService.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvirtualnetworkavailableendpointservice -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualNetworkAvailableEndpointService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualNetworkAvailableEndpointService.md ---- - -# Get-AzureRmVirtualNetworkAvailableEndpointService - -## SYNOPSIS -Lists available endpoint services for location. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVirtualNetworkAvailableEndpointService -Location <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -Get-AzureRmVirtualNetworkAvailableEndpointService lists endpoint services available in the specified location. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmVirtualNetworkAvailableEndpointService -Location westus - --Name Id Type ------ -- ---- --Microsoft.Storage /subscriptions/id/providers/Microsoft.Network/virtualNetworkEndpointServices/Microsoft.Storage Microsoft.Network/virtualNetworkEndpointServices -``` - -Gets available endpoint services in westus region. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The location to retrieve the endpoint services from. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSEndpointServiceResult - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkGateway.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkGateway.md deleted file mode 100644 index d4efb259e7..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkGateway.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 9CBF592E-734B-4A0C-A45D-358C226D08C7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvirtualnetworkgateway -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualNetworkGateway.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualNetworkGateway.md ---- - -# Get-AzureRmVirtualNetworkGateway - -## SYNOPSIS -Gets a Virtual Network Gateway - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVirtualNetworkGateway [-Name <String>] -ResourceGroupName <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Virtual Network Gateway is the object representing your gateway in Azure. -The **Get-AzureRmVirtualNetworkGateway** cmdlet returns the object of your gateway in Azure based on Name and Resource Group Name. - -## EXAMPLES - -### 1: Get a Virtual Network Gateway -``` -Get-AzureRmVirtualNetworkGateway -Name myGateway -ResourceGroupName myRG -``` - -Returns the object of the Virtual Network Gateway with the name "myGateway" within the resource group "myRG" - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkGatewayAdvertisedRoute.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkGatewayAdvertisedRoute.md deleted file mode 100644 index ac0564fbc9..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkGatewayAdvertisedRoute.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvirtualnetworkgatewayadvertisedroute -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualNetworkGatewayAdvertisedRoute.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualNetworkGatewayAdvertisedRoute.md ---- - -# Get-AzureRmVirtualNetworkGatewayAdvertisedRoute - -## SYNOPSIS -Lists routes being advertised by an Azure virtual network gateway - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVirtualNetworkGatewayAdvertisedRoute -VirtualNetworkGatewayName <String> -ResourceGroupName <String> - -Peer <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Given the IP of a BGP peer, enumerates routes being advertised to that peer by the specified Azure virtual network gateway. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmVirtualNetworkGatewayAdvertisedRoute -VirtualNetworkGatewayName gatewayName -ResourceGroupName resourceGroupName -Peer 10.0.0.254 -``` - -For the Azure gateway named gatewayName in resource group resourceGroupName, retrives a list of routes being advertised to the BGP peer with IP 10.0.0.254 - -### Example 2 -``` -PS C:\> $bgpPeerStatus = Get-AzureRmVirtualNetworkGatewayBGPPeerStatus -VirtualNetworkGatewayName gatewayName -ResourceGroupName resourceGroupName -PS C:\> Get-AzureRmVirtualNetworkGatewayAdvertisedRoute -VirtualNetworkGatewayName gatewayName -ResourceGroupName resourceGroupName -Peer $bgpPeerStatus[0].Neighbor -``` - -For the Azure gateway named gatewayName in resource group resourceGroupName, retrieves routes being advertised to the first BGP peer on the gateway's list of BGP peers. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Peer -BGP peer's IP address. This should be an IP within the address space accessible from within the Azure virtual network the gateway is deployed in. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Virtual network gateway resource group's name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkGatewayName -Virtual network gateway name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSGatewayRoute - -## NOTES -This command is only applicable to Azure virtual network gateways with BGP enabled connections. - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkGatewayBGPPeerStatus.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkGatewayBGPPeerStatus.md deleted file mode 100644 index c52140a9db..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkGatewayBGPPeerStatus.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvirtualnetworkgatewaybgppeerstatus -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualNetworkGatewayBGPPeerStatus.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualNetworkGatewayBGPPeerStatus.md ---- - -# Get-AzureRmVirtualNetworkGatewayBGPPeerStatus - -## SYNOPSIS -Lists an Azure virtual network gateway's BGP peers - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVirtualNetworkGatewayBGPPeerStatus -VirtualNetworkGatewayName <String> -ResourceGroupName <String> - [-Peer <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -This command enumerates BGP peers an Azure virtual network gateway is configured to peer with. The status of each peer is also given. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmVirtualNetworkGatewayBgpPeerStatus -ResourceGroupName resourceGroup -VirtualNetworkGatewayName gatewayName - -Asn : 65515 -ConnectedDuration : 9.01:04:53.5768637 -LocalAddress : 10.1.0.254 -MessagesReceived : 14893 -MessagesSent : 14900 -Neighbor : 10.0.0.254 -RoutesReceived : 1 -State : Connected -``` - -Retrieves BGP peers for the Azure virtual network gateway named gatewayName in resource group resourceGroup. -This example output shows one connected BGP peer, with an IP of 10.0.0.254. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Peer -IP of the peer to retrieve status for - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Virtual network gateway resource group's name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkGatewayName -Virtual network gateway name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSBGPPeerStatus - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkGatewayConnection.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkGatewayConnection.md deleted file mode 100644 index 04b060339b..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkGatewayConnection.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 617FB2F9-05EA-4224-B9A9-2F00A7599486 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvirtualnetworkgatewayconnection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualNetworkGatewayConnection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualNetworkGatewayConnection.md ---- - -# Get-AzureRmVirtualNetworkGatewayConnection - -## SYNOPSIS -Gets a Virtual Network Gateway Connection - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVirtualNetworkGatewayConnection [-Name <String>] -ResourceGroupName <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Virtual Network Gateway Connection is the object representing the IPsec tunnel (Site-to-Site or Vnet-to-Vnet) connected to your Virtual Network Gateway in Azure. -The **Get-AzureRmVirtualNetworkGatewayConnection** cmdlet returns the object of your connection based on Name and Resource Group Name. - -## EXAMPLES - -### 1: Get a Virtual Network Gateway Connection -``` -Get-AzureRmVirtualNetworkGatewayConnection -Name myTunnel -ResourceGroupName myRG -``` - -Returns the object of the Virtual Network Gateway Connection with the name "myTunnel" within the resource group "myRG" - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayConnection - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkGatewayConnectionSharedKey.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkGatewayConnectionSharedKey.md deleted file mode 100644 index e3f27bc817..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkGatewayConnectionSharedKey.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: ECC5C079-C9A0-4159-A039-EE216897D686 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvirtualnetworkgatewayconnectionsharedkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualNetworkGatewayConnectionSharedKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualNetworkGatewayConnectionSharedKey.md ---- - -# Get-AzureRmVirtualNetworkGatewayConnectionSharedKey - -## SYNOPSIS -Displays the shared key used for the connection. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVirtualNetworkGatewayConnectionSharedKey [-Name <String>] -ResourceGroupName <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Displays the shared key used for the connection. - -## EXAMPLES - -### Example 1 -``` -Get-AzureRmVirtualNetworkGatewayConnectionSharedKey -Name 1 -ResourceGroupName P2SVPNGateway -xxxxxx -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkGatewayConnectionVpnDeviceConfigScript.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkGatewayConnectionVpnDeviceConfigScript.md deleted file mode 100644 index 8d003a473b..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkGatewayConnectionVpnDeviceConfigScript.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvirtualnetworkgatewayconnectionvpndeviceconfigscript -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualNetworkGatewayConnectionVpnDeviceConfigScript.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualNetworkGatewayConnectionVpnDeviceConfigScript.md ---- - -# Get-AzureRmVirtualNetworkGatewayConnectionVpnDeviceConfigScript - -## SYNOPSIS -This commandlet takes the connection resource, VPN device brand, model, firmware version, and return the corresponding configuration script that customers can apply directly on their on-premises VPN devices. The script will follow the syntax of the selected device, and fill in the necessary parameters such as Azure gateway public IP addresses, virtual network address prefixes, VPN tunnel pre-shared key, etc. so customers can simply copy-paste to their VPN device configurations. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVirtualNetworkGatewayConnectionVpnDeviceConfigScript -Name <String> -ResourceGroupName <String> - -DeviceVendor <String> -DeviceFamily <String> -FirmwareVersion <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -This commandlet takes the connection resource, VPN device brand, model, firmware version, and return the corresponding configuration script that customers can apply directly on their on-premises VPN devices. The script will follow the syntax of the selected device, and fill in the necessary parameters such as Azure gateway public IP addresses, virtual network address prefixes, VPN tunnel pre-shared key, etc. so customers can simply copy-paste to their VPN device configurations. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmVirtualNetworkGatewaySupportedVpnDevice -ResourceGroupName TestRG -Name TestGateway -PS C:\> Get-AzureRmVirtualNetworkGatewayConnectionVpnDeviceConfigScript -ResourceGroupName TestRG -Name TestConnection -DeviceVendor "Cisco-Test" -DeviceFamily "IOS-Test" -FirmwareVersion "20" -``` - -The above example uses Get-AzureRmVirtualNetworkGatewaySupportedVpnDevice to get the supported VPN Device brands, models, and firmware versions. -Then uses one of the returned models information to generate a VPN Device configuration script for the VirtualNetworkGatewayConnection "TestConnection". The device used in this example has DeviceFamily "IOS-Test", DeviceVendor "Cisco-Test" and FirmwareVersion 20. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeviceFamily -Name of the VPN device model/family. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DeviceVendor -Name of the VPN device vendor. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FirmwareVersion -Firmware version of the VPN device. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The resource name of the connection for which the configuration is to be generated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkGatewayLearnedRoute.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkGatewayLearnedRoute.md deleted file mode 100644 index c6399bd9f7..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkGatewayLearnedRoute.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvirtualnetworkgatewaylearnedroute -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualNetworkGatewayLearnedRoute.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualNetworkGatewayLearnedRoute.md ---- - -# Get-AzureRmVirtualNetworkGatewayLearnedRoute - -## SYNOPSIS -Lists routes learned by an Azure virtual network gateway - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVirtualNetworkGatewayLearnedRoute -VirtualNetworkGatewayName <String> -ResourceGroupName <String> - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Enumerates routes learned by an Azure virtual network gateway from various sources. This includes routes learned over BGP, as well as static routes. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmVirtualNetworkGatewayLearnedRoute -ResourceGroupName resourceGroup -VirtualNetworkGatewayname gatewayName - -AsPath : -LocalAddress : 10.1.0.254 -Network : 10.1.0.0/16 -NextHop : -Origin : Network -SourcePeer : 10.1.0.254 -Weight : 32768 - -AsPath : -LocalAddress : 10.1.0.254 -Network : 10.0.0.254/32 -NextHop : -Origin : Network -SourcePeer : 10.1.0.254 -Weight : 32768 - -AsPath : 65515 -LocalAddress : 10.1.0.254 -Network : 10.0.0.0/16 -NextHop : 10.0.0.254 -Origin : EBgp -SourcePeer : 10.0.0.254 -Weight : 32768 -``` - -For the Azure virtual network gateway named gatewayname in resource group resourceGroup, retrieves routes the Azure gateway knows. -The Azure virtual network gateway in this case has two static routes (10.1.0.0/16 and 10.0.0.254/32), as well as one route learned over BGP (10.0.0.0/16). - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Virtual network gateway resource group's name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkGatewayName -Virtual network gateway name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSGatewayRoute - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkGatewaySupportedVpnDevice.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkGatewaySupportedVpnDevice.md deleted file mode 100644 index bd6bcb5f2e..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkGatewaySupportedVpnDevice.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvirtualnetworkgatewaysupportedvpndevice -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualNetworkGatewaySupportedVpnDevice.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualNetworkGatewaySupportedVpnDevice.md ---- - -# Get-AzureRmVirtualNetworkGatewaySupportedVpnDevice - -## SYNOPSIS -This commandlet returns a list of supported VPN device brands, models, and firmware versions. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVirtualNetworkGatewaySupportedVpnDevice -Name <String> -ResourceGroupName <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -This commandlet returns a list of supported VPN device brands, models, and firmware versions. - -## EXAMPLES - -### Example 1 - -Returns list of supported VPN device brands, models and firmware versions: - -```powershell -Get-AzureRmVirtualNetworkGatewaySupportedVpnDevice -ResourceGroupName TestRG -Name TestGateway -``` - -```Output -<?xml version="1.0" encoding="utf-8"?> -<RpVpnDeviceList version="1.0"> - <Vendor name="Cisco-Test"> - <DeviceFamily name="IOS-Test"> - <FirmwareVersion name="20" /> - </DeviceFamily> - </Vendor> -</RpVpnDeviceList> -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The virtual network gateway name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkPeering.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkPeering.md deleted file mode 100644 index 733b18a18a..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkPeering.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 463DDBA8-0F93-483D-A4B6-3B055968CDE8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvirtualnetworkpeering -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualNetworkPeering.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualNetworkPeering.md ---- - -# Get-AzureRmVirtualNetworkPeering - -## SYNOPSIS -Gets the virtual network peering. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVirtualNetworkPeering -VirtualNetworkName <String> -ResourceGroupName <String> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVirtualNetworkPeering** cmdlet gets the virtual network peering. - -## EXAMPLES - -### Example 1: Get a peering between two virtual networks -``` -# Get virtual network peering named myVnet1TomyVnet2 located in myVirtualNetwork in the resource group named myResourceGroup. - -Get-AzureRmVirtualNetworkPeering -Name "myVnet1TomyVnet2" -VirtualNetwork "myVnet" -ResourceGroupName "myResourceGroup" -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the virtual network peering name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group name that the virtual network peering belongs to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkName -Specifies the virtual network name that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkPeering - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVirtualNetworkPeering](./Add-AzureRmVirtualNetworkPeering.md) - -[Remove-AzureRmVirtualNetworkPeering](./Remove-AzureRmVirtualNetworkPeering.md) - -[Set-AzureRmVirtualNetworkPeering](./Set-AzureRmVirtualNetworkPeering.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkSubnetConfig.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkSubnetConfig.md deleted file mode 100644 index 45f1738782..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkSubnetConfig.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 7688CE56-0A25-4409-9676-BF1B67C3F05F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvirtualnetworksubnetconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualNetworkSubnetConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualNetworkSubnetConfig.md ---- - -# Get-AzureRmVirtualNetworkSubnetConfig - -## SYNOPSIS -Gets a subnet in a virtual network. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVirtualNetworkSubnetConfig [-Name <String>] -VirtualNetwork <PSVirtualNetwork> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVirtualNetworkSubnetConfig** cmdlet gets one or more subnet configurations in an Azure virtual network. - -## EXAMPLES - -### 1: Get a subnet in a virtual network -``` -New-AzureRmResourceGroup -Name TestResourceGroup -Location centralus - $frontendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet - -AddressPrefix "10.0.1.0/24" - $virtualNetwork = New-AzureRmVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName - TestResourceGroup -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet - Get-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet -VirtualNetwork $virtualNetwork -``` - -This example creates a resource group and a virtual network with a single subnet in that resource group. It then retrieves data about that subnet. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the subnet configuration that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetwork -Specifies the **VirtualNetwork** object that contains the subnet configuration that this cmdlet gets. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSSubnet - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVirtualNetworkSubnetConfig](./Add-AzureRmVirtualNetworkSubnetConfig.md) - -[New-AzureRmVirtualNetworkSubnetConfig](./New-AzureRmVirtualNetworkSubnetConfig.md) - -[Remove-AzureRmVirtualNetworkSubnetConfig](./Remove-AzureRmVirtualNetworkSubnetConfig.md) - -[Set-AzureRmVirtualNetworkSubnetConfig](./Set-AzureRmVirtualNetworkSubnetConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkTap.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkTap.md deleted file mode 100644 index 7dd05a0dd7..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkTap.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvirtualnetworktap -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualNetworkTap.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualNetworkTap.md ---- - -# Get-AzureRmVirtualNetworkTap - -## SYNOPSIS -Gets a virtual network tap - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetByNameParameterSet (Default) -``` -Get-AzureRmVirtualNetworkTap -ResourceGroupName <String> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### GetByResourceIdParameterSet -``` -Get-AzureRmVirtualNetworkTap -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVirtualNetworkTap** cmdlet gets an Azure virtual network tap or a list of Azure virtual network taps in a resource group. - -## EXAMPLES - -### Example 1: Get a virtual network tap -``` -PS C:\>Get-AzureRmVirtualNetworkTap -ResourceGroupName "ResourceGroup1" -Name "VirtualTap1" -``` - -This command gets a VirtualNetwork tap reference for given "VirtualTap1" in "ResourceGroup1". - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the tap. - -```yaml -Type: System.String -Parameter Sets: GetByNameParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name of the virtual network tap. - -```yaml -Type: System.String -Parameter Sets: GetByNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -ResourceId of the VirtualNetworkTap resource - -```yaml -Type: System.String -Parameter Sets: GetByResourceIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkTap - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkUsageList.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkUsageList.md deleted file mode 100644 index 9012204152..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualNetworkUsageList.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvirtualnetworkusagelist -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualNetworkUsageList.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualNetworkUsageList.md ---- - -# Get-AzureRmVirtualNetworkUsageList - -## SYNOPSIS -Gets virtual network current usage. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVirtualNetworkUsageList -ResourceGroupName <String> -Name <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVirtualNetworkUsageList** cmdlet gets per subnet usage for the specified virtual network. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmVirtualNetworkUsageList -ResourceGroupName test -Name usagetest - -Get-AzureRmVirtualNetworkUsageList -ResourceGroupName test -Name usagetest - -Name : Subnet size and usage -Id : /subscriptions/sub1/resourceGroups/test/providers/Microsoft.Network/virtualNetworks/usagetest/subnets/subnet -CurrentValue : 1 -Limit : 65531 -Unit : Count - -Name : Subnet size and usage -Id : /subscriptions/sub1/resourceGroups/test/providers/Microsoft.Network/virtualNetworks/usagetest/subnets/subnet11 -CurrentValue : 0 -Limit : 251 -Unit : Count -``` - -Gets per subnet current values of usage for usagetest virtual network. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual network to show usages for. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that virtual network belongs to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkUsage - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualWan.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualWan.md deleted file mode 100644 index f677b6c164..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualWan.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvirtualwan -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualWan.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualWan.md ---- - -# Get-AzureRmVirtualWan - -## SYNOPSIS -Gets a Virtual WAN or all Virtual WANs in a resource group or subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ListBySubscriptionId (Default) -``` -Get-AzureRmVirtualWan [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ListByResourceGroupName -``` -Get-AzureRmVirtualWan -ResourceGroupName <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -Gets a Virtual WAN or all Virtual WANs in a resource group or subscription. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> New-AzureRmVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" -AllowBranchToBranchTraffic $true -PS C:\> Get-AzureRmVirtualWan -Name "myVirtualWAN" -ResourceGroupName "testRG" - -Name : testRG -Id : /subscriptions/{SubscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualWans/myVirtualWAN -AllowVnetToVnetTraffic : False -AllowBranchToBranchTraffic : True -Location : West US -Type : Microsoft.Network/virtualWans -ProvisioningState : Succeeded -``` - -This command gets the Virtual WAN named myVirtualWAN in the resource group testRG. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: System.String -Parameter Sets: ListByResourceGroupName -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ListByResourceGroupName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualWan - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualWanVpnConfiguration.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualWanVpnConfiguration.md deleted file mode 100644 index cf29230cf8..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVirtualWanVpnConfiguration.md +++ /dev/null @@ -1,264 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvirtualwanvpnconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualWanVpnConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualWanVpnConfiguration.md ---- - -# Get-AzureRmVirtualWanVpnConfiguration - -## SYNOPSIS -Gets the Vpn configuration for a subset of VpnSites connected to this WAN via VpnConnections. Uploads the generated Vpn -configuration to a storage blob specified by the customer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVirtualWanNameByVpnSiteObject (Default) -``` -Get-AzureRmVirtualWanVpnConfiguration -ResourceGroupName <String> -Name <String> -StorageSasUrl <String> - -VpnSite <PSVpnSite[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByVirtualWanNameByVpnSiteResourceId -``` -Get-AzureRmVirtualWanVpnConfiguration -ResourceGroupName <String> -Name <String> -StorageSasUrl <String> - -VpnSiteId <String[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByVirtualWanObjectByVpnSiteObject -``` -Get-AzureRmVirtualWanVpnConfiguration -InputObject <PSVirtualWan> -StorageSasUrl <String> - -VpnSite <PSVpnSite[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByVirtualWanObjectByVpnSiteResourceId -``` -Get-AzureRmVirtualWanVpnConfiguration -InputObject <PSVirtualWan> -StorageSasUrl <String> -VpnSiteId <String[]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByVirtualWanResourceIdByVpnSiteObject -``` -Get-AzureRmVirtualWanVpnConfiguration -ResourceId <String> -StorageSasUrl <String> -VpnSite <PSVpnSite[]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByVirtualWanResourceIdByVpnSiteResourceId -``` -Get-AzureRmVirtualWanVpnConfiguration -ResourceId <String> -StorageSasUrl <String> -VpnSiteId <String[]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Gets the Vpn configuration for a subset of VpnSites connected to this WAN via VpnConnections. Uploads the generated Vpn -configuration to a storage blob specified by the customer. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> $virtualWan = New-AzureRmVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" -PS C:\> $virtualHub = New-AzureRmVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" -PS C:\> New-AzureRmVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -BGPPeeringWeight 10 -VpnGatewayScaleUnit 2 -PS C:\> $vpnGateway = Get-AzureRmVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" - -PS C:\> $vpnSiteAddressSpaces = New-Object string[] 2 -PS C:\> $vpnSiteAddressSpaces[0] = "192.168.2.0/24" -PS C:\> $vpnSiteAddressSpaces[1] = "192.168.3.0/24" - -PS C:\> $vpnSite = New-AzureRmVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -Location "West US" -VirtualWan $virtualWan -IpAddress "1.2.3.4" -AddressSpace $vpnSiteAddressSpaces -DeviceModel "SomeDevice" -DeviceVendor "SomeDeviceVendor" -LinkSpeedInMbps "10" - -PS C:\> New-AzureRmVpnConnection -ResourceGroupName $vpnGateway.ResourceGroupName -ParentResourceName $vpnGateway.Name -Name "testConnection" -VpnSite $vpnSite - -PS C:\> $vpnSitesForConfig = New-Object Microsoft.Azure.Commands.Network.Models.PSVpnSite[] 1 -PS C:\> $vpnSitesForConfig[0] = $vpnSite -PS C:\> Get-AzureRmVirtualWanVpnConfiguration -VirtualWan $virtualWan -StorageSasUrl "SignedSasUrl" -VpnSite $vpnSitesForConfig - -SasUrl ------- -SignedSasUrl -``` - -The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub and a VpnSite in West US in "testRG" resource group in Azure. -A VPN gateway will be created thereafter in the Virtual Hub with 2 scale units. - -Once the gateway has been created, it is connected to the VpnSite using the New-AzureRmVpnConnection command. - -The configuration is then downloaded using this commandlet. - -If the commandlet is successful, then the download configuration will be written to the blob indicated by the SignedSasUrl. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The vpn site object to be modified - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualWan -Parameter Sets: ByVirtualWanObjectByVpnSiteObject, ByVirtualWanObjectByVpnSiteResourceId -Aliases: VirtualWan - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: System.String -Parameter Sets: ByVirtualWanNameByVpnSiteObject, ByVirtualWanNameByVpnSiteResourceId -Aliases: ResourceName, VirtualWanName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByVirtualWanNameByVpnSiteObject, ByVirtualWanNameByVpnSiteResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID for the virtual wan. - -```yaml -Type: System.String -Parameter Sets: ByVirtualWanResourceIdByVpnSiteObject, ByVirtualWanResourceIdByVpnSiteResourceId -Aliases: VirtualWanId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageSasUrl -The SAS Url for the storage location where the configuration is to be generated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VpnSite -The list of VpnSite resource ids to generate configuration for. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVpnSite[] -Parameter Sets: ByVirtualWanNameByVpnSiteObject, ByVirtualWanObjectByVpnSiteObject, ByVirtualWanResourceIdByVpnSiteObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VpnSiteId -The list of VpnSite resource ids to generate configuration for. - -```yaml -Type: System.String[] -Parameter Sets: ByVirtualWanNameByVpnSiteResourceId, ByVirtualWanObjectByVpnSiteResourceId, ByVirtualWanResourceIdByVpnSiteResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualWan - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualWanVpnSitesConfiguration - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVpnClientConfiguration.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVpnClientConfiguration.md deleted file mode 100644 index d3759007ef..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVpnClientConfiguration.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvpnclientconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVpnClientConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVpnClientConfiguration.md ---- - -# Get-AzureRmVpnClientConfiguration - -## SYNOPSIS -Allows users to easily download the Vpn Profile package that was generated using the New-AzureRmVpnClientConfiguration commandlet. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVpnClientConfiguration [-Name <String>] -ResourceGroupName <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmVpnClientConfiguration returns the URL where the VPN client can be downloaded from. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmVpnClientConfiguration -VirtualNetworkGatewayName "ContosoVirtualNetworkGateway" -ResourceGroupName "ContosoResourceGroup" -AuthenticationMethod "EAPTLS" -RadiusRootCert "C:\Users\Test\Desktop\VpnProfileRadiusCert.cer" - -PS C:\> Get-AzureRmVpnClientConfiguration -VirtualNetworkGatewayName "ContosoVirtualNetworkGateway" -ResourceGroupName "ContosoResourceGroup" -``` - -Gets the URL to download a VpnClient profile that has been previously generated using the New-AzureRMVpnClientConfiguration command. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVpnProfile - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVpnClientIpsecParameter.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVpnClientIpsecParameter.md deleted file mode 100644 index 941cb4efea..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVpnClientIpsecParameter.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvpnclientipsecparameter -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVpnClientIpsecParameter.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVpnClientIpsecParameter.md ---- - -# Get-AzureRmVpnClientIpsecParameter - -## SYNOPSIS -Gets the vpn Ipsec parameters set on Virtual Network Gateway for Point to site connections. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVpnClientIpsecParameter [-Name <String>] -ResourceGroupName <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Virtual Network Gateway is the object representing your gateway in Azure. -The **Get-AzureRmVpnClientIpsecParameter** cmdlet returns the object of your vpn ipsec parameters set on gateway in Azure based on Gateway Name and Resource Group Name. - -## EXAMPLES - -### 1: Gets the vpn Ipsec parameters set on Virtual Network Gateway for Point to site connections. -``` -PS C:\> $VpnClientIPsecParameters = Get-AzureRmVpnClientIpsecParameter -Name myGateway -ResourceGroupName myRG -``` - -Returns the object of the vpn ipsec parameters set on the Virtual Network Gateway with the name "myGateway" within the resource group "myRG" - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVpnClientIPsecParameters - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVpnClientPackage.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVpnClientPackage.md deleted file mode 100644 index 1a53669d18..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVpnClientPackage.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 2B4A3E2A-1868-492F-9F77-932319D2CE6D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvpnclientpackage -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVpnClientPackage.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVpnClientPackage.md ---- - -# Get-AzureRmVpnClientPackage - -## SYNOPSIS -Gets information about a VPN client package. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVpnClientPackage -ResourceGroupName <String> -VirtualNetworkGatewayName <String> - -ProcessorArchitecture <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVpnClientPackage** cmdlet gets information about the VPN client packages available from a virtual network gateway. -Client packages contain configuration data that enable a client computer to make a VPN connection to an Azure virtual network; client computers must have the correct configuration package installed in order to make a VPN connection. -Different configuration packages are available based on the client computer's version of Windows (for example, Windows 7 or Windows 10) and on the client computer's processor architecture (AMD64 or x86). -You must specify the architecture type when running **Get-AzureRmVpnClientPackage**. - -## EXAMPLES - -### Example 1: Get information about a processor architecture VPN client package -``` -PS C:\>Get-AzureRmVpnClientPackage -ProcessorArchitecture -VirtualNetworkGatewayName "ContosoVirtualNetworkGateway" -ResourceGroupName "ContosoResourceGroup" -ProcessorArchitecture "Amd64" -``` - -This command gets information about the AMD64 VPN client packages stored on the virtual network gateway named ContosoVirtualNetworkGateway. -To get information about the x86 client packages, set the value of the *ProcessorArchitecture* parameter to x86. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProcessorArchitecture -Specifies the type of CPU architecture that the client package is designed for. -Valid values are Amd64 and X86. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Amd64, X86 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the virtual network gateway is assigned to. -Resource groups categorize items to help simplify inventory management and general Azure administration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VirtualNetworkGatewayName -Specifies the name of the virtual network gateway where the client package information is stored. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: ResourceGroupName (ByValue), VirtualNetworkGatewayName (ByValue) - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Resize-AzureRmVirtualNetworkGateway](./Resize-AzureRmVirtualNetworkGateway.md) - -[Set-AzureRmVirtualNetworkGatewayVpnClientConfig](./Set-AzureRmVirtualNetworkGatewayVpnClientConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVpnClientRevokedCertificate.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVpnClientRevokedCertificate.md deleted file mode 100644 index f19786b911..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVpnClientRevokedCertificate.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 05626BF7-F886-4C76-8FC2-DDF783DEB539 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvpnclientrevokedcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVpnClientRevokedCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVpnClientRevokedCertificate.md ---- - -# Get-AzureRmVpnClientRevokedCertificate - -## SYNOPSIS -Gets information about VPN client-revocation certificates. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVpnClientRevokedCertificate [-VpnClientRevokedCertificateName <String>] - -VirtualNetworkGatewayName <String> -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVpnClientRevokedCertificate** cmdlet returns information about the client-revocation certificates assigned to a virtual network gateway. -Client-revocation certificates prevent client computers from using the specified certificate for authentication. -**Get-AzureRmVpnClientRevokedCertificate** enables you to return information about all the client-revocation certificates on the gateway or, by using the *VpnClientRevokedCertificateName* parameter, to get information about a single certificate. - -## EXAMPLES - -### Example 1: Get information about all client-revocation certificates -``` -PS C:\>Get-AzureRmVpnClientRevokedCertificate -VirtualNetworkGatewayName "ContosoVirtualNetworkGateway" -ResourceGroupName "ContosoResourceGroup" -``` - -This command gets information about all the client-revocation certificates associated with the virtual network gateway named ContosoVirtualNetworkGateway. - -### Example 2: Get information about specific client-revocation certificates -``` -PS C:\>Get-AzureRmVpnClientRevokedCertificate -VirtualNetworkGatewayName "ContosoVirtualNetwork" -ResourceGroupName "ContosoResourceGroup" -VpnClientRevokedCertificateName "ContosoRevokedClientCertificate" -``` - -This command is a variation of the command shown in Example 1. -In this case, however, the *VpnClientRevokedCertificateName* parameter is used to limit the returned data to a specific client-revoked certificate: the certificate with the name ContosoRevokedClientCertificate. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the virtual network gateway is assigned to. -Resource groups categorize items to help simplify inventory management and general Azure administration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkGatewayName -Specifies the name of the virtual network gateway where the revoked certificate information is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VpnClientRevokedCertificateName -Specifies the name of the VPN client certificate that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVpnClientRevokedCertificate](./Add-AzureRmVpnClientRevokedCertificate.md) - -[New-AzureRmVpnClientRevokedCertificate](./New-AzureRmVpnClientRevokedCertificate.md) - -[Remove-AzureRmVpnClientRevokedCertificate](./Remove-AzureRmVpnClientRevokedCertificate.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVpnClientRootCertificate.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVpnClientRootCertificate.md deleted file mode 100644 index df545d2f08..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVpnClientRootCertificate.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 16754F70-9619-4F68-86E9-5C8B27812707 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvpnclientrootcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVpnClientRootCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVpnClientRootCertificate.md ---- - -# Get-AzureRmVpnClientRootCertificate - -## SYNOPSIS -Gets information about VPN root certificates. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVpnClientRootCertificate [-VpnClientRootCertificateName <String>] - -VirtualNetworkGatewayName <String> -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVpnClientRootCertificate** cmdlet returns information about the root certificates assigned to a virtual network gateway. -Root certificates are X.509 certificates that identify your Root Certification Authority: all other certificates used on the gateway trust the root certificate. -By default, **Get-AzureRmVpnClientRootCertificate** returns information about all the root certificates assigned to a gateway. -(Gateways can have more than one root certificate.) However, by including the **VpnClientRootCertificateName** parameter you can limit the returned data to a specific certificate. - -## EXAMPLES - -### Example 1: Get information about all root certificates -``` -PS C:\>Get-AzureRmVpnClientRootCertificate -VirtualNetworkGatewayName "ContosoVirtualNetwork" -ResourceGroupName "ContosoResourceGroup" -``` - -This command gets information about all the root certificates assigned to a virtual network gateway named ContosoVirtualNetwork. - -### Example 2: Get information about specific root certificates -``` -PS C:\>Get-AzureRmVpnClientRootCertificate -VirtualNetworkGatewayName "ContosoVirtualNetwork" -ResourceGroupName "ContosoResourceGroup" -VpnClientRootCertificateName "ContosoRootClientCertificate" -``` - -This command is a variation of the command shown in Example 1. -In this case, however, the *VpnClientRootCertificateName* parameter is included in order to limit the returned data to a specific root certificate: ContosoRootClientCertificate. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the virtual network gateway is assigned to. -Resource groups categorize items to help simplify inventory management and general Azure administration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkGatewayName -Specifies the name of the virtual network gateway where the root certificate is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VpnClientRootCertificateName -Specifies the name of the client root certificate that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVpnClientRootCertificate](./Add-AzureRmVpnClientRootCertificate.md) - -[New-AzureRmVpnClientRootCertificate](./New-AzureRmVpnClientRootCertificate.md) - -[Remove-AzureRmVpnClientRootCertificate](./Remove-AzureRmVpnClientRootCertificate.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVpnConnection.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVpnConnection.md deleted file mode 100644 index ddbcf494a7..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVpnConnection.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvpnconnection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVpnConnection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVpnConnection.md ---- - -# Get-AzureRmVpnConnection - -## SYNOPSIS -Gets a vpn connection by name or lists all vpn connections connected to a VpnGateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVpnGatewayName (Default) -``` -Get-AzureRmVpnConnection -ResourceGroupName <String> -ParentResourceName <String> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByVpnGatewayObject -``` -Get-AzureRmVpnConnection -ParentObject <PSVpnGateway> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByVpnGatewayResourceId -``` -Get-AzureRmVpnConnection -ParentResourceId <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -Gets a vpn connection by name or lists all vpn connections connected to a VpnGateway. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> $virtualWan = New-AzureRmVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" -PS C:\> $virtualHub = New-AzureRmVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" -PS C:\> New-AzureRmVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -BGPPeeringWeight 10 -VpnGatewayScaleUnit 2 -PS C:\> $vpnGateway = Get-AzureRmVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" - -PS C:\> $vpnSiteAddressSpaces = New-Object string[] 2 -PS C:\> $vpnSiteAddressSpaces[0] = "192.168.2.0/24" -PS C:\> $vpnSiteAddressSpaces[1] = "192.168.3.0/24" - -PS C:\> $vpnSite = New-AzureRmVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -Location "West US" -VirtualWan $virtualWan -IpAddress "1.2.3.4" -AddressSpace $vpnSiteAddressSpaces -DeviceModel "SomeDevice" -DeviceVendor "SomeDeviceVendor" -LinkSpeedInMbps "10" - -PS C:\> New-AzureRmVpnConnection -ResourceGroupName $vpnGateway.ResourceGroupName -ParentResourceName $vpnGateway.Name -Name "testConnection" -VpnSite $vpnSite -PS C:\> Get-AzureRmVpnConnection -ResourceGroupName $vpnGateway.ResourceGroupName -ParentResourceName $vpnGateway.Name -Name "testConnection" - -RemoteVpnSite : Microsoft.Azure.Commands.Network.Models.PSResourceId -SharedKey : -VpnConnectionProtocolType : IKEv2 -ConnectionStatus : -EgressBytesTransferred : 0 -IngressBytesTransferred : 0 -IpsecPolicies : {} -ConnectionBandwidth : 20 -EnableBgp : False -ProvisioningState : testConnection -Name : ps9709 -Etag : W/"4580a2e2-2fab-4cff-88eb-92013a76b5a8" -Id : /subscriptions/{subscriptionId}/resourceGroups/ps9361/providers/Microsoft.Network/vpnGateways/testvpngw/vpnConnections/testConnection -``` - -The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub and a VpnSite in West US in "testRG" resource group in Azure. -A VPN gateway will be created thereafter in the Virtual Hub with 2 scale units. - -Once the gateway has been created, it is connected to the VpnSite using the New-AzureRmVpnConnection command. - -Then it gets the connection using the connection name. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName, VpnConnectionName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParentObject -The parent VpnGateway for this connection. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVpnGateway -Parameter Sets: ByVpnGatewayObject -Aliases: ParentVpnGateway, VpnGateway - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ParentResourceId -The resource id of the parent VpnGateway for this connection. - -```yaml -Type: System.String -Parameter Sets: ByVpnGatewayResourceId -Aliases: ParentVpnGatewayId, VpnGatewayId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ParentResourceName -The parent resource name. - -```yaml -Type: System.String -Parameter Sets: ByVpnGatewayName -Aliases: ParentVpnGatewayName, VpnGatewayName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByVpnGatewayName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVpnConnection - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVpnGateway.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVpnGateway.md deleted file mode 100644 index 8731c18dee..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVpnGateway.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvpngateway -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVpnGateway.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVpnGateway.md ---- - -# Get-AzureRmVpnGateway - -## SYNOPSIS -Gets a VpnGateway resource using ResourceGroupName and GatewayName OR lists all gateways by ResourceGroupName or SubscriptionId. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ListBySubscriptionId (Default) -``` -Get-AzureRmVpnGateway [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ListByResourceGroupName -``` -Get-AzureRmVpnGateway -ResourceGroupName <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -Gets a VpnGateway resource using ResourceGroupName and GatewayName OR lists all gateways by ResourceGroupName or SubscriptionId. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> $virtualWan = New-AzureRmVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" -PS C:\> $virtualHub = New-AzureRmVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" -PS C:\> New-AzureRmVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -BGPPeeringWeight 10 -VpnGatewayScaleUnit 2 -PS C:\> Get-AzureRmVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" - -ResourceGroupName : testRG -Name : testvpngw -Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/vpnGateways/testvpngw -Location : West US -VpnGatewayScaleUnit : 2 -VirtualHub : /subscriptions/{subscriptionId}/resourceGroups/Ali_pS_Test/providers/Microsoft.Network/virtualHubs/westushub -BgpSettings : {} -Type : Microsoft.Network/vpnGateways -ProvisioningState : Succeeded -``` - -The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub in West US in "testRG" resource group in Azure. -A VPN gateway will be created thereafter in the Virtual Hub with 2 scale units. - -It then gets the VpnGateway using its resourceGroupName and the gateway name. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: System.String -Parameter Sets: ListByResourceGroupName -Aliases: ResourceName, VpnGatewayName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ListByResourceGroupName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVpnGateway - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVpnSite.md b/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVpnSite.md deleted file mode 100644 index 2aa3c7099d..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Get-AzureRmVpnSite.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvpnsite -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVpnSite.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVpnSite.md ---- - -# Get-AzureRmVpnSite - -## SYNOPSIS -Gets an Azure VpnSite resource by name OR lists all VpnSites in a ResourceGroup or SubscriptionId. - -This is an RM representation of customer branches that are uploaded to Azure for S2S connectivity with a Cortex virtual hub. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ListBySubscriptionId (Default) -``` -Get-AzureRmVpnSite [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ListByResourceGroupName -``` -Get-AzureRmVpnSite -ResourceGroupName <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -Gets an Azure VpnSite resource by name OR lists all VpnSites in a ResourceGroup or SubscriptionId. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> $virtualWan = New-AzureRmVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" -PS C:\> $vpnSiteAddressSpaces = New-Object string[] 2 -PS C:\> $vpnSiteAddressSpaces[0] = "192.168.2.0/24" -PS C:\> $vpnSiteAddressSpaces[1] = "192.168.3.0/24" -PS C:\> New-AzureRmVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -Location "West US" -VirtualWan $virtualWan -IpAddress "1.2.3.4" -AddressSpace $vpnSiteAddressSpaces -DeviceModel "SomeDevice" -DeviceVendor "SomeDeviceVendor" -LinkSpeedInMbps "10" -PS C:\> Get-AzureRmVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" - -ResourceGroupName : testRG -Name : testVpnSite -Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/vpnSites/testVpnSite -Location : eastus2euap -IpAddress : 1.2.3.4 -VirtualWan : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualWans/myVirtualWAN -AddressSpace : {192.168.2.0/24, 192.168.3.0/24} -BgpSettings : -Type : Microsoft.Network/vpnSites -ProvisioningState : Succeeded -``` - -The above will create a resource group, Virtual WAN in West US in "testRG" resource group in Azure. - -Then it creates a VpnSite to represent a customer branch and links it to the Virtual WAN. - -Once the site is created, it gets the site using the Get-AzureRmVpnSite command. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: System.String -Parameter Sets: ListByResourceGroupName -Aliases: ResourceName, VpnSiteName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ListByResourceGroupName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVpnSite - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Move-AzureRmExpressRouteCircuit.md b/azurermps-6.13.0/AzureRM.Network/Move-AzureRmExpressRouteCircuit.md deleted file mode 100644 index da89a96d19..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Move-AzureRmExpressRouteCircuit.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: F845ED42-A7C1-4CCC-9AD8-E9A91C3EEC7A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/move-azurermexpressroutecircuit -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Move-AzureRmExpressRouteCircuit.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Move-AzureRmExpressRouteCircuit.md ---- - -# Move-AzureRmExpressRouteCircuit - -## SYNOPSIS -Moves an ExpressRoute circuit from the classic deployment model to the Resource Manager deployment model. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Move-AzureRmExpressRouteCircuit -Name <String> -ResourceGroupName <String> -Location <String> - -ServiceKey <String> [-Tag <Hashtable>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Move-AzureRmExpressRouteCircuit** cmdlet moves an ExpressRoute circuit from the classic -deployment model to the Resource Manager deployment model. After the move, the ExpressRoute circuit -behaves and performs like any other ExpressRoute circuit that is created in the Resource Manager -deployment model. Circuit links, virtual networks, and VPN gateways are not moved through this -operation. Those resources need to be reconfigured after the move. - -## EXAMPLES - -### Example 1: Move an ExpressRoute circuit to the Resource Manager deployment model -``` -Move-AzureRmExpressRouteCircuit -Name $CircuitName -ResourceGroupName $RG -Location $Location -ServiceKey $ServiceKey -``` - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The name of the Azure location where the ExpressRoute circuit resides. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The name of the ExpressRoute circuit to be moved. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group that will contain the ExpressRoute circuit being moved. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceKey -The Service Key used by the ExpressRoute circuit in the classic deployment model. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit - -## NOTES - -## RELATED LINKS - -[Get-AzureRmExpressRouteCircuit](./Get-AzureRmExpressRouteCircuit.md) - -[New-AzureRmExpressRouteCircuit](./New-AzureRmExpressRouteCircuit.md) - -[Remove-AzureRmExpressRouteCircuit](./Remove-AzureRmExpressRouteCircuit.md) - -[Set-AzureRmExpressRouteCircuit](./Set-AzureRmExpressRouteCircuit.md) diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGateway.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGateway.md deleted file mode 100644 index 50bc290989..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGateway.md +++ /dev/null @@ -1,605 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 1F5066C6-9756-47B4-886C-C52755809926 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgateway -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGateway.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGateway.md ---- - -# New-AzureRmApplicationGateway - -## SYNOPSIS -Creates an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApplicationGateway -Name <String> -ResourceGroupName <String> -Location <String> - -Sku <PSApplicationGatewaySku> [-SslPolicy <PSApplicationGatewaySslPolicy>] - -GatewayIPConfigurations <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayIPConfiguration]> - [-SslCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslCertificate]>] - [-AuthenticationCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate]>] - [-TrustedRootCertificate <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayTrustedRootCertificate]>] - [-FrontendIPConfigurations <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendIPConfiguration]>] - -FrontendPorts <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendPort]> - [-Probes <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayProbe]>] - -BackendAddressPools <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool]> - -BackendHttpSettingsCollection <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings]> - -HttpListeners <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener]> - [-UrlPathMaps <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayUrlPathMap]>] - -RequestRoutingRules <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRequestRoutingRule]> - [-RedirectConfigurations <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRedirectConfiguration]>] - [-WebApplicationFirewallConfiguration <PSApplicationGatewayWebApplicationFirewallConfiguration>] - [-AutoscaleConfiguration <PSApplicationGatewayAutoscaleConfiguration>] [-EnableHttp2] [-EnableFIPS] - [-Zone <System.Collections.Generic.List`1[System.String]>] [-Tag <Hashtable>] [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationGateway** cmdlet creates an Azure application gateway. -An application gateway requires the following: -- A resource group. -- A virtual network. -- A back-end server pool, containing the IP addresses of the back-end servers. -- Back-end server pool settings. Each pool has settings such as port, protocol and cookie-based affinity, that are applied to all servers within the pool. -- Front-end IP addresses, which are the IP addresses opened on the application gateway. A front-end IP address can be a public IP address or an internal IP address. -- Front-end ports, which are the public ports opened on the application gateway. Traffic that hits these ports is redirected to the back-end servers. -- A request routing rule that binds the listener and the back-end server pool. The rule defines which back-end server pool the traffic should be directed to when it hits a particular listener. -A listener has a front-end port, front-end IP address, protocol (HTTP or HTTPS) and Secure Sockets -Layer (SSL) certificate name (if configuring SSL offload). - -## EXAMPLES - -### Example 1: Create an application gateway -``` -PS C:\> $ResourceGroup = New-AzureRmResourceGroup -Name "ResourceGroup01" -Location "West US" -Tag @{Name = "Department"; Value = "Marketing"} -PS C:\> $Subnet = New-AzureRmVirtualNetworkSubnetConfig -Name "Subnet01" -AddressPrefix 10.0.0.0/24 -PS C:\> $VNet = New-AzureRmvirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" -Location "West US" -AddressPrefix 10.0.0.0/16 -Subnet $Subnet -PS C:\> $VNet = Get-AzureRmvirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name $Subnet01 -VirtualNetwork $VNet -PS C:\> $GatewayIPconfig = New-AzureRmApplicationGatewayIPConfiguration -Name "GatewayIp01" -Subnet $Subnet -PS C:\> $Pool = New-AzureRmApplicationGatewayBackendAddressPool -Name "Pool01" -BackendIPAddresses 10.10.10.1, 10.10.10.2, 10.10.10.3 -PS C:\> $PoolSetting = New-AzureRmApplicationGatewayBackendHttpSettings -Name "PoolSetting01" -Port 80 -Protocol "Http" -CookieBasedAffinity "Disabled" -PS C:\> $FrontEndPort = New-AzureRmApplicationGatewayFrontendPort -Name "FrontEndPort01" -Port 80 -# Create a public IP address -PS C:\> $PublicIp = New-AzureRmPublicIpAddress -ResourceGroupName "ResourceGroup01" -Name "PublicIpName01" -Location "West US" -AllocationMethod "Dynamic" -PS C:\> $FrontEndIpConfig = New-AzureRmApplicationGatewayFrontendIPConfig -Name "FrontEndConfig01" -PublicIPAddress $PublicIp -PS C:\> $Listener = New-AzureRmApplicationGatewayHttpListener -Name "ListenerName01" -Protocol "Http" -FrontendIpConfiguration $FrontEndIpConfig -FrontendPort $FrontEndPort -PS C:\> $Rule = New-AzureRmApplicationGatewayRequestRoutingRule -Name "Rule01" -RuleType basic -BackendHttpSettings $PoolSetting -HttpListener $Listener -BackendAddressPool $Pool -PS C:\> $Sku = New-AzureRmApplicationGatewaySku -Name "Standard_Small" -Tier Standard -Capacity 2 -PS C:\> $Gateway = New-AzureRmApplicationGateway -Name "AppGateway01" -ResourceGroupName "ResourceGroup01" -Location "West US" -BackendAddressPools $Pool -BackendHttpSettingsCollection $PoolSetting -FrontendIpConfigurations $FrontEndIpConfig -GatewayIpConfigurations $GatewayIpConfig -FrontendPorts $FrontEndPort -HttpListeners $Listener -RequestRoutingRules $Rule -Sku $Sku -``` - -The following example creates an application gateway by first creating a resource group and a -virtual network, as well as the following: -- A back-end server pool -- Back-end server pool settings -- Front-end ports -- Front-end IP addresses -- A request routing rule -These four commands create a virtual network. -The first command creates a subnet configuration. -The second command creates a virtual network. -The third command verifies the subnet configuration and the fourth command verifies that the virtual network is created successfully. -The following commands create the application gateway. -The first command creates an IP configuration named GatewayIp01 for the subnet created previously. -The second command creates a back-end server pool named Pool01 with a list of back-end IP addresses and stores the pool in the $Pool variable. -The third command creates the settings for the back-end server pool and stores the settings in the $PoolSetting variable. -The forth command creates a front-end port on port 80, names it FrontEndPort01, and stores the port in the $FrontEndPort variable. -The fifth command creates a public IP address by using New-AzureRmPublicIpAddress. -The sixth command creates a front-end IP configuration using $PublicIp, names it FrontEndPortConfig01, and stores it in the $FrontEndIpConfig variable. -The seventh command creates a listener using the previously created $FrontEndIpConfig $FrontEndPort. -The eighth command creates a rule for the listener. -The ninth command sets the SKU. -The tenth command creates the gateway using the objects set by the previous commands. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthenticationCertificates -Specifies authentication certificates for the application gateway. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AutoscaleConfiguration -Autoscale Configuration - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAutoscaleConfiguration -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BackendAddressPools -Specifies the list of back-end address pools for the application gateway. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BackendHttpSettingsCollection -Specifies the list of back-end HTTP settings for the application gateway. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableFIPS -Whether FIPS is enabled. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableHttp2 -Whether HTTP2 is enabled. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIPConfigurations -Specifies a list of front-end IP configurations for the application gateway. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendIPConfiguration] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FrontendPorts -Specifies a list of front-end ports for the application gateway. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendPort] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GatewayIPConfigurations -Specifies a list of IP configurations for the application gateway. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayIPConfiguration] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HttpListeners -Specifies a list of HTTP listeners for the application gateway. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the region in which to create the application gateway. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of application gateway. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Probes -Specifies probes for the application gateway. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayProbe] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RedirectConfigurations -The list of redirect configuration - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRedirectConfiguration] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RequestRoutingRules -Specifies a list of request routing rules for the application gateway. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRequestRoutingRule] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group in which to create the application gateway. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -Specifies the stock keeping unit (SKU) of the application gateway. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySku -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SslCertificates -Specifies the list of Secure Sockets Layer (SSL) certificates for the application gateway. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslCertificate] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SslPolicy -Specifies an SSL policy for the application gateway. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslPolicy -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TrustedRootCertificate -The list of trusted root certificates - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayTrustedRootCertificate] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UrlPathMaps -Specifies URL path maps for the application gateway. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayUrlPathMap] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WebApplicationFirewallConfiguration -Specifies a web application firewall (WAF) configuration. You can use the -Get-AzureRmApplicationGatewayWebApplicationFirewallConfiguration cmdlet to get a WAF. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayWebApplicationFirewallConfiguration -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Zone -A list of availability zones denoting where the application gateway needs to come from. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySku - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslPolicy - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayIPConfiguration, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslCertificate, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendIPConfiguration, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendPort, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayProbe, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayUrlPathMap, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRequestRoutingRule, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRedirectConfiguration, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayWebApplicationFirewallConfiguration - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[New-AzureRmApplicationGatewayBackendAddressPool](./New-AzureRmApplicationGatewayBackendAddressPool.md) - -[New-AzureRmApplicationGatewayBackendHttpSettings](./New-AzureRmApplicationGatewayBackendHttpSettings.md) - -[New-AzureRmApplicationGatewayFrontendIPConfig](./New-AzureRmApplicationGatewayFrontendIPConfig.md) - -[New-AzureRmApplicationGatewayFrontendPort](./New-AzureRmApplicationGatewayFrontendPort.md) - -[New-AzureRmApplicationGatewayHttpListener](./New-AzureRmApplicationGatewayHttpListener.md) - -[New-AzureRmApplicationGatewayIPConfiguration](./New-AzureRmApplicationGatewayIPConfiguration.md) - -[New-AzureRmApplicationGatewayRequestRoutingRule](./New-AzureRmApplicationGatewayRequestRoutingRule.md) - -[New-AzureRmApplicationGatewaySku](./New-AzureRmApplicationGatewaySku.md) - -[New-AzureRmVirtualNetwork](./New-AzureRmVirtualNetwork.md) - -[New-AzureRmVirtualNetworkSubnetConfig](./New-AzureRmVirtualNetworkSubnetConfig.md) diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayAuthenticationCertificate.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayAuthenticationCertificate.md deleted file mode 100644 index 81eb0874ec..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayAuthenticationCertificate.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 4736FA0D-222D-4D69-BCBD-72036303A20E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewayauthenticationcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayAuthenticationCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayAuthenticationCertificate.md ---- - -# New-AzureRmApplicationGatewayAuthenticationCertificate - -## SYNOPSIS -Creates an authentication certificate for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApplicationGatewayAuthenticationCertificate -Name <String> -CertificateFile <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationGatewayAuthenticationCertificate** cmdlet creates an authentication certificate for an Azure application gateway. - -## EXAMPLES - -## PARAMETERS - -### -CertificateFile -Specifies the path of the authentication certificate. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the authentication certificate. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayAuthenticationCertificate](./Add-AzureRmApplicationGatewayAuthenticationCertificate.md) - -[Get-AzureRmApplicationGatewayAuthenticationCertificate](./Get-AzureRmApplicationGatewayAuthenticationCertificate.md) - -[Remove-AzureRmApplicationGatewayAuthenticationCertificate](./Remove-AzureRmApplicationGatewayAuthenticationCertificate.md) - -[Set-AzureRmApplicationGatewayAuthenticationCertificate](./Set-AzureRmApplicationGatewayAuthenticationCertificate.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayAutoscaleConfiguration.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayAutoscaleConfiguration.md deleted file mode 100644 index beee9159b9..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayAutoscaleConfiguration.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewayautoscaleconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayAutoscaleConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayAutoscaleConfiguration.md ---- - -# New-AzureRmApplicationGatewayAutoscaleConfiguration - -## SYNOPSIS -Creates a Autoscale Configuration for the Application Gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApplicationGatewayAutoscaleConfiguration -MinCapacity <Int32> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationGatewayAutoscaleConfiguration** cmdlet creates Autoscale Configuration for an Azure application gateway. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> $autoscaleConfig = New-AzureRmApplicationGatewayAutoscaleConfiguration -MinCapacity 3 -PS C:\> $gw = New-AzureRmApplicationGateway -Name $appgwName -ResourceGroupName $rgname .. -AutoscaleConfiguration $autoscaleConfig -``` - -The first command creates an autoscale configuration with minimum capacity 3. -The second command creates an application gateway with the autoscale configuration. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinCapacity -Minimum capacity units that will always be available [and charged] for application gateway. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAutoscaleConfiguration - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayBackendAddressPool.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayBackendAddressPool.md deleted file mode 100644 index f43ed1b21d..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayBackendAddressPool.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: C257E62F-1535-4626-A12B-F4572D00BB13 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewaybackendaddresspool -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayBackendAddressPool.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayBackendAddressPool.md ---- - -# New-AzureRmApplicationGatewayBackendAddressPool - -## SYNOPSIS -Creates a back-end address pool for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApplicationGatewayBackendAddressPool -Name <String> - [-BackendIPAddresses <System.Collections.Generic.List`1[System.String]>] - [-BackendFqdns <System.Collections.Generic.List`1[System.String]>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationGatewayBackendAddressPool** cmdlet creates a back-end address pool for an Azure application gateway. -A back-end address can be specified as an IP address, a fully-qualified domain name (FQDN) or an IP configuration ID. - -## EXAMPLES - -### Example 1: Create a back-end address pool by using the FQDN of a back-end server -``` -PS C:\>$Pool = New-AzureRmApplicationGatewayBackendAddressPool -Name "Pool01" -BackendFqdns "contoso1.com", "contoso2.com" -``` - -This command creates a back-end address pool named Pool01 by using the FQDNs of back-end servers, and stores it in the $Pool variable. - -### Example 2: Create a back-end address pool by using the IP address of a back-end server -``` -PS C:\>$Pool = New-AzureRmApplicationGatewayBackendAddressPool -Name "Pool02" -BackendFqdns "10.10.10.10", "10.10.10.11" -``` - -This command creates a back-end address pool named Pool02 by using the IP addresses of back-end servers, and stores it in the $Pool variable. - -## PARAMETERS - -### -BackendFqdns -Specifies a list of back-end FQDNs that this cmdlet associates with the back-end server pool. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendIPAddresses -Specifies a list of back-end IP addresses that this cmdlet associates with the back-end server pool. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the back-end server pool that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayBackendAddressPool](./Add-AzureRmApplicationGatewayBackendAddressPool.md) - -[Get-AzureRmApplicationGatewayBackendAddressPool](./Get-AzureRmApplicationGatewayBackendAddressPool.md) - -[Remove-AzureRmApplicationGatewayBackendAddressPool](./Remove-AzureRmApplicationGatewayBackendAddressPool.md) - -[Set-AzureRmApplicationGatewayBackendAddressPool](./Set-AzureRmApplicationGatewayBackendAddressPool.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayBackendHttpSettings.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayBackendHttpSettings.md deleted file mode 100644 index fa53d317f9..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayBackendHttpSettings.md +++ /dev/null @@ -1,297 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewaybackendhttpsettings -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayBackendHttpSettings.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayBackendHttpSettings.md ---- - -# New-AzureRmApplicationGatewayBackendHttpSettings - -## SYNOPSIS -Creates back-end HTTP settings for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApplicationGatewayBackendHttpSettings -Name <String> -Port <Int32> -Protocol <String> - -CookieBasedAffinity <String> [-RequestTimeout <Int32>] - [-ConnectionDraining <PSApplicationGatewayConnectionDraining>] [-ProbeId <String>] - [-Probe <PSApplicationGatewayProbe>] - [-AuthenticationCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate]>] - [-TrustedRootCertificate <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayTrustedRootCertificate]>] - [-PickHostNameFromBackendAddress] [-HostName <String>] [-AffinityCookieName <String>] [-Path <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmApplicationGatewayBackendHttpSettings cmdlet creates back-end HTTP settings for an application gateway. -Back-end HTTP settings are applied to all back-end servers in a pool. - -## EXAMPLES - -### Example 1: Create back-end HTTP settings -``` -PS C:\>$Setting = New-AzureRmApplicationGatewayBackendHttpSettings -Name "Setting01" -Port 80 -Protocol Http -CookieBasedAffinity Disabled -``` - -This command creates back-end HTTP settings named Setting01 on port 80, using the HTTP protocol, with cookie-based affinity disabled. -The settings are stored in the $Setting variable. - -## PARAMETERS - -### -AffinityCookieName -Cookie name to use for the affinity cookie - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthenticationCertificates -Specifies authentication certificates for the application gateway. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionDraining -Connection draining of the backend http settings resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayConnectionDraining -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CookieBasedAffinity -Specifies whether cookie-based affinity should be enabled or disabled for the back-end server pool. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostName -Sets host header to be sent to the backend servers. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the back-end HTTP settings that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Path which should be used as a prefix for all HTTP requests. -If no value is provided for this parameter, then no path will be prefixed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PickHostNameFromBackendAddress -Flag if host header should be picked from the host name of the backend server. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Port -Specifies the port of the back-end server pool. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Probe -Specifies a probe to associate with the back-end server pool. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayProbe -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeId -Specifies the ID of the probe to associate with the back-end server pool. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol to use for communication between the application gateway and the back-end servers. -The acceptable values for this parameter are: Http and Https. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Http, Https - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestTimeout -Specifies a request time-out value. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrustedRootCertificate -Application gateway Trusted Root Certificates - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayTrustedRootCertificate] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayBackendHttpSettings]() - -[Get-AzureRmApplicationGatewayBackendHttpSettings]() - -[Remove-AzureRmApplicationGatewayBackendHttpSettings]() - -[Set-AzureRmApplicationGatewayBackendHttpSettings]() - diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayConnectionDraining.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayConnectionDraining.md deleted file mode 100644 index 1c80cb468e..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayConnectionDraining.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewayconnectiondraining -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayConnectionDraining.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayConnectionDraining.md ---- - -# New-AzureRmApplicationGatewayConnectionDraining - -## SYNOPSIS -Creates a new connection draining configuration for back-end HTTP settings. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApplicationGatewayConnectionDraining -Enabled <Boolean> -DrainTimeoutInSec <Int32> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationGatewayConnectionDraining** cmdlet creates a new connection draining configuration for back-end HTTP settings. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $connectionDraining = New-AzureRmApplicationGatewayConnectionDraining -Enabled $True -DrainTimeoutInSec 42 -``` - -The command creates a new connection draining configuration with Enabled set to True and DrainTimeoutInSec set to 42 seconds and stores it in $connectionDraining. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DrainTimeoutInSec -The number of seconds connection draining is active. -Acceptable values are from 1 second to 3600 seconds. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Whether connection draining is enabled or not. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayConnectionDraining - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGatewayConnectionDraining](./Get-AzureRmApplicationGatewayConnectionDraining.md) - -[Remove-AzureRmApplicationGatewayConnectionDraining](./Remove-AzureRmApplicationGatewayConnectionDraining.md) - -[Set-AzureRmApplicationGatewayConnectionDraining](./Set-AzureRmApplicationGatewayConnectionDraining.md) - diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayCustomError.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayCustomError.md deleted file mode 100644 index 08efa1ebb3..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayCustomError.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewaycustomerror -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayCustomError.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayCustomError.md ---- - -# New-AzureRmApplicationGatewayCustomError - -## SYNOPSIS -Creates a custom error with http status code and custom error page url - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApplicationGatewayCustomError -StatusCode <String> -CustomErrorPageUrl <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationGatewayCustomError** cmdlet creates a custom error. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> $customError403Url = "https://mycustomerrorpages.blob.core.windows.net/errorpages/403-another.htm" -PS C:\> $ce = New-AzureRmApplicationGatewayCustomError -StatusCode HttpStatus403 -CustomErrorPageUrl $customError403Url -``` - -This command creates the custom error of http status code 403. - -## PARAMETERS - -### -CustomErrorPageUrl -Error page URL of the application gateway customer error. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StatusCode -Status code of the application gateway customer error. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayCustomError - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayFirewallDisabledRuleGroupConfig.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayFirewallDisabledRuleGroupConfig.md deleted file mode 100644 index fb722ee3e4..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayFirewallDisabledRuleGroupConfig.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewayfirewalldisabledrulegroupconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayFirewallDisabledRuleGroupConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayFirewallDisabledRuleGroupConfig.md ---- - -# New-AzureRmApplicationGatewayFirewallDisabledRuleGroupConfig - -## SYNOPSIS -Creates a new disabled rule group configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApplicationGatewayFirewallDisabledRuleGroupConfig -RuleGroupName <String> - [-Rules <System.Collections.Generic.List`1[System.Int32]>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationGatewayFirewallDisabledRuleGroupConfig** cmdlet creates a new disabled rule group configuration. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $disabledRuleGroup1 = New-AzureRmApplicationGatewayFirewallDisabledRuleGroupConfig -RuleGroupName "REQUEST-942-APPLICATION-ATTACK-SQLI" -Rules 942130,942140 -``` - -The command creates a new disabled rule group configuration for the rule group named "REQUEST-942-APPLICATION-ATTACK-SQLI" with rule 942130 and rule 942140 being disabled. The new disabled rule group configuration is saved in $disabledRuleGroup1. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RuleGroupName -The name of the rule group that will be disabled. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rules -The list of rules that will be disabled. -If null, all rules of the rule group will be disabled. - -```yaml -Type: System.Collections.Generic.List`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallDisabledRuleGroup - -## NOTES - -## RELATED LINKS - -[New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration](./New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md) - -[Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration](./Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md) - diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayFirewallExclusionConfig.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayFirewallExclusionConfig.md deleted file mode 100644 index ab8068ed7f..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayFirewallExclusionConfig.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewayfirewallexclusionconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayFirewallExclusionConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayFirewallExclusionConfig.md ---- - -# New-AzureRmApplicationGatewayFirewallExclusionConfig - -## SYNOPSIS -Creates a new exclusion rule list for application gateway waf - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApplicationGatewayFirewallExclusionConfig -Variable <String> -Operator <String> -Selector <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationGatewayFirewallExclusionConfig** cmdlet a new exclusion rule list for application gateway waf. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> $exclusion1 = New-AzureRmApplicationGatewayFirewallExclusionConfig -Variable "RequestHeaderNames" -Operator "StartsWith" -Selector "xyz" -``` - -This command creates a new exclusion rule lists configuration for the variable named RequestHeaderNames and operator named StartsWith and Selector named xyz. The exclusion list configuration is saved in $exclusion1. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Operator -When variable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Selector -When variable is a collection, operator used to specify which elements in the collection this exclusion applies to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Variable -The variable to be excluded. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallExclusion - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayFrontendIPConfig.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayFrontendIPConfig.md deleted file mode 100644 index bd966bcbf5..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayFrontendIPConfig.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: AE8E26F2-CF8E-4340-936D-230731B5BA32 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewayfrontendipconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayFrontendIPConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayFrontendIPConfig.md ---- - -# New-AzureRmApplicationGatewayFrontendIPConfig - -## SYNOPSIS -Creates a front-end IP configuration for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -New-AzureRmApplicationGatewayFrontendIPConfig -Name <String> [-PrivateIPAddress <String>] [-SubnetId <String>] - [-PublicIPAddressId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -New-AzureRmApplicationGatewayFrontendIPConfig -Name <String> [-PrivateIPAddress <String>] [-Subnet <PSSubnet>] - [-PublicIPAddress <PSPublicIpAddress>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationGatewayFrontendIPConfig** cmdlet creates a front-end IP configuraton for an Azure application gateway. -An application gateway supports two types of front-end IP configuration: -- Public IP addresses - -- Private IP addresses using internal load balancing (ILB). -An application gateway can have at most one public IP address and one private IP address. -The public IP address and private IP address should be added separately as front-end IP addresses. - -## EXAMPLES - -### Example 1: Create a front-end IP configuration using a public IP resource object -``` -PS C:\>$PublicIP = New-AzureRmPublicIpAddress -ResourceGroupName "ResourceGroup01" -Name "PublicIP01" -location "West US" -AllocationMethod Dynamic -PS C:\> $FrontEnd = New-AzureRmApplicationGatewayFrontendIPConfig -Name "FrontEndIP01" -PublicIPAddress $PublicIP -``` - -The first command creates a public IP resource object and stores it in the $PublicIP variable. -The second command uses $PublicIP to create a new front-end IP configuration named FrontEndIP01 and stores it in the $FrontEnd variable. - -### Example 2: Create a static private IP as the front-end IP address -``` -PS C:\>$VNet = Get-AzureRmvirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $VNet -PS C:\> $FrontEnd = New-AzureRmApplicationGatewayFrontendIPConfig -Name "FrontendIP02" -Subnet $Subnet -PrivateIPAddress 10.0.1.1 -``` - -The first command gets a virtual network named VNet01 that belongs to the resource group named ResourceGroup01, and stores it in the $VNet variable. -The second command gets a subnet configuration named Subnet01 using $VNet from the first command and stores it in the $Subnet variable. -The third command creates a front-end IP configuration named FrontEndIP02 using $Subnet from the second command and the private IP address 10.0.1.1, and then stores it in the $FrontEnd variable. - -### Example 3: Create a dynamic private IP as the front-end IP address -``` -PS C:\>$VNet = Get-AzureRmvirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $VNet -PS C:\> $FrontEnd = New-AzureRmApplicationGatewayFrontendIPConfig -Name "FrontendIP03" -Subnet $Subnet -``` - -The first command gets a virtual network named VNet01 that belongs to the resource group named ResourceGroup01, and stores it in the $VNet variable. -The second command gets a subnet configuration named Subnet01 using $VNet from the first command and stores it in the $Subnet variable. -The third command creates a front-end IP configuration named FrontEndIP03 using $Subnet from the second command, and stores it in the $FrontEnd variable. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the front-end IP configuration that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateIPAddress -Specifies the private IP address which this cmdlet associates with the front-end IP address of the application gateway. -This can be specified only if a subnet is specified. -This IP is statically allocated from the subnet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIPAddress -Specifies the public IP address object which this cmdlet associates with the front-end IP address of the application gateway. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIPAddressId -Specifies the public IP address ID which this cmdlet associates with the front-end IP of the application gateway. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subnet -Specifies the subnet object which this cmdlet associates with the front-end IP address of the application gateway. -If you specify this parameter, it implies that the gateway uses a private IP address. -If the *PrivateIPAddresss* parameter is specified, it should belong to the subnet specified by this parameter. -If *PrivateIPAddress* is not specified, one of the IP addresses from this subnet is dynamically picked up as the front-end IP address of the application gateway. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSSubnet -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetId -Specifies the subnet ID which this cmdlet associates with the front-end IP configuration of the application gateway. -If you specify the *Subnet* parameter, it implies that the gateway uses a private IP address. -If the *PrivateIPAddress* parameter is specified, it should belong to the subnet specified by *Subnet*. -If *PrivateIPAddress* is not specified, one of the IP addresses from this subnet is dynamically picked up as the front-end IP address of the application gateway. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendIPConfiguration - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayFrontendIPConfig](./Add-AzureRmApplicationGatewayFrontendIPConfig.md) - -[Get-AzureRmApplicationGatewayFrontendIPConfig](./Get-AzureRmApplicationGatewayFrontendIPConfig.md) - -[Remove-AzureRmApplicationGatewayFrontendIPConfig](./Remove-AzureRmApplicationGatewayFrontendIPConfig.md) - -[Set-AzureRmApplicationGatewayFrontendIPConfig](./Set-AzureRmApplicationGatewayFrontendIPConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayFrontendPort.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayFrontendPort.md deleted file mode 100644 index 9f280e7f34..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayFrontendPort.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 3C046A0A-A2B6-413C-8D3B-8991A1FC4926 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewayfrontendport -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayFrontendPort.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayFrontendPort.md ---- - -# New-AzureRmApplicationGatewayFrontendPort - -## SYNOPSIS -Creates a front-end port for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApplicationGatewayFrontendPort -Name <String> -Port <Int32> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationGatewayFrontendPort** cmdlet creates a front-end port for an Azure application gateway. - -## EXAMPLES - -### Example1: Create a front-end port -``` -PS C:\>$FrontEndPort = New-AzureRmApplicationGatewayFrontendPort -Name "FrontEndPort01" -Port 80 -``` - -This command creates a front-end port named FrontEndPort01 on port 80 and stores the result in the variable named $FrontEndPort. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the front-end port that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Port -Specifies the port number of the front-end port. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendPort - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayFrontendPort](./Add-AzureRmApplicationGatewayFrontendPort.md) - -[Get-AzureRmApplicationGatewayFrontendPort](./Get-AzureRmApplicationGatewayFrontendPort.md) - -[Remove-AzureRmApplicationGatewayFrontendPort](./Remove-AzureRmApplicationGatewayFrontendPort.md) - -[Set-AzureRmApplicationGatewayFrontendPort](./Set-AzureRmApplicationGatewayFrontendPort.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayHttpListener.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayHttpListener.md deleted file mode 100644 index b6dbdabff5..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayHttpListener.md +++ /dev/null @@ -1,247 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: AF8CC409-2EA7-4EC1-86C9-E7A773DE9201 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewayhttplistener -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayHttpListener.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayHttpListener.md ---- - -# New-AzureRmApplicationGatewayHttpListener - -## SYNOPSIS -Creates an HTTP listener for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -New-AzureRmApplicationGatewayHttpListener -Name <String> [-FrontendIPConfigurationId <String>] - [-FrontendPortId <String>] [-SslCertificateId <String>] [-HostName <String>] - [-RequireServerNameIndication <String>] -Protocol <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### SetByResource -``` -New-AzureRmApplicationGatewayHttpListener -Name <String> - [-FrontendIPConfiguration <PSApplicationGatewayFrontendIPConfiguration>] - [-FrontendPort <PSApplicationGatewayFrontendPort>] [-SslCertificate <PSApplicationGatewaySslCertificate>] - [-HostName <String>] [-RequireServerNameIndication <String>] -Protocol <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationGatewayHttpListener** cmdlet creates an HTTP listener for an Azure application gateway. - -## EXAMPLES - -### Example 1: Create an HTTP listener -``` -PS C:\>$Listener = New-AzureRmApplicationGatewayHttpListener -Name "Listener01" -Protocol "Http" -FrontendIpConfiguration $FIp01 -FrontendPort $FP01 -``` - -This command creates an HTTP listener named Listener01 and stores the result in the variable named $Listener. - -### Example 2: Create an HTTP listener with SSL -``` -PS C:\>$Listener = New-AzureRmApplicationGatewayHttpListener -Name "Listener01" -Protocol "Https" -FrontendIpConfiguration $FIp01 -FrontendPort $FP01 -SslCertificate $SSLCert01 -``` - -This command creates an HTTP listener that uses SSL offload and provides the SSL certificate in the $SSLCert01 variable. -The command stores the result in the variable named $Listener. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIPConfiguration -Specifies front-end IP configuration object for the HTTP listener. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendIPConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIPConfigurationId -Specifies the ID of the front-end IP configuration for the HTTP listener. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendPort -Specifies the front-end port for the HTTP listener. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendPort -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendPortId -Specifies the ID of the front-end port object for the HTTP listener. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostName -Specifies the host name of the application gateway HTTP listener. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the HTTP listener that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol that the HTTP listener uses. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Http, Https - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequireServerNameIndication -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: true, false - -Required: False -Position: Named -Default value: true -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SslCertificate -Specifies the SSL certificate object for the HTTP listener. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslCertificate -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SslCertificateId -Specifies the ID of the SSL certificate for the HTTP listener. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayHttpListener](./Add-AzureRmApplicationGatewayHttpListener.md) - -[Get-AzureRmApplicationGatewayHttpListener](./Get-AzureRmApplicationGatewayHttpListener.md) - -[Remove-AzureRmApplicationGatewayHttpListener](./Remove-AzureRmApplicationGatewayHttpListener.md) - -[Set-AzureRmApplicationGatewayHttpListener](./Set-AzureRmApplicationGatewayHttpListener.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayIPConfiguration.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayIPConfiguration.md deleted file mode 100644 index cb8e0b8f53..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayIPConfiguration.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 312AA609-7362-42A5-A889-C0784D5A2943 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewayipconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayIPConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayIPConfiguration.md ---- - -# New-AzureRmApplicationGatewayIPConfiguration - -## SYNOPSIS -Creates an IP configuration for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -New-AzureRmApplicationGatewayIPConfiguration -Name <String> [-SubnetId <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -New-AzureRmApplicationGatewayIPConfiguration -Name <String> [-Subnet <PSSubnet>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationGatewayIPConfiguration** cmdlet creates an IP configuration for an application gateway. -The IP configuration contains the subnet in which application gateway is deployed. - -## EXAMPLES - -### Example 1: Create an IP configuration for an application gateway. -``` -PS C:\>$VNet = Get-AzureRmvirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $VNet -PS C:\ $GatewayIpConfig = New-AzureRmApplicationGatewayIPConfiguration -Name "AppGwSubnet01" -Subnet $Subnet -``` - -The first command gets a virtual network named VNet01 that belongs to the resource group named ResourceGroup01. -The second command gets the subnet configuration for the subnet that the virtual network in the previous command belongs to, and stores it in the $Subnet variable. -The third command creates the IP configuration using $Subnet. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the IP configuration to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subnet -Specifies the subnet object. -This is the subnet in which the application gateway is deployed. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSSubnet -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetId -Specifies the subnet ID. -This is the subnet in which the application gateway would be deployed. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayIPConfiguration - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayIPConfiguration](./Add-AzureRmApplicationGatewayIPConfiguration.md) - -[Get-AzureRmApplicationGatewayIPConfiguration](./Get-AzureRmApplicationGatewayIPConfiguration.md) - -[Remove-AzureRmApplicationGatewayIPConfiguration](./Remove-AzureRmApplicationGatewayIPConfiguration.md) - -[Set-AzureRmApplicationGatewayIPConfiguration](./Set-AzureRmApplicationGatewayIPConfiguration.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayPathRuleConfig.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayPathRuleConfig.md deleted file mode 100644 index 9bf091c77f..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayPathRuleConfig.md +++ /dev/null @@ -1,257 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: A1F949A9-7AEF-41C1-B757-114421B79493 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewaypathruleconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayPathRuleConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayPathRuleConfig.md ---- - -# New-AzureRmApplicationGatewayPathRuleConfig - -## SYNOPSIS -Creates an application gateway path rule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -New-AzureRmApplicationGatewayPathRuleConfig -Name <String> - -Paths <System.Collections.Generic.List`1[System.String]> [-BackendAddressPoolId <String>] - [-BackendHttpSettingsId <String>] [-RedirectConfigurationId <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -New-AzureRmApplicationGatewayPathRuleConfig -Name <String> - -Paths <System.Collections.Generic.List`1[System.String]> - [-BackendAddressPool <PSApplicationGatewayBackendAddressPool>] - [-BackendHttpSettings <PSApplicationGatewayBackendHttpSettings>] - [-RedirectConfiguration <PSApplicationGatewayRedirectConfiguration>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationGatewayPathRuleConfig** cmdlet creates an application gateway path rule. -Rules created by this cmdlet can be added to a collection of URL path map configuration settings and then assigned to a gateway. -Path map configuration settings are used in application gateway load balancing. - -## EXAMPLES - -### Example 1 -``` -PS C:\>$Gateway = Get-AzureRmApplicationGateway -Name "ContosoApplicationGateway" -PS C:\> $AddressPool = New-AzureRmApplicationGatewayBackendAddressPool -Name "ContosoAddressPool" -BackendIPAddresses "192.168.1.1", "192.168.1.2" -PS C:\> $HttpSettings = New-AzureRmApplicationGatewayBackendHttpSettings -Name "ContosoHttpSetings" -Port 80 -Protocol "Http" -CookieBasedAffinity "Disabled" -PS C:\> $PathRuleConfig = New-AzureRmApplicationGatewayPathRuleConfig -Name "base" -Paths "/base" -BackendAddressPool $AddressPool -BackendHttpSettings $HttpSettings -PS C:\> Add-AzureRmApplicationGatewayUrlPathMapConfig -ApplicationGateway $Gateway -Name "ContosoUrlPathMap" -PathRules $PathRuleConfig -DefaultBackendAddressPool $AddressPool -DefaultBackendHttpSettings $HttpSettings -``` - -These commands create a new application gateway path rule and then use the **Add-AzureRmApplicationGatewayUrlPathMapConfig** cmdlet to assign that rule to an application gateway. -To do this, the first command creates an object reference to the gateway ContosoApplicationGateway. -This object reference is stored in a variable named $Gateway. -The next two commands create a backend address pool and a backend HTTP settings object; these objects (stored in the variables $AddressPool and $HttpSettings) are needed in order to create a path rule object. -The fourth command creates the path rule object and is stored in a variable named $PathRuleConfig. -The fifth command uses **Add-AzureRmApplicationGatewayUrlPathMapConfig** to add the configuration settings and the new path rule contained within those settings to ContosoApplicationGateway. - -## PARAMETERS - -### -BackendAddressPool -Specifies an object reference to a collection of backend address pool settings to be added to the gateway path rules configuration settings. -You can create this object reference by using the New-AzureRmApplicationGatewayBackendAddressPool cmdlet and syntax similar to this: -`$AddressPool = New-AzureRmApplicationGatewayBackendAddressPool -Name "ContosoAddressPool" -BackendIPAddresses "192.168.1.1", "192.168.1.2"` -The preceding command adds two IP addresses (192.16.1.1 and 192.168.1.2) to the address pool. -Note that the IP address are enclosed in quote marks and separated by using commas. -The resulting variable, $AddressPool, can then be used as the parameter value for the *DefaultBackendAddressPool* parameter. -The backend address pool represents the IP addresses on the backend servers. -These IP addresses should either belong to the virtual network subnet or should be public IP addresses. -If you use this parameter you cannot use the *DefaultBackendAddressPoolId* parameter in the same command. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendAddressPoolId -Specifies the ID of an existing backend address pool that can be added to the gateway path rule configuration settings. -Address pool IDs can be returned by using the Get-AzureRmApplicationGatewayBackendAddressPool cmdlet. -After you have the ID you can then use the *DefaultBackendAddressPoolId* parameter instead of the *DefaultBackendAddressPool* parameter. -For instance: --DefaultBackendAddressPoolId "/subscriptions/39c54063-01d3-4abf-8f4c-234777bc1f10/resourceGroups/appgw-rg/providers/Microsoft.Network/applicationGateways/appgwtest/backendAddressPools/ContosoAddressPool" -The backend address pool represents the IP addresses on the backend servers. -These IP addresses should either belong to the virtual network subnet or should be public IP addresses. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendHttpSettings -Specifies an object reference to a collection of backend HTTP settings to be added to the gateway path rule configuration settings. -You can create this object reference by using the New-AzureRmApplicationGatewayBackendHttpSettings cmdlet and syntax similar to this: -$HttpSettings = New-AzureRmApplicationGatewayBackendHttpSettings -Name "ContosoHttpSetings" -Port 80 -Protocol "Http" -CookieBasedAffinity "Disabled" -The resulting variable, $HttpSettings, can then be used as the parameter value for the *DefaultBackendAddressPool* parameter: --DefaultBackendHttpSettings $HttpSettings -The backend HTTP settings configure properties such as port, protocol, and cookie-based affinity for a backend pool. -If you use this parameter you cannot use the *DefaultBackendHttpSettingsId* parameter in the same command. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendHttpSettingsId -Specifies the ID of an existing backend HTTP settings collection that can be added to the gateway path rule configuration settings. -HTTP setting IDs can be returned by using the Get-AzureRmApplicationGatewayBackendHttpSettings cmdlet. -After you have the ID you can then use the *DefaultBackendHttpSettingsId* parameter instead of the *DefaultBackendHttpSettings* parameter. -For instance: --DefaultBackendSettings Id "/subscriptions/39c54063-01d3-4abf-8f4c-234777bc1f10/resourceGroups/appgw-rg/providers/Microsoft.Network/applicationGateways/appgwtest/backendHttpSettingsCollection/ContosoHttpSettings" -The backend HTTP settings configure properties such as port, protocol, and cookie-based affinity for a backend pool. -If you use this parameter you cannot use the *DefaultBackendHttpSettings* parameter in the same command. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the path rule configuration that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Paths -Specifies one or more application gateway path rules. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedirectConfiguration -Application gateway RedirectConfiguration - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRedirectConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedirectConfigurationId -ID of the application gateway RedirectConfiguration - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPathRule - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayUrlPathMapConfig](./Add-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[Get-AzureRmApplicationGateway](./Get-AzureRmApplicationGateway.md) - -[Get-AzureRmApplicationGatewayUrlPathMapConfig](./Get-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[New-AzureRmApplicationGatewayBackendAddressPool](./New-AzureRmApplicationGatewayBackendAddressPool.md) - -[New-AzureRmApplicationGatewayBackendHttpSettings](./New-AzureRmApplicationGatewayBackendHttpSettings.md) - -[New-AzureRmApplicationGatewayPathRuleConfig](./New-AzureRmApplicationGatewayPathRuleConfig.md) - -[New-AzureRmApplicationGatewayUrlPathMapConfig](./New-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[Remove-AzureRmApplicationGatewayUrlPathMapConfig](./Remove-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[Set-AzureRmApplicationGatewayUrlPathMapConfig](./Set-AzureRmApplicationGatewayUrlPathMapConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayProbeConfig.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayProbeConfig.md deleted file mode 100644 index 1900ae8964..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayProbeConfig.md +++ /dev/null @@ -1,241 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewayprobeconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayProbeConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayProbeConfig.md ---- - -# New-AzureRmApplicationGatewayProbeConfig - -## SYNOPSIS -Creates a health probe. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApplicationGatewayProbeConfig -Name <String> -Protocol <String> [-HostName <String>] -Path <String> - -Interval <Int32> -Timeout <Int32> -UnhealthyThreshold <Int32> [-PickHostNameFromBackendHttpSettings] - [-MinServers <Int32>] [-Match <PSApplicationGatewayProbeHealthResponseMatch>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmApplicationGatewayProbeConfig cmdlet creates a health probe. - -## EXAMPLES - -### Example1: Create a health probe -``` -PS C:\>New-AzureRmApplicationGatewayProbeConfig -Name "Probe03" -Protocol Http -HostName "contoso.com" -Path "/path/custompath.htm" -Interval 30 -Timeout 120 -UnhealthyThreshold 8 -``` - -This command creates a health probe named Probe03, with HTTP protocol, a 30 second interval, timeout of 120 seconds, and an unhealthy threshold of 8 retries. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostName -Specifies the host name that this cmdlet sends the probe. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Interval -Specifies the probe interval in seconds. -This is the time interval between two consecutive probes. -This value is between 1 second and 86400 seconds. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Match -Body that must be contained in the health response. -Default value is empty - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayProbeHealthResponseMatch -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinServers -Minimum number of servers that are always marked healthy. -Default value is 0 - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the probe. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the relative path of probe. -Valid paths start with the slash character (/). -The probe is sent to \<Protocol\>://\<host\>:\<port\>\<path\>. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PickHostNameFromBackendHttpSettings -Whether the host header should be picked from the backend http settings. -Default value is false - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol used to send probe. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Http, Https - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Timeout -Specifies the probe timeout in seconds. -This cmdlet marks the probe as failed if a valid response is not received with this timeout period. -Valid values are between 1 second and 86400 seconds. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UnhealthyThreshold -Specifies the probe retry count. -The backend server is marked down after consecutive probe failure count reaches the unhealthy threshold. -Valid values are between 1 second and 20 seconds. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayProbe - -## NOTES - -## RELATED LINKS - -[Create custom probe for Application Gateway using PowerShell for Azure Resource Manager](https://azure.microsoft.com/en-us/documentation/articles/application-gateway-create-probe-ps/#) - -[Add-AzureRmApplicationGatewayProbeConfig]() - -[Get-AzureRmApplicationGatewayProbeConfig]() - -[Remove-AzureRmApplicationGatewayProbeConfig]() - -[Set-AzureRmApplicationGatewayProbeConfig]() - diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayProbeHealthResponseMatch.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayProbeHealthResponseMatch.md deleted file mode 100644 index 0047c0947c..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayProbeHealthResponseMatch.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewayprobehealthresponsematch -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayProbeHealthResponseMatch.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayProbeHealthResponseMatch.md ---- - -# New-AzureRmApplicationGatewayProbeHealthResponseMatch - -## SYNOPSIS -Creates a health probe response match used by Health Probe for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApplicationGatewayProbeHealthResponseMatch [-Body <String>] - [-StatusCode <System.Collections.Generic.List`1[System.String]>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -**The Add-AzureRmApplicationGatewayProbeHealthResponseMatch** cmdlet creates a health probe response match used by Health Probe for an application gateway. - -## EXAMPLES - -### Example 1 -``` -PS C:\>$responsematch = New-AzureRmApplicationGatewayProbeHealthResponseMatch -Body "helloworld" -StatusCode "200-399","503" -``` - -This command creates a health response match which can be passed to ProbeConfig as a parameter. - -## PARAMETERS - -### -Body -Body that must be contained in the health response. -Default value is empty - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StatusCode -Allowed ranges of healthy status codes.Default range of healthy status codes is 200 - 399 - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayProbeHealthResponseMatch - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayRedirectConfiguration.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayRedirectConfiguration.md deleted file mode 100644 index a99411099c..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayRedirectConfiguration.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewayredirectconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayRedirectConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayRedirectConfiguration.md ---- - -# New-AzureRmApplicationGatewayRedirectConfiguration - -## SYNOPSIS -Creates a redirect configuration for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -New-AzureRmApplicationGatewayRedirectConfiguration -Name <String> -RedirectType <String> - [-TargetListenerID <String>] [-IncludePath <Boolean>] [-IncludeQueryString <Boolean>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -New-AzureRmApplicationGatewayRedirectConfiguration -Name <String> -RedirectType <String> - [-TargetListener <PSApplicationGatewayHttpListener>] [-IncludePath <Boolean>] [-IncludeQueryString <Boolean>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByURL -``` -New-AzureRmApplicationGatewayRedirectConfiguration -Name <String> -RedirectType <String> [-TargetUrl <String>] - [-IncludePath <Boolean>] [-IncludeQueryString <Boolean>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -**The New-AzureRmApplicationGatewayRedirectConfiguration** cmdlet creates a redirect configuration for an application gateway. - -## EXAMPLES - -### Example 1 -``` -PS C:\>$RedirectConfig = New-AzureRmApplicationGatewayRedirectConfiguration -Name "Redirect01" -RedirectType Permanent -TargetListener $listener01 -``` - -This command creates a redirect configuration named Redirect01 and stores the result in the variable named $RedirectConfig. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludePath -Include path in the redirected url. -Default is true. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeQueryString -Include query string in the redirected url. -Default is true. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the Redirect Configuration - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedirectType -The type of redirect - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Permanent, Found, SeeOther, Temporary - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetListener -HTTPListener to redirect the request to - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetListenerID -ID of listener to redirect the request to - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetUrl -Target URL fo redirection - -```yaml -Type: System.String -Parameter Sets: SetByURL -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRedirectConfiguration - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayRequestRoutingRule.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayRequestRoutingRule.md deleted file mode 100644 index 89ddd0ab0e..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayRequestRoutingRule.md +++ /dev/null @@ -1,267 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 622FE9AC-1CC4-489C-BB17-9D6B9D1C151D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewayrequestroutingrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayRequestRoutingRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayRequestRoutingRule.md ---- - -# New-AzureRmApplicationGatewayRequestRoutingRule - -## SYNOPSIS -Creates a request routing rule for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -New-AzureRmApplicationGatewayRequestRoutingRule -Name <String> -RuleType <String> - [-BackendHttpSettingsId <String>] [-HttpListenerId <String>] [-BackendAddressPoolId <String>] - [-UrlPathMapId <String>] [-RedirectConfigurationId <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### SetByResource -``` -New-AzureRmApplicationGatewayRequestRoutingRule -Name <String> -RuleType <String> - [-BackendHttpSettings <PSApplicationGatewayBackendHttpSettings>] - [-HttpListener <PSApplicationGatewayHttpListener>] - [-BackendAddressPool <PSApplicationGatewayBackendAddressPool>] [-UrlPathMap <PSApplicationGatewayUrlPathMap>] - [-RedirectConfiguration <PSApplicationGatewayRedirectConfiguration>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -**The Add-AzureRmApplicationGatewayRequestRoutingRule** cmdlet creates a request routing rule for an Azure application gateway. - -## EXAMPLES - -### Example 1: Create a request routing rule for an application gateway -``` -PS C:\>$Rule = New-AzureRmApplicationGatewayRequestRoutingRule -Name "Rule01" -RuleType Basic -BackendHttpSettings $Setting -HttpListener $Listener -BackendAddressPool $Pool -``` - -This command creates a basic request routing rule named Rule01 and stores the result in the variable named $Rule. - -## PARAMETERS - -### -BackendAddressPool -Specifies the back-end address pool, as an object, for the request routing rule to create. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendAddressPoolId -Specifies the back-end address pool ID of the request routing rule to create. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendHttpSettings -Specifies the back-end HTTP settings, as an object, for the request routing rule to create. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendHttpSettingsId -Specifies the back-end HTTP settings ID of the request routing rule to create. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpListener -Specifies the back-end HTTP listener for the request routing rule to create. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpListenerId -Specifies the backend HTTP listener ID for the request routing rule to create. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the request routing rule that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedirectConfiguration -Application gateway RedirectConfiguration - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRedirectConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedirectConfigurationId -ID of the application gateway RedirectConfiguration - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RuleType -Specifies type of the request routing rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Basic, PathBasedRouting - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UrlPathMap -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayUrlPathMap -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UrlPathMapId -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRequestRoutingRule - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayRequestRoutingRule](./Add-AzureRmApplicationGatewayRequestRoutingRule.md) - -[Get-AzureRmApplicationGatewayRequestRoutingRule](./Get-AzureRmApplicationGatewayRequestRoutingRule.md) - -[Remove-AzureRmApplicationGatewayRequestRoutingRule](./Remove-AzureRmApplicationGatewayRequestRoutingRule.md) - -[Set-AzureRmApplicationGatewayRequestRoutingRule](./Set-AzureRmApplicationGatewayRequestRoutingRule.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewaySku.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewaySku.md deleted file mode 100644 index 25ad0f7512..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewaySku.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 48C33FAF-83C1-4725-AD2A-CF48D0718182 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewaysku -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewaySku.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewaySku.md ---- - -# New-AzureRmApplicationGatewaySku - -## SYNOPSIS -Creates a SKU for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApplicationGatewaySku -Name <String> -Tier <String> [-Capacity <Int32>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationGatewaySku** cmdlet creates a stock keeping unit (SKU) for an Azure application gateway. - -## EXAMPLES - -### Example 1: Create a SKU for an Azure application gateway -``` -PS C:\>$SKU = New-AzureRmApplicationGatewaySku -Name "Standard_Small" -Tier "Standard" -Capacity 2 -``` - -This command creates a SKU named Standard_Small for an Azure application gateway and stores the result in the variable named $SKU. - -## PARAMETERS - -### -Capacity -Specifies the number of instances of an application gateway. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the SKU. -The acceptable values for this parameter are: -- Standard_Small -- Standard_Medium -- Standard_Large -- WAF_Medium -- WAF_Large - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Standard_Small, Standard_Medium, Standard_Large, WAF_Medium, WAF_Large, Standard_v2, WAF_v2 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tier -Specifies the tier of the SKU. -The acceptable values for this parameter are: -- Standard -- WAF - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Standard, WAF, Standard_v2, WAF_v2 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySku - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGatewaySku](./Get-AzureRmApplicationGatewaySku.md) - -[Set-AzureRmApplicationGatewaySku](./Set-AzureRmApplicationGatewaySku.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewaySslCertificate.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewaySslCertificate.md deleted file mode 100644 index 4c8c6cedf9..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewaySslCertificate.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 6FFE1B64-C80B-423D-A043-55C90A224752 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewaysslcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewaySslCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewaySslCertificate.md ---- - -# New-AzureRmApplicationGatewaySslCertificate - -## SYNOPSIS -Creates an SSL certificate for an Azure application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApplicationGatewaySslCertificate -Name <String> -CertificateFile <String> -Password <SecureString> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationGatewaySslCertificate** cmdlet creates an SSL certificate for an Azure application gateway. - -## EXAMPLES - -### Example 1: Create an SSL certificate for an Azure application gateway. -``` -PS C:\> $password = ConvertTo-SecureString "P@ssw0rd" -AsPlainText -Force -PS C:\> $cert = New-AzureRmApplicationGatewaySslCertificate -Name "Cert01" -CertificateFile "D:\cert01.pfx" -Password $password -``` - -This command creates a SSL certificate named Cert01 for the default application gateway and stores the result in the variable named $Cert. - -## PARAMETERS - -### -CertificateFile -Specifies the path of the .pfx file of the SSL certificate that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the SSL certificate that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -Specifies the password of the SSL that this cmdlet creates. - -```yaml -Type: System.Security.SecureString -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslCertificate - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewaySslCertificate](./Add-AzureRmApplicationGatewaySslCertificate.md) - -[Get-AzureRmApplicationGatewaySslCertificate](./Get-AzureRmApplicationGatewaySslCertificate.md) - -[Remove-AzureRmApplicationGatewaySslCertificate](./Remove-AzureRmApplicationGatewaySslCertificate.md) - -[Set-AzureRmApplicationGatewaySslCertificate](./Set-AzureRmApplicationGatewaySslCertificate.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewaySslPolicy.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewaySslPolicy.md deleted file mode 100644 index 789813f8c7..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewaySslPolicy.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 98FA4E95-CAC5-4FBD-AA84-113BE9ED7FEA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewaysslpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewaySslPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewaySslPolicy.md ---- - -# New-AzureRmApplicationGatewaySslPolicy - -## SYNOPSIS -Creates an SSL policy for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApplicationGatewaySslPolicy - [-DisabledSslProtocols <System.Collections.Generic.List`1[System.String]>] [-PolicyType <String>] - [-PolicyName <String>] [-CipherSuite <System.Collections.Generic.List`1[System.String]>] - [-MinProtocolVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationGatewaySslPolicy** cmdlet creates an SSL policy for an application gateway. - -## EXAMPLES - -### 1: -``` -PS C:\>$sslPolicy = New-AzureRmApplicationGatewaySslPolicy -PolicyType Custom -MinProtocolVersion TLSv1_1 -CipherSuite "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", "TLS_RSA_WITH_AES_128_GCM_SHA256" -``` - -This command creates a custom policy. - -## PARAMETERS - -### -CipherSuite -Ssl cipher suites to be enabled in the specified order to application gateway - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisabledSslProtocols -Specifies which protocols are disabled. -The acceptable values for this parameter are: -- TLSv1_0 -- TLSv1_1 -- TLSv1_2 - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: -Accepted values: TLSv1_0, TLSv1_1, TLSv1_2 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinProtocolVersion -Minimum version of Ssl protocol to be supported on application gateway - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: TLSv1_0, TLSv1_1, TLSv1_2 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName -Name of Ssl predefined policy - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyType -Type of Ssl Policy - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Predefined, Custom - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslPolicy - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Get-AzureRmApplicationGatewaySslPolicy](./Get-AzureRmApplicationGatewaySslPolicy.md) - -[Set-AzureRmApplicationGatewaySslPolicy](./Set-AzureRmApplicationGatewaySslPolicy.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayTrustedRootCertificate.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayTrustedRootCertificate.md deleted file mode 100644 index 1b19b045b7..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayTrustedRootCertificate.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewaytrustedrootcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayTrustedRootCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayTrustedRootCertificate.md ---- - -# New-AzureRmApplicationGatewayTrustedRootCertificate - -## SYNOPSIS -Creates a Trusted Root Certificate for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApplicationGatewayTrustedRootCertificate -Name <String> -CertificateFile <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationGatewayTrustedRootCertificate** cmdlet creates a Trusted Root Certificate for an Azure application gateway. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> $certFilePath = ".\rootCA.cer" -PS C:\> $trc = New-AzureRmApplicationGatewayTrustedRootCertificate -Name "trc1" --CertificateFile $certFilePath -``` - -This command creates a Trusted Root Certificate named List "trc1" and stores the result in the variable named $trc. - -## PARAMETERS - -### -CertificateFile -Path of certificate CER file - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the TrustedRoot certificate - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayTrustedRootCertificate - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayUrlPathMapConfig.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayUrlPathMapConfig.md deleted file mode 100644 index 29acb8e304..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayUrlPathMapConfig.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: F312FD6E-AF0F-4901-B763-741E1B46A654 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewayurlpathmapconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayUrlPathMapConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayUrlPathMapConfig.md ---- - -# New-AzureRmApplicationGatewayUrlPathMapConfig - -## SYNOPSIS -Creates an array of URL path mappings to a backend server pool. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -New-AzureRmApplicationGatewayUrlPathMapConfig -Name <String> - -PathRules <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPathRule]> - [-DefaultBackendAddressPoolId <String>] [-DefaultBackendHttpSettingsId <String>] - [-DefaultRedirectConfigurationId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -New-AzureRmApplicationGatewayUrlPathMapConfig -Name <String> - -PathRules <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPathRule]> - [-DefaultBackendAddressPool <PSApplicationGatewayBackendAddressPool>] - [-DefaultBackendHttpSettings <PSApplicationGatewayBackendHttpSettings>] - [-DefaultRedirectConfiguration <PSApplicationGatewayRedirectConfiguration>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationGatewayUrlPathMapConfig** cmdlet creates an array of URL path mappings to a backend server pool. - -## EXAMPLES - -### Example 1: Create an array of URL path mappings to a backend server pool -``` -PS C:\>New-AzureRmApplicationGatewayUrlPathMapConfig -Name $UrlPathMapName -PathRules $VideoPathRule, $ImagePathRule -DefaultBackendAddressPool $Pool -DefaultBackendHttpSettings $PoolSetting02 -``` - -This command creates an array of URL path mappings to a backend server pool. - -## PARAMETERS - -### -DefaultBackendAddressPool -Specifies the default backend address pool to route in case none of the rules specified in the *pathRules* parameter match. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultBackendAddressPoolId -Specifies the default backend address pool ID. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultBackendHttpSettings -Specifies the default backend HTTP settings to use in case none of the rules specified in the *pathRules* parameter match. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultBackendHttpSettingsId -Specifies the default backend HTTP settings ID. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultRedirectConfiguration -Application gateway default RedirectConfiguration - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRedirectConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultRedirectConfigurationId -ID of the application gateway default RedirectConfiguration - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the URL path map name that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PathRules -Specifies a list of path rules. -Note that the path rules are order sensitive, they are applied in order they are specified. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPathRule] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayUrlPathMap - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayUrlPathMapConfig](./Add-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[Get-AzureRmApplicationGatewayUrlPathMapConfig](./Get-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[Remove-AzureRmApplicationGatewayUrlPathMapConfig](./Remove-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[Set-AzureRmApplicationGatewayUrlPathMapConfig](./Set-AzureRmApplicationGatewayUrlPathMapConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md deleted file mode 100644 index a719a34b65..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md +++ /dev/null @@ -1,257 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 76DB6AF5-BF6F-436C-8500-626468F84466 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewaywebapplicationfirewallconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md ---- - -# New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration - -## SYNOPSIS -Creates a WAF configuration for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration -Enabled <Boolean> -FirewallMode <String> - [-RuleSetType <String>] [-RuleSetVersion <String>] - [-DisabledRuleGroup <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallDisabledRuleGroup]>] - [-RequestBodyCheck <Boolean>] [-MaxRequestBodySizeInKb <Int32>] [-FileUploadLimitInMb <Int32>] - [-Exclusion <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallExclusion]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration** cmdlet creates a web application firewall (WAF) configuration for an Azure application gateway. - -## EXAMPLES - -### Example 1: Create a web application firewall configuration for an application gateway -``` -PS C:\> $disabledRuleGroup1 = New-AzureRmApplicationGatewayFirewallDisabledRuleGroupConfig -RuleGroupName "REQUEST-942-APPLICATION-ATTACK-SQLI" -Rules 942130,942140 -PS C:\> $disabledRuleGroup2 = New-AzureRmApplicationGatewayFirewallDisabledRuleGroupConfig -RuleGroupName "REQUEST-921-PROTOCOL-ATTACK" -PS C:\> $firewallConfig = New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration -Enabled $true -FirewallMode "Prevention" -RuleSetType "OWASP" -RuleSetVersion "3.0" -DisabledRuleGroups $disabledRuleGroup1,$disabledRuleGroup2 -``` - -The first command creates a new disabled rule group configuration for the rule group named "REQUEST-942-APPLICATION-ATTACK-SQLI" with rule 942130 and rule 942140 being disabled. -The second command creates another disabled rule group configuration for a rule group named "REQUEST-921-PROTOCOL-ATTACK". No rules are specifically passed and thus all rules of the rule group will be disabled. -The last command then creates a WAF configuration with firewall rules disabled as configured in $disabledRuleGroup1 and $disabledRuleGroup2. The new WAF configuration is stored in the $firewallConfig variable. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisabledRuleGroup -The disabled rule groups. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallDisabledRuleGroup] -Parameter Sets: (All) -Aliases: DisabledRuleGroups - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Indicates whether the WAF is enabled. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Exclusion -The exclusion lists. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallExclusion] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileUploadLimitInMb -Max file upload limit in MB. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FirewallMode -Specifies the web application firewall mode. -The acceptable values for this parameter are: -- Detection -- Prevention - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Detection, Prevention - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxRequestBodySizeInKb -Max request body size in KB. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestBodyCheck -Whether request body is checked or not. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RuleSetType -The type of the web application firewall rule set. -The acceptable values for this parameter are: -- OWASP - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: OWASP - -Required: False -Position: Named -Default value: OWASP -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RuleSetVersion -The version of the rule set type. -The acceptable values for this parameter are: -- 3.0 -- 2.2.9 - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: 3.0, 2.2.9 - -Required: False -Position: Named -Default value: 3.0 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayWebApplicationFirewallConfiguration - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGatewayWebApplicationFirewallConfiguration](./Get-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md) - -[Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration](./Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationSecurityGroup.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationSecurityGroup.md deleted file mode 100644 index 7bd3ebcada..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmApplicationSecurityGroup.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationsecuritygroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationSecurityGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmApplicationSecurityGroup.md ---- - -# New-AzureRmApplicationSecurityGroup - -## SYNOPSIS -Creates an application security group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApplicationSecurityGroup -ResourceGroupName <String> -Name <String> -Location <String> - [-Tag <Hashtable>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationSecurityGroup** cmdlet creates an application security group. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmApplicationSecurityGroup -ResourceGroupName "MyResourceGroup" -Name "MyApplicationSecurityGroup" -Location "West US" -``` - -This example creates an application security group with no associations. Once it is created, IP configurations in the network interface can be included in the group. Security rules may also refer to the group as their sources or destinations. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation if you want to overwrite a resource. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The location. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The name of the application security group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name of the application security group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -A hashtable which represents resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationSecurityGroup](./Get-AzureRmApplicationSecurityGroup.md) - -[Remove-AzureRmApplicationSecurityGroup](./Remove-AzureRmApplicationSecurityGroup.md) - -[New-AzureRmNetworkSecurityRuleConfig](./New-AzureRmNetworkSecurityRuleConfig.md) - -[Add-AzureRmNetworkSecurityRuleConfig](./Add-AzureRmNetworkSecurityRuleConfig.md) - -[Set-AzureRmNetworkSecurityRuleConfig](./Set-AzureRmNetworkSecurityRuleConfig.md) - -[New-AzureRmNetworkInterfaceIpConfig](./New-AzureRmNetworkInterfaceIpConfig.md) - -[Add-AzureRmNetworkInterfaceIpConfig](./Add-AzureRmNetworkInterfaceIpConfig.md) - -[Set-AzureRmNetworkInterfaceIpConfig](./Set-AzureRmNetworkInterfaceIpConfig.md) diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmContainerNicConfig.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmContainerNicConfig.md deleted file mode 100644 index fab47936c1..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmContainerNicConfig.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-AzureRmNetworkProfileContainerNicconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmContainerNicConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmContainerNicConfig.md ---- - -# New-AzureRmNetworkProfileContainerNicConfig - -## SYNOPSIS -Creates a new container network interface configuration object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmNetworkProfileContainerNicConfig [-Name <String>] [-IpConfiguration <PSIPConfigurationProfile[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmNetworkProfileContainerNicConfig** cmdlet creates a new container network interface configuration object. This object determines the characteristics of container network interfacs created referencing the parent network profile. - -## EXAMPLES - -### Example 1 -```powershell -$containerNicConfig = New-AzureRmNetworkProfileContainerNicConfig -Name cnicConfig1 - -$networkProfile = New-AzureRmNetworkProfile -Name np1 -ResourceGroupName rg1 -Location westus -ContainerNetworkInterfaceConfiguration $containerNicConfig -``` - -The first command creates an empty container network interface configuration. The second creates a new network profile, passing the previously created container network interface configuration as an argument to the New-NetworkProfile cmdlet. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IpConfiguration -{{Fill IpConfiguration Description}} - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSIPConfigurationProfile[] -Parameter Sets: (All) -Aliases: IpConfig - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Name of the container network interface configuration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSIPConfigurationProfile, Microsoft.Azure.Commands.Network, Version=6.7.0.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSContainerNetworkInterfaceConfiguration - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmContainerNicConfigIpConfig.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmContainerNicConfigIpConfig.md deleted file mode 100644 index a612d21816..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmContainerNicConfigIpConfig.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-AzureRmNetworkProfileContainerNicconfigipconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmContainerNicConfigIpConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmContainerNicConfigIpConfig.md ---- - -# New-AzureRmNetworkProfileContainerNicConfigIpConfig - -## SYNOPSIS -Creates a container nic configuration ip configuration object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmNetworkProfileContainerNicConfigIpConfig -Name <String> -Subnet <PSSubnet> [-SubnetId <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmNetworkProfileContainerNicConfigIpConfig** cmdlet creates a new container network interface configuration ip configuration. - -## EXAMPLES - -### Example 1 -```powershell -$subnet = New-AzureRmVirtualNetworkSubnetConfig -Name subnet -AddressPrefix 10.0.1.0/24 - -$vnet = New-AzureRmVirtualNetwork -Name vnet -ResourceGroupName rg1 -Location "West US" -AddressPrefix 10.0.0.0/16 -Subnet $subnet - -$containerNicConfigIpConfig = New-AzureRmNetworkProfileContainerNicConfigIpConfig -Name ipconfigprofile1 -Subnet $vnet.Subnets[0] - -$containerNicConfig = New-AzureRmNetworkProfileContainerNicConfig -Name cnic -IpConfiguration containerNicConfigIpConfig - -$networkProfile = New-AzureRmNetworkProfile -Name np1 -Location "West US" -ResourceGroupName rg1 -ContainerNetworkInterfaceConfiguration $containerNicConfig -``` - -The first two commands create and initialize a vnet and a subnet. The third command creates a container nic ip configuration profile referencing the created subnet. The fourth command creates a container network interface configuration supplying the ip configuration profile created in the previous command. Finally, the fifth command creates a network profile initialized with the container network interface configuration stored in $containerNicConfig. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the container network interface configuration ip configuration profile. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subnet -Subnet - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSSubnet -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetId -SubnetId - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSContainerNetworkInterfaceConfiguration - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmDdosProtectionPlan.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmDdosProtectionPlan.md deleted file mode 100644 index 2dfd84ff6d..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmDdosProtectionPlan.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azuredosprotectionplan -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmDdosProtectionPlan.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmDdosProtectionPlan.md ---- - -# New-AzureRmDdosProtectionPlan - -## SYNOPSIS -Creates a DDoS protection plan. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmDdosProtectionPlan -ResourceGroupName <String> -Name <String> -Location <String> [-Tag <Hashtable>] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmDdosProtectionPlan cmdlet creates a DDoS protection plan. - -## EXAMPLES - -### Example 1: Create and associate a DDoS protection plan with a new virtual network -``` -D:\> $ddosProtectionPlan = New-AzureRmDdosProtectionPlan -ResourceGroupName ResourceGroupName -Name DdosProtectionPlanName -Location "West US" -D:\> $subnet = New-AzureRmVirtualNetworkSubnetConfig -Name SubnetName -AddressPrefix 10.0.1.0/24 -D:\> $vnet = New-AzureRmvirtualNetwork -Name VnetName -ResourceGroupName ResourceGroupName -Location "West US" -AddressPrefix 10.0.0.0/16 -DnsServer 8.8.8.8 -Subnet $subnet -EnableDdoSProtection -DdosProtectionPlanId $ddosProtectionPlan.Id -``` - -First, we create a new DDoS Protection plan with the **New-AzureRmDdosProtectionPlan** command. -Then, we create a new virtual network with **New-AzureRmvirtualNetwork** and we specify the ID of the newly created plan in the parameter **DdosProtectionPlanId**. In this case, since we are associating the virtual network with a plan, we can also specify the parameter **EnableDdoSProtection**. - -### Example 2: Create and associate a DDoS protection plan with an existing virtual network -``` -D:\> $ddosProtectionPlan = New-AzureRmDdosProtectionPlan -ResourceGroupName ResourceGroupName -Name DdosProtectionPlanName -Location "West US" -D:\> $vnet = Get-AzureRmVirtualNetwork -Name VnetName -ResourceGroupName ResourceGroupName -D:\> $vnet.DdosProtectionPlan = New-Object Microsoft.Azure.Commands.Network.Models.PSResourceId -D:\> $vnet.DdosProtectionPlan.Id = $ddosProtectionPlan.Id -D:\> $vnet.EnableDdosProtection = $true -D:\> $vnet | Set-AzureRmVirtualNetwork - - -Name : VnetName -ResourceGroupName : ResourceGroupName -Location : westus -Id : /subscriptions/d1dbd366-9871-45ac-84b7-fb318152a9e0/resourceGroups/ResourceGroupName/providers/Microsoft.Network/virtualNetworks/VnetName -Etag : W/"fbf41754-3c13-43fd-bb5b-fcc37d5e1cbb" -ResourceGuid : fcb7bc1e-ee0d-4005-b3f1-feda76e3756c -ProvisioningState : Succeeded -Tags : -AddressSpace : { - "AddressPrefixes": [ - "10.0.0.0/16" - ] - } -DhcpOptions : { - "DnsServers": [ - "8.8.8.8" - ] - } -Subnets : [ - { - "Name": "SubnetName", - "Etag": "W/\"fbf41754-3c13-43fd-bb5b-fcc37d5e1cbb\"", - "Id": "/subscriptions/d1dbd366-9871-45ac-84b7-fb318152a9e0/resourceGroups/ResourceGroupName/providers/Microsoft.Network/virtualNetworks/VnetName/subnets/SubnetName", - "AddressPrefix": "10.0.1.0/24", - "IpConfigurations": [], - "ResourceNavigationLinks": [], - "ServiceEndpoints": [], - "ProvisioningState": "Succeeded" - } - ] -VirtualNetworkPeerings : [] -EnableDdosProtection : true -DdosProtectionPlan : { - "Id": "/subscriptions/d1dbd366-9871-45ac-84b7-fb318152a9e0/resourceGroups/ResourceGroupName/providers/Microsoft.Network/ddosProtectionPlans/DdosProtectionPlanName" - } -EnableVmProtection : false -``` - -First, we create a new DDoS Protection plan with the **New-AzureRmDdosProtectionPlan** command. -Second, we get the most updated version of the virtual network we want to associate with the plan. We update the property **DdosProtectionPlan** with a **PSResourceId** object containing a reference to the ID of the newly created plan. In this case, if we associate the virtual network with a DDoS protection plan, we can also set the flag **EnableDdosProtection** to true. -Finally, we persist the new state by piping the local variable into **Set-AzureRmVirtualNetwork**. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the DDoS protection plan to be created. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the DDoS protection plan to be created. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group of the DDoS protection plan to be created. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -A hashtable which represents resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSDdosProtectionPlan - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDdosProtectionPlan](./Get-AzureRmDdosProtectionPlan.md) - -[Remove-AzureRmDdosProtectionPlan](./Remove-AzureRmDdosProtectionPlan.md) - -[New-AzureRmVirtualNetwork](./New-AzureRmVirtualNetwork.md) - -[Set-AzureRmVirtualNetwork](./Set-AzureRmVirtualNetwork.md) - -[Get-AzureRmVirtualNetwork](./Get-AzureRmVirtualNetwork.md) diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmDelegation.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmDelegation.md deleted file mode 100644 index f7acc0b30c..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmDelegation.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermdelegation -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmDelegation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmDelegation.md ---- - -# New-AzureRmDelegation - -## SYNOPSIS -Creates a service delegation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmDelegation -Name <String> -ServiceName <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmDelegation** cmdlet creates a service delegation that can be added to a subnet. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> $delegation = New-AzureRmDelegation -Name "myDelegation" -ServiceName "Microsoft.Sql/servers" -PS C:\> $vnet = Get-AzureRmVirtualNetwork -Name "myVNet" -ResourceGroupName "myResourceGroup" -PS C:\> $subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name "mySubnet" -VirtualNetwork $vnet -PS C:\> $subnet.Delegations.Add($delegation) -PS C:\> Set-AzureRmVirtualNetwork $vnet -``` - -The first cmdlet creates a delegation that can be added to a subnet, and stores it in the $delegation variable. The second and third cmdlets retrieve the subnet to be delegated. The fourth cmdlet adds the created delegation to the subnet of interest, and the final cmdlet sends the updated configuration to the server. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the delegation - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceName -The name of the service to which the subnet should be delegated - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSDelegation - -## NOTES - -## RELATED LINKS -[Add-AzureRmDelegation](./Add-AzureRmDelegation.md) -[Get-AzureRmDelegation](./Get-AzureRmDelegation.md) -[Remove-AzureRmDelegation](./Remove-AzureRmDelegation.md) -[Get-AzureRmVirtualNetwork](./Get-AzureRmVirtualNetwork.md) -[Get-AzureRmVirtualNetworkSubnetConfig](./Get-AzureRmVirtualNetworkSubnetConfig.md) -[Set-AzureRmVirtualNetwork](./Set-AzureRmVirtualNetwork.md) diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmExpressRouteCircuit.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmExpressRouteCircuit.md deleted file mode 100644 index 2d72c21355..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmExpressRouteCircuit.md +++ /dev/null @@ -1,401 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: E40CAF2F-ED57-4AC1-8B9A-E48042DD8F91 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermexpressroutecircuit -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmExpressRouteCircuit.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmExpressRouteCircuit.md ---- - -# New-AzureRmExpressRouteCircuit - -## SYNOPSIS -Creates an Azure express route circuit. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ServiceProvider -``` -New-AzureRmExpressRouteCircuit -Name <String> -ResourceGroupName <String> -Location <String> - [-SkuTier <String>] [-SkuFamily <String>] [-ServiceProviderName <String>] [-PeeringLocation <String>] - [-BandwidthInMbps <Int32>] - [-Peering <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSPeering]>] - [-Authorization <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuitAuthorization]>] - [-AllowClassicOperations <Boolean>] [-Tag <Hashtable>] [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ExpressRoutePort -``` -New-AzureRmExpressRouteCircuit -Name <String> -ResourceGroupName <String> -Location <String> - [-SkuTier <String>] [-SkuFamily <String>] [-ExpressRoutePort <PSExpressRoutePort>] [-BandwidthInGbps <Double>] - [-Peering <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSPeering]>] - [-Authorization <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuitAuthorization]>] - [-AllowClassicOperations <Boolean>] [-Tag <Hashtable>] [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmExpressRouteCircuit** cmdlet creates an Azure express route circuit. - -## EXAMPLES - -### Example 1: Create a new ExpressRoute circuit -``` -$parameters = @{ - Name='ExpressRouteCircuit' - ResourceGroupName='ExpressRouteResourceGroup' - Location='West US' - SkuTier='Standard' - SkuFamily='MeteredData' - ServiceProviderName='Equinix' - PeeringLocation='Silicon Valley' - BandwidthInMbps=200 -} -New-AzureRmExpressRouteCircuit @parameters -``` - -### Example 2: Create a new ExpressRoute circuit on ExpressRoutePort -``` -$parameters = @{ - Name='ExpressRouteCircuit' - ResourceGroupName='ExpressRouteResourceGroup' - Location='West US' - SkuTier='Standard' - SkuFamily='MeteredData' - ExpressRoutePort=$PSExpressRoutePort - BandwidthInGbps=10.0 -} -New-AzureRmExpressRouteCircuit @parameters -``` - -## PARAMETERS - -### -AllowClassicOperations -The use of this parameter allows you to use the classic Azure PowerShell cmdlets to manage the -circuit. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Authorization -A list of circuit authorizations. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuitAuthorization] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BandwidthInGbps -The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. - -```yaml -Type: Double -Parameter Sets: ExpressRoutePort -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BandwidthInMbps -The bandwidth of the circuit. This must be a value that is supported by the service provider. - -```yaml -Type: System.Int32 -Parameter Sets: ServiceProvider -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpressRoutePort -The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource. - -```yaml -Type: PSExpressRoutePort -Parameter Sets: ExpressRoutePort -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The location of the circuit. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The name of the ExpressRoute circuit being created. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Peering -A list peer configurations. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSPeering] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PeeringLocation -The name of the peering location supported by the service provider. - -```yaml -Type: System.String -Parameter Sets: ServiceProvider -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group that will contain the circuit. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceProviderName -The name of the circuit service provider. This must match a name listed by the -Get-AzureRmExpressRouteServiceProvider cmdlet. - -```yaml -Type: System.String -Parameter Sets: ServiceProvider -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuFamily -SKU family determines the billing type. Possible values for this parameter are: `MeteredData` or -`UnlimitedData`. Note that you can change the billing type from MeteredData to UnlimitedData, but -you can't change the type from UnlimitedData to MeteredData. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: MeteredData, UnlimitedData - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuTier -The tier of service for the circuit. Possible values for this parameter are: `Standard` or `Premium`. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Standard, Premium - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Int32 - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSPeering, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuitAuthorization, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit - -## NOTES - -## RELATED LINKS - -[Get-AzureRmExpressRouteCircuit](Get-AzureRmExpressRouteCircuit.md) - -[Move-AzureRmExpressRouteCircuit](Move-AzureRmExpressRouteCircuit.md) - -[Remove-AzureRmExpressRouteCircuit](Remove-AzureRmExpressRouteCircuit.md) - -[Set-AzureRmExpressRouteCircuit](Set-AzureRmExpressRouteCircuit.md) diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmExpressRouteCircuitAuthorization.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmExpressRouteCircuitAuthorization.md deleted file mode 100644 index f6cb4ba941..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmExpressRouteCircuitAuthorization.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: B6E55944-1B78-463F-9FC9-98097FEEC278 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermexpressroutecircuitauthorization -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmExpressRouteCircuitAuthorization.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmExpressRouteCircuitAuthorization.md ---- - -# New-AzureRmExpressRouteCircuitAuthorization - -## SYNOPSIS -Creates an ExpressRoute circuit authorization. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmExpressRouteCircuitAuthorization -Name <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmExpressRouteCircuitAuthorization** cmdlet creates a circuit authorization that can -be added to an ExpressRoute circuit. ExpressRoute circuits connect your on-premises network to the -Microsoft cloud by using a connectivity provider instead of the public Internet. The owner of an -ExpressRoute circuit can create as many as 10 authorizations for each circuit; these authorizations -generate an authorization key that can be used by a virtual network owner to connect a network to -the circuit. There can only one authorization per virtual network. -After you create an ExpressRoute circuit you can use -**Add-AzureRmExpressRouteCircuitAuthorization** to add an authorization to that circuit. -Alternatively, you can use **New-AzureRmExpressRouteCircuitAuthorization** to create an -authorization that can be added to a new circuit at the same time the circuit is created. - -## EXAMPLES - -### Example 1: Create a new circuit authorization -``` -$Authorization = New-AzureRmExpressRouteCircuitAuthorization -Name "ContosoCircuitAuthorization" -``` - -This command creates a new circuit authorization named ContosoCircuitAuthorization and then stores -that object in a variable named $Authorization. Saving the object to a variable is important: -although **New-AzureRmExpressRouteCircuitAuthorization** can create a circuit authorization it -cannot add that authorization to a circuit route. Instead, the variable $Authorization is used -New-AzureRmExpressRouteCircuit when creating a brand-new ExpressRoute circuit. -For more information, see the documentation for the New-AzureRmExpressRouteCircuit cmdlet. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a unique name for the new ExpressRoute circuit authorization. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuitAuthorization - -## NOTES - -## RELATED LINKS - -[Add-AzureRmExpressRouteCircuitAuthorization](./Add-AzureRmExpressRouteCircuitAuthorization.md) - -[Get-AzureRmExpressRouteCircuitAuthorization](./Get-AzureRmExpressRouteCircuitAuthorization.md) - -[Remove-AzureRmExpressRouteCircuitAuthorization](./Remove-AzureRmExpressRouteCircuitAuthorization.md) - diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmExpressRouteCircuitPeeringConfig.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmExpressRouteCircuitPeeringConfig.md deleted file mode 100644 index ce12c043bc..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmExpressRouteCircuitPeeringConfig.md +++ /dev/null @@ -1,348 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 5E9C02BE-9DCC-4865-95D2-6B69D373BE77 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermexpressroutecircuitpeeringconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmExpressRouteCircuitPeeringConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmExpressRouteCircuitPeeringConfig.md ---- - -# New-AzureRmExpressRouteCircuitPeeringConfig - -## SYNOPSIS -Creates a new peering configuration to be added to an ExpressRoute circuit. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -New-AzureRmExpressRouteCircuitPeeringConfig -Name <String> -PeeringType <String> -PeerASN <UInt32> - -PrimaryPeerAddressPrefix <String> -SecondaryPeerAddressPrefix <String> -VlanId <Int32> [-SharedKey <String>] - [-MicrosoftConfigAdvertisedPublicPrefixes <System.Collections.Generic.List`1[System.String]>] - [-MicrosoftConfigCustomerAsn <Int32>] [-MicrosoftConfigRoutingRegistryName <String>] - [-PeerAddressType <String>] [-LegacyMode <Boolean>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### MicrosoftPeeringConfigRoutFilterId -``` -New-AzureRmExpressRouteCircuitPeeringConfig -Name <String> -PeeringType <String> -PeerASN <UInt32> - -PrimaryPeerAddressPrefix <String> -SecondaryPeerAddressPrefix <String> -VlanId <Int32> [-SharedKey <String>] - [-MicrosoftConfigAdvertisedPublicPrefixes <System.Collections.Generic.List`1[System.String]>] - [-MicrosoftConfigCustomerAsn <Int32>] [-MicrosoftConfigRoutingRegistryName <String>] -RouteFilterId <String> - [-PeerAddressType <String>] [-LegacyMode <Boolean>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### MicrosoftPeeringConfigRoutFilter -``` -New-AzureRmExpressRouteCircuitPeeringConfig -Name <String> -PeeringType <String> -PeerASN <UInt32> - -PrimaryPeerAddressPrefix <String> -SecondaryPeerAddressPrefix <String> -VlanId <Int32> [-SharedKey <String>] - [-MicrosoftConfigAdvertisedPublicPrefixes <System.Collections.Generic.List`1[System.String]>] - [-MicrosoftConfigCustomerAsn <Int32>] [-MicrosoftConfigRoutingRegistryName <String>] - -RouteFilter <PSRouteFilter> [-PeerAddressType <String>] [-LegacyMode <Boolean>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmExpressRouteCircuitPeeringConfig** cmdlet adds a peering configuration to an -ExpressRoute circuit. ExpressRoute circuits connect your on-premises network to the Microsoft cloud -by using a connectivity provider instead of the public Internet. - -## EXAMPLES - -### Example 1: Create a new ExpressRoute circuit with a peering configuration -``` -$parameters = @{ - Name = 'AzurePrivatePeering' - Circuit = $circuit - PeeringType = 'AzurePrivatePeering' - PeerASN = 100 - PrimaryPeerAddressPrefix = '10.6.1.0/30' - SecondaryPeerAddressPrefix = '10.6.2.0/30' - VlanId = 200 -} -$PeerConfig = New-AzureRmExpressRouteCircuitPeeringConfig @parameters - -$parameters = @{ - Name='ExpressRouteCircuit' - ResourceGroupName='ExpressRouteResourceGroup' - Location='West US' - SkuTier='Standard' - SkuFamily='MeteredData' - ServiceProviderName='Equinix' - Peering=$PeerConfig - PeeringLocation='Silicon Valley' - BandwidthInMbps=200 -} -New-AzureRmExpressRouteCircuit @parameters -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LegacyMode -The legacy mode of the Peering - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MicrosoftConfigAdvertisedPublicPrefixes -For a PeeringType of MicrosoftPeering, you must provide a list of all prefixes you plan to -advertise over the BGP session. Only public IP address prefixes are accepted. You can send a comma -separated list if you plan to send a set of prefixes. These prefixes must be registered to you in -a Routing Registry Name (RIR / IRR). - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MicrosoftConfigCustomerAsn -If you are advertising prefixes that are not registered to the peering AS number, you can specify -the AS number to which they are registered. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MicrosoftConfigRoutingRegistryName -The Routing Registry Name (RIR / IRR) to which the AS number and prefixes are registered. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the peering configuration to be created. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PeerAddressType -PeerAddressType - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: IPv4, IPv6 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PeerASN -The AS number of your ExpressRoute circuit. This must be a Public ASN when the PeeringType is -AzurePublicPeering. - -```yaml -Type: System.UInt32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PeeringType -The acceptable values for this parameter are: `AzurePrivatePeering`, `AzurePublicPeering`, and -`MicrosoftPeering` - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: AzurePrivatePeering, AzurePublicPeering, MicrosoftPeering - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimaryPeerAddressPrefix -This is the IP Address range for the primary routing path of this peering relationship. This must -be a /30 CIDR subnet. The first odd-numbered address in this subnet should be assigned to your -router interface. Azure will configure the next even-numbered address to the Azure router interface. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteFilter -This is an existing RouteFilter object. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSRouteFilter -Parameter Sets: MicrosoftPeeringConfigRoutFilter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RouteFilterId -This is the resource Id of an existing RouteFilter object. - -```yaml -Type: System.String -Parameter Sets: MicrosoftPeeringConfigRoutFilterId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecondaryPeerAddressPrefix -This is the IP Address range for the secondary routing path of this peering relationship. This must -be a /30 CIDR subnet. The first odd-numbered address in this subnet should be assigned to your -router interface. Azure will configure the next even-numbered address to the Azure router interface. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharedKey -This is an optional MD5 hash used as a pre-shared key for the peering configuration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VlanId -This is the Id number of the VLAN assigned for this peering. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Network.Models.PSRouteFilter - -### System.Boolean - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSPeering - -## NOTES - -## RELATED LINKS - -[Add-AzureRmExpressRouteCircuitPeeringConfig](Add-AzureRmExpressRouteCircuitPeeringConfig.md) - -[Get-AzureRmExpressRouteCircuit](Get-AzureRmExpressRouteCircuit.md) - -[Remove-AzureRmExpressRouteCircuitPeeringConfig](Remove-AzureRmExpressRouteCircuitPeeringConfig.md) - -[Set-AzureRmExpressRouteCircuit](Set-AzureRmExpressRouteCircuit.md) diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmExpressRoutePort.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmExpressRoutePort.md deleted file mode 100644 index 5ab250d716..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmExpressRoutePort.md +++ /dev/null @@ -1,297 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermexpressrouteport -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmExpressRoutePort.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmExpressRoutePort.md ---- - -# New-AzureRmExpressRoutePort - -## SYNOPSIS -Creates an Azure ExpressRoutePort. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceNameParameterSet (Default) -``` -New-AzureRmExpressRoutePort -ResourceGroupName <String> -Name <String> -PeeringLocation <String> - -BandwidthInGbps <Int32> -Encapsulation <String> -Location <String> [-Tag <Hashtable>] - [-Link <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSExpressRouteLink]>] - [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -New-AzureRmExpressRoutePort -ResourceId <String> -PeeringLocation <String> -BandwidthInGbps <Int32> - -Encapsulation <String> -Location <String> [-Tag <Hashtable>] - [-Link <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSExpressRouteLink]>] - [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmExpressRoutePort** cmdlet creates an Azure ExpressRoutePort - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> $parameters = @{ - Name='ExpressRoutePort' - ResourceGroupName='ExpressRouteResourceGroup' - Location='West US' - PeeringLocation='Silicon Valley' - BandwidthInGbps=100 - Encapsulation='QinQ' -} -PS C:\> New-AzureRmExpressRoutePort @parameters -``` - -### Example 2 -```powershell -PS C:\> $parameters = @{ - ResourceId='/subscriptions/<SubId>/resourceGroups/<ResourceGroupName>/providers/Microsoft.Network/expressRoutePorts/<PortName>' - Location='West US' - PeeringLocation='Silicon Valley' - BandwidthInGbps=100 - Encapsulation='QinQ' -} -PS C:\> New-AzureRmExpressRoutePort @parameters -``` - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BandwidthInGbps -Bandwidth of procured ports in Gbps - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Encapsulation -Encapsulation method on physical ports. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation if you want to overwrite a resource - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Link -The set of physical links of the ExpressRoutePort resource - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSExpressRouteLink] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -The location. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The name of the ExpressRoutePort. - -```yaml -Type: System.String -Parameter Sets: ResourceNameParameterSet -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PeeringLocation -The name of the peering location that the ExpressRoutePort is mapped to physically. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name of the ExpressRoutePort. - -```yaml -Type: System.String -Parameter Sets: ResourceNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -ResourceId of the express route port. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -A hashtable which represents resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Int32 - -### System.Collections.Hashtable - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSExpressRouteLink, Microsoft.Azure.Commands.Network, Version=6.3.0.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmFirewall.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmFirewall.md deleted file mode 100644 index 0b6ddb70cc..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmFirewall.md +++ /dev/null @@ -1,302 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: A3D60CF1-2E66-4EE5-9C68-932DD8DF80BD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermfirewall -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmFirewall.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmFirewall.md ---- - -# New-AzureRmFirewall - -## SYNOPSIS -Creates a new Firewall in a resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmFirewall -Name <String> -ResourceGroupName <String> -Location <String> - [-VirtualNetworkName <String>] [-PublicIpName <String>] - [-ApplicationRuleCollection <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSAzureFirewallApplicationRuleCollection]>] - [-NatRuleCollection <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSAzureFirewallNatRuleCollection]>] - [-NetworkRuleCollection <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSAzureFirewallNetworkRuleCollection]>] - [-Tag <Hashtable>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmFirewall** cmdlet creates an Azure Firewall. - -## EXAMPLES - -### 1: Create a Firewall attached to a virtual network -``` -New-AzureRmFirewall -Name "azFw" -ResourceGroupName "rg" -Location centralus -VirtualNetworkName "vnet" -PublicIpName "pip-name" -``` - -This example creates a Firewall attached to virtual network "vnet" in the same resource group as the firewall. -Since no rules were specified, the firewall will block all traffic (default behavior). - -### 2: Create a Firewall which allows all HTTPS traffic -``` -$rule = New-AzureRmFirewallApplicationRule -Name R1 -Protocol "https:443" -TargetFqdn "*" -$ruleCollection = New-AzureRmFirewallApplicationRuleCollection -Name RC1 -Priority 100 -Rule $rule -ActionType "Allow" -New-AzureRmFirewall -Name "azFw" -ResourceGroupName "rg" -Location centralus -VirtualNetworkName "vnet" -PublicIpName "pip-name" -ApplicationRuleCollection $ruleCollection -``` - -This example creates a Firewall which allows all HTTPS traffic on port 443. - -### 3: DNAT - redirect traffic destined to 10.1.2.3:80 to 10.2.3.4:8080 -``` -$rule = New-AzureRmFirewallNatRule -Name "natRule" -Protocol "TCP" -SourceAddress "*" -DestinationAddress "10.1.2.3" -DestinationPort "80" -TranslatedAddress "10.2.3.4" -TranslatedPort "8080" -$ruleCollection = New-AzureRmFirewallNatRuleCollection -Name "NatRuleCollection" -Priority 1000 -Rule $rule -New-AzureRmFirewall -Name "azFw" -ResourceGroupName "rg" -Location centralus -NatRuleCollection $ruleCollection -``` - -This example created a Firewall which translated the destination IP and port of all packets destined to 10.1.2.3:80 to 10.2.3.4:8080 - -## PARAMETERS - -### -ApplicationRuleCollection -Specifies the collections of application rules for the new Firewall. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSAzureFirewallApplicationRuleCollection] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the region for the Firewall. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Azure Firewall that this cmdlet creates. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NatRuleCollection -The list of AzureFirewallNatRuleCollections - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSAzureFirewallNatRuleCollection] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkRuleCollection -The list of AzureFirewallNetworkRuleCollections - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSAzureFirewallNetworkRuleCollection] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublicIpName -Public Ip Name. The Public IP must use Standard SKU and must belong to the same resource group as the Firewall. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group to contain the Firewall. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkName -Specifies the name of the virtual network for which the Firewall will be deployed. Virtual network and Firewall must belong to the same resource group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSFirewall - -## NOTES - -## RELATED LINKS - -[Get-AzureRmFirewall](./Get-AzureRmFirewall.md) - -[Remove-AzureRmFirewall](./Remove-AzureRmFirewall.md) - -[Set-AzureRmFirewall](./Set-AzureRmFirewall.md) - -[New-AzureRmFirewallApplicationRuleCollection](./New-AzureRmFirewallApplicationRuleCollection.md) - -[New-AzureRmFirewallNatRuleCollection](./New-AzureRmFirewallNatRuleCollection.md) - -[New-AzureRmFirewallNetworkRuleCollection](./New-AzureRmFirewallNetworkRuleCollection.md) diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmFirewallApplicationRule.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmFirewallApplicationRule.md deleted file mode 100644 index 2ee30ae608..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmFirewallApplicationRule.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: C0E1D4DF-232F-49C6-BE4C-05C8E8038329 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermfirewallapplicationrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmFirewallApplicationRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmFirewallApplicationRule.md ---- - -# New-AzureRmFirewallApplicationRule - -## SYNOPSIS -Creates a Firewall Application Rule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### TargetFqdn (Default) -``` -New-AzureRmFirewallApplicationRule -Name <String> [-Description <String>] - [-SourceAddress <System.Collections.Generic.List`1[System.String]>] - -TargetFqdn <System.Collections.Generic.List`1[System.String]> - -Protocol <System.Collections.Generic.List`1[System.String]> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### FqdnTag -``` -New-AzureRmFirewallApplicationRule -Name <String> [-Description <String>] - [-SourceAddress <System.Collections.Generic.List`1[System.String]>] - -FqdnTag <System.Collections.Generic.List`1[System.String]> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmFirewallApplicationRule** cmdlet creates an application rule for Azure Firewall. - -## EXAMPLES - -### 1: Create a rule to allow all HTTPS traffic from 10.0.0.0 -``` -New-AzureRmFirewallApplicationRule -Name "https-rule" -Protocol "https:443" -TargetFqdn "*" -SourceAddress "10.0.0.0" -``` - -This example creates a rule which will allow all HTTPS traffic on port 443 from 10.0.0.0. - -### 2: Create a rule to allow WindowsUpdate for 10.0.0.0/24 subnet -``` -New-AzureRmFirewallApplicationRule -Name "windows-update-rule" -FqdnTag WindowsUpdate -SourceAddress "10.0.0.0/24" -``` - -This example creates a rule which will allow traffic for Windows Updates for 10.0.0.0/24 domain. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies an optional description of this rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FqdnTag -Specifies a list of FQDN Tags for this rule. The available tags can be retrieved using [Get-AzureRmFirewallFqdnTag](./Get-AzureRmFirewallFqdnTag.md) cmdlet. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: FqdnTag -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of this application rule. The name must be unique inside a rule collection. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the type of traffic to be filtered by this rule. The format is `<protocol type>:<port>`. -For example, "http:80" or "https:443". -Protocol is mandatory when TargetFqdn is used, but it cannot be used with FqdnTag. The supported protocols are HTTP and HTTPS. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: TargetFqdn -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceAddress -The source addresses of the rule - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetFqdn -Specifies a list of domain names filtered by this rule. -The asterik character, '*', is accepted only as the first character of an FQDN in the list. When used, the asterik matches any number of characters. (e.g. '*msn.com' will match msn.com and all its subdomains) - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: TargetFqdn -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSFirewallApplicationRule - -## NOTES - -## RELATED LINKS - -[New-AzureRmFirewallApplicationRuleCollection](./New-AzureRmFirewallApplicationRuleCollection.md) - -[New-AzureRmFirewall](./New-AzureRmFirewall.md) - -[Get-AzureRmFirewall](./Get-AzureRmFirewall.md) - -[Get-AzureRmFirewallFqdnTag](./Get-AzureRmFirewallFqdnTag.md) diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmFirewallApplicationRuleCollection.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmFirewallApplicationRuleCollection.md deleted file mode 100644 index 9bdb3d6817..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmFirewallApplicationRuleCollection.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: A29E9921-C1B9-42C2-B816-5D4873AC6688 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermfirewallapplicationrulecollection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmFirewallApplicationRuleCollection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmFirewallApplicationRuleCollection.md ---- - -# New-AzureRmFirewallApplicationRuleCollection - -## SYNOPSIS -Creates a collection of Firewall application rules. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmFirewallApplicationRuleCollection -Name <String> -Priority <UInt32> - -Rule <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSAzureFirewallApplicationRule]> - -ActionType <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmFirewallApplicationRuleCollection** cmdlet creates a collection of Firewall Application Rules. - -## EXAMPLES - -### 1: Create a collection with one rule -``` -$rule1 = New-AzureRmFirewallApplicationRule -Name "httpsRule" -Protocol "https:443" -TargetFqdn "*" -SourceAddress "10.0.0.0" -New-AzureRmFirewallApplicationRuleCollection -Name "MyAppRuleCollection" -Priority 1000 -Rule $rule1 -ActionType "Allow" -``` - -This example creates a collection with one rule. All traffic that matches the conditions identified in $rule1 will be allowed. -The first rule is for all HTTPS traffic on port 443 from 10.0.0.0. -If there is another application rule collection with higher priority (smaller number) which also matches traffic identified in $rule1, -the action of the rule collection with higher priority will take in effect instead. - -### 2: Add a rule to a rule collection -``` -$rule1 = New-AzureRmFirewallApplicationRule -Name R1 -Protocol "http:80","https:443" -TargetFqdn "*google.com", "*microsoft.com" -SourceAddress "10.0.0.0" -$ruleCollection = New-AzureRmFirewallApplicationRuleCollection -Name "MyAppRuleCollection" -Priority 100 -Rule $rule1 -ActionType "Allow" - -$rule2 = New-AzureRmFirewallApplicationRule -Name R2 -Protocol "http:80","https:443" -TargetFqdn "*google.com", "*microsoft.com" -$ruleCollection.AddRule($rule2) -``` - -This example creates a new application rule collection with one rule and then adds a second rule to the rule collection using method -AddRule on the rule collection object. Each rule name in a given rule collection must have a unique name and is case insensitive. - -### 3: Get a rule from a rule collection -``` -$rule1 = New-AzureRmFirewallApplicationRule -Name R1 -Protocol "http:80","https:443" -TargetFqdn "*google.com", "*microsoft.com" -SourceAddress "10.0.0.0" -$ruleCollection = New-AzureRmFirewallApplicationRuleCollection -Name "MyAppRuleCollection" -Priority 100 -Rule $rule1 -ActionType "Allow" -$getRule=$ruleCollection.GetRuleByName("r1") -``` - -This example creates a new application rule collection with one rule and then gets the rule by name, calling method GetRuleByName on the -rule collection object. The rule name for method GetRuleByName is case-insensitive. - -### 4: Remove a rule from a rule collection -``` -$rule1 = New-AzureRmFirewallApplicationRule -Name R1 -Protocol "http:80","https:443" -TargetFqdn "*google.com", "*microsoft.com" -SourceAddress "10.0.0.0" -$rule2 = New-AzureRmFirewallApplicationRule -Name R2 -Protocol "http:80","https:443" -TargetFqdn "*google.com", "*microsoft.com" -$ruleCollection = New-AzureRmFirewallApplicationRuleCollection -Name "MyAppRuleCollection" -Priority 100 -Rule $rule1, $rule1 -ActionType "Allow" -$ruleCollection.RemoveRuleByName("r1") -``` - -This example creates a new application rule collection with two rules and then removes the first rule from the rule collection by calling method -RemoveRuleByName on the rule collection object. The rule name for method RemoveRuleByName is case-insensitive. - -## PARAMETERS - -### -ActionType -The action of the rule collection - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Allow, Deny - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of this application rule. The name must be unique inside a rule collection. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -Specifies the priority of this rule. Priority is a number between 100 and 65000. The smaller the number, the bigger the priority. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rule -Specifies the list of rules to be grouped under this collection. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSAzureFirewallApplicationRule] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSFirewallApplicationRuleCollection - -## NOTES - -## RELATED LINKS - -[New-AzureRmFirewallApplicationRule](./New-AzureRmFirewallApplicationRule.md) - -[New-AzureRmFirewall](./New-AzureRmFirewall.md) - -[Get-AzureRmFirewall](./Get-AzureRmFirewall.md) diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmFirewallNatRule.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmFirewallNatRule.md deleted file mode 100644 index 5247fece8a..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmFirewallNatRule.md +++ /dev/null @@ -1,232 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: C0E1D4DF-232F-49C6-BE4C-05C8E8038329 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermfirewallnatrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmFirewallNatRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmFirewallNatRule.md ---- - -# New-AzureRmFirewallNatRule - -## SYNOPSIS -Creates a Firewall NAT Rule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmFirewallNatRule -Name <String> [-Description <String>] - -SourceAddress <System.Collections.Generic.List`1[System.String]> - -DestinationAddress <System.Collections.Generic.List`1[System.String]> - -DestinationPort <System.Collections.Generic.List`1[System.String]> - -Protocol <System.Collections.Generic.List`1[System.String]> -TranslatedAddress <String> - -TranslatedPort <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmFirewallNatRule** cmdlet creates a NAT rule for Azure Firewall. - -## EXAMPLES - -### 1: Create a rule to DNAT all TCP traffic from 10.0.0.0/24 with destination 10.1.2.3:80 to destination 10.4.5.6:8080 -``` -New-AzureRmFirewallNatRule -Name "dnat-rule" -Protocol "TCP" -SourceAddress "10.0.0.0/24" -DestinationAddress "10.1.2.3" -DestinationPort "80" -TranslatedAddress "10.4.5.6" -TranslatedPort "8080" -``` - -This example creates a rule which will DNAT all traffic originating in 10.0.0.0/24 with destination 10.1.2.3:80 to 10.4.5.6:8080 - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies an optional description of this rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationAddress -The destination addresses of the rule. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationPort -The destination ports of the rule - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of this NAT rule. The name must be unique inside a rule collection. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the type of traffic to be filtered by this rule. -The supported protocols are TCP and UDP. -A special value "Any" is allowed, meaning it will match both TCP and UDP, but no other protocols. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: -Accepted values: Any, TCP, UDP - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceAddress -The source addresses of the rule - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TranslatedAddress -Specifies the desired result of the address translation - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TranslatedPort -Specifies the desired result of the port translation - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSFirewallNatRule - -## NOTES - -## RELATED LINKS - -[New-AzureRmFirewallNatRuleCollection](./New-AzureRmFirewallNatRuleCollection.md) - -[New-AzureRmFirewall](./New-AzureRmFirewall.md) - -[Get-AzureRmFirewall](./Get-AzureRmFirewall.md) diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmFirewallNatRuleCollection.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmFirewallNatRuleCollection.md deleted file mode 100644 index c91ba0d629..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmFirewallNatRuleCollection.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: A29E9921-C1B9-42C2-B816-5D4873AC6688 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermfirewallnatrulecollection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmFirewallNatRuleCollection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmFirewallNatRuleCollection.md ---- - -# New-AzureRmFirewallNatRuleCollection - -## SYNOPSIS -Creates a collection of Firewall NAT rules. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmFirewallNatRuleCollection -Name <String> -Priority <UInt32> - -Rule <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSAzureFirewallNatRule]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmFirewallNatRuleCollection** cmdlet creates a collection of Firewall NAT Rules. - -## EXAMPLES - -### 1: Create a collection with one rule -``` -$rule1 = New-AzureRmFirewallNatRule -Name "natRule" -Protocol "TCP" -SourceAddress "*" -DestinationAddress "10.0.0.1" -DestinationPort "80" -TranslatedAddress "10.0.0.2" -TranslatedPort "8080" -New-AzureRmFirewallNatRuleCollection -Name "MyNatRuleCollection" -Priority 1000 -Rule $rule1 -``` - -This example creates a collection with one rule. All traffic that matches the conditions identified in $rule1 will be DNAT'ed to translated address and port. - -### 2: Add a rule to a rule collection -``` -$rule1 = New-AzureRmFirewallNatRule -Name R1 -Protocol "UDP","TCP" -SourceAddress "*" -DestinationAddress "10.0.0.1" -DestinationPort "80" -TranslatedAddress "10.0.0.2" -TranslatedPort "8080" -$ruleCollection = New-AzureRmFirewallNatRuleCollection -Name "MyNatRuleCollection" -Priority 100 -Rule $rule1 - -$rule2 = New-AzureRmFirewallNatRule -Name R2 -Protocol "TCP" -SourceAddress "*" -DestinationAddress "10.0.0.1" -DestinationPort "443" -TranslatedAddress "10.0.0.2" -TranslatedPort "8443" -$ruleCollection.AddRule($rule2) -``` - -This example creates a new NAT rule collection with one rule and then adds a second rule to the rule collection using method -AddRule on the rule collection object. Each rule name in a given rule collection must have an unique name and is case insensitive. - -### 3: Get a rule from a rule collection -``` -$rule1 = New-AzureRmFirewallNatRule -Name R1 -Protocol "TCP" -SourceAddress "10.0.0.0/24" -DestinationAddress "10.0.1.0/24" -DestinationPort "443" -TranslatedAddress "10.0.0.2" -TranslatedPort "8443" -$ruleCollection = New-AzureRmFirewallNatRuleCollection -Name "MyNatRuleCollection" -Priority 100 -Rule $rule1 - -$rule=$ruleCollection.GetRuleByName("r1") -``` - -This example creates a new NAT rule collection with one rule and then gets the rule by name, calling method GetRuleByName on the -rule collection object. The rule name for method GetRuleByName is case-insensitive. - -### 4: Remove a rule from a rule collection -``` -$rule1 = New-AzureRmFirewallNatRule -Name R1 -Protocol "UDP","TCP" -SourceAddress "*" -DestinationAddress "10.0.0.1" -DestinationPort "80" -TranslatedAddress "10.0.0.2" -TranslatedPort "8080" -$rule2 = New-AzureRmFirewallNatRule -Name R2 -Protocol "TCP" -SourceAddress "*" -DestinationAddress "10.0.0.1" -DestinationPort "443" -TranslatedAddress "10.0.0.2" -TranslatedPort "8443" -$ruleCollection = New-AzureRmFirewallNatRuleCollection -Name "MyNatRuleCollection" -Priority 100 -Rule $rule1, $rule2 -$ruleCollection.RemoveRuleByName("r1") -``` - -This example creates a new NAT rule collection with two rules and then removes the first rule from the rule collection by calling method -RemoveRuleByName on the rule collection object. The rule name for method RemoveRuleByName is case-insensitive. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of this NAT rule. The name must be unique inside a rule collection. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -Specifies the priority of this rule. Priority is a number between 100 and 65000. The smaller the number, the bigger the priority. - -```yaml -Type: System.UInt32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rule -Specifies the list of rules to be grouped under this collection. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSAzureFirewallNatRule] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSFirewallNatRuleCollection - -## NOTES - -## RELATED LINKS - -[New-AzureRmFirewallNatRule](./New-AzureRmFirewallNatRule.md) - -[New-AzureRmFirewall](./New-AzureRmFirewall.md) - -[Get-AzureRmFirewall](./Get-AzureRmFirewall.md) diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmFirewallNetworkRule.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmFirewallNetworkRule.md deleted file mode 100644 index d158764888..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmFirewallNetworkRule.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: C0E1D4DF-232F-49C6-BE4C-05C8E8038329 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermfirewallnetworkrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmFirewallNetworkRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmFirewallNetworkRule.md ---- - -# New-AzureRmFirewallNetworkRule - -## SYNOPSIS -Creates a Firewall Network Rule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmFirewallNetworkRule -Name <String> [-Description <String>] - -SourceAddress <System.Collections.Generic.List`1[System.String]> - -DestinationAddress <System.Collections.Generic.List`1[System.String]> - -DestinationPort <System.Collections.Generic.List`1[System.String]> - -Protocol <System.Collections.Generic.List`1[System.String]> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmFirewallNetworkRule** cmdlet creates an network rule for Azure Firewall. - -## EXAMPLES - -### 1: Create a rule for all TCP traffic -``` -$rule = New-AzureRmFirewallNetworkRule -Name "all-tcp-traffic" -Description "Rule for all TCP traffic" -Protocol TCP -SourceAddress "*" -DestinationAddress "*" -DestinationPort "*" -``` - -This example creates a rule for all TCP traffic. User enforces whether traffic will be allowed or denied for a rule based on the rule collection it is associated with. - -### 2: Create a rule for all TCP traffic from 10.0.0.0 to 60.1.5.0:4040 -``` -$rule = New-AzureRmFirewallNetworkRule -Name "partial-tcp-rule" -Description "Rule for all TCP traffic from 10.0.0.0 to 60.1.5.0:4040" -Protocol TCP -SourceAddress "10.0.0.0" -DestinationAddress "60.1.5.0" -DestinationPort "4040" -``` - -This example creates a rule for all TCP traffic from 10.0.0.0 to 60.1.5.0:4040. User enforces whether traffic will be allowed or denied for a rule based on the rule collection it is associated with. - -### 3: Create a rule for all TCP and ICMP traffic from any source to 10.0.0.0/16 -``` -$rule = New-AzureRmFirewallNetworkRule -Name "tcp-and-icmp-rule" -Description "Rule for all TCP and ICMP traffic from any source to 10.0.0.0/16" -Protocol TCP,ICMP -SourceAddress * -DestinationAddress "10.0.0.0/16" -DestinationPort * -``` - -This example creates a rule for all TCP traffic from 10.0.0.0 to 60.1.5.0:4040. User enforces whether traffic will be allowed or denied for a rule based on the rule collection it is associated with. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies an optional description of this rule. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationAddress -The destination addresses of the rule - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationPort -The destination ports of the rule - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of this network rule. The name must be unique inside a rule collection. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the type of traffic to be filtered by this rule. Possible values are TCP, UDP, ICMP and Any. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceAddress -The source addresses of the rule - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSFirewallNetworkRule - -## NOTES - -## RELATED LINKS - -[New-AzureRmFirewallNetworkRuleCollection](./New-AzureRmFirewallNetworkRuleCollection.md) - -[New-AzureRmFirewall](./New-AzureRmFirewall.md) - -[Get-AzureRmFirewall](./Get-AzureRmFirewall.md) diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmFirewallNetworkRuleCollection.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmFirewallNetworkRuleCollection.md deleted file mode 100644 index f9f8e05f98..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmFirewallNetworkRuleCollection.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: A29E9921-C1B9-42C2-B816-5D4873AC6688 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermfirewallnetworkrulecollection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmFirewallNetworkRuleCollection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmFirewallNetworkRuleCollection.md ---- - -# New-AzureRmFirewallNetworkRuleCollection - -## SYNOPSIS -Creates a Azure Firewall Network Collection of Network rules. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmFirewallNetworkRuleCollection -Name <String> -Priority <UInt32> - -Rule <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSAzureFirewallNetworkRule]> - -ActionType <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmFirewallNetworkRuleCollection** cmdlet creates a collection of Firewall Network Rules. - -## EXAMPLES - -### 1: Create a network collection with two rules -``` -$rule1 = New-AzureRmFirewallNetworkRule -Name "all-udp-traffic" -Description "Rule for all UDP traffic" -Protocol UDP -SourceAddress "*" -DestinationAddress "*" -DestinationPort "*" -$rule2 = New-AzureRmFirewallNetworkRule -Name "partial-tcp-rule" -Description "Rule for all TCP traffic from 10.0.0.0 to 60.1.5.0:4040" -Protocol TCP -SourceAddress "10.0.0.0" -DestinationAddress "60.1.5.0" -DestinationPort "4040" -New-AzureRmFirewallNetworkRuleCollection -Name RC1 -Priority 100 -Rule $rule1, $rule2 -ActionType "Allow" -``` - -This example creates a collection which will allow all traffic that matches either of the two rules. -The first rule is for all UDP traffic. -The second rule is for TCP traffic from 10.0.0.0 to 60.1.5.0:4040. -If there is another Network rule collection with higher priority (smaller number) which also matches traffic identified in $rule1 or $rule2, -the action of the rule collection with higher priority will take in effect instead. - -### 2: Add a rule to a rule collection -``` -$rule1 = New-AzureRmFirewallNetworkRule -Name "all-udp-traffic" -Description "Rule for all UDP traffic" -Protocol UDP -SourceAddress "*" -DestinationAddress "*" -DestinationPort "*" -$ruleCollection = New-AzureRmFirewallNetworkRuleCollection -Name "MyNetworkRuleCollection" -Priority 100 -Rule $rule1 -ActionType "Allow" - -$rule2 = New-AzureRmFirewallNetworkRule -Name "partial-tcp-rule" -Description "Rule for all TCP traffic from 10.0.0.0 to 60.1.5.0:4040" -Protocol TCP -SourceAddress "10.0.0.0" -DestinationAddress "60.1.5.0" -DestinationPort "4040" -$ruleCollection.AddRule($rule2) -``` - -This example creates a new network rule collection with one rule and then adds a second rule to the rule collection using method -AddRule on the rule collection object. Each rule name in a given rule collection must have a unique name and is case insensitive. - -### 3: Get a rule from a rule collection -``` -$rule1 = New-AzureRmFirewallNetworkRule -Name "all-udp-traffic" -Description "Rule for all UDP traffic" -Protocol UDP -SourceAddress "*" -DestinationAddress "*" -DestinationPort "*" -$ruleCollection = New-AzureRmFirewallNetworkRuleCollection -Name "MyNetworkRuleCollection" -Priority 100 -Rule $rule1 -ActionType "Allow" -$getRule=$ruleCollection.GetRuleByName("ALL-UDP-traffic") -``` - -This example creates a new network rule collection with one rule and then gets the rule by name, calling method GetRuleByName on the -rule collection object. The rule name for method GetRuleByName is case-insensitive. - -### 4: Remove a rule from a rule collection -``` -$rule1 = New-AzureRmFirewallNetworkRule -Name "all-udp-traffic" -Description "Rule for all UDP traffic" -Protocol UDP -SourceAddress "*" -DestinationAddress "*" -DestinationPort "*" -$rule2 = New-AzureRmFirewallNetworkRule -Name "partial-tcp-rule" -Description "Rule for all TCP traffic from 10.0.0.0 to 60.1.5.0:4040" -Protocol TCP -SourceAddress "10.0.0.0" -DestinationAddress "60.1.5.0" -DestinationPort "4040" -$ruleCollection = New-AzureRmFirewallNetworkRuleCollection -Name "MyNetworkRuleCollection" -Priority 100 -Rule $rule1, $rule2 -ActionType "Allow" -$ruleCollection.RemoveRuleByName("ALL-udp-traffic") -``` - -This example creates a new network rule collection with two rules and then removes the first rule from the rule collection by calling method -RemoveRuleByName on the rule collection object. The rule name for method RemoveRuleByName is case-insensitive. - -## PARAMETERS - -### -ActionType -Specifies the action to be taken for traffic matching conditions of this rule. Accepted actions are "Allow" or "Deny". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Allow, Deny - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of this network rule collection. The name must be unique across all network rule collection. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -Specifies the priority of this rule collection. Priority is a number between 100 and 65000. The smaller the number, the higher the priority. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rule -Specifies the list of rules to be grouped under this collection. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSAzureFirewallNetworkRule] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSFirewallNetworkRuleCollection - -## NOTES - -## RELATED LINKS - -[New-AzureRmFirewallNetworkRule](./New-AzureRmFirewallNetworkRule.md) - -[New-AzureRmFirewall](./New-AzureRmFirewall.md) - -[Get-AzureRmFirewall](./Get-AzureRmFirewall.md) diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmIpsecPolicy.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmIpsecPolicy.md deleted file mode 100644 index 238092d9db..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmIpsecPolicy.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermipsecpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmIpsecPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmIpsecPolicy.md ---- - -# New-AzureRmIpsecPolicy - -## SYNOPSIS -Creates an IPSec Policy. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmIpsecPolicy [-SALifeTimeSeconds <Int32>] [-SADataSizeKilobytes <Int32>] -IpsecEncryption <String> - -IpsecIntegrity <String> -IkeEncryption <String> -IkeIntegrity <String> -DhGroup <String> -PfsGroup <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmIpsecPolicy cmdlet creates an IPSec policy proposal to be used in a virtual network gateway connection. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $ipsecPolicy = New-AzureRmIpsecPolicy -SALifeTimeSeconds 1000 -SADataSizeKilobytes 2000 -IpsecEncryption "GCMAES256" -IpsecIntegrity "GCMAES256" -IkeEncryption "AES256" -IkeIntegrity "SHA256" -DhGroup "DHGroup14" -PfsGroup "PFS2048" -PS C:\> New-AzureRmVirtualNetworkGatewayConnection -ResourceGroupName $rgname -name $vnetConnectionName -location $location -VirtualNetworkGateway1 $vnetGateway -LocalNetworkGateway2 $localnetGateway -ConnectionType IPsec -RoutingWeight 3 -SharedKey $sharedKey -UsePolicyBasedTrafficSelectors $true -IpsecPolicies $ipsecPolicy -``` - -Creating an IPSec policy to be used for a new virtual network gateway connection. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DhGroup -The DH Groups used in IKE Phase 1 for initial SA - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: None, DHGroup1, DHGroup14, DHGroup2, DHGroup2048, DHGroup24, ECP256, ECP384 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IkeEncryption -The IKE encryption algorithm (IKE Phase 2) - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: DES, DES3, AES128, AES192, AES256 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IkeIntegrity -The IKE integrity algorithm (IKE Phase 2) - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: MD5, SHA1, SHA256, SHA384 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IpsecEncryption -The IPSec encryption algorithm (IKE Phase 1) - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: None, DES, DES3, AES128, AES192, AES256, GCMAES128, GCMAES192, GCMAES256 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IpsecIntegrity -The IPSec integrity algorithm (IKE Phase 1) - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: MD5, SHA1, SHA256, GCMAES128, GCMAES192, GCMAES256 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PfsGroup -The DH Groups used in IKE Phase 2 for new child SA - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: None, PFS1, PFS2, PFS2048, PFS24, ECP256, ECP384 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SADataSizeKilobytes -The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SALifeTimeSeconds -The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmLoadBalancer.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmLoadBalancer.md deleted file mode 100644 index c6b0ee574e..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmLoadBalancer.md +++ /dev/null @@ -1,351 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: F1522074-7EEA-4DCF-AC16-26FE8E654720 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermloadbalancer -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmLoadBalancer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmLoadBalancer.md ---- - -# New-AzureRmLoadBalancer - -## SYNOPSIS -Creates a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmLoadBalancer -ResourceGroupName <String> -Name <String> -Location <String> [-Tag <Hashtable>] - [-Sku <String>] - [-FrontendIpConfiguration <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration]>] - [-BackendAddressPool <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool]>] - [-LoadBalancingRule <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSLoadBalancingRule]>] - [-Probe <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSProbe]>] - [-InboundNatRule <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSInboundNatRule]>] - [-InboundNatPool <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSInboundNatPool]>] - [-OutboundRule <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSOutboundRule]>] - [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmLoadBalancer** cmdlet creates an Azure load balancer. - -## EXAMPLES - -### Example 1: Create a load balancer -``` -PS C:\>$publicip = New-AzureRmPublicIpAddress -ResourceGroupName "MyResourceGroup" -Name "MyPublicIp" -Location "West US" -AllocationMethod "Dynamic" -PS C:\> $frontend = New-AzureRmLoadBalancerFrontendIpConfig -Name "MyFrontEnd" -PublicIpAddress $publicip -PS C:\> $backendAddressPool = New-AzureRmLoadBalancerBackendAddressPoolConfig -Name "MyBackendAddPoolConfig02" -PS C:\> $probe = New-AzureRmLoadBalancerProbeConfig -Name "MyProbe" -Protocol "http" -Port 80 -IntervalInSeconds 15 -ProbeCount 2 -RequestPath "healthcheck.aspx" -PS C:\> $inboundNatRule1 = New-AzureRmLoadBalancerInboundNatRuleConfig -Name "MyinboundNatRule1" -FrontendIPConfiguration $frontend -Protocol "Tcp" -FrontendPort 3389 -BackendPort 3389 -IdleTimeoutInMinutes 15 -EnableFloatingIP -PS C:\> $inboundNatRule2 = New-AzureRmLoadBalancerInboundNatRuleConfig -Name "MyinboundNatRule2" -FrontendIPConfiguration $frontend -Protocol "Tcp" -FrontendPort 3391 -BackendPort 3392 -PS C:\> $lbrule = New-AzureRmLoadBalancerRuleConfig -Name "MyLBruleName" -FrontendIPConfiguration $frontend -BackendAddressPool $backendAddressPool -Probe $probe -Protocol "Tcp" -FrontendPort 80 -BackendPort 80 -IdleTimeoutInMinutes 15 -EnableFloatingIP -LoadDistribution SourceIP -PS C:\> $lb = New-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -Location "West US" -FrontendIpConfiguration $frontend -BackendAddressPool $backendAddressPool -Probe $probe -InboundNatRule $inboundNatRule1,$inboundNatRule2 -LoadBalancingRule $lbrule -PS C:\> Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -``` - -Deploying a load balancer requires that you first create several objects, and the first seven -commands show how to create those objects. -The eighth command creates a load balancer named MyLoadBalancer in the resource group named -MyResourceGroup. -The ninth and last command gets the new load balancer to ensure it was successfully created. -Note that this example only shows how to create a load balancer. You must also configure it using -the Add-AzureRmNetworkInterfaceIpConfig cmdlet to assign the NICs to different virtual machines. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendAddressPool -Specifies a backend address pool to associate with a load balancer. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Indicates that this cmdlet creates a load balancer even if a load balancer with the same name already exists. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIpConfiguration -Specifies a list of front-end IP addresses to associate with a load balancer. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InboundNatPool -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSInboundNatPool] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InboundNatRule -Specifies a list of inbound network address translation (NAT) rules to associate with a load balancer. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSInboundNatRule] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancingRule -Specifies a list of load balancing rules to associate with a load balancer. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSLoadBalancingRule] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the region in which to create a load balancer. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the load balancer that this creates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OutboundRule -The outbound rules. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSOutboundRule] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Probe -Specifies a list of probes to associate with a load balancer. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSProbe] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group in which to create a load balancer. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -The load balancer Sku name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Generic.List\`1[[Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List\`1[[Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List\`1[[Microsoft.Azure.Commands.Network.Models.PSProbe, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List\`1[[Microsoft.Azure.Commands.Network.Models.PSInboundNatRule, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List\`1[[Microsoft.Azure.Commands.Network.Models.PSLoadBalancingRule, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Hashtable - -### System.Collections.Generic.List\`1[[Microsoft.Azure.Commands.Network.Models.PSInboundNatPool, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[Add-AzureRmNetworkInterfaceIpConfig](./Add-AzureRmNetworkInterfaceIpConfig.md) - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[Remove-AzureRmLoadBalancer](./Remove-AzureRmLoadBalancer.md) - -[Set-AzureRmLoadBalancer](./Set-AzureRmLoadBalancer.md) diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmLoadBalancerBackendAddressPoolConfig.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmLoadBalancerBackendAddressPoolConfig.md deleted file mode 100644 index ab7a970142..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmLoadBalancerBackendAddressPoolConfig.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 67AD15B0-94EB-486F-8C17-606EA5F702D3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermloadbalancerbackendaddresspoolconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmLoadBalancerBackendAddressPoolConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmLoadBalancerBackendAddressPoolConfig.md ---- - -# New-AzureRmLoadBalancerBackendAddressPoolConfig - -## SYNOPSIS -Creates a backend address pool configuration for a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmLoadBalancerBackendAddressPoolConfig -Name <String> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmLoadBalancerBackendAddressPoolConfig** cmdlet creates a backend address pool configuration for an Azure load balancer. - -## EXAMPLES - -### Example 1: Create a backend address pool configuration for a load balancer -``` -PS C:\>New-AzureRmLoadBalancerBackendAddressPoolConfig -Name "BackendAddressPool02" -``` - -This command creates a backend address pool configuration named BackendAddressPool02 for a load balancer. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the address pool configuration to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerBackendAddressPoolConfig](./Add-AzureRmLoadBalancerBackendAddressPoolConfig.md) - -[Get-AzureRmLoadBalancerBackendAddressPoolConfig](./Get-AzureRmLoadBalancerBackendAddressPoolConfig.md) - -[Remove-AzureRmLoadBalancerBackendAddressPoolConfig](./Remove-AzureRmLoadBalancerBackendAddressPoolConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmLoadBalancerFrontendIpConfig.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmLoadBalancerFrontendIpConfig.md deleted file mode 100644 index 273e2ff237..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmLoadBalancerFrontendIpConfig.md +++ /dev/null @@ -1,240 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: D639E4F5-5AAD-4F13-9B48-70E90D2DFFCA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermloadbalancerfrontendipconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmLoadBalancerFrontendIpConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmLoadBalancerFrontendIpConfig.md ---- - -# New-AzureRmLoadBalancerFrontendIpConfig - -## SYNOPSIS -Creates a front-end IP configuration for a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceSubnet (Default) -``` -New-AzureRmLoadBalancerFrontendIpConfig -Name <String> [-PrivateIpAddress <String>] - [-Zone <System.Collections.Generic.List`1[System.String]>] -Subnet <PSSubnet> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByResourceIdSubnet -``` -New-AzureRmLoadBalancerFrontendIpConfig -Name <String> [-PrivateIpAddress <String>] - [-Zone <System.Collections.Generic.List`1[System.String]>] -SubnetId <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByResourceIdPublicIpAddress -``` -New-AzureRmLoadBalancerFrontendIpConfig -Name <String> - [-Zone <System.Collections.Generic.List`1[System.String]>] -PublicIpAddressId <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByResourcePublicIpAddress -``` -New-AzureRmLoadBalancerFrontendIpConfig -Name <String> - [-Zone <System.Collections.Generic.List`1[System.String]>] -PublicIpAddress <PSPublicIpAddress> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmLoadBalancerFrontendIpConfig** cmdlet creates a front-end IP configuration for an Azure load balancer. - -## EXAMPLES - -### Example 1: Create a front-end IP configuration for a load balancer -``` -PS C:\>$publicip = New-AzureRmPublicIpAddress -ResourceGroupName "MyResourceGroup" -Name "MyPublicIP" -Location "West US" -AllocationMethod "Dynamic" -PS C:\> New-AzureRmLoadBalancerFrontendIpConfig -Name "FrontendIpConfig01" -PublicIpAddress $publicip -``` - -The first command creates a dynamic public IP address named MyPublicIP in the resource group named MyResourceGroup, and then stores it in the $publicip variable. -The second command creates a front-end IP configuration named FrontendIpConfig01 using the public IP address in $publicip. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the front-end IP configuration that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateIpAddress -Specifies the private IP address of the load balancer. -Specify this parameter only if you also specify the *Subnet* parameter. - -```yaml -Type: System.String -Parameter Sets: SetByResourceSubnet, SetByResourceIdSubnet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublicIpAddress -Specifies the **PublicIpAddress** object to associate with a front-end IP configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress -Parameter Sets: SetByResourcePublicIpAddress -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublicIpAddressId -Specifies the ID of the **PublicIpAddress** object to associate with a front-end IP configuration. - -```yaml -Type: System.String -Parameter Sets: SetByResourceIdPublicIpAddress -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Subnet -Specifies the **Subnet** object in which to create a front-end IP configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSSubnet -Parameter Sets: SetByResourceSubnet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubnetId -Specifies the ID of the subnet in which to create a front-end IP configuration. - -```yaml -Type: System.String -Parameter Sets: SetByResourceIdSubnet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Zone -A list of availability zones denoting the IP allocated for the resource needs to come from. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Collections.Generic.List\`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerFrontendIpConfig](./Add-AzureRmLoadBalancerFrontendIpConfig.md) - -[Get-AzureRmLoadBalancerFrontendIpConfig](./Get-AzureRmLoadBalancerFrontendIpConfig.md) - -[New-AzureRmPublicIpAddress](./New-AzureRmPublicIpAddress.md) - -[Remove-AzureRmLoadBalancerFrontendIpConfig](./Remove-AzureRmLoadBalancerFrontendIpConfig.md) - -[Set-AzureRmLoadBalancerFrontendIpConfig](./Set-AzureRmLoadBalancerFrontendIpConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmLoadBalancerInboundNatPoolConfig.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmLoadBalancerInboundNatPoolConfig.md deleted file mode 100644 index 35562e4e00..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmLoadBalancerInboundNatPoolConfig.md +++ /dev/null @@ -1,242 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 61C34433-A16A-4ACF-A318-1C7D9E49579F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermloadbalancerinboundnatpoolconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmLoadBalancerInboundNatPoolConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmLoadBalancerInboundNatPoolConfig.md ---- - -# New-AzureRmLoadBalancerInboundNatPoolConfig - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -New-AzureRmLoadBalancerInboundNatPoolConfig -Name <String> -Protocol <String> -FrontendPortRangeStart <Int32> - -FrontendPortRangeEnd <Int32> -BackendPort <Int32> [-IdleTimeoutInMinutes <Int32>] [-EnableFloatingIP] - [-EnableTcpReset] [-FrontendIpConfiguration <PSFrontendIPConfiguration>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByResourceId -``` -New-AzureRmLoadBalancerInboundNatPoolConfig -Name <String> -Protocol <String> -FrontendPortRangeStart <Int32> - -FrontendPortRangeEnd <Int32> -BackendPort <Int32> [-IdleTimeoutInMinutes <Int32>] [-EnableFloatingIP] - [-EnableTcpReset] [-FrontendIpConfigurationId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION - -## EXAMPLES - -### 1: New -``` -PS C:\> $slb = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -PS C:\> $feIpConfig = Get-AzureRmLoadBalancerFrontendIpConfig -Name "FrontendName" -Loadbalancer $slb -PS C:\> New-AzureRmLoadBalancerInboundNatPoolConfig -Name "myInboundNatPool" -FrontendIpConfigurationId $feIpConfig.Id -Protocol TCP -FrontendPortRangeStart 1001 -FrontendPortRangeEnd 2000 -BackendPort 1001 -``` - -## PARAMETERS - -### -BackendPort -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableFloatingIP -Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableTcpReset -Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIpConfiguration -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FrontendIpConfigurationId -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FrontendPortRangeEnd -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FrontendPortRangeStart -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IdleTimeoutInMinutes -The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSInboundNatPool - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmLoadBalancerInboundNatRuleConfig.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmLoadBalancerInboundNatRuleConfig.md deleted file mode 100644 index c68808d50a..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmLoadBalancerInboundNatRuleConfig.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 4AA587F8-4967-439D-84B6-EDC24235D3F5 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermloadbalancerinboundnatruleconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmLoadBalancerInboundNatRuleConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmLoadBalancerInboundNatRuleConfig.md ---- - -# New-AzureRmLoadBalancerInboundNatRuleConfig - -## SYNOPSIS -Creates an inbound NAT rule configuration for a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -New-AzureRmLoadBalancerInboundNatRuleConfig -Name <String> [-Protocol <String>] [-FrontendPort <Int32>] - [-BackendPort <Int32>] [-IdleTimeoutInMinutes <Int32>] [-EnableFloatingIP] [-EnableTcpReset] - [-FrontendIpConfiguration <PSFrontendIPConfiguration>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### SetByResourceId -``` -New-AzureRmLoadBalancerInboundNatRuleConfig -Name <String> [-Protocol <String>] [-FrontendPort <Int32>] - [-BackendPort <Int32>] [-IdleTimeoutInMinutes <Int32>] [-EnableFloatingIP] [-EnableTcpReset] - [-FrontendIpConfigurationId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmLoadBalancerInboundNatRuleConfig** cmdlet creates an inbound network address translation (NAT) rule configuration for an Azure load balancer. - -## EXAMPLES - -### Example 1: Create an inbound NAT rule configuration for a load balancer -``` -PS C:\>$publicip = New-AzureRmPublicIpAddress -ResourceGroupName "MyResourceGroup" -Name "MyPublicIP" -Location "West US" -AllocationMethod "Dynamic" -PS C:\> $frontend = New-AzureRmLoadBalancerFrontendIpConfig -Name "FrontendIpConfig01" -PublicIpAddress $publicip -PS C:\> New-AzureRmLoadBalancerInboundNatRuleConfig -Name "MyInboundNatRule" -FrontendIPConfiguration $frontend -Protocol "Tcp" -FrontendPort 3389 -BackendPort 3389 -``` - -The first command creates a public IP address named MyPublicIP in the resource group named MyResourceGroup, and then stores it in the $publicip variable. -The second command creates a front-end IP configuration named FrontendIpConfig01 using the public IP address in $publicip, and then stores it in the $frontend variable. -The third command creates an inbound NAT rule configuration named MyInboundNatRule using the front-end object in $frontend. -The TCP protocol is specified and the front-end port is 3389, the same as the backend port in this case. -The *FrontendIpConfiguration*, *Procotol*, *FrontendPort*, and *BackendPort* parameters are all required to create an inbound NAT rule configuration. - -## PARAMETERS - -### -BackendPort -Specifies the backend port for traffic that is matched by this rule configuration. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableFloatingIP -Indicates that this cmdlet enables a floating IP address for a rule configuration. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableTcpReset -Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIpConfiguration -Specifies a list of front-end IP addresses to associate with a load balancer rule configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FrontendIpConfigurationId -Specifies the ID for a front-end IP address configuration. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FrontendPort -Specifies the front-end port that is matched by a load balancer rule configuration. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IdleTimeoutInMinutes -Specifies the length of time, in minutes, for which the state of conversations is maintained in a load balancer. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the rule configuration that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies a protocol. -The acceptable values for this parameter are: -- Tcp -- Udp - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSInboundNatRule - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerInboundNatRuleConfig](./Add-AzureRmLoadBalancerInboundNatRuleConfig.md) - -[Get-AzureRmLoadBalancerInboundNatRuleConfig](./Get-AzureRmLoadBalancerInboundNatRuleConfig.md) - -[New-AzureRmLoadBalancerFrontendIpConfig](./New-AzureRmLoadBalancerFrontendIpConfig.md) - -[New-AzureRmPublicIpAddress](./New-AzureRmPublicIpAddress.md) - -[Remove-AzureRmLoadBalancerInboundNatRuleConfig](./Remove-AzureRmLoadBalancerInboundNatRuleConfig.md) - -[Set-AzureRmLoadBalancerInboundNatRuleConfig](./Set-AzureRmLoadBalancerInboundNatRuleConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmLoadBalancerOutboundRuleConfig.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmLoadBalancerOutboundRuleConfig.md deleted file mode 100644 index 23c105e65d..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmLoadBalancerOutboundRuleConfig.md +++ /dev/null @@ -1,243 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermloadbalanceroutboundruleconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmLoadBalancerOutboundRuleConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmLoadBalancerOutboundRuleConfig.md ---- - -# New-AzureRmLoadBalancerOutboundRuleConfig - -## SYNOPSIS -Creates an outbound rule configuration for a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -New-AzureRmLoadBalancerOutboundRuleConfig -Name <String> [-AllocatedOutboundPort <Int32>] -Protocol <String> - [-EnableTcpReset] [-IdleTimeoutInMinutes <Int32>] - -FrontendIpConfiguration <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSResourceId]> - -BackendAddressPool <PSBackendAddressPool> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### SetByResourceId -``` -New-AzureRmLoadBalancerOutboundRuleConfig -Name <String> [-AllocatedOutboundPort <Int32>] -Protocol <String> - [-EnableTcpReset] [-IdleTimeoutInMinutes <Int32>] - -FrontendIpConfiguration <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSResourceId]> - -BackendAddressPoolId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmLoadBalancerOutboundRuleConfig** cmdlet creates an outbound rule configuration for an Azure load balancer. - -## EXAMPLES - -### Example 1: Create an outbound rule configuration for a load balancer -``` -PS C:\>$publicip = New-AzureRmPublicIpAddress -ResourceGroupName "MyResourceGroup" -Name "MyPublicIP" -Location "West US" -AllocationMethod "Dynamic" -PS C:\>$frontend = New-AzureRmLoadBalancerFrontendIpConfig -Name "FrontendIpConfig01" -PublicIpAddress $publicip -PS C:\>$backend = New-AzureRmLoadBalancerBackendAddressPoolConfig -Name "BackendAddressPool01" -PS C:\>New-AzureRmLoadBalancerOutboundRuleConfig -Name "MyOutboundRule" -Protocol "Tcp" -FrontendIPConfiguration $frontend -BackendAddressPool $backend -``` - -The first command creates a public IP address named MyPublicIP in the resource group named MyResourceGroup, and then stores it in the $publicip variable. -The second command creates a front-end IP configuration named FrontendIpConfig01 using the public IP address in $publicip, and then stores it in the $frontend variable. -The third command creates a back-end address pool configuration named BackendAddressPool01, and then stores it in the $backend variable. -The fourth command creates an outbound rule configuration named MyOutboundRule using the front-end and back-end objects in $frontend and $backend. -The *Protocol*, *FrontendIPConfiguration*, and *BackendAddressPool* parameters are all required to create an outbound rule configuration. - -## PARAMETERS - -### -AllocatedOutboundPort -The number of outbound ports to be used for NAT. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BackendAddressPool -A reference to a pool of DIPs. -Outbound traffic is randomly load balanced across IPs in the backend IPs. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BackendAddressPoolId -A reference to a pool of DIPs. -Outbound traffic is randomly load balanced across IPs in the backend IPs. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableTcpReset -Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. -This element is only used when the protocol is set to TCP. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIpConfiguration -The Frontend IP addresses of the load balancer. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSResourceId] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IdleTimeoutInMinutes -The timeout for the TCP idle connection - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Name of the outbound rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Protocol - TCP, UDP or All - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Int32 -System.String -System.Collections.Generic.List\`1[[Microsoft.Azure.Commands.Network.Models.PSResourceId, Microsoft.Azure.Commands.Network, Version=6.5.0.0, Culture=neutral, PublicKeyToken=null]] -Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSOutboundRule - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmLoadBalancerProbeConfig.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmLoadBalancerProbeConfig.md deleted file mode 100644 index e8ca2f5312..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmLoadBalancerProbeConfig.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 2049CB74-E3CB-4294-B97C-B41E91209A1E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermloadbalancerprobeconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmLoadBalancerProbeConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmLoadBalancerProbeConfig.md ---- - -# New-AzureRmLoadBalancerProbeConfig - -## SYNOPSIS -Creates a probe configuration for a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmLoadBalancerProbeConfig -Name <String> [-Protocol <String>] -Port <Int32> -IntervalInSeconds <Int32> - -ProbeCount <Int32> [-RequestPath <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmLoadBalancerProbeConfig** cmdlet creates a probe configuration for an Azure load balancer. - -## EXAMPLES - -### Example 1: Create a probe configuration -``` -PS C:\>New-AzureRmLoadBalancerProbeConfig -Name "MyProbe" -Protocol "http" -Port 80 -IntervalInSeconds 15 -ProbeCount 15 -``` - -This command creates a probe configuration named MyProbe using the HTTP protocol. -The new probe will connect to a load-balanced service on port 80. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IntervalInSeconds -Specifies the interval, in seconds, between probes to each instance of a load-balanced service. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the probe configuration to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Port -Specifies the port on which the new probe should connect to a load-balanced service. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProbeCount -Specifies the number of per-instance consecutive failures for an instance to be considered unhealthy. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol to use for the probe configuration. -The acceptable values for this parameter are: Tcp or Http. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RequestPath -Specifies the path in a load-balanced service to probe to determine health. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSProbe - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerProbeConfig](./Add-AzureRmLoadBalancerProbeConfig.md) - -[Get-AzureRmLoadBalancerProbeConfig](./Get-AzureRmLoadBalancerProbeConfig.md) - -[Remove-AzureRmLoadBalancerProbeConfig](./Remove-AzureRmLoadBalancerProbeConfig.md) - -[Set-AzureRmLoadBalancerProbeConfig](./Set-AzureRmLoadBalancerProbeConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmLoadBalancerRuleConfig.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmLoadBalancerRuleConfig.md deleted file mode 100644 index f633e4dfc7..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmLoadBalancerRuleConfig.md +++ /dev/null @@ -1,359 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: FD84D530-491B-4075-A6B4-2E1C46AD92D4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermloadbalancerruleconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmLoadBalancerRuleConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmLoadBalancerRuleConfig.md ---- - -# New-AzureRmLoadBalancerRuleConfig - -## SYNOPSIS -Creates a rule configuration for a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -New-AzureRmLoadBalancerRuleConfig -Name <String> [-Protocol <String>] [-LoadDistribution <String>] - [-FrontendPort <Int32>] [-BackendPort <Int32>] [-IdleTimeoutInMinutes <Int32>] [-EnableFloatingIP] - [-EnableTcpReset] [-DisableOutboundSNAT] [-FrontendIpConfiguration <PSFrontendIPConfiguration>] - [-BackendAddressPool <PSBackendAddressPool>] [-Probe <PSProbe>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByResourceId -``` -New-AzureRmLoadBalancerRuleConfig -Name <String> [-Protocol <String>] [-LoadDistribution <String>] - [-FrontendPort <Int32>] [-BackendPort <Int32>] [-IdleTimeoutInMinutes <Int32>] [-EnableFloatingIP] - [-EnableTcpReset] [-DisableOutboundSNAT] [-FrontendIpConfigurationId <String>] - [-BackendAddressPoolId <String>] [-ProbeId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmLoadBalancerRuleConfig** cmdlet creates a rule configuration for an Azure load balancer. - -## EXAMPLES - -### 1: Creating a rule configuration for an Azure Load Balancer -``` -PS C:\> $publicip = New-AzureRmPublicIpAddress -ResourceGroupName "MyResourceGroup" - -name MyPublicIP -location 'West US' -AllocationMethod Dynamic -PS C:\> $frontend = New-AzureRmLoadBalancerFrontendIpConfig -Name MyFrontEnd - -PublicIpAddress $publicip -PS C:\> $probe = New-AzureRmLoadBalancerProbeConfig -Name MyProbe -Protocol http -Port - 80 -IntervalInSeconds 15 -ProbeCount 2 -RequestPath healthcheck.aspx -PS C:\> New-AzureRmLoadBalancerRuleConfig -Name "MyLBrule" -FrontendIPConfiguration - $frontend -BackendAddressPool $backendAddressPool -Probe $probe -Protocol Tcp - -FrontendPort 80 -BackendPort 80 -IdleTimeoutInMinutes 15 -EnableFloatingIP - -LoadDistribution SourceIP -``` - -The first three commands set up a public IP, a front end, and a probe for the rule configuration in the forth command. The forth command creates a new rule called MyLBrule with certain specifications. - -## PARAMETERS - -### -BackendAddressPool -Specifies a **BackendAddressPool** object to associate with a load balancer rule configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BackendAddressPoolId -Specifies the ID of a **BackendAddressPool** object to associate with a load balancer rule configuration. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BackendPort -Specifies the backend port for traffic that is matched by this load balancer rule configuration. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableOutboundSNAT -Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableFloatingIP -Indicates that this cmdlet enables a floating IP address for a rule configuration. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableTcpReset -Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIpConfiguration -Specifies a list of front-end IP addresses to associate with a load balancer rule configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FrontendIpConfigurationId -Specifies the ID for a front-end IP address configuration. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FrontendPort -Specifies the front-end port that is matched by a load balancer rule configuration. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IdleTimeoutInMinutes -Specifies the length of time, in minutes, that the state of conversations is maintained in a load balancer. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadDistribution -Specifies a load distribution. -The acceptable values for this parameter are: -- Default -- SourceIP -- SourceIPProtocol - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the load balancing rule that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Probe -Specifies a probe to associate with a load balancer rule configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSProbe -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProbeId -Specifies the ID of the probe to associate with a load balancer rule configuration. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol that is matched by a load balancer rule configuration. -The acceptable values for this parameter are: Tcp or Udp. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancingRule - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerRuleConfig](./Add-AzureRmLoadBalancerRuleConfig.md) - -[Get-AzureRmLoadBalancerRuleConfig](./Get-AzureRmLoadBalancerRuleConfig.md) - -[Remove-AzureRmLoadBalancerRuleConfig](./Remove-AzureRmLoadBalancerRuleConfig.md) - -[Set-AzureRmLoadBalancerRuleConfig](./Set-AzureRmLoadBalancerRuleConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmLocalNetworkGateway.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmLocalNetworkGateway.md deleted file mode 100644 index 1d16eb8f6e..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmLocalNetworkGateway.md +++ /dev/null @@ -1,271 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 59BE802E-C061-4E25-A446-B00B0BA36019 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermlocalnetworkgateway -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmLocalNetworkGateway.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmLocalNetworkGateway.md ---- - -# New-AzureRmLocalNetworkGateway - -## SYNOPSIS -Creates a Local Network Gateway - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmLocalNetworkGateway -Name <String> -ResourceGroupName <String> -Location <String> - [-GatewayIpAddress <String>] [-AddressPrefix <System.Collections.Generic.List`1[System.String]>] - [-Asn <UInt32>] [-BgpPeeringAddress <String>] [-PeerWeight <Int32>] [-Tag <Hashtable>] [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Local Network Gateway is the object representing your VPN device On-Premises. -The **New-AzureRmLocalNetworkGateway** cmdlet creates the object representing your on-prem gateway -based on the Name, Resource Group Name, Location, and IP Address of the gateway, as well as the -Address Prefix of the On-Premises network which will be connecting to Azure. - -## EXAMPLES - -### 1: Create a Local Network Gateway -``` -New-AzureRmLocalNetworkGateway -Name myLocalGW -ResourceGroupName myRG -Location "West US" -GatewayIpAddress 23.99.221.164 -AddressPrefix "10.5.51.0/24" -``` - -Creates the object of the Local Network Gateway with the name "myLocalGW" within the resource group -"myRG" in location "West US" with the IP address "23.99.221.164" and the address prefix -"10.5.51.0/24" on-prem. - -## PARAMETERS - -### -AddressPrefix -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Asn -```yaml -Type: System.UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BgpPeeringAddress -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GatewayIpAddress -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PeerWeight -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group that the local network gateway belongs to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.UInt32 - -### System.Int32 - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLocalNetworkGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLocalNetworkGateway](./Get-AzureRmLocalNetworkGateway.md) - -[Remove-AzureRmLocalNetworkGateway](./Remove-AzureRmLocalNetworkGateway.md) - -[Set-AzureRmLocalNetworkGateway](./Set-AzureRmLocalNetworkGateway.md) diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkInterface.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkInterface.md deleted file mode 100644 index 819f8b25a1..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkInterface.md +++ /dev/null @@ -1,589 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: B2F2082F-4BAA-4FBE-8846-2D436A433570 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermnetworkinterface -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmNetworkInterface.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmNetworkInterface.md ---- - -# New-AzureRmNetworkInterface - -## SYNOPSIS -Creates a network interface. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByIpConfigurationResource (Default) -``` -New-AzureRmNetworkInterface -Name <String> -ResourceGroupName <String> -Location <String> - -IpConfiguration <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSNetworkInterfaceIPConfiguration]> - [-DnsServer <System.Collections.Generic.List`1[System.String]>] [-InternalDnsNameLabel <String>] - [-EnableIPForwarding] [-EnableAcceleratedNetworking] [-Tag <Hashtable>] [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByIpConfigurationResourceId -``` -New-AzureRmNetworkInterface -Name <String> -ResourceGroupName <String> -Location <String> - -IpConfiguration <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSNetworkInterfaceIPConfiguration]> - [-NetworkSecurityGroupId <String>] [-NetworkSecurityGroup <PSNetworkSecurityGroup>] - [-DnsServer <System.Collections.Generic.List`1[System.String]>] [-InternalDnsNameLabel <String>] - [-EnableIPForwarding] [-EnableAcceleratedNetworking] [-Tag <Hashtable>] [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByResourceId -``` -New-AzureRmNetworkInterface -Name <String> -ResourceGroupName <String> -Location <String> -SubnetId <String> - [-PublicIpAddressId <String>] [-NetworkSecurityGroupId <String>] - [-LoadBalancerBackendAddressPoolId <System.Collections.Generic.List`1[System.String]>] - [-LoadBalancerInboundNatRuleId <System.Collections.Generic.List`1[System.String]>] - [-ApplicationGatewayBackendAddressPoolId <System.Collections.Generic.List`1[System.String]>] - [-ApplicationSecurityGroupId <System.Collections.Generic.List`1[System.String]>] [-PrivateIpAddress <String>] - [-IpConfigurationName <String>] [-DnsServer <System.Collections.Generic.List`1[System.String]>] - [-InternalDnsNameLabel <String>] [-EnableIPForwarding] [-EnableAcceleratedNetworking] [-Tag <Hashtable>] - [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByResource -``` -New-AzureRmNetworkInterface -Name <String> -ResourceGroupName <String> -Location <String> -Subnet <PSSubnet> - [-PublicIpAddress <PSPublicIpAddress>] [-NetworkSecurityGroup <PSNetworkSecurityGroup>] - [-LoadBalancerBackendAddressPool <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool]>] - [-LoadBalancerInboundNatRule <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSInboundNatRule]>] - [-ApplicationGatewayBackendAddressPool <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool]>] - [-ApplicationSecurityGroup <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup]>] - [-PrivateIpAddress <String>] [-IpConfigurationName <String>] - [-DnsServer <System.Collections.Generic.List`1[System.String]>] [-InternalDnsNameLabel <String>] - [-EnableIPForwarding] [-EnableAcceleratedNetworking] [-Tag <Hashtable>] [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmNetworkInterface** cmdlet creates an Azure network interface. - -## EXAMPLES - -### Example 1: Create an Azure network interface -``` -PS C:\>New-AzureRmNetworkInterface -Name "NetworkInterface1" -ResourceGroupName "ResourceGroup1" -Location "centralus" -SubnetId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup1/providers/Microsoft.Network/virtualNetworks/VirtualNetwork1/subnets/Subnet1" -IpConfigurationName "IPConfiguration1" -DnsServer "8.8.8.8", "8.8.4.4" -``` - -This command creates a network interface named NetworkInterface001 with a dynamically assigned -private IP address from Subnet1 in the virtual network named VirtualNetwork1. The command also -assigns two DNS servers to the network interface. The IPConfiguration child resource will be -created automatically using the name IPConfiguration1. - -### Example 2: Create an Azure network interface using an IP configuration object -``` -PS C:\>$IPconfig = New-AzureRmNetworkInterfaceIpConfig -Name "IPConfig1" -PrivateIpAddressVersion IPv4 -PrivateIpAddress "10.0.1.10" -SubnetId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup1/providers/Microsoft.Network/virtualNetworks/VirtualNetwork1/subnets/Subnet1" -PS C:\> New-AzureRmNetworkInterface -Name "NetworkInterface1" -ResourceGroupName "ResourceGroup1" -Location "centralus" -IpConfiguration $IPconfig -``` - -This example creates a new network interface using an IP configuration object. The IP configuration -object specifies a static private IPv4 address. -The first command creates a network interface IP configuration named IPConfig1 and stores the -configuration in the variable named $IPconfig. -The second command creates a network interface named NetworkInterface1 that uses the network -interface IP configuration stored in the variable named $IPconfig. - -## PARAMETERS - -### -ApplicationGatewayBackendAddressPool -Specifies an **ApplicationGatewayBackendAddressPool** object. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationGatewayBackendAddressPoolId -Specifies the ID of a **ApplicationGatewayBackendAddressPool** object. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationSecurityGroup -Specifies a collection of application security group references to which the network interface IP configuration should belong to. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationSecurityGroupId -Specifies a collection of application security group references to which the network interface IP configuration should belong to. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DnsServer -Specifies the DNS server for the network interface. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableAcceleratedNetworking -Enables accelerated networking. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableIPForwarding -Indicates that this cmdlet enables IP forwarding for the network interface. -IP forwarding allows a virtual machine to receive traffic addressed to other destinations. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the creation of the network interface even if a network interface with the same name already exists. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InternalDnsNameLabel -Specifies the internal DNS name label for the new network interface. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IpConfiguration -Specifies the IP configuration that this cmdlet uses for the network interface. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSNetworkInterfaceIPConfiguration] -Parameter Sets: SetByIpConfigurationResource, SetByIpConfigurationResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IpConfigurationName -Specifies the name of an IP configuration. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId, SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancerBackendAddressPool -Specifies a **BackendAddressPool** object. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancerBackendAddressPoolId -Specifies the ID of a **BackendAddressPool** object. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancerInboundNatRule -Specifies an inbound NAT rule configuration for a load balancer. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSInboundNatRule] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancerInboundNatRuleId -Specifies the ID of an inbound NAT rule configuration for a load balancer. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the region for a network interface. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network interface to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkSecurityGroup -Specifies a **NetworkSecurityGroup** object. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup -Parameter Sets: SetByIpConfigurationResourceId, SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkSecurityGroupId -Specifies the ID of a network security group. - -```yaml -Type: System.String -Parameter Sets: SetByIpConfigurationResourceId, SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PrivateIpAddress -Specifies a static IPv4 IP address to assign to this network interface. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId, SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublicIpAddress -Specifies a **PublicIPAddress** object to assign to a network interface. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublicIpAddressId -Specifies the ID of a **PublicIPAddress** object to assign to a network interface. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group that the network interface belongs to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Subnet -Specifies a **Subnet** object. -This cmdlet creates a network interface for the subnet that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSSubnet -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubnetId -Specifies the ID of the subnet for which to create a network interface. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSNetworkInterfaceIPConfiguration, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### Microsoft.Azure.Commands.Network.Models.PSSubnet - -### Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress - -### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup - -### System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSInboundNatRule, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface - -## NOTES - -## RELATED LINKS - -[Get-AzureRmNetworkInterface](./Get-AzureRmNetworkInterface.md) - -[Remove-AzureRmNetworkInterface](./Remove-AzureRmNetworkInterface.md) - -[Set-AzureRmNetworkInterface](./Set-AzureRmNetworkInterface.md) diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkInterfaceIpConfig.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkInterfaceIpConfig.md deleted file mode 100644 index 4d323a5dad..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkInterfaceIpConfig.md +++ /dev/null @@ -1,376 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: D29C82CC-2080-48DA-880A-1AA83007E552 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermnetworkinterfaceipconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmNetworkInterfaceIpConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmNetworkInterfaceIpConfig.md ---- - -# New-AzureRmNetworkInterfaceIpConfig - -## SYNOPSIS -Creates a network interface IP configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -New-AzureRmNetworkInterfaceIpConfig -Name <String> [-PrivateIpAddressVersion <String>] - [-PrivateIpAddress <String>] [-Primary] [-Subnet <PSSubnet>] [-PublicIpAddress <PSPublicIpAddress>] - [-LoadBalancerBackendAddressPool <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool]>] - [-LoadBalancerInboundNatRule <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSInboundNatRule]>] - [-ApplicationGatewayBackendAddressPool <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool]>] - [-ApplicationSecurityGroup <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResourceId -``` -New-AzureRmNetworkInterfaceIpConfig -Name <String> [-PrivateIpAddressVersion <String>] - [-PrivateIpAddress <String>] [-Primary] [-SubnetId <String>] [-PublicIpAddressId <String>] - [-LoadBalancerBackendAddressPoolId <System.Collections.Generic.List`1[System.String]>] - [-LoadBalancerInboundNatRuleId <System.Collections.Generic.List`1[System.String]>] - [-ApplicationGatewayBackendAddressPoolId <System.Collections.Generic.List`1[System.String]>] - [-ApplicationSecurityGroupId <System.Collections.Generic.List`1[System.String]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmNetworkInterfaceIpConfig** cmdlet creates an Azure network interface IP configuration for a network interface. - -## EXAMPLES - -### 1: Create an IP configuration with a public IP address for a network interface -``` -$vnet = Get-AzureRmVirtualNetwork -Name myvnet -ResourceGroupName myrg -$Subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name mysubnet -VirtualNetwork $vnet -$PIP1 = Get-AzureRmPublicIPAddress -Name "PIP1" -ResourceGroupName "RG1" - -$IPConfig1 = New-AzureRmNetworkInterfaceIpConfig -Name "IPConfig-1" -Subnet $Subnet -PublicIpAddress $PIP1 - -Primary - - $nic = New-AzureRmNetworkInterface -Name $NicName -ResourceGroupName myrg -Location westus - -IpConfiguration $IpConfig1 -``` - -The first two commands get a virtual network called myvnet and a subnet called mysubnet respectively that were - previously created. These are stored in $vnet and $Subnet respectively. The third command gets a previously - created public IP address called PIP1. The forth command creates a new IP configuration called "IPConfig-1" as the - primary IP configuration with a public IP address associated with it. - The last command then creates a network interface called mynic1 using this IP configuration. - -### 2: Create an IP configuration with a private IP address -``` -$vnet = Get-AzureRmVirtualNetwork -Name myvnet -ResourceGroupName myrg -$Subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name mysubnet -VirtualNetwork $vnet - -$IPConfig2 = New-AzureRmNetworkInterfaceIpConfig -Name "IP-Config2" -Subnet $Subnet -PrivateIpAddress - 10.0.0.5 - -$nic = New-AzureRmNetworkInterface -Name mynic1 -ResourceGroupName myrg -Location westus -IpConfiguration - $IpConfig2 -``` - -The first two commands get a virtual network called myvnet and a subnet called mysubnet respectively that were - previously created. These are stored in $vnet and $Subnet respectively. The third command creates a new IP - configuration called "IPConfig-2" with a private IP address 10.0.0.5 associated with it. - The last command then creates a network interface called mynic1 using this IP configuration. - -## PARAMETERS - -### -ApplicationGatewayBackendAddressPool -Specifies a collection of application gateway backend address pool references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationGatewayBackendAddressPoolId -Specifies a collection of application gateway backend address pool references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationSecurityGroup -Specifies a collection of application security group references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationSecurityGroupId -Specifies a collection of application security group references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancerBackendAddressPool -Specifies a collection of load balancer backend address pool references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancerBackendAddressPoolId -Specifies a collection of load balancer backend address pool references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancerInboundNatRule -Specifies a collection of load balancer inbound Nat Rule references to which this network interface IPConfiguration belongs. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSInboundNatRule] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancerInboundNatRuleId -Specifies a collection of load balancer inbound network address translation (NAT) rule references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network interface IP configuration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Primary -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateIpAddress -Specifies the static IP address of the network interface IP configuration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateIpAddressVersion -Specifies the IP address version of a network interface IP configuration. -The acceptable values for this parameter are: -- IPv4 -- IPv6 - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: IPv4, IPv6 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIpAddress -Specifies a **PublicIPAddress** object. -This cmdlet creates a reference to a public IP Address to associate with this network interface IP configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIpAddressId -This cmdlet creates a reference to a public IP Address to associate with this network interface IP configuration. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subnet -Specifies a **Subnet** object. -This cmdlet creates a reference to a subnet in which this network interface IP configuration is created. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSSubnet -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetId -Specifies a reference to a subnet in which this network interface IP configuration is created. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSInboundNatRule, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkInterfaceIPConfiguration - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Add-AzureRmNetworkInterfaceIpConfig](./Add-AzureRmNetworkInterfaceIpConfig.md) - -[Get-AzureRmNetworkInterfaceIpConfig](./Get-AzureRmNetworkInterfaceIpConfig.md) - -[Remove-AzureRmNetworkInterfaceIpConfig](./Remove-AzureRmNetworkInterfaceIpConfig.md) - -[Set-AzureRmNetworkInterfaceIpConfig](./Set-AzureRmNetworkInterfaceIpConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkProfile.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkProfile.md deleted file mode 100644 index afa542ec79..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkProfile.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermnetworkprofile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmNetworkProfile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmNetworkProfile.md ---- - -# New-AzureRmNetworkProfile - -## SYNOPSIS -Creates a new network profile. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmNetworkProfile -ResourceGroupName <String> -Name <String> [-Location <String>] [-Tag <Hashtable>] - [-ContainerNicConfig <PSContainerNetworkInterfaceConfiguration[]>] [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmNetworkProfile** cmdlet creates a new network profile top level resource. - -## EXAMPLES - -### Example 1 -```powershell -$networkProfile = New-AzureRmNetworkProfile -Name np1 -ResourceGroupName rg1 -Location westus -``` - -This creates a new network profile top level resource - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContainerNicConfig -The container network interface configurations to add to this network profile. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSContainerNetworkInterfaceConfiguration[] -Parameter Sets: (All) -Aliases: ContainerNetworkInterfaceConfiguration - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation if you want to overwrite a resource - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The location. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The name of the network profile. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name of the network profile. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -A hashtable which represents resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSContainerNetworkInterface, Microsoft.Azure.Commands.Network, Version=6.7.0.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSContainerNetworkInterfaceConfiguration, Microsoft.Azure.Commands.Network, Version=6.7.0.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkProfile - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkSecurityGroup.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkSecurityGroup.md deleted file mode 100644 index da281b2964..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkSecurityGroup.md +++ /dev/null @@ -1,235 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: A420B3E7-2FE9-4D0B-803E-AC28E5F23C59 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermnetworksecuritygroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmNetworkSecurityGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmNetworkSecurityGroup.md ---- - -# New-AzureRmNetworkSecurityGroup - -## SYNOPSIS -Creates a network security group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmNetworkSecurityGroup -Name <String> -ResourceGroupName <String> -Location <String> - [-SecurityRules <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSSecurityRule]>] - [-Tag <Hashtable>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmNetworkSecurityGroup** cmdlet creates an Azure network security group. - -## EXAMPLES - -### 1: Create a new network security group -``` -New-AzureRmNetworkSecurityGroup -Name "nsg1" -ResourceGroupName "rg1" -Location "westus" -``` - -This command creates a new Azure network security group named "nsg1" in resource group "rg1" in location "westus". - -### 2: Create a detailed network security group -``` -$rule1 = New-AzureRmNetworkSecurityRuleConfig -Name rdp-rule -Description "Allow RDP" - -Access Allow -Protocol Tcp -Direction Inbound -Priority 100 -SourceAddressPrefix - Internet -SourcePortRange * -DestinationAddressPrefix * -DestinationPortRange 3389 - -$rule2 = New-AzureRmNetworkSecurityRuleConfig -Name web-rule -Description "Allow HTTP" - -Access Allow -Protocol Tcp -Direction Inbound -Priority 101 -SourceAddressPrefix - Internet -SourcePortRange * -DestinationAddressPrefix * -DestinationPortRange 80 - -$nsg = New-AzureRmNetworkSecurityGroup -ResourceGroupName TestRG -Location westus -Name - "NSG-FrontEnd" -SecurityRules $rule1,$rule2 -``` - -Step:1 Create a security rule allowing access from the Internet to port 3389. -Step:2 Create a security rule allowing access from the Internet to port 80. -Step:3 Add the rules created above to a new NSG named NSG-FrontEnd. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the region for which to create a network security group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network security group to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. -This cmdlet creates a network security group in the resource group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecurityRules -Specifies a list of network security rule objects to create in a network security group. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSSecurityRule] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSSecurityRule, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup - -## NOTES - -## RELATED LINKS - -[Get-AzureRmNetworkSecurityGroup](./Get-AzureRmNetworkSecurityGroup.md) - -[Remove-AzureRmNetworkSecurityGroup](./Remove-AzureRmNetworkSecurityGroup.md) - -[Set-AzureRmNetworkSecurityGroup](./Set-AzureRmNetworkSecurityGroup.md) diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkSecurityRuleConfig.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkSecurityRuleConfig.md deleted file mode 100644 index b9c2246c52..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkSecurityRuleConfig.md +++ /dev/null @@ -1,348 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 633FB5C9-BEB3-42A3-AF4F-A54CC3F9E0F7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermnetworksecurityruleconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmNetworkSecurityRuleConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmNetworkSecurityRuleConfig.md ---- - -# New-AzureRmNetworkSecurityRuleConfig - -## SYNOPSIS -Creates a network security rule configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -New-AzureRmNetworkSecurityRuleConfig -Name <String> [-Description <String>] [-Protocol <String>] - [-SourcePortRange <System.Collections.Generic.List`1[System.String]>] - [-DestinationPortRange <System.Collections.Generic.List`1[System.String]>] - [-SourceAddressPrefix <System.Collections.Generic.List`1[System.String]>] - [-DestinationAddressPrefix <System.Collections.Generic.List`1[System.String]>] - [-SourceApplicationSecurityGroup <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup]>] - [-DestinationApplicationSecurityGroup <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup]>] - [-Access <String>] [-Priority <Int32>] [-Direction <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### SetByResourceId -``` -New-AzureRmNetworkSecurityRuleConfig -Name <String> [-Description <String>] [-Protocol <String>] - [-SourcePortRange <System.Collections.Generic.List`1[System.String]>] - [-DestinationPortRange <System.Collections.Generic.List`1[System.String]>] - [-SourceAddressPrefix <System.Collections.Generic.List`1[System.String]>] - [-DestinationAddressPrefix <System.Collections.Generic.List`1[System.String]>] - [-SourceApplicationSecurityGroupId <System.Collections.Generic.List`1[System.String]>] - [-DestinationApplicationSecurityGroupId <System.Collections.Generic.List`1[System.String]>] [-Access <String>] - [-Priority <Int32>] [-Direction <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmNetworkSecurityRuleConfig** cmdlet creates an Azure network security rule configuration for a network security group. - -## EXAMPLES - -### 1: Create a network security rule to allow RDP -``` -$rule1 = New-AzureRmNetworkSecurityRuleConfig -Name rdp-rule -Description "Allow RDP" - -Access Allow -Protocol Tcp -Direction Inbound -Priority 100 -SourceAddressPrefix - Internet -SourcePortRange * -DestinationAddressPrefix * -DestinationPortRange 3389 -``` - -This command creates a security rule allowing access from the Internet to port 3389 - -### 2: Create a network security rule that allows HTTP -``` -$rule2 = New-AzureRmNetworkSecurityRuleConfig -Name web-rule -Description "Allow HTTP" - -Access Allow -Protocol Tcp -Direction Inbound -Priority 101 -SourceAddressPrefix - Internet -SourcePortRange * -DestinationAddressPrefix * -DestinationPortRange 80 -``` - -This command creates a security rule allowing access from the Internet to port 80 - -## PARAMETERS - -### -Access -Specifies whether network traffic is allowed or denied. -The acceptable values for this parameter are: Allow and Deny. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Allow, Deny - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the network security rule configuration to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationAddressPrefix -Specifies a destination address prefix. -The acceptable values for this parameter are: -- A Classless Interdomain Routing (CIDR) address -- A destination IP address range -- A wildcard character (*) to match any IP address -You can use tags such as VirtualNetwork, AzureLoadBalancer, and Internet. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationApplicationSecurityGroup -The application security group set as destination for the rule. It cannot be used with 'DestinationAddressPrefix' parameter. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationApplicationSecurityGroupId -The application security group set as destination for the rule. It cannot be used with 'DestinationAddressPrefix' parameter. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationPortRange -Specifies a destination port or range. -The acceptable values for this parameter are: -- An integer -- A range of integers between 0 and 65535 -- A wildcard character (*) to match any port - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Direction -Specifies whether a rule is evaluated on incoming or outgoing traffic. -The acceptable values for this parameter are: Inbound and Outbound. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Inbound, Outbound - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network security rule configuration that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -Specifies the priority of a rule configuration. -The acceptable values for this parameter are: An integer between 100 and 4096. -The priority number must be unique for each rule in the collection. -The lower the priority number, the higher the priority of the rule. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the network protocol that a new rule configuration applies to. -The acceptable values for this parameter are: -- Tcp -- Udp -- wildcard character (*) to match both. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Tcp, Udp, * - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceAddressPrefix -Specifies a source address prefix. -The acceptable values for this parameter are: -- A CIDR -- A source IP range -- A wildcard character (*) to match any IP address. -You can also use tags such as VirtualNetwork, AzureLoadBalancer and Internet. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceApplicationSecurityGroup -The application security group set as source for the rule. It cannot be used with 'SourceAddressPrefix' parameter. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceApplicationSecurityGroupId -The application security group set as source for the rule. It cannot be used with 'SourceAddressPrefix' parameter. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourcePortRange -Specifies the source port or range. -The acceptable values for this parameter are: -- An integer -- A range of integers between 0 and 65535 -- A wildcard character (*) to match any port - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSSecurityRule - -## NOTES - -## RELATED LINKS - -[Add-AzureRmNetworkSecurityRuleConfig](./Add-AzureRmNetworkSecurityRuleConfig.md) - -[Get-AzureRmNetworkSecurityRuleConfig](./Get-AzureRmNetworkSecurityRuleConfig.md) - -[Remove-AzureRmNetworkSecurityRuleConfig](./Remove-AzureRmNetworkSecurityRuleConfig.md) - -[Set-AzureRmNetworkSecurityRuleConfig](./Set-AzureRmNetworkSecurityRuleConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkWatcher.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkWatcher.md deleted file mode 100644 index 76416461c4..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkWatcher.md +++ /dev/null @@ -1,224 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermnetworkwatcher -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmNetworkWatcher.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmNetworkWatcher.md ---- - -# New-AzureRmNetworkWatcher - -## SYNOPSIS -Creates a new Network Watcher resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmNetworkWatcher -Name <String> -ResourceGroupName <String> -Location <String> [-Tag <Hashtable>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmNetworkWatcher cmdlet creates a new Network Watcher resource. - -## EXAMPLES - -### Example 1: Create a Network Watcher -``` -New-AzureRmResourceGroup -Name NetworkWatcherRG -Location westcentralus -New-AzureRmNetworkWatcher -Name NetworkWatcher_westcentralus -ResourceGroup NetworkWatcherRG - -Name : NetworkWatcher_westcentralus -Id : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NetworkWatcherRG/providers/Microsoft.Network/networkWatchers/NetworkWatcher_westcentralus -Etag : W/"7cf1f2fe-8445-4aa7-9bf5-c15347282c39" -Location : westcentralus -Tags : -ProvisioningState : Succeeded -``` - -This example creates a new Network Watcher inside a newly created Resource Group. Note that only -one Network Watcher can be created per region per subscription. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Location. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The network watcher name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher - -## RELATED LINKS - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmNetworkWatcherProtocolConfiguration](./New-AzureRmNetworkWatcherProtocolConfiguration.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Test-AzureRmNetworkWatcherConnectivity](./Test-AzureRmNetworkWatcherConnectivity.md) - -[Stop-AzureRmNetworkWatcherConnectionMonitor](./Stop-AzureRmNetworkWatcherConnectionMonitor.md) - -[Start-AzureRmNetworkWatcherConnectionMonitor](./Start-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConnectionMonitor](./Set-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConfigFlowLog](./Set-AzureRmNetworkWatcherConfigFlowLog.md) - -[Remove-AzureRmNetworkWatcherConnectionMonitor](./Remove-AzureRmNetworkWatcherConnectionMonitor.md) - -[New-AzureRmNetworkWatcherConnectionMonitor](./New-AzureRmNetworkWatcherConnectionMonitor.md) - -[Get-AzureRmNetworkWatcherTroubleshootingResult](./Get-AzureRmNetworkWatcherTroubleshootingResult.md) - -[Get-AzureRMNetworkWatcherReachabilityReport](./Get-AzureRMNetworkWatcherReachabilityReport.md) - -[Get-AzureRmNetworkWatcherReachabilityProvidersList](./Get-AzureRmNetworkWatcherReachabilityProvidersList.md) - -[Get-AzureRmNetworkWatcherFlowLogStatus](./Get-AzureRmNetworkWatcherFlowLogStatus.md) - -[Get-AzureRmNetworkWatcherConnectionMonitorReport](./Get-AzureRmNetworkWatcherConnectionMonitorReport.md) - -[Get-AzureRmNetworkWatcherConnectionMonitor](./Get-AzureRmNetworkWatcherConnectionMonitor.md) diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkWatcherConnectionMonitor.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkWatcherConnectionMonitor.md deleted file mode 100644 index 9e22660a9e..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkWatcherConnectionMonitor.md +++ /dev/null @@ -1,423 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermnetworkwatcher -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmNetworkWatcherConnectionMonitor.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmNetworkWatcherConnectionMonitor.md ---- - -# New-AzureRmNetworkWatcherConnectionMonitor - -## SYNOPSIS -Creates a connection monitor. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByName (Default) -``` -New-AzureRmNetworkWatcherConnectionMonitor -NetworkWatcherName <String> -ResourceGroupName <String> - -Name <String> -SourceResourceId <String> [-MonitoringIntervalInSeconds <Int32>] [-SourcePort <Int32>] - [-DestinationResourceId <String>] [-DestinationAddress <String>] [-DestinationPort <Int32>] [-ConfigureOnly] - [-Tag <Hashtable>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### SetByResource -``` -New-AzureRmNetworkWatcherConnectionMonitor -NetworkWatcher <PSNetworkWatcher> -Name <String> - -SourceResourceId <String> [-MonitoringIntervalInSeconds <Int32>] [-SourcePort <Int32>] - [-DestinationResourceId <String>] [-DestinationAddress <String>] [-DestinationPort <Int32>] [-ConfigureOnly] - [-Tag <Hashtable>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### SetByLocation -``` -New-AzureRmNetworkWatcherConnectionMonitor -Location <String> -Name <String> -SourceResourceId <String> - [-MonitoringIntervalInSeconds <Int32>] [-SourcePort <Int32>] [-DestinationResourceId <String>] - [-DestinationAddress <String>] [-DestinationPort <Int32>] [-ConfigureOnly] [-Tag <Hashtable>] [-Force] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmNetworkWatcherConnectionMonitor cmdlet rcreates a connection monitor for a specified source and destination. - -## EXAMPLES - -### Example 1: Create a connection monitor for a vm and internet destination -``` -PS C:\> New-AzureRmNetworkWatcherConnectionMonitor -NetworkWatcher $nw -Name cm -SourceResourceId /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RgCentralUSEUAP/providers/Microsoft.Compute/virtualMachines/vm -DestinationAddress bing.com -DestinationPort 80 - -Name : cm -Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGro - ups/NetworkWatcherRG/providers/Microsoft.Network/networkWatcher - s/NetworkWatcher_centraluseuap/connectionMonitors/t1 -Etag : W/"e86b28cf-b907-4475-a8b7-34d310367694" -ProvisioningState : Succeeded -Source : { - "ResourceId": "/subscriptions/00000000-0000-0000-0000-0000000 - 00000/resourceGroups/RgCentralUSEUAP/providers/Microsoft - .Compute/virtualMachines/vm", - "Port": 0 - } -Destination : { - "Address": "bing.com", - "Port": 80 - } -MonitoringIntervalInSeconds : 60 -AutoStart : True -StartTime : 1/12/2018 7:13:11 PM -MonitoringStatus : Running -Location : centraluseuap -Type : Microsoft.Network/networkWatchers/connectionMonitors -Tags : {} -``` - -The New-AzureRmNetworkWatcherConnectionMonitor cmdlet creates a connection monitor for a specified source and destination. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConfigureOnly -Configure connection monitor, but do not start it - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationAddress -The Ip address of the connection monitor destination. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationPort -Destination port. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationResourceId -The ID of the connection monitor destination. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation if you want to overwrite a resource - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Location of the network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByLocation -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MonitoringIntervalInSeconds -Monitoring interval in seconds. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The connection monitor name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ConnectionMonitorName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourcePort -Source port. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceResourceId -The ID of the connection monitor source. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -A hashtable which represents resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameters: NetworkWatcher (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResult - -## NOTES -Keywords: azure, azurerm, arm, resource, connectivity, management, manager, network, networking, network watcher, connection monitor - -## RELATED LINKS - -[New-AzureRmNetworkWatcher]() - -[Get-AzureRmNetworkWatcher]() - -[Remove-AzureRmNetworkWatcher]() - -[Get-AzureRmNetworkWatcherNextHop]() - -[Get-AzureRmNetworkWatcherSecurityGroupView]() - -[Get-AzureRmNetworkWatcherTopology]() - -[Get-AzureRmNetworkWatcherTroubleshootingResult]() - -[New-AzureRmNetworkWatcherPacketCapture]() - -[New-AzureRmPacketCaptureFilterConfig]() - -[Get-AzureRmNetworkWatcherPacketCapture]() - -[Remove-AzureRmNetworkWatcherPacketCapture]() - -[Stop-AzureRmNetworkWatcherPacketCapture]() - -[Get-AzureRmNetworkWatcherConnectionMonitor]() - -[Get-AzureRmNetworkWatcherConnectionMonitorReport]() - -[Remove-AzureRmNetworkWatcherConnectionMonitor]() - -[Set-AzureRmNetworkWatcherConnectionMonitor]() - -[Stop-AzureRmNetworkWatcherConnectionMonitor]() - -[New-AzureRmNetworkWatcherConnectionMonitor]() - -[New-AzureRmNetworkWatcherProtocolConfiguration]() - -[Test-AzureRmNetworkWatcherIPFlow]() - -[Test-AzureRmNetworkWatcherConnectivity]() - -[Start-AzureRmNetworkWatcherResourceTroubleshooting]() - -[Start-AzureRmNetworkWatcherConnectionMonitor]() - -[Set-AzureRmNetworkWatcherConfigFlowLog]() - -[Get-AzureRMNetworkWatcherReachabilityReport]() - -[Get-AzureRmNetworkWatcherReachabilityProvidersList]() - -[Get-AzureRmNetworkWatcherFlowLogStatus]() diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkWatcherPacketCapture.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkWatcherPacketCapture.md deleted file mode 100644 index 0cb764b455..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkWatcherPacketCapture.md +++ /dev/null @@ -1,405 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermnetworkwatcherpacketcapture -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmNetworkWatcherPacketCapture.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmNetworkWatcherPacketCapture.md ---- - -# New-AzureRmNetworkWatcherPacketCapture - -## SYNOPSIS -Creates a new packet capture resource and starts a packet capture session on a VM. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -New-AzureRmNetworkWatcherPacketCapture -NetworkWatcher <PSNetworkWatcher> -PacketCaptureName <String> - -TargetVirtualMachineId <String> [-StorageAccountId <String>] [-StoragePath <String>] - [-LocalFilePath <String>] [-BytesToCapturePerPacket <Int32>] [-TotalBytesPerSession <Int32>] - [-TimeLimitInSeconds <Int32>] - [-Filter <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSPacketCaptureFilter]>] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByName -``` -New-AzureRmNetworkWatcherPacketCapture -NetworkWatcherName <String> -ResourceGroupName <String> - -PacketCaptureName <String> -TargetVirtualMachineId <String> [-StorageAccountId <String>] - [-StoragePath <String>] [-LocalFilePath <String>] [-BytesToCapturePerPacket <Int32>] - [-TotalBytesPerSession <Int32>] [-TimeLimitInSeconds <Int32>] - [-Filter <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSPacketCaptureFilter]>] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByLocation -``` -New-AzureRmNetworkWatcherPacketCapture -Location <String> -PacketCaptureName <String> - -TargetVirtualMachineId <String> [-StorageAccountId <String>] [-StoragePath <String>] - [-LocalFilePath <String>] [-BytesToCapturePerPacket <Int32>] [-TotalBytesPerSession <Int32>] - [-TimeLimitInSeconds <Int32>] - [-Filter <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSPacketCaptureFilter]>] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmNetworkWatcherPacketCapture cmdlet creates a new packet capture resource and starts a packet capture session on a VM. -The length of the Packet Capture sessions can be configured via a time constraint or a size constraint. The amount of data captured for each packet can also be configured. -Filters can be applied to a given packet capture session, allowing you to customize the type of packets captured. Filters can restrict packets on local and remote IP addresses & address ranges, local and remote ports & port ranges, and the session level protocol to be captured. Filters are composable, and multiple filters can be applied to provide you with granularity of capture. - -## EXAMPLES - -### Example 1: Create a Packet Capture with multiple filters -``` -$nw = Get-AzurermResource | Where {$_.ResourceType -eq "Microsoft.Network/networkWatchers" -and $_.Location -eq "WestCentralUS" } -$networkWatcher = Get-AzureRmNetworkWatcher -Name $nw.Name -ResourceGroupName $nw.ResourceGroupName - -$storageAccount = Get-AzureRmStorageAccount -ResourceGroupName contosoResourceGroup -Name contosostorage123 - -$filter1 = New-AzureRmPacketCaptureFilterConfig -Protocol TCP -RemoteIPAddress "1.1.1.1-255.255.255" -LocalIPAddress "10.0.0.3" -LocalPort "1-65535" -RemotePort "20;80;443" -$filter2 = New-AzureRmPacketCaptureFilterConfig -Protocol UDP -New-AzureRmNetworkWatcherPacketCapture -NetworkWatcher $networkWatcher -TargetVirtualMachineId $vm.Id -PacketCaptureName "PacketCaptureTest" -StorageAccountId $storageAccount.id -TimeLimitInSeconds 60 -Filter $filter1, $filter2 -``` - -In this example we create a packet capture named "PacketCaptureTest" with multiple filters and a time limit. Once the session is complete, it will be saved to the specified storage account. -Note: The Azure Network Watcher extension must be installed on the target virtual machine to create packet captures. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BytesToCapturePerPacket -Bytes to capture per packet. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Filters for packet capture session. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSPacketCaptureFilter] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalFilePath -Local file path. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Location of the network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByLocation -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PacketCaptureName -The packet capture name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountId -Storage account Id. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StoragePath -Storage path. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetVirtualMachineId -The target virtual machine ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TimeLimitInSeconds -Time limit in seconds. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TotalBytesPerSession -Total bytes per session. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameters: NetworkWatcher (ByValue) - -### System.String -Parameters: NetworkWatcherName (ByValue) - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSPacketCaptureResult - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, packet, capture, traffic - -## RELATED LINKS - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmNetworkWatcherProtocolConfiguration](./New-AzureRmNetworkWatcherProtocolConfiguration.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Test-AzureRmNetworkWatcherConnectivity](./Test-AzureRmNetworkWatcherConnectivity.md) - -[Stop-AzureRmNetworkWatcherConnectionMonitor](./Stop-AzureRmNetworkWatcherConnectionMonitor.md) - -[Start-AzureRmNetworkWatcherConnectionMonitor](./Start-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConnectionMonitor](./Set-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConfigFlowLog](./Set-AzureRmNetworkWatcherConfigFlowLog.md) - -[Remove-AzureRmNetworkWatcherConnectionMonitor](./Remove-AzureRmNetworkWatcherConnectionMonitor.md) - -[New-AzureRmNetworkWatcherConnectionMonitor](./New-AzureRmNetworkWatcherConnectionMonitor.md) - -[Get-AzureRmNetworkWatcherTroubleshootingResult](./Get-AzureRmNetworkWatcherTroubleshootingResult.md) - -[Get-AzureRMNetworkWatcherReachabilityReport](./Get-AzureRMNetworkWatcherReachabilityReport.md) - -[Get-AzureRmNetworkWatcherReachabilityProvidersList](./Get-AzureRmNetworkWatcherReachabilityProvidersList.md) - -[Get-AzureRmNetworkWatcherFlowLogStatus](./Get-AzureRmNetworkWatcherFlowLogStatus.md) - -[Get-AzureRmNetworkWatcherConnectionMonitorReport](./Get-AzureRmNetworkWatcherConnectionMonitorReport.md) - -[Get-AzureRmNetworkWatcherConnectionMonitor](./Get-AzureRmNetworkWatcherConnectionMonitor.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkWatcherProtocolConfiguration.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkWatcherProtocolConfiguration.md deleted file mode 100644 index 75d0ff9516..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmNetworkWatcherProtocolConfiguration.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermnetworkwatcherprotocolconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmNetworkWatcherProtocolConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmNetworkWatcherProtocolConfiguration.md ---- - -# New-AzureRmNetworkWatcherProtocolConfiguration - -## SYNOPSIS -Creates a new protocol configuration object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmNetworkWatcherProtocolConfiguration -Protocol <String> [-Method <String>] [-Header <IDictionary>] - [-ValidStatusCode <Int32[]>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmNetworkWatcherProtocolConfiguration cmdlet creates a new protocol configuration object. -This object is used to restrict the protocol confiuration during a connecitivity check session using the specified criteria. - -## EXAMPLES - -### Example 1: Test Network Watcher Connectivity from a VM to a website with protocol configuration -``` -$config = New-AzureRmNetworkWatcherProtocolConfiguration -Protocol Http -Method Get -Headers @{"accept"="application/json"} -ValidStatusCodes @(200,202,204) - -Test-AzureRmNetworkWatcherConnectivity -NetworkWatcherName NetworkWatcher -ResourceGroupName NetworkWatcherRG -SourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ContosoRG/providers/Microsoft.Compute/virtualMachines/MultiTierApp0" -DestinationAddress "bing.com" -DestinationPort 80 -ProtocolConfiguration $config - - -ConnectionStatus : Reachable -AvgLatencyInMs : 4 -MinLatencyInMs : 2 -MaxLatencyInMs : 15 -ProbesSent : 15 -ProbesFailed : 0 -Hops : [ - { - "Type": "Source", - "Id": "f8cff464-e13f-457f-a09e-4dcd53d38a85", - "Address": "10.1.1.4", - "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ContosoRG/provi iders/Microsoft.Network/networkInterfaces/appNic0/ipConfigurations/ipconfig1", - "NextHopIds": [ - "1034b1bf-0b1b-4f0a-93b2-900477f45485" - ], - "Issues": [] - }, - { - "Type": "Internet", - "Id": "1034b1bf-0b1b-4f0a-93b2-900477f45485", - "Address": "13.107.21.200", - "ResourceId": "Internet", - "NextHopIds": [], - "Issues": [] - } - ] -``` - -In this example we test connectivity from a VM in Azure to www.bing.com. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Header -list of HTTP headers - -```yaml -Type: System.Collections.IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Method -HTTP method - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Procotol type - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ValidStatusCode -valid status codes - -```yaml -Type: System.Int32[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcherProtocolConfiguration - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, watcher, packet, capture, traffic, filter - -## RELATED LINKS - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmNetworkWatcherProtocolConfiguration](./New-AzureRmNetworkWatcherProtocolConfiguration.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Test-AzureRmNetworkWatcherConnectivity](./Test-AzureRmNetworkWatcherConnectivity.md) - -[Stop-AzureRmNetworkWatcherConnectionMonitor](./Stop-AzureRmNetworkWatcherConnectionMonitor.md) - -[Start-AzureRmNetworkWatcherConnectionMonitor](./Start-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConnectionMonitor](./Set-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConfigFlowLog](./Set-AzureRmNetworkWatcherConfigFlowLog.md) - -[Remove-AzureRmNetworkWatcherConnectionMonitor](./Remove-AzureRmNetworkWatcherConnectionMonitor.md) - -[New-AzureRmNetworkWatcherConnectionMonitor](./New-AzureRmNetworkWatcherConnectionMonitor.md) - -[Get-AzureRmNetworkWatcherTroubleshootingResult](./Get-AzureRmNetworkWatcherTroubleshootingResult.md) - -[Get-AzureRMNetworkWatcherReachabilityReport](./Get-AzureRMNetworkWatcherReachabilityReport.md) - -[Get-AzureRmNetworkWatcherReachabilityProvidersList](./Get-AzureRmNetworkWatcherReachabilityProvidersList.md) - -[Get-AzureRmNetworkWatcherFlowLogStatus](./Get-AzureRmNetworkWatcherFlowLogStatus.md) - -[Get-AzureRmNetworkWatcherConnectionMonitorReport](./Get-AzureRmNetworkWatcherConnectionMonitorReport.md) - -[Get-AzureRmNetworkWatcherConnectionMonitor](./Get-AzureRmNetworkWatcherConnectionMonitor.md) diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmPacketCaptureFilterConfig.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmPacketCaptureFilterConfig.md deleted file mode 100644 index 66e4b3fb5f..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmPacketCaptureFilterConfig.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermpacketcapturefilterconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmPacketCaptureFilterConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmPacketCaptureFilterConfig.md ---- - -# New-AzureRmPacketCaptureFilterConfig - -## SYNOPSIS -Creates a new packet capture filter object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmPacketCaptureFilterConfig [-Protocol <String>] [-RemoteIPAddress <String>] - [-LocalIPAddress <String>] [-LocalPort <String>] [-RemotePort <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmPacketCaptureFilterConfig cmdlet creates a new packet capture filter object. -This object is used to restrict the type of packets that are captured during a packet capture session using the specified criteria. -The New-AzureRmNetworkWatcherPacketCapture cmdlet can accept multiple filter objects to enable composable capture sessions. - -## EXAMPLES - -### Example 1: Create a Packet Capture with multiple filters -``` -$nw = Get-AzurermResource | Where {$_.ResourceType -eq "Microsoft.Network/networkWatchers" -and $_.Location -eq "WestCentralUS" } -$networkWatcher = Get-AzureRmNetworkWatcher -Name $nw.Name -ResourceGroupName $nw.ResourceGroupName - -$storageAccount = Get-AzureRmStorageAccount -ResourceGroupName contosoResourceGroup -Name contosostorage123 - -$filter1 = New-AzureRmPacketCaptureFilterConfig -Protocol TCP -RemoteIPAddress "1.1.1.1-255.255.255" -LocalIPAddress "10.0.0.3" -LocalPort "1-65535" -RemotePort "20;80;443" -$filter2 = New-AzureRmPacketCaptureFilterConfig -Protocol UDP -New-AzureRmNetworkWatcherPacketCapture -NetworkWatcher $networkWatcher -TargetVirtualMachineId $vm.Id -PacketCaptureName "PacketCaptureTest" -StorageAccountId $storageAccount.id -TimeLimitInSeconds 60 -Filters $filter1, $filter2 -``` - -In this example we create a packet capture named "PacketCaptureTest" with multiple filters and a time limit. Once the session is complete, it will be saved to the specified storage account. -Note: The Azure Network Watcher extension must be installed on the target virtual machine to create packet captures. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalIPAddress -Specifies the Local IP Address to filter on. -Example inputs: -"127.0.0.1" for single address entry. -"127.0.0.1-127.0.0.255" for range. -"127.0.0.1;127.0.0.5;" for multiple entries. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LocalPort -Specifies the Local IP Address to filter on. -Example inputs: -"127.0.0.1" for single address entry. -"127.0.0.1-127.0.0.255" for range. -"127.0.0.1;127.0.0.5;" for multiple entries. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Protocol -Specifies the Procotol to filter on. Acceptable values "TCP","UDP","Any" - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RemoteIPAddress -Specifies the remote IP address to filter on. -Example inputs: -"127.0.0.1" for single address entry. -"127.0.0.1-127.0.0.255" for range. -"127.0.0.1;127.0.0.5;" for multiple entries. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RemotePort -Specifies the Remote Port to filter on. -Remote port -Example inputs: -"80" for single port entry. -"80-85" for range. -"80;443;" for multiple entries. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: Protocol (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSPacketCaptureFilter - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, watcher, packet, capture, traffic, filter - -## RELATED LINKS - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmNetworkWatcherProtocolConfiguration](./New-AzureRmNetworkWatcherProtocolConfiguration.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Test-AzureRmNetworkWatcherConnectivity](./Test-AzureRmNetworkWatcherConnectivity.md) - -[Stop-AzureRmNetworkWatcherConnectionMonitor](./Stop-AzureRmNetworkWatcherConnectionMonitor.md) - -[Start-AzureRmNetworkWatcherConnectionMonitor](./Start-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConnectionMonitor](./Set-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConfigFlowLog](./Set-AzureRmNetworkWatcherConfigFlowLog.md) - -[Remove-AzureRmNetworkWatcherConnectionMonitor](./Remove-AzureRmNetworkWatcherConnectionMonitor.md) - -[New-AzureRmNetworkWatcherConnectionMonitor](./New-AzureRmNetworkWatcherConnectionMonitor.md) - -[Get-AzureRmNetworkWatcherTroubleshootingResult](./Get-AzureRmNetworkWatcherTroubleshootingResult.md) - -[Get-AzureRMNetworkWatcherReachabilityReport](./Get-AzureRMNetworkWatcherReachabilityReport.md) - -[Get-AzureRmNetworkWatcherReachabilityProvidersList](./Get-AzureRmNetworkWatcherReachabilityProvidersList.md) - -[Get-AzureRmNetworkWatcherFlowLogStatus](./Get-AzureRmNetworkWatcherFlowLogStatus.md) - -[Get-AzureRmNetworkWatcherConnectionMonitorReport](./Get-AzureRmNetworkWatcherConnectionMonitorReport.md) - -[Get-AzureRmNetworkWatcherConnectionMonitor](./Get-AzureRmNetworkWatcherConnectionMonitor.md) diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmPublicIpAddress.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmPublicIpAddress.md deleted file mode 100644 index 2b8ceae0c1..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmPublicIpAddress.md +++ /dev/null @@ -1,387 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 8D84F81A-F6B5-413D-B349-50947FCD5CFC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermpublicipaddress -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmPublicIpAddress.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmPublicIpAddress.md ---- - -# New-AzureRmPublicIpAddress - -## SYNOPSIS -Creates a public IP address. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmPublicIpAddress [-Name <String>] -ResourceGroupName <String> [-Location <String>] [-Sku <String>] - -AllocationMethod <String> [-IpAddressVersion <String>] [-DomainNameLabel <String>] - [-IpTag <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSPublicIpTag]>] - [-PublicIpPrefix <Microsoft.Azure.Commands.Network.Models.PSPublicIpPrefix>] - [-ReverseFqdn <String>] [-IdleTimeoutInMinutes <Int32>] - [-Zone <System.Collections.Generic.List`1[System.String]>] [-Tag <Hashtable>] [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmPublicIpAddress** cmdlet creates a public IP address. - -## EXAMPLES - -### 1: Create a new public IP address -``` -$publicIp = New-AzureRmPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName -AllocationMethod Static -DomainNameLabel $dnsPrefix -Location $location -``` - -This command creates a new public IP address resource.A DNS record is created for -$dnsPrefix.$location.cloudapp.azure.com pointing to the public IP address of this resource. A -public IP address is immediately allocated to this resource as the -AllocationMethod is specified -as 'Static'. If it is specified as 'Dynamic', a public IP address gets allocated only when you -start (or create) the associated resource (like a VM or load balancer). - -### 2: Create a public IP address with a reverse FQDN -``` -$publicIp = New-AzureRmPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName -AllocationMethod Static -DomainNameLabel $dnsPrefix -Location $location -ReverseFqdn $customFqdn -``` - -This command creates a new public IP address resource. With the -ReverseFqdn parameter, Azure -creates a DNS PTR record (reverse-lookup) for the public IP address allocated to this resource, -pointing to the $customFqdn specified in the command. As a pre-requisite, the $customFqdn (say -webapp.contoso.com) should have a DNS CNAME record (forward-lookup) pointing to -$dnsPrefix.$location.cloudapp.azure.com. - -### 3: Create a new public IP address with IpTag -``` -$ipTag = New-AzureRmPublicIpTag -IpTagType "FirstPartyUsage" -Tag "/Sql" -$publicIp = New-AzureRmPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName -AllocationMethod Static -DomainNameLabel $dnsPrefix -Location $location -IpTags ipTag -``` - -This command creates a new public IP address resource.A DNS record is created for -$dnsPrefix.$location.cloudapp.azure.com pointing to the public IP address of this resource. A -public IP address is immediately allocated to this resource as the -AllocationMethod is specified -as 'Static'. If it is specified as 'Dynamic', a public IP address gets allocated only when you -start (or create) the associated resource (like a VM or load balancer). An Iptag is used to -specific the Tags associated with resource. Iptag can be specified using New-AzureRmPublicIpTag -and passed as input through -IpTags. - -### 4: Create a new public IP address from a Prefix -``` -$publicIp = New-AzureRmPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName -AllocationMethod Static -DomainNameLabel $dnsPrefix -Location $location --PublicIpPrefix publicIpPrefix -Sku Standard -``` - -This command creates a new public IP address resource. A DNS record is created for -$dnsPrefix.$location.cloudapp.azure.com pointing to the public IP address of this resource. A -public IP address is immediately allocated to this resource from the publicIpPrefix specified. -This option is only supported for the 'Standard' Sku and 'Static' AllocationMethod. - -## PARAMETERS - -### -AllocationMethod -Specifies the method with which to allocate the public IP address. -The acceptable values for this parameter are: Static or Dynamic. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Dynamic, Static - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainNameLabel -Specifies the relative DNS name for a public IP address. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IdleTimeoutInMinutes -Specifies the idle time-out, in minutes. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IpAddressVersion -Specifies the version of the IP address. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: IPv4, IPv6 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IpTag -IpTag List. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSPublicIpTag] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the region in which to create a public IP address. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublicIpPrefix -Specifies the PSPublicIpPrefix from which to allocate the public IP address. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpPrefix -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the public IP address that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group in which to create a public IP address. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReverseFqdn -Specifies a reverse fully qualified domain name (FQDN). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -The public IP Sku name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Basic, Standard - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Zone -A list of availability zones denoting the IP allocated for the resource needs to come from. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSPublicIpTag, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Int32 - -### System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress - -## NOTES - -## RELATED LINKS - -[Get-AzureRmPublicIpAddress](./Get-AzureRmPublicIpAddress.md) - -[Remove-AzureRmPublicIpAddress](./Remove-AzureRmPublicIpAddress.md) - -[Set-AzureRmPublicIpAddress](./Set-AzureRmPublicIpAddress.md) diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmPublicIpPrefix.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmPublicIpPrefix.md deleted file mode 100644 index de0099c114..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmPublicIpPrefix.md +++ /dev/null @@ -1,274 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermpublicipprefix -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmPublicIpPrefix.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmPublicIpPrefix.md ---- - -# New-AzureRmPublicIpPrefix - -## SYNOPSIS -Creates a Public IP Prefix - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmPublicIpPrefix -Name <String> -ResourceGroupName <String> [-Location <String>] [-Sku <String>] - -PrefixLength <UInt16> [-IpAddressVersion <String>] - [-IpTag <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSPublicIpPrefixTag]>] - [-Zone <System.Collections.Generic.List`1[System.String]>] [-Tag <Hashtable>] [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmPublicIpPrefix** cmdlet creates a public IP prefix. - -## EXAMPLES - -### 1: Create a new public Ip prefix -```powershell -PS C:\> $publicIpPrefix = New-AzureRmPublicIpPrefix -Name $prefixName -ResourceGroupName $rgName -PrefixLength 30 -``` - -This command creates a new public IP prefix resource. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation if you want to overrite a resource - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IpAddressVersion -The public IP address version. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: IPv4, IPv6 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IpTag -IpTag List. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSPublicIpPrefixTag] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -The public IP prefix location. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PrefixLength -The PublicIPPrefix length - -```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -The public IP Prefix Sku name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Standard - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -A hashtable which represents resource tags. - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Zone -A list of availability zones denoting the IP allocated for the resource needs to come from. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -System.UInt16 -System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSPublicIpPrefixTag, Microsoft.Azure.Commands.Network, Version=6.4.0.0, Culture=neutral, PublicKeyToken=null]] -System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] -System.Collections.Hashtable - - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSPublicIpPrefix - - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmPublicIpTag.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmPublicIpTag.md deleted file mode 100644 index 4333b41417..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmPublicIpTag.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermpubliciptag -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmPublicIpTag.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmPublicIpTag.md ---- - -# New-AzureRmPublicIpTag - -## SYNOPSIS -Creates an IP Tag. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmPublicIpTag -IpTagType <String> -Tag <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmPublicIpTag** cmdlet creates a IP Tag. - -## EXAMPLES - -### 1: Create a new IP Tag -``` -$ipTag = New-AzureRmPublicIpTag -IpTagType $ipTagType -Tag $tag -``` - -This command creates a new IP Tag with the Tagtype like "FirstPartyUsage" -and tag like "/Sql". This is used in publicIpAddress creation with these -specific tags for allocation. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IpTagType -IpTag type Example:FirstPartyUsage - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: FirstPartyUsage, NetworkDomain - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -IpTag value Example:/Sql - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSPublicIpTag - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmRouteConfig.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmRouteConfig.md deleted file mode 100644 index c2dfc9c261..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmRouteConfig.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 356764CF-A860-432A-907A-9058CEB2BF8E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermrouteconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmRouteConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmRouteConfig.md ---- - -# New-AzureRmRouteConfig - -## SYNOPSIS -Creates a route for a route table. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmRouteConfig [-Name <String>] [-AddressPrefix <String>] [-NextHopType <String>] - [-NextHopIpAddress <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmRouteConfig** cmdlet creates a route for an Azure route table. - -## EXAMPLES - -### Example 1: Create a route -``` -PS C:\>$Route = New-AzureRmRouteConfig -Name "Route07" -AddressPrefix 10.1.0.0/16 -NextHopType "VnetLocal" -PS C:\> $Route -Name : Route07 -Id : -Etag : -ProvisioningState : -AddressPrefix : 10.1.0.0/16 -NextHopType : VnetLocal -NextHopIpAddress : -``` - -The first command creates a route named Route07, and then stores it in the $Route variable. -This route forwards packets to the local virtual network. -The second command displays the properties of the route. - -## PARAMETERS - -### -AddressPrefix -Specifies the destination, in Classless Interdomain Routing (CIDR) format, to which the route applies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the route. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NextHopIpAddress -Specifies the IP address of a virtual appliance that you add to your Azurevirtual network. -This route forwards packets to that address. -Specify this parameter only if you specify a value of VirtualAppliance for the *NextHopType* parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NextHopType -Specifies how this route forwards packets. -The acceptable values for this parameter are: -- Internet. -The default Internet gateway provided by Azure. -- None. -If you specify this value, the route does not forward packets. -- VirtualAppliance. -A virtual appliance that you add to your Azure virtual network. -- VirtualNetworkGateway. -An Azure server-to-server virtual private network gateway. -- VnetLocal. -The local virtual network. -If you have two subnets, 10.1.0.0/16 and 10.2.0.0/16 in the same virtual network, select a value of VnetLocal for each subnet to forward to the other subnet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRoute - -## NOTES - -## RELATED LINKS - -[Add-AzureRmRouteConfig](./Add-AzureRmRouteConfig.md) - -[Get-AzureRmRouteConfig](./Get-AzureRmRouteConfig.md) - -[Remove-AzureRmRouteConfig](./Remove-AzureRmRouteConfig.md) - -[Set-AzureRmRouteConfig](./Set-AzureRmRouteConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmRouteFilter.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmRouteFilter.md deleted file mode 100644 index 0656c5f18e..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmRouteFilter.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermroutefilter -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmRouteFilter.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmRouteFilter.md ---- - -# New-AzureRmRouteFilter - -## SYNOPSIS -Creates a route filter. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmRouteFilter -Name <String> -ResourceGroupName <String> -Location <String> - [-Rule <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSRouteFilterRule]>] - [-Tag <Hashtable>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmRouteFilter cmdlet creates an Azure route filter. - -## EXAMPLES - -### Example 1 -``` -PS C:\> {{ Add example code here }} -``` - - -{{ Add example description here }} - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Indicates that this cmdlet creates a route table even if a route filter that has the same name already exists. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the Azure region in which this cmdlet creates a route filter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the route filter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group in which this cmdlet creates a route filter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Rule -Specifies an array of Route Filter Rule objects to associate with the route filter. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSRouteFilterRule] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSRouteFilterRule, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteFilter - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Get-AzureRmRouteFilter](./Get-AzureRmRouteFilter.md) - -[New-AzureRmRouteFilterRuleConfig](./New-AzureRmRouteFilterRuleConfig.md) - -[Remove-AzureRmRouteFilter](./Remove-AzureRmRouteFilter.md) - -[Set-AzureRmRouteFilter](./Set-AzureRmRouteFilter.md) diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmRouteFilterRuleConfig.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmRouteFilterRuleConfig.md deleted file mode 100644 index 9413365332..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmRouteFilterRuleConfig.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermroutefilterruleconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmRouteFilterRuleConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmRouteFilterRuleConfig.md ---- - -# New-AzureRmRouteFilterRuleConfig - -## SYNOPSIS -Creates a route filter rule for a route filter. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmRouteFilterRuleConfig [-Force] -Name <String> -Access <String> -RouteFilterRuleType <String> - -CommunityList <System.Collections.Generic.List`1[System.String]> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmRouteFilterRuleConfig cmdlet creates a route filter rule for an Azure route filter. - -## EXAMPLES - -### Example 1 -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -Access -Access for route filter rule. -Valid values are Allow or Deny. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Allow, Deny - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CommunityList -The list of community value that route filter will filter on - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation if you want to overrite a resource - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the route filter rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteFilterRuleType -Route Filter Rule Type. -Valid values are: Community - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Community - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteFilterRule - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Add-AzureRmRouteFilterRuleConfig](./Add-AzureRmRouteFilterRuleConfig.md) - -[Get-AzureRmRouteFilterRuleConfig](./Get-AzureRmRouteFilterRuleConfig.md) - -[Remove-AzureRmRouteFilterRuleConfig](./Remove-AzureRmRouteFilterRuleConfig.md) - -[Set-AzureRmRouteFilterRuleConfig](./Set-AzureRmRouteFilterRuleConfig.md) - diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmRouteTable.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmRouteTable.md deleted file mode 100644 index f85b345482..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmRouteTable.md +++ /dev/null @@ -1,260 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 6A278F91-C078-4DD4-82D0-2E4FA549A089 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermroutetable -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmRouteTable.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmRouteTable.md ---- - -# New-AzureRmRouteTable - -## SYNOPSIS -Creates a route table. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmRouteTable -ResourceGroupName <String> -Name <String> [-DisableBgpRoutePropagation] - -Location <String> [-Tag <Hashtable>] - [-Route <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSRoute]>] [-Force] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmRouteTable** cmdlet creates an Azure route table. - -## EXAMPLES - -### Example 1: Create a route table that contains a route -``` -PS C:\>$Route = New-AzureRmRouteConfig -Name "Route07" -AddressPrefix 10.1.0.0/16 -NextHopType "VnetLocal" -PS C:\> New-AzureRmRouteTable -Name "RouteTable01" -ResourceGroupName "ResourceGroup11" -Location "EASTUS" -Route $Route -Name : routetable01 -ResourceGroupName : ResourceGroup11 -Location : eastus -Id : /subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Microsoft.Networ - k/routeTables/myroutetable -Etag : W/"db5f4e12-3f34-465b-92dd-0ab3bf6fc274" -ProvisioningState : Succeeded -Tags : -Routes : [ - { - "Name": "route07", - "Etag": "W/\"db5f4e12-3f34-465b-92dd-0ab3bf6fc274\"", - "Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro - soft.Network/routeTables/routetable01/routes/route07", - "AddressPrefix": "10.1.0.0/16", - "NextHopType": "VnetLocal", - "NextHopIpAddress": null, - "ProvisioningState": "Succeeded" - } - ] -Subnets : [] -``` - -The first command creates a route named Route07 by using the New-AzureRmRouteConfig cmdlet, and -then stores it in the $Route variable. This route forwards packets to the local virtual network. -The second command creates a route table named RouteTable01, and adds the route stored in $Route to -the new table. The command specifies the resource group to which the table belongs and the location -for the table. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableBgpRoutePropagation -Disable BGP Route auto propagation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Indicates that this cmdlet creates a route table even if a route table that has the same name already exists. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the Azure region in which this cmdlet creates a route table. -For more information, see [Azure Regions](https://azure.microsoft.com/en-us/regions/). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the route table. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group in which this cmdlet creates a route table. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Route -Specifies an array of **Route** objects to associate with the route table. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSRoute] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -### System.Collections.Generic.List\`1[[Microsoft.Azure.Commands.Network.Models.PSRoute, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteTable - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRouteTable](./Get-AzureRmRouteTable.md) - -[New-AzureRmRouteConfig](./New-AzureRmRouteConfig.md) - -[Remove-AzureRmRouteTable](./Remove-AzureRmRouteTable.md) - -[Set-AzureRmRouteTable](./Set-AzureRmRouteTable.md) diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmServiceEndpointPolicy.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmServiceEndpointPolicy.md deleted file mode 100644 index 5300a3b929..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmServiceEndpointPolicy.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermserviceendpointpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmServiceEndpointPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmServiceEndpointPolicy.md ---- - -# New-AzureRmServiceEndpointPolicy - -## SYNOPSIS -{{Fill in the Synopsis}} - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmServiceEndpointPolicy -Name <String> - [-ServiceEndpointDefinitions <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicyDefinition]>] - -ResourceGroupName <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmServiceEndpointPolicy** cmdlet create a service endpoint policy. - -## EXAMPLES - -### Example 1: Creates a service endpoint policy -``` -$serviceEndpointPolicy = New-AzureRmServiceEndpointPolicy -Name "Policy1" -ServiceEndpointPolicyDefinition $serviceEndpointDefinition -Location "location"; -``` - -This command creates a service endpoint policy named Policy1 with definitions defined by the object $serviceEndpointDefinition and stores it in the $serviceEndpointPolicy variable. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation if you want to overrite a resource - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the subnet - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceEndpointDefinitions -List of service endpoint definitions - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicyDefinition] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy - - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmServiceEndpointPolicyDefinition.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmServiceEndpointPolicyDefinition.md deleted file mode 100644 index 91c4be0f6a..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmServiceEndpointPolicyDefinition.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermserviceendpointpolicydefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmServiceEndpointPolicyDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmServiceEndpointPolicyDefinition.md ---- - -# New-AzureRmServiceEndpointPolicyDefinition - -## SYNOPSIS -{{Fill in the Synopsis}} - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmServiceEndpointPolicyDefinition -Name <String> [-Description <String>] - [-ServiceResource <System.Collections.Generic.List`1[System.String]>] [-Service <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmServiceEndpointPolicyDefinition** cmdlet create a service endpoint policy definition. - -## EXAMPLES - -### Example 1: Creates a service endpoint policy -``` -$policydef= New-AzureRmServiceEndpointPolicyDefinition -Name "ServiceEndpointPolicyDefinition1" -ResourceGroupName "ResourceGroup01" -Service "Microsoft.Storage" -ServiceResources "subscriptions/sub1" -Description "New Definition" -``` - -This command creates the service endpoint policy definition with name ServiceEndpointPolicyDefinition1, service Microsoft.Storage, service resources subscriptions/sub1 and -description "New Definition" that belongs to the resource group named ResourceGroup01 and stores it in the $policydef variable. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The description of the definition - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the service endpoint policy - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Service -Name of the service - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceResource -List of service resources - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicyDefinition - - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualHub.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualHub.md deleted file mode 100644 index d090ce1368..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualHub.md +++ /dev/null @@ -1,323 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermvirtualhub -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVirtualHub.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVirtualHub.md ---- - -# New-AzureRmVirtualHub - -## SYNOPSIS -Creates an Azure VirtualHub resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVirtualWanObject (Default) -``` -New-AzureRmVirtualHub -ResourceGroupName <String> -Name <String> -VirtualWan <PSVirtualWan> - -AddressPrefix <String> -Location <String> [-HubVnetConnection <PSHubVirtualNetworkConnection[]>] - [-RouteTable <PSVirtualHubRouteTable>] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByVirtualWanResourceId -``` -New-AzureRmVirtualHub -ResourceGroupName <String> -Name <String> -VirtualWanId <String> -AddressPrefix <String> - -Location <String> [-HubVnetConnection <PSHubVirtualNetworkConnection[]>] - [-RouteTable <PSVirtualHubRouteTable>] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Creates an Azure VirtualHub resource. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> $virtualWan = New-AzureRmVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" -PS C:\> New-AzureRmVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" - -VirtualWan : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualWans/myVirtualWAN -ResourceGroupName : testRG -Name : westushub -Id : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub -AddressPrefix : 10.0.1.0/24 -RouteTable : -VirtualNetworkConnections : {} -Location : West US -Type : Microsoft.Network/virtualHubs -ProvisioningState : Succeeded -``` - -The above will create a resource group "testRG", a Virtual WAN and a Virtual Hub in West US in that resource group in Azure. The virtual hub will have the address space "10.0.1.0/24". - -### Example 2 - -```powershell -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> $virtualWan = New-AzureRmVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" -PS C:\> New-AzureRmVirtualHub -VirtualWanId $virtualWan.Id -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" -Location "West US" - -VirtualWan : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualWans/myVirtualWAN -ResourceGroupName : testRG -Name : westushub -Id : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub -AddressPrefix : 10.0.1.0/24 -RouteTable : -VirtualNetworkConnections : {} -Location : West US -Type : Microsoft.Network/virtualHubs -ProvisioningState : Succeeded -``` - -The above will create a resource group "testRG", a Virtual WAN and a Virtual Hub in West US in that resource group in Azure. The virtual hub will have the address space "10.0.1.0/24". - -This example is similar to Example 1, but uses a resource Id to reference the Virtual WAN that is required to create the virtual Hub. - -### Example 3 - -```powershell -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> $virtualWan = New-AzureRmVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" -PS C:\> $route1 = New-AzureRmVirtualHubRoute -AddressPrefix @("10.0.0.0/16", "11.0.0.0/16") -NextHopIpAddress "12.0.0.5" -PS C:\> $route2 = New-AzureRmVirtualHubRoute -AddressPrefix @("13.0.0.0/16") -NextHopIpAddress "14.0.0.5" -PS C:\> $routeTable = New-AzureRmVirtualHubRouteTable -Route @($route1, $route2) -PS C:\> New-AzureRmVirtualHub -VirtualWanId $virtualWan.Id -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" -RouteTable $routeTable - -VirtualWan : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualWans/myVirtualWAN -ResourceGroupName : testRG -Name : westushub -Id : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub -AddressPrefix : 10.0.1.0/24 -RouteTable : Microsoft.Azure.Commands.Network.Models.PSVirtualHubRouteTable -VirtualNetworkConnections : {} -Location : West US -Type : Microsoft.Network/virtualHubs -ProvisioningState : Succeeded -``` - -The above will create a resource group "testRG", a Virtual WAN and a Virtual Hub in West US in that resource group in Azure. The virtual hub will have the address space "10.0.1.0/24" and a route table attached. - -This example is similar to Example 2, but also attaches a route table to the virtual hub. - -## PARAMETERS - -### -AddressPrefix -The address space string for this virtual hub. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HubVnetConnection -The hub virtual network connections associated with this Virtual Hub. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSHubVirtualNetworkConnection[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -location. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName, VirtualHubName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteTable -The route table associated with this Virtual Hub. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHubRouteTable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -A hashtable which represents resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualWan -The virtual wan object this hub is linked to. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualWan -Parameter Sets: ByVirtualWanObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VirtualWanId -The id of virtual wan object this hub is linked to. - -```yaml -Type: System.String -Parameter Sets: ByVirtualWanResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualWan - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualHub - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualHubRoute.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualHubRoute.md deleted file mode 100644 index a540fea3dd..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualHubRoute.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermvirtualhubroute -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVirtualHubRoute.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVirtualHubRoute.md ---- - -# New-AzureRmVirtualHubRoute - -## SYNOPSIS -Creates an Azure Virtual Hub Route object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmVirtualHubRoute -AddressPrefix <String[]> -NextHopIpAddress <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Creates an Azure Virtual Hub Route object. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> $route1 = - -AddressPrefixes NextHopIpAddress ---------------- ---------------- -{10.0.0.0/16, 11.0.0.0/16} 12.0.0.5 -``` - -The above will create a virtual hub route object that can be included in the virtual hub route table. - -The virtual hub route is an in-memory object that can be used to create a VirtualHubRouteTable object. - -## PARAMETERS - -### -AddressPrefix -List of Address Prefixes. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NextHopIpAddress -The Next Hop IpAddress. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualHubRoute - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualHubRouteTable.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualHubRouteTable.md deleted file mode 100644 index 387550ca02..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualHubRouteTable.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermvirtualhubroutetable -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVirtualHubRouteTable.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVirtualHubRouteTable.md ---- - -# New-AzureRmVirtualHubRouteTable - -## SYNOPSIS -Creates an Azure Virtual Hub Route Table object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmVirtualHubRouteTable -Route <PSVirtualHubRoute[]> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -Creates an Azure Virtual Hub Route Table object. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> $route1 = New-AzureRmVirtualHubRoute -AddressPrefix @("10.0.0.0/16", "11.0.0.0/16") -NextHopIpAddress "12.0.0.5" -PS C:\> $route2 = New-AzureRmVirtualHubRoute -AddressPrefix @("13.0.0.0/16") -NextHopIpAddress "14.0.0.5" -PS C:\> $routeTable = New-AzureRmVirtualHubRouteTable -Route @($route1, $route2) -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> $virtualWan = New-AzureRmVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" -PS C:\> New-AzureRmVirtualHub -VirtualWanId $virtualWan.Id -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" -RouteTable $routeTable - -VirtualWan : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualWans/myVirtualWAN -ResourceGroupName : testRG -Name : westushub -Id : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub -AddressPrefix : 10.0.1.0/24 -RouteTable : Microsoft.Azure.Commands.Network.Models.PSVirtualHubRouteTable -VirtualNetworkConnections : {} -Location : West US -Type : Microsoft.Network/virtualHubs -ProvisioningState : Succeeded -``` - -The above will create a route table composed of multiple routes and attached to a new virtual hub. - -This is an in-memory object that can be used to add a Route table to a new or an existing VirtualHub. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Route -List of virtual hub routes. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHubRoute[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualHubRouteTable - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualHubVnetConnection.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualHubVnetConnection.md deleted file mode 100644 index c6666ad11a..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualHubVnetConnection.md +++ /dev/null @@ -1,267 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermvirtualhubvnetconnection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVirtualHubVnetConnection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVirtualHubVnetConnection.md ---- - -# New-AzureRmVirtualHubVnetConnection - -## SYNOPSIS -The New-AzureRmVirtualHubVnetConnection cmdlet creates a HubVirtualNetworkConnection resource that peers a Virtual Network to the Azure Virtual Hub. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVirtualHubNameByRemoteVirtualNetworkObject (Default) -``` -New-AzureRmVirtualHubVnetConnection -ResourceGroupName <String> -ParentResourceName <String> -Name <String> - -RemoteVirtualNetwork <PSVirtualNetwork> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ByVirtualHubNameByRemoteVirtualNetworkResourceId -``` -New-AzureRmVirtualHubVnetConnection -ResourceGroupName <String> -ParentResourceName <String> -Name <String> - -RemoteVirtualNetworkId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByVirtualHubObjectByRemoteVirtualNetworkObject -``` -New-AzureRmVirtualHubVnetConnection -ParentObject <PSVirtualHub> -Name <String> - -RemoteVirtualNetwork <PSVirtualNetwork> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ByVirtualHubObjectByRemoteVirtualNetworkResourceId -``` -New-AzureRmVirtualHubVnetConnection -ParentObject <PSVirtualHub> -Name <String> - -RemoteVirtualNetworkId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByVirtualHubResourceIdByRemoteVirtualNetworkObject -``` -New-AzureRmVirtualHubVnetConnection -ParentResourceId <String> -Name <String> - -RemoteVirtualNetwork <PSVirtualNetwork> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ByVirtualHubResourceIdByRemoteVirtualNetworkResourceId -``` -New-AzureRmVirtualHubVnetConnection -ParentResourceId <String> -Name <String> -RemoteVirtualNetworkId <String> - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmVirtualHubVnetConnection cmdlet creates a HubVirtualNetworkConnection resource that peers a Virtual Network to the Azure Virtual Hub. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> $frontendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" -PS C:\> $backendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name backendSubnet -AddressPrefix "10.0.2.0/24" -PS C:\> $remoteVirtualNetwork = New-AzureRmVirtualNetwork -Name "MyVirtualNetwork" -ResourceGroupName "testRG" -Location "West US" -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet,$backendSubnet -PS C:\> $virtualWan = New-AzureRmVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" -PS C:\> New-AzureRmVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" -PS C:\> New-AzureRmVirtualHubVnetConnection -ResourceGroupName "testRG" -VirtualHubName "westushub" -Name "testvnetconnection" -RemoteVirtualNetwork $remoteVirtualNetwork - -Name : testvnetconnection -Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub/hubVirtualNetworkConnections/testvnetconnection -RemoteVirtualNetwork : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualNetworks/MyVirtualNetwork -ProvisioningState : Succeeded -``` - -The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub in Central US in that resource group in Azure. A Virtual Network Connection will be created thereafter which will peer the Virtual Network to the Virtual Hub. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName, HubVirtualNetworkConnectionName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParentObject -The parent resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub -Parameter Sets: ByVirtualHubObjectByRemoteVirtualNetworkObject, ByVirtualHubObjectByRemoteVirtualNetworkResourceId -Aliases: VirtualHub, ParentVirtualHub - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ParentResourceId -The parent resource. - -```yaml -Type: System.String -Parameter Sets: ByVirtualHubResourceIdByRemoteVirtualNetworkObject, ByVirtualHubResourceIdByRemoteVirtualNetworkResourceId -Aliases: VirtualHubId, ParentVirtualHubId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ParentResourceName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByVirtualHubNameByRemoteVirtualNetworkObject, ByVirtualHubNameByRemoteVirtualNetworkResourceId -Aliases: VirtualHubName, ParentVirtualHubName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteVirtualNetwork -The remote virtual network to which this hub virtual network connection is connected. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork -Parameter Sets: ByVirtualHubNameByRemoteVirtualNetworkObject, ByVirtualHubObjectByRemoteVirtualNetworkObject, ByVirtualHubResourceIdByRemoteVirtualNetworkObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteVirtualNetworkId -The remote virtual network to which this hub virtual network connection is connected. - -```yaml -Type: System.String -Parameter Sets: ByVirtualHubNameByRemoteVirtualNetworkResourceId, ByVirtualHubObjectByRemoteVirtualNetworkResourceId, ByVirtualHubResourceIdByRemoteVirtualNetworkResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByVirtualHubNameByRemoteVirtualNetworkObject, ByVirtualHubNameByRemoteVirtualNetworkResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualHub - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSHubVirtualNetworkConnection - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualNetwork.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualNetwork.md deleted file mode 100644 index 2d3bcbadb8..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualNetwork.md +++ /dev/null @@ -1,338 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 81D55C43-C9A3-4DA7-A469-A3A7550FE9A4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermvirtualnetwork -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVirtualNetwork.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVirtualNetwork.md ---- - -# New-AzureRmVirtualNetwork - -## SYNOPSIS -Creates a virtual network. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmVirtualNetwork -Name <String> -ResourceGroupName <String> -Location <String> - -AddressPrefix <System.Collections.Generic.List`1[System.String]> - [-DnsServer <System.Collections.Generic.List`1[System.String]>] - [-Subnet <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSSubnet]>] - [-Tag <Hashtable>] [-EnableDdosProtection] [-DdosProtectionPlanId <String>] [-EnableVmProtection] [-Force] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmVirtualNetwork** cmdlet creates an Azure virtual network. - -## EXAMPLES - -### 1: Create a virtual network with two subnets -``` -New-AzureRmResourceGroup -Name TestResourceGroup -Location centralus -$frontendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" -$backendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name backendSubnet -AddressPrefix "10.0.2.0/24" -New-AzureRmVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet,$backendSubnet -``` - -This example creates a virtual network with two subnets. First, a new resource group is created in -the centralus region. Then, the example creates in-memory representations of two subnets. The -New-AzureRmVirtualNetworkSubnetConfig cmdlet will not create any subnet on the server side. There -is one subnet called frontendSubnet and one subnet called backendSubnet. The -New-AzureRmVirtualNetwork cmdlet then creates a virtual network using the CIDR 10.0.0.0/16 as the -address prefix and two subnets. - -### 2: Create a virtual network with DNS settings -``` -New-AzureRmResourceGroup -Name TestResourceGroup -Location centralus -$frontendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" -$backendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name backendSubnet -AddressPrefix "10.0.2.0/24" -New-AzureRmVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet,$backendSubnet -DnsServer 10.0.1.5,10.0.1.6 -``` - -This example create a virtual network with two subnets and two DNS servers. The effect of -specifying the DNS servers on the virtual network is that the NICs/VMs that are deployed into this -virtual network inherit these DNS servers as defaults. These defaults can be overwritten per NIC -through a NIC-level setting. If no DNS servers are specified on a VNET and no DNS servers on the -NICs, then the default Azure DNS servers are used for DNS resolution. - -### 3: Create a virtual network with a subnet referencing a network security group -``` -New-AzureRmResourceGroup -Name TestResourceGroup -Location centralus -$rdpRule = New-AzureRmNetworkSecurityRuleConfig -Name rdp-rule -Description "Allow RDP" -Access Allow -Protocol Tcp -Direction Inbound -Priority 100 -SourceAddressPrefix Internet -SourcePortRange * -DestinationAddressPrefix * -DestinationPortRange 3389 -$networkSecurityGroup = New-AzureRmNetworkSecurityGroup -ResourceGroupName TestResourceGroup -Location centralus -Name "NSG-FrontEnd" -SecurityRules $rdpRule -$frontendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" -NetworkSecurityGroup $networkSecurityGroup -$backendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name backendSubnet -AddressPrefix "10.0.2.0/24" -NetworkSecurityGroup $networkSecurityGroup -New-AzureRmVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet,$backendSubnet -``` - -This example creates a virtual network with subnets that reference a network security group. First, -the example creates a resource group as a container for the resources that will be created. Then, a -network security group is created that allows inbound RDP access, but otherwise enforces the -default network security group rules. The New-AzureRmVirtualNetworkSubnetConfig cmdlet then creates -in-memory representations of two subnets that both reference the network security group that was -created. The New-AzureRmVirtualNetwork command then creates the virtual network. - -## PARAMETERS - -### -AddressPrefix -Specifies a range of IP addresses for a virtual network. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DdosProtectionPlanId -Reference to the DDoS protection plan resource associated with the virtual network. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DnsServer -Specifies the DNS server for a subnet. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableDdosProtection -A switch parameter which represents if DDoS protection is enabled or not. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableVmProtection -A switch parameter which represents if Vm protection is enabled or not. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the region for the virtual network. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual network that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group to contain the virtual network. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Subnet -Specifies a list of subnets to associate with the virtual network. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSSubnet] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSSubnet, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Hashtable - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVirtualNetwork](./Get-AzureRmVirtualNetwork.md) - -[Remove-AzureRmVirtualNetwork](./Remove-AzureRmVirtualNetwork.md) - -[Set-AzureRmVirtualNetwork](./Set-AzureRmVirtualNetwork.md) - -[New-AzureRmDdosProtectionPlan](./New-AzureRmDdosProtectionPlan.md) diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualNetworkGateway.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualNetworkGateway.md deleted file mode 100644 index 83f3521ae9..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualNetworkGateway.md +++ /dev/null @@ -1,533 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 5784FD44-91D4-4537-84F3-4F03CCBA355F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermvirtualnetworkgateway -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVirtualNetworkGateway.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVirtualNetworkGateway.md ---- - -# New-AzureRmVirtualNetworkGateway - -## SYNOPSIS -Creates a Virtual Network Gateway - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Default (Default) -``` -New-AzureRmVirtualNetworkGateway -Name <String> -ResourceGroupName <String> -Location <String> - [-IpConfigurations <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayIpConfiguration]>] - [-GatewayType <String>] [-VpnType <String>] [-EnableBgp <Boolean>] [-EnableActiveActiveFeature] - [-GatewaySku <String>] [-GatewayDefaultSite <PSLocalNetworkGateway>] - [-VpnClientAddressPool <System.Collections.Generic.List`1[System.String]>] - [-VpnClientProtocol <System.Collections.Generic.List`1[System.String]>] - [-VpnClientRootCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate]>] - [-VpnClientRevokedCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate]>] - [-VpnClientIpsecPolicy <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy]>] - [-Asn <UInt32>] [-PeerWeight <Int32>] [-Tag <Hashtable>] [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RadiusServerConfiguration -``` -New-AzureRmVirtualNetworkGateway -Name <String> -ResourceGroupName <String> -Location <String> - [-IpConfigurations <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayIpConfiguration]>] - [-GatewayType <String>] [-VpnType <String>] [-EnableBgp <Boolean>] [-EnableActiveActiveFeature] - [-GatewaySku <String>] [-GatewayDefaultSite <PSLocalNetworkGateway>] - [-VpnClientAddressPool <System.Collections.Generic.List`1[System.String]>] - [-VpnClientProtocol <System.Collections.Generic.List`1[System.String]>] - [-VpnClientRootCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate]>] - [-VpnClientRevokedCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate]>] - [-VpnClientIpsecPolicy <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy]>] - [-Asn <UInt32>] [-PeerWeight <Int32>] [-Tag <Hashtable>] [-Force] -RadiusServerAddress <String> - -RadiusServerSecret <SecureString> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The Virtual Network Gateway is the object representing your gateway in Azure. -The **New-AzureRmVirtualNetworkGateway** cmdlet creates the object of your gateway in Azure based -on the Name, Resource Group Name, Location, and IP configuration, as well as the Gateway Type and -if VPN, the VPN Type. You can also name the Gateway SKU. -If this Gateway is being used for Point-to-Site connections, you will also need to include the VPN -Client Address Pool from which to assign addresses to connecting clients and the VPN Client Root -Certificate used to authenticate VPN clients connecting to the Gateway. -You can also choose to include other features like BGP and Active-Active. - -## EXAMPLES - -### 1: Create a Virtual Network Gateway -``` -New-AzureRmResourceGroup -Location "UK West" -Name "vnet-gateway" -$subnet = New-AzureRMVirtualNetworkSubnetConfig -Name 'gatewaysubnet' -AddressPrefix '10.254.0.0/27' - -$ngwpip = New-AzureRMPublicIpAddress -Name ngwpip -ResourceGroupName "vnet-gateway" -Location "UK West" -AllocationMethod Dynamic -$vnet = New-AzureRmVirtualNetwork -AddressPrefix "10.254.0.0/27" -Location "UK West" -Name vnet-gateway -ResourceGroupName "vnet-gateway" -Subnet $subnet -$subnet = Get-AzureRmVirtualNetworkSubnetConfig -name 'gatewaysubnet' -VirtualNetwork $vnet -$ngwipconfig = New-AzureRMVirtualNetworkGatewayIpConfig -Name ngwipconfig -SubnetId $subnet.Id -PublicIpAddressId $ngwpip.Id - -New-AzureRmVirtualNetworkGateway -Name myNGW -ResourceGroupName vnet-gateway -Location "UK West" -IpConfigurations $ngwIpConfig -GatewayType "Vpn" -VpnType "RouteBased" -GatewaySku "Basic" -``` - -The above will create a resource group, request a Public IP Address, create a Virtual Network and -subnet and create a Virtual Network Gateway in Azure. -The gateway will be called "myNGW" within the resource group "vnet-gateway" in the location "UK -West" with the previously created IP configurations saved in the variable "ngwIPConfig," the -gateway type of "VPN," the vpn type "RouteBased," and the sku "Basic." - -### 2: Create a Virtual Network Gateway with External Radius Configuration -``` -New-AzureRmResourceGroup -Location "UK West" -Name "vnet-gateway" -New-AzureRMVirtualNetworkSubnetConfig -Name 'gatewaysubnet' -AddressPrefix '10.254.0.0/27' - -$ngwpip = New-AzureRMPublicIpAddress -Name ngwpip -ResourceGroupName "vnet-gateway" -Location "UK West" -AllocationMethod Dynamic -$vnet = New-AzureRmVirtualNetwork -AddressPrefix "10.254.0.0/27" -Location "UK West" -Name vnet-gateway -ResourceGroupName "vnet-gateway" -Subnet $subnet -$subnet = Get-AzureRmVirtualNetworkSubnetConfig -name 'gatewaysubnet' -VirtualNetwork $vnet -$ngwipconfig = New-AzureRMVirtualNetworkGatewayIpConfig -Name ngwipconfig -SubnetId $subnet.Id -PublicIpAddressId $ngwpip.Id -$Secure_String_Pwd = ConvertTo-SecureString "TestRadiusServerPassword" -AsPlainText -Force - -New-AzureRmVirtualNetworkGateway -Name myNGW -ResourceGroupName vnet-gateway -Location "UK West" -IpConfigurations $ngwIpConfig -GatewayType "Vpn" -VpnType "RouteBased" -GatewaySku "Basic" -RadiusServerAddress "TestRadiusServer" -RadiusServerSecret $Secure_String_Pwd -``` - -The above will create a resource group, request a Public IP Address, create a Virtual Network and -subnet and create a Virtual Network Gateway in Azure. -The gateway will be called "myNGW" within the resource group "vnet-gateway" in the location "UK West" with the previously created IP configurations saved in the variable "ngwIPConfig," the gateway type of "VPN," the vpn type "RouteBased," and the sku "Basic." It also adds an external radius server with address "TestRadiusServer" - -### 1: Create a Virtual Network Gateway with P2S settings -``` -New-AzureRmResourceGroup -Location "UK West" -Name "vnet-gateway" -$subnet = New-AzureRMVirtualNetworkSubnetConfig -Name 'gatewaysubnet' -AddressPrefix '10.254.0.0/27' - -$ngwpip = New-AzureRMPublicIpAddress -Name ngwpip -ResourceGroupName "vnet-gateway" -Location "UK West" -AllocationMethod Dynamic -$vnet = New-AzureRmVirtualNetwork -AddressPrefix "10.254.0.0/27" -Location "UK West" -Name vnet-gateway -ResourceGroupName "vnet-gateway" -Subnet $subnet -$subnet = Get-AzureRmVirtualNetworkSubnetConfig -name 'gatewaysubnet' -VirtualNetwork $vnet -$ngwipconfig = New-AzureRMVirtualNetworkGatewayIpConfig -Name ngwipconfig -SubnetId $subnet.Id -PublicIpAddressId $ngwpip.Id -$rootCert = New-AzureRmVpnClientRootCertificate -Name $clientRootCertName -PublicCertData $samplePublicCertData -$vpnclientipsecpolicy = New-AzureRmVpnClientIpsecPolicy -IpsecEncryption AES256 -IpsecIntegrity SHA256 -SALifeTimeSeconds 86471 -SADataSizeKilobytes 429496 -IkeEncryption AES256 -IkeIntegrity SHA384 -DhGroup DHGroup2 -PfsGroup PFS2 - -New-AzureRmVirtualNetworkGateway -Name myNGW -ResourceGroupName vnet-gateway -Location "UK West" -IpConfigurations $ngwIpConfig -GatewayType "Vpn" -VpnType "RouteBased" -GatewaySku "VpnGw1" -VpnClientProtocol IkeV2 -VpnClientAddressPool 201.169.0.0/16 -VpnClientRootCertificates $rootCert -VpnClientIpsecPolicy $vpnclientipsecpolicy -``` - -The above will create a resource group, request a Public IP Address, create a Virtual Network and -subnet and create a Virtual Network Gateway with P2S settings e.g. VpnProtocol,VpnClientAddressPool,VpnClientRootCertificates,VpnClientIpsecPolicy etc. in Azure. -The gateway will be called "myNGW" within the resource group "vnet-gateway" in the location "UK West" with the previously created IP configurations saved in the variable "ngwIPConfig," the gateway type of "VPN," the vpn type "RouteBased," and the sku "VpnGw1." Vpn settings will be set on Gateway such as VpnProtocol set as Ikev2, VpnClientAddressPool as "201.169.0.0/16", VpnClientRootCertificate set as passed one: clientRootCertName and custom vpn ipsec policy passed in object:$vpnclientipsecpolicy - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Asn - -```yaml -Type: System.UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableActiveActiveFeature -Enables the active-active feature. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableBgp - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GatewayDefaultSite - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSLocalNetworkGateway -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GatewaySku - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Basic, Standard, HighPerformance, UltraPerformance, VpnGw1, VpnGw2, VpnGw3, VpnGw1AZ, VpnGw2AZ, VpnGw3AZ, ErGw1AZ, ErGw2AZ, ErGw3AZ - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GatewayType - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Vpn, ExpressRoute - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IpConfigurations - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayIpConfiguration] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PeerWeight - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RadiusServerAddress -P2S External Radius server address. - -```yaml -Type: System.String -Parameter Sets: RadiusServerConfiguration -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RadiusServerSecret -P2S External Radius server secret. - -```yaml -Type: System.Security.SecureString -Parameter Sets: RadiusServerConfiguration -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VpnClientAddressPool - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VpnClientIpsecPolicy -A list of IPSec policies for P2S VPN client tunneling protocols. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VpnClientProtocol -The list of P2S VPN client tunneling protocols - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: -Accepted values: SSTP, IkeV2, OpenVPN - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VpnClientRevokedCertificates - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VpnClientRootCertificates - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VpnType - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: PolicyBased, RouteBased - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayIpConfiguration, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Boolean - -### Microsoft.Azure.Commands.Network.Models.PSLocalNetworkGateway - -### System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.UInt32 - -### System.Int32 - -### System.Collections.Hashtable - -### System.Security.SecureString - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVirtualNetworkGateway](./Get-AzureRmVirtualNetworkGateway.md) - -[Remove-AzureRmVirtualNetworkGateway](./Remove-AzureRmVirtualNetworkGateway.md) - -[Reset-AzureRmVirtualNetworkGateway](./Reset-AzureRmVirtualNetworkGateway.md) - -[Resize-AzureRmVirtualNetworkGateway](./Resize-AzureRmVirtualNetworkGateway.md) - -[Set-AzureRmVirtualNetworkGateway](./Set-AzureRmVirtualNetworkGateway.md) diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualNetworkGatewayConnection.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualNetworkGatewayConnection.md deleted file mode 100644 index cfca275b11..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualNetworkGatewayConnection.md +++ /dev/null @@ -1,405 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 0F141A92-4994-45B3-AE94-09865BC691C4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermvirtualnetworkgatewayconnection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVirtualNetworkGatewayConnection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVirtualNetworkGatewayConnection.md ---- - -# New-AzureRmVirtualNetworkGatewayConnection - -## SYNOPSIS -Creates the Site-to-Site VPN connection between the virtual network gateway and the on-prem VPN device. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -New-AzureRmVirtualNetworkGatewayConnection -Name <String> -ResourceGroupName <String> -Location <String> - [-AuthorizationKey <String>] -VirtualNetworkGateway1 <PSVirtualNetworkGateway> - [-VirtualNetworkGateway2 <PSVirtualNetworkGateway>] [-LocalNetworkGateway2 <PSLocalNetworkGateway>] - -ConnectionType <String> [-RoutingWeight <Int32>] [-SharedKey <String>] [-Peer <PSPeering>] - [-EnableBgp <Boolean>] [-Tag <Hashtable>] [-Force] [-UsePolicyBasedTrafficSelectors <Boolean>] - [-IpsecPolicies <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy]>] [-ExpressRouteGatewayBypass] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByResourceId -``` -New-AzureRmVirtualNetworkGatewayConnection -Name <String> -ResourceGroupName <String> -Location <String> - [-AuthorizationKey <String>] -VirtualNetworkGateway1 <PSVirtualNetworkGateway> - [-VirtualNetworkGateway2 <PSVirtualNetworkGateway>] [-LocalNetworkGateway2 <PSLocalNetworkGateway>] - -ConnectionType <String> [-RoutingWeight <Int32>] [-SharedKey <String>] [-PeerId <String>] - [-EnableBgp <Boolean>] [-Tag <Hashtable>] [-Force] [-UsePolicyBasedTrafficSelectors <Boolean>] - [-IpsecPolicies <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy]>] [-ExpressRouteGatewayBypass] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Creates the Site-to-Site VPN connection between the virtual network gateway and the on-prem VPN device. - -## EXAMPLES - -### Example 1 -``` -New-AzureRmVirtualNetworkGatewayConnection -Name conn-client-1 -ResourceGroupName $RG1 -VirtualNetworkGateway1 $vnetgw1 -VirtualNetworkGateway2 $vnetgw2 -Location $loc1 -ConnectionType Vnet2Vnet -SharedKey 'a1b2c3d4e5' -``` - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthorizationKey - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConnectionType - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: IPsec, Vnet2Vnet, ExpressRoute, VPNClient - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableBgp - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExpressRouteGatewayBypass - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IpsecPolicies -A list of IPSec policies. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LocalNetworkGateway2 - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSLocalNetworkGateway -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Peer - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSPeering -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PeerId - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RoutingWeight - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SharedKey - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UsePolicyBasedTrafficSelectors -Use policy-based traffic selectors for a S2S connection - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkGateway1 - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkGateway2 - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway - -### Microsoft.Azure.Commands.Network.Models.PSLocalNetworkGateway - -### System.Int32 - -### Microsoft.Azure.Commands.Network.Models.PSPeering - -### System.Boolean - -### System.Collections.Hashtable - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayConnection - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVirtualNetworkGatewayConnection](./Get-AzureRmVirtualNetworkGatewayConnection.md) - -[Remove-AzureRmVirtualNetworkGatewayConnection](./Remove-AzureRmVirtualNetworkGatewayConnection.md) - -[Set-AzureRmVirtualNetworkGatewayConnection](./Set-AzureRmVirtualNetworkGatewayConnection.md) diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualNetworkGatewayIpConfig.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualNetworkGatewayIpConfig.md deleted file mode 100644 index 99c8958526..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualNetworkGatewayIpConfig.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: C6E65138-CD14-4A54-A901-8E944201F2AE -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermvirtualnetworkgatewayipconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVirtualNetworkGatewayIpConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVirtualNetworkGatewayIpConfig.md ---- - -# New-AzureRmVirtualNetworkGatewayIpConfig - -## SYNOPSIS -Creates an IP Configuration for a Virtual Network Gateway - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -New-AzureRmVirtualNetworkGatewayIpConfig -Name <String> [-PrivateIpAddress <String>] [-SubnetId <String>] - [-PublicIpAddressId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -New-AzureRmVirtualNetworkGatewayIpConfig -Name <String> [-PrivateIpAddress <String>] [-Subnet <PSSubnet>] - [-PublicIpAddress <PSPublicIpAddress>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmVirtualNetworkGatewayIpConfig** cmdlet creates a configuration assigned to a Virtual Network Gateway with a (previously created) Public IP Address based on Subnet ID. - -## EXAMPLES - -### 1: Create an IP Configuration for a Virtual Network Gateway -``` -$gwIpConfig = New-AzureRmVirtualNetworkGatewayIpConfig -Name myGWIpConfig -SubnetId $myGWsubnet.Id -PublicIpAddressId $myGWpip.Id -``` - -Configures a Virtual Network Gateway with a Public IP Address. The variable $myGWsubnet is obtained using the **Get-AzureRmVirtualNetworkSubnetConfig** cmdlet on the "GatewaySubnet" within the Virtual Network you intend to create a Virtual Network Gateway. The variable $myGWpip is obtained using the **New-AzureRmPublicIpAddress** cmdlet. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateIpAddress -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIpAddress -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIpAddressId -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subnet -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSSubnet -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetId -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayIpConfiguration - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualNetworkSubnetConfig.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualNetworkSubnetConfig.md deleted file mode 100644 index c3615202e4..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualNetworkSubnetConfig.md +++ /dev/null @@ -1,260 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 901FD38B-67FA-40D5-8D23-51E5544C25D8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermvirtualnetworksubnetconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVirtualNetworkSubnetConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVirtualNetworkSubnetConfig.md ---- - -# New-AzureRmVirtualNetworkSubnetConfig - -## SYNOPSIS -Creates a virtual network subnet configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -New-AzureRmVirtualNetworkSubnetConfig -Name <String> - -AddressPrefix <System.Collections.Generic.List`1[System.String]> - [-NetworkSecurityGroup <PSNetworkSecurityGroup>] [-RouteTable <PSRouteTable>] - [-ServiceEndpoint <System.Collections.Generic.List`1[System.String]>] - [-ServiceEndpointPolicy <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy]>] - [-Delegation <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSDelegation]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResourceId -``` -New-AzureRmVirtualNetworkSubnetConfig -Name <String> - -AddressPrefix <System.Collections.Generic.List`1[System.String]> [-NetworkSecurityGroupId <String>] - [-RouteTableId <String>] [-ServiceEndpoint <System.Collections.Generic.List`1[System.String]>] - [-ServiceEndpointPolicy <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy]>] - [-Delegation <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSDelegation]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -**The New-AzureRmVirtualNetworkSubnetConfig** cmdlet creates a virtual network subnet configuration. - -## EXAMPLES - -### 1: Create a virtual network with two subnets and a network security group -``` -New-AzureRmResourceGroup -Name TestResourceGroup -Location centralus - -$rdpRule = New-AzureRmNetworkSecurityRuleConfig -Name rdp-rule -Description "Allow RDP" ` - -Access Allow -Protocol Tcp -Direction Inbound -Priority 100 ` - -SourceAddressPrefix Internet -SourcePortRange * ` - -DestinationAddressPrefix * -DestinationPortRange 3389 - -$networkSecurityGroup = New-AzureRmNetworkSecurityGroup -ResourceGroupName TestResourceGroup ` - -Location centralus -Name "NSG-FrontEnd" -SecurityRules $rdpRule - -$frontendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet ` - -AddressPrefix "10.0.1.0/24" -NetworkSecurityGroup $networkSecurityGroup - -$backendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name backendSubnet ` - -AddressPrefix "10.0.2.0/24" -NetworkSecurityGroup $networkSecurityGroup - -New-AzureRmVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup ` - -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet,$backendSubnet -``` - -This example creates two new subnet configurations using the - New-AzureRmVirtualSubnetConfig cmdlet, and then uses them to create a virtual network. - The New-AzureRmVirtualSubnetConfig template only creates an in-memory representation of - the subnet. In this example, the frontendSubnet has CIDR 10.0.1.0/24 and references a - network security group that allows RDP access. The backendSubnet has CIDR 10.0.2.0/24 and - references the same network security group. - -## PARAMETERS - -### -AddressPrefix -Specifies a range of IP addresses for a subnet configuration. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Delegation -List of services that have permission to perform operations on this subnet. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSDelegation] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the subnet configuration to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkSecurityGroup -Specifies a NetworkSecurityGroup object. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkSecurityGroupId -Specifies the ID of a network security group. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RouteTable -Specifies the route table associated with the subnet configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSRouteTable -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RouteTableId -Specifies the ID of the route table associated with the subnet configuration. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceEndpoint -Service Endpoint Value - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceEndpointPolicy -Service Endpoint Policies - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup - -### Microsoft.Azure.Commands.Network.Models.PSRouteTable - -### System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy, Microsoft.Azure.Commands.Network, Version=6.7.0.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSDelegation, Microsoft.Azure.Commands.Network, Version=6.7.0.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSSubnet - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVirtualNetworkSubnetConfig](./Add-AzureRmVirtualNetworkSubnetConfig.md) - -[Get-AzureRmVirtualNetworkSubnetConfig](./Get-AzureRmVirtualNetworkSubnetConfig.md) - -[Remove-AzureRmVirtualNetworkSubnetConfig](./Remove-AzureRmVirtualNetworkSubnetConfig.md) - -[Set-AzureRmVirtualNetworkSubnetConfig](./Set-AzureRmVirtualNetworkSubnetConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualNetworkTap.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualNetworkTap.md deleted file mode 100644 index 324bb9cb1f..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualNetworkTap.md +++ /dev/null @@ -1,293 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermvirtualnetworktap -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVirtualNetworkTap.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVirtualNetworkTap.md ---- - -# New-AzureRmVirtualNetworkTap - -## SYNOPSIS -Creates a VirtualNetworkTap resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -New-AzureRmVirtualNetworkTap -ResourceGroupName <String> -Name <String> [-DestinationPort <Int32>] - [-Location <String>] [-Tag <Hashtable>] - [-DestinationNetworkInterfaceIPConfiguration <PSNetworkInterfaceIPConfiguration>] - [-DestinationLoadBalancerFrontEndIPConfiguration <PSFrontendIPConfiguration>] [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByResourceId -``` -New-AzureRmVirtualNetworkTap -ResourceGroupName <String> -Name <String> [-DestinationPort <Int32>] - [-Location <String>] [-Tag <Hashtable>] [-DestinationNetworkInterfaceIPConfigurationId <String>] - [-DestinationLoadBalancerFrontEndIPConfigurationId <String>] [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmVirtualNetworkTap** cmdlet creates an Azure virtual network tap resource. - -## EXAMPLES - -### Example 1: Create an Azure virtual network tap -``` -PS C:\>New-AzureRmVirtualNetworkTap -Name "VirtualNetworkTap1" -ResourceGroupName "ResourceGroup1" -Location "centralus" -DestinationPort 8888 -DestinationNetworkInterfaceIPConfiguration $destinationNic.IpConfigurations[0] -``` - -This command creates a virtual network tap named "VirtualNetworkTap1" which has destination VM configuration details (DestinationIpConfiguration, DestinationPort). -All the source tap configured VM's traffic will be routed to this Destination IP + Port. - -### Example 2: Create an Azure virtual network tap using LoadBalancer IP -``` -# Create LoadBalancer -PS C:\>$frontend = New-AzureRmLoadBalancerFrontendIpConfig -Name $frontendName -PublicIpAddress $publicip -PS C:\>New-AzureRmVirtualNetworkTap -Name "VirtualNetworkTap1" -ResourceGroupName "ResourceGroup1" -Location "centralus" -DestinationLoadBalancerFrontEndIPConfiguration $frontend -``` - -This command creates a virtual network tap named "VirtualNetworkTap1" which has destination VM configuration details (FrontEndIpConfiguration). -All the source tap configured VM's traffic will be routed to this LoadBalancer IpConfiguration. Default Destination Port is 4789. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationLoadBalancerFrontEndIPConfiguration -The reference of the destination load balancer front end IP configuration resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DestinationLoadBalancerFrontEndIPConfigurationId -The reference of the destination load balancer front end IP configuration resource. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DestinationNetworkInterfaceIPConfiguration -The reference of the destination network interface IP configuration resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkInterfaceIPConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DestinationNetworkInterfaceIPConfigurationId -The reference of the destination network interface IP configuration resource. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DestinationPort -The Destination Port of the packet collector - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation if you want to overwrite a resource - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The location. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The name of the tap. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name of the virtual network tap. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -A hashtable which represents resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Int32 - -### System.Collections.Hashtable - -### Microsoft.Azure.Commands.Network.Models.PSNetworkInterfaceIPConfiguration - -### Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkTap - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualWan.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualWan.md deleted file mode 100644 index aa88b3d603..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVirtualWan.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermvirtualwan -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVirtualWan.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVirtualWan.md ---- - -# New-AzureRmVirtualWan - -## SYNOPSIS -Creates an Azure Virtual WAN. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmVirtualWan -ResourceGroupName <String> -Name <String> -Location <String> [-AllowVnetToVnetTraffic] - [-AllowBranchToBranchTraffic] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Creates a new Azure VirtualWAN resource. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> New-AzureRmVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" -AllowBranchToBranchTraffic $true - -Name : testRG -Id : /subscriptions/{SubscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualWans/myVirtualWAN -AllowVnetToVnetTraffic : False -AllowBranchToBranchTraffic : True -Location : West US -Type : Microsoft.Network/virtualWans -ProvisioningState : Succeeded -``` - -The above will create a resource group "testRG" in region "West US" and an Azure Virtual WAN with branch to branch traffic allowed in that resource group in Azure. - -## PARAMETERS - -### -AllowBranchToBranchTraffic -Allow branch to branch traffic for VirtualWan. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowVnetToVnetTraffic -Allow vnet to vnet traffic for VirtualWan. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The location of the VirtualWAN resource. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName, VirtualWanName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -A hashtable which represents resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualWan - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVpnClientConfiguration.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmVpnClientConfiguration.md deleted file mode 100644 index 72f85266f9..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVpnClientConfiguration.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermvpnclientconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVpnClientConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVpnClientConfiguration.md ---- - -# New-AzureRmVpnClientConfiguration - -## SYNOPSIS -This command allows the users to create the Vpn profile package based on pre-configured vpn settings on the VPN gateway, in addition to some additional settings that users may need to configure, for e.g. some root certificates. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmVpnClientConfiguration [-Name <String>] -ResourceGroupName <String> - [-ProcessorArchitecture <String>] -AuthenticationMethod <String> [-RadiusRootCertificateFile <String>] - [-ClientRootCertificateFileList <System.Collections.Generic.List`1[System.String]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -this allows the users to create the Vpn profile package based on pre-configured vpn settings on the VPN gateway, in addition to some additional settings that users may need to configure, for e.g. some root certificates. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmVpnClientConfiguration -ResourceGroupName "ContosoResourceGroup" -Name "ContosoVirtualNetworkGateway" -AuthenticationMethod "EAPTLS" -RadiusRootCertificateFile "C:\Users\Test\Desktop\VpnProfileRadiusCert.cer" -``` - -This cmdlet is used to create a VPN client profile zip file for "ContosoVirtualNetworkGateway" in ResourceGroup "ContosoResourceGroup". The profile is generated for a pre-configured radius server that is configured to use "EAPTLS" authentication method with the VpnProfileRadiusCert certificate file. - -## PARAMETERS - -### -AuthenticationMethod -Authentication Method -Can take values EAPMSCHAPv2 or EAPTLS. When EAPMSCHAPv2 is specified then the cmdlet generates a client configuration installer for username/password authentication that uses EAP-MSCHAPv2 authentication protocol. If EAPTLS is specified then the cmdlet generates a client configuration installer for certificate authentication that uses EAP-TLS protocol. The "EapTls" option can be used for both RADIUS-based certificate authentication and certification authentication performed by the Virtual Network Gateway by uploading the trusted root. The cmdlet automatically detects what is configured. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: EAPTLS, EAPMSCHAPv2 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ClientRootCertificateFileList -A list of client root certificate paths - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProcessorArchitecture -ProcessorArchitecture - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Amd64, X86 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RadiusRootCertificateFile -Radius server root certificate path. This is a mandatory parameter that has to be specified when EAP-TLS with RADIUS authentication is used. This is the full path name of .cer file containing the RADIUS root certificate that the client uses to validates the RADIUS server during authentication. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVpnProfile - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVpnClientIpsecParameter.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmVpnClientIpsecParameter.md deleted file mode 100644 index 18b176d946..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVpnClientIpsecParameter.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermvpnclientipsecparameter -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVpnClientIpsecParameter.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVpnClientIpsecParameter.md ---- - -# New-AzureRmVpnClientIpsecParameter - -## SYNOPSIS -This command allows the users to create the Vpn ipsec parameters object specifying one or all values such as IpsecEncryption,IpsecIntegrity,IkeEncryption,IkeIntegrity,DhGroup,PfsGroup to set on the existing VPN gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmVpnClientIpsecParameter [-SALifeTime <Int32>] [-SADataSize <Int32>] [-IpsecEncryption <String>] - [-IpsecIntegrity <String>] [-IkeEncryption <String>] [-IkeIntegrity <String>] [-DhGroup <String>] - [-PfsGroup <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -This command allows the users to create the Vpn ipsec parameters object specifying one or all values such as IpsecEncryption,IpsecIntegrity,IkeEncryption,IkeIntegrity,DhGroup,PfsGroup to set on the existing VPN gateway. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $vpnclientipsecparams1 = New-AzureRmVpnClientIpsecParameter -IpsecEncryption AES256 -IpsecIntegrity SHA256 -SALifeTime 86473 -SADataSize 429498 -IkeEncryption AES256 -IkeIntegrity SHA384 -DhGroup DHGroup2 -PfsGroup PFS2 -PS C:\> $setvpnIpsecParams = Set-AzureRmVpnClientIpsecParameter -VirtualNetworkGatewayName $rname -ResourceGroupName $rgname -VpnClientIPsecParameter $vpnclientipsecparams1 -``` - -New-AzureRmVpnClientIpsecParameter cmdlet is used to create the vpn ipsec parameters object of using the passed one or all parameters' values which user can set for any existing Virtual network gateway in ResourceGroup. -This created VpnClientIPsecParameters object is passed to Set-AzureRmVpnClientIpsecParameter command to set the specified Vpn ipsec custom policy on Virtual network gateway as shown in above example. This command returns object of VpnClientIPsecParameters which shows set parameters. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DhGroup -The Vpnclient DH Groups used in IKE Phase 1 for initial SA. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: DHGroup24, ECP384, ECP256, DHGroup14, DHGroup2 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IkeEncryption -The Vpnclient IKE encryption algorithm (IKE Phase 2) - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: GCMAES256, GCMAES128, AES256, AES128 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IkeIntegrity -The Vpnclient IKE integrity algorithm (IKE Phase 2) - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: SHA384, SHA256 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IpsecEncryption -The Vpnclient IPSec encryption algorithm (IKE Phase 1) - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: GCMAES256, GCMAES128, AES256, AES128 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IpsecIntegrity -The Vpnclient IPSec integrity algorithm (IKE Phase 1) - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: GCMAES256, GCMAES128, SHA256 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PfsGroup -The Vpnclient PFS Groups used in IKE Phase 2 for new child SA - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: PFS24, PFSMM, ECP384, ECP256, PFS14, PFS2, None - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SADataSize -The Vpnclient IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SALifeTime -The Vpnclient IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVpnClientIPsecParameters - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVpnClientIpsecPolicy.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmVpnClientIpsecPolicy.md deleted file mode 100644 index 9909bc33eb..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVpnClientIpsecPolicy.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermvpnclientipsecpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVpnClientIpsecPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVpnClientIpsecPolicy.md ---- - -# New-AzureRmVpnClientIpsecPolicy - -## SYNOPSIS -This command allows the users to create the Vpn ipsec policy object specifying one or all values such as IpsecEncryption,IpsecIntegrity,IkeEncryption,IkeIntegrity,DhGroup,PfsGroup to set on the VPN gateway. This command let output object is used to set vpn ipsec policy for both new / exisitng gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmVpnClientIpsecPolicy [-SALifeTime <Int32>] [-SADataSize <Int32>] [-IpsecEncryption <String>] - [-IpsecIntegrity <String>] [-IkeEncryption <String>] [-IkeIntegrity <String>] [-DhGroup <String>] - [-PfsGroup <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -This command allows the users to create the Vpn ipsec policy object specifying one or all values such as IpsecEncryption,IpsecIntegrity,IkeEncryption,IkeIntegrity,DhGroup,PfsGroup to set on the VPN gateway. This command let output object is used to set vpn ipsec policy for both new / exisitng gateway. - -## EXAMPLES - -### Define vpn ipsec policy object: -``` -PS C:\>$vpnclientipsecpolicy = New-AzureRmVpnClientIpsecPolicy -IpsecEncryption AES256 -IpsecIntegrity SHA256 -SALifeTime 86472 -SADataSize 429497 -IkeEncryption AES256 -IkeIntegrity SHA256 -DhGroup DHGroup2 -PfsGroup None -``` - -This cmdlet is used to create the vpn ipsec policy object using the passed one or all parameters' values which user can pass to param:VpnClientIpsecPolicy of PS command let: New-AzureRmVirtualNetworkGateway (New VPN Gateway creation) / Set-AzureRmVirtualNetworkGateway (existing VPN Gateway update) in ResourceGroup : - -### Create new virtual network gateway with setting vpn custom ipsec policy: -``` -PS C:\> $vnetGateway = New-AzureRmVirtualNetworkGateway -ResourceGroupName vnet-gateway -name myNGW -location $location -IpConfigurations $vnetIpConfig -GatewayType Vpn -VpnType RouteBased -GatewaySku VpnGw1 -VpnClientIpsecPolicy $vpnclientipsecpolicy -``` - -This cmdlet returns virtual network gateway object after creation. - -### Set vpn custom ipsec policy on existing virtual network gateway: -``` -PS C:\> $vnetGateway = Set-AzureRmVirtualNetworkGateway -VirtualNetworkGateway $gateway -VpnClientIpsecPolicy $vpnclientipsecpolicy -``` - -This cmdlet returns virtual network gateway object after setting vpn custom ipsec policy. - -### Get virtual network gateway to see if vpn custom policy is set correctly: -``` -PS C:\> $gateway = Get-AzureRmVirtualNetworkGateway -ResourceGroupName vnet-gateway -name myNGW -``` - -This cmdlet returns virtual network gateway object. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DhGroup -The Vpnclient DH Groups used in IKE Phase 1 for initial SA - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: DHGroup24, ECP384, ECP256, DHGroup14, DHGroup2 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IkeEncryption -The Vpnclient IKE encryption algorithm (IKE Phase 2) - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: GCMAES256, GCMAES128, AES256, AES128 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IkeIntegrity -The Vpnclient IKE integrity algorithm (IKE Phase 2) - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: SHA384, SHA256 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IpsecEncryption -The Vpnclient IPSec encryption algorithm (IKE Phase 1) - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: GCMAES256, GCMAES128, AES256, AES128 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IpsecIntegrity -The Vpnclient IPSec integrity algorithm (IKE Phase 1) - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: GCMAES256, GCMAES128, SHA256 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PfsGroup -The Vpnclient PFS Groups used in IKE Phase 2 for new child SA - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: PFS24, PFSMM, ECP384, ECP256, PFS14, PFS2, None - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SADataSize -The Vpnclient IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SALifeTime -The Vpnclient IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVpnClientRevokedCertificate.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmVpnClientRevokedCertificate.md deleted file mode 100644 index 834c7f1faa..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVpnClientRevokedCertificate.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 973E1E53-983F-45A7-A7CF-18A8D96EC4E6 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermvpnclientrevokedcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVpnClientRevokedCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVpnClientRevokedCertificate.md ---- - -# New-AzureRmVpnClientRevokedCertificate - -## SYNOPSIS -Creates a new VPN client-revocation certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmVpnClientRevokedCertificate -Name <String> -Thumbprint <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmVpnClientRevokedCertificate** cmdlet creates a new virtual private network (VPN) client-revocation certificate for use on a virtual network gateway. -Client-revocation certificates prevent client computers from using the specified certificate for authentication. -This cmdlet creates a stand-alone certificate that is not assigned to a virtual gateway. -Instead, the certificate created by **New-AzureRmVpnClientRevokedCertificate** is used in conjunction with the New-AzureRmVirtualNetworkGateway cmdlet when it creates a new gateway. -For instance, suppose you create a new certificate and store it in a variable named $Certificate. -You can then use that certificate object when you create a new virtual gateway. -For instance, -`New-AzureRmVirtualNetworkGateway -Name "ContosoVirtualGateway" -ResourceGroupName "ContosoResourceGroup" -Location "West US" -GatewayType "VPN" -IpConfigurations $Ipconfig -VPNType "RouteBased" -VpnClientRevokedCertificates $Certificate` -For more information, see the documentation for the New-AzureRmVirtualNetworkGateway cmdlet. - -## EXAMPLES - -### Example 1: Create a new client-revoked certificate -``` -PS C:\>$Certificate = New-AzureRmVpnClientRevokedCertificate -Name "ContosoClientRevokedCertificate" -Thumbprint "E3A38EBA60CAA1C162785A2E1C44A15AD450199C3" -``` - -This command creates a new client-revoked certificate and stores the certificate object in a variable named $Certificate. -This variable can then be used by the **New-AzureRmVirtualNetworkGateway** cmdlet to add the certificate to a new virtual network gateway. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a unique name for the new client-revocation certificate. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Thumbprint -Specifies the unique identifier of the certificate being added. -You can return thumbprint information for your certificates by using a Windows PowerShell command similar to this: -`Get-ChildItem -Path Cert:\LocalMachine\Root` -The preceding command returns information for all the Local Computer certificates found in the Root certificate store. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVpnClientRevokedCertificate](./Add-AzureRmVpnClientRevokedCertificate.md) - -[Get-AzureRmVpnClientRevokedCertificate](./Get-AzureRmVpnClientRevokedCertificate.md) - -[Remove-AzureRmVpnClientRevokedCertificate](./Remove-AzureRmVpnClientRevokedCertificate.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVpnClientRootCertificate.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmVpnClientRootCertificate.md deleted file mode 100644 index 17ed0b5ca1..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVpnClientRootCertificate.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: C54AC64C-DA21-443E-8CFE-6CCAC6152C2B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermvpnclientrootcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVpnClientRootCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVpnClientRootCertificate.md ---- - -# New-AzureRmVpnClientRootCertificate - -## SYNOPSIS -Creates a new VPN client root certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmVpnClientRootCertificate -Name <String> -PublicCertData <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmVpnClientRootCertificate** cmdlet creates a new VPN root certificate for use on a virtual network gateway. -Root certificates are X.509 certificates that identify your Root Certification Authority: all other certificates used on the gateway trust the root certificate. -This cmdlet creates a stand-alone certificate that is not assigned to a virtual gateway. -Instead, the certificate created by **New-AzureRmVpnClientRootCertificate** is used in conjunction with the New-AzureRmVirtualNetworkGateway cmdlet when creating a new gateway. -For example, suppose you create a new certificate and store it in a variable named $Certificate. -You can then use that certificate object when creating a new virtual gateway. -For instance, -`New-AzureRmVirtualNetworkGateway -Name "ContosoVirtualGateway" -ResourceGroupName "ContosoResourceGroup" -Location "West US" -GatewayType "VPN" -IpConfigurations $Ipconfig -VPNType "RouteBased" -VpnClientRootCertificates $Certificate` -For more information, see the documentation for the New-AzureRmVirtualNetworkGateway cmdlet. - -## EXAMPLES - -### Example 1: Create aclient root certificate -``` -PS C:\> $Text = Get-Content -Path "C:\Azure\Certificates\ExportedCertficate.cer" -PS C:\> $CertificateText = for ($i=1; $i -lt $Text.Length -1 ; $i++){$Text[$i]} -PS C:\> $Certificate = New-AzureRmVpnClientRootCertificate -PublicCertData $CertificateText -Name "ContosoClientRootCertificate" -``` - -This example creates a client root certificate and store the certificate object in a variable named $Certificate. -This variable can then be used by the **New-AzureRmVirtualNetworkGateway** cmdlet to add a root certificate to a new virtual network gateway. -The first command uses the **Get-Content** cmdlet to get a previously exported text representation of the root certificate; that text data is stored in a variable named $Text. -The second command then uses a for loop to extract all the text except for the first line and the last line, storing the extracted text in a variable named $CertificateText. -The third command uses the **New-AzureRmVpnClientRootCertificate** cmdlet to create the certificate, storing the created object in a variable named $Certificate. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the new client root certificate. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicCertData -Specifies a text representation of the root certificate to be added. -To obtain the text representation, export your certificate in .cer format (using Base64 encoding), then open the resulting file in a text editor. -You should see output similar to this (note that the actual output will contain many more lines of text than the abbreviated sample shown here): ------ BEGIN CERTIFICATE ----- -MIIC13FAAXC3671Auij9HHgUNEW8343NMJklo09982CVVFAw8w ------ END CERTIFICATE ----- -The PublicCertData is made up of all the lines between the first line (----- BEGIN CERTIFICATE -----) and the last line (----- END CERTIFICATE -----) in the file. -You can retrieve the PublicCertData by using Windows PowerShell commands similar to this: -$Text = Get-Content -Path "C:\Azure\Certificates\ExportedCertficate.cer" -$CertificateText = for ($i=1; $i -lt $Text.Length -1 ; $i++){$Text\[$i\]} - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVpnClientRootCertificate](./Add-AzureRmVpnClientRootCertificate.md) - -[Get-AzureRmVpnClientRootCertificate](./Get-AzureRmVpnClientRootCertificate.md) - -[Remove-AzureRmVpnClientRootCertificate](./Remove-AzureRmVpnClientRootCertificate.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVpnConnection.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmVpnConnection.md deleted file mode 100644 index 6902d48c42..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVpnConnection.md +++ /dev/null @@ -1,366 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermvpnconnection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVpnConnection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVpnConnection.md ---- - -# New-AzureRmVpnConnection - -## SYNOPSIS -Creates a IPSec connection that connects a VpnGateway to a remote customer branch represented in RM as a VpnSite. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVpnGatewayNameByVpnSiteObject (Default) -``` -New-AzureRmVpnConnection -ResourceGroupName <String> -ParentResourceName <String> -Name <String> - -VpnSite <PSVpnSite> [-SharedKey <SecureString>] [-ConnectionBandwidthInMbps <UInt32>] - [-IpSecPolicy <PSIpsecPolicy>] [-VpnConnectionProtocolType <String>] [-EnableBgp] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByVpnGatewayNameByVpnSiteResourceId -``` -New-AzureRmVpnConnection -ResourceGroupName <String> -ParentResourceName <String> -Name <String> - -VpnSiteId <String> [-SharedKey <SecureString>] [-ConnectionBandwidthInMbps <UInt32>] - [-IpSecPolicy <PSIpsecPolicy>] [-VpnConnectionProtocolType <String>] [-EnableBgp] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByVpnGatewayObjectByVpnSiteObject -``` -New-AzureRmVpnConnection -ParentObject <PSVpnGateway> -Name <String> -VpnSite <PSVpnSite> - [-SharedKey <SecureString>] [-ConnectionBandwidthInMbps <UInt32>] [-IpSecPolicy <PSIpsecPolicy>] - [-VpnConnectionProtocolType <String>] [-EnableBgp] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByVpnGatewayObjectByVpnSiteResourceId -``` -New-AzureRmVpnConnection -ParentObject <PSVpnGateway> -Name <String> -VpnSiteId <String> - [-SharedKey <SecureString>] [-ConnectionBandwidthInMbps <UInt32>] [-IpSecPolicy <PSIpsecPolicy>] - [-VpnConnectionProtocolType <String>] [-EnableBgp] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByVpnGatewayResourceIdByVpnSiteObject -``` -New-AzureRmVpnConnection -ParentResourceId <String> -Name <String> -VpnSite <PSVpnSite> - [-SharedKey <SecureString>] [-ConnectionBandwidthInMbps <UInt32>] [-IpSecPolicy <PSIpsecPolicy>] - [-VpnConnectionProtocolType <String>] [-EnableBgp] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByVpnGatewayResourceIdByVpnSiteResourceId -``` -New-AzureRmVpnConnection -ParentResourceId <String> -Name <String> -VpnSiteId <String> - [-SharedKey <SecureString>] [-ConnectionBandwidthInMbps <UInt32>] [-IpSecPolicy <PSIpsecPolicy>] - [-VpnConnectionProtocolType <String>] [-EnableBgp] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Creates a IPSec connection that connects a VpnGateway to a remote customer branch represented in RM as a VpnSite. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> $virtualWan = New-AzureRmVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" -PS C:\> $virtualHub = New-AzureRmVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" -PS C:\> New-AzureRmVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -BGPPeeringWeight 10 -VpnGatewayScaleUnit 2 -PS C:\> $vpnGateway = Get-AzureRmVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -PS C:\> $vpnSiteAddressSpaces = New-Object string[] 2 -PS C:\> $vpnSiteAddressSpaces[0] = "192.168.2.0/24" -PS C:\> $vpnSiteAddressSpaces[1] = "192.168.3.0/24" -PS C:\> $vpnSite = New-AzureRmVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -Location "West US" -VirtualWan $virtualWan -IpAddress "1.2.3.4" -AddressSpace $vpnSiteAddressSpaces -DeviceModel "SomeDevice" -DeviceVendor "SomeDeviceVendor" -LinkSpeedInMbps "10" - -PS C:\> New-AzureRmVpnConnection -ResourceGroupName $vpnGateway.ResourceGroupName -ParentResourceName $vpnGateway.Name -Name "testConnection" -VpnSite $vpnSite -ConnectionBandwidth 20 - -RemoteVpnSite : Microsoft.Azure.Commands.Network.Models.PSResourceId -SharedKey : -VpnConnectionProtocolType : IKEv2 -ConnectionStatus : -EgressBytesTransferred : 0 -IngressBytesTransferred : 0 -IpsecPolicies : {} -ConnectionBandwidth : 20 -EnableBgp : False -ProvisioningState : testConnection -Name : ps9709 -Etag : W/"4580a2e2-2fab-4cff-88eb-92013a76b5a8" -Id : /subscriptions/{subscriptionId}/resourceGroups/ps9361/providers/Microsoft.Network/vpnGateways/testvpngw/vpnConnections/testConnection -``` - -The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub and a VpnSite in West US in "testRG" resource group in Azure. -A VPN gateway will be created thereafter in the Virtual Hub with 2 scale units. - -Once the gateway has been created, it is connected to the VpnSite using the New-AzureRmVpnConnection command. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionBandwidthInMbps -The bandwith that needs to be handled by this connection in mbps. - -```yaml -Type: System.UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableBgp -Enable BGP for this connection - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IpSecPolicy -The bandwith that needs to be handled by this connection in mbps. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName, VpnConnectionName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParentObject -The parent VpnGateway for this connection. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVpnGateway -Parameter Sets: ByVpnGatewayObjectByVpnSiteObject, ByVpnGatewayObjectByVpnSiteResourceId -Aliases: ParentVpnGateway, VpnGateway - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ParentResourceId -The resource id of the parent VpnGateway for this connection. - -```yaml -Type: System.String -Parameter Sets: ByVpnGatewayResourceIdByVpnSiteObject, ByVpnGatewayResourceIdByVpnSiteResourceId -Aliases: ParentVpnGatewayId, VpnGatewayId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ParentResourceName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByVpnGatewayNameByVpnSiteObject, ByVpnGatewayNameByVpnSiteResourceId -Aliases: ParentVpnGatewayName, VpnGatewayName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByVpnGatewayNameByVpnSiteObject, ByVpnGatewayNameByVpnSiteResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharedKey -The shared key required to set this connection up. - -```yaml -Type: System.Security.SecureString -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VpnConnectionProtocolType -Gateway connection protocol:IKEv1/IKEv2 - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: IKEv1, IKEv2 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VpnSite -The remote vpn site to which this hub virtual network connection is connected. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVpnSite -Parameter Sets: ByVpnGatewayNameByVpnSiteObject, ByVpnGatewayObjectByVpnSiteObject, ByVpnGatewayResourceIdByVpnSiteObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VpnSiteId -The remote vpn site to which this hub virtual network connection is connected. - -```yaml -Type: System.String -Parameter Sets: ByVpnGatewayNameByVpnSiteResourceId, ByVpnGatewayObjectByVpnSiteResourceId, ByVpnGatewayResourceIdByVpnSiteResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVpnGateway - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVpnConnection - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVpnGateway.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmVpnGateway.md deleted file mode 100644 index a38f78414e..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVpnGateway.md +++ /dev/null @@ -1,272 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermvpngateway -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVpnGateway.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVpnGateway.md ---- - -# New-AzureRmVpnGateway - -## SYNOPSIS -Creates a Scalable VPN Gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVirtualHubName (Default) -``` -New-AzureRmVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> - -VirtualHubName <String> [-VpnConnection <PSVpnConnection[]>] [-Tag <Hashtable>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByVirtualHubObject -``` -New-AzureRmVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> - -VirtualHub <PSVirtualHub> [-VpnConnection <PSVpnConnection[]>] [-Tag <Hashtable>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByVirtualHubResourceId -``` -New-AzureRmVpnGateway -ResourceGroupName <String> -Name <String> -VpnGatewayScaleUnit <UInt32> - -VirtualHubId <String> [-VpnConnection <PSVpnConnection[]>] [-Tag <Hashtable>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION - -New-AzureRmVpnGateway creates a scalable VPN Gateway. This is software defined connectivity for site to site connections inside the VirtualHub. - -This gateway resizes and scales based on the scale unit specified in this or the Set-AzureRmVpnGateway cmdlet. - -A connection is set up from a branch/Site known as VPNSite to the scalable gateway. Each connection comprises of 2 Active-Active tunnels. - -The VpnGateway will be in the same location as the referenced VirtualHub. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> $virtualWan = New-AzureRmVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" -PS C:\> $virtualHub = New-AzureRmVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" -PS C:\> New-AzureRmVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -BGPPeeringWeight 10 -VpnGatewayScaleUnit 2 - -ResourceGroupName : testRG -Name : testvpngw -Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/vpnGateways/testvpngw -Location : West US -VpnGatewayScaleUnit : 2 -VirtualHub : /subscriptions/{subscriptionId}/resourceGroups/Ali_pS_Test/providers/Microsoft.Network/virtualHubs/westushub -BgpSettings : {} -Type : Microsoft.Network/vpnGateways -ProvisioningState : Succeeded -``` - -The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub in West US in "testRG" resource group in Azure. -A VPN gateway will be created thereafter in the Virtual Hub with 2 scale units. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName, VpnGatewayName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -A hashtable which represents resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualHub -The VirtualHub this VpnGateway needs to be associated with. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub -Parameter Sets: ByVirtualHubObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VirtualHubId -The Id of the VirtualHub this VpnGateway needs to be associated with. - -```yaml -Type: System.String -Parameter Sets: ByVirtualHubResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualHubName -The Id of the VirtualHub this VpnGateway needs to be associated with. - -```yaml -Type: System.String -Parameter Sets: ByVirtualHubName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VpnConnection -The list of VpnConnections that this VpnGateway needs to have. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVpnConnection[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VpnGatewayScaleUnit -The scale unit for this VpnGateway. - -```yaml -Type: System.UInt32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualHub - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVpnGateway - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVpnSite.md b/azurermps-6.13.0/AzureRM.Network/New-AzureRmVpnSite.md deleted file mode 100644 index a8f9aaa650..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/New-AzureRmVpnSite.md +++ /dev/null @@ -1,399 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermvpnsite -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVpnSite.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/New-AzureRmVpnSite.md ---- - -# New-AzureRmVpnSite - -## SYNOPSIS -Creates a new Azure VpnSite resource. This is an RM representation of customer branches that are uploaded to Azure -for S2S connectivity with a Cortex virtual hub. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVirtualWanName (Default) -``` -New-AzureRmVpnSite -ResourceGroupName <String> -Name <String> -Location <String> - -VirtualWanResourceGroupName <String> -VirtualWanName <String> -IpAddress <String> [-AddressSpace <String[]>] - [-DeviceModel <String>] [-DeviceVendor <String>] [-LinkSpeedInMbps <UInt32>] [-BgpAsn <UInt32>] - [-BgpPeeringAddress <String>] [-BgpPeeringWeight <UInt32>] [-Tag <Hashtable>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByVirtualWanObject -``` -New-AzureRmVpnSite -ResourceGroupName <String> -Name <String> -Location <String> -VirtualWan <PSVirtualWan> - -IpAddress <String> [-AddressSpace <String[]>] [-DeviceModel <String>] [-DeviceVendor <String>] - [-LinkSpeedInMbps <UInt32>] [-BgpAsn <UInt32>] [-BgpPeeringAddress <String>] [-BgpPeeringWeight <UInt32>] - [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByVirtualWanResourceId -``` -New-AzureRmVpnSite -ResourceGroupName <String> -Name <String> -Location <String> -VirtualWanId <String> - -IpAddress <String> [-AddressSpace <String[]>] [-DeviceModel <String>] [-DeviceVendor <String>] - [-LinkSpeedInMbps <UInt32>] [-BgpAsn <UInt32>] [-BgpPeeringAddress <String>] [-BgpPeeringWeight <UInt32>] - [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Creates a new Azure VpnSite resource. This is an RM representation of customer branches that are uploaded to Azure -for S2S connectivity with a Cortex virtual hub. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> $virtualWan = New-AzureRmVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" - -PS C:\> $vpnSiteAddressSpaces = New-Object string[] 2 -PS C:\> $vpnSiteAddressSpaces[0] = "192.168.2.0/24" -PS C:\> $vpnSiteAddressSpaces[1] = "192.168.3.0/24" - -PS C:\> New-AzureRmVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -Location "West US" -VirtualWan $virtualWan -IpAddress "1.2.3.4" -AddressSpace $vpnSiteAddressSpaces -DeviceModel "SomeDevice" -DeviceVendor "SomeDeviceVendor" -LinkSpeedInMbps "10" - -ResourceGroupName : testRG -Name : testVpnSite -Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/vpnSites/testVpnSite -Location : eastus2euap -IpAddress : 1.2.3.4 -VirtualWan : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualWans/myVirtualWAN -AddressSpace : {192.168.2.0/24, 192.168.3.0/24} -BgpSettings : -Type : Microsoft.Network/vpnSites -ProvisioningState : Succeeded -``` - -The above will create a resource group, Virtual WAN in West US in "testRG" resource group in Azure. - -Then it creates a VpnSite to represent a customer branch and links it to the Virtual WAN. - -An IPSec connection can then be setup with this branch and a VpnGateway using the New-AzureRmVpnConnection command. - -## PARAMETERS - -### -AddressSpace -The address prefixes of the virtual network. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BgpAsn -The BGP ASN for this VpnSite. - -```yaml -Type: System.UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BgpPeeringAddress -The BGP Peering Address for this VpnSite. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BgpPeeringWeight -The BGP Peering weight for this VpnSite. - -```yaml -Type: System.UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeviceModel -The device model of the remote vpn device. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeviceVendor -The device vendor of the remote vpn device. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IpAddress -The IPAddress for this VpnSite. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LinkSpeedInMbps -The device model of the remote vpn device. - -```yaml -Type: System.UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The resource location. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName, VpnSiteName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -A hashtable which represents resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualWan -The VirtualWan this VpnSite needs to be connected to. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualWan -Parameter Sets: ByVirtualWanObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualWanId -The ResourceId VirtualWan this VpnSite needs to be connected to. - -```yaml -Type: System.String -Parameter Sets: ByVirtualWanResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualWanName -The name of the VirtualWan this VpnSite needs to be connected to. - -```yaml -Type: System.String -Parameter Sets: ByVirtualWanName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualWanResourceGroupName -The resource group name of the VirtualWan this VpnSite needs to be connected to. - -```yaml -Type: System.String -Parameter Sets: ByVirtualWanName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVpnSite - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGateway.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGateway.md deleted file mode 100644 index 19eaf22996..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGateway.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: E9390015-FD5C-4015-BA81-3445ADF8F8BF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationgateway -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGateway.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGateway.md ---- - -# Remove-AzureRmApplicationGateway - -## SYNOPSIS -Removes an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationGateway -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmApplicationGateway** cmdlet removes an application gateway. - -## EXAMPLES - -### Example 1: Remove a specified application gateway -``` -PS C:\>Remove-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -``` - -This command removes the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Indicates that the cmdlet forces the deletion of the application gateway regardless of whether resources are assigned to it. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the application gateway to be removed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group name that the application gateway belongs to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Set-AzureRmApplicationGateway](./Set-AzureRmApplicationGateway.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayAuthenticationCertificate.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayAuthenticationCertificate.md deleted file mode 100644 index 4e1562884c..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayAuthenticationCertificate.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 29BB24C4-1EC9-47DE-A5B8-5EEA4525AE3A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationgatewayauthenticationcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewayAuthenticationCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewayAuthenticationCertificate.md ---- - -# Remove-AzureRmApplicationGatewayAuthenticationCertificate - -## SYNOPSIS -Removes an authentication certificate from an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationGatewayAuthenticationCertificate -Name <String> - -ApplicationGateway <PSApplicationGateway> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmApplicationGatewayAuthenticationCertificate** cmdlet removes an authentication certificate from an Azure application gateway. - -## EXAMPLES - -## PARAMETERS - -### -ApplicationGateway -Specifies the name of application gateway from which this cmdlet removes an authentication certificate. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the authentication certificate that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayAuthenticationCertificate](./Add-AzureRmApplicationGatewayAuthenticationCertificate.md) - -[Get-AzureRmApplicationGatewayAuthenticationCertificate](./Get-AzureRmApplicationGatewayAuthenticationCertificate.md) - -[New-AzureRmApplicationGatewayAuthenticationCertificate](./New-AzureRmApplicationGatewayAuthenticationCertificate.md) - -[Set-AzureRmApplicationGatewayAuthenticationCertificate](./Set-AzureRmApplicationGatewayAuthenticationCertificate.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayAutoscaleConfiguration.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayAutoscaleConfiguration.md deleted file mode 100644 index f028c4ef52..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayAutoscaleConfiguration.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationgatewayautoscaleconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewayAutoscaleConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewayAutoscaleConfiguration.md ---- - -# Remove-AzureRmApplicationGatewayAutoscaleConfiguration - -## SYNOPSIS -Removes Autoscale Configuration from an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationGatewayAutoscaleConfiguration -ApplicationGateway <PSApplicationGateway> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmApplicationGatewayAutoscaleConfiguration** cmdlet removes Autoscale Configuration from an existing Application Gateway. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> $gw = Get-AzureRmApplicationGateway -Name $appgwName -ResourceGroupName $resgpName -PS C:\> $gw = Remove-AzureRmApplicationGatewayAutoscaleConfiguration -ApplicationGateway $gw -PS C:\> $gw = Set-AzureRmApplicationGateway -ApplicationGateway $gw -``` - -The first command gets the application gateway and stores it in $gw variable. -The second command removes the autoscale configuration from the applicationg gateway. -The third command updates the application gateway on Azure. - -## PARAMETERS - -### -ApplicationGateway -The applicationGateway - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayBackendAddressPool.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayBackendAddressPool.md deleted file mode 100644 index e78f04a37f..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayBackendAddressPool.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: F34C5D18-C505-4815-9DDB-C563E205515C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationgatewaybackendaddresspool -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewayBackendAddressPool.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewayBackendAddressPool.md ---- - -# Remove-AzureRmApplicationGatewayBackendAddressPool - -## SYNOPSIS -Removes a back-end address pool from an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationGatewayBackendAddressPool -Name <String> -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmApplicationGatewayBackendAddressPool** cmdlet removes a back-end address pool from an Azure application gateway. - -## EXAMPLES - -### Example 1: Remove a back-end address pool from an application gateway -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> Remove-AzureRmApplicationGatewayBackendAddressPool -ApplicationGateway $AppGw -Name "BackEndPool02" -``` - -The first command gets the application gateway named ApplicationGateway01 belonging to the resource group named ResourceGroup01 and saves it in the $AppGw variable. -The second command removes the back-end address pool named BackEndPool02 from the application gateway. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway from which this cmdlet removes a back-end address pool. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the back-end address pool that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayBackendAddressPool](./Add-AzureRmApplicationGatewayBackendAddressPool.md) - -[Get-AzureRmApplicationGatewayBackendAddressPool](./Get-AzureRmApplicationGatewayBackendAddressPool.md) - -[New-AzureRmApplicationGatewayBackendAddressPool](./New-AzureRmApplicationGatewayBackendAddressPool.md) - -[Set-AzureRmApplicationGatewayBackendAddressPool](./Set-AzureRmApplicationGatewayBackendAddressPool.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayBackendHttpSettings.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayBackendHttpSettings.md deleted file mode 100644 index d09a285547..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayBackendHttpSettings.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationgatewaybackendhttpsettings -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewayBackendHttpSettings.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewayBackendHttpSettings.md ---- - -# Remove-AzureRmApplicationGatewayBackendHttpSettings - -## SYNOPSIS -Removes back-end HTTP settings from an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationGatewayBackendHttpSettings -Name <String> -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmApplicationGatewayBackendHttpSettings cmdlet removes back-end Hypertext Transfer Protocol (HTTP) settings from an Azure application gateway. - -## EXAMPLES - -### Example 1: Remove back-end HTTP settings from an application gateway -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> Remove-AzureRmApplicationGatewayBackendHttpSettings -ApplicationGateway $AppGw -Name "BackEndSetting02" -``` - -The first command gets an application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $AppGw variable. -The second command removes the back-end HTTP setting named BackEndSetting02 from the application gateway stored in $AppGw. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway from which this cmdlet removes back-end HTTP settings. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the back-end HTTP settings that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayBackendHttpSettings]() - -[New-AzureRmApplicationGatewayBackendHttpSettings]() - -[Get-AzureRmApplicationGatewayBackendHttpSettings]() - -[Set-AzureRmApplicationGatewayBackendHttpSettings]() - diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayConnectionDraining.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayConnectionDraining.md deleted file mode 100644 index 3d92620c6a..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayConnectionDraining.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationgatewayconnectiondraining -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewayConnectionDraining.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewayConnectionDraining.md ---- - -# Remove-AzureRmApplicationGatewayConnectionDraining - -## SYNOPSIS -Removes the connection draining configuration of a back-end HTTP settings object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationGatewayConnectionDraining - -BackendHttpSettings <PSApplicationGatewayBackendHttpSettings> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmApplicationGatewayConnectionDraining** cmdlet removes the connection draining configuration of a back-end HTTP settings object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Settings = Get-AzureRmApplicationGatewayBackendHttpSettings -Name "Settings01" -ApplicationGateway $AppGw -PS C:\> Remove-AzureRmApplicationGatewayConnectionDraining -BackendHttpSettings $Settings -``` - -The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01 and stores it in the $AppGw variable. -The second command gets the back-end HTTP settings named Settings01 for $AppGw and stores the settings in the $Settings variable. -The last command removes the connection draining configuration of the back-end HTTP settings stored in $Settings. - -## PARAMETERS - -### -BackendHttpSettings -The backend http settings - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings -Parameters: BackendHttpSettings (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGateway](./Get-AzureRmApplicationGateway.md) - -[Get-AzureRmApplicationGatewayBackendHttpSettings](./Get-AzureRmApplicationGatewayBackendHttpSettings.md) - -[Get-AzureRmApplicationGatewayConnectionDraining](./Get-AzureRmApplicationGatewayConnectionDraining.md) - -[New-AzureRmApplicationGatewayConnectionDraining](./New-AzureRmApplicationGatewayConnectionDraining.md) - -[Set-AzureRmApplicationGatewayConnectionDraining](./Set-AzureRmApplicationGatewayConnectionDraining.md) - diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayCustomError.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayCustomError.md deleted file mode 100644 index f85cc802fc..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayCustomError.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationgatewaycustomerror -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewayCustomError.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewayCustomError.md ---- - -# Remove-AzureRmApplicationGatewayCustomError - -## SYNOPSIS -Removes a custom error from an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationGatewayCustomError -StatusCode <String> -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmApplicationGatewayCustomError** cmdlet removes a custom error from an application gateway. - -## EXAMPLES - -### Example 1: Removes custom error from an application gateway -``` -PS C:\> $updatedgateway = Remove-AzureRmApplicationGatewayCustomError -ApplicationGateway $appgw -StatusCode HttpStatus502 -``` - -This command removes the custom error of http status code 502 from the application gateway $appgw, and return the updated gateway. - -## PARAMETERS - -### -ApplicationGateway -The Application Gateway - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StatusCode -Status code of the application gateway customer error. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayFrontendIPConfig.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayFrontendIPConfig.md deleted file mode 100644 index 53a5ca1784..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayFrontendIPConfig.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 289B761C-1A1D-46D2-8755-B6B6A4758EFC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationgatewayfrontendipconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewayFrontendIPConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewayFrontendIPConfig.md ---- - -# Remove-AzureRmApplicationGatewayFrontendIPConfig - -## SYNOPSIS -Removes a front-end IP configuration from an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationGatewayFrontendIPConfig -Name <String> -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmApplicationGatewayFrontendIPConfig** cmdlet removes frontend IP from an Azure application gateway. - -## EXAMPLES - -### Example 1: Remove a front-end IP configuration -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> Remove-AzureRmApplicationGatewayFrontendIPConfig -ApplicationGateway $AppGw -Name "FrontEndIP02" -``` - -The first command gets an application gateway named ApplicationGateway01 and stores it in the $AppGw variable. -The second command removes the front-end IP configuration named FrontEndIP02 from the application gateway stored in $AppGw. - -## PARAMETERS - -### -ApplicationGateway -Specifies an application gateway from which to remove a front-end IP configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a front-end IP configuration to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayFrontendIPConfig](./Add-AzureRmApplicationGatewayFrontendIPConfig.md) - -[Get-AzureRmApplicationGatewayFrontendIPConfig](./Get-AzureRmApplicationGatewayFrontendIPConfig.md) - -[New-AzureRmApplicationGatewayFrontendIPConfig](./New-AzureRmApplicationGatewayFrontendIPConfig.md) - -[Set-AzureRmApplicationGatewayFrontendIPConfig](./Set-AzureRmApplicationGatewayFrontendIPConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayFrontendPort.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayFrontendPort.md deleted file mode 100644 index bb11e51eab..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayFrontendPort.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: A698954A-994E-45AD-BA36-1E03196CFCB0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationgatewayfrontendport -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewayFrontendPort.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewayFrontendPort.md ---- - -# Remove-AzureRmApplicationGatewayFrontendPort - -## SYNOPSIS -Removes a front-end port from an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationGatewayFrontendPort -Name <String> -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmApplicationGatewayFrontendPort** cmdlet removes a front-end port from an Azure application gateway. - -## EXAMPLES - -### Example: Remove a front-end port from an application gateway -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> Remove-AzureRmApplicationGatewayFrontendPort -ApplicationGateway $AppGw -Name "FrontEndPort02" -``` - -The first command gets an application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores the gateway in $AppGw variable. -The second command removes the port named FrontEndPort02 from the application gateway. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway from which to remove a front-end port. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies name of the frontend port to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayFrontendPort](./Add-AzureRmApplicationGatewayFrontendPort.md) - -[Get-AzureRmApplicationGatewayFrontendPort](./Get-AzureRmApplicationGatewayFrontendPort.md) - -[New-AzureRmApplicationGatewayFrontendPort](./New-AzureRmApplicationGatewayFrontendPort.md) - -[Set-AzureRmApplicationGatewayFrontendPort](./Set-AzureRmApplicationGatewayFrontendPort.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayHttpListener.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayHttpListener.md deleted file mode 100644 index 787dbfd7c9..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayHttpListener.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 6C90AF6C-3193-4D75-A78F-3EC315C6D7DF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationgatewayhttplistener -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewayHttpListener.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewayHttpListener.md ---- - -# Remove-AzureRmApplicationGatewayHttpListener - -## SYNOPSIS -Removes an HTTP listener from an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationGatewayHttpListener -Name <String> -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmApplicationGatewayHttpListener** cmdlet removes an HTTP listener from an Azure application gateway. - -## EXAMPLES - -### Example 1: Remove an application gateway HTTP listener -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> Remove-AzureRmApplicationGatewayHttpListener -ApplicationGateway $AppGw -Name "Listener02" -``` - -The first command gets an application gateway and stores it in the $AppGw variable. -The second command removes the HTTP listener named Listener02 from the application gateway stored in $AppGw. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway from which to remove an HTTP listener. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the HTTP listener that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayHttpListener](./Add-AzureRmApplicationGatewayHttpListener.md) - -[Get-AzureRmApplicationGatewayHttpListener](./Get-AzureRmApplicationGatewayHttpListener.md) - -[New-AzureRmApplicationGatewayHttpListener](./New-AzureRmApplicationGatewayHttpListener.md) - -[Set-AzureRmApplicationGatewayHttpListener](./Set-AzureRmApplicationGatewayHttpListener.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayHttpListenerCustomError.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayHttpListenerCustomError.md deleted file mode 100644 index 3aa725b3b8..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayHttpListenerCustomError.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationgatewayhttplistenercustomerror -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewayHttpListenerCustomError.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewayHttpListenerCustomError.md ---- - -# Remove-AzureRmApplicationGatewayHttpListenerCustomError - -## SYNOPSIS -Removes a custom error from a http listener of an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationGatewayHttpListenerCustomError -StatusCode <String> - -HttpListener <PSApplicationGatewayHttpListener> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmApplicationGatewayCustomError** cmdlet removes a custom error from a http listener of an application gateway. - -## EXAMPLES - -### Example 1: Removes custom error from a http listener -```powershell -PS C:\> $updatedlistener = Remove-AzureRmApplicationGatewayCustomError -HttpListener $listener01 -StatusCode HttpStatus502 -``` - -This command removes the custom error of http status code 502 from the http listener $listener01, and return the updated listener. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpListener -The Application Gateway Http Listener - -```yaml -Type: PSApplicationGatewayHttpListener -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -StatusCode -Status code of the application gateway customer error. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayIPConfiguration.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayIPConfiguration.md deleted file mode 100644 index 181d1d575a..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayIPConfiguration.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 6943BB5C-D709-4A80-AF5E-DC9501C20680 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationgatewayipconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewayIPConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewayIPConfiguration.md ---- - -# Remove-AzureRmApplicationGatewayIPConfiguration - -## SYNOPSIS -Removes an IP configuration from an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationGatewayIPConfiguration -Name <String> -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmApplicationGatewayIPConfiguration** cmdlet removes an IP configuration from an Azure application gateway. - -## EXAMPLES - -### Example 1: Remove an IP configuration from an Azure application gateway -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> Remove-AzureRmApplicationGatewayIPConfiguration -ApplicationGateway $AppGw -Name "Subnet02" -``` - -The first command gets an application gateway and stores it in the $AppGw variable. -The second command removes the IP configuration named Subnet02 from the application gateway stored in $AppGw. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway from which to remove an IP configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the IP configuration to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayIPConfiguration](./Add-AzureRmApplicationGatewayIPConfiguration.md) - -[Get-AzureRmApplicationGatewayIPConfiguration](./Get-AzureRmApplicationGatewayIPConfiguration.md) - -[New-AzureRmApplicationGatewayIPConfiguration](./New-AzureRmApplicationGatewayIPConfiguration.md) - -[Set-AzureRmApplicationGatewayIPConfiguration](./Set-AzureRmApplicationGatewayIPConfiguration.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayProbeConfig.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayProbeConfig.md deleted file mode 100644 index 8c80bcd539..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayProbeConfig.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationgatewayprobeconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewayProbeConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewayProbeConfig.md ---- - -# Remove-AzureRmApplicationGatewayProbeConfig - -## SYNOPSIS -Removes a health probe from an existing application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationGatewayProbeConfig -Name <String> -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmApplicationGatewayProbeConfig cmdlet removes a heath probe from an existing application gateway. - -## EXAMPLES - -### Example 1: Remove a health probe from an existing application gateway -``` -PS C:\>$Gateway = Remove-AzureRmApplicationGatewayProbeConfig -ApplicationGateway Gateway -Name "Probe04" -``` - -This command removes the health probe named Probe04 from the application gateway named Gateway. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway to which this cmdlet removes a probe. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the probe for which this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Remove a probe from an existing application gateway](https://azure.microsoft.com/en-us/documentation/articles/application-gateway-create-probe-ps/#remove-a-probe-from-an-existing-application-gateway) - -[Add-AzureRmApplicationGatewayProbeConfig]() - -[Get-AzureRmApplicationGatewayProbeConfig]() - -[New-AzureRmApplicationGatewayProbeConfig]() - -[Set-AzureRmApplicationGatewayProbeConfig]() - diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayRedirectConfiguration.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayRedirectConfiguration.md deleted file mode 100644 index 4bdd4dc92d..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayRedirectConfiguration.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationgatewayredirectconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewayRedirectConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewayRedirectConfiguration.md ---- - -# Remove-AzureRmApplicationGatewayRedirectConfiguration - -## SYNOPSIS -Removes a redirect configuration from an existing Application Gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationGatewayRedirectConfiguration -Name <String> -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmApplicationGatewayRedirectConfiguration** cmdlet removes a redirect configuration from an existing Application Gateway. - -## EXAMPLES - -### Example 1 -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\>$AppGw = Remove-AzureRmApplicationGatewayRedirectConfiguration -ApplicationGateway $AppGw -Name "Redirect01" -``` - -The first command gets an application gateway and stores it in the $AppGw variable. -The second command removes the redirect configuration named Redirect01 from the application gateway stored in $AppGw. - -## PARAMETERS - -### -ApplicationGateway -The applicationGateway - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the redirect configuration - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayRequestRoutingRule.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayRequestRoutingRule.md deleted file mode 100644 index 31c62761cc..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayRequestRoutingRule.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: CC033DA8-FACC-44E2-82F9-E30FADBF8926 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationgatewayrequestroutingrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewayRequestRoutingRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewayRequestRoutingRule.md ---- - -# Remove-AzureRmApplicationGatewayRequestRoutingRule - -## SYNOPSIS -Removes a request routing rule from an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationGatewayRequestRoutingRule -Name <String> -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmApplicationGatewayRequestRoutingRule** cmdlet removes a request routing rule from an Azure application gateway. - -## EXAMPLES - -### Example 1: Remove a request routing rule from an application gateway -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> Remove-AzureRmApplicationGatewayRequestRoutingRule -ApplicationGateway $AppGw -Name "Rule02" -``` - -The first command gets an application gateway and stores it in the $AppGw variable. -The second command removes the request routing rule named Rule02 from the application gateway stored in $AppGw. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway from which to remove a request routing rule. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the request routing rule for which this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRequestRoutingRule - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayRequestRoutingRule](./Add-AzureRmApplicationGatewayRequestRoutingRule.md) - -[Get-AzureRmApplicationGatewayRequestRoutingRule](./Get-AzureRmApplicationGatewayRequestRoutingRule.md) - -[New-AzureRmApplicationGatewayRequestRoutingRule](./New-AzureRmApplicationGatewayRequestRoutingRule.md) - -[Set-AzureRmApplicationGatewayRequestRoutingRule](./Set-AzureRmApplicationGatewayRequestRoutingRule.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewaySslCertificate.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewaySslCertificate.md deleted file mode 100644 index 06c8d4fad6..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewaySslCertificate.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 5D788B84-0179-4A35-AC35-27C6F5FECB39 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationgatewaysslcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewaySslCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewaySslCertificate.md ---- - -# Remove-AzureRmApplicationGatewaySslCertificate - -## SYNOPSIS -Removes an SSL certificate from an Azure application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationGatewaySslCertificate -Name <String> -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmApplicationGatewaySslCertificate** cmdlet removes a Secure Sockets Layer (SSL) certificate from an Azure application gateway. - -## EXAMPLES - -### Example 1: Remove an SSL certificate from an application gateway -``` -PS C:\>$AppGW = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> Remove-AzureRmApplicationGatewaySslCertificate -ApplicationGateway $AppGW -Name "Cert02" -``` - -The first command gets the application gateway named ApplicationGateway01 and stores the result in the variable named $AppGW. -The second command removes the SSL certificate named Cert02 from the application gateway stored in the $AppGW variable. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway from which this cmdlet removes an SSL certificate. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of an SSL certificate that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewaySslCertificate](./Add-AzureRmApplicationGatewaySslCertificate.md) - -[Get-AzureRmApplicationGatewaySslCertificate](./Get-AzureRmApplicationGatewaySslCertificate.md) - -[New-AzureRmApplicationGatewaySslCertificate](./New-AzureRmApplicationGatewaySslCertificate.md) - -[Set-AzureRmApplicationGatewaySslCertificate](./Set-AzureRmApplicationGatewaySslCertificate.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewaySslPolicy.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewaySslPolicy.md deleted file mode 100644 index 941ea705c0..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewaySslPolicy.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: A308E4DD-49FA-4905-94A7-CEA3AAEC3959 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationgatewaysslpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewaySslPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewaySslPolicy.md ---- - -# Remove-AzureRmApplicationGatewaySslPolicy - -## SYNOPSIS -Removes an SSL policy from an Azure application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationGatewaySslPolicy -ApplicationGateway <PSApplicationGateway> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmApplicationGatewaySslPolicy cmdlet removes SSL policy from an Azure application gateway. - -## EXAMPLES - -### Example 1: Remove an SSL policy from an application gateway -``` -PS C:\>$AppGW = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGW = Remove-AzureRmApplicationGatewaySslPolicy -ApplicationGateway $AppGW -``` - -This command removes the SSL policy from the application gateway named ApplicationGateway01. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway from which this cmdlet removes SSL policy. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Set-AzureRmApplicationGatewaySslPolicy](./Set-AzureRmApplicationGatewaySslPolicy.md) - -[New-AzureRmApplicationGatewaySslPolicy](./New-AzureRmApplicationGatewaySslPolicy.md) - -[Get-AzureRmApplicationGatewaySslPolicy](./Get-AzureRmApplicationGatewaySslPolicy.md) - diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayTrustedRootCertificate.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayTrustedRootCertificate.md deleted file mode 100644 index a953f06e30..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayTrustedRootCertificate.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationgatewaytrustedrootcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewayTrustedRootCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewayTrustedRootCertificate.md ---- - -# Remove-AzureRmApplicationGatewayTrustedRootCertificate - -## SYNOPSIS -Removes a Trusted Root Certificate from an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationGatewayTrustedRootCertificate -Name <String> - -ApplicationGateway <PSApplicationGateway> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmApplicationGatewayTrustedRootCertificate** cmdlet removes a Trusted Root Certificate from an existing Application Gateway. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> $gw = Get-AzureRmApplicationGateway -Name $appgwName -ResourceGroupName $resgpName -PS C:\> $gw = Remove-AzureRmApplicationGatewayTrustedRootCertificate -ApplicationGateway $gw -Name "myRootCA" -PS C:\> $gw = Set-AzureRmApplicationGateway -ApplicationGateway $gw -``` - -The first command gets an application gateway and stores it in the $gw variable. -The second command removes the trusted root certificate named myRootCA from the application gateway stored in $gw. -The third command updates the application gateway on Azure. - -## PARAMETERS - -### -ApplicationGateway -The applicationGateway - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the TrustedRoot certificate - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayUrlPathMapConfig.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayUrlPathMapConfig.md deleted file mode 100644 index 0d5382f1eb..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationGatewayUrlPathMapConfig.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: E43C8D2A-A6B5-4259-94B9-353FBC15F5A8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationgatewayurlpathmapconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewayUrlPathMapConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationGatewayUrlPathMapConfig.md ---- - -# Remove-AzureRmApplicationGatewayUrlPathMapConfig - -## SYNOPSIS -Removes URL path mappings to a backend server pool. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationGatewayUrlPathMapConfig -Name <String> -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmApplicationGatewayUrlPathMapConfig** cmdlet removes URL path mappings to a backend server pool. - -## EXAMPLES - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway to which this cmdlet removes URL path map configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the URL path map name that this cmdlet removes from the backend server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayUrlPathMapConfig](./Add-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[Get-AzureRmApplicationGatewayUrlPathMapConfig](./Get-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[New-AzureRmApplicationGatewayUrlPathMapConfig](./New-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[Set-AzureRmApplicationGatewayUrlPathMapConfig](./Set-AzureRmApplicationGatewayUrlPathMapConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationSecurityGroup.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationSecurityGroup.md deleted file mode 100644 index 335fc5f6f3..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmApplicationSecurityGroup.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationsecuritygroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationSecurityGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmApplicationSecurityGroup.md ---- - -# Remove-AzureRmApplicationSecurityGroup - -## SYNOPSIS -Removes an application security group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationSecurityGroup -ResourceGroupName <String> -Name <String> [-Force] [-AsJob] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmApplicationSecurityGroup** cmdlet removes an application security group. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Remove-AzureRmApplicationSecurityGroup -Name "MyApplicationSecurityGrouo" -ResourceGroupName "MyResourceGroup" -``` - -This command deletes an application security group named MyApplicationSecurityGrouo in the resource group named MyResourceGroup. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation if you want to delete resource - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the application security group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name of the application security group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[New-AzureRmApplicationSecurityGroup](./New-AzureRmApplicationSecurityGroup.md) - -[Get-AzureRmApplicationSecurityGroup](./Get-AzureRmApplicationSecurityGroup.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmDdosProtectionPlan.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmDdosProtectionPlan.md deleted file mode 100644 index 03b7b8aa99..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmDdosProtectionPlan.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azuredosprotectionplan -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmDdosProtectionPlan.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmDdosProtectionPlan.md ---- - -# Remove-AzureRmDdosProtectionPlan - -## SYNOPSIS -Removes a DDoS protection plan. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmDdosProtectionPlan -ResourceGroupName <String> -Name <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmDdosProtectionPlan cmdlet removes a DDoS protection plan. - -## EXAMPLES - -### Example 1: Remove an empty DDoS protection plan -``` -D:\> Remove-AzureRmDdosProtectionPlan -ResourceGroupName ResourceGroupName -Name DdosProtectionPlan -``` - -In this case, we remove a DDoS protection plan as specified. - -### Example 2: Remove a DDoS protection plan associated with a virtual network -``` -D:\> $vnet = Get-AzureRmVirtualNetwork -Name VnetName -ResourceGroupName ResourceGroupName -D:\> $vnet.DdosProtectionPlan = $null -D:\> $vnet.EnableDdosProtection = $false -D:\> $vnet | Set-AzureRmVirtualNetwork - - -Name : VnetName -ResourceGroupName : ResourceGroupName -Location : westus -Id : /subscriptions/d1dbd366-9871-45ac-84b7-fb318152a9e0/resourceGroups/ResourceGroupName/providers/Microsoft.Network/virtualNetworks/VnetName -Etag : W/"65947351-747e-4686-aa8b-c40da58f6c8b" -ResourceGuid : fcb7bc1e-ee0d-4005-b3f1-feda76e3756c -ProvisioningState : Succeeded -Tags : -AddressSpace : { - "AddressPrefixes": [ - "10.0.0.0/16" - ] - } -DhcpOptions : { - "DnsServers": [ - "8.8.8.8" - ] - } -Subnets : [ - { - "Name": "SubnetName", - "Etag": "W/\"65947351-747e-4686-aa8b-c40da58f6c8b\"", - "Id": "/subscriptions/d1dbd366-9871-45ac-84b7-fb318152a9e0/resourceGroups/ResourceGroupName/providers/Microsoft.Network/virtualNetworks/VnetName/subnets/SubnetName", - "AddressPrefix": "10.0.1.0/24", - "IpConfigurations": [], - "ResourceNavigationLinks": [], - "ServiceEndpoints": [], - "ProvisioningState": "Succeeded" - } - ] -VirtualNetworkPeerings : [] -EnableDdosProtection : false -DdosProtectionPlan : null -EnableVmProtection : false - - -D:\> Remove-AzureRmDdosProtectionPlan -ResourceGroupName ResourceGroupName -Name DdosProtectionPlan -``` - -DDoS protection plans cannot be deleted if they are associated with a virtual network. So the first step is to disassociate both objects. Here, we get the most updated version of the virtual network associated with the plan, and we set the property **DdosProtectionPlan** to an empty value and the flag **EnableDdosProtection** (this flag cannot be true without a plan). -Then, we persist the new state by piping the local variable into **Set-AzureRmVirtualNetwork**. At this point, the plan is no longer associated with the virtual network. -If this is the last one associated with the plan, we can remove the DDoS protection plan by using the command Remove-AzureRmDdosProtectionPlan. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the DDoS protection plan to be removed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group of the DDoS protection plan to be removed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[New-AzureRmDdosProtectionPlan](./New-AzureRmDdosProtectionPlan.md) - -[Get-AzureRmDdosProtectionPlan](./Get-AzureRmDdosProtectionPlan.md) - -[New-AzureRmVirtualNetwork](./New-AzureRmVirtualNetwork.md) - -[Set-AzureRmVirtualNetwork](./Set-AzureRmVirtualNetwork.md) - -[Get-AzureRmVirtualNetwork](./Get-AzureRmVirtualNetwork.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmDelegation.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmDelegation.md deleted file mode 100644 index 2baab3e569..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmDelegation.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermdelegation -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmDelegation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmDelegation.md ---- - -# Remove-AzureRmDelegation - -## SYNOPSIS -Removes a service delegation from the provided subnet. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmDelegation -Name <String> -Subnet <PSSubnet> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmDelegation** cmdlet takes in a Subnet with delegations and removes the named delegation from that subnet. - -## EXAMPLES - -### Example 1 -```powershell -# Add a delegation to an existing subnet -PS C:\> $vnet = Get-AzureRmVirtualNetwork -Name "myVNet" -ResourceGroupName "myResourceGroup" -PS C:\> $subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name "mySubnet" -VirtualNetwork $vnet -PS C:\> $subnet = Add-AzureRmDelegation -Name "myDelegation" -ServiceName "Microsoft.Sql/servers" -Subnet $subnet -PS C:\> Set-AzureRmVirtualNetwork $vnet - -# Remove the delegation -PS C:\> $vnet = Get-AzureRmVirtualNetwork -Name "myVNet" -ResourceGroupName "myResourceGroup" -PS C:\> $subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name "mySubnet" -VirtualNetwork $vnet -PS C:\> $subnet = Remove-AzureRmDelegation -Name "myDelegation" -Subnet $subnet -PS C:\> Set-AzureRmVirtualNetwork $vnet -``` - -In this example, the first half (found under _"Add a delegation to an existing subnet"_) is identical to [Add-AzureRmDelegation](./Add-AzureRmDelegation.md). In the second half, the first two cmdlets retrieve the subnet of interest, refreshing the local copy with what's on the server. The third cmdlet removes the delegation that was created in the first half from _mySubnet_ and stores the updated subnet in _$subnet_. The final cmdlet updates the server with the removed delegation. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the delegation - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceName -The name of the service to which the subnet should be delegated - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Subnet -The subnet from which to remove the delegation - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSSubnet -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSSubnet -### System.String -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSSubnet -## NOTES - -## RELATED LINKS - -[Add-AzureRmDelegation](./Add-AzureRmDelegation.md) -[Get-AzureRmDelegation](./Get-AzureRmDelegation.md) -[New-AzureRmDelegation](./New-AzureRmDelegation.md) -[Get-AzureRmVirtualNetwork](./Get-AzureRmVirtualNetwork.md) -[Get-AzureRmVirtualNetworkSubnetConfig](./Get-AzureRmVirtualNetworkSubnetConfig.md) -[Set-AzureRmVirtualNetwork](./Set-AzureRmVirtualNetwork.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmExpressRouteCircuit.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmExpressRouteCircuit.md deleted file mode 100644 index def39b74f7..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmExpressRouteCircuit.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: EDB94194-650C-4892-8DDC-E67D435522DD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermexpressroutecircuit -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmExpressRouteCircuit.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmExpressRouteCircuit.md ---- - -# Remove-AzureRmExpressRouteCircuit - -## SYNOPSIS -Removes an ExpressRoute circuit. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmExpressRouteCircuit -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmExpressRouteCircuit** cmdlet removes an ExpressRoute circuit. - -## EXAMPLES - -### Example 1: Delete an ExpressRoute circuit -``` -Remove-AzureRmExpressRouteCircuit -Name $CircuitName -ResourceGroupName $rg -``` - -### Example 2: Delete an ExpressRoute circuit using the pipeline -``` -Get-AzureRmExpressRouteCircuit -Name $CircuitName -ResourceGroupName $rg | Remove-AzureRmExpressRouteCircuit -``` - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the ExpressRoute circuit to be removed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. By default, this cmdlet does -not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that this ExpressRoute circuit belongs to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmExpressRouteCircuit](Get-AzureRmExpressRouteCircuit.md) - -[Move-AzureRmExpressRouteCircuit](Move-AzureRmExpressRouteCircuit.md) - -[New-AzureRmExpressRouteCircuit](New-AzureRmExpressRouteCircuit.md) - -[Set-AzureRmExpressRouteCircuit](Set-AzureRmExpressRouteCircuit.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmExpressRouteCircuitAuthorization.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmExpressRouteCircuitAuthorization.md deleted file mode 100644 index 6f05a194eb..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmExpressRouteCircuitAuthorization.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 38D57CE4-6994-4BDA-A50E-28680EF4E568 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermexpressroutecircuitauthorization -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmExpressRouteCircuitAuthorization.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmExpressRouteCircuitAuthorization.md ---- - -# Remove-AzureRmExpressRouteCircuitAuthorization - -## SYNOPSIS -Removes an existing ExpressRoute configuration authorization. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmExpressRouteCircuitAuthorization [-Name <String>] -ExpressRouteCircuit <PSExpressRouteCircuit> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmExpressRouteCircuitAuthorization** cmdlet removes an authorization assigned to -an ExpressRoute circuit. ExpressRoute circuits connect your on-premises network to Azure by using a -connectivity provider instead of the public Internet. The owner of an ExpressRoute circuit can -create as many as 10 authorizations for each circuit; these authorizations generate an -authorization key that can be used by a virtual network owner to connect his or her network to the -circuit. There can only be one authorization per virtual network. At any time, however, the circuit -owner can use **Remove-AzureRmExpressRouteCircuitAuthorization** to remove the authorization -assigned to a virtual network. When that happens the corresponding virtual network is no longer -able to use the ExpressRoute circuit to connect to Azure. - -## EXAMPLES - -### Example 1: Remove a circuit authorization from an ExpressRoute circuit -``` -$Circuit = Get-AzureRmExpressRouteCircuit -Name "ContosoCircuit" -ResourceGroupName "ContosoResourceGroup" -Remove-AzureRmExpressRouteCircuitAuthorization -Name "ContosoCircuitAuthorization" -Circuit $Circuit -Set-AzureRmExpressRouteCircuit -ExpressRouteCircuit $Circuit -``` - -This example removes a circuit authorization from an ExpressRoute circuit. The first command uses -the **Get-AzureRmExpressRouteCircuit** cmdlet to create an object reference to an ExpressRoute -circuit named ContosoCircuit and stores the result in the variable named $Circuit. -The second command marks the circuit authorization ContosoCircuitAuthorization for removal. -The third command uses the Set-AzureRmExpressRouteCircuit cmdlet to confirm the removal of the -ExpressRoute circuit stored in the $Circuit variable. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpressRouteCircuit -Specifies the ExpressRouteCircuit object that this cmdlet removes. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the circuit authorization that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit -Parameters: ExpressRouteCircuit (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit - -## NOTES - -## RELATED LINKS - -[Add-AzureRmExpressRouteCircuitAuthorization](./Add-AzureRmExpressRouteCircuitAuthorization.md) - -[Get-AzureRmExpressRouteCircuit](./Get-AzureRmExpressRouteCircuit.md) - -[Get-AzureRmExpressRouteCircuitAuthorization](./Get-AzureRmExpressRouteCircuitAuthorization.md) - -[New-AzureRmExpressRouteCircuitAuthorization](./New-AzureRmExpressRouteCircuitAuthorization.md) - -[Set-AzureRmExpressRouteCircuit](./Set-AzureRmExpressRouteCircuit.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmExpressRouteCircuitConnectionConfig.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmExpressRouteCircuitConnectionConfig.md deleted file mode 100644 index bded91a02f..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmExpressRouteCircuitConnectionConfig.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: cc944e06-4fa0-4ce5-88e9-ea6454b41d55 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermexpressroutecircuitconnectionconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmExpressRouteCircuitConnectionConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmExpressRouteCircuitConnectionConfig.md ---- - -# Remove-AzureRmExpressRouteCircuitConnectionConfig - -## SYNOPSIS -Removes an ExpressRoute circuit connection configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmExpressRouteCircuitConnectionConfig [-Name] <String> - [-ExpressRouteCircuit] <PSExpressRouteCircuit> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmExpressRouteCircuitConnectionConfig** cmdlet removes an ExpressRoute circuit -connection configuration associated with a given Express Route Circuit. - -## EXAMPLES - -### Example 1: Remove a circuit connection configuration from an ExpressRoute circuit -``` -$circuit_init = Get-AzureRmExpressRouteCircuit -Name $initiatingCircuitName -ResourceGroupName $rg -Remove-AzureRmExpressRouteCircuitConnectionConfig -Name $circuitConnectionName -ExpressRouteCircuit $circuit_init -Set-AzureRmExpressRouteCircuit -ExpressRouteCircuit $circuit_init -``` - -### Example 2: Remove a circuit connection configuration using Piping from an ExpressRoute Circuit -``` -Get-AzureRmExpressRouteCircuit -Name $initiatingCircuitName -ResourceGroupName $rg|Remove-AzureRmExpressRouteCircuitConnectionConfig -Name $circuitConnectionName|Set-AzureRmExpressRouteCircuit -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpressRouteCircuit -The ExpressRoute circuit containing the peering configuration to be removed. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the circuit connection configuration to be removed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit -Parameters: ExpressRouteCircuit (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit - -## NOTES - -## RELATED LINKS - -[Get-AzureRmExpressRouteCircuit](Get-AzureRmExpressRouteCircuit.md) - -[Get-AzureRmExpressRouteCircuitConnectionConfig](Get-AzureRmExpressRouteCircuitConnectionConfig.md) - -[Add-AzureRmExpressRouteCircuitConnectionConfig](Add-AzureRmExpressRouteCircuitConnectionConfig.md) - - - - - -[Set-AzureRmExpressRouteCircuit](Set-AzureRmExpressRouteCircuit.md) - -[Get-AzureRmExpressRouteCircuit](Get-AzureRmExpressRouteCircuit.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmExpressRouteCircuitPeeringConfig.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmExpressRouteCircuitPeeringConfig.md deleted file mode 100644 index 046ab1e93b..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmExpressRouteCircuitPeeringConfig.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 462F3EF7-4C15-41F8-853D-CDCC8E67673D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermexpressroutecircuitpeeringconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmExpressRouteCircuitPeeringConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmExpressRouteCircuitPeeringConfig.md ---- - -# Remove-AzureRmExpressRouteCircuitPeeringConfig - -## SYNOPSIS -Removes an ExpressRoute circuit peering configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmExpressRouteCircuitPeeringConfig [-Name <String>] -ExpressRouteCircuit <PSExpressRouteCircuit> - [-PeerAddressType <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmExpressRouteCircuitPeeringConfig** cmdlet removes an ExpressRoute circuit -peering configuration. - -## EXAMPLES - -### Example 1: Remove a peering configuration from an ExpressRoute circuit -``` -$circuit = Get-AzureRmExpressRouteCircuit -Name $CircuitName -ResourceGroupName $rg -Remove-AzureRmExpressRouteCircuitPeeringConfig -Name 'AzurePrivatePeering' -ExpressRouteCircuit $circuit -Set-AzureRmExpressRouteCircuit -ExpressRouteCircuit $circuit -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpressRouteCircuit -The ExpressRoute circuit containing the peering configuration to be removed. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the peering configuration to be removed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PeerAddressType -The Address family of the peering - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: IPv4, IPv6, All - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit -Parameters: ExpressRouteCircuit (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit - -## NOTES - -## RELATED LINKS - -[Add-AzureRmExpressRouteCircuitPeeringConfig](Add-AzureRmExpressRouteCircuitPeeringConfig.md) - -[Get-AzureRmExpressRouteCircuit](Get-AzureRmExpressRouteCircuit.md) - -[New-AzureRmExpressRouteCircuitPeeringConfig](New-AzureRmExpressRouteCircuitPeeringConfig.md) - -[Set-AzureRmExpressRouteCircuit](Set-AzureRmExpressRouteCircuit.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmExpressRoutePort.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmExpressRoutePort.md deleted file mode 100644 index b85acda07b..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmExpressRoutePort.md +++ /dev/null @@ -1,230 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermexpressrouteport -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmExpressRoutePort.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmExpressRoutePort.md ---- - -# Remove-AzureRmExpressRoutePort - -## SYNOPSIS -Removes an ExpressRoutePort. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceNameParameterSet (Default) -``` -Remove-AzureRmExpressRoutePort -ResourceGroupName <String> -Name <String> [-Force] [-AsJob] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectParameterSet -``` -Remove-AzureRmExpressRoutePort -InputObject <PSExpressRoutePort> [-Force] [-AsJob] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Remove-AzureRmExpressRoutePort -ResourceId <String> [-Force] [-AsJob] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmExpressRoutePort** cmdlet removes an ExpressRoutePort. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-AzureRmExpressRoutePort -Name $PortName -ResourceGroupName $rg -``` - -Removes $PortName ExpressRoutePort resource in $rg resource group in your subscription. - -### Example 2 -```powershell -PS C:\> Remove-AzureRmExpressRoutePort -InputObject $erPort -``` -Removes the ExpressRoutePort resource in InputObject. - -### Example 3 -```powershell -PS C:\> Remove-AzureRmExpressRoutePort -Name $ResourceId $id -``` - -Removes the ExpressRoutePort resource with ResourceId $id. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation if you want to delete resource - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The express route port object - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the ExpressRoutePort. - -```yaml -Type: System.String -Parameter Sets: ResourceNameParameterSet -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. By default, this cmdlet does -not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name of the ExpressRoutePort. - -```yaml -Type: System.String -Parameter Sets: ResourceNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -ResourceId of the express route port. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmFirewall.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmFirewall.md deleted file mode 100644 index 82f4f974b5..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmFirewall.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 9DBD5ADF-C30E-4D1A-A4CB-4D70C21088F3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermfirewall -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmFirewall.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmFirewall.md ---- - -# Remove-AzureRmFirewall - -## SYNOPSIS -Remove a Firewall. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmFirewall -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmFirewall** cmdlet removes an Azure Firewall. - -## EXAMPLES - -### 1: Create and delete a Firewall -``` -New-AzureRmFirewall -Name "azFw" -ResourceGroupName "rgName" -Location centralus - -Remove-AzureRmFirewall -Name "azFw" -ResourceGroupName "rgName" -Confirm -Are you sure you want to remove resource 'azFw' -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y -``` - -This example creates a Firewall and then deletes it. To suppress the prompt when deleting the Firewall, use the -Force flag. - -### 2: Deallocate the Firewall, then delete the Firewall -``` -$firewall=Get-AzureRmFirewall -ResourceGroupName rgName -Name azFw -$firewall.Deallocate() -Remove-AzureRmFirewall -ResourceGroupName rgName -Name azFw -Confirm -Are you sure you want to remove resource 'azFw' -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y -``` - -This example retrieves a Firewall, deallocates the firewall, and then deletes the firewall. The Deallocate command removes the running -service but preserves the firewall's configuration. If user wants to start the service again, the Allocate method should be called on the firewall. -To suppress the prompt when deleting the Firewall, use the -Force flag. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the firewall that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the firewall that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSAzureFirewall -Type 'PSAzureFirewall' is accepted from the pipeline - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmFirewall](./Get-AzureRmFirewall.md) - -[New-AzureRmFirewall](./New-AzureRmFirewall.md) - -[Set-AzureRmFirewall](./Set-AzureRmFirewall.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLoadBalancer.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLoadBalancer.md deleted file mode 100644 index b89a356953..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLoadBalancer.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 31B0FBEF-366A-41AF-9182-2EB087019F36 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermloadbalancer -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmLoadBalancer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmLoadBalancer.md ---- - -# Remove-AzureRmLoadBalancer - -## SYNOPSIS -Removes a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmLoadBalancer -ResourceGroupName <String> -Name <String> [-Force] [-AsJob] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmLoadBalancer** cmdlet removes an Azure load balancer. - -## EXAMPLES - -### Example 1: Remove a load balancer -``` -PS C:\>Remove-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -``` - -This command deletes a load balancer named MyLoadBalancer in the resource group named MyResourceGroup. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Indicates that this cmdlet removes the load balancer regardless of whether resources are assigned to it. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the load balancer to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the load balancer to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[New-AzureRmLoadBalancer](./New-AzureRmLoadBalancer.md) - -[Set-AzureRmLoadBalancer](./Set-AzureRmLoadBalancer.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLoadBalancerBackendAddressPoolConfig.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLoadBalancerBackendAddressPoolConfig.md deleted file mode 100644 index 4677e84ea2..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLoadBalancerBackendAddressPoolConfig.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: F965A9DE-645C-471B-84E8-58D648B1CA57 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermloadbalancerbackendaddresspoolconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmLoadBalancerBackendAddressPoolConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmLoadBalancerBackendAddressPoolConfig.md ---- - -# Remove-AzureRmLoadBalancerBackendAddressPoolConfig - -## SYNOPSIS -Removes a backend address pool configuration from a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmLoadBalancerBackendAddressPoolConfig -LoadBalancer <PSLoadBalancer> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmLoadBalancerBackendAddressPoolConfig** cmdlet removes a backend address pool from a load balancer. - -## EXAMPLES - -### Example 1: Remove a backend address pool configuration from a load balancer -``` -PS C:\>Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" | Remove-AzureRmLoadBalancerBackendAddressPoolConfig -Name "BackendAddressPool02" | Set-AzureRmLoadBalancer -``` - -This command gets the load balancer named MyLoadBalancer and passes it to **Remove-AzureRmLoadBalancerBackendAddressPoolConfig**, which removes the BackendAddressPool02 configuration from MyLoadBalancer. -Finally, the Set-AzureRmLoadBalancer cmdlet updates MyLoadBalancer. -Note that a backend address pool configuration must exist before you can delete it. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancer -Specifies the load balancer that contains the backend address pool to remove. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the backend address pool that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameters: LoadBalancer (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerBackendAddressPoolConfig](./Add-AzureRmLoadBalancerBackendAddressPoolConfig.md) - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[Get-AzureRmLoadBalancerBackendAddressPoolConfig](./Get-AzureRmLoadBalancerBackendAddressPoolConfig.md) - -[New-AzureRmLoadBalancerBackendAddressPoolConfig](./New-AzureRmLoadBalancerBackendAddressPoolConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLoadBalancerFrontendIpConfig.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLoadBalancerFrontendIpConfig.md deleted file mode 100644 index 7ee1be4e29..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLoadBalancerFrontendIpConfig.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 5F8E11DF-D560-44D7-99CA-C425951A56D6 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermloadbalancerfrontendipconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmLoadBalancerFrontendIpConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmLoadBalancerFrontendIpConfig.md ---- - -# Remove-AzureRmLoadBalancerFrontendIpConfig - -## SYNOPSIS -Removes a front-end IP configuration from a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmLoadBalancerFrontendIpConfig -LoadBalancer <PSLoadBalancer> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmLoadBalancerFrontendIpConfig** cmdlet removes a front-end IP configuration from an Azure load balancer. - -## EXAMPLES - -### Example 1: Remove a front-end IP configuration from a load balancer -``` -PS C:\>$loadbalancer = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -PS C:> Remove-AzureRmLoadBalancerFrontendIpConfig -Name "frontendName" -LoadBalancer $loadbalancer -``` - -The first command gets the load balancer that is associated with the front-end IP configuration you want to remove, and then stores it in the $loadbalancer variable. -The second command removes the associated frontend IP configuration from the load balancer in $loadbalancer. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancer -Specifies the load balancer that contains the front-end IP configuration to remove. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the front-end IP address configuration to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameters: LoadBalancer (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerFrontendIpConfig](./Add-AzureRmLoadBalancerFrontendIpConfig.md) - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[Get-AzureRmLoadBalancerFrontendIpConfig](./Get-AzureRmLoadBalancerFrontendIpConfig.md) - -[New-AzureRmLoadBalancerFrontendIpConfig](./New-AzureRmLoadBalancerFrontendIpConfig.md) - -[Set-AzureRmLoadBalancerFrontendIpConfig](./Set-AzureRmLoadBalancerFrontendIpConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLoadBalancerInboundNatPoolConfig.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLoadBalancerInboundNatPoolConfig.md deleted file mode 100644 index 694767a8b5..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLoadBalancerInboundNatPoolConfig.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 98D2EB70-440F-45C4-A79A-EB87BBDC6256 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermloadbalancerinboundnatpoolconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmLoadBalancerInboundNatPoolConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmLoadBalancerInboundNatPoolConfig.md ---- - -# Remove-AzureRmLoadBalancerInboundNatPoolConfig - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmLoadBalancerInboundNatPoolConfig -LoadBalancer <PSLoadBalancer> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION - -## EXAMPLES - -### 1: Remove -``` -PS C:\> $slb = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -PS C:\> Remove-AzureRmLoadBalancerInboundNatPoolConfig -Name myinboundnatpool -LoadBalancer $slb -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancer -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameters: LoadBalancer (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLoadBalancerInboundNatRuleConfig.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLoadBalancerInboundNatRuleConfig.md deleted file mode 100644 index 1f34a8b611..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLoadBalancerInboundNatRuleConfig.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: D818C404-60E4-42DB-AADF-063305D9541B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermloadbalancerinboundnatruleconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmLoadBalancerInboundNatRuleConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmLoadBalancerInboundNatRuleConfig.md ---- - -# Remove-AzureRmLoadBalancerInboundNatRuleConfig - -## SYNOPSIS -Removes an inbound NAT rule configuration from a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmLoadBalancerInboundNatRuleConfig -LoadBalancer <PSLoadBalancer> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmLoadBalancerInboundNatRuleConfig** cmdlet removes an inbound network address translation (NAT) rule configuration from an Azure load balancer. - -## EXAMPLES - -### 1: Delete an inbound NAT rule from an Azure load balancer -``` -$loadbalancer = Get-AzureRmLoadBalancer -Name mylb -ResourceGroupName myrg - - Remove-AzureRmLoadBalancerInboundNatRuleConfig -Name "myinboundnatrule" -LoadBalancer $loadbalancer -``` - -The first command loads an already existing load balancer called "mylb" and stores it in the variable $load - balancer. The second command removes the inbound NAT rule associated with this load balancer. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancer -Specifies the **LoadBalancer** object that contains the inbound NAT rule configuration that this cmdlet removes. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the inbound NAT rule configuration that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameters: LoadBalancer (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerInboundNatRuleConfig](./Add-AzureRmLoadBalancerInboundNatRuleConfig.md) - -[Get-AzureRmLoadBalancerInboundNatRuleConfig](./Get-AzureRmLoadBalancerInboundNatRuleConfig.md) - -[New-AzureRmLoadBalancerInboundNatRuleConfig](./New-AzureRmLoadBalancerInboundNatRuleConfig.md) - -[Set-AzureRmLoadBalancerInboundNatRuleConfig](./Set-AzureRmLoadBalancerInboundNatRuleConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLoadBalancerOutboundRuleConfig.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLoadBalancerOutboundRuleConfig.md deleted file mode 100644 index 545b349500..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLoadBalancerOutboundRuleConfig.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermloadbalanceroutboundruleconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmLoadBalancerOutboundRuleConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmLoadBalancerOutboundRuleConfig.md ---- - -# Remove-AzureRmLoadBalancerOutboundRuleConfig - -## SYNOPSIS -Removes an outbound rule configuration from a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmLoadBalancerOutboundRuleConfig -LoadBalancer <PSLoadBalancer> -Name <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmLoadBalancerOutboundRuleConfig** cmdlet removes an outbound rule configuration from an Azure load balancer. - -## EXAMPLES - -### Example 1: Delete an outbound rule from an Azure load balancer -```powershell -PS C:\>$slb = Get-AzureRmLoadBalancer -ResourceGroupName "MyResourceGroup" -Name "MyLoadBalancer" -PS C:\>Remove-AzureRmLoadBalancerOutboundRuleConfig -Name "RuleName" -LoadBalancer $slb -PS C:\>Set-AzureRmLoadBalancer -LoadBalancer $slb -``` - -The first command gets the load balancer that is associated with the outbound rule configuration you want to remove, and then stores it in the $slb variable. -The second command removes the associated outbound rule configuration from the load balancer. -The third command updates the load balancer. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancer -The reference of the load balancer resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -The Name of outbound rule - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLoadBalancerProbeConfig.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLoadBalancerProbeConfig.md deleted file mode 100644 index 910412a436..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLoadBalancerProbeConfig.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 2B15B224-E36C-454B-B6C2-F2BE032AE962 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermloadbalancerprobeconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmLoadBalancerProbeConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmLoadBalancerProbeConfig.md ---- - -# Remove-AzureRmLoadBalancerProbeConfig - -## SYNOPSIS -Removes a probe configuration from a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmLoadBalancerProbeConfig -LoadBalancer <PSLoadBalancer> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmLoadBalancerProbeConfig** cmdlet removes a probe configuration from a load balancer. - -## EXAMPLES - -### Example 1: Remove a probe configuration from a load balancer -``` -PS C:\>$loadbalancer = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -PS C:> Remove-AzureRmLoadBalancerProbeConfig -Name "MyProbe" -LoadBalancer $loadbalancer -``` - -The first command gets the load balancer named MyLoadBalancer, and then stores it in the $loadbalancer variable. -The second command deletes the configuration named MyProbe from the load balancer in $loadbalancer. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancer -Specifies the load balancer that contains the probe configuration that this cmdlet removes. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the probe configuration that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameters: LoadBalancer (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerProbeConfig](./Add-AzureRmLoadBalancerProbeConfig.md) - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[Get-AzureRmLoadBalancerProbeConfig](./Get-AzureRmLoadBalancerProbeConfig.md) - -[New-AzureRmLoadBalancerProbeConfig](./New-AzureRmLoadBalancerProbeConfig.md) - -[Set-AzureRmLoadBalancerProbeConfig](./Set-AzureRmLoadBalancerProbeConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLoadBalancerRuleConfig.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLoadBalancerRuleConfig.md deleted file mode 100644 index 134c1ba7f6..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLoadBalancerRuleConfig.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: DEBD58A3-AFAF-485C-8708-53228625138F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermloadbalancerruleconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmLoadBalancerRuleConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmLoadBalancerRuleConfig.md ---- - -# Remove-AzureRmLoadBalancerRuleConfig - -## SYNOPSIS -Removes a rule configuration for a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmLoadBalancerRuleConfig -LoadBalancer <PSLoadBalancer> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmLoadBalancerRuleConfig** cmdlet removes a rule configuration for an Azure load balancer. - -## EXAMPLES - -### Example 1: Remove a rule configuration from a load balancer -``` -PS C:\>$loadbalancer = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -PS C:> Remove-AzureRmLoadBalancerRuleConfig -Name "MyLBruleName" -LoadBalancer $loadbalancer -``` - -The first command gets the load balancer named MyLoadBalancer, and then stores it in the $loadbalancer variable. -The second command removes the rule configuration named MyLBruleName from the load balancer in $loadbalancer. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancer -Specifies the **LoadBalancer** object that contains the rule configuration that this cmdlet removes. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the load balancer rule configuration that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameters: LoadBalancer (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerRuleConfig](./Add-AzureRmLoadBalancerRuleConfig.md) - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[Get-AzureRmLoadBalancerRuleConfig](./Get-AzureRmLoadBalancerRuleConfig.md) - -[New-AzureRmLoadBalancerRuleConfig](./New-AzureRmLoadBalancerRuleConfig.md) - -[Set-AzureRmLoadBalancerRuleConfig](./Set-AzureRmLoadBalancerRuleConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLocalNetworkGateway.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLocalNetworkGateway.md deleted file mode 100644 index e894480c4a..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmLocalNetworkGateway.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 75E30205-97AD-44E3-A61F-62B81ADB532C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermlocalnetworkgateway -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmLocalNetworkGateway.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmLocalNetworkGateway.md ---- - -# Remove-AzureRmLocalNetworkGateway - -## SYNOPSIS -Deletes a Local Network Gateway - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmLocalNetworkGateway -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Local Network Gateway is the object representing your VPN device On-Premises. -The **Remove-AzureRmLocalNetworkGateway** cmdlet deletes the object representing your on-prem gateway based on Name and Resource Group Name. - -## EXAMPLES - -### 1: Delete a Local Network Gateway -``` -Remove-AzureRmLocalNetworkGateway -Name myLocalGW -ResourceGroupName myRG -``` - -Deletes the object of the Local Network Gateway with the name "myLocalGW" within the resource group "myRG" -Note: You must first delete all connections to the Local Network Gateway using the **Remove-AzureRmVirtualNetworkGatewayConnection** cmdlet. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the local network gateway that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the local network gateway. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLocalNetworkGateway](./Get-AzureRmLocalNetworkGateway.md) - -[New-AzureRmLocalNetworkGateway](./New-AzureRmLocalNetworkGateway.md) - -[Set-AzureRmLocalNetworkGateway](./Set-AzureRmLocalNetworkGateway.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkInterface.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkInterface.md deleted file mode 100644 index 4b52ddf238..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkInterface.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: C83A0465-45EF-4FCC-B706-D5DF819664F0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermnetworkinterface -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmNetworkInterface.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmNetworkInterface.md ---- - -# Remove-AzureRmNetworkInterface - -## SYNOPSIS -Removes a network interface. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmNetworkInterface -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmNetworkInterface** cmdlet removes an Azure network interface. - -## EXAMPLES - -### Example 1: Remove a network interface -``` -PS C:\>Remove-AzureRmNetworkInterface -Name "NetworkInterface1" -ResourceGroup "ResourceGroup1" -``` - -This command removes the network interface NetworkInterface1 in resource group ResourceGroup1. -Because the *Force* parameter is not used, the user will be prompted to confirm this action. - -### Example 2: Remove a network interface -``` -PS C:\>Get-AzureRmNetworkInterface -ResourceGroupName "ResourceGroup1" | Remove-AzureRmNetworkInterface -Force -``` - -This command removes all network interfaces in resource group ResourceGroup1. -Because the *Force* parameter is used, the user is not prompted for confirmation. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network interface that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group that contains the network interface that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmNetworkInterface](./Get-AzureRmNetworkInterface.md) - -[New-AzureRmNetworkInterface](./New-AzureRmNetworkInterface.md) - -[Set-AzureRmNetworkInterface](./Set-AzureRmNetworkInterface.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkInterfaceIpConfig.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkInterfaceIpConfig.md deleted file mode 100644 index 60a5567357..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkInterfaceIpConfig.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 015C7DB7-2B08-4033-9B6E-1738D4DDACDA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermnetworkinterfaceipconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmNetworkInterfaceIpConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmNetworkInterfaceIpConfig.md ---- - -# Remove-AzureRmNetworkInterfaceIpConfig - -## SYNOPSIS -Removes a network interface IP configuration from a network interface. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmNetworkInterfaceIpConfig -Name <String> -NetworkInterface <PSNetworkInterface> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmNetworkInterfaceIpConfig** cmdlet removes a network interface IP configuration from an Azure network interface. - -## EXAMPLES - -### 1: Delete an IP configuration from a network interface -``` -$nic = Get-AzureRmNetworkInterface -Name mynic -ResourceGroupName myrg - -Remove-AzureRmNetworkInterfaceIpConfig -Name IPConfig-1 -NetworkInterface $nic -``` - -The first command gets a network interface called mynic and stores it in the variable $nic. The second command - removes the IP configuration called IPConfig-1 associated with this network interface. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network interface IP configuration to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkInterface -Specifies a **NetworkInterface** object. -This object contains the network interface IP configuration to remove. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkInterface -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface -Parameters: NetworkInterface (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Add-AzureRmNetworkInterfaceIpConfig](./Add-AzureRmNetworkInterfaceIpConfig.md) - -[Get-AzureRmNetworkInterfaceIpConfig](./Get-AzureRmNetworkInterfaceIpConfig.md) - -[New-AzureRmNetworkInterfaceIpConfig](./New-AzureRmNetworkInterfaceIpConfig.md) - -[Set-AzureRmNetworkInterfaceIpConfig](./Set-AzureRmNetworkInterfaceIpConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkInterfaceTapConfig.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkInterfaceTapConfig.md deleted file mode 100644 index fd3047800d..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkInterfaceTapConfig.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/Remove-azurermnetworkinterfacetapconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmNetworkInterfaceTapConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmNetworkInterfaceTapConfig.md ---- - -# Remove-AzureRmNetworkInterfaceTapConfig - -## SYNOPSIS -Removes a tap configuration from given network interface - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RemoveByNameParameterSet (Default) -``` -Remove-AzureRmNetworkInterfaceTapConfig -ResourceGroupName <String> -NetworkInterfaceName <String> - -Name <String> [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### DeleteByResourceIdParameterSet -``` -Remove-AzureRmNetworkInterfaceTapConfig -ResourceId <String> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### DeleteByInputObjectParameterSet -``` -Remove-AzureRmNetworkInterfaceTapConfig -InputObject <PSNetworkInterfaceTapConfiguration> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmNetworkInterfaceTapConfig** cmdlet removes an Azure tap configuration from a network interface list. - -## EXAMPLES - -### Example 1: Remove a tap configuration -``` -PS C:\>Remove-AzureRmNetworkInterfaceTapConfig -Name "TapConfiguration" -NetworkInterfaceName "NetworkInterface1" -ResourceGroup "ResourceGroup1" -``` - -This command removes the TapConfiguration from NetworkInterface1 in a resource group ResourceGroup1. -Because the *Force* parameter is not used, the user will be prompted to confirm this action. - -### Example 2: Remove a network interface -``` -PS C:\>Get-AzureRmNetworkInterfaceTapConfig -Name "TapConfiguration" -NetworkInterfaceName "NetworkInterface1" -ResourceGroup "ResourceGroup1" | Remove-AzureRmNetworkInterfaceTapConfig -Force -``` - -This command removes the TapConfiguration from NetworkInterface1 in a resource group ResourceGroup1. -Because the *Force* parameter is used, the user is not prompted for confirmation. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Reference to NetworkInterfaceTapConfig. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkInterfaceTapConfiguration -Parameter Sets: DeleteByInputObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The virtual network peering name. - -```yaml -Type: System.String -Parameter Sets: RemoveByNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkInterfaceName -The virtual network name. - -```yaml -Type: System.String -Parameter Sets: RemoveByNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: RemoveByNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -NetworkInterfaceTapConfig resource id. - -```yaml -Type: System.String -Parameter Sets: DeleteByResourceIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkProfile.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkProfile.md deleted file mode 100644 index 9c9030cead..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkProfile.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermnetworkprofile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmNetworkProfile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmNetworkProfile.md ---- - -# Remove-AzureRmNetworkProfile - -## SYNOPSIS -Removes a network profile. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RemoveByName -``` -Remove-AzureRmNetworkProfile -ResourceGroupName <String> [-Force] [-AsJob] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RemoveByNameParameterSet -``` -Remove-AzureRmNetworkProfile -Name <String> [-Force] [-AsJob] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RemoveByResourceIdParameterSet -``` -Remove-AzureRmNetworkProfile -ResourceId <String> [-Force] [-AsJob] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RemoveByInputObjectParameterSet -``` -Remove-AzureRmNetworkProfile -InputObject <PSNetworkProfile> [-Force] [-AsJob] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmNetworkProfile** cmdlet removes a network profile if no container network interfaces (as contrasted to a container network interface **configuration**) have been created. - -## EXAMPLES - -### Example 1 -```powershell -Remove-AzureRmNetworkProfile -Name np1 -ResourceGroupName rg1 -``` - -This removes the network profile with name np1 from the resource group rg1. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation if you want to delete resource - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Network profile object. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkProfile -Parameter Sets: RemoveByInputObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the network profile. - -```yaml -Type: System.String -Parameter Sets: RemoveByNameParameterSet -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name of the network profile. - -```yaml -Type: System.String -Parameter Sets: RemoveByNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource manager resource ID of the network profile. - -```yaml -Type: System.String -Parameter Sets: RemoveByResourceIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkSecurityGroup.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkSecurityGroup.md deleted file mode 100644 index 15e4f70872..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkSecurityGroup.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 01F56553-1685-43D4-89E6-DDCDF17D1E00 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermnetworksecuritygroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmNetworkSecurityGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmNetworkSecurityGroup.md ---- - -# Remove-AzureRmNetworkSecurityGroup - -## SYNOPSIS -Removes a network security group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmNetworkSecurityGroup -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmNetworkSecurityGroup** cmdlet removes an Azure network security group. - -## EXAMPLES - -### Example 1: Remove a network security group -``` -PS C:\>Remove-AzureRmNetworkSecurityGroup -Name "NSG-FrontEnd" -ResourceGroupName "TestRG" -``` - -This command removes the security group named NSG-FrontEnd in the resource group named TestRG. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network security group that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group that this cmdlet removes a network security group from. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmNetworkSecurityGroup](./Get-AzureRmNetworkSecurityGroup.md) - -[New-AzureRmNetworkSecurityGroup](./New-AzureRmNetworkSecurityGroup.md) - -[Set-AzureRmNetworkSecurityGroup](./Set-AzureRmNetworkSecurityGroup.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkSecurityRuleConfig.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkSecurityRuleConfig.md deleted file mode 100644 index 50786d22d0..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkSecurityRuleConfig.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 2E43D0D8-EF93-443B-AA8F-58C992026E95 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermnetworksecurityruleconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmNetworkSecurityRuleConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmNetworkSecurityRuleConfig.md ---- - -# Remove-AzureRmNetworkSecurityRuleConfig - -## SYNOPSIS -Removes a network security rule from a network security group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmNetworkSecurityRuleConfig [-Name <String>] -NetworkSecurityGroup <PSNetworkSecurityGroup> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmNetworkSecurityRuleConfig** cmdlet removes a network security rule configuration from an Azure network security group. - -## EXAMPLES - -### Example 1: Remove a network security rule configuration -``` -PS C:\>$rule1 = New-AzureRmNetworkSecurityRuleConfig -Name "rdp-rule" -Description "Allow RDP" -Access "Allow" -Protocol "Tcp" -Direction "Inbound" -Priority 100 -SourceAddressPrefix "Internet" -SourcePortRange * -DestinationAddressPrefix * -DestinationPortRange 3389 -PS C:\> $nsg = New-AzureRmNetworkSecurityGroup -ResourceGroupName "TestRG" -Location "westus" -Name "NSG-FrontEnd" -SecurityRules $rule1 -PS C:\> Remove-AzureRmNetworkSecurityRuleConfig -Name "rdp-rule" -NetworkSecurityGroup $nsg -``` - -The first command creates a network security rule configuration named rdp-rule, and then stores it in the $rule1 variable. -The second command creates a network security group using the rule in $rule1, and then stores the network security group in the $nsg variable. -The third command removes the network security rule configuration named rdp-rule from the network security group in $nsg. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network security rule configuration that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkSecurityGroup -Specifies a **NetworkSecurityGroup** object. -This object contains the network security rule configuration to remove. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup -Parameters: NetworkSecurityGroup (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup - -## NOTES - -## RELATED LINKS - -[Add-AzureRmNetworkSecurityRuleConfig](./Add-AzureRmNetworkSecurityRuleConfig.md) - -[Get-AzureRmNetworkSecurityRuleConfig](./Get-AzureRmNetworkSecurityRuleConfig.md) - -[New-AzureRmNetworkSecurityGroup](./New-AzureRmNetworkSecurityGroup.md) - -[New-AzureRmNetworkSecurityRuleConfig](./New-AzureRmNetworkSecurityRuleConfig.md) - -[Set-AzureRmNetworkSecurityRuleConfig](./Set-AzureRmNetworkSecurityRuleConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkWatcher.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkWatcher.md deleted file mode 100644 index dc391802be..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkWatcher.md +++ /dev/null @@ -1,262 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermnetworkwatcher -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmNetworkWatcher.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmNetworkWatcher.md ---- - -# Remove-AzureRmNetworkWatcher - -## SYNOPSIS -Removes a Network Watcher. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource -``` -Remove-AzureRmNetworkWatcher -NetworkWatcher <PSNetworkWatcher> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByName -``` -Remove-AzureRmNetworkWatcher -Name <String> -ResourceGroupName <String> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByLocation -``` -Remove-AzureRmNetworkWatcher -Location <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmNetworkWatcher cmdlet removes a Network Watcher resource. - -## EXAMPLES - -### Example 1: Create and delete a Network Watcher -``` -New-AzureRmResourceGroup -Name NetworkWatcherRG -Location westcentralus -New-AzureRmNetworkWatcher -Name NetworkWatcher_westcentralus -ResourceGroup NetworkWatcherRG -Location westcentralus -Remove-AzureRmNetworkWatcher -Name NetworkWatcher_westcentralus -ResourceGroup NetworkWatcherRG -``` - -This example creates a Network Watcher in a resource group and then immediately deletes it. Note that only one Network Watcher can be created per region per subscription. -To suppress the prompt when deleting the virtual network, use the -Force flag. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Location of the network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByLocation -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameters: NetworkWatcher (ByValue) - -### System.String -Parameters: Name (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher - -## RELATED LINKS - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmNetworkWatcherProtocolConfiguration](./New-AzureRmNetworkWatcherProtocolConfiguration.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Test-AzureRmNetworkWatcherConnectivity](./Test-AzureRmNetworkWatcherConnectivity.md) - -[Stop-AzureRmNetworkWatcherConnectionMonitor](./Stop-AzureRmNetworkWatcherConnectionMonitor.md) - -[Start-AzureRmNetworkWatcherConnectionMonitor](./Start-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConnectionMonitor](./Set-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConfigFlowLog](./Set-AzureRmNetworkWatcherConfigFlowLog.md) - -[Remove-AzureRmNetworkWatcherConnectionMonitor](./Remove-AzureRmNetworkWatcherConnectionMonitor.md) - -[New-AzureRmNetworkWatcherConnectionMonitor](./New-AzureRmNetworkWatcherConnectionMonitor.md) - -[Get-AzureRmNetworkWatcherTroubleshootingResult](./Get-AzureRmNetworkWatcherTroubleshootingResult.md) - -[Get-AzureRMNetworkWatcherReachabilityReport](./Get-AzureRMNetworkWatcherReachabilityReport.md) - -[Get-AzureRmNetworkWatcherReachabilityProvidersList](./Get-AzureRmNetworkWatcherReachabilityProvidersList.md) - -[Get-AzureRmNetworkWatcherFlowLogStatus](./Get-AzureRmNetworkWatcherFlowLogStatus.md) - -[Get-AzureRmNetworkWatcherConnectionMonitorReport](./Get-AzureRmNetworkWatcherConnectionMonitorReport.md) - -[Get-AzureRmNetworkWatcherConnectionMonitor](./Get-AzureRmNetworkWatcherConnectionMonitor.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkWatcherConnectionMonitor.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkWatcherConnectionMonitor.md deleted file mode 100644 index 7e94709858..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkWatcherConnectionMonitor.md +++ /dev/null @@ -1,319 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermnetworkwatcher -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmNetworkWatcherConnectionMonitor.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmNetworkWatcherConnectionMonitor.md ---- - -# Remove-AzureRmNetworkWatcherConnectionMonitor - -## SYNOPSIS -Remove connection monitor. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByName (Default) -``` -Remove-AzureRmNetworkWatcherConnectionMonitor -NetworkWatcherName <String> -ResourceGroupName <String> - -Name <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### SetByResource -``` -Remove-AzureRmNetworkWatcherConnectionMonitor -NetworkWatcher <PSNetworkWatcher> -Name <String> [-PassThru] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByLocation -``` -Remove-AzureRmNetworkWatcherConnectionMonitor -Location <String> -Name <String> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByResourceId -``` -Remove-AzureRmNetworkWatcherConnectionMonitor -ResourceId <String> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByInputObject -``` -Remove-AzureRmNetworkWatcherConnectionMonitor -InputObject <PSConnectionMonitorResult> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The remove-AzureRmNetworkWatcherConnectionMonitor cmdlet removes the specified connection monitor. - -## EXAMPLES - -### Example 1: Remove the specified connection monitor -``` -PS C:\> Remove-AzureRmNetworkWatcherConnectionMonitor -Location centraluseuap -Name cm -``` - -In this example we delete the connection monitor specified by location and name. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Connection monitor object. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResult -Parameter Sets: SetByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Location -Location of the network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByLocation -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The connection monitor name. - -```yaml -Type: System.String -Parameter Sets: SetByName, SetByResource, SetByLocation -Aliases: ConnectionMonitorName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameters: NetworkWatcher (ByValue) - -### System.String - -### Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResult -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES -Keywords: azure, azurerm, arm, resource, connectivity, management, manager, network, networking, network watcher, connection monitor - -## RELATED LINKS - -[New-AzureRmNetworkWatcher]() - -[Get-AzureRmNetworkWatcher]() - -[Remove-AzureRmNetworkWatcher]() - -[Get-AzureRmNetworkWatcherNextHop]() - -[Get-AzureRmNetworkWatcherSecurityGroupView]() - -[Get-AzureRmNetworkWatcherTopology]() - -[Get-AzureRmNetworkWatcherTroubleshootingResult]() - -[New-AzureRmNetworkWatcherPacketCapture]() - -[New-AzureRmPacketCaptureFilterConfig]() - -[Get-AzureRmNetworkWatcherPacketCapture]() - -[Remove-AzureRmNetworkWatcherPacketCapture]() - -[Stop-AzureRmNetworkWatcherPacketCapture]() - -[Get-AzureRmNetworkWatcherConnectionMonitor]() - -[Get-AzureRmNetworkWatcherConnectionMonitorReport]() - -[Remove-AzureRmNetworkWatcherConnectionMonitor]() - -[Set-AzureRmNetworkWatcherConnectionMonitor]() - -[Stop-AzureRmNetworkWatcherConnectionMonitor]() - -[New-AzureRmNetworkWatcherConnectionMonitor]() - -[New-AzureRmNetworkWatcherProtocolConfiguration]() - -[Test-AzureRmNetworkWatcherIPFlow]() - -[Test-AzureRmNetworkWatcherConnectivity]() - -[Start-AzureRmNetworkWatcherResourceTroubleshooting]() - -[Start-AzureRmNetworkWatcherConnectionMonitor]() - -[Set-AzureRmNetworkWatcherConfigFlowLog]() - -[Get-AzureRMNetworkWatcherReachabilityReport]() - -[Get-AzureRmNetworkWatcherReachabilityProvidersList]() - -[Get-AzureRmNetworkWatcherFlowLogStatus]() diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkWatcherPacketCapture.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkWatcherPacketCapture.md deleted file mode 100644 index fd9367d369..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmNetworkWatcherPacketCapture.md +++ /dev/null @@ -1,277 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermnetworkwatcherpacketcapture -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmNetworkWatcherPacketCapture.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmNetworkWatcherPacketCapture.md ---- - -# Remove-AzureRmNetworkWatcherPacketCapture - -## SYNOPSIS -Removes a packet capture resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Remove-AzureRmNetworkWatcherPacketCapture -NetworkWatcher <PSNetworkWatcher> -PacketCaptureName <String> - [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByName -``` -Remove-AzureRmNetworkWatcherPacketCapture -NetworkWatcherName <String> -ResourceGroupName <String> - -PacketCaptureName <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### SetByLocation -``` -Remove-AzureRmNetworkWatcherPacketCapture -Location <String> -PacketCaptureName <String> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmNetworkWatcherPacketCapture removes a packet capture resource. -It is recommended to call Stop-AzureRmNetworkWatcherPacketCapture before calling Remove-AzureRmNetworkWatcherPacketCapture. -If the packet capture session is running when Remove-AzureRmNetworkWatcherPacketCapture is called the packet capture may not be saved. If the session is stopped prior to removal the .cap file containing capture data is not removed. - -## EXAMPLES - -### Example 1: Remove a packet capture session -``` -Remove-AzureRmNetworkWatcherPacketCapture -NetworkWatcher $networkWatcher -PacketCaptureName "PacketCaptureTest" -``` - -In this example we remove an existing packet capture session named "PacketCaptureTest". - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Location of the network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByLocation -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PacketCaptureName -The packet capture name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameters: NetworkWatcher (ByValue) - -### System.String -Parameters: NetworkWatcherName (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, packet, capture, traffic, remove - -## RELATED LINKS - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmNetworkWatcherProtocolConfiguration](./New-AzureRmNetworkWatcherProtocolConfiguration.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Test-AzureRmNetworkWatcherConnectivity](./Test-AzureRmNetworkWatcherConnectivity.md) - -[Stop-AzureRmNetworkWatcherConnectionMonitor](./Stop-AzureRmNetworkWatcherConnectionMonitor.md) - -[Start-AzureRmNetworkWatcherConnectionMonitor](./Start-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConnectionMonitor](./Set-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConfigFlowLog](./Set-AzureRmNetworkWatcherConfigFlowLog.md) - -[Remove-AzureRmNetworkWatcherConnectionMonitor](./Remove-AzureRmNetworkWatcherConnectionMonitor.md) - -[New-AzureRmNetworkWatcherConnectionMonitor](./New-AzureRmNetworkWatcherConnectionMonitor.md) - -[Get-AzureRmNetworkWatcherTroubleshootingResult](./Get-AzureRmNetworkWatcherTroubleshootingResult.md) - -[Get-AzureRMNetworkWatcherReachabilityReport](./Get-AzureRMNetworkWatcherReachabilityReport.md) - -[Get-AzureRmNetworkWatcherReachabilityProvidersList](./Get-AzureRmNetworkWatcherReachabilityProvidersList.md) - -[Get-AzureRmNetworkWatcherFlowLogStatus](./Get-AzureRmNetworkWatcherFlowLogStatus.md) - -[Get-AzureRmNetworkWatcherConnectionMonitorReport](./Get-AzureRmNetworkWatcherConnectionMonitorReport.md) - -[Get-AzureRmNetworkWatcherConnectionMonitor](./Get-AzureRmNetworkWatcherConnectionMonitor.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmPublicIpAddress.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmPublicIpAddress.md deleted file mode 100644 index 16dadd4134..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmPublicIpAddress.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 00236BC2-61D8-49C2-91BE-923C567153F3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermpublicipaddress -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmPublicIpAddress.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmPublicIpAddress.md ---- - -# Remove-AzureRmPublicIpAddress - -## SYNOPSIS -Removes a public IP address. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmPublicIpAddress -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmPublicIpAddress** cmdlet removes an Azure public IP address. - -## EXAMPLES - -### 1: Remove a public IP address resource -``` -Remove-AzureRmPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName -``` - -This command removes the public IP address resource named $publicIpName in the resource group $rgName. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the public IP address that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the public IP address that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmPublicIpAddress](./Get-AzureRmPublicIpAddress.md) - -[New-AzureRmPublicIpAddress](./New-AzureRmPublicIpAddress.md) - -[Set-AzureRmPublicIpAddress](./Set-AzureRmPublicIpAddress.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmPublicIpPrefix.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmPublicIpPrefix.md deleted file mode 100644 index 11e4f7ec85..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmPublicIpPrefix.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermpublicipprefix -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmPublicIpPrefix.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmPublicIpPrefix.md ---- - -# Remove-AzureRmPublicIpPrefix - -## SYNOPSIS -Removes a public IP prefix - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RemoveByNameParameterSet -``` -Remove-AzureRmPublicIpPrefix -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### DeleteByResourceIdParameterSet -``` -Remove-AzureRmPublicIpPrefix -ResourceId <String> [-Force] [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### DeleteByInputObjectParameterSet -``` -Remove-AzureRmPublicIpPrefix -InputObject <PSPublicIpPrefix> [-Force] [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmPublicIpPrefix cmdlet removes an Azure public IP prefix as long as there are no public IP addresses allocated from it. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-AzureRmPublicIpPrefix -Name $prefixName -ResourceGroupName $rgName -``` - -Removes the public IP prefix with Name $prefixName from resource group $rgName - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -A PublicIpPrefix object - -```yaml -Type: PSPublicIpPrefix -Parameter Sets: DeleteByInputObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: String -Parameter Sets: RemoveByNameParameterSet -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: String -Parameter Sets: RemoveByNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The resourceId for the resource to remove - -```yaml -Type: String -Parameter Sets: DeleteByResourceIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Microsoft.Azure.Commands.Network.Models.PSPublicIpPrefix - - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmRouteConfig.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmRouteConfig.md deleted file mode 100644 index 731c78de74..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmRouteConfig.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 03285628-6BD3-4F2F-8129-E3CAE4C70EC8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermrouteconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmRouteConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmRouteConfig.md ---- - -# Remove-AzureRmRouteConfig - -## SYNOPSIS -Removes a route from a route table. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmRouteConfig -RouteTable <PSRouteTable> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmRouteConfig** cmdlet removes a route from an Azure route table. - -## EXAMPLES - -### Example 1: Remove a route -``` -PS C:\>Get-AzureRmRouteTable -ResourceGroupName "ResourceGroup11" -Name "RouteTable01" | Remove-AzureRmRouteConfig -Name "Route02" | Set-AzureRmRouteTable -Name : RouteTable01 -ResourceGroupName : ResourceGroup11 -Location : eastus -Id : /subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Microsoft.Networ - k/routeTables/RouteTable01 -Etag : W/"47099b62-60ec-4bc1-b87b-fad56cb8bed1" -ProvisioningState : Succeeded -Tags : -Routes : [ - { - "Name": "Route07", - "Etag": "W/\"47099b62-60ec-4bc1-b87b-fad56cb8bed1\"", - "Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro - soft.Network/routeTables/RouteTable01/routes/Route07", - "AddressPrefix": "10.1.0.0/16", - "NextHopType": "VnetLocal", - "NextHopIpAddress": null, - "ProvisioningState": "Succeeded" - } - ] -Subnets : [] -``` - -This command gets the route table named RouteTable01 by using the **Get-AzureRmRouteTable** cmdlet. -The command passes that table to the current cmdlet by using the pipeline operator. -The current cmdlet remove the route named Route02, and the passes the result to the **Set-AzureRmRouteTable** cmdlet, which updates the table to reflect your changes. -The table no longer contains the route named Route02. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the route that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteTable -Specifies the route table that contains the route that this cmdlet deletes. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSRouteTable -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteTable - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteTable - -## NOTES - -## RELATED LINKS - -[Add-AzureRmRouteConfig](./Add-AzureRmRouteConfig.md) - -[Get-AzureRmRouteConfig](./Get-AzureRmRouteConfig.md) - -[New-AzureRmRouteConfig](./New-AzureRmRouteConfig.md) - -[Set-AzureRmRouteConfig](./Set-AzureRmRouteConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmRouteFilter.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmRouteFilter.md deleted file mode 100644 index 1292d513e3..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmRouteFilter.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermroutefilter -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmRouteFilter.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmRouteFilter.md ---- - -# Remove-AzureRmRouteFilter - -## SYNOPSIS -{{Fill in the Synopsis}} - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmRouteFilter -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -{{Fill in the Description}} - -## EXAMPLES - -### Example 1 -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmRouteFilterRuleConfig.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmRouteFilterRuleConfig.md deleted file mode 100644 index 33eceb9ef7..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmRouteFilterRuleConfig.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermroutefilterruleconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmRouteFilterRuleConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmRouteFilterRuleConfig.md ---- - -# Remove-AzureRmRouteFilterRuleConfig - -## SYNOPSIS -{{Fill in the Synopsis}} - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmRouteFilterRuleConfig -Name <String> -RouteFilter <PSRouteFilter> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -{{Fill in the Description}} - -## EXAMPLES - -### Example 1 -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation if you want to overrite a resource - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the route filter rule - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteFilter -The RouteFilter - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSRouteFilter -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteFilter -Parameters: RouteFilter (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteFilterRule - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmRouteTable.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmRouteTable.md deleted file mode 100644 index 2b1dec6181..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmRouteTable.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: FDA33633-EB2E-4095-8498-DF8910F1D434 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermroutetable -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmRouteTable.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmRouteTable.md ---- - -# Remove-AzureRmRouteTable - -## SYNOPSIS -Removes a route table. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmRouteTable -ResourceGroupName <String> -Name <String> [-Force] [-AsJob] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmRouteTable** cmdlet removes an Azure route table. - -## EXAMPLES - -### Example 1: Remove a route table -``` -PS C:\>Remove-AzureRmRouteTable -ResourceGroupName "ResourceGroup11 -Name "RouteTable01" -Confirm -Are you sure you want to remove resource 'RouteTable01' -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y -``` - -This command removes the route table named RouteTable01 in the resource group named ResourceGroup11. -The cmdlet prompts you for confirmation before it removes the table. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the route table that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the route table that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRouteTable](./Get-AzureRmRouteTable.md) - -[New-AzureRmRouteTable](./New-AzureRmRouteTable.md) - -[Set-AzureRmRouteTable](./Set-AzureRmRouteTable.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmServiceEndpointPolicy.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmServiceEndpointPolicy.md deleted file mode 100644 index 5a8bef51fb..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmServiceEndpointPolicy.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermserviceendpointpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmServiceEndpointPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmServiceEndpointPolicy.md ---- - -# Remove-AzureRmServiceEndpointPolicy - -## SYNOPSIS -{{Fill in the Synopsis}} - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmServiceEndpointPolicy -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmServiceEndpointPolicy** cmdlet removes a service endpoint policy. - -## EXAMPLES - -### Example 1: Removes a service endpoint policy using name -``` -Remove-AzureRmServiceEndpointPolicy -Name "Policy1" -ResourceGroup "resourcegroup1" -``` - -This command removes a service endpoint policy with name Policy1 which belongs to resourcegroup with name "resourcegroup1" - -### Example 2: Remove a service endpoint policy using input object -``` -Remove-AzureRmServiceEndpointPolicy -InputObject $Policy1 -ResourceGroup "resourcegroup1" -``` - -This command removes a service endpoint policy object Policy1 which belongs to resourcegroup with name "resourcegroup1" - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation if you want to overrite a resource - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the service endpoint policy - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmServiceEndpointPolicyDefinition.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmServiceEndpointPolicyDefinition.md deleted file mode 100644 index acbe3447e7..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmServiceEndpointPolicyDefinition.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermserviceendpointpolicydefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmServiceEndpointPolicyDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmServiceEndpointPolicyDefinition.md ---- - -# Remove-AzureRmServiceEndpointPolicyDefinition - -## SYNOPSIS -{{Fill in the Synopsis}} - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmServiceEndpointPolicyDefinition [-Name <String>] -ServiceEndpointPolicy <PSServiceEndpointPolicy> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmServiceEndpointPolicy** cmdlet removes a service endpoint policy. - -## EXAMPLES - -### Example 1: Removes a service endpoint policy using name -``` -Remove-AzureRmServiceEndpointPolicyDefinition -Name "PolicyDef1" -``` - -This command removes a service endpoint policy with name PolicyDef1 - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the service endpoint definition - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceEndpointPolicy -The ServiceEndpointPolicy - -```yaml -Type: PSServiceEndpointPolicy -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy - - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy - - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualHub.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualHub.md deleted file mode 100644 index b7439557bf..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualHub.md +++ /dev/null @@ -1,250 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermvirtualhub -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmVirtualHub.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmVirtualHub.md ---- - -# Remove-AzureRmVirtualHub - -## SYNOPSIS -Removes an Azure VirtualHub resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVirtualHubName (Default) -``` -Remove-AzureRmVirtualHub -ResourceGroupName <String> -Name <String> [-AsJob] [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByVirtualHubResourceId -``` -Remove-AzureRmVirtualHub -ResourceId <String> [-AsJob] [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByVirtualHubObject -``` -Remove-AzureRmVirtualHub -InputObject <PSVirtualHub> [-AsJob] [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Removes an Azure VirtualHub resource. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> $virtualWan = New-AzureRmVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" -PS C:\> New-AzureRmVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" -PS C:\> Remove-AzureRmVirtualHub -ResourceGroupName "testRG" -Name "westushub" -``` - -The above will create a resource group "testRG", a Virtual WAN and a Virtual Hub in West US in that resource group in Azure. The virtual hub will have the address space "10.0.1.0/24". - -It then deletes the virtual hub using its ResourceGroupName and ResourceName. - -### Example 2 - -```powershell -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> $virtualWan = New-AzureRmVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" -PS C:\> $virtualHub = New-AzureRmVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" -PS C:\> Remove-AzureRmVirtualHub -InputObject $virtualHub -``` - -The above will create a resource group "testRG", a Virtual WAN and a Virtual Hub in West US in that resource group in Azure. The virtual hub will have the address space "10.0.1.0/24". - -It then deletes the virtual hub using an input object. The input object is of type PSVirtualHub. - -### Example 3 - -```powershell -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> $virtualWan = New-AzureRmVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" -PS C:\> New-AzureRmVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" -PS C:\> Get-AzureRmVirtualHub -ResourceGroupName "testRG" -Name "westushub" | Remove-AzureRmVirtualHub -``` - -The above will create a resource group "testRG", a Virtual WAN and a Virtual Hub in West US in that resource group in Azure. The virtual hub will have the address space "10.0.1.0/24". - -It then deletes the virtual hub using powershell piping using output from Get-AzureRmVirtualHub. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation if you want to overrite a resource - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The Virtual hub object to be modified. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub -Parameter Sets: ByVirtualHubObject -Aliases: VirtualHub - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: System.String -Parameter Sets: ByVirtualHubName -Aliases: ResourceName, VirtualHubName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByVirtualHubName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The resource id of the Virtual hub to be modified. - -```yaml -Type: System.String -Parameter Sets: ByVirtualHubResourceId -Aliases: VirtualHubId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Network.Models.PSVirtualHub - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualHubVnetConnection.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualHubVnetConnection.md deleted file mode 100644 index 0124d1c8f9..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualHubVnetConnection.md +++ /dev/null @@ -1,261 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermvirtualhubvnetConnection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmVirtualHubVnetConnection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmVirtualHubVnetConnection.md ---- - -# Remove-AzureRmVirtualHubVnetConnection - -## SYNOPSIS -The Remove-AzureRmVirtualHubVnetConnection cmdlet removes an Azure Virtual Network Connection which peers a remote VNET to the hub VNET. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByHubVirtualNetworkConnectionName (Default) -``` -Remove-AzureRmVirtualHubVnetConnection -ResourceGroupName <String> -ParentResourceName <String> -Name <String> - [-AsJob] [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByHubVirtualNetworkConnectionObject -``` -Remove-AzureRmVirtualHubVnetConnection [-InputObject <PSHubVirtualNetworkConnection>] [-AsJob] [-Force] - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByHubVirtualNetworkConnectionResourceId -``` -Remove-AzureRmVirtualHubVnetConnection -ResourceId <String> [-AsJob] [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmVirtualHubVnetConnection cmdlet removes an Azure Virtual Network Connection which peers a remote VNET to the hub VNET. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> $frontendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" -PS C:\> $backendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name backendSubnet -AddressPrefix "10.0.2.0/24" -PS C:\> $remoteVirtualNetwork = New-AzureRmVirtualNetwork -Name "MyVirtualNetwork" -ResourceGroupName "testRG" -Location "West US" -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet,$backendSubnet -PS C:\> $virtualWan = New-AzureRmVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" -PS C:\> New-AzureRmVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" -PS C:\> New-AzureRmVirtualHubVnetConnection -ResourceGroupName "testRG" -VirtualHubName "westushub" -Name "testvnetconnection" -RemoteVirtualNetwork $remoteVirtualNetwork -PS C:\> Remove-AzureRmVirtualHubVnetConnection -ResourceGroupName testRG -VirtualHubName westushub -Name testvnetconnection -``` - -The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub in Central US in that resource group in Azure. A Virtual Network Connection will be created thereafter which will peer the Virtual Network to the Virtual Hub. - -After the hub virtual network connection is created, it removes the hub virtual network connection using its resource group name, the hub name and the connection name. - -### Example 2 - -```powershell -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> $frontendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" -PS C:\> $backendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name backendSubnet -AddressPrefix "10.0.2.0/24" -PS C:\> $remoteVirtualNetwork = New-AzureRmVirtualNetwork -Name "MyVirtualNetwork" -ResourceGroupName "testRG" -Location "West US" -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet,$backendSubnet -PS C:\> $virtualWan = New-AzureRmVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" -PS C:\> New-AzureRmVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" -PS C:\> New-AzureRmVirtualHubVnetConnection -ResourceGroupName "testRG" -VirtualHubName "westushub" -Name "testvnetconnection" -RemoteVirtualNetwork $remoteVirtualNetwork -PS C:\> Get-AzureRmVirtualHubVnetConnection -ResourceGroupName testRG -VirtualHubName westushub -Name testvnetconnection | Remove-AzureRmHubVnetConnection -``` - -The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub in Central US in that resource group in Azure. A Virtual Network Connection will be created thereafter which will peer the Virtual Network to the Virtual Hub. - -After the hub virtual network connection is created, it removes the hub virtual network connection using powershell piping on the output from Get-AzureRmHubVirtualNetworkConnection. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation if you want to overwrite a resource - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The hubvirtualnetworkconnection resource to modify. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSHubVirtualNetworkConnection -Parameter Sets: ByHubVirtualNetworkConnectionObject -Aliases: HubVirtualNetworkConnection - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: System.String -Parameter Sets: ByHubVirtualNetworkConnectionName -Aliases: ResourceName, HubVirtualNetworkConnectionName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParentResourceName -The parent resource name. - -```yaml -Type: System.String -Parameter Sets: ByHubVirtualNetworkConnectionName -Aliases: VirtualHubName, ParentVirtualHubName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByHubVirtualNetworkConnectionName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The resource id of the hubvirtualnetworkconnection resource to modify. - -```yaml -Type: System.String -Parameter Sets: ByHubVirtualNetworkConnectionResourceId -Aliases: HubVirtualNetworkConnectionId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSHubVirtualNetworkConnection - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualNetwork.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualNetwork.md deleted file mode 100644 index a402b80142..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualNetwork.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: C48E204D-D7EC-4EFD-ADC5-C6F593313B9B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermvirtualnetwork -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmVirtualNetwork.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmVirtualNetwork.md ---- - -# Remove-AzureRmVirtualNetwork - -## SYNOPSIS -Removes a virtual network. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVirtualNetwork -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVirtualNetwork** cmdlet removes an Azure virtual network. - -## EXAMPLES - -### 1: Create and delete a virtual network -``` -New-AzureRmResourceGroup -Name TestResourceGroup -Location centralus - $frontendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet - -AddressPrefix "10.0.1.0/24" - $backendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name backendSubnet -AddressPrefix - "10.0.2.0/24" - -New-AzureRmVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup - -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet,$backendSubnet - -Remove-AzureRmVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup -``` - -This example creates a virtual network in a resource group and then immediately deletes it. To suppress the prompt when deleting the virtual network, use the -Force flag. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual network that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the virtual network that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVirtualNetwork](./Get-AzureRmVirtualNetwork.md) - -[New-AzureRmVirtualNetwork](./New-AzureRmVirtualNetwork.md) - -[Set-AzureRmVirtualNetwork](./Set-AzureRmVirtualNetwork.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualNetworkGateway.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualNetworkGateway.md deleted file mode 100644 index f9e1268527..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualNetworkGateway.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: A35BB728-A7EF-4ADF-B1A9-25A156434E99 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermvirtualnetworkgateway -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmVirtualNetworkGateway.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmVirtualNetworkGateway.md ---- - -# Remove-AzureRmVirtualNetworkGateway - -## SYNOPSIS -Deletes a Virtual Network Gateway - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVirtualNetworkGateway -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Virtual Network Gateway is the object representing your gateway in Azure. -The **Get-AzureRmVirtualNetworkGateway** cmdlet returns the object of your gateway in Azure based on Name and Resource Group Name. - -## EXAMPLES - -### 1: Delete a Virtual Network Gateway -``` -Remove-AzureRmVirtualNetworkGateway -Name myGateway -ResourceGroupName myRG -``` - -Deletes the object of the Virtual Network Gateway with the name "myGateway" within the resource group "myRG" -Note: You must first delete all connections to the Virtual Network Gateway using the **Remove-AzureRmVirtualNetworkGatewayConnection** cmdlet. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual network gateway that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the virtual network gateway. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualNetworkGatewayConnection.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualNetworkGatewayConnection.md deleted file mode 100644 index d5d4dffb54..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualNetworkGatewayConnection.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 15958F3D-291A-4E49-A667-9792E9A1577A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermvirtualnetworkgatewayconnection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmVirtualNetworkGatewayConnection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmVirtualNetworkGatewayConnection.md ---- - -# Remove-AzureRmVirtualNetworkGatewayConnection - -## SYNOPSIS -Deletes a Virtual Network Gateway Connection - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVirtualNetworkGatewayConnection -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Virtual Network Gateway Connection is the object representing the IPsec tunnel (Site-to-Site or Vnet-to-Vnet) connected to your Virtual Network Gateway in Azure. -The **Remove-AzureRmVirtualNetworkGatewayConnection** cmdlet deletes the object of your connection based on Name and Resource Group Name. - -## EXAMPLES - -### 1: Delete a Virtual Network Gateway Connection -``` -Remove-AzureRmVirtualNetworkGatewayConnection -Name myTunnel -ResourceGroupName myRG -``` - -Deletes the object of the Virtual Network Gateway Connection with the name "myTunnel" within the resource group "myRG" - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual network gateway connection that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the virtual network gateway connection. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVirtualNetworkGatewayConnection](./Get-AzureRmVirtualNetworkGatewayConnection.md) - -[New-AzureRmVirtualNetworkGatewayConnection](./New-AzureRmVirtualNetworkGatewayConnection.md) - -[Set-AzureRmVirtualNetworkGatewayConnection](./Set-AzureRmVirtualNetworkGatewayConnection.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualNetworkGatewayDefaultSite.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualNetworkGatewayDefaultSite.md deleted file mode 100644 index b78505ff52..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualNetworkGatewayDefaultSite.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 65E9C4D5-4D2C-4039-A87B-4E693B97C4CB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermvirtualnetworkgatewaydefaultsite -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmVirtualNetworkGatewayDefaultSite.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmVirtualNetworkGatewayDefaultSite.md ---- - -# Remove-AzureRmVirtualNetworkGatewayDefaultSite - -## SYNOPSIS -Removes the default site from a virtual network gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVirtualNetworkGatewayDefaultSite -VirtualNetworkGateway <PSVirtualNetworkGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVirtualNetworkGatewayDefaultSite** cmdlet removes the forced tunneling default site from a virtual network gateway. -Forced tunneling provides a way for you to redirect Internet-bound traffic from Azure virtual machines to your on-premises network; this enables you to inspect and audit traffic before releasing it. -Forced tunneling is carried out by using a virtual private network (VPN) tunnel; this tunnel requires a default site, a local gateway where all the Azure Internet-bound traffic is redirected. -**Remove-AzureRmVirtualNetworkGatewayDefaultSite** removes the default site assigned to a gateway. -If you do this you will need to use Set-AzureRmVirtualNetworkGatewayDefaultSite to assign a new default site before the gateway can be used for forced tunneling. - -## EXAMPLES - -### Example 1: Remove the default site assigned to a virtual network gateway -``` -PS C:\>$Gateway = Get-AzureRmVirtualNetworkGateway -Name "ContosoVirtualGateway" -PS C:\> Remove-AzureRmVirtualNetworkGatewayDefaultSite -VirtualNetworkGateway $Gateway -``` - -This example removes the default site currently assigned to a virtual network gateway named ContosoVirtualGateway. -The first command uses **Get-AzureRmVirtualNetworkGateway** to create an object reference to the gateway; this object reference is stored in a variable named $Gateway. -The second command then uses **Remove-AzureRmVirtualNetworkGatewayDefaultSite** to remove the default site assigned to that gateway. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkGateway -Specifies an object reference to the virtual network gateway containing the default site to be removed. -You can create an object reference to a virtual network gateway by using the Get-AzureRmVirtualNetworkGateway and specifying the name of the gateway. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway -Parameters: VirtualNetworkGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVirtualNetworkGateway](./Get-AzureRmVirtualNetworkGateway.md) - -[Set-AzureRmVirtualNetworkGatewayDefaultSite](./Set-AzureRmVirtualNetworkGatewayDefaultSite.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualNetworkGatewayIpConfig.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualNetworkGatewayIpConfig.md deleted file mode 100644 index f5496903a7..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualNetworkGatewayIpConfig.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 60DA2175-7970-410C-A13C-B1314716AD8A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermvirtualnetworkgatewayipconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmVirtualNetworkGatewayIpConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmVirtualNetworkGatewayIpConfig.md ---- - -# Remove-AzureRmVirtualNetworkGatewayIpConfig - -## SYNOPSIS -Removes an IP Configuration from a Virtual Network Gateway - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVirtualNetworkGatewayIpConfig -VirtualNetworkGateway <PSVirtualNetworkGateway> -Name <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Removes an IP Configuration from a Virtual Network Gateway - -## EXAMPLES - -### Example 1: -``` -Remove-AzureRmVirtualNetworkGatewayIpConfig -VirtualNetworkGateway $gateway -Name ActiveActive - -Name : myGateway -ResourceGroupName : myRG -Location : eastus -Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft - .Network/virtualNetworkGateways/VNet8GW -Etag : W/"00000000-0000-0000-0000-000000000000" -ResourceGuid : 00000000-0000-0000-0000-000000000000 -ProvisioningState : Succeeded -Tags : -IpConfigurations : [ - { - "PrivateIpAllocationMethod": "Dynamic", - "Subnet": { - "Id": "/subscriptions/800000000-0000-0000-0000-000000000000/resourceGroups/myRG/provid - ers/Microsoft.Network/virtualNetworks/VNet8/subnets/GatewaySubnet" - }, - "PublicIpAddress": { - "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/provid - ers/Microsoft.Network/publicIPAddresses/VNet8GWIP" - }, - "Name": "gwipconfig1", - "Etag": "W/\"00000000-0000-0000-0000-000000000000\"", - "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/provider - s/Microsoft.Network/virtualNetworkGateways/VNet8GW/ipConfigurations/gwipconfig1" - } - ] -GatewayType : Vpn -VpnType : RouteBased -EnableBgp : False -ActiveActive : True -GatewayDefaultSite : null -Sku : { - "Capacity": 2, - "Name": "VpnGw1", - "Tier": "VpnGw1" - } -VpnClientConfiguration : null -BgpSettings : { - "Asn": 65515, - "BgpPeeringAddress": "192.0.2.4,192.0.2.5", - "PeerWeight": 0 - } -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkGateway -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway -Parameters: VirtualNetworkGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualNetworkPeering.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualNetworkPeering.md deleted file mode 100644 index adc2096df6..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualNetworkPeering.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 1CE08F0F-A59E-46AC-B470-F1DCCD46513E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermvirtualnetworkpeering -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmVirtualNetworkPeering.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmVirtualNetworkPeering.md ---- - -# Remove-AzureRmVirtualNetworkPeering - -## SYNOPSIS -Removes a virtual network peering. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVirtualNetworkPeering -VirtualNetworkName <String> -Name <String> -ResourceGroupName <String> - [-Force] [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Removes a virtual network peering. - -## EXAMPLES - -### Example 1: Remove a virtual network peering -``` -# Remove the virtual network peering named myVnet1TomyVnet2 located in myVnet1 in the resource group named myResourceGroup. - -Remove-AzureRmVirtualNetworkPeering -Name "myVnet1TomyVnet2" -VirtualNetworkName "myVnet" -ResourceGroupName "myResourceGroup" -``` - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The virtual network peering name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkName -The virtual network name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualNetworkSubnetConfig.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualNetworkSubnetConfig.md deleted file mode 100644 index a322c48527..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualNetworkSubnetConfig.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 47FE9EF4-6000-4096-8F04-26A0C6661FDB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermvirtualnetworksubnetconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmVirtualNetworkSubnetConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmVirtualNetworkSubnetConfig.md ---- - -# Remove-AzureRmVirtualNetworkSubnetConfig - -## SYNOPSIS -Removes a subnet configuration from a virtual network. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVirtualNetworkSubnetConfig [-Name <String>] -VirtualNetwork <PSVirtualNetwork> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVirtualNetworkSubnetConfig** cmdlet removes a subnet from an Azure virtual network. - -## EXAMPLES - -### 1: Remove a subnet from a virtual network and update the virtual network -``` -New-AzureRmResourceGroup -Name TestResourceGroup -Location centralus - $frontendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet - -AddressPrefix "10.0.1.0/24" - -$backendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name backendSubnet -AddressPrefix - "10.0.2.0/24" - -$virtualNetwork = New-AzureRmVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName - TestResourceGroup -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet - $frontendSubnet,$backendSubnet - -Remove-AzureRmVirtualNetworkSubnetConfig -Name backendSubnet -VirtualNetwork - $virtualNetwork - $virtualNetwork | Set-AzureRmVirtualNetwork -``` - -This example creates a resource group and a virtual network with two subnets. It then - uses the Remove-AzureRmVirtualNetworkSubnetConfig command to remove the backend subnet - from the in-memory representation of the virtual network. Set-AzureRmVirtualNetwork is - then called to modify the virtual network on the server side. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the subnet configuration to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetwork -Specifies the **VirtualNetwork** object that contains the subnet configuration to remove. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork -Parameters: VirtualNetwork (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVirtualNetworkSubnetConfig](./Add-AzureRmVirtualNetworkSubnetConfig.md) - -[Get-AzureRmVirtualNetworkSubnetConfig](./Get-AzureRmVirtualNetworkSubnetConfig.md) - -[New-AzureRmVirtualNetworkSubnetConfig](./New-AzureRmVirtualNetworkSubnetConfig.md) - -[Set-AzureRmVirtualNetworkSubnetConfig](./Set-AzureRmVirtualNetworkSubnetConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualNetworkTap.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualNetworkTap.md deleted file mode 100644 index 8210d66aa9..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualNetworkTap.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermvirtualnetworktap -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmVirtualNetworkTap.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmVirtualNetworkTap.md ---- - -# Remove-AzureRmVirtualNetworkTap - -## SYNOPSIS -Removes a virtual network tap. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RemoveByNameParameterSet (Default) -``` -Remove-AzureRmVirtualNetworkTap -ResourceGroupName <String> -Name <String> [-Force] [-AsJob] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### DeleteByResourceIdParameterSet -``` -Remove-AzureRmVirtualNetworkTap -ResourceId <String> [-Force] [-AsJob] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### DeleteByInputObjectParameterSet -``` -Remove-AzureRmVirtualNetworkTap -InputObject <PSVirtualNetworkTap> [-Force] [-AsJob] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVirtualNetworkTap** cmdlet removes an Azure virtual network tap. - -## EXAMPLES - -### Example 1: Remove a virtuak network tap -``` -PS C:\>Remove-AzureRmNetworkInterface -Name "VirtualNetworkTap1" -ResourceGroup "ResourceGroup1" -``` - -This command removes the VirtualNetworkTap1 in resource group ResourceGroup1. -Because the *Force* parameter is not used, the user will be prompted to confirm this action. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation if you want to delete resource - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Reference to VirtualNetworkTap resource - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkTap -Parameter Sets: DeleteByInputObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the tap. - -```yaml -Type: System.String -Parameter Sets: RemoveByNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name of the virtual network tap. - -```yaml -Type: System.String -Parameter Sets: RemoveByNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -VirtualNetworkTap resourceId - -```yaml -Type: System.String -Parameter Sets: DeleteByResourceIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualWan.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualWan.md deleted file mode 100644 index 44efea8ea6..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVirtualWan.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermvirtualwan -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmVirtualWan.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmVirtualWan.md ---- - -# Remove-AzureRmVirtualWan - -## SYNOPSIS -Removes an Azure Virtual WAN. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVirtualWanName (Default) -``` -Remove-AzureRmVirtualWan -ResourceGroupName <String> -Name <String> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByVirtualWanObject -``` -Remove-AzureRmVirtualWan -InputObject <PSVirtualWan> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByVirtualWanResourceId -``` -Remove-AzureRmVirtualWan -ResourceId <String> [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Removes an Azure Virtual WAN. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> New-AzureRmResourceGroup -Name "TestResourceGroup" -Location "Central US" -PS C:\> New-AzureRmVirtualWan -Name "MyVirtualWan" -ResourceGroupName "TestResourceGroup" -Location "Central US" -PS C:\> Remove-AzureRmVirtualWan -Name "MyVirtualWan" -ResourceGroupName "TestResourceGroup" -Passthru -``` - -This example creates a Virtual WAN in a resource group and then immediately deletes it. -To suppress the prompt when deleting the Virtual WAN, use the -Force flag. - -### Example 2 - -```powershell -PS C:\> New-AzureRmResourceGroup -Name "TestResourceGroup" -Location "Central US" -PS C:\> $virtualWan = New-AzureRmVirtualWan -Name "MyVirtualWan" -ResourceGroupName "TestResourceGroup" -Location "Central US" -PS C:\> Remove-AzureRmVirtualWan -InputObject $virtualWan -Passthru -``` - -This example creates a Virtual WAN in a resource group and then immediately deletes it. This deletion happens using the virtual wan object returned by New-AzureRmVirtualWan. -To suppress the prompt when deleting the Virtual WAN, use the -Force flag. - -### Example 3 - -```powershell -PS C:\> New-AzureRmResourceGroup -Name "TestResourceGroup" -Location "Central US" -PS C:\> $virtualWan = New-AzureRmVirtualWan -Name "MyVirtualWan" -ResourceGroupName "TestResourceGroup" -Location "Central US" -PS C:\> Remove-AzureRmVirtualWan -ResourceId $virtualWan.Id -Passthru -``` - -This example creates a Virtual WAN in a resource group and then immediately deletes it. This deletion happens using the virtual wan resource id returned by New-AzureRmVirtualWan. -To suppress the prompt when deleting the Virtual WAN, use the -Force flag. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The virtual wan object to be deleted. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualWan -Parameter Sets: ByVirtualWanObject -Aliases: VirtualWan - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The virtual wan name. - -```yaml -Type: System.String -Parameter Sets: ByVirtualWanName -Aliases: ResourceName, VirtualWanName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByVirtualWanName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID for the virtual wan to be deleted. - -```yaml -Type: System.String -Parameter Sets: ByVirtualWanResourceId -Aliases: VirtualWanId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualWan - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVpnClientIpsecParameter.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVpnClientIpsecParameter.md deleted file mode 100644 index 71c3bc0a81..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVpnClientIpsecParameter.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermvpnclientipsecparameter -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmVpnClientIpsecParameter.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmVpnClientIpsecParameter.md ---- - -# Remove-AzureRmVpnClientIpsecParameter - -## SYNOPSIS -Removes Vpn custom ipsec policy set on Virtual Network Gateway resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Remove-AzureRmVpnClientIpsecParameter -VirtualNetworkGatewayName <String> -ResourceGroupName <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByFactoryObject -``` -Remove-AzureRmVpnClientIpsecParameter -InputObject <PSVirtualNetworkGateway> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Remove-AzureRmVpnClientIpsecParameter -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Virtual Network Gateway is the object representing your gateway in Azure. -The **Remove-AzureRmVpnClientIpsecParameter** cmdlet removes the vpn custom ipsec parameters set on your Virtual Network Gateway, which in turn sets default vpn ipsec policy on VPN gateway based on VirtualNetworkGateway Name and Resource Group Name passed. - -## EXAMPLES - -### 1: Deletes the set vpn ipsec parameters set on the Virtual Network Gateway -``` -PS C:\> $delete = Remove-AzureRmVpnClientIpsecParameter -VirtualNetworkGatewayName myGateway -ResourceGroupName myRG -``` - -Deletes the vpn custom ipsec parameters set on your Virtual Network Gateway with the name "myGateway" within the resource group "myRG". This command returns bool object showing if removal was successful or failed. -Note: This will result in setting default vpn ipsec policy on your Virtual Network Gateway. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The virtual network gateaway object - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkGatewayName -The virtual network gateway name. - -```yaml -Type: System.String -Parameter Sets: ByFactoryName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVpnClientRevokedCertificate.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVpnClientRevokedCertificate.md deleted file mode 100644 index 0ac862af8f..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVpnClientRevokedCertificate.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 818C2250-DE43-409E-AC68-B4A7E945401E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermvpnclientrevokedcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmVpnClientRevokedCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmVpnClientRevokedCertificate.md ---- - -# Remove-AzureRmVpnClientRevokedCertificate - -## SYNOPSIS -Removes a VPN client-revocation certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVpnClientRevokedCertificate -VpnClientRevokedCertificateName <String> - -VirtualNetworkGatewayName <String> -ResourceGroupName <String> -Thumbprint <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVpnClientRevokedCertificate** cmdlet removes a client-revocation certificate from a virtual network gateway. -Client-revocation certificates prevent client computers from using the specified certificate for authentication. -If you remove a client-revocation certificate client computers can then use the previously-banned certificate to make a virtual private network (VPN) connection. - -## EXAMPLES - -### Example 1: Remove a client-revocation certificate from a virtual network gateway -``` -PS C:\>Remove-AzureRmVpnClientRevokedCertificate -VirtualNetworkGatewayName "ContosoVirtualNetwork" -ResourceGroupName"ContosoResourceGroup" -VpnClientRevokedCertificateName "ContosoRevokedClientCertificate"-Thumbprint "E3A38EBA60CAA1C162785A2E1C44A15AD450199C3" -``` - -This command removes a client-revocation certificate from a virtual network gateway named ContosoVirtualNetwork. -In order to remove a client-revocation certificate, you must specify both the certificate name and the certificate thumbprint. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the virtual network gateway is assigned to. -Resource groups categorize items to help simplify inventory management and general Azure administration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Thumbprint -Specifies the unique identifier of the certificate being removed. -You can return thumbprint information for your certificates by using a Windows PowerShell command similar to this: -`Get-ChildItem -Path "Cert:\LocalMachine\Root"` -The preceding command returns information for all the Local Computer certificates found in the Root certificate store. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkGatewayName -Specifies the name of the virtual network gateway that the certificate is assigned to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VpnClientRevokedCertificateName -Specifies the name of the VPN client certificate being removed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVpnClientRevokedCertificate](./Add-AzureRmVpnClientRevokedCertificate.md) - -[Get-AzureRmVpnClientRevokedCertificate](./Get-AzureRmVpnClientRevokedCertificate.md) - -[New-AzureRmVpnClientRevokedCertificate](./New-AzureRmVpnClientRevokedCertificate.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVpnClientRootCertificate.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVpnClientRootCertificate.md deleted file mode 100644 index f193a94693..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVpnClientRootCertificate.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 5D857FF6-A27D-4031-948D-8A69D24B4AD4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermvpnclientrootcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmVpnClientRootCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmVpnClientRootCertificate.md ---- - -# Remove-AzureRmVpnClientRootCertificate - -## SYNOPSIS -Removes an existing VPN client root certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVpnClientRootCertificate -VpnClientRootCertificateName <String> - -VirtualNetworkGatewayName <String> -ResourceGroupName <String> -PublicCertData <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVpnClientRootCertificate** cmdlet removes the specified root certificate from a virtual network gateway. -Root certificates are X.509 certificates that identify your Root Certification Authority: all other certificates used on the gateway trust the root certificate. -If you remove a root certificate computers that use the certificate for authentication purposes will no longer be able to connect to the gateway. -When you use **Remove-AzureRmVpnClientRootCertificate**, you must supply both the certificate name and a text representation of the certificate data. -For more information about the text representation of a certificate see the *PublicCertData* parameter description. - -## EXAMPLES - -### Example 1: Remove a client root certificate from a virtual network gateway -``` -PS C:\>$Text = Get-Content -Path "C:\Azure\Certificates\ExportedCertficate.cer" -PS C:\> $CertificateText = for ($i=1; $i -lt $Text.Length -1 ; $i++){$Text[$i]} -PS C:\> Remove-AzureRmVpnClientRootCertificate -PublicCertData $CertificateText -ResourceGroupName "ContosoResourceGroup" -VirtualNetworkGatewayName "ContosoVirtualGateway"-VpnClientRootCertificateName "ContosoRootCertificate" -``` - -This example removes a client root certificate named ContosoRootCertificate from the virtual network gateway ContosoVirtualGateway. -The first command uses the **Get-Content** cmdlet to get a previously-exported text representation of the certificate; this text representation is stored in a variable named $Text. -The second command then uses a for loop to extract all the text in $Text except for the first line and the last line. -This extracted text is stored in a variable named $CertificateText. -The third command uses the information stored in the $CertificateText variable along with the **Remove-AzureRmVpnClientRootCertificate** cmdlet to remove the certificate from the gateway. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicCertData -Specifies the text representation of the root certificate to be removed. -To obtain the text representation, export your certificate in .cer format (using Base64) encoding, then open the resulting file in a text editor. -You should see output similar to the following (note that the actual output will contain many more lines of text than the abbreviated sample shown here): ------ BEGIN CERTIFICATE ----- -MIIC13FAAXC3671Auij9HHgUNEW8343NMJklo09982CVVFAw8w ------ END CERTIFICATE ----- -The PublicCertData is made up of all the lines between the first line (----- BEGIN CERTIFICATE -----) and the last line (----- END CERTIFICATE -----) in the file. -You can retrieve the PublicCertData using Windows PowerShell commands similar to this: -$Text = Get-Content -Path "C:\Azure\Certificates\ExportedCertficate.cer" -$CertificateText = for ($i=1; $i -lt $Text.Length -1 ; $i++){$Text\[$i\]} - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the virtual network gateway is assigned to. -Resource groups categorize items to help simplify inventory management and general Azure administration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkGatewayName -Specifies the name of the virtual network gateway that the certificate is removed from. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VpnClientRootCertificateName -Specifies the name of the client root certificate that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVpnClientRootCertificate](./Add-AzureRmVpnClientRootCertificate.md) - -[Get-AzureRmVpnClientRootCertificate](./Get-AzureRmVpnClientRootCertificate.md) - -[New-AzureRmVpnClientRootCertificate](./New-AzureRmVpnClientRootCertificate.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVpnConnection.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVpnConnection.md deleted file mode 100644 index 36279d6967..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVpnConnection.md +++ /dev/null @@ -1,257 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermvpnconnection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmVpnConnection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmVpnConnection.md ---- - -# Remove-AzureRmVpnConnection - -## SYNOPSIS -Removes a VpnConnection. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVpnConnectionName (Default) -``` -Remove-AzureRmVpnConnection -ResourceGroupName <String> -ParentResourceName <String> -Name <String> [-Force] - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByVpnConnectionResourceId -``` -Remove-AzureRmVpnConnection -ResourceId <String> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByVpnConnectionObject -``` -Remove-AzureRmVpnConnection -InputObject <PSVpnConnection> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Removes a VpnConnection. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> $virtualWan = New-AzureRmVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" -PS C:\> $virtualHub = New-AzureRmVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" -PS C:\> New-AzureRmVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -BGPPeeringWeight 10 -VpnGatewayScaleUnit 2 -PS C:\> $vpnGateway = Get-AzureRmVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" - -PS C:\> $vpnSiteAddressSpaces = New-Object string[] 2 -PS C:\> $vpnSiteAddressSpaces[0] = "192.168.2.0/24" -PS C:\> $vpnSiteAddressSpaces[1] = "192.168.3.0/24" - -PS C:\> $vpnSite = New-AzureRmVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -Location "West US" -VirtualWan $virtualWan -IpAddress "1.2.3.4" -AddressSpace $vpnSiteAddressSpaces -DeviceModel "SomeDevice" -DeviceVendor "SomeDeviceVendor" -LinkSpeedInMbps "10" - -PS C:\> New-AzureRmVpnConnection -ResourceGroupName $vpnGateway.ResourceGroupName -ParentResourceName $vpnGateway.Name -Name "testConnection" -VpnSite $vpnSite -PS C:\> Remove-AzureRmVpnConnection -ResourceGroupName $vpnGateway.ResourceGroupName -ParentResourceName $vpnGateway.Name -Name "testConnection" -``` - -The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub and a VpnSite in West US in "testRG" resource group in Azure. -A VPN gateway will be created thereafter in the Virtual Hub with 2 scale units. - -Once the gateway has been created, it is connected to the VpnSite using the New-AzureRmVpnConnection command. - -Then it removes the connection using the connection name. - -### Example 2 - -```powershell -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> $virtualWan = New-AzureRmVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" -PS C:\> $virtualHub = New-AzureRmVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" -PS C:\> New-AzureRmVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -BGPPeeringWeight 10 -VpnGatewayScaleUnit 2 -PS C:\> $vpnGateway = Get-AzureRmVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" - -PS C:\> $vpnSiteAddressSpaces = New-Object string[] 2 -PS C:\> $vpnSiteAddressSpaces[0] = "192.168.2.0/24" -PS C:\> $vpnSiteAddressSpaces[1] = "192.168.3.0/24" - -PS C:\> $vpnSite = New-AzureRmVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -Location "West US" -VirtualWan $virtualWan -IpAddress "1.2.3.4" -AddressSpace $vpnSiteAddressSpaces -DeviceModel "SomeDevice" -DeviceVendor "SomeDeviceVendor" -LinkSpeedInMbps "10" - -PS C:\> New-AzureRmVpnConnection -ResourceGroupName $vpnGateway.ResourceGroupName -ParentResourceName $vpnGateway.Name -Name "testConnection" -VpnSite $vpnSite -PS C:\> Get-AzureRmVpnConnection -ResourceGroupName $vpnGateway.ResourceGroupName -ParentResourceName $vpnGateway.Name -Name "testConnection" | Remove-AzureRmVpnConnection -``` - -Same as example 1, but it now removes the connection using the piped object from Get-AzureRmVpnConnection. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation if you want to overrite a resource - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The VpnConenction object to update. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVpnConnection -Parameter Sets: ByVpnConnectionObject -Aliases: VpnConnection - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: System.String -Parameter Sets: ByVpnConnectionName -Aliases: ResourceName, VpnConnectionName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParentResourceName -The parent resource name. - -```yaml -Type: System.String -Parameter Sets: ByVpnConnectionName -Aliases: ParentVpnGatewayName, VpnGatewayName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByVpnConnectionName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The resource id of the VpnConenction object to delete. - -```yaml -Type: System.String -Parameter Sets: ByVpnConnectionResourceId -Aliases: VpnConnectionId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Network.Models.PSVpnConnection - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVpnGateway.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVpnGateway.md deleted file mode 100644 index da6149f6ba..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVpnGateway.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermvpngateway -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmVpnGateway.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmVpnGateway.md ---- - -# Remove-AzureRmVpnGateway - -## SYNOPSIS -The Remove-AzureRmVpnGateway cmdlet removes an Azure VPN gateway. This is a gateway specific to Azure Virtual WAN's software defined connectivity. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVpnGatewayName (Default) -``` -Remove-AzureRmVpnGateway -ResourceGroupName <String> -Name <String> [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByVpnGatewayObject -``` -Remove-AzureRmVpnGateway -InputObject <PSVpnGateway> [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByVpnGatewayResourceId -``` -Remove-AzureRmVpnGateway -ResourceId <String> [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmVpnGateway cmdlet removes an Azure VPN gateway. This is a gateway specific to Azure Virtual WAN's software defined connectivity. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> $virtualWan = New-AzureRmVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" -PS C:\> $virtualHub = New-AzureRmVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" -PS C:\> New-AzureRmVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -BGPPeeringWeight 10 -VpnGatewayScaleUnit 2 -PS C:\> Remove-AzureRmVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -Passthru -``` - -This example creates a Resource group, Virtual WAN, Virtual Hub, scalable VPN gateway in Central US and then immediately deletes it. -To suppress the prompt when deleting the Virtual Gateway, use the -Force flag. -This will delete the VpnGateway and all VpnConnections attached to it. - -### Example 2 - -```powershell -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> $virtualWan = New-AzureRmVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" -PS C:\> $virtualHub = New-AzureRmVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" -PS C:\> New-AzureRmVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -BGPPeeringWeight 10 -VpnGatewayScaleUnit 2 -PS C:\> Get-AzureRmVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" | Remove-AzureRmVpnGateway-Passthru -``` - -This example creates a Resource group, Virtual WAN, Virtual Hub, scalable VPN gateway in Central US and then immediately deletes it. -This deletion happens using powershell piping, which uses the VpnGateway object returned by the Get-AzureRmVpnGateway command. -To suppress the prompt when deleting the Virtual Gateway, use the -Force flag. -This will delete the VpnGateway and all VpnConnections attached to it. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The vpnGateway object to be deleted. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVpnGateway -Parameter Sets: ByVpnGatewayObject -Aliases: VpnGateway - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The vpnGateway name. - -```yaml -Type: System.String -Parameter Sets: ByVpnGatewayName -Aliases: ResourceName, VpnGatewayName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByVpnGatewayName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID for the vpnGateway to be deleted. - -```yaml -Type: System.String -Parameter Sets: ByVpnGatewayResourceId -Aliases: vpnGatewayId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVpnGateway - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVpnSite.md b/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVpnSite.md deleted file mode 100644 index ba7301bc52..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Remove-AzureRmVpnSite.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermvpnsite -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmVpnSite.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Remove-AzureRmVpnSite.md ---- - -# Remove-AzureRmVpnSite - -## SYNOPSIS -Removes an Azure VpnSite resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVpnSiteName (Default) -``` -Remove-AzureRmVpnSite -ResourceGroupName <String> -Name <String> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByVpnSiteObject -``` -Remove-AzureRmVpnSite -InputObject <PSVpnSite> [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByVpnSiteResourceId -``` -Remove-AzureRmVpnSite -ResourceId <String> [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Removes an Azure VpnSite resource. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> $virtualWan = New-AzureRmVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" -PS C:\> $vpnSiteAddressSpaces = New-Object string[] 2 -PS C:\> $vpnSiteAddressSpaces[0] = "192.168.2.0/24" -PS C:\> $vpnSiteAddressSpaces[1] = "192.168.3.0/24" -PS C:\> New-AzureRmVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -Location "West US" -VirtualWan $virtualWan -IpAddress "1.2.3.4" -AddressSpace $vpnSiteAddressSpaces -DeviceModel "SomeDevice" -DeviceVendor "SomeDeviceVendor" -LinkSpeedInMbps "10" -PS C:\> Remove-AzureRmVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -``` - -The above will create a resource group, Virtual WAN in West US in "testRG" resource group in Azure. - -Then it creates a VpnSite to represent a customer branch and links it to the Virtual WAN. - -Once the site is created, it is immediately removed using the Remove-AzureRmVpnSite command. - -### Example 2 - -```powershell -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> $virtualWan = New-AzureRmVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" -PS C:\> $vpnSiteAddressSpaces = New-Object string[] 2 -PS C:\> $vpnSiteAddressSpaces[0] = "192.168.2.0/24" -PS C:\> $vpnSiteAddressSpaces[1] = "192.168.3.0/24" -PS C:\> New-AzureRmVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -Location "West US" -VirtualWan $virtualWan -IpAddress "1.2.3.4" -AddressSpace $vpnSiteAddressSpaces -DeviceModel "SomeDevice" -DeviceVendor "SomeDeviceVendor" -LinkSpeedInMbps "10" -PS C:\> Get-AzureRmVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" | Remove-AzureRmVpnSite -``` - -Same as example 1 but here the removal happens using the piped output from Get-AzureRmVpnSite. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The vpnSite object to be deleted. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVpnSite -Parameter Sets: ByVpnSiteObject -Aliases: VpnSite - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The vpnSite name. - -```yaml -Type: System.String -Parameter Sets: ByVpnSiteName -Aliases: ResourceName, VpnSiteName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByVpnSiteName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID for the vpnSite to be deleted. - -```yaml -Type: System.String -Parameter Sets: ByVpnSiteResourceId -Aliases: VpnSiteId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVpnSite - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Reset-AzureRmVirtualNetworkGateway.md b/azurermps-6.13.0/AzureRM.Network/Reset-AzureRmVirtualNetworkGateway.md deleted file mode 100644 index 53ff1e48ba..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Reset-AzureRmVirtualNetworkGateway.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 443F6492-EFA7-4417-943A-3A8D47F8C83C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/reset-azurermvirtualnetworkgateway -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Reset-AzureRmVirtualNetworkGateway.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Reset-AzureRmVirtualNetworkGateway.md ---- - -# Reset-AzureRmVirtualNetworkGateway - -## SYNOPSIS -Resets the Virtual Network Gateway - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Reset-AzureRmVirtualNetworkGateway -VirtualNetworkGateway <PSVirtualNetworkGateway> [-GatewayVip <String>] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Resets the Virtual Network Gateway - -## EXAMPLES - -### Example 1: -``` -$Gateway = Get-AzureRmVirtualNetworkGateway -Name "ContosoVirtualGateway" -Reset-AzureRmVirtualNetworkGateway -VirtualNetworkGateway $Gateway -``` - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GatewayVip -The gateway vip in order to reset particular gateway instance (e.g. in case of Active-Active feature enabled gateways.) By default, gateway primary instance will be reset if no value is passed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VirtualNetworkGateway -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway -Parameters: VirtualNetworkGateway (ByValue) - -### System.String -Parameters: GatewayVip (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVirtualNetworkGateway](./Get-AzureRmVirtualNetworkGateway.md) - -[New-AzureRmVirtualNetworkGateway](./New-AzureRmVirtualNetworkGateway.md) - -[Remove-AzureRmVirtualNetworkGateway](./Remove-AzureRmVirtualNetworkGateway.md) - -[Resize-AzureRmVirtualNetworkGateway](./Resize-AzureRmVirtualNetworkGateway.md) - -[Set-AzureRmVirtualNetworkGateway](./Set-AzureRmVirtualNetworkGateway.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Reset-AzureRmVirtualNetworkGatewayConnectionSharedKey.md b/azurermps-6.13.0/AzureRM.Network/Reset-AzureRmVirtualNetworkGatewayConnectionSharedKey.md deleted file mode 100644 index 95de90fa11..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Reset-AzureRmVirtualNetworkGatewayConnectionSharedKey.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: AB370DAD-CED9-479D-BE08-B32EFF924A37 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/reset-azurermvirtualnetworkgatewayconnectionsharedkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Reset-AzureRmVirtualNetworkGatewayConnectionSharedKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Reset-AzureRmVirtualNetworkGatewayConnectionSharedKey.md ---- - -# Reset-AzureRmVirtualNetworkGatewayConnectionSharedKey - -## SYNOPSIS -Resets the shared key of the virtual network gateway connection. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Reset-AzureRmVirtualNetworkGatewayConnectionSharedKey -Name <String> -ResourceGroupName <String> - -KeyLength <UInt32> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Resets the shared key of the virtual network gateway connection. - -## EXAMPLES - -### Example 1: -``` -Reset-AzureRmVirtualNetworkGatewayConnectionSharedKey -ResourceGroupName myRG -Name myConnection -KeyLength 32 - -Confirm -Are you sure you want to overwrite resource 'myConnection' -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y -h0FmZA3BzXHqRE00J0wie0Mti0cCZwJm -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyLength -```yaml -Type: System.UInt32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.UInt32 - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVirtualNetworkGatewayConnectionSharedKey](./Get-AzureRmVirtualNetworkGatewayConnectionSharedKey.md) - -[Set-AzureRmVirtualNetworkGatewayConnectionSharedKey](./Set-AzureRmVirtualNetworkGatewayConnectionSharedKey.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Resize-AzureRmVirtualNetworkGateway.md b/azurermps-6.13.0/AzureRM.Network/Resize-AzureRmVirtualNetworkGateway.md deleted file mode 100644 index 0f9363a264..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Resize-AzureRmVirtualNetworkGateway.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: DE2441FC-9504-4F3F-AEAF-37EDCD9B7275 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/resize-azurermvirtualnetworkgateway -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Resize-AzureRmVirtualNetworkGateway.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Resize-AzureRmVirtualNetworkGateway.md ---- - -# Resize-AzureRmVirtualNetworkGateway - -## SYNOPSIS -Resizes an existing virtual network gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Resize-AzureRmVirtualNetworkGateway -VirtualNetworkGateway <PSVirtualNetworkGateway> -GatewaySku <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Resize-AzureRmVirtualNetworkGateway** cmdlet enables you to change the stock-keeping unit (SKU) for a virtual network gateway. -SKUs determine the capabilities of a gateway, including such things as throughput and the maximum number of IP tunnels that are allowed. -Azure supports Basic, Standard, High-Performance, VpnGw1, VpnGw2, VpnGw3, VpnGw1AZ, VpnGw2AZ, VpnGw3AZ, ErGw1AZ, ErGw2AZ, ErGw3AZ SKUs (sometimes referred to as Small, Medium, and Large SKUs). -For detailed information about the capabilities of each SKU type, see https://azure.microsoft.com/en-us/documentation/articles/vpn-gateway-about-vpngateways/. -Keep in mind that SKUs differ in pricing as well as capabilities. -For more information, see https://azure.microsoft.com/en-us/pricing/details/vpn-gateway/. - -## EXAMPLES - -### Example 1: Change the size of a virtual network gateway -``` -PS C:\>$Gateway = Get-AzureRmVirtualNetworkGateway -Name "ContosoVirtualGateway" -PS C:\> Resize-AzureRmVirtualNetworkGateway -VirtualNetworkGateway $Gateway -GatewaySku "Basic" -``` - -This example changes the size of a virtual network gateway named ContosoVirtualGateway. -The first command creates an object reference to ContosoVirtualGateway; this object reference is stored in a variable named $Gateway. -The second command then uses the **Resize-AzureRmVirtualNetworkGateway** cmdlet to set the *GatewaySku* property to Basic. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GatewaySku -Specifies the new type of gateway SKU. -The acceptable values for this parameter are: -- Basic -- Standard -- High Performance -- VpnGw1 -- VpnGw2 -- VpnGw3 -- VpnGw1AZ -- VpnGw2AZ -- VpnGw3AZ -- ErGw1AZ -- ErGw2AZ -- ErGw3AZ - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Basic, Standard, HighPerformance, UltraPerformance, VpnGw1, VpnGw2, VpnGw3, VpnGw1AZ, VpnGw2AZ, VpnGw3AZ, ErGw1AZ, ErGw2AZ, ErGw3AZ - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkGateway -Specifies an object reference to the virtual network gateway to be resized. -You can create this object reference by using the Get-AzureRmVirtualNetworkGateway and specifying the name of the gateway. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway -Parameters: VirtualNetworkGateway (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway - -## NOTES -You cannot resize from Basic/Standard/HighPerformance SKUs to the new VpnGw1/VpnGw2/VpnGw3 SKUs. Further resize is not allowed from/to VpnGw1AZ/VpnGw2AZ/VpnGw3AZ or ErGw1AZ/ErGw2AZ/ErGw3AZ. Resize is allowed only within the SKU 'series' e.g VpnGw1AZ can be resized to/from VpnGw2AZ/VpnGw3AZ and ErGw1AZ can be resized to/from ErGw2AZ/ErGw3AZ. See https://docs.microsoft.com/en-us/azure/vpn-gateway/vpn-gateway-about-vpngateways for instructions. - -## RELATED LINKS - -[Get-AzureRmVpnClientPackage](./Get-AzureRmVpnClientPackage.md) - -[Get-AzureRmVirtualNetworkGateway](./Get-AzureRmVirtualNetworkGateway.md) - -[Set-AzureRmVirtualNetworkGatewayVpnClientConfig](./Set-AzureRmVirtualNetworkGatewayVpnClientConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGateway.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGateway.md deleted file mode 100644 index 41852b44bc..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGateway.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 7C8B47B4-2F6A-45EF-A351-88C8C3F9D0D3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgateway -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGateway.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGateway.md ---- - -# Set-AzureRmApplicationGateway - -## SYNOPSIS -Updates an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApplicationGateway -ApplicationGateway <PSApplicationGateway> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmApplicationGateway** cmdlet updates an Azure application gateway. - -## EXAMPLES - -### Example 1: Update an application gateway -``` -PS C:\>$UpdatedAppGw = Set-AzureRmApplicationGateway -ApplicationGateway $AppGw -``` - -This command updates the application gateway with settings in the $AppGw variable and stores the updated gateway in the $UpdatedAppGw variable. - -## PARAMETERS - -### -ApplicationGateway -Specifies an application gateway object representing the state to which the application gateway should be set. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Start-AzureRmApplicationGateway](./Start-AzureRmApplicationGateway.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayAuthenticationCertificate.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayAuthenticationCertificate.md deleted file mode 100644 index 0dc2ca4e1c..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayAuthenticationCertificate.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 0108A65B-E322-4783-AB6A-6AF1E1A58AC5 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewayauthenticationcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayAuthenticationCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayAuthenticationCertificate.md ---- - -# Set-AzureRmApplicationGatewayAuthenticationCertificate - -## SYNOPSIS -Updates an authentication certificate for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApplicationGatewayAuthenticationCertificate -ApplicationGateway <PSApplicationGateway> - -Name <String> -CertificateFile <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmApplicationGatewayAuthenticationCertificate** cmdlet updates an authentication certificate for an Azure application gateway. - -## EXAMPLES - -## PARAMETERS - -### -ApplicationGateway -Specifies the name of application gateway for which this cmdlet updates an authentication certificate. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CertificateFile -Specifies the path of the authentication certificate file with which this cmdlet updates the certificate. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the authentication certificate that this cmdlet updates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayAuthenticationCertificate](./Add-AzureRmApplicationGatewayAuthenticationCertificate.md) - -[Get-AzureRmApplicationGatewayAuthenticationCertificate](./Get-AzureRmApplicationGatewayAuthenticationCertificate.md) - -[New-AzureRmApplicationGatewayAuthenticationCertificate](./New-AzureRmApplicationGatewayAuthenticationCertificate.md) - -[Remove-AzureRmApplicationGatewayAuthenticationCertificate](./Remove-AzureRmApplicationGatewayAuthenticationCertificate.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayAutoscaleConfiguration.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayAutoscaleConfiguration.md deleted file mode 100644 index e6edcc527b..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayAutoscaleConfiguration.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewayautoscaleconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayAutoscaleConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayAutoscaleConfiguration.md ---- - -# Set-AzureRmApplicationGatewayAutoscaleConfiguration - -## SYNOPSIS -Updates Autoscale Configuration of an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApplicationGatewayAutoscaleConfiguration -ApplicationGateway <PSApplicationGateway> - -MinCapacity <Int32> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmApplicationGatewayAutoscaleConfiguration** cmdlet modifies the existing autoscale configuration of an Application Gateway. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> $gw = Get-AzureRmApplicationGateway -Name $appgwName -ResourceGroupName $resgpName -PS C:\> $gw = Set-AzureRmApplicationGatewayAutoscaleConfiguration -ApplicationGateway $gw -MinCapacity 5 -PS C:\> $gw = Set-AzureRmApplicationGateway -ApplicationGateway $gw -``` - -The first command gets the application gateway and stores it in $gw variable. -The second command updates the autoscale configuration from the applicationg gateway. -The third command updates the application gateway on Azure. - -## PARAMETERS - -### -ApplicationGateway -The applicationGateway - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinCapacity -Minimum capcity for application gateway. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayBackendAddressPool.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayBackendAddressPool.md deleted file mode 100644 index dd952ea204..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayBackendAddressPool.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: C2C5E0C0-E212-4554-966B-940B1B6FE235 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewaybackendaddresspool -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayBackendAddressPool.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayBackendAddressPool.md ---- - -# Set-AzureRmApplicationGatewayBackendAddressPool - -## SYNOPSIS -Updates a back-end address pool for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApplicationGatewayBackendAddressPool -ApplicationGateway <PSApplicationGateway> -Name <String> - [-BackendIPAddresses <System.Collections.Generic.List`1[System.String]>] - [-BackendFqdns <System.Collections.Generic.List`1[System.String]>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmApplicationGatewayBackendAddressPool** cmdlet updates a back-end address pool for an Azure application gateway. -Back-end addresses can be specified as IP addresses, fully-qualified domain names (FQDN) or IP configurations IDs. - -## EXAMPLES - -### Example 1: Setting a back-end address pool by using FQDNs -``` -PS C:\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Set-AzureRmApplicationGatewayBackendAddressPool -ApplicationGateway $AppGw -Name "Pool02" -BackendFqdns "contoso1.com", "contoso2.com" -``` - -The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01, and stores it in the $AppGw variable. -The second command updates the back-end address pool of the application gateway in $AppGw by using FQDNs. - -### Example 2: Setting a back-end address pool by using backend server IP addresses -``` -PS C:\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Set-AzureRmApplicationGatewayBackendAddressPool -ApplicationGateway $AppGw -Name "Pool02" -BackendIPAddresses "10.10.10.10", "10.10.10.11" -``` - -The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01, and stores it in the $AppGw variable. -The second command updates the back-end address pool of the application gateway in $AppGw by using IP addresses. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway with which this cmdlet associates the back-end address pool. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -BackendFqdns -Specifies a list of back-end IP addresses to use as a back-end server pool. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendIPAddresses -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the back-end address pool. -This back-end address pool must exist in the application gateway. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayBackendAddressPool](./Add-AzureRmApplicationGatewayBackendAddressPool.md) - -[Get-AzureRmApplicationGatewayBackendAddressPool](./Get-AzureRmApplicationGatewayBackendAddressPool.md) - -[New-AzureRmApplicationGatewayBackendAddressPool](./New-AzureRmApplicationGatewayBackendAddressPool.md) - -[Remove-AzureRmApplicationGatewayBackendAddressPool](./Remove-AzureRmApplicationGatewayBackendAddressPool.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayBackendHttpSettings.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayBackendHttpSettings.md deleted file mode 100644 index e37c85dff3..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayBackendHttpSettings.md +++ /dev/null @@ -1,316 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewaybackendhttpsettings -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayBackendHttpSettings.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayBackendHttpSettings.md ---- - -# Set-AzureRmApplicationGatewayBackendHttpSettings - -## SYNOPSIS -Updates back-end HTTP settings for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApplicationGatewayBackendHttpSettings -ApplicationGateway <PSApplicationGateway> -Name <String> - -Port <Int32> -Protocol <String> -CookieBasedAffinity <String> [-RequestTimeout <Int32>] - [-ConnectionDraining <PSApplicationGatewayConnectionDraining>] [-ProbeId <String>] - [-Probe <PSApplicationGatewayProbe>] - [-AuthenticationCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate]>] - [-TrustedRootCertificate <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayTrustedRootCertificate]>] - [-PickHostNameFromBackendAddress] [-HostName <String>] [-AffinityCookieName <String>] [-Path <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Set-AzureRmApplicationGatewayBackendHttpSettings cmdlet updates the back-end Hypertext Transfer Protocol (HTTP) settings for an Azure application gateway. -Back-end HTTP settings are applied to all back-end servers in a pool. - -## EXAMPLES - -### Example 1: Update the back-end HTTP settings for an application gateway -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Set-AzureRmApplicationGatewayBackendHttpSettings -ApplicationGateway $AppGw -Name "Setting02" -Port 88 -Protocol "Http" -CookieBasedAffinity "Disabled" -``` - -The first command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $AppGw variable. -The second command updates the HTTP settings of the application gateway in the $AppGw variable to use port 88, the HTTP protocol and enables cookie-based affinity. - -## PARAMETERS - -### -AffinityCookieName -Cookie name to use for the affinity cookie - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationGateway -Specifies an application gateway object with which this cmdlet associates back-end HTTP settings. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AuthenticationCertificates -Specifies authentication certificates for the application gateway. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionDraining -Connection draining of the backend http settings resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayConnectionDraining -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CookieBasedAffinity -Specifies whether cookie-based affinity should be enabled or disabled for the backend server pool. -The acceptable values for this parameter are: Disabled or Enabled. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostName -Sets host header to be sent to the backend servers. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the back-end HTTP settings object. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Path which should be used as a prefix for all HTTP requests. -If no value is provided for this parameter, then no path will be prefixed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PickHostNameFromBackendAddress -Flag if host header should be picked from the host name of the backend server. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Port -Specifies the port to use for each server in the back-end server pool. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Probe -Specifies a probe to associate with the back-end HTTP settings. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayProbe -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeId -Specifies the ID of the probe to associate with the back-end HTTP settings. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol to use for communication between the application gateway and back-end servers. -The acceptable values for this parameter are: Http and Https. -This parameter is case-sensitive. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Http, Https - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestTimeout -Specifies a request time-out value. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrustedRootCertificate -Application gateway Trusted Root Certificates - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayTrustedRootCertificate] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayBackendHttpSettings]() - -[Get-AzureRmApplicationGatewayBackendHttpSettings]() - -[New-AzureRmApplicationGatewayBackendHttpSettings]() - -[Remove-AzureRmApplicationGatewayBackendHttpSettings]() - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayConnectionDraining.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayConnectionDraining.md deleted file mode 100644 index 8a108504cf..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayConnectionDraining.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewayconnectiondraining -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayConnectionDraining.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayConnectionDraining.md ---- - -# Set-AzureRmApplicationGatewayConnectionDraining - -## SYNOPSIS -Modifies the connection draining configuration of a back-end HTTP settings object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApplicationGatewayConnectionDraining -BackendHttpSettings <PSApplicationGatewayBackendHttpSettings> - -Enabled <Boolean> -DrainTimeoutInSec <Int32> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration** cmdlet modifies the connection draining configuration of a back-end HTTP settings object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Settings = Get-AzureRmApplicationGatewayBackendHttpSettings -Name "Settings01" -ApplicationGateway $AppGw -PS C:\> Set-AzureRmApplicationGatewayConnectionDraining -BackendHttpSettings $poolSetting02 -Enabled $False -DrainTimeoutInSec 3600 -``` - -The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01 and stores it in the $AppGw variable. -The second command gets the back-end HTTP settings named Settings01 for $AppGw and stores the settings in the $Settings variable. -The last command modifies the connection draining configuration of the back-end HTTP settings object stored in $Settings by setting Enabled to False and DrainTimeoutInSec to 3600. - -## PARAMETERS - -### -BackendHttpSettings -The backend http settings - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DrainTimeoutInSec -The number of seconds connection draining is active. -Acceptable values are from 1 second to 3600 seconds. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Whether connection draining is enabled or not. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings -Parameters: BackendHttpSettings (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGateway](./Get-AzureRmApplicationGateway.md) - -[Get-AzureRmApplicationGatewayBackendHttpSettings](./Get-AzureRmApplicationGatewayBackendHttpSettings.md) - -[Get-AzureRmApplicationGatewayConnectionDraining](./Get-AzureRmApplicationGatewayConnectionDraining.md) - -[New-AzureRmApplicationGatewayConnectionDraining](./New-AzureRmApplicationGatewayConnectionDraining.md) - -[Remove-AzureRmApplicationGatewayConnectionDraining](./Remove-AzureRmApplicationGatewayConnectionDraining.md) - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayCustomError.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayCustomError.md deleted file mode 100644 index c037a95666..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayCustomError.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewaycustomerror -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayCustomError.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayCustomError.md ---- - -# Set-AzureRmApplicationGatewayCustomError - -## SYNOPSIS -Updates a custom error in an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApplicationGatewayCustomError -ApplicationGateway <PSApplicationGateway> -StatusCode <String> - -CustomErrorPageUrl <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmApplicationGatewayCustomError** cmdlet updates a custom error in an application gateway. - -## EXAMPLES - -### Example 1: Updates custom error in an application gateway -```powershell -PS C:\> $customError502Url = "https://mycustomerrorpages.blob.core.windows.net/errorpages/502.htm" -PS C:\> $updatedgateway = Set-AzureRmApplicationGatewayCustomError -ApplicationGateway $appgw -StatusCode HttpStatus502 -CustomErrorPageUrl $customError502Url -``` - -This command updates the custom error of http status code 502 in the application gateway $appgw, and returns the updated gateway. - -## PARAMETERS - -### -ApplicationGateway -The Application Gateway - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CustomErrorPageUrl -Error page URL of the application gateway customer error. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StatusCode -Status code of the application gateway customer error. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayFrontendIPConfig.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayFrontendIPConfig.md deleted file mode 100644 index 6dd89d8aa0..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayFrontendIPConfig.md +++ /dev/null @@ -1,236 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 2C024C32-1B03-4BAA-AD31-4974D414C998 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewayfrontendipconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayFrontendIPConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayFrontendIPConfig.md ---- - -# Set-AzureRmApplicationGatewayFrontendIPConfig - -## SYNOPSIS -Modifies a front-end IP address configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -Set-AzureRmApplicationGatewayFrontendIPConfig -ApplicationGateway <PSApplicationGateway> -Name <String> - [-PrivateIPAddress <String>] [-SubnetId <String>] [-PublicIPAddressId <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -Set-AzureRmApplicationGatewayFrontendIPConfig -ApplicationGateway <PSApplicationGateway> -Name <String> - [-PrivateIPAddress <String>] [-Subnet <PSSubnet>] [-PublicIPAddress <PSPublicIpAddress>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmApplicationGatewayFrontendIPConfig** cmdlet updates a front-end IP configuration. -An application gateway supports two types of front-end IP addresses: -- Public IP addresses -- Private IP addresses for which the configuration uses Internal Load Balancing (ILB) -An application gateway can have at most one public IP address and one private IP address. -A public IP address and a private IP address should be added separately as front-end IP addresses. - -## EXAMPLES - -### Example 1: Set a public IP as front-end IP of an application gateway -``` -PS C:\>$PublicIp = New-AzureRmPublicIpAddress -ResourceGroupName "ResourceGroup01" -Name "PublicIp01" -location "West US" -AllocationMethod Dynamic -PS C:\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Set-AzureRmApplicationGatewayFrontendIPConfig -ApplicationGateway $AppGw -Name "FrontEndIp01" -PublicIPAddress $PublicIp -``` - -The first command creates a public IP address object and stores it in the $PublicIp variable. -The second command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01, and stores it in the $AppGw variable. -The third command updates the front-end IP configuration named FrontEndIp01, for the gateway in $AppGw, using the address stored in $PublicIp. - -### Example 2: Set a static private IP as the front-end IP of an application gateway -``` -PS C:\>$VNet = Get-AzureRmvirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $VNet -PS C:\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Set-AzureRmApplicationGatewayFrontendIPConfig -ApplicationGateway $AppGw -Name "FrontendIP02" -Subnet $Subnet -PrivateIPAddress 10.0.1.1 -``` - -The first command gets a virtual network named VNet01 that belongs to the resource group named ResourceGroup01, and stores it in the $VNet variable. -The second command gets a subnet configuration named Subnet01 using $VNet from the first command and stores it in the $Subnet variable. -The third command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01, and stores it in the $AppGw variable. -The fourth command adds a front-end IP configuration named FrontendIP02 using $Subnet from the second command and the private IP address 10.0.1.1. - -### Example 3: Set a dynamic private IP as the front-end IP of an application gateway -``` -PS C:\>$VNet = Get-AzureRmvirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $VNet -PS C:\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Set-AzureRmApplicationGatewayFrontendIPConfig -ApplicationGateway $AppGw -Name "FrontendIP02" -Subnet $Subnet -``` - -The first command gets a virtual network named VNet01 that belongs to the resource group named ResourceGroup01, and stores it in the $VNet variable. -The second command gets a subnet configuration named Subnet01 using $VNet from the first command and stores it in the $Subnet variable. -The third command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01, and stores it in the $AppGw variable. -The fourth command adds a front-end IP configuration named FrontendIP02 using $Subnet from the second command. - -## PARAMETERS - -### -ApplicationGateway -Specifies an application gateway object in which to modify the front-end IP configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the front-end IP configuration that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateIPAddress -Specifies the private IP address. -If specified, this IP is statically allocated from the subnet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIPAddress -Specifies the public IP address. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIPAddressId -Specifies the ID of the public IP address. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subnet -Specifies the subnet that the application gateway uses. -Specify this parameter if the gateway uses a private IP address. -If the *PrivateIPAddress* address is specified, it should belong to this subnet. -If *PrivateIPAddress* is not specified, one of the IP addresses from this subnet is dynamically picked up as the front-end IP address of the application gateway. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSSubnet -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetId -Specifies the subnet ID. -Specify this parameter if the gateway uses a private IP address. -If the *PrivateIPAddress* parameter is specified, it should belong to this subnet. -If *PrivateIPAddress* is not specified, one of the IP addresses from this subnet is dynamically picked up as the front-end IP address of the application gateway. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayFrontendIPConfig](./Add-AzureRmApplicationGatewayFrontendIPConfig.md) - -[Add-AzureRmApplicationGatewayFrontendIPConfig](./Add-AzureRmApplicationGatewayFrontendIPConfig.md) - -[Get-AzureRmApplicationGatewayFrontendIPConfig](./Get-AzureRmApplicationGatewayFrontendIPConfig.md) - -[New-AzureRmApplicationGatewayFrontendIPConfig](./New-AzureRmApplicationGatewayFrontendIPConfig.md) - -[Remove-AzureRmApplicationGatewayFrontendIPConfig](./Remove-AzureRmApplicationGatewayFrontendIPConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayFrontendPort.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayFrontendPort.md deleted file mode 100644 index 21593c8241..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayFrontendPort.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 85C0A1C3-FC6D-496A-B6B5-8DC2A73B8032 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewayfrontendport -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayFrontendPort.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayFrontendPort.md ---- - -# Set-AzureRmApplicationGatewayFrontendPort - -## SYNOPSIS -Modifies a front-end port for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApplicationGatewayFrontendPort -ApplicationGateway <PSApplicationGateway> -Name <String> - -Port <Int32> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmApplicationGatewayFrontendPort** cmdlet modifies a front-end port for an -application gateway. - -## EXAMPLES - -### Example 1: Set an application gateway front-end port to 80 -``` -PS C:\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Set-AzureRmApplicationGatewayFrontendPort -ApplicationGateway $AppGw -Name "FrontEndPort01" -Port 80 -``` - -The first command gets the application gateway named ApplicationGateway01 that belongs to the -resource group named ResourceGroup01 and stores it in the $AppGw variable. -The second command modifies the gateway in $AppGw to use port 80 for the front-end port named -FrontEndPort01. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway object with which this cmdlet associates the front-end port. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the front-end port to modify. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Port -Specifies the port number to use for the front-end port. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayFrontendPort](./Add-AzureRmApplicationGatewayFrontendPort.md) - -[Get-AzureRmApplicationGatewayFrontendPort](./Get-AzureRmApplicationGatewayFrontendPort.md) - -[New-AzureRmApplicationGatewayFrontendPort](./New-AzureRmApplicationGatewayFrontendPort.md) - -[Remove-AzureRmApplicationGatewayFrontendPort](./Remove-AzureRmApplicationGatewayFrontendPort.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayHttpListener.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayHttpListener.md deleted file mode 100644 index 943aba1f0b..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayHttpListener.md +++ /dev/null @@ -1,263 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: F8068AF1-3380-4E60-B6CF-CC584BD053A7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewayhttplistener -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayHttpListener.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayHttpListener.md ---- - -# Set-AzureRmApplicationGatewayHttpListener - -## SYNOPSIS -Modifies an HTTP listener for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -Set-AzureRmApplicationGatewayHttpListener -ApplicationGateway <PSApplicationGateway> -Name <String> - [-FrontendIPConfigurationId <String>] [-FrontendPortId <String>] [-SslCertificateId <String>] - [-HostName <String>] [-RequireServerNameIndication <String>] -Protocol <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -Set-AzureRmApplicationGatewayHttpListener -ApplicationGateway <PSApplicationGateway> -Name <String> - [-FrontendIPConfiguration <PSApplicationGatewayFrontendIPConfiguration>] - [-FrontendPort <PSApplicationGatewayFrontendPort>] [-SslCertificate <PSApplicationGatewaySslCertificate>] - [-HostName <String>] [-RequireServerNameIndication <String>] -Protocol <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmApplicationGatewayHttpListener** cmdlet modifies an HTTP listener for an Azure application gateway. - -## EXAMPLES - -### Example 1: Set an HTTP listener -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Set-AzureRmApplicationGatewayHttpListener -ApplicationGateway $AppGw -Name "Listener01" -Protocol Http -FrontendIpConfiguration $FIP01 -FrontendPort 80 -``` - -The first command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $AppGw variable. -The second command sets the HTTP listener for the gateway to use the front-end configuration stored in $FIP01 with the HTTP protocol on port 80. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway with which this cmdlet associates the HTTP listener. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIPConfiguration -Specifies the front-end IP address of the application gateway. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendIPConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIPConfigurationId -Specifies the ID of the front-end IP address of the application gateway. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendPort -Specifies the application gateway front-end port. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendPort -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendPortId -Specifies the application gateway front-end port ID. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostName -Specifies the host name that this cmdlet sends the HTTP listener to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the HTTP listener. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol that the HTTP listener uses. -The acceptable values for this parameter are: -- Http -- Https - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Http, Https - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequireServerNameIndication -Specifies whether the cmdlet requires a server name indication. -The acceptable values for this parameter are: true or false. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: true, false - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SslCertificate -Specifies the SSL certificate of the HTTP listener. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslCertificate -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SslCertificateId -Specifies the Secure Socket Layer (SSL) certificate ID of the HTTP listener. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayHttpListener](./Add-AzureRmApplicationGatewayHttpListener.md) - -[Get-AzureRmApplicationGatewayHttpListener](./Get-AzureRmApplicationGatewayHttpListener.md) - -[New-AzureRmApplicationGatewayHttpListener](./New-AzureRmApplicationGatewayHttpListener.md) - -[Remove-AzureRmApplicationGatewayHttpListener](./Remove-AzureRmApplicationGatewayHttpListener.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayHttpListenerCustomError.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayHttpListenerCustomError.md deleted file mode 100644 index de0314a77d..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayHttpListenerCustomError.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewayhttplistenercustomerror -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayHttpListenerCustomError.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayHttpListenerCustomError.md ---- - -# Set-AzureRmApplicationGatewayHttpListenerCustomError - -## SYNOPSIS -Updates a custom error in a http listener of an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApplicationGatewayHttpListenerCustomError -HttpListener <PSApplicationGatewayHttpListener> - -StatusCode <String> -CustomErrorPageUrl <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmApplicationGatewayCustomError** cmdlet updates a custom error in a http listener of an application gateway. - -## EXAMPLES - -### Example 1: Updates a custom error from a http listener -```powershell -PS C:\> $customError502Url = "https://mycustomerrorpages.blob.core.windows.net/errorpages/502.htm" -PS C:\> $updatedlistener = Set-AzureRmApplicationGatewayCustomError -HttpListener $listener01 -StatusCode HttpStatus502 -CustomErrorPageUrl $customError502Url -``` - -This command updates the custom error of http status code 502 in the http listener $listener01, and returns the updated listener. - -## PARAMETERS - -### -CustomErrorPageUrl -Error page URL of the application gateway customer error. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpListener -The Application Gateway Http Listener - -```yaml -Type: PSApplicationGatewayHttpListener -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -StatusCode -Status code of the application gateway customer error. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayIPConfiguration.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayIPConfiguration.md deleted file mode 100644 index 7c3d48328c..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayIPConfiguration.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 4D5F469D-FF1F-4D49-AC42-26E6DECFAA26 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewayipconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayIPConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayIPConfiguration.md ---- - -# Set-AzureRmApplicationGatewayIPConfiguration - -## SYNOPSIS -Modifies an IP configuration for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -Set-AzureRmApplicationGatewayIPConfiguration -ApplicationGateway <PSApplicationGateway> -Name <String> - [-SubnetId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -Set-AzureRmApplicationGatewayIPConfiguration -ApplicationGateway <PSApplicationGateway> -Name <String> - [-Subnet <PSSubnet>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmApplicationGatewayIPConfiguration** cmdlet modifies an IP configuration. -An IP configuration contains the subnet in which an application gateway is deployed. - -## EXAMPLES - -### Example 1: Set the goal state of an IP configuration -``` -PS C:\>$VNet = Get-AzureRmVirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $VNet -PS C:\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Set-AzureRmApplicationGatewayIPConfiguration -ApplicationGateway $AppGw -Name "AppgwSubnet01" -Subnet $Subnets -``` - -The first command gets the virtual network named VNet01 that belongs to the resource group named ResourceGroup01 and stores it in the $VNet variable. -The second command gets the subnet configuration named Subnet01 using $VNet and stores it in the $Subnet variable. -The third command gets an application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $AppGw variable. -The forth command sets the IP configuration of the application gateway stored in $AppGw to the subnet configuration stored in $Subnet. - -## PARAMETERS - -### -ApplicationGateway -Specifies an application gateway object with which this cmdlet associates an IP configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the IP configuration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subnet -Specifies the subnet. -This is the subnet in which the application gateway is deployed. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSSubnet -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetId -Specifies the subnet ID. -This is the subnet in which the application gateway is deployed. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayIPConfiguration](./Add-AzureRmApplicationGatewayIPConfiguration.md) - -[Add-AzureRmApplicationGatewayIPConfiguration](./Add-AzureRmApplicationGatewayIPConfiguration.md) - -[Get-AzureRmApplicationGatewayIPConfiguration](./Get-AzureRmApplicationGatewayIPConfiguration.md) - -[New-AzureRmApplicationGatewayIPConfiguration](./New-AzureRmApplicationGatewayIPConfiguration.md) - -[Remove-AzureRmApplicationGatewayIPConfiguration](./Remove-AzureRmApplicationGatewayIPConfiguration.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayProbeConfig.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayProbeConfig.md deleted file mode 100644 index 1ca3ec632a..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayProbeConfig.md +++ /dev/null @@ -1,257 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewayprobeconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayProbeConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayProbeConfig.md ---- - -# Set-AzureRmApplicationGatewayProbeConfig - -## SYNOPSIS -Sets the health probe configuration on an existing Application Gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApplicationGatewayProbeConfig -ApplicationGateway <PSApplicationGateway> -Name <String> - -Protocol <String> [-HostName <String>] -Path <String> -Interval <Int32> -Timeout <Int32> - -UnhealthyThreshold <Int32> [-PickHostNameFromBackendHttpSettings] [-MinServers <Int32>] - [-Match <PSApplicationGatewayProbeHealthResponseMatch>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Set-AzureRmApplicationGatewayProbeConfig cmdlet sets the health probe configuration on an existing Application Gateway. - -## EXAMPLES - -### Example 1: Set the configuration for a health probe on an application gateway -``` -PS C:\>Set-AzureRmApplicationGatewayProbeConfig -ApplicationGateway Gateway -Name "Probe05" -Protocol Http -HostName "contoso.com" -Path "/path/custompath.htm" -Interval 30 -Timeout 120 -UnhealthyThreshold 8 -``` - -This command sets the configuration for a health probe named Probe05 for the application gateway named Gateway. -The command also sets the unhealthy threshold to 8 retries and times out after 120 seconds. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway to which this cmdlet sends a probe. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostName -Specifies the host name that this cmdlet sends the probe to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Interval -Specifies the probe interval in seconds. -This is the time interval between two consecutive probes. -This value is between 1 second and 86400 seconds. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Match -Body that must be contained in the health response. -Default value is empty - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayProbeHealthResponseMatch -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinServers -Minimum number of servers that are always marked healthy. -Default value is 0 - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the probe. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the relative path of probe. -Valid paths start with the slash character (/). -The probe is sent to \<Protocol\>://\<host\>:\<port\>\<path\>. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PickHostNameFromBackendHttpSettings -Whether the host header should be picked from the backend http settings. -Default value is false - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol used to send probe. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Http, Https - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Timeout -Specifies the probe timeout in seconds. -This cmdlet marks the probe as failed if a valid response is not received with this timeout period. -Valid values are between 1 second and 86400 seconds. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UnhealthyThreshold -Specifies the probe retry count. -The backend server is marked down after consecutive probe failure count reaches the unhealthy threshold. -Valid values are between 1 second and 20 seconds. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayProbeConfig]() - -[Get-AzureRmApplicationGatewayProbeConfig]() - -[New-AzureRmApplicationGatewayProbeConfig]() - -[Remove-AzureRmApplicationGatewayProbeConfig]() - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayRedirectConfiguration.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayRedirectConfiguration.md deleted file mode 100644 index 9fa4dd0312..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayRedirectConfiguration.md +++ /dev/null @@ -1,208 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewayredirectconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayRedirectConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayRedirectConfiguration.md ---- - -# Set-AzureRmApplicationGatewayRedirectConfiguration - -## SYNOPSIS -Sets the redirect configuration on an existing Application Gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -Set-AzureRmApplicationGatewayRedirectConfiguration -ApplicationGateway <PSApplicationGateway> -Name <String> - -RedirectType <String> [-TargetListenerID <String>] [-IncludePath <Boolean>] [-IncludeQueryString <Boolean>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -Set-AzureRmApplicationGatewayRedirectConfiguration -ApplicationGateway <PSApplicationGateway> -Name <String> - -RedirectType <String> [-TargetListener <PSApplicationGatewayHttpListener>] [-IncludePath <Boolean>] - [-IncludeQueryString <Boolean>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByURL -``` -Set-AzureRmApplicationGatewayRedirectConfiguration -ApplicationGateway <PSApplicationGateway> -Name <String> - -RedirectType <String> [-TargetUrl <String>] [-IncludePath <Boolean>] [-IncludeQueryString <Boolean>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -**The Set-AzureRmApplicationGatewayRequestRoutingRule** cmdlet modifies a redirect configuration. - -## EXAMPLES - -### Example 1 -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Set-AzureRmApplicationGatewayRedirectConfiguration -ApplicationGateway $appgw -Name "RedirectConfig01" -RedirectType Permanent -TargetUrl "https://www.contoso.com" -``` - -The first command gets the application gateway named ApplicationGateway01 and stores it in the $AppGw variable. -The second command modifies the redirect configuration for the application gateway to redirect type Permanent and use a target url. - -## PARAMETERS - -### -ApplicationGateway -The applicationGateway - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludePath -Include path in the redirected url. -Default is true. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeQueryString -Include query string in the redirected url. -Default is true. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the Redirect Configuration - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedirectType -The type of redirect - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Permanent, Found, SeeOther, Temporary - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetListener -HTTPListener to redirect the request to - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetListenerID -ID of listener to redirect the request to - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetUrl -Target URL fo redirection - -```yaml -Type: System.String -Parameter Sets: SetByURL -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayRequestRoutingRule.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayRequestRoutingRule.md deleted file mode 100644 index 78bb7bf9c7..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayRequestRoutingRule.md +++ /dev/null @@ -1,285 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 75A4826A-7A5F-4742-9DC4-DC728CED63D0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewayrequestroutingrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayRequestRoutingRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayRequestRoutingRule.md ---- - -# Set-AzureRmApplicationGatewayRequestRoutingRule - -## SYNOPSIS -Modifies a request routing rule for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -Set-AzureRmApplicationGatewayRequestRoutingRule -ApplicationGateway <PSApplicationGateway> -Name <String> - -RuleType <String> [-BackendHttpSettingsId <String>] [-HttpListenerId <String>] - [-BackendAddressPoolId <String>] [-UrlPathMapId <String>] [-RedirectConfigurationId <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -Set-AzureRmApplicationGatewayRequestRoutingRule -ApplicationGateway <PSApplicationGateway> -Name <String> - -RuleType <String> [-BackendHttpSettings <PSApplicationGatewayBackendHttpSettings>] - [-HttpListener <PSApplicationGatewayHttpListener>] - [-BackendAddressPool <PSApplicationGatewayBackendAddressPool>] [-UrlPathMap <PSApplicationGatewayUrlPathMap>] - [-RedirectConfiguration <PSApplicationGatewayRedirectConfiguration>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmApplicationGatewayRequestRoutingRule** cmdlet modifies a request routing rule. - -## EXAMPLES - -### Example 1: Update a request routing rule -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Set-AzureRmApplicationGatewayRequestRoutingRule -ApplicationGateway $AppGw -Name "Rule01" -RuleType Basic -BackendHttpSettings $Setting -HttpListener $Listener -BackendAddressPool $Pool -``` - -The first command gets the application gateway named ApplicationGateway01 and stores it in the $AppGw variable. -The second command modifies the request routing rule for the application gateway to use back-end HTTP settings specified in the $Setting variable, an HTTP listener specified in the $Listener variable, and a back-end address pool specified in the $Pool variable. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway object with which this cmdlet associates a request routing rule. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -BackendAddressPool -Specifies the application gateway back-end address pool. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendAddressPoolId -Specifies the application gateway back-end address pool ID. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendHttpSettings -Specifies the application gateway backend HTTP settings. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendHttpSettingsId -Specifies the application gateway back-end HTTP settings ID. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpListener -Specifies the application gateway HTTP listener. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpListenerId -Specifies the application gateway HTTP listener ID. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the request routing rule that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedirectConfiguration -Application gateway RedirectConfiguration - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRedirectConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedirectConfigurationId -ID of the application gateway RedirectConfiguration - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RuleType -Specifies the type of request routing rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Basic, PathBasedRouting - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UrlPathMap -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayUrlPathMap -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UrlPathMapId -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayRequestRoutingRule](./Add-AzureRmApplicationGatewayRequestRoutingRule.md) - -[Get-AzureRmApplicationGatewayRequestRoutingRule](./Get-AzureRmApplicationGatewayRequestRoutingRule.md) - -[New-AzureRmApplicationGatewayRequestRoutingRule](./New-AzureRmApplicationGatewayRequestRoutingRule.md) - -[Remove-AzureRmApplicationGatewayRequestRoutingRule](./Remove-AzureRmApplicationGatewayRequestRoutingRule.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewaySku.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewaySku.md deleted file mode 100644 index 9bfd03020c..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewaySku.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 3D88F561-7FE4-4017-BAC4-8F085AD037A9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewaysku -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewaySku.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewaySku.md ---- - -# Set-AzureRmApplicationGatewaySku - -## SYNOPSIS -Modifies the SKU of an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApplicationGatewaySku -ApplicationGateway <PSApplicationGateway> -Name <String> -Tier <String> - [-Capacity <Int32>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmApplicationGatewaySku** cmdlet modifies the stock keeping unit (SKU) of an application gateway. - -## EXAMPLES - -### Example 1: Update the application gateway SKU -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Set-AzureRmApplicationGatewaySku -ApplicationGateway $AppGw -Name "Standard_Small" -Tier "Standard" -Capacity 2 -``` - -The first command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01, and stores it in the $AppGw variable. -The second command updates the SKU of the application gateway. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway object with which this cmdlet associates the SKU. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Capacity -Specifies the instance count of the application gateway. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the application gateway. -The acceptable values for this parameter are: -- Standard_Small -- Standard_Medium -- Standard_Large -- WAF_Medium -- WAF_Large - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Standard_Small, Standard_Medium, Standard_Large, WAF_Medium, WAF_Large, Standard_v2, WAF_v2 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tier -Specifies the tier of the application gateway. -The acceptable values for this parameter are: -- Standard -- WAF - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Standard, WAF, Standard_v2, WAF_v2 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGatewaySku](./Get-AzureRmApplicationGatewaySku.md) - -[New-AzureRmApplicationGatewaySku](./New-AzureRmApplicationGatewaySku.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewaySslCertificate.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewaySslCertificate.md deleted file mode 100644 index 72e94b7a4f..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewaySslCertificate.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: D7C275E5-BC43-454B-BF1E-48D639C4B4F0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewaysslcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewaySslCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewaySslCertificate.md ---- - -# Set-AzureRmApplicationGatewaySslCertificate - -## SYNOPSIS -Sets the goal state of an SSL certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApplicationGatewaySslCertificate -ApplicationGateway <PSApplicationGateway> -Name <String> - -CertificateFile <String> -Password <SecureString> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmApplicationGatewaySslCertificate** cmdlet sets the goal state of an SSL certificate. - -## EXAMPLES - -### Example 1: Set the goal state of an SSL certificate -``` -PS C:\> $appGW = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $password = ConvertTo-SecureString "P@ssw0rd" -AsPlainText -Force -PS C:\> $cert = Set-AzureRmApplicationGatewaySslCertificate -ApplicationGateway $AppGW -Name "Cert01" -CertificateFile "D:\cert01.pfx" -Password $password -``` - -This command sets the goal state for an SSL certificate from the application gateway named ApplicationGateway01. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway with which the Secure Socket Layer (SSL) certificate is associated. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CertificateFile -Specifies the path of the SSL certificate. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the SSL certificate. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -Specifies the password of the SSL certificate. - -```yaml -Type: System.Security.SecureString -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewaySslCertificate](./Add-AzureRmApplicationGatewaySslCertificate.md) - -[Get-AzureRmApplicationGatewaySslCertificate](./Get-AzureRmApplicationGatewaySslCertificate.md) - -[New-AzureRmApplicationGatewaySslCertificate](./New-AzureRmApplicationGatewaySslCertificate.md) - -[Remove-AzureRmApplicationGatewaySslCertificate](./Remove-AzureRmApplicationGatewaySslCertificate.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewaySslPolicy.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewaySslPolicy.md deleted file mode 100644 index a52182ef5a..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewaySslPolicy.md +++ /dev/null @@ -1,208 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 30A34CA8-AC07-4327-B7B9-19F001DA996A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewaysslpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewaySslPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewaySslPolicy.md ---- - -# Set-AzureRmApplicationGatewaySslPolicy - -## SYNOPSIS -Modifies the SSL policy of an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApplicationGatewaySslPolicy -ApplicationGateway <PSApplicationGateway> - [-DisabledSslProtocols <System.Collections.Generic.List`1[System.String]>] [-PolicyType <String>] - [-PolicyName <String>] [-CipherSuite <System.Collections.Generic.List`1[System.String]>] - [-MinProtocolVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmApplicationGatewaySslPolicy** cmdlet modifies the SSL policy of an application gateway. - -## EXAMPLES - -### 1: -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Set-AzureRmApplicationGatewaySslPolicy -ApplicationGateway $getgw -PolicyType Predefined -PolicyName AppGwSslPolicy20170401 -``` - -The first command gets the application gateway named ApplicationGateway01 and stores it in the $AppGw variable. -This second command modifies the ssl policy to a policy type Predefined and policy name AppGwSslPolicy20170401. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway of the SSL policy that this cmdlet modifies. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CipherSuite -Ssl cipher suites to be enabled in the specified order to application gateway - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisabledSslProtocols -Specifies which protocols are disabled. -The acceptable values for this parameter are: -- TLSv1_0 -- TLSv1_1 -- TLSv1_2 - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: -Accepted values: TLSv1_0, TLSv1_1, TLSv1_2 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinProtocolVersion -Minimum version of Ssl protocol to be supported on application gateway - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: TLSv1_0, TLSv1_1, TLSv1_2 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName -Name of Ssl predefined policy - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyType -Type of Ssl Policy - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Predefined, Custom - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Get-AzureRmApplicationGatewaySslPolicy](./Get-AzureRmApplicationGatewaySslPolicy.md) - -[New-AzureRmApplicationGatewaySslPolicy](./New-AzureRmApplicationGatewaySslPolicy.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayTrustedRootCertificate.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayTrustedRootCertificate.md deleted file mode 100644 index 71aba236e8..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayTrustedRootCertificate.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewaytrustedrootcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayTrustedRootCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayTrustedRootCertificate.md ---- - -# Set-AzureRmApplicationGatewayTrustedRootCertificate - -## SYNOPSIS -Updates a Trusted Root Certificate of an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApplicationGatewayTrustedRootCertificate -ApplicationGateway <PSApplicationGateway> -Name <String> - -CertificateFile <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmApplicationGatewayTrustedRootCertificate** cmdlet modifies the existing trusted root certificate of an Application Gateway. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> $gw = Get-AzureRmApplicationGateway -Name $appgwName -ResourceGroupName $resgpName -PS C:\> $gw = Set-AzureRmApplicationGatewayTrustedRootCertificate -ApplicationGateway $gw -Name $certName --CertificateFile ".\rootCAUpdated.cer" -PS C:\> $gw = Set-AzureRmApplicationGateway -ApplicationGateway $gw -``` - -Above example scenarios shows how to update an existing trusted root certificate when a root certificate is rolled. -The first command gets an application gateway and stores it in the $gw variable. -The second command modifies the existing trusted root certificate with a new root certificate. -The third command updates the application gateway on Azure. - -## PARAMETERS - -### -ApplicationGateway -The applicationGateway - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CertificateFile -Path of certificate CER file - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the TrustedRoot certificate - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayUrlPathMapConfig.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayUrlPathMapConfig.md deleted file mode 100644 index ab1a3b86ba..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayUrlPathMapConfig.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 9F5EC8E7-12E9-40E5-B98D-AAFD8F9F3C37 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewayurlpathmapconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayUrlPathMapConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayUrlPathMapConfig.md ---- - -# Set-AzureRmApplicationGatewayUrlPathMapConfig - -## SYNOPSIS -Sets configuration for an array of URL path mappings to a backend server pool. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -Set-AzureRmApplicationGatewayUrlPathMapConfig -ApplicationGateway <PSApplicationGateway> -Name <String> - -PathRules <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPathRule]> - [-DefaultBackendAddressPoolId <String>] [-DefaultBackendHttpSettingsId <String>] - [-DefaultRedirectConfigurationId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -Set-AzureRmApplicationGatewayUrlPathMapConfig -ApplicationGateway <PSApplicationGateway> -Name <String> - -PathRules <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPathRule]> - [-DefaultBackendAddressPool <PSApplicationGatewayBackendAddressPool>] - [-DefaultBackendHttpSettings <PSApplicationGatewayBackendHttpSettings>] - [-DefaultRedirectConfiguration <PSApplicationGatewayRedirectConfiguration>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmApplicationGatewayUrlPathMapConfig** cmdlet sets configuration for an array of URL path mappings to a backend server pool. - -## EXAMPLES - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway to which this cmdlet sets a URL path map configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultBackendAddressPool -Specifies the default backend address pool to route in case none of the rules specified in the *pathRules* parameter match. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultBackendAddressPoolId -Specifies the default backend address pool ID. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultBackendHttpSettings -Specifies the default backend HTTP settings to use in case none of the rules specified in the *pathRules* parameter match. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultBackendHttpSettingsId -Specifies the default backend HTTP settings ID. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultRedirectConfiguration -Application gateway default RedirectConfiguration - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRedirectConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultRedirectConfigurationId -ID of the application gateway default RedirectConfiguration - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the URL path map name in which this cmdlet sets configuration for. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PathRules -Specifies a list of path rules. -Note that the path rules are order sensitive, they are applied in order they are specified. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPathRule] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayUrlPathMapConfig](./Add-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[Get-AzureRmApplicationGatewayUrlPathMapConfig](./Get-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[New-AzureRmApplicationGatewayUrlPathMapConfig](./New-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[Remove-AzureRmApplicationGatewayUrlPathMapConfig](./Remove-AzureRmApplicationGatewayUrlPathMapConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md deleted file mode 100644 index 73c0601af9..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md +++ /dev/null @@ -1,274 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 46FDE4D8-08E0-4465-8BF9-849A108628B8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewaywebapplicationfirewallconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md ---- - -# Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration - -## SYNOPSIS -Modifies the WAF configuration of an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration -ApplicationGateway <PSApplicationGateway> - -Enabled <Boolean> -FirewallMode <String> [-RuleSetType <String>] [-RuleSetVersion <String>] - [-DisabledRuleGroup <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallDisabledRuleGroup]>] - [-RequestBodyCheck <Boolean>] [-MaxRequestBodySizeInKb <Int32>] [-FileUploadLimitInMb <Int32>] - [-Exclusion <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallExclusion]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration** cmdlet modifies the web application firewall (WAF) configuration of an application gateway. - -## EXAMPLES - -### Example 1: Update the application gateway web application firewall configuration -``` -PS C:\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration -ApplicationGateway $AppGw -Enabled $True -FirewallMode "Detection" -RuleSetType "OWASP" -RuleSetVersion "3.0" -``` - -The first command gets the application gateway named ApplicationGateway01 and then stores it in the $AppGw variable. -The second command enables the firewall configuration for the application gateway stored in $AppGw and sets the firewall mode to "Detection", RuleSetType to "OWASP" and the RuleSetVersion to "3.0". - -## PARAMETERS - -### -ApplicationGateway -Specifies an application gateway object. -You can use the Get-AzureRmApplicationGateway cmdlet to get an application gateway object. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisabledRuleGroup -The disabled rule groups. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallDisabledRuleGroup] -Parameter Sets: (All) -Aliases: DisabledRuleGroups - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Indicates whether the web application firewall is enabled. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Exclusion -The exclusion lists. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallExclusion] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileUploadLimitInMb -Max file upload limit in MB. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FirewallMode -Specifies the web application firewall mode. -The acceptable values for this parameter are: -- Detection -- Prevention - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Detection, Prevention - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxRequestBodySizeInKb -Max request body size in KB. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestBodyCheck -Whether request body is checked or not. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RuleSetType -The type of the web application firewall rule set. -The acceptable values for this parameter are: -- OWASP - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: OWASP - -Required: False -Position: Named -Default value: OWASP -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RuleSetVersion -The version of the rule set type. -The acceptable values for this parameter are: -- 3.0 -- 2.2.9 - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: 3.0, 2.2.9 - -Required: False -Position: Named -Default value: 3.0 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGateway](./Get-AzureRmApplicationGateway.md) - -[Get-AzureRmApplicationGatewayWebApplicationFirewallConfiguration](./Get-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md) - -[New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration](./New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmExpressRouteCircuit.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmExpressRouteCircuit.md deleted file mode 100644 index 16cfac5220..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmExpressRouteCircuit.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 2A3B7343-9AA0-4505-AEDE-31C0C5B98694 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermexpressroutecircuit -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmExpressRouteCircuit.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmExpressRouteCircuit.md ---- - -# Set-AzureRmExpressRouteCircuit - -## SYNOPSIS -Modifies an ExpressRoute circuit. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmExpressRouteCircuit -ExpressRouteCircuit <PSExpressRouteCircuit> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmExpressRouteCircuit** cmdlet saves the modified ExpressRoute circuit to Azure. - -## EXAMPLES - -### Example 1: Change the ServiceKey of an ExpressRoute circuit -``` -$ckt = Get-AzureRmExpressRouteCircuit -Name $CircuitName -ResourceGroupName $rg -$ckt.ServiceKey = '64ce99dd-ee70-4e74-b6b8-91c6307433a0' -Set-AzureRmExpressRouteCircuit -ExpressRouteCircuit $ckt -``` - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpressRouteCircuit -Specifies the **ExpressRouteCircuit** object that this cmdlet modifies. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit -Parameters: ExpressRouteCircuit (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit - -## NOTES - -## RELATED LINKS - -[Get-AzureRmExpressRouteCircuit](./Get-AzureRmExpressRouteCircuit.md) - -[Move-AzureRmExpressRouteCircuit](./Move-AzureRmExpressRouteCircuit.md) - -[New-AzureRmExpressRouteCircuit](./New-AzureRmExpressRouteCircuit.md) - -[Remove-AzureRmExpressRouteCircuit](./Remove-AzureRmExpressRouteCircuit.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmExpressRouteCircuitPeeringConfig.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmExpressRouteCircuitPeeringConfig.md deleted file mode 100644 index d103d8f7f1..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmExpressRouteCircuitPeeringConfig.md +++ /dev/null @@ -1,357 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 6C0281EC-4D23-4BD0-A268-4C278ABC7B1A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermexpressroutecircuitpeeringconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmExpressRouteCircuitPeeringConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmExpressRouteCircuitPeeringConfig.md ---- - -# Set-AzureRmExpressRouteCircuitPeeringConfig - -## SYNOPSIS -Saves a modified ExpressRoute peering configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Set-AzureRmExpressRouteCircuitPeeringConfig -Name <String> -ExpressRouteCircuit <PSExpressRouteCircuit> - -PeeringType <String> -PeerASN <UInt32> -PrimaryPeerAddressPrefix <String> - -SecondaryPeerAddressPrefix <String> -VlanId <Int32> [-SharedKey <String>] - [-MicrosoftConfigAdvertisedPublicPrefixes <System.Collections.Generic.List`1[System.String]>] - [-MicrosoftConfigCustomerAsn <Int32>] [-MicrosoftConfigRoutingRegistryName <String>] - [-PeerAddressType <String>] [-LegacyMode <Boolean>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### MicrosoftPeeringConfigRoutFilterId -``` -Set-AzureRmExpressRouteCircuitPeeringConfig -Name <String> -ExpressRouteCircuit <PSExpressRouteCircuit> - -PeeringType <String> -PeerASN <UInt32> -PrimaryPeerAddressPrefix <String> - -SecondaryPeerAddressPrefix <String> -VlanId <Int32> [-SharedKey <String>] - [-MicrosoftConfigAdvertisedPublicPrefixes <System.Collections.Generic.List`1[System.String]>] - [-MicrosoftConfigCustomerAsn <Int32>] [-MicrosoftConfigRoutingRegistryName <String>] -RouteFilterId <String> - [-PeerAddressType <String>] [-LegacyMode <Boolean>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### MicrosoftPeeringConfigRoutFilter -``` -Set-AzureRmExpressRouteCircuitPeeringConfig -Name <String> -ExpressRouteCircuit <PSExpressRouteCircuit> - -PeeringType <String> -PeerASN <UInt32> -PrimaryPeerAddressPrefix <String> - -SecondaryPeerAddressPrefix <String> -VlanId <Int32> [-SharedKey <String>] - [-MicrosoftConfigAdvertisedPublicPrefixes <System.Collections.Generic.List`1[System.String]>] - [-MicrosoftConfigCustomerAsn <Int32>] [-MicrosoftConfigRoutingRegistryName <String>] - -RouteFilter <PSRouteFilter> [-PeerAddressType <String>] [-LegacyMode <Boolean>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmExpressRouteCircuitPeeringConfig** cmdlets saves a modified ExpressRoute peering -configuration back to Azure. - -## EXAMPLES - -### Example 1: Change an existing peering configuration -``` -$circuit = Get-AzureRmExpressRouteCircuit -Name $CircuitName -ResourceGroupName $rg -$parameters = @{ - Name = 'AzurePrivatePeering' - Circuit = $circuit - PeeringType = 'AzurePrivatePeering' - PeerASN = 100 - PrimaryPeerAddressPrefix = '10.6.1.0/30' - SecondaryPeerAddressPrefix = '10.6.2.0/30' - VlanId = 201 -} -Set-AzureRmExpressRouteCircuitPeeringConfig @parameters -Set-AzureRmExpressRouteCircuit -ExpressRouteCircuit $circuit -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpressRouteCircuit -The ExpressRoute circuit object containing the peering configuration to be modified. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LegacyMode -The legacy mode of the Peering - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MicrosoftConfigAdvertisedPublicPrefixes -For a PeeringType of MicrosoftPeering, you must provide a list of all prefixes you plan to -advertise over the BGP session. Only public IP address prefixes are accepted. You can send a comma -separated list if you plan to send a set of prefixes. These prefixes must be registered to you in -a Routing Registry Name (RIR / IRR). - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MicrosoftConfigCustomerAsn -If you are advertising prefixes that are not registered to the peering AS number, you can specify -the AS number to which they are registered. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MicrosoftConfigRoutingRegistryName -The Routing Registry Name (RIR / IRR) to which the AS number and prefixes are registered. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the peering configuration to be modified. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PeerAddressType -PeerAddressType - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: IPv4, IPv6 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PeerASN -The AS number of your ExpressRoute circuit. This must be a Public ASN when the PeeringType is -AzurePublicPeering. - -```yaml -Type: System.UInt32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PeeringType -The acceptable values for this parameter are: `AzurePrivatePeering`, `AzurePublicPeering`, and -`MicrosoftPeering` - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: AzurePrivatePeering, AzurePublicPeering, MicrosoftPeering - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimaryPeerAddressPrefix -This is the IP Address range for the primary routing path of this peering relationship. This must -be a /30 CIDR subnet. The first odd-numbered address in this subnet should be assigned to your -router interface. Azure will configure the next even-numbered address to the Azure router interface. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteFilter -This is an existing RouteFilter object. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSRouteFilter -Parameter Sets: MicrosoftPeeringConfigRoutFilter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RouteFilterId -This is the resource Id of an existing RouteFilter object. - -```yaml -Type: System.String -Parameter Sets: MicrosoftPeeringConfigRoutFilterId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecondaryPeerAddressPrefix -This is the IP Address range for the secondary routing path of this peering relationship. This must -be a /30 CIDR subnet. The first odd-numbered address in this subnet should be assigned to your -router interface. Azure will configure the next even-numbered address to the Azure router interface. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharedKey -This is an optional MD5 hash used as a pre-shared key for the peering configuration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VlanId -This is the Id number of the VLAN assigned for this peering. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit -Parameters: ExpressRouteCircuit (ByValue) - -### System.String - -### Microsoft.Azure.Commands.Network.Models.PSRouteFilter - -### System.Boolean - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit - -## NOTES - -## RELATED LINKS - -[Add-AzureRmExpressRouteCircuitPeeringConfig](Add-AzureRmExpressRouteCircuitPeeringConfig.md) - -[Get-AzureRmExpressRouteCircuit](Get-AzureRmExpressRouteCircuit.md) - -[New-AzureRmExpressRouteCircuitPeeringConfig](New-AzureRmExpressRouteCircuitPeeringConfig.md) - -[Remove-AzureRmExpressRouteCircuitPeeringConfig](Remove-AzureRmExpressRouteCircuitPeeringConfig.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmExpressRoutePort.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmExpressRoutePort.md deleted file mode 100644 index 94fd2894d4..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmExpressRoutePort.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermexpressrouteport -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmExpressRoutePort.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmExpressRoutePort.md ---- - -# Set-AzureRmExpressRoutePort - -## SYNOPSIS -Modifies an ExpressRoutePort. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmExpressRoutePort -ExpressRoutePort <PSExpressRoutePort> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmExpressRoutePort** cmdlet saves the modified ExpressRoutePort to Azure. - -## EXAMPLES - -### Example 1 -```powershell -$erport = Get-AzureRmExpressRoutePort -Name $PortName -ResourceGroupName $rg -$erport.Links[0].AdminState = 'Enabled' -Set-AzureRmExpressRoutePort -ExpressRoutePort $erport -``` - -### Example 2 -```powershell -$erport = Get-AzureRmExpressRoutePort -Name $PortName -ResourceGroupName $rg -$erport.Links[0].AdminState = 'Enabled' -Set-AzureRmExpressRoutePort -InputObject $erport -``` - -Modifies the admin state of a link of an ExpressRoutePort - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpressRoutePort -The ExpressRoutePort object. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort -Parameter Sets: (All) -Aliases: InputObject - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmFirewall.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmFirewall.md deleted file mode 100644 index b935480a63..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmFirewall.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 40E56EC1-3327-4DFF-8262-E2EEBB5E4447 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermfirewall -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmFirewall.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmFirewall.md ---- - -# Set-AzureRmFirewall - -## SYNOPSIS -Saves a modified Firewall. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmFirewall -AzureFirewall <PSAzureFirewall> [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmFirewall** cmdlet updates an Azure Firewall. - -## EXAMPLES - -### 1: Update priority of a Firewall application rule collection -``` -$azFw = Get-AzureRmFirewall -Name "AzureFirewall" -ResourceGroupName "rg" -$ruleCollection = $azFw.GetApplicationRuleCollectionByName("ruleCollectionName") -$ruleCollection.Priority = 101 -Set-AzureRmFirewall -Firewall $azFw -``` - -This example updates the priority of an existing rule collection of an Azure Firewall. -Assuming Azure Firewall "AzureFirewall" in resource group "rg" contains an application rule collection named -"ruleCollectionName", the commands above will change the priority of that rule collection and update the -Azure Firewall afterwards. Without the Set-AzureRmFirewall command, all operations performed on the local $azFw -object are not reflected on the server. - -### 2: Create a Azure Firewall and set an application rule collection later -``` -$azFw = New-AzureRmFirewall -Name "AzureFirewall" -ResourceGroupName "rg" -VirtualNetworkName "vnet-name" -PublicIpName "pip-name" - -$rule = New-AzureRmFirewallApplicationRule -Name R1 -Protocol "http:80","https:443" -TargetFqdn "*google.com", "*microsoft.com" -SourceAddress "10.0.0.0" -$RuleCollection = New-AzureRmFirewallApplicationRuleCollection -Name RC1 -Priority 100 -Rule $rule -ActionType "Allow" -$azFw.ApplicationRuleCollections = $RuleCollection - -$azFw | Set-AzureRmFirewall -``` - -In this example, a Firewall is created first without any application rule collections. Afterwards a Application Rule -and Application Rule Collection are created, then the Firewall object is modified in memory, without affecting -the real configuration in cloud. For changes to be reflected in cloud, Set-AzureRmFirewall must be called. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AzureFirewall -The AzureFirewall - -```yaml -Type: PSAzureFirewall -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSAzureFirewall -Parameter 'AzureFirewall' accepts value of type 'PSAzureFirewall' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSAzureFirewall - -## NOTES - -## RELATED LINKS - -[Get-AzureRmFirewall](./Get-AzureRmFirewall.md) - -[New-AzureRmFirewall](./New-AzureRmFirewall.md) - -[Remove-AzureRmFirewall](./Remove-AzureRmFirewall.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmLoadBalancer.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmLoadBalancer.md deleted file mode 100644 index 4a4eb7eb87..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmLoadBalancer.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 494E185D-3746-4959-846E-660017A1F392 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermloadbalancer -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmLoadBalancer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmLoadBalancer.md ---- - -# Set-AzureRmLoadBalancer - -## SYNOPSIS -Sets the goal state for a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmLoadBalancer -LoadBalancer <PSLoadBalancer> [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmLoadBalancer** cmdlet sets the goal state for an Azure load balancer. - -## EXAMPLES - -### Example 1: Modify a load balancer -``` -PS C:\>$slb = Get-AzureRmLoadBalancer -Name "NRPLB" -ResourceGroupName "NRP-RG" -PS C:\> $slb | Add-AzureRmLoadBalancerInboundNatRuleConfig -Name "NewRule" -FrontendIpConfiguration $slb.FrontendIpConfigurations[0] -FrontendPort 81 -BackendPort 8181 -Protocol "TCP" -PS C:\> $slb | Set-AzureRmLoadBalancer -``` - -The first command gets the load balancer named NRPLB, and then stores it in the $slb variable. -The second command uses the pipeline operator to pass the load balancer in $slb to Add-AzureRmLoadBalancerInboundNatRuleConfig, which adds an inbound NAT rule named NewRule. -The third command passes the load balancer to **Set-AzureRmLoadBalancer**, which updates the load balancer configuration and saves it. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancer -Specifies a load balancer. -This cmdlet sets the goal state for the load balancer that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameters: LoadBalancer (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[New-AzureRmLoadBalancer](./New-AzureRmLoadBalancer.md) - -[Remove-AzureRmLoadBalancer](./Remove-AzureRmLoadBalancer.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmLoadBalancerFrontendIpConfig.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmLoadBalancerFrontendIpConfig.md deleted file mode 100644 index 264ae5cadd..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmLoadBalancerFrontendIpConfig.md +++ /dev/null @@ -1,265 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: C23BEF37-D472-43EC-90AA-F8742247ABA2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermloadbalancerfrontendipconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmLoadBalancerFrontendIpConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmLoadBalancerFrontendIpConfig.md ---- - -# Set-AzureRmLoadBalancerFrontendIpConfig - -## SYNOPSIS -Sets the goal state for a front-end IP configuration in a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceSubnet (Default) -``` -Set-AzureRmLoadBalancerFrontendIpConfig -LoadBalancer <PSLoadBalancer> -Name <String> - [-PrivateIpAddress <String>] [-Zone <System.Collections.Generic.List`1[System.String]>] -Subnet <PSSubnet> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByResourceIdSubnet -``` -Set-AzureRmLoadBalancerFrontendIpConfig -LoadBalancer <PSLoadBalancer> -Name <String> - [-PrivateIpAddress <String>] [-Zone <System.Collections.Generic.List`1[System.String]>] -SubnetId <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByResourceIdPublicIpAddress -``` -Set-AzureRmLoadBalancerFrontendIpConfig -LoadBalancer <PSLoadBalancer> -Name <String> - [-Zone <System.Collections.Generic.List`1[System.String]>] -PublicIpAddressId <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByResourcePublicIpAddress -``` -Set-AzureRmLoadBalancerFrontendIpConfig -LoadBalancer <PSLoadBalancer> -Name <String> - [-Zone <System.Collections.Generic.List`1[System.String]>] -PublicIpAddress <PSPublicIpAddress> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmLoadBalancerFrontendIpConfig** cmdlet sets the goal state for a front-end IP configuration in an Azure load balancer. - -## EXAMPLES - -### Example 1: Modify the front-end IP configuration of a load balancer -``` -PS C:\>$Subnet = Get-AzureRmVirtualNetwork -Name "MyVnet" -ResourceGroupName "MyResourceGroup" | Get-AzureRmVirtualNetworkSubnetConfig -Name "Subnet" -PS C:\> $slb = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -PS C:\> $slb | Add-AzureRmLoadBalancerFrontendIpConfig -Name "NewFrontend" -Subnet $Subnet -PS C:\> $slb | Set-AzureRmLoadBalancerFrontendIpConfig -Name "NewFrontend" -Subnet $Subnet -``` - -The first command gets the virtual subnet named Subnet, and then stores it in the $Subnet variable. -The second command gets the associated load balancer named MyLoadBalancer, and then stores it in the $slb variable. -The third command uses the pipeline operator to pass the load balancer in $slb to Add-AzureRmLoadBalancerFrontendIpConfig, which creates a front-end IP configuration named NewFrontend for $slb. -The fourth command passes the load balancer in $slb to **Set-AzureRmLoadBalancerFrontendIpConfig**, which saves and updates the front-end IP configuration. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancer -Specifies a load balancer. -This cmdlet sets the goal state for a front-end configuration for the load balancer that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the front-end IP configuration to set. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateIpAddress -Specifies the private IP address of the load balancer that is associated with the front-end IP configuration to set. -Specify this parameter only if you also specify the *Subnet* parameter. - -```yaml -Type: System.String -Parameter Sets: SetByResourceSubnet, SetByResourceIdSubnet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublicIpAddress -Specifies the **PublicIpAddress** object that is associated with the front-end IP configuration to set. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress -Parameter Sets: SetByResourcePublicIpAddress -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublicIpAddressId -Specifies the ID of the **PublicIpAddress** object that is associated with the front-end IP configuration that this cmdlet sets. - -```yaml -Type: System.String -Parameter Sets: SetByResourceIdPublicIpAddress -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Subnet -Specifies the **Subnet** object that contains the front-end IP configuration that this cmdlet sets. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSSubnet -Parameter Sets: SetByResourceSubnet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubnetId -Specifies the ID of the subnet that contains the front-end IP configuration that this cmdlet sets. - -```yaml -Type: System.String -Parameter Sets: SetByResourceIdSubnet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Zone -A list of availability zones denoting the IP allocated for the resource needs to come from. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameters: LoadBalancer (ByValue) - -### System.Collections.Generic.List\`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerFrontendIpConfig](./Add-AzureRmLoadBalancerFrontendIpConfig.md) - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[Get-AzureRmLoadBalancerFrontendIpConfig](./Get-AzureRmLoadBalancerFrontendIpConfig.md) - -[Get-AzureRmVirtualNetwork](./Get-AzureRmVirtualNetwork.md) - -[New-AzureRmLoadBalancerFrontendIpConfig](./New-AzureRmLoadBalancerFrontendIpConfig.md) - -[Remove-AzureRmLoadBalancerFrontendIpConfig](./Remove-AzureRmLoadBalancerFrontendIpConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmLoadBalancerInboundNatPoolConfig.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmLoadBalancerInboundNatPoolConfig.md deleted file mode 100644 index 361a8e763a..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmLoadBalancerInboundNatPoolConfig.md +++ /dev/null @@ -1,267 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 355DF798-6233-45C6-9416-8AB0E0D7DC02 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermloadbalancerinboundnatpoolconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmLoadBalancerInboundNatPoolConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmLoadBalancerInboundNatPoolConfig.md ---- - -# Set-AzureRmLoadBalancerInboundNatPoolConfig - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Set-AzureRmLoadBalancerInboundNatPoolConfig -LoadBalancer <PSLoadBalancer> -Name <String> -Protocol <String> - -FrontendPortRangeStart <Int32> -FrontendPortRangeEnd <Int32> -BackendPort <Int32> - [-IdleTimeoutInMinutes <Int32>] [-EnableFloatingIP] [-EnableTcpReset] - [-FrontendIpConfiguration <PSFrontendIPConfiguration>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### SetByResourceId -``` -Set-AzureRmLoadBalancerInboundNatPoolConfig -LoadBalancer <PSLoadBalancer> -Name <String> -Protocol <String> - -FrontendPortRangeStart <Int32> -FrontendPortRangeEnd <Int32> -BackendPort <Int32> - [-IdleTimeoutInMinutes <Int32>] [-EnableFloatingIP] [-EnableTcpReset] [-FrontendIpConfigurationId <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION - -## EXAMPLES - -### 1: Set -``` -PS C:\> $slb = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -PS C:\> $feIpConfig = Get-AzureRmLoadBalancerFrontendIpConfig -Name "FrontendName" -LoadBalancer $slb -PS C:\> Set-AzureRmLoadBalancerInboundNatPoolConfig -Name "myInboundNatPool" -LoadBalancer $slb -FrontendIpConfigurationId $inboundNatPoolConfig.FrontendIPConfiguration -Protocol TCP -FrontendPortRangeStart 2001 -FrontendPortRangeEnd 3000 -BackendPort 2001 -``` - -## PARAMETERS - -### -BackendPort -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableFloatingIP -Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableTcpReset -Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIpConfiguration -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FrontendIpConfigurationId -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FrontendPortRangeEnd -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FrontendPortRangeStart -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IdleTimeoutInMinutes -The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancer -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameters: LoadBalancer (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerInboundNatPoolConfig](./Add-AzureRmLoadBalancerInboundNatPoolConfig.md) - -[Get-AzureRmLoadBalancerInboundNatPoolConfig](./Get-AzureRmLoadBalancerInboundNatPoolConfig.md) - -[New-AzureRmLoadBalancerInboundNatPoolConfig](./New-AzureRmLoadBalancerInboundNatPoolConfig.md) - -[Remove-AzureRmLoadBalancerInboundNatPoolConfig](./Remove-AzureRmLoadBalancerInboundNatPoolConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmLoadBalancerInboundNatRuleConfig.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmLoadBalancerInboundNatRuleConfig.md deleted file mode 100644 index 927fab9071..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmLoadBalancerInboundNatRuleConfig.md +++ /dev/null @@ -1,278 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 87818605-EFA6-422E-9ECD-0A0BF269DCFD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermloadbalancerinboundnatruleconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmLoadBalancerInboundNatRuleConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmLoadBalancerInboundNatRuleConfig.md ---- - -# Set-AzureRmLoadBalancerInboundNatRuleConfig - -## SYNOPSIS -Sets an inbound NAT rule configuration for a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Set-AzureRmLoadBalancerInboundNatRuleConfig -LoadBalancer <PSLoadBalancer> -Name <String> [-Protocol <String>] - [-FrontendPort <Int32>] [-BackendPort <Int32>] [-IdleTimeoutInMinutes <Int32>] [-EnableFloatingIP] - [-EnableTcpReset] [-FrontendIpConfiguration <PSFrontendIPConfiguration>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByResourceId -``` -Set-AzureRmLoadBalancerInboundNatRuleConfig -LoadBalancer <PSLoadBalancer> -Name <String> [-Protocol <String>] - [-FrontendPort <Int32>] [-BackendPort <Int32>] [-IdleTimeoutInMinutes <Int32>] [-EnableFloatingIP] - [-EnableTcpReset] [-FrontendIpConfigurationId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmLoadBalancerInboundNatRuleConfig** cmdlet sets an inbound network address translation (NAT) rule configuration for an Azure load balancer. - -## EXAMPLES - -### Example 1: Modify the inbound NAT rule configuration on a load balancer -``` -PS C:\>$slb = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -PS C:\> $slb | Add-AzureRmLoadBalancerInboundNatRuleConfig -Name "NewNatRule" -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol "Tcp" -FrontendPort 3350 -BackendPort 3350 -EnableFloatingIP -PS C:\> $slb | Set-AzureRmLoadBalancerInboundNatRuleConfig -Name "NewNatRule" -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol "Tcp" -FrontendPort 3350 -BackendPort 3350 -``` - -The first command gets the load balancer named MyLoadBalancer, and then stores it in the $slb variable. -The second command uses the pipeline operator to pass the load balancer in $slb to Add-AzureRmLoadBalancerInboundNatRuleConfig, which adds an inbound NAT rule configuration to it. -The third command passes the load balancer to **Set-AzureRmLoadBalancerInboundNatRuleConfig**, which saves and updates the inbound NAT rule configuration. -Note that the rule configuration was set without enabling floating IP, which had been enabled by the previous command. - -## PARAMETERS - -### -BackendPort -Specifies the backend port for traffic that is matched by this rule configuration. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableFloatingIP -Indicates that this cmdlet enables a floating IP address for a rule configuration. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableTcpReset -Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIpConfiguration -Specifies a list of front-end IP addresses to associate with an inbound NAT rule configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FrontendIpConfigurationId -Specifies the ID for a front-end IP address configuration. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FrontendPort -Specifies the front-end port that is matched by a load balancer rule configuration. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IdleTimeoutInMinutes -Specifies the length of time, in minutes, that the state of conversations is maintained in a load balancer. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancer -Specifies a load balancer. -This cmdlet sets an inbound NAT rule configuration for the load balancer that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of an inbound NAT rule configuration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol that is matched by an inbound NAT rule configuration. -The acceptable values for this parameter are: Tcp or Udp. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameters: LoadBalancer (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerInboundNatRuleConfig](./Add-AzureRmLoadBalancerInboundNatRuleConfig.md) - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[Get-AzureRmLoadBalancerInboundNatRuleConfig](./Get-AzureRmLoadBalancerInboundNatRuleConfig.md) - -[New-AzureRmLoadBalancerInboundNatRuleConfig](./New-AzureRmLoadBalancerInboundNatRuleConfig.md) - -[Remove-AzureRmLoadBalancerInboundNatRuleConfig](./Remove-AzureRmLoadBalancerInboundNatRuleConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmLoadBalancerOutboundRuleConfig.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmLoadBalancerOutboundRuleConfig.md deleted file mode 100644 index c0a19e1c34..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmLoadBalancerOutboundRuleConfig.md +++ /dev/null @@ -1,256 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermloadbalanceroutboundruleconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmLoadBalancerOutboundRuleConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmLoadBalancerOutboundRuleConfig.md ---- - -# Set-AzureRmLoadBalancerOutboundRuleConfig - -## SYNOPSIS -Sets an outbound rule configuration for a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Set-AzureRmLoadBalancerOutboundRuleConfig -LoadBalancer <PSLoadBalancer> -Name <String> - [-AllocatedOutboundPort <Int32>] -Protocol <String> [-EnableTcpReset] [-IdleTimeoutInMinutes <Int32>] - -FrontendIpConfiguration <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSResourceId]> - -BackendAddressPool <PSBackendAddressPool> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### SetByResourceId -``` -Set-AzureRmLoadBalancerOutboundRuleConfig -LoadBalancer <PSLoadBalancer> -Name <String> - [-AllocatedOutboundPort <Int32>] -Protocol <String> [-EnableTcpReset] [-IdleTimeoutInMinutes <Int32>] - -FrontendIpConfiguration <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSResourceId]> - -BackendAddressPoolId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmLoadBalancerOutboundRuleConfig** cmdlet sets an outbound rule configuration for an Azure load balancer. - -## EXAMPLES - -### Example 1: Modify the outbound rule configuration on a load balancer -```powershell -PS C:\>$slb = Get-AzureRmLoadBalancer -ResourceGroupName "MyResourceGroup" -Name "MyLoadBalancer" -PS C:\>$slb | Add-AzureRmLoadBalancerOutboundRuleConfig -Name "NewRule" -Protocol "Tcp" -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -BackendAddressPool $slb.BackendAddressPools[0] -IdleTimeoutInMinutes 5 -PS C:\>$slb | Set-AzureRmLoadBalancerOutboundRuleConfig -Name "NewRule" -Protocol "Tcp" -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -BackendAddressPool $slb.BackendAddressPools[0] -IdleTimeoutInMinutes 10 -``` - -The first command gets the load balancer named MyLoadBalancer, and then stores it in the $slb variable. -The second command uses the pipeline operator to pass the load balancer in $slb to Add-AzureRmLoadBalancerOutboundRuleConfig, which adds an outbound rule configuration to it. -The third command passes the load balancer to **Set-AzureRmLoadBalancerOutboundRuleConfig**, which saves and updates the outbound rule configuration. - -## PARAMETERS - -### -AllocatedOutboundPort -The number of outbound ports to be used for NAT. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BackendAddressPool -A reference to a pool of DIPs. -Outbound traffic is randomly load balanced across IPs in the backend IPs. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BackendAddressPoolId -A reference to a pool of DIPs. -Outbound traffic is randomly load balanced across IPs in the backend IPs. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableTcpReset -Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. -This element is only used when the protocol is set to TCP. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIpConfiguration -The Frontend IP addresses of the load balancer. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSResourceId] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IdleTimeoutInMinutes -The timeout for the TCP idle connection - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancer -The reference of the load balancer resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the outbound rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Protocol - TCP, UDP or All - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -System.Int32 -System.String -System.Collections.Generic.List\`1[[Microsoft.Azure.Commands.Network.Models.PSResourceId, Microsoft.Azure.Commands.Network, Version=6.5.0.0, Culture=neutral, PublicKeyToken=null]] -Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmLoadBalancerProbeConfig.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmLoadBalancerProbeConfig.md deleted file mode 100644 index 44ccb1eb3b..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmLoadBalancerProbeConfig.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: C8B91455-C1A7-43BD-9E63-A20E2694371F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermloadbalancerprobeconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmLoadBalancerProbeConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmLoadBalancerProbeConfig.md ---- - -# Set-AzureRmLoadBalancerProbeConfig - -## SYNOPSIS -Sets the goal state for a probe configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmLoadBalancerProbeConfig -LoadBalancer <PSLoadBalancer> -Name <String> [-Protocol <String>] - -Port <Int32> -IntervalInSeconds <Int32> -ProbeCount <Int32> [-RequestPath <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmLoadBalancerProbeConfig** cmdlet sets the goal state for a probe configuration. - -## EXAMPLES - -### Example 1: Modify the probe configuration on a load balancer -``` -PS C:\>$slb = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -PS C:\> $slb | Add-AzureRmLoadBalancerProbeConfig -Name "NewProbe" -Protocol "http" -Port 80 -IntervalInSeconds 15 -ProbeCount 2 -RequestPath "healthcheck.aspx" -PS C:\> $slb | Set-AzureRmLoadBalancerProbeConfig -Name "NewProbe" -Port 80 -IntervalInSeconds 15 -ProbeCount 2 -``` - -The first command gets the loadbalancer named MyLoadBalancer, and then stores it in the $slb variable. -The second command uses the pipeline operator to pass the load balancer in $slb to Add-AzureRmLoadBalancerProbeConfig, which adds a new probe configuration to it. -The third command passes the load balancer to **Set-AzureRmLoadBalancerProbeConfig**, which sets the new configuration. -Note that it is necessary to specify several of the same parameters that were specified in the previous command because they are required by the current cmdlet. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IntervalInSeconds -Specifies the interval, in seconds, between probes to each instance of the load-balanced service. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancer -Specifies a load balancer. -This cmdlet sets the goal state for a probe configuration for the load balancer that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the probe configuration that this cmdlet sets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Port -Specifies the port on which probes should connect to a load-balanced service. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProbeCount -Specifies the number of per-instance consecutive failures for an instance to be considered unhealthy. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol to use for the probing. -The acceptable values for this parameter are: Tcp or Http. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RequestPath -Specifies the path in the load-balanced service to probe to determine health. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameters: LoadBalancer (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerProbeConfig](./Add-AzureRmLoadBalancerProbeConfig.md) - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[Get-AzureRmLoadBalancerProbeConfig](./Get-AzureRmLoadBalancerProbeConfig.md) - -[New-AzureRmLoadBalancerProbeConfig](./New-AzureRmLoadBalancerProbeConfig.md) - -[Remove-AzureRmLoadBalancerProbeConfig](./Remove-AzureRmLoadBalancerProbeConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmLoadBalancerRuleConfig.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmLoadBalancerRuleConfig.md deleted file mode 100644 index 5663698338..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmLoadBalancerRuleConfig.md +++ /dev/null @@ -1,371 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 2638B226-B974-43B6-ACC2-D67573CF6B56 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermloadbalancerruleconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmLoadBalancerRuleConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmLoadBalancerRuleConfig.md ---- - -# Set-AzureRmLoadBalancerRuleConfig - -## SYNOPSIS -Sets the goal state for a load balancer rule configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Set-AzureRmLoadBalancerRuleConfig -LoadBalancer <PSLoadBalancer> -Name <String> [-Protocol <String>] - [-LoadDistribution <String>] [-FrontendPort <Int32>] [-BackendPort <Int32>] [-IdleTimeoutInMinutes <Int32>] - [-EnableFloatingIP] [-EnableTcpReset] [-DisableOutboundSNAT] - [-FrontendIpConfiguration <PSFrontendIPConfiguration>] [-BackendAddressPool <PSBackendAddressPool>] - [-Probe <PSProbe>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByResourceId -``` -Set-AzureRmLoadBalancerRuleConfig -LoadBalancer <PSLoadBalancer> -Name <String> [-Protocol <String>] - [-LoadDistribution <String>] [-FrontendPort <Int32>] [-BackendPort <Int32>] [-IdleTimeoutInMinutes <Int32>] - [-EnableFloatingIP] [-EnableTcpReset] [-DisableOutboundSNAT] [-FrontendIpConfigurationId <String>] - [-BackendAddressPoolId <String>] [-ProbeId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmLoadBalancerRuleConfig** cmdlet sets the goal state for a load balancer rule configuration. - -## EXAMPLES - -### Example 1: Modify a load balancing rule configuration -``` -PS C:\>$slb = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -PS C:\> $slb | Add-AzureRmLoadBalancerRuleConfig -Name "NewRule" -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol "Tcp" -FrontendPort 3350 -BackendPort 3350 -EnableFloatingIP -PS C:\> $slb | Set-AzureRmLoadBalancerRuleConfig -Name "NewRule" -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol "Tcp" -FrontendPort 3350 -BackendPort 3350 -``` - -The first command gets the load balancer named MyLoadBalancer, and then stores it in the $slb variable. -The second command uses the pipeline operator to pass the load balancer in $slb to Add-AzureRmLoadBalancerRuleConfig, which adds a rule named NewRule to it. -The third command passes the load balancer to **Set-AzureRmLoadBalancerRuleConfig**, which sets the new rule configuration. -Note that the configuration does not enable a floating IP address, which had been enabled by the previous command. - -## PARAMETERS - -### -BackendAddressPool -Specifies a **BackendAddressPool** object to associate with a load balancer rule. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BackendAddressPoolId -Specifies the ID of a **BackendAddressPool** object to associate with a load balancer rule configuration. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BackendPort -Specifies the backend port for traffic that is matched by this rule configuration. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableOutboundSNAT -Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableFloatingIP -Indicates that this cmdlet enables a floating IP address for a rule configuration. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableTcpReset -Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIpConfiguration -Specifies a list of front-end IP addresses to associate with a load balancer rule configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FrontendIpConfigurationId -Specifies the ID for a front-end IP address configuration. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FrontendPort -Specifies the front-end port that is matched by a load balancer rule configuration. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IdleTimeoutInMinutes -Specifies the length of time, in minutes, for which the state of conversations is maintained in a load balancer. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancer -Specifies a load balancer. -This cmdlet sets the goal state rule configuration for the load balancer that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -LoadDistribution -Specifies a load distribution. -The acceptable values for this parameter are: SourceIP and SourceIPProtocol. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a load balancer. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Probe -Specifies a probe to associate with a load balancer rule configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSProbe -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProbeId -Specifies the ID of the probe to associate with a load balancer rule configuration. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol that is matched by a load balancer rule. -The acceptable values for this parameter are: Tcp or Udp. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer -Parameters: LoadBalancer (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerRuleConfig](./Add-AzureRmLoadBalancerRuleConfig.md) - -[Add-AzureRmLoadBalancerRuleConfig](./Add-AzureRmLoadBalancerRuleConfig.md) - -[Get-AzureRmLoadBalancerRuleConfig](./Get-AzureRmLoadBalancerRuleConfig.md) - -[New-AzureRmLoadBalancerRuleConfig](./New-AzureRmLoadBalancerRuleConfig.md) - -[Remove-AzureRmLoadBalancerRuleConfig](./Remove-AzureRmLoadBalancerRuleConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmLocalNetworkGateway.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmLocalNetworkGateway.md deleted file mode 100644 index 0af12ae8ee..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmLocalNetworkGateway.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: F8C1DF39-1DAF-4BDB-8B0E-1BC3B5E82185 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermlocalnetworkgateway -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmLocalNetworkGateway.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmLocalNetworkGateway.md ---- - -# Set-AzureRmLocalNetworkGateway - -## SYNOPSIS -Modifies a local network gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmLocalNetworkGateway -LocalNetworkGateway <PSLocalNetworkGateway> - [-AddressPrefix <System.Collections.Generic.List`1[System.String]>] [-Asn <UInt32>] - [-BgpPeeringAddress <String>] [-PeerWeight <Int32>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmLocalNetworkGateway** cmdlet modifies a local network gateway. - -## EXAMPLES - -### Example 1 -Set configuration for an existing gateway - - -``` -$lgw = Get-AzureRmLocalNetworkGateway -Name myLocalGW -ResourceGroupName myRG -Set-AzureRmLocalNetworkGateway -LocalNetworkGateway $lgw - -Name : myLocalGW -ResourceGroupName : TestRG1 -Location : westus -Id : /subscriptions/81ab786c-56eb-4a4d-bb5f-f60329772466/resourceGroups/TestRG1/providers/Microso - ft.Network/localNetworkGateways/myLocalGW -Etag : W/"d2de6968-315e-411d-a4b8-a8c335abe61b" -ResourceGuid : 393acf8b-dbb8-4b08-a9ea-c714570710e1 -ProvisioningState : Succeeded -Tags : -GatewayIpAddress : 1.2.3.4 -LocalNetworkAddressSpace : { - "AddressPrefixes": [] - } -BgpSettings : null -``` - -## PARAMETERS - -### -AddressPrefix -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Asn -```yaml -Type: System.UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BgpPeeringAddress -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalNetworkGateway -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSLocalNetworkGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PeerWeight -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLocalNetworkGateway -Parameters: LocalNetworkGateway (ByValue) - -### System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.UInt32 - -### System.String - -### System.Int32 - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLocalNetworkGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLocalNetworkGateway](./Get-AzureRmLocalNetworkGateway.md) - -[New-AzureRmLocalNetworkGateway](./New-AzureRmLocalNetworkGateway.md) - -[Remove-AzureRmLocalNetworkGateway](./Remove-AzureRmLocalNetworkGateway.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmNetworkInterface.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmNetworkInterface.md deleted file mode 100644 index 746f8adb67..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmNetworkInterface.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: DDB38A77-E5C0-47DD-BADD-94488F661CD5 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermnetworkinterface -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmNetworkInterface.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmNetworkInterface.md ---- - -# Set-AzureRmNetworkInterface - -## SYNOPSIS -Sets the goal state for a network interface. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmNetworkInterface -NetworkInterface <PSNetworkInterface> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmNetworkInterface** sets the goal state for an Azure network interface. - -## EXAMPLES - -### Example 1: Configure a network interface -``` -$Nic = Get-AzureRmNetworkInterface -ResourceGroupName "ResourceGroup1" -Name "NetworkInterface1" -$Nic.IpConfigurations[0].PrivateIpAddress = "10.0.1.20" -$Nic.IpConfigurations[0].PrivateIpAllocationMethod = "Static" -$Nic.Tag = @{Name = "Name"; Value = "Value"} -Set-AzureRmNetworkInterface -NetworkInterface $Nic -``` - -This example configures a network interface. -The first command gets a network interface named NetworkInterface1 in resource group ResourceGroup1. -The second command sets the private IP address of the IP configuration. -The third command sets the private IP allocation method to Static. -The fourth command sets a tag on the network interface. -The fifth command uses the information stored in the $Nic variable to set the network interface. - -### Example 2: Change DNS settings on a network interface -``` -$nic = Get-AzureRmNetworkInterface -ResourceGroupName "ResourceGroup1" -Name "NetworkInterface1" -$nic.DnsSettings.DnsServers.Add("192.168.1.100") -$nic | Set-AzureRmNetworkInterface -``` - -The first command gets a network interface named NetworkInterface1 that exists within resource group ResourceGroup1. The second command adds DNS server 192.168.1.100 to this interface. The third command applies these changes to the network interface. To remove a DNS server, follow the commands listed above, but replace ".Add" with ".Remove" in the second command. - -### Example 3: Enable IP forwading on a network interface -``` -$nic = Get-AzureRmNetworkInterface -ResourceGroupName "ResourceGroup1" -Name "NetworkInterface1" -$nic.EnableIPForwarding = 1 -$nic | Set-AzureRmNetworkInterface -``` - -The first command gets an existing network interface called NetworkInterface1 and stores it in the $nic variable. The second command changes the IP forwarding value to true. Finally, the third command applies the changes to the network interface. To disable IP forwarding on a network interface, follow the sample example, but be sure to change the second command to "$nic.EnableIPForwarding = 0". - -### Example 4: Change the subnet of a network interface -``` -$nic = Get-AzureRmNetworkInterface -ResourceGroupName "ResourceGroup1" -Name "NetworkInterface1" -$vnet = Get-AzureRmVirtualNetwork -Name VNet1 -ResourceGroupName crosssubcrossversionpeering -$subnet2 = Get-AzureRmVirtualNetworkSubnetConfig -Name Subnet2 -VirtualNetwork $vnet -$nic.IpConfigurations[0].Subnet.Id = $subnet2.Id -$nic | Set-AzureRmNetworkInterface -``` - -The first command gets the network interface NetworkInterface1 and stores it in the $nic variable. The second command gets the virtual network associated with the subnet that the network interface is going to be associated with. The second command gets the subnet and stores it in the $subnet2 variable. The third command associated the primary private IP address of the network interface with the new subnet. Finally the last command applied these changes on the network interface. ->[!NOTE] ->The IP configurations must be dynamic before you can change the subnet. If you have static IP configurations, change then to dynamic before proceeding. ->[!NOTE] ->If the network interface has multiple IP configurations, the forth command must be done for all these IP configurations before the final Set-AzureRmNetworkInterface command is executed. This can be done as in the forth command but by replacing "0" with the appropriate number. If a network interface has N IP configurations, then N-1 of these commands must exist. - -### Example 5: Associate/Dissociate a Network Security Group to a network interface -``` -$nic = Get-AzureRmNetworkInterface -ResourceGroupName "ResourceGroup1" -Name "NetworkInterface1" -$nsg = Get-AzureRmNetworkSecurityGroup -ResourceGroupName "ResourceGroup1" -Name "MyNSG" -$nic.NetworkSecurityGroup = $nsg -$nic | Set-AzureRmNetworkInterface -``` - -The first command gets an existing network interface called NetworkInterface1 and stores it in the $nic variable. The second command gets an existing network security group called MyNSG and stores it in the $nsg variable. The forth command assigns the $nsg to the $nic. Finally, the fifth command applies the changes to the Network interface. To dissociate network security groups from a network interface, simple replace $nsg in the forth command with $null. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkInterface -Specifies a **NetworkInterface** object that represents the goal state for a network interface. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkInterface -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface -Parameters: NetworkInterface (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface - -## NOTES - -## RELATED LINKS - -[Get-AzureRmNetworkInterface](./Get-AzureRmNetworkInterface.md) - -[Get-AzureRmNetworkInterface](./Get-AzureRmNetworkInterface.md) - -[New-AzureRmNetworkInterface](./New-AzureRmNetworkInterface.md) - -[Remove-AzureRmNetworkInterface](./Remove-AzureRmNetworkInterface.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmNetworkInterfaceIpConfig.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmNetworkInterfaceIpConfig.md deleted file mode 100644 index 864162cf04..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmNetworkInterfaceIpConfig.md +++ /dev/null @@ -1,402 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 13EF1028-43DE-424D-8185-EC45B5CEF2C1 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermnetworkinterfaceipconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmNetworkInterfaceIpConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmNetworkInterfaceIpConfig.md ---- - -# Set-AzureRmNetworkInterfaceIpConfig - -## SYNOPSIS -Sets the goal state for an Azure network interface IP configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Set-AzureRmNetworkInterfaceIpConfig -Name <String> -NetworkInterface <PSNetworkInterface> - [-PrivateIpAddressVersion <String>] [-PrivateIpAddress <String>] [-Primary] [-Subnet <PSSubnet>] - [-PublicIpAddress <PSPublicIpAddress>] - [-LoadBalancerBackendAddressPool <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool]>] - [-LoadBalancerInboundNatRule <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSInboundNatRule]>] - [-ApplicationGatewayBackendAddressPool <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool]>] - [-ApplicationSecurityGroup <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResourceId -``` -Set-AzureRmNetworkInterfaceIpConfig -Name <String> -NetworkInterface <PSNetworkInterface> - [-PrivateIpAddressVersion <String>] [-PrivateIpAddress <String>] [-Primary] [-SubnetId <String>] - [-PublicIpAddressId <String>] - [-LoadBalancerBackendAddressPoolId <System.Collections.Generic.List`1[System.String]>] - [-LoadBalancerInboundNatRuleId <System.Collections.Generic.List`1[System.String]>] - [-ApplicationGatewayBackendAddressPoolId <System.Collections.Generic.List`1[System.String]>] - [-ApplicationSecurityGroupId <System.Collections.Generic.List`1[System.String]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmNetworkInterfaceIpConfig** cmdlet sets the goal state for an Azure network interface IP configuration. - -## EXAMPLES - -### 1: Changing the IP address of an IP configuration -``` -$vnet = Get-AzureRmVirtualNetwork -Name myvnet -ResourceGroupName myrg -$subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name mysubnet -VirtualNetwork $vnet - -$nic = Get-AzureRmNetworkInterface -Name nic1 -ResourceGroupName myrg - -$nic | Set-AzureRmNetworkInterfaceIpConfig -Name ipconfig1 -PrivateIpAddress 10.0.0.11 -Subnet $subnet - -Primary - -$nic | Set-AzureRmNetworkInterface -``` - -The first two commands get a virtual network called myvnet and a subnet called mysubnet and store it in the - variables $vnet and $subnet respectively. The third command gets the network interface nic1 associated with the IP - configuration that needs to be updated. The third command sets the private IP address of the primary IP - configuration ipconfig1 to 10.0.0.11. Finally, the last command updates the network interface ensuring the changes - have been made successfully. - - -### 2: Associating an IP configuration with an application security group -``` -$vnet = Get-AzureRmVirtualNetwork -Name myvnet -ResourceGroupName myrg -$subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name mysubnet -VirtualNetwork $vnet -$asg = Get-ApplicationSecurityGroup -Name myasg -ResourceGroupName myrg - -$nic = Get-AzureRmNetworkInterface -Name nic1 -ResourceGroupName myrg - -$nic | Set-AzureRmNetworkInterfaceIpConfig -Name ipconfig1 -PrivateIpAddress 10.0.0.11 -Subnet $subnet -ApplicationSecurityGroup $asg - -Primary - -$nic | Set-AzureRmNetworkInterface -``` - -In this example, the variable $asg contains a reference to an application security group. - The fourth command gets the network interface nic1 associated with the IP - configuration that needs to be updated. The Set-AzureRmNetworkInterfaceIpConfig sets the private IP address of the primary IP - configuration ipconfig1 to 10.0.0.11 and creates an association with the retrieved application security group. - Finally, the last command updates the network interface ensuring the changes - have been made successfully. - -## PARAMETERS - -### -ApplicationGatewayBackendAddressPool -Specifies a collection of application gateway backend address pool references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationGatewayBackendAddressPoolId -Specifies a collection of application gateway backend address pool references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationSecurityGroup -Specifies a collection of application security group references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationSecurityGroupId -Specifies a collection of application security group references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancerBackendAddressPool -Specifies a collection of load balancer backend address pool references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancerBackendAddressPoolId -Specifies a collection of load balancer backend address pool references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancerInboundNatRule -Specifies a collection of load balancer inbound network address translation (NAT) rule references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSInboundNatRule] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancerInboundNatRuleId -Specifies a collection of load balancer inbound NAT rule references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network IP configuration for which this cmdlet sets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkInterface -Specifies a **NetworkInterface** object. -This cmdlet adds a network interface IP configuration to the object that this parameter specifies. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkInterface -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Primary -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateIpAddress -Specifies the static IP address of the network interface IP configuration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateIpAddressVersion -Specifies the IP address version of a network interface IP configuration. -The acceptable values for this parameter are: -- IPv4 -- IPv6 - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: IPv4, IPv6 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIpAddress -Specifies a **PublicIPAddress** object. -This cmdlet creates a reference to a public IP Address to associate with this network interface IP configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIpAddressId -This cmdlet creates a reference to a public IP Address to associate with this network interface IP configuration. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subnet -Specifies a **Subnet** object. -This cmdlet creates a reference to a subnet in which this network interface IP configuration is created. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSSubnet -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetId -This cmdlet creates a reference to a subnet in which this network interface IP configuration is created. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface -Parameters: NetworkInterface (ByValue) - -### System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSInboundNatRule, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Add-AzureRmNetworkInterfaceIpConfig](./Add-AzureRmNetworkInterfaceIpConfig.md) - -[Get-AzureRmNetworkInterfaceIpConfig](./Get-AzureRmNetworkInterfaceIpConfig.md) - -[New-AzureRmNetworkInterfaceIpConfig](./New-AzureRmNetworkInterfaceIpConfig.md) - -[Remove-AzureRmNetworkInterfaceIpConfig](./Remove-AzureRmNetworkInterfaceIpConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmNetworkInterfaceTapConfig.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmNetworkInterfaceTapConfig.md deleted file mode 100644 index f5c19f32e1..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmNetworkInterfaceTapConfig.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermnetworkinterfacetapconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmNetworkInterfaceTapConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmNetworkInterfaceTapConfig.md ---- - -# Set-AzureRmNetworkInterfaceTapConfig - -## SYNOPSIS -Sets the goal state of a Tap Configuration - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmNetworkInterfaceTapConfig -NetworkInterfaceTapConfig <PSNetworkInterfaceTapConfiguration> [-AsJob] - [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmNetworkInterfaceTapConfig** sets the goal state for an Azure network interface. - -## EXAMPLES - -### Example 1: Set the TapConfiguration with updated TapConfig name -``` -PS C:\>$tapConfig = Get-AzureRmNetworkInterface -ResourceGroupName "ResourceGroup1" -NetworkInterface "sourceNicName" -Name "tapconfigName" -PS C:\>$tapConfig.Name = "NewTapName" -PS C:\>Set-AzureRmNetworkInterfaceTapConfig -NetworkInterfaceTapConfig $tapConfig -``` - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkInterfaceTapConfig -The NetworkInterface Tap configurtion - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkInterfaceTapConfiguration -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkInterfaceTapConfiguration - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmNetworkProfile.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmNetworkProfile.md deleted file mode 100644 index 4910657f78..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmNetworkProfile.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermnetworkprofile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmNetworkProfile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmNetworkProfile.md ---- - -# Set-AzureRmNetworkProfile - -## SYNOPSIS -Sets the goal state for an existing network profile - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmNetworkProfile -NetworkProfile <PSNetworkProfile> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmPublicIpPrefix** cmdlet sets the goal state for a network profile. - -## EXAMPLES - -### Example 1 -```powershell -$networkProfile = Get-AzureRmNetworkProfile -Name np1 -ResourceGroupName rg1 - -$networkProfile.Tags = "TestTag" - -$networkProfile.ContainerNetworkInterfaceConfigurations = New-AzureRmNetworkProfileContainerNicConfig -Name cnicconfig1 - -$networkProfile | Set-AzureRmNetworkProfile -``` - -The first command gets an existing network profile. The second command updates a tag and the third adds a network interface configuration on the network profile. The fourth command updates the network profile. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkProfile -The network profile - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkProfile -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkProfile - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkProfile - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmNetworkSecurityGroup.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmNetworkSecurityGroup.md deleted file mode 100644 index 5133798b87..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmNetworkSecurityGroup.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 9F69DAEF-F2ED-449B-B75F-FCA7ED73D98F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermnetworksecuritygroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmNetworkSecurityGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmNetworkSecurityGroup.md ---- - -# Set-AzureRmNetworkSecurityGroup - -## SYNOPSIS -Sets the goal state for a network security group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmNetworkSecurityGroup -NetworkSecurityGroup <PSNetworkSecurityGroup> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmNetworkSecurityGroup** cmdlet sets the goal state for an Azure network security group. - -## EXAMPLES - -### Example 1: Set the goal state for a network security group -``` -PS C:\>Get-AzureRmNetworkSecurityGroup -Name "Nsg1" -ResourceGroupName "Rg1" | Add-AzureRmNetworkSecurityRuleConfig -Name "Rdp-Rule" -Description "Allow RDP" -Access "Allow" -Protocol "Tcp" -Direction "Inbound" -Priority 100 -SourceAddressPrefix "Internet" -SourcePortRange "*" -DestinationAddressPrefix "*" -DestinationPortRange "3389" | Set-AzureRmNetworkSecurityGroup -``` - -This command gets the Azure network security group named Nsg1, and adds a network security rule named Rdp-Rule to allow Internet traffic on port 3389 to the retrieved network security group object using Add-AzureRmNetworkSecurityRuleConfig. -The command persists the modified Azure network security group using **Set-AzureRmNetworkSecurityGroup**. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkSecurityGroup -A network security group object representing the goal state to which the cmdlet sets the network security group. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup -Parameters: NetworkSecurityGroup (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup - -## NOTES - -## RELATED LINKS - -[Get-AzureRmNetworkSecurityGroup](./Get-AzureRmNetworkSecurityGroup.md) - -[New-AzureRmNetworkSecurityGroup](./New-AzureRmNetworkSecurityGroup.md) - -[Remove-AzureRmNetworkSecurityGroup](./Remove-AzureRmNetworkSecurityGroup.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmNetworkSecurityRuleConfig.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmNetworkSecurityRuleConfig.md deleted file mode 100644 index 25cdbcfda6..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmNetworkSecurityRuleConfig.md +++ /dev/null @@ -1,360 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 7EFFFF43-501E-4955-A4EE-2C09B8863B30 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermnetworksecurityruleconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmNetworkSecurityRuleConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmNetworkSecurityRuleConfig.md ---- - -# Set-AzureRmNetworkSecurityRuleConfig - -## SYNOPSIS -Sets the goal state for a network security rule configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Set-AzureRmNetworkSecurityRuleConfig -Name <String> -NetworkSecurityGroup <PSNetworkSecurityGroup> - [-Description <String>] [-Protocol <String>] - [-SourcePortRange <System.Collections.Generic.List`1[System.String]>] - [-DestinationPortRange <System.Collections.Generic.List`1[System.String]>] - [-SourceAddressPrefix <System.Collections.Generic.List`1[System.String]>] - [-DestinationAddressPrefix <System.Collections.Generic.List`1[System.String]>] - [-SourceApplicationSecurityGroup <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup]>] - [-DestinationApplicationSecurityGroup <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup]>] - [-Access <String>] [-Priority <Int32>] [-Direction <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### SetByResourceId -``` -Set-AzureRmNetworkSecurityRuleConfig -Name <String> -NetworkSecurityGroup <PSNetworkSecurityGroup> - [-Description <String>] [-Protocol <String>] - [-SourcePortRange <System.Collections.Generic.List`1[System.String]>] - [-DestinationPortRange <System.Collections.Generic.List`1[System.String]>] - [-SourceAddressPrefix <System.Collections.Generic.List`1[System.String]>] - [-DestinationAddressPrefix <System.Collections.Generic.List`1[System.String]>] - [-SourceApplicationSecurityGroupId <System.Collections.Generic.List`1[System.String]>] - [-DestinationApplicationSecurityGroupId <System.Collections.Generic.List`1[System.String]>] [-Access <String>] - [-Priority <Int32>] [-Direction <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmNetworkSecurityRuleConfig** cmdlet sets the goal state for an Azure network security rule configuration. - -## EXAMPLES - -### Example 1: Change the access configuration in a network security rule -``` -PS C:\>$nsg = Get-AzureRmNetworkSecurityGroup -Name "NSG-FrontEnd" -ResourceGroupName "TestRG" -PS C:\> $nsg | Get-AzureRmNetworkSecurityRuleConfig -Name "rdp-rule" -PS C:\> Set-AzureRmNetworkSecurityRuleConfig -Name "rdp-rule" -NetworkSecurityGroup $nsg -Access "Deny" -``` - -The first command gets the network security group named NSG-FrontEnd, and then stores it in the variable $nsg. -The second command uses the pipeline operator to pass the security group in $nsg to Get-AzureRmNetworkSecurityRuleConfig, which gets the security rule configuration named rdp-rule. -The third command changes the access configuration of rdp-rule to Deny. - -## PARAMETERS - -### -Access -Specifies whether network traffic is allowed or denied. -The acceptable values for this parameter are: Allow and Deny. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Allow, Deny - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for a rule configuration. -The maximum size is 140 characters. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationAddressPrefix -Specifies a destination address prefix. -The acceptable values for this parameter are: -- A Classless Interdomain Routing (CIDR) address -- A destination IP address range -- A wildcard character (*) to match any IP address -You can use tags such as VirtualNetwork, AzureLoadBalancer, and Internet. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationApplicationSecurityGroup -The application security group set as destination for the rule. It cannot be used with 'DestinationAddressPrefix' parameter. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationApplicationSecurityGroupId -The application security group set as destination for the rule. It cannot be used with 'DestinationAddressPrefix' parameter. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationPortRange -Specifies a destination port or range. -The acceptable values for this parameter are: -- An integer -- A range of integers between 0 and 65535 -- A wildcard character (*) to match any port - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Direction -Specifies whether a rule is evaluated for incoming or outgoing traffic. -The acceptable values for this parameter are: Inbound and Outbound. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Inbound, Outbound - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network security rule configuration that this cmdlet sets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkSecurityGroup -Specifies the **NetworkSecurityGroup** object that contains the network security rule configuration to set. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Priority -Specifies the priority of a rule configuration. -The acceptable values for this parameter are:An integer between 100 and 4096. -The priority number must be unique for each rule in the collection. -The lower the priority number, the higher the priority of the rule. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the network protocol that a rule configuration applies to. -The acceptable values for this parameter are: - --Tcp -- Udp -- A wildcard character (*) to match both - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Tcp, Udp, * - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceAddressPrefix -Specifies a source address prefix. -The acceptable values for this parameter are: -- A CIDR -- A source IP range -- A wildcard character (*) to match any IP address -You can also use tags such as VirtualNetwork, AzureLoadBalancer and Internet. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceApplicationSecurityGroup -The application security group set as source for the rule. It cannot be used with 'SourceAddressPrefix' parameter. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceApplicationSecurityGroupId -The application security group set as source for the rule. It cannot be used with 'SourceAddressPrefix' parameter. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourcePortRange -Specifies the source port or range. -The acceptable values for this parameter are: -- An integer -- A range of integers between 0 and 65535 -- A wildcard character (*) to match any port - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup -Parameters: NetworkSecurityGroup (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup - -## NOTES - -## RELATED LINKS - -[Add-AzureRmNetworkSecurityRuleConfig](./Add-AzureRmNetworkSecurityRuleConfig.md) - -[Get-AzureRmNetworkSecurityRuleConfig](./Get-AzureRmNetworkSecurityRuleConfig.md) - -[New-AzureRmNetworkSecurityRuleConfig](./New-AzureRmNetworkSecurityRuleConfig.md) - -[Remove-AzureRmNetworkSecurityRuleConfig](./Remove-AzureRmNetworkSecurityRuleConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmNetworkWatcherConfigFlowLog.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmNetworkWatcherConfigFlowLog.md deleted file mode 100644 index e6d224bed6..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmNetworkWatcherConfigFlowLog.md +++ /dev/null @@ -1,509 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermnetworkwatcherconfigflowlog -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmNetworkWatcherConfigFlowLog.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmNetworkWatcherConfigFlowLog.md ---- - -# Set-AzureRmNetworkWatcherConfigFlowLog - -## SYNOPSIS -Configures flow logging for a target resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetFlowlogByResourceWithoutTA (Default) -``` -Set-AzureRmNetworkWatcherConfigFlowLog -NetworkWatcher <PSNetworkWatcher> -TargetResourceId <String> - -EnableFlowLog <Boolean> -StorageAccountId <String> [-EnableRetention <Boolean>] [-RetentionInDays <Int32>] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetFlowlogByResourceWithTAByResource -``` -Set-AzureRmNetworkWatcherConfigFlowLog -NetworkWatcher <PSNetworkWatcher> -TargetResourceId <String> - -EnableFlowLog <Boolean> -StorageAccountId <String> [-EnableRetention <Boolean>] [-RetentionInDays <Int32>] - [-AsJob] [-EnableTrafficAnalytics] -Workspace <IOperationalInsightWorkspace> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetFlowlogByResourceWithTAByDetails -``` -Set-AzureRmNetworkWatcherConfigFlowLog -NetworkWatcher <PSNetworkWatcher> -TargetResourceId <String> - -EnableFlowLog <Boolean> -StorageAccountId <String> [-EnableRetention <Boolean>] [-RetentionInDays <Int32>] - [-AsJob] [-EnableTrafficAnalytics] -WorkspaceResourceId <String> -WorkspaceGUID <String> - -WorkspaceLocation <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### SetFlowlogByNameWithTAByResource -``` -Set-AzureRmNetworkWatcherConfigFlowLog -NetworkWatcherName <String> -ResourceGroupName <String> - -TargetResourceId <String> -EnableFlowLog <Boolean> -StorageAccountId <String> [-EnableRetention <Boolean>] - [-RetentionInDays <Int32>] [-AsJob] [-EnableTrafficAnalytics] -Workspace <IOperationalInsightWorkspace> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetFlowlogByNameWithTAByDetails -``` -Set-AzureRmNetworkWatcherConfigFlowLog -NetworkWatcherName <String> -ResourceGroupName <String> - -TargetResourceId <String> -EnableFlowLog <Boolean> -StorageAccountId <String> [-EnableRetention <Boolean>] - [-RetentionInDays <Int32>] [-AsJob] [-EnableTrafficAnalytics] -WorkspaceResourceId <String> - -WorkspaceGUID <String> -WorkspaceLocation <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### SetFlowlogByNameWithoutTA -``` -Set-AzureRmNetworkWatcherConfigFlowLog -NetworkWatcherName <String> -ResourceGroupName <String> - -TargetResourceId <String> -EnableFlowLog <Boolean> -StorageAccountId <String> [-EnableRetention <Boolean>] - [-RetentionInDays <Int32>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### SetFlowlogByLocationWithTAByResource -``` -Set-AzureRmNetworkWatcherConfigFlowLog -Location <String> -TargetResourceId <String> -EnableFlowLog <Boolean> - -StorageAccountId <String> [-EnableRetention <Boolean>] [-RetentionInDays <Int32>] [-AsJob] - [-EnableTrafficAnalytics] -Workspace <IOperationalInsightWorkspace> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetFlowlogByLocationWithTAByDetails -``` -Set-AzureRmNetworkWatcherConfigFlowLog -Location <String> -TargetResourceId <String> -EnableFlowLog <Boolean> - -StorageAccountId <String> [-EnableRetention <Boolean>] [-RetentionInDays <Int32>] [-AsJob] - [-EnableTrafficAnalytics] -WorkspaceResourceId <String> -WorkspaceGUID <String> -WorkspaceLocation <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetFlowlogByLocationWithoutTA -``` -Set-AzureRmNetworkWatcherConfigFlowLog -Location <String> -TargetResourceId <String> -EnableFlowLog <Boolean> - -StorageAccountId <String> [-EnableRetention <Boolean>] [-RetentionInDays <Int32>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Set-AzureRmNetworkWatcherConfigFlowLog configures flow logging for a target resource. -Properties to configure include: whether or not flow logging is enabled for the resource provided, the configured storage account to send logs, and the retention policy for the logs. -Currently Network Security Groups are supported for flow logging. - -## EXAMPLES - -### Example 1: Configure Flow Logging for a Specified NSG -``` -PS C:\> $NW = Get-AzurermNetworkWatcher -ResourceGroupName NetworkWatcherRg -Name NetworkWatcher_westcentralus -PS C:\> $nsg = Get-AzureRmNetworkSecurityGroup -ResourceGroupName NSGRG -Name appNSG -PS C:\> $storageId = "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NSGRG/providers/Microsoft.Storage/storageAccounts/contosostorageacct123" - - -PS C:\> Set-AzureRmNetworkWatcherConfigFlowLog -NetworkWatcher $NW -TargetResourceId $nsg.Id -EnableFlowLog $true -StorageAccountId $storageID - -TargetResourceId : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NSGRG/providers/Microsoft.Network/networkSecurityGroups/appNSG -StorageId : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NSGRG/providers/Microsoft.Storage/storageAccounts/contosostorageacct123 -Enabled : True -RetentionPolicy : { - "Days": 0, - "Enabled": false - } -``` - -In this example we configure flow logging status for a Network Security Group. In the response, we see the specified NSG has flow logging enabled, and no retention policy set. - -### Example 2: Configure Flow Logging and Traffic Analytics for a Specified NSG -``` -PS C:\> $NW = Get-AzurermNetworkWatcher -ResourceGroupName NetworkWatcherRg -Name NetworkWatcher_westcentralus -PS C:\> $nsg = Get-AzureRmNetworkSecurityGroup -ResourceGroupName NSGRG -Name appNSG -PS C:\> $storageId = "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NSGRG/providers/Microsoft.Storage/storageAccounts/contosostorageacct123" -PS C:\> $workspace = Get-AzureRmOperationalInsightsWorkspace -Name WorkspaceName -ResourceGroupName WorkspaceRg - - -PS C:\> Set-AzureRmNetworkWatcherConfigFlowLog -NetworkWatcher $NW -TargetResourceId $nsg.Id -EnableFlowLog $true -StorageAccountId $storageID -EnableTrafficAnalytics -Workspace $workspace - -TargetResourceId : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NSGRG/providers/Microsoft.Network/networkSecurityGroups/appNSG -StorageId : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NSGRG/providers/Microsoft.Storage/storageAccounts/contosostorageacct123 -Enabled : True -RetentionPolicy : { - "Days": 0, - "Enabled": false - } -FlowAnalyticsConfiguration : { - "networkWatcherFlowAnalyticsConfiguration": { - "enabled": true, - "workspaceId": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb", - "workspaceRegion": "WorkspaceLocation", - "workspaceResourceId": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourcegroups/WorkspaceRg/providers/microsoft.operationalinsights/workspaces/WorkspaceName" - } - } -``` - -In this example we configure flow logging status and Traffic Analytics for a Network Security Group. In the response, we see the specified NSG has flow logging and Traffic Analytics enabled, and no retention policy set. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableFlowLog -Flag to enable/disable flow logging. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableRetention -Flag to enable/disable retention. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableTrafficAnalytics -Flag to enable/disable retention. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: SetFlowlogByResourceWithTAByResource, SetFlowlogByResourceWithTAByDetails, SetFlowlogByNameWithTAByResource, SetFlowlogByNameWithTAByDetails, SetFlowlogByLocationWithTAByResource, SetFlowlogByLocationWithTAByDetails -Aliases: EnableTA - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Location of the network watcher. - -```yaml -Type: System.String -Parameter Sets: SetFlowlogByLocationWithTAByResource, SetFlowlogByLocationWithTAByDetails, SetFlowlogByLocationWithoutTA -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameter Sets: SetFlowlogByResourceWithoutTA, SetFlowlogByResourceWithTAByResource, SetFlowlogByResourceWithTAByDetails -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: System.String -Parameter Sets: SetFlowlogByNameWithTAByResource, SetFlowlogByNameWithTAByDetails, SetFlowlogByNameWithoutTA -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: System.String -Parameter Sets: SetFlowlogByNameWithTAByResource, SetFlowlogByNameWithTAByDetails, SetFlowlogByNameWithoutTA -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RetentionInDays -Number of days to retain flow log records. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountId -ID of the storage account which is used to store the flow log. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetResourceId -The target resource ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Workspace -The WS object which is used to store the traffic analytics data. - -```yaml -Type: Microsoft.Azure.Management.Internal.Network.Common.IOperationalInsightWorkspace -Parameter Sets: SetFlowlogByResourceWithTAByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: Microsoft.Azure.Management.Internal.Network.Common.IOperationalInsightWorkspace -Parameter Sets: SetFlowlogByNameWithTAByResource, SetFlowlogByLocationWithTAByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WorkspaceGUID -GUID of the WS which is used to store the traffic analytics data. - -```yaml -Type: System.String -Parameter Sets: SetFlowlogByResourceWithTAByDetails, SetFlowlogByNameWithTAByDetails, SetFlowlogByLocationWithTAByDetails -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WorkspaceLocation -Azure Region of the WS which is used to store the traffic analytics data. - -```yaml -Type: System.String -Parameter Sets: SetFlowlogByResourceWithTAByDetails, SetFlowlogByNameWithTAByDetails, SetFlowlogByLocationWithTAByDetails -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WorkspaceResourceId -Subscription of the WS which is used to store the traffic analytics data. - -```yaml -Type: System.String -Parameter Sets: SetFlowlogByResourceWithTAByDetails, SetFlowlogByNameWithTAByDetails, SetFlowlogByLocationWithTAByDetails -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameters: NetworkWatcher (ByValue) - -### System.String -Parameters: NetworkWatcherName (ByValue) - -### System.Boolean - -### System.Int32 - -### Microsoft.Azure.Management.Internal.Network.Common.IOperationalInsightWorkspace - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSFlowLog - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, watcher, flow, logs, flowlog, logging - -## RELATED LINKS - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmNetworkWatcherProtocolConfiguration](./New-AzureRmNetworkWatcherProtocolConfiguration.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Test-AzureRmNetworkWatcherConnectivity](./Test-AzureRmNetworkWatcherConnectivity.md) - -[Stop-AzureRmNetworkWatcherConnectionMonitor](./Stop-AzureRmNetworkWatcherConnectionMonitor.md) - -[Start-AzureRmNetworkWatcherConnectionMonitor](./Start-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConnectionMonitor](./Set-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConfigFlowLog](./Set-AzureRmNetworkWatcherConfigFlowLog.md) - -[Remove-AzureRmNetworkWatcherConnectionMonitor](./Remove-AzureRmNetworkWatcherConnectionMonitor.md) - -[New-AzureRmNetworkWatcherConnectionMonitor](./New-AzureRmNetworkWatcherConnectionMonitor.md) - -[Get-AzureRmNetworkWatcherTroubleshootingResult](./Get-AzureRmNetworkWatcherTroubleshootingResult.md) - -[Get-AzureRMNetworkWatcherReachabilityReport](./Get-AzureRMNetworkWatcherReachabilityReport.md) - -[Get-AzureRmNetworkWatcherReachabilityProvidersList](./Get-AzureRmNetworkWatcherReachabilityProvidersList.md) - -[Get-AzureRmNetworkWatcherFlowLogStatus](./Get-AzureRmNetworkWatcherFlowLogStatus.md) - -[Get-AzureRmNetworkWatcherConnectionMonitorReport](./Get-AzureRmNetworkWatcherConnectionMonitorReport.md) - -[Get-AzureRmNetworkWatcherConnectionMonitor](./Get-AzureRmNetworkWatcherConnectionMonitor.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmNetworkWatcherConnectionMonitor.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmNetworkWatcherConnectionMonitor.md deleted file mode 100644 index 2d2fc63143..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmNetworkWatcherConnectionMonitor.md +++ /dev/null @@ -1,462 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermnetworkwatcherconfigflowlog -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmNetworkWatcherConnectionMonitor.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmNetworkWatcherConnectionMonitor.md ---- - -# Set-AzureRmNetworkWatcherConnectionMonitor - -## SYNOPSIS -Update a connection monitor. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByName (Default) -``` -Set-AzureRmNetworkWatcherConnectionMonitor -NetworkWatcherName <String> -ResourceGroupName <String> - -Name <String> -SourceResourceId <String> [-MonitoringIntervalInSeconds <Int32>] [-SourcePort <Int32>] - [-DestinationResourceId <String>] [-DestinationAddress <String>] [-DestinationPort <Int32>] [-ConfigureOnly] - [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### SetByResource -``` -Set-AzureRmNetworkWatcherConnectionMonitor -NetworkWatcher <PSNetworkWatcher> -Name <String> - -SourceResourceId <String> [-MonitoringIntervalInSeconds <Int32>] [-SourcePort <Int32>] - [-DestinationResourceId <String>] [-DestinationAddress <String>] [-DestinationPort <Int32>] [-ConfigureOnly] - [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### SetByLocation -``` -Set-AzureRmNetworkWatcherConnectionMonitor -Location <String> -Name <String> -SourceResourceId <String> - [-MonitoringIntervalInSeconds <Int32>] [-SourcePort <Int32>] [-DestinationResourceId <String>] - [-DestinationAddress <String>] [-DestinationPort <Int32>] [-ConfigureOnly] [-Tag <Hashtable>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByResourceId -``` -Set-AzureRmNetworkWatcherConnectionMonitor -ResourceId <String> -SourceResourceId <String> - [-MonitoringIntervalInSeconds <Int32>] [-SourcePort <Int32>] [-DestinationResourceId <String>] - [-DestinationAddress <String>] [-DestinationPort <Int32>] [-ConfigureOnly] [-Tag <Hashtable>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByInputObject -``` -Set-AzureRmNetworkWatcherConnectionMonitor -InputObject <PSConnectionMonitorResult> -SourceResourceId <String> - [-MonitoringIntervalInSeconds <Int32>] [-SourcePort <Int32>] [-DestinationResourceId <String>] - [-DestinationAddress <String>] [-DestinationPort <Int32>] [-ConfigureOnly] [-Tag <Hashtable>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Set-AzureRmNetworkWatcherConnectionMonitor cmdlet updates the specified connection monitor. - -## EXAMPLES - -### Example 1: Update a connection monitor -``` -PS C:\> Set-AzureRmNetworkWatcherConnectionMonitor -Location centraluseuap -Name cm -SourceResourceId /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RgCentralUSEUAP/providers/Microsoft.Compute/virtualMachines/vm --DestinationAddress google.com -DestinationPort 80 -Tag @{"key1" = "value1"} - -Name : cm -Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGro - ups/NetworkWatcherRG/providers/Microsoft.Network/networkWatcher - s/NetworkWatcher_centraluseuap/connectionMonitors/cm -Etag : W/"5b2b20e8-0ce0-417e-9607-76208149bb67" -ProvisioningState : Succeeded -Source : { - "ResourceId": "/subscriptions/00000000-0000-0000-0000-0000000 - 00000/RgCentralUSEUAP/providers/Microsoft.Compute/virtualMach - ines/vm", - "Port": 0 - } -Destination : { - "Address": "google.com", - "Port": 80 - } -MonitoringIntervalInSeconds : 60 -AutoStart : True -StartTime : 1/12/2018 7:19:28 PM -MonitoringStatus : Running -Location : centraluseuap -Type : Microsoft.Network/networkWatchers/connectionMonitors -Tags : { - "key1": "value1" - } -``` - -In this example we update existing connection monitor by changing destinationAddress and adding tags. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConfigureOnly -Configure connection monitor, but do not start it - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationAddress -The Ip address of the connection monitor destination. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationPort -Destination port. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationResourceId -The ID of the connection monitor destination. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Connection monitor object. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResult -Parameter Sets: SetByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Location -Location of the network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByLocation -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MonitoringIntervalInSeconds -Monitoring interval in seconds. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The connection monitor name. - -```yaml -Type: System.String -Parameter Sets: SetByName, SetByResource, SetByLocation -Aliases: ConnectionMonitorName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourcePort -Source port. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceResourceId -The ID of the connection monitor source. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -A hashtable which represents resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameters: NetworkWatcher (ByValue) - -### System.String - -### Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResult -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResult - -## NOTES -Keywords: azure, azurerm, arm, resource, connectivity, management, manager, network, networking, network watcher, connection monitor - -## RELATED LINKS - -[New-AzureRmNetworkWatcher]() - -[Get-AzureRmNetworkWatcher]() - -[Remove-AzureRmNetworkWatcher]() - -[Get-AzureRmNetworkWatcherNextHop]() - -[Get-AzureRmNetworkWatcherSecurityGroupView]() - -[Get-AzureRmNetworkWatcherTopology]() - -[Get-AzureRmNetworkWatcherTroubleshootingResult]() - -[New-AzureRmNetworkWatcherPacketCapture]() - -[New-AzureRmPacketCaptureFilterConfig]() - -[Get-AzureRmNetworkWatcherPacketCapture]() - -[Remove-AzureRmNetworkWatcherPacketCapture]() - -[Stop-AzureRmNetworkWatcherPacketCapture]() - -[Get-AzureRmNetworkWatcherConnectionMonitor]() - -[Get-AzureRmNetworkWatcherConnectionMonitorReport]() - -[Remove-AzureRmNetworkWatcherConnectionMonitor]() - -[Set-AzureRmNetworkWatcherConnectionMonitor]() - -[Stop-AzureRmNetworkWatcherConnectionMonitor]() - -[New-AzureRmNetworkWatcherConnectionMonitor]() - -[New-AzureRmNetworkWatcherProtocolConfiguration]() - -[Test-AzureRmNetworkWatcherIPFlow]() - -[Test-AzureRmNetworkWatcherConnectivity]() - -[Start-AzureRmNetworkWatcherResourceTroubleshooting]() - -[Start-AzureRmNetworkWatcherConnectionMonitor]() - -[Set-AzureRmNetworkWatcherConfigFlowLog]() - -[Get-AzureRMNetworkWatcherReachabilityReport]() - -[Get-AzureRmNetworkWatcherReachabilityProvidersList]() - -[Get-AzureRmNetworkWatcherFlowLogStatus]() diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmPublicIpAddress.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmPublicIpAddress.md deleted file mode 100644 index cc1360b3a5..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmPublicIpAddress.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: EC798838-1850-4E88-B17F-D2F00F2D4EE9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermpublicipaddress -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmPublicIpAddress.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmPublicIpAddress.md ---- - -# Set-AzureRmPublicIpAddress - -## SYNOPSIS -Sets the goal state for a public IP address. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmPublicIpAddress -PublicIpAddress <PSPublicIpAddress> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmPublicIpAddress** cmdlet sets the goal state for a public IP address. - -## EXAMPLES - -### 1: Change allocation method of a public IP address -``` -PS C:\> $publicIp = Get-AzureRmPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName - -PS C:\> $publicIp.PublicIpAllocationMethod = "Static" - -PS C:\> Set-AzureRmPublicIpAddress -PublicIpAddress $publicIp - -PS C:\> Get-AzureRmPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName -``` - - First command gets the public IP address resource with name $publicIPName in the resource - group $rgName. - Second command sets the allocation method of the public IP address object to "Static". - Set-AzureRmPublicIPAddress command updates the public IP address resource with the - updated object, and modifies the allocation method to 'Static'. A public IP address gets - allocated immediately. - -### 2: Change DNS domain label of a public IP address -``` -PS C:\> $publicIp = Get-AzureRmPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName - -PS C:\> $publicIp.DnsSettings.DomainNameLabel = "newdnsprefix" - -PS C:\> Set-AzureRmPublicIpAddress -PublicIpAddress $publicIp - -PS C:\> $publicIp = Get-AzureRmPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName -``` - -First command gets the public IP address resource with name $publicIPName in the resource - group $rgName. - Second command sets the DomainNameLabel property to the required dns prefix. - Set-AzureRmPublicIPAddress command updates the public IP address resource with the - updated object. DomainNameLabel & Fqdn are modified as expected. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIpAddress -Specifies a **PublicIpAddress** object that represents the goal state to which the public IP address should be set. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress -Parameters: PublicIpAddress (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress - -## NOTES - -## RELATED LINKS - -[Get-AzureRmPublicIpAddress](./Get-AzureRmPublicIpAddress.md) - -[New-AzureRmPublicIpAddress](./New-AzureRmPublicIpAddress.md) - -[Remove-AzureRmPublicIpAddress](./Remove-AzureRmPublicIpAddress.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmPublicIpPrefix.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmPublicIpPrefix.md deleted file mode 100644 index b4ddfc2f42..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmPublicIpPrefix.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermpublicipprefix -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmPublicIpPrefix.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmPublicIpPrefix.md ---- - -# Set-AzureRmPublicIpPrefix - -## SYNOPSIS -Sets the Tags for an existing PublicIpPrefix - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmPublicIpPrefix -PublicIpPrefix <PSPublicIpPrefix> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmPublicIpPrefix** cmdlet sets the Tags for a public IP prefix. - -## EXAMPLES - -### Set the tags for public ip prefix -```powershell -PS C:\> $publicIpPrefix = Get-AzureRmPublicIpPrefix -Name $prefixName -ResourceGroupName $rgName - -PS C:\> $publicIpPrefix.Tags = "TestTag" - -PS C:\> Set-AzureRmPublicIpPrefix -PublicIpPrefix $publicIpPrefix -``` - -The first command gets an existing public IP Prefix, the second command sets the Tags Property and the third command updates the existing object. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIpPrefix -The PublicIpPrefix - -```yaml -Type: PSPublicIpPrefix -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSPublicIpPrefix - - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSPublicIpPrefix - - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmRouteConfig.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmRouteConfig.md deleted file mode 100644 index 201429dc88..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmRouteConfig.md +++ /dev/null @@ -1,232 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 6E967F9C-949E-4485-9B57-FC4F523D5DC9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermrouteconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmRouteConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmRouteConfig.md ---- - -# Set-AzureRmRouteConfig - -## SYNOPSIS -Sets the goal state for a route. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmRouteConfig -RouteTable <PSRouteTable> [-Name <String>] [-AddressPrefix <String>] - [-NextHopType <String>] [-NextHopIpAddress <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmRouteConfig** cmdlet sets the goal state for an Azure route. - -## EXAMPLES - -### Example 1: Modify a route -``` -PS C:\>Get-AzureRmRouteTable -ResourceGroupName "ResourceGroup11" -Name "RouteTable01" | Set-AzureRmRouteConfig -Name "Route02" -AddressPrefix 10.4.0.0/16 -NextHopType VnetLocal | Set-AzureRmRouteTable -Name : Routetable01 -ResourceGroupName : ResourceGroup11 -Location : eastus -Id : /subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Microsoft.Networ - k/routeTables/RouteTable01 -Etag : W/"58c2922e-9efe-4554-a457-956ef44bc718" -ProvisioningState : Succeeded -Tags : -Routes : [ - { - "Name": "Route07", - "Etag": "W/\"58c2922e-9efe-4554-a457-956ef44bc718\"", - "Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro - soft.Network/routeTables/Routetable01/routes/Route07", - "AddressPrefix": "10.1.0.0/16", - "NextHopType": "VnetLocal", - "NextHopIpAddress": null, - "ProvisioningState": "Succeeded" - }, - { - "Name": "route02", - "Etag": "W/\"58c2922e-9efe-4554-a457-956ef44bc718\"", - "Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro - soft.Network/routeTables/routetable01/routes/route02", - "AddressPrefix": "10.4.0.0/16", - "NextHopType": "VnetLocal", - "NextHopIpAddress": null, - "ProvisioningState": "Succeeded" - } - ] -Subnets : [] -``` - -This command gets the route table named RouteTable01 by using the Get-AzureRmRouteTable cmdlet. -The command passes that table to the current cmdlet by using the pipeline operator. -The current cmdlet modifies the route named Route02, and then passes the result to the **Set-AzureRmRouteTable** cmdlet, which updates the table to reflect your changes. - -## PARAMETERS - -### -AddressPrefix -Specifies the destination, in Classless Interdomain Routing (CIDR) format, to which the route applies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the route that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NextHopIpAddress -Specifies the IP address of a virtual appliance that you add to your Azure virtual network. -This route forwards packets to that address. -Specify this parameter only if you specify a value of VirtualAppliance for the *NextHopType* parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NextHopType -Specifies how this route forwards packets. -The acceptable values for this parameter are: -- Internet. -The default Internet gateway provided by Azure. -- None. -If you specify this value, the route does not forward packets. -- VirtualAppliance. -A virtual appliance that you add to your Azure virtual network. -- VirtualNetworkGateway. -An Azureserver-to-server virtual private network gateway. -- VnetLocal. -The local virtual network. -If you have two subnets, 10.1.0.0/16 and 10.2.0.0/16 in the same virtual network, select a value of VnetLocal for each subnet to forward to the other subnet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RouteTable -Specifies the route table with which this route is associated. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSRouteTable -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteTable - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteTable - -## NOTES - -## RELATED LINKS - -[Add-AzureRmRouteConfig](./Add-AzureRmRouteConfig.md) - -[Get-AzureRmRouteConfig](./Get-AzureRmRouteConfig.md) - -[New-AzureRmRouteConfig](./New-AzureRmRouteConfig.md) - -[Remove-AzureRmRouteConfig](./Remove-AzureRmRouteConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmRouteFilter.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmRouteFilter.md deleted file mode 100644 index ef94723e44..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmRouteFilter.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermroutefilter -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmRouteFilter.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmRouteFilter.md ---- - -# Set-AzureRmRouteFilter - -## SYNOPSIS -{{Fill in the Synopsis}} - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmRouteFilter -RouteFilter <PSRouteFilter> [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -{{Fill in the Description}} - -## EXAMPLES - -### Example 1 -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation if you want to overrite a resource - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteFilter -The RouteFilter - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSRouteFilter -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteFilter -Parameters: RouteFilter (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteFilter - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmRouteFilterRuleConfig.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmRouteFilterRuleConfig.md deleted file mode 100644 index 08586dbc6d..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmRouteFilterRuleConfig.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermroutefilterruleconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmRouteFilterRuleConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmRouteFilterRuleConfig.md ---- - -# Set-AzureRmRouteFilterRuleConfig - -## SYNOPSIS -{{Fill in the Synopsis}} - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmRouteFilterRuleConfig -RouteFilter <PSRouteFilter> [-Force] -Name <String> -Access <String> - -RouteFilterRuleType <String> -CommunityList <System.Collections.Generic.List`1[System.String]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -{{Fill in the Description}} - -## EXAMPLES - -### Example 1 -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -Access -The access type of the rule. -Possible values are: 'Allow', 'Deny' - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Allow, Deny - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CommunityList -The list of community value that route filter will filter on - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation if you want to overrite a resource - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the route filter rule - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteFilter -The RouteFilter - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSRouteFilter -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RouteFilterRuleType -The route filter rule type of the rule. -Possible values are: 'Community' - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Community - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteFilter -Parameters: RouteFilter (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteFilter - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmRouteTable.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmRouteTable.md deleted file mode 100644 index 0f37ab441b..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmRouteTable.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 1CE2A30A-6DF8-4C4C-8348-C3C1CD4D0146 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermroutetable -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmRouteTable.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmRouteTable.md ---- - -# Set-AzureRmRouteTable - -## SYNOPSIS -Sets the goal state for a route table. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmRouteTable -RouteTable <PSRouteTable> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmRouteTable** cmdlet sets the goal state for an Azure route table. - -## EXAMPLES - -### Example 1: Add a route and then set the goal state of the route table -``` -PS C:\>Get-AzureRmRouteTable -ResourceGroupName "ResourceGroup11" -Name "RouteTable01" | Add-AzureRmRouteConfig -Name "Route07" -AddressPrefix 10.2.0.0/16 -NextHopType "VnetLocal" | Set-AzureRmRouteTable -Name : RouteTable01 -ResourceGroupName : ResourceGroup11 -Location : eastus -Id : /subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Microsoft.Networ - k/routeTables/RouteTable01 -Etag : W/"f13e1bc8-d41f-44d0-882d-b8b5a1134f59" -ProvisioningState : Succeeded -Tags : -Routes : [ - { - "Name": "Route07", - "Etag": "W/\"f13e1bc8-d41f-44d0-882d-b8b5a1134f59\"", - "Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro - soft.Network/RouteTables/RouteTable01/routes/Route07", - "AddressPrefix": "10.1.0.0/16", - "NextHopType": "VnetLocal", - "NextHopIpAddress": null, - "ProvisioningState": "Succeeded" - }, - { - "Name": "Route07", - "Etag": "W/\"f13e1bc8-d41f-44d0-882d-b8b5a1134f59\"", - "Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro - soft.Network/RouteTables/RouteTable01/routes/Route07", - "AddressPrefix": "10.2.0.0/16", - "NextHopType": "VnetLocal", - "NextHopIpAddress": null, - "ProvisioningState": "Succeeded" - }, - { - "Name": "Route13", - "Etag": null, - "Id": null, - "AddressPrefix": "10.3.0.0/16", - "NextHopType": "VnetLocal", - "NextHopIpAddress": null, - "ProvisioningState": null - } - ] -Subnets : [] -``` - -This command gets the route table named RouteTable01 by using Get-AzureRmRouteTable cmdlet. -The command passes that table to the Add-AzureRmRouteConfig cmdlet by using the pipeline operator. -**Add-AzureRmRouteConfig** adds the route named Route07, and then passes the result to the current cmdlet, which updates the table to reflect your changes. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteTable -Specifies a route table object that represents the goal state to which this cmdlet sets the route table. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSRouteTable -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteTable -Parameters: RouteTable (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteTable - -## NOTES - -## RELATED LINKS - -[Add-AzureRmRouteConfig](./Add-AzureRmRouteConfig.md) - -[Get-AzureRmRouteTable](./Get-AzureRmRouteTable.md) - -[New-AzureRmRouteTable](./New-AzureRmRouteTable.md) - -[Remove-AzureRmRouteTable](./Remove-AzureRmRouteTable.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmServiceEndpointPolicy.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmServiceEndpointPolicy.md deleted file mode 100644 index 1e467ca1ae..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmServiceEndpointPolicy.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermserviceendpointpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmServiceEndpointPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmServiceEndpointPolicy.md ---- - -# Set-AzureRmServiceEndpointPolicy - -## SYNOPSIS -{{Fill in the Synopsis}} - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmServiceEndpointPolicy -ServiceEndpointPolicy <PSServiceEndpointPolicy> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmServiceEndpointPolicy** cmdlet create a service endpoint policy. - -## EXAMPLES - -### Example 1: Sets a service endpoint policy -``` -$serviceEndpointPolicy = Set-AzureRmServiceEndpointPolicy -Name "Policy1" -ServiceEndpointPolicy $serviceEndpointPolicy -ResourceGroup "resourcegroup1" -``` - -This command updates a service endpoint policy named Policy1 defined by the object $serviceEndpointPolicy belong to the resourcegroup "resourcegroup1". - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceEndpointPolicy -The ServiceEndpointPolicy - -```yaml -Type: PSServiceEndpointPolicy -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy - - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy - - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmServiceEndpointPolicyDefinition.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmServiceEndpointPolicyDefinition.md deleted file mode 100644 index cd5f5f97e2..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmServiceEndpointPolicyDefinition.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermserviceendpointpolicydefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmServiceEndpointPolicyDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmServiceEndpointPolicyDefinition.md ---- - -# Set-AzureRmServiceEndpointPolicyDefinition - -## SYNOPSIS -{{Fill in the Synopsis}} - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmServiceEndpointPolicyDefinition -Name <String> -ServiceEndpointPolicy <PSServiceEndpointPolicy> - [-Description <String>] [-ServiceResource <System.Collections.Generic.List`1[System.String]>] - [-Service <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmServiceEndpointPolicyDefinition** cmdlet create a service endpoint policy definition. - -## EXAMPLES - -### Example 1: Updates a service endpoint policy definition in a service endpoint policy -``` -$serviceEndpointPolicy = Set-AzureRmServiceEndpointPolicyDefinition -Name "Policydef1" -ServiceEndpointPolicy $serviceEndpointPolicy -``` - -This command updates a service endpoint policy definition named Policydef1 in the service endpoint policy defined by the object $ServiceEndpointPolicy. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The description of the definition - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the rule - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Service -Name of the service - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceEndpointPolicy -The NetworkSecurityGroup - -```yaml -Type: PSServiceEndpointPolicy -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServiceResource -List of service resources - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy - - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy - - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetwork.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetwork.md deleted file mode 100644 index 8e1f8bad5e..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetwork.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 93D8A341-540A-43F1-8C62-28323EAA58E0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermvirtualnetwork -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmVirtualNetwork.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmVirtualNetwork.md ---- - -# Set-AzureRmVirtualNetwork - -## SYNOPSIS -Sets the goal state for a virtual network. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVirtualNetwork -VirtualNetwork <PSVirtualNetwork> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVirtualNetwork** cmdlet sets the goal state for an Azure virtual network. - -## EXAMPLES - -### 1: Creates a virtual network and removes one of its subnets -``` -New-AzureRmResourceGroup -Name TestResourceGroup -Location centralus - $frontendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" ## Create resource group -$backendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name backendSubnet -AddressPrefix "10.0.2.0/24" ## Create backend subnet - -$virtualNetwork = New-AzureRmVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName - TestResourceGroup -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet,$backendSubnet ## Create virtual network - -Remove-AzureRmVirtualNetworkSubnetConfig -Name backendSubnet -VirtualNetwork $virtualNetwork ## Remove subnet from in memory representation of virtual network - -$virtualNetwork | Set-AzureRmVirtualNetwork ## Remove subnet from virtual network -``` - -This example creates a virtual network called TestResourceGroup with two subnets: frontendSubnet and backendSubnet. Then it removes backendSubnet subnet from the in-memory representation of the virtual network. The Set-AzureRmVirtualNetwork cmdlet is then used to write the modified virtual network state on the service side. When the Set-AzureRmVirtualNetwork cmdlet is executed, the backendSubnet is removed. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetwork -Specifies a **VirtualNetwork** object that represents the goal state. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork -Parameters: VirtualNetwork (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVirtualNetwork](./Get-AzureRmVirtualNetwork.md) - -[Get-AzureRmVirtualNetwork](./Get-AzureRmVirtualNetwork.md) - -[New-AzureRmVirtualNetwork](./New-AzureRmVirtualNetwork.md) - -[Remove-AzureRmVirtualNetwork](./Remove-AzureRmVirtualNetwork.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetworkGateway.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetworkGateway.md deleted file mode 100644 index c6fe76637d..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetworkGateway.md +++ /dev/null @@ -1,411 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 5C309071-A2ED-464C-9197-0A77859C8FBB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermvirtualnetworkgateway -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmVirtualNetworkGateway.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmVirtualNetworkGateway.md ---- - -# Set-AzureRmVirtualNetworkGateway - -## SYNOPSIS -Updates a virtual network gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Default (Default) -``` -Set-AzureRmVirtualNetworkGateway -VirtualNetworkGateway <PSVirtualNetworkGateway> [-GatewaySku <String>] - [-GatewayDefaultSite <PSLocalNetworkGateway>] - [-VpnClientAddressPool <System.Collections.Generic.List`1[System.String]>] - [-VpnClientProtocol <System.Collections.Generic.List`1[System.String]>] - [-VpnClientRootCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate]>] - [-VpnClientRevokedCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate]>] - [-VpnClientIpsecPolicy <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy]>] - [-Asn <UInt32>] [-PeerWeight <Int32>] [-EnableActiveActiveFeature] [-DisableActiveActiveFeature] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RadiusServerConfiguration -``` -Set-AzureRmVirtualNetworkGateway -VirtualNetworkGateway <PSVirtualNetworkGateway> [-GatewaySku <String>] - [-GatewayDefaultSite <PSLocalNetworkGateway>] - [-VpnClientAddressPool <System.Collections.Generic.List`1[System.String]>] - [-VpnClientProtocol <System.Collections.Generic.List`1[System.String]>] - [-VpnClientRootCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate]>] - [-VpnClientRevokedCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate]>] - [-VpnClientIpsecPolicy <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy]>] - [-Asn <UInt32>] [-PeerWeight <Int32>] [-EnableActiveActiveFeature] [-DisableActiveActiveFeature] - -RadiusServerAddress <String> -RadiusServerSecret <SecureString> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVirtualNetworkGateway** cmdlet updates a virtual network gateway. - -## EXAMPLES - -### Example 1: Set the goal state a virtual network gateway -``` -PS C:\>$Gateway = Get-AzureRmVirtualNetworkGateway -ResourceGroupName "ResourceGroup001" -Name "Gateway001" -PS C:\> Set-AzureRmVirtualNetworkGateway -VirtualNetworkGateway $Gateway -Asn 1337 -``` - -The first command gets a virtual network gateway named Gateway01 that belongs to resource group ResourceGroup001 and stores it to the variable named $Gateway -The second command sets the goal state for the virtual network gateway stored in variable $Gateway. -The command also sets the ASN to 1337. - -### Example 2: Set the goal state a virtual network gateway -``` -PS C:\>$Gateway = Get-AzureRmVirtualNetworkGateway -ResourceGroupName "ResourceGroup001" -Name "Gateway001" -PS C:\> $vpnclientipsecpolicy = New-AzureRmVpnClientIpsecPolicy -IpsecEncryption AES256 -IpsecIntegrity SHA256 -SALifeTimeSeconds 86472 -SADataSizeKilobytes 429497 -IkeEncryption AES256 -IkeIntegrity SHA256 -DhGroup DHGroup2 -PfsGroup None -PS C:\> $gateway = Set-AzureRmVirtualNetworkGateway -VirtualNetworkGateway $Gateway -VpnClientIpsecPolicy $vpnclientipsecpolicy -``` - -The first command gets a virtual network gateway named Gateway01 that belongs to resource group ResourceGroup001 and stores it to the variable named $Gateway -The second command creates the Vpn ipsec policy object as per specified ipsec parameters. -The third command sets the goal state for the virtual network gateway stored in variable $Gateway. -The command also sets the custom vpn ipsec policy specified in the $vpnclientipsecpolicy object on Virtual network gateway. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Asn -Specifies the virtual network gateway Autonomous System Number (ASN) that is used to set up Border Gateway Protocol (BGP) sessions inside IPsec tunnels. - -```yaml -Type: System.UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableActiveActiveFeature -Disables the active-active feature. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableActiveActiveFeature -Enables the active-active feature. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GatewayDefaultSite -Specifies the default site to use for force tunneling. -If a default site is specified, all internet traffic from the gateway's Virtual Private Network (VPN) is routed to that site. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSLocalNetworkGateway -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GatewaySku -Specifies the stock keeping unit (SKU) of the virtual network gateway. -The acceptable values for this parameter are: -- Basic -- Standard -- HighPerformance -- VpnGw1 -- VpnGw2 -- VpnGw3 -- VpnGw1AZ -- VpnGw2AZ -- VpnGw3AZ -- ErGw1AZ -- ErGw2AZ -- ErGw3AZ - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Basic, Standard, HighPerformance, UltraPerformance, VpnGw1, VpnGw2, VpnGw3, VpnGw1AZ, VpnGw2AZ, VpnGw3AZ, ErGw1AZ, ErGw2AZ, ErGw3AZ - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PeerWeight -Specifies the weight added to routes learned over BGP from this virtual network gateway - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RadiusServerAddress -P2S External Radius server address. - -```yaml -Type: System.String -Parameter Sets: RadiusServerConfiguration -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RadiusServerSecret -P2S External Radius server secret. - -```yaml -Type: System.Security.SecureString -Parameter Sets: RadiusServerConfiguration -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkGateway -Specifies the virtual network gateway object to base modifications off of. -You can use the Get-AzureRmVirtualNetworkGateway cmdlet to get the virtual network gateway object. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VpnClientAddressPool -Specifies the address space that this cmdlet uses to allocate VPN client IP addresses from. -This should not overlap with virtual network or on-premise ranges. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VpnClientIpsecPolicy -A list of IPSec policies for P2S VPN client tunneling protocols. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VpnClientProtocol -A list of P2S VPN client tunneling protocols - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: -Accepted values: SSTP, IkeV2, OpenVPN - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VpnClientRevokedCertificates -Specifies a list of revoked VPN client certificates. -A VPN client presenting a certificate that matches one of these is removed. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VpnClientRootCertificates -Specifies a list of VPN client root certificates to use for VPN client authentication. -Connecting VPN clients must present certificates generated from one of these root certificates. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway -Parameters: VirtualNetworkGateway (ByValue) - -### System.String - -### Microsoft.Azure.Commands.Network.Models.PSLocalNetworkGateway - -### System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -### System.UInt32 - -### System.Int32 - -### System.Security.SecureString - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Get-AzureRmVirtualNetworkGateway](./Get-AzureRmVirtualNetworkGateway.md) - -[New-AzureRmVirtualNetworkGateway](./New-AzureRmVirtualNetworkGateway.md) - -[Remove-AzureRmVirtualNetworkGateway](./Remove-AzureRmVirtualNetworkGateway.md) - -[Reset-AzureRmVirtualNetworkGateway](./Reset-AzureRmVirtualNetworkGateway.md) - -[Resize-AzureRmVirtualNetworkGateway](./Resize-AzureRmVirtualNetworkGateway.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetworkGatewayConnection.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetworkGatewayConnection.md deleted file mode 100644 index e6a30ceae6..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetworkGatewayConnection.md +++ /dev/null @@ -1,230 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: D7065B04-1A01-4BB4-A519-1DA9002CDE02 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermvirtualnetworkgatewayconnection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmVirtualNetworkGatewayConnection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmVirtualNetworkGatewayConnection.md ---- - -# Set-AzureRmVirtualNetworkGatewayConnection - -## SYNOPSIS -Configures a virtual network gateway connection. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVirtualNetworkGatewayConnection -VirtualNetworkGatewayConnection <PSVirtualNetworkGatewayConnection> - [-EnableBgp <Boolean>] [-UsePolicyBasedTrafficSelectors <Boolean>] - [-IpsecPolicies <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy]>] - [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVirtualNetworkGatewayConnection** cmdlet configures a virtual network gateway connection. - -## EXAMPLES - -### Example 1: -``` -$conn = Get-AzureRmVirtualNetworkGatewayConnection -Name 1 -ResourceGroupName myRG -Set-AzureRmVirtualNetworkGatewayConnection -VirtualNetworkGatewayConnection $conn - -Confirm -Are you sure you want to overwrite resource '1' -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y - - -Name : 1 -ResourceGroupName : myRG -Location : westus -Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Mi - crosoft.Network/connections/1 -Etag : W/"00000000-0000-0000-0000-000000000000" -ResourceGuid : 00000000-0000-0000-0000-000000000000 -ProvisioningState : Succeeded -Tags : -AuthorizationKey : -VirtualNetworkGateway1 : "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/M - icrosoft.Network/virtualNetworkGateways/myGateway" -VirtualNetworkGateway2 : "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/S2SVnetConn/providers/Mic - rosoft.Network/virtualNetworkGateways/S2SConnGW" -LocalNetworkGateway2 : -Peer : -RoutingWeight : 0 -SharedKey : -ConnectionStatus : Connected -EgressBytesTransferred : 91334484 -IngressBytesTransferred : 100386089 -TunnelConnectionStatus : [] -``` - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableBgp -Whether to use a BGP session over a S2S VPN tunnel - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IpsecPolicies -A list of IPSec policies. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UsePolicyBasedTrafficSelectors -Whether to use policy-based traffic selectors for a S2S connection - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkGatewayConnection -Specifies the PSVirtualNetworkGatewayConnection object that this cmdlet uses to modify the virtual network gateway connection. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayConnection -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayConnection -Parameters: VirtualNetworkGatewayConnection (ByValue) - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayConnection - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVirtualNetworkGatewayConnection](./Get-AzureRmVirtualNetworkGatewayConnection.md) - -[New-AzureRmVirtualNetworkGatewayConnection](./New-AzureRmVirtualNetworkGatewayConnection.md) - -[Remove-AzureRmVirtualNetworkGatewayConnection](./Remove-AzureRmVirtualNetworkGatewayConnection.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetworkGatewayConnectionSharedKey.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetworkGatewayConnectionSharedKey.md deleted file mode 100644 index f552d72c63..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetworkGatewayConnectionSharedKey.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 78BADAF3-6001-4A25-A74D-F6B50079FCB4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermvirtualnetworkgatewayconnectionsharedkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmVirtualNetworkGatewayConnectionSharedKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmVirtualNetworkGatewayConnectionSharedKey.md ---- - -# Set-AzureRmVirtualNetworkGatewayConnectionSharedKey - -## SYNOPSIS -Configures the shared key of the virtual network gateway connection. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVirtualNetworkGatewayConnectionSharedKey -Name <String> -ResourceGroupName <String> -Value <String> - [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVirtualNetworkGatewayConnectionSharedKey** cmdlet configures the shared key of the virtual network gateway connection. - -## EXAMPLES - -### Example 1: -``` -PS C:\Users\alzam> Set-AzureRmVirtualNetworkGatewayConnectionSharedKey -ResourceGroupName VPNGatewayV3 -Name VNet1toVNet2 -Value abcd1234 - -Confirm -Are you sure you want to overwrite resource 'VNet1toVNet2' -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y -abcd1234 -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual network gateway shared key. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the virtual network gateway belongs to - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Value -Specifies the value of the shared key. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVirtualNetworkGatewayConnectionSharedKey](./Get-AzureRmVirtualNetworkGatewayConnectionSharedKey.md) - -[Reset-AzureRmVirtualNetworkGatewayConnectionSharedKey](./Reset-AzureRmVirtualNetworkGatewayConnectionSharedKey.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetworkGatewayDefaultSite.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetworkGatewayDefaultSite.md deleted file mode 100644 index f679a6a849..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetworkGatewayDefaultSite.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: A27EE9C0-C7F5-4BF6-AE52-58087BD1B1C3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermvirtualnetworkgatewaydefaultsite -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmVirtualNetworkGatewayDefaultSite.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmVirtualNetworkGatewayDefaultSite.md ---- - -# Set-AzureRmVirtualNetworkGatewayDefaultSite - -## SYNOPSIS -Sets the default site for a virtual network gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVirtualNetworkGatewayDefaultSite -VirtualNetworkGateway <PSVirtualNetworkGateway> - -GatewayDefaultSite <PSLocalNetworkGateway> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVirtualNetworkGatewayDefaultSite** cmdlet assigns a forced tunneling default site to a virtual network gateway. -Forced tunneling provides a way for you to redirect Internet-bound traffic from Azure virtual machines to your on-premises network; this enables you to inspect and audit traffic before releasing it. -Forced tunneling is carried out by using a virtual private network (VPN) tunnel; this tunnel requires a default site, a local gateway where all the Azure Internet-bound traffic is redirected. -**Set-AzureRmVirtualNetworkGatewayDefaultSite** provides a way to change the default site assigned to a gateway. - -## EXAMPLES - -### Example 1: Assign a default site to a virtual network gateway -``` -PS C:\>$LocalGateway = Get-AzureRmLocalNetworkGateway -Name "ContosoLocalGateway " -ResourceGroup "ContosoResourceGroup" -PS C:\> $VirtualGateway = Get-AzureRmVirtualNetworkGateway -Name "ContosoVirtualGateway" -PS C:\> Set-AzureRmVirtualNetworkGatewayDefaultSite -GatewayDefaultSite $LocalGateway -VirtualNetworkGateway $VirtualGateway -``` - -This example assigns a default site to a virtual network gateway named ContosoVirtualGateway. -The first command creates an object reference to a local gateway named ContosoLocalGateway. -This object reference that is stored in the variable named $LocalGateway represents the gateway to be configured as the default site -. -The second command then creates an object reference to the virtual network gateway and stores the result in the variable named $VirtualGateway. -The third command uses the **Set-AzureRmVirtualNetworkGatewayDefaultSite** cmdlet to assign the default site to ContosoVirtualGateway. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GatewayDefaultSite -Specifies an object reference to the local network gateway to be assigned as the default site for the specified virtual network. -You can use the Get-AzureRmLocalNetworkGateway cmdlet to create an object reference to a local gateway. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSLocalNetworkGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkGateway -Specifies an object reference to the virtual network gateway where the default site will be assigned. -You can create an object reference to a virtual network gateway by using the **Get-AzureRmVirtualNetworkGateway** and specifying the name of the gateway. -The variable $VirtualGateway can then be used as the parameter value for the *VirtualNetworkGateway* parameter: - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway -Parameters: VirtualNetworkGateway (ByValue) - -### Microsoft.Azure.Commands.Network.Models.PSLocalNetworkGateway - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLocalNetworkGateway](./Get-AzureRmLocalNetworkGateway.md) - -[Get-AzureRmVirtualNetworkGateway](./Get-AzureRmVirtualNetworkGateway.md) - -[Remove-AzureRmVirtualNetworkGatewayDefaultSite](./Remove-AzureRmVirtualNetworkGatewayDefaultSite.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetworkGatewayVpnClientConfig.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetworkGatewayVpnClientConfig.md deleted file mode 100644 index 1636e0d068..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetworkGatewayVpnClientConfig.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: EFB0D7A6-0C8A-4514-873D-672641CCCAF3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermvirtualnetworkgatewayvpnclientconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmVirtualNetworkGatewayVpnClientConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmVirtualNetworkGatewayVpnClientConfig.md ---- - -# Set-AzureRmVirtualNetworkGatewayVpnClientConfig - -## SYNOPSIS -Sets the VPN client address pool for a virtual network gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Default (Default) -``` -Set-AzureRmVirtualNetworkGatewayVpnClientConfig -VirtualNetworkGateway <PSVirtualNetworkGateway> - -VpnClientAddressPool <System.Collections.Generic.List`1[System.String]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RadiusServerConfiguration -``` -Set-AzureRmVirtualNetworkGatewayVpnClientConfig -VirtualNetworkGateway <PSVirtualNetworkGateway> - -VpnClientAddressPool <System.Collections.Generic.List`1[System.String]> -RadiusServerAddress <String> - -RadiusServerSecret <SecureString> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVirtualNetworkVpnClientConfig** cmdlet configures the client address pool for a virtual network gateway. -Virtual private network (VPN) clients that connect to this gateway will be assigned an IP address from this address pool. - -## EXAMPLES - -### Example 1: Assign a VPN client address pool to a virtual network gateway -``` -PS C:\>$Gateway = Get-AzureRmVirtualNetworkGateway -Name "ContosoVirtualGateway" -PS C:\> Set-AzureRmVirtualNetworkGatewayVpnClientConfig -VirtualNetworkGateway $Gateway -VpnClientAddressPool "10.0.0.0/16" -``` - -This example assigns a VPN client address pool to a virtual network gateway named ContosoVirtualGateway. -The first command creates an object reference to the gateway and the object is stored in a variable named $Gateway. -The second command in the example then uses the **Set-AzureRmVirtualNetworkGatewayVpnClientConfig** cmdlet to assign the address pool 10.0.0.0/16 to ContosoVirtualGateway. - -### Example 2: Configure external radius based authentication on existing gateway -``` -PS C:\>$Gateway = Get-AzureRmVirtualNetworkGateway -Name "ContosoVirtualGateway" -PS C:\> $Secure_String_Pwd = ConvertTo-SecureString "TestRadiusServerPassword" -AsPlainText -Force -PS C:\> Set-AzureRmVirtualNetworkGatewayVpnClientConfig -VirtualNetworkGateway $Gateway -VpnClientAddressPool "10.0.0.0/16" -RadiusServerAddress "TestRadiusServer" -RadiusServerSecret $Secure_String_Pwd -``` - -This example assigns a VPN client address pool to a virtual network gateway named ContosoVirtualGateway. -The first command creates an object reference to the gateway and the object is stored in a variable named $Gateway. -The second command in the example then uses the **Set-AzureRmVirtualNetworkGatewayVpnClientConfig** cmdlet to assign the address pool 10.0.0.0/16 to ContosoVirtualGateway. It also configures the external radius server "TestRadiusServer" to be used for authentication for vpn clients. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RadiusServerAddress -P2S External Radius server address. - -```yaml -Type: System.String -Parameter Sets: RadiusServerConfiguration -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RadiusServerSecret -P2S External Radius server secret. - -```yaml -Type: System.Security.SecureString -Parameter Sets: RadiusServerConfiguration -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkGateway -Specifies an object reference to the virtual network gateway that contains the VPN client configuration settings that this cmdlet modifies. -You can create an object reference to a virtual network gateway by using the Get-AzureRmVirtualNetworkGateway and specifying the name of the gateway. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VpnClientAddressPool -Specifies the IP addresses to be assigned to clients connecting to this gateway - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway -Parameters: VirtualNetworkGateway (ByValue) - -### System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.String - -### System.Security.SecureString - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVpnClientPackage](./Get-AzureRmVpnClientPackage.md) - -[Get-AzureRmVirtualNetworkGateway](./Get-AzureRmVirtualNetworkGateway.md) - -[Resize-AzureRmVirtualNetworkGateway](./Resize-AzureRmVirtualNetworkGateway.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetworkPeering.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetworkPeering.md deleted file mode 100644 index 76c6fec3f5..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetworkPeering.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 06DAD751-3A43-4EF6-94C5-AA7AC1A67FC8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermvirtualnetworkpeering -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmVirtualNetworkPeering.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmVirtualNetworkPeering.md ---- - -# Set-AzureRmVirtualNetworkPeering - -## SYNOPSIS -Configures a virtual network peering. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVirtualNetworkPeering -VirtualNetworkPeering <PSVirtualNetworkPeering> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVirtualNetworkPeering** cmdlet configures a virtual network peering. - -## EXAMPLES - -### Example 1: Change forwarded traffic configuration of a virtual network peering -``` -# Get the virtual network peering you want to update information for -Get-AzureRmVirtualNetworkPeering -VirtualNetworkName "myVnet1" -ResourceGroupName "ResourceGroup" -Name "myVnet1ToMyVnet2" - -# Change value of AllowForwardedTraffic property -$myVnet1ToMyVnet2.AllowForwardedTraffic = $True - -# Update the peering with changes made -Set-AzureRmVirtualNetworkPeering -VirtualNetworkPeering $myVnet1ToMyVnet2 -``` - -### Example 2: Change virtual network access of a virtual network peering -``` -# Get the virtual network peering -$myVnet1TomyVnet2 = Get-AzureRmVirtualNetworkPeering -VirtualNetworkName "myVnet1" -ResourceGroupName "myResourceGroup" -Name "myVnet1TomyVnet2" - -# Change AllowVirtualNetworkAccess property -$myVnet1TomyVnet2.AllowVirtualNetworkAccess = $False - -# Update virtual network peering -Set-AzureRmVirtualNetworkPeering -VirtualNetworkPeering $myVnet1TomyVnet2 -``` - -### Example 3: Change gateway transit property configuration of a virtual network peering -``` -# Get the virtual network peering -$myVnet1TomyVnet2 = Get-AzureRmVirtualNetworkPeering -VirtualNetworkName "myVnet1" -ResourceGroupName "myResourceGroup" -Name "myVnet1TomyVnet2" - -# Change AllowGatewayTransit property -$myVnet1TomyVnet2.AllowGatewayTransit = $True - -# Update the virtual network peering -Set-AzureRmVirtualNetworkPeering -VirtualNetworkPeering $myVnet1TomyVnet2 -``` - -### Example 4: Use remote gateways in virtual network peering -``` -# Get the virtual network peering -$myVnet1TomyVnet2 = Get-AzureRmVirtualNetworkPeering -VirtualNetworkName "myVnet1" -ResourceGroupName "ResourceGroup001" -Name "myVnet1TomyVnet2" - -# Change the UseRemoteGateways property -$myVnet1TomyVnet2.UseRemoteGateways = $True - -# Update the virtual network peering -Set-AzureRmVirtualNetworkPeering -VirtualNetworkPeering $LinkToVNet2 -``` - -By changing this property to $True, your peer's VNet gateway can be used. -However, the peer VNet must have a gateway configured and **AllowGatewayTransit** must have a value of $True. -This property cannot be used if a gateway has already been configured. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkPeering -Specifies the virtual network peering. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkPeering -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkPeering -Parameters: VirtualNetworkPeering (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkPeering - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVirtualNetworkPeering](./Add-AzureRmVirtualNetworkPeering.md) - -[Get-AzureRmVirtualNetworkPeering](./Get-AzureRmVirtualNetworkPeering.md) - -[Remove-AzureRmVirtualNetworkPeering](./Remove-AzureRmVirtualNetworkPeering.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetworkSubnetConfig.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetworkSubnetConfig.md deleted file mode 100644 index a951d24639..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetworkSubnetConfig.md +++ /dev/null @@ -1,295 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: D1D51DEF-05DE-45C4-9013-A02A5B248EAC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermvirtualnetworksubnetconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmVirtualNetworkSubnetConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmVirtualNetworkSubnetConfig.md ---- - -# Set-AzureRmVirtualNetworkSubnetConfig - -## SYNOPSIS -Configures the goal state for a subnet configuration in a virtual network. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Set-AzureRmVirtualNetworkSubnetConfig -Name <String> -VirtualNetwork <PSVirtualNetwork> - -AddressPrefix <System.Collections.Generic.List`1[System.String]> - [-NetworkSecurityGroup <PSNetworkSecurityGroup>] [-RouteTable <PSRouteTable>] - [-ServiceEndpoint <System.Collections.Generic.List`1[System.String]>] - [-ServiceEndpointPolicy <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy]>] - [-Delegation <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSDelegation]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResourceId -``` -Set-AzureRmVirtualNetworkSubnetConfig -Name <String> -VirtualNetwork <PSVirtualNetwork> - -AddressPrefix <System.Collections.Generic.List`1[System.String]> [-NetworkSecurityGroupId <String>] - [-RouteTableId <String>] [-ServiceEndpoint <System.Collections.Generic.List`1[System.String]>] - [-ServiceEndpointPolicy <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy]>] - [-Delegation <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSDelegation]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVirtualNetworkSubnetConfig** cmdlet configures the goal state for a subnet configuration in an Azure virtual network. - -## EXAMPLES - -### 1: Modify the address prefix of a subnet -``` -New-AzureRmResourceGroup -Name TestResourceGroup -Location centralus - -$frontendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" - -$virtualNetwork = New-AzureRmVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup - -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet - -Set-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet -VirtualNetwork $virtualNetwork -AddressPrefix "10.0.3.0/23" - -$virtualNetwork | Set-AzureRmVirtualNetwork -``` - -This example creates a virtual network with one subnet. Then is calls - Set-AzureRmVirtualNetworkSubnetConfig to modify the AddressPrefix of the subnet. This - only impacts the in-memory representation of the virtual network. - Set-AzureRmVirtualNetwork is then called to modify the virtual network in Azure. - -### 2: Add a network security group to a subnet -``` -New-AzureRmResourceGroup -Name TestResourceGroup -Location centralus - -$frontendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" - -$virtualNetwork = New-AzureRmVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup - -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet - -$rdpRule = New-AzureRmNetworkSecurityRuleConfig -Name rdp-rule -Description "Allow RDP" -Access Allow - -Protocol Tcp -Direction Inbound -Priority 100 -SourceAddressPrefix Internet -SourcePortRange * -DestinationAddressPrefix * -DestinationPortRange 3389 - -$networkSecurityGroup = New-AzureRmNetworkSecurityGroup -ResourceGroupName - TestResourceGroup -Location centralus -Name "NSG-FrontEnd" -SecurityRules $rdpRule - -Set-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet -VirtualNetwork $virtualNetwork -AddressPrefix - "10.0.1.0/24" -NetworkSecurityGroup $networkSecurityGroup - -$virtualNetwork | Set-AzureRmVirtualNetwork -``` - -This example creates a resource group with one virtual network containing just one - subnet. It then creates a network security group with an allow rule for RDP traffic. The - Set-AzureRmVirtualNetworkSubnetConfig cmdlet is used to modify the in-memory - representation of the frontend subnet so that it points to the newly created network - security group. The Set-AzureRmVirtualNetwork cmdlet is then called to write the modified - state back to the service. - -## PARAMETERS - -### -AddressPrefix -Specifies a range of IP addresses for a subnet configuration. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Delegation -List of services that have permission to perform operations on this subnet. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSDelegation] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a subnet configuration that this cmdlet configures. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkSecurityGroup -Specifies a **NetworkSecurityGroup** object. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkSecurityGroupId -Specifies the ID of a network security group. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RouteTable -Specifies the route table object that is associated with the network security group. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSRouteTable -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RouteTableId -Specifies the ID of the route table object that is associated with the network security group. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceEndpoint -Service Endpoint Value - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceEndpointPolicy -Service Endpoint Policies - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetwork -Specifies the **VirtualNetwork** object that contains the subnet configuration. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork - -### System.String - -### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup - -### Microsoft.Azure.Commands.Network.Models.PSRouteTable - -### System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSServiceEndpointPolicy, Microsoft.Azure.Commands.Network, Version=6.7.0.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSDelegation, Microsoft.Azure.Commands.Network, Version=6.7.0.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVirtualNetworkSubnetConfig](./Add-AzureRmVirtualNetworkSubnetConfig.md) - -[Get-AzureRmVirtualNetworkSubnetConfig](./Get-AzureRmVirtualNetworkSubnetConfig.md) - -[New-AzureRmVirtualNetworkSubnetConfig](./New-AzureRmVirtualNetworkSubnetConfig.md) - -[Remove-AzureRmVirtualNetworkSubnetConfig](./Remove-AzureRmVirtualNetworkSubnetConfig.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetworkTap.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetworkTap.md deleted file mode 100644 index 0fda8024ce..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmVirtualNetworkTap.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermvirtualnetworktap -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmVirtualNetworkTap.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmVirtualNetworkTap.md ---- - -# Set-AzureRmVirtualNetworkTap - -## SYNOPSIS -Sets the goal state for a virtual network tap. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVirtualNetworkTap -VirtualNetworkTap <PSVirtualNetworkTap> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVirtualNetworkTap** sets the goal state for an Azure virtual network tap. - -## EXAMPLES - -### Example 1: Configure a Virtual network tap -``` -PS C:\>$vTap = Get-AzureRmVirtualNetworkTap -ResourceGroupName "ResourceGroup1" -Name "VirtualTap1" -PS C:\>$vTap.DestinationNetworkInterfaceIPConfiguration = $newDestinationNic.IpConfigurations[0] -PS C:\>Set-AzureRmVirtualNetworkTap -VirtualNetworkTap $vTap -``` - -The command updates the Destination IpConfiguration and updates the Virtual network tap. -If there are any tap configurations referencing it, then all the source traffic will not start be mirrored to new destination ip configuration post update. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkTap -The virtual network tap - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkTap -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkTap - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkTap - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmVpnClientIpsecParameter.md b/azurermps-6.13.0/AzureRM.Network/Set-AzureRmVpnClientIpsecParameter.md deleted file mode 100644 index eb388825c0..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Set-AzureRmVpnClientIpsecParameter.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermvpnclientipsecparameter -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmVpnClientIpsecParameter.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Set-AzureRmVpnClientIpsecParameter.md ---- - -# Set-AzureRmVpnClientIpsecParameter - -## SYNOPSIS -Sets the vpn ipsec parameters for existing virtual network gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFactoryName (Default) -``` -Set-AzureRmVpnClientIpsecParameter -VirtualNetworkGatewayName <String> -ResourceGroupName <String> - -VpnClientIPsecParameter <PSVpnClientIPsecParameters> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ByFactoryObject -``` -Set-AzureRmVpnClientIpsecParameter -VirtualNetworkGatewayName <String> -ResourceGroupName <String> - -VpnClientIPsecParameter <PSVpnClientIPsecParameters> -InputObject <PSVirtualNetworkGateway> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Set-AzureRmVpnClientIpsecParameter -VirtualNetworkGatewayName <String> -ResourceGroupName <String> - -VpnClientIPsecParameter <PSVpnClientIPsecParameters> -ResourceId <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVpnClientIpsecParameter** cmdlet sets the vpn ipsec parameters for existing virtual network gateway. -When Virtual network gateway is created, it sets the set of default vpn ipsec policies on Gateway. In case, Point to site user wants to use certain custom ipsec policy to connect to VPN Gateway, user has to set that ipsec policy on VPN Gateway first. **Set-AzureRmVpnClientIpsecParameter** provides a way to do that. - -## EXAMPLES - -### Example 1 : Sets a custom vpn ipsec policy to existing virtual network gateway. -```powershell -PS C:\>$vpnclientipsecparams = New-AzureRmVpnClientIpsecParameter -IpsecEncryption AES256 -IpsecIntegrity SHA256 -SALifeTime 86473 -SADataSize 429498 -IkeEncryption AES256 -IkeIntegrity SHA384 -DhGroup DHGroup2 -PfsGroup PFS2 -PS C:\> $setvpnIpsecParams = Set-AzureRmVpnClientIpsecParameter -VirtualNetworkGatewayName "ContosoLocalGateway" -ResourceGroupName "ContosoResourceGroup" -VpnClientIPsecParameter $vpnclientipsecparams -``` - -This example sets custom vpn ipsec policy to existing virtual network gateway named ContosoVirtualGateway from Resource group named ContosoResourceGroup. -New-AzureRmVpnClientIpsecParameter cmdlet is used to create the vpn ipsec parameters object of using the passed one or all parameters' values which user can set for any existing Virtual network gateway in ResourceGroup. -This created VpnClientIPsecParameters object is passed to Set-AzureRmVpnClientIpsecParameter command to set the specified Vpn ipsec custom policy on Virtual network gateway as shown in above example. This command returns object of VpnClientIPsecParameters which shows set parameters. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The virtual network gateaway object - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway -Parameter Sets: ByFactoryObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkGatewayName -The virtual network gateway name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VpnClientIPsecParameter -Vpn client ipsec parameters. This parameter value can be constructed using PS command let:New-AzureRmVpnClientIpsecParameter - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVpnClientIPsecParameters -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVpnClientIPsecParameters -Parameters: VpnClientIPsecParameter (ByValue) - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVpnClientIPsecParameters - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-6.13.0/AzureRM.Network/Start-AzureRmApplicationGateway.md b/azurermps-6.13.0/AzureRM.Network/Start-AzureRmApplicationGateway.md deleted file mode 100644 index 98d3ac2bce..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Start-AzureRmApplicationGateway.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 95731734-EDCA-432A-A7BF-94D1E3725FB2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/start-azurermapplicationgateway -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Start-AzureRmApplicationGateway.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Start-AzureRmApplicationGateway.md ---- - -# Start-AzureRmApplicationGateway - -## SYNOPSIS -Starts an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Start-AzureRmApplicationGateway -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Start-AzureRmApplicationGateway** cmdlet starts an Azure application gateway - -## EXAMPLES - -### Example1: Start an application gateway -``` -PS C:\>$AppGw = Start-AzureRmApplicationGateway -ApplicationGateway $AppGw -``` - -This command starts the application gateway stored in the $AppGw variable. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway that this cmdlet starts. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Stop-AzureRmApplicationGateway](./Stop-AzureRmApplicationGateway.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Start-AzureRmNetworkWatcherConnectionMonitor.md b/azurermps-6.13.0/AzureRM.Network/Start-AzureRmNetworkWatcherConnectionMonitor.md deleted file mode 100644 index e8829ed344..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Start-AzureRmNetworkWatcherConnectionMonitor.md +++ /dev/null @@ -1,319 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/start-azurermapplicationgateway -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Start-AzureRmNetworkWatcherConnectionMonitor.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Start-AzureRmNetworkWatcherConnectionMonitor.md ---- - -# Start-AzureRmNetworkWatcherConnectionMonitor - -## SYNOPSIS -Start a connection monitor - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByName (Default) -``` -Start-AzureRmNetworkWatcherConnectionMonitor -NetworkWatcherName <String> -ResourceGroupName <String> - -Name <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### SetByResource -``` -Start-AzureRmNetworkWatcherConnectionMonitor -NetworkWatcher <PSNetworkWatcher> -Name <String> [-PassThru] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByLocation -``` -Start-AzureRmNetworkWatcherConnectionMonitor -Location <String> -Name <String> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByResourceId -``` -Start-AzureRmNetworkWatcherConnectionMonitor -ResourceId <String> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByInputObject -``` -Start-AzureRmNetworkWatcherConnectionMonitor -InputObject <PSConnectionMonitorResult> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Start-AzureRmNetworkWatcherConnectionMonitor cmdlet starts the specified connection monitor. - -## EXAMPLES - -### Example 1: Start a connection monitor -``` -PS C:\> Start-AzureRmNetworkWatcherConnectionMonitor -NetworkWatcherName NetworkWatcher_centraluseuap -ResourceGroupName NetworkWatcherRG -Name cm -``` - -In this example we start connection monitor specified by name and network watcher - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Connection monitor object. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResult -Parameter Sets: SetByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Location -Location of the network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByLocation -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The connection monitor name. - -```yaml -Type: System.String -Parameter Sets: SetByName, SetByResource, SetByLocation -Aliases: ConnectionMonitorName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameters: NetworkWatcher (ByValue) - -### System.String - -### Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResult -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES -Keywords: azure, azurerm, arm, resource, connectivity, management, manager, network, networking, network watcher, connection monitor - -## RELATED LINKS - -[New-AzureRmNetworkWatcher]() - -[Get-AzureRmNetworkWatcher]() - -[Remove-AzureRmNetworkWatcher]() - -[Get-AzureRmNetworkWatcherNextHop]() - -[Get-AzureRmNetworkWatcherSecurityGroupView]() - -[Get-AzureRmNetworkWatcherTopology]() - -[Get-AzureRmNetworkWatcherTroubleshootingResult]() - -[New-AzureRmNetworkWatcherPacketCapture]() - -[New-AzureRmPacketCaptureFilterConfig]() - -[Get-AzureRmNetworkWatcherPacketCapture]() - -[Remove-AzureRmNetworkWatcherPacketCapture]() - -[Stop-AzureRmNetworkWatcherPacketCapture]() - -[Get-AzureRmNetworkWatcherConnectionMonitor]() - -[Get-AzureRmNetworkWatcherConnectionMonitorReport]() - -[Remove-AzureRmNetworkWatcherConnectionMonitor]() - -[Set-AzureRmNetworkWatcherConnectionMonitor]() - -[Stop-AzureRmNetworkWatcherConnectionMonitor]() - -[New-AzureRmNetworkWatcherConnectionMonitor]() - -[New-AzureRmNetworkWatcherProtocolConfiguration]() - -[Test-AzureRmNetworkWatcherIPFlow]() - -[Test-AzureRmNetworkWatcherConnectivity]() - -[Start-AzureRmNetworkWatcherResourceTroubleshooting]() - -[Start-AzureRmNetworkWatcherConnectionMonitor]() - -[Set-AzureRmNetworkWatcherConfigFlowLog]() - -[Get-AzureRMNetworkWatcherReachabilityReport]() - -[Get-AzureRmNetworkWatcherReachabilityProvidersList]() - -[Get-AzureRmNetworkWatcherFlowLogStatus]() diff --git a/azurermps-6.13.0/AzureRM.Network/Start-AzureRmNetworkWatcherResourceTroubleshooting.md b/azurermps-6.13.0/AzureRM.Network/Start-AzureRmNetworkWatcherResourceTroubleshooting.md deleted file mode 100644 index f20edb65cb..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Start-AzureRmNetworkWatcherResourceTroubleshooting.md +++ /dev/null @@ -1,252 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/start-azurermnetworkwatcherresourcetroubleshooting -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Start-AzureRmNetworkWatcherResourceTroubleshooting.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Start-AzureRmNetworkWatcherResourceTroubleshooting.md ---- - -# Start-AzureRmNetworkWatcherResourceTroubleshooting - -## SYNOPSIS -Starts troubleshooting on a Networking resource in Azure. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Start-AzureRmNetworkWatcherResourceTroubleshooting -NetworkWatcher <PSNetworkWatcher> - -TargetResourceId <String> -StorageId <String> -StoragePath <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByName -``` -Start-AzureRmNetworkWatcherResourceTroubleshooting -NetworkWatcherName <String> -ResourceGroupName <String> - -TargetResourceId <String> -StorageId <String> -StoragePath <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByLocation -``` -Start-AzureRmNetworkWatcherResourceTroubleshooting -Location <String> -TargetResourceId <String> - -StorageId <String> -StoragePath <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Start-AzureRmNetworkWatcherResourceTroubleshooting cmdlet starts troubleshooting for a Networking resource in Azure and returns information about potential issues and mitigations. Currently Virtual Network Gateways and Connections are supported. - -## EXAMPLES - -### Example 1: Start Troubleshooting on a Virtual Network Gateway -``` -$nw = Get-AzurermResource | Where {$_.ResourceType -eq "Microsoft.Network/networkWatchers" -and $_.Location -eq "WestCentralUS" } -$networkWatcher = Get-AzureRmNetworkWatcher -Name $nw.Name -ResourceGroupName $nw.ResourceGroupName - -$target = '/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{vnetGatewayName}' -$storageId = '/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{storageAccountName}' -$storagePath = 'https://{storageAccountName}.blob.core.windows.net/troubleshoot' - -Start-AzureRmNetworkWatcherResourceTroubleshooting -NetworkWatcher $networkWatcher -TargetResourceId $target -StorageId $storageId -StoragePath $storagePath -``` - -The above sample starts troubleshooting on a virtual network gateway. The operation may take a few minutes to complete. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Location of the network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByLocation -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageId -The storage ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StoragePath -The storage path. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetResourceId -Specifies the resource id of the resource to troubleshoot. Example format: "/subscriptions/${subscriptionId}/resourceGroups/${resourceGroupName}/providers/Microsoft.Network/connections/${connectionName}" - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameters: NetworkWatcher (ByValue) - -### System.String -Parameters: NetworkWatcherName (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSTroubleshootingResult - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, troubleshoot, VPN, connection - -## RELATED LINKS - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmNetworkWatcherProtocolConfiguration](./New-AzureRmNetworkWatcherProtocolConfiguration.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Test-AzureRmNetworkWatcherConnectivity](./Test-AzureRmNetworkWatcherConnectivity.md) - -[Stop-AzureRmNetworkWatcherConnectionMonitor](./Stop-AzureRmNetworkWatcherConnectionMonitor.md) - -[Start-AzureRmNetworkWatcherConnectionMonitor](./Start-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConnectionMonitor](./Set-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConfigFlowLog](./Set-AzureRmNetworkWatcherConfigFlowLog.md) - -[Remove-AzureRmNetworkWatcherConnectionMonitor](./Remove-AzureRmNetworkWatcherConnectionMonitor.md) - -[New-AzureRmNetworkWatcherConnectionMonitor](./New-AzureRmNetworkWatcherConnectionMonitor.md) - -[Get-AzureRmNetworkWatcherTroubleshootingResult](./Get-AzureRmNetworkWatcherTroubleshootingResult.md) - -[Get-AzureRMNetworkWatcherReachabilityReport](./Get-AzureRMNetworkWatcherReachabilityReport.md) - -[Get-AzureRmNetworkWatcherReachabilityProvidersList](./Get-AzureRmNetworkWatcherReachabilityProvidersList.md) - -[Get-AzureRmNetworkWatcherFlowLogStatus](./Get-AzureRmNetworkWatcherFlowLogStatus.md) - -[Get-AzureRmNetworkWatcherConnectionMonitorReport](./Get-AzureRmNetworkWatcherConnectionMonitorReport.md) - -[Get-AzureRmNetworkWatcherConnectionMonitor](./Get-AzureRmNetworkWatcherConnectionMonitor.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Stop-AzureRmApplicationGateway.md b/azurermps-6.13.0/AzureRM.Network/Stop-AzureRmApplicationGateway.md deleted file mode 100644 index 0881e3042b..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Stop-AzureRmApplicationGateway.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 2C9609E8-0D8B-471B-9F0E-672BF55C3A0E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/stop-azurermapplicationgateway -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Stop-AzureRmApplicationGateway.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Stop-AzureRmApplicationGateway.md ---- - -# Stop-AzureRmApplicationGateway - -## SYNOPSIS -Stops an application gateway - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Stop-AzureRmApplicationGateway -ApplicationGateway <PSApplicationGateway> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Stop-AzureRmApplicationGateway** cmdlet stops an application gateway. - -## EXAMPLES - -### Example 1: Stop an application gateway -``` -PS C:\>Stop-AzureRmApplicationGateway -ApplicationGateway $AppGw -``` - -This command stops the application gateway stored in the $AppGw variable. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway that this cmdlet stops. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway -Parameters: ApplicationGateway (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGateway](./Get-AzureRmApplicationGateway.md) - -[New-AzureRmApplicationGateway](./New-AzureRmApplicationGateway.md) - -[Remove-AzureRmApplicationGateway](./Remove-AzureRmApplicationGateway.md) - -[Set-AzureRmApplicationGateway](./Set-AzureRmApplicationGateway.md) - -[Start-AzureRmApplicationGateway](./Start-AzureRmApplicationGateway.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Stop-AzureRmNetworkWatcherConnectionMonitor.md b/azurermps-6.13.0/AzureRM.Network/Stop-AzureRmNetworkWatcherConnectionMonitor.md deleted file mode 100644 index 08074d02a0..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Stop-AzureRmNetworkWatcherConnectionMonitor.md +++ /dev/null @@ -1,319 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/stop-azurermapplicationgateway -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Stop-AzureRmNetworkWatcherConnectionMonitor.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Stop-AzureRmNetworkWatcherConnectionMonitor.md ---- - -# Stop-AzureRmNetworkWatcherConnectionMonitor - -## SYNOPSIS -Stop a connection monitor - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByName (Default) -``` -Stop-AzureRmNetworkWatcherConnectionMonitor -NetworkWatcherName <String> -ResourceGroupName <String> - -Name <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### SetByResource -``` -Stop-AzureRmNetworkWatcherConnectionMonitor -NetworkWatcher <PSNetworkWatcher> -Name <String> [-PassThru] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByLocation -``` -Stop-AzureRmNetworkWatcherConnectionMonitor -Location <String> -Name <String> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByResourceId -``` -Stop-AzureRmNetworkWatcherConnectionMonitor -ResourceId <String> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByInputObject -``` -Stop-AzureRmNetworkWatcherConnectionMonitor -InputObject <PSConnectionMonitorResult> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Stop-AzureRmNetworkWatcherConnectionMonitor cmdlet stops the specified connection monitor. - -## EXAMPLES - -### Example 1: Stop a connection monitor -``` -PS C:\> Stop-AzureRmNetworkWatcherConnectionMonitor -NetworkWatcher $nw -Name cm -``` - -In this example we stop connection monitor specified by name and network watcher - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Connection monitor object. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResult -Parameter Sets: SetByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Location -Location of the network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByLocation -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The connection monitor name. - -```yaml -Type: System.String -Parameter Sets: SetByName, SetByResource, SetByLocation -Aliases: ConnectionMonitorName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameters: NetworkWatcher (ByValue) - -### System.String - -### Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResult -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES -Keywords: azure, azurerm, arm, resource, connectivity, management, manager, network, networking, network watcher, connection monitor - -## RELATED LINKS - -[New-AzureRmNetworkWatcher]() - -[Get-AzureRmNetworkWatcher]() - -[Remove-AzureRmNetworkWatcher]() - -[Get-AzureRmNetworkWatcherNextHop]() - -[Get-AzureRmNetworkWatcherSecurityGroupView]() - -[Get-AzureRmNetworkWatcherTopology]() - -[Get-AzureRmNetworkWatcherTroubleshootingResult]() - -[New-AzureRmNetworkWatcherPacketCapture]() - -[New-AzureRmPacketCaptureFilterConfig]() - -[Get-AzureRmNetworkWatcherPacketCapture]() - -[Remove-AzureRmNetworkWatcherPacketCapture]() - -[Stop-AzureRmNetworkWatcherPacketCapture]() - -[Get-AzureRmNetworkWatcherConnectionMonitor]() - -[Get-AzureRmNetworkWatcherConnectionMonitorReport]() - -[Remove-AzureRmNetworkWatcherConnectionMonitor]() - -[Set-AzureRmNetworkWatcherConnectionMonitor]() - -[Stop-AzureRmNetworkWatcherConnectionMonitor]() - -[New-AzureRmNetworkWatcherConnectionMonitor]() - -[New-AzureRmNetworkWatcherProtocolConfiguration]() - -[Test-AzureRmNetworkWatcherIPFlow]() - -[Test-AzureRmNetworkWatcherConnectivity]() - -[Start-AzureRmNetworkWatcherResourceTroubleshooting]() - -[Start-AzureRmNetworkWatcherConnectionMonitor]() - -[Set-AzureRmNetworkWatcherConfigFlowLog]() - -[Get-AzureRMNetworkWatcherReachabilityReport]() - -[Get-AzureRmNetworkWatcherReachabilityProvidersList]() - -[Get-AzureRmNetworkWatcherFlowLogStatus]() diff --git a/azurermps-6.13.0/AzureRM.Network/Stop-AzureRmNetworkWatcherPacketCapture.md b/azurermps-6.13.0/AzureRM.Network/Stop-AzureRmNetworkWatcherPacketCapture.md deleted file mode 100644 index 0072abe7b7..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Stop-AzureRmNetworkWatcherPacketCapture.md +++ /dev/null @@ -1,275 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/stop-azurermnetworkwatcherpacketcapture -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Stop-AzureRmNetworkWatcherPacketCapture.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Stop-AzureRmNetworkWatcherPacketCapture.md ---- - -# Stop-AzureRmNetworkWatcherPacketCapture - -## SYNOPSIS -Stops a running packet capture session - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Stop-AzureRmNetworkWatcherPacketCapture -NetworkWatcher <PSNetworkWatcher> -PacketCaptureName <String> - [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByName -``` -Stop-AzureRmNetworkWatcherPacketCapture -NetworkWatcherName <String> -ResourceGroupName <String> - -PacketCaptureName <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### SetByLocation -``` -Stop-AzureRmNetworkWatcherPacketCapture -Location <String> -PacketCaptureName <String> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Stop-AzureRmNetworkWatcherPacketCapture stops a running packet capture session. After the session is stopped, the packet capture file is uploaded to storage and/or saved locally on the VM depending on its configuration. - -## EXAMPLES - -### Example 1: Stop a packet capture session -``` -Stop-AzureRmNetworkWatcherPacketCapture -NetworkWatcher $networkWatcher -PacketCaptureName "PacketCaptureTest" -``` - -In this example we stop a running packet capture session named "PacketCaptureTest". After the session is stopped, the packet capture file is uploaded to storage and/or saved locally on the VM depending on its configuration. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Location of the network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByLocation -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PacketCaptureName -The packet capture name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameters: NetworkWatcher (ByValue) - -### System.String -Parameters: NetworkWatcherName (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, packet, capture, traffic - -## RELATED LINKS - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) - -[Get-AzureRmNetworkWatcherTroubleshootingResult](./Get-AzureRmNetworkWatcherTroubleshootingResult.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmNetworkWatcherProtocolConfiguration](./New-AzureRmNetworkWatcherProtocolConfiguration.md) - -[Test-AzureRmNetworkWatcherConnectivity](./Test-AzureRmNetworkWatcherConnectivity.md) - -[Stop-AzureRmNetworkWatcherConnectionMonitor](./Stop-AzureRmNetworkWatcherConnectionMonitor.md) - -[Start-AzureRmNetworkWatcherConnectionMonitor](./Start-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConnectionMonitor](./Set-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConfigFlowLog](./Set-AzureRmNetworkWatcherConfigFlowLog.md) - -[Remove-AzureRmNetworkWatcherConnectionMonitor](./Remove-AzureRmNetworkWatcherConnectionMonitor.md) - -[New-AzureRmNetworkWatcherConnectionMonitor](./New-AzureRmNetworkWatcherConnectionMonitor.md) - -[Get-AzureRMNetworkWatcherReachabilityReport](./Get-AzureRMNetworkWatcherReachabilityReport.md) - -[Get-AzureRmNetworkWatcherReachabilityProvidersList](./Get-AzureRmNetworkWatcherReachabilityProvidersList.md) - -[Get-AzureRmNetworkWatcherFlowLogStatus](./Get-AzureRmNetworkWatcherFlowLogStatus.md) - -[Get-AzureRmNetworkWatcherConnectionMonitorReport](./Get-AzureRmNetworkWatcherConnectionMonitorReport.md) - -[Get-AzureRmNetworkWatcherConnectionMonitor](./Get-AzureRmNetworkWatcherConnectionMonitor.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Test-AzureRmDnsAvailability.md b/azurermps-6.13.0/AzureRM.Network/Test-AzureRmDnsAvailability.md deleted file mode 100644 index 66133def59..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Test-AzureRmDnsAvailability.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 556A9F12-DF72-468F-9C3F-A747CC70BD2F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/test-azurermdnsavailability -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Test-AzureRmDnsAvailability.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Test-AzureRmDnsAvailability.md ---- - -# Test-AzureRmDnsAvailability - -## SYNOPSIS -Checks whether a domain name in the cloudapp.azure.com zone is available for use. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Test-AzureRmDnsAvailability -DomainNameLabel <String> -Location <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Checks whether a domain name in the cloudapp.azure.com zone is available for use. - -## EXAMPLES - -### Example 1: Check if contoso.cloudapp.azure.com is available for use. -``` -Test-AzureRmDnsAvailability -DomainNameLabel contoso -Location westus -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainNameLabel -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: DomainQualifiedName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Test-AzureRmNetworkWatcherConnectivity.md b/azurermps-6.13.0/AzureRM.Network/Test-AzureRmNetworkWatcherConnectivity.md deleted file mode 100644 index a6e5ad5e3d..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Test-AzureRmNetworkWatcherConnectivity.md +++ /dev/null @@ -1,316 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/test-azurermnetworkwatcherconnectivity -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Test-AzureRmNetworkWatcherConnectivity.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Test-AzureRmNetworkWatcherConnectivity.md ---- - -# Test-AzureRmNetworkWatcherConnectivity - -## SYNOPSIS -Returns connectivity information for a specified source VM and a destination. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Test-AzureRmNetworkWatcherConnectivity -NetworkWatcher <PSNetworkWatcher> -SourceId <String> - [-SourcePort <Int32>] [-DestinationId <String>] [-DestinationAddress <String>] [-DestinationPort <Int32>] - [-ProtocolConfiguration <PSNetworkWatcherProtocolConfiguration>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByName -``` -Test-AzureRmNetworkWatcherConnectivity -NetworkWatcherName <String> -ResourceGroupName <String> - -SourceId <String> [-SourcePort <Int32>] [-DestinationId <String>] [-DestinationAddress <String>] - [-DestinationPort <Int32>] [-ProtocolConfiguration <PSNetworkWatcherProtocolConfiguration>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByLocation -``` -Test-AzureRmNetworkWatcherConnectivity -Location <String> -SourceId <String> [-SourcePort <Int32>] - [-DestinationId <String>] [-DestinationAddress <String>] [-DestinationPort <Int32>] - [-ProtocolConfiguration <PSNetworkWatcherProtocolConfiguration>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Test-AzureRmNetworkWatcherConnectivity cmdlet returns connectivity information for a specified source VM and a destination. If connectivity between the source and destination cannot be established, the cmdlet returns details about the issue. - -## EXAMPLES - -### Example 1: Test Network Watcher Connectivity from a VM to a website -``` -Test-AzureRmNetworkWatcherConnectivity -NetworkWatcherName NetworkWatcher -ResourceGroupName NetworkWatcherRG -SourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ContosoRG/providers/Microsoft.Compute/virtualMachines/MultiTierApp0" -DestinationAddress "bing.com" -DestinationPort 80 - - -ConnectionStatus : Reachable -AvgLatencyInMs : 4 -MinLatencyInMs : 2 -MaxLatencyInMs : 15 -ProbesSent : 15 -ProbesFailed : 0 -Hops : [ - { - "Type": "Source", - "Id": "f8cff464-e13f-457f-a09e-4dcd53d38a85", - "Address": "10.1.1.4", - "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ContosoRG/provi iders/Microsoft.Network/networkInterfaces/appNic0/ipConfigurations/ipconfig1", - "NextHopIds": [ - "1034b1bf-0b1b-4f0a-93b2-900477f45485" - ], - "Issues": [] - }, - { - "Type": "Internet", - "Id": "1034b1bf-0b1b-4f0a-93b2-900477f45485", - "Address": "13.107.21.200", - "ResourceId": "Internet", - "NextHopIds": [], - "Issues": [] - } - ] -``` - -In this example we test connectivity from a VM in Azure to www.bing.com. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationAddress -The IP address or URI the resource to which a connection attempt will be made. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationId -The ID of the resource to which a connection attempt will be made. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationPort -Port on which check connectivity will be performed. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Location of the network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByLocation -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProtocolConfiguration -Protocal configuration on which check connectivity will be performed. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcherProtocolConfiguration -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceId -The ID of the resource from which a connectivity check will be initiated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourcePort -The source port from which a connectivity check will be performed. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameters: NetworkWatcher (ByValue) - -### System.String - -### System.Int32 - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSConnectivityInformation - -## NOTES -Keywords: azure, azurerm, arm, resource, connectivity, management, manager, network, networking, network watcher - -## RELATED LINKS - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) -[Get-AzureRmNetworkWatcherTroubleshootingResult](./Get-AzureRmNetworkWatcherTroubleshootingResult.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) -[New-AzureRmNetworkWatcherProtocolConfiguration](./New-AzureRmNetworkWatcherProtocolConfiguration.md) -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) -[Test-AzureRmNetworkWatcherConnectivity](./Test-AzureRmNetworkWatcherConnectivity.md) -[Stop-AzureRmNetworkWatcherConnectionMonitor](./Stop-AzureRmNetworkWatcherConnectionMonitor.md) -[Start-AzureRmNetworkWatcherConnectionMonitor](./Start-AzureRmNetworkWatcherConnectionMonitor.md) -[Set-AzureRmNetworkWatcherConnectionMonitor](./Set-AzureRmNetworkWatcherConnectionMonitor.md) -[Set-AzureRmNetworkWatcherConfigFlowLog](./Set-AzureRmNetworkWatcherConfigFlowLog.md) -[Remove-AzureRmNetworkWatcherConnectionMonitor](./Remove-AzureRmNetworkWatcherConnectionMonitor.md) -[New-AzureRmNetworkWatcherConnectionMonitor](./New-AzureRmNetworkWatcherConnectionMonitor.md) -[Get-AzureRMNetworkWatcherReachabilityReport](./Get-AzureRMNetworkWatcherReachabilityReport.md) -[Get-AzureRmNetworkWatcherReachabilityProvidersList](./Get-AzureRmNetworkWatcherReachabilityProvidersList.md) -[Get-AzureRmNetworkWatcherFlowLogStatus](./Get-AzureRmNetworkWatcherFlowLogStatus.md) -[Get-AzureRmNetworkWatcherConnectionMonitorReport](./Get-AzureRmNetworkWatcherConnectionMonitorReport.md) -[Get-AzureRmNetworkWatcherConnectionMonitor](./Get-AzureRmNetworkWatcherConnectionMonitor.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Test-AzureRmNetworkWatcherIPFlow.md b/azurermps-6.13.0/AzureRM.Network/Test-AzureRmNetworkWatcherIPFlow.md deleted file mode 100644 index 29f2a58bac..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Test-AzureRmNetworkWatcherIPFlow.md +++ /dev/null @@ -1,347 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/test-azurermnetworkwatcheripflow -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Test-AzureRmNetworkWatcherIPFlow.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Test-AzureRmNetworkWatcherIPFlow.md ---- - -# Test-AzureRmNetworkWatcherIPFlow - -## SYNOPSIS -Returns whether the packet is allowed or denied to or from a particular destination. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Test-AzureRmNetworkWatcherIPFlow -NetworkWatcher <PSNetworkWatcher> -TargetVirtualMachineId <String> - -Direction <String> -Protocol <String> -RemoteIPAddress <String> -LocalIPAddress <String> -LocalPort <String> - [-RemotePort <String>] [-TargetNetworkInterfaceId <String>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByName -``` -Test-AzureRmNetworkWatcherIPFlow -NetworkWatcherName <String> -ResourceGroupName <String> - -TargetVirtualMachineId <String> -Direction <String> -Protocol <String> -RemoteIPAddress <String> - -LocalIPAddress <String> -LocalPort <String> [-RemotePort <String>] [-TargetNetworkInterfaceId <String>] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByLocation -``` -Test-AzureRmNetworkWatcherIPFlow -Location <String> -TargetVirtualMachineId <String> -Direction <String> - -Protocol <String> -RemoteIPAddress <String> -LocalIPAddress <String> -LocalPort <String> - [-RemotePort <String>] [-TargetNetworkInterfaceId <String>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Test-AzureRmNetworkWatcherIPFlow cmdlet, for a specified VM resource and a packet with specified direction using local and remote, IP addresses and ports, returns whether the packet is allowed or denied. - -## EXAMPLES - -### Example 1: Run Test-AzureRmNetworkWatcherIPFlow -``` -$nw = Get-AzurermResource | Where {$_.ResourceType -eq "Microsoft.Network/networkWatchers" -and $_.Location -eq "WestCentralUS" } -$networkWatcher = Get-AzureRmNetworkWatcher -Name $nw.Name -ResourceGroupName $nw.ResourceGroupName -$VM = Get-AzurermVM -ResourceGroupName testResourceGroup -Name VM0 -$Nics = Get-AzureRmNetworkInterface | Where {$_.Id -eq $vm.NetworkInterfaceIDs.ForEach({$_})} - -Test-AzureRmNetworkWatcherIPFlow -NetworkWatcher $networkWatcher -TargetVirtualMachineId $VM.Id -Direction Outbound -Protocol TCP -LocalIPAddress $nics[0].IpConfigurations[0].PrivateIpAddress -LocalPort 6895 -RemoteIPAddress 204.79.197.200 -RemotePort 80 -``` - -Get's the Network Watcher in West Central US for this subscription, then gets the VM and it's associated Network Interfaces. -Then for the first Network Interface, runs Test-AzureRmNetworkWatcherIPFlow using the first IP from the first Network Interface for an outbound connection to an IP on the internet. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Direction -Direction. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Inbound, Outbound - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalIPAddress -Local IP Address. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LocalPort -Local Port. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Location of the network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByLocation -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Protocol -Protocol. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: TCP, UDP - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteIPAddress -Remote IP Address. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RemotePort -Remote port. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: System.String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetNetworkInterfaceId -Target network interface Id. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetVirtualMachineId -The target virtual machine ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -Parameters: NetworkWatcher (ByValue) - -### System.String -Parameters: NetworkWatcherName (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSIPFlowVerifyResult - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, flow, ip - -## RELATED LINKS - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmNetworkWatcherProtocolConfiguration](./New-AzureRmNetworkWatcherProtocolConfiguration.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Test-AzureRmNetworkWatcherConnectivity](./Test-AzureRmNetworkWatcherConnectivity.md) - -[Stop-AzureRmNetworkWatcherConnectionMonitor](./Stop-AzureRmNetworkWatcherConnectionMonitor.md) - -[Start-AzureRmNetworkWatcherConnectionMonitor](./Start-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConnectionMonitor](./Set-AzureRmNetworkWatcherConnectionMonitor.md) - -[Set-AzureRmNetworkWatcherConfigFlowLog](./Set-AzureRmNetworkWatcherConfigFlowLog.md) - -[Remove-AzureRmNetworkWatcherConnectionMonitor](./Remove-AzureRmNetworkWatcherConnectionMonitor.md) - -[New-AzureRmNetworkWatcherConnectionMonitor](./New-AzureRmNetworkWatcherConnectionMonitor.md) - -[Get-AzureRmNetworkWatcherTroubleshootingResult](./Get-AzureRmNetworkWatcherTroubleshootingResult.md) - -[Get-AzureRMNetworkWatcherReachabilityReport](./Get-AzureRMNetworkWatcherReachabilityReport.md) - -[Get-AzureRmNetworkWatcherReachabilityProvidersList](./Get-AzureRmNetworkWatcherReachabilityProvidersList.md) - -[Get-AzureRmNetworkWatcherFlowLogStatus](./Get-AzureRmNetworkWatcherFlowLogStatus.md) - -[Get-AzureRmNetworkWatcherConnectionMonitorReport](./Get-AzureRmNetworkWatcherConnectionMonitorReport.md) - -[Get-AzureRmNetworkWatcherConnectionMonitor](./Get-AzureRmNetworkWatcherConnectionMonitor.md) diff --git a/azurermps-6.13.0/AzureRM.Network/Test-AzureRmPrivateIPAddressAvailability.md b/azurermps-6.13.0/AzureRM.Network/Test-AzureRmPrivateIPAddressAvailability.md deleted file mode 100644 index ff29cc68c8..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Test-AzureRmPrivateIPAddressAvailability.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 0780CB09-9C3B-468A-A718-3A646FE3D152 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/test-azurermprivateipaddressavailability -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Test-AzureRmPrivateIPAddressAvailability.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Test-AzureRmPrivateIPAddressAvailability.md ---- - -# Test-AzureRmPrivateIPAddressAvailability - -## SYNOPSIS -Test availability of a private IP address in a virtual network. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### TestByResource -``` -Test-AzureRmPrivateIPAddressAvailability -VirtualNetwork <PSVirtualNetwork> -IPAddress <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### TestByResourceId -``` -Test-AzureRmPrivateIPAddressAvailability -ResourceGroupName <String> -VirtualNetworkName <String> - -IPAddress <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Test-AzureRmPrivateIPAddressAvailability** cmdlet tests whether a specified private IP address is available in a virtual network. -This cmdlet returns a list of available private IP addresses if the requested private IP address is taken. - -## EXAMPLES - -### Example 1: Test whether an IP address is available using the pipeline -``` -PS C:\>Get-AzureRmVirtualNetwork -Name $vnetName -ResourceGroupName $rgname | Test-AzureRmPrivateIPAddressAvailability -IPAddress "10.0.1.10" -``` - -This command gets a virtual network and uses the pipeline operator to pass it to **Test-AzureRmPrivateIPAddressAvailability**, which tests whether the specified private IP address is available. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddress -Specifies the IP address to test. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for the virtual network. - -```yaml -Type: System.String -Parameter Sets: TestByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetwork -Specifies a **PSVirtualNetwork** object. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork -Parameter Sets: TestByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VirtualNetworkName -Specifies the name of the virtual network. - -```yaml -Type: System.String -Parameter Sets: TestByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork -Parameters: VirtualNetwork (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSIPAddressAvailabilityResult - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVirtualNetwork](./Get-AzureRmVirtualNetwork.md) - - diff --git a/azurermps-6.13.0/AzureRM.Network/Update-AzureRmVirtualHub.md b/azurermps-6.13.0/AzureRM.Network/Update-AzureRmVirtualHub.md deleted file mode 100644 index 919b1174fa..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Update-AzureRmVirtualHub.md +++ /dev/null @@ -1,294 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/update-azurermvirtualhub -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Update-AzureRmVirtualHub.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Update-AzureRmVirtualHub.md ---- - -# Update-AzureRmVirtualHub - -## SYNOPSIS -Updates a Virtual Hub to an intended goal state. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVirtualHubName (Default) -``` -Update-AzureRmVirtualHub -ResourceGroupName <String> -Name <String> [-AddressPrefix <String>] - [-HubVnetConnection <PSHubVirtualNetworkConnection[]>] [-RouteTable <PSVirtualHubRouteTable>] - [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByVirtualHubResourceId -``` -Update-AzureRmVirtualHub -ResourceId <String> [-AddressPrefix <String>] - [-HubVnetConnection <PSHubVirtualNetworkConnection[]>] [-RouteTable <PSVirtualHubRouteTable>] - [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByVirtualHubObject -``` -Update-AzureRmVirtualHub -InputObject <PSVirtualHub> [-AddressPrefix <String>] - [-HubVnetConnection <PSHubVirtualNetworkConnection[]>] [-RouteTable <PSVirtualHubRouteTable>] - [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Updates a Virtual Hub to an intended goal state. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> $virtualWan = New-AzureRmVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" -PS C:\> New-AzureRmVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" -PS C:\> Update-AzureRmVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.2.0/24" - -VirtualWan : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualWans/myVirtualWAN -ResourceGroupName : testRG -Name : westushub -Id : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub -AddressPrefix : 10.0.2.0/24 -RouteTable : -VirtualNetworkConnections : {} -Location : West US -Type : Microsoft.Network/virtualHubs -ProvisioningState : Succeeded -``` - -The above will create a resource group "testRG", a Virtual WAN and a Virtual Hub in West US in that resource group in Azure. The virtual hub will have the address space "10.0.1.0/24". - -### Example 2 - -```powershell -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> $virtualWan = New-AzureRmVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" -PS C:\> New-AzureRmVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.1.0/24" -PS C:\> $route1 = New-AzureRmVirtualHubRoute -AddressPrefix @("10.0.0.0/16", "11.0.0.0/16") -NextHopIpAddress "12.0.0.5" -PS C:\> $route2 = New-AzureRmVirtualHubRoute -AddressPrefix @("13.0.0.0/16") -NextHopIpAddress "14.0.0.5" -PS C:\> $routeTable = New-AzureRmVirtualHubRouteTable -Route @($route1, $route2) -PS C:\> Update-AzureRmVirtualHub -ResourceGroupName "testRG" -Name "westushub" -RouteTable $routeTable - -VirtualWan : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualWans/myVirtualWAN -ResourceGroupName : testRG -Name : westushub -Id : /subscriptions/{subscriptionId}resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/westushub -AddressPrefix : 192.168.2.0/24 -RouteTable : Microsoft.Azure.Commands.Network.Models.PSVirtualHubRouteTable -VirtualNetworkConnections : {} -Location : West US -Type : Microsoft.Network/virtualHubs -ProvisioningState : Succeeded -``` - -The above will create a resource group "testRG", a Virtual WAN and a Virtual Hub in West US in that resource group in Azure. The virtual hub will have the address space "10.0.1.0/24". -This example is similar to Example 1, but also attaches a route table to the virtual hub. - -## PARAMETERS - -### -AddressPrefix -The address space string for this virtual hub. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HubVnetConnection -The hub virtual network connections associated with this Virtual Hub. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSHubVirtualNetworkConnection[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The Virtual hub object to be modified. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHub -Parameter Sets: ByVirtualHubObject -Aliases: VirtualHub - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: System.String -Parameter Sets: ByVirtualHubName -Aliases: ResourceName, VirtualHubName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByVirtualHubName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The resource id of the Virtual hub to be modified. - -```yaml -Type: System.String -Parameter Sets: ByVirtualHubResourceId -Aliases: VirtualHubId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RouteTable -The route table associated with this Virtual Hub. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualHubRouteTable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -A hashtable which represents resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Network.Models.PSVirtualHub - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualHub - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Update-AzureRmVirtualWan.md b/azurermps-6.13.0/AzureRM.Network/Update-AzureRmVirtualWan.md deleted file mode 100644 index 71ff0066c1..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Update-AzureRmVirtualWan.md +++ /dev/null @@ -1,263 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/update-azurermvirtualwan -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Update-AzureRmVirtualWan.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Update-AzureRmVirtualWan.md ---- - -# Update-AzureRmVirtualWan - -## SYNOPSIS -Updates an Azure Virtual WAN. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVirtualWanName (Default) -``` -Update-AzureRmVirtualWan -ResourceGroupName <String> -Name <String> [-AllowVnetToVnetTraffic <Boolean>] - [-AllowBranchToBranchTraffic <Boolean>] [-Tag <Hashtable>] [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByVirtualWanObject -``` -Update-AzureRmVirtualWan -InputObject <PSVirtualWan> [-AllowVnetToVnetTraffic <Boolean>] - [-AllowBranchToBranchTraffic <Boolean>] [-Tag <Hashtable>] [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByVirtualWanResourceId -``` -Update-AzureRmVirtualWan -ResourceId <String> [-AllowVnetToVnetTraffic <Boolean>] - [-AllowBranchToBranchTraffic <Boolean>] [-Tag <Hashtable>] [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Updates an Azure Virtual WAN. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> New-AzureRmVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -Location "West US" -PS C:\> Update-AzureRmVirtualWan -ResourceGroupName "testRG" -Name "myVirtualWAN" -AllowBranchToBranchTraffic $true -AllowVnetToVnetTraffic $false - -Name : testRG -Id : /subscriptions/{SubscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualWans/myVirtualWAN -AllowVnetToVnetTraffic : False -AllowBranchToBranchTraffic : True -Location : West US -Type : Microsoft.Network/virtualWans -ProvisioningState : Succeeded -``` - -The above will create a resource group "testRG" in region "West US" and an Azure Virtual WAN in that resource group in Azure. VirtualWan is updated with new properties. - -## PARAMETERS - -### -AllowBranchToBranchTraffic -Allow branch to branch traffic for VirtualWan. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowVnetToVnetTraffic -Allow vnet to vnet traffic for VirtualWan. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation if you want to overrite a resource - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The virtual wan object to be modified - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualWan -Parameter Sets: ByVirtualWanObject -Aliases: VirtualWan - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: System.String -Parameter Sets: ByVirtualWanName -Aliases: ResourceName, VirtualWanName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByVirtualWanName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID for the virtual wan. - -```yaml -Type: System.String -Parameter Sets: ByVirtualWanResourceId -Aliases: VirtualWanId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -A hashtable which represents resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Network.Models.PSVirtualWan - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualWan - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Update-AzureRmVpnConnection.md b/azurermps-6.13.0/AzureRM.Network/Update-AzureRmVpnConnection.md deleted file mode 100644 index 2b7039ec18..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Update-AzureRmVpnConnection.md +++ /dev/null @@ -1,335 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/update-azurermvpnconnection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Update-AzureRmVpnConnection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Update-AzureRmVpnConnection.md ---- - -# Update-AzureRmVpnConnection - -## SYNOPSIS -Updates a VpnConnection object to a goal state. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVpnConnectionName (Default) -``` -Update-AzureRmVpnConnection -ResourceGroupName <String> -ParentResourceName <String> -Name <String> - [-SharedKey <SecureString>] [-ConnectionBandwidthInMbps <UInt32>] [-IpSecPolicy <PSIpsecPolicy>] - [-EnableBgp <Boolean>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByVpnConnectionResourceId -``` -Update-AzureRmVpnConnection -ResourceId <String> [-SharedKey <SecureString>] - [-ConnectionBandwidthInMbps <UInt32>] [-IpSecPolicy <PSIpsecPolicy>] [-EnableBgp <Boolean>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByVpnConnectionObject -``` -Update-AzureRmVpnConnection -InputObject <PSVpnConnection> [-SharedKey <SecureString>] - [-ConnectionBandwidthInMbps <UInt32>] [-IpSecPolicy <PSIpsecPolicy>] [-EnableBgp <Boolean>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Creates a IPSec connection that connects a VpnGateway to a remote customer branch represented in RM as a VpnSite. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> $virtualWan = New-AzureRmVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" -PS C:\> $virtualHub = New-AzureRmVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" -PS C:\> New-AzureRmVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -BGPPeeringWeight 10 -VpnGatewayScaleUnit 2 -PS C:\> $vpnGateway = Get-AzureRmVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -PS C:\> $vpnSiteAddressSpaces = New-Object string[] 2 -PS C:\> $vpnSiteAddressSpaces[0] = "192.168.2.0/24" -PS C:\> $vpnSiteAddressSpaces[1] = "192.168.3.0/24" -PS C:\> $vpnSite = New-AzureRmVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -Location "West US" -VirtualWan $virtualWan -IpAddress "1.2.3.4" -AddressSpace $vpnSiteAddressSpaces -DeviceModel "SomeDevice" -DeviceVendor "SomeDeviceVendor" -LinkSpeedInMbps "10" -PS C:\> $vpnConnection = New-AzureRmVpnConnection -ResourceGroupName $vpnGateway.ResourceGroupName -ParentResourceName $vpnGateway.Name -Name "testConnection" -VpnSite $vpnSite -PS C:\> $ipsecPolicy = New-AzureRmIpsecPolicy -SALifeTimeSeconds 1000 -SADataSizeKilobytes 2000 -IpsecEncryption "GCMAES256" -IpsecIntegrity "GCMAES256" -IkeEncryption "AES256" -IkeIntegrity "SHA256" -DhGroup "DHGroup14" -PfsGroup "PFS2048" -PS C:\> Update-AzureRmVpnConnection -InputObject $vpnConnection -IpSecPolicy $ipsecPolicy - -RemoteVpnSite : Microsoft.Azure.Commands.Network.Models.PSResourceId -SharedKey : -VpnConnectionProtocolType : IKEv2 -ConnectionStatus : -EgressBytesTransferred : 0 -IngressBytesTransferred : 0 -IpsecPolicies : {Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy} -ConnectionBandwidth : 20 -EnableBgp : False -ProvisioningState : testConnection -Name : ps9709 -Etag : W/"4580a2e2-2fab-4cff-88eb-92013a76b5a8" -Id : /subscriptions/{subscriptionId}/resourceGroups/ps9361/providers/Microsoft.Network/vpnGateways/testvpngw/vpnConnections/testConnection -``` - -The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub and a VpnSite in West US in "testRG" resource group in Azure. -A VPN gateway will be created thereafter in the Virtual Hub with 2 scale units. - -Once the gateway has been created, it is connected to the VpnSite using the New-AzureRmVpnConnection command. - -The connection is then updated to have a new IpSecPolicy by using the Set-AzureRmVpnConnection command. - -### Example 2 - -```powershell -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> $virtualWan = New-AzureRmVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" -PS C:\> $virtualHub = New-AzureRmVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" -PS C:\> New-AzureRmVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -BGPPeeringWeight 10 -VpnGatewayScaleUnit 2 -PS C:\> $vpnGateway = Get-AzureRmVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -PS C:\> $vpnSiteAddressSpaces = New-Object string[] 2 -PS C:\> $vpnSiteAddressSpaces[0] = "192.168.2.0/24" -PS C:\> $vpnSiteAddressSpaces[1] = "192.168.3.0/24" -PS C:\> $vpnSite = New-AzureRmVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -Location "West US" -VirtualWan $virtualWan -IpAddress "1.2.3.4" -AddressSpace $vpnSiteAddressSpaces -DeviceModel "SomeDevice" -DeviceVendor "SomeDeviceVendor" -LinkSpeedInMbps "10" -PS C:\> $vpnConnection = New-AzureRmVpnConnection -ResourceGroupName $vpnGateway.ResourceGroupName -ParentResourceName $vpnGateway.Name -Name "testConnection" -VpnSite $vpnSite -PS C:\> $Secure_String_Pwd = Read-Host -AsSecureString -PS C:\> Update-AzureRmVpnConnection -InputObject $vpnConnection -SharedKey $Secure_String_Pwd - -RemoteVpnSite : Microsoft.Azure.Commands.Network.Models.PSResourceId -SharedKey : -VpnConnectionProtocolType : IKEv2 -ConnectionStatus : -EgressBytesTransferred : 0 -IngressBytesTransferred : 0 -IpsecPolicies : {Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy} -ConnectionBandwidth : 20 -EnableBgp : False -ProvisioningState : testConnection -Name : ps9709 -Etag : W/"4580a2e2-2fab-4cff-88eb-92013a76b5a8" -Id : /subscriptions/{subscriptionId}/resourceGroups/ps9361/providers/Microsoft.Network/vpnGateways/testvpngw/vpnConnections/testConnection -``` - -The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub and a VpnSite in West US in "testRG" resource group in Azure. -A VPN gateway will be created thereafter in the Virtual Hub with 2 scale units. - -Once the gateway has been created, it is connected to the VpnSite using the New-AzureRmVpnConnection command. - -The connection is then updated to have a new shared key using the secure string construct. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionBandwidthInMbps -The bandwith that needs to be handled by this connection in mbps. - -```yaml -Type: System.UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableBgp -Enable BGP for this connection - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The VpnConenction object to update. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVpnConnection -Parameter Sets: ByVpnConnectionObject -Aliases: VpnConnection - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IpSecPolicy -The bandwith that needs to be handled by this connection in mbps. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: System.String -Parameter Sets: ByVpnConnectionName -Aliases: ResourceName, VpnConnectionName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParentResourceName -The parent resource name. - -```yaml -Type: System.String -Parameter Sets: ByVpnConnectionName -Aliases: ParentVpnGatewayName, VpnGatewayName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByVpnConnectionName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The resource id of the VpnConenction object to delete. - -```yaml -Type: System.String -Parameter Sets: ByVpnConnectionResourceId -Aliases: VpnConnectionId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SharedKey -The shared key required to set this connection up. - -```yaml -Type: System.Security.SecureString -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Network.Models.PSVpnConnection - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVpnConnection - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Update-AzureRmVpnGateway.md b/azurermps-6.13.0/AzureRM.Network/Update-AzureRmVpnGateway.md deleted file mode 100644 index 59d00405c6..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Update-AzureRmVpnGateway.md +++ /dev/null @@ -1,255 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/update-azurermvpngateway -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Update-AzureRmVpnGateway.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Update-AzureRmVpnGateway.md ---- - -# Update-AzureRmVpnGateway - -## SYNOPSIS -Update-AzureRmVpnGateway updates a scalable VPN Gateway to the appropriate goal state. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVpnGatewayName (Default) -``` -Update-AzureRmVpnGateway -ResourceGroupName <String> -Name <String> [-VpnConnection <PSVpnConnection[]>] - [-VpnGatewayScaleUnit <UInt32>] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByVpnGatewayObject -``` -Update-AzureRmVpnGateway -InputObject <PSVpnGateway> [-VpnConnection <PSVpnConnection[]>] - [-VpnGatewayScaleUnit <UInt32>] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByVpnGatewayResourceId -``` -Update-AzureRmVpnGateway -ResourceId <String> [-VpnConnection <PSVpnConnection[]>] - [-VpnGatewayScaleUnit <UInt32>] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Update-AzureRmVpnGateway updates a scalable VPN Gateway to the appropriate goal state. An AzureRmVpnGateway is a software defined connectivity for site to site connections inside the VirtualHub. -This gateway resizes and scales based on the scale unit specified by the user. -A connection can be set up from a branch/Site known as VPNSite to the scalable gateway. Each connection comprises of 2 Active-Active tunnels - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> $virtualWan = New-AzureRmVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" -PS C:\> $virtualHub = New-AzureRmVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24" -PS C:\> $vpnGateway = New-AzureRmVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -BGPPeeringWeight 10 -VpnGatewayScaleUnit 2 -PS C:\> Set-AzureRmVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VpnGatewayScaleUnit 3 - -ResourceGroupName : testRG -Name : testvpngw -Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/vpnGateways/testvpngw -Location : West US -VpnGatewayScaleUnit : 3 -VirtualHub : /subscriptions/{subscriptionId}/resourceGroups/Ali_pS_Test/providers/Microsoft.Network/virtualHubs/westushub -BgpSettings : {} -Type : Microsoft.Network/vpnGateways -ProvisioningState : Succeeded -``` - -The above will create a resource group, Virtual WAN, Virtual Network, Virtual Hub in West US in "testRG" resource group in Azure. -A VPN gateway will be created thereafter in the Virtual Hub with 2 scale units. - -After the gateway has been created, it uses Set-AzureRmVpnGateway to upgrade the gateway to 3 scale units. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The vpn gateway object to be modified - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVpnGateway -Parameter Sets: ByVpnGatewayObject -Aliases: VpnGateway - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The virtual wan name. - -```yaml -Type: System.String -Parameter Sets: ByVpnGatewayName -Aliases: ResourceName, VpnGatewayName, GatewayName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByVpnGatewayName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID of the VpnGateway to be modified. - -```yaml -Type: System.String -Parameter Sets: ByVpnGatewayResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -A hashtable which represents resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VpnConnection -The list of VpnConnections that this VpnGateway needs to have. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVpnConnection[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VpnGatewayScaleUnit -The scale unit for this VpnGateway. - -```yaml -Type: System.UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVpnGateway - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVpnGateway - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Network/Update-AzureRmVpnSite.md b/azurermps-6.13.0/AzureRM.Network/Update-AzureRmVpnSite.md deleted file mode 100644 index 5fc279f47e..0000000000 --- a/azurermps-6.13.0/AzureRM.Network/Update-AzureRmVpnSite.md +++ /dev/null @@ -1,496 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/update-azurermvpnsite -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Update-AzureRmVpnSite.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Network/Commands.Network/help/Update-AzureRmVpnSite.md ---- - -# Update-AzureRmVpnSite - -## SYNOPSIS -Updates a VpnSite representing a customer branch to an intended goal state. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVpnSiteNameNoVirtualWanUpdate (Default) -``` -Update-AzureRmVpnSite -ResourceGroupName <String> -Name <String> [-IpAddress <String>] - [-AddressSpace <System.Collections.Generic.List`1[System.String]>] [-DeviceModel <String>] - [-DeviceVendor <String>] [-LinkSpeedInMbps <UInt32>] [-BgpAsn <UInt32>] [-BgpPeeringAddress <String>] - [-BgpPeeringWeight <UInt32>] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ByVpnSiteNameByVirtualWanName -``` -Update-AzureRmVpnSite -ResourceGroupName <String> -Name <String> -VirtualWanResourceGroupName <String> - -VirtualWanName <String> [-IpAddress <String>] - [-AddressSpace <System.Collections.Generic.List`1[System.String]>] [-DeviceModel <String>] - [-DeviceVendor <String>] [-LinkSpeedInMbps <UInt32>] [-BgpAsn <UInt32>] [-BgpPeeringAddress <String>] - [-BgpPeeringWeight <UInt32>] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ByVpnSiteNameByVirtualWanResourceId -``` -Update-AzureRmVpnSite -ResourceGroupName <String> -Name <String> -VirtualWanId <String> [-IpAddress <String>] - [-AddressSpace <System.Collections.Generic.List`1[System.String]>] [-DeviceModel <String>] - [-DeviceVendor <String>] [-LinkSpeedInMbps <UInt32>] [-BgpAsn <UInt32>] [-BgpPeeringAddress <String>] - [-BgpPeeringWeight <UInt32>] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ByVpnSiteNameByVirtualWanObject -``` -Update-AzureRmVpnSite -ResourceGroupName <String> -Name <String> -VirtualWan <PSVirtualWan> - [-IpAddress <String>] [-AddressSpace <System.Collections.Generic.List`1[System.String]>] - [-DeviceModel <String>] [-DeviceVendor <String>] [-LinkSpeedInMbps <UInt32>] [-BgpAsn <UInt32>] - [-BgpPeeringAddress <String>] [-BgpPeeringWeight <UInt32>] [-Tag <Hashtable>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByVpnSiteObjectByVirtualWanName -``` -Update-AzureRmVpnSite -InputObject <PSVpnSite> -VirtualWanResourceGroupName <String> -VirtualWanName <String> - [-IpAddress <String>] [-AddressSpace <System.Collections.Generic.List`1[System.String]>] - [-DeviceModel <String>] [-DeviceVendor <String>] [-LinkSpeedInMbps <UInt32>] [-BgpAsn <UInt32>] - [-BgpPeeringAddress <String>] [-BgpPeeringWeight <UInt32>] [-Tag <Hashtable>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByVpnSiteObjectByVirtualWanResourceId -``` -Update-AzureRmVpnSite -InputObject <PSVpnSite> -VirtualWanId <String> [-IpAddress <String>] - [-AddressSpace <System.Collections.Generic.List`1[System.String]>] [-DeviceModel <String>] - [-DeviceVendor <String>] [-LinkSpeedInMbps <UInt32>] [-BgpAsn <UInt32>] [-BgpPeeringAddress <String>] - [-BgpPeeringWeight <UInt32>] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ByVpnSiteObjectByVirtualWanObject -``` -Update-AzureRmVpnSite -InputObject <PSVpnSite> -VirtualWan <PSVirtualWan> [-IpAddress <String>] - [-AddressSpace <System.Collections.Generic.List`1[System.String]>] [-DeviceModel <String>] - [-DeviceVendor <String>] [-LinkSpeedInMbps <UInt32>] [-BgpAsn <UInt32>] [-BgpPeeringAddress <String>] - [-BgpPeeringWeight <UInt32>] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ByVpnSiteObjectNoVirtualWanUpdate -``` -Update-AzureRmVpnSite -InputObject <PSVpnSite> [-IpAddress <String>] - [-AddressSpace <System.Collections.Generic.List`1[System.String]>] [-DeviceModel <String>] - [-DeviceVendor <String>] [-LinkSpeedInMbps <UInt32>] [-BgpAsn <UInt32>] [-BgpPeeringAddress <String>] - [-BgpPeeringWeight <UInt32>] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ByVpnSiteResourceIdByVirtualWanName -``` -Update-AzureRmVpnSite -ResourceId <String> -VirtualWanResourceGroupName <String> -VirtualWanName <String> - [-IpAddress <String>] [-AddressSpace <System.Collections.Generic.List`1[System.String]>] - [-DeviceModel <String>] [-DeviceVendor <String>] [-LinkSpeedInMbps <UInt32>] [-BgpAsn <UInt32>] - [-BgpPeeringAddress <String>] [-BgpPeeringWeight <UInt32>] [-Tag <Hashtable>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByVpnSiteResourceIdByVirtualWanResourceId -``` -Update-AzureRmVpnSite -ResourceId <String> -VirtualWanId <String> [-IpAddress <String>] - [-AddressSpace <System.Collections.Generic.List`1[System.String]>] [-DeviceModel <String>] - [-DeviceVendor <String>] [-LinkSpeedInMbps <UInt32>] [-BgpAsn <UInt32>] [-BgpPeeringAddress <String>] - [-BgpPeeringWeight <UInt32>] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ByVpnSiteResourceIdByVirtualWanObject -``` -Update-AzureRmVpnSite -ResourceId <String> -VirtualWan <PSVirtualWan> [-IpAddress <String>] - [-AddressSpace <System.Collections.Generic.List`1[System.String]>] [-DeviceModel <String>] - [-DeviceVendor <String>] [-LinkSpeedInMbps <UInt32>] [-BgpAsn <UInt32>] [-BgpPeeringAddress <String>] - [-BgpPeeringWeight <UInt32>] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ByVpnSiteResourceIdNoVirtualWanUpdate -``` -Update-AzureRmVpnSite -ResourceId <String> [-IpAddress <String>] - [-AddressSpace <System.Collections.Generic.List`1[System.String]>] [-DeviceModel <String>] - [-DeviceVendor <String>] [-LinkSpeedInMbps <UInt32>] [-BgpAsn <UInt32>] [-BgpPeeringAddress <String>] - [-BgpPeeringWeight <UInt32>] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Updates a VpnSite representing a customer branch to an intended goal state. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG" -PS C:\> $virtualWan = New-AzureRmVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US" -PS C:\> $vpnSiteAddressSpaces = New-Object string[] 2 -PS C:\> $vpnSiteAddressSpaces[0] = "192.168.2.0/24" -PS C:\> $vpnSiteAddressSpaces[1] = "192.168.3.0/24" -PS C:\> New-AzureRmVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -Location "West US" -VirtualWan $virtualWan -IpAddress "1.2.3.4" -AddressSpace $vpnSiteAddressSpaces -DeviceModel "SomeDevice" -DeviceVendor "SomeDeviceVendor" -LinkSpeedInMbps "10" -PS C:\> New-AzureRmVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -Location "West US" -VirtualWan $virtualWan -IpAddress "2.3.5.5" - -ResourceGroupName : testRG -Name : testVpnSite -Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/vpnSites/testVpnSite -Location : eastus2euap -IpAddress : 2.3.4.5 -VirtualWan : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualWans/myVirtualWAN -AddressSpace : {192.168.2.0/24, 192.168.3.0/24} -BgpSettings : -Type : Microsoft.Network/vpnSites -ProvisioningState : Succeeded -``` - -The above will create a resource group, Virtual WAN in West US in "testRG" resource group in Azure. - -Then it creates a VpnSite to represent a customer branch and links it to the Virtual WAN. - -Once the site is created, it updates the IpAddress of the site using the Set-AzureRmVpnSite command. - -## PARAMETERS - -### -AddressSpace -The address prefixes of the virtual network. -Use this or AddressSpaceObject but not both. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BgpAsn -The BGP ASN for this VpnSite. - -```yaml -Type: System.UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BgpPeeringAddress -The BGP Peering Address for this VpnSite. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BgpPeeringWeight -The BGP Peering weight for this VpnSite. - -```yaml -Type: System.UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeviceModel -The device model of the remote vpn device. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeviceVendor -The device vendor of the remote vpn device. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The vpn site object to be modified - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVpnSite -Parameter Sets: ByVpnSiteObjectByVirtualWanName, ByVpnSiteObjectByVirtualWanResourceId, ByVpnSiteObjectByVirtualWanObject, ByVpnSiteObjectNoVirtualWanUpdate -Aliases: VpnSite - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IpAddress -IP address of local network gateway. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LinkSpeedInMbps -The device model of the remote vpn device. - -```yaml -Type: System.UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: System.String -Parameter Sets: ByVpnSiteNameNoVirtualWanUpdate, ByVpnSiteNameByVirtualWanName, ByVpnSiteNameByVirtualWanResourceId, ByVpnSiteNameByVirtualWanObject -Aliases: ResourceName, VpnSiteName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: ByVpnSiteNameNoVirtualWanUpdate, ByVpnSiteNameByVirtualWanName, ByVpnSiteNameByVirtualWanResourceId, ByVpnSiteNameByVirtualWanObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The Azure resource ID for the vpn site. - -```yaml -Type: System.String -Parameter Sets: ByVpnSiteResourceIdByVirtualWanName, ByVpnSiteResourceIdByVirtualWanResourceId, ByVpnSiteResourceIdByVirtualWanObject, ByVpnSiteResourceIdNoVirtualWanUpdate -Aliases: VpnSiteId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -A hashtable which represents resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualWan -The VirtualWan this VpnSite needs to be connected to. - -```yaml -Type: Microsoft.Azure.Commands.Network.Models.PSVirtualWan -Parameter Sets: ByVpnSiteNameByVirtualWanObject, ByVpnSiteObjectByVirtualWanObject, ByVpnSiteResourceIdByVirtualWanObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualWanId -The ResourceId VirtualWan this VpnSite needs to be connected to. - -```yaml -Type: System.String -Parameter Sets: ByVpnSiteNameByVirtualWanResourceId, ByVpnSiteObjectByVirtualWanResourceId, ByVpnSiteResourceIdByVirtualWanResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualWanName -The name of the VirtualWan this VpnSite needs to be connected to. - -```yaml -Type: System.String -Parameter Sets: ByVpnSiteNameByVirtualWanName, ByVpnSiteObjectByVirtualWanName, ByVpnSiteResourceIdByVirtualWanName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualWanResourceGroupName -The resource group name of the VirtualWan this VpnSite needs to be connected to. - -```yaml -Type: System.String -Parameter Sets: ByVpnSiteNameByVirtualWanName, ByVpnSiteObjectByVirtualWanName, ByVpnSiteResourceIdByVirtualWanName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVpnSite - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVpnSite - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.NotificationHubs/AzureRM.NotificationHubs.md b/azurermps-6.13.0/AzureRM.NotificationHubs/AzureRM.NotificationHubs.md deleted file mode 100644 index e76da8cd19..0000000000 --- a/azurermps-6.13.0/AzureRM.NotificationHubs/AzureRM.NotificationHubs.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -Module Name: AzureRM.NotificationHubs -Module Guid: f875725d-8ce4-423f-a6af-ea880bc63f13 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.notificationhubs -Help Version: 4.1.1.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/AzureRM.NotificationHubs.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/AzureRM.NotificationHubs.md ---- - -# AzureRM.NotificationHubs Module -## Description -This topic displays help topics for the Azure Notification Hub cmdlets. Notification hubs are used to send push notifications to multiple clients regardless of the platform (iOS, Android, Windows Phone 8, Windows Store, etc.) used by those clients. These hubs are roughly equivalent to individual apps: each of your apps will typically have its own notification hub. Notification hubs are organized within logical containers known as namespaces, and Shared Access Signature (SAS) authorization rules are used to manage access to hubs and namespaces. All of these elements can be administered by using the Notification Hub cmdlets. - -## AzureRM.NotificationHubs Cmdlets -### [Get-AzureRmNotificationHub](Get-AzureRmNotificationHub.md) -Gets information about your notification hubs. - -### [Get-AzureRmNotificationHubAuthorizationRules](Get-AzureRmNotificationHubAuthorizationRules.md) -Gets information about the authorization rules associated with a notification hub. - -### [Get-AzureRmNotificationHubListKeys](Get-AzureRmNotificationHubListKeys.md) -Gets the primary and secondary connection strings associated with a notification hub authorization rule. - -### [Get-AzureRmNotificationHubPNSCredentials](Get-AzureRmNotificationHubPNSCredentials.md) -Gets the PNS credentials for a notification hub. - -### [Get-AzureRmNotificationHubsNamespace](Get-AzureRmNotificationHubsNamespace.md) -Gets information about a notification hub namespace. - -### [Get-AzureRmNotificationHubsNamespaceAuthorizationRules](Get-AzureRmNotificationHubsNamespaceAuthorizationRules.md) -Gets information about the authorization rules associated with a notification hub namespace. - -### [Get-AzureRmNotificationHubsNamespaceListKeys](Get-AzureRmNotificationHubsNamespaceListKeys.md) -Gets the primary and secondary connection strings associated with a notification hub namespace authorization rule. - -### [New-AzureRmNotificationHub](New-AzureRmNotificationHub.md) -Creates a notification hub. - -### [New-AzureRmNotificationHubAuthorizationRules](New-AzureRmNotificationHubAuthorizationRules.md) -Creates an authorization rule and assigns the rule to a notification hub. - -### [New-AzureRmNotificationHubKey](New-AzureRmNotificationHubKey.md) -Regenerate the Authorization Rule Key for a NotificationHub . - -### [New-AzureRmNotificationHubsNamespace](New-AzureRmNotificationHubsNamespace.md) -Creates a notification hub namespace. - -### [New-AzureRmNotificationHubsNamespaceAuthorizationRules](New-AzureRmNotificationHubsNamespaceAuthorizationRules.md) -Creates an authorization rule and assigns that rule to a notification hub namespace. - -### [New-AzureRmNotificationHubsNamespaceKey](New-AzureRmNotificationHubsNamespaceKey.md) -Regenerate the Authorization Rule Key for a Namespace. - -### [Remove-AzureRmNotificationHub](Remove-AzureRmNotificationHub.md) -Removes an existing notification hub. - -### [Remove-AzureRmNotificationHubAuthorizationRules](Remove-AzureRmNotificationHubAuthorizationRules.md) -Removes an authorization rule from a notification hub. - -### [Remove-AzureRmNotificationHubsNamespace](Remove-AzureRmNotificationHubsNamespace.md) -Removes a notification hub namespace. - -### [Remove-AzureRmNotificationHubsNamespaceAuthorizationRules](Remove-AzureRmNotificationHubsNamespaceAuthorizationRules.md) -Removes an authorization rule from a notification hub namespace. - -### [Set-AzureRmNotificationHub](Set-AzureRmNotificationHub.md) -Sets property values for a notification hub. - -### [Set-AzureRmNotificationHubAuthorizationRules](Set-AzureRmNotificationHubAuthorizationRules.md) -Sets authorization rules for a notification hub. - -### [Set-AzureRmNotificationHubsNamespace](Set-AzureRmNotificationHubsNamespace.md) -Sets property values for a notification hub namespace. - -### [Set-AzureRmNotificationHubsNamespaceAuthorizationRules](Set-AzureRmNotificationHubsNamespaceAuthorizationRules.md) -Sets authorization rules for a notification hub namespace. - diff --git a/azurermps-6.13.0/AzureRM.NotificationHubs/Get-AzureRmNotificationHub.md b/azurermps-6.13.0/AzureRM.NotificationHubs/Get-AzureRmNotificationHub.md deleted file mode 100644 index f02a6d40b7..0000000000 --- a/azurermps-6.13.0/AzureRM.NotificationHubs/Get-AzureRmNotificationHub.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml -Module Name: AzureRM.NotificationHubs -ms.assetid: 796396B4-1F9D-4D53-AD2E-4CE83B563E93 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.notificationhubs/get-azurermnotificationhub -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHub.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHub.md ---- - -# Get-AzureRmNotificationHub - -## SYNOPSIS -Gets information about your notification hubs. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmNotificationHub [-ResourceGroup] <String> [-Namespace] <String> [[-NotificationHub] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmNotificationHub** cmdlet gets information about the notification hubs in a specified namespace and assigned to a specified resource group. -For example, you can get information for all the notification hubs in the namespace ContosoNamespace and assigned to the ContosoNotificationsGroup resource group. -Alternatively, you can use the *NotificationHub* parameter to limit the returned data to information about a specific notification hub. -Notification hubs are used to send push notifications to multiple clients regardless of the platform, such as iOS, Android, Windows Phone 8, and Windows Store, used by those clients. -These hubs are roughly equivalent to individual apps and each of your apps will typically have its own notification hub. -This cmdlet only gets information about the hub itself. -Other cmdlets, such as Get-AzureRmNotificationHubAuthorizationRules, Get-AzureRmNotificationHubListKeys, and Get-AzureRmNotificationHubPNSCredentials, are needed to get information about a hub's authorization rules, connection strings, and platform notification service credentials. - -## EXAMPLES - -### Example 1: Get information for all notification hubs in a specific namespace -``` -PS C:\>Get-AzureRmNotificationHub -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationsGroup" -``` - -This command gets information for all the notification hubs in the namespace named ContosoNamespace that have been assigned to the resource group ContosoNotificationsGroup. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Namespace -Specifies the namespace to which the notification hub is assigned. -Namespaces provide a way to group and categorize notification hubs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NotificationHub -Specifies the name of the notification hub that this cmdlet gets. -Notification hubs are used to send push notifications to multiple clients regardless of the platform used by those clients. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroup -Specifies the resource group to which the notification hub is assigned. -Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and Azure administration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.NotificationHubs.Models.NotificationHubAttributes - -## NOTES - -## RELATED LINKS - -[Get-AzureRmNotificationHubAuthorizationRules](./Get-AzureRmNotificationHubAuthorizationRules.md) - -[Get-AzureRmNotificationHubListKeys](./Get-AzureRmNotificationHubListKeys.md) - -[Get-AzureRmNotificationHubPNSCredentials](./Get-AzureRmNotificationHubPNSCredentials.md) - -[New-AzureRmNotificationHub](./New-AzureRmNotificationHub.md) - -[Remove-AzureRmNotificationHub](./Remove-AzureRmNotificationHub.md) - -[Set-AzureRmNotificationHub](./Set-AzureRmNotificationHub.md) - - diff --git a/azurermps-6.13.0/AzureRM.NotificationHubs/Get-AzureRmNotificationHubAuthorizationRules.md b/azurermps-6.13.0/AzureRM.NotificationHubs/Get-AzureRmNotificationHubAuthorizationRules.md deleted file mode 100644 index 0e40981a08..0000000000 --- a/azurermps-6.13.0/AzureRM.NotificationHubs/Get-AzureRmNotificationHubAuthorizationRules.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml -Module Name: AzureRM.NotificationHubs -ms.assetid: 7A9D8F5A-6035-411B-8FDB-96ABFEED05A2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.notificationhubs/get-azurermnotificationhubauthorizationrules -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubAuthorizationRules.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubAuthorizationRules.md ---- - -# Get-AzureRmNotificationHubAuthorizationRules - -## SYNOPSIS -Gets information about the authorization rules associated with a notification hub. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmNotificationHubAuthorizationRules [-ResourceGroup] <String> [-Namespace] <String> - [-NotificationHub] <String> [[-AuthorizationRule] <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmNotificationHubAuthorizationRules** cmdlet gets information about the Shared Access Signature (SAS) authorization rules associated with a notification hub. -The cmdlet returns information about all the rules associated with a hub or, by including the *AuthorizationRule* parameter, gets information about a specific rule. -Authorization rules manage access to your notification hubs. -An authorization rule will create links, as a URI, based on different permission levels. -Clients are directed to one of these URIs based on the appropriate permission level. -For instance, a client with the Listen permission will be directed to the URI for that permission. -The **Get-AzureRmNotificationHubAuthorizationRules** cmdlet only gets information about the authorization rules associated with a notification hub. -To get information about the hub itself, use Get-AzureRmNotificationHub. - -## EXAMPLES - -### Example 1: Get information for all authorization rules assigned to a notification hub -``` -PS C:\>Get-AzureRmNotificationHubAuthorizationRules -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationsGroup" -NotificationHub "ContosoInternalHub" -``` - -This command gets information for all the authorization rules assigned to the notification hub named ContosoInternalHub in the namespace ContosoNamespace. -You must specify the namespace where the hub is located as well as the resource group that the hub has been assigned to. - -### Example 2: Get information for an authorization rules assigned to a notification hub -``` -PS C:\>Get-AzureRmNotificationHubAuthorizationRules -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationsGroup" -NotificationHub "ContosoInternalHub" -AuthorizationRule "ListenRule" -``` - -This command gets information for all the authorization rules assigned to the notification hub named ContosoInternalHub in the namespace ContosoNamespace. -The command uses the *AuthorizationRule* parameter to limit the returned data to a single authorization rule named ListenRule. - -## PARAMETERS - -### -AuthorizationRule -Specifies the name of an SAS authentication rule. -These rules determine the type of access that users have to the notification hub. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Namespace -Specifies the namespace to which the notification hub is assigned. -Namespaces provide a way to group and categorize notification hubs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NotificationHub -Specifies the notification hub that this cmdlet assigns authorization rules. -Notification hubs are used to send push notifications to multiple clients regardless of the platform used by those clients. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroup -Specifies the resource group to which the notification hub is assigned. -Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simplify inventory management and Azure administration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.NotificationHubs.Models.SharedAccessAuthorizationRuleAttributes - -## NOTES - -## RELATED LINKS - -[Get-AzureRmNotificationHubsNamespaceAuthorizationRules](./Get-AzureRmNotificationHubsNamespaceAuthorizationRules.md) - -[New-AzureRmNotificationHubAuthorizationRules](./New-AzureRmNotificationHubAuthorizationRules.md) - -[Remove-AzureRmNotificationHubAuthorizationRules](./Remove-AzureRmNotificationHubAuthorizationRules.md) - -[Set-AzureRmNotificationHubAuthorizationRules](./Set-AzureRmNotificationHubAuthorizationRules.md) - - diff --git a/azurermps-6.13.0/AzureRM.NotificationHubs/Get-AzureRmNotificationHubListKeys.md b/azurermps-6.13.0/AzureRM.NotificationHubs/Get-AzureRmNotificationHubListKeys.md deleted file mode 100644 index e1fe200afe..0000000000 --- a/azurermps-6.13.0/AzureRM.NotificationHubs/Get-AzureRmNotificationHubListKeys.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml -Module Name: AzureRM.NotificationHubs -ms.assetid: 326C87EB-EC3B-4B04-B593-EAC56FFA854A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.notificationhubs/get-azurermnotificationhublistkeys -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubListKeys.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubListKeys.md ---- - -# Get-AzureRmNotificationHubListKeys - -## SYNOPSIS -Gets the primary and secondary connection strings associated with a notification hub authorization rule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmNotificationHubListKeys [-ResourceGroup] <String> [-Namespace] <String> [-NotificationHub] <String> - [-AuthorizationRule] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmNotificationHubListKeys** cmdlet returns the primary and secondary connection strings of a notification hub Shared Access Signature (SAS) authorization rule. -Authorization rules manage user rights to the hub. -Each rule includes a primary and a secondary connection string. -These connection strings (URIs) perform the following: -- Point users to a resource. -- Include a token containing query parameters. -One of these parameters, the signature, is used to authenticate the user and provide the specified level of access. - -## EXAMPLES - -### Example 1: Get the primary and secondary connection strings for an authorization rule -``` -PS C:\>Get-AzureRmNotificationHubListKeys -Namespace "ContosoNamespace" -NotificationHub "ContosoInternalHub" -ResourceGroup "ContosoNotificationsGroup" -AuthorizationRule "ListenRule" -``` - -This command gets the primary and secondary connection strings for the authorization rule ListenRule, a rule assigned to the ContosoInternalHub notification hub. -The command must include the hub namespace and resource group. - -## PARAMETERS - -### -AuthorizationRule -Specifies the name of a Shared Access Signature (SAS) authentication rule. -These rules determine the type of access that users have to the notification hub. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Namespace -Specifies the namespace to which the notification hub is assigned. -Namespaces provide a way to group and categorize notification hubs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NotificationHub -Specifies the notification hub that this cmdlet assigns an authorization rule to. -Notification hubs are used to send push notifications to multiple clients regardless of the platform used by those clients. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroup -Specifies the resource group to which the notification hub is assigned. -Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and Azure administration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.NotificationHubs.Models.ResourceListKeys - -## NOTES - -## RELATED LINKS - -[Get-AzureRmNotificationHubAuthorizationRules](./Get-AzureRmNotificationHubAuthorizationRules.md) - - diff --git a/azurermps-6.13.0/AzureRM.NotificationHubs/Get-AzureRmNotificationHubPNSCredentials.md b/azurermps-6.13.0/AzureRM.NotificationHubs/Get-AzureRmNotificationHubPNSCredentials.md deleted file mode 100644 index 3d101baab6..0000000000 --- a/azurermps-6.13.0/AzureRM.NotificationHubs/Get-AzureRmNotificationHubPNSCredentials.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml -Module Name: AzureRM.NotificationHubs -ms.assetid: 2CCDF339-9D6E-4B0C-9201-BE641C8827F6 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.notificationhubs/get-azurermnotificationhubpnscredentials -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubPNSCredentials.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubPNSCredentials.md ---- - -# Get-AzureRmNotificationHubPNSCredentials - -## SYNOPSIS -Gets the PNS credentials for a notification hub. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmNotificationHubPNSCredentials [-ResourceGroup] <String> [-Namespace] <String> - [-NotificationHub] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmNotificationHubPNSCredentials** cmdlet gets the platform notification service (PNS) credentials for a notification hub. -Each notification hub has a single set of PNS credentials. -These credentials are applied to individual push notification services such as, but not limited to; the iOS push notification service, the Android push notification service, and Windows Phone 8. - -## EXAMPLES - -### Example 1: Get PNS credentials for a specific notification hub -``` -PS C:\>Get-AzureRmNotificationHubPNSCredentials -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationsGroup" -NotificationHub "ContosoInternalHub" -``` - -This command gets the PNS credentials for the notification hub named ContosoInternalHub that belongs to the resource group named ContosoNotificationsGroup. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Namespace -Specifies the namespace to which the notification hub is assigned. -Namespaces provide a way to group and categorize notification hubs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NotificationHub -Specifies the notification hub that the PNS credentials are assigned to. -Notification hubs are used to send push notifications to multiple clients regardless of the platform used by those clients. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroup -Specifies the resource group to which the notification hub is assigned. -Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and Azure administration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.NotificationHubs.Models.NotificationHubAttributes - -## NOTES - -## RELATED LINKS - -[Get-AzureRmNotificationHub](./Get-AzureRmNotificationHub.md) - - diff --git a/azurermps-6.13.0/AzureRM.NotificationHubs/Get-AzureRmNotificationHubsNamespace.md b/azurermps-6.13.0/AzureRM.NotificationHubs/Get-AzureRmNotificationHubsNamespace.md deleted file mode 100644 index 142cc81e0b..0000000000 --- a/azurermps-6.13.0/AzureRM.NotificationHubs/Get-AzureRmNotificationHubsNamespace.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml -Module Name: AzureRM.NotificationHubs -ms.assetid: 9805B3F1-C6BB-4A0F-A7C3-1DD1ACB75CDA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.notificationhubs/get-azurermnotificationhubsnamespace -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubsNamespace.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubsNamespace.md ---- - -# Get-AzureRmNotificationHubsNamespace - -## SYNOPSIS -Gets information about a notification hub namespace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmNotificationHubsNamespace [[-ResourceGroup] <String>] [[-Namespace] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -**The Get-AzureRmNotificationHubsNamespace** cmdlet gets information about notification hub namespaces. -This cmdlet provides you the option of getting information for all your namespaces, information about the namespaces assigned to a specified resource group; or for returning information about a specific namespace. -Namespaces are logical containers that help you organize and manage your notification hubs. -You must have at least one notification hub namespace: all notification hubs must be assigned to a namespace. -A single namespace can house multiple hubs which means that you might only need one namespace in your organization. -However, you can also have multiple namespaces to better organize your hubs, or to give specific individuals permission to manage a selected subset of hubs. -The **Get-AzureRmNotificationHubsNamespace** cmdlet returns basic information about the namespace itself. -To get information about the authorization rules associated with a namespace use Get-AzureRmNotificationHubsNamespaceAuthorizationRules. - -## EXAMPLES - -### Example 1: Get information for all notification hub namespaces -``` -PS C:\>Get-AzureRmNotificationHubsNamespace -``` - -This command returns information for all your notification hub namespaces. - -### Example 2: Get information for a single notification hub namespace -``` -PS C:\>Get-AzureRmNotificationHubsNamespace -Namespace "ContosoNamespace" -``` - -This command gets information for a single notification hub namespace: ContosoNamespace. - -### Example 3: Get information for all notification hubs assigned to a specific namespace -``` -PS C:\>Get-AzureRmNotificationHubsNamespace -ResourceGroup "ContosoNotificationsGroup" -``` - -This command gets information for all notification hub namespaces assigned to the resource group ContosoNotificationsGroup. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Namespace -Specifies a unique name for the namespace. -Namespaces provide a way to group and categorize notification hubs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroup -Specifies the resource group to which the namespace is assigned. -Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and Azure administration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.NotificationHubs.Models.NamespaceAttributes - -## NOTES - -## RELATED LINKS - -[Get-AzureRmNotificationHubsNamespaceAuthorizationRules](./Get-AzureRmNotificationHubsNamespaceAuthorizationRules.md) - -[New-AzureRmNotificationHubsNamespace](./New-AzureRmNotificationHubsNamespace.md) - -[Remove-AzureRmNotificationHubsNamespace](./Remove-AzureRmNotificationHubsNamespace.md) - -[Set-AzureRmNotificationHubsNamespace](./Set-AzureRmNotificationHubsNamespace.md) - - diff --git a/azurermps-6.13.0/AzureRM.NotificationHubs/Get-AzureRmNotificationHubsNamespaceAuthorizationRules.md b/azurermps-6.13.0/AzureRM.NotificationHubs/Get-AzureRmNotificationHubsNamespaceAuthorizationRules.md deleted file mode 100644 index 521635bc0e..0000000000 --- a/azurermps-6.13.0/AzureRM.NotificationHubs/Get-AzureRmNotificationHubsNamespaceAuthorizationRules.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml -Module Name: AzureRM.NotificationHubs -ms.assetid: 08D03498-D18D-47FE-8916-702FA2E7D719 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.notificationhubs/get-azurermnotificationhubsnamespaceauthorizationrules -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubsNamespaceAuthorizationRules.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubsNamespaceAuthorizationRules.md ---- - -# Get-AzureRmNotificationHubsNamespaceAuthorizationRules - -## SYNOPSIS -Gets information about the authorization rules associated with a notification hub namespace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmNotificationHubsNamespaceAuthorizationRules [-ResourceGroup] <String> [-Namespace] <String> - [[-AuthorizationRule] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmNotificationHubsNamespaceAuthorizationRules** cmdlet returns information about the Shared Access Signature (SAS) authorization rules associated with a notification hub namespace. -You can return information about all the rules associated with the namespace. -Alternatively, and by including the *AuthorizationRule* parameter, you can return information for a specific rule. -Authorization rules manage access to namespaces. -This is done through the creation of links, as URIs, based on different permission levels. -Platform levels can be one of the following: -- Listen -- Send -- Manage -Clients are directed to one of these URIs based on the appropriate permission level. -For instance, a client given the Listen permission will be directed to the URI for that permission. -This cmdlet only gets the authorization rules associated with a namespace. -To get information about the namespace itself, use Get-AzureRmNotificationHubsNamespace. - -## EXAMPLES - -### Example 1: Get information about all authorization rules assigned to namespaces -``` -PS C:\>Get-AzureRmNotificationHubsNamespaceAuthorizationRules -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationsGroup" -``` - -This command gets information about all the authorization rules assigned to both the namespace ContosoNamespace and the ContosoNotificationsGroup resource group. - -### Example 2: Get information about an authorization rule -``` -PS C:\>Get-AzureRmNotificationHubsNamespaceAuthorizationRules -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationsGroup" -AuthorizationRule "ListenRule" -``` - -This command gets information about a single namespace authorization rule named ListenRule. -You must include the namespace and the resource group when you get information for a specific authorization rule. - -## PARAMETERS - -### -AuthorizationRule -Specifies the name of a SAS authentication rule. -These rules determine the type of access that users have to the namespace. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Namespace -Specifies the namespace to which the authorization rules are assigned. -Namespaces provide a way to group and categorize notification hubs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroup -Specifies the resource group to which the authorization rules are assigned. -Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and Azure administration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.NotificationHubs.Models.SharedAccessAuthorizationRuleAttributes - -## NOTES - -## RELATED LINKS - -[Get-AzureRmNotificationHubsNamespace](./Get-AzureRmNotificationHubsNamespace.md) - -[New-AzureRmNotificationHubsNamespace](./New-AzureRmNotificationHubsNamespace.md) - -[Remove-AzureRmNotificationHubsNamespace](./Remove-AzureRmNotificationHubsNamespace.md) - -[Set-AzureRmNotificationHubsNamespace](./Set-AzureRmNotificationHubsNamespace.md) - - diff --git a/azurermps-6.13.0/AzureRM.NotificationHubs/Get-AzureRmNotificationHubsNamespaceListKeys.md b/azurermps-6.13.0/AzureRM.NotificationHubs/Get-AzureRmNotificationHubsNamespaceListKeys.md deleted file mode 100644 index 197a15b74f..0000000000 --- a/azurermps-6.13.0/AzureRM.NotificationHubs/Get-AzureRmNotificationHubsNamespaceListKeys.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml -Module Name: AzureRM.NotificationHubs -ms.assetid: F769A8AB-E025-49EE-AEA4-0D27EAEE341F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.notificationhubs/get-azurermnotificationhubsnamespacelistkeys -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubsNamespaceListKeys.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubsNamespaceListKeys.md ---- - -# Get-AzureRmNotificationHubsNamespaceListKeys - -## SYNOPSIS -Gets the primary and secondary connection strings associated with a notification hub namespace authorization rule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmNotificationHubsNamespaceListKeys [-ResourceGroup] <String> [-Namespace] <String> - [-AuthorizationRule] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmNotificationHubsNamespaceListKeys** cmdlet returns the primary and secondary connection strings for a Shared Access Signature (SAS) authorization rule assigned to a notification hub namespace. -Authorization rules manage user rights to a notification hub namespace. -Each rule includes a primary and a secondary connection string. - -## EXAMPLES - -### Example 1: Get the primary and secondary connection strings for an authorization rule -``` -PS C:\>Get-AzureRmNotificationHubsNamespaceListKeys -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationsGroup" -AuthorizationRule "ListenRule" -``` - -This command returns the primary and secondary connection strings for the authorization rule named ListenRule assigned to the ContosoNamespace namespace. -When you run this command you must include the name of the resource group that the namespace is assigned to. - -## PARAMETERS - -### -AuthorizationRule -Specifies the name of a SAS authentication rule. -These rules determine the type of access that users have to the notification hub. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Namespace -Specifies the namespace containing the connection strings that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroup -Specifies the resource group to which the namespace is assigned. -Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and Azure administration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.NotificationHubs.Models.ResourceListKeys - -## NOTES - -## RELATED LINKS - -[Get-AzureRmNotificationHubsNamespace](./Get-AzureRmNotificationHubsNamespace.md) - -[Get-AzureRmNotificationHubsNamespaceAuthorizationRules](./Get-AzureRmNotificationHubsNamespaceAuthorizationRules.md) - - diff --git a/azurermps-6.13.0/AzureRM.NotificationHubs/New-AzureRmNotificationHub.md b/azurermps-6.13.0/AzureRM.NotificationHubs/New-AzureRmNotificationHub.md deleted file mode 100644 index 27b3d30501..0000000000 --- a/azurermps-6.13.0/AzureRM.NotificationHubs/New-AzureRmNotificationHub.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml -Module Name: AzureRM.NotificationHubs -ms.assetid: 8EDDA991-55B6-4151-8619-E13E14599ECD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.notificationhubs/new-azurermnotificationhub -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHub.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHub.md ---- - -# New-AzureRmNotificationHub - -## SYNOPSIS -Creates a notification hub. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### InputFileParameterSet -``` -New-AzureRmNotificationHub [-ResourceGroup] <String> [-Namespace] <String> [-InputFile] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### NotificationHubParameterSet -``` -New-AzureRmNotificationHub [-ResourceGroup] <String> [-Namespace] <String> - [-NotificationHubObj] <NotificationHubAttributes> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmNotificationHub** cmdlet creates a notification hub. -Notification hubs are used to send push notifications to multiple clients regardless of the platform used by those clients. -Notification hubs are roughly equivalent to individual apps: each of your apps will typically have its own notification hub. -The **New-AzureRmNotificationHub** cmdlet provides two ways to create a new notification hub. -You can create an instance of the **NotificationHubAttributes** object and then configure that object. -You can then copy those property values to your new hub by through the *NotificationHubObj* parameter. -Alternatively, you can create a JSON (JavaScript Object Notation) file containing the relevant configuration values and then apply those values by using the *InputFile* parameter. -When used in conjunction with the **New-AzureRmNotificationHub** cmdlet, the preceding JSON sample creates a notification hub named ContosoNotificationHub located on the West US datacenter. - -## EXAMPLES - -### Example 1: Create a notification hub -``` -PS C:\>New-AzureRmNotificationHub -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationsGroup" -InputFile "C:\Configurations\InternalHub.json" -``` - -This command creates a notification hub in the namespace ContosoNamespace. -The new hub will be assigned to the ContosoNotificationsGroup. -You do not need to specify a name or any other configuration information for the hub; that information will be taken from the input file C:\Configurations\InternalHub.json. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputFile -Specifies the path to a JSON file containing configuration values for the new notification hub. - -```yaml -Type: System.String -Parameter Sets: InputFileParameterSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Namespace -Specifies the namespace to which the notification hub will be assigned. -Namespaces provide a way to group and categorize notification hubs. -Notification hubs must be assigned to an existing namespace. -The **New-AzureRmNotificationHub** cmdlet cannot create a new namespace. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NotificationHubObj -Specifies the **NotificationHubAttributes** object that contains configuration information for the new hub. - -```yaml -Type: Microsoft.Azure.Commands.NotificationHubs.Models.NotificationHubAttributes -Parameter Sets: NotificationHubParameterSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroup -Specifies the resource group to which the notification hub will be assigned. -Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and Azure administration. -You must use an existing resource group. -The **New-AzureRmNotificationHub** cmdlet cannot create a new resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.NotificationHubs.Models.NotificationHubAttributes - -## NOTES - -## RELATED LINKS - -[Get-AzureRmNotificationHub](./Get-AzureRmNotificationHub.md) - -[Remove-AzureRmNotificationHub](./Remove-AzureRmNotificationHub.md) - -[Set-AzureRmNotificationHub](./Set-AzureRmNotificationHub.md) - - diff --git a/azurermps-6.13.0/AzureRM.NotificationHubs/New-AzureRmNotificationHubAuthorizationRules.md b/azurermps-6.13.0/AzureRM.NotificationHubs/New-AzureRmNotificationHubAuthorizationRules.md deleted file mode 100644 index eacac18177..0000000000 --- a/azurermps-6.13.0/AzureRM.NotificationHubs/New-AzureRmNotificationHubAuthorizationRules.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml -Module Name: AzureRM.NotificationHubs -ms.assetid: 7E9CBEE9-DD5F-4552-9187-ECBBEF6174B0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.notificationhubs/new-azurermnotificationhubauthorizationrules -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHubAuthorizationRules.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHubAuthorizationRules.md ---- - -# New-AzureRmNotificationHubAuthorizationRules - -## SYNOPSIS -Creates an authorization rule and assigns the rule to a notification hub. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### InputFileParameterSet -``` -New-AzureRmNotificationHubAuthorizationRules [-ResourceGroup] <String> [-Namespace] <String> - [-NotificationHub] <String> [-InputFile] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### SASRuleParameterSet -``` -New-AzureRmNotificationHubAuthorizationRules [-ResourceGroup] <String> [-Namespace] <String> - [-NotificationHub] <String> [-SASRule] <SharedAccessAuthorizationRuleAttributes> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmNotificationHubAuthorizationRules** cmdlet creates a notification hub Shared Access Signature (SAS) authorization rule. -Authorization rules are used to manage access to your notification hubs. -This is done by the creation of links, as URIs, based on different permission levels. -Clients are directed to one of these URIs based on the appropriate permission level. -For example, a client given the Listen permission will be directed to the URI for that permission. - -## EXAMPLES - -### Example 1: Create a notification hub authorization rule -``` -PS C:\>New-AzureRmNotificationHubAuthorizationRules -Namespace "ContosoNamespace" -NotificationHub "ContosoInternalHub" -ResourceGroup "ContosoNotificationsGroup" -InputFile "C:\Configuration\ExternalAccessRule.json" -``` - -This command creates a new authorization rule and assigns it to the notification hub named ContosoInternalHub. -This hub is located in the ContosoNamespace namespace and is assigned to the ContosoNotificationsGroup resource group. -Note that all the configuration information for the rule, including the rule name, will be taken from the input file C:\Configuration\ExternalAccessRule.json. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputFile -Specifies the input file for the authorization rule that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: InputFileParameterSet -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Namespace -Specifies the namespace to which the authorization rules are assigned. -Namespaces provide a way to group and categorize notification hubs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NotificationHub -Specifies the notification hub that the authorization rules will be assigned to. -Notification hubs are used to send push notifications to multiple clients regardless of the platform used by those clients. -Note that you must specify the name of an existing notification hub. -The **New-AzureRmNotificationHubAuthorizationRules** cmdlet cannot create new notification hubs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroup -Specifies the resource group that the notification hub is assigned to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SASRule -Specifies the **SharedAccessAuthorizationRuleAttributes** object containing configuration information for the new rules. - -```yaml -Type: Microsoft.Azure.Commands.NotificationHubs.Models.SharedAccessAuthorizationRuleAttributes -Parameter Sets: SASRuleParameterSet -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.NotificationHubs.Models.SharedAccessAuthorizationRuleAttributes - -## NOTES - -## RELATED LINKS - -[Get-AzureRmNotificationHubAuthorizationRules](./Get-AzureRmNotificationHubAuthorizationRules.md) - -[Remove-AzureRmNotificationHubAuthorizationRules](./Remove-AzureRmNotificationHubAuthorizationRules.md) - -[Set-AzureRmNotificationHubAuthorizationRules](./Set-AzureRmNotificationHubAuthorizationRules.md) - - diff --git a/azurermps-6.13.0/AzureRM.NotificationHubs/New-AzureRmNotificationHubKey.md b/azurermps-6.13.0/AzureRM.NotificationHubs/New-AzureRmNotificationHubKey.md deleted file mode 100644 index 60a0b02ae0..0000000000 --- a/azurermps-6.13.0/AzureRM.NotificationHubs/New-AzureRmNotificationHubKey.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml -Module Name: AzureRM.NotificationHubs -ms.assetid: A03F32C3-BB01-46A5-86C5-B7A4DDC42351 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.notificationhubs/new-azurermnotificationhubkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHubKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHubKey.md ---- - -# New-AzureRmNotificationHubKey - -## SYNOPSIS -Regenerate the Authorization Rule Key for a NotificationHub . - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmNotificationHubKey [-ResourceGroup] <String> [-Namespace] <String> [-NotificationHub] <String> - [[-AuthorizationRule] <String>] [-PolicyKey] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -New-AzureRmNotificationHubKey cmdlet regenerates the Primary Key/Secondary Key for the NotificationHub Authorization Rule. - -## EXAMPLES - -### Example 1 -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -AuthorizationRule -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Namespace -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NotificationHub -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PolicyKey -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: PrimaryKey, SecondaryKey - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroup -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.NotificationHubs.Models.ResourceListKeys - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.NotificationHubs/New-AzureRmNotificationHubsNamespace.md b/azurermps-6.13.0/AzureRM.NotificationHubs/New-AzureRmNotificationHubsNamespace.md deleted file mode 100644 index 6e0acd14a6..0000000000 --- a/azurermps-6.13.0/AzureRM.NotificationHubs/New-AzureRmNotificationHubsNamespace.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml -Module Name: AzureRM.NotificationHubs -ms.assetid: 3BA94976-DE88-4F07-9C06-41FEEDE1B829 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.notificationhubs/new-azurermnotificationhubsnamespace -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHubsNamespace.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHubsNamespace.md ---- - -# New-AzureRmNotificationHubsNamespace - -## SYNOPSIS -Creates a notification hub namespace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmNotificationHubsNamespace [-ResourceGroup] <String> [-Namespace] <String> [-Location] <String> - [[-Tag] <Hashtable>] [[-SkuTier] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmNotificationHubsNamespace** cmdlet creates a notification hub namespace. -Namespaces are logical containers that help you organize and manage your notification hubs. -You must have at least one notification hub namespace. -A single namespace can house multiple hubs. -You can have multiple namespaces to organize your hubs, or to give specific individuals permission to manage a selected subset of your hubs. -To create a namespace, make sure that you specify a unique name for the namespace; specify the datacenter where the namespace will be located; and, specify the resource group that the namespace will be assigned to. -After the namespace has been created you can use the New-AzureRmNotificationHubsNamespaceAuthorizationRules cmdlet to assign authorization rules to that namespace. -Authorization rules are used to manage permissions to the namespace. - -## EXAMPLES - -### Example 1: Create a notification hub -``` -PS C:\>New-AzureRmNotificationHubsNamespace -ResourceGroup "ContosoNotificationsGroup" -Location "West US" -Namespace "ContosoPartners" -``` - -This command creates a notification hub named ContosoPartners. -The namespace will be located in the West US datacenter and be assigned to the ContosoNotificationsGroup resource group. - -### Example 2: Create a notification hub with tags -``` -PS C:\>New-AzureRmNotificationHubsNamespace -ResourceGroup "ContosoNotificationsGroup" -Location "West US" -Namespace "ContosoPartners" -Tags @{Name="Audience";Value="PartnerOrganizations"} -``` - -This command creates a notification hub named ContosoPartners. -The namespace will be located in the West US datacenter and be assigned to the ContosoNotificationsGroup resource group. -In addition, this command creates a tag with the name Audience and the value PartnerOrganizations and is assigned to the namespace. -This ensures that the namespace will be displayed any time you filter for items where the Audience tag is set to PartnerOrganizations. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the display name of the datacenter that will host the Namespace. -Although you can set this parameter to any valid location, for optimal performance you might want to use a datacenter located near the majority of your users. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Specifies the name of the new namespace. -Namespaces provide a way to group and categorize notification hubs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroup -Specifies the resource group to which the namespace will be assigned. -Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and administration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuTier -Sku tier of the namespace - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Specifies name-value pairs that can be used to categorize and organize Azure items. -Tags function similar to keywords, and operate across a deployment. -For example, if you search for all items with the tag Department:IT the search will return all the Azure items that have that tag, regardless of such things as item type, location, or resource group. -An individual tag consists of two parts: the *Name* and, optionally, the *Value*. -For instance, in Department:IT, the tag name is Department and the tag value is IT. -To add a tag, use hash table syntax similar to this, which creates the tag CalendarYear:2016: - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.NotificationHubs.Models.NamespaceAttributes - -## NOTES - -## RELATED LINKS - -[Get-AzureRmNotificationHubsNamespace](./Get-AzureRmNotificationHubsNamespace.md) - -[Remove-AzureRmNotificationHubsNamespace](./Remove-AzureRmNotificationHubsNamespace.md) - -[Set-AzureRmNotificationHubsNamespace](./Set-AzureRmNotificationHubsNamespace.md) - - diff --git a/azurermps-6.13.0/AzureRM.NotificationHubs/New-AzureRmNotificationHubsNamespaceAuthorizationRules.md b/azurermps-6.13.0/AzureRM.NotificationHubs/New-AzureRmNotificationHubsNamespaceAuthorizationRules.md deleted file mode 100644 index 978d1bb550..0000000000 --- a/azurermps-6.13.0/AzureRM.NotificationHubs/New-AzureRmNotificationHubsNamespaceAuthorizationRules.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml -Module Name: AzureRM.NotificationHubs -ms.assetid: 3F59F7E8-CD32-40CB-9DE0-3FB044439DD0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.notificationhubs/new-azurermnotificationhubsnamespaceauthorizationrules -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHubsNamespaceAuthorizationRules.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHubsNamespaceAuthorizationRules.md ---- - -# New-AzureRmNotificationHubsNamespaceAuthorizationRules - -## SYNOPSIS -Creates an authorization rule and assigns that rule to a notification hub namespace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### InputFileParameterSet -``` -New-AzureRmNotificationHubsNamespaceAuthorizationRules [-ResourceGroup] <String> [-Namespace] <String> - [-InputFile] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SASRuleParameterSet -``` -New-AzureRmNotificationHubsNamespaceAuthorizationRules [-ResourceGroup] <String> [-Namespace] <String> - [-SASRule] <SharedAccessAuthorizationRuleAttributes> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmNotificationHubsNamespaceAuthorizationRules** cmdlet creates a Shared Access Signature (SAS) authorization rule and assigns it to a notification hub namespace. -Authorization rules manage user rights to the namespace and to the notification hubs contained with that namespace. -This cmdlet provides two ways to create a new authorization rule and assign it to a namespace. -You can create an instance of the **SharedAccessAuthorizationRuleAttributes** object and then configure that object with the property values you want the new rule to possess. -This can be done using .NET Framework. -You can then copy those property values to your new rule by using *SASRule* parameter. -Alternatively, you can create a JSON (JavaScript Object Notation) file containing the relevant configuration values and then apply those values by using the *InputFile* parameter. -A JSON file is a text file that uses syntax similar to the following: -{ - "Name": "ContosoAuthorizationRule", - "PrimaryKey": "WE4qH0398AyXjlekt56gg1gMR3NHoMs29KkUnnpUk01Y=", - "Rights": \[ - "Listen", - "Send" - \] -} -When used in conjunction with the **New-AzureRmNotificationHubsNamespaceAuthorizationRules** cmdlet, the preceding JSON sample creates an authorization rule named ContosoAuthorizationRule that gives users Listen and Send rights to the namespace. -The *PrimaryKey* that is used for authentication, can be randomly generated by using the following Windows PowerShell command: -\[Convert\]::ToBase64String((1..32 |% { \[byte/](Get-Random -Minimum 0 -Maximum 255) })) - -## EXAMPLES - -### Example 1: Create an authorization rule and assign it to a namespace -``` -PS C:\>New-AzureRmNotificationHubAuthorizationRules -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationsGroup" -InputFile "C:\Configuration\NamespaceAuthorizationRules.json" -``` - -This command creates an authorization rule and assigns that rule to the namespace ContosoNamespace. -When creating this rule you must specify the appropriate namespace and the resource group that the namespace is assigned to. -However, you do not need to specify any information about the rule itself: rule information will be taken from the input file C:\Configuration\NamespaceAuthorizationRules.json. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputFile -Specifies the path to a JSON file containing configuration information for the new authorization rule. - -```yaml -Type: System.String -Parameter Sets: InputFileParameterSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Namespace -Specifies the namespace to which the authorization rules will be assigned. -Namespaces provide a way to group and categorize notification hubs. -The new rules must be assigned to an existing namespace. -The **New-AzureRmNotificationHubsNamespaceAuthorizationRules** cmdlet cannot create a new namespace. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroup -Specifies the resource group to which the namespace is assigned. -Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and Azure administration. -You must use an existing resource group. -This cmdlet cannot create a new resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SASRule -Specifies the **SharedAccessAuthorizationRuleAttributes** object containing configuration information for the new rules. - -```yaml -Type: Microsoft.Azure.Commands.NotificationHubs.Models.SharedAccessAuthorizationRuleAttributes -Parameter Sets: SASRuleParameterSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.NotificationHubs.Models.SharedAccessAuthorizationRuleAttributes - -## NOTES - -## RELATED LINKS - -[Get-AzureRmNotificationHubAuthorizationRules](./Get-AzureRmNotificationHubAuthorizationRules.md) - -[Remove-AzureRmNotificationHubAuthorizationRules](./Remove-AzureRmNotificationHubAuthorizationRules.md) - -[Set-AzureRmNotificationHubAuthorizationRules](./Set-AzureRmNotificationHubAuthorizationRules.md) - - diff --git a/azurermps-6.13.0/AzureRM.NotificationHubs/New-AzureRmNotificationHubsNamespaceKey.md b/azurermps-6.13.0/AzureRM.NotificationHubs/New-AzureRmNotificationHubsNamespaceKey.md deleted file mode 100644 index 92236b24c7..0000000000 --- a/azurermps-6.13.0/AzureRM.NotificationHubs/New-AzureRmNotificationHubsNamespaceKey.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml -Module Name: AzureRM.NotificationHubs -ms.assetid: 1EC19069-B64C-4F0F-99A3-07C16E46C0A0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.notificationhubs/new-azurermnotificationhubsnamespacekey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHubsNamespaceKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHubsNamespaceKey.md ---- - -# New-AzureRmNotificationHubsNamespaceKey - -## SYNOPSIS -Regenerate the Authorization Rule Key for a Namespace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmNotificationHubsNamespaceKey [-ResourceGroup] <String> [-Namespace] <String> - [[-AuthorizationRule] <String>] [-PolicyKey] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -New-AzureRmNotificationHubNamespaceKey cmdlet regenerates the Primary Key/Secondary Key for the Namespace Authorization Rule. - -## EXAMPLES - -### Example 1 -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -AuthorizationRule -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Namespace -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PolicyKey -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: PrimaryKey, SecondaryKey - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroup -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.NotificationHubs.Models.ResourceListKeys - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.NotificationHubs/Remove-AzureRmNotificationHub.md b/azurermps-6.13.0/AzureRM.NotificationHubs/Remove-AzureRmNotificationHub.md deleted file mode 100644 index 0777912dd7..0000000000 --- a/azurermps-6.13.0/AzureRM.NotificationHubs/Remove-AzureRmNotificationHub.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml -Module Name: AzureRM.NotificationHubs -ms.assetid: 62631E1C-FB43-4E87-82C2-159A9D1D4221 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.notificationhubs/remove-azurermnotificationhub -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Remove-AzureRmNotificationHub.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Remove-AzureRmNotificationHub.md ---- - -# Remove-AzureRmNotificationHub - -## SYNOPSIS -Removes an existing notification hub. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmNotificationHub [-ResourceGroup] <String> [-Namespace] <String> [-NotificationHub] <String> - [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmNotificationHub** cmdlet removes an existing notification hub. -Notification hubs are used to send push notifications to multiple clients regardless of the platform used by those clients. -Platforms include, but are not limited to: iOS, Android, Windows Phone 8, and Windows Store. -Notification hubs are roughly equivalent to individual apps: each of your apps will typically have its own notification hub. -You can remove an existing notification hub by using the **Remove-AzureRmNotificationHub** cmdlet. -After a hub has been removed you can no longer use that hub to send push notifications to users. - -## EXAMPLES - -### Example 1: Remove a notification hub -``` -PS C:\>Remove-AzureRmNotificationHub -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationsGroup" -NotificationHub "ContosoInternalHub" -``` - -This command removes the notification hub named ContosoInternalHub. -In order to remove the hub, you must specify the namespace where the hub is located as well as the resource group the hub is assigned to. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Namespace -Specifies the namespace to which the notification hub is assigned. -Namespaces provide a way to group and categorize notification hubs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NotificationHub -Specifies the notification hub to be removed. -Notification hubs are used to send push notifications to multiple clients regardless of the platform used by those clients. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroup -Specifies the resource group to which the notification hub is assigned. -Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and Azure administration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmNotificationHub](./Get-AzureRmNotificationHub.md) - -[New-AzureRmNotificationHub](./New-AzureRmNotificationHub.md) - -[Set-AzureRmNotificationHub](./Set-AzureRmNotificationHub.md) - - diff --git a/azurermps-6.13.0/AzureRM.NotificationHubs/Remove-AzureRmNotificationHubAuthorizationRules.md b/azurermps-6.13.0/AzureRM.NotificationHubs/Remove-AzureRmNotificationHubAuthorizationRules.md deleted file mode 100644 index 4d3ada2e8f..0000000000 --- a/azurermps-6.13.0/AzureRM.NotificationHubs/Remove-AzureRmNotificationHubAuthorizationRules.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml -Module Name: AzureRM.NotificationHubs -ms.assetid: 715F8821-BBD1-440A-AD54-E960939E288A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.notificationhubs/remove-azurermnotificationhubauthorizationrules -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Remove-AzureRmNotificationHubAuthorizationRules.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Remove-AzureRmNotificationHubAuthorizationRules.md ---- - -# Remove-AzureRmNotificationHubAuthorizationRules - -## SYNOPSIS -Removes an authorization rule from a notification hub. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmNotificationHubAuthorizationRules [-ResourceGroup] <String> [-Namespace] <String> - [-NotificationHub] <String> [-AuthorizationRule] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmNotificationHubAuthorizationRules** cmdlet removes a Shared Access Signature (SAS) authorization rule from a notification hub. -Authorization rules manage access to your notification hubs through the creation of links, as URIs, based on different permission levels. -Permission levels can be one of the following: -- Listen -- Send -- Manage -Clients are directed to one of these URIs based on the appropriate permission level. -For instance, a client given the Listen permission will be directed to the URI for that permission. -Removing an authorization rule also removes the corresponding user permission. - -## EXAMPLES - -### Example 1: Remove an authorization rule from a notification hub -``` -PS C:\>Remove-AzureRmNotificationHubAuthorizationRules -Namespace "ContosoNamespace" -NotificationHub "ContosoExternalHub" -ResourceGroup "ContosoNotificationsGroup" -AuthorizationRule "ListenRule" -``` - -This command removes the authorization rule named ListenRule from the notification hub named ContosoExternalHub. -When you run this command you must specify both the namespace and the resource group that the hub is assigned to. - -## PARAMETERS - -### -AuthorizationRule -Specifies the name of the SAS authentication rule that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Namespace -Specifies the namespace to which the notification hub is assigned. -Namespaces provide a way to group and categorize notification hubs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NotificationHub -Specifies the notification hub the authorization rules are assigned to. -Notification hubs are used to send push notifications to multiple clients regardless of the platform. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroup -Specifies the resource group to which the notification hub is assigned. -Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and Azure administration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmNotificationHubAuthorizationRules](./Get-AzureRmNotificationHubAuthorizationRules.md) - -[New-AzureRmNotificationHubAuthorizationRules](./New-AzureRmNotificationHubAuthorizationRules.md) - -[Set-AzureRmNotificationHubAuthorizationRules](./Set-AzureRmNotificationHubAuthorizationRules.md) - - diff --git a/azurermps-6.13.0/AzureRM.NotificationHubs/Remove-AzureRmNotificationHubsNamespace.md b/azurermps-6.13.0/AzureRM.NotificationHubs/Remove-AzureRmNotificationHubsNamespace.md deleted file mode 100644 index f4706fa593..0000000000 --- a/azurermps-6.13.0/AzureRM.NotificationHubs/Remove-AzureRmNotificationHubsNamespace.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml -Module Name: AzureRM.NotificationHubs -ms.assetid: 5EDFBF19-928F-4F95-BD93-CF8BAEA11C52 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.notificationhubs/remove-azurermnotificationhubsnamespace -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Remove-AzureRmNotificationHubsNamespace.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Remove-AzureRmNotificationHubsNamespace.md ---- - -# Remove-AzureRmNotificationHubsNamespace - -## SYNOPSIS -Removes a notification hub namespace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmNotificationHubsNamespace [-ResourceGroup] <String> [-Namespace] <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmNotificationHubsNamespace** cmdlet removes a notification hub namespace from your deployment. -Namespaces are logical containers that help you organize and manage your notification hubs. -The **Remove-AzureRmNotificationHubsNamespace** cmdlet removes a notification hub namespace from your deployment. -When you run this cmdlet, the specified namespace will be deleted along with all the notification hubs associated with that namespace. - -## EXAMPLES - -### Example 1: Remove a notification hub namespace -``` -PS C:\>Remove-AzureRmNotificationHubsNamespace -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationsGroup" -``` - -This command removes the namespace named ContosoNamespace. -You must specify the resource group the namespace is assigned to. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Namespace -Specifies the namespace that this cmdlet removes. -Namespaces provide a way to group and categorize notification hubs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroup -Specifies the resource group to which the namespace is assigned. -Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and Azure administration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmNotificationHubsNamespace](./Get-AzureRmNotificationHubsNamespace.md) - -[New-AzureRmNotificationHubsNamespace](./New-AzureRmNotificationHubsNamespace.md) - -[Set-AzureRmNotificationHubsNamespace](./Set-AzureRmNotificationHubsNamespace.md) - - diff --git a/azurermps-6.13.0/AzureRM.NotificationHubs/Remove-AzureRmNotificationHubsNamespaceAuthorizationRules.md b/azurermps-6.13.0/AzureRM.NotificationHubs/Remove-AzureRmNotificationHubsNamespaceAuthorizationRules.md deleted file mode 100644 index be9418089b..0000000000 --- a/azurermps-6.13.0/AzureRM.NotificationHubs/Remove-AzureRmNotificationHubsNamespaceAuthorizationRules.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml -Module Name: AzureRM.NotificationHubs -ms.assetid: 860AB403-3F99-45FA-8E6A-8C9872C121E8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.notificationhubs/remove-azurermnotificationhubsnamespaceauthorizationrules -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Remove-AzureRmNotificationHubsNamespaceAuthorizationRules.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Remove-AzureRmNotificationHubsNamespaceAuthorizationRules.md ---- - -# Remove-AzureRmNotificationHubsNamespaceAuthorizationRules - -## SYNOPSIS -Removes an authorization rule from a notification hub namespace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmNotificationHubsNamespaceAuthorizationRules [-ResourceGroup] <String> [-Namespace] <String> - [-AuthorizationRule] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmNotificationHubsNamespaceAuthorizationRules** cmdlet removes a Shared Access Signature (SAS) authorization rule from a notification hub namespace. -Authorization rules manage access to a namespace. -This is done by through the creation of links, as URIs, based on different permission levels. -Permission levels can be of the following: -- Listen -- Send -- Manage -Clients are directed to one of these URIs based on the appropriate permission level. -For instance, a client given the Listen permission is directed to the URI for that permission. -Removing an authorization rule also removes the corresponding user permission. - -## EXAMPLES - -### Example 1: Remove an authorization rule from a namespace -``` -PS C:\>Remove-AzureRmNotificationHubNamespaceAuthorizationRules -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationsGroup" -AuthorizationRule "ListenRule" -``` - -This command removes the authorization rule named ListenRule from the namespace named ContosoNamespace. -When you run this command you must specify the resource group that the namespace is assigned to. - -## PARAMETERS - -### -AuthorizationRule -Specifies the name of the SAS authentication rule to be removed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Namespace -Specifies the namespace to which the authorization rules are assigned. -Namespaces provide a way to group and categorize notification hubs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroup -Specifies the resource group to which the namespace is assigned. -Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and Azure administration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmNotificationHubsNamespaceAuthorizationRules](./Get-AzureRmNotificationHubsNamespaceAuthorizationRules.md) - -[New-AzureRmNotificationHubsNamespaceAuthorizationRules](./New-AzureRmNotificationHubsNamespaceAuthorizationRules.md) - -[Set-AzureRmNotificationHubsNamespaceAuthorizationRules](./Set-AzureRmNotificationHubsNamespaceAuthorizationRules.md) - - diff --git a/azurermps-6.13.0/AzureRM.NotificationHubs/Set-AzureRmNotificationHub.md b/azurermps-6.13.0/AzureRM.NotificationHubs/Set-AzureRmNotificationHub.md deleted file mode 100644 index d9283dcebb..0000000000 --- a/azurermps-6.13.0/AzureRM.NotificationHubs/Set-AzureRmNotificationHub.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml -Module Name: AzureRM.NotificationHubs -ms.assetid: F7BBEF57-0DC2-4EFF-9AA2-119B3BD19AE6 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.notificationhubs/set-azurermnotificationhub -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Set-AzureRmNotificationHub.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Set-AzureRmNotificationHub.md ---- - -# Set-AzureRmNotificationHub - -## SYNOPSIS -Sets property values for a notification hub. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### InputFileParameterSet -``` -Set-AzureRmNotificationHub [-ResourceGroup] <String> [-Namespace] <String> [-InputFile] <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### NotificationHubParameterSet -``` -Set-AzureRmNotificationHub [-ResourceGroup] <String> [-Namespace] <String> - [-NotificationHubObj] <NotificationHubAttributes> [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmNotificationHub** cmdlet modifies the property values of a notification hub. -You can modify a notification hub property value in two ways. -For one, you can create an instance of the **NotificationHubAttributes** object and then configure that object with the property values you want the new hub to possess. -This can be done through the .NET Framework. -You can then copy those property values to your hub by through the *NotificationHubObj* parameter. -Alternatively, you can create a JSON (JavaScript Object Notation) file that contains the relevant configuration values, then apply those values by through the *InputFile* parameter. -A JSON file is a text file that uses syntax similar to the following: -{ - "Name": "ContosoNotificationHub", - "Location": "West US", -} -When used in conjunction with the **Set-AzureRmNotificationHub** cmdlet, the preceding JSON sample sets the Location value of a notification hub named ContosoNotificationHub to West US. - -## EXAMPLES - -### Example 1: Modify the property values for a notification hub -``` -PS C:\>Set-AzureRmNotificationHub -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationsGroup" -InputFile "C:\Configuration\Hubs.json" -``` - -This command modifies the property values for a notification hub found in the ContosoNamespace namespace and assigned it to the resource group ContosoNotificationsGroup. -The property values, as well as the name of the hub to be modified, are not specified in the command. -Instead, that information is contained in the input file C:\Configuration\Hubs.json. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputFile -Specifies the path to a JSON file that contains configuration information for the notification hub. - -```yaml -Type: System.String -Parameter Sets: InputFileParameterSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Namespace -Specifies the namespace to which the notification hub is assigned. -Namespaces provide a way to group and categorize notification hubs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NotificationHubObj -Specifies the **NotificationHubAttributes** object that contains configuration information for the hub that this cmdlet modifies. - -```yaml -Type: Microsoft.Azure.Commands.NotificationHubs.Models.NotificationHubAttributes -Parameter Sets: NotificationHubParameterSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroup -Specifies the resource group to which the notification hub is assigned. -Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and Azure administration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.NotificationHubs.Models.NotificationHubAttributes - -## NOTES - -## RELATED LINKS - -[Get-AzureRmNotificationHub](./Get-AzureRmNotificationHub.md) - -[New-AzureRmNotificationHub](./New-AzureRmNotificationHub.md) - -[Remove-AzureRmNotificationHub](./Remove-AzureRmNotificationHub.md) - - diff --git a/azurermps-6.13.0/AzureRM.NotificationHubs/Set-AzureRmNotificationHubAuthorizationRules.md b/azurermps-6.13.0/AzureRM.NotificationHubs/Set-AzureRmNotificationHubAuthorizationRules.md deleted file mode 100644 index 93a01b98e3..0000000000 --- a/azurermps-6.13.0/AzureRM.NotificationHubs/Set-AzureRmNotificationHubAuthorizationRules.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml -Module Name: AzureRM.NotificationHubs -ms.assetid: BD311CEF-378B-463E-8998-CC3E9A5B3A7B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.notificationhubs/set-azurermnotificationhubauthorizationrules -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Set-AzureRmNotificationHubAuthorizationRules.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Set-AzureRmNotificationHubAuthorizationRules.md ---- - -# Set-AzureRmNotificationHubAuthorizationRules - -## SYNOPSIS -Sets authorization rules for a notification hub. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### InputFileParameterSet -``` -Set-AzureRmNotificationHubAuthorizationRules [-ResourceGroup] <String> [-Namespace] <String> - [-NotificationHub] <String> [-InputFile] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SASRuleParameterSet -``` -Set-AzureRmNotificationHubAuthorizationRules [-ResourceGroup] <String> [-Namespace] <String> - [-NotificationHub] <String> [-SASRule] <SharedAccessAuthorizationRuleAttributes> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmNotificationHubAuthorizationRules** cmdlet modifies a Shared Access Signature (SAS) authorization rule assigned to a notification hub. -Authorization rules manage access to your notification hubs by the creation of links, as URIs, based on different permission levels. -Permission levels can be one of the following: -- Listen -- Send -- Manage -Clients are directed to one of these URIs based on the appropriate permission level. -For example, a client given the Listen permission will be directed to the URI for that permission. -This cmdlet provides two ways to modify an authorization rule assigned to a notification hub. -For one, you can create an instance of the **SharedAccessAuthorizationRuleAttributes** object and then configure that object with the property values you want the rule to possess. -You can configure the object through the .NET Framework. -You can then copy those property values to your rule by using *SASRule* parameter. -Alternatively, you can create a JSON (JavaScript Object Notation) file containing the relevant configuration values and then apply those values through the *InputFile* parameter. -A JSON file is a text file that uses syntax similar to this: -{ "Name": "ContosoAuthorizationRule", - "PrimaryKey": "WE4qH0398AyXjlekt56gg1gMR3NHoMs29KkUnnpUk01Y=", - "Rights": \[ - "Listen", - "Send" - \] -} -When used in conjunction with the New-AzureRmNotificationHubAuthorizationRules cmdlet, the preceding JSON sample modifies an authorization rule named ContosoAuthorizationRule in order to give users Listen and Send rights to the hub. - -## EXAMPLES - -### Example 1: Modify an authorization rule assigned to a notification hub -``` -PS C:\>Set-AzureRmNotificationHubAuthorizationRules -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationGroup" -NotificationHub "ContosoExternalHub" -InputFile "C:\Configuration\AuthorizationRules.json" -``` - -This command modifies an authorization rule assigned to the notification hub named ContosoExternalHub. -You must specify the namespace where the hub is located as well as the resource group that the hub is assigned. -Information about the rule that is modified is not included in the command itself. -Instead, that information is found in the input file C:\Configuration\AuthorizationRules.json. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputFile -Specifies the path to a JSON file containing configuration information for the new rule. - -```yaml -Type: System.String -Parameter Sets: InputFileParameterSet -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Namespace -Specifies the namespace to which the notification hub is assigned. -Namespaces provide a way to group and categorize notification hubs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NotificationHub -Specifies the notification hub that this cmdlet assigns authorization rules to. -Notification hubs are used to send push notifications to multiple clients regardless of the used by those clients. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroup -Specifies the resource group to which the notification hub is assigned. -Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and Azure administration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SASRule -Specifies the **SharedAccessAuthorizationRuleAttributes** object that contains configuration information for the authorization rules that are modified. - -```yaml -Type: Microsoft.Azure.Commands.NotificationHubs.Models.SharedAccessAuthorizationRuleAttributes -Parameter Sets: SASRuleParameterSet -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.NotificationHubs.Models.SharedAccessAuthorizationRuleAttributes - -## NOTES - -## RELATED LINKS - -[Get-AzureRmNotificationHubAuthorizationRules](./Get-AzureRmNotificationHubAuthorizationRules.md) - -[New-AzureRmNotificationHubAuthorizationRules](./New-AzureRmNotificationHubAuthorizationRules.md) - -[Remove-AzureRmNotificationHubAuthorizationRules](./Remove-AzureRmNotificationHubAuthorizationRules.md) - - diff --git a/azurermps-6.13.0/AzureRM.NotificationHubs/Set-AzureRmNotificationHubsNamespace.md b/azurermps-6.13.0/AzureRM.NotificationHubs/Set-AzureRmNotificationHubsNamespace.md deleted file mode 100644 index 9dec74546f..0000000000 --- a/azurermps-6.13.0/AzureRM.NotificationHubs/Set-AzureRmNotificationHubsNamespace.md +++ /dev/null @@ -1,265 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml -Module Name: AzureRM.NotificationHubs -ms.assetid: 1B2AA717-ECD6-4CC0-AB6D-A199AF21A4A5 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.notificationhubs/set-azurermnotificationhubsnamespace -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Set-AzureRmNotificationHubsNamespace.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Set-AzureRmNotificationHubsNamespace.md ---- - -# Set-AzureRmNotificationHubsNamespace - -## SYNOPSIS -Sets property values for a notification hub namespace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmNotificationHubsNamespace [-ResourceGroup] <String> [-Namespace] <String> [-Location] <String> - [[-State] <NamespaceState>] [[-Critical] <Boolean>] [[-Tag] <Hashtable>] [[-SkuTier] <String>] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmNotificationHubsNamespace** cmdlet sets the property values of an existing notification hub namespace. -Namespaces are logical containers that help you organize and manage your notification hubs. -You must have at least one notification hub namespace. -Additionally, all notification hubs must have an assigned namespace. -This cmdlet is primarily used to enable and disable a namespace. -When a namespace is disabled, users cannot connect to any of the notification hubs in the namespace, nor can administrators use those hubs to send push notifications. -To re-enable a disabled namespace, use this cmdlet to set the **State** property of the namespace to Active. -You can also use this cmdlet to tag a namespace as critical. -This prevents the namespace from being deleted. -To remove a critical namespace you must first remove the Critical tag. - -## EXAMPLES - -### Example 1: Disable a namespace -``` -PS C:\>Set-AzureRmNotificationHubsNamespace -Namespace "ContosoPartners" -Location "West US" -ResourceGroup "ContosoNotificationsGroup" -State "Disabled" -``` - -This command disables the namespace named ContosoPartners located in the West US datacenter and assigned to the ContosoNotificationsGroup resource group. - -### Example 2: Enable a namespace -``` -PS C:\>Set-AzureRmNotificationHubsNamespace -Namespace "ContosoPartners" -Location "West US" -ResourceGroup "ContosoNotificationsGroup" -State "Active" -``` - -This command enables the namespace named ContosoPartners located in the West US datacenter and assigned to the ContosoNotificationsGroup resource group. - -## PARAMETERS - -### -Critical -Indicates whether the namespace is a critical namespace. -Critical namespaces cannot be deleted. -To delete a critical namespace, you must set the value of this property to False in order to mark the namespace as non-critical. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the display name of the datacenter that hosts the namespace. -Although you can set this parameter to any valid Azure location, for optimal performance you should use a datacenter located near the majority of your users. -To get an up-to-date list of Azure locations run the following command: -`Get-AzureLocation | Select-Object DisplayName` - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Specifies the namespace that this cmdlet modifies. -Namespaces provide a way to group and categorize notification hubs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroup -Specifies the resource group to which the namespace is assigned. -Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and Azure administration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuTier -Sku tier of the namespace - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -Specifies the current state of the namespace. -The acceptable values for this parameter are: Active and Disabled. - -```yaml -Type: Microsoft.Azure.Commands.NotificationHubs.Models.NamespaceState -Parameter Sets: (All) -Aliases: -Accepted values: Unknown, Active, Disabled - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Specifies name-value pairs that can be used to categorize and organize Azure items. -Tags function similar to keywords, and operate across a deployment. -For example, if you search for all items with the tag Department:IT the search will return all the Azure items that have that tag, regardless of such things as item type, location, or resource group. -An individual tag consists of two parts: the *Name* and (optionally) the *Value*. -For example, in Department:IT, the tag name is Department and the tag value is IT. -To add a tag, use hash table syntax similar to this, which creates the tag CalendarYear:2016: --Tags @{Name="CalendarYear";Value="2016"} -To add multiple tags in the same command, separate the individual tags by using commas: --Tag @{Name="CalendarYear";Value="2016"}, @{Name="FiscalYear";Value="2017"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.NotificationHubs.Models.NamespaceState - -### System.Boolean - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.NotificationHubs.Models.NamespaceAttributes - -## NOTES - -## RELATED LINKS - -[Get-AzureRmNotificationHubsNamespace](./Get-AzureRmNotificationHubsNamespace.md) - -[New-AzureRmNotificationHubsNamespace](./New-AzureRmNotificationHubsNamespace.md) - -[Remove-AzureRmNotificationHubsNamespace](./Remove-AzureRmNotificationHubsNamespace.md) - - diff --git a/azurermps-6.13.0/AzureRM.NotificationHubs/Set-AzureRmNotificationHubsNamespaceAuthorizationRules.md b/azurermps-6.13.0/AzureRM.NotificationHubs/Set-AzureRmNotificationHubsNamespaceAuthorizationRules.md deleted file mode 100644 index d3805876d8..0000000000 --- a/azurermps-6.13.0/AzureRM.NotificationHubs/Set-AzureRmNotificationHubsNamespaceAuthorizationRules.md +++ /dev/null @@ -1,210 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml -Module Name: AzureRM.NotificationHubs -ms.assetid: F0981A7A-1B17-4141-A267-927E5B78BE5F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.notificationhubs/set-azurermnotificationhubsnamespaceauthorizationrules -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Set-AzureRmNotificationHubsNamespaceAuthorizationRules.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Set-AzureRmNotificationHubsNamespaceAuthorizationRules.md ---- - -# Set-AzureRmNotificationHubsNamespaceAuthorizationRules - -## SYNOPSIS -Sets authorization rules for a notification hub namespace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### InputFileParameterSet -``` -Set-AzureRmNotificationHubsNamespaceAuthorizationRules [-ResourceGroup] <String> [-Namespace] <String> - [-InputFile] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### SASRuleParameterSet -``` -Set-AzureRmNotificationHubsNamespaceAuthorizationRules [-ResourceGroup] <String> [-Namespace] <String> - [-SASRule] <SharedAccessAuthorizationRuleAttributes> [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmNotificationHubsNamespaceAuthorizationRules** cmdlet modifies a Shared Access Signature (SAS) authorization rule assigned to a notification hub namespace. -Authorization rules manage user rights to the namespace and to the notification hubs contained in that namespace. -This cmdlet provides two ways to modify an authorization rule assigned to a namespace. -For one, you can create an instance of the **SharedAccessAuthorizationRuleAttributes** object and then configure that object with the property values you want the rule to possess. -You can use the .NET Framework to accomplish this. -You can then copy those property values to the rule through the *SASRule* parameter. -Alternatively, you can create a JSON (JavaScript Object Notation) file containing the relevant configuration values and then apply those values through the *InputFile* parameter. -A JSON file is a text file that uses syntax similar to this: -{ - "Name": "ContosoAuthorizationRule", - "PrimaryKey": "WE4qH0398AyXjlekt56gg1gMR3NHoMs29KkUnnpUk01Y=", - "Rights": \[ - "Listen", - "Send" - \] -} -When used in conjunction with the **Set-AzureRmNotificationHubsNamespaceAuthorizationRules** cmdlet, the preceding JSON sample modifies an authorization rule named ContosoAuthorizationRule to give users Listen and Send rights to the namespace. - -## EXAMPLES - -### Example 1: Modify an authorization rule assigned to a namespace -``` -PS C:\>Set-AzureRmNotificationHubsNamespaceAuthorizationRules -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationGroup" -InputFile "C:\Configuration\AuthorizationRules.json" -``` - -This command modifies an authorization rule assigned to the namespace named ContosoNamespace. -You must specify the resource group that the namespace is assigned to. -Information about the authorization rule is not included in the command itself. -Instead, that information is obtained from the input file C:\Configuration\AuthorizationRules.json. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputFile -Specifies the path to a JSON file containing configuration information for the new rule. - -```yaml -Type: System.String -Parameter Sets: InputFileParameterSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Namespace -Specifies the namespace that contains the authorization rules that this cmdlet modifies. -Namespaces provide a way to group and categorize notification hubs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroup -Specifies the resource group to which the namespace is assigned. -Resource groups organize items such as namespaces, notification hubs, and authorization rules in ways that help simply inventory management and Azure administration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SASRule -Specifies the **SharedAccessAuthorizationRuleAttributes** object that contains configuration information for the authorization rules that this cmdlet modifies. - -```yaml -Type: Microsoft.Azure.Commands.NotificationHubs.Models.SharedAccessAuthorizationRuleAttributes -Parameter Sets: SASRuleParameterSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.NotificationHubs.Models.SharedAccessAuthorizationRuleAttributes - -## NOTES - -## RELATED LINKS - -[Get-AzureRmNotificationHubsNamespaceAuthorizationRules](./Get-AzureRmNotificationHubsNamespaceAuthorizationRules.md) - -[New-AzureRmNotificationHubsNamespaceAuthorizationRules](./New-AzureRmNotificationHubsNamespaceAuthorizationRules.md) - -[Remove-AzureRmNotificationHubsNamespaceAuthorizationRules](./Remove-AzureRmNotificationHubsNamespaceAuthorizationRules.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/AzureRM.OperationalInsights.md b/azurermps-6.13.0/AzureRM.OperationalInsights/AzureRM.OperationalInsights.md deleted file mode 100644 index 2676bcbbed..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/AzureRM.OperationalInsights.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -Module Name: AzureRM.OperationalInsights -Module Guid: e827799a-7abf-4538-a61f-94dc52a48bd4 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights -Help Version: 4.3.2.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/AzureRM.OperationalInsights.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/AzureRM.OperationalInsights.md ---- - -# AzureRM.OperationalInsights Module -## Description -This topic displays help topics for the Azure Operational Insights Cmdlets. - -## AzureRM.OperationalInsights Cmdlets -### [Disable-AzureRmOperationalInsightsIISLogCollection](Disable-AzureRmOperationalInsightsIISLogCollection.md) -Stops collection of IIS logs from computers. - -### [Disable-AzureRmOperationalInsightsLinuxCustomLogCollection](Disable-AzureRmOperationalInsightsLinuxCustomLogCollection.md) -Stops collection of custom logs from Linux computers. - -### [Disable-AzureRmOperationalInsightsLinuxPerformanceCollection](Disable-AzureRmOperationalInsightsLinuxPerformanceCollection.md) -Stops collection of performance counters from Linux computers. - -### [Disable-AzureRmOperationalInsightsLinuxSyslogCollection](Disable-AzureRmOperationalInsightsLinuxSyslogCollection.md) -Stops collection of syslog data from Linux computers. - -### [Enable-AzureRmOperationalInsightsIISLogCollection](Enable-AzureRmOperationalInsightsIISLogCollection.md) -Starts collection of IIS logs from computers in a workspace. - -### [Enable-AzureRmOperationalInsightsLinuxCustomLogCollection](Enable-AzureRmOperationalInsightsLinuxCustomLogCollection.md) -Starts collection of custom logs from Linux computers. - -### [Enable-AzureRmOperationalInsightsLinuxPerformanceCollection](Enable-AzureRmOperationalInsightsLinuxPerformanceCollection.md) -Starts collection of performance counters from Linux computers. - -### [Enable-AzureRmOperationalInsightsLinuxSyslogCollection](Enable-AzureRmOperationalInsightsLinuxSyslogCollection.md) -Starts collection of syslog data from Linux computers. - -### [Get-AzureRmOperationalInsightsDataSource](Get-AzureRmOperationalInsightsDataSource.md) -Get datasources under Azure Log Analytics workspace. - -### [Get-AzureRmOperationalInsightsIntelligencePacks](Get-AzureRmOperationalInsightsIntelligencePacks.md) -Gets the available Intelligence Packs. - -### [Get-AzureRmOperationalInsightsLinkTargets](Get-AzureRmOperationalInsightsLinkTargets.md) -Gets accounts that are not associated with a subscription. - -### [Get-AzureRmOperationalInsightsSavedSearch](Get-AzureRmOperationalInsightsSavedSearch.md) -Returns all of the saved searches for a specified workspace. - -### [Get-AzureRmOperationalInsightsSavedSearchResults](Get-AzureRmOperationalInsightsSavedSearchResults.md) -Returns the results from a query. - -### [Get-AzureRmOperationalInsightsSchema](Get-AzureRmOperationalInsightsSchema.md) -Returns the schema associated with a workspace. - -### [Get-AzureRmOperationalInsightsSearchResults](Get-AzureRmOperationalInsightsSearchResults.md) -Returns search results based on the specified parameters. - -### [Get-AzureRmOperationalInsightsStorageInsight](Get-AzureRmOperationalInsightsStorageInsight.md) -Gets information about a Storage Insight. - -### [Get-AzureRmOperationalInsightsWorkspace](Get-AzureRmOperationalInsightsWorkspace.md) -Gets information about a workspace. - -### [Get-AzureRmOperationalInsightsWorkspaceManagementGroups](Get-AzureRmOperationalInsightsWorkspaceManagementGroups.md) -Gets details of management groups connected to a workspace. - -### [Get-AzureRmOperationalInsightsWorkspaceSharedKeys](Get-AzureRmOperationalInsightsWorkspaceSharedKeys.md) -Gets the shared keys for a workspace. - -### [Get-AzureRmOperationalInsightsWorkspaceUsage](Get-AzureRmOperationalInsightsWorkspaceUsage.md) -Gets the usage data for a workspace. - -### [Invoke-AzureRmOperationalInsightsQuery](Invoke-AzureRmOperationalInsightsQuery.md) -Returns search results based on the specified parameters. - -### [New-AzureRmOperationalInsightsAzureActivityLogDataSource](New-AzureRmOperationalInsightsAzureActivityLogDataSource.md) -Collect Azure Activity log from given subscription. - -### [New-AzureRmOperationalInsightsComputerGroup](New-AzureRmOperationalInsightsComputerGroup.md) -Creates a computer group. - -### [New-AzureRmOperationalInsightsCustomLogDataSource](New-AzureRmOperationalInsightsCustomLogDataSource.md) -Defines a custom log collection policy. - -### [New-AzureRmOperationalInsightsLinuxPerformanceObjectDataSource](New-AzureRmOperationalInsightsLinuxPerformanceObjectDataSource.md) -Adds performance counters to all Linux computers in a workspace. - -### [New-AzureRmOperationalInsightsLinuxSyslogDataSource](New-AzureRmOperationalInsightsLinuxSyslogDataSource.md) -Adds a data source to Linux computers. - -### [New-AzureRmOperationalInsightsSavedSearch](New-AzureRmOperationalInsightsSavedSearch.md) -Creates a new saved search with the specified parameters. - -### [New-AzureRmOperationalInsightsStorageInsight](New-AzureRmOperationalInsightsStorageInsight.md) -Creates a Storage Insight inside a workspace. - -### [New-AzureRmOperationalInsightsWindowsEventDataSource](New-AzureRmOperationalInsightsWindowsEventDataSource.md) -Collects event logs from computers that run the Windows operating system. - -### [New-AzureRmOperationalInsightsWindowsPerformanceCounterDataSource](New-AzureRmOperationalInsightsWindowsPerformanceCounterDataSource.md) -Adds Windows performance counter data source for connected computers that run the Windows operating system. - -### [New-AzureRmOperationalInsightsWorkspace](New-AzureRmOperationalInsightsWorkspace.md) -Creates a workspace. - -### [Remove-AzureRmOperationalInsightsDataSource](Remove-AzureRmOperationalInsightsDataSource.md) -Deletes a data source. - -### [Remove-AzureRmOperationalInsightsSavedSearch](Remove-AzureRmOperationalInsightsSavedSearch.md) -Removes a saved search from the workspace. - -### [Remove-AzureRmOperationalInsightsStorageInsight](Remove-AzureRmOperationalInsightsStorageInsight.md) -Removes a Storage Insight. - -### [Remove-AzureRmOperationalInsightsWorkspace](Remove-AzureRmOperationalInsightsWorkspace.md) -Removes a workspace. - -### [Set-AzureRmOperationalInsightsDataSource](Set-AzureRmOperationalInsightsDataSource.md) -Updates a data source. - -### [Set-AzureRmOperationalInsightsIntelligencePack](Set-AzureRmOperationalInsightsIntelligencePack.md) -Enables or disables the specified Intelligence Pack. - -### [Set-AzureRmOperationalInsightsSavedSearch](Set-AzureRmOperationalInsightsSavedSearch.md) -Updates a saved search that already exists. - -### [Set-AzureRmOperationalInsightsStorageInsight](Set-AzureRmOperationalInsightsStorageInsight.md) -Updates a Storage Insight. - -### [Set-AzureRmOperationalInsightsWorkspace](Set-AzureRmOperationalInsightsWorkspace.md) -Updates a workspace. - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/Disable-AzureRmOperationalInsightsIISLogCollection.md b/azurermps-6.13.0/AzureRM.OperationalInsights/Disable-AzureRmOperationalInsightsIISLogCollection.md deleted file mode 100644 index c95853d145..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/Disable-AzureRmOperationalInsightsIISLogCollection.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: 95B54065-B6CC-4D10-A747-28CE3F412ABF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/disable-azurermoperationalinsightsiislogcollection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Disable-AzureRmOperationalInsightsIISLogCollection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Disable-AzureRmOperationalInsightsIISLogCollection.md ---- - -# Disable-AzureRmOperationalInsightsIISLogCollection - -## SYNOPSIS -Stops collection of IIS logs from computers. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByWorkspaceName (Default) -``` -Disable-AzureRmOperationalInsightsIISLogCollection [-ResourceGroupName] <String> [-WorkspaceName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByWorkspaceObject -``` -Disable-AzureRmOperationalInsightsIISLogCollection [-Workspace] <PSWorkspace> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Disable-AzureRmOperationalInsightsIISLogCollection** cmdlet stops collection of Internet Information Services (IIS) logs from connected computers in a workspace. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group that contains computers. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Workspace -Specifies a workspace in which this cmdlet operates. - -```yaml -Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameter Sets: ByWorkspaceObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WorkspaceName -Specifies the name of a workspace in which this cmdlet operates. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameters: Workspace (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, operational, insights - -## RELATED LINKS - -[Enable-AzureRmOperationalInsightsIISLogCollection](./Enable-AzureRmOperationalInsightsIISLogCollection.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/Disable-AzureRmOperationalInsightsLinuxCustomLogCollection.md b/azurermps-6.13.0/AzureRM.OperationalInsights/Disable-AzureRmOperationalInsightsLinuxCustomLogCollection.md deleted file mode 100644 index b90d5d4d1b..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/Disable-AzureRmOperationalInsightsLinuxCustomLogCollection.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: EF3FE3F1-1C8F-41EB-990E-F2B30BD9D082 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/disable-azurermoperationalinsightslinuxcustomlogcollection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Disable-AzureRmOperationalInsightsLinuxCustomLogCollection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Disable-AzureRmOperationalInsightsLinuxCustomLogCollection.md ---- - -# Disable-AzureRmOperationalInsightsLinuxCustomLogCollection - -## SYNOPSIS -Stops collection of custom logs from Linux computers. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByWorkspaceName (Default) -``` -Disable-AzureRmOperationalInsightsLinuxCustomLogCollection [-ResourceGroupName] <String> - [-WorkspaceName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByWorkspaceObject -``` -Disable-AzureRmOperationalInsightsLinuxCustomLogCollection [-Workspace] <PSWorkspace> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Disable-AzureRmOperationalInsightsLinuxCustomLogCollection** cmdlet stops collection of custom logs from connected Linux computers in a workspace. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group that contains Linux computers. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Workspace -Specifies a workspace in which this cmdlet operates. - -```yaml -Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameter Sets: ByWorkspaceObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WorkspaceName -Specifies the name of a workspace in which this cmdlet operates. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameters: Workspace (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, operational, insights - -## RELATED LINKS - -[Enable-AzureRmOperationalInsightsLinuxCustomLogCollection](./Enable-AzureRmOperationalInsightsLinuxCustomLogCollection.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/Disable-AzureRmOperationalInsightsLinuxPerformanceCollection.md b/azurermps-6.13.0/AzureRM.OperationalInsights/Disable-AzureRmOperationalInsightsLinuxPerformanceCollection.md deleted file mode 100644 index 7b6d9edfac..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/Disable-AzureRmOperationalInsightsLinuxPerformanceCollection.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: 47AFBAC7-8818-4788-B685-7AB4DCD6C2DE -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/disable-azurermoperationalinsightslinuxperformancecollection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Disable-AzureRmOperationalInsightsLinuxPerformanceCollection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Disable-AzureRmOperationalInsightsLinuxPerformanceCollection.md ---- - -# Disable-AzureRmOperationalInsightsLinuxPerformanceCollection - -## SYNOPSIS -Stops collection of performance counters from Linux computers. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByWorkspaceName (Default) -``` -Disable-AzureRmOperationalInsightsLinuxPerformanceCollection [-ResourceGroupName] <String> - [-WorkspaceName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByWorkspaceObject -``` -Disable-AzureRmOperationalInsightsLinuxPerformanceCollection [-Workspace] <PSWorkspace> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Disable-AzureRmOperationalInsightsLinuxPerformanceCollection** cmdlet stops collection of performance counters from connected Linux computers in a workspace. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group that contains Linux computers. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Workspace -Specifies a workspace in which this cmdlet operates. - -```yaml -Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameter Sets: ByWorkspaceObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WorkspaceName -Specifies the name of a workspace in which this cmdlet operates. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameters: Workspace (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, operational, insights - -## RELATED LINKS - -[Enable-AzureRmOperationalInsightsLinuxPerformanceCollection](./Enable-AzureRmOperationalInsightsLinuxPerformanceCollection.md) - -[New-AzureRmOperationalInsightsLinuxSyslogDataSource](./New-AzureRmOperationalInsightsLinuxSyslogDataSource.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/Disable-AzureRmOperationalInsightsLinuxSyslogCollection.md b/azurermps-6.13.0/AzureRM.OperationalInsights/Disable-AzureRmOperationalInsightsLinuxSyslogCollection.md deleted file mode 100644 index 6d0ada120c..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/Disable-AzureRmOperationalInsightsLinuxSyslogCollection.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: 4A91EEDA-D8F0-4109-A32E-B83694952C06 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/disable-azurermoperationalinsightslinuxsyslogcollection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Disable-AzureRmOperationalInsightsLinuxSyslogCollection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Disable-AzureRmOperationalInsightsLinuxSyslogCollection.md ---- - -# Disable-AzureRmOperationalInsightsLinuxSyslogCollection - -## SYNOPSIS -Stops collection of syslog data from Linux computers. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByWorkspaceName (Default) -``` -Disable-AzureRmOperationalInsightsLinuxSyslogCollection [-ResourceGroupName] <String> [-WorkspaceName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByWorkspaceObject -``` -Disable-AzureRmOperationalInsightsLinuxSyslogCollection [-Workspace] <PSWorkspace> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Disable-AzureRmOperationalInsightsLinuxSyslogCollection** cmdlet stops collection of syslog data from connected Linux computers in a workspace. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group that contains Linux computers. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Workspace -Specifies a workspace in which this cmdlet operates. - -```yaml -Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameter Sets: ByWorkspaceObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WorkspaceName -Specifies the name of a workspace in which this cmdlet operates. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameters: Workspace (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, operational, insights - -## RELATED LINKS - -[Enable-AzureRmOperationalInsightsLinuxSyslogCollection](./Enable-AzureRmOperationalInsightsLinuxSyslogCollection.md) - -[New-AzureRmOperationalInsightsLinuxSyslogDataSource](./New-AzureRmOperationalInsightsLinuxSyslogDataSource.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/Enable-AzureRmOperationalInsightsIISLogCollection.md b/azurermps-6.13.0/AzureRM.OperationalInsights/Enable-AzureRmOperationalInsightsIISLogCollection.md deleted file mode 100644 index 9e6156591a..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/Enable-AzureRmOperationalInsightsIISLogCollection.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: 26B1921E-6052-471B-B5B6-F2853536A425 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/enable-azurermoperationalinsightsiislogcollection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Enable-AzureRmOperationalInsightsIISLogCollection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Enable-AzureRmOperationalInsightsIISLogCollection.md ---- - -# Enable-AzureRmOperationalInsightsIISLogCollection - -## SYNOPSIS -Starts collection of IIS logs from computers in a workspace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByWorkspaceName (Default) -``` -Enable-AzureRmOperationalInsightsIISLogCollection [-ResourceGroupName] <String> [-WorkspaceName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByWorkspaceObject -``` -Enable-AzureRmOperationalInsightsIISLogCollection [-Workspace] <PSWorkspace> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Enable-AzureRmOperationalInsightsIISLogCollection** cmdlet starts collection of Internet Information Services (IIS) logs from connected computers in a workspace. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group that contains computers. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Workspace -Specifies a workspace in which this cmdlet operates. - -```yaml -Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameter Sets: ByWorkspaceObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WorkspaceName -Specifies the name of a workspace in which this cmdlet operates. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameters: Workspace (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource - -## NOTES - -## RELATED LINKS - -[Disable-AzureRmOperationalInsightsIISLogCollection](./Disable-AzureRmOperationalInsightsIISLogCollection.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/Enable-AzureRmOperationalInsightsLinuxCustomLogCollection.md b/azurermps-6.13.0/AzureRM.OperationalInsights/Enable-AzureRmOperationalInsightsLinuxCustomLogCollection.md deleted file mode 100644 index 721c2571d6..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/Enable-AzureRmOperationalInsightsLinuxCustomLogCollection.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: 99865242-6623-425E-92F2-0B229FC4EDAC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/enable-azurermoperationalinsightslinuxcustomlogcollection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Enable-AzureRmOperationalInsightsLinuxCustomLogCollection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Enable-AzureRmOperationalInsightsLinuxCustomLogCollection.md ---- - -# Enable-AzureRmOperationalInsightsLinuxCustomLogCollection - -## SYNOPSIS -Starts collection of custom logs from Linux computers. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByWorkspaceName (Default) -``` -Enable-AzureRmOperationalInsightsLinuxCustomLogCollection [-ResourceGroupName] <String> - [-WorkspaceName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByWorkspaceObject -``` -Enable-AzureRmOperationalInsightsLinuxCustomLogCollection [-Workspace] <PSWorkspace> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Enable-AzureRmOperationalInsightsLinuxCustomLogCollection** cmdlet starts collection of custom logs from connected Linux computers in a workspace. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group that contains Linux computers. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Workspace -Specifies a workspace in which this cmdlet operates. - -```yaml -Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameter Sets: ByWorkspaceObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WorkspaceName -Specifies the name of a workspace in which this cmdlet operates. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameters: Workspace (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, operational, insights - -## RELATED LINKS - -[Disable-AzureRmOperationalInsightsLinuxCustomLogCollection](./Disable-AzureRmOperationalInsightsLinuxCustomLogCollection.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/Enable-AzureRmOperationalInsightsLinuxPerformanceCollection.md b/azurermps-6.13.0/AzureRM.OperationalInsights/Enable-AzureRmOperationalInsightsLinuxPerformanceCollection.md deleted file mode 100644 index 9f136b572c..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/Enable-AzureRmOperationalInsightsLinuxPerformanceCollection.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: 10141D75-B58D-42B0-B0A6-92FF630E534C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/enable-azurermoperationalinsightslinuxperformancecollection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Enable-AzureRmOperationalInsightsLinuxPerformanceCollection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Enable-AzureRmOperationalInsightsLinuxPerformanceCollection.md ---- - -# Enable-AzureRmOperationalInsightsLinuxPerformanceCollection - -## SYNOPSIS -Starts collection of performance counters from Linux computers. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByWorkspaceName (Default) -``` -Enable-AzureRmOperationalInsightsLinuxPerformanceCollection [-ResourceGroupName] <String> - [-WorkspaceName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByWorkspaceObject -``` -Enable-AzureRmOperationalInsightsLinuxPerformanceCollection [-Workspace] <PSWorkspace> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Enable-AzureRmOperationalInsightsLinuxPerformanceCollection** cmdlet starts collection of performance counters from connected Linux computers in a workspace. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group that contains Linux computers. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Workspace -Specifies a workspace in which this cmdlet operates. - -```yaml -Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameter Sets: ByWorkspaceObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WorkspaceName -Specifies the name of a workspace in which this cmdlet operates. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameters: Workspace (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, operational, insights - -## RELATED LINKS - -[Disable-AzureRmOperationalInsightsLinuxPerformanceCollection](./Disable-AzureRmOperationalInsightsLinuxPerformanceCollection.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/Enable-AzureRmOperationalInsightsLinuxSyslogCollection.md b/azurermps-6.13.0/AzureRM.OperationalInsights/Enable-AzureRmOperationalInsightsLinuxSyslogCollection.md deleted file mode 100644 index 9b21713fb4..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/Enable-AzureRmOperationalInsightsLinuxSyslogCollection.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: 66DD5919-B6B7-4FE5-B45B-937013549882 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/enable-azurermoperationalinsightslinuxsyslogcollection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Enable-AzureRmOperationalInsightsLinuxSyslogCollection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Enable-AzureRmOperationalInsightsLinuxSyslogCollection.md ---- - -# Enable-AzureRmOperationalInsightsLinuxSyslogCollection - -## SYNOPSIS -Starts collection of syslog data from Linux computers. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByWorkspaceName (Default) -``` -Enable-AzureRmOperationalInsightsLinuxSyslogCollection [-ResourceGroupName] <String> [-WorkspaceName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByWorkspaceObject -``` -Enable-AzureRmOperationalInsightsLinuxSyslogCollection [-Workspace] <PSWorkspace> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Enable-AzureRmOperationalInsightsLinuxSyslogCollection** cmdlet starts collection of syslog data from connected Linux computers in a workspace. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group that contains Linux computers. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Workspace -Specifies a workspace in which this cmdlet operates. - -```yaml -Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameter Sets: ByWorkspaceObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WorkspaceName -Specifies the name of a workspace in which this cmdlet operates. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameters: Workspace (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, operational, insights - -## RELATED LINKS - -[Disable-AzureRmOperationalInsightsLinuxSyslogCollection](./Disable-AzureRmOperationalInsightsLinuxSyslogCollection.md) - -[New-AzureRmOperationalInsightsLinuxSyslogDataSource](./New-AzureRmOperationalInsightsLinuxSyslogDataSource.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsDataSource.md b/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsDataSource.md deleted file mode 100644 index 0b9e107000..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsDataSource.md +++ /dev/null @@ -1,240 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: 1F094EBA-E4AE-4B3E-BA20-858818C6FD12 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/get-azurermoperationalinsightsdatasource -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsDataSource.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsDataSource.md ---- - -# Get-AzureRmOperationalInsightsDataSource - -## SYNOPSIS -Get datasources under Azure Log Analytics workspace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByWorkspaceName (Default) -``` -Get-AzureRmOperationalInsightsDataSource [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByWorkspaceObjectByName -``` -Get-AzureRmOperationalInsightsDataSource [-Workspace] <PSWorkspace> [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByWorkspaceObjectByKind -``` -Get-AzureRmOperationalInsightsDataSource [[-Workspace] <PSWorkspace>] [[-Kind] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByWorkspaceNameByName -``` -Get-AzureRmOperationalInsightsDataSource [-ResourceGroupName] <String> [-WorkspaceName] <String> - [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByWorkspaceNameByKind -``` -Get-AzureRmOperationalInsightsDataSource [[-ResourceGroupName] <String>] [[-WorkspaceName] <String>] - [-Kind] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmOperationalInsightsDataSource** cmdlet gets data sources. -You can specify a data source to get. -You can filter the results based on the kind of data source. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Kind -Specifies the kind of data sources to get. -The acceptable values for this parameter are: -- AzureActivityLog -- CustomLog -- LinuxPerformanceObject -- LinuxSyslog -- WindowsEvent -- WindowsPerformanceCounter - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceObjectByKind -Aliases: -Accepted values: AzureAuditLog, AzureActivityLog, CustomLog, LinuxPerformanceObject, LinuxSyslog, WindowsEvent, WindowsPerformanceCounter - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceNameByKind -Aliases: -Accepted values: AzureAuditLog, AzureActivityLog, CustomLog, LinuxPerformanceObject, LinuxSyslog, WindowsEvent, WindowsPerformanceCounter - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a data source to get. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceObjectByName -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceNameByName -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group that contains data sources to get. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceNameByName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceNameByKind -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Workspace -Specifies a workspace in which this cmdlet operates. - -```yaml -Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameter Sets: ByWorkspaceObjectByName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -```yaml -Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameter Sets: ByWorkspaceObjectByKind -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WorkspaceName -Specifies the name of a workspace in which this cmdlet operates. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceNameByName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceNameByKind -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameters: Workspace (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, operational, insights - -## RELATED LINKS - -[Remove-AzureRmOperationalInsightsDataSource](./Remove-AzureRmOperationalInsightsDataSource.md) - -[Set-AzureRmOperationalInsightsDataSource](./Set-AzureRmOperationalInsightsDataSource.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsIntelligencePacks.md b/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsIntelligencePacks.md deleted file mode 100644 index b236ca9ad9..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsIntelligencePacks.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: 0F9D72C1-2E42-4A67-9FDE-6344F5DE6C30 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/get-azurermoperationalinsightsintelligencepacks -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsIntelligencePacks.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsIntelligencePacks.md ---- - -# Get-AzureRmOperationalInsightsIntelligencePacks - -## SYNOPSIS -Gets the available Intelligence Packs. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmOperationalInsightsIntelligencePacks [-ResourceGroupName] <String> [-WorkspaceName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmOperationalInsightsIntelligencePacks** cmdlet gets the available Intelligence Packs. - -## EXAMPLES - -### Example 1: Get Intelligence Packs -``` -PS C:\>Get-AzureOperationalInsightsStorageInsight -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace" -``` - -This command gets the available Intelligence Packs. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group that contains a workspace. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WorkspaceName -Specifies the workspace name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSIntelligencePack - -## NOTES - -## RELATED LINKS - -[Azure Operational Insights Cmdlets](./AzureRM.OperationalInsights.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsLinkTargets.md b/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsLinkTargets.md deleted file mode 100644 index e3ca940a03..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsLinkTargets.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: 35C6E85B-E5E1-44E8-86E8-F18E197F69DC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/get-azurermoperationalinsightslinktargets -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsLinkTargets.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsLinkTargets.md ---- - -# Get-AzureRmOperationalInsightsLinkTargets - -## SYNOPSIS -Gets accounts that are not associated with a subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmOperationalInsightsLinkTargets [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmOperationalInsightsLinkTargets** cmdlet lists existing accounts that are not associated with an Azure subscription. -To link a new workspace to an existing account, use a customer ID returned by this operation in the customer ID property of a new workspace. - -## EXAMPLES - -### Example 1: Get unlinked accounts -``` -PS C:\>Get-AzureRmOperationalInsightsLinkTargets -``` - -This command gets unlinked accounts that are owned by the caller's ID. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSAccount - -## NOTES - -## RELATED LINKS - -[Azure Operational Insights Cmdlets](./AzureRM.OperationalInsights.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsSavedSearch.md b/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsSavedSearch.md deleted file mode 100644 index 094303f7b7..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsSavedSearch.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: FB2C47AD-E103-409E-A23B-BC316FA32E8C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/get-azurermoperationalinsightssavedsearch -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsSavedSearch.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsSavedSearch.md ---- - -# Get-AzureRmOperationalInsightsSavedSearch - -## SYNOPSIS -Returns all of the saved searches for a specified workspace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmOperationalInsightsSavedSearch [-ResourceGroupName] <String> [-WorkspaceName] <String> - [[-SavedSearchId] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmOperationalInsightsSavedSearch** cmdlet returns all of the saved searches for a specified workspace within the resource group specified if you do not specify a saved search ID. -If you do specify a saved search ID, then the saved search corresponding to that ID is returned. - -## EXAMPLES - -### Example 1: Get all saved searches for a workspace -``` -PS C:\>Get-AzureRmOperationalInsightsSavedSearch -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace" -``` - -This command gets all of the saved resources associated with a workspace. - -### Example 2: Get a specific saved search by ID -``` -PS C:\>Get-AzureRmOperationalInsightsSavedSearch -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace" -SavedSearchId "ContosoSavedSearchId" -``` - -This command gets a specific saved search by its ID. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group that contains a workspace. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SavedSearchId -Specifies a saved search ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WorkspaceName -Specifies a workspace name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSSearchListSavedSearchResponse - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSSearchGetSavedSearchResponse - -## NOTES - -## RELATED LINKS - -[Azure Operational Insights Cmdlets](./AzureRM.OperationalInsights.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsSavedSearchResults.md b/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsSavedSearchResults.md deleted file mode 100644 index 5ce1ea6579..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsSavedSearchResults.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: AA3EF369-C724-4D32-A56E-503CBE191320 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/get-azurermoperationalinsightssavedsearchresults -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsSavedSearchResults.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsSavedSearchResults.md ---- - -# Get-AzureRmOperationalInsightsSavedSearchResults - -## SYNOPSIS -Returns the results from a query. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmOperationalInsightsSavedSearchResults [-ResourceGroupName] <String> [-WorkspaceName] <String> - [-SavedSearchId] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmOperationalInsightsSavedSearchResults** cmdlet returns the results from the query specified by the search ID. - -## EXAMPLES - -### Example 1: Get all of the search results for a saved search -``` -PS C:\>Get-AzureRmOperationalInsightSavedSearchResults -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace" -SavedSearchId "ContosoSavedSearchId" -``` - -This command gets all of the search results for a saved search. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group that contains a workspace. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SavedSearchId -Specifies a saved search ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WorkspaceName -Specifies a workspace name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSSearchGetSearchResultsResponse - -## NOTES - -## RELATED LINKS - -[Azure Operational Insights Cmdlets](./AzureRM.OperationalInsights.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsSchema.md b/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsSchema.md deleted file mode 100644 index b3b4b284e0..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsSchema.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: 6A834F26-C3D1-46DA-A4A6-1BB5B69291D0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/get-azurermoperationalinsightsschema -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsSchema.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsSchema.md ---- - -# Get-AzureRmOperationalInsightsSchema - -## SYNOPSIS -Returns the schema associated with a workspace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmOperationalInsightsSchema [-ResourceGroupName] <String> [-WorkspaceName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmOperationalInsightsSchema** cmdlet returns the schema associated with the specified workspace within that resource group. - -## EXAMPLES - -### Example 1: Get the schemas for a workspace -``` -PS C:\>Get-AzureRmOperationalInsightsSchema -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace" -``` - -This command gets the schemas associated with a workspace. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group that contains a workspace. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WorkspaceName -Specifies a workspace name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSSearchGetSchemaResponse - -## NOTES - -## RELATED LINKS - -[Azure Operational Insights Cmdlets](./AzureRM.OperationalInsights.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsSearchResults.md b/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsSearchResults.md deleted file mode 100644 index b9ae40faa0..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsSearchResults.md +++ /dev/null @@ -1,252 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: 438F549D-1AF6-49FE-83AC-B45BAB701AB6 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/get-azurermoperationalinsightssearchresults -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsSearchResults.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsSearchResults.md ---- - -# Get-AzureRmOperationalInsightsSearchResults - -## SYNOPSIS -Returns search results based on the specified parameters. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmOperationalInsightsSearchResults [-ResourceGroupName] <String> [-WorkspaceName] <String> - [[-Top] <Int64>] [[-PreHighlight] <String>] [[-PostHighlight] <String>] [[-Query] <String>] - [[-Start] <DateTime>] [[-End] <DateTime>] [[-Id] <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmOperationalInsightsSearchResults** cmdlet returns the search results based on the specified parameters. -You can access the status of the search in the Metadata property of the returned object. -If the status is Pending, then the search has not completed, and the results will be from the archive. -You can retrieve the results of the search from the Value property of the returned object. - -## EXAMPLES - -### Example 1: Get search results using a query -``` -PS C:\>Get-AzureRmOperationalInsightsSearchResults -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace" -Query "Type=Event" -Top 100 -``` - -This command gets all search results by using a query. - -### Example 2: Get search results using an ID -``` -PS C:\>Get-AzureRmOperationalInsightsSearchResults -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace" -Id "ContosoSearchId" -``` - -This command gets search results by using an ID. - -### Example 3: Wait for a search to complete before displaying results -``` -PS C:\>$error.clear() -$response = @{} -$StartTime = Get-Date - -$resGroup = "ContosoResourceGroup" -$wrkspace = "ContosoWorkspace" - -# Sample Query -$query = "Type=Event" - -# Get Initial response -$response = Get-AzureRmOperationalInsightsSearchResults -WorkspaceName $wrkspace -ResourceGroupName $resGroup -Query $query -Top 15000 -$elapsedTime = $(get-date) - $script:StartTime -Write-Host "Elapsed: " $elapsedTime "Status: " $response.Metadata.Status - -# Split and extract request Id -$reqIdParts = $response.Id.Split("/") -$reqId = $reqIdParts[$reqIdParts.Count -1] - -# Poll if pending -while($response.Metadata.Status -eq "Pending" -and $error.Count -eq 0) { - $response = Get-AzureRmOperationalInsightsSearchResults -WorkspaceName $wrkspace -ResourceGroupName $resGroup -Id $reqId - $elapsedTime = $(get-date) - $script:StartTime - Write-Host "Elapsed: " $elapsedTime "Status: " $response.Metadata.Status -} - -Write-Host "Returned " $response.Value.Count " documents" -Write-Host $error -``` - -This script starts a search and waits until it completes before displaying the results. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -End -End of the queried time range. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Id -If an id is given, the search results for that id will be retrieved using the original query parameters. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PostHighlight -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PreHighlight -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Query -The search query that will be executed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group that contains the workspace. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Start -Start of the queried time range. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Top -The maximum number of results to be returned, limited to 5000. - -```yaml -Type: System.Int64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: 10 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WorkspaceName -Specifies a workspace name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Int64 - -### System.Nullable`1[[System.DateTime, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSSearchGetSearchResultsResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmOperationalInsightsSavedSearchResults](./Get-AzureRmOperationalInsightsSavedSearchResults.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsStorageInsight.md b/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsStorageInsight.md deleted file mode 100644 index b3211f5213..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsStorageInsight.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: 29ABCC1B-8590-4243-A629-709F207927B4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/get-azurermoperationalinsightsstorageinsight -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsStorageInsight.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsStorageInsight.md ---- - -# Get-AzureRmOperationalInsightsStorageInsight - -## SYNOPSIS -Gets information about a Storage Insight. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByWorkspaceName (Default) -``` -Get-AzureRmOperationalInsightsStorageInsight [-ResourceGroupName] <String> [-WorkspaceName] <String> - [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByWorkspaceObject -``` -Get-AzureRmOperationalInsightsStorageInsight [-Workspace] <PSWorkspace> [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmOperationalInsightsStorageInsight** cmdlet gets information about an existing Storage Insight. -If a Storage Insight name is specified, this cmdlet gets information about that Storage Insight. -If you do not specify a name, this cmdlet gets information about all storage insights in a workspace. - -## EXAMPLES - -### Example 1: Get a Storage Insight by name -``` -PS C:\>Get-AzureRmOperationalInsightsStorageInsight -Name "MyStorageInsight" -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace" -``` - -This command gets the storage insight named MyStorageInsight from the workspace named ContosoWorkspace. - -### Example 2: Get a Storage Insight by using a workspace object -``` -PS C:\>$Workspace = Get-AzureRmOperationalInsightsWorkspace -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" -PS C:\>Get-AzureRmOperationalInsightsStorageInsight -Workspace $Workspace -Name "MyStorageInsight" -``` - -The first command uses the **Get-AzureRmOperationalInsightsWorkspace** cmdlet to get an Operational Insights workspace, and then stores it in the $Workspace variable. -The second command gets the storage insight named MyStorageInsight for the workspace in $Workspace. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the Storage Insight name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Workspace -Specifies the workspace that contains the Storage Insights. - -```yaml -Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameter Sets: ByWorkspaceObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WorkspaceName -Specifies the name of the workspace that contains the Storage Insights. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameters: Workspace (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSStorageInsight - -## NOTES - -## RELATED LINKS - -[Azure Operational Insights Cmdlets](./AzureRM.OperationalInsights.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsWorkspace.md b/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsWorkspace.md deleted file mode 100644 index 65f36430ec..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsWorkspace.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: F94415DA-1A4A-4D37-A626-1EDF5D1EFE74 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/get-azurermoperationalinsightsworkspace -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsWorkspace.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsWorkspace.md ---- - -# Get-AzureRmOperationalInsightsWorkspace - -## SYNOPSIS -Gets information about a workspace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmOperationalInsightsWorkspace [[-ResourceGroupName] <String>] [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmOperationalInsightsWorkspace** cmdlet gets information about an existing workspace. -If you specify a workspace name, this cmdlet gets information about that workspace. -If you do not specify a name, this cmdlet gets information about all workspaces in a resource group. -If you do not specify a name and resource group, this cmdlet gets information about all workspaces in a subscription. - -## EXAMPLES - -### Example 1: Get a workspace by name -``` -PS C:\>Get-AzureRmOperationalInsightsWorkspace -Name "MyWorkspace" -ResourceGroupName "ContosoResourceGroup" -``` - -This command gets a workspace named MyWorkspace in the resource group named ContosoResourceGroup. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the workspace name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace - -## NOTES - -## RELATED LINKS - -[Azure Operational Insights Cmdlets](./AzureRM.OperationalInsights.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsWorkspaceManagementGroups.md b/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsWorkspaceManagementGroups.md deleted file mode 100644 index d794714e22..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsWorkspaceManagementGroups.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: F29E0B9C-2479-44FB-B196-EAF97B69E6A6 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/get-azurermoperationalinsightsworkspacemanagementgroups -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsWorkspaceManagementGroups.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsWorkspaceManagementGroups.md ---- - -# Get-AzureRmOperationalInsightsWorkspaceManagementGroups - -## SYNOPSIS -Gets details of management groups connected to a workspace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmOperationalInsightsWorkspaceManagementGroups [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmOperationalInsightsWorkspaceManagementGroups** cmdlet lists the management groups that are connected to a workspace. - -## EXAMPLES - -### Example 1: Get management groups by workspace name -``` -PS C:\>Get-AzureRmOperationalInsightsWorkspaceManagementGroups -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" -``` - -This command gets the management groups for the workspace named MyWorkspace in the resource group named ContosoResourceGroup. - -### Example 2: Get management groups by using the pipeline -``` -PS C:\>Get-AzureRmOperationalInsightsWorkspace -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" | Get-AzureOperationalInsightsWorkspaceManagementGroups -``` - -This command uses the Get-AzureRmOperationalInsightsWorkspace cmdlet to get the workspace named MyWorkspace, and then passes the workspace to the current cmdlet, which gets the management groups for that workspace. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the workspace name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSManagementGroup - -## NOTES - -## RELATED LINKS - -[Azure Operational Insights Cmdlets](./AzureRM.OperationalInsights.md) - -[Get-AzureRmOperationalInsightsWorkspace](./Get-AzureRmOperationalInsightsWorkspace.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsWorkspaceSharedKeys.md b/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsWorkspaceSharedKeys.md deleted file mode 100644 index 892688cc50..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsWorkspaceSharedKeys.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: 112D5C69-3F4F-4BB6-9DA4-52757146B0EF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/get-azurermoperationalinsightsworkspacesharedkeys -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsWorkspaceSharedKeys.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsWorkspaceSharedKeys.md ---- - -# Get-AzureRmOperationalInsightsWorkspaceSharedKeys - -## SYNOPSIS -Gets the shared keys for a workspace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmOperationalInsightsWorkspaceSharedKeys [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmOperationalInsightsWorkspaceSharedKeys** cmdlet lists the shared keys for a workspace. -The keys are used to connect Operational Insights agents to the workspace. - -## EXAMPLES - -### Example 1: Get shared keys by workspace name -``` -PS C:\>Get-AzureRmOperationalInsightsWorkspaceSharedKeys -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" -``` - -This command gets the shared keys for the workspace named MyWorkspace in the resource group named ContosoResourceGroup. - -### Example 2: Get shared keys by using the pipeline -``` -PS C:\>Get-AzureRmOperationalInsightsWorkspace -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" | Get-AzureRmOperationalInsightsWorkspaceSharedKeys -``` - -This command gets the workspace named MyWorkspace using the Get-AzureRmOperationalInsightsWorkspace cmdlet, and then passes the workspace to the **Get-AzureRmOperationalInsightsWorkspaceSharedKeys** cmdlet. -The command gets the shared keys for that workspace. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the workspace name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspaceKeys - -## NOTES - -## RELATED LINKS - -[Azure Operational Insights Cmdlets](./AzureRM.OperationalInsights.md) - -[Get-AzureRmOperationalInsightsWorkspace](./Get-AzureRmOperationalInsightsWorkspace.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsWorkspaceUsage.md b/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsWorkspaceUsage.md deleted file mode 100644 index c48a75c031..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/Get-AzureRmOperationalInsightsWorkspaceUsage.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: 818A048F-7CBE-4845-BBC2-6420CE48199A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/get-azurermoperationalinsightsworkspaceusage -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsWorkspaceUsage.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsWorkspaceUsage.md ---- - -# Get-AzureRmOperationalInsightsWorkspaceUsage - -## SYNOPSIS -Gets the usage data for a workspace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmOperationalInsightsWorkspaceUsage [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmOperationalInsightsWorkspaceUsage** cmdlet retrieves the usage data for a workspace. -This exposes how much data has been analyzed by the workspace over a certain period. - -## EXAMPLES - -### Example 1: Get usage data by workspace name -``` -PS C:\>Get-AzureRmOperationalInsightsWorkspaceUsage -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" -``` - -This command gets the usage details for the workspace named MyWorkspace in the specified resource group. - -### Example 2: Get usage data using the pipeline -``` -PS C:\>Get-AzureRmOperationalInsightsWorkspace -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" | Get-AzureOperationalInsightsWorkspaceUsage -``` - -This command gets the workspace named MyWorkSpace using the Get-AzureRmOperationalInsightsWorkspace cmdlet, and then passes the workspace to the current cmdlet. -The command gets the usage details for that workspace. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the workspace name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSUsageMetric - -## NOTES - -## RELATED LINKS - -[Azure Operational Insights Cmdlets](./AzureRM.OperationalInsights.md) - -[Get-AzureRmOperationalInsightsWorkspace](./Get-AzureRmOperationalInsightsWorkspace.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/Invoke-AzureRmOperationalInsightsQuery.md b/azurermps-6.13.0/AzureRM.OperationalInsights/Invoke-AzureRmOperationalInsightsQuery.md deleted file mode 100644 index 9ad1fc78e3..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/Invoke-AzureRmOperationalInsightsQuery.md +++ /dev/null @@ -1,230 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/invoke-azurermoperationalinsightsquery -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Invoke-AzureRmOperationalInsightsQuery.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Invoke-AzureRmOperationalInsightsQuery.md ---- - -# Invoke-AzureRmOperationalInsightsQuery - -## SYNOPSIS -Returns search results based on the specified parameters. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByWorkspaceId (Default) -``` -Invoke-AzureRmOperationalInsightsQuery -WorkspaceId <String> -Query <String> [-Timespan <TimeSpan>] - [-Wait <Int32>] [-IncludeRender] [-IncludeStatistics] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByWorkspaceObject -``` -Invoke-AzureRmOperationalInsightsQuery -Workspace <PSWorkspace> -Query <String> [-Timespan <TimeSpan>] - [-Wait <Int32>] [-IncludeRender] [-IncludeStatistics] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Invoke-AzureRmOperationalInsightsQuery** cmdlet returns the search results based on the specified parameters. -You can access the status of the search in the Metadata property of the returned object. -If the status is Pending, then the search has not completed, and the results will be from the archive. -You can retrieve the results of the search from the Value property of the returned object. - -## EXAMPLES - -### Example 1: Get search results using a query -``` -PS C:\> $queryResults = Invoke-AzureRmOperationalInsightsQuery -WorkspaceId "63613592-b6f7-4c3d-a390-22ba13102111" -Query "union * | take 10" -PS C:\> $queryResults.Results -... -``` - -Once invoked, $queryResults.Results will contain all of the resulting rows from your query. - -### Example 2: Convert $results.Result IEnumberable to an array -``` -PS C:\> $queryResults = Invoke-AzureRmOperationalInsightsQuery -WorkspaceId "63613592-b6f7-4c3d-a390-22ba13102111" -Query "union * | take 10" -PS C:\> $resultsArray = [System.Linq.Enumerable]::ToArray($results.Results) -... -``` - -Some queries can result in very large data sets being returned. Because of this, the default behavior of the cmdlet is to return an IEnumerable to reduce memory costs. If you'd prefer to have an array of results, you can use the LINQ Enumerable.ToArray() extension method to convert the IEnumerable to an array. - -### Example 3: Get search results using a query over a specific timeframe -``` -PS C:\> $queryResults = Invoke-AzureRmOperationalInsightsQuery -WorkspaceId "63613592-b6f7-4c3d-a390-22ba13102111" -Query "union * | take 10" -Timespan (New-TimeSpan -Hours 24) -PS C:\> $queryResults.Results -... -``` - -The results from this query will be limited to the past 24 hours. - -### Example 4: Include render & statistics in query result -``` -PS C:\> $queryResults = Invoke-AzureRmOperationalInsightsQuery -WorkspaceId "63613592-b6f7-4c3d-a390-22ba13102111" -Query "union * | take 10" -IncludeRender -IncludeStatistics -PS C:\> $queryResults.Results -... -PS C:\> $queryResults.Render -... -PS C:\> $queryResults.Statistics -... -``` - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeRender -If specified, rendering information for metric queries will be included in the response. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeStatistics -If specified, query statistics will be included in the response. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Query -The query to execute. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Timespan -The timespan to bound the query by. - -```yaml -Type: System.Nullable`1[System.TimeSpan] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Puts an upper bound on the amount of time the server will spend processing the query. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Workspace -The workspace - -```yaml -Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameter Sets: ByWorkspaceObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WorkspaceId -The workspace ID. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameters: Workspace (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSQueryResponse - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsAzureActivityLogDataSource.md b/azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsAzureActivityLogDataSource.md deleted file mode 100644 index a8a21e20d7..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsAzureActivityLogDataSource.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: B4EC9132-8DB9-498D-8B3F-2AB51D8EA03A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/new-azurermoperationalinsightsazureactivitylogdatasource -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsAzureActivityLogDataSource.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsAzureActivityLogDataSource.md ---- - -# New-AzureRmOperationalInsightsAzureActivityLogDataSource - -## SYNOPSIS -Collect Azure Activity log from given subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByWorkspaceName (Default) -``` -New-AzureRmOperationalInsightsAzureActivityLogDataSource [-ResourceGroupName] <String> - [-WorkspaceName] <String> [-Name] <String> [-SubscriptionId] <String> [-BackfillStartTime <DateTimeOffset>] - [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByWorkspaceObject -``` -New-AzureRmOperationalInsightsAzureActivityLogDataSource [-Workspace] <PSWorkspace> [-Name] <String> - [-SubscriptionId] <String> [-BackfillStartTime <DateTimeOffset>] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmOperationalInsightsAzureActivityLogDataSource enable Log Analytics to collect Azure activity log from given subscription. - -## EXAMPLES - -### Example 1 -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -BackfillStartTime -You can choose to backfill logs from a week ago. - -```yaml -Type: System.DateTimeOffset -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubscriptionId -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Workspace -```yaml -Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameter Sets: ByWorkspaceObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WorkspaceName -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameters: Workspace (ByValue) - -### System.String - -### System.DateTimeOffset - -## OUTPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsComputerGroup.md b/azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsComputerGroup.md deleted file mode 100644 index a27595af1c..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsComputerGroup.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: E68E90B3-0B6A-49E9-83CD-E73826571B04 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/new-azurermoperationalinsightscomputergroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsComputerGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsComputerGroup.md ---- - -# New-AzureRmOperationalInsightsComputerGroup - -## SYNOPSIS -Creates a computer group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmOperationalInsightsComputerGroup [-ResourceGroupName] <String> [-WorkspaceName] <String> - [-SavedSearchId] <String> [-DisplayName] <String> [-Category] <String> [-Query] <String> [[-Version] <Int64>] - [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmOperationalInsightsComputerGroup** cmdlet creates a computer group in a resource group and location. - -## EXAMPLES - -## PARAMETERS - -### -Category -Specifies the category of the computer group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the display name of the computer group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Query -Specifies the query of the computer group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -The cmdlet creates computer group in this resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SavedSearchId -Specifies the ID of the computer group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Version -Specifies the version. - -```yaml -Type: System.Int64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WorkspaceName -Specifies the name of the workspace. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Int64 - -## OUTPUTS - -### System.Net.HttpStatusCode - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsCustomLogDataSource.md b/azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsCustomLogDataSource.md deleted file mode 100644 index 86a5d5a86d..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsCustomLogDataSource.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: 6A08AF7C-1E18-40A1-B21E-12F94823D304 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/new-azurermoperationalinsightscustomlogdatasource -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsCustomLogDataSource.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsCustomLogDataSource.md ---- - -# New-AzureRmOperationalInsightsCustomLogDataSource - -## SYNOPSIS -Defines a custom log collection policy. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByWorkspaceName (Default) -``` -New-AzureRmOperationalInsightsCustomLogDataSource [-ResourceGroupName] <String> [-WorkspaceName] <String> - [-Name] <String> [-CustomLogRawJson] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ByWorkspaceObject -``` -New-AzureRmOperationalInsightsCustomLogDataSource [-Workspace] <PSWorkspace> [-Name] <String> - [-CustomLogRawJson] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmOperationalInsightsCustomLogDataSource** cmdlet defines a custom log collection policy. - -## EXAMPLES - -## PARAMETERS - -### -CustomLogRawJson -Specifies the custom collection policy as a raw JavaScript Object Notation (JSON) string. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the data source. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group that contains computers. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Workspace -Specifies a workspace in which this cmdlet operates. - -```yaml -Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameter Sets: ByWorkspaceObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WorkspaceName -Specifies the name of a workspace in which this cmdlet operates. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameters: Workspace (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource - -## NOTES - -## RELATED LINKS - -[Disable-AzureRmOperationalInsightsLinuxCustomLogCollection](./Disable-AzureRmOperationalInsightsLinuxCustomLogCollection.md) - -[Enable-AzureRmOperationalInsightsLinuxCustomLogCollection](./Enable-AzureRmOperationalInsightsLinuxCustomLogCollection.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsLinuxPerformanceObjectDataSource.md b/azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsLinuxPerformanceObjectDataSource.md deleted file mode 100644 index c09fdfb73e..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsLinuxPerformanceObjectDataSource.md +++ /dev/null @@ -1,249 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: F94F3FA8-08FD-4B25-B634-8E2EEBDDE36E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/new-azurermoperationalinsightslinuxperformanceobjectdatasource -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsLinuxPerformanceObjectDataSource.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsLinuxPerformanceObjectDataSource.md ---- - -# New-AzureRmOperationalInsightsLinuxPerformanceObjectDataSource - -## SYNOPSIS -Adds performance counters to all Linux computers in a workspace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByWorkspaceName (Default) -``` -New-AzureRmOperationalInsightsLinuxPerformanceObjectDataSource [-ResourceGroupName] <String> - [-WorkspaceName] <String> [-Name] <String> [-ObjectName] <String> [-CounterNames] <String[]> - [-InstanceName <String>] [-IntervalSeconds <Int32>] [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByWorkspaceObject -``` -New-AzureRmOperationalInsightsLinuxPerformanceObjectDataSource [-Workspace] <PSWorkspace> [-Name] <String> - [-ObjectName] <String> [-CounterNames] <String[]> [-InstanceName <String>] [-IntervalSeconds <Int32>] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmOperationalInsightsLinuxPerformanceObjectDataSource** cmdlet adds performance counters from which Azure Operational Insights collects data to all Linux computers in a workspace. - -## EXAMPLES - -## PARAMETERS - -### -CounterNames -Specifies an array of names of counters. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceName -Specifies an instance name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IntervalSeconds -Specifies the interval of collection. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the data source. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ObjectName -Specifies the name of an object. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group that contains Linux computers. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Workspace -Specifies a workspace in which this cmdlet operates. - -```yaml -Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameter Sets: ByWorkspaceObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WorkspaceName -Specifies the name of a workspace in which this cmdlet operates. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameters: Workspace (ByValue) - -### System.String - -### System.String[] - -### System.Int32 - -## OUTPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource - -## NOTES - -## RELATED LINKS - -[Disable-AzureRmOperationalInsightsLinuxPerformanceCollection](./Disable-AzureRmOperationalInsightsLinuxPerformanceCollection.md) - -[Enable-AzureRmOperationalInsightsLinuxPerformanceCollection](./Enable-AzureRmOperationalInsightsLinuxPerformanceCollection.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsLinuxSyslogDataSource.md b/azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsLinuxSyslogDataSource.md deleted file mode 100644 index 2d087dcabc..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsLinuxSyslogDataSource.md +++ /dev/null @@ -1,322 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: D6CBDF09-E243-425B-8677-256163A6DFBF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/new-azurermoperationalinsightslinuxsyslogdatasource -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsLinuxSyslogDataSource.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsLinuxSyslogDataSource.md ---- - -# New-AzureRmOperationalInsightsLinuxSyslogDataSource - -## SYNOPSIS -Adds a data source to Linux computers. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByWorkspaceName (Default) -``` -New-AzureRmOperationalInsightsLinuxSyslogDataSource [-ResourceGroupName] <String> [-WorkspaceName] <String> - [-Name] <String> [-Facility] <String> [-CollectEmergency] [-CollectAlert] [-CollectCritical] [-CollectError] - [-CollectWarning] [-CollectNotice] [-CollectDebug] [-CollectInformational] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByWorkspaceObject -``` -New-AzureRmOperationalInsightsLinuxSyslogDataSource [-Workspace] <PSWorkspace> [-Name] <String> - [-Facility] <String> [-CollectEmergency] [-CollectAlert] [-CollectCritical] [-CollectError] [-CollectWarning] - [-CollectNotice] [-CollectDebug] [-CollectInformational] [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmOperationalInsightsLinuxSyslogDataSource** cmdlet adds a syslog data source to connected Linux computers in a workspace. -Azure Operational Insights can collect syslog data. - -## EXAMPLES - -## PARAMETERS - -### -CollectAlert -Indicates that Operational Insights collects alert messages. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CollectCritical -Indicates that Operational Insights collects critical messages. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CollectDebug -Indicates that Operational Insights collects debug messages. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CollectEmergency -Indicates that Operational Insights collects emergency messages. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CollectError -Indicates that Operational Insights collects error messages. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CollectInformational -Indicates that Operational Insights collects informational messages. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CollectNotice -Indicates that Operational Insights collects notice messages. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CollectWarning -Indicates that the syslog includes warning messages. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Facility -Specifies a facility code. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the data source. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group that contains Linux computers. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Workspace -Specifies a workspace in which this cmdlet operates. - -```yaml -Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameter Sets: ByWorkspaceObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WorkspaceName -Specifies the name of a workspace in which this cmdlet operates. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameters: Workspace (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource - -## NOTES - -## RELATED LINKS - -[Disable-AzureRmOperationalInsightsLinuxSyslogCollection](./Disable-AzureRmOperationalInsightsLinuxSyslogCollection.md) - -[Enable-AzureRmOperationalInsightsLinuxSyslogCollection](./Enable-AzureRmOperationalInsightsLinuxSyslogCollection.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsSavedSearch.md b/azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsSavedSearch.md deleted file mode 100644 index 42f3165d8b..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsSavedSearch.md +++ /dev/null @@ -1,243 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: DFEB9EA3-574A-463B-8B70-46D76ABCA84D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/new-azurermoperationalinsightssavedsearch -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsSavedSearch.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsSavedSearch.md ---- - -# New-AzureRmOperationalInsightsSavedSearch - -## SYNOPSIS -Creates a new saved search with the specified parameters. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmOperationalInsightsSavedSearch [-ResourceGroupName] <String> [-WorkspaceName] <String> - [-SavedSearchId] <String> [-DisplayName] <String> [-Category] <String> [-Query] <String> [[-Tag] <Hashtable>] - [[-Version] <Int64>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmOperationalInsightsSavedSearch** cmdlet creates a new saved search with the specified parameters for the workspace. - -## EXAMPLES - -### Example 1: Create a new saved search -``` -PS C:\>New-AzureRmOperationalInsightSavedSearch -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace" -SavedSearchId "ContosoSavedSearchId" -DisplayName "ContosoSavedSearchDisplayName" -Category "ContosoSavedSearchCategory" -Query "*" -Version $Version -Force -``` - -This command creates a new saved search. - -## PARAMETERS - -### -Category -Specifies the category name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the saved search display name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Query -Specifies the query name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SavedSearchId -Specifies the saved search ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -The saved search tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Version -Specifies the version. - -```yaml -Type: System.Int64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WorkspaceName -Specifies the workspace name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -### System.Int64 - -## OUTPUTS - -### System.Net.HttpStatusCode - -## NOTES - -## RELATED LINKS - -[Azure Operational Insights Cmdlets](./AzureRM.OperationalInsights.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsStorageInsight.md b/azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsStorageInsight.md deleted file mode 100644 index 798349efa6..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsStorageInsight.md +++ /dev/null @@ -1,280 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: 7660F1A2-604D-4488-93F1-CB7C502F135E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/new-azurermoperationalinsightsstorageinsight -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsStorageInsight.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsStorageInsight.md ---- - -# New-AzureRmOperationalInsightsStorageInsight - -## SYNOPSIS -Creates a Storage Insight inside a workspace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByWorkspaceName (Default) -``` -New-AzureRmOperationalInsightsStorageInsight [-ResourceGroupName] <String> [-WorkspaceName] <String> - [-Name] <String> [-StorageAccountResourceId] <String> [-StorageAccountKey] <String> [[-Tables] <String[]>] - [[-Containers] <String[]>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByWorkspaceObject -``` -New-AzureRmOperationalInsightsStorageInsight [-Workspace] <PSWorkspace> [-Name] <String> - [-StorageAccountResourceId] <String> [-StorageAccountKey] <String> [[-Tables] <String[]>] - [[-Containers] <String[]>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmOperationalInsightsStorageInsight** cmdlet creates a new Storage Insight in an existing workspace. - -## EXAMPLES - -### Example 1: Create a Storage Insight by name -``` -PS C:\>$Storage = Get-AzureRmStorageAccount -ResourceGroupName "ContosoResourceGroup" -Name "ContosoStorage" - -PS C:\>$StorageKey = ($Storage | Get-AzureRmStorageAccountKey).Key1 - -PS C:\>New-AzureRmOperationalInsightsStorageInsight -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "MyWorkspace" -Name "MyStorageInsight" -StorageAccountResourceId $Storage.Id -StorageAccountKey $StorageKey -Tables @("WADWindowsEventLogsTable") -``` - -The first command uses the Get-AzureRmStorageAccount cmdlet to get the storage account named ContosoStorage, and then stores it in the $Storage variable. -The second command passes the storage account in $Storage to the Get-AzureRmStorageAccountKey cmdlet by using the pipeline operator to get the specified storage account key, and then stores it in the $StorageKey variable. -The final command creates a storage insight named MyStorageInsight in the workspace named MyWorkspace. -This storage insight consumes data from the WADWindowsEventLogsTable table in the specified storage account resource. - -### Example 2: Create a Storage Insight by using a workspace object -``` -PS C:\>$Workspace = Get-AzureRmOperationalInsightsWorkspace -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" - -PS C:\>$Storage = Get-AzureRmStorageAccount -ResourceGroupName "ContosoResourceGroup" -Name "ContosoStorage" - -PS C:\>$StorageKey = ($Storage | Get-AzureRmStorageAccountKey).Key1 - -PS C:\>New-AzureRmOperationalInsightsStorageInsight -Workspace $Workspace -Name "MyStorageInsight" -StorageAccountResourceId $Storage.Id -StorageAccountKey $StorageKey -Tables @("WADWindowsEventLogsTable") -``` - -The first command uses the Get-AzureRmOperationalInsightsWorkspace cmdlet to get the workspace named MyWorkspace, and then stores it in the $Workspace variable. -The second command uses the Get-AzureRmStorageAccount cmdlet to get the specified storage account, and then stores it in the $Storage variable. -The third command passes the storage account in $Storage to the Get-AzureRmStorageAccountKey cmdlet by using the pipeline operator to get the specified key, and then stores it in the $StorageKey variable. -The final command creates a storage insight named MyStorageInsight in the workspace defined in $Workspace. -The Storage Insight consumes data from the WADWindowsEventLogsTable table in the specified storage account resource. - -## PARAMETERS - -### -Containers -Specifies the list of containers that contain the data. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Storage Insight. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group that contains a workspace. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountKey -Specifies the access key for the storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountResourceId -Specifies the Azure resource of a storage account. -This can be retrieved by executing the Get-AzureRmStorageAccount cmdlet and accessing the *Id* parameter of the result. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tables -Specifies the list of tables that provide the data. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Workspace -Specifies the workspace for the new Storage Insight. - -```yaml -Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameter Sets: ByWorkspaceObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WorkspaceName -Specifies the name of an existing workspace. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameters: Workspace (ByValue) - -### System.String - -### System.String[] - -## OUTPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSStorageInsight - -## NOTES - -## RELATED LINKS - -[Azure Operational Insights Cmdlets](./AzureRM.OperationalInsights.md) - -[Get-AzureRmOperationalInsightsWorkspace](./Get-AzureRmOperationalInsightsWorkspace.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsWindowsEventDataSource.md b/azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsWindowsEventDataSource.md deleted file mode 100644 index 5fe0c75440..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsWindowsEventDataSource.md +++ /dev/null @@ -1,238 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: 36B3B1AC-6E7F-4607-A024-91583D952B62 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/new-azurermoperationalinsightswindowseventdatasource -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsWindowsEventDataSource.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsWindowsEventDataSource.md ---- - -# New-AzureRmOperationalInsightsWindowsEventDataSource - -## SYNOPSIS -Collects event logs from computers that run the Windows operating system. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByWorkspaceName (Default) -``` -New-AzureRmOperationalInsightsWindowsEventDataSource [-ResourceGroupName] <String> [-WorkspaceName] <String> - [-Name] <String> [-EventLogName] <String> [-CollectErrors] [-CollectWarnings] [-CollectInformation] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByWorkspaceObject -``` -New-AzureRmOperationalInsightsWindowsEventDataSource [-Workspace] <PSWorkspace> [-Name] <String> - [-EventLogName] <String> [-CollectErrors] [-CollectWarnings] [-CollectInformation] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmOperationalInsightsWindowsEventDataSource** cmdlet adds a data source that collects Windows event logs from connected computers that run the Windows operating system in Azure Operational Insights. - -## EXAMPLES - -## PARAMETERS - -### -CollectErrors -Indicates that Operational Insights collects error messages. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CollectInformation -Indicates that Operational Insights collects information messages. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CollectWarnings -Indicates that Operational Insights collects warning messages. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventLogName -Specifies the name of the event log. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the data source. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group that contains computers. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Workspace -Specifies a workspace in which this cmdlet operates. - -```yaml -Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameter Sets: ByWorkspaceObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WorkspaceName -Specifies the name of a workspace in which this cmdlet operates. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameters: Workspace (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsWindowsPerformanceCounterDataSource.md b/azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsWindowsPerformanceCounterDataSource.md deleted file mode 100644 index b6283ceba1..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsWindowsPerformanceCounterDataSource.md +++ /dev/null @@ -1,257 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: 09CC097E-0210-4443-BCDB-5CF6C8300288 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/new-azurermoperationalinsightswindowsperformancecounterdatasource -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsWindowsPerformanceCounterDataSource.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsWindowsPerformanceCounterDataSource.md ---- - -# New-AzureRmOperationalInsightsWindowsPerformanceCounterDataSource - -## SYNOPSIS -Adds Windows performance counter data source for connected computers that run the Windows operating system. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByWorkspaceName (Default) -``` -New-AzureRmOperationalInsightsWindowsPerformanceCounterDataSource [-ResourceGroupName] <String> - [-WorkspaceName] <String> [-Name] <String> [-ObjectName] <String> [-CounterName] <String> - [-InstanceName <String>] [-IntervalSeconds <Int32>] [-UseLegacyCollector] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByWorkspaceObject -``` -New-AzureRmOperationalInsightsWindowsPerformanceCounterDataSource [-Workspace] <PSWorkspace> [-Name] <String> - [-ObjectName] <String> [-CounterName] <String> [-InstanceName <String>] [-IntervalSeconds <Int32>] - [-UseLegacyCollector] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmOperationalInsightsWindowsPerformanceCounterDataSource** cmdlet adds a Windows performance counter data source for connected computers that run the Windows operating system. - -## EXAMPLES - -## PARAMETERS - -### -CounterName -Specifies the name of a counter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceName -Specifies an instance name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IntervalSeconds -Specifies the interval of collection. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the data source. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ObjectName -Specifies the name of an object. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group that contains computers. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UseLegacyCollector -Use legacy collector or the default collector. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Workspace -Specifies a workspace in which this cmdlet operates. - -```yaml -Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameter Sets: ByWorkspaceObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WorkspaceName -Specifies the name of a workspace in which this cmdlet operates. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameters: Workspace (ByValue) - -### System.String - -### System.Int32 - -## OUTPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsWorkspace.md b/azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsWorkspace.md deleted file mode 100644 index 1b124a3b97..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/New-AzureRmOperationalInsightsWorkspace.md +++ /dev/null @@ -1,249 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: 4682807D-34E8-4057-8894-36820447067B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/new-azurermoperationalinsightsworkspace -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsWorkspace.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsWorkspace.md ---- - -# New-AzureRmOperationalInsightsWorkspace - -## SYNOPSIS -Creates a workspace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmOperationalInsightsWorkspace [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> - [[-Sku] <String>] [[-CustomerId] <Guid>] [[-Tag] <Hashtable>] [[-RetentionInDays] <Int32>] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmOperationalInsightsWorkspace** cmdlet creates a workspace in the specified resource group and location. - -## EXAMPLES - -### Example 1: Create a workspace by name -``` -PS C:\>New-AzureRmOperationalInsightsWorkspace -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" -Location "East US" -Sku "Standard" -``` - -This command creates a standard SKU workspace named MyWorkspace in the resource group named ContosoResourceGroup. - -### Example 2: Create a workspace and link it to an existing account -``` -PS C:\>$OILinkTargets = Get-AzureRmOperationalInsightsLinkTargets - -PS C:\>$OILinkTargets[0] | New-AzureRmOperationalInsightsWorkspace -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" -Sku "Standard" -``` - -The first command uses the Get-AzureRmOperationalInsightsLinkTargets cmdlet to get Operational Insights account link targets, and then stores them in the $OILinkTargets variable. -The second command passes the first account link target in $OILinkTargets to the **New-AzureRmOperationalInsightsWorkspace** cmdlet by using the pipeline operator. -The command creates a standard SKU workspace named MyWorkspace that is linked to the first Operational Insights account in $OILinkTargets. - -## PARAMETERS - -### -CustomerId -Specifies the account to which this workspace will be linked. -The Get-AzureRmOperationalInsightsLinkTargets cmdlet can also be used to list the potential accounts. - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location in which to create the workspace, for example, East US or West Europe. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the workspace. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. -The workspace is created in this resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RetentionInDays -The workspace data retention in days. 730 days is the maximum allowed for all other Skus - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -Specifies the service tier of the workspace. -Valid values are: -- free -- standard -- premium - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: free, standard, premium, pernode, standalone - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -The resource tags for the workspace. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Collections.Hashtable - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace - -## NOTES - -## RELATED LINKS - -[Azure Operational Insights Cmdlets](./AzureRM.OperationalInsights.md) - -[Get-AzureRmOperationalInsightsLinkTargets](./Get-AzureRmOperationalInsightsLinkTargets.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/Remove-AzureRmOperationalInsightsDataSource.md b/azurermps-6.13.0/AzureRM.OperationalInsights/Remove-AzureRmOperationalInsightsDataSource.md deleted file mode 100644 index 2a1da81027..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/Remove-AzureRmOperationalInsightsDataSource.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: 5C1C51FE-747F-4176-84ED-A28AA3475581 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/remove-azurermoperationalinsightsdatasource -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Remove-AzureRmOperationalInsightsDataSource.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Remove-AzureRmOperationalInsightsDataSource.md ---- - -# Remove-AzureRmOperationalInsightsDataSource - -## SYNOPSIS -Deletes a data source. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByWorkspaceName (Default) -``` -Remove-AzureRmOperationalInsightsDataSource [-ResourceGroupName] <String> [-WorkspaceName] <String> - [-Name] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByWorkspaceObject -``` -Remove-AzureRmOperationalInsightsDataSource [-Workspace] <PSWorkspace> [-Name] <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmOperationalInsightsDataSource** cmdlet deletes a data source. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a data source to delete. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group that contains computers. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Workspace -Specifies a workspace in which this cmdlet operates. - -```yaml -Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameter Sets: ByWorkspaceObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WorkspaceName -Specifies the name of a workspace in which this cmdlet operates. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameters: Workspace (ByValue) - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, operational, insights - -## RELATED LINKS - -[Get-AzureRmOperationalInsightsDataSource](./Get-AzureRmOperationalInsightsDataSource.md) - -[Set-AzureRmOperationalInsightsDataSource](./Set-AzureRmOperationalInsightsDataSource.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/Remove-AzureRmOperationalInsightsSavedSearch.md b/azurermps-6.13.0/AzureRM.OperationalInsights/Remove-AzureRmOperationalInsightsSavedSearch.md deleted file mode 100644 index f6a03b1015..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/Remove-AzureRmOperationalInsightsSavedSearch.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: D4A40E83-2969-40A2-AED0-A6073142CAF1 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/remove-azurermoperationalinsightssavedsearch -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Remove-AzureRmOperationalInsightsSavedSearch.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Remove-AzureRmOperationalInsightsSavedSearch.md ---- - -# Remove-AzureRmOperationalInsightsSavedSearch - -## SYNOPSIS -Removes a saved search from the workspace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmOperationalInsightsSavedSearch [-ResourceGroupName] <String> [-WorkspaceName] <String> - [-SavedSearchId] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmOperationalInsightsSavedSearch** cmdlet removes a saved search from the workspace. - -## EXAMPLES - -### Example 1: Remove a saved search -``` -PS C:\>Remove-AzureRmOperationalInsightsSavedSearch -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace" -SavedSearchId "ContosoSavedSearchId" -Force -``` - -This command removes a saved search from the workspace. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the workspace name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SavedSearchId -Specifies the saved search ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WorkspaceName -Specifies the workspace name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Azure Operational Insights Cmdlets](./AzureRM.OperationalInsights.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/Remove-AzureRmOperationalInsightsStorageInsight.md b/azurermps-6.13.0/AzureRM.OperationalInsights/Remove-AzureRmOperationalInsightsStorageInsight.md deleted file mode 100644 index f9379be3ba..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/Remove-AzureRmOperationalInsightsStorageInsight.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: 92261663-CF50-4EBD-85D2-C2E254F39B41 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/remove-azurermoperationalinsightsstorageinsight -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Remove-AzureRmOperationalInsightsStorageInsight.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Remove-AzureRmOperationalInsightsStorageInsight.md ---- - -# Remove-AzureRmOperationalInsightsStorageInsight - -## SYNOPSIS -Removes a Storage Insight. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByWorkspaceName (Default) -``` -Remove-AzureRmOperationalInsightsStorageInsight [-ResourceGroupName] <String> [-WorkspaceName] <String> - [-Name] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByWorkspaceObject -``` -Remove-AzureRmOperationalInsightsStorageInsight [-Workspace] <PSWorkspace> [-Name] <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmOperationalInsightsStorageInsight** cmdlet deletes a Storage Insight from a workspace. - -## EXAMPLES - -### Example 1: Remove a Storage Insight by name -``` -PS C:\>Remove-AzureRmOperationalInsightsStorageInsight -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "MyWorkspace" -Name "MyStorageInsight" -``` - -This command removes the Storage Insight named MyStorageInsight from the workspace named MyWorkspace in the specified resource group. -The command does not specify the *Force* parameter, so it prompts you for confirmation before removing the Storage Insight. - -### Example 2: Remove a Storage Insight without confirmation -``` -PS C:\>$Workspace = Get-AzureRmOperationalInsightsWorkspace -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" - -PS C:\>Remove-AzureRmOperationalInsightsStorageInsight -Workspace $Workspace -Name "MyStorageInsight" -Force -``` - -The first command uses the Get-AzureRmOperationalInsightsWorkspace cmdlet to get the workspace named MyWorkspace, and then stores it in the $Workspace variable.The second command removes the storage insight named MyStorageInsight from $Workspace without prompting you for confirmation. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Storage Insight. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Workspace -Specifies the workspace that contains the Storage Insight. - -```yaml -Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameter Sets: ByWorkspaceObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WorkspaceName -Specifies the name of the workspace that contains the Storage Insight. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameters: Workspace (ByValue) - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Azure Operational Insights Cmdlets](./AzureRM.OperationalInsights.md) - -[Get-AzureRmOperationalInsightsWorkspace](./Get-AzureRmOperationalInsightsWorkspace.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/Remove-AzureRmOperationalInsightsWorkspace.md b/azurermps-6.13.0/AzureRM.OperationalInsights/Remove-AzureRmOperationalInsightsWorkspace.md deleted file mode 100644 index b7985c2e7e..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/Remove-AzureRmOperationalInsightsWorkspace.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: 0C35E679-B991-49A8-890F-C8DAB68A8240 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/remove-azurermoperationalinsightsworkspace -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Remove-AzureRmOperationalInsightsWorkspace.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Remove-AzureRmOperationalInsightsWorkspace.md ---- - -# Remove-AzureRmOperationalInsightsWorkspace - -## SYNOPSIS -Removes a workspace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmOperationalInsightsWorkspace [-ResourceGroupName] <String> [-Name] <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmOperationalInsightsWorkspace** cmdlet deletes an existing workspace. -If this workspace was linked to an existing account via the *CustomerId* parameter at creation time the original account is not deleted in the Operational Insights portal. - -## EXAMPLES - -### Example 1: Remove a workspace by name -``` -PS C:\>Remove-AzureRmOperationalInsightsWorkspace -ResourceGroupName "ContosResourceGroup" -Name "MyWorkspace" -``` - -This command removes the workspace named MyWorkspace from the resource group named ContosoResourceGroup. - -### Example 2: Remove a workspace by using the pipeline and without confirmation -``` -PS C:\>Get-AzureRmOperationalInsightsWorkspace -ResourceGroupName "ContosResourceGroup" -Name "MyWorkspace" | Remove-AzureRmOperationalInsightsWorkspace -Force -``` - -This command uses the Get-AzureRmOperationalInsightsWorkspace cmdlet to get the workspace named MyWorkspace, and then passes it to the **Remove-AzureRmOperationalInsightsWorkspace** cmdlet by using the pipeline operator to remove it. -Since the *Force* parameter is specified, the command does not prompt you before removing the workspace. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the workspace. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Azure Operational Insights Cmdlets](./AzureRM.OperationalInsights.md) - -[Get-AzureRmOperationalInsightsWorkspace](./Get-AzureRmOperationalInsightsWorkspace.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/Set-AzureRmOperationalInsightsDataSource.md b/azurermps-6.13.0/AzureRM.OperationalInsights/Set-AzureRmOperationalInsightsDataSource.md deleted file mode 100644 index 50c3015e2a..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/Set-AzureRmOperationalInsightsDataSource.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: 3992E6B5-F794-4C7A-BB59-C8D60E2CD7BC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/set-azurermoperationalinsightsdatasource -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Set-AzureRmOperationalInsightsDataSource.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Set-AzureRmOperationalInsightsDataSource.md ---- - -# Set-AzureRmOperationalInsightsDataSource - -## SYNOPSIS -Updates a data source. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmOperationalInsightsDataSource [-DataSource] <PSDataSource> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmOperationalInsightsDataSource** cmdlet updates a data source. - -## EXAMPLES - -## PARAMETERS - -### -DataSource -Specifies the data source that this cmdlet updates. - -```yaml -Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource -Parameters: DataSource (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSDataSource - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, operational, insights - -## RELATED LINKS - -[Get-AzureRmOperationalInsightsDataSource](./Get-AzureRmOperationalInsightsDataSource.md) - -[Remove-AzureRmOperationalInsightsDataSource](./Remove-AzureRmOperationalInsightsDataSource.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/Set-AzureRmOperationalInsightsIntelligencePack.md b/azurermps-6.13.0/AzureRM.OperationalInsights/Set-AzureRmOperationalInsightsIntelligencePack.md deleted file mode 100644 index ca295140ca..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/Set-AzureRmOperationalInsightsIntelligencePack.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: 23ED4D24-66BD-46E9-BB57-6E0DA679B733 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/set-azurermoperationalinsightsintelligencepack -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Set-AzureRmOperationalInsightsIntelligencePack.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Set-AzureRmOperationalInsightsIntelligencePack.md ---- - -# Set-AzureRmOperationalInsightsIntelligencePack - -## SYNOPSIS -Enables or disables the specified Intelligence Pack. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmOperationalInsightsIntelligencePack [-ResourceGroupName] <String> [-WorkspaceName] <String> - [-IntelligencePackName] <String> [-Enabled] <Boolean> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmOperationalInsightsIntelligencePack** cmdlet enables the specified Intelligence Pack if *Enabled* is set to $True and disables it if *Enabled* is set to $False. - -## EXAMPLES - -### Example 1: Set Intelligence Packs -``` -PS C:\>Set-AzureOperationalInsightsIntelligencePack -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace" -IntelligencePackName "ContosoWorkspace" -Enabled $True -``` - -This command enables the specified Intelligence Pack. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IntelligencePackName -Specifies the Intelligence Pack name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WorkspaceName -Specifies the name of the workspace. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Boolean - -## OUTPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSIntelligencePack - -## NOTES - -## RELATED LINKS - -[Azure Operational Insights Cmdlets](./AzureRM.OperationalInsights.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/Set-AzureRmOperationalInsightsSavedSearch.md b/azurermps-6.13.0/AzureRM.OperationalInsights/Set-AzureRmOperationalInsightsSavedSearch.md deleted file mode 100644 index 6326fdc1d8..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/Set-AzureRmOperationalInsightsSavedSearch.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: A333A60D-CA76-4E4E-9C8B-72AAEF464F0A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/set-azurermoperationalinsightssavedsearch -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Set-AzureRmOperationalInsightsSavedSearch.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Set-AzureRmOperationalInsightsSavedSearch.md ---- - -# Set-AzureRmOperationalInsightsSavedSearch - -## SYNOPSIS -Updates a saved search that already exists. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmOperationalInsightsSavedSearch [-ResourceGroupName] <String> [-WorkspaceName] <String> - [-SavedSearchId] <String> [-DisplayName] <String> [-Category] <String> [-Query] <String> [[-Tag] <Hashtable>] - [[-Version] <Int64>] [[-ETag] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmOperationalInsightsSavedSearch** cmdlet updates a saved search that already exists. - -## EXAMPLES - -### Example 1: Sets a saved search with updated properties -``` -PS C:\>Set-AzureRmOperationalInsightsSavedSearch -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace" -SavedSearchId "ContosoSavedSearchId" -DisplayName "ContosoSavedSearchDisplayName" -Category "ContosoSavedSearchCategory" -Query "Type=Event" -Version $Version -ETag "ContosoSavedSearchEtag" -``` - -This command sets a saved search with updated properties. - -## PARAMETERS - -### -Category -Specifies the category name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the display name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ETag -Specifies the ETag name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Query -Specifies the query name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SavedSearchId -Specifies the saved search ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -The saved search tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Version -```yaml -Type: System.Int64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WorkspaceName -Specifies the workspace name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -### System.Int64 - -## OUTPUTS - -### System.Net.HttpStatusCode - -## NOTES - -## RELATED LINKS - -[Azure Operational Insights Cmdlets](./AzureRM.OperationalInsights.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/Set-AzureRmOperationalInsightsStorageInsight.md b/azurermps-6.13.0/AzureRM.OperationalInsights/Set-AzureRmOperationalInsightsStorageInsight.md deleted file mode 100644 index 1b58a47098..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/Set-AzureRmOperationalInsightsStorageInsight.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: 010328F9-C878-4F16-AFD7-2135465A1968 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/set-azurermoperationalinsightsstorageinsight -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Set-AzureRmOperationalInsightsStorageInsight.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Set-AzureRmOperationalInsightsStorageInsight.md ---- - -# Set-AzureRmOperationalInsightsStorageInsight - -## SYNOPSIS -Updates a Storage Insight. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByWorkspaceName (Default) -``` -Set-AzureRmOperationalInsightsStorageInsight [-ResourceGroupName] <String> [-WorkspaceName] <String> - [-Name] <String> [[-StorageAccountKey] <String>] [[-Tables] <String[]>] [[-Containers] <String[]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByWorkspaceObject -``` -Set-AzureRmOperationalInsightsStorageInsight [-Workspace] <PSWorkspace> [-Name] <String> - [[-StorageAccountKey] <String>] [[-Tables] <String[]>] [[-Containers] <String[]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmOperationalInsightsStorageInsight** cmdlet changes the configuration of a Storage Insight. - -## EXAMPLES - -### Example 1: Modify a Storage Insight by name -``` -PS C:\>Set-AzureRmOperationalInsightsStorageInsight -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "MyWorkspace" -Name "MyStorageInsight" -Tables @("WADWindowsEventLogsTable") -``` - -This command modifies the tables from which the Storage Insight named MyStorageInsight reads. - -### Example 2: Modify a Storage Insight by using a workspace object -``` -PS C:\>$Workspace = Get-AzureRmOperationalInsightsWorkspace -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" - -PS C:\>Set-AzureRmOperationalInsightsStorageInsight -Workspace $Workspace -Name "MyStorageInsight" -Containers @("wad-iis-logfiles") -``` - -The first command uses the Get-AzureRmOperationalInsightsWorkspace cmdlet to get the workspace named MyWorkspace, and then stores it in the $Workspace variable. -The second command modifies the containers from which the Storage Insight named MyStorageInsight reads. - -## PARAMETERS - -### -Containers -Specifies the list of containers that provide the data. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a Storage Insight. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an Azure resource group that contains a workspace. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountKey -Specifies the access key for the storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tables -Specifies the list of tables that contain the data. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Workspace -Specifies the workspace that contains the Storage Insight. - -```yaml -Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameter Sets: ByWorkspaceObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WorkspaceName -Specifies the name of a workspace. - -```yaml -Type: System.String -Parameter Sets: ByWorkspaceName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameters: Workspace (ByValue) - -### System.String - -### System.String[] - -## OUTPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSStorageInsight - -## NOTES - -## RELATED LINKS - -[Azure Operational Insights Cmdlets](./AzureRM.OperationalInsights.md) - -[Get-AzureRmOperationalInsightsWorkspace](./Get-AzureRmOperationalInsightsWorkspace.md) - - diff --git a/azurermps-6.13.0/AzureRM.OperationalInsights/Set-AzureRmOperationalInsightsWorkspace.md b/azurermps-6.13.0/AzureRM.OperationalInsights/Set-AzureRmOperationalInsightsWorkspace.md deleted file mode 100644 index 364ec5b101..0000000000 --- a/azurermps-6.13.0/AzureRM.OperationalInsights/Set-AzureRmOperationalInsightsWorkspace.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml -Module Name: AzureRM.OperationalInsights -ms.assetid: 54DFBB63-AE8C-4918-870F-19FAD6CC5E4A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.operationalinsights/set-azurermoperationalinsightsworkspace -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Set-AzureRmOperationalInsightsWorkspace.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Set-AzureRmOperationalInsightsWorkspace.md ---- - -# Set-AzureRmOperationalInsightsWorkspace - -## SYNOPSIS -Updates a workspace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByName (Default) -``` -Set-AzureRmOperationalInsightsWorkspace [-ResourceGroupName] <String> [-Name] <String> [[-Sku] <String>] - [[-Tag] <Hashtable>] [-RetentionInDays <Int32>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByObject -``` -Set-AzureRmOperationalInsightsWorkspace [-Workspace] <PSWorkspace> [[-Sku] <String>] [[-Tag] <Hashtable>] - [-RetentionInDays <Int32>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmOperationalInsightsWorkspace** cmdlet changes the configuration of a workspace. - -## EXAMPLES - -### Example 1: Modify a workspace by name -``` -PS C:\>Set-AzureRmOperationalInsightsWorkspace -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" -Sku Standard -Tags @{ "Department" = "IT" } -``` - -This command modifies the SKU and tags of the workspace named MyWorkspace in the resource group named ContosoResourceGroup. - -### Example 2: Update a workspace by using the pipeline -``` -PS C:\>Get-AzureRmOperationalInsightsWorkspace -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" | Set-AzureRmOperationalInsightsWorkspace -Sku "Premium" -``` - -This command uses the Get-AzureRmOperationalInsightsWorkspace cmdlet to get the workspace named MyWorkSpace, and then passes it to the **Set-AzureRmOperationalInsightsWorkspace** cmdlet by using the pipeline operator to set the SKU to Premium. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the workspace name. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the Azure resource group name. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RetentionInDays -The workspace data retention in days. 730 days is the maximum allowed for all other Skus - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -Specifies the service tier of the workspace. -Valid values are: -- free -- standard -- premium - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: free, standard, premium, pernode, standalone - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -The resource tags for the workspace. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Workspace -Specifies the workspace to be updated. - -```yaml -Type: Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameter Sets: ByObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace -Parameters: Workspace (ByValue) - -### System.String - -### System.Collections.Hashtable - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace - -## NOTES - -## RELATED LINKS - -[Azure Operational Insights Cmdlets](./AzureRM.OperationalInsights.md) - -[Get-AzureRmOperationalInsightsWorkspace](./Get-AzureRmOperationalInsightsWorkspace.md) - - diff --git a/azurermps-6.13.0/AzureRM.PolicyInsights/AzureRM.PolicyInsights.md b/azurermps-6.13.0/AzureRM.PolicyInsights/AzureRM.PolicyInsights.md deleted file mode 100644 index f80daba82d..0000000000 --- a/azurermps-6.13.0/AzureRM.PolicyInsights/AzureRM.PolicyInsights.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -Module Name: AzureRM.PolicyInsights -Module Guid: B1876B47-3652-4265-9AD5-782EC3E98319 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.policyinsights -Help Version: 1.1.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PolicyInsights/Commands.PolicyInsights/help/AzureRM.PolicyInsights.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PolicyInsights/Commands.PolicyInsights/help/AzureRM.PolicyInsights.md ---- - -# AzureRM.PolicyInsights Module -## Description -This topic displays help for the Azure Policy Insights cmdlets. - -## AzureRM.PolicyInsights Cmdlets -### [Get-AzureRmPolicyEvent](Get-AzureRmPolicyEvent.md) -Gets policy evaluation events generated as resources are created or updated. - -### [Get-AzureRmPolicyRemediation](Get-AzureRmPolicyRemediation.md) -Gets policy remediations. - -### [Get-AzureRmPolicyState](Get-AzureRmPolicyState.md) -Gets policy compliance states for resources. - -### [Get-AzureRmPolicyStateSummary](Get-AzureRmPolicyStateSummary.md) -Gets latest policy compliance states summary for resources. - -### [Remove-AzureRmPolicyRemediation](Remove-AzureRmPolicyRemediation.md) -Deletes a policy remediation. - -### [Start-AzureRmPolicyRemediation](Start-AzureRmPolicyRemediation.md) -Creates and starts a policy remediation for a policy assignment. - -### [Stop-AzureRmPolicyRemediation](Stop-AzureRmPolicyRemediation.md) -Cancels an in-progress policy remediation. - diff --git a/azurermps-6.13.0/AzureRM.PolicyInsights/Get-AzureRmPolicyEvent.md b/azurermps-6.13.0/AzureRM.PolicyInsights/Get-AzureRmPolicyEvent.md deleted file mode 100644 index a72a8bd5dc..0000000000 --- a/azurermps-6.13.0/AzureRM.PolicyInsights/Get-AzureRmPolicyEvent.md +++ /dev/null @@ -1,480 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.PolicyInsights.dll-Help.xml -Module Name: AzureRM.PolicyInsights -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.policyinsights/get-azurermpolicyevent -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PolicyInsights/Commands.PolicyInsights/help/Get-AzureRmPolicyEvent.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PolicyInsights/Commands.PolicyInsights/help/Get-AzureRmPolicyEvent.md ---- - -# Get-AzureRmPolicyEvent - -## SYNOPSIS -Gets policy evaluation events generated as resources are created or updated. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SubscriptionScope (Default) -``` -Get-AzureRmPolicyEvent [-SubscriptionId <String>] [-Top <Int32>] [-OrderBy <String>] [-Select <String>] - [-From <DateTime>] [-To <DateTime>] [-Filter <String>] [-Apply <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ManagementGroupScope -``` -Get-AzureRmPolicyEvent -ManagementGroupName <String> [-Top <Int32>] [-OrderBy <String>] [-Select <String>] - [-From <DateTime>] [-To <DateTime>] [-Filter <String>] [-Apply <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceGroupScope -``` -Get-AzureRmPolicyEvent [-SubscriptionId <String>] -ResourceGroupName <String> [-Top <Int32>] - [-OrderBy <String>] [-Select <String>] [-From <DateTime>] [-To <DateTime>] [-Filter <String>] - [-Apply <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### PolicySetDefinitionScope -``` -Get-AzureRmPolicyEvent [-SubscriptionId <String>] -PolicySetDefinitionName <String> [-Top <Int32>] - [-OrderBy <String>] [-Select <String>] [-From <DateTime>] [-To <DateTime>] [-Filter <String>] - [-Apply <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### PolicyDefinitionScope -``` -Get-AzureRmPolicyEvent [-SubscriptionId <String>] -PolicyDefinitionName <String> [-Top <Int32>] - [-OrderBy <String>] [-Select <String>] [-From <DateTime>] [-To <DateTime>] [-Filter <String>] - [-Apply <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SubscriptionLevelPolicyAssignmentScope -``` -Get-AzureRmPolicyEvent [-SubscriptionId <String>] -PolicyAssignmentName <String> [-Top <Int32>] - [-OrderBy <String>] [-Select <String>] [-From <DateTime>] [-To <DateTime>] [-Filter <String>] - [-Apply <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceGroupLevelPolicyAssignmentScope -``` -Get-AzureRmPolicyEvent [-SubscriptionId <String>] -ResourceGroupName <String> -PolicyAssignmentName <String> - [-Top <Int32>] [-OrderBy <String>] [-Select <String>] [-From <DateTime>] [-To <DateTime>] [-Filter <String>] - [-Apply <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceScope -``` -Get-AzureRmPolicyEvent -ResourceId <String> [-Top <Int32>] [-OrderBy <String>] [-Select <String>] - [-From <DateTime>] [-To <DateTime>] [-Filter <String>] [-Apply <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Gets policy evaluation events generated as resources are created or updated. Policy event records can be queried at various scopes based on the time interval specified (defaults to last day). Results can be filtered, grouped, and group aggregations can be computed. - -## EXAMPLES - -### Example 1: Get policy events in current subscription scope -```powershell -PS C:\> Get-AzureRmPolicyEvent -``` - -Gets policy event records generated in the last day for all resources within the subscription in current session context. - -### Example 2: Get policy events in the specified subscription scope -```powershell -PS C:\> Get-AzureRmPolicyEvent -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" -``` - -Gets policy event records generated in the last day for all resources within the specified subscription. - -### Example 3: Get policy events in management group scope -```powershell -PS C:\> Get-AzureRmPolicyEvent -ManagementGroupName "myManagementGroup" -``` - -Gets policy event records generated in the last day for all resources within the specified management group. - -### Example 4: Get policy events in resource group scope in current subscription -```powershell -PS C:\> Get-AzureRmPolicyEvent -ResourceGroupName "myResourceGroup" -``` - -Gets policy event records generated in the last day for all resources within the specified resource group (in the subscription in current session context). - -### Example 5: Get policy events in resource group scope in the specified subscription -```powershell -PS C:\> Get-AzureRmPolicyEvent -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" -ResourceGroupName "myResourceGroup" -``` - -Gets policy event records generated in the last day for all resources within the specified resource group (in the specified subscription). - -### Example 6: Get policy events for a resource -```powershell -PS C:\> Get-AzureRmPolicyEvent -ResourceId "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myns1/eventhubs/eh1/consumergroups/cg1" -``` - -Gets policy event records generated in the last day for the specified resource. - -### Example 7: Get policy events for a policy set definition in current subscription -```powershell -PS C:\> Get-AzureRmPolicyEvent -PolicySetDefinitionName "fff58873-fff8-fff5-fffc-fffbe7c9d697" -``` - -Gets policy event records generated in the last day for all resources (within the tenant in current session context) effected by the specified policy set definition (that exists in the subscription in current session context). - -### Example 8: Get policy events for a policy set definition in the specified subscription -```powershell -PS C:\> Get-AzureRmPolicyEvent -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" -PolicySetDefinitionName "fff58873-fff8-fff5-fffc-fffbe7c9d697" -``` - -Gets policy event records generated in the last day for all resources (within the tenant in current session context) effected by the specified policy set definition (that exists in the specified subscription). - -### Example 9: Get policy events for a policy definition in current subscription -```powershell -PS C:\> Get-AzureRmPolicyEvent -PolicyDefinitionName "fff58873-fff8-fff5-fffc-fffbe7c9d697" -``` - -Gets policy event records generated in the last day for all resources (within the tenant in current session context) effected by the specified policy definition (that exists in the subscription in current session context). - -### Example 10: Get policy events for a policy definition in the specified subscription -```powershell -PS C:\> Get-AzureRmPolicyEvent -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" -PolicyDefinitionName "fff58873-fff8-fff5-fffc-fffbe7c9d697" -``` - -Gets policy event records generated in the last day for all resources (within the tenant in current session context) effected by the specified policy definition (that exists in the specified subscription). - -### Example 11: Get policy events for a policy assignment in current subscription -```powershell -PS C:\> Get-AzureRmPolicyEvent -PolicyAssignmentName "ddd8ef92e3714a5ea3d208c1" -``` - -Gets policy event records generated in the last day for all resources (within the tenant in current session context) effected by the specified policy assignment (that exists in the subscription in current session context). - -### Example 12: Get policy events for a policy assignment in the specified subscription -```powershell -PS C:\> Get-AzureRmPolicyEvent -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" -PolicyAssignmentName "ddd8ef92e3714a5ea3d208c1" -``` - -Gets policy event records generated in the last day for all resources (within the tenant in current session context) effected by the specified policy assignment (that exists in the specified subscription). - -### Example 13: Get policy events for a policy assignment in the specified resource group in the current subscription -```powershell -PS C:\> Get-AzureRmPolicyEvent -ResourceGroupName "myResourceGroup" -PolicyAssignmentName "ddd8ef92e3714a5ea3d208c1" -``` - -Gets policy event records generated in the last day for all resources (within the tenant in current session context) effected by the specified policy assignment (that exists in the resource group in the subscription in current session context). - -### Example 14: Get policy events in current subscription scope, with OrderBy, Top and Select query options -```powershell -PS C:\> Get-AzureRmPolicyEvent -OrderBy "Timestamp desc, PolicyAssignmentName asc" -Top 5 -Select "Timestamp, ResourceId, PolicyAssignmentId, PolicySetDefinitionId, PolicyDefinitionId" -``` - -Gets policy event records generated in the last day for all resources within the subscription in current session context. -The command orders the results by timestamp and policy assignment name properties, and takes only top 5 of those listed in that order. -It also selects to list only a subset of the columns for each record. - -### Example 15: Get policy events in current subscription scope, with From and To query options -```powershell -PS C:\> Get-AzureRmPolicyEvent -From "2018-03-08 00:00:00Z" -To "2018-03-15 00:00:00Z" -``` - -Gets policy event records generated within the date range specified for all resources within the subscription in current session context. - -### Example 16: Get policy events in current subscription scope, with Filter query option -```powershell -PS C:\> Get-AzureRmPolicyEvent -Filter "(PolicyDefinitionAction eq 'deny' or PolicyDefinitionAction eq 'audit') and ResourceLocation ne 'eastus'" -``` - -Gets policy event records generated in the last day for all resources within the subscription in current session context. -The command limits the results returned by filtering based on policy definition action (includes deny or audit actions) and resource location (excludes eastus location). - -### Example 17: Get policy events in current subscription scope, with Apply specifying row count aggregation -```powershell -PS C:\> Get-AzureRmPolicyEvent -Apply "aggregate(`$count as NumberOfRecords)" -``` - -Gets the number of policy event records generated in the last day for all resources within the subscription in current session context. -The command returns the count of the policy event records only, which is returned inside AdditionalProperties property. - -### Example 18: Get policy events in current subscription scope, with Apply specifying grouping with aggregation -```powershell -PS C:\> Get-AzureRmPolicyEvent -Filter "PolicyDefinitionAction eq 'audit' or PolicyDefinitionAction eq 'deny'" -Apply "groupby((PolicyAssignmentId, PolicyDefinitionId, PolicyDefinitionAction, ResourceId), aggregate(`$count as NumEvents))" -OrderBy "NumEvents desc" -Top 5 -``` - -Gets policy event records generated in the last day for all resources within the subscription in current session context. -The command limits the results returned by filtering based on policy definition action (includes only audit and deny events). -It groups the results based on policy assignment, policy definition, policy definition action, and resource id, and computes the number of records in each group, which is returned inside AdditionalProperties property. -It orders the results by the count aggregation in descending order, and takes only top 5 of those listed in that order. - -### Example 19: Get policy events in current subscription scope, with Apply specifying grouping without aggregation -```powershell -PS C:\> Get-AzureRmPolicyEvent -Filter "PolicyDefinitionAction eq 'audit' or PolicyDefinitionAction eq 'deny'" -Apply "groupby((ResourceId))" -``` - -Gets policy event records generated in the last day for all resources within the subscription in current session context. -The command limits the results returned by filtering based on policy definition action (includes only audit and deny events). -It groups the results based on resource id. -This generates the list of all resources within the subscription that generated a policy event for at least one audit or deny policy. - -### Example 20: Get policy events in current subscription scope, with Apply specifying multiple groupings -```powershell -PS C:\> Get-AzureRmPolicyEvent -Filter "PolicyDefinitionAction eq 'deny'" -Apply "groupby((PolicyAssignmentId, PolicyDefinitionId, ResourceId))/groupby((PolicyAssignmentId, PolicyDefinitionId), aggregate(`$count as NumDeniedResources))" -OrderBy "NumDeniedResources desc" -Top 5 -``` - -Gets policy event records generated in the last day for all resources within the subscription in current session context. -The command limits the results returned by filtering based on policy definition action (includes only deny events). -It groups the results first based on policy assignment, policy definition, and resource id. -Then, it further groups the results of this grouping with the same properties except for resource id, and computes the number of records in each of these groups, which is returned inside AdditionalProperties property. -It orders the results by the count aggregation in descending order, and takes only top 5 of those listed in that order. -This generates the top 5 deny policies with the most number of denied resources. - -## PARAMETERS - -### -Apply -Apply expression for aggregations using OData notation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Filter expression using OData notation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -From -ISO 8601 formatted timestamp specifying the start time of the interval to query. -When not specified, defaults to 'To' parameter value minus 1 day. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagementGroupName -Management group name. - -```yaml -Type: System.String -Parameter Sets: ManagementGroupScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OrderBy -Ordering expression using OData notation. -One or more comma-separated column names with an optional 'desc' (the default) or 'asc'. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyAssignmentName -Policy assignment name. - -```yaml -Type: System.String -Parameter Sets: SubscriptionLevelPolicyAssignmentScope, ResourceGroupLevelPolicyAssignmentScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PolicyDefinitionName -Policy definition name. - -```yaml -Type: System.String -Parameter Sets: PolicyDefinitionScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PolicySetDefinitionName -Policy set definition name. - -```yaml -Type: System.String -Parameter Sets: PolicySetDefinitionScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource group name. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupScope, ResourceGroupLevelPolicyAssignmentScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID. - -```yaml -Type: System.String -Parameter Sets: ResourceScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Select -Select expression using OData notation. -One or more comma-separated column names. -Limits the columns on each record to just those requested. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Subscription ID. - -```yaml -Type: System.String -Parameter Sets: SubscriptionScope, ResourceGroupScope, PolicySetDefinitionScope, PolicyDefinitionScope, SubscriptionLevelPolicyAssignmentScope, ResourceGroupLevelPolicyAssignmentScope -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -To -ISO 8601 formatted timestamp specifying the end time of the interval to query. -When not specified, defaults to time of request. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Top -Maximum number of records to return. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.PolicyInsights.Models.PolicyEvent - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.PolicyInsights/Get-AzureRmPolicyRemediation.md b/azurermps-6.13.0/AzureRM.PolicyInsights/Get-AzureRmPolicyRemediation.md deleted file mode 100644 index 5fc227e61f..0000000000 --- a/azurermps-6.13.0/AzureRM.PolicyInsights/Get-AzureRmPolicyRemediation.md +++ /dev/null @@ -1,269 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.PolicyInsights.dll-Help.xml -Module Name: AzureRM.PolicyInsights -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.policyinsights/get-azurermpolicyremediation -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PolicyInsights/Commands.PolicyInsights/help/Get-AzureRmPolicyRemediation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PolicyInsights/Commands.PolicyInsights/help/Get-AzureRmPolicyRemediation.md ---- - -# Get-AzureRmPolicyRemediation - -## SYNOPSIS -Gets policy remediations. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SubscriptionScope (Default) -``` -Get-AzureRmPolicyRemediation [-Top <Int32>] [-Filter <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByName -``` -Get-AzureRmPolicyRemediation -Name <String> [-Scope <String>] [-ManagementGroupName <String>] - [-ResourceGroupName <String>] [-Top <Int32>] [-IncludeDetail] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### GenericScope -``` -Get-AzureRmPolicyRemediation -Scope <String> [-Top <Int32>] [-Filter <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ManagementGroupScope -``` -Get-AzureRmPolicyRemediation -ManagementGroupName <String> [-Top <Int32>] [-Filter <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceGroupScope -``` -Get-AzureRmPolicyRemediation -ResourceGroupName <String> [-Top <Int32>] [-Filter <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByResourceId -``` -Get-AzureRmPolicyRemediation -ResourceId <String> [-Top <Int32>] [-IncludeDetail] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmPolicyRemediation** cmdlet gets all policy remediations in a scope or a particular remediation. - -## EXAMPLES - -### Example 1: Get all policy remediations in the current subscription -``` -PS C:\> Select-AzureRmSubscription -Subscription "My Subscription" -PS C:\> Get-AzureRmPolicyRemediation -``` - -This command gets all the remediations created at or underneath a subscription named 'My Subscription'. - -### Example 2: Get a specific policy remediation and the deployment details -``` -PS C:\> Get-AzureRmPolicyRemediation -ResourceGroupName "myResourceGroup" -Name "remediation1" -IncludeDetail -``` - -This command gets the remediation named 'remediation1' from resource group 'myResourceGroup'. The details of the resources being remediated will be included. - -### Example 3: Get 10 policy remediations in a management group with optional filters -``` -PS C:\> Get-AzureRmPolicyRemediation -ManagementGroupName "mg1" -Top 10 -Filter "PolicyAssignmentId eq '/providers/Microsoft.Management/managementGroups/mg1/providers/Microsoft.Authorization/policyAssignments/pa1'" -``` - -This command gets a max of 10 policy remediations from a management group named 'mg1'. Only policy remediations for the given policy assignment will be retrieved. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Filter expression using OData notation. - -```yaml -Type: System.String -Parameter Sets: SubscriptionScope, GenericScope, ManagementGroupScope, ResourceGroupScope -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDetail -Include details of the deployments created by the remediation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByName, ByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagementGroupName -Management group ID. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ManagementGroupScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Resource name. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource group name. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ResourceGroupScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Scope -Scope of the resource. For example, '/subscriptions/{subscriptionId}/resourceGroups/{rgName}'. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: GenericScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Top -Maximum number of records to return. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.PolicyInsights.Models.Remediation.PSRemediation - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.PolicyInsights/Get-AzureRmPolicyState.md b/azurermps-6.13.0/AzureRM.PolicyInsights/Get-AzureRmPolicyState.md deleted file mode 100644 index c4a75559f8..0000000000 --- a/azurermps-6.13.0/AzureRM.PolicyInsights/Get-AzureRmPolicyState.md +++ /dev/null @@ -1,505 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.PolicyInsights.dll-Help.xml -Module Name: AzureRM.PolicyInsights -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.policyinsights/get-azurermpolicystate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PolicyInsights/Commands.PolicyInsights/help/Get-AzureRmPolicyState.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PolicyInsights/Commands.PolicyInsights/help/Get-AzureRmPolicyState.md ---- - -# Get-AzureRmPolicyState - -## SYNOPSIS -Gets policy compliance states for resources. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SubscriptionScope (Default) -``` -Get-AzureRmPolicyState [-All] [-SubscriptionId <String>] [-Top <Int32>] [-OrderBy <String>] [-Select <String>] - [-From <DateTime>] [-To <DateTime>] [-Filter <String>] [-Apply <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ManagementGroupScope -``` -Get-AzureRmPolicyState [-All] -ManagementGroupName <String> [-Top <Int32>] [-OrderBy <String>] - [-Select <String>] [-From <DateTime>] [-To <DateTime>] [-Filter <String>] [-Apply <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceGroupScope -``` -Get-AzureRmPolicyState [-All] [-SubscriptionId <String>] -ResourceGroupName <String> [-Top <Int32>] - [-OrderBy <String>] [-Select <String>] [-From <DateTime>] [-To <DateTime>] [-Filter <String>] - [-Apply <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceScope -``` -Get-AzureRmPolicyState [-All] -ResourceId <String> [-Top <Int32>] [-OrderBy <String>] [-Select <String>] - [-From <DateTime>] [-To <DateTime>] [-Filter <String>] [-Apply <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### PolicySetDefinitionScope -``` -Get-AzureRmPolicyState [-All] [-SubscriptionId <String>] -PolicySetDefinitionName <String> [-Top <Int32>] - [-OrderBy <String>] [-Select <String>] [-From <DateTime>] [-To <DateTime>] [-Filter <String>] - [-Apply <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### PolicyDefinitionScope -``` -Get-AzureRmPolicyState [-All] [-SubscriptionId <String>] -PolicyDefinitionName <String> [-Top <Int32>] - [-OrderBy <String>] [-Select <String>] [-From <DateTime>] [-To <DateTime>] [-Filter <String>] - [-Apply <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SubscriptionLevelPolicyAssignmentScope -``` -Get-AzureRmPolicyState [-All] [-SubscriptionId <String>] -PolicyAssignmentName <String> [-Top <Int32>] - [-OrderBy <String>] [-Select <String>] [-From <DateTime>] [-To <DateTime>] [-Filter <String>] - [-Apply <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceGroupLevelPolicyAssignmentScope -``` -Get-AzureRmPolicyState [-All] [-SubscriptionId <String>] -ResourceGroupName <String> - -PolicyAssignmentName <String> [-Top <Int32>] [-OrderBy <String>] [-Select <String>] [-From <DateTime>] - [-To <DateTime>] [-Filter <String>] [-Apply <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -Gets policy compliance states for resources. Policy state records can be queried at various scopes. Based on the time interval specified (defaults to last day), either latest policy states or all policy state transitions can be queried. Results can be filtered, grouped, and group aggregations can be computed. - -## EXAMPLES - -### Example 1: Get latest policy states in current subscription scope -```powershell -PS C:\> Get-AzureRmPolicyState -``` - -Gets latest policy state records generated in the last day for all resources within the subscription in current session context. - -### Example 2: Get latest policy states in the specified subscription scope -```powershell -PS C:\> Get-AzureRmPolicyState -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" -``` - -Gets latest policy state records generated in the last day for all resources within the specified subscription. - -### Example 3: Get all policy states in current subscription scope -```powershell -PS C:\> Get-AzureRmPolicyState -All -``` - -Gets all historical policy state records (including latest) generated in the last day for all resources within the subscription in current session context. - -### Example 4: Get latest policy states in management group scope -```powershell -PS C:\> Get-AzureRmPolicyState -ManagementGroupName "myManagementGroup" -``` - -Gets latest policy state records generated in the last day for all resources within the specified management group. - -### Example 5: Get latest policy states in resource group scope in current subscription -```powershell -PS C:\> Get-AzureRmPolicyState -ResourceGroupName "myResourceGroup" -``` - -Gets latest policy state records generated in the last day for all resources within the specified resource group (in the subscription in current session context). - -### Example 6: Get latest policy states in resource group scope in the specified subscription -```powershell -PS C:\> Get-AzureRmPolicyState -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" -ResourceGroupName "myResourceGroup" -``` - -Gets latest policy state records generated in the last day for all resources within the specified resource group (in the specified subscription). - -### Example 7: Get latest policy states for a resource -```powershell -PS C:\> Get-AzureRmPolicyState -ResourceId "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myns1/eventhubs/eh1/consumergroups/cg1" -``` - -Gets latest policy state records generated in the last day for the specified resource. - -### Example 8: Get latest policy states for a policy set definition in current subscription -```powershell -PS C:\> Get-AzureRmPolicyState -PolicySetDefinitionName "fff58873-fff8-fff5-fffc-fffbe7c9d697" -``` - -Gets latest policy state records generated in the last day for all resources (within the tenant in current session context) effected by the specified policy set definition (that exists in the subscription in current session context). - -### Example 9: Get latest policy states for a policy set definition in the specified subscription -```powershell -PS C:\> Get-AzureRmPolicyState -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" -PolicySetDefinitionName "fff58873-fff8-fff5-fffc-fffbe7c9d697" -``` - -Gets latest policy state records generated in the last day for all resources (within the tenant in current session context) effected by the specified policy set definition (that exists in the specified subscription). - -### Example 10: Get latest policy states for a policy definition in current subscription -```powershell -PS C:\> Get-AzureRmPolicyState -PolicyDefinitionName "fff58873-fff8-fff5-fffc-fffbe7c9d697" -``` - -Gets latest policy state records generated in the last day for all resources (within the tenant in current session context) effected by the specified policy definition (that exists in the subscription in current session context). - -### Example 11: Get latest policy states for a policy definition in the specified subscription -```powershell -PS C:\> Get-AzureRmPolicyState -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" -PolicyDefinitionName "fff58873-fff8-fff5-fffc-fffbe7c9d697" -``` - -Gets latest policy state records generated in the last day for all resources (within the tenant in current session context) effected by the specified policy definition (that exists in the specified subscription). - -### Example 12: Get latest policy states for a policy assignment in current subscription -```powershell -PS C:\> Get-AzureRmPolicyState -PolicyAssignmentName "ddd8ef92e3714a5ea3d208c1" -``` - -Gets latest policy state records generated in the last day for all resources (within the tenant in current session context) effected by the specified policy assignment (that exists in the subscription in current session context). - -### Example 13: Get latest policy states for a policy assignment in the specified subscription -```powershell -PS C:\> Get-AzureRmPolicyState -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" -PolicyAssignmentName "ddd8ef92e3714a5ea3d208c1" -``` - -Gets latest policy state records generated in the last day for all resources (within the tenant in current session context) effected by the specified policy assignment (that exists in the specified subscription). - -### Example 14: Get latest policy states for a policy assignment in the specified resource group in the current subscription -```powershell -PS C:\> Get-AzureRmPolicyState -ResourceGroupName "myResourceGroup" -PolicyAssignmentName "ddd8ef92e3714a5ea3d208c1" -``` - -Gets latest policy state records generated in the last day for all resources (within the tenant in current session context) effected by the specified policy assignment (that exists in the resource group in the subscription in current session context). - -### Example 15: Get latest policy states in current subscription scope, with OrderBy, Top and Select query options -```powershell -PS C:\> Get-AzureRmPolicyState -OrderBy "Timestamp desc, PolicyAssignmentName asc" -Top 5 -Select "Timestamp, ResourceId, PolicyAssignmentId, PolicySetDefinitionId, PolicyDefinitionId, IsCompliant" -``` - -Gets latest policy state records generated in the last day for all resources within the subscription in current session context. -The command orders the results by timestamp and policy assignment name properties, and takes only top 5 of those listed in that order. -It also selects to list only a subset of the columns for each record. - -### Example 16: Get latest policy states in current subscription scope, with From and To query options -```powershell -PS C:\> Get-AzureRmPolicyState -From "2018-03-08 00:00:00Z" -To "2018-03-15 00:00:00Z" -``` - -Gets latest policy state records generated within the date range specified for all resources within the subscription in current session context. - -### Example 17: Get latest policy states in current subscription scope, with Filter query option -```powershell -PS C:\> Get-AzureRmPolicyState -Filter "(PolicyDefinitionAction eq 'deny' or PolicyDefinitionAction eq 'audit') and IsCompliant eq false and ResourceLocation ne 'eastus'" -``` - -Gets latest policy state records generated in the last day for all resources within the subscription in current session context. -The command limits the results returned by filtering based on policy definition action (includes deny or audit actions), compliance status (includes only non-compliant status) and resource location (excludes eastus location). - -### Example 18: Get latest policy states in current subscription scope, with Apply specifying row count aggregation -```powershell -PS C:\> Get-AzureRmPolicyState -Apply "aggregate(`$count as NumberOfRecords)" -``` - -Gets the number of latest policy state records generated in the last day for all resources within the subscription in current session context. -The command returns the count of the policy state records only, which is returned inside AdditionalProperties property. - -### Example 19: Get latest policy states in current subscription scope, with Apply specifying grouping with aggregation -```powershell -PS C:\> Get-AzureRmPolicyState -Filter "IsCompliant eq false" -Apply "groupby((PolicyAssignmentId, PolicySetDefinitionId, PolicyDefinitionReferenceId, PolicyDefinitionId), aggregate(`$count as NumStates))" -OrderBy "NumStates desc" -Top 5 -``` - -Gets latest policy state records generated in the last day for all resources within the subscription in current session context. -The command limits the results returned by filtering based on compliance status (includes only non-compliant status). -It groups the results based on policy assignment, policy set definition, and policy definition, and computes the number of records in each group, which is returned inside AdditionalProperties property. -It orders the results by the count aggregation in descending order, and takes only top 5 of those listed in that order. - -### Example 20: Get latest policy states in current subscription scope, with Apply specifying grouping without aggregation -```powershell -PS C:\> Get-AzureRmPolicyState -Filter "IsCompliant eq false" -Apply "groupby((ResourceId))" -``` - -Gets latest policy state records generated in the last day for all resources within the subscription in current session context. -The command limits the results returned by filtering based on compliance status (includes only non-compliant status). -It groups the results based on resource id. -This generates the list of all resources within the subscription that are non-compliant for at least one policy. - -### Example 21: Get latest policy states in current subscription scope, with Apply specifying multiple groupings -```powershell -PS C:\> Get-AzureRmPolicyState -Filter "IsCompliant eq false" -Apply "groupby((PolicyAssignmentId, PolicySetDefinitionId, PolicyDefinitionReferenceId, PolicyDefinitionId, ResourceId))/groupby((PolicyAssignmentId, PolicySetDefinitionId, PolicyDefinitionReferenceId, PolicyDefinitionId), aggregate(`$count as NumNonCompliantResources))" -OrderBy "NumNonCompliantResources desc" -Top 5 -``` - -Gets latest policy state records generated in the last day for all resources within the subscription in current session context. -The command limits the results returned by filtering based on compliance status (includes only non-compliant status). -It groups the results first based on policy assignment, policy set definition, policy definition, and resource id. -Then, it further groups the results of this grouping with the same properties except for resource id, and computes the number of records in each of these groups, which is returned inside AdditionalProperties property. -It orders the results by the count aggregation in descending order, and takes only top 5 of those listed in that order. -This generates the top 5 policies with the most number of non-compliant resources. - -## PARAMETERS - -### -All -Within the specified time interval, get all policy states instead of the latest only. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Apply -Apply expression for aggregations using OData notation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Filter expression using OData notation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -From -ISO 8601 formatted timestamp specifying the start time of the interval to query. -When not specified, defaults to 'To' parameter value minus 1 day. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagementGroupName -Management group name. - -```yaml -Type: System.String -Parameter Sets: ManagementGroupScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OrderBy -Ordering expression using OData notation. -One or more comma-separated column names with an optional 'desc' (the default) or 'asc'. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyAssignmentName -Policy assignment name. - -```yaml -Type: System.String -Parameter Sets: SubscriptionLevelPolicyAssignmentScope, ResourceGroupLevelPolicyAssignmentScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PolicyDefinitionName -Policy definition name. - -```yaml -Type: System.String -Parameter Sets: PolicyDefinitionScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PolicySetDefinitionName -Policy set definition name. - -```yaml -Type: System.String -Parameter Sets: PolicySetDefinitionScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource group name. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupScope, ResourceGroupLevelPolicyAssignmentScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID. - -```yaml -Type: System.String -Parameter Sets: ResourceScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Select -Select expression using OData notation. -One or more comma-separated column names. -Limits the columns on each record to just those requested. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Subscription ID. - -```yaml -Type: System.String -Parameter Sets: SubscriptionScope, ResourceGroupScope, PolicySetDefinitionScope, PolicyDefinitionScope, SubscriptionLevelPolicyAssignmentScope, ResourceGroupLevelPolicyAssignmentScope -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -To -ISO 8601 formatted timestamp specifying the end time of the interval to query. -When not specified, defaults to time of request. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Top -Maximum number of records to return. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.PolicyInsights.Models.PolicyState - -## NOTES - -## RELATED LINKS - -[Get-AzureRmPolicyStateSummary](./Get-AzureRmPolicyStateSummary.md) diff --git a/azurermps-6.13.0/AzureRM.PolicyInsights/Get-AzureRmPolicyStateSummary.md b/azurermps-6.13.0/AzureRM.PolicyInsights/Get-AzureRmPolicyStateSummary.md deleted file mode 100644 index 9c4b887c55..0000000000 --- a/azurermps-6.13.0/AzureRM.PolicyInsights/Get-AzureRmPolicyStateSummary.md +++ /dev/null @@ -1,390 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.PolicyInsights.dll-Help.xml -Module Name: AzureRM.PolicyInsights -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.policyinsights/get-azurermpolicystatesummary -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PolicyInsights/Commands.PolicyInsights/help/Get-AzureRmPolicyStateSummary.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PolicyInsights/Commands.PolicyInsights/help/Get-AzureRmPolicyStateSummary.md ---- - -# Get-AzureRmPolicyStateSummary - -## SYNOPSIS -Gets latest policy compliance states summary for resources. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SubscriptionScope (Default) -``` -Get-AzureRmPolicyStateSummary [-SubscriptionId <String>] [-Top <Int32>] [-From <DateTime>] [-To <DateTime>] - [-Filter <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ManagementGroupScope -``` -Get-AzureRmPolicyStateSummary -ManagementGroupName <String> [-Top <Int32>] [-From <DateTime>] [-To <DateTime>] - [-Filter <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceGroupScope -``` -Get-AzureRmPolicyStateSummary [-SubscriptionId <String>] -ResourceGroupName <String> [-Top <Int32>] - [-From <DateTime>] [-To <DateTime>] [-Filter <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### PolicySetDefinitionScope -``` -Get-AzureRmPolicyStateSummary [-SubscriptionId <String>] -PolicySetDefinitionName <String> [-Top <Int32>] - [-From <DateTime>] [-To <DateTime>] [-Filter <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### PolicyDefinitionScope -``` -Get-AzureRmPolicyStateSummary [-SubscriptionId <String>] -PolicyDefinitionName <String> [-Top <Int32>] - [-From <DateTime>] [-To <DateTime>] [-Filter <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### SubscriptionLevelPolicyAssignmentScope -``` -Get-AzureRmPolicyStateSummary [-SubscriptionId <String>] -PolicyAssignmentName <String> [-Top <Int32>] - [-From <DateTime>] [-To <DateTime>] [-Filter <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ResourceGroupLevelPolicyAssignmentScope -``` -Get-AzureRmPolicyStateSummary [-SubscriptionId <String>] -ResourceGroupName <String> - -PolicyAssignmentName <String> [-Top <Int32>] [-From <DateTime>] [-To <DateTime>] [-Filter <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceScope -``` -Get-AzureRmPolicyStateSummary -ResourceId <String> [-Top <Int32>] [-From <DateTime>] [-To <DateTime>] - [-Filter <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Gets a summary view of latest policy compliance state numbers at various scopes, broken down into policy assignments and policy definitions. It includes only non-compliant policy states. - -## EXAMPLES - -### Example 1: Get latest non-compliant policy states summary in current subscription scope -```powershell -PS C:\> Get-AzureRmPolicyStateSummary -``` - -Gets the summary view of latest policy compliance states generated in the last day for all resources within the subscription in current session context. - -### Example 2: Get latest non-compliant policy states summary in the specified subscription scope -```powershell -PS C:\> Get-AzureRmPolicyStateSummary -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" -``` - -Gets the summary view of latest policy compliance states generated in the last day for all resources within the specified subscription. - -### Example 3: Get latest non-compliant policy states summary in management group scope -```powershell -PS C:\> Get-AzureRmPolicyStateSummary -ManagementGroupName "myManagementGroup" -``` - -Gets the summary view of latest policy compliance states generated in the last day for all resources within the specified management group. - -### Example 4: Get latest non-compliant policy states summary in resource group scope in current subscription -```powershell -PS C:\> Get-AzureRmPolicyStateSummary -ResourceGroupName "myResourceGroup" -``` - -Gets the summary view of latest policy compliance states generated in the last day for all resources within the specified resource group (in the subscription in current session context). - -### Example 5: Get latest non-compliant policy states summary in resource group scope in the specified subscription -```powershell -PS C:\> Get-AzureRmPolicyStateSummary -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" -ResourceGroupName "myResourceGroup" -``` - -Gets the summary view of latest policy compliance states generated in the last day for all resources within the specified resource group (in the specified subscription). - -### Example 6: Get latest non-compliant policy states summary for a resource -```powershell -PS C:\> Get-AzureRmPolicyStateSummary -ResourceId "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myns1/eventhubs/eh1/consumergroups/cg1" -``` - -Gets the summary view of latest policy compliance states generated in the last day for the specified resource. - -### Example 7: Get latest non-compliant policy states summary for a policy set definition in current subscription -```powershell -PS C:\> Get-AzureRmPolicyStateSummary -PolicySetDefinitionName "fff58873-fff8-fff5-fffc-fffbe7c9d697" -``` - -Gets the summary view of latest policy compliance states generated in the last day for all resources (within the tenant in current session context) effected by the specified policy set definition (that exists in the subscription in current session context). - -### Example 8: Get latest non-compliant policy states summary for a policy set definition in the specified subscription -```powershell -PS C:\> Get-AzureRmPolicyStateSummary -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" -PolicySetDefinitionName "fff58873-fff8-fff5-fffc-fffbe7c9d697" -``` - -Gets the summary view of latest policy compliance states generated in the last day for all resources (within the tenant in current session context) effected by the specified policy set definition (that exists in the specified subscription). - -### Example 9: Get latest non-compliant policy states summary for a policy definition in current subscription -```powershell -PS C:\> Get-AzureRmPolicyStateSummary -PolicyDefinitionName "fff58873-fff8-fff5-fffc-fffbe7c9d697" -``` - -Gets the summary view of latest policy compliance states generated in the last day for all resources (within the tenant in current session context) effected by the specified policy definition (that exists in the subscription in current session context). - -### Example 10: Get latest non-compliant policy states summary for a policy definition in the specified subscription -```powershell -PS C:\> Get-AzureRmPolicyStateSummary -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" -PolicyDefinitionName "fff58873-fff8-fff5-fffc-fffbe7c9d697" -``` - -Gets the summary view of latest policy compliance states generated in the last day for all resources (within the tenant in current session context) effected by the specified policy definition (that exists in the specified subscription). - -### Example 11: Get latest non-compliant policy states summary for a policy assignment in current subscription -```powershell -PS C:\> Get-AzureRmPolicyStateSummary -PolicyAssignmentName "ddd8ef92e3714a5ea3d208c1" -``` - -Gets the summary view of latest policy compliance states generated in the last day for all resources (within the tenant in current session context) effected by the specified policy assignment (that exists in the subscription in current session context). - -### Example 12: Get latest non-compliant policy states summary for a policy assignment in the specified subscription -```powershell -PS C:\> Get-AzureRmPolicyStateSummary -SubscriptionId "fff10b27-fff3-fff5-fff8-fffbe01e86a5" -PolicyAssignmentName "ddd8ef92e3714a5ea3d208c1" -``` - -Gets the summary view of latest policy compliance states generated in the last day for all resources (within the tenant in current session context) effected by the specified policy assignment (that exists in the specified subscription). - -### Example 13: Get latest non-compliant policy states summary for a policy assignment in the specified resource group in the current subscription -```powershell -PS C:\> Get-AzureRmPolicyStateSummary -ResourceGroupName "myResourceGroup" -PolicyAssignmentName "ddd8ef92e3714a5ea3d208c1" -``` - -Gets the summary view of latest policy compliance states generated in the last day for all resources (within the tenant in current session context) effected by the specified policy assignment (that exists in the resource group in the subscription in current session context). - -### Example 14: Get latest non-compliant policy states summary in current subscription scope, with Top query option -```powershell -PS C:\> Get-AzureRmPolicyStateSummary -Top 5 -``` - -Gets the summary view of latest policy compliance states generated in the last day for all resources within the subscription in current session context. -The command orders the policy assignment summaries in the results by non-compliant resource counts in descending order, and takes only top 5 of those policy assignment summaries. - -### Example 15: Get latest non-compliant policy states summary in current subscription scope, with From and To query options -```powershell -PS C:\> Get-AzureRmPolicyStateSummary -From "2018-03-08 00:00:00Z" -To "2018-03-15 00:00:00Z" -``` - -Gets the summary view of latest policy compliance states generated within the date range specified for all resources within the subscription in current session context. - -### Example 16: Get latest non-compliant policy states summary in current subscription scope, with Filter query option -```powershell -PS C:\> Get-AzureRmPolicyStateSummary -Filter "(PolicyDefinitionAction eq 'deny' or PolicyDefinitionAction eq 'audit') and ResourceLocation ne 'eastus'" -``` - -Gets the summary view of latest policy compliance states generated in the last day for all resources within the subscription in current session context. -The command limits the results returned by filtering based on policy definition action (includes deny or audit actions), and resource location (excludes eastus location). - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Filter expression using OData notation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -From -ISO 8601 formatted timestamp specifying the start time of the interval to query. -When not specified, defaults to 'To' parameter value minus 1 day. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagementGroupName -Management group name. - -```yaml -Type: System.String -Parameter Sets: ManagementGroupScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PolicyAssignmentName -Policy assignment name. - -```yaml -Type: System.String -Parameter Sets: SubscriptionLevelPolicyAssignmentScope, ResourceGroupLevelPolicyAssignmentScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PolicyDefinitionName -Policy definition name. - -```yaml -Type: System.String -Parameter Sets: PolicyDefinitionScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PolicySetDefinitionName -Policy set definition name. - -```yaml -Type: System.String -Parameter Sets: PolicySetDefinitionScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource group name. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupScope, ResourceGroupLevelPolicyAssignmentScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID. - -```yaml -Type: System.String -Parameter Sets: ResourceScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubscriptionId -Subscription ID. - -```yaml -Type: System.String -Parameter Sets: SubscriptionScope, ResourceGroupScope, PolicySetDefinitionScope, PolicyDefinitionScope, SubscriptionLevelPolicyAssignmentScope, ResourceGroupLevelPolicyAssignmentScope -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -To -ISO 8601 formatted timestamp specifying the end time of the interval to query. -When not specified, defaults to time of request. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Top -Maximum number of records to return. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.PolicyInsights.Models.PolicyStateSummary - -## NOTES - -## RELATED LINKS - -[Get-AzureRmPolicyState](./Get-AzureRmPolicyState.md) diff --git a/azurermps-6.13.0/AzureRM.PolicyInsights/Remove-AzureRmPolicyRemediation.md b/azurermps-6.13.0/AzureRM.PolicyInsights/Remove-AzureRmPolicyRemediation.md deleted file mode 100644 index f02b1186cf..0000000000 --- a/azurermps-6.13.0/AzureRM.PolicyInsights/Remove-AzureRmPolicyRemediation.md +++ /dev/null @@ -1,265 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.PolicyInsights.dll-Help.xml -Module Name: AzureRM.PolicyInsights -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.policyinsights/remove-azurermpolicyremediation -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PolicyInsights/Commands.PolicyInsights/help/Remove-AzureRmPolicyRemediation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PolicyInsights/Commands.PolicyInsights/help/Remove-AzureRmPolicyRemediation.md ---- - -# Remove-AzureRmPolicyRemediation - -## SYNOPSIS -Deletes a policy remediation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByName (Default) -``` -Remove-AzureRmPolicyRemediation -Name <String> [-Scope <String>] [-ManagementGroupName <String>] - [-ResourceGroupName <String>] [-AllowStop] [-AsJob] [-PassThru] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Remove-AzureRmPolicyRemediation -ResourceId <String> [-AllowStop] [-AsJob] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByInputObject -``` -Remove-AzureRmPolicyRemediation -InputObject <PSRemediation> [-AllowStop] [-AsJob] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmPolicyRemediation** cmdlet deletes a policy remediation. - -## EXAMPLES - -### Example 1: Delete a policy remediation at resource group scope -``` -PS C:\> Remove-AzureRmPolicyRemediation -ResourceGroupName "myRG" -Name "remediation1" -``` - -This command deletes the remediation named 'remediation1' in resource group 'myRG'. - -### Example 2: Delete a management group remediation via piping -``` -PS C:\> $remediation = Get-AzureRmPolicyRemediation -ManagementGroupName "mg1" -Name "remediation1" -PS C:\> $remediation | Remove-AzureRmPolicyRemediation -Confirm -``` - -This command deletes the remediation named 'remediation1' from management group 'mg1'. A confirmation prompt will be presented before deleting the resource. - -### Example 3: Cancel and delete a policy remediation -``` -PS C:\> Remove-AzureRmPolicyRemediation -ResourceGroupName "myRG" -Name "remediation1" -AllowStop -``` - -This command deletes the remediation named 'remediation1' in resource group 'myRG'. If the remediation is in-progress it will be canceled before being deleted. - -## PARAMETERS - -### -AllowStop -Allow the remediation to be canceled if it is in-progress. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The Remediation object. - -```yaml -Type: Microsoft.Azure.Commands.PolicyInsights.Models.Remediation.PSRemediation -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ManagementGroupName -Management group ID. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Resource name. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Return True if the command completes successfully. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource group name. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Scope -Scope of the resource. -E.g. -'/subscriptions/{subscriptionId}/resourceGroups/{rgName}'. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.PolicyInsights.Models.Remediation.PSRemediation - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.PolicyInsights/Start-AzureRmPolicyRemediation.md b/azurermps-6.13.0/AzureRM.PolicyInsights/Start-AzureRmPolicyRemediation.md deleted file mode 100644 index c7ec440073..0000000000 --- a/azurermps-6.13.0/AzureRM.PolicyInsights/Start-AzureRmPolicyRemediation.md +++ /dev/null @@ -1,279 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.PolicyInsights.dll-Help.xml -Module Name: AzureRM.PolicyInsights -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.policyinsights/start-azurermpolicyremediation -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PolicyInsights/Commands.PolicyInsights/help/Start-AzureRmPolicyRemediation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PolicyInsights/Commands.PolicyInsights/help/Start-AzureRmPolicyRemediation.md ---- - -# Start-AzureRmPolicyRemediation - -## SYNOPSIS -Creates and starts a policy remediation for a policy assignment. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByName (Default) -``` -Start-AzureRmPolicyRemediation -Name <String> [-Scope <String>] [-ManagementGroupName <String>] - [-ResourceGroupName <String>] -PolicyAssignmentId <String> [-PolicyDefinitionReferenceId <String>] - [-LocationFilter <String[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByResourceId -``` -Start-AzureRmPolicyRemediation -ResourceId <String> -PolicyAssignmentId <String> - [-PolicyDefinitionReferenceId <String>] [-LocationFilter <String[]>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Start-AzureRmPolicyRemediation** cmdlet creates a policy remediation for a particular policy assignment. All non-compliant resources at or below the remediation's scope will be remediated. Remediation is only supported for policies with the 'deployIfNotExists' effect. - -## EXAMPLES - -### Example 1: Start a remediation at subscription scope -``` -PS C:\> $policyAssignmentId = "/subscriptions/f0710c27-9663-4c05-19f8-1b4be01e86a5/providers/Microsoft.Authorization/policyAssignments/2deae24764b447c29af7c309" -PS C:\> Select-AzureRmSubscription -Subscription "My Subscription" -PS C:\> Start-AzureRmPolicyRemediation -PolicyAssignmentId $policyAssignmentId -Name "remediation1" -``` - -This command creates a new policy remediation in subscription 'My Subscription' for the given policy assignment. - -### Example 2: Start a remediation at management group scope with optional filters -``` -PS C:\> $policyAssignmentId = "/providers/Microsoft.Management/managementGroups/mg1/providers/Microsoft.Authorization/policyAssignments/pa1" -PS C:\> Start-AzureRmPolicyRemediation -ManagementGroupName "mg1" -PolicyAssignmentId $policyAssignmentId -Name "remediation1" -LocationFilter "westus","eastus" -``` - -This command creates a new policy remediation in management group 'mg1' for the given policy assignment. Only resources in the 'westus' or 'eastus' locations will be remediated. - -### Example 3: Start a remediation at resource group scope for a policy set definition assignment -``` -PS C:\> $policyAssignmentId = "/subscriptions/f0710c27-9663-4c05-19f8-1b4be01e86a5/resourceGroups/myRG/providers/Microsoft.Authorization/policyAssignments/2deae24764b447c29af7c309" -PS C:\> Start-AzureRmPolicyRemediation -ResourceGroupName "myRG" -PolicyAssignmentId $policyAssignmentId -PolicyDefinitionReferenceId "0349234412441" -Name "remediation1" -``` - -This command creates a new policy remediation in resource group 'myRG' for the given policy assignment. The policy assignment assigns a policy set definition (also known as an initiative). The policy definition reference ID indicates which policy within the initiative should be remediated. - -### Example 4: Start a remediation and wait for it to complete in the background -``` -PS C:\> $policyAssignmentId = "/subscriptions/f0710c27-9663-4c05-19f8-1b4be01e86a5/providers/Microsoft.Authorization/policyAssignments/2deae24764b447c29af7c309" -PS C:\> Select-AzureRmSubscription -Subscription f0710c27-9663-4c05-19f8-1b4be01e86a5 -PS C:\> $job = Start-AzureRmPolicyRemediation -PolicyAssignmentId $policyAssignmentId -Name "remediation1" -AsJob -PS C:\> $job | Wait-Job -PS C:\> $remediation = $job | Receive-Job -``` - -This command starts a new policy remediation in subscription 'My Subscription' for the given policy assignment. It will wait for the remediation to complete before returning the final remediation status. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocationFilter -The resource locations that should be included in the remediation. -Resources that don't reside in these locations will not be remediated. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ManagementGroupName -Management group ID. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Resource name. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PolicyAssignmentId -Policy assignment ID. -E.g. -'/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyAssignments/{assignmentName}'. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PolicyDefinitionReferenceId -Gets the policy definition reference ID of the individual definition that is being remediated. -Required when the policy assignment assigns a policy set definition. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource group name. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Scope -Scope of the resource. -E.g. -'/subscriptions/{subscriptionId}/resourceGroups/{rgName}'. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.String[] - -## OUTPUTS - -### Microsoft.Azure.Commands.PolicyInsights.Models.Remediation.PSRemediation - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.PolicyInsights/Stop-AzureRmPolicyRemediation.md b/azurermps-6.13.0/AzureRM.PolicyInsights/Stop-AzureRmPolicyRemediation.md deleted file mode 100644 index 0b57c81f45..0000000000 --- a/azurermps-6.13.0/AzureRM.PolicyInsights/Stop-AzureRmPolicyRemediation.md +++ /dev/null @@ -1,243 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.PolicyInsights.dll-Help.xml -Module Name: AzureRM.PolicyInsights -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.policyinsights/stop-azurermpolicyremediation -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PolicyInsights/Commands.PolicyInsights/help/Stop-AzureRmPolicyRemediation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PolicyInsights/Commands.PolicyInsights/help/Stop-AzureRmPolicyRemediation.md ---- - -# Stop-AzureRmPolicyRemediation - -## SYNOPSIS -Cancels an in-progress policy remediation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByName (Default) -``` -Stop-AzureRmPolicyRemediation -Name <String> [-Scope <String>] [-ManagementGroupName <String>] - [-ResourceGroupName <String>] [-AsJob] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Stop-AzureRmPolicyRemediation -ResourceId <String> [-AsJob] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByInputObject -``` -Stop-AzureRmPolicyRemediation -InputObject <PSRemediation> [-AsJob] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Stop-AzureRmPolicyRemediation** cmdlet cancels an in-progress policy remediation. Active deployments will be canceled and no new deployments will be created. - -## EXAMPLES - -### Example 1: Cancel a policy remediation at resource group scope -``` -PS C:\> Stop-AzureRmPolicyRemediation -ResourceGroupName "myRG" -Name "remediation1" -``` - -This command cancels the remediation named 'remediation1' in resource group 'myRG'. - -### Example 2: Cancel a management group remediation via piping -``` -PS C:\> $remediation = Get-AzureRmPolicyRemediation -ManagementGroupName "mg1" -Name "remediation1" -PS C:\> $remediation | Stop-AzureRmPolicyRemediation -``` - -This command cancels the remediation named 'remediation1' in management group 'mg1'. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The Remediation object. - -```yaml -Type: Microsoft.Azure.Commands.PolicyInsights.Models.Remediation.PSRemediation -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ManagementGroupName -Management group ID. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Resource name. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Return True if the command completes successfully. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource group name. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Scope -Scope of the resource. -E.g. -'/subscriptions/{subscriptionId}/resourceGroups/{rgName}'. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.PolicyInsights.Models.Remediation.PSRemediation - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.PowerBIEmbedded/AzureRM.PowerBIEmbedded.md b/azurermps-6.13.0/AzureRM.PowerBIEmbedded/AzureRM.PowerBIEmbedded.md deleted file mode 100644 index 37a395c15c..0000000000 --- a/azurermps-6.13.0/AzureRM.PowerBIEmbedded/AzureRM.PowerBIEmbedded.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -Module Name: AzureRM.PowerBIEmbedded -Module Guid: 868389ce-dd36-4f57-a674-0970db085d9a -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.powerbiembedded -Help Version: 4.1.4.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/AzureRM.PowerBIEmbedded.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/AzureRM.PowerBIEmbedded.md ---- - -# AzureRM.PowerBIEmbedded Module -## Description -This topic displays help topics for the Azure Power BI Embedded Cmdlets. - -## PowerBI Embedded Capacity Cmdlets -### [Get-AzureRmPowerBIEmbeddedCapacity](Get-AzureRmPowerBIEmbeddedCapacity.md) -Gets the details of a PowerBI Embedded Capacity. - -### [New-AzureRmPowerBIEmbeddedCapacity](New-AzureRmPowerBIEmbeddedCapacity.md) -Creates a new PowerBI Embedded Capacity. - -### [Remove-AzureRmPowerBIEmbeddedCapacity](Remove-AzureRmPowerBIEmbeddedCapacity.md) -Deletes an instance of PowerBI Embedded Capacity. - -### [Resume-AzureRmPowerBIEmbeddedCapacity](Resume-AzureRmPowerBIEmbeddedCapacity.md) -Resumes an instance of PowerBI Embedded Capacity. - -### [Suspend-AzureRmPowerBIEmbeddedCapacity](Suspend-AzureRmPowerBIEmbeddedCapacity.md) -Suspends an instance of PowerBI Embedded Capacity. - -### [Test-AzureRmPowerBIEmbeddedCapacity](Test-AzureRmPowerBIEmbeddedCapacity.md) -Tests the existence of an instance of PowerBI Embedded Capacity. - -### [Update-AzureRmPowerBIEmbeddedCapacity](Update-AzureRmPowerBIEmbeddedCapacity.md) -Modifies an instance of PowerBI Embedded Capacity. - - -## PowerBI Workspace Collection Cmdlets -### [Get-AzureRmPowerBIWorkspace](Get-AzureRmPowerBIWorkspace.md) -Gets the workspaces in a Power BI workspace collection. - -### [Get-AzureRmPowerBIWorkspaceCollection](Get-AzureRmPowerBIWorkspaceCollection.md) -Gets Power BI workspace collections. - -### [Get-AzureRmPowerBIWorkspaceCollectionAccessKeys](Get-AzureRmPowerBIWorkspaceCollectionAccessKeys.md) -Gets the current access keys associated with a Power BI workspace collection. - -### [New-AzureRmPowerBIWorkspaceCollection](New-AzureRmPowerBIWorkspaceCollection.md) -Creates a Power BI workspace collection. - -### [Remove-AzureRmPowerBIWorkspaceCollection](Remove-AzureRmPowerBIWorkspaceCollection.md) -Removes a Power BI workspace collection. - -### [Reset-AzureRmPowerBIWorkspaceCollectionAccessKeys](Reset-AzureRmPowerBIWorkspaceCollectionAccessKeys.md) -Resets the specified access key. - diff --git a/azurermps-6.13.0/AzureRM.PowerBIEmbedded/Get-AzureRmPowerBIEmbeddedCapacity.md b/azurermps-6.13.0/AzureRM.PowerBIEmbedded/Get-AzureRmPowerBIEmbeddedCapacity.md deleted file mode 100644 index 0c04d445fe..0000000000 --- a/azurermps-6.13.0/AzureRM.PowerBIEmbedded/Get-AzureRmPowerBIEmbeddedCapacity.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.PowerBI.dll-Help.xml -Module Name: AzureRM.PowerBIEmbedded -ms.assetid: 5321FC62-3585-4493-A3D2-22CD82503CA7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.powerbiembedded/get-azurermpowerbiembeddedcapacity -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PowerBIEmbedded/Commands.PowerBI/help/Get-AzureRmPowerBIEmbeddedCapacity.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PowerBIEmbedded/Commands.PowerBI/help/Get-AzureRmPowerBIEmbeddedCapacity.md ---- - -# Get-AzureRmPowerBIEmbeddedCapacity - -## SYNOPSIS -Gets the details of a PowerBI Embedded Capacity. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByCapacityOrResourceGroupOrSubscription (Default) -``` -Get-AzureRmPowerBIEmbeddedCapacity [-ResourceGroupName <String>] [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByResourceId -``` -Get-AzureRmPowerBIEmbeddedCapacity -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmPowerBIEmbeddedCapacity cmdlet gets the details of a PowerBI Embedded Capacity. - -## EXAMPLES - -### Example 1: Get resource group capacities -``` -PS C:\>Get-AzureRmPowerBIEmbeddedCapacity -ResourceGroupName "testRG" -Type : Microsoft.PowerBIDedicated/capacities -Id : /subscriptions/78e47976-.../resourceGroups/testRG/providers/Microsoft.PowerBIDedicated/capacities/testcapacity -ResourceGroup : testRG -Name : testcapacity -Location : West Central US -State : Succeeded -Administrator : {admin@microsoft.com} -Sku : A1 -Tier : PBIE_Azure -Tag : {} - -Type : Microsoft.PowerBIDedicated/capacities -Id : /subscriptions/78e47976-.../resourceGroups/testRG/providers/Microsoft.PowerBIDedicated/capacities/mycapacity -ResourceGroup : testRG -Name : mycapacity -Location : West Central US -State : Succeeded -Administrator : {admin@microsoft.com} -Sku : A4 -Tier : PBIE_Azure -Tag : {} -``` - -This command gets all Azure PowerBI Embedded Capacity in the resource group named testRG - -### Example 2: Get a capacity -``` -PS C:\>Get-AzureRmPowerBIEmbeddedCapacity -ResourceGroupName "testRG" -Name "testcapacity" -Type : Microsoft.PowerBIDedicated/capacities -Id : /subscriptions/78e47976-.../resourceGroups/testRG/providers/Microsoft.PowerBIDedicated/capacities/testcapacity -ResourceGroup : testRG -Name : testcapacity -Location : West Central US -State : Succeeded -Administrator : {admin@microsoft.com} -Sku : A1 -Tier : PBIE_Azure -Tag : {} -``` - -This command gets the Azure PowerBI Embedded Capacity named testcapacity in the resource group named testRG. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the PowerBI Embedded Capacity - -```yaml -Type: System.String -Parameter Sets: ByCapacityOrResourceGroupOrSubscription -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Azure resource group to which the capacity belongs - -```yaml -Type: System.String -Parameter Sets: ByCapacityOrResourceGroupOrSubscription -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Azure resource ID - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.PowerBI.Models.PSPowerBIEmbeddedCapacity - -## NOTES - -## RELATED LINKS - -[New-AzureRmPowerBIEmbeddedCapacity ](./New-AzureRmPowerBIEmbeddedCapacity.md) - -[Remove-AzureRmPowerBIEmbeddedCapacity ](./Remove-AzureRmPowerBIEmbeddedCapacity.md) diff --git a/azurermps-6.13.0/AzureRM.PowerBIEmbedded/Get-AzureRmPowerBIWorkspace.md b/azurermps-6.13.0/AzureRM.PowerBIEmbedded/Get-AzureRmPowerBIWorkspace.md deleted file mode 100644 index 63f264feb1..0000000000 --- a/azurermps-6.13.0/AzureRM.PowerBIEmbedded/Get-AzureRmPowerBIWorkspace.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.PowerBIEmbedded.dll-Help.xml -Module Name: AzureRM.PowerBIEmbedded -ms.assetid: 5321FC62-3585-4493-A3D2-22CD82503CA7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.powerbiembedded/get-azurermpowerbiworkspace -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/Get-AzureRmPowerBIWorkspace.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/Get-AzureRmPowerBIWorkspace.md ---- - -# Get-AzureRmPowerBIWorkspace - -## SYNOPSIS -Gets the workspaces in a Power BI workspace collection. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmPowerBIWorkspace [-ResourceGroupName] <String> [-WorkspaceCollectionName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmPowerBIWorkspace** cmdlet gets the workspaces in a Power BI workspace collection. - -## EXAMPLES - -### Example 1: Get workspaces of a workspace collection -``` -PS C:\>Get-AzureRmPowerBIWorkspace -ResourceGroupName "ResourceGroup17" -WorkspaceCollectionName "WCN11" -``` - -This command gets the workspaces that belong to the workspace collection named WCN11 in the specified resource group. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the workspace collection belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WorkspaceCollectionName -Specifies the name of the workspace collection for which this cmdlet gets workspaces. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.PowerBIEmbedded.Models.PSWorkspace - -## NOTES - -## RELATED LINKS - -[Get-AzureRmPowerBIWorkspaceCollection](./Get-AzureRmPowerBIWorkspaceCollection.md) - - diff --git a/azurermps-6.13.0/AzureRM.PowerBIEmbedded/Get-AzureRmPowerBIWorkspaceCollection.md b/azurermps-6.13.0/AzureRM.PowerBIEmbedded/Get-AzureRmPowerBIWorkspaceCollection.md deleted file mode 100644 index f0fb435fc5..0000000000 --- a/azurermps-6.13.0/AzureRM.PowerBIEmbedded/Get-AzureRmPowerBIWorkspaceCollection.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.PowerBIEmbedded.dll-Help.xml -Module Name: AzureRM.PowerBIEmbedded -ms.assetid: EEF32F48-00F6-4C57-B4F1-B58B566EAFEF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.powerbiembedded/get-azurermpowerbiworkspacecollection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/Get-AzureRmPowerBIWorkspaceCollection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/Get-AzureRmPowerBIWorkspaceCollection.md ---- - -# Get-AzureRmPowerBIWorkspaceCollection - -## SYNOPSIS -Gets Power BI workspace collections. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceGroupParameterSet -``` -Get-AzureRmPowerBIWorkspaceCollection [[-ResourceGroupName] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### WorkspaceCollectionNameParameterSet -``` -Get-AzureRmPowerBIWorkspaceCollection [-ResourceGroupName] <String> [-WorkspaceCollectionName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmPowerBIWorkspaceCollection** cmdlet gets Power BI workspace collections in your Azure subscription and resource group, or by collection name. - -## EXAMPLES - -### Example 1: Get all workspace collections in a resource group -``` -PS C:\>Get-AzureRmPowerBIWorkspaceCollection -ResourceGroupName "ResourceGroup17" -``` - -This command gets the workspace collections that belong to the resource group named ResourceGroup17. - -### Example 2: Get a workspace collection by using its name -``` -PS C:\>Get-AzureRmPowerBIWorkspaceCollection -ResourceGroupName "ResourceGroup17" -WorkspaceCollectionName "WCN11" -``` - -This command gets the workspace collection named WCN11 in the specified resource group. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group from which this cmdlet gets workspace collections. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupParameterSet -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: WorkspaceCollectionNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WorkspaceCollectionName -Specifies the name of the Power BI workspace collection that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: WorkspaceCollectionNameParameterSet -Aliases: Name, ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.PowerBIEmbedded.Models.PSWorkspaceCollection - -## NOTES - -## RELATED LINKS - -[New-AzureRmPowerBIWorkspaceCollection](./New-AzureRmPowerBIWorkspaceCollection.md) - -[Remove-AzureRmPowerBIWorkspaceCollection](./Remove-AzureRmPowerBIWorkspaceCollection.md) - - diff --git a/azurermps-6.13.0/AzureRM.PowerBIEmbedded/Get-AzureRmPowerBIWorkspaceCollectionAccessKeys.md b/azurermps-6.13.0/AzureRM.PowerBIEmbedded/Get-AzureRmPowerBIWorkspaceCollectionAccessKeys.md deleted file mode 100644 index 229fd01941..0000000000 --- a/azurermps-6.13.0/AzureRM.PowerBIEmbedded/Get-AzureRmPowerBIWorkspaceCollectionAccessKeys.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.PowerBIEmbedded.dll-Help.xml -Module Name: AzureRM.PowerBIEmbedded -ms.assetid: 3FED0088-47DA-4565-B9F0-DACF9B2DC0C7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.powerbiembedded/get-azurermpowerbiworkspacecollectionaccesskeys -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/Get-AzureRmPowerBIWorkspaceCollectionAccessKeys.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/Get-AzureRmPowerBIWorkspaceCollectionAccessKeys.md ---- - -# Get-AzureRmPowerBIWorkspaceCollectionAccessKeys - -## SYNOPSIS -Gets the current access keys associated with a Power BI workspace collection. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmPowerBIWorkspaceCollectionAccessKeys [-ResourceGroupName] <String> - [-WorkspaceCollectionName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmPowerBIWorkspaceCollectionAccessKeys** cmdlet gets the current access keys associated with a Power BI workspace collection. - -## EXAMPLES - -### Example 1: Get access keys -``` -PS C:\>Get-AzureRmPowerBIWorkspaceCollectionAccessKeys -ResourceGroupName "ResourceGroup17" -WorkspaceCollectionName "WCN11" -``` - -This command gets access keys for the workspace collection named WCN11 in the specified resource group. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the collection. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WorkspaceCollectionName -Specifies the name of the Power BI workspace collection on which this cmdlet operates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.PowerBIEmbedded.Models.PSWorkspaceCollectionAccessKey - -## NOTES - -## RELATED LINKS - -[Reset-AzureRmPowerBIWorkspaceCollectionAccessKeys](./Reset-AzureRmPowerBIWorkspaceCollectionAccessKeys.md) - - diff --git a/azurermps-6.13.0/AzureRM.PowerBIEmbedded/New-AzureRmPowerBIEmbeddedCapacity.md b/azurermps-6.13.0/AzureRM.PowerBIEmbedded/New-AzureRmPowerBIEmbeddedCapacity.md deleted file mode 100644 index 468d1d5bee..0000000000 --- a/azurermps-6.13.0/AzureRM.PowerBIEmbedded/New-AzureRmPowerBIEmbeddedCapacity.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.PowerBI.dll-Help.xml -Module Name: AzureRM.PowerBIEmbedded -ms.assetid: 5321FC62-3585-4493-A3D2-22CD82503CA7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.powerbiembedded/new-azurermpowerbiembeddedcapacity -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PowerBIEmbedded/Commands.PowerBI/help/New-AzureRmPowerBIEmbeddedCapacity.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PowerBIEmbedded/Commands.PowerBI/help/New-AzureRmPowerBIEmbeddedCapacity.md ---- - -# New-AzureRmPowerBIEmbeddedCapacity - -## SYNOPSIS -Creates a new PowerBI Embedded Capacity. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmPowerBIEmbeddedCapacity [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> - [-Sku] <String> [-Administrator] <String[]> [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmPowerBIEmbeddedCapacity cmdlet creates a new PowerBI Embedded Capacity - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmPowerBIEmbeddedCapacity -ResourceGroupName "testRG" -Name "testcapacity" -Location "West Central US" -Sku "A1" -Administrator admin@microsoft.com -Type : Microsoft.PowerBIDedicated/capacities -Id : /subscriptions/78e47976-.../resourceGroups/testRG/providers/Microsoft.PowerBIDedicated/capacities/testcapacity -ResourceGroup : testRG -Name : testcapacity -Location : West Central US -State : Succeeded -Administrator : {admin@microsoft.com} -Sku : A1 -Tier : PBIE_Azure -Tag : {} -``` - -Creates a capacity named testcapacity in the Azure region West Central US and in resource group testRG. The sku level for the capacity will be A1. - -## PARAMETERS - -### -Administrator -A comma separated capacity names to set as administrator on the capacity - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The Azure region where the PowerBI Embedded Capacity is hosted - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Name of the PowerBI Embedded Capacity - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Azure resource group to which the capacity belongs - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -The name of the Sku for the capacity. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: A1, A2, A3, A4, A5, A6 - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table set as tags on the capacity. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts user to confirm whether to perform the operation - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Describes the actions the current operation will perform without actually performing them - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.String[] - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.PowerBI.Models.PSPowerBIEmbeddedCapacity - -## NOTES - -## RELATED LINKS - -[Get-AzureRmPowerBIEmbeddedCapacity](./Get-AzureRmPowerBIEmbeddedCapacity.md) - -[Remove-AzureRmPowerBIEmbeddedCapacity](./Remove-AzureRmPowerBIEmbeddedCapacity.md) diff --git a/azurermps-6.13.0/AzureRM.PowerBIEmbedded/New-AzureRmPowerBIWorkspaceCollection.md b/azurermps-6.13.0/AzureRM.PowerBIEmbedded/New-AzureRmPowerBIWorkspaceCollection.md deleted file mode 100644 index 487db6f6b8..0000000000 --- a/azurermps-6.13.0/AzureRM.PowerBIEmbedded/New-AzureRmPowerBIWorkspaceCollection.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.PowerBIEmbedded.dll-Help.xml -Module Name: AzureRM.PowerBIEmbedded -ms.assetid: 9F9E4273-6747-4963-AF1F-C0AEB46770A4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.powerbiembedded/new-azurermpowerbiworkspacecollection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/New-AzureRmPowerBIWorkspaceCollection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/New-AzureRmPowerBIWorkspaceCollection.md ---- - -# New-AzureRmPowerBIWorkspaceCollection - -## SYNOPSIS -Creates a Power BI workspace collection. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmPowerBIWorkspaceCollection [-ResourceGroupName] <String> [-WorkspaceCollectionName] <String> - [-Location] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmPowerBIWorkspaceCollection** cmdlet creates a Power BI workspace collection for your Azure subscription in the specified resource group and location. - -## EXAMPLES - -### Example 1: Create a workspace collection -``` -PS C:\>New-AzureRmPowerBIWorkspaceCollection -ResourceGroupName "ResourceGroup17" -WorkspaceCollectionName "WCN11" -Location "Japan West" -``` - -This command creates a workspace collection named WCN11 in the specified resource group in the specified location. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the Azure location in which this cmdlet creates a workspace collection. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group in which this cmdlet creates a workspace collection. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WorkspaceCollectionName -Specifies a name for the Power BI workspace collection. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.PowerBIEmbedded.Models.PSWorkspaceCollection - -## NOTES - -## RELATED LINKS - -[Get-AzureRmPowerBIWorkspaceCollection](./Get-AzureRmPowerBIWorkspaceCollection.md) - -[Remove-AzureRmPowerBIWorkspaceCollection](./Remove-AzureRmPowerBIWorkspaceCollection.md) - - diff --git a/azurermps-6.13.0/AzureRM.PowerBIEmbedded/Remove-AzureRmPowerBIEmbeddedCapacity.md b/azurermps-6.13.0/AzureRM.PowerBIEmbedded/Remove-AzureRmPowerBIEmbeddedCapacity.md deleted file mode 100644 index 6caef42185..0000000000 --- a/azurermps-6.13.0/AzureRM.PowerBIEmbedded/Remove-AzureRmPowerBIEmbeddedCapacity.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.PowerBI.dll-Help.xml -Module Name: AzureRM.PowerBIEmbedded -ms.assetid: 5321FC62-3585-4493-A3D2-22CD82503CA7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.powerbiembedded/remove-azurermpowerbiembeddedcapacity -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PowerBIEmbedded/Commands.PowerBI/help/Remove-AzureRmPowerBIEmbeddedCapacity.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PowerBIEmbedded/Commands.PowerBI/help/Remove-AzureRmPowerBIEmbeddedCapacity.md ---- - -# Remove-AzureRmPowerBIEmbeddedCapacity - -## SYNOPSIS -Deletes an instance of PowerBI Embedded Capacity. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByNameAndResourceGroup (Default) -``` -Remove-AzureRmPowerBIEmbeddedCapacity [-Name] <String> [-ResourceGroupName <String>] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Remove-AzureRmPowerBIEmbeddedCapacity [-ResourceId] <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByInputObject -``` -Remove-AzureRmPowerBIEmbeddedCapacity [-InputObject] <PSPowerBIEmbeddedCapacity> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmPowerBIEmbeddedCapacity cmdlet deletes an instance of PowerBI Embedded Capacity - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmPowerBIEmbeddedCapacity -Name "testcapacity" -ResourceGroupName "testRG" -Type : Microsoft.PowerBIDedicated/capacities -Id : /subscriptions/78e47976-.../resourceGroups/testRG/providers/Microsoft.PowerBIDedicated/capacities/testcapacity -ResourceGroup : testRG -Name : testcapacity -Location : West Central US -State : Succeeded -Administrator : {admin@microsoft.com} -Sku : A1 -Tier : PBIE_Azure -Tag : {} -``` - -This command will remove the capacity named testcapacity in the resourcegroup testRG - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Input object for Piping - -```yaml -Type: Microsoft.Azure.Commands.PowerBI.Models.PSPowerBIEmbeddedCapacity -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the PowerBI Embedded Capacity - -```yaml -Type: System.String -Parameter Sets: ByNameAndResourceGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Will return the deleted capacity details if the operation completes successfully - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Azure resource group to which the capacity belongs - -```yaml -Type: System.String -Parameter Sets: ByNameAndResourceGroup -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Azure resource ID - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts user to confirm whether to perform the operation - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Describes the actions the current operation will perform without actually performing them - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.PowerBI.Models.PSPowerBIEmbeddedCapacity -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.PowerBI.Models.PSPowerBIEmbeddedCapacity - -## NOTES - -## RELATED LINKS - -[Get-AzureRmPowerBIEmbeddedCapacity](./Get-AzureRmPowerBIEmbeddedCapacity.md) - -[New-AzureRmPowerBIEmbeddedCapacity](./New-AzureRmPowerBIEmbeddedCapacity.md) diff --git a/azurermps-6.13.0/AzureRM.PowerBIEmbedded/Remove-AzureRmPowerBIWorkspaceCollection.md b/azurermps-6.13.0/AzureRM.PowerBIEmbedded/Remove-AzureRmPowerBIWorkspaceCollection.md deleted file mode 100644 index 4f75592c9b..0000000000 --- a/azurermps-6.13.0/AzureRM.PowerBIEmbedded/Remove-AzureRmPowerBIWorkspaceCollection.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.PowerBIEmbedded.dll-Help.xml -Module Name: AzureRM.PowerBIEmbedded -ms.assetid: 2D63CC6D-AB02-4299-A922-4057D6F595D7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.powerbiembedded/remove-azurermpowerbiworkspacecollection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/Remove-AzureRmPowerBIWorkspaceCollection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/Remove-AzureRmPowerBIWorkspaceCollection.md ---- - -# Remove-AzureRmPowerBIWorkspaceCollection - -## SYNOPSIS -Removes a Power BI workspace collection. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmPowerBIWorkspaceCollection [-ResourceGroupName] <String> [-WorkspaceCollectionName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmPowerBIWorkspaceCollection** cmdlet removes a Power BI workspace collection from your Azure subscription and resource group. - -## EXAMPLES - -### Example 1: Remove a workspace collection -``` -PS C:\>Remove-AzureRmPowerBIWorkspaceCollection -ResourceGroupName "ResourceGroup17" -WorkspaceCollectionName "WCN11" -``` - -This command removes the workspace collection named WCN11 in the specified resource group. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group from which this cmdlet removes a workspace collection. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WorkspaceCollectionName -Specifies the name of the Power BI workspace collection that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmPowerBIWorkspaceCollection](./Get-AzureRmPowerBIWorkspaceCollection.md) - -[New-AzureRmPowerBIWorkspaceCollection](./New-AzureRmPowerBIWorkspaceCollection.md) - - diff --git a/azurermps-6.13.0/AzureRM.PowerBIEmbedded/Reset-AzureRmPowerBIWorkspaceCollectionAccessKeys.md b/azurermps-6.13.0/AzureRM.PowerBIEmbedded/Reset-AzureRmPowerBIWorkspaceCollectionAccessKeys.md deleted file mode 100644 index c12a3a3647..0000000000 --- a/azurermps-6.13.0/AzureRM.PowerBIEmbedded/Reset-AzureRmPowerBIWorkspaceCollectionAccessKeys.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.PowerBIEmbedded.dll-Help.xml -Module Name: AzureRM.PowerBIEmbedded -ms.assetid: 8FB2D9A0-BF7A-482D-B3A2-566FCA8C62A1 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.powerbiembedded/reset-azurermpowerbiworkspacecollectionaccesskeys -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/Reset-AzureRmPowerBIWorkspaceCollectionAccessKeys.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/Reset-AzureRmPowerBIWorkspaceCollectionAccessKeys.md ---- - -# Reset-AzureRmPowerBIWorkspaceCollectionAccessKeys - -## SYNOPSIS -Resets the specified access key. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Reset-AzureRmPowerBIWorkspaceCollectionAccessKeys [-ResourceGroupName] <String> - [-WorkspaceCollectionName] <String> [-Key1] [-Key2] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Reset-AzureRmPowerBIWorkspaceCollectionAccessKeys** cmdlet resets the specified access key in your Power BI workspace collection. - -## EXAMPLES - -### Example 1: Reset the primary access key -``` -PS C:\>Reset-AzureRmPowerBIWorkspaceCollectionAccessKeys -ResourceGroupName "ResourceGroup17" -WorkspaceCollectionName "WCN11" -Key1 -``` - -This command resets the primary access key for the workspace collection named WCN11 in the specified resource group. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Key1 -Indicates that this cmdlet resets the primary access key. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Key2 -Indicates that this cmdlet resets the secondary access key. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the collection. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WorkspaceCollectionName -Specifies the name of the Power BI workspace collection on which this cmdlet operates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.PowerBIEmbedded.Models.PSWorkspaceCollectionAccessKey - -## NOTES - -## RELATED LINKS - -[Get-AzureRmPowerBIWorkspaceCollectionAccessKeys](./Get-AzureRmPowerBIWorkspaceCollectionAccessKeys.md) - - diff --git a/azurermps-6.13.0/AzureRM.PowerBIEmbedded/Resume-AzureRmPowerBIEmbeddedCapacity.md b/azurermps-6.13.0/AzureRM.PowerBIEmbedded/Resume-AzureRmPowerBIEmbeddedCapacity.md deleted file mode 100644 index 997ed56a1a..0000000000 --- a/azurermps-6.13.0/AzureRM.PowerBIEmbedded/Resume-AzureRmPowerBIEmbeddedCapacity.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.PowerBI.dll-Help.xml -Module Name: AzureRM.PowerBIEmbedded -ms.assetid: 5321FC62-3585-4493-A3D2-22CD82503CA7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.powerbiembedded/resume-azurermpowerbiembeddedcapacity -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PowerBIEmbedded/Commands.PowerBI/help/Resume-AzureRmPowerBIEmbeddedCapacity.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PowerBIEmbedded/Commands.PowerBI/help/Resume-AzureRmPowerBIEmbeddedCapacity.md ---- - -# Resume-AzureRmPowerBIEmbeddedCapacity - -## SYNOPSIS -Resumes an instance of PowerBI Embedded Capacity. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByNameAndResourceGroup (Default) -``` -Resume-AzureRmPowerBIEmbeddedCapacity [-Name] <String> [-ResourceGroupName <String>] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Resume-AzureRmPowerBIEmbeddedCapacity [-ResourceId] <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByInputObject -``` -Resume-AzureRmPowerBIEmbeddedCapacity [-InputObject] <PSPowerBIEmbeddedCapacity> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Resume-AzureRmPowerBIEmbeddedCapacity cmdlet resumes an instance of PowerBI Embedded Capacity - -## EXAMPLES - -### Example 1 -``` -PS C:\> Resume-AzureRmPowerBIEmbeddedCapacity -Name "testcapacity" -ResourceGroupName "testRG" -PassThru -Type : Microsoft.PowerBIDedicated/capacities -Id : /subscriptions/78e47976-.../resourceGroups/testRG/providers/Microsoft.PowerBIDedicated/capacities/testcapacity -ResourceGroup : testRG -Name : testcapacity -Location : West Central US -State : Succeeded -Administrator : {admin@microsoft.com} -Sku : A1 -Tier : PBIE_Azure -Tag : {} -``` - -This command will resume a paused capacity named testcapacity in the resourcegroup testRG - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Input object for Piping - -```yaml -Type: Microsoft.Azure.Commands.PowerBI.Models.PSPowerBIEmbeddedCapacity -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the PowerBI Embedded Capacity - -```yaml -Type: System.String -Parameter Sets: ByNameAndResourceGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Azure resource group to which the capacity belongs - -```yaml -Type: System.String -Parameter Sets: ByNameAndResourceGroup -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Azure resource ID - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts user to confirm whether to perform the operation - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Describes the actions the current operation will perform without actually performing them - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.PowerBI.Models.PSPowerBIEmbeddedCapacity -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.PowerBI.Models.PSPowerBIEmbeddedCapacity - -## NOTES - -## RELATED LINKS - -[Get-AzureRmPowerBIEmbeddedCapacity](./Get-AzureRmPowerBIEmbeddedCapacity.md) - -[Suspend-AzureRmPowerBIEmbeddedCapacity](./Suspend-AzureRmPowerBIEmbeddedCapacity.md) diff --git a/azurermps-6.13.0/AzureRM.PowerBIEmbedded/Suspend-AzureRmPowerBIEmbeddedCapacity.md b/azurermps-6.13.0/AzureRM.PowerBIEmbedded/Suspend-AzureRmPowerBIEmbeddedCapacity.md deleted file mode 100644 index 36d584319f..0000000000 --- a/azurermps-6.13.0/AzureRM.PowerBIEmbedded/Suspend-AzureRmPowerBIEmbeddedCapacity.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.PowerBI.dll-Help.xml -Module Name: AzureRM.PowerBIEmbedded -ms.assetid: 5321FC62-3585-4493-A3D2-22CD82503CA7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.powerbiembedded/suspend-azurermpowerbiembeddedcapacity -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PowerBIEmbedded/Commands.PowerBI/help/Suspend-AzureRmPowerBIEmbeddedCapacity.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PowerBIEmbedded/Commands.PowerBI/help/Suspend-AzureRmPowerBIEmbeddedCapacity.md ---- - -# Suspend-AzureRmPowerBIEmbeddedCapacity - -## SYNOPSIS -Suspends an instance of PowerBI Embedded Capacity. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByNameAndResourceGroup (Default) -``` -Suspend-AzureRmPowerBIEmbeddedCapacity [-Name] <String> [-ResourceGroupName <String>] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Suspend-AzureRmPowerBIEmbeddedCapacity [-ResourceId] <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByInputObject -``` -Suspend-AzureRmPowerBIEmbeddedCapacity [-InputObject] <PSPowerBIEmbeddedCapacity> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Suspend-AzureRmPowerBIEmbeddedCapacity cmdlet suspends an instance of PowerBI Embedded Capacity - -## EXAMPLES - -### Example 1 -``` -PS C:\> Suspend-AzureRmPowerBIEmbeddedCapacity -Name "testcapacity" -ResourceGroupName "testRG" -PassThru -Type : Microsoft.PowerBIDedicated/capacities -Id : /subscriptions/78e47976-.../resourceGroups/testRG/providers/Microsoft.PowerBIDedicated/capacities/testcapacity -ResourceGroup : testRG -Name : testcapacity -Location : West Central US -State : Paused -Administrator : {admin@microsoft.com} -Sku : A1 -Tier : PBIE_Azure -Tag : {} -``` - -This command will suspend an active capacity named testcapacity in the resourcegroup testgroup - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Input object for Piping - -```yaml -Type: Microsoft.Azure.Commands.PowerBI.Models.PSPowerBIEmbeddedCapacity -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the PowerBI Embedded Capacity - -```yaml -Type: System.String -Parameter Sets: ByNameAndResourceGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Azure resource group to which the capacity belongs - -```yaml -Type: System.String -Parameter Sets: ByNameAndResourceGroup -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Azure resource ID - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts user to confirm whether to perform the operation - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Describes the actions the current operation will perform without actually performing them - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.PowerBI.Models.PSPowerBIEmbeddedCapacity -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.PowerBI.Models.PSPowerBIEmbeddedCapacity - -## NOTES - -## RELATED LINKS - -[Get-AzureRmPowerBIEmbeddedCapacity](./Get-AzureRmPowerBIEmbeddedCapacity.md) - -[Resume-AzureRmPowerBIEmbeddedCapacity](./Resume-AzureRmPowerBIEmbeddedCapacity.md) - diff --git a/azurermps-6.13.0/AzureRM.PowerBIEmbedded/Test-AzureRmPowerBIEmbeddedCapacity.md b/azurermps-6.13.0/AzureRM.PowerBIEmbedded/Test-AzureRmPowerBIEmbeddedCapacity.md deleted file mode 100644 index faea3f6981..0000000000 --- a/azurermps-6.13.0/AzureRM.PowerBIEmbedded/Test-AzureRmPowerBIEmbeddedCapacity.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.PowerBI.dll-Help.xml -Module Name: AzureRM.PowerBIEmbedded -ms.assetid: 5321FC62-3585-4493-A3D2-22CD82503CA7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.powerbiembedded/test-azurermpowerbiembeddedcapacity -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PowerBIEmbedded/Commands.PowerBI/help/Test-AzureRmPowerBIEmbeddedCapacity.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PowerBIEmbedded/Commands.PowerBI/help/Test-AzureRmPowerBIEmbeddedCapacity.md ---- - -# Test-AzureRmPowerBIEmbeddedCapacity - -## SYNOPSIS -Tests the existence of an instance of PowerBI Embedded Capacity. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Test-AzureRmPowerBIEmbeddedCapacity [-Name] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Test-AzureRmPowerBIEmbeddedCapacity cmdlet tests the existence of an instance of PowerBI Embedded Capacity - -## EXAMPLES - -### Example 1 -``` -PS C:\> Test-AzureRmPowerBIEmbeddedCapacity -Name "testcapacity" -True -``` - -This command will test if there is a capacity named testcapacity - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the PowerBI Embedded Capacity - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmPowerBIEmbeddedCapacity](./Get-AzureRmPowerBIEmbeddedCapacity.md) - -[Remove-AzureRmPowerBIEmbeddedCapacity](./Remove-AzureRmPowerBIEmbeddedCapacity.md) diff --git a/azurermps-6.13.0/AzureRM.PowerBIEmbedded/Update-AzureRmPowerBIEmbeddedCapacity.md b/azurermps-6.13.0/AzureRM.PowerBIEmbedded/Update-AzureRmPowerBIEmbeddedCapacity.md deleted file mode 100644 index d90f6ac3eb..0000000000 --- a/azurermps-6.13.0/AzureRM.PowerBIEmbedded/Update-AzureRmPowerBIEmbeddedCapacity.md +++ /dev/null @@ -1,251 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.PowerBI.dll-Help.xml -Module Name: AzureRM.PowerBIEmbedded -ms.assetid: 5321FC62-3585-4493-A3D2-22CD82503CA7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.powerbiembedded/update-azurermpowerbiembeddedcapacity -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PowerBIEmbedded/Commands.PowerBI/help/Update-AzureRmPowerBIEmbeddedCapacity.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/PowerBIEmbedded/Commands.PowerBI/help/Update-AzureRmPowerBIEmbeddedCapacity.md ---- - -# Update-AzureRmPowerBIEmbeddedCapacity - -## SYNOPSIS -Modifies an instance of PowerBI Embedded Capacity. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByNameAndResourceGroup (Default) -``` -Update-AzureRmPowerBIEmbeddedCapacity [-Name] <String> [-ResourceGroupName <String>] [-Sku <String>] - [-Tag <Hashtable>] [-Administrator <String[]>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Update-AzureRmPowerBIEmbeddedCapacity [-Sku <String>] [-Tag <Hashtable>] [-Administrator <String[]>] - [-ResourceId] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByInputObject -``` -Update-AzureRmPowerBIEmbeddedCapacity [-Sku <String>] [-Tag <Hashtable>] [-Administrator <String[]>] - [-InputObject] <PSPowerBIEmbeddedCapacity> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Update-AzureRmPowerBIEmbeddedCapacity cmdlet modifies an instance of PowerBI Embedded Capacity - -## EXAMPLES - -### Example 1 -``` -PS C:\> Update-AzureRmPowerBIEmbeddedCapacity -Name "testcapacity" -Tag @{"key1" = "value1";"key2" = "value2"} -Administrator "testuser1@contoso.com, testuser2@contoso.com" -PassThru -Type : Microsoft.PowerBIDedicated/capacities -Id : /subscriptions/78e47976-.../resourceGroups/testRG/providers/Microsoft.PowerBIDedicated/capacities/testcapacity -ResourceGroup : testRG -Name : testcapacity -Location : West Central US -State : Succeeded -Administrator : {testuser1@contoso.com, testuser2@contoso.com} -Sku : A1 -Tier : PBIE_Azure -Tag : {[key1, value1], [key2, value2]} -``` - -Modifies the capacity named testcapacity in resourcegroup testgroup to set the tags as key1:value1 and key2:value2 and administrator to testuser1@contoso.com - -## PARAMETERS - -### -Administrator -A comma separated capacity names to set as administrator on the capacity - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Input object for Piping - -```yaml -Type: Microsoft.Azure.Commands.PowerBI.Models.PSPowerBIEmbeddedCapacity -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the PowerBI Embedded Capacity - -```yaml -Type: System.String -Parameter Sets: ByNameAndResourceGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Will return the deleted capacity details if the operation completes successfully - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the Azure resource group to which the capacity belongs - -```yaml -Type: System.String -Parameter Sets: ByNameAndResourceGroup -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -PowerBI Embedded Capacity ResourceID. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -The name of the Sku for the capacity. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: A1, A2, A3, A4, A5, A6 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table set as tags on the capacity. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts user to confirm whether to perform the operation - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Describes the actions the current operation will perform without actually performing them - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.PowerBI.Models.PSPowerBIEmbeddedCapacity -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.PowerBI.Models.PSPowerBIEmbeddedCapacity - -## NOTES - -## RELATED LINKS - -[Get-AzureRmPowerBIEmbeddedCapacity](./Get-AzureRmPowerBIEmbeddedCapacity.md) - -[Remove-AzureRmPowerBIEmbeddedCapacity](./Remove-AzureRmPowerBIEmbeddedCapacity.md) diff --git a/azurermps-6.13.0/AzureRM.Profile/Add-AzureRmEnvironment.md b/azurermps-6.13.0/AzureRM.Profile/Add-AzureRmEnvironment.md deleted file mode 100644 index 8825878a61..0000000000 --- a/azurermps-6.13.0/AzureRM.Profile/Add-AzureRmEnvironment.md +++ /dev/null @@ -1,560 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml -Module Name: AzureRM.Profile -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.profile/add-azurermenvironment -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Add-AzureRmEnvironment.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Add-AzureRmEnvironment.md ---- - -# Add-AzureRmEnvironment - -## SYNOPSIS -Adds endpoints and metadata for an instance of Azure Resource Manager. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Name (Default) -``` -Add-AzureRmEnvironment [-Name] <String> [[-PublishSettingsFileUrl] <String>] [[-ServiceEndpoint] <String>] - [[-ManagementPortalUrl] <String>] [[-StorageEndpoint] <String>] [[-ActiveDirectoryEndpoint] <String>] - [[-ResourceManagerEndpoint] <String>] [[-GalleryEndpoint] <String>] - [[-ActiveDirectoryServiceEndpointResourceId] <String>] [[-GraphEndpoint] <String>] - [[-AzureKeyVaultDnsSuffix] <String>] [[-AzureKeyVaultServiceEndpointResourceId] <String>] - [[-TrafficManagerDnsSuffix] <String>] [[-SqlDatabaseDnsSuffix] <String>] - [[-AzureDataLakeStoreFileSystemEndpointSuffix] <String>] - [[-AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix] <String>] [-EnableAdfsAuthentication] - [[-AdTenant] <String>] [[-GraphAudience] <String>] [[-DataLakeAudience] <String>] - [[-BatchEndpointResourceId] <String>] [[-AzureOperationalInsightsEndpointResourceId] <String>] - [[-AzureOperationalInsightsEndpoint] <String>] [-AzureAnalysisServicesEndpointSuffix <String>] [-Scope <ContextModificationScope>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ARMEndpoint -``` -Add-AzureRmEnvironment [-Name] <String> [[-StorageEndpoint] <String>] [-ARMEndpoint] <String> - [[-AzureKeyVaultDnsSuffix] <String>] [[-AzureKeyVaultServiceEndpointResourceId] <String>] - [[-DataLakeAudience] <String>] [[-BatchEndpointResourceId] <String>] - [[-AzureOperationalInsightsEndpointResourceId] <String>] [[-AzureOperationalInsightsEndpoint] <String>] - [-Scope <ContextModificationScope>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The Add-AzureRmEnvironment cmdlet adds endpoints and metadata to enable Azure Resource Manager cmdlets to connect with a new instance of Azure Resource Manager. -The built-in environments AzureCloud and AzureChinaCloud target existing public instances of Azure Resource Manager. - -## EXAMPLES - -### Example 1: Creating and modifying a new environment -``` -PS C:\> Add-AzureRmEnvironment -Name TestEnvironment ` - -ActiveDirectoryEndpoint TestADEndpoint ` - -ActiveDirectoryServiceEndpointResourceId TestADApplicationId ` - -ResourceManagerEndpoint TestRMEndpoint ` - -GalleryEndpoint TestGalleryEndpoint ` - -GraphEndpoint TestGraphEndpoint - -Name Resource Manager Url ActiveDirectory Authority ----- -------------------- ------------------------- -TestEnvironment TestRMEndpoint TestADEndpoint/ - -PS C:\> Set-AzureRmEnvironment -Name TestEnvironment ` - -ActiveDirectoryEndpoint NewTestADEndpoint ` - -GraphEndpoint NewTestGraphEndpoint | Format-List - -Name : TestEnvironment -EnableAdfsAuthentication : False -OnPremise : False -ActiveDirectoryServiceEndpointResourceId : TestADApplicationId -AdTenant : -GalleryUrl : TestGalleryEndpoint -ManagementPortalUrl : -ServiceManagementUrl : -PublishSettingsFileUrl : -ResourceManagerUrl : TestRMEndpoint -SqlDatabaseDnsSuffix : -StorageEndpointSuffix : -ActiveDirectoryAuthority : NewTestADEndpoint -GraphUrl : NewTestGraphEndpoint -GraphEndpointResourceId : -TrafficManagerDnsSuffix : -AzureKeyVaultDnsSuffix : -DataLakeEndpointResourceId : -AzureDataLakeStoreFileSystemEndpointSuffix : -AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix : -AzureKeyVaultServiceEndpointResourceId : -AzureOperationalInsightsEndpointResourceId : -AzureOperationalInsightsEndpoint : -AzureAnalysisServicesEndpointSuffix : -VersionProfiles : {} -ExtendedProperties : {} -BatchEndpointResourceId : - -In this example we are creating a new Azure environment with sample endpoints using Add-AzureRmEnvironment, and then we are changing the value of the ActiveDirectoryEndpoint and GraphEndpoint attributes of the created environment using the cmdlet Set-AzureRmEnvironment. -``` - -## PARAMETERS - -### -ActiveDirectoryEndpoint -Specifies the base authority for Microsoft Entra authentication. - -```yaml -Type: System.String -Parameter Sets: Name -Aliases: AdEndpointUrl, ActiveDirectory, ActiveDirectoryAuthority - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ActiveDirectoryServiceEndpointResourceId -Specifies the audience for tokens that authenticate requests to Azure Resource Manager or Service Management (RDFE) endpoints. - -```yaml -Type: System.String -Parameter Sets: Name -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AdTenant -Specifies the default Active Directory tenant. - -```yaml -Type: System.String -Parameter Sets: Name -Aliases: - -Required: False -Position: 17 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ARMEndpoint -The Azure Resource Manager endpoint - -```yaml -Type: System.String -Parameter Sets: ARMEndpoint -Aliases: ArmUrl - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AzureAnalysisServicesEndpointSuffix -Dns Suffix of Azure Analysis Services service endpoints - -```yaml -Type: System.String -Parameter Sets: Name -Aliases: - -Required: False -Position: 15 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - - -### -AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix -Dns Suffix of Azure Data Lake Analytics job and catalog services - -```yaml -Type: System.String -Parameter Sets: Name -Aliases: - -Required: False -Position: 15 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AzureDataLakeStoreFileSystemEndpointSuffix -Dns Suffix of Azure Data Lake Store FileSystem. -Example: azuredatalake.net - -```yaml -Type: System.String -Parameter Sets: Name -Aliases: - -Required: False -Position: 14 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AzureKeyVaultDnsSuffix -Specifies the domain name suffix for Key Vault services. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 10 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AzureKeyVaultServiceEndpointResourceId -Specifies the audience for access tokens that authorize requests for Key Vault services. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 11 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AzureOperationalInsightsEndpoint -Specifies the endpoint for the Operational Insights query access. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 22 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AzureOperationalInsightsEndpointResourceId -Specifies the audience for access tokens that authorize requests for Operational Insights services. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 21 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BatchEndpointResourceId -The resource identifier of the Azure Batch service that is the recipient of the requested token - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: BatchResourceId, BatchAudience - -Required: False -Position: 20 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataLakeAudience -The audience for tokens authenticating with the AD Data Lake services Endpoint. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: DataLakeEndpointResourceId, DataLakeResourceId - -Required: False -Position: 19 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credeetnails, tenant and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableAdfsAuthentication -Indicates that Active Directory Federation Services (ADFS) on-premise authentication is allowed. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Name -Aliases: OnPremise - -Required: False -Position: 16 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GalleryEndpoint -Specifies the endpoint for the Azure Resource Manager gallery of deployment templates. - -```yaml -Type: System.String -Parameter Sets: Name -Aliases: Gallery, GalleryUrl - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GraphAudience -The audience for tokens authenticating with the AD Graph Endpoint. - -```yaml -Type: System.String -Parameter Sets: Name -Aliases: GraphEndpointResourceId, GraphResourceId - -Required: False -Position: 18 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GraphEndpoint -Specifies the URL for Graph (Active Directory metadata) requests. - -```yaml -Type: System.String -Parameter Sets: Name -Aliases: Graph, GraphUrl - -Required: False -Position: 9 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ManagementPortalUrl -Specifies the URL for the Management Portal. - -```yaml -Type: System.String -Parameter Sets: Name -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the environment to add. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublishSettingsFileUrl -Specifies the URL from which .publishsettings files can be downloaded. - -```yaml -Type: System.String -Parameter Sets: Name -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceManagerEndpoint -Specifies the URL for Azure Resource Manager requests. - -```yaml -Type: System.String -Parameter Sets: Name -Aliases: ResourceManager, ResourceManagerUrl - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Scope -Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user. - -```yaml -Type: Microsoft.Azure.Commands.Profile.Common.ContextModificationScope -Parameter Sets: (All) -Aliases: -Accepted values: Process, CurrentUser - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceEndpoint -Specifies the endpoint for Service Management (RDFE) requests. - -```yaml -Type: System.String -Parameter Sets: Name -Aliases: ServiceManagement, ServiceManagementUrl - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SqlDatabaseDnsSuffix -Specifies the domain-name suffix for Azure SQL Database servers. - -```yaml -Type: System.String -Parameter Sets: Name -Aliases: - -Required: False -Position: 13 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageEndpoint -Specifies the endpoint for storage (blob, table, queue, and file) access. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: StorageEndpointSuffix - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrafficManagerDnsSuffix -Specifies the domain-name suffix for Azure Traffic Manager services. - -```yaml -Type: System.String -Parameter Sets: Name -Aliases: - -Required: False -Position: 12 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Profile.Models.PSAzureEnvironment - -## NOTES - -## RELATED LINKS - -[Get-AzureRMEnvironment](./Get-AzureRMEnvironment.md) - -[Remove-AzureRMEnvironment](./Remove-AzureRMEnvironment.md) - -[Set-AzureRMEnvironment](./Set-AzureRMEnvironment.md) diff --git a/azurermps-6.13.0/AzureRM.Profile/AzureRM.Profile.md b/azurermps-6.13.0/AzureRM.Profile/AzureRM.Profile.md deleted file mode 100644 index c85b9e46bd..0000000000 --- a/azurermps-6.13.0/AzureRM.Profile/AzureRM.Profile.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -Module Name: AzureRM.Profile -Module Guid: 342714fc-4009-4863-8afb-a9067e3db04b -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.profile -Help Version: 4.6.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/AzureRM.Profile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/AzureRM.Profile.md ---- - -# AzureRM.Profile Module -## Description -Manages credentials and common configuration for all Azure modules. - -## AzureRM.Profile Cmdlets -### [Add-AzureRmEnvironment](Add-AzureRmEnvironment.md) -Adds endpoints and metadata for an instance of Azure Resource Manager. - -### [Clear-AzureRmContext](Clear-AzureRmContext.md) -Remove all Azure credentials, account, and subscription information. - -### [Clear-AzureRmDefault](Clear-AzureRmDefault.md) -Clears the defaults set by the user in the current context. - -### [Connect-AzureRmAccount](Connect-AzureRmAccount.md) -Connect to Azure with an authenticated account for use with Azure Resource Manager cmdlet requests. - -### [Disable-AzureRmContextAutosave](Disable-AzureRmContextAutosave.md) -Turn off autosaving Azure credentials. Your login information will be forgotten the next time you open a PowerShell window - -### [Disable-AzureRmDataCollection](Disable-AzureRmDataCollection.md) -Opts out of collecting data to improve the AzurePowerShell cmdlets. -Data is not collected unless you explicitly opt in. - -### [Disconnect-AzureRmAccount](Disconnect-AzureRmAccount.md) -Disconnects a connected Azure account and removes all credentials and contexts associated with that account. - -### [Enable-AzureRmContextAutosave](Enable-AzureRmContextAutosave.md) -Allow the azure credential, account and subscription information to be saved and automatically loaded when you open a PowerShell window. - -### [Enable-AzureRmDataCollection](Enable-AzureRmDataCollection.md) -Enables Azure PowerShell to collect data to improve the user experience with AzurePowerShell cmdlets. -Executing this cmdlet opts in to data collection for the current user on the current machine. -No data is collected unless you explicitly opt in. - -### [Get-AzureRmContext](Get-AzureRmContext.md) -Gets the metadata used to authenticate Azure Resource Manager requests. - -### [Get-AzureRmContextAutosaveSetting](Get-AzureRmContextAutosaveSetting.md) -Display metadata about the context autosave feature, including whether the context is -automatically saved, and where saved context and credential information can be found. - -### [Get-AzureRmDefault](Get-AzureRmDefault.md) -Get the defaults set by the user in the current context. - -### [Get-AzureRmEnvironment](Get-AzureRmEnvironment.md) -Get endpoints and metadata for an instance of Azure services. - -### [Get-AzureRmSubscription](Get-AzureRmSubscription.md) -Get subscriptions that the current account can access. - -### [Get-AzureRmTenant](Get-AzureRmTenant.md) -Gets tenants that are authorized for the current user. - -### [Import-AzureRmContext](Import-AzureRmContext.md) -Loads Azure authentication information from a file. - -### [Remove-AzureRmContext](Remove-AzureRmContext.md) -Remove a context from the set of available contexts - -### [Remove-AzureRmEnvironment](Remove-AzureRmEnvironment.md) -Removes endpoints and metadata for connecting to a given Azure instance. - -### [Rename-AzureRmContext](Rename-AzureRmContext.md) -Rename an Azure context. By default contexts are named by user account and subscription. - -### [Resolve-AzureRmError](Resolve-AzureRmError.md) -Display detailed information about PowerShell errors, with extended details for Azure PowerShell errors. - -### [Save-AzureRmContext](Save-AzureRmContext.md) -Saves the current authentication information for use in other PowerShell sessions. - -### [Select-AzureRmContext](Select-AzureRmContext.md) -Select a subscription and account to target in Azure PowerShell cmdlets - -### [Send-Feedback](Send-Feedback.md) -Sends feedback to the Azure PowerShell team via a set of guided prompts. - -### [Set-AzureRmContext](Set-AzureRmContext.md) -Sets the tenant, subscription, and environment for cmdlets to use in the current session. - -### [Set-AzureRmDefault](Set-AzureRmDefault.md) -Sets a default in the current context - -### [Set-AzureRmEnvironment](Set-AzureRmEnvironment.md) -Sets properties for an Azure environment. - diff --git a/azurermps-6.13.0/AzureRM.Profile/Clear-AzureRmContext.md b/azurermps-6.13.0/AzureRM.Profile/Clear-AzureRmContext.md deleted file mode 100644 index e74a7789ef..0000000000 --- a/azurermps-6.13.0/AzureRM.Profile/Clear-AzureRmContext.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml -Module Name: AzureRM.Profile -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.profile/clear-azurermcontext -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Clear-AzureRmContext.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Clear-AzureRmContext.md ---- - -# Clear-AzureRmContext - -## SYNOPSIS -Remove all Azure credentials, account, and subscription information. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Clear-AzureRmContext [-PassThru] [-Force] [-Scope <ContextModificationScope>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Remove all Azure Credentials, account, and subscription information. - -## EXAMPLES - -### Clear global context -``` -PS C:\> Clear-AzureRmContext -Scope CurrentUser -``` - -Remove all account, subscription, and credential information for any powershell session. - -## PARAMETERS - -### -DefaultProfile -The credentials, tenant and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Delete all users and groups from the global scope without prompting - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Return a value indicating success or failure - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Clear the context only for the current PowerShell session, or for all sessions. - -```yaml -Type: Microsoft.Azure.Commands.Profile.Common.ContextModificationScope -Parameter Sets: (All) -Aliases: -Accepted values: Process, CurrentUser - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Profile/Clear-AzureRmDefault.md b/azurermps-6.13.0/AzureRM.Profile/Clear-AzureRmDefault.md deleted file mode 100644 index d524be7e29..0000000000 --- a/azurermps-6.13.0/AzureRM.Profile/Clear-AzureRmDefault.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml -Module Name: AzureRM.Profile -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.profile/clear-azurermdefault -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Clear-AzureRmDefault.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Clear-AzureRmDefault.md ---- - -# Clear-AzureRmDefault - -## SYNOPSIS -Clears the defaults set by the user in the current context. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Clear-AzureRmDefault [-ResourceGroup] [-PassThru] [-Force] [-Scope <ContextModificationScope>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Clear-AzureRmDefault cmdlet removes the defaults set by -the user depending on the switch parameters specified by the user. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Clear-AzureRmDefault -``` - -This command removes all the defaults set by the user in the current context. - -### Example 1 -``` -PS C:\> Clear-AzureRmDefault -ResourceGroup -``` - -This command removes the default resource group set by the user in the current context. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Remove all defaults if no default is specified - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroup -Clear Default Resource Group - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Scope -Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user. - -```yaml -Type: Microsoft.Azure.Commands.Profile.Common.ContextModificationScope -Parameter Sets: (All) -Aliases: -Accepted values: Process, CurrentUser - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Profile/Connect-AzureRmAccount.md b/azurermps-6.13.0/AzureRM.Profile/Connect-AzureRmAccount.md deleted file mode 100644 index 658ca87771..0000000000 --- a/azurermps-6.13.0/AzureRM.Profile/Connect-AzureRmAccount.md +++ /dev/null @@ -1,569 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml -Module Name: AzureRM.Profile -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.profile/add-azurermaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Connect-AzureRmAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Connect-AzureRmAccount.md ---- - -# Connect-AzureRmAccount - -## SYNOPSIS -Connect to Azure with an authenticated account for use with Azure Resource Manager cmdlet requests. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### UserWithSubscriptionId (Default) -``` -Connect-AzureRmAccount [-Environment <String>] [[-Credential] <PSCredential>] [-TenantId <String>] - [-Subscription <String>] [-ContextName <String>] [-SkipContextPopulation] [-Force] - [-Scope <ContextModificationScope>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ServicePrincipalWithSubscriptionId -``` -Connect-AzureRmAccount [-Environment <String>] [-Credential] <PSCredential> [-ServicePrincipal] - -TenantId <String> [-Subscription <String>] [-ContextName <String>] [-SkipContextPopulation] [-Force] - [-Scope <ContextModificationScope>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ServicePrincipalCertificateWithSubscriptionId -``` -Connect-AzureRmAccount [-Environment <String>] -CertificateThumbprint <String> -ApplicationId <String> - [-ServicePrincipal] -TenantId <String> [-Subscription <String>] [-ContextName <String>] - [-SkipContextPopulation] [-Force] [-Scope <ContextModificationScope>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### AccessTokenWithSubscriptionId -``` -Connect-AzureRmAccount [-Environment <String>] [-TenantId <String>] -AccessToken <String> - [-GraphAccessToken <String>] [-KeyVaultAccessToken <String>] -AccountId <String> [-Subscription <String>] - [-ContextName <String>] [-SkipValidation] [-SkipContextPopulation] [-Force] - [-Scope <ContextModificationScope>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ManagedServiceLogin -``` -Connect-AzureRmAccount [-Environment <String>] [-TenantId <String>] [-AccountId <String>] [-Identity] - [-ManagedServicePort <Int32>] [-ManagedServiceHostName <String>] [-ManagedServiceSecret <SecureString>] - [-Subscription <String>] [-ContextName <String>] [-SkipContextPopulation] [-Force] - [-Scope <ContextModificationScope>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The Connect-AzureRmAccount cmdlet connects to Azure with an authenticated account for use with Azure Resource Manager cmdlet requests. -You can use this authenticated account only with Azure Resource Manager cmdlets. -To add an authenticated account for use with Service Management cmdlets, use the Add-AzureAccount or the Import-AzurePublishSettingsFile cmdlet. -If no context is found for the current user, this command will populate the user's context list with a context for each of their (first 25) subscriptions. The list of contexts created for the user can be found by running "Get-AzureRmContext -ListAvailable". To skip this context population, you can run this command with the "-SkipContextPopulation" switch parameter. -After executing this cmdlet, you can disconnect from an Azure account using Disconnect-AzureRmAccount. - -## EXAMPLES - -### Example 1: Use an interactive login to connect to an Azure account -```powershell -PS C:\> Connect-AzureRmAccount - -Account SubscriptionName TenantId Environment -------- ---------------- -------- ----------- -azureuser@contoso.com Subscription1 xxxx-xxxx-xxxx-xxxx AzureCloud -``` - -This command connects to an Azure account. -To run Azure Resource Manager cmdlets with this account, you must provide Microsoft account or organizational ID credentials at the prompt. -If multi-factor authentication is enabled for your credentials, you must log in using the interactive option or use service principal authentication. - -### Example 2: Connect to an Azure account using organizational ID credentials -```powershell -PS C:\> $Credential = Get-Credential -PS C:\> Connect-AzureRmAccount -Credential $Credential - -Account SubscriptionName TenantId Environment -------- ---------------- -------- ----------- -azureuser@contoso.com Subscription1 xxxx-xxxx-xxxx-xxxx AzureCloud -``` - -The first command will prompt for user credentials (username and password), and then stores them in the $Credential variable. -The second command connects to an Azure account using the credentials stored in $Credential. -This account authenticates with Azure Resource Manager using organizational ID credentials. -You cannot use multi-factor authentication or Microsoft account credentials to run Azure Resource Manager cmdlets with this account. - -### Example 3: Connect to an Azure service principal account -```powershell -PS C:\> $Credential = Get-Credential - -PS C:\> Connect-AzureRmAccount -Credential $Credential -Tenant "xxxx-xxxx-xxxx-xxxx" -ServicePrincipal -Account SubscriptionName TenantId Environment -------- ---------------- -------- ----------- -xxxx-xxxx-xxxx-xxxx Subscription1 xxxx-xxxx-xxxx-xxxx AzureCloud -``` - -The first command gets the service principal credentials (application id and service principal secret), and then stores them in the $Credential variable. -The second command connect to Azure using the service principal credentials stored in $Credential for the specified Tenant. -The ServicePrincipal switch parameter indicates that the account authenticates as a service principal. - -### Example 4: Use an interactive login to connect to an account for a specific tenant and subscription -```powershell -PS C:\> Connect-AzureRmAccount -Tenant "xxxx-xxxx-xxxx-xxxx" -SubscriptionId "yyyy-yyyy-yyyy-yyyy" -Account SubscriptionName TenantId Environment -------- ---------------- -------- ----------- -azureuser@contoso.com Subscription1 xxxx-xxxx-xxxx-xxxx AzureCloud -``` - -This command connects to an Azure account and configured AzureRM PowerShell to run cmdlets for the specified tenant and subscription by default. - -### Example 5: Add an Account Using Managed Service Identity Login -```powershell -PS C:\> Connect-AzureRmAccount -MSI - -Account SubscriptionName TenantId Environment -------- ---------------- -------- ----------- -MSI@50342 Subscription1 xxxx-xxxx-xxxx-xxxx AzureCloud -``` - -This command connects using the managed service identity of the host environment (for example, if executed on a -VirtualMachine with an assigned Managed Service Identity, this will allow the code to login using that assigned identity) - -### Example 6: Add an account using certificates -```powershell -# For more information on creating a self-signed certificate -# and giving it proper permissions, please see the following: -# https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-authenticate-service-principal-powershell -PS C:\> $Thumbprint = "0SZTNJ34TCCMUJ5MJZGR8XQD3S0RVHJBA33Z8ZXV" -PS C:\> $TenantId = "00001111-aaaa-2222-bbbb-3333cccc4444" -PS C:\> $ApplicationId = "00001111-aaaa-2222-bbbb-3333cccc4444" -PS C:\> Connect-AzureRmAccount -CertificateThumbprint $Thumbprint -ApplicationId $ApplicationId -Tenant $TenantId -ServicePrincipal - -Account SubscriptionName TenantId Environment -------- ---------------- -------- ----------- -xxxx-xxxx-xxxx-xxxx Subscription1 xxxx-xxxx-xxxx-xxxx AzureCloud - -Account : 00001111-aaaa-2222-bbbb-3333cccc4444 -SubscriptionName : MyTestSubscription -SubscriptionId : 85f0f653-1f86-4d2c-a9f1-042efc00085c -TenantId : 00001111-aaaa-2222-bbbb-3333cccc4444 -Environment : AzureCloud -``` - -This command connects to an Azure account using certificate-based service principal authentication. Theservice principal used for authentication should have been created with the given certificate. - -## PARAMETERS - -### -AccessToken -Specifies an access token. - -```yaml -Type: System.String -Parameter Sets: AccessTokenWithSubscriptionId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccountId -Account Id for access token - -```yaml -Type: System.String -Parameter Sets: AccessTokenWithSubscriptionId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ManagedServiceLogin -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationId -SPN - -```yaml -Type: System.String -Parameter Sets: ServicePrincipalCertificateWithSubscriptionId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CertificateThumbprint -Certificate Hash (Thumbprint) - -```yaml -Type: System.String -Parameter Sets: ServicePrincipalCertificateWithSubscriptionId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContextName -Name of the default context from this login. You will be able to select this context by this name after login. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies a PSCredential object. -For more information about the PSCredential object, type Get-Help Get-Credential. -The PSCredential object provides the user ID and password for organizational ID credentials, or the application ID and secret for service principal credentials. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: UserWithSubscriptionId -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: ServicePrincipalWithSubscriptionId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Environment -Environment containing the account to log into - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: EnvironmentName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Overwrite the existing context with the same name, if any. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GraphAccessToken -AccessToken for Graph Service - -```yaml -Type: System.String -Parameter Sets: AccessTokenWithSubscriptionId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Login using managed service identity in the current environment. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ManagedServiceLogin -Aliases: MSI, ManagedService - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyVaultAccessToken -AccessToken for KeyVault Service - -```yaml -Type: System.String -Parameter Sets: AccessTokenWithSubscriptionId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedServiceHostName -Host name for managed service login - -```yaml -Type: System.String -Parameter Sets: ManagedServiceLogin -Aliases: - -Required: False -Position: Named -Default value: localhost -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedServicePort -Port number for managed service login - -```yaml -Type: System.Int32 -Parameter Sets: ManagedServiceLogin -Aliases: - -Required: False -Position: Named -Default value: 50342 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedServiceSecret -Secret, used for some kinds of managed service login. - -```yaml -Type: System.Security.SecureString -Parameter Sets: ManagedServiceLogin -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user. - -```yaml -Type: Microsoft.Azure.Commands.Profile.Common.ContextModificationScope -Parameter Sets: (All) -Aliases: -Accepted values: Process, CurrentUser - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServicePrincipal -Indicates that this account authenticates by providing service principal credentials. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ServicePrincipalCertificateWithSubscriptionId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ServicePrincipalWithSubscriptionId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipContextPopulation -Skips context population if no contexts are found. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipValidation -Skip validation for access token - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: AccessTokenWithSubscriptionId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subscription -Subscription Name or ID - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: SubscriptionName, SubscriptionId - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TenantId -Optional domain name or tenant ID. Domain name will not work in all sign-in situations. For Cloud Solution Provider (CSP) sign-in, tenant ID is required. - -```yaml -Type: System.String -Parameter Sets: UserWithSubscriptionId, AccessTokenWithSubscriptionId, ManagedServiceLogin -Aliases: Domain - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ServicePrincipalWithSubscriptionId, ServicePrincipalCertificateWithSubscriptionId -Aliases: Domain - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: Subscription (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Profile.Models.PSAzureProfile - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Profile/Disable-AzureRmContextAutosave.md b/azurermps-6.13.0/AzureRM.Profile/Disable-AzureRmContextAutosave.md deleted file mode 100644 index 4428f85b7a..0000000000 --- a/azurermps-6.13.0/AzureRM.Profile/Disable-AzureRmContextAutosave.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml -Module Name: AzureRM.Profile -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.profile/disable-azurermcontextautosave -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Disable-AzureRmContextAutosave.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Disable-AzureRmContextAutosave.md ---- - -# Disable-AzureRmContextAutosave - -## SYNOPSIS -Turn off autosaving Azure credentials. Your login information will be forgotten the next time you open a PowerShell window - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Disable-AzureRmContextAutosave [-Scope <ContextModificationScope>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Turn off autosaving Azure credentials. Your login information will be forgotten the next time you open a PowerShell window - -## EXAMPLES - -### Disable autosaving the context -``` -PS C:\> Disable-AzureRmContextAutosave -``` - -Disable autosave for the current user. - -## PARAMETERS - -### -DefaultProfile -The credentials, tenant and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user - -```yaml -Type: Microsoft.Azure.Commands.Profile.Common.ContextModificationScope -Parameter Sets: (All) -Aliases: -Accepted values: Process, CurrentUser - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Common.Authentication.ContextAutosaveSettings - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Profile/Disable-AzureRmDataCollection.md b/azurermps-6.13.0/AzureRM.Profile/Disable-AzureRmDataCollection.md deleted file mode 100644 index 4037d8a27c..0000000000 --- a/azurermps-6.13.0/AzureRM.Profile/Disable-AzureRmDataCollection.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml -Module Name: AzureRM.Profile -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.profile/disable-azurermdatacollection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Disable-AzureRmDataCollection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Disable-AzureRmDataCollection.md ---- - -# Disable-AzureRmDataCollection - -## SYNOPSIS -Opts out of collecting data to improve the AzurePowerShell cmdlets. -Data is not collected unless you explicitly opt in. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Disable-AzureRmDataCollection [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -You can improve the experience of using the Microsoft Cloud and Azure PowerShell by opting in to data collection. -Azure PowerShell does not collect data without your consent - you must explicitly opt in by executing Enable-AzureRmDataCollection, or by answering yes when Azure PowerShell prompts you about collecting data the first time you execute a cmdlet. -Microsoft aggregates collected data to identify patterns of usage, to identify common issues and to improve the experience of using Azure PowerShell. -Microsoft Azure PowerShell does not collect any private data, or any personally identifiable information. -Run the Disable-AzureRMDataCollection cmdlet to disable data collection for the current user. -This will prevent the current user from being prompted about data collection the first time cmdlets are executed. -To enable data collection for the current user, run the Enable-AzureRmDataCollection cmdlet. - -## EXAMPLES - -### Example 1: Disabling data collection for the current user -``` -PS C:\> Disable-AzureRmDataCollection -``` - -This example shows how to disable data collection for the current user. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Enable-AzureRmDataCollection](./Enable-AzureRmDataCollection.md) - diff --git a/azurermps-6.13.0/AzureRM.Profile/Disconnect-AzureRmAccount.md b/azurermps-6.13.0/AzureRM.Profile/Disconnect-AzureRmAccount.md deleted file mode 100644 index a1a1c6bcb6..0000000000 --- a/azurermps-6.13.0/AzureRM.Profile/Disconnect-AzureRmAccount.md +++ /dev/null @@ -1,247 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml -Module Name: AzureRM.Profile -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.profile/remove-azurermaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Disconnect-AzureRmAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Disconnect-AzureRmAccount.md ---- - -# Disconnect-AzureRmAccount - -## SYNOPSIS -Disconnects a connected Azure account and removes all credentials and contexts associated with that account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ContextName (Default) -``` -Disconnect-AzureRmAccount [-ContextName <String>] [-Scope <ContextModificationScope>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### UserId -``` -Disconnect-AzureRmAccount [-Username] <String> [-Scope <ContextModificationScope>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ServicePrincipal -``` -Disconnect-AzureRmAccount -ApplicationId <String> -TenantId <String> [-Scope <ContextModificationScope>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### AccountObject -``` -Disconnect-AzureRmAccount [-InputObject] <PSAzureRmAccount> [-Scope <ContextModificationScope>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ContextObject -``` -Disconnect-AzureRmAccount [-AzureContext] <PSAzureContext> [-Scope <ContextModificationScope>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Disconnect-AzureRmAccount cmdlet disconnects a connected Azure account and removes all credentials and contexts (subscription and tenant information) associated with that account. -After executing this cmdlet, you will need to login again using Connect-AzureRmAccount. - -## EXAMPLES - -### Logout of the current account -``` -PS C:\> Disconnect-AzureRmAccount -``` - -Logs out of the Azure account associated with the current context. - -### Logout of the account associated with a particular context -``` -PS C:\> Get-AzureRmContext "Work" | Disconnect-AzureRmAccount -Scope CurrentUser -``` - -Logs out the account associated with the given context (named 'Work'). Because this uses the 'CurrentUser' scope, all credentials and contexts will be permanently deleted. - -### Log out a particular user -``` -PS C:\> Disconnect-AzureRmAccount -Username 'user1@contoso.org' -``` - -Logs out the 'user1@contoso.org' user - all credentials and all contexts associated with this user will be removed. - -## PARAMETERS - -### -ApplicationId -ServicePrincipal id (globally unique id) - -```yaml -Type: System.String -Parameter Sets: ServicePrincipal -Aliases: SPN, ServicePrincipal - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AzureContext -Context - -```yaml -Type: Microsoft.Azure.Commands.Profile.Models.PSAzureContext -Parameter Sets: ContextObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ContextName -Name of the context to log out of - -```yaml -Type: System.String -Parameter Sets: ContextName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, tenant and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The account object to remove - -```yaml -Type: Microsoft.Azure.Commands.Profile.Models.PSAzureRmAccount -Parameter Sets: AccountObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Scope -Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user. - -```yaml -Type: Microsoft.Azure.Commands.Profile.Common.ContextModificationScope -Parameter Sets: (All) -Aliases: -Accepted values: Process, CurrentUser - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TenantId -Tenant id (globally unique id) - -```yaml -Type: System.String -Parameter Sets: ServicePrincipal -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Username -User name of the form 'user@contoso.org' - -```yaml -Type: System.String -Parameter Sets: UserId -Aliases: Id, UserId - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not executed. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Profile.Models.PSAzureRmAccount -Parameters: InputObject (ByValue) - -### Microsoft.Azure.Commands.Profile.Models.PSAzureContext -Parameters: AzureContext (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Profile.Models.PSAzureRmAccount - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Profile/Enable-AzureRmContextAutosave.md b/azurermps-6.13.0/AzureRM.Profile/Enable-AzureRmContextAutosave.md deleted file mode 100644 index 272e63fbb9..0000000000 --- a/azurermps-6.13.0/AzureRM.Profile/Enable-AzureRmContextAutosave.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml -Module Name: AzureRM.Profile -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.profile/enable-azurermcontextautosave -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Enable-AzureRmContextAutosave.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Enable-AzureRmContextAutosave.md ---- - -# Enable-AzureRmContextAutosave - -## SYNOPSIS -Allow the azure credential, account and subscription information to be saved and automatically loaded when you open a PowerShell window. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Enable-AzureRmContextAutosave [-Scope <ContextModificationScope>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Allow the azure credential, account and subscription information to be saved and automatically loaded when you open a PowerShell window. - -## EXAMPLES - -### Enable autosaving credentials for the current user -``` -PS C:\> Enable-AzureRmContextAutosave -``` - -Turn on credential autosave for the current user. Whenever a powershell window is opened, your current context will be remembered without logging in. - -## PARAMETERS - -### -DefaultProfile -The credentials, tenant and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user - -```yaml -Type: Microsoft.Azure.Commands.Profile.Common.ContextModificationScope -Parameter Sets: (All) -Aliases: -Accepted values: Process, CurrentUser - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Common.Authentication.ContextAutosaveSettings - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Profile/Enable-AzureRmDataCollection.md b/azurermps-6.13.0/AzureRM.Profile/Enable-AzureRmDataCollection.md deleted file mode 100644 index ff0f92a195..0000000000 --- a/azurermps-6.13.0/AzureRM.Profile/Enable-AzureRmDataCollection.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml -Module Name: AzureRM.Profile -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.profile/enable-azurermdatacollection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Enable-AzureRmDataCollection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Enable-AzureRmDataCollection.md ---- - -# Enable-AzureRmDataCollection - -## SYNOPSIS -Enables Azure PowerShell to collect data to improve the user experience with AzurePowerShell cmdlets. -Executing this cmdlet opts in to data collection for the current user on the current machine. -No data is collected unless you explicitly opt in. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Enable-AzureRmDataCollection [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -You can improve the experience of using the Microsoft Cloud and Azure PowerShell by opting in to data collection. -Azure PowerShell does not collect data without your consent - you must explicitly opt in by executing Enable-AzureRmDataCollection, or by answering yes when Azure PowerShell prompts you about collecting data the first time you execute a cmdlet. -Microsoft aggregates collected data to identify patterns of usage, to identify common issues and to improve the experience of using Azure PowerShell. -Microsoft Azure PowerShell does not collect any private data, or any personally identifiable information. -Run the Enable-AzureRMDataCollection cmdlet to enable data collection for the current user on the current machine. -This will prevent the current user from being prompted about data collection the first time cmdlets are executed. -To disable data collection for the current user, run the Disable-AzureRmDataCollection cmdlet. - -## EXAMPLES - -### Example 1: Enabling data collection for the current user -``` -PS C:\> Enable-AzureRmDataCollection -``` - -This example shows how to enable data collection for the current user. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Disable-AzureRmDataCollection](./Disable-AzureRmDataCollection.md) - diff --git a/azurermps-6.13.0/AzureRM.Profile/Get-AzureRmContext.md b/azurermps-6.13.0/AzureRM.Profile/Get-AzureRmContext.md deleted file mode 100644 index d894ea3c9a..0000000000 --- a/azurermps-6.13.0/AzureRM.Profile/Get-AzureRmContext.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml -Module Name: AzureRM.Profile -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.profile/get-azurermcontext -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Get-AzureRmContext.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Get-AzureRmContext.md ---- - -# Get-AzureRmContext - -## SYNOPSIS -Gets the metadata used to authenticate Azure Resource Manager requests. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetSingleContext (Default) -``` -Get-AzureRmContext [-DefaultProfile <IAzureContextContainer>] [[-Name] <String>] [<CommonParameters>] -``` - -### ListAllContexts -``` -Get-AzureRmContext [-ListAvailable] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmContext cmdlet gets the current metadata used to authenticate Azure Resource Manager requests. -This cmdlet gets the Active Directory account, Active Directory tenant, Azure subscription, and the targeted Azure environment. -Azure Resource Manager cmdlets use these settings by default when making Azure Resource Manager requests. - -## EXAMPLES - -### Example 1: Getting the current context -``` -PS C:\> Connect-AzureRmAccount -PS C:\> Get-AzureRmContext - -Name Account SubscriptionName Environment TenantId ----- ------- ---------------- ----------- -------- -Subscription1 (xxxxxxxx-xxxx-xxxx-xxx... test@outlook.com Subscription1 AzureCloud xxxxxxxx-x... -``` - -In this example we are logging into our account with an Azure subscription using Connect-AzureRmAccount, and then we are getting the context of the current session by calling Get-AzureRmContext. - -### Example 2: Listing all available contexts -``` -PS C:\> Get-AzureRmContext -ListAvailable - -Name Account SubscriptionName Environment TenantId ----- ------- ---------------- ----------- -------- -Subscription1 (xxxxxxxx-xxxx-xxxx-xxx... test@outlook.com Subscription1 AzureCloud xxxxxxxx-x... -Subscription2 (xxxxxxxx-xxxx-xxxx-xxx... test@outlook.com Subscription2 AzureCloud xxxxxxxx-x... -Subscription3 (xxxxxxxx-xxxx-xxxx-xxx... test@outlook.com Subscription3 AzureCloud xxxxxxxx-x... -``` - -In this example, all currently available contexts are displayed. The user may select one of these contexts using Select-AzureRmContext. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ListAvailable -List all available contexts in the current session. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ListAllContexts -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the context - -```yaml -Type: System.String -Parameter Sets: GetSingleContext -Aliases: -Accepted values: Default - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Profile.Models.PSAzureContext - -## NOTES - -## RELATED LINKS - -[Set-AzureRMContext](./Set-AzureRMContext.md) - diff --git a/azurermps-6.13.0/AzureRM.Profile/Get-AzureRmContextAutosaveSetting.md b/azurermps-6.13.0/AzureRM.Profile/Get-AzureRmContextAutosaveSetting.md deleted file mode 100644 index 54b1271872..0000000000 --- a/azurermps-6.13.0/AzureRM.Profile/Get-AzureRmContextAutosaveSetting.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml -Module Name: AzureRM.Profile -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.profile/get-azurermcontextautosavesetting -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Get-AzureRmContextAutosaveSetting.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Get-AzureRmContextAutosaveSetting.md ---- - -# Get-AzureRmContextAutosaveSetting - -## SYNOPSIS -Display metadata about the context autosave feature, including whether the context is -automatically saved, and where saved context and credential information can be found. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmContextAutosaveSetting [-Scope <ContextModificationScope>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Display metadata about the context autosave feature, including whether the context is -automatically saved, and where saved context and credential information can be found. - -## EXAMPLES - -### Get context save metadata for the current session -``` -PS C:\> Get-AzureRmContextAutosaveSetting - -Mode : Process -ContextDirectory : None -ContextFile : None -CacheDirectory : None -CacheFile : None -Settings : {} -``` - -Get details about whether and wehere the context is saved. In the above example, the autosave feature has been disabled. - -### Get context save metadata for the current user -``` -PS C:\> Get-AzureRmContextAutosaveSetting -Scope CurrentUser - -Mode : CurrentUser -ContextDirectory : C:\Users\contoso\AppData\Roaming\Windows Azure Powershell -ContextFile : AzureRmContext.json -CacheDirectory : C:\Users\contoso\AppData\Roaming\Windows Azure Powershell -CacheFile : TokenCache.dat -Settings : {} -``` - -Get details about whether and wehere the context is saved by default for the current user. Note that this may be different than -the settings that are active in the current session. In the above example, the autosave feature has been enabled, and data is saved -to the default location. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user. - -```yaml -Type: Microsoft.Azure.Commands.Profile.Common.ContextModificationScope -Parameter Sets: (All) -Aliases: -Accepted values: Process, CurrentUser - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Common.Authentication.ContextAutosaveSettings - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Profile/Get-AzureRmDefault.md b/azurermps-6.13.0/AzureRM.Profile/Get-AzureRmDefault.md deleted file mode 100644 index c258d10503..0000000000 --- a/azurermps-6.13.0/AzureRM.Profile/Get-AzureRmDefault.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml -Module Name: AzureRM.Profile -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.profile/get-azurermdefault -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Get-AzureRmDefault.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Get-AzureRmDefault.md ---- - -# Get-AzureRmDefault - -## SYNOPSIS -Get the defaults set by the user in the current context. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmDefault [-ResourceGroup] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmDefault cmdlet gets the Resource Group that the -user has set as default in the current context. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmDefault - -Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup -Name : myResourceGroup -Properties : Microsoft.Azure.Management.Internal.Resources.Models.ResourceGroupProperties -Location : eastus -ManagedBy : -Tags : -``` - -This command returns the current defaults if there are defaults set, or returns nothing if no default is set. - -### Example 2 -``` -PS C:\> Get-AzureRmDefault -ResourceGroup - -Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup -Name : myResourceGroup -Properties : Microsoft.Azure.Management.Internal.Resources.Models.ResourceGroupProperties -Location : eastus -ManagedBy : -Tags : -``` - -This command returns the current default Resource Group if there is a default set, or returns nothing if no default is set. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroup -Display Default Resource Group - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Profile.Models.PSResourceGroup - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Profile/Get-AzureRmEnvironment.md b/azurermps-6.13.0/AzureRM.Profile/Get-AzureRmEnvironment.md deleted file mode 100644 index 5504a88ea8..0000000000 --- a/azurermps-6.13.0/AzureRM.Profile/Get-AzureRmEnvironment.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml -Module Name: AzureRM.Profile -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.profile/get-azurermenvironment -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Get-AzureRmEnvironment.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Get-AzureRmEnvironment.md ---- - -# Get-AzureRmEnvironment - -## SYNOPSIS -Get endpoints and metadata for an instance of Azure services. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmEnvironment [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmEnvironment cmdlet gets endpoints and metadata for an instance of Azure services. - -## EXAMPLES - -### Example 1: Getting the AzureCloud environment -``` -PS C:\> Get-AzureRmEnvironment AzureCloud - -Name Resource Manager Url ActiveDirectory Authority ----- -------------------- ------------------------- -AzureCloud https://management.azure.com/ https://login.microsoftonline.com/ -``` - -This example shows how to get the endpoints and metadata for the AzureCloud (default) environment. - -### Example 2: Getting the AzureChinaCloud environment -``` -PS C:\> Get-AzureRmEnvironment AzureChinaCloud | Format-List - -Name : AzureChinaCloud -EnableAdfsAuthentication : False -ActiveDirectoryServiceEndpointResourceId : https://management.core.chinacloudapi.cn/ -AdTenant : -GalleryUrl : https://gallery.chinacloudapi.cn/ -ManagementPortalUrl : https://go.microsoft.com/fwlink/?LinkId=301902 -ServiceManagementUrl : https://management.core.chinacloudapi.cn/ -PublishSettingsFileUrl : https://go.microsoft.com/fwlink/?LinkID=301776 -ResourceManagerUrl : https://management.chinacloudapi.cn/ -SqlDatabaseDnsSuffix : .database.chinacloudapi.cn -StorageEndpointSuffix : core.chinacloudapi.cn -ActiveDirectoryAuthority : https://login.chinacloudapi.cn/ -GraphUrl : https://graph.chinacloudapi.cn/ -GraphEndpointResourceId : https://graph.chinacloudapi.cn/ -TrafficManagerDnsSuffix : trafficmanager.cn -AzureKeyVaultDnsSuffix : vault.azure.cn -AzureDataLakeStoreFileSystemEndpointSuffix : -AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix : -AzureKeyVaultServiceEndpointResourceId : https://vault.azure.cn -``` - -This example shows how to get the endpoints and metadata for the AzureChinaCloud environment. - -### Example 3: Getting the AzureUSGovernment environment -``` -PS C:\> Get-AzureRmEnvironment AzureUSGovernment - -Name Resource Manager Url ActiveDirectory Authority ----- -------------------- ------------------------- -AzureUSGovernment https://management.usgovcloudapi.net/ https://login.microsoftonline.us/ -``` - -This example shows how to get the endpoints and metadata for the AzureUSGovernment environment. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Azure instance to get. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Profile.Models.PSAzureEnvironment - -## NOTES - -## RELATED LINKS - -[Add-AzureRMEnvironment](./Add-AzureRMEnvironment.md) - -[Remove-AzureRMEnvironment](./Remove-AzureRMEnvironment.md) - -[Set-AzureRMEnvironment](./Set-AzureRMEnvironment.md) - diff --git a/azurermps-6.13.0/AzureRM.Profile/Get-AzureRmSubscription.md b/azurermps-6.13.0/AzureRM.Profile/Get-AzureRmSubscription.md deleted file mode 100644 index bb6eb5c3b7..0000000000 --- a/azurermps-6.13.0/AzureRM.Profile/Get-AzureRmSubscription.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml -Module Name: AzureRM.Profile -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.profile/get-azurermsubscription -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Get-AzureRmSubscription.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Get-AzureRmSubscription.md ---- - -# Get-AzureRmSubscription - -## SYNOPSIS -Get subscriptions that the current account can access. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ListByIdInTenant (Default) -``` -Get-AzureRmSubscription [-SubscriptionId <String>] [-TenantId <String>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ListByNameInTenant -``` -Get-AzureRmSubscription [-SubscriptionName <String>] [-TenantId <String>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmSubscription cmdlet gets the subscription ID, subscription -name, and home tenant for subscriptions that the current account can -access. - -## EXAMPLES - -### Example 1: Get all subscriptions in all tenants -``` -PS C:\>Get-AzureRmSubscription - -Name Id TenantId State ----- -- -------- ----- -Subscription1 yyyy-yyyy-yyyy-yyyy aaaa-aaaa-aaaa-aaaa Enabled -Subscription2 xxxx-xxxx-xxxx-xxxx aaaa-aaaa-aaaa-aaaa Enabled -Subscription3 zzzz-zzzz-zzzz-zzzz bbbb-bbbb-bbbb-bbbb Enabled -``` - -This command gets all subscriptions in all tenants that are authorized for -the current account. - -### Example 2: Get all subscriptions for a specific tenant -``` -PS C:\>Get-AzureRmSubscription -TenantId "xxxx-xxxx-xxxx-xxxx" - -Name Id TenantId State ----- -- -------- ----- -Subscription1 yyyy-yyyy-yyyy-yyyy aaaa-aaaa-aaaa-aaaa Enabled -Subscription2 xxxx-xxxx-xxxx-xxxx aaaa-aaaa-aaaa-aaaa Enabled -``` - -List all subscriptions in the given tenant that are authorized for the -current account. - -### Example 3: Get all subscriptions in the current tenant -``` -PS C:\>Get-AzureRmSubscription - -Name Id TenantId State ----- -- -------- ----- -Subscription1 yyyy-yyyy-yyyy-yyyy aaaa-aaaa-aaaa-aaaa Enabled -Subscription2 xxxx-xxxx-xxxx-xxxx aaaa-aaaa-aaaa-aaaa Enabled -``` - -This command gets all subscriptions in the current tenant that are -authorized for the current user. - -### Example 4: Change the current context to use a specific subscription -``` -PS C:\>Get-AzureRmSubscription -SubscriptionId "xxxx-xxxx-xxxx-xxxx" -TenantId "yyyy-yyyy-yyyy-yyyy" | Set-AzureRmContext - -Name Account SubscriptionName Environment TenantId ----- ------- ---------------- ----------- -------- -Subscription1 (xxxx-xxxx-xxxx-xxxx) azureuser@micros... Subscription1 AzureCloud yyyy-yyyy-yyyy-yyyy -``` - -This command gets the specified subscription, and then sets the current -context to use it. All subsequent cmdlets in this session use the new -subscription (Contoso Subscription 1) by default. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, tenant and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Specifies the ID of the subscription to get. - -```yaml -Type: System.String -Parameter Sets: ListByIdInTenant -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubscriptionName -Specifies the name of the subscription to get. - -```yaml -Type: System.String -Parameter Sets: ListByNameInTenant -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TenantId -Specifies the ID of the tenant that contains subscriptions to get. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Profile.Models.PSAzureSubscription - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Profile/Get-AzureRmTenant.md b/azurermps-6.13.0/AzureRM.Profile/Get-AzureRmTenant.md deleted file mode 100644 index 4ef064c93a..0000000000 --- a/azurermps-6.13.0/AzureRM.Profile/Get-AzureRmTenant.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml -Module Name: AzureRM.Profile -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.profile/get-azurermtenant -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Get-AzureRmTenant.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Get-AzureRmTenant.md ---- - -# Get-AzureRmTenant - -## SYNOPSIS -Gets tenants that are authorized for the current user. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmTenant [[-TenantId] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmTenant cmdlet gets tenants authorized for the current user. - -## EXAMPLES - -### Example 1: Getting all tenants -``` -PS C:\> Connect-AzureRmAccount -PS C:\> Get-AzureRmTenant - -Id Directory --- --------- -xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx microsoft.com -yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy microsoft.com -``` - -This example shows how to get all of the authorized tenants of an Azure account. - -### Example 2: Getting a specific tenant -``` -PS C:\> Connect-AzureRmAccount -PS C:\> Get-AzureRmTenant -TenantId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx - -Id Directory --- --------- -xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx microsoft.com -``` - -This example shows how to get a specific authorized tenant of an Azure account. - -## PARAMETERS - -### -DefaultProfile -The credentials, tenant and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TenantId -Specifies the ID of the tenant that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Domain, Tenant - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Profile.Models.PSAzureTenant - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Profile/Import-AzureRmContext.md b/azurermps-6.13.0/AzureRM.Profile/Import-AzureRmContext.md deleted file mode 100644 index 694fa5e62c..0000000000 --- a/azurermps-6.13.0/AzureRM.Profile/Import-AzureRmContext.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml -Module Name: AzureRM.Profile -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.profile/import-azurermcontext -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Import-AzureRmContext.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Import-AzureRmContext.md ---- - -# Import-AzureRmContext - -## SYNOPSIS -Loads Azure authentication information from a file. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ProfileFromDisk (Default) -``` -Import-AzureRmContext [-Path] <String> [-Scope <ContextModificationScope>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InMemoryProfile -``` -Import-AzureRmContext [-AzureContext] <AzureRmProfile> [-Scope <ContextModificationScope>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Import-AzureRmContext cmdlet loads authentication information from a file to set the Azure environment and context. -Cmdlets that you run in the current session use this information to authenticate requests to Azure Resource Manager. - -## EXAMPLES - -### Example 1: Importing a context from a AzureRmProfile -``` -PS C:\> Import-AzureRmContext -AzureContext (Connect-AzureRmAccount) - -Account SubscriptionName TenantId Environment -------- ---------------- -------- ----------- -azureuser@contoso.com Subscription1 xxxx-xxxx-xxxx-xxxx AzureCloud -``` - -This example imports a context from a PSAzureProfile that is passed through to the cmdlet. - -### Example 2: Importing a context from a JSON file -``` -PS C:\> Import-AzureRmContext -Path C:\test.json - -Account SubscriptionName TenantId Environment -------- ---------------- -------- ----------- -azureuser@contoso.com Subscription1 xxxx-xxxx-xxxx-xxxx AzureCloud -``` - -This example selects a context from a JSON file that is passed through to the cmdlet. This JSON file can be created from Save-AzureRmContext. - -## PARAMETERS - -### -AzureContext -Specifies the Azure context from which this cmdlet reads. If you do not specify a context, this cmdlet reads from the local default context. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Models.AzureRmProfile -Parameter Sets: InMemoryProfile -Aliases: Profile - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path to context information saved by using Save-AzureRMContext. - -```yaml -Type: System.String -Parameter Sets: ProfileFromDisk -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Scope -Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user. - -```yaml -Type: Microsoft.Azure.Commands.Profile.Common.ContextModificationScope -Parameter Sets: (All) -Aliases: -Accepted values: Process, CurrentUser - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Common.Authentication.Models.AzureRmProfile - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Profile.Models.PSAzureProfile - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Profile/Remove-AzureRmContext.md b/azurermps-6.13.0/AzureRM.Profile/Remove-AzureRmContext.md deleted file mode 100644 index d4141be434..0000000000 --- a/azurermps-6.13.0/AzureRM.Profile/Remove-AzureRmContext.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml -Module Name: AzureRM.Profile -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.profile/remove-azurermcontext -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Remove-AzureRmContext.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Remove-AzureRmContext.md ---- - -# Remove-AzureRmContext - -## SYNOPSIS -Remove a context from the set of available contexts - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RemoveByInputObject (Default) -``` -Remove-AzureRmContext -InputObject <PSAzureContext> [-Force] [-PassThru] [-Scope <ContextModificationScope>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RemoveByName -``` -Remove-AzureRmContext [-Force] [-PassThru] [-Scope <ContextModificationScope>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-Name] <String> [<CommonParameters>] -``` - -## DESCRIPTION -Remove an azure context from the set of contexts - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmContext -Name Default -``` - -Remove the context named default - -## PARAMETERS - -### -DefaultProfile -The credentials, tenant and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Remove context even if it is the defualt - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -A context object, normally passed through the pipeline. - -```yaml -Type: Microsoft.Azure.Commands.Profile.Models.PSAzureContext -Parameter Sets: RemoveByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the context - -```yaml -Type: System.String -Parameter Sets: RemoveByName -Aliases: -Accepted values: Default - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Return the removed context - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user - -```yaml -Type: Microsoft.Azure.Commands.Profile.Common.ContextModificationScope -Parameter Sets: (All) -Aliases: -Accepted values: Process, CurrentUser - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Profile.Models.PSAzureContext -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Profile.Models.PSAzureContext - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Profile/Remove-AzureRmEnvironment.md b/azurermps-6.13.0/AzureRM.Profile/Remove-AzureRmEnvironment.md deleted file mode 100644 index 916a51a364..0000000000 --- a/azurermps-6.13.0/AzureRM.Profile/Remove-AzureRmEnvironment.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml -Module Name: AzureRM.Profile -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.profile/remove-azurermenvironment -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Remove-AzureRmEnvironment.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Remove-AzureRmEnvironment.md ---- - -# Remove-AzureRmEnvironment - -## SYNOPSIS -Removes endpoints and metadata for connecting to a given Azure instance. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmEnvironment [-Name] <String> [-Scope <ContextModificationScope>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmEnvironment cmdlet removes endpoints and metadata information for connecting to a given Azure instance. - -## EXAMPLES - -### Example 1: Creating and removing a test environment -``` -PS C:\> Add-AzureRmEnvironment -Name TestEnvironment ` - -ActiveDirectoryEndpoint TestADEndpoint ` - -ActiveDirectoryServiceEndpointResourceId TestADApplicationId ` - -ResourceManagerEndpoint TestRMEndpoint ` - -GalleryEndpoint TestGalleryEndpoint ` - -GraphEndpoint TestGraphEndpoint - -Name Resource Manager Url ActiveDirectory Authority ----- -------------------- ------------------------- -TestEnvironment TestRMEndpoint TestADEndpoint/ - -PS C:\> Remove-AzureRmEnvironment -Name TestEnvironment - -Name Resource Manager Url ActiveDirectory Authority ----- -------------------- ------------------------- -TestEnvironment TestRMEndpoint TestADEndpoint/ -``` - -This example shows how to create an environment using Add-AzureRmEnvironment, and then how to delete the environment using Remove-AzureRmEnvironment. - -## PARAMETERS - -### -DefaultProfile -The credentials, tenant and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the environment to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Scope -Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user. - -```yaml -Type: Microsoft.Azure.Commands.Profile.Common.ContextModificationScope -Parameter Sets: (All) -Aliases: -Accepted values: Process, CurrentUser - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Profile.Models.PSAzureEnvironment - -## NOTES - -## RELATED LINKS - -[Add-AzureRMEnvironment](./Add-AzureRMEnvironment.md) - -[Get-AzureRMEnvironment](./Get-AzureRMEnvironment.md) - -[Set-AzureRMEnvironment](./Set-AzureRMEnvironment.md) - diff --git a/azurermps-6.13.0/AzureRM.Profile/Rename-AzureRmContext.md b/azurermps-6.13.0/AzureRM.Profile/Rename-AzureRmContext.md deleted file mode 100644 index 446e6f4768..0000000000 --- a/azurermps-6.13.0/AzureRM.Profile/Rename-AzureRmContext.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml -Module Name: AzureRM.Profile -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.profile/rename-azurermcontext -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Rename-AzureRmContext.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Rename-AzureRmContext.md ---- - -# Rename-AzureRmContext - -## SYNOPSIS -Rename an Azure context. By default contexts are named by user account and subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RenameByInputObject (Default) -``` -Rename-AzureRmContext -InputObject <PSAzureContext> [-Force] [-PassThru] [-Scope <ContextModificationScope>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-TargetName] <String> [<CommonParameters>] -``` - -### RenameByName -``` -Rename-AzureRmContext [-Force] [-PassThru] [-Scope <ContextModificationScope>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-SourceName] <String> [-TargetName] <String> - [<CommonParameters>] -``` - -## DESCRIPTION -Rename an Azure context. By default contexts are named by user account and subscription. - -## EXAMPLES - -### Rename a context using named parameters -``` -PS C:\> Rename-AzureRmContext -SourceName "[user1@contoso.org; 12345-6789-2345-3567890]" -TargetName "Work" -``` - -Rename the context for 'user1@contoso.org' with subscription '12345-6789-2345-3567890' to 'Work'. After this command, you will be able to target the context using -'Select-AzureRmContext Work'. Note that you can tab through the values for 'SourceName' using tab completion. - -### Rename a context using positional parameters -``` -PS C:\> Rename-AzureRmContext "My context" "Work" -``` - -Rename the context named "My context" to "Work". After this command, you will be able to target the context using -Select-AzureRmContext Work - -## PARAMETERS - -### -DefaultProfile -The credentials, tenant and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Rename the context even if the target context already exists - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -A context object, normally passed through the pipeline. - -```yaml -Type: Microsoft.Azure.Commands.Profile.Models.PSAzureContext -Parameter Sets: RenameByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Return the renamed context. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user - -```yaml -Type: Microsoft.Azure.Commands.Profile.Common.ContextModificationScope -Parameter Sets: (All) -Aliases: -Accepted values: Process, CurrentUser - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceName -The name of the context - -```yaml -Type: System.String -Parameter Sets: RenameByName -Aliases: -Accepted values: Default - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetName -The new name of the context - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Profile.Models.PSAzureContext -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Profile.Models.PSAzureContext - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Profile/Resolve-AzureRmError.md b/azurermps-6.13.0/AzureRM.Profile/Resolve-AzureRmError.md deleted file mode 100644 index 16bcce65d7..0000000000 --- a/azurermps-6.13.0/AzureRM.Profile/Resolve-AzureRmError.md +++ /dev/null @@ -1,238 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml -Module Name: AzureRM.Profile -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.profile/resolve-azurermerror -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Resolve-AzureRmError.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Resolve-AzureRmError.md ---- - -# Resolve-AzureRmError - -## SYNOPSIS -Display detailed information about PowerShell errors, with extended details for Azure PowerShell errors. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### AnyErrorParameterSet (Default) -``` -Resolve-AzureRmError [[-Error] <ErrorRecord[]>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### LastErrorParameterSet -``` -Resolve-AzureRmError [-Last] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Resolves and displays detailed information about errors in the current PowerShell session, including where the error -occurred in script, stack trace, and all inner and aggregate exceptions. For Azure PowerShell errors provides -additional detail in debugging service issues, including complete detail about the request and server response -that caused the error. - -## EXAMPLES - -### Example 1: Resolve the Last Error -``` -PS C:\> Resolve-AzureRmError -Last - - HistoryId: 3 - - -Message : Run Connect-AzureRmAccount to login. -StackTrace : at Microsoft.Azure.Commands.ResourceManager.Common.AzureRMCmdlet.get_DefaultContext() in AzureRmCmdlet.cs:line 85 - at Microsoft.Azure.Commands.ResourceManager.Common.AzureRMCmdlet.LogCmdletStartInvocationInfo() in AzureRmCmdlet.cs:line 269 - at Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet.BeginProcessing() inAzurePSCmdlet.cs:line 299 - at Microsoft.Azure.Commands.ResourceManager.Common.AzureRMCmdlet.BeginProcessing() in AzureRmCmdlet.cs:line 320 - at Microsoft.Azure.Commands.Profile.GetAzureRMSubscriptionCommand.BeginProcessing() in GetAzureRMSubscription.cs:line 49 - at System.Management.Automation.Cmdlet.DoBeginProcessing() - at System.Management.Automation.CommandProcessorBase.DoBegin() -Exception : System.Management.Automation.PSInvalidOperationException -InvocationInfo : {Get-AzureRmSubscription} -Line : Get-AzureRmSubscription -Position : At line:1 char:1 - + Get-AzureRmSubscription - + ~~~~~~~~~~~~~~~~~~~~~~~ -HistoryId : 3 -``` - -Get details of the last error. - -### Example 2: Resolve all Errors in the Session -``` -PS C:\> Resolve-AzureRmError - - - HistoryId: 8 - - -RequestId : b61309e8-09c9-4f0d-ba56-08a6b28c731d -Message : Resource group 'contoso' could not be found. -ServerMessage : ResourceGroupNotFound: Resource group 'contoso' could not be found. - (System.Collections.Generic.List`1[Microsoft.Rest.Azure.CloudError]) -ServerResponse : {NotFound} -RequestMessage : {GET https://management.azure.com/subscriptions/00977cdb-163f-435f-9c32-39ec8ae61f4d/resourceGroups/co - ntoso/providers/Microsoft.Storage/storageAccounts/contoso?api-version=2016-12-01} -InvocationInfo : {Get-AzureRmStorageAccount} -Line : Get-AzureRmStorageAccount -ResourceGroupName contoso -Name contoso -Position : At line:1 char:1 - + Get-AzureRmStorageAccount -ResourceGroupName contoso -Name contoso - + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -StackTrace : at Microsoft.Azure.Management.Storage.StorageAccountsOperations.<GetPropertiesWithHttpMessagesAsync - >d__8.MoveNext() - --- End of stack trace from previous location where exception was thrown --- - at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw() - at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task) - at Microsoft.Azure.Management.Storage.StorageAccountsOperationsExtensions.<GetPropertiesAsync>d__7. - MoveNext() - --- End of stack trace from previous location where exception was thrown --- - at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw() - at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task) - at Microsoft.Azure.Management.Storage.StorageAccountsOperationsExtensions.GetProperties(IStorageAcc - ountsOperations operations, String resourceGroupName, String accountName) - at Microsoft.Azure.Commands.Management.Storage.GetAzureStorageAccountCommand.ExecuteCmdlet() in C:\ - zd\azure-powershell\src\ResourceManager\Storage\Commands.Management.Storage\StorageAccount\GetAzureSto - rageAccount.cs:line 70 - at Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet.ProcessRecord() in - C:\zd\azure-powershell\src\Common\Commands.Common\AzurePSCmdlet.cs:line 642 -HistoryId : 8 - - - HistoryId: 5 - - -Message : Run Connect-AzureRmAccount to login. -StackTrace : at Microsoft.Azure.Commands.ResourceManager.Common.AzureRMCmdlet.get_DefaultContext() in C:\zd\azur - e-powershell\src\ResourceManager\Common\Commands.ResourceManager.Common\AzureRmCmdlet.cs:line 85 - at Microsoft.Azure.Commands.ResourceManager.Common.AzureRMCmdlet.LogCmdletStartInvocationInfo() in - C:\zd\azure-powershell\src\ResourceManager\Common\Commands.ResourceManager.Common\AzureRmCmdlet.cs:lin - e 269 - at Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet.BeginProcessing() in - C:\zd\azure-powershell\src\Common\Commands.Common\AzurePSCmdlet.cs:line 299 - at Microsoft.Azure.Commands.ResourceManager.Common.AzureRMCmdlet.BeginProcessing() in C:\zd\azure-p - owershell\src\ResourceManager\Common\Commands.ResourceManager.Common\AzureRmCmdlet.cs:line 320 - at Microsoft.Azure.Commands.Profile.GetAzureRMSubscriptionCommand.BeginProcessing() in C:\zd\azure- - powershell\src\ResourceManager\Profile\Commands.Profile\Subscription\GetAzureRMSubscription.cs:line 49 - at System.Management.Automation.Cmdlet.DoBeginProcessing() - at System.Management.Automation.CommandProcessorBase.DoBegin() -Exception : System.Management.Automation.PSInvalidOperationException -InvocationInfo : {Get-AzureRmSubscription} -Line : Get-AzureRmSubscription -Position : At line:1 char:1 - + Get-AzureRmSubscription - + ~~~~~~~~~~~~~~~~~~~~~~~ -HistoryId : 5 -``` - -Get details of all errors that have occurred in the current session. - -### Example 3: Resolve a Specific Error -``` -PS C:\> Resolve-AzureRmError $Error[0] - - - HistoryId: 8 - - -RequestId : b61309e8-09c9-4f0d-ba56-08a6b28c731d -Message : Resource group 'contoso' could not be found. -ServerMessage : ResourceGroupNotFound: Resource group 'contoso' could not be found. - (System.Collections.Generic.List`1[Microsoft.Rest.Azure.CloudError]) -ServerResponse : {NotFound} -RequestMessage : {GET https://management.azure.com/subscriptions/00977cdb-163f-435f-9c32-39ec8ae61f4d/resourceGroups/co - ntoso/providers/Microsoft.Storage/storageAccounts/contoso?api-version=2016-12-01} -InvocationInfo : {Get-AzureRmStorageAccount} -Line : Get-AzureRmStorageAccount -ResourceGroupName contoso -Name contoso -Position : At line:1 char:1 - + Get-AzureRmStorageAccount -ResourceGroupName contoso -Name contoso - + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -StackTrace : at Microsoft.Azure.Management.Storage.StorageAccountsOperations.<GetPropertiesWithHttpMessagesAsync - >d__8.MoveNext() - --- End of stack trace from previous location where exception was thrown --- - at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw() - at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task) - at Microsoft.Azure.Management.Storage.StorageAccountsOperationsExtensions.<GetPropertiesAsync>d__7. - MoveNext() - --- End of stack trace from previous location where exception was thrown --- - at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw() - at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task) - at Microsoft.Azure.Management.Storage.StorageAccountsOperationsExtensions.GetProperties(IStorageAcc - ountsOperations operations, String resourceGroupName, String accountName) - at Microsoft.Azure.Commands.Management.Storage.GetAzureStorageAccountCommand.ExecuteCmdlet() in C:\ - zd\azure-powershell\src\ResourceManager\Storage\Commands.Management.Storage\StorageAccount\GetAzureSto - rageAccount.cs:line 70 - at Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet.ProcessRecord() in - C:\zd\azure-powershell\src\Common\Commands.Common\AzurePSCmdlet.cs:line 642 -HistoryId : 8 -``` - -Get details of the specified error. - -## PARAMETERS - -### -DefaultProfile -The credentials, tenant and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Error -One or more error records to resolve. If no parameters are specified, all errors in the session are resolved. - -```yaml -Type: System.Management.Automation.ErrorRecord[] -Parameter Sets: AnyErrorParameterSet -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Last -Resolve only the last error that occurred in the session. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: LastErrorParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Management.Automation.ErrorRecord[] -Parameters: Error (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Profile.Errors.AzureErrorRecord - -### Microsoft.Azure.Commands.Profile.Errors.AzureExceptionRecord - -### Microsoft.Azure.Commands.Profile.Errors.AzureRestExceptionRecord - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Profile/Save-AzureRmContext.md b/azurermps-6.13.0/AzureRM.Profile/Save-AzureRmContext.md deleted file mode 100644 index 260ca5bc10..0000000000 --- a/azurermps-6.13.0/AzureRM.Profile/Save-AzureRmContext.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml -Module Name: AzureRM.Profile -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.profile/save-azurermcontext -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Save-AzureRmContext.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Save-AzureRmContext.md ---- - -# Save-AzureRmContext - -## SYNOPSIS -Saves the current authentication information for use in other PowerShell sessions. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Save-AzureRmContext [[-Profile] <AzureRmProfile>] [-Path] <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Save-AzureRmContext cmdlet saves the current authentication information for use in other PowerShell sessions. - -## EXAMPLES - -### Example 1: Saving the current session's context -``` -PS C:\> Connect-AzureRmAccount -PS C:\> Save-AzureRmContext -Path C:\test.json -``` - -This example saves the current session's Azure context to the JSON file provided. - -### Example 2: Saving a given context -``` -PS C:\> Save-AzureRmContext -Profile (Connect-AzureRmAccount) -Path C:\test.json -``` - -This example saves the Azure context that is passed through to the cmdlet to the JSON file provided. - -## PARAMETERS - -### -DefaultProfile -The credentials, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Overwrite the given file if it exists - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path of the file to which to save authentication information. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Profile -Specifies the Azure context from which this cmdlet reads. -If you do not specify a context, this cmdlet reads from the local default context. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Models.AzureRmProfile -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Common.Authentication.Models.AzureRmProfile -Parameters: Profile (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Profile.Models.PSAzureProfile - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Profile/Select-AzureRmContext.md b/azurermps-6.13.0/AzureRM.Profile/Select-AzureRmContext.md deleted file mode 100644 index 56fc4f095a..0000000000 --- a/azurermps-6.13.0/AzureRM.Profile/Select-AzureRmContext.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml -Module Name: AzureRM.Profile -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.profile/select-azurermcontext -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Select-AzureRmContext.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Select-AzureRmContext.md ---- - -# Select-AzureRmContext - -## SYNOPSIS -Select a subscription and account to target in Azure PowerShell cmdlets - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SelectByInputObject (Default) -``` -Select-AzureRmContext -InputObject <PSAzureContext> [-Scope <ContextModificationScope>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SelectByName -``` -Select-AzureRmContext [-Scope <ContextModificationScope>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [-Name] <String> [<CommonParameters>] -``` - -## DESCRIPTION -Select a subscription to target (or account or tenant) in Azure PowerShell cmdlets. After this cmdlet, future cmdlets will target the -selected context. - -## EXAMPLES - -### Example 1 : Target a named context -``` -PS C:\> Select-AzureRmContext "Work" - -Name Account SubscriptionName Environment TenantId ----- ------- ---------------- ----------- -------- -Work test@outlook.com Subscription1 AzureCloud xxxxxxxx-x... -``` - -Target future Azure PowerShell cmdlets at the account, tenant, and subscription in the 'Work' context. - -## PARAMETERS - -### -DefaultProfile -The credentials, tenant and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -A context object, normally passed through the pipeline. - -```yaml -Type: Microsoft.Azure.Commands.Profile.Models.PSAzureContext -Parameter Sets: SelectByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the context - -```yaml -Type: System.String -Parameter Sets: SelectByName -Aliases: -Accepted values: Default - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user - -```yaml -Type: Microsoft.Azure.Commands.Profile.Common.ContextModificationScope -Parameter Sets: (All) -Aliases: -Accepted values: Process, CurrentUser - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Profile.Models.PSAzureContext -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Profile.Models.PSAzureContext - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Profile/Send-Feedback.md b/azurermps-6.13.0/AzureRM.Profile/Send-Feedback.md deleted file mode 100644 index fc12f6d441..0000000000 --- a/azurermps-6.13.0/AzureRM.Profile/Send-Feedback.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml -Module Name: AzureRM.Profile -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.profile/send-feedback -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Send-Feedback.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Send-Feedback.md ---- - -# Send-Feedback - -## SYNOPSIS -Sends feedback to the Azure PowerShell team via a set of guided prompts. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Send-Feedback [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Send-Feedback cmdlet sends feedback to the Azure PowerShell team. - -## EXAMPLES - -### Example 1: -``` -PS C:\> Send-Feedback - -With zero (0) being the least and ten (10) being the most, how likely are you to recommend Azure PowerShell to a friend or colleague? - -10 - -What does Azure PowerShell do well? - -Response. - -Upon what could Azure PowerShell improve? - -Response. - -Please enter your email if you are interested in providing follow up information: - -your@email.com -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Profile/Set-AzureRmContext.md b/azurermps-6.13.0/AzureRM.Profile/Set-AzureRmContext.md deleted file mode 100644 index 7ba3a730b0..0000000000 --- a/azurermps-6.13.0/AzureRM.Profile/Set-AzureRmContext.md +++ /dev/null @@ -1,294 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml -Module Name: AzureRM.Profile -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.profile/set-azurermcontext -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Set-AzureRmContext.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Set-AzureRmContext.md ---- - -# Set-AzureRmContext - -## SYNOPSIS -Sets the tenant, subscription, and environment for cmdlets to use in the current session. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Context (Default) -``` -Set-AzureRmContext [-Context] <PSAzureContext> - [-ExtendedProperty <System.Collections.Generic.IDictionary`2[System.String,System.String]>] [-Name <String>] - [-Force] [-Scope <ContextModificationScope>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### TenantObject -``` -Set-AzureRmContext [-TenantObject] <PSAzureTenant> - [-ExtendedProperty <System.Collections.Generic.IDictionary`2[System.String,System.String]>] [-Name <String>] - [-Force] [-Scope <ContextModificationScope>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### SubscriptionObject -``` -Set-AzureRmContext [-SubscriptionObject] <PSAzureSubscription> - [-ExtendedProperty <System.Collections.Generic.IDictionary`2[System.String,System.String]>] [-Name <String>] - [-Force] [-Scope <ContextModificationScope>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### Subscription -``` -Set-AzureRmContext [-Tenant <String>] [-Subscription] <String> - [-ExtendedProperty <System.Collections.Generic.IDictionary`2[System.String,System.String]>] [-Name <String>] - [-Force] [-Scope <ContextModificationScope>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### TenantNameOnly -``` -Set-AzureRmContext -Tenant <String> - [-ExtendedProperty <System.Collections.Generic.IDictionary`2[System.String,System.String]>] [-Name <String>] - [-Force] [-Scope <ContextModificationScope>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The Set-AzureRmContext cmdlet sets authentication information for cmdlets that you run in the current session. -The context includes tenant, subscription, and environment information. - -## EXAMPLES - -### Example 1: Set the subscription context -``` -PS C:\>Set-AzureRmContext -SubscriptionId "xxxx-xxxx-xxxx-xxxx" - -Name Account SubscriptionName Environment TenantId ----- ------- ---------------- ----------- -------- -Work test@outlook.com Subscription1 AzureCloud xxxxxxxx-x... -``` - -This command sets the context to use the specified subscription. - -## PARAMETERS - -### -Context -Specifies the context for the current session. - -```yaml -Type: Microsoft.Azure.Commands.Profile.Models.PSAzureContext -Parameter Sets: Context -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedProperty -Additional context properties - -```yaml -Type: System.Collections.Generic.IDictionary`2[System.String,System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Overwrite the existing context with the same name, if any. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the context - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user. - -```yaml -Type: Microsoft.Azure.Commands.Profile.Common.ContextModificationScope -Parameter Sets: (All) -Aliases: -Accepted values: Process, CurrentUser - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subscription -The name or id of the subscription that the context should be set to. This parameter has aliases to -SubscriptionName and -SubscriptionId, so, for clarity, either of these can be used instead of -Subscription when specifying name and id, respectively. - -```yaml -Type: System.String -Parameter Sets: Subscription -Aliases: SubscriptionId, SubscriptionName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionObject -A subscription object - -```yaml -Type: Microsoft.Azure.Commands.Profile.Models.PSAzureSubscription -Parameter Sets: SubscriptionObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Tenant -Tenant name or ID - -```yaml -Type: System.String -Parameter Sets: Subscription -Aliases: Domain, TenantId - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: TenantNameOnly -Aliases: Domain, TenantId - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TenantObject -A Tenant Object - -```yaml -Type: Microsoft.Azure.Commands.Profile.Models.PSAzureTenant -Parameter Sets: TenantObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Profile.Models.PSAzureContext -Parameters: Context (ByValue) - -### Microsoft.Azure.Commands.Profile.Models.PSAzureTenant -Parameters: TenantObject (ByValue) - -### Microsoft.Azure.Commands.Profile.Models.PSAzureSubscription -Parameters: SubscriptionObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Profile.Models.PSAzureContext - -## NOTES - -## RELATED LINKS - -[Get-AzureRMContext](./Get-AzureRMContext.md) - diff --git a/azurermps-6.13.0/AzureRM.Profile/Set-AzureRmDefault.md b/azurermps-6.13.0/AzureRM.Profile/Set-AzureRmDefault.md deleted file mode 100644 index 353b15712c..0000000000 --- a/azurermps-6.13.0/AzureRM.Profile/Set-AzureRmDefault.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml -Module Name: AzureRM.Profile -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.profile/set-azurermdefault -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Set-AzureRmDefault.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Set-AzureRmDefault.md ---- - -# Set-AzureRmDefault - -## SYNOPSIS -Sets a default in the current context - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmDefault [-ResourceGroupName <String>] [-Force] [-Scope <ContextModificationScope>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Set-AzureRmDefault cmdlet adds or changes the defaults in the current context. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Set-AzureRmDefault -ResourceGroupName myResourceGroup - -Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup -Name : myResourceGroup -Properties : Microsoft.Azure.Management.Internal.Resources.Models.ResourceGroupProperties -Location : eastus -ManagedBy : -Tags : -``` - -This command sets the default resource group to the resource group specified by the user. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Create a new resource group if specified default does not exist - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group being set as default - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Scope -Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user. - -```yaml -Type: Microsoft.Azure.Commands.Profile.Common.ContextModificationScope -Parameter Sets: (All) -Aliases: -Accepted values: Process, CurrentUser - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Profile.Models.PSResourceGroup - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Profile/Set-AzureRmEnvironment.md b/azurermps-6.13.0/AzureRM.Profile/Set-AzureRmEnvironment.md deleted file mode 100644 index 1379ff6911..0000000000 --- a/azurermps-6.13.0/AzureRM.Profile/Set-AzureRmEnvironment.md +++ /dev/null @@ -1,553 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml -Module Name: AzureRM.Profile -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.profile/set-azurermenvironment -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Set-AzureRmEnvironment.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Profile/Commands.Profile/help/Set-AzureRmEnvironment.md ---- - -# Set-AzureRmEnvironment - -## SYNOPSIS -Sets properties for an Azure environment. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Name (Default) -``` -Set-AzureRmEnvironment [-Name] <String> [[-PublishSettingsFileUrl] <String>] [[-ServiceEndpoint] <String>] - [[-ManagementPortalUrl] <String>] [[-StorageEndpoint] <String>] [[-ActiveDirectoryEndpoint] <String>] - [[-ResourceManagerEndpoint] <String>] [[-GalleryEndpoint] <String>] - [[-ActiveDirectoryServiceEndpointResourceId] <String>] [[-GraphEndpoint] <String>] - [[-AzureKeyVaultDnsSuffix] <String>] [[-AzureKeyVaultServiceEndpointResourceId] <String>] - [[-TrafficManagerDnsSuffix] <String>] [[-SqlDatabaseDnsSuffix] <String>] - [[-AzureDataLakeStoreFileSystemEndpointSuffix] <String>] - [[-AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix] <String>] [-EnableAdfsAuthentication] - [[-AdTenant] <String>] [[-GraphAudience] <String>] [[-DataLakeAudience] <String>] - [[-BatchEndpointResourceId] <String>] [[-AzureOperationalInsightsEndpointResourceId] <String>] - [[-AzureOperationalInsightsEndpoint] <String>] [[-AzureAnalysisServicesEndpointSuffix] <String>] [-Scope <ContextModificationScope>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ARMEndpoint -``` -Set-AzureRmEnvironment [-Name] <String> [[-StorageEndpoint] <String>] [-ARMEndpoint] <String> - [[-AzureKeyVaultDnsSuffix] <String>] [[-AzureKeyVaultServiceEndpointResourceId] <String>] - [[-DataLakeAudience] <String>] [[-BatchEndpointResourceId] <String>] - [[-AzureOperationalInsightsEndpointResourceId] <String>] [[-AzureOperationalInsightsEndpoint] <String>] - [-Scope <ContextModificationScope>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The Set-AzureRMEnvironment cmdlet sets endpoints and metadata for connecting to an instance of Azure. - -## EXAMPLES - -### Example 1: Creating and modifying a new environment -``` -PS C:\> Add-AzureRmEnvironment -Name TestEnvironment ` - -ActiveDirectoryEndpoint TestADEndpoint ` - -ActiveDirectoryServiceEndpointResourceId TestADApplicationId ` - -ResourceManagerEndpoint TestRMEndpoint ` - -GalleryEndpoint TestGalleryEndpoint ` - -GraphEndpoint TestGraphEndpoint - -Name Resource Manager Url ActiveDirectory Authority ----- -------------------- ------------------------- -TestEnvironment TestRMEndpoint TestADEndpoint/ - -PS C:\> Set-AzureRmEnvironment -Name TestEnvironment - -ActiveDirectoryEndpoint NewTestADEndpoint - -GraphEndpoint NewTestGraphEndpoint | Format-List - -Name : TestEnvironment -EnableAdfsAuthentication : False -ActiveDirectoryServiceEndpointResourceId : TestADApplicationId -AdTenant : -GalleryUrl : TestGalleryEndpoint -ManagementPortalUrl : -ServiceManagementUrl : -PublishSettingsFileUrl : -ResourceManagerUrl : TestRMEndpoint -SqlDatabaseDnsSuffix : -StorageEndpointSuffix : -ActiveDirectoryAuthority : NewTestADEndpoint -GraphUrl : NewTestGraphEndpoint -GraphEndpointResourceId : -TrafficManagerDnsSuffix : -AzureKeyVaultDnsSuffix : -AzureDataLakeStoreFileSystemEndpointSuffix : -AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix : -AzureKeyVaultServiceEndpointResourceId : -BatchEndpointResourceId : -AzureOperationalInsightsEndpoint : -AzureOperationalInsightsEndpointResourceId : -``` - -In this example we are creating a new Azure environment with sample endpoints using Add-AzureRmEnvironment, and then we are changing the value of the ActiveDirectoryEndpoint and GraphEndpoint attributes of the created environment using the cmdlet Set-AzureRmEnvironment. - -## PARAMETERS - -### -ActiveDirectoryEndpoint -Specifies the base authority for Microsoft Entra authentication. - -```yaml -Type: System.String -Parameter Sets: Name -Aliases: AdEndpointUrl, ActiveDirectory, ActiveDirectoryAuthority - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ActiveDirectoryServiceEndpointResourceId -Specifies the audience for tokens that authenticate requests to Azure Resource Manager or Service Management (RDFE) endpoints. - -```yaml -Type: System.String -Parameter Sets: Name -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AdTenant -Specifies the default Active Directory tenant. - -```yaml -Type: System.String -Parameter Sets: Name -Aliases: - -Required: False -Position: 17 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ARMEndpoint -The Azure Resource Manager endpoint. - -```yaml -Type: System.String -Parameter Sets: ARMEndpoint -Aliases: ArmUrl - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AzureAnalysisServicesEndpointSuffix -Dns Suffix of Azure Analysis Services service endpoints - -```yaml -Type: System.String -Parameter Sets: Name -Aliases: - -Required: False -Position: 15 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix -Dns Suffix of Azure Data Lake Analytics job and catalog services - -```yaml -Type: System.String -Parameter Sets: Name -Aliases: - -Required: False -Position: 15 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AzureDataLakeStoreFileSystemEndpointSuffix -Dns Suffix of Azure Data Lake Store FileSystem. -Example: azuredatalake.net - -```yaml -Type: System.String -Parameter Sets: Name -Aliases: - -Required: False -Position: 14 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AzureKeyVaultDnsSuffix -Specifies the domain name suffix for Key Vault services. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 10 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AzureKeyVaultServiceEndpointResourceId -Specifies the audience for access tokens that authorize requests for Key Vault services. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 11 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AzureOperationalInsightsEndpoint -Specifies the endpoint for the Operational Insights query access. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 22 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AzureOperationalInsightsEndpointResourceId -Specifies the audience for access tokens that authorize requests for Operational Insights services. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 21 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BatchEndpointResourceId -The resource identifier of the Azure Batch service that is the recipient of the requested token - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: BatchResourceId, BatchAudience - -Required: False -Position: 20 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataLakeAudience -The audience for tokens authenticating with the AD Data Lake services Endpoint. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: DataLakeEndpointResourceId, DataLakeResourceId - -Required: False -Position: 19 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableAdfsAuthentication -Indicates that Active Directory Federation Services (ADFS) on-premise authentication is allowed. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Name -Aliases: OnPremise - -Required: False -Position: 16 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GalleryEndpoint -Specifies the endpoint for the Azure Resource Manager gallery of deployment templates. - -```yaml -Type: System.String -Parameter Sets: Name -Aliases: Gallery, GalleryUrl - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GraphAudience -The audience for tokens authenticating with the AD Graph Endpoint. - -```yaml -Type: System.String -Parameter Sets: Name -Aliases: GraphEndpointResourceId, GraphResourceId - -Required: False -Position: 18 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GraphEndpoint -Specifies the URL for Graph (Active Directory metadata) requests. - -```yaml -Type: System.String -Parameter Sets: Name -Aliases: Graph, GraphUrl - -Required: False -Position: 9 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ManagementPortalUrl -Specifies the URL for the Management Portal. - -```yaml -Type: System.String -Parameter Sets: Name -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the environment to modify. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublishSettingsFileUrl -Specifies the URL from which .publishsettings files can be downloaded. - -```yaml -Type: System.String -Parameter Sets: Name -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceManagerEndpoint -Specifies the URL for Azure Resource Manager requests. - -```yaml -Type: System.String -Parameter Sets: Name -Aliases: ResourceManager, ResourceManagerUrl - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Scope -Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user. - -```yaml -Type: Microsoft.Azure.Commands.Profile.Common.ContextModificationScope -Parameter Sets: (All) -Aliases: -Accepted values: Process, CurrentUser - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceEndpoint -Specifies the endpoint for Service Management (RDFE) requests. - -```yaml -Type: System.String -Parameter Sets: Name -Aliases: ServiceManagement, ServiceManagementUrl - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SqlDatabaseDnsSuffix -Specifies the domain-name suffix for Azure SQL Database servers. - -```yaml -Type: System.String -Parameter Sets: Name -Aliases: - -Required: False -Position: 13 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageEndpoint -Specifies the endpoint for storage (blob, table, queue, and file) access. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: StorageEndpointSuffix - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrafficManagerDnsSuffix -Specifies the domain-name suffix for Azure Traffic Manager services. - -```yaml -Type: System.String -Parameter Sets: Name -Aliases: - -Required: False -Position: 12 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Profile.Models.PSAzureEnvironment - -## NOTES - -## RELATED LINKS - -[Add-AzureRMEnvironment](./Add-AzureRMEnvironment.md) - -[Get-AzureRMEnvironment](./Get-AzureRMEnvironment.md) - -[Remove-AzureRMEnvironment](./Remove-AzureRMEnvironment.md) diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/AzureRM.RecoveryServices.Backup.md b/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/AzureRM.RecoveryServices.Backup.md deleted file mode 100644 index cef921036e..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/AzureRM.RecoveryServices.Backup.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -Module Name: AzureRM.RecoveryServices.Backup -Module Guid: 3d444bee-6742-4ce2-b573-dfd1b7c4144c -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup -Help Version: 4.1.2.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/AzureRM.RecoveryServices.Backup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/AzureRM.RecoveryServices.Backup.md ---- - -# AzureRM.RecoveryServices.Backup Module -## Description -This topic displays help topics for the Azure Backup - Recovery Services Cmdlets. - -## AzureRM.RecoveryServices.Backup Cmdlets -### [Backup-AzureRmRecoveryServicesBackupItem](Backup-AzureRmRecoveryServicesBackupItem.md) -Starts a backup for a Backup item. - -### [Disable-AzureRmRecoveryServicesBackupProtection](Disable-AzureRmRecoveryServicesBackupProtection.md) -Disables protection for a Backup-protected item. - -### [Disable-AzureRmRecoveryServicesBackupRPMountScript](Disable-AzureRmRecoveryServicesBackupRPMountScript.md) -Dismounts all the files of the recovery point. - -### [Enable-AzureRmRecoveryServicesBackupProtection](Enable-AzureRmRecoveryServicesBackupProtection.md) -Enables backup for an item with a specified Backup protection policy. - -### [Get-AzureRmRecoveryServicesBackupContainer](Get-AzureRmRecoveryServicesBackupContainer.md) -Gets Backup containers. - -### [Get-AzureRmRecoveryServicesBackupItem](Get-AzureRmRecoveryServicesBackupItem.md) -Gets the items from a container in Backup. - -### [Get-AzureRmRecoveryServicesBackupJob](Get-AzureRmRecoveryServicesBackupJob.md) -Gets Backup jobs. - -### [Get-AzureRmRecoveryServicesBackupJobDetails](Get-AzureRmRecoveryServicesBackupJobDetails.md) -Gets details for a Backup job. - -### [Get-AzureRmRecoveryServicesBackupManagementServer](Get-AzureRmRecoveryServicesBackupManagementServer.md) -Gets SCDPM and Azure Backup management servers. - -### [Get-AzureRmRecoveryServicesBackupProtectionPolicy](Get-AzureRmRecoveryServicesBackupProtectionPolicy.md) -Gets Backup protection policies for a vault. - -### [Get-AzureRmRecoveryServicesBackupRecoveryPoint](Get-AzureRmRecoveryServicesBackupRecoveryPoint.md) -Gets the recovery points for a backed up item. - -### [Get-AzureRmRecoveryServicesBackupRetentionPolicyObject](Get-AzureRmRecoveryServicesBackupRetentionPolicyObject.md) -Gets a base retention policy object. - -### [Get-AzureRmRecoveryServicesBackupRPMountScript](Get-AzureRmRecoveryServicesBackupRPMountScript.md) -Downloads a script to mount all the files of the recovery point. - -### [Get-AzureRmRecoveryServicesBackupSchedulePolicyObject](Get-AzureRmRecoveryServicesBackupSchedulePolicyObject.md) -Gets a base schedule policy object. - -### [Get-AzureRmRecoveryServicesBackupStatus](Get-AzureRmRecoveryServicesBackupStatus.md) -Checks whether your ARM resource is backed up or not. - -### [New-AzureRmRecoveryServicesBackupProtectionPolicy](New-AzureRmRecoveryServicesBackupProtectionPolicy.md) -Creates a Backup protection policy. - -### [Remove-AzureRmRecoveryServicesBackupProtectionPolicy](Remove-AzureRmRecoveryServicesBackupProtectionPolicy.md) -Deletes a Backup protection policy from a vault. - -### [Restore-AzureRmRecoveryServicesBackupItem](Restore-AzureRmRecoveryServicesBackupItem.md) -Restores the data and configuration for a Backup item to a recovery point. - -### [Set-AzureRmRecoveryServicesBackupProtectionPolicy](Set-AzureRmRecoveryServicesBackupProtectionPolicy.md) -Modifies a Backup protection policy. - -### [Stop-AzureRmRecoveryServicesBackupJob](Stop-AzureRmRecoveryServicesBackupJob.md) -Cancels a running job. - -### [Unregister-AzureRmRecoveryServicesBackupContainer](Unregister-AzureRmRecoveryServicesBackupContainer.md) -Unregisters a Windows Server or other container from the vault. - -### [Unregister-AzureRmRecoveryServicesBackupManagementServer](Unregister-AzureRmRecoveryServicesBackupManagementServer.md) -Unregisters a SCDPM server or Backup server from the vault. - -### [Wait-AzureRmRecoveryServicesBackupJob](Wait-AzureRmRecoveryServicesBackupJob.md) -Waits for a Backup job to finish. - diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Backup-AzureRmRecoveryServicesBackupItem.md b/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Backup-AzureRmRecoveryServicesBackupItem.md deleted file mode 100644 index 36188cdf54..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Backup-AzureRmRecoveryServicesBackupItem.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.Backup.dll-Help.xml -Module Name: AzureRM.RecoveryServices.Backup -ms.assetid: 04D7317E-2089-4197-909D-89F0CEC4851A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/backup-azurermrecoveryservicesbackupitem -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Backup-AzureRmRecoveryServicesBackupItem.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Backup-AzureRmRecoveryServicesBackupItem.md ---- - -# Backup-AzureRmRecoveryServicesBackupItem - -## SYNOPSIS -Starts a backup for a Backup item. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Backup-AzureRmRecoveryServicesBackupItem -Item <ItemBase> [-ExpiryDateTimeUTC <DateTime>] [-VaultId <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Backup-AzureRmRecoveryServicesBackupItem** cmdlet starts a backup for a protected Azure Backup item that is not tied to the backup schedule. -You can do an initial backup immediately after you enable protection or start a backup after a scheduled backup fails. -Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. - -## EXAMPLES - -### Example 1: Start a backup for a Backup item -``` -PS C:\> $NamedContainer = Get-AzureRmRecoveryServicesBackupContainer -ContainerType AzureVM -Status Registered -Name "pstestv2vm1" -PS C:\> $Item = Get-AzureRmRecoveryServicesBackupItem -Container $NamedContainer -WorkloadType AzureVM -PS C:\> $Job = Backup-AzureRmRecoveryServicesItem -Item $Item -Operation Status StartTime EndTime JOBID ------------- --------- ------ --------- ------- -pstestv2vm1 Backup InProgress 4/23/2016 5:00:30 PM cf4b3ef5-2fac-4c8e-a215-d2eba4124f27 -``` - -The first command gets the Backup container of type AzureVM named pstestv2vm1, and then stores it in the $NamedContainer variable. -The second command gets the Backup item corresponding to the container in $NamedContainer, and then stores it in the $Item variable. -The last command triggers the backup job for the Backup item in $Item. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpiryDateTimeUTC -Specifies an expiry time as a **DateTime** object. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Item -Specifies a Backup item for which this cmdlet starts a backup operation. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemBase -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VaultId -ARM ID of the Recovery Services Vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemBase -Parameters: Item (ByValue) - -### System.Nullable`1[[System.DateTime, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.String -Parameters: VaultId (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesBackupContainer](./Get-AzureRmRecoveryServicesBackupContainer.md) - -[Get-AzureRmRecoveryServicesBackupItem](./Get-AzureRmRecoveryServicesBackupItem.md) - -[Restore-AzureRmRecoveryServicesBackupItem](./Restore-AzureRmRecoveryServicesBackupItem.md) - - diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Disable-AzureRmRecoveryServicesBackupProtection.md b/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Disable-AzureRmRecoveryServicesBackupProtection.md deleted file mode 100644 index 050e69d565..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Disable-AzureRmRecoveryServicesBackupProtection.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.Backup.dll-Help.xml -Module Name: AzureRM.RecoveryServices.Backup -ms.assetid: ECD3F05A-9350-407E-8B48-67443547652F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/disable-azurermrecoveryservicesbackupprotection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Disable-AzureRmRecoveryServicesBackupProtection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Disable-AzureRmRecoveryServicesBackupProtection.md ---- - -# Disable-AzureRmRecoveryServicesBackupProtection - -## SYNOPSIS -Disables protection for a Backup-protected item. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Disable-AzureRmRecoveryServicesBackupProtection [-Item] <ItemBase> [-RemoveRecoveryPoints] [-Force] - [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Disable-AzureRmRecoveryServicesBackupProtection** cmdlet disables protection for an Azure Backup-protected item. -This cmdlet stops regular scheduled backup of an item. -This cmdlet can also delete existing recovery points for the backup item. -Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. - -## EXAMPLES - -### Example 1: Disable Backup protection -``` -PS C:\> $Cont = Get-AzureRmRecoveryServicesBackupContainer -ContainerType AzureVM -Status Registered -PS C:\> $PI = Get-AzureRmRecoveryServicesBackupItem -Container $Cont[0] -WorkloadType AzureVM -PS C:\> Disable-AzureRmRecoveryServicesBackupProtection -Item $PI[0] -``` - -The first command gets an array of backup containers, and then stores it in the $Cont array. -The second command gets the Backup item corresponding to the first container item, and then stores it in the $PI variable. -The last command disables Backup protection for the item in $PI\[0\], but retains the data. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Item -Specifies the Backup item for which this cmdlet disables protection. -To obtain an **AzureRmRecoveryServicesBackupItem**, use the Get-AzureRmRecoveryServicesBackupItem cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemBase -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RemoveRecoveryPoints -Indicates that this cmdlet deletes existing recovery points. -To delete stored recovery points later, run this cmdlet again and specify this parameter. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultId -ARM ID of the Recovery Services Vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemBase -Parameters: Item (ByValue) - -### System.String -Parameters: VaultId (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase - -## NOTES - -## RELATED LINKS - -[Enable-AzureRmRecoveryServicesBackupProtection](./Enable-AzureRmRecoveryServicesBackupProtection.md) - -[Get-AzureRmRecoveryServicesBackupContainer](./Get-AzureRmRecoveryServicesBackupContainer.md) - -[Get-AzureRmRecoveryServicesBackupItem](./Get-AzureRmRecoveryServicesBackupItem.md) - - diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Disable-AzureRmRecoveryServicesBackupRPMountScript.md b/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Disable-AzureRmRecoveryServicesBackupRPMountScript.md deleted file mode 100644 index 93aab0e0da..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Disable-AzureRmRecoveryServicesBackupRPMountScript.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.Backup.dll-Help.xml -Module Name: AzureRM.RecoveryServices.Backup -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/disable-azurermrecoveryservicesbackuprpmountscript -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Disable-AzureRmRecoveryServicesBackupRPMountScript.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Disable-AzureRmRecoveryServicesBackupRPMountScript.md ---- - -# Disable-AzureRmRecoveryServicesBackupRPMountScript - -## SYNOPSIS -Dismounts all the files of the recovery point. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Disable-AzureRmRecoveryServicesBackupRPMountScript [-RecoveryPoint] <RecoveryPointBase> [-PassThru] - [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Disable-AzureRmRecoveryServicesBackupRPMountScript cmdlet dismounts the files of the recovery point which were mounted earlier using the Get-AzureRmRecoveryServicesBackupRPMountScript cmdlet. - -## EXAMPLES - -### Example 1: Dismount a recovery point -``` -PS C:\> $namedContainer = Get-AzureRmRecoveryServicesBackupContainer -ContainerType "AzureVM" -Status "Registered" -FriendlyName "V2VM" -PS C:\> $backupitem = Get-AzureRmRecoveryServicesBackupItem -Container $namedContainer -WorkloadType "AzureVM" -PS C:\> $startDate = (Get-Date).AddDays(-7) -PS C:\> $endDate = Get-Date -PS C:\> $rp = Get-AzureRmRecoveryServicesBackupRecoveryPoint -Item $backupitem -StartDate $startdate.ToUniversalTime() -EndDate $enddate.ToUniversalTime() - -To mount files of the latest recovery point, obtain the script by - -PS C:\> Get-AzureRmRecoveryServicesBackupRPMountScript -RecoveryPoint $rp[0] - -OsType Password Filename ------- -------- -------- -Windows e3632984e51f496 V2VM_wus2_8287309959960546283_451516692429_cbd6061f7fc543c489f1974d33659fed07a6e0c2e08740.exe - -When the script is run, it will mount the files of the recovery point $rp[0] - -After the relevant files are copied, then you remove the files of the recovery point by running the disable cmdlet - -PS C:\> Disable-AzureRmRecoveryServicesBackupRPMountScript -RecoveryPoint $rp[0] -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Return the recovery point. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryPoint -Recovery point object to be restored - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryPointBase -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VaultId -ARM ID of the Recovery Services Vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryPointBase -Parameters: RecoveryPoint (ByValue) - -### System.String -Parameters: VaultId (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryPointBase - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Enable-AzureRmRecoveryServicesBackupProtection.md b/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Enable-AzureRmRecoveryServicesBackupProtection.md deleted file mode 100644 index 5c36bcc9db..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Enable-AzureRmRecoveryServicesBackupProtection.md +++ /dev/null @@ -1,243 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.Backup.dll-Help.xml -Module Name: AzureRM.RecoveryServices.Backup -ms.assetid: 44622461-E567-4A0A-8F18-2D7B1BF86DA2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/enable-azurermrecoveryservicesbackupprotection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Enable-AzureRmRecoveryServicesBackupProtection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Enable-AzureRmRecoveryServicesBackupProtection.md ---- - -# Enable-AzureRmRecoveryServicesBackupProtection - -## SYNOPSIS -Enables backup for an item with a specified Backup protection policy. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### AzureVMComputeEnableProtection (Default) -``` -Enable-AzureRmRecoveryServicesBackupProtection [-Policy] <PolicyBase> [-Name] <String> - [-ResourceGroupName] <String> [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### AzureVMClassicComputeEnableProtection -``` -Enable-AzureRmRecoveryServicesBackupProtection [-Policy] <PolicyBase> [-Name] <String> [-ServiceName] <String> - [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### AzureFileShareEnableProtection -``` -Enable-AzureRmRecoveryServicesBackupProtection [-Policy] <PolicyBase> [-Name] <String> - -StorageAccountName <String> [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ModifyProtection -``` -Enable-AzureRmRecoveryServicesBackupProtection [-Policy] <PolicyBase> [-Item] <ItemBase> [-VaultId <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Enable-AzureRmRecoveryServicesBackupProtection** cmdlet sets Azure Backup protection policy on an item. -Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. - -## EXAMPLES - -### Example 1: Enable Backup protection for an item -``` -PS C:\> $Pol = Get-AzureRmRecoveryServicesBackupProtectionPolicy -Name "DefaultPolicy" -PS C:\> Enable-AzureRmRecoveryServicesBackupProtection -Policy $Pol -Name "V2VM" -ResourceGroupName "RGName1" -WorkloadName Operation Status StartTime EndTime ------------- --------- ------ --------- ------- -co03-vm ConfigureBackup Completed 11-Apr-16 12:19:49 PM 11-Apr-16 12:19:54 PM -``` - -The first cmdlet gets a default policy object, and then stores it in the $Pol variable. -The second cmdlet sets the Backup protection policy for the ARM virtual machine named V2VM using the policy in $Pol. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Item -Specifies the Backup item for which this cmdlet enables protection. -To obtain an **AzureRmRecoveryServicesBackupItem**, use the Get-AzureRmRecoveryServicesBackupItem cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemBase -Parameter Sets: ModifyProtection -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Backup item. - -```yaml -Type: System.String -Parameter Sets: AzureVMComputeEnableProtection, AzureVMClassicComputeEnableProtection, AzureFileShareEnableProtection -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Policy -Specifies protection policy that this cmdlet associates with an item. -To obtain an **AzureRmRecoveryServicesBackupProtectionPolicy** object, use the Get-AzureRmRecoveryServicesBackupProtectionPolicy cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.PolicyBase -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. -Specify this parameter only for ARM virtual machines. - -```yaml -Type: System.String -Parameter Sets: AzureVMComputeEnableProtection -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceName -Specifies the service name. -Specify this parameter only for ASM virtual machines. - -```yaml -Type: System.String -Parameter Sets: AzureVMClassicComputeEnableProtection -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountName -Azure file share storage account name - -```yaml -Type: System.String -Parameter Sets: AzureFileShareEnableProtection -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultId -ARM ID of the Recovery Services Vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: VaultId (ByValue) - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemBase -Parameters: Item (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase - -## NOTES - -## RELATED LINKS - -[Disable-AzureRmRecoveryServicesBackupProtection](./Disable-AzureRmRecoveryServicesBackupProtection.md) - -[Get-AzureRmRecoveryServicesBackupProtectionPolicy](./Get-AzureRmRecoveryServicesBackupProtectionPolicy.md) - - diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupContainer.md b/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupContainer.md deleted file mode 100644 index 63d39a7e04..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupContainer.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.Backup.dll-Help.xml -Module Name: AzureRM.RecoveryServices.Backup -ms.assetid: 1097FF29-1C23-4960-930C-5C1227419359 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/get-azurermrecoveryservicesbackupcontainer -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Get-AzureRmRecoveryServicesBackupContainer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Get-AzureRmRecoveryServicesBackupContainer.md ---- - -# Get-AzureRmRecoveryServicesBackupContainer - -## SYNOPSIS -Gets Backup containers. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmRecoveryServicesBackupContainer [-ContainerType] <ContainerType> [[-BackupManagementType] <String>] - [[-Name] <String>] [[-FriendlyName] <String>] [[-ResourceGroupName] <String>] - [[-Status] <ContainerRegistrationStatus>] [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRecoveryServicesBackupContainer** cmdlet gets a backup container. -A Backup container encapsulates data sources that are modelled as backup items. -Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. - -## EXAMPLES - -### Example 1: Get a specific container -``` -PS C:\>Get-AzureRmRecoveryServicesContainer -ContainerType "AzureVM" -Status "Registered" -Name "V2VM"; -``` - -This command gets the container named V2VM of type AzureVM. - -### Example 2: Get all containers of a specific type -``` -PS C:\>Get-AzureRmRecoveryServicesBackupContainer -ContainerType Windows -BackupManagementType MARS -``` - -This command gets all Windows containers that are protected by Azure Backup agent. -The *BackupManagementType* parameter is only required for Windows containers. - -## PARAMETERS - -### -BackupManagementType -Specifies the backup management type. -The acceptable values for this parameter are: -- AzureVM -- MARS -- AzureSQL -- AzureStorage - -This parameter is used to differentiate Windows machines that are backed up using MARS agent or other backup engines. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: AzureVM, MARS, AzureSQL, AzureStorage - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContainerType -Specifies the backup container type. -The acceptable values for this parameter are: -- AzureVM -- Windows -- AzureSQL -- AzureStorage - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ContainerType -Parameter Sets: (All) -Aliases: -Accepted values: AzureVM, Windows, AzureSQL, AzureStorage - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FriendlyName -Specifies the friendly name of the container to get. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the container to get. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. -This parameter is for Azure virtual machines only. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Status -Specifies the container registration status. -The acceptable values for this parameter are: -- Registered - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ContainerRegistrationStatus -Parameter Sets: (All) -Aliases: -Accepted values: Registered - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultId -ARM ID of the Recovery Services Vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: VaultId (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ContainerBase - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesBackupItem](./Get-AzureRmRecoveryServicesBackupItem.md) - -[Get-AzureRmRecoveryServicesBackupManagementServer](./Get-AzureRmRecoveryServicesBackupManagementServer.md) - -[Unregister-AzureRmRecoveryServicesBackupContainer](./Unregister-AzureRmRecoveryServicesBackupContainer.md) - - diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupItem.md b/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupItem.md deleted file mode 100644 index c87a77ad82..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupItem.md +++ /dev/null @@ -1,251 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.Backup.dll-Help.xml -Module Name: AzureRM.RecoveryServices.Backup -ms.assetid: DEB3D7B5-D974-472B-B8B4-9A19CA6AECCC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/get-azurermrecoveryservicesbackupitem -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Get-AzureRmRecoveryServicesBackupItem.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Get-AzureRmRecoveryServicesBackupItem.md ---- - -# Get-AzureRmRecoveryServicesBackupItem - -## SYNOPSIS -Gets the items from a container in Backup. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetItemsForContainer (Default) -``` -Get-AzureRmRecoveryServicesBackupItem [-Container] <ContainerBase> [[-Name] <String>] - [[-ProtectionStatus] <ItemProtectionStatus>] [[-ProtectionState] <ItemProtectionState>] - [-WorkloadType] <WorkloadType> [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### GetItemsForVault -``` -Get-AzureRmRecoveryServicesBackupItem [-BackupManagementType] <BackupManagementType> [[-Name] <String>] - [[-ProtectionStatus] <ItemProtectionStatus>] [[-ProtectionState] <ItemProtectionState>] - [-WorkloadType] <WorkloadType> [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### GetItemsForPolicy -``` -Get-AzureRmRecoveryServicesBackupItem [-Policy] <PolicyBase> [[-Name] <String>] - [[-ProtectionStatus] <ItemProtectionStatus>] [[-ProtectionState] <ItemProtectionState>] [-VaultId <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRecoveryServicesBackupItem** cmdlet gets the items in a container or a value in Azure Backup and the protection status of the items. -A container that is registered to an Azure Recovery Services vault can have one or more items that can be protected. -For Azure virtual machines, there can be only one backup item in the virtual machine container. -Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. - -## EXAMPLES - -### Example 1: Get an item from a Backup container -``` -PS C:\>$Container = Get-AzureRmRecoveryServicesBackupContainer -ContainerType AzureVM -Status Registered -Name "V2VM" -PS C:\> $BackupItem = Get-AzureRmRecoveryServicesBackupItem -Container $Container -WorkloadType AzureVM -``` - -The first command gets the container of type AzureVM, and then stores it in the $Container variable. -The second command gets the Backup item named V2VM in $Container, and then stores it in the $BackupItem variable. - -## PARAMETERS - -### -BackupManagementType -Specifies the Backup management type. -The acceptable values for this parameter are: -- AzureVM -- MARS -- SCDPM -- AzureBackupServer -- AzureSQL -- AzureStorage - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.BackupManagementType -Parameter Sets: GetItemsForVault -Aliases: -Accepted values: AzureVM, MARS, SCDPM, AzureBackupServer, AzureSQL, AzureStorage - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Container -Specifies a container object from which this cmdlet gets backup items. -To obtain an **AzureRmRecoveryServicesBackupContainer**, use the Get-AzureRmRecoveryServicesBackupContainer cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ContainerBase -Parameter Sets: GetItemsForContainer -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the container. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Protection policy object. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.PolicyBase -Parameter Sets: GetItemsForPolicy -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtectionState -Specifies the state of protection. -The acceptable values for this parameter are: -- IRPending. -Initial synchronization has not started and there is no recovery point yet. -- Protected. -Protection is ongoing. -- ProtectionError. -There is a protection error. -- ProtectionStopped. -Protection is disabled. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemProtectionState -Parameter Sets: (All) -Aliases: -Accepted values: IRPending, ProtectionError, Protected, ProtectionStopped - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtectionStatus -Specifies the overall protection status of an item in the container. -The acceptable values for this parameter are: -- Healthy -- Unhealthy - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemProtectionStatus -Parameter Sets: (All) -Aliases: -Accepted values: Healthy, Unhealthy - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultId -ARM ID of the Recovery Services Vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WorkloadType -Specifies the workload type. -The acceptable values for this parameter are: -- AzureVM -- AzureSQLDatabase -- AzureFiles - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.WorkloadType -Parameter Sets: GetItemsForContainer, GetItemsForVault -Aliases: -Accepted values: AzureVM, AzureSQLDatabase, AzureFiles - -Required: True -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ContainerBase - -### System.String -Parameters: VaultId (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemBase - -## NOTES - -## RELATED LINKS - -[Backup-AzureRmRecoveryServicesBackupItem](./Backup-AzureRmRecoveryServicesBackupItem.md) - -[Disable-AzureRmRecoveryServicesBackupProtection](./Disable-AzureRmRecoveryServicesBackupProtection.md) - -[Get-AzureRmRecoveryServicesBackupRecoveryPoint](./Get-AzureRmRecoveryServicesBackupRecoveryPoint.md) - -[Restore-AzureRmRecoveryServicesBackupItem](./Restore-AzureRmRecoveryServicesBackupItem.md) - - diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupJob.md b/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupJob.md deleted file mode 100644 index 2c86fd9d2e..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupJob.md +++ /dev/null @@ -1,260 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.Backup.dll-Help.xml -Module Name: AzureRM.RecoveryServices.Backup -ms.assetid: 12F8A120-7282-4844-90E0-1C3393336E8A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/get-azurermrecoveryservicesbackupjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Get-AzureRmRecoveryServicesBackupJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Get-AzureRmRecoveryServicesBackupJob.md ---- - -# Get-AzureRmRecoveryServicesBackupJob - -## SYNOPSIS -Gets Backup jobs. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmRecoveryServicesBackupJob [[-Status] <JobStatus>] [[-Operation] <JobOperation>] [[-From] <DateTime>] - [[-To] <DateTime>] [[-JobId] <String>] [[-Job] <JobBase>] [-BackupManagementType <BackupManagementType>] - [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRecoveryServicesBackupJob** cmdlet gets Azure Backup jobs for a specific vault. -Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. - -## EXAMPLES - -### Example 1: Get all in-progress jobs -``` -PS C:\>$Joblist = Get-AzureRMRecoveryservicesBackupJob -Status Inprogress -PS C:\> $Joblist[0] -WorkloadName Operation Status StartTime EndTime ------------- --------- ------ --------- ------- -V2VM Backup InProgress 4/23/2016 5:00:30 PM 1/1/2001 12:00:00 -``` - -The first command gets status of an in-progress job as an array, and then stores it in the $Joblist variable. -The second command displays the first item in the $Joblist array. - -### Example 2: Get all failed jobs in the last 7 days -``` -PS C:\>Get-AzureRmRecoveryServicesBackupJob -From (Get-Date).AddDays(-7).ToUniversalTime() -Status Failed -``` - -This command gets failed jobs from the last week in the vault. -The *From* parameter specifies a time seven days in the past specified in UTC. -The command does not specify a value for the *To* parameter. -Therefore, it uses the default value of the current time. - -### Example 3: Get an in-progress job and wait for completion -``` -PS C:\> -$Jobs = Get-AzureRmRecoveryServicesBackupJob -Status InProgress -$Job = $Jobs[0] - while ( $Job.Status -ne Completed ) - { - Write-Host "Waiting for completion..." - Start-Sleep -Seconds 10 - $job = Get-AzureRmBackAzureRmRecoveryServicesBackupJob -Job $Job - } - Write-Host "Done!" - Waiting for completion... - Waiting for completion... - Waiting for completion... - Done! -``` - -This script polls the first job that is currently in progress until the job has completed. - -## PARAMETERS - -### -BackupManagementType -Specifies the Backup management type. -Currently, only AzureVM, AzureStorage is supported. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.BackupManagementType] -Parameter Sets: (All) -Aliases: -Accepted values: AzureVM, MARS, SCDPM, AzureBackupServer, AzureSQL, AzureStorage - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -From -Specifies the start, as a **DateTime** object, of a time range for the jobs that this cmdlet gets. -To obtain a **DateTime** object, use the Get-Date cmdlet. -For more information about **DateTime** objects, type `Get-Help Get-Date`. -Use UTC format for dates. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Job -Specifies the name of the Backup job to get. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobId -Specifies the ID of a job that this cmdlet gets. -The ID is the InstanceId property of an **AzureRmRecoveryServicesBackupJob** object. -To obtain an **AzureRmRecoveryServicesBackupJob** object, use Get-AzureRmRecoveryServicesBackupJob. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Operation -Specifies an operation of the jobs that this cmdlet gets. -The acceptable values for this parameter are: -- Backup -- ConfigureBackup -- DeleteBackupData -- Register -- Restore -- UnProtect -- Unregister - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobOperation] -Parameter Sets: (All) -Aliases: -Accepted values: Backup, Restore, ConfigureBackup, DisableBackup, DeleteBackupData - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Status -Specifies a status of the jobs that this cmdlet gets. -The acceptable values for this parameter are: -- InProgress -- Failed -- Cancelled -- Cancelling -- Completed -- CompletedWithWarnings - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobStatus] -Parameter Sets: (All) -Aliases: -Accepted values: InProgress, Cancelling, Cancelled, Completed, CompletedWithWarnings, Failed - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -To -Specifies the end, as a **DateTime** object, of a time range for the jobs that this cmdlet gets. -The default value is the current system time. -If you specify this parameter, you must also specify the *From* parameter. -Use UTC format for dates. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultId -ARM ID of the Recovery Services Vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: VaultId (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesBackupJobDetails](./Get-AzureRmRecoveryServicesBackupJobDetails.md) - -[Stop-AzureRmRecoveryServicesBackupJob](./Stop-AzureRmRecoveryServicesBackupJob.md) - -[Wait-AzureRmRecoveryServicesBackupJob](./Wait-AzureRmRecoveryServicesBackupJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupJobDetails.md b/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupJobDetails.md deleted file mode 100644 index 3269077896..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupJobDetails.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.Backup.dll-Help.xml -Module Name: AzureRM.RecoveryServices.Backup -ms.assetid: 707A3E57-AF46-44B3-A491-89554900EF03 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/get-azurermrecoveryservicesbackupjobdetails -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Get-AzureRmRecoveryServicesBackupJobDetails.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Get-AzureRmRecoveryServicesBackupJobDetails.md ---- - -# Get-AzureRmRecoveryServicesBackupJobDetails - -## SYNOPSIS -Gets details for a Backup job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### JobFilterSet (Default) -``` -Get-AzureRmRecoveryServicesBackupJobDetails [-Job] <JobBase> [-VaultId <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### IdFilterSet -``` -Get-AzureRmRecoveryServicesBackupJobDetails [-JobId] <String> [-VaultId <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRecoveryServicesBackupJobDetails** cmdlet gets Azure Backup job details for a specified job. -Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. - -## EXAMPLES - -### Example 1: Get Backup job details for failed jobs -``` -PS C:\>$Jobs = Get-AzureRmRecoveryServicesBackupJob -Status Failed -PS C:\> $JobDetails = Get-AzureRmRecoveryServicesBackupJobDetails -Job $Jobs[0] -PS C:\> $JobDetails.ErrorDetails -``` - -The first command gets an array of failed jobs in the vault, and then stores them in the $Jobs array. -The second command gets the job details for the failed jobs in $Jobs, and then stores them in the $JobDetails variable. -The final command displays error details for the failed jobs. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Job -Specifies the job to get. -To obtain a **BackupJob** object, use the Get-AzureRmRecoveryServicesBackupJob cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase -Parameter Sets: JobFilterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobId -Specifies the ID of a Backup job. -The ID is the InstanceId property of a **BackupJob** object. - -```yaml -Type: System.String -Parameter Sets: IdFilterSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultId -ARM ID of the Recovery Services Vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: VaultId (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesBackupJob](./Get-AzureRmRecoveryServicesBackupJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupManagementServer.md b/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupManagementServer.md deleted file mode 100644 index 25441268d9..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupManagementServer.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.Backup.dll-Help.xml -Module Name: AzureRM.RecoveryServices.Backup -ms.assetid: 4B7ACEC8-29BB-4791-8087-801300F246B4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/get-azurermrecoveryservicesbackupmanagementserver -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Get-AzureRmRecoveryServicesBackupManagementServer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Get-AzureRmRecoveryServicesBackupManagementServer.md ---- - -# Get-AzureRmRecoveryServicesBackupManagementServer - -## SYNOPSIS -Gets SCDPM and Azure Backup management servers. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmRecoveryServicesBackupManagementServer [[-Name] <String>] [-VaultId <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRecoveryServicesBackupManagementServer** cmdlet gets a list of Backup management servers that are registered in a vault. -There are two types of Backup management servers: System Center Data Protection Manager (SCDPM) and Azure Backup management servers. -Backup management servers are installed separately to manage Backup orchestration. -Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. - -## EXAMPLES - -### Example 1: Get all Backup management servers -``` -PS C:\>Get-AzureRmRecoveryServicesBackupManagementServer -``` - -This command gets all Backup management servers registered with the vault. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Backup management server to get. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultId -ARM ID of the Recovery Services Vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: VaultId (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.BackupEngineBase - -## NOTES - -## RELATED LINKS - -[Unregister-AzureRmRecoveryServicesBackupManagementServer](./Unregister-AzureRmRecoveryServicesBackupManagementServer.md) - - diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupProtectionPolicy.md b/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupProtectionPolicy.md deleted file mode 100644 index c2c2e5c3af..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupProtectionPolicy.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.Backup.dll-Help.xml -Module Name: AzureRM.RecoveryServices.Backup -ms.assetid: 2E202D0D-076D-431D-9338-9A84ABC0B461 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/get-azurermrecoveryservicesbackupprotectionpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Get-AzureRmRecoveryServicesBackupProtectionPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Get-AzureRmRecoveryServicesBackupProtectionPolicy.md ---- - -# Get-AzureRmRecoveryServicesBackupProtectionPolicy - -## SYNOPSIS -Gets Backup protection policies for a vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NoParamSet (Default) -``` -Get-AzureRmRecoveryServicesBackupProtectionPolicy [-VaultId <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### PolicyNameParamSet -``` -Get-AzureRmRecoveryServicesBackupProtectionPolicy [-Name] <String> [-VaultId <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### WorkloadParamSet -``` -Get-AzureRmRecoveryServicesBackupProtectionPolicy [-WorkloadType] <WorkloadType> [-VaultId <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### WorkloadBackupManagementTypeParamSet -``` -Get-AzureRmRecoveryServicesBackupProtectionPolicy [-WorkloadType] <WorkloadType> - [-BackupManagementType] <BackupManagementType> [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRecoveryServicesBackupProtectionPolicy** cmdlet gets Azure Backup protection policies for a vault. -Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. - -## EXAMPLES - -### Example 1: Get all policies in the vault -``` -PS C:\> Get-AzureRmRecoveryServicesBackupProtectionPolicy -Name WorkloadType BackupManagementType BackupTime DaysOfWeek ----- ------------ -------------------- ---------- ---------- -DefaultPolicy AzureVM AzureVM 4/14/2016 5:00:00 PM -NewPolicy AzureVM AzureVM 4/23/2016 5:30:00 PM -NewPolicy2 AzureVM AzureVM 4/24/2016 1:30:00 AM -``` - -This command gets all protection policies created in the vault. - -### Example 2: Get a specific policy -``` -PS C:\> $Pol= Get-AzureRmRecoveryServicesBackupProtectionPolicy -Name "DefaultPolicy" -``` - -This command gets the protection policy named DefaultPolicy, and then stores it in the $Pol variable. - -## PARAMETERS - -### -BackupManagementType -Specifies the Backup management type. -Currently, only AzureVM, AzureStorage is supported. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.BackupManagementType] -Parameter Sets: WorkloadBackupManagementTypeParamSet -Aliases: -Accepted values: AzureVM, MARS, SCDPM, AzureBackupServer, AzureSQL, AzureStorage - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the policy. - -```yaml -Type: System.String -Parameter Sets: PolicyNameParamSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultId -ARM ID of the Recovery Services Vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WorkloadType -Specifies the workload type. -Currently, only AzureVM, AzureFiles is supported. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.WorkloadType] -Parameter Sets: WorkloadParamSet, WorkloadBackupManagementTypeParamSet -Aliases: -Accepted values: AzureVM, AzureSQLDatabase, AzureFiles - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: VaultId (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.PolicyBase - -## NOTES - -## RELATED LINKS - -[New-AzureRmRecoveryServicesBackupProtectionPolicy](./New-AzureRmRecoveryServicesBackupProtectionPolicy.md) - -[Remove-AzureRmRecoveryServicesBackupProtectionPolicy](./Remove-AzureRmRecoveryServicesBackupProtectionPolicy.md) - -[Set-AzureRmRecoveryServicesBackupProtectionPolicy](./Set-AzureRmRecoveryServicesBackupProtectionPolicy.md) - - diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupRPMountScript.md b/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupRPMountScript.md deleted file mode 100644 index bd823316d4..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupRPMountScript.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.Backup.dll-Help.xml -Module Name: AzureRM.RecoveryServices.Backup -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/get-azurermrecoveryservicesbackuprpmountscript -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Get-AzureRmRecoveryServicesBackupRPMountScript.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Get-AzureRmRecoveryServicesBackupRPMountScript.md ---- - -# Get-AzureRmRecoveryServicesBackupRPMountScript - -## SYNOPSIS -Downloads a script to mount all the files of the recovery point. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmRecoveryServicesBackupRPMountScript [-RecoveryPoint] <RecoveryPointBase> [[-Path] <String>] - [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmRecoveryServicesBackupRPMountScript cmdlet downloads a script which mounts the volumes of the recovery point on the machine where it is run. - -## EXAMPLES - -### Example 1: Mount a recovery point -``` -PS C:\> $namedContainer = Get-AzureRmRecoveryServicesBackupContainer -ContainerType "AzureVM" -Status "Registered" -FriendlyName "V2VM" -PS C:\> $backupitem = Get-AzureRmRecoveryServicesBackupItem -Container $namedContainer -WorkloadType "AzureVM" -PS C:\> $startDate = (Get-Date).AddDays(-7) -PS C:\> $endDate = Get-Date -PS C:\> $rp = Get-AzureRmRecoveryServicesBackupRecoveryPoint -Item $backupitem -StartDate $startdate.ToUniversalTime() -EndDate $enddate.ToUniversalTime() - -To mount files of the latest recovery point, obtain the script by - -PS C:\> Get-AzureRmRecoveryServicesBackupRPMountScript -RecoveryPoint $rp[0] - -OsType Password Filename ------- -------- -------- -Windows e3632984e51f496 V2VM_wus2_8287309959960546283_451516692429_cbd6061f7fc543c489f1974d33659fed07a6e0c2e08740.exe -``` - -When the script is run, it will mount the files of the recovery point $rp\[0\] - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Location where the file should be downloaded in the case of file recovery. If -Path is not provided, the script file will be downloaded in the current directory. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryPoint -Recovery point object to be restored - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryPointBase -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VaultId -ARM ID of the Recovery Services Vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryPointBase -Parameters: RecoveryPoint (ByValue) - -### System.String -Parameters: VaultId (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RPMountScriptDetails - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupRecoveryPoint.md b/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupRecoveryPoint.md deleted file mode 100644 index 65d1261899..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupRecoveryPoint.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.Backup.dll-Help.xml -Module Name: AzureRM.RecoveryServices.Backup -ms.assetid: 838026E4-F001-434C-86F0-B2A838E93A9C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/get-azurermrecoveryservicesbackuprecoverypoint -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Get-AzureRmRecoveryServicesBackupRecoveryPoint.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Get-AzureRmRecoveryServicesBackupRecoveryPoint.md ---- - -# Get-AzureRmRecoveryServicesBackupRecoveryPoint - -## SYNOPSIS -Gets the recovery points for a backed up item. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NoFilterParameterSet (Default) -``` -Get-AzureRmRecoveryServicesBackupRecoveryPoint [-Item] <ItemBase> [-VaultId <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### DateTimeFilter -``` -Get-AzureRmRecoveryServicesBackupRecoveryPoint [[-StartDate] <DateTime>] [[-EndDate] <DateTime>] - [-Item] <ItemBase> [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### RecoveryPointId -``` -Get-AzureRmRecoveryServicesBackupRecoveryPoint [-Item] <ItemBase> [-RecoveryPointId] <String> - [[-KeyFileDownloadLocation] <String>] [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRecoveryServicesBackupRecoveryPoint** cmdlet gets the recovery points for a backed up Azure Backup item. -After an item has been backed up, an **AzureRmRecoveryServicesBackupRecoveryPoint** object has one or more recovery points. -Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. - -## EXAMPLES - -### Example 1: Get recovery points from the last week for an item -``` -PS C:\> $StartDate = (Get-Date).AddDays(-7) -PS C:\> $EndDate = Get-Date -PS C:\> $Container = Get-AzureRmRecoveryServicesBackupContainer -ContainerType AzureVM -Status Registered -Name "V2VM" -PS C:\> $BackupItem = Get-AzureRmRecoveryServicesBackupItem -ContainerType AzureVM -WorkloadType AzureVM -PS C:\> $RP = Get-AzureRmRecoveryServicesBackupRecoveryPoint -Item $BackupItem -StartDate $Startdate.ToUniversalTime() -EndDate $Enddate.ToUniversalTime() -``` - -The first command gets the date from seven days ago, and then stores it in the $StartDate variable. -The second command gets today's date, and then stores it in the $EndDate variable. -The third command gets AzureVM backup containers, and stores them in the $Containers variable. -The fourth command gets the backup item named V2VM, and then stores it in the $BackupItem variable. -The last command gets an array of recovery points for the item in $BackupItem, and then stores them in the $RP variable. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndDate -Specifies the end of the date range. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: DateTimeFilter -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Item -Specifies the item for which this cmdlet gets recovery points. -To obtain an **AzureRmRecoveryServicesBackupItem** object, use the Get-AzureRmRecoveryServicesBackupItem cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemBase -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -KeyFileDownloadLocation -Specifies the location to download the input file to restore the KeyVault key for an encrypted virtual machine. - -```yaml -Type: System.String -Parameter Sets: RecoveryPointId -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryPointId -Specifies the recovery point ID. - -```yaml -Type: System.String -Parameter Sets: RecoveryPointId -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -Specifies the start of the date range. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: DateTimeFilter -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultId -ARM ID of the Recovery Services Vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemBase -Parameters: Item (ByValue) - -### System.String -Parameters: VaultId (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryPointBase - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesBackupContainer](./Get-AzureRmRecoveryServicesBackupContainer.md) - -[Get-AzureRmRecoveryServicesBackupItem](./Get-AzureRmRecoveryServicesBackupItem.md) - - diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupRetentionPolicyObject.md b/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupRetentionPolicyObject.md deleted file mode 100644 index 6bf2699c14..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupRetentionPolicyObject.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.Backup.dll-Help.xml -Module Name: AzureRM.RecoveryServices.Backup -ms.assetid: 476094CC-A320-4B2D-B53D-6BFFE30C76CC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/get-azurermrecoveryservicesbackupretentionpolicyobject -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Get-AzureRmRecoveryServicesBackupRetentionPolicyObject.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Get-AzureRmRecoveryServicesBackupRetentionPolicyObject.md ---- - -# Get-AzureRmRecoveryServicesBackupRetentionPolicyObject - -## SYNOPSIS -Gets a base retention policy object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmRecoveryServicesBackupRetentionPolicyObject [-WorkloadType] <WorkloadType> - [[-BackupManagementType] <BackupManagementType>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRecoveryServicesBackupRetentionPolicyObject** cmdlet gets a base **AzureRMRecoveryServicesRetentionPolicyObject**. -This object is not persisted in the system. -It is a temporary object that you can manipulate and use with the New-AzureRmRecoveryServicesBackupProtectionPolicy cmdlet to create a new backup policy. - -## EXAMPLES - -### Example 1: Create a backup protection policy -``` -PS C:\>$RetPol = Get-AzureRmRecoveryServicesBackupRetentionPolicyObject -WorkloadType AzureVM -PS C:\> $RetPol.DailySchedule.DurationCountInDays = 365 -PS C:\> $SchPol = Get-AzureRmRecoveryServicesBackupSchedulePolicyObject -WorkloadType AzureVM -PS C:\> New-AzureRmRecoveryServicesBackupProtectionPolicy -Name "NewPolicy" -WorkloadType AzureVM -RetentionPolicy $RetPol -SchedulePolicy $SchPol -``` - -The first command gets the retention policy object, and then stores it in the $RetPol variable. -The second command sets the duration for the retention policy object to 365 days. -The third command gets the schedule policy object, and then stores it in the $SchPol variable. -The last command creates a backup protection policy using the retention policy and schedule policy created with the previous commands. - -## PARAMETERS - -### -BackupManagementType -Specifies the Backup management type. -The acceptable values for this parameter are: -- AzureVM -- AzureSQLDatabase -- AzureStorage - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.BackupManagementType] -Parameter Sets: (All) -Aliases: -Accepted values: AzureVM, MARS, SCDPM, AzureBackupServer, AzureSQL, AzureStorage - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkloadType -Specifies the workload type. -The acceptable values for this parameter are: -- AzureVM -- AzureSQLDatabase -- AzureFiles - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.WorkloadType -Parameter Sets: (All) -Aliases: -Accepted values: AzureVM, AzureSQLDatabase, AzureFiles - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RetentionPolicyBase - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesBackupSchedulePolicyObject](./Get-AzureRmRecoveryServicesBackupSchedulePolicyObject.md) - -[New-AzureRmRecoveryServicesBackupProtectionPolicy](./New-AzureRmRecoveryServicesBackupProtectionPolicy.md) - - diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupSchedulePolicyObject.md b/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupSchedulePolicyObject.md deleted file mode 100644 index 43e2402464..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupSchedulePolicyObject.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.Backup.dll-Help.xml -Module Name: AzureRM.RecoveryServices.Backup -ms.assetid: E247C6DF-B53D-487E-AAA2-551FCBFD77E7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/get-azurermrecoveryservicesbackupschedulepolicyobject -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Get-AzureRmRecoveryServicesBackupSchedulePolicyObject.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Get-AzureRmRecoveryServicesBackupSchedulePolicyObject.md ---- - -# Get-AzureRmRecoveryServicesBackupSchedulePolicyObject - -## SYNOPSIS -Gets a base schedule policy object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmRecoveryServicesBackupSchedulePolicyObject [-WorkloadType] <WorkloadType> - [[-BackupManagementType] <BackupManagementType>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRecoveryServicesBackupSchedulePolicyObject** cmdlet gets a base **AzureRMRecoveryServicesSchedulePolicyObject**. -This object is not persisted in the system. -It is temporary object that you can manipulate and use with the New-AzureRmRecoveryServicesBackupProtectionPolicy cmdlet to create a new backup protection policy. - -## EXAMPLES - -### Example 1: Set the schedule frequency to weekly -``` -PS C:\>$RetPol = Get-AzureRmRecoveryServicesBackupRetentionPolicyObject -WorkloadType "AzureVM" -PS C:\> $SchPol = Get-AzureRmRecoveryServicesBackupSchedulePolicyObject -WorkloadType "AzureVM" -PS C:\> $SchPol.ScheduleRunFrequency = "Weekly" -PS C:\> New-AzureRmRecoveryServicesBackupProtectionPolicy -Name "NewPolicy" -WorkloadType AzureVM -RetentionPolicy $RetPol -SchedulePolicy $SchPol -``` - -The first command gets the retention policy object, and then stores it in the $RetPol variable. -The second command gets the schedule policy object, and then stores it in the $SchPol variable. -The third command changes the frequency for the schedule policy to weekly. -The last command creates a backup protection policy with the updated schedule. - -### Example 2: Set the backup time -``` -PS C:\>$SchPol = Get-AzureRmRecoveryServicesBackupSchedulePolicyObject -WorkloadType "AzureVM" -PS C:\> $SchPol.ScheduleRunTimes.RemoveAll() -PS C:\> $DT = Get-Date -PS C:\> $SchPol.ScheduleRunTimes.Add($DT.ToUniversalTime()) -PS C:\> New-AzureRmRecoveryServicesBackupProtectionPolicy -Name "NewPolicy" -WorkloadType AzureVM -RetentionPolicy $RetPol -SchedulePolicy $SchPol -``` - -The first command gets the schedule policy object, and then stores it in the $SchPol variable. -The second command removes all scheduled run times from $SchPol. -The third command gets the current date and time, and then stores it in the $DT variable. -The fourth command replaces the scheduled run times with the current time. -You can only backup AzureVM once per day, so to reset the backup time you must replace the original schedule. -The last command creates a backup protection policy using the new schedule. - -## PARAMETERS - -### -BackupManagementType -Specifies the Backup management type. -The acceptable values for this parameter are: -- AzureVM -- AzureSQLDatabase -- AzureStorage - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.BackupManagementType] -Parameter Sets: (All) -Aliases: -Accepted values: AzureVM, MARS, SCDPM, AzureBackupServer, AzureSQL, AzureStorage - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkloadType -Specifies the workload type. -The acceptable values for this parameter are: -- AzureVM -- AzureSQLDatabase -- AzureFiles - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.WorkloadType -Parameter Sets: (All) -Aliases: -Accepted values: AzureVM, AzureSQLDatabase, AzureFiles - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.SchedulePolicyBase - -## NOTES - -## RELATED LINKS - -[New-AzureRmRecoveryServicesBackupProtectionPolicy](./New-AzureRmRecoveryServicesBackupProtectionPolicy.md) - -[Set-AzureRmRecoveryServicesBackupProtectionPolicy](./Set-AzureRmRecoveryServicesBackupProtectionPolicy.md) - - diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupStatus.md b/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupStatus.md deleted file mode 100644 index 5526fdefab..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Get-AzureRmRecoveryServicesBackupStatus.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.Backup.dll-Help.xml -Module Name: AzureRM.RecoveryServices.Backup -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/get-azurermrecoveryservicesbackupstatus -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Get-AzureRmRecoveryServicesBackupStatus.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Get-AzureRmRecoveryServicesBackupStatus.md ---- - -# Get-AzureRmRecoveryServicesBackupStatus - -## SYNOPSIS -Checks whether your ARM resource is backed up or not. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Name (Default) -``` -Get-AzureRmRecoveryServicesBackupStatus -Name <String> -ResourceGroupName <String> -Type <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### Id -``` -Get-AzureRmRecoveryServicesBackupStatus -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The command returns null/empty if the specified resource is not protected under any Recovery Services vault in the subscription. -If it is protected, the relevant vault details will be returned. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $status = Get-AzureRmRecoveryServicesBackupStatus -Name "myAzureVM" -ResourceGroupName "myAzureVMRG" -ResourceType "AzureVM" -PS C:\> If ($status.BackedUp -eq $false) { -$vault = Get-AzureRmRecoveryServicesVault -Name "testvault" -ResourceGroupName "vaultResourceGroup" -$defPolicy = Get-AzureRmRecoveryServicesBackupProtectionPolicy -Vault $vault -WorkloadType "AzureVM" -Enable-AzureRmRecoveryServicesBackupProtection -Vault $vault -Policy $defpol -Name "myAzureVM" -ResourceGroupName "myAzureVMRG" -} -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the Azure Resource whose representative item needs to be checked if it is already protected by some Recovery Services Vault in the subscription. - -```yaml -Type: System.String -Parameter Sets: Name -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of the resource group of the Azure Resource whose representative item needs to be checked if it is already protected by some RecoveryServices Vault in the subscription. - -```yaml -Type: System.String -Parameter Sets: Name -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -ID of the Azure Resource whose representative item needs to be checked if it is already protected by some RecoveryServices Vault in the subscription. - -```yaml -Type: System.String -Parameter Sets: Id -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Type -Name of the Azure Resource whose representative item needs to be checked if it is already protected by some Recovery Services Vault in the subscription. - -```yaml -Type: System.String -Parameter Sets: Name -Aliases: -Accepted values: AzureVM, AzureFiles - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ResourceBackupStatus - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/New-AzureRmRecoveryServicesBackupProtectionPolicy.md b/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/New-AzureRmRecoveryServicesBackupProtectionPolicy.md deleted file mode 100644 index 3dcfa34b47..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/New-AzureRmRecoveryServicesBackupProtectionPolicy.md +++ /dev/null @@ -1,240 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.Backup.dll-Help.xml -Module Name: AzureRM.RecoveryServices.Backup -ms.assetid: C2A7F37B-5713-4430-B83F-C6745692396D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/new-azurermrecoveryservicesbackupprotectionpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/New-AzureRmRecoveryServicesBackupProtectionPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/New-AzureRmRecoveryServicesBackupProtectionPolicy.md ---- - -# New-AzureRmRecoveryServicesBackupProtectionPolicy - -## SYNOPSIS -Creates a Backup protection policy. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmRecoveryServicesBackupProtectionPolicy [-Name] <String> [-WorkloadType] <WorkloadType> - [[-BackupManagementType] <BackupManagementType>] [[-RetentionPolicy] <RetentionPolicyBase>] - [[-SchedulePolicy] <SchedulePolicyBase>] [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmRecoveryServicesBackupProtectionPolicy** cmdlet creates a Backup protection policy in a vault. -A protection policy is associated with at least one retention policy. -The retention policy defines how long a recovery point is kept with Azure Backup. -You can use the Get-AzureRmRecoveryServicesBackupRetentionPolicyObject cmdlet to get the default retention policy. -And you can use the Get-AzureRmRecoveryServicesBackupSchedulePolicyObject cmdlet to get the default schedule policy. -The **SchedulePolicy** and **RetentionPolicy** objects are used as inputs to the **New-AzureRmRecoveryServicesBackupProtectionPolicy** cmdlet. -Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. - -## EXAMPLES - -### Example 1: Create a Backup protection policy -``` -PS C:\> $SchPol = Get-AzureRmRecoveryServicesBackupSchedulePolicyObject -WorkloadType "AzureVM" -PS C:\> $SchPol.ScheduleRunTimes.Clear() -PS C:\> $Dt = Get-Date -PS C:\> $SchPol.ScheduleRunTimes.Add($Dt.ToUniversalTime()) -PS C:\> $RetPol = Get-AzureRmRecoveryServicesBackupRetentionPolicyObject -WorkloadType "AzureVM" -PS C:\> $RetPol.DailySchedule.DurationCountInDays = 365 -PS C:\> New-AzureRmRecoveryServicesBackupProtectionPolicy -Name "NewPolicy" -WorkloadType AzureVM -RetentionPolicy $RetPol -SchedulePolicy $SchPol -``` - -The first command gets a base **SchedulePolicyObject**, and then stores it in the $SchPol variable. -The second command removes all scheduled run times from the schedule policy in $SchPol. -The third command uses the Get-Date cmdlet to get the current date and time. -The fourth command adds the current date and time in $Dt as the scheduled run time to the schedule policy. -The fifth command gets a base **RetentionPolicy** object, and then stores it in the $RetPol variable. -The sixth command sets the retention duration policy to 365 days. -The final command creates a **BackupProtectionPolicy** object based on the schedule and retention policies created by the previous commands. - -## PARAMETERS - -### -BackupManagementType -Specifies the Backup management type. -The acceptable values for this parameter are: -- AzureVM -- AzureSQLDatabase - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.BackupManagementType] -Parameter Sets: (All) -Aliases: -Accepted values: AzureVM, MARS, SCDPM, AzureBackupServer, AzureSQL - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionPolicy -Specifies the base **RetentionPolicy** object. -You can use the Get-AzureRmRecoveryServicesBackupRetentionPolicyObject cmdlet to get a **RetentionPolicy** object. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RetentionPolicyBase -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SchedulePolicy -Specifies the base **SchedulePolicy** object. -You can use the Get-AzureRmRecoveryServicesBackupSchedulePolicyObject cmdlet to get a **SchedulePolicy** object. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.SchedulePolicyBase -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultId -ARM ID of the Recovery Services Vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WorkloadType -Specifies the workload type. -The acceptable values for this parameter are: -- AzureVM -- AzureSQLDatabase - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.WorkloadType -Parameter Sets: (All) -Aliases: -Accepted values: AzureVM, AzureSQLDatabase - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.WorkloadType - -### System.Nullable`1[[Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.BackupManagementType, Microsoft.Azure.Commands.RecoveryServices.Backup.Models, Version=4.3.1.0, Culture=neutral, PublicKeyToken=null]] - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RetentionPolicyBase - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.SchedulePolicyBase - -### System.String -Parameters: VaultId (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.PolicyBase - -## NOTES - -## RELATED LINKS - -[Enable-AzureRmRecoveryServicesBackupProtection](./Enable-AzureRmRecoveryServicesBackupProtection.md) - -[Get-AzureRmRecoveryServicesBackupProtectionPolicy](./Get-AzureRmRecoveryServicesBackupProtectionPolicy.md) - -[Get-AzureRmRecoveryServicesBackupRetentionPolicyObject](./Get-AzureRmRecoveryServicesBackupRetentionPolicyObject.md) - -[Get-AzureRmRecoveryServicesBackupSchedulePolicyObject](./Get-AzureRmRecoveryServicesBackupSchedulePolicyObject.md) - -[Remove-AzureRmRecoveryServicesBackupProtectionPolicy](./Remove-AzureRmRecoveryServicesBackupProtectionPolicy.md) - -[Set-AzureRmRecoveryServicesBackupProtectionPolicy](./Set-AzureRmRecoveryServicesBackupProtectionPolicy.md) - - diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Remove-AzureRmRecoveryServicesBackupProtectionPolicy.md b/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Remove-AzureRmRecoveryServicesBackupProtectionPolicy.md deleted file mode 100644 index 1beb104863..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Remove-AzureRmRecoveryServicesBackupProtectionPolicy.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.Backup.dll-Help.xml -Module Name: AzureRM.RecoveryServices.Backup -ms.assetid: BFE741CC-C166-4534-93F4-D21AAFAD9FF6 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/remove-azurermrecoveryservicesbackupprotectionpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Remove-AzureRmRecoveryServicesBackupProtectionPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Remove-AzureRmRecoveryServicesBackupProtectionPolicy.md ---- - -# Remove-AzureRmRecoveryServicesBackupProtectionPolicy - -## SYNOPSIS -Deletes a Backup protection policy from a vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### PolicyName (Default) -``` -Remove-AzureRmRecoveryServicesBackupProtectionPolicy [-Name] <String> [-PassThru] [-Force] [-VaultId <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### PolicyObject -``` -Remove-AzureRmRecoveryServicesBackupProtectionPolicy [-Policy] <PolicyBase> [-PassThru] [-Force] - [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmRecoveryServicesBackupProtectionPolicy** cmdlet deletes backup policies for a vault. -Before you can delete a Backup protection policy, the policy must not have any associated Backup items. -Before you delete the policy, make sure that each associated item is associated with some other policy. -To associate another policy with a Backup item, use the Enable-AzureRmRecoveryServicesBackupProtection cmdlet. -Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. - -## EXAMPLES - -### Example 1: Remove a policy -``` -PS C:\>$Pol= Get-AzureRmRecoveryServicesBackupProtectionPolicy -Name "NewPolicy" -PS C:\> Remove-AzureRmRecoveryServicesBackupProtectionPolicy -Policy $Pol -``` - -The first command gets the Backup protection policy named NewPolicy, and then stores it in the $Pol variable. -The second command removes the policy object in $Pol. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Backup protection policy to remove. - -```yaml -Type: System.String -Parameter Sets: PolicyName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Return the policy to be deleted. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies the Backup protection policy to remove. -To obtain an **BackupPolicy** object, use the Get-AzureRmRecoveryServicesBackupProtectionPolicy cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.PolicyBase -Parameter Sets: PolicyObject -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VaultId -ARM ID of the Recovery Services Vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.PolicyBase -Parameters: Policy (ByValue) - -### System.String -Parameters: VaultId (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.PolicyBase - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesBackupProtectionPolicy](./Get-AzureRmRecoveryServicesBackupProtectionPolicy.md) - -[New-AzureRmRecoveryServicesBackupProtectionPolicy](./New-AzureRmRecoveryServicesBackupProtectionPolicy.md) - -[Set-AzureRmRecoveryServicesBackupProtectionPolicy](./Set-AzureRmRecoveryServicesBackupProtectionPolicy.md) - - diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Restore-AzureRmRecoveryServicesBackupItem.md b/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Restore-AzureRmRecoveryServicesBackupItem.md deleted file mode 100644 index ca19cb69f6..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Restore-AzureRmRecoveryServicesBackupItem.md +++ /dev/null @@ -1,338 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.Backup.dll-Help.xml -Module Name: AzureRM.RecoveryServices.Backup -ms.assetid: F49FA524-28BC-464F-BD0A-F898E99C83D8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/restore-azurermrecoveryservicesbackupitem -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Restore-AzureRmRecoveryServicesBackupItem.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Restore-AzureRmRecoveryServicesBackupItem.md ---- - -# Restore-AzureRmRecoveryServicesBackupItem - -## SYNOPSIS -Restores the data and configuration for a Backup item to a recovery point. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### AzureVMParameterSet (Default) -``` -Restore-AzureRmRecoveryServicesBackupItem [-VaultLocation <String>] [-RecoveryPoint] <RecoveryPointBase> - [-StorageAccountName] <String> [-StorageAccountResourceGroupName] <String> - [[-TargetResourceGroupName] <String>] [-UseOriginalStorageAccount] [-VaultId <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### AzureFileParameterSet -``` -Restore-AzureRmRecoveryServicesBackupItem [-VaultLocation <String>] [-RecoveryPoint] <RecoveryPointBase> - [-StorageAccountName] <String> [-StorageAccountResourceGroupName] <String> - -ResolveConflict <RestoreFSResolveConfictOption> [-SourceFilePath <String>] [-SourceFileType <SourceFileType>] - [-TargetStorageAccountName <String>] [-TargetFileShareName <String>] [-TargetFolder <String>] - [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Restore-AzureRmRecoveryServicesBackupItem** cmdlet restores the data and configuration for an Azure Backup item to a specified recovery point. -This cmdlet starts the restore from the Recovery Services vault to customer's storage account. -The restore operation does not restore the full virtual machine. -It restores the disk data and configuration information. -After the restore operation is finished, you must create the virtual machine and start it. -Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. - -## EXAMPLES - -### Example 1: Restore an item to a recovery point -``` -PS C:\>$Container = Get-AzureRmRecoveryServicesBackupContainer -ContainerType AzureVM -Status Registered -Name "V2VM" -PS C:\> $BackupItem = Get-AzureRmRecoveryServicesBackupItem -ContainerType AzureVM -WorkloadType AzureVM -PS C:\> $StartDate = (Get-Date).AddDays(-7) -PS C:\> $EndDate = Get-Date -PS C:\> $RP = Get-AzureRmRecoveryServicesBackupRecoveryPoint -Item $BackupItem -StartDate $StartDate.ToUniversalTime() -EndDate $EndDate.ToUniversalTime() -PS C:\> $RestoreJob = Restore-AzureRmRecoveryServicesBackupItem -RecoveryPoint $RP[0] -StorageAccountName "DestAccount" -StorageAccountResourceGroupName "DestRG" - WorkloadName Operation Status StartTime EndTime - ------------ --------- ------ --------- ------- - V2VM Restore InProgress 26-Apr-16 1:14:01 PM 01-Jan-01 12:00:00 AM -``` - -The first command gets the Backup container of type AzureVM, and then stores it in the $Container variable. -The second command gets the Backup item named V2VM from $Container, and then stores it in the $BackupItem variable. -The third command gets the date from seven days earlier, and then stores it in the $StartDate variable. -The fourth command gets the current date, and then stores it in the $EndDate variable. -The fifth command gets a list of recovery points for the specific backup item filtered by $StartDate and $EndDate. -The date range specified is the last 7 days. -The last command restores the disks to the target storage account DestAccount in the DestRG resource group. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryPoint -Specifies the recovery point to which to restore the virtual machine. -To obtain an **AzureRmRecoveryServicesBackupRecoveryPoint** object, use the Get-AzureRmRecoveryServicesBackupRecoveryPoint cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryPointBase -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResolveConflict -In case the restored item also exists in the destination, use this to indicate whether to overwrite or not. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RestoreFSResolveConfictOption -Parameter Sets: AzureFileParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceFilePath -Used for a particular item restore from a file share. The path of the item to be restored within the file share. - -```yaml -Type: System.String -Parameter Sets: AzureFileParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceFileType -Used for a particular item restore from a file share. The path of the item to be restored within the file share. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.SourceFileType -Parameter Sets: AzureFileParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageAccountName -Specifies the name of the target Storage account in your subscription. -As a part of the restore process, this cmdlet stores the disks and the configuration information in this Storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageAccountResourceGroupName -Specifies the name of the resource group that contains the target Storage account in your subscription. -As a part of the restore process, this cmdlet stores the disks and the configuration information in this Storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetFileShareName -The File Share to which the file share has to be restored to. - -```yaml -Type: System.String -Parameter Sets: AzureFileParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetFolder -The folder under which the file share has to be restored to within the targetFileShareName.Leave the variable empty to restore under root folder. - -```yaml -Type: System.String -Parameter Sets: AzureFileParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetResourceGroupName -The resource group to which the managed disks are restored. Applicable to backup of VM with managed disks - -```yaml -Type: System.String -Parameter Sets: AzureVMParameterSet -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetStorageAccountName -The storage account to which the file share has to be restored to. - -```yaml -Type: System.String -Parameter Sets: AzureFileParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseOriginalStorageAccount -Use this switch if the disks from the recovery point are to be restored to their original storage accounts. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: AzureVMParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultId -ARM ID of the Recovery Services Vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VaultLocation -Location of the Recovery Services Vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: VaultId (ByValue), VaultLocation (ByValue) - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryPointBase -Parameters: RecoveryPoint (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase - -## NOTES - -## RELATED LINKS - -[Backup-AzureRmRecoveryServicesBackupItem](./Backup-AzureRmRecoveryServicesBackupItem.md) - -[Get-AzureRmRecoveryServicesBackupItem](./Get-AzureRmRecoveryServicesBackupItem.md) - -[Get-AzureRmRecoveryServicesBackupRecoveryPoint](./Get-AzureRmRecoveryServicesBackupRecoveryPoint.md) - - diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Set-AzureRmRecoveryServicesBackupProtectionPolicy.md b/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Set-AzureRmRecoveryServicesBackupProtectionPolicy.md deleted file mode 100644 index f25883e338..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Set-AzureRmRecoveryServicesBackupProtectionPolicy.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.Backup.dll-Help.xml -Module Name: AzureRM.RecoveryServices.Backup -ms.assetid: D614B509-82DD-42FB-B975-D72CD3355E3E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/set-azurermrecoveryservicesbackupprotectionpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Set-AzureRmRecoveryServicesBackupProtectionPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Set-AzureRmRecoveryServicesBackupProtectionPolicy.md ---- - -# Set-AzureRmRecoveryServicesBackupProtectionPolicy - -## SYNOPSIS -Modifies a Backup protection policy. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmRecoveryServicesBackupProtectionPolicy [-Policy] <PolicyBase> - [[-RetentionPolicy] <RetentionPolicyBase>] [[-SchedulePolicy] <SchedulePolicyBase>] [-VaultId <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmBackupProtectionPolicy** cmdlet modifies an existing Azure Backup protection policy. -You can modify the Backup schedule and retention policy components. -Any changes you make affect the backup and retention of the items associated with the policy. -Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. - -## EXAMPLES - -### Example 1: Modify a Backup protection policy -``` -PS C:\>$SchPol = Get-AzureRmRecoveryServicesBackupSchedulePolicyObject -WorkloadType "AzureVM" -PS C:\> $SchPol.ScheduleRunTimes.RemoveAll() -PS C:\> $DT = Get-Date -PS C:\> $SchPol.ScheduleRunTimes.Add($DT.ToUniversalTime()) -PS C:\> $RetPol = Get-AzureRmRecoveryServicesBackupRetentionPolicyObject -WorkloadType "AzureVM" -PS C:\> $RetPol.DailySchedule.DurationCountInDays = 365 -PS C:\> $Pol = Get-AzureRmRecoveryServicesBackupProtectionPolicy -Name "NewPolicy" -PS C:\> Set-AzureRmRecoveryServicesBackupProtectionPolicy -Policy $Pol -SchedulePolicy $SchPol -RetentionPolicy $RetPol -``` - -The first command gets a base SchedulePolicy object, and then stores it in the $SchPol variable. -The second command removes all scheduled run times from the schedule policy in $SchPol. -The third command uses the Get-Date cmdlet to get the current date and time, and then stores it in the $DT variable. -The fourth command adds the date and time in $DT to the schedule run time for the schedule policy. -The fifth command gets a base retention policy object, and then stores it in the $RetPol variable. -The sixth command sets the retention duration to 365 days. -The seventh command gets the Backup protection policy named NewPolicy, and then stores it in the $Pol variable. -The final command modifies the Backup protection policy in $Pol using schedule policy in $SchPol and the retention policy in $RetPol. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies the Backup protection policy that this cmdlet modifies. -To obtain a **BackupProtectionPolicy** object, use the Get-AzureRmRecoveryServicesBackupProtectionPolicy cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.PolicyBase -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RetentionPolicy -Specifies the base retention policy. -To obtain a **RetentionPolicy** object, use the Get-AzureRmRecoveryServicesBackupRetentionPolicyObject cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RetentionPolicyBase -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SchedulePolicy -Specifies the base schedule policy object. -To obtain a **SchedulePolicy** object, use the Get-AzureRmRecoveryServicesBackupSchedulePolicyObject object. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.SchedulePolicyBase -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultId -ARM ID of the Recovery Services Vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.PolicyBase -Parameters: Policy (ByValue) - -### System.String -Parameters: VaultId (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesBackupProtectionPolicy](./Get-AzureRmRecoveryServicesBackupProtectionPolicy.md) - -[Get-AzureRmRecoveryServicesBackupRetentionPolicyObject](./Get-AzureRmRecoveryServicesBackupRetentionPolicyObject.md) - -[New-AzureRmRecoveryServicesBackupProtectionPolicy](./New-AzureRmRecoveryServicesBackupProtectionPolicy.md) - -[Remove-AzureRmRecoveryServicesBackupProtectionPolicy](./Remove-AzureRmRecoveryServicesBackupProtectionPolicy.md) - - diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Stop-AzureRmRecoveryServicesBackupJob.md b/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Stop-AzureRmRecoveryServicesBackupJob.md deleted file mode 100644 index 5218d6dc7a..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Stop-AzureRmRecoveryServicesBackupJob.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.Backup.dll-Help.xml -Module Name: AzureRM.RecoveryServices.Backup -ms.assetid: A8FDC5A3-F309-49B3-B417-8E0A1535BAF4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/stop-azurermrecoveryservicesbackupjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Stop-AzureRmRecoveryServicesBackupJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Stop-AzureRmRecoveryServicesBackupJob.md ---- - -# Stop-AzureRmRecoveryServicesBackupJob - -## SYNOPSIS -Cancels a running job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### JobFilterSet (Default) -``` -Stop-AzureRmRecoveryServicesBackupJob [-Job] <JobBase> [-VaultId <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### IdFilterSet -``` -Stop-AzureRmRecoveryServicesBackupJob [-JobId] <String> [-VaultId <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Stop-AzureRmRecoveryServicesBackupJob** cmdlet cancels an existing Azure Backup job. -Use this cmdlet to stop a job that takes too long and blocks other activities. -You can cancel only Backup and Restore job types. -Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. - -## EXAMPLES - -### Example 1: Stop a backup job -``` -PS C:\>$Job = Get-AzureRmRecoveryServicesBackupJob -Operation Backup -PS C:\> Stop-AzureRmRecoveryServicesBackupJob -JobID $Job.InstanceId -``` - -The first command gets a backup job, and then stores the job in the $Job variable. -The last command stops the job by specifying the Instance ID of the backup job in $Job. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Job -Specifies a job that this cmdlet cancels. -To obtain a **BackupJob** object, use the Get-AzureRmRecoveryServicesBackupJob cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase -Parameter Sets: JobFilterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobId -Specifies the ID of the job to cancel. -The ID is the InstanceId property of a **BackupJob** object. -To obtain an **BackupJob** object, use Get-AzureRmRecoveryServicesBackupJob. - -```yaml -Type: System.String -Parameter Sets: IdFilterSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultId -ARM ID of the Recovery Services Vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: VaultId (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesBackupJob](./Get-AzureRmRecoveryServicesBackupJob.md) - -[Wait-AzureRmRecoveryServicesBackupJob](./Wait-AzureRmRecoveryServicesBackupJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Unregister-AzureRmRecoveryServicesBackupContainer.md b/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Unregister-AzureRmRecoveryServicesBackupContainer.md deleted file mode 100644 index 0bcc516d0f..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Unregister-AzureRmRecoveryServicesBackupContainer.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.Backup.dll-Help.xml -Module Name: AzureRM.RecoveryServices.Backup -ms.assetid: A10DC2A2-A732-416F-9C68-6533C143AE8F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/unregister-azurermrecoveryservicesbackupcontainer -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Unregister-AzureRmRecoveryServicesBackupContainer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Unregister-AzureRmRecoveryServicesBackupContainer.md ---- - -# Unregister-AzureRmRecoveryServicesBackupContainer - -## SYNOPSIS -Unregisters a Windows Server or other container from the vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Unregister-AzureRmRecoveryServicesBackupContainer [-Container] <ContainerBase> [-PassThru] [-VaultId <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Unregister-AzureRmRecoveryServicesBackupContainer** cmdlet unregisters a Windows Server or other Backup container from the vault. -This cmdlet removes references to a container from the vault. -Before you can unregister a container, you must delete any protected data associated with that container. -Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. - -## EXAMPLES - -### Example 1: Unregister a Windows Server from the vault -``` -PS C:\>$Cont = Get-AzureRmRecoveryServicesBackupContainer -ContainerType "Windows" -BackupManagementType MARS -Name "server01.contoso.com" -PS C:\> Unregister-AzureRmRecoveryServicesBackupContainer -Container $Cont -``` - -The first command gets the Windows container named server01.contoso.com that is registered in the vault, and then stores it in the $Cont variable. -The second command unregisters the specified Windows Server from the Azure Backup vault. - -## PARAMETERS - -### -Container -Specifies a Backup container object to unregister. -To obtain a **BackupContainer** object, use the Get-AzureRmRecoveryServicesBackupContainer cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ContainerBase -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Return the container to be deleted. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultId -ARM ID of the Recovery Services Vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: VaultId (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ContainerBase - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesBackupContainer](./Get-AzureRmRecoveryServicesBackupContainer.md) - - diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Unregister-AzureRmRecoveryServicesBackupManagementServer.md b/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Unregister-AzureRmRecoveryServicesBackupManagementServer.md deleted file mode 100644 index e2b489730f..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Unregister-AzureRmRecoveryServicesBackupManagementServer.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.Backup.dll-Help.xml -Module Name: AzureRM.RecoveryServices.Backup -ms.assetid: BBF12B16-C5FD-4AE2-B5D7-AFDC29CEE4D3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/unregister-azurermrecoveryservicesbackupmanagementserver -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Unregister-AzureRmRecoveryServicesBackupManagementServer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Unregister-AzureRmRecoveryServicesBackupManagementServer.md ---- - -# Unregister-AzureRmRecoveryServicesBackupManagementServer - -## SYNOPSIS -Unregisters a SCDPM server or Backup server from the vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Unregister-AzureRmRecoveryServicesBackupManagementServer [-AzureRmBackupManagementServer] <BackupEngineBase> - [-PassThru] [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Unregister-AzureRmRecoveryServicesBackupManagementServer** cmdlet unregisters a System Center Data Protection Manager (SCDPM) server or an Azure Backup server from the vault. -This cmdlet removes references to the servers that are unregistered from the vault. -Before you can unregister a container, you must delete any protected data associated with that container. -Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. - -## EXAMPLES - -### Example 1: Unregister an SCDPM server from the vault -``` -PS C:\>$BMS = Get-AzureRmRecoveryServicesBackupManagementServer -Name "dpmserver01.contoso.com" -PS C:\> Unregister-AzureRmRecoveryServicesBackupManagementServer -AzureRmBackupManagementServer $BMS -``` - -The first command gets the Backup management server named dpmserver01.contoso.com, and then stores it in the $BMS variable. -The second command unregisters the SCDPM server from the vault. - -## PARAMETERS - -### -AzureRmBackupManagementServer -Specifies an SCDPM server object to unregister. -To obtain an **BackupManagementServer** object, use the Get-AzureRmRecoveryServicesBackupManagementServer cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.BackupEngineBase -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Return the Backup Management Server to be deleted. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultId -ARM ID of the Recovery Services Vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: VaultId (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.BackupEngineBase - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesBackupManagementServer](./Get-AzureRmRecoveryServicesBackupManagementServer.md) - - diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Wait-AzureRmRecoveryServicesBackupJob.md b/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Wait-AzureRmRecoveryServicesBackupJob.md deleted file mode 100644 index c8a064df60..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.Backup/Wait-AzureRmRecoveryServicesBackupJob.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.Backup.dll-Help.xml -Module Name: AzureRM.RecoveryServices.Backup -ms.assetid: F671A7CC-2A27-460E-B064-2FBF1B9C6A0B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/wait-azurermrecoveryservicesbackupjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Wait-AzureRmRecoveryServicesBackupJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Wait-AzureRmRecoveryServicesBackupJob.md ---- - -# Wait-AzureRmRecoveryServicesBackupJob - -## SYNOPSIS -Waits for a Backup job to finish. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Wait-AzureRmRecoveryServicesBackupJob [-Job] <Object> [[-Timeout] <Int64>] [-VaultId <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Wait-AzureRmRecoveryServicesBackupJob** cmdlet waits for an Azure Backup job to finish. -Backup jobs can take a long time. -If you run a backup job as part of a script, you may want to force the script to wait for job to finish before it continues to other tasks. -A script that includes this cmdlet can be simpler than one that polls the Backup service for the job status. -Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. - -## EXAMPLES - -### Example 1: Wait for a job to finish -``` -PS C:\> -$Jobs = Get-AzureRmRecoveryServicesBackupJob -Status InProgress - $Job = $Jobs[0] - while ( $Job.Status -ne Completed ) - { - Write-Host "Waiting for completion..." - Start-Sleep -Seconds 10 - $Job = Get-AzureRmBackAzureRmRecoveryServicesBackupJob -Job $Job - } - Write-Host "Done!" - Waiting for completion... - Waiting for completion... - Waiting for completion... - Done! -``` - -This script polls the first job that is currently in progress until the job has completed. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Job -Specifies the job to wait for. -To obtain a **BackupJob** object, use the Get-AzureRmRecoveryServicesBackupJob cmdlet. - -```yaml -Type: System.Object -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Timeout -Specifies the maximum time, in seconds, that this cmdlet waits for the job to finish. -It is recommended to specify a time-out value. - -```yaml -Type: System.Nullable`1[System.Int64] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultId -ARM ID of the Recovery Services Vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Object -Parameters: Job (ByValue) - -### System.String -Parameters: VaultId (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesBackupJob](./Get-AzureRmRecoveryServicesBackupJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/AzureRM.RecoveryServices.SiteRecovery.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/AzureRM.RecoveryServices.SiteRecovery.md deleted file mode 100644 index 97c960737b..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/AzureRM.RecoveryServices.SiteRecovery.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -Module Name: AzureRM.RecoveryServices.SiteRecovery -Module Guid: d1de7560-48e1-48f3-bc8c-4eea3af2bbe2 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery -Help Version: 0.1.3.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/AzureRM.RecoveryServices.SiteRecovery.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/AzureRM.RecoveryServices.SiteRecovery.md ---- - -# AzureRM.RecoveryServices.SiteRecovery Module -## Description -This topic displays help topics for the Azure Site Recovery Cmdlets. - -## AzureRM.RecoveryServices.SiteRecovery Cmdlets -### [Edit-AzureRmRecoveryServicesAsrRecoveryPlan](Edit-AzureRmRecoveryServicesAsrRecoveryPlan.md) -Edits a Site Recovery plan. - -### [Get-AzureRmRecoveryServicesAsrAlertSetting](Get-AzureRmRecoveryServicesAsrAlertSetting.md) -Gets the configured Azure Site Recovery notification settings for the vault. - -### [Get-AzureRmRecoveryServicesAsrEvent](Get-AzureRmRecoveryServicesAsrEvent.md) -Gets details of Azure Site Recovery events in the vault. - -### [Get-AzureRmRecoveryServicesAsrFabric](Get-AzureRmRecoveryServicesAsrFabric.md) -Get the details of an Azure Site Recovery Fabric. - -### [Get-AzureRmRecoveryServicesAsrJob](Get-AzureRmRecoveryServicesAsrJob.md) -Gets the details of the specified ASR job or the list of recent ASR jobs in the Recovery Services vault. - -### [Get-AzureRmRecoveryServicesAsrNetwork](Get-AzureRmRecoveryServicesAsrNetwork.md) -Gets information about the networks managed by Site Recovery for the current vault. - -### [Get-AzureRmRecoveryServicesAsrNetworkMapping](Get-AzureRmRecoveryServicesAsrNetworkMapping.md) -Gets information about Site Recovery network mappings for the current vault. - -### [Get-AzureRmRecoveryServicesAsrPolicy](Get-AzureRmRecoveryServicesAsrPolicy.md) -Gets ASR replication policies. - -### [Get-AzureRmRecoveryServicesAsrProtectableItem](Get-AzureRmRecoveryServicesAsrProtectableItem.md) -Get the protectable items in an ASR protection container. - -### [Get-AzureRmRecoveryServicesAsrProtectionContainer](Get-AzureRmRecoveryServicesAsrProtectionContainer.md) -Gets ASR protection containers in the Recovery Services vault. - -### [Get-AzureRmRecoveryServicesAsrProtectionContainerMapping](Get-AzureRmRecoveryServicesAsrProtectionContainerMapping.md) -Gets Azure Site Recovery Protection Container mappings. - -### [Get-AzureRmRecoveryServicesAsrRecoveryPlan](Get-AzureRmRecoveryServicesAsrRecoveryPlan.md) -Gets a recovery plan or all the recovery plans in the Recovery Services vault - -### [Get-AzureRmRecoveryServicesAsrRecoveryPoint](Get-AzureRmRecoveryServicesAsrRecoveryPoint.md) -Gets the available recovery points for a replication protected item. - -### [Get-AzureRmRecoveryServicesAsrReplicationProtectedItem](Get-AzureRmRecoveryServicesAsrReplicationProtectedItem.md) -Gets the properties of an Azure Site Recovery Replication Protected Items. - -### [Get-AzureRmRecoveryServicesAsrServicesProvider](Get-AzureRmRecoveryServicesAsrServicesProvider.md) -Gets the details of the ASR recovery services providers registered to the Recovery Services vault. - -### [Get-AzureRmRecoveryServicesAsrStorageClassification](Get-AzureRmRecoveryServicesAsrStorageClassification.md) -Gets the available(discovered) ASR storage classifications in the Recovery Services vault. - -### [Get-AzureRmRecoveryServicesAsrStorageClassificationMapping](Get-AzureRmRecoveryServicesAsrStorageClassificationMapping.md) -Gets ASR storage classification mappings. - -### [Get-AzureRmRecoveryServicesAsrVaultContext](Get-AzureRmRecoveryServicesAsrVaultContext.md) -Gets ASR vault settings information for the Recovery Services vault. - -### [Get-AzureRmRecoveryServicesAsrvCenter](Get-AzureRmRecoveryServicesAsrvCenter.md) -Gets details of the vCenter servers registered for discovery on the Configuration server specified by the ASR fabric. - -### [Import-AzureRmRecoveryServicesAsrVaultSettingsFile](Import-AzureRmRecoveryServicesAsrVaultSettingsFile.md) -Imports the specified ASR vault settings file to set the vault context(PowerShell session context) for subsequent ASR operations in the PowerShell session. - -### [New-AzureRmRecoveryServicesAsrAzureToAzureDiskReplicationConfig](New-AzureRmRecoveryServicesAsrAzureToAzureDiskReplicationConfig.md) -Creates a disk mapping object for Azure virtual machine disks to be replicated. - -### [New-AzureRmRecoveryServicesAsrFabric](New-AzureRmRecoveryServicesAsrFabric.md) -Creates an Azure Site Recovery Fabric. - -### [New-AzureRmRecoveryServicesAsrNetworkMapping](New-AzureRmRecoveryServicesAsrNetworkMapping.md) -Creates an ASR network mapping between two networks. - -### [New-AzureRmRecoveryServicesAsrPolicy](New-AzureRmRecoveryServicesAsrPolicy.md) -Creates an Azure Site Recovery replication policy. - -### [New-AzureRmRecoveryServicesAsrProtectableItem](New-AzureRmRecoveryServicesAsrProtectableItem.md) -Add(Discover) a physical server to the list of protectable items. - -### [New-AzureRmRecoveryServicesAsrProtectionContainer](New-AzureRmRecoveryServicesAsrProtectionContainer.md) -Creates an Azure Site Recovery Protection Container within the specified fabric. - -### [New-AzureRmRecoveryServicesAsrProtectionContainerMapping](New-AzureRmRecoveryServicesAsrProtectionContainerMapping.md) -Creates an Azure Site Recovery Protection Container mapping by associating the specified replication policy to the specified ASR protection container. - -### [New-AzureRmRecoveryServicesAsrRecoveryPlan](New-AzureRmRecoveryServicesAsrRecoveryPlan.md) -Creates an ASR recovery plan. - -### [New-AzureRmRecoveryServicesAsrReplicationProtectedItem](New-AzureRmRecoveryServicesAsrReplicationProtectedItem.md) -Enables replication for an ASR protectable item by creating a replication protected item. - -### [New-AzureRmRecoveryServicesAsrStorageClassificationMapping](New-AzureRmRecoveryServicesAsrStorageClassificationMapping.md) -Creates an ASR storage classification mapping in the Recovery Services vault. - -### [New-AzureRmRecoveryServicesAsrvCenter](New-AzureRmRecoveryServicesAsrvCenter.md) -Adds a vCenter server to discover protectable items from. - -### [Remove-AzureRmRecoveryServicesAsrFabric](Remove-AzureRmRecoveryServicesAsrFabric.md) -Deletes the specified Azure Site Recovery Fabric from the Recovery Services vault. - -### [Remove-AzureRmRecoveryServicesAsrNetworkMapping](Remove-AzureRmRecoveryServicesAsrNetworkMapping.md) -Deletes the specified ASR network mapping from the Recovery Services vault. - -### [Remove-AzureRmRecoveryServicesAsrPolicy](Remove-AzureRmRecoveryServicesAsrPolicy.md) -Deletes the specified ASR replication policy from the Recovery Services vault. - -### [Remove-AzureRmRecoveryServicesAsrProtectionContainer](Remove-AzureRmRecoveryServicesAsrProtectionContainer.md) -Deletes the specified Protection Container from its Fabric. - -### [Remove-AzureRmRecoveryServicesAsrProtectionContainerMapping](Remove-AzureRmRecoveryServicesAsrProtectionContainerMapping.md) -Deletes the specified Azure Site Recovery protection container mapping. - -### [Remove-AzureRmRecoveryServicesAsrRecoveryPlan](Remove-AzureRmRecoveryServicesAsrRecoveryPlan.md) -Deletes the specified ASR recovery plan from Recovery Services vault. - -### [Remove-AzureRmRecoveryServicesAsrReplicationProtectedItem](Remove-AzureRmRecoveryServicesAsrReplicationProtectedItem.md) -Stops/Disables replication for an Azure Site Recovery replication protected item. - -### [Remove-AzureRmRecoveryServicesAsrServicesProvider](Remove-AzureRmRecoveryServicesAsrServicesProvider.md) -Deletes/unregister the specified Azure Site Recovery recovery services provider from the recovery services vault. - -### [Remove-AzureRmRecoveryServicesAsrStorageClassificationMapping](Remove-AzureRmRecoveryServicesAsrStorageClassificationMapping.md) -Deletes the specified ASR storage classification mapping. - -### [Remove-AzureRmRecoveryServicesAsrvCenter](Remove-AzureRmRecoveryServicesAsrvCenter.md) -Removes the vCenter server from the ASR fabric and stops discovery of virtual machines from the vCenter server. - -### [Restart-AzureRmRecoveryServicesAsrJob](Restart-AzureRmRecoveryServicesAsrJob.md) -Restarts an Azure Site Recovery job. - -### [Resume-AzureRmRecoveryServicesAsrJob](Resume-AzureRmRecoveryServicesAsrJob.md) -Resumes a suspended Azure Site Recovery job. - -### [Set-AzureRmRecoveryServicesAsrAlertSetting](Set-AzureRmRecoveryServicesAsrAlertSetting.md) -Configure Azure Site Recovery notification settings (email notification) for the vault. - -### [Set-AzureRmRecoveryServicesAsrReplicationProtectedItem](Set-AzureRmRecoveryServicesAsrReplicationProtectedItem.md) -Sets recovery properties such as target network and virtual machine size for the specified replication protected item. - -### [Set-AzureRmRecoveryServicesAsrVaultContext](Set-AzureRmRecoveryServicesAsrVaultContext.md) -Sets the Recovery Services vault context to be used for subsequent Azure Site Recovery operations in the current PowerShell session. - -### [Start-AzureRmRecoveryServicesAsrApplyRecoveryPoint](Start-AzureRmRecoveryServicesAsrApplyRecoveryPoint.md) -Changes a recovery point for a failed over protected item before commiting the failover operation. - -### [Start-AzureRmRecoveryServicesAsrCommitFailoverJob](Start-AzureRmRecoveryServicesAsrCommitFailoverJob.md) -Starts the commit failover action for a Site Recovery object. - -### [Start-AzureRmRecoveryServicesAsrPlannedFailoverJob](Start-AzureRmRecoveryServicesAsrPlannedFailoverJob.md) -Starts a planned failover operation. - -### [Start-AzureRmRecoveryServicesAsrResynchronizeReplicationJob](Start-AzureRmRecoveryServicesAsrResynchronizeReplicationJob.md) -Starts replication resynchronization. - -### [Start-AzureRmRecoveryServicesAsrSwitchProcessServerJob](Start-AzureRmRecoveryServicesAsrSwitchProcessServerJob.md) -Switch replication from one Process server to another for load balancing. - -### [Start-AzureRmRecoveryServicesAsrTestFailoverCleanupJob](Start-AzureRmRecoveryServicesAsrTestFailoverCleanupJob.md) -Starts the test failover cleanup operation. - -### [Start-AzureRmRecoveryServicesAsrTestFailoverJob](Start-AzureRmRecoveryServicesAsrTestFailoverJob.md) -Starts a test failover operation. - -### [Start-AzureRmRecoveryServicesAsrUnplannedFailoverJob](Start-AzureRmRecoveryServicesAsrUnplannedFailoverJob.md) -Starts a unplanned failover operation. - -### [Stop-AzureRmRecoveryServicesAsrJob](Stop-AzureRmRecoveryServicesAsrJob.md) -Stops an Azure Site Recovery job. - -### [Update-AzureRmRecoveryServicesAsrMobilityService](Update-AzureRmRecoveryServicesAsrMobilityService.md) -Push mobility service agent updates to protected machines. - -### [Update-AzureRmRecoveryServicesAsrNetworkMapping](Update-AzureRmRecoveryServicesAsrNetworkMapping.md) -Updates the specified azure site recovery network mapping. - -### [Update-AzureRmRecoveryServicesAsrPolicy](Update-AzureRmRecoveryServicesAsrPolicy.md) -Updates an Azure Site Recovery replication policy. - -### [Update-AzureRmRecoveryServicesAsrProtectionDirection](Update-AzureRmRecoveryServicesAsrProtectionDirection.md) -Updates the replication direction for the specified replication protected item or recovery plan. Used to re-protect/reverse replicate a failed over replicated item or recovery plan. - -### [Update-AzureRmRecoveryServicesAsrRecoveryPlan](Update-AzureRmRecoveryServicesAsrRecoveryPlan.md) -Updates the contents of an Azure Site recovery plan. - -### [Update-AzureRmRecoveryServicesAsrServicesProvider](Update-AzureRmRecoveryServicesAsrServicesProvider.md) -Refreshes (Refresh server) the information received from the Azure Site Recovery Services Provider. - -### [Update-AzureRmRecoveryServicesAsrvCenter](Update-AzureRmRecoveryServicesAsrvCenter.md) -Update discovery details for a registered vCenter. - diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Edit-AzureRmRecoveryServicesAsrRecoveryPlan.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Edit-AzureRmRecoveryServicesAsrRecoveryPlan.md deleted file mode 100644 index 08dc44a6d7..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Edit-AzureRmRecoveryServicesAsrRecoveryPlan.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/edit-azurermrecoveryservicesasrrecoveryplan -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Edit-AzureRmRecoveryServicesAsrRecoveryPlan.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Edit-AzureRmRecoveryServicesAsrRecoveryPlan.md ---- - -# Edit-AzureRmRecoveryServicesAsrRecoveryPlan - -## SYNOPSIS -Edits a Site Recovery plan. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### AppendGroup (Default) -``` -Edit-AzureRmRecoveryServicesAsrRecoveryPlan -InputObject <ASRRecoveryPlan> [-AppendGroup] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RemoveGroup -``` -Edit-AzureRmRecoveryServicesAsrRecoveryPlan -InputObject <ASRRecoveryPlan> -RemoveGroup <ASRRecoveryPlanGroup> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### AddReplicationProtectedItems -``` -Edit-AzureRmRecoveryServicesAsrRecoveryPlan -InputObject <ASRRecoveryPlan> -Group <ASRRecoveryPlanGroup> - -AddProtectedItem <ASRReplicationProtectedItem[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### RemoveReplicationProtectedItems -``` -Edit-AzureRmRecoveryServicesAsrRecoveryPlan -InputObject <ASRRecoveryPlan> -Group <ASRRecoveryPlanGroup> - -RemoveProtectedItem <ASRReplicationProtectedItem[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Edit-AzureRmRecoveryServicesAsrRecoveryPlan** cmdlet edits an Azure Site Recovery plan. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $RP = Edit-AzureRmRecoveryServicesAsrRecoveryPlan -RecoveryPlan $RP -AppendGroup -``` - -Appends a group to existing Azure Site Recovery recovery plan and returns the in-memory updated recovery plan. - -## PARAMETERS - -### -AddProtectedItem -List of ASR replication protected items to be added to the recovery plan group in the recovery plan object. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem[] -Parameter Sets: AddReplicationProtectedItems -Aliases: AddProtectedItems - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AppendGroup -Switch parameter to append a recovery plan group to the recovery plan object. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: AppendGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group -Specifies a recovery plan group. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlanGroup -Parameter Sets: AddReplicationProtectedItems, RemoveReplicationProtectedItems -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The ASR recovery plan object to be edited (In memory operation. To update the recovery plan run Update-AzureRmASRRecoveryPlan with the edited recovery plan object.) - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan -Parameter Sets: (All) -Aliases: RecoveryPlan - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RemoveGroup -Removes the specified group from the recovery plan object. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlanGroup -Parameter Sets: RemoveGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveProtectedItem -List of ASR replication protected items to be removed from the recovery plan group in the recovery plan object. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem[] -Parameter Sets: RemoveReplicationProtectedItems -Aliases: RemoveProtectedItems - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesAsrRecoveryPlan](./Get-AzureRmRecoveryServicesAsrRecoveryPlan.md) - -[New-AzureRmRecoveryServicesAsrRecoveryPlan](./New-AzureRmRecoveryServicesAsrRecoveryPlan.md) diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrAlertSetting.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrAlertSetting.md deleted file mode 100644 index 47428bddf7..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrAlertSetting.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/get-azurermrecoveryservicesasralertsetting -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrAlertSetting.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrAlertSetting.md ---- - -# Get-AzureRmRecoveryServicesAsrAlertSetting - -## SYNOPSIS -Gets the configured Azure Site Recovery notification settings for the vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmRecoveryServicesAsrAlertSetting [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRecoveryServicesAsrAlertSetting** cmdlet gets the configured Azure Site Recovery notification settings for the vault. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmRecoveryServicesAsrAlertSetting - -CustomEmailAddress EmailSubscriptionOwner Locale ------------------- ---------------------- ------ -{abcxxxx@xxxx.com} On en-US -``` - -Get Alert / Notification Setting for Azure Site Recovery. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Collections.Generic.IEnumerable`1[[Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRAlertSetting, Microsoft.Azure.Commands.RecoveryServices.SiteRecovery, Version=0.1.0.0, Culture=neutral, PublicKeyToken=null]] - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrEvent.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrEvent.md deleted file mode 100644 index ed6ef1b6b9..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrEvent.md +++ /dev/null @@ -1,258 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/get-azurermrecoveryservicesasrevent -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrEvent.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrEvent.md ---- - -# Get-AzureRmRecoveryServicesAsrEvent - -## SYNOPSIS -Gets details of Azure Site Recovery events in the vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByParam (Default) -``` -Get-AzureRmRecoveryServicesAsrEvent [-AffectedObjectFriendlyName <String>] [-Fabric <ASRFabric>] - [-Severity <String>] [-StartTime <DateTime>] [-EndTime <DateTime>] [-EventType <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByResourceId -``` -Get-AzureRmRecoveryServicesAsrEvent -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByFabricId -``` -Get-AzureRmRecoveryServicesAsrEvent -FabricId <String> [-AffectedObjectFriendlyName <String>] - [-Severity <String>] [-StartTime <DateTime>] [-EndTime <DateTime>] [-EventType <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByName -``` -Get-AzureRmRecoveryServicesAsrEvent -Name <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRecoveryServicesAsrEvent** gets the list of events in the vault based on the specified selection filters. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmRecoveryServicesAsrEvent -``` - -List of all events. - -### Example 2 -``` -PS C:\> Get-AzureRmRecoveryServicesAsrEvent -EventName "VmMonitoringEvent;9091897569816476200_84576304-bafc-4714-8ba6-197a5d09d84f" - - -AffectedObjectFriendlyName : V2A-W2K12-400 -Description : Virtual machine health is in Critical state. -EventCode : SRSVMHealthChanged -EventSpecificDetails : -EventType : AgentHealth -FabricId : /Subscriptions/xxxxxxxxxxxxxxxxx/resourceGroups/xxxxxxxxxxxx/providers/Microsoft.RecoveryServices/vaults/xxxxxxxxxxxxxxxx/replicationFabrics/xxxxxxxxxxxx -HealthErrors : {} -Name : VmMonitoringEvent;9091897569816476200_84576304-bafc-4714-8ba6-197a5d09d84f -ProviderSpecificEventDetails : Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRInMageAzureV2EventDetails -Severity : Critical -TimeOfOccurence : 8/17/2017 12:31:43 PM -``` - -Get event by name. - -### Example 3 -``` -PS C:\> Get-AzureRmRecoveryServicesAsrEvent -AffectedObjectName xxxxxxxxxxxxx -``` - -List of event for affected Object. - -### Example 4 -``` -PS C:\> Get-AzureRmRecoveryServicesAsrEvent -AffectedObjectName xxxxxxxxxxxx -StartTime "8/17/2017 12:31:40 PM" -EndTime "8/17/2017 12:31:44 PM" -Severity Critical -EventType VmHealth -``` - -List of event between time start time and end time , severity critical and health type VmHealth. - -## PARAMETERS - -### -AffectedObjectFriendlyName -Specifies AffectedObject FriendlyName for the search. - -```yaml -Type: System.String -Parameter Sets: ByParam, ByFabricId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndTime -Specifies the end time of the search window. Use this parameter to get only those events that have occurred before the specified time. - -```yaml -Type: System.DateTime -Parameter Sets: ByParam, ByFabricId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventType -Filter events by the event type. - -```yaml -Type: System.String -Parameter Sets: ByParam, ByFabricId -Aliases: -Accepted values: VmHealth, ServerHealth, AgentHealth - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fabric -Filter events by the specified fabric. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric -Parameter Sets: ByParam -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FabricId -Specifies the fabricId to filter. - -```yaml -Type: System.String -Parameter Sets: ByFabricId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies name of the event for search. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Specifes the event ReourceId of event. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Severity -Event severity to filter on. - -```yaml -Type: System.String -Parameter Sets: ByParam, ByFabricId -Aliases: -Accepted values: Critical, Warning, OK, Unknown - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Specifies the start time of the search window. Use this parameter to get only those events that have occurred after the specified time. - -```yaml -Type: System.DateTime -Parameter Sets: ByParam, ByFabricId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric - -## OUTPUTS - -### System.Collections.Generic.IEnumerable`1[[Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASREvent, Microsoft.Azure.Commands.RecoveryServices.SiteRecovery, Version=0.1.0.0, Culture=neutral, PublicKeyToken=null]] - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrFabric.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrFabric.md deleted file mode 100644 index b37f0e9bc0..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrFabric.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/get-azurermrecoveryservicesasrfabric -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrFabric.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrFabric.md ---- - -# Get-AzureRmRecoveryServicesAsrFabric - -## SYNOPSIS -Get the details of an Azure Site Recovery Fabric. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Default (Default) -``` -Get-AzureRmRecoveryServicesAsrFabric [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByName -``` -Get-AzureRmRecoveryServicesAsrFabric -Name <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByFriendlyName -``` -Get-AzureRmRecoveryServicesAsrFabric -FriendlyName <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRecoveryServicesAsrFabric** cmdlet gets the properties of a specified Azure Site Recovery Fabric or all Azure Site Recovery Fabrics in a Recovery Service vault. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $fabrics = Get-AzureRmRecoveryServicesAsrFabric -``` - -Returns all the Azure Site Recovery fabrics in the vault. - -### Example 2 -``` -PS C:\> $fabric = Get-AzureRmRecoveryServicesAsrFabric -Name xxxx - -Name : xxxx -FriendlyName : XXXXXXXXXX -ID : /Subscriptions/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/resourceGroups/canaryexproute/providers/Microsoft.RecoveryServices/vaults/XXXXXXXXXXXXX/replicationFabrics/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX -FabricType : VMware -SiteIdentifier : XXXXXXXXxxxxxxxxxxx -FabricSpecificDetails : Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRVMWareSpecificDetails -``` - -Return azure site recovery fabric with name xxxx. - -### Example 3 -``` -PS C:\> $fabric = Get-AzureRmRecoveryServicesAsrFabric -FriendlyName XXXXXXXXXX - -Name : xxxx -FriendlyName : XXXXXXXXXX -ID : /Subscriptions/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/resourceGroups/canaryexproute/providers/Microsoft.RecoveryServices/vaults/XXXXXXXXXXXXX/replicationFabrics/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX -FabricType : VMware -SiteIdentifier : XXXXXXXXxxxxxxxxxxx -FabricSpecificDetails : Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRVMWareSpecificDetails -``` - -Return azure site recovery fabric with friendly name xxxx. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FriendlyName -Search for the ASR fabric by the friendly name of the fabric. - -```yaml -Type: System.String -Parameter Sets: ByFriendlyName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Search for the ASR fabric by the name of the fabric. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric, Microsoft.Azure.Commands.RecoveryServices.SiteRecovery, Version=4.0.0.0, Culture=neutral, PublicKeyToken=null]] - -## NOTES - -## RELATED LINKS - -[New-AzureRmRecoveryServicesAsrFabric](./New-AzureRmRecoveryServicesAsrFabric.md) - -[Remove-AzureRmRecoveryServicesAsrFabric](./Remove-AzureRmRecoveryServicesAsrFabric.md) diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrJob.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrJob.md deleted file mode 100644 index 5f231f24d3..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrJob.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/get-azurermrecoveryservicesasrjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrJob.md ---- - -# Get-AzureRmRecoveryServicesAsrJob - -## SYNOPSIS -Gets the details of the specified ASR job or the list of recent ASR jobs in the Recovery Services vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByParam (Default) -``` -Get-AzureRmRecoveryServicesAsrJob [-StartTime <DateTime>] [-EndTime <DateTime>] [-TargetObjectId <String>] - [-State <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByName -``` -Get-AzureRmRecoveryServicesAsrJob -Name <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByObject -``` -Get-AzureRmRecoveryServicesAsrJob -Job <ASRJob> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRecoveryServicesAsrJob** cmdlet gets Azure Site Recovery jobs. -You can use this cmdlet to view the ASR jobs in the Recovery Services vault. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $jobs = Get-AzureRmRecoveryServicesAsrJob -TargetObjectId $ASRObjectId -``` - -Returns all the jobs on a particular ASR object(reference the ASR object such as replicated item or recovery plan by its ID.) - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndTime -Specifies the end time for the jobs. -This cmdlet gets all jobs that started before the specified time. -To obtain a **DateTime** object for this parameter, use the Get-Date cmdlet. -For more information, type `Get-Help Get-Date`. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: ByParam -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Job -Specifies the ASR job object to get updated details for. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob -Parameter Sets: ByObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specify the ASR job by name. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Specifies the start time for the jobs. -This cmdlet gets all jobs that started after the specified time. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: ByParam -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -State -Specifies the state for a ASR job. -This cmdlet gets all jobs that match the specified state. -The acceptable values for this parameter are: - -- NotStarted -- InProgress -- Succeeded -- Other -- Failed -- Cancelled -- Suspended - -```yaml -Type: System.String -Parameter Sets: ByParam -Aliases: -Accepted values: NotStarted, InProgress, Succeeded, Other, Failed, Cancelled, Suspended - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetObjectId -Specifies the ID of the object. Used to search for jobs on the specified object. - -```yaml -Type: System.String -Parameter Sets: ByParam -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob - -## OUTPUTS - -### System.Collections.Generic.IEnumerable`1[[Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob, Microsoft.Azure.Commands.RecoveryServices.SiteRecovery, Version=4.0.0.0, Culture=neutral, PublicKeyToken=null]] - -## NOTES - -## RELATED LINKS - -[Restart-AzureRmRecoveryServicesAsrJob](./Restart-AzureRmRecoveryServicesAsrJob.md) - -[Resume-AzureRmRecoveryServicesAsrJob](./Resume-AzureRmRecoveryServicesAsrJob.md) - -[Stop-AzureRmRecoveryServicesAsrJob](./Stop-AzureRmRecoveryServicesAsrJob.md) diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrNetwork.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrNetwork.md deleted file mode 100644 index bb95c2871b..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrNetwork.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/get-azurermrecoveryservicesasrnetwork -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrNetwork.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrNetwork.md ---- - -# Get-AzureRmRecoveryServicesAsrNetwork - -## SYNOPSIS -Gets information about the networks managed by Site Recovery for the current vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFabricObject (Default) -``` -Get-AzureRmRecoveryServicesAsrNetwork -Fabric <ASRFabric> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByName -``` -Get-AzureRmRecoveryServicesAsrNetwork -Fabric <ASRFabric> -Name <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByFriendlyName -``` -Get-AzureRmRecoveryServicesAsrNetwork -Fabric <ASRFabric> -FriendlyName <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRecoveryServicesAsrNetwork** cmdlet gets information about Azure Site Recovery networks for the current Azure Site Recovery vault. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $Networks = Get-AzureRmRecoveryServicesAsrNetwork -Fabric $Fabric -``` - -Gets all known networks in the specified fabric. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fabric -ASR fabric object - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -FriendlyName -Friendly name of network ASR object. - -```yaml -Type: System.String -Parameter Sets: ByFriendlyName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of network ASR object. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric - -## OUTPUTS - -### System.Collections.Generic.IEnumerable`1[[Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRNetwork, Microsoft.Azure.Commands.RecoveryServices.SiteRecovery, Version=4.0.0.0, Culture=neutral, PublicKeyToken=null]] - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrNetworkMapping.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrNetworkMapping.md deleted file mode 100644 index 059187ab9c..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrNetworkMapping.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/get-azurermrecoveryservicesasrnetworkmapping -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrNetworkMapping.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrNetworkMapping.md ---- - -# Get-AzureRmRecoveryServicesAsrNetworkMapping - -## SYNOPSIS -Gets information about Site Recovery network mappings for the current vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByObject (Default) -``` -Get-AzureRmRecoveryServicesAsrNetworkMapping [-Name <String>] -Network <ASRNetwork> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByFabricObject -``` -Get-AzureRmRecoveryServicesAsrNetworkMapping [-Name <String>] -PrimaryFabric <ASRFabric> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRecoveryServicesAsrNetworkMapping** cmdlet gets information about Azure Site Recovery network mappings for the Recovery Services vault. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $Networkmappings = Get-AzureRmRecoveryServicesAsrNetworkMapping -Network $Network -``` - -Gets all networks mappings for the passed Network. - -### Example 2 -``` -PS C:\> $primaryFabric = Get-AzureRmRecoveryServicesAsrFabric -Name xxxx -PS C:\> $Networkmappings = Get-AzureRmRecoveryServicesAsrNetworkMapping -Name $networkMappingName -PrimaryFabric $primaryFabric -``` - -Gets networks mapping with provided name in specified azure site recovery fabric. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the ASR network mapping object to get. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Network -Get the ASR network mappings corresponding to the specified network ASR object. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRNetwork -Parameter Sets: ByObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PrimaryFabric -Get the ASR network mappings corresponding to the specified primary fabric object. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric -Parameter Sets: ByFabricObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric - -## OUTPUTS - -### System.Collections.Generic.IEnumerable`1[[Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRNetworkMapping, Microsoft.Azure.Commands.RecoveryServices.SiteRecovery, Version=4.0.0.0, Culture=neutral, PublicKeyToken=null]] - -## NOTES - -## RELATED LINKS - -[New-AzureRmRecoveryServicesAsrNetworkMapping](./New-AzureRmRecoveryServicesAsrNetworkMapping.md) - -[Remove-AzureRmRecoveryServicesAsrNetworkMapping](./Remove-AzureRmRecoveryServicesAsrNetworkMapping.md) diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrPolicy.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrPolicy.md deleted file mode 100644 index 8376f762c6..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrPolicy.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/get-azurermrecoveryservicesasrpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrPolicy.md ---- - -# Get-AzureRmRecoveryServicesAsrPolicy - -## SYNOPSIS -Gets ASR replication policies. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Default (Default) -``` -Get-AzureRmRecoveryServicesAsrPolicy [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByName -``` -Get-AzureRmRecoveryServicesAsrPolicy -Name <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByFriendlyName -``` -Get-AzureRmRecoveryServicesAsrPolicy -FriendlyName <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRecoveryServicesAsrPolicy** cmdlet gets the list of configured Azure Site Recovery replication policies or a specific replication policy by name. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $Policy = Get-AzureRmRecoveryServicesAsrPolicy -``` - -Retuns the list of replication policies - -### Example 2 -``` -PS C:\> Get-AzureRmRecoveryServicesAsrPolicy -Name abc - -FriendlyName : abc -Name : abc -ID : /Subscriptions/xxxxxxxxxxxx/resourceGroups/xxxxxxxxxxxx/providers/Microsoft.RecoveryServices/vaults/xxxxxxxxxxxx/replicationPolicies/abc -Type : Microsoft.RecoveryServices/vaults/replicationPolicies -ReplicationProvider : HyperVReplicaAzure -ReplicationProviderSettings : Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRHyperVReplicaAzurePolicyDetails -``` - -Retuns replication policy with name. - -### Example 3 -``` -PS C:\> Get-AzureRmRecoveryServicesAsrPolicy -FriendlyName abc - -FriendlyName : abc -Name : abc -ID : /Subscriptions/xxxxxxxxxxxx/resourceGroups/xxxxxxxxxxxx/providers/Microsoft.RecoveryServices/vaults/xxxxxxxxxxxx/replicationPolicies/abc -Type : Microsoft.RecoveryServices/vaults/replicationPolicies -ReplicationProvider : HyperVReplicaAzure -ReplicationProviderSettings : Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRHyperVReplicaAzurePolicyDetails -``` - -Returns the replication policy with the specified friendly name. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FriendlyName -Specifies the friendly name of the ASR replication policy. - -```yaml -Type: System.String -Parameter Sets: ByFriendlyName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the ASR replication policy. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Collections.Generic.IEnumerable`1[[Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRPolicy, Microsoft.Azure.Commands.RecoveryServices.SiteRecovery, Version=4.0.0.0, Culture=neutral, PublicKeyToken=null]] - -## NOTES - -## RELATED LINKS - -[New-AzureRmRecoveryServicesAsrPolicy](./New-AzureRmRecoveryServicesAsrPolicy.md) - -[Remove-AzureRmRecoveryServicesAsrPolicy](./Remove-AzureRmRecoveryServicesAsrPolicy.md) diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrProtectableItem.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrProtectableItem.md deleted file mode 100644 index d73a615d71..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrProtectableItem.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/get-azurermrecoveryservicesasrprotectableitem -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrProtectableItem.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrProtectableItem.md ---- - -# Get-AzureRmRecoveryServicesAsrProtectableItem - -## SYNOPSIS -Get the protectable items in an ASR protection container. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByObject (Default) -``` -Get-AzureRmRecoveryServicesAsrProtectableItem -ProtectionContainer <ASRProtectionContainer> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByObjectWithName -``` -Get-AzureRmRecoveryServicesAsrProtectableItem -Name <String> -ProtectionContainer <ASRProtectionContainer> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByObjectWithFriendlyName -``` -Get-AzureRmRecoveryServicesAsrProtectableItem -FriendlyName <String> - -ProtectionContainer <ASRProtectionContainer> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRecoveryServicesAsrProtectableItem** cmdlet gets the protectable items in an Azure Site Recovery Protection Container. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $ProtectableItems = Get-AzureRmRecoveryServicesAsrProtectableItem -ProtectionContainer $Container -``` - -Gets all the protectable items in specified ASR protection container. - -### Example 2 -``` -PS C:\> Get-ASRProtectableItem -ProtectionContainer $pc -FriendlyName $piFriendlyName - -Disks : {} -FabricObjectId : -FabricSpecificVMDetails : Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRVMWareSpecificVMDetails -FriendlyName : V2A-W2K12-400 -ID : /Subscriptions/xxxxxxxxxxxx/resourceGroups/canaryexproute/providers/Microsoft.RecoveryServices/vaults/IbizaV2ATest/replicationFabrics/d011a5abf48190235963ee3a88ad188ee6bca8a4c6cd0c8d7ce5d439aa77ffd9/replicationProt - ectionContainers/cloud_5dc96260-9f00-42e4-aca7-24ad27fc2078/replicationProtectableItems/22d47502-7df0-11e7-9373-0050568f2e8f -Name : 22d47502-7df0-11e7-9373-0050568f2e8f -OS : WINDOWS -OSDiskId : -OSDiskName : -ProtectionContainerId : cloud_5dc96260-9f00-42e4-aca7-24ad27fc2078 -ProtectionReadinessErrors : -ProtectionStatus : Unprotected -ReplicationProtectedItemId : -SupportedReplicationProviders : {InMage, InMageAzureV2} -``` - -Get the protectable items in specified ASR protection container and with given friendly name. - -### Example 3 -``` -PS C:\> Get-ASRProtectableItem -ProtectionContainer $pc -Name $piName - -Disks : {} -FabricObjectId : -FabricSpecificVMDetails : Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRVMWareSpecificVMDetails -FriendlyName : V2A-W2K12-400 -ID : /Subscriptions/xxxxxxxxxxxx/resourceGroups/canaryexproute/providers/Microsoft.RecoveryServices/vaults/IbizaV2ATest/replicationFabrics/d011a5abf48190235963ee3a88ad188ee6bca8a4c6cd0c8d7ce5d439aa77ffd9/replicationProt - ectionContainers/cloud_5dc96260-9f00-42e4-aca7-24ad27fc2078/replicationProtectableItems/22d47502-7df0-11e7-9373-0050568f2e8f -Name : 22d47502-7df0-11e7-9373-0050568f2e8f -OS : WINDOWS -OSDiskId : -OSDiskName : -ProtectionContainerId : cloud_5dc96260-9f00-42e4-aca7-24ad27fc2078 -ProtectionReadinessErrors : -ProtectionStatus : Unprotected -ReplicationProtectedItemId : -SupportedReplicationProviders : {InMage, InMageAzureV2} -``` - -Gets all the protectable items in specified ASR protection container. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FriendlyName -Specifies the friendly name of the ASR protectable item. - -```yaml -Type: System.String -Parameter Sets: ByObjectWithFriendlyName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the ASR protectable item. - -```yaml -Type: System.String -Parameter Sets: ByObjectWithName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtectionContainer -Specifies the Azure Site Recovery Protection Container object. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainer - -## OUTPUTS - -### System.Collections.Generic.IEnumerable`1[[Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectableItem, Microsoft.Azure.Commands.RecoveryServices.SiteRecovery, Version=4.0.0.0, Culture=neutral, PublicKeyToken=null]] - -## NOTES - -## RELATED LINKS - - diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrProtectionContainer.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrProtectionContainer.md deleted file mode 100644 index dadd6e4193..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrProtectionContainer.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/get-azurermrecoveryservicesasrprotectioncontainer -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrProtectionContainer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrProtectionContainer.md ---- - -# Get-AzureRmRecoveryServicesAsrProtectionContainer - -## SYNOPSIS -Gets ASR protection containers in the Recovery Services vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFabricObject (Default) -``` -Get-AzureRmRecoveryServicesAsrProtectionContainer -Fabric <ASRFabric> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByObjectWithName -``` -Get-AzureRmRecoveryServicesAsrProtectionContainer -Name <String> -Fabric <ASRFabric> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByObjectWithFriendlyName -``` -Get-AzureRmRecoveryServicesAsrProtectionContainer -FriendlyName <String> -Fabric <ASRFabric> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRecoveryServicesAsrProtectionContainer** cmdlet gets Azure Site Recovery protection containers in the Recovery Services vault. -A protection container is a logical container for protectable(discovered) and protected objects such as virtual machines. -Replication policies define replication settings for protected items and can be associated with a protection container and applied to a protectable item. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $ProtectionContainers = Get-AzureRmRecoveryServicesAsrProtectionContainer -Fabric $fabric -``` - -List of protection container in fabric $fabric. - -### Example 2 -``` -PS C:\> Get-AzureRmRecoveryServicesAsrProtectionContainer -Name xxxxx -Fabric $fabric -FriendlyName : xxxxxxxx -Name : xxxxx -ID : /Subscriptions/xxxxxxxxxxxxxxxxxxxxxxxxx/resourceGroups/xxxxxxxxxxxxxxx/providers/Microsoft.RecoveryServices/vaults/xxxxxxxxxx/replicationFabrics/xxxxxxxxxxxxxxxxxxxxxxxxx/replicationProtectionContainers/xxxxxxxxxxxxxxxxxxxxxxxxx -Type : Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers -FabricFriendlyName : xxxxxxxxxxxxxxxxxxxxxxxxx -FabricType : VMware -Role : Primary -AvailablePolicies : {V2aTestPolicy, v2ahydra, v2aswag-failback, v2aswag} -ProtectionContainerMappings : {pcmmapping, v2aPowerold, 636569dc-79bc-4f50-b83d-89f58717f0b2, df7aa204-b0ef-4d62-943e-324551030e5b} -``` - -Protection container in fabric $fabric with name. - -### Example 3 -``` -PS C:\> Get-AzureRmRecoveryServicesAsrProtectionContainer -FriendlyName xxxxxxxx -Fabric $fabric -FriendlyName : xxxxxxxx -Name : xxxxx -ID : /Subscriptions/xxxxxxxxxxxxxxxxxxxxxxxxx/resourceGroups/xxxxxxxxxxxxxxx/providers/Microsoft.RecoveryServices/vaults/xxxxxxxxxx/replicationFabrics/xxxxxxxxxxxxxxxxxxxxxxxxx/replicationProtectionContainers/xxxxxxxxxxxxxxxxxxxxxxxxx -Type : Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers -FabricFriendlyName : xxxxxxxxxxxxxxxxxxxxxxxxx -FabricType : VMware -Role : Primary -AvailablePolicies : {V2aTestPolicy, v2ahydra, v2aswag-failback, v2aswag} -ProtectionContainerMappings : {pcmmapping, v2aPowerold, 636569dc-79bc-4f50-b83d-89f58717f0b2, df7aa204-b0ef-4d62-943e-324551030e5b} -``` - -Protection container in fabric $fabric with friendly Name. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fabric -Look for the protection container in the specified ASR fabric. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -FriendlyName -Specifies the friendly name of the ASR protection container to look for. - -```yaml -Type: System.String -Parameter Sets: ByObjectWithFriendlyName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the ASR protection container to look for. - -```yaml -Type: System.String -Parameter Sets: ByObjectWithName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric - -## OUTPUTS - -### System.Collections.Generic.IEnumerable`1[[Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainer, Microsoft.Azure.Commands.RecoveryServices.SiteRecovery, Version=4.0.0.0, Culture=neutral, PublicKeyToken=null]] - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrProtectionContainerMapping.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrProtectionContainerMapping.md deleted file mode 100644 index 821626e301..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrProtectionContainerMapping.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/get-azurermrecoveryservicesasrprotectioncontainermapping -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrProtectionContainerMapping.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrProtectionContainerMapping.md ---- - -# Get-AzureRmRecoveryServicesAsrProtectionContainerMapping - -## SYNOPSIS -Gets Azure Site Recovery Protection Container mappings. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByObject (Default) -``` -Get-AzureRmRecoveryServicesAsrProtectionContainerMapping -ProtectionContainer <ASRProtectionContainer> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByObjectWithName -``` -Get-AzureRmRecoveryServicesAsrProtectionContainerMapping -Name <String> - -ProtectionContainer <ASRProtectionContainer> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRecoveryServicesAsrProtectionContainerMapping** cmdlet gets information about the protection container to replication policy mappings(association) in the vault for the specified ASR protection container. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $ProtectionContainerMappings = Get-AzureRmRecoveryServicesAsrProtectionContainerMapping -ProtectionContainer $Container -``` - -List of protection container mappings for container. - -### Example 2 -``` -PS C:\> $ProtectionContainerMappings = Get-AzureRmRecoveryServicesAsrProtectionContainerMapping -ProtectionContainer $Container -Name $PrimaryProtectionContainerMapping - -Name : pcmmapping -ID : /Subscriptions/xxxxxxxxxxxx/resourceGroups/canaryexproute/providers/Microsoft.RecoveryServices/vaults/IbizaV2ATest/replicationFabrics/d011a5abf48190235963ee3a88ad188ee6bca8a4c6cd0c8d7ce5d439aa77ffd9/replica - tionProtectionContainers/cloud_5dc96260-9f00-42e4-aca7-24ad27fc2078/replicationProtectionContainerMappings/pcmmapping -Health : Normal -HealthErrorDetails : {} -PolicyFriendlyName : V2aTestPolicy -PolicyId : /Subscriptions/xxxxxxxxxxxx/resourceGroups/canaryexproute/providers/Microsoft.RecoveryServices/vaults/IbizaV2ATest/replicationPolicies/V2aTestPolicy -SourceFabricFriendlyName : V2A-W2K12-400 -SourceProtectionContainerFriendlyName : V2A-W2K12-400 -State : Paired -TargetFabricFriendlyName : Microsoft Azure -TargetProtectionContainerFriendlyName : Microsoft Azure -TargetProtectionContainerId : Microsoft Azure -``` - -Gets all protection container mappings for the specified protection container. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the protection container mapping to get. - -```yaml -Type: System.String -Parameter Sets: ByObjectWithName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtectionContainer -Get protection container mappings corresponding to the specified ASR protection container object. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainer - -## OUTPUTS - -### System.Collections.Generic.IEnumerable`1[[Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainerMapping, Microsoft.Azure.Commands.RecoveryServices.SiteRecovery, Version=4.0.0.0, Culture=neutral, PublicKeyToken=null]] - -## NOTES - -## RELATED LINKS - -[New-AzureRmRecoveryServicesAsrProtectionContainerMapping](./New-AzureRmRecoveryServicesAsrProtectionContainerMapping.md) - -[Remove-AzureRmRecoveryServicesAsrProtectionContainerMapping](./Remove-AzureRmRecoveryServicesAsrProtectionContainerMapping.md) diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrRecoveryPlan.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrRecoveryPlan.md deleted file mode 100644 index ba561f8e00..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrRecoveryPlan.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/get-azurermrecoveryservicesasrrecoveryplan -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrRecoveryPlan.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrRecoveryPlan.md ---- - -# Get-AzureRmRecoveryServicesAsrRecoveryPlan - -## SYNOPSIS -Gets a recovery plan or all the recovery plans in the Recovery Services vault - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Default (Default) -``` -Get-AzureRmRecoveryServicesAsrRecoveryPlan [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByName -``` -Get-AzureRmRecoveryServicesAsrRecoveryPlan -Name <String> [[-Path] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByFriendlyName -``` -Get-AzureRmRecoveryServicesAsrRecoveryPlan -FriendlyName <String> [[-Path] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRecoveryServicesAsrRecoveryPlan** cmdlet gets the details of the specified recovery plan or all recovery plans in the Recovery Services vault. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $RP = Get-AzureRmRecoveryServicesAsrRecoveryPlan -Name $RPName -``` - -Gets the recovery plan with the specified name. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FriendlyName -Specifies the friendly name of the recovery plan to get. - -```yaml -Type: System.String -Parameter Sets: ByFriendlyName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the recovery plan to get. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the file path to which this cmdlet saves the recovery plan json definition. The json definition can be edited to modify the recovery plan and used to update the recovery plan through the Update-AzureRmRecoveryServicesASRRecoveryPlan cmdlet - -```yaml -Type: System.String -Parameter Sets: ByName, ByFriendlyName -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Collections.Generic.IEnumerable`1[[Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan, Microsoft.Azure.Commands.RecoveryServices.SiteRecovery, Version=4.0.0.0, Culture=neutral, PublicKeyToken=null]] - -## NOTES - -## RELATED LINKS - -[New-AzureRmRecoveryServicesAsrRecoveryPlan](./New-AzureRmRecoveryServicesAsrRecoveryPlan.md) - -[Remove-AzureRmRecoveryServicesAsrRecoveryPlan](./Remove-AzureRmRecoveryServicesAsrRecoveryPlan.md) - -[Update-AzureRmRecoveryServicesAsrRecoveryPlan](./Update-AzureRmRecoveryServicesAsrRecoveryPlan.md) diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrRecoveryPoint.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrRecoveryPoint.md deleted file mode 100644 index d3c2fdf7a2..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrRecoveryPoint.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/get-azurermrecoveryservicesasrrecoverypoint -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrRecoveryPoint.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrRecoveryPoint.md ---- - -# Get-AzureRmRecoveryServicesAsrRecoveryPoint - -## SYNOPSIS -Gets the available recovery points for a replication protected item. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByObject (Default) -``` -Get-AzureRmRecoveryServicesAsrRecoveryPoint -ReplicationProtectedItem <ASRReplicationProtectedItem> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByObjectWithName -``` -Get-AzureRmRecoveryServicesAsrRecoveryPoint -Name <String> - -ReplicationProtectedItem <ASRReplicationProtectedItem> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRecoveryServicesAsrRecoveryPoint** cmdlet gets the list of available recovery points for a replication protected item. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $RecoveryPoints = Get-AzureRmRecoveryServicesAsrRecoveryPoint -ReplicationProtectedItem $ReplicationProtectedItem -``` - -Gets recovery points for the specified ASR replication protected item. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the recovery point to get. - -```yaml -Type: System.String -Parameter Sets: ByObjectWithName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationProtectedItem -Specifies the Azure Site Recovery Replication Protected Item object for which to get the list of available recovery points. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem - -## OUTPUTS - -### System.Collections.Generic.IEnumerable`1[[Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPoint, Microsoft.Azure.Commands.RecoveryServices.SiteRecovery, Version=4.0.0.0, Culture=neutral, PublicKeyToken=null]] - -## NOTES - -## RELATED LINKS - -[Edit-AzureRmRecoveryServicesAsrRecoveryPlan](./Edit-AzureRmRecoveryServicesAsrRecoveryPlan.md) - -[Get-AzureRmRecoveryServicesAsrRecoveryPlan](./Get-AzureRmRecoveryServicesAsrRecoveryPlan.md) - -[New-AzureRmRecoveryServicesAsrRecoveryPlan](./New-AzureRmRecoveryServicesAsrRecoveryPlan.md) - -[Remove-AzureRmRecoveryServicesAsrRecoveryPlan](./Remove-AzureRmRecoveryServicesAsrRecoveryPlan.md) - -[Update-AzureRmRecoveryServicesAsrRecoveryPlan](./Update-AzureRmRecoveryServicesAsrRecoveryPlan.md) diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrReplicationProtectedItem.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrReplicationProtectedItem.md deleted file mode 100644 index a003af5efb..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrReplicationProtectedItem.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/get-azurermrecoveryservicesasrreplicationprotecteditem -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrReplicationProtectedItem.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrReplicationProtectedItem.md ---- - -# Get-AzureRmRecoveryServicesAsrReplicationProtectedItem - -## SYNOPSIS -Gets the properties of an Azure Site Recovery Replication Protected Items. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByObject (Default) -``` -Get-AzureRmRecoveryServicesAsrReplicationProtectedItem -ProtectionContainer <ASRProtectionContainer> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByObjectWithName -``` -Get-AzureRmRecoveryServicesAsrReplicationProtectedItem -Name <String> - -ProtectionContainer <ASRProtectionContainer> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByObjectWithFriendlyName -``` -Get-AzureRmRecoveryServicesAsrReplicationProtectedItem -FriendlyName <String> - -ProtectionContainer <ASRProtectionContainer> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByProtectableItemObject -``` -Get-AzureRmRecoveryServicesAsrReplicationProtectedItem -ProtectableItem <ASRProtectableItem> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRecoveryServicesAsrReplicationProtectedItem** cmdlet gets the properties of all or the specified ASR replication protected item from the specified ASR protection container. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $ReplicationProtectedItems = Get-AzureRmRecoveryServicesAsrReplicationProtectedItem -ProtectionContainer $PrimaryContainer -``` - -Lists all replication protected items in the specified ASR protection container. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FriendlyName -Specifies the friendly name of the replication protected item to get. - -```yaml -Type: System.String -Parameter Sets: ByObjectWithFriendlyName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the replication protected item to get. - -```yaml -Type: System.String -Parameter Sets: ByObjectWithName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtectableItem -Specifies an ASR protectable item object. The cmdlet gets the ASR replication protected item corresponding to the specified ASR protectable item if the item is protected. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectableItem -Parameter Sets: ByProtectableItemObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ProtectionContainer -Specifies the ASR protection container object of the ASR protection container corresponding to the replication protected item. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainer -Parameter Sets: ByObject, ByObjectWithName, ByObjectWithFriendlyName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainer -Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectableItem - -## OUTPUTS - -### System.Collections.Generic.IEnumerable`1[[Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem, Microsoft.Azure.Commands.RecoveryServices.SiteRecovery, Version=4.0.0.0, Culture=neutral, PublicKeyToken=null]] - -## NOTES - -## RELATED LINKS - -[New-AzureRmRecoveryServicesAsrReplicationProtectedItem](./New-AzureRmRecoveryServicesAsrReplicationProtectedItem.md) - -[Remove-AzureRmRecoveryServicesAsrReplicationProtectedItem](./Remove-AzureRmRecoveryServicesAsrReplicationProtectedItem.md) - -[Set-AzureRmRecoveryServicesAsrReplicationProtectedItem](./Set-AzureRmRecoveryServicesAsrReplicationProtectedItem.md) diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrServicesProvider.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrServicesProvider.md deleted file mode 100644 index 84e7d07cc8..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrServicesProvider.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/get-azurermrecoveryservicesasrservicesprovider -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrServicesProvider.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrServicesProvider.md ---- - -# Get-AzureRmRecoveryServicesAsrServicesProvider - -## SYNOPSIS -Gets the details of the ASR recovery services providers registered to the Recovery Services vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Default (Default) -``` -Get-AzureRmRecoveryServicesAsrServicesProvider -Fabric <ASRFabric> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByName -``` -Get-AzureRmRecoveryServicesAsrServicesProvider -Name <String> -Fabric <ASRFabric> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByFriendlyName -``` -Get-AzureRmRecoveryServicesAsrServicesProvider -FriendlyName <String> -Fabric <ASRFabric> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRecoveryServicesAsrServicesProvider** cmdlet gets information on the Azure Site Recovery providers in the vault. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $RSPs = Get-AzureRmRecoveryServicesAsrFabric | Get-AzureRmRecoveryServicesAsrServicesProvider -``` - -List all ASR replication services providers registered to the Recovery Services vault corresponding to the specified fabric. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fabric -Specifies the ASR fabric object. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -FriendlyName -Specifies the friendly name of the ASR recovery services provider to get details for. - -```yaml -Type: System.String -Parameter Sets: ByFriendlyName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the ASR recovery services provider to get details for. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric - -## OUTPUTS - -### System.Collections.Generic.IEnumerable`1[[Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryServicesProvider, Microsoft.Azure.Commands.RecoveryServices.SiteRecovery, Version=4.0.0.0, Culture=neutral, PublicKeyToken=null]] - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmRecoveryServicesAsrServicesProvider](./Remove-AzureRmRecoveryServicesAsrServicesProvider.md) - -[Update-AzureRmRecoveryServicesAsrServicesProvider](./Update-AzureRmRecoveryServicesAsrServicesProvider.md) diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrStorageClassification.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrStorageClassification.md deleted file mode 100644 index c531872b14..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrStorageClassification.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/get-azurermrecoveryservicesasrstorageclassification -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrStorageClassification.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrStorageClassification.md ---- - -# Get-AzureRmRecoveryServicesAsrStorageClassification - -## SYNOPSIS -Gets the available(discovered) ASR storage classifications in the Recovery Services vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFabricObject (Default) -``` -Get-AzureRmRecoveryServicesAsrStorageClassification -Fabric <ASRFabric> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByObjectWithName -``` -Get-AzureRmRecoveryServicesAsrStorageClassification -Name <String> -Fabric <ASRFabric> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByObjectWithFriendlyName -``` -Get-AzureRmRecoveryServicesAsrStorageClassification -FriendlyName <String> -Fabric <ASRFabric> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRecoveryServicesAsrStorageClassification** cmdlet gets details of the discovered ASR storage classifications in the Recovery Services vault. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $StorageClassifications = Get-AzureRmRecoveryServicesAsrStorageClassification -Fabric $Fabric -``` - -List the discovered storage classifications corresponding to the specified ASR fabric. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fabric -Specifies an ASR fabric object. The cmdlet gets the details of discovered storage classifications corresponding to the specified ASR fabric. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -FriendlyName -Specifies the friendly name of the storage classification object to get. - -```yaml -Type: System.String -Parameter Sets: ByObjectWithFriendlyName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the storage classification object to get. - -```yaml -Type: System.String -Parameter Sets: ByObjectWithName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric - -## OUTPUTS - -### System.Collections.Generic.IEnumerable`1[[Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRStorageClassification, Microsoft.Azure.Commands.RecoveryServices.SiteRecovery, Version=4.0.0.0, Culture=neutral, PublicKeyToken=null]] - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrStorageClassificationMapping.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrStorageClassificationMapping.md deleted file mode 100644 index 9de44ddcbd..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrStorageClassificationMapping.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/get-azurermrecoveryservicesasrstorageclassificationmapping -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrStorageClassificationMapping.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrStorageClassificationMapping.md ---- - -# Get-AzureRmRecoveryServicesAsrStorageClassificationMapping - -## SYNOPSIS -Gets ASR storage classification mappings. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByObject (Default) -``` -Get-AzureRmRecoveryServicesAsrStorageClassificationMapping -StorageClassification <ASRStorageClassification> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByObjectWithName -``` -Get-AzureRmRecoveryServicesAsrStorageClassificationMapping -Name <String> - -StorageClassification <ASRStorageClassification> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRecoveryServicesAsrStorageClassificationMapping** cmdlet gets the details of an ASR storage classification mapping. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $StorageClassificationMappings = Get-AzureRmRecoveryServicesAsrStorageClassificationMapping -StorageClassification $StorageClassification -``` - -List all storage classification mappings corresponding to the specified storage classification. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the storage classification mapping to get. - -```yaml -Type: System.String -Parameter Sets: ByObjectWithName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageClassification -Specifies an ASR storage classification object. The cmdlet gets ASR storage classification mappings corresponding to the specified storage classification - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRStorageClassification -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Collections.Generic.IEnumerable`1[[Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRStorageClassificationMapping, Microsoft.Azure.Commands.RecoveryServices.SiteRecovery, Version=4.0.0.0, Culture=neutral, PublicKeyToken=null]] - -## NOTES - -## RELATED LINKS - -[New-AzureRmRecoveryServicesAsrStorageClassificationMapping](./New-AzureRmRecoveryServicesAsrStorageClassificationMapping.md) - -[Remove-AzureRmRecoveryServicesAsrStorageClassificationMapping](./Remove-AzureRmRecoveryServicesAsrStorageClassificationMapping.md) diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrVCenter.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrVCenter.md deleted file mode 100644 index 7d735c48b9..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrVCenter.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/get-azurermrecoveryservicesasrvcenter -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrVCenter.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrVCenter.md ---- - -# Get-AzureRmRecoveryServicesAsrvCenter - -## SYNOPSIS -Gets details of the vCenter servers registered for discovery on the Configuration server specified by the ASR fabric. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByFabricObject (Default) -``` -Get-AzureRmRecoveryServicesAsrvCenter -Fabric <ASRFabric> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByResourceId -``` -Get-AzureRmRecoveryServicesAsrvCenter -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByName -``` -Get-AzureRmRecoveryServicesAsrvCenter -Fabric <ASRFabric> -Name <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRecoveryServicesAsrvCenter** cmdlet gets details of the vCenter servers registered for discovery on the Configuration server specified by the ASR fabric. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmRecoveryServicesAsrvCenter -Fabric $Fabric -Name $Name - -FriendlyName : inmtest81 -Server : 10.150.209.27 -Port : 443 -Name : inmtest81 -ID : /Subscriptions/xxxxxxxxxxx/resourceGroups/canaryexproute/providers/Microsoft.RecoveryServices/vaults/xxxxxxxxx/replicationFabrics/xxxxxxxxxxxxxxxxx/replicationvCenters/inmtest81 -FabricArmResourceName : d011a5abf48190235963ee3a88ad188ee6bca8a4c6cd0c8d7ce5d439aa77ffd9 -ProcessServerId : 526C9B6C-4039-D841-97A92FB0BD153B53 -AccountId : 2 -DiscoveryStatus : Pending -LastHeartbeat : -``` - -Get azure site recovery vCenter by fabric name and name of vCenter. - -### Example 2 -``` -PS C:\> Get-AzureRmRecoveryServicesAsrvCenter -Fabric $Fabric -``` - -Get azure site recovery vCenter list by fabric name. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fabric -ASR fabric object representing the Configuration Server. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric -Parameter Sets: ByFabricObject, ByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the vCenter server. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Specifies the resourceId of vCenter. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric - -## OUTPUTS - -### System.Collections.Generic.IEnumerable`1[[Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRvCenter, Microsoft.Azure.Commands.RecoveryServices.SiteRecovery, Version=0.1.1.0, Culture=neutral, PublicKeyToken=null]] - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrVaultContext.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrVaultContext.md deleted file mode 100644 index 95b4271a85..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Get-AzureRmRecoveryServicesAsrVaultContext.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/get-azurermrecoveryservicesasrvaultcontext -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrVaultContext.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrVaultContext.md ---- - -# Get-AzureRmRecoveryServicesAsrVaultContext - -## SYNOPSIS -Gets ASR vault settings information for the Recovery Services vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmRecoveryServicesAsrVaultContext [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRecoveryServicesAsrVaultContext** cmdlet gets ASR vault settings information related to the Recovery Services vault. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $VaultSettings = Get-AzureRmRecoveryServicesAsrVaultContext -``` - -Gets the ASR vault settings for the currently active(in the PowerShell session) Recovery Services vault. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRVaultSettings - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Import-AzureRmRecoveryServicesAsrVaultSettingsFile.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Import-AzureRmRecoveryServicesAsrVaultSettingsFile.md deleted file mode 100644 index b09e85fb2b..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Import-AzureRmRecoveryServicesAsrVaultSettingsFile.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/import-azurermrecoveryservicesasrvaultsettingsfile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Import-AzureRmRecoveryServicesAsrVaultSettingsFile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Import-AzureRmRecoveryServicesAsrVaultSettingsFile.md ---- - -# Import-AzureRmRecoveryServicesAsrVaultSettingsFile - -## SYNOPSIS -Imports the specified ASR vault settings file to set the vault context(PowerShell session context) for subsequent ASR operations in the PowerShell session. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Import-AzureRmRecoveryServicesAsrVaultSettingsFile [-Path] <String> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Import-AzureRmRecoveryServicesAsrVaultSettingsFile** cmdlet imports the Azure Site Recovery vault settings file. The vault settings file is used to set the vault context for subsequent Azure Site Recovery operations in the current session. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $VaultSettings = Import-AzureRmRecoveryServicesAsrVaultSettingsFile -Path $FilePath -``` - -Imports the specified Recovery Services vault settings file and returns settings of the imported vault. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the folder path of the ASR vault settings file. -This file can be downloaded from the Recovery Services vault portal and stored locally. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRVaultSettings - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrAzureToAzureDiskReplicationConfig.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrAzureToAzureDiskReplicationConfig.md deleted file mode 100644 index 052078f49e..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrAzureToAzureDiskReplicationConfig.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/new-azurermrecoveryservicesasrazuretoazurediskreplicationconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/New-AzureRmRecoveryServicesAsrAzureToAzureDiskReplicationConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/New-AzureRmRecoveryServicesAsrAzureToAzureDiskReplicationConfig.md ---- - -# New-AzureRmRecoveryServicesAsrAzureToAzureDiskReplicationConfig - -## SYNOPSIS -Creates a disk mapping object for Azure virtual machine disks to be replicated. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### AzureToAzure (Default) -``` -New-AzureRmRecoveryServicesAsrAzureToAzureDiskReplicationConfig -VhdUri <String> -LogStorageAccountId <String> - -RecoveryAzureStorageAccountId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### AzureToAzureManagedDisk -``` -New-AzureRmRecoveryServicesAsrAzureToAzureDiskReplicationConfig [-ManagedDisk] -LogStorageAccountId <String> - -DiskId <String> -RecoveryResourceGroupId <String> -RecoveryReplicaDiskAccountType <String> - -RecoveryTargetDiskAccountType <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Creates a disk mapping object that maps an Azure virtual machine disk to the cache storage account and target storage account (recovery region) to be used to replicate the disk. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmRecoveryServicesAsrAzureToAzureDiskReplicationConfig -VhdUri $vhdUri -RecoveryAzureStorageAccountId $recoveryStorageAccountId -LogStorageAccountId $logStorageAccountId -``` - -Create a disk mapping object for Azure virtual machine disks to be replicated.Used during Azure to Azure EnableDr and reprotect operation. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskId -Specifies the disk id of managed disk. - -```yaml -Type: System.String -Parameter Sets: AzureToAzureManagedDisk -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogStorageAccountId -Specifies the log or cache storage account Id to be used to store replication logs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedDisk -Specifies the input is for managed disk. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: AzureToAzureManagedDisk -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryAzureStorageAccountId -Specifies the ID of the Azure storage account to replicate to. - -```yaml -Type: System.String -Parameter Sets: AzureToAzure -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryReplicaDiskAccountType -Specifies the account type of replicated managed disk. - -```yaml -Type: System.String -Parameter Sets: AzureToAzureManagedDisk -Aliases: -Accepted values: Premium_LRS, Standard_LRS - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryResourceGroupId -Specifies the recovery resource group id for replicated managed disk. - -```yaml -Type: System.String -Parameter Sets: AzureToAzureManagedDisk -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryTargetDiskAccountType -Specifies the recovery target disk for replicated managed disk. - -```yaml -Type: System.String -Parameter Sets: AzureToAzureManagedDisk -Aliases: -Accepted values: Premium_LRS, Standard_LRS - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VhdUri -Specify the VHD URI of the disk that this mapping corresponds to. - -```yaml -Type: System.String -Parameter Sets: AzureToAzure -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRAzureRmRecoveryServicesAsrAzureToAzureDiskReplicationConfig - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrFabric.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrFabric.md deleted file mode 100644 index 1ac710bfb5..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrFabric.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/new-azurermrecoveryservicesasrfabric -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/New-AzureRmRecoveryServicesAsrFabric.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/New-AzureRmRecoveryServicesAsrFabric.md ---- - -# New-AzureRmRecoveryServicesAsrFabric - -## SYNOPSIS -Creates an Azure Site Recovery Fabric. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Default (Default) -``` -New-AzureRmRecoveryServicesAsrFabric -Name <String> [-Type <String>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Azure -``` -New-AzureRmRecoveryServicesAsrFabric [-Azure] -Name <String> -Location <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmRecoveryServicesAsrFabric** cmdlet creates an Azure Site Recovery Fabric of the specified type. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $currentJob = New-AzureRmRecoveryServicesAsrFabric -Name $FabricName -``` - -Starts the fabric creation with passed name and returns the ASR job used to track the fabric creation operation. - -### Example 2 -``` -PS C:\> $currentJob = New-AzureRmRecoveryServicesAsrFabric -Azure -Name $fabricName -Location "eastus" -PS C:\> Get-ASRJob -name $currentJob.id -``` - -Starts the azure fabric creation with passed name and returns the ASR job used to track the fabric creation operation. - -## PARAMETERS - -### -Azure -Switch parameter indicates creation of azure fabric. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Azure -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the Azure region corresponding to the Fabric object being created. The Azure Site Recovery fabric object represents a region. For virtual machines being replicated between two Azure regions a primary fabric represents the primary Azure region and the recovery fabric . - -```yaml -Type: System.String -Parameter Sets: Azure -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Azure Site Recovery Fabric. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the Azure Site Recovery Fabric Type. - -```yaml -Type: System.String -Parameter Sets: Default -Aliases: -Accepted values: HyperVSite - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesAsrFabric](./Get-AzureRmRecoveryServicesAsrFabric.md) - -[Remove-AzureRmRecoveryServicesAsrFabric](./Remove-AzureRmRecoveryServicesAsrFabric.md) diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrNetworkMapping.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrNetworkMapping.md deleted file mode 100644 index 644bfc6113..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrNetworkMapping.md +++ /dev/null @@ -1,245 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/new-azurermrecoveryservicesasrnetworkmapping -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/New-AzureRmRecoveryServicesAsrNetworkMapping.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/New-AzureRmRecoveryServicesAsrNetworkMapping.md ---- - -# New-AzureRmRecoveryServicesAsrNetworkMapping - -## SYNOPSIS -Creates an ASR network mapping between two networks. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### EnterpriseToEnterprise (Default) -``` -New-AzureRmRecoveryServicesAsrNetworkMapping -Name <String> -PrimaryNetwork <ASRNetwork> - -RecoveryNetwork <ASRNetwork> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### AzureToAzure -``` -New-AzureRmRecoveryServicesAsrNetworkMapping [-AzureToAzure] -Name <String> -PrimaryFabric <ASRFabric> - -PrimaryAzureNetworkId <String> -RecoveryFabric <ASRFabric> -RecoveryAzureNetworkId <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### EnterpriseToAzure -``` -New-AzureRmRecoveryServicesAsrNetworkMapping -Name <String> -PrimaryNetwork <ASRNetwork> - -RecoveryAzureNetworkId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmRecoveryServicesAsrNetworkMapping** cmdlet starts the operation of creating an ASR network mapping between two networks and returns the ASR job object for the ASR job used to track the operation. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $currentJob = New-AzureRmRecoveryServicesAsrNetworkMapping -Name $NetworkMapName -PrimaryNetwork $PrimaryNetwork -RecoveryNetwork $RecoveryNetwork -``` - -Starts the network mapping creation operation using the specified name, primary and recovery networks, and returns an ASR job to track the operation. - -### Example 2 -``` -PS C:\> $currentJob = New-AzureRmRecoveryServicesAsrNetworkMapping -AzureToAzure -Name "mappingName" -PrimaryFabric $AzureFabric ` - -PrimaryAzureNetworkId $AzureNetworkId -RecoveryFabric $RecoveryAzureFabric -RecoveryAzureNetworkId $RecoveryNetworkId -``` - -Starts the network mapping for creation operation using the specified name, primary and recovery networks, and returns an ASR job to track the operation(Azure to Azure scenario). - -## PARAMETERS - -### -AzureToAzure -Switch parameter specifying that the network mapping being created will be used to replicated Azure virtual machines between two Azure regions. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: AzureToAzure -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the ASR network mapping to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimaryAzureNetworkId -Specifies the Azure virtual network ID of the primary network for the mapping. - -```yaml -Type: System.String -Parameter Sets: AzureToAzure -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimaryFabric -Specifes the ASR fabric where mapping should be created. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric -Parameter Sets: AzureToAzure -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimaryNetwork -Specifies the primary network object for the ASR network mapping. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRNetwork -Parameter Sets: EnterpriseToEnterprise, EnterpriseToAzure -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RecoveryAzureNetworkId -Specifies the recovery azure network ID for the network mapping. - -```yaml -Type: System.String -Parameter Sets: AzureToAzure, EnterpriseToAzure -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryFabric -The Azure Site Recovery fabric object corresponding to the recovery Azure region. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric -Parameter Sets: AzureToAzure -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryNetwork -Specifies the recovery network object for the ASR network mapping. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRNetwork -Parameter Sets: EnterpriseToEnterprise -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRNetwork - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesAsrNetworkMapping](./Get-AzureRmRecoveryServicesAsrNetworkMapping.md) - -[Remove-AzureRmRecoveryServicesAsrNetworkMapping](./Remove-AzureRmRecoveryServicesAsrNetworkMapping.md) diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrPolicy.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrPolicy.md deleted file mode 100644 index 14fe82d0f7..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrPolicy.md +++ /dev/null @@ -1,529 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/new-azurermrecoveryservicesasrpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/New-AzureRmRecoveryServicesAsrPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/New-AzureRmRecoveryServicesAsrPolicy.md ---- - -# New-AzureRmRecoveryServicesAsrPolicy - -## SYNOPSIS -Creates an Azure Site Recovery replication policy. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### HyperVToAzure (Default) -``` -New-AzureRmRecoveryServicesAsrPolicy [-HyperVToAzure] -Name <String> -ReplicationProvider <String> - -ReplicationFrequencyInSeconds <String> [-NumberOfRecoveryPointsToRetain <Int32>] - [-ApplicationConsistentSnapshotFrequencyInHours <Int32>] [-ReplicationStartTime <TimeSpan>] - [-RecoveryAzureStorageAccountId <String>] [-Encryption <String>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### VMwareToAzure -``` -New-AzureRmRecoveryServicesAsrPolicy [-VMwareToAzure] -Name <String> -RecoveryPointRetentionInHours <Int32> - [-ApplicationConsistentSnapshotFrequencyInHours <Int32>] [-MultiVmSyncStatus <String>] - -RPOWarningThresholdInMinutes <Int32> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### AzureToVMware -``` -New-AzureRmRecoveryServicesAsrPolicy [-AzureToVMware] -Name <String> -RecoveryPointRetentionInHours <Int32> - [-ApplicationConsistentSnapshotFrequencyInHours <Int32>] [-MultiVmSyncStatus <String>] - -RPOWarningThresholdInMinutes <Int32> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### AzureToAzure -``` -New-AzureRmRecoveryServicesAsrPolicy [-AzureToAzure] -Name <String> -RecoveryPointRetentionInHours <Int32> - [-ApplicationConsistentSnapshotFrequencyInHours <Int32>] [-MultiVmSyncStatus <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### EnterpriseToEnterprise -``` -New-AzureRmRecoveryServicesAsrPolicy [-VmmToVmm] -Name <String> -ReplicationProvider <String> - [-ReplicationMethod <String>] -ReplicationFrequencyInSeconds <String> - [-NumberOfRecoveryPointsToRetain <Int32>] [-ApplicationConsistentSnapshotFrequencyInHours <Int32>] - [-Compression <String>] -ReplicationPort <UInt16> [-Authentication <String>] - [-ReplicationStartTime <TimeSpan>] [-ReplicaDeletion <String>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmRecoveryServicesAsrPolicy** cmdlet creates an Azure Site Recovery replication policy. -The replication policy is used to specify replication settings such as the replication frequency and number of recovery points. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmRecoveryServicesAsrPolicy -Name "abc" -ReplicationProvider HyperVReplicaAzure -ReplicationFrequencyInSeconds 30 -NumberOfRecoveryPointsToRetain 10 -``` - -Starts the replication policy creation operation using the specified parameters and returns the ASR job used to track the operation. - -### Example 2 -``` -PS C:\> New-AzureRmRecoveryServicesAsrPolicy -Name "abc122" -ReplicationProvider HyperVReplica2012R2 -ReplicationFrequencyInSeconds 300 -ReplicationPort 211 - -Name : 1c609a5b-324e-461c-866f-ad58f944df25 -ID : /Subscriptions/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/resourceGroups/xxxxxxxxxxxx/providers/Microsoft.RecoveryServices/vaults/xxxxxxxxxxxx/replicationJobs/1c609a5b-324e-461c-866f-ad58f944df25 -Type : -JobType : AddProtectionProfile -DisplayName : Create replication policy -ClientRequestId : b10c83ee-fee2-42d4-ad1d-dfc3e166faab ActivityId: 67e8453c-fae0-465f-801c-dfa2e6e6ee23 -State : Succeeded -StateDescription : Completed -StartTime : 8/29/2017 10:18:10 AM -EndTime : 8/29/2017 10:18:11 AM -TargetObjectId : 00001111-aaaa-2222-bbbb-3333cccc4444 -TargetObjectType : ProtectionProfile -TargetObjectName : abc122 -AllowedActions : -Tasks : {Prerequisites check for creating the replication policy, Creating the replication policy} -Errors : {} -``` - -Starts the replication policy creation operation using the specified parameters and returns the ASR job used to track the operation. - -### Example 3 -``` -PS C:\> New-AzureRmRecoveryServicesAsrPolicy -Name $policyName1 -ReplicationProvider InMageAzureV2 -RecoveryPoints 40 -RPOWarningThresholdInMinutes 5 -ApplicationConsistentSnapshotFrequencyInMinutes 15 -Name : ed69e451-878b-4f19-9c0f-73184be05eaf -ID : /Subscriptions/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/resourceGroups/xxxxxxxxxxxx/providers/Microsoft.RecoveryServices/vaults/xxxxxxxxxxxx/replicationJobs/ed69e451-878b-4f19-9c0f-73184be05eaf -Type : -JobType : -DisplayName : -ClientRequestId : d8922fa2-303c-4eb4-b556-e07969ea6fba ActivityId: 9e946cdf-2351-44c2-9aef-70ef2eab29b4 -State : NotStarted -StateDescription : NotStarted -StartTime : -EndTime : -TargetObjectId : -TargetObjectType : -TargetObjectName : -AllowedActions : -Tasks : {} -Errors : {} -``` - -### Example 4 -``` -PS C:\> $Job = New-AzureRmRecoveryServicesAsrPolicy -Name $TestPolicy1 -AzureToAzure -RecoveryPointRetentionInHours 10 -ApplicationConsistentSnapshotFrequencyInHours 5 -PS C:\> Get-AsrJob -name $Job.id -``` - -Starts the replication policy creation operation using the specified parameters and returns the ASR job used to track the operation. - -## PARAMETERS - -### -ApplicationConsistentSnapshotFrequencyInHours -Specifies the frequency(in hours) at which to create application consistent recovery points. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Authentication -Specifies the type of authentication used. -Valid values are: - -- Certificate -- Kerberos - -```yaml -Type: System.String -Parameter Sets: EnterpriseToEnterprise -Aliases: -Accepted values: Certificate, Kerberos - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AzureToAzure -Switch parameter specifying that the replication policy being created will be used to replicated Azure virtual machines between two Azure regions. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: AzureToAzure -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AzureToVMware -Switch parameter specifying that the replication policy being created will be used to reverse replicate failed over VMware virtual machines and Physical servers running in Azure back to an on-premises VMware site. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: AzureToVMware -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Compression -Specifies if compression should be enabled. - -```yaml -Type: System.String -Parameter Sets: EnterpriseToEnterprise -Aliases: -Accepted values: Enable, Disable - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Encryption -{{Fill Encryption Description}} - -```yaml -Type: System.String -Parameter Sets: HyperVToAzure -Aliases: -Accepted values: Enable, Disable - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HyperVToAzure -Switch parameter to specify policy is to be used to replicate Hyper-V virtual machines to Azure - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: HyperVToAzure -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MultiVmSyncStatus -Specifies multiVm sync status for the policy. - -```yaml -Type: System.String -Parameter Sets: VMwareToAzure, AzureToVMware, AzureToAzure -Aliases: -Accepted values: Enable, Disable - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the ASR replication policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumberOfRecoveryPointsToRetain -Specifies the number recovery points to retain. - -```yaml -Type: System.Int32 -Parameter Sets: HyperVToAzure, EnterpriseToEnterprise -Aliases: RecoveryPoints - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryAzureStorageAccountId -Specifies the ID of the Azure storage account to replicate to. - -```yaml -Type: System.String -Parameter Sets: HyperVToAzure -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryPointRetentionInHours -Retain the recovery points for given time in hours. - -```yaml -Type: System.Int32 -Parameter Sets: VMwareToAzure, AzureToVMware, AzureToAzure -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicaDeletion -Specifies if the replica virtual machine should be deleted on disabling replication from a VMM managed site to another. - -```yaml -Type: System.String -Parameter Sets: EnterpriseToEnterprise -Aliases: -Accepted values: Required, NotRequired - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationFrequencyInSeconds -Specifies the replication frequency interval in seconds. -Valid values are: - -- 30 -- 300 -- 900 - -```yaml -Type: System.String -Parameter Sets: HyperVToAzure, EnterpriseToEnterprise -Aliases: -Accepted values: 30, 300, 900 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationMethod -Specifies the replication method. -Valid values are: - -- Online -- Offline - -```yaml -Type: System.String -Parameter Sets: EnterpriseToEnterprise -Aliases: -Accepted values: Online, Offline - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationPort -Specifies the port used for replication. - -```yaml -Type: System.UInt16 -Parameter Sets: EnterpriseToEnterprise -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationProvider -Specifies the replication provider for the policy. - -```yaml -Type: System.String -Parameter Sets: HyperVToAzure, EnterpriseToEnterprise -Aliases: -Accepted values: HyperVReplica2012R2, HyperVReplica2012, HyperVReplicaAzure - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationStartTime -Specifies the replication start time. -It must be no later than 24-hours from the start of the job. - -```yaml -Type: System.Nullable`1[System.TimeSpan] -Parameter Sets: HyperVToAzure, EnterpriseToEnterprise -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RPOWarningThresholdInMinutes -The RPO threshold value in minutes to warn on. - -```yaml -Type: System.Int32 -Parameter Sets: VMwareToAzure, AzureToVMware -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VmmToVmm -Switch parameter to specify policy is to be used to replicate between Hyper-V sites managed by a VMM server. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: EnterpriseToEnterprise -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMwareToAzure -Switch parameter specifying that the replication policy being created will be used to replicate VMware virtual machines and/or Physical servers to Azure. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: VMwareToAzure -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesAsrPolicy](./Get-AzureRmRecoveryServicesAsrPolicy.md) - -[Remove-AzureRmRecoveryServicesAsrPolicy](./Remove-AzureRmRecoveryServicesAsrPolicy.md) diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrProtectableItem.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrProtectableItem.md deleted file mode 100644 index ac739cc566..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrProtectableItem.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/new-azurermrecoveryservicesasrprotectableitem -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/New-AzureRmRecoveryServicesAsrProtectableItem.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/New-AzureRmRecoveryServicesAsrProtectableItem.md ---- - -# New-AzureRmRecoveryServicesAsrProtectableItem - -## SYNOPSIS -Add(Discover) a physical server to the list of protectable items. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmRecoveryServicesAsrProtectableItem -ProtectionContainer <ASRProtectionContainer> - -FriendlyName <String> -IPAddress <String> -OSType <String> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmRecoveryServicesAsrProtectableItem** adds a new protectable item to the list of discovered protectable items in a protection container within an ASR fabric (applicable only for the VMware fabric type). - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmRecoveryServicesAsrProtectableItem -ProtectionContainer $pc -Name $name -IPAddress $ipaddresss -OSType $OsType -``` - -Add or Discover new Azure Recovery Service ProtectableItem. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FriendlyName -Friendly name for the protectable item. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddress -IP address of the protectable item. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OSType -Operating System type (Windows/Linux) of the protectable item. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Windows, Linux - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtectionContainer -ASR Protection container object to which the protectable item should be added. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompt for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainer - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrProtectionContainer.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrProtectionContainer.md deleted file mode 100644 index 042687150b..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrProtectionContainer.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/new-azurermrecoveryservicesasrprotectioncontainer -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/New-AzureRmRecoveryServicesAsrProtectionContainer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/New-AzureRmRecoveryServicesAsrProtectionContainer.md ---- - -# New-AzureRmRecoveryServicesAsrProtectionContainer - -## SYNOPSIS -Creates an Azure Site Recovery Protection Container within the specified fabric. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmRecoveryServicesAsrProtectionContainer -Name <String> -InputObject <ASRFabric> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmRecoveryServicesAsrProtectionContainer cmdlet creates a Protection Container under the specified Azure Site Recovery Fabric. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $job = New-AzureRmRecoveryServicesAsrProtectionContainer -Name xyz -Fabric $fabric -PS C:\> Get-ASRJob -name $job.id -``` - -Starts the creation of the protection container with the specified parameters, and returns the ASR job used to track the operation. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Creates the replication protection container in specifed input Object (Azure Fabric). - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric -Parameter Sets: (All) -Aliases: Fabric - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the protection container. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrProtectionContainerMapping.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrProtectionContainerMapping.md deleted file mode 100644 index e8fa302e7f..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrProtectionContainerMapping.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/new-azurermrecoveryservicesasrprotectioncontainermapping -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/New-AzureRmRecoveryServicesAsrProtectionContainerMapping.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/New-AzureRmRecoveryServicesAsrProtectionContainerMapping.md ---- - -# New-AzureRmRecoveryServicesAsrProtectionContainerMapping - -## SYNOPSIS -Creates an Azure Site Recovery Protection Container mapping by associating the specified replication policy to the specified ASR protection container. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### EnterpriseToAzure (Default) -``` -New-AzureRmRecoveryServicesAsrProtectionContainerMapping -Name <String> -Policy <ASRPolicy> - -PrimaryProtectionContainer <ASRProtectionContainer> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### EnterpriseToEnterprise -``` -New-AzureRmRecoveryServicesAsrProtectionContainerMapping -Name <String> -Policy <ASRPolicy> - -PrimaryProtectionContainer <ASRProtectionContainer> -RecoveryProtectionContainer <ASRProtectionContainer> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmRecoveryServicesAsrProtectionContainerMapping** cmdlet creates an Azure Site Recovery Protection Container mapping by associating the specified replication policy to the specified protection container. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmRecoveryServicesAsrProtectionContainerMapping -Name $ContainerMappingName -Policy $ProtectionProfile -PrimaryProtectionContainer $PrimaryContainer -RecoveryProtectionContainer $RecoveryContainer - -Name : 1f32fee1-05d0-4c11-a997-1618e14b4dab -ID : /Subscriptions/xxxxxxxxxxxx/resourceGroups/canaryexproute/providers/Microsoft.RecoveryServices/vaults/IbizaV2ATest/replicationJobs/1f32fee1-05d0-4c11-a997-1618e14b4dab -Type : -JobType : -DisplayName : -ClientRequestId : 2870d5ab-f9be-405e-87d5-5bf20387c623 ActivityId: 24b28fc5-509b-4ad3-92c0-c8bb7ced7fb6 -State : NotStarted -StateDescription : NotStarted -StartTime : -EndTime : -TargetObjectId : -TargetObjectType : -TargetObjectName : -AllowedActions : -Tasks : {} -Errors : {} -``` - -Starts the creation of the protection container mapping with the specified parameters, and returns the ASR job used to track the operation. - -### Example 2 -``` -PS C:\> New-AzureRmRecoveryServicesAsrProtectionContainerMapping -Name $PrimaryProtectionContainerMapping -policy $Policy1 -PrimaryProtectionContainer $pc - -Name : 1f32fee1-05d0-4c11-a997-1618e14b4dab -ID : /Subscriptions/xxxxxxxxxxxx/resourceGroups/canaryexproute/providers/Microsoft.RecoveryServices/vaults/IbizaV2ATest/replicationJobs/1f32fee1-05d0-4c11-a997-1618e14b4dab -Type : -JobType : -DisplayName : -ClientRequestId : 2870d5ab-f9be-405e-87d5-5bf20387c623 ActivityId: 24b28fc5-509b-4ad3-92c0-c8bb7ced7fb6 -State : NotStarted -StateDescription : NotStarted -StartTime : -EndTime : -TargetObjectId : -TargetObjectType : -TargetObjectName : -AllowedActions : -Tasks : {} -Errors : {} -``` - -Starts the creation of the protection container mapping with the specified parameters, and returns the ASR job used to track the operation. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Protection Container mapping. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies the ASR replication policy object for the replication policy to be used in the mapping. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRPolicy -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PrimaryProtectionContainer -Specifies the ASR protection container object for the primary protection container to be used in the mapping. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryProtectionContainer -Specifies the ASR protection container object for the recovery protection container to be used in the mapping (used if replicating to a recovery location that is not Azure.) - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainer -Parameter Sets: EnterpriseToEnterprise -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRPolicy - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesAsrProtectionContainerMapping](./Get-AzureRmRecoveryServicesAsrProtectionContainerMapping.md) - -[Remove-AzureRmRecoveryServicesAsrProtectionContainerMapping](./Remove-AzureRmRecoveryServicesAsrProtectionContainerMapping.md) diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrRecoveryPlan.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrRecoveryPlan.md deleted file mode 100644 index 9e697c4188..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrRecoveryPlan.md +++ /dev/null @@ -1,228 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/new-azurermrecoveryservicesasrrecoveryplan -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/New-AzureRmRecoveryServicesAsrRecoveryPlan.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/New-AzureRmRecoveryServicesAsrRecoveryPlan.md ---- - -# New-AzureRmRecoveryServicesAsrRecoveryPlan - -## SYNOPSIS -Creates an ASR recovery plan. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### EnterpriseToEnterprise (Default) -``` -New-AzureRmRecoveryServicesAsrRecoveryPlan -Name <String> -PrimaryFabric <ASRFabric> - -RecoveryFabric <ASRFabric> -ReplicationProtectedItem <ASRReplicationProtectedItem[]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### EnterpriseToAzure -``` -New-AzureRmRecoveryServicesAsrRecoveryPlan -Name <String> -PrimaryFabric <ASRFabric> [-Azure] - -FailoverDeploymentModel <String> -ReplicationProtectedItem <ASRReplicationProtectedItem[]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByRPFile -``` -New-AzureRmRecoveryServicesAsrRecoveryPlan -Path <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmRecoveryServicesAsrRecoveryPlan** cmdlet creates an Azure Site Recovery recovery plan in the Recovery Services vault. - -A recovery plan gathers virtual machines belonging to an application into a unit to allow them to be recovered together. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $currentJob = New-AzureRmRecoveryServicesAsrRecoveryPlan -Name $RPName -PrimaryFabric $PrimaryFabric -RecoveryFabric $RecoveryFabric -ReplicationProtectedItem $RPI -``` - -Starts the recovery plan creation operation with the specified parameters and returns the ASR job used to track the operation. - -## PARAMETERS - -### -Azure -Switch parameter to specify that the recovery location for recovery plan is Azure. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: EnterpriseToAzure -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FailoverDeploymentModel -Specifies the failover deployment model (Classic or Resource Manager) of the replication protected items that will be part of this recovery plan. - -```yaml -Type: System.String -Parameter Sets: EnterpriseToAzure -Aliases: -Accepted values: Classic, ResourceManager - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the recovery plan. - -```yaml -Type: System.String -Parameter Sets: EnterpriseToEnterprise, EnterpriseToAzure -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path to the recovery plan definition json file. A recovery plan definition json can be used to create the recovery plan. - -```yaml -Type: System.String -Parameter Sets: ByRPFile -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimaryFabric -Specifies the ASR fabric object for the primary ASR fabric of the replication protected items that will be part of this recovery plan. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric -Parameter Sets: EnterpriseToEnterprise, EnterpriseToAzure -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryFabric -Specifies the ASR fabric object for the recovery ASR fabric of the replication protected items that will be part of this recovery plan. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric -Parameter Sets: EnterpriseToEnterprise -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationProtectedItem -The list of replication protected items to add to the first group of the recovery plan. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem[] -Parameter Sets: EnterpriseToEnterprise, EnterpriseToAzure -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem[] - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesAsrRecoveryPlan](./Get-AzureRmRecoveryServicesAsrRecoveryPlan.md) - -[Remove-AzureRmRecoveryServicesAsrRecoveryPlan](./Remove-AzureRmRecoveryServicesAsrRecoveryPlan.md) - -[Update-AzureRmRecoveryServicesAsrRecoveryPlan](./Update-AzureRmRecoveryServicesAsrRecoveryPlan.md) - - diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrReplicationProtectedItem.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrReplicationProtectedItem.md deleted file mode 100644 index 2e82f3988b..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrReplicationProtectedItem.md +++ /dev/null @@ -1,585 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/new-azurermrecoveryservicesasrreplicationprotecteditem -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/New-AzureRmRecoveryServicesAsrReplicationProtectedItem.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/New-AzureRmRecoveryServicesAsrReplicationProtectedItem.md ---- - -# New-AzureRmRecoveryServicesAsrReplicationProtectedItem - -## SYNOPSIS -Enables replication for an ASR protectable item by creating a replication protected item. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### EnterpriseToEnterprise (Default) -``` -New-AzureRmRecoveryServicesAsrReplicationProtectedItem [-VmmToVmm] -ProtectableItem <ASRProtectableItem> - -Name <String> -ProtectionContainerMapping <ASRProtectionContainerMapping> [-WaitForCompletion] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### VMwareToAzure -``` -New-AzureRmRecoveryServicesAsrReplicationProtectedItem [-VMwareToAzure] -ProtectableItem <ASRProtectableItem> - -Name <String> [-RecoveryVmName <String>] -ProtectionContainerMapping <ASRProtectionContainerMapping> - -RecoveryAzureStorageAccountId <String> -Account <ASRRunAsAccount> [-LogStorageAccountId <String>] - [-IncludeDiskId <String[]>] -ProcessServer <ASRProcessServer> [-RecoveryAzureNetworkId <String>] - [-RecoveryAzureSubnetName <String>] -RecoveryResourceGroupId <String> [-ReplicationGroupName <String>] - [-WaitForCompletion] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### EnterpriseToAzure -``` -New-AzureRmRecoveryServicesAsrReplicationProtectedItem [-HyperVToAzure] -ProtectableItem <ASRProtectableItem> - -Name <String> [-RecoveryVmName <String>] -ProtectionContainerMapping <ASRProtectionContainerMapping> - -RecoveryAzureStorageAccountId <String> -RecoveryResourceGroupId <String> [-WaitForCompletion] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### HyperVSiteToAzure -``` -New-AzureRmRecoveryServicesAsrReplicationProtectedItem [-HyperVToAzure] -ProtectableItem <ASRProtectableItem> - -Name <String> [-RecoveryVmName <String>] -ProtectionContainerMapping <ASRProtectionContainerMapping> - -RecoveryAzureStorageAccountId <String> -OSDiskName <String> -OS <String> [-LogStorageAccountId <String>] - [-IncludeDiskId <String[]>] [-RecoveryAzureNetworkId <String>] [-RecoveryAzureSubnetName <String>] - -RecoveryResourceGroupId <String> [-WaitForCompletion] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### AzureToAzure -``` -New-AzureRmRecoveryServicesAsrReplicationProtectedItem [-AzureToAzure] - -AzureToAzureDiskReplicationConfiguration <ASRAzuretoAzureDiskReplicationConfig[]> -AzureVmId <String> - -Name <String> [-RecoveryVmName <String>] -ProtectionContainerMapping <ASRProtectionContainerMapping> - -RecoveryResourceGroupId <String> [-RecoveryCloudServiceId <String>] [-RecoveryAvailabilitySetId <String>] - [-RecoveryBootDiagStorageAccountId <String>] [-WaitForCompletion] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### AzureToAzureWithoutDiskDetails -``` -New-AzureRmRecoveryServicesAsrReplicationProtectedItem [-AzureToAzure] -AzureVmId <String> -Name <String> - [-RecoveryVmName <String>] -ProtectionContainerMapping <ASRProtectionContainerMapping> - [-RecoveryAzureStorageAccountId <String>] -LogStorageAccountId <String> -RecoveryResourceGroupId <String> - [-RecoveryAvailabilitySetId <String>] [-RecoveryBootDiagStorageAccountId <String>] [-WaitForCompletion] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmRecoveryServicesAsrReplicationProtectedItem** cmdlet creates a new replication protected item. -Use this cmdlet to enable replication for an ASR protectable item. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $currentJob = New-AzureRmRecoveryServicesAsrReplicationProtectedItem -ProtectableItem $VM -Name $VM.Name -ProtectionContainerMapping $ProtectionContainerMapping -``` - -Starts the replication protected item creation operation for the specified ASR protectable item and returns the ASR job used to track the operation. - -### Example 2 -``` -PS C:\>$job = New-AzureRmRecoveryServicesAsrReplicationProtectedItem -ProtectableItem $pi -Name $rpiName -ProtectionContainerMapping $pcm ` --RecoveryAzureStorageAccountId $RecoveryAzureStorageAccountId -RecoveryResourceGroupId $RecoveryResourceGroupId ` --ProcessServer $fabric.fabricSpecificDetails.ProcessServers[0] -Account $fabric.fabricSpecificDetails.RunAsAccounts[0] -``` - -Starts the replication protected item creation operation for the specified ASR protectable item and returns the ASR job used to track the operation(vmWare to Azure scenario). - -### Example 3 -``` -PS C:>$job = New-AzureRmRecoveryServicesAsrReplicationProtectedItem -AzureToAzure -AzureToAzureDiskReplicationConfig disk1,disk2 -AzureVmId $vmId ` --Name "a2aprotectedItem" -RecoveryVmName "vmName" -ProtectionContainerMapping $pcmMapping -RecoveryResourceGroupId $recoveryResourceGroup -``` - -Starts the replication protected item creation operation for the specified ASR protectable item and returns the ASR job used to track the operation (Azure to Azure scenario). - -### Example 4 -``` -PS C:\> $disk1 = new-AzureToAzureDiskReplicationConfiguration -vhdUri $diskUri1 -RecoveryAzureStorageAccountId $recoveryAzureStorageAccountId ` --LogStorageAccountId $logStorageAccountId -PS C:\> $disk2 = new-AzureToAzureDiskReplicationConfiguration -vhdUri $diskUri2 -RecoveryAzureStorageAccountId $recoveryAzureStorageAccountId ` --LogStorageAccountId $logStorageAccountId -PS C:\> $enableDRjob = New-AzureRmRecoveryServicesAsrReplicationProtectedItem -AzureToAzure -AzureVmId $vmId -Name $rpiName ` --RecoveryCloudServiceId $recoveryCloudServiceId -ProtectionContainerMapping $pcm -RecoveryResourceGroupId $RecoveryResourceGroupId ` --AzureToAzureDiskReplicationConfiguration $disk1,$disk2 -``` - -Starts the replication protected item creation operation for the specified VmId and returns the ASR job used to track the operation (Azure to Azure scenario). - -## PARAMETERS - -### -Account -The run as account to be used to push install the Mobility service if needed. Must be one from the list of run as accounts in the ASR fabric. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRunAsAccount -Parameter Sets: VMwareToAzure -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AzureToAzure -Switch parameter to specify that the replicated item is an Azure virtual machine replicating to a recovery Azure region. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: AzureToAzure, AzureToAzureWithoutDiskDetails -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AzureToAzureDiskReplicationConfiguration -Specifies the list of virtual machine disks to replicated and the cache storage account and recovery storage account to be used to replicate the disk. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRAzuretoAzureDiskReplicationConfig[] -Parameter Sets: AzureToAzure -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AzureVmId -Specifies the azure vm id to be replicated. - -```yaml -Type: System.String -Parameter Sets: AzureToAzure, AzureToAzureWithoutDiskDetails -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HyperVToAzure -Switch parameter to specify the replicated item is a Hyper-V virtual machine that is being replicated to Azure. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: EnterpriseToAzure, HyperVSiteToAzure -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDiskId -The list of disks to include for replication. By default all disks are included. - -```yaml -Type: System.String[] -Parameter Sets: VMwareToAzure, HyperVSiteToAzure -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogStorageAccountId -Specifies the log or cache storage account Id to be used to store replication logs. - -```yaml -Type: System.String -Parameter Sets: VMwareToAzure, HyperVSiteToAzure -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: AzureToAzureWithoutDiskDetails -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the ASR replication protected item. The name must be unique within the vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OS -Specifies the operating system family. -The acceptable values for this parameter are: Windows or Linux. - -```yaml -Type: System.String -Parameter Sets: HyperVSiteToAzure -Aliases: -Accepted values: Windows, Linux - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OSDiskName -Specifies the name of the operating system disk. - -```yaml -Type: System.String -Parameter Sets: HyperVSiteToAzure -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProcessServer -The Process Server to use to replicate this machine. Use the list of process servers in the ASR fabric corresponding to the Configuration server to specify one. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProcessServer -Parameter Sets: VMwareToAzure -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtectableItem -Specifies the ASR protectable item object for which replication is being enabled. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectableItem -Parameter Sets: EnterpriseToEnterprise, VMwareToAzure, EnterpriseToAzure, HyperVSiteToAzure -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ProtectionContainerMapping -Specifies the ASR protection container mapping object corresponding to the replication policy to be used for replication. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainerMapping -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryAvailabilitySetId -The ID of the AvailabilitySet to recover the machine to in the event of a failover. - -```yaml -Type: System.String -Parameter Sets: AzureToAzure, AzureToAzureWithoutDiskDetails -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryAzureNetworkId -The ID of the Azure virtual network to recover the machine to in the event of a failover. - -```yaml -Type: System.String -Parameter Sets: VMwareToAzure, HyperVSiteToAzure -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryAzureStorageAccountId -Specifies the ID of the Azure storage account to replicate to. - -```yaml -Type: System.String -Parameter Sets: VMwareToAzure, EnterpriseToAzure, HyperVSiteToAzure -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: AzureToAzureWithoutDiskDetails -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryAzureSubnetName -The subnet within the recovery Azure virtual network to which the failed over virtual machine should be attached in the event of a failover. - -```yaml -Type: System.String -Parameter Sets: VMwareToAzure, HyperVSiteToAzure -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryBootDiagStorageAccountId -Specifies the storage account for boot diagnostics for recovery azure VM. - -```yaml -Type: System.String -Parameter Sets: AzureToAzure, AzureToAzureWithoutDiskDetails -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryCloudServiceId -Specifies the resource ID of the recovery cloud service to failover this virtual machine to. - -```yaml -Type: System.String -Parameter Sets: AzureToAzure -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryResourceGroupId -Specifies the ARM identifier of the resource group in which the virtual machine will be created in the event of a failover. - -```yaml -Type: System.String -Parameter Sets: VMwareToAzure, EnterpriseToAzure, HyperVSiteToAzure, AzureToAzure, AzureToAzureWithoutDiskDetails -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryVmName -Name of the recovery Vm created after failover. - -```yaml -Type: System.String -Parameter Sets: VMwareToAzure, EnterpriseToAzure, HyperVSiteToAzure, AzureToAzure, AzureToAzureWithoutDiskDetails -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationGroupName -Specifies the replication group name to use to create multi-VM consistent recovery points. By default each replication protected item is created in a group of its own and multi-VM consistent recovery points are not generated. Use this option only if you need to create multi-VM consistent recovery points across a group of machines by protecting all machines to the same replication group. - -```yaml -Type: System.String -Parameter Sets: VMwareToAzure -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VmmToVmm -Switch parameter to specify the replicated item is a Hyper-V virtual machine that is being replicated between VMM managed Hyper-V sites. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: EnterpriseToEnterprise -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMwareToAzure -Switch parameter to specify the replicated item is a VMware virtual machine or physical server that will be replicate to Azure. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: VMwareToAzure -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WaitForCompletion -Specifies that the cmdlet should wait for completion of the operation before returning. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts for confirmation before starting the operation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectableItem - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesAsrReplicationProtectedItem](./Get-AzureRmRecoveryServicesAsrReplicationProtectedItem.md) - -[Remove-AzureRmRecoveryServicesAsrReplicationProtectedItem](./Remove-AzureRmRecoveryServicesAsrReplicationProtectedItem.md) - -[Set-AzureRmRecoveryServicesAsrReplicationProtectedItem](./Set-AzureRmRecoveryServicesAsrReplicationProtectedItem.md) diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrStorageClassificationMapping.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrStorageClassificationMapping.md deleted file mode 100644 index 9b79ff6379..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrStorageClassificationMapping.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/new-azurermrecoveryservicesasrstorageclassificationmapping -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/New-AzureRmRecoveryServicesAsrStorageClassificationMapping.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/New-AzureRmRecoveryServicesAsrStorageClassificationMapping.md ---- - -# New-AzureRmRecoveryServicesAsrStorageClassificationMapping - -## SYNOPSIS -Creates an ASR storage classification mapping in the Recovery Services vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmRecoveryServicesAsrStorageClassificationMapping -Name <String> - -PrimaryStorageClassification <ASRStorageClassification> - -RecoveryStorageClassification <ASRStorageClassification> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmRecoveryServicesAsrStorageClassificationMapping** cmdlet creates a storage classification mapping the Recovery Services vault. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $currentJob = New-AzureRmRecoveryServicesAsrStorageClassificationMapping -Name $StrorageClassificationMappingName -PrimaryStorageClassification $PrimaryStorageClassification -RecoveryStorageClassification $RecoveryStorageClassification -``` - -Starts the storage classification mapping creation operation with the specified parameters and returns the ASR job used to track the operation. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the ASR storage classification mapping. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimaryStorageClassification -Specifies the primary ASR storage classification object for the mapping. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRStorageClassification -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RecoveryStorageClassification -Specifies the recovery ASR storage classification object for the mapping. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRStorageClassification -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRStorageClassification - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesAsrStorageClassificationMapping](./Get-AzureRmRecoveryServicesAsrStorageClassificationMapping.md) - -[Remove-AzureRmRecoveryServicesAsrStorageClassificationMapping](./Remove-AzureRmRecoveryServicesAsrStorageClassificationMapping.md) diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrVCenter.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrVCenter.md deleted file mode 100644 index 27eeeb3e59..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/New-AzureRmRecoveryServicesAsrVCenter.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/new-azurermrecoveryservicesasrvcenter -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/New-AzureRmRecoveryServicesAsrVCenter.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/New-AzureRmRecoveryServicesAsrVCenter.md ---- - -# New-AzureRmRecoveryServicesAsrvCenter - -## SYNOPSIS -Adds a vCenter server to discover protectable items from. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmRecoveryServicesAsrvCenter -Fabric <ASRFabric> -Name <String> -Account <ASRRunAsAccount> - -Port <Int32> -IpOrHostName <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmRecoveryServicesAsrvCenter** cmdlet adds a vCenter server to discover protectable items from. This cmdlet registers the vCenter server for discovery with the Configuration server. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmRecoveryServicesAsrvCenterServer -Account $ConfigServer.FabricSpecificDetails.RunAsAccounts[1] -Fabric $ConfigServer -Name InmTest59 -Port 443 -Server 10.150.209.6 - -Asr Job for vCenter creation. -``` - -Adds a vCenter server to discover protectable items from. - -## PARAMETERS - -### -Account -User login creadential Account. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRunAsAccount -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fabric -ASR fabric corresponding to the Configuration server. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IpOrHostName -IPv4 address or FQDN of the vCenter server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -A friendly name for the vCenter server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Port -The TCP port on the vCenter server to use for discovery. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric - -## OUTPUTS - -### System.Collections.Generic.IEnumerable`1[[Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob, Microsoft.Azure.Commands.RecoveryServices.SiteRecovery, Version=0.1.1.0, Culture=neutral, PublicKeyToken=null]] - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrFabric.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrFabric.md deleted file mode 100644 index 05c53eb34c..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrFabric.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/remove-azurermrecoveryservicesasrfabric -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Remove-AzureRmRecoveryServicesAsrFabric.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Remove-AzureRmRecoveryServicesAsrFabric.md ---- - -# Remove-AzureRmRecoveryServicesAsrFabric - -## SYNOPSIS -Deletes the specified Azure Site Recovery Fabric from the Recovery Services vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmRecoveryServicesAsrFabric -InputObject <ASRFabric> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmRecoveryServicesAsrFabric** cmdlet removes the specified Azure Site Recovery fabric from the Recovery services vault. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $currentJob = Remove-AzureRmRecoveryServicesAsrFabric -Fabric $Fabric -``` - -Starts the deletion of specified fabric and returns the ASR job used to track the operation. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Force the command to run without providing an additional warning. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The input object to the cmdlet: The ASR fabric object corresponding to the fabric to be deleted. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric -Parameter Sets: (All) -Aliases: Fabric - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Specify if confirmation is required. Set the value of the confirm parameter to $false in order to skip confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet is executed without actually executing the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesAsrFabric](./Get-AzureRmRecoveryServicesAsrFabric.md) - -[New-AzureRmRecoveryServicesAsrFabric](./New-AzureRmRecoveryServicesAsrFabric.md) diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrNetworkMapping.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrNetworkMapping.md deleted file mode 100644 index 3ddd440a69..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrNetworkMapping.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/remove-azurermrecoveryservicesasrnetworkmapping -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Remove-AzureRmRecoveryServicesAsrNetworkMapping.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Remove-AzureRmRecoveryServicesAsrNetworkMapping.md ---- - -# Remove-AzureRmRecoveryServicesAsrNetworkMapping - -## SYNOPSIS -Deletes the specified ASR network mapping from the Recovery Services vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmRecoveryServicesAsrNetworkMapping -InputObject <ASRNetworkMapping> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmRecoveryServicesAsrNetworkMapping** cmdlet deletes the specified ASR network mapping. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $currentJob = Remove-AzureRmRecoveryServicesAsrNetworkMapping -NetworkMapping $networkmapping -``` - -Starts the deletion of specified ASR network mapping and returns the ASR job used to track the operation. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The input object to the cmdlet: The ASR network mapping object corresponding to the ASR network mapping to be deleted. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRNetworkMapping -Parameter Sets: (All) -Aliases: NetworkMapping - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRNetworkMapping - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesAsrNetworkMapping](./Get-AzureRmRecoveryServicesAsrNetworkMapping.md) - -[New-AzureRmRecoveryServicesAsrNetworkMapping](./New-AzureRmRecoveryServicesAsrNetworkMapping.md) diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrPolicy.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrPolicy.md deleted file mode 100644 index e89b567dcc..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrPolicy.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/remove-azurermrecoveryservicesasrpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Remove-AzureRmRecoveryServicesAsrPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Remove-AzureRmRecoveryServicesAsrPolicy.md ---- - -# Remove-AzureRmRecoveryServicesAsrPolicy - -## SYNOPSIS -Deletes the specified ASR replication policy from the Recovery Services vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmRecoveryServicesAsrPolicy -InputObject <ASRPolicy> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmRecoveryServicesAsrPolicy** cmdlet deleted the specified replication policy from the Recovery Services vault. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $currentJob = Remove-AzureRmRecoveryServicesAsrPolicy -Policy $Policy -``` - -Starts the deletion of the specified replication policy and returns the ASR job used to track the operation. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The input object to the cmdlet: The ASR replication policy object corresponding to the replication policy to be deleted. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRPolicy -Parameter Sets: (All) -Aliases: Policy - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRPolicy - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesAsrPolicy](./Get-AzureRmRecoveryServicesAsrPolicy.md) - -[New-AzureRmRecoveryServicesAsrPolicy](./New-AzureRmRecoveryServicesAsrPolicy.md) diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrProtectionContainer.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrProtectionContainer.md deleted file mode 100644 index 31c5457d36..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrProtectionContainer.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/remove-azurermrecoveryservicesasrprotectioncontainer -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Remove-AzureRmRecoveryServicesAsrProtectionContainer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Remove-AzureRmRecoveryServicesAsrProtectionContainer.md ---- - -# Remove-AzureRmRecoveryServicesAsrProtectionContainer - -## SYNOPSIS -Deletes the specified Protection Container from its Fabric. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmRecoveryServicesAsrProtectionContainer -InputObject <ASRProtectionContainer> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmRecoveryServicesAsrProtectionContainer cmdlet deletes the specified Azure Site Recovery Protection Container. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmRecoveryServicesAsrProtectionContainer -Name xxxxx -Fabric $fabric -PS C:\> Remove-AzureRmRecoveryServicesAsrProtectionContainer -InputObject $protectionContainer -``` - -Starts the deletion of specified protection container and returns the ASR job used to track the remove operation. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the protection container to be removed . - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainer -Parameter Sets: (All) -Aliases: ProtectionContainer - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainer - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrProtectionContainerMapping.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrProtectionContainerMapping.md deleted file mode 100644 index 1d32cacc49..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrProtectionContainerMapping.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/remove-azurermrecoveryservicesasrprotectioncontainermapping -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Remove-AzureRmRecoveryServicesAsrProtectionContainerMapping.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Remove-AzureRmRecoveryServicesAsrProtectionContainerMapping.md ---- - -# Remove-AzureRmRecoveryServicesAsrProtectionContainerMapping - -## SYNOPSIS -Deletes the specified Azure Site Recovery protection container mapping. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmRecoveryServicesAsrProtectionContainerMapping -InputObject <ASRProtectionContainerMapping> - [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmRecoveryServicesAsrProtectionContainerMapping** cmdlet deletes the specified Azure Site Recovery protection container mapping. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $currentJob = Remove-AzureRmRecoveryServicesAsrProtectionContainerMapping -ProtectionContainerMapping $ProtectionContainerMapping -``` - -Starts the deletion of specified protection container mapping and returns the ASR job used to track the operation. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Force the command to run without providing an additional warning. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The input object to the cmdlet: the ASR protection container mapping object corresponding to the protection container to be deleted. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainerMapping -Parameter Sets: (All) -Aliases: ProtectionContainerMapping - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Specify if confirmation is required. Set the value of the confirm parameter to $false in order to skip confirmation - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet is executed without actually executing the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainerMapping - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesAsrProtectionContainerMapping](./Get-AzureRmRecoveryServicesAsrProtectionContainerMapping.md) - -[New-AzureRmRecoveryServicesAsrProtectionContainerMapping](./New-AzureRmRecoveryServicesAsrProtectionContainerMapping.md) diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrRecoveryPlan.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrRecoveryPlan.md deleted file mode 100644 index 6f7af9979e..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrRecoveryPlan.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/remove-azurermrecoveryservicesasrrecoveryplan -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Remove-AzureRmRecoveryServicesAsrRecoveryPlan.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Remove-AzureRmRecoveryServicesAsrRecoveryPlan.md ---- - -# Remove-AzureRmRecoveryServicesAsrRecoveryPlan - -## SYNOPSIS -Deletes the specified ASR recovery plan from Recovery Services vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByObject (Default) -``` -Remove-AzureRmRecoveryServicesAsrRecoveryPlan -InputObject <ASRRecoveryPlan> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByName -``` -Remove-AzureRmRecoveryServicesAsrRecoveryPlan -Name <String> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmRecoveryServicesAsrRecoveryPlan** cmdlet deletes the specified recovery plan from the Recovery Services vault. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $currentJob = Remove-AzureRmRecoveryServicesAsrRecoveryPlan -RecoveryPlan $RP -``` - -Starts the deletion of specified recovery plan and returns the ASR job used to track the operation. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The input object to the cmdlet: The ASR recovery plan object corresponding to the recovery plan to be deleted. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan -Parameter Sets: ByObject -Aliases: RecoveryPlan - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the recovery plan to be deleted. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesAsrRecoveryPlan](./Get-AzureRmRecoveryServicesAsrRecoveryPlan.md) - -[New-AzureRmRecoveryServicesAsrRecoveryPlan](./New-AzureRmRecoveryServicesAsrRecoveryPlan.md) - -[Update-AzureRmRecoveryServicesAsrRecoveryPlan](./Update-AzureRmRecoveryServicesAsrRecoveryPlan.md) - - diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrReplicationProtectedItem.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrReplicationProtectedItem.md deleted file mode 100644 index 5473f69eaf..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrReplicationProtectedItem.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/remove-azurermrecoveryservicesasrreplicationprotecteditem -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Remove-AzureRmRecoveryServicesAsrReplicationProtectedItem.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Remove-AzureRmRecoveryServicesAsrReplicationProtectedItem.md ---- - -# Remove-AzureRmRecoveryServicesAsrReplicationProtectedItem - -## SYNOPSIS -Stops/Disables replication for an Azure Site Recovery replication protected item. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmRecoveryServicesAsrReplicationProtectedItem -InputObject <ASRReplicationProtectedItem> - [-WaitForCompletion] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmRecoveryServicesAsrReplicationProtectedItem** cmdlet disables replication of the specified Azure Site Recovery replication protected item. -This operation causes replication to stop for the protected item. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $currentJob = Remove-AzureRmRecoveryServicesAsrReplicationProtectedItem -ReplicationProtectedItem $ReplicationProtectedItem -``` - -Starts the disable replication operation for the specified replication protected item and returns the ASR job used to track the operation. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Force the command to run without providing an additional warning. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The input object to the cmdlet: The ASR replication protected item object corresponding to the replication protected item for which replication is to be disabled. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem -Parameter Sets: (All) -Aliases: ReplicationProtectedItem - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WaitForCompletion -Indicates that the cmdlet should wait for the operation to complete before returning. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Specify if confirmation is required. Set the value of the confirm parameter to $false in order to skip confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet is executed without actually executing the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesAsrReplicationProtectedItem](./Get-AzureRmRecoveryServicesAsrReplicationProtectedItem.md) - -[New-AzureRmRecoveryServicesAsrReplicationProtectedItem](./New-AzureRmRecoveryServicesAsrReplicationProtectedItem.md) - -[Set-AzureRmRecoveryServicesAsrReplicationProtectedItem](./Set-AzureRmRecoveryServicesAsrReplicationProtectedItem.md) diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrServicesProvider.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrServicesProvider.md deleted file mode 100644 index e9eb255a26..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrServicesProvider.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/remove-azurermrecoveryservicesasrservicesprovider -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Remove-AzureRmRecoveryServicesAsrServicesProvider.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Remove-AzureRmRecoveryServicesAsrServicesProvider.md ---- - -# Remove-AzureRmRecoveryServicesAsrServicesProvider - -## SYNOPSIS -Deletes/unregister the specified Azure Site Recovery recovery services provider from the recovery services vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmRecoveryServicesAsrServicesProvider -InputObject <ASRRecoveryServicesProvider> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmRecoveryServicesAsrServicesProvider** cmdlet removes the specified Azure Site Recovery recovery services provider from the vault. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $currentJob = Remove-AzureRmRecoveryServicesAsrServicesProvider -ServicesProvider $ServicesProvider -``` - -Starts the deletion/unregistration of the specified Azure Site Recovery services provider and returns the ASR job used to track the operation. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Force the command to run without providing an additional warning. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The input object to the cmdlet: The ASR recovery services provider object corresponding to the ASR recovery services provider to be deleted. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryServicesProvider -Parameter Sets: (All) -Aliases: ServicesProvider - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Specify if confirmation is required. Set the value of the confirm parameter to $false in order to skip confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet is executed without actually executing the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryServicesProvider - -## OUTPUTS - -### System.Collections.Generic.IEnumerable`1[[Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob, Microsoft.Azure.Commands.RecoveryServices.SiteRecovery, Version=4.0.0.0, Culture=neutral, PublicKeyToken=null]] - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesAsrServicesProvider](./Get-AzureRmRecoveryServicesAsrServicesProvider.md) - -[Update-AzureRmRecoveryServicesAsrServicesProvider](./Update-AzureRmRecoveryServicesAsrServicesProvider.md) diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrStorageClassificationMapping.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrStorageClassificationMapping.md deleted file mode 100644 index e370c7dfc6..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrStorageClassificationMapping.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/remove-azurermrecoveryservicesasrstorageclassificationmapping -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Remove-AzureRmRecoveryServicesAsrStorageClassificationMapping.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Remove-AzureRmRecoveryServicesAsrStorageClassificationMapping.md ---- - -# Remove-AzureRmRecoveryServicesAsrStorageClassificationMapping - -## SYNOPSIS -Deletes the specified ASR storage classification mapping. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmRecoveryServicesAsrStorageClassificationMapping -InputObject <ASRStorageClassificationMapping> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmRecoveryServicesAsrStorageClassificationMapping** cmdlet deletes the specified Azure Site Recovery storage classification mapping. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $currentJob = Remove-AzureRmRecoveryServicesAsrStorageClassificationMapping -StorageClassificationMapping $StorageClassificationMapping -``` - -Starts the deletion of specified storage classification mapping and returns the ASR job used to track the operation. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The input object to the cmdlet: The ASR storage classification mapping object corresponding to the ASR storage classification mapping to be deleted. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRStorageClassificationMapping -Parameter Sets: (All) -Aliases: StorageClassificationMapping - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRStorageClassificationMapping - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesAsrStorageClassificationMapping](./Get-AzureRmRecoveryServicesAsrStorageClassificationMapping.md) - -[New-AzureRmRecoveryServicesAsrStorageClassificationMapping](./New-AzureRmRecoveryServicesAsrStorageClassificationMapping.md) diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrVCenter.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrVCenter.md deleted file mode 100644 index 3d5619570f..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Remove-AzureRmRecoveryServicesAsrVCenter.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/remove-azurermrecoveryservicesasrvcenter -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Remove-AzureRmRecoveryServicesAsrVCenter.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Remove-AzureRmRecoveryServicesAsrVCenter.md ---- - -# Remove-AzureRmRecoveryServicesAsrvCenter - -## SYNOPSIS -Removes the vCenter server from the ASR fabric and stops discovery of virtual machines from the vCenter server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Default (Default) -``` -Remove-AzureRmRecoveryServicesAsrvCenter -InputObject <ASRvCenter> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Remove-AzureRmRecoveryServicesAsrvCenter -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByName -``` -Remove-AzureRmRecoveryServicesAsrvCenter -Fabric <ASRFabric> -Name <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmRecoveryServicesAsrvCenter** cmdlet removes the vCenter server from the ASR fabric and stops discovery of virtual machines from the vCenter server. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmRecoveryServicesAsrvCenterServer -InputObject $vCenter -``` - -Removes the vCenter server from the ASR fabric. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fabric -ASR fabric object representing the Configuration Server. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric -Parameter Sets: ByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InputObject -ASR vCenter object representing the vCenter server to be removed. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRvCenter -Parameter Sets: Default -Aliases: vCenter - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the vCenter Server. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Specifies the resourceId of vCenter to remove. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRvCenter - -## OUTPUTS - -### System.Collections.Generic.IEnumerable`1[[Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob, Microsoft.Azure.Commands.RecoveryServices.SiteRecovery, Version=0.1.1.0, Culture=neutral, PublicKeyToken=null]] - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Restart-AzureRmRecoveryServicesAsrJob.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Restart-AzureRmRecoveryServicesAsrJob.md deleted file mode 100644 index a6c09471d3..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Restart-AzureRmRecoveryServicesAsrJob.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/restart-azurermrecoveryservicesasrjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Restart-AzureRmRecoveryServicesAsrJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Restart-AzureRmRecoveryServicesAsrJob.md ---- - -# Restart-AzureRmRecoveryServicesAsrJob - -## SYNOPSIS -Restarts an Azure Site Recovery job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByObject (Default) -``` -Restart-AzureRmRecoveryServicesAsrJob -InputObject <ASRJob> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByName -``` -Restart-AzureRmRecoveryServicesAsrJob -Name <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Restart-AzureRmRecoveryServicesAsrJob** cmdlet restarts an Azure Site Recovery job. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $currentJob = Restart-AzureRmRecoveryServicesAsrJob -Job $Job -``` - -Restarts the specified ASR job and returns the updated ASR job object of the ASR job. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The input object to the cmdlet: The ASR job object corresponding to the ASR job to be restarted - - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob -Parameter Sets: ByObject -Aliases: Job - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specify the job by name. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesAsrJob](./Get-AzureRmRecoveryServicesAsrJob.md) - -[Resume-AzureRmRecoveryServicesAsrJob](./Resume-AzureRmRecoveryServicesAsrJob.md) - -[Stop-AzureRmRecoveryServicesAsrJob](./Stop-AzureRmRecoveryServicesAsrJob.md) diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Resume-AzureRmRecoveryServicesAsrJob.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Resume-AzureRmRecoveryServicesAsrJob.md deleted file mode 100644 index f13f9df8fa..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Resume-AzureRmRecoveryServicesAsrJob.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/resume-azurermrecoveryservicesasrjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Resume-AzureRmRecoveryServicesAsrJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Resume-AzureRmRecoveryServicesAsrJob.md ---- - -# Resume-AzureRmRecoveryServicesAsrJob - -## SYNOPSIS -Resumes a suspended Azure Site Recovery job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByObject (Default) -``` -Resume-AzureRmRecoveryServicesAsrJob -InputObject <ASRJob> [-Comment <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByName -``` -Resume-AzureRmRecoveryServicesAsrJob -Name <String> [-Comment <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Resume-AzureRmRecoveryServicesAsrJob** cmdlet resumes a suspended Azure Site Recovery job. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $currentJob = Resume-AzureRmRecoveryServicesAsrJob -Job $Job -``` - -Resume the specified job if it is in a waiting or suspended state and return the updated ASR job object corresponding to the ASR job. - -## PARAMETERS - -### -Comment -Comments for the job log. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Comments - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The input object to the cmdlet: The ASR Job object corresponding to the job to be resumed. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob -Parameter Sets: ByObject -Aliases: Job - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specify the ASR job by name. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesAsrJob](./Get-AzureRmRecoveryServicesAsrJob.md) - -[Restart-AzureRmRecoveryServicesAsrJob](./Restart-AzureRmRecoveryServicesAsrJob.md) - -[Stop-AzureRmRecoveryServicesAsrJob](./Stop-AzureRmRecoveryServicesAsrJob.md) diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Set-AzureRmRecoveryServicesAsrAlertSetting.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Set-AzureRmRecoveryServicesAsrAlertSetting.md deleted file mode 100644 index 7e48bb7aa2..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Set-AzureRmRecoveryServicesAsrAlertSetting.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/set-azurermrecoveryservicesasralertsetting -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Set-AzureRmRecoveryServicesAsrAlertSetting.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Set-AzureRmRecoveryServicesAsrAlertSetting.md ---- - -# Set-AzureRmRecoveryServicesAsrAlertSetting - -## SYNOPSIS -Configure Azure Site Recovery notification settings (email notification) for the vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Set (Default) -``` -Set-AzureRmRecoveryServicesAsrAlertSetting [-CustomEmailAddress <String[]>] [-LocaleID <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### EmailToSubscriptionOwner -``` -Set-AzureRmRecoveryServicesAsrAlertSetting [-EnableEmailSubscriptionOwner] [-CustomEmailAddress <String[]>] - [-LocaleID <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### DisableEmailToSubcriptionOwner -``` -Set-AzureRmRecoveryServicesAsrAlertSetting [-DisableEmailToSubscriptionOwner] [-CustomEmailAddress <String[]>] - [-LocaleID <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Disable -``` -Set-AzureRmRecoveryServicesAsrAlertSetting [-DisableNotification] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmRecoveryServicesAsrNotificationSetting** cmdlet configures Azure Site Recovery notification settings (email notification) for the vault. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Set-AzureRmRecoveryServicesAsrAlertSetting -DisableNotification - -CustomEmailAddress EmailSubscriptionOwner Locale ------------------- ---------------------- ------ -{} Off en-US -``` - -Disable notification. - -### Example 2 -``` -PS C:\> Set-AzureRmRecoveryServicesAsrAlertSetting -CustomEmailAddress "abcxxxx@xxxx.com" -EmailSubscriptionOwner - -CustomEmailAddress EmailSubscriptionOwner Locale ------------------- ---------------------- ------ -{abcxxxx@xxxx.com} On en-US -``` - -Set notification for custom email address(s) and for subscription owner. - -## PARAMETERS - -### -CustomEmailAddress -Alert / Notification sent to emails. - -```yaml -Type: System.String[] -Parameter Sets: Set, EmailToSubscriptionOwner, DisableEmailToSubcriptionOwner -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableEmailToSubscriptionOwner -Switch parameter specifies enable notification to subscription owner. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: DisableEmailToSubcriptionOwner -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableNotification -Flag to disable all notification. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Disable -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableEmailSubscriptionOwner -Switch paramter specifies enable notification to subscription owner. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: EmailToSubscriptionOwner -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocaleID -Email language of alert /notifcation to user(supported culture codes from microsoft). - -```yaml -Type: System.String -Parameter Sets: Set, EmailToSubscriptionOwner, DisableEmailToSubcriptionOwner -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Collections.Generic.IEnumerable`1[[Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRAlertSetting, Microsoft.Azure.Commands.RecoveryServices.SiteRecovery, Version=0.1.1.0, Culture=neutral, PublicKeyToken=null]] - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Set-AzureRmRecoveryServicesAsrReplicationProtectedItem.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Set-AzureRmRecoveryServicesAsrReplicationProtectedItem.md deleted file mode 100644 index cce415d516..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Set-AzureRmRecoveryServicesAsrReplicationProtectedItem.md +++ /dev/null @@ -1,339 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/set-azurermrecoveryservicesasrreplicationprotecteditem -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Set-AzureRmRecoveryServicesAsrReplicationProtectedItem.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Set-AzureRmRecoveryServicesAsrReplicationProtectedItem.md ---- - -# Set-AzureRmRecoveryServicesAsrReplicationProtectedItem - -## SYNOPSIS -Sets recovery properties such as target network and virtual machine size for the specified replication protected item. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmRecoveryServicesAsrReplicationProtectedItem -InputObject <ASRReplicationProtectedItem> - [-Name <String>] [-Size <String>] [-PrimaryNic <String>] [-RecoveryNetworkId <String>] - [-RecoveryCloudServiceId <String>] [-RecoveryNicSubnetName <String>] [-RecoveryNicStaticIPAddress <String>] - [-NicSelectionType <String>] [-RecoveryResourceGroupId <String>] [-LicenseType <String>] - [-RecoveryAvailabilitySet <String>] [-RecoveryBootDiagStorageAccountId <String>] - [-AzureToAzureUpdateReplicationConfiguration <ASRAzuretoAzureDiskReplicationConfig[]>] - [-UseManagedDisk <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmRecoveryServicesAsrReplicationProtectedItem** cmdlet sets the recovery properties for a Replication Protected Item. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $currentJob = Set-AzureRmRecoveryServicesAsrReplicationProtectedItem -ReplicationProtectedItem $RPI -PrimaryNic $NicId -RecoveryNetworkId $AzureNetworkID -RecoveryNicSubnetName $subnetName -``` - -Starts the operation of updating the replication protect item settings using the specified parameters and returns the ASR job used to track the operation. - -## PARAMETERS - -### -AzureToAzureUpdateReplicationConfiguration -Specifies the update relication configration. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRAzuretoAzureDiskReplicationConfig[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The input object to the cmdlet: The ASR replication protected item object corresponding to the replication protected item to update. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem -Parameter Sets: (All) -Aliases: ReplicationProtectedItem - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LicenseType -Specifiy the license type selection to be used for Windows Server virtual machines. If you are entitled to use the Azure Hybrid Use Benefit (HUB) for migrations and would like to specify that the HUB setting be used while failing over this protected item set the license type to be WindowsServer. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: NoLicenseType, WindowsServer - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the recovery virtual machine that will be created on failover. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NicSelectionType -Specifies the network interface card (NIC) properties set by user or set by default. -You can specify NotSelected to go back to the default values. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: NotSelected, SelectedByUser - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimaryNic -Specifies the NIC of the virtual machine for which this cmdlet sets the recovery network property. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryAvailabilitySet -Availability set for replication protected item after failover. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryBootDiagStorageAccountId -Specifies the storage account for boot diagnostics for recovery azure VM. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryCloudServiceId -The resource ID of the recovery cloud service to failover this virtual machine to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryNetworkId -Specifies the ID of the Azure virtual network to which the protected item should be failed over. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryNicStaticIPAddress -Specifies the static IP address that should be assigned to primary NIC on recovery. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryNicSubnetName -Specifies the name of the subnet on the recovery Azure virtual network to which this NIC of the protected item should be connected to on failover. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryResourceGroupId -The ID of the Azure resource group in the recovery region in which the protected item will be recovered on failover. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Size -Specifies the recovery virtual machine size. -The value should be from the set of sizes supported by Azure virtual machines. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseManagedDisk -Specifies if the Azure virtual machine that is created on failover should use managed disks. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: True, False - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesAsrReplicationProtectedItem](./Get-AzureRmRecoveryServicesAsrReplicationProtectedItem.md) - -[New-AzureRmRecoveryServicesAsrReplicationProtectedItem](./New-AzureRmRecoveryServicesAsrReplicationProtectedItem.md) - -[Remove-AzureRmRecoveryServicesAsrReplicationProtectedItem](./Remove-AzureRmRecoveryServicesAsrReplicationProtectedItem.md) diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Set-AzureRmRecoveryServicesAsrVaultContext.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Set-AzureRmRecoveryServicesAsrVaultContext.md deleted file mode 100644 index fbf2f05860..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Set-AzureRmRecoveryServicesAsrVaultContext.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/set-azurermrecoveryservicesasrvaultcontext -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Set-AzureRmRecoveryServicesAsrVaultContext.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Set-AzureRmRecoveryServicesAsrVaultContext.md ---- - -# Set-AzureRmRecoveryServicesAsrVaultContext - -## SYNOPSIS -Sets the Recovery Services vault context to be used for subsequent Azure Site Recovery operations in the current PowerShell session. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### AzureRecoveryServicesVault (Default) -``` -Set-AzureRmRecoveryServicesAsrVaultContext -Vault <ARSVault> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Set-AzureRmRecoveryServicesAsrVaultContext -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmRecoveryServicesAsrVaultContext** cmdlet sets the Azure Site Recovery vault context for further operations. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $vaultSettings = Set-AzureRmRecoveryServicesAsrVaultContext -Vault $RecoveryServicesVault -``` - -Sets the vault context to the specified Recovery Services vault for subsequent Azure Site Recovery operations in the current PowerShell session. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Specifies the recoveryservices vault resource id to be set as Vault context. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Vault -The Recovery Services vault object corresponding to the Recovery Services vault. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.ARSVault -Parameter Sets: AzureRecoveryServicesVault -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.ARSVault - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRVaultSettings - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Start-AzureRmRecoveryServicesAsrApplyRecoveryPoint.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Start-AzureRmRecoveryServicesAsrApplyRecoveryPoint.md deleted file mode 100644 index 80785c61a7..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Start-AzureRmRecoveryServicesAsrApplyRecoveryPoint.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/start-azurermrecoveryservicesasrapplyrecoverypoint -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Start-AzureRmRecoveryServicesAsrApplyRecoveryPoint.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Start-AzureRmRecoveryServicesAsrApplyRecoveryPoint.md ---- - -# Start-AzureRmRecoveryServicesAsrApplyRecoveryPoint - -## SYNOPSIS -Changes a recovery point for a failed over protected item before commiting the failover operation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Start-AzureRmRecoveryServicesAsrApplyRecoveryPoint -RecoveryPoint <ASRRecoveryPoint> - -ReplicationProtectedItem <ASRReplicationProtectedItem> [-DataEncryptionPrimaryCertFile <String>] - [-DataEncryptionSecondaryCertFile <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Start-AzureRmRecoveryServicesAsrApplyRecoveryPoint** changes the recovery point for a failed over protected item before it commits the failover operation. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $currentJob = Start-AzureRmRecoveryServicesAsrApplyRecoveryPoint -RecoveryPoint $RecoveryPoint -ReplicationProtectedItem $RPI -``` - -Starts applying the specified recovery point to the replication protected item and returns the ASR job used to track the operation. - -## PARAMETERS - -### -DataEncryptionPrimaryCertFile -Specifies the primary certificate file if data encryption is being used. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataEncryptionSecondaryCertFile -Specifies the secondary certificate file if data encryption is being used. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryPoint -Specifies the recovery point object corresponding to the recovery point to be applied. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPoint -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationProtectedItem -Specifies the ASR replication protected item object. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob - -## NOTES - -## RELATED LINKS - - diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Start-AzureRmRecoveryServicesAsrCommitFailoverJob.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Start-AzureRmRecoveryServicesAsrCommitFailoverJob.md deleted file mode 100644 index 14fc7d8b78..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Start-AzureRmRecoveryServicesAsrCommitFailoverJob.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/start-azurermrecoveryservicesasrcommitfailoverjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Start-AzureRmRecoveryServicesAsrCommitFailoverJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Start-AzureRmRecoveryServicesAsrCommitFailoverJob.md ---- - -# Start-AzureRmRecoveryServicesAsrCommitFailoverJob - -## SYNOPSIS -Starts the commit failover action for a Site Recovery object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByRPIObject (Default) -``` -Start-AzureRmRecoveryServicesAsrCommitFailoverJob -ReplicationProtectedItem <ASRReplicationProtectedItem> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByRPObject -``` -Start-AzureRmRecoveryServicesAsrCommitFailoverJob -RecoveryPlan <ASRRecoveryPlan> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Start-AzureRmRecoveryServicesAsrCommitFailoverJob** cmdlet starts the commit failover process for an Azure Site Recovery object after a failover operation. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $currentJob = Start-AzureRmRecoveryServicesAsrCommitFailoverJob -RecoveryPlan $RP -``` - -Starts the commit failover for the specified recovery plan and returns the ASR job used to track the operation. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryPlan -Specifies an ASR recovery plan object corresponding to recovery plan to be failovered. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan -Parameter Sets: ByRPObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ReplicationProtectedItem -Specifies an ASR replication protected item object corresponding to replication protected item to be failovered. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem -Parameter Sets: ByRPIObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan -Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Start-AzureRmRecoveryServicesAsrPlannedFailoverJob.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Start-AzureRmRecoveryServicesAsrPlannedFailoverJob.md deleted file mode 100644 index 073979e99e..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Start-AzureRmRecoveryServicesAsrPlannedFailoverJob.md +++ /dev/null @@ -1,255 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/start-azurermrecoveryservicesasrplannedfailoverjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Start-AzureRmRecoveryServicesAsrPlannedFailoverJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Start-AzureRmRecoveryServicesAsrPlannedFailoverJob.md ---- - -# Start-AzureRmRecoveryServicesAsrPlannedFailoverJob - -## SYNOPSIS -Starts a planned failover operation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByRPIObject (Default) -``` -Start-AzureRmRecoveryServicesAsrPlannedFailoverJob -ReplicationProtectedItem <ASRReplicationProtectedItem> - -Direction <String> [-Optimize <String>] [-CreateVmIfNotFound <String>] - [-ServicesProvider <ASRRecoveryServicesProvider>] [-DataEncryptionPrimaryCertFile <String>] - [-DataEncryptionSecondaryCertFile <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByRPObject -``` -Start-AzureRmRecoveryServicesAsrPlannedFailoverJob -RecoveryPlan <ASRRecoveryPlan> -Direction <String> - [-Optimize <String>] [-CreateVmIfNotFound <String>] [-DataEncryptionPrimaryCertFile <String>] - [-DataEncryptionSecondaryCertFile <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Start-AzureRmRecoveryServicesAsrPlannedFailoverJob** cmdlet starts a planned failover for an Azure Site Recovery replication protected item or recovery plan. -You can check whether the job succeeds by using the Get-AzureRmRecoveryServicesAsrJob cmdlet. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $currentJob = Start-AzureRmRecoveryServicesAsrPlannedFailoverJob -RecoveryPlan $RP -Direction PrimaryToRecovery -``` - -Starts the planned failover for the specified ASR recovery plan and returns the ASR job used to track the operation. - -## PARAMETERS - -### -CreateVmIfNotFound -Create the virtual machine if not found while failing back to the primary region (used in alternate location recovery.) The acceptable values for this parameter are: - -- Yes -- No - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Yes, No - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataEncryptionPrimaryCertFile -Specifies the primary certificate file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataEncryptionSecondaryCertFile -Specifies the secondary certificate file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Direction -Specifies the direction of the failover. -The acceptable values for this parameter are: - -- PrimaryToRecovery -- RecoveryToPrimary - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: PrimaryToRecovery, RecoveryToPrimary - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Optimize -Specifies what to optimize for. -This parameter applies when failover is done from an Azure site to an on-premise site which requires substantial data synchronization. -Valid values are: - -- ForDowntime -- ForSynchronization - -When **ForDowntime** is specified, this indicates that data is synchronized before failover to minimize downtime. -Synchronization is performed without shutting down the virtual machine. -After synchronization is complete, the job is suspended. -Resume the job to do an additional synchronization operation that shuts down the virtual machine. - -When **ForSynchronization** is specified, this indicates that data is synchronized during failover only so data synchronization is minimized. -With this setting enabled, the virtual machine is shut down immediately. -Synchronization starts after shutdown to complete the failover operation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: ForDownTime, ForSynchronization - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryPlan -Specifies the ASR Recovery plan object corresponding to the recovery plan to be failed over. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan -Parameter Sets: ByRPObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ReplicationProtectedItem -Specifies the ASR replication protected item object corresponding to the replication protected item to be failed over. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem -Parameter Sets: ByRPIObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServicesProvider -Identifies the host to on which to create the virtual machine while failing over to an alternate location by specifying the ASR services provider object corresponding to the ASR services provider running on the host. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryServicesProvider -Parameter Sets: ByRPIObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan -Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Start-AzureRmRecoveryServicesAsrResynchronizeReplicationJob.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Start-AzureRmRecoveryServicesAsrResynchronizeReplicationJob.md deleted file mode 100644 index d2c91db82b..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Start-AzureRmRecoveryServicesAsrResynchronizeReplicationJob.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/start-azurermrecoveryservicesasrresynchronizereplicationjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Start-AzureRmRecoveryServicesAsrResynchronizeReplicationJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Start-AzureRmRecoveryServicesAsrResynchronizeReplicationJob.md ---- - -# Start-AzureRmRecoveryServicesAsrResynchronizeReplicationJob - -## SYNOPSIS -Starts replication resynchronization. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Default (Default) -``` -Start-AzureRmRecoveryServicesAsrResynchronizeReplicationJob - -ReplicationProtectedItem <ASRReplicationProtectedItem> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Start-AzureRmRecoveryServicesAsrResynchronizeReplicationJob -ResourceId <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Start-AzureRmRecoveryServicesAsrResynchronizeReplicationJob** cmdlet start resynchronization of replication for the specified protected item if the protected is in a resynchronization required state. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Start-AzureRmRecoveryServicesAsrResynchronizeReplicationJob -ReplicationProtectedItem $rpi -``` - -Starts job to resynchronize replication on passed replication protected item. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationProtectedItem -ASR replication protected item to resynchronize replication for. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem -Parameter Sets: Default -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceId -Resource Id of replication protected item to resynchronize. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Start-AzureRmRecoveryServicesAsrSwitchProcessServerJob.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Start-AzureRmRecoveryServicesAsrSwitchProcessServerJob.md deleted file mode 100644 index 07536a68cf..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Start-AzureRmRecoveryServicesAsrSwitchProcessServerJob.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/start-azurermrecoveryservicesasrswitchprocessserverjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Start-AzureRmRecoveryServicesAsrSwitchProcessServerJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Start-AzureRmRecoveryServicesAsrSwitchProcessServerJob.md ---- - -# Start-AzureRmRecoveryServicesAsrSwitchProcessServerJob - -## SYNOPSIS -Switch replication from one Process server to another for load balancing. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Start-AzureRmRecoveryServicesAsrSwitchProcessServerJob -Fabric <ASRFabric> - -SourceProcessServer <ASRProcessServer> -TargetProcessServer <ASRProcessServer> - [-ReplicationProtectedItem <ASRReplicationProtectedItem[]>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Start-AzureRmRecoveryServicesAsrSwitchProcessServerJob** switches replication data movement for the specified virtual machines or a specified Process server to the specified target Process server. Used for load balancing or switching replication between Process servers. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Start-AzureRmRecoveryServicesAsrSwitchProcessServerJob -Fabric $fabric -SourceProcessServer $sourceProcessServer -TargetProcessServer $TargetProcessServer -``` - -Job to track switching process server for all replication protected item from source to target process server. - -### Example 2 -``` -PS C:\> Start-AzureRmRecoveryServicesAsrSwitchProcessServerJob -Fabric $fabric -SourceProcessServer $sourceProcessServer -TargetProcessServer $TargetProcessServer -ReplicatedItem $rpList -``` - -Job to track switching process server for passed replication protected item from source to target process server. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fabric -Site recovery fabric corresponding to the Configuration Server. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRFabric -Parameter Sets: (All) -Aliases: ConfigServer - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationProtectedItem -List of replication protected item whose process server to be switched. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem[] -Parameter Sets: (All) -Aliases: ReplicatedItem - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceProcessServer -The Process server to switch replication out from. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProcessServer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetProcessServer -The Process server to switch replication to. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProcessServer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Start-AzureRmRecoveryServicesAsrTestFailoverCleanupJob.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Start-AzureRmRecoveryServicesAsrTestFailoverCleanupJob.md deleted file mode 100644 index c289dd18b8..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Start-AzureRmRecoveryServicesAsrTestFailoverCleanupJob.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/start-azurermrecoveryservicesasrtestfailovercleanupjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Start-AzureRmRecoveryServicesAsrTestFailoverCleanupJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Start-AzureRmRecoveryServicesAsrTestFailoverCleanupJob.md ---- - -# Start-AzureRmRecoveryServicesAsrTestFailoverCleanupJob - -## SYNOPSIS -Starts the test failover cleanup operation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByRPIObject (Default) -``` -Start-AzureRmRecoveryServicesAsrTestFailoverCleanupJob -ReplicationProtectedItem <ASRReplicationProtectedItem> - [-Comment <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Start-AzureRmRecoveryServicesAsrTestFailoverCleanupJob -ResourceId <String> [-Comment <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByRPObject -``` -Start-AzureRmRecoveryServicesAsrTestFailoverCleanupJob -RecoveryPlan <ASRRecoveryPlan> [-Comment <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Start-AzureRmRecoveryServicesAsrTestFailoverCleanupJob** cmdlet starts the test failover cleanup operation on a replication protected item or recovery plan on which a test failover has been performed. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Start-AzureRmRecoveryServicesAsrTestFailoverCleanupJob -ReplicationProtectedItem $rpi -Comments "testing done" -``` - -Job to track test failover Cleanup of an Azure Site Recovery replication protected item. - -### Example 2 -``` -PS C:\> Start-AzureRmRecoveryServicesAsrTestFailoverCleanupJob -RecoveryPlan $recoveryPlan -Comment "testing done" -``` - -Job to track test failover Cleanup of an Azure Site Recovery recoveryPlan. - -## PARAMETERS - -### -Comment -User Comment for Test Failover. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryPlan -Recovery Plan to perform the test failover cleanup on. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan -Parameter Sets: ByRPObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ReplicationProtectedItem -Replication Protected Item to perform the test failover cleanup on. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem -Parameter Sets: ByRPIObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceId -Resource Id of replication protected item / recovery plan for cleaningup test failover. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan -Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Start-AzureRmRecoveryServicesAsrTestFailoverJob.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Start-AzureRmRecoveryServicesAsrTestFailoverJob.md deleted file mode 100644 index 4709047a48..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Start-AzureRmRecoveryServicesAsrTestFailoverJob.md +++ /dev/null @@ -1,301 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/start-azurermrecoveryservicesasrtestfailoverjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Start-AzureRmRecoveryServicesAsrTestFailoverJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Start-AzureRmRecoveryServicesAsrTestFailoverJob.md ---- - -# Start-AzureRmRecoveryServicesAsrTestFailoverJob - -## SYNOPSIS -Starts a test failover operation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByRPIObject (Default) -``` -Start-AzureRmRecoveryServicesAsrTestFailoverJob -ReplicationProtectedItem <ASRReplicationProtectedItem> - -Direction <String> [-CloudServiceCreationOption <String>] [-DataEncryptionPrimaryCertFile <String>] - [-DataEncryptionSecondaryCertFile <String>] [-RecoveryPoint <ASRRecoveryPoint>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByRPObject -``` -Start-AzureRmRecoveryServicesAsrTestFailoverJob -RecoveryPlan <ASRRecoveryPlan> -Direction <String> - [-CloudServiceCreationOption <String>] [-DataEncryptionPrimaryCertFile <String>] - [-DataEncryptionSecondaryCertFile <String>] [-RecoveryTag <String>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByRPObjectWithVMNetwork -``` -Start-AzureRmRecoveryServicesAsrTestFailoverJob -RecoveryPlan <ASRRecoveryPlan> -Direction <String> - -VMNetwork <ASRNetwork> [-DataEncryptionPrimaryCertFile <String>] [-DataEncryptionSecondaryCertFile <String>] - [-RecoveryTag <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByRPObjectWithAzureVMNetworkId -``` -Start-AzureRmRecoveryServicesAsrTestFailoverJob -RecoveryPlan <ASRRecoveryPlan> -Direction <String> - -AzureVMNetworkId <String> [-CloudServiceCreationOption <String>] [-DataEncryptionPrimaryCertFile <String>] - [-DataEncryptionSecondaryCertFile <String>] [-RecoveryTag <String>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByRPIObjectWithVMNetwork -``` -Start-AzureRmRecoveryServicesAsrTestFailoverJob -ReplicationProtectedItem <ASRReplicationProtectedItem> - -Direction <String> -VMNetwork <ASRNetwork> [-DataEncryptionPrimaryCertFile <String>] - [-DataEncryptionSecondaryCertFile <String>] [-RecoveryPoint <ASRRecoveryPoint>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByRPIObjectWithAzureVMNetworkId -``` -Start-AzureRmRecoveryServicesAsrTestFailoverJob -ReplicationProtectedItem <ASRReplicationProtectedItem> - -Direction <String> -AzureVMNetworkId <String> [-CloudServiceCreationOption <String>] - [-DataEncryptionPrimaryCertFile <String>] [-DataEncryptionSecondaryCertFile <String>] - [-RecoveryPoint <ASRRecoveryPoint>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Start-AzureRmRecoveryServicesAsrTestFailoverJob** cmdlet starts test failover of an Azure Site Recovery replication protected item or recovery plan. -You can check whether the job succeeded by using the Get-AzureRmRecoveryServicesAsrJob cmdlet. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $currentJob = Start-AzureRmRecoveryServicesAsrTestFailoverJob -RecoveryPlan $RP -Direction PrimaryToRecovery -VMNetwork $TestRecoveryNetwork -``` - -Starts the test failover operation for the recovery plan with the specified parameters and returns the ASR job used to track the operation. - -## PARAMETERS - -### -AzureVMNetworkId -Specifies the Azure virtual network ID to connect the test fail over virtual machine(s) to. - -```yaml -Type: System.String -Parameter Sets: ByRPObjectWithAzureVMNetworkId, ByRPIObjectWithAzureVMNetworkId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CloudServiceCreationOption -Specifies whether a new cloud service should be created or the recovery cloud service configured for the VM should be used for the test failover. - -```yaml -Type: System.String -Parameter Sets: ByRPIObject, ByRPObject, ByRPObjectWithAzureVMNetworkId, ByRPIObjectWithAzureVMNetworkId -Aliases: -Accepted values: UseRecoveryCloudService, AutoCreateCloudService - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataEncryptionPrimaryCertFile -Specifies the primary certificate file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataEncryptionSecondaryCertFile -Specifies the secondary certificate file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Direction -Specifies the failover direction. -The acceptable values for this parameter are: - -- PrimaryToRecovery -- RecoveryToPrimary - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: PrimaryToRecovery, RecoveryToPrimary - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryPlan -Specifies an ASR recovery plan object. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan -Parameter Sets: ByRPObject, ByRPObjectWithVMNetwork, ByRPObjectWithAzureVMNetworkId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RecoveryPoint -Specifies a custom recovery point to test failover the protected machine to. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPoint -Parameter Sets: ByRPIObject, ByRPIObjectWithVMNetwork, ByRPIObjectWithAzureVMNetworkId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryTag -Specifies the recovery tag to test failover to - -```yaml -Type: System.String -Parameter Sets: ByRPObject, ByRPObjectWithVMNetwork, ByRPObjectWithAzureVMNetworkId -Aliases: -Accepted values: Latest, LatestAvailable, LatestAvailableApplicationConsistent - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationProtectedItem -Specifies an ASR replication protected item. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem -Parameter Sets: ByRPIObject, ByRPIObjectWithVMNetwork, ByRPIObjectWithAzureVMNetworkId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMNetwork -Specifies the Site Recovery virtual machine network to connect the test failover virtual machine(s) to. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRNetwork -Parameter Sets: ByRPObjectWithVMNetwork, ByRPIObjectWithVMNetwork -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan -Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesAsrJob](./Get-AzureRmRecoveryServicesAsrJob.md) diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Start-AzureRmRecoveryServicesAsrUnplannedFailoverJob.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Start-AzureRmRecoveryServicesAsrUnplannedFailoverJob.md deleted file mode 100644 index b8b6e48af7..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Start-AzureRmRecoveryServicesAsrUnplannedFailoverJob.md +++ /dev/null @@ -1,259 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/start-azurermrecoveryservicesasrunplannedfailoverjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Start-AzureRmRecoveryServicesAsrUnplannedFailoverJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Start-AzureRmRecoveryServicesAsrUnplannedFailoverJob.md ---- - -# Start-AzureRmRecoveryServicesAsrUnplannedFailoverJob - -## SYNOPSIS -Starts a unplanned failover operation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByRPIObject (Default) -``` -Start-AzureRmRecoveryServicesAsrUnplannedFailoverJob -ReplicationProtectedItem <ASRReplicationProtectedItem> - -Direction <String> [-PerformSourceSideAction] [-DataEncryptionPrimaryCertFile <String>] - [-DataEncryptionSecondaryCertFile <String>] [-RecoveryPoint <ASRRecoveryPoint>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByRPObject -``` -Start-AzureRmRecoveryServicesAsrUnplannedFailoverJob -RecoveryPlan <ASRRecoveryPlan> -Direction <String> - [-PerformSourceSideAction] [-DataEncryptionPrimaryCertFile <String>] - [-DataEncryptionSecondaryCertFile <String>] [-RecoveryTag <String>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByRPIObjectWithRecoveryTag -``` -Start-AzureRmRecoveryServicesAsrUnplannedFailoverJob -ReplicationProtectedItem <ASRReplicationProtectedItem> - -Direction <String> [-PerformSourceSideAction] [-DataEncryptionPrimaryCertFile <String>] - [-DataEncryptionSecondaryCertFile <String>] -RecoveryTag <String> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Start-AzureRmRecoveryServicesAsrTestFailoverJob** cmdlet starts test failover of an Azure Site Recovery replication protected item or recovery plan. -You can check whether the job succeeded by using the Get-AzureRmRecoveryServicesAsrJob cmdlet. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $currentJob = Start-AzureRmRecoveryServicesAsrTestFailoverJob -RecoveryPlan $RP -Direction PrimaryToRecovery -VMNetwork $TestRecoveryNetwork -``` - -Starts the test failover operation for the recovery plan with the specified parameters and returns the ASR job used to track the operation. - -## PARAMETERS - -### -DataEncryptionPrimaryCertFile -Specifies the data encryption primary certificate file path for failover of Protected Item. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataEncryptionSecondaryCertFile -Specifies the data encryption secondary certificate file path for failover of Protected Item. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Direction -Specifies the failover direction. -The acceptable values for this parameter are: - -- PrimaryToRecovery -- RecoveryToPrimary - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: PrimaryToRecovery, RecoveryToPrimary - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PerformSourceSideAction -Perform operation in source side before starting unplanned failover. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: PerformSourceSideActions - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryPlan -Specifies an ASR recovery plan object. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan -Parameter Sets: ByRPObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RecoveryPoint -Specifies a custom recovery point to failover the protected machine to. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPoint -Parameter Sets: ByRPIObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryTag -Specifies the recovery tag to failover to. - -```yaml -Type: System.String -Parameter Sets: ByRPObject -Aliases: -Accepted values: Latest, LatestAvailable, LatestAvailableApplicationConsistent, LatestAvailableCrashConsistent, Latest, LatestAvailable, LatestAvailableApplicationConsistent, LatestAvailableCrashConsistent - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ByRPIObjectWithRecoveryTag -Aliases: -Accepted values: Latest, LatestAvailable, LatestAvailableApplicationConsistent, LatestAvailableCrashConsistent, Latest, LatestAvailable, LatestAvailableApplicationConsistent, LatestAvailableCrashConsistent - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationProtectedItem -Specifies an azure site recovery replication protected item. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem -Parameter Sets: ByRPIObject, ByRPIObjectWithRecoveryTag -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan -Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesAsrJob](./Get-AzureRmRecoveryServicesAsrJob.md) diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Stop-AzureRmRecoveryServicesAsrJob.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Stop-AzureRmRecoveryServicesAsrJob.md deleted file mode 100644 index 854bb45922..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Stop-AzureRmRecoveryServicesAsrJob.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/stop-azurermrecoveryservicesasrjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Stop-AzureRmRecoveryServicesAsrJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Stop-AzureRmRecoveryServicesAsrJob.md ---- - -# Stop-AzureRmRecoveryServicesAsrJob - -## SYNOPSIS -Stops an Azure Site Recovery job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByObject (Default) -``` -Stop-AzureRmRecoveryServicesAsrJob -InputObject <ASRJob> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ByName -``` -Stop-AzureRmRecoveryServicesAsrJob -Name <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Stop-AzureRmRecoveryServicesAsrJob** cmdlet stops the specified Azure Site Recovery job. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $currentJob = Stop-AzureRmRecoveryServicesAsrJob -Job $Job -``` - -Attempts to stop the specified job and returns an updated ASR job object. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Input Object: Specify the ASR job object corresponding to the ASR job to be stopped - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob -Parameter Sets: ByObject -Aliases: Job - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specify the ASR Job to be stopped by the ASR job name. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesAsrJob](./Get-AzureRmRecoveryServicesAsrJob.md) - -[Restart-AzureRmRecoveryServicesAsrJob](./Restart-AzureRmRecoveryServicesAsrJob.md) - -[Resume-AzureRmRecoveryServicesAsrJob](./Resume-AzureRmRecoveryServicesAsrJob.md) diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Update-AzureRmRecoveryServicesAsrMobilityService.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Update-AzureRmRecoveryServicesAsrMobilityService.md deleted file mode 100644 index c869f0f5f3..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Update-AzureRmRecoveryServicesAsrMobilityService.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/update-azurermrecoveryservicesasrmobilityservice -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Update-AzureRmRecoveryServicesAsrMobilityService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Update-AzureRmRecoveryServicesAsrMobilityService.md ---- - -# Update-AzureRmRecoveryServicesAsrMobilityService - -## SYNOPSIS -Push mobility service agent updates to protected machines. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Update-AzureRmRecoveryServicesAsrMobilityService [-Account <ASRRunAsAccount>] - -ReplicationProtectedItem <ASRReplicationProtectedItem> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureRmRecoveryServicesAsrMobilityService** cmdlet attempts to push mobility service agent updates to protected machines(if an update is available.) - -## EXAMPLES - -### Example 1 -``` -PS C:\> Update-AzureRmRecoveryServicesAsrMobilityService -ReplicationProtectedItem $rpi -Account $fabric.fabricSpecificDetails.RunAsAccounts[0] -``` - -Job to track Update Replication Protected Item's Moblility Service Agent. - -## PARAMETERS - -### -Account -The run as account ID to be used to push the update. Must be one from the list of run as accounts in the ASR fabric corresponding to machine being updated. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRunAsAccount -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationProtectedItem -Azure Site Recovery replication protected item to be updated. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Update-AzureRmRecoveryServicesAsrNetworkMapping.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Update-AzureRmRecoveryServicesAsrNetworkMapping.md deleted file mode 100644 index 5c209edb14..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Update-AzureRmRecoveryServicesAsrNetworkMapping.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/update-azurermrecoveryservicesasrnetworkmapping -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Update-AzureRmRecoveryServicesAsrNetworkMapping.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Update-AzureRmRecoveryServicesAsrNetworkMapping.md ---- - -# Update-AzureRmRecoveryServicesAsrNetworkMapping - -## SYNOPSIS -Updates the specified azure site recovery network mapping. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByNetworkObject (Default) -``` -Update-AzureRmRecoveryServicesAsrNetworkMapping -InputObject <ASRNetworkMapping> -RecoveryNetwork <ASRNetwork> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ById -``` -Update-AzureRmRecoveryServicesAsrNetworkMapping -InputObject <ASRNetworkMapping> - -RecoveryAzureNetworkId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureRmRecoveryServicesAsrNetworkMapping** cmdlet updates the specified Azure Site Recovery network mapping. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $currentJob = Update-AzureRmRecoveryServicesAsrNetworkMapping -Mapping $NetworkMapping -RecoveryNetwork $RecoveryNetwork -``` - -Starts the update network mapping operation using the specified parameters and returns the ASR job used to track the operation. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Input Object: Specifies the ASR network mapping object corresponding to the ASR network mapping to be updated. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRNetworkMapping -Parameter Sets: (All) -Aliases: NetworkMapping - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RecoveryAzureNetworkId -Specifies the recovery azure network ID for the network mapping. - -```yaml -Type: System.String -Parameter Sets: ById -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryNetwork -Specifies the recovery network object for the network mapping. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRNetwork -Parameter Sets: ByNetworkObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Update-AzureRmRecoveryServicesAsrPolicy.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Update-AzureRmRecoveryServicesAsrPolicy.md deleted file mode 100644 index 82ac60da69..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Update-AzureRmRecoveryServicesAsrPolicy.md +++ /dev/null @@ -1,472 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/update-azurermrecoveryservicesasrpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Update-AzureRmRecoveryServicesAsrPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Update-AzureRmRecoveryServicesAsrPolicy.md ---- - -# Update-AzureRmRecoveryServicesAsrPolicy - -## SYNOPSIS -Updates an Azure Site Recovery replication policy. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Default (Default) -``` -Update-AzureRmRecoveryServicesAsrPolicy -InputObject <ASRPolicy> [-ReplicationMethod <String>] - [-ReplicationFrequencyInSeconds <String>] [-NumberOfRecoveryPointsToRetain <Int32>] - [-ApplicationConsistentSnapshotFrequencyInHours <Int32>] [-Compression <String>] [-ReplicationPort <UInt16>] - [-Authentication <String>] [-ReplicationStartTime <TimeSpan>] [-ReplicaDeletion <String>] - [-RecoveryAzureStorageAccountId <String>] [-Encryption <String>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### VMwareToAzure -``` -Update-AzureRmRecoveryServicesAsrPolicy [-VMwareToAzure] -InputObject <ASRPolicy> - [-RecoveryPointRetentionInHours <Int32>] [-ApplicationConsistentSnapshotFrequencyInHours <Int32>] - [-MultiVmSyncStatus <String>] [-RPOWarningThresholdInMinutes <Int32>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### AzureToAzure -``` -Update-AzureRmRecoveryServicesAsrPolicy [-AzureToAzure] -InputObject <ASRPolicy> - [-RecoveryPointRetentionInHours <Int32>] [-ApplicationConsistentSnapshotFrequencyInHours <Int32>] - [-MultiVmSyncStatus <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### AzureToVMware -``` -Update-AzureRmRecoveryServicesAsrPolicy [-AzureToVMware] -InputObject <ASRPolicy> - [-RecoveryPointRetentionInHours <Int32>] [-ApplicationConsistentSnapshotFrequencyInHours <Int32>] - [-MultiVmSyncStatus <String>] [-RPOWarningThresholdInMinutes <Int32>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### HyperVToAzure -``` -Update-AzureRmRecoveryServicesAsrPolicy [-HyperVToAzure] -InputObject <ASRPolicy> - [-ReplicationFrequencyInSeconds <String>] [-NumberOfRecoveryPointsToRetain <Int32>] - [-ApplicationConsistentSnapshotFrequencyInHours <Int32>] [-ReplicationStartTime <TimeSpan>] - [-RecoveryAzureStorageAccountId <String>] [-Encryption <String>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### EnterpriseToEnterprise -``` -Update-AzureRmRecoveryServicesAsrPolicy [-VmmToVmm] -InputObject <ASRPolicy> [-ReplicationMethod <String>] - [-ReplicationFrequencyInSeconds <String>] [-NumberOfRecoveryPointsToRetain <Int32>] - [-ApplicationConsistentSnapshotFrequencyInHours <Int32>] [-Compression <String>] [-ReplicationPort <UInt16>] - [-Authentication <String>] [-ReplicationStartTime <TimeSpan>] [-ReplicaDeletion <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureRmRecoveryServicesAsrPolicy** cmdlet updates the specified Azure Site Recovery replication policy. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $currentJob = Update-AzureRmRecoveryServicesAsrPolicy -Policy $Policy -ReplicationFrequencyInSeconds 900 -``` - -Starts the update replication policy operation using the specified parameters and returns the ASR job used to track the operation. - -### Example 2 -``` -PS C:\> Update-AzureRmRecoveryServicesAsrPolicy -AzureToAzure -InputObject $Policy -ReplicationFrequencyInSeconds 900 -``` - -Starts the update azure to azure replication policy operation using the specified parameters and returns the ASR job used to track the operation. - -### Example 3 -``` -PS C:\> $currentJob = Update-AzureRmRecoveryServicesAsrPolicy -AzureToAzure -InputObject $Policy -RecoveryPointRetentionInHours 20 -``` - -Starts the update azure to azure replication policy using the specified parameters and returns the ASR job used to track the operation. - -## PARAMETERS - -### -ApplicationConsistentSnapshotFrequencyInHours -Specifies the frequency(in hours) at which to create application consistent recovery points. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Authentication -Specifies the type of authentication used. - -```yaml -Type: System.String -Parameter Sets: Default, EnterpriseToEnterprise -Aliases: -Accepted values: Certificate, Kerberos - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AzureToAzure -Switch parameter specifying that the replication policy used to replicate Azure virtual machines between two Azure regions will be updated. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: AzureToAzure -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AzureToVMware -Switch parameter indicating that the specfied policy is used to replicate failed over virtual machines running in Azure back to an on-premises VMware site. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: AzureToVMware -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Compression -Specifies if compression should be enabled. - -```yaml -Type: System.String -Parameter Sets: Default, EnterpriseToEnterprise -Aliases: -Accepted values: Enable, Disable - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Encryption -{{Fill Encryption Description}} - -```yaml -Type: System.String -Parameter Sets: Default, HyperVToAzure -Aliases: -Accepted values: Enable, Disable - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HyperVToAzure -Switch parameter indicating that the specfied policy is used to replicate Hyper-V virtual machines to Azure. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: HyperVToAzure -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Input object for the cmdlet: Specifies the ASR replication policy object corresponding to the replication policy to be updated. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRPolicy -Parameter Sets: (All) -Aliases: Policy - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -MultiVmSyncStatus -Specifies multiVm sync status for the policy. - -```yaml -Type: System.String -Parameter Sets: VMwareToAzure, AzureToAzure, AzureToVMware -Aliases: -Accepted values: Enable, Disable - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumberOfRecoveryPointsToRetain -Specifies the number recovery points to retain. - -```yaml -Type: System.Int32 -Parameter Sets: Default, HyperVToAzure, EnterpriseToEnterprise -Aliases: RecoveryPoints - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryAzureStorageAccountId -Specifies the Azure storage account ID of the replication target. Used as the target storage account for replication if an alternate is not provided while enabling replication using the New-AzureRmRecoveryServicesASRReplicationProtectedItem cmdlet. - - -```yaml -Type: System.String -Parameter Sets: Default, HyperVToAzure -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryPointRetentionInHours -Time in hours to retain recovery points after creation. - -```yaml -Type: System.Int32 -Parameter Sets: VMwareToAzure, AzureToAzure, AzureToVMware -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicaDeletion -Specifies if the replica virtual machine should be deleted on disabling replication from a VMM managed site to another. - -```yaml -Type: System.String -Parameter Sets: Default, EnterpriseToEnterprise -Aliases: -Accepted values: Required, NotRequired - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationFrequencyInSeconds -Specifies the replication frequency interval in seconds. -Valid values are: - -- 30 -- 300 -- 900 - -```yaml -Type: System.String -Parameter Sets: Default, HyperVToAzure, EnterpriseToEnterprise -Aliases: -Accepted values: 30, 300, 900 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationMethod -Specifies the replication method. - -```yaml -Type: System.String -Parameter Sets: Default, EnterpriseToEnterprise -Aliases: -Accepted values: Online, Offline - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationPort -Specifies the port used for replication. - -```yaml -Type: System.UInt16 -Parameter Sets: Default, EnterpriseToEnterprise -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationStartTime -Specifies the replication start time. -It must be no later than 24-hours from the start of the job. - -```yaml -Type: System.Nullable`1[System.TimeSpan] -Parameter Sets: Default, HyperVToAzure, EnterpriseToEnterprise -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RPOWarningThresholdInMinutes -The RPO threshold value in minutes to warn on. - -```yaml -Type: System.Int32 -Parameter Sets: VMwareToAzure, AzureToVMware -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VmmToVmm -Switch parameter indicating that the specfied policy is used to replicate VMM managed Hyper-V virtual machines between two Hyper-V sites. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: EnterpriseToEnterprise -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMwareToAzure -Switch parameter indicating that the specfied policy is used to replicate VMware virtual machines to Azure. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: VMwareToAzure -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRPolicy - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Update-AzureRmRecoveryServicesAsrProtectionDirection.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Update-AzureRmRecoveryServicesAsrProtectionDirection.md deleted file mode 100644 index 274e79a0a9..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Update-AzureRmRecoveryServicesAsrProtectionDirection.md +++ /dev/null @@ -1,525 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/update-azurermrecoveryservicesasrprotectiondirection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Update-AzureRmRecoveryServicesAsrProtectionDirection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Update-AzureRmRecoveryServicesAsrProtectionDirection.md ---- - -# Update-AzureRmRecoveryServicesAsrProtectionDirection - -## SYNOPSIS -Updates the replication direction for the specified replication protected item or recovery plan. Used to re-protect/reverse replicate a failed over replicated item or recovery plan. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByRPIObject (Default) -``` -Update-AzureRmRecoveryServicesAsrProtectionDirection -ReplicationProtectedItem <ASRReplicationProtectedItem> - -Direction <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### AzureToVMware -``` -Update-AzureRmRecoveryServicesAsrProtectionDirection [-AzureToVMware] [-Account <ASRRunAsAccount>] - -DataStore <ASRDataStore> [-MasterTarget <ASRMasterTargetServer>] -ProcessServer <ASRProcessServer> - -ProtectionContainerMapping <ASRProtectionContainerMapping> - -ReplicationProtectedItem <ASRReplicationProtectedItem> -Direction <String> - -RetentionVolume <ASRRetentionVolume> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### VMwareToAzure -``` -Update-AzureRmRecoveryServicesAsrProtectionDirection [-VMwareToAzure] -Account <ASRRunAsAccount> - [-MasterTarget <ASRMasterTargetServer>] -ProcessServer <ASRProcessServer> - -ProtectionContainerMapping <ASRProtectionContainerMapping> [-LogStorageAccountId <String>] - [-RecoveryAzureStorageAccountId <String>] -ReplicationProtectedItem <ASRReplicationProtectedItem> - -Direction <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### HyperVToAzure -``` -Update-AzureRmRecoveryServicesAsrProtectionDirection [-HyperVToAzure] [-LogStorageAccountId <String>] - [-RecoveryAzureStorageAccountId <String>] -ReplicationProtectedItem <ASRReplicationProtectedItem> - -Direction <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### EnterpriseToEnterprise -``` -Update-AzureRmRecoveryServicesAsrProtectionDirection [-VmmToVmm] - -ReplicationProtectedItem <ASRReplicationProtectedItem> -Direction <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### AzureToAzure -``` -Update-AzureRmRecoveryServicesAsrProtectionDirection [-AzureToAzure] - -ProtectionContainerMapping <ASRProtectionContainerMapping> -LogStorageAccountId <String> - [-RecoveryAzureStorageAccountId <String>] -ReplicationProtectedItem <ASRReplicationProtectedItem> - [-RecoveryResourceGroupId <String>] [-RecoveryCloudServiceId <String>] [-RecoveryAvailabilitySetId <String>] - [-RecoveryBootDiagStorageAccountId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### AzureToAzureWithMultipleStorageAccount -``` -Update-AzureRmRecoveryServicesAsrProtectionDirection [-AzureToAzure] - -ProtectionContainerMapping <ASRProtectionContainerMapping> - -AzureToAzureDiskReplicationConfiguration <ASRAzuretoAzureDiskReplicationConfig[]> - -ReplicationProtectedItem <ASRReplicationProtectedItem> [-RecoveryResourceGroupId <String>] - [-RecoveryCloudServiceId <String>] [-RecoveryAvailabilitySetId <String>] - [-RecoveryBootDiagStorageAccountId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByRPObject -``` -Update-AzureRmRecoveryServicesAsrProtectionDirection -RecoveryPlan <ASRRecoveryPlan> -Direction <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByPEObject -``` -Update-AzureRmRecoveryServicesAsrProtectionDirection -Direction <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureRmRecoveryServicesAsrProtectionDirection** cmdlet updates the replication direction for the specified Azure Site Recovery object after the completion of a commit failover operation. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $currentJob = Update-AzureRmRecoveryServicesAsrProtectionDirection -RecoveryPlan $RP -Direction PrimaryToRecovery -``` - -Start the update direction operation for the specified recovery plan and returns the ASR job object used to track the operation. - -### Example 2 -``` -PS C:\> $currentJob = Update-AzureRmRecoveryServicesAsrProtectionDirection -AzureToAzure -ProtectionContainerMapping $B2ApcmMapping -LogStorageAccountId $cacheStorageId ` - -ReplicationProtectedItem $rpi -``` - -Start the update direction operation for the specified replication protected item in target azure region defined by protection container mapping and using cache storage (in same region as VM). - -### Example 3 -``` -PS C:\> $currentJob = Update-AzureRmRecoveryServicesAsrProtectionDirection -AzureToAzure -ProtectionContainerMapping $B2ApcmMapping ` - -AzureToAzureDiskReplicationConfiguration $disk1,$disk2 -ReplicationProtectedItem $rpi -``` - -Start the update direction operation for the specified replication protected item in target azure region defined by protection container mapping and provided disk replication configuration. - -## PARAMETERS - -### -Account -The run as account to be used to push install the Mobility service if needed. Must be one from the list of run as accounts in the ASR fabric. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRunAsAccount -Parameter Sets: AzureToVMware -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRunAsAccount -Parameter Sets: VMwareToAzure -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AzureToAzure -Switch parameter specifying that the replication direction being updated for replicated Azure virtual machines between two Azure regions. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: AzureToAzure, AzureToAzureWithMultipleStorageAccount -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AzureToAzureDiskReplicationConfiguration -Specifies the list of virtual machine disks to replicated and the cache storage account and recovery storage account to be used to replicate the disk. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRAzuretoAzureDiskReplicationConfig[] -Parameter Sets: AzureToAzureWithMultipleStorageAccount -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AzureToVMware -Update replication direction from Azure to Vmware. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: AzureToVMware -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataStore -The VMware datastore to be used for the vmdisk's. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRDataStore -Parameter Sets: AzureToVMware -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Direction -Specifies the direction to be used for the update operation post a failover. -The acceptable values for this parameter are: - -- PrimaryToRecovery -- RecoveryToPrimary - -```yaml -Type: System.String -Parameter Sets: ByRPIObject, AzureToVMware, VMwareToAzure, HyperVToAzure, EnterpriseToEnterprise, ByRPObject, ByPEObject -Aliases: -Accepted values: PrimaryToRecovery, RecoveryToPrimary - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HyperVToAzure -Reprotect a Hyper-V virtual machine after failback. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: HyperVToAzure -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogStorageAccountId -Specifies the storage account ID to store the replication log of VMs. - -```yaml -Type: System.String -Parameter Sets: VMwareToAzure, HyperVToAzure -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: AzureToAzure -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MasterTarget -Master Target Server Details. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRMasterTargetServer -Parameter Sets: AzureToVMware, VMwareToAzure -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProcessServer -Process Server to be used for replication. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProcessServer -Parameter Sets: AzureToVMware, VMwareToAzure -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtectionContainerMapping -Protection containerMapping to be used for replication. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRProtectionContainerMapping -Parameter Sets: AzureToVMware, VMwareToAzure, AzureToAzure, AzureToAzureWithMultipleStorageAccount -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryAvailabilitySetId -The availability set that the virtual machine should be created in upon failover - -```yaml -Type: System.String -Parameter Sets: AzureToAzure, AzureToAzureWithMultipleStorageAccount -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryAzureStorageAccountId -Specifies the ID of the Azure storage account to replicate to. - -```yaml -Type: System.String -Parameter Sets: VMwareToAzure, HyperVToAzure, AzureToAzure -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryBootDiagStorageAccountId -Specifies the storage account for boot diagnostics for recovery azure VM. - -```yaml -Type: System.String -Parameter Sets: AzureToAzure, AzureToAzureWithMultipleStorageAccount -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryCloudServiceId -The resource ID of the recovery cloud service to failover this virtual machine to. - -```yaml -Type: System.String -Parameter Sets: AzureToAzure, AzureToAzureWithMultipleStorageAccount -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryPlan -Specifies an ASR recovery plan object. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan -Parameter Sets: ByRPObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RecoveryResourceGroupId -Recovery resourceGroup id for protected Vm. - -```yaml -Type: System.String -Parameter Sets: AzureToAzure, AzureToAzureWithMultipleStorageAccount -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationProtectedItem -Specifies an ASR replication protected item. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem -Parameter Sets: ByRPIObject, AzureToVMware, VMwareToAzure, HyperVToAzure, EnterpriseToEnterprise, AzureToAzure, AzureToAzureWithMultipleStorageAccount -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RetentionVolume -Retention Volume on the master target server to be used. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRetentionVolume -Parameter Sets: AzureToVMware -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VmmToVmm -Update replication direction for a failed over Hyper-V virtual machine that is protected between two VMM managed Hyper-V sites. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: EnterpriseToEnterprise -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMwareToAzure -Update replication direction from VMware to Azure. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: VMwareToAzure -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan -Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Update-AzureRmRecoveryServicesAsrRecoveryPlan.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Update-AzureRmRecoveryServicesAsrRecoveryPlan.md deleted file mode 100644 index 4c35f6b75c..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Update-AzureRmRecoveryServicesAsrRecoveryPlan.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/update-azurermrecoveryservicesasrrecoveryplan -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Update-AzureRmRecoveryServicesAsrRecoveryPlan.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Update-AzureRmRecoveryServicesAsrRecoveryPlan.md ---- - -# Update-AzureRmRecoveryServicesAsrRecoveryPlan - -## SYNOPSIS -Updates the contents of an Azure Site recovery plan. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByRPObject (Default) -``` -Update-AzureRmRecoveryServicesAsrRecoveryPlan -InputObject <ASRRecoveryPlan> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByRPFile -``` -Update-AzureRmRecoveryServicesAsrRecoveryPlan -Path <String> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureRmRecoveryServicesAsrRecoveryPlan** cmdlet updates the contents of a recovery plan using the contents of the specified ASR recovery plan object or ASR recovery plan definition json file. - -## EXAMPLES - -### Example 1: Update a recovery plan -``` -PS C:\> $currentJob = Update-AzureRmRecoveryServicesAsrRecoveryPlan -RecoveryPlan $RP -``` - -Start the operation of updating a recovery plan using the contents of the specified ASR recovery plan object and returns the ASR job used to track the operation. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Input Object to the cmdlet: Specifies an ASR recovery plan object, the contents of which are used to update the recovery plan referred to by the object. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan -Parameter Sets: ByRPObject -Aliases: RecoveryPlan - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Path -Specifies the path of the recovery plan definition json file used to update the recovery plan. - -```yaml -Type: System.String -Parameter Sets: ByRPFile -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesAsrRecoveryPlan](./Get-AzureRmRecoveryServicesAsrRecoveryPlan.md) - -[New-AzureRmRecoveryServicesAsrRecoveryPlan](./New-AzureRmRecoveryServicesAsrRecoveryPlan.md) - -[Remove-AzureRmRecoveryServicesAsrRecoveryPlan](./Remove-AzureRmRecoveryServicesAsrRecoveryPlan.md) diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Update-AzureRmRecoveryServicesAsrServicesProvider.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Update-AzureRmRecoveryServicesAsrServicesProvider.md deleted file mode 100644 index 530ff9f516..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Update-AzureRmRecoveryServicesAsrServicesProvider.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/update-azurermrecoveryservicesasrservicesprovider -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Update-AzureRmRecoveryServicesAsrServicesProvider.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Update-AzureRmRecoveryServicesAsrServicesProvider.md ---- - -# Update-AzureRmRecoveryServicesAsrServicesProvider - -## SYNOPSIS -Refreshes (Refresh server) the information received from the Azure Site Recovery Services Provider. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Update-AzureRmRecoveryServicesAsrServicesProvider -InputObject <ASRRecoveryServicesProvider> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureRmRecoveryServicesAsrServicesProvider** cmdlet updates the information received from the Azure Site Recovery Services Provider. You can use this cmdlet to trigger a refresh of the information received from the Recovery Services Provider. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $currentJob = Update-AzureRmRecoveryServicesAsrServicesProvider -InputObject $ServicesProvider -``` - -Starts the operation of refreshing the information from the specified ASR services provider and returns the ASR job used to track the operation. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the ASR services provider object that identifies the server for which information is to updated(refreshed.) - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryServicesProvider -Parameter Sets: (All) -Aliases: ServicesProvider - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryServicesProvider - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesAsrServicesProvider](./Get-AzureRmRecoveryServicesAsrServicesProvider.md) - -[Remove-AzureRmRecoveryServicesAsrServicesProvider](./Remove-AzureRmRecoveryServicesAsrServicesProvider.md) diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Update-AzureRmRecoveryServicesAsrVCenter.md b/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Update-AzureRmRecoveryServicesAsrVCenter.md deleted file mode 100644 index 529e484630..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices.SiteRecovery/Update-AzureRmRecoveryServicesAsrVCenter.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml -Module Name: AzureRM.RecoveryServices.SiteRecovery -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.siterecovery/update-azurermrecoveryservicesasrvcenter -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Update-AzureRmRecoveryServicesAsrVCenter.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices.SiteRecovery/help/Update-AzureRmRecoveryServicesAsrVCenter.md ---- - -# Update-AzureRmRecoveryServicesAsrvCenter - -## SYNOPSIS -Update discovery details for a registered vCenter. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Default (Default) -``` -Update-AzureRmRecoveryServicesAsrvCenter -InputObject <ASRvCenter> [-Account <ASRRunAsAccount>] [-Port <Int32>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Update-AzureRmRecoveryServicesAsrvCenter -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureRmRecoveryServicesAsrvCenter** cmdlet is updates discovery details for a registered vCenter. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Update-AzureRmRecoveryServicesAsrvCenter -Account $fabric.fabricSpecificDetails.RunAsAccounts[1] -InputObject $vCenter -Returns ASRJOB for update vCenter. -``` - -Update discovery details for a registered vCenter. - -## PARAMETERS - -### -Account -vCenter login credentials account. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRunAsAccount -Parameter Sets: Default -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The vCenter server object to update discovery details for. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRvCenter -Parameter Sets: Default -Aliases: vCenter - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Port -The TCP port on the vCenter server to use for discovery. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: Default -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Specifies the resourceId of vCenter. - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRvCenter - -## OUTPUTS - -### System.Collections.Generic.IEnumerable`1[[Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob, Microsoft.Azure.Commands.RecoveryServices.SiteRecovery, Version=0.1.1.0, Culture=neutral, PublicKeyToken=null]] - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices/AzureRM.RecoveryServices.md b/azurermps-6.13.0/AzureRM.RecoveryServices/AzureRM.RecoveryServices.md deleted file mode 100644 index 3dad7f927d..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices/AzureRM.RecoveryServices.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -Module Name: AzureRM.RecoveryServices -Module Guid: 4aa53b7e-fcfe-4e22-979c-9a4e6380de58 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices -Help Version: 4.1.2.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices/help/AzureRM.RecoveryServices.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices/help/AzureRM.RecoveryServices.md ---- - -# AzureRM.RecoveryServices Module -## Description -This topic displays help topics for the Azure Recovery Services cmdlets. - -## AzureRM.RecoveryServices Cmdlets -### [Get-AzureRmRecoveryServicesBackupProperty](Get-AzureRmRecoveryServicesBackupProperty.md) -Gets Backup properties. - -### [Get-AzureRmRecoveryServicesVault](Get-AzureRmRecoveryServicesVault.md) -Gets a list of Recovery Services vaults. - -### [Get-AzureRmRecoveryServicesVaultSettingsFile](Get-AzureRmRecoveryServicesVaultSettingsFile.md) -Gets the Azure Site Recovery vault settings file. - -### [New-AzureRmRecoveryServicesVault](New-AzureRmRecoveryServicesVault.md) -Creates a new Recovery Services vault. - -### [Remove-AzureRmRecoveryServicesVault](Remove-AzureRmRecoveryServicesVault.md) -Deletes a Recovery Services vault. - -### [Set-AzureRmRecoveryServicesBackupProperties](Set-AzureRmRecoveryServicesBackupProperties.md) -Sets the properties for backup management. - -### [Set-AzureRmRecoveryServicesVaultContext](Set-AzureRmRecoveryServicesVaultContext.md) -Sets vault context. - diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices/Get-AzureRmRecoveryServicesBackupProperty.md b/azurermps-6.13.0/AzureRM.RecoveryServices/Get-AzureRmRecoveryServicesBackupProperty.md deleted file mode 100644 index 096b98090a..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices/Get-AzureRmRecoveryServicesBackupProperty.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.ARM.dll-Help.xml -Module Name: AzureRM.RecoveryServices -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices/get-azurermrecoveryservicesbackupproperty -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices/help/Get-AzureRmRecoveryServicesBackupProperty.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices/help/Get-AzureRmRecoveryServicesBackupProperty.md ---- - -# Get-AzureRmRecoveryServicesBackupProperty - -## SYNOPSIS -Gets Backup properties. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmRecoveryServicesBackupProperty -Vault <ARSVault> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRecoveryServicesBackupProperty** cmdlet gets backup properties for a Recovery Services vault. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmRecoveryServicesBackupProperty -Vault $vault -``` - -Get the backup vault property for vault. - -## PARAMETERS - -### -Vault -Specifies the name of the vault. -The vault must be an **AzureRmRecoveryServicesVault** object. - -```yaml -Type: ARSVault -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.ARSVault -Parameters: Vault (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.ASRVaultBackupProperties - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices/Get-AzureRmRecoveryServicesVault.md b/azurermps-6.13.0/AzureRM.RecoveryServices/Get-AzureRmRecoveryServicesVault.md deleted file mode 100644 index e87b6bd57f..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices/Get-AzureRmRecoveryServicesVault.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.ARM.dll-Help.xml -Module Name: AzureRM.RecoveryServices -ms.assetid: 818B5302-91EE-425F-B1CD-86B626F1B7A3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices/get-azurermrecoveryservicesvault -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices/help/Get-AzureRmRecoveryServicesVault.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices/help/Get-AzureRmRecoveryServicesVault.md ---- - -# Get-AzureRmRecoveryServicesVault - -## SYNOPSIS -Gets a list of Recovery Services vaults. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmRecoveryServicesVault [-ResourceGroupName <String>] [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRecoveryServicesVault** cmdlet gets a list of Recovery Services vaults in the current subscription. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmRecoveryServicesVault -``` - -Get the list of vault in selected subscription. - -### Example 2 -``` -PS C:\> Get-AzureRmRecoveryServicesVault -ResourceGroupName "resourceGroup" -``` - -Get the list of vault in resource group in selected subscription. - -### Example 3 -``` -PS C:\> Get-AzureRmRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName" -``` - -Get the vault in resource group with given name. - -## PARAMETERS - -### -Name -Specifies the name of the vault to query for. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the Azure resource group in which to create or from which to retrieve the specified Recovery Services object. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.ARSVault - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesVaultSettingsFile](./Get-AzureRmRecoveryServicesVaultSettingsFile.md) - -[New-AzureRmRecoveryServicesVault](./New-AzureRmRecoveryServicesVault.md) - -[Remove-AzureRmRecoveryServicesVault](./Remove-AzureRmRecoveryServicesVault.md) - - diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices/Get-AzureRmRecoveryServicesVaultSettingsFile.md b/azurermps-6.13.0/AzureRM.RecoveryServices/Get-AzureRmRecoveryServicesVaultSettingsFile.md deleted file mode 100644 index 1d4301f19a..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices/Get-AzureRmRecoveryServicesVaultSettingsFile.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.ARM.dll-Help.xml -Module Name: AzureRM.RecoveryServices -ms.assetid: 56074606-28A6-4F91-A56C-4C8A9A31543F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices/get-azurermrecoveryservicesvaultsettingsfile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices/help/Get-AzureRmRecoveryServicesVaultSettingsFile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices/help/Get-AzureRmRecoveryServicesVaultSettingsFile.md ---- - -# Get-AzureRmRecoveryServicesVaultSettingsFile - -## SYNOPSIS -Gets the Azure Site Recovery vault settings file. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ForSite -``` -Get-AzureRmRecoveryServicesVaultSettingsFile [-Vault] <ARSVault> -SiteIdentifier <String> - -SiteFriendlyName <String> [[-Path] <String>] [-SiteRecovery] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByDefault -``` -Get-AzureRmRecoveryServicesVaultSettingsFile [-Vault] <ARSVault> [[-Path] <String>] [-SiteRecovery] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ForBackupVaultType -``` -Get-AzureRmRecoveryServicesVaultSettingsFile [-Vault] <ARSVault> [[-Path] <String>] [-Backup] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRecoveryServicesVaultSettingsFile** cmdlet gets the settings file for an Azure Site Recovery vault. - -## EXAMPLES - -### Example 1: Register a Windows Server or DPM machine for Azure Backup -``` -PS C:\> $Vault01 = Get-AzureRmRecoveryServicesVault -Name "TestVault" -PS C:\> $CredsPath = "C:\Downloads" -PS C:\> $Credsfilename = Get-AzureRmRecoveryServicesVaultSettingsFile -Backup -Vault $Vault01 -Path $CredsPath -``` - -The first command gets the vault named TestVault, and then stores it in the $Vault01 variable. -The second command sets the $CredsPath variable to C:\Downloads. -The last command gets the vault credentials file for $Vault01 using the credentials in $CredsPath for Azure Backup. - -### Example 2: -``` -PS C:\> $Credsfilename = Get-AzureRmRecoveryServicesVaultSettingsFile -SiteIdentifier -Vault $Vault01 -``` - -The command gets the vault credentials file for $Vault01 of vault type siteRecovery. - -### Example 3: Register a Windows Server or DPM machine for Azure Backup -``` -PS C:\> $Credsfilename = Get-AzureRmRecoveryServicesVaultSettingsFile -SiteIdentifier -Vault $Vault01 -``` - -The command gets the vault credentials file for $Vault01. - -## PARAMETERS - -### -Backup -Indicates the vault credentials file is applicable to Azure Backup. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ForBackupVaultType -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path to the Azure Site Recovery vault settings file. -You can download this file from the Azure Site Recovery vault portal and store it locally. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteFriendlyName -Specifies the site friendly name. -Use this parameter if you are downloading the vault credentials for a Hyper-V site. - -```yaml -Type: System.String -Parameter Sets: ForSite -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteIdentifier -Specifies the site identifier. -Use this parameter if you are downloading the vault credentials for a Hyper-V site. - -```yaml -Type: System.String -Parameter Sets: ForSite -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteRecovery -Indicates the vault credentials file is applicable to Azure Site Recovery. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ForSite, ByDefault -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Vault -Specifies the Azure Site Recovery vault object. - -```yaml -Type: Microsoft.Azure.Commands.RecoveryServices.ARSVault -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.ARSVault -Parameters: Vault (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.VaultSettingsFilePath - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesVault](./Get-AzureRmRecoveryServicesVault.md) - -[New-AzureRmRecoveryServicesVault](./New-AzureRmRecoveryServicesVault.md) - -[Remove-AzureRmRecoveryServicesVault](./Remove-AzureRmRecoveryServicesVault.md) - - diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices/New-AzureRmRecoveryServicesVault.md b/azurermps-6.13.0/AzureRM.RecoveryServices/New-AzureRmRecoveryServicesVault.md deleted file mode 100644 index 6ea73c56d6..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices/New-AzureRmRecoveryServicesVault.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.ARM.dll-Help.xml -Module Name: AzureRM.RecoveryServices -ms.assetid: 9591E150-54DA-48B7-8656-3891833FE61E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices/new-azurermrecoveryservicesvault -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices/help/New-AzureRmRecoveryServicesVault.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices/help/New-AzureRmRecoveryServicesVault.md ---- - -# New-AzureRmRecoveryServicesVault - -## SYNOPSIS -Creates a new Recovery Services vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmRecoveryServicesVault -Name <String> -ResourceGroupName <String> -Location <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmRecoveryServicesVault** cmdlet creates a new Recovery Services vault. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmRecoveryServicesVault -Name "vaultName" -ResourceGroupName "rg" -Location "eastasia" -``` - -Create recovery service vault in resource group and given location. - -## PARAMETERS - -### -Location -Specifies the name of the geographic location of the vault. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the vault to create. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the Azure resource group in which to create or from which to retrieve the specified Recovery Services object. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.ARSVault - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesVault](./Get-AzureRmRecoveryServicesVault.md) - -[Get-AzureRmRecoveryServicesVaultSettingsFile](./Get-AzureRmRecoveryServicesVaultSettingsFile.md) - -[Remove-AzureRmRecoveryServicesVault](./Remove-AzureRmRecoveryServicesVault.md) - - diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices/Remove-AzureRmRecoveryServicesVault.md b/azurermps-6.13.0/AzureRM.RecoveryServices/Remove-AzureRmRecoveryServicesVault.md deleted file mode 100644 index 613c122a88..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices/Remove-AzureRmRecoveryServicesVault.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.ARM.dll-Help.xml -Module Name: AzureRM.RecoveryServices -ms.assetid: 466F6B7C-BA7E-4DFD-8504-5A196A335231 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices/remove-azurermrecoveryservicesvault -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices/help/Remove-AzureRmRecoveryServicesVault.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices/help/Remove-AzureRmRecoveryServicesVault.md ---- - -# Remove-AzureRmRecoveryServicesVault - -## SYNOPSIS -Deletes a Recovery Services vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmRecoveryServicesVault -Vault <ARSVault> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmRecoveryServicesVault** cmdlet deletes a Recovery Services vault. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmRecoveryServicesVault -Vault $vault -``` - -Deletes a Recovery Services vault. - -## PARAMETERS - -### -Vault -Specifies an Azure Site Recovery vault object. - -```yaml -Type: ARSVault -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.ARSVault -Parameters: Vault (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.RecoveryServices.VaultOperationOutput - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRecoveryServicesVault](./Get-AzureRmRecoveryServicesVault.md) - -[Get-AzureRmRecoveryServicesVaultSettingsFile](./Get-AzureRmRecoveryServicesVaultSettingsFile.md) - -[New-AzureRmRecoveryServicesVault](./New-AzureRmRecoveryServicesVault.md) - - diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices/Set-AzureRmRecoveryServicesBackupProperties.md b/azurermps-6.13.0/AzureRM.RecoveryServices/Set-AzureRmRecoveryServicesBackupProperties.md deleted file mode 100644 index e2f6a3bdaa..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices/Set-AzureRmRecoveryServicesBackupProperties.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.ARM.dll-Help.xml -Module Name: AzureRM.RecoveryServices -ms.assetid: C635D723-0F03-4EF8-9435-24DBE0859899 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices/set-azurermrecoveryservicesbackupproperties -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices/help/Set-AzureRmRecoveryServicesBackupProperties.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices/help/Set-AzureRmRecoveryServicesBackupProperties.md ---- - -# Set-AzureRmRecoveryServicesBackupProperties - -## SYNOPSIS -Sets the properties for backup management. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmRecoveryServicesBackupProperties -Vault <ARSVault> - [-BackupStorageRedundancy <AzureRmRecoveryServicesBackupStorageRedundancyType>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmRecoveryServicesBackupProperties** cmdlet sets backup storage properties for a Recovery Services vault. - -## EXAMPLES - -### Example 1: Set GeoRedundant storage for a vault -``` -PS C:\> $Vault01 = Get-AzureRmRecoveryServicesVault -Name "TestVault" -PS C:\> Set-AzureRmRecoveryServicesBackupProperties -Vault $Vault01 -BackupStorageRedundancy GeoRedundant -``` - -The first command gets the vault named TestVault, and then stores it in the $Vault01 variable. -The second command sets the backup storage redundancy for $Vault01 to GeoRedundant. - -## PARAMETERS - -### -BackupStorageRedundancy -Specifies the backup storage redundancy type. - -```yaml -Type: AzureRmRecoveryServicesBackupStorageRedundancyType -Parameter Sets: (All) -Aliases: -Accepted values: GeoRedundant, LocallyRedundant - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Vault -Specifies the name of the vault. -The vault must be an **AzureRmRecoveryServicesVault** object. - -```yaml -Type: ARSVault -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.ARSVault -Parameters: Vault (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - - -[Get-AzureRmRecoveryServicesVault](./Get-AzureRmRecoveryServicesVault.md) - - diff --git a/azurermps-6.13.0/AzureRM.RecoveryServices/Set-AzureRmRecoveryServicesVaultContext.md b/azurermps-6.13.0/AzureRM.RecoveryServices/Set-AzureRmRecoveryServicesVaultContext.md deleted file mode 100644 index 92fa84987f..0000000000 --- a/azurermps-6.13.0/AzureRM.RecoveryServices/Set-AzureRmRecoveryServicesVaultContext.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RecoveryServices.ARM.dll-Help.xml -Module Name: AzureRM.RecoveryServices -ms.assetid: 368DD95E-EA25-4FC4-8171-CB7348FE480C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices/set-azurermrecoveryservicesvaultcontext -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices/help/Set-AzureRmRecoveryServicesVaultContext.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RecoveryServices/Commands.RecoveryServices/help/Set-AzureRmRecoveryServicesVaultContext.md ---- - -# Set-AzureRmRecoveryServicesVaultContext - -## SYNOPSIS -Sets vault context. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmRecoveryServicesVaultContext -Vault <ARSVault> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmRecoveryServicesVaultContext** cmdlet sets the vault context for Azure Site Recovery services. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Set-AzureRmRecoveryServicesVaultContext -Vault $vault -``` - -Sets vault context. - -## PARAMETERS - -### -Vault -Specifies the name of the vault. -The vault must be an **AzureRmRecoveryServicesVault** object. - -```yaml -Type: ARSVault -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.RecoveryServices.ARSVault -Parameters: Vault (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.RedisCache/AzureRM.RedisCache.md b/azurermps-6.13.0/AzureRM.RedisCache/AzureRM.RedisCache.md deleted file mode 100644 index afd4ebc546..0000000000 --- a/azurermps-6.13.0/AzureRM.RedisCache/AzureRM.RedisCache.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -Module Name: AzureRM.RedisCache -Module Guid: 820628d7-6938-488a-8760-43373a5ffce6 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.rediscache -Help Version: 4.1.2.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/AzureRM.RedisCache.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/AzureRM.RedisCache.md ---- - -# AzureRM.RedisCache Module -## Description -This topic displays help topics for the Azure Redis Cache cmdlets. - -## AzureRM.RedisCache Cmdlets -### [Export-AzureRmRedisCache](Export-AzureRmRedisCache.md) -Exports data from Azure Redis Cache to a container. - -### [Get-AzureRmRedisCache](Get-AzureRmRedisCache.md) -Gets a Redis Cache. - -### [Get-AzureRmRedisCacheFirewallRule](Get-AzureRmRedisCacheFirewallRule.md) -Get firewall rules set on Redis Cache. - -### [Get-AzureRmRedisCacheKey](Get-AzureRmRedisCacheKey.md) -Gets the access keys for a Redis Cache. - -### [Get-AzureRmRedisCacheLink](Get-AzureRmRedisCacheLink.md) -Get geo replication link for Redis Cache. - -### [Get-AzureRmRedisCachePatchSchedule](Get-AzureRmRedisCachePatchSchedule.md) -Gets a patch schedule. - -### [Import-AzureRmRedisCache](Import-AzureRmRedisCache.md) -Imports data from blobs to Azure Redis Cache. - -### [New-AzureRmRedisCache](New-AzureRmRedisCache.md) -Creates a Redis Cache. - -### [New-AzureRmRedisCacheFirewallRule](New-AzureRmRedisCacheFirewallRule.md) -Create a firewall rule on a Redis Cache. - -### [New-AzureRmRedisCacheKey](New-AzureRmRedisCacheKey.md) -Regenerates the access key of a Redis Cache. - -### [New-AzureRmRedisCacheLink](New-AzureRmRedisCacheLink.md) -Create a geo replication link between two Redis Caches. - -### [New-AzureRmRedisCachePatchSchedule](New-AzureRmRedisCachePatchSchedule.md) -Adds a patch schedule. - -### [New-AzureRmRedisCacheScheduleEntry](New-AzureRmRedisCacheScheduleEntry.md) -Creates a schedule entry. - -### [Remove-AzureRmRedisCache](Remove-AzureRmRedisCache.md) -Removes a Redis Cache. - -### [Remove-AzureRmRedisCacheDiagnostics](Remove-AzureRmRedisCacheDiagnostics.md) -Disables diagnostics on an Azure Redis Cache. - -### [Remove-AzureRmRedisCacheFirewallRule](Remove-AzureRmRedisCacheFirewallRule.md) -Remove a firewall rule from a Redis Cache. - -### [Remove-AzureRmRedisCacheLink](Remove-AzureRmRedisCacheLink.md) -Remove a geo replication link between two Redis Caches. - -### [Remove-AzureRmRedisCachePatchSchedule](Remove-AzureRmRedisCachePatchSchedule.md) -Removes the patch schedule. - -### [Reset-AzureRmRedisCache](Reset-AzureRmRedisCache.md) -Restarts nodes of a cache. - -### [Set-AzureRmRedisCache](Set-AzureRmRedisCache.md) -Modifies a Redis Cache. - -### [Set-AzureRmRedisCacheDiagnostics](Set-AzureRmRedisCacheDiagnostics.md) -Enables diagnostics on an Azure Redis Cache. - diff --git a/azurermps-6.13.0/AzureRM.RedisCache/Export-AzureRmRedisCache.md b/azurermps-6.13.0/AzureRM.RedisCache/Export-AzureRmRedisCache.md deleted file mode 100644 index e4b2eba8f1..0000000000 --- a/azurermps-6.13.0/AzureRM.RedisCache/Export-AzureRmRedisCache.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RedisCache.dll-Help.xml -Module Name: AzureRM.RedisCache -ms.assetid: B447E492-D87E-4DA3-A8B0-0BAF603CCC26 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.rediscache/export-azurermrediscache -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/Export-AzureRmRedisCache.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/Export-AzureRmRedisCache.md ---- - -# Export-AzureRmRedisCache - -## SYNOPSIS -Exports data from Azure Redis Cache to a container. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Export-AzureRmRedisCache [-ResourceGroupName <String>] -Name <String> -Prefix <String> -Container <String> - [-Format <String>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Export-AzureRmRedisCache** cmdlet exports data from Azure Redis Cache to a container. - -## EXAMPLES - -### Example 1: Export data -``` -PS C:\>Export-AzureRmRedisCache -ResourceGroupName "ResourceGroup13" -Name "RedisCache06" -Prefix "blobprefix" -Container "https://mystorageaccount.blob.core.windows.net/container18?sv=2015-04-05&sr=c&sig=HezZtBZ3DURmEGDduauE7pvETY4kqlPI8JCNa8ATmaw%3D&st=2016-05-27T00%3A00%3A00Z&se=2016-05-28T00%3A00%3A00Z&sp=rwdl" -``` - -This command exports data from an Azure Redis Cache instance into the container that is specified by the SAS URL. - -## PARAMETERS - -### -Container -Specifies the Service SAS URL of container where this cmdlet exports data. You can generate a Service SAS URL using the following PowerShell commands: -$storageAccountContext = New-AzureStorageContext -StorageAccountName "storageName" -StorageAccountKey "key" -$sasKeyForContainer = New-AzureStorageContainerSASToken -Name "containername" -Permission "rwdl" -StartTime ([System.DateTime]::Now).AddMinutes(-15) -ExpiryTime ([System.DateTime]::Now).AddHours(5) -Context $storageAccountContext -FullUri -Export-AzureRmRedisCache -ResourceGroupName "ResourceGroupName" -Name "cacheName" -Prefix "blobprefix" -Container ($sasKeyForContainer) - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Format -Specifies a format for the blob. -Currently rdb is the only supported format. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a cache. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a Boolean that indicates whether the operation succeeds. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Prefix -Specifies a prefix to use for blob names. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the cache. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, redis, cache, web, webapp, website - -## RELATED LINKS - -[Import-AzureRmRedisCache](./Import-AzureRmRedisCache.md) - -[New-AzureRmRedisCache](./New-AzureRmRedisCache.md) - -[Remove-AzureRmRedisCache](./Remove-AzureRmRedisCache.md) - -[Reset-AzureRmRedisCache](./Reset-AzureRmRedisCache.md) - -[Set-AzureRmRedisCache](./Set-AzureRmRedisCache.md) - - diff --git a/azurermps-6.13.0/AzureRM.RedisCache/Get-AzureRmRedisCache.md b/azurermps-6.13.0/AzureRM.RedisCache/Get-AzureRmRedisCache.md deleted file mode 100644 index 8a4e86d85c..0000000000 --- a/azurermps-6.13.0/AzureRM.RedisCache/Get-AzureRmRedisCache.md +++ /dev/null @@ -1,224 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RedisCache.dll-Help.xml -Module Name: AzureRM.RedisCache -ms.assetid: 8EF45FCE-5475-4A18-BFB0-C016E239612E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.rediscache/get-azurermrediscache -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/Get-AzureRmRedisCache.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/Get-AzureRmRedisCache.md ---- - -# Get-AzureRmRedisCache - -## SYNOPSIS -Gets a Redis Cache. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmRedisCache [-ResourceGroupName <String>] [-Name <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRedisCache** cmdlet gets the specified Azure Redis Cache. -If you specify no parameters, this operation gets every Redis Cache for the current subscription. - -## EXAMPLES - -### Example 1: Get a Redis Cache by name -``` -PS C:\>Get-AzureRmRedisCache -Name "myexists" - - ResourceGroupName : myGroup - Id : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/myGroup/providers/Microsoft.Cache/Redis/myexists - Location : North Central US - Name : myexists - Type : Microsoft.Cache/Redis - HostName : myexists.redis.cache.windows.net - Port : 6379 - ProvisioningState : succeeded - SslPort : 6380 - RedisConfiguration : {} - EnableNonSslPort : False - RedisVersion : 2.8 - Size : 1GB - Sku : Basic - Tag : {} - Zone : [] -``` - -This command gets the Redis Cache named myexists. - -### Example 2: Get every Redis Cache in a resource group -``` -PS C:\>Get-AzureRmRedisCache -ResourceGroupName "myGroup" - - ResourceGroupName : myGroup - Id : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/myGroup/providers/Microsoft.Cache/Redis/myexists - Location : North Central US - Name : myexists - Type : Microsoft.Cache/Redis - HostName : myexists.redis.cache.windows.net - Port : 6379 - ProvisioningState : succeeded - SslPort : 6380 - RedisConfiguration : {} - EnableNonSslPort : False - RedisVersion : 2.8 - Size : 1GB - Sku : Basic - Tag : {} - Zone : [] - - ResourceGroupName : myGroup - Id : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/myGroup/providers/Microsoft.Cache/Redis/myearlier - Location : North Central US - Name : myearlier - Type : Microsoft.Cache/Redis - HostName : myearlier.redis.cache.windows.net - Port : 6379 - ProvisioningState : succeeded - SslPort : 6380 - RedisConfiguration : {} - EnableNonSslPort : True - RedisVersion : 2.8 - Size : 250MB - Sku : Standard - Tag : {} - Zone : [] -``` - -This command gets every Redis Cache in the specified resource group. - -### Example 3: Get every Redis Cache in the current subscription -``` -PS C:\>Get-AzureRmRedisCache - - ResourceGroupName : myGroup - Id : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/myGroup/providers/Microsoft.Cache/Redis/myexists - Location : North Central US - Name : myexists - Type : Microsoft.Cache/Redis - HostName : myexists.redis.cache.windows.net - Port : 6379 - ProvisioningState : succeeded - SslPort : 6380 - RedisConfiguration : {} - EnableNonSslPort : False - RedisVersion : 2.8 - Size : 1GB - Sku : Basic - Tag : {} - Zone : [] - - ResourceGroupName : myGroup - Id : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/myGroup/providers/Microsoft.Cache/Redis/myearlier - Location : North Central US - Name : myearlier - Type : Microsoft.Cache/Redis - HostName : myearlier.redis.cache.windows.net - Port : 6379 - ProvisioningState : succeeded - SslPort : 6380 - RedisConfiguration : {} - EnableNonSslPort : True - RedisVersion : 2.8 - Size : 250MB - Sku : Standard - Tag : {} - Zone : [] - - ResourceGroupName : myGroup2 - Id : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/myGroup2/providers/Microsoft.Cache/Redis/myearlier2 - Location : North Central US - Name : myearlier2 - Type : Microsoft.Cache/Redis - HostName : myearlier2.redis.cache.windows.net - Port : 6379 - ProvisioningState : succeeded - SslPort : 6380 - RedisConfiguration : {} - EnableNonSslPort : False - RedisVersion : 2.8 - Size : 250MB - Sku : Basic - Tag : {} - Zone : [] -``` - -This command gets every Redis Cache in the current subscription. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Redis Cache to get. -Use with the *ResourceGroupName* parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the Redis Cache to get. -If you specify only the *ResourceGroupName* parameter, this operation gets every Redis Cache in the specified resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.RedisCache.Models.RedisCacheAttributes - -## NOTES - -## RELATED LINKS - -[New-AzureRmRedisCache](./New-AzureRmRedisCache.md) - -[Remove-AzureRmRedisCache](./Remove-AzureRmRedisCache.md) - -[Set-AzureRmRedisCache](./Set-AzureRmRedisCache.md) - - diff --git a/azurermps-6.13.0/AzureRM.RedisCache/Get-AzureRmRedisCacheFirewallRule.md b/azurermps-6.13.0/AzureRM.RedisCache/Get-AzureRmRedisCacheFirewallRule.md deleted file mode 100644 index 9a66f8767e..0000000000 --- a/azurermps-6.13.0/AzureRM.RedisCache/Get-AzureRmRedisCacheFirewallRule.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RedisCache.dll-Help.xml -Module Name: AzureRM.RedisCache -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.rediscache/get-azurermrediscachefirewallrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/Get-AzureRmRedisCacheFirewallRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/Get-AzureRmRedisCacheFirewallRule.md ---- - -# Get-AzureRmRedisCacheFirewallRule - -## SYNOPSIS -Get firewall rules set on Redis Cache. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmRedisCacheFirewallRule [-ResourceGroupName <String>] -Name <String> [-RuleName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -If **RuleName** parameter if provided, **Get-AzureRmRedisCacheFirewallRule** cmdlet gets detail about the specified firewall rule on Azure Redis Cache. If only **Name** is specified this operation gets all firewall rules available on that Redis Cache. - -## EXAMPLES - -### Example 1: Get a single firewall rule -``` -PS C:\>Get-AzureRmRedisCacheFirewallRule -Name "mycache" -RuleName "ruleone" - - ResourceGroupName : myGroup - Name : mycache - FirewallRuleId : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/myGroup/providers/Microsoft.Cache/Redis/mycache/firewallRules/ruleone - RuleName : ruleone - Type : Microsoft.Cache/Redis/firewallRules - StartIP : 10.0.0.1 - EndIP : 10.0.0.32 -``` - -This command gets firewall rule named ruleone from Redis Cache named mycache. - -### Example 2: Get all firewall rules -``` -PS C:\>Get-AzureRmRedisCacheFirewallRule -Name "mycache" - - ResourceGroupName : myGroup - Name : mycache - FirewallRuleId : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/myGroup/providers/Microsoft.Cache/Redis/mycache/firewallRules/ruleone - RuleName : ruleone - Type : Microsoft.Cache/Redis/firewallRules - StartIP : 10.0.0.1 - EndIP : 10.0.0.32 - - ResourceGroupName : myGroup - Name : mycache - FirewallRuleId : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/myGroup/providers/Microsoft.Cache/Redis/mycache/firewallRules/ruletwo - RuleName : ruletwo - Type : Microsoft.Cache/Redis/firewallRules - StartIP : 10.0.0.33 - EndIP : 10.0.0.64 -``` - -This command gets all firewall rules from Redis Cache named mycache. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of redis cache. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of resource group in which cache exists. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RuleName -Name of firewall rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.RedisCache.Models.PSRedisFirewallRule - -## NOTES - -## RELATED LINKS - -[New-AzureRmRedisCacheFirewallRule](./New-AzureRmRedisCacheFirewallRule.md) - -[Remove-AzureRmRedisCacheFirewallRule](./Remove-AzureRmRedisCacheFirewallRule.md) - -[Get-AzureRmRedisCache](./Get-AzureRmRedisCache.md) - -[New-AzureRmRedisCache](./New-AzureRmRedisCache.md) - -[Remove-AzureRmRedisCache](./Remove-AzureRmRedisCache.md) - -[Set-AzureRmRedisCache](./Set-AzureRmRedisCache.md) diff --git a/azurermps-6.13.0/AzureRM.RedisCache/Get-AzureRmRedisCacheKey.md b/azurermps-6.13.0/AzureRM.RedisCache/Get-AzureRmRedisCacheKey.md deleted file mode 100644 index c7b324549d..0000000000 --- a/azurermps-6.13.0/AzureRM.RedisCache/Get-AzureRmRedisCacheKey.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RedisCache.dll-Help.xml -Module Name: AzureRM.RedisCache -ms.assetid: C0BEC701-8CE2-4B19-9F04-D32A42D9249E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.rediscache/get-azurermrediscachekey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/Get-AzureRmRedisCacheKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/Get-AzureRmRedisCacheKey.md ---- - -# Get-AzureRmRedisCacheKey - -## SYNOPSIS -Gets the access keys for a Redis Cache. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmRedisCacheKey [-ResourceGroupName <String>] -Name <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRedisCacheKey** cmdlet gets the access keys for an Azure Redis Cache. - -## EXAMPLES - -### Example 1: Get the access keys for a Redis Cache -``` -PS C:\>Get-AzureRmRedisCacheKey -ResourceGroupName "MyResourceGroup" -Name "MyCacheKey" -PrimaryKey : pJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= -SecondaryKey : sJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= -``` - -This command gets the access keys named MyCacheKey. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a Redis Cache. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the Redis Cache. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Redis.Models.RedisAccessKeys - -## NOTES - -## RELATED LINKS - -[New-AzureRmRedisCacheKey](./New-AzureRmRedisCacheKey.md) - - diff --git a/azurermps-6.13.0/AzureRM.RedisCache/Get-AzureRmRedisCacheLink.md b/azurermps-6.13.0/AzureRM.RedisCache/Get-AzureRmRedisCacheLink.md deleted file mode 100644 index 38f43fe919..0000000000 --- a/azurermps-6.13.0/AzureRM.RedisCache/Get-AzureRmRedisCacheLink.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RedisCache.dll-Help.xml -Module Name: AzureRM.RedisCache -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.rediscache/get-azurermrediscachelink -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/Get-AzureRmRedisCacheLink.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/Get-AzureRmRedisCacheLink.md ---- - -# Get-AzureRmRedisCacheLink - -## SYNOPSIS -Get geo replication link for Redis Cache. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### AllLinksForCache (Default) -``` -Get-AzureRmRedisCacheLink -Name <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### AllLinksForPrimaryCache -``` -Get-AzureRmRedisCacheLink -PrimaryServerName <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### SingleLink -``` -Get-AzureRmRedisCacheLink -PrimaryServerName <String> -SecondaryServerName <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### AllLinksForSecondaryCache -``` -Get-AzureRmRedisCacheLink -SecondaryServerName <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -There are four different ways to get geo-replication link detail. Either provide parameter Name or PrimaryServerName and/or SecondaryServerName. Name is given then all link where cache exists will be returned. If only PrimaryServerName is given then all links where cache is primary will be returned. If only SecondaryServerName is given then all links where cache is secondary will be returned. If PrimaryServerName and SecondaryServerName both are given then specific link with correct role will be returned. - -## EXAMPLES - -### Example 1: Get using parameter set AllLinksForCache -``` -PS C:\>Get-AzureRmRedisCacheLink -Name "mycache1" - - PrimaryServerName : mycache1 - SecondaryServerName : mycache2 - ProvisioningState : Succeeded -``` - -This command gets all geo-replication links for Redis Cache named mycache1. - -### Example 2: Get using parameter set AllLinksForPrimaryCache -``` -PS C:\>Get-AzureRmRedisCacheLink -PrimaryServerName "mycache1" - - PrimaryServerName : mycache1 - SecondaryServerName : mycache2 - ProvisioningState : Succeeded -``` - -This command gets geo-replication links where Redis Cache named mycache1 is primary. - -### Example 3: Get using parameter set AllLinksForSecondaryCache -``` -PS C:\>Get-AzureRmRedisCacheLink -SecondaryServerName "mycache2" - - PrimaryServerName : mycache1 - SecondaryServerName : mycache2 - ProvisioningState : Succeeded -``` - -This command gets geo-replication links where Redis Cache named mycache2 is secondary. - -### Example 4: Get using parameter set SingleLink -``` -PS C:\>Get-AzureRmRedisCacheLink -PrimaryServerName "mycache1" -SecondaryServerName "mycache2" - - PrimaryServerName : mycache1 - SecondaryServerName : mycache2 - ProvisioningState : Succeeded -``` - -This command gets a single geo-replication links where Redis Cache named mycache1 is primary and Redis Cache named mycache2 is secondary. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of redis cache. - -```yaml -Type: System.String -Parameter Sets: AllLinksForCache -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PrimaryServerName -Name of primary redis cache in link. - -```yaml -Type: System.String -Parameter Sets: AllLinksForPrimaryCache, SingleLink -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecondaryServerName -Name of secondary redis cache in link. - -```yaml -Type: System.String -Parameter Sets: SingleLink, AllLinksForSecondaryCache -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.RedisCache.Models.PSRedisLinkedServer - -## NOTES - -## RELATED LINKS - -[New-AzureRmRedisCacheLink](./New-AzureRmRedisCacheLink.md) - -[Remove-AzureRmRedisCacheLink](./Remove-AzureRmRedisCacheLink.md) - -[Get-AzureRmRedisCache](./Get-AzureRmRedisCache.md) - -[New-AzureRmRedisCache](./New-AzureRmRedisCache.md) - -[Remove-AzureRmRedisCache](./Remove-AzureRmRedisCache.md) - -[Set-AzureRmRedisCache](./Set-AzureRmRedisCache.md) diff --git a/azurermps-6.13.0/AzureRM.RedisCache/Get-AzureRmRedisCachePatchSchedule.md b/azurermps-6.13.0/AzureRM.RedisCache/Get-AzureRmRedisCachePatchSchedule.md deleted file mode 100644 index cfe8bfcc91..0000000000 --- a/azurermps-6.13.0/AzureRM.RedisCache/Get-AzureRmRedisCachePatchSchedule.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RedisCache.dll-Help.xml -Module Name: AzureRM.RedisCache -ms.assetid: DA180A4A-88B6-4359-94E0-CF72F66D1FE4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.rediscache/get-azurermrediscachepatchschedule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/Get-AzureRmRedisCachePatchSchedule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/Get-AzureRmRedisCachePatchSchedule.md ---- - -# Get-AzureRmRedisCachePatchSchedule - -## SYNOPSIS -Gets a patch schedule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmRedisCachePatchSchedule [-ResourceGroupName <String>] -Name <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRedisCachePatchSchedule** cmdlet gets a patch schedule for a cache in Azure Redis Cache. - -## EXAMPLES - -### Example 1: Get the patch schedule -``` -PS C:\>Get-AzureRmRedisCachePatchSchedule -ResourceGroupName "ResourceGroup13" -Name "RedisCache06" -``` - -This command gets the patch schedule from the cache named RedisCache06. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a cache. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group which contains the cache. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.RedisCache.Models.PSScheduleEntry - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, redis, cache, web, webapp, website - -## RELATED LINKS - -[New-AzureRmRedisCachePatchSchedule](./New-AzureRmRedisCachePatchSchedule.md) - -[New-AzureRmRedisCacheScheduleEntry](./New-AzureRmRedisCacheScheduleEntry.md) - -[Remove-AzureRmRedisCachePatchSchedule](./Remove-AzureRmRedisCachePatchSchedule.md) - - diff --git a/azurermps-6.13.0/AzureRM.RedisCache/Import-AzureRmRedisCache.md b/azurermps-6.13.0/AzureRM.RedisCache/Import-AzureRmRedisCache.md deleted file mode 100644 index d21f2f8bba..0000000000 --- a/azurermps-6.13.0/AzureRM.RedisCache/Import-AzureRmRedisCache.md +++ /dev/null @@ -1,208 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RedisCache.dll-Help.xml -Module Name: AzureRM.RedisCache -ms.assetid: BC00DEF9-6A93-4DF5-8E5B-C488551BA1D1 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.rediscache/import-azurermrediscache -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/Import-AzureRmRedisCache.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/Import-AzureRmRedisCache.md ---- - -# Import-AzureRmRedisCache - -## SYNOPSIS -Imports data from blobs to Azure Redis Cache. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Import-AzureRmRedisCache [-ResourceGroupName <String>] -Name <String> -Files <String[]> [-Format <String>] - [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Import-AzureRmRedisCache** cmdlet imports data from blobs into Azure Redis Cache. - -## EXAMPLES - -### Example 1: Import data -``` -PS C:\>Import-AzureRmRedisCache -ResourceGroupName "ResourceGroup13" -Name "RedisCache06" -Files @("https://mystorageaccount.blob.core.windows.net/container22/blobname?sv=2015-04-05&sr=b&sig=caIwutG2uDa0NZ8mjdNJdgOY8%2F8mhwRuGNdICU%2B0pI4%3D&st=2016-05-27T00%3A00%3A00Z&se=2016-05-28T00%3A00%3A00Z&sp=rwd") -Force -``` - -This command imports data from the blob that is specified by the SAS URL into Azure Redis Cache. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Files -Specifies the SAS URLs of blobs whose content this cmdlet imports into the cache. You can generate the SAS URLs using the following PowerShell commands: -$storageAccountContext = New-AzureStorageContext -StorageAccountName "storageName" -StorageAccountKey "key" -$sasKeyForBlob = New-AzureStorageBlobSASToken -Container "containerName" -blob "blobName" -Permission "rwdl" -StartTime ([System.DateTime]::Now).AddMinutes(-15) -ExpiryTime ([System.DateTime]::Now).AddHours(5) -Context $storageAccountContext -FullUri -Import-AzureRmRedisCache -ResourceGroupName "ResourceGroupName" -Name "cacheName" -Files ($sasKeyForBlob) -Force - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Format -Specifies the format of the blob. -Currently rdb is the only supported format. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a cache. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a Boolean that indicates whether the operation succeeds. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the cache. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.String[] - -## OUTPUTS - -### System.Boolean - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, redis, cache, web, webapp, website - -## RELATED LINKS - -[Export-AzureRmRedisCache](./Export-AzureRmRedisCache.md) - -[New-AzureRmRedisCache](./New-AzureRmRedisCache.md) - -[Remove-AzureRmRedisCache](./Remove-AzureRmRedisCache.md) - -[Reset-AzureRmRedisCache](./Reset-AzureRmRedisCache.md) - -[Set-AzureRmRedisCache](./Set-AzureRmRedisCache.md) - - diff --git a/azurermps-6.13.0/AzureRM.RedisCache/New-AzureRmRedisCache.md b/azurermps-6.13.0/AzureRM.RedisCache/New-AzureRmRedisCache.md deleted file mode 100644 index 46495b72b2..0000000000 --- a/azurermps-6.13.0/AzureRM.RedisCache/New-AzureRmRedisCache.md +++ /dev/null @@ -1,448 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RedisCache.dll-Help.xml -Module Name: AzureRM.RedisCache -ms.assetid: 81179AFE-6524-4F59-8BC2-3E152F51D1DD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.rediscache/new-azurermrediscache -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/New-AzureRmRedisCache.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/New-AzureRmRedisCache.md ---- - -# New-AzureRmRedisCache - -## SYNOPSIS -Creates a Redis Cache. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmRedisCache -ResourceGroupName <String> -Name <String> -Location <String> [-Size <String>] - [-Sku <String>] [-RedisConfiguration <Hashtable>] [-EnableNonSslPort <Boolean>] [-TenantSettings <Hashtable>] - [-ShardCount <Int32>] [-SubnetId <String>] [-StaticIP <String>] [-Tag <Hashtable>] [-Zone <String[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmRedisCache** cmdlet creates an Azure Redis Cache. - -## EXAMPLES - -### Example 1: Create a Redis Cache -``` -PS C:\>New-AzureRmRedisCache -ResourceGroupName "MyGroup" -Name "MyCache" -Location "North Central US" - - PrimaryKey : pJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= - SecondaryKey : sJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= - ResourceGroupName : MyGroup - Id : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/mygroup/providers/Microsoft.Cache/Redis/mycache - Location : North Central US - Name : MyCache - Type : Microsoft.Cache/Redis - HostName : mycache.redis.cache.windows.net - Port : 6379 - ProvisioningState : creating - SslPort : 6380 - RedisConfiguration : {} - EnableNonSslPort : False - RedisVersion : 2.8 - Size : 1GB - Sku : Standard - Tag : {} - Zone : [] -``` - -This command creates a Redis Cache. - -### Example 2: Create a Standard SKU Redis Cache -``` -PS C:\>New-AzureRmRedisCache -ResourceGroupName "MyGroup" -Name "MyCache" -Location "North Central US" -Size 250MB -Sku "Standard" -RedisConfiguration @{"maxmemory-policy" = "allkeys-random"} -Force - - PrimaryKey : pJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= - SecondaryKey : sJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= - ResourceGroupName : MyGroup - Id : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/mygroup/providers/Microsoft.Cache/Redis/MyCache - Location : North Central US - Name : mycache - Type : Microsoft.Cache/Redis - HostName : mycache.redis.cache.windows.net - Port : 6379 - ProvisioningState : creating - SslPort : 6380 - RedisConfiguration : {[maxmemory-policy, allkeys-random]} - EnableNonSslPort : False - RedisVersion : 2.8 - Size : 250MB - Sku : Standard - Tag : {} - Zone : [] -``` - -This command creates a Redis Cache. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableNonSslPort -Indicates whether the non-SSL port is enabled. -The default value is $False (the non-SSL port is disabled). - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the location in which to create a Redis Cache. -Valid values are: -- North Central US -- South Central US -- Central US -- West Europe -- North Europe -- West US -- East US -- East US 2 -- Japan East -- Japan West -- Brazil South -- Southeast Asia -- East Asia -- Australia East -- Australia Southeast - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Redis Cache to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RedisConfiguration -Specifies Redis configuration settings. -The acceptable values for this parameter are: -- rdb-backup-enabled. -Specifies that Redis data persistence is enabled. -Premium tier only. -- rdb-storage-connection-string. -Specifies the connection string to the Storage account for Redis data persistence. -Premium tier only. -- rdb-backup-frequency. -Specifies the backup frequency for Redis data persistence. -Premium tier only. -- maxmemory-reserved. -Configures the memory reserved for non-cache processes. -Standard and Premium tiers. -- maxmemory-policy. -Configures the eviction policy for the cache. -All pricing tiers. -- notify-keyspace-events. -Configures keyspace notifications. -Standard and premium tiers. -- hash-max-ziplist-entries. -Configures memory optimization for small aggregate data types. -Standard and Premium tiers. -- hash-max-ziplist-value. -Configures memory optimization for small aggregate data types. -Standard and Premium tiers. -- set-max-intset-entries. -Configures memory optimization for small aggregate data types. -Standard and Premium tiers. -- zset-max-ziplist-entries. -Configures memory optimization for small aggregate data types. -Standard and Premium tiers. -- zset-max-ziplist-value. -Configures memory optimization for small aggregate data types. -Standard and Premium tiers. -- databases. -Configures the number of databases. -This property can be configured only at cache creation. -Standard and Premium tiers. -For more information, see Manage Azure Redis Cache with Azure PowerShellhttps://go.microsoft.com/fwlink/?LinkId=800051 (https://go.microsoft.com/fwlink/?LinkId=800051). - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group in which to create the Redis Cache. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ShardCount -Specifies the number of shards to create on a Premium cluster cache. -The acceptable values for this parameter are: -- 1 -- 2 -- 3 -- 4 -- 5 -- 6 -- 7 -- 8 -- 9 -- 10 - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Size -Specifies the size of the Redis Cache. -Valid values are: -- P1 -- P2 -- P3 -- P4 -- C0 -- C1 -- C2 -- C3 -- C4 -- C5 -- C6 -- 250MB -- 1GB -- 2.5GB -- 6GB -- 13GB -- 26GB -- 53GB -The default value is 1GB or C1. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: P1, P2, P3, P4, C0, C1, C2, C3, C4, C5, C6, 250MB, 1GB, 2.5GB, 6GB, 13GB, 26GB, 53GB - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -Specifies the SKU of the Redis Cache to create. -Valid values are: -- Basic -- Standard -- Premium -The default value is Standard. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Basic, Standard, Premium - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StaticIP -Specifies a unique IP address in the subnet for the Redis Cache. -If you do not specify a value for this parameter, this cmdlet chooses an IP address from the subnet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubnetId -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -A hash table which represents tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TenantSettings -This parameter has been deprecated. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Zone -List of zones. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.String[] - -## OUTPUTS - -### Microsoft.Azure.Commands.RedisCache.Models.RedisCacheAttributesWithAccessKeys - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRedisCache](./Get-AzureRmRedisCache.md) - -[Remove-AzureRmRedisCache](./Remove-AzureRmRedisCache.md) - -[Set-AzureRmRedisCache](./Set-AzureRmRedisCache.md) - - diff --git a/azurermps-6.13.0/AzureRM.RedisCache/New-AzureRmRedisCacheFirewallRule.md b/azurermps-6.13.0/AzureRM.RedisCache/New-AzureRmRedisCacheFirewallRule.md deleted file mode 100644 index 459b64a177..0000000000 --- a/azurermps-6.13.0/AzureRM.RedisCache/New-AzureRmRedisCacheFirewallRule.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RedisCache.dll-Help.xml -Module Name: AzureRM.RedisCache -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.rediscache/new-azurermrediscachefirewallrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/New-AzureRmRedisCacheFirewallRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/New-AzureRmRedisCacheFirewallRule.md ---- - -# New-AzureRmRedisCacheFirewallRule - -## SYNOPSIS -Create a firewall rule on a Redis Cache. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NormalParameterSet (Default) -``` -New-AzureRmRedisCacheFirewallRule [-ResourceGroupName <String>] -Name <String> -RuleName <String> - -StartIP <String> -EndIP <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### RedisCacheAttributesObject -``` -New-AzureRmRedisCacheFirewallRule -InputObject <RedisCacheAttributes> -RuleName <String> -StartIP <String> - -EndIP <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -New-AzureRmRedisCacheFirewallRule -ResourceId <String> -RuleName <String> -StartIP <String> -EndIP <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Create a firewall rule on a Redis Cache. - -## EXAMPLES - -### Example 1: Create a firewall rule -``` -PS C:\>New-AzureRmRedisCacheFirewallRule -Name "mycache" -RuleName "ruleone" -StartIP "10.0.0.1" -EndIP "10.0.0.32" - - ResourceGroupName : myGroup - Name : mycache - FirewallRuleId : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/myGroup/providers/Microsoft.Cache/Redis/mycache/firewallRules/ruleone - RuleName : ruleone - Type : Microsoft.Cache/Redis/firewallRules - StartIP : 10.0.0.1 - EndIP : 10.0.0.32 -``` - -This command creates firewall rule named ruleone on Redis Cache named mycache. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndIP -Ending IP address. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -object of type RedisCacheAttributes - -```yaml -Type: Microsoft.Azure.Commands.RedisCache.Models.RedisCacheAttributes -Parameter Sets: RedisCacheAttributesObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of redis cache. - -```yaml -Type: System.String -Parameter Sets: NormalParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of resource group in which cache exists. - -```yaml -Type: System.String -Parameter Sets: NormalParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -ARM Id of Redis Cache. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RuleName -Name of firewall rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartIP -Starting IP address. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.RedisCache.Models.RedisCacheAttributes -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.RedisCache.Models.PSRedisFirewallRule - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRedisCacheFirewallRule](./Get-AzureRmRedisCacheFirewallRule.md) - -[Remove-AzureRmRedisCacheFirewallRule](./Remove-AzureRmRedisCacheFirewallRule.md) - -[Get-AzureRmRedisCache](./Get-AzureRmRedisCache.md) - -[New-AzureRmRedisCache](./New-AzureRmRedisCache.md) - -[Remove-AzureRmRedisCache](./Remove-AzureRmRedisCache.md) - -[Set-AzureRmRedisCache](./Set-AzureRmRedisCache.md) diff --git a/azurermps-6.13.0/AzureRM.RedisCache/New-AzureRmRedisCacheKey.md b/azurermps-6.13.0/AzureRM.RedisCache/New-AzureRmRedisCacheKey.md deleted file mode 100644 index ed877b63c3..0000000000 --- a/azurermps-6.13.0/AzureRM.RedisCache/New-AzureRmRedisCacheKey.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RedisCache.dll-Help.xml -Module Name: AzureRM.RedisCache -ms.assetid: 1F86CE62-AA01-44FB-A935-484EC51DDE5A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.rediscache/new-azurermrediscachekey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/New-AzureRmRedisCacheKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/New-AzureRmRedisCacheKey.md ---- - -# New-AzureRmRedisCacheKey - -## SYNOPSIS -Regenerates the access key of a Redis Cache. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmRedisCacheKey [-ResourceGroupName <String>] -Name <String> -KeyType <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmRedisCacheKey** cmdlet regenerates the access key of an Azure Redis Cache. - -## EXAMPLES - -### Example 1: Regenerate a primary key -``` -PS C:\>New-AzureRmRedisCacheKey -ResourceGroupName "ResourceGroup03" -Name "myCache" -KeyType "Primary" -Force - - PrimaryKey : pJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= - - SecondaryKey : sJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= -``` - -This command regenerates the primary key of a Redis Cache. - -### Example 2: Regenerate a secondary key -``` -PS C:\>New-AzureRmRedisCacheKey -ResourceGroupName "ResourceGroup03" -Name "myCache" -KeyType "Secondary" -Force - PrimaryKey : pJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= - - SecondaryKey : sJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= -``` - -This command regenerates the secondary key of a Redis Cache. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyType -Specifies whether to regenerate the primary or secondary access key. -Valid values are: Primary, Secondary. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Primary, Secondary - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Redis Cache. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the Redis Cache. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Redis.Models.RedisAccessKeys - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRedisCacheKey](./Get-AzureRmRedisCacheKey.md) - - diff --git a/azurermps-6.13.0/AzureRM.RedisCache/New-AzureRmRedisCacheLink.md b/azurermps-6.13.0/AzureRM.RedisCache/New-AzureRmRedisCacheLink.md deleted file mode 100644 index 4034dbd878..0000000000 --- a/azurermps-6.13.0/AzureRM.RedisCache/New-AzureRmRedisCacheLink.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RedisCache.dll-Help.xml -Module Name: AzureRM.RedisCache -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.rediscache/new-azurermrediscachelink -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/New-AzureRmRedisCacheLink.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/New-AzureRmRedisCacheLink.md ---- - -# New-AzureRmRedisCacheLink - -## SYNOPSIS -Create a geo replication link between two Redis Caches. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmRedisCacheLink -PrimaryServerName <String> -SecondaryServerName <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Create a geo replication link between two Redis Caches. - -## EXAMPLES - -### Example 1: Create a link between two caches -``` -PS C:\>New-AzureRmRedisCacheLink -PrimaryServerName "mycache1" -SecondaryServerName "mycache2" - - PrimaryServerName : mycache1 - SecondaryServerName : mycache2 - ProvisioningState : Creating -``` - -This command creates geo-replication link between Redis Cache mycache1 and mycache2. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimaryServerName -Name of primary redis cache in link. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecondaryServerName -Name of secondary redis cache in link. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.RedisCache.Models.PSRedisLinkedServer - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRedisCacheLink](./Get-AzureRmRedisCacheLink.md) - -[Remove-AzureRmRedisCacheLink](./Remove-AzureRmRedisCacheLink.md) - -[Get-AzureRmRedisCache](./Get-AzureRmRedisCache.md) - -[New-AzureRmRedisCache](./New-AzureRmRedisCache.md) - -[Remove-AzureRmRedisCache](./Remove-AzureRmRedisCache.md) - -[Set-AzureRmRedisCache](./Set-AzureRmRedisCache.md) diff --git a/azurermps-6.13.0/AzureRM.RedisCache/New-AzureRmRedisCachePatchSchedule.md b/azurermps-6.13.0/AzureRM.RedisCache/New-AzureRmRedisCachePatchSchedule.md deleted file mode 100644 index 94c14a71e4..0000000000 --- a/azurermps-6.13.0/AzureRM.RedisCache/New-AzureRmRedisCachePatchSchedule.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RedisCache.dll-Help.xml -Module Name: AzureRM.RedisCache -ms.assetid: F7FAFF52-5E07-4D88-B48F-BC70C43E8691 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.rediscache/new-azurermrediscachepatchschedule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/New-AzureRmRedisCachePatchSchedule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/New-AzureRmRedisCachePatchSchedule.md ---- - -# New-AzureRmRedisCachePatchSchedule - -## SYNOPSIS -Adds a patch schedule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmRedisCachePatchSchedule [-ResourceGroupName <String>] -Name <String> -Entries <PSScheduleEntry[]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmRedisCachePatchSchedule** cmdlet adds a patch schedule to a cache in Azure Redis Cache. - -## EXAMPLES - -### Example 1: Create and add a patch schedule on a cache -``` -PS C:\>New-AzureRmRedisCachePatchSchedule -ResourceGroupName "ResourceGroup13" -Name "RedisCache06" -Entries @(New-AzureRmRedisCacheScheduleEntry -DayOfWeek "Weekend" -StartHourUtc 2 -MaintenanceWindow "06:00:00") -``` - -This command adds a patch schedule to the cache named RedisCache06. -The Entries parameter takes as its value a command that uses **New-AzureRmRedisCacheScheduleEntry** to create a schedule. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Entries -Specifies an array of schedules that this cmdlet sets on a cache. -To obtain a **PSScheduleEntry** object, use the New-AzureRmRedisCacheScheduleEntry cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.RedisCache.Models.PSScheduleEntry[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the cache. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group which contains the cache. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.RedisCache.Models.PSScheduleEntry[] - -## OUTPUTS - -### Microsoft.Azure.Commands.RedisCache.Models.PSScheduleEntry - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, redis, cache, web, webapp, website - -## RELATED LINKS - -[Get-AzureRmRedisCachePatchSchedule](./Get-AzureRmRedisCachePatchSchedule.md) - -[New-AzureRmRedisCacheScheduleEntry](./New-AzureRmRedisCacheScheduleEntry.md) - -[Remove-AzureRmRedisCachePatchSchedule](./Remove-AzureRmRedisCachePatchSchedule.md) - - diff --git a/azurermps-6.13.0/AzureRM.RedisCache/New-AzureRmRedisCacheScheduleEntry.md b/azurermps-6.13.0/AzureRM.RedisCache/New-AzureRmRedisCacheScheduleEntry.md deleted file mode 100644 index 52d1c45cf0..0000000000 --- a/azurermps-6.13.0/AzureRM.RedisCache/New-AzureRmRedisCacheScheduleEntry.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RedisCache.dll-Help.xml -Module Name: AzureRM.RedisCache -ms.assetid: ACB53C23-99E0-4A0A-A44E-0D3FDB12450B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.rediscache/new-azurermrediscachescheduleentry -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/New-AzureRmRedisCacheScheduleEntry.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/New-AzureRmRedisCacheScheduleEntry.md ---- - -# New-AzureRmRedisCacheScheduleEntry - -## SYNOPSIS -Creates a schedule entry. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmRedisCacheScheduleEntry -DayOfWeek <String> -StartHourUtc <Int32> [-MaintenanceWindow <TimeSpan>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmRedisCacheScheduleEntry** cmdlet creates a **PSScheduleEntry** object. -Azure Redis Cache patch schedule cmdlets, such as the New-AzureRmRedisCachePatchSchedule cmdlet, require schedule entry objects. - -## EXAMPLES - -### Example 1: Create a schedule entry for weekends -``` -PS C:\>New-AzureRmRedisCacheScheduleEntry -DayOfWeek "Weekend" -StartHourUtc 2 -MaintenanceWindow "06:00:00" -``` - -This command creates a **PSScheduleEntry** object that represents a weekend schedule that has the specified start time and window. - -## PARAMETERS - -### -DayOfWeek -Specifies the day of the week for the schedule entry. -The acceptable values for this parameter are: -- Everyday -- Weekend -- Monday -- Tuesday -- Wednesday -- Thursday -- Friday -- Saturday -- Sunday - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Everyday, Weekend, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaintenanceWindow -Specifies the amount of time window allowed for updates. - -```yaml -Type: System.Nullable`1[System.TimeSpan] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartHourUtc -Specifies an hour of the day when the schedule starts. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Int32 - -### System.Nullable`1[[System.TimeSpan, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.RedisCache.Models.PSScheduleEntry - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, redis, cache, web, webapp, website - -## RELATED LINKS - -[Get-AzureRmRedisCachePatchSchedule](./Get-AzureRmRedisCachePatchSchedule.md) - -[New-AzureRmRedisCachePatchSchedule](./New-AzureRmRedisCachePatchSchedule.md) - -[Remove-AzureRmRedisCachePatchSchedule](./Remove-AzureRmRedisCachePatchSchedule.md) - - diff --git a/azurermps-6.13.0/AzureRM.RedisCache/Remove-AzureRmRedisCache.md b/azurermps-6.13.0/AzureRM.RedisCache/Remove-AzureRmRedisCache.md deleted file mode 100644 index 489e2cd582..0000000000 --- a/azurermps-6.13.0/AzureRM.RedisCache/Remove-AzureRmRedisCache.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RedisCache.dll-Help.xml -Module Name: AzureRM.RedisCache -ms.assetid: A22D930B-5026-4915-B498-EE31153E1E9A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.rediscache/remove-azurermrediscache -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/Remove-AzureRmRedisCache.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/Remove-AzureRmRedisCache.md ---- - -# Remove-AzureRmRedisCache - -## SYNOPSIS -Removes a Redis Cache. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmRedisCache [-ResourceGroupName <String>] -Name <String> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmRedisCache** cmdlet removes an Azure Redis Cache. - -## EXAMPLES - -### Example 1: Remove a Redis Cache and return the result -``` -PS C:\>Remove-AzureRmRedisCache -ResourceGroupName "ResourceGroup03" -Name "myCache" -Force -PassThru -True -``` - -This command removes a Redis Cache and displays whether the operation is successful. - -### Example 2: Remove a Redis Cache and do not display the result -``` -PS C:\>Remove-AzureRmRedisCache -ResourceGroupName "ResourceGroup03" -Name "myCache" -Force -``` - -This command removes a Redis Cache. -Because the *PassThru* parameter is not specified, the result of the operation is not displayed. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Redis Cache to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the Redis Cache to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRedisCache](./Get-AzureRmRedisCache.md) - -[New-AzureRmRedisCache](./New-AzureRmRedisCache.md) - -[Set-AzureRmRedisCache](./Set-AzureRmRedisCache.md) - - diff --git a/azurermps-6.13.0/AzureRM.RedisCache/Remove-AzureRmRedisCacheDiagnostics.md b/azurermps-6.13.0/AzureRM.RedisCache/Remove-AzureRmRedisCacheDiagnostics.md deleted file mode 100644 index ce28837b7d..0000000000 --- a/azurermps-6.13.0/AzureRM.RedisCache/Remove-AzureRmRedisCacheDiagnostics.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RedisCache.dll-Help.xml -Module Name: AzureRM.RedisCache -ms.assetid: BCF989AE-A718-4AFE-B7C0-8B148468D4EE -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.rediscache/remove-azurermrediscachediagnostics -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/Remove-AzureRmRedisCacheDiagnostics.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/Remove-AzureRmRedisCacheDiagnostics.md ---- - -# Remove-AzureRmRedisCacheDiagnostics - -## SYNOPSIS -Disables diagnostics on an Azure Redis Cache. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmRedisCacheDiagnostics [-ResourceGroupName <String>] -Name <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmRedisCacheDiagnostics** cmdlet disables diagnostics on an Azure Redis Cache. - -## EXAMPLES - -### Example 1: Disable diagnostics -``` -PS C:\>Remove-AzureRmRedisCacheDiagnostics -ResourceGroupName "ContosoResourceGroup" -Name "PeakCache" -Force -``` - -This command disables diagnostics on specified Azure Redis Cache. -This disables diagnostics for all Azure Redis Caches in the same region for the subscription. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the cache. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the cache. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, redis, cache, web, webapp, website - -## RELATED LINKS - -[Set-AzureRmRedisCacheDiagnostics](./Set-AzureRmRedisCacheDiagnostics.md) - - diff --git a/azurermps-6.13.0/AzureRM.RedisCache/Remove-AzureRmRedisCacheFirewallRule.md b/azurermps-6.13.0/AzureRM.RedisCache/Remove-AzureRmRedisCacheFirewallRule.md deleted file mode 100644 index 997bd92f36..0000000000 --- a/azurermps-6.13.0/AzureRM.RedisCache/Remove-AzureRmRedisCacheFirewallRule.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RedisCache.dll-Help.xml -Module Name: AzureRM.RedisCache -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.rediscache/remove-azurermrediscachefirewallrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/Remove-AzureRmRedisCacheFirewallRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/Remove-AzureRmRedisCacheFirewallRule.md ---- - -# Remove-AzureRmRedisCacheFirewallRule - -## SYNOPSIS -Remove a firewall rule from a Redis Cache. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NormalParameterSet (Default) -``` -Remove-AzureRmRedisCacheFirewallRule [-ResourceGroupName <String>] -Name <String> -RuleName <String> - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### PSRedisFirewallRuleObject -``` -Remove-AzureRmRedisCacheFirewallRule -InputObject <PSRedisFirewallRule> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Remove a firewall rule from a Redis Cache. - -## EXAMPLES - -### Example 1: Remove a single firewall rule -``` -PS C:\>Remove-AzureRmRedisCacheFirewallRule -Name "mycache" -RuleName "ruleone" -PassThru -True -``` - -This command removes a firewall rule named ruleone from Redis Cache named mycache. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -object of type PSRedisFirewallRule - -```yaml -Type: Microsoft.Azure.Commands.RedisCache.Models.PSRedisFirewallRule -Parameter Sets: PSRedisFirewallRuleObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of redis cache. - -```yaml -Type: System.String -Parameter Sets: NormalParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Name of resource group in which cache exists. - -```yaml -Type: System.String -Parameter Sets: NormalParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RuleName -Name of firewall rule. - -```yaml -Type: System.String -Parameter Sets: NormalParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.RedisCache.Models.PSRedisFirewallRule -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[New-AzureRmRedisCacheFirewallRule](./New-AzureRmRedisCacheFirewallRule.md) - -[Get-AzureRmRedisCacheFirewallRule](./Get-AzureRmRedisCacheFirewallRule.md) - -[Get-AzureRmRedisCache](./Get-AzureRmRedisCache.md) - -[New-AzureRmRedisCache](./New-AzureRmRedisCache.md) - -[Remove-AzureRmRedisCache](./Remove-AzureRmRedisCache.md) - -[Set-AzureRmRedisCache](./Set-AzureRmRedisCache.md) diff --git a/azurermps-6.13.0/AzureRM.RedisCache/Remove-AzureRmRedisCacheLink.md b/azurermps-6.13.0/AzureRM.RedisCache/Remove-AzureRmRedisCacheLink.md deleted file mode 100644 index 28c7964944..0000000000 --- a/azurermps-6.13.0/AzureRM.RedisCache/Remove-AzureRmRedisCacheLink.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RedisCache.dll-Help.xml -Module Name: AzureRM.RedisCache -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.rediscache/remove-azurermrediscachelink -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/Remove-AzureRmRedisCacheLink.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/Remove-AzureRmRedisCacheLink.md ---- - -# Remove-AzureRmRedisCacheLink - -## SYNOPSIS -Remove a geo replication link between two Redis Caches. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmRedisCacheLink -PrimaryServerName <String> -SecondaryServerName <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Remove a geo replication link between two Redis Caches. - -## EXAMPLES - -### Example 1: Remove a geo replication link -``` -PS C:\>Remove-AzureRmRedisCacheLink -PrimaryServerName "mycache1" -SecondaryServerName "mycache2" -``` - -This command removes a geo-replication links where Redis Cache named mycache1 is primary and Redis Cache named mycache2 is secondary. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimaryServerName -Name of primary redis cache in link. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecondaryServerName -Name of secondary redis cache in link. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[New-AzureRmRedisCacheLink](./New-AzureRmRedisCacheLink.md) - -[Get-AzureRmRedisCacheLink](./Get-AzureRmRedisCacheLink.md) - -[Get-AzureRmRedisCache](./Get-AzureRmRedisCache.md) - -[New-AzureRmRedisCache](./New-AzureRmRedisCache.md) - -[Remove-AzureRmRedisCache](./Remove-AzureRmRedisCache.md) - -[Set-AzureRmRedisCache](./Set-AzureRmRedisCache.md) diff --git a/azurermps-6.13.0/AzureRM.RedisCache/Remove-AzureRmRedisCachePatchSchedule.md b/azurermps-6.13.0/AzureRM.RedisCache/Remove-AzureRmRedisCachePatchSchedule.md deleted file mode 100644 index 63311421cc..0000000000 --- a/azurermps-6.13.0/AzureRM.RedisCache/Remove-AzureRmRedisCachePatchSchedule.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RedisCache.dll-Help.xml -Module Name: AzureRM.RedisCache -ms.assetid: 2EA765B8-D82B-4789-8F10-88F79BDF44D0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.rediscache/remove-azurermrediscachepatchschedule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/Remove-AzureRmRedisCachePatchSchedule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/Remove-AzureRmRedisCachePatchSchedule.md ---- - -# Remove-AzureRmRedisCachePatchSchedule - -## SYNOPSIS -Removes the patch schedule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmRedisCachePatchSchedule [-ResourceGroupName <String>] -Name <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmRedisCachePatchSchedule** cmdlet removes the patch schedule from a cache in Azure Redis Cache. - -## EXAMPLES - -### Example 1: Remove the patch schedule -``` -PS C:\>Remove-AzureRmRedisCachePatchSchedule -ResourceGroupName "ResourceGroup13" -Name "RedisCache06" -``` - -This command removes the patch schedule from the cache named RedisCache06. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a cache. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group which contains the cache. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, redis, cache, web, webapp, website - -## RELATED LINKS - -[Get-AzureRmRedisCachePatchSchedule](./Get-AzureRmRedisCachePatchSchedule.md) - -[New-AzureRmRedisCachePatchSchedule](./New-AzureRmRedisCachePatchSchedule.md) - -[New-AzureRmRedisCacheScheduleEntry](./New-AzureRmRedisCacheScheduleEntry.md) - - diff --git a/azurermps-6.13.0/AzureRM.RedisCache/Reset-AzureRmRedisCache.md b/azurermps-6.13.0/AzureRM.RedisCache/Reset-AzureRmRedisCache.md deleted file mode 100644 index e9dd6a6f7f..0000000000 --- a/azurermps-6.13.0/AzureRM.RedisCache/Reset-AzureRmRedisCache.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RedisCache.dll-Help.xml -Module Name: AzureRM.RedisCache -ms.assetid: A73D4DDD-387A-4468-AC6E-F15BF473527E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.rediscache/reset-azurermrediscache -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/Reset-AzureRmRedisCache.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/Reset-AzureRmRedisCache.md ---- - -# Reset-AzureRmRedisCache - -## SYNOPSIS -Restarts nodes of a cache. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Reset-AzureRmRedisCache [-ResourceGroupName <String>] -Name <String> -RebootType <String> [-ShardId <Int32>] - [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Reset-AzureRmRedisCache** cmdlet restarts nodes of an Azure Redis Cache instance. - -## EXAMPLES - -### Example 1: Restart both nodes -``` -PS C:\>Reset-AzureRmRedisCache -ResourceGroupName "ResourceGroup13" -Name "RedisCache06" -RebootType "AllNodes" -Force -``` - -This command restarts both nodes for the cache named RedisCache06. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a cache. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a Boolean that indicates whether the operation succeeds. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RebootType -Specifies which node or nodes to restart. -The acceptable values for this parameter are: -- PrimaryNode -- SecondaryNode -- AllNodes - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: PrimaryNode, SecondaryNode, AllNodes - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the cache. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ShardId -Specifies the ID of the shard that this cmdlet restarts for a premium cache with clustering enabled. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### System.Boolean - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, redis, cache, web, webapp, website - -## RELATED LINKS - -[Export-AzureRmRedisCache](./Export-AzureRmRedisCache.md) - -[Import-AzureRmRedisCache](./Import-AzureRmRedisCache.md) - -[New-AzureRmRedisCache](./New-AzureRmRedisCache.md) - -[Remove-AzureRmRedisCache](./Remove-AzureRmRedisCache.md) - -[Set-AzureRmRedisCache](./Set-AzureRmRedisCache.md) - - diff --git a/azurermps-6.13.0/AzureRM.RedisCache/Set-AzureRmRedisCache.md b/azurermps-6.13.0/AzureRM.RedisCache/Set-AzureRmRedisCache.md deleted file mode 100644 index a2c2a50e91..0000000000 --- a/azurermps-6.13.0/AzureRM.RedisCache/Set-AzureRmRedisCache.md +++ /dev/null @@ -1,334 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RedisCache.dll-Help.xml -Module Name: AzureRM.RedisCache -ms.assetid: 6234F211-6ED4-443F-9B83-DEB9AC51B763 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.rediscache/set-azurermrediscache -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/Set-AzureRmRedisCache.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/Set-AzureRmRedisCache.md ---- - -# Set-AzureRmRedisCache - -## SYNOPSIS -Modifies a Redis Cache. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmRedisCache [-ResourceGroupName <String>] -Name <String> [-Size <String>] [-Sku <String>] - [-RedisConfiguration <Hashtable>] [-EnableNonSslPort <Boolean>] [-TenantSettings <Hashtable>] - [-ShardCount <Int32>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmRedisCache** cmdlet modifies an Azure Redis Cache. - -## EXAMPLES - -### Example 1: Modify a Redis Cache -``` -PS C:\>Set-AzureRmRedisCache -ResourceGroupName "MyGroup" -Name "MyCache" -RedisConfiguration @{"maxmemory-policy" = "allkeys-random"} - - PrimaryKey : pJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= - SecondaryKey : sJ+jruGKPHDKsEC8kmoybobH3TZx2njBR3ipEsquZFo= - ResourceGroupName : mygroup - Id : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/mygroup/providers/Microsoft.Cache/Redis/myCache - Location : North Central US - Name : MyCache - Type : Microsoft.Cache/Redis - HostName : mycache.redis.cache.windows.net - Port : 6379 - ProvisioningState : creating - SslPort : 6380 - RedisConfiguration : {[maxmemory-policy, allkeys-random]} - EnableNonSslPort : False - RedisVersion : 2.8 - Size : 250MB - Sku : Standard - Tag : {} - Zone : [] -``` - -This command updates the maxmemory-policy for the Redis Cache named MyCache. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableNonSslPort -Indicates whether the non-SSL port is enabled. -The default value is $False (the non-SSL port is disabled). - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Redis Cache to update. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RedisConfiguration -Specifies Redis configuration settings. -The acceptable values for this parameter are: -- rdb-backup-enabled. -Specifies that Redis data persistence is enabled. -Premium tier only. -- rdb-storage-connection-string. -Specifies the connection string to the Storage account for Redis data persistence. -Premium tier only. -- rdb-backup-frequency. -Specifies the backup frequency for Redis data persistence. -Premium tier only. -- maxmemory-reserved. -Configures the memory reserved for non-cache processes. -Standard and Premium tiers. -- maxmemory-policy. -Configures the eviction policy for the cache. -All pricing tiers. -- notify-keyspace-events. -Configures keyspace notifications. -Standard and premium tiers. -- hash-max-ziplist-entries. -Configures memory optimization for small aggregate data types. -Standard and Premium tiers. -- hash-max-ziplist-value. -Configures memory optimization for small aggregate data types. -Standard and Premium tiers. -- set-max-intset-entries. -Configures memory optimization for small aggregate data types. -Standard and Premium tiers. -- zset-max-ziplist-entries. -Configures memory optimization for small aggregate data types. -Standard and Premium tiers. -- zset-max-ziplist-value. -Configures memory optimization for small aggregate data types. -Standard and Premium tiers. -- databases. -Configures the number of databases. -This property can be configured only at cache creation. -Standard and Premium tiers. -For more information, see Manage Azure Redis Cache with Azure PowerShellhttps://go.microsoft.com/fwlink/?LinkId=800051 (https://go.microsoft.com/fwlink/?LinkId=800051). - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the Redis Cache. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ShardCount -Specifies the number of shards to create on a Premium cluster cache. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Size -Specifies the size of the Redis Cache. -Valid values are: -- P1 -- P2 -- P3 -- P4 -- C0 -- C1 -- C2 -- C3 -- C4 -- C5 -- C6 -- 250MB -- 1GB -- 2.5GB -- 6GB -- 13GB -- 26GB -- 53GB -The default value is 1GB or C1. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: P1, P2, P3, P4, C0, C1, C2, C3, C4, C5, C6, 250MB, 1GB, 2.5GB, 6GB, 13GB, 26GB, 53GB - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -Specifies the SKU of the Redis Cache to create. -Valid values are: -- Basic -- Standard -- Premium -The default value is Standard. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Basic, Standard, Premium - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -A hash table which represents tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TenantSettings -This parameter has been deprecated. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.RedisCache.Models.RedisCacheAttributesWithAccessKeys - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRedisCache](./Get-AzureRmRedisCache.md) - -[New-AzureRmRedisCache](./New-AzureRmRedisCache.md) - -[Remove-AzureRmRedisCache](./Remove-AzureRmRedisCache.md) - - diff --git a/azurermps-6.13.0/AzureRM.RedisCache/Set-AzureRmRedisCacheDiagnostics.md b/azurermps-6.13.0/AzureRM.RedisCache/Set-AzureRmRedisCacheDiagnostics.md deleted file mode 100644 index dafef304bd..0000000000 --- a/azurermps-6.13.0/AzureRM.RedisCache/Set-AzureRmRedisCacheDiagnostics.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.RedisCache.dll-Help.xml -Module Name: AzureRM.RedisCache -ms.assetid: FA99C137-68E3-47D3-A0AC-FE33A481BE66 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.rediscache/set-azurermrediscachediagnostics -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/Set-AzureRmRedisCacheDiagnostics.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/RedisCache/Commands.RedisCache/help/Set-AzureRmRedisCacheDiagnostics.md ---- - -# Set-AzureRmRedisCacheDiagnostics - -## SYNOPSIS -Enables diagnostics on an Azure Redis Cache. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmRedisCacheDiagnostics [-ResourceGroupName <String>] -Name <String> -StorageAccountId <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmRedisCacheDiagnostics** cmdlet enables diagnostics for an Azure Redis Cache. - -## EXAMPLES - -### Example 1: Enable diagnostics -``` -PS C:\>Set-AzureRmRedisCacheDiagnostics -ResourceGroupName "ContosoResourceGroup" -Name "PeakCache" -StorageAccountId "/subscriptions/fffff139-aaaa-bbbb-cccc-21f21f35806e/resourcegroups/myresourcegroup/providers/Microsoft.Storage/storageAccounts/mystorageaccount" -``` - -This command enables diagnostics for an Azure Redis cache. -This command will enable diagnostics or update the storage account for all Azure Redis Caches in the same region for the subscription. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the cache. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the cache. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountId -Specifies the resource ID of the storage account used to store the diagnostics data. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, redis, cache, web, webapp, website - -## RELATED LINKS - -[Remove-AzureRmRedisCacheDiagnostics](./Remove-AzureRmRedisCacheDiagnostics.md) - - diff --git a/azurermps-6.13.0/AzureRM.Relay/AzureRM.Relay.md b/azurermps-6.13.0/AzureRM.Relay/AzureRM.Relay.md deleted file mode 100644 index f96b880ba0..0000000000 --- a/azurermps-6.13.0/AzureRM.Relay/AzureRM.Relay.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -Module Name: AzureRm.Relay -Module Guid: 5728d353-7ad5-42d8-b00a-46aaecf07b91 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.relay -Help Version: 4.0.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/AzureRM.Relay.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/AzureRM.Relay.md ---- - -# AzureRm.Relay Module -## Description -List of the cmdlets for Azure Relay - -## AzureRm.Relay Cmdlets -### [Get-AzureRmRelayAuthorizationRule](Get-AzureRmRelayAuthorizationRule.md) -Gets the description of a specified authorization rule for a given Relay entities (Namespace/WcfRelay/HybridConnection). - -### [Get-AzureRmRelayHybridConnection](Get-AzureRmRelayHybridConnection.md) -Gets a description for the specified HybridConnection within the Relay namespace. - -### [Get-AzureRmRelayKey](Get-AzureRmRelayKey.md) -Gets the primary and secondary connection strings for the given Relay entities (Namespace/WcfRelay/HybridConnection). - -### [Get-AzureRmRelayNamespace](Get-AzureRmRelayNamespace.md) -Gets a description for the specified Relay namespace within the resource group. - -### [Get-AzureRmRelayOperation](Get-AzureRmRelayOperation.md) -List supported Relay Operations - -### [Get-AzureRmWcfRelay](Get-AzureRmWcfRelay.md) -Returns a description for the specified WcfRelay. - -### [New-AzureRmRelayAuthorizationRule](New-AzureRmRelayAuthorizationRule.md) -Creates a new authorization rule for the specified Relay entities (Namespace/WcfRelay/HybridConnection). - -### [New-AzureRmRelayHybridConnection](New-AzureRmRelayHybridConnection.md) -Creates a HybridConnection in the specified Relay namespace. - -### [New-AzureRmRelayKey](New-AzureRmRelayKey.md) -Regenerates the primary or secondary connection strings for the given Relay entities (Namespace/WcfRelay/HybridConnection) - -### [New-AzureRmRelayNamespace](New-AzureRmRelayNamespace.md) -Creates a new Relay namespace. - -### [New-AzureRmWcfRelay](New-AzureRmWcfRelay.md) -Creates a WcfRelay in the specified Relay namespace. - -### [Remove-AzureRmRelayAuthorizationRule](Remove-AzureRmRelayAuthorizationRule.md) -Removes the authorization rule of a HybridConnection from the given Relay entities (Namespace/WcfRelay/HybridConnection). - -### [Remove-AzureRmRelayHybridConnection](Remove-AzureRmRelayHybridConnection.md) -Removes the HybridConnection from the specified HybridConnection namespace. - -### [Remove-AzureRmRelayNamespace](Remove-AzureRmRelayNamespace.md) -Removes the namespace from the specified resource group. - -### [Remove-AzureRmWcfRelay](Remove-AzureRmWcfRelay.md) -Removes the WcfRelay from the specified Relay namespace. - -### [Set-AzureRmRelayAuthorizationRule](Set-AzureRmRelayAuthorizationRule.md) -Updates the specified authorization rule description for the given Relay entities (Namespace/WcfRelay/HybridConnection). - -### [Set-AzureRmRelayHybridConnection](Set-AzureRmRelayHybridConnection.md) -Updates the description of a HybridConnection in the specified Relay namespace. - -### [Set-AzureRmRelayNamespace](Set-AzureRmRelayNamespace.md) -Updates the description of an existing Relay namespace. - -### [Set-AzureRmWcfRelay](Set-AzureRmWcfRelay.md) -Updates the description of a WcfRelay in the specified Relay namespace. - -### [Test-AzureRmRelayName](Test-AzureRmRelayName.md) -Checks the Availability of the given NameSpace Name - diff --git a/azurermps-6.13.0/AzureRM.Relay/Get-AzureRmRelayAuthorizationRule.md b/azurermps-6.13.0/AzureRM.Relay/Get-AzureRmRelayAuthorizationRule.md deleted file mode 100644 index a6f2055093..0000000000 --- a/azurermps-6.13.0/AzureRM.Relay/Get-AzureRmRelayAuthorizationRule.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Relay.dll-Help.xml -Module Name: AzureRM.Relay -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.relay/get-azurermrelayauthorizationrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/Get-AzureRmRelayAuthorizationRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/Get-AzureRmRelayAuthorizationRule.md ---- - -# Get-AzureRmRelayAuthorizationRule - -## SYNOPSIS -Gets the description of a specified authorization rule for a given Relay entities (Namespace/WcfRelay/HybridConnection). - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NamespaceAuthorizationRuleSet (Default) -``` -Get-AzureRmRelayAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### WcfRelayAuthorizationRuleSet -``` -Get-AzureRmRelayAuthorizationRule [-ResourceGroupName] <String> [[-Namespace] <String>] [-WcfRelay] <String> - [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### HybridConnectionAuthorizationRuleSet -``` -Get-AzureRmRelayAuthorizationRule [-ResourceGroupName] <String> [[-Namespace] <String>] - [-HybridConnection] <String> [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRelayAuthorizationRule** cmdlet gets the description of the specified authorization rule in the given Relay entities (Namespace/WcfRelay/HybridConnection). - -## EXAMPLES - -### Example 1 - Namespace -``` -PS C:\> Get-AzureRmRelayNamespaceAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 - -Rights : {Listen, Send} -Name : AuthoRule1 -Type : Microsoft.Relay/AuthorizationRules -Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.Relay/namespaces/TestNameSpace-Relay1/AuthorizationRules/Aut - hoRule1 -``` - -Returns the specified authorization rule description for a specified namespace. - -### Example 2 - WcfRelay -``` -PS C:\>Get-AzureRmWcfRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -WcfRelay TestWCFRelay1 -Name AuthoRule1 - -Rights : {Listen, Send} -Name : AuthoRule1 -Type : Microsoft.Relay/AuthorizationRules -Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.Relay/namespaces/TestNameSpace-Relay1/WcfRelays/TestWCFRelay - 1/authorizationRules/AuthoRule1 -``` - -Returns the specified authorization rule description for a given WcfRelay. - -### Example 3 - HybridConnection -``` -PS C:\> Get-AzureRmRelayHybridConnectionAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -HybridConnections TestHybridConnection -Name AuthoRule1 - -Rights : {Listen, Send} -Name : AuthoRule1 -Type : Microsoft.Relay/AuthorizationRules -Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.Relay/namespaces/TestNameSpace-Relay1/HybridConnections/Test - HybridConnection/authorizationRules/AuthoRule1 -``` - -Returns the specified authorization rule description for a given HybridConnection. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HybridConnection -HybridConnection Name. - -```yaml -Type: System.String -Parameter Sets: HybridConnectionAuthorizationRuleSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -AuthorizationRule Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name. - -```yaml -Type: System.String -Parameter Sets: NamespaceAuthorizationRuleSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: WcfRelayAuthorizationRuleSet, HybridConnectionAuthorizationRuleSet -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WcfRelay -WcfRelay Name. - -```yaml -Type: System.String -Parameter Sets: WcfRelayAuthorizationRuleSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - - -## OUTPUTS - -### Microsoft.Azure.Commands.Relay.Models.PSAuthorizationRuleAttributes - - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Relay/Get-AzureRmRelayHybridConnection.md b/azurermps-6.13.0/AzureRM.Relay/Get-AzureRmRelayHybridConnection.md deleted file mode 100644 index de3a4a2df8..0000000000 --- a/azurermps-6.13.0/AzureRM.Relay/Get-AzureRmRelayHybridConnection.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Relay.dll-Help.xml -Module Name: AzureRM.Relay -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.relay/get-azurermrelayhybridconnection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/Get-AzureRmRelayHybridConnection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/Get-AzureRmRelayHybridConnection.md ---- - -# Get-AzureRmRelayHybridConnection - -## SYNOPSIS -Gets a description for the specified HybridConnection within the Relay namespace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmRelayHybridConnection [-ResourceGroupName] <String> [-Namespace] <String> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRelayHybridConnection** cmdlet gets a description for the specified HybridConnection within the Relay namespace. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-AzureRmRelayHybridConnection -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name TestHybridConnection - -CreatedAt : 4/12/2017 3:17:02 AM -UpdatedAt : 4/12/2017 3:17:02 AM -ListenerCount : 0 -RequiresClientAuthorization : True -UserMetadata : User Meta data -Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.Relay/namespaces/TestNameSpace-Relay1/H - ybridConnections/TestHybridConnection -Name : TestHybridConnection -Type : Microsoft.Relay/HybridConnections -``` - -Returns the description of the HybridConnection. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -HybridConnections Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - - -## OUTPUTS - -### Microsoft.Azure.Commands.Relay.Models.PSHybridConnectionAttibutes - - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Relay/Get-AzureRmRelayKey.md b/azurermps-6.13.0/AzureRM.Relay/Get-AzureRmRelayKey.md deleted file mode 100644 index 224c0ce310..0000000000 --- a/azurermps-6.13.0/AzureRM.Relay/Get-AzureRmRelayKey.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Relay.dll-Help.xml -Module Name: AzureRM.Relay -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.relay/get-azurermrelaykey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/Get-AzureRmRelayKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/Get-AzureRmRelayKey.md ---- - -# Get-AzureRmRelayKey - -## SYNOPSIS -Gets the primary and secondary connection strings for the given Relay entities (Namespace/WcfRelay/HybridConnection). - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NamespaceAuthorizationRuleSet (Default) -``` -Get-AzureRmRelayKey [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### WcfRelayAuthorizationRuleSet -``` -Get-AzureRmRelayKey [-ResourceGroupName] <String> [[-Namespace] <String>] [-WcfRelay] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### HybridConnectionAuthorizationRuleSet -``` -Get-AzureRmRelayKey [-ResourceGroupName] <String> [[-Namespace] <String>] [-HybridConnection] <String> - [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRelayKey** cmdlet returns the primary and secondary connection strings for the given Relay entities (Namespace/WcfRelay/HybridConnection). - -## EXAMPLES - -### Example 1 - Namespace -``` -PS C:\> Get-AzureRmRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 - -PrimaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=############################################ -SecondaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=############################################ -PrimaryKey : ############################################ -SecondaryKey : ############################################ -KeyName : AuthoRule1 -``` - -### Example 2 - WcfRelay -``` -PS C:\> Get-AzureRmRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -WcfRelay TestWCFRelay1 -Name AuthoRule1 - -PrimaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=############################################;EntityPath=TestWCFRelay1 -SecondaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=############################################;EntityPath=TestWCFRelay1 -PrimaryKey : ############################################ -SecondaryKey : ############################################ -KeyName : AuthoRule1 -``` - -### Example 3 - HybridConnection -``` -PS C:\> Get-AzureRmRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -HybridConnection TestHybridConnection -Name AuthoRule1 - -PrimaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=############################################;EntityPath=TestHybridConnection -SecondaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=############################################;EntityPath=TestHybridConnection -PrimaryKey : ############################################ -SecondaryKey : ############################################ -KeyName : AuthoRule1 -``` - -Primary and secondary connection string to the specified Relay entities (Namespace/WcfRelay/HybridConnection). - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HybridConnection -HybridConnection Name. - -```yaml -Type: System.String -Parameter Sets: HybridConnectionAuthorizationRuleSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -AuthorizationRule Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name. - -```yaml -Type: System.String -Parameter Sets: NamespaceAuthorizationRuleSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: WcfRelayAuthorizationRuleSet, HybridConnectionAuthorizationRuleSet -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WcfRelay -WcfRelay Name. - -```yaml -Type: System.String -Parameter Sets: WcfRelayAuthorizationRuleSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - - -## OUTPUTS - -### Microsoft.Azure.Commands.Relay.Models.PSAuthorizationRuleKeysAttributes - - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Relay/Get-AzureRmRelayNamespace.md b/azurermps-6.13.0/AzureRM.Relay/Get-AzureRmRelayNamespace.md deleted file mode 100644 index d094841150..0000000000 --- a/azurermps-6.13.0/AzureRM.Relay/Get-AzureRmRelayNamespace.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Relay.dll-Help.xml -Module Name: AzureRM.Relay -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.relay/get-azurermrelaynamespace -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/Get-AzureRmRelayNamespace.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/Get-AzureRmRelayNamespace.md ---- - -# Get-AzureRmRelayNamespace - -## SYNOPSIS -Gets a description for the specified Relay namespace within the resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmRelayNamespace [[-ResourceGroupName] <String>] [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRelayNamespace** cmdlet gets a description for the specified Relay namespace within the resource group. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmRelayNamespace -ResourceGroupName Default-ServiceBus-WestUS -Name TestNameSpace-Relay1 - -ProvisioningState : Succeeded -CreatedAt : 4/12/2017 12:38:47 AM -UpdatedAt : 4/12/2017 12:39:10 AM -ServiceBusEndpoint : https://TestNameSpace-Relay1.servicebus.windows.net:443/ -MetricId : 854d368f-1828-428f-8f3c-f2affa9b2f7d:testnamespace-relay1 -Location : West US -Tags : {[tag1, Tag1Value]} -Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.Relay/namespaces/TestNameSpace-Relay1 -Name : TestNameSpace-Relay1 -Type : Microsoft.Relay/namespaces -``` - -Returns a description of the specified Relay namespace. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Relay Namespace Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - - -## OUTPUTS - -### Microsoft.Azure.Commands.Relay.Models.PSRelayNamespaceAttributes - - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Relay/Get-AzureRmRelayOperation.md b/azurermps-6.13.0/AzureRM.Relay/Get-AzureRmRelayOperation.md deleted file mode 100644 index 039066acbc..0000000000 --- a/azurermps-6.13.0/AzureRM.Relay/Get-AzureRmRelayOperation.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Relay.dll-Help.xml -Module Name: AzureRM.Relay -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.relay/get-azurermrelayoperation -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/Get-AzureRmRelayOperation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/Get-AzureRmRelayOperation.md ---- - -# Get-AzureRmRelayOperation - -## SYNOPSIS -List supported Relay Operations - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmRelayOperation [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRelayOperation** cmdlet Lists the Relay supported Operations. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmRelayOperation - -Name Display ----- ------- -Microsoft.Relay/checkNamespaceAvailability/action Microsoft.Azure.Commands.Relay.Models.OperationDisplayAttributes -Microsoft.Relay/register/action Microsoft.Azure.Commands.Relay.Models.OperationDisplayAttributes -Microsoft.Relay/namespaces/write Microsoft.Azure.Commands.Relay.Models.OperationDisplayAttributes -Microsoft.Relay/namespaces/read Microsoft.Azure.Commands.Relay.Models.OperationDisplayAttributes -Microsoft.Relay/namespaces/Delete Microsoft.Azure.Commands.Relay.Models.OperationDisplayAttributes -Microsoft.Relay/namespaces/authorizationRules/write Microsoft.Azure.Commands.Relay.Models.OperationDisplayAttributes -Microsoft.Relay/namespaces/authorizationRules/delete Microsoft.Azure.Commands.Relay.Models.OperationDisplayAttributes -Microsoft.Relay/namespaces/authorizationRules/listkeys/action Microsoft.Azure.Commands.Relay.Models.OperationDisplayAttributes -Microsoft.Relay/namespaces/HybridConnections/write Microsoft.Azure.Commands.Relay.Models.OperationDisplayAttributes -Microsoft.Relay/namespaces/HybridConnections/read Microsoft.Azure.Commands.Relay.Models.OperationDisplayAttributes -Microsoft.Relay/namespaces/HybridConnections/Delete Microsoft.Azure.Commands.Relay.Models.OperationDisplayAttributes -Microsoft.Relay/namespaces/HybridConnections/authorizationRules/write Microsoft.Azure.Commands.Relay.Models.OperationDisplayAttributes -Microsoft.Relay/namespaces/HybridConnections/authorizationRules/delete Microsoft.Azure.Commands.Relay.Models.OperationDisplayAttributes -Microsoft.Relay/namespaces/HybridConnections/authorizationRules/listkeys/action Microsoft.Azure.Commands.Relay.Models.OperationDisplayAttributes -Microsoft.Relay/namespaces/WcfRelays/write Microsoft.Azure.Commands.Relay.Models.OperationDisplayAttributes -Microsoft.Relay/namespaces/WcfRelays/read Microsoft.Azure.Commands.Relay.Models.OperationDisplayAttributes -Microsoft.Relay/namespaces/WcfRelays/Delete Microsoft.Azure.Commands.Relay.Models.OperationDisplayAttributes -Microsoft.Relay/namespaces/WcfRelays/authorizationRules/write Microsoft.Azure.Commands.Relay.Models.OperationDisplayAttributes -Microsoft.Relay/namespaces/WcfRelays/authorizationRules/delete Microsoft.Azure.Commands.Relay.Models.OperationDisplayAttributes -Microsoft.Relay/namespaces/WcfRelays/authorizationRules/listkeys/action Microsoft.Azure.Commands.Relay.Models.OperationDisplayAttributes -``` - -Lists Relay supported operations - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - - -## OUTPUTS - -### Microsoft.Azure.Commands.Relay.Models.PSOperationAttributes - - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Relay/Get-AzureRmWcfRelay.md b/azurermps-6.13.0/AzureRM.Relay/Get-AzureRmWcfRelay.md deleted file mode 100644 index 2d994b44b5..0000000000 --- a/azurermps-6.13.0/AzureRM.Relay/Get-AzureRmWcfRelay.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Relay.dll-Help.xml -Module Name: AzureRM.Relay -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.relay/get-azurermwcfrelay -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/Get-AzureRmWcfRelay.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/Get-AzureRmWcfRelay.md ---- - -# Get-AzureRmWcfRelay - -## SYNOPSIS -Returns a description for the specified WcfRelay. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmWcfRelay [-ResourceGroupName] <String> [-Namespace] <String> [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmWcfRelay** cmdlet returns a description of the specified WcfRelay. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmWcfRelay -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name TestWCFRelay1 - -RelayType : NetTcp -CreatedAt : 4/12/2017 2:23:08 AM -UpdatedAt : 4/12/2017 2:23:08 AM -ListenerCount : 0 -RequiresClientAuthorization : True -RequiresTransportSecurity : True -IsDynamic : False -UserMetadata : User Meta data -Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.Relay/namespaces/TestNameSpace-Relay1/W - cfRelays/TestWCFRelay1 -Name : TestWCFRelay1 -Type : Microsoft.Relay/WcfRelays -``` - -Returns the description of the WcfRelay. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WcfRelay Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - - -## OUTPUTS - -### Microsoft.Azure.Commands.Relay.Models.PSWcfRelayAttributes - - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Relay/New-AzureRmRelayAuthorizationRule.md b/azurermps-6.13.0/AzureRM.Relay/New-AzureRmRelayAuthorizationRule.md deleted file mode 100644 index 62ebbee2c8..0000000000 --- a/azurermps-6.13.0/AzureRM.Relay/New-AzureRmRelayAuthorizationRule.md +++ /dev/null @@ -1,249 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Relay.dll-Help.xml -Module Name: AzureRM.Relay -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.relay/new-azurermrelayauthorizationrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/New-AzureRmRelayAuthorizationRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/New-AzureRmRelayAuthorizationRule.md ---- - -# New-AzureRmRelayAuthorizationRule - -## SYNOPSIS -Creates a new authorization rule for the specified Relay entities (Namespace/WcfRelay/HybridConnection). - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NamespaceAuthorizationRuleSet (Default) -``` -New-AzureRmRelayAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - -Rights <String[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### WcfRelayAuthorizationRuleSet -``` -New-AzureRmRelayAuthorizationRule [-ResourceGroupName] <String> [[-Namespace] <String>] [-WcfRelay] <String> - [-Name] <String> -Rights <String[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### HybridConnectionAuthorizationRuleSet -``` -New-AzureRmRelayAuthorizationRule [-ResourceGroupName] <String> [[-Namespace] <String>] - [-HybridConnection] <String> [-Name] <String> -Rights <String[]> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmRelayAuthorizationRule** cmdlet creates a new authorization rule for the specified Relay entities (Namespace/WcfRelay/HybridConnection). - -## EXAMPLES - -### Example 1 - Namespace -``` -PS C:\>New-AzureRmRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -Rights "Listen" - -Rights : {Listen} -Name : AuthoRule1 -Type : Microsoft.Relay/AuthorizationRules -Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.Relay/namespaces/TestNameSpace-Relay1/AuthorizationRules/AuthoRule1 -``` - -Creates `AuthoRule1` with **Listen** rights for the namespace `TestNameSpace-Relay1`. - -### Example 2 - WcfRelay -``` -PS C:\>New-AzureRmRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -WcfRelay TestWCFRelay1 -Name AuthoRule1 -Rights "Listen" - -Rights : {Listen} -Name : AuthoRule1 -Type : Microsoft.Relay/AuthorizationRules -Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.Relay/namespaces/TestNameSpace-Relay1/WcfRelays/TestWCFRelay1/authorizationRules/AuthoRule1 -``` - -Creates authorization rule `AuthoRule1` with **Listen** rights for the WcfRelay `TestWCFRelay1`. - -### Example 3 - HybridConnection -``` -PS C:\>New-AzureRmRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -HybridConnection TestHybridConnection -Name AuthoRule1 -Rights "Listen" - -Rights : {Listen} -Name : AuthoRule1 -Type : Microsoft.Relay/AuthorizationRules -Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.Relay/namespaces/TestNameSpace-Relay1/HybridConnections/TestHybridConnection/authorizationRules/AuthoRule1 -``` - -Creates `AuthoRule1` with **Listen** rights for the Hybrid Connection `TestHybridConnection`. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HybridConnection -HybridConnection Name. - -```yaml -Type: System.String -Parameter Sets: HybridConnectionAuthorizationRuleSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -AuthorizationRule Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name. - -```yaml -Type: System.String -Parameter Sets: NamespaceAuthorizationRuleSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: WcfRelayAuthorizationRuleSet, HybridConnectionAuthorizationRuleSet -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Rights -Rights, e.g. -"Listen","Send","Manage" - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: -Accepted values: Listen, Send, Manage - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WcfRelay -WcfRelay Name. - -```yaml -Type: System.String -Parameter Sets: WcfRelayAuthorizationRuleSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -System.String[] - - -## OUTPUTS - -### Microsoft.Azure.Commands.Relay.Models.PSAuthorizationRuleAttributes - - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Relay/New-AzureRmRelayHybridConnection.md b/azurermps-6.13.0/AzureRM.Relay/New-AzureRmRelayHybridConnection.md deleted file mode 100644 index 05ab979ad0..0000000000 --- a/azurermps-6.13.0/AzureRM.Relay/New-AzureRmRelayHybridConnection.md +++ /dev/null @@ -1,234 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Relay.dll-Help.xml -Module Name: AzureRM.Relay -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.relay/new-azurermrelayhybridconnection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/New-AzureRmRelayHybridConnection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/New-AzureRmRelayHybridConnection.md ---- - -# New-AzureRmRelayHybridConnection - -## SYNOPSIS -Creates a HybridConnection in the specified Relay namespace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### HybridConnectionInputObjectSet -``` -New-AzureRmRelayHybridConnection [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - [-InputObject <HybridConnectionAttibutes>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### HybridConnectionPropertiesSet -``` -New-AzureRmRelayHybridConnection [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - [-RequiresClientAuthorization <Boolean>] [-UserMetadata <String>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmRelayHybridConnection cmdlet creates a HybridConnection in the specified Relay namespace. - -## EXAMPLES - -### Example 1 - InputObject -``` -PS C:\> $getHybirdConnection = Get-AzureRmRelayHybridConnection -ResourceGroupName Default-ServiceBus-WestUS -NamespaceName TestNameSpace-HybirdConnection -Name TestHybirdConnection1 -PS C:\> $getHybirdConnection.UserMetadata = "TestHybirdConnection2" -PS C:\> $getHybirdConnection.RequiresClientAuthorization = $False -PS C:\> New-AzureRmRelayHybridConnection -ResourceGroupName Default-Storage-WestUS -Namespace TestNameSpace-HybirdConnection -Name TestHybirdConnection2 -InputObject $getHybirdConnection - -CreatedAt : 4/26/2017 10:04:15 PM -UpdatedAt : 4/26/2017 10:04:15 PM -ListenerCount : -RequiresClientAuthorization : True -UserMetadata : User Meta data -Id : /subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/Default-ServiceBus-WestUS - /providers/Microsoft.Relay/namespaces/TestNameSpace-HybirdConnection/HybridConnections/TestHybirdConnectio - n2 -Name : TestHybirdConnection2 -Type : Microsoft.Relay/HybridConnections -``` - -Creates a new HybirdConnection \`TestHybirdConnection2\` in the specified Relay namespace \`TestNameSpace-HybirdConnection\`. - -### Example 2 - Properties -``` -PS C:\> New-AzureRmWcfRelay -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-HybirdConnection -Name TestHybirdConnection1 -RequiresClientAuthorization $True -UserMetadata "User Meta data" - -CreatedAt : 4/26/2017 10:04:15 PM -UpdatedAt : 4/26/2017 10:04:15 PM -ListenerCount : -RequiresClientAuthorization : True -UserMetadata : User Meta data -Id : /subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/Default-ServiceBus-WestUS - /providers/Microsoft.Relay/namespaces/TestNameSpace-HybirdConnection/HybridConnections/TestHybirdConnectio - n1 -Name : TestHybirdConnection1 -Type : Microsoft.Relay/HybridConnections -``` - -Creates a new HybirdConnection \`TestHybirdConnection1\` in the specified Relay namespace \`TestNameSpace-HybirdConnection\`. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -HybridConnections object. - -```yaml -Type: Microsoft.Azure.Commands.Relay.Models.PSHybridConnectionAttibutes -Parameter Sets: HybridConnectionInputObjectSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -HybridConnections Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RequiresClientAuthorization -true if client authorization is needed for this HybridConnections; otherwise, false - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: HybridConnectionPropertiesSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserMetadata -Gets or sets usermetadata is a placeholder to store user-defined string data for the HybridConnection endpoint.e.g. -it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored. - -```yaml -Type: System.String -Parameter Sets: HybridConnectionPropertiesSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Microsoft.Azure.Commands.Relay.Models.PSHybridConnectionAttibutes -System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - - -## OUTPUTS - -### Microsoft.Azure.Commands.Relay.Models.PSHybridConnectionAttibutes - - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Relay/New-AzureRmRelayKey.md b/azurermps-6.13.0/AzureRM.Relay/New-AzureRmRelayKey.md deleted file mode 100644 index 9a04c5f542..0000000000 --- a/azurermps-6.13.0/AzureRM.Relay/New-AzureRmRelayKey.md +++ /dev/null @@ -1,311 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Relay.dll-Help.xml -Module Name: AzureRM.Relay -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.relay/new-azurermrelaykey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/New-AzureRmRelayKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/New-AzureRmRelayKey.md ---- - -# New-AzureRmRelayKey - -## SYNOPSIS -Regenerates the primary or secondary connection strings for the given Relay entities (Namespace/WcfRelay/HybridConnection) - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NamespaceAuthorizationRuleSet (Default) -``` -New-AzureRmRelayKey [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - -RegenerateKey <String> [-KeyValue <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### WcfRelayAuthorizationRuleSet -``` -New-AzureRmRelayKey [-ResourceGroupName] <String> [[-Namespace] <String>] [-WcfRelay] <String> [-Name] <String> - -RegenerateKey <String> [-KeyValue <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### HybridConnectionAuthorizationRuleSet -``` -New-AzureRmRelayKey [-ResourceGroupName] <String> [[-Namespace] <String>] [-HybridConnection] <String> - [-Name] <String> -RegenerateKey <String> [-KeyValue <String>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmRelayKey** cmdlet generates the primary and secondary connection strings for the given Relay entities (Namespace/WcfRelay/HybridConnection). - -## EXAMPLES - -### Example 1 - Namespace -``` -PS C:\> New-AzureRmRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -RegenerateKeys PrimaryKey - -PS C:\> New-AzureRmRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -RegenerateKeys SecondaryKey - -PrimaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=############################################ -SecondaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=############################################ -PrimaryKey : ############################################ -SecondaryKey : ############################################ -KeyName : AuthoRule1 -``` -Regenerates the primary or secondary connection strings for the given Relay-Namespace entity. - -### Example 1.1 - Namespace KeyValue Provided -``` -PS C:\> New-AzureRmRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -RegenerateKeys PrimaryKey -KeyValue ############### - -PS C:\> New-AzureRmRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -RegenerateKeys SecondaryKey -KeyValue ############### - -PrimaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=############################################ -SecondaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=############################################ -PrimaryKey : ############################################ -SecondaryKey : ############################################ -KeyName : AuthoRule1 -``` -generates the primary or secondary connection strings for the given Relay-Namespace entity with Key Value Provided - -### Example 2 - WcfRelay -``` -PS C:\> New-AzureRmRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -WcfRelay TestWCFRelay1 -RegenerateKeys PrimaryKey - -PS C:\> New-AzureRmRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -WcfRelay TestWCFRelay1 -RegenerateKeys SecondaryKey - -PrimaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=############################################;EntityPath=TestWCFRelay1 -SecondaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=############################################;EntityPath=TestWCFRelay1 -PrimaryKey : ############################################ -SecondaryKey : ############################################ -KeyName : AuthoRule1 -``` -Regenerates the primary or secondary connection strings for the given Relay-WcfRelay entity. - -### Example 2.1 - WcfRelay KeyValue Provided -``` -PS C:\> New-AzureRmRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -WcfRelay TestWCFRelay1 -RegenerateKeys PrimaryKey -KeyValue ############### - -PS C:\> New-AzureRmRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -WcfRelay TestWCFRelay1 -RegenerateKeys SecondaryKey -KeyValue ############### - -PrimaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=############################################;EntityPath=TestWCFRelay1 -SecondaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=############################################;EntityPath=TestWCFRelay1 -PrimaryKey : ############################################ -SecondaryKey : ############################################ -KeyName : AuthoRule1 -``` -generates the primary or secondary connection strings for the given Relay-WcfRelay entity with Key Value Provided - -### Example 3 - HybridConnection -``` -PS C:\> New-AzureRmRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -HybridConnection TestHybridConnection -RegenerateKeys PrimaryKey - -PS C:\> New-AzureRmRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -HybridConnection TestHybridConnection -RegenerateKeys SecondaryKey - -PrimaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=############################################;EntityPath=TestHybridConnection -SecondaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=############################################;EntityPath=TestHybridConnection -PrimaryKey : ############################################ -SecondaryKey : ############################################ -KeyName : AuthoRule1 -``` -Regenerates the primary or secondary connection strings for the given Relay entities (Namespace/WcfRelay/HybridConnection). - -### Example 3.1 - HybridConnection KeyValue Provided -``` -PS C:\> New-AzureRmRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -HybridConnection TestHybridConnection -RegenerateKeys PrimaryKey -KeyValue ############### - -PS C:\> New-AzureRmRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -HybridConnection TestHybridConnection -RegenerateKeys SecondaryKey -KeyValue ############### - -PrimaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=############################################;EntityPath=TestHybridConnection -SecondaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=############################################;EntityPath=TestHybridConnection -PrimaryKey : ############################################ -SecondaryKey : ############################################ -KeyName : AuthoRule1 -``` -generates the primary or secondary connection strings for the given Relay-HybridConnection entity with Key Value Provided - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HybridConnection -HybridConnection Name. - -```yaml -Type: System.String -Parameter Sets: HybridConnectionAuthorizationRuleSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyValue -A base64-encoded 256-bit key for signing and validating the SAS token. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -AuthorizationRule Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name. - -```yaml -Type: System.String -Parameter Sets: NamespaceAuthorizationRuleSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: WcfRelayAuthorizationRuleSet, HybridConnectionAuthorizationRuleSet -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RegenerateKey -Regenerate Keys - 'PrimaryKey'/'SecondaryKey'. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: PrimaryKey, SecondaryKey - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WcfRelay -WcfRelay Name. - -```yaml -Type: System.String -Parameter Sets: WcfRelayAuthorizationRuleSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - - -## OUTPUTS - -### Microsoft.Azure.Commands.Relay.Models.PSAuthorizationRuleKeysAttributes - - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Relay/New-AzureRmRelayNamespace.md b/azurermps-6.13.0/AzureRM.Relay/New-AzureRmRelayNamespace.md deleted file mode 100644 index 6cbe885ee1..0000000000 --- a/azurermps-6.13.0/AzureRM.Relay/New-AzureRmRelayNamespace.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Relay.dll-Help.xml -Module Name: AzureRM.Relay -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.relay/new-azurermrelaynamespace -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/New-AzureRmRelayNamespace.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/New-AzureRmRelayNamespace.md ---- - -# New-AzureRmRelayNamespace - -## SYNOPSIS -Creates a new Relay namespace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmRelayNamespace [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> - [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmRelayNamespace** cmdlet creates a new Relay namespace. Once created, the namespace -resource manifest is immutable. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmRelayNamespace -ResourceGroupName Default-ServiceBus-WestUS -Name TestNameSpace-Relay1 -Location "West US" -Tag @{Tag1="Tag1Value"} - -ProvisioningState : Succeeded -CreatedAt : 4/12/2017 12:38:47 AM -UpdatedAt : 4/12/2017 12:39:10 AM -ServiceBusEndpoint : https://TestNameSpace-Relay1.servicebus.windows.net:443/ -MetricId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX:testnamespace-relay1 -Location : West US -Tags : {[tag1, Tag1Value]} -Id : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.Relay/namespaces/TestNameSpace-Relay1 -Name : TestNameSpace-Relay1 -Type : Microsoft.Relay/namespaces -``` - -Creates a new Relay namespace within the specified resource group. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Relay Namespace Location. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Relay Namespace Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Hashtables which represents resource Tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -System.Collections.Hashtable - - -## OUTPUTS - -### Microsoft.Azure.Commands.Relay.Models.PSRelayNamespaceAttributes - - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Relay/New-AzureRmWcfRelay.md b/azurermps-6.13.0/AzureRM.Relay/New-AzureRmWcfRelay.md deleted file mode 100644 index 35c18e337f..0000000000 --- a/azurermps-6.13.0/AzureRM.Relay/New-AzureRmWcfRelay.md +++ /dev/null @@ -1,271 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Relay.dll-Help.xml -Module Name: AzureRM.Relay -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.relay/new-azurermwcfrelay -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/New-AzureRmWcfRelay.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/New-AzureRmWcfRelay.md ---- - -# New-AzureRmWcfRelay - -## SYNOPSIS -Creates a WcfRelay in the specified Relay namespace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### WcfRelayInputObjectSet -``` -New-AzureRmWcfRelay [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - [-InputObject <WcfRelayAttributes>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### WcfRelayPropertiesSet -``` -New-AzureRmWcfRelay [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - [-WcfRelayType <String>] [-RequiresClientAuthorization <Boolean>] [-RequiresTransportSecurity <Boolean>] - [-UserMetadata <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmWcfRelay cmdlet creates a WcfRelay in the specified Relay namespace. - -## EXAMPLES - -### Example 1 - InputObject -``` -PS C:\> $getWcfRelay = Get-AzureRmWcfRelay -ResourceGroupName Default-ServiceBus-WestUS -NamespaceName TestNameSpace-Relay1 -WcfRelayName TestWCFRelay1 -PS C:\> $GetWcfRelay.UserMetadata = "TestWCFRelay2" -PS C:\> $GetWcfRelay.RequiresClientAuthorization = $False -PS C:\> $GetWcfRelay.RelayType = "Http" -PS C:\> New-AzureRmWcfRelay -ResourceGroupName Default-Storage-WestUS -Namespace TestNameSpace-Relay1 -Name TestWCFRelay2 -InputObject - -RelayType : Http -CreatedAt : 4/26/2017 5:14:46 PM -UpdatedAt : 4/26/2017 5:14:46 PM -ListenerCount : -RequiresClientAuthorization : False -RequiresTransportSecurity : True -IsDynamic : False -UserMetadata : TestWCFRelay2 -Id : /subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/Default-Storage-WestUS/providers/Microsoft.Rel - ay/namespaces/TestNameSpace-Relay1/WcfRelays/TestWCFRelay2 -Name : TestWCFRelay2 -Type : Microsoft.Relay/WcfRelays -``` - -Creates a new WcfRelay \`TestWCFRelay2\` in the specified Relay namespace \`TestNameSpace-Relay\`. - -### Example 2 - Properties -``` -PS C:\> New-AzureRmWcfRelay -ResourceGroupName Default-Storage-WestUS -Namespace TestNameSpace-Relay1 -Name TestWCFRelay -WcfRelayType "NetTcp" -RequiresClientAuthorization $True -RequiresTransportSecurity $True -UserMetadata "User Meta data" - -RelayType : NetTcp -CreatedAt : 4/26/2017 5:20:08 PM -UpdatedAt : 4/26/2017 5:20:08 PM -ListenerCount : -RequiresClientAuthorization : True -RequiresTransportSecurity : True -IsDynamic : False -UserMetadata : User Meta data -Id : /subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/Default-Storage-WestUS/providers/Microsoft.Rel - ay/namespaces/TestNameSpace-Relay1/WcfRelays/TestWCFRelay -Name : TestWCFRelay -Type : Microsoft.Relay/WcfRelays -``` - -Creates a new WcfRelay \`TestWCFRelay\` in the specified Relay namespace \`TestNameSpace-Relay1\`. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -WcfRelay object. - -```yaml -Type: Microsoft.Azure.Commands.Relay.Models.PSWcfRelayAttributes -Parameter Sets: WcfRelayInputObjectSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -WcfRelay Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RequiresClientAuthorization -true if client authorization is needed for this relay; otherwise, false - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: WcfRelayPropertiesSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RequiresTransportSecurity -true if transport security is needed for this relay; otherwise, false - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: WcfRelayPropertiesSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserMetadata -Gets or sets usermetadata is a placeholder to store user-defined string data for the HybridConnection endpoint.e.g. -it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored. - -```yaml -Type: System.String -Parameter Sets: WcfRelayPropertiesSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WcfRelayType -WcfRelay Type. -Possible values include: 'NetTcp' or 'Http' - -```yaml -Type: System.String -Parameter Sets: WcfRelayPropertiesSet -Aliases: -Accepted values: NetTcp, Http - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Microsoft.Azure.Commands.Relay.Models.PSWcfRelayAttributes -System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - - -## OUTPUTS - -### Microsoft.Azure.Commands.Relay.Models.PSWcfRelayAttributes - - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Relay/Remove-AzureRmRelayAuthorizationRule.md b/azurermps-6.13.0/AzureRM.Relay/Remove-AzureRmRelayAuthorizationRule.md deleted file mode 100644 index c7b71b85ea..0000000000 --- a/azurermps-6.13.0/AzureRM.Relay/Remove-AzureRmRelayAuthorizationRule.md +++ /dev/null @@ -1,246 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Relay.dll-Help.xml -Module Name: AzureRM.Relay -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.relay/remove-azurermrelayauthorizationrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/Remove-AzureRmRelayAuthorizationRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/Remove-AzureRmRelayAuthorizationRule.md ---- - -# Remove-AzureRmRelayAuthorizationRule - -## SYNOPSIS -Removes the authorization rule of a HybridConnection from the given Relay entities (Namespace/WcfRelay/HybridConnection). - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NamespaceAuthorizationRuleSet (Default) -``` -Remove-AzureRmRelayAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### WcfRelayAuthorizationRuleSet -``` -Remove-AzureRmRelayAuthorizationRule [-ResourceGroupName] <String> [[-Namespace] <String>] [-WcfRelay] <String> - [-Name] <String> [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### HybridConnectionAuthorizationRuleSet -``` -Remove-AzureRmRelayAuthorizationRule [-ResourceGroupName] <String> [[-Namespace] <String>] - [-HybridConnection] <String> [-Name] <String> [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmRelayAuthorizationRule** cmdlet removes the authorization rule of the given Relay entities (Namespace/WcfRelay/HybridConnection). - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -``` - -Removes the authorization rule `AuthoRule1` of the namespace `TestNameSpace-Relay1`. - -### Example 2 -``` -PS C:\> Remove-AzureRmRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -WcfRelay TestWcfRelay -Name AuthoRule1 -``` - -Removes the authorization rule `AuthoRule1` of the WcfRelay `TestWcfRelay` from the namespace `TestNameSpace-Relay1`. - -### Example 3 -``` -PS C:\> Remove-AzureRmRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -HybridConnection TestHybridConnection -Name AuthoRule1 -``` - -Removes the authorization rule `AuthoRule1` of the HybridConnection `TestHybridConnection` from the namespace `TestNameSpace-Relay1`. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HybridConnection -HybridConnection Name. - -```yaml -Type: System.String -Parameter Sets: HybridConnectionAuthorizationRuleSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -AuthorizationRule Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name. - -```yaml -Type: System.String -Parameter Sets: NamespaceAuthorizationRuleSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: WcfRelayAuthorizationRuleSet, HybridConnectionAuthorizationRuleSet -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WcfRelay -WcfRelay Name. - -```yaml -Type: System.String -Parameter Sets: WcfRelayAuthorizationRuleSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - - -## OUTPUTS - -### System.Boolean - - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Relay/Remove-AzureRmRelayHybridConnection.md b/azurermps-6.13.0/AzureRM.Relay/Remove-AzureRmRelayHybridConnection.md deleted file mode 100644 index f68145f316..0000000000 --- a/azurermps-6.13.0/AzureRM.Relay/Remove-AzureRmRelayHybridConnection.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Relay.dll-Help.xml -Module Name: AzureRM.Relay -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.relay/remove-azurermrelayhybridconnection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/Remove-AzureRmRelayHybridConnection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/Remove-AzureRmRelayHybridConnection.md ---- - -# Remove-AzureRmRelayHybridConnection - -## SYNOPSIS -Removes the HybridConnection from the specified HybridConnection namespace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmRelayHybridConnection [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmRelayHybridConnection** cmdlet removes the HybridConnection from the specified Relay namespace. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmRelayHybridConnection -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name TestHybridConnection -``` - -Removes the HybridConnection `TestHybridConnection` from the namespace `TestNameSpace-Relay1`. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -HybridConnections Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - - -## OUTPUTS - -### System.Void - - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Relay/Remove-AzureRmRelayNamespace.md b/azurermps-6.13.0/AzureRM.Relay/Remove-AzureRmRelayNamespace.md deleted file mode 100644 index 24fc84340e..0000000000 --- a/azurermps-6.13.0/AzureRM.Relay/Remove-AzureRmRelayNamespace.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Relay.dll-Help.xml -Module Name: AzureRM.Relay -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.relay/remove-azurermrelaynamespace -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/Remove-AzureRmRelayNamespace.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/Remove-AzureRmRelayNamespace.md ---- - -# Remove-AzureRmRelayNamespace - -## SYNOPSIS -Removes the namespace from the specified resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmRelayNamespace [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmRelayNamespace** cmdlet removes the namespace from the specified resource group. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmRelayNamespace -ResourceGroupName Default-ServiceBus-WestUS -Name TestNameSpace-Relay1 -``` - -Removes the Relay namespace `TestNameSpace-Relay1` from the specified resource group `Default-ServiceBus-WestUS`. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Relay Namespace Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - - -## OUTPUTS - -### System.Void - - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Relay/Remove-AzureRmWcfRelay.md b/azurermps-6.13.0/AzureRM.Relay/Remove-AzureRmWcfRelay.md deleted file mode 100644 index 7bac71e3cd..0000000000 --- a/azurermps-6.13.0/AzureRM.Relay/Remove-AzureRmWcfRelay.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Relay.dll-Help.xml -Module Name: AzureRM.Relay -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.relay/remove-azurermwcfrelay -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/Remove-AzureRmWcfRelay.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/Remove-AzureRmWcfRelay.md ---- - -# Remove-AzureRmWcfRelay - -## SYNOPSIS -Removes the WcfRelay from the specified Relay namespace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmWcfRelay [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmWcfRelay** cmdlet removes the WcfRelay from the specified Relay namespace. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmWcfRelay -ResourceGroupName Default-ServiceBus-WestUS -NamespaceName TestNameSpace-Relay1 -Name TestWCFRelay1 -``` - -Removes the WcfRelay `TestWCFRelay1` from the namespace `TestNameSpace-Relay1`. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WcfRelay Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - - -## OUTPUTS - -### System.Void - - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Relay/Set-AzureRmRelayAuthorizationRule.md b/azurermps-6.13.0/AzureRM.Relay/Set-AzureRmRelayAuthorizationRule.md deleted file mode 100644 index e9d070dcca..0000000000 --- a/azurermps-6.13.0/AzureRM.Relay/Set-AzureRmRelayAuthorizationRule.md +++ /dev/null @@ -1,346 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Relay.dll-Help.xml -Module Name: AzureRM.Relay -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.relay/set-azurermrelayauthorizationrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/Set-AzureRmRelayAuthorizationRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/Set-AzureRmRelayAuthorizationRule.md ---- - -# Set-AzureRmRelayAuthorizationRule - -## SYNOPSIS -Updates the specified authorization rule description for the given Relay entities (Namespace/WcfRelay/HybridConnection). - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NamespaceAuthorizationRuleSet (Default) -``` -Set-AzureRmRelayAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - [[-InputObject] <AuthorizationRuleAttributes>] [[-Rights] <String[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### WcfRelayAuthorizationRuleSet -``` -Set-AzureRmRelayAuthorizationRule [-ResourceGroupName] <String> [[-Namespace] <String>] [-WcfRelay] <String> - [-Name] <String> [[-InputObject] <AuthorizationRuleAttributes>] [[-Rights] <String[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### HybridConnectionAuthorizationRuleSet -``` -Set-AzureRmRelayAuthorizationRule [-ResourceGroupName] <String> [[-Namespace] <String>] - [-HybridConnection] <String> [-Name] <String> [[-InputObject] <AuthorizationRuleAttributes>] - [[-Rights] <String[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### AuthoRuleInputObjectSet -``` -Set-AzureRmRelayAuthorizationRule [-ResourceGroupName] <String> [-Name] <String> - [-InputObject] <AuthorizationRuleAttributes> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### AuthoRulePropertiesSet -``` -Set-AzureRmRelayAuthorizationRule [-ResourceGroupName] <String> [-Name] <String> [-Rights] <String[]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmRelayAuthorizationRule** cmdlet updates the description for the specified authorization rule of the given Relay entities (Namespace/WcfRelay/HybridConnection). - -## EXAMPLES - -### Example 1.1 - Namespace with InputObject -``` -PS C:\> -PS C:\> $getAutoRule = Get-AzureRmRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -NamespaceName TestNameSpace-Relay1 -AuthorizationRuleName - AuthoRule1 -PS C:\> $getAutoRule.Rights.Add("Send") -PS C:\> Set-AzureRmRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -AuthorizationRule AuthoRule1 -InputObject $getAutoRule - -Rights : {Listen, Send} -Name : AuthoRule1 -Type : Microsoft.Relay/AuthorizationRules -Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.Relay/namespaces/TestNameSpace-Relay1/AuthorizationRules/AuthoRule1 -``` - -Adds **Send** from the access rights of the authorization rule `AuthoRule1` in namespace `TestNameSpace-Relay1`. - -### Example 1.2 - Namespace with Rights parameter -``` -PS C:\> Set-AzureRmRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -AuthorizationRule AuthoRule1 -Rights "Send" - -Rights : {Listen, Send} -Name : AuthoRule1 -Type : Microsoft.Relay/AuthorizationRules -Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.Relay/namespaces/TestNameSpace-Relay1/AuthorizationRules/AuthoRule1 -``` - -Adds **Send** from the access rights of the authorization rule `AuthoRule1` in namespace `TestNameSpace-Relay1`. - -### Example 2.1 - WcfRelay with InputObject -``` -PS C:\> $getWcfRelayAutho = Get-AzureRmRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -WcfRelay TestWCFRelay1 -Name AuthoRule1 -PS C:\> $getWcfRelayAutho.Rights.Add("Send") -PS C:\> Set-AzureRmRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -WcfRelay TestWCFRelay1 -Name AuthoRule1 -InputObject $getWcfRelayAutho - -Rights : {Listen, Send} -Name : AuthoRule1 -Type : Microsoft.Relay/AuthorizationRules -Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.Relay/namespaces/TestNameSpace-Relay1/WcfRelays/TestWCFRelay1/authorizationRules/AuthoRule1 -``` - -Adds **Send** to the access rights of the authorization rule `AuthoRule1` of the WcfRelay `TestWCFRelay1`. - -### Example 2.2 - WcfRelay with Rights parameter -``` -PS C:\> Set-AzureRmRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -WcfRelay TestWCFRelay1 -Name AuthoRule1 -Rights "Send" - -Rights : {Listen, Send} -Name : AuthoRule1 -Type : Microsoft.Relay/AuthorizationRules -Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.Relay/namespaces/TestNameSpace-Relay1/WcfRelays/TestWCFRelay1/authorizationRules/AuthoRule1 -``` - -Adds **Send** to the access rights of the authorization rule `AuthoRule1` of the WcfRelay `TestWCFRelay1`. - -### Example 3.1 - HybridConnection with InputObject -``` -PS C:\> $GetHybirdAutho = Get-AzureRmRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -HybridConnection TestHybridConnection -Name AuthoRule1 -PS C:\> $GetHybirdAutho.Rights.Add("Send") -PS C:\> Set-AzureRmRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -HybridConnection TestHybridConnection -Name AuthoRule1 -InputObject $GetHybirdAutho - -Rights : {Listen, Send} -Name : AuthoRule1 -Type : Microsoft.Relay/AuthorizationRules -Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.Relay/namespaces/TestNameSpace-Relay1/HybridConnections/TestHybridConnection/authorizationRules/AuthoRule1 -``` - -Adds **Send** to the access rights of the authorization rule `AuthoRule1` of the HybridConnection `TestHybridConnection`. - -### Example 3.2 - HybridConnection with Rights parameter -``` -PS C:\> Set-AzureRmRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -HybridConnection TestHybridConnection -Name AuthoRule1 -Rights "Send" - -Rights : {Listen, Send} -Name : AuthoRule1 -Type : Microsoft.Relay/AuthorizationRules -Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.Relay/namespaces/TestNameSpace-Relay1/HybridConnections/TestHybridConnection/authorizationRules/AuthoRule1 -``` - -Adds **Send** to the access rights of the authorization rule `AuthoRule1` of the HybridConnection `TestHybridConnection`. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HybridConnection -HybridConnection Name. - -```yaml -Type: System.String -Parameter Sets: HybridConnectionAuthorizationRuleSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -Relay AuthorizationRule Object. - -```yaml -Type: Microsoft.Azure.Commands.Relay.Models.PSAuthorizationRuleAttributes -Parameter Sets: NamespaceAuthorizationRuleSet, WcfRelayAuthorizationRuleSet, HybridConnectionAuthorizationRuleSet -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: Microsoft.Azure.Commands.Relay.Models.PSAuthorizationRuleAttributes -Parameter Sets: AuthoRuleInputObjectSet -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -AuthorizationRule Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name. - -```yaml -Type: System.String -Parameter Sets: NamespaceAuthorizationRuleSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: WcfRelayAuthorizationRuleSet, HybridConnectionAuthorizationRuleSet -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Rights -Rights, e.g. -@("Listen","Send","Manage") - -```yaml -Type: System.String[] -Parameter Sets: NamespaceAuthorizationRuleSet, WcfRelayAuthorizationRuleSet, HybridConnectionAuthorizationRuleSet -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String[] -Parameter Sets: AuthoRulePropertiesSet -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WcfRelay -WcfRelay Name. - -```yaml -Type: System.String -Parameter Sets: WcfRelayAuthorizationRuleSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Microsoft.Azure.Commands.Relay.Models.PSAuthorizationRuleAttributes -System.String[] - - -## OUTPUTS - -### Microsoft.Azure.Commands.Relay.Models.PSAuthorizationRuleAttributes - - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Relay/Set-AzureRmRelayHybridConnection.md b/azurermps-6.13.0/AzureRM.Relay/Set-AzureRmRelayHybridConnection.md deleted file mode 100644 index d3c1d36615..0000000000 --- a/azurermps-6.13.0/AzureRM.Relay/Set-AzureRmRelayHybridConnection.md +++ /dev/null @@ -1,216 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Relay.dll-Help.xml -Module Name: AzureRM.Relay -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.relay/set-azurermrelayhybridconnection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/Set-AzureRmRelayHybridConnection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/Set-AzureRmRelayHybridConnection.md ---- - -# Set-AzureRmRelayHybridConnection - -## SYNOPSIS -Updates the description of a HybridConnection in the specified Relay namespace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### HybridConnectionInputObjectSet -``` -Set-AzureRmRelayHybridConnection [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - [-InputObject <HybridConnectionAttibutes>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### HybridConnectionPropertiesSet -``` -Set-AzureRmRelayHybridConnection [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - [-UserMetadata <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Set-AzureRmRelayHybridConnection cmdlet updates the description for the HybridConnection in the specified Relay namespace. - -## EXAMPLES - -### Example 1 -``` -PS C:\> -PS C:\> $GetHybrid = Get-AzureRmRelayHybridConnection -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name TestHybridConnection -PS C:\> $GetHybrid.UserMetadata = "Test UserMetadata" -PS C:\> Set-AzureRmRelayHybridConnection -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name TestHybridConnection -InputObject $GetHybrid - -CreatedAt : 4/26/2017 10:04:15 PM -UpdatedAt : 4/26/2017 10:08:11 PM -ListenerCount : -RequiresClientAuthorization : True -UserMetadata : Test UserMetadata -Id : /subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/Default-ServiceBus-WestUS - /providers/Microsoft.Relay/namespaces/TestNameSpace-HybirdConnection/HybridConnections/TestHybirdConnectio - n2 -Name : TestHybirdConnection2 -Type : Microsoft.Relay/HybridConnections -``` - -### Example 2 -``` -PS C:\> Set-AzureRmRelayHybridConnection -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name TestHybridConnection -UserMetadata = "Test UserMetadata updated" - -CreatedAt : 4/26/2017 10:04:15 PM -UpdatedAt : 4/26/2017 10:10:25 PM -ListenerCount : -RequiresClientAuthorization : True -UserMetadata : Test UserMetadata updated -Id : /subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/Default-ServiceBus-WestUS - /providers/Microsoft.Relay/namespaces/TestNameSpace-HybirdConnection/HybridConnections/TestHybirdConnectio - n1 -Name : TestHybirdConnection1 -Type : Microsoft.Relay/HybridConnections -``` - -Updates the specified HybridConnection with a new description in the specified namespace. -This example updates the UserMetadata property with new value. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -HybridConnections object. - -```yaml -Type: Microsoft.Azure.Commands.Relay.Models.PSHybridConnectionAttibutes -Parameter Sets: HybridConnectionInputObjectSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -HybridConnections Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserMetadata -Gets or sets usermetadata is a placeholder to store user-defined string data for the HybridConnection endpoint.e.g. -it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored. - -```yaml -Type: System.String -Parameter Sets: HybridConnectionPropertiesSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Microsoft.Azure.Commands.Relay.Models.PSHybridConnectionAttibutes - - -## OUTPUTS - -### Microsoft.Azure.Commands.Relay.Models.PSHybridConnectionAttibutes - - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Relay/Set-AzureRmRelayNamespace.md b/azurermps-6.13.0/AzureRM.Relay/Set-AzureRmRelayNamespace.md deleted file mode 100644 index 6b4da028d6..0000000000 --- a/azurermps-6.13.0/AzureRM.Relay/Set-AzureRmRelayNamespace.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Relay.dll-Help.xml -Module Name: AzureRM.Relay -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.relay/set-azurermrelaynamespace -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/Set-AzureRmRelayNamespace.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/Set-AzureRmRelayNamespace.md ---- - -# Set-AzureRmRelayNamespace - -## SYNOPSIS -Updates the description of an existing Relay namespace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmRelayNamespace [-ResourceGroupName] <String> [-Name] <String> [-Tag <Hashtable>] - [-InputObject <RelayNamespaceAttirbutesUpdateParameter>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmRelayNamespace** cmdlet updates the description of the specified Relay namespace within the resource group. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Set-AzureRmRelayNamespace -ResourceGroupName Default-ServiceBus-WestUS -Name TestNameSpace-Relay1 -Tag @{Tag2="Tag2Value"} - -ProvisioningState : -CreatedAt : 4/12/2017 12:38:47 AM -UpdatedAt : 4/12/2017 12:39:10 AM -ServiceBusEndpoint : https://TestNameSpace-Relay1.servicebus.windows.net:443/ -MetricId : -Location : -Tags : {[tag2, Tag2Value]} -Id : -Name : -Type : -``` - -Updates the Relay namespace with a new description. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Relay Namespace object. - -```yaml -Type: Microsoft.Azure.Commands.Relay.Models.RelayNamespaceAttirbutesUpdateParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Relay Namespace Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Hashtables which represents resource Tag. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -System.Collections.Hashtable -Microsoft.Azure.Commands.Relay.Models.RelayNamespaceAttirbutesUpdateParameter - - -## OUTPUTS - -### Microsoft.Azure.Commands.Relay.Models.PSRelayNamespaceAttributes - - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Relay/Set-AzureRmWcfRelay.md b/azurermps-6.13.0/AzureRM.Relay/Set-AzureRmWcfRelay.md deleted file mode 100644 index 2088502b96..0000000000 --- a/azurermps-6.13.0/AzureRM.Relay/Set-AzureRmWcfRelay.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Relay.dll-Help.xml -Module Name: AzureRM.Relay -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.relay/set-azurermwcfrelay -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/Set-AzureRmWcfRelay.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/Set-AzureRmWcfRelay.md ---- - -# Set-AzureRmWcfRelay - -## SYNOPSIS -Updates the description of a WcfRelay in the specified Relay namespace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### WcfRelayInputObjectSet -``` -Set-AzureRmWcfRelay [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - [-InputObject <WcfRelayAttributes>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### WcfRelayPropertiesSet -``` -Set-AzureRmWcfRelay [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - [-UserMetadata <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Set-AzureRmWcfRelay cmdlet updates the description for the WcfRelay in the specified Relay namespace. - -## EXAMPLES - -### Example 1 - InputObject -``` -PS C:\> -PS C:\> $getWcfRelay = Get-AzureRmWcfRelay -ResourceGroupName Default-ServiceBus-WestUS -NamespaceName TestNameSpace-Relay1 -WcfRelayName TestWCFRelay -PS C:\> $getWcfRelay.UserMetadata = "usermetadata is a placeholder to store user-defined string data for the HybridConnection endpoint.e.g. it can be used to store desc -riptive data, such as list of teams and their contact information also user-defined configuration settings can be stored." -PS C:\> Set-AzureRmWcfRelay -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name TestWCFRelay1 -InputObject $getWcfRelay - -RelayType : Http -CreatedAt : 4/26/2017 5:14:46 PM -UpdatedAt : 4/26/2017 5:16:50 PM -ListenerCount : -RequiresClientAuthorization : False -RequiresTransportSecurity : True -IsDynamic : False -UserMetadata : usermetadata is a placeholder to store user-defined string data for the HybridConnection endpoint.e.g. it can be used to store desc -riptive data, such as list of teams and their contact information also user-defined configuration settings can be stored. -Id : /subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/Default-Storage-WestUS/providers/Microsoft.Rel - ay/namespaces/TestNameSpace-Relay1/WcfRelays/TestWCFRelay2 -Name : TestWCFRelay2 -Type : Microsoft.Relay/WcfRelays -``` - -### Example 2 - Properties -``` -PS C:\> Set-AzureRmWcfRelay -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name TestWCFRelay1 -UserMetadata "User Meta data" - -RelayType : NetTcp -CreatedAt : 4/26/2017 5:20:08 PM -UpdatedAt : 4/26/2017 5:26:09 PM -ListenerCount : -RequiresClientAuthorization : True -RequiresTransportSecurity : True -IsDynamic : False -UserMetadata : User Meta data -Id : /subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/Default-Storage-WestUS/providers/Microsoft.Rel - ay/namespaces/TestNameSpace-Relay1/WcfRelays/TestWCFRelay -Name : TestWCFRelay -Type : Microsoft.Relay/WcfRelays -``` - -Updates the specified WcfRelay with a new description in the specified namespace. -This example updates the UserMetadata property with new value. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -WcfRelay object. - -```yaml -Type: Microsoft.Azure.Commands.Relay.Models.PSWcfRelayAttributes -Parameter Sets: WcfRelayInputObjectSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -WcfRelay Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserMetadata -Gets or sets usermetadata is a placeholder to store user-defined string data for the WcfRelay endpoint.e.g. -it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored. - -```yaml -Type: System.String -Parameter Sets: WcfRelayPropertiesSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Microsoft.Azure.Commands.Relay.Models.PSWcfRelayAttributes - - -## OUTPUTS - -### Microsoft.Azure.Commands.Relay.Models.PSWcfRelayAttributes - - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Relay/Test-AzureRmRelayName.md b/azurermps-6.13.0/AzureRM.Relay/Test-AzureRmRelayName.md deleted file mode 100644 index 81aeaf16f6..0000000000 --- a/azurermps-6.13.0/AzureRM.Relay/Test-AzureRmRelayName.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Relay.dll-Help.xml -Module Name: AzureRM.Relay -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.relay/test-azurermrelayname -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/Test-AzureRmRelayName.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Relay/Commands.Relay/help/Test-AzureRmRelayName.md ---- - -# Test-AzureRmRelayName - -## SYNOPSIS -Checks the Availability of the given NameSpace Name - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Test-AzureRmRelayName [-Namespace] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Test-AzureRmRelayName** Cmdlet Check Availability of the NameSpace Name - -## EXAMPLES - -### Example 1 -``` -PS C:\> Test-AzureRmRelayName -Namespace TestingtheAvailability - -NameAvailable Reason Message -------------- ------ ------- - True None -``` - -### Example 2 -``` -PS C:\> Test-AzureRmRelayName -Namespace Testi - -NameAvailable Reason Message -------------- ------ ------- - False InvalidName The specified service namespace is invalid. -``` - -### Example 3 -``` -PS C:\> Test-AzureRmRelayName -Namespace Test123 - -NameAvailable Reason Message -------------- ------ ------- - False NameInUse The specified service namespace is not available. -``` - -Returns the status on availability of the namespace name - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Namespace -Relay Namespace Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - - -## OUTPUTS - -### Microsoft.Azure.Commands.Relay.Models.PSCheckNameAvailabilityResultAttributes - - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Reservations/AzureRM.Reservations.md b/azurermps-6.13.0/AzureRM.Reservations/AzureRM.Reservations.md deleted file mode 100644 index 7b1270f228..0000000000 --- a/azurermps-6.13.0/AzureRM.Reservations/AzureRM.Reservations.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -Module Name: AzureRM.Reservations -Module Guid: 43d3b085-6323-4ac4-a7c3-81d75ea036e5 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.reservations -Help Version: 1.0.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Reservations/Commands.Reservations/help/AzureRM.Reservations.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Reservations/Commands.Reservations/help/AzureRM.Reservations.md ---- - -# AzureRM.Reservations Module -## Description -The topics in this section document the Azure PowerShell cmdlets for Azure Reservations in the Azure Resource Manager (ARM) framework. The cmdlets exist in the Microsoft.Azure.Commands.Reservations namespace. - -## AzureRM.Reservations Cmdlets -### [Get-AzureRmReservation](Get-AzureRmReservation.md) -Get `Reservation`s in a given reservation Order - -### [Get-AzureRmReservationCatalog](Get-AzureRmReservationCatalog.md) -Get the catalog of available reservations - -### [Get-AzureRmReservationHistory](Get-AzureRmReservationHistory.md) -Get `Reservation` revision history. - -### [Get-AzureRmReservationOrder](Get-AzureRmReservationOrder.md) -Get `ReservationOrder` - -### [Get-AzureRmReservationOrderId](Get-AzureRmReservationOrderId.md) -Get list of applicable `ReservationOrder` Ids. - -### [Merge-AzureRmReservation](Merge-AzureRmReservation.md) -Merges two `Reservation`s. - -### [Split-AzureRmReservation](Split-AzureRmReservation.md) -Split a `Reservation`. - -### [Update-AzureRmReservation](Update-AzureRmReservation.md) -Update a `Reservation`. - diff --git a/azurermps-6.13.0/AzureRM.Reservations/Get-AzureRmReservation.md b/azurermps-6.13.0/AzureRM.Reservations/Get-AzureRmReservation.md deleted file mode 100644 index aaf738d95c..0000000000 --- a/azurermps-6.13.0/AzureRM.Reservations/Get-AzureRmReservation.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Reservations.dll-Help.xml -Module Name: AzureRM.Reservations -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.reservations/get-azurermreservation -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Reservations/Commands.Reservations/help/Get-AzureRmReservation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Reservations/Commands.Reservations/help/Get-AzureRmReservation.md ---- - -# Get-AzureRmReservation - -## SYNOPSIS -Get `Reservation`s in a given reservation Order - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### CommandLine (Default) -``` -Get-AzureRmReservation -ReservationOrderId <Guid> [-ReservationId <Guid>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### PipeObject -``` -Get-AzureRmReservation [-ReservationOrder <PSReservationOrder>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### PagePipeObject -``` -Get-AzureRmReservation [-ReservationOrderPage <PSReservationOrderPage>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -List `Reservation`s within a single `ReservationOrder`. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmReservation -ReservationOrderId "1111aaaa-b1b2-c0c2-d0d2-00000fffff" -``` - -List `Reservation`s within the specified `ReservationOrder`. - -### Example 2 -``` -PS C:\> Get-AzureRmReservation -ReservationOrderId "1111aaaa-b1b2-c0c2-d0d2-00000fffff" -ReservationId "11111111-1111-1111-1111-1111111111" -``` - -Get specific `Reservation` details. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReservationId -Id of the `Reservation` to look at - -```yaml -Type: System.Guid -Parameter Sets: CommandLine -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReservationOrder -Pipe object parameter for `ReservationOrder` - -```yaml -Type: Microsoft.Azure.Commands.Reservations.Models.PSReservationOrder -Parameter Sets: PipeObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ReservationOrderId -Id of the `ReservationOrder` that contains the `Reservation`. Required. - -```yaml -Type: System.Guid -Parameter Sets: CommandLine -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReservationOrderPage -Pipe object parameter for `ReservationOrder` - -```yaml -Type: Microsoft.Azure.Commands.Reservations.Models.PSReservationOrderPage -Parameter Sets: PagePipeObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### Microsoft.Azure.Commands.Reservations.Models.PSReservationOrder -Parameters: ReservationOrder (ByValue) - -### Microsoft.Azure.Commands.Reservations.Models.PSReservationOrderPage -Parameters: ReservationOrderPage (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Reservations.Models.PSReservationPage - -### Microsoft.Azure.Commands.Reservations.Models.PSReservation - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Reservations/Get-AzureRmReservationCatalog.md b/azurermps-6.13.0/AzureRM.Reservations/Get-AzureRmReservationCatalog.md deleted file mode 100644 index c906be30f2..0000000000 --- a/azurermps-6.13.0/AzureRM.Reservations/Get-AzureRmReservationCatalog.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Reservations.dll-Help.xml -Module Name: AzureRM.Reservations -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.reservations/get-azurermreservationcatalog -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Reservations/Commands.Reservations/help/Get-AzureRmReservationCatalog.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Reservations/Commands.Reservations/help/Get-AzureRmReservationCatalog.md ---- - -# Get-AzureRmReservationCatalog - -## SYNOPSIS -Get the catalog of available reservations - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmReservationCatalog [-SubscriptionId <Guid>] -ReservedResourceType <String> [-Location <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Get the regions and skus that are available for Reserved Instance purchase for the specified Azure subscription. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmReservationCatalog -ReservedResourceType VirtualMachines -Location westus -``` - -Get the VirtualMachines catalog in westus for the default subscription - -### Example 2 -``` -PS C:\> Get-AzureRmReservationCatalog -SubscriptionId "1111aaaa-b1b2-c0c2-d0d2-00000fffff" -ReservedResourceType SuseLinux -``` - -Get the SuseLinux catalog for the specified subscription - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the reserved resources in the catalog - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReservedResourceType -Specifies the type of the reserved resources in the catalog - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Id of the subscription - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Reservations.Models.PSCatalog - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Reservations/Get-AzureRmReservationHistory.md b/azurermps-6.13.0/AzureRM.Reservations/Get-AzureRmReservationHistory.md deleted file mode 100644 index 4a732eb06e..0000000000 --- a/azurermps-6.13.0/AzureRM.Reservations/Get-AzureRmReservationHistory.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Reservations.dll-Help.xml -Module Name: AzureRM.Reservations -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.reservations/get-azurermreservationhistory -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Reservations/Commands.Reservations/help/Get-AzureRmReservationHistory.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Reservations/Commands.Reservations/help/Get-AzureRmReservationHistory.md ---- - -# Get-AzureRmReservationHistory - -## SYNOPSIS -Get `Reservation` revision history. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### CommandLine (Default) -``` -Get-AzureRmReservationHistory -ReservationOrderId <Guid> -ReservationId <Guid> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### PipeObject -``` -Get-AzureRmReservationHistory -Reservation <PSReservation> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -List of all the revisions for the `Reservation`. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmReservationHistory -ReservationOrderId "1111aaaa-b1b2-c0c2-d0d2-00000fffff" -ReservationId "00000000-ffff-ffff-0000-00000fffff" -``` - -Get the revision history of the specific reservation - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Reservation -Pipe object parameter for `Reservation`s - -```yaml -Type: Microsoft.Azure.Commands.Reservations.Models.PSReservation -Parameter Sets: PipeObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ReservationId -ReservationId of the `Reservation` of which history is to be shown - -```yaml -Type: System.Guid -Parameter Sets: CommandLine -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReservationOrderId -ReservationOrderId for the `ReservationOrder` that contains the `Reservation` - -```yaml -Type: System.Guid -Parameter Sets: CommandLine -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### Microsoft.Azure.Commands.Reservations.Models.PSReservation -Parameters: Reservation (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Reservations.Models.PSReservationPage - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Reservations/Get-AzureRmReservationOrder.md b/azurermps-6.13.0/AzureRM.Reservations/Get-AzureRmReservationOrder.md deleted file mode 100644 index 614e27b1be..0000000000 --- a/azurermps-6.13.0/AzureRM.Reservations/Get-AzureRmReservationOrder.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Reservations.dll-Help.xml -Module Name: AzureRM.Reservations -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.reservations/get-azurermreservationorder -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Reservations/Commands.Reservations/help/Get-AzureRmReservationOrder.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Reservations/Commands.Reservations/help/Get-AzureRmReservationOrder.md ---- - -# Get-AzureRmReservationOrder - -## SYNOPSIS -Get `ReservationOrder` - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmReservationOrder [-ReservationOrderId <Guid>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -List of all the `ReservationOrder`s that the user has access to in the current tenant. If ReservationOrderId parameter is set, get that specific ReservationOrder. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmReservationOrder -``` - -List all `ReservationOrder` that the user has access to in the current tenant - -### Example 2 -``` -PS C:\> Get-AzureRmReservationOrder -ReservationOrderId "00000000-ffff-ffff-0000-00000fffff" -``` - -Get `ReservationOrder` with the specified ReservationOrderId - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReservationOrderId -Id of the specific ReservationOrder that user wants to see - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Reservations.Models.PSReservationOrderPage - -### Microsoft.Azure.Commands.Reservations.Models.PSReservationOrder - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Reservations/Get-AzureRmReservationOrderId.md b/azurermps-6.13.0/AzureRM.Reservations/Get-AzureRmReservationOrderId.md deleted file mode 100644 index 2bf0646dd0..0000000000 --- a/azurermps-6.13.0/AzureRM.Reservations/Get-AzureRmReservationOrderId.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Reservations.dll-Help.xml -Module Name: AzureRM.Reservations -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.reservations/get-azurermreservationorderid -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Reservations/Commands.Reservations/help/Get-AzureRmReservationOrderId.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Reservations/Commands.Reservations/help/Get-AzureRmReservationOrderId.md ---- - -# Get-AzureRmReservationOrderId - -## SYNOPSIS -Get list of applicable `ReservationOrder` Ids. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmReservationOrderId [-SubscriptionId <Guid>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -Get Ids of applicable `ReservationOrder`s that can be applied to this subscription. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmReservationOrderId -``` - -Get applied `ReservationOrder` for default subscription - -### Example 2 -``` -PS C:\> Get-AzureRmReservationOrderId -SubscriptionId "1111aaaa-b1b2-c0c2-d0d2-00000fffff" -``` - -Get applied `ReservationOrder` for specified subscription - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Id of the subscription to get the applied `ReservationOrder`s - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Management.Reservations.Models.AppliedReservations - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Reservations/Merge-AzureRmReservation.md b/azurermps-6.13.0/AzureRM.Reservations/Merge-AzureRmReservation.md deleted file mode 100644 index 98dffb1d0b..0000000000 --- a/azurermps-6.13.0/AzureRM.Reservations/Merge-AzureRmReservation.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Reservations.dll-Help.xml -Module Name: AzureRM.Reservations -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.reservations/merge-azurermreservation -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Reservations/Commands.Reservations/help/Merge-AzureRmReservation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Reservations/Commands.Reservations/help/Merge-AzureRmReservation.md ---- - -# Merge-AzureRmReservation - -## SYNOPSIS -Merges two `Reservation`s. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### CommandLine (Default) -``` -Merge-AzureRmReservation -ReservationOrderId <Guid> -ReservationId <Guid[]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### PipeObject -``` -Merge-AzureRmReservation -Reservation <PSReservation[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Merge the specified `Reservation`s into a new `Reservation`. The two `Reservation`s being merged must have same properties. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Merge-AzureRmReservation -ReservationOrderId "1111aaaa-b1b2-c0c2-d0d2-00000fffff" -ReservationId "11111111-1111-1111-1111-1111111111","11111111-0000-0000-0000-1111111111" -``` - -Merge the two specified `Reservation`s into one `Reservation` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Reservation -Comma-separated strings of two ReservationIds to merge - -```yaml -Type: Microsoft.Azure.Commands.Reservations.Models.PSReservation[] -Parameter Sets: PipeObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReservationId -ReservationOrderId for the `ReservationOrder` that contains the two `Reservation`s - -```yaml -Type: System.Guid[] -Parameter Sets: CommandLine -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReservationOrderId -{{Fill ReservationOrderId Description}} - -```yaml -Type: System.Guid -Parameter Sets: CommandLine -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Reservations.Models.PSReservation - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Reservations/Split-AzureRmReservation.md b/azurermps-6.13.0/AzureRM.Reservations/Split-AzureRmReservation.md deleted file mode 100644 index 5e1cc4e850..0000000000 --- a/azurermps-6.13.0/AzureRM.Reservations/Split-AzureRmReservation.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Reservations.dll-Help.xml -Module Name: AzureRM.Reservations -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.reservations/split-azurermreservation -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Reservations/Commands.Reservations/help/Split-AzureRmReservation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Reservations/Commands.Reservations/help/Split-AzureRmReservation.md ---- - -# Split-AzureRmReservation - -## SYNOPSIS -Split a `Reservation`. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### CommandLine (Default) -``` -Split-AzureRmReservation -ReservationOrderId <Guid> -ReservationId <Guid> -Quantity <Int32[]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### PipeObject -``` -Split-AzureRmReservation -Quantity <Int32[]> -Reservation <PSReservation> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Split a `Reservation` into two `Reservation`s with specified quantity distribution. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Split-AzureRmReservation -ReservationOrderId "00000000-ffff-ffff-0000-00000fffff" -ReservationId "11111111-1111-1111-1111-1111111111" -Quantities 2,3 -``` - -Split the specified `Reservation` into two `Reservation`s with the corresponding quantities - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Quantity -Comma-separated integers for quantity field of the two `Reservation`s - -```yaml -Type: System.Int32[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Reservation -Pipe object parameter for `Reservation` - -```yaml -Type: Microsoft.Azure.Commands.Reservations.Models.PSReservation -Parameter Sets: PipeObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ReservationId -Id of the `Reservation` to split - -```yaml -Type: System.Guid -Parameter Sets: CommandLine -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReservationOrderId -Id of the `ReservationOrder` that contains the `Reservation` that user wants to split - -```yaml -Type: System.Guid -Parameter Sets: CommandLine -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Reservations.Models.PSReservation -Parameters: Reservation (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Reservations.Models.PSReservation - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Reservations/Update-AzureRmReservation.md b/azurermps-6.13.0/AzureRM.Reservations/Update-AzureRmReservation.md deleted file mode 100644 index 62272815b3..0000000000 --- a/azurermps-6.13.0/AzureRM.Reservations/Update-AzureRmReservation.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Reservations.dll-Help.xml -Module Name: AzureRM.Reservations -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.reservations/update-azurermreservation -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Reservations/Commands.Reservations/help/Update-AzureRmReservation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Reservations/Commands.Reservations/help/Update-AzureRmReservation.md ---- - -# Update-AzureRmReservation - -## SYNOPSIS -Update a `Reservation`. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### CommandLine (Default) -``` -Update-AzureRmReservation -ReservationOrderId <Guid> -ReservationId <Guid> -AppliedScopeType <String> - [-AppliedScope <String>] [-InstanceFlexibility <String>] [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### PipeObject -``` -Update-AzureRmReservation -AppliedScopeType <String> [-AppliedScope <String>] [-InstanceFlexibility <String>] - -Reservation <PSReservation> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Updates the applied scopes of the `Reservation`. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Update-AzureRmReservation -ReservationOrderId "11111111-1111-1111-1111-1111111111" -ReservationId "00000000-1111-1111-1111-0000000000" -appliedScopeType "Single" -appliedscope "/subscriptions/1111aaaa-b1b2-c0c2-d0d2-00000fffff" -InstanceFlexibility "On" -``` - -Updates the AppliedScopeType of the specified `Reservation` to Single and InstanceFlexibility to On. - -### Example 2 -``` -PS C:\> Update-AzureRmReservation -ReservationOrderId "11111111-1111-1111-1111-1111111111" -ReservationId "00000000-1111-1111-1111-0000000000" -appliedscopetype "Shared" -InstanceFlexibility "Off" -``` - -Updates the AppliedScopeType of the specified `Reservation` to Shared and InstanceFlexibility to Off. - -## PARAMETERS - -### -AppliedScope -SubscriptionId for this `Reservation` to be applied - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AppliedScopeType -Type of the Applied Scope - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceFlexibility -If present, updates the InstanceFlexibility value of the `Reservation`. If not specified, the existing value remains unchanged. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of Reservation - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Reservation -Pipe object parameter for `Reservation` - -```yaml -Type: Microsoft.Azure.Commands.Reservations.Models.PSReservation -Parameter Sets: PipeObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ReservationId -Id of the `Reservation` to update - -```yaml -Type: System.Guid -Parameter Sets: CommandLine -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReservationOrderId -Id of the `ReservationOrder` to update - -```yaml -Type: System.Guid -Parameter Sets: CommandLine -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Reservations.Models.PSReservation -Parameters: Reservation (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Reservations.Models.PSReservation - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ResourceGraph/AzureRm.ResourceGraph.md b/azurermps-6.13.0/AzureRM.ResourceGraph/AzureRm.ResourceGraph.md deleted file mode 100644 index 50b6ece999..0000000000 --- a/azurermps-6.13.0/AzureRM.ResourceGraph/AzureRm.ResourceGraph.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -Module Name: AzureRm.ResourceGraph -Module Guid: a290eead-f293-4588-b61e-b465b237591e -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.resourcegraph -Help Version: 0.1.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ResourceGraph/Commands.ResourceGraph/help/AzureRm.ResourceGraph.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ResourceGraph/Commands.ResourceGraph/help/AzureRm.ResourceGraph.md ---- - -# AzureRm.ResourceGraph Module -## Description -This topic displays help for the Azure Resource Graph cmdlets. - -## AzureRm.ResourceGraph Cmdlets -### [Search-AzureRmGraph](Search-AzureRmGraph.md) -Queries the resources managed by Azure Resource Manager. - diff --git a/azurermps-6.13.0/AzureRM.ResourceGraph/Search-AzureRmGraph.md b/azurermps-6.13.0/AzureRM.ResourceGraph/Search-AzureRmGraph.md deleted file mode 100644 index c79ca3e29d..0000000000 --- a/azurermps-6.13.0/AzureRM.ResourceGraph/Search-AzureRmGraph.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceGraph.dll-Help.xml -Module Name: AzureRM.ResourceGraph -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resourcegraph/search-azurermgraph -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ResourceGraph/Commands.ResourceGraph/help/Search-AzureRmGraph.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ResourceGraph/Commands.ResourceGraph/help/Search-AzureRmGraph.md ---- - -# Search-AzureRmGraph - -## SYNOPSIS -Queries the resources managed by Azure Resource Manager. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Search-AzureRmGraph [-Query] <String> [-Subscription <String[]>] [-First <Int32>] [-Skip <Int32>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Learn more about the query syntax here: https://aka.ms/resource-graph/learntoquery - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Search-AzureRmGraph "project id, name, type, location, tags" -First 3 - - -id : /subscriptions/1ef51df4-f8a9-4b69-9919-1ef51df4eff6/resourceGroups/Service-INT-a/providers/Microsoft.Compute/virtualMachineScaleSets/nt -name : nt -type : microsoft.compute/virtualmachinescalesets -location : eastus -tags : @{resourceType=Service Fabric; clusterName=gov-art-int-nt-a} - -id : /subscriptions/1ef51df4-f8a9-4b69-9919-1ef51df4eff6/resourceGroups/Service-INT-a/providers/Microsoft.EventGrid/topics/egtopic-1 -name : egtopic-1 -type : microsoft.eventgrid/topics -location : westus2 -tags : -``` - -Simple resources query requesting a subset of resource fields. - -### Example 2 -```powershell -PS C:\> Search-AzureRmGraph "project id, name, type, location | where type =~ 'Microsoft.Compute/virtualMachines' | summarize count() by location | top 3 by count_" - -location count_ --------- ------ -eastus 66 -westcentralus 32 -westus 26 -``` - -A complex query on resources featuring field selection, filtering and summarizing. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Query -Resource Graph query. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subscription -Subscription(s) to run query against. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Skip -Ignores the first N objects and then gets the remaining objects. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -First -The maximum number of objects to return. Allowed values: 1-5000. -Default value is 100. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Management.Automation.PSObject - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/Add-AzureRmADGroupMember.md b/azurermps-6.13.0/AzureRM.Resources/Add-AzureRmADGroupMember.md deleted file mode 100644 index 1f72f1e4b1..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Add-AzureRmADGroupMember.md +++ /dev/null @@ -1,228 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/add-azurermadgroupmember -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Add-AzureRmADGroupMember.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Add-AzureRmADGroupMember.md ---- - -# Add-AzureRmADGroupMember - -## SYNOPSIS -Adds a user to an existing AD group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### MemberObjectIdWithGroupObjectId (Default) -``` -Add-AzureRmADGroupMember -MemberObjectId <Guid[]> -TargetGroupObjectId <Guid> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### MemberObjectIdWithGroupDisplayName -``` -Add-AzureRmADGroupMember -MemberObjectId <Guid[]> -TargetGroupDisplayName <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### MemberObjectIdWithGroupObject -``` -Add-AzureRmADGroupMember -MemberObjectId <Guid[]> -TargetGroupObject <PSADGroup> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### MemberUPNWithGroupDisplayNameParameterSet -``` -Add-AzureRmADGroupMember -MemberUserPrincipalName <String[]> -TargetGroupDisplayName <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### MemberUPNWithGroupObjectParameterSet -``` -Add-AzureRmADGroupMember -MemberUserPrincipalName <String[]> -TargetGroupObject <PSADGroup> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### MemberUPNWithGroupObjectIdParameterSet -``` -Add-AzureRmADGroupMember -MemberUserPrincipalName <String[]> -TargetGroupObjectId <Guid> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Adds a user to an existing AD group. - -## EXAMPLES - -### Example 1 - Add a user to a group by object id - -``` -PS C:\> Add-AzureRmADGroupMember -MemberObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 -TargetGroupObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 -``` - -Adds the user with object id '00001111-aaaa-2222-bbbb-3333cccc4444' to the group with object id '00001111-aaaa-2222-bbbb-3333cccc4444'. - -### Example 2 - Add a user to a group by piping - -``` -PS C:\> Get-AzureRmADGroup -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 | Add-AzureRmADGroupMember -MemberObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 -``` - -Gets the group with object id '00001111-aaaa-2222-bbbb-3333cccc4444' and pipes it to the Add-AzureRmADGroupMember cmdlet to add the user to that group. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberObjectId -The object id of the member. - -```yaml -Type: System.Guid[] -Parameter Sets: MemberObjectIdWithGroupObjectId, MemberObjectIdWithGroupDisplayName, MemberObjectIdWithGroupObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberUserPrincipalName -The UPN of the member(s) to add to the group. - -```yaml -Type: System.String[] -Parameter Sets: MemberUPNWithGroupDisplayNameParameterSet, MemberUPNWithGroupObjectParameterSet, MemberUPNWithGroupObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Specifying this will return true if the command was successful. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetGroupDisplayName -The display name of the group to add the member(s) to. - -```yaml -Type: System.String -Parameter Sets: MemberObjectIdWithGroupDisplayName, MemberUPNWithGroupDisplayNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetGroupObject -The object representation of the group to add the member(s) to. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADGroup -Parameter Sets: MemberObjectIdWithGroupObject, MemberUPNWithGroupObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetGroupObjectId -The object id of the group to add the member(s) to. - -```yaml -Type: System.Guid -Parameter Sets: MemberObjectIdWithGroupObjectId, MemberUPNWithGroupObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADGroup -Parameters: TargetGroupObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/AzureRM.Resources.md b/azurermps-6.13.0/AzureRM.Resources/AzureRM.Resources.md deleted file mode 100644 index f63deed01d..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/AzureRM.Resources.md +++ /dev/null @@ -1,305 +0,0 @@ ---- -Module Name: AzureRM.Resources -Module Guid: ab3ca893-26fe-44b0-bd3c-8933df144d7b -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources -Help Version: 5.5.2.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/AzureRM.Resources.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/AzureRM.Resources.md ---- - -# AzureRM.Resources Module -## Description -This topic displays help topics for the Azure Resource Manager Cmdlets. - -## AzureRM.Resources Cmdlets -### [Add-AzureRmADGroupMember](Add-AzureRmADGroupMember.md) -Adds a user to an existing AD group. - -### [Export-AzureRmResourceGroup](Export-AzureRmResourceGroup.md) -Captures a resource group as a template and saves it to a file. - -### [Get-AzureRmADAppCredential](Get-AzureRmADAppCredential.md) -Retrieves a list of credentials associated with an application. - -### [Get-AzureRmADApplication](Get-AzureRmADApplication.md) -Lists existing Microsoft Entra applications. - -### [Get-AzureRmADGroup](Get-AzureRmADGroup.md) -Filters active directory groups. - -### [Get-AzureRmADGroupMember](Get-AzureRmADGroupMember.md) -Lists members of an AD group in the current tenant. - -### [Get-AzureRmADServicePrincipal](Get-AzureRmADServicePrincipal.md) -Filters active directory service principals. - -### [Get-AzureRmADSpCredential](Get-AzureRmADSpCredential.md) -Retrieves a list of credentials associated with a service principal. - -### [Get-AzureRmADUser](Get-AzureRmADUser.md) -Filters active directory users. - -### [Get-AzureRmDeployment](Get-AzureRmDeployment.md) -Gets a deployment at subscription scope. - -### [Get-AzureRmDeploymentOperation](Get-AzureRmDeploymentOperation.md) -Gets the deployment operations for a deployment at subscription scope. - -### [Get-AzureRmLocation](Get-AzureRmLocation.md) -Gets all locations and the supported resource providers for each location. - -### [Get-AzureRmManagedApplication](Get-AzureRmManagedApplication.md) -Gets managed applications - -### [Get-AzureRmManagedApplicationDefinition](Get-AzureRmManagedApplicationDefinition.md) -Gets managed application definitions - -### [Get-AzureRmManagementGroup](Get-AzureRmManagementGroup.md) -Gets Management Group(s) - -### [Get-AzureRmPolicyAssignment](Get-AzureRmPolicyAssignment.md) -Gets policy assignments. - -### [Get-AzureRmPolicyDefinition](Get-AzureRmPolicyDefinition.md) -Gets policy definitions. - -### [Get-AzureRmPolicySetDefinition](Get-AzureRmPolicySetDefinition.md) -Gets policy set definitions. - -### [Get-AzureRmProviderFeature](Get-AzureRmProviderFeature.md) -Gets information about Azure provider features. - -### [Get-AzureRmProviderOperation](Get-AzureRmProviderOperation.md) -Gets the operations for an Azure resource provider that are securable using Azure RBAC. - -### [Get-AzureRmResource](Get-AzureRmResource.md) -Gets resources. - -### [Get-AzureRmResourceGroup](Get-AzureRmResourceGroup.md) -Gets resource groups. - -### [Get-AzureRmResourceGroupDeployment](Get-AzureRmResourceGroupDeployment.md) -Gets the deployments in a resource group. - -### [Get-AzureRmResourceGroupDeploymentOperation](Get-AzureRmResourceGroupDeploymentOperation.md) -Gets the resource group deployment operation - -### [Get-AzureRmResourceLock](Get-AzureRmResourceLock.md) -Gets a resource lock. - -### [Get-AzureRmResourceProvider](Get-AzureRmResourceProvider.md) -Gets a resource provider. - -### [Get-AzureRmRoleAssignment](Get-AzureRmRoleAssignment.md) -Lists Azure RBAC role assignments at the specified scope. -By default it lists all role assignments in the selected Azure subscription. -Use respective parameters to list assignments to a specific user, or to list assignments on a specific resource group or resource. - -### [Get-AzureRmRoleDefinition](Get-AzureRmRoleDefinition.md) -Lists all Azure RBAC roles that are available for assignment. - -### [Invoke-AzureRmResourceAction](Invoke-AzureRmResourceAction.md) -Invokes an action on a resource. - -### [Move-AzureRmResource](Move-AzureRmResource.md) -Moves a resource to a different resource group or subscription. - -### [New-AzureRmADAppCredential](New-AzureRmADAppCredential.md) -Adds a credential to an existing application. - -### [New-AzureRmADApplication](New-AzureRmADApplication.md) -Creates a new Microsoft Entra application. - -### [New-AzureRmADGroup](New-AzureRmADGroup.md) -Creates a new active directory group. - -### [New-AzureRmADServicePrincipal](New-AzureRmADServicePrincipal.md) -Creates a new Microsoft Entra service principal. - -### [New-AzureRmADSpCredential](New-AzureRmADSpCredential.md) -Adds a credential to an existing service principal. - -### [New-AzureRmADUser](New-AzureRmADUser.md) -Creates a new active directory user. - -### [New-AzureRmDeployment](New-AzureRmDeployment.md) -Creates a new deployment at subscription scope. - -### [New-AzureRmManagedApplication](New-AzureRmManagedApplication.md) -Creates an Azure managed application. - -### [New-AzureRmManagedApplicationDefinition](New-AzureRmManagedApplicationDefinition.md) -Creates a managed application definition. - -### [New-AzureRmManagementGroup](New-AzureRmManagementGroup.md) -Creates a Management Group - -### [New-AzureRmManagementGroupSubscription](New-AzureRmManagementGroupSubscription.md) -Adds a Subscription to a Management Group. - -### [New-AzureRmPolicyAssignment](New-AzureRmPolicyAssignment.md) -Creates a policy assignment. - -### [New-AzureRmPolicyDefinition](New-AzureRmPolicyDefinition.md) -Creates a policy definition. - -### [New-AzureRmPolicySetDefinition](New-AzureRmPolicySetDefinition.md) -Creates a policy set definition. - -### [New-AzureRmResource](New-AzureRmResource.md) -Creates a resource. - -### [New-AzureRmResourceGroup](New-AzureRmResourceGroup.md) -Creates an Azure resource group. - -### [New-AzureRmResourceGroupDeployment](New-AzureRmResourceGroupDeployment.md) -Adds an Azure deployment to a resource group. - -### [New-AzureRmResourceLock](New-AzureRmResourceLock.md) -Creates a resource lock. - -### [New-AzureRmRoleAssignment](New-AzureRmRoleAssignment.md) -Assigns the specified RBAC role to the specified principal, at the specified scope. - -### [New-AzureRmRoleDefinition](New-AzureRmRoleDefinition.md) -Creates a custom role in Azure RBAC. -Provide either a JSON role definition file or a PSRoleDefinition object as input. -First, use the Get-AzureRmRoleDefinition command to generate a baseline role definition object. -Then, modify its properties as required. -Finally, use this command to create a custom role using role definition. - -### [Register-AzureRmProviderFeature](Register-AzureRmProviderFeature.md) -Registers an Azure provider feature in your account. - -### [Register-AzureRmResourceProvider](Register-AzureRmResourceProvider.md) -Registers a resource provider. - -### [Remove-AzureRmADAppCredential](Remove-AzureRmADAppCredential.md) -Removes a credential from an application. - -### [Remove-AzureRmADApplication](Remove-AzureRmADApplication.md) -Deletes the Microsoft Entra application. - -### [Remove-AzureRmADGroup](Remove-AzureRmADGroup.md) -Deletes an active directory group. - -### [Remove-AzureRmADGroupMember](Remove-AzureRmADGroupMember.md) -Removes a user from an AD group. - -### [Remove-AzureRmADServicePrincipal](Remove-AzureRmADServicePrincipal.md) -Deletes the Microsoft Entra service principal. - -### [Remove-AzureRmADSpCredential](Remove-AzureRmADSpCredential.md) -Removes a credential from a service principal. - -### [Remove-AzureRmADUser](Remove-AzureRmADUser.md) -Deletes an active directory user. - -### [Remove-AzureRmDeployment](Remove-AzureRmDeployment.md) -Removes a deployment at subscription scope. - -### [Remove-AzureRmManagedApplication](Remove-AzureRmManagedApplication.md) -Removes a managed application - -### [Remove-AzureRmManagedApplicationDefinition](Remove-AzureRmManagedApplicationDefinition.md) -Removes a managed application definition - -### [Remove-AzureRmManagementGroup](Remove-AzureRmManagementGroup.md) -Removes a Management Group - -### [Remove-AzureRmManagementGroupSubscription](Remove-AzureRmManagementGroupSubscription.md) -Removes a Subscription from a Management Group. - -### [Remove-AzureRmPolicyAssignment](Remove-AzureRmPolicyAssignment.md) -Removes a policy assignment. - -### [Remove-AzureRmPolicyDefinition](Remove-AzureRmPolicyDefinition.md) -Removes a policy definition. - -### [Remove-AzureRmPolicySetDefinition](Remove-AzureRmPolicySetDefinition.md) -Removes a policy set definition. - -### [Remove-AzureRmResource](Remove-AzureRmResource.md) -Removes a resource. - -### [Remove-AzureRmResourceGroup](Remove-AzureRmResourceGroup.md) -Removes a resource group. - -### [Remove-AzureRmResourceGroupDeployment](Remove-AzureRmResourceGroupDeployment.md) -Removes a resource group deployment and any associated operations. - -### [Remove-AzureRmResourceLock](Remove-AzureRmResourceLock.md) -Removes a resource lock. - -### [Remove-AzureRmRoleAssignment](Remove-AzureRmRoleAssignment.md) -Removes a role assignment to the specified principal who is assigned to a particular role at a particular scope. - -### [Remove-AzureRmRoleDefinition](Remove-AzureRmRoleDefinition.md) -Deletes a custom role in Azure RBAC. -The role to be deleted is specified using the Id property of the role. -Delete will fail if there are existing role assignments made to the custom role. - -### [Save-AzureRmDeploymentTemplate](Save-AzureRmDeploymentTemplate.md) -Gets the template for a deployment at subscription scope. - -### [Save-AzureRmResourceGroupDeploymentTemplate](Save-AzureRmResourceGroupDeploymentTemplate.md) -Saves a resource group deployment template to a file. - -### [Set-AzureRmManagedApplication](Set-AzureRmManagedApplication.md) -Updates managed application - -### [Set-AzureRmManagedApplicationDefinition](Set-AzureRmManagedApplicationDefinition.md) -Updates managed application definition - -### [Set-AzureRmPolicyAssignment](Set-AzureRmPolicyAssignment.md) -Modifies a policy assignment. - -### [Set-AzureRmPolicyDefinition](Set-AzureRmPolicyDefinition.md) -Modifies a policy definition. - -### [Set-AzureRmPolicySetDefinition](Set-AzureRmPolicySetDefinition.md) -Modifies a policy set definition - -### [Set-AzureRmResource](Set-AzureRmResource.md) -Modifies a resource. - -### [Set-AzureRmResourceGroup](Set-AzureRmResourceGroup.md) -Modifies a resource group. - -### [Set-AzureRmResourceLock](Set-AzureRmResourceLock.md) -Modifies a resource lock. - -### [Set-AzureRmRoleDefinition](Set-AzureRmRoleDefinition.md) -Modifies a custom role in Azure RBAC. -Provide the modified role definition either as a JSON file or as a PSRoleDefinition. -First, use the Get-AzureRmRoleDefinition command to retrieve the custom role that you wish to modify. -Then, modify the properties that you wish to change. -Finally, save the role definition using this command. - -### [Stop-AzureRmDeployment](Stop-AzureRmDeployment.md) -Cancels a running deployment at subscription scope. - -### [Stop-AzureRmResourceGroupDeployment](Stop-AzureRmResourceGroupDeployment.md) -Cancels a resource group deployment. - -### [Test-AzureRmDeployment](Test-AzureRmDeployment.md) -Validates a deployment template and parameters at subscription scope. - -### [Test-AzureRmResourceGroupDeployment](Test-AzureRmResourceGroupDeployment.md) -Validates a resource group deployment. - -### [Unregister-AzureRmResourceProvider](Unregister-AzureRmResourceProvider.md) -Unregisters a resource provider. - -### [Update-AzureRmADApplication](Update-AzureRmADApplication.md) -Updates an existing Microsoft Entra application. - -### [Update-AzureRmADServicePrincipal](Update-AzureRmADServicePrincipal.md) -Updates an existing Microsoft Entra service principal. - -### [Update-AzureRmADUser](Update-AzureRmADUser.md) -Updates an existing active directory user. - -### [Update-AzureRmManagementGroup](Update-AzureRmManagementGroup.md) -Updates a Management Group diff --git a/azurermps-6.13.0/AzureRM.Resources/Export-AzureRmResourceGroup.md b/azurermps-6.13.0/AzureRM.Resources/Export-AzureRmResourceGroup.md deleted file mode 100644 index c51da08001..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Export-AzureRmResourceGroup.md +++ /dev/null @@ -1,246 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 63BBDF98-75FC-4A44-9FD0-95AD21ED93A6 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/export-azurermresourcegroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Export-AzureRmResourceGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Export-AzureRmResourceGroup.md ---- - -# Export-AzureRmResourceGroup - -## SYNOPSIS -Captures a resource group as a template and saves it to a file. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Export-AzureRmResourceGroup -ResourceGroupName <String> [-Path <String>] [-IncludeParameterDefaultValue] - [-IncludeComments] [-Force] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Export-AzureRmResourceGroup** cmdlet captures the specified resource group as a template and saves it to a JSON file.This can be useful in scenarios where you have already created some resources in your resource group, and then want to leverage the benefits of using template backed deployments. -This cmdlet gives you an easy start by generating the template for your existing resources in the resource group. -There might be some cases where this cmdlet fails to generate some parts of the template. -Warning messages will inform you of the resources that failed. -The template will still be generated for the parts that were successful. - -## EXAMPLES - -### Example 1: Export a resource group -``` -PS C:\>Export-AzureRmResourceGroup -ResourceGroupName "TestGroup" -``` - -This command captures the resource group named TestGroup as a template, and saves it to a JSON file in the current directory. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. -If not specified, the latest API version is used. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeComments -Indicates that this operation exports the template with comments. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeParameterDefaultValue -Indicates that this operation exports the template parameter with the default value. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationAction -Specifies how this cmdlet responds to an information event. -The acceptable values for this parameter are: -- Continue -- Ignore -- Inquire -- SilentlyContinue -- Stop -- Suspend - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: infa - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationVariable -Specifies an information variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: iv - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the output path of the template file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet use pre-release API versions when automatically determining which API version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to export. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - diff --git a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmADAppCredential.md b/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmADAppCredential.md deleted file mode 100644 index 203e6e5bbc..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmADAppCredential.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 6AC9DA05-756D-4D59-BD97-DBAAFBB3C7AC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermadappcredential -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADAppCredential.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADAppCredential.md ---- - -# Get-AzureRmADAppCredential - -## SYNOPSIS -Retrieves a list of credentials associated with an application. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ApplicationObjectIdParameterSet (Default) -``` -Get-AzureRmADAppCredential -ObjectId <Guid> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ApplicationIdParameterSet -``` -Get-AzureRmADAppCredential -ApplicationId <Guid> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### DisplayNameParameterSet -``` -Get-AzureRmADAppCredential -DisplayName <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ApplicationObjectParameterSet -``` -Get-AzureRmADAppCredential -ApplicationObject <PSADApplication> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmADAppCredential cmdlet can be used to retrieve a list of credentials associated with an application. -This command will retrieve all of the credential properties (but not the credential value) associated with the application. - -## EXAMPLES - -### Example 1 - Get application credentials by object id - -``` -PS C:\> Get-AzureRmADAppCredential -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 -``` - -Returns a list of credentials associated with the application having object id '00001111-aaaa-2222-bbbb-3333cccc4444'. - -### Example 2 - Get application credentials by piping - -``` -PS C:\> Get-AzureRmADApplication -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 | Get-AzureRmADAppCredential -``` - -Gets the application with object id '00001111-aaaa-2222-bbbb-3333cccc4444' and pipes it to the Get-AzureRmADAppCredential cmdlet to list all of the credentials for that application. - -## PARAMETERS - -### -ApplicationId -The id of the application to retrieve credentials from. - -```yaml -Type: System.Guid -Parameter Sets: ApplicationIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationObject -The application object to retrieve credentials from. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication -Parameter Sets: ApplicationObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The display name of the application. - -```yaml -Type: System.String -Parameter Sets: DisplayNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ObjectId -The object id of the application to retrieve credentials from. - -```yaml -Type: System.Guid -Parameter Sets: ApplicationObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication -Parameters: ApplicationObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADCredential - -## NOTES - -## RELATED LINKS - -[New-AzureRmADAppCredential](./New-AzureRmADAppCredential.md) - -[Remove-AzureRmADAppCredential](./Remove-AzureRmADAppCredential.md) - -[Get-AzureRmADApplication](./Get-AzureRmADApplication.md) - diff --git a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmADApplication.md b/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmADApplication.md deleted file mode 100644 index 40e6cba8b2..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmADApplication.md +++ /dev/null @@ -1,258 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 66AC5120-80B1-46F2-AA51-132BF361602E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermadapplication -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADApplication.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADApplication.md ---- - -# Get-AzureRmADApplication - -## SYNOPSIS -Lists existing Microsoft Entra applications. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### EmptyParameterSet (Default) -``` -Get-AzureRmADApplication [-DefaultProfile <IAzureContextContainer>] [-IncludeTotalCount] [-Skip <UInt64>] - [-First <UInt64>] [<CommonParameters>] -``` - -### ApplicationObjectIdParameterSet -``` -Get-AzureRmADApplication -ObjectId <Guid> [-DefaultProfile <IAzureContextContainer>] [-IncludeTotalCount] - [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### ApplicationIdParameterSet -``` -Get-AzureRmADApplication -ApplicationId <Guid> [-DefaultProfile <IAzureContextContainer>] [-IncludeTotalCount] - [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### SearchStringParameterSet -``` -Get-AzureRmADApplication -DisplayNameStartWith <String> [-DefaultProfile <IAzureContextContainer>] - [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### DisplayNameParameterSet -``` -Get-AzureRmADApplication -DisplayName <String> [-DefaultProfile <IAzureContextContainer>] [-IncludeTotalCount] - [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### ApplicationIdentifierUriParameterSet -``` -Get-AzureRmADApplication -IdentifierUri <String> [-DefaultProfile <IAzureContextContainer>] - [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -## DESCRIPTION -Lists existing Microsoft Entra applications. -Application lookup can be done by ObjectId, ApplicationId, IdentifierUri or DisplayName. -If no parameter is provided, it fetches all applications under the tenant. - -## EXAMPLES - -### Example 1 - List all applications - -``` -PS C:\> Get-AzureRmADApplication -``` - -Lists all the applications under a tenant. - -### Example 2 - List applications using paging - -``` -PS C:\> Get-AzureRmADApplication -First 100 -``` - -Lists the first 100 applications under a tenant. - -### Example 3 - Get application by identifier URI - -``` -PS C:\> Get-AzureRmADApplication -IdentifierUri http://mySecretApp1 -``` - -Gets the application with identifier uri as "http://mySecretApp1". - -### Example 4 - Get application by object id - -``` -PS C:\> Get-AzureRmADApplication -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 -``` - -Gets the application with the object id '00001111-aaaa-2222-bbbb-3333cccc4444'. - -## PARAMETERS - -### -ApplicationId -The application id of the application to fetch. - -```yaml -Type: System.Guid -Parameter Sets: ApplicationIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The display name of the application. - -```yaml -Type: System.String -Parameter Sets: DisplayNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisplayNameStartWith -Fetch all applications starting with the display name. - -```yaml -Type: System.String -Parameter Sets: SearchStringParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -First -The maximum number of objects to return. - -```yaml -Type: System.UInt64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IdentifierUri -Unique identifier Uri of the application to fetch. - -```yaml -Type: System.String -Parameter Sets: ApplicationIdentifierUriParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IncludeTotalCount -Reports the number of objects in the data set. Currently, this parameter does nothing. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ObjectId -The object id of the application to fetch. - -```yaml -Type: System.Guid -Parameter Sets: ApplicationObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Skip -Ignores the first N objects and then gets the remaining objects. - -```yaml -Type: System.UInt64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmADAppCredential](./Remove-AzureRmADAppCredential.md) - -[New-AzureRmADAppCredential](./New-AzureRmADAppCredential.md) - -[Get-AzureRmADAppCredential](./Get-AzureRmADAppCredential.md) - -[Remove-AzureRmADApplication](./Remove-AzureRmADApplication.md) - - -[New-AzureRmADApplication](./New-AzureRmADApplication.md) diff --git a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmADGroup.md b/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmADGroup.md deleted file mode 100644 index 434793e2f7..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmADGroup.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 85DDA491-7A7D-4217-B0E3-72CDC3787889 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermadgroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADGroup.md ---- - -# Get-AzureRmADGroup - -## SYNOPSIS -Filters active directory groups. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### EmptyParameterSet (Default) -``` -Get-AzureRmADGroup [-ObjectId <Guid>] [-DefaultProfile <IAzureContextContainer>] [-IncludeTotalCount] - [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### SearchStringParameterSet -``` -Get-AzureRmADGroup -DisplayNameStartsWith <String> [-DefaultProfile <IAzureContextContainer>] - [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### DisplayNameParameterSet -``` -Get-AzureRmADGroup -DisplayName <String> [-DefaultProfile <IAzureContextContainer>] [-IncludeTotalCount] - [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### ObjectIdParameterSet -``` -Get-AzureRmADGroup -ObjectId <Guid> [-DefaultProfile <IAzureContextContainer>] [-IncludeTotalCount] - [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -## DESCRIPTION -Filters active directory groups. - -## EXAMPLES - -### Example 1 - List all AD groups -``` -PS C:\> Get-AzureRmADGroup -``` - -Lists all AD groups in a tenant. - -### Example 2 - List all AD groups using paging - -``` -PS C:\> Get-AzureRmADGroup -First 100 -``` - -Lists the first 100 AD groups in a tenant. - -### Example 3 - Get AD group by object id - -``` -PS C:\> Get-AzureRmADGroup -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 -``` - -Gets an AD group with object id '00001111-aaaa-2222-bbbb-3333cccc4444'. - -### Example 4 - List groups by search string - -``` -PS C:\> Get-AzureRmADGroup -SearchString Joe -``` - -Lists all AD groups whose display name begins with 'Joe'. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The display name of the group. - -```yaml -Type: System.String -Parameter Sets: DisplayNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayNameStartsWith -Used to find groups that begin with the provided string. - -```yaml -Type: System.String -Parameter Sets: SearchStringParameterSet -Aliases: SearchString - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -First -The maximum number of objects to return. - -```yaml -Type: System.UInt64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeTotalCount -Reports the number of objects in the data set. Currently, this parameter does nothing. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ObjectId -Object id of the group. - -```yaml -Type: System.Guid -Parameter Sets: EmptyParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Guid -Parameter Sets: ObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Skip -Ignores the first N objects and then gets the remaining objects. - -```yaml -Type: System.UInt64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Guid - -## OUTPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADGroup - -## NOTES - -## RELATED LINKS - -[Get-AzureRmADUser](./Get-AzureRmADUser.md) - -[Get-AzureRmADServicePrincipal](./Get-AzureRmADServicePrincipal.md) - -[Get-AzureRmADGroupMember](./Get-AzureRmADGroupMember.md) - diff --git a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmADGroupMember.md b/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmADGroupMember.md deleted file mode 100644 index d6482433c8..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmADGroupMember.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 52C5CD8B-2489-4FE6-9F33-B3350531CD8E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermadgroupmember -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADGroupMember.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADGroupMember.md ---- - -# Get-AzureRmADGroupMember - -## SYNOPSIS -Lists members of an AD group in the current tenant. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ObjectIdParameterSet (Default) -``` -Get-AzureRmADGroupMember [-GroupObjectId <Guid>] [-DefaultProfile <IAzureContextContainer>] - [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### DisplayNameParameterSet -``` -Get-AzureRmADGroupMember -GroupDisplayName <String> [-DefaultProfile <IAzureContextContainer>] - [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### GroupObjectParameterSet -``` -Get-AzureRmADGroupMember -GroupObject <PSADGroup> [-DefaultProfile <IAzureContextContainer>] - [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -## DESCRIPTION -Lists members of an AD group in the current tenant. - -## EXAMPLES - -### Example 1 - List members by AD group object id - -``` -PS C:\> Get-AzureRmADGroupMember -GroupObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 -``` - -Lists members of the AD group with object id '00001111-aaaa-2222-bbbb-3333cccc4444'. - -### Example 2 - List members by AD group object id using paging - -``` -PS C:\> Get-AzureRmADGroupMember -GroupObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 -First 100 -``` - -Lists the first 100 members of the AD group with object id '00001111-aaaa-2222-bbbb-3333cccc4444'. - -### Example 3 - List members by piping - -``` -PS C:\> Get-AzureRmADGroup -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 | Get-AzureRmADGroupMember -``` - -Gets the AD group with object id '00001111-aaaa-2222-bbbb-3333cccc4444' and pipes it to the Get-AzureRmADGroupMember cmdlet to list all members in that group. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -First -The maximum number of objects to return. - -```yaml -Type: System.UInt64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupDisplayName -The display name of the group. - -```yaml -Type: System.String -Parameter Sets: DisplayNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupObject -The group object that you are listing members from. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADGroup -Parameter Sets: GroupObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -GroupObjectId -Object Id of the group. - -```yaml -Type: System.Guid -Parameter Sets: ObjectIdParameterSet -Aliases: Id, ObjectId - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IncludeTotalCount -Reports the number of objects in the data set. Currently, this parameter does nothing. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Skip -Ignores the first N objects and then gets the remaining objects. - -```yaml -Type: System.UInt64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADGroup -Parameters: GroupObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADObject - -## NOTES - -## RELATED LINKS - -[Get-AzureRmADUser](./Get-AzureRmADUser.md) - -[Get-AzureRmADServicePrincipal](./Get-AzureRmADServicePrincipal.md) - diff --git a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmADServicePrincipal.md b/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmADServicePrincipal.md deleted file mode 100644 index 059a565315..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmADServicePrincipal.md +++ /dev/null @@ -1,287 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 4DC26C26-6162-4A15-BFCB-4D2B6B52DD81 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermadserviceprincipal -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADServicePrincipal.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADServicePrincipal.md ---- - -# Get-AzureRmADServicePrincipal - -## SYNOPSIS -Filters active directory service principals. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### EmptyParameterSet (Default) -``` -Get-AzureRmADServicePrincipal [-DefaultProfile <IAzureContextContainer>] [-IncludeTotalCount] [-Skip <UInt64>] - [-First <UInt64>] [<CommonParameters>] -``` - -### SearchStringParameterSet -``` -Get-AzureRmADServicePrincipal -DisplayNameBeginsWith <String> [-DefaultProfile <IAzureContextContainer>] - [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### DisplayNameParameterSet -``` -Get-AzureRmADServicePrincipal -DisplayName <String> [-DefaultProfile <IAzureContextContainer>] - [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### ObjectIdParameterSet -``` -Get-AzureRmADServicePrincipal -ObjectId <Guid> [-DefaultProfile <IAzureContextContainer>] [-IncludeTotalCount] - [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### ApplicationIdParameterSet -``` -Get-AzureRmADServicePrincipal -ApplicationId <Guid> [-DefaultProfile <IAzureContextContainer>] - [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### ApplicationObjectParameterSet -``` -Get-AzureRmADServicePrincipal -ApplicationObject <PSADApplication> [-DefaultProfile <IAzureContextContainer>] - [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### SPNParameterSet -``` -Get-AzureRmADServicePrincipal -ServicePrincipalName <String> [-DefaultProfile <IAzureContextContainer>] - [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -## DESCRIPTION -Filters active directory service principals. - -## EXAMPLES - -### Example 1 - List AD service principals - -``` -PS C:\> Get-AzureRmADServicePrincipal -``` - -Lists all AD service principals in a tenant. - -### Example 2 - List AD service principals using paging - -``` -PS C:\> Get-AzureRmADServicePrincipal -First 100 -``` - -Lists the first 100 AD service principals in a tenant. - -### Example 3 - List service principals by SPN - -``` -PS C:\> Get-AzureRmADServicePrincipal -ServicePrincipalName 36f81fc3-b00f-48cd-8218-3879f51ff39f -``` - -Lists service principals with the SPN '36f81fc3-b00f-48cd-8218-3879f51ff39f'. - -### Example 4 - List service principals by search string - -``` -PS C:\> Get-AzureRmADServicePrincipal -SearchString "Web" -``` - -Lists all AD service principals whose display name start with "Web". - -### Example 5 - List service principals by piping - -``` -PS C:\> Get-AzureRmADApplication -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 | Get-AzureRmADServicePrincipal -``` - -Gets the AD application with object id '00001111-aaaa-2222-bbbb-3333cccc4444' and pipes it to the Get-AzureRmADServicePrincipal cmdlet to list all service principals for that application. - -## PARAMETERS - -### -ApplicationId -The service principal application id. - -```yaml -Type: System.Guid -Parameter Sets: ApplicationIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationObject -The application object whose service principal is being retrieved. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication -Parameter Sets: ApplicationObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The service principal display name. - -```yaml -Type: System.String -Parameter Sets: DisplayNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisplayNameBeginsWith -The service principal search string. - -```yaml -Type: System.String -Parameter Sets: SearchStringParameterSet -Aliases: SearchString - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -First -The maximum number of objects to return. - -```yaml -Type: System.UInt64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeTotalCount -Reports the number of objects in the data set. Currently, this parameter does nothing. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ObjectId -Object id of the service principal. - -```yaml -Type: System.Guid -Parameter Sets: ObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServicePrincipalName -SPN of the service. - -```yaml -Type: System.String -Parameter Sets: SPNParameterSet -Aliases: SPN - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Skip -Ignores the first N objects and then gets the remaining objects. - -```yaml -Type: System.UInt64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Guid - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication -Parameters: ApplicationObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADServicePrincipal - -## NOTES - -## RELATED LINKS - -[New-AzureRmADServicePrincipal](./New-AzureRmADServicePrincipal.md) - - -[Remove-AzureRmADServicePrincipal](./Remove-AzureRmADServicePrincipal.md) - -[Get-AzureRmADApplication](./Get-AzureRmADApplication.md) - -[Get-AzureRmADSpCredential](./Get-AzureRmADSpCredential.md) - diff --git a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmADSpCredential.md b/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmADSpCredential.md deleted file mode 100644 index 2bd57fb423..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmADSpCredential.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 7690143F-5F09-4739-9F66-B2ACDF8305F4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermadspcredential -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADSpCredential.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADSpCredential.md ---- - -# Get-AzureRmADSpCredential - -## SYNOPSIS -Retrieves a list of credentials associated with a service principal. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ObjectIdParameterSet (Default) -``` -Get-AzureRmADSpCredential -ObjectId <Guid> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SPNParameterSet -``` -Get-AzureRmADSpCredential -ServicePrincipalName <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### DisplayNameParameterSet -``` -Get-AzureRmADSpCredential -DisplayName <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SPNObjectParameterSet -``` -Get-AzureRmADSpCredential -ServicePrincipalObject <PSADServicePrincipal> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmADSpCredential cmdlet can be used to retrieve a list of credentials associated with a service principal. -This command will retrieve all of the credential properties (but not the credential value) associated with the service principal. - -## EXAMPLES - -### Example 1 - List credentials by SPN - -``` -PS C:\> Get-AzureRmADSpCredential -ServicePrincipalName http://test12345 -``` - -Returns a list of credentials associated with the service principal with SPN 'http://test12345'. - -### Example 2 - List credentials by object id - -``` -PS C:\> Get-AzureRmADSpCredential -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 -``` - -Returns a list of credentials associated with the service principal with object id "00001111-aaaa-2222-bbbb-3333cccc4444". - -### Example 3 - List credentials by piping - -``` -PS C:\> Get-AzureRmADServicePrincipal -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 | Get-AzureRmADSpCredential -``` - -Gets the service principal with object id "00001111-aaaa-2222-bbbb-3333cccc4444" and pipes it to the Get-AzureRmADSpCredential cmdlet to list all credentials for that service principal. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The display name of the service principal - -```yaml -Type: System.String -Parameter Sets: DisplayNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ObjectId -The object id of the service principal to retrieve credentials from. - -```yaml -Type: System.Guid -Parameter Sets: ObjectIdParameterSet -Aliases: Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServicePrincipalName -The name (SPN) of the service principal to retrieve credentials from. - -```yaml -Type: System.String -Parameter Sets: SPNParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServicePrincipalObject -The service principal object to retrieve the credentials from. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADServicePrincipal -Parameter Sets: SPNObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADServicePrincipal -Parameters: ServicePrincipalObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADCredential - -## NOTES - -## RELATED LINKS - -[New-AzureRmADSpCredential](./New-AzureRmADSpCredential.md) - -[Remove-AzureRmADSpCredential](./Remove-AzureRmADSpCredential.md) - -[Get-AzureRmADServicePrincipal](./Get-AzureRmADServicePrincipal.md) - diff --git a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmADUser.md b/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmADUser.md deleted file mode 100644 index 6d4cb315bb..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmADUser.md +++ /dev/null @@ -1,263 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: BF254F2F-F658-45CC-8AC8-53FF96CFCAAD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermaduser -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADUser.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADUser.md ---- - -# Get-AzureRmADUser - -## SYNOPSIS -Filters active directory users. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### EmptyParameterSet (Default) -``` -Get-AzureRmADUser [-UserPrincipalName <String>] [-DefaultProfile <IAzureContextContainer>] [-IncludeTotalCount] - [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### SearchStringParameterSet -``` -Get-AzureRmADUser -StartsWith <String> [-DefaultProfile <IAzureContextContainer>] [-IncludeTotalCount] - [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### DisplayNameParameterSet -``` -Get-AzureRmADUser -DisplayName <String> [-DefaultProfile <IAzureContextContainer>] [-IncludeTotalCount] - [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### ObjectIdParameterSet -``` -Get-AzureRmADUser -ObjectId <Guid> [-DefaultProfile <IAzureContextContainer>] [-IncludeTotalCount] - [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### UPNParameterSet -``` -Get-AzureRmADUser -UserPrincipalName <String> [-DefaultProfile <IAzureContextContainer>] [-IncludeTotalCount] - [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### MailParameterSet -``` -Get-AzureRmADUser -Mail <String> [-DefaultProfile <IAzureContextContainer>] [-IncludeTotalCount] - [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -## DESCRIPTION -Filters active directory users. - -## EXAMPLES - -### Example 1 - List all users - -``` -PS C:\> Get-AzureRmADUser -``` - -Lists all AD users in a tenant. - -### Example 2 - List all users using paging - -``` -PS C:\> Get-AzureRmADUser -First 100 -``` - -Lists the first 100 AD users in a tenant. - -### Example 3 - Get AD user by user principal name - -``` -PS C:\> Get-AzureRmADUser -UserPrincipalName foo@domain.com -``` - -Gets the AD user with user principal name "foo@domain.com". - -### Example 4 - List by search string - -``` -PS C:\> Get-AzureRmADUser -SearchString Joe -``` - -Lists all AD users whose display name starts with "Joe". - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The display name of the user. - -```yaml -Type: System.String -Parameter Sets: DisplayNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -First -The maximum number of objects to return. - -```yaml -Type: System.UInt64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeTotalCount -Reports the number of objects in the data set. Currently, this parameter does nothing. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mail -The user mail. - -```yaml -Type: System.String -Parameter Sets: MailParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ObjectId -Object id of the user. - -```yaml -Type: System.Guid -Parameter Sets: ObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Skip -Ignores the first N objects and then gets the remaining objects. - -```yaml -Type: System.UInt64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartsWith -Used to find users that begin with the provided string. - -```yaml -Type: System.String -Parameter Sets: SearchStringParameterSet -Aliases: SearchString - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserPrincipalName -UPN of the user. - -```yaml -Type: System.String -Parameter Sets: EmptyParameterSet -Aliases: UPN - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: UPNParameterSet -Aliases: UPN - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Guid - -## OUTPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADUser - -## NOTES - -## RELATED LINKS - -[New-AzureRmADUser](./New-AzureRmADUser.md) - - -[Remove-AzureRmADUser](./Remove-AzureRmADUser.md) - diff --git a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmDeployment.md b/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmDeployment.md deleted file mode 100644 index ed629abf98..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmDeployment.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermdeployment -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmDeployment.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmDeployment.md ---- - -# Get-AzureRmDeployment - -## SYNOPSIS -Get deployment - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetByDeploymentName (Default) -``` -Get-AzureRmDeployment [[-Name] <String>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetByDeploymentId -``` -Get-AzureRmDeployment [-Id <String>] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDeployment** cmdlet gets the deployments at the current subscription scope. -Specify the *Name* or *Id* parameter to filter the results. -By default, **Get-AzureRmDeployment** gets all deployments at the current subscription scope. - -## EXAMPLES - -### Example 1: Get all deployments at subscription scope -``` -PS C:\>Get-AzureRmDeployment -``` - -This command gets all deployments at the current subscription scope. - -### Example 2: Get a deployment by name -``` -PS C:\>Get-AzureRmDeployment -Name "DeployRoles01" -``` - -This command gets the DeployRoles01 deployment at the current subscription scope. -You can assign a name to a deployment when you create it by using the **New-AzureRmDeployment** cmdlets. -If you do not assign a name, the cmdlets provide a default name based on the template that is used to create the deployment. - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The fully qualified resource Id of the deployment. -example: /subscriptions/{subId}/providers/Microsoft.Resources/deployments/{deploymentName} - -```yaml -Type: String -Parameter Sets: GetByDeploymentId -Aliases: DeploymentId, ResourceId - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of deployment. - -```yaml -Type: String -Parameter Sets: GetByDeploymentName -Aliases: DeploymentName - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmDeploymentOperation.md b/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmDeploymentOperation.md deleted file mode 100644 index 5c300fd4ba..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmDeploymentOperation.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermdeploymentoperation -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmDeploymentOperation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmDeploymentOperation.md ---- - -# Get-AzureRmDeploymentOperation - -## SYNOPSIS -Get deployment operation - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetByDeploymentName (Default) -``` -Get-AzureRmDeploymentOperation -DeploymentName <String> [-OperationId <String>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetByDeploymentObject -``` -Get-AzureRmDeploymentOperation -DeploymentObject <PSDeployment> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDeploymentOperation** cmdlet lists all the operations that were part of a deployment to help you identify and give more information about the exact operations that failed for a particular deployment. -It can also show the response and the request content for each deployment operation. -This is the same information provided in the deployment details on the portal. - -To get the request and the response content, enable the setting when submitting a deployment through **New-AzureRmDeployment**. -It can potentially log and expose secrets like passwords used in the resource property or **listKeys** operations that are then returned when you retrieve the deployment operations. -For more on this setting and how to enable it, see New-AzureRmDeployment and Debugging ARM template deployments - -## EXAMPLES - -### Get deployment operations given a deployment name -``` -PS C:\>Get-AzureRmDeploymentOperation -DeploymentName test -``` - -Gets deployment operation with name "test" at the current subscription scope. - -### Get a deployment and get its deployment operations -``` -PS C:\>Get-AzureRmDeployment -Name "test" | Get-AzureRmDeploymentOperation -``` - -This command gets the deployment "test" at the current subscription scope and get its deployment operations. - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeploymentName -The deployment name. - -```yaml -Type: String -Parameter Sets: GetByDeploymentName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeploymentObject -The deployment object. - -```yaml -Type: PSDeployment -Parameter Sets: GetByDeploymentObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -OperationId -The deployment operation Id. - -```yaml -Type: String -Parameter Sets: GetByDeploymentName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeploymentOperation - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmLocation.md b/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmLocation.md deleted file mode 100644 index df959268eb..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmLocation.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: DC870E11-2129-4906-8357-D9BC1CF2E08E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermlocation -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmLocation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmLocation.md ---- - -# Get-AzureRmLocation - -## SYNOPSIS -Gets all locations and the supported resource providers for each location. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmLocation [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmLocation** cmdlet gets all locations and the supported resource providers for each location. - -## EXAMPLES - -### Example 1: Get all locations and the supported resource providers -``` -PS C:\>Get-AzureRmLocation -``` - -This command gets all locations and the supported resource providers for each location. - -## PARAMETERS - -### -ApiVersion -Specifies the API version that is supported by the resource Provider. -You can specify a different version than the default version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmManagedApplication.md b/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmManagedApplication.md deleted file mode 100644 index 36f81c91b8..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmManagedApplication.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermmanagedapplication -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmManagedApplication.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmManagedApplication.md ---- - -# Get-AzureRmManagedApplication - -## SYNOPSIS -Gets managed applications - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetBySubscription (Default) -``` -Get-AzureRmManagedApplication [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### GetByNameAndResourceGroup -``` -Get-AzureRmManagedApplication [-Name <String>] -ResourceGroupName <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetById -``` -Get-AzureRmManagedApplication -Id <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmManagedApplication** cmdlet gets managed applications - -## EXAMPLES - -### Example 1: Get all managed applications under a resource group -``` -PS C:\>Get-AzureRmManagedApplication -ResourceGroupName "MyRG" -``` - -This command gets managed applications under resource group "MyRG" - -### Example 2: Get all managed applications -``` -PS C:\>Get-AzureRmManagedApplication -``` - -This command get all managed applications under the current subscription - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The fully qualified managed application Id, including the subscription. -e.g. -/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName} - -```yaml -Type: System.String -Parameter Sets: GetById -Aliases: ResourceId, ManagedApplicationId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The managed application name. - -```yaml -Type: System.String -Parameter Sets: GetByNameAndResourceGroup -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: GetByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Management.Automation.PSObject - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmManagedApplicationDefinition.md b/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmManagedApplicationDefinition.md deleted file mode 100644 index fab56c3c86..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmManagedApplicationDefinition.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermmanagedapplicationdefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmManagedApplicationDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmManagedApplicationDefinition.md ---- - -# Get-AzureRmManagedApplicationDefinition - -## SYNOPSIS -Gets managed application definitions - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetByNameAndResourceGroup (Default) -``` -Get-AzureRmManagedApplicationDefinition [-Name <String>] -ResourceGroupName <String> [-ApiVersion <String>] - [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetById -``` -Get-AzureRmManagedApplicationDefinition -Id <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmManagedApplicationDefinition** cmdlet gets managed application definitions - -## EXAMPLES - -### Example 1: Get all managed application definitions under a resource group -``` -PS C:\>Get-AzureRmManagedApplicationDefinition -ResourceGroupName "MyRG" -``` - -This command gets the managed application definitions under resource group "MyRG" - -### Example 2: Get a managed application definition -``` -PS C:\>Get-AzureRmManagedApplicationDefinition -ResourceGroupName "MyRG" -Name "myManagedAppDef" -``` - -This command gets the managed application definition "myManagedAppDef" under resource group "MyRG" - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The fully qualified managed application definition Id, including the subscription. -e.g. -/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName} - -```yaml -Type: System.String -Parameter Sets: GetById -Aliases: ResourceId, ManagedApplicationDefinitionId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The managed application definition name. - -```yaml -Type: System.String -Parameter Sets: GetByNameAndResourceGroup -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: GetByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Management.Automation.PSObject - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmManagementGroup.md b/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmManagementGroup.md deleted file mode 100644 index d433d1dcba..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmManagementGroup.md +++ /dev/null @@ -1,238 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermmanagementgroup/ -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmManagementGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmManagementGroup.md ---- - -# Get-AzureRmManagementGroup - -## SYNOPSIS -Gets Management Group(s) - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ListOperation (Default) -``` -Get-AzureRmManagementGroup [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### GetOperation -``` -Get-AzureRmManagementGroup [-GroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-Expand] - [-Recurse] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRMManagementGroup cmdlet Gets all or a specific Management Group. - -## EXAMPLES - -### Example 1: Get all Management Groups -``` -PS C:\> Get-AzureRmManagementGroup - -Id : /providers/Microsoft.Management/managementGroups/TestGroup -Type : /providers/Microsoft.Management/managementGroups -Name : TestGroup -TenantId : 00001111-aaaa-2222-bbbb-3333cccc4444 -DisplayName : TestGroupDisplayName - -Id : /providers/Microsoft.Management/managementGroups/TestGroupChild -Type : /providers/Microsoft.Management/managementGroups -Name : TestGroupChild -TenantId : 00001111-aaaa-2222-bbbb-3333cccc4444 -DisplayName : TestGroupChildDisplayName -``` - -### Example 2: Get specific Management Group -``` -PS C:\> Get-AzureRmManagementGroup -GroupName TestGroup - -Id : /providers/Microsoft.Management/managementGroups/TestGroup -Type : /providers/Microsoft.Management/managementGroups -Name : TestGroup -TenantId : 00001111-aaaa-2222-bbbb-3333cccc4444 -DisplayName : TestGroupDisplayName -UpdatedTime : 2/1/2018 11:16:12 AM -UpdatedBy : 64360beb-ffb4-43a8-9314-01aa34db95a9 -ParentId : /providers/Microsoft.Management/managementGroups/TestGroupParent -ParentName : TestGroupParent -ParentDisplayName : TestGroupParent -``` - -### Example 3: Get specific Management Group and first level of hierarchy -``` -PS C:\> $reponse = Get-AzureRmManagementGroup -GroupName TestGroupParent -Expand -PS C:\> $response - -Id : /providers/Microsoft.Management/managementGroups/TestGroupParent -Type : /providers/Microsoft.Management/managementGroups -Name : TestGroupParent -TenantId : 00001111-aaaa-2222-bbbb-3333cccc4444 -DisplayName : TestGroupParent -UpdatedTime : 2/1/2018 11:15:46 AM -UpdatedBy : 64360beb-ffb4-43a8-9314-01aa34db95a9 -ParentId : /providers/Microsoft.Management/managementGroups/00001111-aaaa-2222-bbbb-3333cccc4444 -ParentName : 00001111-aaaa-2222-bbbb-3333cccc4444 -ParentDisplayName : 00001111-aaaa-2222-bbbb-3333cccc4444 -Children : {TestGroup1DisplayName, TestGroup2DisplayName} - -PS C:\> $response.Children[0] - -Type : /managementGroup -Id : /providers/Microsoft.Management/managementGroups/TestGroup1 -Name : TestGroup1 -DisplayName : TestGroup1DisplayName -Children : -``` - -With the `Expand` flag, one can navigate through the `Children` array and get details for each child. For example, `Children[0]` will give details for the group with display name `TestGroup1DisplayName`. - -### Example 4: Get specific Management Group and all levels of hiearchy -``` -PS C:\> $response = Get-AzureRmManagementGroup -GroupName TestGroupParent -Expand -Recurse -PS C:\> $response - -Id : /providers/Microsoft.Management/managementGroups/TestGroupParent -Type : /providers/Microsoft.Management/managementGroups -Name : TestGroupParent -TenantId : 00001111-aaaa-2222-bbbb-3333cccc4444 -DisplayName : TestGroupParent -UpdatedTime : 2/1/2018 11:15:46 AM -UpdatedBy : 64360beb-ffb4-43a8-9314-01aa34db95a9 -ParentId : /providers/Microsoft.Management/managementGroups/00001111-aaaa-2222-bbbb-3333cccc4444 -ParentName : 00001111-aaaa-2222-bbbb-3333cccc4444 -ParentDisplayName : 00001111-aaaa-2222-bbbb-3333cccc4444 -Children : {TestGroup1DisplayName, TestGroup2DisplayName} - -PS C:\> $response.Children[0] - -Type : /managementGroup -Id : /providers/Microsoft.Management/managementGroups/TestGroup1 -Name : TestGroup1 -DisplayName : TestGroup1DisplayName -Children : {TestRecurseChild} - -PS C:\> $response.Children[0].Children[0] - -Type : /managementGroup -Id : /providers/Microsoft.Management/managementGroups/TestRecurseChild -Name : TestRecurseChild -DisplayName : TestRecurseChild -Children : -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expand -Expand the output to list the children of the management group - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: GetOperation -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupName -Management Group Id - -```yaml -Type: System.String -Parameter Sets: GetOperation -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Recurse -Recursively list the children of the management group - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: GetOperation -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Resources.Models.ManagementGroups.PSManagementGroupInfo - -### Microsoft.Azure.Commands.Resources.Models.ManagementGroups.PSManagementGroup - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmPolicyAlias.md b/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmPolicyAlias.md deleted file mode 100644 index 3b8fcd182a..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmPolicyAlias.md +++ /dev/null @@ -1,387 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRm.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermpolicyalias -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmPolicyAlias.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmPolicyAlias.md ---- - -# Get-AzureRmPolicyAlias - -## SYNOPSIS -Get-AzureRmPolicyAlias retrieves and outputs Azure provider resource types that have aliases defined and match the -given parameter values. If no parameters are provided, all provider resource types that contain an alias will be output. -The -ListAvailable switch modifies this behavior by listing all matching resource types including those without aliases. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmPolicyAlias [-NamespaceMatch <String>] [-ResourceTypeMatch <String>] [-AliasMatch <String>] - [-PathMatch <String>] [-ApiVersionMatch <String>] [-LocationMatch <String>] [-ListAvailable] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmPolicyAlias** cmdlet gets a listing of policy aliases. -Policy aliases are used by Azure Policy to refer to resource type properties. -Parameters are provided that limit items in the listing by matching various properties of the resource type or its aliases. -A given match value matches if the target string contains it using case insensitive comparison. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmPolicyAlias - -Namespace ResourceType Aliases ---------- ------------ ------- -Microsoft.AnalysisServices servers {Microsoft.AnalysisServices/servers/state, Microsoft.AnalysisServices/s... -Microsoft.Authorization roleAssignments {Microsoft.Authorization/roleAssignments/roleDefinitionId, Microsoft.Au... -Microsoft.Authorization roleDefinitions {Microsoft.Authorization/roleDefinitions/type, Microsoft.Authorization/... - -... ... ... - -Microsoft.Web hostingEnvironments {Microsoft.Web/hostingEnvironments/clusterSettings[*].name, Microsoft.W... -Microsoft.Web sites/config {Microsoft.Web/sites/config/httpLoggingEnabled, Microsoft.Web/sites/con... -Microsoft.GuestConfiguration guestConfigurationAssignments {Microsoft.GuestConfiguration/guestConfigurationAssignments/complianceS... - - -PS C:\> -``` - -Lists all provider resource types that have an alias. - -### Example 2 -```powershell -PS C:\> Get-AzureRmPolicyAlias -ListAvailable - -Namespace ResourceType Aliases ---------- ------------ ------- - -... ... ... - -Microsoft.AlertsManagement operations {} -Microsoft.AnalysisServices servers {Microsoft.AnalysisServices/servers/sta... -Microsoft.AnalysisServices locations {} - -... ... ... - - -PS C:\> -``` - -Lists all provider resource types, including those without aliases. - -### Example 3 -```powershell -PS C:\> Get-AzureRmPolicyAlias -NamespaceMatch 'compute' - -Namespace ResourceType Aliases ---------- ------------ ------- -Microsoft.Compute virtualMachines {Microsoft.Compute/licenseType, Microsoft.Compute/virtualMachines/availabilitySet.id, Microsoft... -Microsoft.Compute virtualMachines/extensions {Microsoft.Compute/virtualMachines/extensions/provisioningState, Microsoft.Compute/virtualMachi... -Microsoft.Compute virtualMachineScaleSets {Microsoft.Compute/VirtualMachineScaleSets/sku.name, Microsoft.Compute/VirtualMachineScaleSets/... -Microsoft.Compute virtualMachineScaleSets/extensions {Microsoft.Compute/virtualMachineScaleSets/extensions/provisioningState, Microsoft.Compute/virt... -Microsoft.Compute disks {Microsoft.Compute/imagePublisher, Microsoft.Compute/imageOffer, Microsoft.Compute/imageSku, Mi... - - -PS C:\> -``` - -Lists all provider resource types whose namespace matches 'compute' and contain an alias. - -### Example 4 -```powershell -PS C:\> Get-AzureRmPolicyAlias -ResourceTypeMatch 'virtual' - -Namespace ResourceType Aliases ---------- ------------ ------- -Microsoft.Compute virtualMachines {Microsoft.Compute/licenseType, Microsoft.Compute/virtualMachines/availabilitySet.id, Micro... -Microsoft.Compute virtualMachines/extensions {Microsoft.Compute/virtualMachines/extensions/provisioningState, Microsoft.Compute/virtualM... -Microsoft.Compute virtualMachineScaleSets {Microsoft.Compute/VirtualMachineScaleSets/sku.name, Microsoft.Compute/VirtualMachineScaleS... -Microsoft.Compute virtualMachineScaleSets/extensions {Microsoft.Compute/virtualMachineScaleSets/extensions/provisioningState, Microsoft.Compute/... -Microsoft.Network virtualNetworks {Microsoft.Network/virtualNetworks/subnets[*].routeTable.id, Microsoft.Network/virtualNetwo... -Microsoft.Network virtualNetworkGateways {Microsoft.Network/virtualNetworkGateways/sku.name, Microsoft.Network/virtualNetworkGateway... -Microsoft.Network virtualNetworks/subnets {Microsoft.Network/virtualNetworks/subnets/routeTable.id, Microsoft.Network/virtualNetworks... -Microsoft.Network virtualNetworks/virtualNetworkPeerings {Microsoft.Network/virtualNetworks/virtualNetworkPeerings/remoteVirtualNetwork.id} -Microsoft.Sql servers/virtualNetworkRules {Microsoft.Sql/servers/virtualNetworkRules/virtualNetworkSubnetId, Microsoft.Sql/servers/vi... - - -PS C:\> -``` - -Lists all provider resource types whose resource type matches 'virtual' and contain an alias. - -### Example 5 -```powershell -PS C:\> Get-AzureRmPolicyAlias -ResourceTypeMatch 'virtual' -ListAvailable - -Namespace ResourceType Aliases ---------- ------------ ------- - -... ... ... - -Microsoft.KeyVault locations/deleteVirtualNetworkOrSubnets {} -Microsoft.Network virtualNetworks {Microsoft.Network/virtualNetworks/subnets[*].routeTable.id,... -Microsoft.Network virtualNetworkGateways {Microsoft.Network/virtualNetworkGateways/sku.name, Microsof... -Microsoft.Network locations/virtualNetworkAvailableEndpointServices {} - -... ... ... - - -PS C:\> -``` - -Lists all provider resource types whose resource type matches 'virtual', including those without aliases. - -### Example 6 -```powershell -PS C:\> Get-AzureRmPolicyAlias -NamespaceMatch 'compute' -ResourceTypeMatch 'virtual' - -Namespace ResourceType Aliases ---------- ------------ ------- -Microsoft.Compute virtualMachines {Microsoft.Compute/licenseType, Microsoft.Compute/virtualMachines/availabilitySet.id, Microsoft... -Microsoft.Compute virtualMachines/extensions {Microsoft.Compute/virtualMachines/extensions/provisioningState, Microsoft.Compute/virtualMachi... -Microsoft.Compute virtualMachineScaleSets {Microsoft.Compute/VirtualMachineScaleSets/sku.name, Microsoft.Compute/VirtualMachineScaleSets/... -Microsoft.Compute virtualMachineScaleSets/extensions {Microsoft.Compute/virtualMachineScaleSets/extensions/provisioningState, Microsoft.Compute/virt... - - -PS C:\> -``` - -Lists all provider resource types whose namespace matches 'compute' and resource type matches 'virtual' and contain an alias. -Note: -NamespaceMatch and -ResourceTypeMatch provide exclusive matches, whereas the others are inclusive. - -### Example 7 -```powershell -PS C:\> Get-AzureRmPolicyAlias -AliasMatch 'virtual' - -Namespace ResourceType Aliases ---------- ------------ ------- -Microsoft.Compute virtualMachines {Microsoft.Compute/licenseType, Microsoft.Compute/virtualMachines/availabilitySet.id, Mi... -Microsoft.Compute virtualMachines/extensions {Microsoft.Compute/virtualMachines/extensions/provisioningState, Microsoft.Compute/virtu... -Microsoft.Compute virtualMachineScaleSets {Microsoft.Compute/VirtualMachineScaleSets/sku.name, Microsoft.Compute/VirtualMachineSca... -Microsoft.Compute virtualMachineScaleSets/extensions {Microsoft.Compute/virtualMachineScaleSets/extensions/provisioningState, Microsoft.Compu... -Microsoft.DocumentDB databaseAccounts {Microsoft.DocumentDB/databaseAccounts/sku.name, Microsoft.DocumentDB/databaseAccounts/v... -Microsoft.HDInsight clusters {Microsoft.HDInsight/clusters/clusterVersion, Microsoft.HDInsight/clusters/osType, Micro... -Microsoft.KeyVault vaults {Microsoft.KeyVault/vaults/sku.name, Microsoft.KeyVault/vaults/sku.family, Microsoft.Key... -Microsoft.Network virtualNetworks {Microsoft.Network/virtualNetworks/subnets[*].routeTable.id, Microsoft.Network/virtualNe... -Microsoft.Network virtualNetworkGateways {Microsoft.Network/virtualNetworkGateways/sku.name, Microsoft.Network/virtualNetworkGate... -Microsoft.Network virtualNetworks/subnets {Microsoft.Network/virtualNetworks/subnets/routeTable.id, Microsoft.Network/virtualNetwo... -Microsoft.Network virtualNetworks/virtualNetworkPeerings {Microsoft.Network/virtualNetworks/virtualNetworkPeerings/remoteVirtualNetwork.id} -Microsoft.Sql servers/virtualNetworkRules {Microsoft.Sql/servers/virtualNetworkRules/virtualNetworkSubnetId, Microsoft.Sql/servers... -Microsoft.Storage storageAccounts {Microsoft.Storage/storageAccounts/accountType, Microsoft.Storage/storageAccounts/sku.na... - - -PS C:\> -``` - -Lists all provider resource types that contain an alias matching 'virtual'. - -### Example 8 -```powershell -PS C:\> Get-AzureRmPolicyAlias -AliasMatch 'virtual' -PathMatch 'network' - -Namespace ResourceType Aliases ---------- ------------ ------- -Microsoft.Compute virtualMachines {Microsoft.Compute/licenseType, Microsoft.Compute/virtualMachines/availabilitySet.id, Mi... -Microsoft.Compute virtualMachines/extensions {Microsoft.Compute/virtualMachines/extensions/provisioningState, Microsoft.Compute/virtu... -Microsoft.Compute virtualMachineScaleSets {Microsoft.Compute/VirtualMachineScaleSets/sku.name, Microsoft.Compute/VirtualMachineSca... -Microsoft.Compute virtualMachineScaleSets/extensions {Microsoft.Compute/virtualMachineScaleSets/extensions/provisioningState, Microsoft.Compu... -Microsoft.DocumentDB databaseAccounts {Microsoft.DocumentDB/databaseAccounts/sku.name, Microsoft.DocumentDB/databaseAccounts/v... -Microsoft.HDInsight clusters {Microsoft.HDInsight/clusters/clusterVersion, Microsoft.HDInsight/clusters/osType, Micro... -Microsoft.KeyVault vaults {Microsoft.KeyVault/vaults/sku.name, Microsoft.KeyVault/vaults/sku.family, Microsoft.Key... -Microsoft.Network virtualNetworks {Microsoft.Network/virtualNetworks/subnets[*].routeTable.id, Microsoft.Network/virtualNe... -Microsoft.Network networkInterfaces {Microsoft.Network/networkInterfaces/ipconfigurations[*].subnet.id, Microsoft.Network/ne... -Microsoft.Network networkSecurityGroups {Microsoft.Network/networkSecurityGroups/securityRules[*].protocol, Microsoft.Network/ne... -Microsoft.Network virtualNetworkGateways {Microsoft.Network/virtualNetworkGateways/sku.name, Microsoft.Network/virtualNetworkGate... -Microsoft.Network virtualNetworks/subnets {Microsoft.Network/virtualNetworks/subnets/routeTable.id, Microsoft.Network/virtualNetwo... -Microsoft.Network virtualNetworks/virtualNetworkPeerings {Microsoft.Network/virtualNetworks/virtualNetworkPeerings/remoteVirtualNetwork.id} -Microsoft.Sql servers/virtualNetworkRules {Microsoft.Sql/servers/virtualNetworkRules/virtualNetworkSubnetId, Microsoft.Sql/servers... -Microsoft.Storage storageAccounts {Microsoft.Storage/storageAccounts/accountType, Microsoft.Storage/storageAccounts/sku.na... - - -PS C:\> -``` - -Lists all provider resource types that contain an alias matching 'virtual' or an alias with a path matching 'network'. - -### Example 9 -```powershell -PS C:\> Get-AzureRmPolicyAlias -ApiVersionMatch 'alpha' - -Namespace ResourceType Aliases ---------- ------------ ------- -Microsoft.Cache Redis {Microsoft.Cache/Redis/sku.name, Microsoft.Cache/Redis/sku.family, Microsoft.Cache/Redis/sku.capacity, Micros... -Microsoft.Cache Redis/firewallrules {Microsoft.Cache/Redis/firewallrules/startIP, Microsoft.Cache/Redis/firewallrules/endIP} -Microsoft.Security alerts {Microsoft.Security/alerts/state} -Microsoft.Security pricings {Microsoft.Security/pricings/pricingTier} -Microsoft.Security complianceResults {Microsoft.Security/complianceResults/resourceStatus} - - -PS C:\> -``` - -Lists all provider resource types with alpha api version or containing an alias with an alpha api version. - -## PARAMETERS - -### -AliasMatch -Includes in the output items with aliases whose name matches this value. -```yaml -Type: String -Parameter Sets: (All) -Aliases: Alias - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApiVersion -When set, indicates the version of the resource provider API to use. If not specified, the API version is automatically determined as the latest available. -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApiVersionMatch -Includes in the output items whose resource types or aliases have a matching api version. -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ListAvailable -Includes in the output matching items with and without aliases. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: ShowAll - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocationMatch -Includes in the output items whose resource types have a matching location. -```yaml -Type: String -Parameter Sets: (All) -Aliases: Location - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NamespaceMatch -Limits the output to items whose namespace matches this value. -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name, Namespace - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PathMatch -Includes in the output items with aliases containing a path that matches this value. -```yaml -Type: String -Parameter Sets: (All) -Aliases: Path - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceTypeMatch -Limits the output to items whose resource type matches this value. -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceType, Resource - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.PsResourceProviderAlias - -## NOTES - -* To expand the Aliases or any other property, pipe the output to `select -ExpandProperty <property>`. For example: `Get-AzureRmPolicyAlias -NamespaceMatch 'Microsoft.Cache' -ApiVersionMatch 'alpha' | select -ExpandProperty Aliases | select -Property Name -ExpandProperty Paths` - -* Additional properties are available in the output and can be displayed by piping the output to `Format-List`. For example: `Get-AzureRmPolicyAlias -NamespaceMatch 'Web' -ResourceTypeMatch site -PathMatch cert | Format-List` - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmPolicyAssignment.md b/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmPolicyAssignment.md deleted file mode 100644 index 568d8b03d5..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmPolicyAssignment.md +++ /dev/null @@ -1,255 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 2DBAF415-A039-479E-B3CA-E00FD5E476C9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermpolicyassignment -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmPolicyAssignment.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmPolicyAssignment.md ---- - -# Get-AzureRmPolicyAssignment - -## SYNOPSIS -Gets policy assignments. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameterSet (Default) -``` -Get-AzureRmPolicyAssignment [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>] -``` - -### NameParameterSet -``` -Get-AzureRmPolicyAssignment [-Name <String>] [-Scope <String>] [-PolicyDefinitionId <String>] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>] -``` - -### IncludeDescendentParameterSet -``` -Get-AzureRmPolicyAssignment [-Scope <String>] [-IncludeDescendent] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [<CommonParameters>] -``` - -### IdParameterSet -``` -Get-AzureRmPolicyAssignment -Id <String> [-PolicyDefinitionId <String>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmPolicyAssignment** cmdlet gets all policy assignments or particular assignments. -Identify a policy assignment to get by name and scope or by ID. - -## EXAMPLES - -### Example 1: Get all policy assignments -``` -PS C:\> Get-AzureRmPolicyAssignment -``` - -This command gets all the policy assignments. - -### Example 2: Get a specific policy assignment -``` -PS C:\> $ResourceGroup = Get-AzureRmResourceGroup -Name 'ResourceGroup11' -PS C:\> Get-AzureRmPolicyAssignment -Name 'PolicyAssignment07' -Scope $ResourceGroup.ResourceId -``` - -The first command gets a resource group named ResourceGroup11 by using the Get-AzureRMResourceGroup cmdletand stores it in the $ResourceGroup variable. -The second command gets the policy assignment named PolicyAssignment07 for the scope that the **ResourceId** property of $ResourceGroup identifies. - -### Example 3: Get all policy assignments assigned to a management group -``` -PS C:\> $mgId = 'myManagementGroup' -PS C:\> Get-AzureRmPolicyAssignment -Scope '/providers/Microsoft.Management/managementgroups/$mgId' -``` - -The first command specifies the ID of the management group to query. -The second command gets all of the policy assignments that are assigned to the management group with ID 'myManagementGroup'. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. -If you do not specify a version, this cmdlet uses the latest available version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the fully qualified resource ID for the policy assignment that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: IdParameterSet -Aliases: ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IncludeDescendent -Causes the list of returned policy assignments to include all assignments related to the given scope, including those from ancestor scopes and those from descendent scopes. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: IncludeDescendentParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InformationAction -Specifies how this cmdlet responds to an information event. -The acceptable values for this parameter are: -- Continue -- Ignore -- Inquire -- SilentlyContinue -- Stop -- Suspend - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: infa - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationVariable -Specifies an information variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: iv - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the policy assignment that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PolicyDefinitionId -Specifies the ID of the policy definition of the policy assignments that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet, IdParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Specifies the scope at which the policy is applied for the assignment that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet, IncludeDescendentParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-AzureRmPolicyAssignment](./New-AzureRmPolicyAssignment.md) - -[Remove-AzureRmPolicyAssignment](./Remove-AzureRmPolicyAssignment.md) - -[Set-AzureRmPolicyAssignment](./Set-AzureRmPolicyAssignment.md) - - diff --git a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmPolicyDefinition.md b/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmPolicyDefinition.md deleted file mode 100644 index 4f5f2b5673..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmPolicyDefinition.md +++ /dev/null @@ -1,311 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 6396AEC3-DFE6-45DA-BCF4-69C55C5D051B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermpolicydefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmPolicyDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmPolicyDefinition.md ---- - -# Get-AzureRmPolicyDefinition - -## SYNOPSIS -Gets policy definitions. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameParameterSet (Default) -``` -Get-AzureRmPolicyDefinition [-Name <String>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [<CommonParameters>] -``` - -### ManagementGroupNameParameterSet -``` -Get-AzureRmPolicyDefinition [-Name <String>] -ManagementGroupName <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [<CommonParameters>] -``` - -### SubscriptionIdParameterSet -``` -Get-AzureRmPolicyDefinition [-Name <String>] -SubscriptionId <Guid> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [<CommonParameters>] -``` - -### IdParameterSet -``` -Get-AzureRmPolicyDefinition -Id <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [<CommonParameters>] -``` - -### BuiltinFilterParameterSet -``` -Get-AzureRmPolicyDefinition [-ManagementGroupName <String>] [-SubscriptionId <Guid>] [-Builtin] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>] -``` - -### CustomFilterParameterSet -``` -Get-AzureRmPolicyDefinition [-ManagementGroupName <String>] [-SubscriptionId <Guid>] [-Custom] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmPolicyDefinition** cmdlet gets a collection of policy definitions or a specific policy definition identified by name or ID. - -## EXAMPLES - -### Example 1: Get all policy definitions -``` -PS C:\> Get-AzureRmPolicyDefinition -``` - -This command gets all the policy definitions. - -### Example 2: Get policy definition from current subscription by name -``` -PS C:\> Get-AzureRmPolicyDefinition -Name 'VMPolicyDefinition' -``` - -This command gets the policy definition named VMPolicyDefinition from the current default subscription. - -### Example 3: Get policy definition from management group by name -``` -PS C:\> Get-AzureRmPolicyDefinition -Name 'VMPolicyDefinition' -ManagementGroupName 'Dept42' -``` - -This command gets the policy definition named VMPolicyDefinition from the management group named Dept42. - -### Example 4: Get all built-in policy definitions from subscription -``` -PS C:\> Get-AzureRmPolicyDefinition -SubscriptionId '3bf44b72-c631-427a-b8c8-53e2595398ca' -Builtin -``` - -This command gets all built-in policy definitions from the subscription with ID 3bf44b72-c631-427a-b8c8-53e2595398ca. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. -If you do not specify a version, this cmdlet uses the latest available version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Builtin -Limits list of results to only built-in policy definitions. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: BuiltinFilterParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Custom -Limits list of results to only custom policy definitions. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: CustomFilterParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the fully qualified resource ID for the policy definition that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: IdParameterSet -Aliases: ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InformationAction -Specifies how this cmdlet responds to an information event. -The acceptable values for this parameter are: -- Continue -- Ignore -- Inquire -- SilentlyContinue -- Stop -- Suspend - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: infa - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationVariable -Specifies an information variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: iv - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagementGroupName -The name of the management group of the policy definition(s) to get. - -```yaml -Type: System.String -Parameter Sets: ManagementGroupNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: BuiltinFilterParameterSet, CustomFilterParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the policy definition that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet, ManagementGroupNameParameterSet, SubscriptionIdParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The subscription ID of the policy definition(s) to get. - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: SubscriptionIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: BuiltinFilterParameterSet, CustomFilterParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-AzureRmPolicyDefinition](./New-AzureRmPolicyDefinition.md) - -[Remove-AzureRmPolicyDefinition](./Remove-AzureRmPolicyDefinition.md) - -[Set-AzureRmPolicyDefinition](./Set-AzureRmPolicyDefinition.md) - - diff --git a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmPolicySetDefinition.md b/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmPolicySetDefinition.md deleted file mode 100644 index f91908d41c..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmPolicySetDefinition.md +++ /dev/null @@ -1,267 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermpolicysetdefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmPolicySetDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmPolicySetDefinition.md ---- - -# Get-AzureRmPolicySetDefinition - -## SYNOPSIS -Gets policy set definitions. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameParameterSet (Default) -``` -Get-AzureRmPolicySetDefinition [-Name <String>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ManagementGroupNameParameterSet -``` -Get-AzureRmPolicySetDefinition [-Name <String>] -ManagementGroupName <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SubscriptionIdParameterSet -``` -Get-AzureRmPolicySetDefinition [-Name <String>] -SubscriptionId <Guid> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### IdParameterSet -``` -Get-AzureRmPolicySetDefinition -Id <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### BuiltinFilterParameterSet -``` -Get-AzureRmPolicySetDefinition [-ManagementGroupName <String>] [-SubscriptionId <Guid>] [-Builtin] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### CustomFilterParameterSet -``` -Get-AzureRmPolicySetDefinition [-ManagementGroupName <String>] [-SubscriptionId <Guid>] [-Custom] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmPolicySetDefinition** cmdlet gets a collection of policy set definitions or a specific policy set definition identified by name or ID. - -## EXAMPLES - -### Example 1: Get all policy set definitions -``` -PS C:\> Get-AzureRmPolicySetDefinition -``` - -This command gets all the policy set definitions. - -### Example 2: Get policy set definition from current subscription by name -``` -PS C:\> Get-AzureRmPolicySetDefinition -Name 'VMPolicySetDefinition' -``` - -This command gets the policy set definition named VMPolicySetDefinition from the current default subscription. - -### Example 3: Get policy set definition from subscription by name -``` -PS C:\> Get-AzureRmPolicySetDefinition -Name 'VMPolicySetDefinition' -subscriptionId '3bf44b72-c631-427a-b8c8-53e2595398ca' -``` - -This command gets the policy definition named VMPolicySetDefinition from the subscription with ID 3bf44b72-c631-427a-b8c8-53e2595398ca. - -### Example 4: Get all custom policy set definitions from management group -``` -PS C:\> Get-AzureRmPolicySetDefinition -ManagementGroupName 'Dept42' -Custom -``` - -This command gets all custom policy set definitions from the management group named Dept42. - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Builtin -Limits list of results to only built-in policy set definitions. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: BuiltinFilterParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Custom -Limits list of results to only custom policy set definitions. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: CustomFilterParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The fully qualified policy set definition Id, including the subscription. -e.g. -/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName} - -```yaml -Type: System.String -Parameter Sets: IdParameterSet -Aliases: ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ManagementGroupName -The name of the management group of the policy set definition(s) to get. - -```yaml -Type: System.String -Parameter Sets: ManagementGroupNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: BuiltinFilterParameterSet, CustomFilterParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The policy set definition name. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet, ManagementGroupNameParameterSet, SubscriptionIdParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The subscription ID of the policy set definition(s) to get. - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: SubscriptionIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: BuiltinFilterParameterSet, CustomFilterParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### System.Management.Automation.PSObject - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmProviderFeature.md b/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmProviderFeature.md deleted file mode 100644 index 017dd66aa9..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmProviderFeature.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 2970E81E-A788-4829-B1FF-B522A91DE4B1 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermproviderfeature -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmProviderFeature.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmProviderFeature.md ---- - -# Get-AzureRmProviderFeature - -## SYNOPSIS -Gets information about Azure provider features. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ListAvailableParameterSet (Default) -``` -Get-AzureRmProviderFeature [-ProviderNamespace <String>] [-ListAvailable] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetFeature -``` -Get-AzureRmProviderFeature -ProviderNamespace <String> -FeatureName <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmProviderFeature** cmdlet gets the feature name, provider name, and registration status for Azure provider features. - -## EXAMPLES - -### Example 1: Get all available features -``` -PS C:\>Get-AzureRmProviderFeature -ListAvailable -``` - -This command gets all available features. - -### Example 2: Get information about a specific feature -``` -PS C:\>Get-AzureRmProviderFeature -FeatureName "AllowPreReleaseRegions" -ProviderNamespace "Microsoft.Compute" -``` - -This command gets information for the feature named AllowPreReleaseRegions for the specified provider. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FeatureName -Specifies the name of the feature to get. - -```yaml -Type: System.String -Parameter Sets: GetFeature -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ListAvailable -Indicates that this cmdlet gets all features. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ListAvailableParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProviderNamespace -Specifies the namespace for which this cmdlet gets provider features. - -```yaml -Type: System.String -Parameter Sets: ListAvailableParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: GetFeature -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Register-AzureRmProviderFeature](./Register-AzureRmProviderFeature.md) - - diff --git a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmProviderOperation.md b/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmProviderOperation.md deleted file mode 100644 index c54e9545f0..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmProviderOperation.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 6424B740-DBFB-490C-AEAA-EDD60952B435 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermprovideroperation -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmProviderOperation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmProviderOperation.md ---- - -# Get-AzureRmProviderOperation - -## SYNOPSIS -Gets the operations for an Azure resource provider that are securable using Azure RBAC. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmProviderOperation [[-OperationSearchString] <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmProviderOperation gets the operations exposed by Azure resource providers. -Operations can be composed to create custom roles in Azure RBAC. -The command takes as input an operation search string (with possible wildcard(*) character(s)) which determines the operations details to display. -Use Get-AzureRmProviderOperation * to get all operations for all Azure resource providers. -Use Get-AzureRmProviderOperation Microsoft.Compute/* to get all operations of Microsoft.Compute resource provider. - -## EXAMPLES - -### Get all actions for all providers -``` -PS C:\> Get-AzureRmProviderOperation * -``` - -### Get actions for a particular resource provider -``` -PS C:\> Get-AzureRmProviderOperation Microsoft.Insights/* -``` - -### Get all actions that can be performed on virtual machines -``` -PS C:\> Get-AzureRmProviderOperation */virtualMachines/* -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OperationSearchString -The operation search string (with possible wildcard (*) characters) - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: False -Position: 0 -Default value: "*" -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: OperationSearchString (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Resources.Models.PSResourceProviderOperation - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmResource.md b/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmResource.md deleted file mode 100644 index 2db94f1699..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmResource.md +++ /dev/null @@ -1,356 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: C2C608E5-3351-4D01-8533-9668B2E9F1D1 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermresource -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResource.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResource.md ---- - -# Get-AzureRmResource - -## SYNOPSIS - -Gets resources. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByTagNameValueParameterSet (Default) -``` -Get-AzureRmResource [[-Name] <String>] [-ResourceType <String>] [-ODataQuery <String>] - [-ResourceGroupName <String>] [-TagName <String>] [-TagValue <String>] [-ExpandProperties] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByResourceId -``` -Get-AzureRmResource -ResourceId <String> [-ExpandProperties] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByTagObjectParameterSet -``` -Get-AzureRmResource [[-Name] <String>] [-ResourceType <String>] [-ODataQuery <String>] - [-ResourceGroupName <String>] -Tag <Hashtable> [-ExpandProperties] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION - -The **Get-AzureRmResource** cmdlet gets Azure resources. - -## EXAMPLES - -### Example 1: Get all resources in the current subscription - -``` -PS C:\> Get-AzureRmResource | ft - -Name ResourceGroupName ResourceType Location ----- ----------------- ------------ -------- -testVM testRG Microsoft.Compute/virtualMachines westus -disk testRG Microsoft.Compute/disks westus -nic testRG Microsoft.Network/networkInterfaces westus -nsg testRG Microsoft.Network/networkSecurityGroups westus -ip testRG Microsoft.Network/publicIPAddresses westus -vnet testRG Microsoft.Network/virtualNetworks westus -testKV otherRG Microsoft.KeyVault/vaults eastus -storage otherResourceGroup Microsoft.Storage/storageAccounts eastus -testVM2 otherResourceGroup Microsoft.Compute/virtualMachines eastus -``` - -This command gets all of the resources in the current subscription. - -### Example 2: Get all resources in a resource group - -``` -PS C:\> Get-AzureRmResource -ResourceGroupName testRG | ft - -Name ResourceGroupName ResourceType Location ----- ----------------- ------------ -------- -testVM testRG Microsoft.Compute/virtualMachines westus -disk testRG Microsoft.Compute/disks westus -nic testRG Microsoft.Network/networkInterfaces westus -nsg testRG Microsoft.Network/networkSecurityGroups westus -ip testRG Microsoft.Network/publicIPAddresses westus -vnet testRG Microsoft.Network/virtualNetworks westus -``` - -This command gets all of the resources in the resource group "testRG". - -### Example 3: Get all resources whose resource group matches the provided wildcard - -``` -PS C:\> Get-AzureRmResource -ResourceGroupName other* | ft - -Name ResourceGroupName ResourceType Location ----- ----------------- ------------ -------- -testKV otherRG Microsoft.KeyVault/vaults eastus -storage otherResourceGroup Microsoft.Storage/storageAccounts eastus -testVM2 otherResourceGroup Microsoft.Compute/virtualMachines eastus -``` - -This command gets all of the resources whose resource group they belong in beings with "other". - -### Example 4: Get all resources with a given name - -``` -PS C:\> Get-AzureRmResource -Name testVM | fl - -Name : testVM -ResourceGroupName : testRG -ResourceType : Microsoft.Compute/virtualMachines -Location : westus -ResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testRG/providers/Microsoft.Compute/virtualMachines/testVM -``` - -This command gets all of the resources whose resource name is "testVM". - -### Example 5: Get all resources whose name matches the provided wildcard - -``` -PS C:\> Get-AzureRmResource -Name test* | ft - -Name ResourceGroupName ResourceType Location ----- ----------------- ------------ -------- -testVM testRG Microsoft.Compute/virtualMachines westus -testKV otherRG Microsoft.KeyVault/vaults eastus -testVM2 otherResourceGroup Microsoft.Compute/virtualMachines eastus -``` - -This command gets all of the resources whose resource name begins with "test". - -### Example 6: Get all resources of a given resource type - -``` -PS C:\> Get-AzureRmResource -ResourceType Microsoft.Compute/virtualMachines | ft - -Name ResourceGroupName ResourceType Location ----- ----------------- ------------ -------- -testVM testRG Microsoft.Compute/virtualMachines westus -testVM2 otherResourceGroup Microsoft.Compute/virtualMachines eastus -``` - -This command gets all of the resources in the current subscriptions that are virtual machines. - -### Example 7: Get a resource by resource id - -``` -PS C:\> Get-AzureRmResource -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testRG/providers/Microsoft.Compute/virtualMachines/testVM - -Name : testVM -ResourceGroupName : testRG -ResourceType : Microsoft.Compute/virtualMachines -Location : westus -ResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testRG/providers/Microsoft.Compute/virtualMachines/testVM -``` - -This command gets the resource with the provided resource id, which is a virtual machine called "testVM" in the resource group "testRG". - -## PARAMETERS - -### -ApiVersion - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpandProperties -When specified, expands the properties of the resource. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the resource(s) to be retrieved. This parameter supports wildcards at the beginning and/or end of the string. - -```yaml -Type: System.String -Parameter Sets: ByTagNameValueParameterSet, ByTagObjectParameterSet -Aliases: ResourceName - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ODataQuery - -```yaml -Type: System.String -Parameter Sets: ByTagNameValueParameterSet, ByTagObjectParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pre - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group the resource(s) that is retireved belongs in. This parameter supports wildcards at the beginning and/or end of the string. - -```yaml -Type: System.String -Parameter Sets: ByTagNameValueParameterSet, ByTagObjectParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Specifies the fully qualified resource ID, as in the following example -`/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Compute/virtualMachines` - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceType -The resource type of the resource(s) to be retrieved. For example, Microsoft.Compute/virtualMachines - -```yaml -Type: System.String -Parameter Sets: ByTagNameValueParameterSet, ByTagObjectParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag - -Gets resources that have the specified Azure tag. Enter a hash table with a Name key or Name and Value keys. Wildcard characters are not supported.A "tag" is a name-value pair that you can apply to resources and resource groups. Use tags to categorize your resources, such as by department or cost center, or to track notes or comments about the resources. To add a tag to a resource, use the Tag parameter of the New-AzureRmResource or Set-AzureRmResource cmdlets. To create a predefined tag, use the New-AzureRmTag cmdlet. For help with hash tables in Windows PowerShell, run 'Get-Help about_Hashtables'. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: ByTagObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TagName -The key in the tag of the resource(s) to be retrieved. - -```yaml -Type: System.String -Parameter Sets: ByTagNameValueParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TagValue -The value in the tag of the resource(s) to be retrieved. - -```yaml -Type: System.String -Parameter Sets: ByTagNameValueParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.ResourceManagement.Models.PSResource - -## NOTES - -## RELATED LINKS - - -[Move-AzureRmResource](./Move-AzureRmResource.md) - -[New-AzureRmResource](./New-AzureRmResource.md) - -[Remove-AzureRmResource](./Remove-AzureRmResource.md) - -[Set-AzureRmResource](./Set-AzureRmResource.md) diff --git a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmResourceGroup.md b/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmResourceGroup.md deleted file mode 100644 index 4408b755ea..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmResourceGroup.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 5B17A241-BF36-48A6-BC29-4C32C08F5F94 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermresourcegroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResourceGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResourceGroup.md ---- - -# Get-AzureRmResourceGroup - -## SYNOPSIS -Gets resource groups. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetByResourceGroupName (Default) -``` -Get-AzureRmResourceGroup [-Name <String>] [-Location <String>] [-Tag <Hashtable>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetByResourceGroupId -``` -Get-AzureRmResourceGroup [-Location <String>] [-Id <String>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmResourceGroup** cmdlet gets Azure resource groups in the current subscription. -You can get all resource groups, or specify a resource group by name or by other properties. -By default, this cmdlet gets all resource groups in the current subscription. -For more information about Azure resources and Azure resource groups, see the New-AzureRmResourceGroup cmdlet. - -## EXAMPLES - -### Example 1: Get a resource group by name -``` -PS C:\>Get-AzureRmResourceGroup -Name "EngineerBlog" -``` - -This command gets the Azure resource group in your subscription named EngineerBlog. - -### Example 2: Get all tags of a resource group -``` -PS C:\>(Get-AzureRmResourceGroup -Name "ContosoRG").Tags -``` - -This command gets the resource group named ContosoRG, and displays the tags associated with that group. - -### Example 3: Show the Resource groups by location -``` -PS C:\> Get-AzureRmResourceGroup | - Sort Location,ResourceGroupName | - Format-Table -GroupBy Location ResourceGroupName,ProvisioningState,Tags -``` - -### Example 4: Show the names of all the Resource groups in a particular location -``` -PS C:\> Get-AzureRmResourceGroup -Location westus2 | - Sort ResourceGroupName | - Format-Wide ResourceGroupName -Column 4 -``` - -### Example 5: Show the Resource groups whose names begin with WebServer -``` -PS C:\> Get-AzureRmResourceGroup | Where ResourceGroupName -like WebServer* -``` - -## PARAMETERS - -### -ApiVersion -Specifies the API version that is supported by the resource Provider. -You can specify a different version than the default version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the resource group to get. -Wildcard characters are not permitted. - -```yaml -Type: System.String -Parameter Sets: GetByResourceGroupId -Aliases: ResourceGroupId, ResourceId - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the resource group to get. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the resource group to get. This parameter supports wildcards at the beginning and/or the end of the string. - -```yaml -Type: System.String -Parameter Sets: GetByResourceGroupName -Aliases: ResourceGroupName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -The tag hashtable to filter resource groups by. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: GetByResourceGroupName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.ResourceManagement.PSResourceGroup - -## NOTES - -## RELATED LINKS - -[New-AzureRmResourceGroup](./New-AzureRmResourceGroup.md) - -[Remove-AzureRmResourceGroup](./Remove-AzureRmResourceGroup.md) - -[Set-AzureRmResourceGroup](./Set-AzureRmResourceGroup.md) - - diff --git a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmResourceGroupDeployment.md b/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmResourceGroupDeployment.md deleted file mode 100644 index a987ff84d1..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmResourceGroupDeployment.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 20CB842B-F7A9-4052-85D9-0DF9586D5FEA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermresourcegroupdeployment -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResourceGroupDeployment.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResourceGroupDeployment.md ---- - -# Get-AzureRmResourceGroupDeployment - -## SYNOPSIS -Gets the deployments in a resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetByResourceGroupDeploymentName (Default) -``` -Get-AzureRmResourceGroupDeployment [-ResourceGroupName] <String> [[-Name] <String>] [-ApiVersion <String>] - [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetByResourceGroupDeploymentId -``` -Get-AzureRmResourceGroupDeployment -Id <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmResourceGroupDeployment** cmdlet gets the deployments in an Azure resource group. -Specify the *Name* or *Id* parameter to filter the results. -By default, **Get-AzureRmResourceGroupDeployment** gets all deployments for a specified resource group. -An Azure resource is a user-managed Azure entity, such as a database server, database, or web site. -An Azure resource group is a collection of Azure resources that are deployed as a unit. -A deployment is the operation that makes the resources in the resource group available for use. -For more information about Azure resources and Azure resource groups, see the New-AzureRmResourceGroup cmdlet. -You can use this cmdlet for tracking. -For debugging, use this cmdlet with the Get-AzureRmLog cmdlet. - -## EXAMPLES - -### Example 1: Get all deployments for a resource group -``` -PS C:\>Get-AzureRmResourceGroupDeployment -ResourceGroupName "ContosoLabsRG" -``` - -This command gets all deployments for the ContosoLabsRG resource group. -The output shows a deployment for a WordPress blog that used a gallery template. - -### Example 2: Get a deployment by name -``` -PS C:\>Get-AzureRmResourceGroupDeployment -ResourceGroupName "ContosoLabsRG" -Name "DeployWebsite01" -``` - -This command gets the DeployWebsite01 deployment of the ContosoLabsRG resource group. -You can assign a name to a deployment when you create it by using the **New-AzureRmResourceGroup** or **New-AzureRmResourceGroupDeployment** cmdlets. -If you do not assign a name, the cmdlets provide a default name based on the template that is used to create the deployment. - -### Example 3: Get the deployments of all resource groups -``` -PS C:\>Get-AzureRmResourceGroup | Get-AzureRmResourceGroupDeployment | Format-Table ResourceGroupName, DeploymentName, ProvisioningState -``` - -This command gets all resource groups in your subscription by using the Get-AzureRmResourceGroup cmdlet. -The command passes the resource groups to the current cmdlet by using the pipeline operator. -The current cmdlet gets all deployments of all resource groups in the subscription, and passes the results to the Format-Table cmdlet to display their **ResourceGroupName**, **DeploymentName**, and **ProvisioningState** property values. - -## PARAMETERS - -### -ApiVersion -Specifies the API version that is supported by the resource Provider. -You can specify a different version than the default version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the resource group deployment to get. - -```yaml -Type: System.String -Parameter Sets: GetByResourceGroupDeploymentId -Aliases: DeploymentId, ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the deployment to get. -Wildcard characters are not permitted. - -```yaml -Type: System.String -Parameter Sets: GetByResourceGroupDeploymentName -Aliases: DeploymentName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. -The cmdlet gets the deployments for the resource group that this parameter specifies. -Wildcard characters are not permitted. -This parameter is required and you can specify only one resource group in each command. - -```yaml -Type: System.String -Parameter Sets: GetByResourceGroupDeploymentName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.ResourceManagement.Models. PSResourceGroupDeployment - -## NOTES - -## RELATED LINKS - -[Get-AzureRmResourceGroup](./Get-AzureRmResourceGroup.md) - -[New-AzureRmResourceGroup](./New-AzureRmResourceGroup.md) - -[New-AzureRmResourceGroupDeployment](./New-AzureRmResourceGroupDeployment.md) - -[Remove-AzureRmResourceGroupDeployment](./Remove-AzureRmResourceGroupDeployment.md) - -[Stop-AzureRmResourceGroupDeployment](./Stop-AzureRmResourceGroupDeployment.md) - -[Test-AzureRmResourceGroupDeployment](./Test-AzureRmResourceGroupDeployment.md) - - diff --git a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmResourceGroupDeploymentOperation.md b/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmResourceGroupDeploymentOperation.md deleted file mode 100644 index 55fb72d5ce..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmResourceGroupDeploymentOperation.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 9F29DFCB-A02B-45A5-99B9-C054BF4FCA6C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermresourcegroupdeploymentoperation -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResourceGroupDeploymentOperation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResourceGroupDeploymentOperation.md ---- - -# Get-AzureRmResourceGroupDeploymentOperation - -## SYNOPSIS -Gets the resource group deployment operation - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmResourceGroupDeploymentOperation -DeploymentName <String> [-SubscriptionId <Guid>] - -ResourceGroupName <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmResourceGroupDeploymentOperation** cmdlet lists all the operations that were part of a deployment to help you identify and give more information about the exact operations that failed for a particular deployment. -It can also show the response and the request content for each deployment operation. -This is the same information provided in the deployment details on the portal. -To get the request and the response content, enable the setting when submitting a deployment through **New-AzureRmResourceGroupDeployment**. -It can potentially log and expose secrets like passwords used in the resource property or **listKeys** operations that are then returned when you retrieve the deployment operations. -For more on this setting and how to enable it, see New-AzureRmResourceGroupDeployment and Debugging ARM template deployments - -## EXAMPLES - -### Get1 -``` -PS C:\>Get-AzureRmResourceGroupDeploymentOperation -DeploymentName test -ResourceGroupName test -``` - -Gets deployment operation with name "test" under resource group "test" - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeploymentName -The deployment name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InformationAction -Specifies how this cmdlet responds to an information event. -The acceptable values for this parameter are: -- Continue -- Ignore -- Inquire -- SilentlyContinue -- Stop -- Suspend - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: infa - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationVariable -Specifies an information variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: iv - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubscriptionId -The subscription to use. - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmResourceLock.md b/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmResourceLock.md deleted file mode 100644 index 912b1c9689..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmResourceLock.md +++ /dev/null @@ -1,308 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 3FBF91B8-8EF9-4E05-AD7E-AEFC6EBBFB8E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermresourcelock -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResourceLock.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResourceLock.md ---- - -# Get-AzureRmResourceLock - -## SYNOPSIS -Gets a resource lock. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByResourceGroup -``` -Get-AzureRmResourceLock [-LockName <String>] [-AtScope] -ResourceGroupName <String> [-ApiVersion <String>] - [-Pre] [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [<CommonParameters>] -``` - -### ByResourceGroupLevel -``` -Get-AzureRmResourceLock [-LockName <String>] [-AtScope] -ResourceName <String> -ResourceType <String> - -ResourceGroupName <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>] -``` - -### BySpecifiedScope -``` -Get-AzureRmResourceLock [-LockName <String>] [-AtScope] -Scope <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [<CommonParameters>] -``` - -### BySubscription -``` -Get-AzureRmResourceLock [-LockName <String>] [-AtScope] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [<CommonParameters>] -``` - -### BySubscriptionLevel -``` -Get-AzureRmResourceLock [-LockName <String>] [-AtScope] -ResourceName <String> -ResourceType <String> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>] -``` - -### ByTenantLevel -``` -Get-AzureRmResourceLock [-LockName <String>] [-AtScope] -ResourceName <String> -ResourceType <String> - [-TenantLevel] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>] -``` - -### ByLockId -``` -Get-AzureRmResourceLock [-AtScope] -LockId <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmResourceLock** cmdlet gets Azure resource locks. - -## EXAMPLES - -### Example 1: Get a lock -``` -PS C:\>Get-AzureRmResourceLock -LockName "ContosoSiteLock" -ResourceName "ContosoSite" -ResourceType "microsoft.web/sites" -ResourceGroupName "ResourceGroup11" -``` - -This command gets the resource lock named ContosoSiteLock. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. -If you do not specify a version, this cmdlet uses the latest available version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AtScope -Indicates that this cmdlet returns all locks at or above the specified scope. -If you do not specify this parameter, the cmdlet returns all locks at, above, or below the scope. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationAction -Specifies how this cmdlet responds to an information event. -The acceptable values for this parameter are: -- Continue -- Ignore -- Inquire -- SilentlyContinue -- Stop -- Suspend - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: infa - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationVariable -Specifies an information variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: iv - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LockId -Specifies the ID of the lock that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: ByLockId -Aliases: Id, ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LockName -Specifies the name of the lock that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: ByResourceGroup, ByResourceGroupLevel, BySpecifiedScope, BySubscription, BySubscriptionLevel, ByTenantLevel -Aliases: ExtensionResourceName, Name - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for which the lock applies. -This cmdlet gets locks for this resource group. - -```yaml -Type: System.String -Parameter Sets: ByResourceGroup, ByResourceGroupLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceName -Specifies the name of the resource for which this lock applies. -This cmdlet gets locks for this resource. - -```yaml -Type: System.String -Parameter Sets: ByResourceGroupLevel, BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceType -Specifies the resource type of the resource for which this lock applies. -This cmdlet gets locks for this resource. - -```yaml -Type: System.String -Parameter Sets: ByResourceGroupLevel, BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Scope -Specifies the scope to which the lock applies. -The cmdlet gets locks for this scope. - -```yaml -Type: System.String -Parameter Sets: BySpecifiedScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TenantLevel -Indicates that this cmdlet operates at the tenant level. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-AzureRmResourceLock](./New-AzureRmResourceLock.md) - -[Remove-AzureRmResourceLock](./Remove-AzureRmResourceLock.md) - -[Set-AzureRmResourceLock](./Set-AzureRmResourceLock.md) - - diff --git a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmResourceProvider.md b/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmResourceProvider.md deleted file mode 100644 index 254a93ba5d..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmResourceProvider.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 6AB09621-488B-4A16-92D9-9C47EB87DA95 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermresourceprovider -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResourceProvider.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResourceProvider.md ---- - -# Get-AzureRmResourceProvider - -## SYNOPSIS -Gets a resource provider. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ListAvailable (Default) -``` -Get-AzureRmResourceProvider [-Location <String>] [-ListAvailable] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### IndividualProvider -``` -Get-AzureRmResourceProvider -ProviderNamespace <String[]> [-Location <String>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmResourceProvider** cmdlet gets an Azure resource provider. - -## EXAMPLES - -## PARAMETERS - -### -ApiVersion -Specifies the API version that is supported by the resource Provider. -You can specify a different version than the default version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ListAvailable -Indicates that this operation gets all available resource providers. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ListAvailable -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the resource provider. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProviderNamespace -Specifies the namespace of the resource provider. - -```yaml -Type: System.String[] -Parameter Sets: IndividualProvider -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Register-AzureRmResourceProvider](./Register-AzureRmResourceProvider.md) - -[Unregister-AzureRmResourceProvider](./Unregister-AzureRmResourceProvider.md) - - diff --git a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmRoleAssignment.md b/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmRoleAssignment.md deleted file mode 100644 index 577d31ca66..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmRoleAssignment.md +++ /dev/null @@ -1,446 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 488229AF-FD6D-4E1B-B3DA-E57CA781D91E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermroleassignment -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmRoleAssignment.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmRoleAssignment.md ---- - -# Get-AzureRmRoleAssignment - -## SYNOPSIS -Lists Azure RBAC role assignments at the specified scope. -By default it lists all role assignments in the selected Azure subscription. -Use respective parameters to list assignments to a specific user, or to list assignments on a specific resource group or resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### EmptyParameterSet (Default) -``` -Get-AzureRmRoleAssignment [-RoleDefinitionName <String>] [-IncludeClassicAdministrators] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ObjectIdParameterSet -``` -Get-AzureRmRoleAssignment -ObjectId <Guid> [-RoleDefinitionName <String>] [-ExpandPrincipalGroups] - [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceGroupWithObjectIdParameterSet -``` -Get-AzureRmRoleAssignment -ObjectId <Guid> -ResourceGroupName <String> [-RoleDefinitionName <String>] - [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceWithObjectIdParameterSet -``` -Get-AzureRmRoleAssignment -ObjectId <Guid> -ResourceGroupName <String> -ResourceName <String> - -ResourceType <String> [-ParentResource <String>] [-RoleDefinitionName <String>] - [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ScopeWithObjectIdParameterSet -``` -Get-AzureRmRoleAssignment -ObjectId <Guid> [-RoleDefinitionName <String>] -Scope <String> - [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### RoleIdWithScopeAndObjectIdParameterSet -``` -Get-AzureRmRoleAssignment [-ObjectId <Guid>] -RoleDefinitionId <Guid> [-Scope <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceGroupWithSignInNameParameterSet -``` -Get-AzureRmRoleAssignment -SignInName <String> -ResourceGroupName <String> [-RoleDefinitionName <String>] - [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceWithSignInNameParameterSet -``` -Get-AzureRmRoleAssignment -SignInName <String> -ResourceGroupName <String> -ResourceName <String> - -ResourceType <String> [-ParentResource <String>] [-RoleDefinitionName <String>] - [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ScopeWithSignInNameParameterSet -``` -Get-AzureRmRoleAssignment -SignInName <String> [-RoleDefinitionName <String>] -Scope <String> - [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SignInNameParameterSet -``` -Get-AzureRmRoleAssignment -SignInName <String> [-RoleDefinitionName <String>] [-ExpandPrincipalGroups] - [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceGroupWithSPNParameterSet -``` -Get-AzureRmRoleAssignment -ServicePrincipalName <String> -ResourceGroupName <String> - [-RoleDefinitionName <String>] [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ResourceWithSPNParameterSet -``` -Get-AzureRmRoleAssignment -ServicePrincipalName <String> -ResourceGroupName <String> -ResourceName <String> - -ResourceType <String> [-ParentResource <String>] [-RoleDefinitionName <String>] - [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ScopeWithSPNParameterSet -``` -Get-AzureRmRoleAssignment -ServicePrincipalName <String> [-RoleDefinitionName <String>] -Scope <String> - [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SPNParameterSet -``` -Get-AzureRmRoleAssignment -ServicePrincipalName <String> [-RoleDefinitionName <String>] - [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceGroupParameterSet -``` -Get-AzureRmRoleAssignment -ResourceGroupName <String> [-RoleDefinitionName <String>] - [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceParameterSet -``` -Get-AzureRmRoleAssignment -ResourceGroupName <String> -ResourceName <String> -ResourceType <String> - [-ParentResource <String>] [-RoleDefinitionName <String>] [-IncludeClassicAdministrators] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ScopeParameterSet -``` -Get-AzureRmRoleAssignment [-RoleDefinitionName <String>] -Scope <String> [-IncludeClassicAdministrators] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-AzureRMRoleAssignment command to list all role assignments that are effective on a scope. -Without any parameters, this command returns all the role assignments made under the subscription. -This list can be filtered using filtering parameters for principal, role and scope. -The subject of the assignment must be specified. -To specify a user, use SignInName or Microsoft Entra ObjectId parameters. -To specify a security group, use Microsoft Entra ObjectId parameter. -And to specify a Microsoft Entra application, use ServicePrincipalName or ObjectId parameters. -The role that is being assigned must be specified using the RoleDefinitionName parameter. -The scope at which access is being granted may be specified. -It defaults to the selected subscription. -The scope of the assignment can be specified using one of the following parameter combinations - a. -Scope - This is the fully qualified scope starting with /subscriptions/\<subscriptionId\>. -This will filter assignments that are effective at that particular scope i.e. -all assignments at that scope and above. - b. -ResourceGroupName - Name of any resource group under the subscription. -This will filter assignments effective at the specified resource group - c. -ResourceName, ResourceType, ResourceGroupName and (optionally) ParentResource - Identifies a particular resource under the subscription and will filter assignments effective at that resource scope. -To determine what access a particular user has in the subscription, use the ExpandPrincipalGroups switch. -This will list all roles assigned to the user, and to the groups that the user is member of. -Use the IncludeClassicAdministrators switch to also display the subscription admins and co-admins. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmRoleAssignment -``` - -List all role assignments in the subscription - -### Example 2 -``` -PS C:\> Get-AzureRmRoleAssignment -ResourceGroupName testRG -SignInName john.doe@contoso.com -``` - -Gets all role assignments made to user john.doe@contoso.com, and the groups of which he is member, at the testRG scope or above. - -### Example 3 -``` -PS C:\> Get-AzureRmRoleAssignment -ServicePrincipalName "http://testapp1.com" -``` - -Gets all role assignments of the specified service principal - -### Example 4 -``` -PS C:\> Get-AzureRmRoleAssignment -Scope "/subscriptions/96231a05-34ce-4eb4-aa6a-70759cbb5e83/resourcegroups/rg1/providers/Microsoft.Web/sites/site1" -``` - -Gets role assignments at the 'site1' website scope. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpandPrincipalGroups -If specified, returns roles directly assigned to the user and to the groups of which the user is a member (transitively). -Supported only for a user principal. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ObjectIdParameterSet, SignInNameParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeClassicAdministrators -If specified, also lists subscription classic administrators (co-admins, service admins, etc.) role assignments. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: EmptyParameterSet, ObjectIdParameterSet, ResourceGroupWithObjectIdParameterSet, ResourceWithObjectIdParameterSet, ScopeWithObjectIdParameterSet, ResourceGroupWithSignInNameParameterSet, ResourceWithSignInNameParameterSet, ScopeWithSignInNameParameterSet, SignInNameParameterSet, ResourceGroupWithSPNParameterSet, ResourceWithSPNParameterSet, ScopeWithSPNParameterSet, SPNParameterSet, ResourceGroupParameterSet, ResourceParameterSet, ScopeParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ObjectId -The Microsoft Entra ObjectId of the User, Group or Service Principal. -Filters all assignments that are made to the specified principal. - -```yaml -Type: System.Guid -Parameter Sets: ObjectIdParameterSet, ResourceGroupWithObjectIdParameterSet, ResourceWithObjectIdParameterSet, ScopeWithObjectIdParameterSet -Aliases: Id, PrincipalId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Guid -Parameter Sets: RoleIdWithScopeAndObjectIdParameterSet -Aliases: Id, PrincipalId - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ParentResource -The parent resource in the hierarchy of the resource specified using ResourceName parameter. -Must be used in conjunction with ResourceGroupName, ResourceType, and ResourceName parameters. - -```yaml -Type: System.String -Parameter Sets: ResourceWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceWithSPNParameterSet, ResourceParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. -Lists role assignments that are effective at the specified resource group. -When used in conjunction with ResourceName, ResourceType, and ParentResource parameters, the command lists assignments effective at resources within the resource group. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupWithObjectIdParameterSet, ResourceWithObjectIdParameterSet, ResourceGroupWithSignInNameParameterSet, ResourceWithSignInNameParameterSet, ResourceGroupWithSPNParameterSet, ResourceWithSPNParameterSet, ResourceGroupParameterSet, ResourceParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceName -The resource name. -For e.g. -storageaccountprod. -Must be used in conjunction with ResourceGroupName, ResourceType, and (optionally)ParentResource parameters. - -```yaml -Type: System.String -Parameter Sets: ResourceWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceWithSPNParameterSet, ResourceParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceType -The resource type. -For e.g. -Microsoft.Network/virtualNetworks. -Must be used in conjunction with ResourceGroupName, ResourceName, and (optionally)ParentResource parameters. - -```yaml -Type: System.String -Parameter Sets: ResourceWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceWithSPNParameterSet, ResourceParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RoleDefinitionId -Id of the Role that is assigned to the principal. - -```yaml -Type: System.Guid -Parameter Sets: RoleIdWithScopeAndObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RoleDefinitionName -Role that is assigned to the principal i.e. -Reader, Contributor, Virtual Network Administrator, etc. - -```yaml -Type: System.String -Parameter Sets: EmptyParameterSet, ObjectIdParameterSet, ResourceGroupWithObjectIdParameterSet, ResourceWithObjectIdParameterSet, ScopeWithObjectIdParameterSet, ResourceGroupWithSignInNameParameterSet, ResourceWithSignInNameParameterSet, ScopeWithSignInNameParameterSet, SignInNameParameterSet, ResourceGroupWithSPNParameterSet, ResourceWithSPNParameterSet, ScopeWithSPNParameterSet, SPNParameterSet, ResourceGroupParameterSet, ResourceParameterSet, ScopeParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Scope -The Scope of the role assignment. -In the format of relative URI. -For e.g. -/subscriptions/9004a9fd-d58e-48dc-aeb2-4a4aec58606f/resourceGroups/TestRG. -It must start with "/subscriptions/{id}". -The command filters all assignments that are effective at that scope. - -```yaml -Type: System.String -Parameter Sets: ScopeWithObjectIdParameterSet, ScopeWithSignInNameParameterSet, ScopeWithSPNParameterSet, ScopeParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: RoleIdWithScopeAndObjectIdParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServicePrincipalName -The ServicePrincipalName of the service principal. -Filters all assignments that are made to the specified Microsoft Entra application. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupWithSPNParameterSet, ResourceWithSPNParameterSet, ScopeWithSPNParameterSet, SPNParameterSet -Aliases: SPN - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SignInName -The email address or the user principal name of the user. -Filters all assignments that are made to the specified user. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupWithSignInNameParameterSet, ResourceWithSignInNameParameterSet, ScopeWithSignInNameParameterSet, SignInNameParameterSet -Aliases: Email, UserPrincipalName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleAssignment - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment - -## RELATED LINKS - -[New-AzureRmRoleAssignment](./New-AzureRmRoleAssignment.md) - -[Remove-AzureRmRoleAssignment](./Remove-AzureRmRoleAssignment.md) - -[Get-AzureRmRoleDefinition](./Get-AzureRmRoleDefinition.md) diff --git a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmRoleDefinition.md b/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmRoleDefinition.md deleted file mode 100644 index f689c05bb1..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Get-AzureRmRoleDefinition.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 7740AC3B-F643-4F8D-8DC5-ACBF59323BD8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermroledefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmRoleDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmRoleDefinition.md ---- - -# Get-AzureRmRoleDefinition - -## SYNOPSIS -Lists all Azure RBAC roles that are available for assignment. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RoleDefinitionNameParameterSet -``` -Get-AzureRmRoleDefinition [[-Name] <String>] [-Scope <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### RoleDefinitionIdParameterSet -``` -Get-AzureRmRoleDefinition -Id <Guid> [-Scope <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### RoleDefinitionCustomParameterSet -``` -Get-AzureRmRoleDefinition [-Scope <String>] [-Custom] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-AzureRmRoleDefinition command with a particular role name to view its details. -To inspect individual operations that a role grants access to, review the Actions and NotActions properties of the role. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmRoleDefinition -Name Reader -``` - -Get the Reader role definition - -### Example 2 -``` -PS C:\> Get-AzureRmRoleDefinition -``` - -Lists all RBAC role definitions - -## PARAMETERS - -### -Custom -If specified, only displays the custom created roles in the directory. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: RoleDefinitionCustomParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Role definition Id. - -```yaml -Type: System.Guid -Parameter Sets: RoleDefinitionIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Role definition name. -For e.g. -Reader, Contributor, Virtual Machine Contributor. - -```yaml -Type: System.String -Parameter Sets: RoleDefinitionNameParameterSet -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Scope -Role definition scope. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: Scope (ByValue) - -### System.Guid - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment - -## RELATED LINKS - -[New-AzureRmRoleAssignment](./New-AzureRmRoleAssignment.md) - -[Get-AzureRmRoleAssignment](./Get-AzureRmRoleAssignment.md) - -[New-AzureRmRoleDefinition](./New-AzureRmRoleDefinition.md) - -[Remove-AzureRmRoleDefinition](./Remove-AzureRmRoleDefinition.md) - diff --git a/azurermps-6.13.0/AzureRM.Resources/Invoke-AzureRmResourceAction.md b/azurermps-6.13.0/AzureRM.Resources/Invoke-AzureRmResourceAction.md deleted file mode 100644 index 46d2146d87..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Invoke-AzureRmResourceAction.md +++ /dev/null @@ -1,353 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 427F7300-0FEB-4F28-9C1D-27592AEBF6A0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/invoke-azurermresourceaction -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Invoke-AzureRmResourceAction.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Invoke-AzureRmResourceAction.md ---- - -# Invoke-AzureRmResourceAction - -## SYNOPSIS -Invokes an action on a resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByResourceId (Default) -``` -Invoke-AzureRmResourceAction [-Parameters <Hashtable>] -Action <String> -ResourceId <String> - [-ODataQuery <String>] [-Force] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### BySubscriptionLevel -``` -Invoke-AzureRmResourceAction [-Parameters <Hashtable>] -Action <String> -ResourceName <String> - -ResourceType <String> [-ExtensionResourceName <String>] [-ExtensionResourceType <String>] - [-ODataQuery <String>] [-ResourceGroupName <String>] [-Force] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTenantLevel -``` -Invoke-AzureRmResourceAction [-Parameters <Hashtable>] -Action <String> -ResourceName <String> - -ResourceType <String> [-ExtensionResourceName <String>] [-ExtensionResourceType <String>] - [-ODataQuery <String>] [-TenantLevel] [-Force] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Invoke-AzureRmResourceAction** cmdlet invokes an action on a specified Azure resource. -To get a list of supported actions, use the Azure Resource Explorer tool. - -## EXAMPLES - -## PARAMETERS - -### -Action -Specifies the name of the action to invoke. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ActionName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApiVersion -Specifies the version of the resource provider API to use. -If you do not specify a version, this cmdlet uses the latest available version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionResourceName -Specifies the name of an extension resource for the resource on which this cmdlet invokes an action. -For instance, to specify a database, use the following format: -server name`/`database name - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExtensionResourceType -Specifies the type of the extension resource. -For instance: -`Microsoft.Sql/Servers/Databases` - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationAction -Specifies how this cmdlet responds to an information event. -The acceptable values for this parameter are: -- Continue -- Ignore -- Inquire -- SilentlyContinue -- Stop -- Suspend - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: infa - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationVariable -Specifies an information variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: iv - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ODataQuery -Specifies an Open Data Protocol (OData) style filter. -This cmdlet appends this value to the request in addition to any other filters. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Parameters -Specifies parameters, as a hash table, for the action that this cmdlet invokes. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Object - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group in which this cmdlet invokes an action. - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Specifies the fully qualified resource ID of the resource on which this cmdlet invokes an action. -The ID includes the subscription, as in the following example: -`/subscriptions/`subscription ID`/providers/Microsoft.Sql/servers/ContosoServer/databases/ContosoDatabase` - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceName -Specifies the name of the resource of the resource on which this cmdlet invokes an action. -For instance, to specify a database, use the following format: -`ContosoServer/ContosoDatabase` - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel, ByTenantLevel -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceType -Specifies the type of the resource. -For instance, for a database, the resource type is as follows: -`Microsoft.Sql/Servers/Databases` - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TenantLevel -Indicates that this cmdlet operates at the tenant level. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/Move-AzureRmResource.md b/azurermps-6.13.0/AzureRM.Resources/Move-AzureRmResource.md deleted file mode 100644 index 4350906dc1..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Move-AzureRmResource.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 60BED40A-EEA4-4667-93E9-8A9B35037726 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/move-azurermresource -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Move-AzureRmResource.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Move-AzureRmResource.md ---- - -# Move-AzureRmResource - -## SYNOPSIS -Moves a resource to a different resource group or subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Move-AzureRmResource -DestinationResourceGroupName <String> [-DestinationSubscriptionId <Guid>] - -ResourceId <String[]> [-Force] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Move-AzureRmResource** cmdlet moves existing resources to a different resource group. -That resource group can be in a different subscription. - -## EXAMPLES - -### Example 1: Move a resource to a resource group -``` -PS C:\>$Resource = Get-AzureRmResource -ResourceType "Microsoft.ClassicCompute/storageAccounts" -ResourceName "ContosoStorageAccount" -PS C:\> Move-AzureRmResource -ResourceId $Resource.ResourceId -DestinationResourceGroupName "ResourceGroup14" -``` - -The first command gets a resource named ContosoStorageAccount by using the Get-AzureRmResource cmdlet, and then stores that resource in the $Resource variable. -The second command moves that resource into the resource group named ResourceGroup14. -The command identifies the resource to move by using the **ResourceId** property of $Resource. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. -If you do not specify a version, this cmdlet uses the latest available version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationResourceGroupName -Specifies the name of the resource group into which this cmdlet moves resources. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: TargetResourceGroup - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationSubscriptionId -Specifies the ID of the subscription into which this cmdlet moves resources . - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: (All) -Aliases: Id, SubscriptionId - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationAction -Specifies how this cmdlet responds to an information event. -The acceptable values for this parameter are: -- Continue -- Ignore -- Inquire -- SilentlyContinue -- Stop -- Suspend - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: infa - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationVariable -Specifies an information variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: iv - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Specifies an array of IDs of the resources that this cmdlet moves. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - -[Get-AzureRmResource](./Get-AzureRmResource.md) - -[New-AzureRmResource](./New-AzureRmResource.md) - -[Remove-AzureRmResource](./Remove-AzureRmResource.md) - -[Set-AzureRmResource](./Set-AzureRmResource.md) - - diff --git a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmADAppCredential.md b/azurermps-6.13.0/AzureRM.Resources/New-AzureRmADAppCredential.md deleted file mode 100644 index 7af1299f6c..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmADAppCredential.md +++ /dev/null @@ -1,326 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 98836BC0-AB4F-4F24-88BE-E7DD350B71E8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermadappcredential -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADAppCredential.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADAppCredential.md ---- - -# New-AzureRmADAppCredential - -## SYNOPSIS -Adds a credential to an existing application. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ApplicationObjectIdWithPasswordParameterSet (Default) -``` -New-AzureRmADAppCredential -ObjectId <Guid> -Password <SecureString> [-StartDate <DateTime>] - [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationObjectIdWithCertValueParameterSet -``` -New-AzureRmADAppCredential -ObjectId <Guid> -CertValue <String> [-StartDate <DateTime>] [-EndDate <DateTime>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationIdWithCertValueParameterSet -``` -New-AzureRmADAppCredential -ApplicationId <Guid> -CertValue <String> [-StartDate <DateTime>] - [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationIdWithPasswordParameterSet -``` -New-AzureRmADAppCredential -ApplicationId <Guid> -Password <SecureString> [-StartDate <DateTime>] - [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### DisplayNameWithPasswordParameterSet -``` -New-AzureRmADAppCredential -DisplayName <String> -Password <SecureString> [-StartDate <DateTime>] - [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### DisplayNameWithCertValueParameterSet -``` -New-AzureRmADAppCredential -DisplayName <String> -CertValue <String> [-StartDate <DateTime>] - [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationObjectWithCertValueParameterSet -``` -New-AzureRmADAppCredential -ApplicationObject <PSADApplication> -CertValue <String> [-StartDate <DateTime>] - [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationObjectWithPasswordParameterSet -``` -New-AzureRmADAppCredential -ApplicationObject <PSADApplication> -Password <SecureString> - [-StartDate <DateTime>] [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmADAppCredential cmdlet can be used to add a new credential or to roll credentials for an application. -The application is identified by supplying either the application object id or application Id. - -## EXAMPLES - -### Example 1 - Create a new application credential using a password - -``` -PS C:\> $SecureStringPassword = ConvertTo-SecureString -String "password" -AsPlainText -Force -PS C:\> New-AzureRmADAppCredential -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 -Password $SecureStringPassword -``` - -A new password credential is added to the existing appplication with object id '00001111-aaaa-2222-bbbb-3333cccc4444'. - -### Example 2 - Create a new application credential using a certificate - -``` -PS C:\> $cer = New-Object System.Security.Cryptography.X509Certificates.X509Certificate -PS C:\> $cer.Import("C:\myapp.cer") -PS C:\> $binCert = $cer.GetRawCertData() -PS C:\> $credValue = [System.Convert]::ToBase64String($binCert) -PS C:\> New-AzureRmADAppCredential -ApplicationId 00001111-aaaa-2222-bbbb-3333cccc4444 -CertValue $credValue -StartDate $cer.GetEffectiveDateString() -EndDate $cer.GetExpirationDateString() -``` - -The supplied base64 encoded public X509 certificate ("myapp.cer") is added to the existing application with application id '00001111-aaaa-2222-bbbb-3333cccc4444'. - -### Example 3 - Create a new application credential using piping - -``` -PS C:\> $SecureStringPassword = ConvertTo-SecureString -String "password" -AsPlainText -Force -PS C:\> Get-AzureRmADApplication -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 | New-AzureRmADAppCredential -Password $SecureStringPassword -``` - -Gets the application with object id '00001111-aaaa-2222-bbbb-3333cccc4444' and pipes that to the New-AzureRmADAppCredential to create a new application credential for that application with the given password. - -## PARAMETERS - -### -ApplicationId -The application id of the application to add the credentials to. - -```yaml -Type: System.Guid -Parameter Sets: ApplicationIdWithCertValueParameterSet, ApplicationIdWithPasswordParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationObject -The application object to add the credentials to. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication -Parameter Sets: ApplicationObjectWithCertValueParameterSet, ApplicationObjectWithPasswordParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CertValue -The value of the "asymmetric" credential type. It represents the base 64 encoded certificate. - -```yaml -Type: System.String -Parameter Sets: ApplicationObjectIdWithCertValueParameterSet, ApplicationIdWithCertValueParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: DisplayNameWithCertValueParameterSet, ApplicationObjectWithCertValueParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The display name of the application. - -```yaml -Type: System.String -Parameter Sets: DisplayNameWithPasswordParameterSet, DisplayNameWithCertValueParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EndDate -The effective end date of the credential usage. The default end date value is one year from today. For an "asymmetric" type credential, this must be set to on or before the date that the X509 certificate is valid. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ObjectId -The object id of the application to add the credentials to. - -```yaml -Type: System.Guid -Parameter Sets: ApplicationObjectIdWithPasswordParameterSet, ApplicationObjectIdWithCertValueParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Password -The password to be associated with the application. - -```yaml -Type: System.Security.SecureString -Parameter Sets: ApplicationObjectIdWithPasswordParameterSet, ApplicationIdWithPasswordParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Security.SecureString -Parameter Sets: DisplayNameWithPasswordParameterSet, ApplicationObjectWithPasswordParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartDate -The effective start date of the credential usage. The default start date value is today. For an "asymmetric" type credential, this must be set to on or after the date that the X509 certificate is valid from. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication -Parameters: ApplicationObject (ByValue) - -### System.Security.SecureString - -### System.DateTime - -## OUTPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADCredential - -## NOTES - -## RELATED LINKS - -[Get-AzureRmADAppCredential](./Get-AzureRmADAppCredential.md) - -[Remove-AzureRmADAppCredential](./Remove-AzureRmADAppCredential.md) - -[Get-AzureRmADApplication](./Get-AzureRmADApplication.md) - diff --git a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmADApplication.md b/azurermps-6.13.0/AzureRM.Resources/New-AzureRmADApplication.md deleted file mode 100644 index 40051a70d4..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmADApplication.md +++ /dev/null @@ -1,334 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: F58FD77E-2946-44B1-B410-6E983FC20E21 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermadapplication -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADApplication.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADApplication.md ---- - -# New-AzureRmADApplication - -## SYNOPSIS -Creates a new Microsoft Entra application. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ApplicationWithoutCredentialParameterSet (Default) -``` -New-AzureRmADApplication -DisplayName <String> -IdentifierUris <String[]> [-HomePage <String>] - [-ReplyUrls <String[]>] [-AvailableToOtherTenants <Boolean>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationWithPasswordPlainParameterSet -``` -New-AzureRmADApplication -DisplayName <String> -IdentifierUris <String[]> [-HomePage <String>] - [-ReplyUrls <String[]>] [-AvailableToOtherTenants <Boolean>] -Password <SecureString> [-StartDate <DateTime>] - [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationWithPasswordCredentialParameterSet -``` -New-AzureRmADApplication -DisplayName <String> -IdentifierUris <String[]> [-HomePage <String>] - [-ReplyUrls <String[]>] [-AvailableToOtherTenants <Boolean>] -PasswordCredentials <PSADPasswordCredential[]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationWithKeyPlainParameterSet -``` -New-AzureRmADApplication -DisplayName <String> -IdentifierUris <String[]> [-HomePage <String>] - [-ReplyUrls <String[]>] [-AvailableToOtherTenants <Boolean>] -CertValue <String> [-StartDate <DateTime>] - [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationWithKeyCredentialParameterSet -``` -New-AzureRmADApplication -DisplayName <String> -IdentifierUris <String[]> [-HomePage <String>] - [-ReplyUrls <String[]>] [-AvailableToOtherTenants <Boolean>] -KeyCredentials <PSADKeyCredential[]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Creates a new Microsoft Entra application. - -## EXAMPLES - -### Example 1 - Create new Microsoft Entra application. - -``` -PS C:\> New-AzureRmADApplication -DisplayName "NewApplication" -HomePage "https://www.microsoft.com" -IdentifierUris "http://NewApplication" -``` - -Creates a new Microsoft Entra application without any credentials. - -### Example 2 - Create new Microsoft Entra application with password. - -``` -PS C:\> $SecureStringPassword = ConvertTo-SecureString -String "password" -AsPlainText -Force -PS C:\> New-AzureRmADApplication -DisplayName "NewApplication" -HomePage "https://www.microsoft.com" -IdentifierUris "http: -//NewApplication" -Password $SecureStringPassword -``` - -Creates a new Microsoft Entra application and associates password credentials with it. - -## PARAMETERS - -### -AvailableToOtherTenants -The value specifying whether the application is a single tenant or a multi-tenant. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CertValue -The value of the "asymmetric" credential type. -It represents the base 64 encoded certificate. - -```yaml -Type: System.String -Parameter Sets: ApplicationWithKeyPlainParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Display name of the new application. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EndDate -The effective end date of the credential usage. -The default end date value is one year from today. -For an "asymmetric" type credential, this must be set to on or before the date that the X509 certificate is valid. - -```yaml -Type: System.DateTime -Parameter Sets: ApplicationWithPasswordPlainParameterSet, ApplicationWithKeyPlainParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HomePage -The URL to the application homepage. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IdentifierUris -The URIs that identify the application. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyCredentials -The list of certificate credentials associated with the application. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADKeyCredential[] -Parameter Sets: ApplicationWithKeyCredentialParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Password -The password to be associated with the application. - -```yaml -Type: System.Security.SecureString -Parameter Sets: ApplicationWithPasswordPlainParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PasswordCredentials -The list of password credentials associated with the application. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADPasswordCredential[] -Parameter Sets: ApplicationWithPasswordCredentialParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReplyUrls -The application reply urls. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartDate -The effective start date of the credential usage. -The default start date value is today. -For an "asymmetric" type credential, this must be set to on or after the date that the X509 certificate is valid from. - -```yaml -Type: System.DateTime -Parameter Sets: ApplicationWithPasswordPlainParameterSet, ApplicationWithKeyPlainParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.String[] - -### System.Boolean - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADPasswordCredential[] - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADKeyCredential[] - -### System.Security.SecureString - -### System.DateTime - -## OUTPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment - -## RELATED LINKS - -[Remove-AzureRmADApplication](./Remove-AzureRmADApplication.md) - -[Get-AzureRmADApplication](./Get-AzureRmADApplication.md) - -[New-AzureRmADServicePrincipal](./New-AzureRmADServicePrincipal.md) - -[Get-AzureRmADAppCredential](./Get-AzureRmADAppCredential.md) - -[New-AzureRmADAppCredential](./New-AzureRmADAppCredential.md) - -[Remove-AzureRmADAppCredential](./Remove-AzureRmADAppCredential.md) diff --git a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmADGroup.md b/azurermps-6.13.0/AzureRM.Resources/New-AzureRmADGroup.md deleted file mode 100644 index 798b5172ad..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmADGroup.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermadgroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADGroup.md ---- - -# New-AzureRmADGroup - -## SYNOPSIS -Creates a new active directory group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmADGroup -DisplayName <String> -MailNickname <String> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Creates a new active directory group. - -## EXAMPLES - -### Example 1 - Create a new AD group - -``` -PS C:\> New-AzureRmADGroup -DisplayName "MyGroupDisplayName" -MailNickname "myemail@domain.com" -``` - -Creates a new AD group with the name "MyGroupDisplayName" and the mail nickname "myemail@domain.com". - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The display name for the group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MailNickname -The mail nickname for the group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADGroup - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmADServicePrincipal.md b/azurermps-6.13.0/AzureRM.Resources/New-AzureRmADServicePrincipal.md deleted file mode 100644 index 68fc9f9f98..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmADServicePrincipal.md +++ /dev/null @@ -1,600 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: D602F910-B26F-473D-B5B6-C7BDFB0A14CB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermadserviceprincipal -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADServicePrincipal.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADServicePrincipal.md ---- - -# New-AzureRmADServicePrincipal - -## SYNOPSIS -Creates a new Microsoft Entra service principal. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SimpleParameterSet (Default) -``` -New-AzureRmADServicePrincipal [-ApplicationId <Guid>] [-DisplayName <String>] [-Password <SecureString>] - [-StartDate <DateTime>] [-EndDate <DateTime>] [-Scope <String>] [-Role <String>] [-SkipAssignment] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationWithoutCredentialParameterSet -``` -New-AzureRmADServicePrincipal -ApplicationId <Guid> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ApplicationWithPasswordPlainParameterSet -``` -New-AzureRmADServicePrincipal -ApplicationId <Guid> -Password <SecureString> [-StartDate <DateTime>] - [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationWithPasswordCredentialParameterSet -``` -New-AzureRmADServicePrincipal -ApplicationId <Guid> -PasswordCredential <PSADPasswordCredential[]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationWithKeyPlainParameterSet -``` -New-AzureRmADServicePrincipal -ApplicationId <Guid> -CertValue <String> [-StartDate <DateTime>] - [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationWithKeyCredentialParameterSet -``` -New-AzureRmADServicePrincipal -ApplicationId <Guid> -KeyCredential <PSADKeyCredential[]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### DisplayNameWithoutCredentialParameterSet -``` -New-AzureRmADServicePrincipal -DisplayName <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### DisplayNameWithPasswordPlainParameterSet -``` -New-AzureRmADServicePrincipal -DisplayName <String> -Password <SecureString> [-StartDate <DateTime>] - [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### DisplayNameWithPasswordCredentialParameterSet -``` -New-AzureRmADServicePrincipal -DisplayName <String> -PasswordCredential <PSADPasswordCredential[]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### DisplayNameWithKeyPlainParameterSet -``` -New-AzureRmADServicePrincipal -DisplayName <String> -CertValue <String> [-StartDate <DateTime>] - [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### DisplayNameWithKeyCredentialParameterSet -``` -New-AzureRmADServicePrincipal -DisplayName <String> -KeyCredential <PSADKeyCredential[]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationObjectWithoutCredentialParameterSet -``` -New-AzureRmADServicePrincipal -ApplicationObject <PSADApplication> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationObjectWithPasswordPlainParameterSet -``` -New-AzureRmADServicePrincipal -ApplicationObject <PSADApplication> -Password <SecureString> - [-StartDate <DateTime>] [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ApplicationObjectWithPasswordCredentialParameterSet -``` -New-AzureRmADServicePrincipal -ApplicationObject <PSADApplication> - -PasswordCredential <PSADPasswordCredential[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ApplicationObjectWithKeyPlainParameterSet -``` -New-AzureRmADServicePrincipal -ApplicationObject <PSADApplication> -CertValue <String> [-StartDate <DateTime>] - [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationObjectWithKeyCredentialParameterSet -``` -New-AzureRmADServicePrincipal -ApplicationObject <PSADApplication> -KeyCredential <PSADKeyCredential[]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Creates a new Microsoft Entra service principal. The default parameter set uses default values for parameters if the user does not provide one for them. For more information on the default values used, please see the description for the given parameters below. -This cmdlet has the ability to assign a role to the service principal with the `Role` and `Scope` parameters; if neither of these parameters are provided, no role will be assigned to the service principal. The default values for the `Role` and `Scope` parameters are "Contributor" and the current subscription, respectively (_note_: the defaults are only used when the user provides a value for one of the two parameters, but not the other). -The cmdlet also implicitly creates an application and sets its properties (if the ApplicationId is not provided). In order to update the application specific parameters please use Set-AzureRmADApplication cmdlet. - -## EXAMPLES - -### Example 1 - Simple AD service principal creation - -``` -PS C:\> New-AzureRmADServicePrincipal - -Secret : System.Security.SecureString -ServicePrincipalNames : {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, http://azure-powershell-05-22-2018-18-23-43} -ApplicationId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -DisplayName : azure-powershell-05-22-2018-18-23-43 -Id : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -Type : ServicePrincipal -``` - -The above command creates an AD service principal using default values for parameters not provided. Since an application id was not provided, an application was created for the service principal. Since no values were provided for `Role` or `Scope`, the created service principal does not have any permissions. - -### Example 2 - Simple AD service principal creation with a specified role and default scope - -``` -PS C:\> New-AzureRmADServicePrincipal -Role Reader - -Secret : System.Security.SecureString -ServicePrincipalNames : {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, http://azure-powershell-05-22-2018-18-23-43} -ApplicationId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -DisplayName : azure-powershell-05-22-2018-18-23-43 -Id : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -Type : ServicePrincipal - -WARNING: Assigning role 'Reader' over scope '/subscriptions/zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz' to the new service principal. -``` - -The above command creates an AD service principal using the default values for parameters not provided. Since the application id was not provided, an application was created for the service principal. The service principal was created with "Reader" permissions over the current subscription (since no value was provided for the `Scope` parameter). - -### Example 3 - Simple AD service principal creation with a specified scope and default role - -``` -PS C:\> New-AzureRmADServicePrincipal -Scope /subscriptions/zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz/resourceGroups/myResourceGroup - -Secret : System.Security.SecureString -ServicePrincipalNames : {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, http://azure-powershell-05-22-2018-18-23-43} -ApplicationId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -DisplayName : azure-powershell-05-22-2018-18-23-43 -Id : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -Type : ServicePrincipal - -WARNING: Assigning role 'Contributor' over scope '/subscriptions/zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz/resourceGroups/myResourceGroup' to the new service principal. -``` - -The above command creates an AD service principal using the default values for parameters not provided. Since the application id was not provided, an application was created for the service principal. The service principal was created with "Contributor" permissions (since no value was provided for the `Role` parameter) over the provided resource group scope. - -### Example 4 - Simple AD service principal creation with a specified scope and role - -``` -PS C:\> New-AzureRmADServicePrincipal -Role Reader -Scope /subscriptions/zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz/resourceGroups/myResourceGroup - -Secret : System.Security.SecureString -ServicePrincipalNames : {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, http://azure-powershell-05-22-2018-18-23-43} -ApplicationId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -DisplayName : azure-powershell-05-22-2018-18-23-43 -Id : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -Type : ServicePrincipal - -WARNING: Assigning role 'Reader' over scope '/subscriptions/zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz/resourceGroups/myResourceGroup' to the new service principal. -``` - -The above command creates an AD service principal using the default values for parameters not provided. Since the application id was not provided, an application was created for the service principal. The service principal was created with "Reader" permissions over the provided resource group scope. - -### Example 5 - Create a new AD service principal using application id with role assignment - -``` -PS C:\> New-AzureRmADServicePrincipal -ApplicationId 00001111-aaaa-2222-bbbb-3333cccc4444 - -ServicePrincipalNames : {00001111-aaaa-2222-bbbb-3333cccc4444, http://my-temp-app} -ApplicationId : 00001111-aaaa-2222-bbbb-3333cccc4444 -DisplayName : my-temp-app -Id : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -Type : ServicePrincipal -``` - -Creates a new AD service principal for the application with application id '00001111-aaaa-2222-bbbb-3333cccc4444'. Since no values were provided for `Role` or `Scope`, the created service principal does not have any permissions. - -### Example 6 - Create a new AD service principal using piping - -``` -PS C:\> Get-AzureRmADApplication -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 | New-AzureRmADServicePrincipal -``` - -Gets the application with object id '00001111-aaaa-2222-bbbb-3333cccc4444' and pipes that to the New-AzureRmADServicePrincipal cmdlet to create a new AD service principal for that application. - -## PARAMETERS - -### -ApplicationId -The unique application id for a service principal in a tenant. -Once created this property cannot be changed. -If an application id is not specified, one will be generated. - -```yaml -Type: System.Guid -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.Guid -Parameter Sets: ApplicationWithoutCredentialParameterSet, ApplicationWithPasswordPlainParameterSet, ApplicationWithPasswordCredentialParameterSet, ApplicationWithKeyPlainParameterSet, ApplicationWithKeyCredentialParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationObject -The object representing the application for which the service principal is created. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication -Parameter Sets: ApplicationObjectWithoutCredentialParameterSet, ApplicationObjectWithPasswordPlainParameterSet, ApplicationObjectWithPasswordCredentialParameterSet, ApplicationObjectWithKeyPlainParameterSet, ApplicationObjectWithKeyCredentialParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CertValue -The value of the "asymmetric" credential type. -It represents the base 64 encoded certificate. - -```yaml -Type: System.String -Parameter Sets: ApplicationWithKeyPlainParameterSet, DisplayNameWithKeyPlainParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ApplicationObjectWithKeyPlainParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The friendly name of the service principal. If a display name is not provided, this value will default to 'azure-powershell-MM-dd-yyyy-HH-mm-ss', where the suffix is the time of application creation. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: DisplayNameWithoutCredentialParameterSet, DisplayNameWithPasswordPlainParameterSet, DisplayNameWithPasswordCredentialParameterSet, DisplayNameWithKeyPlainParameterSet, DisplayNameWithKeyCredentialParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndDate -The effective end date of the credential usage. -The default end date value is one year from today. -For an "asymmetric" type credential, this must be set to on or before the date that the X509 certificate is valid. - -```yaml -Type: System.DateTime -Parameter Sets: SimpleParameterSet, ApplicationObjectWithPasswordPlainParameterSet, ApplicationObjectWithKeyPlainParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.DateTime -Parameter Sets: ApplicationWithPasswordPlainParameterSet, ApplicationWithKeyPlainParameterSet, DisplayNameWithPasswordPlainParameterSet, DisplayNameWithKeyPlainParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyCredential -The collection of key credentials associated with the application. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADKeyCredential[] -Parameter Sets: ApplicationWithKeyCredentialParameterSet, DisplayNameWithKeyCredentialParameterSet -Aliases: KeyCredentials - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADKeyCredential[] -Parameter Sets: ApplicationObjectWithKeyCredentialParameterSet -Aliases: KeyCredentials - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Password -The password to be associated with the service principal. If a password is not provided, a random GUID will be generated and used as the password. - -```yaml -Type: System.Security.SecureString -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.Security.SecureString -Parameter Sets: ApplicationWithPasswordPlainParameterSet, DisplayNameWithPasswordPlainParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.Security.SecureString -Parameter Sets: ApplicationObjectWithPasswordPlainParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordCredential -The collection of password credentials associated with the application. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADPasswordCredential[] -Parameter Sets: ApplicationWithPasswordCredentialParameterSet, DisplayNameWithPasswordCredentialParameterSet -Aliases: PasswordCredentials - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADPasswordCredential[] -Parameter Sets: ApplicationObjectWithPasswordCredentialParameterSet -Aliases: PasswordCredentials - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Role -The role that the service principal has over the scope. If a value for `Scope` is provided, but no value is provided for `Role`, then `Role` will default to the 'Contributor' role. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -The scope that the service principal has permissions on. If a value for `Role` is provided, but no value is provided for `Scope`, then `Scope` will default to the current subscription. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipAssignment -If set, will skip creating the default role assignment for the service principal. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The effective start date of the credential usage. -The default start date value is today. -For an "asymmetric" type credential, this must be set to on or after the date that the X509 certificate is valid from. - -```yaml -Type: System.DateTime -Parameter Sets: SimpleParameterSet, ApplicationObjectWithPasswordPlainParameterSet, ApplicationObjectWithKeyPlainParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.DateTime -Parameter Sets: ApplicationWithPasswordPlainParameterSet, ApplicationWithKeyPlainParameterSet, DisplayNameWithPasswordPlainParameterSet, DisplayNameWithKeyPlainParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication -Parameters: ApplicationObject (ByValue) - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADPasswordCredential[] - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADKeyCredential[] - -### System.Security.SecureString - -### System.DateTime - -## OUTPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADServicePrincipal - -### Microsoft.Azure.Commands.Resources.Models.Authorization.PSADServicePrincipalWrapper - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment - -## RELATED LINKS - -[Remove-AzureRmADServicePrincipal](./Remove-AzureRmADServicePrincipal.md) - -[Get-AzureRmADServicePrincipal](./Get-AzureRmADServicePrincipal.md) - -[New-AzureRmADApplication](./New-AzureRmADApplication.md) - -[Remove-AzureRmADApplication](./Remove-AzureRmADApplication.md) - -[Get-AzureRmADSpCredential](./Get-AzureRmADSpCredential.md) - -[New-AzureRmADSpCredential](./New-AzureRmADSpCredential.md) - -[Remove-AzureRmADSpCredential](./Remove-AzureRmADSpCredential.md) diff --git a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmADSpCredential.md b/azurermps-6.13.0/AzureRM.Resources/New-AzureRmADSpCredential.md deleted file mode 100644 index 86607d5f08..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmADSpCredential.md +++ /dev/null @@ -1,319 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 063BAA79-484D-48CF-9170-3808813752BD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermadspcredential -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADSpCredential.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADSpCredential.md ---- - -# New-AzureRmADSpCredential - -## SYNOPSIS -Adds a credential to an existing service principal. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SpObjectIdWithPasswordParameterSet (Default) -``` -New-AzureRmADSpCredential -ObjectId <Guid> [-Password <SecureString>] [-StartDate <DateTime>] - [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SpObjectIdWithCertValueParameterSet -``` -New-AzureRmADSpCredential -ObjectId <Guid> -CertValue <String> [-StartDate <DateTime>] [-EndDate <DateTime>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SPNWithCertValueParameterSet -``` -New-AzureRmADSpCredential -ServicePrincipalName <String> -CertValue <String> [-StartDate <DateTime>] - [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SPNWithPasswordParameterSet -``` -New-AzureRmADSpCredential -ServicePrincipalName <String> [-Password <SecureString>] [-StartDate <DateTime>] - [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ServicePrincipalObjectWithCertValueParameterSet -``` -New-AzureRmADSpCredential -ServicePrincipalObject <PSADServicePrincipal> -CertValue <String> - [-StartDate <DateTime>] [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ServicePrincipalObjectWithPasswordParameterSet -``` -New-AzureRmADSpCredential -ServicePrincipalObject <PSADServicePrincipal> [-Password <SecureString>] - [-StartDate <DateTime>] [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmADSpCredential cmdlet can be used to add a new credential or to roll credentials for a service principal. -The service principal is identified by supplying either the object id or service principal name. - -## EXAMPLES - -### Example 1 - Create a new service principal credential using a generated password - -``` -PS C:\> New-AzureRmADSpCredential -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 - -Secret : System.Security.SecureString -StartDate : 11/12/2018 9:36:05 PM -EndDate : 11/12/2019 9:36:05 PM -KeyId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -Type : Password -``` - -A new password credential is added to the existing service principal with object id '00001111-aaaa-2222-bbbb-3333cccc4444'. - -### Example 2 - Create a new service principal credential using a certificate - -``` -PS C:\> $cer = New-Object System.Security.Cryptography.X509Certificates.X509Certificate -PS C:\> $cer.Import("C:\myapp.cer") -PS C:\> $binCert = $cer.GetRawCertData() -PS C:\> $credValue = [System.Convert]::ToBase64String($binCert) -PS C:\> New-AzureRmADSpCredential -ServicePrincipalName "http://test123" -CertValue $credValue -StartDate $cer.GetEffectiveDateString() -EndDate $cer.GetExpirationDateString() -``` - -The supplied base64 encoded public X509 certificate ("myapp.cer") is added to the existing service principal using its SPN. - -### Example 3 - Create a new service principal credential using piping - -``` -PS C:\> Get-AzureRmADServicePrincipal -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 | New-AzureRmADSpCredential - -Secret : System.Security.SecureString -StartDate : 11/12/2018 9:36:05 PM -EndDate : 11/12/2019 9:36:05 PM -KeyId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -Type : Password -``` - -Gets the service principal with object id '00001111-aaaa-2222-bbbb-3333cccc4444' and pipes that to the New-AzureRmADSpCredential to create a new service principal credential for that service principal with a generated password. - -## PARAMETERS - -### -CertValue -The value of the "asymmetric" credential type. -It represents the base 64 encoded certificate. - -```yaml -Type: System.String -Parameter Sets: SpObjectIdWithCertValueParameterSet, SPNWithCertValueParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ServicePrincipalObjectWithCertValueParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndDate -The effective end date of the credential usage. -The default end date value is one year from today. -For an "asymmetric" type credential, this must be set to on or before the date that the X509 certificate is valid. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ObjectId -The object id of the service principal to add the credentials to. - -```yaml -Type: System.Guid -Parameter Sets: SpObjectIdWithPasswordParameterSet, SpObjectIdWithCertValueParameterSet -Aliases: ServicePrincipalObjectId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Password -The password to be associated with the application. - -```yaml -Type: System.Security.SecureString -Parameter Sets: SpObjectIdWithPasswordParameterSet, SPNWithPasswordParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Security.SecureString -Parameter Sets: ServicePrincipalObjectWithPasswordParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServicePrincipalName -The name (SPN) of the service principal to add the credentials to. - -```yaml -Type: System.String -Parameter Sets: SPNWithCertValueParameterSet, SPNWithPasswordParameterSet -Aliases: SPN - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServicePrincipalObject -The service principal object to add the credentials to. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADServicePrincipal -Parameter Sets: ServicePrincipalObjectWithCertValueParameterSet, ServicePrincipalObjectWithPasswordParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -StartDate -The effective start date of the credential usage. -The default start date value is today. -For an "asymmetric" type credential, this must be set to on or after the date that the X509 certificate is valid from. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADServicePrincipal -Parameters: ServicePrincipalObject (ByValue) - -### System.Security.SecureString - -### System.DateTime - -## OUTPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADCredential - -### Microsoft.Azure.Commands.Resources.Models.Authorization.PSADCredentialWrapper - -## NOTES - -## RELATED LINKS - -[Get-AzureRmADSpCredential](./Get-AzureRmADSpCredential.md) - -[Remove-AzureRmADSpCredential](./Remove-AzureRmADSpCredential.md) - -[Get-AzureRmADServicePrincipal](./Get-AzureRmADServicePrincipal.md) - - - diff --git a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmADUser.md b/azurermps-6.13.0/AzureRM.Resources/New-AzureRmADUser.md deleted file mode 100644 index 2cc41e3c12..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmADUser.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 86D8965D-D999-48A4-A4EE-9E054E5486EE -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermaduser -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADUser.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADUser.md ---- - -# New-AzureRmADUser - -## SYNOPSIS -Creates a new active directory user. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmADUser -DisplayName <String> -UserPrincipalName <String> -Password <SecureString> - [-ImmutableId <String>] [-MailNickname <String>] [-ForceChangePasswordNextLogin] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Creates a new active directory user (work/school account also popularly known as org-id). -For more information: https://msdn.microsoft.com/en-us/library/azure/ad/graph/api/users-operations#CreateUser - -## EXAMPLES - -### Example 1 - Create a new AD user -``` -PS C:\> $SecureStringPassword = ConvertTo-SecureString -String "password" -AsPlainText -Force -PS C:\> New-AzureRmADUser -DisplayName "MyDisplayName" -UserPrincipalName "myemail@domain.com" -Password $SecureStringPassword -MailNickname "MyMailNickName" -``` - -Creates a new AD user with the name "MyDisplayName" and user principal name "myemail@domain.com" in a tenant. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The name to display in the address book for the user. -example 'Alex Wu'. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ForceChangePasswordNextLogin -It must be specified if the user must change the password on the next successful login (true). -Default behavior is (false) to not change the password on the next successful login. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ImmutableId -It needs to be specified only if you are using a federated domain for the user's user principal name (upn) property. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MailNickname -The mail alias for the user. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Password -Password for the user. -It must meet the tenant's password complexity requirements. -It is recommended to set a strong password. - -```yaml -Type: System.Security.SecureString -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserPrincipalName -The user principal name. -Example-'someuser@contoso.com'. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Security.SecureString - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADUser - -## NOTES - -## RELATED LINKS - -[Get-AzureRmADUser](./Get-AzureRmADUser.md) - - -[Remove-AzureRmADUser](./Remove-AzureRmADUser.md) diff --git a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmDeployment.md b/azurermps-6.13.0/AzureRM.Resources/New-AzureRmDeployment.md deleted file mode 100644 index 5199e3d7dd..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmDeployment.md +++ /dev/null @@ -1,337 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermdeployment -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmDeployment.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmDeployment.md ---- - -# New-AzureRmDeployment - -## SYNOPSIS -Creat a deployment - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByTemplateFileWithNoParameters (Default) -``` -New-AzureRmDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] [-AsJob] - -TemplateFile <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ByTemplateFileAndParameterObject -``` -New-AzureRmDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] [-AsJob] - -TemplateParameterObject <Hashtable> -TemplateFile <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTemplateUriAndParameterObject -``` -New-AzureRmDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] [-AsJob] - -TemplateParameterObject <Hashtable> -TemplateUri <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTemplateFileAndParameterFile -``` -New-AzureRmDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] [-AsJob] - -TemplateParameterFile <String> -TemplateFile <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTemplateUriAndParameterFile -``` -New-AzureRmDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] [-AsJob] - -TemplateParameterFile <String> -TemplateUri <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTemplateFileAndParameterUri -``` -New-AzureRmDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] [-AsJob] - -TemplateParameterUri <String> -TemplateFile <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTemplateUriAndParameterUri -``` -New-AzureRmDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] [-AsJob] - -TemplateParameterUri <String> -TemplateUri <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTemplateUriWithNoParameters -``` -New-AzureRmDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] [-AsJob] - -TemplateUri <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmDeployment** cmdlet adds a deployment at the current subscription scope. -This includes the resources that the deployment requires. - -An Azure resource is a user-managed Azure entity. A resource can live in a resource group, like database server, database, website, virtual machine, or Storage account. -Or, it can be a subscription level resource, like role definition, policy definition, etc. - -To add resources to a resource group, use the **New-AzureRmDeployment** which creates a deployment at a resource group. -The **New-AzureRmDeployment** cmdlet creates a deployment at the current subscription scope, which deploys subscription level resources. - -To add a deployment at subscription, specify the location and a template. -The location tells Azure Resource Manager where to store the deployment data. The template is a JSON string that contains individual resources to be deployed. -The template includes parameter placeholders for required resources and configurable property values, such as names and sizes. - -To use a custom template for the deployment, specify the *TemplateFile* parameter or *TemplateUri* parameter. -Each template has parameters for configurable properties. -To specify values for the template parameters, specify the *TemplateParameterFile* parameter or the *TemplateParameterObject* parameter. -Alternatively, you can use the template parameters that are dynamically added to the command when you specify a template. -To use dynamic parameters, type them at the command prompt, or type a minus sign (-) to indicate a parameter and use the Tab key to cycle through available parameters. -Template parameter values that you enter at the command prompt take precedence over values in a template parameter object or file. - -## EXAMPLES - -### Example 1: Use a custom template and parameter file to create a deployment -``` -PS C:\>New-AzureRmDeployment -Location "West US" -TemplateFile "D:\Azure\Templates\EngineeringSite.json" -TemplateParameterFile "D:\Azure\Templates\EngSiteParms.json" -TemplateVersion "2.1" -``` - -This command creates a new deployment at the current subscription scope by using a custom template and a template file on disk. -The command uses the *TemplateFile* parameter to specify the template and the *TemplateParameterFile* parameter to specify a file that contains parameters and parameter values. -It uses the *TemplateVersion* parameter to specify the version of the template. - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeploymentDebugLogLevel -The deployment debug log level. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The location to store deployment data. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the deployment it's going to create. -Only valid when a template is used. -When a template is used, if the user doesn't specify a deployment name, use the current time, like "20131223140835". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: DeploymentName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TemplateFile -Local path to the template file. - -```yaml -Type: String -Parameter Sets: ByTemplateFileWithNoParameters, ByTemplateFileAndParameterObject, ByTemplateFileAndParameterFile, ByTemplateFileAndParameterUri -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TemplateParameterFile -A file that has the template parameters. - -```yaml -Type: String -Parameter Sets: ByTemplateFileAndParameterFile, ByTemplateUriAndParameterFile -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TemplateParameterObject -A hash table which represents the parameters. - -```yaml -Type: Hashtable -Parameter Sets: ByTemplateFileAndParameterObject, ByTemplateUriAndParameterObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TemplateParameterUri -Uri to the template parameter file. - -```yaml -Type: String -Parameter Sets: ByTemplateFileAndParameterUri, ByTemplateUriAndParameterUri -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TemplateUri -Uri to the template file. - -```yaml -Type: String -Parameter Sets: ByTemplateUriAndParameterObject, ByTemplateUriAndParameterFile, ByTemplateUriAndParameterUri, ByTemplateUriWithNoParameters -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmManagedApplication.md b/azurermps-6.13.0/AzureRM.Resources/New-AzureRmManagedApplication.md deleted file mode 100644 index ab0f153684..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmManagedApplication.md +++ /dev/null @@ -1,270 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermmanagedapplication -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmManagedApplication.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmManagedApplication.md ---- - -# New-AzureRmManagedApplication - -## SYNOPSIS -Creates an Azure managed application. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmManagedApplication -Name <String> -ResourceGroupName <String> -ManagedResourceGroupName <String> - [-ManagedApplicationDefinitionId <String>] -Location <String> [-Parameter <String>] -Kind <ApplicationKind> - [-Plan <Hashtable>] [-Tag <Hashtable>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmManagedApplication** cmdlet creates an Azure Managed Application. - -## EXAMPLES - -### Example 1 -``` -PS C:\>New-AzureRmManagedApplication -Name "myManagedApplication" -ResourceGroupName myRG -ManagedResourceGroupName myManagedRG -ManagedApplicationDefinitionId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.Solutions/applicationDefinitions/myAppDef" -Location eastus2euap -Kind ServiceCatalog -``` - -This command creates a managed application - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Kind -The managed application kind. -One of marketplace or servicecatalog - -```yaml -Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Application.ApplicationKind -Parameter Sets: (All) -Aliases: -Accepted values: ServiceCatalog, MarketPlace - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The resource location. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedApplicationDefinitionId -The managed resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ManagedResourceGroupName -The managed resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The managed application name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Parameter -The JSON formatted string of parameters for managed application. -This can either be a path to a file name or uri containing the parameters, or the parameters as string. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Plan -A hash table which represents managed application plan properties. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: PlanObject - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -A hashtable which represents resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -## OUTPUTS - -### System.Management.Automation.PSObject - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmManagedApplicationDefinition.md b/azurermps-6.13.0/AzureRM.Resources/New-AzureRmManagedApplicationDefinition.md deleted file mode 100644 index 75abf1322f..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmManagedApplicationDefinition.md +++ /dev/null @@ -1,304 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermmanagedapplicationdefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmManagedApplicationDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmManagedApplicationDefinition.md ---- - -# New-AzureRmManagedApplicationDefinition - -## SYNOPSIS -Creates a managed application definition. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmManagedApplicationDefinition -Name <String> -ResourceGroupName <String> -DisplayName <String> - -Description <String> -Location <String> -LockLevel <ApplicationLockLevel> [-PackageFileUri <String>] - [-CreateUiDefinition <String>] [-MainTemplate <String>] -Authorization <String[]> [-Tag <Hashtable>] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmManagedApplicationDefinition** cmdlet creates a managed application definition. - -## EXAMPLES - -### Example 1 -``` -PS> New-AzureRmManagedApplicationDefinition -Name myAppDef -ResourceGroupName myRG -DisplayName test -Description "sample description" -Location westus -LockLevel ReadOnly -PackageFileUri https://sample.blob.core.windows.net/files/myPackage.zip -Authorization <principalId:roleDefinitionId> -``` - -This command creates a managed application definition - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Authorization -The managed application definition authorization. -Comma separated authorization pairs in a format of \<principalId\>:\<roleDefinitionId\> - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CreateUiDefinition -The managed application definition create ui definition - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The managed application definition description. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisplayName -The managed application definition display name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -The resource location. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LockLevel -The level of the lock for managed application definition. - -```yaml -Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Application.ApplicationLockLevel -Parameter Sets: (All) -Aliases: Level -Accepted values: None, CanNotDelete, ReadOnly - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MainTemplate -The managed application definition main template - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The managed application definition name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PackageFileUri -The managed application definition package file uri. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -A hashtable which represents resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Application.ApplicationLockLevel - -### System.String[] - -### System.Collections.Hashtable - -## OUTPUTS - -### System.Management.Automation.PSObject - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmManagementGroup.md b/azurermps-6.13.0/AzureRM.Resources/New-AzureRmManagementGroup.md deleted file mode 100644 index 325285ab2d..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmManagementGroup.md +++ /dev/null @@ -1,233 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermmanagementgroup/ -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmManagementGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmManagementGroup.md ---- - -# New-AzureRmManagementGroup - -## SYNOPSIS -Creates a Management Group - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GroupOperations (Default) -``` -New-AzureRmManagementGroup [-GroupName] <String> [-DisplayName <String>] [-ParentId <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ParentGroupObject -``` -New-AzureRmManagementGroup [-GroupName] <String> [-DisplayName <String>] - [-DefaultProfile <IAzureContextContainer>] -ParentObject <PSManagementGroup> [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRMManagementGroup** cmdlet creates a management group. - -## EXAMPLES - -### Example 1: Create a Management Group -``` -PS C:\> New-AzureRmManagementGroup -GroupName "TestGroup" - -Id : /providers/Microsoft.Management/managementGroups/TestGroup -Type : /providers/Microsoft.Management/managementGroups -Name : TestGroup -TenantId : 00001111-aaaa-2222-bbbb-3333cccc4444 -DisplayName : TestGroup -UpdatedTime : 2/1/2018 11:06:27 AM -UpdatedBy : 00001111-aaaa-2222-bbbb-3333cccc4444 -ParentId : /providers/Microsoft.Management/managementGroups/00001111-aaaa-2222-bbbb-3333cccc4444 -ParentName : 00001111-aaaa-2222-bbbb-3333cccc4444 -ParentDisplayName : 00001111-aaaa-2222-bbbb-3333cccc4444 -``` - -Creation of a new group with `DisplayName` and `ParentId` set to `null`. The `DisplayName` will be same as the `GroupName` and the parent of the group will be the tenant. - -### Example 2: Create a Management Group with a display name -``` -PS C:\> New-AzureRmManagementGroup -GroupName "TestGroup" -DisplayName "TestGroupDisplayName" - -Id : /providers/Microsoft.Management/managementGroups/TestGroup -Type : /providers/Microsoft.Management/managementGroups -Name : TestGroup -TenantId : 00001111-aaaa-2222-bbbb-3333cccc4444 -DisplayName : TestGroup -UpdatedTime : 2/1/2018 11:06:27 AM -UpdatedBy : 00001111-aaaa-2222-bbbb-3333cccc4444 -ParentId : /providers/Microsoft.Management/managementGroups/00001111-aaaa-2222-bbbb-3333cccc4444 -ParentName : 00001111-aaaa-2222-bbbb-3333cccc4444 -ParentDisplayName : 00001111-aaaa-2222-bbbb-3333cccc4444 -``` - -In this case, the parent of the group will be the tenant and the `DisplayName` will be set to the value given. - -### Example 3: Create a Management Group with a parent and a display name -``` -PS C:\> New-AzureRmManagementGroup -GroupName "TestGroup" -DisplayName "TestGroupDisplayName" -ParentId "/providers/Microsoft.Management/managementGroups/TestGroupParent" - -Id : /providers/Microsoft.Management/managementGroups/TestGroup -Type : /providers/Microsoft.Management/managementGroups -Name : TestGroup -TenantId : 00001111-aaaa-2222-bbbb-3333cccc4444 -DisplayName : TestGroupDisplayName -UpdatedTime : 2/1/2018 11:16:12 AM -UpdatedBy : 00001111-aaaa-2222-bbbb-3333cccc4444 -ParentId : /providers/Microsoft.Management/managementGroups/TestGroupParent -ParentName : TestGroupParent -ParentDisplayName : TestGroupParent -``` - -### Example 4: Create a Management Group with a parent (using a parent object) -``` -PS C:\> $parentObject = Get-AzureRmManagementGroup -GroupName "TestGroupParent" -PS C:\> New-AzureRmManagementGroup -GroupName "TestGroup" -ParentObject $parentObject - -Id : /providers/Microsoft.Management/managementGroups/TestGroup -Type : /providers/Microsoft.Management/managementGroups -Name : TestGroup -TenantId : 00001111-aaaa-2222-bbbb-3333cccc4444 -DisplayName : TestGroupDisplayName -UpdatedTime : 2/1/2018 11:16:12 AM -UpdatedBy : 00001111-aaaa-2222-bbbb-3333cccc4444 -ParentId : /providers/Microsoft.Management/managementGroups/TestGroupParent -ParentName : TestGroupParent -ParentDisplayName : TestGroupParent -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Display Name of the management group - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupName -Management Group Id - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParentId -Parent Id of the management group - -```yaml -Type: System.String -Parameter Sets: GroupOperations -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParentObject -Parent Object - -```yaml -Type: Microsoft.Azure.Commands.Resources.Models.ManagementGroups.PSManagementGroup -Parameter Sets: ParentGroupObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Resources.Models.ManagementGroups.PSManagementGroup - -## NOTES - -## RELATED LINKS - -[Remove-AzureRMManagementGroup](./Remove-AzureRMManagementGroup.md) - -[Update-AzureRmManagementGroup](./Update-AzureRmManagementGroup.md) - -[Get-AzureRmManagementGroup](./Get-AzureRmManagementGroup.md) diff --git a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmManagementGroupSubscription.md b/azurermps-6.13.0/AzureRM.Resources/New-AzureRmManagementGroupSubscription.md deleted file mode 100644 index 7f412e2539..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmManagementGroupSubscription.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermmanagementgroupsubscription/ -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmManagementGroupSubscription.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmManagementGroupSubscription.md ---- - -# New-AzureRmManagementGroupSubscription - -## SYNOPSIS -Adds a Subscription to a Management Group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmManagementGroupSubscription [-GroupName] <String> [-SubscriptionId] <Guid> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRMManagementGroupSubscription** cmdlet adds a Subscription to a Management Group. - -## EXAMPLES - -### Example 1: Add Subscription to a Management Group -``` -PS C:\> New-AzureRMManagementGroupSubscription -GroupName "TestGroup" -SubscriptionId 2120692d-35c3-44c8-81f5-631fa7351726 -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupName -Management Group Id - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Return `true` on successful execution - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Subscription Id of the subscription associated witht the management - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmPolicyAssignment.md b/azurermps-6.13.0/AzureRM.Resources/New-AzureRmPolicyAssignment.md deleted file mode 100644 index ba8bde52e8..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmPolicyAssignment.md +++ /dev/null @@ -1,483 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: BA40BD11-8167-48D7-AC71-72B2FD9924F2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermpolicyassignment -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmPolicyAssignment.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmPolicyAssignment.md ---- - -# New-AzureRmPolicyAssignment - -## SYNOPSIS -Creates a policy assignment. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameterSet (Default) -``` -New-AzureRmPolicyAssignment -Name <String> -Scope <String> [-NotScope <String[]>] [-DisplayName <String>] - [-Description <String>] [-PolicyDefinition <PSObject>] [-PolicySetDefinition <PSObject>] [-Metadata <String>] - [-Sku <Hashtable>] [-AssignIdentity] [-Location <String>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [<CommonParameters>] -``` - -### PolicyParameterObjectParameterSet -``` -New-AzureRmPolicyAssignment -Name <String> -Scope <String> [-NotScope <String[]>] [-DisplayName <String>] - [-Description <String>] -PolicyDefinition <PSObject> [-PolicySetDefinition <PSObject>] - -PolicyParameterObject <Hashtable> [-Metadata <String>] [-Sku <Hashtable>] [-AssignIdentity] - [-Location <String>] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>] -``` - -### PolicyParameterStringParameterSet -``` -New-AzureRmPolicyAssignment -Name <String> -Scope <String> [-NotScope <String[]>] [-DisplayName <String>] - [-Description <String>] -PolicyDefinition <PSObject> [-PolicySetDefinition <PSObject>] - -PolicyParameter <String> [-Metadata <String>] [-Sku <Hashtable>] [-AssignIdentity] [-Location <String>] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>] -``` - -### PolicySetParameterObjectParameterSet -``` -New-AzureRmPolicyAssignment -Name <String> -Scope <String> [-NotScope <String[]>] [-DisplayName <String>] - [-Description <String>] [-PolicyDefinition <PSObject>] -PolicySetDefinition <PSObject> - -PolicyParameterObject <Hashtable> [-Metadata <String>] [-Sku <Hashtable>] [-AssignIdentity] - [-Location <String>] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>] -``` - -### PolicySetParameterStringParameterSet -``` -New-AzureRmPolicyAssignment -Name <String> -Scope <String> [-NotScope <String[]>] [-DisplayName <String>] - [-Description <String>] [-PolicyDefinition <PSObject>] -PolicySetDefinition <PSObject> - -PolicyParameter <String> [-Metadata <String>] [-Sku <Hashtable>] [-AssignIdentity] [-Location <String>] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmPolicyAssignment** cmdlet creates a policy assignment. -Specify a policy and scope. - -## EXAMPLES - -### Example 1: Policy assignment at resource group level -``` -PS C:\> $ResourceGroup = Get-AzureRmResourceGroup -Name 'ResourceGroup11' -PS C:\> $Policy = Get-AzureRmPolicyDefinition -Name 'VirtualMachinePolicy' -PS C:\> New-AzureRmPolicyAssignment -Name 'VirtualMachinePolicyAssignment' -PolicyDefinition $Policy -Scope $ResourceGroup.ResourceId -``` - -The first command gets a resource group named ResourceGroup11 by using the Get-AzureRMResourceGroup cmdlet and stores it in the $ResourceGroup variable. -The second command gets the policy definition named VirtualMachinePolicy by using the Get-AzureRmPolicyDefinition cmdlet and stores it in the $Policy variable. -The final command assigns the policy in $Policy at the level of the resource group identified by the **ResourceId** property of $ResourceGroup. - -### Example 2: Policy assignment at resource group level with policy parameter object -``` -PS C:\> $ResourceGroup = Get-AzureRmResourceGroup -Name 'ResourceGroup11' -PS C:\> $Policy = Get-AzureRmPolicyDefinition -BuiltIn | Where-Object {$_.Properties.DisplayName -eq 'Allowed locations'} -PS C:\> $Locations = Get-AzureRmLocation | where displayname -like '*east*' -PS C:\> $AllowedLocations = @{'listOfAllowedLocations'=($Locations.location)} -PS C:\> New-AzureRmPolicyAssignment -Name 'RestrictLocationPolicyAssignment' -PolicyDefinition $Policy -Scope $ResourceGroup.ResourceId -PolicyParameterObject $AllowedLocations -``` - -The first command gets a resource group named ResourceGroup11 by using the Get-AzureRMResourceGroup cmdlet. -The command stores that object in the $ResourceGroup variable. -The second command gets the built-in policy definition for allowed locations by using the Get-AzureRmPolicyDefinition cmdlet. -The command stores that object in the $Policy variable. -The third and fourth commands create an object containing all Azure regions with "east" in the name. -The commands store that object in the $AllowedLocations variable. -The final command assigns the policy in $Policy at the level of a resource group using the policy parameter object in $AllowedLocations. -The **ResourceId** property of $ResourceGroup identifies the resource group. - -### Example 3: Policy assignment at resource group level with policy parameter file -Create a file called _AllowedLocations.json_ in the local working directory with the following content. - -``` -{ - "listOfAllowedLocations": { - "value": [ - "westus", - "westeurope", - "japanwest" - ] - } -} -``` - -``` -PS C:\> $ResourceGroup = Get-AzureRmResourceGroup -Name 'ResourceGroup11' -PS C:\> $Policy = Get-AzureRmPolicyDefinition -BuiltIn | Where-Object {$_.Properties.DisplayName -eq 'Allowed locations'} -PS C:\> New-AzureRmPolicyAssignment -Name 'RestrictLocationPolicyAssignment' -PolicyDefinition $Policy -Scope $ResourceGroup.ResourceId -PolicyParameter .\AllowedLocations.json -``` - -The first command gets a resource group named ResourceGroup11 by using the Get-AzureRMResourceGroup cmdlet and stores it in the $ResourceGroup variable. -The second command gets the built-in policy definition for allowed locations by using the Get-AzureRmPolicyDefinition cmdlet and stores it in the $Policy variable. -The final command assigns the policy in $Policy at the resource group identified by the **ResourceId** property of $ResourceGroup using the policy parameter file AllowedLocations.json from the local working directory. - -### Example 4: Policy assignment with a managed identity -``` -PS C:\> $ResourceGroup = Get-AzureRmResourceGroup -Name 'ResourceGroup11' -PS C:\> $Policy = Get-AzureRmPolicyDefinition -Name 'VirtualMachinePolicy' -PS C:\> New-AzureRmPolicyAssignment -Name 'VirtualMachinePolicyAssignment' -PolicyDefinition $Policy -Scope $ResourceGroup.ResourceId -Location 'eastus' -AssignIdentity -``` - -The first command gets a resource group named ResourceGroup11 by using the Get-AzureRMResourceGroup cmdlet and stores it in the $ResourceGroup variable. -The second command gets the policy definition named VirtualMachinePolicy by using the Get-AzureRmPolicyDefinition cmdlet and stores it in the $Policy variable. -The final command assigns the policy in $Policy to the resource group. A managed identity is automatically created and assigned to the policy assignment. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. -If you do not specify a version, this cmdlet uses the latest available version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignIdentity -Generate and assign a Microsoft Entra identity for this policy assignment. The identity will be used when executing deployments for 'deployIfNotExists' policies. Location is required when assigning an identity. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The description for policy assignment - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisplayName -Specifies a display name for the policy assignment. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InformationAction -Specifies how this cmdlet responds to an information event. -The acceptable values for this parameter are: -- Continue -- Ignore -- Inquire -- SilentlyContinue -- Stop -- Suspend - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: infa - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationVariable -Specifies an information variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: iv - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The location of the policy assignment's resource identity. This is required when the -AssignIdentity switch is used. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Metadata -The metadata for the new policy assignment. This can either be a path to a file name containing the metadata, or the metadata as a string. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the policy assignment. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NotScope -The not scopes for policy assignment. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PolicyDefinition -Specifies a policy, as a **PsPolicyDefinition** object that contains the policy rule. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: DefaultParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: PolicyParameterObjectParameterSet, PolicyParameterStringParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: PolicySetParameterObjectParameterSet, PolicySetParameterStringParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PolicyParameter -The policy parameter file path or policy parameter string. - -```yaml -Type: System.String -Parameter Sets: PolicyParameterStringParameterSet, PolicySetParameterStringParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PolicyParameterObject -The policy parameter object. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: PolicyParameterObjectParameterSet, PolicySetParameterObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicySetDefinition -The policy set definition object. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: DefaultParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: PolicyParameterObjectParameterSet, PolicyParameterStringParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: PolicySetParameterObjectParameterSet, PolicySetParameterStringParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Specifies the scope at which to assign the policy. -For instance, to assign a policy to a resource group, specify the following: -`/subscriptions/`subscription ID`/resourcegroups/`resource group name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -A hash table which represents SKU properties. Defaults to the Free SKU with the values: `@{Name = 'A0'; Tier = 'Free'}`. To use the Standard SKU, use the values: `@{Name = 'A1'; Tier = 'Standard'}`. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: SkuObject - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmPolicyDefinition](./Get-AzureRmPolicyDefinition.md) - -[Get-AzureRmPolicyAssignment](./Get-AzureRmPolicyAssignment.md) - -[Remove-AzureRmPolicyAssignment](./Remove-AzureRmPolicyAssignment.md) - -[Set-AzureRmPolicyAssignment](./Set-AzureRmPolicyAssignment.md) diff --git a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmPolicyDefinition.md b/azurermps-6.13.0/AzureRM.Resources/New-AzureRmPolicyDefinition.md deleted file mode 100644 index e150c957b9..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmPolicyDefinition.md +++ /dev/null @@ -1,350 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 31F2AF24-488D-4CAF-A9C8-C8DAE76E031F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermpolicydefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmPolicyDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmPolicyDefinition.md ---- - -# New-AzureRmPolicyDefinition - -## SYNOPSIS -Creates a policy definition. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameParameterSet (Default) -``` -New-AzureRmPolicyDefinition -Name <String> [-DisplayName <String>] [-Description <String>] -Policy <String> - [-Metadata <String>] [-Parameter <String>] [-Mode <PolicyDefinitionMode>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [<CommonParameters>] -``` - -### ManagementGroupNameParameterSet -``` -New-AzureRmPolicyDefinition -Name <String> [-DisplayName <String>] [-Description <String>] -Policy <String> - [-Metadata <String>] [-Parameter <String>] [-Mode <PolicyDefinitionMode>] -ManagementGroupName <String> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>] -``` - -### SubscriptionIdParameterSet -``` -New-AzureRmPolicyDefinition -Name <String> [-DisplayName <String>] [-Description <String>] -Policy <String> - [-Metadata <String>] [-Parameter <String>] [-Mode <PolicyDefinitionMode>] -SubscriptionId <Guid> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmPolicyDefinition** cmdlet creates a policy definition that includes a policy rule in JavaScript Object Notation (JSON) format. - -## EXAMPLES - -### Example 1: Create a policy definition by using a policy file -``` -{ - "if": { - "field": "location", - "notIn": ["eastus", "westus", "centralus"] - }, - "then": { - "effect": "audit" - } -} -``` - -``` -PS C:\> New-AzureRmPolicyDefinition -Name 'LocationDefinition' -Policy C:\LocationPolicy.json -``` - -This command creates a policy definition named LocationDefinition that contains the policy rule specified in C:\LocationPolicy.json. Example content for the LocationPolicy.json file is provided above. - -### Example 2: Create a parameterized policy definition using inline parameters -``` -{ - "if": { - "field": "location", - "notIn": "[parameters('listOfAllowedLocations')]" - }, - "then": { - "effect": "audit" - } -} -``` - -``` -PS C:\> New-AzureRmPolicyDefinition -Name 'LocationDefinition' -Policy C:\LocationPolicy.json -Parameter '{ "listOfAllowedLocations": { "type": "array" } }' -``` - -This command creates a policy definition named LocationDefinition that contains the policy rule specified in C:\LocationPolicy.json. The parameter definition for the policy rule is provided inline. - -### Example 3: Create a policy definition inline in a management group -``` -PS C:\> New-AzureRmPolicyDefinition -Name 'VMPolicyDefinition' -ManagementGroupName Dept42 -DisplayName 'Virtual Machine policy definition' -Policy '{"if":{"source":"action","equals":"Microsoft.Compute/virtualMachines/write"},"then":{"effect":"deny"}}' -``` - -This command creates a policy definition named VMPolicyDefinition in management group Dept42. -The command specifies the policy as a string in valid JSON format. - -### Example 4: Create a policy definition inline with metadata -``` -PS C:\> New-AzureRmPolicyDefinition -Name 'VMPolicyDefinition' -Metadata '{"Category":"Virtual Machine"}' -Policy '{"if":{"source":"action","equals":"Microsoft.Compute/virtualMachines/write"},"then":{"effect":"deny"}}' - - -Name : VMPolicyDefinition -ResourceId : /subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Authorization/policyDefinitions/VMPolicyDefinition -ResourceName : VMPolicyDefinition -ResourceType : Microsoft.Authorization/policyDefinitions -SubscriptionId : 11111111-1111-1111-1111-111111111111 -Properties : @{displayName=VMPolicyDefinition; policyType=Custom; mode=All; metadata=; policyRule=} -PolicyDefinitionId : /subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Authorization/policyDefinitions/VMPolicyDefinition -``` - -This command creates a policy definition named VMPolicyDefinition with metadata indicating its category is "Virtual Machine". -The command specifies the policy as a string in valid JSON format. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. -If you do not specify a version, this cmdlet uses the latest available version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the policy definition. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisplayName -Specifies a display name for the policy definition. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InformationAction -Specifies how this cmdlet responds to an information event. -The acceptable values for this parameter are: -- Continue -- Ignore -- Inquire -- SilentlyContinue -- Stop -- Suspend - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: infa - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationVariable -Specifies an information variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: iv - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagementGroupName -The name of the management group of the new policy definition. - -```yaml -Type: System.String -Parameter Sets: ManagementGroupNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Metadata -The metadata for policy definition. This can either be a path to a file name containing the metadata, or the metadata as string - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Mode -The mode of the policy definition - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Policy.PolicyDefinitionMode] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the policy definition. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Parameter -The parameters declaration for policy definition. This can either be a path to a file name containing the parameters declaration, or the parameters declaration as string. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Policy -Specifies a policy rule for the policy definition. -You can specify the path of a .json file or a string that contains the policy in JSON format. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The subscription ID of the new policy definition. - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: SubscriptionIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmPolicyDefinition](./Get-AzureRmPolicyDefinition.md) - -[Remove-AzureRmPolicyDefinition](./Remove-AzureRmPolicyDefinition.md) - -[Set-AzureRmPolicyDefinition](./Set-AzureRmPolicyDefinition.md) - - diff --git a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmPolicySetDefinition.md b/azurermps-6.13.0/AzureRM.Resources/New-AzureRmPolicySetDefinition.md deleted file mode 100644 index 8ef3d45a6f..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmPolicySetDefinition.md +++ /dev/null @@ -1,313 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermpolicysetdefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmPolicySetDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmPolicySetDefinition.md ---- - -# New-AzureRmPolicySetDefinition - -## SYNOPSIS -Creates a policy set definition. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameParameterSet (Default) -``` -New-AzureRmPolicySetDefinition -Name <String> [-DisplayName <String>] [-Description <String>] - [-Metadata <String>] -PolicyDefinition <String> [-Parameter <String>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ManagementGroupNameParameterSet -``` -New-AzureRmPolicySetDefinition -Name <String> [-DisplayName <String>] [-Description <String>] - [-Metadata <String>] -PolicyDefinition <String> [-Parameter <String>] -ManagementGroupName <String> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### SubscriptionIdParameterSet -``` -New-AzureRmPolicySetDefinition -Name <String> [-DisplayName <String>] [-Description <String>] - [-Metadata <String>] -PolicyDefinition <String> [-Parameter <String>] -SubscriptionId <Guid> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmPolicySetDefinition** cmdlet creates a policy set definition. - -## EXAMPLES - -### Example 1: Create a policy set definition by using a policy set file -``` -[ - { - "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/2a0e14a6-b0a6-4fab-991a-187a4f81c498", - "parameters": { - "tagName": { - "value": "Business Unit" - }, - "tagValue": { - "value": "Finance" - } - } - }, - { - "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/464dbb85-3d5f-4a1d-bb09-95a9b5dd19cf" - } -] -``` - -``` -PS C:\> New-AzureRmPolicySetDefinition -Name 'VMPolicyDefinition' -PolicyDefinition C:\VMPolicySet.json -``` - -This command creates a policy set definition named VMPolicyDefinition that contains the policy definitions specified in C:\VMPolicy.json. Example content of the VMPolicy.json is provided above. - -### Example 2: Create a parameterized policy set definition -``` -[ - { - "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/2a0e14a6-b0a6-4fab-991a-187a4f81c498", - "parameters": { - "tagName": { - "value": "Business Unit" - }, - "tagValue": { - "value": "[parameters('buTagValue')]" - } - } - }, - { - "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/464dbb85-3d5f-4a1d-bb09-95a9b5dd19cf" - } -] -``` - -``` -PS C:\> New-AzureRmPolicySetDefinition -Name 'VMPolicyDefinition' -PolicyDefinition C:\VMPolicySet.json -Parameter '{ "buTagValue": { "type": "string" } }' -``` - -This command creates a parameterized policy set definition named VMPolicyDefinition that contains the policy definitions specified in C:\VMPolicy.json. Example content of the VMPolicy.json is provided above. - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The description for policy set definition. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisplayName -The display name for policy set definition. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ManagementGroupName -The name of the management group of the new policy set definition. - -```yaml -Type: System.String -Parameter Sets: ManagementGroupNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Metadata -The metadata for policy set definition. This can either be a path to a file name containing the metadata, or the metadata as string - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The policy set definition name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Parameter -The parameters declaration for policy set definition. -This can either be a path to a file name containing the parameters declaration, or the parameters declaration as string. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PolicyDefinition -The policy set definition. This can either be a path to a file name containing the policy definitions, or the policy set definition as string. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The subscription ID of the new policy set definition. - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: SubscriptionIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### System.Management.Automation.PSObject - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmResource.md b/azurermps-6.13.0/AzureRM.Resources/New-AzureRmResource.md deleted file mode 100644 index ffe61a72c5..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmResource.md +++ /dev/null @@ -1,443 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: D6FF6BDD-4515-438D-B39D-C0BFC3342F4E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermresource -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmResource.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmResource.md ---- - -# New-AzureRmResource - -## SYNOPSIS -Creates a resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByResourceId (Default) -``` -New-AzureRmResource [-Location <String>] [-Kind <String>] [-Properties <PSObject>] [-Plan <Hashtable>] - [-Sku <Hashtable>] [-Tag <Hashtable>] [-IsFullObject] [-AsJob] -ResourceId <String> [-ODataQuery <String>] - [-Force] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### BySubscriptionLevel -``` -New-AzureRmResource [-Location <String>] [-Kind <String>] [-Properties <PSObject>] [-Plan <Hashtable>] - [-Sku <Hashtable>] [-Tag <Hashtable>] [-IsFullObject] [-AsJob] -ResourceName <String> -ResourceType <String> - [-ExtensionResourceName <String>] [-ExtensionResourceType <String>] [-ODataQuery <String>] - [-ResourceGroupName <String>] [-Force] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTenantLevel -``` -New-AzureRmResource [-Location <String>] [-Kind <String>] [-Properties <PSObject>] [-Plan <Hashtable>] - [-Sku <Hashtable>] [-Tag <Hashtable>] [-IsFullObject] [-AsJob] -ResourceName <String> -ResourceType <String> - [-ExtensionResourceName <String>] [-ExtensionResourceType <String>] [-ODataQuery <String>] [-TenantLevel] - [-Force] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmResource** cmdlet creates an Azure resource, such as a website, Azure SQL Database server, or Azure SQL Database, in a resource group. - -## EXAMPLES - -### Example 1: Create a resource -``` -PS> New-AzureRmResource -Location "West US" -Properties @{test="test"} -ResourceName TestSite06 -ResourceType microsoft.web/sites -ResourceGroupName ResourceGroup11 -Force -``` - -This command creates a resource that is a website in ResourceGroup11. - -### Example 2: Create a resource using splatting -``` -PS> $prop = @{ - Location = "West US" - Properties = @{test = "test"} - ResourceName = "TestSite06" - ResourceType = "microsoft.web/sites" - ResourceGroupName = "ResourceGroup11" - Force = $true -} - -PS> New-AzureRmResource @prop -``` - -This command creates a resource that is a website in ResourceGroup11. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. If you do not specify a version, this cmdlet uses the latest available version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionResourceName -Specifies the name of an extension resource for the resource. For instance, to specify a database, use the following format: -server name`/`database name - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExtensionResourceType -Specifies the resource type for an extension resource. -For instance, if the extension resource is a database, specify the following type: -`Microsoft.Sql/Servers/Databases` - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsFullObject -Indicates that the object that the *Properties* parameter specifies is the full object. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Kind -Specifies the resource kind for the resource. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the resource. -Specify data center location, such as Central US or Southeast Asia. -You can place a resource in any location that supports resources of that type. Resource groups can -contain resources from different locations. To determine which locations support each resource -type, use the Get-AzureLocation cmdlet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ODataQuery -Specifies an Open Data Protocol (OData) style filter. This cmdlet appends this value to the request -in addition to any other filters. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Plan -A hash table that represents resource plan properties. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: PlanObject - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Properties -Specifies resource properties for the resource. Use this parameter to specify the values of -properties that are specific to a resource type. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: PropertyObject - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group where this cmdlet creates the resource. - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Specifies the fully qualified resource ID, including the subscription, as in the following example: -`/subscriptions/`subscription ID`/providers/Microsoft.Sql/servers/ContosoServer/databases/ContosoDatabase` - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceName -Specifies the name of the resource. For instance, to specify a database, use the following format: -`ContosoServer/ContosoDatabase` - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel, ByTenantLevel -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceType -Specifies the type of the resource. -For instance, for a database, the resource type is as follows: -`Microsoft.Sql/Servers/Databases` - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -A hash table that represents sku properties. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: SkuObject - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TenantLevel -Indicates that this cmdlet operates at the tenant level. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.ResourceManagement.Models.PSResource - -## NOTES - -## RELATED LINKS - - -[Get-AzureRmResource](./Get-AzureRmResource.md) - -[Move-AzureRmResource](./Move-AzureRmResource.md) - -[Remove-AzureRmResource](./Remove-AzureRmResource.md) - -[Set-AzureRmResource](./Set-AzureRmResource.md) diff --git a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmResourceGroup.md b/azurermps-6.13.0/AzureRM.Resources/New-AzureRmResourceGroup.md deleted file mode 100644 index 5a1f2acc1c..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmResourceGroup.md +++ /dev/null @@ -1,240 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 0632DAD6-F331-454F-9E7E-2164AB413E77 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermresourcegroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmResourceGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmResourceGroup.md ---- - -# New-AzureRmResourceGroup - -## SYNOPSIS -Creates an Azure resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmResourceGroup -Name <String> -Location <String> [-Tag <Hashtable>] [-Force] [-ApiVersion <String>] - [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmResourceGroup** cmdlet creates an Azure resource group. -You can create a resource group by using just a name and location, and then use the -New-AzureRmResource cmdlet to create resources to add to the resource group. -To add a deployment to an existing resource group, use the New-AzureRmResourceGroupDeployment -cmdlet. To add a resource to an existing resource group, use the **New-AzureRmResource** cmdlet. An -Azure resource is a user-managed Azure entity, such as a database server, database, or website. An -Azure resource group is a collection of Azure resources that are deployed as a unit. - -## EXAMPLES - -### Example 1: Create an empty resource group -``` -PS> New-AzureRmResourceGroup -Name RG01 -Location "South Central US" -``` - -This command creates a resource group that has no resources. You can use the -**New-AzureRmResource** or **New-AzureRmResourceGroupDeployment** cmdlets to add resources and -deployments to this resource group. - -### Example 2: Create an empty resource group using positional parameters -``` -PS> New-AzureRmResourceGroup RG01 "South Central US" -``` - -This command creates a resource group that has no resources. - -### Example 3: Create a resource group with tags -``` -PS> New-AzureRmResourceGroup -Name RG01 -Location "South Central US" -Tag @{Empty=$null; Department="Marketing"} -``` - -This command creates an empty resource group. This command is the same as the command in Example 1, -except that it assigns tags to the resource group. The first tag, named Empty, can be used to -identify resource groups that have no resources. The second tag is named Department and has a value -of Marketing. You can use a tag such as this one to categorize resource groups for administration -or budgeting. - -## PARAMETERS - -### -ApiVersion -Specifies the API version that is supported by the resource Provider. -You can specify a different version than the default version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the resource group. Specify an Azure data center location, such as West -US or Southeast Asia. You can place a resource group in any location. The resource group does not -have to be in the same location your Azure subscription or in the same location as its resources. -To determine which location supports each resource type, use the Get-AzureRmResourceProvider cmdlet -with the *ProviderNamespace* parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the resource group. The resource name must be unique in the subscription. If a -resource group that has that name already exists, the command prompts you for confirmation before -replacing the existing resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroupName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} -To add or change a tag, you must replace the collection of tags for the resource group. -After you assign tags to resources and groups, you can use the *Tag* parameter of -Get-AzureRmResource and Get-AzureRmResourceGroup to search for resources and groups by tag name or -by name and value. You can use tags to categorize your resources, such as by department or cost -center, or to track notes or comments about the resources. -To get your predefined tags, use the Get-AzureRMTag cmdlet. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.ResourceManagement.Models.PSResourceGroup - -## NOTES - -## RELATED LINKS - -[Get-AzureRmResourceProvider](./Get-AzureRmResourceProvider.md) - -[Get-AzureRmResourceGroup](./Get-AzureRmResourceGroup.md) - -[New-AzureRmResource](./New-AzureRmResource.md) - -[New-AzureRmResourceGroupDeployment](./New-AzureRmResourceGroupDeployment.md) - -[Remove-AzureRmResourceGroup](./Remove-AzureRmResourceGroup.md) - -[Set-AzureRmResourceGroup](./Set-AzureRmResourceGroup.md) diff --git a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmResourceGroupDeployment.md b/azurermps-6.13.0/AzureRM.Resources/New-AzureRmResourceGroupDeployment.md deleted file mode 100644 index 73b0be2363..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmResourceGroupDeployment.md +++ /dev/null @@ -1,432 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 6E2F0D5E-E683-46F3-B48B-55C4864F3308 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermresourcegroupdeployment -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmResourceGroupDeployment.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmResourceGroupDeployment.md ---- - -# New-AzureRmResourceGroupDeployment - -## SYNOPSIS -Adds an Azure deployment to a resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByTemplateFileWithNoParameters (Default) -``` -New-AzureRmResourceGroupDeployment [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] - [-DeploymentDebugLogLevel <String>] [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] [-Force] - [-AsJob] -TemplateFile <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTemplateFileAndParameterObject -``` -New-AzureRmResourceGroupDeployment [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] - [-DeploymentDebugLogLevel <String>] [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] [-Force] - [-AsJob] -TemplateParameterObject <Hashtable> -TemplateFile <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTemplateUriAndParameterObject -``` -New-AzureRmResourceGroupDeployment [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] - [-DeploymentDebugLogLevel <String>] [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] [-Force] - [-AsJob] -TemplateParameterObject <Hashtable> -TemplateUri <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTemplateFileAndParameterFile -``` -New-AzureRmResourceGroupDeployment [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] - [-DeploymentDebugLogLevel <String>] [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] [-Force] - [-AsJob] -TemplateParameterFile <String> -TemplateFile <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTemplateUriAndParameterFile -``` -New-AzureRmResourceGroupDeployment [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] - [-DeploymentDebugLogLevel <String>] [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] [-Force] - [-AsJob] -TemplateParameterFile <String> -TemplateUri <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTemplateFileAndParameterUri -``` -New-AzureRmResourceGroupDeployment [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] - [-DeploymentDebugLogLevel <String>] [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] [-Force] - [-AsJob] -TemplateParameterUri <String> -TemplateFile <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTemplateUriAndParameterUri -``` -New-AzureRmResourceGroupDeployment [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] - [-DeploymentDebugLogLevel <String>] [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] [-Force] - [-AsJob] -TemplateParameterUri <String> -TemplateUri <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTemplateUriWithNoParameters -``` -New-AzureRmResourceGroupDeployment [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] - [-DeploymentDebugLogLevel <String>] [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] [-Force] - [-AsJob] -TemplateUri <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmResourceGroupDeployment** cmdlet adds a deployment to an existing resource group. -This includes the resources that the deployment requires. -An Azure resource is a user-managed Azure entity, such as a database server, database, website, virtual machine, or Storage account. -An Azure resource group is a collection of Azure resources that are deployed as a unit, such as the website, database server, and databases that are required for a financial website. -A resource group deployment uses a template to add resources to a resource group and publishes them so that they are available in Azure. -To add resources to a resource group without using a template, use the New-AzureRmResource cmdlet. -To add a resource group deployment, specify the name of an existing resource group and a resource group template. -A resource group template is a JSON string that represents a resource group for a complex cloud-based service, such as a web portal. -The template includes parameter placeholders for required resources and configurable property values, such as names and sizes. -You can find many templates in the Azure template gallery or you can create your own templates. -You can use the **Get-AzureRmResourceGroupGalleryTemplate** cmdlet to find a template in the gallery. -To use a custom template to create a resource group, specify the *TemplateFile* parameter or *TemplateUri* parameter. -Each template has parameters for configurable properties. -To specify values for the template parameters, specify the *TemplateParameterFile* parameter or the *TemplateParameterObject* parameter. -Alternatively, you can use the template parameters that are dynamically added to the command when you specify a template. -To use dynamic parameters, type them at the command prompt, or type a minus sign (-) to indicate a parameter and use the Tab key to cycle through available parameters. -Template parameter values that you enter at the command prompt take precedence over values in a template parameter object or file. - -## EXAMPLES - -### Example 1: Use a custom template and parameter file to create a deployment -``` -PS C:\>New-AzureRmResourceGroupDeployment -ResourceGroupName "ContosoEngineering" -TemplateFile "D:\Azure\Templates\EngineeringSite.json" -TemplateParameterFile "D:\Azure\Templates\EngSiteParms.json" -``` - -This command creates a new deployment by using a custom template and a template file on disk. -The command uses the *TemplateFile* parameter to specify the template and the *TemplateParameterFile* parameter to specify a file that contains parameters and parameter values. - -## PARAMETERS - -### -ApiVersion -Specifies the API version that is supported by the resource Provider. -You can specify a different version than the default version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeploymentDebugLogLevel -Specifies a debug log level. -The acceptable values for this parameter are: -- RequestContent -- ResponseContent -- All -- None - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mode -Specifies the deployment mode. The acceptable values for this parameter are: -- Complete -- Incremental -In complete mode, Resource Manager deletes resources that exist in the resource group but are not -specified in the template. In incremental mode, Resource Manager leaves unchanged resources that -exist in the resource group but are not specified in the template. - -```yaml -Type: Microsoft.Azure.Management.ResourceManager.Models.DeploymentMode -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Incremental -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the resource group deployment to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: DeploymentName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to deploy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RollBackDeploymentName -Rollback to the successful deployment with the given name in the resource group, should not be used if -RollbackToLastDeployment is used. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RollbackToLastDeployment -Rollback to the last successful deployment in the resource group, should not be present if -RollBackDeploymentName is used. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TemplateFile -Specifies the full path of a JSON template file. -This can be a custom template or a gallery template that is saved as a JSON file, such as one created by using the **Save-AzureRmResourceGroupGalleryTemplate** cmdlet. - -```yaml -Type: System.String -Parameter Sets: ByTemplateFileWithNoParameters, ByTemplateFileAndParameterObject, ByTemplateFileAndParameterFile, ByTemplateFileAndParameterUri -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TemplateParameterFile -Specifies the full path of a JSON file that contains the names and values of the template parameters. -If a template has parameters, you must specify the parameter values with the *TemplateParameterFile* parameter or the *TemplateParameterObject* parameter. -Template parameters are dynamically added to the command when you specify a template. -To use the dynamic parameters, type a minus sign (-) to indicate a parameter name and then use the Tab key to cycle through the available parameters. - -```yaml -Type: System.String -Parameter Sets: ByTemplateFileAndParameterFile, ByTemplateUriAndParameterFile -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TemplateParameterObject -Specifies a hash table of template parameter names and values. -For help with hash tables in Windows PowerShell, type `Get-Help about_Hash_Tables`. -If a template has parameters, you must specify parameter values. -Template parameters are dynamically added to the command when you specify a template. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: ByTemplateFileAndParameterObject, ByTemplateUriAndParameterObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TemplateParameterUri -Specifies the URI of a template parameters file. - -```yaml -Type: System.String -Parameter Sets: ByTemplateFileAndParameterUri, ByTemplateUriAndParameterUri -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TemplateUri -Specifies the URI of a JSON template file. -This file can be a custom template or a gallery template that is saved as a JSON file, such as by using **Save-AzureRmResourceGroupGalleryTemplate**. - -```yaml -Type: System.String -Parameter Sets: ByTemplateUriAndParameterObject, ByTemplateUriAndParameterFile, ByTemplateUriAndParameterUri, ByTemplateUriWithNoParameters -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.ResourceManager.Models.PSResourceGroupDeployment - -## NOTES - -## RELATED LINKS - -[Get-AzureRmResourceGroupDeployment](./Get-AzureRmResourceGroupDeployment.md) - -[New-AzureRmResource](./New-AzureRmResource.md) - -[New-AzureRmResourceGroup](./New-AzureRmResourceGroup.md) - -[Remove-AzureRmResourceGroupDeployment](./Remove-AzureRmResourceGroupDeployment.md) - -[Stop-AzureRmResourceGroupDeployment](./Stop-AzureRmResourceGroupDeployment.md) - -[Test-AzureRmResourceGroupDeployment](./Test-AzureRmResourceGroupDeployment.md) - - diff --git a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmResourceLock.md b/azurermps-6.13.0/AzureRM.Resources/New-AzureRmResourceLock.md deleted file mode 100644 index bff863fb18..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmResourceLock.md +++ /dev/null @@ -1,378 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 6847ECFD-2E3D-46F6-ABE9-9D8E08C7858F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermresourcelock -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmResourceLock.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmResourceLock.md ---- - -# New-AzureRmResourceLock - -## SYNOPSIS -Creates a resource lock. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### BySpecifiedScope (Default) -``` -New-AzureRmResourceLock -LockName <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Force] - -Scope <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByResourceGroup -``` -New-AzureRmResourceLock -LockName <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Force] - -ResourceGroupName <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByResourceGroupLevel -``` -New-AzureRmResourceLock -LockName <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Force] - -ResourceName <String> -ResourceType <String> -ResourceGroupName <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### BySubscription -``` -New-AzureRmResourceLock -LockName <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Force] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### BySubscriptionLevel -``` -New-AzureRmResourceLock -LockName <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Force] - -ResourceName <String> -ResourceType <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTenantLevel -``` -New-AzureRmResourceLock -LockName <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Force] - -ResourceName <String> -ResourceType <String> [-TenantLevel] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByLockId -``` -New-AzureRmResourceLock -LockLevel <LockLevel> [-LockNotes <String>] [-Force] -LockId <String> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmResourceLock** cmdlet creates a resource lock. - -## EXAMPLES - -### Example 1: Create a resource lock on a website -``` -PS C:\>New-AzureRmResourceLock -LockLevel CanNotDelete -LockNotes "My lock notes" -LockName "ContosoSiteLock" -ResourceName "ContosoSite" -ResourceType "microsoft.web/sites" -``` - -This command creates a resource lock on a website. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. -If you do not specify a version, this cmdlet uses the latest available version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationAction -Specifies how this cmdlet responds to an information event. -The acceptable values for this parameter are: -- Continue -- Ignore -- Inquire -- SilentlyContinue -- Stop -- Suspend - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: infa - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationVariable -Specifies an information variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: iv - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LockId -Specifies the ID of the lock. - -```yaml -Type: System.String -Parameter Sets: ByLockId -Aliases: Id, ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LockLevel -Specifies the level for the lock. -Currently, valid values are CanNotDelete, ReadOnly. - -```yaml -Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Locks.LockLevel -Parameter Sets: (All) -Aliases: Level - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LockName -Specifies the name of the lock. - -```yaml -Type: System.String -Parameter Sets: BySpecifiedScope, ByResourceGroup, ByResourceGroupLevel, BySubscription, BySubscriptionLevel, ByTenantLevel -Aliases: ExtensionResourceName, Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LockNotes -Specifies the notes for the lock. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Notes - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group for which the lock applies or that contains the resource group for which the lock applies. - -```yaml -Type: System.String -Parameter Sets: ByResourceGroup, ByResourceGroupLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceName -Specifies the name of the resource for which the lock applies. -For instance, to specify a database, use the following format: -`ContosoServer/ContosoDatabase` - -```yaml -Type: System.String -Parameter Sets: ByResourceGroupLevel, BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceType -Specifies the resource type of the resource for which the lock applies. - -```yaml -Type: System.String -Parameter Sets: ByResourceGroupLevel, BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Scope -Specifies the scope to which the lock applies. -For instance, to specify a database, use the following format: -`/subscriptions/`subscription ID`/resourceGroups/`resource group name`/providers/Microsoft.Sql/servers/`server name`/databases/`database name -To specify a resource group, use the following format: -`/subscriptions/`subscription ID`/resourceGroups/`resource group name - -```yaml -Type: System.String -Parameter Sets: BySpecifiedScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TenantLevel -Indicates that this cmdlet operates at the tenant level. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmResourceLock](./Get-AzureRmResourceLock.md) - -[Remove-AzureRmResourceLock](./Remove-AzureRmResourceLock.md) - -[Set-AzureRmResourceLock](./Set-AzureRmResourceLock.md) - - diff --git a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmRoleAssignment.md b/azurermps-6.13.0/AzureRM.Resources/New-AzureRmRoleAssignment.md deleted file mode 100644 index 5be9205c04..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmRoleAssignment.md +++ /dev/null @@ -1,384 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: E460D108-2BF9-4F57-AF3D-13868DC73EA0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermroleassignment -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmRoleAssignment.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmRoleAssignment.md ---- - -# New-AzureRmRoleAssignment - -## SYNOPSIS -Assigns the specified RBAC role to the specified principal, at the specified scope. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### EmptyParameterSet (Default) -``` -New-AzureRmRoleAssignment -ObjectId <Guid> -Scope <String> -RoleDefinitionName <String> [-AllowDelegation] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceGroupWithObjectIdParameterSet -``` -New-AzureRmRoleAssignment -ObjectId <Guid> -ResourceGroupName <String> -RoleDefinitionName <String> - [-AllowDelegation] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceWithObjectIdParameterSet -``` -New-AzureRmRoleAssignment -ObjectId <Guid> -ResourceGroupName <String> -ResourceName <String> - -ResourceType <String> [-ParentResource <String>] -RoleDefinitionName <String> [-AllowDelegation] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ScopeWithObjectIdParameterSet -``` -New-AzureRmRoleAssignment -ObjectId <Guid> [-Scope <String>] -RoleDefinitionName <String> [-AllowDelegation] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### RoleIdWithScopeAndObjectIdParameterSet -``` -New-AzureRmRoleAssignment -ObjectId <Guid> -Scope <String> -RoleDefinitionId <Guid> [-AllowDelegation] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceGroupWithSignInNameParameterSet -``` -New-AzureRmRoleAssignment -SignInName <String> -ResourceGroupName <String> -RoleDefinitionName <String> - [-AllowDelegation] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceWithSignInNameParameterSet -``` -New-AzureRmRoleAssignment -SignInName <String> -ResourceGroupName <String> -ResourceName <String> - -ResourceType <String> [-ParentResource <String>] -RoleDefinitionName <String> [-AllowDelegation] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ScopeWithSignInNameParameterSet -``` -New-AzureRmRoleAssignment -SignInName <String> [-Scope <String>] -RoleDefinitionName <String> - [-AllowDelegation] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceGroupWithSPNParameterSet -``` -New-AzureRmRoleAssignment -ApplicationId <String> -ResourceGroupName <String> -RoleDefinitionName <String> - [-AllowDelegation] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceWithSPNParameterSet -``` -New-AzureRmRoleAssignment -ApplicationId <String> -ResourceGroupName <String> -ResourceName <String> - -ResourceType <String> [-ParentResource <String>] -RoleDefinitionName <String> [-AllowDelegation] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ScopeWithSPNParameterSet -``` -New-AzureRmRoleAssignment -ApplicationId <String> [-Scope <String>] -RoleDefinitionName <String> - [-AllowDelegation] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the New-AzureRMRoleAssignment command to grant access. -Access is granted by assigning the appropriate RBAC role to them at the right scope. -To grant access to the entire subscription, assign a role at the subscription scope. -To grant access to a specific resource group within a subscription, assign a role at the resource group scope. -The subject of the assignment must be specified. -To specify a user, use SignInName or Microsoft Entra ObjectId parameters. -To specify a security group, use Microsoft Entra ObjectId parameter. -And to specify a Microsoft Entra application, use ApplicationId or ObjectId parameters. -The role that is being assigned must be specified using the RoleDefinitionName parameter. -The scope at which access is being granted may be specified. -It defaults to the selected subscription. -The scope of the assignment can be specified using one of the following parameter combinations - a. -Scope - This is the fully qualified scope starting with /subscriptions/\<subscriptionId\> - b. -ResourceGroupName - to grant access to the specified resource group. - c. -ResourceName, ResourceType, ResourceGroupName and (optionally) ParentResource - to specify a particular resource within a resource group to grant access to. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmRoleAssignment -ResourceGroupName rg1 -SignInName allen.young@live.com -RoleDefinitionName Reader -AllowDelegation -``` - -Grant Reader role access to a user at a resource group scope with the Role Assignment being available for delegation - -### Example 2 -``` -PS C:\> Get-AzureRMADGroup -SearchString "Christine Koch Team" - - DisplayName Type Id - ----------- ---- -------- - Christine Koch Team 00001111-aaaa-2222-bbbb-3333cccc4444 - -PS C:\> New-AzureRmRoleAssignment -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 -RoleDefinitionName Contributor -ResourceGroupName rg1 -``` - -Grant access to a security group - -### Example 3 -``` -PS C:\> New-AzureRmRoleAssignment -SignInName john.doe@contoso.com -RoleDefinitionName Owner -Scope "/subscriptions/00001111-aaaa-2222-bbbb-3333cccc4444/resourcegroups/rg1/providers/Microsoft.Web/sites/site1" -``` - -Grant access to a user at a resource (website) - -### Example 4 -``` -PS C:\> New-AzureRMRoleAssignment -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 -RoleDefinitionName "Virtual Machine Contributor" -ResourceName Devices-Engineering-ProjectRND -ResourceType Microsoft.Network/virtualNetworks/subnets -ParentResource virtualNetworks/VNET-EASTUS-01 -ResourceGroupName Network -``` - -Grant access to a group at a nested resource (subnet) - -### Example 5 -``` -PS C:\> $servicePrincipal = New-AzureRmADServicePrincipal -DisplayName "testServiceprincipal" -PS C:\> New-AzureRmRoleAssignment -RoleDefinitionName "Reader" -ApplicationId $servicePrincipal.ApplicationId -``` - -Grant reader access to a service principal - -## PARAMETERS - -### -AllowDelegation -The delegation flag while creating a Role assignment. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationId -The Application ID of the ServicePrincipal - -```yaml -Type: System.String -Parameter Sets: ResourceGroupWithSPNParameterSet, ResourceWithSPNParameterSet, ScopeWithSPNParameterSet -Aliases: SPN, ServicePrincipalName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ObjectId -Microsoft Entra Objectid of the user, group or service principal. - -```yaml -Type: System.Guid -Parameter Sets: EmptyParameterSet, ResourceGroupWithObjectIdParameterSet, ResourceWithObjectIdParameterSet, ScopeWithObjectIdParameterSet, RoleIdWithScopeAndObjectIdParameterSet -Aliases: Id, PrincipalId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ParentResource -The parent resource in the hierarchy(of the resource specified using ResourceName parameter). -Should only be used in conjunction with ResourceGroupName, ResourceType and ResourceName parameters to construct a hierarchical scope in the form of a relative URI that identifies a resource. - -```yaml -Type: System.String -Parameter Sets: ResourceWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceWithSPNParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. -Creates an assignment that is effective at the specified resource group. -When used in conjunction with ResourceName, ResourceType and (optionally)ParentResource parameters, the command constructs a hierarchical scope in the form of a relative URI that identifies a resource. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupWithObjectIdParameterSet, ResourceWithObjectIdParameterSet, ResourceGroupWithSignInNameParameterSet, ResourceWithSignInNameParameterSet, ResourceGroupWithSPNParameterSet, ResourceWithSPNParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceName -The resource name. -For e.g. -storageaccountprod. -Should only be used in conjunction with ResourceGroupName, ResourceType and (optionally)ParentResource parameters to construct a hierarchical scope in the form of a relative URI that identifies a resource. - -```yaml -Type: System.String -Parameter Sets: ResourceWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceWithSPNParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceType -The resource type. -For e.g. -Microsoft.Network/virtualNetworks. -Should only be used in conjunction with ResourceGroupName, ResourceName and (optionally)ParentResource parameters to construct a hierarchical scope in the form of a relative URI that identifies a resource. - -```yaml -Type: System.String -Parameter Sets: ResourceWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceWithSPNParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RoleDefinitionId -Id of the RBAC role that needs to be assigned to the principal. - -```yaml -Type: System.Guid -Parameter Sets: RoleIdWithScopeAndObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RoleDefinitionName -Name of the RBAC role that needs to be assigned to the principal i.e. -Reader, Contributor, Virtual Network Administrator, etc. - -```yaml -Type: System.String -Parameter Sets: EmptyParameterSet, ResourceGroupWithObjectIdParameterSet, ResourceWithObjectIdParameterSet, ScopeWithObjectIdParameterSet, ResourceGroupWithSignInNameParameterSet, ResourceWithSignInNameParameterSet, ScopeWithSignInNameParameterSet, ResourceGroupWithSPNParameterSet, ResourceWithSPNParameterSet, ScopeWithSPNParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Scope -The Scope of the role assignment. -In the format of relative URI. -For e.g. -"/subscriptions/9004a9fd-d58e-48dc-aeb2-4a4aec58606f/resourceGroups/TestRG". -If not specified, will create the role assignment at subscription level. -If specified, it should start with "/subscriptions/{id}". - -```yaml -Type: System.String -Parameter Sets: EmptyParameterSet, RoleIdWithScopeAndObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ScopeWithObjectIdParameterSet, ScopeWithSignInNameParameterSet, ScopeWithSPNParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SignInName -The email address or the user principal name of the user. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupWithSignInNameParameterSet, ResourceWithSignInNameParameterSet, ScopeWithSignInNameParameterSet -Aliases: Email, UserPrincipalName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleAssignment - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment - -## RELATED LINKS - -[Get-AzureRmRoleAssignment](./Get-AzureRmRoleAssignment.md) - -[Remove-AzureRmRoleAssignment](./Remove-AzureRmRoleAssignment.md) - -[Get-AzureRmRoleDefinition](./Get-AzureRmRoleDefinition.md) diff --git a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmRoleDefinition.md b/azurermps-6.13.0/AzureRM.Resources/New-AzureRmRoleDefinition.md deleted file mode 100644 index fbc2487bb0..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/New-AzureRmRoleDefinition.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 8300B143-E322-419E-BC98-DBA56DD90A59 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermroledefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmRoleDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmRoleDefinition.md ---- - -# New-AzureRmRoleDefinition - -## SYNOPSIS -Creates a custom role in Azure RBAC. -Provide either a JSON role definition file or a PSRoleDefinition object as input. -First, use the Get-AzureRmRoleDefinition command to generate a baseline role definition object. -Then, modify its properties as required. -Finally, use this command to create a custom role using role definition. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### InputFileParameterSet -``` -New-AzureRmRoleDefinition [-InputFile] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### RoleDefinitionParameterSet -``` -New-AzureRmRoleDefinition [-Role] <PSRoleDefinition> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmRoleDefinition cmdlet creates a custom role in Azure Role-Based Access Control. -Provide a role definition as an input to the command as a JSON file or a PSRoleDefinition object. -The input role definition MUST contain the following properties: -1) DisplayName: the name of the custom role -2) Description: a short description of the role that summarizes the access that the role grants. -3) Actions: the set of operations to which the custom role grants access. -Use Get-AzureRmProviderOperation to get the operation for Azure resource providers that can be secured using Azure RBAC. -Following are some valid operation strings: - - "*/read" grants access to read operations of all Azure resource providers. - - "Microsoft.Network/*/read" grants access to read operations for all resource types in the Microsoft.Network resource provider of Azure. - - "Microsoft.Compute/virtualMachines/*" grants access to all operations of virtual machines and its child resource types. -4) AssignableScopes: the set of scopes (Azure subscriptions or resource groups) in which the custom role will be available for assignment. -Using AssignableScopes you can make the custom role available for assignment in only the subscriptions or resource groups that need it, and not clutter the user experience for the rest of the subscriptions or resource groups. -Following are some valid assignable scopes: - - "/subscriptions/c276fc76-9cd4-44c9-99a7-4fd71546436e", "/subscriptions/e91d47c4-76f3-4271-a796-21b4ecfe3624": makes the role available for assignment in two subscriptions. - - "/subscriptions/c276fc76-9cd4-44c9-99a7-4fd71546436e": makes the role available for assignment in a single subscription. - - "/subscriptions/c276fc76-9cd4-44c9-99a7-4fd71546436e/resourceGroups/Network": makes the role available for assignment only in the Network resource group. -The input role definition MAY contain the following properties: -1) NotActions: the set of operations that must be excluded from the Actions to determine the effective actions for the custom role. -If there is a specific operation that you do not wish to grant access to in a custom role, it is convenient to use NotActions to exclude it, rather than specifying all operations other than that specific operation in Actions. -2) DataActions: the set of data operations to which the custom role grants access. -3) NotDataActions: the set of operations that must be excluded from the DataActions to determine the effective dataactions for the custom role. -If there is a specific data operation that you do not wish to grant access to in a custom role, it is convenient to use NotDataActions to exclude it, rather than specifying all operations other than that specific operation in Actions. -NOTE: If a user is assigned a role that specifies an operation in NotActions and also assigned another role grants access to the same operation - the user will be able to perform that operation. -NotActions is not a deny rule - it is simply a convenient way to create a set of allowed operations when specific operations need to be excluded. -Following is a sample json role definition that can be provided as input -{ - "Name": "Updated Role", - "Description": "Can monitor all resources and start and restart virtual machines", - "Actions": - \[ - "*/read", - "Microsoft.ClassicCompute/virtualmachines/restart/action", - "Microsoft.ClassicCompute/virtualmachines/start/action" - \], - "NotActions": - \[ - "*/write" - \], - "DataActions": - \[ - "Microsoft.Storage/storageAccounts/blobServices/containers/blobs/read" - \], - "NotDataActions": - \[ - "Microsoft.Storage/storageAccounts/blobServices/containers/blobs/write" - \], - "AssignableScopes": \["/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"\] -} - -## EXAMPLES - -### Create using PSRoleDefinitionObject -``` -PS C:\> $role = Get-AzureRmRoleDefinition -Name "Virtual Machine Contributor" - PS C:\> $role.Id = $null - PS C:\> $role.Name = "Virtual Machine Operator" - PS C:\> $role.Description = "Can monitor, start, and restart virtual machines." - PS C:\> $role.Actions.RemoveRange(0,$role.Actions.Count) - PS C:\> $role.Actions.Add("Microsoft.Compute/*/read") - PS C:\> $role.Actions.Add("Microsoft.Compute/virtualMachines/start/action") - PS C:\> $role.Actions.Add("Microsoft.Compute/virtualMachines/restart/action") - PS C:\> $role.Actions.Add("Microsoft.Compute/virtualMachines/downloadRemoteDesktopConnectionFile/action") - PS C:\> $role.Actions.Add("Microsoft.Network/*/read") - PS C:\> $role.Actions.Add("Microsoft.Storage/*/read") - PS C:\> $role.Actions.Add("Microsoft.Authorization/*/read") - PS C:\> $role.Actions.Add("Microsoft.Resources/subscriptions/resourceGroups/read") - PS C:\> $role.Actions.Add("Microsoft.Resources/subscriptions/resourceGroups/resources/read") - PS C:\> $role.Actions.Add("Microsoft.Insights/alertRules/*") - PS C:\> $role.Actions.Add("Microsoft.Support/*") - PS C:\> $role.AssignableScopes.Clear() - PS C:\> $role.AssignableScopes.Add("/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx") - - PS C:\> New-AzureRmRoleDefinition -Role $role -``` - -### Create using JSON file -``` -PS C:\> New-AzureRmRoleDefinition -InputFile C:\Temp\roleDefinition.json -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputFile -File name containing a single json role definition. - -```yaml -Type: System.String -Parameter Sets: InputFileParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Role -Role definition object. - -```yaml -Type: Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition -Parameter Sets: RoleDefinitionParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment - -## RELATED LINKS - -[Get-AzureRmProviderOperation](./Get-AzureRmProviderOperation.md) - -[Get-AzureRmRoleDefinition](./Get-AzureRmRoleDefinition.md) - -[Set-AzureRmRoleDefinition](./Set-AzureRmRoleDefinition.md) - -[Remove-AzureRmRoleDefinition](./Remove-AzureRmRoleDefinition.md) - diff --git a/azurermps-6.13.0/AzureRM.Resources/Register-AzureRmProviderFeature.md b/azurermps-6.13.0/AzureRM.Resources/Register-AzureRmProviderFeature.md deleted file mode 100644 index 2d616af765..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Register-AzureRmProviderFeature.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 83EE33E5-18EF-4A7A-AEF2-E93D7A3CA541 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/register-azurermproviderfeature -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Register-AzureRmProviderFeature.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Register-AzureRmProviderFeature.md ---- - -# Register-AzureRmProviderFeature - -## SYNOPSIS -Registers an Azure provider feature in your account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Register-AzureRmProviderFeature -FeatureName <String> -ProviderNamespace <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Register-AzureRmProviderFeature** cmdlet registers an Azure provider feature in your account. - -## EXAMPLES - -### Example 1: Register a feature -``` -PS C:\>Register-AzureRmProviderFeature -FeatureName AllowApplicationSecurityGroups -ProviderNamespace Microsoft.Network -``` - -This adds the AllowApplicationSecurityGroups feature for Microsoft.Network to your account. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FeatureName -Specifies the name of the feature that this cmdlet registers. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProviderNamespace -Specifies a namespace for which this cmdlet registers a provider feature. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmProviderFeature](./Get-AzureRmProviderFeature.md) - - diff --git a/azurermps-6.13.0/AzureRM.Resources/Register-AzureRmResourceProvider.md b/azurermps-6.13.0/AzureRM.Resources/Register-AzureRmResourceProvider.md deleted file mode 100644 index 483a755231..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Register-AzureRmResourceProvider.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: D5067FD8-2FB1-413C-9F59-84E83A74343E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/register-azurermresourceprovider -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Register-AzureRmResourceProvider.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Register-AzureRmResourceProvider.md ---- - -# Register-AzureRmResourceProvider - -## SYNOPSIS -Registers a resource provider. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Register-AzureRmResourceProvider -ProviderNamespace <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Register-AzureRmResourceProvider** cmdlet registers an Azure resource provider. - -## EXAMPLES - -### Example 1: Register a provider -``` -PS C:\>Register-AzureRmResourceProvider -ProviderNamespace Microsoft.Network -``` - -This registers the Microsoft.Network provider for your account. - -## PARAMETERS - -### -ApiVersion -Specifies the API version that is supported by the resource Provider. -You can specify a different version than the default version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProviderNamespace -Specifies the namespace of the resource provider. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmResourceProvider](./Get-AzureRmResourceProvider.md) - -[Unregister-AzureRmResourceProvider](./Unregister-AzureRmResourceProvider.md) - - diff --git a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmADAppCredential.md b/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmADAppCredential.md deleted file mode 100644 index f6380ed8c9..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmADAppCredential.md +++ /dev/null @@ -1,265 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: C61FA834-BEBE-4DBF-888F-C6CB8CC95390 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermadappcredential -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmADAppCredential.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmADAppCredential.md ---- - -# Remove-AzureRmADAppCredential - -## SYNOPSIS -Removes a credential from an application. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ApplicationObjectIdWithKeyIdParameterSet (Default) -``` -Remove-AzureRmADAppCredential -ObjectId <Guid> [-KeyId <Guid>] [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationIdWithKeyIdParameterSet -``` -Remove-AzureRmADAppCredential -ApplicationId <Guid> [-KeyId <Guid>] [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationDisplayNameParameterSet -``` -Remove-AzureRmADAppCredential -DisplayName <String> [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationObjectWithKeyIdParameterSet -``` -Remove-AzureRmADAppCredential [-KeyId <Guid>] -ApplicationObject <PSADApplication> [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmADAppCredential cmdlet can be used to remove a credential key from an application in the case of a compromise or as part of credential key rollover expiration. -The application is identified by supplying either the object ID or AppId. -The credential to be removed is identified by its key ID. - -## EXAMPLES - -### Example 1 - Remove a specific credential from an application - -``` -PS C:\> Remove-AzureRmADAppCredential -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 -KeyId 9044423a-60a3-45ac-9ab1-09534157ebb -``` - -Removes the credential with key id '9044423a-60a3-45ac-9ab1-09534157ebb' from the application with object id '00001111-aaaa-2222-bbbb-3333cccc4444'. - -### Example 2 - Remove all credentials from an application - -``` -PS C:\> Remove-AzureRmADAppCredential -ApplicationId 00001111-aaaa-2222-bbbb-3333cccc4444 -``` - -Removes all credentials from the application with application id '00001111-aaaa-2222-bbbb-3333cccc4444'. - -### Example 3 - Remove all credentials using piping - -``` -PS C:\> Get-AzureRmADApplication -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 | Remove-AzureRmADAppCredential -``` - -Gets the application with object id '00001111-aaaa-2222-bbbb-3333cccc4444' and pipes that to the Remove-AzureRmADAppCredential cmdlet and removes all credentials from that application. - -## PARAMETERS - -### -ApplicationId -The id of the application to remove the credentials from. - -```yaml -Type: System.Guid -Parameter Sets: ApplicationIdWithKeyIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationObject -The application object to remove the credentials from. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication -Parameter Sets: ApplicationObjectWithKeyIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The display name of the application. - -```yaml -Type: System.String -Parameter Sets: ApplicationDisplayNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Switch to delete credential without a confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyId -Specifies the credential key to be removed. -The key Ids for the application can be obtained using the Get-AzureRmADAppCredential cmdlet. - -```yaml -Type: System.Guid -Parameter Sets: ApplicationObjectIdWithKeyIdParameterSet, ApplicationIdWithKeyIdParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Guid -Parameter Sets: ApplicationObjectWithKeyIdParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ObjectId -The object id of the application to remove the credentials from. - -```yaml -Type: System.Guid -Parameter Sets: ApplicationObjectIdWithKeyIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Specifying this will return true if the command was successful. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication -Parameters: ApplicationObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmADAppCredential](./Get-AzureRmADAppCredential.md) - -[New-AzureRmADAppCredential](./New-AzureRmADAppCredential.md) - -[Get-AzureRmADApplication](./Get-AzureRmADApplication.md) diff --git a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmADApplication.md b/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmADApplication.md deleted file mode 100644 index ee481c1a35..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmADApplication.md +++ /dev/null @@ -1,237 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: C791C593-F7D5-4961-97F9-E4909813FFE7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermadapplication -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmADApplication.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmADApplication.md ---- - -# Remove-AzureRmADApplication - -## SYNOPSIS -Deletes the Microsoft Entra application. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ObjectIdParameterSet (Default) -``` -Remove-AzureRmADApplication -ObjectId <Guid> [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationIdParameterSet -``` -Remove-AzureRmADApplication -ApplicationId <Guid> [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationDisplayNameParameterSet -``` -Remove-AzureRmADApplication -DisplayName <String> [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectParameterSet -``` -Remove-AzureRmADApplication -InputObject <PSADApplication> [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Deletes the Microsoft Entra application. - -## EXAMPLES - -### Example 1 - Remove application by object id - -``` -PS C:\> Remove-AzureRmADApplication -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 -``` - -Removes the application with object id '00001111-aaaa-2222-bbbb-3333cccc4444' from the tenant. - -### Example 2 - Remove application by application id - -``` -PS C:\> Remove-AzureRmADApplication -ApplicationId 00001111-aaaa-2222-bbbb-3333cccc4444 -``` - -Removes the application with application id '00001111-aaaa-2222-bbbb-3333cccc4444' from the tenant. - -### Example 3 - Remove application by piping - -``` -PS C:\> Get-AzureRmADApplication -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 | Remove-AzureRmADApplication -``` - -Gets the application with object id '00001111-aaaa-2222-bbbb-3333cccc4444' and pipes that to the Remove-AzureRmADApplication cmdlet to remove the application from the tenant. - -## PARAMETERS - -### -ApplicationId -The application id of the application to remove. - -```yaml -Type: System.Guid -Parameter Sets: ApplicationIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The display name of the application. - -```yaml -Type: System.String -Parameter Sets: ApplicationDisplayNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Switch to delete an application without a confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The object representing the application to remove. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ObjectId -The object id of the application to delete. - -```yaml -Type: System.Guid -Parameter Sets: ObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Specifying this will return true if the command was successful. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment - -## RELATED LINKS - -[New-AzureRmADApplication](./New-AzureRmADApplication.md) - -[Get-AzureRmADApplication](./Get-AzureRmADApplication.md) - - -[Remove-AzureRmADAppCredential](./Remove-AzureRmADAppCredential.md) diff --git a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmADGroup.md b/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmADGroup.md deleted file mode 100644 index 721398dcd9..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmADGroup.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermadgroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmADGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmADGroup.md ---- - -# Remove-AzureRmADGroup - -## SYNOPSIS -Deletes an active directory group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ObjectIdParameterSet (Default) -``` -Remove-AzureRmADGroup -ObjectId <Guid> [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### DisplayNameParameterSet -``` -Remove-AzureRmADGroup -DisplayName <String> [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectParameterSet -``` -Remove-AzureRmADGroup -InputObject <PSADGroup> [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Deletes an active directory group. - -## EXAMPLES - -### Example 1 - Remove a group by object id - -``` -PS C:\> Remove-AzureRmADGroup -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 -``` - -Removes the group with object id '00001111-aaaa-2222-bbbb-3333cccc4444' from the tenant. - -### Example 2 - Remove a group by piping - -``` -PS C:\> Get-AzureRmADGroup -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 | Remove-AzureRmADGroup -``` - -Gets the group with object id '00001111-aaaa-2222-bbbb-3333cccc4444' and pipes that to Remove-AzureRmADGroup to remove the group from the tenant. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The display name of the group to be removed. - -```yaml -Type: System.String -Parameter Sets: DisplayNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -If specified, doesn't ask for confirmation for deleting the group. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The object representation of the group to be removed. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADGroup -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ObjectId -The object id of the group to be removed. - -```yaml -Type: System.Guid -Parameter Sets: ObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Specifying this will return true if the command was successful. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADGroup -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmADGroupMember.md b/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmADGroupMember.md deleted file mode 100644 index c16252fb4b..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmADGroupMember.md +++ /dev/null @@ -1,234 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermadgroupmember -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmADGroupMember.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmADGroupMember.md ---- - -# Remove-AzureRmADGroupMember - -## SYNOPSIS -Removes a user from an AD group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ExplicitParameterSet (Default) -``` -Remove-AzureRmADGroupMember [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### MemberObjectIdWithGroupDisplayName -``` -Remove-AzureRmADGroupMember -MemberObjectId <Guid[]> -GroupDisplayName <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### MemberObjectIdWithGroupObject -``` -Remove-AzureRmADGroupMember -MemberObjectId <Guid[]> -GroupObject <PSADGroup> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### MemberObjectIdWithGroupObjectId -``` -Remove-AzureRmADGroupMember -MemberObjectId <Guid[]> -GroupObjectId <Guid> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### MemberUPNWithGroupDisplayNameParameterSet -``` -Remove-AzureRmADGroupMember -MemberUserPrincipalName <String[]> -GroupDisplayName <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### MemberUPNWithGroupObjectParameterSet -``` -Remove-AzureRmADGroupMember -MemberUserPrincipalName <String[]> -GroupObject <PSADGroup> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### MemberUPNWithGroupObjectIdParameterSet -``` -Remove-AzureRmADGroupMember -MemberUserPrincipalName <String[]> -GroupObjectId <Guid> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Removes a user from an AD group. - -## EXAMPLES - -### Example 1 - Remove a user from a group by object id - -``` -PS C:\> Remove-AzureRmADGroup -MemberObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 -GroupObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 -``` - -Removes the user with object id '00001111-aaaa-2222-bbbb-3333cccc4444' from the group with object id '00001111-aaaa-2222-bbbb-3333cccc4444'. - -### Example 2 - Remove a user from a group by piping - -``` -PS C:\> Get-AzureRmADGroup -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 | Remove-AzureRmADGroupMember -MemberObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 -``` - -Gets the group with object id '00001111-aaaa-2222-bbbb-3333cccc4444' and pipes it to the Remove-AzureRmADGroupMember cmdlet to remove the user to that group. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupDisplayName -The display name of the group to remove the member(s) from. - -```yaml -Type: System.String -Parameter Sets: MemberObjectIdWithGroupDisplayName, MemberUPNWithGroupDisplayNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupObject -The object representation of the group to remove the member from. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADGroup -Parameter Sets: MemberObjectIdWithGroupObject, MemberUPNWithGroupObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -GroupObjectId -The object id of the group to remove the member from. - -```yaml -Type: System.Guid -Parameter Sets: MemberObjectIdWithGroupObjectId, MemberUPNWithGroupObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberObjectId -The object id of the member. - -```yaml -Type: System.Guid[] -Parameter Sets: MemberObjectIdWithGroupDisplayName, MemberObjectIdWithGroupObject, MemberObjectIdWithGroupObjectId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberUserPrincipalName -The UPN of the member(s) to remove. - -```yaml -Type: System.String[] -Parameter Sets: MemberUPNWithGroupDisplayNameParameterSet, MemberUPNWithGroupObjectParameterSet, MemberUPNWithGroupObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Specifying this will return true if the command was successful. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADGroup -Parameters: GroupObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmADServicePrincipal.md b/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmADServicePrincipal.md deleted file mode 100644 index 9a54a0cc7d..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmADServicePrincipal.md +++ /dev/null @@ -1,300 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 0C8C07CA-6720-452F-A952-48C76EBF3BBD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermadserviceprincipal -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmADServicePrincipal.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmADServicePrincipal.md ---- - -# Remove-AzureRmADServicePrincipal - -## SYNOPSIS -Deletes the Microsoft Entra service principal. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ObjectIdParameterSet (Default) -``` -Remove-AzureRmADServicePrincipal -ObjectId <Guid> [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationIdParameterSet -``` -Remove-AzureRmADServicePrincipal -ApplicationId <Guid> [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SPNParameterSet -``` -Remove-AzureRmADServicePrincipal -ServicePrincipalName <String> [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### DisplayNameParameterSet -``` -Remove-AzureRmADServicePrincipal -DisplayName <String> [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectParameterSet -``` -Remove-AzureRmADServicePrincipal -InputObject <PSADServicePrincipal> [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationObjectParameterSet -``` -Remove-AzureRmADServicePrincipal -ApplicationObject <PSADApplication> [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Deletes the Microsoft Entra service principal. - -## EXAMPLES - -### Example 1 - Remove a service principal by object id - -``` -PS C:\> Remove-AzureRmADServicePrincipal -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 -``` - -Removes the service principal with object id '00001111-aaaa-2222-bbbb-3333cccc4444'. - -### Example 2 - Remove a service principal by application id - -``` -PS C:\> Remove-AzureRmADServicePrincipal -ApplicationId 00001111-aaaa-2222-bbbb-3333cccc4444 -``` - -Removes the service principal with application id '00001111-aaaa-2222-bbbb-3333cccc4444'. - -### Example 3 - Remove a service principal by SPN - -``` -PS C:\> Remove-AzureRmADServicePrincipal -ServicePrincipalName MyServicePrincipal -``` - -Remove the service principal with service principal name "MyServicePrincipal" - -### Example 4 - Remove a service principal by piping - -``` -PS C:\> Get-AzureRmADServicePrincipal -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 | Remove-AzureRmADServicePrincipal -``` - -Gets the service principal with object id '00001111-aaaa-2222-bbbb-3333cccc4444' and pipes that to the Remove-AzureRmADServicePrincipal cmdlet to remove that service principal. - -### Example 5 - Remove a service principal by piping an application - -``` -PS C:\> Get-AzureRmApplication -ApplicationId 00001111-aaaa-2222-bbbb-3333cccc4444 | Remove-AzureRmADServicePrincipal -``` - -Gets the application with application id '00001111-aaaa-2222-bbbb-3333cccc4444' and pipes that to the Remove-AzureRmADServicePrincipal cmdlet to remove the service principal associated with that application. - -## PARAMETERS - -### -ApplicationId -The service principal application id. - -```yaml -Type: System.Guid -Parameter Sets: ApplicationIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationObject -The application object whose service principal is being removed. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication -Parameter Sets: ApplicationObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The display name of the service principal. - -```yaml -Type: System.String -Parameter Sets: DisplayNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Switch to delete service principal without a confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The service principal object. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADServicePrincipal -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ObjectId -The object id of the service principal to delete. - -```yaml -Type: System.Guid -Parameter Sets: ObjectIdParameterSet -Aliases: PrincipalId, Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -If specified, returns the deleted service principal. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServicePrincipalName -The service principal name. - -```yaml -Type: System.String -Parameter Sets: SPNParameterSet -Aliases: SPN - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADServicePrincipal -Parameters: InputObject (ByValue) - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication -Parameters: ApplicationObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADServicePrincipal - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment - -## RELATED LINKS - -[New-AzureRmADServicePrincipal](./New-AzureRmADServicePrincipal.md) - -[Get-AzureRmADServicePrincipal](./Get-AzureRmADServicePrincipal.md) - - -[Remove-AzureRmADApplication](./Remove-AzureRmADApplication.md) - -[Remove-AzureRmADAppCredential](./Remove-AzureRmADAppCredential.md) diff --git a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmADSpCredential.md b/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmADSpCredential.md deleted file mode 100644 index 3a87d569d7..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmADSpCredential.md +++ /dev/null @@ -1,254 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 04B1E3A6-6D52-46A3-8241-2CCDB5E71642 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermadspcredential -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmADSpCredential.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmADSpCredential.md ---- - -# Remove-AzureRmADSpCredential - -## SYNOPSIS -Removes a credential from a service principal. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ObjectIdWithKeyIdParameterSet (Default) -``` -Remove-AzureRmADSpCredential -ObjectId <Guid> [-KeyId <Guid>] [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SPNWithKeyIdParameterSet -``` -Remove-AzureRmADSpCredential -ServicePrincipalName <String> [-KeyId <Guid>] [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### DisplayNameWithKeyIdParameterSet -``` -Remove-AzureRmADSpCredential -DisplayName <String> [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ServicePrincipalObjectParameterSet -``` -Remove-AzureRmADSpCredential -ServicePrincipalObject <PSADServicePrincipal> [-KeyId <Guid>] [-PassThru] - [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmADSpCredential cmdlet can be used to remove a credential key from a service principal in the case of a compromise or as part of credential key rollover expiration. -The service principal is identified by supplying either the object ID or service principal name (SPN). -The credential to be removed is identified by its key ID if an individual credential is to be removed or with an 'All' switch to delete all credentials associated with the service principal. - -## EXAMPLES - -### Example 1 - Remove a specific credential from a service principal - -``` -PS C:\> Remove-AzureRmADSpCredential -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 -KeyId 9044423a-60a3-45ac-9ab1-09534157ebb -``` - -Removes the credential with key id '9044423a-60a3-45ac-9ab1-09534157ebb' from the service principal with object id '00001111-aaaa-2222-bbbb-3333cccc4444'. - -### Example 2 - Remove all credentials from a service principal - -``` -PS C:\> Remove-AzureRmADSpCredential -ServicePrincipalName http://test123 -``` - -Removes all credentials from the service principal with the SPN "http://test123". - -### Example 3 - Remove all credentials from a service principal using piping - -``` -PS C:\> Get-AzureRmADServicePrincipal -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 | Remove-AzureRmADSpCredential -``` - -Gets the service principal with object id '00001111-aaaa-2222-bbbb-3333cccc4444' and pipes that to the Remove-AzureRmADSpCredential cmdlet to remove all credentials from that service principal. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The display name of the service principal. - -```yaml -Type: System.String -Parameter Sets: DisplayNameWithKeyIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Switch to delete credential without a confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyId -Specifies the credential key to be removed. -The key Ids for a service principal can be obtained using the Get-AzureRmADSpCredential cmdlet. - -```yaml -Type: System.Guid -Parameter Sets: ObjectIdWithKeyIdParameterSet, SPNWithKeyIdParameterSet, ServicePrincipalObjectParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ObjectId -The object id of the service principal to remove the credentials from. - -```yaml -Type: System.Guid -Parameter Sets: ObjectIdWithKeyIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Specifying this will return true if the command was successful. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServicePrincipalName -The name (SPN) of the service principal to remove the credentials from. - -```yaml -Type: System.String -Parameter Sets: SPNWithKeyIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServicePrincipalObject -The service principal object to remove the credentials from. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADServicePrincipal -Parameter Sets: ServicePrincipalObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADServicePrincipal -Parameters: ServicePrincipalObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmADSpCredential](./Get-AzureRmADSpCredential.md) - -[New-AzureRmADSpCredential](./New-AzureRmADSpCredential.md) - -[Get-AzureRmADServicePrincipal](./Get-AzureRmADServicePrincipal.md) - diff --git a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmADUser.md b/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmADUser.md deleted file mode 100644 index c0df5c72ec..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmADUser.md +++ /dev/null @@ -1,256 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 9F9B2691-BB3F-4644-BD95-6D74777D1E99 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermaduser -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmADUser.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmADUser.md ---- - -# Remove-AzureRmADUser - -## SYNOPSIS -Deletes an active directory user. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### UPNOrObjectIdParameterSet (Default) -``` -Remove-AzureRmADUser -UPNOrObjectId <String> [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### UPNParameterSet -``` -Remove-AzureRmADUser -UserPrincipalName <String> [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ObjectIdParameterSet -``` -Remove-AzureRmADUser -ObjectId <Guid> [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### DisplayNameParameterSet -``` -Remove-AzureRmADUser -DisplayName <String> [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectParameterSet -``` -Remove-AzureRmADUser -InputObject <PSADUser> [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Deletes an active directory user (work/school account also popularly known as org-id). - -## EXAMPLES - -### Example 1 - Remove a user by user principal name - -``` -PS C:\> Remove-AzureRmADUser -UserPrincipalName foo@domain.com -``` - -Removes the user with user principal name "foo@domain.com" from the tenant. - -### Example 2 - Remove a user by object id - -``` -PS C:\> Remove-AzureRmADUser -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 -``` - -Removes the user with object id '00001111-aaaa-2222-bbbb-3333cccc4444' from the tenant. - -### Example 3 - Remove a user by piping - -``` -PS C:\> Get-AzureRmADUser -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 | Remove-AzureRmADUser -``` - -Gets the user with object id '00001111-aaaa-2222-bbbb-3333cccc4444' and pipes that to the Remove-AzureRmADUser cmdlet to remove the user from the tenant. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The display name of the user to be deleted. - -```yaml -Type: System.String -Parameter Sets: DisplayNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -If specified, doesn't ask for confirmation for deleting the user. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The user object to be deleted. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADUser -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ObjectId -The object id of the user to be deleted. - -```yaml -Type: System.Guid -Parameter Sets: ObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Specifying this will return true if the command was successful. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UPNOrObjectId -The user principal name or the objectId of the user to be deleted. - -```yaml -Type: System.String -Parameter Sets: UPNOrObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserPrincipalName -The user principal name of the user to be deleted. - -```yaml -Type: System.String -Parameter Sets: UPNParameterSet -Aliases: UPN - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Guid - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADUser -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[New-AzureRmADUser](./New-AzureRmADUser.md) - -[Get-AzureRmADUser](./Get-AzureRmADUser.md) - - diff --git a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmDeployment.md b/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmDeployment.md deleted file mode 100644 index 41bbf5ac30..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmDeployment.md +++ /dev/null @@ -1,224 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermdeployment -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmDeployment.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmDeployment.md ---- - -# Remove-AzureRmDeployment - -## SYNOPSIS -Removes a deployment and any associated operations - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RemoveByDeploymentName (Default) -``` -Remove-AzureRmDeployment [-Name] <String> [-AsJob] [-PassThru] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RemoveByDeploymentId -``` -Remove-AzureRmDeployment -Id <String> [-AsJob] [-PassThru] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RemoveByInputObject -``` -Remove-AzureRmDeployment -InputObject <PSDeployment> [-AsJob] [-PassThru] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmDeployment** cmdlet removes an Azure deployment at subscription scope and any associated operations. - -## EXAMPLES - -### Example 1: Remove a deployment with a given name -``` -PS C:\>Remove-AzureRmDeployment -Name "RolesDeployment" -``` - -This command removes the deployment "RolesDeployment" at the current subscription scope. - -### Example 2: Get a deployment and remove it -``` -PS C:\>Get-AzureRmDeployment -Name "RolesDeployment" | Remove-AzureRmDeployment -``` - -This command gets the deployment "RolesDeployment" at the current subscription scope and removes it. - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The fully qualified resource Id of the deployment. -example: /subscriptions/{subId}/providers/Microsoft.Resources/deployments/{deploymentName} - -```yaml -Type: String -Parameter Sets: RemoveByDeploymentId -Aliases: DeploymentId, ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The deployment object. - -```yaml -Type: PSDeployment -Parameter Sets: RemoveByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the deployment. - -```yaml -Type: String -Parameter Sets: RemoveByDeploymentName -Aliases: DeploymentName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmManagedApplication.md b/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmManagedApplication.md deleted file mode 100644 index 72fffffdd8..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmManagedApplication.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermmanagedapplication -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmManagedApplication.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmManagedApplication.md ---- - -# Remove-AzureRmManagedApplication - -## SYNOPSIS -Removes a managed application - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RemoveByNameAndResourceGroup (Default) -``` -Remove-AzureRmManagedApplication -Name <String> -ResourceGroupName <String> [-Force] [-ApiVersion <String>] - [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RemoveById -``` -Remove-AzureRmManagedApplication -Id <String> [-Force] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmManagedApplication** cmdlet removes a managed application - -## EXAMPLES - -### Example 1: Remove managed application by resource ID -``` -PS C:\>$Application = Get-AzureRmManagedApplication -Name "myApp" -ResourceGroupName "myRG" -PS C:\>Remove-AzureRmManagedApplication -Id $Application.ResourceId -Force -``` - -The first command gets a managed application named myApp by using the Get-AzureRmManagedApplication cmdlet. -The command stores it in the $Application variable. -The second command removes the managed application identified by the **ResourceId** property of $Application. - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The fully qualified managed application Id, including the subscription. -e.g. -/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName} - -```yaml -Type: System.String -Parameter Sets: RemoveById -Aliases: ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The managed application name. - -```yaml -Type: System.String -Parameter Sets: RemoveByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: RemoveByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmManagedApplicationDefinition.md b/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmManagedApplicationDefinition.md deleted file mode 100644 index dc3f6e928c..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmManagedApplicationDefinition.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermmanagedapplicationdefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmManagedApplicationDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmManagedApplicationDefinition.md ---- - -# Remove-AzureRmManagedApplicationDefinition - -## SYNOPSIS -Removes a managed application definition - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RemoveByNameAndResourceGroup (Default) -``` -Remove-AzureRmManagedApplicationDefinition -Name <String> -ResourceGroupName <String> [-Force] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### RemoveById -``` -Remove-AzureRmManagedApplicationDefinition -Id <String> [-Force] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmManagedApplicationDefinition** cmdlet removes a managed application definition - -## EXAMPLES - -### Example 1: Remove managed application definition by resource ID -``` -PS C:\>$ApplicationDefinition = Get-AzureRmManagedApplicationDefinition -Name "myAppDef" -ResourceGroupName "myRG" -PS C:\>Remove-AzureRmManagedApplicationDefinition -Id $ApplicationDefinition.ResourceId -Force -``` - -The first command gets a managed application definition named myAppDef by using the Get-AzureRmManagedApplicationDefinition cmdlet. -The command stores it in the $ApplicationDefinition variable. -The second command removes the managed application definition identified by the **ResourceId** property of $ApplicationDefinition. - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The fully qualified managed application definition Id, including the subscription. -e.g. -/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName} - -```yaml -Type: System.String -Parameter Sets: RemoveById -Aliases: ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The managed application definition name. - -```yaml -Type: System.String -Parameter Sets: RemoveByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: RemoveByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmManagementGroup.md b/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmManagementGroup.md deleted file mode 100644 index df6897fbc4..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmManagementGroup.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermmanagementgroup/ -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmManagementGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmManagementGroup.md ---- - -# Remove-AzureRmManagementGroup - -## SYNOPSIS -Removes a Management Group - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GroupOperations (Default) -``` -Remove-AzureRmManagementGroup [-GroupName] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ManagementGroupObject -``` -Remove-AzureRmManagementGroup -InputObject <PSManagementGroup> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmManagementGroup** cmdlet deletes a Management Group. - -## EXAMPLES - -### Example 1 - Remove a Management Group -``` -PS C:\> Remove-AzureRmManagementGroup -GroupName "TestGroup" -``` - -### Example 2 - Remove a Management Group by piping PSManagementGroup Object -``` -PS C:\> Get-Remove-AzureRmManagementGroup -GroupName "TestGroup" | Remove-AzureRmManagementGroup -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupName -Management Group Id - -```yaml -Type: System.String -Parameter Sets: GroupOperations -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Input Object from the Get call - -```yaml -Type: Microsoft.Azure.Commands.Resources.Models.ManagementGroups.PSManagementGroup -Parameter Sets: ManagementGroupObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Return `true` on successful execution - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Resources.Models.ManagementGroups.PSManagementGroup -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmManagementGroupSubscription.md b/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmManagementGroupSubscription.md deleted file mode 100644 index c3ddbb7c1a..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmManagementGroupSubscription.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermmanagementgroupsubscription/ -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmManagementGroupSubscription.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmManagementGroupSubscription.md ---- - -# Remove-AzureRmManagementGroupSubscription - -## SYNOPSIS -Removes a Subscription from a Management Group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmManagementGroupSubscription [-GroupName] <String> [-SubscriptionId] <Guid> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmManagementGroupSubscription** cmdlet removes a Subscription from a Management Group. - -## EXAMPLES - -### Example 1 - Remove Subscription from a Management Group -``` -PS C:\> Remove-AzureRmManagementGroupSubscription -GroupName "TestGroup" -SubscriptionId 2120692d-35c3-44c8-81f5-631fa7351726 -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupName -Management Group Id - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Return `true` on successful execution - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Subscription Id of the subscription associated witht the management - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmPolicyAssignment.md b/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmPolicyAssignment.md deleted file mode 100644 index d7a32cd91c..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmPolicyAssignment.md +++ /dev/null @@ -1,240 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 36399302-3EA5-45A3-A042-536CC7EC2E6D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermpolicyassignment -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmPolicyAssignment.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmPolicyAssignment.md ---- - -# Remove-AzureRmPolicyAssignment - -## SYNOPSIS -Removes a policy assignment. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameParameterSet (Default) -``` -Remove-AzureRmPolicyAssignment -Name <String> -Scope <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### IdParameterSet -``` -Remove-AzureRmPolicyAssignment -Id <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmPolicyAssignment** cmdlet removes the specified policy assignment. - -## EXAMPLES - -### Example 1: Remove policy assignment by name and scope -``` -PS C:\> $ResourceGroup = Get-AzureRmResourceGroup -Name 'ResourceGroup11' -PS C:\> Remove-AzureRmPolicyAssignment -Name 'PolicyAssignment07' -Scope $ResourceGroup.ResourceId -Force -``` - -The first command gets a resource group named ResourceGroup11 by using the Get-AzureRMResourceGroup cmdlet. -The command stores that object in the $ResourceGroup variable. -The second command removes the policy assignment named PolicyAssignment07 that was assigned at a resource group level. -The **ResourceId** property of $ResourceGroup identifies the resource group. - -### Example 2: Remove policy assignment by ID -``` -PS C:\> $ResourceGroup = Get-AzureRmResourceGroup -Name 'ResourceGroup11' -PS C:\> $PolicyAssignment = Get-AzureRmPolicyAssignment -Name 'PolicyAssignment07' -Scope $ResourceGroup.ResourceId -PS C:\> Remove-AzureRmPolicyAssignment -Id $PolicyAssignment.ResourceId -Force -``` - -The first command gets a resource group named ResourceGroup11, and then stores that object in the $ResourceGroup variable. -The second command gets the policy assignment at a resource group level, and then stores it in the $PolicyAssignment variable. -The **ResourceId** property of $ResourceGroup identifies the resource group. -The final command removes the policy assignment that the **ResourceId** property of $PolicyAssignment identifies. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. -If you do not specify a version, this cmdlet uses the latest available version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the fully qualified resource ID for the policy assignment that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: IdParameterSet -Aliases: ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InformationAction -Specifies how this cmdlet responds to an information event. -The acceptable values for this parameter are: -- Continue -- Ignore -- Inquire -- SilentlyContinue -- Stop -- Suspend - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: infa - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationVariable -Specifies an information variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: iv - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the policy assignment that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Specifies the scope at which the policy is applied. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmPolicyAssignment](./Get-AzureRmPolicyAssignment.md) - -[New-AzureRmPolicyAssignment](./New-AzureRmPolicyAssignment.md) - -[Set-AzureRmPolicyAssignment](./Set-AzureRmPolicyAssignment.md) - - diff --git a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmPolicyDefinition.md b/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmPolicyDefinition.md deleted file mode 100644 index 0058c8bba7..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmPolicyDefinition.md +++ /dev/null @@ -1,290 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: DEC01722-EB1A-45CE-BD30-9DB861718573 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermpolicydefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmPolicyDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmPolicyDefinition.md ---- - -# Remove-AzureRmPolicyDefinition - -## SYNOPSIS -Removes a policy definition. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameParameterSet (Default) -``` -Remove-AzureRmPolicyDefinition -Name <String> [-Force] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ManagementGroupNameParameterSet -``` -Remove-AzureRmPolicyDefinition -Name <String> [-Force] -ManagementGroupName <String> [-ApiVersion <String>] - [-Pre] [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SubscriptionIdParameterSet -``` -Remove-AzureRmPolicyDefinition -Name <String> [-Force] -SubscriptionId <Guid> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### IdParameterSet -``` -Remove-AzureRmPolicyDefinition -Id <String> [-Force] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmPolicyDefinition** cmdlet removes a policy definition. - -## EXAMPLES - -### Example 1: Remove the policy definition by name -``` -PS C:\> Remove-AzureRmPolicyDefinition -Name 'VMPolicyDefinition' -``` - -This command removes the specified policy definition. - -### Example 2: Remove policy definition by resource ID -``` -PS C:\> $PolicyDefinition = Get-AzureRmPolicyDefinition -Name 'VMPolicyDefinition' -PS C:\> Remove-AzureRmPolicyDefinition -Id $PolicyDefinition.ResourceId -Force -``` - -The first command gets a policy definition named VMPolicyDefinition by using the Get-AzureRmPolicyDefinition cmdlet. -The command stores it in the $PolicyDefinition variable. -The second command removes the policy definition identified by the **ResourceId** property of $PolicyDefinition. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. -If you do not specify a version, this cmdlet uses the latest available version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the fully qualified resource ID for the policy definition that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: IdParameterSet -Aliases: ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InformationAction -Specifies how this cmdlet responds to an information event. -The acceptable values for this parameter are: -- Continue -- Ignore -- Inquire -- SilentlyContinue -- Stop -- Suspend - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: infa - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationVariable -Specifies an information variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: iv - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagementGroupName -The name of the management group of the policy definition to delete. - -```yaml -Type: System.String -Parameter Sets: ManagementGroupNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the policy definition that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ManagementGroupNameParameterSet, SubscriptionIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The subscription ID of the policy definition to delete. - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: SubscriptionIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmPolicyDefinition](./Get-AzureRmPolicyDefinition.md) - -[New-AzureRmPolicyDefinition](./New-AzureRmPolicyDefinition.md) - -[Set-AzureRmPolicyDefinition](./Set-AzureRmPolicyDefinition.md) - - diff --git a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmPolicySetDefinition.md b/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmPolicySetDefinition.md deleted file mode 100644 index 451d358a1b..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmPolicySetDefinition.md +++ /dev/null @@ -1,242 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermpolicysetdefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmPolicySetDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmPolicySetDefinition.md ---- - -# Remove-AzureRmPolicySetDefinition - -## SYNOPSIS -Removes a policy set definition. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameParameterSet (Default) -``` -Remove-AzureRmPolicySetDefinition -Name <String> [-Force] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ManagementGroupNameParameterSet -``` -Remove-AzureRmPolicySetDefinition [-Name <String>] [-Force] -ManagementGroupName <String> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### SubscriptionIdParameterSet -``` -Remove-AzureRmPolicySetDefinition [-Name <String>] [-Force] -SubscriptionId <Guid> [-ApiVersion <String>] - [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### IdParameterSet -``` -Remove-AzureRmPolicySetDefinition -Id <String> [-Force] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmPolicySetDefinition** cmdlet removes a policy definition. - -## EXAMPLES - -### Example 1: Remove policy set definition by resource ID -``` -PS C:\> $PolicySetDefinition = Get-AzureRmPolicySetDefinition -ResourceId '/subscriptions/mySub/Microsoft.Authorization/policySetDefinitions/myPSSetDefinition' -PS C:\> Remove-AzureRmPolicySetDefinition -Id $PolicySetDefinition.ResourceId -Force -``` - -The first command gets a policy set definition by using the Get-AzureRmPolicySetDefinition cmdlet. -The command stores it in the $PolicySetDefinition variable. -The second command removes the policy set definition identified by the **ResourceId** property of $PolicySetDefinition. - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The fully qualified policy set definition Id, including the subscription. -e.g. -/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName} - -```yaml -Type: System.String -Parameter Sets: IdParameterSet -Aliases: ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ManagementGroupName -The name of the management group of the policy set definition to delete. - -```yaml -Type: System.String -Parameter Sets: ManagementGroupNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The policy set definition name. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ManagementGroupNameParameterSet, SubscriptionIdParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The subscription ID of the policy set definition to delete. - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: SubscriptionIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmResource.md b/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmResource.md deleted file mode 100644 index 1287d5fa81..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmResource.md +++ /dev/null @@ -1,321 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: A262DFD1-8B90-462C-A4E2-ABA0F51173FA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermresource -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmResource.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmResource.md ---- - -# Remove-AzureRmResource - -## SYNOPSIS -Removes a resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByResourceId (Default) -``` -Remove-AzureRmResource [-AsJob] -ResourceId <String> [-ODataQuery <String>] [-Force] [-ApiVersion <String>] - [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### BySubscriptionLevel -``` -Remove-AzureRmResource [-AsJob] -ResourceName <String> -ResourceType <String> [-ExtensionResourceName <String>] - [-ExtensionResourceType <String>] [-ODataQuery <String>] [-ResourceGroupName <String>] [-Force] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByTenantLevel -``` -Remove-AzureRmResource [-AsJob] -ResourceName <String> -ResourceType <String> [-ExtensionResourceName <String>] - [-ExtensionResourceType <String>] [-ODataQuery <String>] [-TenantLevel] [-Force] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmResource** cmdlet removes an Azure resource. - -## EXAMPLES - -### Example 1: Remove a website resource -``` -PS C:\>Remove-AzureRmResource -ResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup11/providers/Microsoft.Web/sites/ContosoSite" -Force -``` - -This command removes the website resource named ContosoSite. -The example uses a placeholder value for the subscription ID. -The command specifies the *Force* parameter. -Therefore, it does not prompt you for confirmation. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. -If you do not specify a version, this cmdlet uses the latest available version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionResourceName -Specifies the name of an extension resource of the resource that this cmdlet removes. -For instance, to specify a database, use the following format: -server name`/`database name - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExtensionResourceType -Specifies the resource type for an extension resource. -Specifies the extension resource type for the resource. -For instance: -`Microsoft.Sql/Servers/Databases` - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ODataQuery -Specifies an Open Data Protocol (OData) style filter. -This cmdlet appends this value to the request in addition to any other filters. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group from which this cmdlet removes a resource. - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Specifies the fully qualified resource ID of the resource that this cmdlet removes. -The ID includes the subscription, as in the following example: -`/subscriptions/`subscription ID`/providers/Microsoft.Sql/servers/ContosoServer/databases/ContosoDatabase` - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceName -Specifies the name of the resource that this cmdlet removes. -For instance, to specify a database, use the following format: -`ContosoServer/ContosoDatabase` - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel, ByTenantLevel -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceType -Specifies the type of the resource that this cmdlet removes. -For instance, for a database, the resource type is as follows: -`Microsoft.Sql/Servers/Databases` - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TenantLevel -Indicates that this cmdlet operates at the tenant level. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - - -[Get-AzureRmResource](./Get-AzureRmResource.md) - -[Move-AzureRmResource](./Move-AzureRmResource.md) - -[New-AzureRmResource](./New-AzureRmResource.md) - -[Set-AzureRmResource](./Set-AzureRmResource.md) - - diff --git a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmResourceGroup.md b/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmResourceGroup.md deleted file mode 100644 index aa86d7dea0..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmResourceGroup.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 880D321E-30F2-4CAE-B14A-5F6DD8E1DB99 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermresourcegroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmResourceGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmResourceGroup.md ---- - -# Remove-AzureRmResourceGroup - -## SYNOPSIS -Removes a resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RemoveByResourceGroupName (Default) -``` -Remove-AzureRmResourceGroup [-Name] <String> [-Force] [-AsJob] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RemoveByResourceGroupId -``` -Remove-AzureRmResourceGroup [-Id] <String> [-Force] [-AsJob] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmResourceGroup** cmdlet removes an Azure resource group and its resources from the current subscription. -To delete a resource, but leave the resource group, use the Remove-AzureRmResource cmdlet. - -## EXAMPLES - -### Example 1: Remove a resource group -``` -PS C:\>Remove-AzureRmResourceGroup -Name "ContosoRG01" -``` - -This command removes the ContosoRG01 resource group from the subscription. -The cmdlet prompts you for confirmation and returns no output. - -### Example 2: Remove a resource group without confirmation -``` -PS C:\>Get-AzureRmResourceGroup -Name "ContosoRG01" | Remove-AzureRmResourceGroup -Verbose -Force -``` - -This command uses the Get-AzureRmResourceGroup cmdlet to get the resource group ContosoRG01, and then passes it to **Remove-AzureRmResourceGroup** by using the pipeline operator. -The *Verbose* common parameter gets status information about the operation, and the *Force* parameter suppresses the confirmation prompt. - -### Example 3: Remove all resource groups -``` -PS C:\>Get-AzureRmResourceGroup | Remove-AzureRmResourceGroup -``` - -This command uses the **Get-AzureRmResourceGroup** cmdlet to get all resource groups, and then passes them to **Remove-AzureRmResourceGroup** by using the pipeline operator. - -## PARAMETERS - -### -ApiVersion -Specifies the API version that is supported by the resource Provider. -You can specify a different version than the default version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of resource group to remove. -Wildcard characters are not permitted. - -```yaml -Type: System.String -Parameter Sets: RemoveByResourceGroupId -Aliases: ResourceGroupId, ResourceId - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the names of resource groups to remove. -Wildcard characters are not permitted. - -```yaml -Type: System.String -Parameter Sets: RemoveByResourceGroupName -Aliases: ResourceGroupName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmResourceGroup](./Get-AzureRmResourceGroup.md) - -[New-AzureRmResourceGroup](./New-AzureRmResourceGroup.md) - -[Set-AzureRmResourceGroup](./Set-AzureRmResourceGroup.md) - - diff --git a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmResourceGroupDeployment.md b/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmResourceGroupDeployment.md deleted file mode 100644 index 2e3a3bf508..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmResourceGroupDeployment.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: C3DD193E-B8FE-468D-BEE7-00C3D99B469E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermresourcegroupdeployment -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmResourceGroupDeployment.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmResourceGroupDeployment.md ---- - -# Remove-AzureRmResourceGroupDeployment - -## SYNOPSIS -Removes a resource group deployment and any associated operations. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RemoveByResourceGroupName (Default) -``` -Remove-AzureRmResourceGroupDeployment -ResourceGroupName <String> -Name <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RemoveByResourceGroupDeploymentId -``` -Remove-AzureRmResourceGroupDeployment -Id <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmResourceGroupDeployment** cmdlet removes an Azure resource group deployment and any associated operations. - -## EXAMPLES - -## PARAMETERS - -### -ApiVersion -Specifies the API version that is supported by the resource Provider. -You can specify a different version than the default version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the resource group deployment to remove. - -```yaml -Type: System.String -Parameter Sets: RemoveByResourceGroupDeploymentId -Aliases: DeploymentId, ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the resource group deployment to remove. - -```yaml -Type: System.String -Parameter Sets: RemoveByResourceGroupName -Aliases: DeploymentName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to remove. - -```yaml -Type: System.String -Parameter Sets: RemoveByResourceGroupName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmResourceGroupDeployment](./Get-AzureRmResourceGroupDeployment.md) - -[New-AzureRmResourceGroupDeployment](./New-AzureRmResourceGroupDeployment.md) - -[Stop-AzureRmResourceGroupDeployment](./Stop-AzureRmResourceGroupDeployment.md) - -[Test-AzureRmResourceGroupDeployment](./Test-AzureRmResourceGroupDeployment.md) - - diff --git a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmResourceLock.md b/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmResourceLock.md deleted file mode 100644 index a1f378336a..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmResourceLock.md +++ /dev/null @@ -1,339 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 42EEAAA8-F13B-486B-82BD-F646EF0DCDBA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermresourcelock -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmResourceLock.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmResourceLock.md ---- - -# Remove-AzureRmResourceLock - -## SYNOPSIS -Removes a resource lock. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByLockId (Default) -``` -Remove-AzureRmResourceLock [-Force] -LockId <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceGroup -``` -Remove-AzureRmResourceLock -LockName <String> [-Force] -ResourceGroupName <String> [-ApiVersion <String>] - [-Pre] [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceGroupLevel -``` -Remove-AzureRmResourceLock -LockName <String> [-Force] -ResourceName <String> -ResourceType <String> - -ResourceGroupName <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### BySpecifiedScope -``` -Remove-AzureRmResourceLock -LockName <String> [-Force] -Scope <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### BySubscription -``` -Remove-AzureRmResourceLock -LockName <String> [-Force] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### BySubscriptionLevel -``` -Remove-AzureRmResourceLock -LockName <String> [-Force] -ResourceName <String> -ResourceType <String> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByTenantLevel -``` -Remove-AzureRmResourceLock -LockName <String> [-Force] -ResourceName <String> -ResourceType <String> - [-TenantLevel] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmResourceLock** cmdlet removes an Azure resource lock. - -## EXAMPLES - -### Example 1: Remove a lock -``` -PS C:\>Remove-AzureRmResourceLock -LockName "ContosoSiteLock" -ResourceName "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Storage-SouthCentralUS/providers/Microsoft.ClassicStorage/storageAccounts/mystorageaccount/providers/Microsoft.Authorization/locks/test" -``` - -This command removes the lock named ContosoSiteLock. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. -If you do not specify a version, this cmdlet uses the latest available version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationAction -Specifies how this cmdlet responds to an information event. -The acceptable values for this parameter are: -- Continue -- Ignore -- Inquire -- SilentlyContinue -- Stop -- Suspend - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: infa - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationVariable -Specifies an information variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: iv - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LockId -Specifies the ID of the lock that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: ByLockId -Aliases: Id, ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LockName -Specifies the name of the lock that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: ByResourceGroup, ByResourceGroupLevel, BySpecifiedScope, BySubscription, BySubscriptionLevel, ByTenantLevel -Aliases: ExtensionResourceName, Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for which the lock applies. - -```yaml -Type: System.String -Parameter Sets: ByResourceGroup, ByResourceGroupLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceName -Specifies the name of the resource for which the lock applies. -For instance, to specify a database, use the following format: -Server`/`Database - -```yaml -Type: System.String -Parameter Sets: ByResourceGroupLevel, BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceType -Specifies the resource type of the resource for which the lock applies. - -```yaml -Type: System.String -Parameter Sets: ByResourceGroupLevel, BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Scope -Specifies the scope to which the lock applies. - -```yaml -Type: System.String -Parameter Sets: BySpecifiedScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TenantLevel -Indicates that this cmdlet operates at the tenant level. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmResourceLock](./Get-AzureRmResourceLock.md) - -[New-AzureRmResourceLock](./New-AzureRmResourceLock.md) - -[Set-AzureRmResourceLock](./Set-AzureRmResourceLock.md) - - diff --git a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmRoleAssignment.md b/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmRoleAssignment.md deleted file mode 100644 index df9d5d9495..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmRoleAssignment.md +++ /dev/null @@ -1,402 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 8C1D738C-825D-4718-AD2A-9CFEAA7DBD3B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermroleassignment -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmRoleAssignment.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmRoleAssignment.md ---- - -# Remove-AzureRmRoleAssignment - -## SYNOPSIS -Removes a role assignment to the specified principal who is assigned to a particular role at a particular scope. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### EmptyParameterSet (Default) -``` -Remove-AzureRmRoleAssignment -ObjectId <Guid> [-Scope <String>] -RoleDefinitionName <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceWithObjectIdParameterSet -``` -Remove-AzureRmRoleAssignment -ObjectId <Guid> -ResourceGroupName <String> -ResourceName <String> - -ResourceType <String> [-ParentResource <String>] -RoleDefinitionName <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceGroupWithObjectIdParameterSet -``` -Remove-AzureRmRoleAssignment -ObjectId <Guid> -ResourceGroupName <String> -RoleDefinitionName <String> - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ScopeWithObjectIdParameterSet -``` -Remove-AzureRmRoleAssignment -ObjectId <Guid> [-Scope <String>] -RoleDefinitionName <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RoleIdWithScopeAndObjectIdParameterSet -``` -Remove-AzureRmRoleAssignment -ObjectId <Guid> [-Scope <String>] -RoleDefinitionId <Guid> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceWithSignInNameParameterSet -``` -Remove-AzureRmRoleAssignment -SignInName <String> -ResourceGroupName <String> -ResourceName <String> - -ResourceType <String> [-ParentResource <String>] -RoleDefinitionName <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceGroupWithSignInNameParameterSet -``` -Remove-AzureRmRoleAssignment -SignInName <String> -ResourceGroupName <String> -RoleDefinitionName <String> - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ScopeWithSignInNameParameterSet -``` -Remove-AzureRmRoleAssignment -SignInName <String> [-Scope <String>] -RoleDefinitionName <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceWithSPNParameterSet -``` -Remove-AzureRmRoleAssignment -ServicePrincipalName <String> -ResourceGroupName <String> -ResourceName <String> - -ResourceType <String> [-ParentResource <String>] -RoleDefinitionName <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceGroupWithSPNParameterSet -``` -Remove-AzureRmRoleAssignment -ServicePrincipalName <String> -ResourceGroupName <String> - -RoleDefinitionName <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ScopeWithSPNParameterSet -``` -Remove-AzureRmRoleAssignment -ServicePrincipalName <String> [-Scope <String>] -RoleDefinitionName <String> - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RoleAssignmentParameterSet -``` -Remove-AzureRmRoleAssignment [-PassThru] [-InputObject] <PSRoleAssignment> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Remove-AzureRmRoleAssignment commandlet to revoke access to any principal at given scope and given role. -The object of the assignment i.e. -the principal MUST be specified. -The principal can be a user (use SignInName or ObjectId parameters to identify a user), security group (use ObjectId parameter to identify a group) or service principal (use ServicePrincipalName or ObjectId parameters to identify a ServicePrincipal. -The role that the principal is assigned to MUST be specified using the RoleDefinitionName parameter. -The scope of the assignment MAY be specified and if not specified, defaults to the subscription scope i.e. -it will try to delete an assignment to the specified principal and role at the subscription scope. -The scope of the assignment can be specified using one of the following parameters. - a. -Scope - This is the fully qualified scope starting with /subscriptions/\<subscriptionId\> - b. -ResourceGroupName - Name of any resource group under the subscription. - c. -ResourceName, ResourceType, ResourceGroupName and (optionally) ParentResource - Identifies a particular resource under the subscription. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmRoleAssignment -ResourceGroupName rg1 -SignInName john.doe@contoso.com -RoleDefinitionName Reader -``` - -Removes a role assignment for john.doe@contoso.com who is assigned to the Reader role at the rg1 resourcegroup scope. - -### Example 2 -``` -PS C:\> Remove-AzureRmRoleAssignment -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 -RoleDefinitionName Reader -``` - -Removes the role assignment to the group principal identified by the ObjectId and assigned to the Reader role. -Defaults to using the current subscription as the scope to find the assignment to be deleted. - -### Example 3 -``` -PS C:\> $roleassignment = Get-AzureRmRoleAssignment |Select-Object -First 1 -Wait -PS C:\> Remove-AzureRmRoleAssignment -InputObject $roleassignment -``` - -Removes the first role assignment object which is fetched from the Get-AzureRmRoleAssignment commandlet. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Role Assignment object. - -```yaml -Type: Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleAssignment -Parameter Sets: RoleAssignmentParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ObjectId -Microsoft Entra ObjectId of the user, group or service principal. - -```yaml -Type: System.Guid -Parameter Sets: EmptyParameterSet, ResourceWithObjectIdParameterSet, ResourceGroupWithObjectIdParameterSet, ScopeWithObjectIdParameterSet, RoleIdWithScopeAndObjectIdParameterSet -Aliases: Id, PrincipalId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ParentResource -The parent resource in the hierarchy(of the resource specified using ResourceName parameter), if any. -Must be used in conjunction with ResourceGroupName, ResourceType and ResourceName parameters to construct a hierarchical scope in the form of a relative URI that identifies the resource. - -```yaml -Type: System.String -Parameter Sets: ResourceWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceWithSPNParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -If specified, displays the deleted role assignment - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name that the role is assigned to. -Attempts to delete an assignment at the specified resource group scope. -When used in conjunction with ResourceName, ResourceType and (optionally)ParentResource parameters, the command constructs a hierarchical scope in the form of a relative URI that identifies a resource. - -```yaml -Type: System.String -Parameter Sets: ResourceWithObjectIdParameterSet, ResourceGroupWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceGroupWithSignInNameParameterSet, ResourceWithSPNParameterSet, ResourceGroupWithSPNParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceName -The resource name. -For e.g. -storageaccountprod. -Must be used in conjunction with ResourceGroupName, ResourceType and (optionally)ParentResource parameters, to construct a hierarchical scope in the form of a relative URI that identifies the resource and delete an assignment at that scope. - -```yaml -Type: System.String -Parameter Sets: ResourceWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceWithSPNParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceType -The resource type. -For e.g. -Microsoft.Network/virtualNetworks. -Must be used in conjunction with ResourceGroupName, ResourceName and (optionally)ParentResource parameters to construct a hierarchical scope in the form of a relative URI that identifies the resource and delete an assignment at that resource scope. - -```yaml -Type: System.String -Parameter Sets: ResourceWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceWithSPNParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RoleDefinitionId -Id of the RBAC role for which the assignment needs to be deleted. - -```yaml -Type: System.Guid -Parameter Sets: RoleIdWithScopeAndObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RoleDefinitionName -Name of the RBAC role for which the assignment needs to be deleted i.e. -Reader, Contributor, Virtual Network Administrator, etc. - -```yaml -Type: System.String -Parameter Sets: EmptyParameterSet, ResourceWithObjectIdParameterSet, ResourceGroupWithObjectIdParameterSet, ScopeWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceGroupWithSignInNameParameterSet, ScopeWithSignInNameParameterSet, ResourceWithSPNParameterSet, ResourceGroupWithSPNParameterSet, ScopeWithSPNParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Scope -The Scope of the role assignment to be deleted. -In the format of relative URI. -For e.g. -"/subscriptions/9004a9fd-d58e-48dc-aeb2-4a4aec58606f/resourceGroups/TestRG". -If not specified, will attempt to delete the role at subscription level. -If specified, it should start with "/subscriptions/{id}". - -```yaml -Type: System.String -Parameter Sets: EmptyParameterSet, ScopeWithObjectIdParameterSet, RoleIdWithScopeAndObjectIdParameterSet, ScopeWithSignInNameParameterSet, ScopeWithSPNParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServicePrincipalName -The ServicePrincipalName of the Microsoft Entra application - -```yaml -Type: System.String -Parameter Sets: ResourceWithSPNParameterSet, ResourceGroupWithSPNParameterSet, ScopeWithSPNParameterSet -Aliases: SPN - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SignInName -The email address or the user principal name of the user. - -```yaml -Type: System.String -Parameter Sets: ResourceWithSignInNameParameterSet, ResourceGroupWithSignInNameParameterSet, ScopeWithSignInNameParameterSet -Aliases: Email, UserPrincipalName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -### Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleAssignment -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleAssignment - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment - -## RELATED LINKS - -[New-AzureRmRoleAssignment](./New-AzureRmRoleAssignment.md) - -[Get-AzureRmRoleAssignment](./Get-AzureRmRoleAssignment.md) - -[Get-AzureRmRoleDefinition](./Get-AzureRmRoleDefinition.md) diff --git a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmRoleDefinition.md b/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmRoleDefinition.md deleted file mode 100644 index 4a7bcd6033..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Remove-AzureRmRoleDefinition.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 2D882B33-2B62-4785-AF8F-5F4644E9504D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermroledefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmRoleDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmRoleDefinition.md ---- - -# Remove-AzureRmRoleDefinition - -## SYNOPSIS -Deletes a custom role in Azure RBAC. -The role to be deleted is specified using the Id property of the role. -Delete will fail if there are existing role assignments made to the custom role. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RoleDefinitionIdParameterSet (Default) -``` -Remove-AzureRmRoleDefinition -Id <Guid> [-Scope <String>] [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RoleDefinitionNameParameterSet -``` -Remove-AzureRmRoleDefinition [-Name] <String> [-Scope <String>] [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectParameterSet -``` -Remove-AzureRmRoleDefinition -InputObject <PSRoleDefinition> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmRoleDefinition cmdlet deletes a custom role in Azure Role-Based Access Control. - Provide the Id parameter of an existing custom role to delete that custom role. -By default, Remove-AzureRmRoleDefinition prompts you for confirmation. -To suppress the prompt, use the Force parameter. -If there are existing role assignments made to the custom role to be deleted, the delete will fail. - -## EXAMPLES - -### Example 1 -``` -Get-AzureRmRoleDefinition -Name "Virtual Machine Operator" | Remove-AzureRmRoleDefinition -``` - -### Example 2 -``` -Remove-AzureRmRoleDefinition -Id "00001111-aaaa-2222-bbbb-3333cccc4444" -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -If set, does not prompt for a confirmation before deleting the custom role - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Id of the Role definition to be deleted - -```yaml -Type: System.Guid -Parameter Sets: RoleDefinitionIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -The object representing the role definition to be removed. - -```yaml -Type: Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the Role definition to be deleted. - -```yaml -Type: System.String -Parameter Sets: RoleDefinitionNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Role definition scope. - -```yaml -Type: System.String -Parameter Sets: RoleDefinitionIdParameterSet, RoleDefinitionNameParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -### Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment - -## RELATED LINKS - -[New-AzureRmRoleDefinition](./New-AzureRmRoleDefinition.md) - -[Get-AzureRmRoleDefinition](./Get-AzureRmRoleDefinition.md) - -[Set-AzureRmRoleDefinition](./Set-AzureRmRoleDefinition.md) - diff --git a/azurermps-6.13.0/AzureRM.Resources/Save-AzureRmDeploymentTemplate.md b/azurermps-6.13.0/AzureRM.Resources/Save-AzureRmDeploymentTemplate.md deleted file mode 100644 index 5816a0f4c1..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Save-AzureRmDeploymentTemplate.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/save-azurermdeploymenttemplate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Save-AzureRmDeploymentTemplate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Save-AzureRmDeploymentTemplate.md ---- - -# Save-AzureRmDeploymentTemplate - -## SYNOPSIS -Saves a deployment template to a file. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SaveByDeploymentName (Default) -``` -Save-AzureRmDeploymentTemplate -DeploymentName <String> [-Path <String>] [-Force] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SaveByDeploymentObject -``` -Save-AzureRmDeploymentTemplate -DeploymentObject <PSDeployment> [-Path <String>] [-Force] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Save-AzureRmDeploymentTemplate** cmdlet saves a deployment template to a JSON file. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Save-AzureRmDeploymentTemplate -DeploymentName "TestDeployment" -``` - -This command gets the deployment template from TestDeployment and saves it as a JSON file in the current directory. - -### Example 2: Get a deployment and save its template -``` -PS C:\>Get-AzureRmDeployment -Name "RolesDeployment" | Save-AzureRmDeploymentTemplate -``` - -This command gets the deployment "RolesDeployment" at the current subscription scope and saves its template. - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeploymentName -The deployment name. - -```yaml -Type: String -Parameter Sets: SaveByDeploymentName -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeploymentObject -The deployment object. - -```yaml -Type: PSDeployment -Parameter Sets: SaveByDeploymentObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -The output path of the template file. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/Save-AzureRmResourceGroupDeploymentTemplate.md b/azurermps-6.13.0/AzureRM.Resources/Save-AzureRmResourceGroupDeploymentTemplate.md deleted file mode 100644 index 116e08800f..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Save-AzureRmResourceGroupDeploymentTemplate.md +++ /dev/null @@ -1,224 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 8BB4AD6B-EBE3-442A-83E7-B77A31573208 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/save-azurermresourcegroupdeploymenttemplate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Save-AzureRmResourceGroupDeploymentTemplate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Save-AzureRmResourceGroupDeploymentTemplate.md ---- - -# Save-AzureRmResourceGroupDeploymentTemplate - -## SYNOPSIS -Saves a resource group deployment template to a file. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Save-AzureRmResourceGroupDeploymentTemplate -ResourceGroupName <String> -DeploymentName <String> - [-Path <String>] [-Force] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Save-AzureRmResourceGroupDeploymentTemplate** cmdlet saves a resource group deployment template to a JSON file. - -## EXAMPLES - -### Example 1: Save a deployment template -``` -PS C:\>Save-AzureRmResourceGroupDeploymentTemplate -DeploymentName "TestDeployment" -ResourceGroupName "TestGroup" -``` - -This command gets the deployment template from TestDeployment and saves it as a JSON file in the current directory. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. -If not specified, the latest API version is used. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeploymentName -Specifies the name of the deployment. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationAction -Specifies how this cmdlet responds to an information event. -The acceptable values for this parameter are: -- Continue -- Ignore -- Inquire -- SilentlyContinue -- Stop -- Suspend - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: infa - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationVariable -Specifies an information variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: iv - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the output path of the template file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet use pre-release API versions when automatically determining which API version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/Set-AzureRmManagedApplication.md b/azurermps-6.13.0/AzureRM.Resources/Set-AzureRmManagedApplication.md deleted file mode 100644 index 77556faf48..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Set-AzureRmManagedApplication.md +++ /dev/null @@ -1,278 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/set-azurermmanagedapplication -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmManagedApplication.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmManagedApplication.md ---- - -# Set-AzureRmManagedApplication - -## SYNOPSIS -Updates managed application - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByNameAndResourceGroup (Default) -``` -Set-AzureRmManagedApplication -Name <String> -ResourceGroupName <String> [-ManagedResourceGroupName <String>] - [-ManagedApplicationDefinitionId <String>] [-Parameter <String>] [-Kind <String>] [-Plan <Hashtable>] - [-Tag <Hashtable>] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### SetById -``` -Set-AzureRmManagedApplication -Id <String> [-ManagedResourceGroupName <String>] - [-ManagedApplicationDefinitionId <String>] [-Parameter <String>] [-Kind <String>] [-Plan <Hashtable>] - [-Tag <Hashtable>] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmManagedApplication** cmdlet updates managed applications - -## EXAMPLES - -### Example 1: Update managed application definition description -``` -PS C:\>Set-AzureRmManagedApplication -ResourceId "/subscriptions/mySubId/resourcegroups/myRG/Microsoft.Solutions/applications/myApp" -Description "Updated description here" -``` - -This command updates the managed application description - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The fully qualified managed application Id, including the subscription. e.g. /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName - -```yaml -Type: System.String -Parameter Sets: SetById -Aliases: ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Kind -The managed application kind. -One of marketplace or servicecatalog - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedApplicationDefinitionId -The managed resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ManagedResourceGroupName -The managed resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The managed application name. - -```yaml -Type: System.String -Parameter Sets: SetByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Parameter -The JSON formatted string of parameters for managed application. -This can either be a path to a file name or uri containing the parameters, or the parameters as string. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Plan -A hash table which represents managed application plan properties. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: PlanObject - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: SetByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -A hash table which represents resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -## OUTPUTS - -### System.Management.Automation.PSObject - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/Set-AzureRmManagedApplicationDefinition.md b/azurermps-6.13.0/AzureRM.Resources/Set-AzureRmManagedApplicationDefinition.md deleted file mode 100644 index b16634fcbb..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Set-AzureRmManagedApplicationDefinition.md +++ /dev/null @@ -1,263 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/set-azurermmanagedapplicationdefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmManagedApplicationDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmManagedApplicationDefinition.md ---- - -# Set-AzureRmManagedApplicationDefinition - -## SYNOPSIS -Updates managed application definition - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByNameAndResourceGroup (Default) -``` -Set-AzureRmManagedApplicationDefinition -Name <String> -ResourceGroupName <String> [-DisplayName <String>] - [-Description <String>] [-PackageFileUri <String>] [-Authorization <String[]>] [-Tag <Hashtable>] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### SetById -``` -Set-AzureRmManagedApplicationDefinition -Id <String> [-DisplayName <String>] [-Description <String>] - [-PackageFileUri <String>] [-Authorization <String[]>] [-Tag <Hashtable>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmManagedApplicationDefinition** cmdlet updates managed application definitions - -## EXAMPLES - -### Example 1: Update managed application definition description -``` -PS C:\>Set-AzureRmManagedApplicationDefinition -ResourceId "/subscriptions/mySubId/resourcegroups/myRG/Microsoft.Solutions/applicationDefinitions/myAppDef" -Description "Updated description here" -``` - -This command updates the managed application definition description - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Authorization -The managed application definition authorization. -Comma separated authorization pairs in a format of \<principalId\>:\<roleDefinitionId\> - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The managed application definition description. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisplayName -The managed application definition display name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Id -The fully qualified managed application definition Id, including the subscription. e.g. /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName - -```yaml -Type: System.String -Parameter Sets: SetById -Aliases: ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The managed application definition name. - -```yaml -Type: System.String -Parameter Sets: SetByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PackageFileUri -The managed application definition package file uri. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: SetByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -A hash table which represents resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.String[] - -### System.Collections.Hashtable - -## OUTPUTS - -### System.Management.Automation.PSObject - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/Set-AzureRmPolicyAssignment.md b/azurermps-6.13.0/AzureRM.Resources/Set-AzureRmPolicyAssignment.md deleted file mode 100644 index 23bb71f42c..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Set-AzureRmPolicyAssignment.md +++ /dev/null @@ -1,315 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: C3B2C33F-8BD4-4E31-9450-EF6A3A6A5325 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/set-azurermpolicyassignment -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmPolicyAssignment.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmPolicyAssignment.md ---- - -# Set-AzureRmPolicyAssignment - -## SYNOPSIS -Modifies a policy assignment. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameParameterSet (Default) -``` -Set-AzureRmPolicyAssignment -Name <String> -Scope <String> [-NotScope <String[]>] [-DisplayName <String>] - [-Description <String>] [-Metadata <String>] [-Sku <Hashtable>] [-AssignIdentity] [-Location <String>] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>] -``` - -### IdParameterSet -``` -Set-AzureRmPolicyAssignment [-NotScope <String[]>] -Id <String> [-DisplayName <String>] [-Description <String>] - [-Metadata <String>] [-Sku <Hashtable>] [-AssignIdentity] [-Location <String>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmPolicyAssignment** cmdlet modifies a policy assignment. -Specify an assignment by ID or by name and scope. - -## EXAMPLES - -### Example 1: Update the display name -``` -PS C:\> $ResourceGroup = Get-AzureRmResourceGroup -Name 'ResourceGroup11' -PS C:\> $PolicyAssignment = Get-AzureRmPolicyAssignment -Name 'PolicyAssignment' -Scope $ResourceGroup.ResourceId -PS C:\> Set-AzureRmPolicyAssignment -Id $PolicyAssignment.ResourceId -DisplayName 'Do not allow VM creation' -``` - -The first command gets a resource group named ResourceGroup11 by using the Get-AzureRMResourceGroup cmdlet. -The command stores that object in the $ResourceGroup variable. -The second command gets the policy assignment named PolicyAssignment by using the Get-AzureRmPolicyAssignment cmdlet. -The command stores that object in the $PolicyAssignment variable. -The final command updates the display name on the policy assignment on the resource group identified by the **ResourceId** property of $ResourceGroup. - -### Example 2: Add a managed identity to the policy assignment -``` -PS C:\> $PolicyAssignment = Get-AzureRmPolicyAssignment -Name 'PolicyAssignment' -PS C:\> Set-AzureRmPolicyAssignment -Id $PolicyAssignment.ResourceId -AssignIdentity -Location 'westus' -``` - -The first command gets the policy assignment named PolicyAssignment from the current subscription by using the Get-AzureRmPolicyAssignment cmdlet. -The command stores that object in the $PolicyAssignment variable. -The final command assigns a managed identity to the policy assignment. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. -If you do not specify a version, this cmdlet uses the latest available version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignIdentity -Generate and assign a Microsoft Entra identity for this policy assignment. The identity will be used when executing deployments for 'deployIfNotExists' policies. Location is required when assigning an identity. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The description for policy assignment - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisplayName -Specifies a new display name for the policy assignment. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Id -Specifies the fully qualified resource ID for the policy assignment that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: IdParameterSet -Aliases: ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InformationAction -Specifies how this cmdlet responds to an information event. -The acceptable values for this parameter are: -- Continue -- Ignore -- Inquire -- SilentlyContinue -- Stop -- Suspend - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: infa - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationVariable -Specifies an information variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: iv - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The location of the policy assignment's resource identity. This is required when the -AssignIdentity switch is used. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Metadata -The updated metadata for the policy assignment. This can either be a path to a file name containing the metadata, or the metadata as a string. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the policy assignment that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NotScope -The policy assignment not scopes. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Specifies the scope at which the policy is applied. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -A hash table which represents sku properties. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: SkuObject - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmPolicyAssignment](./Get-AzureRmPolicyAssignment.md) - -[New-AzureRmPolicyAssignment](./New-AzureRmPolicyAssignment.md) - -[Remove-AzureRmPolicyAssignment](./Remove-AzureRmPolicyAssignment.md) diff --git a/azurermps-6.13.0/AzureRM.Resources/Set-AzureRmPolicyDefinition.md b/azurermps-6.13.0/AzureRM.Resources/Set-AzureRmPolicyDefinition.md deleted file mode 100644 index ce3bfedee9..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Set-AzureRmPolicyDefinition.md +++ /dev/null @@ -1,328 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: E1AC7139-786C-4DD6-A898-242723E0D159 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/set-azurermpolicydefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmPolicyDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmPolicyDefinition.md ---- - -# Set-AzureRmPolicyDefinition - -## SYNOPSIS -Modifies a policy definition. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameParameterSet (Default) -``` -Set-AzureRmPolicyDefinition -Name <String> [-DisplayName <String>] [-Description <String>] [-Policy <String>] - [-Metadata <String>] [-Parameter <String>] [-Mode <PolicyDefinitionMode>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [<CommonParameters>] -``` - -### ManagementGroupNameParameterSet -``` -Set-AzureRmPolicyDefinition -Name <String> [-DisplayName <String>] [-Description <String>] [-Policy <String>] - [-Metadata <String>] [-Parameter <String>] [-Mode <PolicyDefinitionMode>] -ManagementGroupName <String> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>] -``` - -### SubscriptionIdParameterSet -``` -Set-AzureRmPolicyDefinition -Name <String> [-DisplayName <String>] [-Description <String>] [-Policy <String>] - [-Metadata <String>] [-Parameter <String>] [-Mode <PolicyDefinitionMode>] -SubscriptionId <Guid> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>] -``` - -### IdParameterSet -``` -Set-AzureRmPolicyDefinition -Id <String> [-DisplayName <String>] [-Description <String>] [-Policy <String>] - [-Metadata <String>] [-Parameter <String>] [-Mode <PolicyDefinitionMode>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmPolicyDefinition** cmdlet modifies a policy definition. - -## EXAMPLES - -### Example 1: Update the description of a policy definition -``` -PS C:\> $PolicyDefinition = Get-AzureRmPolicyDefinition -Name 'VMPolicyDefinition' -PS C:\> Set-AzureRmPolicyDefinition -Id $PolicyDefinition.ResourceId -Description 'Updated policy to not allow virtual machine creation' -``` - -The first command gets a policy definition named VMPolicyDefinition by using the Get-AzureRmPolicyDefinition cmdlet. -The command stores that object in the $PolicyDefinition variable. -The second command updates the description of the policy definition identified by the **ResourceId** property of $PolicyDefinition. - -### Example 2: Update the mode of a policy definition -``` -PS C:\> Set-AzureRmPolicyDefinition -Name 'VMPolicyDefinition' -Mode 'All' -``` - -This command updates the policy definition named VMPolicyDefinition by using the Set-AzureRmPolicyDefinition cmdlet to -set its mode property to 'All'. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. -If you do not specify a version, this cmdlet uses the latest available version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a new description for the policy definition. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisplayName -Specifies a new display name for the policy definition. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Id -Specifies the fully qualified resource ID for the policy definition that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: IdParameterSet -Aliases: ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InformationAction -Specifies how this cmdlet responds to an information event. -The acceptable values for this parameter are: -- Continue -- Ignore -- Inquire -- SilentlyContinue -- Stop -- Suspend - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: infa - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationVariable -Specifies an information variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: iv - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagementGroupName -The name of the management group of the policy definition to update. - -```yaml -Type: System.String -Parameter Sets: ManagementGroupNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Metadata -The metadata for policy definition. This can either be a path to a file name containing the metadata, or the metadata as string. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Mode -The mode of the new policy definition. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Policy.PolicyDefinitionMode] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the policy definition that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet, ManagementGroupNameParameterSet, SubscriptionIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Parameter -The parameters declaration for policy definition. This can either be a path to a file name or uri containing the parameters declaration, or the parameters declaration as string. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Policy -Specifies new policy rule for the policy definition. -You can specify the path of a .json file or a string that contains the policy in JavaScript Object Notation (JSON) format. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The subscription ID of the policy definition to update. - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: SubscriptionIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmPolicyDefinition](./Get-AzureRmPolicyDefinition.md) - -[New-AzureRmPolicyDefinition](./New-AzureRmPolicyDefinition.md) - -[Remove-AzureRmPolicyDefinition](./Remove-AzureRmPolicyDefinition.md) - - diff --git a/azurermps-6.13.0/AzureRM.Resources/Set-AzureRmPolicySetDefinition.md b/azurermps-6.13.0/AzureRM.Resources/Set-AzureRmPolicySetDefinition.md deleted file mode 100644 index 10cffec09b..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Set-AzureRmPolicySetDefinition.md +++ /dev/null @@ -1,294 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/set-azurermpolicysetdefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmPolicySetDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmPolicySetDefinition.md ---- - -# Set-AzureRmPolicySetDefinition - -## SYNOPSIS -Modifies a policy set definition - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameParameterSet (Default) -``` -Set-AzureRmPolicySetDefinition -Name <String> [-DisplayName <String>] [-Description <String>] - [-PolicyDefinition <String>] [-Metadata <String>] [-Parameter <String>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ManagementGroupNameParameterSet -``` -Set-AzureRmPolicySetDefinition -Name <String> [-DisplayName <String>] [-Description <String>] - [-PolicyDefinition <String>] [-Metadata <String>] [-Parameter <String>] -ManagementGroupName <String> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### SubscriptionIdParameterSet -``` -Set-AzureRmPolicySetDefinition -Name <String> [-DisplayName <String>] [-Description <String>] - [-PolicyDefinition <String>] [-Metadata <String>] [-Parameter <String>] -SubscriptionId <Guid> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### IdParameterSet -``` -Set-AzureRmPolicySetDefinition -Id <String> [-DisplayName <String>] [-Description <String>] - [-PolicyDefinition <String>] [-Metadata <String>] [-Parameter <String>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmPolicySetDefinition** cmdlet modifies a policy definition. - -## EXAMPLES - -### Example 1: Update the description of a policy set definition -``` -PS C:\> $PolicySetDefinition = Get-AzureRmPolicySetDefinition -ResourceId '/subscriptions/mySub/Microsoft.Authorization/policySetDefinitions/myPSSetDefinition' -PS C:\> Set-AzureRmPolicySetDefinition -Id $PolicySetDefinition.ResourceId -Description 'Updated policy to not allow virtual machine creation' -``` - -The first command gets a policy set definition by using the Get-AzureRmPolicySetDefinition cmdlet. -The command stores that object in the $PolicySetDefinition variable. -The second command updates the description of the policy set definition identified by the **ResourceId** property of $PolicySetDefinition. - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The description for policy set definition. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisplayName -The display name for policy set definition. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Id -The fully qualified policy definition Id, including the subscription. -e.g. -/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName} - -```yaml -Type: System.String -Parameter Sets: IdParameterSet -Aliases: ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ManagementGroupName -The name of the management group of the policy set definition to update. - -```yaml -Type: System.String -Parameter Sets: ManagementGroupNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Metadata -The metadata of the updated policy set definition. This can either be a path to a file name containing the metadata, or the metadata as a string. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The policy set definition name. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet, ManagementGroupNameParameterSet, SubscriptionIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Parameter -The parameters declaration of the updated policy set definition. This can either be a path to a file name or uri containing the parameters declaration, or the parameters declaration as a string. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PolicyDefinition -The policy set definition. This can either be a path to a file name containing the policy definitions, or the policy set definition as string. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The subscription ID of the policy set definition to update. - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: SubscriptionIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### System.Management.Automation.PSObject - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/Set-AzureRmResource.md b/azurermps-6.13.0/AzureRM.Resources/Set-AzureRmResource.md deleted file mode 100644 index f501581364..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Set-AzureRmResource.md +++ /dev/null @@ -1,472 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: A00160B9-831F-4A20-8D9D-9E89BC4F5C91 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/set-azurermresource -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmResource.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmResource.md ---- - -# Set-AzureRmResource - -## SYNOPSIS -Modifies a resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByResourceId (Default) -``` -Set-AzureRmResource [-Kind <String>] [-Properties <PSObject>] [-Plan <Hashtable>] [-Sku <Hashtable>] - [-Tag <Hashtable>] [-UsePatchSemantics] [-AsJob] -ResourceId <String> [-ODataQuery <String>] [-Force] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByInputObject -``` -Set-AzureRmResource -InputObject <PSResource> [-Kind <String>] [-Properties <PSObject>] [-Plan <Hashtable>] - [-Sku <Hashtable>] [-Tag <Hashtable>] [-UsePatchSemantics] [-AsJob] [-ODataQuery <String>] [-Force] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### BySubscriptionLevel -``` -Set-AzureRmResource [-Kind <String>] [-Properties <PSObject>] [-Plan <Hashtable>] [-Sku <Hashtable>] - [-Tag <Hashtable>] [-UsePatchSemantics] [-AsJob] -ResourceName <String> -ResourceType <String> - [-ExtensionResourceName <String>] [-ExtensionResourceType <String>] [-ODataQuery <String>] - [-ResourceGroupName <String>] [-Force] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTenantLevel -``` -Set-AzureRmResource [-Kind <String>] [-Properties <PSObject>] [-Plan <Hashtable>] [-Sku <Hashtable>] - [-Tag <Hashtable>] [-UsePatchSemantics] [-AsJob] -ResourceName <String> -ResourceType <String> - [-ExtensionResourceName <String>] [-ExtensionResourceType <String>] [-ODataQuery <String>] [-TenantLevel] - [-Force] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmResource** cmdlet modifies an existing Azure resource. -Specify a resource to modify by name and type or by ID. - -## EXAMPLES - -### Example 1: Modify a resource -``` -PS C:\> $Resource = Get-AzureRmResource -ResourceType Microsoft.Web/sites -ResourceGroupName ResourceGroup11 -ResourceName ContosoSite -PS C:\> $Resource.Properties.Enabled = "False" -PS C:\> $Resource | Set-AzureRmResource -Force -``` - -The first command gets the resource named ContosoSite by using the Get-AzureRmResource cmdlet, and then stores it in the $Resource variable. -The second command modifies a property of $Resource. -The final command updates the resource to match $Resource. - -### Example 2: Modify all resources in a given resource group -``` -PS C:\> $Resource = Get-AzureRmResource -ResourceGroupName testrg -PS C:\> $Resource | ForEach-Object { $_.Tags.Add("testkey", "testval") } -PS C:\> $Resource | Set-AzureRmResource -Force - -Name : kv-test -ResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testrg/providers/Microsoft.KeyVault/vaults/kv-test -ResourceName : kv-test -ResourceType : Microsoft.KeyVault/vaults -ResourceGroupName : testrg -Location : westus -SubscriptionId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -Tags : {testrgkey, key} -Properties : @{} - -Name : testresource -ResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testrg/providers/Providers.Test/statefulResources/testresource -ResourceName : testresource -ResourceType : Providers.Test/statefulResources -ResourceGroupName : testrg -Location : West US 2 -SubscriptionId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -Tags : {testrgkey, anothertesttag} -Properties : @{key=value} -Sku : @{name=A0} -``` - -The first command gets the resources in the testrg resource group, and then stores them in the $Resource variable. - -The second command iterates over each of these resources in the resource group and adds a new tag to them. - -The final command updates each of these resources. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. -If you do not specify a version, this cmdlet uses the latest available version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionResourceName -Specifies the name of an extension resource for the resource. -For instance, to specify a database, use the following format: -server name`/`database name - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExtensionResourceType -Specifies the resource type for an extension resource. -For instance, if the extension resource is a database specify the following: -`Microsoft.Sql/Servers/Databases` - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The object representation of the resource to update. - -```yaml -Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSResource -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Kind -Specifies the resource kind for the resource. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ODataQuery -Specifies an Open Data Protocol (OData) style filter. -This cmdlet appends this value to the request in addition to any other filters. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Plan -Specifies resource plan properties, as a hash table, for the resource. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: PlanObject - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Properties -Specifies resource properties for the resource. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: PropertyObject - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group where this cmdlet modifies the resource. - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Specifies the fully qualified resource ID, including the subscription, as in the following example: -`/subscriptions/`subscription ID`/providers/Microsoft.Sql/servers/ContosoServer/databases/ContosoDatabase` - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceName -Specifies the name of the resource. -For instance, to specify a database, use the following format: -`ContosoServer/ContosoDatabase` - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel, ByTenantLevel -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceType -Specifies the type of the resource. -For instance, for a database, the resource type is as follows: -`Microsoft.Sql/Servers/Databases` - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -Specifies the SKU object of the resource as a hash table. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: SkuObject - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TenantLevel -Indicates that this cmdlet operates at the tenant level. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UsePatchSemantics -Indicates that this cmdlet uses an HTTP PATCH to update the object, instead of an HTTP PUT. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.ResourceManager.Models.PSResource - -## NOTES - -## RELATED LINKS - - -[Get-AzureRmResource](./Get-AzureRmResource.md) - -[Move-AzureRmResource](./Move-AzureRmResource.md) - -[New-AzureRmResource](./New-AzureRmResource.md) - -[Remove-AzureRmResource](./Remove-AzureRmResource.md) diff --git a/azurermps-6.13.0/AzureRM.Resources/Set-AzureRmResourceGroup.md b/azurermps-6.13.0/AzureRM.Resources/Set-AzureRmResourceGroup.md deleted file mode 100644 index adab167987..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Set-AzureRmResourceGroup.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 4E5C059B-36F3-41C8-9FDB-69F5318CF39B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/set-azurermresourcegroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmResourceGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmResourceGroup.md ---- - -# Set-AzureRmResourceGroup - -## SYNOPSIS -Modifies a resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceGroupName (Default) -``` -Set-AzureRmResourceGroup [-Name] <String> [-Tag] <Hashtable> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResourceGroupId -``` -Set-AzureRmResourceGroup [-Tag] <Hashtable> [-Id] <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmResourceGroup** cmdlet modifies the properties of a resource group. -You can use this cmdlet to add, change, or delete the Azure tags applied to a resource group. -Specify the *Name* parameter to identify the resource group and the *Tag* parameter to modify the tags. -You cannot use this cmdlet to change the name of a resource group. - -## EXAMPLES - -### Example 1: Apply a tag to a resource group -``` -PS C:\>Set-AzureRmResourceGroup -Name "ContosoRG" -Tag @{Department="IT"} -``` - -This command applies a Department tag with a value of IT to a resource group that has no existing tags. - -### Example 2: Add tags to a resource group -``` -PS C:\>$Tags = (Get-AzureRmResourceGroup -Name "ContosoRG").Tags -PS C:\> $Tags -PS C:\> $Tags += @{"Status"="Approved"; "FY2016"=$null} -PS C:\> Set-AzureRmResourceGroup -Name "ContosoRG" -Tag $Tags -PS C:> (Get-AzureRmResourceGroup -Name "ContosoRG").Tags -``` - -This example adds a Status tag with a value of Approved and an FY2016 tag to a resource group that -has existing tags. Because the tags you specify replace the existing tags, you must include the -existing tags in the new tag collection or you will lose them. -The first command gets the ContosoRG resource group and uses the dot method to get the value of its -Tags property. The command stores the tags in the $Tags variable. -The second command gets the tags in the $Tags variable. -The third command uses the += assignment operator to add the Status and FY2016 tags to the array of -tags in the $Tags variable. -The fourth command uses the *Tag* parameter of **Set-AzureRmResourceGroup** to apply the tags in -the $Tags variable to the ContosoRG resource group. -The fifth command gets all of the tags applied to the ContosoRG resource group. The output shows -that the resource group has the Department tag and the two new tags, Status and FY2015. - -### Example 3: Delete all tags for a resource group -``` -PS C:\>Set-AzureRmResourceGroup -Name "ContosoRG" -Tag @{} -``` - -This command specifies the *Tag* parameter with an empty hash table value to delete all tags from -the ContosoRG resource group. - -## PARAMETERS - -### -ApiVersion -Specifies the API version that is supported by the resource Provider. -You can specify a different version than the default version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the resource group to modify. - -```yaml -Type: System.String -Parameter Sets: SetByResourceGroupId -Aliases: ResourceGroupId, ResourceId - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the resource group to modify. - -```yaml -Type: System.String -Parameter Sets: SetByResourceGroupName -Aliases: ResourceGroupName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} -A tag is a name-value pair that you can create and apply to resources and resource groups. After -you assign tags to resources and groups, you can use the *Tag* parameter of Get-AzureRmResource and -Get-AzureRmResourceGroup to search for resources and groups by tag name or name and value. You can -use tags to categorize your resources, such as by department or cost center, or to track notes or -comments about the resources. -To add or change a tag, you must replace the collection of tags for the resource group. To delete a -tag, enter a hash table with all tags currently applied to the resource group, from -**Get-AzureRmResourceGroup**, except for the tag you want to delete. To delete all tags from a -resource group, specify an empty hash table: `@{}`. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Resources.Models.PSResourceGroup - -## NOTES - -## RELATED LINKS - -[Get-AzureRmResource](./Get-AzureRmResource.md) - -[Get-AzureRmResourceGroup](./Get-AzureRmResourceGroup.md) - -[New-AzureRmResourceGroup](./New-AzureRmResourceGroup.md) - -[Remove-AzureRmResourceGroup](./Remove-AzureRmResourceGroup.md) diff --git a/azurermps-6.13.0/AzureRM.Resources/Set-AzureRmResourceLock.md b/azurermps-6.13.0/AzureRM.Resources/Set-AzureRmResourceLock.md deleted file mode 100644 index 1dcba906ee..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Set-AzureRmResourceLock.md +++ /dev/null @@ -1,378 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 770093CD-CE2A-4076-8A28-F4DCFFB7A075 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/set-azurermresourcelock -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmResourceLock.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmResourceLock.md ---- - -# Set-AzureRmResourceLock - -## SYNOPSIS -Modifies a resource lock. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### BySpecifiedScope (Default) -``` -Set-AzureRmResourceLock -LockName <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Force] - -Scope <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByResourceGroup -``` -Set-AzureRmResourceLock -LockName <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Force] - -ResourceGroupName <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByResourceGroupLevel -``` -Set-AzureRmResourceLock -LockName <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Force] - -ResourceName <String> -ResourceType <String> -ResourceGroupName <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### BySubscription -``` -Set-AzureRmResourceLock -LockName <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Force] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### BySubscriptionLevel -``` -Set-AzureRmResourceLock -LockName <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Force] - -ResourceName <String> -ResourceType <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTenantLevel -``` -Set-AzureRmResourceLock -LockName <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Force] - -ResourceName <String> -ResourceType <String> [-TenantLevel] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByLockId -``` -Set-AzureRmResourceLock -LockLevel <LockLevel> [-LockNotes <String>] [-Force] -LockId <String> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmResourceLock** cmdlet modifies a resource lock. - -## EXAMPLES - -### Example 1: Update notes for a lock -``` -PS C:\>Set-AzureRmResourceLock -LockLevel CanNotDelete -LockNotes "Updated note" -LockName "ContosoSiteLock" -ResourceName "ContosoSite" -ResourceType "microsoft.web/sites" -ResourceGroupName "ResourceGroup11" -``` - -This command updates the note for a lock named ContosoSiteLock. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. -If you do not specify a version, this cmdlet uses the latest available version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationAction -Specifies how this cmdlet responds to an information event. -The acceptable values for this parameter are: -- Continue -- Ignore -- Inquire -- SilentlyContinue -- Stop -- Suspend - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: infa - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationVariable -Specifies an information variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: iv - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LockId -Specifies the ID of the lock that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: ByLockId -Aliases: Id, ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LockLevel -Specifies the level for the lock. -Currently, the only valid value is CanNotDelete. - -```yaml -Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Locks.LockLevel -Parameter Sets: (All) -Aliases: Level - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LockName -Specifies the name of the lock that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: BySpecifiedScope, ByResourceGroup, ByResourceGroupLevel, BySubscription, BySubscriptionLevel, ByTenantLevel -Aliases: ExtensionResourceName, Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LockNotes -Specifies the notes for the lock. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Notes - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for which the lock applies. - -```yaml -Type: System.String -Parameter Sets: ByResourceGroup, ByResourceGroupLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceName -Specifies the name of the resource for which the lock applies. -For instance, to specify a database, use the following format: -Server`/`Database - -```yaml -Type: System.String -Parameter Sets: ByResourceGroupLevel, BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceType -Specifies the resource type for which the lock applies. - -```yaml -Type: System.String -Parameter Sets: ByResourceGroupLevel, BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Scope -Specifies the scope to which the lock applies. -For instance, to specify a database, use the following format: -`/subscriptions/`subscription ID`/resourceGroups/`resource group name`/providers/Microsoft.Sql/servers/`server name`/databases/`database name -To specify a resource group, use the following format: -`/subscriptions/`subscription ID`/resourceGroups/`resource group name - -```yaml -Type: System.String -Parameter Sets: BySpecifiedScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TenantLevel -Indicates that this cmdlet operates at the tenant level. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmResourceLock](./Get-AzureRmResourceLock.md) - -[New-AzureRmResourceLock](./New-AzureRmResourceLock.md) - -[Remove-AzureRmResourceLock](./Remove-AzureRmResourceLock.md) - - diff --git a/azurermps-6.13.0/AzureRM.Resources/Set-AzureRmRoleDefinition.md b/azurermps-6.13.0/AzureRM.Resources/Set-AzureRmRoleDefinition.md deleted file mode 100644 index 8661cfef32..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Set-AzureRmRoleDefinition.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 115A7612-4856-47AE-AEE4-918350CD7009 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/set-azurermroledefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmRoleDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmRoleDefinition.md ---- - -# Set-AzureRmRoleDefinition - -## SYNOPSIS -Modifies a custom role in Azure RBAC. -Provide the modified role definition either as a JSON file or as a PSRoleDefinition. -First, use the Get-AzureRmRoleDefinition command to retrieve the custom role that you wish to modify. -Then, modify the properties that you wish to change. -Finally, save the role definition using this command. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### InputFileParameterSet -``` -Set-AzureRmRoleDefinition -InputFile <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### RoleDefinitionParameterSet -``` -Set-AzureRmRoleDefinition -Role <PSRoleDefinition> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Set-AzureRmRoleDefinition cmdlet updates an existing custom role in Azure Role-Based Access Control. -Provide the updated role definition as an input to the command as a JSON file or a PSRoleDefinition object. -The role definition for the updated custom role MUST contain the Id and all other required properties of the role even if they are not updated: DisplayName, Description, Actions, AssignableScopes. -NotActions, DataActions, NotDataActions are optional. -Following is a sample updated role definition json for Set-AzureRmRoleDefinition -{ - "Id": "52a6cc13-ff92-47a8-a39b-2a8205c3087e", - "Name": "Updated Role", - "Description": "Can monitor all resources and start and restart virtual machines", - "Actions": - \[ - "*/read", - "Microsoft.ClassicCompute/virtualmachines/restart/action", - "Microsoft.ClassicCompute/virtualmachines/start/action" - \], - "NotActions": - \[ - "*/write" - \], - "DataActions": - \[ - "Microsoft.Storage/storageAccounts/blobServices/containers/blobs/read" - \], - "NotDataActions": - \[ - "Microsoft.Storage/storageAccounts/blobServices/containers/blobs/write" - \], - "AssignableScopes": \["/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"\] -} - -## EXAMPLES - -### Update using PSRoleDefinitionObject -``` -PS C:\> $roleDef = Get-AzureRmRoleDefinition "Contoso On-Call" - PS C:\> $roleDef.Actions.Add("Microsoft.ClassicCompute/virtualmachines/start/action") - PS C:\> $roleDef.Description = "Can monitor all resources and start and restart virtual machines" - PS C:\> $roleDef.AssignableScopes = @("/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx") - - PS C:\> Set-AzureRmRoleDefinition -Role $roleDef -``` - -### Create using JSON file -``` -PS C:\> Set-AzureRmRoleDefinition -InputFile C:\Temp\roleDefinition.json -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputFile -File name containing a single json role definition to be updated. -Only include the properties that are to be updated in the JSON. -Id property is Required. - -```yaml -Type: System.String -Parameter Sets: InputFileParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Role -Role definition object to be updated - -```yaml -Type: Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition -Parameter Sets: RoleDefinitionParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition -Parameters: Role (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment - -## RELATED LINKS - -[Get-AzureRmProviderOperation](./Get-AzureRmProviderOperation.md) - -[Get-AzureRmRoleDefinition](./Get-AzureRmRoleDefinition.md) - -[New-AzureRmRoleDefinition](./New-AzureRmRoleDefinition.md) - -[Remove-AzureRmRoleDefinition](./Remove-AzureRmRoleDefinition.md) - diff --git a/azurermps-6.13.0/AzureRM.Resources/Stop-AzureRmDeployment.md b/azurermps-6.13.0/AzureRM.Resources/Stop-AzureRmDeployment.md deleted file mode 100644 index 868eaca250..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Stop-AzureRmDeployment.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/stop-azurermdeployment -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Stop-AzureRmDeployment.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Stop-AzureRmDeployment.md ---- - -# Stop-AzureRmDeployment - -## SYNOPSIS -Cancal a running deployment - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### StopByDeploymentName (Default) -``` -Stop-AzureRmDeployment [-Name] <String> [-PassThru] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### StopByDeploymentId -``` -Stop-AzureRmDeployment -Id <String> [-PassThru] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### StopByInputObject -``` -Stop-AzureRmDeployment -InputObject <PSDeployment> [-PassThru] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Stop-AzureRmDeployment** cmdlet cancels a deployment at subscription scope that has started but not completed. -To stop a deployment, the deployment must have an incomplete provisioning state, such as Provisioning, and not a completed state, such as Provisioned or Failed. - -To create a deployment at subscription scope, use the New-AzureRmDeployment cmdlet. - -This cmdlet stops only one running deployment. Use the *Name* parameter to stop a specific deployment. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Stop-AzureRmDeployment -Name "deployment01" -``` - -This command cancels a running deployment "deployment01" at the current subscription scope. - -### Example 2 -``` -PS C:\>Get-AzureRmDeployment -Name "deployment01" | Stop-AzureRmDeployment -``` - -This command gets the deployment "deployment01" at the current subscription scope and cancels it. - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The fully qualified resource Id of the deployment. -example: /subscriptions/{subId}/providers/Microsoft.Resources/deployments/{deploymentName} - -```yaml -Type: String -Parameter Sets: StopByDeploymentId -Aliases: DeploymentId, ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The deployment object. - -```yaml -Type: PSDeployment -Parameter Sets: StopByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the deployment. - -```yaml -Type: String -Parameter Sets: StopByDeploymentName -Aliases: DeploymentName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/Stop-AzureRmResourceGroupDeployment.md b/azurermps-6.13.0/AzureRM.Resources/Stop-AzureRmResourceGroupDeployment.md deleted file mode 100644 index 3d191bd859..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Stop-AzureRmResourceGroupDeployment.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 089954C3-7F3E-46C2-AA93-C0151EACDA2F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/stop-azurermresourcegroupdeployment -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Stop-AzureRmResourceGroupDeployment.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Stop-AzureRmResourceGroupDeployment.md ---- - -# Stop-AzureRmResourceGroupDeployment - -## SYNOPSIS -Cancels a resource group deployment. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### StopByResourceGroupDeploymentName (Default) -``` -Stop-AzureRmResourceGroupDeployment [-ResourceGroupName] <String> [-Name] <String> [-ApiVersion <String>] - [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### StopByResourceGroupDeploymentId -``` -Stop-AzureRmResourceGroupDeployment -Id <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Stop-AzureRmResourceGroupDeployment** cmdlet cancels an Azure resource group deployment that has started but not completed. -To stop a deployment, the deployment must have an incomplete provisioning state, such as Provisioning, and not a completed state, such as Provisioned or Failed. -An Azure resource is a user-managed entity, such as a website, database, or database server. -A resource group is a collection of resources that are deployed as a unit. -To deploy a resource group, use the New-AzureRmResourceGroupDeployment cmdlet. -The New-AzureRmResource cmdlet creates a new resource, but it does not trigger a resource group deployment operation that this cmdlet can stop. -This cmdlet stops only one running deployment. -Use the *Name* parameter to stop a specific deployment. -If you omit the *Name* parameter, **Stop-AzureRmResourceGroupDeployment** searches for a running deployment and stops it. -If the cmdlet finds more than one running deployment, the command fails. - -## EXAMPLES - -### Example 1: Starting and stopping a resource group deployment - -```powershell -PS C:\> New-AzureRmResourceGroupDeployment -Name mynewstorageaccount -ResourceGroupName myrg -TemplateFile .\storage-account-create-azuredeploy.json -TemplateParameterFile .\storage-account-create-azuredeploy.parameters.json -AsJob - -Id Name PSJobTypeName State HasMoreData Location Command --- ---- ------------- ----- ----------- -------- ------- -1 Long Running... AzureLongRun... Running True localhost New-AzureRmResourceGro... - -PS C:\> Stop-AzureRmResourceGroupDeployment -Name mynewstorageaccount -ResourceGroupName myrg -True - -PS C:\> Get-Job 1 - -Id Name PSJobTypeName State HasMoreData Location Command --- ---- ------------- ----- ----------- -------- ------- -1 Long Running... AzureLongRun... Failed True localhost New-AzureRmResourceGro... -``` - -## PARAMETERS - -### -ApiVersion -Specifies the API version that is supported by the resource Provider. -You can specify a different version than the default version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of the resource group deployment to stop. - -```yaml -Type: System.String -Parameter Sets: StopByResourceGroupDeploymentId -Aliases: DeploymentId, ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the resource group deployment to stop. -If you do not specify this parameter, this cmdlet searches for a running deployment in the resource group and stops it. -If it finds more than one running deployment, the command fails. -To get the deployment name, use the Get-AzureRmResourceGroupDeployment cmdlet. - -```yaml -Type: System.String -Parameter Sets: StopByResourceGroupDeploymentName -Aliases: DeploymentName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. -This cmdlet stops the deployment of the resource group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: StopByResourceGroupDeploymentName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmResourceGroupDeployment](./Get-AzureRmResourceGroupDeployment.md) - -[New-AzureRmResource](./New-AzureRmResource.md) - -[New-AzureRmResourceGroup](./New-AzureRmResourceGroup.md) - -[New-AzureRmResourceGroupDeployment](./New-AzureRmResourceGroupDeployment.md) - -[Remove-AzureRmResourceGroupDeployment](./Remove-AzureRmResourceGroupDeployment.md) - -[Test-AzureRmResourceGroupDeployment](./Test-AzureRmResourceGroupDeployment.md) - - diff --git a/azurermps-6.13.0/AzureRM.Resources/Test-AzureRmDeployment.md b/azurermps-6.13.0/AzureRM.Resources/Test-AzureRmDeployment.md deleted file mode 100644 index f0177d2bd8..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Test-AzureRmDeployment.md +++ /dev/null @@ -1,232 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/test-azurermdeployment -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Test-AzureRmDeployment.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Test-AzureRmDeployment.md ---- - -# Test-AzureRmDeployment - -## SYNOPSIS -Validates a deployment. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByTemplateFileWithNoParameters (Default) -``` -Test-AzureRmDeployment -Location <String> -TemplateFile <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByTemplateFileAndParameterObject -``` -Test-AzureRmDeployment -Location <String> -TemplateParameterObject <Hashtable> -TemplateFile <String> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByTemplateUriAndParameterObject -``` -Test-AzureRmDeployment -Location <String> -TemplateParameterObject <Hashtable> -TemplateUri <String> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByTemplateFileAndParameterFile -``` -Test-AzureRmDeployment -Location <String> -TemplateParameterFile <String> -TemplateFile <String> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByTemplateUriAndParameterFile -``` -Test-AzureRmDeployment -Location <String> -TemplateParameterFile <String> -TemplateUri <String> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByTemplateFileAndParameterUri -``` -Test-AzureRmDeployment -Location <String> -TemplateParameterUri <String> -TemplateFile <String> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByTemplateUriAndParameterUri -``` -Test-AzureRmDeployment -Location <String> -TemplateParameterUri <String> -TemplateUri <String> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByTemplateUriWithNoParameters -``` -Test-AzureRmDeployment -Location <String> -TemplateUri <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Test-AzureRmDeployment** cmdlet determines whether a deployment template and its parameter values are valid. - -## EXAMPLES - -### Example 1: Test deployment with a custom template and parameter file -``` -PS C:\>Test-AzureRmDeployment -Location "West US" -TemplateFile "D:\Azure\Templates\EngineeringSite.json" -TemplateParameterFile "D:\Azure\Templates\EngSiteParms.json" -``` - -This command tests a deployment at the current subscription scope using the given template file and parameters file. - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The location to store deployment data. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TemplateFile -Local path to the template file. - -```yaml -Type: String -Parameter Sets: ByTemplateFileWithNoParameters, ByTemplateFileAndParameterObject, ByTemplateFileAndParameterFile, ByTemplateFileAndParameterUri -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TemplateParameterFile -A file that has the template parameters. - -```yaml -Type: String -Parameter Sets: ByTemplateFileAndParameterFile, ByTemplateUriAndParameterFile -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TemplateParameterObject -A hash table which represents the parameters. - -```yaml -Type: Hashtable -Parameter Sets: ByTemplateFileAndParameterObject, ByTemplateUriAndParameterObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TemplateParameterUri -Uri to the template parameter file. - -```yaml -Type: String -Parameter Sets: ByTemplateFileAndParameterUri, ByTemplateUriAndParameterUri -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TemplateUri -Uri to the template file. - -```yaml -Type: String -Parameter Sets: ByTemplateUriAndParameterObject, ByTemplateUriAndParameterFile, ByTemplateUriAndParameterUri, ByTemplateUriWithNoParameters -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Microsoft.Azure.Management.ResourceManager.Models.DeploymentMode -System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSResourceManagerError - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/Test-AzureRmResourceGroupDeployment.md b/azurermps-6.13.0/AzureRM.Resources/Test-AzureRmResourceGroupDeployment.md deleted file mode 100644 index 4c7853852e..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Test-AzureRmResourceGroupDeployment.md +++ /dev/null @@ -1,296 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 0143CE35-3B1D-4829-B880-A5CA25B83883 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/test-azurermresourcegroupdeployment -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Test-AzureRmResourceGroupDeployment.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Test-AzureRmResourceGroupDeployment.md ---- - -# Test-AzureRmResourceGroupDeployment - -## SYNOPSIS -Validates a resource group deployment. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByTemplateFileWithNoParameters (Default) -``` -Test-AzureRmResourceGroupDeployment -ResourceGroupName <String> [-Mode <DeploymentMode>] - [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] -TemplateFile <String> [-ApiVersion <String>] - [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByTemplateFileAndParameterObject -``` -Test-AzureRmResourceGroupDeployment -ResourceGroupName <String> [-Mode <DeploymentMode>] - [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] -TemplateParameterObject <Hashtable> - -TemplateFile <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByTemplateUriAndParameterObject -``` -Test-AzureRmResourceGroupDeployment -ResourceGroupName <String> [-Mode <DeploymentMode>] - [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] -TemplateParameterObject <Hashtable> - -TemplateUri <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByTemplateFileAndParameterFile -``` -Test-AzureRmResourceGroupDeployment -ResourceGroupName <String> [-Mode <DeploymentMode>] - [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] -TemplateParameterFile <String> - -TemplateFile <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByTemplateUriAndParameterFile -``` -Test-AzureRmResourceGroupDeployment -ResourceGroupName <String> [-Mode <DeploymentMode>] - [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] -TemplateParameterFile <String> - -TemplateUri <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByTemplateFileAndParameterUri -``` -Test-AzureRmResourceGroupDeployment -ResourceGroupName <String> [-Mode <DeploymentMode>] - [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] -TemplateParameterUri <String> - -TemplateFile <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByTemplateUriAndParameterUri -``` -Test-AzureRmResourceGroupDeployment -ResourceGroupName <String> [-Mode <DeploymentMode>] - [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] -TemplateParameterUri <String> - -TemplateUri <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByTemplateUriWithNoParameters -``` -Test-AzureRmResourceGroupDeployment -ResourceGroupName <String> [-Mode <DeploymentMode>] - [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] -TemplateUri <String> [-ApiVersion <String>] - [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Test-AzureRmResourceGroupDeployment** cmdlet determines whether an Azure resource group deployment template and its parameter values are valid. - -## EXAMPLES - -## PARAMETERS - -### -ApiVersion -Specifies the API version that is supported by the resource Provider. -You can specify a different version than the default version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mode -Specifies the deployment mode. -The acceptable values for this parameter are: -- Incremental -- Complete - -```yaml -Type: Microsoft.Azure.Management.ResourceManager.Models.DeploymentMode -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to test. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RollBackDeploymentName -Rollback to the successful deployment with the given name in the resource group, should not be used if -RollbackToLastDeployment is used. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RollbackToLastDeployment -Rollback to the last successful deployment in the resource group, should not be present if -RollBackDeploymentName is used. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TemplateFile -Specifies the full path of a JSON template file. - -```yaml -Type: System.String -Parameter Sets: ByTemplateFileWithNoParameters, ByTemplateFileAndParameterObject, ByTemplateFileAndParameterFile, ByTemplateFileAndParameterUri -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TemplateParameterFile -Specifies the full path of a JSON file that contains the names and values of the template parameters. - -```yaml -Type: System.String -Parameter Sets: ByTemplateFileAndParameterFile, ByTemplateUriAndParameterFile -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TemplateParameterObject -Specifies a hash table of template parameter names and values. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: ByTemplateFileAndParameterObject, ByTemplateUriAndParameterObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TemplateParameterUri -Specifies the URI of a template parameters file. - -```yaml -Type: System.String -Parameter Sets: ByTemplateFileAndParameterUri, ByTemplateUriAndParameterUri -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TemplateUri -Specifies the URI of a JSON template file. - -```yaml -Type: System.String -Parameter Sets: ByTemplateUriAndParameterObject, ByTemplateUriAndParameterFile, ByTemplateUriAndParameterUri, ByTemplateUriWithNoParameters -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.ResourceManager.Models.PSResourceManagerError - -## NOTES - -## RELATED LINKS - -[Get-AzureRmResourceGroupDeployment](./Get-AzureRmResourceGroupDeployment.md) - -[New-AzureRmResourceGroupDeployment](./New-AzureRmResourceGroupDeployment.md) - -[Remove-AzureRmResourceGroupDeployment](./Remove-AzureRmResourceGroupDeployment.md) - -[Stop-AzureRmResourceGroupDeployment](./Stop-AzureRmResourceGroupDeployment.md) - - diff --git a/azurermps-6.13.0/AzureRM.Resources/Unregister-AzureRmResourceProvider.md b/azurermps-6.13.0/AzureRM.Resources/Unregister-AzureRmResourceProvider.md deleted file mode 100644 index 6b95668884..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Unregister-AzureRmResourceProvider.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: D5126B7B-7FBB-4C72-B77E-13ADE2BE9B1B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/unregister-azurermresourceprovider -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Unregister-AzureRmResourceProvider.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Unregister-AzureRmResourceProvider.md ---- - -# Unregister-AzureRmResourceProvider - -## SYNOPSIS -Unregisters a resource provider. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Unregister-AzureRmResourceProvider -ProviderNamespace <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Unregister-AzureRmResourceProvider** cmdlet unregisters an Azure resource provider. - -## EXAMPLES - -## PARAMETERS - -### -ApiVersion -Specifies the API version that is supported by the resource Provider. -You can specify a different version than the default version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProviderNamespace -Specifies the namespace of the resource provider. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmResourceProvider](./Get-AzureRmResourceProvider.md) - -[Register-AzureRmResourceProvider](./Register-AzureRmResourceProvider.md) - - diff --git a/azurermps-6.13.0/AzureRM.Resources/Update-AzureRmADApplication.md b/azurermps-6.13.0/AzureRM.Resources/Update-AzureRmADApplication.md deleted file mode 100644 index 7af012629a..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Update-AzureRmADApplication.md +++ /dev/null @@ -1,320 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/update-azurermadapplication -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Update-AzureRmADApplication.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Update-AzureRmADApplication.md ---- - -# Update-AzureRmADApplication - -## SYNOPSIS -Updates an existing Microsoft Entra application. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ApplicationObjectIdWithUpdateParamsParameterSet (Default) -``` -Update-AzureRmADApplication -ObjectId <Guid> [-DisplayName <String>] [-HomePage <String>] - [-IdentifierUri <String[]>] [-ReplyUrl <String[]>] [-AvailableToOtherTenants <Boolean>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationIdWithUpdateParamsParameterSet -``` -Update-AzureRmADApplication -ApplicationId <Guid> [-DisplayName <String>] [-HomePage <String>] - [-IdentifierUri <String[]>] [-ReplyUrl <String[]>] [-AvailableToOtherTenants <Boolean>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectWithUpdateParamsParameterSet -``` -Update-AzureRmADApplication -InputObject <PSADApplication> [-DisplayName <String>] [-HomePage <String>] - [-IdentifierUri <String[]>] [-ReplyUrl <String[]>] [-AvailableToOtherTenants <Boolean>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Updates an existing Microsoft Entra application. -To update the credentials associated with this application, please use the New-AzureRmADAppCredential cmdlet. - -## EXAMPLES - -### Example 1 - Update the display name of an application - -``` -PS C:\> Update-AzureRmADApplication -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 -DisplayName MyNewDisplayName -``` - -Updates the display name of the application with object id '00001111-aaaa-2222-bbbb-3333cccc4444' to be 'MyNewDisplayName'. - -### Example 2 - Update all properties of an application - -``` -PS C:\> Update-AzureRmADApplication -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 -DisplayName MyNewDisplayName -HomePage https://www.microsoft.com -IdentifierUris "https://UpdateAppUri" -``` - -Updates the properties of an application with object id '00001111-aaaa-2222-bbbb-3333cccc4444'. - -### Example 3 - Update the display name of an application using piping - -``` -PS C:\> Get-AzureRmADApplication -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 | Update-AzureRmADApplication -DisplayName MyNewDisplayName -``` - -Gets the application with object id '00001111-aaaa-2222-bbbb-3333cccc4444' and pipes that to the Update-AzureRmADApplication cmdlet to update the display name of the application to "MyNewDisplayName". - -## PARAMETERS - -### -ApplicationId -The application id of the application to update. - -```yaml -Type: System.Guid -Parameter Sets: ApplicationIdWithUpdateParamsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AvailableToOtherTenants -True if the application is shared with other tenants; otherwise, false. - -```yaml -Type: System.Boolean -Parameter Sets: ApplicationObjectIdWithUpdateParamsParameterSet, ApplicationIdWithUpdateParamsParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Boolean -Parameter Sets: InputObjectWithUpdateParamsParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The display name for the application to update. - -```yaml -Type: System.String -Parameter Sets: ApplicationObjectIdWithUpdateParamsParameterSet, ApplicationIdWithUpdateParamsParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: InputObjectWithUpdateParamsParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HomePage -The URL to the application's homepage. - -```yaml -Type: System.String -Parameter Sets: ApplicationObjectIdWithUpdateParamsParameterSet, ApplicationIdWithUpdateParamsParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: InputObjectWithUpdateParamsParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IdentifierUri -The URIs that identify the application. - -```yaml -Type: System.String[] -Parameter Sets: ApplicationObjectIdWithUpdateParamsParameterSet, ApplicationIdWithUpdateParamsParameterSet -Aliases: IdentifierUris - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String[] -Parameter Sets: InputObjectWithUpdateParamsParameterSet -Aliases: IdentifierUris - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -The object representing the application to update. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication -Parameter Sets: InputObjectWithUpdateParamsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ObjectId -The object id of the application to update. - -```yaml -Type: System.Guid -Parameter Sets: ApplicationObjectIdWithUpdateParamsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReplyUrl -Specifies the URLs that user tokens are sent to for sign in, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to. - -```yaml -Type: System.String[] -Parameter Sets: ApplicationObjectIdWithUpdateParamsParameterSet, ApplicationIdWithUpdateParamsParameterSet -Aliases: ReplyUrls - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String[] -Parameter Sets: InputObjectWithUpdateParamsParameterSet -Aliases: ReplyUrls - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication -Parameters: InputObject (ByValue) - -### System.String - -### System.String[] - -### System.Boolean - -## OUTPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/Update-AzureRmADServicePrincipal.md b/azurermps-6.13.0/AzureRM.Resources/Update-AzureRmADServicePrincipal.md deleted file mode 100644 index 38bc4988f1..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Update-AzureRmADServicePrincipal.md +++ /dev/null @@ -1,284 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/update-azurermadserviceprincipal -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Update-AzureRmADServicePrincipal.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Update-AzureRmADServicePrincipal.md ---- - -# Update-AzureRmADServicePrincipal - -## SYNOPSIS -Updates an existing Microsoft Entra service principal. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SpObjectIdWithDisplayNameParameterSet (Default) -``` -Update-AzureRmADServicePrincipal -ObjectId <Guid> [-DisplayName <String>] [-Homepage <String>] - [-IdentifierUri <String[]>] [-KeyCredential <KeyCredential[]>] [-PasswordCredential <PasswordCredential[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SpApplicationIdWithDisplayNameParameterSet -``` -Update-AzureRmADServicePrincipal -ApplicationId <Guid> [-Homepage <String>] [-IdentifierUri <String[]>] - [-KeyCredential <KeyCredential[]>] [-PasswordCredential <PasswordCredential[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SPNWithDisplayNameParameterSet -``` -Update-AzureRmADServicePrincipal -ServicePrincipalName <String> [-DisplayName <String>] [-Homepage <String>] - [-IdentifierUri <String[]>] [-KeyCredential <KeyCredential[]>] [-PasswordCredential <PasswordCredential[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectWithDisplayNameParameterSet -``` -Update-AzureRmADServicePrincipal -InputObject <PSADServicePrincipal> [-DisplayName <String>] - [-Homepage <String>] [-IdentifierUri <String[]>] [-KeyCredential <KeyCredential[]>] - [-PasswordCredential <PasswordCredential[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Updates an existing Microsoft Entra service principal. -To update the credentials associated with this service principal, please use New-AzureRmADSpCredential cmdlet. -To update the properties associated with the underlying application, please use Update-AzureRmADApplication cmdlet. - -## EXAMPLES - -### Example 1 - Update the display name of a service principal - -``` -PS C:\> Update-AzureRmADServicePrincipal -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 -DisplayName MyNewDisplayName -``` - -Updates the display name of the service principal with object id '00001111-aaaa-2222-bbbb-3333cccc4444' to be 'MyNewDisplayName'. - -### Example 2 - Update the display name of a service principal using piping - -``` -PS C:\> Get-AzureRmADServicePrincipal -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 | Update-AzureRmADServicePrincipal -DisplayName MyNewDisplayName -``` - -Gets the service principal with object id '00001111-aaaa-2222-bbbb-3333cccc4444' and pipes that to the Update-AzureRmADServicePrincipal cmdlet to update the display name of the service principal to "MyNewDisplayName". - -## PARAMETERS - -### -ApplicationId -The application id of the service principal to update. - -```yaml -Type: System.Guid -Parameter Sets: SpApplicationIdWithDisplayNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The display name for the service principal. - -```yaml -Type: System.String -Parameter Sets: SpObjectIdWithDisplayNameParameterSet, SPNWithDisplayNameParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: InputObjectWithDisplayNameParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Homepage -The homepage for the service principal. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IdentifierUri -The identifier URI(s) for the service principal. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The object representing the service principal to update. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADServicePrincipal -Parameter Sets: InputObjectWithDisplayNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -KeyCredential -The key credential(s) for the service principal. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.Models.KeyCredential[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ObjectId -The object id of the service principal to update. - -```yaml -Type: System.Guid -Parameter Sets: SpObjectIdWithDisplayNameParameterSet -Aliases: ServicePrincipalObjectId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PasswordCredential -The password credential(s) for the service principal. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.Models.PasswordCredential[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServicePrincipalName -The SPN of the service principal to update. - -```yaml -Type: System.String -Parameter Sets: SPNWithDisplayNameParameterSet -Aliases: SPN - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADServicePrincipal -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADServicePrincipal - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/Update-AzureRmADUser.md b/azurermps-6.13.0/AzureRM.Resources/Update-AzureRmADUser.md deleted file mode 100644 index e1cc068e2a..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Update-AzureRmADUser.md +++ /dev/null @@ -1,304 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/update-azurermaduser -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Update-AzureRmADUser.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Update-AzureRmADUser.md ---- - -# Update-AzureRmADUser - -## SYNOPSIS -Updates an existing active directory user. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### UPNOrObjectIdParameterSet (Default) -``` -Update-AzureRmADUser -UPNOrObjectId <String> [-DisplayName <String>] [-EnableAccount <Boolean>] - [-Password <SecureString>] [-ForceChangePasswordNextLogin] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### UPNParameterSet -``` -Update-AzureRmADUser -UserPrincipalName <String> [-DisplayName <String>] [-EnableAccount <Boolean>] - [-Password <SecureString>] [-ForceChangePasswordNextLogin] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ObjectIdParameterSet -``` -Update-AzureRmADUser -ObjectId <Guid> [-DisplayName <String>] [-EnableAccount <Boolean>] - [-Password <SecureString>] [-ForceChangePasswordNextLogin] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectParameterSet -``` -Update-AzureRmADUser -InputObject <PSADUser> [-DisplayName <String>] [-EnableAccount <Boolean>] - [-Password <SecureString>] [-ForceChangePasswordNextLogin] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Updates an existing active directory user (work/school account also popularly known as org-id). -For more information: https://msdn.microsoft.com/en-us/library/azure/ad/graph/api/users-operations#UpdateUser - -## EXAMPLES - -### Example 1 - Update the display name of a user using object id - -``` -PS C:\> Update-AzureRmADUser -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 -DisplayName MyNewDisplayName -``` - -Updates the display name of the user with object id '00001111-aaaa-2222-bbbb-3333cccc4444' to be 'MyNewDisplayName'. - -### Example 2 - Update the display name of a user using user principal name - -``` -PS C:\> Update-AzureRmADUser -UserPrincipalName foo@domain.com -DisplayName MyNewDisplayName -``` - -Updates the display name of the user with user principal name 'foo@domain.com' to be 'MyNewDisplayName'. - -### Example 3 - Update the display name of a user using piping - -``` -PS C:\> Get-AzureRmADUser -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 | Update-AzureRmADUser -DisplayName MyNewDisplayName -``` - -Gets the user with object id '00001111-aaaa-2222-bbbb-3333cccc4444' and pipes that to the Update-AzureRmADUser cmdlet to update the display name of that user to 'MyNewDisplayName'. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -New display name for the user. - -```yaml -Type: System.String -Parameter Sets: UPNOrObjectIdParameterSet, UPNParameterSet, ObjectIdParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableAccount -true for enabling the account; otherwise, false. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: UPNOrObjectIdParameterSet, UPNParameterSet, ObjectIdParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ForceChangePasswordNextLogin -It must be specified if the user should change the password on the next successful login. -Only valid if password is updated otherwise it will be ignored. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The object representing the user to be updated. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADUser -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ObjectId -The object id of the user to be updated. - -```yaml -Type: System.Guid -Parameter Sets: ObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Password -New password for the user. - -```yaml -Type: System.Security.SecureString -Parameter Sets: UPNOrObjectIdParameterSet, UPNParameterSet, ObjectIdParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Security.SecureString -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UPNOrObjectId -The user principal name or object id of the user to be updated. - -```yaml -Type: System.String -Parameter Sets: UPNOrObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserPrincipalName -The user principal name of the user to be updated. - -```yaml -Type: System.String -Parameter Sets: UPNParameterSet -Aliases: UPN - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Guid - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADUser -Parameters: InputObject (ByValue) - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Security.SecureString - -## OUTPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADUser - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Resources/Update-AzureRmManagementGroup.md b/azurermps-6.13.0/AzureRM.Resources/Update-AzureRmManagementGroup.md deleted file mode 100644 index b54c7be056..0000000000 --- a/azurermps-6.13.0/AzureRM.Resources/Update-AzureRmManagementGroup.md +++ /dev/null @@ -1,252 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/update-azurermmanagementgroup/ -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Update-AzureRmManagementGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Resources/Commands.Resources/help/Update-AzureRmManagementGroup.md ---- - -# Update-AzureRmManagementGroup - -## SYNOPSIS -Updates a Management Group - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GroupOperations (Default) -``` -Update-AzureRmManagementGroup -GroupName <String> [-DisplayName <String>] [-ParentId <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ParentAndManagementGroupObject -``` -Update-AzureRmManagementGroup -InputObject <PSManagementGroup> [-DisplayName <String>] - [-DefaultProfile <IAzureContextContainer>] -ParentObject <PSManagementGroup> [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ManagementGroupObject -``` -Update-AzureRmManagementGroup -InputObject <PSManagementGroup> [-DisplayName <String>] [-ParentId <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ParentGroupObject -``` -Update-AzureRmManagementGroup -GroupName <String> [-DisplayName <String>] - [-DefaultProfile <IAzureContextContainer>] -ParentObject <PSManagementGroup> [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureRMManagementGroup** cmdlet updates the **ParentId** or **DisplayName** for a Management Group. - -## EXAMPLES - -### Example 1: Update a Management Group's Display Name -``` -PS C:\> Update-AzureRMManagementGroup -Group "TestGroup" -DisplayName "New Display Name" - -Id : /providers/Microsoft.Management/managementGroups/TestGroup -Type : /providers/Microsoft.Management/managementGroups -Name : TestGroup -TenantId : 00001111-aaaa-2222-bbbb-3333cccc4444 -DisplayName : New Display Name -UpdatedTime : 2/1/2018 12:03:37 PM -UpdatedBy : 64360beb-ffb4-43a8-9314-01aa34db95a9 -ParentId : /providers/Microsoft.Management/managementGroups/00001111-aaaa-2222-bbbb-3333cccc4444 -ParentName : 00001111-aaaa-2222-bbbb-3333cccc4444 -ParentDisplayName : 00001111-aaaa-2222-bbbb-3333cccc4444 -``` - -### Example 2: Update a Management Group's Parent -``` -PS C:\> Update-AzureRMManagementGroup -Group "TestGroup" -ParentId "/providers/Microsoft.Management/managementGroups/TestGroupParent" - -Id : /providers/Microsoft.Management/managementGroups/TestGroup -Type : /providers/Microsoft.Management/managementGroups -Name : TestGroup -TenantId : 00001111-aaaa-2222-bbbb-3333cccc4444 -DisplayName : TestGroup -UpdatedTime : 2/1/2018 12:03:37 PM -UpdatedBy : 64360beb-ffb4-43a8-9314-01aa34db95a9 -ParentId : /providers/Microsoft.Management/managementGroups/TestGroupParent -ParentName : TestGroupParent -ParentDisplayName : TestGroupParent -``` - -### Example 3: Update a Management Group by piping PSManagementGroup Object -``` -PS C:\> Get-AzureRmManagementGroup -GroupName "TestGroup" | Update-AzureRMManagementGroup -DisplayName "TestDisplayName" -ParentId "/providers/Microsoft.Management/managementGroups/TestGroupParent" - -Id : /providers/Microsoft.Management/managementGroups/TestGroup -Type : /providers/Microsoft.Management/managementGroups -Name : TestGroup -TenantId : 00001111-aaaa-2222-bbbb-3333cccc4444 -DisplayName : TestDisplayName -UpdatedTime : 2/1/2018 12:03:37 PM -UpdatedBy : 64360beb-ffb4-43a8-9314-01aa34db95a9 -ParentId : /providers/Microsoft.Management/managementGroups/TestGroupParent -ParentName : TestGroupParent -ParentDisplayName : TestGroupParent -``` - -### Example 4: Update a Management Group's parent using the ParentObject -``` -PS C:\> $parentObject = Get-AzureRmManagementGroup -GroupName "TestGroupParent" -PS C:\> Update-AzureRmManagementGroup -GroupName "TestGroup" -ParentObject $parentObject - -Id : /providers/Microsoft.Management/managementGroups/TestGroup -Type : /providers/Microsoft.Management/managementGroups -Name : TestGroup -TenantId : 00001111-aaaa-2222-bbbb-3333cccc4444 -DisplayName : TestGroupDisplayName -UpdatedTime : 2/1/2018 11:16:12 AM -UpdatedBy : 00001111-aaaa-2222-bbbb-3333cccc4444 -ParentId : /providers/Microsoft.Management/managementGroups/TestGroupParent -ParentName : TestGroupParent -ParentDisplayName : TestGroupParent -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Display Name of the management group - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupName -Management Group Id - -```yaml -Type: System.String -Parameter Sets: GroupOperations, ParentGroupObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Input Object from the Get call - -```yaml -Type: Microsoft.Azure.Commands.Resources.Models.ManagementGroups.PSManagementGroup -Parameter Sets: ParentAndManagementGroupObject, ManagementGroupObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ParentId -Parent Id of the management group - -```yaml -Type: System.String -Parameter Sets: GroupOperations, ManagementGroupObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParentObject -Input Object from the Get call - -```yaml -Type: Microsoft.Azure.Commands.Resources.Models.ManagementGroups.PSManagementGroup -Parameter Sets: ParentAndManagementGroupObject, ParentGroupObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Resources.Models.ManagementGroups.PSManagementGroup -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Resources.Models.ManagementGroups.PSManagementGroup - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Scheduler/AzureRM.Scheduler.md b/azurermps-6.13.0/AzureRM.Scheduler/AzureRM.Scheduler.md deleted file mode 100644 index 84154a3aac..0000000000 --- a/azurermps-6.13.0/AzureRM.Scheduler/AzureRM.Scheduler.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -Module Name: AzureRM.Scheduler -Module Guid: 5c8a1c13-7e88-42d8-bbea-f3a81fdd6c1e -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.scheduler -Help Version: 0.16.3.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/AzureRM.Scheduler.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/AzureRM.Scheduler.md ---- - -# AzureRM.Scheduler Module -## Description -This topic displays help topics for the Azure Scheduler cmdlets. - -## AzureRM.Scheduler Cmdlets -### [Disable-AzureRmSchedulerJobCollection](Disable-AzureRmSchedulerJobCollection.md) -Disables a job collection. - -### [Enable-AzureRmSchedulerJobCollection](Enable-AzureRmSchedulerJobCollection.md) -Enables a job collection. - -### [Get-AzureRmSchedulerJob](Get-AzureRmSchedulerJob.md) -Gets Scheduler jobs. - -### [Get-AzureRmSchedulerJobCollection](Get-AzureRmSchedulerJobCollection.md) -Gets job collections. - -### [Get-AzureRmSchedulerJobHistory](Get-AzureRmSchedulerJobHistory.md) -Gets job history. - -### [New-AzureRmSchedulerHttpJob](New-AzureRmSchedulerHttpJob.md) -Creates an HTTP job. - -### [New-AzureRmSchedulerJobCollection](New-AzureRmSchedulerJobCollection.md) -Creates a job collection. - -### [New-AzureRmSchedulerServiceBusQueueJob](New-AzureRmSchedulerServiceBusQueueJob.md) -Creates a service bus queue job. - -### [New-AzureRmSchedulerServiceBusTopicJob](New-AzureRmSchedulerServiceBusTopicJob.md) -Creates a service bus topic job. - -### [New-AzureRmSchedulerStorageQueueJob](New-AzureRmSchedulerStorageQueueJob.md) -Creates a storage queue job. - -### [Remove-AzureRmSchedulerJob](Remove-AzureRmSchedulerJob.md) -Removes a Scheduler job. - -### [Remove-AzureRmSchedulerJobCollection](Remove-AzureRmSchedulerJobCollection.md) -Removes a job collection. - -### [Set-AzureRmSchedulerHttpJob](Set-AzureRmSchedulerHttpJob.md) -Modifies a Scheduler HTTP job. - -### [Set-AzureRmSchedulerJobCollection](Set-AzureRmSchedulerJobCollection.md) -Modifies a job collection. - -### [Set-AzureRmSchedulerServiceBusQueueJob](Set-AzureRmSchedulerServiceBusQueueJob.md) -Modifies a service bus queue job. - -### [Set-AzureRmSchedulerServiceBusTopicJob](Set-AzureRmSchedulerServiceBusTopicJob.md) -Modifies a service bus topic job. - -### [Set-AzureRmSchedulerStorageQueueJob](Set-AzureRmSchedulerStorageQueueJob.md) -Modifies a storage queue job. - diff --git a/azurermps-6.13.0/AzureRM.Scheduler/Disable-AzureRmSchedulerJobCollection.md b/azurermps-6.13.0/AzureRM.Scheduler/Disable-AzureRmSchedulerJobCollection.md deleted file mode 100644 index 899e9df260..0000000000 --- a/azurermps-6.13.0/AzureRM.Scheduler/Disable-AzureRmSchedulerJobCollection.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Scheduler.dll-Help.xml -Module Name: AzureRM.Scheduler -ms.assetid: C06D4AD3-9CB1-4FEB-B02F-74022F264260 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.scheduler/disable-azurermschedulerjobcollection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/Disable-AzureRmSchedulerJobCollection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/Disable-AzureRmSchedulerJobCollection.md ---- - -# Disable-AzureRmSchedulerJobCollection - -## SYNOPSIS -Disables a job collection. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Disable-AzureRmSchedulerJobCollection -ResourceGroupName <String> -JobCollectionName <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Disable-AzureRmSchedulerJobCollection** cmdlet disables a job collection in Azure Scheduler. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobCollectionName -Specifies the name of a job collection. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a value of Success on success. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group of the job collection. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Enable-AzureRmSchedulerJobCollection](./Enable-AzureRmSchedulerJobCollection.md) - -[Get-AzureRmSchedulerJobCollection](./Get-AzureRmSchedulerJobCollection.md) - -[New-AzureRmSchedulerJobCollection](./New-AzureRmSchedulerJobCollection.md) - -[Remove-AzureRmSchedulerJobCollection](./Remove-AzureRmSchedulerJobCollection.md) - -[Set-AzureRmSchedulerJobCollection](./Set-AzureRmSchedulerJobCollection.md) - - diff --git a/azurermps-6.13.0/AzureRM.Scheduler/Enable-AzureRmSchedulerJobCollection.md b/azurermps-6.13.0/AzureRM.Scheduler/Enable-AzureRmSchedulerJobCollection.md deleted file mode 100644 index 2281a01191..0000000000 --- a/azurermps-6.13.0/AzureRM.Scheduler/Enable-AzureRmSchedulerJobCollection.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Scheduler.dll-Help.xml -Module Name: AzureRM.Scheduler -ms.assetid: BA79EDC8-BE89-4836-92EF-748D6F518886 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.scheduler/enable-azurermschedulerjobcollection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/Enable-AzureRmSchedulerJobCollection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/Enable-AzureRmSchedulerJobCollection.md ---- - -# Enable-AzureRmSchedulerJobCollection - -## SYNOPSIS -Enables a job collection. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Enable-AzureRmSchedulerJobCollection -ResourceGroupName <String> -JobCollectionName <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Enable-AzureRmSchedulerJobCollection** cmdlet enables a job collection in Azure Scheduler. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobCollectionName -Specifies the name of a job collection. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a value of Success on success. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group of the job collection. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Disable-AzureRmSchedulerJobCollection](./Disable-AzureRmSchedulerJobCollection.md) - -[Get-AzureRmSchedulerJobCollection](./Get-AzureRmSchedulerJobCollection.md) - -[New-AzureRmSchedulerJobCollection](./New-AzureRmSchedulerJobCollection.md) - -[Remove-AzureRmSchedulerJobCollection](./Remove-AzureRmSchedulerJobCollection.md) - -[Set-AzureRmSchedulerJobCollection](./Set-AzureRmSchedulerJobCollection.md) - - diff --git a/azurermps-6.13.0/AzureRM.Scheduler/Get-AzureRmSchedulerJob.md b/azurermps-6.13.0/AzureRM.Scheduler/Get-AzureRmSchedulerJob.md deleted file mode 100644 index f9495fc80b..0000000000 --- a/azurermps-6.13.0/AzureRM.Scheduler/Get-AzureRmSchedulerJob.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Scheduler.dll-Help.xml -Module Name: AzureRM.Scheduler -ms.assetid: DC151161-72C0-40F7-B2F0-45FA01142AE1 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.scheduler/get-azurermschedulerjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/Get-AzureRmSchedulerJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/Get-AzureRmSchedulerJob.md ---- - -# Get-AzureRmSchedulerJob - -## SYNOPSIS -Gets Scheduler jobs. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSchedulerJob -ResourceGroupName <String> -JobCollectionName <String> [-JobName <String>] - [-JobState <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSchedulerJob** cmdlet gets Azure Scheduler jobs. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobCollectionName -Specifies the name of a job collection that contains jobs to get. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -JobName -Specifies the name of a job to get. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -JobState -Specifies a job state of jobs to get. -The acceptable values for this parameter are: -- Enabled -- Disabled -- Faulted -- Completed - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled, Faulted, Completed - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group of the jobs to get. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Scheduler.Models.PSSchedulerJobDefinition - -## NOTES - -## RELATED LINKS - -[New-AzureRmSchedulerHttpJob](./New-AzureRmSchedulerHttpJob.md) - -[New-AzureRmSchedulerJobCollection](./New-AzureRmSchedulerJobCollection.md) - -[New-AzureRmSchedulerServiceBusQueueJob](./New-AzureRmSchedulerServiceBusQueueJob.md) - -[New-AzureRmSchedulerServiceBusTopicJob](./New-AzureRmSchedulerServiceBusTopicJob.md) - -[New-AzureRmSchedulerStorageQueueJob](./New-AzureRmSchedulerStorageQueueJob.md) - -[Remove-AzureRmSchedulerJob](./Remove-AzureRmSchedulerJob.md) - -[Set-AzureRmSchedulerHttpJob](./Set-AzureRmSchedulerHttpJob.md) - -[Set-AzureRmSchedulerServiceBusQueueJob](./Set-AzureRmSchedulerServiceBusQueueJob.md) - -[Set-AzureRmSchedulerServiceBusTopicJob](./Set-AzureRmSchedulerServiceBusTopicJob.md) - -[Set-AzureRmSchedulerStorageQueueJob](./Set-AzureRmSchedulerStorageQueueJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.Scheduler/Get-AzureRmSchedulerJobCollection.md b/azurermps-6.13.0/AzureRM.Scheduler/Get-AzureRmSchedulerJobCollection.md deleted file mode 100644 index dc8e46364a..0000000000 --- a/azurermps-6.13.0/AzureRM.Scheduler/Get-AzureRmSchedulerJobCollection.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Scheduler.dll-Help.xml -Module Name: AzureRM.Scheduler -ms.assetid: 600B621A-1311-4A05-9807-7B0E49D5A63C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.scheduler/get-azurermschedulerjobcollection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/Get-AzureRmSchedulerJobCollection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/Get-AzureRmSchedulerJobCollection.md ---- - -# Get-AzureRmSchedulerJobCollection - -## SYNOPSIS -Gets job collections. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSchedulerJobCollection [-ResourceGroupName <String>] [-JobCollectionName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSchedulerJobCollection** cmdlet gets job collections in Azure Scheduler. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobCollectionName -Specifies the name of a job collection. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies resource group from which this cmdlet gets job collections. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Scheduler.Models.PSJobCollectionDefinition - -## NOTES - -## RELATED LINKS - -[Disable-AzureRmSchedulerJobCollection](./Disable-AzureRmSchedulerJobCollection.md) - -[Enable-AzureRmSchedulerJobCollection](./Enable-AzureRmSchedulerJobCollection.md) - -[New-AzureRmSchedulerJobCollection](./New-AzureRmSchedulerJobCollection.md) - -[Remove-AzureRmSchedulerJobCollection](./Remove-AzureRmSchedulerJobCollection.md) - -[Set-AzureRmSchedulerJobCollection](./Set-AzureRmSchedulerJobCollection.md) - - diff --git a/azurermps-6.13.0/AzureRM.Scheduler/Get-AzureRmSchedulerJobHistory.md b/azurermps-6.13.0/AzureRM.Scheduler/Get-AzureRmSchedulerJobHistory.md deleted file mode 100644 index b9a37b8038..0000000000 --- a/azurermps-6.13.0/AzureRM.Scheduler/Get-AzureRmSchedulerJobHistory.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Scheduler.dll-Help.xml -Module Name: AzureRM.Scheduler -ms.assetid: F6D8710D-1D42-493C-B7F1-EDA35FCCDC23 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.scheduler/get-azurermschedulerjobhistory -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/Get-AzureRmSchedulerJobHistory.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/Get-AzureRmSchedulerJobHistory.md ---- - -# Get-AzureRmSchedulerJobHistory - -## SYNOPSIS -Gets job history. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSchedulerJobHistory -ResourceGroupName <String> -JobCollectionName <String> -JobName <String> - [-JobExecutionStatus <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSchedulerJobHistory** cmdlet gets history for an Azure Scheduler job. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobCollectionName -Specifies the name of a job collection. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -JobExecutionStatus -Specifies the status of a job. -This cmdlet gets history that matches the status that you specify. -The acceptable values for this parameter are: -- Completed -- Failed -- Postponed - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Completed, Failed, Postponed - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -JobName -Specifies the name of a job for which this cmdlet gets history. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group to which the job belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Scheduler.Models.PSJobHistory - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSchedulerJob](./Get-AzureRmSchedulerJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.Scheduler/New-AzureRmSchedulerHttpJob.md b/azurermps-6.13.0/AzureRM.Scheduler/New-AzureRmSchedulerHttpJob.md deleted file mode 100644 index 1107cb8dd1..0000000000 --- a/azurermps-6.13.0/AzureRM.Scheduler/New-AzureRmSchedulerHttpJob.md +++ /dev/null @@ -1,377 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Scheduler.dll-Help.xml -Module Name: AzureRM.Scheduler -ms.assetid: E00D42D6-707A-479E-9964-C5B80D3DAA6A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.scheduler/new-azurermschedulerhttpjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/New-AzureRmSchedulerHttpJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/New-AzureRmSchedulerHttpJob.md ---- - -# New-AzureRmSchedulerHttpJob - -## SYNOPSIS -Creates an HTTP job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmSchedulerHttpJob -ResourceGroupName <String> -JobCollectionName <String> -JobName <String> - -Method <String> -Uri <Uri> [-RequestBody <String>] [-Headers <Hashtable>] [-HttpAuthenticationType <String>] - [-StartTime <DateTime>] [-Interval <Int32>] [-Frequency <String>] [-EndTime <DateTime>] - [-ExecutionCount <Int32>] [-JobState <String>] [-ErrorActionType <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmSchedulerHttpJob** cmdlet creates an HTTP job in Azure Scheduler. -This cmdlet supports dynamic parameters based on the *ErrorActionType* and *HttpAuthenticationType* parameters. -Dynamic parameters become available based on other parameter values. -To discover the names of dynamic parameters after you specify the other parameters, type a hyphen (-), and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndTime -Specifies an end time, as a **DateTime** object, for the job. -To obtain a **DateTime** object, use the Get-Date cmdlet. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ErrorActionType -Specifies an error action setting for the job. -The acceptable values for this parameter are: -- Http -- Https -- StorageQueue -- ServiceBusQueue -- ServiceBusTopic - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Http, Https, StorageQueue, ServiceBusQueue, ServiceBusTopic - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExecutionCount -Specifies how many times the job runs. -By default, a job recurs indefinitely. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Frequency -Specifies a maximum frequency for the job. -The acceptable values for this parameter are: -- Minute -- Hour -- Day -- Week -- Month - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Minute, Hour, Day, Week, Month - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Headers -Specifies a hash table that contains headers. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HttpAuthenticationType -Specifies the HTTP authentication type. -The acceptable values for this parameter are: -- None -- ClientCertificate -- ActiveDirectoryOAuth -- Basic - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: None, ClientCertificate, ActiveDirectoryOAuth, Basic - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Interval -Specifies an interval of recurrence for the job. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobCollectionName -Specifies the name of the job collection to which the job belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -JobName -Specifies a name for the job. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -JobState -Specifies the state of the job. -The acceptable values for this parameter are: -- Enabled -- Disabled - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Method -Specifies the method for the action types for the job. -The acceptable values for this parameter are: -- GET -- PUT -- POST -- DELETE - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: GET, PUT, POST, DELETE - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestBody -Specifies the value of the body for PUT and POST job actions. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group to which the job belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartTime -Specifies the start time, as a **DateTime** object, for the job. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Uri -Specifies a URI for the job action. - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.Scheduler.Models.PSSchedulerJobDefinition - -## NOTES - -## RELATED LINKS - -[New-AzureRmSchedulerJobCollection](./New-AzureRmSchedulerJobCollection.md) - -[New-AzureRmSchedulerServiceBusQueueJob](./New-AzureRmSchedulerServiceBusQueueJob.md) - -[New-AzureRmSchedulerServiceBusTopicJob](./New-AzureRmSchedulerServiceBusTopicJob.md) - -[New-AzureRmSchedulerStorageQueueJob](./New-AzureRmSchedulerStorageQueueJob.md) - -[Set-AzureRmSchedulerHttpJob](./Set-AzureRmSchedulerHttpJob.md) - -[Set-AzureRmSchedulerJobCollection](./Set-AzureRmSchedulerJobCollection.md) - -[Set-AzureRmSchedulerServiceBusQueueJob](./Set-AzureRmSchedulerServiceBusQueueJob.md) - -[Set-AzureRmSchedulerServiceBusTopicJob](./Set-AzureRmSchedulerServiceBusTopicJob.md) - -[Set-AzureRmSchedulerStorageQueueJob](./Set-AzureRmSchedulerStorageQueueJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.Scheduler/New-AzureRmSchedulerJobCollection.md b/azurermps-6.13.0/AzureRM.Scheduler/New-AzureRmSchedulerJobCollection.md deleted file mode 100644 index 61435cbb39..0000000000 --- a/azurermps-6.13.0/AzureRM.Scheduler/New-AzureRmSchedulerJobCollection.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Scheduler.dll-Help.xml -Module Name: AzureRM.Scheduler -ms.assetid: D82270AD-50C2-4980-ABE2-58049C187875 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.scheduler/new-azurermschedulerjobcollection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/New-AzureRmSchedulerJobCollection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/New-AzureRmSchedulerJobCollection.md ---- - -# New-AzureRmSchedulerJobCollection - -## SYNOPSIS -Creates a job collection. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmSchedulerJobCollection -ResourceGroupName <String> -JobCollectionName <String> -Location <String> - [-Plan <String>] [-MaxJobCount <Int32>] [-Frequency <String>] [-Interval <Int32>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmSchedulerJobCollection** cmdlet creates a job collection in Azure Scheduler. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Frequency -Specifies the maximum frequency that you can specify on any job in the job collection. -The acceptable values for this parameter are: -- Minute -- Hour -- Day -- Week -- Month - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Minute, Hour, Day, Week, Month - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Interval -Specifies an interval of recurrence. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobCollectionName -Specifies a name for the job collection. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the Azure region in which this cmdlet creates the job collection. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaxJobCount -Specifies the maximum number of jobs that you can create in the job collection. -The maximum depends on the plan that the *Plan* parameter specifies. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Plan -Specifies the job collection plan. -The acceptable values for this parameter are: -- Free -- Standard -- P10Premium -- P20Premium - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Free, Standard, P10Premium, P20Premium - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group for the job collection. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Scheduler.Models.PSJobCollectionDefinition - -## NOTES - -## RELATED LINKS - -[Disable-AzureRmSchedulerJobCollection](./Disable-AzureRmSchedulerJobCollection.md) - -[Enable-AzureRmSchedulerJobCollection](./Enable-AzureRmSchedulerJobCollection.md) - -[Get-AzureRmSchedulerJobCollection](./Get-AzureRmSchedulerJobCollection.md) - -[Remove-AzureRmSchedulerJobCollection](./Remove-AzureRmSchedulerJobCollection.md) - -[Set-AzureRmSchedulerJobCollection](./Set-AzureRmSchedulerJobCollection.md) - - diff --git a/azurermps-6.13.0/AzureRM.Scheduler/New-AzureRmSchedulerServiceBusQueueJob.md b/azurermps-6.13.0/AzureRM.Scheduler/New-AzureRmSchedulerServiceBusQueueJob.md deleted file mode 100644 index 13e2ab5a22..0000000000 --- a/azurermps-6.13.0/AzureRM.Scheduler/New-AzureRmSchedulerServiceBusQueueJob.md +++ /dev/null @@ -1,383 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Scheduler.dll-Help.xml -Module Name: AzureRM.Scheduler -ms.assetid: 52987702-D101-4D5D-852D-2809374292F4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.scheduler/new-azurermschedulerservicebusqueuejob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/New-AzureRmSchedulerServiceBusQueueJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/New-AzureRmSchedulerServiceBusQueueJob.md ---- - -# New-AzureRmSchedulerServiceBusQueueJob - -## SYNOPSIS -Creates a service bus queue job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmSchedulerServiceBusQueueJob -ResourceGroupName <String> -JobCollectionName <String> - -JobName <String> -ServiceBusQueueName <String> -ServiceBusNamespace <String> - -ServiceBusTransportType <String> -ServiceBusMessage <String> -ServiceBusSasKeyName <String> - -ServiceBusSasKeyValue <String> [-StartTime <DateTime>] [-Interval <Int32>] [-Frequency <String>] - [-EndTime <DateTime>] [-ExecutionCount <Int32>] [-JobState <String>] [-ErrorActionType <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmSchedulerServiceBusQueueJob** cmdlet creates a service bus queue job in Azure Scheduler. -This cmdlet supports dynamic parameters based on the *ErrorActionType* parameter. -Dynamic parameters become available based on other parameter values. -To discover the names of dynamic parameters after you specify the other parameters, type a hyphen (-), and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndTime -Specifies an end time, as a **DateTime** object, for the job. -To obtain a **DateTime** object, use the Get-Date cmdlet. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ErrorActionType -Specifies an error action setting for the job. -The acceptable values for this parameter are: -- Http -- Https -- StorageQueue -- ServiceBusQueue -- ServiceBusTopic - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Http, Https, StorageQueue, ServiceBusQueue, ServiceBusTopic - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExecutionCount -Specifies how many times the job runs. -By default, a job recurs indefinitely. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Frequency -Specifies a frequency for the job. -The acceptable values for this parameter are: -- Minute -- Hour -- Day -- Week -- Month - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Minute, Hour, Day, Week, Month - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Interval -Specifies an interval of recurrence for the job. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobCollectionName -Specifies the name of the job collection to which the job belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -JobName -Specifies a name for the job. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -JobState -Specifies the state of the job. -The acceptable values for this parameter are: -- Enabled -- Disabled - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group to which the job belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceBusMessage -Specifies a service bus queue message. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceBusNamespace -Specifies a service bus namespace. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceBusQueueName -Specifies a service bus queue name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceBusSasKeyName -Specifies a shared access signature key name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceBusSasKeyValue -Specifies a shared access signature key value. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceBusTransportType -Specifies a service bus transport type. -The acceptable values for this parameter are: -- NetMessaging -- AMQP - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: NetMessaging, AMQP - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Specifies the start time, as a **DateTime** object, for the job. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Scheduler.Models.PSSchedulerJobDefinition - -## NOTES - -## RELATED LINKS - -[New-AzureRmSchedulerHttpJob](./New-AzureRmSchedulerHttpJob.md) - -[New-AzureRmSchedulerJobCollection](./New-AzureRmSchedulerJobCollection.md) - -[New-AzureRmSchedulerServiceBusTopicJob](./New-AzureRmSchedulerServiceBusTopicJob.md) - -[New-AzureRmSchedulerStorageQueueJob](./New-AzureRmSchedulerStorageQueueJob.md) - -[Set-AzureRmSchedulerHttpJob](./Set-AzureRmSchedulerHttpJob.md) - -[Set-AzureRmSchedulerJobCollection](./Set-AzureRmSchedulerJobCollection.md) - -[Set-AzureRmSchedulerServiceBusQueueJob](./Set-AzureRmSchedulerServiceBusQueueJob.md) - -[Set-AzureRmSchedulerServiceBusTopicJob](./Set-AzureRmSchedulerServiceBusTopicJob.md) - -[Set-AzureRmSchedulerStorageQueueJob](./Set-AzureRmSchedulerStorageQueueJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.Scheduler/New-AzureRmSchedulerServiceBusTopicJob.md b/azurermps-6.13.0/AzureRM.Scheduler/New-AzureRmSchedulerServiceBusTopicJob.md deleted file mode 100644 index 96b75342c1..0000000000 --- a/azurermps-6.13.0/AzureRM.Scheduler/New-AzureRmSchedulerServiceBusTopicJob.md +++ /dev/null @@ -1,383 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Scheduler.dll-Help.xml -Module Name: AzureRM.Scheduler -ms.assetid: 2B9FEEDB-09AA-40B6-B42C-F9090F54EB3B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.scheduler/new-azurermschedulerservicebustopicjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/New-AzureRmSchedulerServiceBusTopicJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/New-AzureRmSchedulerServiceBusTopicJob.md ---- - -# New-AzureRmSchedulerServiceBusTopicJob - -## SYNOPSIS -Creates a service bus topic job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmSchedulerServiceBusTopicJob -ResourceGroupName <String> -JobCollectionName <String> - -JobName <String> -ServiceBusTopicPath <String> -ServiceBusNamespace <String> - -ServiceBusTransportType <String> -ServiceBusMessage <String> -ServiceBusSasKeyName <String> - -ServiceBusSasKeyValue <String> [-StartTime <DateTime>] [-Interval <Int32>] [-Frequency <String>] - [-EndTime <DateTime>] [-ExecutionCount <Int32>] [-JobState <String>] [-ErrorActionType <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmSchedulerServiceBusTopicJob** cmdlet creates a service bus topic job in Azure Scheduler. -This cmdlet supports dynamic parameters based on the *ErrorActionType* parameter. -Dynamic parameters become available based on other parameter values. -To discover the names of dynamic parameters after you specify the other parameters, type a hyphen (-), and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndTime -Specifies an end time, as a **DateTime** object, for the job. -To obtain a **DateTime** object, use the Get-Date cmdlet. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ErrorActionType -Specifies an error action setting for the job. -The acceptable values for this parameter are: -- Http -- Https -- StorageQueue -- ServiceBusQueue -- ServiceBusTopic - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Http, Https, StorageQueue, ServiceBusQueue, ServiceBusTopic - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExecutionCount -Specifies how many times the job runs. -By default, a job recurs indefinitely. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Frequency -Specifies a maximum frequency for the job. -The acceptable values for this parameter are: -- Minute -- Hour -- Day -- Week -- Month - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Minute, Hour, Day, Week, Month - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Interval -Specifies an interval of recurrence for the job. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobCollectionName -Specifies the name of the job collection to which the job belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -JobName -Specifies a name for the job. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -JobState -Specifies the state of the job. -The acceptable values for this parameter are: -- Enabled -- Disabled - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group to which the job belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceBusMessage -Specifies a service bus topic message. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceBusNamespace -Specifies a service bus namespace. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceBusSasKeyName -Specifies a shared access signature key name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceBusSasKeyValue -Specifies a shared access signature key value. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceBusTopicPath -Specifies a service bus topic path. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceBusTransportType -Specifies a service bus transport type. -The acceptable values for this parameter are: -- NetMessaging -- AMQP - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: NetMessaging, AMQP - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Specifies the start time, as a **DateTime** object, for the job. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Scheduler.Models.PSSchedulerJobDefinition - -## NOTES - -## RELATED LINKS - -[New-AzureRmSchedulerHttpJob](./New-AzureRmSchedulerHttpJob.md) - -[New-AzureRmSchedulerJobCollection](./New-AzureRmSchedulerJobCollection.md) - -[New-AzureRmSchedulerServiceBusQueueJob](./New-AzureRmSchedulerServiceBusQueueJob.md) - -[New-AzureRmSchedulerStorageQueueJob](./New-AzureRmSchedulerStorageQueueJob.md) - -[Set-AzureRmSchedulerHttpJob](./Set-AzureRmSchedulerHttpJob.md) - -[Set-AzureRmSchedulerJobCollection](./Set-AzureRmSchedulerJobCollection.md) - -[Set-AzureRmSchedulerServiceBusQueueJob](./Set-AzureRmSchedulerServiceBusQueueJob.md) - -[Set-AzureRmSchedulerServiceBusTopicJob](./Set-AzureRmSchedulerServiceBusTopicJob.md) - -[Set-AzureRmSchedulerStorageQueueJob](./Set-AzureRmSchedulerStorageQueueJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.Scheduler/New-AzureRmSchedulerStorageQueueJob.md b/azurermps-6.13.0/AzureRM.Scheduler/New-AzureRmSchedulerStorageQueueJob.md deleted file mode 100644 index e6b735bff4..0000000000 --- a/azurermps-6.13.0/AzureRM.Scheduler/New-AzureRmSchedulerStorageQueueJob.md +++ /dev/null @@ -1,348 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Scheduler.dll-Help.xml -Module Name: AzureRM.Scheduler -ms.assetid: 5563B6E8-805B-463B-AF78-4F5750F5CDEA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.scheduler/new-azurermschedulerstoragequeuejob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/New-AzureRmSchedulerStorageQueueJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/New-AzureRmSchedulerStorageQueueJob.md ---- - -# New-AzureRmSchedulerStorageQueueJob - -## SYNOPSIS -Creates a storage queue job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmSchedulerStorageQueueJob -ResourceGroupName <String> -JobCollectionName <String> -JobName <String> - -StorageQueueAccount <String> -StorageQueueName <String> -StorageSASToken <String> - -StorageQueueMessage <String> [-StartTime <DateTime>] [-Interval <Int32>] [-Frequency <String>] - [-EndTime <DateTime>] [-ExecutionCount <Int32>] [-JobState <String>] [-ErrorActionType <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmSchedulerStorageQueueJob** cmdlet creates a storage queue job in Azure Scheduler. -This cmdlet supports dynamic parameters based on the *ErrorActionType* parameter. -Dynamic parameters become available based on other parameter values. -To discover the names of dynamic parameters after you specify the other parameters, type a hyphen (-), and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndTime -Specifies an end time, as a **DateTime** object, for the job. -To obtain a **DateTime** object, use the Get-Date cmdlet. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ErrorActionType -Specifies an error action setting for the job. -The acceptable values for this parameter are: -- Http -- Https -- StorageQueue -- ServiceBusQueue -- ServiceBusTopic - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Http, Https, StorageQueue, ServiceBusQueue, ServiceBusTopic - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExecutionCount -Specifies how many times the job runs. -By default, a job recurs indefinitely. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Frequency -Specifies a frequency for the job. -The acceptable values for this parameter are: -- Minute -- Hour -- Day -- Week -- Month - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Minute, Hour, Day, Week, Month - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Interval -Specifies an interval of recurrence for the job. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobCollectionName -Specifies the name of the job collection to which the job belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -JobName -Specifies a name for the job. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -JobState -Specifies the state of the job. -The acceptable values for this parameter are: -- Enabled -- Disabled - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group to which the job belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartTime -Specifies the start time, as a **DateTime** object, for the job. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageQueueAccount -Specifies a storage account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageQueueMessage -Specifies a queue message for the storage job. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageQueueName -Specifies a storage queue name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageSASToken -Specifies a shared access signature token for a storage queue. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Scheduler.Models.PSSchedulerJobDefinition - -## NOTES - -## RELATED LINKS - -[New-AzureRmSchedulerHttpJob](./New-AzureRmSchedulerHttpJob.md) - -[New-AzureRmSchedulerJobCollection](./New-AzureRmSchedulerJobCollection.md) - -[New-AzureRmSchedulerServiceBusQueueJob](./New-AzureRmSchedulerServiceBusQueueJob.md) - -[New-AzureRmSchedulerServiceBusTopicJob](./New-AzureRmSchedulerServiceBusTopicJob.md) - -[Set-AzureRmSchedulerHttpJob](./Set-AzureRmSchedulerHttpJob.md) - -[Set-AzureRmSchedulerJobCollection](./Set-AzureRmSchedulerJobCollection.md) - -[Set-AzureRmSchedulerServiceBusQueueJob](./Set-AzureRmSchedulerServiceBusQueueJob.md) - -[Set-AzureRmSchedulerServiceBusTopicJob](./Set-AzureRmSchedulerServiceBusTopicJob.md) - -[Set-AzureRmSchedulerStorageQueueJob](./Set-AzureRmSchedulerStorageQueueJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.Scheduler/Remove-AzureRmSchedulerJob.md b/azurermps-6.13.0/AzureRM.Scheduler/Remove-AzureRmSchedulerJob.md deleted file mode 100644 index ba510e3c7b..0000000000 --- a/azurermps-6.13.0/AzureRM.Scheduler/Remove-AzureRmSchedulerJob.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Scheduler.dll-Help.xml -Module Name: AzureRM.Scheduler -ms.assetid: 774699A8-8916-4F2A-973E-97E5E487D42E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.scheduler/remove-azurermschedulerjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/Remove-AzureRmSchedulerJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/Remove-AzureRmSchedulerJob.md ---- - -# Remove-AzureRmSchedulerJob - -## SYNOPSIS -Removes a Scheduler job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmSchedulerJob -ResourceGroupName <String> -JobCollectionName <String> -JobName <String> - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmSchedulerJob** cmdlet removes an Azure Scheduler job. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobCollectionName -Specifies the name of a job collection that contains the job to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -JobName -Specifies the name of a job to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a value of Success on success. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group of the job to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSchedulerJob](./Get-AzureRmSchedulerJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.Scheduler/Remove-AzureRmSchedulerJobCollection.md b/azurermps-6.13.0/AzureRM.Scheduler/Remove-AzureRmSchedulerJobCollection.md deleted file mode 100644 index 9bdbb237b0..0000000000 --- a/azurermps-6.13.0/AzureRM.Scheduler/Remove-AzureRmSchedulerJobCollection.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Scheduler.dll-Help.xml -Module Name: AzureRM.Scheduler -ms.assetid: F315B193-C17B-41A9-B61D-0A0212B6B643 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.scheduler/remove-azurermschedulerjobcollection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/Remove-AzureRmSchedulerJobCollection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/Remove-AzureRmSchedulerJobCollection.md ---- - -# Remove-AzureRmSchedulerJobCollection - -## SYNOPSIS -Removes a job collection. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmSchedulerJobCollection -ResourceGroupName <String> -JobCollectionName <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmSchedulerJobCollection** cmdlet removes a job collection in Azure Scheduler. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobCollectionName -Specifies the name of a job collection. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a value of Success on success. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group of the job collection. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Disable-AzureRmSchedulerJobCollection](./Disable-AzureRmSchedulerJobCollection.md) - -[Enable-AzureRmSchedulerJobCollection](./Enable-AzureRmSchedulerJobCollection.md) - -[Get-AzureRmSchedulerJobCollection](./Get-AzureRmSchedulerJobCollection.md) - -[New-AzureRmSchedulerJobCollection](./New-AzureRmSchedulerJobCollection.md) - -[Set-AzureRmSchedulerJobCollection](./Set-AzureRmSchedulerJobCollection.md) - - diff --git a/azurermps-6.13.0/AzureRM.Scheduler/Set-AzureRmSchedulerHttpJob.md b/azurermps-6.13.0/AzureRM.Scheduler/Set-AzureRmSchedulerHttpJob.md deleted file mode 100644 index ade36b8bb1..0000000000 --- a/azurermps-6.13.0/AzureRM.Scheduler/Set-AzureRmSchedulerHttpJob.md +++ /dev/null @@ -1,377 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Scheduler.dll-Help.xml -Module Name: AzureRM.Scheduler -ms.assetid: D9FA686C-48BB-48A1-926C-56B8151F8F82 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.scheduler/set-azurermschedulerhttpjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/Set-AzureRmSchedulerHttpJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/Set-AzureRmSchedulerHttpJob.md ---- - -# Set-AzureRmSchedulerHttpJob - -## SYNOPSIS -Modifies a Scheduler HTTP job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSchedulerHttpJob -ResourceGroupName <String> -JobCollectionName <String> -JobName <String> - [-Method <String>] [-Uri <Uri>] [-RequestBody <String>] [-Headers <Hashtable>] - [-HttpAuthenticationType <String>] [-StartTime <DateTime>] [-Interval <Int32>] [-Frequency <String>] - [-EndTime <DateTime>] [-ExecutionCount <Int32>] [-JobState <String>] [-ErrorActionType <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSchedulerHttpJob** cmdlet modifies an HTTP job in Azure Scheduler. -This cmdlet supports dynamic parameters based on the *ErrorActionType* and *HttpAuthenticationType* parameters. -Dynamic parameters become available based on other parameter values. -To discover the names of dynamic parameters after you specify the other parameters, type a hyphen (-), and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndTime -Specifies an end time, as a **DateTime** object, for the job. -To obtain a **DateTime** object, use the Get-Date cmdlet. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ErrorActionType -Specifies an error action setting for the job. -The acceptable values for this parameter are: -- Http -- Https -- StorageQueue -- ServiceBusQueue -- ServiceBusTopic - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Http, Https, StorageQueue, ServiceBusQueue, ServiceBusTopic - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExecutionCount -Specifies how many times the job runs. -By default, a job recurs indefinitely. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Frequency -Specifies the maximum frequency for the job. -The acceptable values for this parameter are: -- Minute -- Hour -- Day -- Week -- Month - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Minute, Hour, Day, Week, Month - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Headers -Specifies a hash table that contains headers. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HttpAuthenticationType -Specifies the HTTP authentication type. -The acceptable values for this parameter are: -- None -- ClientCertificate -- ActiveDirectoryOAuth -- Basic - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: None, ClientCertificate, ActiveDirectoryOAuth, Basic - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Interval -Specifies an interval of recurrence for the job. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobCollectionName -Specifies the name of the job collection to which the job belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -JobName -Specifies the name of the job that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -JobState -Specifies the state of the job. -The acceptable values for this parameter are: -- Enabled -- Disabled - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Method -Specifies the method for the action types for this job. -The acceptable values for this parameter are: -- GET -- PUT -- POST -- DELETE - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: GET, PUT, POST, DELETE - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestBody -Specifies the value of the body for PUT and POST job actions. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group to which the job belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartTime -Specifies the start time, as a **DateTime** object, for the job. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Uri -Specifies a URI for the job action. - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.Scheduler.Models.PSSchedulerJobDefinition - -## NOTES - -## RELATED LINKS - -[New-AzureRmSchedulerHttpJob](./New-AzureRmSchedulerHttpJob.md) - -[New-AzureRmSchedulerJobCollection](./New-AzureRmSchedulerJobCollection.md) - -[New-AzureRmSchedulerServiceBusQueueJob](./New-AzureRmSchedulerServiceBusQueueJob.md) - -[New-AzureRmSchedulerServiceBusTopicJob](./New-AzureRmSchedulerServiceBusTopicJob.md) - -[New-AzureRmSchedulerStorageQueueJob](./New-AzureRmSchedulerStorageQueueJob.md) - -[Set-AzureRmSchedulerJobCollection](./Set-AzureRmSchedulerJobCollection.md) - -[Set-AzureRmSchedulerServiceBusQueueJob](./Set-AzureRmSchedulerServiceBusQueueJob.md) - -[Set-AzureRmSchedulerServiceBusTopicJob](./Set-AzureRmSchedulerServiceBusTopicJob.md) - -[Set-AzureRmSchedulerStorageQueueJob](./Set-AzureRmSchedulerStorageQueueJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.Scheduler/Set-AzureRmSchedulerJobCollection.md b/azurermps-6.13.0/AzureRM.Scheduler/Set-AzureRmSchedulerJobCollection.md deleted file mode 100644 index d2e752a86a..0000000000 --- a/azurermps-6.13.0/AzureRM.Scheduler/Set-AzureRmSchedulerJobCollection.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Scheduler.dll-Help.xml -Module Name: AzureRM.Scheduler -ms.assetid: F9CF1EEB-6EFF-4C24-AC79-1328034D22A1 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.scheduler/set-azurermschedulerjobcollection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/Set-AzureRmSchedulerJobCollection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/Set-AzureRmSchedulerJobCollection.md ---- - -# Set-AzureRmSchedulerJobCollection - -## SYNOPSIS -Modifies a job collection. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSchedulerJobCollection -ResourceGroupName <String> -JobCollectionName <String> [-Location <String>] - [-Plan <String>] [-MaxJobCount <Int32>] [-Frequency <String>] [-Interval <Int32>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSchedulerJobCollection** cmdlet modifies a job collection in Azure Scheduler. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Frequency -Specifies the maximum frequency that you can specify on any job in the job collection. -The acceptable values for this parameter are: -- Minute -- Hour -- Day -- Week -- Month - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Minute, Hour, Day, Week, Month - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Interval -Specifies an interval of recurrence. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobCollectionName -Specifies the name of a job collection. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the Azure region in which the job collection exists. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaxJobCount -Specifies the maximum number of jobs that you can create in the job collection. -The maximum depends on the plan that the *Plan* parameter specifies. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Plan -Specifies the job collection plan. -The acceptable values for this parameter are: -- Free -- Standard -- P10Premium -- P20Premium - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Free, Standard, P10Premium, P20Premium - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group of the job collection. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Scheduler.Models.PSJobCollectionDefinition - -## NOTES - -## RELATED LINKS - -[Disable-AzureRmSchedulerJobCollection](./Disable-AzureRmSchedulerJobCollection.md) - -[Enable-AzureRmSchedulerJobCollection](./Enable-AzureRmSchedulerJobCollection.md) - -[Get-AzureRmSchedulerJobCollection](./Get-AzureRmSchedulerJobCollection.md) - -[New-AzureRmSchedulerJobCollection](./New-AzureRmSchedulerJobCollection.md) - -[Remove-AzureRmSchedulerJobCollection](./Remove-AzureRmSchedulerJobCollection.md) - - diff --git a/azurermps-6.13.0/AzureRM.Scheduler/Set-AzureRmSchedulerServiceBusQueueJob.md b/azurermps-6.13.0/AzureRM.Scheduler/Set-AzureRmSchedulerServiceBusQueueJob.md deleted file mode 100644 index 36772e196e..0000000000 --- a/azurermps-6.13.0/AzureRM.Scheduler/Set-AzureRmSchedulerServiceBusQueueJob.md +++ /dev/null @@ -1,383 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Scheduler.dll-Help.xml -Module Name: AzureRM.Scheduler -ms.assetid: 2C8C98B8-7A3B-4F24-BDF1-0B7B81049956 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.scheduler/set-azurermschedulerservicebusqueuejob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/Set-AzureRmSchedulerServiceBusQueueJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/Set-AzureRmSchedulerServiceBusQueueJob.md ---- - -# Set-AzureRmSchedulerServiceBusQueueJob - -## SYNOPSIS -Modifies a service bus queue job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSchedulerServiceBusQueueJob -ResourceGroupName <String> -JobCollectionName <String> - -JobName <String> [-ServiceBusQueueName <String>] -ServiceBusNamespace <String> - -ServiceBusTransportType <String> -ServiceBusMessage <String> -ServiceBusSasKeyName <String> - -ServiceBusSasKeyValue <String> [-StartTime <DateTime>] [-Interval <Int32>] [-Frequency <String>] - [-EndTime <DateTime>] [-ExecutionCount <Int32>] [-JobState <String>] [-ErrorActionType <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSchedulerServiceBusQueueJob** cmdlet modifies a service bus queue job in Azure Scheduler. -This cmdlet supports dynamic parameters based on the *ErrorActionType* parameter. -Dynamic parameters become available based on other parameter values. -To discover the names of dynamic parameters after you specify the other parameters, type a hyphen (-), and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndTime -Specifies an end time, as a **DateTime** object, for the job. -To obtain a **DateTime** object, use the Get-Date cmdlet. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ErrorActionType -Specifies an error action setting for the job. -The acceptable values for this parameter are: -- Http -- Https -- StorageQueue -- ServiceBusQueue -- ServiceBusTopic - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Http, Https, StorageQueue, ServiceBusQueue, ServiceBusTopic - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExecutionCount -Specifies how many times the job runs. -By default, a job recurs indefinitely. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Frequency -Specifies a frequency for the job. -The acceptable values for this parameter are: -- Minute -- Hour -- Day -- Week -- Month - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Minute, Hour, Day, Week, Month - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Interval -Specifies an interval of recurrence for the job. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobCollectionName -Specifies the name of the job collection to which the job belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -JobName -Specifies the name of the job that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -JobState -Specifies the state of the job. -The acceptable values for this parameter are: -- Enabled -- Disabled - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group to which the job belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceBusMessage -Specifies a service bus queue message. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceBusNamespace -Specifies a service bus namespace. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceBusQueueName -Specifies a service bus queue name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceBusSasKeyName -Specifies a shared access signature key name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceBusSasKeyValue -Specifies a shared access signature key value. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceBusTransportType -Specifies a service bus transport type. -The acceptable values for this parameter are: -- NetMessaging -- AMQP - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: NetMessaging, AMQP - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Specifies the start time, as a **DateTime** object, for the job. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Scheduler.Models.PSSchedulerJobDefinition - -## NOTES - -## RELATED LINKS - -[New-AzureRmSchedulerHttpJob](./New-AzureRmSchedulerHttpJob.md) - -[New-AzureRmSchedulerJobCollection](./New-AzureRmSchedulerJobCollection.md) - -[New-AzureRmSchedulerServiceBusQueueJob](./New-AzureRmSchedulerServiceBusQueueJob.md) - -[New-AzureRmSchedulerServiceBusTopicJob](./New-AzureRmSchedulerServiceBusTopicJob.md) - -[New-AzureRmSchedulerStorageQueueJob](./New-AzureRmSchedulerStorageQueueJob.md) - -[Set-AzureRmSchedulerHttpJob](./Set-AzureRmSchedulerHttpJob.md) - -[Set-AzureRmSchedulerJobCollection](./Set-AzureRmSchedulerJobCollection.md) - -[Set-AzureRmSchedulerServiceBusTopicJob](./Set-AzureRmSchedulerServiceBusTopicJob.md) - -[Set-AzureRmSchedulerStorageQueueJob](./Set-AzureRmSchedulerStorageQueueJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.Scheduler/Set-AzureRmSchedulerServiceBusTopicJob.md b/azurermps-6.13.0/AzureRM.Scheduler/Set-AzureRmSchedulerServiceBusTopicJob.md deleted file mode 100644 index b69da31bf8..0000000000 --- a/azurermps-6.13.0/AzureRM.Scheduler/Set-AzureRmSchedulerServiceBusTopicJob.md +++ /dev/null @@ -1,383 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Scheduler.dll-Help.xml -Module Name: AzureRM.Scheduler -ms.assetid: F6B24F96-6016-4645-9F92-F584B73657D5 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.scheduler/set-azurermschedulerservicebustopicjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/Set-AzureRmSchedulerServiceBusTopicJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/Set-AzureRmSchedulerServiceBusTopicJob.md ---- - -# Set-AzureRmSchedulerServiceBusTopicJob - -## SYNOPSIS -Modifies a service bus topic job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSchedulerServiceBusTopicJob -ResourceGroupName <String> -JobCollectionName <String> - -JobName <String> -ServiceBusTopicPath <String> -ServiceBusNamespace <String> - -ServiceBusTransportType <String> -ServiceBusMessage <String> -ServiceBusSasKeyName <String> - -ServiceBusSasKeyValue <String> [-StartTime <DateTime>] [-Interval <Int32>] [-Frequency <String>] - [-EndTime <DateTime>] [-ExecutionCount <Int32>] [-JobState <String>] [-ErrorActionType <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSchedulerServiceBusTopicJob** cmdlet modifies a service bus topic job in Azure Scheduler. -This cmdlet supports dynamic parameters based on the *ErrorActionType* parameter. -Dynamic parameters become available based on other parameter values. -To discover the names of dynamic parameters after you specify the other parameters, type a hyphen (-), and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndTime -Specifies an end time, as a **DateTime** object, for the job. -To obtain a **DateTime** object, use the Get-Date cmdlet. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ErrorActionType -Specifies an error action setting for the job. -The acceptable values for this parameter are: -- Http -- Https -- StorageQueue -- ServiceBusQueue -- ServiceBusTopic - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Http, Https, StorageQueue, ServiceBusQueue, ServiceBusTopic - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExecutionCount -Specifies how many times the job runs. -By default, a job recurs indefinitely. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Frequency -Specifies a maximum frequency for the job. -The acceptable values for this parameter are: -- Minute -- Hour -- Day -- Week -- Month - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Minute, Hour, Day, Week, Month - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Interval -Specifies an interval of recurrence for the job. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobCollectionName -Specifies the name of the job collection to which the job belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -JobName -Specifies the name of the job that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -JobState -Specifies the state of the job. -The acceptable values for this parameter are: -- Enabled -- Disabled - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group to which the job belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceBusMessage -Specifies a service bus topic message. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceBusNamespace -Specifies a service bus namespace. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceBusSasKeyName -Specifies a shared access signature key name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceBusSasKeyValue -Specifies a shared access signature key value. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceBusTopicPath -Specifies a service bus topic path. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceBusTransportType -Specifies a service bus transport type. -The acceptable values for this parameter are: -- NetMessaging -- AMQP - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: NetMessaging, AMQP - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Specifies the start time, as a **DateTime** object, for the job. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Scheduler.Models.PSSchedulerJobDefinition - -## NOTES - -## RELATED LINKS - -[New-AzureRmSchedulerHttpJob](./New-AzureRmSchedulerHttpJob.md) - -[New-AzureRmSchedulerJobCollection](./New-AzureRmSchedulerJobCollection.md) - -[New-AzureRmSchedulerServiceBusQueueJob](./New-AzureRmSchedulerServiceBusQueueJob.md) - -[New-AzureRmSchedulerServiceBusTopicJob](./New-AzureRmSchedulerServiceBusTopicJob.md) - -[New-AzureRmSchedulerStorageQueueJob](./New-AzureRmSchedulerStorageQueueJob.md) - -[Set-AzureRmSchedulerHttpJob](./Set-AzureRmSchedulerHttpJob.md) - -[Set-AzureRmSchedulerJobCollection](./Set-AzureRmSchedulerJobCollection.md) - -[Set-AzureRmSchedulerServiceBusQueueJob](./Set-AzureRmSchedulerServiceBusQueueJob.md) - -[Set-AzureRmSchedulerStorageQueueJob](./Set-AzureRmSchedulerStorageQueueJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.Scheduler/Set-AzureRmSchedulerStorageQueueJob.md b/azurermps-6.13.0/AzureRM.Scheduler/Set-AzureRmSchedulerStorageQueueJob.md deleted file mode 100644 index e2a1e82b32..0000000000 --- a/azurermps-6.13.0/AzureRM.Scheduler/Set-AzureRmSchedulerStorageQueueJob.md +++ /dev/null @@ -1,348 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Scheduler.dll-Help.xml -Module Name: AzureRM.Scheduler -ms.assetid: 75AF57EE-C7C3-42DE-AFD7-4B5150EEDBB6 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.scheduler/set-azurermschedulerstoragequeuejob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/Set-AzureRmSchedulerStorageQueueJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Scheduler/Commands.Scheduler/help/Set-AzureRmSchedulerStorageQueueJob.md ---- - -# Set-AzureRmSchedulerStorageQueueJob - -## SYNOPSIS -Modifies a storage queue job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSchedulerStorageQueueJob -ResourceGroupName <String> -JobCollectionName <String> -JobName <String> - [-StorageQueueAccount <String>] [-StorageQueueName <String>] [-StorageSASToken <String>] - [-StorageQueueMessage <String>] [-StartTime <DateTime>] [-Interval <Int32>] [-Frequency <String>] - [-EndTime <DateTime>] [-ExecutionCount <Int32>] [-JobState <String>] [-ErrorActionType <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSchedulerStorageQueueJob** cmdlet modifies a storage queue job in Azure Scheduler. -This cmdlet supports dynamic parameters based on the *ErrorActionType* parameter. -Dynamic parameters become available based on other parameter values. -To discover the names of dynamic parameters after you specify the other parameters, type a hyphen (-), and then press the Tab key repeatedly to cycle through the available parameters. -If you omit a required parameter, the cmdlet prompts you for the value. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndTime -Specifies an end time, as a **DateTime** object, for the job. -To obtain a **DateTime** object, use the Get-Date cmdlet. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ErrorActionType -Specifies an error action setting for the job. -The acceptable values for this parameter are: -- Http -- Https -- StorageQueue -- ServiceBusQueue -- ServiceBusTopic - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Http, Https, StorageQueue, ServiceBusQueue, ServiceBusTopic - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExecutionCount -Specifies how many times the job runs. -By default, a job recurs indefinitely. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Frequency -Specifies a frequency for the job. -The acceptable values for this parameter are: -- Minute -- Hour -- Day -- Week -- Month - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Minute, Hour, Day, Week, Month - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Interval -Specifies an interval of recurrence for the job. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobCollectionName -Specifies the name of the job collection to which the job belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -JobName -Specifies the name of the job that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -JobState -Specifies the state of the job. -The acceptable values for this parameter are: -- Enabled -- Disabled - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group to which the job belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartTime -Specifies the start time, as a **DateTime** object, for the job. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageQueueAccount -Specifies a storage account name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageQueueMessage -Specifies a queue message for storage job. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageQueueName -Specifies a storage queue name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageSASToken -Specifies a shared access signature token for a storage queue. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Scheduler.Models.PSSchedulerJobDefinition - -## NOTES - -## RELATED LINKS - -[New-AzureRmSchedulerHttpJob](./New-AzureRmSchedulerHttpJob.md) - -[New-AzureRmSchedulerJobCollection](./New-AzureRmSchedulerJobCollection.md) - -[New-AzureRmSchedulerServiceBusQueueJob](./New-AzureRmSchedulerServiceBusQueueJob.md) - -[New-AzureRmSchedulerServiceBusTopicJob](./New-AzureRmSchedulerServiceBusTopicJob.md) - -[New-AzureRmSchedulerStorageQueueJob](./New-AzureRmSchedulerStorageQueueJob.md) - -[Set-AzureRmSchedulerHttpJob](./Set-AzureRmSchedulerHttpJob.md) - -[Set-AzureRmSchedulerJobCollection](./Set-AzureRmSchedulerJobCollection.md) - -[Set-AzureRmSchedulerServiceBusQueueJob](./Set-AzureRmSchedulerServiceBusQueueJob.md) - -[Set-AzureRmSchedulerServiceBusTopicJob](./Set-AzureRmSchedulerServiceBusTopicJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.Search/AzureRM.Search.md b/azurermps-6.13.0/AzureRM.Search/AzureRM.Search.md deleted file mode 100644 index 8041b10e8c..0000000000 --- a/azurermps-6.13.0/AzureRM.Search/AzureRM.Search.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -Module Name: AzureRM.Search -Module Guid: a2bb88dc-abd2-4275-9aae-bd98346f8c8a -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.search -Help Version: 0.1.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Search/Commands.Management.Search/help/AzureRM.Search.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Search/Commands.Management.Search/help/AzureRM.Search.md ---- - -# AzureRM.Search Module -## Description -This topic displays help topics for the Azure Search Cmdlets. - -## AzureRM.Search Cmdlets -### [Get-AzureRmSearchAdminKeyPair](Get-AzureRmSearchAdminKeyPair.md) -Gets admin key pair of the Azure Search service. - -### [Get-AzureRmSearchQueryKey](Get-AzureRmSearchQueryKey.md) -Gets query key(s) of the Azure Search service. - -### [Get-AzureRmSearchService](Get-AzureRmSearchService.md) -Gets an Azure Search service. - -### [New-AzureRmSearchAdminKey](New-AzureRmSearchAdminKey.md) -Regenerates an admin key of the Azure Search service. - -### [New-AzureRmSearchQueryKey](New-AzureRmSearchQueryKey.md) -Create a new query key for the Azure Search service. - -### [New-AzureRmSearchService](New-AzureRmSearchService.md) -Creates an Azure Search service. - -### [Remove-AzureRmSearchQueryKey](Remove-AzureRmSearchQueryKey.md) -Remove the query key from the Azure Search service. - -### [Remove-AzureRmSearchService](Remove-AzureRmSearchService.md) -Remove an Azure Search service. - -### [Set-AzureRmSearchService](Set-AzureRmSearchService.md) -Update an Azure Search service. - diff --git a/azurermps-6.13.0/AzureRM.Search/Get-AzureRmSearchAdminKeyPair.md b/azurermps-6.13.0/AzureRM.Search/Get-AzureRmSearchAdminKeyPair.md deleted file mode 100644 index 6c3836c340..0000000000 --- a/azurermps-6.13.0/AzureRM.Search/Get-AzureRmSearchAdminKeyPair.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Search.dll-Help.xml -Module Name: AzureRM.Search -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.search/get-azurermsearchadminkeypair -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Search/Commands.Management.Search/help/Get-AzureRmSearchAdminKeyPair.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Search/Commands.Management.Search/help/Get-AzureRmSearchAdminKeyPair.md ---- - -# Get-AzureRmSearchAdminKeyPair - -## SYNOPSIS -Gets admin key pair of the Azure Search service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceNameParameterSet (Default) -``` -Get-AzureRmSearchAdminKeyPair [-ResourceGroupName] <String> [-ServiceName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ParentObjectParameterSet -``` -Get-AzureRmSearchAdminKeyPair [-ParentObject] <PSSearchService> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ParentResourceIdParameterSet -``` -Get-AzureRmSearchAdminKeyPair [-ParentResourceId] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSearchAdminKeyPair** cmdlet gets the admin key pair of the Azure Search service. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmSearchAdminKeyPair -ResourceGroupName felixwa-01 -ServiceName felixwa-basic-search - -Primary Secondary -------- --------- -3B06A25BDADFF72EC132736BAA2547A1 E643B75A52E04DF13EB690807C451C55 -``` - -The example gets admin key pair of the Azure Search service. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParentObject -Search Service Input Object. - -```yaml -Type: Microsoft.Azure.Commands.Management.Search.Models.PSSearchService -Parameter Sets: ParentObjectParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ParentResourceId -Search Service Resource Id. - -```yaml -Type: System.String -Parameter Sets: ParentResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group name. - -```yaml -Type: System.String -Parameter Sets: ResourceNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceName -Search Service name. - -```yaml -Type: System.String -Parameter Sets: ResourceNameParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.Search.Models.PSSearchService -Parameters: ParentObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.Search.Models.PSSearchAdminKey - -## NOTES - -## RELATED LINKS - -[New-AzureRmSearchAdminKey](./New-AzureRmSearchAdminKey.md) diff --git a/azurermps-6.13.0/AzureRM.Search/Get-AzureRmSearchQueryKey.md b/azurermps-6.13.0/AzureRM.Search/Get-AzureRmSearchQueryKey.md deleted file mode 100644 index 3d6a6ec236..0000000000 --- a/azurermps-6.13.0/AzureRM.Search/Get-AzureRmSearchQueryKey.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Search.dll-Help.xml -Module Name: AzureRM.Search -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.search/get-azurermsearchquerykey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Search/Commands.Management.Search/help/Get-AzureRmSearchQueryKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Search/Commands.Management.Search/help/Get-AzureRmSearchQueryKey.md ---- - -# Get-AzureRmSearchQueryKey - -## SYNOPSIS -Gets query key(s) of the Azure Search service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceNameParameterSet (Default) -``` -Get-AzureRmSearchQueryKey [-ResourceGroupName] <String> [-ServiceName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ParentObjectParameterSet -``` -Get-AzureRmSearchQueryKey [-ParentObject] <PSSearchService> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ParentResourceIdParameterSet -``` -Get-AzureRmSearchQueryKey [-ParentResourceId] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSearchQueryKey** cmdlet gets query key(s) of the Azure Search service. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmSearchQueryKey -ResourceGroupName "TestAzureSearchPsGroup" -ServiceName "pstestazuresearch01" - -Name Key ----- --- - 896AA09C167541072D404E1BE0442CE9 -``` - -The example gets all query key(s) of the Azure Search Service. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParentObject -Search Service Input Object. - -```yaml -Type: Microsoft.Azure.Commands.Management.Search.Models.PSSearchService -Parameter Sets: ParentObjectParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ParentResourceId -Search Service Resource Id. - -```yaml -Type: System.String -Parameter Sets: ParentResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group name. - -```yaml -Type: System.String -Parameter Sets: ResourceNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceName -Search Service name. - -```yaml -Type: System.String -Parameter Sets: ResourceNameParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.Search.Models.PSSearchService -Parameters: ParentObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.Search.Models.PSSearchQueryKey - -## NOTES - -## RELATED LINKS - -[New-AzureRmSearchQueryKey.md](./New-AzureRmSearchQueryKey.md) - -[Remove-AzureRmSearchQueryKey.md](./Remove-AzureRmSearchQueryKey.md) diff --git a/azurermps-6.13.0/AzureRM.Search/Get-AzureRmSearchService.md b/azurermps-6.13.0/AzureRM.Search/Get-AzureRmSearchService.md deleted file mode 100644 index 4ef7369652..0000000000 --- a/azurermps-6.13.0/AzureRM.Search/Get-AzureRmSearchService.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Search.dll-Help.xml -Module Name: AzureRM.Search -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.search/get-azurermsearchservice -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Search/Commands.Management.Search/help/Get-AzureRmSearchService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Search/Commands.Management.Search/help/Get-AzureRmSearchService.md ---- - -# Get-AzureRmSearchService - -## SYNOPSIS -Gets an Azure Search service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceGroupParameterSet (Default) -``` -Get-AzureRmSearchService [-ResourceGroupName] <String> [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Get-AzureRmSearchService [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSearchService** cmdlet gets the specified Azure Search service. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmSearchService -ResourceGroupName felixwa-01 - - -ResourceGroupName : felixwa-01 -Name : felixwa-basic-search -Location : West US -Sku : Basic -ReplicaCount : 1 -PartitionCount : 1 -HostingMode : Default -Id : /subscriptions/f9b96b36-1f5e-4021-8959-51527e26e6d3/resourceGroups/felixwa-01/providers/Microsoft.Search/searchServices/felixwa-basic-search -``` - -Get an Azure Search service with specified parameters. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Search Service name. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupParameterSet -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group name. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Search Service Resource Id. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.Search.Models.PSSearchService - -## NOTES - -## RELATED LINKS - -[New-AzureRmSearchService](./New-AzureRmSearchService.md) - -[Set-AzureRmSearchService](./Set-AzureRmSearchService.md) - -[Remove-AzureRmSearchService](./Remove-AzureRmSearchService.md) diff --git a/azurermps-6.13.0/AzureRM.Search/New-AzureRmSearchAdminKey.md b/azurermps-6.13.0/AzureRM.Search/New-AzureRmSearchAdminKey.md deleted file mode 100644 index ce512a7911..0000000000 --- a/azurermps-6.13.0/AzureRM.Search/New-AzureRmSearchAdminKey.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Search.dll-Help.xml -Module Name: AzureRM.Search -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.search/new-azurermsearchadminkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Search/Commands.Management.Search/help/New-AzureRmSearchAdminKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Search/Commands.Management.Search/help/New-AzureRmSearchAdminKey.md ---- - -# New-AzureRmSearchAdminKey - -## SYNOPSIS -Regenerates an admin key of the Azure Search service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceNameParameterSet (Default) -``` -New-AzureRmSearchAdminKey [-ResourceGroupName] <String> [-ServiceName] <String> -KeyKind <PSSearchAdminKeyKind> - [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ParentObjectParameterSet -``` -New-AzureRmSearchAdminKey [-ParentObject] <PSSearchService> -KeyKind <PSSearchAdminKeyKind> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ParentResourceIdParameterSet -``` -New-AzureRmSearchAdminKey [-ParentResourceId] <String> -KeyKind <PSSearchAdminKeyKind> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmSearchAdminKey** cmdlet regenerates an admin key of the Azure Search service. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-AzureRmSearchAdminKey -ResourceGroupName "TestAzureSearchPsGroup" -ServiceName "pstestazuresearch01" -KeyKind Primary - -Confirm -Are you sure you want to regenerate 'Primary' key for Search Service 'pstestazuresearch01'? -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y - -Primary Secondary -------- --------- -85B3813D11904B591BE8A196C2C743A1 CEF791D5BAC2E6C0B232C56702F21E87 -``` - -The example regenerates Primary key of the Azure Search Service. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyKind -Search Service admin key kind (Primary/Secondary). - -```yaml -Type: Microsoft.Azure.Commands.Management.Search.Models.PSSearchAdminKeyKind -Parameter Sets: (All) -Aliases: -Accepted values: Primary, Secondary - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParentObject -Search Service Input Object. - -```yaml -Type: Microsoft.Azure.Commands.Management.Search.Models.PSSearchService -Parameter Sets: ParentObjectParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ParentResourceId -Search Service Resource Id. - -```yaml -Type: System.String -Parameter Sets: ParentResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group name. - -```yaml -Type: System.String -Parameter Sets: ResourceNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceName -Search Service name. - -```yaml -Type: System.String -Parameter Sets: ResourceNameParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.Search.Models.PSSearchService -Parameters: ParentObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.Search.Models.PSSearchAdminKey - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSearchAdminKeyPair](./Get-AzureRmSearchAdminKeyPair.md) diff --git a/azurermps-6.13.0/AzureRM.Search/New-AzureRmSearchQueryKey.md b/azurermps-6.13.0/AzureRM.Search/New-AzureRmSearchQueryKey.md deleted file mode 100644 index 21a71557c3..0000000000 --- a/azurermps-6.13.0/AzureRM.Search/New-AzureRmSearchQueryKey.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Search.dll-Help.xml -Module Name: AzureRM.Search -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.search/new-azurermsearchquerykey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Search/Commands.Management.Search/help/New-AzureRmSearchQueryKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Search/Commands.Management.Search/help/New-AzureRmSearchQueryKey.md ---- - -# New-AzureRmSearchQueryKey - -## SYNOPSIS -Create a new query key for the Azure Search service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceNameParameterSet (Default) -``` -New-AzureRmSearchQueryKey [-ResourceGroupName] <String> [-ServiceName] <String> -Name <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ParentObjectParameterSet -``` -New-AzureRmSearchQueryKey [-ParentObject] <PSSearchService> -Name <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ParentResourceIdParameterSet -``` -New-AzureRmSearchQueryKey [-ParentResourceId] <String> -Name <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmSearchQueryKey** cmdlet creates a new query key for the Azure Search Service. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-AzureRmSearchQueryKey -ResourceGroupName "TestAzureSearchPsGroup" -ServiceName "pstestazuresearch01" -Name "NewQueryKey1" -Force - -Name Key ----- --- -NewQueryKey1 65FBCF561228C5F0E01F8F2114C80459 -``` - -The example creates a new query key for the Azure Search service. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Search Service query key name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParentObject -Search Service Input Object. - -```yaml -Type: Microsoft.Azure.Commands.Management.Search.Models.PSSearchService -Parameter Sets: ParentObjectParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ParentResourceId -Search Service Resource Id. - -```yaml -Type: System.String -Parameter Sets: ParentResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group name. - -```yaml -Type: System.String -Parameter Sets: ResourceNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceName -Search Service name. - -```yaml -Type: System.String -Parameter Sets: ResourceNameParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.Search.Models.PSSearchService -Parameters: ParentObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.Search.Models.PSSearchQueryKey - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSearchQueryKey.md](./Get-AzureRmSearchQueryKey.md) - -[Remove-AzureRmSearchQueryKey.md](./Remove-AzureRmSearchQueryKey.md) diff --git a/azurermps-6.13.0/AzureRM.Search/New-AzureRmSearchService.md b/azurermps-6.13.0/AzureRM.Search/New-AzureRmSearchService.md deleted file mode 100644 index 4114387cd5..0000000000 --- a/azurermps-6.13.0/AzureRM.Search/New-AzureRmSearchService.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Search.dll-Help.xml -Module Name: AzureRM.Search -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.search/new-azurermsearchservice -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Search/Commands.Management.Search/help/New-AzureRmSearchService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Search/Commands.Management.Search/help/New-AzureRmSearchService.md ---- - -# New-AzureRmSearchService - -## SYNOPSIS -Creates an Azure Search service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmSearchService [-ResourceGroupName] <String> [-Name] <String> [-Sku] <PSSkuName> [-Location] <String> - [-PartitionCount <Int32>] [-ReplicaCount <Int32>] [-HostingMode <PSHostingMode>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmSearchService** cmdlet creates an Azure Search service with specified parameters. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-AzureRmSearchService -ResourceGroupName "TestAzureSearchPsGroup" -Name "pstestazuresearch01" -Sku "Standard" -Location "West US" -PartitionCount 1 -ReplicaCount 1 -HostingMode Default -Force - - -ResourceGroupName : TestAzureSearchPsGroup -Name : pstestazuresearch01 -Id : /subscriptions/f9b96b36-1f5e-4021-8959-51527e26e6d3/resourceGroups/TestAzureSearchPsGroup/providers/Microsoft.Search/searchServices/pstestazuresearch01 -Location : West US -Sku : Standard -ReplicaCount : 1 -PartitionCount : 1 -HostingMode : Default -Tags : -``` - -The command creates an Azure Search service. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostingMode -Search Service hosting mode. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Commands.Management.Search.Models.PSHostingMode] -Parameter Sets: (All) -Aliases: -Accepted values: Default, HighDensity - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Search Service location. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Search Service name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PartitionCount -Search Service partition count. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicaCount -Search Service replica count. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sku -Search Service Sku. - -```yaml -Type: Microsoft.Azure.Commands.Management.Search.Models.PSSkuName -Parameter Sets: (All) -Aliases: -Accepted values: Free, Basic, Standard, Standard2, Standard3 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.Search.Models.PSSearchService - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSearchService](./Get-AzureRmSearchService.md) - -[Set-AzureRmSearchService](./Set-AzureRmSearchService.md) - -[Remove-AzureRmSearchService](./Remove-AzureRmSearchService.md) diff --git a/azurermps-6.13.0/AzureRM.Search/Remove-AzureRmSearchQueryKey.md b/azurermps-6.13.0/AzureRM.Search/Remove-AzureRmSearchQueryKey.md deleted file mode 100644 index c0235f113d..0000000000 --- a/azurermps-6.13.0/AzureRM.Search/Remove-AzureRmSearchQueryKey.md +++ /dev/null @@ -1,234 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Search.dll-Help.xml -Module Name: AzureRM.Search -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.search/remove-azurermsearchquerykey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Search/Commands.Management.Search/help/Remove-AzureRmSearchQueryKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Search/Commands.Management.Search/help/Remove-AzureRmSearchQueryKey.md ---- - -# Remove-AzureRmSearchQueryKey - -## SYNOPSIS -Remove the query key from the Azure Search service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceNameParameterSet (Default) -``` -Remove-AzureRmSearchQueryKey [-ResourceGroupName] <String> [-ServiceName] <String> -KeyValue <String> [-Force] - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ParentObjectParameterSet -``` -Remove-AzureRmSearchQueryKey [-ParentObject] <PSSearchService> -KeyValue <String> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ParentResourceIdParameterSet -``` -Remove-AzureRmSearchQueryKey [-ParentResourceId] <String> -KeyValue <String> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmSearchQueryKey** cmdlet removes the query key from the Azure Search service. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmSearchQueryKey -ResourceGroupName "TestAzureSearchPsGroup" -ServiceName "pstestazuresearch01" - -Name Key ----- --- - D260F448EA192EBC19D59F7E5670E8BB -NewQueryKey1 B4C13E3F6FA76100D3488673CFDCD438 - -PS C:\> Remove-AzureRmSearchQueryKey -ResourceGroupName "TestAzureSearchPsGroup" -ServiceName "pstestazuresearch01" -KeyValue B4C13E3F6FA76100D3488673CFDCD438 - -Confirm -Are you sure you want to remove query key 'B4C13E3F6FA76100D3488673CFDCD438'? -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y -PS C:\> -``` - -The example removes the query key from the Azure Search service. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyValue -Search Service query key value. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParentObject -Search Service Input Object. - -```yaml -Type: Microsoft.Azure.Commands.Management.Search.Models.PSSearchService -Parameter Sets: ParentObjectParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ParentResourceId -Search Service Resource Id. - -```yaml -Type: System.String -Parameter Sets: ParentResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -This Cmdlet does not return an object by default. If this switch is specified, it returns true if successful. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group name. - -```yaml -Type: System.String -Parameter Sets: ResourceNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceName -Search Service name. - -```yaml -Type: System.String -Parameter Sets: ResourceNameParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.Search.Models.PSSearchService -Parameters: ParentObject (ByValue) - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[New-AzureRmSearchQueryKey.md](./New-AzureRmSearchQueryKey.md) - -[Get-AzureRmSearchQueryKey.md](./Get-AzureRmSearchQueryKey.md) diff --git a/azurermps-6.13.0/AzureRM.Search/Remove-AzureRmSearchService.md b/azurermps-6.13.0/AzureRM.Search/Remove-AzureRmSearchService.md deleted file mode 100644 index 683e5483fb..0000000000 --- a/azurermps-6.13.0/AzureRM.Search/Remove-AzureRmSearchService.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Search.dll-Help.xml -Module Name: AzureRM.Search -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.search/remove-azurermsearchservice -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Search/Commands.Management.Search/help/Remove-AzureRmSearchService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Search/Commands.Management.Search/help/Remove-AzureRmSearchService.md ---- - -# Remove-AzureRmSearchService - -## SYNOPSIS -Remove an Azure Search service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceNameParameterSet (Default) -``` -Remove-AzureRmSearchService [-ResourceGroupName] <String> [-Name] <String> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectParameterSet -``` -Remove-AzureRmSearchService [-InputObject] <PSSearchService> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Remove-AzureRmSearchService [-ResourceId] <String> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmSearchService** cmdlet removes an Azure Search service with specified paramters. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-AzureRmSearchService -ResourceGroupName "TestAzureSearchPsGroup" -Name "pstestazuresearch01" - -Confirm -Are you sure you want to remove Search Service 'pstestazuresearch01'? -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y -PS C:\> -``` - -The example removes an Azure Search service. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Search Service Input Object. - -```yaml -Type: Microsoft.Azure.Commands.Management.Search.Models.PSSearchService -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Search Service name. - -```yaml -Type: System.String -Parameter Sets: ResourceNameParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -This Cmdlet does not return an object by default. If this switch is specified, it returns true if successful. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group name. - -```yaml -Type: System.String -Parameter Sets: ResourceNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Search Service Resource Id. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.Search.Models.PSSearchService -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[New-AzureRmSearchService](./New-AzureRmSearchService.md) - -[Get-AzureRmSearchService](./Get-AzureRmSearchService.md) - -[Set-AzureRmSearchService](./Set-AzureRmSearchService.md) - diff --git a/azurermps-6.13.0/AzureRM.Search/Set-AzureRmSearchService.md b/azurermps-6.13.0/AzureRM.Search/Set-AzureRmSearchService.md deleted file mode 100644 index 7ad3678d12..0000000000 --- a/azurermps-6.13.0/AzureRM.Search/Set-AzureRmSearchService.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Search.dll-Help.xml -Module Name: AzureRM.Search -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.search/set-azurermsearchservice -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Search/Commands.Management.Search/help/Set-AzureRmSearchService.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Search/Commands.Management.Search/help/Set-AzureRmSearchService.md ---- - -# Set-AzureRmSearchService - -## SYNOPSIS -Update an Azure Search service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceNameParameterSet (Default) -``` -Set-AzureRmSearchService [-ResourceGroupName] <String> [-Name] <String> [-PartitionCount <Int32>] - [-ReplicaCount <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectParameterSet -``` -Set-AzureRmSearchService [-InputObject] <PSSearchService> [-PartitionCount <Int32>] [-ReplicaCount <Int32>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Set-AzureRmSearchService [-ResourceId] <String> [-PartitionCount <Int32>] [-ReplicaCount <Int32>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSearchService** cmdlet modifies an Azure Search service. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Set-AzureRmSearchService -ResourceGroupName "TestAzureSearchPsGroup" -Name "pstestazuresearch01" -PartitionCount 2 -ReplicaCount 2 - - -ResourceGroupName : TestAzureSearchPsGroup -Name : pstestazuresearch01 -Id : /subscriptions/f9b96b36-1f5e-4021-8959-51527e26e6d3/resourceGroups/TestAzureSearchPsGroup/providers/Microsoft.Search/searchServices/pstestazuresearch01 -Location : West US -Sku : Standard -ReplicaCount : 2 -PartitionCount : 2 -HostingMode : Default -Tags : -``` - -The example changes partition count and replica count of the Azure Search service to 2. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Search Service Input Object. - -```yaml -Type: Microsoft.Azure.Commands.Management.Search.Models.PSSearchService -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Search Service name. - -```yaml -Type: System.String -Parameter Sets: ResourceNameParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PartitionCount -Search Service partition count. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicaCount -Search Service replica count. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group name. - -```yaml -Type: System.String -Parameter Sets: ResourceNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Search Service Resource Id. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Management.Search.Models.PSSearchService -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.Search.Models.PSSearchService - -## NOTES - -## RELATED LINKS - -[New-AzureRmSearchService](./New-AzureRmSearchService.md) - -[Get-AzureRmSearchService](./Get-AzureRmSearchService.md) - -[Remove-AzureRmSearchService](./Remove-AzureRmSearchService.md) diff --git a/azurermps-6.13.0/AzureRM.Security/AzureRM.Security.md b/azurermps-6.13.0/AzureRM.Security/AzureRM.Security.md deleted file mode 100644 index 4ca6e02764..0000000000 --- a/azurermps-6.13.0/AzureRM.Security/AzureRM.Security.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -Module Name: AzureRM.Security -Module Guid: 5e312bb4-9d3a-4c88-94c3-8e5bbb2e3da4 -Download Help Link: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/AzureRM.Security.md -Help Version: 0.1.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/AzureRM.Security.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/AzureRM.Security.md ---- - -# AzureRM.Security Module -## Description -Azure Security Center gives you control over the security of your Azure subscriptions and other machines that you connected to it outside of Azure. - -## AzureRM.Security Cmdlets -### [Get-AzureRmDiscoveredSecuritySolution](Get-AzureRmDiscoveredSecuritySolution.md) -Gets security solutions that were discovered by Azure Security Center - -### [Get-AzureRmExternalSecuritySolution](Get-AzureRmExternalSecuritySolution.md) -Get external security solution - -### [Get-AzureRmJitNetworkAccessPolicy](Get-AzureRmJitNetworkAccessPolicy.md) -Gets the JIT network access policies - -### [Get-AzureRmSecurityAlert](Get-AzureRmSecurityAlert.md) -Gets security alerts that were detected by Azure Security Center - -### [Get-AzureRmSecurityAutoProvisioningSetting](Get-AzureRmSecurityAutoProvisioningSetting.md) -Gets the security automatic provisioning settings - -### [Get-AzureRmSecurityCompliance](Get-AzureRmSecurityCompliance.md) -Get the security compliance of a subscription over time - -### [Get-AzureRmSecurityContact](Get-AzureRmSecurityContact.md) -Gets security contacts that were configured on this subscription - -### [Get-AzureRmSecurityLocation](Get-AzureRmSecurityLocation.md) -Gets the location where Azure Security Center will automatically save data for the specific subscription - -### [Get-AzureRmSecurityPricing](Get-AzureRmSecurityPricing.md) -Gets the pricing tier data for Azure Security Center for a scope. - -### [Get-AzureRmSecurityTask](Get-AzureRmSecurityTask.md) -Gets the security tasks that Azure Security Center recommends you to do in order to strengthen your security posture. - -### [Get-AzureRmSecurityWorkspaceSetting](Get-AzureRmSecurityWorkspaceSetting.md) -Gets the configured security workspace settings on a subscription. - -### [Remove-AzureRmJitNetworkAccessPolicy](Remove-AzureRmJitNetworkAccessPolicy.md) -Deletes a JIT network access policy. - -### [Remove-AzureRmSecurityContact](Remove-AzureRmSecurityContact.md) -Deletes a security contact. - -### [Remove-AzureRmSecurityWorkspaceSetting](Remove-AzureRmSecurityWorkspaceSetting.md) -Deletes the security workspace setting for this subscription. - -### [Set-AzureRmJitNetworkAccessPolicy](Set-AzureRmJitNetworkAccessPolicy.md) -Updates JIT network access policy. - -### [Set-AzureRmSecurityAlert](Set-AzureRmSecurityAlert.md) -Updates a security alert state. - -### [Set-AzureRmSecurityAutoProvisioningSetting](Set-AzureRmSecurityAutoProvisioningSetting.md) -Updates automatic provisioning setting - -### [Set-AzureRmSecurityContact](Set-AzureRmSecurityContact.md) -Updates a security contact for a subscription. - -### [Set-AzureRmSecurityPricing](Set-AzureRmSecurityPricing.md) -Sets the pricing of Azure Security Center tier for a scope. - -### [Set-AzureRmSecurityWorkspaceSetting](Set-AzureRmSecurityWorkspaceSetting.md) -Updates the workspace settings for the subscription. - -### [Start-AzureRmJitNetworkAccessPolicy](Start-AzureRmJitNetworkAccessPolicy.md) -Invokes a temporary network access request. - diff --git a/azurermps-6.13.0/AzureRM.Security/Get-AzureRmDiscoveredSecuritySolution.md b/azurermps-6.13.0/AzureRM.Security/Get-AzureRmDiscoveredSecuritySolution.md deleted file mode 100644 index dbf1ed5686..0000000000 --- a/azurermps-6.13.0/AzureRM.Security/Get-AzureRmDiscoveredSecuritySolution.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.SecurityCenter.dll-Help.xml -Module Name: AzureRM.Security -online version: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Get-AzureRmDiscoveredSecuritySolution.md -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Get-AzureRmDiscoveredSecuritySolution.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Get-AzureRmDiscoveredSecuritySolution.md ---- - -# Get-AzureRmDiscoveredSecuritySolution - -## SYNOPSIS -Gets security solutions that were discovered by Azure Security Center - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SubscriptionScope (Default) -``` -Get-AzureRmDiscoveredSecuritySolution [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceGroupLevelResource -``` -Get-AzureRmDiscoveredSecuritySolution -ResourceGroupName <String> -Name <String> -Location <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceId -``` -Get-AzureRmDiscoveredSecuritySolution -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -Security solutions are automatically discovered by Azure Security Center, use this cmdlet to view the discovered security solutions - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmDiscoveredSecuritySolution -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Secu - rity/locations/centralus/discoveredSecuritySolutions/ContosoWAF2 -Name : ContosoWAF2 -Offer : -Publisher : microsoft -SecurityFamily : SaasWaf -Sku : -``` - -Get all the discovered security solutions in the subscription - -### Example 2 -```powershell -PS C:\> Get-AzureRmDiscoveredSecuritySolution -ResourceGroupName "myService1" -Location "centralus" -Name "ContosoWAF2" -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Secu - rity/locations/centralus/discoveredSecuritySolutions/ContosoWAF2 -Name : ContosoWAF2 -Offer : -Publisher : microsoft -SecurityFamily : SaasWaf -Sku : -``` - -Get a specific discovered security solution - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Location. - -```yaml -Type: String -Parameter Sets: ResourceGroupLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Resource name. - -```yaml -Type: String -Parameter Sets: ResourceGroupLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource group name. - -```yaml -Type: String -Parameter Sets: ResourceGroupLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID. - -```yaml -Type: String -Parameter Sets: ResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Security.Models.DiscoveredSecuritySolutions.PSSecurityDiscoveredSecuritySolution - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Security/Get-AzureRmExternalSecuritySolution.md b/azurermps-6.13.0/AzureRM.Security/Get-AzureRmExternalSecuritySolution.md deleted file mode 100644 index ecec3ac5e7..0000000000 --- a/azurermps-6.13.0/AzureRM.Security/Get-AzureRmExternalSecuritySolution.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.SecurityCenter.dll-Help.xml -Module Name: AzureRM.Security -online version: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Get-AzureRmExternalSecuritySolution.md -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Get-AzureRmExternalSecuritySolution.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Get-AzureRmExternalSecuritySolution.md ---- - -# Get-AzureRmExternalSecuritySolution - -## SYNOPSIS -Get external security solution - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SubscriptionScope (Default) -``` -Get-AzureRmExternalSecuritySolution [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceGroupLevelResource -``` -Get-AzureRmExternalSecuritySolution -ResourceGroupName <String> -Name <String> -Location <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SubscriptionLevelResource -``` -Get-AzureRmExternalSecuritySolution -Location <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ResourceId -``` -Get-AzureRmExternalSecuritySolution -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -Get external security solution - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmExternalSecuritySolution -ConnectivityState : Discovered -DeviceType : Azure Active Directory Identity Protection -DeviceVendor : microsoft -Workspace : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourcegroups/defaultresourcegroup-eus/provide - rs/microsoft.operationalinsights/workspaces/defaultworkspace-487bb485-b5b0-471e-9c0d-10717612f869-e - us -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/defaultresourcegroup-eus/provide - rs/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_defaultworkspace-487bb485-b - 5b0-471e-9c0d-10717612f869-eus -Name : aad_defaultworkspace-487bb485-b5b0-471e-9c0d-10717612f869-eus -Kind : AAD - -ConnectivityState : Discovered -DeviceType : Azure Active Directory Identity Protection -DeviceVendor : microsoft -Workspace : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourcegroups/defaultresourcegroup-weu/provide - rs/microsoft.operationalinsights/workspaces/defaultworkspace-487bb485-b5b0-471e-9c0d-10717612f869-w - eu -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/defaultresourcegroup-weu/provide - rs/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_defaultworkspace-487bb485-b - 5b0-471e-9c0d-10717612f869-weu -Name : aad_defaultworkspace-487bb485-b5b0-471e-9c0d-10717612f869-weu -Kind : AAD - -ConnectivityState : Discovered -DeviceType : Azure Active Directory Identity Protection -DeviceVendor : microsoft -Workspace : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourcegroups/mainws/providers/microsoft.opera - tionalinsights/workspaces/securityuserws -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/mainws/providers/Microsoft.Secur - ity/locations/centralus/externalSecuritySolutions/aad_securityuserws -Name : aad_securityuserws -Kind : AAD - -ConnectivityState : Discovered -DeviceType : Azure Active Directory Identity Protection -DeviceVendor : microsoft -Workspace : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourcegroups/myservice1/providers/microsoft.o - perationalinsights/workspaces/testservicews -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myservice1/providers/Microsoft.S - ecurity/locations/centralus/externalSecuritySolutions/aad_testservicews -Name : aad_testservicews -Kind : AAD -``` - -Get all the external security solutions in the subscription - -### Example 2 -```powershell -PS C:\> Get-AzureRmExternalSecuritySolution -ResourceGroupName "myservice1" -Location "centralus" -Name "aad_testservicews" -ConnectivityState : Discovered -DeviceType : Azure Active Directory Identity Protection -DeviceVendor : microsoft -Workspace : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourcegroups/myservice1/providers/microsoft.operationalinsights/workspaces/testservicews -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myservice1/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_testservicews -Name : aad_testservicews -Kind : AAD -``` - -Get a specific external security solution - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Location. - -```yaml -Type: String -Parameter Sets: ResourceGroupLevelResource, SubscriptionLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Resource name. - -```yaml -Type: String -Parameter Sets: ResourceGroupLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource group name. - -```yaml -Type: String -Parameter Sets: ResourceGroupLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID. - -```yaml -Type: String -Parameter Sets: ResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Security.Models.ExternalSecuritySolutions.PSSecurityExternalSecuritySolution - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Security/Get-AzureRmJitNetworkAccessPolicy.md b/azurermps-6.13.0/AzureRM.Security/Get-AzureRmJitNetworkAccessPolicy.md deleted file mode 100644 index e934092c34..0000000000 --- a/azurermps-6.13.0/AzureRM.Security/Get-AzureRmJitNetworkAccessPolicy.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.SecurityCenter.dll-Help.xml -Module Name: AzureRM.Security -online version: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Get-AzureRmJitNetworkAccessPolicy.md -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Get-AzureRmJitNetworkAccessPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Get-AzureRmJitNetworkAccessPolicy.md ---- - -# Get-AzureRmJitNetworkAccessPolicy - -## SYNOPSIS -Gets the JIT network access policies - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SubscriptionScope (Default) -``` -Get-AzureRmJitNetworkAccessPolicy [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceGroupScope -``` -Get-AzureRmJitNetworkAccessPolicy -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ResourceGroupLevelResource -``` -Get-AzureRmJitNetworkAccessPolicy -ResourceGroupName <String> -Location <String> -Name <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceId -``` -Get-AzureRmJitNetworkAccessPolicy -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -Just In Time (JIT) network access policies let you define a policy the will allow simple users to create a temporary network connection to a VM. -The policy defines what ports, protocol and source IP addresses can request a connection to a VM and the max duration before the connection will be closed automatically. -In the policy you can also see the connection request that were made with this policy. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmJitNetworkAccessPolicy -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/locations/centralus/jitNetworkAccessPolicies/default -Name : default -Kind : Basic -VirtualMachines : {/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Compute/virtualMachines/testService} -Requests : {Microsoft.Azure.Commands.Security.Models.JitNetworkAccessPolicies.PSSecurityJitNetworkAccessPolicyRequest} -ProvisioningState : Succeeded - -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/locations/northeurope/jitNetworkAccessPolicies/default -Name : default -Kind : Basic -VirtualMachines : {/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Compute/virtualMachines/testService} -Requests : {Microsoft.Azure.Commands.Security.Models.JitNetworkAccessPolicies.PSSecurityJitNetworkAccessPolicyRequest} -ProvisioningState : Succeeded -``` - -Get all the JIT network access polices on a subscription - -### Example 2 -```powershell -PS C:\> Get-AzureRmJitNetworkAccessPolicy -ResourceGroupName "myService1" -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/locations/centralus/jitNetworkAccessPolicies/default -Name : default -Kind : Basic -VirtualMachines : {/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Compute/virtualMachines/testService} -Requests : {Microsoft.Azure.Commands.Security.Models.JitNetworkAccessPolicies.PSSecurityJitNetworkAccessPolicyRequest} -ProvisioningState : Succeeded - -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/locations/northeurope/jitNetworkAccessPolicies/default -Name : default -Kind : Basic -VirtualMachines : {/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Compute/virtualMachines/testService} -Requests : {Microsoft.Azure.Commands.Security.Models.JitNetworkAccessPolicies.PSSecurityJitNetworkAccessPolicyRequest} -ProvisioningState : Succeeded -``` - -Get all the JIT network access polices on the "myService1" resource group - -### Example 3 -```powershell -PS C:\> Get-AzureRmJitNetworkAccessPolicy -ResourceGroupName "myService1" -Location "centralus" -Name "default" -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/locations/centralus/jitNetworkAccessPolicies/default -Name : default -Kind : Basic -VirtualMachines : {/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Compute/virtualMachines/testService} -Requests : {Microsoft.Azure.Commands.Security.Models.JitNetworkAccessPolicies.PSSecurityJitNetworkAccessPolicyRequest} -ProvisioningState : Succeeded -``` - -Gets a specific JIT network access policy - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Location. - -```yaml -Type: String -Parameter Sets: ResourceGroupLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Resource name. - -```yaml -Type: String -Parameter Sets: ResourceGroupLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource group name. - -```yaml -Type: String -Parameter Sets: ResourceGroupScope, ResourceGroupLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID. - -```yaml -Type: String -Parameter Sets: ResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Security.Models.JitNetworkAccessPolicies.PSSecurityJitNetworkAccessPolicy - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Security/Get-AzureRmSecurityAlert.md b/azurermps-6.13.0/AzureRM.Security/Get-AzureRmSecurityAlert.md deleted file mode 100644 index 66f01b8930..0000000000 --- a/azurermps-6.13.0/AzureRM.Security/Get-AzureRmSecurityAlert.md +++ /dev/null @@ -1,446 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.SecurityCenter.dll-Help.xml -Module Name: AzureRM.Security -online version: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Get-AzureRmSecurityAlert.md -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Get-AzureRmSecurityAlert.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Get-AzureRmSecurityAlert.md ---- - -# Get-AzureRmSecurityAlert - -## SYNOPSIS -Gets security alerts that were detected by Azure Security Center - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SubscriptionScope (Default) -``` -Get-AzureRmSecurityAlert [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceGroupScope -``` -Get-AzureRmSecurityAlert -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ResourceGroupLevelResource -``` -Get-AzureRmSecurityAlert -ResourceGroupName <String> -Name <String> -Location <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SubscriptionLevelResource -``` -Get-AzureRmSecurityAlert -Name <String> -Location <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ResourceId -``` -Get-AzureRmSecurityAlert -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Gets security alerts that were detected by Azure Security Center - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmSecurityAlert - - -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/RSG/providers/Microsoft.Securit - y/locations/centralus/alerts/2518710774294070750_FFF23C70-80EF-4A8B-9122-507B0EA8DFFF -Name : 2518710774294070750_FFF23C70-80EF-4A8B-9122-507B0EA8DFFF -ActionTaken : Undefined -AlertDisplayName : PREVIEW - Vulnerability scanner detected -AlertName : APPS_WpScanner -AssociatedResource : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/RSG/providers/Microsoft.Web/sit - es/testSite1 -CanBeInvestigated : True -CompromisedEntity : testSite1 -ConfidenceReasons : {} -ConfidenceScore : -Description : Azure App Services activity log indicates a possible vulnerability scanner usage on your App - Service resource. - The suspicious activity detected resembles that of tools targeting WordPress applications. -DetectedTimeUtc : 10/07/2018 11:49:30 -Entities : {} -ExtendedProperties : {[sample User Agents, WPScan+v2.9.3+(http://wpscan.org)], [last Event Time, 6/23/2018 12:18:58 - AM], [sample URIs, /wp-config.php.original, /wp-includes/css/editor.min.css, - /wp-includes/js/wp-emoji.js, /wp-config.old, /xmlrpc.php, /wp-admin/css/wp-admin-rtl.css, - /#wp-config.php#, /wp-includes/js/tinymce/plugins/wplink/plugin.js, - /wp-includes/js/tinymce/plugins/wordpress/editor_plugin.js, /wp-admin/js/post.js], [sample - Referer, https://www.stone.com.br/]...} -InstanceId : fff23c70-80ef-4a8b-9122-507b0ea8dfff -RemediationSteps : 1. If WordPress is installed, make sure that the application is up to date and automatic updates - are enabled. - 2. If only specific IPs should access to the web application, use IP Restrictions - (https://docs.microsoft.com/en-us/azure/app-service/app-service-ip-restrictions). -ReportedSeverity : High -ReportedTimeUtc : 10/07/2018 16:31:52 -State : Active -SubscriptionId : 487bb485-b5b0-471e-9c0d-10717612f869 -SystemSource : -VendorName : Microsoft -WorkspaceArmId : - -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/locations/central - us/alerts/2518710774894070750_EEE23C70-80EF-4A8B-9122-507B0EA8DFFF -Name : 2518710774894070750_EEE23C70-80EF-4A8B-9122-507B0EA8DFFF -ActionTaken : Undefined -AlertDisplayName : PREVIEW - Spam folder referrer detected -AlertName : APPS_SpamReferrer -AssociatedResource : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Web/sites/testSite2 -CanBeInvestigated : True -CompromisedEntity : testSite2 -ConfidenceReasons : {} -ConfidenceScore : -Description : Azure App Services activity log indicates web activity that was identified as originating from a - web site associated with SPAM activity. - This could occur if your web site is compromised and used for spam activity. -DetectedTimeUtc : 10/07/2018 11:48:30 -Entities : {} -ExtendedProperties : {[sample User Agents, Mozilla/4.0+(compatible;+MSIE+6.0;+Windows+NT+5.1)], [last Event Time, - 6/23/2018 4:53:58 PM], [sample URIs, /acropolis.php, /wp-content/animator.php, /bandpass.php, - /wp-content/base.php, /candid.php, /wp-content/uploads/2018/christina.php, - /wp-content/climax.php, /wp-content/uploads/conditioning.php, /wp-content/corkscrew.php, - /wp-content/uploads/2018/countermeasures.php], [sample Referer, - https://google.com/mail/inbox/spam/]...} -InstanceId : eee23c70-80ef-4a8b-9122-507b0ea8dfff -RemediationSteps : Review the URIs in the alert details. Check whether the corresponding files contain malicious or - suspicious content. - If they do, escalate the alert to the information security team. -ReportedSeverity : High -ReportedTimeUtc : 10/07/2018 16:31:52 -State : Active -SubscriptionId : 487bb485-b5b0-471e-9c0d-10717612f869 -SystemSource : -VendorName : Microsoft -WorkspaceArmId : - -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft. - Security/locations/westeurope/alerts/2518675199999999999_0501972d-06cd-47c7-a276-036f67d89262 -Name : 2518675199999999999_0501972d-06cd-47c7-a276-036f67d89262 -ActionTaken : Detected -AlertDisplayName : PROTOCOL-ENFORCEMENT -AlertName : PROTOCOL-ENFORCEMENT -AssociatedResource : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft. - Network/applicationGateways/ContosoWAF -CanBeInvestigated : True -CompromisedEntity : 10.1.0.4 -ConfidenceReasons : {} -ConfidenceScore : -Description : Detail:Host header is a numeric IP address 13.69.131.117:80 -DetectedTimeUtc : 20/08/2018 16:00:00 -Entities : {} -ExtendedProperties : {[hit Count, 1], [source IPs, 177.189.28.238], [management URL, https://portal.azure.com#resource/ - subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.N - etwork/applicationGateways/ContosoWAF/overview], [resourceType, Networking]} -InstanceId : 0501972d-06cd-47c7-a276-036f67d89262 -RemediationSteps : -ReportedSeverity : Low -ReportedTimeUtc : 20/08/2018 17:00:18 -State : Active -SubscriptionId : 487bb485-b5b0-471e-9c0d-10717612f869 -SystemSource : Azure -VendorName : Microsoft WAF -WorkspaceArmId : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourcegroups/defaultresourcegroup-eus/provid - ers/microsoft.operationalinsights/workspaces/defaultworkspace-487bb485-b5b0-471e-9c0d-10717612f869 - -eus - -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft. - Security/locations/westeurope/alerts/2518675235999999999_0cd957d9-8101-47f7-88cc-0c5d0ebdbfd0 -Name : 2518675235999999999_0cd957d9-8101-47f7-88cc-0c5d0ebdbfd0 -ActionTaken : Detected -AlertDisplayName : PROTOCOL-ENFORCEMENT -AlertName : PROTOCOL-ENFORCEMENT -AssociatedResource : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft. - Network/applicationGateways/ContosoWAF -CanBeInvestigated : True -CompromisedEntity : 10.1.0.4 -ConfidenceReasons : {} -ConfidenceScore : -Description : Detail:Host header is a numeric IP address 13.69.131.117 -DetectedTimeUtc : 20/08/2018 15:00:00 -Entities : {} -ExtendedProperties : {[hit Count, 1], [source IPs, 217.91.251.86], [management URL, https://portal.azure.com#resource/s - ubscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Ne - twork/applicationGateways/ContosoWAF/overview], [resourceType, Networking]} -InstanceId : 0cd957d9-8101-47f7-88cc-0c5d0ebdbfd0 -RemediationSteps : -ReportedSeverity : Low -ReportedTimeUtc : 20/08/2018 16:00:03 -State : Active -SubscriptionId : 487bb485-b5b0-471e-9c0d-10717612f869 -SystemSource : Azure -VendorName : Microsoft WAF -WorkspaceArmId : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourcegroups/defaultresourcegroup-eus/provid - ers/microsoft.operationalinsights/workspaces/defaultworkspace-487bb485-b5b0-471e-9c0d-10717612f869 - -eus -``` - -Gets all the security alerts that were detected on resoruces inside a subscription - -### Example 2 -```powershell -PS C:\> Get-AzureRmSecurityAlert -ResourceGroupName "myService1" - - -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft. - Security/locations/westeurope/alerts/2518675199999999999_0501972d-06cd-47c7-a276-036f67d89262 -Name : 2518675199999999999_0501972d-06cd-47c7-a276-036f67d89262 -ActionTaken : Detected -AlertDisplayName : PROTOCOL-ENFORCEMENT -AlertName : PROTOCOL-ENFORCEMENT -AssociatedResource : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft. - Network/applicationGateways/ContosoWAF -CanBeInvestigated : True -CompromisedEntity : 10.1.0.4 -ConfidenceReasons : {} -ConfidenceScore : -Description : Detail:Host header is a numeric IP address 13.69.131.117:80 -DetectedTimeUtc : 20/08/2018 16:00:00 -Entities : {} -ExtendedProperties : {[hit Count, 1], [source IPs, 177.189.28.238], [management URL, https://portal.azure.com#resource/ - subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.N - etwork/applicationGateways/ContosoWAF/overview], [resourceType, Networking]} -InstanceId : 0501972d-06cd-47c7-a276-036f67d89262 -RemediationSteps : -ReportedSeverity : Low -ReportedTimeUtc : 20/08/2018 17:00:18 -State : Active -SubscriptionId : 487bb485-b5b0-471e-9c0d-10717612f869 -SystemSource : Azure -VendorName : Microsoft WAF -WorkspaceArmId : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourcegroups/defaultresourcegroup-eus/provid - ers/microsoft.operationalinsights/workspaces/defaultworkspace-487bb485-b5b0-471e-9c0d-10717612f869 - -eus - -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft. - Security/locations/westeurope/alerts/2518675235999999999_0cd957d9-8101-47f7-88cc-0c5d0ebdbfd0 -Name : 2518675235999999999_0cd957d9-8101-47f7-88cc-0c5d0ebdbfd0 -ActionTaken : Detected -AlertDisplayName : PROTOCOL-ENFORCEMENT -AlertName : PROTOCOL-ENFORCEMENT -AssociatedResource : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft. - Network/applicationGateways/ContosoWAF -CanBeInvestigated : True -CompromisedEntity : 10.1.0.4 -ConfidenceReasons : {} -ConfidenceScore : -Description : Detail:Host header is a numeric IP address 13.69.131.117 -DetectedTimeUtc : 20/08/2018 15:00:00 -Entities : {} -ExtendedProperties : {[hit Count, 1], [source IPs, 217.91.251.86], [management URL, https://portal.azure.com#resource/s - ubscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Ne - twork/applicationGateways/ContosoWAF/overview], [resourceType, Networking]} -InstanceId : 0cd957d9-8101-47f7-88cc-0c5d0ebdbfd0 -RemediationSteps : -ReportedSeverity : Low -ReportedTimeUtc : 20/08/2018 16:00:03 -State : Active -SubscriptionId : 487bb485-b5b0-471e-9c0d-10717612f869 -SystemSource : Azure -VendorName : Microsoft WAF -WorkspaceArmId : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourcegroups/defaultresourcegroup-eus/provid - ers/microsoft.operationalinsights/workspaces/defaultworkspace-487bb485-b5b0-471e-9c0d-10717612f869 - -eus - -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft. - Security/locations/westeurope/alerts/2518675235999999999_3cc2c984-3d3d-4af2-a2d9-ed7c6d078315 -Name : 2518675235999999999_3cc2c984-3d3d-4af2-a2d9-ed7c6d078315 -ActionTaken : Detected -AlertDisplayName : PROTOCOL-ENFORCEMENT -AlertName : PROTOCOL-ENFORCEMENT -AssociatedResource : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft. - Network/applicationGateways/ContosoWAF -CanBeInvestigated : True -CompromisedEntity : 10.1.0.5 -ConfidenceReasons : {} -ConfidenceScore : -Description : Detail:Host header is a numeric IP address 13.69.131.117 -DetectedTimeUtc : 20/08/2018 15:00:00 -Entities : {} -ExtendedProperties : {[hit Count, 1], [source IPs, 217.91.251.86], [management URL, https://portal.azure.com#resource/s - ubscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Ne - twork/applicationGateways/ContosoWAF/overview], [resourceType, Networking]} -InstanceId : 3cc2c984-3d3d-4af2-a2d9-ed7c6d078315 -RemediationSteps : -ReportedSeverity : Low -ReportedTimeUtc : 20/08/2018 16:00:04 -State : Active -SubscriptionId : 487bb485-b5b0-471e-9c0d-10717612f869 -SystemSource : Azure -VendorName : Microsoft WAF -WorkspaceArmId : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourcegroups/defaultresourcegroup-eus/provid - ers/microsoft.operationalinsights/workspaces/defaultworkspace-487bb485-b5b0-471e-9c0d-10717612f869 - -eus - -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft. - Security/locations/westeurope/alerts/2518675307999999999_bbbda0ad-b149-49f4-a4ba-3e95540cbf1c -Name : 2518675307999999999_bbbda0ad-b149-49f4-a4ba-3e95540cbf1c -ActionTaken : Detected -AlertDisplayName : PROTOCOL-ENFORCEMENT -AlertName : PROTOCOL-ENFORCEMENT -AssociatedResource : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft. - Network/applicationGateways/ContosoWAF -CanBeInvestigated : True -CompromisedEntity : 10.1.0.4 -ConfidenceReasons : {} -ConfidenceScore : -Description : Detail:Host header is a numeric IP address 13.69.131.117:80 -DetectedTimeUtc : 20/08/2018 13:00:00 -Entities : {} -ExtendedProperties : {[hit Count, 1], [source IPs, 177.86.202.171], [management URL, https://portal.azure.com#resource/ - subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.N - etwork/applicationGateways/ContosoWAF/overview], [resourceType, Networking]} -InstanceId : bbbda0ad-b149-49f4-a4ba-3e95540cbf1c -RemediationSteps : -ReportedSeverity : Low -ReportedTimeUtc : 20/08/2018 14:00:36 -State : Active -SubscriptionId : 487bb485-b5b0-471e-9c0d-10717612f869 -SystemSource : Azure -VendorName : Microsoft WAF -WorkspaceArmId : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourcegroups/defaultresourcegroup-eus/provid - ers/microsoft.operationalinsights/workspaces/defaultworkspace-487bb485-b5b0-471e-9c0d-10717612f869 - -eus -``` - -Gets all the security alerts that were detected on resoruces inside the "myService1" resource group - -### Example 3 -```powershell -PS C:\> Get-AzureRmSecurityAlert -ResourceGroupName "myService1" -Location "westeurope" -Name "2518675235999999999_0cd957d9-8101-47f7-88cc-0c5d0ebdbfd0" - - -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft. - Security/locations/westeurope/alerts/2518675235999999999_0cd957d9-8101-47f7-88cc-0c5d0ebdbfd0 -Name : 2518675235999999999_0cd957d9-8101-47f7-88cc-0c5d0ebdbfd0 -ActionTaken : Detected -AlertDisplayName : PROTOCOL-ENFORCEMENT -AlertName : PROTOCOL-ENFORCEMENT -AssociatedResource : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft. - Network/applicationGateways/ContosoWAF -CanBeInvestigated : True -CompromisedEntity : 10.1.0.4 -ConfidenceReasons : {} -ConfidenceScore : -Description : Detail:Host header is a numeric IP address 13.69.131.117 -DetectedTimeUtc : 20/08/2018 15:00:00 -Entities : {} -ExtendedProperties : {[hit Count, 1], [source IPs, 217.91.251.86], [management URL, https://portal.azure.com#resource/s - ubscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Ne - twork/applicationGateways/ContosoWAF/overview], [resourceType, Networking]} -InstanceId : 0cd957d9-8101-47f7-88cc-0c5d0ebdbfd0 -RemediationSteps : -ReportedSeverity : Low -ReportedTimeUtc : 20/08/2018 16:00:03 -State : Active -SubscriptionId : 487bb485-b5b0-471e-9c0d-10717612f869 -SystemSource : Azure -VendorName : Microsoft WAF -WorkspaceArmId : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourcegroups/defaultresourcegroup-eus/provid - ers/microsoft.operationalinsights/workspaces/defaultworkspace-487bb485-b5b0-471e-9c0d-10717612f869 - -eus -``` - -Gets a specific security alert that were detected on resoruces inside the "myService1" resource group - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Location. - -```yaml -Type: String -Parameter Sets: ResourceGroupLevelResource, SubscriptionLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Resource name. - -```yaml -Type: String -Parameter Sets: ResourceGroupLevelResource, SubscriptionLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource group name. - -```yaml -Type: String -Parameter Sets: ResourceGroupScope, ResourceGroupLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID. - -```yaml -Type: String -Parameter Sets: ResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Security.Models.Alerts.PSSecurityAlert - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Security/Get-AzureRmSecurityAutoProvisioningSetting.md b/azurermps-6.13.0/AzureRM.Security/Get-AzureRmSecurityAutoProvisioningSetting.md deleted file mode 100644 index 99c82fe5a6..0000000000 --- a/azurermps-6.13.0/AzureRM.Security/Get-AzureRmSecurityAutoProvisioningSetting.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.SecurityCenter.dll-Help.xml -Module Name: AzureRM.Security -online version: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Get-AzureRmSecurityAutoProvisioningSetting.md -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Get-AzureRmSecurityAutoProvisioningSetting.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Get-AzureRmSecurityAutoProvisioningSetting.md ---- - -# Get-AzureRmSecurityAutoProvisioningSetting - -## SYNOPSIS -Gets the security automatic provisioning settings - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SubscriptionScope (Default) -``` -Get-AzureRmSecurityAutoProvisioningSetting [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SubscriptionLevelResource -``` -Get-AzureRmSecurityAutoProvisioningSetting -Name <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ResourceId -``` -Get-AzureRmSecurityAutoProvisioningSetting -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -Automatic Provisioning Settings let you decide whether you want Azure Security Cetner to automatically proviosion a security agent that will be installed on your VMs. -The security agent will monitor your VM to create security alerts and monitor the security compliance of the VM. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmSecurityAutoProvisioningSetting -Name "default" -Id Name AutoProvision --- ---- ------------- -/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/autoProvisioningSettings/default default On -``` - -Gets the auto provisioning setting for the subscription - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Resource name. - -```yaml -Type: String -Parameter Sets: SubscriptionLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID. - -```yaml -Type: String -Parameter Sets: ResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Security.Models.AutoProvisioningSettings.PSSecurityAutoProvisioningSetting - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Security/Get-AzureRmSecurityCompliance.md b/azurermps-6.13.0/AzureRM.Security/Get-AzureRmSecurityCompliance.md deleted file mode 100644 index 8bb9a64641..0000000000 --- a/azurermps-6.13.0/AzureRM.Security/Get-AzureRmSecurityCompliance.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.SecurityCenter.dll-Help.xml -Module Name: AzureRM.Security -online version: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Get-AzureRmSecurityCompliance.md -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Get-AzureRmSecurityCompliance.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Get-AzureRmSecurityCompliance.md ---- - -# Get-AzureRmSecurityCompliance - -## SYNOPSIS -Get the security compliance of a subscription over time - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SubscriptionScope (Default) -``` -Get-AzureRmSecurityCompliance [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SubscriptionLevelResource -``` -Get-AzureRmSecurityCompliance -Name <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceId -``` -Get-AzureRmSecurityCompliance -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -Gets the security compliance of a subscription based on the current healthy and non secured resources ratio on this subscription. -The security compliance is calculated every day and the history is saved. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmSecurityCompliance - - -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/compliances/2018-08-20Z -Name : 2018-08-20Z -ResourceCount : 18 -AssessmentTimestampUtcDate : 20/08/2018 00:00:00 -AssessmentResult : {Microsoft.Azure.Commands.Security.Models.Compliances.PSSecurityComplianceSegment} - -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/compliances/2018-08-19Z -Name : 2018-08-19Z -ResourceCount : 18 -AssessmentTimestampUtcDate : 19/08/2018 00:00:00 -AssessmentResult : {Microsoft.Azure.Commands.Security.Models.Compliances.PSSecurityComplianceSegment} - -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/compliances/2018-08-18Z -Name : 2018-08-18Z -ResourceCount : 18 -AssessmentTimestampUtcDate : 18/08/2018 00:00:00 -AssessmentResult : {Microsoft.Azure.Commands.Security.Models.Compliances.PSSecurityComplianceSegment} - -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/compliances/2018-08-17Z -Name : 2018-08-17Z -ResourceCount : 18 -AssessmentTimestampUtcDate : 17/08/2018 00:00:00 -AssessmentResult : {Microsoft.Azure.Commands.Security.Models.Compliances.PSSecurityComplianceSegment} - -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/compliances/2018-08-16Z -Name : 2018-08-16Z -ResourceCount : 18 -AssessmentTimestampUtcDate : 16/08/2018 00:00:00 -AssessmentResult : {Microsoft.Azure.Commands.Security.Models.Compliances.PSSecurityComplianceSegment} - -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/compliances/2018-08-15Z -Name : 2018-08-15Z -ResourceCount : 18 -AssessmentTimestampUtcDate : 15/08/2018 00:00:00 -AssessmentResult : {Microsoft.Azure.Commands.Security.Models.Compliances.PSSecurityComplianceSegment} - -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/compliances/2018-08-14Z -Name : 2018-08-14Z -ResourceCount : 18 -AssessmentTimestampUtcDate : 14/08/2018 00:00:00 -AssessmentResult : {Microsoft.Azure.Commands.Security.Models.Compliances.PSSecurityComplianceSegment} - -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/compliances/2018-08-13Z -Name : 2018-08-13Z -ResourceCount : 18 -AssessmentTimestampUtcDate : 13/08/2018 00:00:00 -AssessmentResult : {Microsoft.Azure.Commands.Security.Models.Compliances.PSSecurityComplianceSegment} - -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/compliances/2018-08-12Z -Name : 2018-08-12Z -ResourceCount : 18 -AssessmentTimestampUtcDate : 12/08/2018 00:00:00 -AssessmentResult : {Microsoft.Azure.Commands.Security.Models.Compliances.PSSecurityComplianceSegment} - -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/compliances/2018-08-11Z -Name : 2018-08-11Z -ResourceCount : 18 -AssessmentTimestampUtcDate : 11/08/2018 00:00:00 -AssessmentResult : {Microsoft.Azure.Commands.Security.Models.Compliances.PSSecurityComplianceSegment} - -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/compliances/2018-08-10Z -Name : 2018-08-10Z -ResourceCount : 18 -AssessmentTimestampUtcDate : 10/08/2018 00:00:00 -AssessmentResult : {Microsoft.Azure.Commands.Security.Models.Compliances.PSSecurityComplianceSegment} - -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/compliances/2018-08-09Z -Name : 2018-08-09Z -ResourceCount : 18 -AssessmentTimestampUtcDate : 09/08/2018 00:00:00 -AssessmentResult : {Microsoft.Azure.Commands.Security.Models.Compliances.PSSecurityComplianceSegment} - -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/compliances/2018-08-08Z -Name : 2018-08-08Z -ResourceCount : 18 -AssessmentTimestampUtcDate : 08/08/2018 00:00:00 -AssessmentResult : {Microsoft.Azure.Commands.Security.Models.Compliances.PSSecurityComplianceSegment} - -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/compliances/2018-08-07Z -Name : 2018-08-07Z -ResourceCount : 18 -AssessmentTimestampUtcDate : 07/08/2018 00:00:00 -AssessmentResult : {Microsoft.Azure.Commands.Security.Models.Compliances.PSSecurityComplianceSegment} -``` - -Gets the security compliance of a subscription for the last 14 days - -### Example 2 -```powershell -PS C:\> Get-AzureRmSecurityCompliance -Name "2018-08-20Z" - - -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/compliances/2018-08-20Z -Name : 2018-08-20Z -ResourceCount : 18 -AssessmentTimestampUtcDate : 20/08/2018 00:00:00 -AssessmentResult : {Microsoft.Azure.Commands.Security.Models.Compliances.PSSecurityComplianceSegment} -``` - -Gets the security compliance of a subscription on a specific date - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Resource name. - -```yaml -Type: String -Parameter Sets: SubscriptionLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID. - -```yaml -Type: String -Parameter Sets: ResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Security.Models.Compliances.PSSecurityCompliance - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Security/Get-AzureRmSecurityContact.md b/azurermps-6.13.0/AzureRM.Security/Get-AzureRmSecurityContact.md deleted file mode 100644 index fc04339f2b..0000000000 --- a/azurermps-6.13.0/AzureRM.Security/Get-AzureRmSecurityContact.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.SecurityCenter.dll-Help.xml -Module Name: AzureRM.Security -online version: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Get-AzureRmSecurityContact.md -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Get-AzureRmSecurityContact.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Get-AzureRmSecurityContact.md ---- - -# Get-AzureRmSecurityContact - -## SYNOPSIS -Gets security contacts that were configured on this subscription - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SubscriptionScope (Default) -``` -Get-AzureRmSecurityContact [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SubscriptionLevelResource -``` -Get-AzureRmSecurityContact -Name <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceId -``` -Get-AzureRmSecurityContact -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Gets security contacts that were configured on this subscription. -The security contact can get notifications on security alerts that happen on the subscription. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmSecurityContact -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/securityContacts/default1 -Name : default1 -Email : ascasc@microsoft.com -Phone : 123123123 -AlertNotifications : On -AlertsToAdmins : On -``` - -Gets all the configured security contacts on the subscription - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Resource name. - -```yaml -Type: String -Parameter Sets: SubscriptionLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID. - -```yaml -Type: String -Parameter Sets: ResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Security.Models.SecurityContacts.PSSecurityContact - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Security/Get-AzureRmSecurityLocation.md b/azurermps-6.13.0/AzureRM.Security/Get-AzureRmSecurityLocation.md deleted file mode 100644 index 0a619255d0..0000000000 --- a/azurermps-6.13.0/AzureRM.Security/Get-AzureRmSecurityLocation.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.SecurityCenter.dll-Help.xml -Module Name: AzureRM.Security -online version: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Get-AzureRmSecurityLocation.md -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Get-AzureRmSecurityLocation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Get-AzureRmSecurityLocation.md ---- - -# Get-AzureRmSecurityLocation - -## SYNOPSIS -Gets the location where Azure Security Center will automatically save data for the specific subscription - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SubscriptionScope (Default) -``` -Get-AzureRmSecurityLocation [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SubscriptionLevelResource -``` -Get-AzureRmSecurityLocation -Name <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceId -``` -Get-AzureRmSecurityLocation -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -Azure Security Center will automatically decide on a location to save some of your data. -Use this cmdlet to discover that location. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmSecurityLocation -Id Name --- ---- -/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/locations/centralus centralus -``` - -Gets the location where Azure Security Center saves the calculated security data. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Resource name. - -```yaml -Type: String -Parameter Sets: SubscriptionLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID. - -```yaml -Type: String -Parameter Sets: ResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Security.Models.Locations.PSSecurityLocation - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Security/Get-AzureRmSecurityPricing.md b/azurermps-6.13.0/AzureRM.Security/Get-AzureRmSecurityPricing.md deleted file mode 100644 index 80b2a06670..0000000000 --- a/azurermps-6.13.0/AzureRM.Security/Get-AzureRmSecurityPricing.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.SecurityCenter.dll-Help.xml -Module Name: AzureRM.Security -online version: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Get-AzureRmSecurityPricing.md -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Get-AzureRmSecurityPricing.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Get-AzureRmSecurityPricing.md ---- - -# Get-AzureRmSecurityPricing - -## SYNOPSIS -Gets the pricing tier data for Azure Security Center for a scope. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SubscriptionScope (Default) -``` -Get-AzureRmSecurityPricing [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceGroupLevelResource -``` -Get-AzureRmSecurityPricing -ResourceGroupName <String> -Name <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceGroupScope -``` -Get-AzureRmSecurityPricing -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### SubscriptionLevelResource -``` -Get-AzureRmSecurityPricing -Name <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceId -``` -Get-AzureRmSecurityPricing -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Azure Security Center pricing tier is decided per scope, with this cmdlet you can get the configured pricing tiers. -Subscription pricing tier include all the resource groups under it. -Resource Group pricing tier will override the subscription pricing tier. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmSecurityPricing -Id Name PricingTier --- ---- ----------- -/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/pricings/default default Standard -/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/pricings/myService1 myService1 Standard -``` - -Gets all the configured pricing tiers for the subscription and the resource groups under it. - -### Example 2 -```powershell -PS C:\> Get-AzureRmSecurityPricing -ResourceGroupName "myService1" -Id Name PricingTier --- ---- ----------- -/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/pricings/myService1 myService1 Standard -``` - -Gets the configured pricing tier for the "myService1" resource gorup. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Resource name. - -```yaml -Type: String -Parameter Sets: ResourceGroupLevelResource, SubscriptionLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource group name. - -```yaml -Type: String -Parameter Sets: ResourceGroupLevelResource, ResourceGroupScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID. - -```yaml -Type: String -Parameter Sets: ResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Security.Models.Pricings.PSSecurityPricing - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Security/Get-AzureRmSecurityTask.md b/azurermps-6.13.0/AzureRM.Security/Get-AzureRmSecurityTask.md deleted file mode 100644 index f69cc1e9b1..0000000000 --- a/azurermps-6.13.0/AzureRM.Security/Get-AzureRmSecurityTask.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.SecurityCenter.dll-Help.xml -Module Name: AzureRM.Security -online version: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Get-AzureRmSecurityTask.md -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Get-AzureRmSecurityTask.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Get-AzureRmSecurityTask.md ---- - -# Get-AzureRmSecurityTask - -## SYNOPSIS -Gets the security tasks that Azure Security Center recommends you to do in order to strengthen your security posture. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SubscriptionScope (Default) -``` -Get-AzureRmSecurityTask [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceGroupScope -``` -Get-AzureRmSecurityTask -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ResourceGroupLevelResource -``` -Get-AzureRmSecurityTask -ResourceGroupName <String> -Name <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### SubscriptionLevelResource -``` -Get-AzureRmSecurityTask -Name <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceId -``` -Get-AzureRmSecurityTask -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Azure Security Center scans your resources to detect potential security issues. -This cmdlet lets you discover the security tasks that Azure Security Center recommends you to do. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmSecurityTask -Id Name RecommendationType ResourceId --- ---- ------------------ ---------- -/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/locations/centralus/tasks/08357a1e-c534-756f-cbb9-7b45e73f3137 08357a1e-c534-756f-cbb9-7b45e73f3137 Subscription has machines with failed baseline rule /subscriptions/48... -/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/locations/centralus/tasks/0876feac-8c60-3fef-d95e-2c43b333ff14 0876feac-8c60-3fef-d95e-2c43b333ff14 Antimalware Health Issues /subscriptions/48... -/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/locations/centralus/tasks/09ea0fa9-ce5a-d703-e17b-08f1d5246e2c 09ea0fa9-ce5a-d703-e17b-08f1d5246e2c Subscription has machines with failed baseline rule /subscriptions/48... -/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/locations/centralus/tasks/11ff8541-820e-cecc-75de-91be7c0d8419 11ff8541-820e-cecc-75de-91be7c0d8419 Subscription has machines with failed baseline rule /subscriptions/48... -``` - -Gets all the security tasks that were discovered on resources inside a subscription. - -### Example 2 -```powershell -PS C:\> Get-AzureRmSecurityTask -ResourceGroupName "myService1" - -Id Name RecommendationType ResourceI - d --- ---- ------------------ --------- -/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/locations/centralus/tasks/22ef553d-f13a-5227-ee4c-7cc861d28c96 22ef553d-f13a-5227-ee4c-7cc861d28c96 Enable DDoS protection standard /subsc... -/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/locations/centralus/tasks/47f736fa-0ec8-a372-de49-8cf18527930c 47f736fa-0ec8-a372-de49-8cf18527930c ConfigureTier2Waf /subsc... -/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/locations/centralus/tasks/5696e90f-833d-494c-8833-f3be335fa9cb 5696e90f-833d-494c-8833-f3be335fa9cb NetworkSecurityGroupMissingOnVm /subsc... -/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/MYSERVICE1/providers/Microsoft.Security/locations/centralus/tasks/65193cce-25a1-b30f-f94e-69d52e22923c 65193cce-25a1-b30f-f94e-69d52e22923c VulnerabilityAssessmentDeployment /subsc... -/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/locations/centralus/tasks/7e28a40d-e746-4751-8340-5126d6b77ae5 7e28a40d-e746-4751-8340-5126d6b77ae5 NetworkSecurityGroupMissingOnSubnet /subsc... -/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/MYSERVICE1/providers/Microsoft.Security/locations/centralus/tasks/94867597-75e5-cfb6-8b71-e5e5253a24e1 94867597-75e5-cfb6-8b71-e5e5253a24e1 EncryptionOnVm /subsc... -/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/MYSERVICE1/providers/Microsoft.Security/locations/centralus/tasks/a02fffd5-1956-a6d7-73da-a87a65ae02f4 a02fffd5-1956-a6d7-73da-a87a65ae02f4 VulnerabilityAssessmentDeployment /subsc... -/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/locations/centralus/tasks/bd382d04-b478-ac77-e89f-300789032367 bd382d04-b478-ac77-e89f-300789032367 ProvisionNgfw /subsc... -/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/MYSERVICE1/providers/Microsoft.Security/locations/centralus/tasks/ce43626a-d56b-6a38-49ef-3ad7a731666e ce43626a-d56b-6a38-49ef-3ad7a731666e EncryptionOnVm /subsc... -/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/locations/centralus/tasks/dcfb6365-799e-5ed4-f344-d86a0a4c2992 dcfb6365-799e-5ed4-f344-d86a0a4c2992 Enable auditing for the SQL database /subsc... -/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/locations/centralus/tasks/ed736ed1-3f42-a95a-0b9e-458c44233937 ed736ed1-3f42-a95a-0b9e-458c44233937 Enable auditing for the SQL server /subsc... -``` - -Gets all the security tasks that were discovered on resources inside a resource group. - -### Example 3 -```powershell -PS C:\> Get-AzureRmSecurityTask -ResourceGroupName "myService1" -Name "22ef553d-f13a-5227-ee4c-7cc861d28c96" - -Id Name RecommendationType ResourceId --- ---- ------------------ ---------- -/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/locations/centralus/tasks/22ef553d-f13a-5227-ee4c-7cc861d28c96 22ef553d-f13a-5227-ee4c-7cc861d28c96 Enable DDoS protection standard /subscripti... -``` - -Gets a specific security task. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Resource name. - -```yaml -Type: String -Parameter Sets: ResourceGroupLevelResource, SubscriptionLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource group name. - -```yaml -Type: String -Parameter Sets: ResourceGroupScope, ResourceGroupLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID. - -```yaml -Type: String -Parameter Sets: ResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Security.Models.Tasks.PSSecurityTask - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Security/Get-AzureRmSecurityWorkspaceSetting.md b/azurermps-6.13.0/AzureRM.Security/Get-AzureRmSecurityWorkspaceSetting.md deleted file mode 100644 index 37872d35f9..0000000000 --- a/azurermps-6.13.0/AzureRM.Security/Get-AzureRmSecurityWorkspaceSetting.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.SecurityCenter.dll-Help.xml -Module Name: AzureRM.Security -online version: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Get-AzureRmSecurityWorkspaceSetting.md -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Get-AzureRmSecurityWorkspaceSetting.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Get-AzureRmSecurityWorkspaceSetting.md ---- - -# Get-AzureRmSecurityWorkspaceSetting - -## SYNOPSIS -Gets the configured security workspace settings on a subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SubscriptionScope (Default) -``` -Get-AzureRmSecurityWorkspaceSetting [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SubscriptionLevelResource -``` -Get-AzureRmSecurityWorkspaceSetting -Name <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ResourceId -``` -Get-AzureRmSecurityWorkspaceSetting -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -This cmdlet lets you discover the configured workspace that will hold the security data that was collected by the security agent that is installed in VMs inside this subscription. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmSecurityWorkspaceSetting - -Id Name WorkspaceId --- ---- ----------- -/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/workspaceSettings/default default /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourcegroups/mainws/providers/microsoft.operationalinsights/workspaces/securityus... -``` - -Gets the workspace settings for a subscription. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Resource name. - -```yaml -Type: String -Parameter Sets: SubscriptionLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID. - -```yaml -Type: String -Parameter Sets: ResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Security.Models.WorkspaceSettings.PSSecurityWorkspaceSetting - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Security/Remove-AzureRmJitNetworkAccessPolicy.md b/azurermps-6.13.0/AzureRM.Security/Remove-AzureRmJitNetworkAccessPolicy.md deleted file mode 100644 index 4d6e9daf92..0000000000 --- a/azurermps-6.13.0/AzureRM.Security/Remove-AzureRmJitNetworkAccessPolicy.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.SecurityCenter.dll-Help.xml -Module Name: AzureRM.Security -online version: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Remove-AzureRmJitNetworkAccessPolicy.md -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Remove-AzureRmJitNetworkAccessPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Remove-AzureRmJitNetworkAccessPolicy.md ---- - -# Remove-AzureRmJitNetworkAccessPolicy - -## SYNOPSIS -Deletes a JIT network access policy. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceGroupLevelResource (Default) -``` -Remove-AzureRmJitNetworkAccessPolicy -ResourceGroupName <String> -Location <String> -Name <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceId -``` -Remove-AzureRmJitNetworkAccessPolicy -ResourceId <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObject -``` -Remove-AzureRmJitNetworkAccessPolicy -InputObject <PSRemoveJitNetworkAccessPolicy> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Deletes a Just In Time network access policy. -After this action a user will not be able to request temporary network connection on the VMs that were configured inside the deleted policy. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-AzureRmJitNetworkAccessPolicy -ResourceGroupName "myService1" -Location "centralus" -Name "default" -``` - -Deletes a Just In Time network access policy. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Input Object. - -```yaml -Type: PSRemoveJitNetworkAccessPolicy -Parameter Sets: InputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Location -Location. - -```yaml -Type: String -Parameter Sets: ResourceGroupLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Resource name. - -```yaml -Type: String -Parameter Sets: ResourceGroupLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Return whether the operation was successful. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource group name. - -```yaml -Type: String -Parameter Sets: ResourceGroupLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID. - -```yaml -Type: String -Parameter Sets: ResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Microsoft.Azure.Commands.Security.Cmdlets.JitNetworkAccessPolicies.PSRemoveJitNetworkAccessPolicy - -## OUTPUTS - -### Microsoft.Azure.Commands.Security.Models.JitNetworkAccessPolicies.PSSecurityJitNetworkAccessPolicy - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Security/Remove-AzureRmSecurityContact.md b/azurermps-6.13.0/AzureRM.Security/Remove-AzureRmSecurityContact.md deleted file mode 100644 index 5b61af81c6..0000000000 --- a/azurermps-6.13.0/AzureRM.Security/Remove-AzureRmSecurityContact.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.SecurityCenter.dll-Help.xml -Module Name: AzureRM.Security -online version: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Remove-AzureRmSecurityContact.md -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Remove-AzureRmSecurityContact.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Remove-AzureRmSecurityContact.md ---- - -# Remove-AzureRmSecurityContact - -## SYNOPSIS -Deletes a security contact. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SubscriptionLevelResource (Default) -``` -Remove-AzureRmSecurityContact -Name <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ResourceId -``` -Remove-AzureRmSecurityContact -ResourceId <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObject -``` -Remove-AzureRmSecurityContact -InputObject <PSRemoveSecurityContactInputObject> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Deletes a security contact. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-AzureRmSecurityContact -Name "default1" -``` - -Deletes the "default1" security contact - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Input Object. - -```yaml -Type: PSRemoveSecurityContactInputObject -Parameter Sets: InputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Resource name. - -```yaml -Type: String -Parameter Sets: SubscriptionLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Return whether the operation was successful. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID. - -```yaml -Type: String -Parameter Sets: ResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Microsoft.Azure.Commands.Security.Cmdlets.SecurityContacts.PSRemoveSecurityContactInputObject - -## OUTPUTS - -### Microsoft.Azure.Commands.Security.Models.SecurityContacts.PSSecurityContact - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Security/Remove-AzureRmSecurityWorkspaceSetting.md b/azurermps-6.13.0/AzureRM.Security/Remove-AzureRmSecurityWorkspaceSetting.md deleted file mode 100644 index ba1837ab63..0000000000 --- a/azurermps-6.13.0/AzureRM.Security/Remove-AzureRmSecurityWorkspaceSetting.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.SecurityCenter.dll-Help.xml -Module Name: AzureRM.Security -online version: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Remove-AzureRmSecurityWorkspaceSetting.md -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Remove-AzureRmSecurityWorkspaceSetting.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Remove-AzureRmSecurityWorkspaceSetting.md ---- - -# Remove-AzureRmSecurityWorkspaceSetting - -## SYNOPSIS -Deletes the security workspace setting for this subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SubscriptionLevelResource (Default) -``` -Remove-AzureRmSecurityWorkspaceSetting -Name <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceId -``` -Remove-AzureRmSecurityWorkspaceSetting -ResourceId <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObject -``` -Remove-AzureRmSecurityWorkspaceSetting -InputObject <PSRemoveWorkspaceSettingInputObject> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Deletes the security workspace setting for this subscription. -This action will make the newly installed security agents to report to the default workspace of this susbscription. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-AzureRmSecurityWorkspaceSetting -Name "default" -``` - -Deletes the security workspace setting for this subscription. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Input Object. - -```yaml -Type: PSRemoveWorkspaceSettingInputObject -Parameter Sets: InputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Resource name. - -```yaml -Type: String -Parameter Sets: SubscriptionLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Return whether the operation was successful. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID. - -```yaml -Type: String -Parameter Sets: ResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Microsoft.Azure.Commands.Security.Cmdlets.WorkspaceSettings.PSRemoveWorkspaceSettingInputObject - -## OUTPUTS - -### Microsoft.Azure.Commands.Security.Models.WorkspaceSettings.PSSecurityWorkspaceSetting - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Security/Set-AzureRmJitNetworkAccessPolicy.md b/azurermps-6.13.0/AzureRM.Security/Set-AzureRmJitNetworkAccessPolicy.md deleted file mode 100644 index 0a8476c39d..0000000000 --- a/azurermps-6.13.0/AzureRM.Security/Set-AzureRmJitNetworkAccessPolicy.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.SecurityCenter.dll-Help.xml -Module Name: AzureRM.Security -online version: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Set-AzureRmJitNetworkAccessPolicy.md -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Set-AzureRmJitNetworkAccessPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Set-AzureRmJitNetworkAccessPolicy.md ---- - -# Set-AzureRmJitNetworkAccessPolicy - -## SYNOPSIS -Updates JIT network access policy. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmJitNetworkAccessPolicy -ResourceGroupName <String> -Location <String> -Name <String> - -VirtualMachine <PSSecurityJitNetworkAccessPolicyVirtualMachine[]> -Kind <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Updates JIT network access policy. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Set-AzureRmJitNetworkAccessPolicy -ResourceGroupName "myService1" -Location "centralus" -Name "default" -VirtualMachine $vmRules -Kind "Basic" - -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/locations/centralus/jitNetworkAccessPolicies/default -Name : default -Kind : Basic -VirtualMachines : {/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Compute/virtualMachines/testService} -Requests : {} -ProvisioningState : Succeeded -``` - -Updates a JIT network access policy with new VM rules. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Kind -Kind. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Location. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Resource name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource group name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualMachine -Virutal Machines. - -```yaml -Type: PSSecurityJitNetworkAccessPolicyVirtualMachine[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Microsoft.Azure.Commands.Security.Models.JitNetworkAccessPolicies.PSSecurityJitNetworkAccessPolicyVirtualMachine[] - -## OUTPUTS - -### Microsoft.Azure.Commands.Security.Models.JitNetworkAccessPolicies.PSSecurityJitNetworkAccessPolicy - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Security/Set-AzureRmSecurityAlert.md b/azurermps-6.13.0/AzureRM.Security/Set-AzureRmSecurityAlert.md deleted file mode 100644 index 4ce7cf0e8e..0000000000 --- a/azurermps-6.13.0/AzureRM.Security/Set-AzureRmSecurityAlert.md +++ /dev/null @@ -1,233 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.SecurityCenter.dll-Help.xml -Module Name: AzureRM.Security -online version: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Set-AzureRmSecurityAlert.md -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Set-AzureRmSecurityAlert.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Set-AzureRmSecurityAlert.md ---- - -# Set-AzureRmSecurityAlert - -## SYNOPSIS -Updates a security alert state. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SubscriptionLevelResource (Default) -``` -Set-AzureRmSecurityAlert -Location <String> -Name <String> -ActionType <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceGroupLevelResource -``` -Set-AzureRmSecurityAlert -ResourceGroupName <String> -Location <String> -Name <String> -ActionType <String> - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceId -``` -Set-AzureRmSecurityAlert -ActionType <String> -ResourceId <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObject -``` -Set-AzureRmSecurityAlert [-ActionType <String>] -InputObject <PSSetAlertInputObject> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Sets a security alert state. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Set-AzureRmSecurityAlert -Location "centralus" -ResourceGroupName "RSG" -Name "2518710774294070750_FFF23C70-80EF-4A8B-9122-507B0EA8DFFF" -ActionType Dismiss -``` - -Dismisses a security alert that was raised. - -## PARAMETERS - -### -ActionType -Action Type. - -```yaml -Type: String -Parameter Sets: SubscriptionLevelResource, ResourceGroupLevelResource, ResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: InputObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Input Object. - -```yaml -Type: PSSetAlertInputObject -Parameter Sets: InputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Location -Location. - -```yaml -Type: String -Parameter Sets: SubscriptionLevelResource, ResourceGroupLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Resource name. - -```yaml -Type: String -Parameter Sets: SubscriptionLevelResource, ResourceGroupLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Return whether the operation was successful. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource group name. - -```yaml -Type: String -Parameter Sets: ResourceGroupLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID. - -```yaml -Type: String -Parameter Sets: ResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Microsoft.Azure.Commands.Security.Cmdlets.Alerts.PSSetAlertInputObject - -## OUTPUTS - -### Microsoft.Azure.Commands.Security.Models.Alerts.PSSecurityAlert - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Security/Set-AzureRmSecurityAutoProvisioningSetting.md b/azurermps-6.13.0/AzureRM.Security/Set-AzureRmSecurityAutoProvisioningSetting.md deleted file mode 100644 index 5c72871763..0000000000 --- a/azurermps-6.13.0/AzureRM.Security/Set-AzureRmSecurityAutoProvisioningSetting.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.SecurityCenter.dll-Help.xml -Module Name: AzureRM.Security -online version: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Set-AzureRmSecurityAutoProvisioningSetting.md -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Set-AzureRmSecurityAutoProvisioningSetting.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Set-AzureRmSecurityAutoProvisioningSetting.md ---- - -# Set-AzureRmSecurityAutoProvisioningSetting - -## SYNOPSIS -Updates automatic provisioning setting - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SubscriptionLevelResource (Default) -``` -Set-AzureRmSecurityAutoProvisioningSetting -Name <String> [-EnableAutoProvision] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceId -``` -Set-AzureRmSecurityAutoProvisioningSetting [-EnableAutoProvision] -ResourceId <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObject -``` -Set-AzureRmSecurityAutoProvisioningSetting -InputObject <PSSecurityAutoProvisioningSetting> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Turns on or off automatic provisioning settings for a subscription. -Automatic Provisioning Settings let you decide whether you want Azure Security Center to automatically provision a security agent that will be installed on your VMs. -The security agent will monitor your VM to create security alerts and monitor the security compliance of the VM. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Set-AzureRmSecurityAutoProvisioningSetting -Name "default" -EnableAutoProvision -Id Name AutoProvision --- ---- ------------- -/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/autoProvisioningSettings/default default On -``` - -Turns on automatic provisioning setting for a subscription. - -### Example 2 -```powershell -PS C:\> Set-AzureRmSecurityAutoProvisioningSetting -Name "default" -Id Name --- ---- -/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/autoProvisioningSettings/default de... -``` - -Turns off automatic provisioning setting for a subscription. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableAutoProvision -Automatic Provisioning. - -```yaml -Type: SwitchParameter -Parameter Sets: SubscriptionLevelResource, ResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Input Object. - -```yaml -Type: PSSecurityAutoProvisioningSetting -Parameter Sets: InputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Resource name. - -```yaml -Type: String -Parameter Sets: SubscriptionLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID. - -```yaml -Type: String -Parameter Sets: ResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -System.Management.Automation.SwitchParameter -Microsoft.Azure.Commands.Security.Models.AutoProvisioningSettings.PSSecurityAutoProvisioningSetting - -## OUTPUTS - -### Microsoft.Azure.Commands.Security.Models.AutoProvisioningSettings.PSSecurityAutoProvisioningSetting - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Security/Set-AzureRmSecurityContact.md b/azurermps-6.13.0/AzureRM.Security/Set-AzureRmSecurityContact.md deleted file mode 100644 index 97e32d5396..0000000000 --- a/azurermps-6.13.0/AzureRM.Security/Set-AzureRmSecurityContact.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.SecurityCenter.dll-Help.xml -Module Name: AzureRM.Security -online version: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Set-AzureRmSecurityContact.md -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Set-AzureRmSecurityContact.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Set-AzureRmSecurityContact.md ---- - -# Set-AzureRmSecurityContact - -## SYNOPSIS -Updates a security contact for a subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSecurityContact -Name <String> -Email <String> -Phone <String> [-AlertAdmin] [-NotifyOnAlert] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Updates a security contact for a subscription. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Set-AzureRmSecurityContact -Name "default1" -Email "john@contoso.com" -Phone "214275-4038" -AlertAdmin -NotifyOnAlert - -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/securityContacts/ - default1 -Name : default1 -Email : john@contoso.com -Phone : 214275-4038 -AlertNotifications : On -AlertsToAdmins : On -``` - -Updates a security contact for a subscription. - -## PARAMETERS - -### -AlertAdmin -Alerts To Administrators. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Email -E-Mail. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Resource name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyOnAlert -Alert Notifications. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Phone -Phone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Security.Models.SecurityContacts.PSSecurityContact - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Security/Set-AzureRmSecurityPricing.md b/azurermps-6.13.0/AzureRM.Security/Set-AzureRmSecurityPricing.md deleted file mode 100644 index 2223c7f509..0000000000 --- a/azurermps-6.13.0/AzureRM.Security/Set-AzureRmSecurityPricing.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.SecurityCenter.dll-Help.xml -Module Name: AzureRM.Security -online version: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Set-AzureRmSecurityPricing.md -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Set-AzureRmSecurityPricing.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Set-AzureRmSecurityPricing.md ---- - -# Set-AzureRmSecurityPricing - -## SYNOPSIS -Sets the pricing of Azure Security Center tier for a scope. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SubscriptionLevelResource (Default) -``` -Set-AzureRmSecurityPricing -Name <String> -PricingTier <String> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceGroupLevelResource -``` -Set-AzureRmSecurityPricing -ResourceGroupName <String> -Name <String> -PricingTier <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObject -``` -Set-AzureRmSecurityPricing -InputObject <PSAddPricingInputObject> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Sets the pricing of Azure Security Center tier for a scope. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Set-AzureRmSecurityPricing -Name "default" -PricingTier "Standard" -Id Name PricingTier --- ---- ----------- -/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/pricings/default default Standard -``` - -Sets the subscription Azure Security Center pricing tier to "Standard" - -### Example 2 -```powershell -PS C:\> Set-AzureRmSecurityPricing -Name "myService1" -ResourceGroupName "myService1" -PricingTier "Standard" - -Id --- -/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/pricings/... -``` - -Sets the "myService1" resource group Azure Security Center pricing tier to "Standard" - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Input Object. - -```yaml -Type: PSAddPricingInputObject -Parameter Sets: InputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Resource name. - -```yaml -Type: String -Parameter Sets: SubscriptionLevelResource, ResourceGroupLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PricingTier -Pricing Tier. - -```yaml -Type: String -Parameter Sets: SubscriptionLevelResource, ResourceGroupLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource group name. - -```yaml -Type: String -Parameter Sets: ResourceGroupLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Microsoft.Azure.Commands.Security.Cmdlets.Pricings.PSAddPricingInputObject - -## OUTPUTS - -### Microsoft.Azure.Commands.Security.Models.Pricings.PSSecurityPricing - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Security/Set-AzureRmSecurityWorkspaceSetting.md b/azurermps-6.13.0/AzureRM.Security/Set-AzureRmSecurityWorkspaceSetting.md deleted file mode 100644 index 4a79f3a35f..0000000000 --- a/azurermps-6.13.0/AzureRM.Security/Set-AzureRmSecurityWorkspaceSetting.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.SecurityCenter.dll-Help.xml -Module Name: AzureRM.Security -online version: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Set-AzureRmSecurityWorkspaceSetting.md -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Set-AzureRmSecurityWorkspaceSetting.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Set-AzureRmSecurityWorkspaceSetting.md ---- - -# Set-AzureRmSecurityWorkspaceSetting - -## SYNOPSIS -Updates the workspace settings for the subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSecurityWorkspaceSetting -Name <String> -Scope <String> -WorkspaceId <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Updates the workspace settings for the subscription. -The configured workspace will hold the security data that was collected by the security agent that is installed in VMs inside this subscription. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Set-AzureRmSecurityWorkspaceSetting -Name "default" -Scope "/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869" -WorkspaceId "/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourcegroups/mainws/providers/microsoft.operationalinsights/workspaces/securityuserws" - -Id Name WorkspaceId --- ---- ---- -/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/workspaceSettings/default default /... -``` - -Sets the "myWorkspace" workspace to hold all the security data that was collected by the security agents. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Resource name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Scope. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceId -Workspace ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Security.Models.WorkspaceSettings.PSSecurityWorkspaceSetting - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Security/Start-AzureRmJitNetworkAccessPolicy.md b/azurermps-6.13.0/AzureRM.Security/Start-AzureRmJitNetworkAccessPolicy.md deleted file mode 100644 index cb8a590abc..0000000000 --- a/azurermps-6.13.0/AzureRM.Security/Start-AzureRmJitNetworkAccessPolicy.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.SecurityCenter.dll-Help.xml -Module Name: AzureRM.Security -online version: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Start-AzureRmJitNetworkAccessPolicy.md -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Start-AzureRmJitNetworkAccessPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Security/Commands.Security/help/Start-AzureRmJitNetworkAccessPolicy.md ---- - -# Start-AzureRmJitNetworkAccessPolicy - -## SYNOPSIS -Invokes a temporary network access request. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceGroupLevelResource (Default) -``` -Start-AzureRmJitNetworkAccessPolicy -ResourceGroupName <String> -Location <String> -Name <String> - -VirtualMachine <PSSecurityJitNetworkAccessPolicyInitiateVirtualMachine[]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceId -``` -Start-AzureRmJitNetworkAccessPolicy -VirtualMachine <PSSecurityJitNetworkAccessPolicyInitiateVirtualMachine[]> - -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObject -``` -Start-AzureRmJitNetworkAccessPolicy -InputObject <PSSecurityJitNetworkAccessPolicyInitiateInputObject> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Invokes a temporary network access request. -The request is validated against the configured JIT network access policy and if permittet, opens up a network connection according to the user's request. -The request will be loged in the policy for later review and will be terminated when the specified duration will be exceeded. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Set-AzureRmJitNetworkAccessPolicy -ResourceGroupName "myService1" -Location "centralus" -Name "default" -Kind "Basic" -VirtualMachine $vms - -Id : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.S - ecurity/locations/centralus/jitNetworkAccessPolicies/default -Name : default -Kind : Basic -VirtualMachines : {/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft. - Compute/virtualMachines/testService} -Requests : {} -ProvisioningState : Succeeded -``` - -Opens up a network connection according to the specified connection request data. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Input Object. - -```yaml -Type: PSSecurityJitNetworkAccessPolicyInitiateInputObject -Parameter Sets: InputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Location -Location. - -```yaml -Type: String -Parameter Sets: ResourceGroupLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Resource name. - -```yaml -Type: String -Parameter Sets: ResourceGroupLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource group name. - -```yaml -Type: String -Parameter Sets: ResourceGroupLevelResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID. - -```yaml -Type: String -Parameter Sets: ResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachine -Automatic Provisioning. - -```yaml -Type: PSSecurityJitNetworkAccessPolicyInitiateVirtualMachine[] -Parameter Sets: ResourceGroupLevelResource, ResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Microsoft.Azure.Commands.Security.Models.JitNetworkAccessPolicies.PSSecurityJitNetworkAccessPolicyInitiateVirtualMachine[] - -## OUTPUTS - -### Microsoft.Azure.Commands.Security.Models.JitNetworkAccessPolicies.PSSecurityJitNetworkAccessPolicy - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/AzureRM.ServiceBus.md b/azurermps-6.13.0/AzureRM.ServiceBus/AzureRM.ServiceBus.md deleted file mode 100644 index fb4d155a49..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/AzureRM.ServiceBus.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -Module Name: AzureRM.ServiceBus -Module Guid: cc69c625-e961-43f4-8b50-0061eba6e4b6 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus -Help Version: 4.0.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/AzureRM.ServiceBus.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/AzureRM.ServiceBus.md ---- - -# AzureRM.ServiceBus Module -## Description -This topic displays help topics for the Azure Service Bus cmdlets. - -## AzureRM.ServiceBus Cmdlets -### [Complete-AzureRmServiceBusMigration](Complete-AzureRmServiceBusMigration.md) -Cmdlets set the Migration from Standard to premium namespace as complete and connection strings of standard namespace now point to Premium namespace - -### [Get-AzureRmServiceBusAuthorizationRule](Get-AzureRmServiceBusAuthorizationRule.md) -Gets a description of the specified authorization rule for a given Namespace or Queue or Topic or Alias (GeoDR Configurations). - -### [Get-AzureRmServiceBusGeoDRConfiguration](Get-AzureRmServiceBusGeoDRConfiguration.md) -Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace - -### [Get-AzureRmServiceBusKey](Get-AzureRmServiceBusKey.md) -Gets the primary and secondary connection strings for the given Namespace or Queue or Topic or Alias (GeoDR Configurations). - -### [Get-AzureRmServiceBusMigration](Get-AzureRmServiceBusMigration.md) -Retrieves MigrationConfiguration for the namespace - -### [Get-AzureRmServiceBusNamespace](Get-AzureRmServiceBusNamespace.md) -Gets a description for the specified Service Bus namespace within the resource group. - -### [Get-AzureRmServiceBusOperation](Get-AzureRmServiceBusOperation.md) -List supported ServiceBus Operations - -### [Get-AzureRmServiceBusQueue](Get-AzureRmServiceBusQueue.md) -Returns a description for the specified Service Bus queue. - -### [Get-AzureRmServiceBusRule](Get-AzureRmServiceBusRule.md) -Creates a new rule for a given Subscription of Topic. - -### [Get-AzureRmServiceBusSubscription](Get-AzureRmServiceBusSubscription.md) -Returns a subscription description for the specified topic. - -### [Get-AzureRmServiceBusTopic](Get-AzureRmServiceBusTopic.md) -Returns a description for the specified Service Bus topic. - -### [New-AzureRmServiceBusAuthorizationRule](New-AzureRmServiceBusAuthorizationRule.md) -Creates a new authorization rule for the specified Service Bus given Namespace or Queue or Topic. - -### [New-AzureRmServiceBusGeoDRConfiguration](New-AzureRmServiceBusGeoDRConfiguration.md) -Creates an new Alias(Disaster Recovery configuration) - -### [New-AzureRmServiceBusKey](New-AzureRmServiceBusKey.md) -Regenerates the primary or secondary connection strings for the Service Bus namespace or queue or topic. - -### [New-AzureRmServiceBusNamespace](New-AzureRmServiceBusNamespace.md) -Creates a new Service Bus namespace. - -### [New-AzureRmServiceBusQueue](New-AzureRmServiceBusQueue.md) -Creates a Service Bus queue in the specified Service Bus namespace. - -### [New-AzureRmServiceBusRule](New-AzureRmServiceBusRule.md) -Creates a new rule for a given Subscription of Topic. - -### [New-AzureRmServiceBusSubscription](New-AzureRmServiceBusSubscription.md) -Creates a subscription to the specified Service Bus topic. - -### [New-AzureRmServiceBusTopic](New-AzureRmServiceBusTopic.md) -Creates a new Service Bus topic in the specified Service Bus namespace. - -### [Remove-AzureRmServiceBusAuthorizationRule](Remove-AzureRmServiceBusAuthorizationRule.md) -Removes the authorization rule of a Service Bus namespace or queue or topic from the specified resource group. - -### [Remove-AzureRmServiceBusGeoDRConfiguration](Remove-AzureRmServiceBusGeoDRConfiguration.md) -Deletes an Alias(Disaster Recovery configuration) - -### [Remove-AzureRmServiceBusMigration](Remove-AzureRmServiceBusMigration.md) -Cmdlet deletes the Migration configuration for Standard to Premium namespaces - -### [Remove-AzureRmServiceBusNamespace](Remove-AzureRmServiceBusNamespace.md) -Removes the namespace from the specified resource group. - -### [Remove-AzureRmServiceBusQueue](Remove-AzureRmServiceBusQueue.md) -Removes the queue from the specified Service Bus namespace. - -### [Remove-AzureRmServiceBusRule](Remove-AzureRmServiceBusRule.md) -Removes the speficied rule of a given subscription . - -### [Remove-AzureRmServiceBusSubscription](Remove-AzureRmServiceBusSubscription.md) -Removes the subscription to a topic from the specified Service Bus namespace. - -### [Remove-AzureRmServiceBusTopic](Remove-AzureRmServiceBusTopic.md) -Removes the topic from the specified Service Bus namespace. - -### [Set-AzureRmServiceBusAuthorizationRule](Set-AzureRmServiceBusAuthorizationRule.md) -Updates the specified authorization rule description for the given Service Bus namespace or queue or topic. - -### [Set-AzureRmServiceBusGeoDRConfigurationBreakPair](Set-AzureRmServiceBusGeoDRConfigurationBreakPair.md) -This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces - -### [Set-AzureRmServiceBusGeoDRConfigurationFailOver](Set-AzureRmServiceBusGeoDRConfigurationFailOver.md) -Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace - -### [Set-AzureRmServiceBusNamespace](Set-AzureRmServiceBusNamespace.md) -Updates the description of an existing Service Bus namespace. - -### [Set-AzureRmServiceBusQueue](Set-AzureRmServiceBusQueue.md) -Updates the description of a Service Bus queue in the specified Service Bus namespace. - -### [Set-AzureRmServiceBusRule](Set-AzureRmServiceBusRule.md) -Updates the specified rule description for the given subscription. - -### [Set-AzureRmServiceBusSubscription](Set-AzureRmServiceBusSubscription.md) -Updates a subscription description for a Service Bus topic in the specified Service Bus namespace. - -### [Set-AzureRmServiceBusTopic](Set-AzureRmServiceBusTopic.md) -Updates the description of a Service Bus topic in the specified Service Bus namespace. - -### [Start-AzureRmServiceBusMigration](Start-AzureRmServiceBusMigration.md) -Creates a new Migration configuration and starts migrating entities from Standard to Premium namespaces - -### [Stop-AzureRmServiceBusMigration](Stop-AzureRmServiceBusMigration.md) -Terminates the Migration between Standard to premium namespace - -### [Test-AzureRmServiceBusName](Test-AzureRmServiceBusName.md) -Checks the Availability of the given NameSpace Name or Alias (DR Configuration Name) - diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/Complete-AzureRmServiceBusMigration.md b/azurermps-6.13.0/AzureRM.ServiceBus/Complete-AzureRmServiceBusMigration.md deleted file mode 100644 index 1611f22de6..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/Complete-AzureRmServiceBusMigration.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/complete-azurermservicebusmigration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Complete-AzureRmServiceBusMigration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Complete-AzureRmServiceBusMigration.md ---- - -# Complete-AzureRmServiceBusMigration - -## SYNOPSIS -Cmdlets set the Migration from Standard to premium namespace as complete and connection strings of standard namespace now point to Premium namespace - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### MigrationConfigurationPropertiesSet (Default) -``` -Complete-AzureRmServiceBusMigration [-ResourceGroupName] <String> [-Name] <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### NamespaceInputObjectSet -``` -Complete-AzureRmServiceBusMigration [-InputObject] <PSServiceBusDRConfigurationAttributes> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### NamespaceResourceIdParameterSet -``` -Complete-AzureRmServiceBusMigration [-ResourceId] <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Complete-AzureRmServiceBusMigration** cmdlets set the Migration from Standard to premium namespace as complete and connection strings of standard namespace now point to Premium namespace - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Complete-AzureRmServiceBusMigration -ResourceGroupName ResourceGroup -Name NamespaceStandardMirgation -``` - -Sets the Migration of 'NamespaceStandardMirgation' namespace as complete. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Service Bus Migration configuration - Standard Namespace Object - -```yaml -Type: Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusDRConfigurationAttributes -Parameter Sets: NamespaceInputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Standard Namespace Name - -```yaml -Type: System.String -Parameter Sets: MigrationConfigurationPropertiesSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Specifying this will return true if the command was successful. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: MigrationConfigurationPropertiesSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Service Bus Migratio - Standard Namespace Resource Id - -```yaml -Type: System.String -Parameter Sets: NamespaceResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusDRConfigurationAttributes -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusAuthorizationRule.md b/azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusAuthorizationRule.md deleted file mode 100644 index 5929a346d8..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusAuthorizationRule.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/get-azurermservicebusauthorizationrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusAuthorizationRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusAuthorizationRule.md ---- - -# Get-AzureRmServiceBusAuthorizationRule - -## SYNOPSIS -Gets a description of the specified authorization rule for a given Namespace or Queue or Topic or Alias (GeoDR Configurations). - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NamespaceAuthorizationRuleSet (Default) -``` -Get-AzureRmServiceBusAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### QueueAuthorizationRuleSet -``` -Get-AzureRmServiceBusAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [-Queue] <String> - [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### TopicAuthorizationRuleSet -``` -Get-AzureRmServiceBusAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [-Topic] <String> - [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### AliasAuthoRuleSet -``` -Get-AzureRmServiceBusAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> - [-AliasName] <String> [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmServiceBusAuthorizationRule** cmdlet gets the description of the specified authorization rule in the given Namespace or Queue or Topic or Alias (GeoDR Configurations). - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmServiceBusAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Name AuthoRule1 -``` - -Returns the specified authorization rule description for a specified namespace. - -### Example 2 -``` -PS C:\> Get-AzureRmServiceBusAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Queue SBQueue -Name AuthoRule1 -``` - -Returns the specified authorization rule description for a specified queue. - -### Example 3 -``` -PS C:\> Get-AzureRmServiceBusAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Topic SBTopic -Name AuthoRule1 -``` - -Returns the specified authorization rule description for a specified topic. - -### Example 4 -``` -PS C:\> Get-AzureRmServiceBusAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -AliasName SBAlias -Name AuthoRule1 -``` - -Returns the specified authorization rule description for a specified namespace and alias. - -## PARAMETERS - -### -AliasName -GeoDR Configuration Name - -```yaml -Type: System.String -Parameter Sets: AliasAuthoRuleSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -AuthorizationRule Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AuthorizationRuleName - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Queue -Queue Name - -```yaml -Type: System.String -Parameter Sets: QueueAuthorizationRuleSet -Aliases: QueueName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Topic -Topic Name - -```yaml -Type: System.String -Parameter Sets: TopicAuthorizationRuleSet -Aliases: TopicName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceBus.Models.PSSharedAccessAuthorizationRuleAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusGeoDRConfiguration.md b/azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusGeoDRConfiguration.md deleted file mode 100644 index 815cb19fe5..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusGeoDRConfiguration.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/get-azurermservicebusgeodrconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusGeoDRConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusGeoDRConfiguration.md ---- - -# Get-AzureRmServiceBusGeoDRConfiguration - -## SYNOPSIS -Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GeoDRPropertiesSet (Default) -``` -Get-AzureRmServiceBusGeoDRConfiguration [-ResourceGroupName] <String> [-Namespace] <String> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### NamespaceInputObjectSet -``` -Get-AzureRmServiceBusGeoDRConfiguration [-InputObject] <PSNamespaceAttributes> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Get-AzureRmServiceBusGeoDRConfiguration [-ResourceId] <String> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmServiceBusGeoDRConfiguration** Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmServiceBusGeoDRConfiguration -ResourceGroupName "SampleResourceGroup" -Namespace "SampleNamespace_Primary" -Name "SampleDRCongifName" - -Name : SampleDRCongifName -Id : /subscriptions/{SubscriptionId}/resourceGroups/SampleResourceGroup/providers/Microsoft.ServiceBus/namespaces/SampleNamespace_Primary/disasterRecoveryConfigs/SampleDRCongifName -Type : Microsoft.ServiceBus/Namespaces/disasterrecoveryconfigs -ProvisioningState : Accepted -PartnerNamespace : SampleNamespace_Secondary -Role : Primary -PendingReplicationOperationsCount : 0 -``` - -Retrieves alias "SampleDRCongifName" configuration for primary namespace "SampleNamespace_Primary" - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Namespace Object - -```yaml -Type: Microsoft.Azure.Commands.ServiceBus.Models.PSNamespaceAttributes -Parameter Sets: NamespaceInputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -DR Configuration Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: GeoDRPropertiesSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: GeoDRPropertiesSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Namespace Resource Id - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.ServiceBus.Models.PSNamespaceAttributes -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusDRConfigurationAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusKey.md b/azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusKey.md deleted file mode 100644 index ded29fa67c..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusKey.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/get-azurermservicebuskey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusKey.md ---- - -# Get-AzureRmServiceBusKey - -## SYNOPSIS -Gets the primary and secondary connection strings for the given Namespace or Queue or Topic or Alias (GeoDR Configurations). - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NamespaceAuthorizationRuleSet (Default) -``` -Get-AzureRmServiceBusKey [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### QueueAuthorizationRuleSet -``` -Get-AzureRmServiceBusKey [-ResourceGroupName] <String> [-Namespace] <String> [-Queue] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### TopicAuthorizationRuleSet -``` -Get-AzureRmServiceBusKey [-ResourceGroupName] <String> [-Namespace] <String> [-Topic] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### AliasAuthoRuleSet -``` -Get-AzureRmServiceBusKey [-ResourceGroupName] <String> [-Namespace] <String> [-AliasName] <String> - [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmServiceBusKey** cmdlet returns the primary and secondary connection strings for the given Namespace or Queue or Topic or Alias (GeoDR Configurations). - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmServiceBusKey -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Name AuthoRule1 -``` - -Primary and secondary connection string to the specified namespace. - -### Example 2 -``` -PS C:\> Get-AzureRmServiceBusKey -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Queue SBQueue -Name AuthoRule1 -``` - -Primary and secondary connection string to the specified queue. - -### Example 3 -``` -PS C:\> Get-AzureRmServiceBusKey -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Topic SBTopic -Name AuthoRule1 -``` - -Primary and secondary connection string to the specified topic. - -### Example 4 -``` -PS C:\> Get-AzureRmServiceBusKey -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -AliasName SBAlias -Name AuthoRule1 -``` - -Primary and secondary connection string to the specified namespace and alias. - -## PARAMETERS - -### -AliasName -Alias Name - -```yaml -Type: System.String -Parameter Sets: AliasAuthoRuleSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -AuthorizationRule Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AuthorizationRuleName - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Queue -Queue Name - -```yaml -Type: System.String -Parameter Sets: QueueAuthorizationRuleSet -Aliases: QueueName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Topic -Topic Name - -```yaml -Type: System.String -Parameter Sets: TopicAuthorizationRuleSet -Aliases: TopicName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceBus.Models.PSListKeysAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusMigration.md b/azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusMigration.md deleted file mode 100644 index 878724cdeb..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusMigration.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/get-azurermservicebusmigration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusMigration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusMigration.md ---- - -# Get-AzureRmServiceBusMigration - -## SYNOPSIS -Retrieves MigrationConfiguration for the namespace - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### MigrationConfigurationPropertiesSet (Default) -``` -Get-AzureRmServiceBusMigration [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### NamespaceInputObjectSet -``` -Get-AzureRmServiceBusMigration [-InputObject] <PSNamespaceAttributes> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Get-AzureRmServiceBusMigration [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmServiceBusMigration** Retrieves Migration Configuration for the namespace - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmServiceBusMigration -ResourceGroupName ResourceGroup -Name TestingNamespaceStandardMirgation - -Name : TestingNamespaceStandardMirgation -Id : /subscriptions/d7670b40-0217-4af9-985c-972f6702782e/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/TestingNamespaceStandardMirgation/migrationConfigurations/$default -Type : Microsoft.ServiceBus/Namespaces/migrationconfigurations -ProvisioningState : Succeeded -PendingReplicationOperationsCount : 40 -TargetNamespace : /subscriptions/d7670b40-0217-4af9-985c-972f6702782e/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/TestingNamespacePremiumMirgation -PostMigrationName : TestingNamespaceStandardMirgationPostMigration -``` - -Gets the Migration Configuration properties of 'TestingNamespaceStandardMirgation' - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Namespace Object - -```yaml -Type: Microsoft.Azure.Commands.ServiceBus.Models.PSNamespaceAttributes -Parameter Sets: NamespaceInputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Namespace Name - -```yaml -Type: System.String -Parameter Sets: MigrationConfigurationPropertiesSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: MigrationConfigurationPropertiesSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Namespace Resource Id - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ServiceBus.Models.PSNamespaceAttributes -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusMigrationConfigurationAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusNamespace.md b/azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusNamespace.md deleted file mode 100644 index b79ebbf20f..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusNamespace.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/get-azurermservicebusnamespace -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusNamespace.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusNamespace.md ---- - -# Get-AzureRmServiceBusNamespace - -## SYNOPSIS -Gets a description for the specified Service Bus namespace within the resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmServiceBusNamespace [[-ResourceGroupName] <String>] [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmServiceBusNamespace** cmdlet gets a description for the specified Service Bus namespace within the resource group. - -## EXAMPLES - -### Example 1 - -``` -PS C:\> Get-AzureRmServiceBusNamespace -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 - -Name : SB-Example1 -Id : /subscriptions/{subscription id}/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.ServiceBus/namespaces/SB-Example1 -ResourceGroup : Default-ServiceBus-WestUS -Location : West US -Tags : {TesttingTags, TestingTagValue, TestTag, TestTagValue} -Sku : Name : Premium , Tier : Premium -ProvisioningState : Succeeded -CreatedAt : 1/20/2017 1:40:01 AM -UpdatedAt : 1/20/2017 1:40:24 AM -ServiceBusEndpoint : https://SB-Example1.servicebus.windows.net:443/ -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Namespace Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceBus.Models.PSNamespaceAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusOperation.md b/azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusOperation.md deleted file mode 100644 index 62892d94fc..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusOperation.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/get-azurermservicebusoperation -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusOperation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusOperation.md ---- - -# Get-AzureRmServiceBusOperation - -## SYNOPSIS -List supported ServiceBus Operations - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmServiceBusOperation [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmServiceBusOperation** cmdlet Lists the ServiceBus supported Operations. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmServiceBusOperation -``` - -Lists ServiceBus supported operations - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceBus.Models.PSOperationAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusQueue.md b/azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusQueue.md deleted file mode 100644 index 6b53889be2..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusQueue.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/get-azurermservicebusqueue -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusQueue.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusQueue.md ---- - -# Get-AzureRmServiceBusQueue - -## SYNOPSIS -Returns a description for the specified Service Bus queue. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmServiceBusQueue [-ResourceGroupName] <String> [-Namespace] <String> [[-Name] <String>] - [-MaxCount <Int32>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Returns a description for the specified Service Bus queue. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmServiceBusQueue -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -QueueName SB-Queue_example1 - -Id : /subscriptions/{subscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ServiceBus/namespaces/SB-Example1/queues/SB-Queue_example1 -Name : SB-Queue_example1 -LockDuration : PT1M -AccessedAt : 1/1/0001 12:00:00 AM -AutoDeleteOnIdle : P10675199DT2H48M5.4775807S -CreatedAt : 10/11/2018 12:37:11 AM -DefaultMessageTimeToLive : P10675199DT2H48M5.4775807S -DuplicateDetectionHistoryTimeWindow : PT10M -DeadLetteringOnMessageExpiration : False -EnableExpress : False -EnablePartitioning : False -MaxDeliveryCount : 10 -MaxSizeInMegabytes : 81920 -MessageCount : 0 -CountDetails : Microsoft.Azure.Management.ServiceBus.Models.MessageCountDetails -RequiresDuplicateDetection : False -RequiresSession : False -SizeInBytes : 0 -Status : Active -UpdatedAt : 10/11/2018 12:37:11 AM -ForwardTo : -ForwardDeadLetteredMessagesTo : -EnableBatchedOperations : False -``` - -Returns the description of the queue. - -### Example 2 -``` -PS C:\> Get-AzureRmServiceBusQueue -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -``` - -Returns list of queues for given namespace, By default 100 queues will be returned, if more than 100 queues to be returned, please use -MaxCount Parameter. - -### Example 3 -``` -PS C:\> Get-AzureRmServiceBusQueue -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -MaxCount 150 -``` - -Returns list of first 150 queues for given namespace - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxCount -Determine the maximum number of Queues to return. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Queue Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: QueueName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceBus.Models.PSQueueAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusRule.md b/azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusRule.md deleted file mode 100644 index 1537cc6ee1..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusRule.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/get-azurermservicebusrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusRule.md ---- - -# Get-AzureRmServiceBusRule - -## SYNOPSIS -Creates a new rule for a given Subscription of Topic. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmServiceBusRule [-ResourceGroupName] <String> [-Namespace] <String> [-Topic] <String> - [-Subscription] <String> [[-Name] <String>] [-MaxCount <Int32>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmServiceBusRule** cmdlet gets the description of the specified rule in the given subscription of topic. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmServiceBusRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SBExample1 -Topic SBTopic -Subscription SBSubscription -Name SBRule -``` - -Returns the specified rule description for a specified subscription. - -### Example 2 -``` -PS C:\> Get-AzureRmServiceBusRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SBExample1 -Topic SBTopic -Subscription SBSubscription -``` - -Returns list of rule descriptions for a specified subscription. By default 100 rule will be returned, if more than 100 rule to be returned, please use -MaxCount Parameter. - -### Example 3 -``` -PS C:\> Get-AzureRmServiceBusRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SBExample1 -Topic SBTopic -Subscription SBSubscription -MaxCount 150 -``` - -Returns list of first 150 rules descriptions for a specified subscription. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxCount -Determine the maximum number of Rules to return. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Rule Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Subscription -Subscription Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: SubscriptionName - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Topic -Topic Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: TopicName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceBus.Models.PSRulesAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusSubscription.md b/azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusSubscription.md deleted file mode 100644 index 599977363d..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusSubscription.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/get-azurermservicebussubscription -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusSubscription.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusSubscription.md ---- - -# Get-AzureRmServiceBusSubscription - -## SYNOPSIS -Returns a subscription description for the specified topic. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmServiceBusSubscription [-ResourceGroupName] <String> [-Namespace] <String> [-Topic] <String> - [[-Name] <String>] [-MaxCount <Int32>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmServiceBusSubscription** cmdlet returns a subscription description for the specified Service Bus topic. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmServiceBusSubscription -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -TopicName SB-Topic_exampl1 -SubscriptionName SB-TopicSubscription-Example1 - -Name : SB-TopicSubscription-Example1 -AccessedAt : 1/20/2017 3:18:54 AM -AutoDeleteOnIdle : 10675199.02:48:05.4775807 -CountDetails : Microsoft.Azure.Management.ServiceBus.Models.MessageCountDetails -CreatedAt : 1/20/2017 3:18:52 AM -DefaultMessageTimeToLive : 10675199.02:48:05.4775807 -DeadLetteringOnMessageExpiration : False -EnableBatchedOperations : True -LockDuration : 00:01:00 -MaxDeliveryCount : 10 -MessageCount : 0 -RequiresSession : False -Status : Active -UpdatedAt : 1/20/2017 3:18:54 AM -``` - -Returns a subscription description for the specified Service Bus topic. - -### Example 2 -``` -PS C:\> Get-AzureRmServiceBusSubscription -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -TopicName SB-Topic_exampl1 -``` - -Returns list of subscriptions for specified Service Bus topic. By default 100 subscriptions will be returned, for number of subscriptions please use -MaxCount Parameter - -### Example 3 -``` -PS C:\> Get-AzureRmServiceBusSubscription -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -TopicName SB-Topic_exampl1 -MaxCount 150 -``` - -Returns list of first 150 subscriptions for specified Service Bus topic. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxCount -Determine the maximum number of Subscriptions to return. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Subscription Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: SubscriptionName - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Topic -Topic Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: TopicName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceBus.Models.PSSubscriptionAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusTopic.md b/azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusTopic.md deleted file mode 100644 index 04c33893b9..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/Get-AzureRmServiceBusTopic.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/get-azurermservicebustopic -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusTopic.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusTopic.md ---- - -# Get-AzureRmServiceBusTopic - -## SYNOPSIS -Returns a description for the specified Service Bus topic. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmServiceBusTopic [-ResourceGroupName] <String> [-Namespace] <String> [[-Name] <String>] - [-MaxCount <Int32>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmServiceBusTopic** cmdlet returns a topic description for the specified Service Bus namespace. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmServiceBusTopic -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -TopicName SB-Topic_exampl1 - -Name : SB-Topic_example1 -Id : /subscriptions/{subscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ServiceBus/namespaces/SB-Example1/topics/SB-Topic_example1 -Type : Microsoft.ServiceBus/Namespaces/Topics -AccessedAt : 1/1/0001 12:00:00 AM -AutoDeleteOnIdle : P10675199DT2H48M5.4775807S -CreatedAt : 10/11/2018 11:51:24 PM -CountDetails : Microsoft.Azure.Management.ServiceBus.Models.MessageCountDetails -DefaultMessageTimeToLive : P10675199DT2H48M5.4775807S -DuplicateDetectionHistoryTimeWindow : PT10M -EnableBatchedOperations : True -EnableExpress : False -EnablePartitioning : False -MaxSizeInMegabytes : 81920 -RequiresDuplicateDetection : False -SizeInBytes : 0 -Status : Active -SubscriptionCount : 0 -SupportOrdering : True -UpdatedAt : 10/11/2018 11:51:24 PM -``` - -Returns the description of the specified topic for the given Service Bus namespace. - -### Example 2 -``` -PS C:\> Get-AzureRmServiceBusTopic -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -``` - -Returns list of topics for given Service Bus namespace. By default 100 topics will be returned, if more than 100 topics to be returned, please use -MaxCount Parameter. - -### Example 3 -``` -PS C:\> Get-AzureRmServiceBusTopic -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -MaxCount 150 -``` - -Returns list of first 150 topics for given Service Bus namespace. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxCount -Determine the maximum number of Topics to return. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Topic Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: TopicName - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceBus.Models.PSTopicAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/New-AzureRmServiceBusAuthorizationRule.md b/azurermps-6.13.0/AzureRM.ServiceBus/New-AzureRmServiceBusAuthorizationRule.md deleted file mode 100644 index f8446f098e..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/New-AzureRmServiceBusAuthorizationRule.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/new-azurermservicebusauthorizationrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/New-AzureRmServiceBusAuthorizationRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/New-AzureRmServiceBusAuthorizationRule.md ---- - -# New-AzureRmServiceBusAuthorizationRule - -## SYNOPSIS -Creates a new authorization rule for the specified Service Bus given Namespace or Queue or Topic. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NamespaceAuthorizationRuleSet (Default) -``` -New-AzureRmServiceBusAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - -Rights <String[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### QueueAuthorizationRuleSet -``` -New-AzureRmServiceBusAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [-Queue] <String> - [-Name] <String> -Rights <String[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### TopicAuthorizationRuleSet -``` -New-AzureRmServiceBusAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [-Topic] <String> - [-Name] <String> -Rights <String[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmServiceBusAuthorizationRule** cmdlet creates a new authorization rule for the specified Service Bus namespace or queue or topic. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmServiceBusAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Name AuthoRule1 -Rights @("Listen","Send") -``` - -Creates `AuthoRule1` with **Listen** and **Send** rights for the namespace `SB-Example1`. - -### Example 2 -``` -PS C:\> New-AzureRmServiceBusAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Queue SBQueue -Name AuthoRule1 -Rights @("Listen","Send") -``` - -Creates `AuthoRule1` with **Listen** and **Send** rights for the queue `SBQueue`. - -### Example 3 -``` -PS C:\> New-AzureRmServiceBusAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Topic SBTopic -Name AuthoRule1 -Rights @("Listen","Send") -``` - -Creates `AuthoRule1` with **Listen** and **Send** rights for the topic `SBTopic`. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -AuthorizationRule Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AuthorizationRuleName - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Queue -Queue Name - -```yaml -Type: System.String -Parameter Sets: QueueAuthorizationRuleSet -Aliases: QueueName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Rights -Rights, e.g. -"Listen","Send","Manage" - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: -Accepted values: Listen, Send, Manage - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Topic -Topic Name - -```yaml -Type: System.String -Parameter Sets: TopicAuthorizationRuleSet -Aliases: TopicName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.String[] - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceBus.Models.PSSharedAccessAuthorizationRuleAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/New-AzureRmServiceBusGeoDRConfiguration.md b/azurermps-6.13.0/AzureRM.ServiceBus/New-AzureRmServiceBusGeoDRConfiguration.md deleted file mode 100644 index f26a29fc59..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/New-AzureRmServiceBusGeoDRConfiguration.md +++ /dev/null @@ -1,243 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/new-azurermservicebusgeodrconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/New-AzureRmServiceBusGeoDRConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/New-AzureRmServiceBusGeoDRConfiguration.md ---- - -# New-AzureRmServiceBusGeoDRConfiguration - -## SYNOPSIS -Creates an new Alias(Disaster Recovery configuration) - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GeoDRPropertiesSet (Default) -``` -New-AzureRmServiceBusGeoDRConfiguration [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - [-PartnerNamespace] <String> [-AlternateName <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### NamespaceInputObjectSet -``` -New-AzureRmServiceBusGeoDRConfiguration [-InputObject] <PSNamespaceAttributes> [-Name] <String> - [-PartnerNamespace] <String> [-AlternateName <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### NamespaceResourceIdParameterSet -``` -New-AzureRmServiceBusGeoDRConfiguration [-ResourceId] <String> [-Name] <String> [-PartnerNamespace] <String> - [-AlternateName <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmServiceBusGeoDRConfiguration** cmdlet Creates a new Alias(Disaster Recovery configuration) - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-AzureRmServiceBusGeoDRConfiguration -ResourceGroupName "SampleResourceGroup" -Namespace "SampleNamespace_Primary" -Name "SampleDRCongifName" -PartnerNamespace "/subscriptions/{SubscriptionId}/resourceGroups/SampleResourceGroup/providers/Microsoft.ServiceBus/namespaces/SampleNamespace_Secondary" - -Name : SampleDRCongifName -Id : /subscriptions/{SubscriptionId}/resourceGroups/SampleResourceGroup/providers/Microsoft.ServiceBus/namespaces/SampleNamespace_Primary/disasterRecoveryConfigs/SampleDRCongifName -Type : Microsoft.ServiceBus/Namespaces/disasterrecoveryconfigs -ProvisioningState : Accepted -PartnerNamespace : /subscriptions/{SubscriptionId}/resourceGroups/TestignGeoDR/providers/Microsoft.ServiceBus/namespaces/SampleNamespaceSecondary -Role : Primary -``` - -Creates an alias "SampleDRCongifName" with primary namespace "SampleNamespace_Primary" with secondary namespace "SampleNamespace_Secondary" - -## PARAMETERS - -### -AlternateName -AlternateName - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Namespace Object - -```yaml -Type: Microsoft.Azure.Commands.ServiceBus.Models.PSNamespaceAttributes -Parameter Sets: NamespaceInputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -DR Configuration Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: GeoDRPropertiesSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PartnerNamespace -DR Configuration PartnerNamespace (ARM Id of PartnerNamespace [Secondary namespace]) - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: GeoDRPropertiesSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Namespace Resource Id - -```yaml -Type: System.String -Parameter Sets: NamespaceResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.ServiceBus.Models.PSNamespaceAttributes -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusDRConfigurationAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/New-AzureRmServiceBusKey.md b/azurermps-6.13.0/AzureRM.ServiceBus/New-AzureRmServiceBusKey.md deleted file mode 100644 index cb1670a693..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/New-AzureRmServiceBusKey.md +++ /dev/null @@ -1,254 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/new-azurermservicebuskey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/New-AzureRmServiceBusKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/New-AzureRmServiceBusKey.md ---- - -# New-AzureRmServiceBusKey - -## SYNOPSIS -Regenerates the primary or secondary connection strings for the Service Bus namespace or queue or topic. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NamespaceAuthorizationRuleSet (Default) -``` -New-AzureRmServiceBusKey [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - -RegenerateKey <String> [-KeyValue <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### QueueAuthorizationRuleSet -``` -New-AzureRmServiceBusKey [-ResourceGroupName] <String> [-Namespace] <String> [-Queue] <String> [-Name] <String> - -RegenerateKey <String> [-KeyValue <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### TopicAuthorizationRuleSet -``` -New-AzureRmServiceBusKey [-ResourceGroupName] <String> [-Namespace] <String> [-Topic] <String> [-Name] <String> - -RegenerateKey <String> [-KeyValue <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmServiceBusKey** cmdlet generates new primary or secondary connection strings for the specified namespace or queue or topic and authorization rule. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmServiceBusKey -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Name AuthoRule1 -RegenerateKey PrimaryKey -``` - -Regenerates the primary or secondary connection strings for the namespace. - -### Example 1.1 -``` -PS C:\> New-AzureRmServiceBusKey -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Name AuthoRule1 -RegenerateKey PrimaryKey -KeyValue {base64-encoded 256-bit key} -``` - -Regenerates the primary or secondary connection strings with provided Key value for the namespace. - -### Example 2 -``` -PS C:\> New-AzureRmServiceBusKey -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Queue SBQueue -Name AuthoRule1 -RegenerateKey PrimaryKey -``` - -Regenerates the primary or secondary connection strings for the queue. - -### Example 2.2 -``` -PS C:\> New-AzureRmServiceBusKey -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Queue SBQueue -Name AuthoRule1 -RegenerateKey PrimaryKey -KeyValue {base64-encoded 256-bit key} -``` - -Regenerates the primary or secondary connection strings with provided Key value for the queue. - -### Example 3 -``` -PS C:\> New-AzureRmServiceBusKey -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Topic SBTopic -Name AuthoRule1 -RegenerateKey PrimaryKey -``` - -Regenerates the primary or secondary connection strings for the topic. - -### Example 3.1 -``` -PS C:\> New-AzureRmServiceBusKey -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Topic SBTopic -Name AuthoRule1 -RegenerateKey PrimaryKey -KeyValue {base64-encoded 256-bit key} -``` - -Regenerates the primary or secondary connection strings with provided Key value for the topic. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyValue -A base64-encoded 256-bit key for signing and validating the SAS token. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -AuthorizationRule Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AuthorizationRuleName - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Queue -Queue Name - -```yaml -Type: System.String -Parameter Sets: QueueAuthorizationRuleSet -Aliases: QueueName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RegenerateKey -Regenerate Keys - 'PrimaryKey'/'SecondaryKey'. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: PrimaryKey, SecondaryKey - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Topic -Topic Name - -```yaml -Type: System.String -Parameter Sets: TopicAuthorizationRuleSet -Aliases: TopicName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceBus.Models.PSListKeysAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/New-AzureRmServiceBusNamespace.md b/azurermps-6.13.0/AzureRM.ServiceBus/New-AzureRmServiceBusNamespace.md deleted file mode 100644 index 9b13676d88..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/New-AzureRmServiceBusNamespace.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/new-azurermservicebusnamespace -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/New-AzureRmServiceBusNamespace.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/New-AzureRmServiceBusNamespace.md ---- - -# New-AzureRmServiceBusNamespace - -## SYNOPSIS -Creates a new Service Bus namespace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmServiceBusNamespace [-ResourceGroupName] <String> [-Location] <String> [-Name] <String> - [-SkuName <String>] [-SkuCapacity <Int32>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmServiceBusNamespace** cmdlet creates a new Service Bus namespace. Once created, the namespace resource manifest is immutable. This operation is idempotent. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmServiceBusNamespace -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -Location WestUS -SkuName "Standard" -Tag @{Tag1="Tag1Value"} - -Name : SB-Example1 -Id : /subscriptions/{SubscriptionId}/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.ServiceBus/namespaces/SB-Example1 -ResourceGroup : Default-ServiceBus-WestUS -Location : West US -Tags : {TesttingTags, TestingTagValue, TestTag, TestTagValue} -Sku : Name : Premium , Tier : Premium -ProvisioningState : Succeeded -CreatedAt : 1/20/2017 2:07:33 AM -UpdatedAt : 1/20/2017 2:07:56 AM -ServiceBusEndpoint : https://SB-Example1.servicebus.windows.net:443/ -``` - -Creates a new Service Bus namespace within the specified resource group. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The Service Bus namespace location. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -ServiceBus Namespace Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuCapacity -The Service Bus premium namespace throughput units, allowed values 1 or 2 or 4 - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuName -The Service Bus namespace SKU name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Basic, Standard, Premium - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table set as tags on the server. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceBus.Models.PSNamespaceAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/New-AzureRmServiceBusQueue.md b/azurermps-6.13.0/AzureRM.ServiceBus/New-AzureRmServiceBusQueue.md deleted file mode 100644 index f3bf2d727b..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/New-AzureRmServiceBusQueue.md +++ /dev/null @@ -1,428 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/new-azurermservicebusqueue -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/New-AzureRmServiceBusQueue.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/New-AzureRmServiceBusQueue.md ---- - -# New-AzureRmServiceBusQueue - -## SYNOPSIS -Creates a Service Bus queue in the specified Service Bus namespace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmServiceBusQueue [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - [-EnablePartitioning <Boolean>] [-LockDuration <String>] [-AutoDeleteOnIdle <String>] - [-DefaultMessageTimeToLive <String>] [-DuplicateDetectionHistoryTimeWindow <String>] - [-DeadLetteringOnMessageExpiration <Boolean>] [-EnableBatchedOperations] [-EnableExpress <Boolean>] - [-MaxDeliveryCount <Int32>] [-MaxSizeInMegabytes <Int64>] [-MessageCount <Int64>] - [-RequiresDuplicateDetection <Boolean>] [-RequiresSession <Boolean>] [-SizeInBytes <Int64>] - [-ForwardTo <String>] [-ForwardDeadLetteredMessagesTo <String>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmServiceBusQueue** cmdlet creates a Service Bus queue in the specified Service Bus namespace. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmServiceBusQueue -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -QueueName SB-Queue_example1 -EnablePartitioning $True - -Id : /subscriptions/{subscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ServiceBus/namespaces/SB-Example1/queues/SB-Queue_example1 -Name : SB-Queue_example1 -LockDuration : PT1M -AccessedAt : 1/1/0001 12:00:00 AM -AutoDeleteOnIdle : P10675199DT2H48M5.4775807S -CreatedAt : 10/11/2018 12:37:11 AM -DefaultMessageTimeToLive : P10675199DT2H48M5.4775807S -DuplicateDetectionHistoryTimeWindow : PT10M -DeadLetteringOnMessageExpiration : False -EnableExpress : False -EnablePartitioning : False -MaxDeliveryCount : 10 -MaxSizeInMegabytes : 81920 -MessageCount : 0 -CountDetails : Microsoft.Azure.Management.ServiceBus.Models.MessageCountDetails -RequiresDuplicateDetection : False -RequiresSession : False -SizeInBytes : 0 -Status : Active -UpdatedAt : 10/11/2018 12:37:12 AM -ForwardTo : -ForwardDeadLetteredMessagesTo : -EnableBatchedOperations : False -``` - -Creates a new Service Bus queue `SB-Queue_example1` in the specified Service Bus namespace `SB-Example1`. - -## PARAMETERS - -### -AutoDeleteOnIdle -Specifies the [TimeSpan](https://msdn.microsoft.com/library/system.timespan.aspx) idle interval, after which the queue is automatically deleted. The minimum duration is 5 minutes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DeadLetteringOnMessageExpiration -Dead Lettering On Message Expiration - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: -Accepted values: TRUE, FALSE - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultMessageTimeToLive -Timespan to live value. -This is the duration after which the message expires, starting from when the message is sent to Service Bus. -This is the default value used when TimeToLive is not set on a message itself. -For Standard = Timespan.Max and Basic = 14 dyas - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DuplicateDetectionHistoryTimeWindow -Specifies the duplicate detection history time window, a [TimeSpan](https://msdn.microsoft.com/library/system.timespan.aspx) valuethat defines the duration of the duplicate detection history. The default value is 10 minutes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableBatchedOperations -Enable Batched Operations - value that indicates whether server-side batched operations are enabled - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableExpress -EnableExpress - a value that indicates whether Express Entities are enabled. -An express queue holds a message in memory temporarily before writing it to persistent storage. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: -Accepted values: TRUE, FALSE - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnablePartitioning -EnablePartitioning - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: -Accepted values: TRUE, FALSE - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ForwardDeadLetteredMessagesTo -Queue/Topic name to forward the Dead Letter message - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ForwardTo -Queue/Topic name to forward the messages - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LockDuration -Lock Duration - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaxDeliveryCount -MaxDeliveryCount - the maximum delivery count. -A message is automatically deadlettered after this number of deliveries. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaxSizeInMegabytes -MaxSizeInMegabytes - the maximum size of the queue in megabytes, which is the size of memory allocated for the queue. - -```yaml -Type: System.Nullable`1[System.Int64] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MessageCount -MessageCount - the number of messages in the queue - -```yaml -Type: System.Nullable`1[System.Int64] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Queue Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: QueueName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RequiresDuplicateDetection -RequiresDuplicateDetection - a value that indicates whether the queue supports the concept of session - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: -Accepted values: TRUE, FALSE - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RequiresSession -RequiresSession - the value indicating if this queue requires duplicate detection - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: -Accepted values: TRUE, FALSE - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SizeInBytes -SizeInBytes - the size of the queue in bytes - -```yaml -Type: System.Nullable`1[System.Int64] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Nullable`1[[System.Int64, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceBus.Models.PSQueueAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/New-AzureRmServiceBusRule.md b/azurermps-6.13.0/AzureRM.ServiceBus/New-AzureRmServiceBusRule.md deleted file mode 100644 index ecdfe3f932..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/New-AzureRmServiceBusRule.md +++ /dev/null @@ -1,237 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/new-azurermservicebusrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/New-AzureRmServiceBusRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/New-AzureRmServiceBusRule.md ---- - -# New-AzureRmServiceBusRule - -## SYNOPSIS -Creates a new rule for a given Subscription of Topic. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RulePropertiesSet (Default) -``` -New-AzureRmServiceBusRule [-ResourceGroupName] <String> [-Namespace] <String> [-Topic] <String> - [-Subscription] <String> [-Name] <String> [-SqlExpression] <String> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RuleActionPropertiesSet -``` -New-AzureRmServiceBusRule [-ResourceGroupName] <String> [-Namespace] <String> [-Topic] <String> - [-Subscription] <String> [-Name] <String> [-SqlExpression] <String> -ActionSqlExpression <String> - [-RequiresPreprocessing] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmServiceBusRule** cmdlet Creates a new rule for given subscription. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmServiceBusRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SBExample1 -Topic SBTopic -Subscription SBSubscription -Name SBRule -SqlExpression "mysqlexpression='test'" -``` - -The New-AzureRmServiceBusRule cmdlet creates a new rule for the specified Subscription. - - -### Example 2 -``` -PS C:\> New-AzureRmServiceBusRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SBExample1 -Topic SBTopic -Subscription SBSubscription -Name SBRule -SqlExpression "mysqlexpression='test'" -ActionSqlExpression "SET myAction='test'" -RequiresPreprocessing -``` - -The New-AzureRmServiceBusRule cmdlet creates a new rule for the specified Subscription with ActionFilter. - -## PARAMETERS - -### -ActionSqlExpression -Action SqlFillter Expression - -```yaml -Type: System.String -Parameter Sets: RuleActionPropertiesSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Rule Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RequiresPreprocessing -Action Requires Preprocessing - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: RuleActionPropertiesSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SqlExpression -Sql Fillter Expression - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Subscription -Subscription Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: SubscriptionName - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Topic -Topic Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: TopicName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceBus.Models.PSRulesAttributes - - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/New-AzureRmServiceBusSubscription.md b/azurermps-6.13.0/AzureRM.ServiceBus/New-AzureRmServiceBusSubscription.md deleted file mode 100644 index 9734e2c91a..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/New-AzureRmServiceBusSubscription.md +++ /dev/null @@ -1,337 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/new-azurermservicebussubscription -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/New-AzureRmServiceBusSubscription.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/New-AzureRmServiceBusSubscription.md ---- - -# New-AzureRmServiceBusSubscription - -## SYNOPSIS -Creates a subscription to the specified Service Bus topic. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmServiceBusSubscription [-ResourceGroupName] <String> [-Namespace] <String> [-Topic] <String> - [-Name] <String> [-AutoDeleteOnIdle <String>] [-DefaultMessageTimeToLive <String>] - [-DeadLetteringOnMessageExpiration <Boolean>] [-DeadLetteringOnFilterEvaluationExceptions] - [-EnableBatchedOperations <Boolean>] [-LockDuration <String>] [-MaxDeliveryCount <Int32>] - [-RequiresSession <Boolean>] [-ForwardTo <String>] [-ForwardDeadLetteredMessagesTo <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmServiceBusSubscription** cmdlet creates a new subscription to the specified Service Bus topic. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmServiceBusSubscription -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -TopicName SB-Topic_exampl1 -SubscriptionName SB-TopicSubscription-Example1 - -Name : SB-TopicSubscription-Example1 -AccessedAt : 1/20/2017 3:18:54 AM -AutoDeleteOnIdle : 10675199.02:48:05.4775807 -CountDetails : Microsoft.Azure.Management.ServiceBus.Models.MessageCountDetails -CreatedAt : 1/20/2017 3:18:52 AM -DefaultMessageTimeToLive : 10675199.02:48:05.4775807 -DeadLetteringOnMessageExpiration : False -EnableBatchedOperations : True -LockDuration : 00:01:00 -MaxDeliveryCount : 10 -MessageCount : 0 -RequiresSession : False -Status : Active -UpdatedAt : 1/20/2017 3:18:54 AM -``` - -Creates the subscription `SB-TopicSubscription-Example1` for the specified Service Bus topic `SB-Topic_exampl1`. - -## PARAMETERS - -### -AutoDeleteOnIdle -Specifies the [TimeSpan](https://msdn.microsoft.com/library/system.timespan.aspx) idle interval, after which the subscription is automatically deleted. The minimum duration is 5 minutes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DeadLetteringOnFilterEvaluationExceptions -Value that indicates whether a subscription has dead letter support on filter evaluation exceptions. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeadLetteringOnMessageExpiration -Dead Lettering On Message Expiration - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: -Accepted values: TRUE, FALSE - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultMessageTimeToLive -Timespan to live value. -This is the duration after which the message expires, starting from when the message is sent to Service Bus. -This is the default value used when TimeToLive is not set on a message itself. -For Standard = Timespan.Max and Basic = 14 dyas - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableBatchedOperations -Enable Batched Operations - value that indicates whether server-side batched operations are enabled - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: -Accepted values: TRUE, FALSE - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ForwardDeadLetteredMessagesTo -Queue/Topic name to forward the Dead Letter message - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ForwardTo -Queue/Topic name to forward the messages - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LockDuration -Lock Duration - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaxDeliveryCount -MaxDeliveryCount - the maximum delivery count. -A message is automatically deadlettered after this number of deliveries. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Subscription Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: SubscriptionName - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RequiresSession -RequiresSession - the value indicating if this queue requires duplicate detection. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: -Accepted values: TRUE, FALSE - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Topic -Topic Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: TopicName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceBus.Models.PSSubscriptionAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/New-AzureRmServiceBusTopic.md b/azurermps-6.13.0/AzureRM.ServiceBus/New-AzureRmServiceBusTopic.md deleted file mode 100644 index 14661d2d44..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/New-AzureRmServiceBusTopic.md +++ /dev/null @@ -1,325 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/new-azurermservicebustopic -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/New-AzureRmServiceBusTopic.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/New-AzureRmServiceBusTopic.md ---- - -# New-AzureRmServiceBusTopic - -## SYNOPSIS -Creates a new Service Bus topic in the specified Service Bus namespace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmServiceBusTopic [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - -EnablePartitioning <Boolean> [-AutoDeleteOnIdle <String>] [-DefaultMessageTimeToLive <String>] - [-DuplicateDetectionHistoryTimeWindow <String>] [-EnableBatchedOperations <Boolean>] - [-EnableExpress <Boolean>] [-MaxSizeInMegabytes <Int64>] [-RequiresDuplicateDetection <Boolean>] - [-SupportOrdering <Boolean>] [-SizeInBytes <Int64>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmServiceBusTopic** cmdlet creates a new Service Bus topic in the specified Service Bus namespace. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmServiceBusTopic -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -TopicName SB-Topic_exampl1 -EnablePartitioning $True - -Name : SB-Topic_example1 -Id : /subscriptions/{subscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ServiceBus/namespaces/SB-Example1/topics/SB-Topic_example1 -Type : Microsoft.ServiceBus/Namespaces/Topics -AccessedAt : 1/1/0001 12:00:00 AM -AutoDeleteOnIdle : P10675199DT2H48M5.4775807S -CreatedAt : 10/11/2018 11:51:24 PM -CountDetails : Microsoft.Azure.Management.ServiceBus.Models.MessageCountDetails -DefaultMessageTimeToLive : P10675199DT2H48M5.4775807S -DuplicateDetectionHistoryTimeWindow : PT10M -EnableBatchedOperations : True -EnableExpress : False -EnablePartitioning : False -MaxSizeInMegabytes : 81920 -RequiresDuplicateDetection : False -SizeInBytes : 0 -Status : Active -SubscriptionCount : 0 -SupportOrdering : True -UpdatedAt : 10/11/2018 11:51:24 PM -``` - -Creates a new Service Bus topic `SB-Topic_exampl1` in the specified Service Bus namespace `SB-Example1`. - -## PARAMETERS - -### -AutoDeleteOnIdle -Specifies the [TimeSpan](https://msdn.microsoft.com/library/system.timespan.aspx) idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultMessageTimeToLive -Specifies the duration after which the message expires, starting from when the message is sent to Service Bus. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DuplicateDetectionHistoryTimeWindow -Specifies the [TimeSpan](https://msdn.microsoft.com/library/system.timespan.aspx) structure that defines the duration of the duplicate detection history. The default value is 10 minutes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableBatchedOperations -Indicates whether server-side batched operations are enabled. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: -Accepted values: TRUE, FALSE - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableExpress -Indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: -Accepted values: TRUE, FALSE - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnablePartitioning -Specifies whether to enable the topic to be partitioned across multiple message brokers. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: -Accepted values: TRUE, FALSE - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaxSizeInMegabytes -The maximum size of the topic in megabytes, which is the size of memory allocated for the topic. - -```yaml -Type: System.Nullable`1[System.Int64] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Topic Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: TopicName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RequiresDuplicateDetection -Indicates whether the topic requires duplication detection. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: -Accepted values: TRUE, FALSE - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SizeInBytes -Specifies the size of the topic in bytes. - -```yaml -Type: System.Nullable`1[System.Int64] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SupportOrdering -Indicates whether the topic supports ordering. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: -Accepted values: TRUE, FALSE - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Nullable`1[[System.Int64, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceBus.Models.PSTopicAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/Remove-AzureRmServiceBusAuthorizationRule.md b/azurermps-6.13.0/AzureRM.ServiceBus/Remove-AzureRmServiceBusAuthorizationRule.md deleted file mode 100644 index 372d63ebfc..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/Remove-AzureRmServiceBusAuthorizationRule.md +++ /dev/null @@ -1,251 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/remove-azurermservicebusauthorizationrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Remove-AzureRmServiceBusAuthorizationRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Remove-AzureRmServiceBusAuthorizationRule.md ---- - -# Remove-AzureRmServiceBusAuthorizationRule - -## SYNOPSIS -Removes the authorization rule of a Service Bus namespace or queue or topic from the specified resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NamespaceAuthorizationRuleSet (Default) -``` -Remove-AzureRmServiceBusAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - [[-InputObject] <PSSharedAccessAuthorizationRuleAttributes>] [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### QueueAuthorizationRuleSet -``` -Remove-AzureRmServiceBusAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [-Queue] <String> - [-Name] <String> [[-InputObject] <PSSharedAccessAuthorizationRuleAttributes>] [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### TopicAuthorizationRuleSet -``` -Remove-AzureRmServiceBusAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [-Topic] <String> - [-Name] <String> [[-InputObject] <PSSharedAccessAuthorizationRuleAttributes>] [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmServiceBusAuthorizationRule** cmdlet removes the authorization rule of a Service Bus namespace or queue or topic for the specified resource group. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmServiceBusAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Name AuthoRule1 -``` - -Removes the authorization rule `SBAuthoRule1` of namespace `SB-Example1` from the specified resource group. - -### Example 2 -``` -PS C:\> Remove-AzureRmServiceBusAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Queue SBQueue -Name AuthoRule1 -``` - -Removes the authorization rule `SBAuthoRule1` of queue `SBQueue` from the specified resource group. - -### Example 3 -``` -PS C:\> Remove-AzureRmServiceBusAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Topic SBTopic -Name AuthoRule1 -``` - -Removes the authorization rule `SBAuthoRule1` of topic `SBTopic` from the specified resource group. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -ServiceBus AuthorizationRule Object - -```yaml -Type: Microsoft.Azure.Commands.ServiceBus.Models.PSSharedAccessAuthorizationRuleAttributes -Parameter Sets: (All) -Aliases: AuthRuleObj - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -AuthorizationRule Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AuthorizationRuleName - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Queue -Queue Name - -```yaml -Type: System.String -Parameter Sets: QueueAuthorizationRuleSet -Aliases: QueueName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Topic -Topic Name - -```yaml -Type: System.String -Parameter Sets: TopicAuthorizationRuleSet -Aliases: TopicName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.ServiceBus.Models.PSSharedAccessAuthorizationRuleAttributes -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/Remove-AzureRmServiceBusGeoDRConfiguration.md b/azurermps-6.13.0/AzureRM.ServiceBus/Remove-AzureRmServiceBusGeoDRConfiguration.md deleted file mode 100644 index 5676cafc03..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/Remove-AzureRmServiceBusGeoDRConfiguration.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/remove-azurermservicebusgeodrconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Remove-AzureRmServiceBusGeoDRConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Remove-AzureRmServiceBusGeoDRConfiguration.md ---- - -# Remove-AzureRmServiceBusGeoDRConfiguration - -## SYNOPSIS -Deletes an Alias(Disaster Recovery configuration) - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GeoDRPropertiesSet (Default) -``` -Remove-AzureRmServiceBusGeoDRConfiguration [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### GeoDRConfigurationInputObjectSet -``` -Remove-AzureRmServiceBusGeoDRConfiguration [-InputObject] <PSServiceBusDRConfigurationAttributes> [-PassThru] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### GeoDRConfigResourceIdParameterSet -``` -Remove-AzureRmServiceBusGeoDRConfiguration [-ResourceId] <String> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmServiceBusGeoDRConfiguration** cmdlet deletes an Alias(Disaster Recovery configuration) - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmServiceBusGeoDRConfiguration -ResourceGroupName "SampleResourceGroup" -Namespace "SampleNamespace_Secondary" -Name "SampleDRCongifName" -``` - -Deletes an Alias(Disaster Recovery configuration) - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Service Bus GeoDR Configuration Object - -```yaml -Type: Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusDRConfigurationAttributes -Parameter Sets: GeoDRConfigurationInputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Alias (GeoDR) Name - -```yaml -Type: System.String -Parameter Sets: GeoDRPropertiesSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: GeoDRPropertiesSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: GeoDRPropertiesSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -GeoDRConfiguration Resource Id - -```yaml -Type: System.String -Parameter Sets: GeoDRConfigResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusDRConfigurationAttributes -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/Remove-AzureRmServiceBusMigration.md b/azurermps-6.13.0/AzureRM.ServiceBus/Remove-AzureRmServiceBusMigration.md deleted file mode 100644 index 63409577a8..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/Remove-AzureRmServiceBusMigration.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/remove-azurermservicebusmigration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Remove-AzureRmServiceBusMigration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Remove-AzureRmServiceBusMigration.md ---- - -# Remove-AzureRmServiceBusMigration - -## SYNOPSIS -Cmdlet deletes the Migration configuration for Standard to Premium namespaces - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### MigrationConfigurationPropertiesSet (Default) -``` -Remove-AzureRmServiceBusMigration [-ResourceGroupName] <String> [-Name] <String> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### NamespaceInputObjectSet -``` -Remove-AzureRmServiceBusMigration [-InputObject] <PSServiceBusDRConfigurationAttributes> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### NamespaceResourceIdParameterSet -``` -Remove-AzureRmServiceBusMigration [-ResourceId] <String> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmServiceBusMigration** cmdlet deletes the Migration configuration for Standard to Premium namespaces - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-AzureRmServiceBusMigration -ResourceGroupName ResourceGroup -Name TestingNamespaceStandardMirgation -``` - -Deletes the 'TestingNamespaceStandardMirgation' migration configuration - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Service Bus Migration Standard Namespace Object - -```yaml -Type: Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusDRConfigurationAttributes -Parameter Sets: NamespaceInputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Standard Namespace Name - -```yaml -Type: System.String -Parameter Sets: MigrationConfigurationPropertiesSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Specifying this will return true if the command was successful. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: MigrationConfigurationPropertiesSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Service Bus Migration Standard Namespace Resource Id - -```yaml -Type: System.String -Parameter Sets: NamespaceResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusDRConfigurationAttributes -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/Remove-AzureRmServiceBusNamespace.md b/azurermps-6.13.0/AzureRM.ServiceBus/Remove-AzureRmServiceBusNamespace.md deleted file mode 100644 index 7aa505bd16..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/Remove-AzureRmServiceBusNamespace.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/remove-azurermservicebusnamespace -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Remove-AzureRmServiceBusNamespace.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Remove-AzureRmServiceBusNamespace.md ---- - -# Remove-AzureRmServiceBusNamespace - -## SYNOPSIS -Removes the namespace from the specified resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NamespacePropertiesSet (Default) -``` -Remove-AzureRmServiceBusNamespace [-ResourceGroupName] <String> [-Name] <String> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### NamespaceInputObjectSet -``` -Remove-AzureRmServiceBusNamespace [-InputObject] <PSNamespaceAttributes> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### NamespaceResourceIdParameterSet -``` -Remove-AzureRmServiceBusNamespace [-ResourceId] <String> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmServiceBusNamespace** cmdlet removes the namespace from the specified resource group. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmServiceBusNamespace -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -``` - -Removes the Service Bus namespace `SB-Example1` from the specified resource group `Default-ServiceBus-WestUS`. - -### Example 2.1 - InputObject - Using variable: -``` -PS C:\> $inputobject = Get-AzureRmServiceBusNamespace <params> -PS C:\> Remove-AzureRmServiceBusNamespace -InputObject $inputobject -``` - -Removes the Service Bus namespace provided through the $inputobject. - -### Example 2.2 - InputObject - Using Piping: -``` -PS C:\> Get-AzureRmServiceBusNamespace <params> | Remove-AzureRmServiceBusNamespace -``` - -Removes the Service Bus namespace using Piping. - -### Example 3 - ResourceId -``` -PS c:\> $ResourceId = (Get-AzureRmResource -ResourceType Microsoft.ServiceBus/namespaces).ResourceId -PS C:\> Remove-AzureRmServiceBusNamespace -ResourceId $resourceid -``` - -Removes the Service Bus namespace provided through ARM id in $resourceid for -ResourceId parameter or through piping. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Service Bus Namespace Object - -```yaml -Type: Microsoft.Azure.Commands.ServiceBus.Models.PSNamespaceAttributes -Parameter Sets: NamespaceInputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Namespace Name. - -```yaml -Type: System.String -Parameter Sets: NamespacePropertiesSet -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Specifying this will return true if the command was successful. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group - -```yaml -Type: System.String -Parameter Sets: NamespacePropertiesSet -Aliases: ResourceGroup - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Service Bus Namespace Resource Id - -```yaml -Type: System.String -Parameter Sets: NamespaceResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.ServiceBus.Models.PSNamespaceAttributes -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/Remove-AzureRmServiceBusQueue.md b/azurermps-6.13.0/AzureRM.ServiceBus/Remove-AzureRmServiceBusQueue.md deleted file mode 100644 index 93e1e19a6c..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/Remove-AzureRmServiceBusQueue.md +++ /dev/null @@ -1,244 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/remove-azurermservicebusqueue -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Remove-AzureRmServiceBusQueue.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Remove-AzureRmServiceBusQueue.md ---- - -# Remove-AzureRmServiceBusQueue - -## SYNOPSIS -Removes the queue from the specified Service Bus namespace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### QueuePropertiesSet (Default) -``` -Remove-AzureRmServiceBusQueue [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> [-PassThru] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### QueueInputObjectSet -``` -Remove-AzureRmServiceBusQueue [-InputObject] <PSQueueAttributes> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### QueueResourceIdSet -``` -Remove-AzureRmServiceBusQueue [-ResourceId] <String> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmServiceBusQueue** cmdlet removes the queue from the specified Service Bus namespace. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmServiceBusQueue -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -QueueName SB-Queue_exampl1 -``` - -Removes the Service Bus queue `SB-Queue_exampl1` from the namespace `SB-Example1`. - -### Example 2.1 - InputObject - Using variable: -``` -PS C:\> $inputobject = Get-AzureRmServiceBusQueue <params> -PS C:\> Remove-AzureRmServiceBusQueue -InputObject $inputobject -``` - -Removes the Service Bus queue provided in the $inputobject for -InputObject parameter - -### Example 2.1 - InputObject - Using Piping: -``` -PS C:\> Get-AzureRmServiceBusQueue <params> | Remove-AzureRmServiceBusQueue -``` - -### Example 3.1 - ResourceId - Using variable: -``` -PS c:\> $resourceid = Get-AzureRmServiceBusQueue <params> -PS C:\> Remove-AzureRmServiceBusQueue -ResourceId $resourceid.Id -``` - -Removes the Service Bus queue provided in the ARM id in $resourceid/string for -ResourceId parameter - -### Example 3.2 - ResourceId - passign as string: -``` -PS C:\> Remove-AzureRmServiceBusQueue -ResourceId "/subscriptions/xxxx-xxxxx-xxxxx-xxxxxx-xxxxxxx/resourceGroups/ResourceGroupName/providers/Microsoft.ServiceBus/namespaces/NamespaceName/queues/QueueName" -``` - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Service Bus Queue Object - -```yaml -Type: Microsoft.Azure.Commands.ServiceBus.Models.PSQueueAttributes -Parameter Sets: QueueInputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Queue Name - -```yaml -Type: System.String -Parameter Sets: QueuePropertiesSet -Aliases: QueueName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: QueuePropertiesSet -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Specifying this will return true if the command was successful. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group - -```yaml -Type: System.String -Parameter Sets: QueuePropertiesSet -Aliases: ResourceGroup - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Service Bus Queue Resource Id - -```yaml -Type: System.String -Parameter Sets: QueueResourceIdSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.ServiceBus.Models.PSQueueAttributes -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/Remove-AzureRmServiceBusRule.md b/azurermps-6.13.0/AzureRM.ServiceBus/Remove-AzureRmServiceBusRule.md deleted file mode 100644 index cbe99272c0..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/Remove-AzureRmServiceBusRule.md +++ /dev/null @@ -1,284 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/remove-azurermservicebusrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Remove-AzureRmServiceBusRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Remove-AzureRmServiceBusRule.md ---- - -# Remove-AzureRmServiceBusRule - -## SYNOPSIS -Removes the speficied rule of a given subscription . - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RulePropertiesSet (Default) -``` -Remove-AzureRmServiceBusRule [-ResourceGroupName] <String> [-Namespace] <String> [-Topic] <String> - [-Subscription] <String> [-Name] <String> [-PassThru] [-AsJob] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RuleResourceIdSet -``` -Remove-AzureRmServiceBusRule [-InputObject] <PSTopicAttributes> [-ResourceId] <String> [-PassThru] [-AsJob] - [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmServiceBusRule** cmdlet removes the rule of a subscription of given topic. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmServiceBusRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SBExample1 -Topic SBTopic -Subscription SBSubscription -Name SBRule -``` - -Removes the rule `SBRule` of subscription `SBSubscription` of specified topic `SBTopic`. - -### Example 2.1 - InputObject - Using Variable: -``` -PS C:\> $inputobject = Get-AzureRmServiceBusRule <params> -PS C:\> Remove-AzureRmServiceBusRule -InputObject $inputobject -``` - -Removes the rule provided through $inputobject for -InputObject parameter - -### Example 2.2 - InputObject - Using Piping: -``` -PS C:\> Get-AzureRmServiceBusRule <params> | Remove-AzureRmServiceBusRule -``` - -### Example 3.1 - ResourceId - Using Variable -``` -PS C:\> $resourceid = Get-AzureRmServiceBusRule <params> -PS C:\> Remove-AzureRmServiceBusRule -ResourceId $resourceid.Id -``` - -### Example 3.1 - ResourceId - Using string value -``` -PS C:\> Remove-AzureRmServiceBusRule -ResourceId "/subscriptions/xxx-xxxxx-xxxxxx-xxxxxx/resourceGroups/ResourceGroupName/providers/Microsoft.ServiceBus/namespaces/NamespaceName/topics/TopicName/subscriptions/SubscriptionName/rules/RuleName" -``` - -Removes the rule provided through ARM Id in $resourceid/string for -ResourceId parameter - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Service Bus Rule Object - -```yaml -Type: Microsoft.Azure.Commands.ServiceBus.Models.PSTopicAttributes -Parameter Sets: RuleResourceIdSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Rule Name - -```yaml -Type: System.String -Parameter Sets: RulePropertiesSet -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: RulePropertiesSet -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Specifying this will return true if the command was successful. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group - -```yaml -Type: System.String -Parameter Sets: RulePropertiesSet -Aliases: ResourceGroup - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Service Bus Rule Resource Id - -```yaml -Type: System.String -Parameter Sets: RuleResourceIdSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Subscription -Subscription Name - -```yaml -Type: System.String -Parameter Sets: RulePropertiesSet -Aliases: SubscriptionName - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Topic -Topic Name - -```yaml -Type: System.String -Parameter Sets: RulePropertiesSet -Aliases: TopicName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.ServiceBus.Models.PSTopicAttributes -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/Remove-AzureRmServiceBusSubscription.md b/azurermps-6.13.0/AzureRM.ServiceBus/Remove-AzureRmServiceBusSubscription.md deleted file mode 100644 index dbe39a3a5e..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/Remove-AzureRmServiceBusSubscription.md +++ /dev/null @@ -1,258 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/remove-azurermservicebussubscription -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Remove-AzureRmServiceBusSubscription.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Remove-AzureRmServiceBusSubscription.md ---- - -# Remove-AzureRmServiceBusSubscription - -## SYNOPSIS -Removes the subscription to a topic from the specified Service Bus namespace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SubscriptionPropertiesSet (Default) -``` -Remove-AzureRmServiceBusSubscription [-ResourceGroupName] <String> [-Namespace] <String> [-Topic] <String> - [-Name] <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### SubscriptionInputObjectSet -``` -Remove-AzureRmServiceBusSubscription [-InputObject] <PSSubscriptionAttributes> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SubscriptionResourceIdSet -``` -Remove-AzureRmServiceBusSubscription [-ResourceId] <String> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmServiceBusSubscription** cmdlet removes the subscription to a topic from the specified Service Bus namespace. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmServiceBusSubscription -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -TopicName SB-Topic_exampl1 -SubscriptionName SB-TopicSubscription-Example1 -``` - -Removes the subscription `SB-TopicSubscription-Example1` to the topic `SB-Topic_exampl1` in the specified Service Bus namespace `SB-Example1`. - -### Example 2.1 - InputObject - Using Variable: -``` -PS C:\> $inputobject = Get-AzureRmServiceBusSubscription <params> -PS C:\> Remove-AzureRmServiceBusSubscription -InputObject $inputobject -``` - -### Example 2.2 - InputObject - Using Piping: -``` -PS C:\>Get-AzureRmServiceBusSubscription <params> |Remove-AzureRmServiceBusSubscription -``` - -### Example 3.1 - ResourceId - Using Variable: -``` -PS C:\> $resourceid = Get-AzureRmServiceBusSubscription <params> -PS C:\> Remove-AzureRmServiceBusSubscription -ResourceId $resourceid.Id -``` - -### Example 3.2 - ResourceId - Using string value: -``` -PS C:\> Remove-AzureRmServiceBusSubscription -ResourceId "/subscriptions/Subscriptionid/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/NamespaceName/topics/TopicName/subscriptions/SubscriptionName" -``` - -Removes the subscription provided through ARM Id in $resourceid/string for -ResourceId parameter - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Service Bus Subscription Object - -```yaml -Type: Microsoft.Azure.Commands.ServiceBus.Models.PSSubscriptionAttributes -Parameter Sets: SubscriptionInputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Subscription Name - -```yaml -Type: System.String -Parameter Sets: SubscriptionPropertiesSet -Aliases: SubscriptionName - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: SubscriptionPropertiesSet -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Specifying this will return true if the command was successful. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group - -```yaml -Type: System.String -Parameter Sets: SubscriptionPropertiesSet -Aliases: ResourceGroup - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Service Bus Subscription Resource Id - -```yaml -Type: System.String -Parameter Sets: SubscriptionResourceIdSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Topic -Topic Name - -```yaml -Type: System.String -Parameter Sets: SubscriptionPropertiesSet -Aliases: TopicName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.ServiceBus.Models.PSSubscriptionAttributes -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/Remove-AzureRmServiceBusTopic.md b/azurermps-6.13.0/AzureRM.ServiceBus/Remove-AzureRmServiceBusTopic.md deleted file mode 100644 index e9a8d18960..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/Remove-AzureRmServiceBusTopic.md +++ /dev/null @@ -1,240 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/remove-azurermservicebustopic -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Remove-AzureRmServiceBusTopic.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Remove-AzureRmServiceBusTopic.md ---- - -# Remove-AzureRmServiceBusTopic - -## SYNOPSIS -Removes the topic from the specified Service Bus namespace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### TopicPropertiesSet (Default) -``` -Remove-AzureRmServiceBusTopic [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> [-PassThru] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### TopicInputObjectSet -``` -Remove-AzureRmServiceBusTopic [-InputObject] <PSTopicAttributes> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### TopicResourceIdSet -``` -Remove-AzureRmServiceBusTopic [-ResourceId] <String> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmServiceBusTopic** cmdlet removes the topic from the specified Service Bus namespace. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmServiceBusTopic -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -TopicName SB-Topic_exampl1 -``` - -Removes the topic `SB-Topic_exampl1` from the namespace `SB-Example1`. - -### Example 2.1 - InputObject - Using Variable: -``` -PS C:\> $inputobject = Get-AzureRmServiceBusTopic <parmas> -PS C:\> Remove-AzureRmServiceBusTopic -InputObject $inputobject -``` - -### Example 2.2 - InputObject - Using Piping: -``` -PS C:\> Get-AzureRmServiceBusTopic <parmas> | Remove-AzureRmServiceBusTopic -``` - -### Example 3.1 - ResourceId Using Variable: -``` -PS C:\> $resourceid = Get-AzureRmServiceBusTopic <params> -PS C:\> Remove-AzureRmServiceBusTopic -ResourceId $resourceid.Id -``` - -### Example 3.2 - ResourceId Using String value -``` -PS C:\> Remove-AzureRmServiceBusTopic -ResourceId "/subscriptions/xxxx-xxxxx-xxxxxx-xxxxx/resourceGroups/ResourceGroupName/providers/Microsoft.ServiceBus/namespaces/NamespaceName/topics/TopicName" -``` - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Service Bus Topic Object - -```yaml -Type: Microsoft.Azure.Commands.ServiceBus.Models.PSTopicAttributes -Parameter Sets: TopicInputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Topic Name - -```yaml -Type: System.String -Parameter Sets: TopicPropertiesSet -Aliases: TopicName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: TopicPropertiesSet -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Specifying this will return true if the command was successful. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group - -```yaml -Type: System.String -Parameter Sets: TopicPropertiesSet -Aliases: ResourceGroup - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Service Bus Topic Resource Id - -```yaml -Type: System.String -Parameter Sets: TopicResourceIdSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.ServiceBus.Models.PSTopicAttributes -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/Set-AzureRmServiceBusAuthorizationRule.md b/azurermps-6.13.0/AzureRM.ServiceBus/Set-AzureRmServiceBusAuthorizationRule.md deleted file mode 100644 index ae81d9259b..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/Set-AzureRmServiceBusAuthorizationRule.md +++ /dev/null @@ -1,270 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/set-azurermservicebusauthorizationrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Set-AzureRmServiceBusAuthorizationRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Set-AzureRmServiceBusAuthorizationRule.md ---- - -# Set-AzureRmServiceBusAuthorizationRule - -## SYNOPSIS -Updates the specified authorization rule description for the given Service Bus namespace or queue or topic. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NamespaceAuthorizationRuleSet (Default) -``` -Set-AzureRmServiceBusAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - [[-InputObject] <PSSharedAccessAuthorizationRuleAttributes>] [[-Rights] <String[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### QueueAuthorizationRuleSet -``` -Set-AzureRmServiceBusAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [-Queue] <String> - [-Name] <String> [[-InputObject] <PSSharedAccessAuthorizationRuleAttributes>] [[-Rights] <String[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### TopicAuthorizationRuleSet -``` -Set-AzureRmServiceBusAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [-Topic] <String> - [-Name] <String> [[-InputObject] <PSSharedAccessAuthorizationRuleAttributes>] [[-Rights] <String[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### AuthoRuleInputObjectSet -``` -Set-AzureRmServiceBusAuthorizationRule [-ResourceGroupName] <String> [-Name] <String> - [-InputObject] <PSSharedAccessAuthorizationRuleAttributes> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmServiceBusAuthorizationRule** cmdlet updates the description for the specified authorization rule in the given Service Bus namespace or queue or topic. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $authRuleObj = Get-AzureRmServiceBusNamespaceAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Name AuthoRule1 - -PS C:\> $authRuleObj.Rights.Remove("Manage") - -PS C:\> Set-AzureRmServiceBusNamespaceAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Name AuthoRule1 -InputObj $authRuleObj -``` - -Removes **Manage** from the access rights of the authorization rule `AuthoRule1` in namespace `SB-Example1`. - -### Example 2 -``` -PS C:\> $authRuleObj = Get-AzureRmServiceBusNamespaceAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Queue SBQueue -Name AuthoRule1 - -PS C:\> $authRuleObj.Rights.Remove("Manage") - -PS C:\> Set-AzureRmServiceBusNamespaceAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Queue SBQueue -Name AuthoRule1 -InputObj $authRuleObj -``` - -Removes **Manage** from the access rights of the authorization rule `AuthoRule1` in queue `SBQueue`. - -### Example 2 -``` -PS C:\> $authRuleObj = Get-AzureRmServiceBusNamespaceAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Topic SBTopic -Name AuthoRule1 - -PS C:\> $authRuleObj.Rights.Remove("Manage") - -PS C:\> Set-AzureRmServiceBusNamespaceAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Topic SBTopic -Name AuthoRule1 -InputObj $authRuleObj -``` - -Removes **Manage** from the access rights of the authorization rule `AuthoRule1` in topic `SBTopic`. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -ServiceBus AuthorizationRule Object - -```yaml -Type: Microsoft.Azure.Commands.ServiceBus.Models.PSSharedAccessAuthorizationRuleAttributes -Parameter Sets: NamespaceAuthorizationRuleSet, QueueAuthorizationRuleSet, TopicAuthorizationRuleSet -Aliases: AuthRuleObj - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -```yaml -Type: Microsoft.Azure.Commands.ServiceBus.Models.PSSharedAccessAuthorizationRuleAttributes -Parameter Sets: AuthoRuleInputObjectSet -Aliases: AuthRuleObj - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -AuthorizationRule Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: AuthorizationRuleName - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - -```yaml -Type: System.String -Parameter Sets: NamespaceAuthorizationRuleSet, QueueAuthorizationRuleSet, TopicAuthorizationRuleSet -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Queue -Queue Name - -```yaml -Type: System.String -Parameter Sets: QueueAuthorizationRuleSet -Aliases: QueueName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Rights -Rights, e.g. -@("Listen","Send","Manage") - -```yaml -Type: System.String[] -Parameter Sets: NamespaceAuthorizationRuleSet, QueueAuthorizationRuleSet, TopicAuthorizationRuleSet -Aliases: -Accepted values: Listen, Send, Manage - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Topic -Topic Name - -```yaml -Type: System.String -Parameter Sets: TopicAuthorizationRuleSet -Aliases: TopicName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.ServiceBus.Models.PSSharedAccessAuthorizationRuleAttributes -Parameters: InputObject (ByValue) - -### System.String[] - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceBus.Models.PSSharedAccessAuthorizationRuleAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/Set-AzureRmServiceBusGeoDRConfigurationBreakPair.md b/azurermps-6.13.0/AzureRM.ServiceBus/Set-AzureRmServiceBusGeoDRConfigurationBreakPair.md deleted file mode 100644 index 4b9882f59f..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/Set-AzureRmServiceBusGeoDRConfigurationBreakPair.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/set-azurermservicebusgeodrconfigurationbreakpair -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Set-AzureRmServiceBusGeoDRConfigurationBreakPair.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Set-AzureRmServiceBusGeoDRConfigurationBreakPair.md ---- - -# Set-AzureRmServiceBusGeoDRConfigurationBreakPair - -## SYNOPSIS -This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GeoDRPropertiesSet (Default) -``` -Set-AzureRmServiceBusGeoDRConfigurationBreakPair [-ResourceGroupName] <String> [-Namespace] <String> - [-Name] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### GeoDRConfigurationInputObjectSet -``` -Set-AzureRmServiceBusGeoDRConfigurationBreakPair [-InputObject] <PSServiceBusDRConfigurationAttributes> - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### GeoDRConfigResourceIdParameterSet -``` -Set-AzureRmServiceBusGeoDRConfigurationBreakPair [-ResourceId] <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmServiceBusGeoDRConfigurationBreakPair** cmdlet disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces - -## EXAMPLES - -### Example 1 -``` -PS C:\> Set-AzureRmServiceBusGeoDRConfigurationBreakPair -ResourceGroupName "SampleResourceGroup" -Namespace "SampleNamespace_Primary" -Name "SampleDRCongifName" -``` - -This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Service Bus GeoDR Configuration Object - -```yaml -Type: Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusDRConfigurationAttributes -Parameter Sets: GeoDRConfigurationInputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -DR Configuration Name - -```yaml -Type: System.String -Parameter Sets: GeoDRPropertiesSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - Primary Namespace - -```yaml -Type: System.String -Parameter Sets: GeoDRPropertiesSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: GeoDRPropertiesSet -Aliases: ResourceGroup - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -GeoDRConfiguration Resource Id - -```yaml -Type: System.String -Parameter Sets: GeoDRConfigResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusDRConfigurationAttributes -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/Set-AzureRmServiceBusGeoDRConfigurationFailOver.md b/azurermps-6.13.0/AzureRM.ServiceBus/Set-AzureRmServiceBusGeoDRConfigurationFailOver.md deleted file mode 100644 index d1cdb7684c..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/Set-AzureRmServiceBusGeoDRConfigurationFailOver.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/set-azurermservicebusgeodrconfigurationfailover -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Set-AzureRmServiceBusGeoDRConfigurationFailOver.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Set-AzureRmServiceBusGeoDRConfigurationFailOver.md ---- - -# Set-AzureRmServiceBusGeoDRConfigurationFailOver - -## SYNOPSIS -Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GeoDRPropertiesSet (Default) -``` -Set-AzureRmServiceBusGeoDRConfigurationFailOver [-ResourceGroupName] <String> [-Namespace] <String> - [-Name] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### GeoDRConfigurationInputObjectSet -``` -Set-AzureRmServiceBusGeoDRConfigurationFailOver [-InputObject] <PSServiceBusDRConfigurationAttributes> - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### GeoDRConfigResourceIdParameterSet -``` -Set-AzureRmServiceBusGeoDRConfigurationFailOver [-ResourceId] <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmServiceBusGeoDRConfigurationFailOver** cmdlet envokes GEO DR failover and reconfigure the alias to point to the secondary namespace - -## EXAMPLES - -### Example 1 -``` -PS C:\> Set-AzureRmServiceBusGeoDRConfigurationFailOver -ResourceGroupName "SampleResourceGroup" -Namespace "SampleNamespace_Secondary" -Name "SampleDRCongifName" -``` - -Invokes the Failover over alias "SampleDRCongifName", reconfigures and point to Secondary namespace "SampleNamespace_Secondary" - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Service Bus GeoDR Configuration Object - -```yaml -Type: Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusDRConfigurationAttributes -Parameter Sets: GeoDRConfigurationInputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -DR Configuration Name - Alias - -```yaml -Type: System.String -Parameter Sets: GeoDRPropertiesSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name - Secondary Namespace - -```yaml -Type: System.String -Parameter Sets: GeoDRPropertiesSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: GeoDRPropertiesSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -GeoDRConfiguration Resource Id - -```yaml -Type: System.String -Parameter Sets: GeoDRConfigResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusDRConfigurationAttributes -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/Set-AzureRmServiceBusNamespace.md b/azurermps-6.13.0/AzureRM.ServiceBus/Set-AzureRmServiceBusNamespace.md deleted file mode 100644 index a2ded34133..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/Set-AzureRmServiceBusNamespace.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/set-azurermservicebusnamespace -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Set-AzureRmServiceBusNamespace.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Set-AzureRmServiceBusNamespace.md ---- - -# Set-AzureRmServiceBusNamespace - -## SYNOPSIS -Updates the description of an existing Service Bus namespace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmServiceBusNamespace [-ResourceGroupName] <String> [-Location] <String> [-Name] <String> - [-SkuName <String>] [-SkuCapacity <Int32>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmServiceBusNamespace** cmdlet updates the description of the specified Service Bus namespace within the resource group. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Set-AzureRmServiceBusNamespace -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -Location WestUs -SkuName Premium -SkuCapacity 1 -Tag @{Tag2="Tag2Value"} - -Name : SB-Example1 -Id : /subscriptions/{subscription id}/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.ServiceBus/namespaces/SB-Example1 -ResourceGroup : Default-ServiceBus-WestUS -Location : West US -Tags : {Tag2, Tag2Value} -Sku : Name : Premium , Tier : Premium, Capacity : 1 -ProvisioningState : Succeeded -CreatedAt : -UpdatedAt : -ServiceBusEndpoint : -``` - -Updates the Service Bus namespace with a new description. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The Service Bus namespace location. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -ServiceBus Namespace Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuCapacity -Namespace Sku Capacity. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuName -The namespace SKU name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Basic, Standard, Premium - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Updates the Service Bus namespace with the specified information. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceBus.Models.PSNamespaceAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/Set-AzureRmServiceBusQueue.md b/azurermps-6.13.0/AzureRM.ServiceBus/Set-AzureRmServiceBusQueue.md deleted file mode 100644 index c3d2659881..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/Set-AzureRmServiceBusQueue.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/set-azurermservicebusqueue -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Set-AzureRmServiceBusQueue.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Set-AzureRmServiceBusQueue.md ---- - -# Set-AzureRmServiceBusQueue - -## SYNOPSIS -Updates the description of a Service Bus queue in the specified Service Bus namespace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmServiceBusQueue [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - [-InputObject] <PSQueueAttributes> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmServiceBusQueue** cmdlet updates the description for the Service Bus queue in the specified Service Bus namespace. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $QueueObj = Get-AzureRmServiceBusQueue -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -QueueName SB-Queue_example1 - -PS C:\> $QueueObj.DeadLetteringOnMessageExpiration = $True -PS C:\> $QueueObj.SupportOrdering = $True - -PS C:\> Set-AzureRmServiceBusQueue -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -QueueName SB-Queue_example1 -QueueObj $QueueObj - -Id : /subscriptions/{subscriptionId}/resourceGroups/{ResourceGroupName}/Default-ServiceBus-WestUS/providers/Microsoft.ServiceBus/namespaces/SB-Example1/queues/SB-Queue_exampl1 -Name : SB-Queue_exampl1 -LockDuration : PT1M -AccessedAt : 1/1/0001 12:00:00 AM -AutoDeleteOnIdle : P10675199DT2H48M5.4775807S -CreatedAt : 1/1/0001 12:00:00 AM -DefaultMessageTimeToLive : P10675199DT2H48M5.4775807S -DuplicateDetectionHistoryTimeWindow : PT10M -DeadLetteringOnMessageExpiration : True -EnableExpress : False -EnablePartitioning : False -MaxDeliveryCount : 10 -MaxSizeInMegabytes : 81920 -MessageCount : 0 -CountDetails : Microsoft.Azure.Management.ServiceBus.Models.MessageCountDetails -RequiresDuplicateDetection : False -RequiresSession : False -SizeInBytes : 0 -Status : Active -UpdatedAt : 1/1/0001 12:00:00 AM -ForwardTo : -ForwardDeadLetteredMessagesTo : -EnableBatchedOperations : False -``` - -Updates the specified queue with a new description in the specified namespace. This example updates the **DeadLetteringOnMessageExpiration** property to **true** and **SupportOrdering** to **true**. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -ServiceBus definition. - -```yaml -Type: Microsoft.Azure.Commands.ServiceBus.Models.PSQueueAttributes -Parameter Sets: (All) -Aliases: QueueObj - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Queue Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: QueueName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.ServiceBus.Models.PSQueueAttributes - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceBus.Models.PSQueueAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/Set-AzureRmServiceBusRule.md b/azurermps-6.13.0/AzureRM.ServiceBus/Set-AzureRmServiceBusRule.md deleted file mode 100644 index c524a1a1d4..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/Set-AzureRmServiceBusRule.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/set-azurermservicebusrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Set-AzureRmServiceBusRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Set-AzureRmServiceBusRule.md ---- - -# Set-AzureRmServiceBusRule - -## SYNOPSIS -Updates the specified rule description for the given subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmServiceBusRule [-ResourceGroupName] <String> [-Namespace] <String> [-Topic] <String> - [-Subscription] <String> [-Name] <String> [-InputObject] <PSRulesAttributes> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmServiceBusRule** cmdlet updates the description for the specified rule of the given subscription. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $getRule = Get-AzureRmServiceBusRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SBExample1 -Topic SBTopic -Subscription SBSubscription -Name SBRule -PS C:\> $getRule.SqlFilter.SqlExpression = "mysqlexpression='condition'" -PS C:\> $setRule = Set-AzureRmServiceBusRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SBExample1 -Topic SBTopic -Subscription SBSubscription -Name SBRule -InputObject $getRule -``` - -updates the sqlexpression **mysqlexpression='condition'** of the rule `SBEule` of the subscription `SBSubscription` in Topic `SBTopic` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -ServiceBus Rules definition. - -```yaml -Type: Microsoft.Azure.Commands.ServiceBus.Models.PSRulesAttributes -Parameter Sets: (All) -Aliases: - -Required: True -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Rule Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Subscription -Subscription Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: SubscriptionName - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Topic -Topic Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: TopicName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.ServiceBus.Models.PSRulesAttributes - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceBus.Models.PSRulesAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/Set-AzureRmServiceBusSubscription.md b/azurermps-6.13.0/AzureRM.ServiceBus/Set-AzureRmServiceBusSubscription.md deleted file mode 100644 index 8536d2a9e8..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/Set-AzureRmServiceBusSubscription.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/set-azurermservicebussubscription -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Set-AzureRmServiceBusSubscription.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Set-AzureRmServiceBusSubscription.md ---- - -# Set-AzureRmServiceBusSubscription - -## SYNOPSIS -Updates a subscription description for a Service Bus topic in the specified Service Bus namespace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmServiceBusSubscription [-ResourceGroupName] <String> [-Namespace] <String> [-Topic] <String> - [-InputObject] <PSSubscriptionAttributes> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmServiceBusSubscription** cmdlet updates the description of the subscription for the Service Bus topic in the specified Service Bus namespace. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $subscriptionObj = Get-AzureRmServiceBusSubscription -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -TopicName SB-Topic_exampl1 -SubscriptionName SB-TopicSubscription-Example1 - -PS C:\> $subscriptionObj.DeadLetteringOnMessageExpiration = $True -PS C:\> $subscriptionObj.MaxDeliveryCount = 9 - -Name : SB-TopicSubscription-Example1 -AccessedAt : 1/1/0001 12:00:00 AM -AutoDeleteOnIdle : 10675199.02:48:05.4775807 -CountDetails : -CreatedAt : 1/20/2017 9:59:15 PM -DefaultMessageTimeToLive : 10675199.02:48:05.4775807 -DeadLetteringOnMessageExpiration : True -EnableBatchedOperations : True -LockDuration : 00:01:00 -MaxDeliveryCount : 9 -MessageCount : 0 -RequiresSession : False -Status : Active -UpdatedAt : 1/20/2017 9:59:15 PM -PS C:\> Set-AzureRmServiceBusSubscription -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -TopicName SB-Topic_exampl1 -SubscriptionObj $subscriptionObj -``` - -Updates the description for the specified subscription to the given topic. This example updates the **DeadLetteringOnMessageExpiration** property to **true** and **MaxDeliveryCount** to 9. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -ServiceBus Subscription definition. - -```yaml -Type: Microsoft.Azure.Commands.ServiceBus.Models.PSSubscriptionAttributes -Parameter Sets: (All) -Aliases: SubscriptionObj - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Topic -Topic Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: TopicName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.ServiceBus.Models.PSSubscriptionAttributes -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceBus.Models.PSSubscriptionAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/Set-AzureRmServiceBusTopic.md b/azurermps-6.13.0/AzureRM.ServiceBus/Set-AzureRmServiceBusTopic.md deleted file mode 100644 index 40c7e41a98..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/Set-AzureRmServiceBusTopic.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/set-azurermservicebustopic -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Set-AzureRmServiceBusTopic.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Set-AzureRmServiceBusTopic.md ---- - -# Set-AzureRmServiceBusTopic - -## SYNOPSIS -Updates the description of a Service Bus topic in the specified Service Bus namespace. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmServiceBusTopic [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> - [-InputObject] <PSTopicAttributes> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmServiceBusTopic** cmdlet updates a description object for a Service Bus topic in the specified Service Bus namespace. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $topicObj = Get-AzureRmServiceBusTopic -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-ExampleStandard -TopicName SB-Topic_exampl1 - -PS C:\> $topicObj.EnableExpress = $True - -PS C:\> Set-AzureRmServiceBusTopic -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-ExampleStandard -TopicName SB-Topic_exampl1 -TopicObj $topicObj - -Name : SB-Topic_example1 -Id : /subscriptions/{subscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ServiceBus/namespaces/SB-ExampleStandard/topics/SB-Topic_example1 -Type : Microsoft.ServiceBus/Namespaces/Topics -AccessedAt : 1/1/0001 12:00:00 AM -AutoDeleteOnIdle : P10675199DT2H48M5.4775807S -CreatedAt : 10/12/2018 12:01:28 AM -CountDetails : Microsoft.Azure.Management.ServiceBus.Models.MessageCountDetails -DefaultMessageTimeToLive : P10675199DT2H48M5.4775807S -DuplicateDetectionHistoryTimeWindow : PT10M -EnableBatchedOperations : True -EnableExpress : False -EnablePartitioning : True -MaxSizeInMegabytes : 81920 -RequiresDuplicateDetection : False -SizeInBytes : 0 -Status : Active -SubscriptionCount : 0 -SupportOrdering : False -UpdatedAt : 10/12/2018 12:01:29 AM -``` - -Updates the specified topic with a new description in the specified namespace. This example updates the **EnableExpress** property to **true**. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -ServiceBus Topic definition. - -```yaml -Type: Microsoft.Azure.Commands.ServiceBus.Models.PSTopicAttributes -Parameter Sets: (All) -Aliases: TopicObj - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Topic Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: TopicName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Namespace Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.ServiceBus.Models.PSTopicAttributes -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceBus.Models.PSTopicAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/Start-AzureRmServiceBusMigration.md b/azurermps-6.13.0/AzureRM.ServiceBus/Start-AzureRmServiceBusMigration.md deleted file mode 100644 index 7e4cc89dd3..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/Start-AzureRmServiceBusMigration.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/start-azurermservicebusmigration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Start-AzureRmServiceBusMigration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Start-AzureRmServiceBusMigration.md ---- - -# Start-AzureRmServiceBusMigration - -## SYNOPSIS -Creates a new Migration configuration and starts migrating entities from Standard to Premium namespaces - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Start-AzureRmServiceBusMigration [-ResourceGroupName] <String> [-Name] <String> [-TargetNameSpace] <String> - [-PostMigrationName] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Start-AzureRmServiceBusMigration** cmdlet creates an new Migration configuration and starts migrating entities from Standard to Premium namespaces - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Start-AzureRmServiceBusMigration -ResourceGroupName ResourceGroup -Name TestingNamespaceStandardMirgation -TargetNameSpace /subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/TestingNamespacePremiumMirgation -PostMigrationName TestingNamespaceStandardMirgationPostMigration - -Name : TestingNamespaceStandardMirgation -Id : /subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/TestingNamespaceStandardMirgation/migrationConfigurations/$default -Type : Microsoft.ServiceBus/Namespaces/migrationconfigurations -ProvisioningState : Accepted -TargetNamespace : /subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/TestingNamespacePremiumMirgation -PostMigrationName : TestingNamespaceStandardMirgationPostMigration -``` - -Creates a new migration configuration for 'TestingNamespaceStandardMirgation' to 'TestingNamespacePremiumMirgation' namespaces - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Standard Namespace Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PostMigrationName -Post Migration Name for Standrad Namespace in Migration - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetNameSpace -Premium Namespace ARM Id - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusDRConfigurationAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/Stop-AzureRmServiceBusMigration.md b/azurermps-6.13.0/AzureRM.ServiceBus/Stop-AzureRmServiceBusMigration.md deleted file mode 100644 index ed61baa7ea..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/Stop-AzureRmServiceBusMigration.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/stop-azurermservicebusmigration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Stop-AzureRmServiceBusMigration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Stop-AzureRmServiceBusMigration.md ---- - -# Stop-AzureRmServiceBusMigration - -## SYNOPSIS -{{Fill in the Synopsis}} - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### MigrationConfigurationPropertiesSet (Default) -``` -Stop-AzureRmServiceBusMigration [-ResourceGroupName] <String> [-Name] <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### NamespaceInputObjectSet -``` -Stop-AzureRmServiceBusMigration [-InputObject] <PSServiceBusDRConfigurationAttributes> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### NamespaceResourceIdParameterSet -``` -Stop-AzureRmServiceBusMigration [-ResourceId] <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Stop-AzureRmServiceBusMigration** cmdlets tremitates the Migration between Standard to premium namespace - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Stop-AzureRmServiceBusMigration -ResourceGroupName ResourceGroup -Name TestingNamespaceStandardMirgation -``` - -cmdlet termitates the migration between Standard namespace and Premium namespace provided while creating the migration configuration. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Service Bus Migration Configuration Standard Namespace Object - -```yaml -Type: Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusDRConfigurationAttributes -Parameter Sets: NamespaceInputObjectSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Standard Namespace Name - -```yaml -Type: System.String -Parameter Sets: MigrationConfigurationPropertiesSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Specifying this will return true if the command was successful. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: MigrationConfigurationPropertiesSet -Aliases: ResourceGroup - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Service Bus Migration Configuration Standard Namespace Resource Id - -```yaml -Type: System.String -Parameter Sets: NamespaceResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.ServiceBus.Models.PSServiceBusDRConfigurationAttributes -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceBus/Test-AzureRmServiceBusName.md b/azurermps-6.13.0/AzureRM.ServiceBus/Test-AzureRmServiceBusName.md deleted file mode 100644 index deb2dbcad1..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceBus/Test-AzureRmServiceBusName.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceBus.dll-Help.xml -Module Name: AzureRM.ServiceBus -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicebus/test-azurermservicebusname -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Test-AzureRmServiceBusName.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Test-AzureRmServiceBusName.md ---- - -# Test-AzureRmServiceBusName - -## SYNOPSIS -Checks the Availability of the given NameSpace Name or Alias (DR Configuration Name) - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### AliasCheckNameAvailabilitySet -``` -Test-AzureRmServiceBusName [-ResourceGroupName] <String> [-Namespace] <String> [-AliasName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### NamespaceCheckNameAvailabilitySet -``` -Test-AzureRmServiceBusName [-Namespace] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Test-AzureRmServiceBusName** Cmdlet Check Availability of the NameSpace Name or Alias (DR Configuration Name) - -## EXAMPLES - -### Example 1 -``` -PS C:\> Test-AzureRmServiceBusName -Namespace MyNameSapceName -``` - -Returns the status on availability of the namespace name 'MyNameSapceName' as True - -### Example 2 -``` -PS C:\> Test-AzureRmServiceBusName -Namespace MyNameSapceName -``` - -Returns the status on availability of the namespace name 'MyNameSapceName' as False with Reason - -### Example 3 -``` -PS C:\> Test-AzureRmServiceBusName -ResourceGroupName MyResourceGroup -Namespace Test123 -AliasName myAliasName -``` - -## PARAMETERS - -### -AliasName -DR Configuration Name - Alias Name - -```yaml -Type: System.String -Parameter Sets: AliasCheckNameAvailabilitySet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Namespace -Servicebus Namespace Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: NamespaceName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: AliasCheckNameAvailabilitySet -Aliases: ResourceGroup - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceBus.Models.PSCheckNameAvailabilityResultAttributes - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceFabric/Add-AzureRmServiceFabricApplicationCertificate.md b/azurermps-6.13.0/AzureRM.ServiceFabric/Add-AzureRmServiceFabricApplicationCertificate.md deleted file mode 100644 index 7c671b2c2e..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceFabric/Add-AzureRmServiceFabricApplicationCertificate.md +++ /dev/null @@ -1,267 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceFabric.dll-Help.xml -Module Name: AzureRM.ServiceFabric -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicefabric/add-azurermservicefabricapplicationcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/Add-AzureRmServiceFabricApplicationCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/Add-AzureRmServiceFabricApplicationCertificate.md ---- - -# Add-AzureRmServiceFabricApplicationCertificate - -## SYNOPSIS -Add a new certificate to the Virtual Machine Scale Set(s) that make up the cluster. The certificate is intended to be used as an application certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByExistingKeyVault -``` -Add-AzureRmServiceFabricApplicationCertificate [-ResourceGroupName] <String> [-Name] <String> - -SecretIdentifier <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByNewPfxAndVaultName -``` -Add-AzureRmServiceFabricApplicationCertificate [-ResourceGroupName] <String> [-Name] <String> - [-KeyVaultResouceGroupName <String>] [-KeyVaultName <String>] [-CertificateOutputFolder <String>] - [-CertificatePassword <SecureString>] -CertificateSubjectName <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByExistingPfxAndVaultName -``` -Add-AzureRmServiceFabricApplicationCertificate [-ResourceGroupName] <String> [-Name] <String> - [-KeyVaultResouceGroupName <String>] [-KeyVaultName <String>] -CertificateFile <String> - [-CertificatePassword <SecureString>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Use **Add-AzureRmServiceFabricApplicationCertificate** to install a certificate to all nodes in the cluster. -You can specify a certificate you already have or have the system generate a new one for you, and upload it to a new or existing Azure key vault. - -## EXAMPLES - -### Example 1 -``` -PS c:> Add-AzureRmServiceFabricApplicationCertificate -ResourceGroupName 'Group1' -Name 'Contoso01SFCluster' -SecretIdentifier 'https://contoso03vault.vault.azure.net/secrets/contoso03vaultrg/7f7de9131c034172b9df37ccc549524f' -``` - -This command will add a certificate from existing Azure key vault to all node types of the cluster. - -### Example 2 -``` -PS c:\> $pwd = ConvertTo-SecureString -String '123' -AsPlainText -Force -PS C:\> Add-AzureRmServiceFabricApplicationCertificate -ResourceGroupName 'Group2' -Name 'Contoso02SFCluster' -KeyVaultName 'Contoso02Vault' -KeyVaultResouceGroupName 'Contoso02VaultRg' - -CertificateSubjectName 'cn=Contoso.com' -CertificateOutputFolder 'c:\test' -CertificatePassword $pwd -``` - -This command will create a self-signed certificate in the Azure key vault with the key vault resource group name and key vault Name, installs to all node types of the cluster, and downloads the certificate under folder 'c:\test'. The name of the certificate downloaded is same as the name of key vault certificate. - -## PARAMETERS - -### -CertificateFile -The existing certificate file path. - -```yaml -Type: System.String -Parameter Sets: ByExistingPfxAndVaultName -Aliases: Source - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CertificateOutputFolder -The folder path of the new certificate to be created. - -```yaml -Type: System.String -Parameter Sets: ByNewPfxAndVaultName -Aliases: Destination - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CertificatePassword -The password of the pfx file. - -```yaml -Type: System.Security.SecureString -Parameter Sets: ByNewPfxAndVaultName, ByExistingPfxAndVaultName -Aliases: CertPassword - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CertificateSubjectName -The Dns name of the certificate to be created. - -```yaml -Type: System.String -Parameter Sets: ByNewPfxAndVaultName -Aliases: Subject - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyVaultName -Azure key vault name. - -```yaml -Type: System.String -Parameter Sets: ByNewPfxAndVaultName, ByExistingPfxAndVaultName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -KeyVaultResouceGroupName -Azure key vault resource group name. - -```yaml -Type: System.String -Parameter Sets: ByNewPfxAndVaultName, ByExistingPfxAndVaultName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specify the name of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ClusterName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specify the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecretIdentifier -The existing Azure key vault secret uri. - -```yaml -Type: System.String -Parameter Sets: ByExistingKeyVault -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: CertificateFile (ByValue), CertificateOutputFolder (ByValue), CertificateSubjectName (ByValue), KeyVaultName (ByValue), KeyVaultResouceGroupName (ByValue), SecretIdentifier (ByValue) - -### System.Security.SecureString -Parameters: CertificatePassword (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceFabric.Models.PSKeyVault - -## NOTES - -## RELATED LINKS - -[Add-AzureRmServiceFabricClusterCertificate](./Add-AzureRmServiceFabricClusterCertificate.md) - -[New-AzureRmServiceFabricCluster](./New-AzureRmServiceFabricCluster.md) diff --git a/azurermps-6.13.0/AzureRM.ServiceFabric/Add-AzureRmServiceFabricClientCertificate.md b/azurermps-6.13.0/AzureRM.ServiceFabric/Add-AzureRmServiceFabricClientCertificate.md deleted file mode 100644 index a2fb286771..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceFabric/Add-AzureRmServiceFabricClientCertificate.md +++ /dev/null @@ -1,272 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceFabric.dll-Help.xml -Module Name: AzureRM.ServiceFabric -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicefabric/add-azurermservicefabricclientcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/Add-AzureRmServiceFabricClientCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/Add-AzureRmServiceFabricClientCertificate.md ---- - -# Add-AzureRmServiceFabricClientCertificate - -## SYNOPSIS -Add common name or thumbprint to the cluster for client authentication purposes. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SingleUpdateWithThumbprint -``` -Add-AzureRmServiceFabricClientCertificate [-Admin] [-ResourceGroupName] <String> [-Name] <String> - -Thumbprint <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SingleUpdateWithCommonName -``` -Add-AzureRmServiceFabricClientCertificate [-Admin] [-ResourceGroupName] <String> [-Name] <String> - -CommonName <String> -IssuerThumbprint <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### MultipleUpdatesWithCommonName -``` -Add-AzureRmServiceFabricClientCertificate [-ResourceGroupName] <String> [-Name] <String> - -ClientCertificateCommonName <PSClientCertificateCommonName[]> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### MultipleUpdatesWithThumbprint -``` -Add-AzureRmServiceFabricClientCertificate [-ResourceGroupName] <String> [-Name] <String> - [-AdminClientThumbprint <String[]>] [-ReadonlyClientThumbprint <String[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Use **Add-AzureRmServiceFabricClientCertificate** to add a common name and issuer thumbprint or certificate thumbprint to the cluster, so the client can use it for authentication. - -## EXAMPLES - -### Example 1 -``` -PS c:> Add-AzureRmServiceFabricClientCertificate -ResourceGroupName 'Group1' -Name 'Contoso01SFCluster' -Thumbprint 5F3660C715EBBDA31DB1FFDCF508302348DE8E7A -Admin -``` - -This command will add the certificate with thumbprint '5F3660C715EBBDA31DB1FFDCF508302348DE8E7A' to the cluster, so the client can use the certificate as admin to communicate with the cluster. - -### Example 2 -``` -PS c:> Add-AzureRmServiceFabricClientCertificate -ResourceGroupName 'Group2' -Name 'Contoso02SFCluster' -CommonName 'Contoso.com' -IssuerThumbprint 5F3660C715EBBDA31DB1FFDCF508302348DE8E7A -``` - -This command will add a read only client certificate that's common name is 'Contoso.com' and issuer thumbprint is '5F3660C715EBBDA31DB1FFDCF508302348DE8E7A' to the cluster. - -## PARAMETERS - -### -Admin -Client authentication type. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: SingleUpdateWithThumbprint, SingleUpdateWithCommonName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AdminClientThumbprint -Specify client certificate thumbprint that only has admin permission. - -```yaml -Type: System.String[] -Parameter Sets: MultipleUpdatesWithThumbprint -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ClientCertificateCommonName -Specify client common name, issuer thumbprint, and authentication type. - -```yaml -Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSClientCertificateCommonName[] -Parameter Sets: MultipleUpdatesWithCommonName -Aliases: CertCommonName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CommonName -Specify client certificate common name. - -```yaml -Type: System.String -Parameter Sets: SingleUpdateWithCommonName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IssuerThumbprint -Specify client certificate issuer thumbprint. - -```yaml -Type: System.String -Parameter Sets: SingleUpdateWithCommonName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specify the name of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ClusterName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReadonlyClientThumbprint -Specify client certificate thumbprint that has read only permission. - -```yaml -Type: System.String[] -Parameter Sets: MultipleUpdatesWithThumbprint -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Thumbprint -Specify client certificate thumbprint. - -```yaml -Type: System.String -Parameter Sets: SingleUpdateWithThumbprint -Aliases: ClientCertificateThumbprint - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Management.Automation.SwitchParameter -Parameters: Admin (ByValue) - -### System.String -Parameters: CommonName (ByValue), IssuerThumbprint (ByValue), Thumbprint (ByValue) - -### System.String[] -Parameters: AdminClientThumbprint (ByValue), ReadonlyClientThumbprint (ByValue) - -### Microsoft.Azure.Commands.ServiceFabric.Models.PSClientCertificateCommonName[] -Parameters: ClientCertificateCommonName (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceFabric.Models.PSCluster - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmServiceFabricClientCertificate](./Remove-AzureRmServiceFabricClientCertificate.md) diff --git a/azurermps-6.13.0/AzureRM.ServiceFabric/Add-AzureRmServiceFabricClusterCertificate.md b/azurermps-6.13.0/AzureRM.ServiceFabric/Add-AzureRmServiceFabricClusterCertificate.md deleted file mode 100644 index 7f6565b9c9..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceFabric/Add-AzureRmServiceFabricClusterCertificate.md +++ /dev/null @@ -1,270 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceFabric.dll-Help.xml -Module Name: AzureRM.ServiceFabric -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicefabric/add-azurermservicefabricclustercertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/Add-AzureRmServiceFabricClusterCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/Add-AzureRmServiceFabricClusterCertificate.md ---- - -# Add-AzureRmServiceFabricClusterCertificate - -## SYNOPSIS -Add a secondary cluster certificate to the cluster. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByExistingKeyVault -``` -Add-AzureRmServiceFabricClusterCertificate [-ResourceGroupName] <String> [-Name] <String> - -SecretIdentifier <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByNewPfxAndVaultName -``` -Add-AzureRmServiceFabricClusterCertificate [-ResourceGroupName] <String> [-Name] <String> - [-KeyVaultResouceGroupName <String>] [-KeyVaultName <String>] [-CertificateOutputFolder <String>] - [-CertificatePassword <SecureString>] -CertificateSubjectName <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByExistingPfxAndVaultName -``` -Add-AzureRmServiceFabricClusterCertificate [-ResourceGroupName] <String> [-Name] <String> - [-KeyVaultResouceGroupName <String>] [-KeyVaultName <String>] -CertificateFile <String> - [-CertificatePassword <SecureString>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Use **Add-AzureRmServiceFabricClusterCertificate** to add a secondary cluster certificate, either from an existing Azure key vault or creating a new Azure key vault using an existing certificate provided or from a new self-signed certificate created. -It will override the secondary cluster if there is any. - -## EXAMPLES - -### Example 1 -``` -Add-AzureRmServiceFabricClusterCertificate -ResourceGroupName 'Group1' -Name 'Contoso01SFCluster' --SecretIdentifier 'https://contoso03vault.vault.azure.net/secrets/contoso03vaultrg/7f7de9131c034172b9df37ccc549524f' -``` - -This command will add a certificate in the existing Azure key vault as a secondary cluster certificate. - -### Example 2 -``` -PS c:\> $pwd = ConvertTo-SecureString -String "123" -AsPlainText -Force -PS c:\> add-AzureRmServiceFabricClusterCertificate -ResourceGroupName 'Group2' -Name 'Contoso02SFCluster' -CertificateSubjectName 'Contoso.com' --CertificateOutputFolder 'c:\test' -CertificatePassword $pwd -``` - -This command will create a self-signed certificate in the Azure key vault and upgrade the cluster to use it as a secondary cluster certificate. - -## PARAMETERS - -### -CertificateFile -The existing certificate file path. - -```yaml -Type: System.String -Parameter Sets: ByExistingPfxAndVaultName -Aliases: Source - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CertificateOutputFolder -The folder of the new certificate to be created. - -```yaml -Type: System.String -Parameter Sets: ByNewPfxAndVaultName -Aliases: Destination - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CertificatePassword -The password of the certificate file. - -```yaml -Type: System.Security.SecureString -Parameter Sets: ByNewPfxAndVaultName, ByExistingPfxAndVaultName -Aliases: CertPassword - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CertificateSubjectName -The Dns name of the certificate to be created. - -```yaml -Type: System.String -Parameter Sets: ByNewPfxAndVaultName -Aliases: Subject - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyVaultName -Azure key vault name. - -```yaml -Type: System.String -Parameter Sets: ByNewPfxAndVaultName, ByExistingPfxAndVaultName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -KeyVaultResouceGroupName -Azure key vault resource group name. - -```yaml -Type: System.String -Parameter Sets: ByNewPfxAndVaultName, ByExistingPfxAndVaultName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specify the name of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ClusterName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecretIdentifier -The existing Azure key vault secret Url. - -```yaml -Type: System.String -Parameter Sets: ByExistingKeyVault -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: CertificateFile (ByValue), CertificateOutputFolder (ByValue), CertificateSubjectName (ByValue), KeyVaultName (ByValue), KeyVaultResouceGroupName (ByValue), SecretIdentifier (ByValue) - -### System.Security.SecureString -Parameters: CertificatePassword (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceFabric.Models.PSCluster - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmServiceFabricClusterCertificate](./Remove-AzureRmServiceFabricClusterCertificate.md) - -[New-AzureRmServiceFabricCluster](./New-AzureRmServiceFabricCluster.md) - -[Add-AzureRmServiceFabricApplicationCertificate](./Add-AzureRmServiceFabricApplicationCertificate.md) diff --git a/azurermps-6.13.0/AzureRM.ServiceFabric/Add-AzureRmServiceFabricNode.md b/azurermps-6.13.0/AzureRM.ServiceFabric/Add-AzureRmServiceFabricNode.md deleted file mode 100644 index a85d77aa2a..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceFabric/Add-AzureRmServiceFabricNode.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceFabric.dll-Help.xml -Module Name: AzureRM.ServiceFabric -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicefabric/add-azurermservicefabricnode -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/Add-AzureRmServiceFabricNode.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/Add-AzureRmServiceFabricNode.md ---- - -# Add-AzureRmServiceFabricNode - -## SYNOPSIS -Add nodes to the specific node type in the cluster. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmServiceFabricNode -NumberOfNodesToAdd <Int32> [-ResourceGroupName] <String> [-Name] <String> - -NodeType <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Use **Add-AzureRmServiceFabricNode** to add nodes to the specific node type. You just need to specify the number of nodes you want to add to a node type. - -## EXAMPLES - -### Example 1 -``` -PS c:> Add-AzureRmServiceFabricNode -ResourceGroupName 'Group1' -Name 'Contoso01SFCluster' -NumberOfNodesToAdd 2 -NodeTypeName 'nt1' -``` - -This command will add 2 nodes to the node type 'n1'. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specify the name of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ClusterName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NodeType -Node type name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NumberOfNodesToAdd -VM instance number. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: Number - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Int32 -Parameters: NumberOfNodesToAdd (ByValue) - -### System.String -Parameters: NodeType (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceFabric.Models.PSCluster - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmServiceFabricNode](./Remove-AzureRmServiceFabricNode.md) diff --git a/azurermps-6.13.0/AzureRM.ServiceFabric/Add-AzureRmServiceFabricNodeType.md b/azurermps-6.13.0/AzureRM.ServiceFabric/Add-AzureRmServiceFabricNodeType.md deleted file mode 100644 index 81d15d9bd3..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceFabric/Add-AzureRmServiceFabricNodeType.md +++ /dev/null @@ -1,245 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceFabric.dll-Help.xml -Module Name: AzureRM.ServiceFabric -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicefabric/add-azurermservicefabricnodetype -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/Add-AzureRmServiceFabricNodeType.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/Add-AzureRmServiceFabricNodeType.md ---- - -# Add-AzureRmServiceFabricNodeType - -## SYNOPSIS -Add a new node type to the existing cluster. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmServiceFabricNodeType [-ResourceGroupName] <String> [-Name] <String> -Capacity <Int32> - -VmUserName <String> -VmPassword <SecureString> [-VmSku <String>] [-Tier <String>] - [-DurabilityLevel <DurabilityLevel>] -NodeType <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Add a new node type to a existing cluster. - -## EXAMPLES - -### Example 1 -``` -PS c:\> $pwd = ConvertTo-SecureString -String 'Password$123456' -AsPlainText -Force -PS C:\> Add-AzureRmServiceFabricNodeType -ResourceGroupName 'Group1' -Name 'Contoso01SFCluster' -NodeType 'n2' -Capacity 5 -VmUserName 'adminName' -VmPassword $pwd -``` - -This command will add a new NodeType 'n2' with capacity of 5, and the vm admin name is 'adminName'. - -## PARAMETERS - -### -Capacity -Capacity - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DurabilityLevel -Specify the durability level of the NodeType. - -```yaml -Type: Microsoft.Azure.Commands.ServiceFabric.Models.DurabilityLevel -Parameter Sets: (All) -Aliases: -Accepted values: Bronze, Silver, Gold - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specify the name of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ClusterName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NodeType -The node type name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specify the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tier -Vm Sku Tier. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VmPassword -The password of login to the Vm. - -```yaml -Type: System.Security.SecureString -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VmSku -The sku name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VmUserName -The user name for login to Vm. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: NodeType (ByValue), Tier (ByValue), VmSku (ByValue), VmUserName (ByValue) - -### System.Int32 -Parameters: Capacity (ByValue) - -### System.Security.SecureString -Parameters: VmPassword (ByValue) - -### Microsoft.Azure.Commands.ServiceFabric.Models.DurabilityLevel -Parameters: DurabilityLevel (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceFabric.Models.PSCluster - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceFabric/AzureRM.ServiceFabric.md b/azurermps-6.13.0/AzureRM.ServiceFabric/AzureRM.ServiceFabric.md deleted file mode 100644 index 9c86da8d8c..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceFabric/AzureRM.ServiceFabric.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -Module Name: AzureRM.ServiceFabric -Module Guid: 60f3ba88-443f-46ff-88a3-318cfd11c1da -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicefabric -Help Version: 0.3.4.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/AzureRM.ServiceFabric.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/AzureRM.ServiceFabric.md ---- - -# AzureRM.ServiceFabric Module -## Description -Azure Service Fabric Module that you can use to automate the end-2-end operations like creating a secure cluster, rolling over cluster certificates, adding or removed nodes from the cluster, etc. The complete list of all operations are listed below. - -## AzureRM.ServiceFabric Cmdlets -### [Add-AzureRmServiceFabricApplicationCertificate](Add-AzureRmServiceFabricApplicationCertificate.md) -Add a new certificate to the Virtual Machine Scale Set(s) that make up the cluster. The certificate is intended to be used as an application certificate. - -### [Add-AzureRmServiceFabricClientCertificate](Add-AzureRmServiceFabricClientCertificate.md) -Add common name or thumbprint to the cluster for client authentication purposes. - -### [Add-AzureRmServiceFabricClusterCertificate](Add-AzureRmServiceFabricClusterCertificate.md) -Add a secondary cluster certificate to the cluster. - -### [Add-AzureRmServiceFabricNode](Add-AzureRmServiceFabricNode.md) -Add nodes to the specific node type in the cluster. - -### [Add-AzureRmServiceFabricNodeType](Add-AzureRmServiceFabricNodeType.md) -Add a new node type to the existing cluster. - -### [Get-AzureRmServiceFabricCluster](Get-AzureRmServiceFabricCluster.md) -Get the cluster resource details. - -### [New-AzureRmServiceFabricCluster](New-AzureRmServiceFabricCluster.md) -This command uses certificates that you provide or system generated self-signed certificates to set up a new service fabric cluster. It can use a default template or a custom template that you provide. You have the option of specifying a folder to export the self-signed certificates to or fetching them later from the key vault. - -### [Remove-AzureRmServiceFabricClientCertificate](Remove-AzureRmServiceFabricClientCertificate.md) -Remove a client certificate(s) or certificate subject(s) name(s) from being used for client authentication to the cluster. - -### [Remove-AzureRmServiceFabricClusterCertificate](Remove-AzureRmServiceFabricClusterCertificate.md) -Remove a cluster certificate from being used for cluster security. - -### [Remove-AzureRmServiceFabricNode](Remove-AzureRmServiceFabricNode.md) -Remove nodes from the specific node type from a cluster. - -### [Remove-AzureRmServiceFabricNodeType](Remove-AzureRmServiceFabricNodeType.md) -Remove a complete node type from a cluster. - -### [Remove-AzureRmServiceFabricSetting](Remove-AzureRmServiceFabricSetting.md) -Remove one or multiple Service Fabric setting from the cluster. - -### [Set-AzureRmServiceFabricSetting](Set-AzureRmServiceFabricSetting.md) -Add or update one or multiple Service Fabric settings to the cluster. - -### [Set-AzureRmServiceFabricUpgradeType](Set-AzureRmServiceFabricUpgradeType.md) -Change the Service Fabric upgrade type of the cluster. - -### [Update-AzureRmServiceFabricDurability](Update-AzureRmServiceFabricDurability.md) -Update the durability tier or VmSku of a node type in the cluster. - -### [Update-AzureRmServiceFabricReliability](Update-AzureRmServiceFabricReliability.md) -Update the reliability tier of the primary node type in a cluster. - diff --git a/azurermps-6.13.0/AzureRM.ServiceFabric/Get-AzureRmServiceFabricCluster.md b/azurermps-6.13.0/AzureRM.ServiceFabric/Get-AzureRmServiceFabricCluster.md deleted file mode 100644 index 17ba083017..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceFabric/Get-AzureRmServiceFabricCluster.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceFabric.dll-Help.xml -Module Name: AzureRM.ServiceFabric -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicefabric/get-azurermservicefabriccluster -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/Get-AzureRmServiceFabricCluster.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/Get-AzureRmServiceFabricCluster.md ---- - -# Get-AzureRmServiceFabricCluster - -## SYNOPSIS -Get the cluster resource details. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### BySubscription (Default) -``` -Get-AzureRmServiceFabricCluster [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByResourceGroup -``` -Get-AzureRmServiceFabricCluster [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByName -``` -Get-AzureRmServiceFabricCluster [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmServiceFabricCluster** will get the cluster resource details. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmServiceFabricCluster -ResourceGroupName 'Group1' -ClusterName 'Contoso01SFCluster' -``` - -This command will get the cluster resource details for cluster 'myCluster'. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specify the name of the cluster. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: ClusterName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: ByResourceGroup, ByName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceFabric.Models.PSCluster - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceFabric/New-AzureRmServiceFabricCluster.md b/azurermps-6.13.0/AzureRM.ServiceFabric/New-AzureRmServiceFabricCluster.md deleted file mode 100644 index 263d350617..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceFabric/New-AzureRmServiceFabricCluster.md +++ /dev/null @@ -1,485 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceFabric.dll-Help.xml -Module Name: AzureRM.ServiceFabric -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicefabric/new-azurermservicefabriccluster -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/New-AzureRmServiceFabricCluster.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/New-AzureRmServiceFabricCluster.md ---- - -# New-AzureRmServiceFabricCluster - -## SYNOPSIS -This command uses certificates that you provide or system generated self-signed certificates to set up a new service fabric cluster. It can use a default template or a custom template that you provide. You have the option of specifying a folder to export the self-signed certificates to or fetching them later from the key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByDefaultArmTemplate (Default) -``` -New-AzureRmServiceFabricCluster [-ResourceGroupName] <String> [-CertificateOutputFolder <String>] - [-CertificatePassword <SecureString>] [-KeyVaultResouceGroupName <String>] [-KeyVaultName <String>] - -Location <String> [-Name <String>] [-VmUserName <String>] [-ClusterSize <Int32>] - [-CertificateSubjectName <String>] -VmPassword <SecureString> [-OS <OperatingSystem>] [-VmSku <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByExistingKeyVault -``` -New-AzureRmServiceFabricCluster [-ResourceGroupName] <String> -TemplateFile <String> -ParameterFile <String> - [-VmPassword <SecureString>] -SecretIdentifier <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ByNewPfxAndVaultName -``` -New-AzureRmServiceFabricCluster [-ResourceGroupName] <String> -TemplateFile <String> -ParameterFile <String> - [-CertificateOutputFolder <String>] [-CertificatePassword <SecureString>] [-KeyVaultResouceGroupName <String>] - [-KeyVaultName <String>] [-CertificateSubjectName <String>] [-VmPassword <SecureString>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByExistingPfxAndVaultName -``` -New-AzureRmServiceFabricCluster [-ResourceGroupName] <String> -TemplateFile <String> -ParameterFile <String> - -CertificateFile <String> [-CertificatePassword <SecureString>] [-SecondaryCertificateFile <String>] - [-SecondaryCertificatePassword <SecureString>] [-KeyVaultResouceGroupName <String>] [-KeyVaultName <String>] - [-VmPassword <SecureString>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmServiceFabricCluster** command uses certificates that you provide or system generated self-signed certificates to set up a new service fabric cluster. The template used can be a default template or a custom template that you provide. You have the option of specifying a folder to export the self-signed certificates or fetching them later from the key vault. -If you are specifying a custom template and parameter file, you don't need to provide the certificate information in the parameter file, the system will populate these parameters. -The four options are detailed below. Scroll down for explanations of each of the parameters. - -## EXAMPLES - -### Example 1: Specify only the cluster size, the cert subject name, and the OS to deploy a cluster. -``` -$pass="Password#1234" | ConvertTo-SecureString -AsPlainText -Force -$RGname="test01" -$clusterloc="SouthCentralUS" -$subname="{0}.{1}.cloudapp.azure.com" -f $RGname, $clusterloc -$pfxfolder="c:\certs" - -Write-Output "Create cluster in '$clusterloc' with cert subject name '$subname' and cert output path '$pfxfolder'" - -New-AzureRmServiceFabricCluster -ResourceGroupName $RGname -Location $clusterloc -ClusterSize 5 -VmPassword $pass -CertificateSubjectName $subname -CertificateOutputFolder $pfxfolder -CertificatePassword $pass -OS WindowsServer2016Datacenter -``` - -This command specifies only the cluster size, the cert subject name, and the OS to deploy a cluster. - -### Example 2: Specify an existing Certificate resource in a key vault and a custom template to deploy a cluster -``` -$RGname="test20" -$templateParmfile="C:\service-fabric-secure-nsg-cluster-65-node-3-nodetype\azuredeploytest.parameters.json" -$templateFile="C:\azure-quickstart-templates\service-fabric-secure-nsg-cluster-65-node-3-nodetype\azuredeploy.json" -$secretId="https://test1.vault.azure.net:443/secrets/testcertificate4/56ec774dc61a462bbc645ffc9b4b225f" - -New-AzureRmServiceFabricCluster -ResourceGroupName $RGname -TemplateFile $templateFile -ParameterFile $templateParmfile -SecretIdentifier $secretId -``` - -This command specifies an existing Certificate resource in a key vault and a custom template to deploy a cluster. - -### Example 3: Create a new cluster using a custom template. Specify a different resource group name for the key vault and have the system upload a new certificate to it -``` -$pass="Password#1234" | ConvertTo-SecureString -AsPlainText -Force -$RGname="test20" -$keyVaultRG="test20kvrg" -$keyVault="test20kv" -$clusterloc="SouthCentralUS" -$subname="{0}.{1}.$clusterloc.cloudapp.azure.com" -f $RGName, $clusterloc -$pfxfolder="~\Documents" -$templateParmfile="C:\service-fabric-secure-nsg-cluster-65-node-3-nodetype\azuredeploytest.parameters.json" -$templateFile="C:\service-fabric-secure-nsg-cluster-65-node-3-nodetype\azuredeploy.json" - -New-AzureRmServiceFabricCluster -ResourceGroupName $RGname -TemplateFile $templateFile -ParameterFile $templateParmfile -CertificateOutputFolder $pfxfolder -CertificatePassword $pass -KeyVaultResouceGroupName $keyVaultRG -KeyVaultName $keyVault -CertificateSubjectName $subname -``` - -This command creates a new cluster using a custom template. Specify a different resource group name for the key vault and have the system upload a new certificate to it - -### Example 4: Bring your own Certificate and custom template and create a new cluster -``` -$pass="Password#1234" | ConvertTo-SecureString -AsPlainText -Force -$RGname="test20" -$keyVaultRG="test20kvrg" -$keyVault="test20kv" -$pfxsourcefile="c:\Mycertificates\my2017Prodcert.pfx" -$templateParmfile="~\Documents\GitHub\azure-quickstart-templates-parms\service-fabric-secure-nsg-cluster-65-node-3-nodetype\azuredeploytest.parameters.json" -$templateFile="~\GitHub\azure-quickstart-templates\service-fabric-secure-nsg-cluster-65-node-3-nodetype\azuredeploy.json" - -New-AzureRmServiceFabricCluster -ResourceGroupName $RGname -TemplateFile $templateFile -ParameterFile $templateParmfile -CertificateFile $pfxsourcefile -CertificatePassword $pass -KeyVaultResouceGroupName $keyVaultRG -KeyVaultName $keyVault -``` - -This command will let you bring your own Certificate and custom template and create a new cluster. - -## PARAMETERS - -### -CertificateFile -The existing certificate file path for the primary cluster certificate. - -```yaml -Type: System.String -Parameter Sets: ByExistingPfxAndVaultName -Aliases: Source - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CertificateOutputFolder -The folder of the new certificate file to be created. - -```yaml -Type: System.String -Parameter Sets: ByDefaultArmTemplate, ByNewPfxAndVaultName -Aliases: Destination - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CertificatePassword -The password of the certificate file. - -```yaml -Type: System.Security.SecureString -Parameter Sets: ByDefaultArmTemplate, ByNewPfxAndVaultName, ByExistingPfxAndVaultName -Aliases: CertPassword - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CertificateSubjectName -The subject name of the certificate to be created. - -```yaml -Type: System.String -Parameter Sets: ByDefaultArmTemplate, ByNewPfxAndVaultName -Aliases: Subject - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ClusterSize -The number of nodes in the cluster. Default are 5 nodes. - -```yaml -Type: System.Int32 -Parameter Sets: ByDefaultArmTemplate -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyVaultName -Azure key vault name. If not given, it will be defaulted to the resource group name. - -```yaml -Type: System.String -Parameter Sets: ByDefaultArmTemplate, ByNewPfxAndVaultName, ByExistingPfxAndVaultName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -KeyVaultResouceGroupName -Azure key vault resource group name. If not given, it will be defaulted to resource group name. - -```yaml -Type: System.String -Parameter Sets: ByDefaultArmTemplate, ByNewPfxAndVaultName, ByExistingPfxAndVaultName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Location -The resource group location. - -```yaml -Type: System.String -Parameter Sets: ByDefaultArmTemplate -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specify the name of the cluster. If not given, it will be same as resource group name. - -```yaml -Type: System.String -Parameter Sets: ByDefaultArmTemplate -Aliases: ClusterName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -OS -The Operating System of the VMs that make up the cluster. - -```yaml -Type: Microsoft.Azure.Commands.ServiceFabric.Models.OperatingSystem -Parameter Sets: ByDefaultArmTemplate -Aliases: VmImage -Accepted values: WindowsServer2012R2Datacenter, WindowsServer2016Datacenter, WindowsServer2016DatacenterwithContainers, UbuntuServer1604 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ParameterFile -The path to the template parameter file. - -```yaml -Type: System.String -Parameter Sets: ByExistingKeyVault, ByNewPfxAndVaultName, ByExistingPfxAndVaultName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specify the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecondaryCertificateFile -The existing certificate file path for the secondary cluster certificate. - -```yaml -Type: System.String -Parameter Sets: ByExistingPfxAndVaultName -Aliases: SecSource - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SecondaryCertificatePassword -The password of the certificate file. - -```yaml -Type: System.Security.SecureString -Parameter Sets: ByExistingPfxAndVaultName -Aliases: SecCertPassword - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SecretIdentifier -The existing Azure key vault secret URL, for example: 'https://mykv.vault.azure.net:443/secrets/mysecrets/55ec7c4dc61a462bbc645ffc9b4b225f'. - -```yaml -Type: System.String -Parameter Sets: ByExistingKeyVault -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TemplateFile -The path to the template file. - -```yaml -Type: System.String -Parameter Sets: ByExistingKeyVault, ByNewPfxAndVaultName, ByExistingPfxAndVaultName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VmPassword -The password of the Vm. - -```yaml -Type: System.Security.SecureString -Parameter Sets: ByDefaultArmTemplate -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Security.SecureString -Parameter Sets: ByExistingKeyVault, ByNewPfxAndVaultName, ByExistingPfxAndVaultName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VmSku -The Vm Sku. - -```yaml -Type: System.String -Parameter Sets: ByDefaultArmTemplate -Aliases: Sku - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VmUserName -The user name for logging to Vm. - -```yaml -Type: System.String -Parameter Sets: ByDefaultArmTemplate -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: CertificateFile (ByValue), CertificateOutputFolder (ByValue), CertificateSubjectName (ByValue), KeyVaultName (ByValue), KeyVaultResouceGroupName (ByValue), Location (ByValue), Name (ByValue), ParameterFile (ByValue), SecondaryCertificateFile (ByValue), SecretIdentifier (ByValue), TemplateFile (ByValue), VmUserName (ByValue) - -### System.Security.SecureString -Parameters: CertificatePassword (ByValue), SecondaryCertificatePassword (ByValue) - -### System.Int32 -Parameters: ClusterSize (ByValue) - -### Microsoft.Azure.Commands.ServiceFabric.Models.OperatingSystem - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceFabric.Models.PSDeploymentResult - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceFabric/Remove-AzureRmServiceFabricClientCertificate.md b/azurermps-6.13.0/AzureRM.ServiceFabric/Remove-AzureRmServiceFabricClientCertificate.md deleted file mode 100644 index bae3c41168..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceFabric/Remove-AzureRmServiceFabricClientCertificate.md +++ /dev/null @@ -1,247 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceFabric.dll-Help.xml -Module Name: AzureRM.ServiceFabric -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicefabric/remove-azurermservicefabricclientcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/Remove-AzureRmServiceFabricClientCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/Remove-AzureRmServiceFabricClientCertificate.md ---- - -# Remove-AzureRmServiceFabricClientCertificate - -## SYNOPSIS -Remove a client certificate(s) or certificate subject(s) name(s) from being used for client authentication to the cluster. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SingleUpdateWithCommonName -``` -Remove-AzureRmServiceFabricClientCertificate [-ResourceGroupName] <String> [-Name] <String> - -CommonName <String> -IssuerThumbprint <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### SingleUpdateWithThumbprint -``` -Remove-AzureRmServiceFabricClientCertificate [-ResourceGroupName] <String> [-Name] <String> - -Thumbprint <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### MultipleUpdatesWithCommonName -``` -Remove-AzureRmServiceFabricClientCertificate [-ResourceGroupName] <String> [-Name] <String> - -ClientCertificateCommonName <PSClientCertificateCommonName[]> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### MultipleUpdatesWithThumbprint -``` -Remove-AzureRmServiceFabricClientCertificate [-ResourceGroupName] <String> [-Name] <String> - [-AdminClientThumbprint <String[]>] [-ReadonlyClientThumbprint <String[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Use **Remove-AzureRmServiceFabricClientCertificate** to remove a client certificate(s) or certificate subject(s) name(s) from being used for client authentication to the cluster. - -## EXAMPLES - -### Example 1 -``` -PS c:> Remove-AzureRmServiceFabricClientCertificate -ResourceGroupName 'Group1' -Name 'Contoso01SFCluster' -Thumbprint 5F3660C715EBBDA31DB1FFDCF508302348DE8E7A -``` - -This command will remove client certificate with thumbprint '5F3660C715EBBDA31DB1FFDCF508302348DE8E7A' from the cluster. - -## PARAMETERS - -### -AdminClientThumbprint -Specify client certificate thumbprint that only has admin permission. - -```yaml -Type: System.String[] -Parameter Sets: MultipleUpdatesWithThumbprint -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ClientCertificateCommonName -Specify client common name, issuer thumbprint, and authentication type. - -```yaml -Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSClientCertificateCommonName[] -Parameter Sets: MultipleUpdatesWithCommonName -Aliases: CertCommonName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CommonName -Specify client certificate common name. - -```yaml -Type: System.String -Parameter Sets: SingleUpdateWithCommonName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IssuerThumbprint -Specify client certificate issuer thumbprint. - -```yaml -Type: System.String -Parameter Sets: SingleUpdateWithCommonName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specify the name of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ClusterName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReadonlyClientThumbprint -Specify client certificate thumbprint that has read only permission. - -```yaml -Type: System.String[] -Parameter Sets: MultipleUpdatesWithThumbprint -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Thumbprint -Specify client certificate thumbprint. - -```yaml -Type: System.String -Parameter Sets: SingleUpdateWithThumbprint -Aliases: ClientCertificateThumbprint - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: CommonName (ByValue), IssuerThumbprint (ByValue), Thumbprint (ByValue) - -### System.String[] -Parameters: AdminClientThumbprint (ByValue), ReadonlyClientThumbprint (ByValue) - -### Microsoft.Azure.Commands.ServiceFabric.Models.PSClientCertificateCommonName[] -Parameters: ClientCertificateCommonName (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceFabric.Models.PSCluster - -## NOTES - -## RELATED LINKS - -[Add-AzureRmServiceFabricClientCertificate](./Add-AzureRmServiceFabricClientCertificate.md) diff --git a/azurermps-6.13.0/AzureRM.ServiceFabric/Remove-AzureRmServiceFabricClusterCertificate.md b/azurermps-6.13.0/AzureRM.ServiceFabric/Remove-AzureRmServiceFabricClusterCertificate.md deleted file mode 100644 index 6fe99887e1..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceFabric/Remove-AzureRmServiceFabricClusterCertificate.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceFabric.dll-Help.xml -Module Name: AzureRM.ServiceFabric -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicefabric/remove-azurermservicefabricclustercertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/Remove-AzureRmServiceFabricClusterCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/Remove-AzureRmServiceFabricClusterCertificate.md ---- - -# Remove-AzureRmServiceFabricClusterCertificate - -## SYNOPSIS -Remove a cluster certificate from being used for cluster security. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmServiceFabricClusterCertificate -Thumbprint <String> [-Name] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Use **Remove-AzureRmServiceFabricClusterCertificate** to remove a cluster certificate from the cluster, as long as there is another valid certificate that is already in use in the cluster. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmServiceFabricClusterCertificate -ResourceGroupName 'Group1' -Name 'Contoso01SFCluster' -Thumbprint '5F3660C715EBBDA31DB1FFDCF508302348DE8E7A -``` - -This command removes the certificate with thumbprint 5F3660C715EBBDA31DB1FFDCF508302348DE8E7A from being used for cluster security. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specify the name of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ClusterName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Thumbprint -Specify the cluster thumbprint which to be removed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: Thumbprint (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceFabric.Models.PSCluster - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceFabric/Remove-AzureRmServiceFabricNode.md b/azurermps-6.13.0/AzureRM.ServiceFabric/Remove-AzureRmServiceFabricNode.md deleted file mode 100644 index 3fb09e0b09..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceFabric/Remove-AzureRmServiceFabricNode.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceFabric.dll-Help.xml -Module Name: AzureRM.ServiceFabric -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicefabric/remove-azurermservicefabricnode -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/Remove-AzureRmServiceFabricNode.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/Remove-AzureRmServiceFabricNode.md ---- - -# Remove-AzureRmServiceFabricNode - -## SYNOPSIS -Remove nodes from the specific node type from a cluster. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmServiceFabricNode -NumberOfNodesToRemove <Int32> [-ResourceGroupName] <String> [-Name] <String> - -NodeType <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Use **Remove-AzureRmServiceFabricNode** to remove nodes from a specific node type from a cluster. The removal proceeds only if it meets cluster health metrics. - -## EXAMPLES - -### Example 1 -``` -PS c:> Remove-AzureRmServiceFabricNode -ResourceGroupName 'Group1' -Name 'Contoso01SFCluster' -NodeTypeName 'nt1' -NumberOfNodesToRemove 2 -``` - -This command will remove 2 nodes from the NodeType 'nt1'. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specify the name of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ClusterName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NodeType -Node type name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NumberOfNodesToRemove -Number of nodes to remove. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: Number - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Int32 -Parameters: NumberOfNodesToRemove (ByValue) - -### System.String -Parameters: NodeType (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceFabric.Models.PSCluster - -## NOTES - -## RELATED LINKS - -[Add-AzureRmServiceFabricNode](./Add-AzureRmServiceFabricNode.md) diff --git a/azurermps-6.13.0/AzureRM.ServiceFabric/Remove-AzureRmServiceFabricNodeType.md b/azurermps-6.13.0/AzureRM.ServiceFabric/Remove-AzureRmServiceFabricNodeType.md deleted file mode 100644 index 02a1605625..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceFabric/Remove-AzureRmServiceFabricNodeType.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceFabric.dll-Help.xml -Module Name: AzureRM.ServiceFabric -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicefabric/remove-azurermservicefabricnodetype -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/Remove-AzureRmServiceFabricNodeType.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/Remove-AzureRmServiceFabricNodeType.md ---- - -# Remove-AzureRmServiceFabricNodeType - -## SYNOPSIS -Remove a complete node type from a cluster. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmServiceFabricNodeType [-ResourceGroupName] <String> [-Name] <String> -NodeType <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Use the **Remove-AzureRmServiceFabricNodeType** to remove all nodes from a specific node type and the node type from a cluster. This command cannot be used to delete the primary node type. - -## EXAMPLES - -### Example 1 -``` -PS c:> Remove-AzureRmServiceFabricNodeType -ResourceGroupName 'Group1' -Name 'Contoso01SFCluster' -NodeTypeName 'nt1' -``` - -This command will remove NodeType 'nt1' from the cluster. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specify the name of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ClusterName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NodeType -The node type name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: NodeType (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceFabric.Models.PSCluster - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceFabric/Remove-AzureRmServiceFabricSetting.md b/azurermps-6.13.0/AzureRM.ServiceFabric/Remove-AzureRmServiceFabricSetting.md deleted file mode 100644 index d29136ec5e..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceFabric/Remove-AzureRmServiceFabricSetting.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceFabric.dll-Help.xml -Module Name: AzureRM.ServiceFabric -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicefabric/remove-azurermservicefabricsetting -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/Remove-AzureRmServiceFabricSetting.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/Remove-AzureRmServiceFabricSetting.md ---- - -# Remove-AzureRmServiceFabricSetting - -## SYNOPSIS -Remove one or multiple Service Fabric setting from the cluster. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### OneSetting -``` -Remove-AzureRmServiceFabricSetting [-ResourceGroupName] <String> [-Name] <String> -Section <String> - -Parameter <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### BatchSettings -``` -Remove-AzureRmServiceFabricSetting [-ResourceGroupName] <String> [-Name] <String> - -SettingsSectionDescription <PSSettingsSectionDescription[]> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Use **Remove-AzureRmServiceFabricSetting** to remove Service Fabric settings from the cluster. - -## EXAMPLES - -### Example 1 -``` -PS c:> Remove-AzureRmServiceFabricSetting -ResourceGroupName 'Group1' -Name 'Contoso01SFCluster' -Section 'EseStore' -Parameter 'MaxCursors' -``` - -This command will remove settings 'MaxCursors' under 'EseStore' section. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specify the name of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ClusterName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Parameter -Parameter. - -```yaml -Type: System.String -Parameter Sets: OneSetting -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Section -Section. - -```yaml -Type: System.String -Parameter Sets: OneSetting -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SettingsSectionDescription -Client authentication type. - -```yaml -Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSSettingsSectionDescription[] -Parameter Sets: BatchSettings -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: Parameter (ByValue), Section (ByValue) - -### Microsoft.Azure.Commands.ServiceFabric.Models.PSSettingsSectionDescription[] -Parameters: SettingsSectionDescription (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceFabric.Models.PSCluster - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceFabric/Set-AzureRmServiceFabricSetting.md b/azurermps-6.13.0/AzureRM.ServiceFabric/Set-AzureRmServiceFabricSetting.md deleted file mode 100644 index bd9770f254..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceFabric/Set-AzureRmServiceFabricSetting.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceFabric.dll-Help.xml -Module Name: AzureRM.ServiceFabric -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicefabric/set-azurermservicefabricsetting -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/Set-AzureRmServiceFabricSetting.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/Set-AzureRmServiceFabricSetting.md ---- - -# Set-AzureRmServiceFabricSetting - -## SYNOPSIS -Add or update one or multiple Service Fabric settings to the cluster. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### OneSetting -``` -Set-AzureRmServiceFabricSetting [-ResourceGroupName] <String> [-Name] <String> -Section <String> - -Parameter <String> -Value <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### BatchSettings -``` -Set-AzureRmServiceFabricSetting [-ResourceGroupName] <String> [-Name] <String> - -SettingsSectionDescription <PSSettingsSectionDescription[]> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Use **Set-AzureRmServiceFabricSetting** to add or update Service Fabric settings in a cluster. - -## EXAMPLES - -### Example 1 -``` -PS c:\> Set-AzureRmServiceFabricSetting -ResourceGroupName 'Group1' -Name 'Contoso01SFCluster' -Section 'NamingService' -Parameter 'MaxFileOperationTimeout' -Value 5000 -``` - -This command will set 'MaxFileOperationTimeout' to value '5000' under the section 'NamingService'. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specify the name of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ClusterName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Parameter -Parameter. - -```yaml -Type: System.String -Parameter Sets: OneSetting -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Section -Section. - -```yaml -Type: System.String -Parameter Sets: OneSetting -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SettingsSectionDescription -Client authentication type. - -```yaml -Type: Microsoft.Azure.Commands.ServiceFabric.Models.PSSettingsSectionDescription[] -Parameter Sets: BatchSettings -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Value -Value. - -```yaml -Type: System.String -Parameter Sets: OneSetting -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: Parameter (ByValue), Section (ByValue), Value (ByValue) - -### Microsoft.Azure.Commands.ServiceFabric.Models.PSSettingsSectionDescription[] -Parameters: SettingsSectionDescription (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceFabric.Models.PSCluster - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceFabric/Set-AzureRmServiceFabricUpgradeType.md b/azurermps-6.13.0/AzureRM.ServiceFabric/Set-AzureRmServiceFabricUpgradeType.md deleted file mode 100644 index 8afc3f09ec..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceFabric/Set-AzureRmServiceFabricUpgradeType.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceFabric.dll-Help.xml -Module Name: AzureRM.ServiceFabric -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicefabric/set-azurermservicefabricupgradetype -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/Set-AzureRmServiceFabricUpgradeType.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/Set-AzureRmServiceFabricUpgradeType.md ---- - -# Set-AzureRmServiceFabricUpgradeType - -## SYNOPSIS -Change the Service Fabric upgrade type of the cluster. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Automatic -``` -Set-AzureRmServiceFabricUpgradeType [-ResourceGroupName] <String> [-Name] <String> - -UpgradeMode <ClusterUpgradeMode> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### Manual -``` -Set-AzureRmServiceFabricUpgradeType [-ResourceGroupName] <String> [-Name] <String> - -UpgradeMode <ClusterUpgradeMode> -Version <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Use **Set-AzureRmServiceFabricUpgradeType** to set upgrade type to automatic or manual with specific Service Fabric code version. - -## EXAMPLES - -### Example 1 -``` -PS c:> Set-AzureRmServiceFabricUpgradeType -ResourceGroupName 'Group1' -Name 'Contoso01SFCluster' -UpgradeMode Automatic -``` - -This command will set the cluster upgrade mode to automatic. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specify the name of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ClusterName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UpgradeMode -ClusterUpgradeMode - -```yaml -Type: Microsoft.Azure.Commands.ServiceFabric.Models.ClusterUpgradeMode -Parameter Sets: (All) -Aliases: -Accepted values: Automatic, Manual - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Version -Cluster code version. - -```yaml -Type: System.String -Parameter Sets: Manual -Aliases: ClusterCodeVersion - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: Version (ByValue) - -### Microsoft.Azure.Commands.ServiceFabric.Models.ClusterUpgradeMode -Parameters: UpgradeMode (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceFabric.Models.PSCluster - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceFabric/Update-AzureRmServiceFabricDurability.md b/azurermps-6.13.0/AzureRM.ServiceFabric/Update-AzureRmServiceFabricDurability.md deleted file mode 100644 index 7ac415ed2f..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceFabric/Update-AzureRmServiceFabricDurability.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceFabric.dll-Help.xml -Module Name: AzureRM.ServiceFabric -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicefabric/update-azurermservicefabricdurability -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/Update-AzureRmServiceFabricDurability.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/Update-AzureRmServiceFabricDurability.md ---- - -# Update-AzureRmServiceFabricDurability - -## SYNOPSIS -Update the durability tier or VmSku of a node type in the cluster. It will also update the durability tier in the Service Fabric VM extension on the associated Virtual Machine Scale Set. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Update-AzureRmServiceFabricDurability [-ResourceGroupName] <String> [-Name] <String> -NodeType <String> - -DurabilityLevel <DurabilityLevel> [-Sku <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Use **Update-AzureRmServiceFabricDurability** to update durability or SKU of the cluster. - -## EXAMPLES - -### Example 1 -``` -PS c:> Update-AzureRmServiceFabricDurability -ResourceGroupName 'Group1' -Name 'Contoso01SFCluster' -DurabilityLevel Silver -NodeType nt1 -``` - -This command changes durability tier of the NodeType 'nt1' to silver. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DurabilityLevel -Specify durability level. - -```yaml -Type: Microsoft.Azure.Commands.ServiceFabric.Models.DurabilityLevel -Parameter Sets: (All) -Aliases: Level -Accepted values: Bronze, Silver, Gold - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specify the name of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ClusterName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NodeType -Specify Service Fabric node type name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -Specify the SKU of the node type. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: NodeType (ByValue), Sku (ByValue) - -### Microsoft.Azure.Commands.ServiceFabric.Models.DurabilityLevel -Parameters: DurabilityLevel (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceFabric.Models.PSCluster - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.ServiceFabric/Update-AzureRmServiceFabricReliability.md b/azurermps-6.13.0/AzureRM.ServiceFabric/Update-AzureRmServiceFabricReliability.md deleted file mode 100644 index c5ab65794a..0000000000 --- a/azurermps-6.13.0/AzureRM.ServiceFabric/Update-AzureRmServiceFabricReliability.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ServiceFabric.dll-Help.xml -Module Name: AzureRM.ServiceFabric -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.servicefabric/update-azurermservicefabricreliability -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/Update-AzureRmServiceFabricReliability.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/ServiceFabric/Commands.ServiceFabric/help/Update-AzureRmServiceFabricReliability.md ---- - -# Update-AzureRmServiceFabricReliability - -## SYNOPSIS -Update the reliability tier of the primary node type in a cluster. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Update-AzureRmServiceFabricReliability [-ResourceGroupName] <String> [-Name] <String> - -ReliabilityLevel <ReliabilityLevel> [-AutoAddNode] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Use **Update-AzureRmServiceFabricReliability** to update reliability of the primary node type in a cluster. - -## EXAMPLES - -### Example 1 -``` -PS c:> Add-AzureRmServiceFabricReliability -ResourceGroupName 'Group1' -Name 'Contoso01SFCluster' -ReliabilityLevel Silver -``` - -This command changes the reliability tier of the primary node type to silver. - -## PARAMETERS - -### -AutoAddNode -Add node count automatically when changing reliability. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: Auto - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specify the name of the cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ClusterName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReliabilityLevel -Reliability tier. - -```yaml -Type: Microsoft.Azure.Commands.ServiceFabric.Models.ReliabilityLevel -Parameter Sets: (All) -Aliases: Level -Accepted values: None, Bronze, Silver, Gold, Platinum - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.ServiceFabric.Models.ReliabilityLevel -Parameters: ReliabilityLevel (ByValue) - -### System.Management.Automation.SwitchParameter -Parameters: AutoAddNode (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.ServiceFabric.Models.PSCluster - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.SignalR/AzureRM.SignalR.md b/azurermps-6.13.0/AzureRM.SignalR/AzureRM.SignalR.md deleted file mode 100644 index 1fddfef2c7..0000000000 --- a/azurermps-6.13.0/AzureRM.SignalR/AzureRM.SignalR.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -Module Name: AzureRM.SignalR -Module Guid: 7aa1b2c0-72cb-448a-9c12-c45bdf3e088d -Download Help Link: {{Please enter FwLink manually}} -Help Version: 0.1.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/SignalR/Commands.SignalR/help/AzureRM.SignalR.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/SignalR/Commands.SignalR/help/AzureRM.SignalR.md ---- - -# AzureRM.SignalR Module -## Description -Cmdlets to interact with the Azure SignalR service. - -## AzureRM.SignalR Cmdlets -### [Get-AzureRmSignalR](Get-AzureRmSignalR.md) -Get a specific SignalR service or all the SignalR services in a resource group or a subscription. - -### [Get-AzureRmSignalRKey](Get-AzureRmSignalRKey.md) -Get the access keys of a SignalR service. - -### [New-AzureRmSignalR](New-AzureRmSignalR.md) -Create a SignalR service. - -### [New-AzureRmSignalRKey](New-AzureRmSignalRKey.md) -Regenerate an access key for a SignalR service. - -### [Remove-AzureRmSignalR](Remove-AzureRmSignalR.md) -Remove a SignalR service. - diff --git a/azurermps-6.13.0/AzureRM.SignalR/Get-AzureRmSignalR.md b/azurermps-6.13.0/AzureRM.SignalR/Get-AzureRmSignalR.md deleted file mode 100644 index a503dbf60c..0000000000 --- a/azurermps-6.13.0/AzureRM.SignalR/Get-AzureRmSignalR.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.SignalR.dll-Help.xml -Module Name: AzureRM.SignalR -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.signalr/get-azurermsignalr -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/SignalR/Commands.SignalR/help/Get-AzureRmSignalR.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/SignalR/Commands.SignalR/help/Get-AzureRmSignalR.md ---- - -# Get-AzureRmSignalR - -## SYNOPSIS -Get a specific SignalR service or all the SignalR services in a resource group or a subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ListSignalRServiceParameterSet (Default) -``` -Get-AzureRmSignalR [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ResourceGroupParameterSet -``` -Get-AzureRmSignalR [-ResourceGroupName <String>] [-Name] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Get-AzureRmSignalR -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Get a specific SignalR service or all the SignalR services in a resource group or a subscription. - -## EXAMPLES - -### Get all SignalR services in the subscription -```powershell -PS C:\> Get-AzureRmSignalR - - -HostName Location ServerPort PublicPort ProvisioningState Version --------- -------- ---------- ---------- ----------------- ------- -mysignalr1.service.signalr.net eastus 5002 5001 Succeeded 1.0 -mysignalr2.service.signalr.net eastus 5002 5001 Succeeded 1.0 -mysignalr3.service.signalr.net eastus 5002 5001 Creating 1.0 -``` - -### Get all SignalR services in a resource group - -```powershell -PS C:\> Get-AzureRmSignalR -ResourceGroupName myResourceGroup - -HostName Location ServerPort PublicPort ProvisioningState Version --------- -------- ---------- ---------- ----------------- ------- -mysignalr1.service.signalr.net eastus 5002 5001 Succeeded 1.0 -mysignalr2.service.signalr.net eastus 5002 5001 Succeeded 1.0 -``` - -### Get a specific SignalR service - -```powershell -PS C:\> Get-AzureRmSignalR -ResourceGroupName myResourceGroup -Name mysignalr1 - -HostName Location ServerPort PublicPort ProvisioningState Version --------- -------- ---------- ---------- ----------------- ------- -mysignalr1.service.signalr.net eastus 5002 5001 Succeeded 1.0 -``` - -### Get a specific SignalR service from the default resource group - -```powershell -PS C:\> Get-AzureRmSignalR -Name mysignalr2 - -HostName Location ServerPort PublicPort ProvisioningState Version --------- -------- ---------- ---------- ----------------- ------- -mysignalr2.service.signalr.net eastus 5002 5001 Succeeded 1.0 -``` - -The default resource group can be set by `Set-AzureRmDefault -ResourceGroupName myResourceGroup`. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -SignalR service name. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource group name. - -```yaml -Type: System.String -Parameter Sets: ListSignalRServiceParameterSet, ResourceGroupParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The SignalR service resource ID. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: ResourceId (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.SignalR/Get-AzureRmSignalRKey.md b/azurermps-6.13.0/AzureRM.SignalR/Get-AzureRmSignalRKey.md deleted file mode 100644 index 9f8b65ecbb..0000000000 --- a/azurermps-6.13.0/AzureRM.SignalR/Get-AzureRmSignalRKey.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.SignalR.dll-Help.xml -Module Name: AzureRM.SignalR -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.signalr/get-azurermsignalrkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/SignalR/Commands.SignalR/help/Get-AzureRmSignalRKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/SignalR/Commands.SignalR/help/Get-AzureRmSignalRKey.md ---- - -# Get-AzureRmSignalRKey - -## SYNOPSIS -Get the access keys of a SignalR service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceGroupParameterSet (Default) -``` -Get-AzureRmSignalRKey [-ResourceGroupName <String>] [-Name] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Get-AzureRmSignalRKey -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### InputObjectParameterSet -``` -Get-AzureRmSignalRKey -InputObject <PSSignalRResource> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -Get the access keys of a SignalR service. - -## EXAMPLES - -### Get access keys of a specific SignalR service -```powershell -PS C:\> Get-AzureRmSignalRKey -ResourceGroupName myResourceGroup -Name mysignalr1 - -Name : mysignalr1 -PrimaryKey : vmYRhoM62PMkNe/CSSPdMSxokn+WZEFmOQNt77PovDs= -PrimaryConnectionString : Endpoint=https://mysignalr1.service.signalr.net;AccessKey=vmYRhoM62PMkNe/CSSPdMSxokn+WZEFmO - QNt77PovDs=; -SecondaryKey : 2+HkuxAA34xiZFFiDsVM0uDyzCsg6GKsdXSjN4C/YFQ= -SecondaryConnectionString : Endpoint=https://mysignalr1.service.signalr.net;AccessKey=2+HkuxAA34xiZFFiDsVM0uDyzCsg6GKsd - XSjN4C/YFQ=; -``` - -### Get access keys from a SignalR service object in pipe - -```powershell -PS C:\> Get-AzureRmSignalR -ResourceGroupName myResourceGroup -Name mysignalr1 | Get-AzureRmSignalRKey - -Name : mysignalr1 -PrimaryKey : vmYRhoM62PMkNe/CSSPdMSxokn+WZEFmOQNt77PovDs= -PrimaryConnectionString : Endpoint=https://mysignalr1.service.signalr.net;AccessKey=vmYRhoM62PMkNe/CSSPdMSxokn+WZEFmO - QNt77PovDs=; -SecondaryKey : 2+HkuxAA34xiZFFiDsVM0uDyzCsg6GKsdXSjN4C/YFQ= -SecondaryConnectionString : Endpoint=https://mysignalr1.service.signalr.net;AccessKey=2+HkuxAA34xiZFFiDsVM0uDyzCsg6GKsd - XSjN4C/YFQ=; -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The SignalR resource object. - -```yaml -Type: Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -SignalR service name. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource group name. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The SignalR service resource ID. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: ResourceId (ByValue) - -### Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.SignalR.Models.PSSignalRKeys - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.SignalR/New-AzureRmSignalR.md b/azurermps-6.13.0/AzureRM.SignalR/New-AzureRmSignalR.md deleted file mode 100644 index b35efc1c69..0000000000 --- a/azurermps-6.13.0/AzureRM.SignalR/New-AzureRmSignalR.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.SignalR.dll-Help.xml -Module Name: AzureRM.SignalR -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.signalr/new-azurermsignalr -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/SignalR/Commands.SignalR/help/New-AzureRmSignalR.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/SignalR/Commands.SignalR/help/New-AzureRmSignalR.md ---- - -# New-AzureRmSignalR - -## SYNOPSIS -Create a SignalR service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmSignalR [-ResourceGroupName <String>] [-Name] <String> [-Location <String>] [-Sku <String>] - [-UnitCount <Int32>] [-Tag <System.Collections.Generic.IDictionary`2[System.String,System.String]>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Create a SignalR service. -The following values will be used for the parameters if not specified: -* `ResourceGroupName`: the default resource group set by `Set-AzureRmDefault -ResourceGroupName`. -* `Location`: the location of the resource group -* `Sku`: `Standard_S1` - -## EXAMPLES - -### Create a SignalR serivce -```powershell -PS C:\> New-AzureRmSignalR -ResourceGroupName myResourceGroup1 -Name mysignalr1 -Location eastus -Sku Standard_S1 - -HostName Location ServerPort PublicPort ProvisioningState Version --------- -------- ---------- ---------- ----------------- ------- -mysignalr1.service.signalr.net eastus 5002 5001 Succeeded 1.0-preview -``` - -## PARAMETERS - -### -AsJob -Run the cmdlet in background job. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The SignalR service location. The resource group location will be used if not specified. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The SignalR service name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. The default one will be used if not specified. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sku -The SignalR service SKU. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Standard_S1 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -The tags for the SignalR service. - -```yaml -Type: System.Collections.Generic.IDictionary`2[System.String,System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UnitCount -The SignalR service unit count, from 1 to 10. Default to 1. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 1 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.SignalR/New-AzureRmSignalRKey.md b/azurermps-6.13.0/AzureRM.SignalR/New-AzureRmSignalRKey.md deleted file mode 100644 index 852b32b199..0000000000 --- a/azurermps-6.13.0/AzureRM.SignalR/New-AzureRmSignalRKey.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.SignalR.dll-Help.xml -Module Name: AzureRM.SignalR -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.signalr/new-azurermsignalrkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/SignalR/Commands.SignalR/help/New-AzureRmSignalRKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/SignalR/Commands.SignalR/help/New-AzureRmSignalRKey.md ---- - -# New-AzureRmSignalRKey - -## SYNOPSIS -Regenerate an access key for a SignalR service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceGroupParameterSet (Default) -``` -New-AzureRmSignalRKey [-ResourceGroupName <String>] [-Name] <String> [-KeyType] <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -New-AzureRmSignalRKey -ResourceId <String> [-KeyType] <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectParameterSet -``` -New-AzureRmSignalRKey -InputObject <PSSignalRResource> [-KeyType] <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Regenerate an access key for a SignalR service. - -## EXAMPLES - -### Regenerate the primary key -```powershell -PS C:\> New-AzureRmSignalRKey -ResourceGroupName myResourceGroup -Name mysignalr1 -KeyType Primary -PassThru - -True -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The SignalR resource object. - -```yaml -Type: Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -KeyType -The key type, either Primary or Secondary. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Primary, Secondary - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -SignalR service name. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true if the regeneration was completed successfully. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource group name. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The SignalR service resource ID. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: ResourceId (ByValue) - -### Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.SignalR/Remove-AzureRmSignalR.md b/azurermps-6.13.0/AzureRM.SignalR/Remove-AzureRmSignalR.md deleted file mode 100644 index a153c12926..0000000000 --- a/azurermps-6.13.0/AzureRM.SignalR/Remove-AzureRmSignalR.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.SignalR.dll-Help.xml -Module Name: AzureRM.SignalR -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.signalr/new-azurermsignalr -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/SignalR/Commands.SignalR/help/Remove-AzureRmSignalR.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/SignalR/Commands.SignalR/help/Remove-AzureRmSignalR.md ---- - -# Remove-AzureRmSignalR - -## SYNOPSIS -Remove a SignalR service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceGroupParameterSet (Default) -``` -Remove-AzureRmSignalR [-ResourceGroupName <String>] [-Name] <String> [-AsJob] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceIdParameterSet -``` -Remove-AzureRmSignalR -ResourceId <String> [-AsJob] [-PassThru] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectParameterSet -``` -Remove-AzureRmSignalR -InputObject <PSSignalRResource> [-AsJob] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Remove a SignalR service. - -## EXAMPLES - -### Remove a SignalR service -```powershell -PS C:\> Remove-AzureRmSignalR -ResourceGroupName myResourceGroup -Name mysignalr1 -PassThru - -True -``` - -### Remove all SignalR service from pipe -```powershell -PS C:\> Get-AzureRmSignalR -ResourceGroupName myResourceGroup | Remove-AzureRmSignalR -``` - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The SignalR resource object. - -```yaml -Type: Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -SignalR service name. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true if the removal was completed successfully. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource group name. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The SignalR service resource ID. - -```yaml -Type: System.String -Parameter Sets: ResourceIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: ResourceId (ByValue) - -### Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Add-AzureRmSqlDatabaseToFailoverGroup.md b/azurermps-6.13.0/AzureRM.Sql/Add-AzureRmSqlDatabaseToFailoverGroup.md deleted file mode 100644 index 1db3740c56..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Add-AzureRmSqlDatabaseToFailoverGroup.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/add-azurermsqldatabasetofailovergroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Add-AzureRmSqlDatabaseToFailoverGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Add-AzureRmSqlDatabaseToFailoverGroup.md ---- - -# Add-AzureRmSqlDatabaseToFailoverGroup - -## SYNOPSIS -Adds one or more databases to an Azure SQL Database Failover Group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmSqlDatabaseToFailoverGroup [-ServerName] <String> [-FailoverGroupName] <String> - -Database <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel]> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Adds one or more databases on a Azure SQL Database Failover Group's primary server to that Failover Group. The databases must not be secondary databases in existing replication relationships. The command will start geo-replication of any added databases to the Failover Group's secondary server. -To obtain database objects with which to populate the '-Database' parameter, use (for example) the Get-AzureRmSqlDatabase cmdlet. -The Failover Group's primary server must be used to execute the command. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $failoverGroup = Get-AzureRmSqlDatabase -ResourceGroupName rg -ServerName primaryserver -DatabaseName db1 | Add-AzureRmSqlDatabaseToFailoverGroup -ResourceGroupName rg -ServerName primaryserver -FailoverGroupName fg -``` - -This command adds one database to a Failover Group by piping it in. - -### Example 2 -``` -PS C:\> $primaryServer = Get-AzureRmSqlServer -ResourceGroupName rg -ServerName primaryserver -PS C:\> $failoverGroup = $primaryServer | Add-AzureRmSqlDatabaseToFailoverGroup -FailoverGroupName fg -Database ($primaryServer | Get-AzureRmSqlDatabase) -``` - -This command adds all databases in a server to a Failover Group. - -### Example 3 -``` -PS C:\> $failoverGroup = Get-AzureRmSqlDatabaseFailoverGroup -ResourceGroupName rg -ServerName primaryserver -FailoverGroupName fg -PS C:\> $databases = Get-AzureRmSqlElasticPoolDatabase -ResourceGroupName rg -ServerName primaryserver -ElasticPoolName pool1 -PS C:\> $failoverGroup = $failoverGroup | Add-AzureRmSqlDatabaseToFailoverGroup -Database $databases -``` - -This command adds all databases in an Elastic Pool to a Failover Group. - -## PARAMETERS - -### -Database -One or more Azure SQL Databases on the Failover Group's primary server to be added to the Failover Group. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FailoverGroupName -The name of the Azure SQL Database Failover Group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The name of the primary Azure SQL Database Server of the Failover Group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel, Microsoft.Azure.Commands.Sql, Version=4.11.0.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.FailoverGroup.Model.AzureSqlFailoverGroupModel - -## NOTES - -## RELATED LINKS - -[New-AzureRmSqlDatabaseFailoverGroup](./New-AzureRmSqlDatabaseFailoverGroup.md) - -[Set-AzureRmSqlDatabaseFailoverGroup](./Set-AzureRmSqlDatabaseFailoverGroup.md) - -[Get-AzureRmSqlDatabaseFailoverGroup](./Get-AzureRmSqlDatabaseFailoverGroup.md) - -[Remove-AzureRmSqlDatabaseFromFailoverGroup](./Remove-AzureRmSqlDatabaseFromFailoverGroup.md) - -[Switch-AzureRmSqlDatabaseFailoverGroup](./Switch-AzureRmSqlDatabaseFailoverGroup.md) - -[Remove-AzureRmSqlDatabaseFailoverGroup](./Remove-AzureRmSqlDatabaseFailoverGroup.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate.md b/azurermps-6.13.0/AzureRM.Sql/Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate.md deleted file mode 100644 index ca4a515d62..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate.md ---- - -# Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate - -## SYNOPSIS -Adds a Transparent Data Encryption Certificate for the given managed instance - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate [-PassThru] [-ResourceGroupName] <String> - [-ManagedInstanceName] <String> [-PrivateBlob] <SecureString> [-Password] <SecureString> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate adds a Transparent Data Encryption Certificate for the given managed instance - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> $privateBlob = "MIIJ+QIBAzCCCbUGCSqGSIb3DQEHAaCCCaYEggmiMIIJnjCCBhcGCSqGSIb3Dasdsadasd" -PS C:\> $securePrivateBlob = $privateBlob | ConvertTo-SecureString -AsPlainText -Force -PS C:\> $password = "CertificatePassword" -PS C:\> $securePassword = $password | ConvertTo-SecureString -AsPlainText -Force -PS C:\> Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate -ResourceGroupName "YourResourceGroupName" -ManagedInstanceName "YourManagedInstanceName" -PrivateBlob $securePrivateBlob -Password $securePassword -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedInstanceName -The managed instance name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -On Successful execution, returns certificate object that was added. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -The Password for Transparent Data Encryption Certificate - -```yaml -Type: System.Security.SecureString -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateBlob -The Private blob for Transparent Data Encryption Certificate - -```yaml -Type: System.Security.SecureString -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Add-AzureRmSqlServerKeyVaultKey.md b/azurermps-6.13.0/AzureRM.Sql/Add-AzureRmSqlServerKeyVaultKey.md deleted file mode 100644 index 2ba23073b3..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Add-AzureRmSqlServerKeyVaultKey.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/add-azurermsqlserverkeyvaultkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Add-AzureRmSqlServerKeyVaultKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Add-AzureRmSqlServerKeyVaultKey.md ---- - -# Add-AzureRmSqlServerKeyVaultKey - -## SYNOPSIS -Adds a Key Vault key to a SQL server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmSqlServerKeyVaultKey [-KeyId] <String> [-AsJob] [-ServerName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Add-AzureRmSqlServerKeyVaultKey cmdlet adds a Key Vault key to the provided SQL server. -The server must have 'get, wrapKey, unwrapKey' permissions to the vault. - -## EXAMPLES - -### Example 1: Add Key Vault key -``` -PS C:\> Add-AzureRmSqlServerKeyVaultKey -KeyId 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' -ServerName 'ContosoServer' -ResourceGroupName 'ContosoResourceGroup' -``` - -This command adds the Key Vault key with Id 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' to the SQL server named 'ContosoServer' in the resource group 'ContosoResourceGroup'. -ResourceGroupName : ContosoResourceGroup -ServerName : ContosoServer -ServerKeyName : contoso_contosokey_01234567890123456789012345678901 -Type : AzureKeyVault -Uri : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901 -Thumbprint : 1122334455667788990011223344556677889900 -CreationDate : 1/1/2017 12:00:00 AM - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyId -The Azure Key Vault KeyId. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The Azure Sql Server name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ServerKeyVaultKey.Model.AzureSqlServerKeyVaultKeyModel - -## NOTES - -## RELATED LINKS - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Add-AzureRmSqlServerTransparentDataEncryptionCertificate.md b/azurermps-6.13.0/AzureRM.Sql/Add-AzureRmSqlServerTransparentDataEncryptionCertificate.md deleted file mode 100644 index cfce149032..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Add-AzureRmSqlServerTransparentDataEncryptionCertificate.md +++ /dev/null @@ -1,248 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/Add-AzureRmSqlServerTransparentDataEncryptionCertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Add-AzureRmSqlServerTransparentDataEncryptionCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Add-AzureRmSqlServerTransparentDataEncryptionCertificate.md ---- - -# Add-AzureRmSqlServerTransparentDataEncryptionCertificate - -## SYNOPSIS -Adds a Transparent Data Encryption Certificate for the given SQL Server instance - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### AddAzureRmSqlServerTransparentDataEncryptionCertificateDefaultParameterSet (Default) -``` -Add-AzureRmSqlServerTransparentDataEncryptionCertificate [-PassThru] [-ResourceGroupName] <String> - [-ServerName] <String> [-PrivateBlob] <SecureString> [-Password] <SecureString> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### AddAzureRmSqlServerTransparentDataEncryptionCertificateInputObjectParameterSet -``` -Add-AzureRmSqlServerTransparentDataEncryptionCertificate [-PassThru] [-SqlServer] <AzureSqlServerModel> - [-PrivateBlob] <SecureString> [-Password] <SecureString> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### AddAzureRmSqlServerTransparentDataEncryptionCertificateResourceIdParameterSet -``` -Add-AzureRmSqlServerTransparentDataEncryptionCertificate [-PassThru] [-SqlServerResourceId] <String> - [-PrivateBlob] <SecureString> [-Password] <SecureString> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate adds a Transparent Data Encryption Certificate for the given SQL Server instance - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> $privateBlob = "MIIJ+QIBAzCCCbUGCSqGSIb3DQEHAaCCCaYEggmiMIIJnjCCBhcGCSqGSIb3Dasdsadasd" -PS C:\> $securePrivateBlob = $privateBlob | ConvertTo-SecureString -AsPlainText -Force -PS C:\> $password = "CertificatePassword" -PS C:\> $securePassword = $password | ConvertTo-SecureString -AsPlainText -Force -PS C:\> Add-AzureRmSqlServerTransparentDataEncryptionCertificate -ResourceGroupName "YourResourceGroupName" -ServerName "YourServerName" -PrivateBlob $securePrivateBlob -Password $securePassword -``` - -Add TDE certificate to a sql server using resource group name and SQL Server name - -### Example 2 -```powershell -PS C:\> $privateBlob = "MIIJ+QIBAzCCCbUGCSqGSIb3DQEHAaCCCaYEggmiMIIJnjCCBhcGCSqGSIb3Dasdsadasd" -PS C:\> $securePrivateBlob = $privateBlob | ConvertTo-SecureString -AsPlainText -Force -PS C:\> $password = "CertificatePassword" -PS C:\> $securePassword = $password | ConvertTo-SecureString -AsPlainText -Force -PS C:\> $server = Get-AzureRmSqlServer -ServerName "YourServerName" -ResourceGroupName "YourResourceGroupName" -PS C:\> Add-AzureRmSqlServerTransparentDataEncryptionCertificate -SqlServerResourceId $server.ResourceId -PrivateBlob $securePrivateBlob -Password $securePassword -``` - -Add TDE certificate to the servers using server resourceId - -### Example 3 -```powershell -PS C:\> $privateBlob = "MIIJ+QIBAzCCCbUGCSqGSIb3DQEHAaCCCaYEggmiMIIJnjCCBhcGCSqGSIb3Dasdsadasd" -PS C:\> $securePrivateBlob = $privateBlob | ConvertTo-SecureString -AsPlainText -Force -PS C:\> $password = "CertificatePassword" -PS C:\> $securePassword = $password | ConvertTo-SecureString -AsPlainText -Force -Get-AzureRmSqlServer | Add-AzureRmSqlServerTransparentDataEncryptionCertificate -ResourceGroupName "YourResourceGroupName" -PrivateBlob $securePrivateBlob -Password $securePassword -``` - -Add TDE certificate to all sql servers in a resource group - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -On Successful execution, returns certificate object that was added. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -The Password for Transparent Data Encryption Certificate - -```yaml -Type: System.Security.SecureString -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateBlob -The Private blob for Transparent Data Encryption Certificate - -```yaml -Type: System.Security.SecureString -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The Resource Group Name - -```yaml -Type: System.String -Parameter Sets: AddAzureRmSqlServerTransparentDataEncryptionCertificateDefaultParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerName -The Server Name - -```yaml -Type: System.String -Parameter Sets: AddAzureRmSqlServerTransparentDataEncryptionCertificateDefaultParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SqlServer -The sql server input object - -```yaml -Type: Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel -Parameter Sets: AddAzureRmSqlServerTransparentDataEncryptionCertificateInputObjectParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SqlServerResourceId -The sql server resource id - -```yaml -Type: System.String -Parameter Sets: AddAzureRmSqlServerTransparentDataEncryptionCertificateResourceIdParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel -Parameters: SqlServer (ByValue) - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/AzureRM.Sql.md b/azurermps-6.13.0/AzureRM.Sql/AzureRM.Sql.md deleted file mode 100644 index f73f1b1d6d..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/AzureRM.Sql.md +++ /dev/null @@ -1,517 +0,0 @@ ---- -Module Name: AzureRM.Sql -Module Guid: 150d9544-6348-4373-806f-10cd0b4de4cb -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql -Help Version: 4.4.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/AzureRM.Sql.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/AzureRM.Sql.md ---- - -# AzureRM.Sql Module -## Description -This topic displays help topics for the Azure SQL Database Cmdlets. - -## AzureRM.Sql Cmdlets -### [Add-AzureRmSqlDatabaseToFailoverGroup](Add-AzureRmSqlDatabaseToFailoverGroup.md) -Adds one or more databases to an Azure SQL Database Failover Group. - -### [Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate](Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate.md) -Adds a Transparent Data Encryption Certificate for the given managed instance - -### [Add-AzureRmSqlServerKeyVaultKey](Add-AzureRmSqlServerKeyVaultKey.md) -Adds a Key Vault key to a SQL server. - -### [Add-AzureRmSqlServerTransparentDataEncryptionCertificate](Add-AzureRmSqlServerTransparentDataEncryptionCertificate.md) -Adds a Transparent Data Encryption Certificate for the given SQL Server instance - -### [Clear-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline](Clear-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline.md) -Clears the vulnerability assessment rule baseline. - -### [Clear-AzureRmSqlDatabaseVulnerabilityAssessmentSettings](Clear-AzureRmSqlDatabaseVulnerabilityAssessmentSettings.md) -Clears the vulnerability assessment settings of a database. - -### [Convert-AzureRmSqlDatabaseVulnerabilityAssessmentScan](Convert-AzureRmSqlDatabaseVulnerabilityAssessmentScan.md) -Converts a vulnerability assessment scan results to Excel format. - -### [Disable-AzureRmSqlServerAdvancedThreatProtection](Disable-AzureRmSqlServerAdvancedThreatProtection.md) -Disables Advanced Threat Protection on a server. - -### [Enable-AzureRmSqlServerAdvancedThreatProtection](Enable-AzureRmSqlServerAdvancedThreatProtection.md) -Enables Advanced Threat Protection on a server. - -### [Get-AzureRmSqlCapability](Get-AzureRmSqlCapability.md) -Gets SQL Database capabilities for the current subscription. - -### [Get-AzureRmSqlDatabase](Get-AzureRmSqlDatabase.md) -Gets one or more databases. - -### [Get-AzureRmSqlDatabaseActivity](Get-AzureRmSqlDatabaseActivity.md) -Gets the status of database operations. - -### [Get-AzureRmSqlDatabaseAdvisor](Get-AzureRmSqlDatabaseAdvisor.md) -Gets one or more Advisors for an Azure SQL Database. - -### [Get-AzureRmSqlDatabaseAuditing](Get-AzureRmSqlDatabaseAuditing.md) -Gets the auditing settings of an Azure SQL database. - -### [Get-AzureRmSqlDatabaseAuditingPolicy](Get-AzureRmSqlDatabaseAuditingPolicy.md) -Gets the auditing policy of a database. - -### [Get-AzureRmSqlDatabaseBackupLongTermRetentionPolicy](Get-AzureRmSqlDatabaseBackupLongTermRetentionPolicy.md) -Gets a database long term retention policy. - -### [Get-AzureRmSqlDatabaseDataMaskingPolicy](Get-AzureRmSqlDatabaseDataMaskingPolicy.md) -Gets the data masking policy for a database. - -### [Get-AzureRmSqlDatabaseDataMaskingRule](Get-AzureRmSqlDatabaseDataMaskingRule.md) -Gets the data masking rules from a database. - -### [Get-AzureRmSqlDatabaseExpanded](Get-AzureRmSqlDatabaseExpanded.md) -Gets a database and its expanded property values. - -### [Get-AzureRmSqlDatabaseFailoverGroup](Get-AzureRmSqlDatabaseFailoverGroup.md) -Gets or lists Azure SQL Database Failover Groups. - -### [Get-AzureRmSqlDatabaseGeoBackup](Get-AzureRmSqlDatabaseGeoBackup.md) -Gets a geo-redundant backup of a database. - -### [Get-AzureRmSqlDatabaseGeoBackupPolicy](Get-AzureRmSqlDatabaseGeoBackupPolicy.md) -Gets a database geo backup policy. - -### [Get-AzureRmSqlDatabaseImportExportStatus](Get-AzureRmSqlDatabaseImportExportStatus.md) -Gets the details of an import or export of an Azure SQL Database. - -### [Get-AzureRmSqlDatabaseIndexRecommendations](Get-AzureRmSqlDatabaseIndexRecommendations.md) -Gets the recommended index operations for a server or database. - -### [Get-AzureRmSqlDatabaseLongTermRetentionBackup](Get-AzureRmSqlDatabaseLongTermRetentionBackup.md) -Gets one or more long term retention backups. - -### [Get-AzureRmSqlDatabaseRecommendedAction](Get-AzureRmSqlDatabaseRecommendedAction.md) -Gets one or more recommended actions for an Azure SQL Database Advisor. - -### [Get-AzureRmSqlDatabaseReplicationLink](Get-AzureRmSqlDatabaseReplicationLink.md) -Gets the geo-replication links between an Azure SQL Database and a resource group or SQL Server. - -### [Get-AzureRmSqlDatabaseRestorePoints](Get-AzureRmSqlDatabaseRestorePoints.md) -Retrieves the distinct restore points from which a SQL Data Warehouse can be restored. - -### [Get-AzureRmSqlDatabaseSecureConnectionPolicy](Get-AzureRmSqlDatabaseSecureConnectionPolicy.md) -Gets the secure connection policy for a database. - -### [Get-AzureRmSqlDatabaseThreatDetectionPolicy](Get-AzureRmSqlDatabaseThreatDetectionPolicy.md) -Gets the threat detection policy for a database. - -### [Get-AzureRmSqlDatabaseTransparentDataEncryption](Get-AzureRmSqlDatabaseTransparentDataEncryption.md) -Gets the TDE state for a database. - -### [Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity](Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity.md) -Gets the progress of a TDE scan of a database. - -### [Get-AzureRmSqlDatabaseUpgradeHint](Get-AzureRmSqlDatabaseUpgradeHint.md) -Gets pricing tier hints for a database. - -### [Get-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline](Get-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline.md) -Gets the vulnerability assessment rule baseline. - -### [Get-AzureRmSqlDatabaseVulnerabilityAssessmentScanRecord](Get-AzureRmSqlDatabaseVulnerabilityAssessmentScanRecord.md) -Gets all vulnerability assessment scan record(s) associated with a given database. - -### [Get-AzureRmSqlDatabaseVulnerabilityAssessmentSettings](Get-AzureRmSqlDatabaseVulnerabilityAssessmentSettings.md) -Gets the vulnerability assessment settings of a database. - -### [Get-AzureRmSqlDeletedDatabaseBackup](Get-AzureRmSqlDeletedDatabaseBackup.md) -Gets a deleted database that you can restore. - -### [Get-AzureRmSqlElasticPool](Get-AzureRmSqlElasticPool.md) -Gets elastic pools and their property values in an Azure SQL Database. - -### [Get-AzureRmSqlElasticPoolActivity](Get-AzureRmSqlElasticPoolActivity.md) -Gets the status of operations on an elastic pool. - -### [Get-AzureRmSqlElasticPoolAdvisor](Get-AzureRmSqlElasticPoolAdvisor.md) -Gets one or more Advisors for an Azure SQL Elastic Pool. - -### [Get-AzureRmSqlElasticPoolDatabase](Get-AzureRmSqlElasticPoolDatabase.md) -Gets elastic databases in an elastic pool and their property values. - -### [Get-AzureRmSqlElasticPoolRecommendation](Get-AzureRmSqlElasticPoolRecommendation.md) -Gets elastic pool recommendations. - -### [Get-AzureRmSqlElasticPoolRecommendedAction](Get-AzureRmSqlElasticPoolRecommendedAction.md) -Gets one or more recommended actions for an Azure SQL Elastic Pool Advisor. - -### [Get-AzureRmSqlInstance](Get-AzureRmSqlInstance.md) -Returns information about Azure SQL Managed Database Instance. - -### [Get-AzureRmSqlInstanceDatabase](Get-AzureRmSqlInstanceDatabase.md) -Returns information about Azure SQL Managed Instance database. - -### [Get-AzureRmSqlServer](Get-AzureRmSqlServer.md) -Returns information about SQL Database servers. - -### [Get-AzureRmSqlServerActiveDirectoryAdministrator](Get-AzureRmSqlServerActiveDirectoryAdministrator.md) -Gets information about a Microsoft Entra administrator for SQL Server. - -### [Get-AzureRmSqlServerAdvancedThreatProtectionPolicy](Get-AzureRmSqlServerAdvancedThreatProtectionPolicy.md) -Gets Advanced Threat Protection policy of a server. - -### [Get-AzureRmSqlServerAdvisor](Get-AzureRmSqlServerAdvisor.md) -Gets one or more Advisors for an Azure SQL Server. - -### [Get-AzureRmSqlServerAuditing](Get-AzureRmSqlServerAuditing.md) -Gets the auditing settings of an Azure SQL server. - -### [Get-AzureRmSqlServerAuditingPolicy](Get-AzureRmSqlServerAuditingPolicy.md) -Gets the auditing policy of a SQL server. - -### [Get-AzureRmSqlServerBackupLongTermRetentionVault](Get-AzureRmSqlServerBackupLongTermRetentionVault.md) -Gets a server long term retention vault. - -### [Get-AzureRmSqlServerCommunicationLink](Get-AzureRmSqlServerCommunicationLink.md) -Gets communication links for elastic database transactions between database servers. - -### [Get-AzureRmSqlServerDisasterRecoveryConfiguration](Get-AzureRmSqlServerDisasterRecoveryConfiguration.md) -Gets a database server system recovery configuration. - -### [Get-AzureRmSqlServerDisasterRecoveryConfigurationActivity](Get-AzureRmSqlServerDisasterRecoveryConfigurationActivity.md) -Gets activity for a database server system recovery configuration. - -### [Get-AzureRmSqlServerDnsAlias](Get-AzureRmSqlServerDnsAlias.md) -Gets or lists Azure SQL Server DNS Alias. - -### [Get-AzureRmSqlServerFirewallRule](Get-AzureRmSqlServerFirewallRule.md) -Gets firewall rules for a SQL Database server. - -### [Get-AzureRmSqlServerKeyVaultKey](Get-AzureRmSqlServerKeyVaultKey.md) -Gets a SQL server's Key Vault keys. - -### [Get-AzureRmSqlServerRecommendedAction](Get-AzureRmSqlServerRecommendedAction.md) -Gets one or more recommended actions for an Azure SQL Server Advisor. - -### [Get-AzureRmSqlServerServiceObjective](Get-AzureRmSqlServerServiceObjective.md) -Gets service objectives for an Azure SQL Database server. - -### [Get-AzureRmSqlServerThreatDetectionPolicy](Get-AzureRmSqlServerThreatDetectionPolicy.md) -Gets the threat detection policy for a server. - -### [Get-AzureRmSqlServerTransparentDataEncryptionProtector](Get-AzureRmSqlServerTransparentDataEncryptionProtector.md) -Gets the Transparent Data Encryption (TDE) protector - -### [Get-AzureRmSqlServerUpgrade](Get-AzureRmSqlServerUpgrade.md) -Gets the status of an Azure SQL Database server upgrade. - -### [Get-AzureRmSqlServerUpgradeHint](Get-AzureRmSqlServerUpgradeHint.md) -Gets pricing tier hints for upgrading an Azure SQL Database server. - -### [Get-AzureRmSqlServerVirtualNetworkRule](Get-AzureRmSqlServerVirtualNetworkRule.md) -Gets or lists Azure SQL Server Virtual Network Rule. - -### [Get-AzureRmSqlSyncAgent](Get-AzureRmSqlSyncAgent.md) -Returns information about Azure SQL Sync Agents. - -### [Get-AzureRmSqlSyncAgentLinkedDatabase](Get-AzureRmSqlSyncAgentLinkedDatabase.md) -Returns information about SQL Server databases linked by a sync agent. - -### [Get-AzureRmSqlSyncGroup](Get-AzureRmSqlSyncGroup.md) -Returns information about Azure SQL Database Sync Groups. - -### [Get-AzureRmSqlSyncGroupLog](Get-AzureRmSqlSyncGroupLog.md) -Returns the logs of an Azure SQL Database Sync Group. - -### [Get-AzureRmSqlSyncMember](Get-AzureRmSqlSyncMember.md) -Returns information about Azure SQL Database Sync Members. - -### [Get-AzureRmSqlSyncSchema](Get-AzureRmSqlSyncSchema.md) -Returns information about the sync schema of a member database or a hub database. - -### [New-AzureRmSqlDatabase](New-AzureRmSqlDatabase.md) -Creates a database or an elastic database. - -### [New-AzureRmSqlDatabaseCopy](New-AzureRmSqlDatabaseCopy.md) -Creates a copy of a SQL Database that uses the snapshot at the current time. - -### [New-AzureRmSqlDatabaseDataMaskingRule](New-AzureRmSqlDatabaseDataMaskingRule.md) -Creates a data masking rule for a database. - -### [New-AzureRmSqlDatabaseExport](New-AzureRmSqlDatabaseExport.md) -Exports an Azure SQL Database as a .bacpac file to a storage account. - -### [New-AzureRmSqlDatabaseFailoverGroup](New-AzureRmSqlDatabaseFailoverGroup.md) -This command creates a new Azure SQL Database Failover Group. - -### [New-AzureRmSqlDatabaseImport](New-AzureRmSqlDatabaseImport.md) -Imports a .bacpac file and create a new database on the server. - -### [New-AzureRmSqlDatabaseRestorePoint](New-AzureRmSqlDatabaseRestorePoint.md) -Creates a new restore point from which a SQL Database can be restored. - -### [New-AzureRmSqlDatabaseSecondary](New-AzureRmSqlDatabaseSecondary.md) -Creates a secondary database for an existing database and starts data replication. - -### [New-AzureRmSqlElasticPool](New-AzureRmSqlElasticPool.md) -Creates an elastic database pool for a SQL Database. - -### [New-AzureRmSqlInstance](New-AzureRmSqlInstance.md) -Creates an Azure SQL Database Managed Instance. - -### [New-AzureRmSqlInstanceDatabase](New-AzureRmSqlInstanceDatabase.md) -Creates an Azure SQL Managed Instance database. - -### [New-AzureRmSqlServer](New-AzureRmSqlServer.md) -Creates a SQL Database server. - -### [New-AzureRmSqlServerCommunicationLink](New-AzureRmSqlServerCommunicationLink.md) -Creates a communication link for elastic database transactions between two SQL Database servers. - -### [New-AzureRmSqlServerDisasterRecoveryConfiguration](New-AzureRmSqlServerDisasterRecoveryConfiguration.md) -Creates a database server system recovery configuration. - -### [New-AzureRmSqlServerDnsAlias](New-AzureRmSqlServerDnsAlias.md) -This command creates a new Azure SQL Server DNS Alias. - -### [New-AzureRmSqlServerFirewallRule](New-AzureRmSqlServerFirewallRule.md) -Creates a firewall rule for a SQL Database server. - -### [New-AzureRmSqlServerVirtualNetworkRule](New-AzureRmSqlServerVirtualNetworkRule.md) -Creates an Azure SQL Server Virtual Network Rule. - -### [New-AzureRmSqlSyncAgent](New-AzureRmSqlSyncAgent.md) -Creates an Azure SQL Sync Agent. - -### [New-AzureRmSqlSyncAgentKey](New-AzureRmSqlSyncAgentKey.md) -Creates an Azure SQL Sync Agent Key. - -### [New-AzureRmSqlSyncGroup](New-AzureRmSqlSyncGroup.md) -Creates an Azure SQL Database Sync Group. - -### [New-AzureRmSqlSyncMember](New-AzureRmSqlSyncMember.md) -Creates an Azure SQL Database Sync Member. - -### [Remove-AzureRmSqlDatabase](Remove-AzureRmSqlDatabase.md) -Removes an Azure SQL database. - -### [Remove-AzureRmSqlDatabaseAuditing](Remove-AzureRmSqlDatabaseAuditing.md) -Removes the auditing of a database. - -### [Remove-AzureRmSqlDatabaseDataMaskingRule](Remove-AzureRmSqlDatabaseDataMaskingRule.md) -Removes a data masking rule from a database. - -### [Remove-AzureRmSqlDatabaseFailoverGroup](Remove-AzureRmSqlDatabaseFailoverGroup.md) -Removes an Azure SQL Database Failover Group. - -### [Remove-AzureRmSqlDatabaseFromFailoverGroup](Remove-AzureRmSqlDatabaseFromFailoverGroup.md) -Removes one or more databases from an Azure SQL Database Failover Group. - -### [Remove-AzureRmSqlDatabaseLongTermRetentionBackup](Remove-AzureRmSqlDatabaseLongTermRetentionBackup.md) -Deletes a long term retention backup. - -### [Remove-AzureRmSqlDatabaseRestorePoint](Remove-AzureRmSqlDatabaseRestorePoint.md) -Removes given restore point from a SQL Database. - -### [Remove-AzureRmSqlDatabaseSecondary](Remove-AzureRmSqlDatabaseSecondary.md) -Terminates data replication between a SQL Database and the specified secondary database. - -### [Remove-AzureRmSqlDatabaseThreatDetectionPolicy](Remove-AzureRmSqlDatabaseThreatDetectionPolicy.md) -Removes the threat detection policy from a database. - -### [Remove-AzureRmSqlElasticPool](Remove-AzureRmSqlElasticPool.md) -Deletes an elastic database pool. - -### [Remove-AzureRmSqlInstance](Remove-AzureRmSqlInstance.md) -Removes an Azure SQL Managed Database Instance. - -### [Remove-AzureRmSqlInstanceDatabase](Remove-AzureRmSqlInstanceDatabase.md) -Removes an Azure SQL Managed Instance database. - -### [Remove-AzureRmSqlServer](Remove-AzureRmSqlServer.md) -Removes an Azure SQL Database server. - -### [Remove-AzureRmSqlServerActiveDirectoryAdministrator](Remove-AzureRmSqlServerActiveDirectoryAdministrator.md) -Removes a Microsoft Entra administrator for SQL Server. - -### [Remove-AzureRmSqlServerAuditing](Remove-AzureRmSqlServerAuditing.md) -Removes the auditing of a SQL server. - -### [Remove-AzureRmSqlServerCommunicationLink](Remove-AzureRmSqlServerCommunicationLink.md) -Deletes a communication link for elastic database transactions between two servers. - -### [Remove-AzureRmSqlServerDisasterRecoveryConfiguration](Remove-AzureRmSqlServerDisasterRecoveryConfiguration.md) -Removes a SQL database server system recovery configuration. - -### [Remove-AzureRmSqlServerDnsAlias](Remove-AzureRmSqlServerDnsAlias.md) -Removes Azure SQL Server DNS Alias. - -### [Remove-AzureRmSqlServerFirewallRule](Remove-AzureRmSqlServerFirewallRule.md) -Deletes a firewall rule from a SQL Database server. - -### [Remove-AzureRmSqlServerKeyVaultKey](Remove-AzureRmSqlServerKeyVaultKey.md) -Removes a Key Vault key from a SQL server. - -### [Remove-AzureRmSqlServerThreatDetectionPolicy](Remove-AzureRmSqlServerThreatDetectionPolicy.md) -Removes the threat detection policy from a server. - -### [Remove-AzureRmSqlServerVirtualNetworkRule](Remove-AzureRmSqlServerVirtualNetworkRule.md) -Deletes an Azure SQL Server Virtual Network Rule. - -### [Remove-AzureRmSqlSyncAgent](Remove-AzureRmSqlSyncAgent.md) -Removes an Azure SQL Sync Agent. - -### [Remove-AzureRmSqlSyncGroup](Remove-AzureRmSqlSyncGroup.md) -Removes an Azure SQL Database Sync Group. - -### [Remove-AzureRmSqlSyncMember](Remove-AzureRmSqlSyncMember.md) -Removes an Azure SQL Database Sync Member. - -### [Restore-AzureRmSqlDatabase](Restore-AzureRmSqlDatabase.md) -Restores a SQL database. - -### [Restore-AzureRmSqlInstanceDatabase](Restore-AzureRmSqlInstanceDatabase.md) -Restores an Azure SQL Managed Instance database. - -### [Resume-AzureRmSqlDatabase](Resume-AzureRmSqlDatabase.md) -Resumes a SQL Data Warehouse database. - -### [Set-AzureRmSqlDatabase](Set-AzureRmSqlDatabase.md) -Sets properties for a database, or moves an existing database into an elastic pool. - -### [Set-AzureRmSqlDatabaseAdvisorAutoExecuteStatus](Set-AzureRmSqlDatabaseAdvisorAutoExecuteStatus.md) -Modifies auto execute status of an Azure SQL Database Advisor. - -### [Set-AzureRmSqlDatabaseAuditing](Set-AzureRmSqlDatabaseAuditing.md) -Changes the auditing settings for an Azure SQL database. - -### [Set-AzureRmSqlDatabaseAuditingPolicy](Set-AzureRmSqlDatabaseAuditingPolicy.md) -Sets the auditing policy for a database. - -### [Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy](Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy.md) -Sets a server long term retention policy. - -### [Set-AzureRmSqlDatabaseDataMaskingPolicy](Set-AzureRmSqlDatabaseDataMaskingPolicy.md) -Sets data masking for a database. - -### [Set-AzureRmSqlDatabaseDataMaskingRule](Set-AzureRmSqlDatabaseDataMaskingRule.md) -Sets the properties of a data masking rule for a database. - -### [Set-AzureRmSqlDatabaseFailoverGroup](Set-AzureRmSqlDatabaseFailoverGroup.md) -Modifies the configuration of an Azure SQL Database Failover Group. - -### [Set-AzureRmSqlDatabaseGeoBackupPolicy](Set-AzureRmSqlDatabaseGeoBackupPolicy.md) -Sets a database geo backup policy. - -### [Set-AzureRmSqlDatabaseRecommendedActionState](Set-AzureRmSqlDatabaseRecommendedActionState.md) -Updates the state of an Azure SQL Database recommended action. - -### [Set-AzureRmSqlDatabaseSecondary](Set-AzureRmSqlDatabaseSecondary.md) -Switches a secondary database to be primary in order to initiate failover. - -### [Set-AzureRmSqlDatabaseThreatDetectionPolicy](Set-AzureRmSqlDatabaseThreatDetectionPolicy.md) -Sets a threat detection policy on a database. - -### [Set-AzureRmSqlDatabaseTransparentDataEncryption](Set-AzureRmSqlDatabaseTransparentDataEncryption.md) -Modifies TDE property for a database. - -### [Set-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline](Set-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline.md) -Sets the vulnerability assessment rule baseline. - -### [Set-AzureRmSqlElasticPool](Set-AzureRmSqlElasticPool.md) -Modifies properties of an elastic database pool in Azure SQL Database. - -### [Set-AzureRmSqlElasticPoolAdvisorAutoExecuteStatus](Set-AzureRmSqlElasticPoolAdvisorAutoExecuteStatus.md) -Updates auto execute status of an Azure SQL Elastic Pool Advisor. - -### [Set-AzureRmSqlElasticPoolRecommendedActionState](Set-AzureRmSqlElasticPoolRecommendedActionState.md) -Updates the state of an Azure SQL Elastic Pool recommended action. - -### [Set-AzureRmSqlInstance](Set-AzureRmSqlInstance.md) -Sets properties for an Azure SQL Database Managed Instance. - -### [Set-AzureRmSqlServer](Set-AzureRmSqlServer.md) -Modifies properties of a SQL Database server. - -### [Set-AzureRmSqlServerActiveDirectoryAdministrator](Set-AzureRmSqlServerActiveDirectoryAdministrator.md) -Provisions a Microsoft Entra administrator for SQL Server. - -### [Set-AzureRmSqlServerAdvisorAutoExecuteStatus](Set-AzureRmSqlServerAdvisorAutoExecuteStatus.md) -Updates the auto execute status of an Azure SQL Server Advisor. - -### [Set-AzureRmSqlServerAuditing](Set-AzureRmSqlServerAuditing.md) -Changes the auditing settings of an Azure SQL server. - -### [Set-AzureRmSqlServerAuditingPolicy](Set-AzureRmSqlServerAuditingPolicy.md) -Changes the auditing policy of a SQL Database server. - -### [Set-AzureRmSqlServerBackupLongTermRetentionVault](Set-AzureRmSqlServerBackupLongTermRetentionVault.md) -Sets a server long term retention vault. - -### [Set-AzureRmSqlServerDisasterRecoveryConfiguration](Set-AzureRmSqlServerDisasterRecoveryConfiguration.md) -Modifies a database server recovery configuration. - -### [Set-AzureRmSqlServerDnsAlias](Set-AzureRmSqlServerDnsAlias.md) -Modifies the server to which Azure SQL Server DNS Alias is pointing - -### [Set-AzureRmSqlServerFirewallRule](Set-AzureRmSqlServerFirewallRule.md) -Modifies a firewall rule in Azure SQL Database server. - -### [Set-AzureRmSqlServerRecommendedActionState](Set-AzureRmSqlServerRecommendedActionState.md) -Updates the state of an Azure SQL Server recommended action. - -### [Set-AzureRmSqlServerThreatDetectionPolicy](Set-AzureRmSqlServerThreatDetectionPolicy.md) -Sets a threat detection policy on a server. - -### [Set-AzureRmSqlServerTransparentDataEncryptionProtector](Set-AzureRmSqlServerTransparentDataEncryptionProtector.md) -Sets the Transparent Data Encryption (TDE) protector for a SQL server. - -### [Set-AzureRmSqlServerVirtualNetworkRule](Set-AzureRmSqlServerVirtualNetworkRule.md) -Modifies the configuration of an Azure SQL Server Virtual Network Rule. - -### [Start-AzureRmSqlDatabaseExecuteIndexRecommendation](Start-AzureRmSqlDatabaseExecuteIndexRecommendation.md) -Starts the workflow that runs a recommended index operation. - -### [Start-AzureRmSqlDatabaseVulnerabilityAssessmentScan](Start-AzureRmSqlDatabaseVulnerabilityAssessmentScan.md) -Starts a vulnerability assessment scan. - -### [Start-AzureRmSqlServerUpgrade](Start-AzureRmSqlServerUpgrade.md) -Starts the upgrade of a SQL Database server. - -### [Start-AzureRmSqlSyncGroupSync](Start-AzureRmSqlSyncGroupSync.md) -Starts a sync group synchronization. - -### [Stop-AzureRmSqlDatabaseActivity](Stop-AzureRmSqlDatabaseActivity.md) -Cancels the asynchronous updates operation on the database. - -### [Stop-AzureRmSqlDatabaseExecuteIndexRecommendation](Stop-AzureRmSqlDatabaseExecuteIndexRecommendation.md) -Stops the workflow that runs a recommended index operation. - -### [Stop-AzureRmSqlElasticPoolActivity](Stop-AzureRmSqlElasticPoolActivity.md) -Cancels the asynchronous update operation on an elastic pool. - -### [Stop-AzureRmSqlServerUpgrade](Stop-AzureRmSqlServerUpgrade.md) -Stops the upgrade of a SQL Database server. - -### [Stop-AzureRmSqlSyncGroupSync](Stop-AzureRmSqlSyncGroupSync.md) -Stops a sync group synchronization. - -### [Suspend-AzureRmSqlDatabase](Suspend-AzureRmSqlDatabase.md) -Suspends a SQL Data Warehouse database. - -### [Switch-AzureRmSqlDatabaseFailoverGroup](Switch-AzureRmSqlDatabaseFailoverGroup.md) -Executes a failover of an Azure SQL Database Failover Group. - -### [Update-AzureRmSqlDatabaseVulnerabilityAssessmentSettings](Update-AzureRmSqlDatabaseVulnerabilityAssessmentSettings.md) -Updates the vulnerability assessment settings of a database. - -### [Update-AzureRmSqlSyncGroup](Update-AzureRmSqlSyncGroup.md) -Updates an Azure SQL Database Sync Group. - -### [Update-AzureRmSqlSyncMember](Update-AzureRmSqlSyncMember.md) -Updates an Azure SQL Database Sync Member. - -### [Update-AzureRmSqlSyncSchema](Update-AzureRmSqlSyncSchema.md) -Update the sync schema for a sync member database or a sync hub database. -It will get the latest database schema from the real database and then use it refresh the schema cached by Sync metadata database. -If "SyncMemberName" is specified, it will refresh the member database schema; if not, it will refresh the hub database schema. - -### [Use-AzureRmSqlServerAuditingPolicy](Use-AzureRmSqlServerAuditingPolicy.md) -Specifies that a database uses the auditing policy of its host server. diff --git a/azurermps-6.13.0/AzureRM.Sql/Clear-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline.md b/azurermps-6.13.0/AzureRM.Sql/Clear-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline.md deleted file mode 100644 index 229682f695..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Clear-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/clear-azurermsqldatabasevulnerabilityassessmentrulebaseline -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Clear-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Clear-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline.md ---- - -# Clear-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline - -## SYNOPSIS -Clears the vulnerability assessment rule baseline. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Clear-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline [-InputObject <AzureSqlDatabaseModel>] - -RuleId <String> [-RuleAppliesToMaster] [-ServerName] <String> [-DatabaseName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Clear-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline** cmdlet removes the vulnerability assessment rule baseline. -Note that you need to run *Enable-AzureRmSqlServerAdvancedThreatProtection* and *Set-AzureRmSqlDatabaseVulnerabilityAssessmentSettings* cmdlet as a prerequisite for using this cmdlets. - -## EXAMPLES - -### Example 1 - Clears the vulnerability assessment rule baseline -```powershell -PS C:\> Clear-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline ` - -ResourceGroupName "ResourceGroup01" ` - -ServerName "Server01" ` - -DatabaseName "Database01" ` - -RuleId "VA2108" -``` - -### Example 2 - Clears the vulnerability assessment rule baseline from a database object -```powershell -PS C:\> Get-AzureRmSqlDatabase ` - -ResourceGroupName "ResourceGroup01" ` - -ServerName "Server01" ` - -DatabaseName "Database01" ` - | Clear-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline ` - -RuleId "VA2108" ` - -AppliesToMaster -``` - -## PARAMETERS - -### -DatabaseName -SQL Database name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The database object to clear Vulnerability Assessment rule baseline for - -```yaml -Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RuleAppliesToMaster -Specifies whether the baseline results should apply on a server level rule identified by the RuleId - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RuleId -The rule ID which identifies the rule to set the baseline results to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -SQL Database server name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel -Parameters: InputObject (ByValue) - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.DatabaseVulnerabilityAssessmentRuleBaselineModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Clear-AzureRmSqlDatabaseVulnerabilityAssessmentSettings.md b/azurermps-6.13.0/AzureRM.Sql/Clear-AzureRmSqlDatabaseVulnerabilityAssessmentSettings.md deleted file mode 100644 index ef3a296be2..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Clear-AzureRmSqlDatabaseVulnerabilityAssessmentSettings.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/clear-azurermsqldatabasevulnerabilityassessmentsettings -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Clear-AzureRmSqlDatabaseVulnerabilityAssessmentSettings.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Clear-AzureRmSqlDatabaseVulnerabilityAssessmentSettings.md ---- - -# Clear-AzureRmSqlDatabaseVulnerabilityAssessmentSettings - -## SYNOPSIS -Clears the vulnerability assessment settings of a database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Clear-AzureRmSqlDatabaseVulnerabilityAssessmentSettings [-InputObject <AzureSqlDatabaseModel>] - [-ServerName] <String> [-DatabaseName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Clear-AzureRmSqlDatabaseVulnerabilityAssessmentSettings** cmdlet removes the vulnerability assessment settings of an Azure SQL Database. -Note that you need to run *Enable-AzureRmSqlServerAdvancedThreatProtection* cmdlet as a prerequisite for using this cmdlet. - -## EXAMPLES - -### Example 1 - Clear the vulnerability assessment settings of an Azure SQL database -```powershell -PS C:\> Clear-AzureRmSqlDatabaseVulnerabilityAssessmentSettings ` - -ResourceGroupName "ResourceGroup01" ` - -ServerName "Server01" ` - -DatabaseName "Database01" -``` - -### Example 2 - Clear the vulnerability assessment settings from a database object -```powershell -PS C:\> Get-AzureRmSqlDatabase ` - -ResourceGroupName "ResourceGroup01" ` - -ServerName "Server01" ` - -DatabaseName "Database01" ` - | Clear-AzureRmSqlDatabaseVulnerabilityAssessmentSettings -``` - -## PARAMETERS - -### -DatabaseName -SQL Database name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The database object to clear Vulnerability Assessment settings for - -```yaml -Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -SQL Database server name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.DatabaseVulnerabilityAssessmentSettingsModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Convert-AzureRmSqlDatabaseVulnerabilityAssessmentScan.md b/azurermps-6.13.0/AzureRM.Sql/Convert-AzureRmSqlDatabaseVulnerabilityAssessmentScan.md deleted file mode 100644 index 7afb7a854b..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Convert-AzureRmSqlDatabaseVulnerabilityAssessmentScan.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/convert-azurermsqldatabasevulnerabilityassessmentscan -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Convert-AzureRmSqlDatabaseVulnerabilityAssessmentScan.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Convert-AzureRmSqlDatabaseVulnerabilityAssessmentScan.md ---- - -# Convert-AzureRmSqlDatabaseVulnerabilityAssessmentScan - -## SYNOPSIS -Converts a vulnerability assessment scan results to Excel format. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Convert-AzureRmSqlDatabaseVulnerabilityAssessmentScan - [-InputObject <DatabaseVulnerabilityAssessmentScanRecordModel>] [-ScanId <String>] [-ServerName] <String> - [-DatabaseName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Convert-AzureRmSqlDatabaseVulnerabilityAssessmentScan** cmdlet converts a scan results, that resides in the customer storage, identified by the ScanId parameter to an Excel format placed in the storage defined by the Set-AzureRmSqlDatabaseVulnerabilityAssessmentSettings cmdlet. -Note that you need to run *Enable-AzureRmSqlServerAdvancedThreatProtection* and *Set-AzureRmSqlDatabaseVulnerabilityAssessmentSettings* cmdlet as a prerequisite for using this cmdlets. - -## EXAMPLES - -### Example 1 - Converts a vulnerability assessment scan results annd save them to local disk -```powershell -PS C:\> Set-AzureRmSqlDatabaseVulnerabilityAssessmentSettings ` - -ResourceGroupName "ResourceGroup01" ` - -ServerName "Server01" ` - -DatabaseName "Database01" ` - -StorageAccountName "mystorage" - -PS C:\> Start-AzureRmSqlDatabaseVulnerabilityAssessmentScan ` - -ResourceGroupName "ResourceGroup01" ` - -ServerName "Server01" ` - -DatabaseName "Database01" ` - -ScanId "myScan" - -PS C:\> $convert_scan_results = Convert-AzureRmSqlDatabaseVulnerabilityAssessmentScan` - -ResourceGroupName "ResourceGroup01" ` - -ServerName "Server01" ` - -DatabaseName "Database01" ` - -ScanId "myScan" -ResourceGroupName : "ResourceGroup01" -ServerName : "Server01" -DatabaseName : "Database01" -ScanId : "myScan" -ExportedReportLocation : "https://myaccount.blob.core.windows.net/vulnerabilityAssessment/Server01/Database01/scan_myScan.xlsx" - -PS C:\> $connection_string_to_storage_account = "DefaultEndpointsProtocol=https;AccountName=myaccount...." -PS C:\> $converted_scan_results_download_local_folder = "C:\Downloads\" -PS C:\> $storage_account_context = New-AzureStorageContext -ConnectionString $connection_string_to_storage_account -PS C:\> $convert_scan_result_splitted = $convert_scan_results.ExportedReportLocation -split "/" -PS C:\> $container_name = $convert_scan_result_splitted[3] -PS C:\> Get-AzureStorageBlobContent -Blob ($a -split $container_name + '/')[1] ` - -Container $container_name ` - -Destination $converted_scan_results_download_local_folder ` - -Context $storage_account_context -``` - -### Example 2 - Converts a vulnerability assessment scan results from a scan record -```powershell -PS C:\> Get-AzureRmSqlDatabaseVulnerabilityAssessmentScanRecord ` - -ResourceGroupName "ResourceGroup01" ` - -ServerName "Server01" ` - -DatabaseName "Database01" ` - -ScanId "myScan" ` - | Convert-AzureRmSqlDatabaseVulnerabilityAssessmentScan - -ResourceGroupName : "ResourceGroup01" -ServerName : "Server01" -DatabaseName : "Database01" -ScanId : "myScan" -ExportedReportLocation : "https://myaccount.blob.core.windows.net/vulnerabilityAssessment/Server01/Database01 - /scan_myScan.xlsx" -``` - -## PARAMETERS - -### -DatabaseName -SQL Database name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The scan record object to use in order to convert a Vulnerability Assessment scan - -```yaml -Type: Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.DatabaseVulnerabilityAssessmentScanRecordModel -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScanId -Specifies the scan ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -SQL Database server name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.DatabaseVulnerabilityAssessmentScanRecordModel -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.DatabaseVulnerabilityAssessmentScanExportModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Disable-AzureRmSqlServerAdvancedThreatProtection.md b/azurermps-6.13.0/AzureRM.Sql/Disable-AzureRmSqlServerAdvancedThreatProtection.md deleted file mode 100644 index 9ebf3cfeef..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Disable-AzureRmSqlServerAdvancedThreatProtection.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/disable-azurermsqlserveradvancedthreatprotection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Disable-AzureRmSqlServerAdvancedThreatProtection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Disable-AzureRmSqlServerAdvancedThreatProtection.md ---- - -# Disable-AzureRmSqlServerAdvancedThreatProtection - -## SYNOPSIS -Disables Advanced Threat Protection on a server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Disable-AzureRmSqlServerAdvancedThreatProtection [-InputObject <AzureSqlServerModel>] -ServerName <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Disable-AzureRmSqlServerAdvancedThreatProtection** cmdlet disables Advanced Threat Protection on a server. - -## EXAMPLES - -### Example 1 - Disable server Advanced Threat Protection -```powershell -PS C:\> Disable-AzureRmSqlServerAdvancedThreatProtection ` - -ResourceGroupName "ResourceGroup01" ` - -ServerName "Server01" - -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -IsEnabled : False -``` - -### Example 2 - Disable server Advanced Threat Protection from server resource -```powershell -PS C:\> Get-AzureRmSqlServer ` - -ResourceGroupName "ResourceGroup01" ` - -ServerName "Server01" ` - | Disable-AzureRmSqlServerAdvancedThreatProtection - -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -IsEnabled : False -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The server object to use with Advanced Threat Protection policy operation - -```yaml -Type: Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -SQL Database server name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.AdvancedThreatProtection.Model.ServerAdvancedThreatProtectionPolicyModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Enable-AzureRmSqlServerAdvancedThreatProtection.md b/azurermps-6.13.0/AzureRM.Sql/Enable-AzureRmSqlServerAdvancedThreatProtection.md deleted file mode 100644 index 82483e0e0c..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Enable-AzureRmSqlServerAdvancedThreatProtection.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/enable-azurermsqlserveradvancedthreatprotection -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Enable-AzureRmSqlServerAdvancedThreatProtection.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Enable-AzureRmSqlServerAdvancedThreatProtection.md ---- - -# Enable-AzureRmSqlServerAdvancedThreatProtection - -## SYNOPSIS -Enables Advanced Threat Protection on a server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Enable-AzureRmSqlServerAdvancedThreatProtection [-InputObject <AzureSqlServerModel>] -ServerName <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Enable-AzureRmSqlServerAdvancedThreatProtection** cmdlet enables Advanced Threat Protection on a server. - -## EXAMPLES - -### Example 1 - Enable server Advanced Threat Protection -```powershell -PS C:\> Enable-AzureRmSqlServerAdvancedThreatProtection ` - -ResourceGroupName "ResourceGroup01" ` - -ServerName "Server01" - -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -IsEnabled : True -``` - -### Example 2 - Enable server Advanced Threat Protection from server resource -```powershell -PS C:\> Get-AzureRmSqlServer ` - -ResourceGroupName "ResourceGroup01" ` - -ServerName "Server01" ` - | Enable-AzureRmSqlServerAdvancedThreatProtection - -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -IsEnabled : True -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The server object to use with Advanced Threat Protection policy operation - -```yaml -Type: Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -SQL Database server name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.AdvancedThreatProtection.Model.ServerAdvancedThreatProtectionPolicyModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRMSqlDatabaseGeoBackup.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRMSqlDatabaseGeoBackup.md deleted file mode 100644 index 33720d28df..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRMSqlDatabaseGeoBackup.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 256AA6F4-D856-4713-A0AC-0DA1A145AA5C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqldatabasegeobackup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRMSqlDatabaseGeoBackup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRMSqlDatabaseGeoBackup.md ---- - -# Get-AzureRmSqlDatabaseGeoBackup - -## SYNOPSIS -Gets a geo-redundant backup of a database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlDatabaseGeoBackup [-ServerName] <String> [[-DatabaseName] <String>] [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRMSqlDatabaseGeoBackup** cmdlet gets a specified geo-redundant backup of a SQL database or all available geo-redundant backups on a specified server. -A geo-redundant backup is a restorable resource using data files from a separate geographic location. -You can use Geo-Restore to restore a geo-redundant backup in the event of a regional outage to recover your database to a new region. -This cmdlet is also supported by the SQL Server Stretch Database service on Azure. - -## EXAMPLES - -### Example 1: Get all geo-redundant backups on a server -``` -PS C:\>Get-AzureRMSqlDatabaseGeoBackup -ResourceGroupName "ContosoResourceGroup" -ServerName "ContosoServer" -``` - -This command gets all available geo-redundant backups on a specified server. - -### Example 2: Get a specified geo-redundant backup -``` -PS C:\>Get-AzureRMSqlDatabaseGeoBackup -ResourceGroupName "ContosoResourceGroup" -ServerName "ContosoServer" -DatabaseName "ContosoDatabase" -``` - -This command gets the database geo-redundant backup named ContosoDatabase. - -## PARAMETERS - -### -DatabaseName -Specifies the name of the database to get. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the SQL database server is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server that hosts the backup to restore. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlDatabaseGeoBackupModel - -## NOTES - -## RELATED LINKS - -[Overview: Cloud business continuity and database disaster recovery with SQL Database](https://go.microsoft.com/fwlink/?LinkId=746881) - -[Recover an Azure SQL Database from an outage](https://go.microsoft.com/fwlink/?LinkId=746882) - -[Restore-AzureRmSqlDatabase](./Restore-AzureRmSqlDatabase.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRMSqlDeletedDatabaseBackup.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRMSqlDeletedDatabaseBackup.md deleted file mode 100644 index c819118b66..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRMSqlDeletedDatabaseBackup.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 62B9754D-5EBF-4BEE-B07A-3E508C918F03 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqldeleteddatabasebackup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRMSqlDeletedDatabaseBackup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRMSqlDeletedDatabaseBackup.md ---- - -# Get-AzureRmSqlDeletedDatabaseBackup - -## SYNOPSIS -Gets a deleted database that you can restore. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlDeletedDatabaseBackup [-ServerName] <String> [[-DatabaseName] <String>] - [[-DeletionDate] <DateTime>] [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRMSqlDeletedDatabaseBackup** cmdlet gets a specified deleted SQL database backup that you can restore, or all deleted backups that you can restore. -This cmdlet is also supported by the SQL Server Stretch Database service on Azure. - -## EXAMPLES - -### Example 1: Get all deleted database backups on a server -``` -PS C:\>Get-AzureRMSqlDeletedDatabaseBackup -ResourceGroupName "ContosoResourceGroup" -ServerName "ContosoServer" -``` - -This command gets all deleted database backups on a server. - -### Example 2: Get a specified deleted database backup -``` -PS C:\>Get-AzureRMSqlDeletedDatabaseBackup -ResourceGroupName "ContosoResourceGroup" -ServerName "ContosoServer" -DatabaseName "ContosoDatabase" -``` - -This command gets the deleted database backup for ContosoDatabase. - -## PARAMETERS - -### -DatabaseName -Specifies the name of the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeletionDate -Specifies the date, as a **DateTime** object, that the database was deleted. -To get a **DateTime** object, use the Get-Date cmdlet. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the server is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the database server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.DateTime, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlDeletedDatabaseBackupModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlDatabase](./Get-AzureRmSqlDatabase.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlCapability.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlCapability.md deleted file mode 100644 index a0960b62d7..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlCapability.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 8C5D29AD-0B15-4CD4-8637-86ABD19F41C8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlcapability -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlCapability.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlCapability.md ---- - -# Get-AzureRmSqlCapability - -## SYNOPSIS -Gets SQL Database capabilities for the current subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### FilterResults (Default) -``` -Get-AzureRmSqlCapability [-LocationName] <String> [-ServerVersionName <String>] [-EditionName <String>] - [-ServiceObjectiveName <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### DefaultResults -``` -Get-AzureRmSqlCapability [-LocationName] <String> [-Defaults] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlCapability** cmdlet gets the Azure SQL Database capabilities available on the current subscription for a region. -If you specify the *ServerVersionName*, *EditionName*, or *ServiceObjectiveName* parameters, this cmdlet returns the specified values and their predecessors. - -## EXAMPLES - -### Example 1: Get capabilities for the current subscription for a region -``` -PS C:\>Get-AzureRmSqlCapability -LocationName "Central US" -Location : Central US -Status : Available -SupportedServerVersions : {12.0, 2.0} -``` - -This command returns the capabilities for SQL Database instances on the current subscription for the Central US region. - -### Example 2: Get default capabilities for the current subscription for a region -``` -PS C:\>Get-AzureRmSqlCapability -LocationName "Central US" -Defaults -Location : Central US -Status : Available -ExpandedDetails : Version: 2.0 (Default) -> Edition: Standard (Default) -> Service Objective: S0 (Default) -``` - -This command returns the default capabilities for SQL Databases on the current subscription in the Central US region. - -### Example 3: Get details for a service objective -``` -PS C:\>Get-AzureRmSqlCapability -LocationName "Central US" -ServiceObjectiveName "S1" -Location : Central US -Status : Available -ExpandedDetails : Version: 12.0 (Available) -> Edition: Standard (Default) -> Service Objective: S1 (Available) - Version: 2.0 (Default) -> Edition: Standard (Default) -> Service Objective: S1 (Available) -``` - -This command gets default capabilities for SQL Databases for the specified service objective on the current subscription. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Defaults -Indicates that this cmdlet gets only defaults. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: DefaultResults -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EditionName -Specifies the name of the database edition for which this cmdlet gets capabilities. - -```yaml -Type: System.String -Parameter Sets: FilterResults -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LocationName -Specifies the name of the Location for which this cmdlet gets capabilities. -For more information, see Azure Regionshttps://azure.microsoft.com/en-us/regions/ (https://azure.microsoft.com/en-us/regions/). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerVersionName -Specifies the name of the server version for which this cmdlet gets capabilities. - -```yaml -Type: System.String -Parameter Sets: FilterResults -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceObjectiveName -Specifies the name of the service objective for which this cmdlet gets capabilities. - -```yaml -Type: System.String -Parameter Sets: FilterResults -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Location_Capabilities.Model.LocationCapabilityModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabase.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabase.md deleted file mode 100644 index a22a22119b..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabase.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 0C8AC52C-4E70-493C-A299-79CE32EC5EF1 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqldatabase -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabase.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabase.md ---- - -# Get-AzureRmSqlDatabase - -## SYNOPSIS -Gets one or more databases. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlDatabase [[-DatabaseName] <String>] [-ServerName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlDatabase** cmdlet gets one or more Azure SQL databases from an Azure SQL Database Server. -This cmdlet is also supported by the SQL Server Stretch Database service on Azure. - -## EXAMPLES - -### Example 1: Get all databases on a server -``` -PS C:\>Get-AzureRmSqlDatabase -ResourceGroupName "resourcegroup01" -ServerName "server01" -ResourceGroupName : resourcegroup01 -ServerName : server01 -DatabaseName : master -Location : Central US -DatabaseId : a2a7f2db-7526-4d86-a7b2-36276ee10dc6 -Edition : None -CollationName : SQL_Latin1_General_CP1_CI_AS -CatalogCollation : -MaxSizeBytes : 5368709120 -Status : Online -CreationDate : 7/3/2015 7:32:44 AM -CurrentServiceObjectiveId : c99ac918-dbea-463f-a475-16ec020fdc12 -CurrentServiceObjectiveName : System1 -RequestedServiceObjectiveId : c99ac918-dbea-463f-a475-16ec020fdc12 -RequestedServiceObjectiveName : -ElasticPoolName : -EarliestRestoreDate : -Tags : - -ResourceGroupName : resourcegroup01 -ServerName : server01 -DatabaseName : database01 -Location : Central US -DatabaseId : a1e6bd1a-735a-4d48-8b98-afead5ef1218 -Edition : Standard -CollationName : SQL_Latin1_General_CP1_CI_AS -CatalogCollation : -MaxSizeBytes : 268435456000 -Status : Online -CreationDate : 7/3/2015 7:33:37 AM -CurrentServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b -CurrentServiceObjectiveName : S0 -RequestedServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b -RequestedServiceObjectiveName : -ElasticPoolName : -EarliestRestoreDate : -Tags : -``` - -This command gets all databases on the server named server01. - -### Example 2: Get a database by name on a server -``` -PS C:\>Get-AzureRmSqlDatabase -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database02" -ResourceGroupName : resourcegroup01 -ServerName : server01 -DatabaseName : database01 -Location : Central US -DatabaseId : a1e6bd1a-735a-4d48-8b98-afead5ef1218 -Edition : Standard -CollationName : SQL_Latin1_General_CP1_CI_AS -CatalogCollation : -MaxSizeBytes : 268435456000 -Status : Online -CreationDate : 7/3/2015 7:33:37 AM -CurrentServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b -CurrentServiceObjectiveName : S0 -RequestedServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b -RequestedServiceObjectiveName : -ElasticPoolName : -EarliestRestoreDate : -Tags : -``` - -This command gets a database named Database02 from a server named Server01. - -## PARAMETERS - -### -DatabaseName -Specifies the name of the database to retrieve. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the database server is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server to which the database is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel - -## NOTES - -## RELATED LINKS - -[New-AzureRmSqlDatabase](./New-AzureRmSqlDatabase.md) - -[Remove-AzureRmSqlDatabase](./Remove-AzureRmSqlDatabase.md) - -[Resume-AzureRmSqlDatabase](./Resume-AzureRmSqlDatabase.md) - -[Set-AzureRmSqlDatabase](./Set-AzureRmSqlDatabase.md) - -[Suspend-AzureRmSqlDatabase](./Suspend-AzureRmSqlDatabase.md) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseActivity.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseActivity.md deleted file mode 100644 index fd9cb8a3a2..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseActivity.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: B5C909D7-6087-463A-83BF-99DD196B9862 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqldatabaseactivity -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseActivity.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseActivity.md ---- - -# Get-AzureRmSqlDatabaseActivity - -## SYNOPSIS -Gets the status of database operations. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlDatabaseActivity [-ServerName] <String> [-ElasticPoolName <String>] -DatabaseName <String> - [-OperationId <Guid>] [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlDatabaseActivity** cmdlet gets the status of database operations in Azure SQL Database. - -## EXAMPLES - -### Example 1: Get status for all SQL Database instances -``` -PS C:\>Get-AzureRmSqlDatabaseActivity -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ElasticPoolName "ElasticPool01" -``` - -This command returns the operation status of all SQL Database instances in an elastic pool named ElasticPool01. - -### Example 2: Get status for all SQL Database operations -``` -PS C:\>Get-AzureRmSqlDatabaseActivity -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -``` - -This command returns the status of all SQL Database operations in a database. - -## PARAMETERS - -### -DatabaseName -Specifies the name of the database for which this cmdlet gets status. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ElasticPoolName -Specifies the name of the elastic database pool for which this cmdlet gets status. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OperationId -Specifies the ID of the operation that this cmdlet gets. - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the database is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the Microsoft SQL Server that hosts the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseActivityModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseAdvisor.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseAdvisor.md deleted file mode 100644 index c2a09310a1..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseAdvisor.md +++ /dev/null @@ -1,294 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 5AAB22C6-8E3C-4BDC-8A54-DA5A9906B762 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqldatabaseadvisor -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseAdvisor.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseAdvisor.md ---- - -# Get-AzureRmSqlDatabaseAdvisor - -## SYNOPSIS -Gets one or more Advisors for an Azure SQL Database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlDatabaseAdvisor [-AdvisorName <String>] [-ExpandRecommendedActions] -ServerName <String> - -DatabaseName <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlDatabaseAdvisor** cmdlet gets one or more Azure SQL Database Advisors for an Azure SQL Database. - -## EXAMPLES - -### Example 1: List all the advisors for the specified database -``` -PS C:\>Get-AzureRmSqlDatabaseAdvisor -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -DatabaseName "WIRunner" -DatabaseName : WIRunner -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : CreateIndex -AdvisorStatus : GA -AutoExecuteStatus : Disabled -AutoExecuteStatusInheritedFrom : Database -LastChecked : 8/1/2016 2:36:47 PM -RecommendationsStatus : Ok -RecommendedActions : {} - -DatabaseName : WIRunner -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : DropIndex -AdvisorStatus : PublicPreview -AutoExecuteStatus : Disabled -AutoExecuteStatusInheritedFrom : Database -LastChecked : 7/31/2016 8:41:19 PM -RecommendationsStatus : Ok -RecommendedActions : {} - -DatabaseName : WIRunner -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : DbParameterization -AdvisorStatus : PublicPreview -AutoExecuteStatus : Disabled -AutoExecuteStatusInheritedFrom : Default -LastChecked : 7/31/2016 2:46:58 PM -RecommendationsStatus : NoDbParameterizationIssue -RecommendedActions : {} - -DatabaseName : WIRunner -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : SchemaIssue -AdvisorStatus : PublicPreview -AutoExecuteStatus : Disabled -AutoExecuteStatusInheritedFrom : Default -LastChecked : 8/1/2016 3:01:41 PM -RecommendationsStatus : SchemaIsConsistent -RecommendedActions : {} -``` - -This command gets lists all the advisors for the database named WIRunner that belongs to the server named wi-runner-australia-east. - -### Example 2: Get a single advisor for the specified database -``` -PS C:\>Get-AzureRmSqlDatabaseAdvisor -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -DatabaseName "WIRunner" -AdvisorName "CreateIndex" -DatabaseName : WIRunner -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : CreateIndex -AdvisorStatus : GA -AutoExecuteStatus : Disabled -AutoExecuteStatusInheritedFrom : Database -LastChecked : 8/1/2016 2:36:47 PM -RecommendationsStatus : Ok -RecommendedActions : {} -``` - -This command gets the Advisor named CreateIndex for the database named WIRunner. - -### Example 3: List all the advisors with their recommended actions included in the response -``` -PS C:\>Get-AzureRmSqlDatabaseAdvisor -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -DatabaseName "WIRunner" -ExpandRecommendedActions -DatabaseName : WIRunner -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : CreateIndex -AdvisorStatus : GA -AutoExecuteStatus : Disabled -AutoExecuteStatusInheritedFrom : Database -LastChecked : 8/1/2016 2:36:47 PM -RecommendationsStatus : Ok -RecommendedActions : {IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893, - IR_[test_schema]_[test_table_0.236046]_6C7AE8CC9C87E7FD5893, - IR_[test_schema]_[test_table_0.239359]_6C7AE8CC9C87E7FD5893, - IR_[test_schema]_[test_table_0.437714]_6C7AE8CC9C87E7FD5893...} - -DatabaseName : WIRunner -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : DropIndex -AdvisorStatus : PublicPreview -AutoExecuteStatus : Disabled -AutoExecuteStatusInheritedFrom : Database -LastChecked : 7/31/2016 8:41:19 PM -RecommendationsStatus : Ok -RecommendedActions : {IR_[test_schema]_[test_table_0.0288891]_38724E1DCF2178318957, - IR_[test_schema]_[test_table_0.140264]_38724E1DCF2178318957, - IR_[test_schema]_[test_table_0.412191]_38724E1DCF2178318957, - IR_[test_schema]_[test_table_0.442075]_38724E1DCF2178318957...} - -DatabaseName : WIRunner -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : DbParameterization -AdvisorStatus : PublicPreview -AutoExecuteStatus : Disabled -AutoExecuteStatusInheritedFrom : Default -LastChecked : 7/31/2016 2:46:58 PM -RecommendationsStatus : NoDbParameterizationIssue -RecommendedActions : {} - -DatabaseName : WIRunner -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : SchemaIssue -AdvisorStatus : PublicPreview -AutoExecuteStatus : Disabled -AutoExecuteStatusInheritedFrom : Default -LastChecked : 8/1/2016 3:04:26 PM -RecommendationsStatus : SchemaIsConsistent -RecommendedActions : {} -``` - -This command gets all the advisors for the database named 'WIRunner' with their recommended actions included in the response. -Since the command uses the *ExpandRecommendedActions* parameter, the cmdlet gets the recommended actions with the response. - -### Example 4: Get a single advisor with its recommended actions included in the response -``` -PS C:\>Get-AzureRmSqlDatabaseAdvisor -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -DatabaseName "WIRunner" -AdvisorName "CreateIndex" -ExpandRecommendedActions -DatabaseName : WIRunner -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : CreateIndex -AdvisorStatus : GA -AutoExecuteStatus : Disabled -AutoExecuteStatusInheritedFrom : Database -LastChecked : 8/1/2016 2:36:47 PM -RecommendationsStatus : Ok -RecommendedActions : {IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893, - IR_[test_schema]_[test_table_0.236046]_6C7AE8CC9C87E7FD5893, - IR_[test_schema]_[test_table_0.239359]_6C7AE8CC9C87E7FD5893, - IR_[test_schema]_[test_table_0.437714]_6C7AE8CC9C87E7FD5893...} -``` - -This command gets the Advisor named CreateIndex from the database named WIRunner with its recommended actions included in the response. -Since the command uses the *ExpandRecommendedActions* parameter, the cmdlet gets the recommended actions with the response. - -## PARAMETERS - -### -AdvisorName -Specifies the name of the advisor that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the database for which this cmdlet requests the Advisor. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpandRecommendedActions -Indicates that this cmdlet gets the recommended actions with the response. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the server that contains this database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server that contains the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Advisor.Model.AzureSqlDatabaseAdvisorModel - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql, advisor - -## RELATED LINKS - -[Get-AzureRmSqlServerAdvisor](./Get-AzureRmSqlServerAdvisor.md) - -[Get-AzureRmSqlElasticPoolAdvisor](./Get-AzureRmSqlElasticPoolAdvisor.md) - -[Get-AzureRmSqlDatabaseRecommendedAction](./Get-AzureRmSqlDatabaseRecommendedAction.md) - -[Set-AzureRmSqlDatabaseAdvisorAutoExecuteStatus](./Set-AzureRmSqlDatabaseAdvisorAutoExecuteStatus.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseAuditing.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseAuditing.md deleted file mode 100644 index 8670045d68..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseAuditing.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 14814BF3-51AF-4E51-A8A6-661825BD88D1 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqldatabaseauditing -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseAuditing.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseAuditing.md ---- - -# Get-AzureRmSqlDatabaseAuditing - -## SYNOPSIS -Gets the auditing settings of an Azure SQL database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlDatabaseAuditing [-ServerName] <String> [-DatabaseName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlDatabaseAuditing** cmdlet gets the auditing settings of an Azure SQL database. -To use the cmdlet, use the *ResourceGroupName*, *ServerName*, and *DatabaseName* parameters to identify the database. - -## EXAMPLES - -### Example 1: Get the auditing settings of an Azure SQL database -``` -PS C:\>Get-AzureRmSqlDatabaseAuditing -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -DatabaseName : database01 -AuditAction : {} -AuditActionGroup : {SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP, - BATCH_COMPLETED_GROUP, ...} -ResourceGroupName : resourcegroup01 -ServerName : server01 -AuditState : Enabled -StorageAccountName : mystorage -StorageKeyType : Primary -RetentionInDays : 0 -StorageAccountSubscriptionId : 7fe3301d-31d3-4668-af5e-211a890ba6e3 -PredicateExpression : statement <> 'select 1' -``` - -## PARAMETERS - -### -DatabaseName -SQL Database name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -SQL Database server name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Auditing.Model.DatabaseBlobAuditingSettingsModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseAuditingPolicy.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseAuditingPolicy.md deleted file mode 100644 index 7252626fad..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseAuditingPolicy.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 14814BF3-51AF-4E51-A8A6-661825BD88D1 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqldatabaseauditingpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseAuditingPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseAuditingPolicy.md ---- - -# Get-AzureRmSqlDatabaseAuditingPolicy - -## SYNOPSIS -Gets the auditing policy of a database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlDatabaseAuditingPolicy [-ServerName] <String> [-DatabaseName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlDatabaseAuditingPolicy** cmdlet gets the auditing policy of an Azure SQL Database. -To use the cmdlet, use the *ResourceGroupName*, *ServerName*, and *DatabaseName* parameters to identify the database. - -## EXAMPLES - -### Example 1: Get the auditing policy of an Azure SQL database with Table auditing defined on it -``` -PS C:\>Get-AzureRmSqlDatabaseAuditingPolicy -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -DatabaseName : database01 -UseServerDefault : Disabled -EventType : {PlainSQL_Success, PlainSQL_Failure, ParameterizedSQL_Success, ParameterizedSQL_Failure...} -TableIdentifier : MyAuditTableName -FullAuditLogsTableName : SQLDBAuditLogsMyAuditTableName -ResourceGroupName : resourcegroup01 -ServerName : server01 -AuditType : Table -AuditState : Enabled -StorageAccountName : mystorage -StorageKeyType : Primary -RetentionInDays : 0 -``` - -### Example 2: Get the auditing policy of an Azure SQL database with Blob auditing defined on it -``` -PS C:\>Get-AzureRmSqlDatabaseAuditingPolicy -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -DatabaseName : database01 -AuditAction : {} -AuditActionGroup : {SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP, - BATCH_COMPLETED_GROUP, ...} -ResourceGroupName : resourcegroup01 -ServerName : server01 -AuditType : Blob -AuditState : Enabled -StorageAccountName : mystorage -StorageKeyType : Primary -RetentionInDays : 0 -``` - -## PARAMETERS - -### -DatabaseName -Specifies the name of the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the database is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server where the database is located. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Auditing.Model.AuditingPolicyModel - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmSqlDatabaseAuditing](./Remove-AzureRmSqlDatabaseAuditing.md) - -[Set-AzureRmSqlDatabaseAuditingPolicy](./Set-AzureRmSqlDatabaseAuditingPolicy.md) - - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseBackupLongTermRetentionPolicy.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseBackupLongTermRetentionPolicy.md deleted file mode 100644 index cccad32ae3..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseBackupLongTermRetentionPolicy.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqldatabasebackuplongtermretentionpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseBackupLongTermRetentionPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseBackupLongTermRetentionPolicy.md ---- - -# Get-AzureRmSqlDatabaseBackupLongTermRetentionPolicy - -## SYNOPSIS -Gets a database long term retention policy. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlDatabaseBackupLongTermRetentionPolicy [-Current] [-ServerName] <String> [-DatabaseName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlDatabaseBackupLongTermRetentionPolicy** cmdlet gets the long term retention policy registered to this database. -The policy is an Azure Backup resource used to define backup storage policy. - -## EXAMPLES - -### Example 1: Get the current version of the long term retention policy -```powershell -PS C:\> Get-AzureRmSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -Current - - -ResourceGroupName : resourcegroup01 -ServerName : server01 -DatabaseName : database01 -WeeklyRetention : P2W -MonthlyRetention : PT0S -YearlyRetention : PT0S -WeekOfYear : 0 -State : -RecoveryServicesBackupPolicyResourceId : -Location : -``` - -This command gets the current version of the long term retention policy for database01 - -### Example 2: Get the legacy version of the long term retention policy -```powershell -PS C:\> Get-AzureRmSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 - - -ResourceGroupName : resourcegroup01 -ServerName : server01 -DatabaseName : database01 -WeeklyRetention : -MonthlyRetention : -YearlyRetention : -WeekOfYear : -State : Enabled -RecoveryServicesBackupPolicyResourceId : /subscriptions/4f2b42fc-4fc3-fd41-8ab8-5a382d8b30df/resourceGroups/resourcegroup01/providers/MicrosoftRecoveryServices/vaults/vault01/backupPolicies/policy01 -Location : Southeast Asia -``` - -This command gets the legacy version of the long term retention policy for database01 - -## PARAMETERS - -### -Current -If not provided, the command returns the legacy Long Term Retention policy information. -Otherwise, the command returns the current version of the Long Term Retention policy. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -The name of the Azure SQL Database to use. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The name of the Azure SQL Server the database is in. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlDatabaseBackupLongTermRetentionPolicyModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlDatabaseLongTermRetentionBackup](./Get-AzureRmSqlDatabaseLongTermRetentionBackup.md) - -[Remove-AzureRmSqlDatabaseLongTermRetentionBackup](./Remove-AzureRmSqlDatabaseLongTermRetentionBackup.md) - -[Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy](./Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseDataMaskingPolicy.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseDataMaskingPolicy.md deleted file mode 100644 index 060542be19..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseDataMaskingPolicy.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: FFC02A5D-A12F-494D-8542-76A5B89E32DC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqldatabasedatamaskingpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseDataMaskingPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseDataMaskingPolicy.md ---- - -# Get-AzureRmSqlDatabaseDataMaskingPolicy - -## SYNOPSIS -Gets the data masking policy for a database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlDatabaseDataMaskingPolicy [-ServerName] <String> [-DatabaseName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlDatabaseDataMaskingPolicy** cmdlet gets the data masking policy of an Azure SQL database. -To use this cmdlet, use the *ResourceGroupName*, *ServerName*, and *DatabaseName* parameters to identify the database. -This cmdlet is also supported by the SQL Server Stretch Database service on Azure. - -## EXAMPLES - -### Example 1: Get the data masking policy for an Azure SQL database -``` -PS C:\>Get-AzureRmSqlDatabaseDataMaskingPolicy -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -DatabaseName : Database01 -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DataMaskingState : Enabled -PrivilegedUsers : -``` - -This command gets the data masking policy from database Database01 in resource group ResourceGroup01 on server Server01. - -## PARAMETERS - -### -DatabaseName -Specifies the name of the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the database is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server where the database is located. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.DataMasking.Model.DatabaseDataMaskingPolicyModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlDatabaseDataMaskingRule](./Get-AzureRmSqlDatabaseDataMaskingRule.md) - -[New-AzureRmSqlDatabaseDataMaskingRule](./New-AzureRmSqlDatabaseDataMaskingRule.md) - -[Remove-AzureRmSqlDatabaseDataMaskingRule](./Remove-AzureRmSqlDatabaseDataMaskingRule.md) - -[Set-AzureRmSqlDatabaseDataMaskingPolicy](./Set-AzureRmSqlDatabaseDataMaskingPolicy.md) - -[Set-AzureRmSqlDatabaseDataMaskingRule](./Set-AzureRmSqlDatabaseDataMaskingRule.md) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseDataMaskingRule.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseDataMaskingRule.md deleted file mode 100644 index 500fd5e04b..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseDataMaskingRule.md +++ /dev/null @@ -1,244 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 848A6972-AB29-46FB-8E03-FF2ADB113A0E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqldatabasedatamaskingrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseDataMaskingRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseDataMaskingRule.md ---- - -# Get-AzureRmSqlDatabaseDataMaskingRule - -## SYNOPSIS -Gets the data masking rules from a database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlDatabaseDataMaskingRule [-SchemaName <String>] [-TableName <String>] [-ColumnName <String>] - [-ServerName] <String> [-DatabaseName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlDatabaseDataMaskingRule** cmdlet gets either a specific data masking rule or all of the data masking rules for an Azure SQL database. -To use the cmdlet, use the *ResourceGroupName*, *ServerName*, and *DatabaseName* parameters to identify the database, and the *RuleId* parameter to specify which rule this cmdlet returns. -If you do not provide *RuleId*, all the data masking rules for that Azure SQL database are returned. -This cmdlet is also supported by the SQL Server Stretch Database service on Azure. - -## EXAMPLES - -### Example 1: Get all data masking rules from a database -``` -PS C:\>Get-AzureRmSqlDatabaseDataMaskingRule -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -DatabaseName : database01 -ResourceGroupName : resourcegroup01 -ServerName : server01 -SchemaName : dbo -TableName : table1 -ColumnName : column1 -MaskingFunction : Default -PrefixSize : -SuffixSize : -ReplacementString : -NumberFrom : -NumberTo : - -DatabaseName : database01 -ResourceGroupName : resourcegroup01 -ServerName : server01 -SchemaName : dbo -TableName : table2 -ColumnName : column2 -MaskingFunction : Default -PrefixSize : -SuffixSize : -ReplacementString : -NumberFrom : -NumberTo : -``` - -### Example 2: Get the data masking rule defined on schema "dbo", table "table1" and column "column1". -``` -PS C:\>Get-AzureRmSqlDatabaseDataMaskingRule -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -SchemaName "dbo" -TableName "table1" -ColumnName "column1" -DatabaseName : database01 -ResourceGroupName : resourcegroup01 -ServerName : server01 -SchemaName : dbo -TableName : table1 -ColumnName : column1 -MaskingFunction : Default -PrefixSize : -SuffixSize : -ReplacementString : -NumberFrom : -NumberTo : -``` - -## PARAMETERS - -### -ColumnName -Specifies the name of the column targeted by the masking rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the database is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SchemaName -Specifies the name of a schema. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TableName -Specifies the name of an Azure SQL table. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.DataMasking.Model.DatabaseDataMaskingRuleModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlDatabaseDataMaskingPolicy](./Get-AzureRmSqlDatabaseDataMaskingPolicy.md) - -[New-AzureRmSqlDatabaseDataMaskingRule](./New-AzureRmSqlDatabaseDataMaskingRule.md) - -[Remove-AzureRmSqlDatabaseDataMaskingRule](./Remove-AzureRmSqlDatabaseDataMaskingRule.md) - -[Set-AzureRmSqlDatabaseDataMaskingPolicy](./Set-AzureRmSqlDatabaseDataMaskingPolicy.md) - -[Set-AzureRmSqlDatabaseDataMaskingRule](./Set-AzureRmSqlDatabaseDataMaskingRule.md) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseExpanded.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseExpanded.md deleted file mode 100644 index 7fe16e030f..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseExpanded.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 952967EB-AEAD-4597-B837-6669CE73739E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqldatabaseexpanded -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseExpanded.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseExpanded.md ---- - -# Get-AzureRmSqlDatabaseExpanded - -## SYNOPSIS -Gets a database and its expanded property values. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlDatabaseExpanded [-ServerName] <String> [[-DatabaseName] <String>] [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlDatabaseExpanded** cmdlet gets a database and its expanded property values. -This cmdlet is also supported by the SQL Server Stretch Database service on Azure. - -## EXAMPLES - -### Example 1: Get database object that has service tier advisor information -``` -PS C:\>Get-AzureRmSqlDatabaseExpanded -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -``` - -This command returns the database that has expanded properties that contain the service tier advisor information. - -## PARAMETERS - -### -DatabaseName -Specifies the name of the database to get. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the server is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server that hosts the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModelExpanded - -## NOTES - -## RELATED LINKS - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseFailoverGroup.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseFailoverGroup.md deleted file mode 100644 index a9c09da40e..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseFailoverGroup.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqldatabasefailovergroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseFailoverGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseFailoverGroup.md ---- - -# Get-AzureRmSqlDatabaseFailoverGroup - -## SYNOPSIS -Gets or lists Azure SQL Database Failover Groups. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlDatabaseFailoverGroup [-ServerName] <String> [[-FailoverGroupName] <String>] - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Gets a specific Azure SQL Database Failover Group or lists the Failover Groups on a server. -Either server in the Failover Group may be used to execute the command. The returned values will reflect the state of the specified server with respect to the Failover Group. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $failoverGroups = Get-AzureRMSqlDatabaseFailoverGroup -ResourceGroupName rg -ServerName server -``` - -Lists all Failover Groups on a server. - -### Example 2 -``` -PS C:\> $failoverGroup = Get-AzureRMSqlDatabaseFailoverGroup -ResourceGroupName rg -ServerName server -FailoverGroupName fg -``` - -Get a specific Failover Group. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FailoverGroupName -The name of the Azure SQL Database Failover Group to retrieve. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The name of the Azure SQL Database Server from which to retrieve the Failover Group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.FailoverGroup.Model.AzureSqlFailoverGroupModel - -## NOTES - -## RELATED LINKS - -[New-AzureRmSqlDatabaseFailoverGroup](./New-AzureRmSqlDatabaseFailoverGroup.md) - -[Set-AzureRmSqlDatabaseFailoverGroup](./Set-AzureRmSqlDatabaseFailoverGroup.md) - -[Add-AzureRmSqlDatabaseToFailoverGroup](./Add-AzureRmSqlDatabaseToFailoverGroup.md) - -[Remove-AzureRmSqlDatabaseFromFailoverGroup](./Remove-AzureRmSqlDatabaseFromFailoverGroup.md) - -[Switch-AzureRmSqlDatabaseFailoverGroup](./Switch-AzureRmSqlDatabaseFailoverGroup.md) - -[Remove-AzureRmSqlDatabaseFailoverGroup](./Remove-AzureRmSqlDatabaseFailoverGroup.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseGeoBackupPolicy.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseGeoBackupPolicy.md deleted file mode 100644 index 6c75dbce02..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseGeoBackupPolicy.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 4F28BA63-23FC-4E35-A7FB-726E6FE94D26 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqldatabasegeobackuppolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseGeoBackupPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseGeoBackupPolicy.md ---- - -# Get-AzureRmSqlDatabaseGeoBackupPolicy - -## SYNOPSIS -Gets a database geo backup policy. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlDatabaseGeoBackupPolicy [-ServerName] <String> [-DatabaseName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlDatabaseGeoBackupPolicy** cmdlet gets the geo backup policy registered to this database. -This is an Azure Backup resource that is used to define backup storage policy. - -## EXAMPLES - -## PARAMETERS - -### -DatabaseName -Specifies the name of the database for which this cmdlet gets the geo backup policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the server that contains this database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server that hosts the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlDatabaseGeoBackupPolicyModel - -## NOTES - -## RELATED LINKS - -[Set-AzureRmSqlDatabaseGeoBackupPolicy](./Set-AzureRmSqlDatabaseGeoBackupPolicy.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseImportExportStatus.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseImportExportStatus.md deleted file mode 100644 index bd4a536089..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseImportExportStatus.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 5D4F13F9-57E7-446B-AA28-8C44B149E1CB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqldatabaseimportexportstatus -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseImportExportStatus.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseImportExportStatus.md ---- - -# Get-AzureRmSqlDatabaseImportExportStatus - -## SYNOPSIS -Gets the details of an import or export of an Azure SQL Database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlDatabaseImportExportStatus [-OperationStatusLink] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlDatabaseImportExportStatus** cmdlet gets details of a bacpac file import from a storage account to an Azure SQL Database or an export of an Azure SQL Database as a bacpac file to a storage account. -This cmdlet is also supported by the SQL Server Stretch Database service on Azure. - -## EXAMPLES - -### Example 1: Get the import and export status of a SQL database -``` -PS C:\>Get-AzureRmSqlDatabaseImportExportStatus -OperationStatusLink "https://management.contoso.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resource01/providers/Microsoft.Sql/servers/server01/databases/database01/importExportOperationResults/00000000-000-0000-0000-000000000000?api-version=2014-04-01" -OperationStatusLink : -ErrorMessage : -LastModifiedTime : 4/15/2016 10:16:14 PM -QueuedTime : 4/15/2016 10:16:13 PM -StatusMessage : Running, Progress = 5.00 % -Status : InProgress -``` - -This command gets the status of an import or export request for a database at the specified URL. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OperationStatusLink -Specifies the status link that is returned from the New-AzureRmSqlDatabaseExport or New-AzureRmSqlDatabaseImport cmdlets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ImportExport.Model.AzureSqlDatabaseImportExportStatusModel - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - -## RELATED LINKS - -[New-AzureRmSqlDatabaseExport](./New-AzureRmSqlDatabaseExport.md) - -[New-AzureRmSqlDatabaseImport](./New-AzureRmSqlDatabaseImport.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseIndexRecommendations.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseIndexRecommendations.md deleted file mode 100644 index 3358474bc5..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseIndexRecommendations.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 10656EA5-EA5F-4394-951F-BC64BE3BF6F9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqldatabaseindexrecommendations -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseIndexRecommendations.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseIndexRecommendations.md ---- - -# Get-AzureRmSqlDatabaseIndexRecommendations - -## SYNOPSIS -Gets the recommended index operations for a server or database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlDatabaseIndexRecommendations -ServerName <String> [-DatabaseName <String>] [-TableName <String>] - [-IndexRecommendationName <String>] [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlDatabaseIndexRecommendations** cmdlet gets the recommended index operations for an Azure SQL Database server or database. - -## EXAMPLES - -### Example 1: Get index recommendations for all databases on server -``` -PS C:\>Get-AzureRmSqlDatabaseIndexRecommendations -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -``` - -This command returns index recommendations for all databases on server server01. - -### Example 2: Get index recommendations for a specific database -``` -PS C:\>Get-AzureRmSqlDatabaseIndexRecommendations -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -``` - -This command returns index recommendations for specific database. - -### Example 3: Get a single index recommendation by name -``` -PS C:\>Get-AzureRmSqlDatabaseIndexRecommendations -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -IndexRecommendationName "INDEX_NAME" -``` - -This command returns single index recommendation by name. - -## PARAMETERS - -### -DatabaseName -Specifies the name of the database for which this cmdlet gets index recommendations. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IndexRecommendationName -Specifies the name of the index recommendation that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the server is assigned for. -This cmdlet gets index recommendations for a database hosted by this server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the server that hosts the database for which this cmdlet gets index recommendations. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TableName -Specifies the name of an Azure SQL table. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Model.IndexRecommendation - -## NOTES - -## RELATED LINKS - -[Start-AzureRmSqlDatabaseExecuteIndexRecommendation](./Start-AzureRmSqlDatabaseExecuteIndexRecommendation.md) - -[Stop-AzureRmSqlDatabaseExecuteIndexRecommendation](./Stop-AzureRmSqlDatabaseExecuteIndexRecommendation.md) diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseLongTermRetentionBackup.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseLongTermRetentionBackup.md deleted file mode 100644 index eef4a8b667..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseLongTermRetentionBackup.md +++ /dev/null @@ -1,340 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqldatalongtermretentionbackup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseLongTermRetentionBackup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseLongTermRetentionBackup.md ---- - -# Get-AzureRmSqlDatabaseLongTermRetentionBackup - -## SYNOPSIS -Gets one or more long term retention backups. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Location (Default) -``` -Get-AzureRmSqlDatabaseLongTermRetentionBackup [-Location] <String> [-OnlyLatestPerDatabase] - [-DatabaseState <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ServerName -``` -Get-AzureRmSqlDatabaseLongTermRetentionBackup [-Location] <String> [-ServerName] <String> - [-DatabaseName <String>] [-OnlyLatestPerDatabase] [-DatabaseState <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### BackupName -``` -Get-AzureRmSqlDatabaseLongTermRetentionBackup [-Location] <String> [-ServerName] <String> - -DatabaseName <String> [-BackupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### GetBackupByResourceId -``` -Get-AzureRmSqlDatabaseLongTermRetentionBackup [-Location] <String> [-ResourceId] <String> - [-BackupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### GetBackupsByResourceId -``` -Get-AzureRmSqlDatabaseLongTermRetentionBackup [-Location] <String> [-ResourceId] <String> - [-OnlyLatestPerDatabase] [-DatabaseState <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### GetBackupByInputObject -``` -Get-AzureRmSqlDatabaseLongTermRetentionBackup [-InputObject] <AzureSqlDatabaseModel> [-BackupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### GetBackupsByInputObject -``` -Get-AzureRmSqlDatabaseLongTermRetentionBackup [-InputObject] <AzureSqlDatabaseModel> [-OnlyLatestPerDatabase] - [-DatabaseState <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlDatabaseLongTermRetentionBackup** cmdlet gets all long term retention backups for a location, server, or database or gets a specific long term retention backup. - -## EXAMPLES - -### Example 1: Get all backups for a location -```powershell -PS C:\> Get-AzureRmSqlDatabaseLongTermRetentionBackup -Location northeurope - - -BackupExpirationTime : 3/22/2018 11:43:18 PM -BackupName : 55970792-164c-4a4a-88e5-7158d092d503;131656309980000000 -BackupTime : 3/15/2018 11:43:18 PM -DatabaseName : database02 -DatabaseDeletionTime : 3/18/2018 4:36:00 PM -Location : northeurope -ResourceId : /subscriptions/371edd6d-9630-4558-a7bd-ee139498e6a1/providers/Microsoft.Sql/locations/northeurope/longTermRetentionServers/server02/longTermRetentionDatabases/database02/longTermRetentionBackups/55970792-164c-4a4a-88e5-7158d092d503;131656309980000000 -ServerName : server02 -ServerCreateTime : 2/28/2018 12:12:19 AM - -BackupExpirationTime : 3/22/2018 5:50:55 AM -BackupName : 601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000 -BackupTime : 3/15/2018 5:50:55 AM -DatabaseName : database01 -DatabaseDeletionTime : -Location : northeurope -ResourceId : /subscriptions/371edd6d-9630-4558-a7bd-ee139498e6a1/providers/Microsoft.Sql/locations/northeurope/longTermRetentionServers/server01/longTermRetentionDatabases/database01/longTermRetentionBackups/601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000 -ServerName : server01 -ServerCreateTime : 2/29/2018 12:12:19 AM -``` - -This command gets all long term retention backups for all databases (which may be alive or deleted) in northeurope. - -### Example 2: Get a specific long term retention backup -```powershell -PS C:\> Get-AzureRmSqlDatabaseLongTermRetentionBackup -Location northeurope -ServerName server01 -DatabaseName database01 -BackupName "601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000" - - -BackupExpirationTime : 3/22/2018 5:50:55 AM -BackupName : 601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000 -BackupTime : 3/15/2018 5:50:55 AM -DatabaseName : database01 -DatabaseDeletionTime : -Location : northeurope -ResourceId : /subscriptions/371edd6d-9630-4558-a7bd-ee139498e6a1/providers/Microsoft.Sql/locations/northeurope/longTermRetentionServers/server01/longTermRetentionDatabases/database01/longTermRetentionBackups/601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000 -ServerName : server01 -ServerCreateTime : 2/29/2018 12:12:19 AM -``` - -This command gets the backup with name 601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000 - -### Example 3: Get all long term retention backups for a database -```powershell -PS C:\> Get-AzureRmSqlDatabase -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 | Get-AzureRmSqlDatabaseLongTermRetentionBackup - - -BackupExpirationTime : 3/22/2018 5:50:55 AM -BackupName : 601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000 -BackupTime : 3/15/2018 5:50:55 AM -DatabaseName : database01 -DatabaseDeletionTime : -Location : northeurope -ResourceId : /subscriptions/371edd6d-9630-4558-a7bd-ee139498e6a1/providers/Microsoft.Sql/locations/northeurope/longTermRetentionServers/server01/longTermRetentionDatabases/database01/longTermRetentionBackups/601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000 -ServerName : server01 -ServerCreateTime : 2/29/2018 12:12:19 AM -``` - -This command gets all long term retention backups for database01 - -## PARAMETERS - -### -BackupName -The name of the backup. - -```yaml -Type: System.String -Parameter Sets: BackupName, GetBackupByResourceId, GetBackupByInputObject -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseName -The name of the Azure SQL Database the backup is from. - -```yaml -Type: System.String -Parameter Sets: ServerName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: BackupName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseState -The state of the database whose backups you want to find, Alive, Deleted, or All. -Defaults to All - -```yaml -Type: System.String -Parameter Sets: Location, ServerName, GetBackupsByResourceId, GetBackupsByInputObject -Aliases: -Accepted values: All, Deleted, Live - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The database object to get backups for. - -```yaml -Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel -Parameter Sets: GetBackupByInputObject, GetBackupsByInputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Location -The location of the backups' source server. - -```yaml -Type: System.String -Parameter Sets: Location, ServerName, BackupName, GetBackupByResourceId, GetBackupsByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OnlyLatestPerDatabase -Whether or not to only get the latest backup per database. -Defaults to false. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Location, ServerName, GetBackupsByResourceId, GetBackupsByInputObject -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The database Resource ID to get backups for. - -```yaml -Type: System.String -Parameter Sets: GetBackupByResourceId, GetBackupsByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The name of the Azure SQL Server the backups are under. - -```yaml -Type: System.String -Parameter Sets: ServerName, BackupName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlDatabaseLongTermRetentionBackupModel - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmSqlDatabaseLongTermRetentionBackup](./Remove-AzureRmSqlDatabaseLongTermRetentionBackup.md) - -[Get-AzureRmSqlDatabaseBackupLongTermRetentionPolicy](./Get-AzureRmSqlDatabaseBackupLongTermRetentionPolicy.md) - -[Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy](./Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseRecommendedAction.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseRecommendedAction.md deleted file mode 100644 index c604ecdcb2..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseRecommendedAction.md +++ /dev/null @@ -1,276 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: EF6C862B-A89C-48AB-A590-92CFA387305F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqldatabaserecommendedaction -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseRecommendedAction.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseRecommendedAction.md ---- - -# Get-AzureRmSqlDatabaseRecommendedAction - -## SYNOPSIS -Gets one or more recommended actions for an Azure SQL Database Advisor. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlDatabaseRecommendedAction [-RecommendedActionName <String>] -ServerName <String> - -DatabaseName <String> -AdvisorName <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlDatabaseRecommendedAction** cmdlet gets one or more recommended actions for an Azure SQL Database Advisor. - -## EXAMPLES - -### Example 1: List all the recommended actions for an Advisor -``` -PS C:\>Get-AzureRmSqlDatabaseRecommendedAction -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -DatabaseName "WIRunner" -AdvisorName "CreateIndex" -DatabaseName : WIRunner -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : CreateIndex -RecommendedActionName : IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893 -Details : {[indexName, nci_wi_test_table_0.0361551_6C7AE8CC9C87E7FD5893], [indexType, - NONCLUSTERED], [schema, [test_schema]], [table, [test_table_0.0361551]]...} -ErrorDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionErrorInfo -EstimatedImpact : {ActionDuration, SpaceChange} -ExecuteActionDuration : PT1M -ExecuteActionInitiatedBy : User -ExecuteActionInitiatedTime : 4/21/2016 3:24:47 PM -ExecuteActionStartTime : 4/21/2016 3:24:47 PM -ImplementationDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionImplementationInfo -IsArchivedAction : False -IsExecutableAction : True -IsRevertableAction : True -LastRefresh : 4/21/2016 3:24:47 PM -LinkedObjects : {} -ObservedImpact : {CpuUtilization, LogicalReads, LogicalWrites, QueriesWithImprovedPerformance...} -RecommendationReason : -RevertActionDuration : -RevertActionInitiatedBy : -RevertActionInitiatedTime : -RevertActionStartTime : -Score : 2 -State : Microsoft.Azure.Management.Sql.Models.RecommendedActionStateInfo -TimeSeries : {} -ValidSince : 4/21/2016 3:24:47 PM - -DatabaseName : WIRunner -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : CreateIndex -RecommendedActionName : IR_[test_schema]_[test_table_0.236046]_6C7AE8CC9C87E7FD5893 -Details : {[indexName, nci_wi_test_table_0.236046_6C7AE8CC9C87E7FD5893], [indexType, NONCLUSTERED], - [schema, [test_schema]], [table, [test_table_0.236046]]...} -ErrorDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionErrorInfo -EstimatedImpact : {ActionDuration, SpaceChange} -ExecuteActionDuration : PT1M -ExecuteActionInitiatedBy : User -ExecuteActionInitiatedTime : 4/21/2016 3:24:47 PM -ExecuteActionStartTime : 4/21/2016 3:24:47 PM -ImplementationDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionImplementationInfo -IsArchivedAction : False -IsExecutableAction : True -IsRevertableAction : True -LastRefresh : 4/21/2016 3:24:47 PM -LinkedObjects : {} -ObservedImpact : {SpaceChange} -RecommendationReason : -RevertActionDuration : -RevertActionInitiatedBy : -RevertActionInitiatedTime : -RevertActionStartTime : -Score : 3 -State : Microsoft.Azure.Management.Sql.Models.RecommendedActionStateInfo -TimeSeries : {} -ValidSince : 4/21/2016 3:24:47 PM -DatabaseName : WIRunner -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : CreateIndex -RecommendedActionName : IR_[test_schema]_[test_table_0.239359]_6C7AE8CC9C87E7FD5893 -Details : {[indexName, nci_wi_test_table_0.239359_6C7AE8CC9C87E7FD5893], [indexType, NONCLUSTERED], - [schema, [test_schema]], [table, [test_table_0.239359]]...} -ErrorDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionErrorInfo -EstimatedImpact : {ActionDuration, SpaceChange} -ExecuteActionDuration : PT1M -ExecuteActionInitiatedBy : User -ExecuteActionInitiatedTime : 4/21/2016 3:24:47 PM -ExecuteActionStartTime : 4/21/2016 3:24:47 PM -ImplementationDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionImplementationInfo -IsArchivedAction : False -IsExecutableAction : True -IsRevertableAction : True -LastRefresh : 4/21/2016 3:24:47 PM -LinkedObjects : {} -ObservedImpact : {CpuUtilization, LogicalReads, LogicalWrites, QueriesWithImprovedPerformance...} -RecommendationReason : -RevertActionDuration : PT10S -RevertActionInitiatedBy : System -RevertActionInitiatedTime : 4/21/2016 3:24:47 PM -RevertActionStartTime : 4/21/2016 3:24:47 PM -Score : 3 -State : Microsoft.Azure.Management.Sql.Models.RecommendedActionStateInfo -TimeSeries : {} -ValidSince : 4/21/2016 3:24:47 PM -``` - -This command gets a list of all recommended actions of the Advisor named CreateIndex available for the database named wi-runner-australia-east. - -### Example 2: Get a single recommended action for an Advisor -``` -PS C:\>Get-AzureRmSqlDatabaseRecommendedAction -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -DatabaseName "WIRunner" -AdvisorName "CreateIndex" -RecommendedActionName "IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893" -DatabaseName : WIRunner -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : CreateIndex -RecommendedActionName : IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893 -Details : {[indexName, nci_wi_test_table_0.0361551_6C7AE8CC9C87E7FD5893], [indexType, - NONCLUSTERED], [schema, [test_schema]], [table, [test_table_0.0361551]]...} -ErrorDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionErrorInfo -EstimatedImpact : {ActionDuration, SpaceChange} -ExecuteActionDuration : PT1M -ExecuteActionInitiatedBy : User -ExecuteActionInitiatedTime : 4/21/2016 3:24:47 PM -ExecuteActionStartTime : 4/21/2016 3:24:47 PM -ImplementationDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionImplementationInfo -IsArchivedAction : False -IsExecutableAction : True -IsRevertableAction : True -LastRefresh : 4/21/2016 3:24:47 PM -LinkedObjects : {} -ObservedImpact : {CpuUtilization, LogicalReads, LogicalWrites, QueriesWithImprovedPerformance...} -RecommendationReason : -RevertActionDuration : -RevertActionInitiatedBy : -RevertActionInitiatedTime : -RevertActionStartTime : -Score : 2 -State : Microsoft.Azure.Management.Sql.Models.RecommendedActionStateInfo -TimeSeries : {} -ValidSince : 4/21/2016 3:24:47 PM -``` - -This command gets the recommended action named IR_\[test_schema\]_\[test_table_0.0361551\]_6C7AE8CC9C87E7FD5893 for the Advisor named CreateIndex. - -## PARAMETERS - -### -AdvisorName -Specifies the name of the Advisor for which this cmdlet requests recommended actions. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the database for which this cmdlet requests recommended actions. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecommendedActionName -Specifies the name of the recommended action that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies name of the resource group of the server that contains this database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server the database is in. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.RecommendedAction.Model.AzureSqlDatabaseRecommendedActionModel - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql, advisor, recommendedaction - -## RELATED LINKS - -[Get-AzureRmSqlDatabaseAdvisor](./Get-AzureRmSqlDatabaseAdvisor.md) - -[Get-AzureRmSqlServerRecommendedAction](./Get-AzureRmSqlServerRecommendedAction.md) - -[Set-AzureRmSqlDatabaseRecommendedActionState](./Set-AzureRmSqlDatabaseRecommendedActionState.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseReplicationLink.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseReplicationLink.md deleted file mode 100644 index c7c359f001..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseReplicationLink.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 40054224-52FF-4AF6-A090-9F6D07A2BA99 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqldatabasereplicationlink -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseReplicationLink.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseReplicationLink.md ---- - -# Get-AzureRmSqlDatabaseReplicationLink - -## SYNOPSIS -Gets the geo-replication links between an Azure SQL Database and a resource group or SQL Server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByDatabaseName (Default) -``` -Get-AzureRmSqlDatabaseReplicationLink [-DatabaseName] <String> -PartnerResourceGroupName <String> - [-ServerName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ByPartnerServerName -``` -Get-AzureRmSqlDatabaseReplicationLink [-DatabaseName] <String> -PartnerResourceGroupName <String> - [-PartnerServerName <String>] [-ServerName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRMSqlDatabaseReplicationLink** cmdlet replaces the **Get-AzureSqlDatabaseCopy** cmdlet. -It gets all geo-replication links between the specified Azure SQL Database and a resource group or AzureSQL Server. - -## EXAMPLES - -## PARAMETERS - -### -DatabaseName -Specifies the name of the SQL Database for which to retrieve links. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PartnerResourceGroupName -Specifies the name of the resource group to which the partner is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PartnerServerName -Specifies the name of the Azure SQL Server for the partner. - -```yaml -Type: System.String -Parameter Sets: ByPartnerServerName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the Azure resource group for the database for which to retrieve links. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the SQL Server for the database to retrieve links for. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Replication.Model.AzureReplicationLinkModel - -## NOTES - -## RELATED LINKS - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseRestorePoints.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseRestorePoints.md deleted file mode 100644 index 6b100d6829..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseRestorePoints.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 67A9BB67-CF17-4CAA-99D9-002D0D23178B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqldatabaserestorepoints -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseRestorePoints.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseRestorePoints.md ---- - -# Get-AzureRmSqlDatabaseRestorePoints - -## SYNOPSIS -Retrieves the distinct restore points from which a SQL Data Warehouse can be restored. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlDatabaseRestorePoints [-ServerName] <String> [-DatabaseName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlDatabaseRestorePoints** cmdlet retrieves the distinct restore points that an Azure SQL Data Warehouse can be restored from. -For an Azure SQL Database, the restore window is continuous. -This means that any point in time in the backup retention period of the database can be used as a restore point. -This cmdlet is also supported by the SQL Server Stretch Database service on Azure. - -## EXAMPLES - -### Example 1: Get all restore points -``` -PS C:\>Get-AzureRmSqlDatabaseRestorePoints -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -ResourceGroupName : resourcegroup01 -ServerName : server01 -DatabaseName : database01 -Location : Central US -RestorePointType : CONTINUOUS -RestorePointCreationDate : -EarliestRestoreDate : 8/12/2015 12:00:00 AM -RestorePointLabel : RestorePoint01 -``` - -This command returns all available restore points for the Azure SQL Database named Database01. - -## PARAMETERS - -### -DatabaseName -Specifies the name of the SQL Database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the SQL Database is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the AzureSQL Server that hosts the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlDatabaseRestorePointModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseSecureConnectionPolicy.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseSecureConnectionPolicy.md deleted file mode 100644 index cb1130a70d..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseSecureConnectionPolicy.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: F22E14D6-B18B-4136-B1DF-710DA34372C3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqldatabasesecureconnectionpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseSecureConnectionPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseSecureConnectionPolicy.md ---- - -# Get-AzureRmSqlDatabaseSecureConnectionPolicy - -## SYNOPSIS -Gets the secure connection policy for a database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlDatabaseSecureConnectionPolicy [-ServerName] <String> [-DatabaseName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlDatabaseSecureConnectionPolicy** cmdlet gets the encrypted channel policy of an Azure SQL database. -To use the cmdlet, use the *ResourceGroupName*, *ServerName*, and *DatabaseName* parameters to identify the database. -After this cmdlet runs successfully, it returns an object that describes the current encrypted channel policy and also the database identifiers. -Database identifiers include, but are not limited to, **ResourceGroupName**, **ServerName**, and **DatabaseName**. -This cmdlet is also supported by the SQL Server Stretch Database service on Azure. - -## EXAMPLES - -### Example 1: Get the encrypted channel policy of an Azure SQL database -``` -PS C:\>Get-AzureRmSqlDatabaseSecureConnectionPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -DatabaseName : database01 -ConnectionStrings : Microsoft.Azure.Commands.Sql.SecureConnection.Model.ConnectionStrings -ResourceGroupName : resourcegroup01 -ServerName : server01 -ProxyDnsName : server01.database.secure.windows.net -ProxyPort : 1433 -SecureConnectionState : Optional -``` - -This command gets the encrypted channel policy of an Azure SQL database named database01 located on server server01. - -## PARAMETERS - -### -DatabaseName -Specifies the name of the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the database is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of server that hosts the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.SecureConnection.Model.DatabaseSecureConnectionPolicyModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseThreatDetectionPolicy.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseThreatDetectionPolicy.md deleted file mode 100644 index af8988899b..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseThreatDetectionPolicy.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 017EF522-ABC5-40EE-B8DC-369D097F49D0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqldatabasethreatdetectionpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseThreatDetectionPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseThreatDetectionPolicy.md ---- - -# Get-AzureRmSqlDatabaseThreatDetectionPolicy - -## SYNOPSIS -Gets the threat detection policy for a database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlDatabaseThreatDetectionPolicy [-ServerName] <String> [-DatabaseName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlDatabaseThreatDetectionPolicy** cmdlet gets the threat detection policy of an Azure SQL database. -To use this cmdlet, specify the *ResourceGroupName*, *ServerName*, and *DatabaseName* parameters to identify the database for which this cmdlet gets the policy. - -## EXAMPLES - -### Example 1: Get the threat detection policy for a database -``` -PS C:\>Get-AzureRmSqlDatabaseThreatDetectionPolicy -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" -DatabaseName : Database01 -ResourceGroupName : ResourceGroup11 -ServerName : Server01 -ThreatDetectionState : Enabled -NotificationRecipientsEmails : admin@myCompany.com -StorageAccountName : mystorage -EmailAdmins : True -ExcludedDetectionTypes : {} -RetentionInDays : 0 -``` - -This command gets the threat detection policy for a database named Database01. -The database is located on the server named Server01, which is assigned to the resource group ResourceGroup11. - -## PARAMETERS - -### -DatabaseName -Specifies the name of a database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the server is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of a server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ThreatDetection.Model.DatabaseThreatDetectionPolicyModel - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmSqlDatabaseThreatDetectionPolicy](./Remove-AzureRmSqlDatabaseThreatDetectionPolicy.md) - - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseTransparentDataEncryption.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseTransparentDataEncryption.md deleted file mode 100644 index 4252d434da..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseTransparentDataEncryption.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 2328631F-BC30-40E3-ADF7-B1D3B46A6E34 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqldatabasetransparentdataencryption -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseTransparentDataEncryption.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseTransparentDataEncryption.md ---- - -# Get-AzureRmSqlDatabaseTransparentDataEncryption - -## SYNOPSIS -Gets the TDE state for a database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlDatabaseTransparentDataEncryption [-ServerName] <String> [-DatabaseName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlDatabaseTransparentDataEncryption** cmdlet gets the state of Transparent Data Encryption (TDE) for an Azure SQL database. -For more information, see Transparent Data Encryption with Azure SQL Databasehttps://msdn.microsoft.com/library/dn948096 (https://msdn.microsoft.com/library/dn948096) in the Microsoft Developer Network Library. -This cmdlet gets the current state of TDE, but both encryption and decryption can be long-running operations. -To see the encryption scan progress, run the Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity cmdlet. -This cmdlet is also supported by the SQL Server Stretch Database service on Azure. - -## EXAMPLES - -### Example 1: Get TDE status for a database -``` -PS C:\>Get-AzureRmSqlDatabaseTransparentDataEncryption -ServerName "server01" -ResourceGroupName "resourcegroup01" -DatabaseName "database01" -ResourceGroupName ServerName DatabaseName State ------------------ ---------- ------------ ----- -resourcegroup01 server01 database01 Disabled -``` - -This command gets the status of TDE for the database named Database01 on the server named server01. - -## PARAMETERS - -### -DatabaseName -Specifies the name of the database for which this cmdlet gets TDE status. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the database is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server that hosts the database for which this cmdlet gets TDE status. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.AzureSqlDatabaseTransparentDataEncryptionModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity](./Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity.md) - -[Set-AzureRmSqlDatabaseTransparentDataEncryption](./Set-AzureRmSqlDatabaseTransparentDataEncryption.md) diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity.md deleted file mode 100644 index c2c72d53f0..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 7506FCEC-F96C-4918-8F20-A4B260F4DE1C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqldatabasetransparentdataencryptionactivity -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity.md ---- - -# Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity - -## SYNOPSIS -Gets the progress of a TDE scan of a database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity [-ServerName] <String> [-DatabaseName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity** cmdlet gets the progress of a Transparent Data Encryption (TDE) scan of an Azure SQL database. -If no encryption span is running, this cmdlet returns an empty list. -For more information, see Transparent Data Encryption with Azure SQL Databasehttps://msdn.microsoft.com/library/dn948096 (https://msdn.microsoft.com/library/dn948096) in the Microsoft Developer Network Library. -This cmdlet is also supported by the SQL Server Stretch Database service on Azure. - -## EXAMPLES - -### Example 1: Get TDE activity for a database -``` -PS C:\>Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity -ServerName "server01" -ResourceGroupName "resourcegroup01" -DatabaseName "database01" -ResourceGroupName : resourcegroup01 -ServerName : server01 -DatabaseName : database01 -Status : Encrypting -PercentComplete : 3.662109 -``` - -This command gets the TDE activity for the database named database01 on the server named server01. - -## PARAMETERS - -### -DatabaseName -Specifies the name of the database for which this cmdlet gets TDE encryption activity. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the database is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.AzureSqlDatabaseTransparentDataEncryptionActivityModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlDatabaseTransparentDataEncryption](./Get-AzureRmSqlDatabaseTransparentDataEncryption.md) - -[Set-AzureRmSqlDatabaseTransparentDataEncryption](./Set-AzureRmSqlDatabaseTransparentDataEncryption.md) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseUpgradeHint.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseUpgradeHint.md deleted file mode 100644 index acaef9d4fc..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseUpgradeHint.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: D64FB139-04E2-47BC-86FB-EEEA23839F2F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqldatabaseupgradehint -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseUpgradeHint.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseUpgradeHint.md ---- - -# Get-AzureRmSqlDatabaseUpgradeHint - -## SYNOPSIS -Gets pricing tier hints for a database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlDatabaseUpgradeHint [-ServerName] <String> [-DatabaseName <String>] - [-ExcludeElasticPoolCandidates <Boolean>] [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlDatabaseUpgradeHint** cmdlet gets pricing tier hints for upgrading an Azure SQL Database. -Databases that are still in Web and Business pricing tiers get the hint to upgrade to the new Basic, Standard, or Premium pricing tiers. -This cmdlet is also supported by the SQL Server Stretch Database service on Azure. - -## EXAMPLES - -### Example 1: Get recommendations for all databases on a server -``` -PS C:\>Get-AzureRmSqlDatabaseUpgradeHint -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -``` - -This command returns upgrade hints for all databases on the server named Server01. - -### Example 2: Get recommendations for specific database -``` -PS C:\>Get-AzureRmSqlDatabaseUpgradeHint -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -``` - -This command returns upgrade hints for a specific database. - -### Example 3: Get recommendation for all databases that are not in an elastic database pool -``` -PS C:\>Get-AzureRmSqlDatabaseUpgradeHint -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ExcludeElasticPoolCandidates $True -``` - -This command returns upgrade hints for all databases that are not in an elastic database pool. - -## PARAMETERS - -### -DatabaseName -Specifies the name of the SQL database for which this cmdlet gets an upgrade hint. -If you do not specify a database, this cmdlet gets hints for all databases on the logical server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeElasticPoolCandidates -Indicates whether databases in elastic database pools are excluded from the returned recommendations. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the database is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server that hosts the database for which this cmdlet gets an upgrade hint. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Boolean - -## OUTPUTS - -### Microsoft.Azure.Management.Sql.LegacySdk.Models.RecommendedDatabaseProperties - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlDatabaseExpanded](./Get-AzureRmSqlDatabaseExpanded.md) - -[Get-AzureRmSqlElasticPoolRecommendation](./Get-AzureRmSqlElasticPoolRecommendation.md) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline.md deleted file mode 100644 index f79210b516..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqldatabasevulnerabilityassessmentrulebaseline -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline.md ---- - -# Get-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline - -## SYNOPSIS -Gets the vulnerability assessment rule baseline. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline [-InputObject <AzureSqlDatabaseModel>] - -RuleId <String> [-RuleAppliesToMaster] [-ServerName] <String> [-DatabaseName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline** cmdlet gets the vulnerability assessment rule baseline. -Note that you need to run *Enable-AzureRmSqlServerAdvancedThreatProtection* and *Set-AzureRmSqlDatabaseVulnerabilityAssessmentSettings* cmdlets as a prerequisite for using this cmdlet. - -## EXAMPLES - -### Example 1 - Get the vulnerability assessment rule baseline -```powershell -PS C:\> Get-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline ` - -ResourceGroupName "ResourceGroup01" ` - -ServerName "Server01" ` - -DatabaseName "Database01" ` - -RuleId "VA2108" ` - -RuleAppliesToMaster - -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -RuleId : VA2108 -RuleAppliesToMaster : True -BaselineResult : @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') -``` - -### Example 2 - Get the vulnerability assessment rule baseline from a database object -```powershell -PS C:\> Get-AzureRmSqlDatabase ` - -ResourceGroupName "ResourceGroup01" ` - -ServerName "Server01" ` - -DatabaseName "Database01" ` - | Get-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline - -RuleId "VA2108" - -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -RuleId : VA2108 -RuleAppliesToMaster : False -BaselineResult : @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') -``` - -## PARAMETERS - -### -DatabaseName -SQL Database name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The database object to get Vulnerability Assessment rule baseline for - -```yaml -Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RuleAppliesToMaster -Specifies whether the baseline results should apply on a server level rule identified by the RuleId - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RuleId -The rule ID which identifies the rule to set the baseline results to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -SQL Database server name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel -Parameters: InputObject (ByValue) - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.DatabaseVulnerabilityAssessmentRuleBaselineModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseVulnerabilityAssessmentScanRecord.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseVulnerabilityAssessmentScanRecord.md deleted file mode 100644 index 5be5d3cdf3..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseVulnerabilityAssessmentScanRecord.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqldatabasevulnerabilityassessmentscanrecord -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseVulnerabilityAssessmentScanRecord.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseVulnerabilityAssessmentScanRecord.md ---- - -# Get-AzureRmSqlDatabaseVulnerabilityAssessmentScanRecord - -## SYNOPSIS -Gets all vulnerability assessment scan record(s) associated with a given database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlDatabaseVulnerabilityAssessmentScanRecord [-InputObject <AzureSqlDatabaseModel>] - [-ScanId <String>] [-ServerName] <String> [-DatabaseName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlDatabaseVulnerabilityAssessmentScanRecord** cmdlet retrieves all vulnerability assessment scan record(s) associated with a given database. -Note that you need to run *Enable-AzureRmSqlServerAdvancedThreatProtection* and *Set-AzureRmSqlDatabaseVulnerabilityAssessmentSettings* cmdlet as a prerequisite for using this cmdlets. - -## EXAMPLES - -### Example 1 - Gets a specific vulnerability assessment scan results identified by the scan ID -```powershell -PS C:\> Get-AzureRmSqlDatabaseVulnerabilityAssessmentScanRecord ` - -ResourceGroupName "ResourceGroup01" ` - -ServerName "Server01" ` - -DatabaseName "Database01" ` - -ScanId "myScan" - -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -ScanId : myScan -TriggerType : OnDemand -State : Passed -StartTime : 6/11/2018 1:57:27 PM -EndTime : 6/11/2018 1:57:31 PM -Errors : {} -ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment - scans/Server01/Database01/scan_myScan/.json -NumberOfFailedSecurityChecks : 9 -``` - -### Example 2 - Gets a specific vulnerability assessment scan results identified by the scan ID with database object -```powershell -PS C:\> Get-AzureRmSqlDatabase ` - -ResourceGroupName "ResourceGroup01" ` - -ServerName "Server01" ` - -DatabaseName "Database01" ` - | Get-AzureRmSqlDatabaseVulnerabilityAssessmentScanRecord ` - -ScanId "myScan" - -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -ScanId : myScan -TriggerType : OnDemand -State : Passed -StartTime : 6/11/2018 1:57:27 PM -EndTime : 6/11/2018 1:57:31 PM -Errors : {} -ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment - scans/Server01/Database01/scan_myScan/.json -NumberOfFailedSecurityChecks : 9 -``` - -### Example 3 - Gets all vulnerability assessment scan results on the specified databsae -```powershell -PS C:\> Get-AzureRmSqlDatabase ` - -ResourceGroupName "ResourceGroup01" ` - -ServerName "Server01" ` - -DatabaseName "Database01" ` - | Get-AzureRmSqlDatabaseVulnerabilityAssessmentScanRecord - -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -ScanId : myScan -TriggerType : OnDemand -State : Passed -StartTime : 6/11/2018 1:57:27 PM -EndTime : 6/11/2018 1:57:31 PM -Errors : {} -ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment - scans/Server01/Database01/scan_myScan/.json -NumberOfFailedSecurityChecks : 9 - - -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -ScanId : myScan1 -TriggerType : OnDemand -State : Passed -StartTime : 6/12/2018 1:57:27 PM -EndTime : 6/12/2018 1:57:31 PM -Errors : {} -ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment - scans/Server01/Database01/scan_myScan/.json -NumberOfFailedSecurityChecks : 9 -``` - -## PARAMETERS - -### -DatabaseName -SQL Database name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The database object to get Vulnerability Assessment scan record for - -```yaml -Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScanId -Specifies the scan ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -SQL Database server name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.DatabaseVulnerabilityAssessmentScanRecordModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseVulnerabilityAssessmentSettings.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseVulnerabilityAssessmentSettings.md deleted file mode 100644 index cc5426cbfb..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlDatabaseVulnerabilityAssessmentSettings.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqldatabasevulnerabilityassessmentsettings -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseVulnerabilityAssessmentSettings.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseVulnerabilityAssessmentSettings.md ---- - -# Get-AzureRmSqlDatabaseVulnerabilityAssessmentSettings - -## SYNOPSIS -Gets the vulnerability assessment settings of a database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlDatabaseVulnerabilityAssessmentSettings [-InputObject <AzureSqlDatabaseModel>] - [-ServerName] <String> [-DatabaseName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlDatabaseVulnerabilityAssessmentSettings** cmdlet gets the vulnerability assessment settings of an Azure SQL Database. -Note that you need to run *Enable-AzureRmSqlServerAdvancedThreatProtection* cmdlet as a prerequisite for using this cmdlet. - -## EXAMPLES - -### Example 1 - Get the vulnerability assessment settings of an Azure SQL database -```powershell -PS C:\> Get-AzureRmSqlDatabaseVulnerabilityAssessmentSettings ` - -ResourceGroupName "ResourceGroup01" ` - -ServerName "Server01" ` - -DatabaseName "Database01" - -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -StorageAccountName : mystorage -ScanResultsContainerName : vulnerability-assessment -RecurringScansInterval : None -EmailSubscriptionAdmins : False -NotificationEmail : {} -``` - -### Example 2 - Get the vulnerability assessment settings of an Azure SQL database from an Azure SQL database object -```powershell -PS C:\> Get-AzureRmSqlDatabase ` - -ResourceGroupName "ResourceGroup01" ` - -ServerName "Server01" ` - -DatabaseName "Database01" ` - | Get-AzureRmSqlDatabaseVulnerabilityAssessmentSettings - -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -StorageAccountName : mystorage -ScanResultsContainerName : vulnerability-assessment -RecurringScansInterval : None -EmailSubscriptionAdmins : False -NotificationEmail : {} -``` - -## PARAMETERS - -### -DatabaseName -SQL Database name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The database object to get Vulnerability Assessment settings for - -```yaml -Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -SQL Database server name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.DatabaseVulnerabilityAssessmentSettingsModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlElasticPool.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlElasticPool.md deleted file mode 100644 index b87c26196b..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlElasticPool.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 350E19F6-5B1C-4D3F-B4CD-7225CDC984C4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlelasticpool -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPool.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPool.md ---- - -# Get-AzureRmSqlElasticPool - -## SYNOPSIS -Gets elastic pools and their property values in an Azure SQL Database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlElasticPool [[-ElasticPoolName] <String>] [-ServerName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlElasticPool** cmdlet gets elastic pools and their property values. -Specify the name of an existing elastic pool to see the property values for only that pool. - -## EXAMPLES - -### Example 1: Get all elastic pools -``` -PS C:\>Get-AzureRmSqlElasticPool -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 -ResourceGroupName : resourcegroup01 -ServerName : server01 -ElasticPoolName : elasticpool01 -Location : Central US -CreationDate : 8/26/2015 10:00:17 PM -State : Ready -Edition : Standard -Dtu : 400 -DatabaseDtuMax : 100 -DatabaseDtuMin : 10 -StorageMB : 409600 -Tags : - -ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool02 -ResourceGroupName : resourcegroup01 -ServerName : server01 -ElasticPoolName : elasticpool02 -Location : Central US -CreationDate : 8/26/2015 11:00:17 PM -State : Ready -Edition : Standard -Dtu : 400 -DatabaseDtuMax : 100 -DatabaseDtuMin : 10 -StorageMB : 409600 -Tags : -``` - -This command gets all of the elastic pools on the server named Server01. - -### Example 2: Get a specific elastic pool -``` -PS C:\>Get-AzureRmSqlElasticPool -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ElasticPoolName "ElasticPool27" -ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 -ResourceGroupName : resourcegroup01 -ServerName : server01 -ElasticPoolName : elasticpool01 -Location : Central US -CreationDate : 8/26/2015 10:00:17 PM -State : Ready -Edition : Standard -Dtu : 400 -DatabaseDtuMax : 100 -DatabaseDtuMin : 10 -StorageMB : 409600 -Tags : -``` - -This command gets the elastic pool named ElasticPool0127 on the server named Server01. - -### Example 3: Get metrics for a Azure SQL Elastic Database Pool -``` -PS C:\>Get-AzureRmSqlElasticPool -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ElasticPoolName "ElasticPool01" | Get-Metrics -TimeGrain 0:5:0 -DimensionName : -DimensionValue : -Name : cpu_percent -EndTime : 8/27/2015 5:22:25 PM -MetricValues : {Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue...} -Properties : {} -ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 -StartTime : 8/27/2015 4:20:00 PM -TimeGrain : 00:05:00 -Unit : Percent - -DimensionName : -DimensionValue : -Name : physical_data_read_percent -EndTime : 8/27/2015 5:22:25 PM -MetricValues : {Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue...} -Properties : {} -ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 -StartTime : 8/27/2015 4:20:00 PM -TimeGrain : 00:05:00 -Unit : Percent - -DimensionName : -DimensionValue : -Name : log_write_percent -EndTime : 8/27/2015 5:22:25 PM -MetricValues : {Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue...} -Properties : {} -ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 -StartTime : 8/27/2015 4:20:00 PM -TimeGrain : 00:05:00 -Unit : Percent - -DimensionName : -DimensionValue : -Name : dtu_consumption_percent -EndTime : 8/27/2015 5:22:25 PM -MetricValues : {Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue...} -Properties : {} -ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 -StartTime : 8/27/2015 4:20:00 PM -TimeGrain : 00:05:00 -Unit : Percent - -DimensionName : -DimensionValue : -Name : storage_percent -EndTime : 8/27/2015 5:22:25 PM -MetricValues : {Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue...} -Properties : {} -ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 -StartTime : 8/27/2015 4:20:00 PM -TimeGrain : 00:05:00 -Unit : Percent -``` - -This command returns metrics for an Azure SQL elastic database pool named ElasticPool01. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ElasticPoolName -Specifies the name of the elastic pool that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the elastic pool that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server that contains the elastic pool that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolModel - -## NOTES - -## RELATED LINKS - -[New-AzureRmSqlElasticPool](./New-AzureRmSqlElasticPool.md) - -[Remove-AzureRmSqlElasticPool](./Remove-AzureRmSqlElasticPool.md) - -[Set-AzureRmSqlElasticPool](./Set-AzureRmSqlElasticPool.md) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlElasticPoolActivity.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlElasticPoolActivity.md deleted file mode 100644 index 8607f96353..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlElasticPoolActivity.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 0DB0B08A-F948-4F6E-9CF0-2FB5DD5064D3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlelasticpoolactivity -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPoolActivity.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPoolActivity.md ---- - -# Get-AzureRmSqlElasticPoolActivity - -## SYNOPSIS -Gets the status of operations on an elastic pool. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlElasticPoolActivity [-ServerName] <String> [-ElasticPoolName] <String> [-OperationId <Guid>] - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlElasticPoolActivity** cmdlet gets the status of operations on an elastic pool for an Azure SQL Database. -You can see the status of both pool creation and configuration updates. - -## EXAMPLES - -### Example 1: Get the status of operations for an elastic pool -``` -PS C:\>Get-AzureRmSqlElasticPoolActivity -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ElasticPoolName "ElasticPool01" -``` - -This command gets the status of the operations for the elastic pool named ElasticPool01. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ElasticPoolName -Specifies the name of an elastic pool. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OperationId -The ID of the operation to retrieve. - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group to which the elastic pool is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of a server that contains an elastic pool. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolActivityModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlElasticPool](./Get-AzureRmSqlElasticPool.md) - -[Get-AzureRmSqlElasticPoolDatabase](./Get-AzureRmSqlElasticPoolDatabase.md) - -[New-AzureRmSqlElasticPool](./New-AzureRmSqlElasticPool.md) - -[Remove-AzureRmSqlElasticPool](./Remove-AzureRmSqlElasticPool.md) - -[Set-AzureRmSqlElasticPool](./Set-AzureRmSqlElasticPool.md) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlElasticPoolAdvisor.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlElasticPoolAdvisor.md deleted file mode 100644 index 3e9b5b3607..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlElasticPoolAdvisor.md +++ /dev/null @@ -1,292 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: BC8C0D59-662F-47D2-8619-9F69D78B171D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlelasticpooladvisor -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPoolAdvisor.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPoolAdvisor.md ---- - -# Get-AzureRmSqlElasticPoolAdvisor - -## SYNOPSIS -Gets one or more Advisors for an Azure SQL Elastic Pool. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlElasticPoolAdvisor [-AdvisorName <String>] [-ExpandRecommendedActions] -ServerName <String> - -ElasticPoolName <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlElasticPoolAdvisor** cmdlet gets one or more Azure SQL Elastic Pool Advisors for an Azure SQL Elastic Pool. - -## EXAMPLES - -### Example 1: List all the advisors for the specified elastic pool -``` -PS C:\>Get-AzureRmSqlElasticPoolAdvisor -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -PoolName "WIRunnerPool" -ElasticPoolName : WIRunnerPool -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : CreateIndex -AdvisorStatus : GA -AutoExecuteStatus : Disabled -AutoExecuteStatusInheritedFrom : Database -LastChecked : 8/1/2016 2:36:47 PM -RecommendationsStatus : Ok -RecommendedActions : {} - -ElasticPoolName : WIRunnerPool -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : DropIndex -AdvisorStatus : PublicPreview -AutoExecuteStatus : Disabled -AutoExecuteStatusInheritedFrom : Database -LastChecked : 7/31/2016 8:41:19 PM -RecommendationsStatus : Ok -RecommendedActions : {} - -ElasticPoolName : WIRunnerPool -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : DbParameterization -AdvisorStatus : PublicPreview -AutoExecuteStatus : Disabled -AutoExecuteStatusInheritedFrom : Default -LastChecked : 7/31/2016 2:46:58 PM -RecommendationsStatus : NoDbParameterizationIssue -RecommendedActions : {} - -ElasticPoolName : WIRunnerPool -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : SchemaIssue -AdvisorStatus : PublicPreview -AutoExecuteStatus : Disabled -AutoExecuteStatusInheritedFrom : Default -LastChecked : 8/1/2016 3:01:41 PM -RecommendationsStatus : SchemaIsConsistent -RecommendedActions : {} -``` - -The command gets lists all the advisors for the elastic pool named WIRunnerPool. - -### Example 2: Get a single advisor for the specified elastic pool -``` -PS C:\>Get-AzureRmSqlElasticPoolAdvisor -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -ElasticPoolName "WIRunnerPool" -AdvisorName "CreateIndex" -ElasticPoolName : WIRunnerPool -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : CreateIndex -AdvisorStatus : GA -AutoExecuteStatus : Disabled -AutoExecuteStatusInheritedFrom : Database -LastChecked : 8/1/2016 2:36:47 PM -RecommendationsStatus : Ok -RecommendedActions : {} -``` - -This command gets the Advisor named CreateIndex for the elastic pool named WIRunnerPool. - -### Example 3: List all the advisors with their recommended actions included in the response -``` -PS C:\>Get-AzureRmSqlElasticPoolAdvisor -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -ElasticPoolName "WIRunnerPool" -ExpandRecommendedActions -ElasticPoolName : WIRunnerPool -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : CreateIndex -AdvisorStatus : GA -AutoExecuteStatus : Disabled -AutoExecuteStatusInheritedFrom : Database -LastChecked : 8/1/2016 2:36:47 PM -RecommendationsStatus : Ok -RecommendedActions : {IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893, - IR_[test_schema]_[test_table_0.236046]_6C7AE8CC9C87E7FD5893, - IR_[test_schema]_[test_table_0.239359]_6C7AE8CC9C87E7FD5893, - IR_[test_schema]_[test_table_0.437714]_6C7AE8CC9C87E7FD5893...} - -ElasticPoolName : WIRunnerPool -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : DropIndex -AdvisorStatus : PublicPreview -AutoExecuteStatus : Disabled -AutoExecuteStatusInheritedFrom : Database -LastChecked : 7/31/2016 8:41:19 PM -RecommendationsStatus : Ok -RecommendedActions : {IR_[test_schema]_[test_table_0.0288891]_38724E1DCF2178318957, - IR_[test_schema]_[test_table_0.140264]_38724E1DCF2178318957, - IR_[test_schema]_[test_table_0.412191]_38724E1DCF2178318957, - IR_[test_schema]_[test_table_0.442075]_38724E1DCF2178318957...} - -ElasticPoolName : WIRunnerPool -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : DbParameterization -AdvisorStatus : PublicPreview -AutoExecuteStatus : Disabled -AutoExecuteStatusInheritedFrom : Default -LastChecked : 7/31/2016 2:46:58 PM -RecommendationsStatus : NoDbParameterizationIssue -RecommendedActions : {} - -ElasticPoolName : WIRunnerPool -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : SchemaIssue -AdvisorStatus : PublicPreview -AutoExecuteStatus : Disabled -AutoExecuteStatusInheritedFrom : Default -LastChecked : 8/1/2016 3:04:26 PM -RecommendationsStatus : SchemaIsConsistent -RecommendedActions : {} -``` - -This command gets all the advisors for the elastic pool with their recommended actions included in the response. - -### Example 4: Get a single advisor with its recommended actions included in the response -``` -PS C:\>Get-AzureRmSqlElasticPoolAdvisor -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -ElasticPoolName "WIRunnerPool" -AdvisorName "CreateIndex" -ExpandRecommendedActions -ElasticPoolName : WIRunnerPool -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : CreateIndex -AdvisorStatus : GA -AutoExecuteStatus : Disabled -AutoExecuteStatusInheritedFrom : Database -LastChecked : 8/1/2016 2:36:47 PM -RecommendationsStatus : Ok -RecommendedActions : {IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893, - IR_[test_schema]_[test_table_0.236046]_6C7AE8CC9C87E7FD5893, - IR_[test_schema]_[test_table_0.239359]_6C7AE8CC9C87E7FD5893, - IR_[test_schema]_[test_table_0.437714]_6C7AE8CC9C87E7FD5893...} -``` - -This command gets advisor named CreateIndex from the server named wi-runner-australia-east with its recommended actions included in the response. - -## PARAMETERS - -### -AdvisorName -Specifies the name of the Advisor that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ElasticPoolName -Specifies the name of the elastic pool for which this cmdlet requests the Advisor. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExpandRecommendedActions -Indicates that the cmdlet includes the recommended actions of the Advisor in the response. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the server that contains this elastic pool. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server the elastic pool is in. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Advisor.Model.AzureSqlElasticPoolAdvisorModel - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, sql, elasticpool, mssql, advisor - -## RELATED LINKS - -[Get-AzureRmSqlServerAdvisor](./Get-AzureRmSqlServerAdvisor.md) - -[Get-AzureRmSqlDatabaseAdvisor](./Get-AzureRmSqlDatabaseAdvisor.md) - -[Get-AzureRmSqlElasticPoolRecommendedAction](./Get-AzureRmSqlElasticPoolRecommendedAction.md) - -[Set-AzureRmSqlElasticPoolAdvisorAutoExecuteStatus](./Set-AzureRmSqlElasticPoolAdvisorAutoExecuteStatus.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlElasticPoolDatabase.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlElasticPoolDatabase.md deleted file mode 100644 index 7b24968278..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlElasticPoolDatabase.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 14620FBD-4B10-4366-94F7-891BC01B893F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlelasticpooldatabase -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPoolDatabase.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPoolDatabase.md ---- - -# Get-AzureRmSqlElasticPoolDatabase - -## SYNOPSIS -Gets elastic databases in an elastic pool and their property values. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlElasticPoolDatabase [-ElasticPoolName] <String> [-DatabaseName <String>] [-ServerName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlElasticPoolDatabase** cmdlet gets elastic databases in an elastic pool and their property values. -You can specify the name of an elastic database in Azure SQL Database to see the property values for only that database. - -## EXAMPLES - -### Example 1: Get all databases in an elastic pool -``` -PS C:\>Get-AzureRmSqlElasticPoolDatabase -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ElasticPoolName "ElasticPool01" -``` - -This command gets all databases in an elastic pool named ElasticPool01. - -## PARAMETERS - -### -DatabaseName -Specifies the name of the SQL Database that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ElasticPoolName -Specifies the name of an elastic pool. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group to which the elastic pool is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of a server that contains an elastic pool. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlElasticPool](./Get-AzureRmSqlElasticPool.md) - -[Get-AzureRmSqlElasticPoolActivity](./Get-AzureRmSqlElasticPoolActivity.md) - -[New-AzureRmSqlElasticPool](./New-AzureRmSqlElasticPool.md) - -[Remove-AzureRmSqlElasticPool](./Remove-AzureRmSqlElasticPool.md) - -[Set-AzureRmSqlElasticPool](./Set-AzureRmSqlElasticPool.md) - diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlElasticPoolRecommendation.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlElasticPoolRecommendation.md deleted file mode 100644 index e032b91f68..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlElasticPoolRecommendation.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: A1E19A66-CD70-467E-8C59-1F88453905A4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlelasticpoolrecommendation -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPoolRecommendation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPoolRecommendation.md ---- - -# Get-AzureRmSqlElasticPoolRecommendation - -## SYNOPSIS -Gets elastic pool recommendations. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlElasticPoolRecommendation [-ServerName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlElasticPoolRecommendation** cmdlet gets elastic pool recommendations for a server. -These recommendations include the following values: -- DatabaseCollection. Collection of database names that belong to the pool. -- DatabaseDtuMin. Data Transmission Unit (DTU) guarantee for databases in the elastic pool. - -- DatabaseDtuMax. DTU cap for databases in the elastic pool. -- Dtu. DTU guarantee for the elastic pool. -- StorageMb. Storage in megabytes for the elastic pool. -- Edition. Edition for the elastic pool. The acceptable values for this parameter are: Basic, Standard, and Premium. -- IncludeAllDatabases. Indicates whether to all databases in the elastic pool are returned. -- Name. Name of the elastic pool. - -## EXAMPLES - -### Example 1: Get recommendations for a server -``` -PS C:\>Get-AzureRmSqlElasticPoolRecommendation -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -``` - -This command gets the elastic pool recommendations for the server named Server01. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies name of the resource group to which the server is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server for which this cmdlet gets recommendations. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Sql.LegacySdk.Models.UpgradeRecommendedElasticPoolProperties - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlElasticPoolRecommendedAction.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlElasticPoolRecommendedAction.md deleted file mode 100644 index cc807a19c1..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlElasticPoolRecommendedAction.md +++ /dev/null @@ -1,279 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 3FC9E586-3962-437E-B89F-BB4EA1FBF403 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlelasticpoolrecommendedaction -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPoolRecommendedAction.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPoolRecommendedAction.md ---- - -# Get-AzureRmSqlElasticPoolRecommendedAction - -## SYNOPSIS -Gets one or more recommended actions for an Azure SQL Elastic Pool Advisor. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlElasticPoolRecommendedAction [-RecommendedActionName <String>] -ServerName <String> - -ElasticPoolName <String> -AdvisorName <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlElasticPoolRecommendedAction** cmdlet gets one or more recommended actions for an Azure SQL Elastic Pool Advisor. - -## EXAMPLES - -### Example 1: List all recommended actions for an Advisor -``` -PS C:\>Get-AzureRmSqlElasticPoolRecommendedAction -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -ElasticPoolName "WIRunnerPool" -AdvisorName "CreateIndex" -ElasticPoolName : WIRunnerPool -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : CreateIndex -RecommendedActionName : IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893 -Details : {[indexName, nci_wi_test_table_0.0361551_6C7AE8CC9C87E7FD5893], [indexType, - NONCLUSTERED], [schema, [test_schema]], [table, [test_table_0.0361551]]...} -ErrorDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionErrorInfo -EstimatedImpact : {ActionDuration, SpaceChange} -ExecuteActionDuration : PT1M -ExecuteActionInitiatedBy : User -ExecuteActionInitiatedTime : 4/21/2016 3:24:47 PM -ExecuteActionStartTime : 4/21/2016 3:24:47 PM -ImplementationDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionImplementationInfo -IsArchivedAction : False -IsExecutableAction : True -IsRevertableAction : True -LastRefresh : 4/21/2016 3:24:47 PM -LinkedObjects : {} -ObservedImpact : {CpuUtilization, LogicalReads, LogicalWrites, QueriesWithImprovedPerformance...} -RecommendationReason : -RevertActionDuration : -RevertActionInitiatedBy : -RevertActionInitiatedTime : -RevertActionStartTime : -Score : 2 -State : Microsoft.Azure.Management.Sql.Models.RecommendedActionStateInfo -TimeSeries : {} -ValidSince : 4/21/2016 3:24:47 PM - -ElasticPoolName : WIRunnerPool -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : CreateIndex -RecommendedActionName : IR_[test_schema]_[test_table_0.236046]_6C7AE8CC9C87E7FD5893 -Details : {[indexName, nci_wi_test_table_0.236046_6C7AE8CC9C87E7FD5893], [indexType, NONCLUSTERED], - [schema, [test_schema]], [table, [test_table_0.236046]]...} -ErrorDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionErrorInfo -EstimatedImpact : {ActionDuration, SpaceChange} -ExecuteActionDuration : PT1M -ExecuteActionInitiatedBy : User -ExecuteActionInitiatedTime : 4/21/2016 3:24:47 PM -ExecuteActionStartTime : 4/21/2016 3:24:47 PM -ImplementationDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionImplementationInfo -IsArchivedAction : False -IsExecutableAction : True -IsRevertableAction : True -LastRefresh : 4/21/2016 3:24:47 PM -LinkedObjects : {} -ObservedImpact : {SpaceChange} -RecommendationReason : -RevertActionDuration : -RevertActionInitiatedBy : -RevertActionInitiatedTime : -RevertActionStartTime : -Score : 3 -State : Microsoft.Azure.Management.Sql.Models.RecommendedActionStateInfo -TimeSeries : {} -ValidSince : 4/21/2016 3:24:47 PM - -ElasticPoolName : WIRunnerPool -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : CreateIndex -RecommendedActionName : IR_[test_schema]_[test_table_0.239359]_6C7AE8CC9C87E7FD5893 -Details : {[indexName, nci_wi_test_table_0.239359_6C7AE8CC9C87E7FD5893], [indexType, NONCLUSTERED], - [schema, [test_schema]], [table, [test_table_0.239359]]...} -ErrorDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionErrorInfo -EstimatedImpact : {ActionDuration, SpaceChange} -ExecuteActionDuration : PT1M -ExecuteActionInitiatedBy : User -ExecuteActionInitiatedTime : 4/21/2016 3:24:47 PM -ExecuteActionStartTime : 4/21/2016 3:24:47 PM -ImplementationDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionImplementationInfo -IsArchivedAction : False -IsExecutableAction : True -IsRevertableAction : True -LastRefresh : 4/21/2016 3:24:47 PM -LinkedObjects : {} -ObservedImpact : {CpuUtilization, LogicalReads, LogicalWrites, QueriesWithImprovedPerformance...} -RecommendationReason : -RevertActionDuration : PT10S -RevertActionInitiatedBy : System -RevertActionInitiatedTime : 4/21/2016 3:24:47 PM -RevertActionStartTime : 4/21/2016 3:24:47 PM -Score : 3 -State : Microsoft.Azure.Management.Sql.Models.RecommendedActionStateInfo -TimeSeries : {} -ValidSince : 4/21/2016 3:24:47 PM -``` - -This command gets a list of all recommended actions of the Advisor named CreateIndex available for the elastic pool named WIRunnerPool. - -### Example 2: Get a single recommended action for an Advisor -``` -PS C:\>Get-AzureRmSqlElasticPoolRecommendedAction -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -ElasticPoolName "WIRunnerPool" -AdvisorName "CreateIndex" -RecommendedActionName "IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893" -ElasticPoolName : WIRunnerPool -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : CreateIndex -RecommendedActionName : IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893 -Details : {[indexName, nci_wi_test_table_0.0361551_6C7AE8CC9C87E7FD5893], [indexType, - NONCLUSTERED], [schema, [test_schema]], [table, [test_table_0.0361551]]...} -ErrorDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionErrorInfo -EstimatedImpact : {ActionDuration, SpaceChange} -ExecuteActionDuration : PT1M -ExecuteActionInitiatedBy : User -ExecuteActionInitiatedTime : 4/21/2016 3:24:47 PM -ExecuteActionStartTime : 4/21/2016 3:24:47 PM -ImplementationDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionImplementationInfo -IsArchivedAction : False -IsExecutableAction : True -IsRevertableAction : True -LastRefresh : 4/21/2016 3:24:47 PM -LinkedObjects : {} -ObservedImpact : {CpuUtilization, LogicalReads, LogicalWrites, QueriesWithImprovedPerformance...} -RecommendationReason : -RevertActionDuration : -RevertActionInitiatedBy : -RevertActionInitiatedTime : -RevertActionStartTime : -Score : 2 -State : Microsoft.Azure.Management.Sql.Models.RecommendedActionStateInfo -TimeSeries : {} -ValidSince : 4/21/2016 3:24:47 PM -``` - -This command gets the recommended action named IR_\[test_schema\]_\[test_table_0.0361551\]_6C7AE8CC9C87E7FD5893 from the Advisor named CreateIndex. - -## PARAMETERS - -### -AdvisorName -Specifies the name of the advisor for which this cmdlet requests recommended actions. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ElasticPoolName -Specifies the name of the elastic pool for which this cmdlet requests recommended actions. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RecommendedActionName -Specifies the name of the recommended action that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the server that contains this elastic pool. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server the elastic pool is in. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.RecommendedAction.Model.AzureSqlElasticPoolRecommendedActionModel - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, sql, elasticpool, mssql, advisor, recommendedaction - -## RELATED LINKS - -[Get-AzureRmSqlDatabaseRecommendedAction](./Get-AzureRmSqlDatabaseRecommendedAction.md) - -[Get-AzureRmSqlElasticPoolAdvisor](./Get-AzureRmSqlElasticPoolAdvisor.md) - -[Get-AzureRmSqlServerRecommendedAction](./Get-AzureRmSqlServerRecommendedAction.md) - -[Set-AzureRmSqlElasticPoolRecommendedActionState](./Set-AzureRmSqlElasticPoolRecommendedActionState.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlInstance.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlInstance.md deleted file mode 100644 index 0177153548..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlInstance.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlinstance -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlInstance.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlInstance.md ---- - -# Get-AzureRmSqlInstance - -## SYNOPSIS -Returns information about Azure SQL Managed Database Instance. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetInstanceByResourceGroup (Default) -``` -Get-AzureRmSqlInstance [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### GetInstanceByNameAndResourceGroup -``` -Get-AzureRmSqlInstance [-Name] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlInstance** cmdlet returns information about one or more Azure SQL Managed Instances. -Specify the name of a instance to see information for only that instance. - -## EXAMPLES - -### Example 1: Get all instances assigned to a resource group -``` -PS C:\>Get-AzureRmSqlInstance -ResourceGroupName "ResourceGroup01" -Location : westcentralus -Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1 -ResourceGroupName : resourcegroup01 -ManagedInstanceName : managedInstance1 -Tags : -Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity -Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku -FullyQualifiedDomainName : managedInstance1.wcusxxxxxxxxxxxxx.database.windows.net -AdministratorLogin : adminLogin1 -AdministratorPassword : -SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name -LicenseType : BasePrice -VCores : 8 -StorageSizeInGB : 512 - -Location : westcentralus -Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance2 -ResourceGroupName : resourcegroup01 -ManagedInstanceName : managedInstance2 -Tags : -Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity -Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku -FullyQualifiedDomainName : managedInstance2.wcusxxxxxxxxxxxxx.database.windows.net -AdministratorLogin : adminLogin2 -AdministratorPassword : -SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name -LicenseType : BasePrice -VCores : 8 -StorageSizeInGB : 512 -``` - -This command gets information about all instances assigned to the resource group ResourceGroup01. - -### Example 2: Get information about an instance -``` -PS C:\>Get-AzureRmSqlInstance -Name "managedInstance1" -ResourceGroupName "ResourceGroup01" -Location : westcentralus -Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1 -ResourceGroupName : resourcegroup01 -ManagedInstanceName : managedInstance1 -Tags : -Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity -Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku -FullyQualifiedDomainName : managedInstance1.wcusxxxxxxxxxxxxx.database.windows.net -AdministratorLogin : adminLogin1 -AdministratorPassword : -SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name -LicenseType : BasePrice -VCores : 8 -StorageSizeInGB : 512 -``` - -This command gets information about the instance named managedInstance1. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -SQL instance name. - -```yaml -Type: String -Parameter Sets: GetInstanceByNameAndResourceGroup -Aliases: InstanceName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: String -Parameter Sets: GetInstanceByResourceGroup -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: GetInstanceByNameAndResourceGroup -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlInstanceDatabase.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlInstanceDatabase.md deleted file mode 100644 index 629b4fbe47..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlInstanceDatabase.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlinstancedatabase -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlInstanceDatabase.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlInstanceDatabase.md ---- - -# Get-AzureRmSqlInstanceDatabase - -## SYNOPSIS -Returns information about Azure SQL Managed Instance database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetInstanceDatabaseFromInputParameters (Default) -``` -Get-AzureRmSqlInstanceDatabase [[-Name] <String>] [-InstanceName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetInstanceDatabaseFromAzureResourceId -``` -Get-AzureRmSqlInstanceDatabase [[-Name] <String>] [-InstanceResourceId] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetInstanceDatabaseFromInstanceObject -``` -Get-AzureRmSqlInstanceDatabase [[-Name] <String>] [-InstanceObject] <AzureSqlManagedInstanceModel> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlInstanceDatabase** cmdlet gets one or more Azure SQL databases from an Azure SQL Database Managed Instance. - -## EXAMPLES - -### Example 1: Get all databases on a instance -``` -PS C:\>Get-AzureRmSqlInstanceDatabase -InstanceName "managedInstance1" -ResourceGroupName "resourcegroup01" -ResourceGroupName : resourcegroup01 -ManagedInstanceName : managedInstance1 -Location : westcentralus -Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1/databases/managedDatabase1 -Name : managedDatabase1 -Tags : -Collation : SQL_Latin1_General_CP1_CI_AS -Status : Online -CreationDate : 4/27/2018 2:30:07 PM -EarliestRestorePoint : 4/27/2018 2:40:47 PM -RestorePointInTime : -DefaultSecondaryLocation : West US 2 -CatalogCollation : -CreateMode : -StorageContainerUri : -StorageContainerSasToken : -SourceDatabaseId : -FailoverGroupId : - -ResourceGroupName : resourcegroup01 -ManagedInstanceName : managedInstance1 -Location : westcentralus -Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1/databases/managedDatabase2 -Name : managedDatabase2 -Tags : -Collation : SQL_Latin1_General_CP1_CI_AS -Status : Online -CreationDate : 4/23/2018 5:21:07 PM -EarliestRestorePoint : 4/23/2018 5:31:47 PM -RestorePointInTime : -DefaultSecondaryLocation : West US 2 -CatalogCollation : -CreateMode : -StorageContainerUri : -StorageContainerSasToken : -SourceDatabaseId : -FailoverGroupId : -``` - -This command gets all databases on the instance named managedInstance1. - -### Example 2: Get a database by name on a Managed instance -``` -PS C:\>Get-AzureRmSqlInstanceDatabase -Name "managedDatabase1" -InstanceName "managedInstance1" -ResourceGroupName "ResourceGroup01" -ResourceGroupName : resourcegroup01 -ManagedInstanceName : managedInstance1 -Location : westcentralus -Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1/databases/managedDatabase1 -Name : managedDatabase1 -Tags : -Collation : SQL_Latin1_General_CP1_CI_AS -Status : Online -CreationDate : 4/27/2018 2:30:07 PM -EarliestRestorePoint : 4/27/2018 2:40:47 PM -RestorePointInTime : -DefaultSecondaryLocation : West US 2 -CatalogCollation : -CreateMode : -StorageContainerUri : -StorageContainerSasToken : -SourceDatabaseId : -FailoverGroupId : -``` - -This command gets a database named managedDatabase1 from a instance named managedInstance1. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceName -The instance name. - -```yaml -Type: String -Parameter Sets: GetInstanceDatabaseFromInputParameters -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceObject -The instance object to use for getting instance database - -```yaml -Type: AzureSqlManagedInstanceModel -Parameter Sets: GetInstanceDatabaseFromInstanceObject -Aliases: ParentObject - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InstanceResourceId -The resource id of instance object to get - -```yaml -Type: String -Parameter Sets: GetInstanceDatabaseFromAzureResourceId -Aliases: ParentResourceId - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The name of the Azure SQL Instance Database to retrieve. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: InstanceDatabaseName - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: String -Parameter Sets: GetInstanceDatabaseFromInputParameters -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServer.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServer.md deleted file mode 100644 index 49e93a9a00..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServer.md +++ /dev/null @@ -1,210 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: C39ACCAC-2BFF-48D0-95EA-D5B402D74D46 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlserver -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServer.md ---- - -# Get-AzureRmSqlServer - -## SYNOPSIS -Returns information about SQL Database servers. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlServer [[-ResourceGroupName] <String>] [[-ServerName] <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlServer** cmdlet returns information about one or more Azure SQL Database servers. -Specify the name of a server to see information for only that server. - -## EXAMPLES - -### Example 1: Get all instances of SQL Server assigned to a resource group -``` -PS C:\>Get-AzureRmSqlServer -ResourceGroupName "ResourceGroup01" -ResourceGroupName : resourcegroup01 -ServerName : server01 -Location : Central US -SqlAdministratorLogin : adminLogin -SqlAdministratorPassword : -ServerVersion : 12.0 -Tags : -Identity : -FullyQualifiedDomainName : server01.database.windows.net - -ResourceGroupName : resourcegroup01 -ServerName : server02 -Location : West US -SqlAdministratorLogin : adminLogin -SqlAdministratorPassword : -ServerVersion : 12.0 -Tags : -Identity : -FullyQualifiedDomainName : server02.database.windows.net -``` - -This command gets information about all the Azure SQL Database servers assigned to the resource group ResourceGroup01. - -### Example 2: Get information about an Azure SQL Database server -``` -PS C:\>Get-AzureRmSqlServer -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ResourceGroupName : resourcegroup01 -ServerName : server01 -Location : Central US -SqlAdministratorLogin : adminLogin -SqlAdministratorPassword : -ServerVersion : 12.0 -Tags : -Identity : -FullyQualifiedDomainName : server01.database.windows.net -``` - -This command gets information about the Azure SQL Database server named Server01. - -### Example 3: Get all instances of SQL Server in the subscription -``` -PS C:\>Get-AzureRmResourceGroup | Get-AzureRmSqlServer -ResourceGroupName : resourcegroup01 -ServerName : server01 -Location : Central US -SqlAdministratorLogin : adminLogin -SqlAdministratorPassword : -ServerVersion : 12.0 -Tags : -Identity : -FullyQualifiedDomainName : server01.database.windows.net - -ResourceGroupName : resourcegroup01 -ServerName : server02 -Location : West US -SqlAdministratorLogin : adminLogin -SqlAdministratorPassword : -ServerVersion : 12.0 -Tags : -Identity : -FullyQualifiedDomainName : server02.database.windows.net - -ResourceGroupName : resourcegroup02 -ServerName : server03 -Location : East US -SqlAdministratorLogin : adminLogin -SqlAdministratorPassword : -ServerVersion : 12.0 -Tags : -Identity : -FullyQualifiedDomainName : server03.database.windows.net -``` - -This command gets information about all the Azure SQL Database servers in the current subscription. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which servers are assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel - -## NOTES - -## RELATED LINKS - -[New-AzureRmSqlServer](./New-AzureRmSqlServer.md) - -[Remove-AzureRmSqlServer](./Remove-AzureRmSqlServer.md) - -[Set-AzureRmSqlServer](./Set-AzureRmSqlServer.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerActiveDirectoryAdministrator.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerActiveDirectoryAdministrator.md deleted file mode 100644 index 06e0ec6d19..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerActiveDirectoryAdministrator.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: FEDA14CF-632F-4D15-A22B-C73A1298094F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlserveractivedirectoryadministrator -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerActiveDirectoryAdministrator.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerActiveDirectoryAdministrator.md ---- - -# Get-AzureRmSqlServerActiveDirectoryAdministrator - -## SYNOPSIS -Gets information about a Microsoft Entra administrator for SQL Server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlServerActiveDirectoryAdministrator [-ServerName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlServerActiveDirectoryAdministrator** cmdlet gets information about a Microsoft Entra administrator for an AzureSQL Server in the current subscription. - -## EXAMPLES - -### Example 1: Gets information about an administrator for a server -``` -PS C:\>Get-AzureRmSqlServerActiveDirectoryAdministrator -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ResourceGroupName ServerName DisplayName ObjectId ------------------ ---------- ----------- -------- -ResourceGroup01 Server01 DBAs 40b79501-b343-44ed-9ce7-da4c8cc7353b -``` - -This command gets information about a Microsoft Entra administrator for a server named Server01 that is associated with a resource group named ResourceGroup01. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the SQL Server is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the SQL Server for which this cmdlet gets information. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ServerActiveDirectoryAdministrator.Model.AzureSqlServerActiveDirectoryAdministratorModel - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmSqlServerActiveDirectoryAdministrator](./Remove-AzureRmSqlServerActiveDirectoryAdministrator.md) - -[Set-AzureRmSqlServerActiveDirectoryAdministrator](./Set-AzureRmSqlServerActiveDirectoryAdministrator.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerAdvancedThreatProtectionPolicy.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerAdvancedThreatProtectionPolicy.md deleted file mode 100644 index 5b733a53fc..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerAdvancedThreatProtectionPolicy.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlserveradvancedthreatprotectionpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerAdvancedThreatProtectionPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerAdvancedThreatProtectionPolicy.md ---- - -# Get-AzureRmSqlServerAdvancedThreatProtectionPolicy - -## SYNOPSIS -Gets Advanced Threat Protection policy of a server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlServerAdvancedThreatProtectionPolicy [-InputObject <AzureSqlServerModel>] -ServerName <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlServerAdvancedThreatProtectionPolicy** cmdlet retrives the Advanced Threat Protection policy of a server. - -## EXAMPLES - -### Example 1 - Gets server Advanced Threat Protection -```powershell -PS C:\> Get-AzureRmSqlServerAdvancedThreatProtectionPolicy ` - -ResourceGroupName "ResourceGroup01" ` - -ServerName "Server01" - -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -IsEnabled : True -``` - -### Example 2 - Gets server Advanced Threat Protection from server resource -```powershell -PS C:\> Get-AzureRmSqlServer ` - -ResourceGroupName "ResourceGroup01" ` - -ServerName "Server01" ` - | Get-AzureRmSqlServerAdvancedThreatProtectionPolicy - -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -IsEnabled : True -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The server object to use with Advanced Threat Protection policy operation - -```yaml -Type: Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -SQL Database server name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.AdvancedThreatProtection.Model.ServerAdvancedThreatProtectionPolicyModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerAdvisor.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerAdvisor.md deleted file mode 100644 index e0b7efca5f..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerAdvisor.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: DAEF11C1-281B-4BED-9283-2296E0B57018 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlserveradvisor -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerAdvisor.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerAdvisor.md ---- - -# Get-AzureRmSqlServerAdvisor - -## SYNOPSIS -Gets one or more Advisors for an Azure SQL Server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlServerAdvisor [-AdvisorName <String>] [-ExpandRecommendedActions] -ServerName <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlServerAdvisor** cmdlet gets one or more Azure SQL Server Advisors for an Azure SQL Server. - -## EXAMPLES - -### Example 1: List all the advisors for the server -``` -PS C:\> Get-AzureRmSqlServerAdvisor -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : CreateIndex -AdvisorStatus : GA -AutoExecuteStatus : Disabled -AutoExecuteStatusInheritedFrom : Database -LastChecked : 8/1/2016 2:36:47 PM -RecommendationsStatus : Ok -RecommendedActions : {} - -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : DropIndex -AdvisorStatus : PublicPreview -AutoExecuteStatus : Disabled -AutoExecuteStatusInheritedFrom : Database -LastChecked : 7/31/2016 8:41:19 PM -RecommendationsStatus : Ok -RecommendedActions : {} -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : DbParameterization -AdvisorStatus : PublicPreview -AutoExecuteStatus : Disabled -AutoExecuteStatusInheritedFrom : Default -LastChecked : 7/31/2016 2:46:58 PM -RecommendationsStatus : NoDbParameterizationIssue -RecommendedActions : {} - -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : SchemaIssue -AdvisorStatus : PublicPreview -AutoExecuteStatus : Disabled -AutoExecuteStatusInheritedFrom : Default -LastChecked : 8/1/2016 3:01:41 PM -RecommendationsStatus : SchemaIsConsistent -RecommendedActions : {} -``` - -This command gets a list of all the advisors for the server named wi-runner-australia-east that belongs to the resource group named WIRunnersProd. - -### Example 2: Get a single advisor for the server -``` -PS C:\> Get-AzureRmSqlServerAdvisor -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -AdvisorName "CreateIndex" -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : CreateIndex -AdvisorStatus : GA -AutoExecuteStatus : Disabled -AutoExecuteStatusInheritedFrom : Database -LastChecked : 8/1/2016 2:36:47 PM -RecommendationsStatus : Ok -RecommendedActions : {} -``` - -This command gets the advisor named CreateIndex for the server named wi-runner-australia-east. - -### Example 3: List all the advisors with their recommended actions included in the response -``` -PS C:\>Get-AzureRmSqlServerAdvisor -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -ExpandRecommendedActions -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : CreateIndex -AdvisorStatus : GA -AutoExecuteStatus : Disabled -AutoExecuteStatusInheritedFrom : Database -LastChecked : 8/1/2016 2:36:47 PM -RecommendationsStatus : Ok -RecommendedActions : {IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893, - IR_[test_schema]_[test_table_0.236046]_6C7AE8CC9C87E7FD5893, - IR_[test_schema]_[test_table_0.239359]_6C7AE8CC9C87E7FD5893, - IR_[test_schema]_[test_table_0.437714]_6C7AE8CC9C87E7FD5893...} - -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : DropIndex -AdvisorStatus : PublicPreview -AutoExecuteStatus : Disabled -AutoExecuteStatusInheritedFrom : Database -LastChecked : 7/31/2016 8:41:19 PM -RecommendationsStatus : Ok -RecommendedActions : {IR_[test_schema]_[test_table_0.0288891]_38724E1DCF2178318957, - IR_[test_schema]_[test_table_0.140264]_38724E1DCF2178318957, - IR_[test_schema]_[test_table_0.412191]_38724E1DCF2178318957, - IR_[test_schema]_[test_table_0.442075]_38724E1DCF2178318957...} - -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : DbParameterization -AdvisorStatus : PublicPreview -AutoExecuteStatus : Disabled -AutoExecuteStatusInheritedFrom : Default -LastChecked : 7/31/2016 2:46:58 PM -RecommendationsStatus : NoDbParameterizationIssue -RecommendedActions : {} -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : SchemaIssue -AdvisorStatus : PublicPreview -AutoExecuteStatus : Disabled -AutoExecuteStatusInheritedFrom : Default -LastChecked : 8/1/2016 3:04:26 PM -RecommendationsStatus : SchemaIsConsistent -RecommendedActions : {} -``` - -This command gets all the advisors for the server named wi-runner-australia-east. -Since the command uses the *ExpandRecommendedActions* parameter, the cmdlet gets the advisors recommended actions included in the response. - -### Example 4: Get a single advisor with its recommended actions included in the response -``` -PS C:\> Get-AzureRmSqlServerAdvisor -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -AdvisorName "CreateIndex" -ExpandRecommendedActions -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : CreateIndex -AdvisorStatus : GA -AutoExecuteStatus : Disabled -AutoExecuteStatusInheritedFrom : Database -LastChecked : 8/1/2016 2:36:47 PM -RecommendationsStatus : Ok -RecommendedActions : {IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893, - IR_[test_schema]_[test_table_0.236046]_6C7AE8CC9C87E7FD5893, - IR_[test_schema]_[test_table_0.239359]_6C7AE8CC9C87E7FD5893, - IR_[test_schema]_[test_table_0.437714]_6C7AE8CC9C87E7FD5893...} -``` - -This command gets advisor named CreateIndex from the server named wi-runner-australia-east with its recommended actions included in the response. - -## PARAMETERS - -### -AdvisorName -Specifies the name of the advisor that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpandRecommendedActions -Indicates that the cmdlet includes the recommended actions of the advisors that are included in the response. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies name of the resource group of the server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server for the advisor that this cmdlet requests. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Advisor.Model.AzureSqlServerAdvisorModel - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, sql, server, mssql, advisor - -## RELATED LINKS - -[Get-AzureRmSqlElasticPoolAdvisor](./Get-AzureRmSqlElasticPoolAdvisor.md) - -[Get-AzureRmSqlDatabaseAdvisor](./Get-AzureRmSqlDatabaseAdvisor.md) - -[Get-AzureRmSqlServerRecommendedAction](./Get-AzureRmSqlServerRecommendedAction.md) - -[Set-AzureRmSqlServerAdvisorAutoExecuteStatus](./Set-AzureRmSqlServerAdvisorAutoExecuteStatus.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerAuditing.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerAuditing.md deleted file mode 100644 index c455b7a9ca..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerAuditing.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 14814BF3-51AF-4E51-A8A6-661825BD88D1 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlserverauditing -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerAuditing.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerAuditing.md ---- - -# Get-AzureRmSqlServerAuditing - -## SYNOPSIS -Gets the auditing settings of an Azure SQL server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlServerAuditing [-ServerName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlServerAuditing** cmdlet gets the blob auditing policy of an Azure SQL server. -Specify the *ResourceGroupName* and *ServerName* parameters to identify the database. -This cmdlet returns a policy that is used by the Azure SQL databases that are defined in the specified Azure SQL server. - -## EXAMPLES - -### Example 1: Get the auditing settings of an Azure SQL server -``` -PS C:\>Get-AzureRmSqlServerAuditing -ResourceGroupName "resourcegroup01" -ServerName "server01" -AuditActionGroup : {SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP, - BATCH_COMPLETED_GROUP, ...} -ResourceGroupName : resourcegroup01 -ServerName : server01 -AuditState : Enabled -StorageAccountName : mystorage -StorageKeyType : Primary -RetentionInDays : 0 -StorageAccountSubscriptionId : 7fe3301d-31d3-4668-af5e-211a890ba6e3 -PredicateExpression : statement <> 'select 1' -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -SQL server name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Auditing.Model.ServerBlobAuditingSettingsModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerAuditingPolicy.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerAuditingPolicy.md deleted file mode 100644 index a48d6a4550..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerAuditingPolicy.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 40674DC7-E35F-4C9F-8CE0-D1C6F524C9FB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlserverauditingpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerAuditingPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerAuditingPolicy.md ---- - -# Get-AzureRmSqlServerAuditingPolicy - -## SYNOPSIS -Gets the auditing policy of a SQL server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlServerAuditingPolicy -ServerName <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlServerAuditingPolicy** cmdlet gets the auditing policy of an Azure SQL server. -Specify the *ResourceGroupName*, *ServerName*, and *DatabaseName* parameters to identify the database. -This cmdlet returns a policy that is used by the Azure SQL databases that are both defined in the specified Azure SQL server and use its auditing policy. - -## EXAMPLES - -### Example 1: Get the auditing policy of an Azure SQL server with Table auditing defined on it -``` -PS C:\>Get-AzureRmSqlServerAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -EventType : {PlainSQL_Success, PlainSQL_Failure, ParameterizedSQL_Success, ParameterizedSQL_Failure...} -TableIdentifier : MyAuditTableName -FullAuditLogsTableName : SQLDBAuditLogsMyAuditTableName -ResourceGroupName : resourcegroup01 -ServerName : server01 -AuditType : Table -AuditState : Enabled -StorageAccountName : mystorage -StorageKeyType : Primary -RetentionInDays : 0 -``` - -### Example 2: Get the auditing policy of an Azure SQL server with Blob auditing defined on it -``` -PS C:\>Get-AzureRmSqlServerAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -AuditActionGroup : {SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP, - BATCH_COMPLETED_GROUP, ...} -ResourceGroupName : resourcegroup01 -ServerName : server01 -AuditType : Blob -AuditState : Enabled -StorageAccountName : mystorage -StorageKeyType : Primary -RetentionInDays : 0 -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the Azure SQL server is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the Azure SQL server for which this cmdlet gets the auditing policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Auditing.Model.AuditingPolicyModel - -## NOTES - -## RELATED LINKS - -[Set-AzureRmSqlServerAuditingPolicy](./Set-AzureRmSqlServerAuditingPolicy.md) - -[Use-AzureRmSqlServerAuditingPolicy](./Use-AzureRmSqlServerAuditingPolicy.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerBackupLongTermRetentionVault.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerBackupLongTermRetentionVault.md deleted file mode 100644 index 08ea92eb32..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerBackupLongTermRetentionVault.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 686785F8-2085-4705-A74D-12B18A87E187 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlserverbackuplongtermretentionvault -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerBackupLongTermRetentionVault.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerBackupLongTermRetentionVault.md ---- - -# Get-AzureRmSqlServerBackupLongTermRetentionVault - -## SYNOPSIS -Gets a server long term retention vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlServerBackupLongTermRetentionVault [-ServerName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlServerBackupLongTermRetentionVault** cmdlet gets the long term retention vault registered to this server. -The vault is an Azure Backup resource used to store backup data. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the server for which this cmdlet gets a vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlServerBackupLongTermRetentionVaultModel - -## NOTES - -## RELATED LINKS - -[Set-AzureRmSqlServerBackupLongTermRetentionVault](./Set-AzureRmSqlServerBackupLongTermRetentionVault.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerCommunicationLink.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerCommunicationLink.md deleted file mode 100644 index a9f0977f4f..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerCommunicationLink.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 2E7E20CD-6A2B-455E-9476-8E0827429162 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlservercommunicationlink -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerCommunicationLink.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerCommunicationLink.md ---- - -# Get-AzureRmSqlServerCommunicationLink - -## SYNOPSIS -Gets communication links for elastic database transactions between database servers. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlServerCommunicationLink [[-LinkName] <String>] [-ServerName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlServerCommunicationLink** cmdlet gets server-to-server communication links for elastic database transactions in Azure SQL Database. -Specify the name of a server communication link to see the properties for that link. - -## EXAMPLES - -### Example 1: Get all communication links for a server -``` -PS C:\>Get-AzureRmSqlServerCommunicationLink -ResourceGroupName "ResourceGroup01" -ServerName "ContosoServer17" -``` - -This command gets all server-to-server communication links for elastic database transactions for the server named ContosoServer17. - -### Example 2: Get a specific communication link for a server -``` -PS C:\>Get-AzureRmSqlServerCommunicationLink -ResourceGroupName "ResourceGroup01" -ServerName "ContosoServer17" -LinkName "Link01" -``` - -This command gets the server-to-server communication link named Link01. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LinkName -Specifies the name of the server communication link that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the server specified by the *ServerName* parameter belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of a server. -This server contains a communication link that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ServerCommunicationLink.Model.AzureSqlServerCommunicationLinkModel - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - -## RELATED LINKS - -[New-AzureRmSqlServerCommunicationLink](./New-AzureRmSqlServerCommunicationLink.md) - -[Remove-AzureRmSqlServerCommunicationLink](./Remove-AzureRmSqlServerCommunicationLink.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerDisasterRecoveryConfiguration.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerDisasterRecoveryConfiguration.md deleted file mode 100644 index 5d398742a2..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerDisasterRecoveryConfiguration.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: C7F3E754-394A-4F93-A621-A07AF281EE45 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlserverdisasterrecoveryconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerDisasterRecoveryConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerDisasterRecoveryConfiguration.md ---- - -# Get-AzureRmSqlServerDisasterRecoveryConfiguration - -## SYNOPSIS -Gets a database server system recovery configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlServerDisasterRecoveryConfiguration [-VirtualEndpointName <String>] [-ServerName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlServerDisasterRecoveryConfiguration** cmdlet gets a SQL database server system recovery configuration. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of SQL database server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualEndpointName -Specifies the name of the virtual end point. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ServerDisasterRecoveryConfiguration.Model.AzureSqlServerDisasterRecoveryConfigurationModel - -## NOTES - -## RELATED LINKS - -[New-AzureRmSqlServerDisasterRecoveryConfiguration](./New-AzureRmSqlServerDisasterRecoveryConfiguration.md) - -[Remove-AzureRmSqlServerDisasterRecoveryConfiguration](./Remove-AzureRmSqlServerDisasterRecoveryConfiguration.md) - -[Set-AzureRmSqlServerDisasterRecoveryConfiguration](./Set-AzureRmSqlServerDisasterRecoveryConfiguration.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerDisasterRecoveryConfigurationActivity.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerDisasterRecoveryConfigurationActivity.md deleted file mode 100644 index c60a98dc2f..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerDisasterRecoveryConfigurationActivity.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 41D63CC1-5E9F-48D3-89DE-0F753C7475F2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlserverdisasterrecoveryconfigurationactivity -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerDisasterRecoveryConfigurationActivity.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerDisasterRecoveryConfigurationActivity.md ---- - -# Get-AzureRmSqlServerDisasterRecoveryConfigurationActivity - -## SYNOPSIS -Gets activity for a database server system recovery configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlServerDisasterRecoveryConfigurationActivity [-ServerName] <String> - -ServerDisasterRecoveryConfigurationName <String> [-OperationId <Guid>] [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlServerDisasterRecoveryConfigurationActivity** cmdlet gets activity for a SQL database server system recovery configuration. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OperationId -Specifies the operation ID. - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerDisasterRecoveryConfigurationName -Specifies the name of the server system recovery configuration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ServerDisasterRecoveryConfiguration.Model.AzureSqlServerDisasterRecoveryConfigurationActivityModel - -## NOTES - -## RELATED LINKS - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerDnsAlias.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerDnsAlias.md deleted file mode 100644 index 5051903f2d..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerDnsAlias.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlserverdnsalias -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerDnsAlias.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerDnsAlias.md ---- - -# Get-AzureRmSqlServerDnsAlias - -## SYNOPSIS -Gets or lists Azure SQL Server DNS Alias. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlServerDnsAlias [-Name <String>] -ServerName <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Get the specific Azure SQL Server DNS Alias or lists all Server DNS Aliases for the server - -## EXAMPLES - -### Example 1 -``` -PS C:\> $serverDNSAliases = Get-AzureRmSqlServerDNSAlias -ServerName servername -ResourceGroupName rgname - -ResourceGroupName ServerName DnsAliasName ------------------ ---------- ------------------ -rgname servername dnsaliasname -rgname servername dnsaliasname2 -``` - -Lists all Server DNS Aliases for the specific server - -### Example 2 -``` -PS C:\> $serverDNSAliases = Get-AzureRmSqlServerDNSAlias -DnsAliasName dnsaliasname -ServerName servername -ResourceGroupName rgname - -ResourceGroupName ServerName DnsAliasName ------------------ ---------- ------------------ -rgname servername dnsaliasname -``` - -Gets Server DNS Alias specified by server and alias name - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Azure Sql Server DNS Alias name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: DnsAliasName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The Azure Sql Server name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ServerDnsAlias.Model.AzureSqlServerDnsAliasModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerFirewallRule.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerFirewallRule.md deleted file mode 100644 index 3cc8664bf3..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerFirewallRule.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: AD8BA5CB-D5D4-4C6E-A65F-E7AE69E3B22C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlserverfirewallrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerFirewallRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerFirewallRule.md ---- - -# Get-AzureRmSqlServerFirewallRule - -## SYNOPSIS -Gets firewall rules for a SQL Database server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlServerFirewallRule [[-FirewallRuleName] <String>] [-ServerName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlServerFirewallRule** cmdlet gets firewall rules for an Azure SQL Database server. -If you specify the name of a firewall rule, this cmdlet gets information about that specific firewall rule. - -## EXAMPLES - -### Example 1: Get all rules for a server -``` -PS C:\>Get-AzureRmSqlServerFirewallRule -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ResourceGroupName : ResourceGroup01 -ServerName : server01 -StartIpAddress : 0.0.0.0 -EndIpAddress : 0.0.0.0 -FirewallRuleName : AllowAllWindowsAzureIps - -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -StartIpAddress : 1.2.3.4 -EndIpAddress : 4.3.2.1 -FirewallRuleName : Rule01 -``` - -This command gets all the firewall rules for the server named Server01. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FirewallRuleName -Specifies the name of the firewall rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the SQL Server is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the SQL Server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.FirewallRule.Model.AzureSqlServerFirewallRuleModel - -## NOTES - -## RELATED LINKS - -[New-AzureRmSqlServerFirewallRule](./New-AzureRmSqlServerFirewallRule.md) - -[Remove-AzureRmSqlServerFirewallRule](./Remove-AzureRmSqlServerFirewallRule.md) - -[Set-AzureRmSqlServerFirewallRule](./Set-AzureRmSqlServerFirewallRule.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerKeyVaultKey.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerKeyVaultKey.md deleted file mode 100644 index 2229cb00c3..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerKeyVaultKey.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlserverkeyvaultkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerKeyVaultKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerKeyVaultKey.md ---- - -# Get-AzureRmSqlServerKeyVaultKey - -## SYNOPSIS -Gets a SQL server's Key Vault keys. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlServerKeyVaultKey [[-KeyId] <String>] [-ServerName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmSqlServerKeyVaultKey cmdlet gets information about the Key Vault keys on a SQL server. -You can view all keys on a server or view a specific key by providing the KeyId. - -## EXAMPLES - -### Example 1: Get all Key Vault keys -``` -PS C:\> Get-AzureRmSqlServerKeyVaultKey -ServerName 'ContosoServer' -ResourceGroupName 'ContosoResourceGroup' -``` - -This command gets all the Key Vault keys on a SQL server. -ResourceGroupName : ContosoResourceGroup -ServerName : ContosoServer -ServerKeyName : contoso_contosokey_01234567890123456789012345678901 -Type : AzureKeyVault -Uri : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901 -Thumbprint : 1122334455667788990011223344556677889900 -CreationDate : 1/1/2017 12:00:00 AM -ResourceGroupName : ContosoResourceGroup -ServerName : ContosoServer -ServerKeyName : contoso_contosokey2_01234567890123456789012345678901 -Type : AzureKeyVault -Uri : https://contoso.vault.azure.net/keys/contosokey2/09876543210987654321098765432109 -Thumbprint : 0099887766554433221100998877665544332211 -CreationDate : 1/1/2017 12:00:00 AM - -### Example 2: Get a specific Key Vault key -``` -PS C:\> $MyServerKeyVaultKey = Get-AzureRmSqlServerKeyVaultKey -KeyId 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' -ServerName 'ContosoServer' -ResourceGroupName 'ContosoResourceGroup' -``` - -This command gets the Key Vault key with Id 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901', and then stores it in the $MyServerKeyVaultKey variable. -You can inspect the properties of $MyServerKeyVaultKey to get details about the key vault. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyId -The Azure Key Vault KeyId. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The Azure Sql Server name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ServerKeyVaultKey.Model.AzureSqlServerKeyVaultKeyModel - -## NOTES - -## RELATED LINKS - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerRecommendedAction.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerRecommendedAction.md deleted file mode 100644 index 80c18b5806..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerRecommendedAction.md +++ /dev/null @@ -1,261 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: BB513A53-48A0-4F8F-93F0-D3DFA2C3D523 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlserverrecommendedaction -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerRecommendedAction.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerRecommendedAction.md ---- - -# Get-AzureRmSqlServerRecommendedAction - -## SYNOPSIS -Gets one or more recommended actions for an Azure SQL Server Advisor. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlServerRecommendedAction [-RecommendedActionName <String>] -ServerName <String> - -AdvisorName <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlServerRecommendedAction** cmdlet gets one or more recommended actions for an Azure SQL Server Advisor. - -## EXAMPLES - -### Example 1: Get a list of all recommended actions for a specific Advisor -``` -PS C:\>Get-AzureRmSqlServerRecommendedAction -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -AdvisorName "CreateIndex" -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : CreateIndex -RecommendedActionName : IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893 -Details : {[indexName, nci_wi_test_table_0.0361551_6C7AE8CC9C87E7FD5893], [indexType, - NONCLUSTERED], [schema, [test_schema]], [table, [test_table_0.0361551]]...} -ErrorDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionErrorInfo -EstimatedImpact : {ActionDuration, SpaceChange} -ExecuteActionDuration : PT1M -ExecuteActionInitiatedBy : User -ExecuteActionInitiatedTime : 4/21/2016 3:24:47 PM -ExecuteActionStartTime : 4/21/2016 3:24:47 PM -ImplementationDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionImplementationInfo -IsArchivedAction : False -IsExecutableAction : True -IsRevertableAction : True -LastRefresh : 4/21/2016 3:24:47 PM -LinkedObjects : {} -ObservedImpact : {CpuUtilization, LogicalReads, LogicalWrites, QueriesWithImprovedPerformance...} -RecommendationReason : -RevertActionDuration : -RevertActionInitiatedBy : -RevertActionInitiatedTime : -RevertActionStartTime : -Score : 2 -State : Microsoft.Azure.Management.Sql.Models.RecommendedActionStateInfo -TimeSeries : {} -ValidSince : 4/21/2016 3:24:47 PM - -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : CreateIndex -RecommendedActionName : IR_[test_schema]_[test_table_0.236046]_6C7AE8CC9C87E7FD5893 -Details : {[indexName, nci_wi_test_table_0.236046_6C7AE8CC9C87E7FD5893], [indexType, NONCLUSTERED], - [schema, [test_schema]], [table, [test_table_0.236046]]...} -ErrorDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionErrorInfo -EstimatedImpact : {ActionDuration, SpaceChange} -ExecuteActionDuration : PT1M -ExecuteActionInitiatedBy : User -ExecuteActionInitiatedTime : 4/21/2016 3:24:47 PM -ExecuteActionStartTime : 4/21/2016 3:24:47 PM -ImplementationDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionImplementationInfo -IsArchivedAction : False -IsExecutableAction : True -IsRevertableAction : True -LastRefresh : 4/21/2016 3:24:47 PM -LinkedObjects : {} -ObservedImpact : {SpaceChange} -RecommendationReason : -RevertActionDuration : -RevertActionInitiatedBy : -RevertActionInitiatedTime : -RevertActionStartTime : -Score : 3 -State : Microsoft.Azure.Management.Sql.Models.RecommendedActionStateInfo -TimeSeries : {} -ValidSince : 4/21/2016 3:24:47 PM - -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : CreateIndex -RecommendedActionName : IR_[test_schema]_[test_table_0.239359]_6C7AE8CC9C87E7FD5893 -Details : {[indexName, nci_wi_test_table_0.239359_6C7AE8CC9C87E7FD5893], [indexType, NONCLUSTERED], - [schema, [test_schema]], [table, [test_table_0.239359]]...} -ErrorDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionErrorInfo -EstimatedImpact : {ActionDuration, SpaceChange} -ExecuteActionDuration : PT1M -ExecuteActionInitiatedBy : User -ExecuteActionInitiatedTime : 4/21/2016 3:24:47 PM -ExecuteActionStartTime : 4/21/2016 3:24:47 PM -ImplementationDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionImplementationInfo -IsArchivedAction : False -IsExecutableAction : True -IsRevertableAction : True -LastRefresh : 4/21/2016 3:24:47 PM -LinkedObjects : {} -ObservedImpact : {CpuUtilization, LogicalReads, LogicalWrites, QueriesWithImprovedPerformance...} -RecommendationReason : -RevertActionDuration : PT10S -RevertActionInitiatedBy : System -RevertActionInitiatedTime : 4/21/2016 3:24:47 PM -RevertActionStartTime : 4/21/2016 3:24:47 PM -Score : 3 -State : Microsoft.Azure.Management.Sql.Models.RecommendedActionStateInfo -TimeSeries : {} -ValidSince : 4/21/2016 3:24:47 PM -``` - -This command gets a list of all recommended actions of for the SQL Server Advisor named CreateIndex available for the server named wi-runner-australia-east. - -### Example 2: Get a single recommended action for an Advisor -``` -PS C:\>Get-AzureRmSqlServerRecommendedAction -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -AdvisorName "CreateIndex" -RecommendedActionName -IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893 -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : CreateIndex -RecommendedActionName : IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893 -Details : {[indexName, nci_wi_test_table_0.0361551_6C7AE8CC9C87E7FD5893], [indexType, - NONCLUSTERED], [schema, [test_schema]], [table, [test_table_0.0361551]]...} -ErrorDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionErrorInfo -EstimatedImpact : {ActionDuration, SpaceChange} -ExecuteActionDuration : PT1M -ExecuteActionInitiatedBy : User -ExecuteActionInitiatedTime : 4/21/2016 3:24:47 PM -ExecuteActionStartTime : 4/21/2016 3:24:47 PM -ImplementationDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionImplementationInfo -IsArchivedAction : False -IsExecutableAction : True -IsRevertableAction : True -LastRefresh : 4/21/2016 3:24:47 PM -LinkedObjects : {} -ObservedImpact : {CpuUtilization, LogicalReads, LogicalWrites, QueriesWithImprovedPerformance...} -RecommendationReason : -RevertActionDuration : -RevertActionInitiatedBy : -RevertActionInitiatedTime : -RevertActionStartTime : -Score : 2 -State : Microsoft.Azure.Management.Sql.Models.RecommendedActionStateInfo -TimeSeries : {} -ValidSince : 4/21/2016 3:24:47 PM -``` - -This command gets a recommended action named IR_\[test_schema\]_\[test_table_0.0361551\]_6C7AE8CC9C87E7FD5893 from the Advisor named CreateIndex. - -## PARAMETERS - -### -AdvisorName -Specifies the name of the advisor for which this cmdlet requests actions. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecommendedActionName -Specifies the name of the recommended action that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the server that contains this server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server the Advisor belongs to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.RecommendedAction.Model.AzureSqlServerRecommendedActionModel - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, sql, server, mssql, advisor, recommendedaction - -## RELATED LINKS - -[Get-AzureRmSqlServerAdvisor](./Get-AzureRmSqlServerAdvisor.md) - -[Set-AzureRmSqlServerRecommendedActionState](./Set-AzureRmSqlServerRecommendedActionState.md) - -[Get-AzureRmSqlElasticPoolRecommendedAction](./Get-AzureRmSqlElasticPoolRecommendedAction.md) - -[Get-AzureRmSqlDatabaseRecommendedAction](./Get-AzureRmSqlDatabaseRecommendedAction.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerServiceObjective.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerServiceObjective.md deleted file mode 100644 index 08345774b7..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerServiceObjective.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: AC2D64B9-5BCD-45D3-8650-538633F5BBBC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlserverserviceobjective -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerServiceObjective.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerServiceObjective.md ---- - -# Get-AzureRmSqlServerServiceObjective - -## SYNOPSIS -Gets service objectives for an Azure SQL Database server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlServerServiceObjective [[-ServiceObjectiveName] <String>] [-ServerName] <String> - [[-DatabaseName] <String>] [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlServerServiceObjective** cmdlet gets the available service objectives for an Azure SQL Database server. - -## EXAMPLES - -### Example 1: Get service objectives -``` -PS C:\>Get-AzureRmSqlServerServiceObjective -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -ResourceGroupName ServerName ServiceObjectiveName Description Enabled IsDefault IsSystem ------------------ ---------- -------------------- ----------- ------- --------- -------- -resourcegroup01 server01 ElasticPool True False False -resourcegroup01 server01 System True False True -resourcegroup01 server01 System0 True False True -resourcegroup01 server01 System1 True False True -resourcegroup01 server01 System2 True True True -resourcegroup01 server01 Basic True True False -resourcegroup01 server01 S0 True True False -resourcegroup01 server01 S1 True False False -resourcegroup01 server01 S2 True False False -resourcegroup01 server01 S3 True False False -resourcegroup01 server01 P1 True True False -resourcegroup01 server01 P2 True False False -resourcegroup01 server01 P3 True False False -resourcegroup01 server01 P4 True False False -``` - -This command gets the service objectives for the server named Server01 and the database named Database01. - -## PARAMETERS - -### -DatabaseName -SQL Database name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. -This cmdlet gets service objectives for a SQL Database server assigned to this resource. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of a SQL Database SQL Database server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceObjectiveName -Specifies the name of a service objective for an Azure SQL Database server. -The acceptable values for this parameter are: Basic, S0, S1, S2, P1, P2, and P3. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ServiceObjective.Model.AzureSqlServerServiceObjectiveModel - -## NOTES - -## RELATED LINKS - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerThreatDetectionPolicy.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerThreatDetectionPolicy.md deleted file mode 100644 index f0f2aa9a6f..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerThreatDetectionPolicy.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: F26CB715-D66A-4672-AA47-F3B316957FC8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlserverthreatdetectionpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerThreatDetectionPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerThreatDetectionPolicy.md ---- - -# Get-AzureRmSqlServerThreatDetectionPolicy - -## SYNOPSIS -Gets the threat detection policy for a server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlServerThreatDetectionPolicy -ServerName <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlServerThreatDetectionPolicy** cmdlet gets the threat detection policy of an Azure SQL server. -To use this cmdlet, specify the *ResourceGroupName* and *ServerName* parameters to identify the server for which this cmdlet gets the policy. - -## EXAMPLES - -### Example 1: Get the threat detection policy for a server -``` -PS C:\>Get-AzureRmSqlServerThreatDetectionPolicy -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -ResourceGroupName : ResourceGroup11 -ServerName : Server01 -ThreatDetectionState : Enabled -NotificationRecipientsEmails : admin@myCompany.com -StorageAccountName : mystorage -EmailAdmins : True -ExcludedDetectionTypes : {} -RetentionInDays : 0 -``` - -This command gets the threat detection policy for a server named Server01. -The server is assigned to the resource group ResourceGroup11. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the server belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ThreatDetection.Model.ServerThreatDetectionPolicyModel - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmSqlDatabaseThreatDetectionPolicy](./Remove-AzureRmSqlDatabaseThreatDetectionPolicy.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerTransparentDataEncryptionProtector.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerTransparentDataEncryptionProtector.md deleted file mode 100644 index 13e686e25a..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerTransparentDataEncryptionProtector.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlservertransparentdataencryptionprotector -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerTransparentDataEncryptionProtector.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerTransparentDataEncryptionProtector.md ---- - -# Get-AzureRmSqlServerTransparentDataEncryptionProtector - -## SYNOPSIS -Gets the Transparent Data Encryption (TDE) protector - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlServerTransparentDataEncryptionProtector [-ServerName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmSqlServerTransparentDataEncryptionProtector cmdlet gets information about the TDE protector. - -## EXAMPLES - -### Example 1: Get the Transparent Data Encryption (TDE) protector -``` -PS C:\> Get-AzureRmSqlServerTransparentDataEncryptionProtector -ServerName 'ContosoServer' -ResourceGroup 'ContosoResourceGroup' -``` - -This command gets the TDE protector for the server named ContosoServer in resource group named ContosoResourceGroup. -ResourceGroupName ServerName Type ServerKeyVaultKeyName ------------------ ---------- ---- --------------------- -ContosoResourceGroup ContosoServer ServiceManaged ServiceManaged - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The Azure Sql Server name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.AzureSqlServerTransparentDataEncryptionProtectorModel - -## NOTES - -## RELATED LINKS - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerUpgrade.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerUpgrade.md deleted file mode 100644 index 2cebb9f786..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerUpgrade.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: B3776B0B-FBC8-407A-A8A4-583C346CCF12 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlserverupgrade -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerUpgrade.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerUpgrade.md ---- - -# Get-AzureRmSqlServerUpgrade - -## SYNOPSIS -Gets the status of an Azure SQL Database server upgrade. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlServerUpgrade -ServerName <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlServerUpgrade** cmdlet gets the status of an Azure SQL Database server upgrade. - -## EXAMPLES - -### Example 1: Get the status of an upgrade -``` -PS C:\>Get-AzureRmSqlServerUpgrade -ResourceGroupName "ResourceGroup01" -ServerName "Server01" | Format-List -ResourceGroupName : resourcegroup01 -ServerName : server01 -Status : Queued -``` - -This command gets the status of an upgrade from the server named Server01 in resource group named ResourceGroup01. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the server is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server for which this cmdlet gets upgrade status. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ServerUpgrade.Model.AzureSqlServerUpgradeModel - -## NOTES - -## RELATED LINKS - -[Start-AzureRmSqlServerUpgrade](./Start-AzureRmSqlServerUpgrade.md) - -[Stop-AzureRmSqlServerUpgrade](./Stop-AzureRmSqlServerUpgrade.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerUpgradeHint.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerUpgradeHint.md deleted file mode 100644 index 52ccaeba83..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerUpgradeHint.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: BFEAE1F7-56E3-4EA9-B39A-ED09582C8A09 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlserverupgradehint -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerUpgradeHint.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerUpgradeHint.md ---- - -# Get-AzureRmSqlServerUpgradeHint - -## SYNOPSIS -Gets pricing tier hints for upgrading an Azure SQL Database server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlServerUpgradeHint [-ServerName] <String> [-ExcludeElasticPools <Boolean>] - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlServerUpgradeHint** cmdlet gets pricing tier hints for upgrading an Azure SQL Database server. -Hints may contain the elastic database pool and stand-alone database hints. -Databases that are still in Web and Business pricing tiers get a hint to upgrade to the new Basic, Standard, or Premium pricing tiers, or to go into the elastic database pool. -This cmdlet returns hints for all databases hosted on the specified server. - -## EXAMPLES - -### Example 1: Get combined recommendations -``` -PS C:\>Get-AzureRmSqlServerUpgradeHint -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ElasticPools Databases ------------- --------- -{} {database01, database02} -``` - -This command gets combined recommendations for all the databases on a server named Server01. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeElasticPools -Indicates whether databases that are included in elastic database pools should be returned. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the server is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server for which this cmdlet gets an upgrade hint. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Boolean - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ServiceTierAdvisor.Model.UpgradeServerHint - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlDatabaseExpanded](./Get-AzureRmSqlDatabaseExpanded.md) - -[Get-AzureRmSqlElasticPoolRecommendation](./Get-AzureRmSqlElasticPoolRecommendation.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerVirtualNetworkRule.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerVirtualNetworkRule.md deleted file mode 100644 index 7b53f5a6de..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlServerVirtualNetworkRule.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlservervirtualnetworkrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerVirtualNetworkRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerVirtualNetworkRule.md ---- - -# Get-AzureRmSqlServerVirtualNetworkRule - -## SYNOPSIS -Gets or lists Azure SQL Server Virtual Network Rule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlServerVirtualNetworkRule [-VirtualNetworkRuleName <String>] -ServerName <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -This command gets a specific Azure SQL Server Virtual Network Rule or a list of Azure SQL Server Virtual Network Rules under a server. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $virtualNetworkRule = Get-AzureRmSqlServerVirtualNetworkRule -ResourceGroupName rg -ServerName serverName -VirtualNetworkRuleName virtualNetworkRuleName -``` - -Gets an single Azure SQL Server virtual network rule - -### Example 2 -``` -PS C:\> $virtualNetworkRules = Get-AzureRmSqlServerVirtualNetworkRule -ResourceGroupName rg -ServerName serverName -``` - -Gets the list of Azure SQL Server virtual network rules under the specified server - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The Azure Sql Server name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkRuleName -The Azure Sql Server Virtual Network Rule name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.VirtualNetworkRule.Model.AzureSqlServerVirtualNetworkRuleModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlSyncAgent.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlSyncAgent.md deleted file mode 100644 index 3aefff6ad3..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlSyncAgent.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlsyncagent -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncAgent.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncAgent.md ---- - -# Get-AzureRmSqlSyncAgent - -## SYNOPSIS -Returns information about Azure SQL Sync Agents. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlSyncAgent [[-Name] <String>] [-ServerName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlSyncAgent** cmdlet returns information about one or more Azure SQL Sync Agents. -Specify the name of a sync agent to see information for only that sync agent. - -## EXAMPLES - -### Example 1: Get all instances of Azure SQL Sync Agent assigned to an Azure SQL Server -``` -PS C:\>Get-AzureRmSqlSyncAgent -ResourceGroupName "ResourceGroup01" -ServerName "Server01" | Format-List -ResourceId : subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/syncAgents/{SyncAgent01} -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -SyncAgentName : SyncAgent01 -SyncDatabaseId : subscriptions/{subscriptionId}/resourceGroups/{syncDatabaseResourceGroup01}/servers/{syncDatabaseServer01}/databases/{syncDatabaseName01} -LastAliveTime: : 6/1/2017 5:08:48 AM -Version : 4.3.6348.1 -IsUpToDate : False -ExpiryTime : -State : Online - -ResourceId : subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/syncAgents/{SyncAgent02} -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -SyncAgentName : SyncAgent02 -SyncDatabaseId : subscriptions/{subscriptionId}/resourceGroups/{syncDatabaseResourceGroup01}/servers/{syncDatabaseServer01}/databases/{syncDatabaseName01} -LastAliveTime: : 6/1/2017 5:08:48 AM -Version : 4.3.6348.1 -IsUpToDate : False -ExpiryTime : -State : Online -``` - -This command gets information about all the Azure SQL Sync Agents assigned to an Azure SQL Server. - -### Example 2: Get information about an Azure SQL Sync Agent -``` -PS C:\>Get-AzureRmSqlSyncAgent -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -Name "SyncAgent01" | Format-List -ResourceId : subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/syncAgents/{SyncAgent01} -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -SyncAgentName : SyncAgent01 -SyncDatabaseId : subscriptions/{subscriptionId}/resourceGroups/{syncDatabaseResourceGroup01}/servers/{syncDatabaseServer01}/databases/{syncDatabaseName01} -LastAliveTime: : 6/1/2017 5:08:48 AM -Version : 4.3.6348.1 -IsUpToDate : False -ExpiryTime : -State : Online -``` - -This command gets information about the Azure SQL Database Sync Agent with name "SyncAgent01" - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The sync agent name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: SyncAgentName - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The name of the Azure SQL Server the sync agent is in. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncAgentModel - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmSqlSyncAgent](./Remove-AzureRmSqlSyncAgent.md) - -[New-AzureRmSqlSyncAgent](./New-AzureRmSqlSyncAgent.md) - diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlSyncAgentLinkedDatabase.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlSyncAgentLinkedDatabase.md deleted file mode 100644 index 6cce8642cf..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlSyncAgentLinkedDatabase.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlsyncagentlinkeddatabase -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncAgentLinkedDatabase.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncAgentLinkedDatabase.md ---- - -# Get-AzureRmSqlSyncAgentLinkedDatabase - -## SYNOPSIS -Returns information about SQL Server databases linked by a sync agent. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlSyncAgentLinkedDatabase [-ServerName] <String> [-SyncAgentName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlSyncAgentLinkedDatabases** cmdlet returns information about SQL Server databases linked by a sync agent. - -## EXAMPLES - -### Example 1: Get the linked SQL Server databases for an Azure SQL sync agent. -``` -PS C:\> Get-AzureRmSqlSyncAgentLinkedDatabases -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -SyncAgentName "SyncAgent01" | Format-List -SeverName : sever01 -DatabaseId : databaseId -DatabaseName : database01 -DatabaseType : SQLServerDatabase -Description : -UserName : myAccount -``` - -This command returns the linked SQL Server databases linked by an Azure SQL sync agent. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The name of the Azure SQL Server the sync agent is in. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SyncAgentName -The sync agent name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncAgentLinkedDatabaseModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlSyncGroup.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlSyncGroup.md deleted file mode 100644 index 335e722750..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlSyncGroup.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlsyncgroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncGroup.md ---- - -# Get-AzureRmSqlSyncGroup - -## SYNOPSIS -Returns information about Azure SQL Database Sync Groups. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlSyncGroup [[-Name] <String>] [-ServerName] <String> [-DatabaseName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlSyncGroup** cmdlet returns information about one or more Azure SQL Database Sync Groups. -Specify the name of a sync group to see information for only that sync group. - -## EXAMPLES - -### Example 1: Get all instances of Azure SQL Sync Group assigned to an Azure SQL Database -``` -PS C:\>Get-AzureRmSqlSyncGroup -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" | Format-List -ResourceId : /subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup01} -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -SyncGroupName : SyncGroup01 -SyncDatabaseId : subscriptions/{subscriptionId}/resourceGroups/{syncDatabaseResourceGroup01}/servers/{syncDatabaseServer01}/databases/{syncDatabaseName01} -IntervalInSeconds : 100 -ConflictResolutionPolicy: : HubWin -HubDatabaseUserName : myAccount -HubDatabasePassword : -SyncState : NotReady -LastSyncTime : 1/1/0001 12:00:00 AM -Schema : - -ResourceId : /subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup02} -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -SyncGroupName : SyncGroup02 -SyncDatabaseId : subscriptions/{subscriptionId}/resourceGroups/{syncDatabaseResourceGroup01}/servers/{syncDatabaseServer01}/databases/{syncDatabaseName01} -IntervalInSeconds : 100 -ConflictResolutionPolicy: : HubWin -HubDatabaseUserName : myAccount -HubDatabasePassword : -SyncState : NotReady -LastSyncTime : 1/1/0001 12:00:00 AM -Schema : -``` - -This command gets information about all the Azure SQL Database Sync Groups assigned to an Azure SQL Database. - -### Example 2: Get information about an Azure SQL Database Sync Group -``` -PS C:\>Get-AzureRmSqlSyncGroup -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -Name "SyncGroup01" | Format-List -ResourceId : /subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup02} -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -SyncGroupName : SyncGroup02 -SyncDatabaseId : subscriptions/{subscriptionId}/resourceGroups/{syncDatabaseResourceGroup01}/servers/{syncDatabaseServer01}/databases/{syncDatabaseName01} -IntervalInSeconds : 100 -ConflictResolutionPolicy: : HubWin -HubDatabaseUserName : myAccount -HubDatabasePassword : -SyncState : NotReady -LastSyncTime : 1/1/0001 12:00:00 AM -Schema : -``` - -This command gets information about the Azure SQL Database Sync Group with name "SyncGroup01" - -## PARAMETERS - -### -DatabaseName -The name of the Azure SQL Database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The sync group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: SyncGroupName - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The name of the Azure SQL Server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncGroupModel - -## NOTES - -## RELATED LINKS - -[New-AzureRmSqlSyncGroup](./New-AzureRmSqlSyncGroup.md) - -[Update-AzureRmSqlSyncGroup](./Update-AzureRmSqlSyncGroup.md) - -[Remove-AzureRmSqlSyncGroup](./Remove-AzureRmSqlSyncGroup.md) - diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlSyncGroupLog.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlSyncGroupLog.md deleted file mode 100644 index 7f7a08f15f..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlSyncGroupLog.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlsyncgrouplog -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncGroupLog.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncGroupLog.md ---- - -# Get-AzureRmSqlSyncGroupLog - -## SYNOPSIS -Returns the logs of an Azure SQL Database Sync Group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlSyncGroupLog [-SyncGroupName] <String> -StartTime <DateTime> [-EndTime <DateTime>] - [-LogLevel <String>] [-ServerName] <String> [-DatabaseName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlSyncGroupLog** cmdlet returns the logs of an Azure SQL Database Sync Group. - -## EXAMPLES - -### Example 1: Get the logs of an Azure SQL Sync Group -``` -PS C:\>Get-AzureRmSqlSyncGroupLog -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -SyncGroupName "SyncGroup01" -StartTime "9/16/2016 11:31:12" -EndTime "9/16/2016 12:31:00" -LogLevel "All" -TimeStamp LogLevel Details Source ---------- -------- ------- ------ -6/13/2017 9:14:26 AM Success Schema information obtained successfully. fangltest2.database.windows.net/fangltest -6/13/2017 7:11:59 AM Success Schema information obtained successfully. fangltest2.database.windows.net/fangltest -``` - -This command gets the logs of an Azure SQL Sync Group. - -## PARAMETERS - -### -DatabaseName -The name of the Azure SQL Database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndTime -The end time of the logs to query. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogLevel -The type of the logs to query. -Valid values are: 'Error', 'Warning', 'Success' and 'All'. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Error, Warning, Success, All - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The name of the Azure SQL Server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartTime -The start time of the logs to query. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SyncGroupName -The sync group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncGroupLogModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlSyncMember.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlSyncMember.md deleted file mode 100644 index b69c8c1cd7..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlSyncMember.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlsyncmember -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncMember.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncMember.md ---- - -# Get-AzureRmSqlSyncMember - -## SYNOPSIS -Returns information about Azure SQL Database Sync Members. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlSyncMember [-Name <String>] [-SyncGroupName] <String> [-ServerName] <String> - [-DatabaseName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlSyncMember** cmdlet returns information about one or more Azure SQL Database Sync Members. -Specify the name of a sync member to see information for only that sync member. - -## EXAMPLES - -### Example 1: Get all instances of Azure SQL Sync Member assigned to a sync group -``` -PS C:\>Get-AzureRmSqlSyncMember -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -SyncGroupName "SyncGroup01" | Format-List -ResourceId : subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup01}/syncMembers/{SyncMember01} -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -SyncGroupName : SyncGroup01 -SyncMemberName : SyncMember01 -SyncDirection : OneWayMemberToHub -MemberDatabaseType: : AzureSqlDatabase -SyncAgentId : -SqlServerDatabaseId : -MemberServerName : memberServer01.full.dns.name -MemberDatabaseName : memberDatabase01 -MemberDatabaseUserName : myAccount -MemberDatabasePassword : -SyncState : Good - -ResourceId : subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup01}/syncMembers/{SyncMember02} -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -SyncGroupName : SyncGroup01 -SyncMemberName : SyncMember02 -SyncDirection : OneWayMemberToHub -MemberDatabaseType: : AzureSqlDatabase -SyncAgentId : -SqlServerDatabaseId : -MemberServerName : memberServer01.full.dns.name -MemberDatabaseName : memberDatabase01 -MemberDatabaseUserName : myAccount -MemberDatabasePassword : -SyncState : Good -``` - -This command gets information about all the Azure SQL Database Sync Member assigned to the sync group SyncGroup01. - -### Example 2: Get information about an Azure SQL Database Sync Member -``` -PS C:\>Get-AzureRmSqlSyncMember -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -SyncGroupName "SyncGroup01" -Name "SyncMember01" | Format-List -ResourceId : subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup01}/syncMembers/{SyncMember01} -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -SyncGroupName : SyncGroup01 -SyncMemberName : SyncMember01 -SyncDirection : OneWayMemberToHub -MemberDatabaseType: : AzureSqlDatabase -SyncAgentId : -SqlServerDatabaseId : -MemberServerName : memberServer01.full.dns.name -MemberDatabaseName : memberDatabase01 -MemberDatabaseUserName : myAccount -MemberDatabasePassword : -SyncState : Good -``` - -This command gets information about the Azure SQL Database Sync Member with name "SyncMember01" - -## PARAMETERS - -### -DatabaseName -The name of the Azure SQL Database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The sync member name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: SyncMemberName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The name of the Azure SQL Server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SyncGroupName -The sync group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncMemberModel - -## NOTES - -## RELATED LINKS - -[New-AzureRmSqlSyncMember](./New-AzureRmSqlSyncMember.md) - -[Update-AzureRmSqlSyncMember](./Update-AzureRmSqlSyncMember.md) - -[Remove-AzureRmSqlSyncMember](./Remove-AzureRmSqlSyncMember.md) - diff --git a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlSyncSchema.md b/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlSyncSchema.md deleted file mode 100644 index 0163ab9527..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Get-AzureRmSqlSyncSchema.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/get-azurermsqlsyncschema -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncSchema.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncSchema.md ---- - -# Get-AzureRmSqlSyncSchema - -## SYNOPSIS -Returns information about the sync schema of a member database or a hub database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSqlSyncSchema [-SyncGroupName] <String> [-SyncMemberName <String>] [-ServerName] <String> - [-DatabaseName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSqlSyncSchema** cmdlet returns information about the sync schema of a member database or a hub database. - -## EXAMPLES - -### Example 1.1: Get the sync schema for a hub database -``` -PS C:\>Get-AzureRmSqlSyncSchema -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "database01" -SyncGroupName "syncGroup01" -Tables LastUpdateTime ------- -------------- -{dbo.Table_1, dbo.Table_2} 6/13/2017 10:03:44 AM -``` - -This command gets the sync schema for the hub database in the sync group syncGroup01. - -### Example 1.2: Get the sync schema for a hub database, and expand Tables -``` -PS C:\>Get-AzureRmSqlSyncSchema -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "database01" -SyncGroupName "syncGroup01" | select -ExpandProperty Tables -Columns : {column1, column2} -ErrorId : Schema_TableHasNoPrimaryKey -HasError : True -Name : dbo.Table_1 -QuotedName : [dbo].[Table_1] - -Columns : {column2, column4} -ErrorId : Schema_TableHasNoPrimaryKey -HasError : True -Name : dbo.Table_2 -QuotedName : [dbo].[Table_2] -``` - -This command gets the sync schema for the hub database in the sync group syncGroup01 and expand Tables property. - -### Example 2: Get the sync schema for a member database -``` -PS C:\>Get-AzureRmSqlSyncSchema -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "database01" -SyncGroupName "syncGroup01" -SyncMemberName "syncMember01" -The schema payload is the same as Example 1. -``` - -This command gets the sync schema for the member database in the sync member syncMember01. - -## PARAMETERS - -### -DatabaseName -The name of the Azure SQL Database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The name of the Azure SQL Server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SyncGroupName -The sync group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SyncMemberName -The sync member name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncFullSchemaModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlDatabase.md b/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlDatabase.md deleted file mode 100644 index cdba3505da..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlDatabase.md +++ /dev/null @@ -1,478 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: D2DB7821-A7D2-4017-8522-78793DDE040E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/new-azurermsqldatabase -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabase.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabase.md ---- - -# New-AzureRmSqlDatabase - -## SYNOPSIS -Creates a database or an elastic database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DtuBasedDatabase (Default) -``` -New-AzureRmSqlDatabase -DatabaseName <String> [-CollationName <String>] [-CatalogCollation <String>] - [-MaxSizeBytes <Int64>] [-Edition <String>] [-RequestedServiceObjectiveName <String>] - [-ElasticPoolName <String>] [-ReadScale <DatabaseReadScale>] [-Tags <Hashtable>] [-SampleName <String>] - [-ZoneRedundant] [-AsJob] [-LicenseType <String>] [-ServerName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### VcoreBasedDatabase -``` -New-AzureRmSqlDatabase -DatabaseName <String> [-CollationName <String>] [-CatalogCollation <String>] - [-MaxSizeBytes <Int64>] -Edition <String> [-ReadScale <DatabaseReadScale>] [-Tags <Hashtable>] - [-SampleName <String>] [-ZoneRedundant] [-AsJob] -VCore <Int32> -ComputeGeneration <String> - [-LicenseType <String>] [-ServerName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmSqlDatabase** cmdlet creates an Azure SQL database. -You can also create an elastic database by setting the *ElasticPoolName* parameter to an existing elastic pool. - -## EXAMPLES - -### Example 1: Create a database on a specified server -``` -PS C:\>New-AzureRmSqlDatabase -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -Location : Central US -DatabaseId : a1e6bd1a-735a-4d48-8b98-afead5ef1218 -Edition : Standard -CollationName : SQL_Latin1_General_CP1_CI_AS -CatalogCollation : -MaxSizeBytes : 268435456000 -Status : Online -CreationDate : 7/3/2015 7:33:37 AM -CurrentServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b -CurrentServiceObjectiveName : S0 -RequestedServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b -RequestedServiceObjectiveName : -ElasticPoolName : -EarliestRestoreDate : -LicenseType : -Tags : -``` - -This command creates a database named Database01 on server Server01. - -### Example 2: Create an elastic database on a specified server -``` -PS C:\>New-AzureRmSqlDatabase -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -ElasticPoolName "ElasticPool01" -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database02 -Location : Central US -DatabaseId : 7bd9d561-42a7-484e-bf05-62ddef8015ab -Edition : Standard -CollationName : SQL_Latin1_General_CP1_CI_AS -CatalogCollation : -MaxSizeBytes : 268435456000 -Status : Online -CreationDate : 8/26/2015 10:04:29 PM -CurrentServiceObjectiveId : d1737d22-a8ea-4de7-9bd0-33395d2a7419 -CurrentServiceObjectiveName : ElasticPool -RequestedServiceObjectiveId : d1737d22-a8ea-4de7-9bd0-33395d2a7419 -RequestedServiceObjectiveName : -ElasticPoolName : ElasticPool01 -EarliestRestoreDate : -LicenseType : -Tags : -``` - -This command creates a database named Database02 in the elastic pool named ElasticPool01 on server Server01. - -### Example 3: Create an Vcore database on a specified server -``` -PS C:\>New-AzureRmSqlDatabase -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database03" -Edition "GeneralPurpose" -Vcore 2 -ComputeGeneration "Gen4" -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database03 -Location : Central US -DatabaseId : 34d9d561-42a7-484e-bf05-62ddef8000ab -Edition : GeneralPurpose -CollationName : SQL_Latin1_General_CP1_CI_AS -CatalogCollation : -MaxSizeBytes : 268435456000 -Status : Online -CreationDate : 8/26/2015 10:04:29 PM -CurrentServiceObjectiveName : GP_Gen4_2 -RequestedServiceObjectiveName : -ElasticPoolName : -EarliestRestoreDate : -LicenseType : LicenseIncluded -Tags : -``` - -This command creates a Vcore database named Database03 on server Server01. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CatalogCollation -Specifies the name of the SQL database catalog collation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CollationName -Specifies the name of the SQL database collation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputeGeneration -The compute generation to assign. - -```yaml -Type: System.String -Parameter Sets: VcoreBasedDatabase -Aliases: Family - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Edition -Specifies the edition to assign to the database. The acceptable values for this parameter are: -- None -- Basic -- Standard -- Premium -- DataWarehouse -- Free -- Stretch -- GeneralPurpose -- BusinessCritical - -```yaml -Type: System.String -Parameter Sets: DtuBasedDatabase -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: VcoreBasedDatabase -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ElasticPoolName -Specifies the name of the elastic pool in which to put the database. - -```yaml -Type: System.String -Parameter Sets: DtuBasedDatabase -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LicenseType -The license type for the Azure Sql database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxSizeBytes -Specifies the maximum size of the database in bytes. - -```yaml -Type: System.Int64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadScale -The read scale option to assign to the Azure SQL Database.(Enabled/Disabled) - -```yaml -Type: Microsoft.Azure.Commands.Sql.Database.Model.DatabaseReadScale -Parameter Sets: (All) -Aliases: -Accepted values: Disabled, Enabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestedServiceObjectiveName -Specifies the name of the service objective to assign to the database. - -```yaml -Type: System.String -Parameter Sets: DtuBasedDatabase -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the server is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SampleName -The name of the sample schema to apply when creating this database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: AdventureWorksLT - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server that hosts the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tags -Specifies a dictionary of Key-value pairs in the form of a hash table that this cmdlet associates -with the new database. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tag - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VCore -The Vcore number for the Azure Sql database - -```yaml -Type: System.Int32 -Parameter Sets: VcoreBasedDatabase -Aliases: Capacity - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZoneRedundant -The zone redundancy to associate with the Azure Sql Database - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlDatabase](./Get-AzureRmSqlDatabase.md) - -[New-AzureRmSqlElasticPool](./New-AzureRmSqlElasticPool.md) - -[New-AzureRmSqlServer](./New-AzureRmSqlServer.md) - -[Remove-AzureRmSqlDatabase](./Remove-AzureRmSqlDatabase.md) - -[Resume-AzureRmSqlDatabase](./Resume-AzureRmSqlDatabase.md) - -[Set-AzureRmSqlDatabase](./Set-AzureRmSqlDatabase.md) - -[Suspend-AzureRmSqlDatabase](./Suspend-AzureRmSqlDatabase.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - diff --git a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlDatabaseCopy.md b/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlDatabaseCopy.md deleted file mode 100644 index 3473718446..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlDatabaseCopy.md +++ /dev/null @@ -1,307 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: CED38886-2DC9-450E-91FF-8209602C76CD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/new-azurermsqldatabasecopy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseCopy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseCopy.md ---- - -# New-AzureRmSqlDatabaseCopy - -## SYNOPSIS -Creates a copy of a SQL Database that uses the snapshot at the current time. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DtuBasedDatabase (Default) -``` -New-AzureRmSqlDatabaseCopy [-DatabaseName] <String> [-ServiceObjectiveName <String>] - [-ElasticPoolName <String>] [-Tags <Hashtable>] [-CopyResourceGroupName <String>] [-CopyServerName <String>] - -CopyDatabaseName <String> [-AsJob] [-LicenseType <String>] [-ServerName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### VcoreBasedDatabase -``` -New-AzureRmSqlDatabaseCopy [-DatabaseName] <String> [-Tags <Hashtable>] [-CopyResourceGroupName <String>] - [-CopyServerName <String>] -CopyDatabaseName <String> [-AsJob] -ComputeGeneration <String> -VCore <Int32> - [-LicenseType <String>] [-ServerName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmSqlDatabaseCopy** cmdlet creates a copy of an Azure SQL Database that uses the -snapshot of the data at the current time. Use this cmdlet instead of the Start-AzureSqlDatabaseCopy -cmdlet to create a one-time database copy. This cmdlet returns the **Database** object of the copy. -Note: Use the New-AzureRmSqlDatabaseSecondary cmdlet to configure geo-replication for a database. -This cmdlet is also supported by the SQL Server Stretch Database service on Azure. - -## EXAMPLES - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputeGeneration -The compute generation to assign to the new copy. - -```yaml -Type: System.String -Parameter Sets: VcoreBasedDatabase -Aliases: Family - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CopyDatabaseName -Specifies the name of the SQL Database copy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CopyResourceGroupName -Specifies the name of the Azure Resource Group in which to assign the copy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CopyServerName -Specifies the name of the SQL Server which hosts the copy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the SQL Database to copy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ElasticPoolName -Specifies the name of the elastic pool in which to assign the copy. - -```yaml -Type: System.String -Parameter Sets: DtuBasedDatabase -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LicenseType -The license type for the Azure Sql database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the Resource Group that contains the database to copy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the SQL Server that contains the database to copy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceObjectiveName -Specifies the name of the service objective to assign to the copy. - -```yaml -Type: System.String -Parameter Sets: DtuBasedDatabase -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tags -Specifies the Key-value pairs in the form of a hash table to associate with the Azure SQL Database copy. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tag - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VCore -The Vcore numbers of the Azure Sql Database copy. - -```yaml -Type: System.Int32 -Parameter Sets: VcoreBasedDatabase -Aliases: Capacity - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Replication.Model.AzureSqlDatabaseCopyModel - -## NOTES - -## RELATED LINKS - -[New-AzureRmSqlDatabaseSecondary](./New-AzureRmSqlDatabaseSecondary.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlDatabaseDataMaskingRule.md b/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlDatabaseDataMaskingRule.md deleted file mode 100644 index 977bf3c1c5..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlDatabaseDataMaskingRule.md +++ /dev/null @@ -1,340 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: A123CB7F-2F95-49EE-9F57-E264EB1F9093 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/new-azurermsqldatabasedatamaskingrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseDataMaskingRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseDataMaskingRule.md ---- - -# New-AzureRmSqlDatabaseDataMaskingRule - -## SYNOPSIS -Creates a data masking rule for a database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmSqlDatabaseDataMaskingRule -MaskingFunction <String> [-PrefixSize <UInt32>] - [-ReplacementString <String>] [-SuffixSize <UInt32>] [-NumberFrom <Double>] [-NumberTo <Double>] [-PassThru] - -SchemaName <String> -TableName <String> -ColumnName <String> [-ServerName] <String> [-DatabaseName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmSqlDatabaseDataMaskingRule** cmdlet creates a data masking rule for an Azure SQL database. -To use the cmdlet, use the *ResourceGroupName*, *ServerName*, *DatabaseName*, and *RuleId* parameters to identify the rule. -Provide the *TableName* and *ColumnName* to specify the target of the rule and the *MaskingFunction* parameter to define how the data is masked. -If *MaskingFunction* has a value of Number or Text, you can specify the *NumberFrom* and *NumberTo* parameters, for number masking, or the *PrefixSize*, *ReplacementString*, and *SuffixSize* for text masking. -If the command succeeds and the *PassThru* parameter is used, the cmdlet returns an object describing the data masking rule properties in addition to the rule identifiers. -Rule identifiers include, but are not limited to, *ResourceGroupName*, *ServerName*, *DatabaseName*, and *RuleID*. -This cmdlet is also supported by the SQL Server Stretch Database service on Azure. - -## EXAMPLES - -### Example 1: Create a data masking rule for a number column in a database -``` -PS C:\>New-AzureRmSqlDatabaseDataMaskingRule -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -RuleId "Rule01" -SchemaName "Schema01" -TableName "Table01" -ColumnName "Column01" -MaskingFunction "Number" -NumberFrom 5 -NumberTo 14 -``` - -This command creates a data masking rule for the column named Column01 in the table named Table01 in the schema named Schema01. -The database named Database01 contains all these items. -The rule is a number masking rule that uses a random number between 5 and 14 as the mask value. -The rule is named Rule01. - -## PARAMETERS - -### -ColumnName -Specifies the name of the column targeted by the masking rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaskingFunction -Specifies the masking function that the rule uses. -The acceptable values for this parameter are: -- Default -- NoMasking -- Text -- Number -- SocialSecurityNumber -- CreditCardNumber -- Email -The default value is Default. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: NoMasking, Default, Text, Number, SocialSecurityNumber, CreditCardNumber, Email - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NumberFrom -Specifies the lower bound number of the interval from which a random value is selected. -Specify this parameter only if you specify a value of Number for the *MaskingFunction* parameter. -The default value is 0. - -```yaml -Type: System.Nullable`1[System.Double] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NumberTo -Specifies the upper bound number of the interval from which a random value is selected. -Specify this parameter only if you specify a value of Number for the *MaskingFunction* parameter. -The default value is 0. - -```yaml -Type: System.Nullable`1[System.Double] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrefixSize -Specifies the number of characters at the start of the text that are not masked. -Specify this parameter only if you specify a value of Text for the *MaskingFunction* parameter. -The default value is 0. - -```yaml -Type: System.Nullable`1[System.UInt32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReplacementString -Specifies the number of characters in the end of the text that are not masked. -Specify this parameter only if you specify a value of Text for the *MaskingFunction* parameter. -The default value is an empty string. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the database is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SchemaName -Specifies the name of a schema. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server that hosts the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SuffixSize -Specifies the number of characters at the end of the text that are not masked. -Specify this parameter only if you specify a value of Text for the *MaskingFunction* parameter. -The default value is 0. - -```yaml -Type: System.Nullable`1[System.UInt32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TableName -Specifies the name of the database table that contains the masked column. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.UInt32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Nullable`1[[System.Double, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.DataMasking.Model.DatabaseDataMaskingRuleModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlDatabaseDataMaskingRule](./Get-AzureRmSqlDatabaseDataMaskingRule.md) - -[Remove-AzureRmSqlDatabaseDataMaskingRule](./Remove-AzureRmSqlDatabaseDataMaskingRule.md) - -[Set-AzureRmSqlDatabaseDataMaskingRule](./Set-AzureRmSqlDatabaseDataMaskingRule.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlDatabaseExport.md b/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlDatabaseExport.md deleted file mode 100644 index 74b0466e49..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlDatabaseExport.md +++ /dev/null @@ -1,273 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 3D4822DD-736B-42DF-8D9A-1CB23FEF052E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/new-azurermsqldatabaseexport -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseExport.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseExport.md ---- - -# New-AzureRmSqlDatabaseExport - -## SYNOPSIS -Exports an Azure SQL Database as a .bacpac file to a storage account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmSqlDatabaseExport [-DatabaseName] <String> [-ServerName] <String> -StorageKeyType <StorageKeyType> - -StorageKey <String> -StorageUri <Uri> -AdministratorLogin <String> -AdministratorLoginPassword <SecureString> - [-AuthenticationType <AuthenticationType>] [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmSqlDatabaseExport** cmdlet exports an Azure SQL Database as a .bacpac file to a storage account. -The get export database status request may be sent to retrieve status information for this request. -This cmdlet is also supported by the SQL Server Stretch Database service on Azure. - -## EXAMPLES - -### Example 1: Create an export request for a database -``` -PS C:\>New-AzureRmSqlDatabaseExport -ResourceGroupName "RG01" -ServerName "Server01" -DatabaseName "Database01" -StorageKeyType "StorageAccessKey" -StorageKey "StorageKey01" -StorageUri "http://account01.blob.core.contoso.net/bacpacs/database01.bacpac" -AdministratorLogin "User" -AdministratorLoginPassword "secure password" -ResourceGroupName : RG01 -ServerName : Server01 -DatabaseName : Database01 -StorageKeyType : StorageAccessKey -StorageKey : -StorageUri : http://account01.blob.core.contoso.net/bacpacs/database01.bacpac -AdministratorLogin : User -AdministratorLoginPassword : -AuthenticationType : None -OperationStatusLink : https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resource01/providers/Microsoft.Sql/servers/server01/databases/database01/importExportOperationResults/00000000-00 - 0-0000-0000-000000000000?api-version=2014-04-01 -Status : InProgress -ErrorMessage : -``` - -This command creates an export request for the specified database. - -## PARAMETERS - -### -AdministratorLogin -Specifies the name of the SQL administrator. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AdministratorLoginPassword -Specifies the password of the SQL administrator. - -```yaml -Type: System.Security.SecureString -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthenticationType -Specifies the type of authentication used to access the server. -The default value is SQL if no authentication type is set. -The acceptable values for this parameter are: -- Sql. -SQL authentication. -Set the *AdministratorLogin* and *AdministratorLoginPassword* to the SQL administrator username and password. -- ADPassword. -Microsoft Entra authentication. -Set *AdministratorLogin* and *AdministratorLoginPassword* to the Microsoft Entra administrator username and password. -This parameter is only available on SQL Database V12 servers. - -```yaml -Type: Microsoft.Azure.Commands.Sql.ImportExport.Model.AuthenticationType -Parameter Sets: (All) -Aliases: -Accepted values: None, Sql, AdPassword - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the SQL Database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for the SQL Database server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the SQL Database server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageKey -Specifies the access key for the storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageKeyType -Specifies the type of access key for the storage account. -The acceptable values for this parameter are: -- StorageAccessKey. -This value uses a storage account key. -- SharedAccessKey. -This value uses a Shared Access Signature (SAS) key. - -```yaml -Type: Microsoft.Azure.Commands.Sql.ImportExport.Model.StorageKeyType -Parameter Sets: (All) -Aliases: -Accepted values: StorageAccessKey, SharedAccessKey - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageUri -Specifies the blob link, as a URL, to the .bacpac file. - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ImportExport.Model.AzureSqlDatabaseImportExportBaseModel - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - -## RELATED LINKS - -[Get-AzureRmSqlDatabaseImportExportStatus](./Get-AzureRmSqlDatabaseImportExportStatus.md) - -[New-AzureRmSqlDatabaseImport](./New-AzureRmSqlDatabaseImport.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlDatabaseFailoverGroup.md b/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlDatabaseFailoverGroup.md deleted file mode 100644 index 85020b0e6d..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlDatabaseFailoverGroup.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/new-azurermsqldatabasefailovergroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseFailoverGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseFailoverGroup.md ---- - -# New-AzureRmSqlDatabaseFailoverGroup - -## SYNOPSIS -This command creates a new Azure SQL Database Failover Group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmSqlDatabaseFailoverGroup [-ServerName] <String> -FailoverGroupName <String> - [-PartnerResourceGroupName <String>] -PartnerServerName <String> [-FailoverPolicy <FailoverPolicy>] - [-GracePeriodWithDataLossHours <Int32>] [-AllowReadOnlyFailoverToPrimary <AllowReadOnlyFailoverToPrimary>] - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Creates a new Azure SQL Database Failover Group for the specified servers. -Two Azure SQL Database TDS endpoints are created at FailoverGroupName.SqlDatabaseDnsSuffix (for example, FailoverGroupName.database.windows.net) and FailoverGroupName.secondary.SqlDatabaseDnsSuffix. These endpoints may be used to connect to the primary and secondary servers in the Failover Group, respectively. If the primary server is affected by an outage, automatic failover of the endpoints and databases will be triggered as dictated by the Failover Group's failover policy and grace period. -Newly created Failover Groups do not contain any databases. To control the set of databases in a Failover Group, use the 'Add-AzureRmSqlDatabaseToFailoverGroup' and 'Remove-AzureRmSqlDatabaseFromFailoverGroup' cmdlets. -During preview of the Failover Groups feature, only values greater than or equal to 1 hour are supported for the '-GracePeriodWithDataLossHours' parameter. - -## EXAMPLES - -### Example 1 -``` -C:\> $failoverGroup = New-AzureRMSqlDatabaseFailoverGroup -ResourceGroupName rg -ServerName primaryserver -PartnerServerName secondaryserver -FailoverGroupName fg -FailoverPolicy Automatic -GracePeriodWithDataLossHours 1 -``` - -This command creates a new Failover Group with failover policy 'Automatic' for two servers in the same resource group. - -### Example 2 -``` -C:\> $failoverGroup = New-AzureRMSqlDatabaseFailoverGroup -ResourceGroupName rg1 -ServerName primaryserver -PartnerResourceGroupName rg2 -PartnerServerName secondaryserver1 -FailoverGroupName fg -FailoverPolicy Manual -``` - -This command creates a new Failover Group with failover policy 'Manual' for two servers in different resource groups. - -## PARAMETERS - -### -AllowReadOnlyFailoverToPrimary -Whether an outage on the secondary server should trigger automatic failover of the read-only endpoint. This feature is not yet supported. - -```yaml -Type: Microsoft.Azure.Commands.Sql.FailoverGroup.Model.AllowReadOnlyFailoverToPrimary -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FailoverGroupName -The name of the Azure SQL Database Failover Group to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FailoverPolicy -The failover policy of the Azure SQL Database Failover Group. - -```yaml -Type: Microsoft.Azure.Commands.Sql.FailoverGroup.Model.FailoverPolicy -Parameter Sets: (All) -Aliases: -Accepted values: Automatic, Manual - -Required: False -Position: Named -Default value: Automatic -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GracePeriodWithDataLossHours -Interval before automatic failover is initiated if an outage occurs on the primary server and failover cannot be completed without data loss. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 1 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PartnerResourceGroupName -The name of the secondary resource group of the Azure SQL Database Failover Group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PartnerServerName -The name of the secondary server of the Azure SQL Database Failover Group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The name of the primary Azure SQL Database Server of the Failover Group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.FailoverGroup.Model.AzureSqlFailoverGroupModel - -## NOTES - -## RELATED LINKS - -[Set-AzureRmSqlDatabaseFailoverGroup](./Set-AzureRmSqlDatabaseFailoverGroup.md) - -[Get-AzureRmSqlDatabaseFailoverGroup](./Get-AzureRmSqlDatabaseFailoverGroup.md) - -[Add-AzureRmSqlDatabaseToFailoverGroup](./Add-AzureRmSqlDatabaseToFailoverGroup.md) - -[Remove-AzureRmSqlDatabaseFromFailoverGroup](./Remove-AzureRmSqlDatabaseFromFailoverGroup.md) - -[Switch-AzureRmSqlDatabaseFailoverGroup](./Switch-AzureRmSqlDatabaseFailoverGroup.md) - -[Remove-AzureRmSqlDatabaseFailoverGroup](./Remove-AzureRmSqlDatabaseFailoverGroup.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlDatabaseImport.md b/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlDatabaseImport.md deleted file mode 100644 index d269c50f80..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlDatabaseImport.md +++ /dev/null @@ -1,325 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: A1327BC6-F090-490E-8DC2-2CC48A21C2C0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/new-azurermsqldatabaseimport -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseImport.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseImport.md ---- - -# New-AzureRmSqlDatabaseImport - -## SYNOPSIS -Imports a .bacpac file and create a new database on the server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmSqlDatabaseImport -DatabaseName <String> -Edition <DatabaseEdition> -ServiceObjectiveName <String> - -DatabaseMaxSizeBytes <Int64> [-ServerName] <String> -StorageKeyType <StorageKeyType> -StorageKey <String> - -StorageUri <Uri> -AdministratorLogin <String> -AdministratorLoginPassword <SecureString> - [-AuthenticationType <AuthenticationType>] [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmSqlDatabaseImport** cmdlet imports a bacpac file from an Azure storage account to a new Azure SQL Database. -The get import database status request may be sent to retrieve status information for this request. - -## EXAMPLES - -### Example 1: Create an import request for a bacpac file -``` -PS C:\>New-AzureRmSqlDatabaseImport -ResourceGroupName "RG01" -ServerName "Server01" -DatabaseName "Database01" -StorageKeyType "StorageAccessKey" -StorageKey "StorageKey01" -StorageUri "http://account01.blob.core.contoso.net/bacpacs/database01.bacpac" -AdministratorLogin "User" -AdministratorLoginPassword $SecureString -Edition Standard -ServiceObjectiveName S0 -DatabaseMaxSizeBytes 5000000 -ResourceGroupName : RG01 -ServerName : Server01 -DatabaseName : Database01 -StorageKeyType : StorageAccessKey -StorageKey : -StorageUri : http://account01.blob.core.contoso.net/bacpacs/database01.bacpac -AdministratorLogin : User -AdministratorLoginPassword : -AuthenticationType : None -OperationStatusLink : https://management.contoso.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resource01/providers/Microsoft.Sql/servers/server01/databases/database01/importExportOperationResults/00000000-00 - 0-0000-0000-000000000000?api-version=2014-04-01 -Status : InProgress -ErrorMessage : -``` - -This command creates an import request to import a .bacpac to a new database. - -## PARAMETERS - -### -AdministratorLogin -Specifies the name of the SQL administrator. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AdministratorLoginPassword -Specifies the password of the SQL administrator. - -```yaml -Type: System.Security.SecureString -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthenticationType -Specifies the type of authentication used to access the server. -This parameter defaults to SQL if no authentication type is set. -The acceptable values for this parameter are: -- SQL. -SQL authentication. -Set the *AdministratorLogin* and *AdministratorLoginPassword* parameters to the SQL administrator username and password. -- ADPassword. -Microsoft Entra authentication. -Set *AdministratorLogin* and *AdministratorLoginPassword* to the Microsoft Entra administrator username and password. -This parameter is only available on SQL Database V12 servers. - -```yaml -Type: Microsoft.Azure.Commands.Sql.ImportExport.Model.AuthenticationType -Parameter Sets: (All) -Aliases: -Accepted values: None, Sql, AdPassword - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseMaxSizeBytes -Specifies the maximum size for the newly imported database. - -```yaml -Type: System.Int64 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the SQL Database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Edition -Specifies the edition of the new database to import to. -The acceptable values for this parameter are: -- Premium -- Basic -- Standard -- DataWarehouse -- Free - -```yaml -Type: Microsoft.Azure.Commands.Sql.Database.Model.DatabaseEdition -Parameter Sets: (All) -Aliases: -Accepted values: None, Premium, Basic, Standard, DataWarehouse, Stretch, Free, PremiumRS, GeneralPurpose, BusinessCritical - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for the SQL Database server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the SQL Database server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceObjectiveName -Specifies the name of the service objective to assign to the Azure SQL Database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageKey -Specifies the access key for the storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageKeyType -Specifies the type of access key for the storage account. -The acceptable values for this parameter are: -- StorageAccessKey. -Uses the storage account key. -- SharedAccessKey. -Uses the Shared Access Signature (SAS) key. - -```yaml -Type: Microsoft.Azure.Commands.Sql.ImportExport.Model.StorageKeyType -Parameter Sets: (All) -Aliases: -Accepted values: StorageAccessKey, SharedAccessKey - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageUri -Specifies the blob URI of the .bacpac file. - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ImportExport.Model.AzureSqlDatabaseImportExportBaseModel - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - -## RELATED LINKS - -[Get-AzureRmSqlDatabaseImportExportStatus](./Get-AzureRmSqlDatabaseImportExportStatus.md) - -[New-AzureRmSqlDatabaseExport](./New-AzureRmSqlDatabaseExport.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlDatabaseRestorePoint.md b/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlDatabaseRestorePoint.md deleted file mode 100644 index 81f171ec60..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlDatabaseRestorePoint.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 67A9BB67-CF17-4CAA-99D9-002D0D23178B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/new-azurermsqldatabaserestorepoint -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseRestorePoint.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseRestorePoint.md ---- - -# New-AzureRmSqlDatabaseRestorePoint - -## SYNOPSIS -Creates a new restore point from which a SQL Database can be restored. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmSqlDatabaseRestorePoint -RestorePointLabel <String> [-ServerName] <String> [-DatabaseName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmSqlDatabaseRestorePoint** cmdlet creates a new restore point that an Azure SQL Data Warehouse can be restored from. -This cmdlet is currently supported for Azure SQL Data Warehouse. - -## EXAMPLES - -### Example 1: Create a restore point -``` -PS C:\>New-AzureRmSqlDatabaseRestorePoint -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -RestorePointLabel "RestorePoint01" -ResourceGroupName : resourcegroup01 -ServerName : server01 -DatabaseName : database01 -Location : Central US -RestorePointType : DISCRETE -RestorePointCreationDate : 8/12/2015 12:00:00 AM -EarliestRestoreDate : -RestorePointLabel : RestorePoint01 -``` - -This command creates a restore point for Azure SQL Data Warehouse and returns the details of the restore point. - -## PARAMETERS - -### -DatabaseName -Specifies the name of the SQL Database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the SQL Database is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RestorePointLabel -Specifies the label of the restore point for easy identification. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the AzureSQL Server that hosts the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlDatabaseRestorePointModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlDatabaseSecondary.md b/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlDatabaseSecondary.md deleted file mode 100644 index 006985b948..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlDatabaseSecondary.md +++ /dev/null @@ -1,318 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: BEE99039-35F7-4E9D-9308-090EAE68292D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/new-azurermsqldatabasesecondary -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseSecondary.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseSecondary.md ---- - -# New-AzureRmSqlDatabaseSecondary - -## SYNOPSIS -Creates a secondary database for an existing database and starts data replication. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DtuBasedDatabase (Default) -``` -New-AzureRmSqlDatabaseSecondary [-DatabaseName] <String> [-SecondaryServiceObjectiveName <String>] - [-SecondaryElasticPoolName <String>] [-Tags <Hashtable>] -PartnerResourceGroupName <String> - -PartnerServerName <String> [-AllowConnections <AllowConnections>] [-AsJob] [-LicenseType <String>] - [-ServerName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### VcoreBasedDatabase -``` -New-AzureRmSqlDatabaseSecondary [-DatabaseName] <String> [-Tags <Hashtable>] -PartnerResourceGroupName <String> - -PartnerServerName <String> [-AllowConnections <AllowConnections>] [-AsJob] - -SecondaryComputeGeneration <String> -SecondaryVCore <Int32> [-LicenseType <String>] [-ServerName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRMSqlDatabaseSecondary** cmdlet replaces the Start-AzureSqlDatabaseCopy cmdlet when -used for setting up geo-replication for a database. It returns the geo-replication link object from -the primary to the secondary database. - -## EXAMPLES - -### 1: Establish Active Geo-Replication -``` -$database = Get-AzureRmSqlDatabase -DatabaseName $databasename -ResourceGroupName $primaryresourcegroupname -ServerName $primaryservername -$database | New-AzureRmSqlDatabaseSecondary -PartnerResourceGroupName $secondaryresourcegroupname -PartnerServerName $secondaryservername -AllowConnections "All" -``` - -## PARAMETERS - -### -AllowConnections -Specifies the read intent of the secondary Azure SQL Database. -The acceptable values for this parameter are: -- No -- All - -```yaml -Type: Microsoft.Azure.Commands.Sql.Replication.Model.AllowConnections -Parameter Sets: (All) -Aliases: -Accepted values: No, All - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the database to act as primary. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LicenseType -The license type for the Azure Sql database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PartnerResourceGroupName -Specifies the name of the Azure Resource Group to which this cmdlet assigns the secondary database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PartnerServerName -Specifies the name of the Azure SQL database server to act as secondary. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the Azure Resource Group to which this cmdlet assigns the primary database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecondaryComputeGeneration -The compute generation of teh Azure Sql Database secondary. - -```yaml -Type: System.String -Parameter Sets: VcoreBasedDatabase -Aliases: Family - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecondaryElasticPoolName -Specifies the name of the elastic pool in which to put the secondary database. - -```yaml -Type: System.String -Parameter Sets: DtuBasedDatabase -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecondaryServiceObjectiveName -Specifies the name of the service objective to assign to the secondary database. - -```yaml -Type: System.String -Parameter Sets: DtuBasedDatabase -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecondaryVCore -The Vcore numbers of the Azure Sql Database secondary. - -```yaml -Type: System.Int32 -Parameter Sets: VcoreBasedDatabase -Aliases: Capacity - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the SQL Server of the primary SQL Database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tags -Specifies the Key-value pairs in the form of a hash table to associate with the SQL Database replication link. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tag - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Replication.Model.AzureReplicationLinkModel - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmSqlDatabaseSecondary](./Remove-AzureRmSqlDatabaseSecondary.md) - -[Set-AzureRmSqlDatabaseSecondary](./Set-AzureRmSqlDatabaseSecondary.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlElasticPool.md b/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlElasticPool.md deleted file mode 100644 index 196909881a..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlElasticPool.md +++ /dev/null @@ -1,418 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 009899E5-83BF-4A3F-877E-70C16D5CD1AC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/new-azurermsqlelasticpool -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlElasticPool.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlElasticPool.md ---- - -# New-AzureRmSqlElasticPool - -## SYNOPSIS -Creates an elastic database pool for a SQL Database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DtuBasedPool (Default) -``` -New-AzureRmSqlElasticPool [-ElasticPoolName] <String> [-Edition <String>] [-Dtu <Int32>] [-StorageMB <Int32>] - [-DatabaseDtuMin <Int32>] [-DatabaseDtuMax <Int32>] [-Tags <Hashtable>] [-ZoneRedundant] - [-LicenseType <String>] [-AsJob] [-ServerName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### VcoreBasedPool -``` -New-AzureRmSqlElasticPool [-ElasticPoolName] <String> -Edition <String> [-StorageMB <Int32>] -VCore <Int32> - -ComputeGeneration <String> [-DatabaseVCoreMin <Double>] [-DatabaseVCoreMax <Double>] [-Tags <Hashtable>] - [-ZoneRedundant] [-LicenseType <String>] [-AsJob] [-ServerName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmSqlElasticPool** cmdlet creates an elastic database pool for an Azure SQL Database. -Several parameters (*-Dtu, -DatabaseDtuMin, and -DatabaseDtuMax*) require the value being set is from the list of valid values for that parameter. For example, -DatabaseDtuMax for a Standard 100 eDTU pool can only be set to 10, 20, 50, or 100. For details about which values are valid, see the table for your specific size pool in [elastic pools](https://docs.microsoft.com/azure/sql-database/sql-database-elastic-pool). - -## EXAMPLES - -### Example 1: Create an elastic pool -``` -PS C:\>New-AzureRmSqlElasticPool -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ElasticPoolName "ElasticPool01" -Edition "Standard" -Dtu 400 -DatabaseDtuMin 10 -DatabaseDtuMax 100 -ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 -ResourceGroupName : resourcegroup01 -ServerName : server01 -ElasticPoolName : elasticpool01 -Location : Central US -CreationDate : 8/26/2015 10:00:17 PM -State : Ready -Edition : Standard -Dtu : 400 -DatabaseDtuMax : 100 -DatabaseDtuMin : 10 -StorageMB : 409600 -Tags : -``` - -This command creates an elastic pool in the Standard service tier named ElasticPool01. The server -named server01, assigned to an Azure resource group named ResourceGroup01, hosts the elastic pool -in. The command specifies DTU property values for the pool and the databases in the pool. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputeGeneration -The compute generation to assign. - -```yaml -Type: System.String -Parameter Sets: VcoreBasedPool -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseDtuMax -Specifies the maximum number of Database Throughput Units (DTUs) that any single database in the pool can consume. -The default values for the different editions are as follows: -- Basic. 5 DTUs -- Standard. 100 DTUs -- Premium. 125 DTUs -For details about which values are valid, see the table for your specific size pool in [elastic pools](https://docs.microsoft.com/azure/sql-database/sql-database-elastic-pool) - -```yaml -Type: System.Int32 -Parameter Sets: DtuBasedPool -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseDtuMin -Specifies the minimum number of DTUs that the elastic pool guarantees to all the databases in the pool. -The default value is zero (0). -For details about which values are valid, see the table for your specific size pool in [elastic pools](https://docs.microsoft.com/azure/sql-database/sql-database-elastic-pool). - -```yaml -Type: System.Int32 -Parameter Sets: DtuBasedPool -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseVCoreMax -The maxmium VCore number any SqlAzure Database can consume in the pool. - -```yaml -Type: System.Double -Parameter Sets: VcoreBasedPool -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseVCoreMin -The minimum VCore number any SqlAzure Database can consume in the pool. - -```yaml -Type: System.Double -Parameter Sets: VcoreBasedPool -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Dtu -Specifies the total number of shared DTUs for the elastic pool. -The default values for the different editions are as follows: -- Basic. -100 DTUs -- Standard. -100 DTUs -- Premium. -125 DTUs -For details about which values are valid, see the table for your specific size pool in [elastic pools](https://docs.microsoft.com/azure/sql-database/sql-database-elastic-pool). - -```yaml -Type: System.Int32 -Parameter Sets: DtuBasedPool -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Edition -Specifies the edition of the Azure SQL Database used for the elastic pool. -The acceptable values for this parameter are: -- None -- Basic -- Standard -- Premium -- DataWarehouse -- Free -- Stretch -- GeneralPurpose -- BusinessCritical - -```yaml -Type: System.String -Parameter Sets: DtuBasedPool -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: VcoreBasedPool -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ElasticPoolName -Specifies the name of the elastic pool that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LicenseType -The license type for the Azure Sql database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which this cmdlet assigns the elastic pool. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server that hosts the elastic pool. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageMB -Specifies the storage limit, in megabytes, for the elastic pool. If you do not specify this -parameter, this cmdlet calculates a value that depends on the value of the *Dtu* parameter. -See [eDTU and storage limits](/azure/sql-database/sql-database-elastic-pool#edtu-and-storage-limits-for-elastic-pools) for possible values. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tags -Specifies a dictionary of Key-value pairs in the form of a hash table that this cmdlet associates -with the elastic pool. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tag - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VCore -The total shared number of Vcores for the Sql Azure Elastic Pool. - -```yaml -Type: System.Int32 -Parameter Sets: VcoreBasedPool -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZoneRedundant -The zone redundancy to associate with the Azure Sql Elastic Pool - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlElasticPool](./Get-AzureRmSqlElasticPool.md) - -[Get-AzureRmSqlElasticPoolActivity](./Get-AzureRmSqlElasticPoolActivity.md) - -[Get-AzureRmSqlElasticPoolDatabase](./Get-AzureRmSqlElasticPoolDatabase.md) - -[Remove-AzureRmSqlElasticPool](./Remove-AzureRmSqlElasticPool.md) - -[Set-AzureRmSqlElasticPool](./Set-AzureRmSqlElasticPool.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlInstance.md b/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlInstance.md deleted file mode 100644 index 4c928d5619..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlInstance.md +++ /dev/null @@ -1,354 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/new-azurermsqlinstance -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlInstance.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlInstance.md ---- - -# New-AzureRmSqlInstance - -## SYNOPSIS -Creates an Azure SQL Database Managed Instance. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NewByEditionAndComputeGenerationParameterSet (Default) -``` -New-AzureRmSqlInstance [-Name] <String> [-ResourceGroupName] <String> -AdministratorCredential <PSCredential> - -Location <String> -SubnetId <String> -LicenseType <String> -StorageSizeInGB <Int32> -VCore <Int32> - -Edition <String> -ComputeGeneration <String> [-Tag <Hashtable>] [-AssignIdentity] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### NewBySkuNameParameterSetParameter -``` -New-AzureRmSqlInstance [-Name] <String> [-ResourceGroupName] <String> -AdministratorCredential <PSCredential> - -Location <String> -SubnetId <String> -LicenseType <String> -StorageSizeInGB <Int32> -VCore <Int32> - -SkuName <String> [-Tag <Hashtable>] [-AssignIdentity] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmSqlInstance** cmdlet creates an Azure SQL Database Managed instance. - -## EXAMPLES - -### Example 1: Create a new instance -``` -PS C:\>New-AzureRmSqlInstance -Name managedInstance1 -ResourceGroupName ResourceGroup01 -Location westcentralus -AdministratorCredential (Get-Credential) -SubnetId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name" -LicenseType LicenseIncluded -StorageSizeInGB 1024 -VCore 16 -SkuName GP_Gen4 -Location : westcentralus -Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1 -ResourceGroupName : resourcegroup01 -ManagedInstanceName : managedInstance1 -Tags : -Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity -Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku -FullyQualifiedDomainName : managedInstance1.wcusxxxxxxxxxxxxx.database.windows.net -AdministratorLogin : adminLogin1 -AdministratorPassword : -SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name -LicenseType : LicenseIncluded -VCores : 16 -StorageSizeInGB : 1024 -``` - -This command creates a new instance by using Edition and ComputeGeneration parameters. - -### Example 2: Create a new instance -``` -PS C:\>New-AzureRmSqlInstance -Name managedInstance2 -ResourceGroupName ResourceGroup01 -Location westcentralus -AdministratorCredential (Get-Credential) -SubnetId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name" -LicenseType LicenseIncluded -StorageSizeInGB 1024 -VCore 16 -Edition "GeneralPurpose" -ComputeGeneration Gen4 -Location : westcentralus -Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1 -ResourceGroupName : resourcegroup01 -ManagedInstanceName : managedInstance2 -Tags : -Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity -Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku -FullyQualifiedDomainName : managedInstance1.wcusxxxxxxxxxxxxx.database.windows.net -AdministratorLogin : adminLogin1 -AdministratorPassword : -SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name -LicenseType : LicenseIncluded -VCores : 16 -StorageSizeInGB : 1024 -``` - -This command creates a new instance by using by using Edition and ComputeGeneration parameters. - -## PARAMETERS - -### -AdministratorCredential -The SQL authentication credential of the instance. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignIdentity -Generate and assign a Microsoft Entra identity for this Managed instance for use with key management services like Azure KeyVault. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputeGeneration -The compute generation for the instance. - -```yaml -Type: String -Parameter Sets: NewByEditionAndComputeGenerationParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Edition -The edition for the instance. - -```yaml -Type: String -Parameter Sets: NewByEditionAndComputeGenerationParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LicenseType -Determines which License Type of instance to use - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The location in which to create the instance - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Instance name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: InstanceName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkuName -The SKU name for the instance e.g. -'GP_Gen4', 'BC_Gen4'. - -```yaml -Type: String -Parameter Sets: NewBySkuNameParameterSetParameter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageSizeInGB -Determines how much Storage size to associate with instance - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetId -The Subnet Id to use for instance creation - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -The tags to associate with the instance - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VCore -Determines how much VCore to associate with instance - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlInstanceDatabase.md b/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlInstanceDatabase.md deleted file mode 100644 index e0b2201a20..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlInstanceDatabase.md +++ /dev/null @@ -1,252 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/new-azurermsqlinstancedatabase -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlInstanceDatabase.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlInstanceDatabase.md ---- - -# New-AzureRmSqlInstanceDatabase - -## SYNOPSIS -Creates an Azure SQL Managed Instance database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### CreateNewInstanceDatabaseFromInputParameters (Default) -``` -New-AzureRmSqlInstanceDatabase [-Name] <String> [-InstanceName] <String> [-ResourceGroupName] <String> - [-Collation <String>] [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### CreateNewInstanceDatabaseFromAzureSqlManagedInstanceModelInstanceDefinition -``` -New-AzureRmSqlInstanceDatabase [-Name] <String> [-Collation <String>] [-Tag <Hashtable>] - [-InstanceObject] <AzureSqlManagedInstanceModel> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### CreateNewInstanceDatabaseFromAzureSqlInstanceResourceId -``` -New-AzureRmSqlInstanceDatabase [-Name] <String> [-Collation <String>] [-Tag <Hashtable>] - [-InstanceResourceId] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmSqlInstanceDatabase** cmdlet creates an Azure SQL Managed instance database. - -## EXAMPLES - -### Example 1: Create a database on a specified instance -``` -PS C:\>New-AzureRmSqlInstanceDatabase -Name "Database01" -InstanceName "managedInstance1" -ResourceGroupName "ResourceGroup01" -ResourceGroupName : resourcegroup01 -ManagedInstanceName : managedInstance1 -Location : westcentralus -Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1/databases/Database01 -Name : Database01 -Tags : -Collation : SQL_Latin1_General_CP1_CI_AS -Status : Online -CreationDate : 4/27/2018 2:30:07 PM -EarliestRestorePoint : 4/27/2018 2:40:47 PM -RestorePointInTime : -DefaultSecondaryLocation : West US 2 -CatalogCollation : -CreateMode : -StorageContainerUri : -StorageContainerSasToken : -SourceDatabaseId : -FailoverGroupId : -``` - -This command creates a instance database named Database01 on instance managedInstance1. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Collation -The collation of the Azure SQL Instance Database collation to use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceName -The instance name. - -```yaml -Type: String -Parameter Sets: CreateNewInstanceDatabaseFromInputParameters -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceObject -The instance object - -```yaml -Type: AzureSqlManagedInstanceModel -Parameter Sets: CreateNewInstanceDatabaseFromAzureSqlManagedInstanceModelInstanceDefinition -Aliases: ParentObject - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InstanceResourceId -The instance resource id - -```yaml -Type: String -Parameter Sets: CreateNewInstanceDatabaseFromAzureSqlInstanceResourceId -Aliases: ParentResourceId - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The name of the Azure SQL Instance Database to create. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: InstanceDatabaseName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: String -Parameter Sets: CreateNewInstanceDatabaseFromInputParameters -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -The tags to associate with the Azure Sql Instance Database - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel -System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlServer.md b/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlServer.md deleted file mode 100644 index 019884aec0..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlServer.md +++ /dev/null @@ -1,240 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 7039528F-42AE-45DB-BF81-FE5003F8AEE2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/new-azurermsqlserver -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServer.md ---- - -# New-AzureRmSqlServer - -## SYNOPSIS -Creates a SQL Database server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmSqlServer -ServerName <String> -SqlAdministratorCredentials <PSCredential> -Location <String> - [-Tags <Hashtable>] [-ServerVersion <String>] [-AssignIdentity] [-AsJob] [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmSqlServer** cmdlet creates an Azure SQL Database server. - -## EXAMPLES - -### Example 1: Create a new Azure SQL Database server -``` -PS C:\>New-AzureRmSqlServer -ResourceGroupName "ResourceGroup01" -Location "Central US" -ServerName "server01" -ServerVersion "12.0" -SqlAdministratorCredentials (Get-Credential) -ResourceGroupName : resourcegroup01 -ServerName : server01 -Location : Central US -SqlAdministratorLogin : adminLogin -SqlAdministratorPassword : -ServerVersion : 12.0 -Tags : -``` - -This command creates a version 12 Azure SQL Database server. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignIdentity -Generate and assign a Microsoft Entra identity for this server for use with key management services like Azure KeyVault. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the data center where this cmdlet creates the server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which this cmdlet assigns the server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the new server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerVersion -Specifies the version of the new server. The acceptable values for this parameter are: 2.0 and 12.0. -Specify 2.0 to create a version 11 server, or 12.0 to create a version 12 server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SqlAdministratorCredentials -Specifies the SQL Database server administrator credentials for the new server. To obtain a -**PSCredential** object, use the Get-Credential cmdlet. For more information, type `Get-Help -Get-Credential`. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tags -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tag - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlServer](./Get-AzureRmSqlServer.md) - -[Remove-AzureRmSqlServer](./Remove-AzureRmSqlServer.md) - -[Set-AzureRmSqlServer](./Set-AzureRmSqlServer.md) - -[New-AzureRmSqlServerFirewallRule](./New-AzureRmSqlServerFirewallRule.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlServerCommunicationLink.md b/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlServerCommunicationLink.md deleted file mode 100644 index 8853b855da..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlServerCommunicationLink.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 52664E45-7EAB-41C9-BF78-304F10BFC51A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/new-azurermsqlservercommunicationlink -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServerCommunicationLink.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServerCommunicationLink.md ---- - -# New-AzureRmSqlServerCommunicationLink - -## SYNOPSIS -Creates a communication link for elastic database transactions between two SQL Database servers. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmSqlServerCommunicationLink -LinkName <String> -PartnerServer <String> [-AsJob] - [-ServerName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmSqlServerCommunicationLink** cmdlet creates a communication link for elastic database transactions between two logical servers in Azure SQL Database. -Elastic database transactions can span databases in either of the paired servers. -You can create more than one link on a server. -Therefore, elastic database transactions can span across a larger number of servers. - -## EXAMPLES - -### Example 1: Create a communication link -``` -PS C:\>New-AzureRmSqlServerCommunicationLink -ResourceGroupName "ResourceGroup01" -ServerName "ContosoServer17" -LinkName "Link01" -PartnerServer "ContosoServer02" -``` - -This command creates a link named Link01 between ContosoServer17 and ContosoServer02. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LinkName -Specifies the name of the server communication link that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PartnerServer -Specifies the name of the other server that takes part in this communication link. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the server specified by the *ServerName* parameter belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server on which this cmdlet sets up the communication link. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ServerCommunicationLink.Model.AzureSqlServerCommunicationLinkModel - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - -## RELATED LINKS - -[Get-AzureRmSqlServerCommunicationLink](./Get-AzureRmSqlServerCommunicationLink.md) - -[Remove-AzureRmSqlServerCommunicationLink](./Remove-AzureRmSqlServerCommunicationLink.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlServerDisasterRecoveryConfiguration.md b/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlServerDisasterRecoveryConfiguration.md deleted file mode 100644 index c75248eb2e..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlServerDisasterRecoveryConfiguration.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 1D8E8599-113C-4852-8416-1F3359071047 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/new-azurermsqlserverdisasterrecoveryconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServerDisasterRecoveryConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServerDisasterRecoveryConfiguration.md ---- - -# New-AzureRmSqlServerDisasterRecoveryConfiguration - -## SYNOPSIS -Creates a database server system recovery configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmSqlServerDisasterRecoveryConfiguration -VirtualEndpointName <String> - -PartnerResourceGroupName <String> -PartnerServerName <String> [-FailoverPolicy <String>] [-AsJob] - [-ServerName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmSqlServerDisasterRecoveryConfiguration** cmdlet creates a SQL database server system recovery configuration. - -## EXAMPLES - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FailoverPolicy -Specifies the failover policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PartnerResourceGroupName -Specifies the name of the partner resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PartnerServerName -Specifies the name of the partner server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualEndpointName -Specifies the name of the virtual end point. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ServerDisasterRecoveryConfiguration.Model.AzureSqlServerDisasterRecoveryConfigurationModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlServerDisasterRecoveryConfiguration](./Get-AzureRmSqlServerDisasterRecoveryConfiguration.md) - -[Remove-AzureRmSqlServerDisasterRecoveryConfiguration](./Remove-AzureRmSqlServerDisasterRecoveryConfiguration.md) - -[Set-AzureRmSqlServerDisasterRecoveryConfiguration](./Set-AzureRmSqlServerDisasterRecoveryConfiguration.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlServerDnsAlias.md b/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlServerDnsAlias.md deleted file mode 100644 index 3f7e116d99..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlServerDnsAlias.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/new-azurermsqlserverdnsalias -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServerDnsAlias.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServerDnsAlias.md ---- - -# New-AzureRmSqlServerDnsAlias - -## SYNOPSIS -This command creates a new Azure SQL Server DNS Alias. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmSqlServerDnsAlias -Name <String> [-AsJob] -ServerName <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Creates new Azure SQL Server DNS Alias that is pointing to specified server. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $serverDNSAlias = New-AzureRmSqlServerDnsAlias -ResourceGroupName rg -ServerName serverName -DnsAliasName aliasName - -ResourceGroupName ServerName DnsAliasName ------------------ ---------- ------------------ -rgname servername dnsaliasname -``` - -This command creates Azure SQL Server DNS Alias with the name aliasName that is pointing to server serverName - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Azure Sql Server Dns Alias name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: DnsAliasName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The Azure Sql Server name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ServerDnsAlias.Model.AzureSqlServerDnsAliasModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlServerFirewallRule.md b/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlServerFirewallRule.md deleted file mode 100644 index ba76566d8c..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlServerFirewallRule.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 51AF8EFB-F0C1-41E0-BBC5-E48FB1B8672C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/new-azurermsqlserverfirewallrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServerFirewallRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServerFirewallRule.md ---- - -# New-AzureRmSqlServerFirewallRule - -## SYNOPSIS -Creates a firewall rule for a SQL Database server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### UserSpecifiedRuleSet -``` -New-AzureRmSqlServerFirewallRule -FirewallRuleName <String> -StartIpAddress <String> -EndIpAddress <String> - [-ServerName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### AzureIpRuleSet -``` -New-AzureRmSqlServerFirewallRule [-AllowAllAzureIPs] [-ServerName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmSqlServerFirewallRule** cmdlet creates a firewall rule for the specified Azure SQL Database server. - -## EXAMPLES - -### Example 1: Create a firewall rule -``` -PS C:\>New-AzureRmSqlServerFirewallRule -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -FirewallRuleName "Rule01" -StartIpAddress "192.168.0.198" -EndIpAddress "192.168.0.199" -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -StartIpAddress : 192.168.0.198 -EndIpAddress : 192.168.0.199 -FirewallRuleName : Rule01 -``` - -This command creates a firewall rule named Rule01 on the server named Server01. -The rule includes the specified start and end IP addresses. - -### Example 2: Create a firewall rule that allows all Azure IP addresses to access the server -``` -PS C:\>New-AzureRmSqlServerFirewallRule -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -AllowAllAzureIPs -``` - -This command creates a firewall rule on the server named Server01 that belongs to the resource group named ResourceGroup01. -Since the *AllowAllAzureIPs* parameter is used, the firewall rule allows all Azure IP addresses to access the server. - -## PARAMETERS - -### -AllowAllAzureIPs -Indicates that this firewall rule allows all Azure IP addresses to access the server. -You cannot use this parameter if you intend to use the *FirewallRuleName*, *StartIpAddress*, and *EndIpAddress* parameters. -If you want to allow Azure IPs to access the server, this parameter should be used in a separate cmdlet call that does not use the *FirewallRuleName*, *StartIpAddress*, and *EndIpAddress* parameters. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: AzureIpRuleSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndIpAddress -Specifies the end value of the IP address range for this rule. - -```yaml -Type: System.String -Parameter Sets: UserSpecifiedRuleSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FirewallRuleName -Specifies the name of the new firewall rule. - -```yaml -Type: System.String -Parameter Sets: UserSpecifiedRuleSet -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group to which the server is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of a server. -Specify the server name, not the fully qualified DNS name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartIpAddress -Specifies the start value of the IP address range for the firewall rule. - -```yaml -Type: System.String -Parameter Sets: UserSpecifiedRuleSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.FirewallRule.Model.AzureSqlServerFirewallRuleModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlServerFirewallRule](./Get-AzureRmSqlServerFirewallRule.md) - -[Remove-AzureRmSqlServerFirewallRule](./Remove-AzureRmSqlServerFirewallRule.md) - -[Set-AzureRmSqlServerFirewallRule](./Set-AzureRmSqlServerFirewallRule.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlServerVirtualNetworkRule.md b/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlServerVirtualNetworkRule.md deleted file mode 100644 index 5452a6acae..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlServerVirtualNetworkRule.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/new-azurermsqlservervirtualnetworkrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServerVirtualNetworkRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServerVirtualNetworkRule.md ---- - -# New-AzureRmSqlServerVirtualNetworkRule - -## SYNOPSIS -Creates an Azure SQL Server Virtual Network Rule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmSqlServerVirtualNetworkRule -VirtualNetworkRuleName <String> -VirtualNetworkSubnetId <String> - [-IgnoreMissingVnetServiceEndpoint] [-AsJob] -ServerName <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Creates an Azure SQL Server Virtual Network Rule. Virtual Network Rules are used to connect the Azure SQL Server to a specific Virtual Network in order to restrict the access on the Azure SQL Server to only be available within the Virtual Network. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $virtualNetworkRule = New-AzureRmSqlServerVirtualNetworkRule -ResourceGroupName rg -ServerName serverName -VirtualNetworkRuleName virtualNetworkRuleName -VirtualNetworkSubnetId virtualNetworkSubnetId -``` - -Creates an Azure SQL Server virtual network rule - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreMissingVnetServiceEndpoint -Create firewall rule before the virtual network has vnet service endpoint enabled. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The Azure Sql Server name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkRuleName -Azure Sql Server Virtual Network Rule Name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkSubnetId -The Virtual Network Subnet Id that specifies the Microsoft.Network details - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.VirtualNetworkRule.Model.AzureSqlServerVirtualNetworkRuleModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlSyncAgent.md b/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlSyncAgent.md deleted file mode 100644 index d8280eb576..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlSyncAgent.md +++ /dev/null @@ -1,228 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/new-azurermsqlsyncagent -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlSyncAgent.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlSyncAgent.md ---- - -# New-AzureRmSqlSyncAgent - -## SYNOPSIS -Creates an Azure SQL Sync Agent. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SyncDatabaseComponent (Default) -``` -New-AzureRmSqlSyncAgent [-Name] <String> -SyncDatabaseName <String> [-SyncDatabaseServerName <String>] - [-SyncDatabaseResourceGroupName <String>] [-ServerName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SyncDatabaseResourceID -``` -New-AzureRmSqlSyncAgent [-Name] <String> -SyncDatabaseResourceID <String> [-ServerName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmSqlSyncAgent** cmdlet creates an Azure SQL Sync Agent. - -## EXAMPLES - -### Example 1: Create a sync agent for an Azure SQL server. -``` -PS C:\> New-AzureRmSqlSyncAgent -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -Name "SyncAgent01" -SyncDatabaseServerName "syncDatabaseServer01" --SyncDatabaseName "syncDatabaseName01" -SyncDatabaseResourceGroupName "syncDatabaseResourceGroup01" | Format-List -ResourceId : subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/syncAgents/{SyncAgent01} -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -SyncAgentName : SyncAgent01 -SyncDatabaseId : subscriptions/{subscriptionId}/resourceGroups/{syncDatabaseResourceGroup01}/servers/{syncDatabaseServer01}/databases/{syncDatabaseName01} -LastAliveTime: : -Version : 4.2.0.0 -IsUpToDate : True -ExpiryTime : 12/31/9999 11:59:59 PM -State : NeverConnected -``` - -This command creates a sync agent for an Azure SQL server. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The sync agent name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: SyncAgentName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The name of the Azure SQL Server the sync agent is in. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SyncDatabaseName -The database used to store sync related metadata. - -```yaml -Type: System.String -Parameter Sets: SyncDatabaseComponent -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SyncDatabaseResourceGroupName -The resource group the sync metadata database belongs to. - -```yaml -Type: System.String -Parameter Sets: SyncDatabaseComponent -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SyncDatabaseResourceID -The resource ID of the sync metadata database. - -```yaml -Type: System.String -Parameter Sets: SyncDatabaseResourceID -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SyncDatabaseServerName -The server on which the sync metadata database is hosted. - -```yaml -Type: System.String -Parameter Sets: SyncDatabaseComponent -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncAgentModel - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmSqlSyncAgent](./Remove-AzureRmSqlSyncAgent.md) - -[Get-AzureRmSqlSyncAgent](./Get-AzureRmSqlSyncAgent.md) - diff --git a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlSyncAgentKey.md b/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlSyncAgentKey.md deleted file mode 100644 index 022ce963f1..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlSyncAgentKey.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/new-azurermsqlsyncagentkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlSyncAgentKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlSyncAgentKey.md ---- - -# New-AzureRmSqlSyncAgentKey - -## SYNOPSIS -Creates an Azure SQL Sync Agent Key. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmSqlSyncAgentKey [-ServerName] <String> [-SyncAgentName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmSqlSyncAgentKey** cmdlet creates an Azure SQL Sync Agent key. - -## EXAMPLES - -### Example 1: Create a sync agent key for an Azure SQL sync agent. -``` -PS C:\> New-AzureRmSqlSyncAgentKey -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -SyncAgentName "SyncAgent01" -SyncAgentKey : Key -``` - -This command creates a sync agent key for an Azure SQL Sync Agent. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The name of the Azure SQL Server the sync agent is in. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SyncAgentName -The sync agent name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncAgentKeyModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlSyncGroup.md b/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlSyncGroup.md deleted file mode 100644 index c642d4245a..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlSyncGroup.md +++ /dev/null @@ -1,293 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/new-azurermsqlsyncgroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlSyncGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlSyncGroup.md ---- - -# New-AzureRmSqlSyncGroup - -## SYNOPSIS -Creates an Azure SQL Database Sync Group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmSqlSyncGroup [-Name] <String> -SyncDatabaseName <String> -SyncDatabaseServerName <String> - -SyncDatabaseResourceGroupName <String> [-IntervalInSeconds <Int32>] [-DatabaseCredential <PSCredential>] - [-ConflictResolutionPolicy <String>] [-SchemaFile <String>] [-ServerName] <String> [-DatabaseName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmSqlSyncGroup** cmdlet creates an Azure SQL Database Sync Group. - -## EXAMPLES - -### Example 1: Create a sync group for an Azure SQL Database. -``` -PS C:\> $credential = Get-Credential -PS C:\> New-AzureRmSqlSyncGroup -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -Name "SyncGroup01" -ConflictResolutionPolicy "HubWin" --DatabaseCredential $credential -IntervalInSeconds 100 -SyncDatabaseServerName "syncDatabaseServer01" -SyncDatabaseName "syncDatabaseName01" --SyncDatabaseResourceGroupName "syncDatabaseResourceGroup01" -Schema ".\schema.json" | Format-List -ResourceId : /subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup01} -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -SyncGroupName : SyncGroup01 -SyncDatabaseId : subscriptions/{subscriptionId}/resourceGroups/{syncDatabaseResourceGroup01}/servers/{syncDatabaseServer01}/databases/{syncDatabaseName01} -IntervalInSeconds : 100 -ConflictResolutionPolicy: : HubWin -HubDatabaseUserName : myAccount -HubDatabasePassword : -SyncState : NotReady -LastSyncTime : 1/1/0001 12:00:00 AM -Schema : -``` - -This command creates a sync group for an Azure SQL Database. "schema.json" is a file in the local disk. It contains the shema payload in json format. An example of the schema json is: -{"Tables": [{"Columns": [{"QuotedName": "b3ee3a7f-7614-4644-ad07-afa832620b4bManualTestsm4column1"}, {"QuotedName": "b3ee3a7f-7614-4644-ad07-afa832620b4bManualTestsm4column2"}], "QuotedName": "MayQuotedTable1"}, -{"Columns": [{"QuotedName": "b3ee3a7f-7614-4644-ad07-afa832620b4bManualTestsm4column1"}, {"QuotedName": "b3ee3a7f-7614-4644-ad07-afa832620b4bManualTestsm4column2"}], "QuotedName": "MayQuotedTable2"}], -"MasterSyncMemberName": null -} - -## PARAMETERS - -### -ConflictResolutionPolicy -The policy of resolving confliction between hub and member database in the sync group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: HubWin, MemberWin - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseCredential -The SQL authentication credential of the hub database. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -The name of the Azure SQL Database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IntervalInSeconds -The frequency (in seconds) of doing data synchronization. -Default is -1, which means the auto synchronization is not enabled. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The sync group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: SyncGroupName - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SchemaFile -The path of the schema file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerName -The name of the Azure SQL Server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SyncDatabaseName -The database used to store sync related metadata. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SyncDatabaseResourceGroupName -The resource group the sync metadata database belongs to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SyncDatabaseServerName -The server on which the sync metadata database is hosted. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncGroupModel - -## NOTES - -## RELATED LINKS - - -[Remove-AzureRmSqlSyncGroup](./Remove-AzureRmSqlSyncGroup.md) - -[Get-AzureRmSqlSyncGroup](./Get-AzureRmSqlSyncGroup.md) - diff --git a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlSyncMember.md b/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlSyncMember.md deleted file mode 100644 index 83e5c40b88..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/New-AzureRmSqlSyncMember.md +++ /dev/null @@ -1,391 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/new-azurermsqlsyncmember -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlSyncMember.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlSyncMember.md ---- - -# New-AzureRmSqlSyncMember - -## SYNOPSIS -Creates an Azure SQL Database Sync Member. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### AzureSqlDatabase (Default) -``` -New-AzureRmSqlSyncMember -Name <String> -MemberDatabaseType <String> -MemberServerName <String> - -MemberDatabaseName <String> -MemberDatabaseCredential <PSCredential> [-SyncDirection <String>] - [-SyncGroupName] <String> [-ServerName] <String> [-DatabaseName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### OnPremisesDatabaseSyncAgentComponent -``` -New-AzureRmSqlSyncMember -Name <String> -MemberDatabaseType <String> -SyncAgentResourceGroupName <String> - -SyncAgentServerName <String> -SyncAgentName <String> -SqlServerDatabaseId <String> [-SyncDirection <String>] - [-SyncGroupName] <String> [-ServerName] <String> [-DatabaseName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### OnPremisesDatabaseSyncAgentResourceID -``` -New-AzureRmSqlSyncMember -Name <String> -MemberDatabaseType <String> -SqlServerDatabaseId <String> - -SyncAgentResourceID <String> [-SyncDirection <String>] [-SyncGroupName] <String> [-ServerName] <String> - [-DatabaseName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmSqlSyncMember** cmdlet creates an Azure SQL Database Sync Member. - -## EXAMPLES - -### Example 1: Create a sync member for an Azure SQL database. -``` -PS C:\> $credential = Get-Credential -PS C:\> New-AzureRmSqlSyncMember -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -SyncGroupName "SyncGroup01" -Name "SyncMember01" -SyncDirection "OneWayMemberToHub" --MemberDatabaseType "AzureSqlDatabase" -MemberServerName "memberServer01.full.dns.name" -MemberDatabaseName "memberDatabase01" -MemberDatabaseCredential $credential | Format-List -ResourceId : subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup01}/syncMembers/{SyncMember01} -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -SyncGroupName : SyncGroup01 -SyncMemberName : SyncMember01 -SyncDirection : OneWayMemberToHub -MemberDatabaseType: : AzureSqlDatabase -SyncAgentId : -SqlServerDatabaseId : -MemberServerName : memberServer01.full.dns.name -MemberDatabaseName : memberDatabase01 -MemberDatabaseUserName : myAccount -MemberDatabasePassword : -SyncState : UnProvisioned -``` - -This command creates a sync member for an Azure SQL database. - -### Example 2: Create a sync member for an on-premises SQL Server database -``` -PS C:\> $credential = Get-Credential -PS C:\> New-AzureRmSqlSyncMember -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -SyncGroupName "SyncGroup01" -Name "SyncMember01" -SyncDirection "OneWayMemberToHub" --MemberDatabaseType "SqlServerDatabase" -SqlServerDatabaseId "dbId" -syncAgentResourceGroupName "syncAgentResourceGroupName" -syncAgentServerName "syncAgentServerName" --syncAgentDatabaseName "syncAgentDatabaseName" -syncAgentName "agentName" | Format-List -ResourceId : /subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup01}/syncMembers/{SyncMember01} -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -SyncGroupName : SyncGroup01 -SyncMemberName : SyncMember01 -SyncDirection : OneWayMemberToHub -MemberDatabaseType: : AzureSqlDatabase -SyncAgentId : /subscriptions/{subscriptionId}/resourceGroups/{syncAgentResourceGroupName}/servers/{syncAgentServerName}/syncAgents/{syncAgentId} -SqlServerDatabaseId : dbId -MemberServerName : -MemberDatabaseName : -MemberDatabaseUserName : myAccount -MemberDatabasePassword : -SyncState : UnProvisioned -``` - -This command creates a sync member for an on-premises SQL database. - -## PARAMETERS - -### -DatabaseName -The name of the Azure SQL Database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberDatabaseCredential -The credential (username and password) of the Azure SQL Database. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: AzureSqlDatabase -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberDatabaseName -The Azure SQL Database name of the member database. - -```yaml -Type: System.String -Parameter Sets: AzureSqlDatabase -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberDatabaseType -The database type of the member database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: SqlServerDatabase, AzureSqlDatabase - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MemberServerName -The Azure SQL Server Name of the member database. - -```yaml -Type: System.String -Parameter Sets: AzureSqlDatabase -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The sync member name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: SyncMemberName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The name of the Azure SQL Server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SqlServerDatabaseId -The id of the SQL server database which is connected by the sync agent. - -```yaml -Type: System.String -Parameter Sets: OnPremisesDatabaseSyncAgentComponent, OnPremisesDatabaseSyncAgentResourceID -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SyncAgentName -The name of the sync agent. - -```yaml -Type: System.String -Parameter Sets: OnPremisesDatabaseSyncAgentComponent -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SyncAgentResourceGroupName -The name of the resource group where the sync agent is under. - -```yaml -Type: System.String -Parameter Sets: OnPremisesDatabaseSyncAgentComponent -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SyncAgentResourceID -The resource ID of the sync agent. - -```yaml -Type: System.String -Parameter Sets: OnPremisesDatabaseSyncAgentResourceID -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SyncAgentServerName -The name of the Azure SQL Server where the sync agent is under. - -```yaml -Type: System.String -Parameter Sets: OnPremisesDatabaseSyncAgentComponent -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SyncDirection -The sync direction of this sync member. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Bidirectional, OneWayMemberToHub, OneWayHubToMember - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SyncGroupName -The sync group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncMemberModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlSyncMember](./Get-AzureRmSqlSyncMember.md) - - -[Remove-AzureRmSqlSyncMember](./Remove-AzureRmSqlSyncMember.md) - diff --git a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabase.md b/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabase.md deleted file mode 100644 index 1cc0778f35..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabase.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: B396388D-F91C-4BC9-A211-ABFF5DFC1693 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/remove-azurermsqldatabase -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabase.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabase.md ---- - -# Remove-AzureRmSqlDatabase - -## SYNOPSIS -Removes an Azure SQL database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmSqlDatabase [-DatabaseName] <String> [-Force] [-ServerName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmSqlDatabase** cmdlet removes an Azure SQL database. -This cmdlet is also supported by the SQL Server Stretch Database service on Azure. - -## EXAMPLES - -### Example 1: Remove a database from an Azure SQL server -``` -PS C:\>Remove-AzureRmSqlDatabase -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -``` - -This command removes the database named Database01 from server Server01. - -## PARAMETERS - -### -DatabaseName -Specifies the name of the database that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the Azure resource group to which the database is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server that hosts the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlDatabase](./Get-AzureRmSqlDatabase.md) - -[New-AzureRmSqlDatabase](./New-AzureRmSqlDatabase.md) - -[Resume-AzureRmSqlDatabase](./Resume-AzureRmSqlDatabase.md) - -[Set-AzureRmSqlDatabase](./Set-AzureRmSqlDatabase.md) - -[Suspend-AzureRmSqlDatabase](./Suspend-AzureRmSqlDatabase.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabaseAuditing.md b/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabaseAuditing.md deleted file mode 100644 index 75e9f1b4eb..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabaseAuditing.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: D3BA6534-CAAC-41E2-8442-0606B712E2B8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/remove-azurermsqldatabaseauditing -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseAuditing.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseAuditing.md ---- - -# Remove-AzureRmSqlDatabaseAuditing - -## SYNOPSIS -Removes the auditing of a database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmSqlDatabaseAuditing [-PassThru] [-ServerName] <String> [-DatabaseName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmSqlDatabaseAuditing** cmdlet removes the auditing of an Azure SQL database. -To use this cmdlet, use the *ResourceGroupName*, *ServerName*, and *DatabaseName* parameters to identify the database. -After you run this cmdlet, auditing of the database is not performed. -If the command succeeds and you have used the *PassThru* parameter, the cmdlet returns an object that describes the current auditing policy, in addition to the database identifiers. -Database identifiers include, but are not limited to, the **ResourceGroupName**, **ServerName** and **DatabaseName**. -If you remove auditing of an Azure SQL database, threat detection is also removed. -This cmdlet is also supported by the SQL Server Stretch Database service on Azure. - -## EXAMPLES - -### Example 1: Remove the auditing of an Azure SQL database -``` -PS C:\>Remove-AzureRmSqlDatabaseAuditing -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -``` - -This command removes the auditing of database named Database01. -That database is located on Server01, which is assigned to the resource group named ResourceGroup01. - -## PARAMETERS - -### -DatabaseName -Specifies the name of the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group containing the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server containing the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Auditing.Model.AuditingPolicyModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlDatabaseAuditingPolicy](./Get-AzureRmSqlDatabaseAuditingPolicy.md) - -[Set-AzureRmSqlDatabaseAuditingPolicy](./Set-AzureRmSqlDatabaseAuditingPolicy.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabaseDataMaskingRule.md b/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabaseDataMaskingRule.md deleted file mode 100644 index 049907686f..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabaseDataMaskingRule.md +++ /dev/null @@ -1,233 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 4695AFEA-D244-4FCB-AF36-D8CDEBFB392C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/remove-azurermsqldatabasedatamaskingrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseDataMaskingRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseDataMaskingRule.md ---- - -# Remove-AzureRmSqlDatabaseDataMaskingRule - -## SYNOPSIS -Removes a data masking rule from a database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmSqlDatabaseDataMaskingRule [-PassThru] [-Force] -SchemaName <String> -TableName <String> - -ColumnName <String> [-ServerName] <String> [-DatabaseName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmSqlDatabaseDataMaskingRule** cmdlet removes a specific data masking rule from an Azure SQL database. -You can remove a data masking rule by using the *ResourceGroupName*, *ServerName*, *DatabaseName*, and *RuleId* parameters to identify the rule that this cmdlet removes. -This cmdlet is also supported by the SQL Server Stretch Database service on Azure. - -## EXAMPLES - -### Example 1: Remove a database data masking rule -``` -PS C:\>Remove-AzureRmSqlDatabaseDataMaskingRule -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -SchemaName "dbo" -TableName "table1" -ColumnName "column1" -``` - -This command removes rule name Rule01 defined for the database Database01. -The database is located on Server01 and assigned to resource group ResourceGroup01. - -## PARAMETERS - -### -ColumnName -Specifies the name of the column targeted by the masking rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the database is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SchemaName -Specifies the name of a schema. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server that hosts the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TableName -Specifies the name of an Azure SQL table. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.DataMasking.Model.DatabaseDataMaskingRuleModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlDatabaseDataMaskingRule](./Get-AzureRmSqlDatabaseDataMaskingRule.md) - -[New-AzureRmSqlDatabaseDataMaskingRule](./New-AzureRmSqlDatabaseDataMaskingRule.md) - -[Set-AzureRmSqlDatabaseDataMaskingRule](./Set-AzureRmSqlDatabaseDataMaskingRule.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabaseFailoverGroup.md b/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabaseFailoverGroup.md deleted file mode 100644 index 97912a8bb1..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabaseFailoverGroup.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/remove-azurermsqldatabasefailovergroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseFailoverGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseFailoverGroup.md ---- - -# Remove-AzureRmSqlDatabaseFailoverGroup - -## SYNOPSIS -Removes an Azure SQL Database Failover Group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmSqlDatabaseFailoverGroup [-ServerName] <String> [-FailoverGroupName] <String> [-Force] - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -This command removes the Failover Group with the specified name, leaving all databases and replication relationships intact. The listener endpoint will be unregistered from DNS. -The Failover Group's primary server should be used to execute the command. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmSqlDatabaseFailoverGroup -ResourceGroupName rg -ServerName primaryserver -FailoverGroupName fg -``` - -Remove a Failover Group. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FailoverGroupName -The name of the Azure SQL Database Failover Group to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Skip confirmation message for performing the action. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The name of the primary Azure SQL Database Server of the Failover Group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.FailoverGroup.Model.AzureSqlFailoverGroupModel - -## NOTES - -## RELATED LINKS - -[New-AzureRmSqlDatabaseFailoverGroup](./New-AzureRmSqlDatabaseFailoverGroup.md) - -[Set-AzureRmSqlDatabaseFailoverGroup](./Set-AzureRmSqlDatabaseFailoverGroup.md) - -[Get-AzureRmSqlDatabaseFailoverGroup](./Get-AzureRmSqlDatabaseFailoverGroup.md) - -[Add-AzureRmSqlDatabaseToFailoverGroup](./Add-AzureRmSqlDatabaseToFailoverGroup.md) - -[Remove-AzureRmSqlDatabaseFromFailoverGroup](./Remove-AzureRmSqlDatabaseFromFailoverGroup.md) - -[Switch-AzureRmSqlDatabaseFailoverGroup](./Switch-AzureRmSqlDatabaseFailoverGroup.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabaseFromFailoverGroup.md b/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabaseFromFailoverGroup.md deleted file mode 100644 index 3fa6c1deb6..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabaseFromFailoverGroup.md +++ /dev/null @@ -1,208 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/remove-azurermsqldatabasefromfailovergroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseFromFailoverGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseFromFailoverGroup.md ---- - -# Remove-AzureRmSqlDatabaseFromFailoverGroup - -## SYNOPSIS -Removes one or more databases from an Azure SQL Database Failover Group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmSqlDatabaseFromFailoverGroup [-ServerName] <String> [-FailoverGroupName] <String> - -Database <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel]> - [-Force] [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Removes one or more databases from the specified Azure SQL Database Failover Group. The databases and replication relationships are left intact, but they will no longer be accessible through the Failover Group endpoints. -To obtain database objects with which to populate the '-Database' parameter, use (for example) the Get-AzureRmSqlDatabase cmdlet. -The Failover Group's primary server must be used to execute the command. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $failoverGroup = Get-AzureRmSqlDatabase -ResourceGroupName rg -ServerName primaryserver -DatabaseName db1 | Remove-AzureRmSqlDatabaseFromFailoverGroup -ResourceGroupName rg -ServerName primaryserver -FailoverGroupName fg -``` - -This command removes one database from a Failover Group by piping it in. - -### Example 2 -``` -PS C:\> $primaryServer = Get-AzureRmSqlServer -ResourceGroupName rg -ServerName primaryserver -PS C:\> $failoverGroup = $primaryServer | Remove-AzureRmSqlDatabaseFromFailoverGroup -FailoverGroupName fg -Database ($primaryServer | Get-AzureRmSqlDatabase) -``` - -This command removes all databases from a Failover Group. - -### Example 3 -``` -PS C:\> $failoverGroup = Get-AzureRmSqlDatabaseFailoverGroup -ResourceGroupName rg -ServerName primaryserver -FailoverGroupName fg -PS C:\> $databases = Get-AzureRmSqlElasticPoolDatabase -ResourceGroupName rg -ServerName primaryserver -ElasticPoolName pool1 -PS C:\> $failoverGroup = $failoverGroup | Remove-AzureRMSqlDatabaseFromFailoverGroup -Database $databases -``` - -This command removes all databases in an Elastic Pool from a Failover Group. - -## PARAMETERS - -### -Database -One or more Azure SQL Databases on the Failover Group's primary server to be removed from the Failover Group. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FailoverGroupName -The name of the Azure SQL Database Failover Group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Skip confirmation message for performing the action. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The name of the primary Azure SQL Database Server of the Failover Group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel, Microsoft.Azure.Commands.Sql, Version=4.11.0.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.FailoverGroup.Model.AzureSqlFailoverGroupModel - -## NOTES - -## RELATED LINKS - -[New-AzureRmSqlDatabaseFailoverGroup](./New-AzureRmSqlDatabaseFailoverGroup.md) - -[Set-AzureRmSqlDatabaseFailoverGroup](./Set-AzureRmSqlDatabaseFailoverGroup.md) - -[Get-AzureRmSqlDatabaseFailoverGroup](./Get-AzureRmSqlDatabaseFailoverGroup.md) - -[Add-AzureRmSqlDatabaseToFailoverGroup](./Add-AzureRmSqlDatabaseToFailoverGroup.md) - -[Switch-AzureRmSqlDatabaseFailoverGroup](./Switch-AzureRmSqlDatabaseFailoverGroup.md) - -[Remove-AzureRmSqlDatabaseFailoverGroup](./Remove-AzureRmSqlDatabaseFailoverGroup.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabaseLongTermRetentionBackup.md b/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabaseLongTermRetentionBackup.md deleted file mode 100644 index 9901612735..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabaseLongTermRetentionBackup.md +++ /dev/null @@ -1,263 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/remove-azurermsqldatalongtermretentionbackup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseLongTermRetentionBackup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseLongTermRetentionBackup.md ---- - -# Remove-AzureRmSqlDatabaseLongTermRetentionBackup - -## SYNOPSIS -Deletes a long term retention backup. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RemoveBackupDefault (Default) -``` -Remove-AzureRmSqlDatabaseLongTermRetentionBackup [-Location] <String> [-ServerName] <String> - [-DatabaseName] <String> [-BackupName] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### RemoveBackupByInputObject -``` -Remove-AzureRmSqlDatabaseLongTermRetentionBackup [-InputObject] <AzureSqlDatabaseLongTermRetentionBackupModel> - [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RemoveBackupByResourceId -``` -Remove-AzureRmSqlDatabaseLongTermRetentionBackup [-ResourceId] <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmSqlDatabaseLongTermRetentionBackup** cmdlet deletes the backup specified. - -## EXAMPLES - -### Example 1: Delete a single backup -```powershell -PS C:\> Remove-AzureRmSqlDatabaseLongTermRetentionBackup -Location northeurope -ServerName server01 -DatabaseName database01 -BackupName "601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000" - - -BackupExpirationTime : 3/22/2018 5:50:55 AM -BackupName : 601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000 -BackupTime : 3/15/2018 5:50:55 AM -DatabaseName : database01 -DatabaseDeletionTime : -Location : northeurope -ResourceId : /subscriptions/371edd6d-9630-4558-a7bd-ee139498e6a1/providers/Microsoft.Sql/locations/northeurope/longTermRetentionServers/server01/longTermRetentionDatabases/database01/longTermRetentionBackups/601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000 -ServerName : server01 -ServerCreateTime : 2/29/2018 12:12:19 AM -``` - -Deletes the backup with name 601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000 - -### Example 2: Delete all backups for a location -```powershell -PS C:\> Get-AzureRmSqlDatabaseLongTermRetentionBackup -Location northeurope | Remove-AzureRmSqlDatabaseLongTermRetentionBackup - - -BackupExpirationTime : 3/22/2018 11:43:18 PM -BackupName : 55970792-164c-4a4a-88e5-7158d092d503;131656309980000000 -BackupTime : 3/15/2018 11:43:18 PM -DatabaseName : database02 -DatabaseDeletionTime : 3/18/2018 4:36:00 PM -Location : northeurope -ResourceId : /subscriptions/371edd6d-9630-4558-a7bd-ee139498e6a1/providers/Microsoft.Sql/locations/northeurope/longTermRetentionServers/server02/longTermRetentionDatabases/database02/longTermRetentionBackups/55970792-164c-4a4a-88e5-7158d092d503;131656309980000000 -ServerName : server02 -ServerCreateTime : 2/28/2018 12:12:19 AM - -BackupExpirationTime : 3/22/2018 5:50:55 AM -BackupName : 601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000 -BackupTime : 3/15/2018 5:50:55 AM -DatabaseName : database01 -DatabaseDeletionTime : -Location : northeurope -ResourceId : /subscriptions/371edd6d-9630-4558-a7bd-ee139498e6a1/providers/Microsoft.Sql/locations/northeurope/longTermRetentionServers/server01/longTermRetentionDatabases/database01/longTermRetentionBackups/601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000 -ServerName : server01 -ServerCreateTime : 2/29/2018 12:12:19 AM -``` - -This command deletes all long term retention backups for the northeurope location. - -## PARAMETERS - -### -BackupName -The name of the backup. - -```yaml -Type: System.String -Parameter Sets: RemoveBackupDefault -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseName -The name of the Azure SQL Database the backup is from. - -```yaml -Type: System.String -Parameter Sets: RemoveBackupDefault -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Skip confirmation message for performing the action - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The Database Long Term Retention Backup object to remove. - -```yaml -Type: Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlDatabaseLongTermRetentionBackupModel -Parameter Sets: RemoveBackupByInputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The location of the backups' source server. - -```yaml -Type: System.String -Parameter Sets: RemoveBackupDefault -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The Resource ID of the Database Long Term Retention Backup to remove. - -```yaml -Type: System.String -Parameter Sets: RemoveBackupByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The name of the Azure SQL Server the backup is under. - -```yaml -Type: System.String -Parameter Sets: RemoveBackupDefault -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlDatabaseLongTermRetentionBackupModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlDatabaseLongTermRetentionBackup](./Get-AzureRmSqlDatabaseLongTermRetentionBackup.md) - -[Get-AzureRmSqlDatabaseBackupLongTermRetentionPolicy](./Get-AzureRmSqlDatabaseBackupLongTermRetentionPolicy.md) - -[Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy](./Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabaseRestorePoint.md b/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabaseRestorePoint.md deleted file mode 100644 index 8094fa4fe7..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabaseRestorePoint.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 67A9BB67-EF14-4CAA-99D9-002D0D23178B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/remove-azurermsqldatabaserestorepoint -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseRestorePoint.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseRestorePoint.md ---- - -# Remove-AzureRmSqlDatabaseRestorePoint - -## SYNOPSIS -Removes given restore point from a SQL Database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmSqlDatabaseRestorePoint -RestorePointCreationDate <DateTime> [-PassThru] [-ServerName] <String> - [-DatabaseName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmSqlDatabaseRestorePoint** cmdlet removes given restore point from Azure SQL Database. -This cmdlet is currently supported by the SQL Server Datawarehouse service on Azure SQL Database. - -## EXAMPLES - -### Example 1: Removes a restore point -``` -PS C:\>$RestorePointCreationDate = Get-Date "3/11/2017 1:50:00 AM" -PS C:\>Remove-AzureRmSqlDatabaseRestorePoint -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -RestorePointCreationDate $RestorePointCreationDate -``` - -This command removes a restore point for Azure SQL Database given creation date. - -## PARAMETERS - -### -DatabaseName -Specifies the name of the SQL Database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the SQL Database is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RestorePointCreationDate -Specifies the restore point creation date. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the AzureSQL Server that hosts the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.DateTime - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlDatabaseRestorePointModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabaseSecondary.md b/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabaseSecondary.md deleted file mode 100644 index f84f3b731c..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabaseSecondary.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 54E01B3B-FFA5-4E3C-BA5A-A281FF5C9F8B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/remove-azurermsqldatabasesecondary -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseSecondary.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseSecondary.md ---- - -# Remove-AzureRmSqlDatabaseSecondary - -## SYNOPSIS -Terminates data replication between a SQL Database and the specified secondary database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmSqlDatabaseSecondary [-DatabaseName] <String> -PartnerResourceGroupName <String> - -PartnerServerName <String> [-ServerName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmSqlDatabaseSecondary** cmdlet forces termination of a geo-replication link. -This cmdlet replaces the Stop-AzureSqlDatabaseCopy cmdlet. -There is no replication synchronization before termination. - -## EXAMPLES - -## PARAMETERS - -### -DatabaseName -Specifies the name of the primary Azure SQL Database that has the replication link that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PartnerResourceGroupName -Specifies the name of the partner resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PartnerServerName -Specifies the name of the partner SQL Server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that is associated with the replication link to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the SQL Server that has the replication link to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Replication.Model.AzureReplicationLinkModel - -## NOTES - -## RELATED LINKS - -[New-AzureRmSqlDatabaseSecondary](./New-AzureRmSqlDatabaseSecondary.md) - -[Set-AzureRmSqlDatabaseSecondary](./Set-AzureRmSqlDatabaseSecondary.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabaseThreatDetectionPolicy.md b/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabaseThreatDetectionPolicy.md deleted file mode 100644 index 682d406a1f..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlDatabaseThreatDetectionPolicy.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: FCCB768A-A034-44AF-B4B6-2AD3133B08EF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/remove-azurermsqldatabasethreatdetectionpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseThreatDetectionPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseThreatDetectionPolicy.md ---- - -# Remove-AzureRmSqlDatabaseThreatDetectionPolicy - -## SYNOPSIS -Removes the threat detection policy from a database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmSqlDatabaseThreatDetectionPolicy [-PassThru] [-ServerName] <String> [-DatabaseName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmSqlDatabaseThreatDetectionPolicy** cmdlet removes the threat detection policy from an AzureAzure SQL database. -To use this cmdlet, specify the *ResourceGroupName* and *ServerName* parameters to identify the database from which this cmdlet removes the policy. - -## EXAMPLES - -### Example 1: Remove a threat detection policy for a database -``` -PS C:\>Remove-AzureRmSqlDatabaseThreatDetectionPolicy -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" -``` - -This command removes the threat detection policy from a database named Database01 on the server named Server01. - -## PARAMETERS - -### -DatabaseName -Specifies the name of a database where the threat detection policy should be removed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group the server belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of a server on which the database runs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ThreatDetection.Model.DatabaseThreatDetectionPolicyModel - -## NOTES - -## RELATED LINKS - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlElasticPool.md b/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlElasticPool.md deleted file mode 100644 index 97d80bb8ed..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlElasticPool.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 47E8E8C1-A63D-4243-A004-ABD5CA1A559E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/remove-azurermsqlelasticpool -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlElasticPool.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlElasticPool.md ---- - -# Remove-AzureRmSqlElasticPool - -## SYNOPSIS -Deletes an elastic database pool. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmSqlElasticPool [-ElasticPoolName] <String> [-Force] [-ServerName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmSqlElasticPool** cmdlet deletes an Azure SQL Database elastic pool. - -## EXAMPLES - -### Example 1: Delete an elastic pool -``` -PS C:\>Remove-AzureRmSqlElasticPool -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ElasticPoolName "ElasticPool01" -``` - -This command deletes an elastic pool named ElasticPool01. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ElasticPoolName -Specifies the name of the elastic pool that this cmdlet deletes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the elastic pool is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server that hosts the elastic pool. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlElasticPool](./Get-AzureRmSqlElasticPool.md) - -[Get-AzureRmSqlElasticPoolActivity](./Get-AzureRmSqlElasticPoolActivity.md) - -[Get-AzureRmSqlElasticPoolDatabase](./Get-AzureRmSqlElasticPoolDatabase.md) - -[New-AzureRmSqlElasticPool](./New-AzureRmSqlElasticPool.md) - -[Set-AzureRmSqlElasticPool](./Set-AzureRmSqlElasticPool.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlInstance.md b/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlInstance.md deleted file mode 100644 index 015bcf333b..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlInstance.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/remove-azurermsqlmanagedinstance -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlInstance.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlInstance.md ---- - -# Remove-AzureRmSqlInstance - -## SYNOPSIS -Removes an Azure SQL Managed Database Instance. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RemoveInstanceFromInputParameters (Default) -``` -Remove-AzureRmSqlInstance [-Name] <String> [-ResourceGroupName] <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RemoveInstanceFromAzureSqlManagedInstanceModelInstanceDefinition -``` -Remove-AzureRmSqlInstance [-InputObject] <AzureSqlManagedInstanceModel> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RemoveInstanceFromAzureResourceId -``` -Remove-AzureRmSqlInstance [-ResourceId] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmSqlInstance** cmdlet removes an Azure SQL Database Managed Instance. - -## EXAMPLES - -### Example 1: Remove instance -``` -PS C:\>Remove-AzureRmSqlInstance -Name "managedInstance1" -ResourceGroupName "ResourceGroup01" -``` - -This command removes the instance named managedInstance1. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Skip confirmation message for performing the action - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The AzureSqlManagedInstanceModel object to remove - -```yaml -Type: AzureSqlManagedInstanceModel -Parameter Sets: RemoveInstanceFromAzureSqlManagedInstanceModelInstanceDefinition -Aliases: SqlInstance - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -SQL instance name. - -```yaml -Type: String -Parameter Sets: RemoveInstanceFromInputParameters -Aliases: InstanceName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: String -Parameter Sets: RemoveInstanceFromInputParameters -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The resource id of instance object to remove - -```yaml -Type: String -Parameter Sets: RemoveInstanceFromAzureResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel -System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlInstanceDatabase.md b/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlInstanceDatabase.md deleted file mode 100644 index f398966797..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlInstanceDatabase.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/remove-azurermsqlinstancedatabase -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlInstanceDatabase.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlInstanceDatabase.md ---- - -# Remove-AzureRmSqlInstanceDatabase - -## SYNOPSIS -Removes an Azure SQL Managed Instance database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RemoveInstanceDatabaseFromInputParameters (Default) -``` -Remove-AzureRmSqlInstanceDatabase [-Name] <String> [-InstanceName] <String> [-ResourceGroupName] <String> - [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RemoveInstanceDatabaseFromAzureSqlManagedDatabaseModelInstanceDefinition -``` -Remove-AzureRmSqlInstanceDatabase [-InputObject] <AzureSqlManagedDatabaseModel> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RemoveInstanceDatabaseFromAzureResourceId -``` -Remove-AzureRmSqlInstanceDatabase [-ResourceId] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmSqlInstanceDatabase** cmdlet removes an Azure SQL Managed Instance database. - -## EXAMPLES - -### Example 1: Remove a database from an instance -``` -PS C:\>Remove-AzureRmSqlInstanceDatabase -Name "Database01" -InstanceName "managedInstance1" -ResourceGroupName "ResourceGroup01" -``` - -This command removes the database named Database01 from instance managedInstance1. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Skip confirmation message for performing the action - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The Instance Database object to remove - -```yaml -Type: AzureSqlManagedDatabaseModel -Parameter Sets: RemoveInstanceDatabaseFromAzureSqlManagedDatabaseModelInstanceDefinition -Aliases: InstanceDatabase - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InstanceName -The instance name. - -```yaml -Type: String -Parameter Sets: RemoveInstanceDatabaseFromInputParameters -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the Azure SQL Instance Database to remove. - -```yaml -Type: String -Parameter Sets: RemoveInstanceDatabaseFromInputParameters -Aliases: InstanceDatabaseName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: String -Parameter Sets: RemoveInstanceDatabaseFromInputParameters -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The resource id of Instance Database object to remove - -```yaml -Type: String -Parameter Sets: RemoveInstanceDatabaseFromAzureResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel -System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServer.md b/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServer.md deleted file mode 100644 index 16c8dc4331..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServer.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 068D70EF-39D1-4199-BD74-0EC266DF7072 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/remove-azurermsqlserver -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServer.md ---- - -# Remove-AzureRmSqlServer - -## SYNOPSIS -Removes an Azure SQL Database server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmSqlServer [-ServerName] <String> [-Force] [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmSqlServer** cmdlet removes an Azure SQL Database server. -The delete operation is asynchronous and may take some time, so verify the operation is finished before performing any additional operations that depend on the server being completely deleted. -For instance, you need to create a new server that uses the same name. - -## EXAMPLES - -### Example 1: Remove a server -``` -PS C:\>Remove-AzureRmSqlServer -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -``` - -This command removes the Azure SQL Database server named Server01. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the server is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlServer](./Get-AzureRmSqlServer.md) - -[New-AzureRmSqlServer](./New-AzureRmSqlServer.md) - -[Set-AzureRmSqlServer](./Set-AzureRmSqlServer.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerActiveDirectoryAdministrator.md b/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerActiveDirectoryAdministrator.md deleted file mode 100644 index 08a3acb42c..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerActiveDirectoryAdministrator.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: B2E6E66A-1A09-4DB0-8BB4-D2E5EC34C9EB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/remove-azurermsqlserveractivedirectoryadministrator -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerActiveDirectoryAdministrator.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerActiveDirectoryAdministrator.md ---- - -# Remove-AzureRmSqlServerActiveDirectoryAdministrator - -## SYNOPSIS -Removes a Microsoft Entra administrator for SQL Server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmSqlServerActiveDirectoryAdministrator [-Force] [-ServerName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmSqlServerActiveDirectoryAdministrator** cmdlet removes a Microsoft Entra administrator for AzureSQL Server in the current subscription. - -## EXAMPLES - -### Example 1: Remove an administrator -``` -PS C:\>Remove-AzureRmSqlServerActiveDirectoryAdministrator -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -Confirm -Are you sure you want to remove the Azure Sql Server Active Directory Administrator on server 'Server01'? -[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y - -ResourceGroupName ServerName DisplayName ObjectId ------------------ ---------- ----------- -------- -ResourceGroup01 Server01 DBAs 40b79501-b343-44ed-9ce7-da4c8cc7353b -``` - -This command removes the Microsoft Entra administrator for the server named Server01 associated with the resource group ResourceGroup01. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the SQL Server is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the SQL Server for which this cmdlet removes an administrator. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ServerActiveDirectoryAdministrator.Model.AzureSqlServerActiveDirectoryAdministratorModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlServerActiveDirectoryAdministrator](./Get-AzureRmSqlServerActiveDirectoryAdministrator.md) - -[Set-AzureRmSqlServerActiveDirectoryAdministrator](./Set-AzureRmSqlServerActiveDirectoryAdministrator.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerAuditing.md b/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerAuditing.md deleted file mode 100644 index 442d155948..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerAuditing.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 692D0B64-95EB-4D36-975F-65674B3B2F8C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/remove-azurermsqlserverauditing -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerAuditing.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerAuditing.md ---- - -# Remove-AzureRmSqlServerAuditing - -## SYNOPSIS -Removes the auditing of a SQL server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmSqlServerAuditing [-PassThru] -ServerName <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmSqlServerAuditing** cmdlet removes the auditing of an Azure SQL server. -To use this cmdlet, specify the *ResourceGroupName* and *ServerName* parameters to identify the server. -After you run this cmdlet, auditing of the databases on the Azure SQL server is not performed. -If the command succeeds, and you specify the *PassThru* parameter, the cmdlet returns an object that describes the current auditing policy and the Azure SQL server identifiers. -Server identifiers include the **ResourceGroupName** and **ServerName**. - -## EXAMPLES - -### Example 1: Remove the auditing of an Azure SQL server -``` -PS C:\>Remove-AzureRmSqlServerAuditing -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -``` - -This command removes the auditing of all the databases located on Server01 in resource group. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the Azure SQL server is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the Azure SQL server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Auditing.Model.AuditingPolicyModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlDatabaseAuditingPolicy](./Get-AzureRmSqlDatabaseAuditingPolicy.md) - -[Set-AzureRmSqlDatabaseAuditingPolicy](./Set-AzureRmSqlDatabaseAuditingPolicy.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerCommunicationLink.md b/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerCommunicationLink.md deleted file mode 100644 index 90030e6f1e..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerCommunicationLink.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 48D6288A-EBE1-44FD-B871-80A0681BBEA3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/remove-azurermsqlservercommunicationlink -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerCommunicationLink.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerCommunicationLink.md ---- - -# Remove-AzureRmSqlServerCommunicationLink - -## SYNOPSIS -Deletes a communication link for elastic database transactions between two servers. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmSqlServerCommunicationLink [-LinkName] <String> [-Force] [-ServerName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmSqlServerCommunicationLink** cmdlet deletes a server-to-server communication link for elastic database transactions in Azure SQL Database. - -## EXAMPLES - -### Example 1: Delete a communication link -``` -PS C:\>Remove-AzureRmSqlServerCommunicationLink -ResourceGroupName "ResourceGroup01" -ServerName "ContosoServer17" -LinkName "Link01" -``` - -This command deletes a server-to-server communication link named Link01 on ContosoServer17. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LinkName -Specifies the name of the server communication link that this cmdlet deletes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the server specified by the *ServerName* parameter belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of a server. -This server contains the communication link that this cmdlet deletes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ServerCommunicationLink.Model.AzureSqlServerCommunicationLinkModel - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - -## RELATED LINKS - -[Get-AzureRmSqlServerCommunicationLink](./Get-AzureRmSqlServerCommunicationLink.md) - -[New-AzureRmSqlServerCommunicationLink](./New-AzureRmSqlServerCommunicationLink.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerDisasterRecoveryConfiguration.md b/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerDisasterRecoveryConfiguration.md deleted file mode 100644 index 167a1030cd..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerDisasterRecoveryConfiguration.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 2A74E72B-BD6B-45D7-9C19-B2575C60C43F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/remove-azurermsqlserverdisasterrecoveryconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerDisasterRecoveryConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerDisasterRecoveryConfiguration.md ---- - -# Remove-AzureRmSqlServerDisasterRecoveryConfiguration - -## SYNOPSIS -Removes a SQL database server system recovery configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmSqlServerDisasterRecoveryConfiguration [-VirtualEndpointName] <String> [-Force] - [-ServerName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmSqlServerDisasterRecoveryConfiguration** cmdlet removes a SQL database server system recovery configuration. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of a SQL database server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualEndpointName -Specifies the name of a virtual end point. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ServerDisasterRecoveryConfiguration.Model.AzureSqlServerDisasterRecoveryConfigurationModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlServerDisasterRecoveryConfiguration](./Get-AzureRmSqlServerDisasterRecoveryConfiguration.md) - -[New-AzureRmSqlServerDisasterRecoveryConfiguration](./New-AzureRmSqlServerDisasterRecoveryConfiguration.md) - -[Set-AzureRmSqlServerDisasterRecoveryConfiguration](./Set-AzureRmSqlServerDisasterRecoveryConfiguration.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerDnsAlias.md b/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerDnsAlias.md deleted file mode 100644 index 51994914b9..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerDnsAlias.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/remove-azurermsqlserverdnsalias -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerDnsAlias.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerDnsAlias.md ---- - -# Remove-AzureRmSqlServerDnsAlias - -## SYNOPSIS -Removes Azure SQL Server DNS Alias. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Remove a Server Dns Alias from cmdlet input parameters -``` -Remove-AzureRmSqlServerDnsAlias -Name <String> -ServerName <String> [-ResourceGroupName] <String> [-Force] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Remove a Server Dns Alias from AzureSqlServerDnsAliasModel instance definition -``` -Remove-AzureRmSqlServerDnsAlias -InputObject <AzureSqlServerDnsAliasModel> [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Remove a Server Dns Alias from an Azure resource id -``` -Remove-AzureRmSqlServerDnsAlias -ResourceId <String> [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -This commands remove Azure SQL Server DNS Alias from the server leaving server intact. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmSqlServerDnsAlias -DnsAliasName aliasName -ServerName serverName -ResourceGroupName rg -``` - -Removes Azure SQL Server DNS Alias with the name aliasName from the server with the name serverName - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Skip confirmation message for performing the action - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The Server Dns Alias object to remove - -```yaml -Type: Microsoft.Azure.Commands.Sql.ServerDnsAlias.Model.AzureSqlServerDnsAliasModel -Parameter Sets: Remove a Server Dns Alias from AzureSqlServerDnsAliasModel instance definition -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Azure Sql Server Dns Alias name - -```yaml -Type: System.String -Parameter Sets: Remove a Server Dns Alias from cmdlet input parameters -Aliases: DnsAliasName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: Remove a Server Dns Alias from cmdlet input parameters -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The resource id of Server Dns Alias object to remove - -```yaml -Type: System.String -Parameter Sets: Remove a Server Dns Alias from an Azure resource id -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The Azure Sql Server name. - -```yaml -Type: System.String -Parameter Sets: Remove a Server Dns Alias from cmdlet input parameters -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Sql.ServerDnsAlias.Model.AzureSqlServerDnsAliasModel -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ServerDnsAlias.Model.AzureSqlServerDnsAliasModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerFirewallRule.md b/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerFirewallRule.md deleted file mode 100644 index 8d882e0b40..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerFirewallRule.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 251A4546-AC23-4880-B197-773B1B814607 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/remove-azurermsqlserverfirewallrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerFirewallRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerFirewallRule.md ---- - -# Remove-AzureRmSqlServerFirewallRule - -## SYNOPSIS -Deletes a firewall rule from a SQL Database server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmSqlServerFirewallRule [-FirewallRuleName] <String> [-Force] [-ServerName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmSqlServerFirewallRule** cmdlet deletes a firewall rule from the specified Azure SQL Database server. - -## EXAMPLES - -### Example 1: Delete a rule -``` -PS C:\>Remove-AzureRmSqlServerFirewallRule -FirewallRuleName "Rule01" -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -``` - -This command deletes a firewall rule named Rule01 on the server named Server01. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FirewallRuleName -Specifies the name of the firewall rule that this cmdlet deletes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group to which the server is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.FirewallRule.Model.AzureSqlServerFirewallRuleModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlServerFirewallRule](./Get-AzureRmSqlServerFirewallRule.md) - -[New-AzureRmSqlServerFirewallRule](./New-AzureRmSqlServerFirewallRule.md) - -[Set-AzureRmSqlServerFirewallRule](./Set-AzureRmSqlServerFirewallRule.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerKeyVaultKey.md b/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerKeyVaultKey.md deleted file mode 100644 index 3d78670e1d..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerKeyVaultKey.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/remove-azurermsqlserverkeyvaultkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerKeyVaultKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerKeyVaultKey.md ---- - -# Remove-AzureRmSqlServerKeyVaultKey - -## SYNOPSIS -Removes a Key Vault key from a SQL server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmSqlServerKeyVaultKey [-KeyId] <String> [-AsJob] [-ServerName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmSqlServerKeyVaultKey cmdlet removes the Key Vault key from the specified SQL server. -Note that the SQL server's permissions to the key's vault are not changed. -To change permissions, use Set-AzureRmKeyVaultAccessPolicy. -Note that this cmdlet makes no changes to Key Vault. -To remove a key from Key Vault, use Remove-AzureKeyVaultKey. - -## EXAMPLES - -### Example 1: Remove a Key Vault key -``` -PS C:\> Remove-AzureRmSqlServerKeyVaultKey -KeyId 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' -ServerName 'ContosoServer' -ResourceGroupName 'ContosoResourceGroup' -``` - -This command removes the Key Vault key with Id 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' from the specified server. -ResourceGroupName : ContosoResourceGroup -ServerName : ContosoServer -ServerKeyName : contoso_contosokey_01234567890123456789012345678901 -Type : AzureKeyVault -Uri : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901 -Thumbprint : 1122334455667788990011223344556677889900 -CreationDate : 1/1/2017 12:00:00 AM - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyId -The Azure Key Vault KeyId. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The Azure Sql Server name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ServerKeyVaultKey.Model.AzureSqlServerKeyVaultKeyModel - -## NOTES - -## RELATED LINKS - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerThreatDetectionPolicy.md b/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerThreatDetectionPolicy.md deleted file mode 100644 index 1a43cf0082..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerThreatDetectionPolicy.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: DCAB75A1-B4EF-4C41-9D6B-A954B6DB0028 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/remove-azurermsqlserverthreatdetectionpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerThreatDetectionPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerThreatDetectionPolicy.md ---- - -# Remove-AzureRmSqlServerThreatDetectionPolicy - -## SYNOPSIS -Removes the threat detection policy from a server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmSqlServerThreatDetectionPolicy [-PassThru] -ServerName <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmSqlServerThreatDetectionPolicy cmdlet removes the threat detection policy from an Azure SQL server. -To use this cmdlet, specify the ResourceGroupName and ServerName parameters to identify the server from which this cmdlet removes the policy. - -## EXAMPLES - -### Example 1: Remove a threat detection policy for a database -``` -PS C:\> Remove-AzureRmSqlServerThreatDetectionPolicy -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -``` - -This command removes the threat detection policy from a server named Server01. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group the server is assigned to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of a server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ThreatDetection.Model.ServerThreatDetectionPolicyModel - -## NOTES - -## RELATED LINKS - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - diff --git a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerVirtualNetworkRule.md b/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerVirtualNetworkRule.md deleted file mode 100644 index 54df4286f7..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlServerVirtualNetworkRule.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/remove-azurermsqlservervirtualnetworkrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerVirtualNetworkRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerVirtualNetworkRule.md ---- - -# Remove-AzureRmSqlServerVirtualNetworkRule - -## SYNOPSIS -Deletes an Azure SQL Server Virtual Network Rule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmSqlServerVirtualNetworkRule -VirtualNetworkRuleName <String> [-AsJob] -ServerName <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -This command deletes an Azure SQL Server Virtual Network Rule. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $virtualNetworkRule = Remove-AzureRmSqlServerVirtualNetworkRule -ResourceGroupName rg -ServerName serverName -VirtualNetworkRuleName virtualNetworkRuleName -``` - -Deletes an existing Azure SQL Server virtual network rule - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The Azure Sql Server name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkRuleName -Azure Sql Server Virtual Network Rule name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.VirtualNetworkRule.Model.AzureSqlServerVirtualNetworkRuleModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlSyncAgent.md b/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlSyncAgent.md deleted file mode 100644 index 7c229170d4..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlSyncAgent.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/remove-azurermsqlsyncagent -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlSyncAgent.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlSyncAgent.md ---- - -# Remove-AzureRmSqlSyncAgent - -## SYNOPSIS -Removes an Azure SQL Sync Agent. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmSqlSyncAgent [-Name] <String> [-Force] [-PassThru] [-ServerName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmSqlSyncAgent** cmdlet removes an Azure SQL Sync Agent. - -## EXAMPLES - -### Example 1: Remove a sync agent -``` -PS C:\>Remove-AzureRmSqlSyncAgent -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -Name "syncAgent01" -``` - -This command removes the Azure SQL Sync Agent named syncAgent01. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Skip confirmation message for performing the action - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The sync agent name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: SyncAgentName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Defines Whether return the removed sync agent - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The name of the Azure SQL Server the sync agent is in. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncAgentModel - -## NOTES - -## RELATED LINKS - -[New-AzureRmSqlSyncAgent](./New-AzureRmSqlSyncAgent.md) - -[Get-AzureRmSqlSyncAgent](./Get-AzureRmSqlSyncAgent.md) - diff --git a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlSyncGroup.md b/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlSyncGroup.md deleted file mode 100644 index dc6122cddd..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlSyncGroup.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/remove-azurermsqlsyncgroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlSyncGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlSyncGroup.md ---- - -# Remove-AzureRmSqlSyncGroup - -## SYNOPSIS -Removes an Azure SQL Database Sync Group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmSqlSyncGroup [-Name] <String> [-Force] [-PassThru] [-ServerName] <String> - [-DatabaseName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmSqlSyncGroup** cmdlet removes an Azure SQL Database Sync Group. - -## EXAMPLES - -### Example 1: Remove a sync group -``` -PS C:\>Remove-AzureRmSqlSyncGroup -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "database01" -Name "syncGroup01" -``` - -This command removes the Azure SQL Database Sync Group named syncGroup01. - -## PARAMETERS - -### -DatabaseName -The name of the Azure SQL Database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Skip confirmation message for performing the action - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The sync group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: SyncGroupName - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Defines Whether return the removed sync group - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The name of the Azure SQL Server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncGroupModel - -## NOTES - -## RELATED LINKS - -[New-AzureRmSqlSyncGroup](./New-AzureRmSqlSyncGroup.md) - -[Update-AzureRmSqlSyncGroup](./Update-AzureRmSqlSyncGroup.md) - -[Get-AzureRmSqlSyncGroup](./Get-AzureRmSqlSyncGroup.md) - diff --git a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlSyncMember.md b/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlSyncMember.md deleted file mode 100644 index 070d7bd966..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Remove-AzureRmSqlSyncMember.md +++ /dev/null @@ -1,210 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/remove-azurermsqlsyncmember -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlSyncMember.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlSyncMember.md ---- - -# Remove-AzureRmSqlSyncMember - -## SYNOPSIS -Removes an Azure SQL Database Sync Member. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmSqlSyncMember -Name <String> [-Force] [-PassThru] [-SyncGroupName] <String> - [-ServerName] <String> [-DatabaseName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmSqlSyncMember** cmdlet removes an Azure SQL Database Sync Member. - -## EXAMPLES - -### Example 1: Remove a sync member -``` -PS C:\>Remove-AzureRmSqlSyncMember -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "database01" -SyncGroupName "syncGroup01" -Name "syncMember01" -``` - -This command removes the Azure SQL Database Sync Member named syncMember01. - -## PARAMETERS - -### -DatabaseName -The name of the Azure SQL Database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Skip confirmation message for performing the action - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The sync member name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: SyncMemberName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Defines Whether return the removed sync member - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The name of the Azure SQL Server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SyncGroupName -The sync group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncMemberModel - -## NOTES - -## RELATED LINKS - -[New-AzureRmSqlSyncMember](./New-AzureRmSqlSyncMember.md) - -[Update-AzureRmSqlSyncMember](./Update-AzureRmSqlSyncMember.md) - -[Get-AzureRmSqlSyncMember](./Get-AzureRmSqlSyncMember.md) - diff --git a/azurermps-6.13.0/AzureRM.Sql/Restore-AzureRmSqlDatabase.md b/azurermps-6.13.0/AzureRM.Sql/Restore-AzureRmSqlDatabase.md deleted file mode 100644 index 6ec39e885b..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Restore-AzureRmSqlDatabase.md +++ /dev/null @@ -1,475 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 72E0E558-74D7-4A50-A975-FA7D0C0B301E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/restore-azurermsqldatabase -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Restore-AzureRmSqlDatabase.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Restore-AzureRmSqlDatabase.md ---- - -# Restore-AzureRmSqlDatabase - -## SYNOPSIS -Restores a SQL database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### FromPointInTimeBackup -``` -Restore-AzureRmSqlDatabase [-FromPointInTimeBackup] -PointInTime <DateTime> -ResourceId <String> - -ServerName <String> -TargetDatabaseName <String> [-Edition <String>] [-ServiceObjectiveName <String>] - [-ElasticPoolName <String>] [-AsJob] [-LicenseType <String>] [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### FromPointInTimeBackupWithVcore -``` -Restore-AzureRmSqlDatabase [-FromPointInTimeBackup] -PointInTime <DateTime> -ResourceId <String> - -ServerName <String> -TargetDatabaseName <String> -Edition <String> [-AsJob] -ComputeGeneration <String> - -VCore <Int32> [-LicenseType <String>] [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### FromDeletedDatabaseBackup -``` -Restore-AzureRmSqlDatabase [-FromDeletedDatabaseBackup] [-PointInTime <DateTime>] -DeletionDate <DateTime> - -ResourceId <String> -ServerName <String> -TargetDatabaseName <String> [-Edition <String>] - [-ServiceObjectiveName <String>] [-ElasticPoolName <String>] [-AsJob] [-LicenseType <String>] - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### FromDeletedDatabaseBackupWithVcore -``` -Restore-AzureRmSqlDatabase [-FromDeletedDatabaseBackup] [-PointInTime <DateTime>] -DeletionDate <DateTime> - -ResourceId <String> -ServerName <String> -TargetDatabaseName <String> -Edition <String> [-AsJob] - -ComputeGeneration <String> -VCore <Int32> [-LicenseType <String>] [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### FromGeoBackup -``` -Restore-AzureRmSqlDatabase [-FromGeoBackup] -ResourceId <String> -ServerName <String> - -TargetDatabaseName <String> [-Edition <String>] [-ServiceObjectiveName <String>] [-ElasticPoolName <String>] - [-AsJob] [-LicenseType <String>] [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### FromGeoBackupWithVcore -``` -Restore-AzureRmSqlDatabase [-FromGeoBackup] -ResourceId <String> -ServerName <String> - -TargetDatabaseName <String> -Edition <String> [-AsJob] -ComputeGeneration <String> -VCore <Int32> - [-LicenseType <String>] [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### FromLongTermRetentionBackup -``` -Restore-AzureRmSqlDatabase [-FromLongTermRetentionBackup] -ResourceId <String> -ServerName <String> - -TargetDatabaseName <String> [-Edition <String>] [-ServiceObjectiveName <String>] [-ElasticPoolName <String>] - [-AsJob] [-LicenseType <String>] [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### FromLongTermRetentionBackupWithVcore -``` -Restore-AzureRmSqlDatabase [-FromLongTermRetentionBackup] -ResourceId <String> -ServerName <String> - -TargetDatabaseName <String> -Edition <String> [-AsJob] -ComputeGeneration <String> -VCore <Int32> - [-LicenseType <String>] [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Restore-AzureRmSqlDatabase** cmdlet restores a SQL database from a geo-redundant backup, a backup of a deleted database, a long term retention backup, or a point in time in a live database. -The restored database is created as a new database. -You can create an elastic SQL database by setting the *ElasticPoolName* parameter to an existing elastic pool. - -## EXAMPLES - -### Example 1: Restore a database from a point in time -``` -PS C:\>$Database = Get-AzureRmSqlDatabase -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -PS C:\> Restore-AzureRmSqlDatabase -FromPointInTimeBackup -PointInTime UTCDateTime -ResourceGroupName $Database.ResourceGroupName -ServerName $Database.ServerName -TargetDatabaseName "RestoredDatabase" -ResourceId $Database.ResourceID -Edition "Standard" -ServiceObjectiveName "S2" -``` - -The first command gets the SQL database named Database01, and then stores it in the $Database variable. -The second command restores the database in $Database from the specified point-in-time backup to the database named RestoredDatabase. - -### Example 2: Restore a database from a point in time to an elastic pool -``` -PS C:\>$Database = Get-AzureRmSqlDatabase -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -PS C:\> Restore-AzureRmSqlDatabase -FromPointInTimeBackup -PointInTime UTCDateTime -ResourceGroupName $Database.ResourceGroupName -ServerName $Database.ServerName -TargetDatabaseName "RestoredDatabase" -ResourceId $Database.ResourceID -ElasticPoolName "ElasticPool01" -``` - -The first command gets the SQL database named Database01, and then stores it in the $Database variable. -The second command restores the database in $Database from the specified point-in-time backup to the SQL database named RestoredDatabase in the elastic pool named elasticpool01. - -### Example 3: Restore a deleted database -``` -PS C:\>$DeletedDatabase = Get-AzureRmSqlDeletedDatabaseBackup -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -PS C:\> Restore-AzureRmSqlDatabase -FromDeletedDatabaseBackup -DeletionDate $DeletedDatabase.DeletionDate -ResourceGroupName $DeletedDatabase.ResourceGroupName -ServerName $DeletedDatabase.ServerName -TargetDatabaseName "RestoredDatabase" -ResourceId $DeletedDatabase.ResourceID -Edition "Standard" -ServiceObjectiveName "S2" -PointInTime UTCDateTime -``` - -The first command gets the deleted database backup that you want to restore by using [Get-AzureRmSqlDeletedDatabaseBackup](./Get-AzureRMSqlDeletedDatabaseBackup.md). -The second command starts the restore from the deleted database backup by using the [Restore-AzureRmSqlDatabase](./Restore-AzureRmSqlDatabase.md) cmdlet. If the -PointInTime parameter is not specified, the database will be restored to the deletion time. - -### Example 4: Restore a deleted database into an elastic pool -``` -PS C:\>$DeletedDatabase = Get-AzureRmSqlDeletedDatabaseBackup -ResourceGroupName $resourceGroupName -ServerName $sqlServerName -DatabaseName 'DatabaseToRestore' -PS C:\> Restore-AzureRmSqlDatabase -FromDeletedDatabaseBackup -DeletionDate $DeletedDatabase.DeletionDate -ResourceGroupName $DeletedDatabase.ResourceGroupName -ServerName $DeletedDatabase.ServerName -TargetDatabaseName "RestoredDatabase" -ResourceId $DeletedDatabase.ResourceID -ElasticPoolName "elasticpool01" -PointInTime UTCDateTime -``` - -The first command gets the deleted database backup that you want to restore by using [Get-AzureRmSqlDeletedDatabaseBackup](./Get-AzureRMSqlDeletedDatabaseBackup.md). -The second command starts the restore from the deleted database backup by using [Restore-AzureRmSqlDatabase](./Restore-AzureRmSqlDatabase.md). If the -PointInTime parameter is not specified, the database will be restored to the deletion time. - -### Example 5: Geo-Restore a database -``` -PS C:\>$GeoBackup = Get-AzureRmSqlDatabaseGeoBackup -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -PS C:\> Restore-AzureRmSqlDatabase -FromGeoBackup -ResourceGroupName "TargetResourceGroup" -ServerName "TargetServer" -TargetDatabaseName "RestoredDatabase" -ResourceId $GeoBackup.ResourceID -Edition "Standard" -RequestedServiceObjectiveName "S2" -``` - -The first command gets the geo-redundant backup for the database named Database01, and then stores it in the $GeoBackup variable. -The second command restores the backup in $GeoBackup to the SQL database named RestoredDatabase. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputeGeneration -The compute generation to assign to the restored database - -```yaml -Type: System.String -Parameter Sets: FromPointInTimeBackupWithVcore, FromDeletedDatabaseBackupWithVcore, FromGeoBackupWithVcore, FromLongTermRetentionBackupWithVcore -Aliases: Family - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeletionDate -Specifies the deletion date as a **DateTime** object. -To get a **DateTime** object, use the Get-Date cmdlet. - -```yaml -Type: System.DateTime -Parameter Sets: FromDeletedDatabaseBackup, FromDeletedDatabaseBackupWithVcore -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Edition -Specifies the edition of the SQL database. -The acceptable values for this parameter are: -- None -- Basic -- Standard -- Premium -- DataWarehouse -- Free -- Stretch -- GeneralPurpose -- BusinessCritical - -```yaml -Type: System.String -Parameter Sets: FromPointInTimeBackup, FromDeletedDatabaseBackup, FromGeoBackup, FromLongTermRetentionBackup -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: FromPointInTimeBackupWithVcore, FromDeletedDatabaseBackupWithVcore, FromGeoBackupWithVcore, FromLongTermRetentionBackupWithVcore -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ElasticPoolName -Specifies the name of the elastic pool in which to put the SQL database. - -```yaml -Type: System.String -Parameter Sets: FromPointInTimeBackup, FromDeletedDatabaseBackup, FromGeoBackup, FromLongTermRetentionBackup -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FromDeletedDatabaseBackup -Indicates that this cmdlet restores a database from a backup of a deleted SQL database. -You can use the Get-AzureRMSqlDeletedDatabaseBackup cmdlet to get the backup of a deleted SQL database. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: FromDeletedDatabaseBackup, FromDeletedDatabaseBackupWithVcore -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FromGeoBackup -Indicates that this cmdlet restores a SQL database from a geo-redundant backup. -You can use the Get-AzureRMSqlDatabaseGeoBackup cmdlet to get a geo-redundant backup. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: FromGeoBackup, FromGeoBackupWithVcore -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FromLongTermRetentionBackup -Indicates that this cmdlet restores a SQL database from a long term retention backup. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: FromLongTermRetentionBackup, FromLongTermRetentionBackupWithVcore -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FromPointInTimeBackup -Indicates that this cmdlet restores a SQL database from a point-in-time backup. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: FromPointInTimeBackup, FromPointInTimeBackupWithVcore -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LicenseType -The license type for the Azure Sql database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PointInTime -Specifies the point in time, as a **DateTime** object, that you want to restore your SQL database to. -To get a **DateTime** object, use **Get-Date** cmdlet. -Use this parameter together with the *FromPointInTimeBackup* parameter. - -```yaml -Type: System.DateTime -Parameter Sets: FromPointInTimeBackup, FromPointInTimeBackupWithVcore -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.DateTime -Parameter Sets: FromDeletedDatabaseBackup, FromDeletedDatabaseBackupWithVcore -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which this cmdlet assigns the SQL database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Specifies the ID of the resource to restore. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the SQL database server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceObjectiveName -Specifies the name of the service objective. - -```yaml -Type: System.String -Parameter Sets: FromPointInTimeBackup, FromDeletedDatabaseBackup, FromGeoBackup, FromLongTermRetentionBackup -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetDatabaseName -Specifies the name of the database to restore to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VCore -The Vcore numbers of the restored Azure Sql Database. - -```yaml -Type: System.Int32 -Parameter Sets: FromPointInTimeBackupWithVcore, FromDeletedDatabaseBackupWithVcore, FromGeoBackupWithVcore, FromLongTermRetentionBackupWithVcore -Aliases: Capacity - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.DateTime - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel - -## NOTES - -## RELATED LINKS - -[Recover an Azure SQL Database from an outage](https://go.microsoft.com/fwlink/?LinkId=746882) - -[Recover an Azure SQL Database from a user error](https://go.microsoft.com/fwlink/?LinkId=746944) - -[Get-AzureRmSqlDatabase](./Get-AzureRmSqlDatabase.md) - -[Get-AzureRMSqlDatabaseGeoBackup](./Get-AzureRMSqlDatabaseGeoBackup.md) - -[Get-AzureRMSqlDeletedDatabaseBackup](./Get-AzureRMSqlDeletedDatabaseBackup.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - diff --git a/azurermps-6.13.0/AzureRM.Sql/Restore-AzureRmSqlInstanceDatabase.md b/azurermps-6.13.0/AzureRM.Sql/Restore-AzureRmSqlInstanceDatabase.md deleted file mode 100644 index 5f1d6412bd..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Restore-AzureRmSqlInstanceDatabase.md +++ /dev/null @@ -1,312 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/restore-azurermsqlinstancedatabase -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Restore-AzureRmSqlInstanceDatabase.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Restore-AzureRmSqlInstanceDatabase.md ---- - -# Restore-AzureRmSqlInstanceDatabase - -## SYNOPSIS -Restores an Azure SQL Managed Instance database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### PointInTimeSameInstanceRestoreInstanceDatabaseFromInputParameters (Default) -``` -Restore-AzureRmSqlInstanceDatabase [-FromPointInTimeBackup] [-Name] <String> [-InstanceName] <String> - [-ResourceGroupName] <String> -PointInTime <DateTime> -TargetInstanceDatabaseName <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### PointInTimeSameInstanceRestoreInstanceDatabaseFromAzureSqlManagedDatabaseModelInstanceDefinition -``` -Restore-AzureRmSqlInstanceDatabase [-FromPointInTimeBackup] [-InputObject] <AzureSqlManagedDatabaseModel> - -PointInTime <DateTime> -TargetInstanceDatabaseName <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### PointInTimeSameInstanceRestoreInstanceDatabaseFromAzureResourceId -``` -Restore-AzureRmSqlInstanceDatabase [-FromPointInTimeBackup] [-ResourceId] <String> -PointInTime <DateTime> - -TargetInstanceDatabaseName <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### PointInTimeCrossInstanceRestoreInstanceDatabaseFromInputParameters -``` -Restore-AzureRmSqlInstanceDatabase [-FromPointInTimeBackup] [-Name] <String> [-InstanceName] <String> - [-ResourceGroupName] <String> -PointInTime <DateTime> -TargetInstanceDatabaseName <String> - -TargetInstanceName <String> -TargetResourceGroupName <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### PointInTimeCrossInstanceRestoreInstanceDatabaseFromAzureSqlManagedDatabaseModelInstanceDefinition -``` -Restore-AzureRmSqlInstanceDatabase [-FromPointInTimeBackup] [-InputObject] <AzureSqlManagedDatabaseModel> - -PointInTime <DateTime> -TargetInstanceDatabaseName <String> -TargetInstanceName <String> - -TargetResourceGroupName <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### PointInTimeCrossInstanceRestoreInstanceDatabaseFromAzureResourceId -``` -Restore-AzureRmSqlInstanceDatabase [-FromPointInTimeBackup] [-ResourceId] <String> -PointInTime <DateTime> - -TargetInstanceDatabaseName <String> -TargetInstanceName <String> -TargetResourceGroupName <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Restore-AzureRmSqlInstanceDatabase** cmdlet restores an instance database from a point in time in a live database. -The restored database is created as a new instance database. - -## EXAMPLES - -### Example 1: Restore a instance database from a point in time -``` -PS C:\> Restore-AzureRmSqlinstanceDatabase -Name "Database01" -InstanceName "managedInstance1" -ResourceGroupName "ResourceGroup01" -PointInTime UTCDateTime -TargetInstanceDatabaseName "Database01_restored" -``` - -The command restores the instance database Database01 from the specified point-in-time backup to the instance database named Database01_restored. - -### Example 2: Restore a instance database from a point in time to another instance on different resource group -``` -PS C:\> Restore-AzureRmSqlInstanceDatabase -Name "Database01" -InstanceName "managedInstance1" -ResourceGroupName "ResourceGroup01" -PointInTime UTCDateTime -TargetInstanceDatabaseName "Database01_restored" -TargetInstanceName "managedInstance1" -TargetResourceGroupName "ResourceGroup02" -``` - -The command restores the instance database Database01 on instance managedInstance1 on resource group ResourceGroup01 from the specified point-in-time backup to the instance database named Database01_restored on instance managedInstance2 on resource group ResourceGroup02. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FromPointInTimeBackup -Restore from a point-in-time backup. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The Instance Database object to restore - -```yaml -Type: AzureSqlManagedDatabaseModel -Parameter Sets: PointInTimeSameInstanceRestoreInstanceDatabaseFromAzureSqlManagedDatabaseModelInstanceDefinition, PointInTimeCrossInstanceRestoreInstanceDatabaseFromAzureSqlManagedDatabaseModelInstanceDefinition -Aliases: InstanceDatabase - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InstanceName -The instance name. - -```yaml -Type: String -Parameter Sets: PointInTimeSameInstanceRestoreInstanceDatabaseFromInputParameters, PointInTimeCrossInstanceRestoreInstanceDatabaseFromInputParameters -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The instance database name to restore. - -```yaml -Type: String -Parameter Sets: PointInTimeSameInstanceRestoreInstanceDatabaseFromInputParameters, PointInTimeCrossInstanceRestoreInstanceDatabaseFromInputParameters -Aliases: InstanceDatabaseName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PointInTime -The point in time to restore the database to. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: String -Parameter Sets: PointInTimeSameInstanceRestoreInstanceDatabaseFromInputParameters, PointInTimeCrossInstanceRestoreInstanceDatabaseFromInputParameters -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The resource id of Instance Database object to restore - -```yaml -Type: String -Parameter Sets: PointInTimeSameInstanceRestoreInstanceDatabaseFromAzureResourceId, PointInTimeCrossInstanceRestoreInstanceDatabaseFromAzureResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetInstanceDatabaseName -The name of the target instance database to restore to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetInstanceName -The name of the target instance to restore to. -If not specified, the target instance is the same as the source instance. - -```yaml -Type: String -Parameter Sets: PointInTimeCrossInstanceRestoreInstanceDatabaseFromInputParameters, PointInTimeCrossInstanceRestoreInstanceDatabaseFromAzureSqlManagedDatabaseModelInstanceDefinition, PointInTimeCrossInstanceRestoreInstanceDatabaseFromAzureResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetResourceGroupName -The name of the target resource group to restore to. -If not specified, the target resource group is the same as the source resource group. - -```yaml -Type: String -Parameter Sets: PointInTimeCrossInstanceRestoreInstanceDatabaseFromInputParameters, PointInTimeCrossInstanceRestoreInstanceDatabaseFromAzureSqlManagedDatabaseModelInstanceDefinition, PointInTimeCrossInstanceRestoreInstanceDatabaseFromAzureResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel -System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Resume-AzureRmSqlDatabase.md b/azurermps-6.13.0/AzureRM.Sql/Resume-AzureRmSqlDatabase.md deleted file mode 100644 index 64f2482e2e..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Resume-AzureRmSqlDatabase.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 84CF049A-D293-4FEB-8608-179146EADE41 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/resume-azurermsqldatabase -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Resume-AzureRmSqlDatabase.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Resume-AzureRmSqlDatabase.md ---- - -# Resume-AzureRmSqlDatabase - -## SYNOPSIS -Resumes a SQL Data Warehouse database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Resume-AzureRmSqlDatabase [-ServerName] <String> -DatabaseName <String> [-AsJob] [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Resume-AzureRmSqlDatabase** cmdlet resumes an Azure SQL Data Warehouse database. - -## EXAMPLES - -### Example 1: Resumes an Azure SQL Data Warehouse database -``` -PS C:\>Resume-AzureRmSqlDatabase -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -``` - -This command resumes a suspended Azure SQL Data Warehouse database. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the database that this cmdlet resumes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the database is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server that hosts the database that this cmdlet resumes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel - -## NOTES -* The **Resume-AzureRmSqlDatabase** cmdlet works only on Azure SQL Data Warehouse databases. This operation is not supported on Azure SQL Database Basic, Standard and Premium editions. - -## RELATED LINKS - -[Get-AzureRmSqlDatabase](./Get-AzureRmSqlDatabase.md) - -[New-AzureRmSqlDatabase](./New-AzureRmSqlDatabase.md) - -[Remove-AzureRmSqlDatabase](./Remove-AzureRmSqlDatabase.md) - -[Set-AzureRmSqlDatabase](./Set-AzureRmSqlDatabase.md) - -[Suspend-AzureRmSqlDatabase](./Suspend-AzureRmSqlDatabase.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabase.md b/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabase.md deleted file mode 100644 index c645012571..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabase.md +++ /dev/null @@ -1,436 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 2E4F5C27-C50F-4133-B193-BC477BCD6778 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/set-azurermsqldatabase -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabase.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabase.md ---- - -# Set-AzureRmSqlDatabase - -## SYNOPSIS -Sets properties for a database, or moves an existing database into an elastic pool. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Update (Default) -``` -Set-AzureRmSqlDatabase [-DatabaseName] <String> [-MaxSizeBytes <Int64>] [-Edition <String>] - [-RequestedServiceObjectiveName <String>] [-ElasticPoolName <String>] [-ReadScale <DatabaseReadScale>] - [-Tags <Hashtable>] [-ZoneRedundant] [-AsJob] [-LicenseType <String>] [-ServerName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### VcoreBasedDatabase -``` -Set-AzureRmSqlDatabase [-DatabaseName] <String> [-MaxSizeBytes <Int64>] [-Edition <String>] - [-ReadScale <DatabaseReadScale>] [-Tags <Hashtable>] [-ZoneRedundant] [-AsJob] [-VCore <Int32>] - [-ComputeGeneration <String>] [-LicenseType <String>] [-ServerName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Rename -``` -Set-AzureRmSqlDatabase [-DatabaseName] <String> -NewName <String> [-AsJob] [-ServerName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSqlDatabase** cmdlet sets properties for a database in Azure SQL Database. This cmdlet can modify the service tier (*Edition*), performance level (*RequestedServiceObjectiveName*), and storage max size (*MaxSizeBytes*) for the database. In addition, you can specify the *ElasticPoolName* parameter to move a database into an elastic pool. If a database is already in an elastic pool, you can use the *RequestedServiceObjectiveName* parameter to move the database out of an elastic pool and into a performance level for single databases. - -## EXAMPLES - -### Example 1: Update a database to a Standard S2 database -``` -PS C:\>Set-AzureRmSqlDatabase -ResourceGroupName "ResourceGroup01" -DatabaseName "Database01" -ServerName "Server01" -Edition "Standard" -RequestedServiceObjectiveName "S2" -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -Location : Central US -DatabaseId : a1e6bd1a-735a-4d48-8b98-afead5ef1218 -Edition : Standard -CollationName : SQL_Latin1_General_CP1_CI_AS -CatalogCollation : -MaxSizeBytes : 268435456000 -Status : Online -CreationDate : 7/3/2015 7:33:37 AM -CurrentServiceObjectiveId : 455330e1-00cd-488b-b5fa-177c226f28b7 -CurrentServiceObjectiveName : S2 -RequestedServiceObjectiveId : 455330e1-00cd-488b-b5fa-177c226f28b7 -RequestedServiceObjectiveName : -ElasticPoolName : -EarliestRestoreDate : -Tags : -``` - -This command updates a database named Database01 to a Standard S2 database on a server named Server01. - -### Example 2: Add a database to an elastic pool -``` -PS C:\>Set-AzureRmSqlDatabase -ResourceGroupName "ResourceGroup01" -DatabaseName "Database01" -ServerName "Server01" -ElasticPoolName "ElasticPool01" -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -Location : Central US -DatabaseId : a1e6bd1a-735a-4d48-8b98-afead5ef1218 -Edition : Standard -CollationName : SQL_Latin1_General_CP1_CI_AS -CatalogCollation : -MaxSizeBytes : 268435456000 -Status : Online -CreationDate : 7/3/2015 7:33:37 AM -CurrentServiceObjectiveId : d1737d22-a8ea-4de7-9bd0-33395d2a7419 -CurrentServiceObjectiveName : ElasticPool -RequestedServiceObjectiveId : d1737d22-a8ea-4de7-9bd0-33395d2a7419 -RequestedServiceObjectiveName : -ElasticPoolName : elasticpool01 -EarliestRestoreDate : -Tags : -``` - -This command adds a database named Database01 to the elastic pool named ElasticPool01 hosted on the server named Server01. - -### Example 3: Modify the storage max size of a database -``` -PS C:\>Set-AzureRmSqlDatabase -ResourceGroupName "ResourceGroup01" -DatabaseName "Database01" -ServerName "Server01" -MaxSizeBytes 1099511627776 -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -Location : Central US -DatabaseId : a1e6bd1a-735a-4d48-8b98-afead5ef1218 -Edition : Standard -CollationName : SQL_Latin1_General_CP1_CI_AS -CatalogCollation : -MaxSizeBytes : 1099511627776 -Status : Online -CreationDate : 8/24/2017 9:00:37 AM -CurrentServiceObjectiveId : 789681b8-ca10-4eb0-bdf2-e0b050601b40 -CurrentServiceObjectiveName : S3 -RequestedServiceObjectiveId : 789681b8-ca10-4eb0-bdf2-e0b050601b40 -RequestedServiceObjectiveName : -ElasticPoolName : -EarliestRestoreDate : -Tags : -``` - -This command updates a database named Database01 to set its max size to 1 TB. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputeGeneration -The compute generation to assign. - -```yaml -Type: System.String -Parameter Sets: VcoreBasedDatabase -Aliases: Family - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Edition -Specifies the edition for the database. -The acceptable values for this parameter are: -- None -- Basic -- Standard -- Premium -- DataWarehouse -- Free -- Stretch -- GeneralPurpose -- BusinessCritical - -```yaml -Type: System.String -Parameter Sets: Update, VcoreBasedDatabase -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ElasticPoolName -Specifies name of the elastic pool in which to move the database. - -```yaml -Type: System.String -Parameter Sets: Update -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LicenseType -The license type for the Azure Sql database. - -```yaml -Type: System.String -Parameter Sets: Update, VcoreBasedDatabase -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxSizeBytes -The maximum size of the Azure SQL Database in bytes. - -```yaml -Type: System.Int64 -Parameter Sets: Update, VcoreBasedDatabase -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewName -The new name to rename the database to. - -```yaml -Type: System.String -Parameter Sets: Rename -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadScale -The read scale option to assign to the Azure SQL Database.(Enabled/Disabled) - -```yaml -Type: Microsoft.Azure.Commands.Sql.Database.Model.DatabaseReadScale -Parameter Sets: Update, VcoreBasedDatabase -Aliases: -Accepted values: Disabled, Enabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestedServiceObjectiveName -Specifies the name of the service objective to assign to the database. For information about -service objectives, see [Azure SQL Database Service Tiers and Performance Levels](https://msdn.microsoft.com/en-us/library/azure/dn741336.aspx) -in the Microsoft Developer Network Library. - -```yaml -Type: System.String -Parameter Sets: Update -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of resource group to which the server is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server that hosts the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tags -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: Update, VcoreBasedDatabase -Aliases: Tag - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VCore -The Vcore number for the Azure Sql database - -```yaml -Type: System.Int32 -Parameter Sets: VcoreBasedDatabase -Aliases: Capacity - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZoneRedundant -The zone redundancy to associate with the Azure Sql Database - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: Update, VcoreBasedDatabase -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlDatabase](./Get-AzureRmSqlDatabase.md) - -[New-AzureRmSqlDatabase](./New-AzureRmSqlDatabase.md) - -[Remove-AzureRmSqlDatabase](./Remove-AzureRmSqlDatabase.md) - -[Resume-AzureRmSqlDatabase](./Resume-AzureRmSqlDatabase.md) - -[Suspend-AzureRmSqlDatabase](./Suspend-AzureRmSqlDatabase.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseAdvisorAutoExecuteStatus.md b/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseAdvisorAutoExecuteStatus.md deleted file mode 100644 index 43fa438a38..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseAdvisorAutoExecuteStatus.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 50E09DF7-F5B5-4668-9520-73D562E91800 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/set-azurermsqldatabaseadvisorautoexecutestatus -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseAdvisorAutoExecuteStatus.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseAdvisorAutoExecuteStatus.md ---- - -# Set-AzureRmSqlDatabaseAdvisorAutoExecuteStatus - -## SYNOPSIS -Modifies auto execute status of an Azure SQL Database Advisor. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSqlDatabaseAdvisorAutoExecuteStatus -AdvisorName <String> - -AutoExecuteStatus <AdvisorAutoExecuteStatus> -ServerName <String> -DatabaseName <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSqlDatabaseAdvisorAutoExecuteStatus** cmdlet modifies the auto execute property for an Azure SQL Database Advisor. -Currently, this cmdlet supports the values Enabled, Disabled, and Default. - -## EXAMPLES - -### Example 1: Enable auto execute for an advisor -``` -PS C:\>Set-AzureRmSqlDatabaseAdvisorAutoExecuteStatus -ResourceGroupName "ContosoRunnersProd" -ServerName "runner-australia-east" -DatabaseName "ContosoRunner" -AdvisorName "CreateIndex" -AutoExecuteStatus Enabled -DatabaseName : ContosoRunner -ResourceGroupName : ContosoRunnersProd -ServerName : runner-australia-east -AdvisorName : CreateIndex -AdvisorStatus : GA -AutoExecuteStatus : Enabled -AutoExecuteStatusInheritedFrom : Database -LastChecked : 8/1/2016 2:36:47 PM -RecommendationsStatus : Ok -RecommendedActions : {} -``` - -This command changes the auto execute status of an advisor named CreateIndex to Enabled. - -## PARAMETERS - -### -AdvisorName -Specifies the name of the advisor for which this cmdlet modifies the status. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AutoExecuteStatus -Specifies the value for the status. -The acceptable values for this parameter are: -- Enabled -- Disabled -- Default - -```yaml -Type: Microsoft.Azure.Commands.Sql.Advisor.Cmdlet.AdvisorAutoExecuteStatus -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled, Default - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the database for which this cmdlet modifies status. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the server that contains this database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server for the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Sql.Advisor.Cmdlet.AdvisorAutoExecuteStatus - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Advisor.Model.AzureSqlDatabaseAdvisorModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlDatabaseAdvisor](./Get-AzureRmSqlDatabaseAdvisor.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - diff --git a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseAuditing.md b/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseAuditing.md deleted file mode 100644 index c33892a88f..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseAuditing.md +++ /dev/null @@ -1,349 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: F7EF35E3-BC53-43D9-A71E-0B4316260A08 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/set-azurermsqldatabaseauditing -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseAuditing.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseAuditing.md ---- - -# Set-AzureRmSqlDatabaseAuditing - -## SYNOPSIS -Changes the auditing settings for an Azure SQL database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameterSet (Default) -``` -Set-AzureRmSqlDatabaseAuditing -State <String> [-PassThru] [-AuditActionGroup <AuditActionGroups[]>] - [-AuditAction <String[]>] [-StorageAccountName <String>] [-StorageKeyType <String>] - [-RetentionInDays <UInt32>] [-PredicateExpression <String>] [-ServerName] <String> [-DatabaseName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### StorageAccountSubscriptionIdSet -``` -Set-AzureRmSqlDatabaseAuditing -State <String> [-PassThru] [-AuditActionGroup <AuditActionGroups[]>] - [-AuditAction <String[]>] -StorageAccountName <String> [-StorageAccountSubscriptionId <Guid>] - [-StorageKeyType <String>] [-RetentionInDays <UInt32>] [-PredicateExpression <String>] [-ServerName] <String> - [-DatabaseName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSqlDatabaseAuditing** cmdlet changes the auditing settings of an Azure SQL database. -To use the cmdlet, use the *ResourceGroupName*, *ServerName*, and *DatabaseName* parameters to identify the database. -Specify the *StorageAccountName* parameter to specify the storage account for the audit logs and the *StorageKeyType* parameter to define the storage keys. -Use the *State* parameter to enable/disable the policy. -You can also define retention for the audit logs by setting the value of the *RetentionInDays* parameter to define the period for the audit logs. -After the cmdlet runs successfully, auditing of the database is enabled. -If the cmdlet succeeds and you use the *PassThru* parameter, it returns an object describing the current blob auditing policy in addition to the database identifiers. -Database identifiers include, but are not limited to, **ResourceGroupName**, **ServerName**, and **DatabaseName**. - -## EXAMPLES - -### Example 1: Enable the auditing policy of an Azure SQL database -``` -PS C:\>Set-AzureRmSqlDatabaseAuditing -State Enabled -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -StorageAccountName "Storage22" -DatabaseName "Database01" -``` - -### Example 2: Disable the blob auditing policy of an Azure SQL database -``` -PS C:\>Set-AzureRmSqlDatabaseAuditing -State Disabled -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -``` - -### Example 3: Enable the auditing policy of an Azure SQL database using a storage account from a different subscription -``` -PS C:\>Set-AzureRmSqlDatabaseAuditing -State Enabled -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -StorageAccountName "Storage22" -StorageAccountSubscriptionId "7fe3301d-31d3-4668-af5e-211a890ba6e3" -``` - -### Example 4: Enable the extended auditing policy of an Azure SQL database -``` -PS C:\>Set-AzureRmSqlDatabaseAuditing -State Enabled -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -StorageAccountName "Storage22" -DatabaseName "Database01" -PredicateExpression "statement <> 'select 1'" -``` - -### Example 5: Remove the extended auditing policy of an Azure SQL database, and set an auditing policy instead of it. -``` -PS C:\>Set-AzureRmSqlDatabaseAuditing -State Enabled -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -StorageAccountName "Storage22" -DatabaseName "Database01" -PredicateExpression "" -``` - -## PARAMETERS - -### -AuditAction -The set of audit actions. -The supported actions to audit are: -SELECT -UPDATE -INSERT -DELETE -EXECUTE -RECEIVE -REFERENCES -The general form for defining an action to be audited is: -[action] ON [object] BY [principal] -Note that [object] in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::[dbname] and SCHEMA::[schemaname] are used, respectively. -For example: -SELECT on dbo.myTable by public -SELECT on DATABASE::myDatabase by public -SELECT on SCHEMA::mySchema by public -For more information, see https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AuditActionGroup -The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins: -"BATCH_COMPLETED_GROUP", -"SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", -"FAILED_DATABASE_AUTHENTICATION_GROUP" -This above combination is also the set that is configured by default. These groups cover all SQL statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. For more information, see https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups. - -```yaml -Type: Microsoft.Azure.Commands.Sql.Auditing.Model.AuditActionGroups[] -Parameter Sets: (All) -Aliases: -Accepted values: BATCH_STARTED_GROUP, BATCH_COMPLETED_GROUP, APPLICATION_ROLE_CHANGE_PASSWORD_GROUP, BACKUP_RESTORE_GROUP, DATABASE_LOGOUT_GROUP, DATABASE_OBJECT_CHANGE_GROUP, DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP, DATABASE_OBJECT_PERMISSION_CHANGE_GROUP, DATABASE_OPERATION_GROUP, AUDIT_CHANGE_GROUP, DATABASE_PERMISSION_CHANGE_GROUP, DATABASE_PRINCIPAL_CHANGE_GROUP, DATABASE_PRINCIPAL_IMPERSONATION_GROUP, DATABASE_ROLE_MEMBER_CHANGE_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP, SCHEMA_OBJECT_ACCESS_GROUP, SCHEMA_OBJECT_CHANGE_GROUP, SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP, SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, USER_CHANGE_PASSWORD_GROUP - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseName -SQL Database name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PredicateExpression -The statement of the Where Clause used to filter audit logs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RetentionInDays -The number of retention days for the audit logs. - -```yaml -Type: System.Nullable`1[System.UInt32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -SQL Database server name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -The state of the policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountName -The name of the storage account. Wildcard characters are not permitted. -This parameter is not required. -If you do not specify this parameter, the cmdlet uses the storage account that was defined previously as part of the auditing policy. -If this is the first time an auditing policy is defined and you do not specify this parameter, the cmdlet fails. - -```yaml -Type: System.String -Parameter Sets: DefaultParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: StorageAccountSubscriptionIdSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountSubscriptionId -Specifies storage account subscription id - -```yaml -Type: System.Guid -Parameter Sets: StorageAccountSubscriptionIdSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageKeyType -Specifies which of the storage access keys to use. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Primary, Secondary - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseAuditingPolicy.md b/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseAuditingPolicy.md deleted file mode 100644 index 2e0192973d..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseAuditingPolicy.md +++ /dev/null @@ -1,348 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: F7EF35E3-BC53-43D9-A71E-0B4316260A08 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/set-azurermsqldatabaseauditingpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseAuditingPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseAuditingPolicy.md ---- - -# Set-AzureRmSqlDatabaseAuditingPolicy - -## SYNOPSIS -Sets the auditing policy for a database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSqlDatabaseAuditingPolicy [-AuditType <AuditType>] [-PassThru] - [-AuditActionGroup <AuditActionGroups[]>] [-AuditAction <String[]>] [-EventType <String[]>] - [-StorageAccountName <String>] [-StorageKeyType <String>] [-RetentionInDays <UInt32>] - [-TableIdentifier <String>] [-ServerName] <String> [-DatabaseName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSqlDatabaseAuditingPolicy** cmdlet changes the auditing policy of an Azure SQL database. -To use the cmdlet, use the *ResourceGroupName*, *ServerName*, and *DatabaseName* parameters to identify the database. -Specify the *StorageAccountName* parameter to specify the storage account for the audit logs and the *StorageKeyType* parameter to define the storage keys. -You can also define retention for the audit logs table by setting the value of the *RetentionInDays* and *TableIdentifier* parameters to define the period and the seed for the audit log table names. -Specify the *EventType* parameter to define which event types to audit. -After the cmdlet runs successfully, auditing of the database is enabled. -For Table Auditing, if the database used the policy of its server for auditing before you ran this cmdlet, auditing stops using that policy. For Blob Auditing, if the database used the policy of its server for auditing before you ran this cmdlet, both auditing policies will exist side-by-side. -If the cmdlet succeeds and you use the *PassThru* parameter, it returns an object describing the current auditing policy in addition to the database identifiers. -Database identifiers include, but are not limited to, **ResourceGroupName**, **ServerName**, and **DatabaseName**. -This cmdlet is also supported by the SQL Server Stretch Database service on Azure. - -## EXAMPLES - -### Example 1: Set the auditing policy of a database to use Table auditing -``` -PS C:\>Set-AzureRmSqlDatabaseAuditingPolicy -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -AuditType Table -StorageAccountName "Storage31" -``` - -This command sets the auditing policy of database named Database01 located on Server01 to use the storage account named Storage31. - -### Example 2: Set the storage account key of an existing auditing policy of a database -``` -PS C:\>Set-AzureRmSqlDatabaseAuditingPolicy -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -StorageAccountKey Secondary -``` - -This command sets the auditing policy of database named Database01 located on Server01 to keep using the same storage account name but to now use the secondary key. - -### Example 3: Set the auditing policy of a database to use a specific event type -``` -PS C:\>Set-AzureRmSqlDatabaseAuditingPolicy -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -EventType Login_Failure -``` - -### Example 4: Set the auditing policy of a database to use Blob auditing -``` -PS C:\>Set-AzureRmSqlDatabaseAuditingPolicy -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -AuditType Blob -StorageAccountName "Storage31" -AuditActionGroup "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", "FAILED_DATABASE_AUTHENTICATION_GROUP" -AuditAction "UPDATE ON database::[Database01] BY [public]" -RetentionInDays 8 -``` - -This command sets the auditing policy of database named Database01 located on Server01. -The policy logs the Login_Failure event type. -The command does not change the storage settings. - -## PARAMETERS - -### -AuditAction -Specify one or more audit actions. -This parameter is only applicable to Blob auditing. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AuditActionGroup -Specify one or more audit action groups. -This parameter is only applicable to Blob auditing. - -```yaml -Type: Microsoft.Azure.Commands.Sql.Auditing.Model.AuditActionGroups[] -Parameter Sets: (All) -Aliases: -Accepted values: BATCH_STARTED_GROUP, BATCH_COMPLETED_GROUP, APPLICATION_ROLE_CHANGE_PASSWORD_GROUP, BACKUP_RESTORE_GROUP, DATABASE_LOGOUT_GROUP, DATABASE_OBJECT_CHANGE_GROUP, DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP, DATABASE_OBJECT_PERMISSION_CHANGE_GROUP, DATABASE_OPERATION_GROUP, AUDIT_CHANGE_GROUP, DATABASE_PERMISSION_CHANGE_GROUP, DATABASE_PRINCIPAL_CHANGE_GROUP, DATABASE_PRINCIPAL_IMPERSONATION_GROUP, DATABASE_ROLE_MEMBER_CHANGE_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP, SCHEMA_OBJECT_ACCESS_GROUP, SCHEMA_OBJECT_CHANGE_GROUP, SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP, SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, USER_CHANGE_PASSWORD_GROUP - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AuditType -```yaml -Type: Microsoft.Azure.Commands.Sql.Auditing.Model.AuditType -Parameter Sets: (All) -Aliases: -Accepted values: NotSet, Table, Blob - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventType -Specifies the event types to audit. -This parameter is only applicable to Table auditing. -You can specify several event types. -You can specify All to audit all of the event types or None to specify that no events will be audited. -If you specify All or None at the same time, the cmdlet does not run. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: -Accepted values: PlainSQL_Success, PlainSQL_Failure, ParameterizedSQL_Success, ParameterizedSQL_Failure, StoredProcedure_Success, StoredProcedure_Failure, Login_Success, Login_Failure, TransactionManagement_Success, TransactionManagement_Failure, All, None - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the database is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RetentionInDays -Specifies the number of retention days for the audit logs table. -A value of zero (0) means that the table is not retained. -The default value is zero. -If you specify a value greater than zero, you must specify a value for the *TableIdentifer* parameter. - -```yaml -Type: System.Nullable`1[System.UInt32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server that hosts the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountName -Specifies the name of the storage account for auditing the database. -Wildcard characters are not permitted. -This parameter is not required. -If you do not specify this parameter, the cmdlet uses the storage account that was defined previously as part of the auditing policy of the database. -If this is the first time a database auditing policy is defined and you do not specify this parameter, the cmdlet fails. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageKeyType -Specifies which of the storage access keys to use. -The acceptable values for this parameter are: -- Primary -- Secondary -The default value is Primary. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Primary, Secondary - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TableIdentifier -Specifies the name of the audit logs table. -Specify this value if you specify a value greater than zero for the *RetentionInDays* parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Sql.Auditing.Model.AuditType - -### Microsoft.Azure.Commands.Sql.Auditing.Model.AuditActionGroups[] - -### System.String[] - -### System.String - -### System.Nullable`1[[System.UInt32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Auditing.Model.AuditingPolicyModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlDatabaseAuditingPolicy](./Get-AzureRmSqlDatabaseAuditingPolicy.md) - -[Remove-AzureRmSqlDatabaseAuditing](./Remove-AzureRmSqlDatabaseAuditing.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy.md b/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy.md deleted file mode 100644 index 26b01ac46b..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy.md +++ /dev/null @@ -1,428 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/set-azurermsqldatabasebackuplongtermretentionpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy.md ---- - -# Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy - -## SYNOPSIS -Sets a server long term retention policy. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### WeeklyRetentionRequired (Default) -``` -Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy -WeeklyRetention <String> [-ServerName] <String> - [-DatabaseName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### Legacy -``` -Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy -State <String> -ResourceId <String> [-ServerName] <String> - [-DatabaseName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### RemovePolicy -``` -Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy [-RemovePolicy] [-ServerName] <String> - [-DatabaseName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### MonthlyRetentionRequired -``` -Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy [-WeeklyRetention <String>] -MonthlyRetention <String> - [-ServerName] <String> [-DatabaseName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### YearlyRetentionRequired -``` -Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy [-WeeklyRetention <String>] [-MonthlyRetention <String>] - -YearlyRetention <String> -WeekOfYear <Int32> [-ServerName] <String> [-DatabaseName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy** cmdlet sets the long term retention policy registered to this database. -The policy is an Azure Backup resource used to define backup storage policy. - -## EXAMPLES - -### Example 1: Set the weekly retention for the current version of long term retention policy -```powershell -PS C:\> Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -WeeklyRetention P2W - - -ResourceGroupName : resourcegroup01 -ServerName : server01 -DatabaseName : database01 -WeeklyRetention : P2W -MonthlyRetention : PT0S -YearlyRetention : PT0S -WeekOfYear : 0 -State : -RecoveryServicesBackupPolicyResourceId : -Location : -``` - -This sets the long term retention policy of database01 to save every weekly full backup for 2 weeks - -### Example 2: Set the monthly retention for the current version of long term retention policy -```powershell -PS C:\> Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -MonthlyRetention P5Y - - -ResourceGroupName : resourcegroup01 -ServerName : server01 -DatabaseName : database01 -WeeklyRetention : PT0S -MonthlyRetention : P5Y -YearlyRetention : PT0S -WeekOfYear : 0 -State : -RecoveryServicesBackupPolicyResourceId : -Location : -``` - -This sets the long term retention policy of database01 to save the first full backup of each month for 5 years - -### Example 3: Set the yearly retention for the current version of long term retention policy -```powershell -PS C:\> Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -YearlyRetention P10Y -WeekOfYear 26 - - -ResourceGroupName : resourcegroup01 -ServerName : server01 -DatabaseName : database01 -WeeklyRetention : PT0S -MonthlyRetention : PT0S -YearlyRetention : P10Y -WeekOfYear : 26 -State : -RecoveryServicesBackupPolicyResourceId : -Location : -``` - -This sets the long term retention policy of database01 to save the full backup taken on the 26th week of the year for 10 years - -### Example 4: Set each retention for the current version of long term retention policy -```powershell -PS C:\> Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -WeeklyRetention 14 -MonthlyRetention P24W -YearlyRetention P10Y -WeekOfYear 26 - - -ResourceGroupName : resourcegroup01 -ServerName : server01 -DatabaseName : database01 -WeeklyRetention : P14D -MonthlyRetention : P24W -YearlyRetention : P10Y -WeekOfYear : 26 -State : -RecoveryServicesBackupPolicyResourceId : -Location : -``` - -This sets the long term retention policy of database01 to save each full backup for 14 days, the first full backup of each month for 24 weeks, and the full backup taken on the 26th week of the year for 10 years - -### Example 4: Remove the long term retention policy -```powershell -PS C:\> Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -RemovePolicy - - -ResourceGroupName : resourcegroup01 -ServerName : server01 -DatabaseName : database01 -WeeklyRetention : PT0S -MonthlyRetention : PT0S -YearlyRetention : PT0S -WeekOfYear : 0 -State : -RecoveryServicesBackupPolicyResourceId : -Location : -``` - -Removes the policy for database01 so it no longer saves any long term retention backups. -This will not affect backups that have already been taken - -### Example 4: Remove the long term retention policy -```powershell -PS C:\> Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -WeeklyRetention P0D - - -ResourceGroupName : resourcegroup01 -ServerName : server01 -DatabaseName : database01 -WeeklyRetention : PT0S -MonthlyRetention : PT0S -YearlyRetention : PT0S -WeekOfYear : 0 -State : -RecoveryServicesBackupPolicyResourceId : -Location : -``` - -This is another way of removing the policy for database01 so it no longer saves any long term retention backups. -This will not affect backups that have already been taken - -## PARAMETERS - -### -DatabaseName -The name of the Azure SQL Database to use. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MonthlyRetention -The Monthly Retention. -If just a number is passed instead of an ISO 8601 string, days will be assumed as the units. -There is a minumum of 7 days and a maximum of 10 years. - -```yaml -Type: System.String -Parameter Sets: MonthlyRetentionRequired -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: YearlyRetentionRequired -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RemovePolicy -If provided, the policy for the database will be removed. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: RemovePolicy -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The Resource ID of the backup long term retention policy. - -```yaml -Type: System.String -Parameter Sets: Legacy -Aliases: Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The name of the Azure SQL Server the database is in. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -The state of the long term retention backup policy, 'Enabled' or 'Disabled' - -```yaml -Type: System.String -Parameter Sets: Legacy -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WeeklyRetention -The Weekly Retention. -If just a number is passed instead of an ISO 8601 string, days will be assumed as the units. -There is a minumum of 7 days and a maximum of 10 years. - -```yaml -Type: System.String -Parameter Sets: WeeklyRetentionRequired -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: MonthlyRetentionRequired, YearlyRetentionRequired -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WeekOfYear -The Week of Year, 1 to 52, to save for the Yearly Retention. - -```yaml -Type: System.Int32 -Parameter Sets: YearlyRetentionRequired -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -YearlyRetention -The Yearly Retention. -If just a number is passed instead of an ISO 8601 string, days will be assumed as the units. -There is a minumum of 7 days and a maximum of 10 years. - -```yaml -Type: System.String -Parameter Sets: YearlyRetentionRequired -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Int32 - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlDatabaseBackupLongTermRetentionPolicyModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlDatabaseBackupLongTermRetentionPolicy](./Get-AzureRmSqlDatabaseBackupLongTermRetentionPolicy.md) - -[Get-AzureRmSqlDatabaseLongTermRetentionBackup](./Get-AzureRmSqlDatabaseLongTermRetentionBackup.md) - -[Remove-AzureRmSqlDatabaseLongTermRetentionBackup](./Remove-AzureRmSqlDatabaseLongTermRetentionBackup.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseDataMaskingPolicy.md b/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseDataMaskingPolicy.md deleted file mode 100644 index a253e7d851..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseDataMaskingPolicy.md +++ /dev/null @@ -1,232 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 1B138185-E836-414F-93CD-7BAE7F474E73 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/set-azurermsqldatabasedatamaskingpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseDataMaskingPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseDataMaskingPolicy.md ---- - -# Set-AzureRmSqlDatabaseDataMaskingPolicy - -## SYNOPSIS -Sets data masking for a database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSqlDatabaseDataMaskingPolicy [-PassThru] [-PrivilegedLogins <String>] [-PrivilegedUsers <String>] - [-DataMaskingState <String>] [-ServerName] <String> [-DatabaseName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSqlDatabaseDataMaskingPolicy** cmdlet sets the data masking policy for an Azure SQL database. -To use this cmdlet, use the *ResourceGroupName*, *ServerName*, and *DatabaseName* parameters to identify the database. -You can set the *DataMaskingState* parameter to specify whether data masking operations are enabled or disabled. -You can also set the *PrivilegedLogins* parameter to specify which users are allowed to see the unmasked data. -If the cmdlet succeeds and the *PassThru* parameter is used, it returns an object describing the current data masking policy in addition to the database identifiers. -Database identifiers include, but are not limited to, **ResourceGroupName**, **ServerName**, and **DatabaseName**. -This cmdlet is also supported by the SQL Server Stretch Database service on Azure. - -## EXAMPLES - -### Example 1: Set the data masking policy for a database -``` -PS C:\>Set-AzureRmSqlDatabaseDataMaskingPolicy -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01 -PrivilegedUsers "public" -DataMaskingState "Enabled" -``` - -This command sets the data masking policy for a database named database01 on the server named server01. - -## PARAMETERS - -### -DatabaseName -Specifies the name of the database where the policy is set. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataMaskingState -Specifies whether data masking operation is enabled or disabled. -The acceptable values for this parameter are: -- Enabled -- Disabled -The default value is Enabled. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivilegedLogins -Specifies which SQL users are excluded from masking. -This parameter is deprecated and will be removed from future releases. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PrivilegedUsers -Specifies a semicolon-separated list of privileged user IDs. -These users are allowed to view the masking data. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the database is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server hosting the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.DataMasking.Model.DatabaseDataMaskingPolicyModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlDatabaseDataMaskingPolicy](./Get-AzureRmSqlDatabaseDataMaskingPolicy.md) - -[Get-AzureRmSqlDatabaseDataMaskingRule](./Get-AzureRmSqlDatabaseDataMaskingRule.md) - -[New-AzureRmSqlDatabaseDataMaskingRule](./New-AzureRmSqlDatabaseDataMaskingRule.md) - -[Remove-AzureRmSqlDatabaseDataMaskingRule](./Remove-AzureRmSqlDatabaseDataMaskingRule.md) - -[Set-AzureRmSqlDatabaseDataMaskingRule](./Set-AzureRmSqlDatabaseDataMaskingRule.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseDataMaskingRule.md b/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseDataMaskingRule.md deleted file mode 100644 index e848751480..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseDataMaskingRule.md +++ /dev/null @@ -1,341 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 48CF206C-AF63-4013-834E-8EC3646D180B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/set-azurermsqldatabasedatamaskingrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseDataMaskingRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseDataMaskingRule.md ---- - -# Set-AzureRmSqlDatabaseDataMaskingRule - -## SYNOPSIS -Sets the properties of a data masking rule for a database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSqlDatabaseDataMaskingRule [-MaskingFunction <String>] [-PrefixSize <UInt32>] - [-ReplacementString <String>] [-SuffixSize <UInt32>] [-NumberFrom <Double>] [-NumberTo <Double>] [-PassThru] - -SchemaName <String> -TableName <String> -ColumnName <String> [-ServerName] <String> [-DatabaseName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSqlDatabaseDataMaskingRule** cmdlet sets a data masking rule for an Azure SQL database. -To use the cmdlet, provide the *ResourceGroupName*, *ServerName*, *DatabaseName*, and *RuleId* parameters to identify the rule. -You can provide any of the parameters of *SchemaName*, *TableName*, and *ColumnName* to retarget the rule. -Specify the *MaskingFunction* parameter to modify how the data is masked. -If you specify a value of Number or Text for *MaskingFunction*, you can specify the *NumberFrom* and *NumberTo* parameters for number masking or the *PrefixSize*, *ReplacementString*, and *SuffixSize* parameters for text masking. -If the command succeeds, and if you specify the *PassThru* parameter, the cmdlet returns an object that describes the data masking rule properties and the rule identifiers. -Rule identifiers include, but are not limited to, **ResourceGroupName**, **ServerName**, **DatabaseName**, and **RuleId**. -This cmdlet is also supported by the SQL Server Stretch Database service on Azure. - -## EXAMPLES - -### Example 1: Change the range of a data masking rule in a database -``` -PS C:\>Set-AzureRmSqlDatabaseDataMaskingRule -ResourceGroupName $params.rgname -ServerName $params.serverName -DatabaseName $params.databaseName -SchemaName "dbo" -TableName "table1" -ColumnName "column1" -MaskingFunction "Default" -``` - -This command modifies a data masking rule that has the ID Rule17. -That rule operates in the database named Database01 on server Server01. -This command changes the boundaries for the interval in which a random number is generated as the masked value. -The new range is between 23 and 42. - -## PARAMETERS - -### -ColumnName -Specifies the name of the column targeted by the masking rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaskingFunction -Specifies the masking function that the rule uses. -The acceptable values for this parameter are: -- Default -- NoMasking -- Text -- Number -- SocialSecurityNumber -- CreditCardNumber -- Email -The default value is Default. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: NoMasking, Default, Text, Number, SocialSecurityNumber, CreditCardNumber, Email - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NumberFrom -Specifies the lower bound number of the interval from which a random value is selected. -Specify this parameter only if you specify a value of Number for the *MaskingFunction* parameter. -The default value is 0. - -```yaml -Type: System.Nullable`1[System.Double] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NumberTo -Specifies the upper bound number of the interval from which a random value is selected. -Specify this parameter only if you specify a value of Number for the *MaskingFunction* parameter. -The default value is 0. - -```yaml -Type: System.Nullable`1[System.Double] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrefixSize -Specifies the number of characters at the start of the text that are not masked. -Specify this parameter only if you specify a value of Text for the *MaskingFunction* parameter. -The default value is 0. - -```yaml -Type: System.Nullable`1[System.UInt32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReplacementString -Specifies the number of characters at the end of the text that are not masked. -Specify this parameter only if you specify a value of Text for the *MaskingFunction* parameter. -The default value is 0. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the database is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SchemaName -Specifies the name of a schema. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server that hosts the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SuffixSize -Specifies the number of characters at the end of the text that are not masked. -Specify this parameter only if you specify a value of Text for the *MaskingFunction* parameter. -The default value is 0. - -```yaml -Type: System.Nullable`1[System.UInt32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TableName -Specifies the name of the database table that contains the masked column. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.UInt32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Nullable`1[[System.Double, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.DataMasking.Model.DatabaseDataMaskingRuleModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlDatabaseDataMaskingRule](./Get-AzureRmSqlDatabaseDataMaskingRule.md) - -[New-AzureRmSqlDatabaseDataMaskingRule](./New-AzureRmSqlDatabaseDataMaskingRule.md) - -[Remove-AzureRmSqlDatabaseDataMaskingRule](./Remove-AzureRmSqlDatabaseDataMaskingRule.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseFailoverGroup.md b/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseFailoverGroup.md deleted file mode 100644 index e4714ffa9b..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseFailoverGroup.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/set-azurermsqldatabasefailovergroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseFailoverGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseFailoverGroup.md ---- - -# Set-AzureRmSqlDatabaseFailoverGroup - -## SYNOPSIS -Modifies the configuration of an Azure SQL Database Failover Group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSqlDatabaseFailoverGroup [-ServerName] <String> [-FailoverGroupName] <String> - [-FailoverPolicy <FailoverPolicy>] [-GracePeriodWithDataLossHours <Int32>] - [-AllowReadOnlyFailoverToPrimary <AllowReadOnlyFailoverToPrimary>] [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -This command modifies the configuration of an Azure SQL Database Failover Group. -The Failover Group's primary server should be used to execute the command. -To control the set of databases in the group, use 'Add-AzureRmSqlDatabaseToFailoverGroup' and 'Remove-AzureRmSqlDatabaseFromFailoverGroup' instead. -During preview of the Failover Groups feature, only values greater than or equal to 1 hour are supported for the '-GracePeriodWithDataLossHours' parameter. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $failoverGroup = Set-AzureRmSqlDatabaseFailoverGroup -ResourceGroupName rg -ServerName primaryserver -FailoverGroupName fg -FailoverPolicy Automatic -GracePeriodWithDataLossHours 1 -``` - -Sets a Failover Group's failover policy to 'Automatic.' - -### Example 2 -``` -PS C:\> $failoverGroup = Get-AzureRmSqlDatabaseFailoverGroup -ResourceGroupName rg -ServerName primaryserver -FailoverGroupName fg | Set-AzureRmSqlDatabaseFailoverGroup -FailoverPolicy Manual -``` - -Sets a Failover Group's failover policy to 'Manual' by piping in the Failover Group. - -## PARAMETERS - -### -AllowReadOnlyFailoverToPrimary -Whether outages on the secondary server should trigger automatic failover of the read-only endpoint. This feature is not yet supported. - -```yaml -Type: Microsoft.Azure.Commands.Sql.FailoverGroup.Model.AllowReadOnlyFailoverToPrimary -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FailoverGroupName -The name of the Azure SQL Database Failover Group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FailoverPolicy -The failover policy of the Azure SQL Database Failover Group. - -```yaml -Type: Microsoft.Azure.Commands.Sql.FailoverGroup.Model.FailoverPolicy -Parameter Sets: (All) -Aliases: -Accepted values: Automatic, Manual - -Required: False -Position: Named -Default value: Automatic -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GracePeriodWithDataLossHours -Interval before automatic failover is initiated if an outage occurs on the primary server. This indicates that Azure SQL Database will not initiate automatic failover before the grace period expires. Please note that failover operation with AllowDataLoss option might cause data loss due to the nature of asynchronous synchronization. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 1 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The name of the primary Azure SQL Database Server of the Failover Group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.FailoverGroup.Model.AzureSqlFailoverGroupModel - -## NOTES - -## RELATED LINKS - -[New-AzureRmSqlDatabaseFailoverGroup](./New-AzureRmSqlDatabaseFailoverGroup.md) - -[Get-AzureRmSqlDatabaseFailoverGroup](./Get-AzureRmSqlDatabaseFailoverGroup.md) - -[Add-AzureRmSqlDatabaseToFailoverGroup](./Add-AzureRmSqlDatabaseToFailoverGroup.md) - -[Remove-AzureRmSqlDatabaseFromFailoverGroup](./Remove-AzureRmSqlDatabaseFromFailoverGroup.md) - -[Switch-AzureRmSqlDatabaseFailoverGroup](./Switch-AzureRmSqlDatabaseFailoverGroup.md) - -[Remove-AzureRmSqlDatabaseFailoverGroup](./Remove-AzureRmSqlDatabaseFailoverGroup.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseGeoBackupPolicy.md b/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseGeoBackupPolicy.md deleted file mode 100644 index 8ad4359d2b..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseGeoBackupPolicy.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 5A2072B4-1533-46A2-9841-5509A44DE695 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/set-azurermsqldatabasegeobackuppolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseGeoBackupPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseGeoBackupPolicy.md ---- - -# Set-AzureRmSqlDatabaseGeoBackupPolicy - -## SYNOPSIS -Sets a database geo backup policy. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSqlDatabaseGeoBackupPolicy -State <GeoBackupPolicyState> [-ServerName] <String> - [-DatabaseName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSqlDatabaseGeoBackupPolicy** cmdlet sets the geo backup policy registered to a database. -This is an Azure Backup resource that is used to define backup storage policy. - -## EXAMPLES - -## PARAMETERS - -### -DatabaseName -Specifies the name of the database for which this cmdlet sets the geo backup policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the server that contains this database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server that hosts the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -Specifies the state of the geo backup policy. -The acceptable values for this parameter are: -- Enabled -- Disabled - -```yaml -Type: Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlDatabaseGeoBackupPolicyModel+GeoBackupPolicyState -Parameter Sets: (All) -Aliases: -Accepted values: Disabled, Enabled - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlDatabaseGeoBackupPolicyModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlDatabaseGeoBackupPolicy](./Get-AzureRmSqlDatabaseGeoBackupPolicy.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - diff --git a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseRecommendedActionState.md b/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseRecommendedActionState.md deleted file mode 100644 index 4cd09d5313..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseRecommendedActionState.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: BDBA3AA3-DCC6-4C83-84C8-EE6D93BFE1D3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/set-azurermsqldatabaserecommendedactionstate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseRecommendedActionState.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseRecommendedActionState.md ---- - -# Set-AzureRmSqlDatabaseRecommendedActionState - -## SYNOPSIS -Updates the state of an Azure SQL Database recommended action. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSqlDatabaseRecommendedActionState -RecommendedActionName <String> -State <RecommendedActionState> - -ServerName <String> -DatabaseName <String> -AdvisorName <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSqlDatabaseRecommendedActionState** cmdlet updates the state of an Azure SQL Database Recommended Action. -This allows a recommended action to be applied, reverted or discarded based on the new state. - -## EXAMPLES - -### Example 1: Apply a recommended action state to pending -``` -PS C:\>Set-AzureRmSqlDatabaseRecommendedActionState -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -DatabaseName "WIRunner" -AdvisorName "CreateIndex" -RecommendedActionName "IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893" -State Pending -DatabaseName : WIRunner - -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : CreateIndex -RecommendedActionName : IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893 -Details : {[indexName, nci_wi_test_table_0.0361551_6C7AE8CC9C87E7FD5893], [indexType, - NONCLUSTERED], [schema, [test_schema]], [table, [test_table_0.0361551]]...} -ErrorDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionErrorInfo -EstimatedImpact : {ActionDuration, SpaceChange} -ExecuteActionDuration : PT1M -ExecuteActionInitiatedBy : User -ExecuteActionInitiatedTime : 4/21/2016 3:24:47 PM -ExecuteActionStartTime : 4/21/2016 3:24:47 PM -ImplementationDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionImplementationInfo -IsArchivedAction : False -IsExecutableAction : True -IsRevertableAction : True -LastRefresh : 4/21/2016 3:24:47 PM -LinkedObjects : {} -ObservedImpact : {CpuUtilization, LogicalReads, LogicalWrites, QueriesWithImprovedPerformance...} -RecommendationReason : -RevertActionDuration : -RevertActionInitiatedBy : -RevertActionInitiatedTime : -RevertActionStartTime : -Score : 2 -State : Microsoft.Azure.Management.Sql.Models.RecommendedActionStateInfo -TimeSeries : {} -ValidSince : 4/21/2016 3:24:47 PM -``` - -This command updates the state of the recommended action named IR_\[test_schema\]_\[test_table_0.0361551\]_6C7AE8CC9C87E7FD5893 that belongs to the database named WIRunner to Pending. - -## PARAMETERS - -### -AdvisorName -Specifies the name of the advisor for which this recommended action belongs to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the database for which this cmdlet sets the recommended action state. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecommendedActionName -Specifies the name of the recommended action for which state is being updated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the server that contains this database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server the database is in. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -Specifies the new value to which this cmdlet updates the recommended action state. -The acceptable values for this parameter are: -- Active -- Pending -- PendingRevert -- RevertCancelled -- Ignored -- Resolved - -```yaml -Type: Microsoft.Azure.Commands.Sql.RecommendedAction.Cmdlet.RecommendedActionState -Parameter Sets: (All) -Aliases: -Accepted values: Active, Pending, PendingRevert, RevertCancelled, Ignored, Resolved - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Sql.RecommendedAction.Cmdlet.RecommendedActionState - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.RecommendedAction.Model.AzureSqlDatabaseRecommendedActionModel - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql, advisor, recommendedaction - -## RELATED LINKS - -[Get-AzureRmSqlServerAdvisor](./Get-AzureRmSqlServerAdvisor.md) - -[Get-AzureRmSqlElasticPoolAdvisor](./Get-AzureRmSqlElasticPoolAdvisor.md) - -[Get-AzureRmSqlServerRecommendedAction](./Get-AzureRmSqlServerRecommendedAction.md) - -[Get-AzureRmSqlElasticPoolRecommendedAction](./Get-AzureRmSqlElasticPoolRecommendedAction.md) - -[Set-AzureRmSqlElasticPoolRecommendedActionState](./Set-AzureRmSqlElasticPoolRecommendedActionState.md) - -[Set-AzureRmSqlElasticPoolAdvisorAutoExecuteStatus](./Set-AzureRmSqlElasticPoolAdvisorAutoExecuteStatus.md) - -[Set-AzureRmSqlElasticPoolRecommendedActionState](./Set-AzureRmSqlElasticPoolRecommendedActionState.md) - -[Set-AzureRmSqlServerRecommendedActionState](./Set-AzureRmSqlServerRecommendedActionState.md) - -[Set-AzureRmSqlElasticPoolAdvisorAutoExecuteStatus](./Set-AzureRmSqlElasticPoolAdvisorAutoExecuteStatus.md) - -[Set-AzureRmSqlServerAdvisorAutoExecuteStatus](./Set-AzureRmSqlServerAdvisorAutoExecuteStatus.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseSecondary.md b/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseSecondary.md deleted file mode 100644 index d8851b6a05..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseSecondary.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: F9703508-DD4D-4D25-A7CA-7E3432B5DCA9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/set-azurermsqldatabasesecondary -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseSecondary.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseSecondary.md ---- - -# Set-AzureRmSqlDatabaseSecondary - -## SYNOPSIS -Switches a secondary database to be primary in order to initiate failover. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NoOptionsSet (Default) -``` -Set-AzureRmSqlDatabaseSecondary [-DatabaseName] <String> -PartnerResourceGroupName <String> [-AsJob] - [-ServerName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ByFailoverParams -``` -Set-AzureRmSqlDatabaseSecondary [-DatabaseName] <String> -PartnerResourceGroupName <String> [-Failover] - [-AllowDataLoss] [-AsJob] [-ServerName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSqlDatabaseSecondary** cmdlet switches a secondary database to be primary in order to initiate failover. -This cmdlet is designed as a general configuration command, but is currently limited to initiating failover. -Specify the *AllowDataLoss* parameter to initiate a force failover during an outage. -You do not have to specify this parameter when you perform a planned operation, such as recovery drill. -In the latter case, the secondary database is synchronized with the primary before it is switched. - -## EXAMPLES - -## PARAMETERS - -### -AllowDataLoss -Indicates that this failover operation permits data loss. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByFailoverParams -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the Azure SQL Database Secondary. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Failover -Indicates that this operation is a failover. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByFailoverParams -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PartnerResourceGroupName -Specifies the name of the resource group to which the partner Azure SQL Database is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the Azure SQL Database Secondary is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the SQL Server that hosts the Azure SQL Database Secondary. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Replication.Model.AzureReplicationLinkModel - -## NOTES - -## RELATED LINKS - -[New-AzureRmSqlDatabaseSecondary](./New-AzureRmSqlDatabaseSecondary.md) - -[Remove-AzureRmSqlDatabaseSecondary](./Remove-AzureRmSqlDatabaseSecondary.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseThreatDetectionPolicy.md b/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseThreatDetectionPolicy.md deleted file mode 100644 index 36db3aaa3b..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseThreatDetectionPolicy.md +++ /dev/null @@ -1,259 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 457FD595-D5E1-45C4-9DB8-C3C6C30A0E94 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/set-azurermsqldatabasethreatdetectionpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseThreatDetectionPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseThreatDetectionPolicy.md ---- - -# Set-AzureRmSqlDatabaseThreatDetectionPolicy - -## SYNOPSIS -Sets a threat detection policy on a database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSqlDatabaseThreatDetectionPolicy [-PassThru] [-NotificationRecipientsEmails <String>] - [-EmailAdmins <Boolean>] [-ExcludedDetectionType <DetectionType[]>] [-StorageAccountName <String>] - [-RetentionInDays <UInt32>] [-ServerName] <String> [-DatabaseName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSqlDatabaseThreatDetectionPolicy** cmdlet sets a threat detection policy on an Azure SQL database. -In order to enable threat detection on a database an auditing policy must be enabled on that database. -To use this cmdlet, specify the *ResourceGroupName*, *ServerName* and *DatabaseName* parameters to identify the database. -This cmdlet is also supported by the SQL Server Stretch Database service on Azure. - -## EXAMPLES - -### Example 1: Set the threat detection policy for a database -``` -PS C:\>Set-AzureRmSqlDatabaseThreatDetectionPolicy -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" -NotificationRecipientsEmails "admin01@contoso.com;secadmin@contoso.com" -EmailAdmins $False -ExcludedDetectionType "Sql_Injection_Vulnerability", "SQL_Injection" -StorageAccountName "mystorageAccount" -``` - -This command sets the threat detection policy for a database named Database01 on the server named Server01. - -## PARAMETERS - -### -DatabaseName -Specifies the name of the database where the policy is set. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAdmins -Specifies whether the threat detection policy contacts administrators by using email. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExcludedDetectionType -Specifies an array of detection types to exclude from the policy. -The acceptable values for this parameter are: -- Sql_Injection -- Sql_Injection_Vulnerability -- Access_Anomaly -- None - -```yaml -Type: Microsoft.Azure.Commands.Sql.ThreatDetection.Model.DetectionType[] -Parameter Sets: (All) -Aliases: -Accepted values: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, None - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NotificationRecipientsEmails -Specifies a semicolon-separated list of email addresses to which the policy sends alerts. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the server is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RetentionInDays -The number of retention days for the audit logs - -```yaml -Type: System.Nullable`1[System.UInt32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountName -Specifies the name of the storage account to be used. Wildcards are not permitted. This parameter is not required. When this parameter is not provided, the cmdlet will use the storage account that was defined previously as part of the threat detection policy of the database. If this is the first time a database threat detection policy is defined and this parameter is not provided, the cmdlet will fail. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### Microsoft.Azure.Commands.Sql.ThreatDetection.Model.DetectionType[] - -### System.Nullable`1[[System.UInt32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ThreatDetection.Model.DatabaseThreatDetectionPolicyModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlDatabaseThreatDetectionPolicy](./Get-AzureRmSqlServerThreatDetectionPolicy.md) - -[Remove-AzureRmSqlDatabaseThreatDetectionPolicy](./Remove-AzureRmSqlDatabaseThreatDetectionPolicy.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseTransparentDataEncryption.md b/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseTransparentDataEncryption.md deleted file mode 100644 index 596be2d8f1..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseTransparentDataEncryption.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 01744DBD-1991-45EF-AA92-FD471F7E7551 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/set-azurermsqldatabasetransparentdataencryption -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseTransparentDataEncryption.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseTransparentDataEncryption.md ---- - -# Set-AzureRmSqlDatabaseTransparentDataEncryption - -## SYNOPSIS -Modifies TDE property for a database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSqlDatabaseTransparentDataEncryption [-State] <TransparentDataEncryptionStateType> - [-ServerName] <String> [-DatabaseName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSqlDatabaseTransparentDataEncryption** cmdlet modifies the Transparent Data Encryption (TDE) property of an Azure SQL database. -For more information, see Transparent Data Encryption with Azure SQL Databasehttps://msdn.microsoft.com/library/dn948096 (https://msdn.microsoft.com/library/dn948096) in the Microsoft Developer Network Library. -This cmdlet is also supported by the SQL Server Stretch Database service on Azure. - -## EXAMPLES - -### Example 1: Enable TDE for a database -``` -PS C:\>Set-AzureRmSqlDatabaseTransparentDataEncryption -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -State Enabled -ResourceGroupName ServerName DatabaseName State ------------------ ---------- ------------ ----- -ResourceGroup01 Server01 Database01 Enabled -``` - -This command enables TDE for the database named Database01 on the server named Server01. - -## PARAMETERS - -### -DatabaseName -Specifies the name of the database that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the database is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server that hosts the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -Specifies the value of the TDE property. -The acceptable values for this parameter are: -- Enabled -- Disabled - -```yaml -Type: Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.TransparentDataEncryptionStateType -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.TransparentDataEncryptionStateType - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.AzureSqlDatabaseTransparentDataEncryptionModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlDatabaseTransparentDataEncryption](./Get-AzureRmSqlDatabaseTransparentDataEncryption.md) - -[Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity](./Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline.md b/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline.md deleted file mode 100644 index a2c81bd93d..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline.md +++ /dev/null @@ -1,279 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/set-azurermsqldatabasevulnerabilityassessmentrulebaseline -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline.md ---- - -# Set-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline - -## SYNOPSIS -Sets the vulnerability assessment rule baseline. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline - [-InputObject <DatabaseVulnerabilityAssessmentRuleBaselineModel>] -BaselineResult <String[][]> - -RuleId <String> [-RuleAppliesToMaster] [-ServerName] <String> [-DatabaseName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set- AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline** cmdlet sets the vulnerability assessment rule baseline. -As you review your assessment results, you can mark specific results as being an acceptable Baseline in your environment. The baseline is essentially a customization of how the results are reported. Results that match the baseline are considered as passing in subsequent scans. Once you have established your baseline security state, vulnerability assessment only reports on deviations from the baseline, and you can focus your attention on the relevant issues. -Note that you need to run *Enable-AzureRmSqlServerAdvancedThreatProtection* and *Set-AzureRmSqlDatabaseVulnerabilityAssessmentSettings* cmdlet as a prerequisite for using this cmdlets. - -## EXAMPLES - -### Example 1 - Set a vulnerability assessment rule baseline -```powershell -PS C:\> Set-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline ` - -ResourceGroupName "ResourceGroup01" ` - -ServerName "Server01" ` - -DatabaseName "Database01" ` - -RuleId "VA2108" ` - -RuleAppliesToMaster ` - -BaselineResult @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') - -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -RuleId : VA2108 -RuleAppliesToMaster : True -BaselineResult : @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') -``` - -BaselineResult value is a composition of several sub arrays that described the T-SQL results that will be added to the baseline. -You may find the Scan results under the storage defined by the Set-AzureRmSqlDatabaseVulnerabilityAssessmentSettings cmdlet, under scans/{ServerName}/{DatabaseName}/scan_{ScanId}.json - -### Example 2 - Set a vulnerability assessment rule baseline from a baseline object -```powershell -PS C:\> Set-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline ` - -ResourceGroupName "ResourceGroup01" ` - -ServerName "Server01" ` - -DatabaseName "Database01" ` - -RuleId "VA2108" ` - -BaselineResult @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') - -PS C:\> Get-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline ` - -ResourceGroupName "ResourceGroup01" ` - -ServerName "Server01" ` - -DatabaseName "Database01" ` - -RuleId "VA2108" ` - -BaselineResult @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') ` - | Set-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline ` - -ResourceGroupName "ResourceGroup02" ` - -ServerName "Server02" ` - -DatabaseName "Database02" - -ResourceGroupName : ResourceGroup02 -ServerName : Server02 -DatabaseName : Database02 -RuleId : VA2108 -RuleAppliesToMaster : False -BaselineResult : @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') -``` - -### Example 3: Set a vulnerability assessment rule baseline on all the databases under a server -```powershell -PS C:\> Get-AzureRmSqlDatabase -ResourceGroupName "ResourceGroup01" ` - -ServerName "Server01" ` - | where {$_.DatabaseName -ne "master"} ` - | Set-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline ` - -RuleId "VA2108" ` - -BaselineResult @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') - -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -RuleId : VA2108 -RuleAppliesToMaster : False -BaselineResult : @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') - -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database02 -RuleId : VA2108 -RuleAppliesToMaster : False -BaselineResult : @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None') , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None') -``` - -## PARAMETERS - -### -BaselineResult -The results to set as baseline for the rule in all future scans - -```yaml -Type: System.String[][] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseName -SQL Database name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The Vulnerability Assessment rule baseline object to set - -```yaml -Type: Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.DatabaseVulnerabilityAssessmentRuleBaselineModel -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RuleAppliesToMaster -Specifies whether the baseline results should apply on a server level rule identified by the RuleId - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RuleId -The rule ID which identifies the rule to set the baseline results to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -SQL Database server name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.DatabaseVulnerabilityAssessmentRuleBaselineModel -Parameters: InputObject (ByValue) - -### System.String[][] - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.DatabaseVulnerabilityAssessmentRuleBaselineModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlElasticPool.md b/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlElasticPool.md deleted file mode 100644 index 79b4e2507b..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlElasticPool.md +++ /dev/null @@ -1,422 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 555D58AB-1361-4BB1-ACD0-905C3C6F4F7E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/set-azurermsqlelasticpool -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlElasticPool.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlElasticPool.md ---- - -# Set-AzureRmSqlElasticPool - -## SYNOPSIS -Modifies properties of an elastic database pool in Azure SQL Database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DtuBasedPool (Default) -``` -Set-AzureRmSqlElasticPool [-ElasticPoolName] <String> [-Edition <String>] [-Dtu <Int32>] [-StorageMB <Int32>] - [-DatabaseDtuMin <Int32>] [-DatabaseDtuMax <Int32>] [-Tags <Hashtable>] [-ZoneRedundant] - [-LicenseType <String>] [-AsJob] [-ServerName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### VcoreBasedPool -``` -Set-AzureRmSqlElasticPool [-ElasticPoolName] <String> [-Edition <String>] [-StorageMB <Int32>] [-VCore <Int32>] - [-ComputeGeneration <String>] [-DatabaseVCoreMin <Double>] [-DatabaseVCoreMax <Double>] [-Tags <Hashtable>] - [-ZoneRedundant] [-LicenseType <String>] [-AsJob] [-ServerName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSqlElasticPool** cmdlet sets properties for an elastic pool in Azure SQL Database. This cmdlet can modify the eDTUs per pool (*Dtu*), storage max size per pool (*StorageMB*), maximum eDTUs per database (*DatabaseDtuMax*), and minimum eDTUs per database (*DatqabaseDtuMin*). -Several parameters (*-Dtu, -DatabaseDtuMin, and -DatabaseDtuMax*) require the value being set is from the list of valid values for that parameter. For example, -DatabaseDtuMax for a Standard 100 eDTU pool can only be set to 10, 20, 50, or 100. For details about which values are valid, see the table for your specific size pool in [elastic pools](https://docs.microsoft.com/azure/sql-database/sql-database-elastic-pool). - -## EXAMPLES - -### Example 1: Modify properties for an elastic pool -``` -PS C:\>Set-AzureRmSqlDatabaseElasticPool -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ElasticPoolName "ElasticPool01" -Dtu 1000 -DatabaseDtuMax 100 -DatabaseDtuMin 20 -ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/Server01/elasticPools/ElasticPool01 -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -ElasticPoolName : ElasticPool01 -Location : Central US -CreationDate : 8/26/2015 10:00:17 PM -State : Ready -Edition : Standard -Dtu : 200 -DatabaseDtuMax : 100 -DatabaseDtuMin : 20 -StorageMB : 204800 -Tags : -``` - -This command modifies properties for an elastic pool named elasticpool01. The command sets the -number of DTUs for the elastic pool to 1000 and sets the minimum and maximum DTUs. - -### Example 2: Modify the storage max size of an elastic pool -``` -PS C:\>Set-AzureRmSqlDatabaseElasticPool -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ElasticPoolName "ElasticPool01" -StorageMB 2097152 -ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/Server01/elasticPools/ElasticPool01 -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -ElasticPoolName : ElasticPool01 -Location : Central US -CreationDate : 8/26/2015 10:00:17 PM -State : Ready -Edition : Premium -Dtu : 200 -DatabaseDtuMax : 100 -DatabaseDtuMin : 20 -StorageMB : 2097152 -Tags : -``` - -This command modifies properties for an elastic pool named elasticpool01. The command sets the max -storage for an elastic pool to 2 TB. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputeGeneration -The compute generation to assign. - -```yaml -Type: System.String -Parameter Sets: VcoreBasedPool -Aliases: Family - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseDtuMax -Specifies the maximum number of DTUs that any single database in the pool can consume. -For details about which values are valid, see the table for your specific size pool in [elastic pools](https://docs.microsoft.com/azure/sql-database/sql-database-elastic-pool). -The default -values for different editions are as follows: -- Basic. 5 DTUs -- Standard. 100 DTUs -- Premium. 125 DTUs - -```yaml -Type: System.Int32 -Parameter Sets: DtuBasedPool -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseDtuMin -Specifies the minimum number of DTUs that the elastic pool guarantees to all the databases in the pool. -For details about which values are valid, see the table for your specific size pool in [elastic pools](https://docs.microsoft.com/azure/sql-database/sql-database-elastic-pool). -The default value is zero (0). - -```yaml -Type: System.Int32 -Parameter Sets: DtuBasedPool -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseVCoreMax -The maxmium VCore number any SqlAzure Database can consume in the pool. - -```yaml -Type: System.Double -Parameter Sets: VcoreBasedPool -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseVCoreMin -The minimum VCore number any SqlAzure Database can consume in the pool. - -```yaml -Type: System.Double -Parameter Sets: VcoreBasedPool -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Dtu -Specifies the total number of shared DTUs for the elastic pool. -For details about which values are valid, see the table for your specific size pool in [elastic pools](https://docs.microsoft.com/azure/sql-database/sql-database-elastic-pool). -The default values for different -editions are as follows: -- Basic. 100 DTUs -- Standard. 100 DTUs -- Premium. 125 DTUs - -```yaml -Type: System.Int32 -Parameter Sets: DtuBasedPool -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Edition -Specifies the edition of the Azure SQL Database for the elastic pool. You cannot change the -edition. The acceptable values for this parameter are: -- None -- Basic -- Standard -- Premium -- DataWarehouse -- Free -- Stretch -- GeneralPurpose -- BusinessCritical - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ElasticPoolName -Specifies the name of the elastic pool. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LicenseType -The license type for the Azure Sql database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the elastic pool is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server that hosts the elastic pool. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageMB -Specifies the storage limit, in megabytes, for the elastic pool. For more information, see the -New-AzureRmSqlElasticPool cmdlet. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tags -Specifies a dictionary of Key-value pairs that this cmdlet associates with the elastic pool in the -form of a hash table. For example: -`@{key0="value0";"key 1"=$null;key2="value2"}` - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tag - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VCore -The total shared number of Vcore for the Sql Azure Elastic Pool. - -```yaml -Type: System.Int32 -Parameter Sets: VcoreBasedPool -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZoneRedundant -The zone redundancy to associate with the Azure Sql Elastic Pool - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlElasticPool](./Get-AzureRmSqlElasticPool.md) - -[Get-AzureRmSqlElasticPoolActivity](./Get-AzureRmSqlElasticPoolActivity.md) - -[Get-AzureRmSqlElasticPoolDatabase](./Get-AzureRmSqlElasticPoolDatabase.md) - -[New-AzureRmSqlElasticPool](./New-AzureRmSqlElasticPool.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlElasticPoolAdvisorAutoExecuteStatus.md b/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlElasticPoolAdvisorAutoExecuteStatus.md deleted file mode 100644 index 69e7341462..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlElasticPoolAdvisorAutoExecuteStatus.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: BAA0781E-DC02-4AAF-A039-9B71B67E6696 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/set-azurermsqlelasticpooladvisorautoexecutestatus -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlElasticPoolAdvisorAutoExecuteStatus.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlElasticPoolAdvisorAutoExecuteStatus.md ---- - -# Set-AzureRmSqlElasticPoolAdvisorAutoExecuteStatus - -## SYNOPSIS -Updates auto execute status of an Azure SQL Elastic Pool Advisor. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSqlElasticPoolAdvisorAutoExecuteStatus -AdvisorName <String> - -AutoExecuteStatus <AdvisorAutoExecuteStatus> -ServerName <String> -ElasticPoolName <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSqlElasticPoolAdvisorAutoExecuteStatus** cmdlet sets auto execute property for an Azure SQL Elastic Pool Advisor. - -## EXAMPLES - -### Example 1: Enable auto execute for an advisor -``` -PS C:\>Set-AzureRmSqlElasticPoolAdvisorAutoExecuteStatus -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -ElasticPoolName "WIRunnerPool" -AdvisorName "CreateIndex" -AutoExecuteStatus Enabled -'Enabled'ElasticPoolName : WIRunnerPool -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : CreateIndex -AdvisorStatus : GA -AutoExecuteStatus : Enabled -AutoExecuteStatusInheritedFrom : ElasticPool -LastChecked : 8/1/2016 2:36:47 PM -RecommendationsStatus : Ok -RecommendedActions : {} -``` - -This command sets the auto execute status of an advisor named CreateIndex to enabled. - -## PARAMETERS - -### -AdvisorName -Specifies the name of the advisor for which this cmdlet updates the auto execute status. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AutoExecuteStatus -Specifies a new value to which this cmdlet updates the auto execute status. -The acceptable values for this parameter are: -- Enabled -- Disabled -- Default - -```yaml -Type: Microsoft.Azure.Commands.Sql.Advisor.Cmdlet.AdvisorAutoExecuteStatus -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled, Default - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ElasticPoolName -Specifies the name of the elastic pool. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the server that contains this elastic pool. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server the elastic pool is in. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Sql.Advisor.Cmdlet.AdvisorAutoExecuteStatus - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Advisor.Model.AzureSqlElasticPoolAdvisorModel - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, sql, elastic pool, mssql, advisor - -## RELATED LINKS - -[Get-AzureRmSqlElasticPoolAdvisor](./Get-AzureRmSqlElasticPoolAdvisor.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlElasticPoolRecommendedActionState.md b/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlElasticPoolRecommendedActionState.md deleted file mode 100644 index 1986e086de..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlElasticPoolRecommendedActionState.md +++ /dev/null @@ -1,238 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: EFDFCE12-F39C-4F52-9962-4601F0C4FD47 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/set-azurermsqlelasticpoolrecommendedactionstate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlElasticPoolRecommendedActionState.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlElasticPoolRecommendedActionState.md ---- - -# Set-AzureRmSqlElasticPoolRecommendedActionState - -## SYNOPSIS -Updates the state of an Azure SQL Elastic Pool recommended action. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSqlElasticPoolRecommendedActionState -RecommendedActionName <String> -State <RecommendedActionState> - -ServerName <String> -ElasticPoolName <String> -AdvisorName <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSqlElasticPoolRecommendedActionState** cmdlet updates state of an Azure SQL Elastic Pool recommended action. -This cmdlet applies an recommended action, reverted, or discarded based on the new state. - -## EXAMPLES - -### Example 1: Update the state of a recommended action to Pending -``` -PS C:\>Set-AzureRmSqlElasticPoolRecommendedActionState -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -ElasticPoolName "WIRunnerPool" -AdvisorName "CreateIndex" -RecommendedActionName "IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893" -State Pending -ElasticPoolName : WIRunnerPool -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : CreateIndex -RecommendedActionName : IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893 -Details : {[indexName, nci_wi_test_table_0.0361551_6C7AE8CC9C87E7FD5893], [indexType, - NONCLUSTERED], [schema, [test_schema]], [table, [test_table_0.0361551]]...} -ErrorDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionErrorInfo -EstimatedImpact : {ActionDuration, SpaceChange} -ExecuteActionDuration : PT1M -ExecuteActionInitiatedBy : User -ExecuteActionInitiatedTime : 4/21/2016 3:24:47 PM -ExecuteActionStartTime : 4/21/2016 3:24:47 PM -ImplementationDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionImplementationInfo -IsArchivedAction : False -IsExecutableAction : True -IsRevertableAction : True -LastRefresh : 4/21/2016 3:24:47 PM -LinkedObjects : {} -ObservedImpact : {CpuUtilization, LogicalReads, LogicalWrites, QueriesWithImprovedPerformance...} -RecommendationReason : -RevertActionDuration : -RevertActionInitiatedBy : -RevertActionInitiatedTime : -RevertActionStartTime : -Score : 2 -State : Microsoft.Azure.Management.Sql.Models.RecommendedActionStateInfo -TimeSeries : {} -ValidSince : 4/21/2016 3:24:47 PM -``` - -This command updates the state of elastic pool recommended action named IR_\[test_schema\]_\[test_table_0.0361551\]_6C7AE8CC9C87E7FD5893 to Pending. - -## PARAMETERS - -### -AdvisorName -Specifies the name of the advisor for which this recommended action belongs to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ElasticPoolName -Specifies name of the elastic pool. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RecommendedActionName -Specifies the name of the recommended action for which this cmdlet updates the state. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the server that contains this elastic pool. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server the elastic pool is in. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -Specifies the value to which this cmdlet updates the recommended action state. -The acceptable values for this parameter are: -- Active -- Pending -- PendingRevert -- RevertCancelled -- Ignored -- Resolved - -```yaml -Type: Microsoft.Azure.Commands.Sql.RecommendedAction.Cmdlet.RecommendedActionState -Parameter Sets: (All) -Aliases: -Accepted values: Active, Pending, PendingRevert, RevertCancelled, Ignored, Resolved - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Sql.RecommendedAction.Cmdlet.RecommendedActionState - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.RecommendedAction.Model.AzureSqlElasticPoolRecommendedActionModel - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, sql, elasticpool, mssql, advisor, recommendedaction - -## RELATED LINKS - -[Get-AzureRmSqlElasticPoolRecommendedAction](./Get-AzureRmSqlElasticPoolRecommendedAction.md) - -[Set-AzureRmSqlDatabaseRecommendedActionState](./Set-AzureRmSqlDatabaseRecommendedActionState.md) - -[Set-AzureRmSqlServerRecommendedActionState](./Set-AzureRmSqlServerRecommendedActionState.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlInstance.md b/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlInstance.md deleted file mode 100644 index c78e07c03d..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlInstance.md +++ /dev/null @@ -1,312 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/set-azurermsqlinstance -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlInstance.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlInstance.md ---- - -# Set-AzureRmSqlInstance - -## SYNOPSIS -Sets properties for an Azure SQL Database Managed Instance. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetInstanceFromInputParameters (Default) -``` -Set-AzureRmSqlInstance [-Name] <String> [-ResourceGroupName] <String> [-AdministratorPassword <SecureString>] - [-Edition <String>] [-LicenseType <String>] [-StorageSizeInGB <Int32>] [-VCore <Int32>] [-Tag <Hashtable>] - [-AssignIdentity] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### SetInstanceFromAzureSqlManagedInstanceModelInstanceDefinition -``` -Set-AzureRmSqlInstance [-InputObject] <AzureSqlManagedInstanceModel> [-AdministratorPassword <SecureString>] - [-Edition <String>] [-LicenseType <String>] [-StorageSizeInGB <Int32>] [-VCore <Int32>] [-Tag <Hashtable>] - [-AssignIdentity] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### SetInstanceFromAzureResourceId -``` -Set-AzureRmSqlInstance [-ResourceId] <String> [-AdministratorPassword <SecureString>] [-Edition <String>] - [-LicenseType <String>] [-StorageSizeInGB <Int32>] [-VCore <Int32>] [-Tag <Hashtable>] [-AssignIdentity] - [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSqlInstance** cmdlet modifies properties of an Azure SQL Database Managed instance. - -## EXAMPLES - -### Example 1: Set existing instance using new values for -AdministratorPassword, -LicenseType, -StorageSizeInGB and -VCore -``` -PS C:\>$InstancePassword = "Newpassword1234" -PS C:\> $SecureString = ConvertTo-SecureString $InstancePassword -AsPlainText -Force -PS C:\> Set-AzureRmSqlInstance -Name "managedinstance1" -ResourceGroupName "ResourceGroup01" -AdministratorPassword $SecureString -LicenseType LicenseIncluded -StorageSizeInGB 1024 -VCore 16 -Location : westcentralus -Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1 -ResourceGroupName : resourcegroup01 -ManagedInstanceName : managedInstance1 -Tags : -Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity -Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku -FullyQualifiedDomainName : managedInstance1.wcusxxxxxxxxxxxxx.database.windows.net -AdministratorLogin : adminLogin1 -AdministratorPassword : -SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name -LicenseType : LicenseIncluded -VCores : 16 -StorageSizeInGB : 1024 -``` - -This command sets existing instance using new values for -AdministratorPassword, -LicenseType, -StorageSizeInGB and -VCore - -## PARAMETERS - -### -AdministratorPassword -The new SQL administrator password for the instance. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignIdentity -Generate and assign a Microsoft Entra identity for this instance for use with key management services like Azure KeyVault. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Edition -The edition to assign to the instance. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Skip confirmation message for performing the action - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The AzureSqlManagedInstanceModel object to remove - -```yaml -Type: AzureSqlManagedInstanceModel -Parameter Sets: SetInstanceFromAzureSqlManagedInstanceModelInstanceDefinition -Aliases: SqlInstance - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LicenseType -Determines which License Type of instance to use - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Instance name. - -```yaml -Type: String -Parameter Sets: SetInstanceFromInputParameters -Aliases: InstanceName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: String -Parameter Sets: SetInstanceFromInputParameters -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The resource id of instance to remove - -```yaml -Type: String -Parameter Sets: SetInstanceFromAzureResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageSizeInGB -Determines how much Storage size to associate with instance - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -The tags to associate with the instance. - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VCore -Determines how much VCore to associate with instance - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel -System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ManagedInstance.Model.AzureSqlManagedInstanceModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServer.md b/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServer.md deleted file mode 100644 index 49d9a33995..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServer.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: FAAF458C-1662-4130-9A16-0514B714D11D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/set-azurermsqlserver -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServer.md ---- - -# Set-AzureRmSqlServer - -## SYNOPSIS -Modifies properties of a SQL Database server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSqlServer [-ServerName] <String> [-SqlAdministratorPassword <SecureString>] [-Tags <Hashtable>] - [-ServerVersion <String>] [-AssignIdentity] [-Force] [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSqlServer** cmdlet modifies properties of an Azure SQL Database server. - -## EXAMPLES - -### Example 1: Reset the administrator password -``` -PS C:\>$ServerPassword = "newpassword" -PS C:\> $SecureString = ConvertTo-SecureString $ServerPassword -AsPlainText -Force -PS C:\> Set-AzureRmSqlServer -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -SqlAdministratorPassword $secureString -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -Location : Australia East -SqlAdministratorLogin : adminLogin -SqlAdministratorPassword : -ServerVersion : 12.0 -Tags : -Identity : -FullyQualifiedDomainName : server01.database.windows.net -``` - -This command resets the administrator password on the AzureSQL Server named server01. - -## PARAMETERS - -### -AssignIdentity -Generate and assign a Microsoft Entra identity for this server for use with key management services like Azure KeyVault. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the server is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerVersion -Specifies the version to which this cmdlet changes the server. The acceptable values for this -parameter are: 2.0 and 12.0. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SqlAdministratorPassword -Specifies a new password, as a **SecureString**, for the database server administrator. To obtain a -**SecureString**, use the Get-Credential cmdlet. For more information, type `Get-Help -ConvertTo-SecureString`. - -```yaml -Type: System.Security.SecureString -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tags -Specifies a dictionary of tags that this cmdlet associates with the server. Key-value pairs in the -form of a hash table set as tags on the server. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tag - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel - -## NOTES - -## RELATED LINKS - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerActiveDirectoryAdministrator.md b/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerActiveDirectoryAdministrator.md deleted file mode 100644 index 9356b415e6..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerActiveDirectoryAdministrator.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 60E0D10F-9B93-45A9-A1FF-5C943B8CA09C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/set-azurermsqlserveractivedirectoryadministrator -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerActiveDirectoryAdministrator.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerActiveDirectoryAdministrator.md ---- - -# Set-AzureRmSqlServerActiveDirectoryAdministrator - -## SYNOPSIS -Provisions a Microsoft Entra administrator for SQL Server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSqlServerActiveDirectoryAdministrator [-DisplayName] <String> [[-ObjectId] <Guid>] - [-ServerName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSqlServerActiveDirectoryAdministrator** cmdlet provisions a Microsoft Entra administrator for AzureSQL Server in the current subscription. -You can provision only one administrator at a time. -The following members of Microsoft Entra ID can be provisioned as a SQL Server administrator: -- Native members of Microsoft Entra ID -- Federated members of Microsoft Entra ID -- Imported members from other Azure ADs who are native or federated members -- Microsoft Entra groups created as security groups -Microsoft accounts, such as those in the Outlook.com, Hotmail.com, or Live.com domains, are not supported as administrators. -Other guest accounts, such as those in the Gmail.com or Yahoo.com domains, are not supported as administrators. -We recommend that you provision a dedicated Microsoft Entra group as an administrator. - -## EXAMPLES - -### Example 1: Provision an administrator group for a server -``` -PS C:\>Set-AzureRmSqlServerActiveDirectoryAdministrator -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DisplayName "DBAs" -ResourceGroupName ServerName DisplayName ObjectId ------------------ ---------- ----------- -------- -ResourceGroup01 Server01 DBAs 40b79501-b343-44ed-9ce7-da4c8cc7353b -``` - -This command provisions a Microsoft Entra administrator group named DBAs for the server named Server01. -This server is associated with resource group ResourceGroup01. - -### Example 2: Provision an administrator user for a server -``` -PS C:\>Set-AzureRmSqlServerActiveDirectoryAdministrator -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DisplayName "David Chew" -ResourceGroupName ServerName DisplayName ObjectId ------------------ ---------- ----------- -------- -resourcegroup01 server01 David Chew 11E95548-B179-4FE1-9AF4-ACA49D13ABB9 -``` - -This command provisions a Microsoft Entra user as an administrator for the server named Server01. - -### Example 3: Provision an administrator group by specifying its ID -``` -PS C:\>Set-AzureRmSqlServerActiveDirectoryAdministrator -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DisplayName "DBAs" -ObjectId "40b79501-b343-44ed-9ce7-da4c8cc7353b" -ResourceGroupName ServerName DisplayName ObjectId ------------------ ---------- ----------- -------- -ResourceGroup01 Server01 DBAs 40b79501-b343-44ed-9ce7-da4c8cc7353b -``` - -This command provisions a Microsoft Entra administrator group named DBAs for the server named Server01. -The command specifies an ID for the *ObjectId* parameter. -This makes sure that the command succeeds even if the display name of the group is not unique. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the display name of the Microsoft Entra administrator that this cmdlet provisions. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ObjectId -Specifies the unique ID of the Microsoft Entra administrator that this cmdlet provisions. -If the display name is not unique, you must specify a value for this parameter. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the server is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the SQL Server for which this cmdlet provisions an administrator. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Guid - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ServerActiveDirectoryAdministrator.Model.AzureSqlServerActiveDirectoryAdministratorModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlServerActiveDirectoryAdministrator](./Get-AzureRmSqlServerActiveDirectoryAdministrator.md) - -[Remove-AzureRmSqlServerActiveDirectoryAdministrator](./Remove-AzureRmSqlServerActiveDirectoryAdministrator.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerAdvisorAutoExecuteStatus.md b/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerAdvisorAutoExecuteStatus.md deleted file mode 100644 index e8b73c7de1..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerAdvisorAutoExecuteStatus.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 6006D3AC-48E1-44A0-8BD5-CE996B8957A2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/set-azurermsqlserveradvisorautoexecutestatus -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerAdvisorAutoExecuteStatus.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerAdvisorAutoExecuteStatus.md ---- - -# Set-AzureRmSqlServerAdvisorAutoExecuteStatus - -## SYNOPSIS -Updates the auto execute status of an Azure SQL Server Advisor. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSqlServerAdvisorAutoExecuteStatus -AdvisorName <String> - -AutoExecuteStatus <AdvisorAutoExecuteStatus> -ServerName <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSqlServerAdvisorAutoExecuteStatus** cmdlet sets the auto execute property for an Azure SQL Server Advisor. - -## EXAMPLES - -### Example 1: Enable auto execute for an Advisor -``` -PS C:\>Set-AzureRmSqlServerAdvisorAutoExecuteStatus -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -AdvisorName "CreateIndex" -AutoExecuteStatus Enabled -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : CreateIndex -AdvisorStatus : GA -AutoExecuteStatus : Enabled -AutoExecuteStatusInheritedFrom : Server -LastChecked : 8/1/2016 2:36:47 PM -RecommendationsStatus : Ok -RecommendedActions : {} -``` - -This command enables the auto execute status of an Advisor named CreateIndex. - -## PARAMETERS - -### -AdvisorName -Specifies the name of the advisor for which this cmdlet updates the auto execute status. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AutoExecuteStatus -Specifies the value to which this cmdlet updates the auto execute status. -The acceptable values for this parameter are: -- Enabled -- Disabled -- Default - -```yaml -Type: Microsoft.Azure.Commands.Sql.Advisor.Cmdlet.AdvisorAutoExecuteStatus -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled, Default - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Sql.Advisor.Cmdlet.AdvisorAutoExecuteStatus - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Advisor.Model.AzureSqlServerAdvisorModel - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, sql, server, mssql, advisor - -## RELATED LINKS - -[Get-AzureRmSqlServerAdvisor](./Get-AzureRmSqlServerAdvisor.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerAuditing.md b/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerAuditing.md deleted file mode 100644 index db2e13e290..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerAuditing.md +++ /dev/null @@ -1,302 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 14814BF3-51AF-4E51-A8A6-661825BD88D1 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/set-azurermsqlserverauditing -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerAuditing.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerAuditing.md ---- - -# Set-AzureRmSqlServerAuditing - -## SYNOPSIS -Changes the auditing settings of an Azure SQL server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameterSet (Default) -``` -Set-AzureRmSqlServerAuditing -State <String> [-AuditActionGroup <AuditActionGroups[]>] [-PassThru] - [-StorageAccountName <String>] [-StorageKeyType <String>] [-RetentionInDays <UInt32>] - [-PredicateExpression <String>] [-ServerName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### StorageAccountSubscriptionIdSet -``` -Set-AzureRmSqlServerAuditing -State <String> [-AuditActionGroup <AuditActionGroups[]>] [-PassThru] - -StorageAccountName <String> [-StorageAccountSubscriptionId <Guid>] [-StorageKeyType <String>] - [-RetentionInDays <UInt32>] [-PredicateExpression <String>] [-ServerName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSqlServerAuditing** cmdlet changes the auditing settings of an Azure SQL server. -To use the cmdlet, use the *ResourceGroupName* and *ServerName* parameters to identify the server. -Specify the *StorageAccountName* parameter to specify the storage account for the audit logs and the *StorageKeyType* parameter to define the storage keys. -Use the *State* parameter to enable/disable the policy. -You can also define retention for the audit logs by setting the value of the *RetentionInDays* parameter to define the period for the audit logs. -After the cmdlet runs successfully, auditing of the Azure SQL databases that are defined in the specified Azure SQL server is enabled. -If the cmdlet succeeds and you use the *PassThru* parameter, it returns an object describing the current blob auditing policy in addition to the server identifiers. -Server identifiers include, but are not limited to, **ResourceGroupName** and **ServerName**. - -## EXAMPLES - -### Example 1: Enable the auditing policy of an Azure SQL server -``` -PS C:\>Set-AzureRmSqlServerAuditing -State Enabled -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -StorageAccountName "Storage22" -``` - -### Example 2: Disable the auditing policy of an Azure SQL server -``` -PS C:\>Set-AzureRmSqlServerAuditing -State Disabled -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -``` - -### Example 3: Enable the auditing policy of an Azure SQL server using a storage account from a different subscription -``` -PS C:\>Set-AzureRmSqlServerAuditing -State Enabled -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -StorageAccountName "Storage22" -StorageAccountSubscriptionId "7fe3301d-31d3-4668-af5e-211a890ba6e3" -``` - -### Example 4: Enable the extended auditing policy of an Azure SQL database -``` -PS C:\>Set-AzureRmSqlDatabaseAuditing -State Enabled -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -StorageAccountName "Storage22" -DatabaseName "Database01" -PredicateExpression "statement <> 'select 1'" -``` - -### Example 5: Remove the extended auditing policy of an Azure SQL database, and set an auditing policy instead of it. -``` -PS C:\>Set-AzureRmSqlDatabaseAuditing -State Enabled -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -StorageAccountName "Storage22" -DatabaseName "Database01" -PredicateExpression "" -``` - -## PARAMETERS - -### -AuditActionGroup -The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins: -"BATCH_COMPLETED_GROUP", -"SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", -"FAILED_DATABASE_AUTHENTICATION_GROUP" -This above combination is also the set that is configured by default. These groups cover all SQL statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. For more information, see https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups. - -```yaml -Type: Microsoft.Azure.Commands.Sql.Auditing.Model.AuditActionGroups[] -Parameter Sets: (All) -Aliases: -Accepted values: BATCH_STARTED_GROUP, BATCH_COMPLETED_GROUP, APPLICATION_ROLE_CHANGE_PASSWORD_GROUP, BACKUP_RESTORE_GROUP, DATABASE_LOGOUT_GROUP, DATABASE_OBJECT_CHANGE_GROUP, DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP, DATABASE_OBJECT_PERMISSION_CHANGE_GROUP, DATABASE_OPERATION_GROUP, AUDIT_CHANGE_GROUP, DATABASE_PERMISSION_CHANGE_GROUP, DATABASE_PRINCIPAL_CHANGE_GROUP, DATABASE_PRINCIPAL_IMPERSONATION_GROUP, DATABASE_ROLE_MEMBER_CHANGE_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP, SCHEMA_OBJECT_ACCESS_GROUP, SCHEMA_OBJECT_CHANGE_GROUP, SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP, SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, USER_CHANGE_PASSWORD_GROUP - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PredicateExpression -The statement of the Where Clause used to filter audit logs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RetentionInDays -The number of retention days for the audit logs. - -```yaml -Type: System.Nullable`1[System.UInt32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -SQL server name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -The state of the policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountName -The name of the storage account. Wildcard characters are not permitted. -This parameter is not required. -If you do not specify this parameter, the cmdlet uses the storage account that was defined previously as part of the auditing policy. -If this is the first time an auditing policy is defined and you do not specify this parameter, the cmdlet fails. - -```yaml -Type: System.String -Parameter Sets: DefaultParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: StorageAccountSubscriptionIdSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountSubscriptionId -Specifies storage account subscription id - -```yaml -Type: System.Guid -Parameter Sets: StorageAccountSubscriptionIdSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageKeyType -Specifies which of the storage access keys to use. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Primary, Secondary - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerAuditingPolicy.md b/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerAuditingPolicy.md deleted file mode 100644 index 0c4a301806..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerAuditingPolicy.md +++ /dev/null @@ -1,314 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 4FCC7D8B-A46E-4E5B-8BE2-F62B3D3E715D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/set-azurermsqlserverauditingpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerAuditingPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerAuditingPolicy.md ---- - -# Set-AzureRmSqlServerAuditingPolicy - -## SYNOPSIS -Changes the auditing policy of a SQL Database server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSqlServerAuditingPolicy [-AuditType <AuditType>] [-AuditActionGroup <AuditActionGroups[]>] - [-PassThru] [-EventType <String[]>] [-StorageAccountName <String>] [-StorageKeyType <String>] - [-RetentionInDays <UInt32>] [-TableIdentifier <String>] -ServerName <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSqlServerAuditingPolicy** cmdlet changes the auditing policy of an Azure SQL Database server. -Specify the *ResourceGroupName* and *ServerName* parameters to identify the server, the *StorageAccountName* parameter to specify the storage account for the audit logs, and the *StorageKeyType* parameter to define the storage keys to use. -You can also define retention for the audit logs table by setting the value of the *RetentionInDays* and *TableIdentifier* parameters to define the period and the seed for the audit log table names. -Specify the *EventType* parameter to define which event types to audit. -After you run this cmdlet, auditing of the databases that use the policy of this server is enabled. -If the cmdlet succeeds and you specify the *PassThru* parameter, the cmdlet returns an object that describes the current auditing policy, and the server identifiers. -Server identifiers include **ResourceGroupName** and **ServerName**. - -## EXAMPLES - -### Example 1: Set the auditing policy of an Azure SQL server use Table auditing -``` -PS C:\>Set-AzureRmSqlServerAuditingPolicy -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -AuditType Table -StorageAccountName "Storage22" -``` - -This command sets the auditing policy of the server named Server01 to use a storage account named Storage22. - -### Example 2: Set the storage account key of an existing auditing policy of an Azure SQL server -``` -PS C:\>Set-AzureRmSqlServerAuditingPolicy -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -StorageAccountKey Secondary -``` - -This command sets the auditing policy of the server named Server01 to use the secondary key. -The command does not modify the storage account name. - -### Example 3: Set the auditing policy of an Azure SQL server to use a specific event type -``` -PS C:\>Set-AzureRmSqlServerAuditingPolicy -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -EventType Login_Failure -``` - -### Example 4: Set the auditing policy of a database to use Blob auditing -``` -PS C:\>Set-AzureRmSqlDatabaseAuditingPolicy -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -AuditType Blob -StorageAccountName "Storage31" -AuditActionGroup "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", "FAILED_DATABASE_AUTHENTICATION_GROUP" -RetentionInDays 8 -``` - -This command sets the auditing policy of the server named Server01 to use the Login_Failure event type. -This command does not modify any other setting. - -## PARAMETERS - -### -AuditActionGroup -Specify one or more audit action groups. -This parameter is only applicable to Blob auditing. - -```yaml -Type: Microsoft.Azure.Commands.Sql.Auditing.Model.AuditActionGroups[] -Parameter Sets: (All) -Aliases: -Accepted values: BATCH_STARTED_GROUP, BATCH_COMPLETED_GROUP, APPLICATION_ROLE_CHANGE_PASSWORD_GROUP, BACKUP_RESTORE_GROUP, DATABASE_LOGOUT_GROUP, DATABASE_OBJECT_CHANGE_GROUP, DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP, DATABASE_OBJECT_PERMISSION_CHANGE_GROUP, DATABASE_OPERATION_GROUP, AUDIT_CHANGE_GROUP, DATABASE_PERMISSION_CHANGE_GROUP, DATABASE_PRINCIPAL_CHANGE_GROUP, DATABASE_PRINCIPAL_IMPERSONATION_GROUP, DATABASE_ROLE_MEMBER_CHANGE_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP, SCHEMA_OBJECT_ACCESS_GROUP, SCHEMA_OBJECT_CHANGE_GROUP, SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP, SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, USER_CHANGE_PASSWORD_GROUP - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AuditType -Specify the audit type. Audit logs can be written to Table storage or Blob storage. Blob auditing provides higher performance and supports object-level auditing. - -```yaml -Type: Microsoft.Azure.Commands.Sql.Auditing.Model.AuditType -Parameter Sets: (All) -Aliases: -Accepted values: NotSet, Table, Blob - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventType -Specifies the event types to audit. -This parameter is only applicable to Table auditing. -You can specify several event types. -You can specify All to audit all of the event types or None to specify that no events will be audited. -If you specify All or None at the same time, the command fails. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: -Accepted values: PlainSQL_Success, PlainSQL_Failure, ParameterizedSQL_Success, ParameterizedSQL_Failure, StoredProcedure_Success, StoredProcedure_Failure, Login_Success, Login_Failure, TransactionManagement_Success, TransactionManagement_Failure, All, None - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RetentionInDays -Specifies the number of retention days for the audit logs table. -A value of zero (0) means that the table is not retained. -this is the default. -If you specify a value greater than zero, you must also specify a value for the *TableIdentifer* parameter. - -```yaml -Type: System.Nullable`1[System.UInt32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server that contains the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountName -Specifies the name of the storage account for auditing the database. -Wildcard characters are not permitted. -If you do not specify this parameter, the cmdlet uses the storage account that was defined previously as part of the auditing policy of the database. -If this is the first time a database auditing policy is defined and you do not specify this parameter, the command fails. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageKeyType -Specifies which of the storage access keys to use. -The acceptable values for this parameter are: -- Primary -- Secondary -The default value is Primary. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Primary, Secondary - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TableIdentifier -Specifies the name of the audit logs table. -Specify this value if you specify a value greater than zero for the *RetentionInDays* parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Sql.Auditing.Model.AuditType - -### Microsoft.Azure.Commands.Sql.Auditing.Model.AuditActionGroups[] - -### System.String[] - -### System.String - -### System.Nullable`1[[System.UInt32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Auditing.Model.AuditingPolicyModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlServerAuditingPolicy](./Get-AzureRmSqlServerAuditingPolicy.md) - -[Use-AzureRmSqlServerAuditingPolicy](./Use-AzureRmSqlServerAuditingPolicy.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerBackupLongTermRetentionVault.md b/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerBackupLongTermRetentionVault.md deleted file mode 100644 index ccefb9cb74..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerBackupLongTermRetentionVault.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 7642F18A-B193-4849-BE3C-1B85FBD213F3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/set-azurermsqlserverbackuplongtermretentionvault -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerBackupLongTermRetentionVault.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerBackupLongTermRetentionVault.md ---- - -# Set-AzureRmSqlServerBackupLongTermRetentionVault - -## SYNOPSIS -Sets a server long term retention vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSqlServerBackupLongTermRetentionVault -ResourceId <String> [-ServerName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSqlServerBackupLongTermRetentionVault** cmdlet sets the long term retention vault registered to this server. -The vault is an Azure Backup resource used to store backup data. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Specifies the ID of a resource. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the server for which this cmdlet sets a vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Backup.Model.AzureSqlServerBackupLongTermRetentionVaultModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlServerBackupLongTermRetentionVault](./Get-AzureRmSqlServerBackupLongTermRetentionVault.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerDisasterRecoveryConfiguration.md b/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerDisasterRecoveryConfiguration.md deleted file mode 100644 index 73a681595d..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerDisasterRecoveryConfiguration.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 44F8EFF4-8E3D-4657-9D17-2A3F49CEA515 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/set-azurermsqlserverdisasterrecoveryconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerDisasterRecoveryConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerDisasterRecoveryConfiguration.md ---- - -# Set-AzureRmSqlServerDisasterRecoveryConfiguration - -## SYNOPSIS -Modifies a database server recovery configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSqlServerDisasterRecoveryConfiguration -VirtualEndpointName <String> [-Failover] [-AllowDataLoss] - [-AsJob] [-ServerName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSqlServerDisasterRecoveryConfiguration** cmdlet modifies a SQL database server recovery configuration. - -## EXAMPLES - -## PARAMETERS - -### -AllowDataLoss -Indicates that the failover operation permits data loss. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Failover -Indicates that this operation is a failover. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of a SQL database server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualEndpointName -Specifies the name of a virtual end point. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ServerDisasterRecoveryConfiguration.Model.AzureSqlServerDisasterRecoveryConfigurationModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlServerDisasterRecoveryConfiguration](./Get-AzureRmSqlServerDisasterRecoveryConfiguration.md) - -[New-AzureRmSqlServerDisasterRecoveryConfiguration](./New-AzureRmSqlServerDisasterRecoveryConfiguration.md) - -[Remove-AzureRmSqlServerDisasterRecoveryConfiguration](./Remove-AzureRmSqlServerDisasterRecoveryConfiguration.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerDnsAlias.md b/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerDnsAlias.md deleted file mode 100644 index c0c8c98df7..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerDnsAlias.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/set-azurermsqlserverdnsalias -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerDnsAlias.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerDnsAlias.md ---- - -# Set-AzureRmSqlServerDnsAlias - -## SYNOPSIS -Modifies the server to which Azure SQL Server DNS Alias is pointing - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSqlServerDnsAlias -Name <String> -TargetServerName <String> [-ResourceGroupName] <String> - -SourceServerName <String> -SourceServerResourceGroupName <String> -SourceServerSubscriptionId <Guid> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -This command is updating the server to which alias is pointing. -This command needs to be issued while logged into subscription where new server to which alias is going to point is located. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Set-AzureRmSqlServerDnsAlias -ResourceGroupName rg -DnsAliasName aliasName -TargetServerName newServer -SourceServerName oldServer -SourceServerResourceGroupName SourceServerRG -SourceServerSubscriptionId 0000-0000-0000-0000 -``` - -This command is updating alias which was previously pointing to oldServer to point to server newServer - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Azure Sql Server Dns Alias name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: DnsAliasName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: TargetResourceGroupName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceServerName -The name of Azure Sql Server to which alias is currently pointing. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceServerResourceGroupName -The name of resource group of the source server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceServerSubscriptionId -The subscription id of the source server - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetServerName -The name of Azure Sql Server to which alias should point. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ServerDnsAlias.Model.AzureSqlServerDnsAliasModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerFirewallRule.md b/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerFirewallRule.md deleted file mode 100644 index 9a2d47cee7..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerFirewallRule.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: B407CF77-792B-40F8-87AB-49FB3DCEE646 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/set-azurermsqlserverfirewallrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerFirewallRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerFirewallRule.md ---- - -# Set-AzureRmSqlServerFirewallRule - -## SYNOPSIS -Modifies a firewall rule in Azure SQL Database server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSqlServerFirewallRule [-FirewallRuleName] <String> -StartIpAddress <String> -EndIpAddress <String> - [-ServerName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSqlServerFirewallRule** cmdlet modifies a firewall rule in an Azure SQL Database server. - -## EXAMPLES - -### Example 1: Modify a firewall rule -``` -PS C:\>Set-AzureRmSqlServerFirewallRule -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -FirewallRuleName "Rule01" -StartIpAddress "192.168.0.197" -EndIpAddress "192.168.0.199" -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -StartIpAddress : 192.168.0.199 -EndIpAddress : 192.168.0.200 -FirewallRuleName : Rule01 -``` - -This command modifies a firewall rule named Rule01 on the server named Server01. -The command modifies the start and end IP addresses. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndIpAddress -Specifies the end value of the IP address range for this rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FirewallRuleName -Specifies the name of the firewall rule that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the server is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartIpAddress -Specifies the start value of the IP address range for the firewall rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.FirewallRule.Model.AzureSqlServerFirewallRuleModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlServerFirewallRule](./Get-AzureRmSqlServerFirewallRule.md) - -[New-AzureRmSqlServerFirewallRule](./New-AzureRmSqlServerFirewallRule.md) - -[Remove-AzureRmSqlServerFirewallRule](./Remove-AzureRmSqlServerFirewallRule.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerRecommendedActionState.md b/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerRecommendedActionState.md deleted file mode 100644 index ed223dc953..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerRecommendedActionState.md +++ /dev/null @@ -1,224 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 26EC220C-5123-4CEF-8CC6-5FFD08F33481 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/set-azurermsqlserverrecommendedactionstate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerRecommendedActionState.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerRecommendedActionState.md ---- - -# Set-AzureRmSqlServerRecommendedActionState - -## SYNOPSIS -Updates the state of an Azure SQL Server recommended action. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSqlServerRecommendedActionState -RecommendedActionName <String> -State <RecommendedActionState> - -ServerName <String> -AdvisorName <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSqlServerRecommendedActionState** cmdlet updates state of an Azure SQL Server recommended action. -This cmdlet applies, reverts, or discards the recommended action based on the new state. - -## EXAMPLES - -### Example1: Update the state of the specified recommended action to Pending -``` -PS C:\>Set-AzureRmSqlServerRecommendedActionState -ResourceGroupName "WIRunnersProd" -ServerName "wi-runner-australia-east" -AdvisorName "CreateIndex" -RecommendedActionName "IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893" -State Pending -ResourceGroupName : WIRunnersProd -ServerName : wi-runner-australia-east -AdvisorName : CreateIndex -RecommendedActionName : IR_[test_schema]_[test_table_0.0361551]_6C7AE8CC9C87E7FD5893 -Details : {[indexName, nci_wi_test_table_0.0361551_6C7AE8CC9C87E7FD5893], [indexType, - NONCLUSTERED], [schema, [test_schema]], [table, [test_table_0.0361551]]...} -ErrorDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionErrorInfo -EstimatedImpact : {ActionDuration, SpaceChange} -ExecuteActionDuration : PT1M -ExecuteActionInitiatedBy : User -ExecuteActionInitiatedTime : 4/21/2016 3:24:47 PM -ExecuteActionStartTime : 4/21/2016 3:24:47 PM -ImplementationDetails : Microsoft.Azure.Management.Sql.Models.RecommendedActionImplementationInfo -IsArchivedAction : False -IsExecutableAction : True -IsRevertableAction : True -LastRefresh : 4/21/2016 3:24:47 PM -LinkedObjects : {} -ObservedImpact : {CpuUtilization, LogicalReads, LogicalWrites, QueriesWithImprovedPerformance...} -RecommendationReason : -RevertActionDuration : -RevertActionInitiatedBy : -RevertActionInitiatedTime : -RevertActionStartTime : -Score : 2 -State : Microsoft.Azure.Management.Sql.Models.RecommendedActionStateInfo -TimeSeries : {} -ValidSince : 4/21/2016 3:24:47 PM -``` - -Updates state of server recommended action named "IR_\[test_schema\]_\[test_table_0.0361551\]_6C7AE8CC9C87E7FD5893" to "Pending" - -## PARAMETERS - -### -AdvisorName -Specifies the name of the advisor that contains the recommended action. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecommendedActionName -Specifies the name of the recommended action for which this cmdlet updates the state. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -Specifies the new value to which this cmdlet updates the recommended action state. -The acceptable values for this parameter are: -- Active -- Pending -- PendingRevert -- RevertCancelled -- Ignored -- Resolved - -```yaml -Type: Microsoft.Azure.Commands.Sql.RecommendedAction.Cmdlet.RecommendedActionState -Parameter Sets: (All) -Aliases: -Accepted values: Active, Pending, PendingRevert, RevertCancelled, Ignored, Resolved - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Sql.RecommendedAction.Cmdlet.RecommendedActionState - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.RecommendedAction.Model.AzureSqlServerRecommendedActionModel - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, sql, server, mssql, advisor, recommendedaction - -## RELATED LINKS - -[Get-AzureRmSqlServerAdvisor](./Get-AzureRmSqlServerAdvisor.md) - -[Get-AzureRmSqlServerRecommendedAction](./Get-AzureRmSqlServerRecommendedAction.md) - -[Set-AzureRmSqlDatabaseRecommendedActionState](./Set-AzureRmSqlDatabaseRecommendedActionState.md) - -[Set-AzureRmSqlElasticPoolRecommendedActionState](./Set-AzureRmSqlElasticPoolRecommendedActionState.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerThreatDetectionPolicy.md b/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerThreatDetectionPolicy.md deleted file mode 100644 index ac77c17bff..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerThreatDetectionPolicy.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 2B82F5BA-ABC6-4B37-B641-353CFE814290 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/set-azurermsqlserverthreatdetectionpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerThreatDetectionPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerThreatDetectionPolicy.md ---- - -# Set-AzureRmSqlServerThreatDetectionPolicy - -## SYNOPSIS -Sets a threat detection policy on a server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSqlServerThreatDetectionPolicy [-PassThru] [-NotificationRecipientsEmails <String>] - [-EmailAdmins <Boolean>] [-ExcludedDetectionType <DetectionType[]>] [-StorageAccountName <String>] - [-RetentionInDays <UInt32>] -ServerName <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSqlServerThreatDetectionPolicy** cmdlet sets a threat detection policy on an Azure SQL server. -In order to enable threat detection on a server an auditing policy must be enabled on that server. -To use this cmdlet, specify the *ResourceGroupName* and ServerName parameters to identify the server. - -## EXAMPLES - -### Example 1: Set the threat detection policy for a database -``` -PS C:\>Set-AzureRmSqlServerThreatDetectionPolicy -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -NotificationRecipientsEmails "admin01@contoso.com;secadmin@contoso.com" -EmailAdmins $False -ExcludedDetectionType "Sql_Injection_Vulnerability","SQL_Injection" -StorageAccountName "mystorageAccount" -``` - -This command sets the threat detection policy for a server named Server01. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAdmins -Specifies whether the threat detection policy contacts administrators by using email. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExcludedDetectionType -Specifies an array of detection types to exclude from the policy. -The acceptable values for this parameter are: -- Sql_Injection -- Sql_Injection_Vulnerability -- Access_Anomaly -- None - -```yaml -Type: Microsoft.Azure.Commands.Sql.ThreatDetection.Model.DetectionType[] -Parameter Sets: (All) -Aliases: -Accepted values: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, None - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NotificationRecipientsEmails -Specifies a semicolon-separated list of email addresses to which the policy sends alerts. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the server belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RetentionInDays -The number of retention days for the audit logs - -```yaml -Type: System.Nullable`1[System.UInt32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountName -Specifies the name of the storage account to be used. Wildcards are not permitted. This parameter is not required. When this parameter is not provided, the cmdlet will use the storage account that was defined previously as part of the threat detection policy of the database. If this is the first time a database theat detection policy is defined and this parameter is not provided, the cmdlet will fail. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### Microsoft.Azure.Commands.Sql.ThreatDetection.Model.DetectionType[] - -### System.Nullable`1[[System.UInt32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ThreatDetection.Model.ServerThreatDetectionPolicyModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlServerThreatDetectionPolicy](./Get-AzureRmSqlServerThreatDetectionPolicy.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerTransparentDataEncryptionProtector.md b/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerTransparentDataEncryptionProtector.md deleted file mode 100644 index 13f8ae1459..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerTransparentDataEncryptionProtector.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/set-azurermsqlservertransparentdataencryptionprotector -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerTransparentDataEncryptionProtector.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerTransparentDataEncryptionProtector.md ---- - -# Set-AzureRmSqlServerTransparentDataEncryptionProtector - -## SYNOPSIS -Sets the Transparent Data Encryption (TDE) protector for a SQL server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSqlServerTransparentDataEncryptionProtector [-Type] <EncryptionProtectorType> [[-KeyId] <String>] - [-Force] [-AsJob] [-ServerName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Set-AzureRmSqlServerTransparentDataEncryptionProtector cmdlet sets the TDE protector for a SQL server. -Changing the TDE protector type will rotate the protector. - -## EXAMPLES - -### Example 1: Set the Transparent Data Encryption (TDE) protector type to ServiceManaged -``` -PS C:\> Set-AzureRmSqlServerTransparentDataEncryptionProtector -Type ServiceManaged -ServerName 'ContosoServer' -ResourceGroup 'ContosoResourceGroup' -``` - -This command updates a server's TDE protector type to Service Managed. -ResourceGroupName ServerName Type ServerKeyVaultKeyName ------------------ ---------- ---- --------------------- -ContosoResourceGroup ContosoServer ServiceManaged ServiceManaged - -### Example 2: Set the Transparent Data Encryption protector type to Azure Key Vault -``` -PS C:\> Set-AzureRmSqlServerTransparentDataEncryptionProtector -Type AzureKeyVault -KeyId 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' -ServerName 'ContosoServer' -ResourceGroup 'ContosoResourceGroup' -``` - -This command updates a server to use the Server Key Vault Key with Id 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' as the TDE protector. -ResourceGroupName ServerName Type ServerKeyVaultKeyName ------------------ ---------- ---- --------------------- -ContosoResourceGroup ContosoServer AzureKeyVault contoso_contosokey_01234567890123456789012345678901 - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Skip confirmation message for performing the action - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyId -The Azure Key Vault KeyId. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The Azure Sql Server name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Type -The Azure Sql Database TDE protector type. - -```yaml -Type: Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.EncryptionProtectorType -Parameter Sets: (All) -Aliases: -Accepted values: AzureKeyVault, ServiceManaged - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.EncryptionProtectorType - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.AzureSqlServerTransparentDataEncryptionProtectorModel - -## NOTES - -## RELATED LINKS - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerVirtualNetworkRule.md b/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerVirtualNetworkRule.md deleted file mode 100644 index 8442c9649b..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Set-AzureRmSqlServerVirtualNetworkRule.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/set-azurermsqlservervirtualnetworkrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerVirtualNetworkRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerVirtualNetworkRule.md ---- - -# Set-AzureRmSqlServerVirtualNetworkRule - -## SYNOPSIS -Modifies the configuration of an Azure SQL Server Virtual Network Rule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSqlServerVirtualNetworkRule -VirtualNetworkRuleName <String> -VirtualNetworkSubnetId <String> - [-IgnoreMissingVnetServiceEndpoint] [-AsJob] -ServerName <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -This command modifies the configuration of an Azure SQL Server Virtual Network Rule. -To control the set of virtual network rules in the server, use 'Add-AzureRmSqlServerVirtualNetworkRule' and 'Remove-AzureRmSqlServerVirtualNetworkRule' instead. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $virtualNetworkRule = Set-AzureRmSqlServerVirtualNetworkRule -ResourceGroupName rg -ServerName serverName -VirtualNetworkRuleName virtualNetworkRuleName -VirtualNetworkSubnetId virtualNetworkSubnetId -``` - -Modifies an existing virtual network rule with the new virtual network subnet id which contains information about the new virtual network - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreMissingVnetServiceEndpoint -Create firewall rule before the virtual network has vnet service endpoint enabled. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The Azure Sql Server name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkRuleName -The name of the Azure Sql Server Virtual Network Rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkSubnetId -The Virtual Network Subnet Id for the rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.VirtualNetworkRule.Model.AzureSqlServerVirtualNetworkRuleModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Start-AzureRmSqlDatabaseExecuteIndexRecommendation.md b/azurermps-6.13.0/AzureRM.Sql/Start-AzureRmSqlDatabaseExecuteIndexRecommendation.md deleted file mode 100644 index a6865b6d68..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Start-AzureRmSqlDatabaseExecuteIndexRecommendation.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 0EA0B131-A3D0-43CA-8517-9E724A11B04F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/start-azurermsqldatabaseexecuteindexrecommendation -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Start-AzureRmSqlDatabaseExecuteIndexRecommendation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Start-AzureRmSqlDatabaseExecuteIndexRecommendation.md ---- - -# Start-AzureRmSqlDatabaseExecuteIndexRecommendation - -## SYNOPSIS -Starts the workflow that runs a recommended index operation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Start-AzureRmSqlDatabaseExecuteIndexRecommendation -ServerName <String> -DatabaseName <String> - -IndexRecommendationName <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Start-AzureRmSqlDatabaseExecuteIndexRecommendation** cmdlet starts the workflow that runs a recommended index operation for an Azure SQL Database. - -## EXAMPLES - -### Example 1: Run an index recommendation -``` -PS C:\>Start-AzureRmSqlDatabaseExecuteIndexRecommendation -ResourceGroup "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -IndexRecommendationName "INDEX_NAME" -``` - -This command runs an index recommendation. - -## PARAMETERS - -### -DatabaseName -Specifies the name of the database for which this cmdlet starts the workflow. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IndexRecommendationName -Specifies the name of the index recommendation that this cmdlet runs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the server is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the server that hosts the database for which this cmdlet starts a workflow. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Model.IndexRecommendation - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlDatabaseIndexRecommendations](./Get-AzureRmSqlDatabaseIndexRecommendations.md) - -[Stop-AzureRmSqlDatabaseExecuteIndexRecommendation](./Stop-AzureRmSqlDatabaseExecuteIndexRecommendation.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Start-AzureRmSqlDatabaseVulnerabilityAssessmentScan.md b/azurermps-6.13.0/AzureRM.Sql/Start-AzureRmSqlDatabaseVulnerabilityAssessmentScan.md deleted file mode 100644 index 337cd84d29..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Start-AzureRmSqlDatabaseVulnerabilityAssessmentScan.md +++ /dev/null @@ -1,314 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/start-azurermsqldatabasevulnerabilityassessmentscan -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Start-AzureRmSqlDatabaseVulnerabilityAssessmentScan.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Start-AzureRmSqlDatabaseVulnerabilityAssessmentScan.md ---- - -# Start-AzureRmSqlDatabaseVulnerabilityAssessmentScan - -## SYNOPSIS -Starts a vulnerability assessment scan. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Start-AzureRmSqlDatabaseVulnerabilityAssessmentScan [-InputObject <AzureSqlDatabaseModel>] [-AsJob] - [-ScanId <String>] [-ServerName] <String> [-DatabaseName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Start-AzureRmSqlDatabaseVulnerabilityAssessmentScan** cmdlet triggers a scan with ScanId identifier. -Scan results will be saved under the storage defined by the Set-AzureRmSqlDatabaseVulnerabilityAssessmentSettings cmdlet, under scans/{ServerName}/{DatabaseName}/scan_{ScanId}.json -You can monitor the progress of the scan by using the *Get-AzureRmSqlDatabaseVulnerabilityAssessmentScanRecord* cmdlet with the scanId parameter and look at the State returned parameter. -Note that you need to run *Enable-AzureRmSqlServerAdvancedThreatProtection* and *Set-AzureRmSqlDatabaseVulnerabilityAssessmentSettings* cmdlet as a prerequisite for using this cmdlets. - -## EXAMPLES - -### Example 1 - Starts a vulnerability assessment scan -```powershell -PS C:\> Start-AzureRmSqlDatabaseVulnerabilityAssessmentScan ` - -ResourceGroupName "ResourceGroup01" ` - -ServerName "Server01" ` - -DatabaseName "Database01" ` - -ScanId "myScan" - -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -ScanId : myScan -TriggerType : OnDemand -State : Fail -StartTime : 6/11/2018 1:57:27 PM -EndTime : 6/11/2018 1:57:31 PM -Errors : {} -ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment - scans/Server01/Database01/scan_myScan.json -NumberOfFailedSecurityChecks : 9 -``` - -### Example 2 - Starts a vulnerability assessment scan without a specific scan ID -```powershell -PS C:\> Start-AzureRmSqlDatabaseVulnerabilityAssessmentScan ` - -ResourceGroupName "ResourceGroup01" ` - -ServerName "Server01" ` - -DatabaseName "Database01" - -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -ScanId : 20180611_135726 -TriggerType : OnDemand -State : Fail -StartTime : 6/11/2018 1:57:27 PM -EndTime : 6/11/2018 1:57:31 PM -Errors : {} -ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment - scans/Server01/Database01/scan_myScan.json -NumberOfFailedSecurityChecks : 9 -``` - -This command generates a scan ID in the format of "yyyyMMdd_HHmmss" from the UTC date time. - -### Example 3 - Starts a vulnerability assessment scan in the background -```powershell -PS C:\> Start-AzureRmSqlDatabaseVulnerabilityAssessmentScan ` - -ResourceGroupName "ResourceGroup01" ` - -ServerName "Server01" ` - -DatabaseName "Database01" ` - -ScanId "myScan" ` - -AsJob -PS C:\> $scanJob | Wait-Job -PS C:\> $scanJob | Receive-Job - -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -ScanId : myScan -TriggerType : OnDemand -State : Fail -StartTime : 6/11/2018 1:57:27 PM -EndTime : 6/11/2018 1:57:31 PM -Errors : {} -ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment - scans/Server01/Database01/scan_myScan.json -NumberOfFailedSecurityChecks : 9 -``` - -### Example 4 - Starts a vulnerability assessment scan with a database object -```powershell -PS C:\> Get-AzureRmSqlDatabase ` - -ResourceGroupName "ResourceGroup01" ` - -ServerName "Server01" ` - -DatabaseName "Database01" ` - | Start-AzureRmSqlDatabaseVulnerabilityAssessmentScan - -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -ScanId : 20180611_135726 -TriggerType : OnDemand -State : Fail -StartTime : 6/11/2018 1:57:27 PM -EndTime : 6/11/2018 1:57:31 PM -Errors : {} -ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment - scans/Server01/Database01/scan_myScan.json -NumberOfFailedSecurityChecks : 9 -``` - -### Example 5 - Starts a vulnerability assessment scan on all the databases under a server -```powershell -PS C:\> Get-AzureRmSqlDatabase ` - -ResourceGroupName "ResourceGroup01" ` - -ServerName "Server01" ` - | where {$_.DatabaseName -ne "master"} ` - | Start-AzureRmSqlDatabaseVulnerabilityAssessmentScan - -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -ScanId : 20180611_135726 -TriggerType : OnDemand -State : Fail -StartTime : 6/11/2018 1:57:27 PM -EndTime : 6/11/2018 1:57:31 PM -Errors : {} -ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment - scans/Server01/Database01/scan_myScan.json -NumberOfFailedSecurityChecks : 9 - - -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database02 -ScanId : 20180611_135726 -TriggerType : OnDemand -State : Fail -StartTime : 6/11/2018 1:57:27 PM -EndTime : 6/11/2018 1:57:31 PM -Errors : {} -ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment - scans/Server01/Database01/scan_myScan.json -NumberOfFailedSecurityChecks : 9 -``` - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -SQL Database name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The database object to get Vulnerability Assessment settings for - -```yaml -Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScanId -Specifies the scan ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -SQL Database server name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel -Parameters: InputObject (ByValue) - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.DatabaseVulnerabilityAssessmentScanRecordModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Start-AzureRmSqlServerUpgrade.md b/azurermps-6.13.0/AzureRM.Sql/Start-AzureRmSqlServerUpgrade.md deleted file mode 100644 index f81be4b70f..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Start-AzureRmSqlServerUpgrade.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 69A26BF3-7FE7-41ED-8C21-C8DC72D09615 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/start-azurermsqlserverupgrade -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Start-AzureRmSqlServerUpgrade.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Start-AzureRmSqlServerUpgrade.md ---- - -# Start-AzureRmSqlServerUpgrade - -## SYNOPSIS -Starts the upgrade of a SQL Database server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Start-AzureRmSqlServerUpgrade -ServerVersion <String> [-ScheduleUpgradeAfterUtcDateTime <DateTime>] - [-DatabaseCollection <RecommendedDatabaseProperties[]>] - [-ElasticPoolCollection <UpgradeRecommendedElasticPoolProperties[]>] -ServerName <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Start-AzureRmSqlServerUpgrade** cmdlet starts the upgrade of an Azure SQL Database server version 11 to version 12. -You can monitor the progress of an upgrade by using the Get-AzureRmSqlServerUpgrade cmdlet. - -## EXAMPLES - -### Example 1: Upgrade a server -``` -PS C:\>Start-AzureRmSqlServerUpgrade -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ServerVersion 12.0 -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -ServerVersion : 12.0 -ScheduleUpgradeAfterUtcDateTime : -DatabaseCollection : -``` - -This command upgrades the server named server01 assigned to resource group TesourceGroup01. - -### Example 2: Upgrade a server by using schedule time and database recommendation -``` -PS C:\>$ScheduleTime = (Get-Date).AddMinutes(5).ToUniversalTime() -PS C:\> $DatabaseMap = New-Object -TypeName Microsoft.Azure.Management.Sql.Models.RecommendedDatabaseProperties -PS C:\> $DatabaseMap.Name = "contosodb" -PS C:\> $DatabaseMap.TargetEdition = "Standard" -PS C:\> $DatabaseMap.TargetServiceLevelObjective = "S0" -PS C:\> Start-AzureRmSqlServerUpgrade -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ServerVersion 12.0 -ScheduleUpgradeAfterUtcDateTime $ScheduleTime -DatabaseCollection ($DatabaseMap) -``` - -The first command creates a time five minutes in the future by using the Get-Date cmdlet. -The command stores the date in the variable $ScheduleTime. -For more information, type `Get-Help Get-Date`. -The second command creates a **RecommendedDatabaseProperties** object, and then stores that object in the variable $DatabaseMap. -The next three commands assign values to properties of the object stored in $DatabaseMap. -The final command upgrades the existing server named Server01 to version 12.0. -The earliest time to upgrade is five minutes after you run the command, as specified by the $ScheduleTime variable. -After the upgrade, the database contosodb will be running the Standard edition and have the Service Level Objective S0. - -## PARAMETERS - -### -DatabaseCollection -Specifies an array of **RecommendedDatabaseProperties** objects that this cmdlet uses for the server upgrade. - -```yaml -Type: Microsoft.Azure.Management.Sql.LegacySdk.Models.RecommendedDatabaseProperties[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ElasticPoolCollection -Specifies an array of **UpgradeRecommendedElasticPoolProperties** objects to use for the server upgrade. - -```yaml -Type: Microsoft.Azure.Management.Sql.LegacySdk.Models.UpgradeRecommendedElasticPoolProperties[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the server is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScheduleUpgradeAfterUtcDateTime -Specifies the earliest time, as a **DateTime** object, to upgrade the server. -Specify a value in the ISO8601 format, in Coordinated Universal Time (UTC). -For more information, type `Get-Help Get-Date`. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server that this cmdlet upgrades. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerVersion -Specifies the version to which this cmdlet upgrades the server. -The only valid value is 12.0. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ServerUpgrade.Model.AzureSqlServerUpgradeStartModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlServerUpgrade](./Get-AzureRmSqlServerUpgrade.md) - -[Stop-AzureRmSqlServerUpgrade](./Stop-AzureRmSqlServerUpgrade.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Start-AzureRmSqlSyncGroupSync.md b/azurermps-6.13.0/AzureRM.Sql/Start-AzureRmSqlSyncGroupSync.md deleted file mode 100644 index dfec3d255f..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Start-AzureRmSqlSyncGroupSync.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/start-azurermsqlsyncgroupsync -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Start-AzureRmSqlSyncGroupSync.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Start-AzureRmSqlSyncGroupSync.md ---- - -# Start-AzureRmSqlSyncGroupSync - -## SYNOPSIS -Starts a sync group synchronization. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Start-AzureRmSqlSyncGroupSync [-SyncGroupName] <String> [-PassThru] [-ServerName] <String> - [-DatabaseName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Start-AzureRmSqlSyncGroupSync** cmdlet starts a sync group synchronization. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Start-AzureRmSqlSyncGroupSync -SyncGroupName mysg [-ServerName] mysrv [-DatabaseName] mydb [-ResourceGroupName] myrg -``` - -This command starts a round of synchronization for the sync group mysg. - -## PARAMETERS - -### -DatabaseName -The name of the Azure SQL Database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Defines Whether return the sync group - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The name of the Azure SQL Server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SyncGroupName -The sync group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncGroupModel - -## NOTES - -## RELATED LINKS - -[Stop-AzureRmSqlSyncGroupSync](./Stop-AzureRmSqlSyncGroupSync.md) - diff --git a/azurermps-6.13.0/AzureRM.Sql/Stop-AzureRmSqlDatabaseActivity.md b/azurermps-6.13.0/AzureRM.Sql/Stop-AzureRmSqlDatabaseActivity.md deleted file mode 100644 index 1bce0a079a..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Stop-AzureRmSqlDatabaseActivity.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: B5C909D7-6087-463A-83BF-99DD196B9862 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/stop-azurermsqldatabaseactivity -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Stop-AzureRmSqlDatabaseActivity.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Stop-AzureRmSqlDatabaseActivity.md ---- - -# Stop-AzureRmSqlDatabaseActivity - -## SYNOPSIS -Cancels the asynchronous updates operation on the database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Stop-AzureRmSqlDatabaseActivity [-ServerName] <String> [-ElasticPoolName <String>] -DatabaseName <String> - [-OperationId <Guid>] [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Stop-AzureRmSqlDatabaseActivity** cmdlet cancels the asynchronous updates operation on the database. - -## EXAMPLES - -### Example 1: Cancel the asynchronous updates operation on the database -``` -PS C:\>Stop-AzureRmSqlDatabaseActivity -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -OperationId af97005d-9243-4f8a-844e-402d1cc855f5 - -OperationId : af97005d-9243-4f8a-844e-402d1cc855f5 -ServerName : Server01 -DatabaseName : Database01 -State : CANCELLED -Operation : UpdateLogicalDatabase -ErrorCode : -ErrorMessage : -ErrorSeverity : -StartTime : 10/15/2017 02:49:42 PM -EndTime : 10/15/2017 02:49:43 PM -PercentComplete : -Properties : Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseActivityModel+DatabaseState -``` - -This command cancels the asynchronous updates operation on the database. - -## PARAMETERS - -### -DatabaseName -Specifies the name of the database for which this cmdlet gets status. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ElasticPoolName -The name of the Azure SQL Elastic Pool. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OperationId -Specifies the ID of the operation that this cmdlet gets. - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the database is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the Microsoft SQL Server that hosts the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseActivityModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Stop-AzureRmSqlDatabaseExecuteIndexRecommendation.md b/azurermps-6.13.0/AzureRM.Sql/Stop-AzureRmSqlDatabaseExecuteIndexRecommendation.md deleted file mode 100644 index 0bb29e3834..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Stop-AzureRmSqlDatabaseExecuteIndexRecommendation.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 4D2E0956-FBFA-43CC-ABE3-A6CBB9409263 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/stop-azurermsqldatabaseexecuteindexrecommendation -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Stop-AzureRmSqlDatabaseExecuteIndexRecommendation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Stop-AzureRmSqlDatabaseExecuteIndexRecommendation.md ---- - -# Stop-AzureRmSqlDatabaseExecuteIndexRecommendation - -## SYNOPSIS -Stops the workflow that runs a recommended index operation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Stop-AzureRmSqlDatabaseExecuteIndexRecommendation -ServerName <String> -DatabaseName <String> - -IndexRecommendationName <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Stop-AzureRmSqlDatabaseExecuteIndexRecommendation** cmdlet stops the workflow that runs a recommended index operation. - -## EXAMPLES - -### Example 1: Stop running an index recommendation -``` -PS C:\>Stop-AzureRmSqlDatabaseExecuteIndexRecommendation -ResourceGroup "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -IndexRecommendationName "INDEX_NAME" -``` - -This command stops running an index recommendation. - -## PARAMETERS - -### -DatabaseName -Specifies the name of the database for which this cmdlet stops the workflow. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IndexRecommendationName -Specifies the name of the index recommendation that this cmdlet stops. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the server is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the server that hosts the database for which this cmdlet stops a workflow. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Model.IndexRecommendation - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlDatabaseIndexRecommendations](./Get-AzureRmSqlDatabaseIndexRecommendations.md) - -[Start-AzureRmSqlDatabaseExecuteIndexRecommendation](./Start-AzureRmSqlDatabaseExecuteIndexRecommendation.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Stop-AzureRmSqlElasticPoolActivity.md b/azurermps-6.13.0/AzureRM.Sql/Stop-AzureRmSqlElasticPoolActivity.md deleted file mode 100644 index b46352268b..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Stop-AzureRmSqlElasticPoolActivity.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/stop-azurermsqlelasticpoolactivity -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Stop-AzureRmSqlElasticPoolActivity.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Stop-AzureRmSqlElasticPoolActivity.md ---- - -# Stop-AzureRmSqlElasticPoolActivity - -## SYNOPSIS -Cancels the asynchronous update operation on an elastic pool. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Stop-AzureRmSqlElasticPoolActivity [-PassThru] [-ServerName] <String> [-ElasticPoolName] <String> - [-OperationId <Guid>] [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Stop-AzureRmSqlElasticPoolActivity** cmdlet cancels the asynchronous update operation on an elastic pool. - -## EXAMPLES - -### Example 1: Cancel the asynchronous update operation on an elastic pool -``` -PS C:\> Stop-AzureRmSqlElasticPoolActivity -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -ElasticPoolName "ElasticPool01" -OperationId af97005d-9243-4f8a-844e-402d1cc855f5 - -OperationId : af97005d-9243-4f8a-844e-402d1cc855f5 -ServerName : Server01 -DatabaseName : ElasticPool01 -State : CANCELLED -Operation : UpdateLogicalElasticPool -ErrorCode : -ErrorMessage : -ErrorSeverity : -StartTime : 10/15/2017 02:49:42 PM -EndTime : 10/15/2017 02:49:43 PM -PercentComplete : -``` - -This command cancels the asynchronous updates operation on the elastic pool. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ElasticPoolName -The name of the Azure SQL Elastic Pool. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OperationId -The ID of the operation to retrieve. - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The name of the Azure SQL Server the Elastic Pool is in. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolActivityModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Stop-AzureRmSqlServerUpgrade.md b/azurermps-6.13.0/AzureRM.Sql/Stop-AzureRmSqlServerUpgrade.md deleted file mode 100644 index 1647120ec6..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Stop-AzureRmSqlServerUpgrade.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 972F4188-52C5-4B92-8B88-E68526537F48 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/stop-azurermsqlserverupgrade -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Stop-AzureRmSqlServerUpgrade.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Stop-AzureRmSqlServerUpgrade.md ---- - -# Stop-AzureRmSqlServerUpgrade - -## SYNOPSIS -Stops the upgrade of a SQL Database server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Stop-AzureRmSqlServerUpgrade [-Force] -ServerName <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Stop-AzureRmSqlServerUpgrade** cmdlet stops the upgrade of an Azure SQL Database server. - -## EXAMPLES - -### Example 1: Stop a server upgrade -``` -PS C:\>Stop-AzureRmSqlServerUpgrade -ResourceGroupName "ResourceGroup01" -ServerName "Server02" -``` - -This command stops the request to upgrade the server named Server02 assigned to the resource group named ResourceGroup01. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the server is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server for which this cmdlet stops an upgrade. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.ServerUpgrade.Model.AzureSqlServerUpgradeModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlServerUpgrade](./Get-AzureRmSqlServerUpgrade.md) - -[Start-AzureRmSqlServerUpgrade](./Start-AzureRmSqlServerUpgrade.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Stop-AzureRmSqlSyncGroupSync.md b/azurermps-6.13.0/AzureRM.Sql/Stop-AzureRmSqlSyncGroupSync.md deleted file mode 100644 index 9153cead87..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Stop-AzureRmSqlSyncGroupSync.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/stop-azurermsqlsyncgroupsync -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Stop-AzureRmSqlSyncGroupSync.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Stop-AzureRmSqlSyncGroupSync.md ---- - -# Stop-AzureRmSqlSyncGroupSync - -## SYNOPSIS -Stops a sync group synchronization. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Stop-AzureRmSqlSyncGroupSync [-SyncGroupName] <String> [-PassThru] [-ServerName] <String> - [-DatabaseName] <String> [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Stop-AzureRmSqlSyncGroupSync** cmdlet stops a sync group synchronization. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Stop-AzureRmSqlSyncGroupSync -SyncGroupName mysg [-ServerName] mysrv [-DatabaseName] mydb [-ResourceGroupName] myrg -``` - -This command stops the synchronization which is ongoing for the sync group mysg. - -## PARAMETERS - -### -DatabaseName -The name of the Azure SQL Database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Defines Whether return the sync group - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The name of the Azure SQL Server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SyncGroupName -The sync group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncGroupModel - -## NOTES - -## RELATED LINKS - -[Start-AzureRmSqlSyncGroupSync](./Start-AzureRmSqlSyncGroupSync.md) - diff --git a/azurermps-6.13.0/AzureRM.Sql/Suspend-AzureRmSqlDatabase.md b/azurermps-6.13.0/AzureRM.Sql/Suspend-AzureRmSqlDatabase.md deleted file mode 100644 index 7ea6d6049a..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Suspend-AzureRmSqlDatabase.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 7302D785-9DD0-4CC0-93C9-9A6EA60591CF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/suspend-azurermsqldatabase -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Suspend-AzureRmSqlDatabase.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Suspend-AzureRmSqlDatabase.md ---- - -# Suspend-AzureRmSqlDatabase - -## SYNOPSIS -Suspends a SQL Data Warehouse database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Suspend-AzureRmSqlDatabase [-ServerName] <String> -DatabaseName <String> [-AsJob] [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Suspend-AzureRmSqlDatabase** cmdlet suspends an Azure SQL Data Warehouse database. - -## EXAMPLES - -### Example 1: Suspends an Azure SQL Data Warehouse database -``` -PS C:\>Suspend-AzureRmSqlDatabase -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -``` - -This command suspends an active Azure SQL Data Warehouse database. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the database that this cmdlet suspends. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the server is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server which hosts the database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel - -## NOTES -* The **Suspend-AzureRmSqlDatabase** cmdlet works only on Azure SQL Data Warehouse databases. This operation is not supported on Azure SQL Database Basic, Standard and Premium editions. - -## RELATED LINKS - -[Get-AzureRmSqlDatabase](./Get-AzureRmSqlDatabase.md) - -[New-AzureRmSqlDatabase](./New-AzureRmSqlDatabase.md) - -[Remove-AzureRmSqlDatabase](./Remove-AzureRmSqlDatabase.md) - -[Resume-AzureRmSqlDatabase](./Resume-AzureRmSqlDatabase.md) - -[Set-AzureRmSqlDatabase](./Set-AzureRmSqlDatabase.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - - diff --git a/azurermps-6.13.0/AzureRM.Sql/Switch-AzureRmSqlDatabaseFailoverGroup.md b/azurermps-6.13.0/AzureRM.Sql/Switch-AzureRmSqlDatabaseFailoverGroup.md deleted file mode 100644 index 8893596f6e..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Switch-AzureRmSqlDatabaseFailoverGroup.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/switch-azurermsqldatabasefailovergroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Switch-AzureRmSqlDatabaseFailoverGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Switch-AzureRmSqlDatabaseFailoverGroup.md ---- - -# Switch-AzureRmSqlDatabaseFailoverGroup - -## SYNOPSIS -Executes a failover of an Azure SQL Database Failover Group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Switch-AzureRmSqlDatabaseFailoverGroup [-ServerName] <String> [[-FailoverGroupName] <String>] [-AllowDataLoss] - [-AsJob] [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -This command swaps the roles of the servers in a Failover Group and switches all secondary databases to the primary role. All new TDS sessions are automatically re-routed to the secondary server after the DNS client cache is refreshed. When the original primary server is back online, all formerly primary databases in it will switch to the secondary role. -The Failover Group's secondary server must be used to execute this command. - -## EXAMPLES - -### Example 1 -``` -C:\> Get-AzureRmSqlDatabaseFailoverGroup -ResourceGroupName rg -ServerName secondaryserver -FailoverGroupName fg | Switch-AzureRmSqlDatabaseFailoverGroup -AllowDataLoss -``` - -Issue a failover operation allowing data loss by piping in the Failover Group. - -### Example 2 -``` -C:\> Switch-AzureRmSqlDatabaseFailoverGroup -ResourceGroupName rg -ServerName secondaryserver -FailoverGroupName fg -``` - -Issue a best effort failover operation that will either succeed without losing data or fail and roll back. - -## PARAMETERS - -### -AllowDataLoss -Complete the failover even if doing so may result in data loss. This will allow the failover to proceed even if a primary database is unavailable. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FailoverGroupName -The name of the Azure SQL Database Failover Group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The name of the secondary Azure SQL Database Server of the Failover Group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.FailoverGroup.Model.AzureSqlFailoverGroupModel - -## NOTES - -## RELATED LINKS - -[New-AzureRmSqlDatabaseFailoverGroup](./New-AzureRmSqlDatabaseFailoverGroup.md) - -[Set-AzureRmSqlDatabaseFailoverGroup](./Set-AzureRmSqlDatabaseFailoverGroup.md) - -[Get-AzureRmSqlDatabaseFailoverGroup](./Get-AzureRmSqlDatabaseFailoverGroup.md) - -[Add-AzureRmSqlDatabaseToFailoverGroup](./Add-AzureRmSqlDatabaseToFailoverGroup.md) - -[Remove-AzureRmSqlDatabaseFromFailoverGroup](./Remove-AzureRmSqlDatabaseFromFailoverGroup.md) - -[Remove-AzureRmSqlDatabaseFailoverGroup](./Remove-AzureRmSqlDatabaseFailoverGroup.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) diff --git a/azurermps-6.13.0/AzureRM.Sql/Update-AzureRmSqlDatabaseVulnerabilityAssessmentSettings.md b/azurermps-6.13.0/AzureRM.Sql/Update-AzureRmSqlDatabaseVulnerabilityAssessmentSettings.md deleted file mode 100644 index 392e37a2f1..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Update-AzureRmSqlDatabaseVulnerabilityAssessmentSettings.md +++ /dev/null @@ -1,382 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/Update-AzureRmSqlDatabaseVulnerabilityAssessmentSettings -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Update-AzureRmSqlDatabaseVulnerabilityAssessmentSettings.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Update-AzureRmSqlDatabaseVulnerabilityAssessmentSettings.md ---- - -# Update-AzureRmSqlDatabaseVulnerabilityAssessmentSettings - -## SYNOPSIS -Updates the vulnerability assessment settings of a database. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### UpdateSettingsWithStorageAccountNameParameterSet (Default) -``` -Update-AzureRmSqlDatabaseVulnerabilityAssessmentSettings [-StorageAccountName <String>] - [-ScanResultsContainerName <String>] [-RecurringScansInterval <RecurringScansInterval>] - [-EmailAdmins <Boolean>] [-NotificationEmail <String[]>] [-ServerName] <String> [-DatabaseName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### UpdateByInputObjectParameterSet -``` -Update-AzureRmSqlDatabaseVulnerabilityAssessmentSettings - -InputObject <DatabaseVulnerabilityAssessmentSettingsModel> [-RecurringScansInterval <RecurringScansInterval>] - [-EmailAdmins <Boolean>] [-NotificationEmail <String[]>] [-ServerName] <String> [-DatabaseName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### UpdateSettingsWithBlobStorageSasUri -``` -Update-AzureRmSqlDatabaseVulnerabilityAssessmentSettings -BlobStorageSasUri <Uri> - [-RecurringScansInterval <RecurringScansInterval>] [-EmailAdmins <Boolean>] [-NotificationEmail <String[]>] - [-ServerName] <String> [-DatabaseName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureRmSqlDatabaseVulnerabilityAssessmentSettings** cmdlet updates the vulnerability assessment settings of an Azure SQL Database. -Note that you need to run *Enable-AzureRmSqlServerAdvancedThreatProtection* cmdlet as a prerequisite for using this cmdlet. - -## EXAMPLES - -### Example 1: Update Vulnerability Assessment settings with storage account name -```powershell -PS C:\> Update-AzureRmSqlDatabaseVulnerabilityAssessmentSettings ` - -ResourceGroupName "ResourceGroup01"` - -ServerName "Server01"` - -DatabaseName "Database01" ` - -StorageAccountName "mystorage" ` - -ScanResultsContainerName "vulnerability-assessment" ` - -RecurringScansInterval Weekly ` - -EmailSubscriptionAdmins True ` - -NotificationEmail {mail1@mail.com , mail2@mail.com} - -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -StorageAccountName : mystorage -ScanResultsContainerName : vulnerability-assessment -RecurringScansInterval : Weekly -EmailSubscriptionAdmins : True -NotificationEmail : {mail1@mail.com , mail2@mail.com} -``` - -### Example 2: Update Vulnerability Assessment settings with blob storage SAS URI -```powershell -PS C:\> Update-AzureRmSqlDatabaseVulnerabilityAssessmentSettings ` - -ResourceGroupName "ResourceGroup01"` - -ServerName "Server01"` - -DatabaseName "Database01" ` - -BlobStorageSasUri "https://mystorage.blob.core.windows.net/vulnerability-assessment?st=XXXXXX" ` - -RecurringScansInterval Weekly ` - -EmailSubscriptionAdmins True ` - -NotificationEmail {mail1@mail.com , mail2@mail.com} - -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -StorageAccountName : mystorage -ScanResultsContainerName : vulnerability-assessment -RecurringScansInterval : Weekly -EmailSubscriptionAdmins : True -NotificationEmail : {mail1@mail.com , mail2@mail.com} -``` - -### Example 3: Update the Vulnerability Assessment settings from DatabaseVulnerabilityAssessmentSettingsModel instance definition -```powershell -PS C:\> Update-AzureRmSqlDatabaseVulnerabilityAssessmentSettings ` - -ResourceGroupName "ResourceGroup01"` - -ServerName "Server01"` - -DatabaseName "Database01" ` - -StorageAccountName "mystorage" ` - -ScanResultsContainerName "vulnerability-assessment" ` - -RecurringScansInterval Weekly ` - -EmailSubscriptionAdmins True ` - -NotificationEmail {mail1@mail.com , mail2@mail.com} - -PS C:\> Get-AzureRmSqlDatabaseVulnerabilityAssessmentSettings ` - -ResourceGroupName "ResourceGroup01" ` - -ServerName "Server01" ` - -DatabaseName "Database01" ` - | Update-AzureRmSqlDatabaseVulnerabilityAssessmentSettings ` - -ResourceGroupName "ResourceGroup02" ` - -ServerName "Server02" ` - -DatabaseName "Database02" - -ResourceGroupName : ResourceGroup02 -ServerName : Server02 -DatabaseName : Database02 -StorageAccountName : mystorage -ScanResultsContainerName : vulnerability-assessment -RecurringScansInterval : Weekly -EmailSubscriptionAdmins : True -NotificationEmail : {mail1@mail.com , mail2@mail.com} -``` - -This command updated the Vulnerability Assessment settings on Database02 from the settings on Database01 - -### Example 4: Update the Vulnerability Assessment settings on all the databases under a server -```powershell -PS C:\> Get-AzureRmSqlDatabase -ResourceGroupName "ResourceGroup01" ` - -ServerName $"Server01" ` - | where {$_.DatabaseName -ne "master"} ` - | Update-AzureRmSqlDatabaseVulnerabilityAssessmentSettings ` - -StorageAccountName "mystorage" ` - -ScanResultsContainerName "vulnerability-assessment" ` - -RecurringScansInterval Weekly ` - -EmailSubscriptionAdmins True ` - -NotificationEmail {mail1@mail.com , mail2@mail.com} - -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -StorageAccountName : mystorage -ScanResultsContainerName : vulnerability-assessment -RecurringScansInterval : Weekly -EmailSubscriptionAdmins : True -NotificationEmail : {mail1@mail.com , mail2@mail.com} - -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database02 -StorageAccountName : mystorage -ScanResultsContainerName : vulnerability-assessment -RecurringScansInterval : Weekly -EmailSubscriptionAdmins : True -NotificationEmail : {mail1@mail.com , mail2@mail.com} -``` - -This command updates all Vulnerability Assessment settings on all the databases under Server01 - -## PARAMETERS - -### -BlobStorageSasUri -A SAS URI to a storage container that will hold the scan results. - -```yaml -Type: System.Uri -Parameter Sets: UpdateSettingsWithBlobStorageSasUri -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseName -SQL Database name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAdmins -A value indicating whether to email service and co-administrators on recurring scan completion. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -The Vulnerability Assessment settings object to set - -```yaml -Type: Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.DatabaseVulnerabilityAssessmentSettingsModel -Parameter Sets: UpdateByInputObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NotificationEmail -A list of mail addresses to send on recurring scan completion. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RecurringScansInterval -The recurring scans interval. - -```yaml -Type: Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.RecurringScansInterval -Parameter Sets: (All) -Aliases: -Accepted values: None, Weekly - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScanResultsContainerName -The name of the storage container that will hold the scan results. - -```yaml -Type: System.String -Parameter Sets: UpdateSettingsWithStorageAccountNameParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -SQL Database server name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountName -The name of the storage account that will hold the scan results. - -```yaml -Type: System.String -Parameter Sets: UpdateSettingsWithStorageAccountNameParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.DatabaseVulnerabilityAssessmentSettingsModel -Parameters: InputObject (ByValue) - -### System.String - -### System.Uri - -### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.RecurringScansInterval - -### System.Boolean - -### System.String[] - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.VulnerabilityAssessment.Model.DatabaseVulnerabilityAssessmentSettingsModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Update-AzureRmSqlSyncGroup.md b/azurermps-6.13.0/AzureRM.Sql/Update-AzureRmSqlSyncGroup.md deleted file mode 100644 index 113f3dbf35..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Update-AzureRmSqlSyncGroup.md +++ /dev/null @@ -1,230 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/update-azurermsqlsyncgroup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Update-AzureRmSqlSyncGroup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Update-AzureRmSqlSyncGroup.md ---- - -# Update-AzureRmSqlSyncGroup - -## SYNOPSIS -Updates an Azure SQL Database Sync Group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Update-AzureRmSqlSyncGroup [-Name] <String> [-IntervalInSeconds <Int32>] [-DatabaseCredential <PSCredential>] - [-SchemaFile <String>] [-ServerName] <String> [-DatabaseName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureRmSqlSyncGroup** cmdlet modifies properties of an Azure SQL Database Sync Group. - -## EXAMPLES - -### Example 1: Update a sync group for an Azure SQL Database. -``` -PS C:\> $credential = Get-Credential -PS C:\> Update-AzureRmSqlSyncGroup -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -Name "SyncGroup01" --DatabaseCredential $credential -IntervalInSeconds 100 -Schema ".\schema.json" | Format-List -ResourceId : /subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup01} -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -SyncGroupName : SyncGroup01 -SyncDatabaseId : subscriptions/{subscriptionId}/resourceGroups/{syncDatabaseResourceGroup01}/servers/{syncDatabaseServer01}/databases/{syncDatabaseName01} -IntervalInSeconds : 100 -ConflictResolutionPolicy: : HubWin -HubDatabaseUserName : myAccount -HubDatabasePassword : -SyncState : NotReady -LastSyncTime : 1/1/0001 12:00:00 AM -Schema : -``` - -This command updates a sync group for an Azure SQL Database. "schema.json" is a file in the local disk. It contains the shema payload in json format. An example of the schema json is: -{"Tables": [{"Columns": [{"QuotedName": "b3ee3a7f-7614-4644-ad07-afa832620b4bManualTestsm4column1"}, {"QuotedName": "b3ee3a7f-7614-4644-ad07-afa832620b4bManualTestsm4column2"}], "QuotedName": "MayQuotedTable1"}, -{"Columns": [{"QuotedName": "b3ee3a7f-7614-4644-ad07-afa832620b4bManualTestsm4column1"}, {"QuotedName": "b3ee3a7f-7614-4644-ad07-afa832620b4bManualTestsm4column2"}], "QuotedName": "MayQuotedTable2"}], -"MasterSyncMemberName": null -} - -## PARAMETERS - -### -DatabaseCredential -The SQL authentication credential of the hub database. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseName -SQL Database name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IntervalInSeconds -The frequency (in seconds) of doing data synchronization. -Default is -1, which means the auto synchronization is not enabled. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The sync group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: SyncGroupName - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SchemaFile -The path of the schema file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerName -The name of the Azure SQL Server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncGroupModel - -## NOTES - -## RELATED LINKS - -[New-AzureRmSqlSyncGroup](./New-AzureRmSqlSyncGroup.md) - -[Remove-AzureRmSqlSyncGroup](./Remove-AzureRmSqlSyncGroup.md) - -[Get-AzureRmSqlSyncGroup](./Get-AzureRmSqlSyncGroup.md) - diff --git a/azurermps-6.13.0/AzureRM.Sql/Update-AzureRmSqlSyncMember.md b/azurermps-6.13.0/AzureRM.Sql/Update-AzureRmSqlSyncMember.md deleted file mode 100644 index e900191063..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Update-AzureRmSqlSyncMember.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/update-azurermsqlsyncmember -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Update-AzureRmSqlSyncMember.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Update-AzureRmSqlSyncMember.md ---- - -# Update-AzureRmSqlSyncMember - -## SYNOPSIS -Updates an Azure SQL Database Sync Member. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Update-AzureRmSqlSyncMember -Name <String> -MemberDatabaseCredential <PSCredential> [-SyncGroupName] <String> - [-ServerName] <String> [-DatabaseName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureRmSqlSyncGroup** cmdlet modifies properties of an Azure SQL Database Sync Member. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $credential = Get-Credential -PS C:\> Update-AzureRmSqlSyncMember -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -SyncGroupName "SyncGroup01" -Name "SyncMember01" --MemberDatabaseCredential $credential | Format-List -ResourceId : subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup01}/syncMembers/{SyncMember01} -ResourceGroupName : ResourceGroup01 -ServerName : Server01 -DatabaseName : Database01 -SyncGroupName : SyncGroup01 -SyncMemberName : SyncMember01 -SyncDirection : OneWayMemberToHub -MemberDatabaseType: : AzureSqlDatabase -SyncAgentId : -SqlServerDatabaseId : -MemberServerName : memberServer01.full.dns.name -MemberDatabaseName : memberDatabase01 -MemberDatabaseUserName : myAccount-new -MemberDatabasePassword : -SyncState : Good -``` - -This command resets the administrator password for the member database. - -## PARAMETERS - -### -DatabaseName -The name of the Azure SQL Database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberDatabaseCredential -The credential (username and password) of the Azure SQL Database. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The sync member name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: SyncMemberName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The name of the Azure SQL Server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SyncGroupName -The sync group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncMemberModel - -## NOTES - -## RELATED LINKS - -[New-AzureRmSqlSyncMember](./New-AzureRmSqlSyncMember.md) - -[Get-AzureRmSqlSyncMember](./Get-AzureRmSqlSyncMember.md) - -[Remove-AzureRmSqlSyncMember](./Remove-AzureRmSqlSyncMember.md) - diff --git a/azurermps-6.13.0/AzureRM.Sql/Update-AzureRmSqlSyncSchema.md b/azurermps-6.13.0/AzureRM.Sql/Update-AzureRmSqlSyncSchema.md deleted file mode 100644 index 2be6e8c4d1..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Update-AzureRmSqlSyncSchema.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/update-azurermsqlsyncschema -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Update-AzureRmSqlSyncSchema.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Update-AzureRmSqlSyncSchema.md ---- - -# Update-AzureRmSqlSyncSchema - -## SYNOPSIS -Update the sync schema for a sync member database or a sync hub database. -It will get the latest database schema from the real database and then use it refresh the schema cached by Sync metadata database. -If "SyncMemberName" is specified, it will refresh the member database schema; if not, it will refresh the hub database schema. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Update-AzureRmSqlSyncSchema [-SyncGroupName] <String> [-SyncMemberName <String>] [-PassThru] - [-ServerName] <String> [-DatabaseName] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureRmSqlSyncSchema** cmdlet updates the sync schema for a sync member database or a sync hub database. - -## EXAMPLES - -### Example 1: Update the sync schema for a hub database -``` -PS C:\>Update-AzureRmSqlSyncSchema -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "database01" -SyncGroupName "syncGroup01" -``` - -This command updates the sync schema for the hub database in the sync group syncGroup01 - -### Example 2: Update the sync schema for a member database -``` -PS C:\>Update-AzureRmSqlSyncSchema -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "database01" -SyncGroupName "syncGroup01" -SyncMemberName "syncMember01" -``` - -This command updates the sync schema for the member database in the sync member syncMember01 - -## PARAMETERS - -### -DatabaseName -The name of the Azure SQL Database. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Defines Whether return the sync group this cmdlet works on - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -The name of the Azure SQL Server. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SyncGroupName -The sync group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SyncMemberName -The sync member name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncGroupModel - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Sql/Use-AzureRmSqlServerAuditingPolicy.md b/azurermps-6.13.0/AzureRM.Sql/Use-AzureRmSqlServerAuditingPolicy.md deleted file mode 100644 index bd26fb9b54..0000000000 --- a/azurermps-6.13.0/AzureRM.Sql/Use-AzureRmSqlServerAuditingPolicy.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml -Module Name: AzureRM.Sql -ms.assetid: 381F5B34-983C-4733-B384-35D6579B79A2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.sql/use-azurermsqlserverauditingpolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Use-AzureRmSqlServerAuditingPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Sql/Commands.Sql/help/Use-AzureRmSqlServerAuditingPolicy.md ---- - -# Use-AzureRmSqlServerAuditingPolicy - -## SYNOPSIS -Specifies that a database uses the auditing policy of its host server. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Use-AzureRmSqlServerAuditingPolicy [-PassThru] [-ServerName] <String> [-DatabaseName] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Use-AzureRmSqlServerAuditingPolicy** cmdlet specifies that a database uses the auditing policy of its host server. -Specify the *ResourceGroupName*, *ServerName*, and *DatabaseName* parameters to identify the database. -If no auditing policy is defined for the database server, this cmdlet fails. -If the host uses server level auditing, threat detection is removed. - -## EXAMPLES - -### Example 1: Configure a database to use the auditing policy of its server -``` -PS C:\>Use-AzureRmSqlServerAuditingPolicy -ResourceGroupName "ResourceGroup01" -ServerName "Server02" -DatabaseName "Database01" -``` - -This command specifies that the database named Database01 on Server02 uses the auditing policy of the server. - -## PARAMETERS - -### -DatabaseName -Specifies the name of the database that will use the auditing policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the server is assigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server that hosts the database that uses the auditing policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Sql.Auditing.Model.AuditingPolicyModel - -## NOTES - -## RELATED LINKS - -[Get-AzureRmSqlDatabaseAuditingPolicy](./Get-AzureRmSqlDatabaseAuditingPolicy.md) - -[Get-AzureRmSqlServerAuditingPolicy](./Get-AzureRmSqlServerAuditingPolicy.md) - -[Set-AzureRmSqlDatabaseAuditingPolicy](./Set-AzureRmSqlDatabaseAuditingPolicy.md) - -[Set-AzureRmSqlServerAuditingPolicy](./Set-AzureRmSqlServerAuditingPolicy.md) - -[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/) - - diff --git a/azurermps-6.13.0/AzureRM.Storage/Add-AzureRmStorageAccountNetworkRule.md b/azurermps-6.13.0/AzureRM.Storage/Add-AzureRmStorageAccountNetworkRule.md deleted file mode 100644 index 9baa3227f9..0000000000 --- a/azurermps-6.13.0/AzureRM.Storage/Add-AzureRmStorageAccountNetworkRule.md +++ /dev/null @@ -1,255 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/add-azurermstorageaccountnetworkrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Add-AzureRmStorageAccountNetworkRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Add-AzureRmStorageAccountNetworkRule.md ---- - -# Add-AzureRmStorageAccountNetworkRule - -## SYNOPSIS - Add IpRules or VirtualNetworkRules to the NetworkRule property of a Storage account - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NetWorkRuleString (Default) -``` -Add-AzureRmStorageAccountNetworkRule [-ResourceGroupName] <String> [-Name] <String> - -VirtualNetworkResourceId <String[]> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### IpRuleObject -``` -Add-AzureRmStorageAccountNetworkRule [-ResourceGroupName] <String> [-Name] <String> -IPRule <PSIpRule[]> - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### NetworkRuleObject -``` -Add-AzureRmStorageAccountNetworkRule [-ResourceGroupName] <String> [-Name] <String> - -VirtualNetworkRule <PSVirtualNetworkRule[]> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### IpRuleString -``` -Add-AzureRmStorageAccountNetworkRule [-ResourceGroupName] <String> [-Name] <String> - -IPAddressOrRange <String[]> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmStorageAccountNetworkRule** cmdlet adds IpRules or VirtualNetworkRules to the NetworkRule property of a Storage account - -## EXAMPLES - -### Example 1: Add several IpRules with IPAddressOrRange -``` -PS C:\>Add-AzureRMStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount" -IPAddressOrRange "10.0.0.0/24","28.2.0.0/16" -``` - -This command add several IpRules with IPAddressOrRange. - -### Example 2: Add a VirtualNetworkRule with VirtualNetworkResourceID -``` -PS C:\>$subnet = Get-AzureRmVirtualNetwork -ResourceGroupName "myResourceGroup" -Name "myvirtualnetwork" | Get-AzureRmVirtualNetworkSubnetConfig -PS C:\>Add-AzureRMStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount" -VirtualNetworkResourceId $subnet[0].Id -``` - -This command add a VirtualNetworkRule with VirtualNetworkResourceID. - -### Example 3: Add VirtualNetworkRules with VirtualNetworkRule Objects from another account -``` -PS C:\> $networkrule = Get-AzureRMStorageAccountNetworkRuleSet -ResourceGroupName "myResourceGroup" -Name "mystorageaccount1" -PS C:\> Add-AzureRMStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount2" -VirtualNetworkRule $networkrule.VirtualNetworkRules -``` - -This command add VirtualNetworkRules with VirtualNetworkRule Objects from another account. - -### Example 4: Add several IpRule with IpRule objects, input with JSON -``` -PS C:\>Add-AzureRMStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount" -IPRule (@{IPAddressOrRange="10.0.0.0/24";Action="allow"},@{IPAddressOrRange="28.2.0.0/16";Action="allow"}) -``` - -This command add several IpRule with IpRule objects, input with JSON. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddressOrRange -The Array of IpAddressOrRange, add IpRules with the input IpAddressOrRange and default Action Allow to NetworkRule Property. - -```yaml -Type: System.String[] -Parameter Sets: IpRuleString -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPRule -The Array of IpRule objects to add to the NetworkRule Property. - -```yaml -Type: Microsoft.Azure.Commands.Management.Storage.Models.PSIpRule[] -Parameter Sets: IpRuleObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: StorageAccountName, AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group contains the Storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkResourceId -The Array of VirtualNetworkResourceId, will add VirtualNetworkRule with input VirtualNetworkResourceId and default Action Allow to NetworkRule Property. - -```yaml -Type: System.String[] -Parameter Sets: NetWorkRuleString -Aliases: SubnetId, VirtualNetworkId - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkRule -The Array of VirtualNetworkRule objects to add to the NetworkRule Property. - -```yaml -Type: Microsoft.Azure.Commands.Management.Storage.Models.PSVirtualNetworkRule[] -Parameter Sets: NetworkRuleObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Management.Storage.Models.PSIpRule[] -Parameters: IPRule (ByValue) - -### Microsoft.Azure.Commands.Management.Storage.Models.PSVirtualNetworkRule[] -Parameters: VirtualNetworkRule (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.Storage.Models.PSVirtualNetworkRule - -### Microsoft.Azure.Commands.Management.Storage.Models.PSIpRule - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Storage/Add-AzureRmStorageContainerLegalHold.md b/azurermps-6.13.0/AzureRM.Storage/Add-AzureRmStorageContainerLegalHold.md deleted file mode 100644 index 4c682471ee..0000000000 --- a/azurermps-6.13.0/AzureRM.Storage/Add-AzureRmStorageContainerLegalHold.md +++ /dev/null @@ -1,216 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/add-azurermstoragecontainerlegalhold -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Add-AzureRmStorageContainerLegalHold.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Add-AzureRmStorageContainerLegalHold.md ---- - -# Add-AzureRmStorageContainerLegalHold - -## SYNOPSIS -Adds legal hold tags to a Storage blob container - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### AccountName (Default) -``` -Add-AzureRmStorageContainerLegalHold [-ResourceGroupName] <String> [-StorageAccountName] <String> - -Name <String> -Tag <String[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### AccountObject -``` -Add-AzureRmStorageContainerLegalHold -Name <String> -StorageAccount <PSStorageAccount> -Tag <String[]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ContainerObject -``` -Add-AzureRmStorageContainerLegalHold -Container <PSContainer> -Tag <String[]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmStorageContainerLegalHold** cmdlet adds legal hold tags to a Storage blob container - -## EXAMPLES - -### Example 1: Add legal hold tags to a Storage blob container with Storage account name and container name -``` -PS C:\>Add-AzureRmStorageContainerLegalHold -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" -Tag tag1,tag2 -``` - -This command adds legal hold tags to a Storage blob container with Storage account name and container name. - -### Example 2: Add legal hold tags to a Storage blob container with Storage account object and container name -``` -PS C:\>$accountObject = Get-AzureRmStorageAccount -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -PS C:\>Add-AzureRmStorageContainerLegalHold -StorageAccount $accountObject -ContainerName "myContainer" -Tag tag1 -``` - -This command adds legal hold tags to a Storage blob container with Storage account object and container name. - -### Example 3: Add legal hold tags to all Storage blob containers in a Storage account with pipeline -``` -PS C:\>Get-AzureRmStorageContainer -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" | Add-AzureRmStorageContainerLegalHold -Tag tag1,tag2,tag3 -``` - -This command adds legal hold tags to all Storage blob containers in a Storage account with pipeline. - -## PARAMETERS - -### -Container -Storage container object - -```yaml -Type: PSContainer -Parameter Sets: ContainerObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Container Name - -```yaml -Type: String -Parameter Sets: AccountName, AccountObject -Aliases: N, ContainerName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: String -Parameter Sets: AccountName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccount -Storage account object - -```yaml -Type: PSStorageAccount -Parameter Sets: AccountObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -StorageAccountName -Storage Account Name. - -```yaml -Type: String -Parameter Sets: AccountName -Aliases: AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Container LegalHold Tags - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.Storage.Models.PSLegalHold - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-6.13.0/AzureRM.Storage/AzureRM.Storage.md b/azurermps-6.13.0/AzureRM.Storage/AzureRM.Storage.md deleted file mode 100644 index 607c14551d..0000000000 --- a/azurermps-6.13.0/AzureRM.Storage/AzureRM.Storage.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -Module Name: AzureRM.Storage -Module Guid: da67eaa7-4cb1-4bfa-a194-8bf3faae8ac5 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage -Help Version: 4.2.3.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/AzureRM.Storage.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/AzureRM.Storage.md ---- - -# AzureRM.Storage Module -## Description -This topic displays help topics for the Azure Storage Management Cmdlets. - -## AzureRM.Storage Cmdlets -### [Add-AzureRmStorageAccountNetworkRule](Add-AzureRmStorageAccountNetworkRule.md) - Adds IpRules or VirtualNetworkRules to the NetworkRule property of a Storage Account - -### [Add-AzureRmStorageContainerLegalHold](Add-AzureRmStorageContainerLegalHold.md) -Adds tags for legal hold of a Storage blob container - -### [Get-AzureRmStorageAccount](Get-AzureRmStorageAccount.md) -Gets a Storage account. - -### [Get-AzureRmStorageAccountKey](Get-AzureRmStorageAccountKey.md) -Gets the access keys for an Azure Storage account. - -### [Get-AzureRmStorageAccountNameAvailability](Get-AzureRmStorageAccountNameAvailability.md) -Checks the availability of a Storage account name. - -### [Get-AzureRmStorageAccountNetworkRuleSet](Get-AzureRmStorageAccountNetworkRuleSet.md) -Gets the NetWorkRule property of a Storage Account - -### [Get-AzureRmStorageContainer](Get-AzureRmStorageContainer.md) -Gets or lists Storage blob containers - -### [Get-AzureRmStorageContainerImmutabilityPolicy](Get-AzureRmStorageContainerImmutabilityPolicy.md) -Gets ImmutabilityPolicy of a Storage blob containers - -### [Get-AzureRmStorageUsage](Get-AzureRmStorageUsage.md) -Gets the Storage resource usage of the current subscription. - -### [Lock-AzureRmStorageContainerImmutabilityPolicy](Lock-AzureRmStorageContainerImmutabilityPolicy.md) -Locks ImmutabilityPolicy of a Storage blob containers - -### [New-AzureRmStorageAccount](New-AzureRmStorageAccount.md) -Creates a Storage account. - -### [New-AzureRmStorageAccountKey](New-AzureRmStorageAccountKey.md) -Regenerates a storage key for an Azure Storage account. - -### [New-AzureRmStorageContainer](New-AzureRmStorageContainer.md) -Creates a Storage blob container - -### [Remove-AzureRmStorageAccount](Remove-AzureRmStorageAccount.md) -Removes a Storage account from Azure. - -### [Remove-AzureRmStorageAccountNetworkRule](Remove-AzureRmStorageAccountNetworkRule.md) -Removes IpRules or VirtualNetworkRules from the NetWorkRule property of a Storage Account - -### [Remove-AzureRmStorageContainer](Remove-AzureRmStorageContainer.md) -Removes a Storage blob container - -### [Remove-AzureRmStorageContainerImmutabilityPolicy](Remove-AzureRmStorageContainerImmutabilityPolicy.md) -Removes ImmutabilityPolicy of a Storage blob containers - -### [Remove-AzureRmStorageContainerLegalHold](Remove-AzureRmStorageContainerLegalHold.md) -Removes tags for legal hold of a Storage blob container - -### [Set-AzureRmCurrentStorageAccount](Set-AzureRmCurrentStorageAccount.md) -Modifies the current Storage account of the specified subscription. - -### [Set-AzureRmStorageAccount](Set-AzureRmStorageAccount.md) -Modifies a Storage account. - -### [Set-AzureRmStorageContainerImmutabilityPolicy](Set-AzureRmStorageContainerImmutabilityPolicy.md) -Creates or updates ImmutabilityPolicy of a Storage blob containers - -### [Update-AzureRmStorageAccountNetworkRuleSet](Update-AzureRmStorageAccountNetworkRuleSet.md) -Updates the NetworkRule property of a Storage Account - -### [Update-AzureRmStorageContainer](Update-AzureRmStorageContainer.md) -Modifies a Storage blob container - diff --git a/azurermps-6.13.0/AzureRM.Storage/Get-AzureRmStorageAccount.md b/azurermps-6.13.0/AzureRM.Storage/Get-AzureRmStorageAccount.md deleted file mode 100644 index c030973ac5..0000000000 --- a/azurermps-6.13.0/AzureRM.Storage/Get-AzureRmStorageAccount.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -ms.assetid: E53D5040-C1E8-4DC1-8371-F41C00B666E3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/get-azurermstorageaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Get-AzureRmStorageAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Get-AzureRmStorageAccount.md ---- - -# Get-AzureRmStorageAccount - -## SYNOPSIS -Gets a Storage account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceGroupParameterSet -``` -Get-AzureRmStorageAccount [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### AccountNameParameterSet -``` -Get-AzureRmStorageAccount [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmStorageAccount** cmdlet gets a specified Storage account or all of the Storage accounts in a resource group or the subscription. - -## EXAMPLES - -### Example 1: Get a specified Storage account -``` -PS C:\>Get-AzureRmStorageAccount -ResourceGroupName "RG01" -AccountName "mystorageaccount" -``` - -This command gets the specified Storage account. - -### Example 2: Get all Storage accounts in a resource group -``` -PS C:\>Get-AzureRmStorageAccount -ResourceGroupName "RG01" -``` - -This command gets all of the Storage accounts in a resource group. - -### Example 3: Get all Storage accounts in the subscription -``` -PS C:\>Get-AzureRmStorageAccount -``` - -This command gets all of the Storage accounts in the subscription. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Storage account to get. - -```yaml -Type: System.String -Parameter Sets: AccountNameParameterSet -Aliases: StorageAccountName, AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the Storage account to get. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupParameterSet -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: AccountNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount - -## NOTES - -## RELATED LINKS - -[New-AzureRmStorageAccount](./New-AzureRmStorageAccount.md) - -[Remove-AzureRmStorageAccount](./Remove-AzureRmStorageAccount.md) - -[Set-AzureRmStorageAccount](./Set-AzureRmStorageAccount.md) - - diff --git a/azurermps-6.13.0/AzureRM.Storage/Get-AzureRmStorageAccountKey.md b/azurermps-6.13.0/AzureRM.Storage/Get-AzureRmStorageAccountKey.md deleted file mode 100644 index 6bdb63bcff..0000000000 --- a/azurermps-6.13.0/AzureRM.Storage/Get-AzureRmStorageAccountKey.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -ms.assetid: A57A9EFA-47AC-44D8-BFA7-CDE0E2A612B3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/get-azurermstorageaccountkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Get-AzureRmStorageAccountKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Get-AzureRmStorageAccountKey.md ---- - -# Get-AzureRmStorageAccountKey - -## SYNOPSIS -Gets the access keys for an Azure Storage account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmStorageAccountKey [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmStorageAccountKey** cmdlet gets the access keys for an Azure Storage account. - -## EXAMPLES - -### Example 1: Get the access keys for a Storage account -``` -PS C:\>Get-AzureRmStorageAccountKey -ResourceGroupName "RG01" -AccountName "mystorageaccount" -``` - -This command gets the keys for the specified Azure Storage account. - -### Example 2: Get a specific access key for a Storage account -``` -This command gets a specific key for a Storage account. This command works for Azure PowerShell version 1.4, and later versions. -PS C:\>(Get-AzureRmStorageAccountKey -ResourceGroupName "RG01" -AccountName "mystorageaccount").Value[0] - -This command gets a specific key for a Storage account. This command works for Azure PowerShell version 1.3.2, and previous versions. -PS C:\>(Get-AzureRmStorageAccountKey -ResourceGroupName "RG01" -AccountName "mystorageaccount").Key1 -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Storage account for which this cmdlet gets keys. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: StorageAccountName, AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the Storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Storage.Models.StorageAccountKey - -## NOTES - -## RELATED LINKS - -[New-AzureRmStorageAccountKey](./New-AzureRmStorageAccountKey.md) - - diff --git a/azurermps-6.13.0/AzureRM.Storage/Get-AzureRmStorageAccountNameAvailability.md b/azurermps-6.13.0/AzureRM.Storage/Get-AzureRmStorageAccountNameAvailability.md deleted file mode 100644 index 26c4c55f9d..0000000000 --- a/azurermps-6.13.0/AzureRM.Storage/Get-AzureRmStorageAccountNameAvailability.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -ms.assetid: F6EA099A-D588-49AE-9D2C-865BC32685BA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/get-azurermstorageaccountnameavailability -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Get-AzureRmStorageAccountNameAvailability.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Get-AzureRmStorageAccountNameAvailability.md ---- - -# Get-AzureRmStorageAccountNameAvailability - -## SYNOPSIS -Checks the availability of a Storage account name. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmStorageAccountNameAvailability [-Name] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmStorageAccountNameAvailability** cmdlet checks whether the name of an Azure Storage account is valid and available to use. - -## EXAMPLES - -### Example 1: Check availability of a Storage account name -``` -PS C:\>Get-AzureRmStorageAccountNameAvailability -Name 'contosostorage03' -``` - -This command checks the availability of the name ContosoStorage03. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Storage account that this cmdlet checks. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: StorageAccountName, AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Storage.Models.CheckNameAvailabilityResult - -## NOTES - -## RELATED LINKS - -[Azure Storage Manager Cmdlets](./AzureRM.Storage.md) - - diff --git a/azurermps-6.13.0/AzureRM.Storage/Get-AzureRmStorageAccountNetworkRuleSet.md b/azurermps-6.13.0/AzureRM.Storage/Get-AzureRmStorageAccountNetworkRuleSet.md deleted file mode 100644 index f6fe1fab66..0000000000 --- a/azurermps-6.13.0/AzureRM.Storage/Get-AzureRmStorageAccountNetworkRuleSet.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/get-azurermstorageaccountnetworkruleset -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Get-AzureRmStorageAccountNetworkRuleSet.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Get-AzureRmStorageAccountNetworkRuleSet.md ---- - -# Get-AzureRmStorageAccountNetworkRuleSet - -## SYNOPSIS -Get the NetWorkRule property of a Storage account - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmStorageAccountNetworkRuleSet [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmStorageAccountNetworkRuleSet** cmdlet gets the NetworkRule property of a Storage account - -## EXAMPLES - -### Example 1: Get NetworkRule property of a specified Storage account -``` -PS C:\> Get-AzureRmStorageAccountNetworkRuleSet -ResourceGroupName "rg1" -AccountName "mystorageaccount" -``` - -This command gets NetworkRule property of a specified Storage account - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: StorageAccountName, AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group contains the Storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.Storage.Models.PSNetworkRuleSet - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Storage/Get-AzureRmStorageContainer.md b/azurermps-6.13.0/AzureRM.Storage/Get-AzureRmStorageContainer.md deleted file mode 100644 index 8144148ef2..0000000000 --- a/azurermps-6.13.0/AzureRM.Storage/Get-AzureRmStorageContainer.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/get-azurermstoragecontainer -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Get-AzureRmStorageContainer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Get-AzureRmStorageContainer.md ---- - -# Get-AzureRmStorageContainer - -## SYNOPSIS -Gets or lists Storage blob containers - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### AccountName (Default) -``` -Get-AzureRmStorageContainer [-ResourceGroupName] <String> [-StorageAccountName] <String> [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### AccountObject -``` -Get-AzureRmStorageContainer -StorageAccount <PSStorageAccount> [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmStorageContainer** cmdlet gets or lists Storage blob containers - -## EXAMPLES - -### Example 1: Get a Storage blob container with Storage account name and container name -``` -PS C:\>Get-AzureRmStorageContainer -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" -``` - -This command gets a Storage blob container with Storage account name and container name. - -### Example 2: List all Storage blob containers of a Storage account -``` -PS C:\>Get-AzureRmStorageContainer -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -``` - -This command lists all Storage blob containers of a Storage account with Storage account name. - -### Example 3: Get a Storage blob container with Storage account object and container name. -``` -PS C:\>$accountObject = Get-AzureRmStorageAccount -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -PS C:\>Get-AzureRmStorageContainer -StorageAccount $accountObject -ContainerName "myContainer" -``` - -This command gets a Storage blob container with Storage account object and container name. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Container Name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: N, ContainerName - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: String -Parameter Sets: AccountName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccount -Storage account object - -```yaml -Type: PSStorageAccount -Parameter Sets: AccountObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -StorageAccountName -Storage Account Name. - -```yaml -Type: String -Parameter Sets: AccountName -Aliases: AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.Storage.Models.PSContainer - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-6.13.0/AzureRM.Storage/Get-AzureRmStorageContainerImmutabilityPolicy.md b/azurermps-6.13.0/AzureRM.Storage/Get-AzureRmStorageContainerImmutabilityPolicy.md deleted file mode 100644 index 2090952016..0000000000 --- a/azurermps-6.13.0/AzureRM.Storage/Get-AzureRmStorageContainerImmutabilityPolicy.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/get-azurermstoragecontainerimmutabilitypolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Get-AzureRmStorageContainerImmutabilityPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Get-AzureRmStorageContainerImmutabilityPolicy.md ---- - -# Get-AzureRmStorageContainerImmutabilityPolicy - -## SYNOPSIS -Gets ImmutabilityPolicy of a Storage blob containers - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### AccountName (Default) -``` -Get-AzureRmStorageContainerImmutabilityPolicy [-ResourceGroupName] <String> [-StorageAccountName] <String> - [-ContainerName] <String> [-Etag <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### AccountObject -``` -Get-AzureRmStorageContainerImmutabilityPolicy [-ContainerName] <String> -StorageAccount <PSStorageAccount> - [-Etag <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ContainerObject -``` -Get-AzureRmStorageContainerImmutabilityPolicy -Container <PSContainer> [-Etag <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmStorageContainerImmutabilityPolicy** cmdlet gets ImmutabilityPolicy of a Storage blob containers - -## EXAMPLES - -### Example 1: Get ImmutabilityPolicy of a Storage blob container with Storage account name and container name -``` -PS C:\>Get-AzureRmStorageContainerImmutabilityPolicy -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" -``` - -This command gets ImmutabilityPolicy of a Storage blob container with Storage account name and container name. - -### Example 2: Get ImmutabilityPolicy of a Storage blob container with Storage account object and container name -``` -PS C:\>$accountObject = Get-AzureRmStorageAccount -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -PS C:\>Get-AzureRmStorageContainerImmutabilityPolicy -StorageAccount $accountObject -ContainerName "myContainer" -``` - -This command gets ImmutabilityPolicy of a Storage blob containers with Storage account object and container name. - -### Example 3: Get ImmutabilityPolicy of a Storage blob container with Storage container object -``` -PS C:\>$containerObject = Get-AzureRmStorageContainer -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -Name "myContainer" -PS C:\>Get-AzureRmStorageContainerImmutabilityPolicy -Container $containerObject -``` - -This command gets ImmutabilityPolicy of a Storage blob container with Storage container object. - -## PARAMETERS - -### -Container -Storage container object - -```yaml -Type: PSContainer -Parameter Sets: ContainerObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ContainerName -Container Name - -```yaml -Type: String -Parameter Sets: AccountName, AccountObject -Aliases: N - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Etag -Immutability policy etag. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: IfMatch - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: String -Parameter Sets: AccountName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccount -Storage account object - -```yaml -Type: PSStorageAccount -Parameter Sets: AccountObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -StorageAccountName -Storage Account Name. - -```yaml -Type: String -Parameter Sets: AccountName -Aliases: AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.Storage.Models.PSImmutabilityPolicy - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-6.13.0/AzureRM.Storage/Get-AzureRmStorageUsage.md b/azurermps-6.13.0/AzureRM.Storage/Get-AzureRmStorageUsage.md deleted file mode 100644 index 59083e7e88..0000000000 --- a/azurermps-6.13.0/AzureRM.Storage/Get-AzureRmStorageUsage.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -ms.assetid: 11AAA319-DDBB-4156-9BE7-4DE8B80A904C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/get-azurermstorageusage -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Get-AzureRmStorageUsage.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Get-AzureRmStorageUsage.md ---- - -# Get-AzureRmStorageUsage - -## SYNOPSIS -Gets the Storage resource usage of the current subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmStorageUsage [-Location <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmStorageUsage** cmdlet gets the resource usage for Azure Storage for the current subscription. - -## EXAMPLES - -### Example 1: Get the storage resources usage -``` -PS C:\>Get-AzureRmStorageUsage -``` - -This command gets the Storage resources usage of the current subscription. - - -### Example 2: Get the storage resources usage of specified location -``` -PS C:\>Get-AzureRmStorageUsage -Location 'West US' - -LocalizedName : Storage Accounts -Name : StorageAccounts -Unit : Count -CurrentValue : 18 -Limit : 250 -``` - -This command gets the Storage resources usage of the specified location under the current subscription. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Indicate to get Storage resources usage on the specified location. -If not specified, will get Storage resources usage on all locations under the subscription. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.Storage.Models.PSUsage - -## NOTES - -## RELATED LINKS - -[Azure Storage Manager Cmdlets](./AzureRM.Storage.md) - - diff --git a/azurermps-6.13.0/AzureRM.Storage/Lock-AzureRmStorageContainerImmutabilityPolicy.md b/azurermps-6.13.0/AzureRM.Storage/Lock-AzureRmStorageContainerImmutabilityPolicy.md deleted file mode 100644 index 094cf5f5e6..0000000000 --- a/azurermps-6.13.0/AzureRM.Storage/Lock-AzureRmStorageContainerImmutabilityPolicy.md +++ /dev/null @@ -1,265 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/lock-azurermstoragecontainerimmutabilitypolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Lock-AzureRmStorageContainerImmutabilityPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Lock-AzureRmStorageContainerImmutabilityPolicy.md ---- - -# Lock-AzureRmStorageContainerImmutabilityPolicy - -## SYNOPSIS -Locks ImmutabilityPolicy of a Storage blob containers - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### AccountName (Default) -``` -Lock-AzureRmStorageContainerImmutabilityPolicy [-ResourceGroupName] <String> [-StorageAccountName] <String> - [-ContainerName] <String> [-Etag] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### AccountObject -``` -Lock-AzureRmStorageContainerImmutabilityPolicy [-ContainerName] <String> -StorageAccount <PSStorageAccount> - [-Etag] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ContainerObject -``` -Lock-AzureRmStorageContainerImmutabilityPolicy -Container <PSContainer> [-Etag] <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ImmutabilityPolicyObject -``` -Lock-AzureRmStorageContainerImmutabilityPolicy -InputObject <PSImmutabilityPolicy> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Lock-AzureRmStorageContainerImmutabilityPolicy** cmdlet locks ImmutabilityPolicy of a Storage blob containers. - -## EXAMPLES - -### Example 1: Lock ImmutabilityPolicy of a Storage blob container with Storage account name and container name -``` -PS C:\>$policy = Get-AzureRmStorageContainerImmutabilityPolicy -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" -PS C:\>Lock-AzureRmStorageContainerImmutabilityPolicy -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" -Etag $policy.Etag -``` - -This command Locks ImmutabilityPolicy of a Storage blob container with Storage account name and container name. - -### Example 2: Lock ImmutabilityPolicy of a Storage blob container, with Storage account object -``` -PS C:\>$accountObject = Get-AzureRmStorageAccount -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -PS C:\>$policy = Get-AzureRmStorageContainerImmutabilityPolicy -StorageAccount $accountObject -ContainerName "myContainer" -PS C:\>Lock-AzureRmStorageContainerImmutabilityPolicy -StorageAccount $accountObject -ContainerName "myContainer" -Etag $policy.Etag -Force -``` - -This command locks ImmutabilityPolicy of a Storage blob container, with Storage account object. - -### Example 3: Lock ImmutabilityPolicyof a Storage blob container, with container object -``` -PS C:\>$containerObject = Get-AzureRmStorageContainer -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -Name "myContainer" -PS C:\>$policy = Get-AzureRmStorageContainerImmutabilityPolicy -Container $containerObject -PS C:\>Lock-AzureRmStorageContainerImmutabilityPolicy -Container $containerObject -Etag $policy.Etag -Force -``` - -This command locks ImmutabilityPolicy of a Storage blob container with Storage container object. - -### Example 4: Lock ImmutabilityPolicy of a Storage blob container, with ImmutabilityPolicy object -``` -PS C:\>Get-AzureRmStorageContainerImmutabilityPolicy -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" | Lock-AzureRmStorageContainerImmutabilityPolicy -Force -``` - -This command locks ImmutabilityPolicy of a Storage blob container, with ImmutabilityPolicy object. - -## PARAMETERS - -### -Container -Storage container object - -```yaml -Type: PSContainer -Parameter Sets: ContainerObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ContainerName -Container Name - -```yaml -Type: String -Parameter Sets: AccountName, AccountObject -Aliases: N - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Etag -Immutability policy etag. - -```yaml -Type: String -Parameter Sets: AccountName, AccountObject, ContainerObject -Aliases: IfMatch - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Force to remove the ImmutabilityPolicy. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -ImmutabilityPolicy Object to Remove - -```yaml -Type: PSImmutabilityPolicy -Parameter Sets: ImmutabilityPolicyObject -Aliases: ImmutabilityPolicy - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: String -Parameter Sets: AccountName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccount -Storage account object - -```yaml -Type: PSStorageAccount -Parameter Sets: AccountObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -StorageAccountName -Storage Account Name. - -```yaml -Type: String -Parameter Sets: AccountName -Aliases: AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Microsoft.Azure.Commands.Management.Storage.Models.PSImmutabilityPolicy - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.Storage.Models.PSImmutabilityPolicy - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-6.13.0/AzureRM.Storage/New-AzureRmStorageAccount.md b/azurermps-6.13.0/AzureRM.Storage/New-AzureRmStorageAccount.md deleted file mode 100644 index 4ce7c2b33c..0000000000 --- a/azurermps-6.13.0/AzureRM.Storage/New-AzureRmStorageAccount.md +++ /dev/null @@ -1,318 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -ms.assetid: A3DA1205-B8FB-4B4C-9C40-AD303D038EDF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/new-azurermstorageaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/New-AzureRmStorageAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/New-AzureRmStorageAccount.md ---- - -# New-AzureRmStorageAccount - -## SYNOPSIS -Creates a Storage account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmStorageAccount [-ResourceGroupName] <String> [-Name] <String> [-SkuName] <String> - [-Location] <String> [-Kind <String>] [-AccessTier <String>] [-CustomDomainName <String>] - [-UseSubDomain <Boolean>] [-Tag <Hashtable>] [-EnableHttpsTrafficOnly <Boolean>] [-AssignIdentity] - [-NetworkRuleSet <PSNetworkRuleSet>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmStorageAccount** cmdlet creates an Azure Storage account. - -## EXAMPLES - -### Example 1: Create a Storage account -``` -PS C:\>New-AzureRmStorageAccount -ResourceGroupName MyResourceGroup -AccountName mystorageaccount -Location westus -SkuName Standard_GRS -``` - -This command creates a Storage account for the resource group name MyResourceGroup. - -### Example 2: Create a Blob Storage account with BlobStorage Kind and hot AccessTier -``` -PS C:\>New-AzureRmStorageAccount -ResourceGroupName MyResourceGroup -AccountName mystorageaccount -Location westus -SkuName Standard_GRS -Kind BlobStorage -AccessTier Hot -``` - -This command creates a Blob Storage account that with BlobStorage Kind and hot AccessTier - -### Example 3: Create a Storage account with Kind StorageV2, and Generate and Assign an Identity for Azure KeyVault. -``` -PS C:\>New-AzureRmStorageAccount -ResourceGroupName MyResourceGroup -AccountName mystorageaccount -Location westus -SkuName Standard_GRS -Kind StorageV2 -AssignIdentity -``` - -This command creates a Storage account with Kind StorageV2. It also generates and assigns an identity that can be used to manage account keys through Azure KeyVault. - -### Example 4: Create a Storage account with NetworkRuleSet from JSON -``` -PS C:\>New-AzureRmStorageAccount -ResourceGroupName MyResourceGroup -AccountName mystorageaccount -Location westus -Type Standard_LRS -NetworkRuleSet (@{bypass="Logging,Metrics"; - ipRules=(@{IPAddressOrRange="20.11.0.0/16";Action="allow"}, - @{IPAddressOrRange="10.0.0.0/7";Action="allow"}); - virtualNetworkRules=(@{VirtualNetworkResourceId="/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1";Action="allow"}, - @{VirtualNetworkResourceId="/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/subnet2";Action="allow"}); - defaultAction="Deny"}) -``` - -This command creates a Storage account that has NetworkRuleSet property from JSON - -## PARAMETERS - -### -AccessTier -Specifies the access tier of the Storage account that this cmdlet creates. -The acceptable values for this parameter are: Hot and Cool. -If you specify a value of BlobStorage for the *Kind* parameter, you must specify a value for the -*AccessTier* parameter. If you specify a value of Storage for this *Kind* parameter, do not specify -the *AccessTier* parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Hot, Cool - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignIdentity -Generate and assign a new Storage account Identity for this Storage account for use with key management services like Azure KeyVault. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomDomainName -Specifies the name of the custom domain of the Storage account. -The default value is Storage. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableHttpsTrafficOnly -Indicates whether or not the Storage account only enables HTTPS traffic. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Kind -Specifies the kind of Storage account that this cmdlet creates. -The acceptable values for this parameter are: -- Storage. General purpose Storage account that supports storage of Blobs, Tables, Queues, Files and Disks. -- StorageV2. General Purpose Version 2 (GPv2) Storage account that supports Blobs, Tables, Queues, Files, and Disks, with advanced features like data tiering. -- BlobStorage. Blob Storage account which supports storage of Blobs only. -The default value is Storage. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Storage, StorageV2, BlobStorage - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the Storage account to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Storage account to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: StorageAccountName, AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkRuleSet -NetworkRuleSet is used to define a set of configuration rules for firewalls and virtual networks, as well as to set values for network properties such as services allowed to bypass the rules and how to handle requests that don't match any of the defined rules. - -```yaml -Type: Microsoft.Azure.Commands.Management.Storage.Models.PSNetworkRuleSet -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group in which to add the Storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuName -Specifies the SKU name of the Storage account that this cmdlet creates. -The acceptable values for this parameter are: -- Standard_LRS. Locally-redundant storage. -- Standard_ZRS. Zone-redundant storage. -- Standard_GRS. Geo-redundant storage. -- Standard_RAGRS. Read access geo-redundant storage. -- Premium_LRS. Premium locally-redundant storage. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: StorageAccountType, AccountType, Type -Accepted values: Standard_LRS, Standard_ZRS, Standard_GRS, Standard_RAGRS, Premium_LRS - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table set as tags on the server. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseSubDomain -Indicates whether to enable indirect CName validation. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Boolean - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount - -## NOTES - -## RELATED LINKS - -[Get-AzureRmStorageAccount](./Get-AzureRmStorageAccount.md) - -[Remove-AzureRmStorageAccount](./Remove-AzureRmStorageAccount.md) - -[Set-AzureRmStorageAccount](./Set-AzureRmStorageAccount.md) diff --git a/azurermps-6.13.0/AzureRM.Storage/New-AzureRmStorageAccountKey.md b/azurermps-6.13.0/AzureRM.Storage/New-AzureRmStorageAccountKey.md deleted file mode 100644 index f43f7de20b..0000000000 --- a/azurermps-6.13.0/AzureRM.Storage/New-AzureRmStorageAccountKey.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -ms.assetid: FDD2CE98-6C7E-4B95-BA5B-B03B6AC6EAEF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/new-azurermstorageaccountkey -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/New-AzureRmStorageAccountKey.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/New-AzureRmStorageAccountKey.md ---- - -# New-AzureRmStorageAccountKey - -## SYNOPSIS -Regenerates a storage key for an Azure Storage account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmStorageAccountKey [-ResourceGroupName] <String> [-Name] <String> [-KeyName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmStorageAccountKey** cmdlet regenerates a storage key for an Azure Storage account. - -## EXAMPLES - -### Example 1: Regenerate a storage key -``` -PS C:\>New-AzureRmStorageKey -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -KeyName "key1" -``` - -This command regenerates a storage key for the specified Storage account. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyName -Specifies which key to regenerate. -The acceptable values for this parameter are: -- key1 -- key2 - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: key1, key2 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Storage account for which to regenerate a storage key. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: StorageAccountName, AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the Storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Storage.Models.StorageAccountKey - -## NOTES - -## RELATED LINKS - -[Get-AzureRmStorageAccountKey](./Get-AzureRmStorageAccountKey.md) diff --git a/azurermps-6.13.0/AzureRM.Storage/New-AzureRmStorageContainer.md b/azurermps-6.13.0/AzureRM.Storage/New-AzureRmStorageContainer.md deleted file mode 100644 index 1cc508efd6..0000000000 --- a/azurermps-6.13.0/AzureRM.Storage/New-AzureRmStorageContainer.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/new-azurermstoragecontainer -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/New-AzureRmStorageContainer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/New-AzureRmStorageContainer.md ---- - -# New-AzureRmStorageContainer - -## SYNOPSIS -Creates a Storage blob container - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### AccountName (Default) -``` -New-AzureRmStorageContainer [-ResourceGroupName] <String> [-StorageAccountName] <String> [-Name] <String> - [-PublicAccess <PSPublicAccess>] [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### AccountObject -``` -New-AzureRmStorageContainer -StorageAccount <PSStorageAccount> [-Name] <String> - [-PublicAccess <PSPublicAccess>] [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmStorageContainer** cmdlet creates a Storage blob container - -## EXAMPLES - -### Example 1: Create a Storage blob container with Storage account name and container name, with metadata -``` -PS C:\>New-AzureRmStorageContainer -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" -Metadata @{tag0="value0";tag1="value1";tag2="value2"} -``` - -This command creates a Storage blob container with Storage account name and container name, with metadata. - -### Example 2: Create a Storage blob container with Storage account object and container name, with public access as Blob -``` -PS C:\>$accountObject = Get-AzureRmStorageAccount -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -PS C:\>New-AzureRmStorageContainer -StorageAccount $accountObject -ContainerName "myContainer" -PublicAccess Blob -``` - -This command creates a Storage blob container with Storage account object and container name, with public access as Blob. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Metadata -Container Metadata - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Container Name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: N, ContainerName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PublicAccess -Container PublicAccess - -```yaml -Type: PSPublicAccess -Parameter Sets: (All) -Aliases: -Accepted values: Container, Blob - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: String -Parameter Sets: AccountName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccount -Storage account object - -```yaml -Type: PSStorageAccount -Parameter Sets: AccountObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -StorageAccountName -Storage Account Name. - -```yaml -Type: String -Parameter Sets: AccountName -Aliases: AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.Storage.Models.PSContainer - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-6.13.0/AzureRM.Storage/Remove-AzureRmStorageAccount.md b/azurermps-6.13.0/AzureRM.Storage/Remove-AzureRmStorageAccount.md deleted file mode 100644 index 23c757ad6b..0000000000 --- a/azurermps-6.13.0/AzureRM.Storage/Remove-AzureRmStorageAccount.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -ms.assetid: 006B4341-274C-4929-86EE-2E107BA9E485 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/remove-azurermstorageaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Remove-AzureRmStorageAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Remove-AzureRmStorageAccount.md ---- - -# Remove-AzureRmStorageAccount - -## SYNOPSIS -Removes a Storage account from Azure. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmStorageAccount [-ResourceGroupName] <String> [-Name] <String> [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmStorageAccount** cmdlet removes a Storage account from Azure. - -## EXAMPLES - -### Example 1: Remove a Storage account -``` -PS C:\>Remove-AzureRmStorageAccount -ResourceGroupName "RG01" -AccountName "mystorageaccount" -``` - -This command removes the specified Storage account. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Storage account to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: StorageAccountName, AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the Storage account to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmStorageAccount](./Get-AzureRmStorageAccount.md) - -[New-AzureRmStorageAccount](./New-AzureRmStorageAccount.md) - -[Set-AzureRmStorageAccount](./Set-AzureRmStorageAccount.md) - - diff --git a/azurermps-6.13.0/AzureRM.Storage/Remove-AzureRmStorageAccountNetworkRule.md b/azurermps-6.13.0/AzureRM.Storage/Remove-AzureRmStorageAccountNetworkRule.md deleted file mode 100644 index 9522e6704b..0000000000 --- a/azurermps-6.13.0/AzureRM.Storage/Remove-AzureRmStorageAccountNetworkRule.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/remove-azurermstorageaccountnetworkrule -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Remove-AzureRmStorageAccountNetworkRule.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Remove-AzureRmStorageAccountNetworkRule.md ---- - -# Remove-AzureRmStorageAccountNetworkRule - -## SYNOPSIS -Remove IpRules or VirtualNetworkRules from the NetWorkRule property of a Storage account - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NetWorkRuleString (Default) -``` -Remove-AzureRmStorageAccountNetworkRule [-ResourceGroupName] <String> [-Name] <String> - -VirtualNetworkResourceId <String[]> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### IpRuleObject -``` -Remove-AzureRmStorageAccountNetworkRule [-ResourceGroupName] <String> [-Name] <String> -IPRule <PSIpRule[]> - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### NetworkRuleObject -``` -Remove-AzureRmStorageAccountNetworkRule [-ResourceGroupName] <String> [-Name] <String> - -VirtualNetworkRule <PSVirtualNetworkRule[]> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### IpRuleString -``` -Remove-AzureRmStorageAccountNetworkRule [-ResourceGroupName] <String> [-Name] <String> - -IPAddressOrRange <String[]> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmStorageAccountNetworkRule** cmdlet removes IpRules or VirtualNetworkRules from the NetWorkRule property of a Storage account - -## EXAMPLES - -### Example 1: Remove several IpRules with IPAddressOrRange -``` -PS C:\>Remove-AzureRmStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -AccountName "mystorageaccount" -IPAddressOrRange "10.0.0.0/24,28.1.0.0/16" -``` - -This command remove several IpRules with IPAddressOrRange. - -### Example 2: Remove a VirtualNetworkRule with VirtualNetworkRule Object input with JSON -``` -PS C:\>Remove-AzureRmStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -AccountName "mystorageaccount" -VirtualNetworkRules (@{VirtualNetworkReourceId="/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1";Action="allow"}) -``` - -This command remove a VirtualNetworkRule with VirtualNetworkRule Object input with JSON. - -### Example 3: Remove first IpRule with pipeline -``` -PS C:\>(Get-AzureRmStorageAccountNetworkRuleSet -ResourceGroupName "myResourceGroup" -AccountName "mystorageaccount").IpRules[0] | Remove-AzureRmStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -``` - -This command remove first IpRule with pipeline. - -### Example 4: Remove several VirtualNetworkRules with VirtualNetworkResourceID -``` -PS C:\>Remove-AzureRmStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -AccountName "mystorageaccount" -VirtualNetworkResourceId "/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1","/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/subnet2" -``` - -This command remove several VirtualNetworkRules with VirtualNetworkResourceID. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddressOrRange -The Array of IpAddressOrRange, will remove IpRule with same IpAddressOrRange from the NetWorkRule Property. - -```yaml -Type: System.String[] -Parameter Sets: IpRuleString -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPRule -The Array of IpRule objects to remove from the NetWorkRule Property. - -```yaml -Type: Microsoft.Azure.Commands.Management.Storage.Models.PSIpRule[] -Parameter Sets: IpRuleObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: StorageAccountName, AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group contains the Storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkResourceId -The Array of VirtualNetworkResourceId, will remove VirtualNetworkRule with same VirtualNetworkResourceId from the NetWorkRule Property. - -```yaml -Type: System.String[] -Parameter Sets: NetWorkRuleString -Aliases: SubnetId, VirtualNetworkId - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkRule -The Array of VirtualNetworkRule objects to remove from the NetWorkRule Property. - -```yaml -Type: Microsoft.Azure.Commands.Management.Storage.Models.PSVirtualNetworkRule[] -Parameter Sets: NetworkRuleObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Management.Storage.Models.PSIpRule[] -Parameters: IPRule (ByValue) - -### Microsoft.Azure.Commands.Management.Storage.Models.PSVirtualNetworkRule[] -Parameters: VirtualNetworkRule (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.Storage.Models.PSVirtualNetworkRule - -### Microsoft.Azure.Commands.Management.Storage.Models.PSIpRule - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Storage/Remove-AzureRmStorageContainer.md b/azurermps-6.13.0/AzureRM.Storage/Remove-AzureRmStorageContainer.md deleted file mode 100644 index 10a4af2d56..0000000000 --- a/azurermps-6.13.0/AzureRM.Storage/Remove-AzureRmStorageContainer.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/remove-azurermstoragecontainer -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Remove-AzureRmStorageContainer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Remove-AzureRmStorageContainer.md ---- - -# Remove-AzureRmStorageContainer - -## SYNOPSIS -Removes a Storage blob container - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### AccountName (Default) -``` -Remove-AzureRmStorageContainer [-ResourceGroupName] <String> [-StorageAccountName] <String> -Name <String> - [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### AccountObject -``` -Remove-AzureRmStorageContainer -Name <String> -StorageAccount <PSStorageAccount> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ContainerObject -``` -Remove-AzureRmStorageContainer -InputObject <PSContainer> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmStorageContainer** cmdlet removes a Storage blob container - -## EXAMPLES - -### Example 1: Remove a Storage blob container with Storage account name and container name -``` -PS C:\>Remove-AzureRmStorageContainer -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" -``` - -This command removes a Storage blob container with Storage account name and container name. - -### Example 2: Remove a Storage blob container with Storage account object and container name -``` -PS C:\>$accountObject = Get-AzureRmStorageAccount -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -PS C:\>Remove-AzureRmStorageContainer -StorageAccount $accountObject -ContainerName "myContainer" -``` - -This command removes a Storage blob container with Storage account object and container name. - -### Example 3: Remove all Storage blob containers in a Storage account with pipeline -``` -PS C:\>Get-AzureRmStorageContainer -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" | Remove-AzureRmStorageContainer -Force -``` - -This command removes all Storage blob containers in a Storage account with pipeline. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Force to remove the container and all content in it - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Storage container object - -```yaml -Type: PSContainer -Parameter Sets: ContainerObject -Aliases: Container - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -Container Name - -```yaml -Type: String -Parameter Sets: AccountName, AccountObject -Aliases: N, ContainerName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: String -Parameter Sets: AccountName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccount -Storage account object - -```yaml -Type: PSStorageAccount -Parameter Sets: AccountObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -StorageAccountName -Storage Account Name. - -```yaml -Type: String -Parameter Sets: AccountName -Aliases: AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Storage/Remove-AzureRmStorageContainerImmutabilityPolicy.md b/azurermps-6.13.0/AzureRM.Storage/Remove-AzureRmStorageContainerImmutabilityPolicy.md deleted file mode 100644 index bc171eac1c..0000000000 --- a/azurermps-6.13.0/AzureRM.Storage/Remove-AzureRmStorageContainerImmutabilityPolicy.md +++ /dev/null @@ -1,250 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/remove-azurermstoragecontainerimmutabilitypolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Remove-AzureRmStorageContainerImmutabilityPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Remove-AzureRmStorageContainerImmutabilityPolicy.md ---- - -# Remove-AzureRmStorageContainerImmutabilityPolicy - -## SYNOPSIS -Removes ImmutabilityPolicy of a Storage blob containers - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### AccountName (Default) -``` -Remove-AzureRmStorageContainerImmutabilityPolicy [-ResourceGroupName] <String> [-StorageAccountName] <String> - [-ContainerName] <String> [-Etag] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### AccountObject -``` -Remove-AzureRmStorageContainerImmutabilityPolicy [-ContainerName] <String> -StorageAccount <PSStorageAccount> - [-Etag] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ContainerObject -``` -Remove-AzureRmStorageContainerImmutabilityPolicy -Container <PSContainer> [-Etag] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ImmutabilityPolicyObject -``` -Remove-AzureRmStorageContainerImmutabilityPolicy -InputObject <PSImmutabilityPolicy> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmStorageContainerImmutabilityPolicy** cmdlet removes ImmutabilityPolicy of a Storage blob containers. - -## EXAMPLES - -### Example 1: Remove ImmutabilityPolicy of a Storage blob container with Storage account name and container name -``` -PS C:\>$policy = Get-AzureRmStorageContainerImmutabilityPolicy -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" -PS C:\>Remove-AzureRmStorageContainerImmutabilityPolicy -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" -Etag $policy.Etag -``` - -This command removes ImmutabilityPolicy of a Storage blob container with Storage account name and container name. - -### Example 2: Remove ImmutabilityPolicy of a Storage blob container, with Storage account object -``` -PS C:\>$accountObject = Get-AzureRmStorageAccount -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -PS C:\>$policy = Get-AzureRmStorageContainerImmutabilityPolicy -StorageAccount $accountObject -ContainerName "myContainer" -PS C:\>Remove-AzureRmStorageContainerImmutabilityPolicy -StorageAccount $accountObject -ContainerName "myContainer" -Etag $policy.Etag -``` - -This command removes ImmutabilityPolicy of a Storage blob container, with Storage account object. - -### Example 3: Remove ImmutabilityPolicyof a Storage blob container, with container object -``` -PS C:\>$containerObject = Get-AzureRmStorageContainer -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -Name "myContainer" -PS C:\>$policy = Get-AzureRmStorageContainerImmutabilityPolicy -Container $containerObject -PS C:\>Remove-AzureRmStorageContainerImmutabilityPolicy -Container $containerObject -Etag $policy.Etag -``` - -This command removes ImmutabilityPolicy of a Storage blob container with Storage container object. - -### Example 4: Remove ImmutabilityPolicy of a Storage blob container, with ImmutabilityPolicy object -``` -PS C:\>Get-AzureRmStorageContainerImmutabilityPolicy -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" | Remove-AzureRmStorageContainerImmutabilityPolicy -``` - -This command removes ImmutabilityPolicy of a Storage blob container, with ImmutabilityPolicy object. - -## PARAMETERS - -### -Container -Storage container object - -```yaml -Type: PSContainer -Parameter Sets: ContainerObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ContainerName -Container Name - -```yaml -Type: String -Parameter Sets: AccountName, AccountObject -Aliases: N - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Etag -Immutability policy etag. - -```yaml -Type: String -Parameter Sets: AccountName, AccountObject, ContainerObject -Aliases: IfMatch - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -ImmutabilityPolicy Object to Remove - -```yaml -Type: PSImmutabilityPolicy -Parameter Sets: ImmutabilityPolicyObject -Aliases: ImmutabilityPolicy - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: String -Parameter Sets: AccountName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccount -Storage account object - -```yaml -Type: PSStorageAccount -Parameter Sets: AccountObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -StorageAccountName -Storage Account Name. - -```yaml -Type: String -Parameter Sets: AccountName -Aliases: AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Microsoft.Azure.Commands.Management.Storage.Models.PSImmutabilityPolicy - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.Storage.Models.PSImmutabilityPolicy - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-6.13.0/AzureRM.Storage/Remove-AzureRmStorageContainerLegalHold.md b/azurermps-6.13.0/AzureRM.Storage/Remove-AzureRmStorageContainerLegalHold.md deleted file mode 100644 index 6362c48b64..0000000000 --- a/azurermps-6.13.0/AzureRM.Storage/Remove-AzureRmStorageContainerLegalHold.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/remove-azurermstoragecontainerlegalhold -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Remove-AzureRmStorageContainerLegalHold.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Remove-AzureRmStorageContainerLegalHold.md ---- - -# Remove-AzureRmStorageContainerLegalHold - -## SYNOPSIS -Removes legal hold tags from a Storage blob container - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### AccountName (Default) -``` -Remove-AzureRmStorageContainerLegalHold [-ResourceGroupName] <String> [-StorageAccountName] <String> - -Name <String> -Tag <String[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### AccountObject -``` -Remove-AzureRmStorageContainerLegalHold -Name <String> -StorageAccount <PSStorageAccount> -Tag <String[]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ContainerObject -``` -Remove-AzureRmStorageContainerLegalHold -Container <PSContainer> -Tag <String[]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmStorageContainerLegalHold** cmdlet removes legal hold tags from a Storage blob container - -## EXAMPLES - -### Example 1: Remove legal hold tags from a Storage blob container with Storage account name and container name -``` -PS C:\>Remove-AzureRmStorageContainerLegalHold -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" -Tag tag1 -``` - -This command removes legal hold tags from a Storage blob container with Storage account name and container name. - -### Example 2: Remove legal hold tags from a Storage blob container with Storage account object and container name -``` -PS C:\>$accountObject = Get-AzureRmStorageAccount -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -PS C:\>Remove-AzureRmStorageContainerLegalHold -StorageAccount $accountObject -ContainerName "myContainer" -Tag tag1,tag2 -``` - -This command removes legal hold tags from a Storage blob container with Storage account object and container name. - -### Example 3: Remove legal hold tags from all Storage blob containers in a Storage account with pipeline -``` -PS C:\>Get-AzureRmStorageContainer -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" | Remove-AzureRmStorageContainerLegalHold -Tag tag1 -``` - -This command removes legal hold tags from all Storage blob containers in a Storage account with pipeline. - - -## PARAMETERS - -### -Container -Storage container object - -```yaml -Type: PSContainer -Parameter Sets: ContainerObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Container Name - -```yaml -Type: String -Parameter Sets: AccountName, AccountObject -Aliases: N, ContainerName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: String -Parameter Sets: AccountName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccount -Storage account object - -```yaml -Type: PSStorageAccount -Parameter Sets: AccountObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -StorageAccountName -Storage Account Name. - -```yaml -Type: String -Parameter Sets: AccountName -Aliases: AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Container LegalHold Tags - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.Storage.Models.PSLegalHold - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-6.13.0/AzureRM.Storage/Set-AzureRmCurrentStorageAccount.md b/azurermps-6.13.0/AzureRM.Storage/Set-AzureRmCurrentStorageAccount.md deleted file mode 100644 index e93e418862..0000000000 --- a/azurermps-6.13.0/AzureRM.Storage/Set-AzureRmCurrentStorageAccount.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -ms.assetid: 15973FE8-16C1-4B71-A3A8-6D6F67A96FDF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/set-azurermcurrentstorageaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Set-AzureRmCurrentStorageAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Set-AzureRmCurrentStorageAccount.md ---- - -# Set-AzureRmCurrentStorageAccount - -## SYNOPSIS -Modifies the current Storage account of the specified subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### UsingResourceGroupAndNameParameterSet (Default) -``` -Set-AzureRmCurrentStorageAccount -ResourceGroupName <String> -Name <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### UsingStorageContext -``` -Set-AzureRmCurrentStorageAccount -Context <IStorageContext> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmCurrentStorageAccount** cmdlet modifies the current Azure Storage account of the specified Azure subscription in Azure PowerShell. -The current Storage account is used as the default when you access Storage without specifying a Storage account name. - -## EXAMPLES - -### Example 1: Set the current Storage account -``` -PS C:\>Set-AzureRmCurrentStorageAccount -ResourceGroupName "RG01" -AccountName "mystorageaccount" -``` - -This command sets the default Storage account for the specified subscription. - -## PARAMETERS - -### -Context -Specifies an **AzureStorageContext** object for the current Storage account. -To obtain a storage context object, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: UsingStorageContext -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Storage account that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: UsingResourceGroupAndNameParameterSet -Aliases: StorageAccountName, AccountName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group that contains the Storage account to modify. - -```yaml -Type: System.String -Parameter Sets: UsingResourceGroupAndNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -### System.String - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Set-AzureRmStorageAccount](./Set-AzureRmStorageAccount.md) - - diff --git a/azurermps-6.13.0/AzureRM.Storage/Set-AzureRmStorageAccount.md b/azurermps-6.13.0/AzureRM.Storage/Set-AzureRmStorageAccount.md deleted file mode 100644 index d09f281545..0000000000 --- a/azurermps-6.13.0/AzureRM.Storage/Set-AzureRmStorageAccount.md +++ /dev/null @@ -1,478 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -ms.assetid: 4D7EEDD7-89D4-4B1E-A9A1-B301E759CE72 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/set-azurermstorageaccount -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Set-AzureRmStorageAccount.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Set-AzureRmStorageAccount.md ---- - -# Set-AzureRmStorageAccount - -## SYNOPSIS -Modifies a Storage account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### StorageEncryption (Default) -``` -Set-AzureRmStorageAccount [-ResourceGroupName] <String> [-Name] <String> [-Force] [-SkuName <String>] - [-AccessTier <String>] [-CustomDomainName <String>] [-UseSubDomain <Boolean>] [-Tag <Hashtable>] - [-EnableHttpsTrafficOnly <Boolean>] [-StorageEncryption] [-AssignIdentity] - [-NetworkRuleSet <PSNetworkRuleSet>] [-UpgradeToStorageV2] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### KeyvaultEncryption -``` -Set-AzureRmStorageAccount [-ResourceGroupName] <String> [-Name] <String> [-Force] [-SkuName <String>] - [-AccessTier <String>] [-CustomDomainName <String>] [-UseSubDomain <Boolean>] [-Tag <Hashtable>] - [-EnableHttpsTrafficOnly <Boolean>] [-KeyvaultEncryption] -KeyName <String> -KeyVersion <String> - -KeyVaultUri <String> [-AssignIdentity] [-NetworkRuleSet <PSNetworkRuleSet>] [-UpgradeToStorageV2] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmStorageAccount** cmdlet modifies an Azure Storage account. -You can use this cmdlet to modify the account type, update a customer domain, or set tags on a Storage account. - -## EXAMPLES - -### Example 1: Set the Storage account type -``` -PS C:\>Set-AzureRmStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" -Type "Standard_RAGRS" -``` - -This command sets the Storage account type to Standard_RAGRS. - -### Example 2: Set a custom domain for a Storage account -``` -PS C:\>Set-AzureRmStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" -CustomDomainName "www.contoso.com" -UseSubDomain $True -``` - -This command sets a custom domain for a Storage account. - -### Example 3: Set the access tier value -``` -PS C:\>Set-AzureRmStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" -AccessTier Cool -``` - -The command sets the Access Tier value to be cool. - -### Example 4: Set the custom domain and tags -``` -PS C:\>Set-AzureRmStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" -CustomDomainName "www.domainname.com" -UseSubDomain $true -Tag @{tag0="value0";tag1="value1";tag2="value2"} -``` - -The command sets the custom domain and tags for a Storage account. - -### Example 5: Set Encryption KeySource to Keyvault -``` -PS C:\>Set-AzureRmStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" -AssignIdentity -PS C:\>$account = Get-AzureRmStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" - -PS C:\>$keyVault = New-AzureRmKeyVault -VaultName "MyKeyVault" -ResourceGroupName "MyResourceGroup" -Location "EastUS2" -PS C:\>$key = Add-AzureKeyVaultKey -VaultName "MyKeyVault" -Name "MyKey" -Destination 'Software' -PS C:\>Set-AzureRmKeyVaultAccessPolicy -VaultName "MyKeyVault" -ObjectId $account.Identity.PrincipalId -PermissionsToKeys wrapkey,unwrapkey,get - -PS C:\>Set-AzureRmStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" -KeyvaultEncryption -KeyName $key.Name -KeyVersion $key.Version -KeyVaultUri $keyVault.VaultUri -``` - -This command set Encryption KeySource with a new created Keyvault. - -### Example 6: Set Encryption KeySource to "Microsoft.Storage" -``` -PS C:\>Set-AzureRmStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" -StorageEncryption -``` - -This command set Encryption KeySource to "Microsoft.Storage" - -### Example 7: Set NetworkRuleSet property of a Storage account with JSON -``` -PS C:\>Set-AzureRmStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" -NetworkRuleSet (@{bypass="Logging,Metrics"; - ipRules=(@{IPAddressOrRange="20.11.0.0/16";Action="allow"}, - @{IPAddressOrRange="10.0.0.0/7";Action="allow"}); - virtualNetworkRules=(@{VirtualNetworkResourceId="/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1";Action="allow"}, - @{VirtualNetworkResourceId="/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/subnet2";Action="allow"}); - defaultAction="allow"}) -``` - -This command sets NetworkRuleSet property of a Storage account with JSON - -### Example 8: Get NetworkRuleSet property from a Storage account, and set it to another Storage account -``` -PS C:\> $networkRuleSet = (Get-AzureRmStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount").NetworkRuleSet -PS C:\> Set-AzureRmStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount2" -NetworkRuleSet $networkRuleSet -``` - -This first command gets NetworkRuleSet property from a Storage account, and the second command sets it to another Storage account - -### Example 9: Upgrade a Storage account with Kind "Storage" or "BlobStorage" to "StorageV2" kind Storage account -``` -PS C:\> Set-AzureRmStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" -UpgradeToStorageV2 -``` - -The command upgrade a Storage account with Kind "Storage" or "BlobStorage" to "StorageV2" kind Storage account. - -## PARAMETERS - -### -AccessTier -Specifies the access tier of the Storage account that this cmdlet modifies. -The acceptable values for this parameter are: Hot and Cool. -If you change the access tier, it may result in additional charges. For more information, see -[Azure Blob Storage: Hot and cool storage tiers](https://go.microsoft.com/fwlink/?LinkId=786482). -If the Storage account has Kind as StorageV2 or BlobStorage, you can specify the *AccessTier* parameter. -If the Storage account has Kind as Storage, do not specify the *AccessTier* parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Hot, Cool - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignIdentity -Generate and assign a new Storage account Identity for this Storage account for use with key management services like Azure KeyVault. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomDomainName -Specifies the name of the custom domain. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableHttpsTrafficOnly -Indicates whether or not the Storage account only enables HTTPS traffic. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the change to be written to the Storage account. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyName -If using -KeyvaultEncryption to enable encryption with Key Vault, specify the Keyname property with this option. - -```yaml -Type: System.String -Parameter Sets: KeyvaultEncryption -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyvaultEncryption -Indicates whether or not to use Microsoft KeyVault for the encryption keys when using Storage Service Encryption. -If KeyName, KeyVersion, and KeyVaultUri are all set, KeySource will be set to Microsoft.Keyvault whether this parameter is set or not. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: KeyvaultEncryption -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyVaultUri -When using Key Vault Encryption by specifying the -KeyvaultEncryption parameter, use this option to specify the URI to the Key Vault. - -```yaml -Type: System.String -Parameter Sets: KeyvaultEncryption -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyVersion -When using Key Vault Encryption by specifying the -KeyvaultEncryption parameter, use this option to specify the URI to the Key Version. - -```yaml -Type: System.String -Parameter Sets: KeyvaultEncryption -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Storage account to modify. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: StorageAccountName, AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkRuleSet -NetworkRuleSet is used to define a set of configuration rules for firewalls and virtual networks, as well as to set values for network properties such as services allowed to bypass the rules and how to handle requests that don't match any of the defined rules. - -```yaml -Type: Microsoft.Azure.Commands.Management.Storage.Models.PSNetworkRuleSet -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group in which to modify the Storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuName -Specifies the SKU name of the Storage account. -The acceptable values for this parameter are: -- Standard_LRS - Locally-redundant storage. -- Standard_ZRS - Zone-redundant storage. -- Standard_GRS - Geo-redundant storage. -- Standard_RAGRS - Read access geo-redundant storage. -- Premium_LRS - Premium locally-redundant storage. -You cannot change Standard_ZRS and Premium_LRS types to other account types. -You cannot change other account types to Standard_ZRS or Premium_LRS. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: StorageAccountType, AccountType, Type -Accepted values: Standard_LRS, Standard_ZRS, Standard_GRS, Standard_RAGRS, Premium_LRS - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageEncryption -Indicates whether or not to set the Storage account encryption to use Microsoft-managed keys. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: StorageEncryption -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table set as tags on the server. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UpgradeToStorageV2 -Upgrade Storage account Kind from Storage or BlobStorage to StorageV2. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseSubDomain -Indicates whether to enable indirect CName validation. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -### System.Boolean - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount - -## NOTES - -## RELATED LINKS - -[Get-AzureRmStorageAccount](./Get-AzureRmStorageAccount.md) - -[New-AzureRmStorageAccount](./New-AzureRmStorageAccount.md) - -[Remove-AzureRmStorageAccount](./Remove-AzureRmStorageAccount.md) diff --git a/azurermps-6.13.0/AzureRM.Storage/Set-AzureRmStorageContainerImmutabilityPolicy.md b/azurermps-6.13.0/AzureRM.Storage/Set-AzureRmStorageContainerImmutabilityPolicy.md deleted file mode 100644 index 5aa89825c9..0000000000 --- a/azurermps-6.13.0/AzureRM.Storage/Set-AzureRmStorageContainerImmutabilityPolicy.md +++ /dev/null @@ -1,319 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/set-azurermstoragecontainerimmutabilitypolicy -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Set-AzureRmStorageContainerImmutabilityPolicy.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Set-AzureRmStorageContainerImmutabilityPolicy.md ---- - -# Set-AzureRmStorageContainerImmutabilityPolicy - -## SYNOPSIS -Creates or updates ImmutabilityPolicy of a Storage blob containers - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### AccountName (Default) -``` -Set-AzureRmStorageContainerImmutabilityPolicy [-ResourceGroupName] <String> [-StorageAccountName] <String> - [-ContainerName] <String> -ImmutabilityPeriod <Int32> [-Etag <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ExtendAccountName -``` -Set-AzureRmStorageContainerImmutabilityPolicy [-ResourceGroupName] <String> [-StorageAccountName] <String> - [-ContainerName] <String> -ImmutabilityPeriod <Int32> -Etag <String> [-ExtendPolicy] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### AccountObject -``` -Set-AzureRmStorageContainerImmutabilityPolicy [-ContainerName] <String> -StorageAccount <PSStorageAccount> - -ImmutabilityPeriod <Int32> [-Etag <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ExtendAccountObject -``` -Set-AzureRmStorageContainerImmutabilityPolicy [-ContainerName] <String> -StorageAccount <PSStorageAccount> - -ImmutabilityPeriod <Int32> -Etag <String> [-ExtendPolicy] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ContainerObject -``` -Set-AzureRmStorageContainerImmutabilityPolicy -Container <PSContainer> -ImmutabilityPeriod <Int32> - [-Etag <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ExtendContainerObject -``` -Set-AzureRmStorageContainerImmutabilityPolicy -Container <PSContainer> -ImmutabilityPeriod <Int32> - -Etag <String> [-ExtendPolicy] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ImmutabilityPolicyObject -``` -Set-AzureRmStorageContainerImmutabilityPolicy -InputObject <PSImmutabilityPolicy> -ImmutabilityPeriod <Int32> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ExtendImmutabilityPolicyObject -``` -Set-AzureRmStorageContainerImmutabilityPolicy -InputObject <PSImmutabilityPolicy> -ImmutabilityPeriod <Int32> - [-ExtendPolicy] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmStorageContainerImmutabilityPolicy** cmdlet creates or updates ImmutabilityPolicy of a Storage blob containers - -## EXAMPLES - -### Example 1: Create or update ImmutabilityPolicy of a Storage blob container with Storage account name and container name -``` -PS C:\>Set-AzureRmStorageContainerImmutabilityPolicy -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" -ImmutabilityPeriod 10 -``` - -This command creates or updates ImmutabilityPolicy of a Storage blob container with Storage account name and container name. - -### Example 2: Extend ImmutabilityPolicy of a Storage blob container, with Storage account object -``` -PS C:\>$accountObject = Get-AzureRmStorageAccount -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -PS C:\>$policy = Get-AzureRmStorageContainerImmutabilityPolicy -StorageAccount $accountObject -ContainerName "myContainer" -PS C:\>Set-AzureRmStorageContainerImmutabilityPolicy -StorageAccount $accountObject -ContainerName "myContainer" -ImmutabilityPeriod 20 -Etag $policy.Etag -ExtendPolicy -``` - -This command extend ImmutabilityPolicy of a Storage blob container, with Storage account object. Extend ImmutabilityPolicy can only run after ImmutabilityPolicy is locked. - -### Example 3: Update ImmutabilityPolicyof a Storage blob container -``` -PS C:\>$containerObject = Get-AzureRmStorageContainer -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -Name "myContainer" -PS C:\>$policy = Set-AzureRmStorageContainerImmutabilityPolicy -Container $containerObject -ImmutabilityPeriod 12 -PS C:\>$policy = Set-AzureRmStorageContainerImmutabilityPolicy -Container $containerObject -ImmutabilityPeriod 9 -Etag $policy.Etag -``` - -This command updates ImmutabilityPolicy of a Storage blob container with Storage container object 2 times, first to ImmutabilityPeriod 12 days without etag, then to ImmutabilityPeriod 9 days with etag. - -### Example 4: Extend ImmutabilityPolicy of a Storage blob container, with ImmutabilityPolicy object -``` -PS C:\>Get-AzureRmStorageContainerImmutabilityPolicy -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" | Set-AzureRmStorageContainerImmutabilityPolicy -ImmutabilityPeriod 15 -ExtendPolicy -``` - -This command extend ImmutabilityPolicy of a Storage blob container, with ImmutabilityPolicy object. Extend ImmutabilityPolicy can only run after ImmutabilityPolicy is locked. - -## PARAMETERS - -### -Container -Storage container object - -```yaml -Type: PSContainer -Parameter Sets: ContainerObject, ExtendContainerObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ContainerName -Container Name - -```yaml -Type: String -Parameter Sets: AccountName, ExtendAccountName, AccountObject, ExtendAccountObject -Aliases: N - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Etag -Immutability policy etag. If -ExtendPolicy is not specified, Etag is optional; else Etag is required. - -```yaml -Type: String -Parameter Sets: AccountName, AccountObject, ContainerObject -Aliases: IfMatch - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ExtendAccountName, ExtendAccountObject, ExtendContainerObject -Aliases: IfMatch - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendPolicy -Indicate ExtendPolicy to Extend an existing ImmutabilityPolicy. After ImmutabilityPolicy is locked, it can only be extend. - -```yaml -Type: SwitchParameter -Parameter Sets: ExtendAccountName, ExtendAccountObject, ExtendContainerObject, ExtendImmutabilityPolicyObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImmutabilityPeriod -Immutability period since creation in days. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: ImmutabilityPeriodSinceCreationInDays - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Container Name - -```yaml -Type: PSImmutabilityPolicy -Parameter Sets: ImmutabilityPolicyObject, ExtendImmutabilityPolicyObject -Aliases: ImmutabilityPolicy - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: String -Parameter Sets: AccountName, ExtendAccountName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccount -Storage account object - -```yaml -Type: PSStorageAccount -Parameter Sets: AccountObject, ExtendAccountObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -StorageAccountName -Storage Account Name. - -```yaml -Type: String -Parameter Sets: AccountName, ExtendAccountName -Aliases: AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Microsoft.Azure.Commands.Management.Storage.Models.PSImmutabilityPolicy - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.Storage.Models.PSImmutabilityPolicy - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-6.13.0/AzureRM.Storage/Update-AzureRmStorageAccountNetworkRuleSet.md b/azurermps-6.13.0/AzureRM.Storage/Update-AzureRmStorageAccountNetworkRuleSet.md deleted file mode 100644 index 3f7ee37cce..0000000000 --- a/azurermps-6.13.0/AzureRM.Storage/Update-AzureRmStorageAccountNetworkRuleSet.md +++ /dev/null @@ -1,235 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/update-azurermstorageaccountnetworkruleset -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Update-AzureRmStorageAccountNetworkRuleSet.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Update-AzureRmStorageAccountNetworkRuleSet.md ---- - -# Update-AzureRmStorageAccountNetworkRuleSet - -## SYNOPSIS -Update the NetworkRule property of a Storage account - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Update-AzureRmStorageAccountNetworkRuleSet [-ResourceGroupName] <String> [-Name] <String> - [-Bypass <PSNetWorkRuleBypassEnum>] [-DefaultAction <PSNetWorkRuleDefaultActionEnum>] [-IPRule <PSIpRule[]>] - [-VirtualNetworkRule <PSVirtualNetworkRule[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureRmStorageAccountNetworkRuleSet** cmdlet updates the NetworkRule property of a Storage account - -## EXAMPLES - -### Example 1: Update all properties of NetworkRule, input Rules with JSON -``` -PS C:\> Update-AzureRmStorageAccountNetworkRuleSet -ResourceGroupName "myResourceGroup" -AccountName "mystorageaccount" -Bypass Logging,Metrics -DefaultAction Allow -IpRule (@{IPAddressOrRange="10.0.0.0/24";Action="allow"},@{IPAddressOrRange="28.2.0.0/16";Action="allow"}) - -VirtualNetworkRule (@{VirtualNetworkReourceId="/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1";Action="allow"},@{VirtualNetworkReourceId="/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualN - etworks/vnet2/subnets/subnet2";Action="allow"}) -``` - -This command update all properties of NetworkRule, input Rules with JSON. - -### Example 2: Update Bypass property of NetworkRule -``` -PS C:\> Update-AzureRmStorageAccountNetworkRuleSet -ResourceGroupName "myResourceGroup" -AccountName "mystorageaccount" -Bypass AzureServices,Metrics -``` - -This command update Bypass property of NetworkRule (other properties won't change). - -### Example 3: Clean up rules of NetworkRule of a Storage account -``` -PS C:\> Update-AzureRmStorageAccountNetworkRuleSet -ResourceGroupName "myResourceGroup" -AccountName "mystorageaccount" -IpRule @() -VirtualNetworkRule @() -``` - -This command clean up rules of NetworkRule of a Storage account (other properties not change). - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Bypass -The Bypass value to update to the NetworkRule property of a Storage account. -The allowed value are none or any combination of: -• Logging -• Metrics -• Azureservices - -```yaml -Type: Microsoft.Azure.Commands.Management.Storage.Models.PSNetWorkRuleBypassEnum -Parameter Sets: (All) -Aliases: -Accepted values: None, Logging, Metrics, AzureServices - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultAction -The DefaultAction value to update to the NetworkRule property of a Storage account. -The allowed Options: -• Allow -• Deny - -```yaml -Type: Microsoft.Azure.Commands.Management.Storage.Models.PSNetWorkRuleDefaultActionEnum -Parameter Sets: (All) -Aliases: -Accepted values: Deny, Allow - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPRule -The Array of IpRule objects to update to the NetworkRule Property of a Storage account. - -```yaml -Type: Microsoft.Azure.Commands.Management.Storage.Models.PSIpRule[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: StorageAccountName, AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group contains the Storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkRule -The Array of VirtualNetworkRule objects to update to the NetworkRule Property of a Storage account. - -```yaml -Type: Microsoft.Azure.Commands.Management.Storage.Models.PSVirtualNetworkRule[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Management.Storage.Models.PSIpRule[] -Parameters: IPRule (ByValue) - -### Microsoft.Azure.Commands.Management.Storage.Models.PSVirtualNetworkRule[] -Parameters: VirtualNetworkRule (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.Storage.Models.PSNetworkRuleSet - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Storage/Update-AzureRmStorageContainer.md b/azurermps-6.13.0/AzureRM.Storage/Update-AzureRmStorageContainer.md deleted file mode 100644 index a99a6ee696..0000000000 --- a/azurermps-6.13.0/AzureRM.Storage/Update-AzureRmStorageContainer.md +++ /dev/null @@ -1,233 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/update-azurermstoragecontainer -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Update-AzureRmStorageContainer.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/Commands.Management.Storage/help/Update-AzureRmStorageContainer.md ---- - -# Update-AzureRmStorageContainer - -## SYNOPSIS -Modifies a Storage blob container - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### AccountName (Default) -``` -Update-AzureRmStorageContainer [-ResourceGroupName] <String> [-StorageAccountName] <String> [-Name] <String> - [-PublicAccess <PSPublicAccess>] [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### AccountObject -``` -Update-AzureRmStorageContainer [-Name] <String> -StorageAccount <PSStorageAccount> - [-PublicAccess <PSPublicAccess>] [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ContainerObject -``` -Update-AzureRmStorageContainer -InputObject <PSContainer> [-PublicAccess <PSPublicAccess>] - [-Metadata <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureRmStorageContainer** cmdlet modifies a Storage blob container - -## EXAMPLES - -### Example 1: Modifies a Storage blob container's metadata and public access with Storage account name and container name -``` -PS C:\>Update-AzureRmStorageContainer -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" -PublicAccess Container -Metadata @{tag0="value0";tag1="value1"} -``` - -This command modifies a Storage blob container's metadata and public access with Storage account name and container name. - -### Example 2: Disable public access on a Storage blob container with Storage account object and container name -``` -PS C:\>$accountObject = Get-AzureRmStorageAccount -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -PS C:\>Update-AzureRmStorageContainer -StorageAccount $accountObject -ContainerName "myContainer" -PublicAccess None -``` - -This command disables public access on a Storage blob container with Storage account object and container name. - -### Example 3: Set public access as Blob for all Storage blob containers in a Storage account with pipeline -``` -PS C:\>Get-AzureRmStorageContainer -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" | Update-AzureRmStorageContainer -PublicAccess Blob -``` - -This command set public access as Blob for all Storage blob containers in a Storage account with pipeline. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Storage container object - -```yaml -Type: PSContainer -Parameter Sets: ContainerObject -Aliases: Container - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Metadata -Container Metadata - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Container Name - -```yaml -Type: String -Parameter Sets: AccountName, AccountObject -Aliases: N, ContainerName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PublicAccess -Container PublicAccess - -```yaml -Type: PSPublicAccess -Parameter Sets: (All) -Aliases: -Accepted values: Container, Blob - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name. - -```yaml -Type: String -Parameter Sets: AccountName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccount -Storage account object - -```yaml -Type: PSStorageAccount -Parameter Sets: AccountObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -StorageAccountName -Storage Account Name. - -```yaml -Type: String -Parameter Sets: AccountName -Aliases: AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.Storage.Models.PSContainer - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-6.13.0/AzureRM.StorageSync/AzureRm.StorageSync.md b/azurermps-6.13.0/AzureRM.StorageSync/AzureRm.StorageSync.md deleted file mode 100644 index f389389445..0000000000 --- a/azurermps-6.13.0/AzureRM.StorageSync/AzureRm.StorageSync.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -Module Name: AzureRm.StorageSync -Module Guid: 001b4bbc-9d7d-43b2-9e95-7a70325e9509 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.storagesync -Help Version: 1.0.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StorageSync/Commands.StorageSync/help/AzureRm.StorageSync.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StorageSync/Commands.StorageSync/help/AzureRm.StorageSync.md ---- - -# AzureRm.StorageSync Module -## Description -The cmdlets in the Storage Sync module enable you to manage operations pertaining to Azure File Sync in PowerShell. - -## AzureRm.StorageSync Cmdlets -### [Invoke-AzureRmStorageSyncCompatibilityCheck](Invoke-AzureRmStorageSyncCompatibilityCheck.md) -Checks for potential compatibility issues between your system and Azure File Sync. - diff --git a/azurermps-6.13.0/AzureRM.StorageSync/Invoke-AzureRmStorageSyncCompatibilityCheck.md b/azurermps-6.13.0/AzureRM.StorageSync/Invoke-AzureRmStorageSyncCompatibilityCheck.md deleted file mode 100644 index 98ebba767a..0000000000 --- a/azurermps-6.13.0/AzureRM.StorageSync/Invoke-AzureRmStorageSyncCompatibilityCheck.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.StorageSync.dll-Help.xml -Module Name: AzureRM.StorageSync -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storagesync/invoke-azurermstoragesynccompatibilitycheck -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StorageSync/Commands.StorageSync/help/Invoke-AzureRmStorageSyncCompatibilityCheck.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StorageSync/Commands.StorageSync/help/Invoke-AzureRmStorageSyncCompatibilityCheck.md ---- - -# Invoke-AzureRmStorageSyncCompatibilityCheck - -## SYNOPSIS -Checks for potential compatibility issues between your system and Azure File Sync. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### PathBased (Default) -``` -Invoke-AzureRmStorageSyncCompatibilityCheck [-Path] <String> [-Credential <PSCredential>] [-SkipSystemChecks] - [-SkipNamespaceChecks] [-Quiet] [<CommonParameters>] -``` - -### ComputerNameBased -``` -Invoke-AzureRmStorageSyncCompatibilityCheck [-Credential <PSCredential>] [-ComputerName] <String> - [-SkipSystemChecks] [-Quiet] [<CommonParameters>] -``` - -## DESCRIPTION -The **Invoke-AzureRmStorageSyncCompatibilityCheck** cmdlet checks for potential compatibility issues between your system and Azure File Sync. Given a local or remote path, it performs a set of validations on the system and file namespace, and then returns any compatibility issues it finds. -System checks: -- OS compatibility -File namespace checks: -- Unsupported characters -- Maximum file size -- Maximum path length -- Maximum file length -- Maximum dataset size -- Maximum directory depth - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Invoke-AzureRmStorageSyncCompatibilityCheck C:\DATA -``` - -This command checks the compatibility of the system and also of files and folders in C:\DATA. - -### Example 2 -```powershell -PS C:\> Invoke-AzureRmStorageSyncCompatibilityCheck C:\DATA -SkipSystemChecks -``` - -This command checks the compatibility of files and folders in C:\DATA, but does not perform a system compatibility check. - -### Example 3 -```powershell -PS C:\> $errors = Invoke-AzureRmStorageSyncCompatibilityCheck C:\DATA -PS C:\> $errors | Select-Object -Property Type, Path, Level, Description, Result | Export-Csv -Path C:\results -``` - -This command checks the compatibility of the system and also of files and folders in C:\DATA, and then exports the results as a CSV file to C:\results. - -## PARAMETERS - -### -ComputerName -The computer you are performing this check on. - -```yaml -Type: System.String -Parameter Sets: ComputerNameBased -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Your credentials for the share you are validating. - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -The UNC path of the share you are validating. - -```yaml -Type: System.String -Parameter Sets: PathBased -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Quiet -Suppresses writing output report to console. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipNamespaceChecks -Set this flag to skip file namespace validations and only perform system validations. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: PathBased -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipSystemChecks -Set this flag to skip system validations and only perform file namespace validations. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.StorageSync.Evaluation.Models.PSValidationResult - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, storagesync, filesync - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.StreamAnalytics/AzureRM.StreamAnalytics.md b/azurermps-6.13.0/AzureRM.StreamAnalytics/AzureRM.StreamAnalytics.md deleted file mode 100644 index ea98985c34..0000000000 --- a/azurermps-6.13.0/AzureRM.StreamAnalytics/AzureRM.StreamAnalytics.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -Module Name: AzureRM.StreamAnalytics -Module Guid: 59713673-194f-418a-b1f2-ac60db82edf9 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.streamanalytics -Help Version: 4.0.4.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/AzureRM.StreamAnalytics.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/AzureRM.StreamAnalytics.md ---- - -# AzureRM.StreamAnalytics Module -## Description -This topic displays help topics for the Azure Stream Analytics Cmdlets. - -## AzureRM.StreamAnalytics Cmdlets -### [Get-AzureRmStreamAnalyticsDefaultFunctionDefinition](Get-AzureRmStreamAnalyticsDefaultFunctionDefinition.md) -Gets the default definition of a function in Stream Analytics. - -### [Get-AzureRmStreamAnalyticsFunction](Get-AzureRmStreamAnalyticsFunction.md) -Gets functions in a Stream Analytics job. - -### [Get-AzureRmStreamAnalyticsInput](Get-AzureRmStreamAnalyticsInput.md) -Gets Stream Analytics job inputs. - -### [Get-AzureRmStreamAnalyticsJob](Get-AzureRmStreamAnalyticsJob.md) -Gets Stream Analytics jobs information. - -### [Get-AzureRmStreamAnalyticsOutput](Get-AzureRmStreamAnalyticsOutput.md) -Gets the outputs defined in a specified Stream Analytics job or output. - -### [Get-AzureRmStreamAnalyticsQuota](Get-AzureRmStreamAnalyticsQuota.md) -Gets information about the Streaming Unit quota for a region. - -### [Get-AzureRmStreamAnalyticsTransformation](Get-AzureRmStreamAnalyticsTransformation.md) -Gets information about a Stream Analytics job transformation. - -### [New-AzureRmStreamAnalyticsFunction](New-AzureRmStreamAnalyticsFunction.md) -Creates or replaces a function in a Stream Analytics job. - -### [New-AzureRmStreamAnalyticsInput](New-AzureRmStreamAnalyticsInput.md) -Creates or updates a job input. - -### [New-AzureRmStreamAnalyticsJob](New-AzureRmStreamAnalyticsJob.md) -Creates or updates a Stream Analytics job. - -### [New-AzureRmStreamAnalyticsOutput](New-AzureRmStreamAnalyticsOutput.md) -Creates or updates outputs for a Stream Analytics job. - -### [New-AzureRmStreamAnalyticsTransformation](New-AzureRmStreamAnalyticsTransformation.md) -Creates or updates a transformation within a job. - -### [Remove-AzureRmStreamAnalyticsFunction](Remove-AzureRmStreamAnalyticsFunction.md) -Deletes a function from a Stream Analytics job. - -### [Remove-AzureRmStreamAnalyticsInput](Remove-AzureRmStreamAnalyticsInput.md) -Deletes an input from a Stream Analytics job. - -### [Remove-AzureRmStreamAnalyticsJob](Remove-AzureRmStreamAnalyticsJob.md) -Removes a Stream Analytics job. - -### [Remove-AzureRmStreamAnalyticsOutput](Remove-AzureRmStreamAnalyticsOutput.md) -Deletes an output from a Stream Analytics job. - -### [Start-AzureRmStreamAnalyticsJob](Start-AzureRmStreamAnalyticsJob.md) -Starts a Stream Analytics job. - -### [Stop-AzureRmStreamAnalyticsJob](Stop-AzureRmStreamAnalyticsJob.md) -Stops a Stream Analytics job. - -### [Test-AzureRmStreamAnalyticsFunction](Test-AzureRmStreamAnalyticsFunction.md) -Tests whether Stream Analytics can connect to a function. - -### [Test-AzureRmStreamAnalyticsInput](Test-AzureRmStreamAnalyticsInput.md) -Tests the connection status of an input. - -### [Test-AzureRmStreamAnalyticsOutput](Test-AzureRmStreamAnalyticsOutput.md) -Tests the connection status of an output. - diff --git a/azurermps-6.13.0/AzureRM.StreamAnalytics/Get-AzureRmStreamAnalyticsDefaultFunctionDefinition.md b/azurermps-6.13.0/AzureRM.StreamAnalytics/Get-AzureRmStreamAnalyticsDefaultFunctionDefinition.md deleted file mode 100644 index faf7ef9e4e..0000000000 --- a/azurermps-6.13.0/AzureRM.StreamAnalytics/Get-AzureRmStreamAnalyticsDefaultFunctionDefinition.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.StreamAnalytics.dll-Help.xml -Module Name: AzureRM.StreamAnalytics -ms.assetid: EF16CE43-1035-4ED0-B9D1-E475DF659ECE -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.streamanalytics/get-azurermstreamanalyticsdefaultfunctiondefinition -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/Get-AzureRmStreamAnalyticsDefaultFunctionDefinition.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/Get-AzureRmStreamAnalyticsDefaultFunctionDefinition.md ---- - -# Get-AzureRmStreamAnalyticsDefaultFunctionDefinition - -## SYNOPSIS -Gets the default definition of a function in Stream Analytics. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmStreamAnalyticsDefaultFunctionDefinition [-JobName] <String> [-Name] <String> [-File] <String> - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmStreamAnalyticsDefaultFunctionDefinition** cmdlet gets the default definition of a function in Azure Stream Analytics. -You can use the default definition and the New-AzureRmStreamAnalyticsFunction cmdlet to create a function. -You can modify the default definition before you create a function. - -## EXAMPLES - -### Example 1: Get the default definition of a Stream Analytics function -``` -PS C:\>Get-AzureRmStreamAnalyticsDefaultFunctionDefinition -ResourceGroupName "StreamAnalytics-Default-West-US" -JobName "StreamJob22" -File "C:\RetrieveDefaultDefinitionRequest.json" -Name "ScoreTweet" -``` - -This command gets the default definition of the function named ScoreTweet by using the parameters specified in the RetrieveDefaultDefinitionRequest.json file. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -File -Specifies the path of a .json file that contains the JavaScript Object Notation (JSON) representation of the request body for the retrieve default function definition request. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobName -Specifies the name of the Stream Analytics job to which functions belong. -This cmdlet gets the default definition for a function in the job that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Stream Analytics function for which this cmdlet gets the default definition. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which Stream Analytics functions belongs. -This cmdlet gets a function definition for the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.StreamAnalytics.Models.PSFunction - -## NOTES - -## RELATED LINKS - -[New-AzureRmStreamAnalyticsFunction](./New-AzureRmStreamAnalyticsFunction.md) - - diff --git a/azurermps-6.13.0/AzureRM.StreamAnalytics/Get-AzureRmStreamAnalyticsFunction.md b/azurermps-6.13.0/AzureRM.StreamAnalytics/Get-AzureRmStreamAnalyticsFunction.md deleted file mode 100644 index 3f9e5eccfb..0000000000 --- a/azurermps-6.13.0/AzureRM.StreamAnalytics/Get-AzureRmStreamAnalyticsFunction.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.StreamAnalytics.dll-Help.xml -Module Name: AzureRM.StreamAnalytics -ms.assetid: 7F08A880-1FC5-4542-8AB8-927BB999A552 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.streamanalytics/get-azurermstreamanalyticsfunction -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/Get-AzureRmStreamAnalyticsFunction.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/Get-AzureRmStreamAnalyticsFunction.md ---- - -# Get-AzureRmStreamAnalyticsFunction - -## SYNOPSIS -Gets functions in a Stream Analytics job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmStreamAnalyticsFunction [-JobName] <String> [[-Name] <String>] [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmStreamAnalyticsFunction** cmdlet gets a list of the functions that are defined in an Azure Stream Analytics job or information about a specific function. - -## EXAMPLES - -### Example 1: Get all Stream Analytics functions -``` -PS C:\>Get-AzureRmStreamAnalyticsFunction -ResourceGroupName "StreamAnalytics-Default-West-US" -JobName "StreamJob22" -``` - -This command gets the functions defined on the job named StreamJob22. - -### Example 2: Get a specific Stream Analytics function -``` -PS C:\>Get-AzureRmStreamAnalyticsFunction -ResourceGroupName "StreamAnalytics-Default-West-US" -JobName "StreamJob22" -Name "ScoreTweet" -``` - -This command gets information about the function named ScoreTweet defined on the job named StreamJob22. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobName -Specifies the name of the Stream Analytics job to which functions belong. -This cmdlet gets functions for the job that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Stream Analytics function that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which Stream Analytics functions belongs. -This cmdlet gets functions for the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.StreamAnalytics.Models.PSFunction - -## NOTES - -## RELATED LINKS - -[New-AzureRmStreamAnalyticsFunction](./New-AzureRmStreamAnalyticsFunction.md) - -[Remove-AzureRmStreamAnalyticsFunction](./Remove-AzureRmStreamAnalyticsFunction.md) - -[Test-AzureRmStreamAnalyticsFunction](./Test-AzureRmStreamAnalyticsFunction.md) - - diff --git a/azurermps-6.13.0/AzureRM.StreamAnalytics/Get-AzureRmStreamAnalyticsInput.md b/azurermps-6.13.0/AzureRM.StreamAnalytics/Get-AzureRmStreamAnalyticsInput.md deleted file mode 100644 index 6c3cebb5fe..0000000000 --- a/azurermps-6.13.0/AzureRM.StreamAnalytics/Get-AzureRmStreamAnalyticsInput.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.StreamAnalytics.dll-Help.xml -Module Name: AzureRM.StreamAnalytics -ms.assetid: F371FD62-D138-4610-84A1-93EDC42D6AAC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.streamanalytics/get-azurermstreamanalyticsinput -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/Get-AzureRmStreamAnalyticsInput.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/Get-AzureRmStreamAnalyticsInput.md ---- - -# Get-AzureRmStreamAnalyticsInput - -## SYNOPSIS -Gets Stream Analytics job inputs. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmStreamAnalyticsInput [-JobName] <String> [[-Name] <String>] [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmStreamAnalyticsInput** cmdlet lists all of the inputs that are defined in a Stream Analytics job or gets information about a specific input. - -## EXAMPLES - -### EXAMPLE 1: Get information about the inputs defined on a job -``` -PS C:\>Get-AzureRmStreamAnalyticsInput -ResourceGroupName "StreamAnalytics-Default-West-US" -JobName "StreamingJob" -``` - -This command returns information about all the inputs defined on the job StreamingJob. - -### EXAMPLE 2: Get information about a specific input defined on a job -``` -PS C:\>Get-AzureRmStreamAnalyticsInput -ResourceGroupName "StreamAnalytics-Default-West-US" -JobName "StreamingJob" -Name "EntryStream" -``` - -This command returns information about the input named EntryStream defined on the job StreamingJob. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobName -Specifies the name of the Azure Stream Analytics job to which the Azure Stream Analytics input belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Azure Stream Analytics input to retrieve. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the Azure Stream Analytics input belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.StreamAnalytics.Models.PSInput - -## NOTES - -## RELATED LINKS - -[New-AzureRmStreamAnalyticsInput](./New-AzureRmStreamAnalyticsInput.md) - -[Remove-AzureRmStreamAnalyticsInput](./Remove-AzureRmStreamAnalyticsInput.md) - -[Test-AzureRmStreamAnalyticsInput](./Test-AzureRmStreamAnalyticsInput.md) - - diff --git a/azurermps-6.13.0/AzureRM.StreamAnalytics/Get-AzureRmStreamAnalyticsJob.md b/azurermps-6.13.0/AzureRM.StreamAnalytics/Get-AzureRmStreamAnalyticsJob.md deleted file mode 100644 index 3cdd72c75c..0000000000 --- a/azurermps-6.13.0/AzureRM.StreamAnalytics/Get-AzureRmStreamAnalyticsJob.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.StreamAnalytics.dll-Help.xml -Module Name: AzureRM.StreamAnalytics -ms.assetid: 1D10C1EA-632A-4953-85B1-596A45C30B24 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.streamanalytics/get-azurermstreamanalyticsjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/Get-AzureRmStreamAnalyticsJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/Get-AzureRmStreamAnalyticsJob.md ---- - -# Get-AzureRmStreamAnalyticsJob - -## SYNOPSIS -Gets Stream Analytics jobs information. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByResourceGroup -``` -Get-AzureRmStreamAnalyticsJob [-ResourceGroupName] <String> [[-Name] <String>] [-NoExpand] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### BySubscription -``` -Get-AzureRmStreamAnalyticsJob [-NoExpand] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmStreamAnalyticsJob** cmdlet lists all Stream Analytics jobs defined in the Azure subscription or specified resource group or gets job information about a specific job within a resource group. - -## EXAMPLES - -### EXAMPLE 1: Get information about all jobs in a subscription -``` -PS C:\>Get-AzureRmStreamAnalyticsJob -``` - -This command returns information about all the Stream Analytics jobs in the Azure subscription. - -### EXAMPLE 2: Get information about all jobs in a resource group -``` -PS C:\>Get-AzureRmStreamAnalyticsJob -ResourceGroupName "StreamAnalytics-Default-West-US" -``` - -This command returns information about all the Stream Analytics jobs in the resource group StreamAnalytics-Default-West-US. - -### EXAMPLE 3: Get information about a specific job in a resource group -``` -PS C:\>Get-AzureRmStreamAnalyticsJob -ResourceGroupName "StreamAnalytics-Default-West-US" -Name "StreamingJob" -``` - -This command returns information about the Stream Analytics job StreamingJob in the resource group StreamAnalytics-Default-West-US. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Azure Stream Analytics job to retrieve. - -```yaml -Type: System.String -Parameter Sets: ByResourceGroup -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NoExpand -Indicates the cmdlet will retrieve the Azure Stream Analytics job, but not return information on its inputs, outputs, and transformation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the Azure Stream Analytics job belongs. - -```yaml -Type: System.String -Parameter Sets: ByResourceGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.StreamAnalytics.Models.PSJob - -## NOTES - -## RELATED LINKS - -[New-AzureRmStreamAnalyticsJob](./New-AzureRmStreamAnalyticsJob.md) - -[Remove-AzureRmStreamAnalyticsJob](./Remove-AzureRmStreamAnalyticsJob.md) - -[Start-AzureRmStreamAnalyticsJob](./Start-AzureRmStreamAnalyticsJob.md) - -[Stop-AzureRmStreamAnalyticsJob](./Stop-AzureRmStreamAnalyticsJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.StreamAnalytics/Get-AzureRmStreamAnalyticsOutput.md b/azurermps-6.13.0/AzureRM.StreamAnalytics/Get-AzureRmStreamAnalyticsOutput.md deleted file mode 100644 index 470d1a54c1..0000000000 --- a/azurermps-6.13.0/AzureRM.StreamAnalytics/Get-AzureRmStreamAnalyticsOutput.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.StreamAnalytics.dll-Help.xml -Module Name: AzureRM.StreamAnalytics -ms.assetid: 04A6FD47-482C-4EA6-9375-D8B6FD1F2659 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.streamanalytics/get-azurermstreamanalyticsoutput -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/Get-AzureRmStreamAnalyticsOutput.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/Get-AzureRmStreamAnalyticsOutput.md ---- - -# Get-AzureRmStreamAnalyticsOutput - -## SYNOPSIS -Gets the outputs defined in a specified Stream Analytics job or output. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmStreamAnalyticsOutput [-JobName] <String> [[-Name] <String>] [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmStreamAnalyticsOutput** cmdlet lists all of the outputs that are defined in a specified Stream Analytics job or gets information about a specific output. - -## EXAMPLES - -### EXAMPLE 1: Get information about job outputs -``` -PS C:\>Get-AzureRmStreamAnalyticsOutput -ResourceGroupName "StreamAnalytics-Default-West-US" -JobName "StreamingJob" -``` - -This command returns information about the outputs defined on the job StreamingJob. - -### EXAMPLE 2: Get information about a specific job output -``` -PS C:\>Get-AzureRmStreamAnalyticsOutput -ResourceGroupName "StreamAnalytics-Default-West-US" -JobName "StreamingJob" -Name "Output" -``` - -This command returns information about the output named Output defined on the job StreamingJob. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobName -Specifies the name of the Azure Stream Analytics job to which the Azure Stream Analytics output belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Azure Stream Analytics output to retrieve. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the Azure Stream Analytics output belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.StreamAnalytics.Models.PSOutput - -## NOTES - -## RELATED LINKS - -[New-AzureRmStreamAnalyticsOutput](./New-AzureRmStreamAnalyticsOutput.md) - -[Remove-AzureRmStreamAnalyticsOutput](./Remove-AzureRmStreamAnalyticsOutput.md) - -[Test-AzureRmStreamAnalyticsOutput](./Test-AzureRmStreamAnalyticsOutput.md) - - diff --git a/azurermps-6.13.0/AzureRM.StreamAnalytics/Get-AzureRmStreamAnalyticsQuota.md b/azurermps-6.13.0/AzureRM.StreamAnalytics/Get-AzureRmStreamAnalyticsQuota.md deleted file mode 100644 index f64870d823..0000000000 --- a/azurermps-6.13.0/AzureRM.StreamAnalytics/Get-AzureRmStreamAnalyticsQuota.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.StreamAnalytics.dll-Help.xml -Module Name: AzureRM.StreamAnalytics -ms.assetid: ECD0950F-2490-49E2-85E6-5FA2A59364E6 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.streamanalytics/get-azurermstreamanalyticsquota -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/Get-AzureRmStreamAnalyticsQuota.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/Get-AzureRmStreamAnalyticsQuota.md ---- - -# Get-AzureRmStreamAnalyticsQuota - -## SYNOPSIS -Gets information about the Streaming Unit quota for a region. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmStreamAnalyticsQuota [-Location] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmStreamAnalyticsQuota** cmdlet gets information about the Streaming Unit quota for a region. - -## EXAMPLES - -### EXAMPLE 1: Get information about the Streaming Unit quota for a region -``` -PS C:\>Get-AzureRmStreamAnalyticsQuota -Location "West US" -``` - -This command returns information about Streaming Unit quota and usage in the West US region. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the name of an Azure region or data center location for which to get Streaming Unit quota information. -See https://azure.microsoft.com/en-us/regions/#serviceshttps://azure.microsoft.com/en-us/regions/#services for a list of supported Azure regions. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.StreamAnalytics.Models.PSQuota - -## NOTES - -## RELATED LINKS - -[Azure Stream Analytics Cmdlets](./AzureRM.StreamAnalytics.md) - - diff --git a/azurermps-6.13.0/AzureRM.StreamAnalytics/Get-AzureRmStreamAnalyticsTransformation.md b/azurermps-6.13.0/AzureRM.StreamAnalytics/Get-AzureRmStreamAnalyticsTransformation.md deleted file mode 100644 index 0a7465307c..0000000000 --- a/azurermps-6.13.0/AzureRM.StreamAnalytics/Get-AzureRmStreamAnalyticsTransformation.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.StreamAnalytics.dll-Help.xml -Module Name: AzureRM.StreamAnalytics -ms.assetid: 34E1CC9E-9F81-4DA6-A777-D816B09BDE1B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.streamanalytics/get-azurermstreamanalyticstransformation -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/Get-AzureRmStreamAnalyticsTransformation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/Get-AzureRmStreamAnalyticsTransformation.md ---- - -# Get-AzureRmStreamAnalyticsTransformation - -## SYNOPSIS -Gets information about a Stream Analytics job transformation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmStreamAnalyticsTransformation [-JobName] <String> [-Name] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmStreamAnalyticsTransformation** cmdlet gets information about a transformation defined on a Stream Analytics job. - -## EXAMPLES - -### EXAMPLE 1: Get information about a Stream Analytics transformation -``` -PS C:\>Get-AzureRmStreamAnalyticsTransformation -ResourceGroupName "StreamAnalytics-Default-West-US" -JobName "StreamingJob" -Name "StreamingJob" -``` - -This command returns information about the transformation called StreamingJob on the job called StreamingJob. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobName -Specifies the name of the Azure Stream Analytics job to which the Azure Stream Analytics transformation belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Azure Stream Analytics transformation to retrieve. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the Azure Stream Analytics transformation belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.StreamAnalytics.Models.PSTransformation - -## NOTES - -## RELATED LINKS - -[New-AzureRmStreamAnalyticsTransformation](./New-AzureRmStreamAnalyticsTransformation.md) - - diff --git a/azurermps-6.13.0/AzureRM.StreamAnalytics/New-AzureRmStreamAnalyticsFunction.md b/azurermps-6.13.0/AzureRM.StreamAnalytics/New-AzureRmStreamAnalyticsFunction.md deleted file mode 100644 index b124f151b1..0000000000 --- a/azurermps-6.13.0/AzureRM.StreamAnalytics/New-AzureRmStreamAnalyticsFunction.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.StreamAnalytics.dll-Help.xml -Module Name: AzureRM.StreamAnalytics -ms.assetid: 79EB2AD9-BFE1-49BE-870F-7DFC99D6FE17 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.streamanalytics/new-azurermstreamanalyticsfunction -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/New-AzureRmStreamAnalyticsFunction.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/New-AzureRmStreamAnalyticsFunction.md ---- - -# New-AzureRmStreamAnalyticsFunction - -## SYNOPSIS -Creates or replaces a function in a Stream Analytics job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmStreamAnalyticsFunction [-JobName] <String> [[-Name] <String>] [-File] <String> [-Force] - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmStreamAnalyticsFunction** cmdlet creates a function in an Azure Stream Analytics job or replaces an existing function. -Define the function in a JavaScript Object Notation (JSON) file. -You can specify the name of the function by using the *Name* parameter or in the .json file. -If you specify the name in both ways, the names must match. -To replace an existing function, specify the name of the existing function. - -## EXAMPLES - -### Example 1: Create a Stream Analytics function -``` -PS C:\>New-AzureRmStreamAnalyticsFunction -ResourceGroupName "StreamAnalytics-Default-West-US" -JobName "StreamJob07" -File "C:\Function07.json" -``` - -This command creates a function from the file Function07.json. -The name of the function is stored in the .json file. - -### Example 2: Create a Stream Analytics function named ScoreTweet -``` -PS C:\>New-AzureRmStreamAnalyticsFunction -ResourceGroupName "StreamAnalytics-Default-West-US" -JobName "StreamJob22" -File "C:\Function22.json" -Name "ScoreTweet" -``` - -This command creates a function on the job named ScoreTweet. - -### Example 3: Replace a Stream Analytics function -``` -PS C:\>New-AzureRmStreamAnalyticsFunction -ResourceGroupName "StreamAnalytics-Default-West-US" -JobName "StreamJob22" -File "C:\Function22.json" -Name "ScoreTweet" -Force -``` - -This command replaces the definition of the existing function named ScoreTweet with the definition in Function22.json. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -File -Specifies the path of a .json file that contains the JSON representation of the Stream Analytics function. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Indicates that this cmdlet replaces an existing Stream Analytics function without prompting you for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobName -Specifies the name of the Stream Analytics job under which this cmdlet creates a Stream Analytics function. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Stream Analytics function that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group under which this cmdlet creates a Stream Analytics function. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.StreamAnalytics.Models.PSFunction - -## NOTES - -## RELATED LINKS - -[Get-AzureRmStreamAnalyticsFunction](./Get-AzureRmStreamAnalyticsFunction.md) - -[Remove-AzureRmStreamAnalyticsFunction](./Remove-AzureRmStreamAnalyticsFunction.md) - -[Test-AzureRmStreamAnalyticsFunction](./Test-AzureRmStreamAnalyticsFunction.md) - - diff --git a/azurermps-6.13.0/AzureRM.StreamAnalytics/New-AzureRmStreamAnalyticsInput.md b/azurermps-6.13.0/AzureRM.StreamAnalytics/New-AzureRmStreamAnalyticsInput.md deleted file mode 100644 index 0130c8fe2a..0000000000 --- a/azurermps-6.13.0/AzureRM.StreamAnalytics/New-AzureRmStreamAnalyticsInput.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.StreamAnalytics.dll-Help.xml -Module Name: AzureRM.StreamAnalytics -ms.assetid: 35CE5C5F-F8D4-426F-A33A-4F9EA50E9B83 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.streamanalytics/new-azurermstreamanalyticsinput -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/New-AzureRmStreamAnalyticsInput.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/New-AzureRmStreamAnalyticsInput.md ---- - -# New-AzureRmStreamAnalyticsInput - -## SYNOPSIS -Creates or updates a job input. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmStreamAnalyticsInput [-JobName] <String> [[-Name] <String>] [-File] <String> [-Force] - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmStreamAnalyticsInput** cmdlet creates an input within a Stream Analytics job or updates an existing input. -The name of the input can be specified in the JSON file or on the command line. -If both are specified, the name on command line must match the name in the file. -If you specify an input that already exists and do not specify the *Force* parameter, the cmdlet will ask whether or not to replace the existing input. -If you specify the *Force* parameter and specify an existing input name, the input will be replaced without confirmation. - -## EXAMPLES - -### EXAMPLE 1: Create a job input with a definition from a file -``` -PS C:\>New-AzureRmStreamAnalyticsInput -ResourceGroupName "StreamAnalytics-Default-West-US" -JobName "StreamingJob" -File "C:\Input.json" -``` - -This command creates an input from the file Input.json. -If an existing input with the name specified in the input definition file is already defined, the cmdlet will ask whether or not to replace it. - -### EXAMPLE 2: Create a job input -``` -PS C:\>New-AzureRmStreamAnalyticsInput -ResourceGroupName "StreamAnalytics-Default-West-US" -JobName "StreamingJob" -File "C:\Input.json" -Name "EntryStream" -``` - -This command creates a new input on the job called EntryStream. -If an existing input with this name is already defined, the cmdlet will ask whether or not to replace it. - -### EXAMPLE 3: Replace a job input with a definition from a file -``` -PS C:\>New-AzureRmStreamAnalyticsInput -ResourceGroupName "StreamAnalytics-Default-West-US" -JobName "StreamingJob" -File "C:\Input.json" -Name "EntryStream" -Force -``` - -This command replaces the definition of the existing input source called EntryStream with the definition from file without confirmation. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -File -Specifies the path to a JSON file that contains the JSON representation of the Azure Stream Analytics input to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobName -Specifies the name of the Azure Stream Analytics job under which to create the Azure Stream Analytics input. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Azure Stream Analytics input to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group under which to create the Azure Streaming input. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.StreamAnalytics.Models.PSInput - -## NOTES - -## RELATED LINKS - -[Get-AzureRmStreamAnalyticsInput](./Get-AzureRmStreamAnalyticsInput.md) - -[Remove-AzureRmStreamAnalyticsInput](./Remove-AzureRmStreamAnalyticsInput.md) - -[Test-AzureRmStreamAnalyticsInput](./Test-AzureRmStreamAnalyticsInput.md) - - diff --git a/azurermps-6.13.0/AzureRM.StreamAnalytics/New-AzureRmStreamAnalyticsJob.md b/azurermps-6.13.0/AzureRM.StreamAnalytics/New-AzureRmStreamAnalyticsJob.md deleted file mode 100644 index 2deaae3418..0000000000 --- a/azurermps-6.13.0/AzureRM.StreamAnalytics/New-AzureRmStreamAnalyticsJob.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.StreamAnalytics.dll-Help.xml -Module Name: AzureRM.StreamAnalytics -ms.assetid: F281B351-F7C7-47D1-9745-FFE4BAA840FD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.streamanalytics/new-azurermstreamanalyticsjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/New-AzureRmStreamAnalyticsJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/New-AzureRmStreamAnalyticsJob.md ---- - -# New-AzureRmStreamAnalyticsJob - -## SYNOPSIS -Creates or updates a Stream Analytics job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmStreamAnalyticsJob [[-Name] <String>] [-File] <String> [-Force] [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmStreamAnalyticsJob** cmdlet creates a new Stream Analytics job in Azure or updates the definition of an existing specified job. -The name of the job can be specified in the .JSON file or on the command line. -If both are specified, the name on command line must match the name in the file. -If you specify a job name that already exists and do not specify the *Force* parameter, the cmdlet will ask whether or not to replace the existing job. -If you specify the *Force* parameter and specify an existing job name, the job definition will be replaced without confirmation. - -## EXAMPLES - -### EXAMPLE 1: Create a job -``` -PS C:\>New-AzureRmStreamAnalyticsJob -ResourceGroupName "StreamAnalytics-Default-West-US" -File "C:\JobDefinition.json" -``` - -This command creates a job from the definition in JobDefinition.json. -If an existing job with the specified name in the job definition file is already defined, the cmdlet will ask whether or not to replace it. - -### EXAMPLE 2: Replace a job definition -``` -PS C:\>New-AzureRmStreamAnalyticsJob -ResourceGroupName "StreamAnalytics-Default-West-US" -File "C:\JobDefinition.json" -Name "StreamingJob" -Force -``` - -This command replaces the job definition for StreamingJob without confirmation. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -File -Specifies the path to a JSON file that contains the JSON representation of the Azure Stream Analytics job to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Azure Stream Analytics job to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the Azure Stream Analytics job should belong. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.StreamAnalytics.Models.PSJob - -## NOTES - -## RELATED LINKS - -[Get-AzureRmStreamAnalyticsJob](./Get-AzureRmStreamAnalyticsJob.md) - -[Remove-AzureRmStreamAnalyticsJob](./Remove-AzureRmStreamAnalyticsJob.md) - -[Start-AzureRmStreamAnalyticsJob](./Start-AzureRmStreamAnalyticsJob.md) - -[Stop-AzureRmStreamAnalyticsJob](./Stop-AzureRmStreamAnalyticsJob.md) - -[Stop-AzureRmStreamAnalyticsJob](./Stop-AzureRmStreamAnalyticsJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.StreamAnalytics/New-AzureRmStreamAnalyticsOutput.md b/azurermps-6.13.0/AzureRM.StreamAnalytics/New-AzureRmStreamAnalyticsOutput.md deleted file mode 100644 index d0a0ef93ec..0000000000 --- a/azurermps-6.13.0/AzureRM.StreamAnalytics/New-AzureRmStreamAnalyticsOutput.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.StreamAnalytics.dll-Help.xml -Module Name: AzureRM.StreamAnalytics -ms.assetid: 43B2A4FD-DA74-403A-89D0-40FE9A3E5A7E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.streamanalytics/new-azurermstreamanalyticsoutput -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/New-AzureRmStreamAnalyticsOutput.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/New-AzureRmStreamAnalyticsOutput.md ---- - -# New-AzureRmStreamAnalyticsOutput - -## SYNOPSIS -Creates or updates outputs for a Stream Analytics job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmStreamAnalyticsOutput [-JobName] <String> [[-Name] <String>] [-File] <String> [-Force] - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmStreamAnalyticsOutput** cmdlet creates an output within a Stream Analytics job or updates an existing output. -The name of the output can be specified in the .JSON file or on the command line. -If both are specified, the name on command line must match the name in the file. -If you specify an output that already exists and do not specify the *Force* parameter, the cmdlet will ask whether or not to replace the existing output. -If you specify the *Force* parameter and specify an existing output name, the output will be replaced without confirmation. - -## EXAMPLES - -### EXAMPLE 1: Add an output to a job -``` -PS C:\>New-AzureRmStreamAnalyticsOutput -ResourceGroupName "StreamAnalytics-Default-West-US" -File "C:\Output.json" -JobName "StreamingJob" -Name "Output" -``` - -This command creates a new output called Output in the job called StreamingJob. -If an existing output with this name is already defined, the cmdlet will ask whether or not to replace it. - -### EXAMPLE 2: Replace a job output definition -``` -PS C:\>New-AzureRmStreamAnalyticsOutput -ResourceGroupName "StreamAnalytics-Default-West-US" -File "C:\Output.json" -JobName "StreamingJob" -Name "Output" -Force -``` - -This command replaces the definition for Output in the job called StreamingJob without confirmation. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -File -Specifies the path to a JSON file that contains the JSON representation of the Azure Stream Analytics output to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobName -Specifies the name of the Azure Stream Analytics job under which to create the Azure Stream Analytics output. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Azure Stream Analytics output to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group under which to create the Azure Stream Analytics output. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.StreamAnalytics.Models.PSOutput - -## NOTES - -## RELATED LINKS - -[Get-AzureRmStreamAnalyticsOutput](./Get-AzureRmStreamAnalyticsOutput.md) - -[Remove-AzureRmStreamAnalyticsOutput](./Remove-AzureRmStreamAnalyticsOutput.md) - -[Test-AzureRmStreamAnalyticsOutput](./Test-AzureRmStreamAnalyticsOutput.md) - - diff --git a/azurermps-6.13.0/AzureRM.StreamAnalytics/New-AzureRmStreamAnalyticsTransformation.md b/azurermps-6.13.0/AzureRM.StreamAnalytics/New-AzureRmStreamAnalyticsTransformation.md deleted file mode 100644 index c24c76dc73..0000000000 --- a/azurermps-6.13.0/AzureRM.StreamAnalytics/New-AzureRmStreamAnalyticsTransformation.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.StreamAnalytics.dll-Help.xml -Module Name: AzureRM.StreamAnalytics -ms.assetid: 8FF53426-D4AE-455E-A182-D7FBC7262FE1 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.streamanalytics/new-azurermstreamanalyticstransformation -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/New-AzureRmStreamAnalyticsTransformation.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/New-AzureRmStreamAnalyticsTransformation.md ---- - -# New-AzureRmStreamAnalyticsTransformation - -## SYNOPSIS -Creates or updates a transformation within a job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmStreamAnalyticsTransformation [-JobName] <String> [[-Name] <String>] [-File] <String> [-Force] - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmStreamAnalyticsTransformation** cmdlet creates a transformation within a Stream Analytics job or updates the existing transformation. -The name of the transformation can be specified in the .JSON file or on the command line. -If both are specified, the name on command line must match the name in the file. -If you specify a transformation that already exists and do not specify the Force parameter, the cmdlet will ask whether or not to replace the existing transformation. -If you specify the *Force* parameter and specify an existing transformation name, the transformation will be replaced without confirmation. - -## EXAMPLES - -### EXAMPLE 1: Create or replace a transformation in a job -``` -PS C:\>New-AzureRmStreamAnalyticsTransformation -ResourceGroupName "StreamAnalytics-Default-West-US" -File "C:\Transformation.json" -JobName "StreamingJob" -Name "StreamingJobTransform" -``` - -This command creates a transformation called StreamingJobTransform in the job called StreamingJob. -If an existing transformation is already defined with that name, the cmdlet will ask whether or not to replace it. - -### EXAMPLE 2: Replace a transformation in a job -``` -PS C:\>New-AzureRmStreamAnalyticsTransformation -ResourceGroupName "StreamAnalytics-Default-West-US" -File "C:\Transformation.json" -JobName "StreamingJob" -Name "StreamingJobTransform" -Force -``` - -This command replaces the definition of StreamingJobTransform in the job StreamingJob without confirmation. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -File -Specifies the path to a JSON file that contains the JSON representation of the Azure Stream Analytics transformation to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobName -Specifies the name of the Azure Stream Analytics job under which to create the Azure Stream Analytics transformation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Azure Stream Analytics transformation to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group under which to create the Azure Stream Analytics transformation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.StreamAnalytics.Models.PSTransformation - -## NOTES - -## RELATED LINKS - -[Get-AzureRmStreamAnalyticsTransformation](./Get-AzureRmStreamAnalyticsTransformation.md) - - diff --git a/azurermps-6.13.0/AzureRM.StreamAnalytics/Remove-AzureRmStreamAnalyticsFunction.md b/azurermps-6.13.0/AzureRM.StreamAnalytics/Remove-AzureRmStreamAnalyticsFunction.md deleted file mode 100644 index e33dd50e95..0000000000 --- a/azurermps-6.13.0/AzureRM.StreamAnalytics/Remove-AzureRmStreamAnalyticsFunction.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.StreamAnalytics.dll-Help.xml -Module Name: AzureRM.StreamAnalytics -ms.assetid: 75B0776E-32D5-4EE4-B35C-73E13185A4F1 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.streamanalytics/remove-azurermstreamanalyticsfunction -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/Remove-AzureRmStreamAnalyticsFunction.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/Remove-AzureRmStreamAnalyticsFunction.md ---- - -# Remove-AzureRmStreamAnalyticsFunction - -## SYNOPSIS -Deletes a function from a Stream Analytics job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmStreamAnalyticsFunction [-JobName] <String> [-Name] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmStreamAnalyticsFunction** cmdlet deletes a function asynchronously from an Azure Stream Analytics job. - -## EXAMPLES - -### Example 1: Remove a Stream Analytics function -``` -PS C:\>Remove-AzureRmStreamAnalyticsFunction -ResourceGroupName "StreamAnalytics-Default-West-US" -JobName "StreamJob22" -Name "ScoreTweet" -``` - -This command removes the function named ScoreTweet from the job named StreamJob22. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobName -Specifies the name of the Stream Analytics job to which a function belongs. -This cmdlet removes a function from the job that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Stream Analytics function that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which a Stream Analytics function belongs. -This cmdlet deletes a function in the resource group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmStreamAnalyticsFunction](./Get-AzureRmStreamAnalyticsFunction.md) - -[New-AzureRmStreamAnalyticsFunction](./New-AzureRmStreamAnalyticsFunction.md) - -[Test-AzureRmStreamAnalyticsFunction](./Test-AzureRmStreamAnalyticsFunction.md) - - diff --git a/azurermps-6.13.0/AzureRM.StreamAnalytics/Remove-AzureRmStreamAnalyticsInput.md b/azurermps-6.13.0/AzureRM.StreamAnalytics/Remove-AzureRmStreamAnalyticsInput.md deleted file mode 100644 index a256330e7a..0000000000 --- a/azurermps-6.13.0/AzureRM.StreamAnalytics/Remove-AzureRmStreamAnalyticsInput.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.StreamAnalytics.dll-Help.xml -Module Name: AzureRM.StreamAnalytics -ms.assetid: 1449F64F-A8F9-4E8E-B62B-17DEF3A0FB30 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.streamanalytics/remove-azurermstreamanalyticsinput -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/Remove-AzureRmStreamAnalyticsInput.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/Remove-AzureRmStreamAnalyticsInput.md ---- - -# Remove-AzureRmStreamAnalyticsInput - -## SYNOPSIS -Deletes an input from a Stream Analytics job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmStreamAnalyticsInput [-JobName] <String> [-Name] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmStreamAnalyticsInput** cmdlet asynchronously deletes an input from a Stream Analytics job in Azure. - -## EXAMPLES - -### EXAMPLE 1: Remove an input stream from a job -``` -PS C:\>Remove-AzureRmStreamAnalyticsInput -ResourceGroupName "StreamAnalytics-Default-West-US" -JobName "StreamingJob" -Name "EventStream" -``` - -This command removes the input EventStream from StreamingJob. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobName -Specifies the name of the Azure Stream Analytics job to which the Azure Stream Analytics input belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Azure Stream Analytics input to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the Azure Stream Analytics input belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[New-AzureRmStreamAnalyticsInput](./New-AzureRmStreamAnalyticsInput.md) - -[Get-AzureRmStreamAnalyticsInput](./Get-AzureRmStreamAnalyticsInput.md) - -[Test-AzureRmStreamAnalyticsInput](./Test-AzureRmStreamAnalyticsInput.md) - - diff --git a/azurermps-6.13.0/AzureRM.StreamAnalytics/Remove-AzureRmStreamAnalyticsJob.md b/azurermps-6.13.0/AzureRM.StreamAnalytics/Remove-AzureRmStreamAnalyticsJob.md deleted file mode 100644 index 8b64b76f15..0000000000 --- a/azurermps-6.13.0/AzureRM.StreamAnalytics/Remove-AzureRmStreamAnalyticsJob.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.StreamAnalytics.dll-Help.xml -Module Name: AzureRM.StreamAnalytics -ms.assetid: 2F3BDDFE-7585-4802-BFA5-D110F846A33E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.streamanalytics/remove-azurermstreamanalyticsjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/Remove-AzureRmStreamAnalyticsJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/Remove-AzureRmStreamAnalyticsJob.md ---- - -# Remove-AzureRmStreamAnalyticsJob - -## SYNOPSIS -Removes a Stream Analytics job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmStreamAnalyticsJob [-Name] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmStreamAnalyticsJob** cmdlet asynchronously deletes a specific Stream Analytics job in Azure. - -## EXAMPLES - -### EXAMPLE 1: Remove a job -``` -PS C:\>Remove-AzureRmStreamAnalyticsJob -ResourceGroupName "StreamAnalytics-Default-West-US" -Name "StreamingJob" -``` - -This command removes the job StreamingJob. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Azure Stream Analytics job to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the Azure Stream Analytics job belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmStreamAnalyticsJob](./Get-AzureRmStreamAnalyticsJob.md) - -[New-AzureRmStreamAnalyticsJob](./New-AzureRmStreamAnalyticsJob.md) - -[Start-AzureRmStreamAnalyticsJob](./Start-AzureRmStreamAnalyticsJob.md) - -[Stop-AzureRmStreamAnalyticsJob](./Stop-AzureRmStreamAnalyticsJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.StreamAnalytics/Remove-AzureRmStreamAnalyticsOutput.md b/azurermps-6.13.0/AzureRM.StreamAnalytics/Remove-AzureRmStreamAnalyticsOutput.md deleted file mode 100644 index db4dc27cd9..0000000000 --- a/azurermps-6.13.0/AzureRM.StreamAnalytics/Remove-AzureRmStreamAnalyticsOutput.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.StreamAnalytics.dll-Help.xml -Module Name: AzureRM.StreamAnalytics -ms.assetid: EE41BE86-37D4-4A2B-9007-D019CD62BA9D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.streamanalytics/remove-azurermstreamanalyticsoutput -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/Remove-AzureRmStreamAnalyticsOutput.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/Remove-AzureRmStreamAnalyticsOutput.md ---- - -# Remove-AzureRmStreamAnalyticsOutput - -## SYNOPSIS -Deletes an output from a Stream Analytics job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmStreamAnalyticsOutput [-JobName] <String> [-Name] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmStreamAnalyticsOutput** cmdlet asynchronously deletes an output from a Stream Analytics job in Azure. - -## EXAMPLES - -### EXAMPLE 1: Remove an output from a job -``` -PS C:\>Remove-AzureRmStreamAnalyticsOutput -ResourceGroupName "StreamAnalytics-Default-West-US" -JobName "StreamingJob" -Name "Output" -``` - -This command removes the output Output in the job StreamingJob. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobName -Specifies the name of the Azure Stream Analytics job to which the Azure Stream Analytics output belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Azure Stream Analytics output to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the Azure Stream Analytics output belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmStreamAnalyticsOutput](./Get-AzureRmStreamAnalyticsOutput.md) - -[New-AzureRmStreamAnalyticsOutput](./New-AzureRmStreamAnalyticsOutput.md) - -[Test-AzureRmStreamAnalyticsOutput](./Test-AzureRmStreamAnalyticsOutput.md) - - diff --git a/azurermps-6.13.0/AzureRM.StreamAnalytics/Start-AzureRmStreamAnalyticsJob.md b/azurermps-6.13.0/AzureRM.StreamAnalytics/Start-AzureRmStreamAnalyticsJob.md deleted file mode 100644 index 793efd7d41..0000000000 --- a/azurermps-6.13.0/AzureRM.StreamAnalytics/Start-AzureRmStreamAnalyticsJob.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.StreamAnalytics.dll-Help.xml -Module Name: AzureRM.StreamAnalytics -ms.assetid: B5914F65-CAF8-4647-BA78-49B65DD6D67A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.streamanalytics/start-azurermstreamanalyticsjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/Start-AzureRmStreamAnalyticsJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/Start-AzureRmStreamAnalyticsJob.md ---- - -# Start-AzureRmStreamAnalyticsJob - -## SYNOPSIS -Starts a Stream Analytics job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Start-AzureRmStreamAnalyticsJob [-Name] <String> [[-OutputStartMode] <String>] [[-OutputStartTime] <DateTime>] - [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Start-AzureRmStreamAnalyticsJob** cmdlet asynchronously deploys and starts a Stream Analytics job in Azure. - -## EXAMPLES - -### EXAMPLE 1: Start a Stream Analytics job -``` -PS C:\>Start-AzureRmStreamAnalyticsJob -ResourceGroupName "StreamAnalytics-Default-West-US" -Name "StreamingJob" -OutputStartMode "CustomTime" -OutputStartTime "2014-07-03T01:00Z" -``` - -This command starts the job StreamingJob and specifies that the output event stream should start at timestamp 2014-07-03T01:00Z. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Azure Stream Analytics job to start. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OutputStartMode -Specifies the start mode for the job. -Valid values are: -- JobStartTime - This value indicates that the starting point of the output event stream should start when the job is started. -- CustomTime - This value indicates that the starting point of the output event stream should start at a custom time that is specified in the *OutputStartTime* parameter. - -- LastOutputEventTime - This value indicates that the starting point of the output event stream should start from the last event output time. -If the property is absent, the default is JobStartTime. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OutputStartTime -Specifies the output start time. -This value is either an ISO-8601 formatted time stamp that indicates the starting point of the output event stream, or $Null to indicate that the output event stream will start whenever the streaming job is started. -This property must have a value if *OutputStartMode* is set to CustomTime. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the Azure Stream Analytics job belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.DateTime, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmStreamAnalyticsJob](./Get-AzureRmStreamAnalyticsJob.md) - -[New-AzureRmStreamAnalyticsJob](./New-AzureRmStreamAnalyticsJob.md) - -[Remove-AzureRmStreamAnalyticsJob](./Remove-AzureRmStreamAnalyticsJob.md) - -[Stop-AzureRmStreamAnalyticsJob](./Stop-AzureRmStreamAnalyticsJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.StreamAnalytics/Stop-AzureRmStreamAnalyticsJob.md b/azurermps-6.13.0/AzureRM.StreamAnalytics/Stop-AzureRmStreamAnalyticsJob.md deleted file mode 100644 index 5e4017fb4d..0000000000 --- a/azurermps-6.13.0/AzureRM.StreamAnalytics/Stop-AzureRmStreamAnalyticsJob.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.StreamAnalytics.dll-Help.xml -Module Name: AzureRM.StreamAnalytics -ms.assetid: 1EC96B4E-7731-4EE3-A0C1-EA0793F0FE5C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.streamanalytics/stop-azurermstreamanalyticsjob -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/Stop-AzureRmStreamAnalyticsJob.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/Stop-AzureRmStreamAnalyticsJob.md ---- - -# Stop-AzureRmStreamAnalyticsJob - -## SYNOPSIS -Stops a Stream Analytics job. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Stop-AzureRmStreamAnalyticsJob [-Name] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Stop-AzureRmStreamAnalyticsJob** cmdlet asynchronously stops a Stream Analytics job from running in Azure and deallocates resources that were that were being used. -The job definition and metadata remain available within your subscription through both the Azure Portal and Management APIs, such that the job can be edited and restarted. -You will not be charged for a job in the Stopped state. - -## EXAMPLES - -### EXAMPLE 1: Stop a running job -``` -PS C:\>Stop-AzureRmStreamAnalyticsJob -ResourceGroupName "StreamAnalytics-Default-West-US" -Name "StreamingJob" -``` - -This command stops the job StreamingJob. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Azure Stream Analytics job to stop. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the Azure Stream Analytics job belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmStreamAnalyticsJob](./Get-AzureRmStreamAnalyticsJob.md) - -[Get-AzureRmStreamAnalyticsJob](./Get-AzureRmStreamAnalyticsJob.md) - -[New-AzureRmStreamAnalyticsJob](./New-AzureRmStreamAnalyticsJob.md) - -[Remove-AzureRmStreamAnalyticsJob](./Remove-AzureRmStreamAnalyticsJob.md) - -[Start-AzureRmStreamAnalyticsJob](./Start-AzureRmStreamAnalyticsJob.md) - - diff --git a/azurermps-6.13.0/AzureRM.StreamAnalytics/Test-AzureRmStreamAnalyticsFunction.md b/azurermps-6.13.0/AzureRM.StreamAnalytics/Test-AzureRmStreamAnalyticsFunction.md deleted file mode 100644 index 1ecc93f838..0000000000 --- a/azurermps-6.13.0/AzureRM.StreamAnalytics/Test-AzureRmStreamAnalyticsFunction.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.StreamAnalytics.dll-Help.xml -Module Name: AzureRM.StreamAnalytics -ms.assetid: E711FBFF-FB6D-4DFD-BAE8-7961EB4FD16B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.streamanalytics/test-azurermstreamanalyticsfunction -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/Test-AzureRmStreamAnalyticsFunction.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/Test-AzureRmStreamAnalyticsFunction.md ---- - -# Test-AzureRmStreamAnalyticsFunction - -## SYNOPSIS -Tests whether Stream Analytics can connect to a function. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Test-AzureRmStreamAnalyticsFunction [-JobName] <String> [-Name] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Test-AzureRmStreamAnalyticsFunction** cmdlet tests whether Azure Stream Analytics can connect to a function. - -## EXAMPLES - -### Example 1: Test a Stream Analytics function -``` -PS C:\>Test-AzureRmStreamAnalyticsFunction -ResourceGroupName "StreamAnalytics-Default-West-US" -JobName "StreamJob22" -Name "ScoreTweet" -``` - -This command tests the connection status of the function named ScoreTweet in the job named StreamJob22. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobName -Specifies the name of the Stream Analytics job to which a function belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Stream Analytics function that this cmdlet tests. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which a Stream Analytics function belongs. -This cmdlet tests a function in the resource group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmStreamAnalyticsFunction](./Get-AzureRmStreamAnalyticsFunction.md) - -[New-AzureRmStreamAnalyticsFunction](./New-AzureRmStreamAnalyticsFunction.md) - -[Remove-AzureRmStreamAnalyticsFunction](./Remove-AzureRmStreamAnalyticsFunction.md) - - diff --git a/azurermps-6.13.0/AzureRM.StreamAnalytics/Test-AzureRmStreamAnalyticsInput.md b/azurermps-6.13.0/AzureRM.StreamAnalytics/Test-AzureRmStreamAnalyticsInput.md deleted file mode 100644 index a1711853f4..0000000000 --- a/azurermps-6.13.0/AzureRM.StreamAnalytics/Test-AzureRmStreamAnalyticsInput.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.StreamAnalytics.dll-Help.xml -Module Name: AzureRM.StreamAnalytics -ms.assetid: DEAC40AB-D90B-41D8-86AB-A66B60A908BD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.streamanalytics/test-azurermstreamanalyticsinput -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/Test-AzureRmStreamAnalyticsInput.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/Test-AzureRmStreamAnalyticsInput.md ---- - -# Test-AzureRmStreamAnalyticsInput - -## SYNOPSIS -Tests the connection status of an input. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Test-AzureRmStreamAnalyticsInput [-JobName] <String> [-Name] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Test-AzureRmStreamAnalyticsInput** cmdlet tests the ability of Stream Analytics to connect to an input. - -## EXAMPLES - -### EXAMPLE 1: Test the connection status of an input stream -``` -PS C:\>Test-AzureRmStreamAnalyticsInput -ResourceGroupName "StreamAnalytics-Default-West-US" -JobName "StreamingJob" -Name "EntryStream" -``` - -This tests the connection status of the input EntryStream in StreamingJob. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobName -Specifies the name of the Azure Stream Analytics job to which the Azure Stream Analytics input belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Azure Stream Analytics input to test. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the Azure Stream Analytics input belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmStreamAnalyticsInput](./Get-AzureRmStreamAnalyticsInput.md) - -[New-AzureRmStreamAnalyticsInput](./New-AzureRmStreamAnalyticsInput.md) - -[Remove-AzureRmStreamAnalyticsInput](./Remove-AzureRmStreamAnalyticsInput.md) - - diff --git a/azurermps-6.13.0/AzureRM.StreamAnalytics/Test-AzureRmStreamAnalyticsOutput.md b/azurermps-6.13.0/AzureRM.StreamAnalytics/Test-AzureRmStreamAnalyticsOutput.md deleted file mode 100644 index b15ceb1fad..0000000000 --- a/azurermps-6.13.0/AzureRM.StreamAnalytics/Test-AzureRmStreamAnalyticsOutput.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.StreamAnalytics.dll-Help.xml -Module Name: AzureRM.StreamAnalytics -ms.assetid: F57C53E2-2873-441F-90E6-E6100418D519 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.streamanalytics/test-azurermstreamanalyticsoutput -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/Test-AzureRmStreamAnalyticsOutput.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/StreamAnalytics/Commands.StreamAnalytics/help/Test-AzureRmStreamAnalyticsOutput.md ---- - -# Test-AzureRmStreamAnalyticsOutput - -## SYNOPSIS -Tests the connection status of an output. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Test-AzureRmStreamAnalyticsOutput [-JobName] <String> [-Name] <String> [-ResourceGroupName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Test-AzureRmStreamAnalyticsOutput** cmdlet tests the ability of Stream Analytics to connect to an output. - -## EXAMPLES - -### EXAMPLE 1: Test the connection status of an output -``` -PS C:\>Test-AzureRmStreamAnalyticsOutput -ResourceGroupName "StreamAnalytics-Default-West-US" -JobName "StreamingJob" -Name "Output" -``` - -This tests the connection status of the output Output in StreamingJob. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobName -Specifies the name of the Azure Stream Analytics job to which the desired Azure Stream Analytics output belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Azure Stream Analytics output to test. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to which the Azure Stream Analytics output belongs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmStreamAnalyticsOutput](./Get-AzureRmStreamAnalyticsOutput.md) - -[New-AzureRmStreamAnalyticsOutput](./New-AzureRmStreamAnalyticsOutput.md) - -[Remove-AzureRmStreamAnalyticsOutput](./Remove-AzureRmStreamAnalyticsOutput.md) - - diff --git a/azurermps-6.13.0/AzureRM.Subscription/AzureRM.Subscription.md b/azurermps-6.13.0/AzureRM.Subscription/AzureRM.Subscription.md deleted file mode 100644 index f6ef13dfde..0000000000 --- a/azurermps-6.13.0/AzureRM.Subscription/AzureRM.Subscription.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -Module Name: AzureRM.Subscription -Module Guid: 8074e741-0979-4b4e-8f9b-7243f213d98a -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.subscription -Help Version: 1.0.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Subscription/Commands.Subscription/help/AzureRM.Subscription.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Subscription/Commands.Subscription/help/AzureRM.Subscription.md ---- - -# AzureRM.Subscription Module -## Description -The topics in this section document the Azure PowerShell cmdlets for Azure Subscription in the Azure Resource Manager (ARM) framework. The cmdlets exist in the Microsoft.Azure.Commands.Subscription namespace. - -## AzureRM.Subscription Cmdlets -### [New-AzureRmSubscription](New-AzureRmSubscription.md) -Creates an Azure subscription. - diff --git a/azurermps-6.13.0/AzureRM.Subscription/New-AzureRmSubscription.md b/azurermps-6.13.0/AzureRM.Subscription/New-AzureRmSubscription.md deleted file mode 100644 index 1f865f31b0..0000000000 --- a/azurermps-6.13.0/AzureRM.Subscription/New-AzureRmSubscription.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Subscription.dll-Help.xml -Module Name: AzureRM.Subscription -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.subscription/new-azurermsubscription -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Subscription/Commands.Subscription/help/New-AzureRmSubscription.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Subscription/Commands.Subscription/help/New-AzureRmSubscription.md ---- - -# New-AzureRmSubscription - -## SYNOPSIS -Creates an Azure subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmSubscription -EnrollmentAccountObjectId <String> [[-Name] <String>] -OfferType <String> - [-OwnerObjectId <String[]>] [-OwnerSignInName <String[]>] [-OwnerApplicationId <String[]>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmSubscription** cmdlet creates an Azure subscription. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmSubscription -Name "My Subscription" -EnrollmentAccountObjectId ((Get-AzureRmEnrollmentAccount)[0].ObjectId) -OfferType MS-AZR-0017P - -Name : My Subscription -Id : 86869d42-1782-4337-98b0-c905fb937d46 -TenantId : 00001111-aaaa-2222-bbbb-3333cccc4444 -State : Enabled -``` - -Creates an Azure subscription under the specified enrollment account with the specified offer type. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnrollmentAccountObjectId -Name of the enrollment account to use when creating the subscription. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the subscription to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OfferType -The type of offer to use when creating the subscription. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OwnerApplicationId -The app SPN(s) to be granted Owner access to the subscription. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: OwnerSPN, OwnerServicePrincipalName - -Required: False -Position: Named -Default value: Name -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OwnerObjectId -The user(s) or group object(s) id(s) to be granted Owner access to the subscription. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: OwnerId, OwnerPrincipalId - -Required: False -Position: Named -Default value: Name -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OwnerSignInName -The user(s) to be granted Owner access to the subscription. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: OwnerEmail, OwnerUserPrincipalName - -Required: False -Position: Named -Default value: Name -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Subscription.Models.PSAzureSubscription - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Tags/AzureRM.Tags.md b/azurermps-6.13.0/AzureRM.Tags/AzureRM.Tags.md deleted file mode 100644 index f93b50a6d9..0000000000 --- a/azurermps-6.13.0/AzureRM.Tags/AzureRM.Tags.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -Module Name: AzureRM.Tags -Module Guid: 59713673-194f-418a-b1f2-ac60db82edf9 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.tags -Help Version: 4.0.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Tags/Commands.Tags/help/AzureRM.Tags.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Tags/Commands.Tags/help/AzureRM.Tags.md ---- - -# AzureRM.Tags Module -## Description -This topic displays help topics for the Azure Tag Cmdlets. - -## AzureRM.Tags Cmdlets -### [Get-AzureRmTag](Get-AzureRmTag.md) -Gets predefined Azure tags. - -### [New-AzureRmTag](New-AzureRmTag.md) -Creates a predefined Azure tag or adds values to an existing tag. - -### [Remove-AzureRmTag](Remove-AzureRmTag.md) -Deletes predefined Azure tags or values. - diff --git a/azurermps-6.13.0/AzureRM.Tags/Get-AzureRmTag.md b/azurermps-6.13.0/AzureRM.Tags/Get-AzureRmTag.md deleted file mode 100644 index d329d76e32..0000000000 --- a/azurermps-6.13.0/AzureRM.Tags/Get-AzureRmTag.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Tags.dll-Help.xml -Module Name: AzureRM.Tags -ms.assetid: 726E01DD-D73C-4D4B-8FC0-52767927367C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.tags/get-azurermtag -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Tags/Commands.Tags/help/Get-AzureRmTag.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Tags/Commands.Tags/help/Get-AzureRmTag.md ---- - -# Get-AzureRmTag - -## SYNOPSIS -Gets predefined Azure tags. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmTag [[-Name] <String>] [-Detailed] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmTag** cmdlet gets predefined Azure tags in your subscription. -This cmdlet returns basic information about the tags or detailed information about tags and their values. -All output objects include a Count property that represents the number of resources and resource groups to which the tags and values have been applied. -The Azure Tags module that **Get-AzureRMTag** is a part of can help you manage predefined Azure tags. -An Azure tag is a name-value pair that you can use to categorize your Azure resources and resource groups, such as by department or cost center, or to track notes or comments about the resources and groups. -You can define and apply tags in a single step, but predefined tags let you establish standard, consistent, predictable names and values for the tags in your subscription. -To create a predefined tag, use the New-AzureRmTag cmdlet. -To apply a predefined tag to a resource group, use the *Tag* parameter of the New-AzureRmTag cmdlet. -To search resource groups for a specific tag name or name and value, use the *Tag* parameter of the Get-AzureRMResourceGroup cmdlet. - -## EXAMPLES - -### Example 1: Get all predefined tags -``` -PS C:\>Get-AzureRmTag - -Name Count -======== ===== - -Department 5 -FY2015 2 -CostCenter 20 -``` - -This command gets all predefined tags in the subscription. -The Count property shows how many times the tag has been applied to resources and resource groups in the subscription. - -### Example 2: Get a tag by name -``` -PS C:\>Get-AzureRmTag -Name "Department" - -Name: Department -Count: 5 -Values: - - Name Count - ========== ===== - - Finance 2 - IT 3 -``` - -This command gets detailed information about the Department tag and its values. -The Count property shows how many times the tag and each of its values has been applied to resources and resource groups in the subscription. - -### Example 3: Get values of all tags -``` -PS C:\>Get-AzureRmTag -Detailed - -Name: Department -Count: 5 -Values: - - Name Count - ========== ===== - - Finance 2 - IT 3 - - -Name: FY2015 -Count: 2 - - -Name: CostCenter -Count: 20 -Values: - - Name Count - ========== ===== - - 0001 5 - 0002 10 - 0003 5 -``` - -This command uses the *Detailed* parameter to get detailed information about all predefined tags in the subscription. -Using the *Detailed* parameter is the equivalent of using the *Name* parameter for every tag. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Detailed -Indicates that this operation adds information about tag values to the output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the tag to get. -By default, **Get-AzureRmTag** gets basic information about all predefined tags in the subscription. -When you specify the *Name* parameter, the *Detailed* parameter has no effect. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.ResourceManager.Common.Tags.PSTag - -## NOTES - -## RELATED LINKS - -[New-AzureRmTag](./New-AzureRmTag.md) - -[Remove-AzureRmTag](./Remove-AzureRmTag.md) - - diff --git a/azurermps-6.13.0/AzureRM.Tags/New-AzureRmTag.md b/azurermps-6.13.0/AzureRM.Tags/New-AzureRmTag.md deleted file mode 100644 index f5be906a19..0000000000 --- a/azurermps-6.13.0/AzureRM.Tags/New-AzureRmTag.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Tags.dll-Help.xml -Module Name: AzureRM.Tags -ms.assetid: 23DB0AD2-7EB7-4373-BB8D-BB6CB651DD54 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.tags/new-azurermtag -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Tags/Commands.Tags/help/New-AzureRmTag.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Tags/Commands.Tags/help/New-AzureRmTag.md ---- - -# New-AzureRmTag - -## SYNOPSIS -Creates a predefined Azure tag or adds values to an existing tag. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmTag [-Name] <String> [[-Value] <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmTag** cmdlet creates a predefined Azure tag with an optional predefined value. -You can also use it to add additional values to existing predefined tags. -To create a predefined tag, enter a unique tag name. -To add a value to an existing predefined tag, specify the name of the existing tag and the new value. -This cmdlet returns an object that represents the new or modified tag with its values and the number of resources to which it has been applied. -The Azure Tags module that **New-AzureRmTag** is part of can help you manage predefined Azure tags. -An Azure tag is a name-value pair that you can use to categorize your Azure resources and resource groups, such as by department or cost center, or to track notes or comments about the resources and groups. -You can define and apply tags in a single step, but predefined tags let you establish standard, consistent, predictable names and values for the tags in your subscription. -To apply a predefined tag to a resource or resource group, use the *Tag* parameter of the New-AzureRmTag cmdlet. -To search for resource groups with a specified tag name or name and value, use the *Tag* parameter of the Get-AzureRMResourceGroup cmdlet. -Every tag has a name. -The values are optional. -A predefined Azure tag can have multiple values, but when you apply the tag to a resource or resource group, you apply the tag name and only one of its values. -For example, you can create a predefined Department tag with a value for each department, such as Finance, Human Resources, and IT. -When you apply the Department tag to a resource, you apply only one predefined value, such as Finance. - -## EXAMPLES - -### Example 1: Create a predefined tag -``` -PS C:\>New-AzureRmTag -Name "FY2015" -Name: FY2015 -Count: 0 -Values: - - Name Count - ========= ===== - - Finance 0 -``` - -This command creates a predefined tag named FY2015. -This tag has no values. -You can apply a tag with no values to a resource or resource group, or use **New-AzureRmTag** to add values to the tag. -You can also specify a value when you apply the tag to the resource or resource group. - -### Example 2: Create a predefined tag with a value -``` -PS C:\>New-AzureRmTag -Name "Department" -Value "Finance" -Name: Department -Count: 0 -Values: - - Name Count - ========= ===== - Finance 0 -``` - -This command creates a predefined tag named Department with a value of Finance. - -### Example 3: Add a value to a predefined tag -``` -PS C:\>New-AzureRmTag -Name "Department" -Value "Finance" -Name: Department -Count: 0 -Values: - Name Count - ========= ===== - Finance 0 -PS C:\>New-AzureRmTag -Name "Department" -Value "IT" -Name: Department -Count: 0 -Values: - Name Count - ========= ===== - Finance 0 - IT 0 -``` - -These commands create a predefined tag named Department with two values. -If the tag name exists, **New-AzureRmTag** adds the value to the existing tag instead of creating a new one. - -### Example 4: Use a predefined tag -``` -PS C:\>New-AzureRmTag -Name "CostCenter" -Value "0001" -Name: CostCenter -Count: 0 -Values: - Name Count - ========= ===== - 0001 0 -PS C:\>Set-AzureRmResourceGroup -Name "EngineerBlog" -Tag @{Name="CostCenter";Value="0001"} -Name: EngineerBlog -Location: East US -Resources: - - Name Type Location - =============== ======================= ======== - EngineerBlog Microsoft.Web/sites West US - EngSvr01 Microsoft.Sql/servers West US - EngDB02 Microsoft.Sql/databases West US -Tags: - Name Value - ========== ===== - CostCenter 0001 -PS C:\>Get-AzureRmTag -Name "CostCenter" -Name: CostCenter -Count: 1 -Values: - Name Count - ========= ===== - 0001 1 -PS C:\>Get-AzureRmResourceGroup -Tag @{Name="CostCenter"} -Name: EngineerBlog -Location: East US -Resources: - Name Type Location - =============== ======================= ======== - EngineerBlog Microsoft.Web/sites West US - - EngSvr01 Microsoft.Sql/servers West US - EngDB02 Microsoft.Sql/databases West US -Tags: - Name Value - ========== ===== - CostCenter 0001 -``` - -The commands in this example create and use a predefined tag. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the tag name. -To create a new predefined tag, enter a unique name. -To add a value to an existing tag, enter the name of the existing tag. -If an existing predefined tag has the specified name, **New-AzureRmTag** adds the specified value, if any, to the tag with that name instead of creating a new tag. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Value -Specifies a tag value. -Predefined tags can have multiple values, but you can enter only one value in each command. -This parameter is optional, because tags can have names without values. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ResourceManager.Common.Tags.PSTag - -## NOTES - -## RELATED LINKS - -[Get-AzureRmTag](./Get-AzureRmTag.md) - -[Remove-AzureRmTag](./Remove-AzureRmTag.md) - - diff --git a/azurermps-6.13.0/AzureRM.Tags/Remove-AzureRmTag.md b/azurermps-6.13.0/AzureRM.Tags/Remove-AzureRmTag.md deleted file mode 100644 index 888f138019..0000000000 --- a/azurermps-6.13.0/AzureRM.Tags/Remove-AzureRmTag.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Tags.dll-Help.xml -Module Name: AzureRM.Tags -ms.assetid: 66B25541-0FA5-46CF-90D8-FE9527BE11C6 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.tags/remove-azurermtag -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Tags/Commands.Tags/help/Remove-AzureRmTag.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Tags/Commands.Tags/help/Remove-AzureRmTag.md ---- - -# Remove-AzureRmTag - -## SYNOPSIS -Deletes predefined Azure tags or values. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmTag [-Name] <String> [[-Value] <String[]>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmTag** cmdlet deletes predefined Azure tags and values from your subscription. -To delete particular values from a predefined tag, use the *Value* parameter. -By default, **Remove-AzureRmTag** deletes the specified tag and all of its values.You cannot delete a tag or value that is currently applied to a resource or resource group. -Before using **Remove-AzureRmTag**, use the *Tag* parameter of the Set-AzureRMResourceGroup cmdlet to delete the tag or values from the resource or resource group. -The Azure Tags module that **Remove-AzureRmTag** is part of can help you manage your predefined Azure tags. -An Azure tag is a name-value pair that you can use to categorize your Azure resources and resource groups, such as by department or cost center, or to track notes or comments about the resources and groups. -You can define and apply tags in a single step, but predefined tags let you establish standard, consistent, predictable names and values for the tags in your subscription. - -## EXAMPLES - -### Example 1: Delete a predefined tag -``` -PS C:\>Remove-AzureRmTag -Name "Department" -``` - -This command deletes the predefined tag named Department and all of its resources. -If the tag has been applied to any resources or resource groups, the command fails. - -### Example 2: Delete a value from a predefined tag -``` -PS C:\>Remove-AzureRmTag -Name "Department" -Value "HumanResources" -PassThru -Name: Department -Count: 14 -Values: - - Name Count - ========= ===== - - Finance 2 - IT 12 -``` - -This command deletes the HumanResources value from the predefined Department tag. -It does not delete the tag. -If the value has been applied to any resources or resource groups, the command fails. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the tag to be deleted. -By default, **Remove-AzureRmTag** removes the specified tag and all of its values. -To delete selected values, but not delete the tag, use the *Value* parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object that represents the deleted tag or the resulting tag with deleted valued. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Value -Deletes the specified values from the predefined tag, but does not delete the tag. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.String[] - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.ResourceManager.Common.Tags.PSTag - -## NOTES - -## RELATED LINKS - -[Get-AzureRmTag](./Get-AzureRmTag.md) - -[New-AzureRmTag](./New-AzureRmTag.md) - - diff --git a/azurermps-6.13.0/AzureRM.TrafficManager/Add-AzureRmTrafficManagerCustomHeaderToEndpoint.md b/azurermps-6.13.0/AzureRM.TrafficManager/Add-AzureRmTrafficManagerCustomHeaderToEndpoint.md deleted file mode 100644 index eef5391589..0000000000 --- a/azurermps-6.13.0/AzureRM.TrafficManager/Add-AzureRmTrafficManagerCustomHeaderToEndpoint.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.TrafficManager.dll-Help.xml -Module Name: AzureRM.TrafficManager -ms.assetid: 25E3F297-1D91-4102-B4D3-1E7195A5D33E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/add-azurertmtrafficmanagercustomheadertoendpoint -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Add-AzureRmTrafficManagerCustomHeaderToEndpoint.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Add-AzureRmTrafficManagerCustomHeaderToEndpoint.md ---- - -# Add-AzureRmTrafficManagerCustomHeaderToEndpoint - -## SYNOPSIS -Adds custom header information to a local Traffic Manager endpoint object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmTrafficManagerCustomHeaderToEndpoint -Name <String> -Value <String> - -TrafficManagerEndpoint <TrafficManagerEndpoint> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmTrafficManagerCustomHeaderToEndpoint** cmdlet adds custom header information to a local Azure Traffic Manager endpoint object. -You can get an endpoint by using the New-AzureRmTrafficManagerEndpoint or Get-AzureRmTrafficManagerEndpoint cmdlets. - -This cmdlet operates on the local endpoint object. -Commit your changes to the endpoint for Traffic Manager by using the Set-AzureRmTrafficManagerEndpoint cmdlet. - -## EXAMPLES - -### Example 1: Add custom header information to an endpoint -``` -PS C:\> $TrafficManagerEndpoint = New-AzureRmTrafficManagerEndpoint -EndpointStatus Enabled -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" -Type AzureEndpoints -Priority 1 -TargetResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-CentralUS/providers/Microsoft.Web/sites/contoso-web-app" -Weight 10 -PS C:\> Add-AzureRmTrafficManagerCustomHeaderToEndpoint -TrafficManagerEndpoint $TrafficManagerEndpoint -Name "host" -Value "www.contoso.com" -PS C:\> Set-AzureRmTrafficManagerEndpoint -TrafficManagerEndpoint $TrafficManagerEndpoint -``` - -The first command creates an Azure Traffic Manager endpoint by using the **New-AzureRmTrafficManagerEndpoint** cmdlet. -The command stores the local endpoint in the $TrafficManagerEndpoint variable. -The second command adds custom header information to the endpoint stored in $TrafficManagerEndpoint. -The final command updates the endpoint in Traffic Manager to match the local value in $TrafficManagerEndpoint. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the custom header information to be added. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrafficManagerEndpoint -Specifies a local **TrafficManagerEndpoint** object. -This cmdlet modifies this local object. -To obtain a **TrafficManagerEndpoint** object, use the Get-AzureRmTrafficManagerEndpoint or New-AzureRmTrafficManagerEndpoint cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Value -Specifies the value of the custom header information to be added. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.TrafficManagerEndpoint -This cmdlet accepts a **TrafficManagerEndpoint** object to this cmdlet. - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.TrafficManagerEndpoint -This cmdlet returns a modified **TrafficManagerEndpoint** object. - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmTrafficManagerCustomHeaderFromEndpoint](./Remove-AzureRmTrafficManagerCustomHeaderFromEndpoint.md) - -[New-AzureRmTrafficManagerEndpoint](./New-AzureRmTrafficManagerEndpoint.md) - -[Get-AzureRmTrafficManagerProfile](./Get-AzureRmTrafficManagerEndpoint.md) - -[Set-AzureRmTrafficManagerEndpoint](./Set-AzureRmTrafficManagerEndpoint.md) diff --git a/azurermps-6.13.0/AzureRM.TrafficManager/Add-AzureRmTrafficManagerCustomHeaderToProfile.md b/azurermps-6.13.0/AzureRM.TrafficManager/Add-AzureRmTrafficManagerCustomHeaderToProfile.md deleted file mode 100644 index 8492483c35..0000000000 --- a/azurermps-6.13.0/AzureRM.TrafficManager/Add-AzureRmTrafficManagerCustomHeaderToProfile.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.TrafficManager.dll-Help.xml -Module Name: AzureRM.TrafficManager -ms.assetid: 25E3F297-1D91-4102-B4D3-1E7195A5D33F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/add-azurertmtrafficmanagercustomheadertoprofile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Add-AzureRmTrafficManagerCustomHeaderToProfile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Add-AzureRmTrafficManagerCustomHeaderToProfile.md ---- - -# Add-AzureRmTrafficManagerCustomHeaderToProfile - -## SYNOPSIS -Adds custom header information to a local Traffic Manager profile object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmTrafficManagerCustomHeaderToProfile -Name <String> -Value <String> - -TrafficManagerProfile <TrafficManagerProfile> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmTrafficManagerCustomHeaderToProfile** cmdlet adds custom header information to a local Azure Traffic Manager profile object. -You can get a profile by using the New-AzureRmTrafficManagerProfile or Get-AzureRmTrafficManagerProfile cmdlets. - -This cmdlet operates on the local profile object. -Commit your changes to the profile for Traffic Manager by using the Set-AzureRmTrafficManagerProfile cmdlet. - -## EXAMPLES - -### Example 1: Add custom header information to a profile -``` -PS C:\> $TrafficManagerProfile = Get-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" -PS C:\> Add-AzureRmTrafficManagerCustomHeaderToProfile -TrafficManagerProfile $TrafficManagerProfile -Name "host" -Value "www.contoso.com" -PS C:\> Set-AzureRmTrafficManagerProfile -TrafficManagerProfile $TrafficManagerProfile -``` - -The first command gets an Azure Traffic Manager profile by using the **Get-AzureRmTrafficManagerProfile** cmdlet. -The command stores the local profile in the $TrafficManagerProfile variable. -The second command adds custom header information to the profile stored in $TrafficManagerProfile. -The final command updates the profile in Traffic Manager to match the local value in $TrafficManagerProfile. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the custom header information to be added. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrafficManagerProfile -Specifies a local **TrafficManagerProfile** object. -This cmdlet modifies this local object. -To obtain a **TrafficManagerProfile** object, use the Get-AzureRmTrafficManagerProfile cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Value -Specifies the value of the custom header information to be added. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.TrafficManagerProfile -This cmdlet accepts a **TrafficManagerProfile** object to this cmdlet. - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.TrafficManagerProfile -This cmdlet returns a modified **TrafficManagerProfile** object. - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmTrafficManagerCustomHeaderFromProfile](./Remove-AzureRmTrafficManagerCustomHeaderFromProfile.md) - -[Get-AzureRmTrafficManagerProfile](./Get-AzureRmTrafficManagerProfile.md) - -[Set-AzureRmTrafficManagerProfile](./Set-AzureRmTrafficManagerProfile.md) diff --git a/azurermps-6.13.0/AzureRM.TrafficManager/Add-AzureRmTrafficManagerEndpointConfig.md b/azurermps-6.13.0/AzureRM.TrafficManager/Add-AzureRmTrafficManagerEndpointConfig.md deleted file mode 100644 index a3eb20142f..0000000000 --- a/azurermps-6.13.0/AzureRM.TrafficManager/Add-AzureRmTrafficManagerEndpointConfig.md +++ /dev/null @@ -1,328 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.TrafficManager.dll-Help.xml -Module Name: AzureRM.TrafficManager -ms.assetid: 25E3F297-1D91-4102-B4D3-1E7195A5D33D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/add-azurermtrafficmanagerendpointconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Add-AzureRmTrafficManagerEndpointConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Add-AzureRmTrafficManagerEndpointConfig.md ---- - -# Add-AzureRmTrafficManagerEndpointConfig - -## SYNOPSIS -Adds an endpoint to a local Traffic Manager profile object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmTrafficManagerEndpointConfig -EndpointName <String> -TrafficManagerProfile <TrafficManagerProfile> - -Type <String> [-TargetResourceId <String>] [-Target <String>] -EndpointStatus <String> [-Weight <UInt32>] - [-Priority <UInt32>] [-EndpointLocation <String>] [-MinChildEndpoints <UInt32>] - [-GeoMapping <System.Collections.Generic.List`1[System.String]>] - [-SubnetMapping <System.Collections.Generic.List`1[Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerIpAddressRange]>] - [-CustomHeader <System.Collections.Generic.List`1[Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerCustomHeader]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmTrafficManagerEndpointConfig** cmdlet adds an endpoint to a local Azure Traffic Manager profile object. -You can get a profile by using the New-AzureRmTrafficManagerProfile or Get-AzureRmTrafficManagerProfile cmdlets. - -This cmdlet operates on the local profile object. -Commit your changes to the profile for Traffic Manager by using the Set-AzureRmTrafficManagerProfile cmdlet. -To create an endpoint and commit the change in a single operation, use the New-AzureRmTrafficManagerEndpoint cmdlet. - -## EXAMPLES - -### Example 1: Add an endpoint to a profile -``` -PS C:\>$TrafficManagerProfile = Get-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" -PS C:\> Add-AzureRmTrafficManagerEndpointConfig -EndpointName "contoso" -EndpointStatus Enabled -Target "www.contoso.com" -TrafficManagerProfile $TrafficManagerProfile -Type ExternalEndpoints -EndpointLocation "North Europe" -Priority 1 -Weight 10 -PS C:\> Set-AzureRmTrafficManagerProfile -TrafficManagerProfile $TrafficManagerProfile -``` - -The first command gets an Azure Traffic Manager profile by using the **Get-AzureRmTrafficManagerProfile** cmdlet. -The command stores the local profile in the $TrafficManagerProfile variable. - -The second command adds an endpoint named contoso to the profile stored in $TrafficManagerProfile. -The command includes configuration data for the endpoint. -This command changes only the local object. - -The final command updates the Traffic Manager profile in Azure to match the local value in $TrafficManagerProfile. - -## PARAMETERS - -### -CustomHeader -List of custom header name and value pairs for probe requests. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerCustomHeader] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndpointLocation -Specifies the location of the endpoint to use in the Performance traffic-routing method. -This parameter is only applicable to endpoints of the ExternalEndpoints or the NestedEndpoints type. -You must specify this parameter when the Performance traffic-routing method is used. - -Specify an Azure region name. -For a full list of Azure regions, see Azure Regionshttps://azure.microsoft.com/regions/ (https://azure.microsoft.com/regions/). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndpointName -Specifies the name of the Traffic Manager endpoint that this cmdlet adds. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndpointStatus -Specifies the status of the endpoint. -Valid values are: - -- Enabled -- Disabled - -If the status is Enabled, the endpoint is probed for endpoint health and is included in the traffic-routing method. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GeoMapping -The list of regions mapped to this endpoint when using the 'Geographic' traffic routing method. Please consult Traffic Manager documentation for a [full list of accepted values](https://docs.microsoft.com/en-us/azure/traffic-manager/traffic-manager-geographic-regions). - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinChildEndpoints -The minimum number of endpoints that must be available in the child profile in order for the Nested Endpoint in the parent profile to be considered available. -Only applicable to endpoint of type 'NestedEndpoints'. - -```yaml -Type: System.Nullable`1[System.UInt32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -Specifies the priority that Traffic Manager assigns to the endpoint. -This parameter is used only if the Traffic Manager profile is configured with the for Priority traffic-routing method. -Valid values are integers from 1 through 1000. -Lower values represent higher priority. - -If you specify a priority, you must specify priorities on all endpoints in the profile, and no two endpoints can share the same priority value. -If you do not specify priorities, Traffic Manager assigns default priority values to the endpoints, starting with one (1), in the order the profile lists the endpoints. - -```yaml -Type: System.Nullable`1[System.UInt32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetMapping -The list of address ranges or subnets mapped to this endpoint when using the ‘Subnet’ traffic routing method. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerIpAddressRange] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Target -Specifies the fully qualified DNS name of the endpoint. -Traffic Manager returns this value in DNS responses when it directs traffic to this endpoint. -Specify this parameter only for the ExternalEndpoints endpoint type. -For other endpoint types, specify the *TargetResourceId* parameter instead. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetResourceId -Specifies resource ID of the target. -Specify this parameter only for the AzureEndpoints and NestedEndpoints endpoint types. -For the ExternalEndpoints endpoint type, specify the *Target* parameter instead. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrafficManagerProfile -Specifies a local **TrafficManagerProfile** object. -This cmdlet modifies this local object. -To obtain a **TrafficManagerProfile** object, use the Get-AzureRmTrafficManagerProfile cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Type -Specifies the type of endpoint that this cmdlet adds to the Azure Traffic Manager profile. -Valid values are: - -- AzureEndpoints -- ExternalEndpoints -- NestedEndpoints - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: AzureEndpoints, ExternalEndpoints, NestedEndpoints - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Weight -Specifies the weight that Traffic Manager assigns to the endpoint. -Valid values are integers from 1 through 1000. -The default value is one (1). -This parameter is used only if the Traffic Manager profile is configured with the Weighted traffic-routing method. - -```yaml -Type: System.Nullable`1[System.UInt32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.TrafficManagerProfile -This cmdlet accepts a **TrafficManagerProfile** object to this cmdlet. - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.TrafficManagerProfile -This cmdlet returns a modified **TrafficManagerProfile** object. - -## NOTES - -## RELATED LINKS - -[Get-AzureRmTrafficManagerProfile](./Get-AzureRmTrafficManagerProfile.md) - -[New-AzureRmTrafficManagerEndpoint](./New-AzureRmTrafficManagerEndpoint.md) - -[Remove-AzureRmTrafficManagerEndpointConfig](./Remove-AzureRmTrafficManagerEndpointConfig.md) - -[Set-AzureRmTrafficManagerProfile](./Set-AzureRmTrafficManagerProfile.md) - - diff --git a/azurermps-6.13.0/AzureRM.TrafficManager/Add-AzureRmTrafficManagerExpectedStatusCodeRange.md b/azurermps-6.13.0/AzureRM.TrafficManager/Add-AzureRmTrafficManagerExpectedStatusCodeRange.md deleted file mode 100644 index ea0d76a6f0..0000000000 --- a/azurermps-6.13.0/AzureRM.TrafficManager/Add-AzureRmTrafficManagerExpectedStatusCodeRange.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.TrafficManager.dll-Help.xml -Module Name: AzureRM.TrafficManager -ms.assetid: 25E3F297-1D91-4102-B4D3-1E7195A5D340 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/add-azurertmtrafficmanagerexpectedstatuscoderange -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Add-AzureRmTrafficManagerExpectedStatusCodeRange.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Add-AzureRmTrafficManagerExpectedStatusCodeRange.md ---- - -# Add-AzureRmTrafficManagerExpectedStatusCodeRange - -## SYNOPSIS -Adds an expected status code range to a local Traffic Manager profile object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmTrafficManagerExpectedStatusCodeRange -Min <Int32> -Max <Int32> - -TrafficManagerProfile <TrafficManagerProfile> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmTrafficManagerExpectedStatusCodeRange** cmdlet adds a range of expected status codes to a local Azure Traffic Manager profile object. -You can get a profile by using the New-AzureRmTrafficManagerProfile or Get-AzureRmTrafficManagerProfile cmdlets. - -This cmdlet operates on the local profile object. -Commit your changes to the profile for Traffic Manager by using the Set-AzureRmTrafficManagerProfile cmdlet. - -## EXAMPLES - -### Example 1: Add an expected status code range to a profile -``` -PS C:\> $TrafficManagerProfile = Get-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" -PS C:\> Add-AzureRmTrafficManagerExpectedStatusCodeRange -TrafficManagerProfile $TrafficManagerProfile -Min 200 -Max 499 -PS C:\> Set-AzureRmTrafficManagerProfile -TrafficManagerProfile $TrafficManagerProfile -``` - -The first command gets an Azure Traffic Manager profile by using the **Get-AzureRmTrafficManagerProfile** cmdlet. -The command stores the local profile in the $TrafficManagerProfile variable. -The second command adds an expected status code range to the profile stored in $TrafficManagerProfile. -The final command updates the profile in Traffic Manager to match the local value in $TrafficManagerProfile. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Max -Specifies the highest value in the status code range to be added. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Min -Specifies the lowest value in the status code range to be added. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrafficManagerProfile -Specifies a local **TrafficManagerProfile** object. -This cmdlet modifies this local object. -To obtain a **TrafficManagerProfile** object, use the Get-AzureRmTrafficManagerProfile cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.TrafficManagerProfile -This cmdlet accepts a **TrafficManagerProfile** object to this cmdlet. - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.TrafficManagerProfile -This cmdlet returns a modified **TrafficManagerProfile** object. - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmTrafficManagerExpectedStatusCodeRange](./Remove-AzureRmTrafficManagerExpectedStatusCodeRange.md) - -[Get-AzureRmTrafficManagerProfile](./Get-AzureRmTrafficManagerProfile.md) - -[Set-AzureRmTrafficManagerProfile](./Set-AzureRmTrafficManagerProfile.md) diff --git a/azurermps-6.13.0/AzureRM.TrafficManager/Add-AzureRmTrafficManagerIpAddressRange.md b/azurermps-6.13.0/AzureRM.TrafficManager/Add-AzureRmTrafficManagerIpAddressRange.md deleted file mode 100644 index af9c915246..0000000000 --- a/azurermps-6.13.0/AzureRM.TrafficManager/Add-AzureRmTrafficManagerIpAddressRange.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.TrafficManager.dll-Help.xml -Module Name: AzureRM.TrafficManager -ms.assetid: 25E3F297-1D91-4102-B4D3-1E7195A5D341 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/add-azurermtrafficmanagerIpAddressRange -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Add-AzureRmTrafficManagerIpAddressRange.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Add-AzureRmTrafficManagerIpAddressRange.md ---- - -# Add-AzureRmTrafficManagerIpAddressRange - -## SYNOPSIS -Adds an address range or subnet to a local Traffic Manager endpoint object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmTrafficManagerIpAddressRange -First <String> [-Last <String>] [-Scope <Int32>] - -TrafficManagerEndpoint <TrafficManagerEndpoint> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmTrafficManagerIpAddressRange** cmdlet adds an IP address range to a local Azure Traffic Manager endpoint object. -You can get an endpoint by using the New-AzureRmTrafficManagerEndpoint or Get-AzureRmTrafficManagerEndpoint cmdlets. - -This cmdlet operates on the local endpoint object. -Commit your changes to the endpoint for Traffic Manager by using the Set-AzureRmTrafficManagerEndpoint cmdlet. - -## EXAMPLES - -### Example 1: Add IP address ranges to an endpoint -``` -PS C:\> $TrafficManagerEndpoint = New-AzureRmTrafficManagerEndpoint -EndpointStatus Enabled -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" -Type AzureEndpoints -Priority 1 -TargetResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-CentralUS/providers/Microsoft.Web/sites/contoso-web-app" -Weight 10 -PS C:\> Add-AzureRmTrafficManagerIpAddressRange -TrafficManagerEndpoint $TrafficManagerEndpoint -First "1.2.3.4" -Last "5.6.7.8" -PS C:\> Add-AzureRmTrafficManagerIpAddressRange -TrafficManagerEndpoint $TrafficManagerEndpoint -First "9.10.11.0" -Scope 24 -PS C:\> Add-AzureRmTrafficManagerIpAddressRange -TrafficManagerEndpoint $TrafficManagerEndpoint -First "12.13.14.0" -Last "12.13.14.31" -Scope 27 -PS C:\> Add-AzureRmTrafficManagerIpAddressRange -TrafficManagerEndpoint $TrafficManagerEndpoint -First "15.16.17.18" -PS C:\> Set-AzureRmTrafficManagerEndpoint -TrafficManagerEndpoint $TrafficManagerEndpoint -``` - -The first command creates an Azure Traffic Manager endpoint by using the **New-AzureRmTrafficManagerEndpoint** cmdlet. -The command stores the local endpoint in the $TrafficManagerEndpoint variable. -The second command adds the IP address range 1.2.3.4 to 5.6.7.8 to the endpoint stored in $TrafficManagerEndpoint. -The third command adds the IP address range 9.10.11.0 to 9.10.11.255 to the endpoint stored in $TrafficManagerEndpoint. -The fourth command verifies that the scope matches the size of the range, then adds the IP address range 12.13.14.0 to 12.13.14.31 to the endpoint stored in $TrafficManagerEndpoint. -The fifth command adds the IP address range 15.16.17.18 to 15.16.17.18 to the endpoint stored in $TrafficManagerEndpoint. -The final command updates the endpoint in Traffic Manager to match the local value in $TrafficManagerEndpoint. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Last -Specifies the last IP address in the range to be added. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Specifies the scope of the IP address range to be added. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrafficManagerEndpoint -Specifies a local **TrafficManagerEndpoint** object. -This cmdlet modifies this local object. -To obtain a **TrafficManagerEndpoint** object, use the Get-AzureRmTrafficManagerEndpoint or New-AzureRmTrafficManagerEndpoint cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -First -Specifies the first IP address in the range to be added. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.TrafficManagerEndpoint -This cmdlet accepts a **TrafficManagerEndpoint** object to this cmdlet. - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.TrafficManagerEndpoint -This cmdlet returns a modified **TrafficManagerEndpoint** object. - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmTrafficManagerIpAddressRange](./Remove-AzureRmTrafficManagerIpAddressRange.md) - -[New-AzureRmTrafficManagerEndpoint](./New-AzureRmTrafficManagerEndpoint.md) - -[Get-AzureRmTrafficManagerProfile](./Get-AzureRmTrafficManagerEndpoint.md) - -[Set-AzureRmTrafficManagerEndpoint](./Set-AzureRmTrafficManagerEndpoint.md) diff --git a/azurermps-6.13.0/AzureRM.TrafficManager/AzureRM.TrafficManager.md b/azurermps-6.13.0/AzureRM.TrafficManager/AzureRM.TrafficManager.md deleted file mode 100644 index f96033a4a8..0000000000 --- a/azurermps-6.13.0/AzureRM.TrafficManager/AzureRM.TrafficManager.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -Module Name: AzureRM.TrafficManager -Module Guid: D48CF693-4125-4D2D-8790-1514F44CE325 -Download Help Link: https://go.microsoft.com/fwlink/?LinkId=280237 -Help Version: 4.0.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/AzureRM.TrafficManager.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/AzureRM.TrafficManager.md ---- - -# AzureRM.TrafficManager Module -## Description -This topic lists the help topics for the Azure Traffic Manager cmdlets. The cmdlets use Azure Resource Manager. - -## AzureRM.TrafficManager Cmdlets -### [Add-AzureRmTrafficManagerCustomHeaderToEndpoint](Add-AzureRmTrafficManagerCustomHeaderToEndpoint.md) -Adds custom header information to a local Traffic Manager endpoint object. - -### [Add-AzureRmTrafficManagerCustomHeaderToProfile](Add-AzureRmTrafficManagerCustomHeaderToProfile.md) -Adds custom header information to a local Traffic Manager profile object. - -### [Add-AzureRmTrafficManagerEndpointConfig](Add-AzureRmTrafficManagerEndpointConfig.md) -Adds an endpoint to a local Traffic Manager profile object. - -### [Add-AzureRmTrafficManagerExpectedStatusCodeRange](Add-AzureRmTrafficManagerExpectedStatusCodeRange.md) -Adds an expected status code range to a local Traffic Manager profile object. - -### [Add-AzureRmTrafficManagerIpAddressRange](Add-AzureRmTrafficManagerIpAddressRange.md) -Adds an address range or subnet to a local Traffic Manager endpoint object. - -### [Disable-AzureRmTrafficManagerEndpoint](Disable-AzureRmTrafficManagerEndpoint.md) -Disables an endpoint in a Traffic Manager profile. - -### [Disable-AzureRmTrafficManagerProfile](Disable-AzureRmTrafficManagerProfile.md) -Disables a Traffic Manager profile. - -### [Enable-AzureRmTrafficManagerEndpoint](Enable-AzureRmTrafficManagerEndpoint.md) -Enables an endpoint in a Traffic Manager profile. - -### [Enable-AzureRmTrafficManagerProfile](Enable-AzureRmTrafficManagerProfile.md) -Enables a Traffic Manager profile. - -### [Get-AzureRmTrafficManagerEndpoint](Get-AzureRmTrafficManagerEndpoint.md) -Gets an endpoint for a Traffic Manager profile. - -### [Get-AzureRmTrafficManagerProfile](Get-AzureRmTrafficManagerProfile.md) -Gets a Traffic Manager profile. - -### [New-AzureRmTrafficManagerEndpoint](New-AzureRmTrafficManagerEndpoint.md) -Creates an endpoint in a Traffic Manager profile. - -### [New-AzureRmTrafficManagerProfile](New-AzureRmTrafficManagerProfile.md) -Creates a Traffic Manager profile. - -### [Remove-AzureRmTrafficManagerCustomHeaderFromEndpoint](Remove-AzureRmTrafficManagerCustomHeaderFromEndpoint.md) -Removes custom header information from a local Traffic Manager endpoint object. - -### [Remove-AzureRmTrafficManagerCustomHeaderFromProfile](Remove-AzureRmTrafficManagerCustomHeaderFromProfile.md) -Removes custom header information from a local Traffic Manager profile object. - -### [Remove-AzureRmTrafficManagerEndpoint](Remove-AzureRmTrafficManagerEndpoint.md) -Removes an endpoint from Traffic Manager. - -### [Remove-AzureRmTrafficManagerEndpointConfig](Remove-AzureRmTrafficManagerEndpointConfig.md) -Removes an endpoint from a local Traffic Manager profile object. - -### [Remove-AzureRmTrafficManagerExpectedStatusCodeRange](Remove-AzureRmTrafficManagerExpectedStatusCodeRange.md) -Removes an expected status code range from a local Traffic Manager profile object. - -### [Remove-AzureRmTrafficManagerIpAddressRange](Remove-AzureRmTrafficManagerIpAddressRange.md) -Removes an address range or subnet from a local Traffic Manager endpoint object. - -### [Remove-AzureRmTrafficManagerProfile](Remove-AzureRmTrafficManagerProfile.md) -Deletes a Traffic Manager profile. - -### [Set-AzureRmTrafficManagerEndpoint](Set-AzureRmTrafficManagerEndpoint.md) -Updates a Traffic Manager endpoint. - -### [Set-AzureRmTrafficManagerProfile](Set-AzureRmTrafficManagerProfile.md) -Updates a Traffic Manager profile. - diff --git a/azurermps-6.13.0/AzureRM.TrafficManager/Disable-AzureRmTrafficManagerEndpoint.md b/azurermps-6.13.0/AzureRM.TrafficManager/Disable-AzureRmTrafficManagerEndpoint.md deleted file mode 100644 index 8a74de49b2..0000000000 --- a/azurermps-6.13.0/AzureRM.TrafficManager/Disable-AzureRmTrafficManagerEndpoint.md +++ /dev/null @@ -1,238 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.TrafficManager.dll-Help.xml -Module Name: AzureRM.TrafficManager -ms.assetid: 8CC749F1-B961-4F8F-BAD4-2C0F4385D1C2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/disable-azurermtrafficmanagerendpoint -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Disable-AzureRmTrafficManagerEndpoint.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Disable-AzureRmTrafficManagerEndpoint.md ---- - -# Disable-AzureRmTrafficManagerEndpoint - -## SYNOPSIS -Disables an endpoint in a Traffic Manager profile. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Fields -``` -Disable-AzureRmTrafficManagerEndpoint -Name <String> -Type <String> -ProfileName <String> - -ResourceGroupName <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### Object -``` -Disable-AzureRmTrafficManagerEndpoint -TrafficManagerEndpoint <TrafficManagerEndpoint> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Disable-AzureRmTrafficManagerEndpoint** cmdlet disables an endpoint in an Azure Traffic Manager profile. - -You can use the pipeline operator to pass a **TrafficManagerEndpoint** object to this cmdlet, or you can pass a **TrafficManagerEndpoint** object using the *TrafficManagerEndpoint* parameter. - -Alternatively, you can specify the endpoint name and type by using the *Name* and *Type* parameters, together with the *ProfileName* and *ResourceGroupName* parameters. - -## EXAMPLES - -### Example 1: Disable an endpoint by name -``` -PS C:\> Disable-AzureRmTrafficManagerEndpoint -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName ResourceGroup11 -Type ExternalEndpoints -``` - -This command disables the external endpoint named contoso in the profile named ContosoProfile in resource group ResouceGroup11. -The command prompts you for confirmation. - -### Example 2: Disable an endpoint by using the pipeline -``` -PS C:\>Get-AzureRmTrafficManagerEndpoint -Name "contoso" -Type ExternalEndpoints -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" | Disable-AzureRmTrafficManagerEndpoint -Force -``` - -This command gets the external endpoint named Contoso from the profile named ContosoProfile in ResourceGroup11. -The command then passes that endpoint to the **Disable-AzureRmTrafficManagerEndpoint** cmdlet by using the pipeline operator. -That cmdlet disables that endpoint. -The command specifies the *Force* parameter. -Therefore, it does not prompt you for confirmation. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Traffic Manager endpoint that this cmdlet disables. - -```yaml -Type: System.String -Parameter Sets: Fields -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileName -Specifies the name of a Traffic Manager profile in which this cmdlet disables an endpoint. -To obtain a profile, use the Get-AzureRmTrafficManagerProfile cmdlet. - -```yaml -Type: System.String -Parameter Sets: Fields -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. -This cmdlet disables a Traffic Manager endpoint in the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: Fields -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrafficManagerEndpoint -Specifies the Traffic Manager endpoint that this cmdlet disables. -To obtain a **TrafficManagerEndpoint** object, use the Get-AzureRmTrafficManagerEndpoint cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint -Parameter Sets: Object -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Type -Specifies the type of endpoint that this cmdlet adds to the Traffic Manager profile. -Valid values are: - -- AzureEndpoints -- ExternalEndpoints -- NestedEndpoints - -```yaml -Type: System.String -Parameter Sets: Fields -Aliases: -Accepted values: AzureEndpoints, ExternalEndpoints, NestedEndpoints - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### TrafficManagerEndpoint -Parameter 'TrafficManagerEndpoint' accepts value of type 'TrafficManagerEndpoint' from the pipeline - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Enable-AzureRmTrafficManagerEndpoint](./Enable-AzureRmTrafficManagerEndpoint.md) - -[Get-AzureRmTrafficManagerEndpoint](./Get-AzureRmTrafficManagerEndpoint.md) - -[Get-AzureRmTrafficManagerProfile](./Get-AzureRmTrafficManagerProfile.md) - -[New-AzureRmTrafficManagerEndpoint](./New-AzureRmTrafficManagerEndpoint.md) - -[New-AzureRmTrafficManagerProfile](./New-AzureRmTrafficManagerProfile.md) - -[Remove-AzureRmTrafficManagerEndpoint](./Remove-AzureRmTrafficManagerEndpoint.md) - -[Set-AzureRmTrafficManagerProfile](./Set-AzureRmTrafficManagerProfile.md) - - diff --git a/azurermps-6.13.0/AzureRM.TrafficManager/Disable-AzureRmTrafficManagerProfile.md b/azurermps-6.13.0/AzureRM.TrafficManager/Disable-AzureRmTrafficManagerProfile.md deleted file mode 100644 index 39fb993c10..0000000000 --- a/azurermps-6.13.0/AzureRM.TrafficManager/Disable-AzureRmTrafficManagerProfile.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.TrafficManager.dll-Help.xml -Module Name: AzureRM.TrafficManager -ms.assetid: B6E043FF-F4DD-44B7-BEAA-6B17C8F21D58 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/disable-azurermtrafficmanagerprofile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Disable-AzureRmTrafficManagerProfile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Disable-AzureRmTrafficManagerProfile.md ---- - -# Disable-AzureRmTrafficManagerProfile - -## SYNOPSIS -Disables a Traffic Manager profile. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Fields -``` -Disable-AzureRmTrafficManagerProfile -Name <String> -ResourceGroupName <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Object -``` -Disable-AzureRmTrafficManagerProfile -TrafficManagerProfile <TrafficManagerProfile> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Disable-AzureRmTrafficManagerProfile** cmdlet disables an Azure Traffic Manager profile. -You can specify the profile object by using the pipeline or as a parameter value. -Alternatively, you can specify the profile by using the *Name* and *ResourceGroupName* parameters. - -## EXAMPLES - -### Example 1: Disable a profile specified by name -``` -PS C:\>Disable-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" -``` - -This command disables the profile named ContosoProfile in ResourceGroup11. -The command prompts you for confirmation. - -### Example 2: Disable a profile by using the pipeline -``` -PS C:\>Get-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" | Disable-AzureRmTrafficManagerProfile -Force -``` - -This command gets the profile named ContosoProfile in ResourceGroup11. -The command then passes that profile to the **Disable-AzureRmTrafficManagerProfile** cmdlet by using the pipeline operator. -That cmdlet disables that profile. -The command specifies the *Force* parameter. -Therefore, it does not prompt you for confirmation. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Traffic Manager profile that this cmdlet disables. - -```yaml -Type: System.String -Parameter Sets: Fields -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. -This cmdlet disables a Traffic Manager profile in the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: Fields -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrafficManagerProfile -Specifies a **TrafficManagerProfile** object to disable. -To obtain a **TrafficManagerProfile** object, use the Get-AzureRmTrafficManagerProfile cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile -Parameter Sets: Object -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.TrafficManagerProfile -This cmdlet accepts a **TrafficManagerProfile** object. - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Enable-AzureRmTrafficManagerProfile](./Enable-AzureRmTrafficManagerProfile.md) - -[Get-AzureRmTrafficManagerProfile](./Get-AzureRmTrafficManagerProfile.md) - -[New-AzureRmTrafficManagerProfile](./New-AzureRmTrafficManagerProfile.md) - -[Remove-AzureRmTrafficManagerProfile](./Remove-AzureRmTrafficManagerProfile.md) - -[Set-AzureRmTrafficManagerProfile](./Set-AzureRmTrafficManagerProfile.md) - - diff --git a/azurermps-6.13.0/AzureRM.TrafficManager/Enable-AzureRmTrafficManagerEndpoint.md b/azurermps-6.13.0/AzureRM.TrafficManager/Enable-AzureRmTrafficManagerEndpoint.md deleted file mode 100644 index c424da7cfc..0000000000 --- a/azurermps-6.13.0/AzureRM.TrafficManager/Enable-AzureRmTrafficManagerEndpoint.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.TrafficManager.dll-Help.xml -Module Name: AzureRM.TrafficManager -ms.assetid: 32263236-C207-4FE0-AB8A-018118FC7729 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/enable-azurermtrafficmanagerendpoint -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Enable-AzureRmTrafficManagerEndpoint.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Enable-AzureRmTrafficManagerEndpoint.md ---- - -# Enable-AzureRmTrafficManagerEndpoint - -## SYNOPSIS -Enables an endpoint in a Traffic Manager profile. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Fields -``` -Enable-AzureRmTrafficManagerEndpoint -Name <String> -Type <String> -ProfileName <String> - -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### Object -``` -Enable-AzureRmTrafficManagerEndpoint -TrafficManagerEndpoint <TrafficManagerEndpoint> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Enable-AzureRmTrafficManagerEndpoint** cmdlet enables an endpoint in an Azure Traffic Manager profile. - -You can use the pipeline operator to pass a **TrafficManagerEndpoint** object to this cmdlet, or you can specify a **TrafficManagerEndpoint** object by using the *TrafficManagerEndpoint* parameter. - -Alternatively, you can specify the endpoint name and type by using the *Name* and *Type* parameters, together with the *ProfileName* and *ResourceGroupName* parameters. - -## EXAMPLES - -### Example 1: Enable an endpoint from a profile -``` -PS C:\>Enable-AzureRmTrafficManagerEndpoint -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName ResourceGroup11 -Type ExternalEndpoints -``` - -This command enables the external endpoint named contoso in the profile named ContosoProfile in resource group ResouceGroup11. - -### Example 2: Enable an endpoint by using the pipeline -``` -PS C:\>Get-AzureRmTrafficManagerEndpoint -Name "contoso" -Type ExternalEndpoints -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" | Enable-AzureRmTrafficManagerEndpoint -``` - -This command gets the external endpoint named Contoso from the profile named ContosoProfile in ResourceGroup11. -The command then passes that endpoint to the **Enable-AzureRmTrafficManagerEndpoint** cmdlet by using the pipeline operator. -That cmdlet enables that endpoint. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Traffic Manager endpoint that this cmdlet enables. - -```yaml -Type: System.String -Parameter Sets: Fields -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileName -Specifies the name of a Traffic Manager profile in which this cmdlet enables an endpoint. -To obtain a profile, use the Get-AzureRmTrafficManagerProfile cmdlet. - -```yaml -Type: System.String -Parameter Sets: Fields -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. -This cmdlet enables a Traffic Manager endpoint in the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: Fields -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrafficManagerEndpoint -Specifies the Traffic Manager endpoint that this cmdlet enables. -To obtain a **TrafficManagerEndpoint** object, use the Get-AzureRmTrafficManagerEndpoint cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint -Parameter Sets: Object -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Type -Specifies the type of endpoint that this cmdlet disables in the Traffic Manager profile. -Valid values are: - -- AzureEndpoints -- ExternalEndpoints -- NestedEndpoints - -```yaml -Type: System.String -Parameter Sets: Fields -Aliases: -Accepted values: AzureEndpoints, ExternalEndpoints, NestedEndpoints - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### TrafficManagerEndpoint -Parameter 'TrafficManagerEndpoint' accepts value of type 'TrafficManagerEndpoint' from the pipeline - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Disable-AzureRmTrafficManagerEndpoint](./Disable-AzureRmTrafficManagerEndpoint.md) - -[Get-AzureRmTrafficManagerEndpoint](./Get-AzureRmTrafficManagerEndpoint.md) - -[Get-AzureRmTrafficManagerProfile](./Get-AzureRmTrafficManagerProfile.md) - -[New-AzureRmTrafficManagerEndpoint](./New-AzureRmTrafficManagerEndpoint.md) - -[New-AzureRmTrafficManagerProfile](./New-AzureRmTrafficManagerProfile.md) - -[Remove-AzureRmTrafficManagerEndpoint](./Remove-AzureRmTrafficManagerEndpoint.md) - -[Set-AzureRmTrafficManagerProfile](./Set-AzureRmTrafficManagerProfile.md) - - diff --git a/azurermps-6.13.0/AzureRM.TrafficManager/Enable-AzureRmTrafficManagerProfile.md b/azurermps-6.13.0/AzureRM.TrafficManager/Enable-AzureRmTrafficManagerProfile.md deleted file mode 100644 index afbf7ed0b5..0000000000 --- a/azurermps-6.13.0/AzureRM.TrafficManager/Enable-AzureRmTrafficManagerProfile.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.TrafficManager.dll-Help.xml -Module Name: AzureRM.TrafficManager -ms.assetid: 2CE84C3A-EFC0-47FA-ACE5-687380D90A7D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/enable-azurermtrafficmanagerprofile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Enable-AzureRmTrafficManagerProfile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Enable-AzureRmTrafficManagerProfile.md ---- - -# Enable-AzureRmTrafficManagerProfile - -## SYNOPSIS -Enables a Traffic Manager profile. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Fields -``` -Enable-AzureRmTrafficManagerProfile -Name <String> -ResourceGroupName <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### Object -``` -Enable-AzureRmTrafficManagerProfile -TrafficManagerProfile <TrafficManagerProfile> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Enable-AzureRmTrafficManagerProfile** cmdlet enables an Azure Traffic Manager profile. -You can specify the profile object by using the pipeline or as a parameter value. -Alternatively, you can specify the profile by using the *Name* and *ResourceGroupName* parameters. - -## EXAMPLES - -### Example 1: Enable a profile specified by name -``` -PS C:\>Enable-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" -``` - -This command enables the profile named ContosoProfile in ResourceGroup11. - -### Example 2: Enable a profile by using the pipeline -``` -PS C:\>Get-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" | Enable-AzureRmTrafficManagerProfile -``` - -This command gets the profile named ContosoProfile in ResourceGroup11. -The command then passes that profile to the **Enable-AzureRmTrafficManagerProfile** cmdlet by using the pipeline operator. -That cmdlet enables that profile. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Traffic Manager profile that this cmdlet enables. - -```yaml -Type: System.String -Parameter Sets: Fields -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. -This cmdlet enables a Traffic Manager profile in the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: Fields -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrafficManagerProfile -Specifies a **TrafficManagerProfile** object to enable. -To obtain a **TrafficManagerProfile** object, use the Get-AzureRmTrafficManagerProfile cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile -Parameter Sets: Object -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.TrafficManagerProfile -This cmdlet accepts a **TrafficManagerProfile** object. - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Disable-AzureRmTrafficManagerProfile](./Disable-AzureRmTrafficManagerProfile.md) - -[Get-AzureRmTrafficManagerProfile](./Get-AzureRmTrafficManagerProfile.md) - -[New-AzureRmTrafficManagerProfile](./New-AzureRmTrafficManagerProfile.md) - -[Remove-AzureRmTrafficManagerProfile](./Remove-AzureRmTrafficManagerProfile.md) - -[Set-AzureRmTrafficManagerProfile](./Set-AzureRmTrafficManagerProfile.md) - - diff --git a/azurermps-6.13.0/AzureRM.TrafficManager/Get-AzureRmTrafficManagerEndpoint.md b/azurermps-6.13.0/AzureRM.TrafficManager/Get-AzureRmTrafficManagerEndpoint.md deleted file mode 100644 index 33c7f9833f..0000000000 --- a/azurermps-6.13.0/AzureRM.TrafficManager/Get-AzureRmTrafficManagerEndpoint.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.TrafficManager.dll-Help.xml -Module Name: AzureRM.TrafficManager -ms.assetid: 4556C345-55D0-431C-B980-219D5ED14E5F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/get-azurermtrafficmanagerendpoint -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Get-AzureRmTrafficManagerEndpoint.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Get-AzureRmTrafficManagerEndpoint.md ---- - -# Get-AzureRmTrafficManagerEndpoint - -## SYNOPSIS -Gets an endpoint for a Traffic Manager profile. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Fields -``` -Get-AzureRmTrafficManagerEndpoint -Name <String> -Type <String> -ProfileName <String> - -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### Object -``` -Get-AzureRmTrafficManagerEndpoint -TrafficManagerEndpoint <TrafficManagerEndpoint> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmTrafficManagerEndpoint** cmdlet gets an endpoint for an Azure Traffic Manager profile. - -You can modify this object locally, and then apply changes to the profile by using the Set-AzureRmTrafficManagerEndpoint cmdlet. -Specify the endpoint by using the *Name* and *Type* parameters. -You can specify the Traffic Manager profile either by using the *ProfileName* and *ResourceGroupName* parameter, or by specifying a **TrafficManagerProfile** object. -Alternatively, you can pass that value by using the pipeline. - -## EXAMPLES - -### Example 1: Get an endpoint -``` -PS C:\>$TrafficManagerEndpoint = Get-AzureRmTrafficManagerEndpoint -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" -Type AzureEndpoints -``` - -This command gets the Azure endpoint named contoso from the profile named ContosoProfile in the resource group named ResourceGroup11, and then stores that object in the $TrafficManagerEndpoint variable. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Traffic Manager endpoint that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: Fields -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileName -Specifies the name of the Traffic Manager endpoint that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: Fields -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. -This cmdlet gets a Traffic Manager endpoint in the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: Fields -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrafficManagerEndpoint -Specifies the Traffic Manager endpoint that this cmdlet gets. - -```yaml -Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint -Parameter Sets: Object -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Type -Specifies the type of endpoint that this cmdlet adds to the Traffic Manager profile. -Valid values are: - -- AzureEndpoints -- ExternalEndpoints -- NestedEndpoints - -```yaml -Type: System.String -Parameter Sets: Fields -Aliases: -Accepted values: AzureEndpoints, ExternalEndpoints, NestedEndpoints - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint -Parameter 'TrafficManagerEndpoint' accepts value of type 'TrafficManagerEndpoint' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint - -## NOTES - -## RELATED LINKS - -[Disable-AzureRmTrafficManagerEndpoint](./Disable-AzureRmTrafficManagerEndpoint.md) - -[Enable-AzureRmTrafficManagerEndpoint](./Enable-AzureRmTrafficManagerEndpoint.md) - -[New-AzureRmTrafficManagerEndpoint](./New-AzureRmTrafficManagerEndpoint.md) - -[Remove-AzureRmTrafficManagerEndpoint](./Remove-AzureRmTrafficManagerEndpoint.md) - -[Set-AzureRmTrafficManagerEndpoint](./Set-AzureRmTrafficManagerEndpoint.md) - - diff --git a/azurermps-6.13.0/AzureRM.TrafficManager/Get-AzureRmTrafficManagerProfile.md b/azurermps-6.13.0/AzureRM.TrafficManager/Get-AzureRmTrafficManagerProfile.md deleted file mode 100644 index 11ee2d3cae..0000000000 --- a/azurermps-6.13.0/AzureRM.TrafficManager/Get-AzureRmTrafficManagerProfile.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.TrafficManager.dll-Help.xml -Module Name: AzureRM.TrafficManager -ms.assetid: 5032D487-3849-4C80-BD14-5B735FC39285 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/get-azurermtrafficmanagerprofile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Get-AzureRmTrafficManagerProfile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Get-AzureRmTrafficManagerProfile.md ---- - -# Get-AzureRmTrafficManagerProfile - -## SYNOPSIS -Gets a Traffic Manager profile. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceGroupParameterSet -``` -Get-AzureRmTrafficManagerProfile [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### AccountNameParameterSet -``` -Get-AzureRmTrafficManagerProfile [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmTrafficManagerProfile** cmdlet gets an Azure Traffic Manager profile, and returns an object that represents that profile. -Specify a profile by its name and resource group name. - -You can modify this object locally, and then apply changes to the profile by using the Set-AzureRmTrafficManagerProfile cmdlet. - -## EXAMPLES - -### Example 1: Get a profile -``` -PS C:\>Get-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" -``` - -This command gets the profile named ContosoProfile in ResourceGroup11. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Traffic Manager profile that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: AccountNameParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group that contains the Traffic Manager profile that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupParameterSet -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: AccountNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.TrafficManagerProfile -This cmdlet returns a **TrafficManagerProfile** object. -You can modify this object, and then apply changes to Traffic Manager by using **Set-AzureRmTrafficManagerProfile**. - -## NOTES - -## RELATED LINKS - -[Disable-AzureRmTrafficManagerProfile](./Disable-AzureRmTrafficManagerProfile.md) - -[Enable-AzureRmTrafficManagerProfile](./Enable-AzureRmTrafficManagerProfile.md) - -[New-AzureRmTrafficManagerProfile](./New-AzureRmTrafficManagerProfile.md) - -[Remove-AzureRmTrafficManagerProfile](./Remove-AzureRmTrafficManagerProfile.md) - -[Set-AzureRmTrafficManagerProfile](./Set-AzureRmTrafficManagerProfile.md) - - diff --git a/azurermps-6.13.0/AzureRM.TrafficManager/New-AzureRmTrafficManagerEndpoint.md b/azurermps-6.13.0/AzureRM.TrafficManager/New-AzureRmTrafficManagerEndpoint.md deleted file mode 100644 index 3134efa39d..0000000000 --- a/azurermps-6.13.0/AzureRM.TrafficManager/New-AzureRmTrafficManagerEndpoint.md +++ /dev/null @@ -1,346 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.TrafficManager.dll-Help.xml -Module Name: AzureRM.TrafficManager -ms.assetid: A7A908A1-7326-4725-A3F9-4D05E40C5F73 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/new-azurermtrafficmanagerendpoint -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/New-AzureRmTrafficManagerEndpoint.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/New-AzureRmTrafficManagerEndpoint.md ---- - -# New-AzureRmTrafficManagerEndpoint - -## SYNOPSIS -Creates an endpoint in a Traffic Manager profile. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmTrafficManagerEndpoint -Name <String> -ProfileName <String> -ResourceGroupName <String> - -Type <String> [-TargetResourceId <String>] [-Target <String>] -EndpointStatus <String> [-Weight <UInt32>] - [-Priority <UInt32>] [-EndpointLocation <String>] [-MinChildEndpoints <UInt32>] - [-GeoMapping <System.Collections.Generic.List`1[System.String]>] - [-SubnetMapping <System.Collections.Generic.List`1[Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerIpAddressRange]>] - [-CustomHeader <System.Collections.Generic.List`1[Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerCustomHeader]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmTrafficManagerEndpoint** cmdlet creates an endpoint in an Azure Traffic Manager profile. - -This cmdlet commits each new endpoint to the Traffic Manager service. -To add multiple endpoints to a local Traffic Manager profile object and commit changes in a single operation, use the Add-AzureRmTrafficManagerEndpointConfig cmdlet. - -## EXAMPLES - -### Example 1: Create an external endpoint for a profile -``` -PS C:\>New-AzureRmTrafficManagerEndpoint -EndpointStatus Enabled -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" -Type ExternalEndpoints -EndpointLocation "North Europe" -Priority 1 -Target "www.contoso.com" -Weight 10 -``` - -This command creates an external endpoint named contoso in the profile named ContosoProfile in the resource group named ResourceGroup11. - -### Example 2: Create an Azure endpoint for a profile -``` -PS C:\>New-AzureRmTrafficManagerEndpoint -EndpointStatus Enabled -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" -Type AzureEndpoints -Priority 1 -TargetResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-CentralUS/providers/Microsoft.Web/sites/contoso-web-app" -Weight 10 -``` - -This command creates an Azure endpoint named contoso in the profile named ContosoProfile in resource group ResouceGroup11. -The Azure endpoint points to the Azure Web App whose Azure Resource Manager ID is given by the URI path in *TargetResourceId*. -The command does not specify the *EndpointLocation* parameter because the Web App resource supplies the location. - -## PARAMETERS - -### -CustomHeader -List of custom header name and value pairs for probe requests. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerCustomHeader] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndpointLocation -Specifies the location of the endpoint to use in the Performance traffic-routing method. -This parameter is only applicable to endpoints of the ExternalEndpoints or NestedEndpoints type. -You must specify this parameter when the Performance traffic-routing method is used. - -Specify an Azure region name. -For a full list of Azure regions, see Azure Regionshttps://azure.microsoft.com/regions/ (https://azure.microsoft.com/regions/). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndpointStatus -Specifies the status of the endpoint. -Valid values are: - -- Enabled -- Disabled - -If the status is Enabled, the endpoint is probed for endpoint health and is included in the traffic-routing method. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GeoMapping -The list of regions mapped to this endpoint when using the 'Geographic' traffic routing method. Please consult Traffic Manager documentation for a full list of accepted values. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinChildEndpoints -Specify an Azure region name. -For a full list of Azure regions, see Azure Regionshttps://azure.microsoft.com/regions/ (https://azure.microsoft.com/regions/). - -```yaml -Type: System.Nullable`1[System.UInt32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Traffic Manager endpoint that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -Specifies the priority that Traffic Manager assigns to the endpoint. -This parameter is used only if the Traffic Manager profile is configured with the for Priority traffic-routing method. -Valid values are integers from 1 through 1000. -Lower values represent higher priority. - -If you specify a priority, you must specify priorities on all endpoints in the profile, and no two endpoints can share the same priority value. -If you do not specify priorities, Traffic Manager assigns default priority values to the endpoints, starting with one (1), in the order the profile lists the endpoints. - -```yaml -Type: System.Nullable`1[System.UInt32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileName -Specifies the name of a Traffic Manager profile to which this cmdlet adds an endpoint. -To obtain a profile, use the New-AzureRmTrafficManagerProfile or Get-AzureRmTrafficManagerProfile cmdlets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. -This cmdlet creates a Traffic Manager endpoint in the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetMapping -The list of address ranges or subnets mapped to this endpoint when using the ‘Subnet’ traffic routing method. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerIpAddressRange] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Target -Specifies the fully qualified DNS name of the endpoint. -Traffic Manager returns this value in DNS responses when it directs traffic to this endpoint. -Specify this parameter only for the ExternalEndpoints endpoint type. -For other endpoint types, specify the *TargetResourceId* parameter instead. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetResourceId -Specifies resource ID of the target. -Specify this parameter only for the AzureEndpoints and NestedEndpoints endpoint types. -For the ExternalEndpoints endpoint type, specify the *Target* parameter instead. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the type of endpoint that this cmdlet adds to the Traffic Manager profile. -Valid values are: - -- AzureEndpoints -- ExternalEndpoints -- NestedEndpoints - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: AzureEndpoints, ExternalEndpoints, NestedEndpoints - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Weight -Specifies the weight that Traffic Manager assigns to the endpoint. -Valid values are integers from 1 through 1000. -The default value is one (1). -This parameter is used only if the Traffic Manager profile is configured with the Weighted traffic-routing method. - -```yaml -Type: System.Nullable`1[System.UInt32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint - -## NOTES - -## RELATED LINKS - -[Disable-AzureRmTrafficManagerEndpoint](./Disable-AzureRmTrafficManagerEndpoint.md) - -[Enable-AzureRmTrafficManagerEndpoint](./Enable-AzureRmTrafficManagerEndpoint.md) - -[Get-AzureRmTrafficManagerEndpoint](./Get-AzureRmTrafficManagerEndpoint.md) - -[Get-AzureRmTrafficManagerProfile](./Get-AzureRmTrafficManagerProfile.md) - -[New-AzureRmTrafficManagerProfile](./New-AzureRmTrafficManagerProfile.md) - -[Remove-AzureRmTrafficManagerEndpoint](./Remove-AzureRmTrafficManagerEndpoint.md) - -[Set-AzureRmTrafficManagerProfile](./Set-AzureRmTrafficManagerProfile.md) - - diff --git a/azurermps-6.13.0/AzureRM.TrafficManager/New-AzureRmTrafficManagerProfile.md b/azurermps-6.13.0/AzureRM.TrafficManager/New-AzureRmTrafficManagerProfile.md deleted file mode 100644 index 354e2bc04f..0000000000 --- a/azurermps-6.13.0/AzureRM.TrafficManager/New-AzureRmTrafficManagerProfile.md +++ /dev/null @@ -1,359 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.TrafficManager.dll-Help.xml -Module Name: AzureRM.TrafficManager -ms.assetid: DE31891A-0EF7-44D7-B955-A3279D27CC21 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/new-azurermtrafficmanagerprofile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/New-AzureRmTrafficManagerProfile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/New-AzureRmTrafficManagerProfile.md ---- - -# New-AzureRmTrafficManagerProfile - -## SYNOPSIS -Creates a Traffic Manager profile. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmTrafficManagerProfile -Name <String> -ResourceGroupName <String> [-ProfileStatus <String>] - -RelativeDnsName <String> -Ttl <UInt32> -TrafficRoutingMethod <String> -MonitorProtocol <String> - -MonitorPort <UInt32> [-MonitorPath <String>] [-MonitorIntervalInSeconds <Int32>] - [-MonitorTimeoutInSeconds <Int32>] [-MonitorToleratedNumberOfFailures <Int32>] [-MaxReturn <Int64>] - [-Tag <Hashtable>] - [-CustomHeader <System.Collections.Generic.List`1[Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerCustomHeader]>] - [-ExpectedStatusCodeRange <System.Collections.Generic.List`1[Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerExpectedStatusCodeRange]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmTrafficManagerProfile** cmdlet creates an Azure Traffic Manager profile. -Specify the *Name* parameter and required settings. -This cmdlet returns a local object that represents the new profile. - -This cmdlet does not configure Traffic Manager endpoints. -You can update the local profile object by using the Add-AzureRmTrafficManagerEndpointConfig cmdlet. -Then upload changes to Traffic Manager by using the Set-AzureRmTrafficManagerProfile cmdlet. -Alternatively, you can add endpoints by using the New-AzureRmTrafficManagerEndpoint cmdlet. - -## EXAMPLES - -### Example 1: Create a profile -``` -PS C:\>New-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" -ProfileStatus Enabled -TrafficRoutingMethod Performance -RelativeDnsName "contosoapp" -TTL 30 -MonitorProtocol HTTP -MonitorPort 80 -MonitorPath "/default.aspx" -``` - -This command creates an Azure Traffic Manager profile named ContosoProfile in resource group ResourceGroup11. -The DNS FQDN is contosoapp.trafficmanager.net. - -## PARAMETERS - -### -CustomHeader -List of custom header name and value pairs for probe requests. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerCustomHeader] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpectedStatusCodeRange -List of expected HTTP status code ranges for probe requests. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerExpectedStatusCodeRange] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxReturn -The maximum number of answers returned for profiles with a MultiValue routing method. - -```yaml -Type: System.Nullable`1[System.Int64] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MonitorIntervalInSeconds -The interval (in seconds) at which Traffic Manager will check the health of each endpoint in this profile. The default is 30. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: IntervalInSecondsForMonitor - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MonitorPath -Specifies the path that is used to monitor endpoint health. -Specify a value relative to the endpoint domain name. -This value must begin with a slash (/). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: PathForMonitor - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MonitorPort -Specifies the TCP port that is used to monitor endpoint health. -Valid values are integers from 1 through 65535. - -```yaml -Type: System.UInt32 -Parameter Sets: (All) -Aliases: PortForMonitor - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MonitorProtocol -Specifies the protocol to use to monitor endpoint health. -Valid values are: - -- HTTP -- HTTPS - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ProtocolForMonitor -Accepted values: HTTP, HTTPS, TCP - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MonitorTimeoutInSeconds -The time (in seconds) that Traffic Manager allows endpoints in this profile to respond to the health check. The default is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: TimeoutInSecondsForMonitor - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MonitorToleratedNumberOfFailures -The number of consecutive failed health checks that Traffic Manager tolerates before declaring an endpoint in this profile Degraded after the next consecutive failed health check. The default is 3. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: ToleratedNumberOfFailuresForMonitor - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the Traffic Manager profile that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileStatus -Specifies the status of the profile. -Valid values are: Enabled and Disabled. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RelativeDnsName -Specifies the relative DNS name that this Traffic Manager profile provides. -Traffic Manager combines this value and the DNS domain name that Azure Traffic Manager uses to form the fully qualified domain name (FQDN) of the profile. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. -This cmdlet creates a Traffic Manager profile in the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table set as tags on the server. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrafficRoutingMethod -Specifies the traffic routing method. -This method determines which endpoint Traffic Manager returns in response to incoming DNS queries. -Valid values are: - -- Performance -- Weighted -- Priority -- Geographic - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Performance, Weighted, Priority, Geographic - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Ttl -Specifies the DNS Time to Live (TTL) value. - -```yaml -Type: System.UInt32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.TrafficManagerProfile -This cmdlet returns a new TrafficManagerProfile object. - -## NOTES - -## RELATED LINKS - -[Add-AzureRmTrafficManagerEndpointConfig](./Add-AzureRmTrafficManagerEndpointConfig.md) - -[Disable-AzureRmTrafficManagerProfile](./Disable-AzureRmTrafficManagerProfile.md) - -[Enable-AzureRmTrafficManagerProfile](./Enable-AzureRmTrafficManagerProfile.md) - -[Get-AzureRmTrafficManagerProfile](./Get-AzureRmTrafficManagerProfile.md) - -[Remove-AzureRmTrafficManagerProfile](./Remove-AzureRmTrafficManagerProfile.md) - -[Set-AzureRmTrafficManagerProfile](./Set-AzureRmTrafficManagerProfile.md) - - diff --git a/azurermps-6.13.0/AzureRM.TrafficManager/Remove-AzureRmTrafficManagerCustomHeaderFromEndpoint.md b/azurermps-6.13.0/AzureRM.TrafficManager/Remove-AzureRmTrafficManagerCustomHeaderFromEndpoint.md deleted file mode 100644 index 3300a21601..0000000000 --- a/azurermps-6.13.0/AzureRM.TrafficManager/Remove-AzureRmTrafficManagerCustomHeaderFromEndpoint.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.TrafficManager.dll-Help.xml -Module Name: AzureRM.TrafficManager -ms.assetid: 25E3F297-1D91-4102-B4D3-1E7195A5D342 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/remove-azurermtrafficmanagercustomheaderfromendpoint -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Remove-AzureRmTrafficManagerCustomHeaderFromEndpoint.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Remove-AzureRmTrafficManagerCustomHeaderFromEndpoint.md ---- - -# Remove-AzureRmTrafficManagerCustomHeaderFromEndpoint - -## SYNOPSIS -Removes custom header information from a local Traffic Manager endpoint object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmTrafficManagerCustomHeaderFromEndpoint -Name <String> - -TrafficManagerEndpoint <TrafficManagerEndpoint> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmTrafficManagerCustomHeaderFromEndpoint** cmdlet removes custom header information from a local Azure Traffic Manager endpoint object. -You can get an endpoint by using the New-AzureRmTrafficManagerEndpoint or Get-AzureRmTrafficManagerEndpoint cmdlets. - -This cmdlet operates on the local endpoint object. -Commit your changes to the endpoint for Traffic Manager by using the Set-AzureRmTrafficManagerEndpoint cmdlet. - -## EXAMPLES - -### Example 1: Remove custom subnet information from an endpoint -``` -PS C:\> $TrafficManagerEndpoint = Get-AzureRmTrafficManagerEndpoint -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" -Type AzureEndpoints -PS C:\> Remove-AzureRmTrafficManagerCustomHeaderFromEndpoint -TrafficManagerEndpoint $TrafficManagerEndpoint -Name "host" -PS C:\> Set-AzureRmTrafficManagerEndpoint -TrafficManagerEndpoint $TrafficManagerEndpoint -``` - -The first command gets the Azure endpoint named contoso from the profile named ContosoProfile in the resource group named ResourceGroup11, and then stores that object in the $TrafficManagerEndpoint variable. -The second command removes custom header information from the endpoint stored in $TrafficManagerEndpoint. -The final command updates the endpoint in Traffic Manager to match the local value in $TrafficManagerEndpoint. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the custom header information to be removed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrafficManagerEndpoint -Specifies a local **TrafficManagerEndpoint** object. -This cmdlet modifies this local object. -To obtain a **TrafficManagerEndpoint** object, use the Get-AzureRmTrafficManagerEndpoint or New-AzureRmTrafficManagerEndpoint cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.TrafficManagerEndpoint -This cmdlet accepts a **TrafficManagerEndpoint** object to this cmdlet. - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.TrafficManagerEndpoint -This cmdlet returns a modified TrafficManagerEndpoint object. - -## NOTES - -## RELATED LINKS - -[Add-AzureRmTrafficManagerCustomHeaderToEndpoint](./Add-AzureRmTrafficManagerCustomHeaderToEndpoint.md) - -[Get-AzureRmTrafficManagerProfile](./Get-AzureRmTrafficManagerEndpoint.md) - -[New-AzureRmTrafficManagerEndpoint](./New-AzureRmTrafficManagerEndpoint.md) - -[Set-AzureRmTrafficManagerEndpoint](./Set-AzureRmTrafficManagerEndpoint.md) diff --git a/azurermps-6.13.0/AzureRM.TrafficManager/Remove-AzureRmTrafficManagerCustomHeaderFromProfile.md b/azurermps-6.13.0/AzureRM.TrafficManager/Remove-AzureRmTrafficManagerCustomHeaderFromProfile.md deleted file mode 100644 index a3d6d65b36..0000000000 --- a/azurermps-6.13.0/AzureRM.TrafficManager/Remove-AzureRmTrafficManagerCustomHeaderFromProfile.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.TrafficManager.dll-Help.xml -Module Name: AzureRM.TrafficManager -ms.assetid: 25E3F297-1D91-4102-B4D3-1E7195A5D343 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/remove-azurermtrafficmanagercustomheaderfromprofile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Remove-AzureRmTrafficManagerCustomHeaderFromProfile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Remove-AzureRmTrafficManagerCustomHeaderFromProfile.md ---- - -# Remove-AzureRmTrafficManagerCustomHeaderFromProfile - -## SYNOPSIS -Removes custom header information from a local Traffic Manager profile object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmTrafficManagerCustomHeaderFromProfile -Name <String> - -TrafficManagerProfile <TrafficManagerProfile> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmTrafficManagerCustomHeaderFromProfile** cmdlet removes custom header information from a local Azure Traffic Manager profile object. -You can get a profile by using the New-AzureRmTrafficManagerProfile or Get-AzureRmTrafficManagerProfile cmdlets. - -This cmdlet operates on the local profile object. -Commit your changes to the profile for Traffic Manager by using the Set-AzureRmTrafficManagerProfile cmdlet. - -## EXAMPLES - -### Example 1: Remove custom header information from a profile -``` -PS C:\> $TrafficManagerProfile = Get-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" -PS C:\> Remove-AzureRmTrafficManagerCustomHeaderFromEndpoint -TrafficManagerProfile $TrafficManagerProfile -Name "host" -PS C:\> Set-AzureRmTrafficManagerProfile -TrafficManagerProfile $TrafficManagerProfile -``` - -The first command gets an Azure Traffic Manager profile by using the **Get-AzureRmTrafficManagerProfile** cmdlet. -The second command removes custom header information from the profile stored in $TrafficManagerProfile. -The final command updates the profile in Traffic Manager to match the local value in $TrafficManagerProfile. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the custom header information to be removed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrafficManagerProfile -Specifies a local **TrafficManagerProfile** object. -This cmdlet modifies this local object. -To obtain a **TrafficManagerProfile** object, use the Get-AzureRmTrafficManagerProfile cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.TrafficManagerProfile -This cmdlet accepts a **TrafficManagerProfile** object to this cmdlet. - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.TrafficManagerProfile -This cmdlet returns a modified **TrafficManagerProfile** object. - -## NOTES - -## RELATED LINKS - -[Add-AzureRmTrafficManagerCustomHeaderToProfile](./Add-AzureRmTrafficManagerCustomHeaderToProfile.md) - -[Get-AzureRmTrafficManagerProfile](./Get-AzureRmTrafficManagerProfile.md) - -[Set-AzureRmTrafficManagerProfile](./Set-AzureRmTrafficManagerProfile.md) diff --git a/azurermps-6.13.0/AzureRM.TrafficManager/Remove-AzureRmTrafficManagerEndpoint.md b/azurermps-6.13.0/AzureRM.TrafficManager/Remove-AzureRmTrafficManagerEndpoint.md deleted file mode 100644 index 3e9fbd9ab6..0000000000 --- a/azurermps-6.13.0/AzureRM.TrafficManager/Remove-AzureRmTrafficManagerEndpoint.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.TrafficManager.dll-Help.xml -Module Name: AzureRM.TrafficManager -ms.assetid: 2129C457-592B-484C-A148-828BFD5895D4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/remove-azurermtrafficmanagerendpoint -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Remove-AzureRmTrafficManagerEndpoint.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Remove-AzureRmTrafficManagerEndpoint.md ---- - -# Remove-AzureRmTrafficManagerEndpoint - -## SYNOPSIS -Removes an endpoint from Traffic Manager. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Fields -``` -Remove-AzureRmTrafficManagerEndpoint -Name <String> -Type <String> -ProfileName <String> - -ResourceGroupName <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### Object -``` -Remove-AzureRmTrafficManagerEndpoint -TrafficManagerEndpoint <TrafficManagerEndpoint> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmTrafficManagerEndpoint** cmdlet removes an endpoint from Azure Traffic Manager. - -This cmdlet commits each change to the Traffic Manager service. -To remove multiple endpoints from a local Traffic Manager profile object and commit changes in a single operation, use the Remove-AzureRmTrafficManagerEndpointConfig cmdlet. - -You can use the pipeline operator to pass a **TrafficManagerEndpoint** object to this cmdlet, or you can specify a **TrafficManagerEndpoint** object by using the *TrafficManagerEndpoint* parameter. - -Alternatively, you can specify the endpoint name and type by using the *Name* and *Type* parameters, together with the *ProfileName* and *ResourceGroupName* parameters. - -## EXAMPLES - -### Example 1: Remove an endpoint from a profile -``` -PS C:\>Remove-AzureRmTrafficManagerEndpoint -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" -Type AzureEndpoints -``` - -This command removes the Azure endpoint named contoso from the profile named ContosoProfile in the resource group named ResourceGroup11. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Traffic Manager endpoint that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: Fields -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfileName -Specifies the name of a Traffic Manager profile from which this cmdlet removes an endpoint. -To obtain a profile, use the Get-AzureRmTrafficManagerProfile cmdlet. - -```yaml -Type: System.String -Parameter Sets: Fields -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. -This cmdlet removes a Traffic Manager endpoint from a Traffic Manager profile in the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: Fields -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrafficManagerEndpoint -Specifies the Traffic Manager endpoint that this cmdlet removes. -To obtain a **TrafficManagerEndpoint** object, use the Get-AzureRmTrafficManagerEndpoint cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint -Parameter Sets: Object -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Type -Specifies the type of endpoint that this cmdlet adds to the Traffic Manager profile. -Valid values are: - -- AzureEndpoints -- ExternalEndpoints -- NestedEndpoints - -```yaml -Type: System.String -Parameter Sets: Fields -Aliases: -Accepted values: AzureEndpoints, ExternalEndpoints, NestedEndpoints - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### TrafficManagerEndpoint -Parameter 'TrafficManagerEndpoint' accepts value of type 'TrafficManagerEndpoint' from the pipeline - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmTrafficManagerEndpoint](./Get-AzureRmTrafficManagerEndpoint.md) - -[Get-AzureRmTrafficManagerProfile](./Get-AzureRmTrafficManagerProfile.md) - -[New-AzureRmTrafficManagerEndpoint](./New-AzureRmTrafficManagerEndpoint.md) - -[Remove-AzureRmTrafficManagerEndpointConfig](./Remove-AzureRmTrafficManagerEndpointConfig.md) - -[Set-AzureRmTrafficManagerProfile](./Set-AzureRmTrafficManagerProfile.md) - - diff --git a/azurermps-6.13.0/AzureRM.TrafficManager/Remove-AzureRmTrafficManagerEndpointConfig.md b/azurermps-6.13.0/AzureRM.TrafficManager/Remove-AzureRmTrafficManagerEndpointConfig.md deleted file mode 100644 index 385685ceea..0000000000 --- a/azurermps-6.13.0/AzureRM.TrafficManager/Remove-AzureRmTrafficManagerEndpointConfig.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.TrafficManager.dll-Help.xml -Module Name: AzureRM.TrafficManager -ms.assetid: 8E12A392-A100-4814-9003-B2999150DCE1 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/remove-azurermtrafficmanagerendpointconfig -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Remove-AzureRmTrafficManagerEndpointConfig.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Remove-AzureRmTrafficManagerEndpointConfig.md ---- - -# Remove-AzureRmTrafficManagerEndpointConfig - -## SYNOPSIS -Removes an endpoint from a local Traffic Manager profile object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmTrafficManagerEndpointConfig -EndpointName <String> - -TrafficManagerProfile <TrafficManagerProfile> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmTrafficManagerEndpointConfig** cmdlet removes an endpoint from a local Azure Traffic Manager profile object. -You can get a profile by using the Get-AzureRmTrafficManagerProfile cmdlet. - -This cmdlet operates on the local profile object. -Commit your changes to the profile for Traffic Manager by using the Set-AzureRmTrafficManagerProfile cmdlet. -To remove an endpoint and commit changes in a single operation, use the Remove-AzureRmTrafficManagerEndpoint cmdlet. - -## EXAMPLES - -### Example 1: Remove an endpoint -``` -PS C:\>$TrafficManagerProfile = Get-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" -PS C:\> Remove-AzureRmTrafficManagerEndpointConfig -EndpointName "contoso" -TrafficManagerProfile $TrafficManagerProfile -PS C:\> Set-AzureRmTrafficManagerProfile -TrafficManagerProfile $TrafficManagerProfile -``` - -The first command gets an Azure Traffic Manager profile by using the **Get-AzureRmTrafficManagerProfile** cmdlet. -The command stores the local profile in the $TrafficManagerProfile variable. - -The second command removes an Azure endpoint named contoso from the profile stored in $TrafficManagerProfile. -This command changes only the local object. - -The final command updates the Traffic Manager profile named ContosoProfile to match the local value in $TrafficManagerProfile. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndpointName -Specifies the name of the Traffic Manager endpoint that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrafficManagerProfile -Specifies a local **TrafficManagerProfile** object. -This cmdlet modifies this local object. -To obtain a **TrafficManagerProfile** object, use the Get-AzureRmTrafficManagerProfile cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.TrafficManagerProfile -This cmdlet accepts a **TrafficManagerProfile** object to this cmdlet. - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.TrafficManagerProfile -This cmdlet returns a modified TrafficManagerProfile object. - -## NOTES - -## RELATED LINKS - -[Add-AzureRmTrafficManagerEndpointConfig](./Add-AzureRmTrafficManagerEndpointConfig.md) - -[Get-AzureRmTrafficManagerProfile](./Get-AzureRmTrafficManagerProfile.md) - -[Remove-AzureRmTrafficManagerEndpoint](./Remove-AzureRmTrafficManagerEndpoint.md) - -[Set-AzureRmTrafficManagerProfile](./Set-AzureRmTrafficManagerProfile.md) - - diff --git a/azurermps-6.13.0/AzureRM.TrafficManager/Remove-AzureRmTrafficManagerExpectedStatusCodeRange.md b/azurermps-6.13.0/AzureRM.TrafficManager/Remove-AzureRmTrafficManagerExpectedStatusCodeRange.md deleted file mode 100644 index d7f30d88bd..0000000000 --- a/azurermps-6.13.0/AzureRM.TrafficManager/Remove-AzureRmTrafficManagerExpectedStatusCodeRange.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.TrafficManager.dll-Help.xml -Module Name: AzureRM.TrafficManager -ms.assetid: 25E3F297-1D91-4102-B4D3-1E7195A5D344 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/remove-azurermtrafficmanagerexpectedstatuscoderange -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Remove-AzureRmTrafficManagerExpectedStatusCodeRange.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Remove-AzureRmTrafficManagerExpectedStatusCodeRange.md ---- - -# Remove-AzureRmTrafficManagerExpectedStatusCodeRange - -## SYNOPSIS -Removes an expected status code range from a local Traffic Manager profile object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmTrafficManagerExpectedStatusCodeRange -Min <Int32> -TrafficManagerProfile <TrafficManagerProfile> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmTrafficManagerExpectedStatusCodeRange** cmdlet removes a range of expected status codes from a local Azure Traffic Manager profile object. -You can get a profile by using the New-AzureRmTrafficManagerProfile or Get-AzureRmTrafficManagerProfile cmdlets. - -This cmdlet operates on the local profile object. -Commit your changes to the profile for Traffic Manager by using the Set-AzureRmTrafficManagerProfile cmdlet. - -## EXAMPLES - -### Example 1: Remove an expected status code range from a profile -``` -PS C:\> $TrafficManagerProfile = Get-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" -PS C:\> Remove-AzureRmTrafficManagerExpectedStatusCodeRange -TrafficManagerProfile $TrafficManagerProfile -Min 200 -PS C:\> Set-AzureRmTrafficManagerProfile -TrafficManagerProfile $TrafficManagerProfile -``` - -The first command gets an Azure Traffic Manager profile by using the **Get-AzureRmTrafficManagerProfile** cmdlet. -The second command removes an expected status code range from the profile stored in $TrafficManagerProfile. -The final command updates the profile in Traffic Manager to match the local value in $TrafficManagerProfile. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Min -Specifies the lowest value in the status code range to be removed. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrafficManagerProfile -Specifies a local **TrafficManagerProfile** object. -This cmdlet modifies this local object. -To obtain a **TrafficManagerProfile** object, use the Get-AzureRmTrafficManagerProfile cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.TrafficManagerProfile -This cmdlet accepts a **TrafficManagerProfile** object to this cmdlet. - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.TrafficManagerProfile -This cmdlet returns a modified **TrafficManagerProfile** object. - -## NOTES - -## RELATED LINKS - -[Add-AzureRmTrafficManagerExpectedStatusCodeRange](./Add-AzureRmTrafficManagerExpectedStatusCodeRange.md) - -[Get-AzureRmTrafficManagerProfile](./Get-AzureRmTrafficManagerProfile.md) - -[Set-AzureRmTrafficManagerProfile](./Set-AzureRmTrafficManagerProfile.md) diff --git a/azurermps-6.13.0/AzureRM.TrafficManager/Remove-AzureRmTrafficManagerIpAddressRange.md b/azurermps-6.13.0/AzureRM.TrafficManager/Remove-AzureRmTrafficManagerIpAddressRange.md deleted file mode 100644 index 246cd016b2..0000000000 --- a/azurermps-6.13.0/AzureRM.TrafficManager/Remove-AzureRmTrafficManagerIpAddressRange.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.TrafficManager.dll-Help.xml -Module Name: AzureRM.TrafficManager -ms.assetid: 25E3F297-1D91-4102-B4D3-1E7195A5D345 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/remove-azurermtrafficmanagerIpAddressRange -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Remove-AzureRmTrafficManagerIpAddressRange.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Remove-AzureRmTrafficManagerIpAddressRange.md ---- - -# Remove-AzureRmTrafficManagerIpAddressRange - -## SYNOPSIS -Removes an address range or subnet from a local Traffic Manager endpoint object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmTrafficManagerIpAddressRange -First <String> -TrafficManagerEndpoint <TrafficManagerEndpoint> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmTrafficManagerIpAddressRange** cmdlet removes an IP address range from a local Azure Traffic Manager endpoint object. -You can get an endpoint by using the New-AzureRmTrafficManagerEndpoint or Get-AzureRmTrafficManagerEndpoint cmdlets. - -This cmdlet operates on the local endpoint object. -Commit your changes to the endpoint for Traffic Manager by using the Set-AzureRmTrafficManagerEndpoint cmdlet. - -## EXAMPLES - -### Example 1: Remove IP address ranges from an endpoint -``` -PS C:\> $TrafficManagerEndpoint = Get-AzureRmTrafficManagerEndpoint -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" -Type AzureEndpoints -PS C:\> Remove-AzureRmTrafficManagerIpAddressRange -TrafficManagerEndpoint $TrafficManagerEndpoint -First "1.2.3.4" -PS C:\> Set-AzureRmTrafficManagerEndpoint -TrafficManagerEndpoint $TrafficManagerEndpoint -``` - -The first command gets the Azure endpoint named contoso from the profile named ContosoProfile in the resource group named ResourceGroup11, and then stores that object in the $TrafficManagerEndpoint variable. -The second command removes an IP address range from the endpoint stored in $TrafficManagerEndpoint. -The final command updates the endpoint in Traffic Manager to match the local value in $TrafficManagerEndpoint. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrafficManagerEndpoint -Specifies a local **TrafficManagerEndpoint** object. -This cmdlet modifies this local object. -To obtain a **TrafficManagerEndpoint** object, use the Get-AzureRmTrafficManagerEndpoint or New-AzureRmTrafficManagerEndpoint cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -First -Specifies the first IP address in the range to be removed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.TrafficManagerEndpoint -This cmdlet accepts a **TrafficManagerEndpoint** object to this cmdlet. - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.TrafficManagerEndpoint -This cmdlet returns a modified TrafficManagerEndpoint object. - -## NOTES - -## RELATED LINKS - -[Add-AzureRmTrafficManagerIpAddressRange](./Add-AzureRmTrafficManagerIpAddressRange.md) - -[Get-AzureRmTrafficManagerProfile](./Get-AzureRmTrafficManagerEndpoint.md) - -[New-AzureRmTrafficManagerEndpoint](./New-AzureRmTrafficManagerEndpoint.md) - -[Set-AzureRmTrafficManagerEndpoint](./Set-AzureRmTrafficManagerEndpoint.md) diff --git a/azurermps-6.13.0/AzureRM.TrafficManager/Remove-AzureRmTrafficManagerProfile.md b/azurermps-6.13.0/AzureRM.TrafficManager/Remove-AzureRmTrafficManagerProfile.md deleted file mode 100644 index 6559e86242..0000000000 --- a/azurermps-6.13.0/AzureRM.TrafficManager/Remove-AzureRmTrafficManagerProfile.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.TrafficManager.dll-Help.xml -Module Name: AzureRM.TrafficManager -ms.assetid: 5A4D685F-B904-4C85-8B68-C9936B0627FA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/remove-azurermtrafficmanagerprofile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Remove-AzureRmTrafficManagerProfile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Remove-AzureRmTrafficManagerProfile.md ---- - -# Remove-AzureRmTrafficManagerProfile - -## SYNOPSIS -Deletes a Traffic Manager profile. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Fields -``` -Remove-AzureRmTrafficManagerProfile -Name <String> -ResourceGroupName <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Object -``` -Remove-AzureRmTrafficManagerProfile -TrafficManagerProfile <TrafficManagerProfile> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmTrafficManagerProfile** cmdlet deletes an Azure Traffic Manager profile. -Specify the profile to delete by using the *Name* and *ResourceGroupName* parameters. -Alternatively, you can specify a **TrafficManagerProfile** object using the *TrafficManagerProfile* parameter, or you can use the pipeline. - -## EXAMPLES - -### Example 1: Delete a profile specified by name -``` -PS C:\>Remove-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" -``` - -This command deletes the profile named ContosoProfile in ResourceGroup11. -The command prompts you for confirmation. - -### Example 2: Delete a profile by using the pipeline -``` -PS C:\>Get-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" | Remove-AzureRmTrafficManagerProfile -Force -``` - -This command gets the profile named ContosoProfile in ResourceGroup11. -The command then passes that profile to the **Remove-AzureRmTrafficManagerProfile** cmdlet by using the pipeline operator. -That cmdlet deletes that profile. -The command specifies the *Force* parameter. -Therefore, it does not prompt you for confirmation. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Traffic Manager profile that this cmdlet deletes. - -```yaml -Type: System.String -Parameter Sets: Fields -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. -This cmdlet deletes a Traffic Manager profile in the group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: Fields -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrafficManagerProfile -Specifies a **TrafficManagerProfile** object to delete. -To obtain a **TrafficManagerProfile** object, use the Get-AzureRmTrafficManagerProfile cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile -Parameter Sets: Object -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.TrafficManagerProfile -This cmdlet accepts a **TrafficManagerProfile** object. - -## OUTPUTS - -### Boolean -This cmdlet returns a value of $True, if it succeeds or, if the deletion fails, a value of $False. - -## NOTES - -## RELATED LINKS - -[Disable-AzureRmTrafficManagerProfile](./Disable-AzureRmTrafficManagerProfile.md) - -[Enable-AzureRmTrafficManagerProfile](./Enable-AzureRmTrafficManagerProfile.md) - -[Get-AzureRmTrafficManagerProfile](./Get-AzureRmTrafficManagerProfile.md) - -[New-AzureRmTrafficManagerProfile](./New-AzureRmTrafficManagerProfile.md) - -[Set-AzureRmTrafficManagerProfile](./Set-AzureRmTrafficManagerProfile.md) - - diff --git a/azurermps-6.13.0/AzureRM.TrafficManager/Set-AzureRmTrafficManagerEndpoint.md b/azurermps-6.13.0/AzureRM.TrafficManager/Set-AzureRmTrafficManagerEndpoint.md deleted file mode 100644 index c03b756429..0000000000 --- a/azurermps-6.13.0/AzureRM.TrafficManager/Set-AzureRmTrafficManagerEndpoint.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.TrafficManager.dll-Help.xml -Module Name: AzureRM.TrafficManager -ms.assetid: 5287D4DB-2709-4A3C-97D5-DB494CEEFD18 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/set-azurermtrafficmanagerendpoint -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Set-AzureRmTrafficManagerEndpoint.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Set-AzureRmTrafficManagerEndpoint.md ---- - -# Set-AzureRmTrafficManagerEndpoint - -## SYNOPSIS -Updates a Traffic Manager endpoint. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmTrafficManagerEndpoint -TrafficManagerEndpoint <TrafficManagerEndpoint> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmTrafficManagerEndpoint** cmdlet updates an endpoint in Azure Traffic Manager. -This cmdlet updates the settings from a local endpoint object. -You can specify the endpoint object either by using the *TrafficManagerEndpoint* parameter or by using the pipeline. - -You can obtain a local object that represents an endpoint by using the Get-AzureRmTrafficManagerEndpoint cmdlet. -Modify the object locally and then use **Set-AzureRmTrafficManagerEndpoint** to commit your changes. - -## EXAMPLES - -### Example 1: Update an endpoint -``` -PS C:\>$TrafficManagerEndpoint = Get-AzureRmTrafficManagerEndpoint -Name "endpoint1" -Type AzureEndpoints -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" -PS C:\> $TrafficManagerEndpoint.Weight = 20 -PS C:\> Set-AzureRmTrafficManagerEndpoint -TrafficManagerEndpoint $TrafficManagerEndpoint -``` - -The first command gets an Azure Traffic Manager endpoint by using the **Get-AzureRmTrafficManagerEndpoint** cmdlet. -The command stores the endpoint locally in the $TrafficManagerEndpoint variable. - -The second command changes that endpoint locally. -This command changes the endpoint weight to 20. - -The third command updates the endpoint in Traffic Manager to match the local value in $TrafficManagerEndpoint. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrafficManagerEndpoint -Specifies a local **TrafficManagerEndpoint** object. -This cmdlet updates Traffic Manager to match this local object. - -```yaml -Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.TrafficManagerEndpoint -This cmdlet accepts a **TrafficManagerEndpoint** object. - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.TrafficManagerEndpoint -This cmdlet returns a **TrafficManagerEndpoint** object. - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.TrafficManager/Set-AzureRmTrafficManagerProfile.md b/azurermps-6.13.0/AzureRM.TrafficManager/Set-AzureRmTrafficManagerProfile.md deleted file mode 100644 index 5c5a78512b..0000000000 --- a/azurermps-6.13.0/AzureRM.TrafficManager/Set-AzureRmTrafficManagerProfile.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.TrafficManager.dll-Help.xml -Module Name: AzureRM.TrafficManager -ms.assetid: 975DD42E-61B6-437B-884D-C15A8DB7A667 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/set-azurermtrafficmanagerprofile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Set-AzureRmTrafficManagerProfile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Set-AzureRmTrafficManagerProfile.md ---- - -# Set-AzureRmTrafficManagerProfile - -## SYNOPSIS -Updates a Traffic Manager profile. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmTrafficManagerProfile -TrafficManagerProfile <TrafficManagerProfile> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmTrafficManagerProfile** cmdlet updates an Azure Traffic Manager profile. -This cmdlet updates the settings of the profile from a local profile object. -You can specify the profile object either by using the *TrafficManagerProfile* parameter or by using the pipeline. - -You can obtain a local object that represents a profile by using the Get-AzureRmTrafficManagerProfile cmdlet. -Modify the object locally and then use **Set-AzureRmTrafficManagerProfile** to commit your changes. - -## EXAMPLES - -### Example 1: Update a profile -``` -PS C:\>$TrafficManagerProfile = Get-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" -PS C:\> $TrafficManagerProfile.ProfileStatus = Disabled -PS C:\> Set-AzureRmTrafficManagerProfile -TrafficManagerProfile $TrafficManagerProfile -``` - -The first command gets an Azure Traffic Manager profile by using the Get-AzureRmTrafficManagerProfile cmdlet. -The command stores the profile locally in the $TrafficManagerProfile variable. - -The second command changes that profile locally. -This command disables the profile. - -The third command updates the Traffic Manager profile named ContosoProfile to match the local value in $TrafficManagerProfile. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrafficManagerProfile -Specifies a local **TrafficManagerProfile** object. -This cmdlet updates Traffic Manager to match this local object. - -```yaml -Type: Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.TrafficManagerProfile -This cmdlet accepts a **TrafficManagerProfile** object. - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.TrafficManagerProfile -This cmdlet returns a **TrafficManagerProfile** object. - -## NOTES - -## RELATED LINKS - -[Add-AzureRmTrafficManagerEndpointConfig](./Add-AzureRmTrafficManagerEndpointConfig.md) - -[Get-AzureRmTrafficManagerProfile](./Get-AzureRmTrafficManagerProfile.md) - -[New-AzureRmTrafficManagerProfile](./New-AzureRmTrafficManagerProfile.md) - -[Remove-AzureRmTrafficManagerEndpointConfig](./Remove-AzureRmTrafficManagerEndpointConfig.md) - -[Remove-AzureRmTrafficManagerProfile](./Remove-AzureRmTrafficManagerProfile.md) - - diff --git a/azurermps-6.13.0/AzureRM.UsageAggregates/AzureRM.UsageAggregates.md b/azurermps-6.13.0/AzureRM.UsageAggregates/AzureRM.UsageAggregates.md deleted file mode 100644 index 6e9ff05fba..0000000000 --- a/azurermps-6.13.0/AzureRM.UsageAggregates/AzureRM.UsageAggregates.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -Module Name: AzureRM.UsageAggregates -Module Guid: e43e47c8-8bff-4013-b003-ded1741f403a -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.usageaggregates -Help Version: 4.0.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/UsageAggregates/Commands.UsageAggregates/help/AzureRM.UsageAggregates.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/UsageAggregates/Commands.UsageAggregates/help/AzureRM.UsageAggregates.md ---- - -# AzureRM.UsageAggregates Module -## Description -This topic displays help topics for the Azure Usage Aggregate Cmdlets. - -## AzureRM.UsageAggregates Cmdlets -### [Get-UsageAggregates](Get-UsageAggregates.md) -Gets the reported Azure subscription usage details. - diff --git a/azurermps-6.13.0/AzureRM.UsageAggregates/Get-UsageAggregates.md b/azurermps-6.13.0/AzureRM.UsageAggregates/Get-UsageAggregates.md deleted file mode 100644 index 94bc881f23..0000000000 --- a/azurermps-6.13.0/AzureRM.UsageAggregates/Get-UsageAggregates.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.UsageAggregates.dll-Help.xml -Module Name: AzureRM.UsageAggregates -ms.assetid: 52B3ECCB-80E5-4E16-954A-B83D0BDC7E22 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.usageaggregates/get-usageaggregates -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/UsageAggregates/Commands.UsageAggregates/help/Get-UsageAggregates.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/UsageAggregates/Commands.UsageAggregates/help/Get-UsageAggregates.md ---- - -# Get-UsageAggregates - -## SYNOPSIS -Gets the reported Azure subscription usage details. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-UsageAggregates -ReportedStartTime <DateTime> -ReportedEndTime <DateTime> - [-AggregationGranularity <AggregationGranularity>] [-ShowDetails <Boolean>] [-ContinuationToken <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-UsageAggregates** cmdlet gets aggregated Azure subscription usage data by the following properties: -- Start and end times of when the usage was reported. -- Aggregation precision, either daily or hourly. -- Instance level detail for multiple instances of the same resource. -For consistent results, the returned data is based on when the usage details were reported by the Azure resource. -For more information, see Azure Billing REST API Referencehttps://msdn.microsoft.com/library/azure/1ea5b323-54bb-423d-916f-190de96c6a3c (https://msdn.microsoft.com/library/azure/1ea5b323-54bb-423d-916f-190de96c6a3c) in the Microsoft Developer Network library. - -## EXAMPLES - -### Example 1: Retrieve subscription data -``` -PS C:\>Get-UsageAggregates -ReportedStartTime "5/2/2015" -ReportedEndTime "5/5/2015" -``` - -This command retrieves the reported usage data for the subscription between 5/2/2015 and 5/5/2015. - -## PARAMETERS - -### -AggregationGranularity -Specifies the aggregation precision of the data. -Valid values are: Daily and Hourly. -The default value is Daily. - -```yaml -Type: Microsoft.Azure.Commerce.UsageAggregates.Models.AggregationGranularity -Parameter Sets: (All) -Aliases: -Accepted values: Daily, Hourly - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContinuationToken -Specifies the continuation token that was retrieved from the response body in the previous call. -For a large result set, responses are paged by using continuation tokens. -The continuation token serves as a bookmark for progress. -If you do not specify this parameter, the data is retrieved from the beginning of the day or hour specified in *ReportedStartTime*. -We recommend that you follow the next link in the response to page though the data. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportedEndTime -Specifies the reported end time for when resource usage was recorded in the Azure billing system. -Azure is a distributed system, spanning multiple datacenters around the world, so there is a delay between when the resource was actually consumed, which is the resource usage time, and when the usage event reached the billing system, which is the resource usage reported time. -In order to get all usage events for a subscription that are reported for a time period, you query by reported time. -Even though you query by reported time, the cmdlet aggregates the response data by the resource usage time. -The resource usage data is the useful pivot for analyzing the data. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportedStartTime -Specifies the reported start time for when resource usage was recorded in the Azure billing system. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowDetails -Indicates whether this cmdlet returns instance-level details with the usage data. -The default value is $True. -If $False, the service aggregates the results on the server side, and therefore returns fewer aggregate groups. -For example, if you are running three websites, by default you will get three line items for website consumption. -However, when the value is $False, all the data for the same **subscriptionId**, **meterId**, **usageStartTime**, and **usageEndTime** is collapsed into a single line item. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commerce.UsageAggregates.Models.UsageAggregationGetResponse - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Websites/AzureRM.Websites.md b/azurermps-6.13.0/AzureRM.Websites/AzureRM.Websites.md deleted file mode 100644 index 4e32a977e9..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/AzureRM.Websites.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -Module Name: AzureRM.Websites -Module Guid: cc69c625-e961-43f4-8b50-0061eba6e4b6 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites -Help Version: 1.0.0.0 -Locale: en-US -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/AzureRM.Websites.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/AzureRM.Websites.md ---- - -# AzureRM.Websites Module -## Description -ARM (Azure Resource Manager) Web App and App Service Plan commands. - -## AzureRM.Websites Cmdlets -### [Edit-AzureRmWebAppBackupConfiguration](Edit-AzureRmWebAppBackupConfiguration.md) -Modifies an Azure Web App backup schedule. - -### [Enter-AzureRmWebAppContainerPSSession](Enter-AzureRmWebAppContainerPSSession.md) -Opens a remote PowerShell session into the windows container specified in a given site or slot and given resource group. - -### [Get-AzureRmAppServicePlan](Get-AzureRmAppServicePlan.md) -Gets an Azure App Service plan in the specified resource group. - -### [Get-AzureRmAppServicePlanMetrics](Get-AzureRmAppServicePlanMetrics.md) -Gets usage metrics for an Azure Web App. - -### [Get-AzureRmWebApp](Get-AzureRmWebApp.md) -Gets Azure Web Apps in the specified resource group. - -### [Get-AzureRmDeletedWebApp](Get-AzureRmDeletedWebApp.md) -Gets deleted web apps in the subscription. - -### [Get-AzureRmWebAppBackup](Get-AzureRmWebAppBackup.md) -Gets an Azure Web App backup. - -### [Get-AzureRmWebAppBackupConfiguration](Get-AzureRmWebAppBackupConfiguration.md) -Gets an Azure Web App backup schedule. - -### [Get-AzureRmWebAppBackupList](Get-AzureRmWebAppBackupList.md) -Gets all backups of an Azure Web App. - -### [Get-AzureRmWebAppCertificate](Get-AzureRmWebAppCertificate.md) -Gets an Azure Web App certificate. - -### [Get-AzureRmWebAppContainerContinuousDeploymentUrl](Get-AzureRmWebAppContainerContinuousDeploymentUrl.md) -Gets the continuous deployment url for a container web app - -### [Get-AzureRmWebAppMetrics](Get-AzureRmWebAppMetrics.md) -Gets Azure Web App metrics. - -### [Get-AzureRmWebAppPublishingProfile](Get-AzureRmWebAppPublishingProfile.md) -Gets an Azure Web App publishing profile. - -### [Get-AzureRmWebAppSlot](Get-AzureRmWebAppSlot.md) -Gets an Azure Web App slot. - -### [Get-AzureRmWebAppSlotConfigName](Get-AzureRmWebAppSlotConfigName.md) -Get the list of Web App Slot Config names - -### [Get-AzureRmWebAppSlotMetrics](Get-AzureRmWebAppSlotMetrics.md) -Gets metrics for an Azure Web App slot. - -### [Get-AzureRmWebAppSlotPublishingProfile](Get-AzureRmWebAppSlotPublishingProfile.md) -Gets an Azure Web App slot publishing profile. - -### [Get-AzureRmWebAppSnapshot](Get-AzureRmWebAppSnapshot.md) -Gets the snapshots available for a web app. - -### [Get-AzureRmWebAppSSLBinding](Get-AzureRmWebAppSSLBinding.md) -Gets an Azure Web App certificate SSL binding. - -### [New-AzureRmAppServicePlan](New-AzureRmAppServicePlan.md) -Creates an Azure App Service plan in a given Geo location. - -### [New-AzureRmWebApp](New-AzureRmWebApp.md) -Creates an Azure Web App. - -### [New-AzureRmWebAppBackup](New-AzureRmWebAppBackup.md) -Creates an Azure Web App backup. - -### [New-AzureRmWebAppContainerPSSession](New-AzureRmWebAppContainerPSSession.md) -New-AzureRmWebAppContainerPSSession will create new remote PowerShell Session into the windows container specified in a given site or slot and given resource group. - -### [New-AzureRmWebAppDatabaseBackupSetting](New-AzureRmWebAppDatabaseBackupSetting.md) -Creates an Azure Web App database backup setting to be used with New-AzureRmWebAppBackup. - -### [New-AzureRmWebAppSlot](New-AzureRmWebAppSlot.md) -Creates an Azure Web App slot. - -### [New-AzureRmWebAppSSLBinding](New-AzureRmWebAppSSLBinding.md) -Creates an SSL certificate binding for an Azure Web App. - -### [Remove-AzureRmAppServicePlan](Remove-AzureRmAppServicePlan.md) -Removes an Azure App Service plan. - -### [Remove-AzureRmWebApp](Remove-AzureRmWebApp.md) -Removes an Azure Web App. - -### [Remove-AzureRmWebAppBackup](Remove-AzureRmWebAppBackup.md) -Removes an Azure Web App backup. - -### [Remove-AzureRmWebAppSlot](Remove-AzureRmWebAppSlot.md) -Removes an Azure Web App slot. - -### [Remove-AzureRmWebAppSSLBinding](Remove-AzureRmWebAppSSLBinding.md) -Removes an SSL binding from an uploaded certificate. - -### [Reset-AzureRmWebAppPublishingProfile](Reset-AzureRmWebAppPublishingProfile.md) -Resets the publishing credentials of an Azure Web App. - -### [Reset-AzureRmWebAppSlotPublishingProfile](Reset-AzureRmWebAppSlotPublishingProfile.md) -Resets the publishing credentials of an Azure Web App slot. - -### [Restart-AzureRmWebApp](Restart-AzureRmWebApp.md) -Restarts an Azure Web App. - -### [Restart-AzureRmWebAppSlot](Restart-AzureRmWebAppSlot.md) -Restarts an Azure Web App slot. - -### [Restore-AzureRmWebAppBackup](Restore-AzureRmWebAppBackup.md) -Restores an Azure Web App from a backup. - -### [Restore-AzureRmDeletedWebApp](Restore-AzureRmDeletedWebApp.md) -Restores a deleted web app to a new or existing web app. - -### [Restore-AzureRmWebAppSnapshot](Restore-AzureRmWebAppSnapshot.md) -Restores a web app snapshot. - -### [Set-AzureRmAppServicePlan](Set-AzureRmAppServicePlan.md) -Sets an Azure App Service plan. - -### [Set-AzureRmWebApp](Set-AzureRmWebApp.md) -Modifies an Azure Web App. - -### [Set-AzureRmWebAppSlot](Set-AzureRmWebAppSlot.md) -Modifies an Azure Web App slot. - -### [Set-AzureRmWebAppSlotConfigName](Set-AzureRmWebAppSlotConfigName.md) -Set Web App Slot Config names - -### [Start-AzureRmWebApp](Start-AzureRmWebApp.md) -Starts an Azure Web App. - -### [Start-AzureRmWebAppSlot](Start-AzureRmWebAppSlot.md) -Starts an Azure Web App slot. - -### [Stop-AzureRmWebApp](Stop-AzureRmWebApp.md) -Stops an Azure Web App. - -### [Stop-AzureRmWebAppSlot](Stop-AzureRmWebAppSlot.md) -Stops an Azure Web App slot. - -### [Switch-AzureRmWebAppSlot](Switch-AzureRmWebAppSlot.md) -Swap two slots with a Web App - diff --git a/azurermps-6.13.0/AzureRM.Websites/Edit-AzureRmWebAppBackupConfiguration.md b/azurermps-6.13.0/AzureRM.Websites/Edit-AzureRmWebAppBackupConfiguration.md deleted file mode 100644 index cba50b74fc..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Edit-AzureRmWebAppBackupConfiguration.md +++ /dev/null @@ -1,250 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: BFC38930-DBB4-4EBB-8E29-73B901FAF486 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/edit-azurermwebappbackupconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Edit-AzureRmWebAppBackupConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Edit-AzureRmWebAppBackupConfiguration.md ---- - -# Edit-AzureRmWebAppBackupConfiguration - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### FromResourceName -``` -Edit-AzureRmWebAppBackupConfiguration [-FrequencyInterval] <Int32> [-FrequencyUnit] <String> - [-RetentionPeriodInDays] <Int32> [[-StartTime] <DateTime>] [-KeepAtLeastOneBackup] - [-ResourceGroupName] <String> [-Name] <String> [[-Slot] <String>] [-DefaultProfile <IAzureContextContainer>] - [-StorageAccountUrl] <String> [[-Databases] <DatabaseBackupSetting[]>] [<CommonParameters>] -``` - -### FromWebApp -``` -Edit-AzureRmWebAppBackupConfiguration [-FrequencyInterval] <Int32> [-FrequencyUnit] <String> - [-RetentionPeriodInDays] <Int32> [[-StartTime] <DateTime>] [-KeepAtLeastOneBackup] [-WebApp] <PSSite> - [-DefaultProfile <IAzureContextContainer>] [-StorageAccountUrl] <String> - [[-Databases] <DatabaseBackupSetting[]>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Edit-AzureRmWebAppBackupConfiguration** cmdlet edits the current configuration backup for an Azure Web App. - -## EXAMPLES - -## PARAMETERS - -### -Databases -Databases of type DatabaseBackupSetting[] - -```yaml -Type: Microsoft.Azure.Management.WebSites.Models.DatabaseBackupSetting[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrequencyInterval -Frequency Interval - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FrequencyUnit -Frequency Unit - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeepAtLeastOneBackup -Keep At Least One Backup Option - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 9 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: System.String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RetentionPeriodInDays -Retention Period In Days - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Slot -WebApp Slot Name - -```yaml -Type: System.String -Parameter Sets: FromResourceName -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartTime -StartTime in UTC - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountUrl -Storage Account Url - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: FromWebApp -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Int32 - -### System.String - -### System.DateTime - -### System.Management.Automation.SwitchParameter - -### Microsoft.Azure.Management.WebSites.Models.Site -Parameters: WebApp (ByValue) - -### Microsoft.Azure.Management.WebSites.Models.DatabaseBackupSetting[] - -## OUTPUTS - -### Microsoft.Azure.Commands.WebApps.Cmdlets.WebApps.AzureWebAppBackupConfiguration - -## NOTES - -## RELATED LINKS - -[Get-AzureRmWebAppBackupConfiguration](./Get-AzureRmWebAppBackupConfiguration.md) - - diff --git a/azurermps-6.13.0/AzureRM.Websites/Enter-AzureRmWebAppContainerPSSession.md b/azurermps-6.13.0/AzureRM.Websites/Enter-AzureRmWebAppContainerPSSession.md deleted file mode 100644 index dec91ec690..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Enter-AzureRmWebAppContainerPSSession.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/?view=azurermps-6.8.1 -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Enter-AzureRmWebAppContainerPSSession.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Enter-AzureRmWebAppContainerPSSession.md ---- - -# Enter-AzureRmWebAppContainerPSSession - -## SYNOPSIS -Opens a remote PowerShell session into the windows container specified in a given site or slot and given resource group - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 (Default) -``` -Enter-AzureRmWebAppContainerPSSession [-PassThru] [-Force] [[-SlotName] <String>] [-ResourceGroupName] <String> - [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### S2 -``` -Enter-AzureRmWebAppContainerPSSession [-PassThru] [-Force] [-WebApp] <PSSite> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -opens a remote PowerShell session into the windows container specified in a given site or slot and given resource group - -## EXAMPLES - -### Example 1 -``` -PS C:\> Enter-AzureRmWebAppContainerPSSession -ResourceGroupName "Default-Web-WestUS" -Name "ContosoASP" -``` - -This command opens a remote PowerShell session into the windows container app ContosoASP - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Create the PowerShell session without prompting for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the web app. - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Return a value indicating success or failure - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SlotName -The name of the web app slot. - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WebApp -The web app object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -### Microsoft.Azure.Commands.WebApps.Models.PSSite -## OUTPUTS - -### System.String -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmAppServicePlan.md b/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmAppServicePlan.md deleted file mode 100644 index 20ea69605c..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmAppServicePlan.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: 89ED4231-7616-47D0-BDAA-D849C245DC79 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/get-azurermappserviceplan -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Get-AzureRmAppServicePlan.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Get-AzureRmAppServicePlan.md ---- - -# Get-AzureRmAppServicePlan - -## SYNOPSIS -Gets an Azure App Service plan in the specified resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Get-AzureRmAppServicePlan [[-ResourceGroupName] <String>] [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -Get-AzureRmAppServicePlan [-Location] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmAppServicePlan** cmdlet gets an Azure App Service plan in the specified resource group. - -## EXAMPLES - -### Example 1: Get an App Service plan from a resource group -``` -PS C:\>Get-AzureRmAppServicePlan -ResourceGroupName "Default-Web-WestUS" -Name "ContosoASP" -``` - -This command gets the App Service plan named ContosoASP that belongs to the resource group named Default-Web-WestUS. - -### Example 2: Get all App Service plans in a location -``` -PS C:\>Get-AzureRmAppServicePlan -Location "West US" -``` - -This command gets all App Service plans located in the "West US" region. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Location - -```yaml -Type: System.String -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -App Service Plan Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Management.WebSites.Models.AppServicePlan - -## NOTES - -## RELATED LINKS - -[New-AzureRmAppServicePlan](./New-AzureRmAppServicePlan.md) - -[Remove-AzureRmAppServicePlan](./Remove-AzureRmAppServicePlan.md) - -[Set-AzureRmAppServicePlan](./Set-AzureRmAppServicePlan.md) - - diff --git a/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmAppServicePlanMetrics.md b/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmAppServicePlanMetrics.md deleted file mode 100644 index 6d7e1fd172..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmAppServicePlanMetrics.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: 0AC0C4F9-4138-49EA-88CB-DC220DE7E9F4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/get-azurermappserviceplanmetrics -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Get-AzureRmAppServicePlanMetrics.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Get-AzureRmAppServicePlanMetrics.md ---- - -# Get-AzureRmAppServicePlanMetrics - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Get-AzureRmAppServicePlanMetrics [-Metrics] <String[]> [-StartTime] <DateTime> [[-EndTime] <DateTime>] - [-Granularity] <String> [-InstanceDetails] [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -Get-AzureRmAppServicePlanMetrics [-Metrics] <String[]> [-StartTime] <DateTime> [[-EndTime] <DateTime>] - [-Granularity] <String> [-InstanceDetails] [-AppServicePlan] <PSAppServicePlan> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmAppServicePlanMetrics** gets App Service Plan metrics. - -## EXAMPLES - -### 1: -``` -PS C:\>Get-AzureRmAppServicePlanMetrics -ResourceGroupName "Default-Web-WestUS" -Name "ContosoAppServPlan" -StartTime 2016-11-30T22:00:00Z -EndTime 2016-11-30T22:30:00Z -Granularity PT1M -Metrics "CPU Percentage" -``` - -This command gets CPU percentage of the App Service Plan - per minute(PT1M - Poll Time 1 minute) between StartTime and EndTime - -## PARAMETERS - -### -AppServicePlan -App Service Plan Object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.WebApp.PSAppServicePlan -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndTime -End Time in UTC - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Granularity -Granularity - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: PT1M, PT1H, P1D - -Required: True -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceDetails -Instance Details - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Metrics -Metrics - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -App Service Plan Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Start Time in UTC - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.WebSites.Models.AppServicePlan -Parameters: AppServicePlan (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Management.WebSites.Models.ResourceMetric - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmDeletedWebApp.md b/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmDeletedWebApp.md deleted file mode 100644 index 87bd2deaa2..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmDeletedWebApp.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/get-azurermdeletedwebapp -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Get-AzureRmDeletedWebApp.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Get-AzureRmDeletedWebApp.md ---- - -# Get-AzureRmDeletedWebApp - -## SYNOPSIS -Gets deleted web apps in the subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmDeletedWebApp [[-ResourceGroupName] <String>] [[-Name] <String>] [[-Slot] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDeletedWebApp** cmdlet returns all deleted web apps in the subscription. Deleted apps can optionally be filtered by resource group, name, and slot. There can be more than one deleted app with the same name and resource group. Check the DeletionTime to distinguish deleted apps that share the same name. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmDeletedWebApp -ResourceGroupName "Default-Web-WestUS" -Name "ContosoSite" -``` - -This command gets the deleted apps named ContosoSite belonging to the resource group Default-Web-WestUS. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the web app. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Slot -The name of the web app slot. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.WebApps.Cmdlets.WebApps.PSAzureDeletedWebApp - -## NOTES - -## RELATED LINKS - -[Restore-AzureRmDeletedWebApp](./Restore-AzureRmDeletedWebApp.md) diff --git a/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebApp.md b/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebApp.md deleted file mode 100644 index 0d7fef0060..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebApp.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: A87ED954-9C09-4329-A005-ABFF36C45E6E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/get-azurermwebapp -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Get-AzureRmWebApp.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Get-AzureRmWebApp.md ---- - -# Get-AzureRmWebApp - -## SYNOPSIS -Gets Azure Web Apps in the specified resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Get-AzureRmWebApp [[-ResourceGroupName] <String>] [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### S2 -``` -Get-AzureRmWebApp [-AppServicePlan] <PSAppServicePlan> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### S3 -``` -Get-AzureRmWebApp [-Location] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmWebApp** cmdlet gets information about an Azure Web App. - -## EXAMPLES - -### Example 1: Get a Web App from a resource group -``` -PS C:\>Get-AzureRmWebApp -ResourceGroupName "Default-Web-WestUS" -Name "ContosoSite" -``` - -This command gets the Web App named ContosoSite that belongs to the resource group Default-Web-WestUS. - -## PARAMETERS - -### -AppServicePlan -App Service Plan object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.WebApp.PSAppServicePlan -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Location - -```yaml -Type: System.String -Parameter Sets: S3 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.WebSites.Models.Site - -## NOTES - -## RELATED LINKS - -[New-AzureRmWebApp](./New-AzureRmWebApp.md) - -[Remove-AzureRmWebApp](./Remove-AzureRmWebApp.md) - -[Restart-AzureRmWebApp](./Restart-AzureRmWebApp.md) - -[Start-AzureRmWebApp](./Start-AzureRmWebApp.md) - -[Stop-AzureRmWebApp](./Stop-AzureRmWebApp.md) - - diff --git a/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppBackup.md b/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppBackup.md deleted file mode 100644 index 5c5b2711bc..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppBackup.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: EAAF615B-6139-438B-A2FD-6966E72B3AA9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/get-azurermwebappbackup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Get-AzureRmWebAppBackup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Get-AzureRmWebAppBackup.md ---- - -# Get-AzureRmWebAppBackup - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### FromResourceName -``` -Get-AzureRmWebAppBackup [-BackupId] <String> [-ResourceGroupName] <String> [-Name] <String> [[-Slot] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### FromWebApp -``` -Get-AzureRmWebAppBackup [-BackupId] <String> [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmWebAppBackup** cmdlet gets the specified backup of an Azure Web App. - -## EXAMPLES - -### 1: -``` -PS C:\>Get-AzureRmWebAppBackup -ResourceGroupName "Default-Web-WestUS" -Name "WebAppStandard" -BackupId "12345" -``` - -This command gets the backup with ID "12345" from the Web App named WebAppStandard that belongs to the resource group Default-Web-WestUS. - -## PARAMETERS - -### -BackupId -Backup Id - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Webapp Name - -```yaml -Type: System.String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Slot -Slot Name - -```yaml -Type: System.String -Parameter Sets: FromResourceName -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WebApp -Piped WebApp - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: FromWebApp -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Management.WebSites.Models.Site -Parameters: WebApp (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.WebApps.Cmdlets.WebApps.AzureWebAppBackup - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppBackupConfiguration.md b/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppBackupConfiguration.md deleted file mode 100644 index 48cbb741b6..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppBackupConfiguration.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: 8337BEA9-4927-4718-83B9-F3F567BE0FBD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/get-azurermwebappbackupconfiguration -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Get-AzureRmWebAppBackupConfiguration.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Get-AzureRmWebAppBackupConfiguration.md ---- - -# Get-AzureRmWebAppBackupConfiguration - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### FromResourceName -``` -Get-AzureRmWebAppBackupConfiguration [-ResourceGroupName] <String> [-Name] <String> [[-Slot] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### FromWebApp -``` -Get-AzureRmWebAppBackupConfiguration [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmWebAppBackupConfiguration** cmdlet gets the backup configuration of an Azure Web App. - -## EXAMPLES - -### 1: -``` -PS C:\>Get-AzureRmWebAppBackupConfiguration -ResourceGroupName "Default-Web-WestUS" -Name "WebAppStandard" -``` - -This command gets the backup configuration from the Web App named WebAppStandard that belongs to the resource group Default-Web-WestUS. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: System.String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Slot -Slot Name - -```yaml -Type: System.String -Parameter Sets: FromResourceName -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WebApp -WebApp Name - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: FromWebApp -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Management.WebSites.Models.Site -Parameters: WebApp (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.WebApps.Cmdlets.WebApps.AzureWebAppBackupConfiguration - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppBackupList.md b/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppBackupList.md deleted file mode 100644 index 2980fa6e3e..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppBackupList.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: BBC85035-DCF7-44FA-A747-A1563A55B820 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/get-azurermwebappbackuplist -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Get-AzureRmWebAppBackupList.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Get-AzureRmWebAppBackupList.md ---- - -# Get-AzureRmWebAppBackupList - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### FromResourceName -``` -Get-AzureRmWebAppBackupList [-ResourceGroupName] <String> [-Name] <String> [[-Slot] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### FromWebApp -``` -Get-AzureRmWebAppBackupList [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmWebAppBackupList** cmdlet gets a list of backups for an Azure Web App. - -## EXAMPLES - -### 1: -``` -PS C:\>Get-AzureRmWebAppBackupList -ResourceGroupName "Default-Web-WestUS" -Name "WebAppStandard" -``` - -This command returns a backup list pertaining to WebApp WebAppStandard associated with the resource group ContosoResourceGroup. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: System.String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Slot -Slot name - -```yaml -Type: System.String -Parameter Sets: FromResourceName -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WebApp -Piped WebApp - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: FromWebApp -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Management.WebSites.Models.Site -Parameters: WebApp (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.WebApps.Cmdlets.WebApps.AzureWebAppBackup - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppCertificate.md b/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppCertificate.md deleted file mode 100644 index fd375cec14..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppCertificate.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: 2D83D38F-3A5C-40DB-BE8B-D52E5CAFCF6E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/get-azurermwebappcertificate -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Get-AzureRmWebAppCertificate.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Get-AzureRmWebAppCertificate.md ---- - -# Get-AzureRmWebAppCertificate - -## SYNOPSIS -Gets an Azure Web App certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmWebAppCertificate [[-ResourceGroupName] <String>] [[-Thumbprint] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmWebAppCertificate** cmdlet gets information about Azure Web App certificates associated with a specified resource group. -If you know the certificate thumbprint you can also use this cmdlet to get information about a specified certificate. - -## EXAMPLES - -### Example 1: Get Web App certificates in a resource group -``` -PS C:\>Get-AzureRmWebAppCertificate -ResourceGroupName "ContosoResourceGroup" -``` - -This command returns information about the uploaded Web App certificates associated with the resource group ContosoResourceGroup. - -### Example 2: Get a specified web app certificate -``` -PS C:\>Get-AzureRmWebAppCertificate -ResourceGroupName "ContosoResourceGroup" -Thumbprint "E3A38EBA60CAA1C162785A2E1C44A15AD450199C3" -``` - -This command gets the ContosoResourceGroup Web App certificate with the thumbprint E3A38EBA60CAA1C162785A2E1C44A15AD450199C3. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the certificate is assigned to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Thumbprint -Specifies the unique identifier for the certificate. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Management.WebSites.Models.Certificate - -## NOTES - -## RELATED LINKS - -[Get-AzureRmWebAppSSLBinding](./Get-AzureRmWebAppSSLBinding.md) - - diff --git a/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppContainerContinuousDeploymentUrl.md b/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppContainerContinuousDeploymentUrl.md deleted file mode 100644 index 618ee5283c..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppContainerContinuousDeploymentUrl.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/?view=azurermps-6.8.1 -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Get-AzureRmWebAppContainerContinuousDeploymentUrl.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Get-AzureRmWebAppContainerContinuousDeploymentUrl.md ---- - -# Get-AzureRmWebAppContainerContinuousDeploymentUrl - -## SYNOPSIS -Get-AzureRMWebAppContainerContinuousDeploymentUrl will return container continuous deployment url - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Get-AzureRmWebAppContainerContinuousDeploymentUrl [[-SlotName] <String>] [-ResourceGroupName] <String> - [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -Get-AzureRmWebAppContainerContinuousDeploymentUrl [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -Get-AzureRMWebAppContainerContinuousDeploymentUrl will return container continuous deployment url - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmWebAppContainerContinuousDeploymentUrl -ResourceGroupName "Default-Web-WestUS" -Name "ContosoASP" -``` - -This command will return container continuous deployment url. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the web app. - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SlotName -The name of the web app slot. - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WebApp -The web app object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -### Microsoft.Azure.Commands.WebApps.Models.PSSite -## OUTPUTS - -### System.String -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppMetrics.md b/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppMetrics.md deleted file mode 100644 index 6171112716..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppMetrics.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: 513BE097-EB4A-4C49-9F7F-42A2BED09022 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/get-azurermwebappmetrics -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Get-AzureRmWebAppMetrics.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Get-AzureRmWebAppMetrics.md ---- - -# Get-AzureRmWebAppMetrics - -## SYNOPSIS -Gets Azure Web App metrics. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Get-AzureRmWebAppMetrics [-Metrics] <String[]> [-StartTime] <DateTime> [[-EndTime] <DateTime>] - [-Granularity] <String> [-InstanceDetails] [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -Get-AzureRmWebAppMetrics [-Metrics] <String[]> [-StartTime] <DateTime> [[-EndTime] <DateTime>] - [-Granularity] <String> [-InstanceDetails] [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmWebAppMetrics** gets Web App metrics. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmAppServicePlanMetrics -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -StartTime 2016-11-30T22:00:00Z -EndTime 2016-11-30T22:30:00Z -Granularity PT1M -Metrics "Requests" -``` - -This command gets Requests of the Web App ContosoWebApp - per minute(PT1M - Poll Time 1 minute) between StartTime and EndTime - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndTime -End Time in UTC - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Granularity -Granularity - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: PT1M, PT1H, P1D - -Required: True -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceDetails -Instance Details - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Metrics -Metrics as a string array - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Start Time in UTC - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Management.WebSites.Models.Site -Parameters: WebApp (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Management.WebSites.Models.ResourceMetric - -## NOTES - -## RELATED LINKS - -[Get-AzureRmWebAppCertificate](./Get-AzureRmWebAppCertificate.md) - diff --git a/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppPublishingProfile.md b/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppPublishingProfile.md deleted file mode 100644 index fd6095af34..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppPublishingProfile.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: 38433470-CAFD-4B8F-980C-63D4B264B39F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/get-azurermwebapppublishingprofile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Get-AzureRmWebAppPublishingProfile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Get-AzureRmWebAppPublishingProfile.md ---- - -# Get-AzureRmWebAppPublishingProfile - -## SYNOPSIS -Gets an Azure Web App publishing profile. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Get-AzureRmWebAppPublishingProfile [[-OutputFile] <String>] [[-Format] <String>] [-IncludeDisasterRecoveryEndpoints] [-ResourceGroupName] <String> - [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -Get-AzureRmWebAppPublishingProfile [[-OutputFile] <String>] [[-Format] <String>] - [-IncludeDisasterRecoveryEndpoints] [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmWebAppPublishingProfile** cmdlet gets an Azure Web App publishing profile. - -## EXAMPLES - -### 1: -``` -PS C:\> Get-AzureRmWebAppPublishingProfile -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -Format "Ftp" -OutputFile "C:\Users\contoso\outputfile" -``` - -This command gets the publishing profile in Ftp format for Web App ContosoWebApp associated with the resource group Default-Web-WestUS - and stores it in the specified output file. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Format -Format - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: WebDeploy, FileZilla3, Ftp - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDisasterRecoveryEndpoints -Include the disaster recovery endpoints if true - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: None -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OutputFile -Output File - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IncludeDisasterRecoveryEndpoints -Include the disaster recovery endpoints if true - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: None -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Management.WebSites.Models.Site -Parameters: WebApp (ByValue) - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAppServicePlan](./Get-AzureRmAppServicePlan.md) - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) - - diff --git a/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppSSLBinding.md b/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppSSLBinding.md deleted file mode 100644 index 73d8985bda..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppSSLBinding.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: EE3D2BA0-32E7-4A37-BCAF-F0E8FAAC43CE -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/get-azurermwebappsslbinding -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Get-AzureRmWebAppSSLBinding.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Get-AzureRmWebAppSSLBinding.md ---- - -# Get-AzureRmWebAppSSLBinding - -## SYNOPSIS -Gets an Azure Web App certificate SSL binding. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Get-AzureRmWebAppSSLBinding [[-Name] <String>] [-ResourceGroupName] <String> [-WebAppName] <String> - [[-Slot] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -Get-AzureRmWebAppSSLBinding [[-Name] <String>] [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmWebAppSSLBinding** cmdlet gets a Secure Sockets Layer (SSL) binding for an Azure Web App. -SSL bindings are used to associate a Web App with an uploaded certificate. -Web Apps can be bound to multiple certificates. - -## EXAMPLES - -### Example 1: Get SSL bindings for a Web App -``` -PS C:\>Get-AzureRmWebAppSSLBinding -ResourceGroupName "ContosoResourceGroup" -WebAppName "ContosoWebApp" -``` - -This command retrieves the SSL bindings for the Web App ContosoWebApp, which is associated with the resource group ContosoResourceGroup. - -### Example 2: Use an object reference to get SSL bindings for a Web App -``` -PS C:\>$WebApp = Get-AzureRmWebApp -Name "ContosoWebApp" -PS C:\> Get-AzureRmWebAppSSLBinding -WebApp $WebApp -``` - -The commands in this example also get the SSL bindings for the Web App ContosoWebApp; in this case, however, an object reference is used instead of the Web App name and the name of the associated resource group. -This object reference is created by the first command in the example, which uses **Get-AzureRmWebApp** to create an object reference to the Web App named ContosoWebApp. -That object reference is stored in a variable named $WebApp. -This variable, and the **Get-AzureRmWebAppSSLBinding** cmdlet, are then used by the second command to get the SSL bindings. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the SSL binding. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the certificate is assigned to. -You cannot use the *ResourceGroupName* parameter and the *WebApp* parameter in the same command. - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Slot -Specifies a Web App deployment slot. -To get a deployment slot, use the Get-AzureRMWebAppSlot cmdlet. - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -Specifies a Web App. -To get a Web App, use the Get-AzureRmWebApp cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WebAppName -Specifies the name of the Web App that this cmdlet gets SSL bindings from. -You cannot use the *WebAppName* parameter and the *WebApp* parameter in the same command. - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.WebSites.Models.Site -Parameters: WebApp (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Management.WebSites.Models.HostNameSslState - -## NOTES - -## RELATED LINKS - -[New-AzureRmWebAppSSLBinding](./New-AzureRmWebAppSSLBinding.md) - -[Remove-AzureRmWebAppSSLBinding](./Remove-AzureRmWebAppSSLBinding.md) - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) - - diff --git a/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppSlot.md b/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppSlot.md deleted file mode 100644 index 6be471fab3..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppSlot.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: 100A5980-31E2-41F9-84D4-2F5F0CB78B8A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/get-azurermwebappslot -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Get-AzureRmWebAppSlot.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Get-AzureRmWebAppSlot.md ---- - -# Get-AzureRmWebAppSlot - -## SYNOPSIS -Gets an Azure Web App slot. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Get-AzureRmWebAppSlot [-ResourceGroupName] <String> [-Name] <String> [[-Slot] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -Get-AzureRmWebAppSlot [[-Slot] <String>] [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmWebAppSlot** cmdlet gets information about an Azure Web App Slot. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmWebAppSlot -ResourceGroupName "Default-Web-WestUS" -Name "WebAppStandard" -Slot "Slot001" -``` - -This command gets the slot named Slot001 from the Web App named WebAppStandard that belongs to the -resource group Default-Web-WestUS. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Slot -WebApp Slot Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Management.WebSites.Models.Site -Parameters: WebApp (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Management.WebSites.Models.Site - -## NOTES - -## RELATED LINKS - -[New-AzureRMWebAppSlot](./New-AzureRMWebAppSlot.md) - -[Remove-AzureRMWebAppSlot](./Remove-AzureRMWebAppSlot.md) - -[Restart-AzureRMWebAppSlot](./Restart-AzureRMWebAppSlot.md) - -[Set-AzureRMWebAppSlot](./Set-AzureRMWebAppSlot.md) - -[Start-AzureRMWebAppSlot](./Start-AzureRMWebAppSlot.md) - -[Stop-AzureRMWebAppSlot](./Stop-AzureRMWebAppSlot.md) - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) diff --git a/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppSlotConfigName.md b/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppSlotConfigName.md deleted file mode 100644 index 36e0912c4d..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppSlotConfigName.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: EF2D377C-C000-4BCA-8EB9-58C805FA5C31 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/get-azurermwebappslotconfigname -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Get-AzureRmWebAppSlotConfigName.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Get-AzureRmWebAppSlotConfigName.md ---- - -# Get-AzureRmWebAppSlotConfigName - -## SYNOPSIS -Get the list of Web App Slot Config names - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Get-AzureRmWebAppSlotConfigName [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -Get-AzureRmWebAppSlotConfigName [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmWebAppSlotConfigName** cmdlet retrieves the list of App Setting and Connection String names that are currently marked as slot settings - -## EXAMPLES - -### 1: -``` -PS C:\>Get-AzureRmWebAppSlotConfigName -ResourceGroupName "Default-Web-WestUS" -Name "ContosoSite" -``` - -This command gets App Settings and Connection strings pertaining to the Web App named ContosoSite associated with the resource group Default-Web-WestUS - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Management.WebSites.Models.Site -Parameters: WebApp (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Management.WebSites.Models.SlotConfigNamesResource - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppSlotMetrics.md b/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppSlotMetrics.md deleted file mode 100644 index d7616bbe8a..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppSlotMetrics.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: 3BCEADF3-15DC-4033-A94A-4C8B4F5E7340 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/get-azurermwebappslotmetrics -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Get-AzureRmWebAppSlotMetrics.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Get-AzureRmWebAppSlotMetrics.md ---- - -# Get-AzureRmWebAppSlotMetrics - -## SYNOPSIS -Gets metrics for an Azure Web App slot. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Get-AzureRmWebAppSlotMetrics [-Metrics] <String[]> [-StartTime] <DateTime> [[-EndTime] <DateTime>] - [-Granularity] <String> [-InstanceDetails] [-ResourceGroupName] <String> [-Name] <String> [-Slot] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -Get-AzureRmWebAppSlotMetrics [-Metrics] <String[]> [-StartTime] <DateTime> [[-EndTime] <DateTime>] - [-Granularity] <String> [-InstanceDetails] [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmWebAppSlotMetrics** gets Web App metrics for the specified slot. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmAppServicePlanMetrics -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -StartTime 2016-11-30T22:00:00Z -EndTime 2016-11-30T22:30:00Z -Granularity PT1M -Metrics ["Requests"] -``` - -This command gets Request of the specified Web App - per minute(PT1M - Poll Time 1 minute) between StartTime and EndTime - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndTime -End Time in UTC - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Granularity -Granularity - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceDetails -Instance Details - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Metrics -Metrics - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Slot -WebApp Slot Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Start Time in UTC - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Management.WebSites.Models.Site -Parameters: WebApp (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Management.WebSites.Models.ResourceMetric - -## NOTES - -## RELATED LINKS - -[Get-AzureRMAppServicePlanMetrics](./Get-AzureRmAppServicePlanMetrics.md) - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) - -[Get-AzureRMWebAppSlot](./Get-AzureRMWebAppSlot.md) diff --git a/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppSlotPublishingProfile.md b/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppSlotPublishingProfile.md deleted file mode 100644 index 29f2d91dad..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppSlotPublishingProfile.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: B2FDB54F-0318-4037-BC1D-6113E77DDE7E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/get-azurermwebappslotpublishingprofile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Get-AzureRmWebAppSlotPublishingProfile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Get-AzureRmWebAppSlotPublishingProfile.md ---- - -# Get-AzureRmWebAppSlotPublishingProfile - -## SYNOPSIS -Gets an Azure Web App slot publishing profile. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Get-AzureRmWebAppSlotPublishingProfile [[-OutputFile] <String>] [[-Format] <String>] [-IncludeDisasterRecoveryEndpoints] - [-ResourceGroupName] <String> [-Name] <String> [-Slot] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### S2 -``` -Get-AzureRmWebAppSlotPublishingProfile [[-OutputFile] <String>] [[-Format] <String>] - [-IncludeDisasterRecoveryEndpoints] [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmWebAppSlotPublishingProfile** cmdlet gets the Web App publishing profile for the specified slot. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmWebAppSlotPublishingProfile -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -Slot "slot001" -Format "Ftp" -OutputFile "C:\Users\contoso\outputfile" -``` - -This command gets the publishing profile in Ftp format for slot Slot001 pertaining to the Web App ContosoWebApp associated with the resource group Default-Web-WestUS - and stores it in the specified output file. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Format -Format - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: WebDeploy, FileZilla3, Ftp - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDisasterRecoveryEndpoints -Include the disaster recovery endpoints if true - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: None -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OutputFile -Output File - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Slot -WebApp Slot Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IncludeDisasterRecoveryEndpoints -Include the disaster recovery endpoints if true - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: None -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Management.WebSites.Models.Site -Parameters: WebApp (ByValue) - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Reset-AzureRMWebAppSlotPublishingProfile](./Reset-AzureRmWebAppSlotPublishingProfile.md) - -[Get-AzureRMWebAppSlot](./Get-AzureRMWebAppSlot.md) - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) diff --git a/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppSnapshot.md b/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppSnapshot.md deleted file mode 100644 index 58eb9af8fb..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Get-AzureRmWebAppSnapshot.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/get-azurermwebappsnapshot -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Get-AzureRmWebAppSnapshot.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Get-AzureRmWebAppSnapshot.md ---- - -# Get-AzureRmWebAppSnapshot - -## SYNOPSIS -Gets the snapshots available for a web app. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### FromResourceName -``` -Get-AzureRmWebAppSnapshot [-ResourceGroupName] <String> [-Name] <String> [[-Slot] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### FromWebApp -``` -Get-AzureRmWebAppSnapshot [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmWebAppSnapshot** cmdlet returns all snapshots for a web app. Snapshots are automatic backups of a web app's files and settings. A snapshot can be restored with the **Restore-AzureRmWebAppSnapshot** cmdlet. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmWebAppSnapshot -ResourceGroupName "Default-Web-WestUS" -Name "ContosoApp" -Slot "Staging" -``` - -Get the snapshots for a web app named "ConstosoApp" with a slot named "Staging" in the "Default-Web-WestUS" resource group - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the web app. - -```yaml -Type: System.String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Slot -The name of the web app slot. - -```yaml -Type: System.String -Parameter Sets: FromResourceName -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WebApp -The web app object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: FromWebApp -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Management.WebSites.Models.Site -Parameters: WebApp (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.WebApps.Cmdlets.BackupRestore.AzureWebAppSnapshot - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Websites/New-AzureRmAppServicePlan.md b/azurermps-6.13.0/AzureRM.Websites/New-AzureRmAppServicePlan.md deleted file mode 100644 index 00e5f102a0..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/New-AzureRmAppServicePlan.md +++ /dev/null @@ -1,268 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: 8F36244D-A4D7-40BB-AC4C-E9AD445549F8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/new-azurermappserviceplan -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/New-AzureRmAppServicePlan.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/New-AzureRmAppServicePlan.md ---- - -# New-AzureRmAppServicePlan - -## SYNOPSIS -Creates an Azure App Service plan in a given Geo location. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -New-AzureRmAppServicePlan [-Location] <String> [[-Tier] <String>] [[-NumberofWorkers] <Int32>] - [[-WorkerSize] <String>] [[-AseName] <String>] [[-AseResourceGroupName] <String>] [-PerSiteScaling <Boolean>] - [-HyperV] [-AsJob] [-ResourceGroupName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### S2 -``` -New-AzureRmAppServicePlan [-Location] <String> [[-Tier] <String>] [[-NumberofWorkers] <Int32>] - [[-WorkerSize] <String>] [[-AseName] <String>] [[-AseResourceGroupName] <String>] [-PerSiteScaling <Boolean>] - [-AsJob] [-AppServicePlan] <PSAppServicePlan> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmAppServicePlan** cmdlet creates an Azure App Service plan in a given Geo location with the specified Tier, worker size, and number of workers. - -## EXAMPLES - -### Example 1: Create an App Service plan -``` -PS C:\>New-AzureRmAppServicePlan -ResourceGroupName "Default-Web-WestUS" -Name "ContosoASP" -Location "West US" -Tier "Basic" -NumberofWorkers 2 -WorkerSize "Small" -``` - -This command creates an App Service plan named ContosoASP in the resource group named Default-Web-WestUS in Geo location West US. -The command specifies a Basic Tier and allocates two small workers. - -## PARAMETERS - -### -AppServicePlan -App Service Plan Object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.WebApp.PSAppServicePlan -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AseName -App Service Environment Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AseResourceGroupName -App Service Environment Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HyperV -Specify this, App Service Plan will run Windows Containers - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: S1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Location - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -App Service Plan Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumberofWorkers -Number Of Workers - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: 1 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PerSiteScaling -Whether or not to enable Per Site Scaling - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tier -Tier - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: Free -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkerSize -Size of web worker - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Small, Medium, Large, ExtraLarge - -Required: False -Position: 5 -Default value: Small -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.WebSites.Models.AppServicePlan -Parameters: AppServicePlan (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Management.WebSites.Models.AppServicePlan - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAppServicePlan](./Get-AzureRmAppServicePlan.md) - -[Remove-AzureRmAppServicePlan](./Remove-AzureRmAppServicePlan.md) - -[Set-AzureRmAppServicePlan](./Set-AzureRmAppServicePlan.md) - - diff --git a/azurermps-6.13.0/AzureRM.Websites/New-AzureRmWebApp.md b/azurermps-6.13.0/AzureRM.Websites/New-AzureRmWebApp.md deleted file mode 100644 index 6f8f8697a9..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/New-AzureRmWebApp.md +++ /dev/null @@ -1,454 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: D6D4E733-31AE-4ABE-8C78-583EC48C56B8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/new-azurermwebapp -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/New-AzureRmWebApp.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/New-AzureRmWebApp.md ---- - -# New-AzureRmWebApp - -## SYNOPSIS -Creates an Azure Web App. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SimpleParameterSet (Default) -``` -New-AzureRmWebApp [[-ResourceGroupName] <String>] [-Name] <String> [[-Location] <String>] - [[-AppServicePlan] <String>] [-ContainerImageName <String>] [-EnableContainerContinuousDeployment] [-AsJob] - [-GitRepositoryPath <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### PrivateRegistry -``` -New-AzureRmWebApp [-ResourceGroupName] <String> [-Name] <String> [[-Location] <String>] - [[-AppServicePlan] <String>] -ContainerImageName <String> -ContainerRegistryUrl <String> - -ContainerRegistryUser <String> -ContainerRegistryPassword <SecureString> - [-EnableContainerContinuousDeployment] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### WebAppParameterSet -``` -New-AzureRmWebApp [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> - [[-AppServicePlan] <String>] [[-SourceWebApp] <PSSite>] [[-TrafficManagerProfile] <String>] - [-EnableContainerContinuousDeployment] [-IgnoreSourceControl] [-IgnoreCustomHostNames] - [[-AppSettingsOverrides] <Hashtable>] [[-AseName] <String>] [[-AseResourceGroupName] <String>] - [-IncludeSourceWebAppSlots] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmWebApp** cmdlet creates an Azure Web App in a given a resource group that uses the specified App Service plan and data center. - -## EXAMPLES - -### Example 1: Create a Web App -``` -PS C:\>New-AzureRmWebApp -ResourceGroupName Default-Web-WestUS -Name "ContosoSite" -Location "West US" -AppServicePlan "ContosoServicePlan" -``` - -This command creates an Azure Web App named ContosoSite in the existing resource group named Default-Web-WestUS in data center West US. -The command uses an existing App Service plan named ContosoServicePlan. - -## PARAMETERS - -### -AppServicePlan -App Service Plan Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AppSettingsOverrides -App Settings Overrides HashTable - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: WebAppParameterSet -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AseName -App Service Environment Name - -```yaml -Type: System.String -Parameter Sets: WebAppParameterSet -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AseResourceGroupName -App Service Environment Resource Group Name - -```yaml -Type: System.String -Parameter Sets: WebAppParameterSet -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContainerImageName -Container Image Name and optional tag, for example (image:tag) - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: PrivateRegistry -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContainerRegistryPassword -Private Container Registry Password - -```yaml -Type: System.Security.SecureString -Parameter Sets: PrivateRegistry -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContainerRegistryUrl -Private Container Registry Server Url - -```yaml -Type: System.String -Parameter Sets: PrivateRegistry -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContainerRegistryUser -Private Container Registry Username - -```yaml -Type: System.String -Parameter Sets: PrivateRegistry -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableContainerContinuousDeployment -Enables/Disables container continuous deployment webhook - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GitRepositoryPath -Path to the GitHub repository containign the web application to deploy. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreCustomHostNames -Ignore Custom Host Names Option - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: WebAppParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreSourceControl -Ignore Source Control Option - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: WebAppParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeSourceWebAppSlots -Include Source WebApp Slots Option - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: WebAppParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Location - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet, PrivateRegistry -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: WebAppParameterSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: WebAppName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: PrivateRegistry, WebAppParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceWebApp -Source WebApp Object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: WebAppParameterSet -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TrafficManagerProfile -Resource Id of existing traffic manager profile - -```yaml -Type: System.String -Parameter Sets: WebAppParameterSet -Aliases: TrafficManagerProfileName, TrafficManagerProfileId - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.WebSites.Models.Site -Parameters: SourceWebApp (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Management.WebSites.Models.Site - -## NOTES - -## RELATED LINKS - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) - -[Remove-AzureRmWebApp](./Remove-AzureRmWebApp.md) - -[Restart-AzureRmWebApp](./Restart-AzureRmWebApp.md) - -[Start-AzureRmWebApp](./Start-AzureRmWebApp.md) - -[Stop-AzureRmWebApp](./Stop-AzureRmWebApp.md) - - diff --git a/azurermps-6.13.0/AzureRM.Websites/New-AzureRmWebAppBackup.md b/azurermps-6.13.0/AzureRM.Websites/New-AzureRmWebAppBackup.md deleted file mode 100644 index ef221d712e..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/New-AzureRmWebAppBackup.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: D3FE0440-C663-4379-8F5F-2E66EF024E5D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/new-azurermwebappbackup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/New-AzureRmWebAppBackup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/New-AzureRmWebAppBackup.md ---- - -# New-AzureRmWebAppBackup - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### FromResourceName -``` -New-AzureRmWebAppBackup [[-BackupName] <String>] [-ResourceGroupName] <String> [-Name] <String> - [[-Slot] <String>] [-DefaultProfile <IAzureContextContainer>] [-StorageAccountUrl] <String> - [-Databases <DatabaseBackupSetting[]>] [<CommonParameters>] -``` - -### FromWebApp -``` -New-AzureRmWebAppBackup [[-BackupName] <String>] [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] - [-StorageAccountUrl] <String> [-Databases <DatabaseBackupSetting[]>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmWebAppBackup** cmdlet creates an Azure Web App Backup. - -## EXAMPLES - -### 1: -``` -PS C:\> New-AzureRmWebAppBackup -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -StorageAccountUrl "https://storageaccount.file.core.windows.net" -``` - -Creates a backup of the specified app ContosoWebApp that is within resource group Default-Web-WestUS in `https://storageaccount.file.core.windows.net` - -## PARAMETERS - -### -BackupName -Backup Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Databases -Databases of type DatabaseBackupSetting[] - -```yaml -Type: Microsoft.Azure.Management.WebSites.Models.DatabaseBackupSetting[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: System.String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Slot -WebApp Slot Name - -```yaml -Type: System.String -Parameter Sets: FromResourceName -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountUrl -Storage Account Url - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: FromWebApp -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Management.WebSites.Models.Site -Parameters: WebApp (ByValue) - -### Microsoft.Azure.Management.WebSites.Models.DatabaseBackupSetting[] - -## OUTPUTS - -### Microsoft.Azure.Commands.WebApps.Cmdlets.WebApps.AzureWebAppBackup - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Websites/New-AzureRmWebAppContainerPSSession.md b/azurermps-6.13.0/AzureRM.Websites/New-AzureRmWebAppContainerPSSession.md deleted file mode 100644 index a3c195f52b..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/New-AzureRmWebAppContainerPSSession.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/?view=azurermps-6.8.1 -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/New-AzureRmWebAppContainerPSSession.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/New-AzureRmWebAppContainerPSSession.md ---- - -# New-AzureRmWebAppContainerPSSession - -## SYNOPSIS -New-AzureRmWebAppContainerPSSession will create new remote PowerShell Session into the windows container specified in a given site or slot and given resource group - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 (Default) -``` -New-AzureRmWebAppContainerPSSession [[-SlotName] <String>] [-Force] [-ResourceGroupName] <String> - [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### S2 -``` -New-AzureRmWebAppContainerPSSession [-Force] [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -New-AzureRmWebAppContainerPSSession will create new remote PowerShell Session into the windows container specified in a given site or slot and given resource group - -## EXAMPLES - -### Example 1 -``` -PS C:\> $s = New-AzureRmWebAppContainerPSSession -ResourceGroupName "Default-Web-WestUS" -Name "ContosoASP" -PS C:\> Invoke-Command -Session $s -ScriptBlock{Get-Process} -``` - -This will create a new remote PowerShell Session into the windows container app ContosoASP and show the processes that are running on the container ContosoASP - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Create the PowerShell session without prompting for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the web app. - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SlotName -The name of the web app slot. - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WebApp -The web app object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -### Microsoft.Azure.Commands.WebApps.Models.PSSite -## OUTPUTS - -### System.String -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Websites/New-AzureRmWebAppDatabaseBackupSetting.md b/azurermps-6.13.0/AzureRM.Websites/New-AzureRmWebAppDatabaseBackupSetting.md deleted file mode 100644 index 14e4a0fe03..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/New-AzureRmWebAppDatabaseBackupSetting.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: 22ACB910-0C41-4649-8D22-537E38CB4570 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/new-azurermwebappdatabasebackupsetting -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/New-AzureRmWebAppDatabaseBackupSetting.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/New-AzureRmWebAppDatabaseBackupSetting.md ---- - -# New-AzureRmWebAppDatabaseBackupSetting - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmWebAppDatabaseBackupSetting [-Name] <String> [-DatabaseType] <String> [-ConnectionString] <String> - [[-ConnectionStringName] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmWebAppDatabaseBackupSetting** cmdlet creates a new Azure Web App Backup setting. - -## EXAMPLES - -### 1: -``` -PS C:\> New-AzureRmWebAppDatabaseBackupSetting -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -ConnectionString "MyConnectionString" -DatabaseType "SqlAzure" -``` - -Creates a database backup setting (connection string) of type SqlAzure for the specified app ContosoWebApp that is within resource group Default-Web-WestUS. - -## PARAMETERS - -### -ConnectionString -Connection String - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConnectionStringName -Connection String Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseType -Database Type ( e.g. "SqlAzure" or "MySql" ) - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.WebSites.Models.DatabaseBackupSetting - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Websites/New-AzureRmWebAppSSLBinding.md b/azurermps-6.13.0/AzureRM.Websites/New-AzureRmWebAppSSLBinding.md deleted file mode 100644 index ce56048fef..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/New-AzureRmWebAppSSLBinding.md +++ /dev/null @@ -1,255 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: 910239BE-9E48-4DC5-85EA-CC6D466FE62F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/new-azurermwebappsslbinding -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/New-AzureRmWebAppSSLBinding.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/New-AzureRmWebAppSSLBinding.md ---- - -# New-AzureRmWebAppSSLBinding - -## SYNOPSIS -Creates an SSL certificate binding for an Azure Web App. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -New-AzureRmWebAppSSLBinding [-ResourceGroupName] <String> [-WebAppName] <String> [[-Slot] <String>] - [-Name] <String> [[-SslState] <SslState>] [-CertificateFilePath] <String> [-CertificatePassword] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -New-AzureRmWebAppSSLBinding [-ResourceGroupName] <String> [-WebAppName] <String> [[-Slot] <String>] - [-Name] <String> [[-SslState] <SslState>] [-Thumbprint] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### S3 -``` -New-AzureRmWebAppSSLBinding [-WebApp] <PSSite> [-Name] <String> [[-SslState] <SslState>] - [-CertificateFilePath] <String> [-CertificatePassword] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### S4 -``` -New-AzureRmWebAppSSLBinding [-WebApp] <PSSite> [-Name] <String> [[-SslState] <SslState>] [-Thumbprint] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmWebAppSSLBinding** cmdlet creates a Secure Socket Layer (SSL) certificate binding for an Azure Web App. -The cmdlet creates an SSL binding in two ways: -- You can bind a Web App to an existing certificate. -- You can upload a new certificate and then bind the Web App to this new certificate. -Regardless of which approach you use, the certificate and the Web App must be associated with the same Azure resource group. -If you have a Web App in Resource Group A and you want to bind that Web App to a certificate in Resource Group B, the only way to do that is to upload a copy of the certificate to Resource Group A. -If you upload a new certificate, keep in mind the following requirements for an Azure SSL certificate: -- The certificate must contain a private key. -- The certificate must use the Personal Information Exchange (PFX) format. -- The certificate's subject name must match the domain used to access the Web App. -- The certificate must use a minimum of 2048-bit encryption. - -## EXAMPLES - -### Example 1: Bind a certificate to a Web App -``` -PS C:\>New-AzureRmWebAppSSLBinding -ResourceGroupName "ContosoResourceGroup" -WebAppName "ContosoWebApp" -Thumbprint "E3A38EBA60CAA1C162785A2E1C44A15AD450199C3" -Name "www.contoso.com" -``` - -This command binds an existing Azure certificate (a certificate with the Thumbprint E3A38EBA60CAA1C162785A2E1C44A15AD450199C3) to the web app named ContosoWebApp. - -## PARAMETERS - -### -CertificateFilePath -Specifies the file path for the certificate to be uploaded. -The *CertificateFilePath* parameter is only required if the certificate has not yet been uploaded to Azure. - -```yaml -Type: System.String -Parameter Sets: S1, S3 -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CertificatePassword -Specifies the decryption password for the certificate. - -```yaml -Type: System.String -Parameter Sets: S1, S3 -Aliases: - -Required: True -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Web App. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the certificate is assigned to. -You cannot use the *ResourceGroupName* parameter and the *WebApp* parameter in the same command. - -```yaml -Type: System.String -Parameter Sets: S1, S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Slot -Specifies the name of the Web App deployment slot. -You can use the Get-AzureRMWebAppSlot cmdlet to get a slot. -Deployment slots provide a way for you to stage and validate web apps without those apps being accessible over the Internet. -Typically you will deploy your changes to a staging site, validate those changes, and then deploy to the production (Internet-accessible) site. - -```yaml -Type: System.String -Parameter Sets: S1, S2 -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SslState -Specifies whether the certificate is enabled. -Set the *SSLState* parameter to 1 to enable the certificate, or set *SSLState* to 0 to disable the certificate. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.WebSites.Models.SslState] -Parameter Sets: (All) -Aliases: -Accepted values: Disabled, SniEnabled, IpBasedEnabled - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Thumbprint -Specifies the unique identifier for the certificate. - -```yaml -Type: System.String -Parameter Sets: S2, S4 -Aliases: - -Required: True -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -Specifies a Web App. -To get a Web App, use the Get-AzureRmWebApp cmdlet. -You cannot use the *WebApp* parameter in the same command as the *ResourceGroupName* parameter and/or the *WebAppName*. - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: S3, S4 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WebAppName -Specifies the name of the Web App for which the new SSL binding is being created. -You cannot use the *WebAppName* parameter and the *WebApp* parameter in the same command. - -```yaml -Type: System.String -Parameter Sets: S1, S2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.WebSites.Models.Site -Parameters: WebApp (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Management.WebSites.Models.HostNameSslState - -## NOTES - -## RELATED LINKS - -[Get-AzureRmWebAppSSLBinding](./Get-AzureRmWebAppSSLBinding.md) - -[Remove-AzureRmWebAppSSLBinding](./Remove-AzureRmWebAppSSLBinding.md) - -[Get-AzureRMWebAppSlot](./Get-AzureRMWebAppSlot.md) - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) - - diff --git a/azurermps-6.13.0/AzureRM.Websites/New-AzureRmWebAppSlot.md b/azurermps-6.13.0/AzureRM.Websites/New-AzureRmWebAppSlot.md deleted file mode 100644 index 5ea1df427d..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/New-AzureRmWebAppSlot.md +++ /dev/null @@ -1,331 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: D23BBF34-80C0-48B1-8E1C-6F345DEC61AD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/new-azurermwebappslot -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/New-AzureRmWebAppSlot.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/New-AzureRmWebAppSlot.md ---- - -# New-AzureRmWebAppSlot - -## SYNOPSIS -Creates an Azure Web App slot. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmWebAppSlot [-ResourceGroupName] <String> [-Name] <String> [[-Slot] <String>] - [[-AppServicePlan] <String>] [[-SourceWebApp] <PSSite>] [-IgnoreSourceControl] [-IgnoreCustomHostNames] - [[-AppSettingsOverrides] <Hashtable>] [[-AseName] <String>] [[-AseResourceGroupName] <String>] - [-ContainerImageName <String>] [-ContainerRegistryUrl <String>] [-ContainerRegistryUser <String>] - [-ContainerRegistryPassword <SecureString>] [-EnableContainerContinuousDeployment] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmWebAppSlot** cmdlet creates an Azure Web App Slot in a given a resource group that uses the specified App Service plan and data center. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmWebAppSlot -ResourceGroupName Default-Web-WestUS -Name "ContosoSite" -AppServicePlan "ContosoServicePlan" -Slot "Slot001" -``` - -This command creates a Slot named Slot001 under an existing Web App names ContosoSite in the existing resource group named Default-Web-WestUS in data center West US. -The command uses an existing App Service plan named ContosoServicePlan. - -## PARAMETERS - -### -AppServicePlan -App Service Plan Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AppSettingsOverrides -App Settings Overrides Hashtable - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AseName -App Service Environment Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 9 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AseResourceGroupName -App Service Environment Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 9 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContainerImageName -Container Image Name and optional tag, for example (image:tag) - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContainerRegistryPassword -Private Container Registry Password - -```yaml -Type: System.Security.SecureString -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContainerRegistryUrl -Private Container Registry Server Url - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContainerRegistryUser -Private Container Registry Username - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableContainerContinuousDeployment -Enables/Disables container continuous deployment webhook - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreCustomHostNames -Ignore Custom HostNames Option - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreSourceControl -Ignore Source Control Option - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Webapp Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Slot -Webapp Slot Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceWebApp -Source WebApp Object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Management.WebSites.Models.Site -Parameters: SourceWebApp (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Management.WebSites.Models.Site - -## NOTES - -## RELATED LINKS - -[Get-AzureRMWebAppSlot](./Get-AzureRMWebAppSlot.md) - -[Remove-AzureRMWebAppSlot](./Remove-AzureRMWebAppSlot.md) - -[Restart-AzureRMWebAppSlot](./Restart-AzureRMWebAppSlot.md) - -[Set-AzureRMWebAppSlot](./Set-AzureRMWebAppSlot.md) - -[Start-AzureRMWebAppSlot](./Start-AzureRMWebAppSlot.md) - -[Stop-AzureRMWebAppSlot](./Stop-AzureRMWebAppSlot.md) - -[Get-AzureRmAppServicePlan](./Get-AzureRmAppServicePlan.md) - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) diff --git a/azurermps-6.13.0/AzureRM.Websites/Remove-AzureRmAppServicePlan.md b/azurermps-6.13.0/AzureRM.Websites/Remove-AzureRmAppServicePlan.md deleted file mode 100644 index 887f5f0d2a..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Remove-AzureRmAppServicePlan.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: 78AAF476-2E9E-4E60-9940-9A9AC6F9506A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/remove-azurermappserviceplan -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Remove-AzureRmAppServicePlan.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Remove-AzureRmAppServicePlan.md ---- - -# Remove-AzureRmAppServicePlan - -## SYNOPSIS -Removes an Azure App Service plan. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Remove-AzureRmAppServicePlan [-Force] [-AsJob] [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### S2 -``` -Remove-AzureRmAppServicePlan [-Force] [-AsJob] [-AppServicePlan] <PSAppServicePlan> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmAppServicePlan** cmdlet removes an Azure App Service plan. - -## EXAMPLES - -### Example 1: Remove an App Service plan -``` -PS C:\>Remove-AzureRmAppServicePlan -ResourceGroupName "Default-Web-WestUS" -Name "ContosoASP" -``` - -This command removes the Azure App Service plan named ContosoASP that belongs to the resource group named Default-Web-WestUS. - -## PARAMETERS - -### -AppServicePlan -App Service Plan Object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.WebApp.PSAppServicePlan -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forcefully Remove Option - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -App Service Plan Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.WebSites.Models.AppServicePlan -Parameters: AppServicePlan (ByValue) - -## OUTPUTS - -### Microsoft.Azure.AzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAppServicePlan](./Get-AzureRmAppServicePlan.md) - -[New-AzureRmAppServicePlan](./New-AzureRmAppServicePlan.md) - -[Set-AzureRmAppServicePlan](./Set-AzureRmAppServicePlan.md) - - diff --git a/azurermps-6.13.0/AzureRM.Websites/Remove-AzureRmWebApp.md b/azurermps-6.13.0/AzureRM.Websites/Remove-AzureRmWebApp.md deleted file mode 100644 index d5248c47d4..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Remove-AzureRmWebApp.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: 9057185C-6F22-4C4A-8480-BE542B5D6BAF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/remove-azurermwebapp -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Remove-AzureRmWebApp.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Remove-AzureRmWebApp.md ---- - -# Remove-AzureRmWebApp - -## SYNOPSIS -Removes an Azure Web App. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Remove-AzureRmWebApp [-Force] [-AsJob] [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### S2 -``` -Remove-AzureRmWebApp [-Force] [-AsJob] [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmWebApp** cmdlet removes an Azure Web App provided the resource group and Web App name. -This cmdlet, by default, also removes all slots and metrics. - -## EXAMPLES - -### Example 1: Remove a Web App -``` -PS C:\>Remove-AzureRmWebApp -ResourceGroupName "Default-Web-WestUS" -Name "ContosoSite" -``` - -This command removes the Azure Web App named ContosoSite that belongs to the resource group named Default-Web-WestUS. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forcefully Remove Option - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Management.WebSites.Models.Site -Parameters: WebApp (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) - -[New-AzureRmWebApp](./New-AzureRmWebApp.md) - -[Restart-AzureRmWebApp](./Restart-AzureRmWebApp.md) - -[Start-AzureRmWebApp](./Start-AzureRmWebApp.md) - -[Stop-AzureRmWebApp](./Stop-AzureRmWebApp.md) - - diff --git a/azurermps-6.13.0/AzureRM.Websites/Remove-AzureRmWebAppBackup.md b/azurermps-6.13.0/AzureRM.Websites/Remove-AzureRmWebAppBackup.md deleted file mode 100644 index 10bd26dccb..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Remove-AzureRmWebAppBackup.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: 65A78654-A490-4B60-8C16-B0CC597EE995 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/remove-azurermwebappbackup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Remove-AzureRmWebAppBackup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Remove-AzureRmWebAppBackup.md ---- - -# Remove-AzureRmWebAppBackup - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### FromResourceName -``` -Remove-AzureRmWebAppBackup [-BackupId] <String> [-ResourceGroupName] <String> [-Name] <String> - [[-Slot] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### FromWebApp -``` -Remove-AzureRmWebAppBackup [-BackupId] <String> [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmWebAppBackup** cmdlet removes the specified backup of an Azure Web App. - -## EXAMPLES - -### 1: -``` -PS C:\>Remove-AzureRmWebAppBackup -ResourceGroupName "Default-Web-WestUS" -Name "WebAppStandard" -BackupId "12345" -``` - -This command removes the backup with backup with ID of "12345" from the Web App named WebAppStandard that belongs to the resource group Default-Web-WestUS. - -## PARAMETERS - -### -BackupId -Backup Id - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: System.String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Slot -WebApp Slot Name - -```yaml -Type: System.String -Parameter Sets: FromResourceName -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: FromWebApp -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Management.WebSites.Models.Site -Parameters: WebApp (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Management.WebSites.Models.BackupItem - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Websites/Remove-AzureRmWebAppSSLBinding.md b/azurermps-6.13.0/AzureRM.Websites/Remove-AzureRmWebAppSSLBinding.md deleted file mode 100644 index 6ba4f16738..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Remove-AzureRmWebAppSSLBinding.md +++ /dev/null @@ -1,254 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: 3AB3D398-E5DB-4214-BA27-6E3B7D225550 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/remove-azurermwebappsslbinding -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Remove-AzureRmWebAppSSLBinding.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Remove-AzureRmWebAppSSLBinding.md ---- - -# Remove-AzureRmWebAppSSLBinding - -## SYNOPSIS -Removes an SSL binding from an uploaded certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Remove-AzureRmWebAppSSLBinding [-Name] <String> [[-DeleteCertificate] <Boolean>] [-Force] - [-ResourceGroupName] <String> [-WebAppName] <String> [[-Slot] <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### S2 -``` -Remove-AzureRmWebAppSSLBinding [-Name] <String> [[-DeleteCertificate] <Boolean>] [-Force] [-WebApp] <PSSite> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmWebAppSSLBinding** cmdlet removes a Secure Sockets Layer (SSL) binding from an Azure Web App. -SSL bindings are used to associate a Web App with a certificate. - -## EXAMPLES - -### Example 1: Remove an SSL binding for a web app -``` -PS C:\>Remove-AzureRmWebAppSSLBinding -ResourceGroupName "ContosoResourceGroup" -WebAppName "ContosoWebApp" -Name "www.contoso.com" -``` - -This command removes the SSL binding for the web app ContosoWebApp. -Since the *DeleteCertificate* parameter is not included, the certificate will be deleted if it no longer has any SSL bindings. - -### Example 2: Remove an SSL binding without removing the certificate -``` -PS C:\>Remove-AzureRmWebAppSSLBinding -ResourceGroupName "ContosoResourceGroup" -WebAppName "ContosoWebApp" -Name "www.contoso.com" -DeleteCertificate $False -``` - -Similar to Example 1, this command also removes the SSL binding for the Web App ContosoWebApp. -In this case, however, the *DeleteCertificate* parameter is included, and the parameter value is set to $False. -That means that the certificate will not be deleted regardless of whether it has any SSL bindings or not. - -### Example 3: Use an object reference to remove an SSL binding -``` -PS C:\>$WebApp = Get-AzureRmWebApp -Name "ContosoWebApp" -PS C:\> Remove-AzureRmWebAppSSLBinding -WebApp $WebApp -Name "www.contoso.com" -``` - -This example uses an object reference to the Web App website to remove the SSL binding for a Web App. -The first command uses the Get-AzureRmWebApp cmdlet to create an object reference to the Web App named ContosoWebApp. -That object reference is stored in a variable named $WebApp. -The second command uses the object reference and the **Remove-AzureRmWebAppSSLBinding** cmdlet to remove the SSL binding. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeleteCertificate -Specifies the action to take place if the SSL binding being removed is the only binding used by the certificate. -If *DeleteCertificate* is set to $False, the certificate will not be deleted when the binding is deleted. -If *DeleteCertificate* is set to $True or is not included in the command, the certificate will be deleted along with the SSL binding. -The certificate will only be deleted if the SSL binding being removed is the only binding used by the certificate. -If the certificate has more than one binding, the certificate will not be removed regardless of the value of the *DeleteCertificate* parameter. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Web App. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the certificate is assigned to. -You cannot use the *ResourceGroupName* parameter and the *WebApp* parameter in the same command. - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Slot -Specifies the Web App deployment slot. -To get a deployment slot, use the Get-AzureRMWebAppSlot cmdlet. - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -Specifies a Web App. -To get a Web App, use the Get-AzureRmWebApp cmdlet. -You cannot use the *WebApp* parameter in the same command as the *ResourceGroupName* parameter and/or the *WebAppName*. - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WebAppName -Specifies the name of the Web App. -You cannot use the *WebAppName* parameter and the *WebApp* parameter in the same command. - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.WebSites.Models.Site -Parameters: WebApp (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmWebAppSSLBinding](./Get-AzureRmWebAppSSLBinding.md) - -[New-AzureRmWebAppSSLBinding](./New-AzureRmWebAppSSLBinding.md) - -[Get-AzureRMWebAppSlot](./Get-AzureRMWebAppSlot.md) - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) - - diff --git a/azurermps-6.13.0/AzureRM.Websites/Remove-AzureRmWebAppSlot.md b/azurermps-6.13.0/AzureRM.Websites/Remove-AzureRmWebAppSlot.md deleted file mode 100644 index e251020898..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Remove-AzureRmWebAppSlot.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/remove-azurermwebappslot -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Remove-AzureRmWebAppSlot.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Remove-AzureRmWebAppSlot.md ---- - -# Remove-AzureRmWebAppSlot - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Remove-AzureRmWebAppSlot [-Force] [-AsJob] [-ResourceGroupName] <String> [-Name] <String> [-Slot] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### S2 -``` -Remove-AzureRmWebAppSlot [-Force] [-AsJob] [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmWebAppSlot** cmdlet removes an Azure Web App Slot provided the resource group and Web App name. -This cmdlet, by default, also removes all slots and metrics. - -## EXAMPLES - -### Example 1: Remove a Web App Slot -``` -PS C:\>Remove-AzureRmWebAppSlot -ResourceGroupName "Default-Web-WestUS" -Name "ContosoSite" -Slot "Slot001" -``` - -This command removes the Slot named Slot001 associated with Web App ContosoSite that belongs to the resource group named Default-Web-WestUS. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forcefully Remove Option - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Slot -WebApp Slot Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Management.WebSites.Models.Site -Parameters: WebApp (ByValue) - -## OUTPUTS - -### Microsoft.Azure.AzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRMWebAppSlot](./Get-AzureRMWebAppSlot.md) - -[New-AzureRMWebAppSlot](./New-AzureRMWebAppSlot.md) - -[Restart-AzureRMWebAppSlot](./Restart-AzureRMWebAppSlot.md) - -[Set-AzureRMWebAppSlot](./Set-AzureRMWebAppSlot.md) - -[Start-AzureRMWebAppSlot](./Start-AzureRMWebAppSlot.md) - -[Stop-AzureRMWebAppSlot](./Stop-AzureRMWebAppSlot.md) - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) diff --git a/azurermps-6.13.0/AzureRM.Websites/Reset-AzureRmWebAppPublishingProfile.md b/azurermps-6.13.0/AzureRM.Websites/Reset-AzureRmWebAppPublishingProfile.md deleted file mode 100644 index 2d3b1810f3..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Reset-AzureRmWebAppPublishingProfile.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: 84C861B2-DCB3-47F0-8589-BB3172C6E1EC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/reset-azurermwebapppublishingprofile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Reset-AzureRmWebAppPublishingProfile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Reset-AzureRmWebAppPublishingProfile.md ---- - -# Reset-AzureRmWebAppPublishingProfile - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Reset-AzureRmWebAppPublishingProfile [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -Reset-AzureRmWebAppPublishingProfile [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Reset-AzureRmWebAppPublishingProfile** cmdlet resets the publishing profile for the specified Web App. - -## EXAMPLES - -### 1: -``` -PS C:\> Reset-AzureRmWebAppSlotPublishingProfile -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -``` - -This command resets the publishing profile for the Web App ContosoWebApp associated with the resource group Default-Web-WestUS. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Management.WebSites.Models.Site -Parameters: WebApp (ByValue) - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Websites/Reset-AzureRmWebAppSlotPublishingProfile.md b/azurermps-6.13.0/AzureRM.Websites/Reset-AzureRmWebAppSlotPublishingProfile.md deleted file mode 100644 index dc62e11175..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Reset-AzureRmWebAppSlotPublishingProfile.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: 3CD449A1-084E-4950-80EF-06B5ECDFB70F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/reset-azurermwebappslotpublishingprofile -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Reset-AzureRmWebAppSlotPublishingProfile.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Reset-AzureRmWebAppSlotPublishingProfile.md ---- - -# Reset-AzureRmWebAppSlotPublishingProfile - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Reset-AzureRmWebAppSlotPublishingProfile [-ResourceGroupName] <String> [-Name] <String> [-Slot] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -Reset-AzureRmWebAppSlotPublishingProfile [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Reset-AzureRmWebAppSlotPublishingProfile** cmdlet resets the publishing profile for the specified Web App Slot. - -## EXAMPLES - -### 1: -``` -PS C:\> Reset-AzureRmWebAppSlotPublishingProfile -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -Slot "slot001" -``` - -This command resets the publishing profile for the Slot named slot001 for the Web App ContosoWebApp associated with the resource group Default-Web-WestUS. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Slot -WebApp Slot Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Management.WebSites.Models.Site -Parameters: WebApp (ByValue) - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Websites/Restart-AzureRmWebApp.md b/azurermps-6.13.0/AzureRM.Websites/Restart-AzureRmWebApp.md deleted file mode 100644 index 7efbd2c0eb..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Restart-AzureRmWebApp.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: 297071E5-FC06-4493-BCC2-37D4929E4025 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/restart-azurermwebapp -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Restart-AzureRmWebApp.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Restart-AzureRmWebApp.md ---- - -# Restart-AzureRmWebApp - -## SYNOPSIS -Restarts an Azure Web App. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Restart-AzureRmWebApp [-ResourceGroupName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### S2 -``` -Restart-AzureRmWebApp [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Restart-AzureRmWebApp** cmdlet stops and then starts an Azure Web App. -If the Web App is in a stopped state, use the Start-AzureRmWebApp cmdlet. - -## EXAMPLES - -### Example 1: Restart a Web App -``` -PS C:\>Restart-AzureRmWebApp -ResourceGroupName "Default-Web-WestUS" -Name "ContosoSite" -``` - -This command stops the Azure Web App named ContosoSite that belongs to the resource group named Default-Web-WestUS and then restarts it. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Management.WebSites.Models.Site -Parameters: WebApp (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Management.WebSites.Models.Site - -## NOTES - -## RELATED LINKS - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) - -[New-AzureRmWebApp](./New-AzureRmWebApp.md) - -[Remove-AzureRmWebApp](./Remove-AzureRmWebApp.md) - -[Start-AzureRmWebApp](./Start-AzureRmWebApp.md) - -[Stop-AzureRmWebApp](./Stop-AzureRmWebApp.md) - - diff --git a/azurermps-6.13.0/AzureRM.Websites/Restart-AzureRmWebAppSlot.md b/azurermps-6.13.0/AzureRM.Websites/Restart-AzureRmWebAppSlot.md deleted file mode 100644 index 90fdb373f9..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Restart-AzureRmWebAppSlot.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: 645E74D2-640D-494F-9798-4375FE6A0AF2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/restart-azurermwebappslot -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Restart-AzureRmWebAppSlot.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Restart-AzureRmWebAppSlot.md ---- - -# Restart-AzureRmWebAppSlot - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Restart-AzureRmWebAppSlot [-ResourceGroupName] <String> [-Name] <String> [-Slot] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -Restart-AzureRmWebAppSlot [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Restart-AzureRmWebAppSlot** cmdlet stops and then starts an Azure Web App Slot. -If the Web App Slot is in a stopped state, use the Start-AzureRmWebAppSlot cmdlet. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Restart-AzureRmWebAppSlot -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -Slot "Slot001" -``` - -This command restarts the slot Slot001 for the web app ContosoWebApp associated with the resource group Default-Web-WestUS - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Slot -WebApp Slot Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Management.WebSites.Models.Site -Parameters: WebApp (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Management.WebSites.Models.Site - -## NOTES - -## RELATED LINKS - -[Get-AzureRMWebAppSlot](./Get-AzureRMWebAppSlot.md) - -[New-AzureRMWebAppSlot](./New-AzureRMWebAppSlot.md) - -[Remove-AzureRMWebAppSlot](./Remove-AzureRMWebAppSlot.md) - -[Set-AzureRMWebAppSlot](./Set-AzureRMWebAppSlot.md) - -[Start-AzureRMWebAppSlot](./Start-AzureRMWebAppSlot.md) - -[Stop-AzureRMWebAppSlot](./Stop-AzureRMWebAppSlot.md) - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) diff --git a/azurermps-6.13.0/AzureRM.Websites/Restore-AzureRmDeletedWebApp.md b/azurermps-6.13.0/AzureRM.Websites/Restore-AzureRmDeletedWebApp.md deleted file mode 100644 index 686714554c..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Restore-AzureRmDeletedWebApp.md +++ /dev/null @@ -1,251 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/restore-azurermdeletedwebapp -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Restore-AzureRmDeletedWebApp.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Restore-AzureRmDeletedWebApp.md ---- - -# Restore-AzureRmDeletedWebApp - -## SYNOPSIS -Restores a deleted web app to a new or existing web app. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### FromDeletedResourceName -``` -Restore-AzureRmDeletedWebApp [-ResourceGroupName] <String> [-Name] <String> [[-Slot] <String>] - [-TargetResourceGroupName <String>] [-TargetName <String>] [-TargetSlot <String>] - [-TargetAppServicePlanName <String>] [-RestoreContentOnly] [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### FromDeletedApp -``` -Restore-AzureRmDeletedWebApp [-TargetResourceGroupName <String>] [-TargetName <String>] [-TargetSlot <String>] - [-TargetAppServicePlanName <String>] [-RestoreContentOnly] [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-InputObject] <PSAzureDeletedWebApp> [<CommonParameters>] -``` - -## DESCRIPTION -The **Restore-AzureRmDeletedWebApp** cmdlet restores a deleted web app. The web app specified by TargetResourceGroupName, TargetName, and TargetSlot will be overwritten with the contents and settings of the deleted web app. If the target parameters are not specified, they will automatically be filled with the deleted web app's resource group, name, and slot. If the target web app does not exist, it will automatically be created in the app service plan specified by TargetAppServicePlanName. The RestoreContentOnly switch parameter can be used to restore only the deleted app's files without the app settings. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Restore-AzureRmDeletedWebApp -ResourceGroupName Default-Web-WestUS -Name ContosoApp -TargetAppServicePlanName ContosoPlan -``` - -Restores a deleted app named ContosoApp belonging to the resource group Default-Web-WestUS. A new app with the same name and resource group will be created in the App Service Plan named ContosoPlan, and the deleted app's files and settings will be restored to it. - -### Example 2 -```powershell -PS C:\> Restore-AzureRmDeletedWebApp -ResourceGroupName Default-Web-WestUS -Name ContosoApp -Slot Staging -TargetResourceGroupName Default-Web-EastUS -TargetName ContosoRestore -RestoreContentOnly -``` - -Restores the Staging slot of a deleted app named ContosoApp belonging to the resource group Default-Web-WestUS. The web app named ContosoRestore belonging to the resource group Default-Web-EastUS will be overwritten. The deleted web app settings will not be restored. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do the restore without prompting for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The deleted Azure Web App. - -```yaml -Type: PSAzureDeletedWebApp -Parameter Sets: FromDeletedApp -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the deleted Azure Web App. - -```yaml -Type: String -Parameter Sets: FromDeletedResourceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group of the deleted Azure Web App. - -```yaml -Type: String -Parameter Sets: FromDeletedResourceName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RestoreContentOnly -Restore the web app's files, but do not restore the settings. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Slot -The deleted Azure Web App slot. - -```yaml -Type: String -Parameter Sets: FromDeletedResourceName -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetAppServicePlanName -The App Service Plan for the new Azure Web App. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetName -The name of the new Azure Web App. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetResourceGroupName -The resource group containing the new Azure Web App. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetSlot -The name of the new Azure Web App slot. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.WebApps.Cmdlets.WebApps.PSAzureDeletedWebApp - -## OUTPUTS - -### Microsoft.Azure.Commands.WebApps.Models.PSSite - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDeletedWebApp](./Get-AzureRmDeletedWebApp.md) diff --git a/azurermps-6.13.0/AzureRM.Websites/Restore-AzureRmWebAppBackup.md b/azurermps-6.13.0/AzureRM.Websites/Restore-AzureRmWebAppBackup.md deleted file mode 100644 index 94beff48e8..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Restore-AzureRmWebAppBackup.md +++ /dev/null @@ -1,233 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: DC400E32-CAB9-4354-99B2-ABA4AA776030 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/restore-azurermwebappbackup -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Restore-AzureRmWebAppBackup.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Restore-AzureRmWebAppBackup.md ---- - -# Restore-AzureRmWebAppBackup - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### FromResourceName -``` -Restore-AzureRmWebAppBackup [-AppServicePlan <String>] [-Databases <DatabaseBackupSetting[]>] - [-IgnoreConflictingHostNames] [-ResourceGroupName] <String> [-Name] <String> [[-Slot] <String>] - [-DefaultProfile <IAzureContextContainer>] [-StorageAccountUrl] <String> [-BlobName] <String> [-Overwrite] - [<CommonParameters>] -``` - -### FromWebApp -``` -Restore-AzureRmWebAppBackup [-AppServicePlan <String>] [-Databases <DatabaseBackupSetting[]>] - [-IgnoreConflictingHostNames] [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] - [-StorageAccountUrl] <String> [-BlobName] <String> [-Overwrite] [<CommonParameters>] -``` - -## DESCRIPTION -The **Restore-AzureRmWebAppBackup** cmdlet restores an Azure Web App Backup. - -## EXAMPLES - -### 1: -``` -PS C:\> Restore-AzureRmWebAppBackup -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -StorageAccountUrl "https://storageaccount.file.core.windows.net" -BlobName "myBlob" -``` - -Restores a backup of the specified app ContosoWebApp that is within resource group Default-Web-WestUS in blob "myBlob" located at `https://storageaccount.file.core.windows.net` - -## PARAMETERS - -### -AppServicePlan -The name of the App Service Plan for the restored app. If left empty, the app's current App Service Plan is used. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BlobName -Blob Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Databases -Databases of type DatabaseBackupSetting[] - -```yaml -Type: Microsoft.Azure.Management.WebSites.Models.DatabaseBackupSetting[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreConflictingHostNames -Ignore Conflicting HostNames Option - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: System.String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Overwrite -Overwrite Option - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Slot -WebApp Slot Name - -```yaml -Type: System.String -Parameter Sets: FromResourceName -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountUrl -Storage Account Url - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: FromWebApp -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Management.WebSites.Models.DatabaseBackupSetting[] - -### System.Management.Automation.SwitchParameter - -### Microsoft.Azure.Management.WebSites.Models.Site -Parameters: WebApp (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Websites/Restore-AzureRmWebAppSnapshot.md b/azurermps-6.13.0/AzureRM.Websites/Restore-AzureRmWebAppSnapshot.md deleted file mode 100644 index 98eead23ba..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Restore-AzureRmWebAppSnapshot.md +++ /dev/null @@ -1,235 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/restore-azurermwebappsnapshot -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Restore-AzureRmWebAppSnapshot.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Restore-AzureRmWebAppSnapshot.md ---- - -# Restore-AzureRmWebAppSnapshot - -## SYNOPSIS -Restores a web app snapshot. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### FromResourceName -``` -Restore-AzureRmWebAppSnapshot [-RecoverConfiguration] [-Force] [-AsJob] [-ResourceGroupName] <String> - [-Name] <String> [[-Slot] <String>] [-DefaultProfile <IAzureContextContainer>] - [-InputObject] <AzureWebAppSnapshot> [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### FromWebApp -``` -Restore-AzureRmWebAppSnapshot [-RecoverConfiguration] [-Force] [-AsJob] [-WebApp] <PSSite> - [-DefaultProfile <IAzureContextContainer>] [-InputObject] <AzureWebAppSnapshot> [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Restores a web app snapshot to the web app. Restoring a snapshot overwrites all files in a web app with the files contained in the snapshot. To restore settings as well, use the RecoverConfiguration switch parameter. A snapshot from one web app can be restored to any other web app in the same subscription. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $snapshot = (Get-AzureRmWebAppSnapshot -ResourceGroupName "Default-Web-WestUS" -Name "ContosoApp" -Slot "Staging")[0] -PS C:\> Restore-AzureRmWebAppSnapshot -ResourceGroupName "Default-Web-WestUS" -Name "ContosoApp" -Slot "Restore" -InputObject $snapshot -RecoverConfiguration -``` - -Gets the latest snapshot of a web app named "ContosoApp" with a slot named "Staging" in the "Default-Web-WestUS" resource group. Restores the snapshot to the web app's "Restore" slot. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Allows the original web app to be overwritten without displaying a warning. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -The Azure Web App snapshot. - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Cmdlets.BackupRestore.AzureWebAppSnapshot -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the web app. - -```yaml -Type: System.String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RecoverConfiguration -Recover the web app's configuration in addition to files. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: System.String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Slot -The name of the web app slot. - -```yaml -Type: System.String -Parameter Sets: FromResourceName -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WebApp -The web app object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: FromWebApp -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Management.Automation.SwitchParameter - -### System.String - -### Microsoft.Azure.Management.WebSites.Models.Site -Parameters: WebApp (ByValue) - -### Microsoft.Azure.Commands.WebApps.Cmdlets.BackupRestore.AzureWebAppSnapshot -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Websites/Set-AzureRmAppServicePlan.md b/azurermps-6.13.0/AzureRM.Websites/Set-AzureRmAppServicePlan.md deleted file mode 100644 index 35d1785e5f..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Set-AzureRmAppServicePlan.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: 32D45795-FBCD-4157-BF45-41BD1F61782E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/set-azurermappserviceplan -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Set-AzureRmAppServicePlan.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Set-AzureRmAppServicePlan.md ---- - -# Set-AzureRmAppServicePlan - -## SYNOPSIS -Sets an Azure App Service plan. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Set-AzureRmAppServicePlan [[-AdminSiteName] <String>] [[-Tier] <String>] [[-NumberofWorkers] <Int32>] - [[-WorkerSize] <String>] [-PerSiteScaling <Boolean>] [-AsJob] [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -Set-AzureRmAppServicePlan [-AsJob] [-AppServicePlan] <PSAppServicePlan> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmAppServicePlan** cmdlet sets an Azure App Service plan. - -## EXAMPLES - -### 1: Modify an App Service plan -``` -PS C:\>Set-AzureRmAppServicePlan -ResourceGroupName "Default-Web-WestUS" -Name "ContosoASP" -PerSiteScaling $true -``` - -This command sets the PerSiteScaling option to true on the App Service plan named ContosoASP - that belongs to the resource group named Default-Web-WestUS. - -## PARAMETERS - -### -AdminSiteName -Admin Site Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AppServicePlan -App Service Plan Object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.WebApp.PSAppServicePlan -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -App Service Plan Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumberofWorkers -Number Of Workers - -```yaml -Type: System.Int32 -Parameter Sets: S1 -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PerSiteScaling -Per Site Scaling Boolean - -```yaml -Type: System.Boolean -Parameter Sets: S1 -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tier -Tier - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkerSize -Worker Size - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.WebSites.Models.AppServicePlan -Parameters: AppServicePlan (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Management.WebSites.Models.AppServicePlan - -## NOTES - -## RELATED LINKS - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) - -[New-AzureRmWebApp](./New-AzureRmWebApp.md) - -[Remove-AzureRmWebApp](./Remove-AzureRmWebApp.md) - -[Restart-AzureRmWebApp](./Restart-AzureRmWebApp.md) - -[Start-AzureRmWebApp](./Start-AzureRmWebApp.md) - -[Stop-AzureRmWebApp](./Stop-AzureRmWebApp.md) - - diff --git a/azurermps-6.13.0/AzureRM.Websites/Set-AzureRmWebApp.md b/azurermps-6.13.0/AzureRM.Websites/Set-AzureRmWebApp.md deleted file mode 100644 index 3829314040..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Set-AzureRmWebApp.md +++ /dev/null @@ -1,508 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: 4166119F-D26A-45A1-B040-D7B2459833D6 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/set-azurermwebapp -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Set-AzureRmWebApp.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Set-AzureRmWebApp.md ---- - -# Set-AzureRmWebApp - -## SYNOPSIS -Modifies an Azure Web App. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Set-AzureRmWebApp [[-AppServicePlan] <String>] [[-DefaultDocuments] <String[]>] - [[-NetFrameworkVersion] <String>] [[-PhpVersion] <String>] [[-RequestTracingEnabled] <Boolean>] - [[-HttpLoggingEnabled] <Boolean>] [[-DetailedErrorLoggingEnabled] <Boolean>] [[-AppSettings] <Hashtable>] - [[-ConnectionStrings] <Hashtable>] - [[-HandlerMappings] <System.Collections.Generic.IList`1[Microsoft.Azure.Management.WebSites.Models.HandlerMapping]>] - [[-ManagedPipelineMode] <String>] [[-WebSocketsEnabled] <Boolean>] [[-Use32BitWorkerProcess] <Boolean>] - [[-AutoSwapSlotName] <String>] [-ContainerImageName <String>] [-ContainerRegistryUrl <String>] - [-ContainerRegistryUser <String>] [-ContainerRegistryPassword <SecureString>] - [-EnableContainerContinuousDeployment <Boolean>] [-HostNames <String[]>] [-NumberOfWorkers <Int32>] [-AsJob] - [-AssignIdentity <Boolean>] [-HttpsOnly <Boolean>] [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -Set-AzureRmWebApp [[-Use32BitWorkerProcess] <Boolean>] [[-AutoSwapSlotName] <String>] - [-NumberOfWorkers <Int32>] [-AsJob] [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmWebApp** cmdlet sets an Azure Web App. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Set-AzureRmWebApp -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -HttpLoggingEnabled $true -``` - -This command sets HttpLoggingEnabled to true for Web App ContosoWebApp associated with the resource group Default-Web-WestUS - -## PARAMETERS - -### -AppServicePlan -App Service Plan Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AppSettings -App Settings HashTable - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: S1 -Aliases: - -Required: False -Position: 9 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignIdentity -Enable/disable MSI on an existing azure webapp or functionapp - -```yaml -Type: System.Boolean -Parameter Sets: S1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoSwapSlotName -Destination slot name for auto swap - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 15 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionStrings -Connection Strings HashTable - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: S1 -Aliases: - -Required: False -Position: 10 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContainerImageName -Container Image Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContainerRegistryPassword -Private Container Registry Password - -```yaml -Type: System.Security.SecureString -Parameter Sets: S1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContainerRegistryUrl -Private Container Registry Server Url - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContainerRegistryUser -Private Container Registry Username - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultDocuments -Default Documents String Array - -```yaml -Type: System.String[] -Parameter Sets: S1 -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DetailedErrorLoggingEnabled -Detailed Error Logging Enabled Boolean - -```yaml -Type: System.Boolean -Parameter Sets: S1 -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableContainerContinuousDeployment -Enables/Disables container continuous deployment webhook - -```yaml -Type: System.Boolean -Parameter Sets: S1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HandlerMappings -Handler Mappings IList - -```yaml -Type: System.Collections.Generic.IList`1[Microsoft.Azure.Management.WebSites.Models.HandlerMapping] -Parameter Sets: S1 -Aliases: - -Required: False -Position: 11 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostNames -WebApp HostNames String Array - -```yaml -Type: System.String[] -Parameter Sets: S1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpLoggingEnabled -HttpLoggingEnabled Boolean - -```yaml -Type: System.Boolean -Parameter Sets: S1 -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpsOnly -Enable/disable redirecting all traffic to HTTPS on an existing azure webapp or functionapp - -```yaml -Type: System.Boolean -Parameter Sets: S1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedPipelineMode -Managed Pipeline Mode Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: -Accepted values: Classic, Integrated - -Required: False -Position: 12 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetFrameworkVersion -Net Framework Version - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumberOfWorkers -The number of workers to be allocated - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PhpVersion -Php Version - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestTracingEnabled -Request Tracing Enabled - -```yaml -Type: System.Boolean -Parameter Sets: S1 -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Use32BitWorkerProcess -Use 32-bit Worker Process Boolean - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 14 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WebSocketsEnabled -WebSocketsEnabled Boolean - -```yaml -Type: System.Boolean -Parameter Sets: S1 -Aliases: - -Required: False -Position: 13 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Int32 -Parameters: NumberOfWorkers (ByValue) - -### System.String - -### Microsoft.Azure.Management.WebSites.Models.Site -Parameters: WebApp (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Management.WebSites.Models.Site - -## NOTES - -## RELATED LINKS - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) - -[New-AzureRmWebApp](./New-AzureRmWebApp.md) - -[Remove-AzureRmWebApp](./Remove-AzureRmWebApp.md) - -[Restart-AzureRmWebApp](./Restart-AzureRmWebApp.md) - -[Start-AzureRmWebApp](./Start-AzureRmWebApp.md) - -[Stop-AzureRmWebApp](./Stop-AzureRmWebApp.md) diff --git a/azurermps-6.13.0/AzureRM.Websites/Set-AzureRmWebAppSlot.md b/azurermps-6.13.0/AzureRM.Websites/Set-AzureRmWebAppSlot.md deleted file mode 100644 index fd7f137b25..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Set-AzureRmWebAppSlot.md +++ /dev/null @@ -1,515 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: FA868206-D8B0-4868-A1D1-D3F96BF3ADCC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/set-azurermwebappslot -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Set-AzureRmWebAppSlot.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Set-AzureRmWebAppSlot.md ---- - -# Set-AzureRmWebAppSlot - -## SYNOPSIS -Modifies an Azure Web App slot. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Set-AzureRmWebAppSlot [[-AppServicePlan] <String>] [[-DefaultDocuments] <String[]>] - [[-NetFrameworkVersion] <String>] [[-PhpVersion] <String>] [[-RequestTracingEnabled] <Boolean>] - [[-HttpLoggingEnabled] <Boolean>] [[-DetailedErrorLoggingEnabled] <Boolean>] [[-AppSettings] <Hashtable>] - [[-ConnectionStrings] <Hashtable>] - [[-HandlerMappings] <System.Collections.Generic.IList`1[Microsoft.Azure.Management.WebSites.Models.HandlerMapping]>] - [[-ManagedPipelineMode] <String>] [[-WebSocketsEnabled] <Boolean>] [[-Use32BitWorkerProcess] <Boolean>] - [-AutoSwapSlotName <String>] [-NumberOfWorkers <Int32>] [-ContainerImageName <String>] - [-ContainerRegistryUrl <String>] [-ContainerRegistryUser <String>] [-ContainerRegistryPassword <SecureString>] - [-EnableContainerContinuousDeployment <Boolean>] [-AsJob] [-AssignIdentity <Boolean>] [-HttpsOnly <Boolean>] - [-ResourceGroupName] <String> [-Name] <String> [-Slot] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### S2 -``` -Set-AzureRmWebAppSlot [[-AppServicePlan] <String>] [[-DefaultDocuments] <String[]>] - [[-NetFrameworkVersion] <String>] [[-PhpVersion] <String>] [[-RequestTracingEnabled] <Boolean>] - [[-HttpLoggingEnabled] <Boolean>] [[-DetailedErrorLoggingEnabled] <Boolean>] [[-AppSettings] <Hashtable>] - [[-ConnectionStrings] <Hashtable>] - [[-HandlerMappings] <System.Collections.Generic.IList`1[Microsoft.Azure.Management.WebSites.Models.HandlerMapping]>] - [[-ManagedPipelineMode] <String>] [[-WebSocketsEnabled] <Boolean>] [[-Use32BitWorkerProcess] <Boolean>] - [-AutoSwapSlotName <String>] [-NumberOfWorkers <Int32>] [-AsJob] [-WebApp] <PSSite> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmWebApp** cmdlet sets an Azure Web App Slot. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Set-AzureRmWebAppSlot -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -Slot "Slot001" -HttpLoggingEnabled $true -``` - -This command sets HttpLoggingEnabled to true for Slot Slot001 pertaining to Web App ContosoWebApp associated with the resource group Default-Web-WestUS - -## PARAMETERS - -### -AppServicePlan -App Service Plan Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AppSettings -App Settings HashTable - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 10 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignIdentity -Enable/disable MSI on an existing slot [PREVIEW] - -```yaml -Type: System.Boolean -Parameter Sets: S1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoSwapSlotName -Destination slot name for auto swap - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionStrings -Connection Strings HashTable - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 11 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContainerImageName -Container Image Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContainerRegistryPassword -Private Container Registry Password - -```yaml -Type: System.Security.SecureString -Parameter Sets: S1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContainerRegistryUrl -Private Container Registry Server Url - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContainerRegistryUser -Private Container Registry Username - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultDocuments -Default Documents String Array - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DetailedErrorLoggingEnabled -Detailed Error Logging Enabled Boolean - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 9 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableContainerContinuousDeployment -Enables/Disables container continuous deployment webhook - -```yaml -Type: System.Boolean -Parameter Sets: S1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HandlerMappings -Handler Mappings IList - -```yaml -Type: System.Collections.Generic.IList`1[Microsoft.Azure.Management.WebSites.Models.HandlerMapping] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 12 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpLoggingEnabled -HttpLoggingEnabled Boolean - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpsOnly -Enable/disable redirecting all traffic to HTTPS on an existing slot - -```yaml -Type: System.Boolean -Parameter Sets: S1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedPipelineMode -Managed Pipeline Mode Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Classic, Integrated - -Required: False -Position: 13 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetFrameworkVersion -Net Framework Version - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumberOfWorkers -The number of workers to be allocated - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PhpVersion -Php Version - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestTracingEnabled -Request Tracing Enabled Boolean - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Slot -WebApp Slot Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Use32BitWorkerProcess -Use 32-bit Worker Process Boolean - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 15 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WebSocketsEnabled -Web Sockets Enabled Boolean - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 14 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Int32 -Parameters: NumberOfWorkers (ByValue) - -### System.String - -### Microsoft.Azure.Management.WebSites.Models.Site -Parameters: WebApp (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Management.WebSites.Models.Site - -## NOTES - -## RELATED LINKS - -[Get-AzureRMWebAppSlot](./Get-AzureRMWebAppSlot.md) - -[New-AzureRMWebAppSlot](./New-AzureRMWebAppSlot.md) - -[Remove-AzureRMWebAppSlot](./Remove-AzureRMWebAppSlot.md) - -[Restart-AzureRMWebAppSlot](./Restart-AzureRMWebAppSlot.md) - -[Start-AzureRMWebAppSlot](./Start-AzureRMWebAppSlot.md) - -[Stop-AzureRMWebAppSlot](./Stop-AzureRMWebAppSlot.md) - -[Get-AzureRmAppServicePlan](./Get-AzureRmAppServicePlan.md) diff --git a/azurermps-6.13.0/AzureRM.Websites/Set-AzureRmWebAppSlotConfigName.md b/azurermps-6.13.0/AzureRM.Websites/Set-AzureRmWebAppSlotConfigName.md deleted file mode 100644 index 19a7750bb6..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Set-AzureRmWebAppSlotConfigName.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: 7DBF937E-2D01-4356-9A5F-C5A4CB6D1A10 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/set-azurermwebappslotconfigname -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Set-AzureRmWebAppSlotConfigName.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Set-AzureRmWebAppSlotConfigName.md ---- - -# Set-AzureRmWebAppSlotConfigName - -## SYNOPSIS -Set Web App Slot Config names - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Set-AzureRmWebAppSlotConfigName [[-AppSettingNames] <String[]>] [[-ConnectionStringNames] <String[]>] - [-RemoveAllAppSettingNames] [-RemoveAllConnectionStringNames] [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -Set-AzureRmWebAppSlotConfigName [[-AppSettingNames] <String[]>] [[-ConnectionStringNames] <String[]>] - [-RemoveAllAppSettingNames] [-RemoveAllConnectionStringNames] [-WebApp] <PSSite> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmWebAppSlotConfigName** cmdlet marks App Settings and Connection Strings as slot settings - -## EXAMPLES - -### 1: -``` -PS C:\> Set-AzureRmWebAppSlotConfigName -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -RemoveAllAppSettingNames -RemoveAllConnectionStringNames -``` - -This command removes all app settings and connection strings for Web App ContosoWebApp associated with the resource group Default-Web-WestUS - -## PARAMETERS - -### -AppSettingNames -App Settings Names String Array - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConnectionStringNames -Connection String Names String Array - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RemoveAllAppSettingNames -Remove All App Setting Names Option - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveAllConnectionStringNames -Remove All Connection String Names Option - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String[] - -### System.String - -### Microsoft.Azure.Management.WebSites.Models.Site -Parameters: WebApp (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Management.WebSites.Models.SlotConfigNamesResource - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Websites/Start-AzureRmWebApp.md b/azurermps-6.13.0/AzureRM.Websites/Start-AzureRmWebApp.md deleted file mode 100644 index fe9b705fd1..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Start-AzureRmWebApp.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: D70A61D8-0C9A-4BDB-A546-37C32D25797C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/start-azurermwebapp -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Start-AzureRmWebApp.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Start-AzureRmWebApp.md ---- - -# Start-AzureRmWebApp - -## SYNOPSIS -Starts an Azure Web App. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Start-AzureRmWebApp [-ResourceGroupName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### S2 -``` -Start-AzureRmWebApp [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Start-AzureRmWebApp** cmdlet starts an Azure Web App. - -## EXAMPLES - -### Example 1: Start a Web App -``` -PS C:\>Start-AzureRmWebApp -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -``` - -This command starts the Web App named ContosoWebApp that belongs to the resource group named Default-Web-WestUS. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Management.WebSites.Models.Site -Parameters: WebApp (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Management.WebSites.Models.Site - -## NOTES - -## RELATED LINKS - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) - -[New-AzureRmWebApp](./New-AzureRmWebApp.md) - -[Remove-AzureRmWebApp](./Remove-AzureRmWebApp.md) - -[Restart-AzureRmWebApp](./Restart-AzureRmWebApp.md) - -[Stop-AzureRmWebApp](./Stop-AzureRmWebApp.md) - - diff --git a/azurermps-6.13.0/AzureRM.Websites/Start-AzureRmWebAppSlot.md b/azurermps-6.13.0/AzureRM.Websites/Start-AzureRmWebAppSlot.md deleted file mode 100644 index 88af46e134..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Start-AzureRmWebAppSlot.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: 0FDDDEE1-CEAD-46DA-A7EB-EE477ED59749 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/start-azurermwebappslot -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Start-AzureRmWebAppSlot.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Start-AzureRmWebAppSlot.md ---- - -# Start-AzureRmWebAppSlot - -## SYNOPSIS -Starts an Azure Web App slot. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Start-AzureRmWebAppSlot [-ResourceGroupName] <String> [-Name] <String> [-Slot] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -Start-AzureRmWebAppSlot [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Start-AzureRmWebAppSlot** cmdlet starts an Azure Web App Slot. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Start-AzureRmWebAppSlot -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -Slot "Slot001" -``` - -This command starts the Slot named Slot001 pertaining to the Web App named ContosoWebApp that belongs to the resource group named Default-Web-WestUS. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Slot -WebApp Slot Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Management.WebSites.Models.Site -Parameters: WebApp (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Management.WebSites.Models.Site - -## NOTES - -## RELATED LINKS - -[Get-AzureRMWebAppSlot](./Get-AzureRMWebAppSlot.md) - -[New-AzureRMWebAppSlot](./New-AzureRMWebAppSlot.md) - -[Remove-AzureRMWebAppSlot](./Remove-AzureRMWebAppSlot.md) - -[Restart-AzureRMWebAppSlot](./Restart-AzureRMWebAppSlot.md) - -[Set-AzureRMWebAppSlot](./Set-AzureRMWebAppSlot.md) - -[Stop-AzureRMWebAppSlot](./Stop-AzureRMWebAppSlot.md) - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) diff --git a/azurermps-6.13.0/AzureRM.Websites/Stop-AzureRmWebApp.md b/azurermps-6.13.0/AzureRM.Websites/Stop-AzureRmWebApp.md deleted file mode 100644 index 2c16746b7a..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Stop-AzureRmWebApp.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: A12FFDB1-9849-4150-9716-068BE6EFC681 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/stop-azurermwebapp -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Stop-AzureRmWebApp.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Stop-AzureRmWebApp.md ---- - -# Stop-AzureRmWebApp - -## SYNOPSIS -Stops an Azure Web App. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Stop-AzureRmWebApp [-ResourceGroupName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### S2 -``` -Stop-AzureRmWebApp [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Stop-AzureRmWebApp** cmdlet stops an Azure Web App. - -## EXAMPLES - -### Example 1: Stop a Web App -``` -PS C:\>Stop-AzureRmWebApp -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -``` - -This command stops the Web App named ContosoWebApp that belongs to the resource group named Default-Web-WestUS. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Management.WebSites.Models.Site -Parameters: WebApp (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Management.WebSites.Models.Site - -## NOTES - -## RELATED LINKS - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) - -[New-AzureRmWebApp](./New-AzureRmWebApp.md) - -[Remove-AzureRmWebApp](./Remove-AzureRmWebApp.md) - -[Restart-AzureRmWebApp](./Restart-AzureRmWebApp.md) - -[Start-AzureRmWebApp](./Start-AzureRmWebApp.md) - - diff --git a/azurermps-6.13.0/AzureRM.Websites/Stop-AzureRmWebAppSlot.md b/azurermps-6.13.0/AzureRM.Websites/Stop-AzureRmWebAppSlot.md deleted file mode 100644 index bed011070b..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Stop-AzureRmWebAppSlot.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: 86E0D477-DD32-49BD-82E7-1CF191E4F612 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/stop-azurermwebappslot -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Stop-AzureRmWebAppSlot.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Stop-AzureRmWebAppSlot.md ---- - -# Stop-AzureRmWebAppSlot - -## SYNOPSIS -Stops an Azure Web App slot. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Stop-AzureRmWebAppSlot [-ResourceGroupName] <String> [-Name] <String> [-Slot] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -Stop-AzureRmWebAppSlot [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Stop-AzureRmWebAppSlot** cmdlet stops an Azure Web App Slot. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Stop-AzureRmWebAppSlot -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -Slot "Slot001" -``` - -This command stops the slot Slot001 pertaining to the Web App named ContosoWebApp that belongs to the resource group named Default-Web-WestUS. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Slot -WebApp Slot Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Management.WebSites.Models.Site -Parameters: WebApp (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Management.WebSites.Models.Site - -## NOTES - -## RELATED LINKS diff --git a/azurermps-6.13.0/AzureRM.Websites/Switch-AzureRmWebAppSlot.md b/azurermps-6.13.0/AzureRM.Websites/Switch-AzureRmWebAppSlot.md deleted file mode 100644 index 0a210cd65f..0000000000 --- a/azurermps-6.13.0/AzureRM.Websites/Switch-AzureRmWebAppSlot.md +++ /dev/null @@ -1,216 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: 258A4EA9-B82C-4664-8DCE-30D47A623868 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/switch-azurermwebappslot -schema: 2.0.0 -content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Switch-AzureRmWebAppSlot.md -original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Websites/Commands.Websites/help/Switch-AzureRmWebAppSlot.md ---- - -# Switch-AzureRmWebAppSlot - -## SYNOPSIS -Swap two slots with a Web App - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Switch-AzureRmWebAppSlot [-SourceSlotName] <String> [[-DestinationSlotName] <String>] - [[-SwapWithPreviewAction] <SwapWithPreviewAction>] [[-PreserveVnet] <Boolean>] [-ResourceGroupName] <String> - [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### S2 -``` -Switch-AzureRmWebAppSlot [-SourceSlotName] <String> [[-DestinationSlotName] <String>] - [[-SwapWithPreviewAction] <SwapWithPreviewAction>] [[-PreserveVnet] <Boolean>] [-WebApp] <PSSite> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Switch-AzureRmWebAppSlot** switches two slots associated with an Azure Web App. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Switch-AzureRmWebAppSlot -SourceSlotName "sourceslot" -DestinationSlotName "destinationslot" -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -``` - -This command will switch slot "sourceslot" slot with "destinationslot" for Web App ContosoWebApp associated with the resource group Default-Web-WestUS - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationSlotName -Destination Slot Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PreserveVnet -Preserve Vnet Boolean - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: System.String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceSlotName -Source Slot Name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SwapWithPreviewAction -Swap With Preview Action - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Commands.WebApps.Utilities.SwapWithPreviewAction] -Parameter Sets: (All) -Aliases: -Accepted values: ApplySlotConfig, CompleteSlotSwap, ResetSlotSwap - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Microsoft.Azure.Commands.WebApps.Models.PSSite -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Management.WebSites.Models.Site -Parameters: WebApp (ByValue) - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS diff --git a/docfx.json b/docfx.json index 5fcbbef939..c579b6cd8e 100644 --- a/docfx.json +++ b/docfx.json @@ -13,10 +13,6 @@ { "files": ["**/*.yml"], "src": "azps-0.10.0", "version": "azps-0.10.0", "exclude": ["docs-conceptual/**"], "dest": "module" }, { "files": ["**/*.yml", "**/*.md"], "src": "docs-conceptual/azps-0.10.0", "version": "azps-0.10.0", "dest": "azure" }, - { "files": ["toc.yml"], "src": "azurermps-6.13.0", "version": "azurermps-6.13.0", "dest": "module/azure-rm" }, - { "files": ["**/*.yml"], "src": "azurermps-6.13.0", "version": "azurermps-6.13.0", "exclude": ["docs-conceptual/**"], "dest": "module" }, - { "files": ["**/*.yml", "**/*.md"], "src": "docs-conceptual/azurermps-6.13.0", "version": "azurermps-6.13.0", "dest": "azure/azurerm" }, - { "files": ["toc.yml"], "src": "azuresmps-4.0.0", "version": "azuresmps-4.0.0", "dest": "module/servicemanagement" }, { "files": ["**/*.yml"], "src": "azuresmps-4.0.0", "version": "azuresmps-4.0.0", "exclude": ["docs-conceptual/**"], "dest": "module/servicemanagement" }, { "files": ["**/*.yml", "**/*.md"], "src": "docs-conceptual/azuresmps-4.0.0", "version": "azuresmps-4.0.0", "dest": "azure/servicemanagement" }, @@ -34,14 +30,12 @@ "resource": [ { "files": ["media/**"], "version": "azps-12.5.0" }, { "files": ["media/**"], "version": "azps-13.0.0" }, - { "files": ["media/**"], "version": "azps-0.10.0" }, - { "files": ["media/**"], "version": "azurermps-6.13.0" } + { "files": ["media/**"], "version": "azps-0.10.0" } ], "versions": { "azps-12.5.0": { "dest": "azps-12.5.0" }, "azps-13.0.0": { "dest": "azps-13.0.0" }, "azps-0.10.0": { "dest": "azps-0.10.0" }, - "azurermps-6.13.0": { "dest": "azurermps-6.13.0" }, "azuresmps-4.0.0": { "dest": "azuresmps-4.0.0" } }, "filemetadata": { @@ -52,7 +46,6 @@ "ms.service": { "azuresmps-*/**/*.yml": "azure-asm", "docs-conceptual/azuresmps-*/**/*.md": "azure-asm", - "docs-conceptual/azurermps-*/**/*.md": "azure-powershell", "az*-*/**/*.yml": "azure-powershell", "az*-*/ApiManagement.ServiceManagement/*.yml": "azure-api-management", "az*-*/Azure.Storage/*.yml": "azure-storage", @@ -335,10 +328,6 @@ "https://authoring-docs-microsoft.poolparty.biz/devrel/68ec7f3a-2bc6-459f-b959-19beb729907d", "https://authoring-docs-microsoft.poolparty.biz/devrel/8bce367e-2e90-4b56-9ed5-5e4e9f3a2dc3" ], - "docs-conceptual/azurermps-*/**/*.md": [ - "https://authoring-docs-microsoft.poolparty.biz/devrel/8bce367e-2e90-4b56-9ed5-5e4e9f3a2dc3", - "https://authoring-docs-microsoft.poolparty.biz/devrel/8bce367e-2e90-4b56-9ed5-5e4e9f3a2dc3" - ], "az*-*/Azure.aks/*.md": [ "https://authoring-docs-microsoft.poolparty.biz/devrel/68ec7f3a-2bc6-459f-b959-19beb729907d", "https://authoring-docs-microsoft.poolparty.biz/devrel/8bce367e-2e90-4b56-9ed5-5e4e9f3a2dc3" @@ -410,7 +399,6 @@ }, "ms.topic": { "azps-*/**/*": "reference", - "azurermps-*/**/*": "reference", "azuresmps-*/**/*": "reference", "docs-conceptual/**/*": "conceptual" }, @@ -418,11 +406,9 @@ "azps-13.0.0/**/*": "11/19/2024", "azps-12.5.0/**/*": "11/11/2024", "azps-0.10.0/**/*": "4/14/2020", - "azurermps-6.13.0/**/*": "03/23/2021", "azuresmps-4.0.0/**/*": "11/28/2020" }, "enable_powershell_try_it": { - "azurermps-*/**/*.yml": false, "azps-*/**/*.yml": true }, "searchScope": { @@ -438,8 +424,6 @@ "az*-*/Az*.Websites/*.yml": ["App Service", "Azure", "Azure Powershell"] }, "ROBOTS": { - "azurermps-*/**/*": "NOINDEX, NOFOLLOW", - "docs-conceptual/azurermps-*/**/*": "NOINDEX, NOFOLLOW", "azuresmps-*/**/*": "NOINDEX, NOFOLLOW", "docs-conceptual/azuresmps-*/**/*": "NOINDEX, NOFOLLOW" }, @@ -451,8 +435,6 @@ "aztools/**/*": "OpenSource", "azps-0.10.0/**/*": "None", "docs-conceptual/azps-0.10.0/*": "None", - "azurermps-6.13.0/**/*": "None", - "docs-conceptual/azurermps-6.13.0/*": "None", "azuresmps-4.0.0/**/*": "None", "docs-conceptual/azuresmps-4.0.0/*": "None" }, diff --git a/docs-conceptual/azurermps-6.13.0/authenticate-azureps.md b/docs-conceptual/azurermps-6.13.0/authenticate-azureps.md deleted file mode 100644 index d3220f133f..0000000000 --- a/docs-conceptual/azurermps-6.13.0/authenticate-azureps.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -title: Sign into Azure with the AzureRM PowerShell module -description: How to sign into Azure with the AzureRM PowerShell module as a user, service principal, or with managed identities for Azure resources. -ms.devlang: powershell -ms.topic: conceptual - -ms.custom: ---- -# Sign into Azure with the AzureRM PowerShell module - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -Azure PowerShell supports several authentication methods. The simplest way to get started is to sign -in interactively at the command line. - -## Sign in interactively - -To sign in interactively, use the -[Connect-AzureRmAccount](/powershell/module/azurerm.profile/connect-azurermaccount) cmdlet. - -```azurepowershell-interactive -Connect-AzureRmAccount -``` - -When run, this cmdlet will bring up a dialog box prompting you for your email address and password -associated with your Azure account. This authentication lasts for the current PowerShell session. - -> [!IMPORTANT] -> As of Azure PowerShell 6.3.0, your credentials are shared among multiple PowerShell sessions as -> long as you remain signed in to Windows. For more information, see the article on -> [Persistent Credentials](context-persistence.md). - -## Sign in with a service principal - -Service principals are non-interactive Azure accounts. Like other user accounts, their permissions -are managed with Microsoft Entra ID. By granting a service principal only the permissions it -needs, your automation scripts stay secure. - -To learn how to create a service principal for use with Azure PowerShell, see -[Create an Azure service principal with Azure PowerShell](create-azure-service-principal-azureps.md). - -To sign in with a service principal, use the `ServicePrincipal` argument with the -`Connect-AzureRmAccount` cmdlet. You'll also need the service principal's sign-in credentials and -the tenant ID associated with the service principal. To get the service principal's credentials as -the appropriate object, use the -[Get-Credential](/powershell/module/microsoft.powershell.security/get-credential) cmdlet. This -cmdlet will display a dialog box to enter the service principal user ID and password into. - -```azurepowershell -$pscredential = Get-Credential -Connect-AzureRmAccount -ServicePrincipal -Credential $pscredential -TenantId $tenantid -``` - -## Sign in using an Azure Managed Service Identity - -Managed identities for Azure resources is a feature of Microsoft Entra ID. You can use a managed -identity service principal for sign-in, and acquire an app-only access token to access other -resources. Managed identities are only available on virtual machines running in an Azure cloud. - -For more information about managed identities for Azure resources, see -[How to use managed identities for Azure resources on an Azure VM to acquire an access token](/azure/active-directory/managed-identities-azure-resources/how-to-use-vm-token). - -## Sign in as a Cloud Solution Provider (CSP) - -A [Cloud Solution Provider (CSP)](https://azure.microsoft.com/offers/ms-azr-0145p/) sign-in requires -the use of `TenantId`. Normally, this parameter can be provided as either a tenant ID or a domain -name. However, for CSP sign-in, it must be provided a **tenant ID**. - -```azurepowershell -Connect-AzureRmAccount -TenantId '00001111-aaaa-2222-bbbb-3333cccc4444' -``` - -## Sign in to another Cloud - -Azure cloud services offer environments compliant with regional data-handling regulations. For -accounts in a regional cloud, set the environment when you sign in with the `-Environment` argument. -For example, if your account is in the China cloud: - -```azurepowershell -Connect-AzureRmAccount -Environment AzureChinaCloud -``` - -The following command gets a list of available environments: - -```azurepowershell -Get-AzureRmEnvironment | Select-Object -Property Name -``` - -## Learn more about managing Azure role-based access - -For more information about authentication and subscription management in Azure, see -[Manage Accounts, Subscriptions, and Administrative Roles](/azure/active-directory/role-based-access-control-configure). - -Azure PowerShell cmdlets for role management: - -* [Get-AzureRmRoleAssignment](/powershell/module/AzureRM.Resources/Get-AzureRmRoleAssignment) -* [Get-AzureRmRoleDefinition](/powershell/module/AzureRM.Resources/Get-AzureRmRoleDefinition) -* [New-AzureRmRoleAssignment](/powershell/module/AzureRM.Resources/New-AzureRmRoleAssignment) -* [New-AzureRmRoleDefinition](/powershell/module/AzureRM.Resources/New-AzureRmRoleDefinition) -* [Remove-AzureRmRoleAssignment](/powershell/module/AzureRM.Resources/Remove-AzureRmRoleAssignment) -* [Remove-AzureRmRoleDefinition](/powershell/module/AzureRM.Resources/Remove-AzureRmRoleDefinition) -* [Set-AzureRmRoleDefinition](/powershell/module/AzureRM.Resources/Set-AzureRmRoleDefinition) diff --git a/docs-conceptual/azurermps-6.13.0/azureps-vm-tutorial.yml b/docs-conceptual/azurermps-6.13.0/azureps-vm-tutorial.yml deleted file mode 100644 index c3c57d00cd..0000000000 --- a/docs-conceptual/azurermps-6.13.0/azureps-vm-tutorial.yml +++ /dev/null @@ -1,333 +0,0 @@ -### YamlMime:Tutorial -title: Create virtual machines with the AzureRM PowerShell module -metadata: - title: Create virtual machines with the AzureRM PowerShell module - description: Get started with the AzureRM PowerShell module by creating virtual machines. - audience: Developer - level: Beginner - displayType: two-column - interactive: azurepowershell - ms.date: 06/22/2023 - ms.devlang: powershell - ms.custom: devx-track-azurepowershell - ms.service: azure-powershell - clicktale: true -items: - - durationInMinutes: 1 - content: |- - - [!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - - In this tutorial, you learn all of the steps involved in setting up a virtual machine with - Azure PowerShell. The tutorial also covers output queries, Azure resource reuse, and - resource cleanup. - - This tutorial can be completed with the interactive experience offered through Azure Cloud - Shell, or you may [install Azure PowerShell](install-azurerm-ps.md) locally. - - Use __ctrl-shift-v__ (__cmd-shift-v__ on macOS) to paste tutorial text into Azure Cloud - Shell. - - - durationInMinutes: 1 - title: Sign in - content: |- - If you're using a local install of the Azure PowerShell, you need to sign in before - performing any other steps. - - ```azurepowershell-interactive - Connect-AzureRmAccount - ``` - - Complete the sign in process by following the steps displayed in your terminal. - - - durationInMinutes: 1 - title: Create a resource group - content: |- - In Azure, all resources are allocated in a resource management group. Resource groups - provide logical groupings of resources that make them easier to work with as a collection. - For this tutorial, all of the created resources go into a single group named - `TutorialResources`. - - ```azurepowershell-interactive - New-AzureRmResourceGroup -Name TutorialResources -Location eastus - ``` - - ```Output - ResourceGroupName : TutorialResources - Location : eastus - ProvisioningState : Succeeded - Tags : - ResourceId : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/TutorialResources - ``` - - - durationInMinutes: 1 - title: Create admin credentials for the VM - content: |- - Before you can create a new virtual machine, you must create a credential object containing - the username and password for the administrator account of the Windows VM. - - ```powershell-interactive - $cred = Get-Credential -Message "Enter a username and password for the virtual machine." - ``` - - Enter the username and password when prompted. The resulting credential object is passed as - a parameter in the next step. - - ```Output - Windows PowerShell credential request. - Enter a username and password for the virtual machine. - User: tutorAdmin - Password for user tutorAdmin: ********* - ``` - - - durationInMinutes: 4 - title: Create a virtual machine - content: |- - Virtual machines in Azure have a large number of dependencies. The Azure PowerShell creates - these resources for you based on the command-line arguments you specify. For readability, we - are using [PowerShell splatting](/powershell/module/microsoft.powershell.core/about/about_splatting) - to pass parameters to the Azure PowerShell cmdlets. - - Create a new virtual machine running Windows. - - ```azurepowershell-interactive - $vmParams = @{ - ResourceGroupName = 'TutorialResources' - Name = 'TutorialVM1' - Location = 'eastus' - ImageName = 'Win2016Datacenter' - PublicIpAddressName = 'tutorialPublicIp' - Credential = $cred - OpenPorts = 3389 - } - $newVM1 = New-AzureRmVM @vmParams - ``` - As the VM is created, you see the parameter values used and Azure resources being created. - PowerShell will displace a progress bar as shown below. - - ```Output - Creating Azure resources - 39% \ - [ooooooooooooooooooooooooooooooooooo ] - - Creating TutorialVM1 virtual machine. - ``` - - Once the VM is ready, we can view the results in the Azure Portal or by inspecting the - \$newVM1 variable. - - ```azurepowershell-interactive - $newVM1 - ``` - - ```Output - ResourceGroupName : TutorialResources - Id : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/TutorialResources/providers/Microsoft.Compute/virtualMachines/TutorialVM1 - VmId : 12345678-9abc-def0-1234-56789abcedf0 - Name : TutorialVM1 - Type : Microsoft.Compute/virtualMachines - Location : eastus - Tags : {} - HardwareProfile : {VmSize} - NetworkProfile : {NetworkInterfaces} - OSProfile : {ComputerName, AdminUsername, WindowsConfiguration, Secrets} - ProvisioningState : Succeeded - StorageProfile : {ImageReference, OsDisk, DataDisks} - ``` - - Property values listed inside of braces are nested objects. In the next step we will show you - how to view specific values in these nested objects. - - - durationInMinutes: 5 - title: Get VM information with queries - content: |- - Let's get some more detailed information from the VM we just created. In this example, we verify - the Name of the VM and the admin account we created. - - ```azurepowershell-interactive - $newVM1.OSProfile | Select-Object -Property ComputerName, AdminUserName - ``` - - ```Output - ComputerName AdminUsername - ------------ ------------- - TutorialVM1 tutorialAdmin - ``` - - We can use other Azure PowerShell commands to get specific information about the network - configuration. - - ```azurepowershell-interactive - $newVM1 | Get-AzureRmNetworkInterface | - Select-Object -ExpandProperty IpConfigurations | - Select-Object Name,PrivateIpAddress - ``` - - In this example we are using the PowerShell pipeline to send the \$newVM1 object to the - `Get-AzureRmNetworkInterface` cmdlet. From the resulting network interface object we are - selecting the nested IpConfigurations object. From the IpConfigurations object we are - selecting the Name and PrivateIpAddress properties. - - ```Output - Name PrivateIpAddress - ---- ---------------- - TutorialVM1 192.168.1.4 - ``` - - To confirm that the VM is running, we need to connect via Remote Desktop. For that, we need - to know the Public IP address. - - ```azurepowershell-interactive - $publicIp = Get-AzureRmPublicIpAddress -Name tutorialPublicIp -ResourceGroupName TutorialResources - - $publicIp | Select-Object Name,IpAddress,@{label='FQDN';expression={$_.DnsSettings.Fqdn}} - ``` - - In this example, we use the `Get-AzureRmPublicIpAddress` and store the results in the - \$publicIp variable. From this variable we are selecting properties and using an expression - to retrieve the nested Fqdn property. - - ```Output - Name IpAddress FQDN - ---- --------- ---- - tutorialPublicIp <PUBLIC_IP_ADDRESS> tutorialvm1-8a0999.eastus.cloudapp.azure.com - ``` - - From your local machine you can run the following command to connect to the VM over Remote - Desktop. - - ```powershell-interactive - mstsc.exe /v <PUBLIC_IP_ADDRESS> - ``` - - For more information about querying for object properties, see - [Querying for Azure resources](./queries-azureps.md). - - - durationInMinutes: 4 - title: Creating a new VM on the existing subnet - content: |- - The second VM uses the existing subnet. - - ```azurepowershell-interactive - $vm2Params = @{ - ResourceGroupName = 'TutorialResources' - Name = 'TutorialVM2' - ImageName = 'Win2016Datacenter' - VirtualNetworkName = 'TutorialVM1' - SubnetName = 'TutorialVM1' - PublicIpAddressName = 'tutorialPublicIp2' - Credential = $cred - OpenPorts = 3389 - } - $newVM2 = New-AzureRmVM @vm2Params - - $newVM2 - ``` - - ```Output - ResourceGroupName : TutorialResources - Id : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/TutorialResources/providers/Microsoft.Compute/virtualMachines/TutorialVM2 - VmId : 12345678-9abc-def0-1234-56789abcedf1 - Name : TutorialVM2 - Type : Microsoft.Compute/virtualMachines - Location : eastus - Tags : {} - HardwareProfile : {VmSize} - NetworkProfile : {NetworkInterfaces} - OSProfile : {ComputerName, AdminUsername, WindowsConfiguration, Secrets} - ProvisioningState : Succeeded - StorageProfile : {ImageReference, OsDisk, DataDisks} - FullyQualifiedDomainName : tutorialvm2-dfa5af.eastus.cloudapp.azure.com - ``` - - You can skip a few steps to get the public IP address of the new VM since it's returned in - the FullyQualifiedDomainName property of the \$newVM2 object. Use the following command to - connect using Remote Desktop. - - ```powershell-interactive - mstsc.exe /v $newVM2.FullyQualifiedDomainName - ``` - - - durationInMinutes: 4 - title: Cleanup - content: |- - Now that the tutorial is complete, it's time to clean up the created resources. You can - delete individual resources with the `Remove-AzureRmResource` command, but the safest way - to remove all resources in a resource group is delete the group using the - `Remove-AzureRmResourceGroup` command. - - ```azurepowershell-interactive - $job = Remove-AzureRmResourceGroup -Name TutorialResources -Force -AsJob - - $job - ``` - - ```Output - Id Name PSJobTypeName State HasMoreData Location Command - -- ---- ------------- ----- ----------- -------- ------- - 1 Long Running... AzureLongRun... Running True localhost Remove-AzureRmResource... - ``` - - This command deletes the resources created during the tutorial, and is guaranteed to deallocate - them in the correct order. The `-AsJob` parameter keeps PowerShell from blocking while the - deletion takes place. To wait until the deletion is complete, use the following command: - - ```powershell-interactive - Wait-Job -Id $job.Id - ``` - - With cleanup completed, the tutorial is finished. Continue on for a summary of everything - you learned and links to resources that will help you with your next steps. - - - durationInMinutes: 1 - title: Summary - content: |- - - Congratulations! You learned how to create VMs with new or existing resources, used - expressions and other Azure PowerShell commands to capture data to be stored in shell - variables, and looked at some of the resources that get created for Azure VMs. - - Where you go from here depends on how you plan to use Azure PowerShell. There are a variety - of materials that go further in depth on the features covered in this tutorial. - - ### In-depth Azure PowerShell documentation - - You might want to take time to explore the complete [Azure PowerShell documentation](overview.md) set. - - For more information about the commands used in this tutorial, see the following articles. - - - [New-AzureRmResourceGroup](/powershell/module/azurerm.resources/new-azurermresourcegroup) - - [Get-Credential](/powershell/module/microsoft.powershell.security/get-credential) - - [New-AzureRmVM](/powershell/module/azurerm.compute/new-azurermvm) - - [Select-Object](/powershell/module/microsoft.powershell.utility/select-object) - - [Get-AzureRmPublicIpAddress](/powershell/module/azurerm.network/get-AzureRmPublicIpAddress) - - [Remove-AzureRmResourceGroup](/powershell/module/azurerm.resources/Remove-AzureRmResourceGroup) - - [Wait-Job](/powershell/module/microsoft.powershell.core/wait-job) - - There are also articles that go deeper into the features that were shown in the tutorial. - - - [PowerShell splatting](/powershell/module/microsoft.powershell.core/about/about_splatting) - - [Queries](queries-azureps.md) - - [Formatting](formatting-output.md) - - [Using PowerShell jobs](using-psjobs.md) - - ### Sample scripts - - If you want to get started right away with specific tasks, look at some sample scripts. - - - [Linux Virtual Machines](/azure/virtual-machines/linux/powershell-samples?toc=%2fpowershell%2fmodule%2ftoc.json) - - [Windows Virtual Machines](/azure/virtual-machines/windows/powershell-samples?toc=%2fpowershell%2fmodule%2ftoc.json) - - [Web Apps](/azure/app-service-web/app-service-powershell-samples?toc=%2fpowershell%2fmodule%2ftoc.json) - - [SQL Databases](/azure/sql-database/sql-database-powershell-samples?toc=%2fpowershell%2fmodule%2ftoc.json) - - [Cosmos DB](/azure/cosmos-db/powershell-samples?toc=%2fpowershell%2fmodules%2ftoc.json) - - ### Feedback - - If you'd like to give feedback, suggestions, or ask questions, there are a number of ways - for you to get in touch. - - * `Send-Feedback` is a built-in command for Azure PowerShell that allows you to provide free-form feedback to the team. - * File a feature request or a bug report in the [Azure PowerShell repository](https://github.com/Azure/azure-powershell/issues). - * Ask a question or get clarification by filing an issue in the [Azure PowerShell documentation repository](https://github.com/MicrosoftDocs/azure-docs-powershell/issues). - - We hope that you enjoy using the Azure PowerShell! diff --git a/docs-conceptual/azurermps-6.13.0/context-persistence.md b/docs-conceptual/azurermps-6.13.0/context-persistence.md deleted file mode 100644 index d5936d9c3a..0000000000 --- a/docs-conceptual/azurermps-6.13.0/context-persistence.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -title: Persist user credentials across PowerShell sessions -description: Learn how to reuse Azure credentials and other information across multiple PowerShell sessions. -ms.devlang: powershell -ms.topic: conceptual - -ms.custom: devx-track-azurepowershell ---- -# Persist user credentials across PowerShell sessions - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -Azure PowerShell offers a feature called **Azure Context Autosave**, which gives the following features: - -- Retention of sign-in information for reuse in new PowerShell sessions. -- Easier use of background tasks for executing long-running cmdlets. -- Switch between accounts, subscriptions, and environments without a separate sign-in. -- Execution of tasks using different credentials and subscriptions, simultaneously, from the same - PowerShell session. - -## Azure contexts defined - -An *Azure context* is a set of information that defines the target of Azure PowerShell cmdlets. The -context consists of five parts: - -- An *Account* - the UserName or Service Principal used to authenticate communications with Azure -- A *Subscription* - The Azure Subscription with the Resources being acted upon. -- A *Tenant* - The Microsoft Entra tenant that contains your subscription. Tenants are more - important to ServicePrincipal authentication. -- An *Environment* - The particular Azure Cloud being targeted, usually the Azure global Cloud. - However, the environment setting allows you to target National, Government, and on-premises - (Azure Stack) clouds as well. -- *Credentials* - The information used by Azure to verify your identity and confirm your - authorization to access resources in Azure - -In previous releases, an Azure Context had to be created each time you opened a new PowerShell -session. Beginning with Azure PowerShell v4.4.0, Azure Contexts can automatically be saved whenever opening -a new PowerShell session. - -## Automatically save the context for the next sign-in - -In versions 6.3.0 and later, Azure PowerShell retains your context information automatically between -sessions. To set PowerShell to forget your context and credentials, use -`Disable-AzureRmContextAutoSave`. You'll need to sign in to Azure every time you open a PowerShell -session. - -To allow Azure PowerShell to remember your context after the PowerShell session is closed, use -`Enable-AzureRmContextAutosave`. Context and credential information are automatically saved in a -special hidden folder in your user directory (`%AppData%\Roaming\Windows Azure PowerShell`). Each -new PowerShell session targets the context used in your last session. - -The cmdlets that allow you to manage Azure contexts also allow you fine grained control. If you -want changes to apply only to the current PowerShell session (`Process` scope) or every PowerShell -session (`CurrentUser` scope). These options are discussed in mode detail in [Using Context -Scopes](#using-context-scopes). - -## Running Azure PowerShell cmdlets as background jobs - -The **Azure Context Autosave** feature also allows you to share you context with PowerShell -background jobs. PowerShell allows you to start and monitor long-executing tasks as background jobs -without having to wait for the tasks to complete. You can share credentials with background jobs in -two different ways: - -- Passing the context as an argument - - Most AzureRM cmdlets allow you to pass the context as a parameter to the cmdlet. You can pass a - context to a background job as shown in the following example: - - ```powershell - $job = Start-Job { param ($ctx) New-AzureRmVm -AzureRmContext $ctx [... Additional parameters ...]} -ArgumentList (Get-AzureRmContext) - ``` - -- Using the default context with Autosave enabled - - If you have enabled **Context Autosave**, background jobs automatically use the default saved - context. - - ```powershell - $job = Start-Job { New-AzureRmVm [... Additional parameters ...]} - ``` - -When you need to know the outcome of the background task, use `Get-Job` to check the job status and -`Wait-Job` to wait for the Job to complete. Use `Receive-Job` to capture or display the output of -the background job. For more information, see -[about_Jobs](/powershell/module/microsoft.powershell.core/about/about_jobs). - -## Creating, selecting, renaming, and removing contexts - -To create a context, you must be signed in to Azure. The `Connect-AzureRmAccount` cmdlet (or its -alias, `Login-AzureRmAccount`) sets the default context used by Azure PowerShell cmdlets, and allows -you to access any tenants or subscriptions allowed by your credentials. - -To add a new context after sign-in, use `Set-AzureRmContext` (or its alias, -`Select-AzureRmSubscription`). - -```azurepowershell -Set-AzureRMContext -Subscription 'Contoso Subscription 1' -Name 'Contoso1' -``` - -The previous example adds a new context targeting 'Contoso Subscription 1' using your current -credentials. The new context is named 'Contoso1'. If you don't provide a name for the context, a -default name, using the account ID and subscription ID is used. - -To rename an existing context, use the `Rename-AzureRmContext` cmdlet. For example: - -```azurepowershell -Rename-AzureRmContext '[user1@contoso.org; 123456-7890-1234-564321]' 'Contoso2' -``` - -This example renames the context with automatic name `[user1@contoso.org; 123456-7890-1234-564321]` -to the simple name 'Contoso2'. Cmdlets that manage contexts also use tab completion, allowing you -to quickly select the context. - -Finally, to remove a context, use the `Remove-AzureRmContext` cmdlet. For example: - -```azurepowershell -Remove-AzureRmContext Contoso2 -``` - -Forgets the context that was named 'Contoso2'. You can recreate this context using -`Set-AzureRmContext` - -## Removing credentials - -You can remove all credentials and associated contexts for a user or service principal using -`Disconnect-AzureRmAccount` (also known as `Logout-AzureRmAccount`). When executed without -parameters, the `Disconnect-AzureRmAccount` cmdlet removes all credentials and contexts associated -with the User or Service Principal in the current context. You may pass in a Username, Service -Principal Name, or context to target a particular principal. - -```azurepowershell -Disconnect-AzureRmAccount user1@contoso.org -``` - -## Using context scopes - -Occasionally, you may want to select, change, or remove a context in a PowerShell session without -impacting other sessions. To change the default behavior of context cmdlets, use the `Scope` -parameter. The `Process` scope overrides the default behavior by making it apply only for the -current session. Conversely `CurrentUser` scope changes the context in all sessions, instead of just -the current session. - -As an example, to change the default context in the current PowerShell session without impacting -other windows, or the context used the next time a session is opened, use: - -```azurepowershell -Select-AzureRmContext Contoso1 -Scope Process -``` - -## How the context autosave setting is remembered - -The context AutoSave setting is saved to the user Azure PowerShell directory -(`%AppData%\Roaming\Windows Azure PowerShell`). Some kinds of computer accounts may not have access -to this directory. For such scenarios, you can use the environment variable - -```azurepowershell -$env:AzureRmContextAutoSave=$true -``` - -When set to `$true`, the context is automatically saved. If set to `$false`, the context isn't saved. - -## Changes to the AzureRM.Profile module - -New cmdlets for managing context - -- [Enable-AzureRmContextAutosave][enable] - Allow saving the context between powershell sessions. - Any changes alter the global context. -- [Disable-AzureRmContextAutosave][disable] - Turn off autosaving the context. Each new PowerShell - session is required to sign in again. -- [Select-AzureRmContext][select] - Select a context as the default. All cmdlets use the - credentials in this context for authentication. -- [Disconnect-AzureRmAccount][remove-cred] - Remove all credentials and contexts associated with an - account. -- [Remove-AzureRmContext][remove-context] - Remove a named context. -- [Rename-AzureRmContext][rename] - Rename an existing context. - -Changes to existing profile cmdlets - -- [Add-AzureRmAccount][login] - Allow scoping of the sign-in to the process or the current user. - Allow naming the default context after authentication. -- [Import-AzureRmContext][import] - Allow scoping of the sign-in to the process or the current user. -- [Set-AzureRmContext][set-context] - Allow selection of existing named contexts, and scope changes - to the process or current user. - -<!-- Hyperlinks --> -[enable]: /powershell/module/azurerm.profile/Enable-AzureRmContextAutosave -[disable]: /powershell/module/azurerm.profile/Disable-AzureRmContextAutosave -[select]: /powershell/module/azurerm.profile/Select-AzureRmContext -[remove-cred]: /powershell/module/azurerm.profile/Disconnect-AzureRmAccount -[remove-context]: /powershell/module/azurerm.profile/Remove-AzureRmContext -[rename]: /powershell/module/azurerm.profile/Rename-AzureRmContext - -<!-- Updated cmdlets --> -[login]: /powershell/module/azurerm.profile/Connect-AzureRmAccount -[import]: /powershell/module/azurerm.profile/Import-AzureRmContext -[set-context]: /powershell/module/azurerm.profile/Set-AzureRmContext diff --git a/docs-conceptual/azurermps-6.13.0/create-azure-service-principal-azureps.md b/docs-conceptual/azurermps-6.13.0/create-azure-service-principal-azureps.md deleted file mode 100644 index 00630cf662..0000000000 --- a/docs-conceptual/azurermps-6.13.0/create-azure-service-principal-azureps.md +++ /dev/null @@ -1,258 +0,0 @@ ---- -title: Create an Azure service principal with Azure PowerShell -description: Learn how to create a service principal for your app or service with Azure PowerShell. -keywords: Azure PowerShell, Azure Active Directory, Azure Active directory, AD, RBAC -ms.devlang: powershell -ms.topic: conceptual - -ms.custom: devx-track-azurepowershell ---- -# Create an Azure service principal with Azure PowerShell - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -If you plan to manage your app or service with Azure PowerShell, you should run it under an Azure -Microsoft Entra service principal, rather than your own credentials. This article steps you -through creating a security principal with Azure PowerShell. - -> [!NOTE] -> You can also create a service principal through the Azure portal. Read -> [Use portal to create Active Directory application and service principal that can access resources](/azure/azure-resource-manager/resource-group-create-service-principal-portal) -> for more details. - -## What is a 'service principal'? - -An Azure service principal is a security identity used by user-created apps, services, and -automation tools to access specific Azure resources. Think of it as a 'user identity' (username and -password or certificate) with a specific role, and tightly controlled permissions. A service -principal should only need to do specific things, unlike a general user identity. It improves -security if you only grant it the minimum permissions level needed to perform its management tasks. - -## Verify your own permission level - -First, you must have sufficient permissions in both your Microsoft Entra ID and your Azure -subscription. You must be able to create an app in the Active Directory and assign a role to the -service principal. - -The easiest way to check whether your account has the right permissions is through the portal. See -[Check required permission in portal](/azure/azure-resource-manager/resource-group-create-service-principal-portal#required-permissions). - -## Create a service principal for your app - -Once signed in to your Azure account, you can create the service principal. You must have one -of the following ways to identify your deployed app: - -* The unique name of your deployed app, such as "MyDemoWebApp" in the following examples, or -* the Application ID, the unique GUID associated with your deployed app, service, or object - -### Get information about your application - -The `Get-AzureRmADApplication` cmdlet can be used to get information about your application. - -```azurepowershell -Get-AzureRmADApplication -DisplayNameStartWith MyDemoWebApp -``` - -```Output -DisplayName : MyDemoWebApp -ObjectId : 00001111-aaaa-2222-bbbb-3333cccc4444 -IdentifierUris : {http://MyDemoWebApp} -HomePage : http://www.contoso.com -Type : Application -ApplicationId : 00001111-aaaa-2222-bbbb-3333cccc4444 -AvailableToOtherTenants : False -AppPermissions : -ReplyUrls : {} -``` - -### Create a service principal for your application - -The `New-AzureRmADServicePrincipal` cmdlet is used to create the service principal. - -```azurepowershell -$servicePrincipal = New-AzureRmADServicePrincipal -ApplicationId 00001111-aaaa-2222-bbbb-3333cccc4444 -``` - -```Output -Secret : System.Security.SecureString -ServicePrincipalNames : {00001111-aaaa-2222-bbbb-3333cccc4444, http://MyDemoWebApp} -ApplicationId : 00001111-aaaa-2222-bbbb-3333cccc4444 -DisplayName : MyDemoWebApp -Id : 698138e7-d7b6-4738-a866-b4e3081a69e4 -AdfsId : -Type : ServicePrincipal -``` - -From here, you can either directly use the $servicePrincipal.Secret property in -Connect-AzureRmAccount (see "Sign in using the service principal" below), or you can convert this -SecureString to a plain text string for later usage: - -```powershell -$BSTR = [System.Runtime.InteropServices.Marshal]::SecureStringToBSTR($servicePrincipal.Secret) -$password = [System.Runtime.InteropServices.Marshal]::PtrToStringAuto($BSTR) -[Runtime.InteropServices.Marshal]::ZeroFreeBSTR($BSTR) -``` - -### Sign in using the service principal - -You can now sign in as the new service principal for your app using the *appId* you provided and -*password* that was automatically generated. You also need the Tenant ID for the service principal. -Your Tenant ID is displayed when you sign into Azure with your personal credentials. To sign in with -a service principal, use the following commands: - -```azurepowershell-interactive -$cred = New-Object System.Management.Automation.PSCredential ("00001111-aaaa-2222-bbbb-3333cccc4444", $servicePrincipal.Secret) -Connect-AzureRmAccount -Credential $cred -ServicePrincipal -TenantId 00000000-0000-0000-0000-000000000000 -``` - -After a successful sign-in you see output like: - -```Output -Environment : AzureCloud -Account : 00001111-aaaa-2222-bbbb-3333cccc4444 -TenantId : 00000000-0000-0000-0000-000000000000 -SubscriptionId : -SubscriptionName : -CurrentStorageAccount : -``` - -Congratulations! You can use these credentials to run your app. Next, you need to adjust the -permissions of the service principal. - -## Managing roles - -> [!NOTE] -> Azure Role-Based Access Control (RBAC) is a model for defining and managing roles for user and -> service principals. Roles have sets of permissions associated with them, which determine the -> resources a principal can read, access, write, or manage. For more information on RBAC and roles, -> see [RBAC: Built-in roles](/azure/active-directory/role-based-access-built-in-roles). - -Azure PowerShell provides the following cmdlets to manage role assignments: - -* [Get-AzureRmRoleAssignment](/powershell/module/azurerm.resources/get-azurermroleassignment) -* [New-AzureRmRoleAssignment](/powershell/module/azurerm.resources/new-azurermroleassignment) -* [Remove-AzureRmRoleAssignment](/powershell/module/azurerm.resources/remove-azurermroleassignment) - -The default role for a service principal is **Contributor**. It may not be the best choice -depending on the scope of your app's interactions with Azure services, given its broad permissions. -The **Reader** role is more restrictive and can be a good choice for read-only apps. You can view -details on role-specific permissions or create custom ones through the Azure portal. - -In this example, we add the **Reader** role to our prior example, and delete the **Contributor** -one: - -```azurepowershell -New-AzureRmRoleAssignment -ResourceGroupName myRG -ObjectId 698138e7-d7b6-4738-a866-b4e3081a69e4 -RoleDefinitionName Reader -``` - -```Output -RoleAssignmentId : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.Authorization/roleAssignments/818892f2-d075-46a1-a3a2-3a4e1a12fcd5 -Scope : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG -DisplayName : MyDemoWebApp -SignInName : -RoleDefinitionName : Reader -RoleDefinitionId : 00001111-aaaa-2222-bbbb-3333cccc4444 -ObjectId : 698138e7-d7b6-4738-a866-b4e3081a69e4 -ObjectType : ServicePrincipal -``` - -```azurepowershell -Remove-AzureRmRoleAssignment -ResourceGroupName myRG -ObjectId 698138e7-d7b6-4738-a866-b4e3081a69e4 -RoleDefinitionName Contributor -``` - -To view the current roles assigned: - -```azurepowershell -Get-AzureRmRoleAssignment -ResourceGroupName myRG -ObjectId 698138e7-d7b6-4738-a866-b4e3081a69e4 -``` - -```Output -RoleAssignmentId : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.Authorization/roleAssignments/0906bbd8-9982-4c03-8dae-aeaae8b13f9e -Scope : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG -DisplayName : MyDemoWebApp -SignInName : -RoleDefinitionName : Reader -RoleDefinitionId : 00001111-aaaa-2222-bbbb-3333cccc4444 -ObjectId : 698138e7-d7b6-4738-a866-b4e3081a69e4 -ObjectType : ServicePrincipal -``` - -Other Azure PowerShell cmdlets for role management: - -* [Get-AzureRmRoleDefinition](/powershell/module/azurerm.resources/Get-AzureRmRoleDefinition) -* [New-AzureRmRoleDefinition](/powershell/module/azurerm.resources/New-AzureRmRoleDefinition) -* [Remove-AzureRmRoleDefinition](/powershell/module/azurerm.resources/Remove-AzureRmRoleDefinition) -* [Set-AzureRmRoleDefinition](/powershell/module/azurerm.resources/Set-AzureRmRoleDefinition) - -## Change the credentials of the security principal - -It's a good security practice to review the permissions and update the password regularly. You may -also want to manage and modify the security credentials as your app changes. For example, we can -change the password of the service principal by creating a new password and removing the old one. - -### Add a new password for the service principal - -```azurepowershell -New-AzureRmADSpCredential -ServicePrincipalName http://MyDemoWebApp -``` - -```Output -Secret : System.Security.SecureString -StartDate : 11/16/2018 12:38:23 AM -EndDate : 11/16/2019 12:38:23 AM -KeyId : 00001111-aaaa-2222-bbbb-3333cccc4444 -Type : Password -``` - -### Get a list of credentials for the service principal - -```azurepowershell -Get-AzureRmADSpCredential -ServicePrincipalName http://MyDemoWebApp -``` - -```Output -StartDate EndDate KeyId Type ---------- ------- ----- ---- -3/8/2017 5:58:24 PM 3/8/2018 5:58:24 PM 00001111-aaaa-2222-bbbb-3333cccc4444 Password -5/5/2016 4:55:27 PM 5/5/2017 4:55:27 PM 00001111-aaaa-2222-bbbb-3333cccc4444 Password -``` - -### Remove the old password from the service principal - -```azurepowershell -Remove-AzureRmADSpCredential -ServicePrincipalName http://MyDemoWebApp -KeyId 00001111-aaaa-2222-bbbb-3333cccc4444 -``` - -```Output -Confirm -Are you sure you want to remove credential with keyId '00001111-aaaa-2222-bbbb-3333cccc4444' for -service principal objectId '698138e7-d7b6-4738-a866-b4e3081a69e4'. -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y -``` - -### Verify the list of credentials for the service principal - -```azurepowershell -Get-AzureRmADSpCredential -ServicePrincipalName http://MyDemoWebApp -``` - -```output -StartDate EndDate KeyId Type ---------- ------- ----- ---- -3/8/2017 5:58:24 PM 3/8/2018 5:58:24 PM 00001111-aaaa-2222-bbbb-3333cccc4444 Password -``` - -### Get information about the service principal - -```azurepowershell -$svcprincipal = Get-AzureRmADServicePrincipal -ObjectId 698138e7-d7b6-4738-a866-b4e3081a69e4 -$svcprincipal | Select-Object -Property * -``` - -```Output -ServicePrincipalNames : {http://MyDemoWebApp, 00001111-aaaa-2222-bbbb-3333cccc4444} -ApplicationId : 00001111-aaaa-2222-bbbb-3333cccc4444 -DisplayName : MyDemoWebApp -Id : 698138e7-d7b6-4738-a866-b4e3081a69e4 -Type : ServicePrincipal -``` diff --git a/docs-conceptual/azurermps-6.13.0/faq.md b/docs-conceptual/azurermps-6.13.0/faq.md deleted file mode 100644 index d09cc71c70..0000000000 --- a/docs-conceptual/azurermps-6.13.0/faq.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Frequently Asked Questions (FAQ) -description: Frequently Asked Questions about Azure PowerShell. -ms.devlang: powershell -ms.topic: conceptual - -ms.custom: devx-track-azurepowershell -ms.service: azure-powershell ---- - -# Frequently asked questions about Azure PowerShell - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## What is Azure PowerShell? - -Azure PowerShell is a set of cmdlets that allows you to manage Azure resources directly with -PowerShell. In December 2018, the Az PowerShell module became generally available. It's now the -recommended PowerShell module for interacting with Azure. To learn more about the Az PowerShell -module, see [Introducing the Az PowerShell module](/powershell/azure/new-azureps-module-az). - -## How do I disable breaking change warning messages in Azure PowerShell? - -To suppress the breaking change warning messages in Azure PowerShell, you'll need to set the -environment variable `SuppressAzurePowerShellBreakingChangeWarnings` to `true`. - -```powershell -Set-Item -Path Env:\SuppressAzurePowerShellBreakingChangeWarnings -Value $true -``` - -## How do I disable the AzureRM retirement warning message in Azure PowerShell? - -To suppress the AzureRM retirement warning message in Azure PowerShell, you'll need to set the -environment variable `SuppressAzureRmModulesRetiringWarning` to `true`. - -```powershell -Set-Item -Path Env:\SuppressAzureRmModulesRetiringWarning -Value $true -``` - -One disadvantage of the previous example is you'll need to run the command for each new PowerShell -session unless you add it to your PowerShell profile. - -To set the environment variable permanently, you can also use the following example. - -```powershell -[System.Environment]::SetEnvironmentVariable('SuppressAzureRmModulesRetiringWarning', 'true', [System.EnvironmentVariableTarget]::User) -``` diff --git a/docs-conceptual/azurermps-6.13.0/formatting-output.md b/docs-conceptual/azurermps-6.13.0/formatting-output.md deleted file mode 100644 index c83cc4f275..0000000000 --- a/docs-conceptual/azurermps-6.13.0/formatting-output.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -title: Format Azure PowerShell cmdlet output -description: How to format cmdlet output for Azure PowerShell. -ms.devlang: powershell -ms.topic: conceptual - -ms.custom: devx-track-azurepowershell ---- - -# Format AzurePowerShell cmdlet output - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -By default each Azure PowerShell cmdlet has predefined formatting of output making it easy to read. -PowerShell also provides the flexibility to adjust the output or convert the cmdlet output to a -different format with the following cmdlets: - -| Formatting | Conversion | -| ------------------------------------------------------------------------------ | -------------------------------------------------------------------------------- | -| [Format-Custom](/powershell/module/microsoft.powershell.utility/format-custom) | [ConvertTo-Csv](/powershell/module/microsoft.powershell.utility/convertto-csv) | -| [Format-List](/powershell/module/microsoft.powershell.utility/format-list) | [ConvertTo-Html](/powershell/module/microsoft.powershell.utility/convertto-html) | -| [Format-Table](/powershell/module/microsoft.powershell.utility/format-table) | [ConvertTo-Json](/powershell/module/microsoft.powershell.utility/convertto-json) | -| [Format-Wide](/powershell/module/microsoft.powershell.utility/format-wide) | [ConvertTo-Xml](/powershell/module/microsoft.powershell.utility/convertto-xml) | - -## Format examples - -In this example, we get a list of Azure VMs in our default subscription. The `Get-AzureRmVM` command -defaults output into a table format. - -```azurepowershell -Get-AzureRmVM -``` - -```output -ResourceGroupName Name Location VmSize OsType NIC ProvisioningState ------------------ ---- -------- ------ ------ --- ----------------- -MYWESTEURG MyUnbuntu1610 westeurope Standard_DS1_v2 Linux myunbuntu1610980 Succeeded -MYWESTEURG MyWin2016VM westeurope Standard_DS1_v2 Windows mywin2016vm880 Succeeded -``` - -If you would like to limit the columns returned you can use the `Format-Table` cmdlet. In the -following example, we get the same list of virtual machines but restrict the output to just the name -of the VM, the resource group, and the location of the VM. The `-Autosize` parameter sizes the -columns according to the size of the data. - -```azurepowershell -Get-AzureRmVM | - Format-Table -Property Name, ResourceGroupName, Location -AutoSize -``` - -```Output -Name ResourceGroupName Location ----- ----------------- -------- -MyUnbuntu1610 MYWESTEURG westeurope -MyWin2016VM MYWESTEURG westeurope -``` - -Output can also be formatted into a list. The following example shows this using the`Format-List` -cmdlet. - -```azurepowershell -Get-AzureRmVM | - Format-List -Property Name, VmId, Location, ResourceGroupName -``` - -```output -Name : MyUnbuntu1610 -VmId : 33422f9b-e339-4704-bad8-dbe094585496 -Location : westeurope -ResourceGroupName : MYWESTEURG - -Name : MyWin2016VM -VmId : 4650c755-fc2b-4fc7-a5bc-298d5c00808f -Location : westeurope -ResourceGroupName : MYWESTEURG -``` - -## Convert to other data types - -PowerShell also allows taking command output and converting it into multiple data formats. In the -following example, the `Select-Object` cmdlet is used to get attributes of the virtual machines in -our subscription and convert the output to CSV format for easy import into a database or -spreadsheet. - -```azurepowershell -Get-AzureRmVM | - Select-Object -Property ResourceGroupName, Id, VmId, Name, Location, ProvisioningState | - ConvertTo-Csv -NoTypeInformation -``` - -```Output -"ResourceGroupName","Id","VmId","Name","Location","ProvisioningState" -"MYWESTUERG","/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYWESTUERG/providers/Microsoft.Compute/virtualMachines/MyUnbuntu1610","33422f9b-e339-4704-bad8-dbe094585496","MyUnbuntu1610","westeurope","Succeeded" -"MYWESTUERG","/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYWESTUERG/providers/Microsoft.Compute/virtualMachines/MyWin2016VM","4650c755-fc2b-4fc7-a5bc-298d5c00808f","MyWin2016VM","westeurope","Succeeded" -``` - -Output can also be converted into the JSON format. The following example creates the same list of -VMs but changes the output format to JSON. - -```azurepowershell -Get-AzureRmVM | - Select-Object -Property ResourceGroupName, Id, VmId, Name, Location, ProvisioningState | - ConvertTo-Json -``` - -```Output -[ - { - "ResourceGroupName": "MYWESTEURG", - "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYWESTEURG/providers/Microsoft.Compute/virtualMachines/MyUnbuntu1610", - "VmId": "33422f9b-e339-4704-bad8-dbe094585496", - "Name": "MyUnbuntu1610", - "Location": "westeurope", - "ProvisioningState": "Succeeded" - }, - { - "ResourceGroupName": "MYWESTEURG", - "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYWESTEURG/providers/Microsoft.Compute/virtualMachines/MyWin2016VM", - "VmId": "4650c755-fc2b-4fc7-a5bc-298d5c00808f", - "Name": "MyWin2016VM", - "Location": "westeurope", - "ProvisioningState": "Succeeded" - } -] -``` diff --git a/docs-conceptual/azurermps-6.13.0/get-started-azureps.md b/docs-conceptual/azurermps-6.13.0/get-started-azureps.md deleted file mode 100644 index c8283813c4..0000000000 --- a/docs-conceptual/azurermps-6.13.0/get-started-azureps.md +++ /dev/null @@ -1,413 +0,0 @@ ---- -title: Get started with Azure PowerShell -description: "Learn more about: Get started with Azure PowerShell" -ms.devlang: powershell -ms.topic: conceptual - -ms.custom: devx-track-azurepowershell ---- - -# Get started with Azure PowerShell - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -Azure PowerShell is designed for managing and administering Azure resources from the command line, -and for building automation scripts that work against the Azure Resource Manager. You can use it in -your browser with [Azure Cloud Shell](/azure/cloud-shell/overview) or you install it on your -local machine. This article helps get you started with Azure PowerShell and teaches the core concepts behind it. - -## Install Azure PowerShell - -The first step is to make sure you have the latest version of the Azure PowerShell installed. For -information about the latest release, see the [release notes](./release-notes-azureps.md). - -1. [Install Azure PowerShell](install-azurerm-ps.md). - -1. To verify the installation was successful, run `Get-InstalledModule -Name AzureRM -AllVersions` - from PowerShell. - -## Azure Cloud Shell - -The simplest way to get started is to [launch Cloud Shell](/azure/cloud-shell/quickstart). - -1. Launch Cloud Shell from the top navigation of the Azure portal. - - ![Shell icon](~/media/get-started-azureps/shell-icon.png) - -1. Choose the subscription you want to use and create a storage account. - - ![Create a storage account](~/media/get-started-azureps/storage-prompt.png) - -Once your storage has been created, the Cloud Shell will open a PowerShell session in the browser. - -![Cloud Shell for PowerShell](~/media/get-started-azureps/cloud-powershell.png) - -You can also install Azure PowerShell and use it locally in a PowerShell session. - -## Sign in to Azure - -Sign on interactively: - -1. Type `Connect-AzureRmAccount`. You'll get a dialog box asking for your Azure credentials. Option - '-Environment' can let you authenticate for Azure China or Azure Germany. - - for example, Connect-AzureRmAccount -Environment AzureChinaCloud - -1. Type the email address and password associated with your account. Azure authenticates and saves - the credential information, and then closes the window. - -Once you have signed in to an Azure account, you can use the Azure PowerShell cmdlets to access and -manage the resources in your subscription. - -## Create a Windows virtual machine using simple defaults - -The `New-AzureRmVM` cmdlet provides a simplified syntax making it easy to create a new virtual -machine. There are only two parameter values you must provide: the name of the VM and a set of -credentials for the local administrator account on the VM. - -First, create the credential object. - -```powershell -$cred = Get-Credential -Message 'Enter a username and password for the virtual machine.' -``` - -```Output -Windows PowerShell credential request. -Enter a username and password for the virtual machine. -User: localAdmin -Password for user localAdmin: ********* -``` - -Next, create the VM. - -```azurepowershell -New-AzureRmVM -Name SampleVM -Credential $cred -``` - -```Output -ResourceGroupName : SampleVM -Id : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/SampleVM/providers/Microsoft.Compute/virtualMachines/SampleVM -VmId : 43f6275d-ce50-49c8-a831-5d5974006e63 -Name : SampleVM -Type : Microsoft.Compute/virtualMachines -Location : eastus -Tags : {} -HardwareProfile : {VmSize} -NetworkProfile : {NetworkInterfaces} -OSProfile : {ComputerName, AdminUsername, WindowsConfiguration, Secrets} -ProvisioningState : Succeeded -StorageProfile : {ImageReference, OsDisk, DataDisks} -FullyQualifiedDomainName : samplevm-2c0867.eastus.cloudapp.azure.com -``` - -You may wonder what else is created and how is the VM configured. First, let's -look at our resource groups. - -```azurepowershell -Get-AzureRmResourceGroup | - Select-Object -Property ResourceGroupName, Location -``` - -```Output -ResourceGroupName Location ------------------ -------- -cloud-shell-storage-westus westus -SampleVM eastus -``` - -The **cloud-shell-storage-westus** resource group is created the first time you use the Cloud -Shell. The **SampleVM** resource group was created by the `New-AzureRmVM` cmdlet. - -Now, what other resources were created in this new resource group? - -```azurepowershell -Get-AzureRmResource | - Where ResourceGroupName -eq SampleVM | - Select-Object -Property ResourceGroupName, Location, ResourceType, Name -``` - -```Output -ResourceGroupName Location ResourceType Name ------------------ -------- ------------ ---- -SAMPLEVM eastus Microsoft.Compute/disks SampleVM_OsDisk_1_9b286c54b168457fa1f8c47... -SampleVM eastus Microsoft.Compute/virtualMachines SampleVM -SampleVM eastus Microsoft.Network/networkInterfaces SampleVM -SampleVM eastus Microsoft.Network/networkSecurityGroups SampleVM -SampleVM eastus Microsoft.Network/publicIPAddresses SampleVM -SampleVM eastus Microsoft.Network/virtualNetworks SampleVM -``` - -Let's get some more details about the VM. This example shows how to retrieve -information about the OS Image used to create the VM. - -```azurepowershell -Get-AzureRmVM -Name SampleVM -ResourceGroupName SampleVM | - Select-Object -ExpandProperty StorageProfile | - Select-Object -ExpandProperty ImageReference -``` - -```Output -Publisher : MicrosoftWindowsServer -Offer : WindowsServer -Sku : 2016-Datacenter -Version : latest -Id : -``` - -## Create a fully configured Linux Virtual Machine - -The previous example used the simplified syntax and default parameter values to create a Windows -virtual machine. In this example, we provide values for all options of the virtual machine. - -### Create a resource group - -In this example, we want to create a Resource Group. Resource Groups in Azure provide a way to -manage multiple resources that you want to logically group together. For example, you might create -a Resource Group for an application or project and add a virtual machine, a database and a CDN -service within it. - -Let's create a resource group named "MyResourceGroup" in the westeurope region of Azure. To do so -type the following command: - -```azurepowershell -New-AzureRmResourceGroup -Name 'myResourceGroup' -Location 'westeurope' -``` - -```Output -ResourceGroupName : myResourceGroup -Location : westeurope -ProvisioningState : Succeeded -Tags : -ResourceId : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/myResourceGroup -``` - -This new resource group will be used to contain all of the resources needed for the new VM we -create. To create a new Linux VM, we must first create the other required resources and assign them -to a configuration. Then we can use that configuration to create the VM. Also, you will need to -have an SSH public key named `id_rsa.pub` in the .ssh directory of your user profile. - -#### Create the required network resources - -First we need to create a subnet configuration to be used with the virtual network creation -process. We also create a public IP address so that we can connect to this VM. We create a network -security group to secure access to the public address. Finally we create the virtual NIC using all -of the previous resources. - -```azurepowershell -# Variables for common values -$resourceGroup = 'myResourceGroup' -$location = 'westeurope' -$vmName = 'myLinuxVM' - -# Definer user name and blank password -$securePassword = ConvertTo-SecureString 'azurepassword' -AsPlainText -Force -$cred = New-Object -TypeName System.Management.Automation.PSCredential ('azureuser', $securePassword) - -# Create a subnet configuration -$subnetConfig = New-AzureRmVirtualNetworkSubnetConfig -Name mySubnet2 -AddressPrefix 192.168.2.0/24 - -# Create a virtual network -$vnet = New-AzureRmVirtualNetwork -ResourceGroupName $resourceGroup -Location $location ` - -Name MYvNET2 -AddressPrefix 192.168.0.0/16 -Subnet $subnetConfig - -# Create a public IP address and specify a DNS name -$publicIp = New-AzureRmPublicIpAddress -ResourceGroupName $resourceGroup -Location $location ` - -Name "mypublicdns$(Get-Random)" -AllocationMethod Static -IdleTimeoutInMinutes 4 -$publicIp | Select-Object Name,IpAddress - -# Create an inbound network security group rule for port 22 -$nsgRuleSSH = New-AzureRmNetworkSecurityRuleConfig -Name myNetworkSecurityGroupRuleSSH -Protocol Tcp ` - -Direction Inbound -Priority 1000 -SourceAddressPrefix * -SourcePortRange * -DestinationAddressPrefix * ` - -DestinationPortRange 22 -Access Allow - -# Create a network security group -$nsg = New-AzureRmNetworkSecurityGroup -ResourceGroupName $resourceGroup -Location $location ` - -Name myNetworkSecurityGroup2 -SecurityRules $nsgRuleSSH - -# Create a virtual network card and associate with public IP address and NSG -$nic = New-AzureRmNetworkInterface -Name myNic2 -ResourceGroupName $resourceGroup -Location $location ` - -SubnetId $vnet.Subnets[0].Id -PublicIpAddressId $publicIp.Id -NetworkSecurityGroupId $nsg.Id -``` - -### Create the VM configuration - -Now that we have the required resources we can create the VM configuration object. - -```azurepowershell -# Create a virtual machine configuration -$vmConfig = New-AzureRmVMConfig -VMName $vmName -VMSize Standard_D1 | - Set-AzureRmVMOperatingSystem -Linux -ComputerName $vmName -Credential $cred -DisablePasswordAuthentication | - Set-AzureRmVMSourceImage -PublisherName Canonical -Offer UbuntuServer -Skus 14.04.2-LTS -Version latest | - Add-AzureRmVMNetworkInterface -Id $nic.Id - -# Configure SSH Keys -$sshPublicKey = Get-Content -Raw "$env:USERPROFILE\.ssh\id_rsa.pub" -Add-AzureRmVMSshPublicKey -VM $vmConfig -KeyData $sshPublicKey -Path '/home/azureuser/.ssh/authorized_keys' -``` - -### Create the virtual machine - -Now we can create the VM using the VM configuration object. - -```azurepowershell -New-AzureRmVM -ResourceGroupName $resourceGroup -Location $location -VM $vmConfig -``` - -Now that the VM has been created, you can sign in to your new Linux VM using SSH with the public IP -address of the VM you created: - -```bash -ssh xx.xxx.xxx.xxx -``` - -```Output -Welcome to Ubuntu 14.04.4 LTS (GNU/Linux 3.19.0-65-generic x86_64) - - * Documentation: https://help.ubuntu.com/ - - System information as of Sun Feb 19 00:32:28 UTC 2017 - - System load: 0.31 Memory usage: 3% Processes: 89 - Usage of /: 39.6% of 1.94GB Swap usage: 0% Users logged in: 0 - - Graph this data and manage this system at: - https://landscape.canonical.com/ - - Get cloud support with Ubuntu Advantage Cloud Guest: - http://www.ubuntu.com/business/services/cloud - -0 packages can be updated. -0 updates are security updates. - - - -The programs included with the Ubuntu system are free software; -the exact distribution terms for each program are described in the -individual files in /usr/share/doc/*/copyright. - -Ubuntu comes with ABSOLUTELY NO WARRANTY, to the extent permitted by -applicable law. - -my-login@MyLinuxVM:../../..$ -``` - -## Creating other resources in Azure - -We've now walked through how to create a Resource Group, a Linux VM, and a Windows Server VM. You -can create many other types of Azure resources as well. - -For example, to create an Azure Network Load Balancer that we could then associate with our newly -created VMs, we can use the following create command: - -```azurepowershell -New-AzureRmLoadBalancer -Name MyLoadBalancer -ResourceGroupName myResourceGroup -Location westeurope -``` - -We could also create a new private Virtual Network (commonly referred to as a "VNet" within Azure) -for our infrastructure using the following command: - -```azurepowershell -$subnetConfig = New-AzureRmVirtualNetworkSubnetConfig -Name mySubnet2 -AddressPrefix 10.0.0.0/16 -$vnet = New-AzureRmVirtualNetwork -ResourceGroupName myResourceGroup -Location westeurope ` - -Name MYvNET3 -AddressPrefix 10.0.0.0/16 -Subnet $subnetConfig -``` - -What makes Azure and the Azure PowerShell powerful is that we can use it not just to get -cloud-based infrastructure but also to create managed platform services. The managed platform -services can also be combined with infrastructure to build even more powerful solutions. - -For example, you can use the Azure PowerShell to create an Azure AppService. Azure AppService is a -managed platform service that provides a great way to host web apps without having to worry about -infrastructure. After creating the Azure AppService, you can create two new Azure Web Apps within -the AppService using the following commands: - -```azurepowershell -# Create an Azure AppService that we can host any number of web apps within -New-AzureRmAppServicePlan -Name MyAppServicePlan -Tier Basic -NumberofWorkers 2 -WorkerSize Small -ResourceGroupName myResourceGroup -Location westeurope - -# Create Two Web Apps within the AppService (note: name param must be a unique DNS entry) -New-AzureRmWebApp -Name MyWebApp43432 -AppServicePlan MyAppServicePlan -ResourceGroupName myResourceGroup -Location westeurope -New-AzureRmWebApp -Name MyWebApp43433 -AppServicePlan MyAppServicePlan -ResourceGroupName myResourceGroup -Location westeurope -``` - -## Listing deployed resources - -You can use the `Get-AzureRmResource` cmdlet to list the resources running in Azure. The following -example shows the resources we created in the new resource group. - -```azurepowershell -Get-AzureRmResource | - Where-Object ResourceGroupName -eq myResourceGroup | - Select-Object Name,Location,ResourceType -``` - -```Output -Name Location ResourceType ----- -------- ------------ -myLinuxVM_OsDisk_1_36ca038791f642ba91270879088c249a westeurope Microsoft.Compute/disks -myWindowsVM_OsDisk_1_f627e6e2bb454c72897d72e9632adf9a westeurope Microsoft.Compute/disks -myLinuxVM westeurope Microsoft.Compute/virtualMachines -myWindowsVM westeurope Microsoft.Compute/virtualMachines -myWindowsVM/BGInfo westeurope Microsoft.Compute/virtualMachines/extensions -myNic1 westeurope Microsoft.Network/networkInterfaces -myNic2 westeurope Microsoft.Network/networkInterfaces -myNetworkSecurityGroup1 westeurope Microsoft.Network/networkSecurityGroups -myNetworkSecurityGroup2 westeurope Microsoft.Network/networkSecurityGroups -mypublicdns245369171 westeurope Microsoft.Network/publicIPAddresses -mypublicdns779537141 westeurope Microsoft.Network/publicIPAddresses -MYvNET1 westeurope Microsoft.Network/virtualNetworks -MYvNET2 westeurope Microsoft.Network/virtualNetworks -micromyresomywi032907510 westeurope Microsoft.Storage/storageAccounts -``` - -## Deleting resources - -To clean up your Azure account, you want to remove the resources we created in this example. You -can use the `Remove-AzureRm*` cmdlets to delete the resources you no longer need. To remove the -Windows VM we created, using the following command: - -```azurepowershell -Remove-AzureRmVM -Name myWindowsVM -ResourceGroupName myResourceGroup -``` - -You'll be prompted to confirm that you want to remove the resource. - -```Output -Confirm -Are you sure you want to remove resource group 'myResourceGroup' -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y -``` - -You can also delete many resources at once. For example, the following command deletes -the resource group "MyResourceGroup" that we've used for all the samples so far. -All resources in the group are also deleted. - -```azurepowershell -Remove-AzureRmResourceGroup -Name myResourceGroup -``` - -```Output -Confirm -Are you sure you want to remove resource group 'myResourceGroup' -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y -``` - -The task can take several minutes to complete, depending on the number and type of resources. - -## Get samples - -To learn more about ways to use the Azure PowerShell, check out our most common scripts for -[Linux VMs](/azure/virtual-machines/linux/powershell-samples?toc=%2fpowershell%2fazure%%2ftoc.json), -[Windows VMs](/azure/virtual-machines/windows/powershell-samples?toc=%2fpowershell%2fazure%%2ftoc.json), -[Web Apps](/azure/app-service-web/app-service-powershell-samples?toc=%2fpowershell%2fazure%%2ftoc.json), and -[SQL Databases](/azure/sql-database/sql-database-powershell-samples?toc=%2fpowershell%2fazure%%2ftoc.json). - -## Next steps - -* [Sign in with Azure PowerShell](authenticate-azureps.md) -* [Manage Azure subscriptions with Azure PowerShell](manage-subscriptions-azureps.md) -* [Create service principals in Azure using Azure PowerShell](create-azure-service-principal-azureps.md) -* Read the [Release notes](./release-notes-azureps.md) about migrating from an older release. -* Get help from the community: - * [Azure forum on MSDN](https://go.microsoft.com/fwlink/p/?LinkId=320212) - * [stackoverflow](https://go.microsoft.com/fwlink/?LinkId=320213) diff --git a/docs-conceptual/azurermps-6.13.0/install-azurerm-ps.md b/docs-conceptual/azurermps-6.13.0/install-azurerm-ps.md deleted file mode 100644 index 89dc972e77..0000000000 --- a/docs-conceptual/azurermps-6.13.0/install-azurerm-ps.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -title: Install Azure PowerShell on Windows with PowerShellGet -description: How to install Azure PowerShell with PowerShellGet -ms.devlang: powershell -ms.topic: conceptual - -ms.custom: devx-track-azurepowershell ---- - -# Install Azure PowerShell on Windows with PowerShellGet - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -This article explains the steps to install the Azure PowerShell modules for PowerShell 5.x for -Windows using PowerShellGet. PowerShellGet and module management is the preferred way to install -Azure PowerShell but if you would rather install with the Web Platform Installer or MSI package, see -[Other installation methods](other-install.md). - -The Azure classic deployment model is not supported by this version of Azure PowerShell. For support -for classic deployments, follow the instructions in -[Install the Azure PowerShell Service Management module](/powershell/azure/servicemanagement/install-azure-ps). - -> [!IMPORTANT] -> The AzureRM module is not supported for macOS or Linux. To use Azure PowerShell cmdlets on these -> platforms, [Install the Az module](/powershell/azure/install-az-ps). - -## Requirements - -Starting with Azure PowerShell version 6.0, Azure PowerShell requires PowerShell version 5.0. To -check the version of PowerShell running on your machine, run the following command: - -```powershell -$PSVersionTable.PSVersion -``` - -If you have an outdated version, see -[Upgrading existing Windows PowerShell](/powershell/scripting/windows-powershell/install/installing-windows-powershell#upgrading-existing-windows-powershell). - -> [!IMPORTANT] -> The module described in this document, AzureRM, uses .NET Framework. This makes it incompatible -> with PowerShell 6.0, which uses .NET Core. If you are using PowerShell 6.0, follow the -> [installation instructions for macOS and Linux](/powershell/azure/install-az-ps). - -## Install the Azure PowerShell module - -You need elevated privileges to install modules from the PowerShell Gallery. To install Azure -PowerShell, run the following command in an elevated session: - -```azurepowershell -Install-Module -Name AzureRM -AllowClobber -``` - -> [!NOTE] -> If you have a version older than 2.8.5.201 of NuGet, you are prompted to download and install the -> latest version of NuGet. - -By default, the PowerShell gallery isn't configured as a trusted repository for PowerShellGet. The -first time you use the PSGallery you see the following prompt: - -```Output -Untrusted repository - -You are installing the modules from an untrusted repository. If you trust this repository, change -its InstallationPolicy value by running the Set-PSRepository cmdlet. - -Are you sure you want to install the modules from 'PSGallery'? -[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "N"): -``` - -Answer `Yes` or `Yes to All` to continue with the installation. - -The `AzureRM` module is a rollup module for the Azure PowerShell cmdlets. Installing it downloads -all of the available Azure Resource Manager modules, and makes their cmdlets available for use. - -## Sign in - -To start working with Azure PowerShell, sign in with your Azure credentials. - -```azurepowershell -# Connect to Azure with an interactive dialog for sign-in -Connect-AzureRmAccount -``` - -> [!NOTE] -> If you've disabled module autoloading, you need to manually import the module with -> `Import-Module AzureRM`. Because of the way the module is structured, this can take a few seconds. - -You'll need to repeat these steps for every new PowerShell session you start. To learn how to -persist your Azure sign-in across PowerShell sessions, see -[Persist user credentials across PowerShell sessions](context-persistence.md). - -## Update the Azure PowerShell module - -You can update your Azure PowerShell installation by running -[Update-Module](/powershell/module/powershellget/update-module). This command does **not** uninstall -earlier versions. - -```powershell -Update-Module -Name AzureRM -``` - -If you want to remove older versions of Azure PowerShell from your system, see -[Uninstall the Azure PowerShell module](uninstall-azurerm-ps.md). - -## Use multiple versions of Azure PowerShell - -It's possible to install more than one version of Azure PowerShell. To check if you have multiple -versions of Azure PowerShell installed, use the following command: - -```powershell -Get-InstalledModule -Name AzureRM -AllVersions | - Select-Object -Property Name, Version -``` - -To remove a version of Azure PowerShell, see -[Uninstall the Azure PowerShell module](uninstall-azurerm-ps.md). - -You might need more than one version if you work with on-premises Azure Stack resources, run an -older version of Windows, or use the Azure classic deployment model. To install an older version, -provide the `-RequiredVersion` argument when installing. - -```powershell -# Install version 2.3.0 of Azure PowerShell -Install-Module -Name AzureRM -RequiredVersion 2.3.0 -``` - -When loading the Azure PowerShell module the latest version is loaded by default. To load a -different version, specify the `RequiredVersion` parameter. - -```powershell -# Load version 2.3.0 of Azure PowerShell -Import-Module -Name AzureRM -RequiredVersion 2.3.0 -``` - -## Provide feedback - -If you find a bug when using Azure Powershell, -[file an issue on GitHub](https://github.com/Azure/azure-powershell/issues). To provide feedback -from the command line, use the [Send-Feedback](/powershell/module/azurerm.profile/send-feedback) -cmdlet. - -## Next Steps - -To get started using Azure PowerShell, see -[Get Started with Azure PowerShell](get-started-azureps.md) to learn more about the module and its -features. diff --git a/docs-conceptual/azurermps-6.13.0/manage-subscriptions-azureps.md b/docs-conceptual/azurermps-6.13.0/manage-subscriptions-azureps.md deleted file mode 100644 index bd7a1af1f9..0000000000 --- a/docs-conceptual/azurermps-6.13.0/manage-subscriptions-azureps.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: Manage Azure subscriptions with Azure PowerShell -description: Manage Azure subscriptions with Azure PowerShell -ms.devlang: powershell -ms.topic: conceptual - -ms.custom: devx-track-azurepowershell ---- - -# Manage multiple Azure subscriptions - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -If you're brand new to Azure, you probably only have a single subscription. But if you have been -using Azure for a while, you may have created multiple Azure subscriptions. You can configure Azure -PowerShell to execute commands against a particular subscription. - -1. Get a list of all subscriptions in your account. - - ```azurepowershell - Get-AzureRmSubscription - ``` - - ```Output - Environment : AzureCloud - Account : username@contoso.com - TenantId : 00000000-0000-0000-0000-000000000000 - SubscriptionId : 00000000-0000-0000-0000-000000000000 - SubscriptionName : My Production Subscription - CurrentStorageAccount : - - Environment : AzureCloud - Account : username@contoso.com - TenantId : 00000000-0000-0000-0000-000000000000 - SubscriptionId : 00000000-0000-0000-0000-000000000000 - SubscriptionName : My DevTest Subscription - CurrentStorageAccount : - - Environment : AzureCloud - Account : username@contoso.com - TenantId : 00000000-0000-0000-0000-000000000000 - SubscriptionId : 00000000-0000-0000-0000-000000000000 - SubscriptionName : My Demos - CurrentStorageAccount : - ``` - -2. Set the default. - - ```azurepowershell - Select-AzureRmSubscription -Subscription 'My Demos' - ``` - -3. Verify the change by running the `Get-AzureRmContext` cmdlet. - - ```azurepowershell - Get-AzureRmContext - ``` - - ```Output - Environment : AzureCloud - Account : username@contoso.com - TenantId : 00000000-0000-0000-0000-000000000000 - SubscriptionId : 00000000-0000-0000-0000-000000000000 - SubscriptionName : My Demos - CurrentStorageAccount : - ``` - -Once you set your default subscription, all Azure PowerShell commands run against this -subscription. diff --git a/docs-conceptual/azurermps-6.13.0/migration-guide.6.0.0.md b/docs-conceptual/azurermps-6.13.0/migration-guide.6.0.0.md deleted file mode 100644 index 66bb4bbcbf..0000000000 --- a/docs-conceptual/azurermps-6.13.0/migration-guide.6.0.0.md +++ /dev/null @@ -1,571 +0,0 @@ ---- -title: Breaking changes for the AzureRM PowerShell module 6.0.0 -description: This migration guide contains a list of breaking changes made to the AzureRM PowerShell module in the version 6 release. -ms.devlang: powershell -ms.topic: conceptual - -ms.custom: devx-track-azurepowershell ---- -# Breaking changes for the AzureRM PowerShell module 6.0.0 - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -This document serves as both a breaking change notification and migration guide for consumers of the -Microsoft Azure PowerShell cmdlets. Each section describes both the impetus for the breaking change -and the migration path of least resistance. For in-depth context, please refer to the pull request -associated with each change. - -## Table of Contents - -- [General breaking changes](#general-breaking-changes) - - [Minimum PowerShell version required bumped to 5.0](#minimum-powershell-version-required-bumped-to-50) - - [Context autosaved enabled by default](#context-autosave-enabled-by-default) - - [Removal of Tags alias](#removal-of-tags-alias) -- [Breaking changes to AzureRM.Compute cmdlets](#breaking-changes-to-azurermcompute-cmdlets) -- [Breaking changes to AzureRM.DataLakeStore cmdlets](#breaking-changes-to-azurermdatalakestore-cmdlets) -- [Breaking changes to AzureRM.Dns cmdlets](#breaking-changes-to-azurermdns-cmdlets) -- [Breaking changes to AzureRM.Insights cmdlets](#breaking-changes-to-azurerminsights-cmdlets) -- [Breaking changes to AzureRM.KeyVault cmdlets](#breaking-changes-to-azurermkeyvault-cmdlets) -- [Breaking changes to AzureRM.Network cmdlets](#breaking-changes-to-azurermnetwork-cmdlets) -- [Breaking changes to AzureRM.RedisCache cmdlets](#breaking-changes-to-azurermrediscache-cmdlets) -- [Breaking changes to AzureRM.Resources cmdlets](#breaking-changes-to-azurermresources-cmdlets) -- [Breaking changes to AzureRM.Storage cmdlets](#breaking-changes-to-azurermstorage-cmdlets) -- [Removed modules](#removed-modules) - - [`AzureRM.ServerManagement`](#azurermservermanagement) - - [`AzureRM.SiteRecovery`](#azurermsiterecovery) - -## General breaking changes - -### Minimum PowerShell version required bumped to 5.0 - -Previously, Azure PowerShell required _at least_ version 3.0 of PowerShell to run any cmdlet. Moving -forward, this requirement will be raised to version 5.0 of PowerShell. For information on upgrading -to PowerShell 5.0, please see -[this table](/powershell/scripting/windows-powershell/install/installing-windows-powershell#upgrading-existing-windows-powershell). - -### Context autosave enabled by default - -Context autosave is the storage of Azure sign in information that can be used between new and -different PowerShell sessions. For more information on context autosave, please see -[this document](/powershell/azure/context-persistence). - -Previously by default, context autosave was disabled, which meant the user's Azure authentication -information was not stored between sessions until they ran the `Enable-AzureRmContextAutosave` -cmdlet to turn on context persistence. Moving forward, context autosave will be enabled by default, -which means that users _with no saved context autosave settings_ will have their context stored the -next time they sign in. Users can opt out of this functionality by using the -`Disable-AzureRmContextAutosave` cmdlet. - -> [!NOTE] -> Users who previously disabled context autosave or users with context autosave enabled and existing -> contexts will not be affected by this change. - -### Removal of Tags alias - -The alias `Tags` for the `Tag` parameter has been removed across numerous cmdlets. Below is a list -of modules (and the corresponding cmdlets) affected by this: - -#### `AzureRM.ApiManagement` - -- `New-AzureRmApiManagement` -- `New-AzureRmApiManagementProperty` -- `Set-AzureRmApiManagementProperty` - -#### `AzureRM.Automation` -- `Set-AzureRmAutomationRunbook` - -#### `AzureRM.Cdn` -- `New-AzureRmCdnEndpoint` -- `New-AzureRmCdnProfile` - -#### `AzureRM.Compute` -- `New-AzureRmVM` -- `Update-AzureRmVM` - -#### `AzureRM.DataFactories` -- `New-AzureRmDataFactories` - -#### `AzureRM.DataLakeAnalytics` -- `New-AzureRmDataLakeAnalyticsAccount` - -#### `AzureRM.DataLakeStore` -- `New-AzureRmDataLakeStoreAccount` -- `Set-AzureRmDataLakeStoreAccount` - -#### `AzureRM.MachineLearning` -- `Update-AzureRmMlCommitmentPlan` - -#### `AzureRM.Media` -- `Set-AzureRmMediaService` - -#### `AzureRM.OperationalInsights` -- `New-AzureRmOperationalInsightsSavedSearch` -- `New-AzureRmOperationalInsightsWorkspace` -- `Set-AzureRmOperationalInsightsSavedSearch` -- `Set-AzureRmOperationalInsightsWorkspace` - -## Breaking changes to AzureRM.Compute cmdlets - -**Miscellaneous** - -- The sku name property nested in types `PSDisk` and `PSSnapshot` changed from `StandardLRS` and - `PremiumLRS` to `Standard_LRS` and `Premium_LRS`, respectively - -```powershell -$disk = Get-AzureRmDisk -ResourceGroupName 'MyResourceGroup' -DiskName 'MyDiskName' -$disk.Sku.Name # This will now return Standard_LRS or Premium_LRS - -$snapshot = Get-AzureRmSnapshot -ResourceGroupName 'MyResourceGroup' -SnapshotName 'MySnapshotName' -$snapshot.Sku.Name # This will now return Standard_LRS or Premium_LRS -``` - -- The storage account type property nested in types `PSVirtualMachine`, `PSVirtualMachineScaleSet` - and `PSImage` changed from `StandardLRS` and `PremiumLRS` to `Standard_LRS` and `Premium_LRS`, - respectively - -```powershell -$vm = Get-AzureRmVM -ResourceGroupName "MyResourceGroup" -Name "MyVM" -$vm.StorageProfile.DataDisks[0].ManagedDisk.StorageAccountType # This will now return Standard_LRS or Premium_LRS -``` - -**Add-AzureRmImageDataDisk** - -- The accepted values for parameter `StorageAccountType` changed from `StandardLRS` and `PremiumLRS` - to `Standard_LRS` and `Premium_LRS`, respectively - -**Add-AzureRmVMDataDisk** - -- The accepted values for parameter `StorageAccountType` changed from `StandardLRS` and `PremiumLRS` - to `Standard_LRS` and `Premium_LRS`, respectively - -**Add-AzureRmVmssDataDisk** - -- The accepted values for parameter `StorageAccountType` changed from `StandardLRS` and `PremiumLRS` - to `Standard_LRS` and `Premium_LRS`, respectively - -**New-AzureRmAvailabilitySet** -- The parameter `Managed` was removed in favor of `Sku` - -```powershell -# Old -New-AzureRmAvailabilitySet -ResourceGroupName "MyRG" -Name "MyAvailabilitySet" -Location "West US" -Managed - -# New -New-AzureRmAvailabilitySet -ResourceGroupName "MyRG" -Name "MyAvailabilitySet" -Location "West US" -Sku "Aligned" -``` - -**New-AzureRmDiskConfig** -- The accepted values for parameter `SkuName` changed from `StandardLRS` and `PremiumLRS` to - `Standard_LRS` and `Premium_LRS`, respectively - -**New-AzureRmDiskUpdateConfig** -- The accepted values for parameter `SkuName` changed from `StandardLRS` and `PremiumLRS` to - `Standard_LRS` and `Premium_LRS`, respectively - -**New-AzureRmSnapshotConfig** -- The accepted values for parameter `SkuName` changed from `StandardLRS` and `PremiumLRS` to - `Standard_LRS` and `Premium_LRS`, respectively - -**New-AzureRmSnapshotUpdateConfig** -- The accepted values for parameter `SkuName` changed from `StandardLRS` and `PremiumLRS` to - `Standard_LRS` and `Premium_LRS`, respectively - -**Set-AzureRmImageOsDisk** -- The accepted values for parameter `StorageAccountType` changed from `StandardLRS` and `PremiumLRS` - to `Standard_LRS` and `Premium_LRS`, respectively - -**Set-AzureRmVMAEMExtension** -- The parameter `DisableWAD` was removed - - Windows Azure Diagnostics is disabled by default - -**Set-AzureRmVMDataDisk** -- The accepted values for parameter `StorageAccountType` changed from `StandardLRS` and `PremiumLRS` - to `Standard_LRS` and `Premium_LRS`, respectively - -**Set-AzureRmVMOSDisk** -- The accepted values for parameter `StorageAccountType` changed from `StandardLRS` and `PremiumLRS` - to `Standard_LRS` and `Premium_LRS`, respectively - -**Set-AzureRmVmssStorageProfile** -- The accepted values for parameter `ManagedDisk` changed from `StandardLRS` and `PremiumLRS` to - `Standard_LRS` and `Premium_LRS`, respectively - -**Update-AzureRmVmss** -- The accepted values for parameter `ManagedDiskStorageAccountType` changed from `StandardLRS` and - `PremiumLRS` to `Standard_LRS` and `Premium_LRS`, respectively - -## Breaking changes to AzureRM.DataLakeStore cmdlets - -**Export-AzureRmDataLakeStoreItem** -- Parameters `PerFileThreadCount` and `ConcurrentFileCount` were removed. Please use the - `Concurrency` parameter moving forward - -```powershell -# Old -Export-AzureRmDataLakeStoreItem -Account contoso -Path /test -Destination C:\test -Recurse -Resume -PerFileThreadCount 2 -ConcurrentFileCount 80 - -# New -Export-AzureRmDataLakeStoreItem -Account contoso -Path /test -Destination C:\test -Recurse -Resume -Concurrency 160 -``` - -**Import-AzureRmDataLakeStoreItem** -- Parameters `PerFileThreadCount` and `ConcurrentFileCount` were removed. Please use the - `Concurrency` parameter moving forward - -```powershell -# Old -Import-AzureRmDataLakeStoreItem -Account contoso -Path C:\test -Destination /test -Recurse -Resume -ForceBinary -PerFileThreadCount 2 -ConcurrentFileCount 80 - -# New -Import-AzureRmDataLakeStoreItem -Account contoso -Path C:\test -Destination /test -Recurse -Resume -ForceBinary -Concurrency 160 -``` - -**Remove-AzureRmDataLakeStoreItem** -- Parameter `Clean` was removed - -```powershell -# Old -Remove-AzureRmDataLakeStoreItem -Account "ContosoADL" -path /myFolder -Recurse -Clean - -# New -Remove-AzureRmDataLakeStoreItem -Account "ContosoADL" -path /myFolder -Recurse -``` - -## Breaking changes to AzureRM.Dns cmdlets - -**New-AzureRmDnsRecordSet** -- The parameter `Force` was removed - -**Remove-AzureRmDnsRecordSet** -- The parameter `Force` was removed - -**Remove-AzureRmDnsZone** -- The parameter `Force` was removed - -## Breaking changes to AzureRM.Insights cmdlets - -**Add-AzureRmAutoscaleSetting** -- The parameter aliases `AutoscaleProfiles` and `Notifications` were removed - -**Add-AzureRmLogProfile** -- The parameter aliases `Categories` and `Locations` were removed - -**Add-AzureRmMetricAlertRule** -- The parameter alias `Actions` was removed - -**Add-AzureRmWebtestAlertRule** -- The parameter alias `Actions` was removed - -**Get-AzureRmLog** -- The parameter aliases `MaxRecords` and `MaxEvents` were removed - -**Get-AzureRmMetricDefinition** -- The parameter alias `MetricNames` was removed - -**New-AzureRmAlertRuleEmail** -- The parameter aliases `CustomEmails` and `SendToServiceOwners` were removed - -**New-AzureRmAlertRuleWebhook** -- The parameter alias `Properties` was removed - -**New-AzureRmAutoscaleNotification** -- The parameter aliases `CustomEmails`, `SendEmailToSubscriptionCoAdministrators` and `Webhooks` - were removed - -**New-AzureRmAutoscaleProfile** -- The parameter aliases `Rules`, `ScheduleDays`, `ScheduleHours` and `ScheduleMinutes` were removed - -**New-AzureRmAutoscaleWebhook** -- The parameter alias `Properties` was removed - -## Breaking changes to AzureRM.KeyVault cmdlets - -**Add-AzureKeyVaultCertificate** -- The `CertificatePolicy` parameter has become mandatory. - -**Set-AzureKeyVaultManagedStorageSasDefinition** -- The cmdlet no longer accepts individual parameters that compose the access token; instead, the - cmdlet replaces explicit token parameters, such as `Service` or `Permissions`, with a generic - `TemplateUri` parameter, corresponding to a sample access token defined elsewhere (presumably - using Storage PowerShell cmdlets, or composed manually according to the Storage documentation.) - The cmdlet retains the `ValidityPeriod` parameter. - -For more information on composing shared access tokens for Azure Storage, please refer to the -documentation pages, respectively: - -- [Constructing a Service SAS](/rest/api/storageservices/Constructing-a-Service-SAS) -- [Constructing an Account SAS](/rest/api/storageservices/constructing-an-account-sas) - -```powershell -# Old -$sas = Set-AzureKeyVaultManagedStorageSasDefinition -VaultName myVault -Name myKey -Service Blob -Permissions 'rcw' -ValidityPeriod 180d - -# New -$sctx=New-AzureStorageContext -StorageAccountName $sa.StorageAccountName -Protocol Https -StorageAccountKey Key1 -$start=[System.DateTime]::Now.AddDays(-1) -$end=[System.DateTime]::Now.AddMonths(1) -$at=New-AzureStorageAccountSasToken -Service blob -ResourceType Service,Container,Object -Permission "racwdlup" -Protocol HttpsOnly -StartTime $start -ExpiryTime $end -Context $sctx -$sas=Set-AzureKeyVaultManagedStorageSasDefinition -AccountName $sa.StorageAccountName -VaultName $kv.VaultName -Name accountsas -TemplateUri $at -SasType 'account' -ValidityPeriod ([System.Timespan]::FromDays(30)) -``` - -**Set-AzureKeyVaultCertificateIssuer** -- The `IssuerProvider` parameter has become mandatory. - -**Undo-AzureKeyVaultCertificateRemoval** -- The output of this cmdlet has changed from `CertificateBundle` to `PSKeyVaultCertificate`. - -**Undo-AzureRmKeyVaultRemoval** -- `ResourceGroupName` has been removed from the `InputObject` parameter set, and is instead obtained - from the `InputObject` parameter's `ResourceId` property. - -**Set-AzureRmKeyVaultAccessPolicy** -- The `all` permission was removed from `PermissionsToKeys`, `PermissionsToSecrets`, and - `PermissionsToCertificates`. - -**General** -- The `ValueFromPipelineByPropertyName` property was removed from all cmdlets where piping by - `InputObject` was enabled. The cmdlets affected are: - - `Add-AzureKeyVaultCertificate` - - `Add-AzureKeyVaultCertificateContact` - - `Add-AzureKeyVaultKey` - - `Backup-AzureKeyVaultKey` - - `Backup-AzureKeyVaultSecret` - - `Get-AzureKeyVaultCertficate` - - `Get-AzureKeyVaultCertificateContact` - - `Get-AzureKeyVaultCertificateIssuer` - - `Get-AzureKeyVaultCertificateOperation` - - `Get-AzureKeyVaultCertificatePolicy` - - `Get-AzureKeyVaultKey` - - `Get-AzureKeyVaultManagedStorageAccount` - - `Get-AzureKeyVaultManagedStorageSasDefinition` - - `Get-AzureKeyVaultSecret` - - `Remove-AzureRmKeyVault` - - `Remove-AzureRmKeyVaultAccessPolicy` - - `Remove-AzureKeyVaultCertificate` - - `Remove-AzureKeyVaultCertificateContact` - - `Remove-AzureKeyVaultCertificateIssuer` - - `Remove-AzureKeyVaultCertificateOperation` - - `Remove-AzureKeyVaultKey` - - `Remove-AzureKeyVaultManagedStorageAccount` - - `Remove-AzureKeyVaultManagedStorageSasDefinition` - - `Remove-AzureKeyVaultSecret` - - `Restore-AzureKeyVaultKey` - - `Restore-AzureKeyVaultSecret` - - `Set-AzureRmKeyVaultAccessPolicy` - - `Set-AzureKeyVaultCertificateAttribute` - - `Set-AzureKeyVaultCertificateIssuer` - - `Set-AzureKeyVaultCertificatePolicy` - - `Set-AzureKeyVaultKeyAttribute` - - `Set-AzureKeyVaultManagedStorageSasDefinition` - - `Set-AzureKeyVaultSecret` - - `Set-AzureKeyVaultSecretAttribute` - - `Stop-AzureKeyVaultCertificateOperation` - - `Undo-AzureKeyVaultCertificateRemoval` - - `Undo-AzureKeyVaultKeyRemoval` - - `Undo-AzureRmKeyVaultRemoval` - - `Undo-AzureKeyVaultSecretRemoval` - - `Update-AzureKeyVaultManagedStorageAccount` - - `Update-AzureKeyVaultManagedStorageAccountKey` - -- `ConfirmImpact` levels were removed from all cmdlets. The cmdlets affected are: - - `Remove-AzureRmKeyVault` - - `Remove-AzureKeyVaultCertificate` - - `Remove-AzureKeyVaultCertificateIssuer` - - `Remove-AzureKeyVaultCertificateOperation` - - `Remove-AzureKeyVaultKey` - - `Remove-AzureKeyVaultManagedStorageAccount` - - `Remove-AzureKeyVaultManagedStorageSasDefinition` - - `Remove-AzureKeyVaultSecret` - - `Stop-AzureKeyVaultCertificateOperation` - - `Update-AzureKeyVaultManagedStorageAccountKey` - -- The `IKeyVaultDataServiceClient` was updated so all Certificate operations return PSTypes instead of SDK types. This includes: - - `SetCertificateContacts` - - `GetCertificateContacts` - - `GetCertificate` - - `GetDeletedCertificate` - - `MergeCertificate` - - `ImportCertificate` - - `DeleteCertificate` - - `RecoverCertificate` - - `EnrollCertificate` - - `UpdateCertificate` - - `GetCertificateOperation` - - `DeleteCertificateOperation` - - `CancelCertificateOperation` - - `GetCertificatePolicy` - - `UpdateCertificatePolicy` - - `GetCertificateIssuer` - - `SetCertificateIssuer` - - `DeleteCertificateIssuer` - -## Breaking changes to AzureRM.Network cmdlets - - -**Add-AzureRmApplicationGatewayBackendHttpSettings** -- The parameter `ProbeEnabled` was removed - -**Add-AzureRmVirtualNetworkPeering** -- The parameter alias `AlloowGatewayTransit` was removed - -**New-AzureRmApplicationGatewayBackendHttpSettings** -- The parameter `ProbeEnabled` was removed - -**Set-AzureRmApplicationGatewayBackendHttpSettings** -- The parameter `ProbeEnabled` was removed - -## Breaking changes to AzureRM.RedisCache cmdlets - -**New-AzureRmRedisCache** -- The parameters `Subnet` and `VirtualNetwork` were removed in favor of `SubnetId` -- The parameter `RedisVersion` was removed -- The parameter `MaxMemoryPolicy` was removed in favor of `RedisConfiguration` - -```powershell -# Old -New-AzureRmRedisCache -ResourceGroupName "MyRG" -Name "MyRedisCache" -Location "North Central US" -MaxMemoryPolicy "allkeys-lru" - -# New -New-AzureRmRedisCache -ResourceGroupName "MyRG" -Name "MyRedisCache" -Location "North Central US" -RedisConfiguration @{"maxmemory-policy" = "allkeys-lru"} -``` - -**Set-AzureRmRedisCache** -- The parameter `MaxMemoryPolicy` was removed in favor of `RedisConfiguration` - -```powershell -# Old -Set-AzureRmRedisCache -ResourceGroupName "MyRG" -Name "MyRedisCache" -MaxMemoryPolicy "allkeys-lru" - -# New -Set-AzureRmRedisCache -ResourceGroupName "MyRG" -Name "MyRedisCache" -RedisConfiguration @{"maxmemory-policy" = "allkeys-lru"} -``` - -## Breaking changes to AzureRM.Resources cmdlets - -**Find-AzureRmResource** -- This cmdlet was removed and the functionality was moved into `Get-AzureRmResource` - -```powershell -# Old -Find-AzureRmResource -ResourceType "Microsoft.Web/sites" -ResourceGroupNameContains "ResourceGroup" -Find-AzureRmResource -ResourceType "Microsoft.Web/sites" -ResourceNameContains "test" - -# New -Get-AzureRmResource -ResourceType "Microsoft.Web/sites" -ResourceGroupName "*ResourceGroup*" -Get-AzureRmResource -ResourceType "Microsoft.Web/sites" -Name "*test*" -``` - -**Find-AzureRmResourceGroup** -- This cmdlet was removed and the functionality was moved into `Get-AzureRmResourceGroup` - -```powershell -# Old -Find-AzureRmResourceGroup -Find-AzureRmResourceGroup -Tag @{ "testtag" = $null } -Find-AzureRmResourceGroup -Tag @{ "testtag" = "testval" } - -# New -Get-AzureRmResourceGroup -Get-AzureRmResourceGroup -Tag @{ "testtag" = $null } -Get-AzureRmResourceGroup -Tag @{ "testtag" = "testval" } -``` - -**Get-AzureRmRoleDefinition** -- Parameter `AtScopeAndBelow` was removed. - -```powershell - -# Old -Get-AzureRmRoleDefinition [other required parameters] -AtScopeAndBelow - -# New -Get-AzureRmRoleDefinition [other required parameters] -``` - -## Breaking changes to AzureRM.Storage cmdlets - -**New-AzureRmStorageAccount** -- The parameter `EnableEncryptionService` was removed - -**Set-AzureRmStorageAccount** -- The parameters `EnableEncryptionService` and `DisableEncryptionService` were removed - -## Removed modules - -### `AzureRM.ServerManagement` - -The Server Management Tools service was -[retired last year](https://blogs.technet.microsoft.com/servermanagement/2017/05/17/smt-preview-service-is-being-retired-on-june-30-2017/), -and as a result, the corresponding module for SMT, `AzureRM.ServerManagement`, was removed from -`AzureRM` and will stop shipping moving forward. - -### `AzureRM.SiteRecovery` - -The `AzureRM.SiteRecovery` module is being superseded by `AzureRM.RecoveryServices.SiteRecovery`, -which is a functional superset of the `AzureRM.SiteRecovery` module and includes a new set of -equivalent cmdlets. The full list of mappings from old to new cmdlets can be found below: - -| Deprecated cmdlet | Equivalent cmdlet | Aliases | -|----------------------------------------------------------|------------------------------------------------------------------|------------------------------------------| -| `Edit-AzureRmSiteRecoveryRecoveryPlan` | `Edit-AzureRmRecoveryServicesAsrRecoveryPlan` | `Edit-ASRRecoveryPlan` | -| `Get-AzureRmSiteRecoveryFabric` | `Get-AzureRmRecoveryServicesAsrFabric` | `Get-ASRFabric` | -| `Get-AzureRmSiteRecoveryJob` | `Get-AzureRmRecoveryServicesAsrJob` | `Get-ASRJob` | -| `Get-AzureRmSiteRecoveryNetwork` | `Get-AzureRmRecoveryServicesAsrNetwork` | `Get-ASRNetwork` | -| `Get-AzureRmSiteRecoveryNetworkMapping` | `Get-AzureRmRecoveryServicesAsrNetworkMapping` | `Get-ASRNetworkMapping` | -| `Get-AzureRmSiteRecoveryPolicy` | `Get-AzureRmRecoveryServicesAsrPolicy` | `Get-ASRPolicy` | -| `Get-AzureRmSiteRecoveryProtectableItem` | `Get-AzureRmRecoveryServicesAsrProtectableItem` | `Get-ASRProtectableItem` | -| `Get-AzureRmSiteRecoveryProtectionContainer` | `Get-AzureRmRecoveryServicesAsrProtectionContainer` | `Get-ASRProtectionContainer` | -| `Get-AzureRmSiteRecoveryProtectionContainerMapping` | `Get-AzureRmRecoveryServicesAsrProtectionContainerMapping` | `Get-ASRProtectionContainerMapping` | -| `Get-AzureRmSiteRecoveryProtectionEntity` | `Get-AzureRmRecoveryServicesAsrProtectableItem` | `Get-ASRProtectableItem` | -| `Get-AzureRmSiteRecoveryRecoveryPlan` | `Get-AzureRmRecoveryServicesAsrRecoveryPlan` | `Get-ASRRecoveryPlan` | -| `Get-AzureRmSiteRecoveryRecoveryPoint` | `Get-AzureRmRecoveryServicesAsrRecoveryPoint` | `Get-ASRRecoveryPoint` | -| `Get-AzureRmSiteRecoveryReplicationProtectedItem` | `Get-AzureRmRecoveryServicesAsrReplicationProtectedItem` | `Get-ASRReplicationProtectedItem` | -| `Get-AzureRmSiteRecoveryServer` | `Get-AzureRmRecoveryServicesAsrServicesProvider` | `Get-ASRServicesProvider` | -| `Get-AzureRmSiteRecoveryServicesProvider` | `Get-AzureRmRecoveryServicesAsrServicesProvider` | `Get-ASRServicesProvider` | -| `Get-AzureRmSiteRecoverySite` | `Get-AzureRmRecoveryServicesAsrFabric` | `Get-ASRFabric` | -| `Get-AzureRmSiteRecoveryStorageClassification` | `Get-AzureRmRecoveryServicesAsrStorageClassification` | `Get-ASRStorageClassification` | -| `Get-AzureRmSiteRecoveryStorageClassificationMapping` | `Get-AzureRmRecoveryServicesAsrStorageClassificationMapping` | `Get-ASRStorageClassificationMapping` | -| `Get-AzureRmSiteRecoveryVault` | `Get-AzureRmRecoveryServicesVault` | | -| `Get-AzureRmSiteRecoveryVaultSettings` | `Get-AzureRmRecoveryServicesAsrVaultContext` | | -| `Get-AzureRmSiteRecoveryVaultSettingsFile` | `Get-AzureRmRecoveryServicesVaultSettingsFile` | | -| `Get-AzureRmSiteRecoveryVM` | `Get-AzureRmRecoveryServicesAsrReplicationProtectedItem` | `Get-ASRReplicationProtectedItem` | -| `Import-AzureRmSiteRecoveryVaultSettingsFile` | `Import-AzureRmRecoveryServicesAsrVaultSettingsFile` | | -| `New-AzureRmSiteRecoveryFabric` | `New-AzureRmRecoveryServicesAsrFabric` | `New-ASRFabric` | -| `New-AzureRmSiteRecoveryNetworkMapping` | `New-AzureRmRecoveryServicesAsrNetworkMapping` | `New-ASRNetworkMapping` | -| `New-AzureRmSiteRecoveryPolicy` | `New-AzureRmRecoveryServicesAsrPolicy` | `New-ASRPolicy` | -| `New-AzureRmSiteRecoveryProtectionContainerMapping` | `New-AzureRmRecoveryServicesAsrProtectionContainerMapping` | `New-ASRProtectionContainerMapping` | -| `New-AzureRmSiteRecoveryRecoveryPlan` | `New-AzureRmRecoveryServicesAsrRecoveryPlan` | `New-ASRRecoveryPlan` | -| `New-AzureRmSiteRecoveryReplicationProtectedItem` | `New-AzureRmRecoveryServicesAsrReplicationProtectedItem` | `New-ASRReplicationProtectedItem` | -| `New-AzureRmSiteRecoverySite` | `New-AzureRmRecoveryServicesAsrFabric` | `New-ASRFabric` | -| `New-AzureRmSiteRecoveryStorageClassificationMapping` | `New-AzureRmRecoveryServicesAsrStorageClassificationMapping` | `New-ASRStorageClassificationMapping` | -| `New-AzureRmSiteRecoveryVault` | `New-AzureRmRecoveryServicesVault` | | -| `Remove-AzureRmSiteRecoveryFabric` | `Remove-AzureRmRecoveryServicesAsrFabric` | `Remove-ASRFabric` | -| `Remove-AzureRmSiteRecoveryNetworkMapping` | `Remove-AzureRmRecoveryServicesAsrNetworkMapping` | `Remove-ASRNetworkMapping` | -| `Remove-AzureRmSiteRecoveryPolicy` | `Remove-AzureRmRecoveryServicesAsrPolicy` | `Remove-ASRPolicy` | -| `Remove-AzureRmSiteRecoveryProtectionContainerMapping` | `Remove-AzureRmRecoveryServicesAsrProtectionContainerMapping` | `Remove-ASRProtectionContainerMapping` | -| `Remove-AzureRmSiteRecoveryRecoveryPlan` | `Remove-AzureRmRecoveryServicesAsrRecoveryPlan` | `Remove-ASRRecoveryPlan` | -| `Remove-AzureRmSiteRecoveryReplicationProtectedItem` | `Remove-AzureRmRecoveryServicesAsrReplicationProtectedItem` | `Remove-ASRReplicationProtectedItem` | -| `Remove-AzureRmSiteRecoveryServer` | `Remove-AzureRmRecoveryServicesAsrServicesProvider` | | -| `Remove-AzureRmSiteRecoveryServicesProvider` | `Remove-AzureRmRecoveryServicesAsrServicesProvider` | `Remove-ASRServicesProvider` | -| `Remove-AzureRmSiteRecoverySite` | `Remove-AzureRmRecoveryServicesAsrFabric` | `Remove-ASRFabric` | -| `Remove-AzureRmSiteRecoveryStorageClassificationMapping` | `Remove-AzureRmRecoveryServicesAsrStorageClassificationMapping` | `Remove-ASRStorageClassificationMapping` | -| `Remove-AzureRmSiteRecoveryVault` | `Remove-AzureRmRecoveryServicesVault` | | -| `Restart-AzureRmSiteRecoveryJob` | `Restart-AzureRmRecoveryServicesAsrJob` | `Restart-ASRJob` | -| `Resume-AzureRmSiteRecoveryJob` | `Resume-AzureRmRecoveryServicesAsrJob` | `Resume-ASRJob` | -| `Set-AzureRmSiteRecoveryProtectionEntity` | `New-AzureRmRecoveryServicesAsrReplicationProtectedItem` | `New-ASRReplicationProtectedItem` | -| `Set-AzureRmSiteRecoveryReplicationProtectedItem` | `Set-AzureRmRecoveryServicesAsrReplicationProtectedItem` | `Set-ASRReplicationProtectedItem` | -| `Set-AzureRmSiteRecoveryVaultSettings` | `Set-AzureRmRecoveryServicesAsrVaultContext` | `Set-ASRVaultContext` | -| `Set-AzureRmSiteRecoveryVM` | `Set-AzureRmRecoveryServicesAsrReplicationProtectedItem` | `Set-ASRReplicationProtectedItem` | -| `Start-AzureRmSiteRecoveryApplyRecoveryPoint` | `Start-AzureRmRecoveryServicesAsrApplyRecoveryPoint` | `Start-ASRApplyRecoveryPoint` | -| `Start-AzureRmSiteRecoveryCommitFailoverJob` | `Start-AzureRmRecoveryServicesAsrCommitFailoverJob` | `Start-ASRCommitFailoverJob` | -| `Start-AzureRmSiteRecoveryPlannedFailoverJob` | `Start-AzureRmRecoveryServicesAsrPlannedFailoverJob` | `Start-ASRPlannedFailoverJob` | -| `Start-AzureRmSiteRecoveryPolicyAssociationJob` | `New-AzureRmRecoveryServicesAsrProtectionContainerMapping` | `New-ASRProtectionContainerMapping` | -| `Start-AzureRmSiteRecoveryPolicyDissociationJob` | `Remove-AzureRmRecoveryServicesAsrProtectionContainerMapping` | `Remove-ASRProtectionContainerMapping` | -| `Start-AzureRmSiteRecoveryTestFailoverJob` | `Start-AzureRmRecoveryServicesAsrTestFailoverJob` | `Start-ASRTestFailoverJob` | -| `Start-AzureRmSiteRecoveryUnplannedFailoverJob` | `Start-AzureRmRecoveryServicesAsrUnplannedFailoverJob` | `Start-ASRUnplannedFailoverJob` | -| `Stop-AzureRmSiteRecoveryJob` | `Stop-AzureRmRecoveryServicesAsrJob` | `Stop-ASRJob` | -| `Update-AzureRmSiteRecoveryPolicy` | `Update-AzureRmRecoveryServicesAsrPolicy` | `Update-ASRPolicy` | -| `Update-AzureRmSiteRecoveryProtectionDirection` | `Update-AzureRmRecoveryServicesAsrProtectionDirection` | `Update-ASRProtectionDirection` | -| `Update-AzureRmSiteRecoveryRecoveryPlan` | `Update-AzureRmRecoveryServicesAsrRecoveryPlan` | `Update-ASRRecoveryPlan` | -| `Update-AzureRmSiteRecoveryServer` | `Update-AzureRmRecoveryServicesAsrServicesProvider` | `Update-ASRServicesProvider` | -| `Update-AzureRmSiteRecoveryServicesProvider` | `Update-AzureRmRecoveryServicesAsrvCenter` | `Update-ASRvCenter` | diff --git a/docs-conceptual/azurermps-6.13.0/other-install.md b/docs-conceptual/azurermps-6.13.0/other-install.md deleted file mode 100644 index 30fda5aacd..0000000000 --- a/docs-conceptual/azurermps-6.13.0/other-install.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Other ways to install Azure PowerShell -description: How to install Azure PowerShell without PowerShellGet using an MSI -ms.devlang: powershell -ms.topic: conceptual - -ms.custom: devx-track-azurepowershell ---- - -# Install Azure PowerShell on Windows with MSI - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -This article explains how to install Azure PowerShell on Windows using an MSI installer. Use these -installation methods only if they're necessary for your system. The recommended way to install Azure -PowerShell on Windows is with PowerShellGet. For instructions on using PowerShellGet to install -Azure PowerShell, see [Install Azure PowerShell with PowerShellGet](install-azurerm-ps.md). - -> [!NOTE] -> The Web Platform Installer method of installation is no longer available for versions of Azure -> PowerShell 6.x and higher. If you require use of the Web Platform Installer please consider using -> the MSI instead, or you can install an earlier version of Azure PowerShell. - -## Install or update on Windows using the MSI Package - -Azure PowerShell for Windows PowerShell 5.x can be installed using the MSI file available from -[GitHub](https://github.com/Azure/azure-powershell/releases/tag/v6.13.1-November2018). If you have -installed previous versions of Azure modules as an MSI, the installer automatically removes them. -The MSI package installs modules in `${env:ProgramFiles}\WindowsPowerShell\Modules`. Both the -`AzureRM` and `Azure` modules are installed. - -> [!NOTE] -> Only use the `Azure` module if you are working with the Azure classic deployment model. - -To start working with Azure PowerShell, sign in with your Azure credentials. - -```azurepowershell -# Connect to Azure with an interactive dialog for sign-in -Connect-AzureRmAccount -``` - -> [!NOTE] -> If you've disabled module autoloading, you need to manually import the module with -> `Import-Module -Name AzureRM`. Because of the way the module is structured, this can take a few -> seconds. - -You'll need to repeat this step for every new PowerShell session you start. To learn how to persist -your Azure sign-in across PowerShell sessions, see -[Persist user credentials across PowerShell sessions](context-persistence.md). diff --git a/docs-conceptual/azurermps-6.13.0/overview.md b/docs-conceptual/azurermps-6.13.0/overview.md deleted file mode 100644 index cae211b025..0000000000 --- a/docs-conceptual/azurermps-6.13.0/overview.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Overview of the AzureRM PowerShell module | Microsoft Docs -description: An overview of Azure PowerShell with links to installation and configuration. -ms.devlang: powershell -ms.topic: conceptual - -ms.custom: devx-track-azurepowershell ---- -# Overview of the AzureRM PowerShell module - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -Azure PowerShell provides a set of cmdlets that use the -[Azure Resource Manager](/azure/azure-resource-manager/resource-group-overview) model for managing -your Azure resources. You can use it in your browser with -[Azure Cloud Shell](/azure/cloud-shell/overview), or you can install it on your local machine and -use it in any PowerShell session. - -Use the [Cloud Shell](/azure/cloud-shell/overview) to run the Azure PowerShell in your browser, or -[install](install-azurerm-ps.md) it on own computer. Then read the -[Get Started](get-started-azureps.md) article to begin using it. For information about the latest -release, see the [release notes](release-notes-azureps.md). - -The following samples can help you learn how to perform common scenarios with Azure PowerShell: - -- [Linux Virtual Machines](/azure/virtual-machines/linux/powershell-samples?toc=/powershell/azure/toc.json) -- [Windows Virtual Machines](/azure/virtual-machines/windows/powershell-samples?toc=/powershell/azure/toc.json) -- [Web Apps](/azure/app-service-web/app-service-powershell-samples?toc=/powershell/azure/toc.json) -- [SQL Databases](/azure/sql-database/sql-database-powershell-samples?toc=/powershell/azure/toc.json) - -## Learn PowerShell basics - -If you are unfamiliar with PowerShell, you may find an introduction to PowerShell helpful. - -- [Installing PowerShell](/powershell/scripting/install/installing-powershell) -- [PowerShell learning resources](/powershell/scripting/learn/more-powershell-learning) - -You can also watch this video: -[PowerShell Basics: (Part 1) Getting Started with PowerShell](https://channel9.msdn.com/Blogs/Taste-of-Premier/PowerShellBasicsPart1). - -## Build your skills with Microsoft Learn - -- [Automate Azure tasks using scripts with PowerShell](/learn/modules/automate-azure-tasks-with-powershell/) -- [More interactive learning...](/learn/browse/?term=powershell) - -## Other Azure PowerShell modules - -- [Microsoft Entra ID](/powershell/module/activedirectory/) -- [Azure Service Fabric](/powershell/module/AzureRM.ServiceFabric/) diff --git a/docs-conceptual/azurermps-6.13.0/queries-azureps.md b/docs-conceptual/azurermps-6.13.0/queries-azureps.md deleted file mode 100644 index 2ced58afef..0000000000 --- a/docs-conceptual/azurermps-6.13.0/queries-azureps.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -title: Query output of Azure PowerShell cmdlets -description: How to query for resources in Azure and format the results. -ms.devlang: powershell -ms.topic: conceptual - -ms.custom: devx-track-azurepowershell ---- -# Query output of Azure PowerShell cmdlets - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -Querying in PowerShell can be completed by using built-in cmdlets. In PowerShell, cmdlet names take -the form of **_Verb-Noun_**. The cmdlets using the verb **_Get_** are the query cmdlets. The cmdlet -nouns are the types of Azure resources that are acted upon by the cmdlet verbs. - -## Select simple properties - -Azure PowerShell has default formatting defined for each cmdlet. The most common properties for each -resource type are displayed in a table or list format automatically. For more information about -formatting output, see [Formatting query results](formatting-output.md). - -Use the `Get-AzureRmVM` cmdlet to query for a list of VMs in your account. - -```azurepowershell -Get-AzureRmVM -``` - -The default output is automatically formatted as a table. - -```Output -ResourceGroupName Name Location VmSize OsType NIC ProvisioningState ------------------ ---- -------- ------ ------ --- ----------------- -MYWESTEURG MyUnbuntu1610 westeurope Standard_DS1_v2 Linux myunbuntu1610980 Succeeded -MYWESTEURG MyWin2016VM westeurope Standard_DS1_v2 Windows mywin2016vm880 Succeeded -``` - -The `Select-Object` cmdlet can be used to select the specific properties that are interesting to -you. - -```azurepowershell -Get-AzureRmVM | - Select -Property Name, ResourceGroupName, Location -``` - -```Output -Name ResourceGroupName Location ----- ----------------- -------- -MyUnbuntu1610 MYWESTEURG westeurope -MyWin2016VM MYWESTEURG westeurope -``` - -## Select complex nested properties - -If the property you want is nested in the JSON output, you need to supply the full path to the -property. The following example shows how to select the VM Name and the OS type from the -`Get-AzureRmVM` cmdlet. - -```azurepowershell -Get-AzureRmVM | - Select -Property Name, @{Name='OSType'; Expression={$_.StorageProfile.OSDisk.OSType}} -``` - -```Output -Name OSType ----- ------ -MyUnbuntu1610 Linux -MyWin2016VM Windows -``` - -## Filter results with the Where-Object cmdlet - -The `Where-Object` cmdlet allows you to filter the result based on any property value. In the -following example, the filter selects only VMs that have the text "RGD" in their name. - -```azurepowershell -Get-AzureRmVM | - Where-Object ResourceGroupName -like RGD* | - Select-Object -Property ResourceGroupName, Name -``` - -```Output -ResourceGroupName Name ------------------ ---- -RGDEMO001 KBDemo001VM -RGDEMO001 KBDemo020 -``` - -With the next example, the results will return the VMs that have the vmSize 'Standard_DS1_V2'. - -```azurepowershell -Get-AzureRmVM | - Where-Object vmSize -eq Standard_DS1_V2 -``` - -```Output -ResourceGroupName Name Location VmSize OsType NIC ProvisioningState ------------------ ---- -------- ------ ------ --- ----------------- -MYWESTEURG MyUnbuntu1610 westeurope Standard_DS1_v2 Linux myunbuntu1610980 Succeeded -MYWESTEURG MyWin2016VM westeurope Standard_DS1_v2 Windows mywin2016vm880 Succeeded -``` diff --git a/docs-conceptual/azurermps-6.13.0/release-notes-azureps.md b/docs-conceptual/azurermps-6.13.0/release-notes-azureps.md deleted file mode 100644 index cf2de8503c..0000000000 --- a/docs-conceptual/azurermps-6.13.0/release-notes-azureps.md +++ /dev/null @@ -1,1050 +0,0 @@ ---- -title: Azure PowerShell Change Log | Microsoft Docs -description: This is a history of changes made to Azure PowerShell in the latest release. -ms.devlang: powershell -ms.topic: conceptual -ms.workload: - -ms.custom: devx-track-azurepowershell ---- - -# Release notes - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -This is a list of changes made to Azure PowerShell in this release. - ---- -## 6.13.0 - November 2018 -#### AzureRM.Profile -* Update common code to use latest version of ClientRuntime - -#### AzureRM.ApiManagement -* Update dependencies for type mapping issue - -#### AzureRM.Automation -* Swagger based Azure Automation cmdlets -* Added Update Management cmdlets -* Added Source Control cmdlets -* Added Remove-AzureRmAutomationHybridWorkerGroup cmdlet -* Fixed the DSC Register Node command - -#### AzureRM.Compute -* Fixed identity issue for SystemAssigned identity -* Update dependencies for type mapping issue - -#### AzureRM.ContainerInstance -* Update dependencies for type mapping issue - -#### AzureRM.MarketplaceOrdering -* update the examples description for marketplace cmdlets - -#### AzureRM.Network -* Added cmdlet New-AzureRmApplicationGatewayCustomError, Add-AzureRmApplicationGatewayCustomError, Get-AzureRmApplicationGatewayCustomError, Set-AzureRmApplicationGatewayCustomError, Remove-AzureRmApplicationGatewayCustomError, Add-AzureRmApplicationGatewayHttpListenerCustomError, Get-AzureRmApplicationGatewayHttpListenerCustomError, Set-AzureRmApplicationGatewayHttpListenerCustomError, Remove-AzureRmApplicationGatewayHttpListenerCustomError -* Added ICMP back to supported AzureFirewall Network Protocols -* Update cmdlet Test-AzureRmNetworkWatcherConnectivity, add validation on destination id, address and port. -* Fix issues with memory usage in VirtualNetwork map - -#### AzureRM.RecoveryServices.Backup -* Fix for modifying policy for a protected file share. -* Converted policy timezone to uppercase. - -#### AzureRM.RecoveryServices.SiteRecovery -* Corrected example in New-AzureRmRecoveryServicesAsrProtectableItem -* Update dependencies for type mapping issue - -#### AzureRM.Relay -* Added optional Parameter -KeyValue to New-AzureRmRelayKey cmdlet, which enables user to provide KeyValue. - -#### AzureRM.Resources -* Update help documentation for resource identity related parameters in `New-AzureRmPolicyAssignment` and `Set-AzureRmPolicyAssignment` -* Add an example for New-AzureRmPolicyDefinition that uses -Metadata -* Fix to allow case preservation in Tag keys in NetStandard: #7678 #7703 - -#### AzureRM.ServiceFabric -* Add deprecation messages for upcoming breaking changes - -#### AzureRM.Sql -* Added new cmdlets for CRUD operations on Azure Sql Database Managed Instance and Azure Sql Managed Database - - Get-AzureRmSqlInstance - - New-AzureRmSqlInstance - - Set-AzureRmSqlInstance - - Remove-AzureRmSqlInstance - - Get-AzureRmSqlInstanceDatabase - - New-AzureRmSqlInstanceDatabase - - Restore-AzureRmSqlInstanceDatabase - - Remove-AzureRmSqlInstanceDatabase -* Enabled Extended Auditing Policy management on a server or a database. - - New parameter (PredicateExpression) was added to enable filtering of audit logs. - - Cmdlets were modified to use SQL clients instead of Legacy clients. - - Set-AzureRmSqlServerAuditing. - - Get-AzureRmSqlServerAuditing. - - Set-AzureRmSqlDatabaseAuditing. - - Get-AzureRmSqlDatabaseAuditing. -* Fixed issue with using Update-AzureRmSqlDatabaseVulnerabilityAssessmentSettings with storage account name parameter set - -## 6.12.0 - November 2018 -#### AzureRM.Profile -* Update common code to use latest version of ClientRuntime -* Rename param TenantId in cmdlet Connect-AzureRmAccount to Tenant and add an alias for TenantId -* Updated TenantId description for Connect-AzureRmAccount -* Fix error message for failed login when providing tenant domain - - https://github.com/Azure/azure-powershell/issues/6936 -* Fix issue with context name clashing for accounts with no subscriptions in tenant - - https://github.com/Azure/azure-powershell/issues/7453 -* Fix issue with DataLake endpoints when using MSI - - https://github.com/Azure/azure-powershell/issues/7462 -* Fix issue where 'Disconnect-AzureRmAccount' would throw if not connected - - https://github.com/Azure/azure-powershell/issues/7167 - -#### AzureRM.Automation -* Renamed cmdlet DLL filename to Microsoft.Azure.Commands.Automation.dll - -#### AzureRM.CognitiveServices -* Add Get-AzureRmCognitiveServicesAccountSkus operation. - -#### AzureRM.Compute -* Add Add-AzureRmVmssVMDataDisk and Remove-AzureRmVmssVMDataDisk cmdlets -* Get-AzureRmVMImage shows AutomaticOSUpgradeProperties -* Fixed SetAzureRmVMChefExtension -BootstrapOptions and -JsonAttribute option values are not setting in json format. - -#### AzureRM.DataLakeStore -* Update the DataLake package to 1.1.10. -* Add default Concurrency to multithreaded operations. - -#### AzureRM.Insights -* Fixed issue #7267 (Autoscale area) - - Issues with creating a new autoscale rule not properly setting enumerated parameters (would always set them to the default value). -* Fixed issue #7513 [Insights] Set-AzureRMDiagnosticSetting requires explicit specification of categories during creation of setting - - Now the cmdlet does not require explicit indication of the categories to enable during creation, i.e. it works as it is documented - -#### AzureRM.Network -* Changed PeeringType to be a mandatory parameter for the following cmdlets:- - - Get-AzureRmExpressRouteCircuitRouteTable - - Get-AzureRmExpressRouteCircuitARPTable - - Get-AzureRmExpressRouteCircuitRouteTableSummary - - Get-AzureRMExpressRouteCrossConnectionArpTable - - Get-AzureRMExpressRouteCrossConnectionRouteTable - - Get-AzureRMExpressRouteCrossConnectionRouteTableSummary - -#### AzureRM.PolicyInsights -* Added policy remediation cmdlets - -#### AzureRM.RecoveryServices.Backup -* Added support for azure file shares in recovery services. - -#### AzureRM.Resources -* Fix for https://github.com/Azure/azure-powershell/issues/7402 - - Allow listing resources using the '-ResourceId' parameter for 'Get-AzureRmResource' - -#### AzureRM.ServiceBus -* Added MigrationState read-only property to PSServiceBusMigrationConfigurationAttributes which will help to know the Migration state. - -#### AzureRM.ServiceFabric -* Fix add certificate to Linux Vmss. -* Fix 'Add-AzureRmServiceFabricClusterCertificate' - - Using correct thumbprint from new certificate (Azure/service-fabric-issues#932). - - Display exception correctly (Azure/service-fabric-issues#1054). -* Fix 'Update-AzureRmServiceFabricDurability' to update cluster configuration before starting Vmss CreateOrUpdate operation. - -## 6.11.0 - October 2018 -#### AzureRM.Profile -* Fix issue with Get-AzureRmSubscription in CloudShell -* Update common code to use latest version of ClientRuntime - -#### AzureRM.Backup -* Deprecated Azure Backup cmdlets. - -#### AzureRM.Compute -* Added new sizes to the allowlist of VM sizes for which accelerated networking will be turned on when using the simple param set for 'New-AzureRmVm' -* Added ResourceName argument completer to all cmdlets. - -#### AzureRM.DataLakeStore -* Adding support for Virtual Network Rules - - Get-AzureRmDataLakeStoreVirtualNetworkRule: Gets or Lists Azure Data Lake Store virtual network rule. - - Add-AzureRmDataLakeStoreVirtualNetworkRule: Adds a virtual network rule to the specified Data Lake Store account. - - Set-AzureRmDataLakeStoreVirtualNetworkRule: Modifies the specified virtual network rule in the specified Data Lake Store account. - - Remove-AzureRmDataLakeStoreVirtualNetworkRule: Deletes an Azure Data Lake Store virtual network rule. - -#### AzureRM.Network -* Update cmdlet Test-AzureRmNetworkWatcherConnectivity, pass the protocol value to backend. -* Added ResourceName argument completer to all cmdlets. - -#### AzureRM.Resources -* Fix isssue where Get-AzureRMRoleDefinition throws an unintelligible exception (when the default profile has no subscription in it and no scope is specified) by adding a meaningful exception in the scenario. Also set the default param set to 'RoleDefinitionNameParameterSet'. - -## 6.10.0 - October 2018 -#### Azure.Storage -* Fix Copy Blob/File won't copy metadata when destination has metadata issue - - Start-AzureStorageBlobCopy - - Start-AzureStorageFileCopy - -#### AzureRM.CognitiveServices -* Support Get-AzureRmCognitiveServicesAccountSkus without an existing account. - -#### AzureRM.Compute -* Fix Get-AzureRmVM -ResourceGroupName `<rg>` to return more than 50 results if needed -* Added an example of the 'SimpleParameterSet' to New-AzureRmVmss cmdlet help. -* Fixed a typo in the Azure Disk Encryption progress message - -#### AzureRM.DataFactoryV2 -* Updated the ADF .Net SDK version to 2.3.0. - -#### AzureRM.Network -* Added NetworkProfile functionality. new cmdlets added - - Get-AzureRMNetworkProfile - - New-AzureRMNetworkProfile - - Remove-AzureRMNetworkProfile - - Set-AzureRMNetworkProfile - - New-AzureRMContainerNicConfig - - New-AzureRmContainerNicConfigIpConfig -* Added service association link on Subnet Model -* Added cmdlet New-AzureRmVirtualNetworkTap, Get-AzureRmVirtualNetworkTap, Set-AzureRmVirtualNetworkTap, Remove-AzureRmVirtualNetworkTap -* Added cmdlet Set-AzureRmNEtworkInterfaceTapConfig, Get-AzureRmNEtworkInterfaceTapConfig, Remove-AzureRmNEtworkInterfaceTapConfig - -#### AzureRM.RedisCache -* Allow any string as Size parameter going forward. Add P5 in PSArgumentCompleter popup - -#### AzureRM.Resources -* Add missing -Mode parameter to Set-AzureRmPolicyDefinition -* Fix Get-AzureRmProviderOperation commandlet bug for operations with Origin containing User - -#### AzureRM.Sql -* Fixed issue where some backup cmdlets would not recognize the current azure subscription - -#### AzureRM.Storage -* Support get the Storage resource usage of a specific location, and add warning message for get global Storage resource usage is obsolete. - - Get-AzureRmStorageUsage - -#### AzureRM.Websites -* New Cmdlet Get-AzureRMWebAppContainerContinuousDeploymentUrl - Gets the Container Continuous Deployment Webhook URL -* New Cmdlets New-AzureRMWebAppContainerPSSession and Enter-WebAppContainerPSSession - Initiates a PowerShell remote session into a windows container app - -## 6.9.0 - September 2018 -#### General -* AzureRM.SignalR was added to the AzureRM rollup module - -#### AzureRM.Profile -* Minor changes to the storage common code -* Updated help files to include full parameter types. -* Changed -ServicePrincipal to non-mandatory in the ServicePrincipalCertificateWithSubscriptionId parameter set - -#### Azure.Storage -* Support create Storage Context with OAuth. - - New-AzureStorageContext - -#### AzureRM.Cdn -* Added Standard_Microsoft in Cdn pricing sku. - -#### AzureRM.Compute -* Move dependencies on Keyvault and Storage to the common dependencies -* Add support for more virutal machine sizes to AEM cmdlets -* Add PublicIPPrefix parameter to New-AzureRmVmssIpConfig -* Add ResourceId parameter to Invoke-AzureRmVMRunCommand cmdelt -* Add Invoke-AzureRmVmssVMRunCommand cmdlet - -#### AzureRM.Dns -* Added support for alias record during dns record creation - -#### AzureRM.Insights -* Fixed issues #6833 and #7102 (Diagnostic Settings area) - - Issues with the default name, i.e. 'service', during creation and listing/getting of diagnostic settings - - Issues creating diagnostic settings with categories -* Added deprecation message for metrics time grains parameters - - Timegrains parameters are still being accepted (this is a non-breaking change,) but they are ignored in the backend since only PT1M is valid - -#### AzureRM.Network -* Changes to LoadBalancer cmdlets - - LoadBalancerInboundNatPoolConfig: added parameters IdleTimeoutInMinutes, EnableFloatingIp and EnableTcpReset - - LoadBalancerInboundNatRuleConfig: added parameter EnableTcpReset - - LoadBalancerRuleConfig: added parameter EnableTcpReset - - LoadBalancerProbeConfig: added support for value "Https" for parameter Protocol -* Added new commands for new LoadBalancer's subresource OutboundRule - - Add-AzureRmLoadBalancerOutboundRuleConfig - - Get-AzureRmLoadBalancerOutboundRuleConfig - - New-AzureRmLoadBalancerOutboundRuleConfig - - Set-AzureRmLoadBalancerOutboundRuleConfig - - Remove-AzureRmLoadBalancerOutboundRuleConfig -* Added new HostedWorkloads property for PSNetworkInterface -* Added new cmdlets for feature: Azure Firewall via ARM - - Added Get-AzureRmFirewall - - Added Set-AzureRmFirewall - - Added New-AzureRmFirewall - - Added Remove-AzureRmFirewall - - Added New-AzureRmFirewallApplicationRuleCollection - - Added New-AzureRmFirewallApplicationRule - - Added New-AzureRmFirewallNatRuleCollection - - Added New-AzureRmFirewallNatRule - - Added New-AzureRmFirewallNetworkRuleCollection - - Added New-AzureRmFirewallNetworkRule -* Added support for Trusted Root certificate and Autoscale configuration in Application Gateway - - New Cmdlets added: - - Add-AzureRmApplicationGatewayTrustedRootCertificate - - Get-AzureRmApplicationGatewayTrustedRootCertificate - - New-AzureRmApplicationGatewayTrustedRootCertificate - - Remove-AzureRmApplicationGatewayTrustedRootCertificate - - Set-AzureRmApplicationGatewayTrustedRootCertificate - - Get-AzureRmApplicationGatewayAutoscaleConfiguration - - New-AzureRmApplicationGatewayAutoscaleConfiguration - - Remove-AzureRmApplicationGatewayAutoscaleConfiguration - - Set-AzureRmApplicationGatewayAutoscaleConfiguration - - Cmdlets updated with optonal parameter -TrustedRootCertificate - - New-AzureRmApplicationGateway - - Set-AzureRmApplicationGateway - - New-AzureRmApplicationGatewayBackendHttpSetting - - Set-AzureRmApplicationGatewayBackendHttpSetting - - Cmdlets updated with optonal parameter -AutoscaleConfiguration - - New-AzureRmApplicationGateway - - Set-AzureRmApplicationGateway -* Add cmdlet for Interface Endpoint Get-AzureInterfaceEndpoint -* Added support for multiple address prefixes in a subnet. Updated cmdlets: - - New-AzureRmVirtualNetworkSubnetConfig - - Set-AzureRmVirtualNetworkSubnetConfig - - Add-AzureRmVirtualNetworkSubnetConfig - - Get-AzureRmVirtualNetworkSubnetConfig - - Add-AzureRmApplicationGatewayAuthenticationCertificate - - Add-AzureRmApplicationGatewayFrontendIPConfig - - New-AzureRmApplicationGatewayFrontendIPConfig - - Set-AzureRmApplicationGatewayFrontendIPConfig - - Add-AzureRmApplicationGatewayIPConfiguration - - New-AzureRmApplicationGatewayIPConfiguration - - Set-AzureRmApplicationGatewayIPConfiguration - - Add-AzureRmNetworkInterfaceIpConfig - - New-AzureRmNetworkInterfaceIpConfig - Set-AzureRmNetworkInterfaceIpConfig - - New-AzureRmVirtualNetworkGatewayIpConfig - - Add-AzureRmVirtualNetworkGatewayIpConfig - - Set-AzureRmLoadBalancerFrontendIpConfig - - Add-AzureRmLoadBalancerFrontendIpConfig - - New-AzureRmLoadBalancerFrontendIpConfig - - New-AzureRmNetworkInterface -* Adding cmdlets for subnet delegation. - - New-AzureRmDelegation: Creates a new delegation, which can be added to a subnet - - Remove-AzureRmDelegation: Takes in a subnet and removes the provided delegation name from that subnet - - Add-AzureRmDelegation: Takes in a subnet and adds the provided service name as a delegation to that subnet - - Get-AzureRmDelegation - - Get-AzureRmAvailableServiceDelegations - -#### AzureRM.RecoveryServices.SiteRecovery -* Support for managed Managed disk - -#### AzureRM.RedisCache -* Updated Insights dependency. - -#### AzureRM.Resources -* Update New-AzureRmResourceGroupDeployment with new parameter RollbackAction - - Add support for OnErrorDeployment with the new parameter. -* Support managed identity on policy assignments. -* Parameters with default values are no longer requred when assigning a policy with 'New-AzureRmPolicyAssignment' -* Add new cmdlet Get-AzureRmPolicyAlias for retrieving policy aliases - -#### AzureRM.ServiceBus -* Fixed issue #7161 - -#### AzureRM.SignalR -* Update SKU names to Free_F1 and Standard_S1 -* Add version field to the PSSignalRResource object and connection string to the PSSignalRKeys object. - -#### AzureRM.Storage -* Support Immutability Policy in AzureRm.Storage - - Remove-AzureRmStorageAccountNetworkRule - - Get-AzureRmStorageContainer - - Update-AzureRmStorageContainer - - New-AzureRmStorageContainer - - Remove-AzureRmStorageContainer - - Add-AzureRmStorageContainerLegalHold - - Remove-AzureRmStorageContainerLegalHold - - Set-AzureRmStorageContainerImmutabilityPolicy - - Get-AzureRmStorageContainerImmutabilityPolicy - - Remove-AzureRmStorageContainerImmutabilityPolicy - - Lock-AzureRmStorageContainerImmutabilityPolicy - -#### AzureRM.Websites -* Added two new cmdlets: Get-AzureRmDeletedWebApp and Restore-AzureRmDeletedWebApp -* New-AzureRmAppServicePlan -HyperV switch is added for create app service plan with windows container -* New-AzureRmWebApp/ New-AzureRmWebAppSlot/ Set-AzureRmWebApp/ Set-AzureRmWebAppSlot - New parameters (–ContainerRegistryUser string -ContainerRegistryPassword secureString -EnableContainerContinuousDeployment) added for creating and managing windows container app - -## 6.8.1 - August 2018 -#### General -* Fixed issue with default resource groups not being set. -* Updated common runtime assemblies - -#### AzureRM.ApiManagement -* Fixed issue with default resource groups not being set. -* Fixed issue https://github.com/Azure/azure-powershell/issues/6603 - - Import-AzureRmApiManagementApi and *-AzureRmApiManagementCertificate cmdlets now handle relative Paths -* Fixed issue https://github.com/Azure/azure-powershell/issues/6879 - - The CertificateInformation is a settable property allowing for Set-AzureRmApiManagement cmdlet to work property. Fixed by upgrading to - 4.0.4-preview nuget -* Fixed issue https://github.com/Azure/azure-powershell/issues/6853 - - Fixed the Odata filter for Search by Name on Product -* Fixed issue https://github.com/Azure/azure-powershell/issues/6814 - - Fixed the Odata filter for Search by Name on Api -* Added support for AzureMonitor logger - - -#### AzureRM.Compute -* Fixed the issue that target is missing in error output. -* Fixed issue with storage account type for VM with managed disk -* Fixed issue with default resource groups not being set. -* Fix AEM Extension cmdlets for other environments, for example Azure China - -#### AzureRM.Network -* Changed default cmdlet output presentation to table view - -#### AzureRM.PowerBIEmbedded -* Fix failure in Update-AzureRmPowerBIEmbeddedCapacity when trying to scale paused capacity - - -#### AzureRM.Resources -* Fixed issue with creating managed applications from the MarketPlace. - -#### AzureRM.ServiceBus -* Fixed issues - - https://github.com/Azure/azure-powershell/issues/5058 - - https://github.com/Azure/azure-powershell/issues/5055 - - https://github.com/Azure/azure-powershell/issues/6891 - -#### AzureRM.TrafficManager -* Added Support for the MultiValue routing method - - New parameter 'MaxReturn' for MultiValue routing -* Added Support for the Subnet routing method - - Support for IP address ranges (subnets) in endpoints -* Added Support for Custom Headers in profiles -* Added Support for Expected status code ranges in profiles -* Added Support for Custom Headers in endpoints - -## 6.8.0 - August 2018 -#### General -* Fixed issue with default resource groups not being set. - -#### AzureRM.Profile -* Added expiration property to tokens returned during Connect-AzureRmAccount - -#### AzureRM.Compute -* Fixed the issue that target is missing in error output. -* Fixed issue with storage account type for VM with managed disk -* Fix AEM Extension cmdlets for other environments, for example Azure China - -#### AzureRM.IotHub -* Fix examples for New-AzureRmIotHubExportDevices and New-AzureRmIotHubImportDevices - -#### AzureRM.Network -* Changed default models representation to table-view - -#### AzureRM.PowerBIEmbedded -* Fix failure in Update-AzureRmPowerBIEmbeddedCapacity when trying to scale paused capacity - -#### AzureRM.Resources -* Fixed issue with creating managed application from the MarketPlace. - -#### AzureRM.ServiceBus -* Fix for issues - - https://github.com/Azure/azure-powershell/issues/5058 - - https://github.com/Azure/azure-powershell/issues/5055 - - https://github.com/Azure/azure-powershell/issues/6891 - -#### AzureRM.TrafficManager -* Support for the MultiValue routing method - - New parameter 'MaxReturn' for MultiValue routing -* Support for the Subnet routing method - - Support for IP address ranges (subnets) in endpoints -* Support for Custom Headers in profiles -* Support for Expected status code ranges in profiles -* Support for Custom Headers in endpoints - -#### AzureRM.Websites -* Fixed issue with default resource group being set incorrectly. - -## 6.7.0 - August 2018 -#### AzureRM.Profile -* Updated to the latest version of the Azure ClientRuntime. -* Add user id to default context name to avoid context clashing - - https://github.com/Azure/azure-powershell/issues/6489 -* Fix issues with Clear-AzureRmContext that caused issues with selecting a context #6398 -* Enable tenant domain to be passed to '-TenantId' parameter for 'Connect-AzureRmAccount' - - https://github.com/Azure/azure-powershell/issues/3974 - - https://github.com/Azure/azure-powershell/issues/6709 - -#### Azure.Storage -* Remove the 5TB limitation for Azure File Share quota -* Set-AzureStorageShareQuota - -#### AzureRM.AnalysisServices -* Updated to the latest version of the Azure ClientRuntime. - -#### Azure.AnalysisServices -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.ApiManagement -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.ApplicationInsights -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.Automation -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.Backup -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.Batch -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.Billing -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.Cdn -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.CognitiveServices -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.Compute -* Updated to the latest version of the Azure ClientRuntime. -* Add EvictionPolicy parameter to New-AzureRmVmssConfig -* Use default location in the DiskFileParameterSet of New-AzureRmVm if no Location is specified. -* Fix parameter description in Save-AzureRmVMImage -* Fix Get-AzureRmVMDiskEncryptionStatus cmdlet for certain singlepass related scenarios - -#### AzureRM.Consumption -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.ContainerInstance -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.ContainerRegistry -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.DataFactories -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.DataFactoryV2 -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.DataLakeAnalytics -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.DataLakeStore -* Fix debugging when DebugPreference is set from powershell command line -* Update example for Set-AzureRmDataLakeStoreItemAcl -* Updated to the latest version of the Azure ClientRuntime. -* Update example for Set-AzureRmDataLakeStoreItemAclEntry - -#### AzureRM.DevTestLabs -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.Dns -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.EventGrid -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.EventHub -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.HDInsight -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.Insights -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.IotHub -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.KeyVault -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.LogicApp -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.MachineLearning -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.MachineLearningCompute -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.MarketplaceOrdering -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.Media -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.Network -* Added example for Set-AzureRmLocalNetworkGateway -* Added examples and descriptions for Add-AzureRmVirtualNetworkGatewayIpConfig, Get-AzureRmVirtualNetworkGatewayConnectionSharedKey and New-AzureRmVirtualNetworkGatewayConnection -* Added examples for Remove-AzureRmVirtualNetworkGatewayIpConfig and Reset-AzureRmVirtualNetworkGateway -* Added example for Reset-AzureRmVirtualNetworkGatewayConnectionSharedKey -* Added example for Set-AzureRmVirtualNetworkGatewayConnectionSharedKey -* Added example for Set-AzureRmVirtualNetworkGatewayConnection -* Re-generated cmdlets for ApplicationSecurityGroup, RouteTable and Usage using latest code generator -* Clarified error message for Get-AzureRmVirtualNetworkSubnetConfig when attempting to get a subnet that does not exitc - -#### AzureRM.NotificationHubs -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.OperationalInsights -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.PolicyInsights -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.PowerBIEmbedded -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.RecoveryServices -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.RecoveryServices.Backup -* Added policy filter to Get-AzureRmRecoveryServicesBackItem cmdlet. The command returns the list of backup items protected by the given policy id. -* Updated Microsoft.Azure.Management.RecoveryServices.Backup to version 3.0.0-preview. -* Updated to the latest version of the Azure ClientRuntime. -* Added TargetResourceGroupName parameter to Restore-AzureRmRecoveryServicesBackupItem. The resource group to which the managed disks are restored. Applicable to backup of VM with managed disks. - -#### AzureRM.RecoveryServices.SiteRecovery -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.RedisCache -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.Relay -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.Resources -* Support template deployment at subscription scope. Add new Cmdlets: - - New-AzureRmDeployment - - Get-AzureRmDeployment - - Test-AzureRmDeployment - - Remove-AzureRmDeployment - - Stop-AzureRmDeployment - - Save-AzureRmDeploymentTemplate - - Get-AzureRmDeploymentOperation -* Fix issue where error is thrown when passing a context to Set-AzureRmResource - - https://github.com/Azure/azure-powershell/issues/5705 -* Fix example in New-AzureRmResourceGroupDeployment -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.Scheduler -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.ServiceBus -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.ServiceFabric -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.Sql -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.Storage -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.StreamAnalytics -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.Tags -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.TrafficManager -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.UsageAggregates -* Updated to the latest version of the Azure ClientRuntime. - -#### AzureRM.Websites -* Updated to the latest version of the Azure ClientRuntime. - -## 6.6.0 - July 2018 -#### General -* Updated all help files to include full parameter types and correct input/output types. - -#### AzureRM.Profile -* Updated Common.Strategy library to be able to validate that the current config for a resource is compatible with the target resource. -* Added ps1xml types to Common.Storage - -#### Azure.Storage -* Added support for getting Storage Context from DefaultProfile -* Added Ps1XmlAttribute to cmdlets output types properties. - -#### AzureRM.ApiManagement -* Fixed issue https://github.com/Azure/azure-powershell/issues/6370 - - Fixed bug in Automapper to translate PsApiManagementApi to ApiContract -* Fixed issue https://github.com/Azure/azure-powershell/issues/6515 - - Fixed bug in File.Save to not overload with Encoding Type -* Fixed issue https://github.com/Azure/azure-powershell/issues/6560 - - Upgraded to 4.0.3 Nuget version which fixes the pattern exception on apiId - -#### AzureRM.Compute -* Fix issue with creating a vm using DiskFileParameterSet in New-AzureRmVm failing because of PremiumLRS storage account type renaming. -* Fix Invoke-AzureRmVMRunCommand cmdlet -* Update Get-AzureRmAvailabilitySet to enable list all availability sets in a subscription. (ResouceGroupName parameter is now optional.) -* Update SimpleParameterSet of 'New-AzureRmVm' to enable Accelerated Network on qualifying vms. -* Update New-AzureRmVmss simple parameter set to fail creating the vmss when a user specified LB already exists. -* Update example for New-AzureRmDisk -* Add example for 'New-AzureRmVM' -* Update description for Set-AzureRmVMOSDisk -* Update Example 1 for Set-AzureRmVMBginfoExtension to correct spelling and prefix. - -#### AzureRM.DataFactoryV2 -* Updated the ADF .Net SDK version to 1.1.0. -* Support self-hosted integration runtime sharing across data factories. - - Add new parameter -SharedIntegrationRuntimeResourceId to Set-AzureRmDataFactoryV2IntegrationRuntime cmdlet. - - Add new optional parameter -LinkedDataFactoryName to Remove-AzureRmDataFactoryV2IntegrationRuntime cmdlet. - -#### AzureRM.DataLakeStore -* Updated the DataPlane SDK (Microsoft.Azure.DataLake.Store) version to 1.1.9 - -#### AzureRM.EventHub -* Updated piping for InputObject and ResourceId in remove cmdlets - -#### AzureRM.Insights -* Fixed formatting of OutputType in help files -* Using Microsoft.Azure.Management.Monitor SDK 0.19.1-preview - -#### AzureRM.KeyVault -* Fix piping issue in Set-AzureRmKeyVaultAccessPolicy - -#### AzureRM.Network -* Added examples for LoadBalancerInboundNatPoolConfig cmdlets. - -#### AzureRM.Resources -* Fix issue when providing both tag name and value for 'Get-AzureRmResource' - - https://github.com/Azure/azure-powershell/issues/6765 -* Fix piping scenario with 'Set-AzureRmResource' - -#### AzureRM.ServiceBus -* Updated piping for InputObject and ResourceId in remove cmdlets -* fixed few issues - - https://github.com/Azure/azure-powershell/issues/3780 - - https://github.com/Azure/azure-powershell/issues/4340 - -#### AzureRM.Sql -* Adding Server Advanced Threat Protection support with the following cmdlets: - - Enable-AzureRmSqlServerAdvancedThreatProtection; Disable-AzureRmSqlServerAdvancedThreatProtection; Get-AzureRmSqlServerAdvancedThreatProtectionPolicy -* Adding Vulnerability Assessment support with the following cmdlets: - - Update-AzureRmSqlDatabaseVulnerabilityAssessmentSettings; Get-AzureRmSqlDatabaseVulnerabilityAssessmentSettings; Clear-AzureRmSqlDatabaseVulnerabilityAssessmentSettings - - Set-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline; Get-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline; Clear-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline - - Convert-AzureRmSqlDatabaseVulnerabilityAssessmentScan; Get-AzureRmSqlDatabaseVulnerabilityAssessmentScanRecord; Start-AzureRmSqlDatabaseVulnerabilityAssessmentScan -* Fixed example in Remove-AzureRmSqlServerFirewallRule -* Fix datetime handling incorrectly for non-us base culture in Get-AzureSqlSyncGroupLog - -#### AzureRM.Storage -* Add Ps1XmlAttribute to cmdlets output types properties -* Show StorageAccount cmdlet output in table view - - Get-AzureRmStorageAccount - - New-AzureRmStorageAccount - - Set-AzureRmStorageAccount - -#### AzureRM.Tags -* Remove incorrect statement from Tag cmdlet help - - https://github.com/Azure/azure-powershell/issues/3878 - -## 6.5.0 - July 2018 -#### AzureRM.Profile -* Updated help for 'Get-AzureRmContextAutosaveSetting' - -#### Azure.Storage -* Support Upload Blob or File with write only Sas token -* Set-AzureStorageBlobContent -* Set-AzureStorageFileContent - -#### AzureRM.AnalysisServices -* Add required property ResourceGroupName to AS. - -#### AzureRM.Automation -* Update help and add example for 'New-AzureRMAutomationSchedule' - -#### AzureRM.Compute -* Add -Tag parameter to Update/New-AzureRmAvailabilitySet -* Add example for 'Add-AzureRmVmssExtension' -* Add examples for 'Remove-AzureRmVmssExtension' -* Update help for 'Set-AzureRmVMAccessExtension' -* Update SimpleParameterSet for New-AzureRmVmss to set SinglePlacementGroup to false by default and add switch parameter 'SinglePlacementGroup' that enables the user to create the VMSS in a single placement group. - -#### AzureRM.EventHub -* Added a readonly property 'PendingReplicationOperationsCount' to PSEventHubDRConfigurationAttributes class, which gives the pending replication operations count while replication is in progress - -#### AzureRM.KeyVault -* Update error message for Set-AzureRmKeyVaultAccessPolicy - -#### AzureRM.LogicApp -* Fixed "parameter set could not be resolved" error in New-AzureRmLogicApp - -#### AzureRM.Network -* Enable peering across Virtual Networks in multiple Tenants for Set/Add-AzureRmVirtualNetworkPeering -* Updated below cmdlets for Application Gateway - - New-AzureRmApplicationGateway : Added EnableFIPS flag and Zones support - - New-AzureRmApplicationGatewaySku : Added new skus Standard_v2 and WAF_v2 - - Set-AzureRmApplicationGatewaySku : Added new skus Standard_v2 and WAF_v2 -* Regenerated RouteTable cmdlets with the latest generator version - -#### AzureRM.Relay -* Updated markdown files, fix for the parameter name issue in example - -#### AzureRM.Resources -* Update Roleassignment and roledefinition cmdlets: - - Remove extra roledefinition calls done as part of paging. -* Fix Get-AzureRmRoleAssignment cmdlet - - Fix -ExpandPrincipalGroups command parameter functionality -* Fix issue with 'Get-AzureRmResource' where '-ResourceType' parameter was case sensitive - -#### AzureRM.ServiceBus -* Added top and skip parameter to list cmdlets -* Added Standard to Premium NameSpace migration cmdlets : - - Start-AzureRmServiceBusMigration - - Get-AzureRmServiceBusMigration - - Complete-AzureRmServiceBusMigration - - Stop-AzureRmServiceBusMigration - - Remove-AzureRmServiceBusMigration -* Added a readonly property 'PendingReplicationOperationsCount' to PSServiceBusDRConfigurationAttributes class, which gives the pending replication operations count while replication is in progress - -#### AzureRM.ServiceFabric -* Update example for 'New-AzureRmServiceFabricCluster' - -#### AzureRM.Sql -* Adding new Cmdlets for Management.Sql to allow customers to add TDE Certificate to Sql Server instance or a Managed Instance - - Add-AzureRmSqlServerTransparentDataEncryptionCertificate - - Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate - -#### AzureRM.Websites -* `Set-AzureRmWebApp -AssignIdentity` and `Set-AzureRmWebAppSlot -AssignIdentity` when set to false will now remove the Identity property from the site object.Removing preview tag as well. -* `Get-AzureRmWebAppMetrics`,`Get-AzureRmAppServicePlanMetrics` example updated -* `Set-AzureRmWebApp -PhpVersion` supports off as a valid php version - -## 6.4.0 - July 2018 -#### General -* Fixed formatting of OutputType in help files for most modules - -#### AzureRM.Profile -* Ps1Xml attribute added to the basic output types - -#### AzureRM.Compute -* IP Tag feature for VMSS - - 'New-AzureRmVmssIpTagConfig' cmdlet is added - - IpTag parameter is added to New-AzureRmVmssIpConfig -* Auto OS Rollback feature for VMSS - - DisableAutoRollback parameters are added to New-AzureRmVmssConfig and Update-AzureRmVmss -* OS Upgrade History feature for Vmss - - OSUpgradeHistory switch parameter is added to Get-AzureRmVmss - -#### AzureRM.DataLakeAnalytics -* Add support for Catalog ACLs through the following commands: - - Get-AzureRmDataLakeAnalyticsCatalogItemAclEntry - - Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry - - Remove-AzureRmDataLakeAnalyticsCatalogItemAclEntry - -#### AzureRM.DataLakeStore -* Add cancellation support and progress tracking for Set-AzureRmDataLakeStoreItemAclEntry, Remove-AzureRmDataLakeStoreItemAclEntry, Set-AzureRmDataLakeStoreItemAcl -* Add cancellation support for Export-AzureRmDataLakeStoreChildItemProperties -* Fix flushing of debug messages for cmdlets that does recursive operations -* Fix location of test of DataLake cmdlets - -#### AzureRM.EventHub -* Added Optional MaxCount parameter to List Operations cmdlet Get-AzureRmEventHub and Get-AzureRmEventHubConsumerGroup -* Fixed issue in New-AzureRmEventHub cmdlet where at least one parameter needed while creating New EventHub. Provided Default Parameter set. -* Added optional Parameter -KeyValue to New-AzureRmEventHubKey cmdlet, which enables user to provide KeyValue. - -#### AzureRM.KeyVault -* Fix issue where all resources were being returned by Get-AzureRmKeyVault -Tag - -#### AzureRM.Network -* Expose new Skus for Zone-Redundant VirtualNetworkGateways -* Added new commands for feature: ExpressRoute Partner APIs via ARM - - Added Get-AzureRmExpressRouteCrossConnection - - Added Set-AzureRmExpressRouteCrossConnection - - Added Add-AzureRmExpressRouteCrossConnectionPeering - - Added Get-AzureRmExpressRouteCrossConnectionPeering - - Added Remove-AzureRmExpressRouteCrossConnectionPeering - - Added Get-AzureRMExpressRouteCrossConnectionArpTable - - Added Get-AzureRMExpressRouteCrossConnectionRouteTable - - Added Get-AzureRMExpressRouteCrossConnectionRouteTableSummary - -#### AzureRM.RecoveryServices.Backup -* Added Get-AzureRmRecoveryServicesBackupStatus cmdlet. This cmdlet takes a VM ID and checks if the VM is protected by some vault in the subscription. If there exists such a vault, the cmdlet outputs the vault details. - -#### AzureRM.Resources -* Update Get-AzureRmPolicyAssignment cmdlets: - - Add support for listing -Scope values at management group level - - Add support for retrieving individual assignments with -Scope values at management group level - - Add -Effective and -All switches to control parameter -* Update Get/New/Remove/Set-AzureRmPolicyDefinition cmdlets - - Add -ManagementGroupName parameter to apply operations to a given management group - - Add -SubscriptionId parameter to apply operations to a given subscription -* Update Get/New/Remove/Set-AzureRmPolicySetDefinition cmdlets - - Add -ManagementGroupName parameter to apply operations to a given management group - - Add -SubscriptionId parameter to apply operations to a given subscription -* Add KeyVault secret reference support in parameters when using 'TemplateParameterObject' in 'New-AzureRmResourceGroupDeployment' -* Fix issue where '-EndDate' parameter was ignored for 'New-AzureRmADAppCredential' - - https://github.com/Azure/azure-powershell/issues/6505 -* Fix issue where 'Add-AzureRmADGroupMember' used incorrect URL to make request - - https://github.com/Azure/azure-powershell/issues/6485 - -#### AzureRM.ServiceBus -* Added optional Parameter -KeyValue to New-AzureRmServiceBusKey cmdlet, which enables user to provide KeyValue. - -#### AzureRM.Sql -* Clarified User-Defined Restore Points for SQLDW in New-AzureRmSqlDatabaseRestorePoint help -* Updated documentation of -ComputeGeneration parameter in several cmdlets - -## 6.3.0 - June 2018 -#### AzureRM.Profile -* Updated error messages for Enable-AzureRmContextAutoSave -* Create a context for each subscription when running 'Connect-AzureRmAccount' with no previous context - -#### Azure.Storage -* Added additional information about -Permissions parameter in help files. - -#### AzureRM.Compute -* 'Get-AzureRmVmDiskEncryptionStatus' fixes an issue observed for VMs with no data disks -* Update Compute client library version to fix following cmdlets - - Grant-AzureRmDiskAccess - - Grant-AzureRmSnapshotAccess - - Save-AzureRmVMImage -* Fixed following cmdlets to show 'operation ID' and 'operation status' correctly: - - Start-AzureRmVM - - Stop-AzureRmVM - - Restart-AzureRmVM - - Set-AzureRmVM - - Remove-AzuerRmVM - - Set-AzureRmVmss - - Start-AzureRmVmssRollingOSUpgrade - - Stop-AzureRmVmssRollingUpgrade - - Start-AzureRmVmss - - Restart-AzureRmVmss - - Stop-AzureRmVmss - - Remove-AzureRmVmss - - ConvertTo-AzureRmVMManagedDisk - - Revoke-AzureRmSnapshotAccess - - Remove-AzureRmSnapshot - - Revoke-AzureRmDiskAccess - - Remove-AzureRmDisk - - Remove-AzureRmContainerService - - Remove-AzureRmAvailabilitySet - -#### AzureRM.EventGrid -* Remove ValidateNotNullOrEmpty validation conditions for SubjectBeginsWith/SubjectEndsWith in Update-AzureRmEventGridSubscription cmdlet to allow changing these parameters to empty string if needed. - -#### AzureRM.KeyVault -* Fix issue where no Tags are being returned when Get-AzureRmKeyVault -Tag is run - -#### AzureRM.PolicyInsights -* Public release of Policy Insights cmdlets - - Use API version 2018-04-04 - - Add PolicyDefinitionReferenceId to the results of Get-AzureRmPolicyStateSummary - -#### AzureRM.RecoveryServices.Backup -* Added -Vault parameter to RecoveryServices.Backup cmdlets. When passed, this will override the Set-AzureRmRecoveryServicesContext cmdlet. - -#### AzureRM.Sql -* Updated example in the help file for Get-AzureRmSqlDatabaseExpanded - -#### AzureRM.TrafficManager -* Updated the help file for Add-AzureRmTrafficManagerEndpointConfig - -#### AzureRM.Websites -* 'Set-AzureRmWebApp' is updated to not overwrite the AppSettings when using -AssignIdentity -* 'New-AzureRmWebAppSlot' is updated to honor AppServicePlan as an optional parameter - -## 6.2.1 - June 2018 -### AzureRM.OperationalInsights -* Updated PSWorkspace model to allow Network to use type as a parameter - -## 6.2.0 - June 2018 -#### AzureRM.Profile -* Fix issue where version 10.0.3 of Newtonsoft.Json wasn't being loaded on module import - -#### AzureRM.Compute -* VMSS VM Update feature - - Added 'Update-AzureRmVmssVM' and 'New-AzureRmVMDataDisk' cmdlets - - Add VirtualMachineScaleSetVM parameter to 'Add-AzureRmVMDataDisk' cmdlet to support adding a data disk to Vmss VM. - -#### AzureRM.DataFactoryV2 -* Updated the ADF .Net SDK version to 0.8.0-preview containing following changes: - - Added Configure factory repository operation - - Updated QuickBooks LinkedService to expose consumerKey and consumerSecret properties - - Updated Several model types from SecretBase to Object - - Added Blob Events trigger - -### AzureRM.KeyVault -* Update documentation with example output - -### AzureRM.Network -* Enable Traffic Analytics parameters on Network Watcher cmdlets - -#### AzureRM.Resources -* Fix issue with 'Properties' property of 'PSResource' object(s) returned from 'Get-AzureRmResource' - -#### AzureRM.Scheduler -* Fix issue with update ServiceBusQueueJob not setting new Auth values - -### AzureRM.Sql -* Updated the following cmdlets with optional LicenseType parameter - - New-AzureRmSqlDatabase; Set-AzureRmSqlDatabase - - New-AzureRmSqlElasticPool; Set-AzureRmSqlElasticPool - - New-AzureRmSqlDatabaseCopy - - New-AzureRmSqlDatabaseSecondary - - Restore-AzureRmSqlDatabase - -#### AzureRM.Websites -* 'New-AzureRMWebApp' is updated to use common algorithms from the Strategy library. - -## 6.1.0 - May 2018 -#### AzureRM.Profile -* Fix issue where running 'Clear-AzureRmContext' would keep an empty context with the name of the previous default context, which prevented the user from creating a new context with the old name - -#### AzureRM.AnalysisServices -* Enable Gateway assocaite/disassociate operations on AS. - -#### AzureRM.ApiManagement -* Added support for ApiVersions, ApiReleases and ApiRevisions -* Added suppport for ServiceFabric Backend -* Added support for Application Insights Logger -* Added support for recognizing 'Basic' sku as a valid sku of Api Management service -* Added support for installing Certificates issued by private CA as Root or CA -* Added support for accepting Custom SSL certificates via KeyVault and Multiple proxy hostnames -* Added support for MSI identity -* Added support for accepting Policies via Url -NOTE: The following cmdlets will be deprecated in future release - - Import-AzureRmApiManagementHostnameCertificate - - New-AzureRmApiManagementHostnameConfiguration - - Set-AzureRmApiManagementHostnames - - Update-AzureRmApiManagementDeployment - -#### AzureRM.Batch -* Release new cmdlet Get-AzureBatchPoolNodeCounts -* Release new cmdlet Start-AzureBatchComputeNodeServiceLogUpload - -#### AzureRM.Consumption -* Add new parameters Expand, ResourceGroup, InstanceName, InstanceId, Tags, and Top on Cmdlet Get-AzureRmConsumptionUsageDetail - -#### AzureRM.DataLakeStore -* Fix example for Export-AzureRmDataLakeStoreChildItemProperties -* Fix null parameter exception for Recurse case in Set-AzureRmDataLakeStoreItemAclEntry -* Fix the help files for Set-AzureRmDataLakeStoreItemAclEntry, Set-AzureRmDataLakeStoreItemAcl, Remove-AzureRmDataLakeStoreItemAclEntry - -#### AzureRM.Network -* Bump up Network SDK version from 18.0.0-preview to 19.0.0-preview -* Added cmdlet to create protocol configuration - - New-AzureRmNetworkWatcherProtocolConfiguration -* Added cmdlet to add a new circuit connection to an existing express route circuit. - - Add-AzureRmExpressRouteCircuitConnectionConfig -* Added cmdlet to remove a circuit connection from an existing express route circuit. - - Remove-AzureRmExpressRouteCircuitConnectionConfig -* Added cmdlet to retrieve a circuit connection - - Get-AzureRmExpressRouteCircuitConnectionConfig - -#### AzureRM.ServiceFabric -* Fixed server authentication usage with generated certificates (Issue #5998) - -#### AzureRM.Sql -* Updated Auditing cmdlets to allow removing AuditActions or AuditActionGroups -* Fixed issue with Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy when setting a new flexible retention policy where the command would fail with 'Configure long term retention policy with azure recovery service vault and policy is no longer supported. Please submit request with the new flexible retention policy'. -* Update all Azure Sql Database/ElasticPool Creation/Update related cmdlets to use the new Database API, which support Sku property for scale and tier-related properties. -* The updated cmdlets including: - - New-AzureRmSqlDatabase; Set-AzureRmSqlDatabase - - New-AzureRmSqlElasticPool; Set-AzureRmSqlElasticPool - - New-AzureRmSqlDatabaseCopy - - New-AzureRmSqlDatabaseSecondary - - Restore-AzureRmSqlDatabase - -#### AzureRM.TrafficManager -* Update the parameters for 'Get-AzureRmTrafficManagerProfile' so that -ResourceGroupName parameter is required when using -Name parameter. diff --git a/docs-conceptual/azurermps-6.13.0/toc.yml b/docs-conceptual/azurermps-6.13.0/toc.yml deleted file mode 100644 index e192274d2e..0000000000 --- a/docs-conceptual/azurermps-6.13.0/toc.yml +++ /dev/null @@ -1,64 +0,0 @@ -- name: Azure PowerShell - href: overview.md -- name: Install - items: - - name: Install with PowerShellGet - href: install-azurerm-ps.md - - name: Install with MSI - href: other-install.md -- name: Uninstall - href: uninstall-azurerm-ps.md -- name: Get started - href: get-started-azureps.md -- name: Cloud Shell - href: /azure/cloud-shell/overview -- name: Sign in - items: - - name: Authentication methods - href: authenticate-azureps.md - - name: Create a service principal - href: create-azure-service-principal-azureps.md - - name: Persistent credentials - href: context-persistence.md -- name: Queries - href: queries-azureps.md -- name: Format output - href: formatting-output.md -- name: Manage subscriptions - href: manage-subscriptions-azureps.md -- name: Deploy - items: - - name: Deploy Resource Manager templates - href: /azure/azure-resource-manager/resource-group-template-deploy - - name: Export Resource Manager templates - href: /azure/azure-resource-manager/resource-manager-export-template-powershell - - name: Deploy private Resource Manager templates - href: /azure/azure-resource-manager/resource-manager-powershell-sas-token -- name: Concepts - items: - - name: Experimental modules - href: using-experimental-modules.md - - name: PowerShell jobs - href: using-psjobs.md -- name: Tutorials - items: - - name: Create Virtual Machines - href: azureps-vm-tutorial.yml -- name: Sample Scripts - items: - - name: Linux Virtual Machines - href: /azure/virtual-machines/linux/powershell-samples?toc=%2fpowershell%2fmodule%2ftoc.json - - name: Windows Virtual Machines - href: /azure/virtual-machines/windows/powershell-samples?toc=%2fpowershell%2fmodule%2ftoc.json - - name: Web Apps - href: /azure/app-service-web/app-service-powershell-samples?toc=%2fpowershell%2fmodule%2ftoc.json - - name: SQL Databases - href: /azure/sql-database/sql-database-powershell-samples?toc=%2fpowershell%2fmodule%2ftoc.json - - name: Cosmos DB - href: /azure/cosmos-db/powershell-samples?toc=%2fpowershell%2fmodules%2ftoc.json -- name: Release notes - href: release-notes-azureps.md -- name: Breaking changes for Azure PowerShell 6.x - href: migration-guide.6.0.0.md -- name: Frequently Asked Questions - href: faq.md diff --git a/docs-conceptual/azurermps-6.13.0/uninstall-azurerm-ps.md b/docs-conceptual/azurermps-6.13.0/uninstall-azurerm-ps.md deleted file mode 100644 index bb9c6ba0e9..0000000000 --- a/docs-conceptual/azurermps-6.13.0/uninstall-azurerm-ps.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -title: Uninstall Azure PowerShell -description: How to perform a complete uninstall of Azure PowerShell - -ms.devlang: powershell -ms.topic: conceptual -ms.custom: devx-track-azurepowershell ---- -# Uninstall the Azure PowerShell module - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -This article tells you how to uninstall an older version of Azure PowerShell, or completely remove -it from your system. If you've decided to completely uninstall the Azure PowerShell, give us some -feedback through the [Send-Feedback](/powershell/module/azurerm.profile/send-feedback) cmdlet. If -you encounter a bug, we'd appreciate it if you -[file a GitHub issue](https://github.com/azure/azure-powershell/issues). - - -## Uninstall Azure PowerShell MSI - -If you installed Azure PowerShell using the MSI package, you must uninstall through the Windows -system rather than PowerShell. - -| Platform | Instructions | -| ------------------------ | ------------------------------------------------------ | -| Windows 10 | Start > Settings > Apps | -| Windows 7 </br>Windows 8 | Start > Control Panel > Programs > Uninstall a program | - -Once on this screen you should see __Azure PowerShell__ in the program listing. This is the app to -uninstall. - -## Uninstall from PowerShell - -If you installed Azure PowerShell using PowerShellGet, you can use the -[Uninstall-Module](/powershell/module/powershellget/uninstall-module) cmdlet. However, -`Uninstall-Module` only uninstalls one module. To remove Azure PowerShell completely, you must -uninstall each module individually. Uninstallation can be complicated if you have more than one -version of Azure PowerShell installed. - -To check which versions of Azure PowerShell you currently have installed, run the following command: - -```powershell -Get-InstalledModule -Name AzureRM -AllVersions -``` - -```Output -Version Name Repository Description -------- ---- ---------- ----------- -6.11.0 AzureRM PSGallery Azure Resource Manager Module -6.13.1 AzureRM PSGallery Azure Resource Manager Module -``` - -The following script queries the PowerShell Gallery to get a list of dependent submodules. Then, the -script uninstalls the correct version of each submodule. You will need to have administrator access -to run this script in a scope other than `Process` or `CurrentUser`. - -```powershell -function Uninstall-AllModules { - param( - [Parameter(Mandatory=$true)] - [string]$TargetModule, - - [Parameter(Mandatory=$true)] - [string]$Version, - - [switch]$Force, - - [switch]$WhatIf - ) - - $AllModules = @() - - 'Creating list of dependencies...' - $target = Find-Module $TargetModule -RequiredVersion $version - $target.Dependencies | ForEach-Object { - if ($_.PSObject.Properties.Name -contains 'requiredVersion') { - $AllModules += New-Object -TypeName psobject -Property @{name=$_.name; version=$_.requiredVersion} - } - else { # Assume minimum version - # Minimum version actually reports the installed dependency - # which is used, not the actual "minimum dependency." Check to - # see if the requested version was installed as a dependency earlier. - $candidate = Get-InstalledModule $_.name -RequiredVersion $version -ErrorAction Ignore - if ($candidate) { - $AllModules += New-Object -TypeName psobject -Property @{name=$_.name; version=$version} - } - else { - $availableModules = Get-InstalledModule $_.name -AllVersions - Write-Warning ("Could not find uninstall candidate for {0}:{1} - module may require manual uninstall. Available versions are: {2}" -f $_.name,$version,($availableModules.Version -join ', ')) - } - } - } - $AllModules += New-Object -TypeName psobject -Property @{name=$TargetModule; version=$Version} - - foreach ($module in $AllModules) { - Write-Host ('Uninstalling {0} version {1}...' -f $module.name,$module.version) - try { - Uninstall-Module -Name $module.name -RequiredVersion $module.version -Force:$Force -ErrorAction Stop -WhatIf:$WhatIf - } catch { - Write-Host ("`t" + $_.Exception.Message) - } - } -} -``` - -To use this function, copy and paste the code into your PowerShell session. The following example -shows how to run the function to remove an older version of Azure PowerShell. - -```powershell -Uninstall-AllModules -TargetModule AzureRM -Version 4.4.1 -Force -``` - -As the script runs, it will display the name and version of each submodule that is being -uninstalled. To run the script to only see what would be deleted, without removing it, use the -`-WhatIf` option. - -```Output -Creating list of dependencies... -Uninstalling AzureRM.Profile version 3.4.1 -Uninstalling Azure.Storage version 3.4.1 -Uninstalling AzureRM.AnalysisServices version 0.4.7 -Uninstalling Azure.AnalysisServices version 0.4.7 -... -``` - -> [!NOTE] -> If this script can't match an exact dependency with the same version to uninstall, it won't -> uninstall _any_ version of that dependency. This is because there may be other versions of the -> target module on your system which rely on these dependencies. In this case, the available -> versions of the dependency are listed. You can then remove any old versions manually with -> `Uninstall-Module`. - -Run this command for every version of Azure PowerShell that you want to uninstall. For convenience, -the following script will uninstall all versions of AzureRM __except__ for the latest. - -```powershell -$versions = (Get-InstalledModule -Name AzureRM -AllVersions | Select-Object -Property Version) -$versions[0..($versions.Length-2)] | foreach { Uninstall-AllModules -TargetModule AzureRM -Version ($_.Version) -Force } -``` diff --git a/docs-conceptual/azurermps-6.13.0/using-experimental-modules.md b/docs-conceptual/azurermps-6.13.0/using-experimental-modules.md deleted file mode 100644 index ce759c6467..0000000000 --- a/docs-conceptual/azurermps-6.13.0/using-experimental-modules.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -title: Using experimental Azure PowerShell modules -description: Understand the philosophy and usage of experimental Azure PowerShell modules. -ms.devlang: powershell -ms.topic: conceptual - -ms.custom: devx-track-azurepowershell ---- -# Use experimental Azure PowerShell modules - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -With the emphasis on developer tools (especially CLIs) in Azure, the Azure PowerShell team is -experimenting with many improvements to the Azure PowerShell experience. - -## Experimentation methodology - -To facilitate experimentation, we're creating new Azure PowerShell modules that implement existing -Azure SDK functionality in new, easier to use ways. In most cases, the cmdlets exactly mirror -existing cmdlets. However, the experimental cmdlets provide a shorthand notation and smarter default -values that make it easier to create and manage Azure resources. - -These modules can be installed side by side with existing Azure PowerShell modules. The cmdlet names -have been shortened to provide shorter names and avoid name conflicts with existing, -non-experimental cmdlets. - -The experimental modules use the following naming convention: `AzureRM.*.Experiments`. This naming -convention is similar to the naming of Preview modules: `AzureRM.*.Preview`. Preview modules differ -from experimental modules. Preview modules implement new functionality of Azure services that is -only available as a Preview offering. Preview modules replace existing Azure PowerShell modules and -use the same cmdlet and parameter names. - -## How to install an experimental module - -Experimental modules are published to the PowerShell Gallery just like the existing Azure PowerShell -modules. To see a list of experimental modules, run the following command: - -```powershell -Find-Module -Name AzureRM.*.Experiments -``` - -```Output -Version Name Repository Description -------- ---- ---------- ----------- -1.0.25 AzureRM.Compute.Experiments PSGallery Azure Compute experiments for VM creation -1.0.0 AzureRM.Websites.Experiments PSGallery Create and deploy web applications using Azure App Services. -``` - -To install the experimental module, use the following commands from an elevated PowerShell session: - -```powershell -Install-Module -Name AzureRM.Compute.Experiments -Install-Module -Name AzureRM.Websites.Experiments -``` - -### Documentation and support - -Documentation is included in the install package and is accessed using the `Get-Help` cmdlet. No -official documentation is published for experimental modules. - -We encourage you to test these modules. Your feedback allows us to improve usability and respond to -your needs. However, being experimental, support for these modules is limited. Questions or problem -reports can be submitted by creating an [issue](https://github.com/Azure/azure-powershell/issues) in -the GitHub repository. - -## Experiments and areas of improvement - -These improvements were selected based on key differentiators in competing products. For example, -Azure CLI 2.0 has made a point of basing commands on _scenarios_ rather than _API surface area_. -Azure CLI 2.0 use a number of smart defaults that make "getting started" scenarios easier for end -users. - -### Core improvements - -The core improvements are regarded as "common sense", and little experimentation is needed to move -forward in implementing these updates. - -- Scenario-based Cmdlets - <em>*All</em>- cmdlets should be designed around scenarios, not the Azure - REST service. - -- Shorter Names - Includes the names of cmdlets (for example, `New-AzureRmVM` => `New-AzVm`) and the - names of parameters (for example, `-ResourceGroupName` => `-Rg`). Use aliases for compatibility - with "old" cmdlets. Provide _backwards compatible_ parameter sets. - -- Smart Defaults - Create smart defaults to fill in "required" information. For example: - - Resource Group - - Location - - Dependent resources - -### Experimental improvements - -The experimental improvements present a significant change that the team wants to validate via -experimentation. - -- Simple types - Create scenarios should move away from complex types and config objects. Simplify - the configuration down to one or two parameters. - -- "Smart Create" - All create scenarios implementing "Smart Create" would have _no_ required - parameters: all necessary information would be chosen by Azure PowerShell in an opinionated - fashion. - -- Gray Parameters - In many cases, some parameters could be "gray" or semi-optional. If the - parameter isn't specified, the user is asked if they want the parameter generated for them. It - also makes sense for gray parameters to infer a value based on context with the user's consent. - For example, it may make sense to have the gray parameter suggest the most recently used value. - -- `-Auto` Switch - The `-Auto` switch would provide an "opt-in" way for users to _default all the - things_ while maintaining the integrity of required parameters in the mainline path. - -### Feature-specific switches - -For example, the "Create web app" scenario might have a `-Git` or `-AddRemote` switch that would -automatically add an "azure" remote to an existing git repository. - -- Settable Defaults - Users should be able to set defaults for common parameters like - `-ResourceGroupName` and `-Location`. - -- Size Defaults - Resource "sizes" can be confusing to users since many Resource Providers use - different names (for example, "Standard\_DS1\_v2" or "S1"). However, most users care more about - cost. So it makes sense to define "universal" sizes based on a pricing schedule. Users - can choose a specific size or let Azure PowerShell choose the _best option_ based on the resource - the budget. - -- Output Format - Azure PowerShell currently returns `PSObject`s and there's little console - output. Azure PowerShell may need to display some information to the user about the "smart - defaults" used. diff --git a/docs-conceptual/azurermps-6.13.0/using-psjobs.md b/docs-conceptual/azurermps-6.13.0/using-psjobs.md deleted file mode 100644 index b2365f85d6..0000000000 --- a/docs-conceptual/azurermps-6.13.0/using-psjobs.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -title: Running cmdlets in parallel using PowerShell jobs -description: How to run cmdlets in parallel using the -AsJob parameter. -ms.devlang: powershell -ms.topic: conceptual - -ms.custom: ---- - -# Running cmdlets in parallel using PowerShell jobs - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -PowerShell supports asynchronous action with -[PowerShell Jobs](/powershell/module/microsoft.powershell.core/about/about_jobs). Azure PowerShell -is heavily dependent on making, and waiting for, network calls to Azure. You may often find yourself -needing to make non-blocking calls. To address this need, Azure PowerShell provides first-class -[PSJob](/powershell/module/microsoft.powershell.core/about/about_jobs) support. - -## Context Persistence and PSJobs - -Since PSJobs are run as separate processes, your Azure connection must be shared with them. After -signing in to your Azure account with `Connect-AzureRmAccount`, pass the context to a job. - -```azurepowershell -$creds = Get-Credential -$job = Start-Job { param($context,$vmadmin) New-AzureRmVM -Name MyVm -AzureRmContext $context -Credential $vmadmin} -Arguments (Get-AzureRmContext),$creds -``` - -However, if you have chosen to have your context automatically saved with -`Enable-AzureRmContextAutosave`, the context is automatically shared with any jobs you create. - -```azurepowershell -Enable-AzureRmContextAutosave -$creds = Get-Credential -$job = Start-Job { param($vmadmin) New-AzureRmVM -Name MyVm -Credential $vmadmin} -Arguments $creds -``` - -## Automatic Jobs with `-AsJob` - -As a convenience, Azure PowerShell also provides an `-AsJob` switch on some long-running cmdlets. -The `-AsJob` switch makes creating PSJobs even easier. - -```azurepowershell -$creds = Get-Credential -$job = New-AzureRmVM -Name MyVm -Credential $creds -AsJob -``` - -You can inspect the job and progress at any time with `Get-Job` and `Get-AzureRmVM`. - -```azurepowershell -Get-Job $job -Get-AzureRmVM MyVm -``` - -```Output -Id Name PSJobTypeName State HasMoreData Location Command --- ---- ------------- ----- ----------- -------- ------- -1 Long Running Operation for 'New-AzureRmVM' AzureLongRunningJob`1 Running True localhost New-AzureRmVM - -ResourceGroupName Name Location VmSize OsType NIC ProvisioningState Zone ------------------ ---- -------- ------ ------ --- ----------------- ---- -MyVm MyVm eastus Standard_DS1_v2 Windows MyVm Creating -``` - -When the job completes, get the result of the job with `Receive-Job`. - -> [!NOTE] -> `Receive-Job` returns the result from the cmdlet as if the `-AsJob` flag were not present. For -> example, the `Receive-Job` result of `Do-Action -AsJob` is of the same type as the result of -> `Do-Action`. - -```azurepowershell -$vm = Receive-Job $job -$vm -``` - -```Output -ResourceGroupName : MyVm -Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyVm/providers/Microsoft.Compute/virtualMachines/MyVm -VmId : dff1f79e-a8f7-4664-ab72-0ec28b9fbb5b -Name : MyVm -Type : Microsoft.Compute/virtualMachines -Location : eastus -Tags : {} -HardwareProfile : {VmSize} -NetworkProfile : {NetworkInterfaces} -OSProfile : {ComputerName, AdminUsername, WindowsConfiguration, Secrets} -ProvisioningState : Succeeded -StorageProfile : {ImageReference, OsDisk, DataDisks} -FullyQualifiedDomainName : myvmmyvm.eastus.cloudapp.azure.com -``` - -## Example Scenarios - -Create several VMs at once: - -```azurepowershell -$creds = Get-Credential -# Create 10 jobs. -for($k = 0; $k -lt 10; $k++) { - New-AzureRmVm -Name MyVm$k -Credential $creds -AsJob -} - -# Get all jobs and wait on them. -Get-Job | Wait-Job -"All jobs completed" -Get-AzureRmVM -``` - -In this example, the `Wait-Job` cmdlet causes the script to pause while jobs run. The script -continues executing once all of the jobs have completed. Several jobs run in parallel then the -script waits for completion before continuing. - -```Output -Id Name PSJobTypeName State HasMoreData Location Command --- ---- ------------- ----- ----------- -------- ------- -2 Long Running... AzureLongRun... Running True localhost New-AzureRmVM -3 Long Running... AzureLongRun... Running True localhost New-AzureRmVM -4 Long Running... AzureLongRun... Running True localhost New-AzureRmVM -5 Long Running... AzureLongRun... Running True localhost New-AzureRmVM -6 Long Running... AzureLongRun... Running True localhost New-AzureRmVM -7 Long Running... AzureLongRun... Running True localhost New-AzureRmVM -8 Long Running... AzureLongRun... Running True localhost New-AzureRmVM -9 Long Running... AzureLongRun... Running True localhost New-AzureRmVM -10 Long Running... AzureLongRun... Running True localhost New-AzureRmVM -11 Long Running... AzureLongRun... Running True localhost New-AzureRmVM -2 Long Running... AzureLongRun... Completed True localhost New-AzureRmVM -3 Long Running... AzureLongRun... Completed True localhost New-AzureRmVM -4 Long Running... AzureLongRun... Completed True localhost New-AzureRmVM -5 Long Running... AzureLongRun... Completed True localhost New-AzureRmVM -6 Long Running... AzureLongRun... Completed True localhost New-AzureRmVM -7 Long Running... AzureLongRun... Completed True localhost New-AzureRmVM -8 Long Running... AzureLongRun... Completed True localhost New-AzureRmVM -9 Long Running... AzureLongRun... Completed True localhost New-AzureRmVM -10 Long Running... AzureLongRun... Completed True localhost New-AzureRmVM -11 Long Running... AzureLongRun... Completed True localhost New-AzureRmVM -All Jobs completed. - -ResourceGroupName Name Location VmSize OsType NIC ProvisioningState Zone ------------------ ---- -------- ------ ------ --- ----------------- ---- -MYVM MyVm eastus Standard_DS1_v2 Windows MyVm Succeeded -MYVM0 MyVm0 eastus Standard_DS1_v2 Windows MyVm0 Succeeded -MYVM1 MyVm1 eastus Standard_DS1_v2 Windows MyVm1 Succeeded -MYVM2 MyVm2 eastus Standard_DS1_v2 Windows MyVm2 Succeeded -MYVM3 MyVm3 eastus Standard_DS1_v2 Windows MyVm3 Succeeded -MYVM4 MyVm4 eastus Standard_DS1_v2 Windows MyVm4 Succeeded -MYVM5 MyVm5 eastus Standard_DS1_v2 Windows MyVm5 Succeeded -MYVM6 MyVm6 eastus Standard_DS1_v2 Windows MyVm6 Succeeded -MYVM7 MyVm7 eastus Standard_DS1_v2 Windows MyVm7 Succeeded -MYVM8 MyVm8 eastus Standard_DS1_v2 Windows MyVm8 Succeeded -MYVM9 MyVm9 eastus Standard_DS1_v2 Windows MyVm9 Succeeded -``` diff --git a/mapping/monikerMapping.json b/mapping/monikerMapping.json index 6c7f5ecc7d..c624a3d145 100644 --- a/mapping/monikerMapping.json +++ b/mapping/monikerMapping.json @@ -20,13 +20,6 @@ "referenceTocUrl": "/powershell/module/azure-powershell/toc.json", "serviceMap": "mapping/az-groupMapping-0.10.0.json" }, - "azurermps-6.13.0": { - "conceptualToc": "docs-conceptual/azurermps-6.13.0/toc.yml", - "conceptualTocUrl": "/powershell/azure/azurerm/toc.json", - "packageRoot": "azurermps-6.13.0", - "referenceTocUrl": "/powershell/module/azure-powershell/toc.json", - "serviceMap": "mapping/rm-groupMapping-6.13.0.json" - }, "azuresmps-4.0.0": { "conceptualToc": "docs-conceptual/azuresmps-4.0.0/toc.yml", "conceptualTocUrl": "/powershell/azure/servicemanagement/toc.json", diff --git a/mapping/rm-groupMapping-6.13.0.json b/mapping/rm-groupMapping-6.13.0.json deleted file mode 100644 index c9f4f67938..0000000000 --- a/mapping/rm-groupMapping-6.13.0.json +++ /dev/null @@ -1,2268 +0,0 @@ -{ - "Get-AzureRmCognitiveServicesAccountUsage": "Cognitive Services", - "Get-AzureRmCognitiveServicesAccount": "Cognitive Services", - "Set-AzureRmCognitiveServicesAccount": "Cognitive Services", - "New-AzureRmCognitiveServicesAccount": "Cognitive Services", - "Get-AzureRmCognitiveServicesAccountSkus": "Cognitive Services", - "Get-AzureRmCognitiveServicesAccountKey": "Cognitive Services", - "New-AzureRmCognitiveServicesAccountKey": "Cognitive Services", - "Remove-AzureRmCognitiveServicesAccount": "Cognitive Services", - "Get-AzureRmCognitiveServicesAccountType": "Cognitive Services", - "New-AzureRmSubscription": "Subscription", - "Test-AzureRmDataLakeStoreItem": "Data Lake Store", - "Remove-AzureRmDataLakeStoreFirewallRule": "Data Lake Store", - "Set-AzureRmDataLakeStoreFirewallRule": "Data Lake Store", - "Remove-AzureRmDataLakeStoreAccount": "Data Lake Store", - "Get-AzureRmDataLakeStoreItemPermission": "Data Lake Store", - "Remove-AzureRmDataLakeStoreTrustedIdProvider": "Data Lake Store", - "Export-AzureRmDataLakeStoreItem": "Data Lake Store", - "Get-AzureRmDataLakeStoreChildItem": "Data Lake Store", - "Get-AzureRmDataLakeStoreFirewallRule": "Data Lake Store", - "Get-AzureRmDataLakeStoreItemAclEntry": "Data Lake Store", - "Add-AzureRmDataLakeStoreItemContent": "Data Lake Store", - "Get-AzureRmDataLakeStoreAccount": "Data Lake Store", - "Get-AzureRmDataLakeStoreTrustedIdProvider": "Data Lake Store", - "Test-AzureRmDataLakeStoreAccount": "Data Lake Store", - "Remove-AzureRmDataLakeStoreItemAcl": "Data Lake Store", - "Set-AzureRmDataLakeStoreVirtualNetworkRule": "Data Lake Store", - "Set-AzureRmDataLakeStoreItemAclEntry": "Data Lake Store", - "Set-AzureRmDataLakeStoreAccount": "Data Lake Store", - "Add-AzureRmDataLakeStoreTrustedIdProvider": "Data Lake Store", - "Join-AzureRmDataLakeStoreItem": "Data Lake Store", - "Move-AzureRmDataLakeStoreItem": "Data Lake Store", - "Get-AzureRmDataLakeStoreItemContent": "Data Lake Store", - "Add-AzureRmDataLakeStoreFirewallRule": "Data Lake Store", - "Get-AzureRmDataLakeStoreItemOwner": "Data Lake Store", - "Remove-AzureRmDataLakeStoreVirtualNetworkRule": "Data Lake Store", - "Set-AzureRmDataLakeStoreItemOwner": "Data Lake Store", - "Set-AzureRmDataLakeStoreItemPermission": "Data Lake Store", - "Enable-AzureRmDataLakeStoreKeyVault": "Data Lake Store", - "Set-AzureRmDataLakeStoreTrustedIdProvider": "Data Lake Store", - "Get-AzureRmDataLakeStoreChildItemSummary": "Data Lake Store", - "Remove-AzureRmDataLakeStoreItemAclEntry": "Data Lake Store", - "Import-AzureRmDataLakeStoreItem": "Data Lake Store", - "Add-AzureRmDataLakeStoreVirtualNetworkRule": "Data Lake Store", - "Export-AzureRmDataLakeStoreChildItemProperties": "Data Lake Store", - "Remove-AzureRmDataLakeStoreItem": "Data Lake Store", - "Get-AzureRmDataLakeStoreVirtualNetworkRule": "Data Lake Store", - "Get-AzureRmDataLakeStoreItem": "Data Lake Store", - "New-AzureRmDataLakeStoreAccount": "Data Lake Store", - "Set-AzureRmDataLakeStoreItemAcl": "Data Lake Store", - "New-AzureRmDataLakeStoreItem": "Data Lake Store", - "Set-AzureRmDataLakeStoreItemExpiry": "Data Lake Store", - "Set-AzureRmBackupVault": "Backup", - "Register-AzureRmBackupContainer": "Backup", - "Get-AzureRmBackupJob": "Backup", - "Unregister-AzureRmBackupContainer": "Backup", - "Enable-AzureRmBackupProtection": "Backup", - "Set-AzureRmBackupProtectionPolicy": "Backup", - "Remove-AzureRmBackupVault": "Backup", - "Get-AzureRmBackupContainer": "Backup", - "Get-AzureRmBackupJobDetails": "Backup", - "New-AzureRmBackupRetentionPolicyObject": "Backup", - "New-AzureRmBackupProtectionPolicy": "Backup", - "Get-AzureRmBackupVaultCredentials": "Backup", - "Stop-AzureRmBackupJob": "Backup", - "Enable-AzureRmBackupContainerReregistration": "Backup", - "Get-AzureRmBackupVault": "Backup", - "Wait-AzureRmBackupJob": "Backup", - "Remove-AzureRmBackupProtectionPolicy": "Backup", - "Backup-AzureRmBackupItem": "Backup", - "New-AzureRmBackupVault": "Backup", - "Get-AzureRmBackupItem": "Backup", - "Disable-AzureRmBackupProtection": "Backup", - "Get-AzureRmBackupRecoveryPoint": "Backup", - "Get-AzureRmBackupProtectionPolicy": "Backup", - "Restore-AzureRmBackupItem": "Backup", - "Search-AzureRmGraph": "Search", - "Undo-AzureKeyVaultManagedStorageSasDefinitionRemoval": "Key Vault", - "Add-AzureRmKeyVaultNetworkRule": "Key Vault", - "Set-AzureKeyVaultCertificateIssuer": "Key Vault", - "Backup-AzureKeyVaultManagedStorageAccount": "Key Vault", - "Set-AzureKeyVaultManagedStorageSasDefinition": "Key Vault", - "Add-AzureKeyVaultManagedStorageAccount": "Key Vault", - "Remove-AzureRmKeyVault": "Key Vault", - "Undo-AzureRmKeyVaultRemoval": "Key Vault", - "Add-AzureKeyVaultCertificate": "Key Vault", - "Get-AzureKeyVaultManagedStorageAccount": "Key Vault", - "Update-AzureRmKeyVaultNetworkRuleSet": "Key Vault", - "Import-AzureKeyVaultCertificate": "Key Vault", - "Remove-AzureRmKeyVaultNetworkRule": "Key Vault", - "Undo-AzureKeyVaultSecretRemoval": "Key Vault", - "Remove-AzureRmKeyVaultAccessPolicy": "Key Vault", - "Add-AzureKeyVaultCertificateContact": "Key Vault", - "Update-AzureKeyVaultManagedStorageAccount": "Key Vault", - "New-AzureKeyVaultCertificatePolicy": "Key Vault", - "Set-AzureRmKeyVaultAccessPolicy": "Key Vault", - "Remove-AzureKeyVaultCertificateIssuer": "Key Vault", - "Undo-AzureKeyVaultCertificateRemoval": "Key Vault", - "New-AzureKeyVaultCertificateOrganizationDetails": "Key Vault", - "Get-AzureKeyVaultCertificatePolicy": "Key Vault", - "Get-AzureKeyVaultSecret": "Key Vault", - "Remove-AzureKeyVaultSecret": "Key Vault", - "Undo-AzureKeyVaultManagedStorageAccountRemoval": "Key Vault", - "Backup-AzureKeyVaultCertificate": "Key Vault", - "Get-AzureKeyVaultCertificate": "Key Vault", - "Update-AzureKeyVaultCertificate": "Key Vault", - "Set-AzureKeyVaultSecret": "Key Vault", - "Get-AzureKeyVaultKey": "Key Vault", - "Add-AzureKeyVaultKey": "Key Vault", - "Get-AzureKeyVaultCertificateIssuer": "Key Vault", - "Backup-AzureKeyVaultKey": "Key Vault", - "Undo-AzureKeyVaultKeyRemoval": "Key Vault", - "Update-AzureKeyVaultSecret": "Key Vault", - "Remove-AzureKeyVaultCertificateOperation": "Key Vault", - "Remove-AzureKeyVaultCertificateContact": "Key Vault", - "New-AzureKeyVaultCertificateAdministratorDetails": "Key Vault", - "Update-AzureKeyVaultKey": "Key Vault", - "Restore-AzureKeyVaultManagedStorageAccount": "Key Vault", - "Set-AzureKeyVaultCertificatePolicy": "Key Vault", - "Remove-AzureKeyVaultManagedStorageAccount": "Key Vault", - "Remove-AzureKeyVaultCertificate": "Key Vault", - "Update-AzureKeyVaultManagedStorageAccountKey": "Key Vault", - "Get-AzureKeyVaultCertificateContact": "Key Vault", - "Backup-AzureKeyVaultSecret": "Key Vault", - "Get-AzureKeyVaultManagedStorageSasDefinition": "Key Vault", - "Restore-AzureKeyVaultCertificate": "Key Vault", - "Stop-AzureKeyVaultCertificateOperation": "Key Vault", - "Remove-AzureKeyVaultManagedStorageSasDefinition": "Key Vault", - "Restore-AzureKeyVaultSecret": "Key Vault", - "Remove-AzureKeyVaultKey": "Key Vault", - "Get-AzureRmKeyVault": "Key Vault", - "Get-AzureKeyVaultCertificateOperation": "Key Vault", - "Restore-AzureKeyVaultKey": "Key Vault", - "New-AzureRmKeyVault": "Key Vault", - "New-AzureRmDnsZone": "DNS", - "New-AzureRmDnsRecordConfig": "DNS", - "Set-AzureRmDnsZone": "DNS", - "Get-AzureRmDnsZone": "DNS", - "New-AzureRmDnsRecordSet": "DNS", - "Remove-AzureRmDnsRecordSet": "DNS", - "Get-AzureRmDnsRecordSet": "DNS", - "Add-AzureRmDnsRecordConfig": "DNS", - "Set-AzureRmDnsRecordSet": "DNS", - "Remove-AzureRmDnsZone": "DNS", - "Remove-AzureRmDnsRecordConfig": "DNS", - "Get-UsageAggregates": "Usage Aggregates", - "New-AzureRmRecoveryServicesVault": "Recovery Services", - "Get-AzureRmRecoveryServicesBackupProperty": "Recovery Services", - "Set-AzureRmRecoveryServicesVaultContext": "Recovery Services", - "Set-AzureRmRecoveryServicesBackupProperties": "Recovery Services", - "Get-AzureRmRecoveryServicesVaultSettingsFile": "Recovery Services", - "Get-AzureRmRecoveryServicesVault": "Recovery Services", - "Remove-AzureRmRecoveryServicesVault": "Recovery Services", - "Get-AzureRmSchedulerJobHistory": "Scheduler", - "Set-AzureRmSchedulerServiceBusTopicJob": "Scheduler", - "Set-AzureRmSchedulerServiceBusQueueJob": "Scheduler", - "Enable-AzureRmSchedulerJobCollection": "Scheduler", - "New-AzureRmSchedulerStorageQueueJob": "Scheduler", - "Get-AzureRmSchedulerJob": "Scheduler", - "New-AzureRmSchedulerServiceBusQueueJob": "Scheduler", - "Set-AzureRmSchedulerJobCollection": "Scheduler", - "New-AzureRmSchedulerHttpJob": "Scheduler", - "New-AzureRmSchedulerServiceBusTopicJob": "Scheduler", - "Set-AzureRmSchedulerStorageQueueJob": "Scheduler", - "Remove-AzureRmSchedulerJob": "Scheduler", - "Get-AzureRmSchedulerJobCollection": "Scheduler", - "Remove-AzureRmSchedulerJobCollection": "Scheduler", - "Disable-AzureRmSchedulerJobCollection": "Scheduler", - "Set-AzureRmSchedulerHttpJob": "Scheduler", - "New-AzureRmSchedulerJobCollection": "Scheduler", - "Start-AzureRmAksDashboard": "Aks", - "Set-AzureRmAks": "Aks", - "Remove-AzureRmAks": "Aks", - "Import-AzureRmAksCredential": "Aks", - "Get-AzureRmAks": "Aks", - "New-AzureRmAks": "Aks", - "Stop-AzureRmAksDashboard": "Aks", - "Get-AzureRmRelayOperation": "Relay", - "Get-AzureRmRelayHybridConnection": "Relay", - "Remove-AzureRmWcfRelay": "Relay", - "New-AzureRmRelayKey": "Relay", - "Remove-AzureRmRelayNamespace": "Relay", - "Set-AzureRmRelayAuthorizationRule": "Relay", - "New-AzureRmRelayHybridConnection": "Relay", - "Get-AzureRmRelayNamespace": "Relay", - "Set-AzureRmWcfRelay": "Relay", - "Remove-AzureRmRelayAuthorizationRule": "Relay", - "New-AzureRmRelayNamespace": "Relay", - "Set-AzureRmRelayNamespace": "Relay", - "New-AzureRmWcfRelay": "Relay", - "Get-AzureRmRelayKey": "Relay", - "Remove-AzureRmRelayHybridConnection": "Relay", - "Test-AzureRmRelayName": "Relay", - "Get-AzureRmRelayAuthorizationRule": "Relay", - "New-AzureRmRelayAuthorizationRule": "Relay", - "Set-AzureRmRelayHybridConnection": "Relay", - "Get-AzureRmWcfRelay": "Relay", - "Get-AzureRmDataMigrationProject": "Data Migration", - "New-AzureRmDataMigrationService": "Data Migration", - "New-AzureRmDataMigrationFileShare": "Data Migration", - "New-AzureRmDataMigrationTask": "Data Migration", - "Stop-AzureRmDataMigrationTask": "Data Migration", - "Remove-AzureRmDataMigrationProject": "Data Migration", - "New-AzureRmDataMigrationDatabaseInfo": "Data Migration", - "New-AzureRmDataMigrationSyncSelectedDBObject": "Data Migration", - "Remove-AzureRmDataMigrationTask": "Data Migration", - "Invoke-AzureRmDataMigrationCommand": "Data Migration", - "Get-AzureRmDataMigrationTask": "Data Migration", - "New-AzureRmDataMigrationProject": "Data Migration", - "Start-AzureRmDataMigrationService": "Data Migration", - "Get-AzureRmDataMigrationService": "Data Migration", - "New-AzureRmDataMigrationConnectionInfo": "Data Migration", - "New-AzureRmDataMigrationSelectedDBObject": "Data Migration", - "Remove-AzureRmDataMigrationService": "Data Migration", - "Stop-AzureRmDataMigrationService": "Data Migration", - "Invoke-AzureRmStorageSyncCompatibilityCheck": "Storage", - "New-AzureRmApiManagementOpenIdConnectProvider": "API Management", - "New-AzureRmApiManagementApiVersionSet": "API Management", - "Remove-AzureRmApiManagementProductFromGroup": "API Management", - "New-AzureRmApiManagementBackendCredential": "API Management", - "Set-AzureRmApiManagementHostnames": "API Management", - "New-AzureRmApiManagementSystemCertificate": "API Management", - "Import-AzureRmApiManagementApi": "API Management", - "Update-AzureRmApiManagementApiRelease": "API Management", - "New-AzureRmApiManagementUser": "API Management", - "Get-AzureRmApiManagementBackend": "API Management", - "Set-AzureRmApiManagementPolicy": "API Management", - "Remove-AzureRmApiManagementApiRelease": "API Management", - "Get-AzureRmApiManagementProduct": "API Management", - "New-AzureRmApiManagementRegion": "API Management", - "Set-AzureRmApiManagementSubscription": "API Management", - "Set-AzureRmApiManagementCertificate": "API Management", - "Remove-AzureRmApiManagementSubscription": "API Management", - "Update-AzureRmApiManagementDeployment": "API Management", - "New-AzureRmApiManagementVirtualNetwork": "API Management", - "New-AzureRmApiManagementIdentityProvider": "API Management", - "New-AzureRmApiManagementApiRelease": "API Management", - "Get-AzureRmApiManagementLogger": "API Management", - "Restore-AzureRmApiManagement": "API Management", - "Get-AzureRmApiManagementProperty": "API Management", - "New-AzureRmApiManagementApi": "API Management", - "Get-AzureRmApiManagementPolicy": "API Management", - "Remove-AzureRmApiManagementBackend": "API Management", - "Get-AzureRmApiManagementAuthorizationServer": "API Management", - "Remove-AzureRmApiManagementUserFromGroup": "API Management", - "Add-AzureRmApiManagementRegion": "API Management", - "Save-AzureRmApiManagementTenantGitConfiguration": "API Management", - "Get-AzureRmApiManagementCertificate": "API Management", - "Remove-AzureRmApiManagementApiVersionSet": "API Management", - "Import-AzureRmApiManagementHostnameCertificate": "API Management", - "New-AzureRmApiManagementCustomHostnameConfiguration": "API Management", - "New-AzureRmApiManagementBackendProxy": "API Management", - "Set-AzureRmApiManagementLogger": "API Management", - "New-AzureRmApiManagementOperation": "API Management", - "Remove-AzureRmApiManagementApi": "API Management", - "Get-AzureRmApiManagementSubscription": "API Management", - "Remove-AzureRmApiManagementProperty": "API Management", - "Get-AzureRmApiManagementApi": "API Management", - "Get-AzureRmApiManagement": "API Management", - "Backup-AzureRmApiManagement": "API Management", - "New-AzureRmApiManagementContext": "API Management", - "Remove-AzureRmApiManagementApiRevision": "API Management", - "Remove-AzureRmApiManagementRegion": "API Management", - "Set-AzureRmApiManagementGroup": "API Management", - "Remove-AzureRmApiManagementUser": "API Management", - "Add-AzureRmApiManagementApiToProduct": "API Management", - "New-AzureRmApiManagementProperty": "API Management", - "Get-AzureRmApiManagementGroup": "API Management", - "Set-AzureRmApiManagementUser": "API Management", - "Get-AzureRmApiManagementUserSsoUrl": "API Management", - "Get-AzureRmApiManagementUser": "API Management", - "Add-AzureRmApiManagementUserToGroup": "API Management", - "Remove-AzureRmApiManagementLogger": "API Management", - "Get-AzureRmApiManagementIdentityProvider": "API Management", - "New-AzureRmApiManagementAuthorizationServer": "API Management", - "Remove-AzureRmApiManagementPolicy": "API Management", - "Set-AzureRmApiManagementOpenIdConnectProvider": "API Management", - "Set-AzureRmApiManagementProduct": "API Management", - "Publish-AzureRmApiManagementTenantGitConfiguration": "API Management", - "Get-AzureRmApiManagementApiRelease": "API Management", - "Get-AzureRmApiManagementApiVersionSet": "API Management", - "Remove-AzureRmApiManagement": "API Management", - "Export-AzureRmApiManagementApi": "API Management", - "Remove-AzureRmApiManagementGroup": "API Management", - "Set-AzureRmApiManagementApi": "API Management", - "Get-AzureRmApiManagementTenantSyncState": "API Management", - "New-AzureRmApiManagement": "API Management", - "Remove-AzureRmApiManagementOperation": "API Management", - "Remove-AzureRmApiManagementOpenIdConnectProvider": "API Management", - "Get-AzureRmApiManagementApiRevision": "API Management", - "Get-AzureRmApiManagementOperation": "API Management", - "Remove-AzureRmApiManagementApiFromProduct": "API Management", - "Remove-AzureRmApiManagementAuthorizationServer": "API Management", - "New-AzureRmApiManagementCertificate": "API Management", - "Remove-AzureRmApiManagementIdentityProvider": "API Management", - "Set-AzureRmApiManagementBackend": "API Management", - "Set-AzureRmApiManagementAuthorizationServer": "API Management", - "New-AzureRmApiManagementProduct": "API Management", - "Remove-AzureRmApiManagementProduct": "API Management", - "New-AzureRmApiManagementBackend": "API Management", - "New-AzureRmApiManagementBackendServiceFabric": "API Management", - "Add-AzureRmApiManagementProductToGroup": "API Management", - "New-AzureRmApiManagementGroup": "API Management", - "Get-AzureRmApiManagementTenantGitAccess": "API Management", - "New-AzureRmApiManagementHostnameConfiguration": "API Management", - "Set-AzureRmApiManagementOperation": "API Management", - "Get-AzureRmApiManagementTenantAccess": "API Management", - "Get-AzureRmApiManagementSsoToken": "API Management", - "New-AzureRmApiManagementLogger": "API Management", - "Set-AzureRmApiManagement": "API Management", - "Set-AzureRmApiManagementProperty": "API Management", - "Set-AzureRmApiManagementApiRevision": "API Management", - "Set-AzureRmApiManagementApiVersionSet": "API Management", - "Update-AzureRmApiManagementRegion": "API Management", - "New-AzureRmApiManagementApiRevision": "API Management", - "Set-AzureRmApiManagementIdentityProvider": "API Management", - "Get-AzureRmApiManagementOpenIdConnectProvider": "API Management", - "New-AzureRmApiManagementSubscription": "API Management", - "Set-AzureRmApiManagementTenantAccess": "API Management", - "Remove-AzureRmApiManagementCertificate": "API Management", - "Set-AzureRmMarketplaceTerms": "Marketplace", - "Get-AzureRmMarketplaceTerms": "Marketplace", - "Remove-AzureRmApplicationInsightsContinuousExport": "Monitor", - "Set-AzureRmApplicationInsightsDailyCap": "Monitor", - "New-AzureRmApplicationInsights": "Monitor", - "Set-AzureRmApplicationInsightsPricingPlan": "Monitor", - "Get-AzureRmApplicationInsights": "Monitor", - "New-AzureRmApplicationInsightsContinuousExport": "Monitor", - "Remove-AzureRmApplicationInsights": "Monitor", - "New-AzureRmApplicationInsightsApiKey": "Monitor", - "Remove-AzureRmApplicationInsightsApiKey": "Monitor", - "Set-AzureRmApplicationInsightsContinuousExport": "Monitor", - "Get-AzureRmApplicationInsightsContinuousExport": "Monitor", - "Get-AzureRmApplicationInsightsApiKey": "Monitor", - "Get-AzureRMAutomationScheduledRunbook": "Automation", - "New-AzureRMAutomationConnection": "Automation", - "Get-AzureRmAutomationDscOnboardingMetaconfig": "Automation", - "Start-AzureRmAutomationDscNodeConfigurationDeployment": "Automation", - "New-AzureRmAutomationSoftwareUpdateConfiguration": "Automation", - "Register-AzureRMAutomationScheduledRunbook": "Automation", - "Stop-AzureRmAutomationDscNodeConfigurationDeployment": "Automation", - "Get-AzureRmAutomationSoftwareUpdateConfiguration": "Automation", - "Remove-AzureRmAutomationDscNodeConfiguration": "Automation", - "Get-AzureRmAutomationSoftwareUpdateMachineRun": "Automation", - "Get-AzureRmAutomationSourceControlSyncJob": "Automation", - "Export-AzureRMAutomationRunbook": "Automation", - "Get-AzureRmAutomationDscNodeConfigurationDeploymentSchedule": "Automation", - "Start-AzureRmAutomationSourceControlSyncJob": "Automation", - "Get-AzureRMAutomationSchedule": "Automation", - "Publish-AzureRMAutomationRunbook": "Automation", - "Unregister-AzureRmAutomationDscNode": "Automation", - "Set-AzureRMAutomationRunbook": "Automation", - "Set-AzureRmAutomationDscNode": "Automation", - "Get-AzureRMAutomationVariable": "Automation", - "Remove-AzureRmAutomationDscConfiguration": "Automation", - "New-AzureRMAutomationCredential": "Automation", - "Set-AzureRmAutomationAccount": "Automation", - "Remove-AzureRMAutomationVariable": "Automation", - "Set-AzureRMAutomationCertificate": "Automation", - "New-AzureRmAutomationSourceControl": "Automation", - "Register-AzureRmAutomationDscNode": "Automation", - "New-AzureRmAutomationModule": "Automation", - "Set-AzureRMAutomationVariable": "Automation", - "Remove-AzureRmAutomationSoftwareUpdateConfiguration": "Automation", - "Get-AzureRMAutomationCredential": "Automation", - "Get-AzureRmAutomationDscNodeConfiguration": "Automation", - "Get-AzureRMAutomationRunbook": "Automation", - "Get-AzureRmAutomationAccount": "Automation", - "Get-AzureRmAutomationSoftwareUpdateRun": "Automation", - "New-AzureRMAutomationCertificate": "Automation", - "Get-AzureRmAutomationModule": "Automation", - "Set-AzureRMAutomationWebhook": "Automation", - "Get-AzureRMAutomationWebhook": "Automation", - "Set-AzureRMAutomationConnectionFieldValue": "Automation", - "Resume-AzureRMAutomationJob": "Automation", - "Get-AzureRmAutomationRegistrationInfo": "Automation", - "New-AzureRMAutomationWebhook": "Automation", - "New-AzureRmAutomationKey": "Automation", - "Get-AzureRMAutomationConnection": "Automation", - "Remove-AzureRMAutomationSchedule": "Automation", - "Get-AzureRMAutomationJobOutput": "Automation", - "Remove-AzureRMAutomationCredential": "Automation", - "Get-AzureRmAutomationDscConfiguration": "Automation", - "Get-AzureRmAutomationDscNodeReport": "Automation", - "Set-AzureRmAutomationModule": "Automation", - "Start-AzureRMAutomationRunbook": "Automation", - "Get-AzureRmAutomationDscNode": "Automation", - "Unregister-AzureRMAutomationScheduledRunbook": "Automation", - "Update-AzureRmAutomationSourceControl": "Automation", - "Get-AzureRmAutomationDscCompilationJobOutput": "Automation", - "Remove-AzureRmAutomationAccount": "Automation", - "Remove-AzureRMAutomationConnection": "Automation", - "Suspend-AzureRMAutomationJob": "Automation", - "Get-AzureRMAutomationJob": "Automation", - "Get-AzureRmAutomationSourceControlSyncJobOutput": "Automation", - "Set-AzureRMAutomationSchedule": "Automation", - "Remove-AzureRmAutomationSourceControl": "Automation", - "Remove-AzureRMAutomationWebhook": "Automation", - "Stop-AzureRMAutomationJob": "Automation", - "Export-AzureRmAutomationDscNodeReportContent": "Automation", - "Get-AzureRmAutomationSourceControl": "Automation", - "Get-AzureRMAutomationCertificate": "Automation", - "New-AzureRMAutomationVariable": "Automation", - "Remove-AzureRmAutomationHybridWorkerGroup": "Automation", - "Import-AzureRmAutomationDscConfiguration": "Automation", - "Get-AzureRmAutomationDscCompilationJob": "Automation", - "Export-AzureRmAutomationDscConfiguration": "Automation", - "New-AzureRmAutomationAccount": "Automation", - "Get-AzureRmAutomationJobOutputRecord": "Automation", - "Import-AzureRmAutomationDscNodeConfiguration": "Automation", - "Get-AzureRMAutomationHybridWorkerGroup": "Automation", - "Remove-AzureRMAutomationRunbook": "Automation", - "Remove-AzureRMAutomationCertificate": "Automation", - "Start-AzureRmAutomationDscCompilationJob": "Automation", - "New-AzureRMAutomationRunbook": "Automation", - "Get-AzureRmAutomationDscNodeConfigurationDeployment": "Automation", - "Set-AzureRMAutomationCredential": "Automation", - "Import-AzureRMAutomationRunbook": "Automation", - "New-AzureRMAutomationSchedule": "Automation", - "Remove-AzureRmAutomationConnectionType": "Automation", - "Remove-AzureRmAutomationModule": "Automation", - "Get-AzureRmBillingInvoice": "Billing", - "Get-AzureRmBillingPeriod": "Billing", - "Get-AzureRmEnrollmentAccount": "Billing", - "Set-AzureRmPolicySetDefinition": "Policies", - "Remove-AzureRmDeployment": "Resources", - "Get-AzureRmADGroupMember": "Active Directory", - "Remove-AzureRmPolicyDefinition": "Policies", - "Move-AzureRmResource": "Resources", - "New-AzureRmADAppCredential": "Active Directory", - "Test-AzureRmResourceGroupDeployment": "Resources", - "Get-AzureRmManagedApplicationDefinition": "Resources", - "Register-AzureRmProviderFeature": "Resources", - "Get-AzureRmResourceGroupDeployment": "Resources", - "Get-AzureRmResource": "Resources", - "Remove-AzureRmADUser": "Active Directory", - "Remove-AzureRmADApplication": "Active Directory", - "Get-AzureRmPolicySetDefinition": "Policies", - "New-AzureRmPolicySetDefinition": "Policies", - "Add-AzureRmADGroupMember": "Active Directory", - "Unregister-AzureRmResourceProvider": "Resources", - "Remove-AzureRmManagedApplicationDefinition": "Resources", - "Remove-AzureRmResourceLock": "Resources", - "Get-AzureRmManagementGroup": "Resources", - "New-AzureRmADUser": "Active Directory", - "New-AzureRmResourceLock": "Resources", - "Get-AzureRmADUser": "Active Directory", - "Get-AzureRmResourceGroupDeploymentOperation": "Resources", - "Get-AzureRmPolicyAssignment": "Policies", - "Remove-AzureRmManagedApplication": "Resources", - "New-AzureRmADSpCredential": "Active Directory", - "Set-AzureRmResourceGroup": "Resources", - "Get-AzureRmProviderFeature": "Resources", - "Get-AzureRmADServicePrincipal": "Active Directory", - "Test-AzureRmDeployment": "Resources", - "Stop-AzureRmDeployment": "Resources", - "Get-AzureRmResourceGroup": "Resources", - "Get-AzureRmPolicyDefinition": "Policies", - "New-AzureRmADServicePrincipal": "Active Directory", - "Invoke-AzureRmResourceAction": "Resources", - "Update-AzureRmADServicePrincipal": "Active Directory", - "Get-AzureRmLocation": "Resources", - "Get-AzureRmDeployment": "Resources", - "Get-AzureRmProviderOperation": "Resources", - "Remove-AzureRmRoleAssignment": "Resources", - "New-AzureRmADGroup": "Active Directory", - "Update-AzureRmADUser": "Active Directory", - "Update-AzureRmManagementGroup": "Resources", - "Register-AzureRmResourceProvider": "Resources", - "Remove-AzureRmADAppCredential": "Active Directory", - "Get-AzureRmRoleAssignment": "Resources", - "Get-AzureRmADApplication": "Active Directory", - "Get-AzureRmADGroup": "Active Directory", - "Get-AzureRmManagedApplication": "Resources", - "Get-AzureRmResourceProvider": "Resources", - "Set-AzureRmPolicyDefinition": "Policies", - "Remove-AzureRmPolicyAssignment": "Policies", - "New-AzureRmManagedApplication": "Resources", - "Remove-AzureRmADServicePrincipal": "Active Directory", - "Set-AzureRmManagedApplication": "Resources", - "Set-AzureRmResource": "Resources", - "Remove-AzureRmADSpCredential": "Active Directory", - "Remove-AzureRmResource": "Resources", - "New-AzureRmADApplication": "Active Directory", - "Remove-AzureRmResourceGroup": "Resources", - "Set-AzureRmPolicyAssignment": "Policies", - "Get-AzureRmADAppCredential": "Active Directory", - "New-AzureRmManagementGroup": "Resources", - "New-AzureRmManagedApplicationDefinition": "Resources", - "Set-AzureRmRoleDefinition": "Resources", - "New-AzureRmResourceGroup": "Resources", - "Get-AzureRmResourceLock": "Resources", - "Remove-AzureRmADGroup": "Active Directory", - "Remove-AzureRmRoleDefinition": "Resources", - "New-AzureRmPolicyAssignment": "Policies", - "New-AzureRmPolicyDefinition": "Policies", - "Get-AzureRmADSpCredential": "Active Directory", - "Export-AzureRmResourceGroup": "Resources", - "New-AzureRmResource": "Resources", - "Get-AzureRmDeploymentOperation": "Resources", - "Remove-AzureRmADGroupMember": "Active Directory", - "New-AzureRmManagementGroupSubscription": "Resources", - "Remove-AzureRmPolicySetDefinition": "Policies", - "New-AzureRmRoleDefinition": "Resources", - "Remove-AzureRmManagementGroup": "Resources", - "Get-AzureRmPolicyAlias": "Policies", - "New-AzureRmResourceGroupDeployment": "Resources", - "New-AzureRmRoleAssignment": "Resources", - "Get-AzureRmRoleDefinition": "Resources", - "Save-AzureRmResourceGroupDeploymentTemplate": "Resources", - "Remove-AzureRmResourceGroupDeployment": "Resources", - "Set-AzureRmManagedApplicationDefinition": "Resources", - "Set-AzureRmResourceLock": "Resources", - "Remove-AzureRmManagementGroupSubscription": "Resources", - "Update-AzureRmADApplication": "Active Directory", - "Save-AzureRmDeploymentTemplate": "Resources", - "New-AzureRmDeployment": "Resources", - "Stop-AzureRmResourceGroupDeployment": "Resources", - "Get-AzureRmPolicyStateSummary": "Policy Insights", - "Remove-AzureRmPolicyRemediation": "Policy Insights", - "Get-AzureRmPolicyState": "Policy Insights", - "Stop-AzureRmPolicyRemediation": "Policy Insights", - "Get-AzureRmPolicyEvent": "Policy Insights", - "Start-AzureRmPolicyRemediation": "Policy Insights", - "Get-AzureRmPolicyRemediation": "Policy Insights", - "Set-AzureRmMlOpCluster": "Machine Learning", - "Get-AzureRmMlOpCluster": "Machine Learning", - "Remove-AzureRmMlOpCluster": "Machine Learning", - "New-AzureRmMlOpCluster": "Machine Learning", - "Update-AzureRmMlOpClusterSystemService": "Machine Learning", - "Test-AzureRmMlOpClusterSystemServicesUpdateAvailability": "Machine Learning", - "Get-AzureRmMlOpClusterKey": "Machine Learning", - "Get-AzureRmConsumptionPriceSheet": "Billing", - "Get-AzureRmConsumptionBudget": "Billing", - "Get-AzureRmConsumptionUsageDetail": "Billing", - "Get-AzureRmConsumptionMarketplace": "Billing", - "New-AzureRmConsumptionBudget": "Billing", - "Get-AzureRmConsumptionReservationSummary": "Billing", - "Set-AzureRmConsumptionBudget": "Billing", - "Get-AzureRmConsumptionReservationDetail": "Billing", - "Remove-AzureRmConsumptionBudget": "Billing", - "New-AzureRmAlertRuleWebhook": "Monitor", - "New-AzureRmAutoscaleRule": "Monitor", - "New-AzureRmActionGroup": "Monitor", - "Disable-AzureRmActivityLogAlert": "Monitor", - "New-AzureRmAlertRuleEmail": "Monitor", - "Get-AzureRmActionGroup": "Monitor", - "Get-AzureRmActivityLogAlert": "Monitor", - "Get-AzureRmMetricDefinition": "Monitor", - "Remove-AzureRmAutoscaleSetting": "Monitor", - "Remove-AzureRmDiagnosticSetting": "Monitor", - "Remove-AzureRmActivityLogAlert": "Monitor", - "New-AzureRmAutoscaleNotification": "Monitor", - "Get-AzureRmAutoscaleSetting": "Monitor", - "Enable-AzureRmActivityLogAlert": "Monitor", - "Get-AzureRmAutoscaleHistory": "Monitor", - "Remove-AzureRmAlertRule": "Monitor", - "Remove-AzureRmLogProfile": "Monitor", - "New-AzureRmAutoscaleProfile": "Monitor", - "Get-AzureRmDiagnosticSetting": "Monitor", - "Get-AzureRmMetric": "Monitor", - "Add-AzureRmAutoscaleSetting": "Monitor", - "Get-AzureRmLog": "Monitor", - "New-AzureRmActionGroupReceiver": "Monitor", - "Get-AzureRmLogProfile": "Monitor", - "Set-AzureRmActivityLogAlert": "Monitor", - "Add-AzureRmWebtestAlertRule": "Monitor", - "Add-AzureRmMetricAlertRule": "Monitor", - "Remove-AzureRmActionGroup": "Monitor", - "Get-AzureRmAlertHistory": "Monitor", - "Add-AzureRmLogProfile": "Monitor", - "Set-AzureRmActionGroup": "Monitor", - "Get-AzureRmAlertRule": "Monitor", - "New-AzureRmMetricFilter": "Monitor", - "Set-AzureRmDiagnosticSetting": "Monitor", - "New-AzureRmActivityLogAlertCondition": "Monitor", - "New-AzureRmAutoscaleWebhook": "Monitor", - "Get-AzureRmDataLakeAnalyticsJobPipeline": "Data Lake Analytics", - "New-AzureRmDataLakeAnalyticsComputePolicy": "Data Lake Analytics", - "Add-AzureRmDataLakeAnalyticsFirewallRule": "Data Lake Analytics", - "Set-AzureRmDataLakeAnalyticsCatalogItemAclEntry": "Data Lake Analytics", - "New-AzureRmDataLakeAnalyticsCatalogCredential": "Data Lake Analytics", - "Test-AzureRmDataLakeAnalyticsAccount": "Data Lake Analytics", - "Update-AzureRmDataLakeAnalyticsComputePolicy": "Data Lake Analytics", - "Remove-AzureRmDataLakeAnalyticsFirewallRule": "Data Lake Analytics", - "Remove-AzureRmDataLakeAnalyticsCatalogCredential": "Data Lake Analytics", - "Wait-AzureRmDataLakeAnalyticsJob": "Data Lake Analytics", - "Get-AzureRmDataLakeAnalyticsFirewallRule": "Data Lake Analytics", - "Get-AzureRmDataLakeAnalyticsCatalogItemAclEntry": "Data Lake Analytics", - "Remove-AzureRmDataLakeAnalyticsAccount": "Data Lake Analytics", - "New-AzureRmDataLakeAnalyticsCatalogSecret": "Data Lake Analytics", - "Set-AzureRmDataLakeAnalyticsCatalogSecret": "Data Lake Analytics", - "Set-AzureRmDataLakeAnalyticsFirewallRule": "Data Lake Analytics", - "New-AzureRmDataLakeAnalyticsAccount": "Data Lake Analytics", - "Remove-AzureRmDataLakeAnalyticsCatalogSecret": "Data Lake Analytics", - "Add-AzureRmDataLakeAnalyticsDataSource": "Data Lake Analytics", - "Test-AzureRmDataLakeAnalyticsCatalogItem": "Data Lake Analytics", - "Get-AzureRmDataLakeAnalyticsAccount": "Data Lake Analytics", - "Set-AzureRmDataLakeAnalyticsDataSource": "Data Lake Analytics", - "Submit-AzureRmDataLakeAnalyticsJob": "Data Lake Analytics", - "Remove-AzureRmDataLakeAnalyticsCatalogItemAclEntry": "Data Lake Analytics", - "Set-AzureRmDataLakeAnalyticsAccount": "Data Lake Analytics", - "Get-AzureRmDataLakeAnalyticsJobRecurrence": "Data Lake Analytics", - "Get-AzureRmDataLakeAnalyticsJob": "Data Lake Analytics", - "Remove-AzureRmDataLakeAnalyticsDataSource": "Data Lake Analytics", - "Get-AzureRmDataLakeAnalyticsCatalogItem": "Data Lake Analytics", - "Remove-AzureRmDataLakeAnalyticsComputePolicy": "Data Lake Analytics", - "Set-AzureRmDataLakeAnalyticsCatalogCredential": "Data Lake Analytics", - "Get-AzureRmDataLakeAnalyticsDataSource": "Data Lake Analytics", - "Get-AzureRmDataLakeAnalyticsComputePolicy": "Data Lake Analytics", - "Stop-AzureRmDataLakeAnalyticsJob": "Data Lake Analytics", - "Restart-AzureAnalysisServicesInstance": "Analysis Services", - "Sync-AzureAnalysisServicesInstance": "Analysis Services", - "Export-AzureAnalysisServicesInstanceLog": "Analysis Services", - "Add-AzureAnalysisServicesAccount": "Analysis Services", - "Update-AzureRmServiceFabricDurability": "Service Fabric", - "Add-AzureRmServiceFabricApplicationCertificate": "Service Fabric", - "Update-AzureRmServiceFabricReliability": "Service Fabric", - "Remove-AzureRmServiceFabricNode": "Service Fabric", - "Remove-AzureRmServiceFabricClientCertificate": "Service Fabric", - "Remove-AzureRmServiceFabricSetting": "Service Fabric", - "Add-AzureRmServiceFabricClusterCertificate": "Service Fabric", - "Remove-AzureRmServiceFabricNodeType": "Service Fabric", - "Add-AzureRmServiceFabricClientCertificate": "Service Fabric", - "Set-AzureRmServiceFabricSetting": "Service Fabric", - "Set-AzureRmServiceFabricUpgradeType": "Service Fabric", - "Remove-AzureRmServiceFabricClusterCertificate": "Service Fabric", - "New-AzureRmServiceFabricCluster": "Service Fabric", - "Get-AzureRmServiceFabricCluster": "Service Fabric", - "Add-AzureRmServiceFabricNode": "Service Fabric", - "Add-AzureRmServiceFabricNodeType": "Service Fabric", - "Remove-AzureRmRecoveryServicesAsrNetworkMapping": "Recovery Services", - "Get-AzureRmRecoveryServicesAsrPolicy": "Recovery Services", - "Get-AzureRmRecoveryServicesAsrProtectableItem": "Recovery Services", - "New-AzureRmRecoveryServicesAsrProtectableItem": "Recovery Services", - "Update-AzureRmRecoveryServicesAsrVCenter": "Recovery Services", - "Import-AzureRmRecoveryServicesAsrVaultSettingsFile": "Recovery Services", - "Get-AzureRmRecoveryServicesAsrEvent": "Recovery Services", - "Update-AzureRmRecoveryServicesAsrNetworkMapping": "Recovery Services", - "New-AzureRmRecoveryServicesAsrNetworkMapping": "Recovery Services", - "New-AzureRmRecoveryServicesAsrFabric": "Recovery Services", - "Update-AzureRmRecoveryServicesAsrRecoveryPlan": "Recovery Services", - "Get-AzureRmRecoveryServicesAsrRecoveryPlan": "Recovery Services", - "Start-AzureRmRecoveryServicesAsrUnplannedFailoverJob": "Recovery Services", - "Start-AzureRmRecoveryServicesAsrPlannedFailoverJob": "Recovery Services", - "Resume-AzureRmRecoveryServicesAsrJob": "Recovery Services", - "Set-AzureRmRecoveryServicesAsrReplicationProtectedItem": "Recovery Services", - "Update-AzureRmRecoveryServicesAsrProtectionDirection": "Recovery Services", - "New-AzureRmRecoveryServicesAsrReplicationProtectedItem": "Recovery Services", - "Get-AzureRmRecoveryServicesAsrJob": "Recovery Services", - "Start-AzureRmRecoveryServicesAsrCommitFailoverJob": "Recovery Services", - "Get-AzureRmRecoveryServicesAsrReplicationProtectedItem": "Recovery Services", - "Get-AzureRmRecoveryServicesAsrFabric": "Recovery Services", - "Get-AzureRmRecoveryServicesAsrServicesProvider": "Recovery Services", - "Remove-AzureRmRecoveryServicesAsrRecoveryPlan": "Recovery Services", - "Remove-AzureRmRecoveryServicesAsrProtectionContainer": "Recovery Services", - "Get-AzureRmRecoveryServicesAsrProtectionContainerMapping": "Recovery Services", - "New-AzureRmRecoveryServicesAsrProtectionContainer": "Recovery Services", - "Start-AzureRmRecoveryServicesAsrTestFailoverJob": "Recovery Services", - "Get-AzureRmRecoveryServicesAsrProtectionContainer": "Recovery Services", - "Get-AzureRmRecoveryServicesAsrNetwork": "Recovery Services", - "New-AzureRmRecoveryServicesAsrAzureToAzureDiskReplicationConfig": "Recovery Services", - "New-AzureRmRecoveryServicesAsrStorageClassificationMapping": "Recovery Services", - "Remove-AzureRmRecoveryServicesAsrStorageClassificationMapping": "Recovery Services", - "Restart-AzureRmRecoveryServicesAsrJob": "Recovery Services", - "Remove-AzureRmRecoveryServicesAsrProtectionContainerMapping": "Recovery Services", - "Update-AzureRmRecoveryServicesAsrMobilityService": "Recovery Services", - "Remove-AzureRmRecoveryServicesAsrServicesProvider": "Recovery Services", - "Edit-AzureRmRecoveryServicesAsrRecoveryPlan": "Recovery Services", - "Update-AzureRmRecoveryServicesAsrServicesProvider": "Recovery Services", - "Get-AzureRmRecoveryServicesAsrAlertSetting": "Recovery Services", - "New-AzureRmRecoveryServicesAsrPolicy": "Recovery Services", - "Start-AzureRmRecoveryServicesAsrApplyRecoveryPoint": "Recovery Services", - "Start-AzureRmRecoveryServicesAsrSwitchProcessServerJob": "Recovery Services", - "Get-AzureRmRecoveryServicesAsrNetworkMapping": "Recovery Services", - "Remove-AzureRmRecoveryServicesAsrPolicy": "Recovery Services", - "Set-AzureRmRecoveryServicesAsrAlertSetting": "Recovery Services", - "Get-AzureRmRecoveryServicesAsrStorageClassification": "Recovery Services", - "Remove-AzureRmRecoveryServicesAsrVCenter": "Recovery Services", - "Remove-AzureRmRecoveryServicesAsrReplicationProtectedItem": "Recovery Services", - "Remove-AzureRmRecoveryServicesAsrFabric": "Recovery Services", - "New-AzureRmRecoveryServicesAsrProtectionContainerMapping": "Recovery Services", - "New-AzureRmRecoveryServicesAsrRecoveryPlan": "Recovery Services", - "Get-AzureRmRecoveryServicesAsrRecoveryPoint": "Recovery Services", - "Start-AzureRmRecoveryServicesAsrResynchronizeReplicationJob": "Recovery Services", - "Start-AzureRmRecoveryServicesAsrTestFailoverCleanupJob": "Recovery Services", - "Get-AzureRmRecoveryServicesAsrStorageClassificationMapping": "Recovery Services", - "Update-AzureRmRecoveryServicesAsrPolicy": "Recovery Services", - "Stop-AzureRmRecoveryServicesAsrJob": "Recovery Services", - "Set-AzureRmRecoveryServicesAsrVaultContext": "Recovery Services", - "New-AzureRmRecoveryServicesAsrVCenter": "Recovery Services", - "Get-AzureRmRecoveryServicesAsrVCenter": "Recovery Services", - "Get-AzureRmRecoveryServicesAsrVaultContext": "Recovery Services", - "Get-AzureRmDtlAutoStartPolicy": "DevTest Labs", - "Get-AzureRmDtlAutoShutdownPolicy": "DevTest Labs", - "Set-AzureRmDtlAutoStartPolicy": "DevTest Labs", - "Set-AzureRmDtlAutoShutdownPolicy": "DevTest Labs", - "Get-AzureRmDtlVMsPerUserPolicy": "DevTest Labs", - "Set-AzureRmDtlAllowedVMSizesPolicy": "DevTest Labs", - "Set-AzureRmDtlVMsPerUserPolicy": "DevTest Labs", - "Get-AzureRmDtlAllowedVMSizesPolicy": "DevTest Labs", - "Get-AzureRmDtlVMsPerLabPolicy": "DevTest Labs", - "Set-AzureRmDtlVMsPerLabPolicy": "DevTest Labs", - "Set-AzureRmVMPlan": "Virtual Machines", - "New-AzureRmImage": "VM Images", - "Get-AzureRmGalleryImageDefinition": "VM Images", - "Update-AzureRmGallery": "Virtual Machines", - "Update-AzureRmGalleryImageVersion": "VM Images", - "Remove-AzureRmVMCustomScriptExtension": "VM Extensions", - "Remove-AzureRmVmss": "VM Scale Sets", - "Get-AzureRmVMDscExtensionStatus": "VM Extensions", - "Set-AzureRmVMExtension": "VM Extensions", - "New-AzureRmDiskUpdateConfig": "VM Disks", - "Get-AzureRmVmssVMDiskEncryption": "VM Scale Sets", - "Set-AzureRMVMDiagnosticsExtension": "VM Extensions", - "Grant-AzureRmSnapshotAccess": "VM Snapshots", - "Disable-AzureRmVmssDiskEncryption": "VM Scale Sets", - "Get-AzureRmVMDscExtension": "VM Extensions", - "Save-AzureRmVhd": "VM VHDs", - "Get-AzureRmVMAccessExtension": "VM Extensions", - "Set-AzureRmVmss": "VM Scale Sets", - "Set-AzureRmVMOperatingSystem": "Virtual Machines", - "Remove-AzureRmGalleryImageDefinition": "VM Images", - "Add-AzureRmVmssSshPublicKey": "VM Scale Sets", - "Get-AzureRmVmssVM": "VM Scale Sets", - "Get-AzureRMVMDiagnosticsExtension": "VM Extensions", - "Get-AzureRmVMDiskEncryptionStatus": "VM Disks", - "Remove-AzureRmVMNetworkInterface": "Virtual Machines", - "Remove-AzureRmVmssDataDisk": "VM Scale Sets", - "New-AzureRmVMSqlServerAutoBackupConfig": "Virtual Machines", - "Add-AzureRmVmssDiagnosticsExtension": "VM Scale Sets", - "Start-AzureRmVM": "Virtual Machines", - "Get-AzureRmVMChefExtension": "VM Extensions", - "Get-AzureRmVM": "Virtual Machines", - "ConvertTo-AzureRmVMManagedDisk": "VM Disks", - "Get-AzureRmVmssRollingUpgrade": "VM Scale Sets", - "Disable-AzureRmVMDiskEncryption": "VM Disks", - "Add-AzureRMVhd": "VM VHDs", - "Set-AzureRmVMADDomainExtension": "VM Extensions", - "Set-AzureRmVMBackupExtension": "VM Extensions", - "Get-AzureRmAvailabilitySet": "Virtual Machines", - "Set-AzureRmDiskImageReference": "VM Images", - "Get-AzureRmVMBootDiagnosticsData": "Virtual Machines", - "Stop-AzureRmVmssRollingUpgrade": "VM Scale Sets", - "Set-AzureRmSnapshotKeyEncryptionKey": "VM Snapshots", - "New-AzureRmVmssIpTagConfig": "VM Scale Sets", - "Set-AzureRmVMAEMExtension": "VM Extensions", - "Remove-AzureRmSnapshot": "VM Snapshots", - "Get-AzureRmGallery": "Virtual Machines", - "Remove-AzureRmVMDataDisk": "VM Disks", - "New-AzureRmVmss": "VM Scale Sets", - "Remove-AzureRmVM": "Virtual Machines", - "Add-AzureRmImageDataDisk": "VM Images", - "Remove-AzureRmContainerServiceAgentPoolProfile": "Container Service", - "Get-AzureRmVMAEMExtension": "VM Extensions", - "Set-AzureRmDiskDiskEncryptionKey": "VM Disks", - "Stop-AzureRmVmss": "VM Scale Sets", - "New-AzureRmSnapshotUpdateConfig": "VM Snapshots", - "Get-AzureRmGalleryImageVersion": "VM Images", - "Export-AzureRmLogAnalyticThrottledRequests": "Virtual Machines", - "Update-AzureRmVM": "Virtual Machines", - "Revoke-AzureRmSnapshotAccess": "VM Snapshots", - "Get-AzureRmVmssSku": "VM Scale Sets", - "Get-AzureRmVMImage": "VM Images", - "Set-AzureRmVM": "Virtual Machines", - "New-AzureRmGallery": "Virtual Machines", - "Add-AzureRmVmssAdditionalUnattendContent": "VM Scale Sets", - "Set-AzureRmVMCustomScriptExtension": "VM Extensions", - "Remove-AzureRmContainerService": "Container Service", - "Add-AzureRmVmssSecret": "VM Scale Sets", - "Update-AzureRmSnapshot": "VM Snapshots", - "New-AzureRmVmssConfig": "VM Scale Sets", - "Get-AzureRMVMSqlServerExtension": "VM Extensions", - "Set-AzureRmVMBootDiagnostics": "Virtual Machines", - "New-AzureRmVmssVaultCertificateConfig": "VM Scale Sets", - "Publish-AzureRmVMDscConfiguration": "Virtual Machines", - "Set-AzureRmVMOSDisk": "VM Disks", - "Get-AzureRmVMImagePublisher": "VM Images", - "Set-AzureRmVMDiskEncryptionExtension": "VM Disks", - "Remove-AzureRmDisk": "VM Disks", - "New-AzureRmVMConfig": "Virtual Machines", - "Save-AzureRmVMImage": "VM Images", - "Remove-AzureRmVMDscExtension": "VM Extensions", - "Get-AzureRmVMImageSku": "VM Images", - "Get-AzureRmVMADDomainExtension": "VM Extensions", - "Add-AzureRmContainerServiceAgentPoolProfile": "Container Service", - "Add-AzureRmVmssWinRMListener": "VM Scale Sets", - "Set-AzureRmVmssRollingUpgradePolicy": "VM Scale Sets", - "Remove-AzureRmVMAEMExtension": "VM Extensions", - "Repair-AzureRmVmssServiceFabricUpdateDomain": "VM Scale Sets", - "Invoke-AzureRmVmssVMRunCommand": "VM Scale Sets", - "Set-AzureRmVMDscExtension": "VM Extensions", - "New-AzureRmContainerServiceConfig": "Container Service", - "Add-AzureRmVMNetworkInterface": "Virtual Machines", - "Update-AzureRmImage": "VM Images", - "Set-AzureRmVmssDiskEncryptionExtension": "VM Scale Sets", - "Update-AzureRmVmss": "VM Scale Sets", - "New-AzureRmVmssIpConfig": "VM Scale Sets", - "Set-AzureRmImageOsDisk": "VM Images", - "Update-AzureRmDisk": "VM Disks", - "Get-AzureRmSnapshot": "VM Snapshots", - "Remove-AzureRMVMSqlServerExtension": "VM Extensions", - "Revoke-AzureRmDiskAccess": "VM Disks", - "New-AzureRmImageConfig": "VM Images", - "Test-AzureRmVMAEMExtension": "VM Extensions", - "Stop-AzureRmVM": "Virtual Machines", - "Add-AzureRmVmssVMDataDisk": "VM Scale Sets", - "Set-AzureRmDiskUpdateDiskEncryptionKey": "VM Disks", - "New-AzureRmVM": "Virtual Machines", - "New-AzureRmGalleryImageDefinition": "VM Images", - "New-AzureRmAvailabilitySet": "Virtual Machines", - "Set-AzureRmVmssBootDiagnostic": "VM Scale Sets", - "Remove-AzureRmImage": "VM Images", - "Set-AzureRmDiskKeyEncryptionKey": "VM Disks", - "Get-AzureRmVmssDiskEncryption": "VM Scale Sets", - "New-AzureRmSnapshotConfig": "VM Snapshots", - "Remove-AzureRmVMDiskEncryptionExtension": "VM Disks", - "Set-AzureRmVMSourceImage": "VM Images", - "Update-AzureRmGalleryImageDefinition": "VM Images", - "Update-AzureRmVmssInstance": "VM Scale Sets", - "Get-AzureRmRemoteDesktopFile": "Virtual Machines", - "Set-AzureRmVMBginfoExtension": "VM Extensions", - "Set-AzureRmSnapshotUpdateDiskEncryptionKey": "VM Snapshots", - "Get-AzureRmComputeResourceSku": "Virtual Machines", - "Get-AzureRmVMExtensionImage": "VM Images", - "Update-AzureRmAvailabilitySet": "Virtual Machines", - "New-AzureRmVMDataDisk": "VM Disks", - "Set-AzureRmVmssVM": "VM Scale Sets", - "Update-AzureRmVmssVM": "VM Scale Sets", - "Remove-AzureRmVMSecret": "Virtual Machines", - "Remove-AzureRmVmssDiagnosticsExtension": "VM Scale Sets", - "New-AzureRmContainerService": "Container Service", - "New-AzureRmGalleryImageVersion": "VM Images", - "Remove-AzureRmVmssExtension": "VM Scale Sets", - "New-AzureRmDisk": "VM Disks", - "Get-AzureRmVMRunCommandDocument": "Virtual Machines", - "Remove-AzureRmVMExtension": "VM Extensions", - "Add-AzureRmVmssDataDisk": "VM Scale Sets", - "Add-AzureRmVMSshPublicKey": "Virtual Machines", - "Get-AzureRmVMSize": "Virtual Machines", - "Set-AzureRmSnapshotImageReference": "VM Snapshots", - "Get-AzureRmDisk": "VM Disks", - "Remove-AzureRmVMBackup": "Virtual Machines", - "Export-AzureRmLogAnalyticRequestRateByInterval": "Virtual Machines", - "Get-AzureRmVMCustomScriptExtension": "VM Extensions", - "Add-AzureRmVMSecret": "Virtual Machines", - "Add-AzureRmVMAdditionalUnattendContent": "Virtual Machines", - "Get-AzureRmVMImageOffer": "VM Images", - "Set-AzureRmVmssOsProfile": "VM Scale Sets", - "Set-AzureRmVMChefExtension": "VM Extensions", - "Invoke-AzureRmVMRunCommand": "Virtual Machines", - "Set-AzureRMVMSqlServerExtension": "VM Extensions", - "Get-AzureRmImage": "VM Images", - "Add-AzureRmVmssNetworkInterfaceConfiguration": "VM Scale Sets", - "Set-AzureRmDiskUpdateKeyEncryptionKey": "VM Disks", - "Set-AzureRMVMDataDisk": "VM Disks", - "Add-AzureRmVmssExtension": "VM Scale Sets", - "New-AzureRmVMSqlServerAutoPatchingConfig": "Virtual Machines", - "Remove-AzureRmAvailabilitySet": "Virtual Machines", - "New-AzureRmSnapshot": "VM Snapshots", - "Remove-AzureRmVMDiagnosticsExtension": "VM Extensions", - "Remove-AzureRmGallery": "Virtual Machines", - "Remove-AzureRmImageDataDisk": "VM Images", - "Update-AzureRmContainerService": "Container Service", - "Add-AzureRmVMDataDisk": "VM Disks", - "Start-AzureRmVmssRollingOSUpgrade": "VM Scale Sets", - "Set-AzureRmSnapshotUpdateKeyEncryptionKey": "VM Snapshots", - "Restart-AzureRmVmss": "VM Scale Sets", - "Remove-AzureRmVMAccessExtension": "VM Extensions", - "Get-AzureRmContainerService": "Container Service", - "Grant-AzureRmDiskAccess": "VM Disks", - "Set-AzureRmVMAccessExtension": "VM Extensions", - "Remove-AzureRmVMChefExtension": "VM Extensions", - "Get-AzureRmVMExtensionImageType": "VM Images", - "Remove-AzureRmGalleryImageVersion": "VM Images", - "Remove-AzureRmVmssVMDataDisk": "VM Scale Sets", - "Restart-AzureRmVM": "Virtual Machines", - "Get-AzureRmVmss": "VM Scale Sets", - "Set-AzureRmSnapshotDiskEncryptionKey": "VM Snapshots", - "Start-AzureRmVmss": "VM Scale Sets", - "Set-AzureRmVmssStorageProfile": "VM Scale Sets", - "Get-AzureRmVMExtension": "VM Extensions", - "New-AzureRmVMSqlServerKeyVaultCredentialConfig": "Virtual Machines", - "New-AzureRmDiskConfig": "VM Disks", - "Remove-AzureRmVmssNetworkInterfaceConfiguration": "VM Scale Sets", - "Get-AzureRmVMUsage": "Virtual Machines", - "Get-AzureRmRedisCachePatchSchedule": "Redis Cache", - "Reset-AzureRmRedisCache": "Redis Cache", - "New-AzureRmRedisCacheScheduleEntry": "Redis Cache", - "Remove-AzureRmRedisCachePatchSchedule": "Redis Cache", - "Remove-AzureRmRedisCacheFirewallRule": "Redis Cache", - "Get-AzureRmRedisCache": "Redis Cache", - "New-AzureRmRedisCacheLink": "Redis Cache", - "Get-AzureRmRedisCacheFirewallRule": "Redis Cache", - "Import-AzureRmRedisCache": "Redis Cache", - "Remove-AzureRmRedisCache": "Redis Cache", - "Set-AzureRmRedisCache": "Redis Cache", - "Get-AzureRmRedisCacheKey": "Redis Cache", - "Set-AzureRmRedisCacheDiagnostics": "Redis Cache", - "New-AzureRmRedisCacheKey": "Redis Cache", - "Remove-AzureRmRedisCacheDiagnostics": "Redis Cache", - "Export-AzureRmRedisCache": "Redis Cache", - "Get-AzureRmRedisCacheLink": "Redis Cache", - "Remove-AzureRmRedisCacheLink": "Redis Cache", - "New-AzureRmRedisCachePatchSchedule": "Redis Cache", - "New-AzureRmRedisCacheFirewallRule": "Redis Cache", - "New-AzureRmRedisCache": "Redis Cache", - "Test-AzureRmEventHubName": "Event Hub", - "New-AzureRmEventHub": "Event Hub", - "Get-AzureRmEventHub": "Event Hub", - "New-AzureRmEventHubNamespace": "Event Hub", - "Set-AzureRmEventHubConsumerGroup": "Event Hub", - "Remove-AzureRmEventHubNamespace": "Event Hub", - "Set-AzureRmEventHubGeoDRConfigurationFailOver": "Event Hub", - "Get-AzureRmEventHubNamespace": "Event Hub", - "New-AzureRmEventHubConsumerGroup": "Event Hub", - "Get-AzureRmEventHubConsumerGroup": "Event Hub", - "Remove-AzureRmEventHubGeoDRConfiguration": "Event Hub", - "New-AzureRmEventHubGeoDRConfiguration": "Event Hub", - "Remove-AzureRmEventHub": "Event Hub", - "Remove-AzureRmEventHubAuthorizationRule": "Event Hub", - "Get-AzureRmEventHubGeoDRConfiguration": "Event Hub", - "Set-AzureRmEventHub": "Event Hub", - "New-AzureRmEventHubAuthorizationRule": "Event Hub", - "Set-AzureRmEventHubGeoDRConfigurationBreakPair": "Event Hub", - "Remove-AzureRmEventHubConsumerGroup": "Event Hub", - "New-AzureRmEventHubKey": "Event Hub", - "Get-AzureRmEventHubAuthorizationRule": "Event Hub", - "Set-AzureRmEventHubNamespace": "Event Hub", - "Set-AzureRmEventHubAuthorizationRule": "Event Hub", - "Get-AzureRmEventHubKey": "Event Hub", - "New-AzureRmStreamAnalyticsInput": "Stream Analytics", - "Get-AzureRmStreamAnalyticsFunction": "Stream Analytics", - "Remove-AzureRmStreamAnalyticsJob": "Stream Analytics", - "Stop-AzureRmStreamAnalyticsJob": "Stream Analytics", - "Test-AzureRmStreamAnalyticsFunction": "Stream Analytics", - "Test-AzureRmStreamAnalyticsOutput": "Stream Analytics", - "Get-AzureRmStreamAnalyticsQuota": "Stream Analytics", - "New-AzureRmStreamAnalyticsTransformation": "Stream Analytics", - "Get-AzureRmStreamAnalyticsTransformation": "Stream Analytics", - "Remove-AzureRmStreamAnalyticsOutput": "Stream Analytics", - "Remove-AzureRmStreamAnalyticsFunction": "Stream Analytics", - "Get-AzureRmStreamAnalyticsOutput": "Stream Analytics", - "New-AzureRmStreamAnalyticsFunction": "Stream Analytics", - "Remove-AzureRmStreamAnalyticsInput": "Stream Analytics", - "Get-AzureRmStreamAnalyticsDefaultFunctionDefinition": "Stream Analytics", - "Get-AzureRmStreamAnalyticsInput": "Stream Analytics", - "New-AzureRmStreamAnalyticsOutput": "Stream Analytics", - "Get-AzureRmStreamAnalyticsJob": "Stream Analytics", - "Test-AzureRmStreamAnalyticsInput": "Stream Analytics", - "New-AzureRmStreamAnalyticsJob": "Stream Analytics", - "Start-AzureRmStreamAnalyticsJob": "Stream Analytics", - "Enable-AzureRmTrafficManagerEndpoint": "Traffic Manager", - "Remove-AzureRmTrafficManagerCustomHeaderFromEndpoint": "Traffic Manager", - "Set-AzureRmTrafficManagerProfile": "Traffic Manager", - "Remove-AzureRmTrafficManagerExpectedStatusCodeRange": "Traffic Manager", - "Get-AzureRmTrafficManagerEndpoint": "Traffic Manager", - "New-AzureRmTrafficManagerProfile": "Traffic Manager", - "Enable-AzureRmTrafficManagerProfile": "Traffic Manager", - "Disable-AzureRmTrafficManagerEndpoint": "Traffic Manager", - "Add-AzureRmTrafficManagerIpAddressRange": "Traffic Manager", - "Remove-AzureRmTrafficManagerProfile": "Traffic Manager", - "Add-AzureRmTrafficManagerCustomHeaderToEndpoint": "Traffic Manager", - "Remove-AzureRmTrafficManagerCustomHeaderFromProfile": "Traffic Manager", - "Add-AzureRmTrafficManagerExpectedStatusCodeRange": "Traffic Manager", - "Get-AzureRmTrafficManagerProfile": "Traffic Manager", - "Disable-AzureRmTrafficManagerProfile": "Traffic Manager", - "Remove-AzureRmTrafficManagerEndpointConfig": "Traffic Manager", - "Add-AzureRmTrafficManagerCustomHeaderToProfile": "Traffic Manager", - "Remove-AzureRmTrafficManagerIpAddressRange": "Traffic Manager", - "Remove-AzureRmTrafficManagerEndpoint": "Traffic Manager", - "New-AzureRmTrafficManagerEndpoint": "Traffic Manager", - "Set-AzureRmTrafficManagerEndpoint": "Traffic Manager", - "Add-AzureRmTrafficManagerEndpointConfig": "Traffic Manager", - "Get-AzureRmSearchAdminKeyPair": "Search", - "Remove-AzureRmSearchQueryKey": "Search", - "Get-AzureRmSearchQueryKey": "Search", - "Get-AzureRmSearchService": "Search", - "New-AzureRmSearchAdminKey": "Search", - "Remove-AzureRmSearchService": "Search", - "New-AzureRmSearchService": "Search", - "Set-AzureRmSearchService": "Search", - "New-AzureRmSearchQueryKey": "Search", - "Remove-AzureRmManagementPartner": "Management Partner", - "New-AzureRmManagementPartner": "Management Partner", - "Get-AzureRmManagementPartner": "Management Partner", - "Update-AzureRmManagementPartner": "Management Partner", - "Set-AzureRmMediaService": "Media Services", - "New-AzureRmMediaService": "Media Services", - "Set-AzureRmMediaServiceKey": "Media Services", - "Get-AzureRmMediaServiceNameAvailability": "Media Services", - "Remove-AzureRmMediaService": "Media Services", - "Get-AzureRmMediaServiceKeys": "Media Services", - "Sync-AzureRmMediaServiceStorageKeys": "Media Services", - "New-AzureRmMediaServiceStorageConfig": "Media Services", - "Get-AzureRmMediaService": "Media Services", - "Get-AzureRmTag": "Tags", - "Remove-AzureRmTag": "Tags", - "New-AzureRmTag": "Tags", - "New-AzureRmOperationalInsightsStorageInsight": "Operational Insights", - "Get-AzureRmOperationalInsightsSavedSearchResults": "Operational Insights", - "New-AzureRmOperationalInsightsSavedSearch": "Operational Insights", - "Set-AzureRmOperationalInsightsStorageInsight": "Operational Insights", - "Set-AzureRmOperationalInsightsIntelligencePack": "Operational Insights", - "Get-AzureRmOperationalInsightsWorkspaceSharedKeys": "Operational Insights", - "Disable-AzureRmOperationalInsightsLinuxCustomLogCollection": "Operational Insights", - "Remove-AzureRmOperationalInsightsWorkspace": "Operational Insights", - "Get-AzureRmOperationalInsightsSchema": "Operational Insights", - "Remove-AzureRmOperationalInsightsStorageInsight": "Operational Insights", - "New-AzureRmOperationalInsightsWindowsPerformanceCounterDataSource": "Operational Insights", - "Enable-AzureRmOperationalInsightsLinuxPerformanceCollection": "Operational Insights", - "Enable-AzureRmOperationalInsightsIISLogCollection": "Operational Insights", - "Get-AzureRmOperationalInsightsSavedSearch": "Operational Insights", - "Get-AzureRmOperationalInsightsIntelligencePacks": "Operational Insights", - "Get-AzureRmOperationalInsightsWorkspaceManagementGroups": "Operational Insights", - "New-AzureRmOperationalInsightsComputerGroup": "Operational Insights", - "New-AzureRmOperationalInsightsWindowsEventDataSource": "Operational Insights", - "Get-AzureRmOperationalInsightsStorageInsight": "Operational Insights", - "Get-AzureRmOperationalInsightsDataSource": "Operational Insights", - "New-AzureRmOperationalInsightsLinuxPerformanceObjectDataSource": "Operational Insights", - "Invoke-AzureRmOperationalInsightsQuery": "Operational Insights", - "Enable-AzureRmOperationalInsightsLinuxSyslogCollection": "Operational Insights", - "Get-AzureRmOperationalInsightsSearchResults": "Operational Insights", - "Remove-AzureRmOperationalInsightsDataSource": "Operational Insights", - "Get-AzureRmOperationalInsightsLinkTargets": "Operational Insights", - "Disable-AzureRmOperationalInsightsLinuxSyslogCollection": "Operational Insights", - "New-AzureRmOperationalInsightsWorkspace": "Operational Insights", - "New-AzureRmOperationalInsightsAzureActivityLogDataSource": "Operational Insights", - "Remove-AzureRmOperationalInsightsSavedSearch": "Operational Insights", - "Disable-AzureRmOperationalInsightsLinuxPerformanceCollection": "Operational Insights", - "Get-AzureRmOperationalInsightsWorkspace": "Operational Insights", - "Enable-AzureRmOperationalInsightsLinuxCustomLogCollection": "Operational Insights", - "Set-AzureRmOperationalInsightsSavedSearch": "Operational Insights", - "New-AzureRmOperationalInsightsCustomLogDataSource": "Operational Insights", - "Get-AzureRmOperationalInsightsWorkspaceUsage": "Operational Insights", - "Disable-AzureRmOperationalInsightsIISLogCollection": "Operational Insights", - "New-AzureRmOperationalInsightsLinuxSyslogDataSource": "Operational Insights", - "Set-AzureRmOperationalInsightsDataSource": "Operational Insights", - "Set-AzureRmOperationalInsightsWorkspace": "Operational Insights", - "Get-AzureRmContext": "Profile", - "Select-AzureRmContext": "Profile", - "Set-AzureRmEnvironment": "Profile", - "Remove-AzureRmEnvironment": "Profile", - "Get-AzureRmContextAutosaveSetting": "Profile", - "Send-Feedback": "Profile", - "Enable-AzureRmContextAutosave": "Profile", - "Disable-AzureRmDataCollection": "Profile", - "Resolve-AzureRmError": "Profile", - "Add-AzureRmEnvironment": "Profile", - "Connect-AzureRmAccount": "Profile", - "Remove-AzureRmContext": "Profile", - "Disconnect-AzureRmAccount": "Profile", - "Set-AzureRmDefault": "Profile", - "Rename-AzureRmContext": "Profile", - "Set-AzureRmContext": "Profile", - "Get-AzureRmDefault": "Profile", - "Get-AzureRmSubscription": "Profile", - "Clear-AzureRmDefault": "Profile", - "Get-AzureRmEnvironment": "Profile", - "Disable-AzureRmContextAutosave": "Profile", - "Get-AzureRmTenant": "Profile", - "Clear-AzureRmContext": "Profile", - "Import-AzureRmContext": "Profile", - "Enable-AzureRmDataCollection": "Profile", - "Save-AzureRmContext": "Profile", - "New-AzureRmContainerRegistryReplication": "Container Registry", - "Update-AzureRmContainerRegistryWebhook": "Container Registry", - "Update-AzureRmContainerRegistry": "Container Registry", - "Get-AzureRmContainerRegistryReplication": "Container Registry", - "New-AzureRmContainerRegistryWebhook": "Container Registry", - "New-AzureRmContainerRegistry": "Container Registry", - "Get-AzureRmContainerRegistryWebhook": "Container Registry", - "Get-AzureRmContainerRegistryCredential": "Container Registry", - "Remove-AzureRmContainerRegistryWebhook": "Container Registry", - "Test-AzureRmContainerRegistryNameAvailability": "Container Registry", - "Get-AzureRmContainerRegistry": "Container Registry", - "Remove-AzureRmContainerRegistry": "Container Registry", - "Remove-AzureRmContainerRegistryReplication": "Container Registry", - "Get-AzureRmContainerRegistryWebhookEvent": "Container Registry", - "Update-AzureRmContainerRegistryCredential": "Container Registry", - "Test-AzureRmContainerRegistryWebhook": "Container Registry", - "New-AzureRmIoTDeviceProvisioningServiceCertificateVerificationCode": "DPS", - "Update-AzureRmIoTDeviceProvisioningServiceLinkedHub": "DPS", - "Remove-AzureRmIoTDeviceProvisioningServiceLinkedHub": "DPS", - "Get-AzureRmIoTDeviceProvisioningService": "DPS", - "Update-AzureRmIoTDeviceProvisioningService": "DPS", - "Get-AzureRmIoTDeviceProvisioningServiceCertificate": "DPS", - "Get-AzureRmIoTDeviceProvisioningServiceAccessPolicy": "DPS", - "Remove-AzureRmIoTDeviceProvisioningServiceCertificate": "DPS", - "Update-AzureRmIoTDeviceProvisioningServiceAccessPolicy": "DPS", - "New-AzureRmIoTDeviceProvisioningService": "DPS", - "Remove-AzureRmIoTDeviceProvisioningService": "DPS", - "Add-AzureRmIoTDeviceProvisioningServiceLinkedHub": "DPS", - "Get-AzureRmIoTDeviceProvisioningServiceLinkedHub": "DPS", - "Remove-AzureRmIoTDeviceProvisioningServiceAccessPolicy": "DPS", - "Set-AzureRmIoTDeviceProvisioningServiceCertificate": "DPS", - "Add-AzureRmIoTDeviceProvisioningServiceCertificate": "DPS", - "Add-AzureRmIoTDeviceProvisioningServiceAccessPolicy": "DPS", - "Get-AzureRmCdnEndpointNameAvailability": "CDN", - "Set-AzureRmCdnProfile": "CDN", - "Stop-AzureRmCdnEndpoint": "CDN", - "New-AzureRmCdnProfile": "CDN", - "Get-AzureRmCdnSubscriptionResourceUsage": "CDN", - "Remove-AzureRmCdnCustomDomain": "CDN", - "Publish-AzureRmCdnEndpointContent": "CDN", - "Remove-AzureRmCdnEndpoint": "CDN", - "Get-AzureRmCdnEndpoint": "CDN", - "Disable-AzureRmCdnCustomDomain": "CDN", - "Get-AzureRmCdnProfileSsoUrl": "CDN", - "Set-AzureRmCdnOrigin": "CDN", - "Test-AzureRmCdnCustomDomain": "CDN", - "New-AzureRmCdnCustomDomain": "CDN", - "Get-AzureRmCdnOrigin": "CDN", - "Get-AzureRmCdnEndpointResourceUsage": "CDN", - "Remove-AzureRmCdnProfile": "CDN", - "Set-AzureRmCdnEndpoint": "CDN", - "Get-AzureRmCdnEdgeNodes": "CDN", - "Get-AzureRMCdnProfile": "CDN", - "Get-AzureRmCdnProfileResourceUsage": "CDN", - "Enable-AzureRmCdnCustomDomain": "CDN", - "Start-AzureRmCdnEndpoint": "CDN", - "Unpublish-AzureRmCdnEndpointContent": "CDN", - "Get-AzureRmCdnCustomDomain": "CDN", - "New-AzureRmCdnEndpoint": "CDN", - "Confirm-AzureRmCdnEndpointProbeURL": "CDN", - "Get-AzureRmCdnProfileSupportedOptimizationType": "CDN", - "New-AzureRmServiceBusTopic": "Service Bus", - "Remove-AzureRmServiceBusTopic": "Service Bus", - "Remove-AzureRmServiceBusQueue": "Service Bus", - "Get-AzureRmServiceBusNamespace": "Service Bus", - "Get-AzureRmServiceBusGeoDRConfiguration": "Service Bus", - "Remove-AzureRmServiceBusNamespace": "Service Bus", - "Get-AzureRmServiceBusKey": "Service Bus", - "Set-AzureRmServiceBusQueue": "Service Bus", - "Set-AzureRmServiceBusNamespace": "Service Bus", - "Get-AzureRmServiceBusSubscription": "Service Bus", - "Start-AzureRmServiceBusMigration": "Service Bus", - "Set-AzureRmServiceBusGeoDRConfigurationFailOver": "Service Bus", - "Set-AzureRmServiceBusGeoDRConfigurationBreakPair": "Service Bus", - "New-AzureRmServiceBusSubscription": "Service Bus", - "Remove-AzureRmServiceBusGeoDRConfiguration": "Service Bus", - "Test-AzureRmServiceBusName": "Service Bus", - "New-AzureRmServiceBusQueue": "Service Bus", - "New-AzureRmServiceBusKey": "Service Bus", - "Get-AzureRmServiceBusMigration": "Service Bus", - "Complete-AzureRmServiceBusMigration": "Service Bus", - "New-AzureRmServiceBusNamespace": "Service Bus", - "New-AzureRmServiceBusGeoDRConfiguration": "Service Bus", - "Set-AzureRmServiceBusTopic": "Service Bus", - "Get-AzureRmServiceBusQueue": "Service Bus", - "Set-AzureRmServiceBusAuthorizationRule": "Service Bus", - "Remove-AzureRmServiceBusMigration": "Service Bus", - "Remove-AzureRmServiceBusSubscription": "Service Bus", - "Set-AzureRmServiceBusRule": "Service Bus", - "Get-AzureRmServiceBusOperation": "Service Bus", - "Stop-AzureRmServiceBusMigration": "Service Bus", - "Get-AzureRmServiceBusRule": "Service Bus", - "Remove-AzureRmServiceBusAuthorizationRule": "Service Bus", - "New-AzureRmServiceBusAuthorizationRule": "Service Bus", - "Get-AzureRmServiceBusAuthorizationRule": "Service Bus", - "Remove-AzureRmServiceBusRule": "Service Bus", - "New-AzureRmServiceBusRule": "Service Bus", - "Set-AzureRmServiceBusSubscription": "Service Bus", - "Get-AzureRmServiceBusTopic": "Service Bus", - "Set-AzureRmNotificationHubAuthorizationRules": "Notification Hubs", - "Set-AzureRmNotificationHubsNamespaceAuthorizationRules": "Notification Hubs", - "New-AzureRmNotificationHubAuthorizationRules": "Notification Hubs", - "New-AzureRmNotificationHubsNamespaceKey": "Notification Hubs", - "New-AzureRmNotificationHubKey": "Notification Hubs", - "Remove-AzureRmNotificationHubsNamespaceAuthorizationRules": "Notification Hubs", - "Set-AzureRmNotificationHubsNamespace": "Notification Hubs", - "Set-AzureRmNotificationHub": "Notification Hubs", - "Get-AzureRmNotificationHub": "Notification Hubs", - "Get-AzureRmNotificationHubPNSCredentials": "Notification Hubs", - "Remove-AzureRmNotificationHubsNamespace": "Notification Hubs", - "New-AzureRmNotificationHubsNamespaceAuthorizationRules": "Notification Hubs", - "Remove-AzureRmNotificationHubAuthorizationRules": "Notification Hubs", - "New-AzureRmNotificationHubsNamespace": "Notification Hubs", - "Get-AzureRmNotificationHubsNamespaceListKeys": "Notification Hubs", - "Remove-AzureRmNotificationHub": "Notification Hubs", - "Get-AzureRmNotificationHubListKeys": "Notification Hubs", - "Get-AzureRmNotificationHubAuthorizationRules": "Notification Hubs", - "Get-AzureRmNotificationHubsNamespace": "Notification Hubs", - "New-AzureRmNotificationHub": "Notification Hubs", - "Get-AzureRmNotificationHubsNamespaceAuthorizationRules": "Notification Hubs", - "Remove-AzureRmDevSpacesController": "DevSpaces", - "Update-AzureRmDevSpacesController": "DevSpaces", - "Get-AzureRmDevSpacesController": "DevSpaces", - "New-AzureRmDevSpacesController": "DevSpaces", - "Get-AzureRmVirtualNetworkUsageList": "Virtual Network", - "New-AzureRmServiceEndpointPolicyDefinition": "Networking", - "Set-AzureRmServiceEndpointPolicy": "Networking", - "New-AzureRmNetworkProfile": "Networking", - "New-AzureRmVirtualHubVnetConnection": "Networking", - "Add-AzureRmVirtualNetworkSubnetConfig": "Virtual Network", - "Remove-AzureRmVpnGateway": "VPN", - "Remove-AzureRmApplicationGatewayIPConfiguration": "Application Gateway", - "New-AzureRmVirtualHubRouteTable": "Route", - "Remove-AzureRmVirtualNetworkTap": "Virtual Network", - "Get-AzureRmRouteFilter": "Route", - "Get-AzureRmLocalNetworkGateway": "Networking", - "Remove-AzureRmApplicationGatewayAutoscaleConfiguration": "Application Gateway", - "Get-AzureRmVirtualNetworkAvailableEndpointService": "Virtual Network", - "Get-AzureRmVirtualNetworkGatewayConnection": "Virtual Network", - "Set-AzureRmNetworkInterfaceTapConfig": "Networking", - "Get-AzureRmVirtualNetwork": "Virtual Network", - "New-AzureRmApplicationGatewayFirewallDisabledRuleGroupConfig": "Application Gateway", - "New-AzureRmVpnClientRevokedCertificate": "VPN", - "New-AzureRmApplicationGatewayAutoscaleConfiguration": "Application Gateway", - "Remove-AzureRmVirtualWan": "Networking", - "Get-AzureRmApplicationGatewayCustomError": "Application Gateway", - "Get-AzureRmNetworkWatcherPacketCapture": "Network Watcher", - "Remove-AzureRmLoadBalancerBackendAddressPoolConfig": "Load Balancer", - "Get-AzureRmApplicationGatewayHttpListener": "Application Gateway", - "Add-AzureRmLoadBalancerFrontendIpConfig": "Load Balancer", - "New-AzureRmVpnClientIpsecPolicy": "VPN", - "Get-AzureRmExpressRouteCircuit": "ExpressRoute", - "Set-AzureRmApplicationGatewayIPConfiguration": "Application Gateway", - "Get-AzureRmVirtualNetworkPeering": "Virtual Network", - "New-AzureRmNetworkWatcher": "Network Watcher", - "New-AzureRmApplicationGatewayProbeConfig": "Application Gateway", - "Set-AzureRmFirewall": "Networking", - "Remove-AzureRmApplicationGatewayBackendHttpSettings": "Application Gateway", - "Get-AzureRmPublicIpPrefix": "Networking", - "Test-AzureRmNetworkWatcherConnectivity": "Network Watcher", - "New-AzureRmFirewallApplicationRule": "Networking", - "Get-AzureRmPublicIpAddress": "Networking", - "Remove-AzureRmApplicationGatewayProbeConfig": "Application Gateway", - "Remove-AzureRmNetworkWatcherPacketCapture": "Network Watcher", - "New-AzureRmServiceEndpointPolicy": "Networking", - "Remove-AzureRmApplicationGatewayBackendAddressPool": "Application Gateway", - "Set-AzureRmVirtualNetworkGateway": "Virtual Network", - "Get-AzureRmVirtualWanVpnConfiguration": "VPN", - "Get-AzureRmNetworkWatcherSecurityGroupView": "Network Watcher", - "Get-AzureRmApplicationGatewaySslPolicy": "Application Gateway", - "Remove-AzureRmVpnConnection": "VPN", - "Set-AzureRmApplicationGatewaySslPolicy": "Application Gateway", - "New-AzureRmApplicationGatewayBackendAddressPool": "Application Gateway", - "Set-AzureRmApplicationGatewaySku": "Application Gateway", - "Remove-AzureRmLoadBalancerInboundNatRuleConfig": "Load Balancer", - "New-AzureRmFirewallNatRuleCollection": "Networking", - "Remove-AzureRmPublicIpPrefix": "Networking", - "New-AzureRmFirewallNatRule": "Networking", - "New-AzureRmApplicationGatewayRedirectConfiguration": "Application Gateway", - "Remove-AzureRmApplicationGatewayAuthenticationCertificate": "Application Gateway", - "Get-AzureRmApplicationGatewayProbeConfig": "Application Gateway", - "Remove-AzureRmDelegation": "Networking", - "Add-AzureRmApplicationGatewayHttpListenerCustomError": "Application Gateway", - "Get-AzureRmVpnClientIpsecParameter": "VPN", - "Set-AzureRmApplicationGatewayCustomError": "Application Gateway", - "Set-AzureRmApplicationGatewayConnectionDraining": "Application Gateway", - "Get-AzureRmApplicationGatewayAutoscaleConfiguration": "Application Gateway", - "New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration": "Application Gateway", - "Get-AzureRmApplicationGatewayWebApplicationFirewallConfiguration": "Application Gateway", - "New-AzureRmApplicationGatewayHttpListener": "Application Gateway", - "Remove-AzureRmDdosProtectionPlan": "Networking", - "New-AzureRmApplicationSecurityGroup": "Networking", - "New-AzureRmRouteTable": "Route", - "Add-AzureRmExpressRouteCircuitAuthorization": "ExpressRoute", - "Remove-AzureRmApplicationGatewaySslCertificate": "Application Gateway", - "Set-AzureRmApplicationGatewayProbeConfig": "Application Gateway", - "New-AzureRmNetworkInterfaceIpConfig": "Networking", - "Get-AzureRmEffectiveRouteTable": "Route", - "Get-AzureRmNetworkWatcherTroubleshootingResult": "Network Watcher", - "Remove-AzureRmVirtualNetworkGatewayConnection": "Virtual Network", - "Add-AzureRmVpnClientRootCertificate": "VPN", - "Get-AzureRmRouteTable": "Route", - "New-AzureRmVirtualWan": "Networking", - "Remove-AzureRmVirtualHubVnetConnection": "Networking", - "Set-AzureRmPublicIpPrefix": "Networking", - "Remove-AzureRmServiceEndpointPolicyDefinition": "Networking", - "Add-AzureRmApplicationGatewaySslCertificate": "Application Gateway", - "Get-AzureRmApplicationGatewayRedirectConfiguration": "Application Gateway", - "Set-AzureRmNetworkSecurityRuleConfig": "Networking", - "Get-AzureRmApplicationGatewayBackendHealth": "Application Gateway", - "Remove-AzureRmFirewall": "Networking", - "Remove-AzureRmNetworkInterfaceTapConfig": "Networking", - "Remove-AzureRmRouteFilter": "Route", - "Remove-AzureRmVirtualNetworkGatewayIpConfig": "Virtual Network", - "Set-AzureRmNetworkInterfaceIpConfig": "Networking", - "Remove-AzureRmExpressRouteCircuitConnectionConfig": "ExpressRoute", - "Get-AzureRmExpressRouteCircuitConnectionConfig": "ExpressRoute", - "New-AzureRmPacketCaptureFilterConfig": "Networking", - "Move-AzureRmExpressRouteCircuit": "ExpressRoute", - "Add-AzureRmApplicationGatewayUrlPathMapConfig": "Application Gateway", - "Add-AzureRmApplicationGatewayHttpListener": "Application Gateway", - "Get-AzureRmApplicationGatewayTrustedRootCertificate": "Application Gateway", - "Remove-AzureRmExpressRouteCircuitAuthorization": "ExpressRoute", - "New-AzureRmLoadBalancer": "Load Balancer", - "Set-AzureRmVirtualNetworkGatewayConnection": "Virtual Network", - "Get-AzureRmVirtualNetworkGatewayConnectionVpnDeviceConfigScript": "Virtual Network", - "Set-AzureRmNetworkInterface": "Networking", - "Get-AzureRmApplicationGatewayRequestRoutingRule": "Application Gateway", - "Get-AzureRmApplicationGatewayAuthenticationCertificate": "Application Gateway", - "Remove-AzureRmApplicationGatewayHttpListenerCustomError": "Application Gateway", - "Remove-AzureRmLoadBalancerOutboundRuleConfig": "Load Balancer", - "New-AzureRmApplicationGatewayProbeHealthResponseMatch": "Application Gateway", - "Add-AzureRmApplicationGatewayCustomError": "Application Gateway", - "Get-AzureRmVirtualWan": "Networking", - "Add-AzureRmLoadBalancerInboundNatRuleConfig": "Load Balancer", - "Resize-AzureRmVirtualNetworkGateway": "Virtual Network", - "Set-AzureRmServiceEndpointPolicyDefinition": "Networking", - "Add-AzureRmLoadBalancerRuleConfig": "Load Balancer", - "Set-AzureRmExpressRouteCircuit": "ExpressRoute", - "Set-AzureRmVirtualNetworkSubnetConfig": "Virtual Network", - "New-AzureRmPublicIpTag": "Networking", - "Add-AzureRmLoadBalancerInboundNatPoolConfig": "Load Balancer", - "Get-AzureRmVirtualNetworkGatewaySupportedVpnDevice": "Virtual Network", - "Set-AzureRmRouteTable": "Route", - "Get-AzureRmExpressRouteCircuitAuthorization": "ExpressRoute", - "Get-AzureRmFirewallFqdnTag": "Networking", - "Remove-AzureRmLoadBalancerInboundNatPoolConfig": "Load Balancer", - "Get-AzureRmLoadBalancerRuleConfig": "Load Balancer", - "Get-AzureRmLoadBalancerBackendAddressPoolConfig": "Load Balancer", - "Add-AzureRmRouteFilterRuleConfig": "Route", - "Add-AzureRmVpnClientRevokedCertificate": "VPN", - "Get-AzureRmAvailableServiceDelegation": "Networking", - "Remove-AzureRmApplicationGatewayFrontendPort": "Application Gateway", - "Set-AzureRmLoadBalancerOutboundRuleConfig": "Load Balancer", - "New-AzureRmLoadBalancerBackendAddressPoolConfig": "Load Balancer", - "New-AzureRmApplicationGatewaySslCertificate": "Application Gateway", - "Add-AzureRmNetworkSecurityRuleConfig": "Networking", - "New-AzureRmDdosProtectionPlan": "Networking", - "Get-AzureRmVpnClientRootCertificate": "VPN", - "Remove-AzureRmExpressRouteCircuitPeeringConfig": "ExpressRoute", - "Get-AzureRmNetworkUsage": "Networking", - "Get-AzureRmApplicationGatewayHttpListenerCustomError": "Application Gateway", - "Remove-AzureRmServiceEndpointPolicy": "Networking", - "Remove-AzureRmVpnClientRootCertificate": "VPN", - "Get-AzureRmNetworkInterfaceIpConfig": "Networking", - "Remove-AzureRmNetworkProfile": "Networking", - "Add-AzureRmApplicationGatewayProbeConfig": "Application Gateway", - "New-AzureRmLoadBalancerProbeConfig": "Load Balancer", - "Get-AzureRmLoadBalancerFrontendIpConfig": "Load Balancer", - "Get-AzureRmExpressRouteServiceProvider": "ExpressRoute", - "New-AzureRmVpnSite": "VPN", - "New-AzureRmVpnClientConfiguration": "VPN", - "Set-AzureRmRouteConfig": "Route", - "Set-AzureRmPublicIpAddress": "Networking", - "Add-AzureRmApplicationGatewayBackendAddressPool": "Application Gateway", - "Update-AzureRmVirtualWan": "Networking", - "Add-AzureRmLoadBalancerProbeConfig": "Load Balancer", - "Get-AzureRmApplicationGatewaySslCertificate": "Application Gateway", - "Get-AzureRmApplicationGateway": "Application Gateway", - "Set-AzureRmNetworkSecurityGroup": "Networking", - "Remove-AzureRmPublicIpAddress": "Networking", - "Get-AzureRmNetworkInterface": "Networking", - "New-AzureRmVpnGateway": "VPN", - "Get-AzureRmBgpServiceCommunity": "Networking", - "Get-AzureRmServiceEndpointPolicy": "Networking", - "Test-AzureRmPrivateIPAddressAvailability": "Networking", - "Get-AzureRmVirtualNetworkGatewayBGPPeerStatus": "Virtual Network", - "New-AzureRmLocalNetworkGateway": "Networking", - "Get-AzureRmFirewall": "Networking", - "Get-AzureRmNetworkWatcherConnectionMonitorReport": "Network Watcher", - "Set-AzureRmApplicationGatewayBackendAddressPool": "Application Gateway", - "Set-AzureRmApplicationGatewayAutoscaleConfiguration": "Application Gateway", - "New-AzureRmVirtualNetworkTap": "Virtual Network", - "Add-AzureRmNetworkInterfaceTapConfig": "Networking", - "Set-AzureRmVirtualNetwork": "Virtual Network", - "Get-AzureRmVirtualNetworkGateway": "Virtual Network", - "New-AzureRmApplicationGatewaySku": "Application Gateway", - "New-AzureRmFirewallNetworkRule": "Networking", - "Remove-AzureRmVpnClientIpsecParameter": "VPN", - "New-AzureRmFirewallApplicationRuleCollection": "Networking", - "Set-AzureRmExpressRoutePort": "ExpressRoute", - "New-AzureRmVpnConnection": "VPN", - "Set-AzureRmApplicationGatewayHttpListenerCustomError": "Application Gateway", - "Add-AzureRmApplicationGatewayIPConfiguration": "Application Gateway", - "New-AzureRmContainerNicConfig": "Networking", - "New-AzureRmNetworkInterface": "Networking", - "Set-AzureRmLoadBalancerInboundNatRuleConfig": "Load Balancer", - "Get-AzureRmVpnClientRevokedCertificate": "VPN", - "New-AzureRmApplicationGatewayConnectionDraining": "Application Gateway", - "Add-AzureRmDelegation": "Networking", - "Remove-AzureRmApplicationGatewayUrlPathMapConfig": "Application Gateway", - "Get-AzureRmApplicationGatewayAvailableSslOptions": "Application Gateway", - "Get-AzureRmNetworkWatcherTopology": "Network Watcher", - "Get-AzureRmLoadBalancerOutboundRuleConfig": "Load Balancer", - "Remove-AzureRmApplicationGateway": "Application Gateway", - "Get-AzureRmExpressRouteCircuitStats": "ExpressRoute", - "Add-AzureRmApplicationGatewayRedirectConfiguration": "Application Gateway", - "Reset-AzureRmVirtualNetworkGatewayConnectionSharedKey": "Virtual Network", - "Update-AzureRmVirtualHub": "Networking", - "Get-AzureRmDdosProtectionPlan": "Networking", - "Get-AzureRmApplicationGatewayBackendAddressPool": "Application Gateway", - "New-AzureRmLoadBalancerOutboundRuleConfig": "Load Balancer", - "New-AzureRmRouteConfig": "Route", - "New-AzureRmPublicIpPrefix": "Networking", - "Remove-AzureRmApplicationGatewayHttpListener": "Application Gateway", - "Remove-AzureRmVpnSite": "VPN", - "Remove-AzureRmExpressRouteCircuit": "ExpressRoute", - "Get-AzureRmNetworkWatcher": "Network Watcher", - "New-AzureRmExpressRouteCircuit": "ExpressRoute", - "Get-AzureRmVirtualNetworkGatewayAdvertisedRoute": "Virtual Network", - "Add-AzureRmVirtualNetworkGatewayIpConfig": "Virtual Network", - "New-AzureRmDelegation": "Networking", - "Get-AzureRmRouteConfig": "Route", - "Get-AzureRmVirtualHub": "Networking", - "Get-AzureRmNetworkWatcherFlowLogStatus": "Network Watcher", - "Add-AzureRmExpressRouteCircuitPeeringConfig": "ExpressRoute", - "Set-AzureRmRouteFilter": "Route", - "Get-AzureRmVirtualNetworkTap": "Virtual Network", - "Set-AzureRmApplicationGatewayRequestRoutingRule": "Application Gateway", - "Get-AzureRmVpnGateway": "VPN", - "Set-AzureRmApplicationGatewayRedirectConfiguration": "Application Gateway", - "New-AzureRmVirtualNetworkSubnetConfig": "Virtual Network", - "Set-AzureRmApplicationGatewayUrlPathMapConfig": "Application Gateway", - "Get-AzureRmApplicationGatewaySslPredefinedPolicy": "Application Gateway", - "Set-AzureRmLoadBalancerFrontendIpConfig": "Load Balancer", - "Remove-AzureRmRouteFilterRuleConfig": "Route", - "Add-AzureRmExpressRouteCircuitConnectionConfig": "ExpressRoute", - "Set-AzureRmApplicationGatewaySslCertificate": "Application Gateway", - "Remove-AzureRmNetworkWatcherConnectionMonitor": "Network Watcher", - "Get-AzureRmExpressRoutePortsLocation": "ExpressRoute", - "Get-AzureRmApplicationSecurityGroup": "Networking", - "New-AzureRmNetworkSecurityRuleConfig": "Networking", - "Set-AzureRmApplicationGatewayAuthenticationCertificate": "Application Gateway", - "New-AzureRmApplicationGatewayPathRuleConfig": "Application Gateway", - "Get-AzureRmRouteFilterRuleConfig": "Route", - "Remove-AzureRmApplicationGatewayCustomError": "Application Gateway", - "Add-AzureRmLoadBalancerBackendAddressPoolConfig": "Load Balancer", - "Get-AzureRmExpressRouteCircuitPeeringConfig": "ExpressRoute", - "Remove-AzureRmVirtualNetworkPeering": "Virtual Network", - "Get-AzureRmVpnClientConfiguration": "VPN", - "Add-AzureRmApplicationGatewayFrontendIPConfig": "Application Gateway", - "New-AzureRmLoadBalancerInboundNatRuleConfig": "Load Balancer", - "Get-AzureRmApplicationGatewayFrontendPort": "Application Gateway", - "New-AzureRmIpsecPolicy": "Networking", - "Remove-AzureRmApplicationGatewayTrustedRootCertificate": "Application Gateway", - "Remove-AzureRmVpnClientRevokedCertificate": "VPN", - "Set-AzureRmVirtualNetworkGatewayVpnClientConfig": "Virtual Network", - "Get-AzureRmLoadBalancer": "Load Balancer", - "New-AzureRmRouteFilter": "Route", - "Remove-AzureRmLoadBalancer": "Load Balancer", - "Get-AzureRmServiceEndpointPolicyDefinition": "Networking", - "Set-AzureRmVirtualNetworkTap": "Virtual Network", - "Set-AzureRmApplicationGatewayFrontendPort": "Application Gateway", - "Update-AzureRmVpnConnection": "VPN", - "Set-AzureRmLoadBalancerProbeConfig": "Load Balancer", - "Stop-AzureRmNetworkWatcherConnectionMonitor": "Network Watcher", - "Remove-AzureRmApplicationSecurityGroup": "Networking", - "New-AzureRmApplicationGatewayTrustedRootCertificate": "Application Gateway", - "Set-AzureRmExpressRouteCircuitPeeringConfig": "ExpressRoute", - "Get-AzureRmApplicationGatewayUrlPathMapConfig": "Application Gateway", - "Get-AzureRmApplicationGatewayBackendHttpSettings": "Application Gateway", - "Get-AzureRmVpnSite": "VPN", - "New-AzureRmApplicationGatewayRequestRoutingRule": "Application Gateway", - "Get-AzureRmVirtualNetworkGatewayConnectionSharedKey": "Virtual Network", - "Set-AzureRmVpnClientIpsecParameter": "VPN", - "Remove-AzureRmRouteConfig": "Route", - "Get-AzureRmNetworkInterfaceTapConfig": "Networking", - "Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration": "Application Gateway", - "New-AzureRmVirtualHubRoute": "Route", - "Set-AzureRmLoadBalancerInboundNatPoolConfig": "Load Balancer", - "New-AzureRmVirtualNetworkGatewayConnection": "Virtual Network", - "Get-AzureRmVirtualNetworkGatewayLearnedRoute": "Virtual Network", - "Get-AzureRmEffectiveNetworkSecurityGroup": "Networking", - "New-AzureRmApplicationGatewayFrontendPort": "Application Gateway", - "New-AzureRmExpressRouteCircuitAuthorization": "ExpressRoute", - "Remove-AzureRmApplicationGatewayFrontendIPConfig": "Application Gateway", - "Remove-AzureRmVirtualNetwork": "Virtual Network", - "Get-AzureRmVpnConnection": "VPN", - "New-AzureRmApplicationGatewayFrontendIPConfig": "Application Gateway", - "Add-AzureRmApplicationGatewayRequestRoutingRule": "Application Gateway", - "New-AzureRmLoadBalancerRuleConfig": "Load Balancer", - "New-AzureRmExpressRouteCircuitPeeringConfig": "ExpressRoute", - "Get-AzureRmExpressRoutePortLinkConfig": "ExpressRoute", - "Update-AzureRmVpnSite": "VPN", - "Test-AzureRmDnsAvailability": "DNS", - "New-AzureRmLoadBalancerInboundNatPoolConfig": "Load Balancer", - "Remove-AzureRmNetworkInterfaceIpConfig": "Networking", - "Remove-AzureRmApplicationGatewayRequestRoutingRule": "Application Gateway", - "Get-AzureRmExpressRouteCircuitRouteTable": "ExpressRoute", - "New-AzureRmNetworkWatcherProtocolConfiguration": "Network Watcher", - "New-AzureRmApplicationGateway": "Application Gateway", - "Remove-AzureRmApplicationGatewayConnectionDraining": "Application Gateway", - "Add-AzureRmVirtualNetworkPeering": "Virtual Network", - "Start-AzureRmNetworkWatcherConnectionMonitor": "Network Watcher", - "New-AzureRmApplicationGatewayUrlPathMapConfig": "Application Gateway", - "Test-AzureRmNetworkWatcherIPFlow": "Network Watcher", - "New-AzureRmVpnClientIpsecParameter": "VPN", - "Set-AzureRmVirtualNetworkGatewayDefaultSite": "Virtual Network", - "Get-AzureRmVirtualHubVnetConnection": "Networking", - "Get-AzureRmExpressRouteCircuitRouteTableSummary": "ExpressRoute", - "Add-AzureRmApplicationGatewayBackendHttpSettings": "Application Gateway", - "Get-AzureRmNetworkWatcherNextHop": "Network Watcher", - "New-AzureRmApplicationGatewayBackendHttpSettings": "Application Gateway", - "Get-AzureRmLoadBalancerInboundNatPoolConfig": "Load Balancer", - "Get-AzureRmApplicationGatewayConnectionDraining": "Application Gateway", - "Set-AzureRmApplicationGatewayBackendHttpSettings": "Application Gateway", - "Get-AzureRmInterfaceEndpoint": "Networking", - "New-AzureRmNetworkSecurityGroup": "Networking", - "Update-AzureRmVpnGateway": "VPN", - "New-AzureRmVirtualNetworkGateway": "Virtual Network", - "Remove-AzureRmRouteTable": "Route", - "Get-AzureRmExpressRoutePort": "ExpressRoute", - "New-AzureRmNetworkWatcherConnectionMonitor": "Network Watcher", - "New-AzureRmVirtualNetworkGatewayIpConfig": "Virtual Network", - "Remove-AzureRmNetworkSecurityGroup": "Networking", - "Stop-AzureRmApplicationGateway": "Application Gateway", - "Get-AzureRmNetworkSecurityGroup": "Networking", - "New-AzureRmApplicationGatewayCustomError": "Application Gateway", - "New-AzureRmVpnClientRootCertificate": "VPN", - "Set-AzureRmApplicationGatewayFrontendIPConfig": "Application Gateway", - "Get-AzureRmApplicationGatewayAvailableWafRuleSets": "Application Gateway", - "Get-AzureRmNetworkWatcherConnectionMonitor": "Network Watcher", - "Remove-AzureRmLoadBalancerRuleConfig": "Load Balancer", - "Get-AzureRmLoadBalancerInboundNatRuleConfig": "Load Balancer", - "Remove-AzureRmApplicationGatewayRedirectConfiguration": "Application Gateway", - "Add-AzureRmNetworkInterfaceIpConfig": "Networking", - "Set-AzureRmApplicationGateway": "Application Gateway", - "New-AzureRmPublicIpAddress": "Networking", - "Get-AzureRmNetworkSecurityRuleConfig": "Networking", - "Add-AzureRmApplicationGatewayTrustedRootCertificate": "Application Gateway", - "Remove-AzureRmVirtualHub": "Networking", - "Get-AzureRmVirtualNetworkSubnetConfig": "Virtual Network", - "New-AzureRmContainerNicConfigIpConfig": "Networking", - "New-AzureRmVirtualNetwork": "Virtual Network", - "Set-AzureRmLocalNetworkGateway": "Networking", - "Get-AzureRmApplicationGatewaySku": "Application Gateway", - "Get-AzureRmNetworkWatcherReachabilityProvidersList": "Network Watcher", - "New-AzureRmVirtualHub": "Networking", - "Get-AzureRmApplicationGatewayFrontendIPConfig": "Application Gateway", - "Set-AzureRmVirtualNetworkGatewayConnectionSharedKey": "Virtual Network", - "Add-AzureRmApplicationGatewayFrontendPort": "Application Gateway", - "New-AzureRmApplicationGatewaySslPolicy": "Application Gateway", - "Add-AzureRmApplicationGatewayAuthenticationCertificate": "Application Gateway", - "Get-AzureRmExpressRouteCircuitARPTable": "ExpressRoute", - "New-AzureRmApplicationGatewayFirewallExclusionConfig": "Application Gateway", - "Get-AzureRmVpnClientPackage": "VPN", - "Remove-AzureRmApplicationGatewaySslPolicy": "Application Gateway", - "Get-AzureRmNetworkProfile": "Networking", - "Get-AzureRmLoadBalancerProbeConfig": "Load Balancer", - "Get-AzureRmApplicationGatewayIPConfiguration": "Application Gateway", - "Add-AzureRmServiceEndpointPolicyDefinition": "Networking", - "New-AzureRmApplicationGatewayIPConfiguration": "Application Gateway", - "Get-AzureRMNetworkWatcherReachabilityReport": "Network Watcher", - "Remove-AzureRmVirtualNetworkGateway": "Virtual Network", - "Set-AzureRmRouteFilterRuleConfig": "Route", - "Set-AzureRmVirtualNetworkPeering": "Virtual Network", - "Set-AzureRmNetworkWatcherConfigFlowLog": "Network Watcher", - "New-AzureRmApplicationGatewayAuthenticationCertificate": "Application Gateway", - "Get-AzureRmDelegation": "Networking", - "New-AzureRmFirewallNetworkRuleCollection": "Networking", - "Set-AzureRmLoadBalancer": "Load Balancer", - "Add-AzureRmLoadBalancerOutboundRuleConfig": "Load Balancer", - "Set-AzureRmNetworkWatcherConnectionMonitor": "Network Watcher", - "Remove-AzureRmVirtualNetworkSubnetConfig": "Virtual Network", - "New-AzureRmFirewall": "Networking", - "New-AzureRmRouteFilterRuleConfig": "Route", - "Remove-AzureRmNetworkSecurityRuleConfig": "Networking", - "Stop-AzureRmNetworkWatcherPacketCapture": "Network Watcher", - "Start-AzureRmApplicationGateway": "Application Gateway", - "Remove-AzureRmLocalNetworkGateway": "Networking", - "Remove-AzureRmNetworkInterface": "Networking", - "Set-AzureRmApplicationGatewayTrustedRootCertificate": "Application Gateway", - "Reset-AzureRmVirtualNetworkGateway": "Virtual Network", - "Set-AzureRmApplicationGatewayHttpListener": "Application Gateway", - "Start-AzureRmNetworkWatcherResourceTroubleshooting": "Network Watcher", - "New-AzureRmNetworkWatcherPacketCapture": "Network Watcher", - "New-AzureRmExpressRoutePort": "ExpressRoute", - "New-AzureRmLoadBalancerFrontendIpConfig": "Load Balancer", - "Remove-AzureRmLoadBalancerProbeConfig": "Load Balancer", - "Add-AzureRmRouteConfig": "Route", - "Remove-AzureRmLoadBalancerFrontendIpConfig": "Load Balancer", - "Remove-AzureRmVirtualNetworkGatewayDefaultSite": "Virtual Network", - "Remove-AzureRmNetworkWatcher": "Network Watcher", - "Remove-AzureRmExpressRoutePort": "ExpressRoute", - "Set-AzureRmLoadBalancerRuleConfig": "Load Balancer", - "Set-AzureRmNetworkProfile": "Networking", - "Start-AzureRmHDInsightJob": "HD Insights", - "Wait-AzureRmHDInsightJob": "HD Insights", - "Submit-AzureRmHDInsightScriptAction": "HD Insights", - "Remove-AzureRmHDInsightCluster": "HD Insights", - "Add-AzureRmHDInsightComponentVersion": "HD Insights", - "New-AzureRmHDInsightClusterConfig": "HD Insights", - "Stop-AzureRmHDInsightJob": "HD Insights", - "Get-AzureRmHDInsightJobOutput": "HD Insights", - "Add-AzureRmHDInsightSecurityProfile": "HD Insights", - "Add-AzureRmHDInsightConfigValues": "HD Insights", - "New-AzureRmHDInsightPigJobDefinition": "HD Insights", - "Set-AzureRmHDInsightPersistedScriptAction": "HD Insights", - "Enable-AzureRmHDInsightOperationsManagementSuite": "HD Insights", - "Set-AzureRmHDInsightClusterSize": "HD Insights", - "Set-AzureRmHDInsightDefaultStorage": "HD Insights", - "Add-AzureRmHDInsightClusterIdentity": "HD Insights", - "Get-AzureRmHDInsightCluster": "HD Insights", - "New-AzureRmHDInsightCluster": "HD Insights", - "Disable-AzureRmHDInsightOperationsManagementSuite": "HD Insights", - "Get-AzureRmHDInsightProperties": "HD Insights", - "Grant-AzureRmHDInsightRdpServicesAccess": "HD Insights", - "Revoke-AzureRmHDInsightHttpServicesAccess": "HD Insights", - "New-AzureRmHDInsightMapReduceJobDefinition": "HD Insights", - "Add-AzureRmHDInsightMetastore": "HD Insights", - "Revoke-AzureRmHDInsightRdpServicesAccess": "HD Insights", - "Use-AzureRmHDInsightCluster": "HD Insights", - "New-AzureRmHDInsightStreamingMapReduceJobDefinition": "HD Insights", - "Get-AzureRmHDInsightScriptActionHistory": "HD Insights", - "New-AzureRmHDInsightSqoopJobDefinition": "HD Insights", - "Add-AzureRmHDInsightScriptAction": "HD Insights", - "Get-AzureRmHDInsightPersistedScriptAction": "HD Insights", - "Remove-AzureRmHDInsightPersistedScriptAction": "HD Insights", - "Add-AzureRmHDInsightStorage": "HD Insights", - "Get-AzureRmHDInsightJob": "HD Insights", - "Grant-AzureRmHDInsightHttpServicesAccess": "HD Insights", - "New-AzureRmHDInsightHiveJobDefinition": "HD Insights", - "Invoke-AzureRmHDInsightHiveJob": "HD Insights", - "Get-AzureRmHDInsightOperationsManagementSuite": "HD Insights", - "Merge-AzureRmReservation": "Reservations", - "Split-AzureRmReservation": "Reservations", - "Get-AzureRmReservationOrderId": "Reservations", - "Get-AzureRmReservationHistory": "Reservations", - "Get-AzureRmReservationCatalog": "Reservations", - "Get-AzureRmReservation": "Reservations", - "Update-AzureRmReservation": "Reservations", - "Get-AzureRmReservationOrder": "Reservations", - "Get-AzureRmIotCentralApp": "IoT", - "Remove-AzureRmIotCentralApp": "IoT", - "New-AzureRmIotCentralApp": "IoT", - "Set-AzureRmIotCentralApp": "IoT", - "New-AzureRmIntegrationAccountSchema": "Logic Apps", - "Set-AzureRmIntegrationAccountMap": "Logic Apps", - "New-AzureRmIntegrationAccountCertificate": "Logic Apps", - "Remove-AzureRmIntegrationAccountMap": "Logic Apps", - "Get-AzureRmLogicAppUpgradedDefinition": "Logic Apps", - "Start-AzureRmLogicApp": "Logic Apps", - "Get-AzureRmIntegrationAccount": "Logic Apps", - "New-AzureRmLogicApp": "Logic Apps", - "Test-AzureRmLogicApp": "Logic Apps", - "Remove-AzureRmIntegrationAccountCertificate": "Logic Apps", - "Get-AzureRmIntegrationAccountCertificate": "Logic Apps", - "Set-AzureRmLogicApp": "Logic Apps", - "Get-AzureRmLogicApp": "Logic Apps", - "Remove-AzureRmLogicApp": "Logic Apps", - "Get-AzureRmIntegrationAccountPartner": "Logic Apps", - "Get-AzureRmIntegrationAccountCallbackUrl": "Logic Apps", - "Set-AzureRmIntegrationAccountSchema": "Logic Apps", - "Get-AzureRmLogicAppTriggerHistory": "Logic Apps", - "Remove-AzureRmIntegrationAccountPartner": "Logic Apps", - "Get-AzureRmIntegrationAccountGeneratedIcn": "Logic Apps", - "Set-AzureRmIntegrationAccountGeneratedIcn": "Logic Apps", - "New-AzureRmIntegrationAccountMap": "Logic Apps", - "Get-AzureRmLogicAppRunHistory": "Logic Apps", - "Get-AzureRmLogicAppRunAction": "Logic Apps", - "Remove-AzureRmIntegrationAccountAgreement": "Logic Apps", - "New-AzureRmIntegrationAccountAgreement": "Logic Apps", - "Remove-AzureRmIntegrationAccountSchema": "Logic Apps", - "Remove-AzureRmIntegrationAccount": "Logic Apps", - "Remove-AzureRmIntegrationAccountReceivedIcn": "Logic Apps", - "Get-AzureRmIntegrationAccountMap": "Logic Apps", - "New-AzureRmIntegrationAccountPartner": "Logic Apps", - "Set-AzureRmIntegrationAccountPartner": "Logic Apps", - "Set-AzureRmIntegrationAccountAgreement": "Logic Apps", - "Stop-AzureRmLogicAppRun": "Logic Apps", - "Set-AzureRmIntegrationAccountCertificate": "Logic Apps", - "Set-AzureRmIntegrationAccountReceivedIcn": "Logic Apps", - "Get-AzureRmIntegrationAccountSchema": "Logic Apps", - "Get-AzureRmIntegrationAccountAgreement": "Logic Apps", - "Get-AzureRmLogicAppTriggerCallbackUrl": "Logic Apps", - "Get-AzureRmLogicAppTrigger": "Logic Apps", - "Set-AzureRmIntegrationAccount": "Logic Apps", - "New-AzureRmIntegrationAccount": "Logic Apps", - "Get-AzureRmIntegrationAccountReceivedIcn": "Logic Apps", - "Resume-AzureRmAnalysisServicesServer": "Analysis Services", - "New-AzureRmAnalysisServicesFirewallRule": "Analysis Services", - "Suspend-AzureRmAnalysisServicesServer": "Analysis Services", - "Set-AzureRmAnalysisServicesServer": "Analysis Services", - "New-AzureRmAnalysisServicesServer": "Analysis Services", - "Test-AzureRmAnalysisServicesServer": "Analysis Services", - "Remove-AzureRmAnalysisServicesServer": "Analysis Services", - "New-AzureRmAnalysisServicesFirewallConfig": "Analysis Services", - "Get-AzureRmAnalysisServicesServer": "Analysis Services", - "Convert-AzureRmSqlDatabaseVulnerabilityAssessmentScan": "SQL", - "Get-AzureRmSqlDatabaseBackupLongTermRetentionPolicy": "SQL", - "Remove-AzureRmSqlServer": "SQL", - "Set-AzureRmSqlServerRecommendedActionState": "SQL", - "Remove-AzureRmSqlSyncAgent": "SQL", - "Stop-AzureRmSqlElasticPoolActivity": "SQL", - "Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate": "SQL", - "Set-AzureRmSqlElasticPoolAdvisorAutoExecuteStatus": "SQL", - "Get-AzureRmSqlDatabaseLongTermRetentionBackup": "SQL", - "Get-AzureRmSqlDatabaseFailoverGroup": "SQL", - "Start-AzureRmSqlDatabaseVulnerabilityAssessmentScan": "SQL", - "Update-AzureRmSqlDatabaseVulnerabilityAssessmentSettings": "SQL", - "Set-AzureRmSqlServerFirewallRule": "SQL", - "Get-AzureRmSqlServerAuditingPolicy": "SQL", - "Remove-AzureRmSqlServerDnsAlias": "SQL", - "Switch-AzureRmSqlDatabaseFailoverGroup": "SQL", - "New-AzureRmSqlDatabase": "SQL", - "Set-AzureRmSqlServer": "SQL", - "Get-AzureRmSqlServerDnsAlias": "SQL", - "Set-AzureRmSqlDatabaseSecondary": "SQL", - "New-AzureRmSqlDatabaseCopy": "SQL", - "Get-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline": "SQL", - "Remove-AzureRmSqlDatabaseSecondary": "SQL", - "Get-AzureRmSqlElasticPoolDatabase": "SQL", - "Remove-AzureRmSqlServerVirtualNetworkRule": "SQL", - "Set-AzureRmSqlDatabase": "SQL", - "Set-AzureRmSqlDatabaseAuditingPolicy": "SQL", - "Set-AzureRmSqlDatabaseThreatDetectionPolicy": "SQL", - "Set-AzureRmSqlInstance": "SQL", - "Get-AzureRmSqlServer": "SQL", - "Get-AzureRmSqlDatabaseTransparentDataEncryption": "SQL", - "Get-AzureRmSqlSyncGroupLog": "SQL", - "Get-AzureRmSqlElasticPoolAdvisor": "SQL", - "Disable-AzureRmSqlServerAdvancedThreatProtection": "SQL", - "Remove-AzureRmSqlServerKeyVaultKey": "SQL", - "Set-AzureRmSqlDatabaseFailoverGroup": "SQL", - "Set-AzureRmSqlServerBackupLongTermRetentionVault": "SQL", - "Get-AzureRmSqlServerRecommendedAction": "SQL", - "New-AzureRmSqlDatabaseRestorePoint": "SQL", - "Get-AzureRmSqlSyncGroup": "SQL", - "Get-AzureRmSqlServerAdvancedThreatProtectionPolicy": "SQL", - "Get-AzureRmSqlDatabaseUpgradeHint": "SQL", - "Remove-AzureRmSqlInstance": "SQL", - "Clear-AzureRmSqlDatabaseVulnerabilityAssessmentSettings": "SQL", - "Get-AzureRmSqlDatabaseGeoBackupPolicy": "SQL", - "Set-AzureRmSqlServerDisasterRecoveryConfiguration": "SQL", - "Get-AzureRmSqlServerBackupLongTermRetentionVault": "SQL", - "Get-AzureRmSqlServerCommunicationLink": "SQL", - "Set-AzureRmSqlServerTransparentDataEncryptionProtector": "SQL", - "Set-AzureRmSqlDatabaseDataMaskingPolicy": "SQL", - "Get-AzureRmSqlServerServiceObjective": "SQL", - "Set-AzureRmSqlServerAdvisorAutoExecuteStatus": "SQL", - "Remove-AzureRmSqlDatabaseFromFailoverGroup": "SQL", - "Remove-AzureRmSqlSyncGroup": "SQL", - "Stop-AzureRmSqlDatabaseActivity": "SQL", - "Get-AzureRmSqlElasticPoolRecommendedAction": "SQL", - "Get-AzureRmSqlInstance": "SQL", - "Get-AzureRmSqlDatabaseIndexRecommendations": "SQL", - "New-AzureRmSqlServer": "SQL", - "New-AzureRmSqlSyncAgentKey": "SQL", - "Set-AzureRmSqlServerDnsAlias": "SQL", - "New-AzureRmSqlDatabaseFailoverGroup": "SQL", - "Remove-AzureRmSqlDatabase": "SQL", - "Remove-AzureRmSqlInstanceDatabase": "SQL", - "Get-AzureRmSqlElasticPoolActivity": "SQL", - "Remove-AzureRmSqlDatabaseLongTermRetentionBackup": "SQL", - "Set-AzureRmSqlDatabaseRecommendedActionState": "SQL", - "Set-AzureRmSqlServerAuditingPolicy": "SQL", - "Use-AzureRmSqlServerAuditingPolicy": "SQL", - "Get-AzureRmSqlDatabaseRecommendedAction": "SQL", - "Remove-AzureRmSqlServerDisasterRecoveryConfiguration": "SQL", - "Remove-AzureRmSqlDatabaseDataMaskingRule": "SQL", - "Add-AzureRmSqlServerKeyVaultKey": "SQL", - "Get-AzureRmSqlDatabaseReplicationLink": "SQL", - "New-AzureRmSqlSyncGroup": "SQL", - "Get-AzureRmSqlDatabaseRestorePoints": "SQL", - "Set-AzureRmSqlElasticPoolRecommendedActionState": "SQL", - "Remove-AzureRmSqlServerAuditing": "SQL", - "New-AzureRmSqlDatabaseImport": "SQL", - "Get-AzureRmSqlServerUpgradeHint": "SQL", - "New-AzureRmSqlServerDisasterRecoveryConfiguration": "SQL", - "Get-AzureRmSqlDatabaseSecureConnectionPolicy": "SQL", - "Get-AzureRmSqlDatabaseAdvisor": "SQL", - "Stop-AzureRmSqlServerUpgrade": "SQL", - "New-AzureRmSqlInstance": "SQL", - "New-AzureRmSqlServerFirewallRule": "SQL", - "Set-AzureRmSqlServerThreatDetectionPolicy": "SQL", - "Get-AzureRmSqlServerDisasterRecoveryConfigurationActivity": "SQL", - "Get-AzureRmSqlElasticPoolRecommendation": "SQL", - "Get-AzureRmSqlSyncMember": "SQL", - "Get-AzureRmSqlDatabaseActivity": "SQL", - "Set-AzureRmSqlServerAuditing": "SQL", - "Remove-AzureRmSqlElasticPool": "SQL", - "Remove-AzureRmSqlServerThreatDetectionPolicy": "SQL", - "Resume-AzureRmSqlDatabase": "SQL", - "Set-AzureRmSqlDatabaseGeoBackupPolicy": "SQL", - "Get-AzureRmSqlDatabaseDataMaskingRule": "SQL", - "New-AzureRmSqlServerDnsAlias": "SQL", - "Update-AzureRmSqlSyncGroup": "SQL", - "Set-AzureRmSqlDatabaseDataMaskingRule": "SQL", - "Remove-AzureRmSqlDatabaseThreatDetectionPolicy": "SQL", - "Stop-AzureRmSqlDatabaseExecuteIndexRecommendation": "SQL", - "New-AzureRmSqlServerCommunicationLink": "SQL", - "Get-AzureRmSqlServerActiveDirectoryAdministrator": "SQL", - "Get-AzureRmSqlDatabase": "SQL", - "Get-AzureRmSqlServerTransparentDataEncryptionProtector": "SQL", - "Remove-AzureRmSqlSyncMember": "SQL", - "Get-AzureRmSqlSyncAgent": "SQL", - "Get-AzureRmSqlDatabaseThreatDetectionPolicy": "SQL", - "New-AzureRmSqlServerVirtualNetworkRule": "SQL", - "Set-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline": "SQL", - "Get-AzureRmSqlSyncSchema": "SQL", - "New-AzureRmSqlSyncAgent": "SQL", - "Set-AzureRmSqlDatabaseAdvisorAutoExecuteStatus": "SQL", - "Start-AzureRmSqlDatabaseExecuteIndexRecommendation": "SQL", - "Get-AzureRmSqlServerFirewallRule": "SQL", - "Restore-AzureRmSqlDatabase": "SQL", - "Enable-AzureRmSqlServerAdvancedThreatProtection": "SQL", - "Get-AzureRmSqlInstanceDatabase": "SQL", - "Get-AzureRmSqlDatabaseDataMaskingPolicy": "SQL", - "New-AzureRmSqlSyncMember": "SQL", - "Update-AzureRmSqlSyncSchema": "SQL", - "Get-AzureRmSqlServerVirtualNetworkRule": "SQL", - "Get-AzureRmSqlDatabaseAuditingPolicy": "SQL", - "Get-AzureRmSqlDatabaseImportExportStatus": "SQL", - "Get-AzureRmSqlServerDisasterRecoveryConfiguration": "SQL", - "Get-AzureRMSqlDatabaseGeoBackup": "SQL", - "Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy": "SQL", - "Set-AzureRmSqlDatabaseAuditing": "SQL", - "New-AzureRmSqlDatabaseDataMaskingRule": "SQL", - "Clear-AzureRmSqlDatabaseVulnerabilityAssessmentRuleBaseline": "SQL", - "Set-AzureRmSqlDatabaseTransparentDataEncryption": "SQL", - "Get-AzureRmSqlServerKeyVaultKey": "SQL", - "Set-AzureRmSqlElasticPool": "SQL", - "Get-AzureRmSqlSyncAgentLinkedDatabase": "SQL", - "Set-AzureRmSqlServerActiveDirectoryAdministrator": "SQL", - "Remove-AzureRmSqlServerCommunicationLink": "SQL", - "Remove-AzureRmSqlDatabaseAuditing": "SQL", - "Get-AzureRmSqlDatabaseVulnerabilityAssessmentSettings": "SQL", - "Get-AzureRmSqlDatabaseExpanded": "SQL", - "Get-AzureRmSqlCapability": "SQL", - "Set-AzureRmSqlServerVirtualNetworkRule": "SQL", - "Get-AzureRmSqlServerUpgrade": "SQL", - "Get-AzureRmSqlServerAuditing": "SQL", - "Start-AzureRmSqlSyncGroupSync": "SQL", - "New-AzureRmSqlElasticPool": "SQL", - "Get-AzureRmSqlServerAdvisor": "SQL", - "Remove-AzureRmSqlServerActiveDirectoryAdministrator": "SQL", - "Get-AzureRmSqlServerThreatDetectionPolicy": "SQL", - "Update-AzureRmSqlSyncMember": "SQL", - "Add-AzureRmSqlServerTransparentDataEncryptionCertificate": "SQL", - "Get-AzureRMSqlDeletedDatabaseBackup": "SQL", - "Add-AzureRmSqlDatabaseToFailoverGroup": "SQL", - "Remove-AzureRmSqlDatabaseFailoverGroup": "SQL", - "Get-AzureRmSqlElasticPool": "SQL", - "Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity": "SQL", - "Remove-AzureRmSqlDatabaseRestorePoint": "SQL", - "Get-AzureRmSqlDatabaseVulnerabilityAssessmentScanRecord": "SQL", - "New-AzureRmSqlInstanceDatabase": "SQL", - "New-AzureRmSqlDatabaseSecondary": "SQL", - "Remove-AzureRmSqlServerFirewallRule": "SQL", - "Start-AzureRmSqlServerUpgrade": "SQL", - "Get-AzureRmSqlDatabaseAuditing": "SQL", - "Suspend-AzureRmSqlDatabase": "SQL", - "Stop-AzureRmSqlSyncGroupSync": "SQL", - "New-AzureRmSqlDatabaseExport": "SQL", - "Restore-AzureRmSqlInstanceDatabase": "SQL", - "Get-AzureRmRecoveryServicesBackupSchedulePolicyObject": "Recovery Services", - "Get-AzureRmRecoveryServicesBackupJob": "Recovery Services", - "Get-AzureRmRecoveryServicesBackupManagementServer": "Recovery Services", - "Get-AzureRmRecoveryServicesBackupProtectionPolicy": "Recovery Services", - "Get-AzureRmRecoveryServicesBackupJobDetails": "Recovery Services", - "Get-AzureRmRecoveryServicesBackupContainer": "Recovery Services", - "New-AzureRmRecoveryServicesBackupProtectionPolicy": "Recovery Services", - "Disable-AzureRmRecoveryServicesBackupProtection": "Recovery Services", - "Unregister-AzureRmRecoveryServicesBackupContainer": "Recovery Services", - "Get-AzureRmRecoveryServicesBackupRecoveryPoint": "Recovery Services", - "Unregister-AzureRmRecoveryServicesBackupManagementServer": "Recovery Services", - "Disable-AzureRmRecoveryServicesBackupRPMountScript": "Recovery Services", - "Get-AzureRmRecoveryServicesBackupItem": "Recovery Services", - "Restore-AzureRmRecoveryServicesBackupItem": "Recovery Services", - "Stop-AzureRmRecoveryServicesBackupJob": "Recovery Services", - "Enable-AzureRmRecoveryServicesBackupProtection": "Recovery Services", - "Get-AzureRmRecoveryServicesBackupStatus": "Recovery Services", - "Backup-AzureRmRecoveryServicesBackupItem": "Recovery Services", - "Get-AzureRmRecoveryServicesBackupRPMountScript": "Recovery Services", - "Wait-AzureRmRecoveryServicesBackupJob": "Recovery Services", - "Get-AzureRmRecoveryServicesBackupRetentionPolicyObject": "Recovery Services", - "Set-AzureRmRecoveryServicesBackupProtectionPolicy": "Recovery Services", - "Remove-AzureRmRecoveryServicesBackupProtectionPolicy": "Recovery Services", - "Remove-AzureRmFrontDoorContent": "Front Door", - "Get-AzureRmFrontDoor": "Front Door", - "Set-AzureRmFrontDoor": "Front Door", - "New-AzureRmFrontDoorBackendPoolObject": "Front Door", - "New-AzureRmFrontDoorHealthProbeSettingObject": "Front Door", - "Get-AzureRmFrontDoorFireWallPolicy": "Front Door", - "New-AzureRmFrontDoorFireWallPolicy": "Front Door", - "Set-AzureRmFrontDoorFireWallPolicy": "Front Door", - "New-AzureRmFrontDoorManagedRuleObject": "Front Door", - "New-AzureRmFrontDoorFrontendEndpointObject": "Front Door", - "New-AzureRmFrontDoorBackendObject": "Front Door", - "New-AzureRmFrontDoorMatchConditionObject": "Front Door", - "New-AzureRmFrontDoorLoadBalancingSettingObject": "Front Door", - "Remove-AzureRmFrontDoorFireWallPolicy": "Front Door", - "New-AzureRmFrontDoorRuleGroupOverrideObject": "Front Door", - "New-AzureRmFrontDoorCustomRuleObject": "Front Door", - "Remove-AzureRmFrontDoor": "Front Door", - "New-AzureRmFrontDoorRoutingRuleObject": "Front Door", - "New-AzureRmFrontDoor": "Front Door", - "New-AzureRmSignalRKey": "SignalR", - "Get-AzureRmSignalRKey": "SignalR", - "New-AzureRmSignalR": "SignalR", - "Remove-AzureRmSignalR": "SignalR", - "Get-AzureRmSignalR": "SignalR", - "Remove-AzureRmAppServicePlan": "App Service", - "Get-AzureRmWebAppSlotPublishingProfile": "App Service", - "Restore-AzureRmDeletedWebApp": "App Service", - "Get-AzureRmWebAppPublishingProfile": "App Service", - "Set-AzureRmWebApp": "App Service", - "Restore-AzureRmWebAppSnapshot": "App Service", - "Set-AzureRmWebAppSlot": "App Service", - "New-AzureRmWebAppDatabaseBackupSetting": "App Service", - "Restart-AzureRmWebAppSlot": "App Service", - "Start-AzureRmWebApp": "App Service", - "Get-AzureRmWebAppBackupConfiguration": "App Service", - "Reset-AzureRmWebAppPublishingProfile": "App Service", - "Get-AzureRmWebAppSSLBinding": "App Service", - "Remove-AzureRmWebAppBackup": "App Service", - "Get-AzureRmWebAppCertificate": "App Service", - "Get-AzureRmWebAppSnapshot": "App Service", - "Enter-AzureRmWebAppContainerPSSession": "App Service", - "Restore-AzureRmWebAppBackup": "App Service", - "Get-AzureRmWebAppContainerContinuousDeploymentUrl": "App Service", - "Get-AzureRmAppServicePlanMetrics": "App Service", - "Get-AzureRmWebAppSlotConfigName": "App Service", - "Get-AzureRmAppServicePlan": "App Service", - "Edit-AzureRmWebAppBackupConfiguration": "App Service", - "Get-AzureRmWebAppMetrics": "App Service", - "New-AzureRmWebAppContainerPSSession": "App Service", - "Switch-AzureRmWebAppSlot": "App Service", - "Remove-AzureRmWebApp": "App Service", - "Stop-AzureRmWebAppSlot": "App Service", - "Remove-AzureRmWebAppSlot": "App Service", - "New-AzureRmWebAppSSLBinding": "App Service", - "New-AzureRmWebApp": "App Service", - "Start-AzureRmWebAppSlot": "App Service", - "Set-AzureRmAppServicePlan": "App Service", - "Restart-AzureRmWebApp": "App Service", - "Get-AzureRmWebAppBackupList": "App Service", - "Get-AzureRmDeletedWebApp": "App Service", - "Set-AzureRmWebAppSlotConfigName": "App Service", - "New-AzureRmAppServicePlan": "App Service", - "Get-AzureRmWebApp": "App Service", - "Get-AzureRmWebAppBackup": "App Service", - "New-AzureRmWebAppBackup": "App Service", - "Get-AzureRmWebAppSlotMetrics": "App Service", - "Get-AzureRmWebAppSlot": "App Service", - "Stop-AzureRmWebApp": "App Service", - "Remove-AzureRmWebAppSSLBinding": "App Service", - "Reset-AzureRmWebAppSlotPublishingProfile": "App Service", - "New-AzureRmWebAppSlot": "App Service", - "Set-AzureRmIotHubRoute": "IoT", - "Add-AzureRmIotHubRoute": "IoT", - "Get-AzureRmIotHubConnectionString": "IoT", - "Get-AzureRmIotHubRoute": "IoT", - "Remove-AzureRmIotHubCertificate": "IoT", - "Test-AzureRmIotHubRoute": "IoT", - "Get-AzureRmIotHub": "IoT", - "New-AzureRmIotHub": "IoT", - "Add-AzureRmIotHubEventHubConsumerGroup": "IoT", - "Get-AzureRmIotHubRoutingEndpoint": "IoT", - "Get-AzureRmIotHubCertificate": "IoT", - "New-AzureRmIotHubExportDevices": "IoT", - "Set-AzureRmIotHub": "IoT", - "Add-AzureRmIotHubKey": "IoT", - "Get-AzureRmIotHubQuotaMetric": "IoT", - "Add-AzureRmIotHubCertificate": "IoT", - "Get-AzureRmIotHubRegistryStatistic": "IoT", - "New-AzureRmIotHubImportDevices": "IoT", - "Remove-AzureRmIotHubRoutingEndpoint": "IoT", - "Get-AzureRmIotHubEventHubConsumerGroup": "IoT", - "Set-AzureRmIotHubVerifiedCertificate": "IoT", - "Get-AzureRmIotHubKey": "IoT", - "Remove-AzureRmIotHub": "IoT", - "Remove-AzureRmIotHubRoute": "IoT", - "Get-AzureRmIotHubValidSku": "IoT", - "Update-AzureRmIotHub": "IoT", - "Remove-AzureRmIotHubKey": "IoT", - "Add-AzureRmIotHubRoutingEndpoint": "IoT", - "Remove-AzureRmIotHubEventHubConsumerGroup": "IoT", - "Get-AzureRmIotHubCertificateVerificationCode": "IoT", - "Get-AzureRmIotHubJob": "IoT", - "Get-AzureRmStorageUsage": "Storage", - "Set-AzureRmCurrentStorageAccount": "Storage", - "Remove-AzureRmStorageAccountNetworkRule": "Storage", - "Update-AzureRmStorageAccountNetworkRuleSet": "Storage", - "Remove-AzureRmStorageContainerLegalHold": "Storage", - "Get-AzureRmStorageAccountKey": "Storage", - "Set-AzureRmStorageContainerImmutabilityPolicy": "Storage", - "Add-AzureRmStorageContainerLegalHold": "Storage", - "Set-AzureRmStorageAccount": "Storage", - "Get-AzureRmStorageAccount": "Storage", - "Get-AzureRmStorageAccountNameAvailability": "Storage", - "New-AzureRmStorageContainer": "Storage", - "Update-AzureRmStorageContainer": "Storage", - "Get-AzureRmStorageAccountNetworkRuleSet": "Storage", - "New-AzureRmStorageAccountKey": "Storage", - "Get-AzureRmStorageContainerImmutabilityPolicy": "Storage", - "Get-AzureRmStorageContainer": "Storage", - "New-AzureRmStorageAccount": "Storage", - "Add-AzureRmStorageAccountNetworkRule": "Storage", - "Remove-AzureRmStorageAccount": "Storage", - "Remove-AzureRmStorageContainerImmutabilityPolicy": "Storage", - "Lock-AzureRmStorageContainerImmutabilityPolicy": "Storage", - "Remove-AzureRmStorageContainer": "Storage", - "Get-AzureRmEventGridTopicKey": "Event Grid", - "New-AzureRmEventGridSubscription": "Event Grid", - "Get-AzureRmEventGridTopic": "Event Grid", - "New-AzureRmEventGridTopicKey": "Event Grid", - "Remove-AzureRmEventGridTopic": "Event Grid", - "Remove-AzureRmEventGridSubscription": "Event Grid", - "Get-AzureRmEventGridTopicType": "Event Grid", - "Update-AzureRmEventGridSubscription": "Event Grid", - "Get-AzureRmEventGridSubscription": "Event Grid", - "New-AzureRmEventGridTopic": "Event Grid", - "Set-AzureRmEventGridTopic": "Event Grid", - "Remove-AzureStorageCORSRule": "Storage", - "New-AzureStorageShare": "Storage", - "Update-AzureStorageServiceProperty": "Storage", - "Remove-AzureStorageFile": "Storage", - "Get-AzureStorageServiceLoggingProperty": "Storage", - "Get-AzureStorageQueueStoredAccessPolicy": "Storage", - "New-AzureStorageTableSASToken": "Storage", - "Remove-AzureStorageContainer": "Storage", - "New-AzureStorageBlobSASToken": "Storage", - "New-AzureStorageShareSASToken": "Storage", - "Start-AzureStorageBlobCopy": "Storage", - "Get-AzureStorageBlobCopyState": "Storage", - "Start-AzureStorageBlobIncrementalCopy": "Storage", - "Disable-AzureStorageDeleteRetentionPolicy": "Storage", - "Stop-AzureStorageFileCopy": "Storage", - "Set-AzureStorageShareStoredAccessPolicy": "Storage", - "Enable-AzureStorageDeleteRetentionPolicy": "Storage", - "New-AzureStorageContainerStoredAccessPolicy": "Storage", - "Set-AzureStorageContainerAcl": "Storage", - "New-AzureStorageDirectory": "Storage", - "Get-AzureStorageServiceMetricsProperty": "Storage", - "Get-AzureStorageTableStoredAccessPolicy": "Storage", - "Set-AzureStorageCORSRule": "Storage", - "Get-AzureStorageBlob": "Storage", - "Get-AzureStorageFileContent": "Storage", - "Start-AzureStorageFileCopy": "Storage", - "Get-AzureStorageFile": "Storage", - "Get-AzureStorageContainerStoredAccessPolicy": "Storage", - "Get-AzureStorageShareStoredAccessPolicy": "Storage", - "Get-AzureStorageTable": "Storage", - "New-AzureStorageShareStoredAccessPolicy": "Storage", - "New-AzureStorageContainer": "Storage", - "New-AzureStorageQueueStoredAccessPolicy": "Storage", - "Remove-AzureStorageDirectory": "Storage", - "Get-AzureStorageBlobContent": "Storage", - "Get-AzureStorageServiceProperty": "Storage", - "Get-AzureStorageCORSRule": "Storage", - "Set-AzureStorageFileContent": "Storage", - "Get-AzureStorageContainer": "Storage", - "New-AzureStorageContainerSASToken": "Storage", - "New-AzureStorageContext": "Storage", - "New-AzureStorageFileSASToken": "Storage", - "Get-AzureStorageShare": "Storage", - "Get-AzureStorageFileCopyState": "Storage", - "Remove-AzureStorageBlob": "Storage", - "New-AzureStorageTable": "Storage", - "New-AzureStorageTableStoredAccessPolicy": "Storage", - "Remove-AzureStorageShareStoredAccessPolicy": "Storage", - "Stop-AzureStorageBlobCopy": "Storage", - "New-AzureStorageQueue": "Storage", - "New-AzureStorageQueueSASToken": "Storage", - "Remove-AzureStorageTable": "Storage", - "Get-AzureStorageQueue": "Storage", - "Remove-AzureStorageContainerStoredAccessPolicy": "Storage", - "Set-AzureStorageTableStoredAccessPolicy": "Storage", - "Remove-AzureStorageShare": "Storage", - "Remove-AzureStorageQueue": "Storage", - "New-AzureStorageAccountSASToken": "Storage", - "Remove-AzureStorageTableStoredAccessPolicy": "Storage", - "Set-AzureStorageServiceMetricsProperty": "Storage", - "Set-AzureStorageShareQuota": "Storage", - "Set-AzureStorageContainerStoredAccessPolicy": "Storage", - "Set-AzureStorageBlobContent": "Storage", - "Set-AzureStorageServiceLoggingProperty": "Storage", - "Remove-AzureStorageQueueStoredAccessPolicy": "Storage", - "Set-AzureStorageQueueStoredAccessPolicy": "Storage", - "Set-AzureRmSecurityWorkspaceSetting": "Security", - "Get-AzureRmJitNetworkAccessPolicy": "Security", - "Get-AzureRmDiscoveredSecuritySolution": "Security", - "Set-AzureRmSecurityAlert": "Security", - "Get-AzureRmSecurityLocation": "Security", - "Get-AzureRmSecurityWorkspaceSetting": "Security", - "Remove-AzureRmJitNetworkAccessPolicy": "Security", - "Set-AzureRmJitNetworkAccessPolicy": "Security", - "Get-AzureRmSecurityPricing": "Security", - "Remove-AzureRmSecurityWorkspaceSetting": "Security", - "Get-AzureRmSecurityTask": "Security", - "Start-AzureRmJitNetworkAccessPolicy": "Security", - "Get-AzureRmSecurityContact": "Security", - "Set-AzureRmSecurityPricing": "Security", - "Get-AzureRmSecurityAlert": "Security", - "Set-AzureRmSecurityAutoProvisioningSetting": "Security", - "Get-AzureRmSecurityAutoProvisioningSetting": "Security", - "Get-AzureRmSecurityCompliance": "Security", - "Remove-AzureRmSecurityContact": "Security", - "Set-AzureRmSecurityContact": "Security", - "Get-AzureRmExternalSecuritySolution": "Security", - "New-AzureRmMapsAccount": "Maps", - "Get-AzureRmMapsAccountKey": "Maps", - "New-AzureRmMapsAccountKey": "Maps", - "Remove-AzureRmMapsAccount": "Maps", - "Get-AzureRmMapsAccount": "Maps", - "Remove-AzureRmDataFactory": "Data Factories", - "New-AzureRmDataFactoryEncryptValue": "Data Factories", - "Resume-AzureRmDataFactoryPipeline": "Data Factories", - "Remove-AzureRmDataFactoryGateway": "Data Factories", - "Remove-AzureRmDataFactoryHub": "Data Factories", - "New-AzureRmDataFactoryLinkedService": "Data Factories", - "New-AzureRmDataFactoryDataset": "Data Factories", - "New-AzureRmDataFactoryPipeline": "Data Factories", - "Get-AzureRmDataFactorySlice": "Data Factories", - "Remove-AzureRmDataFactoryPipeline": "Data Factories", - "Set-AzureRmDataFactoryGateway": "Data Factories", - "Set-AzureRmDataFactoryPipelineActivePeriod": "Data Factories", - "New-AzureRmDataFactory": "Data Factories", - "Get-AzureRmDataFactoryDataset": "Data Factories", - "Remove-AzureRmDataFactoryLinkedService": "Data Factories", - "New-AzureRmDataFactoryHub": "Data Factories", - "Set-AzureRmDataFactorySliceStatus": "Data Factories", - "Get-AzureRmDataFactoryGateway": "Data Factories", - "Get-AzureRmDataFactoryLinkedService": "Data Factories", - "Get-AzureRmDataFactory": "Data Factories", - "New-AzureRmDataFactoryGateway": "Data Factories", - "Remove-AzureRmDataFactoryDataset": "Data Factories", - "Get-AzureRmDataFactoryHub": "Data Factories", - "Save-AzureRmDataFactoryLog": "Data Factories", - "Get-AzureRmDataFactoryRun": "Data Factories", - "New-AzureRmDataFactoryGatewayKey": "Data Factories", - "Get-AzureRmDataFactoryActivityWindow": "Data Factories", - "Get-AzureRmDataFactoryGatewayAuthKey": "Data Factories", - "Suspend-AzureRmDataFactoryPipeline": "Data Factories", - "New-AzureRmDataFactoryGatewayAuthKey": "Data Factories", - "Get-AzureRmDataFactoryPipeline": "Data Factories", - "Get-AzureRmMlCommitmentPlanUsageHistory": "Machine Learning", - "Remove-AzureRmMlWebService": "Machine Learning", - "New-AzureRmMlWebService": "Machine Learning", - "Get-AzureRmMlCommitmentAssociation": "Machine Learning", - "Get-AzureRmMlWebService": "Machine Learning", - "Get-AzureRmMlCommitmentPlan": "Machine Learning", - "Update-AzureRmMlWebService": "Machine Learning", - "New-AzureRmMlCommitmentPlan": "Machine Learning", - "Update-AzureRmMlCommitmentPlan": "Machine Learning", - "Export-AzureRmMlWebService": "Machine Learning", - "Remove-AzureRmMlCommitmentPlan": "Machine Learning", - "Import-AzureRmMlWebService": "Machine Learning", - "Get-AzureRmMlWebServiceKeys": "Machine Learning", - "Add-AzureRmMlWebServiceRegionalProperty": "Machine Learning", - "Move-AzureRmMlCommitmentAssociation": "Machine Learning", - "Enable-AzureBatchComputeNodeScheduling": "Batch", - "New-AzureBatchPool": "Batch", - "Remove-AzureRmBatchApplication": "Batch", - "Get-AzureBatchTaskCounts": "Batch", - "Get-AzureBatchSubtask": "Batch", - "Get-AzureBatchNodeFile": "Batch", - "New-AzureRmBatchApplicationPackage": "Batch", - "Stop-AzureBatchJob": "Batch", - "Stop-AzureBatchTask": "Batch", - "Set-AzureBatchJobSchedule": "Batch", - "Enable-AzureBatchJobSchedule": "Batch", - "Get-AzureBatchNodeFileContent": "Batch", - "Reset-AzureBatchComputeNode": "Batch", - "Disable-AzureBatchAutoScale": "Batch", - "Remove-AzureRmBatchApplicationPackage": "Batch", - "Enable-AzureBatchAutoScale": "Batch", - "Get-AzureBatchPoolStatistics": "Batch", - "Set-AzureBatchJob": "Batch", - "Set-AzureBatchPoolOSVersion": "Batch", - "Get-AzureBatchJob": "Batch", - "Get-AzureRmBatchApplicationPackage": "Batch", - "Remove-AzureBatchCertificate": "Batch", - "Get-AzureBatchComputeNode": "Batch", - "Remove-AzureBatchJob": "Batch", - "Set-AzureBatchPool": "Batch", - "Start-AzureBatchPoolResize": "Batch", - "Get-AzureBatchCertificate": "Batch", - "Start-AzureBatchComputeNodeServiceLogUpload": "Batch", - "Set-AzureRmBatchAccount": "Batch", - "Restart-AzureBatchComputeNode": "Batch", - "Get-AzureRmBatchAccountKeys": "Batch", - "Enable-AzureBatchTask": "Batch", - "Set-AzureBatchComputeNodeUser": "Batch", - "Remove-AzureBatchPool": "Batch", - "New-AzureBatchCertificate": "Batch", - "Get-AzureRmBatchApplication": "Batch", - "Disable-AzureBatchJob": "Batch", - "Remove-AzureBatchComputeNode": "Batch", - "New-AzureBatchTask": "Batch", - "Get-AzureRmBatchAccount": "Batch", - "New-AzureRmBatchApplication": "Batch", - "Get-AzureBatchJobStatistics": "Batch", - "Remove-AzureBatchJobSchedule": "Batch", - "Stop-AzureBatchJobSchedule": "Batch", - "Get-AzureBatchJobPreparationAndReleaseTaskStatus": "Batch", - "Get-AzureBatchTask": "Batch", - "Get-AzureBatchPool": "Batch", - "Test-AzureBatchAutoScale": "Batch", - "Get-AzureBatchPoolNodeCounts": "Batch", - "Set-AzureRmBatchApplication": "Batch", - "Remove-AzureBatchComputeNodeUser": "Batch", - "Remove-AzureBatchNodeFile": "Batch", - "Stop-AzureBatchPoolResize": "Batch", - "Get-AzureBatchRemoteDesktopProtocolFile": "Batch", - "New-AzureRmBatchAccount": "Batch", - "New-AzureBatchComputeNodeUser": "Batch", - "Enable-AzureBatchJob": "Batch", - "Get-AzureBatchPoolUsageMetrics": "Batch", - "Remove-AzureBatchTask": "Batch", - "Stop-AzureBatchCertificateDeletion": "Batch", - "Get-AzureBatchJobSchedule": "Batch", - "Disable-AzureBatchJobSchedule": "Batch", - "Get-AzureRmBatchLocationQuotas": "Batch", - "Get-AzureBatchNodeAgentSku": "Batch", - "New-AzureBatchJobSchedule": "Batch", - "Remove-AzureRmBatchAccount": "Batch", - "Set-AzureBatchTask": "Batch", - "New-AzureRmBatchAccountKey": "Batch", - "New-AzureBatchJob": "Batch", - "Get-AzureBatchRemoteLoginSettings": "Batch", - "Disable-AzureBatchComputeNodeScheduling": "Batch", - "Get-AzureRmPowerBIEmbeddedCapacity": "Power BI Embedded Capacity", - "Resume-AzureRmPowerBIEmbeddedCapacity": "Power BI Embedded Capacity", - "Reset-AzureRmPowerBIWorkspaceCollectionAccessKeys": "Power BI Workspace Collections", - "Get-AzureRmPowerBIWorkspaceCollectionAccessKeys": "Power BI Workspace Collections", - "Get-AzureRmPowerBIWorkspace": "Power BI Workspace Collections", - "Update-AzureRmPowerBIEmbeddedCapacity": "Power BI Embedded Capacity", - "Remove-AzureRmPowerBIEmbeddedCapacity": "Power BI Embedded Capacity", - "New-AzureRmPowerBIEmbeddedCapacity": "Power BI Embedded Capacity", - "New-AzureRmPowerBIWorkspaceCollection": "Power BI Workspace Collections", - "Get-AzureRmPowerBIWorkspaceCollection": "Power BI Workspace Collections", - "Test-AzureRmPowerBIEmbeddedCapacity": "Power BI Embedded Capacity", - "Remove-AzureRmPowerBIWorkspaceCollection": "Power BI Workspace Collections", - "Suspend-AzureRmPowerBIEmbeddedCapacity": "Power BI Embedded Capacity", - "Get-AzureRmContainerGroup": "Container Instances", - "Remove-AzureRmContainerGroup": "Container Instances", - "New-AzureRmContainerGroup": "Container Instances", - "Get-AzureRmContainerInstanceLog": "Container Instances", - "ConvertTo-AzureRmVhd": "VM VHDs", - "Remove-AzureRmDataFactoryV2": "Data Factories", - "Set-AzureRmDataFactoryV2Trigger": "Data Factories", - "Start-AzureRmDataFactoryV2Trigger": "Data Factories", - "Set-AzureRmDataFactoryV2LinkedService": "Data Factories", - "Remove-AzureRmDataFactoryV2IntegrationRuntime": "Data Factories", - "Get-AzureRmDataFactoryV2Dataset": "Data Factories", - "Get-AzureRmDataFactoryV2Pipeline": "Data Factories", - "Get-AzureRmDataFactoryV2Trigger": "Data Factories", - "Invoke-AzureRmDataFactoryV2Pipeline": "Data Factories", - "Update-AzureRmDataFactoryV2": "Data Factories", - "Get-AzureRmDataFactoryV2IntegrationRuntimeMetric": "Data Factories", - "Stop-AzureRmDataFactoryV2PipelineRun": "Data Factories", - "Set-AzureRmDataFactoryV2IntegrationRuntime": "Data Factories", - "Stop-AzureRmDataFactoryV2Trigger": "Data Factories", - "Get-AzureRmDataFactoryV2IntegrationRuntimeKey": "Data Factories", - "Update-AzureRmDataFactoryV2IntegrationRuntime": "Data Factories", - "Remove-AzureRmDataFactoryV2IntegrationRuntimeNode": "Data Factories", - "New-AzureRmDataFactoryV2IntegrationRuntimeKey": "Data Factories", - "Remove-AzureRmDataFactoryV2Trigger": "Data Factories", - "Get-AzureRmDataFactoryV2TriggerRun": "Data Factories", - "Set-AzureRmDataFactoryV2Dataset": "Data Factories", - "Set-AzureRmDataFactoryV2Pipeline": "Data Factories", - "Get-AzureRmDataFactoryV2PipelineRun": "Data Factories", - "Get-AzureRmDataFactoryV2IntegrationRuntimeNode": "Data Factories", - "Sync-AzureRmDataFactoryV2IntegrationRuntimeCredential": "Data Factories", - "Remove-AzureRmDataFactoryV2Pipeline": "Data Factories", - "Get-AzureRmDataFactoryV2ActivityRun": "Data Factories", - "Get-AzureRmDataFactoryV2IntegrationRuntime": "Data Factories", - "Stop-AzureRmDataFactoryV2IntegrationRuntime": "Data Factories", - "Invoke-AzureRmDataFactoryV2IntegrationRuntimeUpgrade": "Data Factories", - "Start-AzureRmDataFactoryV2IntegrationRuntime": "Data Factories", - "Get-AzureRmDataFactoryV2": "Data Factories", - "Remove-AzureRmDataFactoryV2LinkedService": "Data Factories", - "Update-AzureRmDataFactoryV2IntegrationRuntimeNode": "Data Factories", - "Set-AzureRmDataFactoryV2": "Data Factories", - "Remove-AzureRmDataFactoryV2Dataset": "Data Factories", - "Get-AzureRmDataFactoryV2LinkedService": "Data Factories", - "New-AzureRmDataFactoryV2LinkedServiceEncryptedCredential": "Data Factories", - "Remove-AzureRmUserAssignedIdentity": "Managed Service Identity", - "New-AzureRmUserAssignedIdentity": "Managed Service Identity", - "Get-AzureRmUserAssignedIdentity": "Managed Service Identity" -} \ No newline at end of file From 20275ef7e59d570e24daa53d3de451b96c346b70 Mon Sep 17 00:00:00 2001 From: "Mike F. Robbins" <mike.robbins@microsoft.com> Date: Fri, 10 Jan 2025 14:52:17 -0600 Subject: [PATCH 3/3] Updated links to azurerm docs (#3441) --- .openpublishing.redirection.json | 5 ----- docs-conceptual/azps-0.10.0/migrate-from-azurerm-to-az.md | 6 +++--- docs-conceptual/azps-12.5.0/migrate-from-azurerm-to-az.md | 5 +++-- docs-conceptual/azps-12.5.0/what-is-azure-powershell.md | 2 +- docs-conceptual/azps-13.0.0/migrate-from-azurerm-to-az.md | 5 +++-- docs-conceptual/azps-13.0.0/what-is-azure-powershell.md | 2 +- 6 files changed, 11 insertions(+), 14 deletions(-) diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json index 9c16960f87..9a07011abd 100644 --- a/.openpublishing.redirection.json +++ b/.openpublishing.redirection.json @@ -45,11 +45,6 @@ "redirect_url": "/powershell/azure/", "source_path": "docs-conceptual/azps-0.10.0/overview.md" }, - { - "redirect_document_id": false, - "redirect_url": "/powershell/azure/azurerm/overview", - "source_path": "docs-conceptual/azurermps-6.13.0/index.md" - }, { "redirect_document_id": false, "redirect_url": "/powershell/azure/overview", diff --git a/docs-conceptual/azps-0.10.0/migrate-from-azurerm-to-az.md b/docs-conceptual/azps-0.10.0/migrate-from-azurerm-to-az.md index 413c81153d..b34c443ba6 100644 --- a/docs-conceptual/azps-0.10.0/migrate-from-azurerm-to-az.md +++ b/docs-conceptual/azps-0.10.0/migrate-from-azurerm-to-az.md @@ -36,9 +36,9 @@ your existing scripts may need additional modification to work with the Az modul described here and in the [breaking changes list](migrate-az-1.0.0.md). If your scripts don't work with AzureRM 6.13.1, update them according to the -[AzureRM 5.x to 6.x migration guide](/powershell/azure/azurerm/migration-guide.6.0.0). -If you use an earlier version of the AzureRM module, there are migration guides available for -each major version. +[AzureRM 5.x to 6.x migration guide](/previous-versions/powershell/azure/migration-guide.6.0.0). If +you use an earlier version of the AzureRM module, there are migration guides available for each +major version. ## Uninstall AzureRM diff --git a/docs-conceptual/azps-12.5.0/migrate-from-azurerm-to-az.md b/docs-conceptual/azps-12.5.0/migrate-from-azurerm-to-az.md index dae34871db..98b68dc9af 100644 --- a/docs-conceptual/azps-12.5.0/migrate-from-azurerm-to-az.md +++ b/docs-conceptual/azps-12.5.0/migrate-from-azurerm-to-az.md @@ -55,8 +55,9 @@ your existing scripts may need additional modifications to work with the Az modu of what's described in this article and in the [breaking changes list](migrate-az-1.0.0.md). If your scripts don't work with AzureRM 6.13.2, update them according to the -[AzureRM 5.x to 6.x migration guide](/powershell/azure/azurerm/migration-guide.6.0.0). If you use an -earlier version of the AzureRM module, there are migration guides available for each major version. +[AzureRM 5.x to 6.x migration guide](/previous-versions/powershell/azure/migration-guide.6.0.0). If +you use an earlier version of the AzureRM module, there are migration guides available for each +major version. ## Option 1 (recommended): Automatically migrate your PowerShell scripts diff --git a/docs-conceptual/azps-12.5.0/what-is-azure-powershell.md b/docs-conceptual/azps-12.5.0/what-is-azure-powershell.md index 26561b97e8..ad46f1cc64 100644 --- a/docs-conceptual/azps-12.5.0/what-is-azure-powershell.md +++ b/docs-conceptual/azps-12.5.0/what-is-azure-powershell.md @@ -119,5 +119,5 @@ Guidelines [get-member]: /powershell/module/microsoft.powershell.utility/get-member [azps-output]: queries-azureps.md [format-azps-output]: formatting-output.md -[azurerm-module]: /powershell/azure/azurerm/overview +[azurerm-module]: /previous-versions/powershell/azure/ [azure-rdfe-module]: /powershell/azure/servicemanagement/overview diff --git a/docs-conceptual/azps-13.0.0/migrate-from-azurerm-to-az.md b/docs-conceptual/azps-13.0.0/migrate-from-azurerm-to-az.md index dae34871db..98b68dc9af 100644 --- a/docs-conceptual/azps-13.0.0/migrate-from-azurerm-to-az.md +++ b/docs-conceptual/azps-13.0.0/migrate-from-azurerm-to-az.md @@ -55,8 +55,9 @@ your existing scripts may need additional modifications to work with the Az modu of what's described in this article and in the [breaking changes list](migrate-az-1.0.0.md). If your scripts don't work with AzureRM 6.13.2, update them according to the -[AzureRM 5.x to 6.x migration guide](/powershell/azure/azurerm/migration-guide.6.0.0). If you use an -earlier version of the AzureRM module, there are migration guides available for each major version. +[AzureRM 5.x to 6.x migration guide](/previous-versions/powershell/azure/migration-guide.6.0.0). If +you use an earlier version of the AzureRM module, there are migration guides available for each +major version. ## Option 1 (recommended): Automatically migrate your PowerShell scripts diff --git a/docs-conceptual/azps-13.0.0/what-is-azure-powershell.md b/docs-conceptual/azps-13.0.0/what-is-azure-powershell.md index 26561b97e8..ad46f1cc64 100644 --- a/docs-conceptual/azps-13.0.0/what-is-azure-powershell.md +++ b/docs-conceptual/azps-13.0.0/what-is-azure-powershell.md @@ -119,5 +119,5 @@ Guidelines [get-member]: /powershell/module/microsoft.powershell.utility/get-member [azps-output]: queries-azureps.md [format-azps-output]: formatting-output.md -[azurerm-module]: /powershell/azure/azurerm/overview +[azurerm-module]: /previous-versions/powershell/azure/ [azure-rdfe-module]: /powershell/azure/servicemanagement/overview